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

;update manuals

Browse Source
This commit is contained in:
Simon Michael 2020-12-26 17:29:02 -08:00
parent cee1c69ac0
commit b66d8f0f3c
9 changed files with 1396 additions and 1416 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
hledger-ui/hledger-ui.1
View File

@ -183,10 +183,16 @@ Some reporting options can also be written as query arguments.
hledger help options: hledger help options:
.TP .TP
\f[B]\f[CB]-h --help\f[B]\f[R] \f[B]\f[CB]-h --help\f[B]\f[R]
show general usage (or after COMMAND, command usage) show general or COMMAND help
.TP
\f[B]\f[CB]--man\f[B]\f[R]
show general or COMMAND user manual with man
.TP
\f[B]\f[CB]--info\f[B]\f[R]
show general or COMMAND user manual with info
.TP .TP
\f[B]\f[CB]--version\f[B]\f[R] \f[B]\f[CB]--version\f[B]\f[R]
show version show general or ADDONCOMMAND version
.TP .TP
\f[B]\f[CB]--debug[=N]\f[B]\f[R] \f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)

46
hledger-ui/hledger-ui.info
View File

@ -197,10 +197,16 @@ the last one takes precedence.
'-h --help' '-h --help'
show general usage (or after COMMAND, command usage) show general or COMMAND help
'--man'
show general or COMMAND user manual with man
'--info'
show general or COMMAND user manual with info
'--version' '--version'
show version show general or ADDONCOMMAND version
'--debug[=N]' '--debug[=N]'
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
@ -522,23 +528,23 @@ Tag Table:
Node: Top71 Node: Top71
Node: OPTIONS1488 Node: OPTIONS1488
Ref: #options1585 Ref: #options1585
Node: KEYS5652 Node: KEYS5772
Ref: #keys5747 Ref: #keys5867
Node: SCREENS10066 Node: SCREENS10186
Ref: #screens10171 Ref: #screens10291
Node: Accounts screen10261 Node: Accounts screen10381
Ref: #accounts-screen10389 Ref: #accounts-screen10509
Node: Register screen12604 Node: Register screen12724
Ref: #register-screen12759 Ref: #register-screen12879
Node: Transaction screen14756 Node: Transaction screen14876
Ref: #transaction-screen14914 Ref: #transaction-screen15034
Node: Error screen15784 Node: Error screen15904
Ref: #error-screen15906 Ref: #error-screen16026
Node: ENVIRONMENT16150 Node: ENVIRONMENT16270
Ref: #environment16264 Ref: #environment16384
Node: FILES17071 Node: FILES17191
Ref: #files17170 Ref: #files17290
Node: BUGS17383 Node: BUGS17503
Ref: #bugs17460 Ref: #bugs17580
 
End Tag Table End Tag Table

8
hledger-ui/hledger-ui.txt
View File

@ -178,10 +178,14 @@ OPTIONS
hledger help options: hledger help options:
-h --help -h --help
show general usage (or after COMMAND, command usage) show general or COMMAND help
--man show general or COMMAND user manual with man
--info show general or COMMAND user manual with info
--version --version
show version show general or ADDONCOMMAND version
--debug[=N] --debug[=N]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)

10
hledger-web/hledger-web.1
View File

@ -212,10 +212,16 @@ Some reporting options can also be written as query arguments.
hledger help options: hledger help options:
.TP .TP
\f[B]\f[CB]-h --help\f[B]\f[R] \f[B]\f[CB]-h --help\f[B]\f[R]
show general usage (or after COMMAND, command usage) show general or COMMAND help
.TP
\f[B]\f[CB]--man\f[B]\f[R]
show general or COMMAND user manual with man
.TP
\f[B]\f[CB]--info\f[B]\f[R]
show general or COMMAND user manual with info
.TP .TP
\f[B]\f[CB]--version\f[B]\f[R] \f[B]\f[CB]--version\f[B]\f[R]
show version show general or ADDONCOMMAND version
.TP .TP
\f[B]\f[CB]--debug[=N]\f[B]\f[R] \f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)

38
hledger-web/hledger-web.info
View File

@ -225,10 +225,16 @@ the last one takes precedence.
'-h --help' '-h --help'
show general usage (or after COMMAND, command usage) show general or COMMAND help
'--man'
show general or COMMAND user manual with man
'--info'
show general or COMMAND user manual with info
'--version' '--version'
show version show general or ADDONCOMMAND version
'--debug[=N]' '--debug[=N]'
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
@ -592,19 +598,19 @@ Tag Table:
Node: Top72 Node: Top72
Node: OPTIONS1762 Node: OPTIONS1762
Ref: #options1867 Ref: #options1867
Node: PERMISSIONS8966 Node: PERMISSIONS9086
Ref: #permissions9105 Ref: #permissions9225
Node: EDITING UPLOADING DOWNLOADING10317 Node: EDITING UPLOADING DOWNLOADING10437
Ref: #editing-uploading-downloading10498 Ref: #editing-uploading-downloading10618
Node: RELOADING11332 Node: RELOADING11452
Ref: #reloading11466 Ref: #reloading11586
Node: JSON API11899 Node: JSON API12019
Ref: #json-api12013 Ref: #json-api12133
Node: ENVIRONMENT17503 Node: ENVIRONMENT17623
Ref: #environment17619 Ref: #environment17739
Node: FILES18352 Node: FILES18472
Ref: #files18452 Ref: #files18572
Node: BUGS18665 Node: BUGS18785
Ref: #bugs18743 Ref: #bugs18863
 
End Tag Table End Tag Table

8
hledger-web/hledger-web.txt
View File

@ -202,10 +202,14 @@ OPTIONS
hledger help options: hledger help options:
-h --help -h --help
show general usage (or after COMMAND, command usage) show general or COMMAND help
--man show general or COMMAND user manual with man
--info show general or COMMAND user manual with info
--version --version
show version show general or ADDONCOMMAND version
--debug[=N] --debug[=N]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)

91
hledger/hledger.1
View File

@ -6,8 +6,9 @@
.SH NAME .SH NAME
.PP .PP
hledger is a command-line accounting tool for both power users and folks This is the command-line interface (CLI) for the hledger accounting
new to accounting. tool.
Here we also describe hledger\[aq]s concepts and file formats.
This manual is for hledger 1.20.99. This manual is for hledger 1.20.99.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
@ -23,11 +24,10 @@ money, time, or any other commodity, using double-entry accounting and a
simple, editable file format. simple, editable file format.
hledger is inspired by and largely compatible with ledger(1). hledger is inspired by and largely compatible with ledger(1).
.PP .PP
This is hledger\[cq]s command-line interface (there are also terminal The basic function of the hledger CLI is to read a plain text file
and web interfaces). describing financial transactions (in accounting terms, a general
Its basic function is to read a plain text file describing financial journal) and print useful reports on standard output, or export them as
transactions (in accounting terms, a general journal) and print useful CSV.
reports on standard output, or export them as CSV.
hledger can also read some other file formats such as CSV files, hledger can also read some other file formats such as CSV files,
translating them to journal format. translating them to journal format.
Additionally, hledger lists other hledger-* executables found in the Additionally, hledger lists other hledger-* executables found in the
@ -75,10 +75,16 @@ by most hledger commands, run \f[C]hledger -h\f[R].
General help options: General help options:
.TP .TP
\f[B]\f[CB]-h --help\f[B]\f[R] \f[B]\f[CB]-h --help\f[B]\f[R]
show general usage (or after COMMAND, command usage) show general or COMMAND help
.TP
\f[B]\f[CB]--man\f[B]\f[R]
show general or COMMAND user manual with man
.TP
\f[B]\f[CB]--info\f[B]\f[R]
show general or COMMAND user manual with info
.TP .TP
\f[B]\f[CB]--version\f[B]\f[R] \f[B]\f[CB]--version\f[B]\f[R]
show version show general or ADDONCOMMAND version
.TP .TP
\f[B]\f[CB]--debug[=N]\f[B]\f[R] \f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
@ -2189,7 +2195,7 @@ AlphaVantage \f[I](experimental)\f[R]
Next, the detailed command docs, in alphabetical order. Next, the detailed command docs, in alphabetical order.
.SS accounts .SS accounts
.PP .PP
accounts, a accounts
.PD 0 .PD 0
.P .P
.PD .PD
@ -2408,7 +2414,7 @@ $ hledger areg assets date:jul
.fi .fi
.SS balance .SS balance
.PP .PP
balance, bal, b balance, bal
.PD 0 .PD 0
.P .P
.PD .PD
@ -3587,48 +3593,21 @@ help
.PD 0 .PD 0
.P .P
.PD .PD
Show any of the hledger manuals. Show the hledger user manual in one of several formats, optionally
positioned at a given TOPIC (if possible).
TOPIC is any heading, or heading prefix, in the manual.
Some examples: commands, print, \[aq]auto postings\[aq], periodic.
.PP .PP
The \f[C]help\f[R] command displays any of the main hledger manuals, in This command shows the user manual built in to this hledger version.
one of several ways. It can be useful if the correct version of the hledger manual, or the
Run it with no argument to list the manuals, or provide a full or usual viewing tools, are not installed on your system.
partial manual name to select one.
.PP .PP
hledger manuals are available in several formats. By default it uses the best viewer it can find in $PATH, in this order:
hledger help will use the first of these display methods that it finds: \f[C]info\f[R], \f[C]man\f[R], $PAGER (unless a topic is specified),
info, man, $PAGER, less, stdout (or when non-interactive, just stdout). \f[C]less\f[R], or stdout.
You can force a particular viewer with the \f[C]--info\f[R], When run non-interactively, it always uses stdout.
\f[C]--man\f[R], \f[C]--pager\f[R], \f[C]--cat\f[R] flags. Or you can select a particular viewer with the \f[C]-i\f[R] (info),
.PP \f[C]-m\f[R] (man), or \f[C]-p\f[R] (pager) flags.
Examples:
.IP
.nf
\f[C]
$ hledger help
Please choose a manual by typing \[dq]hledger help MANUAL\[dq] (a substring is ok).
Manuals: hledger hledger-ui hledger-web
\f[R]
.fi
.IP
.nf
\f[C]
$ hledger help h --man
hledger(1) hledger User Manuals hledger(1)
NAME
hledger - a command-line accounting tool
SYNOPSIS
hledger [-f FILE] COMMAND [OPTIONS] [ARGS]
hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]
hledger
DESCRIPTION
hledger is a cross-platform program for tracking money, time, or any
\&...
\f[R]
.fi
.SS import .SS import
.PP .PP
import import
@ -3802,7 +3781,7 @@ Prices (and postings providing prices) can be filtered by a query.
Price amounts are always displayed with their full precision. Price amounts are always displayed with their full precision.
.SS print .SS print
.PP .PP
print, txns, p print
.PD 0 .PD 0
.P .P
.PD .PD
@ -3959,7 +3938,7 @@ $ LEDGER_FILE=unique.journal hledger print-unique
.fi .fi
.SS register .SS register
.PP .PP
register, reg, r register, reg
.PD 0 .PD 0
.P .P
.PD .PD
@ -4735,10 +4714,8 @@ $ hledger web --serve
(because the \f[C]--serve\f[R] flag belongs to \f[C]hledger-web\f[R], (because the \f[C]--serve\f[R] flag belongs to \f[C]hledger-web\f[R],
not \f[C]hledger\f[R]). not \f[C]hledger\f[R]).
.PP .PP
The \f[C]-h/--help\f[R] and \f[C]--version\f[R] flags work without The \f[C]-h/--help\f[R] and \f[C]--version\f[R] flags don\[aq]t require
\f[C]--\f[R], with their position deciding which program they refer to. \f[C]--\f[R].
Eg \f[C]hledger -h web\f[R] shows hledger\[aq]s help,
\f[C]hledger web -h\f[R] shows hledger-web\[aq]s help.
.PP .PP
If you have any trouble with this, remember you can always run the If you have any trouble with this, remember you can always run the
add-on program directly, eg: add-on program directly, eg:

912
hledger/hledger.info
View File

@ -6,8 +6,9 @@ File: hledger.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger(1) hledger(1)
********** **********
hledger is a command-line accounting tool for both power users and folks This is the command-line interface (CLI) for the hledger accounting
new to accounting. This manual is for hledger 1.20.99. tool. Here we also describe hledger's concepts and file formats. This
manual is for hledger 1.20.99.
'hledger' 'hledger'
@ -20,8 +21,7 @@ money, time, or any other commodity, using double-entry accounting and a
simple, editable file format. hledger is inspired by and largely simple, editable file format. hledger is inspired by and largely
compatible with ledger(1). compatible with ledger(1).
This is hledger's command-line interface (there are also terminal and The basic function of the hledger CLI is to read a plain text file
web interfaces). Its basic function is to read a plain text file
describing financial transactions (in accounting terms, a general describing financial transactions (in accounting terms, a general
journal) and print useful reports on standard output, or export them as journal) and print useful reports on standard output, or export them as
CSV. hledger can also read some other file formats such as CSV files, CSV. hledger can also read some other file formats such as CSV files,
@ -103,10 +103,16 @@ by most hledger commands, run 'hledger -h'.
'-h --help' '-h --help'
show general usage (or after COMMAND, command usage) show general or COMMAND help
'--man'
show general or COMMAND user manual with man
'--info'
show general or COMMAND user manual with info
'--version' '--version'
show version show general or ADDONCOMMAND version
'--debug[=N]' '--debug[=N]'
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
@ -1730,7 +1736,7 @@ File: hledger.info, Node: accounts, Next: activity, Up: COMMANDS
10.1 accounts 10.1 accounts
============= =============
accounts, a accounts
Show account names. Show account names.
This command lists account names, either declared with account This command lists account names, either declared with account
@ -1924,7 +1930,7 @@ File: hledger.info, Node: balance, Next: balancesheet, Prev: aregister, Up:
10.5 balance 10.5 balance
============ ============
balance, bal, b balance, bal
Show accounts and their balances. Show accounts and their balances.
The balance command is hledger's most versatile command. Note, The balance command is hledger's most versatile command. Note,
@ -3021,38 +3027,20 @@ File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
========== ==========
help help
Show any of the hledger manuals. Show the hledger user manual in one of several formats, optionally
positioned at a given TOPIC (if possible). TOPIC is any heading, or
heading prefix, in the manual. Some examples: commands, print, 'auto
postings', periodic.
The 'help' command displays any of the main hledger manuals, in one This command shows the user manual built in to this hledger version.
of several ways. Run it with no argument to list the manuals, or It can be useful if the correct version of the hledger manual, or the
provide a full or partial manual name to select one. usual viewing tools, are not installed on your system.
hledger manuals are available in several formats. hledger help will By default it uses the best viewer it can find in $PATH, in this
use the first of these display methods that it finds: info, man, $PAGER, order: 'info', 'man', $PAGER (unless a topic is specified), 'less', or
less, stdout (or when non-interactive, just stdout). You can force a stdout. When run non-interactively, it always uses stdout. Or you can
particular viewer with the '--info', '--man', '--pager', '--cat' flags. select a particular viewer with the '-i' (info), '-m' (man), or '-p'
(pager) flags.
Examples:
$ hledger help
Please choose a manual by typing "hledger help MANUAL" (a substring is ok).
Manuals: hledger hledger-ui hledger-web
$ hledger help h --man
hledger(1) hledger User Manuals hledger(1)
NAME
hledger - a command-line accounting tool
SYNOPSIS
hledger [-f FILE] COMMAND [OPTIONS] [ARGS]
hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]
hledger
DESCRIPTION
hledger is a cross-platform program for tracking money, time, or any
...
 
File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: COMMANDS File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: COMMANDS
@ -3226,7 +3214,7 @@ File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMA
10.22 print 10.22 print
=========== ===========
print, txns, p print
Show transaction journal entries, sorted by date. Show transaction journal entries, sorted by date.
The print command displays full journal entries (transactions) from The print command displays full journal entries (transactions) from
@ -3356,7 +3344,7 @@ File: hledger.info, Node: register, Next: register-match, Prev: print-unique,
10.24 register 10.24 register
============== ==============
register, reg, r register, reg
Show postings and their running total. Show postings and their running total.
The register command displays matched postings, across all accounts, The register command displays matched postings, across all accounts,
@ -4012,9 +4000,7 @@ $ hledger web --serve
(because the '--serve' flag belongs to 'hledger-web', not 'hledger'). (because the '--serve' flag belongs to 'hledger-web', not 'hledger').
The '-h/--help' and '--version' flags work without '--', with their The '-h/--help' and '--version' flags don't require '--'.
position deciding which program they refer to. Eg 'hledger -h web'
shows hledger's help, 'hledger web -h' shows hledger-web's help.
If you have any trouble with this, remember you can always run the If you have any trouble with this, remember you can always run the
add-on program directly, eg: add-on program directly, eg:
@ -7846,425 +7832,425 @@ $ LANG=en_US.UTF-8 hledger -f my.journal print
 
Tag Table: Tag Table:
Node: Top68 Node: Top68
Node: OPTIONS2536 Node: OPTIONS2509
Ref: #options2637 Ref: #options2610
Node: General options2779 Node: General options2752
Ref: #general-options2904 Ref: #general-options2877
Node: Command options6305 Node: Command options6398
Ref: #command-options6456 Ref: #command-options6549
Node: Command arguments6856 Node: Command arguments6949
Ref: #command-arguments7014 Ref: #command-arguments7107
Node: Special characters7894 Node: Special characters7987
Ref: #special-characters8057 Ref: #special-characters8150
Node: Single escaping shell metacharacters8220 Node: Single escaping shell metacharacters8313
Ref: #single-escaping-shell-metacharacters8461 Ref: #single-escaping-shell-metacharacters8554
Node: Double escaping regular expression metacharacters8862 Node: Double escaping regular expression metacharacters8955
Ref: #double-escaping-regular-expression-metacharacters9173 Ref: #double-escaping-regular-expression-metacharacters9266
Node: Triple escaping for add-on commands9699 Node: Triple escaping for add-on commands9792
Ref: #triple-escaping-for-add-on-commands9959 Ref: #triple-escaping-for-add-on-commands10052
Node: Less escaping10603 Node: Less escaping10696
Ref: #less-escaping10757 Ref: #less-escaping10850
Node: Unicode characters11081 Node: Unicode characters11174
Ref: #unicode-characters11246 Ref: #unicode-characters11339
Node: Regular expressions12658 Node: Regular expressions12751
Ref: #regular-expressions12798 Ref: #regular-expressions12891
Node: ENVIRONMENT14534 Node: ENVIRONMENT14627
Ref: #environment14650 Ref: #environment14743
Node: DATA FILES15635 Node: DATA FILES15728
Ref: #data-files15754 Ref: #data-files15847
Node: Data formats16293 Node: Data formats16386
Ref: #data-formats16411 Ref: #data-formats16504
Node: Multiple files17748 Node: Multiple files17841
Ref: #multiple-files17890 Ref: #multiple-files17983
Node: Strict mode18359 Node: Strict mode18452
Ref: #strict-mode18474 Ref: #strict-mode18567
Node: TIME PERIODS19122 Node: TIME PERIODS19215
Ref: #time-periods19239 Ref: #time-periods19332
Node: Smart dates19337 Node: Smart dates19430
Ref: #smart-dates19463 Ref: #smart-dates19556
Node: Report start & end date20789 Node: Report start & end date20882
Ref: #report-start-end-date20964 Ref: #report-start-end-date21057
Node: Report intervals22497 Node: Report intervals22590
Ref: #report-intervals22665 Ref: #report-intervals22758
Node: Period expressions23055 Node: Period expressions23148
Ref: #period-expressions23195 Ref: #period-expressions23288
Node: DEPTH27638 Node: DEPTH27731
Ref: #depth27738 Ref: #depth27831
Node: QUERIES28070 Node: QUERIES28163
Ref: #queries28171 Ref: #queries28264
Node: VALUATION32133 Node: VALUATION32226
Ref: #valuation32241 Ref: #valuation32334
Node: -B Cost32930 Node: -B Cost33023
Ref: #b-cost33028 Ref: #b-cost33121
Node: -V Value33161 Node: -V Value33254
Ref: #v-value33301 Ref: #v-value33394
Node: -X Value in specified commodity33496 Node: -X Value in specified commodity33589
Ref: #x-value-in-specified-commodity33689 Ref: #x-value-in-specified-commodity33782
Node: Valuation date33838 Node: Valuation date33931
Ref: #valuation-date34000 Ref: #valuation-date34093
Node: Market prices34437 Node: Market prices34530
Ref: #market-prices34611 Ref: #market-prices34704
Node: --infer-value market prices from transactions35532 Node: --infer-value market prices from transactions35625
Ref: #infer-value-market-prices-from-transactions35775 Ref: #infer-value-market-prices-from-transactions35868
Node: Valuation commodity37036 Node: Valuation commodity37129
Ref: #valuation-commodity37239 Ref: #valuation-commodity37332
Node: Simple valuation examples38444 Node: Simple valuation examples38537
Ref: #simple-valuation-examples38640 Ref: #simple-valuation-examples38733
Node: --value Flexible valuation39299 Node: --value Flexible valuation39392
Ref: #value-flexible-valuation39501 Ref: #value-flexible-valuation39594
Node: More valuation examples41448 Node: More valuation examples41541
Ref: #more-valuation-examples41651 Ref: #more-valuation-examples41744
Node: Effect of valuation on reports43656 Node: Effect of valuation on reports43749
Ref: #effect-of-valuation-on-reports43838 Ref: #effect-of-valuation-on-reports43931
Node: PIVOTING50857 Node: PIVOTING50950
Ref: #pivoting50962 Ref: #pivoting51055
Node: OUTPUT52638 Node: OUTPUT52731
Ref: #output52738 Ref: #output52831
Node: Output destination52789 Node: Output destination52882
Ref: #output-destination52920 Ref: #output-destination53013
Node: Output format53345 Node: Output format53438
Ref: #output-format53466 Ref: #output-format53559
Node: COMMANDS55633 Node: COMMANDS55726
Ref: #commands55745 Ref: #commands55838
Node: accounts59110 Node: accounts59203
Ref: #accounts59210 Ref: #accounts59303
Node: activity59909 Node: activity59999
Ref: #activity60021 Ref: #activity60111
Node: add60404 Node: add60494
Ref: #add60507 Ref: #add60597
Node: aregister63300 Node: aregister63390
Ref: #aregister63414 Ref: #aregister63504
Node: aregister and custom posting dates64908 Node: aregister and custom posting dates64998
Ref: #aregister-and-custom-posting-dates65074 Ref: #aregister-and-custom-posting-dates65164
Node: balance65895 Node: balance65985
Ref: #balance66014 Ref: #balance66104
Node: Classic balance report67640 Node: Classic balance report67727
Ref: #classic-balance-report67815 Ref: #classic-balance-report67902
Node: Customising the classic balance report69139 Node: Customising the classic balance report69226
Ref: #customising-the-classic-balance-report69369 Ref: #customising-the-classic-balance-report69456
Node: Colour support71445 Node: Colour support71532
Ref: #colour-support71614 Ref: #colour-support71701
Node: Flat mode71710 Node: Flat mode71797
Ref: #flat-mode71860 Ref: #flat-mode71947
Node: Depth limited balance reports72273 Node: Depth limited balance reports72360
Ref: #depth-limited-balance-reports72460 Ref: #depth-limited-balance-reports72547
Node: Percentages72916 Node: Percentages73003
Ref: #percentages73075 Ref: #percentages73162
Node: Sorting by amount74212 Node: Sorting by amount74299
Ref: #sorting-by-amount74380 Ref: #sorting-by-amount74467
Node: Multicolumn balance report74874 Node: Multicolumn balance report74961
Ref: #multicolumn-balance-report75062 Ref: #multicolumn-balance-report75149
Node: Budget report80659 Node: Budget report80746
Ref: #budget-report80795 Ref: #budget-report80882
Node: Budget report start date86084 Node: Budget report start date86171
Ref: #budget-report-start-date86251 Ref: #budget-report-start-date86338
Node: Nested budgets87583 Node: Nested budgets87670
Ref: #nested-budgets87730 Ref: #nested-budgets87817
Node: balancesheet91170 Node: balancesheet91257
Ref: #balancesheet91308 Ref: #balancesheet91395
Node: balancesheetequity92945 Node: balancesheetequity93032
Ref: #balancesheetequity93096 Ref: #balancesheetequity93183
Node: cashflow94315 Node: cashflow94402
Ref: #cashflow94439 Ref: #cashflow94526
Node: check95773 Node: check95860
Ref: #check95878 Ref: #check95965
Node: Basic checks96483 Node: Basic checks96570
Ref: #basic-checks96601 Ref: #basic-checks96688
Node: Strict checks97094 Node: Strict checks97181
Ref: #strict-checks97235 Ref: #strict-checks97322
Node: Other checks97478 Node: Other checks97565
Ref: #other-checks97618 Ref: #other-checks97705
Node: Add-on checks97916 Node: Add-on checks98003
Ref: #add-on-checks98036 Ref: #add-on-checks98123
Node: close98489 Node: close98576
Ref: #close98593 Ref: #close98680
Node: close usage100115 Node: close usage100202
Ref: #close-usage100210 Ref: #close-usage100297
Node: codes103023 Node: codes103110
Ref: #codes103133 Ref: #codes103220
Node: commodities103845 Node: commodities103932
Ref: #commodities103974 Ref: #commodities104061
Node: descriptions104056 Node: descriptions104143
Ref: #descriptions104186 Ref: #descriptions104273
Node: diff104490 Node: diff104577
Ref: #diff104598 Ref: #diff104685
Node: files105645 Node: files105732
Ref: #files105747 Ref: #files105834
Node: help105894 Node: help105981
Ref: #help105996 Ref: #help106083
Node: import107047 Node: import106810
Ref: #import107163 Ref: #import106926
Node: Importing balance assignments108085 Node: Importing balance assignments107848
Ref: #importing-balance-assignments108268 Ref: #importing-balance-assignments108031
Node: Commodity display styles108917 Node: Commodity display styles108680
Ref: #commodity-display-styles109090 Ref: #commodity-display-styles108853
Node: incomestatement109219 Node: incomestatement108982
Ref: #incomestatement109354 Ref: #incomestatement109117
Node: notes110816 Node: notes110579
Ref: #notes110931 Ref: #notes110694
Node: payees111299 Node: payees111062
Ref: #payees111407 Ref: #payees111170
Node: prices111827 Node: prices111590
Ref: #prices111935 Ref: #prices111698
Node: print112276 Node: print112039
Ref: #print112388 Ref: #print112151
Node: print-unique117184 Node: print-unique116938
Ref: #print-unique117312 Ref: #print-unique117066
Node: register117597 Node: register117351
Ref: #register117726 Ref: #register117480
Node: Custom register output122175 Node: Custom register output121926
Ref: #custom-register-output122306 Ref: #custom-register-output122057
Node: register-match123643 Node: register-match123394
Ref: #register-match123779 Ref: #register-match123530
Node: rewrite124130 Node: rewrite123881
Ref: #rewrite124247 Ref: #rewrite123998
Node: Re-write rules in a file126153 Node: Re-write rules in a file125904
Ref: #re-write-rules-in-a-file126316 Ref: #re-write-rules-in-a-file126067
Node: Diff output format127465 Node: Diff output format127216
Ref: #diff-output-format127648 Ref: #diff-output-format127399
Node: rewrite vs print --auto128740 Node: rewrite vs print --auto128491
Ref: #rewrite-vs.-print---auto128900 Ref: #rewrite-vs.-print---auto128651
Node: roi129456 Node: roi129207
Ref: #roi129556 Ref: #roi129307
Node: stats141766 Node: stats141517
Ref: #stats141867 Ref: #stats141618
Node: tags142655 Node: tags142406
Ref: #tags142755 Ref: #tags142506
Node: test143274 Node: test143025
Ref: #test143390 Ref: #test143141
Node: About add-on commands144137 Node: About add-on commands143888
Ref: #about-add-on-commands144274 Ref: #about-add-on-commands144025
Node: JOURNAL FORMAT145548 Node: JOURNAL FORMAT145156
Ref: #journal-format145676 Ref: #journal-format145284
Node: Transactions147842 Node: Transactions147450
Ref: #transactions147957 Ref: #transactions147565
Node: Dates148971 Node: Dates148579
Ref: #dates149087 Ref: #dates148695
Node: Simple dates149152 Node: Simple dates148760
Ref: #simple-dates149272 Ref: #simple-dates148880
Node: Secondary dates149781 Node: Secondary dates149389
Ref: #secondary-dates149929 Ref: #secondary-dates149537
Node: Posting dates151265 Node: Posting dates150873
Ref: #posting-dates151388 Ref: #posting-dates150996
Node: Status152760 Node: Status152368
Ref: #status152877 Ref: #status152485
Node: Description154585 Node: Description154193
Ref: #description154715 Ref: #description154323
Node: Payee and note155035 Node: Payee and note154643
Ref: #payee-and-note155143 Ref: #payee-and-note154751
Node: Comments155478 Node: Comments155086
Ref: #comments155600 Ref: #comments155208
Node: Tags156794 Node: Tags156402
Ref: #tags-1156905 Ref: #tags-1156513
Node: Postings158298 Node: Postings157906
Ref: #postings158422 Ref: #postings158030
Node: Virtual postings159448 Node: Virtual postings159056
Ref: #virtual-postings159559 Ref: #virtual-postings159167
Node: Account names160864 Node: Account names160472
Ref: #account-names161001 Ref: #account-names160609
Node: Amounts161488 Node: Amounts161096
Ref: #amounts161623 Ref: #amounts161231
Node: Digit group marks162747 Node: Digit group marks162355
Ref: #digit-group-marks162892 Ref: #digit-group-marks162500
Node: Commodity display style163830 Node: Commodity display style163438
Ref: #commodity-display-style164004 Ref: #commodity-display-style163612
Node: Rounding165717 Node: Rounding165325
Ref: #rounding165835 Ref: #rounding165443
Node: Transaction prices166247 Node: Transaction prices165855
Ref: #transaction-prices166413 Ref: #transaction-prices166021
Node: Lot prices lot dates168844 Node: Lot prices lot dates168452
Ref: #lot-prices-lot-dates169027 Ref: #lot-prices-lot-dates168635
Node: Balance assertions169515 Node: Balance assertions169123
Ref: #balance-assertions169693 Ref: #balance-assertions169301
Node: Assertions and ordering170726 Node: Assertions and ordering170334
Ref: #assertions-and-ordering170908 Ref: #assertions-and-ordering170516
Node: Assertions and included files171608 Node: Assertions and included files171216
Ref: #assertions-and-included-files171845 Ref: #assertions-and-included-files171453
Node: Assertions and multiple -f options172178 Node: Assertions and multiple -f options171786
Ref: #assertions-and-multiple--f-options172428 Ref: #assertions-and-multiple--f-options172036
Node: Assertions and commodities172560 Node: Assertions and commodities172168
Ref: #assertions-and-commodities172786 Ref: #assertions-and-commodities172394
Node: Assertions and prices173943 Node: Assertions and prices173551
Ref: #assertions-and-prices174151 Ref: #assertions-and-prices173759
Node: Assertions and subaccounts174591 Node: Assertions and subaccounts174199
Ref: #assertions-and-subaccounts174814 Ref: #assertions-and-subaccounts174422
Node: Assertions and virtual postings175138 Node: Assertions and virtual postings174746
Ref: #assertions-and-virtual-postings175374 Ref: #assertions-and-virtual-postings174982
Node: Assertions and precision175516 Node: Assertions and precision175124
Ref: #assertions-and-precision175703 Ref: #assertions-and-precision175311
Node: Balance assignments175970 Node: Balance assignments175578
Ref: #balance-assignments176140 Ref: #balance-assignments175748
Node: Balance assignments and prices177304 Node: Balance assignments and prices176912
Ref: #balance-assignments-and-prices177470 Ref: #balance-assignments-and-prices177078
Node: Directives177694 Node: Directives177302
Ref: #directives177857 Ref: #directives177465
Node: Directives and multiple files183100 Node: Directives and multiple files182708
Ref: #directives-and-multiple-files183296 Ref: #directives-and-multiple-files182904
Node: Comment blocks183960 Node: Comment blocks183568
Ref: #comment-blocks184137 Ref: #comment-blocks183745
Node: Including other files184313 Node: Including other files183921
Ref: #including-other-files184487 Ref: #including-other-files184095
Node: Default year185411 Node: Default year185019
Ref: #default-year185574 Ref: #default-year185182
Node: Declaring commodities185981 Node: Declaring commodities185589
Ref: #declaring-commodities186158 Ref: #declaring-commodities185766
Node: Commodity error checking188002 Node: Commodity error checking187610
Ref: #commodity-error-checking188152 Ref: #commodity-error-checking187760
Node: Default commodity188409 Node: Default commodity188017
Ref: #default-commodity188589 Ref: #default-commodity188197
Node: Declaring market prices189478 Node: Declaring market prices189086
Ref: #declaring-market-prices189667 Ref: #declaring-market-prices189275
Node: Declaring accounts190524 Node: Declaring accounts190132
Ref: #declaring-accounts190704 Ref: #declaring-accounts190312
Node: Account error checking191906 Node: Account error checking191514
Ref: #account-error-checking192072 Ref: #account-error-checking191680
Node: Account comments193251 Node: Account comments192859
Ref: #account-comments193435 Ref: #account-comments193043
Node: Account subdirectives193859 Node: Account subdirectives193467
Ref: #account-subdirectives194044 Ref: #account-subdirectives193652
Node: Account types194357 Node: Account types193965
Ref: #account-types194531 Ref: #account-types194139
Node: Declaring account types195267 Node: Declaring account types194875
Ref: #declaring-account-types195446 Ref: #declaring-account-types195054
Node: Auto-detected account types196096 Node: Auto-detected account types195704
Ref: #auto-detected-account-types196337 Ref: #auto-detected-account-types195945
Node: Interference from auto-detected account types197234 Node: Interference from auto-detected account types196842
Ref: #interference-from-auto-detected-account-types197511 Ref: #interference-from-auto-detected-account-types197119
Node: Old account type syntax197994 Node: Old account type syntax197602
Ref: #old-account-type-syntax198191 Ref: #old-account-type-syntax197799
Node: Account display order198491 Node: Account display order198099
Ref: #account-display-order198651 Ref: #account-display-order198259
Node: Rewriting accounts199802 Node: Rewriting accounts199410
Ref: #rewriting-accounts199981 Ref: #rewriting-accounts199589
Node: Basic aliases200738 Node: Basic aliases200346
Ref: #basic-aliases200874 Ref: #basic-aliases200482
Node: Regex aliases201578 Node: Regex aliases201186
Ref: #regex-aliases201740 Ref: #regex-aliases201348
Node: Combining aliases202459 Node: Combining aliases202067
Ref: #combining-aliases202642 Ref: #combining-aliases202250
Node: Aliases and multiple files203918 Node: Aliases and multiple files203526
Ref: #aliases-and-multiple-files204117 Ref: #aliases-and-multiple-files203725
Node: end aliases204696 Node: end aliases204304
Ref: #end-aliases204843 Ref: #end-aliases204451
Node: Default parent account204944 Node: Default parent account204552
Ref: #default-parent-account205134 Ref: #default-parent-account204742
Node: Periodic transactions206018 Node: Periodic transactions205626
Ref: #periodic-transactions206201 Ref: #periodic-transactions205809
Node: Periodic rule syntax208118 Node: Periodic rule syntax207726
Ref: #periodic-rule-syntax208318 Ref: #periodic-rule-syntax207926
Node: Two spaces between period expression and description!209022 Node: Two spaces between period expression and description!208630
Ref: #two-spaces-between-period-expression-and-description209335 Ref: #two-spaces-between-period-expression-and-description208943
Node: Forecasting with periodic transactions210019 Node: Forecasting with periodic transactions209627
Ref: #forecasting-with-periodic-transactions210318 Ref: #forecasting-with-periodic-transactions209926
Node: Budgeting with periodic transactions212373 Node: Budgeting with periodic transactions211981
Ref: #budgeting-with-periodic-transactions212606 Ref: #budgeting-with-periodic-transactions212214
Node: Auto postings213015 Node: Auto postings212623
Ref: #auto-postings213151 Ref: #auto-postings212759
Node: Auto postings and multiple files215330 Node: Auto postings and multiple files214938
Ref: #auto-postings-and-multiple-files215528 Ref: #auto-postings-and-multiple-files215136
Node: Auto postings and dates215737 Node: Auto postings and dates215345
Ref: #auto-postings-and-dates216005 Ref: #auto-postings-and-dates215613
Node: Auto postings and transaction balancing / inferred amounts / balance assertions216180 Node: Auto postings and transaction balancing / inferred amounts / balance assertions215788
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions216525 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions216133
Node: Auto posting tags216867 Node: Auto posting tags216475
Ref: #auto-posting-tags217076 Ref: #auto-posting-tags216684
Node: CSV FORMAT217712 Node: CSV FORMAT217320
Ref: #csv-format217840 Ref: #csv-format217448
Node: Examples220426 Node: Examples220034
Ref: #examples220529 Ref: #examples220137
Node: Basic220737 Node: Basic220345
Ref: #basic220839 Ref: #basic220447
Node: Bank of Ireland221381 Node: Bank of Ireland220989
Ref: #bank-of-ireland221518 Ref: #bank-of-ireland221126
Node: Amazon222980 Node: Amazon222588
Ref: #amazon223100 Ref: #amazon222708
Node: Paypal224819 Node: Paypal224427
Ref: #paypal224915 Ref: #paypal224523
Node: CSV rules232559 Node: CSV rules232167
Ref: #csv-rules232677 Ref: #csv-rules232285
Node: skip232989 Node: skip232597
Ref: #skip233084 Ref: #skip232692
Node: fields233459 Node: fields233067
Ref: #fields233583 Ref: #fields233191
Node: Transaction field names234748 Node: Transaction field names234356
Ref: #transaction-field-names234910 Ref: #transaction-field-names234518
Node: Posting field names235021 Node: Posting field names234629
Ref: #posting-field-names235175 Ref: #posting-field-names234783
Node: field assignment237545 Node: field assignment237153
Ref: #field-assignment237690 Ref: #field-assignment237298
Node: separator238508 Node: separator238116
Ref: #separator238645 Ref: #separator238253
Node: if block239185 Node: if block238793
Ref: #if-block239312 Ref: #if-block238920
Node: Matching the whole record239713 Node: Matching the whole record239321
Ref: #matching-the-whole-record239890 Ref: #matching-the-whole-record239498
Node: Matching individual fields240694 Node: Matching individual fields240302
Ref: #matching-individual-fields240900 Ref: #matching-individual-fields240508
Node: Combining matchers241124 Node: Combining matchers240732
Ref: #combining-matchers241322 Ref: #combining-matchers240930
Node: Rules applied on successful match241635 Node: Rules applied on successful match241243
Ref: #rules-applied-on-successful-match241828 Ref: #rules-applied-on-successful-match241436
Node: if table242482 Node: if table242090
Ref: #if-table242603 Ref: #if-table242211
Node: end244341 Node: end243949
Ref: #end244455 Ref: #end244063
Node: date-format244679 Node: date-format244287
Ref: #date-format244813 Ref: #date-format244421
Node: decimal-mark245562 Node: decimal-mark245170
Ref: #decimal-mark245707 Ref: #decimal-mark245315
Node: newest-first246046 Node: newest-first245654
Ref: #newest-first246189 Ref: #newest-first245797
Node: include246872 Node: include246480
Ref: #include247005 Ref: #include246613
Node: balance-type247449 Node: balance-type247057
Ref: #balance-type247571 Ref: #balance-type247179
Node: Tips248271 Node: Tips247879
Ref: #tips248362 Ref: #tips247970
Node: Rapid feedback248618 Node: Rapid feedback248226
Ref: #rapid-feedback248737 Ref: #rapid-feedback248345
Node: Valid CSV249197 Node: Valid CSV248805
Ref: #valid-csv249329 Ref: #valid-csv248937
Node: File Extension249521 Node: File Extension249129
Ref: #file-extension249675 Ref: #file-extension249283
Node: Reading multiple CSV files250104 Node: Reading multiple CSV files249712
Ref: #reading-multiple-csv-files250291 Ref: #reading-multiple-csv-files249899
Node: Valid transactions250532 Node: Valid transactions250140
Ref: #valid-transactions250712 Ref: #valid-transactions250320
Node: Deduplicating importing251340 Node: Deduplicating importing250948
Ref: #deduplicating-importing251521 Ref: #deduplicating-importing251129
Node: Setting amounts252554 Node: Setting amounts252162
Ref: #setting-amounts252725 Ref: #setting-amounts252333
Node: Setting currency/commodity253712 Node: Setting currency/commodity253320
Ref: #setting-currencycommodity253906 Ref: #setting-currencycommodity253514
Node: Referencing other fields255080 Node: Referencing other fields254688
Ref: #referencing-other-fields255282 Ref: #referencing-other-fields254890
Node: How CSV rules are evaluated256179 Node: How CSV rules are evaluated255787
Ref: #how-csv-rules-are-evaluated256354 Ref: #how-csv-rules-are-evaluated255962
Node: TIMECLOCK FORMAT257805 Node: TIMECLOCK FORMAT257413
Ref: #timeclock-format257945 Ref: #timeclock-format257553
Node: TIMEDOT FORMAT260006 Node: TIMEDOT FORMAT259614
Ref: #timedot-format260144 Ref: #timedot-format259752
Node: COMMON TASKS264420 Node: COMMON TASKS264028
Ref: #common-tasks264549 Ref: #common-tasks264157
Node: Getting help264956 Node: Getting help264564
Ref: #getting-help265090 Ref: #getting-help264698
Node: Constructing command lines265643 Node: Constructing command lines265251
Ref: #constructing-command-lines265837 Ref: #constructing-command-lines265445
Node: Starting a journal file266534 Node: Starting a journal file266142
Ref: #starting-a-journal-file266734 Ref: #starting-a-journal-file266342
Node: Setting opening balances267922 Node: Setting opening balances267530
Ref: #setting-opening-balances268120 Ref: #setting-opening-balances267728
Node: Recording transactions271261 Node: Recording transactions270869
Ref: #recording-transactions271443 Ref: #recording-transactions271051
Node: Reconciling271999 Node: Reconciling271607
Ref: #reconciling272144 Ref: #reconciling271752
Node: Reporting274401 Node: Reporting274009
Ref: #reporting274543 Ref: #reporting274151
Node: Migrating to a new file278542 Node: Migrating to a new file278150
Ref: #migrating-to-a-new-file278692 Ref: #migrating-to-a-new-file278300
Node: LIMITATIONS278991 Node: LIMITATIONS278599
Ref: #limitations279119 Ref: #limitations278727
Node: TROUBLESHOOTING279862 Node: TROUBLESHOOTING279470
Ref: #troubleshooting279977 Ref: #troubleshooting279585
 
