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

doc: update generated manuals

Browse Source
This commit is contained in:
Simon Michael 2016-07-06 15:17:09 -07:00
parent 1953748972
commit 9ccd4e226f
12 changed files with 206 additions and 188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
hledger-api/doc/hledger-api.1
View File

@ -91,8 +91,8 @@ show version
.RS
.RE
.TP
.B \f[C]\-\-debug=N\f[]
show debug output if N is 1\-9 (default: 0)
.B \f[C]\-\-debug[=N]\f[]
show debug output (levels 1\-9, default: 1)
.RS
.RE
.TP
@ -112,7 +112,7 @@ display accounts named OLD as NEW
.RS
.RE
.TP
.B \f[C]\-\-ignore\-assertions\f[]
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
ignore any failing balance assertions in the journal
.RS
.RE

6
hledger-api/doc/hledger-api.1.info
View File

@ -65,8 +65,8 @@ before options as shown above.
`--version'
show version
`--debug=N'
show debug output if N is 1-9 (default: 0)
`--debug[=N]'
show debug output (levels 1-9, default: 1)
`-f FILE --file=FILE'
use a different input file. For stdin, use -
@ -77,7 +77,7 @@ before options as shown above.
`--alias=OLD=NEW'
display accounts named OLD as NEW
`--ignore-assertions'
`-I --ignore-assertions'
ignore any failing balance assertions in the journal

6
hledger-api/doc/hledger-api.1.txt
View File

@ -62,8 +62,8 @@ OPTIONS
--version
show version
--debug=N
show debug output if N is 1-9 (default: 0)
--debug[=N]
show debug output (levels 1-9, default: 1)
-f FILE --file=FILE
use a different input file. For stdin, use -
@ -75,7 +75,7 @@ OPTIONS
--alias=OLD=NEW
display accounts named OLD as NEW
--ignore-assertions
-I --ignore-assertions
ignore any failing balance assertions in the journal
ENVIRONMENT

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

@ -93,8 +93,8 @@ show version
.RS
.RE
.TP
.B \f[C]\-\-debug=N\f[]
show debug output if N is 1\-9 (default: 0)
.B \f[C]\-\-debug[=N]\f[]
show debug output (levels 1\-9, default: 1)
.RS
.RE
.TP
@ -114,7 +114,7 @@ display accounts named OLD as NEW
.RS
.RE
.TP
.B \f[C]\-\-ignore\-assertions\f[]
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
ignore any failing balance assertions in the journal
.RS
.RE
@ -228,6 +228,9 @@ deeper, \f[C]left\f[] returns to the previous screen,
move up and down through lists.
Vi\-style \f[C]h\f[]/\f[C]j\f[]/\f[C]k\f[]/\f[C]l\f[] movement keys are
also supported.
A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust that.
(On a mac, the Karabiner app is one way to do that).
.PP
\f[C]/\f[] lets you set or change the filter query, which limits the
data shown on most screens (in addition to the quick filters described
@ -246,6 +249,10 @@ Or, it cancels a minibuffer edit or help dialog if one is active.
and any previous screens.
(With large files, there can be a noticeable pause.)
.PP
\f[C]I\f[] toggles balance assertion checking.
Disabling balance assertions temporarily can be useful for
troubleshooting.
.PP
\f[C]a\f[] runs command\-line hledger\[aq]s add command, and reloads the
updated file.
This allows some basic data entry.

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

@ -71,8 +71,8 @@ the data.
`--version'
show version
`--debug=N'
show debug output if N is 1-9 (default: 0)
`--debug[=N]'
show debug output (levels 1-9, default: 1)
`-f FILE --file=FILE'
use a different input file. For stdin, use -
@ -83,7 +83,7 @@ the data.
`--alias=OLD=NEW'
display accounts named OLD as NEW
`--ignore-assertions'
`-I --ignore-assertions'
ignore any failing balance assertions in the journal
hledger reporting options:
@ -159,7 +159,9 @@ again (or `ESCAPE', or `LEFT') to close it.
The cursor keys navigate: `right' (or `enter') goes deeper, `left'
returns to the previous screen, `up'/`down'/`page up'/`page
down'/`home'/`end' move up and down through lists. Vi-style
`h'/`j'/`k'/`l' movement keys are also supported.
`h'/`j'/`k'/`l' movement keys are also supported. A tip: movement speed
is limited by your keyboard repeat rate, to move faster you may want to
adjust that. (On a mac, the Karabiner app is one way to do that).
`/' lets you set or change the filter query, which limits the data
shown on most screens (in addition to the quick filters described
@ -177,6 +179,9 @@ active.
any previous screens. (With large files, there can be a noticeable
pause.)
`I' toggles balance assertion checking. Disabling balance assertions
temporarily can be useful for troubleshooting.
`a' runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry.
@ -333,17 +338,17 @@ Tag Table:
Node: Top88
Node: OPTIONS825
Ref: #options924
Node: KEYS3800
Ref: #keys3897
Node: SCREENS5506
Ref: #screens5593
Node: Accounts screen5683
Ref: #accounts-screen5813
Node: Register screen7118
Ref: #register-screen7275
Node: Transaction screen9096
Ref: #transaction-screen9256
Node: Error screen10123
Ref: #error-screen10247
Node: KEYS3805
Ref: #keys3902
Node: SCREENS5791
Ref: #screens5878
Node: Accounts screen5968
Ref: #accounts-screen6098
Node: Register screen7403
Ref: #register-screen7560
Node: Transaction screen9381
Ref: #transaction-screen9541
Node: Error screen10408
Ref: #error-screen10532

End Tag Table

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

@ -64,8 +64,8 @@ OPTIONS
--version
show version
--debug=N
show debug output if N is 1-9 (default: 0)
--debug[=N]
show debug output (levels 1-9, default: 1)
-f FILE --file=FILE
use a different input file. For stdin, use -
@ -77,7 +77,7 @@ OPTIONS
--alias=OLD=NEW
display accounts named OLD as NEW
--ignore-assertions
-I --ignore-assertions
ignore any failing balance assertions in the journal
hledger reporting options:
@ -148,6 +148,9 @@ KEYS
The cursor keys navigate: right (or enter) goes deeper, left returns to
the previous screen, up/down/page up/page down/home/end move up and
down through lists. Vi-style h/j/k/l movement keys are also supported.
A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust that. (On a mac, the Karabiner app is
one way to do that).
/ lets you set or change the filter query, which limits the data shown
on most screens (in addition to the quick filters described below).
@ -164,13 +167,16 @@ KEYS
g reloads from the data file(s) and updates the current screen and any
previous screens. (With large files, there can be a noticeable pause.)
a runs command-line hledger's add command, and reloads the updated
I toggles balance assertion checking. Disabling balance assertions
temporarily can be useful for troubleshooting.
a runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry.
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac-
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac-
sclient -a "" -nw) on the journal file. With some editors (emacs, vi),
the cursor will be positioned at the current transaction when invoked
from the register and transaction screens, and at the error location
the cursor will be positioned at the current transaction when invoked
from the register and transaction screens, and at the error location
(if possible) when invoked from the error screen.
q quits the application.
@ -179,31 +185,31 @@ KEYS
SCREENS
Accounts screen
This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances. if you specify a query
on the command line, it shows just the matched accounts and the bal-
This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances. if you specify a query
on the command line, it shows just the matched accounts and the bal-
ances from matched transactions.
Account names are normally indented to show the hierarchy (tree mode).
Account names are normally indented to show the hierarchy (tree mode).
To see less detail, set a depth limit by pressing a number key, 1 to 9.
0 shows even less detail, collapsing all accounts to a single total. -
and + (or =) decrease and increase the depth limit. To remove the
depth limit, set it higher than the maximum account depth, or press
and + (or =) decrease and increase the depth limit. To remove the
depth limit, set it higher than the maximum account depth, or press
ESCAPE.
F toggles flat mode on and off. In flat mode, accounts are listed
without indentation (and account registers will exclude subaccounts,
F toggles flat mode on and off. In flat mode, accounts are listed
without indentation (and account registers will exclude subaccounts,
see below).
C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared
C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared
transactions/postings are shown.
R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line
Z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line
hledger).
Press right or enter to view an account's transactions register.
@ -212,15 +218,15 @@ SCREENS
This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows:
o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected
o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected
by real postings.)
o the overall change to the current account's balance; positive for an
o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow.
o the current account's historic balance (if no query other than a date
limit is in effect) or the running total starting from zero (other-
limit is in effect) or the running total starting from zero (other-
wise), after the transaction.
Eg, these will show historic balances:
@ -235,45 +241,45 @@ SCREENS
$ hledger-ui --begin 'this month' desc:market
$ hledger-ui --register checking --cleared
Normally the register screen shows transactions in the current account
and any of its subaccounts (inclusive mode). If it was entered from
accounts screen in flat mode, it shows transactions affecting this
Normally the register screen shows transactions in the current account
and any of its subaccounts (inclusive mode). If it was entered from
accounts screen in flat mode, it shows transactions affecting this
account specifically, without considering subaccounts (exclusive mode).
As on the accounts screen you can toggle this with the F key.
C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared
C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared
transactions/postings are shown.
R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com-
Z toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger).
Press right (or enter) to view the selected transaction in detail.
Transaction screen
This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour-
This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour-
nal(5)).
The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more
The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more
(or in certain cases, fewer).
up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary
up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary
depending on which account register you came from (remember most trans-
actions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload).
Error screen
This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem, press g
This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem, press g
again to reload and resume normal operation. (Or, you can press escape
to cancel the reload attempt.)
@ -281,17 +287,17 @@ ENVIRONMENT
COLUMNS The screen width to use. Default: the full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FILES
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BUGS
The need to precede options with -- when invoked from hledger is awk-
The need to precede options with -- when invoked from hledger is awk-
ward.
-f- doesn't work (hledger-ui can't read from stdin).
@ -302,14 +308,14 @@ BUGS
which may cause a noticeable pause. Also there is no visual indication
that this is in progress.
The register screen's switching between historic balance and running
The register screen's switching between historic balance and running
total based on query arguments may be confusing, and there is no column
heading to indicate which is being displayed.
REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list)
@ -323,7 +329,7 @@ COPYRIGHT
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1)

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

@ -144,8 +144,8 @@ show version
.RS
.RE
.TP
.B \f[C]\-\-debug=N\f[]
show debug output if N is 1\-9 (default: 0)
.B \f[C]\-\-debug[=N]\f[]
show debug output (levels 1\-9, default: 1)
.RS
.RE
.TP
@ -165,7 +165,7 @@ display accounts named OLD as NEW
.RS
.RE
.TP
.B \f[C]\-\-ignore\-assertions\f[]
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
ignore any failing balance assertions in the journal
.RS
.RE

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

@ -111,8 +111,8 @@ before options as shown above.
`--version'
show version
`--debug=N'
show debug output if N is 1-9 (default: 0)
`--debug[=N]'
show debug output (levels 1-9, default: 1)
`-f FILE --file=FILE'
use a different input file. For stdin, use -
@ -123,7 +123,7 @@ before options as shown above.
`--alias=OLD=NEW'
display accounts named OLD as NEW
`--ignore-assertions'
`-I --ignore-assertions'
ignore any failing balance assertions in the journal
hledger reporting options:

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

@ -108,8 +108,8 @@ OPTIONS
--version
show version
--debug=N
show debug output if N is 1-9 (default: 0)
--debug[=N]
show debug output (levels 1-9, default: 1)
-f FILE --file=FILE
use a different input file. For stdin, use -
@ -121,7 +121,7 @@ OPTIONS
--alias=OLD=NEW
display accounts named OLD as NEW
--ignore-assertions
-I --ignore-assertions
ignore any failing balance assertions in the journal
hledger reporting options:

8
hledger/doc/hledger.1
View File

@ -235,7 +235,7 @@ if needed, also add a backslash to escape regexp metacharacters
.IP \[bu] 2
run add\-on executables directly
.PP
If you\[aq]re really curious, add \f[C]\-\-debug\ 2\f[] for
If you\[aq]re really curious, add \f[C]\-\-debug=2\f[] for
troubleshooting.
.PP
\f[B]General options:\f[]
@ -266,8 +266,8 @@ show version
.RS
.RE
.TP
.B \f[C]\-\-debug=N\f[]
show debug output if N is 1\-9 (default: 0)
.B \f[C]\-\-debug[=N]\f[]
show debug output (levels 1\-9, default: 1)
.RS
.RE
.TP
@ -287,7 +287,7 @@ display accounts named OLD as NEW
.RS
.RE
.TP
.B \f[C]\-\-ignore\-assertions\f[]
.B \f[C]\-I\ \-\-ignore\-assertions\f[]
ignore any failing balance assertions in the journal
.RS
.RE

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

@ -193,7 +193,7 @@ cur:\\\\$'.
* run add-on executables directly
If you're really curious, add `--debug 2' for troubleshooting.
If you're really curious, add `--debug=2' for troubleshooting.
*General options:*
@ -213,8 +213,8 @@ cur:\\\\$'.
`--version'
show version
`--debug=N'
show debug output if N is 1-9 (default: 0)
`--debug[=N]'
show debug output (levels 1-9, default: 1)
`-f FILE --file=FILE'
use a different input file. For stdin, use -
@ -225,7 +225,7 @@ cur:\\\\$'.
`--alias=OLD=NEW'
display accounts named OLD as NEW
`--ignore-assertions'
`-I --ignore-assertions'
ignore any failing balance assertions in the journal
*Common reporting options:*
@ -2079,95 +2079,95 @@ Node: EXAMPLES1875
Ref: #examples1977
Node: OPTIONS3981
Ref: #options4085
Node: Multiple files8956
Ref: #multiple-files9081
Node: Repeated options9346
Ref: #repeated-options9498
Node: Depth limiting9618
Ref: #depth-limiting9763
Node: Smart dates9964
Ref: #smart-dates10105
Node: Reporting interval11102
Ref: #reporting-interval11261
Node: Period expressions11604
Ref: #period-expressions11771
Node: Regular Expressions13817
Ref: #regular-expressions13959
Node: QUERIES15442
Ref: #queries15546
Node: COMMANDS18848
Ref: #commands18962
Node: accounts19635
Ref: #accounts19735
Node: activity20717
Ref: #activity20829
Node: add21188
Ref: #add21289
Node: balance23948
Ref: #balance24061
Node: Flat mode26777
Ref: #flat-mode26904
Node: Depth limited balance reports27323
Ref: #depth-limited-balance-reports27526
Node: Multicolumn balance reports27947
Ref: #multicolumn-balance-reports28149
Node: Market value32798
Ref: #market-value32962
Node: Custom balance output33455
Ref: #custom-balance-output33628
Node: Output destination35732
Ref: #output-destination35897
Node: CSV output36167
Ref: #csv-output36286
Node: balancesheet36683
Ref: #balancesheet36811
Node: cashflow37463
Ref: #cashflow37580
Node: help38270
Ref: #help38382
Node: incomestatement39219
Ref: #incomestatement39349
Node: info40076
Ref: #info40183
Node: man40545
Ref: #man40642
Node: print41045
Ref: #print41150
Node: register42501
Ref: #register42614
Node: Custom register output46955
Ref: #custom-register-output47086
Node: stats48383
Ref: #stats48489
Node: test49370
Ref: #test49457
Node: ADD-ON COMMANDS49824
Ref: #add-on-commands49960
Node: api51248
Ref: #api51340
Node: autosync51374
Ref: #autosync51489
Node: diff53804
Ref: #diff53914
Node: equity54578
Ref: #equity54692
Node: interest56020
Ref: #interest56137
Node: irr59221
Ref: #irr59334
Node: print-unique61709
Ref: #print-unique61839
Node: rewrite62097
Ref: #rewrite62216
Node: ui62745
Ref: #ui62845
Node: web62886
Ref: #web62974
Node: TROUBLESHOOTING63007
Ref: #troubleshooting63126
Node: Run-time problems63180
Ref: #run-time-problems63323
Node: Known limitations65267
Ref: #known-limitations65410
Node: Multiple files8961
Ref: #multiple-files9086
Node: Repeated options9351
Ref: #repeated-options9503
Node: Depth limiting9623
Ref: #depth-limiting9768
Node: Smart dates9969
Ref: #smart-dates10110
Node: Reporting interval11107
Ref: #reporting-interval11266
Node: Period expressions11609
Ref: #period-expressions11776
Node: Regular Expressions13822
Ref: #regular-expressions13964
Node: QUERIES15447
Ref: #queries15551
Node: COMMANDS18853
Ref: #commands18967
Node: accounts19640
Ref: #accounts19740
Node: activity20722
Ref: #activity20834
Node: add21193
Ref: #add21294
Node: balance23953
Ref: #balance24066
Node: Flat mode26782
Ref: #flat-mode26909
Node: Depth limited balance reports27328
Ref: #depth-limited-balance-reports27531
Node: Multicolumn balance reports27952
Ref: #multicolumn-balance-reports28154
Node: Market value32803
Ref: #market-value32967
Node: Custom balance output33460
Ref: #custom-balance-output33633
Node: Output destination35737
Ref: #output-destination35902
Node: CSV output36172
Ref: #csv-output36291
Node: balancesheet36688
Ref: #balancesheet36816
Node: cashflow37468
Ref: #cashflow37585
Node: help38275
Ref: #help38387
Node: incomestatement39224
Ref: #incomestatement39354
Node: info40081
Ref: #info40188
Node: man40550
Ref: #man40647
Node: print41050
Ref: #print41155
Node: register42506
Ref: #register42619
Node: Custom register output46960
Ref: #custom-register-output47091
Node: stats48388
Ref: #stats48494
Node: test49375
Ref: #test49462
Node: ADD-ON COMMANDS49829
Ref: #add-on-commands49965
Node: api51253
Ref: #api51345
Node: autosync51379
Ref: #autosync51494
Node: diff53809
Ref: #diff53919
Node: equity54583
Ref: #equity54697
Node: interest56025
Ref: #interest56142
Node: irr59226
Ref: #irr59339
Node: print-unique61714
Ref: #print-unique61844
Node: rewrite62102
Ref: #rewrite62221
Node: ui62750
Ref: #ui62850
Node: web62891
Ref: #web62979
Node: TROUBLESHOOTING63012
Ref: #troubleshooting63131
Node: Run-time problems63185
Ref: #run-time-problems63328
Node: Known limitations65272
Ref: #known-limitations65415

End Tag Table

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

@ -175,7 +175,7 @@ OPTIONS
o run add-on executables directly
If you're really curious, add --debug 2 for troubleshooting.
If you're really curious, add --debug=2 for troubleshooting.
General options:
@ -191,8 +191,8 @@ OPTIONS
--version
show version
--debug=N
show debug output if N is 1-9 (default: 0)
--debug[=N]
show debug output (levels 1-9, default: 1)
-f FILE --file=FILE
use a different input file. For stdin, use -
@ -204,7 +204,7 @@ OPTIONS
--alias=OLD=NEW
display accounts named OLD as NEW
--ignore-assertions
-I --ignore-assertions
ignore any failing balance assertions in the journal
Common reporting options: