;regen manuals

This commit is contained in:
Simon Michael 2020-07-07 13:42:11 -07:00
parent 3ad313d8fa
commit ae4fce8077
6 changed files with 661 additions and 444 deletions

View File

@ -674,7 +674,18 @@ number, like \f[C]%date\f[R] or \f[C]%1\f[R].
.PP
A single matcher can be written on the same line as the \[dq]if\[dq]; or
multiple matchers can be written on the following lines, non-indented.
Multiple matchers are OR\[aq]d (any one of them can match).
Multiple matchers are OR\[aq]d (any one of them can match), unless one
begins with an \f[C]&\f[R] symbol, in which case it is AND\[aq]ed with
the previous matcher.
.IP
.nf
\f[C]
if
MATCHER
& MATCHER
RULE
\f[R]
.fi
.PP
After the patterns there should be one or more rules to apply, all
indented by at least one space.

View File

@ -642,7 +642,14 @@ is a percent sign followed by the field's name or column number, like
A single matcher can be written on the same line as the "if"; or
multiple matchers can be written on the following lines, non-indented.
Multiple matchers are OR'd (any one of them can match).
Multiple matchers are OR'd (any one of them can match), unless one
begins with an '&' symbol, in which case it is AND'ed with the previous
matcher.
if
MATCHER
& MATCHER
RULE
After the patterns there should be one or more rules to apply, all
indented by at least one space. Three kinds of rule are allowed in
@ -1141,40 +1148,40 @@ Node: separator21340
Ref: #separator21475
Node: if block21886
Ref: #if-block22011
Node: if table24167
Ref: #if-table24286
Node: end26024
Ref: #end26136
Node: date-format26360
Ref: #date-format26492
Node: newest-first27241
Ref: #newest-first27379
Node: include28062
Ref: #include28193
Node: balance-type28637
Ref: #balance-type28757
Node: TIPS29457
Ref: #tips29539
Node: Rapid feedback29795
Ref: #rapid-feedback29912
Node: Valid CSV30372
Ref: #valid-csv30502
Node: File Extension30694
Ref: #file-extension30846
Node: Reading multiple CSV files31256
Ref: #reading-multiple-csv-files31441
Node: Valid transactions31682
Ref: #valid-transactions31860
Node: Deduplicating importing32488
Ref: #deduplicating-importing32667
Node: Setting amounts33700
Ref: #setting-amounts33869
Node: Setting currency/commodity34856
Ref: #setting-currencycommodity35048
Node: Referencing other fields35851
Ref: #referencing-other-fields36051
Node: How CSV rules are evaluated36948
Ref: #how-csv-rules-are-evaluated37121
Node: if table24287
Ref: #if-table24406
Node: end26144
Ref: #end26256
Node: date-format26480
Ref: #date-format26612
Node: newest-first27361
Ref: #newest-first27499
Node: include28182
Ref: #include28313
Node: balance-type28757
Ref: #balance-type28877
Node: TIPS29577
Ref: #tips29659
Node: Rapid feedback29915
Ref: #rapid-feedback30032
Node: Valid CSV30492
Ref: #valid-csv30622
Node: File Extension30814
Ref: #file-extension30966
Node: Reading multiple CSV files31376
Ref: #reading-multiple-csv-files31561
Node: Valid transactions31802
Ref: #valid-transactions31980
Node: Deduplicating importing32608
Ref: #deduplicating-importing32787
Node: Setting amounts33820
Ref: #setting-amounts33989
Node: Setting currency/commodity34976
Ref: #setting-currencycommodity35168
Node: Referencing other fields35971
Ref: #referencing-other-fields36171
Node: How CSV rules are evaluated37068
Ref: #how-csv-rules-are-evaluated37241

End Tag Table

View File

@ -506,7 +506,13 @@ CSV RULES
A single matcher can be written on the same line as the "if"; or multi-
ple matchers can be written on the following lines, non-indented. Mul-
tiple matchers are OR'd (any one of them can match).
tiple matchers are OR'd (any one of them can match), unless one begins
with an & symbol, in which case it is AND'ed with the previous matcher.
if
MATCHER
& MATCHER
RULE
After the patterns there should be one or more rules to apply, all in-
dented by at least one space. Three kinds of rule are allowed in con-

