slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: regen manuals (on server)

Browse Source 
Usually done on my laptop, but the toolchain on both machines should
produce the same result these days..

[ci skip]
This commit is contained in:
Simon Michael 2019-09-09 08:02:49 -07:00
parent fb521e248b
commit 85d48a6b0e
10 changed files with 719 additions and 592 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
hledger-lib/hledger_csv.txt
View File

@ -24,9 +24,9 @@ DESCRIPTION
When reading a CSV file named FILE.csv, hledger looks for a conversion
rules file named FILE.csv.rules in the same directory. You can over-
ride this with the --rules-file option. If the rules file does not ex-
ist, hledger will auto-create one with some example rules, which you'll
need to adjust.
ride this with the --rules-file option. If the rules file does not
exist, hledger will auto-create one with some example rules, which
you'll need to adjust.
At minimum, the rules file must identify the date and amount fields.
It's often necessary to specify the date format, and the number of
@ -192,8 +192,8 @@ CSV TIPS
you might need newest-first, see above).
CSV accounts
Each journal entry will have two postings, to account1 and account2 re-
spectively. It's not yet possible to generate entries with more than
Each journal entry will have two postings, to account1 and account2
respectively. It's not yet possible to generate entries with more than
two postings. It's conventional and recommended to use account1 for
the account whose CSV we are reading.
@ -229,9 +229,9 @@ CSV TIPS
CSV balance assertions/assignments
If the CSV includes a running balance, you can assign that to one of
the pseudo fields balance (or balance1) or balance2. This will gener-
ate a balance assertion (or if the amount is left empty, a balance as-
signment), on the first or second posting, whenever the running balance
field is non-empty. (TODO: #1000)
ate a balance assertion (or if the amount is left empty, a balance
assignment), on the first or second posting, whenever the running bal-
ance field is non-empty. (TODO: #1000)
Reading multiple CSV files
You can read multiple CSV files at once using multiple -f arguments on

58
hledger-lib/hledger_journal.5
View File

@ -1579,11 +1579,45 @@ parent account.
.SS Periodic transactions
.PP
Periodic transaction rules describe transactions that recur.
They allow you to generate future transactions for forecasting, without
having to write them out explicitly in the journal (with
\f[C]--forecast\f[R]).
Secondly, they also can be used to define budget goals (with
\f[C]--budget\f[R]).
They allow hledger to generate temporary future transactions to help
with forecasting, so you don\[aq]t have to write out each one in the
journal, and it\[aq]s easy to try out different forecasts.
Secondly, they are also used to define the budgets shown in budget
reports.
.PP
Periodic transactions can be a little tricky, so before you use them,
read this whole section - or at least these tips:
.IP "1." 3
Two spaces accidentally added or omitted will cause you trouble - read
about this below.
.IP "2." 3
For troubleshooting, show the generated transactions with
\f[C]hledger print --forecast tag:generated\f[R] or
\f[C]hledger register --forecast tag:generated\f[R].
.IP "3." 3
Forecasted transactions will begin only after the last non-forecasted
transaction\[aq]s date.
.IP "4." 3
Forecasted transactions will end 6 months from today, by default.
See below for the exact start/end rules.
.IP "5." 3
period expressions can be tricky.
Their documentation needs improvement, but is worth studying.
.IP "6." 3
Some period expressions with a repeating interval must begin on a
natural boundary of that interval.
Eg in \f[C]weekly from DATE\f[R], DATE must be a monday.
\f[C]\[ti] weekly from 2019/10/1\f[R] (a tuesday) will give an error.
.IP "7." 3
Other period expressions with an interval are automatically expanded to
cover a whole number of that interval.
(This is done to improve reports, but it also affects periodic
transactions.
Yes, it\[aq]s a bit inconsistent with the above.) Eg:
\f[C]\[ti] every 10th day of month from 2020/01\f[R], which is
equivalent to \f[C]\[ti] every 10th day of month from 2020/01/01\f[R],
will be adjusted to start on 2019/12/10.
.SS Periodic rule syntax
.PP
A periodic transaction rule looks like a normal journal entry, with the
date replaced by a tilde (\f[C]\[ti]\f[R]) followed by a period
@ -1607,7 +1641,7 @@ Partial or relative dates (M/D, D, tomorrow, last week) in the period
expression can work (useful or not).
They will be relative to today\[aq]s date, unless a Y default year
directive is in effect, in which case they will be relative to Y/1/1.
.SS Two spaces after the period expression
.SS Two spaces between period expression and description!
.PP
If the period expression is followed by a transaction description, these
must be separated by \f[B]two or more spaces\f[R].
@ -1625,6 +1659,14 @@ example:
income:acme inc
\f[R]
.fi
.PP
So,
.IP \[bu] 2
Do write two spaces between your period expression and your transaction
description, if any.
.IP \[bu] 2
Don\[aq]t accidentally write two spaces in the middle of your period
expression.
.SS Forecasting with periodic transactions
.PP
With the \f[C]--forecast\f[R] flag, each periodic transaction rule
@ -1686,8 +1728,8 @@ Eg the first example above declares a goal of spending $2000 on rent
(and also, a goal of depositing $2000 into checking) every month.
Goals and actual performance can then be compared in budget reports.
.PP
For more details, see: balance: Budget report and Cookbook: Budgeting
and Forecasting.
For more details, see: balance: Budget report and Budgeting and
Forecasting.
.PP
.SS Auto postings / transaction modifiers
.PP

115
hledger-lib/hledger_journal.info
View File

@ -1412,12 +1412,52 @@ File: hledger_journal.info, Node: Periodic transactions, Next: Auto postings /
==========================
Periodic transaction rules describe transactions that recur. They allow
you to generate future transactions for forecasting, without having to
write them out explicitly in the journal (with '--forecast'). Secondly,
they also can be used to define budget goals (with '--budget').
hledger to generate temporary future transactions to help with
forecasting, so you don't have to write out each one in the journal, and
it's easy to try out different forecasts. Secondly, they are also used
to define the budgets shown in budget reports.
A periodic transaction rule looks like a normal journal entry, with
the date replaced by a tilde ('~') followed by a period expression
Periodic transactions can be a little tricky, so before you use them,
read this whole section - or at least these tips:
1. Two spaces accidentally added or omitted will cause you trouble -
read about this below.
2. For troubleshooting, show the generated transactions with 'hledger
print --forecast tag:generated' or 'hledger register --forecast
tag:generated'.
3. Forecasted transactions will begin only after the last
non-forecasted transaction's date.
4. Forecasted transactions will end 6 months from today, by default.
See below for the exact start/end rules.
5. period expressions can be tricky. Their documentation needs
improvement, but is worth studying.
6. Some period expressions with a repeating interval must begin on a
natural boundary of that interval. Eg in 'weekly from DATE', DATE
must be a monday. '~ weekly from 2019/10/1' (a tuesday) will give
an error.
7. Other period expressions with an interval are automatically
expanded to cover a whole number of that interval. (This is done
to improve reports, but it also affects periodic transactions.
Yes, it's a bit inconsistent with the above.) Eg: '~ every 10th
day of month from 2020/01', which is equivalent to '~ every 10th
day of month from 2020/01/01', will be adjusted to start on
2019/12/10.
* Menu:
* Periodic rule syntax::
* Two spaces between period expression and description!::
* Forecasting with periodic transactions::
* Budgeting with periodic transactions::

File: hledger_journal.info, Node: Periodic rule syntax, Next: Two spaces between period expression and description!, Up: Periodic transactions
1.15.1 Periodic rule syntax
---------------------------
A periodic transaction rule looks like a normal journal entry, with the
date replaced by a tilde ('~') followed by a period expression
(mnemonic: '~' looks like a recurring sine wave.):
~ monthly
@ -1433,17 +1473,11 @@ expression can work (useful or not). They will be relative to today's
date, unless a Y default year directive is in effect, in which case they
will be relative to Y/1/1.
* Menu:
* Two spaces after the period expression::
* Forecasting with periodic transactions::
* Budgeting with periodic transactions::

File: hledger_journal.info, Node: Two spaces after the period expression, Next: Forecasting with periodic transactions, Up: Periodic transactions
File: hledger_journal.info, Node: Two spaces between period expression and description!, Next: Forecasting with periodic transactions, Prev: Periodic rule syntax, Up: Periodic transactions
1.15.1 Two spaces after the period expression
---------------------------------------------
1.15.2 Two spaces between period expression and description!
------------------------------------------------------------
If the period expression is followed by a transaction description, these
must be separated by *two or more spaces*. This helps hledger know
@ -1457,10 +1491,17 @@ accidentally alter their meaning, as in this example:
assets:bank:checking $1500
income:acme inc

File: hledger_journal.info, Node: Forecasting with periodic transactions, Next: Budgeting with periodic transactions, Prev: Two spaces after the period expression, Up: Periodic transactions
So,
1.15.2 Forecasting with periodic transactions
* Do write two spaces between your period expression and your
transaction description, if any.
* Don't accidentally write two spaces in the middle of your period
expression.

File: hledger_journal.info, Node: Forecasting with periodic transactions, Next: Budgeting with periodic transactions, Prev: Two spaces between period expression and description!, Up: Periodic transactions
1.15.3 Forecasting with periodic transactions
---------------------------------------------
With the '--forecast' flag, each periodic transaction rule generates
@ -1513,7 +1554,7 @@ disables forecast transactions on previous dates.)

File: hledger_journal.info, Node: Budgeting with periodic transactions, Prev: Forecasting with periodic transactions, Up: Periodic transactions
1.15.3 Budgeting with periodic transactions
1.15.4 Budgeting with periodic transactions
-------------------------------------------
With the '--budget' flag, currently supported by the balance command,
@ -1523,8 +1564,8 @@ spending $2000 on rent (and also, a goal of depositing $2000 into
checking) every month. Goals and actual performance can then be
compared in budget reports.
For more details, see: balance: Budget report and Cookbook: Budgeting
and Forecasting.
For more details, see: balance: Budget report and Budgeting and
Forecasting.

File: hledger_journal.info, Node: Auto postings / transaction modifiers, Prev: Periodic transactions, Up: FILE FORMAT
@ -1760,21 +1801,23 @@ Node: Default parent account50218
Ref: #default-parent-account50384
Node: Periodic transactions51268
Ref: #periodic-transactions51466
Node: Two spaces after the period expression52592
Ref: #two-spaces-after-the-period-expression52837
Node: Forecasting with periodic transactions53322
Ref: #forecasting-with-periodic-transactions53612
Node: Budgeting with periodic transactions55638
Ref: #budgeting-with-periodic-transactions55877
Node: Auto postings / transaction modifiers56336
Ref: #auto-postings-transaction-modifiers56547
Node: Auto postings and dates58776
Ref: #auto-postings-and-dates59033
Node: Auto postings and transaction balancing / inferred amounts / balance assertions59208
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions59583
Node: Auto posting tags59961
Ref: #auto-posting-tags60200
Node: EDITOR SUPPORT60865
Ref: #editor-support60983
Node: Periodic rule syntax53338
Ref: #periodic-rule-syntax53544
Node: Two spaces between period expression and description!54248
Ref: #two-spaces-between-period-expression-and-description54567
Node: Forecasting with periodic transactions55251
Ref: #forecasting-with-periodic-transactions55556
Node: Budgeting with periodic transactions57582
Ref: #budgeting-with-periodic-transactions57821
Node: Auto postings / transaction modifiers58270
Ref: #auto-postings-transaction-modifiers58481
Node: Auto postings and dates60710
Ref: #auto-postings-and-dates60967
Node: Auto postings and transaction balancing / inferred amounts / balance assertions61142
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions61517
Node: Auto posting tags61895
Ref: #auto-posting-tags62134
Node: EDITOR SUPPORT62799
Ref: #editor-support62917

End Tag Table

209
hledger-lib/hledger_journal.txt
View File

@ -7,9 +7,9 @@ NAME
Journal - hledger's default file format, representing a General Journal
DESCRIPTION
hledger's usual data source is a plain text file containing journal en-
tries in hledger journal format. This file represents a standard ac-
counting general journal. I use file names ending in .journal, but
hledger's usual data source is a plain text file containing journal
entries in hledger journal format. This file represents a standard
accounting general journal. I use file names ending in .journal, but
that's not required. The journal file contains a number of transaction
entries, each describing a transfer of money (or any commodity) between
two or more named accounts, in a simple format readable by both hledger
@ -23,8 +23,8 @@ DESCRIPTION
You can use hledger without learning any more about this file; just use
the add or web commands to create and update it. Many users, though,
also edit the journal file directly with a text editor, perhaps as-
sisted by the helper modes for emacs or vim.
also edit the journal file directly with a text editor, perhaps
assisted by the helper modes for emacs or vim.
Here's an example:
@ -58,9 +58,9 @@ DESCRIPTION
FILE FORMAT
Transactions
Transactions are movements of some quantity of commodities between
named accounts. Each transaction is represented by a journal entry be-
ginning with a simple date in column 0. This can be followed by any of
the following, separated by spaces:
named accounts. Each transaction is represented by a journal entry
beginning with a simple date in column 0. This can be followed by any
of the following, separated by spaces:
o (optional) a status character (empty, !, or *)
@ -104,16 +104,16 @@ FILE FORMAT
Simple dates
Within a journal file, transaction dates use Y/M/D (or Y-M-D or Y.M.D)
Leading zeros are optional. The year may be omitted, in which case it
will be inferred from the context - the current transaction, the de-
fault year set with a default year directive, or the current date when
the command is run. Some examples: 2010/01/31, 1/31, 2010-01-31,
will be inferred from the context - the current transaction, the
default year set with a default year directive, or the current date
when the command is run. Some examples: 2010/01/31, 1/31, 2010-01-31,
2010.1.31.
Secondary dates
Real-life transactions sometimes involve more than one date - eg the
date you write a cheque, and the date it clears in your bank. When you
want to model this, eg for more accurate balances, you can specify in-
dividual posting dates, which I recommend. Or, you can use the sec-
want to model this, eg for more accurate balances, you can specify
individual posting dates, which I recommend. Or, you can use the sec-
ondary dates (aka auxiliary/effective dates) feature, supported for
compatibility with Ledger.
@ -142,15 +142,15 @@ FILE FORMAT
Secondary dates require some effort; you must use them consistently in
your journal entries and remember whether to use or not use the --date2
flag for your reports. They are included in hledger for Ledger compat-
ibility, but posting dates are a more powerful and less confusing al-
ternative.
ibility, but posting dates are a more powerful and less confusing
alternative.
Posting dates
You can give individual postings a different date from their parent
transaction, by adding a posting comment containing a tag (see below)
like date:DATE. This is probably the best way to control posting dates
precisely. Eg in this example the expense should appear in May re-
ports, and the deduction from checking should be reported on 6/1 for
precisely. Eg in this example the expense should appear in May
reports, and the deduction from checking should be reported on 6/1 for
easy bank reconciliation:
2015/5/30
@ -177,9 +177,9 @@ FILE FORMAT
Status
Transactions, or individual postings within a transaction, can have a
status mark, which is a single character before the transaction de-
scription or posting account name, separated from it by a space, indi-
cating one of three statuses:
status mark, which is a single character before the transaction
description or posting account name, separated from it by a space,
indicating one of three statuses:
mark status
------------------
@ -192,8 +192,8 @@ FILE FORMAT
status:* queries; or the U, P, C keys in hledger-ui.
Note, in Ledger and in older versions of hledger, the "unmarked" state
is called "uncleared". As of hledger 1.3 we have renamed it to un-
marked for clarity.
is called "uncleared". As of hledger 1.3 we have renamed it to
unmarked for clarity.
To replicate Ledger and old hledger's behaviour of also matching pend-
ing, combine -U and -P.
@ -215,8 +215,8 @@ FILE FORMAT
rect
With this scheme, you would use -PC to see the current balance at your
bank, -U to see things which will probably hit your bank soon (like un-
cashed checks), and no flags to see the most up-to-date state of your
bank, -U to see things which will probably hit your bank soon (like
uncashed checks), and no flags to see the most up-to-date state of your
finances.
Description
@ -229,9 +229,9 @@ FILE FORMAT
Payee and note
You can optionally include a | (pipe) character in descriptions to sub-
divide the description into separate fields for payee/payer name on the
left (up to the first |) and an additional note field on the right (af-
ter the first |). This may be worthwhile if you need to do more pre-
cise querying and pivoting by payee or by note.
left (up to the first |) and an additional note field on the right
(after the first |). This may be worthwhile if you need to do more
precise querying and pivoting by payee or by note.
Account names
Account names typically have several parts separated by a full colon,
@ -580,11 +580,11 @@ FILE FORMAT
nodes to be ignored, allowing emacs users to fold and navigate their
journals with org-mode or orgstruct-mode.)
You can attach comments to a transaction by writing them after the de-
scription and/or indented on the following lines (before the postings).
Similarly, you can attach comments to an individual posting by writing
them after the amount and/or indented on the following lines. Transac-
tion and posting comments must begin with a semicolon (;).
You can attach comments to a transaction by writing them after the
description and/or indented on the following lines (before the post-
ings). Similarly, you can attach comments to an individual posting by
writing them after the amount and/or indented on the following lines.
Transaction and posting comments must begin with a semicolon (;).
Some examples:
@ -660,33 +660,33 @@ FILE FORMAT
here is a table summarising the directives and their effects, with
links to more detailed docs.
direc- end di- subdi- purpose can affect (as of
tive rective rec- 2018/06)
direc- end subdi- purpose can affect (as of
tive directive rec- 2018/06)
tives
------------------------------------------------------------------------------------
account any document account names, de- all entries in all
text clare account types & dis- files, before or
account any document account names, all entries in all
text declare account types & dis- files, before or
play order after
alias end rewrite account names following in-
aliases line/included en-
tries until end of
current file or end
directive
apply end apply prepend a common parent to following in-
account account account names line/included en-
tries until end of
current file or end
directive
comment end com- ignore part of journal following in-
ment line/included en-
tries until end of
current file or end
directive
alias end rewrite account names following
aliases inline/included
entries until end
of current file or
end directive
apply end apply prepend a common parent to following
account account account names inline/included
entries until end
of current file or
end directive
comment end com- ignore part of journal following
ment inline/included
entries until end
of current file or
end directive
commod- format declare a commodity and its number notation:
ity number notation & display following entries
style in that commodity
@ -709,13 +709,13 @@ FILE FORMAT
include include entries/directives what the included
from another file directives affect
P declare a market price for a amounts of that
commodity commodity in re-
ports, when -V is
commodity commodity in
reports, when -V is
used
Y declare a year for yearless following in-
dates line/included en-
tries until end of
current file
Y declare a year for yearless following
dates inline/included
entries until end
of current file
And some definitions:
@ -731,8 +731,8 @@ FILE FORMAT
scope are affected by a directive
As you can see, directives vary in which journal entries and files they
affect, and whether they are focussed on input (parsing) or output (re-
ports). Some directives have multiple effects.
affect, and whether they are focussed on input (parsing) or output
(reports). Some directives have multiple effects.
If you have a journal made up of multiple files, or pass multiple -f
options on the command line, note that directives which affect input
@ -756,8 +756,8 @@ FILE FORMAT
file. The include file path may contain common glob patterns (e.g.
*).
The include directive can only be used in journal files. It can in-
clude journal, timeclock or timedot files, but not CSV files.
The include directive can only be used in journal files. It can
include journal, timeclock or timedot files, but not CSV files.
Default year
You can set a default year to be used for subsequent dates which don't
@ -813,8 +813,8 @@ FILE FORMAT
Normally the display format is inferred from journal entries, but this
can be unpredictable; declaring it with a commodity directive overrides
this and removes ambiguity. Towards this end, amounts in commodity di-
rectives must always be written with a decimal point (a period or
this and removes ambiguity. Towards this end, amounts in commodity
directives must always be written with a decimal point (a period or
comma, followed by 0 or more decimal digits).
Commodity directives do not affect how amounts are parsed; the parser
@ -839,8 +839,8 @@ FILE FORMAT
a decimal point.
Market prices
The P directive declares a market price, which is an exchange rate be-
tween two commodities on a certain date. (In Ledger, they are called
The P directive declares a market price, which is an exchange rate
between two commodities on a certain date. (In Ledger, they are called
"historical prices".) These are often obtained from a stock exchange,
cryptocurrency exchange, or the foreign exchange market.
@ -865,8 +865,8 @@ FILE FORMAT
commodity using these prices.
Declaring accounts
account directives can be used to pre-declare accounts. Though not re-
quired, they can provide several benefits:
account directives can be used to pre-declare accounts. Though not
required, they can provide several benefits:
o They can document your intended chart of accounts, providing a refer-
ence.
@ -925,8 +925,8 @@ FILE FORMAT
detected automatically.
Account types declared with tags
More generally, you can declare an account's type with an account di-
rective, by writing a type: tag in a comment, followed by one of the
More generally, you can declare an account's type with an account
directive, by writing a type: tag in a comment, followed by one of the
words Asset, Liability, Equity, Revenue, Expense, or one of the letters
ALERX (case insensitive):
@ -1025,9 +1025,9 @@ FILE FORMAT
Or, you can use the --alias 'OLD=NEW' option on the command line. This
affects all entries. It's useful for trying out aliases interactively.
OLD and NEW are case sensitive full account names. hledger will re-
place any occurrence of the old account name with the new one. Subac-
counts are also affected. Eg:
OLD and NEW are case sensitive full account names. hledger will
replace any occurrence of the old account name with the new one. Sub-
accounts are also affected. Eg:
alias checking = assets:bank:wells fargo:checking
; rewrites "checking" to "assets:bank:wells fargo:checking", or "checking:a" to "assets:bank:wells fargo:checking:a"
@ -1092,9 +1092,9 @@ FILE FORMAT
end aliases
Default parent account
You can specify a parent account which will be prepended to all ac-
counts within a section of the journal. Use the apply account and end
apply account directives like so:
You can specify a parent account which will be prepended to all
accounts within a section of the journal. Use the apply account and
end apply account directives like so:
apply account home
@ -1128,11 +1128,44 @@ FILE FORMAT
account.
Periodic transactions
Periodic transaction rules describe transactions that recur. They al-
low you to generate future transactions for forecasting, without having
to write them out explicitly in the journal (with --forecast). Sec-
ondly, they also can be used to define budget goals (with --budget).
Periodic transaction rules describe transactions that recur. They
allow hledger to generate temporary future transactions to help with
forecasting, so you don't have to write out each one in the journal,
and it's easy to try out different forecasts. Secondly, they are also
used to define the budgets shown in budget reports.
Periodic transactions can be a little tricky, so before you use them,
read this whole section - or at least these tips:
1. Two spaces accidentally added or omitted will cause you trouble -
read about this below.
2. For troubleshooting, show the generated transactions with hledger
print --forecast tag:generated or hledger register --forecast
tag:generated.
3. Forecasted transactions will begin only after the last non-fore-
casted transaction's date.
4. Forecasted transactions will end 6 months from today, by default.
See below for the exact start/end rules.
5. period expressions can be tricky. Their documentation needs
improvement, but is worth studying.
6. Some period expressions with a repeating interval must begin on a
natural boundary of that interval. Eg in weekly from DATE, DATE
must be a monday. ~ weekly from 2019/10/1 (a tuesday) will give an
error.
7. Other period expressions with an interval are automatically expanded
to cover a whole number of that interval. (This is done to improve
reports, but it also affects periodic transactions. Yes, it's a bit
inconsistent with the above.) Eg: ~ every 10th day of month from
2020/01, which is equivalent to ~ every 10th day of month from
2020/01/01, will be adjusted to start on 2019/12/10.
Periodic rule syntax
A periodic transaction rule looks like a normal journal entry, with the
date replaced by a tilde (~) followed by a period expression (mnemonic:
~ looks like a recurring sine wave.):
@ -1150,7 +1183,7 @@ FILE FORMAT
date, unless a Y default year directive is in effect, in which case
they will be relative to Y/1/1.
Two spaces after the period expression
Two spaces between period expression and description!
If the period expression is followed by a transaction description,
these must be separated by two or more spaces. This helps hledger know
where the period expression ends, so that descriptions can not acciden-
@ -1163,9 +1196,17 @@ FILE FORMAT
assets:bank:checking $1500
income:acme inc
So,
o Do write two spaces between your period expression and your transac-
tion description, if any.
o Don't accidentally write two spaces in the middle of your period
expression.
Forecasting with periodic transactions
With the --forecast flag, each periodic transaction rule generates fu-
ture transactions recurring at the specified interval. These are not
With the --forecast flag, each periodic transaction rule generates
future transactions recurring at the specified interval. These are not
saved in the journal, but appear in all reports. They will look like
normal transactions, but with an extra tag:
@ -1220,8 +1261,8 @@ FILE FORMAT
checking) every month. Goals and actual performance can then be com-
pared in budget reports.
For more details, see: balance: Budget report and Cookbook: Budgeting
and Forecasting.
For more details, see: balance: Budget report and Budgeting and Fore-
casting.
Auto postings / transaction modifiers
Transaction modifier rules, AKA auto posting rules, describe changes to

4
hledger-lib/hledger_timedot.txt
View File

@ -28,8 +28,8 @@ FILE FORMAT
Quantities can be written as:
o a sequence of dots (.) representing quarter hours. Spaces may op-
tionally be used for grouping and readability. Eg: .... ..
o a sequence of dots (.) representing quarter hours. Spaces may
optionally be used for grouping and readability. Eg: .... ..
o an integral or decimal number, representing hours. Eg: 1.5

131
hledger-ui/hledger-ui.txt
View File

@ -117,8 +117,8 @@ OPTIONS
using period expressions syntax
--date2
match the secondary date instead (see command help for other ef-
fects)
match the secondary date instead (see command help for other
effects)
-U --unmarked
include only unmarked postings/txns (can combine with -P or -C)
@ -204,8 +204,8 @@ KEYS
BACKSPACE or DELETE removes all filters, showing all transactions.
As mentioned above, hledger-ui shows auto-generated periodic transac-
tions, and hides future transactions (auto-generated or not) by de-
fault. F toggles showing and hiding these future transactions. This
tions, and hides future transactions (auto-generated or not) by
default. F toggles showing and hiding these future transactions. This
is similar to using a query like date:-tomorrow, but more convenient.
(experimental)
@ -227,8 +227,8 @@ KEYS
file. This allows some basic data entry.
A is like a, but runs the hledger-iadd tool, which provides a curses-
style interface. This key will be available if hledger-iadd is in-
stalled in $PATH.
style interface. This key will be available if hledger-iadd is
installed in $PATH.
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""
-nw) on the journal file. With some editors (emacs, vi), the cursor
@ -250,35 +250,36 @@ SCREENS
Account names are shown as a flat list by default. Press T to toggle
tree mode. In flat mode, account balances are exclusive of subac-
counts, except where subaccounts are hidden by a depth limit (see be-
low). In tree mode, all account balances are inclusive of subaccounts.
counts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of subac-
counts.
To see less detail, press a number key, 1 to 9, to set a depth limit.
To see less detail, press a number key, 1 to 9, to set a depth limit.
Or use - to decrease and +/= to increase the depth limit. 0 shows even
less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press ES-
CAPE.
less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press
ESCAPE.
H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions be-
fore the report start date, so they show the change in balance during
torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log.
U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are in-
cluded; and if you activate all three, the filter is removed.)
toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are
included; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line
Z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line
hledger).
Press right or enter to view an account's transactions register.
@ -287,63 +288,63 @@ SCREENS
This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows:
o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected
o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected
by real postings.)
o the overall change to the current account's balance; positive for an
o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow.
o the running historical total or period total for the current account,
after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while
after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while
the period total is not. If the historical total is not disturbed by
a filter query, it will be the running historical balance you would
a filter query, it will be the running historical balance you would
see on a bank register for the current account.
Transactions affecting this account's subaccounts will be included in
Transactions affecting this account's subaccounts will be included in
the register if the accounts screen is in tree mode, or if it's in flat
mode but this account has subaccounts which are not shown due to a
depth limit. In other words, the register always shows the transac-
mode but this account has subaccounts which are not shown due to a
depth limit. In other words, the register always shows the transac-
tions contributing to the balance shown on the accounts screen.
Tree mode/flat mode can be toggled with T here also.
U toggles filtering by unmarked status, showing or hiding unmarked
U toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, P toggles pending transactions, and C toggles
cleared transactions. (By default, transactions with all statuses are
shown; if you activate one or two status filters, only those transac-
cleared transactions. (By default, transactions with all statuses are
shown; if you activate one or two status filters, only those transac-
tions are shown; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com-
Z toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger).
Press right (or enter) to view the selected transaction in detail.
Transaction screen
This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour-
This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour-
nal(5)).
The transaction's date(s) and any cleared flag, transaction code, de-
scription, comments, along with all of its account postings are shown.
Simple transactions have two postings, but there can be more (or in
certain cases, fewer).
The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more
(or in certain cases, fewer).
up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary de-
pending on which account register you came from (remember most transac-
tions appear in multiple account registers). The #N number preceding
up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary
depending on which account register you came from (remember most trans-
actions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload).
Error screen
This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem, press g
This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem, press g
again to reload and resume normal operation. (Or, you can press escape
to cancel the reload attempt.)
@ -351,17 +352,17 @@ ENVIRONMENT
COLUMNS The screen width to use. Default: the full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FILES
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BUGS
The need to precede options with -- when invoked from hledger is awk-
The need to precede options with -- when invoked from hledger is awk-
ward.
-f- doesn't work (hledger-ui can't read from stdin).
@ -369,24 +370,24 @@ BUGS
-V affects only the accounts screen.
When you press g, the current and all previous screens are regenerated,
which may cause a noticeable pause with large files. Also there is no
which may cause a noticeable pause with large files. Also there is no
visual indication that this is in progress.
--watch is not yet fully robust. It works well for normal usage, but
many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi-
--watch is not yet fully robust. It works well for normal usage, but
many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi-
tion, momentary display of parse errors, high CPU usage eventually sub-
siding, and possibly a small but persistent build-up of CPU usage until
the program is restarted.
Also, if you are viewing files mounted from another machine, --watch
Also, if you are viewing files mounted from another machine, --watch
requires that both machine clocks are roughly in step.
REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list)
@ -400,7 +401,7 @@ COPYRIGHT
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1)

26
hledger-web/hledger-web.txt
View File

@ -19,9 +19,9 @@ DESCRIPTION
hledger-web is hledger's web interface. It starts a simple web appli-
cation for browsing and adding transactions, and optionally opens it in
a web browser window if possible. It provides a more user-friendly UI
than the hledger CLI or hledger-ui interface, showing more at once (ac-
counts, the current account register, balance charts) and allowing his-
tory-aware data entry, interactive searching, and bookmarking.
than the hledger CLI or hledger-ui interface, showing more at once
(accounts, the current account register, balance charts) and allowing
history-aware data entry, interactive searching, and bookmarking.
hledger-web also lets you share a ledger with multiple users, or even
the public web. There is no access control, so if you need that you
@ -127,8 +127,8 @@ OPTIONS
using period expressions syntax
--date2
match the secondary date instead (see command help for other ef-
fects)
match the secondary date instead (see command help for other
effects)
-U --unmarked
include only unmarked postings/txns (can combine with -P or -C)
@ -214,8 +214,8 @@ PERMISSIONS
You can restrict who can reach it by
o setting the IP address it listens on (see --host above). By default
it listens on 127.0.0.1, accessible to all users on the local ma-
chine.
it listens on 127.0.0.1, accessible to all users on the local
machine.
o putting it behind an authenticating proxy, using eg apache or nginx
@ -231,8 +231,8 @@ PERMISSIONS
o add - allows adding new transactions to the main journal file
o manage - allows editing, uploading or downloading the main or in-
cluded files
o manage - allows editing, uploading or downloading the main or
included files
o using the --capabilities-header=HTTPHEADER flag to specify a HTTP
header from which it will read capabilities to enable. hledger-web
@ -242,8 +242,8 @@ PERMISSIONS
EDITING, UPLOADING, DOWNLOADING
If you enable the manage capability mentioned above, you'll see a new
"spanner" button to the right of the search form. Clicking this will
let you edit, upload, or download the journal file or any files it in-
cludes.
let you edit, upload, or download the journal file or any files it
includes.
Note, unlike any other hledger command, in this mode you (or any visi-
tor) can alter or wipe the data files.
@ -262,8 +262,8 @@ RELOADING
hledger-web detects changes made to the files by other means (eg if you
edit it directly, outside of hledger-web), and it will show the new
data when you reload the page or navigate to a new page. If a change
makes a file unparseable, hledger-web will display an error message un-
til the file has been fixed.
makes a file unparseable, hledger-web will display an error message
until the file has been fixed.
(Note: if you are viewing files mounted from another machine, make sure
that both machine clocks are roughly in step.)

