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

doc: options help tweaks

Browse Source
This commit is contained in:
Simon Michael 2017-09-30 11:29:25 -10:00
parent 6632aedd93
commit 0af0961e10
13 changed files with 569 additions and 547 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/lib.m4
View File

@ -155,18 +155,9 @@ m4_define({{_reportingoptions_}}, {{
: 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](journal.html#market-prices), if any) (using the most recent applicable [market price](journal.html#market-prices), if any)
}} )m4_dnl When a reporting option appears more than once in the command line, the last one takes precedence.
m4_dnl
m4_define({{_optionnotes_}}, {{
A @FILE argument will be expanded to the contents of FILE, Some reporting options can also be written as [query arguments](#queries).
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).
}} )m4_dnl }} )m4_dnl
m4_dnl m4_dnl

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

@ -188,6 +188,11 @@ most recent applicable market price, if any)
.RS .RS
.RE .RE
.PP .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: hledger help options:
.TP .TP
.B \f[C]\-h\ \-\-help\f[] .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 A \@FILE argument will be expanded to the contents of FILE, which should
contain one command line option/argument per line. contain one command line option/argument per line.
(To prevent this, insert a \f[C]\-\-\f[] argument before.) (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 .SH KEYS
.PP .PP
\f[C]?\f[] shows a help dialog listing all keys. \f[C]?\f[] shows a help dialog listing all keys.

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

@ -132,6 +132,11 @@ 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)
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: hledger help options:
'-h --help' '-h --help'
@ -148,12 +153,6 @@ the data.
should contain one command line option/argument per line. (To prevent should contain one command line option/argument per line. (To prevent
this, insert a '--' argument before.) 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 File: hledger-ui.1.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
@ -368,17 +367,17 @@ Tag Table:
Node: Top73 Node: Top73
Node: OPTIONS831 Node: OPTIONS831
Ref: #options930 Ref: #options930
Node: KEYS3916 Node: KEYS3867
Ref: #keys4013 Ref: #keys3964
Node: SCREENS6809 Node: SCREENS6760
Ref: #screens6896 Ref: #screens6847
Node: Accounts screen6986 Node: Accounts screen6937
Ref: #accounts-screen7116 Ref: #accounts-screen7067
Node: Register screen9346 Node: Register screen9297
Ref: #register-screen9503 Ref: #register-screen9454
Node: Transaction screen11577 Node: Transaction screen11528
Ref: #transaction-screen11737 Ref: #transaction-screen11688
Node: Error screen12607 Node: Error screen12558
Ref: #error-screen12731 Ref: #error-screen12682
 
End Tag Table End Tag Table

4
hledger-ui/doc/hledger-ui.1.m4.md
View File

@ -81,7 +81,9 @@ hledger help options:
_helpoptions_ _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 # KEYS

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

@ -128,6 +128,11 @@ 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)
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: hledger help options:
-h --help -h --help
@ -140,14 +145,9 @@ OPTIONS
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which should A @FILE argument will be expanded to the contents of FILE, which should
contain one command line option/argument per line. (To prevent this, contain one command line option/argument per line. (To prevent this,
insert a -- argument before.) 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 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,

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

@ -244,6 +244,11 @@ most recent applicable market price, if any)
.RS .RS
.RE .RE
.PP .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: hledger help options:
.TP .TP
.B \f[C]\-h\ \-\-help\f[] .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 A \@FILE argument will be expanded to the contents of FILE, which should
contain one command line option/argument per line. contain one command line option/argument per line.
(To prevent this, insert a \f[C]\-\-\f[] argument before.) (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 .SH ENVIRONMENT
.PP .PP
\f[B]LEDGER_FILE\f[] The journal file path when not specified with \f[B]LEDGER_FILE\f[] The journal file path when not specified with

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

@ -177,6 +177,11 @@ 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)
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: hledger help options:
'-h --help' '-h --help'
@ -193,12 +198,6 @@ options as shown above.
should contain one command line option/argument per line. (To prevent should contain one command line option/argument per line. (To prevent
this, insert a '--' argument before.) 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: Tag Table:
Node: Top74 Node: Top74

4
hledger-web/doc/hledger-web.1.m4.md
View File

@ -136,7 +136,9 @@ hledger help options:
_helpoptions_ _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_({{ _man_({{

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

@ -173,6 +173,11 @@ 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)
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: hledger help options:
-h --help -h --help
@ -185,14 +190,9 @@ OPTIONS
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which should A @FILE argument will be expanded to the contents of FILE, which should
contain one command line option/argument per line. (To prevent this, contain one command line option/argument per line. (To prevent this,
insert a -- argument before.) 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 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-

35
hledger/doc/hledger.1
View File

@ -156,7 +156,6 @@ $\ hledger\ activity\ \-W\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ tran
.PP .PP
To see general usage help, including general options which are supported To see general usage help, including general options which are supported
by most hledger commands, run \f[C]hledger\ \-h\f[]. by most hledger commands, run \f[C]hledger\ \-h\f[].
(Note \-h and \-\-help are different, like git.)
.PP .PP
General help options: General help options:
.TP .TP
@ -299,16 +298,10 @@ most recent applicable market price, if any)
.RS .RS
.RE .RE
.PP .PP
A \@FILE argument will be expanded to the contents of FILE, which should When a reporting option appears more than once in the command line, the
contain one command line option/argument per line. last one takes precedence.
(To prevent this, insert a \f[C]\-\-\f[] argument before.)
.PP .PP
When multiple similar reporting options are provided, the last one takes Some reporting options can also be written as query arguments.
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.
.SS Command options .SS Command options
.PP .PP
To see options for a particular command, including command\-specific To see options for a particular command, including command\-specific
@ -326,6 +319,12 @@ Or, you can run the addon executable directly:
.PP .PP
Most hledger commands accept arguments after the command name, which are Most hledger commands accept arguments after the command name, which are
often a query, filtering the data in some way. 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 .SS Special characters
.PP .PP
Option and argument values which contain problematic characters should 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:\[aq]\\$\[aq]\f[] or
\f[C]hledger\ balance\ cur:\\\\$\f[]. \f[C]hledger\ balance\ cur:\\\\$\f[].
.PP .PP
There\[aq]s more.. When hledger is invoking an addon executable (like hledger\-ui), options
options and arguments get de\-escaped when hledger is passing them to an and arguments get de\-escaped once more, so you might need
addon executable. \f[I]triple\f[]\-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[] 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 .PP
If in doubt, keep things simple: If in doubt, keep things simple:
.IP \[bu] 2 .IP \[bu] 2

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

@ -118,6 +118,7 @@ File: hledger.1.info, Node: OPTIONS, Next: QUERIES, Prev: EXAMPLES, Up: Top
* General options:: * General options::
* Command options:: * Command options::
* Command arguments:: * Command arguments::
* Argument expansion::
* Special characters:: * Special characters::
* Input files:: * Input files::
* Smart dates:: * 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 To see general usage help, including general options which are supported
by most hledger commands, run 'hledger -h'. (Note -h and -help are by most hledger commands, run 'hledger -h'.
different, like git.)
General help options: General help options:
@ -232,15 +232,10 @@ different, like git.)
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)
A @FILE argument will be expanded to the contents of FILE, which When a reporting option appears more than once in the command line,
should contain one command line option/argument per line. (To prevent the last one takes precedence.
this, insert a '--' argument before.)
When multiple similar reporting options are provided, the last one Some reporting options can also be written as query arguments.
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.1.info, Node: Command options, Next: Command arguments, Prev: General options, Up: OPTIONS 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'. 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 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. 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 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 dollar symbol, bash users should do: 'hledger balance cur:'\$'' or
'hledger balance cur:\\$'. 'hledger balance cur:\\$'.
There's more.. options and arguments get de-escaped when hledger is When hledger is invoking an addon executable (like hledger-ui),
passing them to an addon executable. In this case you might need options and arguments get de-escaped once more, so you might need
_triple_-escaping. Eg: 'hledger ui cur:'\\$'' or 'hledger ui _triple_-escaping. Eg: 'hledger ui cur:'\\$'' or 'hledger ui cur:\\\\$'
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: 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 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 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 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 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 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 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 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, 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 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 The '-p/--period' option accepts period expressions, a shorthand way of
expressing a start date, end date, and/or report interval all at once. 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 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, 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 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 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 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, 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 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 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 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: hledger uses regular expressions in a number of places:
@ -2202,127 +2213,129 @@ Node: EXAMPLES1892
Ref: #examples1994 Ref: #examples1994
Node: OPTIONS3640 Node: OPTIONS3640
Ref: #options3744 Ref: #options3744
Node: General options4025 Node: General options4048
Ref: #general-options4152 Ref: #general-options4175
Node: Command options6744 Node: Command options6494
Ref: #command-options6897 Ref: #command-options6647
Node: Command arguments7295 Node: Command arguments7045
Ref: #command-arguments7455 Ref: #command-arguments7205
Node: Special characters7576 Node: Argument expansion7326
Ref: #special-characters7734 Ref: #argument-expansion7491
Node: Input files8902 Node: Special characters7710
Ref: #input-files9040 Ref: #special-characters7869
Node: Smart dates11003 Node: Input files9288
Ref: #smart-dates11146 Ref: #input-files9426
Node: Report start & end date12125 Node: Smart dates11389
Ref: #report-start-end-date12297 Ref: #smart-dates11532
Node: Report intervals13363 Node: Report start & end date12511
Ref: #report-intervals13528 Ref: #report-start-end-date12683
Node: Period expressions13929 Node: Report intervals13749
Ref: #period-expressions14089 Ref: #report-intervals13914
Node: Depth limiting16429 Node: Period expressions14315
Ref: #depth-limiting16575 Ref: #period-expressions14477
Node: Pivoting16917 Node: Depth limiting16817
Ref: #pivoting17037 Ref: #depth-limiting16963
Node: Cost18713 Node: Pivoting17305
Ref: #cost18823 Ref: #pivoting17425
Node: Market value18941 Node: Cost19101
Ref: #market-value19078 Ref: #cost19211
Node: Regular expressions20378 Node: Market value19329
Ref: #regular-expressions20516 Ref: #market-value19466
Node: QUERIES21877 Node: Regular expressions20766
Ref: #queries21981 Ref: #regular-expressions20904
Node: COMMANDS25948 Node: QUERIES22265
Ref: #commands26062 Ref: #queries22369
Node: accounts27045 Node: COMMANDS26336
Ref: #accounts27145 Ref: #commands26450
Node: activity28138 Node: accounts27433
Ref: #activity28250 Ref: #accounts27533
Node: add28609 Node: activity28526
Ref: #add28710 Ref: #activity28638
Node: balance31368 Node: add28997
Ref: #balance31481 Ref: #add29098
Node: Flat mode34638 Node: balance31756
Ref: #flat-mode34765 Ref: #balance31869
Node: Depth limited balance reports35185 Node: Flat mode35026
Ref: #depth-limited-balance-reports35388 Ref: #flat-mode35153
Node: Multicolumn balance reports35808 Node: Depth limited balance reports35573
Ref: #multicolumn-balance-reports36019 Ref: #depth-limited-balance-reports35776
Node: Custom balance output40667 Node: Multicolumn balance reports36196
Ref: #custom-balance-output40851 Ref: #multicolumn-balance-reports36407
Node: Colour support42944 Node: Custom balance output41055
Ref: #colour-support43105 Ref: #custom-balance-output41239
Node: Output destination43278 Node: Colour support43332
Ref: #output-destination43436 Ref: #colour-support43493
Node: CSV output43706 Node: Output destination43666
Ref: #csv-output43825 Ref: #output-destination43824
Node: balancesheet44222 Node: CSV output44094
Ref: #balancesheet44360 Ref: #csv-output44213
Node: balancesheetequity46328 Node: balancesheet44610
Ref: #balancesheetequity46479 Ref: #balancesheet44748
Node: cashflow47268 Node: balancesheetequity46716
Ref: #cashflow47398 Ref: #balancesheetequity46867
Node: check-dates49310 Node: cashflow47656
Ref: #check-dates49439 Ref: #cashflow47786
Node: check-dupes49556 Node: check-dates49698
Ref: #check-dupes49683 Ref: #check-dates49827
Node: equity49820 Node: check-dupes49944
Ref: #equity49932 Ref: #check-dupes50071
Node: help50095 Node: equity50208
Ref: #help50198 Ref: #equity50320
Node: import51272 Node: help50483
Ref: #import51388 Ref: #help50586
Node: incomestatement51783 Node: import51660
Ref: #incomestatement51919 Ref: #import51776
Node: prices53872 Node: incomestatement52171
Ref: #prices53989 Ref: #incomestatement52307
Node: print54032 Node: prices54260
Ref: #print54144 Ref: #prices54377
Node: print-unique58990 Node: print54420
Ref: #print-unique59118 Ref: #print54532
Node: register59186 Node: print-unique59378
Ref: #register59315 Ref: #print-unique59506
Node: Custom register output63816 Node: register59574
Ref: #custom-register-output63947 Ref: #register59703
Node: register-match65244 Node: Custom register output64204
Ref: #register-match65380 Ref: #custom-register-output64335
Node: rewrite65563 Node: register-match65632
Ref: #rewrite65682 Ref: #register-match65768
Node: stats65751 Node: rewrite65951
Ref: #stats65856 Ref: #rewrite66070
Node: tags66737 Node: stats66139
Ref: #tags66837 Ref: #stats66244
Node: test66869 Node: tags67125
Ref: #test66955 Ref: #tags67225
Node: ADD-ON COMMANDS67323 Node: test67257
Ref: #add-on-commands67435 Ref: #test67343
Node: Official add-ons68722 Node: ADD-ON COMMANDS67711
Ref: #official-add-ons68864 Ref: #add-on-commands67823
Node: api68951 Node: Official add-ons69110
Ref: #api69042 Ref: #official-add-ons69252
Node: ui69094 Node: api69339
Ref: #ui69195 Ref: #api69430
Node: web69253 Node: ui69482
Ref: #web69344 Ref: #ui69583
Node: Third party add-ons69390 Node: web69641
Ref: #third-party-add-ons69567 Ref: #web69732
Node: diff69702 Node: Third party add-ons69778
Ref: #diff69801 Ref: #third-party-add-ons69955
Node: iadd69900 Node: diff70090
Ref: #iadd70016 Ref: #diff70189
Node: interest70099 Node: iadd70288
Ref: #interest70222 Ref: #iadd70404
Node: irr70317 Node: interest70487
Ref: #irr70417 Ref: #interest70610
Node: Experimental add-ons70495 Node: irr70705
Ref: #experimental-add-ons70649 Ref: #irr70805
Node: autosync70940 Node: Experimental add-ons70883
Ref: #autosync71054 Ref: #experimental-add-ons71037
Node: budget71293 Node: autosync71328
Ref: #budget71417 Ref: #autosync71442
Node: chart71483 Node: budget71681
Ref: #chart71602 Ref: #budget71805
Node: check71673 Node: chart71871
Ref: #check71777 Ref: #chart71990
Node: check72061
Ref: #check72165
 
End Tag Table End Tag Table

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

File diff suppressed because it is too large Load Diff

20
hledger/doc/options.m4.md
View File

@ -4,7 +4,6 @@
To see general usage help, including general options To see general usage help, including general options
which are supported by most hledger commands, run `hledger -h`. which are supported by most hledger commands, run `hledger -h`.
(Note -h and --help are different, like git.)
General help options: General help options:
@ -18,8 +17,6 @@ General reporting options:
_reportingoptions_ _reportingoptions_
_optionnotes_
## Command options ## Command options
To see options for a particular command, including command-specific options, run: `hledger COMMAND -h`. 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, Most hledger commands accept arguments after the command name,
which are often a [query](#queries), filtering the data in some way. 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 ## Special characters
Option and argument values which contain problematic 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 Eg, to match the dollar symbol, bash users should do: `hledger balance cur:'\$'` or
`hledger balance cur:\\$`. `hledger balance cur:\\$`.
There's more.. options and arguments get de-escaped when hledger When hledger is invoking an addon executable (like hledger-ui),
is passing them to an addon executable. In this case you might need *triple*-escaping. options and arguments get de-escaped once more,
Eg: `hledger ui cur:'\\$'` or `hledger ui cur:\\\\$`. 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: If in doubt, keep things simple: