doc: options help tweaks
This commit is contained in:
Simon Michael
parent
6632aedd93
commit
0af0961e10
13
doc/lib.m4
13
doc/lib.m4
@ -155,18 +155,9 @@ m4_define({{_reportingoptions_}}, {{
|
||||
: convert amounts to their market value on the report end date
|
||||
(using the most recent applicable [market price](journal.html#market-prices), if any)
|
||||
|
||||
}} )m4_dnl
|
||||
m4_dnl
|
||||
m4_define({{_optionnotes_}}, {{
|
||||
When a reporting option appears more than once in the command line, the last one takes precedence.
|
||||
|
||||
A @FILE argument will be expanded to the contents of FILE,
|
||||
which should contain one command line option/argument per line.
|
||||
(To prevent this, insert a `--` argument before.)
|
||||
|
||||
When multiple similar reporting options are provided, the last one takes precedence.
|
||||
Eg `--depth 3 --depth 1` is equivalent to `--depth 1`.
|
||||
|
||||
Some of the reporting options can also be written as [query arguments](#queries).
|
||||
Some reporting options can also be written as [query arguments](#queries).
|
||||
|
||||
}} )m4_dnl
|
||||
m4_dnl
|
||||
|
||||
@ -188,6 +188,11 @@ most recent applicable market price, if any)
|
||||
.RS
|
||||
.RE
|
||||
.PP
|
||||
When a reporting option appears more than once in the command line, the
|
||||
last one takes precedence.
|
||||
.PP
|
||||
Some reporting options can also be written as query arguments.
|
||||
.PP
|
||||
hledger help options:
|
||||
.TP
|
||||
.B \f[C]\-h\ \-\-help\f[]
|
||||
@ -208,13 +213,6 @@ show debug output (levels 1\-9, default: 1)
|
||||
A \@FILE argument will be expanded to the contents of FILE, which should
|
||||
contain one command line option/argument per line.
|
||||
(To prevent this, insert a \f[C]\-\-\f[] argument before.)
|
||||
.PP
|
||||
When multiple similar reporting options are provided, the last one takes
|
||||
precedence.
|
||||
Eg \f[C]\-\-depth\ 3\ \-\-depth\ 1\f[] is equivalent to
|
||||
\f[C]\-\-depth\ 1\f[].
|
||||
.PP
|
||||
Some of the reporting options can also be written as query arguments.
|
||||
.SH KEYS
|
||||
.PP
|
||||
\f[C]?\f[] shows a help dialog listing all keys.
|
||||
|
||||
@ -132,6 +132,11 @@ the data.
|
||||
convert amounts to their market value on the report end date (using
|
||||
the most recent applicable market price, if any)
|
||||
|
||||
When a reporting option appears more than once in the command line,
|
||||
the last one takes precedence.
|
||||
|
||||
Some reporting options can also be written as query arguments.
|
||||
|
||||
hledger help options:
|
||||
|
||||
'-h --help'
|
||||
@ -148,12 +153,6 @@ the data.
|
||||
should contain one command line option/argument per line. (To prevent
|
||||
this, insert a '--' argument before.)
|
||||
|
||||
When multiple similar reporting options are provided, the last one
|
||||
takes precedence. Eg '--depth 3 --depth 1' is equivalent to '--depth
|
||||
1'.
|
||||
|
||||
Some of the reporting options can also be written as query arguments.
|
||||
|
||||
|
||||
File: hledger-ui.1.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
|
||||
|
||||
@ -368,17 +367,17 @@ Tag Table:
|
||||
Node: Top73
|
||||
Node: OPTIONS831
|
||||
Ref: #options930
|
||||
Node: KEYS3916
|
||||
Ref: #keys4013
|
||||
Node: SCREENS6809
|
||||
Ref: #screens6896
|
||||
Node: Accounts screen6986
|
||||
Ref: #accounts-screen7116
|
||||
Node: Register screen9346
|
||||
Ref: #register-screen9503
|
||||
Node: Transaction screen11577
|
||||
Ref: #transaction-screen11737
|
||||
Node: Error screen12607
|
||||
Ref: #error-screen12731
|
||||
Node: KEYS3867
|
||||
Ref: #keys3964
|
||||
Node: SCREENS6760
|
||||
Ref: #screens6847
|
||||
Node: Accounts screen6937
|
||||
Ref: #accounts-screen7067
|
||||
Node: Register screen9297
|
||||
Ref: #register-screen9454
|
||||
Node: Transaction screen11528
|
||||
Ref: #transaction-screen11688
|
||||
Node: Error screen12558
|
||||
Ref: #error-screen12682
|
||||
|
||||
End Tag Table
|
||||
|
||||
@ -81,7 +81,9 @@ hledger help options:
|
||||
|
||||
_helpoptions_
|
||||
|
||||
_optionnotes_
|
||||
A @FILE argument will be expanded to the contents of FILE,
|
||||
which should contain one command line option/argument per line.
|
||||
(To prevent this, insert a `--` argument before.)
|
||||
|
||||
# KEYS
|
||||
|
||||
|
||||
@ -128,6 +128,11 @@ OPTIONS
|
||||
convert amounts to their market value on the report end date
|
||||
(using the most recent applicable market price, if any)
|
||||
|
||||
When a reporting option appears more than once in the command line, the
|
||||
last one takes precedence.
|
||||
|
||||
Some reporting options can also be written as query arguments.
|
||||
|
||||
hledger help options:
|
||||
|
||||
-h --help
|
||||
@ -143,11 +148,6 @@ OPTIONS
|
||||
contain one command line option/argument per line. (To prevent this,
|
||||
insert a -- argument before.)
|
||||
|
||||
When multiple similar reporting options are provided, the last one
|
||||
takes precedence. Eg --depth 3 --depth 1 is equivalent to --depth 1.
|
||||
|
||||
Some of the reporting options can also be written as query arguments.
|
||||
|
||||
KEYS
|
||||
? 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,
|
||||
|
||||
@ -244,6 +244,11 @@ most recent applicable market price, if any)
|
||||
.RS
|
||||
.RE
|
||||
.PP
|
||||
When a reporting option appears more than once in the command line, the
|
||||
last one takes precedence.
|
||||
.PP
|
||||
Some reporting options can also be written as query arguments.
|
||||
.PP
|
||||
hledger help options:
|
||||
.TP
|
||||
.B \f[C]\-h\ \-\-help\f[]
|
||||
@ -264,13 +269,6 @@ show debug output (levels 1\-9, default: 1)
|
||||
A \@FILE argument will be expanded to the contents of FILE, which should
|
||||
contain one command line option/argument per line.
|
||||
(To prevent this, insert a \f[C]\-\-\f[] argument before.)
|
||||
.PP
|
||||
When multiple similar reporting options are provided, the last one takes
|
||||
precedence.
|
||||
Eg \f[C]\-\-depth\ 3\ \-\-depth\ 1\f[] is equivalent to
|
||||
\f[C]\-\-depth\ 1\f[].
|
||||
.PP
|
||||
Some of the reporting options can also be written as query arguments.
|
||||
.SH ENVIRONMENT
|
||||
.PP
|
||||
\f[B]LEDGER_FILE\f[] The journal file path when not specified with
|
||||
|
||||
@ -177,6 +177,11 @@ options as shown above.
|
||||
convert amounts to their market value on the report end date (using
|
||||
the most recent applicable market price, if any)
|
||||
|
||||
When a reporting option appears more than once in the command line,
|
||||
the last one takes precedence.
|
||||
|
||||
Some reporting options can also be written as query arguments.
|
||||
|
||||
hledger help options:
|
||||
|
||||
'-h --help'
|
||||
@ -193,12 +198,6 @@ options as shown above.
|
||||
should contain one command line option/argument per line. (To prevent
|
||||
this, insert a '--' argument before.)
|
||||
|
||||
When multiple similar reporting options are provided, the last one
|
||||
takes precedence. Eg '--depth 3 --depth 1' is equivalent to '--depth
|
||||
1'.
|
||||
|
||||
Some of the reporting options can also be written as query arguments.
|
||||
|
||||
|
||||
Tag Table:
|
||||
Node: Top74
|
||||
|
||||
@ -136,7 +136,9 @@ hledger help options:
|
||||
|
||||
_helpoptions_
|
||||
|
||||
_optionnotes_
|
||||
A @FILE argument will be expanded to the contents of FILE,
|
||||
which should contain one command line option/argument per line.
|
||||
(To prevent this, insert a `--` argument before.)
|
||||
|
||||
_man_({{
|
||||
|
||||
|
||||
@ -173,6 +173,11 @@ OPTIONS
|
||||
convert amounts to their market value on the report end date
|
||||
(using the most recent applicable market price, if any)
|
||||
|
||||
When a reporting option appears more than once in the command line, the
|
||||
last one takes precedence.
|
||||
|
||||
Some reporting options can also be written as query arguments.
|
||||
|
||||
hledger help options:
|
||||
|
||||
-h --help
|
||||
@ -188,11 +193,6 @@ OPTIONS
|
||||
contain one command line option/argument per line. (To prevent this,
|
||||
insert a -- argument before.)
|
||||
|
||||
When multiple similar reporting options are provided, the last one
|
||||
takes precedence. Eg --depth 3 --depth 1 is equivalent to --depth 1.
|
||||
|
||||
Some of the reporting options can also be written as query arguments.
|
||||
|
||||
ENVIRONMENT
|
||||
LEDGER_FILE The journal file path when not specified with -f. Default:
|
||||
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
|
||||
|
||||
@ -156,7 +156,6 @@ $\ hledger\ activity\ \-W\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ tran
|
||||
.PP
|
||||
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.)
|
||||
.PP
|
||||
General help options:
|
||||
.TP
|
||||
@ -299,16 +298,10 @@ most recent applicable market price, if any)
|
||||
.RS
|
||||
.RE
|
||||
.PP
|
||||
A \@FILE argument will be expanded to the contents of FILE, which should
|
||||
contain one command line option/argument per line.
|
||||
(To prevent this, insert a \f[C]\-\-\f[] argument before.)
|
||||
When a reporting option appears more than once in the command line, the
|
||||
last one takes precedence.
|
||||
.PP
|
||||
When multiple similar reporting options are provided, the last one takes
|
||||
precedence.
|
||||
Eg \f[C]\-\-depth\ 3\ \-\-depth\ 1\f[] is equivalent to
|
||||
\f[C]\-\-depth\ 1\f[].
|
||||
.PP
|
||||
Some of the reporting options can also be written as query arguments.
|
||||
Some reporting options can also be written as query arguments.
|
||||
.SS Command options
|
||||
.PP
|
||||
To see options for a particular command, including command\-specific
|
||||
@ -326,6 +319,12 @@ Or, you can run the addon executable directly:
|
||||
.PP
|
||||
Most hledger commands accept arguments after the command name, which are
|
||||
often a query, filtering the data in some way.
|
||||
.SS Argument expansion
|
||||
.PP
|
||||
You can save a set of command line options/arguments in a file, one per
|
||||
line, and then reuse them by writing \f[C]\@FILE\f[] in a command line.
|
||||
(To prevent this expansion of \f[C]\@\f[]\-arguments, precede them with
|
||||
a \f[C]\-\-\f[] argument.)
|
||||
.SS Special characters
|
||||
.PP
|
||||
Option and argument values which contain problematic characters should
|
||||
@ -342,12 +341,18 @@ 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 get de\-escaped when hledger is passing them to an
|
||||
addon executable.
|
||||
In this case you might need \f[I]triple\f[]\-escaping.
|
||||
When hledger is invoking an addon executable (like hledger\-ui), options
|
||||
and arguments get de\-escaped once more, so you might need
|
||||
\f[I]triple\f[]\-escaping.
|
||||
Eg: \f[C]hledger\ ui\ cur:\[aq]\\\\$\[aq]\f[] or
|
||||
\f[C]hledger\ ui\ cur:\\\\\\\\$\f[].
|
||||
\f[C]hledger\ ui\ cur:\\\\\\\\$\f[] in bash.
|
||||
(The number of backslashes in fish shell is left as an exercise for the
|
||||
reader.)
|
||||
.PP
|
||||
Inside a file used for argument expansion, one less level of escaping is
|
||||
enough.
|
||||
(And in this case, backslashes seem to work better than quotes.
|
||||
Eg: \f[C]cur:\\$\f[]).
|
||||
.PP
|
||||
If in doubt, keep things simple:
|
||||
.IP \[bu] 2
|
||||
|
||||
@ -118,6 +118,7 @@ File: hledger.1.info, Node: OPTIONS, Next: QUERIES, Prev: EXAMPLES, Up: Top
|
||||
* General options::
|
||||
* Command options::
|
||||
* Command arguments::
|
||||
* Argument expansion::
|
||||
* Special characters::
|
||||
* Input files::
|
||||
* Smart dates::
|
||||
@ -137,8 +138,7 @@ File: hledger.1.info, Node: General options, Next: Command options, Up: OPTIO
|
||||
===================
|
||||
|
||||
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.)
|
||||
by most hledger commands, run 'hledger -h'.
|
||||
|
||||
General help options:
|
||||
|
||||
@ -232,15 +232,10 @@ different, like git.)
|
||||
convert amounts to their market value on the report end date (using
|
||||
the most recent applicable market price, if any)
|
||||
|
||||
A @FILE argument will be expanded to the contents of FILE, which
|
||||
should contain one command line option/argument per line. (To prevent
|
||||
this, insert a '--' argument before.)
|
||||
When a reporting option appears more than once in the command line,
|
||||
the last one takes precedence.
|
||||
|
||||
When multiple similar reporting options are provided, the last one
|
||||
takes precedence. Eg '--depth 3 --depth 1' is equivalent to '--depth
|
||||
1'.
|
||||
|
||||
Some of the reporting options can also be written as query arguments.
|
||||
Some reporting options can also be written as query arguments.
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Command options, Next: Command arguments, Prev: General options, Up: OPTIONS
|
||||
@ -259,7 +254,7 @@ options after a double-hyphen, eg: 'hledger ui -- --watch'. Or, you can
|
||||
run the addon executable directly: 'hledger-ui --watch'.
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Command arguments, Next: Special characters, Prev: Command options, Up: OPTIONS
|
||||
File: hledger.1.info, Node: Command arguments, Next: Argument expansion, Prev: Command options, Up: OPTIONS
|
||||
|
||||
2.3 Command arguments
|
||||
=====================
|
||||
@ -268,9 +263,20 @@ Most hledger commands accept arguments after the command name, which are
|
||||
often a query, filtering the data in some way.
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Special characters, Next: Input files, Prev: Command arguments, Up: OPTIONS
|
||||
File: hledger.1.info, Node: Argument expansion, Next: Special characters, Prev: Command arguments, Up: OPTIONS
|
||||
|
||||
2.4 Special characters
|
||||
2.4 Argument expansion
|
||||
======================
|
||||
|
||||
You can save a set of command line options/arguments in a file, one per
|
||||
line, and then reuse them by writing '@FILE' in a command line. (To
|
||||
prevent this expansion of '@'-arguments, precede them with a '--'
|
||||
argument.)
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Special characters, Next: Input files, Prev: Argument expansion, Up: OPTIONS
|
||||
|
||||
2.5 Special characters
|
||||
======================
|
||||
|
||||
Option and argument values which contain problematic characters should
|
||||
@ -286,10 +292,15 @@ 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:\\\\$'.
|
||||
When hledger is invoking an addon executable (like hledger-ui),
|
||||
options and arguments get de-escaped once more, so you might need
|
||||
_triple_-escaping. Eg: 'hledger ui cur:'\\$'' or 'hledger ui cur:\\\\$'
|
||||
in bash. (The number of backslashes in fish shell is left as an
|
||||
exercise for the reader.)
|
||||
|
||||
Inside a file used for argument expansion, one less level of escaping
|
||||
is enough. (And in this case, backslashes seem to work better than
|
||||
quotes. Eg: 'cur:\$').
|
||||
|
||||
If in doubt, keep things simple:
|
||||
|
||||
@ -303,7 +314,7 @@ cur:\\\\$'.
|
||||
|
||||
File: hledger.1.info, Node: Input files, Next: Smart dates, Prev: Special characters, Up: OPTIONS
|
||||
|
||||
2.5 Input files
|
||||
2.6 Input files
|
||||
===============
|
||||
|
||||
hledger reads transactions from a data file (and the add command writes
|
||||
@ -358,7 +369,7 @@ the files, eg: 'cat a.journal b.journal | hledger -f- CMD'.
|
||||
|
||||
File: hledger.1.info, Node: Smart dates, Next: Report start & end date, Prev: Input files, Up: OPTIONS
|
||||
|
||||
2.6 Smart dates
|
||||
2.7 Smart dates
|
||||
===============
|
||||
|
||||
hledger's user interfaces accept a flexible "smart date" syntax (unlike
|
||||
@ -381,7 +392,7 @@ omitted (defaulting to 1).
|
||||
|
||||
File: hledger.1.info, Node: Report start & end date, Next: Report intervals, Prev: Smart dates, Up: OPTIONS
|
||||
|
||||
2.7 Report start & end date
|
||||
2.8 Report start & end date
|
||||
===========================
|
||||
|
||||
Most hledger reports show the full span of time represented by the
|
||||
@ -410,7 +421,7 @@ need to write the date _after_ the last day you want to include.
|
||||
|
||||
File: hledger.1.info, Node: Report intervals, Next: Period expressions, Prev: Report start & end date, Up: OPTIONS
|
||||
|
||||
2.8 Report intervals
|
||||
2.9 Report intervals
|
||||
====================
|
||||
|
||||
A report interval can be specified so that commands like register,
|
||||
@ -423,8 +434,8 @@ intervals can not be specified with a query, currently.
|
||||
|
||||
File: hledger.1.info, Node: Period expressions, Next: Depth limiting, Prev: Report intervals, Up: OPTIONS
|
||||
|
||||
2.9 Period expressions
|
||||
======================
|
||||
2.10 Period expressions
|
||||
=======================
|
||||
|
||||
The '-p/--period' option accepts period expressions, a shorthand way of
|
||||
expressing a start date, end date, and/or report interval all at once.
|
||||
@ -498,7 +509,7 @@ start date and exclusive end date):
|
||||
|
||||
File: hledger.1.info, Node: Depth limiting, Next: Pivoting, Prev: Period expressions, Up: OPTIONS
|
||||
|
||||
2.10 Depth limiting
|
||||
2.11 Depth limiting
|
||||
===================
|
||||
|
||||
With the '--depth N' option (short form: '-N'), commands like account,
|
||||
@ -510,7 +521,7 @@ less detail. This flag has the same effect as a 'depth:' query argument
|
||||
|
||||
File: hledger.1.info, Node: Pivoting, Next: Cost, Prev: Depth limiting, Up: OPTIONS
|
||||
|
||||
2.11 Pivoting
|
||||
2.12 Pivoting
|
||||
=============
|
||||
|
||||
Normally hledger sums amounts, and organizes them in a hierarchy, based
|
||||
@ -567,7 +578,7 @@ $ hledger balance --pivot member acct:.
|
||||
|
||||
File: hledger.1.info, Node: Cost, Next: Market value, Prev: Pivoting, Up: OPTIONS
|
||||
|
||||
2.12 Cost
|
||||
2.13 Cost
|
||||
=========
|
||||
|
||||
The '-B/--cost' flag converts amounts to their cost at transaction time,
|
||||
@ -576,7 +587,7 @@ if they have a transaction price specified.
|
||||
|
||||
File: hledger.1.info, Node: Market value, Next: Regular expressions, Prev: Cost, Up: OPTIONS
|
||||
|
||||
2.13 Market value
|
||||
2.14 Market value
|
||||
=================
|
||||
|
||||
The '-V/--value' flag converts the reported amounts to their market
|
||||
@ -625,7 +636,7 @@ directives, not transaction prices (unlike Ledger).
|
||||
|
||||
File: hledger.1.info, Node: Regular expressions, Prev: Market value, Up: OPTIONS
|
||||
|
||||
2.14 Regular expressions
|
||||
2.15 Regular expressions
|
||||
========================
|
||||
|
||||
hledger uses regular expressions in a number of places:
|
||||
@ -2202,127 +2213,129 @@ Node: EXAMPLES1892
|
||||
Ref: #examples1994
|
||||
Node: OPTIONS3640
|
||||
Ref: #options3744
|
||||
Node: General options4025
|
||||
Ref: #general-options4152
|
||||
Node: Command options6744
|
||||
Ref: #command-options6897
|
||||
Node: Command arguments7295
|
||||
Ref: #command-arguments7455
|
||||
Node: Special characters7576
|
||||
Ref: #special-characters7734
|
||||
Node: Input files8902
|
||||
Ref: #input-files9040
|
||||
Node: Smart dates11003
|
||||
Ref: #smart-dates11146
|
||||
Node: Report start & end date12125
|
||||
Ref: #report-start-end-date12297
|
||||
Node: Report intervals13363
|
||||
Ref: #report-intervals13528
|
||||
Node: Period expressions13929
|
||||
Ref: #period-expressions14089
|
||||
Node: Depth limiting16429
|
||||
Ref: #depth-limiting16575
|
||||
Node: Pivoting16917
|
||||
Ref: #pivoting17037
|
||||
Node: Cost18713
|
||||
Ref: #cost18823
|
||||
Node: Market value18941
|
||||
Ref: #market-value19078
|
||||
Node: Regular expressions20378
|
||||
Ref: #regular-expressions20516
|
||||
Node: QUERIES21877
|
||||
Ref: #queries21981
|
||||
Node: COMMANDS25948
|
||||
Ref: #commands26062
|
||||
Node: accounts27045
|
||||
Ref: #accounts27145
|
||||
Node: activity28138
|
||||
Ref: #activity28250
|
||||
Node: add28609
|
||||
Ref: #add28710
|
||||
Node: balance31368
|
||||
Ref: #balance31481
|
||||
Node: Flat mode34638
|
||||
Ref: #flat-mode34765
|
||||
Node: Depth limited balance reports35185
|
||||
Ref: #depth-limited-balance-reports35388
|
||||
Node: Multicolumn balance reports35808
|
||||
Ref: #multicolumn-balance-reports36019
|
||||
Node: Custom balance output40667
|
||||
Ref: #custom-balance-output40851
|
||||
Node: Colour support42944
|
||||
Ref: #colour-support43105
|
||||
Node: Output destination43278
|
||||
Ref: #output-destination43436
|
||||
Node: CSV output43706
|
||||
Ref: #csv-output43825
|
||||
Node: balancesheet44222
|
||||
Ref: #balancesheet44360
|
||||
Node: balancesheetequity46328
|
||||
Ref: #balancesheetequity46479
|
||||
Node: cashflow47268
|
||||
Ref: #cashflow47398
|
||||
Node: check-dates49310
|
||||
Ref: #check-dates49439
|
||||
Node: check-dupes49556
|
||||
Ref: #check-dupes49683
|
||||
Node: equity49820
|
||||
Ref: #equity49932
|
||||
Node: help50095
|
||||
Ref: #help50198
|
||||
Node: import51272
|
||||
Ref: #import51388
|
||||
Node: incomestatement51783
|
||||
Ref: #incomestatement51919
|
||||
Node: prices53872
|
||||
Ref: #prices53989
|
||||
Node: print54032
|
||||
Ref: #print54144
|
||||
Node: print-unique58990
|
||||
Ref: #print-unique59118
|
||||
Node: register59186
|
||||
Ref: #register59315
|
||||
Node: Custom register output63816
|
||||
Ref: #custom-register-output63947
|
||||
Node: register-match65244
|
||||
Ref: #register-match65380
|
||||
Node: rewrite65563
|
||||
Ref: #rewrite65682
|
||||
Node: stats65751
|
||||
Ref: #stats65856
|
||||
Node: tags66737
|
||||
Ref: #tags66837
|
||||
Node: test66869
|
||||
Ref: #test66955
|
||||
Node: ADD-ON COMMANDS67323
|
||||
Ref: #add-on-commands67435
|
||||
Node: Official add-ons68722
|
||||
Ref: #official-add-ons68864
|
||||
Node: api68951
|
||||
Ref: #api69042
|
||||
Node: ui69094
|
||||
Ref: #ui69195
|
||||
Node: web69253
|
||||
Ref: #web69344
|
||||
Node: Third party add-ons69390
|
||||
Ref: #third-party-add-ons69567
|
||||
Node: diff69702
|
||||
Ref: #diff69801
|
||||
Node: iadd69900
|
||||
Ref: #iadd70016
|
||||
Node: interest70099
|
||||
Ref: #interest70222
|
||||
Node: irr70317
|
||||
Ref: #irr70417
|
||||
Node: Experimental add-ons70495
|
||||
Ref: #experimental-add-ons70649
|
||||
Node: autosync70940
|
||||
Ref: #autosync71054
|
||||
Node: budget71293
|
||||
Ref: #budget71417
|
||||
Node: chart71483
|
||||
Ref: #chart71602
|
||||
Node: check71673
|
||||
Ref: #check71777
|
||||
Node: General options4048
|
||||
Ref: #general-options4175
|
||||
Node: Command options6494
|
||||
Ref: #command-options6647
|
||||
Node: Command arguments7045
|
||||
Ref: #command-arguments7205
|
||||
Node: Argument expansion7326
|
||||
Ref: #argument-expansion7491
|
||||
Node: Special characters7710
|
||||
Ref: #special-characters7869
|
||||
Node: Input files9288
|
||||
Ref: #input-files9426
|
||||
Node: Smart dates11389
|
||||
Ref: #smart-dates11532
|
||||
Node: Report start & end date12511
|
||||
Ref: #report-start-end-date12683
|
||||
Node: Report intervals13749
|
||||
Ref: #report-intervals13914
|
||||
Node: Period expressions14315
|
||||
Ref: #period-expressions14477
|
||||
Node: Depth limiting16817
|
||||
Ref: #depth-limiting16963
|
||||
Node: Pivoting17305
|
||||
Ref: #pivoting17425
|
||||
Node: Cost19101
|
||||
Ref: #cost19211
|
||||
Node: Market value19329
|
||||
Ref: #market-value19466
|
||||
Node: Regular expressions20766
|
||||
Ref: #regular-expressions20904
|
||||
Node: QUERIES22265
|
||||
Ref: #queries22369
|
||||
Node: COMMANDS26336
|
||||
Ref: #commands26450
|
||||
Node: accounts27433
|
||||
Ref: #accounts27533
|
||||
Node: activity28526
|
||||
Ref: #activity28638
|
||||
Node: add28997
|
||||
Ref: #add29098
|
||||
Node: balance31756
|
||||
Ref: #balance31869
|
||||
Node: Flat mode35026
|
||||
Ref: #flat-mode35153
|
||||
Node: Depth limited balance reports35573
|
||||
Ref: #depth-limited-balance-reports35776
|
||||
Node: Multicolumn balance reports36196
|
||||
Ref: #multicolumn-balance-reports36407
|
||||
Node: Custom balance output41055
|
||||
Ref: #custom-balance-output41239
|
||||
Node: Colour support43332
|
||||
Ref: #colour-support43493
|
||||
Node: Output destination43666
|
||||
Ref: #output-destination43824
|
||||
Node: CSV output44094
|
||||
Ref: #csv-output44213
|
||||
Node: balancesheet44610
|
||||
Ref: #balancesheet44748
|
||||
Node: balancesheetequity46716
|
||||
Ref: #balancesheetequity46867
|
||||
Node: cashflow47656
|
||||
Ref: #cashflow47786
|
||||
Node: check-dates49698
|
||||
Ref: #check-dates49827
|
||||
Node: check-dupes49944
|
||||
Ref: #check-dupes50071
|
||||
Node: equity50208
|
||||
Ref: #equity50320
|
||||
Node: help50483
|
||||
Ref: #help50586
|
||||
Node: import51660
|
||||
Ref: #import51776
|
||||
Node: incomestatement52171
|
||||
Ref: #incomestatement52307
|
||||
Node: prices54260
|
||||
Ref: #prices54377
|
||||
Node: print54420
|
||||
Ref: #print54532
|
||||
Node: print-unique59378
|
||||
Ref: #print-unique59506
|
||||
Node: register59574
|
||||
Ref: #register59703
|
||||
Node: Custom register output64204
|
||||
Ref: #custom-register-output64335
|
||||
Node: register-match65632
|
||||
Ref: #register-match65768
|
||||
Node: rewrite65951
|
||||
Ref: #rewrite66070
|
||||
Node: stats66139
|
||||
Ref: #stats66244
|
||||
Node: tags67125
|
||||
Ref: #tags67225
|
||||
Node: test67257
|
||||
Ref: #test67343
|
||||
Node: ADD-ON COMMANDS67711
|
||||
Ref: #add-on-commands67823
|
||||
Node: Official add-ons69110
|
||||
Ref: #official-add-ons69252
|
||||
Node: api69339
|
||||
Ref: #api69430
|
||||
Node: ui69482
|
||||
Ref: #ui69583
|
||||
Node: web69641
|
||||
Ref: #web69732
|
||||
Node: Third party add-ons69778
|
||||
Ref: #third-party-add-ons69955
|
||||
Node: diff70090
|
||||
Ref: #diff70189
|
||||
Node: iadd70288
|
||||
Ref: #iadd70404
|
||||
Node: interest70487
|
||||
Ref: #interest70610
|
||||
Node: irr70705
|
||||
Ref: #irr70805
|
||||
Node: Experimental add-ons70883
|
||||
Ref: #experimental-add-ons71037
|
||||
Node: autosync71328
|
||||
Ref: #autosync71442
|
||||
Node: budget71681
|
||||
Ref: #budget71805
|
||||
Node: chart71871
|
||||
Ref: #chart71990
|
||||
Node: check72061
|
||||
Ref: #check72165
|
||||
|
||||
End Tag Table
|
||||
|
||||
@ -111,8 +111,7 @@ EXAMPLES
|
||||
OPTIONS
|
||||
General options
|
||||
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.)
|
||||
ported by most hledger commands, run hledger -h.
|
||||
|
||||
General help options:
|
||||
|
||||
@ -203,14 +202,10 @@ OPTIONS
|
||||
convert amounts to their market value on the report end date
|
||||
(using the most recent applicable market price, if any)
|
||||
|
||||
A @FILE argument will be expanded to the contents of FILE, which should
|
||||
contain one command line option/argument per line. (To prevent this,
|
||||
insert a -- argument before.)
|
||||
When a reporting option appears more than once in the command line, the
|
||||
last one takes precedence.
|
||||
|
||||
When multiple similar reporting options are provided, the last one
|
||||
takes precedence. Eg --depth 3 --depth 1 is equivalent to --depth 1.
|
||||
|
||||
Some of the reporting options can also be written as query arguments.
|
||||
Some reporting options can also be written as query arguments.
|
||||
|
||||
Command options
|
||||
To see options for a particular command, including command-specific
|
||||
@ -227,6 +222,11 @@ OPTIONS
|
||||
Most hledger commands accept arguments after the command name, which
|
||||
are often a query, filtering the data in some way.
|
||||
|
||||
Argument expansion
|
||||
You can save a set of command line options/arguments in a file, one per
|
||||
line, and then reuse them by writing @FILE in a command line. (To pre-
|
||||
vent this expansion of @-arguments, precede them with a -- argument.)
|
||||
|
||||
Special characters
|
||||
Option and argument values which contain problematic characters should
|
||||
be escaped with double quotes, backslashes, or (best) single quotes.
|
||||
@ -241,9 +241,15 @@ OPTIONS
|
||||
symbol, bash users should do: hledger balance cur:'\$' or hledger bal-
|
||||
ance 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:\\\\$.
|
||||
When hledger is invoking an addon executable (like hledger-ui), options
|
||||
and arguments get de-escaped once more, so you might need triple-escap-
|
||||
ing. Eg: hledger ui cur:'\\$' or hledger ui cur:\\\\$ in bash. (The
|
||||
number of backslashes in fish shell is left as an exercise for the
|
||||
reader.)
|
||||
|
||||
Inside a file used for argument expansion, one less level of escaping
|
||||
is enough. (And in this case, backslashes seem to work better than
|
||||
quotes. Eg: cur:\$).
|
||||
|
||||
If in doubt, keep things simple:
|
||||
|
||||
@ -328,6 +334,7 @@ OPTIONS
|
||||
next year january 1 of next year
|
||||
this month the 1st of the current
|
||||
month
|
||||
|
||||
this week the most recent monday
|
||||
last week the monday of the week
|
||||
before this one
|
||||
|
||||
@ -4,7 +4,6 @@
|
||||
|
||||
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.)
|
||||
|
||||
General help options:
|
||||
|
||||
@ -18,8 +17,6 @@ General reporting options:
|
||||
|
||||
_reportingoptions_
|
||||
|
||||
_optionnotes_
|
||||
|
||||
## Command options
|
||||
|
||||
To see options for a particular command, including command-specific options, run: `hledger COMMAND -h`.
|
||||
@ -35,6 +32,12 @@ Or, you can run the addon executable directly: `hledger-ui --watch`.
|
||||
Most hledger commands accept arguments after the command name,
|
||||
which are often a [query](#queries), filtering the data in some way.
|
||||
|
||||
## Argument expansion
|
||||
|
||||
You can save a set of command line options/arguments in a file, one per line,
|
||||
and then reuse them by writing `@FILE` in a command line.
|
||||
(To prevent this expansion of `@`-arguments, precede them with a `--` argument.)
|
||||
|
||||
## Special characters
|
||||
|
||||
Option and argument values which contain problematic characters
|
||||
@ -49,9 +52,14 @@ 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:\\\\$`.
|
||||
When hledger is invoking an addon executable (like hledger-ui),
|
||||
options and arguments get de-escaped once more,
|
||||
so you might need *triple*-escaping.
|
||||
Eg: `hledger ui cur:'\\$'` or `hledger ui cur:\\\\$` in bash.
|
||||
(The number of backslashes in fish shell is left as an exercise for the reader.)
|
||||
|
||||
Inside a file used for [argument expansion](#argument-expansion), one less level of escaping is enough.
|
||||
(And in this case, backslashes seem to work better than quotes. Eg: `cur:\$`).
|
||||
|
||||
If in doubt, keep things simple:
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user