View File

@ -3429,6 +3429,64 @@ Here\[aq]s one way to resolve that:
assets:checking
\f[R]
.fi
.SS codes
.PP
codes
.PD 0
.P
.PD
List the codes seen in transactions, in the order parsed.
.PP
This command prints the value of each transaction\[aq]s code field, in
the order transactions were parsed.
The transaction code is an optional value written in parentheses between
the date and description, often used to store a cheque number, order
number or similar.
.PP
Transactions aren\[aq]t required to have a code, and missing or empty
codes will not be shown by default.
With the \f[C]-E\f[R]/\f[C]--empty\f[R] flag, they will be printed as
blank lines.
.PP
You can add a query to select a subset of transactions.
.PP
Examples:
.IP
.nf
\f[C]
1/1 (123)
(a) 1
1/1 ()
(a) 1
1/1
(a) 1
1/1 (126)
(a) 1
\f[R]
.fi
.IP
.nf
\f[C]
$ hledger codes
123
124
126
\f[R]
.fi
.IP
.nf
\f[C]
$ hledger codes -E
123
124
126
\f[R]
.fi
.SS commodities
.PP
commodities
@ -3438,11 +3496,17 @@ commodities
List all commodity/currency symbols used or declared in the journal.
.SS descriptions
.PP
descriptions Show descriptions.
descriptions
.PD 0
.P
.PD
List the unique descriptions that appear in transactions.
.PP
This command lists all descriptions that appear in transactions.
This command lists the unique descriptions that appear in transactions,
in alphabetic order.
You can add a query to select a subset of transactions.
.PP
Examples:
Example:
.IP
.nf
\f[C]
@ -3652,11 +3716,19 @@ options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R],
\f[C]html\f[R], and (experimental) \f[C]json\f[R].
.SS notes
.PP
notes Show notes.
notes
.PD 0
.P
.PD
List the unique notes that appear in transactions.
.PP
This command lists all notes that appear in transactions.
This command lists the unique notes that appear in transactions, in
alphabetic order.
You can add a query to select a subset of transactions.
The note is the part of the transaction description after a | character
(or if there is no |, the whole description).
.PP
Examples:
Example:
.IP
.nf
\f[C]
@ -3667,11 +3739,19 @@ Snacks
.fi
.SS payees
.PP
payees Show payee names.
payees
.PD 0
.P
.PD
List the unique payee/payer names that appear in transactions.
.PP
This command lists all payee names that appear in transactions.
This command lists the unique payee/payer names that appear in
transactions, in alphabetic order.
You can add a query to select a subset of transactions.
The payee/payer is the part of the transaction description before a |
character (or if there is no |, the whole description).
.PP
Examples:
Example:
.IP
.nf
\f[C]

View File

@ -1903,6 +1903,7 @@ detailed command help.
* check-dates::
* check-dupes::
* close::
* codes::
* commodities::
* descriptions::
* diff::
@ -2776,7 +2777,7 @@ the default journal file, or another specified as an argument.
An example: http://stefanorodighiero.net/software/hledger-dupes.html

File: hledger.info, Node: close, Next: commodities, Prev: check-dupes, Up: COMMANDS
File: hledger.info, Node: close, Next: codes, Prev: check-dupes, Up: COMMANDS
3.10 close
==========
@ -2887,9 +2888,55 @@ breaking balance assertions:
assets:checking

File: hledger.info, Node: commodities, Next: descriptions, Prev: close, Up: COMMANDS
File: hledger.info, Node: codes, Next: commodities, Prev: close, Up: COMMANDS
3.11 commodities
3.11 codes
==========
codes
List the codes seen in transactions, in the order parsed.
This command prints the value of each transaction's code field, in
the order transactions were parsed. The transaction code is an optional
value written in parentheses between the date and description, often
used to store a cheque number, order number or similar.
Transactions aren't required to have a code, and missing or empty
codes will not be shown by default. With the '-E'/'--empty' flag, they
will be printed as blank lines.
You can add a query to select a subset of transactions.
Examples:
1/1 (123)
(a) 1
1/1 ()
(a) 1
1/1
(a) 1
1/1 (126)
(a) 1
$ hledger codes
123
124
126
$ hledger codes -E
123
124
126