2
hledger/hledger.1
View File

@ -3634,7 +3634,7 @@ account, but it\[aq]s superseded now by the built-in roi command.
.SS Experimental add-ons
.PP
These are available in source form in the hledger repo\[aq]s bin/
directory; installing them is pretty easy.
directory.
They may be less mature and documented than built-in commands.
Reading and tweaking these is a good way to start making your own!
.SS autosync

19
hledger/hledger.info
View File

@ -3119,10 +3119,9 @@ File: hledger.info, Node: Experimental add-ons, Prev: Third party add-ons, Up
5.3 Experimental add-ons
========================
These are available in source form in the hledger repo's bin/ directory;
installing them is pretty easy. They may be less mature and documented
than built-in commands. Reading and tweaking these is a good way to
start making your own!
These are available in source form in the hledger repo's bin/ directory.
They may be less mature and documented than built-in commands. Reading
and tweaking these is a good way to start making your own!
* Menu:
@ -3328,11 +3327,11 @@ Node: irr108282
Ref: #irr108380
Node: Experimental add-ons108511
Ref: #experimental-add-ons108663
Node: autosync108944
Ref: #autosync109055
Node: chart109294
Ref: #chart109413
Node: check109484
Ref: #check109586
Node: autosync108911
Ref: #autosync109022
Node: chart109261
Ref: #chart109380
Node: check109451
Ref: #check109553

End Tag Table

731
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff