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-08-09 15:32:32 -07:00
parent 79cc999fa3
commit f1ac27590b
6 changed files with 162 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -234,11 +234,13 @@ While editing the query you can use typical command\-line edit keys
(CTRL\-a/e/d/k, cursor keys etc.), and \f[C]ENTER\f[]to set the new (CTRL\-a/e/d/k, cursor keys etc.), and \f[C]ENTER\f[]to set the new
filter or \f[C]ESCAPE\f[]to cancel. filter or \f[C]ESCAPE\f[]to cancel.
.PP .PP
\f[C]d\f[] cycles through the common report period durations: day, week, \f[C]t\f[] sets the report period to today, while \f[C]d\f[] and
month, quarter, year, and unlimited (the default). \f[C]u\f[] cycle downward and upward through standard report periods \-
When the report duration is limited in this way, \f[C]n\f[] and day, week, month, quarter, year, and unlimited.
\f[C]p\f[] step to the next or previous day/week/month/etc. This is useful on the register screen, to limit the transaction history.
(To set arbitrary start/end dates, you can use \f[C]/\f[] to set a When a standard report period is selected in this way, \f[C]n\f[] and
\f[C]p\f[] step to the next or previous period.
(For non\-standard periods, you can use \f[C]/\f[] to set a
\f[C]date:\f[] query.) \f[C]date:\f[] query.)
.PP .PP
\f[C]BACKSPACE\f[] or \f[C]DELETE\f[] clears any filters in effect. \f[C]BACKSPACE\f[] or \f[C]DELETE\f[] clears any filters in effect.

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

@ -166,11 +166,12 @@ described below). While editing the query you can use typical
command-line edit keys (CTRL-a/e/d/k, cursor keys etc.), and `ENTER'to command-line edit keys (CTRL-a/e/d/k, cursor keys etc.), and `ENTER'to
set the new filter or `ESCAPE'to cancel. set the new filter or `ESCAPE'to cancel.
`d' cycles through the common report period durations: day, week, `t' sets the report period to today, while `d' and `u' cycle
month, quarter, year, and unlimited (the default). When the report downward and upward through standard report periods - day, week, month,
duration is limited in this way, `n' and `p' step to the next or quarter, year, and unlimited. This is useful on the register screen, to
previous day/week/month/etc. (To set arbitrary start/end dates, you can limit the transaction history. When a standard report period is
use `/' to set a `date:' query.) selected in this way, `n' and `p' step to the next or previous period.
(For non-standard periods, you can use `/' to set a `date:' query.)
`BACKSPACE' or `DELETE' clears any filters in effect. `BACKSPACE' or `DELETE' clears any filters in effect.
@ -346,15 +347,15 @@ Node: OPTIONS831
Ref: #options930 Ref: #options930
Node: KEYS3743 Node: KEYS3743
Ref: #keys3840 Ref: #keys3840
Node: SCREENS6052 Node: SCREENS6157
Ref: #screens6139 Ref: #screens6244
Node: Accounts screen6229 Node: Accounts screen6334
Ref: #accounts-screen6359 Ref: #accounts-screen6464
Node: Register screen7825 Node: Register screen7930
Ref: #register-screen7982 Ref: #register-screen8087
Node: Transaction screen9942 Node: Transaction screen10047
Ref: #transaction-screen10102 Ref: #transaction-screen10207
Node: Error screen10969 Node: Error screen11074
Ref: #error-screen11093 Ref: #error-screen11198
 
End Tag Table End Tag Table

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

@ -155,31 +155,32 @@ KEYS
mand-line edit keys (CTRL-a/e/d/k, cursor keys etc.), and ENTERto set mand-line edit keys (CTRL-a/e/d/k, cursor keys etc.), and ENTERto set
the new filter or ESCAPEto cancel. the new filter or ESCAPEto cancel.
d cycles through the common report period durations: day, week, month, t sets the report period to today, while d and u cycle downward and
quarter, year, and unlimited (the default). When the report duration upward through standard report periods - day, week, month, quarter,
is limited in this way, n and p step to the next or previous year, and unlimited. This is useful on the register screen, to limit
day/week/month/etc. (To set arbitrary start/end dates, you can use / the transaction history. When a standard report period is selected in
to set a date: query.) this way, n and p step to the next or previous period. (For non-stan-
dard periods, you can use / to set a date: query.)
BACKSPACE or DELETE clears any filters in effect. BACKSPACE or DELETE clears any filters in effect.
ESCAPE removes any filters currently in effect, and jumps to the top ESCAPE removes any filters currently in effect, and jumps to the top
screen. Or, it cancels a minibuffer edit or help dialog if one is screen. Or, it cancels a minibuffer edit or help dialog if one is
active. active.
g reloads from the data file(s) and updates the current screen and any 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.) previous screens. (With large files, there can be a noticeable pause.)
I toggles balance assertion checking. Disabling balance assertions I toggles balance assertion checking. Disabling balance assertions
temporarily can be useful for troubleshooting. temporarily can be useful for troubleshooting.
a runs command-line hledger's add command, and reloads the updated a runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry. 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), sclient -a "" -nw) on the journal file. With some editors (emacs, vi),
the cursor will be positioned at the current transaction when invoked the cursor will be positioned at the current transaction when invoked
from the register and transaction screens, and at the error location from the register and transaction screens, and at the error location
(if possible) when invoked from the error screen. (if possible) when invoked from the error screen.
q quits the application. q quits the application.
@ -188,32 +189,32 @@ KEYS
SCREENS SCREENS
Accounts screen Accounts screen
This is normally the first screen displayed. It lists accounts and This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances (including the balances all accounts and their latest ending balances (including the balances
of subaccounts). if you specify a query on the command line, it shows of subaccounts). if you specify a query on the command line, it shows
just the matched accounts and the balances from matched transactions. just the matched accounts and the balances 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. 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. - 0 shows even less detail, collapsing all accounts to a single total. -
and + (or =) decrease and increase the depth limit. To remove the and + (or =) decrease and increase the depth limit. To remove the
depth limit, set it higher than the maximum account depth, or press depth limit, set it higher than the maximum account depth, or press
ESCAPE. ESCAPE.
F toggles flat mode on and off. In flat mode, accounts are listed F toggles flat mode on and off. In flat mode, accounts are listed
without indentation, and show their subaccount-excluding balances, without indentation, and show their subaccount-excluding balances,
except for accounts which have been clipped by a depth limit, which except for accounts which have been clipped by a depth limit, which
show their inclusive balances (as with hledger's balance command). show their inclusive balances (as with hledger's balance command).
C toggles cleared mode, in which uncleared transactions and postings C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared are not shown. U toggles uncleared mode, in which only uncleared
transactions/postings are shown. transactions/postings are shown.
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only accounts with nonzero balances Z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line are shown (hledger-ui shows zero items by default, unlike command-line
hledger). hledger).
Press right or enter to view an account's transactions register. Press right or enter to view an account's transactions register.
@ -222,15 +223,15 @@ SCREENS
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows: a check register. Each line represents one transaction and shows:
o the other account(s) involved, in abbreviated form. (If there are o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected both real and virtual postings, it shows only the accounts affected
by real postings.) 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. inflow to this account, negative for an outflow.
o the current account's historic balance (if no query other than a date 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. wise), after the transaction.
Eg, these will show historic balances: Eg, these will show historic balances:
@ -245,48 +246,48 @@ SCREENS
$ hledger-ui --begin 'this month' desc:market $ hledger-ui --begin 'this month' desc:market
$ hledger-ui --register checking --cleared $ hledger-ui --register checking --cleared
The register screen normally shows transactions in the current account The register screen normally shows transactions in the current account
and any of its subaccounts (inclusive mode). If it was entered from and any of its subaccounts (inclusive mode). If it was entered from
the accounts screen in flat mode, where the selected account was not the accounts screen in flat mode, where the selected account was not
depth-clipped and therefore was showing its subaccount-excluding bal- depth-clipped and therefore was showing its subaccount-excluding bal-
ance, the register too will omit the transactions of subaccounts ance, the register too will omit the transactions of subaccounts
(exclusive mode). This means the register always shows the transac- (exclusive mode). This means the register always shows the transac-
tions responsible for the balance being displayed on the accounts tions responsible for the balance being displayed on the accounts
screen. screen.
C toggles cleared mode, in which uncleared transactions and postings C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared are not shown. U toggles uncleared mode, in which only uncleared
transactions/postings are shown. transactions/postings are shown.
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only transactions posting a nonzero Z toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com- change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger). mand-line hledger).
Press right (or enter) to view the selected transaction in detail. Press right (or enter) to view the selected transaction in detail.
Transaction screen Transaction screen
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour- similar to hledger's print command and journal format (hledger_jour-
nal(5)). nal(5)).
The transaction's date(s) and any cleared flag, transaction code, The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more shown. Simple transactions have two postings, but there can be more
(or in certain cases, fewer). (or in certain cases, fewer).
up and down will step through all transactions listed in the previous up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary show your position within that account register. They will vary
depending on which account register you came from (remember most trans- depending on which account register you came from (remember most trans-
actions appear in multiple account registers). The #N number preceding actions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour- them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload). nal, which is a more stable id (at least until the next reload).
Error screen Error screen
This screen will appear if there is a problem, such as a parse error, 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 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 again to reload and resume normal operation. (Or, you can press escape
to cancel the reload attempt.) to cancel the reload attempt.)
@ -294,17 +295,17 @@ ENVIRONMENT
COLUMNS The screen width to use. Default: the full terminal width. COLUMNS The screen width to use. Default: the full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default: LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal). nal).
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). C:/Users/USER/.hledger.journal).
BUGS 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. ward.
-f- doesn't work (hledger-ui can't read from stdin). -f- doesn't work (hledger-ui can't read from stdin).
@ -315,14 +316,14 @@ BUGS
which may cause a noticeable pause. Also there is no visual indication which may cause a noticeable pause. Also there is no visual indication
that this is in progress. 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 total based on query arguments may be confusing, and there is no column
heading to indicate which is being displayed. heading to indicate which is being displayed.
REPORTING BUGS 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) or hledger mail list)
@ -336,7 +337,7 @@ COPYRIGHT
SEE ALSO 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- hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1) dot(5), ledger(1)

7
hledger/doc/hledger.1
View File

@ -1029,12 +1029,13 @@ in tree mode: don\[aq]t squash boring parent accounts
.RE .RE
.TP .TP
.B \f[C]\-H\ \-\-historical\f[] .B \f[C]\-H\ \-\-historical\f[]
in multicolumn mode: show historical ending balances show historical ending balances, reflecting postings before report start
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-cumulative\f[] .B \f[C]\-\-cumulative\f[]
in multicolumn mode: show accumulated ending balances in multicolumn mode: show ending balances accumulated from 0 at report
start
.RS .RS
.RE .RE
.TP .TP
@ -1635,7 +1636,7 @@ Show postings and their running total.
Alias: reg. Alias: reg.
.TP .TP
.B \f[C]\-H\ \-\-historical\f[] .B \f[C]\-H\ \-\-historical\f[]
include prior postings in the running total show historical running balance, reflecting prior postings
.RS .RS
.RE .RE
.TP .TP

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

@ -817,10 +817,12 @@ Show accounts and their balances. Alias: bal.
in tree mode: don't squash boring parent accounts in tree mode: don't squash boring parent accounts
`-H --historical' `-H --historical'
in multicolumn mode: show historical ending balances show historical ending balances, reflecting postings before report
start
`--cumulative' `--cumulative'
in multicolumn mode: show accumulated ending balances in multicolumn mode: show ending balances accumulated from 0 at
report start
`-A --average' `-A --average'
in multicolumn mode: show a row average column in multicolumn mode: show a row average column
@ -1396,7 +1398,7 @@ File: hledger.1.info, Node: register, Next: stats, Prev: print, Up: COMMANDS
Show postings and their running total. Alias: reg. Show postings and their running total. Alias: reg.
`-H --historical' `-H --historical'
include prior postings in the running total show historical running balance, reflecting prior postings
`-A --average' `-A --average'
show a running average instead of the running total (implies show a running average instead of the running total (implies
@ -2125,69 +2127,69 @@ Node: add21806
Ref: #add21907 Ref: #add21907
Node: balance24566 Node: balance24566
Ref: #balance24679 Ref: #balance24679
Node: Flat mode27395 Node: Flat mode27448
Ref: #flat-mode27522 Ref: #flat-mode27575
Node: Depth limited balance reports27941 Node: Depth limited balance reports27994
Ref: #depth-limited-balance-reports28144 Ref: #depth-limited-balance-reports28197
Node: Multicolumn balance reports28565 Node: Multicolumn balance reports28618
Ref: #multicolumn-balance-reports28767 Ref: #multicolumn-balance-reports28820
Node: Market value33416 Node: Market value33469
Ref: #market-value33580 Ref: #market-value33633
Node: Custom balance output34073 Node: Custom balance output34126
Ref: #custom-balance-output34246 Ref: #custom-balance-output34299
Node: Output destination36350 Node: Output destination36403
Ref: #output-destination36515 Ref: #output-destination36568
Node: CSV output36785 Node: CSV output36838
Ref: #csv-output36904 Ref: #csv-output36957
Node: balancesheet37301 Node: balancesheet37354
Ref: #balancesheet37429 Ref: #balancesheet37482
Node: cashflow38081 Node: cashflow38134
Ref: #cashflow38198 Ref: #cashflow38251
Node: help38888 Node: help38941
Ref: #help39000 Ref: #help39053
Node: incomestatement39837 Node: incomestatement39890
Ref: #incomestatement39967 Ref: #incomestatement40020
Node: info40694 Node: info40747
Ref: #info40801 Ref: #info40854
Node: man41163 Node: man41216
Ref: #man41260 Ref: #man41313
Node: print41663 Node: print41716
Ref: #print41768 Ref: #print41821
Node: register43119 Node: register43172
Ref: #register43232 Ref: #register43285
Node: Custom register output47573 Node: Custom register output47641
Ref: #custom-register-output47704 Ref: #custom-register-output47772
Node: stats49001 Node: stats49069
Ref: #stats49107 Ref: #stats49175
Node: test49988 Node: test50056
Ref: #test50075 Ref: #test50143
Node: ADD-ON COMMANDS50442 Node: ADD-ON COMMANDS50510
Ref: #add-on-commands50578 Ref: #add-on-commands50646
Node: api51866 Node: api51934
Ref: #api51958 Ref: #api52026
Node: autosync51992 Node: autosync52060
Ref: #autosync52107 Ref: #autosync52175
Node: diff54422 Node: diff54490
Ref: #diff54532 Ref: #diff54600
Node: equity55196 Node: equity55264
Ref: #equity55310 Ref: #equity55378
Node: interest56638 Node: interest56706
Ref: #interest56755 Ref: #interest56823
Node: irr59839 Node: irr59907
Ref: #irr59952 Ref: #irr60020
Node: print-unique62327 Node: print-unique62395
Ref: #print-unique62457 Ref: #print-unique62525
Node: rewrite62715 Node: rewrite62783
Ref: #rewrite62834 Ref: #rewrite62902
Node: ui63363 Node: ui63431
Ref: #ui63463 Ref: #ui63531
Node: web63504 Node: web63572
Ref: #web63592 Ref: #web63660
Node: TROUBLESHOOTING63625 Node: TROUBLESHOOTING63693
Ref: #troubleshooting63744 Ref: #troubleshooting63812
Node: Run-time problems63798 Node: Run-time problems63866
Ref: #run-time-problems63941 Ref: #run-time-problems64009
Node: Known limitations65885 Node: Known limitations65953
Ref: #known-limitations66028 Ref: #known-limitations66096
 
End Tag Table End Tag Table

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

@ -711,10 +711,12 @@ COMMANDS
in tree mode: don't squash boring parent accounts in tree mode: don't squash boring parent accounts
-H --historical -H --historical
in multicolumn mode: show historical ending balances show historical ending balances, reflecting postings before
report start
--cumulative --cumulative
in multicolumn mode: show accumulated ending balances in multicolumn mode: show ending balances accumulated from 0 at
report start
-A --average -A --average
in multicolumn mode: show a row average column in multicolumn mode: show a row average column
@ -1178,7 +1180,7 @@ COMMANDS
Show postings and their running total. Alias: reg. Show postings and their running total. Alias: reg.
-H --historical -H --historical
include prior postings in the running total show historical running balance, reflecting prior postings
-A --average -A --average
show a running average instead of the running total (implies show a running average instead of the running total (implies