doc: update generated files
This commit is contained in:
Simon Michael
parent
7df15a8279
commit
01a2aa9394
@ -12,10 +12,6 @@ hledger\-api \- web API server for the hledger accounting tool
|
|||||||
.PD 0
|
.PD 0
|
||||||
.P
|
.P
|
||||||
.PD
|
.PD
|
||||||
\f[C]hledger\-api\ \-\-swagger\f[]
|
|
||||||
.PD 0
|
|
||||||
.P
|
|
||||||
.PD
|
|
||||||
\f[C]hledger\ api\ \-\-\ [OPTIONS]\f[]
|
\f[C]hledger\ api\ \-\-\ [OPTIONS]\f[]
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.PP
|
.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
|
Note: if invoking hledger\-api as a hledger subcommand, write
|
||||||
\f[C]\-\-\f[] before options as shown above.
|
\f[C]\-\-\f[] before options as shown above.
|
||||||
.TP
|
.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[]
|
.B \f[C]\-d\ \-\-static\-dir=DIR\f[]
|
||||||
serve files from a different directory (default: \f[C]\&.\f[])
|
serve files from a different directory (default: \f[C]\&.\f[])
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.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[]
|
.B \f[C]\-p\ \-\-port=PORT\f[]
|
||||||
use a different TCP port (default: 8001)
|
listen on this TCP port (default: 8001)
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
@ -65,58 +73,29 @@ use a different TCP port (default: 8001)
|
|||||||
print API docs in Swagger 2.0 format, and exit
|
print API docs in Swagger 2.0 format, and exit
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.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
|
.TP
|
||||||
.B \f[C]\-\-version\f[]
|
.B \f[C]\-\-version\f[]
|
||||||
show version
|
show version
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-debug[=N]\f[]
|
.B \f[C]\-h\f[]
|
||||||
show debug output (levels 1\-9, default: 1)
|
show usage
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
|
.B \f[C]\-\-help\f[]
|
||||||
use a different input file.
|
show manual as plain text
|
||||||
For stdin, use \-
|
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-rules\-file=RULESFILE\f[]
|
.B \f[C]\-\-man\f[]
|
||||||
Conversion rules file to use when reading CSV (default: FILE.rules)
|
show manual with man
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-alias=OLD=NEW\f[]
|
.B \f[C]\-\-info\f[]
|
||||||
display accounts named OLD as NEW
|
show manual with info
|
||||||
.RS
|
|
||||||
.RE
|
|
||||||
.TP
|
|
||||||
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
|
|
||||||
ignore any failing balance assertions in the journal
|
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.SH ENVIRONMENT
|
.SH ENVIRONMENT
|
||||||
|
|||||||
@ -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
|
Note: if invoking hledger-api as a hledger subcommand, write '--' before
|
||||||
options as shown above.
|
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'
|
'-d --static-dir=DIR'
|
||||||
|
|
||||||
serve files from a different directory (default: '.')
|
serve files from a different directory (default: '.')
|
||||||
|
'--host=IPADDR'
|
||||||
|
|
||||||
|
listen on this IP address (default: 127.0.0.1)
|
||||||
'-p --port=PORT'
|
'-p --port=PORT'
|
||||||
|
|
||||||
use a different TCP port (default: 8001)
|
listen on this TCP port (default: 8001)
|
||||||
'--swagger'
|
'--swagger'
|
||||||
|
|
||||||
print API docs in Swagger 2.0 format, and exit
|
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'
|
'--version'
|
||||||
|
|
||||||
show version
|
show version
|
||||||
'--debug[=N]'
|
'-h'
|
||||||
|
|
||||||
show debug output (levels 1-9, default: 1)
|
show usage
|
||||||
'-f FILE --file=FILE'
|
'--help'
|
||||||
|
|
||||||
use a different input file. For stdin, use -
|
show manual as plain text
|
||||||
'--rules-file=RULESFILE'
|
'--man'
|
||||||
|
|
||||||
Conversion rules file to use when reading CSV (default: FILE.rules)
|
show manual with man
|
||||||
'--alias=OLD=NEW'
|
'--info'
|
||||||
|
|
||||||
display accounts named OLD as NEW
|
show manual with info
|
||||||
'-I --ignore-assertions'
|
|
||||||
|
|
||||||
ignore any failing balance assertions in the journal
|
|
||||||
|
|
||||||
|
|
||||||
Tag Table:
|
Tag Table:
|
||||||
|
|||||||
@ -8,7 +8,6 @@ NAME
|
|||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
hledger-api [OPTIONS]
|
hledger-api [OPTIONS]
|
||||||
hledger-api --swagger
|
|
||||||
hledger api -- [OPTIONS]
|
hledger api -- [OPTIONS]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
@ -41,64 +40,52 @@ OPTIONS
|
|||||||
Note: if invoking hledger-api as a hledger subcommand, write -- before
|
Note: if invoking hledger-api as a hledger subcommand, write -- before
|
||||||
options as shown above.
|
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
|
-d --static-dir=DIR
|
||||||
serve files from a different directory (default: .)
|
serve files from a different directory (default: .)
|
||||||
|
|
||||||
|
--host=IPADDR
|
||||||
|
listen on this IP address (default: 127.0.0.1)
|
||||||
|
|
||||||
-p --port=PORT
|
-p --port=PORT
|
||||||
use a different TCP port (default: 8001)
|
listen on this TCP port (default: 8001)
|
||||||
|
|
||||||
--swagger
|
--swagger
|
||||||
print API docs in Swagger 2.0 format, and exit
|
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
|
--version
|
||||||
show version
|
show version
|
||||||
|
|
||||||
--debug[=N]
|
-h show usage
|
||||||
show debug output (levels 1-9, default: 1)
|
|
||||||
|
|
||||||
-f FILE --file=FILE
|
--help show manual as plain text
|
||||||
use a different input file. For stdin, use -
|
|
||||||
|
|
||||||
--rules-file=RULESFILE
|
--man show manual with man
|
||||||
Conversion rules file to use when reading CSV (default:
|
|
||||||
FILE.rules)
|
|
||||||
|
|
||||||
--alias=OLD=NEW
|
--info show manual with info
|
||||||
display accounts named OLD as NEW
|
|
||||||
|
|
||||||
-I --ignore-assertions
|
|
||||||
ignore any failing balance assertions in the journal
|
|
||||||
|
|
||||||
ENVIRONMENT
|
ENVIRONMENT
|
||||||
LEDGER_FILE The journal file path when not specified with -f. Default:
|
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).
|
nal).
|
||||||
|
|
||||||
FILES
|
FILES
|
||||||
Reads data from one or more files in hledger journal, timeclock, time-
|
Reads data from one or more files in hledger journal, timeclock, time-
|
||||||
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
||||||
$HOME/.hledger.journal (on windows, perhaps
|
$HOME/.hledger.journal (on windows, perhaps
|
||||||
C:/Users/USER/.hledger.journal).
|
C:/Users/USER/.hledger.journal).
|
||||||
|
|
||||||
BUGS
|
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.
|
ward.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
REPORTING BUGS
|
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)
|
or hledger mail list)
|
||||||
|
|
||||||
|
|
||||||
@ -112,7 +99,7 @@ COPYRIGHT
|
|||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
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-
|
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
|
||||||
dot(5), ledger(1)
|
dot(5), ledger(1)
|
||||||
|
|
||||||
|
|||||||
@ -64,42 +64,12 @@ show full account names, unindented
|
|||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
hledger general options:
|
hledger input 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
|
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
|
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
|
||||||
use a different input file.
|
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
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
@ -109,12 +79,22 @@ Conversion rules file to use when reading CSV (default: FILE.rules)
|
|||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-alias=OLD=NEW\f[]
|
.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
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
|
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
|
||||||
ignore any failing balance assertions in the journal
|
ignore any failing balance assertions
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.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)
|
most recent applicable market price, if any)
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
|
.PP
|
||||||
|
hledger help options:
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-pivot\ TAGNAME\f[]
|
.B \f[C]\-h\f[]
|
||||||
organize reports by some tag\[aq]s value instead of by account
|
show general usage (or after COMMAND, the command\[aq]s usage)
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-anon\f[]
|
.B \f[C]\-\-help\f[]
|
||||||
show anonymized accounts and payees
|
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
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.SH KEYS
|
.SH KEYS
|
||||||
|
|||||||
@ -52,39 +52,27 @@ the data.
|
|||||||
|
|
||||||
show full account names, unindented
|
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'
|
'-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'
|
'--rules-file=RULESFILE'
|
||||||
|
|
||||||
Conversion rules file to use when reading CSV (default: FILE.rules)
|
Conversion rules file to use when reading CSV (default: FILE.rules)
|
||||||
'--alias=OLD=NEW'
|
'--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'
|
'-I --ignore-assertions'
|
||||||
|
|
||||||
ignore any failing balance assertions in the journal
|
ignore any failing balance assertions
|
||||||
|
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
|
|
||||||
@ -142,12 +130,28 @@ the data.
|
|||||||
|
|
||||||
convert amounts to their market value on the report end date (using
|
convert amounts to their market value on the report end date (using
|
||||||
the most recent applicable market price, if any)
|
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)
|
||||||
|
|
||||||
|
|
||||||
File: hledger-ui.1.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
|
File: hledger-ui.1.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
|
||||||
@ -353,17 +357,17 @@ Tag Table:
|
|||||||
Node: Top73
|
Node: Top73
|
||||||
Node: OPTIONS825
|
Node: OPTIONS825
|
||||||
Ref: #options924
|
Ref: #options924
|
||||||
Node: KEYS3631
|
Node: KEYS3677
|
||||||
Ref: #keys3728
|
Ref: #keys3774
|
||||||
Node: SCREENS6316
|
Node: SCREENS6362
|
||||||
Ref: #screens6403
|
Ref: #screens6449
|
||||||
Node: Accounts screen6493
|
Node: Accounts screen6539
|
||||||
Ref: #accounts-screen6623
|
Ref: #accounts-screen6669
|
||||||
Node: Register screen8672
|
Node: Register screen8718
|
||||||
Ref: #register-screen8829
|
Ref: #register-screen8875
|
||||||
Node: Transaction screen10718
|
Node: Transaction screen10764
|
||||||
Ref: #transaction-screen10878
|
Ref: #transaction-screen10924
|
||||||
Node: Error screen11748
|
Node: Error screen11794
|
||||||
Ref: #error-screen11872
|
Ref: #error-screen11918
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|||||||
@ -50,35 +50,26 @@ OPTIONS
|
|||||||
|
|
||||||
--flat show full account names, unindented
|
--flat 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
|
-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
|
--rules-file=RULESFILE
|
||||||
Conversion rules file to use when reading CSV (default:
|
Conversion rules file to use when reading CSV (default:
|
||||||
FILE.rules)
|
FILE.rules)
|
||||||
|
|
||||||
--alias=OLD=NEW
|
--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
|
-I --ignore-assertions
|
||||||
ignore any failing balance assertions in the journal
|
ignore any failing balance assertions
|
||||||
|
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
|
|
||||||
@ -136,57 +127,69 @@ OPTIONS
|
|||||||
convert amounts to their market value on the report end date
|
convert amounts to their market value on the report end date
|
||||||
(using the most recent applicable market price, if any)
|
(using the most recent applicable market price, if any)
|
||||||
|
|
||||||
--pivot TAGNAME
|
hledger help options:
|
||||||
organize reports by some tag's value instead of by account
|
|
||||||
|
|
||||||
--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
|
KEYS
|
||||||
? shows a help dialog listing all keys. (Some of these also appear in
|
? shows a help dialog listing all keys. (Some of these also appear in
|
||||||
the quick help at the bottom of each screen.) Press ? again (or ESCAPE,
|
the quick help at the bottom of each screen.) Press ? again (or ESCAPE,
|
||||||
or LEFT) to close it. The following keys work on most screens:
|
or LEFT) to close it. The following keys work on most screens:
|
||||||
|
|
||||||
The cursor keys navigate: right (or enter) goes deeper, left returns to
|
The cursor keys navigate: right (or enter) goes deeper, left returns to
|
||||||
the previous screen, up/down/page up/page down/home/end move up and
|
the previous screen, up/down/page up/page down/home/end move up and
|
||||||
down through lists. Vi-style h/j/k/l movement keys are also supported.
|
down through lists. Vi-style h/j/k/l movement keys are also supported.
|
||||||
A tip: movement speed is limited by your keyboard repeat rate, to move
|
A tip: movement speed is limited by your keyboard repeat rate, to move
|
||||||
faster you may want to adjust it. (If you're on a mac, the Karabiner
|
faster you may want to adjust it. (If you're on a mac, the Karabiner
|
||||||
app is one way to do that.)
|
app is one way to do that.)
|
||||||
|
|
||||||
With shift pressed, the cursor keys adjust the report period, limiting
|
With shift pressed, the cursor keys adjust the report period, limiting
|
||||||
the transactions to be shown (by default, all are shown).
|
the transactions to be shown (by default, all are shown).
|
||||||
shift-down/up steps downward and upward through these standard report
|
shift-down/up steps downward and upward through these standard report
|
||||||
period durations: year, quarter, month, week, day. Then,
|
period durations: year, quarter, month, week, day. Then,
|
||||||
shift-left/right moves to the previous/next period. t sets the report
|
shift-left/right moves to the previous/next period. t sets the report
|
||||||
period to today. With the --watch option, when viewing a "current"
|
period to today. With the --watch option, when viewing a "current"
|
||||||
period (the current day, week, month, quarter, or year), the period
|
period (the current day, week, month, quarter, or year), the period
|
||||||
will move automatically to track the current date. To set a non-stan-
|
will move automatically to track the current date. To set a non-stan-
|
||||||
dard period, you can use / and a date: query.
|
dard period, you can use / and a date: query.
|
||||||
|
|
||||||
/ lets you set a general filter query limiting the data shown, using
|
/ lets you set a general filter query limiting the data shown, using
|
||||||
the same query terms as in hledger and hledger-web. While editing the
|
the same query terms as in hledger and hledger-web. While editing the
|
||||||
query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
|
query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
|
||||||
it, or ESCAPEto cancel. There are also keys for quickly adjusting some
|
it, or ESCAPEto cancel. There are also keys for quickly adjusting some
|
||||||
common filters like account depth and cleared/uncleared (see below).
|
common filters like account depth and cleared/uncleared (see below).
|
||||||
BACKSPACE or DELETE removes all filters, showing all transactions.
|
BACKSPACE or DELETE removes all filters, showing all transactions.
|
||||||
|
|
||||||
ESCAPE removes all filters and jumps back to the top screen. Or, it
|
ESCAPE removes all filters and jumps back to the top screen. Or, it
|
||||||
cancels a minibuffer edit or help dialog in progress.
|
cancels a minibuffer edit or help dialog in progress.
|
||||||
|
|
||||||
g reloads from the data file(s) and updates the current screen and any
|
g reloads from the data file(s) and updates the current screen and any
|
||||||
previous screens. (With large files, this could cause a noticeable
|
previous screens. (With large files, this could cause a noticeable
|
||||||
pause.)
|
pause.)
|
||||||
|
|
||||||
I toggles balance assertion checking. Disabling balance assertions
|
I toggles balance assertion checking. Disabling balance assertions
|
||||||
temporarily can be useful for troubleshooting.
|
temporarily can be useful for troubleshooting.
|
||||||
|
|
||||||
a runs command-line hledger's add command, and reloads the updated
|
a runs command-line hledger's add command, and reloads the updated
|
||||||
file. This allows some basic data entry.
|
file. This allows some basic data entry.
|
||||||
|
|
||||||
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac-
|
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac-
|
||||||
sclient -a "" -nw) on the journal file. With some editors (emacs, vi),
|
sclient -a "" -nw) on the journal file. With some editors (emacs, vi),
|
||||||
the cursor will be positioned at the current transaction when invoked
|
the cursor will be positioned at the current transaction when invoked
|
||||||
from the register and transaction screens, and at the error location
|
from the register and transaction screens, and at the error location
|
||||||
(if possible) when invoked from the error screen.
|
(if possible) when invoked from the error screen.
|
||||||
|
|
||||||
q quits the application.
|
q quits the application.
|
||||||
@ -195,42 +198,42 @@ KEYS
|
|||||||
|
|
||||||
SCREENS
|
SCREENS
|
||||||
Accounts screen
|
Accounts screen
|
||||||
This is normally the first screen displayed. It lists accounts and
|
This is normally the first screen displayed. It lists accounts and
|
||||||
their balances, like hledger's balance command. By default, it shows
|
their balances, like hledger's balance command. By default, it shows
|
||||||
all accounts and their latest ending balances (including the balances
|
all accounts and their latest ending balances (including the balances
|
||||||
of subaccounts). if you specify a query on the command line, it shows
|
of subaccounts). if you specify a query on the command line, it shows
|
||||||
just the matched accounts and the balances from matched transactions.
|
just the matched accounts and the balances from matched transactions.
|
||||||
|
|
||||||
Account names are normally indented to show the hierarchy (tree mode).
|
Account names are normally indented to show the hierarchy (tree mode).
|
||||||
To see less detail, set a depth limit by pressing a number key, 1 to 9.
|
To see less detail, set a depth limit by pressing a number key, 1 to 9.
|
||||||
0 shows even less detail, collapsing all accounts to a single total. -
|
0 shows even less detail, collapsing all accounts to a single total. -
|
||||||
and + (or =) decrease and increase the depth limit. To remove the
|
and + (or =) decrease and increase the depth limit. To remove the
|
||||||
depth limit, set it higher than the maximum account depth, or press
|
depth limit, set it higher than the maximum account depth, or press
|
||||||
ESCAPE.
|
ESCAPE.
|
||||||
|
|
||||||
F toggles flat mode, in which accounts are shown as a flat list, with
|
F toggles flat mode, in which accounts are shown as a flat list, with
|
||||||
their full names. In this mode, account balances exclude subaccounts,
|
their full names. In this mode, account balances exclude subaccounts,
|
||||||
except for accounts at the depth limit (as with hledger's balance com-
|
except for accounts at the depth limit (as with hledger's balance com-
|
||||||
mand).
|
mand).
|
||||||
|
|
||||||
H toggles between showing historical balances or period balances. His-
|
H toggles between showing historical balances or period balances. His-
|
||||||
torical balances (the default) are ending balances at the end of the
|
torical balances (the default) are ending balances at the end of the
|
||||||
report period, taking into account all transactions before that date
|
report period, taking into account all transactions before that date
|
||||||
(filtered by the filter query if any), including transactions before
|
(filtered by the filter query if any), including transactions before
|
||||||
the start of the report period. In other words, historical balances
|
the start of the report period. In other words, historical balances
|
||||||
are what you would see on a bank statement for that account (unless
|
are what you would see on a bank statement for that account (unless
|
||||||
disturbed by a filter query). Period balances ignore transactions
|
disturbed by a filter query). Period balances ignore transactions
|
||||||
before the report start date, so they show the change in balance during
|
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.
|
the report period. They are more useful eg when viewing a time log.
|
||||||
|
|
||||||
C toggles cleared mode, in which uncleared transactions and postings
|
C toggles cleared mode, in which uncleared transactions and postings
|
||||||
are not shown. U toggles uncleared mode, in which only uncleared
|
are not shown. U toggles uncleared mode, in which only uncleared
|
||||||
transactions/postings are shown.
|
transactions/postings are shown.
|
||||||
|
|
||||||
R toggles real mode, in which virtual postings are ignored.
|
R toggles real mode, in which virtual postings are ignored.
|
||||||
|
|
||||||
Z toggles nonzero mode, in which only accounts with nonzero balances
|
Z toggles nonzero mode, in which only accounts with nonzero balances
|
||||||
are shown (hledger-ui shows zero items by default, unlike command-line
|
are shown (hledger-ui shows zero items by default, unlike command-line
|
||||||
hledger).
|
hledger).
|
||||||
|
|
||||||
Press right or enter to view an account's transactions register.
|
Press right or enter to view an account's transactions register.
|
||||||
@ -239,62 +242,62 @@ SCREENS
|
|||||||
This screen shows the transactions affecting a particular account, like
|
This screen shows the transactions affecting a particular account, like
|
||||||
a check register. Each line represents one transaction and shows:
|
a check register. Each line represents one transaction and shows:
|
||||||
|
|
||||||
o the other account(s) involved, in abbreviated form. (If there are
|
o the other account(s) involved, in abbreviated form. (If there are
|
||||||
both real and virtual postings, it shows only the accounts affected
|
both real and virtual postings, it shows only the accounts affected
|
||||||
by real postings.)
|
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.
|
inflow to this account, negative for an outflow.
|
||||||
|
|
||||||
o the running historical total or period total for the current account,
|
o the running historical total or period total for the current account,
|
||||||
after the transaction. This can be toggled with H. Similar to the
|
after the transaction. This can be toggled with H. Similar to the
|
||||||
accounts screen, the historical total is affected by transactions
|
accounts screen, the historical total is affected by transactions
|
||||||
(filtered by the filter query) before the report start date, while
|
(filtered by the filter query) before the report start date, while
|
||||||
the period total is not. If the historical total is not disturbed by
|
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.
|
see on a bank register for the current account.
|
||||||
|
|
||||||
If the accounts screen was in tree mode, the register screen will
|
If the accounts screen was in tree mode, the register screen will
|
||||||
include transactions from both the current account and its subaccounts.
|
include transactions from both the current account and its subaccounts.
|
||||||
If the accounts screen was in flat mode, and a non-depth-clipped
|
If the accounts screen was in flat mode, and a non-depth-clipped
|
||||||
account was selected, the register screen will exclude transactions
|
account was selected, the register screen will exclude transactions
|
||||||
from subaccounts. In other words, the register always shows the trans-
|
from subaccounts. In other words, the register always shows the trans-
|
||||||
actions responsible for the period balance shown on the accounts
|
actions responsible for the period balance shown on the accounts
|
||||||
screen. As on the accounts screen, this can be toggled with F.
|
screen. As on the accounts screen, this can be toggled with F.
|
||||||
|
|
||||||
C toggles cleared mode, in which uncleared transactions and postings
|
C toggles cleared mode, in which uncleared transactions and postings
|
||||||
are not shown. U toggles uncleared mode, in which only uncleared
|
are not shown. U toggles uncleared mode, in which only uncleared
|
||||||
transactions/postings are shown.
|
transactions/postings are shown.
|
||||||
|
|
||||||
R toggles real mode, in which virtual postings are ignored.
|
R toggles real mode, in which virtual postings are ignored.
|
||||||
|
|
||||||
Z toggles nonzero mode, in which only transactions posting a nonzero
|
Z toggles nonzero mode, in which only transactions posting a nonzero
|
||||||
change are shown (hledger-ui shows zero items by default, unlike com-
|
change are shown (hledger-ui shows zero items by default, unlike com-
|
||||||
mand-line hledger).
|
mand-line hledger).
|
||||||
|
|
||||||
Press right (or enter) to view the selected transaction in detail.
|
Press right (or enter) to view the selected transaction in detail.
|
||||||
|
|
||||||
Transaction screen
|
Transaction screen
|
||||||
This screen shows a single transaction, as a general journal entry,
|
This screen shows a single transaction, as a general journal entry,
|
||||||
similar to hledger's print command and journal format (hledger_jour-
|
similar to hledger's print command and journal format (hledger_jour-
|
||||||
nal(5)).
|
nal(5)).
|
||||||
|
|
||||||
The transaction's date(s) and any cleared flag, transaction code,
|
The transaction's date(s) and any cleared flag, transaction code,
|
||||||
description, comments, along with all of its account postings are
|
description, comments, along with all of its account postings are
|
||||||
shown. Simple transactions have two postings, but there can be more
|
shown. Simple transactions have two postings, but there can be more
|
||||||
(or in certain cases, fewer).
|
(or in certain cases, fewer).
|
||||||
|
|
||||||
up and down will step through all transactions listed in the previous
|
up and down will step through all transactions listed in the previous
|
||||||
account register screen. In the title bar, the numbers in parentheses
|
account register screen. In the title bar, the numbers in parentheses
|
||||||
show your position within that account register. They will vary
|
show your position within that account register. They will vary
|
||||||
depending on which account register you came from (remember most trans-
|
depending on which account register you came from (remember most trans-
|
||||||
actions appear in multiple account registers). The #N number preceding
|
actions appear in multiple account registers). The #N number preceding
|
||||||
them is the transaction's position within the complete unfiltered jour-
|
them is the transaction's position within the complete unfiltered jour-
|
||||||
nal, which is a more stable id (at least until the next reload).
|
nal, which is a more stable id (at least until the next reload).
|
||||||
|
|
||||||
Error screen
|
Error screen
|
||||||
This screen will appear if there is a problem, such as a parse error,
|
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
|
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
|
again to reload and resume normal operation. (Or, you can press escape
|
||||||
to cancel the reload attempt.)
|
to cancel the reload attempt.)
|
||||||
|
|
||||||
@ -302,17 +305,17 @@ ENVIRONMENT
|
|||||||
COLUMNS The screen width to use. Default: the full terminal width.
|
COLUMNS The screen width to use. Default: the full terminal width.
|
||||||
|
|
||||||
LEDGER_FILE The journal file path when not specified with -f. Default:
|
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).
|
nal).
|
||||||
|
|
||||||
FILES
|
FILES
|
||||||
Reads data from one or more files in hledger journal, timeclock, time-
|
Reads data from one or more files in hledger journal, timeclock, time-
|
||||||
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
||||||
$HOME/.hledger.journal (on windows, perhaps
|
$HOME/.hledger.journal (on windows, perhaps
|
||||||
C:/Users/USER/.hledger.journal).
|
C:/Users/USER/.hledger.journal).
|
||||||
|
|
||||||
BUGS
|
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.
|
ward.
|
||||||
|
|
||||||
-f- doesn't work (hledger-ui can't read from stdin).
|
-f- doesn't work (hledger-ui can't read from stdin).
|
||||||
@ -320,13 +323,13 @@ BUGS
|
|||||||
-V affects only the accounts screen.
|
-V affects only the accounts screen.
|
||||||
|
|
||||||
When you press g, the current and all previous screens are regenerated,
|
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.
|
visual indication that this is in progress.
|
||||||
|
|
||||||
--watch is not yet fully robust. It works well for normal usage, but
|
--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
|
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-
|
times with an editor macro) can cause problems at least on OSX. Symp-
|
||||||
toms include: unresponsive UI, periodic resetting of the cursor posi-
|
toms include: unresponsive UI, periodic resetting of the cursor posi-
|
||||||
tion, momentary display of parse errors, high CPU usage eventually sub-
|
tion, momentary display of parse errors, high CPU usage eventually sub-
|
||||||
siding, and possibly a small but persistent build-up of CPU usage until
|
siding, and possibly a small but persistent build-up of CPU usage until
|
||||||
the program is restarted.
|
the program is restarted.
|
||||||
@ -334,7 +337,7 @@ BUGS
|
|||||||
|
|
||||||
|
|
||||||
REPORTING BUGS
|
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)
|
or hledger mail list)
|
||||||
|
|
||||||
|
|
||||||
@ -348,7 +351,7 @@ COPYRIGHT
|
|||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
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-
|
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
|
||||||
dot(5), ledger(1)
|
dot(5), ledger(1)
|
||||||
|
|
||||||
|
|||||||
@ -120,42 +120,12 @@ with this.
|
|||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
hledger general options:
|
hledger input 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
|
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
|
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
|
||||||
use a different input file.
|
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
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
@ -165,12 +135,22 @@ Conversion rules file to use when reading CSV (default: FILE.rules)
|
|||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-alias=OLD=NEW\f[]
|
.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
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
|
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
|
||||||
ignore any failing balance assertions in the journal
|
ignore any failing balance assertions
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.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)
|
most recent applicable market price, if any)
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
|
.PP
|
||||||
|
hledger help options:
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-pivot\ TAGNAME\f[]
|
.B \f[C]\-h\f[]
|
||||||
organize reports by some tag\[aq]s value instead of by account
|
show general usage (or after COMMAND, the command\[aq]s usage)
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-anon\f[]
|
.B \f[C]\-\-help\f[]
|
||||||
show anonymized accounts and payees
|
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
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.SH ENVIRONMENT
|
.SH ENVIRONMENT
|
||||||
|
|||||||
@ -97,39 +97,27 @@ options as shown above.
|
|||||||
them from another server for efficiency, you would set the url with
|
them from another server for efficiency, you would set the url with
|
||||||
this.
|
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'
|
'-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'
|
'--rules-file=RULESFILE'
|
||||||
|
|
||||||
Conversion rules file to use when reading CSV (default: FILE.rules)
|
Conversion rules file to use when reading CSV (default: FILE.rules)
|
||||||
'--alias=OLD=NEW'
|
'--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'
|
'-I --ignore-assertions'
|
||||||
|
|
||||||
ignore any failing balance assertions in the journal
|
ignore any failing balance assertions
|
||||||
|
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
|
|
||||||
@ -187,12 +175,28 @@ options as shown above.
|
|||||||
|
|
||||||
convert amounts to their market value on the report end date (using
|
convert amounts to their market value on the report end date (using
|
||||||
the most recent applicable market price, if any)
|
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)
|
||||||
|
|
||||||
|
|
||||||
Tag Table:
|
Tag Table:
|
||||||
|
|||||||
@ -95,35 +95,26 @@ OPTIONS
|
|||||||
them from another server for efficiency, you would set the url
|
them from another server for efficiency, you would set the url
|
||||||
with this.
|
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
|
-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
|
--rules-file=RULESFILE
|
||||||
Conversion rules file to use when reading CSV (default:
|
Conversion rules file to use when reading CSV (default:
|
||||||
FILE.rules)
|
FILE.rules)
|
||||||
|
|
||||||
--alias=OLD=NEW
|
--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
|
-I --ignore-assertions
|
||||||
ignore any failing balance assertions in the journal
|
ignore any failing balance assertions
|
||||||
|
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
|
|
||||||
@ -181,24 +172,36 @@ OPTIONS
|
|||||||
convert amounts to their market value on the report end date
|
convert amounts to their market value on the report end date
|
||||||
(using the most recent applicable market price, if any)
|
(using the most recent applicable market price, if any)
|
||||||
|
|
||||||
--pivot TAGNAME
|
hledger help options:
|
||||||
organize reports by some tag's value instead of by account
|
|
||||||
|
|
||||||
--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
|
ENVIRONMENT
|
||||||
LEDGER_FILE The journal file path when not specified with -f. Default:
|
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).
|
nal).
|
||||||
|
|
||||||
FILES
|
FILES
|
||||||
Reads data from one or more files in hledger journal, timeclock, time-
|
Reads data from one or more files in hledger journal, timeclock, time-
|
||||||
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
||||||
$HOME/.hledger.journal (on windows, perhaps
|
$HOME/.hledger.journal (on windows, perhaps
|
||||||
C:/Users/USER/.hledger.journal).
|
C:/Users/USER/.hledger.journal).
|
||||||
|
|
||||||
BUGS
|
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.
|
ward.
|
||||||
|
|
||||||
-f- doesn't work (hledger-web can't read from stdin).
|
-f- doesn't work (hledger-web can't read from stdin).
|
||||||
@ -212,7 +215,7 @@ BUGS
|
|||||||
|
|
||||||
|
|
||||||
REPORTING BUGS
|
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)
|
or hledger mail list)
|
||||||
|
|
||||||
|
|
||||||
@ -226,7 +229,7 @@ COPYRIGHT
|
|||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
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-
|
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
|
||||||
dot(5), ledger(1)
|
dot(5), ledger(1)
|
||||||
|
|
||||||
|
|||||||
@ -149,76 +149,60 @@ $\ hledger\ activity\ \-W\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ tran
|
|||||||
.fi
|
.fi
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.PP
|
.PP
|
||||||
To see general usage and the command list: \f[C]hledger\ \-h\f[] or just
|
To see general usage help, including general options which are supported
|
||||||
\f[C]hledger\f[].
|
by most hledger commands, run \f[C]hledger\ \-h\f[].
|
||||||
To see usage for a specific command: \f[C]hledger\ COMMAND\ \-h\f[].
|
(Note \-h and \-\-help are different, like git.) These options can
|
||||||
|
appear anywhere on the command line, and are listed below.
|
||||||
.PP
|
.PP
|
||||||
hledger has several kinds of options:
|
To see usage for a specific command, run:
|
||||||
.IP \[bu] 2
|
\f[C]hledger\ COMMAND\ \-h\f[].
|
||||||
General options are always available and can appear anywhere on the
|
Command\-specific options must be written after the command name, eg:
|
||||||
command line.
|
\f[C]hledger\ print\ \-x\f[].
|
||||||
\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[].
|
|
||||||
.PP
|
.PP
|
||||||
Command arguments may also follow the command name.
|
Additionally, if the command is an add\-on, you may need to put its
|
||||||
In most cases these specify a query which filters the data.
|
options after a double\-hyphen, eg:
|
||||||
Command options and arguments can be intermixed.
|
\f[C]hledger\ ui\ \-\-\ \-\-watch\f[].
|
||||||
|
Or, you can run the add\-on executable directly, eg:
|
||||||
|
\f[C]hledger\-ui\ \-\-watch\f[].
|
||||||
.PP
|
.PP
|
||||||
Option and argument values containing problematic characters should be
|
Most commands also accept arguments, which are often a query filtering
|
||||||
escaped with double quotes, backslashes, or (best) single quotes.
|
the data in some way.
|
||||||
This means spaces, but also characters which are significant to your
|
.SS Special characters
|
||||||
command shell, such as less\-than/greater\-than.
|
.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:
|
Eg:
|
||||||
\f[C]hledger\ register\ \-p\ \[aq]last\ year\[aq]\ "accounts\ receivable\ (receivable|payable)"\ amt:\\>100\f[].
|
\f[C]hledger\ register\ \-p\ \[aq]last\ year\[aq]\ "accounts\ receivable\ (receivable|payable)"\ amt:\\>100\f[].
|
||||||
.PP
|
.PP
|
||||||
Characters which are significant to the shell and also in regular
|
Characters which are significant both to the shell and in regular
|
||||||
expressions, like parentheses, the pipe symbol and the dollar sign, must
|
expressions sometimes need to be double\-escaped.
|
||||||
sometimes be double\-escaped.
|
These include parentheses, the pipe symbol and the dollar sign.
|
||||||
Eg, to match the dollar symbol:
|
Eg, to match the dollar symbol, bash users should do:
|
||||||
\f[C]hledger\ balance\ cur:\[aq]\\$\[aq]\f[] or
|
\f[C]hledger\ balance\ cur:\[aq]\\$\[aq]\f[] or
|
||||||
\f[C]hledger\ balance\ cur:\\\\$\f[].
|
\f[C]hledger\ balance\ cur:\\\\$\f[].
|
||||||
.PP
|
.PP
|
||||||
There\[aq]s more..
|
There\[aq]s more..
|
||||||
options and arguments being passed by hledger to an add\-on executable
|
options and arguments get de\-escaped when hledger is passing them to an
|
||||||
get de\-escaped once in the process.
|
addon executable.
|
||||||
In this case you might need triple\-escaping.
|
In this case you might need \f[I]triple\f[]\-escaping.
|
||||||
Eg: \f[C]hledger\ ui\ cur:\[aq]\\\\$\[aq]\f[] or
|
Eg: \f[C]hledger\ ui\ cur:\[aq]\\\\$\[aq]\f[] or
|
||||||
\f[C]hledger\ ui\ cur:\\\\\\\\$\f[].
|
\f[C]hledger\ ui\ cur:\\\\\\\\$\f[].
|
||||||
.PP
|
.PP
|
||||||
If in doubt, keep things simple:
|
If in doubt, keep things simple:
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
|
run add\-on executables directly
|
||||||
|
.IP \[bu] 2
|
||||||
write options after the command
|
write options after the command
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
enclose problematic args in single quotes
|
enclose problematic args in single quotes
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
if needed, also add a backslash to escape regexp metacharacters
|
if needed, also add a backslash to escape regexp metacharacters
|
||||||
.IP \[bu] 2
|
|
||||||
run add\-on executables directly
|
|
||||||
.PP
|
.PP
|
||||||
If you\[aq]re really curious, add \f[C]\-\-debug=2\f[] for
|
If you\[aq]re really stumped, add \f[C]\-\-debug=2\f[] to troubleshoot.
|
||||||
troubleshooting.
|
|
||||||
.SS General options
|
.SS General options
|
||||||
.PP
|
.SS General help options
|
||||||
Always available, can be written before or after COMMAND.
|
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-h\f[]
|
.B \f[C]\-h\f[]
|
||||||
show general usage (or after COMMAND, the command\[aq]s usage)
|
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)
|
show debug output (levels 1\-9, default: 1)
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
|
.SS General input options
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
|
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
|
||||||
use a different input file.
|
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
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
@ -263,17 +249,25 @@ Conversion rules file to use when reading CSV (default: FILE.rules)
|
|||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-\-alias=OLD=NEW\f[]
|
.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
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
|
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
|
||||||
ignore any failing balance assertions in the journal
|
ignore any failing balance assertions
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.SS Reporting options
|
.SS General reporting options
|
||||||
.PP
|
|
||||||
Common reporting options, must be written after COMMAND.
|
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-b\ \-\-begin=DATE\f[]
|
.B \f[C]\-b\ \-\-begin=DATE\f[]
|
||||||
include postings/txns on or after this date
|
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)
|
most recent applicable market price, if any)
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.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
|
.PP
|
||||||
If a reporting option occurs more than once on the command line, the
|
Note when multiple similar reporting options are provided, the last one
|
||||||
last one takes precedence.
|
takes precedence.
|
||||||
Eg \-p jan \-p feb is equivalent to \-p feb.
|
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
|
.SS Input files
|
||||||
.PP
|
.PP
|
||||||
hledger reads transactions from a data file (and the add command writes
|
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.
|
A file extension matching one of the above formats selects that format.
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
|
.TP
|
||||||
|
.B \f[C]\-\-pretty\-tables\f[]
|
||||||
|
Use unicode to display prettier tables.
|
||||||
|
.RS
|
||||||
|
.RE
|
||||||
.PP
|
.PP
|
||||||
The balance command displays accounts and balances.
|
The balance command displays accounts and balances.
|
||||||
It is hledger\[aq]s most featureful and most useful command.
|
It is hledger\[aq]s most featureful and most useful command.
|
||||||
|
|||||||
@ -114,63 +114,25 @@ File: hledger.1.info, Node: OPTIONS, Next: QUERIES, Prev: EXAMPLES, Up: Top
|
|||||||
2 OPTIONS
|
2 OPTIONS
|
||||||
*********
|
*********
|
||||||
|
|
||||||
To see general usage and the command list: 'hledger -h' or just
|
To see general usage help, including general options which are supported
|
||||||
'hledger'. To see usage for a specific command: 'hledger COMMAND -h'.
|
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
|
Additionally, if the command is an add-on, you may need to put its
|
||||||
command line. 'hledger -h' shows these. Eg: 'hledger --version'.
|
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
|
Most commands also accept arguments, which are often a query
|
||||||
and all other non-general options must be written after COMMAND.
|
filtering the data in some way.
|
||||||
'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.
|
|
||||||
* Menu:
|
* Menu:
|
||||||
|
|
||||||
|
* Special characters::
|
||||||
* General options::
|
* General options::
|
||||||
* Reporting options::
|
|
||||||
* Input files::
|
* Input files::
|
||||||
* Smart dates::
|
* Smart dates::
|
||||||
* Report start & end date::
|
* Report start & end date::
|
||||||
@ -181,12 +143,55 @@ cur:\\\\$'.
|
|||||||
* Regular expressions::
|
* 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'
|
'-h'
|
||||||
|
|
||||||
@ -207,26 +212,38 @@ Always available, can be written before or after COMMAND.
|
|||||||
'--debug[=N]'
|
'--debug[=N]'
|
||||||
|
|
||||||
show debug output (levels 1-9, default: 1)
|
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'
|
'-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'
|
'--rules-file=RULESFILE'
|
||||||
|
|
||||||
Conversion rules file to use when reading CSV (default: FILE.rules)
|
Conversion rules file to use when reading CSV (default: FILE.rules)
|
||||||
'--alias=OLD=NEW'
|
'--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'
|
'-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
|
2.2.3 General reporting options
|
||||||
=====================
|
-------------------------------
|
||||||
|
|
||||||
Common reporting options, must be written after COMMAND.
|
|
||||||
|
|
||||||
'-b --begin=DATE'
|
'-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
|
convert amounts to their market value on the report end date (using
|
||||||
the most recent applicable market price, if any)
|
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
|
||||||
'--anon'
|
one takes precedence. Eg '-p feb -p mar' is equivalent to '-p mar'.
|
||||||
|
|
||||||
show anonymized accounts and payees
|
Some of these can also be written as queries.
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
|
|
||||||
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
|
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
|
write output to FILE. A file extension matching one of the above
|
||||||
formats selects that format.
|
formats selects that format.
|
||||||
|
'--pretty-tables'
|
||||||
|
|
||||||
|
Use unicode to display prettier tables.
|
||||||
|
|
||||||
The balance command displays accounts and balances. It is hledger's
|
The balance command displays accounts and balances. It is hledger's
|
||||||
most featureful and most useful command.
|
most featureful and most useful command.
|
||||||
@ -2192,123 +2208,129 @@ Node: EXAMPLES1883
|
|||||||
Ref: #examples1985
|
Ref: #examples1985
|
||||||
Node: OPTIONS3631
|
Node: OPTIONS3631
|
||||||
Ref: #options3735
|
Ref: #options3735
|
||||||
Node: General options6393
|
Node: Special characters4649
|
||||||
Ref: #general-options6522
|
Ref: #special-characters4785
|
||||||
Node: Reporting options7295
|
Node: General options5953
|
||||||
Ref: #reporting-options7448
|
Ref: #general-options6103
|
||||||
Node: Input files9024
|
Node: General help options6194
|
||||||
Ref: #input-files9161
|
Ref: #general-help-options6354
|
||||||
Node: Smart dates11124
|
Node: General input options6753
|
||||||
Ref: #smart-dates11267
|
Ref: #general-input-options6949
|
||||||
Node: Report start & end date12246
|
Node: General reporting options7420
|
||||||
Ref: #report-start-end-date12418
|
Ref: #general-reporting-options7595
|
||||||
Node: Report intervals13484
|
Node: Input files9027
|
||||||
Ref: #report-intervals13649
|
Ref: #input-files9162
|
||||||
Node: Period expressions14050
|
Node: Smart dates11125
|
||||||
Ref: #period-expressions14210
|
Ref: #smart-dates11268
|
||||||
Node: Depth limiting16550
|
Node: Report start & end date12247
|
||||||
Ref: #depth-limiting16694
|
Ref: #report-start-end-date12419
|
||||||
Node: Pivoting16895
|
Node: Report intervals13485
|
||||||
Ref: #pivoting17028
|
Ref: #report-intervals13650
|
||||||
Node: Regular expressions18857
|
Node: Period expressions14051
|
||||||
Ref: #regular-expressions18991
|
Ref: #period-expressions14211
|
||||||
Node: QUERIES20469
|
Node: Depth limiting16551
|
||||||
Ref: #queries20573
|
Ref: #depth-limiting16695
|
||||||
Node: COMMANDS24219
|
Node: Pivoting16896
|
||||||
Ref: #commands24333
|
Ref: #pivoting17029
|
||||||
Node: accounts25006
|
Node: Regular expressions18858
|
||||||
Ref: #accounts25106
|
Ref: #regular-expressions18992
|
||||||
Node: activity26088
|
Node: QUERIES20470
|
||||||
Ref: #activity26200
|
Ref: #queries20574
|
||||||
Node: add26559
|
Node: COMMANDS24220
|
||||||
Ref: #add26660
|
Ref: #commands24334
|
||||||
Node: balance29318
|
Node: accounts25007
|
||||||
Ref: #balance29431
|
Ref: #accounts25107
|
||||||
Node: Flat mode32309
|
Node: activity26089
|
||||||
Ref: #flat-mode32436
|
Ref: #activity26201
|
||||||
Node: Depth limited balance reports32856
|
Node: add26560
|
||||||
Ref: #depth-limited-balance-reports33059
|
Ref: #add26661
|
||||||
Node: Multicolumn balance reports33479
|
Node: balance29319
|
||||||
Ref: #multicolumn-balance-reports33681
|
Ref: #balance29432
|
||||||
Node: Market value38329
|
Node: Flat mode32374
|
||||||
Ref: #market-value38493
|
Ref: #flat-mode32501
|
||||||
Node: Custom balance output39793
|
Node: Depth limited balance reports32921
|
||||||
Ref: #custom-balance-output39966
|
Ref: #depth-limited-balance-reports33124
|
||||||
Node: Output destination42059
|
Node: Multicolumn balance reports33544
|
||||||
Ref: #output-destination42224
|
Ref: #multicolumn-balance-reports33746
|
||||||
Node: CSV output42494
|
Node: Market value38394
|
||||||
Ref: #csv-output42613
|
Ref: #market-value38558
|
||||||
Node: balancesheet43010
|
Node: Custom balance output39858
|
||||||
Ref: #balancesheet43138
|
Ref: #custom-balance-output40031
|
||||||
Node: cashflow45057
|
Node: Output destination42124
|
||||||
Ref: #cashflow45174
|
Ref: #output-destination42289
|
||||||
Node: help47072
|
Node: CSV output42559
|
||||||
Ref: #help47184
|
Ref: #csv-output42678
|
||||||
Node: incomestatement48022
|
Node: balancesheet43075
|
||||||
Ref: #incomestatement48152
|
Ref: #balancesheet43203
|
||||||
Node: info50067
|
Node: cashflow45122
|
||||||
Ref: #info50174
|
Ref: #cashflow45239
|
||||||
Node: man50538
|
Node: help47137
|
||||||
Ref: #man50635
|
Ref: #help47249
|
||||||
Node: print51040
|
Node: incomestatement48087
|
||||||
Ref: #print51145
|
Ref: #incomestatement48217
|
||||||
Node: register54901
|
Node: info50132
|
||||||
Ref: #register55014
|
Ref: #info50239
|
||||||
Node: Custom register output59510
|
Node: man50603
|
||||||
Ref: #custom-register-output59641
|
Ref: #man50700
|
||||||
Node: stats60938
|
Node: print51105
|
||||||
Ref: #stats61044
|
Ref: #print51210
|
||||||
Node: test61925
|
Node: register54966
|
||||||
Ref: #test62012
|
Ref: #register55079
|
||||||
Node: ADD-ON COMMANDS62380
|
Node: Custom register output59575
|
||||||
Ref: #add-on-commands62516
|
Ref: #custom-register-output59706
|
||||||
Node: Official add-ons63803
|
Node: stats61003
|
||||||
Ref: #official-add-ons63945
|
Ref: #stats61109
|
||||||
Node: api64032
|
Node: test61990
|
||||||
Ref: #api64123
|
Ref: #test62077
|
||||||
Node: ui64175
|
Node: ADD-ON COMMANDS62445
|
||||||
Ref: #ui64276
|
Ref: #add-on-commands62581
|
||||||
Node: web64334
|
Node: Official add-ons63868
|
||||||
Ref: #web64425
|
Ref: #official-add-ons64010
|
||||||
Node: Third party add-ons64471
|
Node: api64097
|
||||||
Ref: #third-party-add-ons64648
|
Ref: #api64188
|
||||||
Node: diff64783
|
Node: ui64240
|
||||||
Ref: #diff64882
|
Ref: #ui64341
|
||||||
Node: iadd64981
|
Node: web64399
|
||||||
Ref: #iadd65097
|
Ref: #web64490
|
||||||
Node: interest65180
|
Node: Third party add-ons64536
|
||||||
Ref: #interest65303
|
Ref: #third-party-add-ons64713
|
||||||
Node: irr65398
|
Node: diff64848
|
||||||
Ref: #irr65498
|
Ref: #diff64947
|
||||||
Node: Experimental add-ons65576
|
Node: iadd65046
|
||||||
Ref: #experimental-add-ons65730
|
Ref: #iadd65162
|
||||||
Node: autosync66123
|
Node: interest65245
|
||||||
Ref: #autosync66237
|
Ref: #interest65368
|
||||||
Node: budget66476
|
Node: irr65463
|
||||||
Ref: #budget66600
|
Ref: #irr65563
|
||||||
Node: chart66666
|
Node: Experimental add-ons65641
|
||||||
Ref: #chart66785
|
Ref: #experimental-add-ons65795
|
||||||
Node: check66856
|
Node: autosync66188
|
||||||
Ref: #check66980
|
Ref: #autosync66302
|
||||||
Node: check-dates67047
|
Node: budget66541
|
||||||
Ref: #check-dates67189
|
Ref: #budget66665
|
||||||
Node: check-dupes67262
|
Node: chart66731
|
||||||
Ref: #check-dupes67405
|
Ref: #chart66850
|
||||||
Node: equity67482
|
Node: check66921
|
||||||
Ref: #equity67610
|
Ref: #check67045
|
||||||
Node: prices67729
|
Node: check-dates67112
|
||||||
Ref: #prices67858
|
Ref: #check-dates67254
|
||||||
Node: print-unique67913
|
Node: check-dupes67327
|
||||||
Ref: #print-unique68062
|
Ref: #check-dupes67470
|
||||||
Node: register-match68155
|
Node: equity67547
|
||||||
Ref: #register-match68311
|
Ref: #equity67675
|
||||||
Node: rewrite68409
|
Node: prices67794
|
||||||
Ref: #rewrite68530
|
Ref: #prices67923
|
||||||
Node: TROUBLESHOOTING68608
|
Node: print-unique67978
|
||||||
Ref: #troubleshooting68727
|
Ref: #print-unique68127
|
||||||
Node: Run-time problems68781
|
Node: register-match68220
|
||||||
Ref: #run-time-problems68924
|
Ref: #register-match68376
|
||||||
Node: Known limitations70871
|
Node: rewrite68474
|
||||||
Ref: #known-limitations71014
|
Ref: #rewrite68595
|
||||||
|
Node: TROUBLESHOOTING68673
|
||||||
|
Ref: #troubleshooting68792
|
||||||
|
Node: Run-time problems68846
|
||||||
|
Ref: #run-time-problems68989
|
||||||
|
Node: Known limitations70936
|
||||||
|
Ref: #known-limitations71079
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user