File: hledger.info, Node: commodities, Next: descriptions, Prev: codes, Up: COMMANDS
3.12 commodities
================
commodities
@ -2898,14 +2945,17 @@ List all commodity/currency symbols used or declared in the journal.

File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: COMMANDS
3.12 descriptions
3.13 descriptions
=================
descriptions Show descriptions.
descriptions
List the unique descriptions that appear in transactions.
This command lists all descriptions that appear in transactions.
This command lists the unique descriptions that appear in
transactions, in alphabetic order. You can add a query to select a
subset of transactions.
Examples:
Example:
$ hledger descriptions
Store Name
@ -2915,7 +2965,7 @@ Person A

File: hledger.info, Node: diff, Next: files, Prev: descriptions, Up: COMMANDS
3.13 diff
3.14 diff
=========
diff
@ -2950,7 +3000,7 @@ These transactions are in the second file only:

File: hledger.info, Node: files, Next: help, Prev: diff, Up: COMMANDS
3.14 files
3.15 files
==========
files
@ -2960,7 +3010,7 @@ file names matching the regular expression (case sensitive) are shown.

File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
3.15 help
3.16 help
=========
help
@ -3000,7 +3050,7 @@ DESCRIPTION

File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: COMMANDS
3.16 import
3.17 import
===========
import
@ -3029,7 +3079,7 @@ $ hledger import --dry ... | hledger -f- print unknown --ignore-assertions

File: hledger.info, Node: Importing balance assignments, Up: import
3.16.1 Importing balance assignments
3.17.1 Importing balance assignments
------------------------------------
Entries added by import will have their posting amounts made explicit
@ -3048,7 +3098,7 @@ please test it and send a pull request.)

File: hledger.info, Node: incomestatement, Next: notes, Prev: import, Up: COMMANDS
3.17 incomestatement
3.18 incomestatement
====================
incomestatement, is
@ -3097,14 +3147,18 @@ options The output formats supported are 'txt', 'csv', 'html', and

File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: COMMANDS
3.18 notes
3.19 notes
==========
notes Show notes.
notes
List the unique notes that appear in transactions.
This command lists all notes that appear in transactions.
This command lists the unique notes that appear in transactions, in
alphabetic order. You can add a query to select a subset of
transactions. The note is the part of the transaction description after
a | character (or if there is no |, the whole description).
Examples:
Example:
$ hledger notes
Petrol
@ -3113,14 +3167,19 @@ Snacks

File: hledger.info, Node: payees, Next: prices, Prev: notes, Up: COMMANDS
3.19 payees
3.20 payees
===========
payees Show payee names.
payees
List the unique payee/payer names that appear in transactions.
This command lists all payee names that appear in transactions.
This command lists the unique payee/payer names that appear in
transactions, in alphabetic order. You can add a query to select a
subset of transactions. The payee/payer is the part of the transaction
description before a | character (or if there is no |, the whole
description).
Examples:
Example:
$ hledger payees
Store Name
@ -3130,7 +3189,7 @@ Person A

File: hledger.info, Node: prices, Next: print, Prev: payees, Up: COMMANDS
3.20 prices
3.21 prices
===========
prices
@ -3143,7 +3202,7 @@ Price amounts are always displayed with their full precision.

File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS
3.21 print
3.22 print
==========
print, txns, p
@ -3252,7 +3311,7 @@ $ hledger print -Ocsv

File: hledger.info, Node: print-unique, Next: register, Prev: print, Up: COMMANDS
3.22 print-unique
3.23 print-unique
=================
print-unique
@ -3273,7 +3332,7 @@ $ LEDGER_FILE=unique.journal hledger print-unique

File: hledger.info, Node: register, Next: register-match, Prev: print-unique, Up: COMMANDS
3.23 register
3.24 register
=============
register, reg, r
@ -3363,7 +3422,7 @@ length and comparable to the others in the report.

File: hledger.info, Node: Custom register output, Up: register
3.23.1 Custom register output
3.24.1 Custom register output
-----------------------------
register uses the full terminal width by default, except on windows.
@ -3395,7 +3454,7 @@ options The output formats supported are 'txt', 'csv', and

File: hledger.info, Node: register-match, Next: rewrite, Prev: register, Up: COMMANDS
3.24 register-match
3.25 register-match
===================
register-match
@ -3408,7 +3467,7 @@ ledger-autosync detect already-seen transactions when importing.

File: hledger.info, Node: rewrite, Next: roi, Prev: register-match, Up: COMMANDS
3.25 rewrite
3.26 rewrite
============
rewrite
@ -3460,7 +3519,7 @@ commodity.

File: hledger.info, Node: Re-write rules in a file, Up: rewrite
3.25.1 Re-write rules in a file
3.26.1 Re-write rules in a file
-------------------------------
During the run this tool will execute so called "Automated Transactions"
@ -3503,7 +3562,7 @@ postings.

File: hledger.info, Node: Diff output format, Next: rewrite vs print --auto, Up: Re-write rules in a file
3.25.1.1 Diff output format
3.26.1.1 Diff output format
...........................
To use this tool for batch modification of your journal files you may
@ -3544,7 +3603,7 @@ output from 'hledger print'.

File: hledger.info, Node: rewrite vs print --auto, Prev: Diff output format, Up: Re-write rules in a file
3.25.1.2 rewrite vs. print -auto
3.26.1.2 rewrite vs. print -auto
................................
This command predates print -auto, and currently does much the same
@ -3564,7 +3623,7 @@ thing, but with these differences:

File: hledger.info, Node: roi, Next: stats, Prev: rewrite, Up: COMMANDS
3.26 roi
3.27 roi
========
roi
@ -3592,7 +3651,7 @@ regardless of the length of reporting interval.

File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS
3.27 stats
3.28 stats
==========
stats
@ -3623,7 +3682,7 @@ selection.

File: hledger.info, Node: tags, Next: test, Prev: stats, Up: COMMANDS
3.28 tags
3.29 tags
=========
tags
@ -3636,7 +3695,7 @@ instead.

File: hledger.info, Node: test, Next: Add-on commands, Prev: tags, Up: COMMANDS
3.29 test
3.30 test
=========
test
@ -3663,7 +3722,7 @@ $ hledger test -- -pData.Amount --color=never

File: hledger.info, Node: Add-on commands, Prev: test, Up: COMMANDS
3.30 Add-on commands
3.31 Add-on commands
====================
hledger also searches for external add-on commands, and will include
@ -3704,7 +3763,7 @@ interfaces. These are maintained and released along with hledger:

File: hledger.info, Node: ui, Next: web, Up: Add-on commands
3.30.1 ui
3.31.1 ui
---------
hledger-ui provides an efficient terminal interface.
@ -3712,7 +3771,7 @@ hledger-ui provides an efficient terminal interface.

File: hledger.info, Node: web, Next: iadd, Prev: ui, Up: Add-on commands
3.30.2 web
3.31.2 web
----------
hledger-web provides a simple web interface.
@ -3722,7 +3781,7 @@ hledger-web provides a simple web interface.

File: hledger.info, Node: iadd, Next: interest, Prev: web, Up: Add-on commands
3.30.3 iadd
3.31.3 iadd
-----------
hledger-iadd is a more interactive, terminal UI replacement for the add
@ -3731,7 +3790,7 @@ command.