End Tag Table End Tag Table

77
hledger/hledger.txt
View File

@ -4,8 +4,9 @@ HLEDGER(1) hledger User Manuals HLEDGER(1)
NAME NAME
hledger is a command-line accounting tool for both power users and This is the command-line interface (CLI) for the hledger accounting
folks new to accounting. This manual is for hledger 1.20.99. tool. Here we also describe hledger's concepts and file formats. This
manual is for hledger 1.20.99.
SYNOPSIS SYNOPSIS
hledger hledger
@ -20,8 +21,7 @@ DESCRIPTION
a simple, editable file format. hledger is inspired by and largely a simple, editable file format. hledger is inspired by and largely
compatible with ledger(1). compatible with ledger(1).
This is hledger's command-line interface (there are also terminal and The basic function of the hledger CLI is to read a plain text file de-
web interfaces). Its basic function is to read a plain text file de-
scribing financial transactions (in accounting terms, a general jour- scribing financial transactions (in accounting terms, a general jour-
nal) and print useful reports on standard output, or export them as nal) and print useful reports on standard output, or export them as
CSV. hledger can also read some other file formats such as CSV files, CSV. hledger can also read some other file formats such as CSV files,
@ -63,10 +63,14 @@ OPTIONS
General help options: General help options:
-h --help -h --help
show general usage (or after COMMAND, command usage) show general or COMMAND help
--man show general or COMMAND user manual with man
--info show general or COMMAND user manual with info
--version --version
show version show general or ADDONCOMMAND version
--debug[=N] --debug[=N]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
@ -553,6 +557,7 @@ TIME PERIODS
Examples: Examples:
-b 2016/3/17 begin on St. Patrick's day 2016 -b 2016/3/17 begin on St. Patrick's day 2016
-e 12/1 end at the start of december 1st of the current year -e 12/1 end at the start of december 1st of the current year
(11/30 will be the last date included) (11/30 will be the last date included)
-b thismonth all transactions on or after the 1st of the current month -b thismonth all transactions on or after the 1st of the current month
@ -622,6 +627,8 @@ TIME PERIODS
-p "2009Q1" first quarter of 2009, -p "2009Q1" first quarter of 2009,
equivalent to "2009/1/1 to equivalent to "2009/1/1 to
2009/4/1" 2009/4/1"
-p "q4" fourth quarter of the cur- -p "q4" fourth quarter of the cur-
rent year rent year
@ -685,7 +692,6 @@ TIME PERIODS
each month each month
-p "every 11/05" yearly periods with boundaries on 5th of Nov -p "every 11/05" yearly periods with boundaries on 5th of Nov
-p "every 5th Nov" same -p "every 5th Nov" same
-p "every Nov 5th" same -p "every Nov 5th" same
Show historical balances at end of 15th each month (N is exclusive end Show historical balances at end of 15th each month (N is exclusive end
@ -1125,6 +1131,7 @@ VALUATION
posting cost value at re- value at value at re- value at posting cost value at re- value at value at re- value at
amounts port end or posting date port or jour- DATE/today amounts port end or posting date port or jour- DATE/today
today nal end today nal end
balance as- unchanged unchanged unchanged unchanged unchanged balance as- unchanged unchanged unchanged unchanged unchanged
ser- ser-
tions/as- tions/as-
@ -1191,8 +1198,6 @@ VALUATION
row aver- ages of dis- ages of dis- ported ages of dis- ages of dis- row aver- ages of dis- ages of dis- ported ages of dis- ages of dis-
ages (-T, played values played values played values played values ages (-T, played values played values played values played values
-A) -A)
column to- sums of dis- sums of dis- not sup- sums of dis- sums of dis- column to- sums of dis- sums of dis- not sup- sums of dis- sums of dis-
tals played values played values ported played values played values tals played values played values ported played values played values
grand to- sum, average sum, average not sup- sum, average sum, average grand to- sum, average sum, average not sup- sum, average sum, average
@ -1200,6 +1205,7 @@ VALUATION
average tals tals tals tals average tals tals tals tals
--cumulative is omitted to save space, it works like -H but with a zero --cumulative is omitted to save space, it works like -H but with a zero
starting balance. starting balance.
@ -1454,7 +1460,7 @@ COMMANDS
Next, the detailed command docs, in alphabetical order. Next, the detailed command docs, in alphabetical order.
accounts accounts
accounts, a accounts
Show account names. Show account names.
This command lists account names, either declared with account direc- This command lists account names, either declared with account direc-
@ -1629,7 +1635,7 @@ COMMANDS
$ hledger areg assets date:jul $ hledger areg assets date:jul
balance balance
balance, bal, b balance, bal
Show accounts and their balances. Show accounts and their balances.
The balance command is hledger's most versatile command. Note, despite The balance command is hledger's most versatile command. Note, despite
@ -2566,38 +2572,19 @@ COMMANDS
help help
help help
Show any of the hledger manuals. Show the hledger user manual in one of several formats, optionally po-
sitioned at a given TOPIC (if possible). TOPIC is any heading, or
heading prefix, in the manual. Some examples: commands, print, 'auto
postings', periodic.
The help command displays any of the main hledger manuals, in one of This command shows the user manual built in to this hledger version.
several ways. Run it with no argument to list the manuals, or provide It can be useful if the correct version of the hledger manual, or the
a full or partial manual name to select one. usual viewing tools, are not installed on your system.
hledger manuals are available in several formats. hledger help will By default it uses the best viewer it can find in $PATH, in this order:
use the first of these display methods that it finds: info, man, info, man, $PAGER (unless a topic is specified), less, or stdout. When
$PAGER, less, stdout (or when non-interactive, just stdout). You can run non-interactively, it always uses stdout. Or you can select a par-
force a particular viewer with the --info, --man, --pager, --cat flags. ticular viewer with the -i (info), -m (man), or -p (pager) flags.
Examples:
$ hledger help
Please choose a manual by typing "hledger help MANUAL" (a substring is ok).
Manuals: hledger hledger-ui hledger-web
$ hledger help h --man
hledger(1) hledger User Manuals hledger(1)
NAME
hledger - a command-line accounting tool
SYNOPSIS
hledger [-f FILE] COMMAND [OPTIONS] [ARGS]
hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]
hledger
DESCRIPTION
hledger is a cross-platform program for tracking money, time, or any
...
import import
import import
@ -2724,7 +2711,7 @@ COMMANDS
Price amounts are always displayed with their full precision. Price amounts are always displayed with their full precision.
print print
print, txns, p print
Show transaction journal entries, sorted by date. Show transaction journal entries, sorted by date.
The print command displays full journal entries (transactions) from the The print command displays full journal entries (transactions) from the
@ -2847,7 +2834,7 @@ COMMANDS
(acct:one) 1 (acct:one) 1
register register
register, reg, r register, reg
Show postings and their running total. Show postings and their running total.
The register command displays matched postings, across all accounts, in The register command displays matched postings, across all accounts, in
@ -3437,9 +3424,7 @@ COMMANDS
(because the --serve flag belongs to hledger-web, not hledger). (because the --serve flag belongs to hledger-web, not hledger).
The -h/--help and --version flags work without --, with their position The -h/--help and --version flags don't require --.
deciding which program they refer to. Eg hledger -h web shows
hledger's help, hledger web -h shows hledger-web's help.
If you have any trouble with this, remember you can always run the add- If you have any trouble with this, remember you can always run the add-
on program directly, eg: on program directly, eg: