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

doc: update generated files

Browse Source
This commit is contained in:
Simon Michael 2017-03-29 14:35:59 -07:00
parent 7df15a8279
commit 01a2aa9394
12 changed files with 947 additions and 966 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
hledger-api/doc/hledger-api.1
View File

@ -12,10 +12,6 @@ hledger\-api \- web API server for the hledger accounting tool
.PD 0
.P
.PD
\f[C]hledger\-api\ \-\-swagger\f[]
.PD 0
.P
.PD
\f[C]hledger\ api\ \-\-\ [OPTIONS]\f[]
.SH DESCRIPTION
.PP
@ -51,13 +47,25 @@ server the API docs will be printed in Swagger 2.0 format.
Note: if invoking hledger\-api as a hledger subcommand, write
\f[C]\-\-\f[] before options as shown above.
.TP
.B \f[C]\-f\ \-\-file=FILE\f[]
use a different input file.
For stdin, use \- (default: \f[C]$LEDGER_FILE\f[] or
\f[C]$HOME/.hledger.journal\f[])
.RS
.RE
.TP
.B \f[C]\-d\ \-\-static\-dir=DIR\f[]
serve files from a different directory (default: \f[C]\&.\f[])
.RS
.RE
.TP
.B \f[C]\-\-host=IPADDR\f[]
listen on this IP address (default: 127.0.0.1)
.RS
.RE
.TP
.B \f[C]\-p\ \-\-port=PORT\f[]
use a different TCP port (default: 8001)
listen on this TCP port (default: 8001)
.RS
.RE
.TP
@ -65,58 +73,29 @@ use a different TCP port (default: 8001)
print API docs in Swagger 2.0 format, and exit
.RS
.RE
.PP
hledger general options:
.TP
.B \f[C]\-h\f[]
show general usage (or after COMMAND, the command\[aq]s usage)
.RS
.RE
.TP
.B \f[C]\-\-help\f[]
show the current program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual)
.RS
.RE
.TP
.B \f[C]\-\-man\f[]
show the current program\[aq]s manual with man
.RS
.RE
.TP
.B \f[C]\-\-info\f[]
show the current program\[aq]s manual with info
.RS
.RE
.TP
.B \f[C]\-\-version\f[]
show version
.RS
.RE
.TP
.B \f[C]\-\-debug[=N]\f[]
show debug output (levels 1\-9, default: 1)
.B \f[C]\-h\f[]
show usage
.RS
.RE
.TP
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
use a different input file.
For stdin, use \-
.B \f[C]\-\-help\f[]
show manual as plain text
.RS
.RE
.TP
.B \f[C]\-\-rules\-file=RULESFILE\f[]
Conversion rules file to use when reading CSV (default: FILE.rules)
.B \f[C]\-\-man\f[]
show manual with man
.RS
.RE
.TP
.B \f[C]\-\-alias=OLD=NEW\f[]
display accounts named OLD as NEW
.RS
.RE
.TP
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
ignore any failing balance assertions in the journal
.B \f[C]\-\-info\f[]
show manual with info
.RS
.RE
.SH ENVIRONMENT

44
hledger-api/doc/hledger-api.1.info
View File

@ -38,49 +38,37 @@ File: hledger-api.1.info, Node: OPTIONS, Prev: Top, Up: Top
Note: if invoking hledger-api as a hledger subcommand, write '--' before
options as shown above.
'-f --file=FILE'
use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'-d --static-dir=DIR'
serve files from a different directory (default: '.')
'--host=IPADDR'
listen on this IP address (default: 127.0.0.1)
'-p --port=PORT'
use a different TCP port (default: 8001)
listen on this TCP port (default: 8001)
'--swagger'
print API docs in Swagger 2.0 format, and exit
hledger general options:
'-h'
show general usage (or after COMMAND, the command's usage)
'--help'
show the current program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
'--man'
show the current program's manual with man
'--info'
show the current program's manual with info
'--version'
show version
'--debug[=N]'
'-h'
show debug output (levels 1-9, default: 1)
'-f FILE --file=FILE'
show usage
'--help'
use a different input file. For stdin, use -
'--rules-file=RULESFILE'
show manual as plain text
'--man'
Conversion rules file to use when reading CSV (default: FILE.rules)
'--alias=OLD=NEW'
show manual with man
'--info'
display accounts named OLD as NEW
'-I --ignore-assertions'
ignore any failing balance assertions in the journal
show manual with info

Tag Table:

37
hledger-api/doc/hledger-api.1.txt
View File

@ -8,7 +8,6 @@ NAME
SYNOPSIS
hledger-api [OPTIONS]
hledger-api --swagger
hledger api -- [OPTIONS]
DESCRIPTION
@ -41,44 +40,32 @@ OPTIONS
Note: if invoking hledger-api as a hledger subcommand, write -- before
options as shown above.
-f --file=FILE
use a different input file. For stdin, use - (default:
$LEDGER_FILE or $HOME/.hledger.journal)
-d --static-dir=DIR
serve files from a different directory (default: .)
--host=IPADDR
listen on this IP address (default: 127.0.0.1)
-p --port=PORT
use a different TCP port (default: 8001)
listen on this TCP port (default: 8001)
--swagger
print API docs in Swagger 2.0 format, and exit
hledger general options:
-h show general usage (or after COMMAND, the command's usage)
--help show the current program's manual as plain text (or after an
add-on COMMAND, the add-on's manual)
--man show the current program's manual with man
--info show the current program's manual with info
--version
show version
--debug[=N]
show debug output (levels 1-9, default: 1)
-h show usage
-f FILE --file=FILE
use a different input file. For stdin, use -
--help show manual as plain text
--rules-file=RULESFILE
Conversion rules file to use when reading CSV (default:
FILE.rules)
--man show manual with man
--alias=OLD=NEW
display accounts named OLD as NEW
-I --ignore-assertions
ignore any failing balance assertions in the journal
--info show manual with info
ENVIRONMENT
LEDGER_FILE The journal file path when not specified with -f. Default:

81
hledger-ui/doc/hledger-ui.1
View File

@ -64,42 +64,12 @@ show full account names, unindented
.RS
.RE
.PP
hledger general options:
.TP
.B \f[C]\-h\f[]
show general usage (or after COMMAND, the command\[aq]s usage)
.RS
.RE
.TP
.B \f[C]\-\-help\f[]
show the current program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual)
.RS
.RE
.TP
.B \f[C]\-\-man\f[]
show the current program\[aq]s manual with man
.RS
.RE
.TP
.B \f[C]\-\-info\f[]
show the current program\[aq]s manual with info
.RS
.RE
.TP
.B \f[C]\-\-version\f[]
show version
.RS
.RE
.TP
.B \f[C]\-\-debug[=N]\f[]
show debug output (levels 1\-9, default: 1)
.RS
.RE
hledger input options:
.TP
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
use a different input file.
For stdin, use \-
For stdin, use \- (default: \f[C]$LEDGER_FILE\f[] or
\f[C]$HOME/.hledger.journal\f[])
.RS
.RE
.TP
@ -109,12 +79,22 @@ Conversion rules file to use when reading CSV (default: FILE.rules)
.RE
.TP
.B \f[C]\-\-alias=OLD=NEW\f[]
display accounts named OLD as NEW
rename accounts named OLD to NEW
.RS
.RE
.TP
.B \f[C]\-\-anon\f[]
anonymize accounts and payees
.RS
.RE
.TP
.B \f[C]\-\-pivot\ TAGNAME\f[]
use some other field/tag for account names
.RS
.RE
.TP
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
ignore any failing balance assertions in the journal
ignore any failing balance assertions
.RS
.RE
.PP
@ -207,14 +187,37 @@ convert amounts to their market value on the report end date (using the
most recent applicable market price, if any)
.RS
.RE
.PP
hledger help options:
.TP
.B \f[C]\-\-pivot\ TAGNAME\f[]
organize reports by some tag\[aq]s value instead of by account
.B \f[C]\-h\f[]
show general usage (or after COMMAND, the command\[aq]s usage)
.RS
.RE
.TP
.B \f[C]\-\-anon\f[]
show anonymized accounts and payees
.B \f[C]\-\-help\f[]
show the current program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual)
.RS
.RE
.TP
.B \f[C]\-\-man\f[]
show the current program\[aq]s manual with man
.RS
.RE
.TP
.B \f[C]\-\-info\f[]
show the current program\[aq]s manual with info
.RS
.RE
.TP
.B \f[C]\-\-version\f[]
show version
.RS
.RE
.TP
.B \f[C]\-\-debug[=N]\f[]
show debug output (levels 1\-9, default: 1)
.RS
.RE
.SH KEYS

82
hledger-ui/doc/hledger-ui.1.info
View File

@ -52,39 +52,27 @@ the data.
show full account names, unindented
hledger general options:
hledger input options:
'-h'
show general usage (or after COMMAND, the command's usage)
'--help'
show the current program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
'--man'
show the current program's manual with man
'--info'
show the current program's manual with info
'--version'
show version
'--debug[=N]'
show debug output (levels 1-9, default: 1)
'-f FILE --file=FILE'
use a different input file. For stdin, use -
use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules)
'--alias=OLD=NEW'
display accounts named OLD as NEW
rename accounts named OLD to NEW
'--anon'
anonymize accounts and payees
'--pivot TAGNAME'
use some other field/tag for account names
'-I --ignore-assertions'
ignore any failing balance assertions in the journal
ignore any failing balance assertions
hledger reporting options:
@ -142,12 +130,28 @@ the data.
convert amounts to their market value on the report end date (using
the most recent applicable market price, if any)
'--pivot TAGNAME'
organize reports by some tag's value instead of by account
'--anon'
hledger help options:
show anonymized accounts and payees
'-h'
show general usage (or after COMMAND, the command's usage)
'--help'
show the current program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
'--man'
show the current program's manual with man
'--info'
show the current program's manual with info
'--version'
show version
'--debug[=N]'
show debug output (levels 1-9, default: 1)

File: hledger-ui.1.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
@ -353,17 +357,17 @@ Tag Table:
Node: Top73
Node: OPTIONS825
Ref: #options924
Node: KEYS3631
Ref: #keys3728
Node: SCREENS6316
Ref: #screens6403
Node: Accounts screen6493
Ref: #accounts-screen6623
Node: Register screen8672
Ref: #register-screen8829
Node: Transaction screen10718
Ref: #transaction-screen10878
Node: Error screen11748
Ref: #error-screen11872
Node: KEYS3677
Ref: #keys3774
Node: SCREENS6362
Ref: #screens6449
Node: Accounts screen6539
Ref: #accounts-screen6669
Node: Register screen8718
Ref: #register-screen8875
Node: Transaction screen10764
Ref: #transaction-screen10924
Node: Error screen11794
Ref: #error-screen11918

End Tag Table

47
hledger-ui/doc/hledger-ui.1.txt
View File

@ -50,35 +50,26 @@ OPTIONS
--flat show full account names, unindented
hledger general options:
-h show general usage (or after COMMAND, the command's usage)
--help show the current program's manual as plain text (or after an
add-on COMMAND, the add-on's manual)
--man show the current program's manual with man
--info show the current program's manual with info
--version
show version
--debug[=N]
show debug output (levels 1-9, default: 1)
hledger input options:
-f FILE --file=FILE
use a different input file. For stdin, use -
use a different input file. For stdin, use - (default:
$LEDGER_FILE or $HOME/.hledger.journal)
--rules-file=RULESFILE
Conversion rules file to use when reading CSV (default:
FILE.rules)
--alias=OLD=NEW
display accounts named OLD as NEW
rename accounts named OLD to NEW
--anon anonymize accounts and payees
--pivot TAGNAME
use some other field/tag for account names
-I --ignore-assertions
ignore any failing balance assertions in the journal
ignore any failing balance assertions
hledger reporting options:
@ -136,10 +127,22 @@ OPTIONS
convert amounts to their market value on the report end date
(using the most recent applicable market price, if any)
--pivot TAGNAME
organize reports by some tag's value instead of by account
hledger help options:
--anon show anonymized accounts and payees
-h show general usage (or after COMMAND, the command's usage)
--help show the current program's manual as plain text (or after an
add-on COMMAND, the add-on's manual)
--man show the current program's manual with man
--info show the current program's manual with info
--version
show version
--debug[=N]
show debug output (levels 1-9, default: 1)
KEYS
? shows a help dialog listing all keys. (Some of these also appear in

81
hledger-web/doc/hledger-web.1
View File

@ -120,42 +120,12 @@ with this.
.RS
.RE
.PP
hledger general options:
.TP
.B \f[C]\-h\f[]
show general usage (or after COMMAND, the command\[aq]s usage)
.RS
.RE
.TP
.B \f[C]\-\-help\f[]
show the current program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual)
.RS
.RE
.TP
.B \f[C]\-\-man\f[]
show the current program\[aq]s manual with man
.RS
.RE
.TP
.B \f[C]\-\-info\f[]
show the current program\[aq]s manual with info
.RS
.RE
.TP
.B \f[C]\-\-version\f[]
show version
.RS
.RE
.TP
.B \f[C]\-\-debug[=N]\f[]
show debug output (levels 1\-9, default: 1)
.RS
.RE
hledger input options:
.TP
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
use a different input file.
For stdin, use \-
For stdin, use \- (default: \f[C]$LEDGER_FILE\f[] or
\f[C]$HOME/.hledger.journal\f[])
.RS
.RE
.TP
@ -165,12 +135,22 @@ Conversion rules file to use when reading CSV (default: FILE.rules)
.RE
.TP
.B \f[C]\-\-alias=OLD=NEW\f[]
display accounts named OLD as NEW
rename accounts named OLD to NEW
.RS
.RE
.TP
.B \f[C]\-\-anon\f[]
anonymize accounts and payees
.RS
.RE
.TP
.B \f[C]\-\-pivot\ TAGNAME\f[]
use some other field/tag for account names
.RS
.RE
.TP
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
ignore any failing balance assertions in the journal
ignore any failing balance assertions
.RS
.RE
.PP
@ -263,14 +243,37 @@ convert amounts to their market value on the report end date (using the
most recent applicable market price, if any)
.RS
.RE
.PP
hledger help options:
.TP
.B \f[C]\-\-pivot\ TAGNAME\f[]
organize reports by some tag\[aq]s value instead of by account
.B \f[C]\-h\f[]
show general usage (or after COMMAND, the command\[aq]s usage)
.RS
.RE
.TP
.B \f[C]\-\-anon\f[]
show anonymized accounts and payees
.B \f[C]\-\-help\f[]
show the current program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual)
.RS
.RE
.TP
.B \f[C]\-\-man\f[]
show the current program\[aq]s manual with man
.RS
.RE
.TP
.B \f[C]\-\-info\f[]
show the current program\[aq]s manual with info
.RS
.RE
.TP
.B \f[C]\-\-version\f[]
show version
.RS
.RE
.TP
.B \f[C]\-\-debug[=N]\f[]
show debug output (levels 1\-9, default: 1)
.RS
.RE
.SH ENVIRONMENT

58
hledger-web/doc/hledger-web.1.info
View File

@ -97,39 +97,27 @@ options as shown above.
them from another server for efficiency, you would set the url with
this.
hledger general options:
hledger input options:
'-h'
show general usage (or after COMMAND, the command's usage)
'--help'
show the current program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
'--man'
show the current program's manual with man
'--info'
show the current program's manual with info
'--version'
show version
'--debug[=N]'
show debug output (levels 1-9, default: 1)
'-f FILE --file=FILE'
use a different input file. For stdin, use -
use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules)
'--alias=OLD=NEW'
display accounts named OLD as NEW
rename accounts named OLD to NEW
'--anon'
anonymize accounts and payees
'--pivot TAGNAME'
use some other field/tag for account names
'-I --ignore-assertions'
ignore any failing balance assertions in the journal
ignore any failing balance assertions
hledger reporting options:
@ -187,12 +175,28 @@ options as shown above.
convert amounts to their market value on the report end date (using
the most recent applicable market price, if any)
'--pivot TAGNAME'
organize reports by some tag's value instead of by account
'--anon'
hledger help options:
show anonymized accounts and payees
'-h'
show general usage (or after COMMAND, the command's usage)
'--help'
show the current program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
'--man'
show the current program's manual with man
'--info'
show the current program's manual with info
'--version'
show version
'--debug[=N]'
show debug output (levels 1-9, default: 1)

Tag Table:

47
hledger-web/doc/hledger-web.1.txt
View File

@ -95,35 +95,26 @@ OPTIONS
them from another server for efficiency, you would set the url
with this.
hledger general options:
-h show general usage (or after COMMAND, the command's usage)
--help show the current program's manual as plain text (or after an
add-on COMMAND, the add-on's manual)
--man show the current program's manual with man
--info show the current program's manual with info
--version
show version
--debug[=N]
show debug output (levels 1-9, default: 1)
hledger input options:
-f FILE --file=FILE
use a different input file. For stdin, use -
use a different input file. For stdin, use - (default:
$LEDGER_FILE or $HOME/.hledger.journal)
--rules-file=RULESFILE
Conversion rules file to use when reading CSV (default:
FILE.rules)
--alias=OLD=NEW
display accounts named OLD as NEW
rename accounts named OLD to NEW
--anon anonymize accounts and payees
--pivot TAGNAME
use some other field/tag for account names
-I --ignore-assertions
ignore any failing balance assertions in the journal
ignore any failing balance assertions
hledger reporting options:
@ -181,10 +172,22 @@ OPTIONS
convert amounts to their market value on the report end date
(using the most recent applicable market price, if any)
--pivot TAGNAME
organize reports by some tag's value instead of by account
hledger help options:
--anon show anonymized accounts and payees
-h show general usage (or after COMMAND, the command's usage)
--help show the current program's manual as plain text (or after an
add-on COMMAND, the add-on's manual)
--man show the current program's manual with man
--info show the current program's manual with info
--version
show version
--debug[=N]
show debug output (levels 1-9, default: 1)
ENVIRONMENT
LEDGER_FILE The journal file path when not specified with -f. Default:

125
hledger/doc/hledger.1
View File

@ -149,76 +149,60 @@ $\ hledger\ activity\ \-W\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ tran
.fi
.SH OPTIONS
.PP
To see general usage and the command list: \f[C]hledger\ \-h\f[] or just
\f[C]hledger\f[].
To see usage for a specific command: \f[C]hledger\ COMMAND\ \-h\f[].
To see general usage help, including general options which are supported
by most hledger commands, run \f[C]hledger\ \-h\f[].
(Note \-h and \-\-help are different, like git.) These options can
appear anywhere on the command line, and are listed below.
.PP
hledger has several kinds of options:
.IP \[bu] 2
General options are always available and can appear anywhere on the
command line.
\f[C]hledger\ \-h\f[] shows these.
Eg: \f[C]hledger\ \-\-version\f[].
.IP \[bu] 2
Common reporting options are available with most commands.
These and all other non\-general options must be written after COMMAND.
\f[C]hledger\ COMMAND\ \-h\f[] shows these.
Eg: \f[C]hledger\ register\ \-\-cleared\f[].
.IP \[bu] 2
Command\-specific options are also provided by some commands.
\f[C]hledger\ COMMAND\ \-h\f[] shows these too.
Eg: \f[C]hledger\ register\ \-\-average\f[].
.IP \[bu] 2
Some hledger commands come from separate add\-on executables, which have
their own options.
\f[C]hledger\ COMMAND\ \-h\f[] shows these, as usual.
Such options, if not also supported by hledger, should be written
following a double hyphen argument (\f[C]\-\-\f[]) so that hledger\[aq]s
option parser does not complain.
Eg: \f[C]hledger\ ui\ \-\-\ \-\-register=checking\f[].
Or, you can just run the add\-on directly:
\f[C]hledger\-ui\ \-\-register=checking\f[].
To see usage for a specific command, run:
\f[C]hledger\ COMMAND\ \-h\f[].
Command\-specific options must be written after the command name, eg:
\f[C]hledger\ print\ \-x\f[].
.PP
Command arguments may also follow the command name.
In most cases these specify a query which filters the data.
Command options and arguments can be intermixed.
Additionally, if the command is an add\-on, you may need to put its
options after a double\-hyphen, eg:
\f[C]hledger\ ui\ \-\-\ \-\-watch\f[].
Or, you can run the add\-on executable directly, eg:
\f[C]hledger\-ui\ \-\-watch\f[].
.PP
Option and argument values containing problematic characters should be
escaped with double quotes, backslashes, or (best) single quotes.
This means spaces, but also characters which are significant to your
command shell, such as less\-than/greater\-than.
Most commands also accept arguments, which are often a query filtering
the data in some way.
.SS Special characters
.PP
Option and argument values which contain problematic characters should
be escaped with double quotes, backslashes, or (best) single quotes.
Problematic characters means spaces, and also characters which are
significant to your command shell, such as less\-than/greater\-than.
Eg:
\f[C]hledger\ register\ \-p\ \[aq]last\ year\[aq]\ "accounts\ receivable\ (receivable|payable)"\ amt:\\>100\f[].
.PP
Characters which are significant to the shell and also in regular
expressions, like parentheses, the pipe symbol and the dollar sign, must
sometimes be double\-escaped.
Eg, to match the dollar symbol:
Characters which are significant both to the shell and in regular
expressions sometimes need to be double\-escaped.
These include parentheses, the pipe symbol and the dollar sign.
Eg, to match the dollar symbol, bash users should do:
\f[C]hledger\ balance\ cur:\[aq]\\$\[aq]\f[] or
\f[C]hledger\ balance\ cur:\\\\$\f[].
.PP
There\[aq]s more..
options and arguments being passed by hledger to an add\-on executable
get de\-escaped once in the process.
In this case you might need triple\-escaping.
options and arguments get de\-escaped when hledger is passing them to an
addon executable.
In this case you might need \f[I]triple\f[]\-escaping.
Eg: \f[C]hledger\ ui\ cur:\[aq]\\\\$\[aq]\f[] or
\f[C]hledger\ ui\ cur:\\\\\\\\$\f[].
.PP
If in doubt, keep things simple:
.IP \[bu] 2
run add\-on executables directly
.IP \[bu] 2
write options after the command
.IP \[bu] 2
enclose problematic args in single quotes
.IP \[bu] 2
if needed, also add a backslash to escape regexp metacharacters
.IP \[bu] 2
run add\-on executables directly
.PP
If you\[aq]re really curious, add \f[C]\-\-debug=2\f[] for
troubleshooting.
If you\[aq]re really stumped, add \f[C]\-\-debug=2\f[] to troubleshoot.
.SS General options
.PP
Always available, can be written before or after COMMAND.
.SS General help options
.TP
.B \f[C]\-h\f[]
show general usage (or after COMMAND, the command\[aq]s usage)
@ -250,10 +234,12 @@ show version
show debug output (levels 1\-9, default: 1)
.RS
.RE
.SS General input options
.TP
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
use a different input file.
For stdin, use \-
For stdin, use \- (default: \f[C]$LEDGER_FILE\f[] or
\f[C]$HOME/.hledger.journal\f[])
.RS
.RE
.TP
@ -263,17 +249,25 @@ Conversion rules file to use when reading CSV (default: FILE.rules)
.RE
.TP
.B \f[C]\-\-alias=OLD=NEW\f[]
display accounts named OLD as NEW
rename accounts named OLD to NEW
.RS
.RE
.TP
.B \f[C]\-\-anon\f[]
anonymize accounts and payees
.RS
.RE
.TP
.B \f[C]\-\-pivot\ TAGNAME\f[]
use some other field/tag for account names
.RS
.RE
.TP
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
ignore any failing balance assertions in the journal
ignore any failing balance assertions
.RS
.RE
.SS Reporting options
.PP
Common reporting options, must be written after COMMAND.
.SS General reporting options
.TP
.B \f[C]\-b\ \-\-begin=DATE\f[]
include postings/txns on or after this date
@ -362,20 +356,12 @@ convert amounts to their market value on the report end date (using the
most recent applicable market price, if any)
.RS
.RE
.TP
.B \f[C]\-\-pivot\ TAGNAME\f[]
organize reports by some tag\[aq]s value instead of by account
.RS
.RE
.TP
.B \f[C]\-\-anon\f[]
show anonymized accounts and payees
.RS
.RE
.PP
If a reporting option occurs more than once on the command line, the
last one takes precedence.
Eg \-p jan \-p feb is equivalent to \-p feb.
Note when multiple similar reporting options are provided, the last one
takes precedence.
Eg \f[C]\-p\ feb\ \-p\ mar\f[] is equivalent to \f[C]\-p\ mar\f[].
.PP
Some of these can also be written as queries.
.SS Input files
.PP
hledger reads transactions from a data file (and the add command writes
@ -1290,6 +1276,11 @@ write output to FILE.
A file extension matching one of the above formats selects that format.
.RS
.RE
.TP
.B \f[C]\-\-pretty\-tables\f[]
Use unicode to display prettier tables.
.RS
.RE
.PP
The balance command displays accounts and balances.
It is hledger\[aq]s most featureful and most useful command.

398
hledger/doc/hledger.1.info
View File

@ -114,63 +114,25 @@ File: hledger.1.info, Node: OPTIONS, Next: QUERIES, Prev: EXAMPLES, Up: Top
2 OPTIONS
*********
To see general usage and the command list: 'hledger -h' or just
'hledger'. To see usage for a specific command: 'hledger COMMAND -h'.
To see general usage help, including general options which are supported
by most hledger commands, run 'hledger -h'. (Note -h and -help are
different, like git.) These options can appear anywhere on the command
line, and are listed below.
hledger has several kinds of options:
To see usage for a specific command, run: 'hledger COMMAND -h'.
Command-specific options must be written after the command name, eg:
'hledger print -x'.
* General options are always available and can appear anywhere on the
command line. 'hledger -h' shows these. Eg: 'hledger --version'.
Additionally, if the command is an add-on, you may need to put its
options after a double-hyphen, eg: 'hledger ui -- --watch'. Or, you can
run the add-on executable directly, eg: 'hledger-ui --watch'.
* Common reporting options are available with most commands. These
and all other non-general options must be written after COMMAND.
'hledger COMMAND -h' shows these. Eg: 'hledger register
--cleared'.
* Command-specific options are also provided by some commands.
'hledger COMMAND -h' shows these too. Eg: 'hledger register
--average'.
* Some hledger commands come from separate add-on executables, which
have their own options. 'hledger COMMAND -h' shows these, as
usual. Such options, if not also supported by hledger, should be
written following a double hyphen argument ('--') so that hledger's
option parser does not complain. Eg: 'hledger ui --
--register=checking'. Or, you can just run the add-on directly:
'hledger-ui --register=checking'.
Command arguments may also follow the command name. In most cases
these specify a query which filters the data. Command options and
arguments can be intermixed.
Option and argument values containing problematic characters should
be escaped with double quotes, backslashes, or (best) single quotes.
This means spaces, but also characters which are significant to your
command shell, such as less-than/greater-than. Eg: 'hledger register -p
'last year' "accounts receivable (receivable|payable)" amt:\>100'.
Characters which are significant to the shell and also in regular
expressions, like parentheses, the pipe symbol and the dollar sign, must
sometimes be double-escaped. Eg, to match the dollar symbol: 'hledger
balance cur:'\$'' or 'hledger balance cur:\\$'.
There's more.. options and arguments being passed by hledger to an
add-on executable get de-escaped once in the process. In this case you
might need triple-escaping. Eg: 'hledger ui cur:'\\$'' or 'hledger ui
cur:\\\\$'.
If in doubt, keep things simple:
* write options after the command
* enclose problematic args in single quotes
* if needed, also add a backslash to escape regexp metacharacters
* run add-on executables directly
If you're really curious, add '--debug=2' for troubleshooting.
Most commands also accept arguments, which are often a query
filtering the data in some way.
* Menu:
* Special characters::
* General options::
* Reporting options::
* Input files::
* Smart dates::
* Report start & end date::
@ -181,12 +143,55 @@ cur:\\\\$'.
* Regular expressions::

File: hledger.1.info, Node: General options, Next: Reporting options, Up: OPTIONS
File: hledger.1.info, Node: Special characters, Next: General options, Up: OPTIONS
2.1 General options
2.1 Special characters
======================
Option and argument values which contain problematic characters should
be escaped with double quotes, backslashes, or (best) single quotes.
Problematic characters means spaces, and also characters which are
significant to your command shell, such as less-than/greater-than. Eg:
'hledger register -p 'last year' "accounts receivable
(receivable|payable)" amt:\>100'.
Characters which are significant both to the shell and in regular
expressions sometimes need to be double-escaped. These include
parentheses, the pipe symbol and the dollar sign. Eg, to match the
dollar symbol, bash users should do: 'hledger balance cur:'\$'' or
'hledger balance cur:\\$'.
There's more.. options and arguments get de-escaped when hledger is
passing them to an addon executable. In this case you might need
_triple_-escaping. Eg: 'hledger ui cur:'\\$'' or 'hledger ui
cur:\\\\$'.
If in doubt, keep things simple:
* run add-on executables directly
* write options after the command
* enclose problematic args in single quotes
* if needed, also add a backslash to escape regexp metacharacters
If you're really stumped, add '--debug=2' to troubleshoot.

File: hledger.1.info, Node: General options, Next: Input files, Prev: Special characters, Up: OPTIONS
2.2 General options
===================
Always available, can be written before or after COMMAND.
* Menu:
* General help options::
* General input options::
* General reporting options::

File: hledger.1.info, Node: General help options, Next: General input options, Up: General options
2.2.1 General help options
--------------------------
'-h'
@ -207,26 +212,38 @@ Always available, can be written before or after COMMAND.
'--debug[=N]'
show debug output (levels 1-9, default: 1)

File: hledger.1.info, Node: General input options, Next: General reporting options, Prev: General help options, Up: General options
2.2.2 General input options
---------------------------
'-f FILE --file=FILE'
use a different input file. For stdin, use -
use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules)
'--alias=OLD=NEW'
display accounts named OLD as NEW
rename accounts named OLD to NEW
'--anon'
anonymize accounts and payees
'--pivot TAGNAME'
use some other field/tag for account names
'-I --ignore-assertions'
ignore any failing balance assertions in the journal
ignore any failing balance assertions

File: hledger.1.info, Node: Reporting options, Next: Input files, Prev: General options, Up: OPTIONS
File: hledger.1.info, Node: General reporting options, Prev: General input options, Up: General options
2.2 Reporting options
=====================
Common reporting options, must be written after COMMAND.
2.2.3 General reporting options
-------------------------------
'-b --begin=DATE'
@ -282,18 +299,14 @@ Common reporting options, must be written after COMMAND.
convert amounts to their market value on the report end date (using
the most recent applicable market price, if any)
'--pivot TAGNAME'
organize reports by some tag's value instead of by account
'--anon'
Note when multiple similar reporting options are provided, the last
one takes precedence. Eg '-p feb -p mar' is equivalent to '-p mar'.
show anonymized accounts and payees
If a reporting option occurs more than once on the command line, the
last one takes precedence. Eg -p jan -p feb is equivalent to -p feb.
Some of these can also be written as queries.

File: hledger.1.info, Node: Input files, Next: Smart dates, Prev: Reporting options, Up: OPTIONS
File: hledger.1.info, Node: Input files, Next: Smart dates, Prev: General options, Up: OPTIONS
2.3 Input files
===============
@ -941,6 +954,9 @@ Show accounts and their balances. Alias: bal.
write output to FILE. A file extension matching one of the above
formats selects that format.
'--pretty-tables'
Use unicode to display prettier tables.
The balance command displays accounts and balances. It is hledger's
most featureful and most useful command.
@ -2192,123 +2208,129 @@ Node: EXAMPLES1883
Ref: #examples1985
Node: OPTIONS3631
Ref: #options3735
Node: General options6393
Ref: #general-options6522
Node: Reporting options7295
Ref: #reporting-options7448
Node: Input files9024
Ref: #input-files9161
Node: Smart dates11124
Ref: #smart-dates11267
Node: Report start & end date12246
Ref: #report-start-end-date12418
Node: Report intervals13484
Ref: #report-intervals13649
Node: Period expressions14050
Ref: #period-expressions14210
Node: Depth limiting16550
Ref: #depth-limiting16694
Node: Pivoting16895
Ref: #pivoting17028
Node: Regular expressions18857
Ref: #regular-expressions18991
Node: QUERIES20469
Ref: #queries20573
Node: COMMANDS24219
Ref: #commands24333
Node: accounts25006
Ref: #accounts25106
Node: activity26088
Ref: #activity26200
Node: add26559
Ref: #add26660
Node: balance29318
Ref: #balance29431
Node: Flat mode32309
Ref: #flat-mode32436
Node: Depth limited balance reports32856
Ref: #depth-limited-balance-reports33059
Node: Multicolumn balance reports33479
Ref: #multicolumn-balance-reports33681
Node: Market value38329
Ref: #market-value38493
Node: Custom balance output39793
Ref: #custom-balance-output39966
Node: Output destination42059
Ref: #output-destination42224
Node: CSV output42494
Ref: #csv-output42613
Node: balancesheet43010
Ref: #balancesheet43138
Node: cashflow45057
Ref: #cashflow45174
Node: help47072
Ref: #help47184
Node: incomestatement48022
Ref: #incomestatement48152
Node: info50067
Ref: #info50174
Node: man50538
Ref: #man50635
Node: print51040
Ref: #print51145
Node: register54901
Ref: #register55014
Node: Custom register output59510
Ref: #custom-register-output59641
Node: stats60938
Ref: #stats61044
Node: test61925
Ref: #test62012
Node: ADD-ON COMMANDS62380
Ref: #add-on-commands62516
Node: Official add-ons63803
Ref: #official-add-ons63945
Node: api64032
Ref: #api64123
Node: ui64175
Ref: #ui64276
Node: web64334
Ref: #web64425
Node: Third party add-ons64471
Ref: #third-party-add-ons64648
Node: diff64783
Ref: #diff64882
Node: iadd64981
Ref: #iadd65097
Node: interest65180
Ref: #interest65303
Node: irr65398
Ref: #irr65498
Node: Experimental add-ons65576
Ref: #experimental-add-ons65730
Node: autosync66123
Ref: #autosync66237
Node: budget66476
Ref: #budget66600
Node: chart66666
Ref: #chart66785
Node: check66856
Ref: #check66980
Node: check-dates67047
Ref: #check-dates67189
Node: check-dupes67262
Ref: #check-dupes67405
Node: equity67482
Ref: #equity67610
Node: prices67729
Ref: #prices67858
Node: print-unique67913
Ref: #print-unique68062
Node: register-match68155
Ref: #register-match68311
Node: rewrite68409
Ref: #rewrite68530
Node: TROUBLESHOOTING68608
Ref: #troubleshooting68727
Node: Run-time problems68781
Ref: #run-time-problems68924
Node: Known limitations70871
Ref: #known-limitations71014
Node: Special characters4649
Ref: #special-characters4785
Node: General options5953
Ref: #general-options6103
Node: General help options6194
Ref: #general-help-options6354
Node: General input options6753
Ref: #general-input-options6949
Node: General reporting options7420
Ref: #general-reporting-options7595
Node: Input files9027
Ref: #input-files9162
Node: Smart dates11125
Ref: #smart-dates11268
Node: Report start & end date12247
Ref: #report-start-end-date12419
Node: Report intervals13485
Ref: #report-intervals13650
Node: Period expressions14051
Ref: #period-expressions14211
Node: Depth limiting16551
Ref: #depth-limiting16695
Node: Pivoting16896
Ref: #pivoting17029
Node: Regular expressions18858
Ref: #regular-expressions18992
Node: QUERIES20470
Ref: #queries20574
Node: COMMANDS24220
Ref: #commands24334
Node: accounts25007
Ref: #accounts25107
Node: activity26089
Ref: #activity26201
Node: add26560
Ref: #add26661
Node: balance29319
Ref: #balance29432
Node: Flat mode32374
Ref: #flat-mode32501
Node: Depth limited balance reports32921
Ref: #depth-limited-balance-reports33124
Node: Multicolumn balance reports33544
Ref: #multicolumn-balance-reports33746
Node: Market value38394
Ref: #market-value38558
Node: Custom balance output39858
Ref: #custom-balance-output40031
Node: Output destination42124
Ref: #output-destination42289
Node: CSV output42559
Ref: #csv-output42678
Node: balancesheet43075
Ref: #balancesheet43203
Node: cashflow45122
Ref: #cashflow45239
Node: help47137
Ref: #help47249
Node: incomestatement48087
Ref: #incomestatement48217
Node: info50132
Ref: #info50239
Node: man50603
Ref: #man50700
Node: print51105
Ref: #print51210
Node: register54966
Ref: #register55079
Node: Custom register output59575
Ref: #custom-register-output59706
Node: stats61003
Ref: #stats61109
Node: test61990
Ref: #test62077
Node: ADD-ON COMMANDS62445
Ref: #add-on-commands62581
Node: Official add-ons63868
Ref: #official-add-ons64010
Node: api64097
Ref: #api64188
Node: ui64240
Ref: #ui64341
Node: web64399
Ref: #web64490
Node: Third party add-ons64536
Ref: #third-party-add-ons64713
Node: diff64848
Ref: #diff64947
Node: iadd65046
Ref: #iadd65162
Node: interest65245
Ref: #interest65368
Node: irr65463
Ref: #irr65563
Node: Experimental add-ons65641
Ref: #experimental-add-ons65795
Node: autosync66188
Ref: #autosync66302
Node: budget66541
Ref: #budget66665
Node: chart66731
Ref: #chart66850
Node: check66921
Ref: #check67045
Node: check-dates67112
Ref: #check-dates67254
Node: check-dupes67327
Ref: #check-dupes67470
Node: equity67547
Ref: #equity67675
Node: prices67794
Ref: #prices67923
Node: print-unique67978
Ref: #print-unique68127
Node: register-match68220
Ref: #register-match68376
Node: rewrite68474
Ref: #rewrite68595
Node: TROUBLESHOOTING68673
Ref: #troubleshooting68792
Node: Run-time problems68846
Ref: #run-time-problems68989
Node: Known limitations70936
Ref: #known-limitations71079

End Tag Table

104
hledger/doc/hledger.1.txt
View File

@ -108,65 +108,54 @@ EXAMPLES
$ hledger activity -W # show transaction counts per week as a bar chart
OPTIONS
To see general usage and the command list: hledger -h or just hledger.
To see usage for a specific command: hledger COMMAND -h.
To see general usage help, including general options which are sup-
ported by most hledger commands, run hledger -h. (Note -h and --help
are different, like git.) These options can appear anywhere on the com-
mand line, and are listed below.
hledger has several kinds of options:
To see usage for a specific command, run: hledger COMMAND -h. Com-
mand-specific options must be written after the command name, eg:
hledger print -x.
o General options are always available and can appear anywhere on the
command line. hledger -h shows these. Eg: hledger --version.
Additionally, if the command is an add-on, you may need to put its
options after a double-hyphen, eg: hledger ui -- --watch. Or, you can
run the add-on executable directly, eg: hledger-ui --watch.
o Common reporting options are available with most commands. These and
all other non-general options must be written after COMMAND.
hledger COMMAND -h shows these. Eg: hledger register --cleared.
Most commands also accept arguments, which are often a query filtering
the data in some way.
o Command-specific options are also provided by some commands.
hledger COMMAND -h shows these too. Eg: hledger register --average.
o Some hledger commands come from separate add-on executables, which
have their own options. hledger COMMAND -h shows these, as usual.
Such options, if not also supported by hledger, should be written
following a double hyphen argument (--) so that hledger's option
parser does not complain. Eg: hledger ui -- --register=checking.
Or, you can just run the add-on directly: hledger-ui --regis-
ter=checking.
Command arguments may also follow the command name. In most cases
these specify a query which filters the data. Command options and
arguments can be intermixed.
Option and argument values containing problematic characters should be
escaped with double quotes, backslashes, or (best) single quotes. This
means spaces, but also characters which are significant to your command
shell, such as less-than/greater-than. Eg: hledger regis-
ter -p 'last year' "accounts receivable (receiv-
Special characters
Option and argument values which contain problematic characters should
be escaped with double quotes, backslashes, or (best) single quotes.
Problematic characters means spaces, and also characters which are sig-
nificant to your command shell, such as less-than/greater-than. Eg:
hledger register -p 'last year' "accounts receivable (receiv-
able|payable)" amt:\>100.
Characters which are significant to the shell and also in regular
expressions, like parentheses, the pipe symbol and the dollar sign,
must sometimes be double-escaped. Eg, to match the dollar symbol:
hledger balance cur:'\$' or hledger balance cur:\\$.
Characters which are significant both to the shell and in regular
expressions sometimes need to be double-escaped. These include paren-
theses, the pipe symbol and the dollar sign. Eg, to match the dollar
symbol, bash users should do: hledger balance cur:'\$' or hledger bal-
ance cur:\\$.
There's more.. options and arguments being passed by hledger to an
add-on executable get de-escaped once in the process. In this case you
might need triple-escaping. Eg: hledger ui cur:'\\$' or
hledger ui cur:\\\\$.
There's more.. options and arguments get de-escaped when hledger is
passing them to an addon executable. In this case you might need
triple-escaping. Eg: hledger ui cur:'\\$' or hledger ui cur:\\\\$.
If in doubt, keep things simple:
o run add-on executables directly
o write options after the command
o enclose problematic args in single quotes
o if needed, also add a backslash to escape regexp metacharacters
o run add-on executables directly
If you're really curious, add --debug=2 for troubleshooting.
If you're really stumped, add --debug=2 to troubleshoot.
General options
Always available, can be written before or after COMMAND.
General help options
-h show general usage (or after COMMAND, the command's usage)
--help show the current program's manual as plain text (or after an
@ -182,22 +171,27 @@ OPTIONS
--debug[=N]
show debug output (levels 1-9, default: 1)
General input options
-f FILE --file=FILE
use a different input file. For stdin, use -
use a different input file. For stdin, use - (default:
$LEDGER_FILE or $HOME/.hledger.journal)
--rules-file=RULESFILE
Conversion rules file to use when reading CSV (default:
FILE.rules)
--alias=OLD=NEW
display accounts named OLD as NEW
rename accounts named OLD to NEW
--anon anonymize accounts and payees
--pivot TAGNAME
use some other field/tag for account names
-I --ignore-assertions
ignore any failing balance assertions in the journal
Reporting options
Common reporting options, must be written after COMMAND.
ignore any failing balance assertions
General reporting options
-b --begin=DATE
include postings/txns on or after this date
@ -252,13 +246,10 @@ OPTIONS
convert amounts to their market value on the report end date
(using the most recent applicable market price, if any)
--pivot TAGNAME
organize reports by some tag's value instead of by account
Note when multiple similar reporting options are provided, the last one
takes precedence. Eg -p feb -p mar is equivalent to -p mar.
--anon show anonymized accounts and payees
If a reporting option occurs more than once on the command line, the
last one takes precedence. Eg -p jan -p feb is equivalent to -p feb.
Some of these can also be written as queries.
Input files
hledger reads transactions from a data file (and the add command writes
@ -332,8 +323,6 @@ OPTIONS
this month the 1st of the current
month
this week the most recent monday
last week the monday of the week
before this one
lastweek spaces are optional
@ -411,6 +400,8 @@ OPTIONS
earliest or latest transaction in your journal:
-p "from 2009/1/1" everything after january
1, 2009
-p "from 2009/1" the same
@ -865,6 +856,9 @@ COMMANDS
write output to FILE. A file extension matching one of the
above formats selects that format.
--pretty-tables
Use unicode to display prettier tables.
The balance command displays accounts and balances. It is hledger's
most featureful and most useful command.