File: hledger.info, Node: interest, Prev: iadd, Up: Add-on commands
3.30.4 interest
3.31.4 interest
---------------
hledger-interest generates interest transactions for an account
@ -3968,113 +4027,115 @@ Node: Effect of valuation on reports58740
Ref: #effect-of-valuation-on-reports58928
Node: COMMANDS64449
Ref: #commands64557
Node: accounts65641
Ref: #accounts65739
Node: activity66438
Ref: #activity66548
Node: add66931
Ref: #add67030
Node: balance69823
Ref: #balance69934
Node: Classic balance report71392
Ref: #classic-balance-report71565
Node: Customising the classic balance report72999
Ref: #customising-the-classic-balance-report73227
Node: Colour support75303
Ref: #colour-support75470
Node: Flat mode75643
Ref: #flat-mode75791
Node: Depth limited balance reports76204
Ref: #depth-limited-balance-reports76389
Node: Percentages76845
Ref: #percentages77011
Node: Multicolumn balance report78148
Ref: #multicolumn-balance-report78328
Node: Budget report84066
Ref: #budget-report84209
Node: Nested budgets89475
Ref: #nested-budgets89587
Ref: #output-format-193068
Node: balancesheet93265
Ref: #balancesheet93401
Node: balancesheetequity94867
Ref: #balancesheetequity95016
Node: cashflow95739
Ref: #cashflow95867
Node: check-dates97046
Ref: #check-dates97173
Node: check-dupes97452
Ref: #check-dupes97576
Node: close97869
Ref: #close97983
Node: close usage99505
Ref: #close-usage99598
Node: commodities102411
Ref: #commodities102538
Node: descriptions102620
Ref: #descriptions102748
Node: diff102929
Ref: #diff103035
Node: files104082
Ref: #files104182
Node: help104329
Ref: #help104429
Node: import105510
Ref: #import105624
Node: Importing balance assignments106517
Ref: #importing-balance-assignments106665
Node: incomestatement107314
Ref: #incomestatement107447
Node: notes108934
Ref: #notes109047
Node: payees109173
Ref: #payees109279
Node: prices109437
Ref: #prices109543
Node: print109884
Ref: #print109994
Node: print-unique114790
Ref: #print-unique114916
Node: register115201
Ref: #register115328
Node: Custom register output119500
Ref: #custom-register-output119629
Node: register-match120966
Ref: #register-match121100
Node: rewrite121451
Ref: #rewrite121566
Node: Re-write rules in a file123421
Ref: #re-write-rules-in-a-file123555
Node: Diff output format124765
Ref: #diff-output-format124934
Node: rewrite vs print --auto126026
Ref: #rewrite-vs.-print---auto126205
Node: roi126761
Ref: #roi126859
Node: stats127871
Ref: #stats127970
Node: tags128758
Ref: #tags128856
Node: test129150
Ref: #test129258
Node: Add-on commands130005
Ref: #add-on-commands130122
Node: ui131465
Ref: #ui131553
Node: web131607
Ref: #web131710
Node: iadd131826
Ref: #iadd131937
Node: interest132019
Ref: #interest132126
Node: ENVIRONMENT132366
Ref: #environment132478
Node: FILES133307
Ref: #files-1133410
Node: LIMITATIONS133623
Ref: #limitations133742
Node: TROUBLESHOOTING134484
Ref: #troubleshooting134597
Node: accounts65651
Ref: #accounts65749
Node: activity66448
Ref: #activity66558
Node: add66941
Ref: #add67040
Node: balance69833
Ref: #balance69944
Node: Classic balance report71402
Ref: #classic-balance-report71575
Node: Customising the classic balance report73009
Ref: #customising-the-classic-balance-report73237
Node: Colour support75313
Ref: #colour-support75480
Node: Flat mode75653
Ref: #flat-mode75801
Node: Depth limited balance reports76214
Ref: #depth-limited-balance-reports76399
Node: Percentages76855
Ref: #percentages77021
Node: Multicolumn balance report78158
Ref: #multicolumn-balance-report78338
Node: Budget report84076
Ref: #budget-report84219
Node: Nested budgets89485
Ref: #nested-budgets89597
Ref: #output-format-193078
Node: balancesheet93275
Ref: #balancesheet93411
Node: balancesheetequity94877
Ref: #balancesheetequity95026
Node: cashflow95749
Ref: #cashflow95877
Node: check-dates97056
Ref: #check-dates97183
Node: check-dupes97462
Ref: #check-dupes97586
Node: close97879
Ref: #close97987
Node: close usage99509
Ref: #close-usage99602
Node: codes102415
Ref: #codes102523
Node: commodities103235
Ref: #commodities103362
Node: descriptions103444
Ref: #descriptions103572
Node: diff103876
Ref: #diff103982
Node: files105029
Ref: #files105129
Node: help105276
Ref: #help105376
Node: import106457
Ref: #import106571
Node: Importing balance assignments107464
Ref: #importing-balance-assignments107612
Node: incomestatement108261
Ref: #incomestatement108394
Node: notes109881
Ref: #notes109994
Node: payees110362
Ref: #payees110468
Node: prices110888
Ref: #prices110994
Node: print111335
Ref: #print111445
Node: print-unique116241
Ref: #print-unique116367
Node: register116652
Ref: #register116779
Node: Custom register output120951
Ref: #custom-register-output121080
Node: register-match122417
Ref: #register-match122551
Node: rewrite122902
Ref: #rewrite123017
Node: Re-write rules in a file124872
Ref: #re-write-rules-in-a-file125006
Node: Diff output format126216
Ref: #diff-output-format126385
Node: rewrite vs print --auto127477
Ref: #rewrite-vs.-print---auto127656
Node: roi128212
Ref: #roi128310
Node: stats129322
Ref: #stats129421
Node: tags130209
Ref: #tags130307
Node: test130601
Ref: #test130709
Node: Add-on commands131456
Ref: #add-on-commands131573
Node: ui132916
Ref: #ui133004
Node: web133058
Ref: #web133161
Node: iadd133277
Ref: #iadd133388
Node: interest133470
Ref: #interest133577
Node: ENVIRONMENT133817
Ref: #environment133929
Node: FILES134758
Ref: #files-1134861
Node: LIMITATIONS135074
Ref: #limitations135193
Node: TROUBLESHOOTING135935
Ref: #troubleshooting136048

End Tag Table

View File

@ -2479,16 +2479,60 @@ COMMANDS
liabilities:pending 5 = 0
assets:checking
codes
codes
List the codes seen in transactions, in the order parsed.
This command prints the value of each transaction's code field, in the
order transactions were parsed. The transaction code is an optional
value written in parentheses between the date and description, often
used to store a cheque number, order number or similar.
Transactions aren't required to have a code, and missing or empty codes
will not be shown by default. With the -E/--empty flag, they will be
printed as blank lines.
You can add a query to select a subset of transactions.
Examples:
1/1 (123)
(a) 1
1/1 ()
(a) 1
1/1
(a) 1
1/1 (126)
(a) 1
$ hledger codes
123
124
126
$ hledger codes -E
123
124
126
commodities
commodities
List all commodity/currency symbols used or declared in the journal.
descriptions
descriptions Show descriptions.
descriptions
List the unique descriptions that appear in transactions.
This command lists all descriptions that appear in transactions.
This command lists the unique descriptions that appear in transactions,
in alphabetic order. You can add a query to select a subset of trans-
actions.
Examples:
Example:
$ hledger descriptions
Store Name
@ -2643,22 +2687,30 @@ COMMANDS
tal) json.
notes
notes Show notes.
notes
List the unique notes that appear in transactions.
This command lists all notes that appear in transactions.
This command lists the unique notes that appear in transactions, in al-
phabetic order. You can add a query to select a subset of transac-
tions. The note is the part of the transaction description after a |
character (or if there is no |, the whole description).
Examples:
Example:
$ hledger notes
Petrol
Snacks
payees
payees Show payee names.
payees
List the unique payee/payer names that appear in transactions.
This command lists all payee names that appear in transactions.
This command lists the unique payee/payer names that appear in transac-
tions, in alphabetic order. You can add a query to select a subset of
transactions. The payee/payer is the part of the transaction descrip-
tion before a | character (or if there is no |, the whole description).
Examples:
Example:
$ hledger payees
Store Name