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

doc: update builtin manuals

Browse Source
This commit is contained in:
Simon Michael 2017-07-07 02:01:11 +01:00
parent 7e896572a7
commit ee735514fe
12 changed files with 591 additions and 648 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
hledger-lib/doc/hledger_csv.5
View File

@ -23,7 +23,7 @@ For an example, see Cookbook: convert CSV files.
To learn about \f[I]exporting\f[] CSV, see CSV output. To learn about \f[I]exporting\f[] CSV, see CSV output.
.SH CSV RULES .SH CSV RULES
.PP .PP
The following six kinds of rule can appear in the rules file, in any The following seven kinds of rule can appear in the rules file, in any
order. order.
Blank lines and lines beginning with \f[C]#\f[] or \f[C];\f[] are Blank lines and lines beginning with \f[C]#\f[] or \f[C];\f[] are
ignored. ignored.
@ -195,6 +195,17 @@ Eg:
include\ common.rules include\ common.rules
\f[] \f[]
.fi .fi
.SS newest\-first
.PP
\f[C]newest\-first\f[]
.PP
Consider adding this rule if: your CSV records are in reverse
chronological order (newest first), and you care about preserving the
order of same\-day transactions, and you might be processing just one
day of data.
It usually isn\[aq]t needed, because hledger autodetects the CSV order,
but if all the CSV records have the same date it assumes they are oldest
first.
.SH CSV TIPS .SH CSV TIPS
.PP .PP
Each generated journal entry will have two postings, to Each generated journal entry will have two postings, to

50
hledger-lib/doc/hledger_csv.5.info
View File

@ -27,7 +27,7 @@ File: hledger_csv.5.info, Node: CSV RULES, Next: CSV TIPS, Prev: Top, Up: To
1 CSV RULES 1 CSV RULES
*********** ***********
The following six kinds of rule can appear in the rules file, in any The following seven kinds of rule can appear in the rules file, in any
order. Blank lines and lines beginning with '#' or ';' are ignored. order. Blank lines and lines beginning with '#' or ';' are ignored.
* Menu: * Menu:
@ -37,6 +37,7 @@ order. Blank lines and lines beginning with '#' or ';' are ignored.
* field assignment:: * field assignment::
* conditional block:: * conditional block::
* include:: * include::
* newest-first::
 
File: hledger_csv.5.info, Node: skip, Next: date-format, Up: CSV RULES File: hledger_csv.5.info, Node: skip, Next: date-format, Up: CSV RULES
@ -156,7 +157,7 @@ banking thru software
comment XXX deductible ? check it comment XXX deductible ? check it
 
File: hledger_csv.5.info, Node: include, Prev: conditional block, Up: CSV RULES File: hledger_csv.5.info, Node: include, Next: newest-first, Prev: conditional block, Up: CSV RULES
1.6 include 1.6 include
=========== ===========
@ -170,6 +171,21 @@ Eg:
# rules reused with several CSV files # rules reused with several CSV files
include common.rules include common.rules

File: hledger_csv.5.info, Node: newest-first, Prev: include, Up: CSV RULES
1.7 newest-first
================
'newest-first'
Consider adding this rule if: your CSV records are in reverse
chronological order (newest first), and you care about preserving the
order of same-day transactions, and you might be processing just one day
of data. It usually isn't needed, because hledger autodetects the CSV
order, but if all the CSV records have the same date it assumes they are
oldest first.
 
File: hledger_csv.5.info, Node: CSV TIPS, Prev: CSV RULES, Up: Top File: hledger_csv.5.info, Node: CSV TIPS, Prev: CSV RULES, Up: Top
@ -203,19 +219,21 @@ Tag Table:
Node: Top74 Node: Top74
Node: CSV RULES810 Node: CSV RULES810
Ref: #csv-rules920 Ref: #csv-rules920
Node: skip1163 Node: skip1182
Ref: #skip1259 Ref: #skip1278
Node: date-format1431 Node: date-format1450
Ref: #date-format1560 Ref: #date-format1579
Node: field list2066 Node: field list2085
Ref: #field-list2205 Ref: #field-list2224
Node: field assignment2910 Node: field assignment2929
Ref: #field-assignment3067 Ref: #field-assignment3086
Node: conditional block3571 Node: conditional block3590
Ref: #conditional-block3727 Ref: #conditional-block3746
Node: include4623 Node: include4642
Ref: #include4734 Ref: #include4774
Node: CSV TIPS4965 Node: newest-first5005
Ref: #csv-tips5061 Ref: #newest-first5121
Node: CSV TIPS5504
Ref: #csv-tips5600
 
End Tag Table End Tag Table

34
hledger-lib/doc/hledger_csv.5.txt
View File

@ -19,7 +19,7 @@ DESCRIPTION
To learn about exporting CSV, see CSV output. To learn about exporting CSV, see CSV output.
CSV RULES CSV RULES
The following six kinds of rule can appear in the rules file, in any The following seven kinds of rule can appear in the rules file, in any
order. Blank lines and lines beginning with # or ; are ignored. order. Blank lines and lines beginning with # or ; are ignored.
skip skip
@ -123,33 +123,43 @@ CSV RULES
# rules reused with several CSV files # rules reused with several CSV files
include common.rules include common.rules
newest-first
newest-first
Consider adding this rule if: your CSV records are in reverse chrono-
logical order (newest first), and you care about preserving the order
of same-day transactions, and you might be processing just one day of
data. It usually isn't needed, because hledger autodetects the CSV
order, but if all the CSV records have the same date it assumes they
are oldest first.
CSV TIPS CSV TIPS
Each generated journal entry will have two postings, to account1 and Each generated journal entry will have two postings, to account1 and
account2 respectively. Currently it's not possible to generate entries account2 respectively. Currently it's not possible to generate entries
with more than two postings. with more than two postings.
If the CSV has debit/credit amounts in separate fields, assign to the If the CSV has debit/credit amounts in separate fields, assign to the
amount-in and amount-out pseudo fields instead of amount. amount-in and amount-out pseudo fields instead of amount.
If the CSV has the currency in a separate field, assign that to the If the CSV has the currency in a separate field, assign that to the
currency pseudo field which will be automatically prepended to the currency pseudo field which will be automatically prepended to the
amount. (Or you can do the same thing with a field assignment.) amount. (Or you can do the same thing with a field assignment.)
If the CSV includes a running balance, you can assign that to the bal- If the CSV includes a running balance, you can assign that to the bal-
ance pseudo field to generate a balance assertion on account1 whenever ance pseudo field to generate a balance assertion on account1 whenever
the balance field is non-empty. (Eg to double-check your bank's bal- the balance field is non-empty. (Eg to double-check your bank's bal-
ance calculation.) ance calculation.)
If an amount value is parenthesised, it will be de-parenthesised and If an amount value is parenthesised, it will be de-parenthesised and
sign-flipped automatically. sign-flipped automatically.
The generated journal entries will be sorted by date. The original The generated journal entries will be sorted by date. The original
order of same-day entries will be preserved, usually. order of same-day entries will be preserved, usually.
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)
@ -163,7 +173,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)

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

@ -190,27 +190,11 @@ most recent applicable market price, if any)
.PP .PP
hledger help options: hledger help options:
.TP .TP
.B \f[C]\-h\f[] .B \f[C]\-h\ \-\-help\f[]
show general usage (or after COMMAND, command usage) show general usage (or after COMMAND, command usage)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-help\f[]
show this program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual)
.RS
.RE
.TP
.B \f[C]\-\-man\f[]
show this program\[aq]s manual with man
.RS
.RE
.TP
.B \f[C]\-\-info\f[]
show this program\[aq]s manual with info
.RS
.RE
.TP
.B \f[C]\-\-version\f[] .B \f[C]\-\-version\f[]
show version show version
.RS .RS

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

@ -133,19 +133,9 @@ the data.
hledger help options: hledger help options:
'-h' '-h --help'
show general usage (or after COMMAND, command usage) show general usage (or after COMMAND, command usage)
'--help'
show this program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
'--man'
show this program's manual with man
'--info'
show this program's manual with info
'--version' '--version'
show version show version
@ -367,17 +357,17 @@ Tag Table:
Node: Top73 Node: Top73
Node: OPTIONS825 Node: OPTIONS825
Ref: #options924 Ref: #options924
Node: KEYS3665 Node: KEYS3459
Ref: #keys3762 Ref: #keys3556
Node: SCREENS6558 Node: SCREENS6352
Ref: #screens6645 Ref: #screens6439
Node: Accounts screen6735 Node: Accounts screen6529
Ref: #accounts-screen6865 Ref: #accounts-screen6659
Node: Register screen9095 Node: Register screen8889
Ref: #register-screen9252 Ref: #register-screen9046
Node: Transaction screen11326 Node: Transaction screen11120
Ref: #transaction-screen11486 Ref: #transaction-screen11280
Node: Error screen12356 Node: Error screen12150
Ref: #error-screen12480 Ref: #error-screen12274
 
End Tag Table End Tag Table

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

@ -129,14 +129,8 @@ OPTIONS
hledger help options: hledger help options:
-h show general usage (or after COMMAND, command usage) -h --help
show general usage (or after COMMAND, command usage)
--help show this program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
--man show this program's manual with man
--info show this program's manual with info
--version --version
show version show version
@ -145,56 +139,56 @@ OPTIONS
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
KEYS KEYS
? shows a help dialog listing all keys. (Some of these also appear in ? shows a help dialog listing all keys. (Some of these also appear in
the quick help at the bottom of each screen.) Press ? again (or ESCAPE, the quick help at the bottom of each screen.) Press ? again (or ESCAPE,
or LEFT) to close it. The following keys work on most screens: or LEFT) to close it. The following keys work on most screens:
The cursor keys navigate: right (or enter) goes deeper, left returns to 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 the previous screen, up/down/page up/page down/home/end move up and
down through lists. Vi-style (h/j/k/l) and Emacs-style down through lists. Vi-style (h/j/k/l) and Emacs-style
(CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also supported. A tip: (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also supported. A tip:
movement speed is limited by your keyboard repeat rate, to move faster movement speed is limited by your keyboard repeat rate, to move faster
you may want to adjust it. (If you're on a mac, the Karabiner app is you may want to adjust it. (If you're on a mac, the Karabiner app is
one way to do that.) one way to do that.)
With shift pressed, the cursor keys adjust the report period, limiting With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown). the transactions to be shown (by default, all are shown).
shift-down/up steps downward and upward through these standard report shift-down/up steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then, period durations: year, quarter, month, week, day. Then,
shift-left/right moves to the previous/next period. t sets the report shift-left/right moves to the previous/next period. t sets the report
period to today. With the --watch option, when viewing a "current" period to today. With the --watch option, when viewing a "current"
period (the current day, week, month, quarter, or year), the period period (the current day, week, month, quarter, or year), the period
will move automatically to track the current date. To set a non-stan- will move automatically to track the current date. To set a non-stan-
dard period, you can use / and a date: query. dard period, you can use / and a date: query.
/ lets you set a general filter query limiting the data shown, using / lets you set a general filter query limiting the data shown, using
the same query terms as in hledger and hledger-web. While editing the the same query terms as in hledger and hledger-web. While editing the
query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
it, or ESCAPEto cancel. There are also keys for quickly adjusting some it, or ESCAPEto cancel. There are also keys for quickly adjusting some
common filters like account depth and transaction status (see below). common filters like account depth and transaction status (see below).
BACKSPACE or DELETE removes all filters, showing all transactions. BACKSPACE or DELETE removes all filters, showing all transactions.
ESCAPE removes all filters and jumps back to the top screen. Or, it ESCAPE removes all filters and jumps back to the top screen. Or, it
cancels a minibuffer edit or help dialog in progress. cancels a minibuffer edit or help dialog in progress.
CTRL-l redraws the screen and centers the selection if possible (selec- CTRL-l redraws the screen and centers the selection if possible (selec-
tions near the top won't be centered, since we don't scroll above the tions near the top won't be centered, since we don't scroll above the
top). top).
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, this could cause a noticeable previous screens. (With large files, this could cause a noticeable
pause.) 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.
@ -203,44 +197,44 @@ 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, in which accounts are shown as a flat list, with F toggles flat mode, in which accounts are shown as a flat list, with
their full names. In this mode, account balances exclude subaccounts, their full names. In this mode, account balances exclude subaccounts,
except for accounts at the depth limit (as with hledger's balance com- except for accounts at the depth limit (as with hledger's balance com-
mand). mand).
H toggles between showing historical balances or period balances. His- H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before (filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log. the report period. They are more useful eg when viewing a time log.
U toggles filtering by unmarked status, including or excluding unmarked U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings; toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are if you activate one or two status filters, only those postings are
included; and if you activate all three, the filter is removed.) included; and if you activate all three, the filter is removed.)
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.
@ -249,65 +243,65 @@ 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 running historical total or period total for the current account, o the running historical total or period total for the current account,
after the transaction. This can be toggled with H. Similar to the after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while (filtered by the filter query) before the report start date, while
the period total is not. If the historical total is not disturbed by the period total is not. If the historical total is not disturbed by
a filter query, it will be the running historical balance you would a filter query, it will be the running historical balance you would
see on a bank register for the current account. see on a bank register for the current account.
If the accounts screen was in tree mode, the register screen will If the accounts screen was in tree mode, the register screen will
include transactions from both the current account and its subaccounts. include transactions from both the current account and its subaccounts.
If the accounts screen was in flat mode, and a non-depth-clipped If the accounts screen was in flat mode, and a non-depth-clipped
account was selected, the register screen will exclude transactions account was selected, the register screen will exclude transactions
from subaccounts. In other words, the register always shows the trans- from subaccounts. In other words, the register always shows the trans-
actions responsible for the period balance shown on the accounts actions responsible for the period balance shown on the accounts
screen. As on the accounts screen, this can be toggled with F. screen. As on the accounts screen, this can be toggled with F.
U toggles filtering by unmarked status, showing or hiding unmarked U toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, P toggles pending transactions, and C toggles transactions. Similarly, P toggles pending transactions, and C toggles
cleared transactions. (By default, transactions with all statuses are cleared transactions. (By default, transactions with all statuses are
shown; if you activate one or two status filters, only those transac- shown; if you activate one or two status filters, only those transac-
tions are shown; and if you activate all three, the filter is tions are shown; and if you activate all three, the filter is
removed.)q removed.)q
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.)
@ -315,17 +309,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).
@ -333,13 +327,13 @@ BUGS
-V affects only the accounts screen. -V affects only the accounts screen.
When you press g, the current and all previous screens are regenerated, When you press g, the current and all previous screens are regenerated,
which may cause a noticeable pause with large files. Also there is no which may cause a noticeable pause with large files. Also there is no
visual indication that this is in progress. visual indication that this is in progress.
--watch is not yet fully robust. It works well for normal usage, but --watch is not yet fully robust. It works well for normal usage, but
many file changes in a short time (eg saving the file thousands of many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symp- times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi- toms include: unresponsive UI, periodic resetting of the cursor posi-
tion, momentary display of parse errors, high CPU usage eventually sub- tion, momentary display of parse errors, high CPU usage eventually sub-
siding, and possibly a small but persistent build-up of CPU usage until siding, and possibly a small but persistent build-up of CPU usage until
the program is restarted. the program is restarted.
@ -347,7 +341,7 @@ BUGS
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)
@ -361,7 +355,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)

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

@ -246,27 +246,11 @@ most recent applicable market price, if any)
.PP .PP
hledger help options: hledger help options:
.TP .TP
.B \f[C]\-h\f[] .B \f[C]\-h\ \-\-help\f[]
show general usage (or after COMMAND, command usage) show general usage (or after COMMAND, command usage)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-help\f[]
show this program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual)
.RS
.RE
.TP
.B \f[C]\-\-man\f[]
show this program\[aq]s manual with man
.RS
.RE
.TP
.B \f[C]\-\-info\f[]
show this program\[aq]s manual with info
.RS
.RE
.TP
.B \f[C]\-\-version\f[] .B \f[C]\-\-version\f[]
show version show version
.RS .RS

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

@ -178,19 +178,9 @@ options as shown above.
hledger help options: hledger help options:
'-h' '-h --help'
show general usage (or after COMMAND, command usage) show general usage (or after COMMAND, command usage)
'--help'
show this program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
'--man'
show this program's manual with man
'--info'
show this program's manual with info
'--version' '--version'
show version show version

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

@ -174,14 +174,8 @@ OPTIONS
hledger help options: hledger help options:
-h show general usage (or after COMMAND, command usage) -h --help
show general usage (or after COMMAND, command usage)
--help show this program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
--man show this program's manual with man
--info show this program's manual with info
--version --version
show version show version
@ -191,17 +185,17 @@ OPTIONS
ENVIRONMENT ENVIRONMENT
LEDGER_FILE The journal file path when not specified with -f. Default: LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
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-web can't read from stdin). -f- doesn't work (hledger-web can't read from stdin).
@ -215,7 +209,7 @@ BUGS
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)
@ -229,7 +223,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)

18
hledger/doc/hledger.1
View File

@ -160,27 +160,11 @@ by most hledger commands, run \f[C]hledger\ \-h\f[].
.PP .PP
General help options: General help options:
.TP .TP
.B \f[C]\-h\f[] .B \f[C]\-h\ \-\-help\f[]
show general usage (or after COMMAND, command usage) show general usage (or after COMMAND, command usage)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-help\f[]
show this program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual)
.RS
.RE
.TP
.B \f[C]\-\-man\f[]
show this program\[aq]s manual with man
.RS
.RE
.TP
.B \f[C]\-\-info\f[]
show this program\[aq]s manual with info
.RS
.RE
.TP
.B \f[C]\-\-version\f[] .B \f[C]\-\-version\f[]
show version show version
.RS .RS

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

@ -142,19 +142,9 @@ different, like git.)
General help options: General help options:
'-h' '-h --help'
show general usage (or after COMMAND, command usage) show general usage (or after COMMAND, command usage)
'--help'
show this program's manual as plain text (or after an add-on
COMMAND, the add-on's manual)
'--man'
show this program's manual with man
'--info'
show this program's manual with info
'--version' '--version'
show version show version
@ -2119,123 +2109,123 @@ Node: OPTIONS3634
Ref: #options3738 Ref: #options3738
Node: General options4019 Node: General options4019
Ref: #general-options4146 Ref: #general-options4146
Node: Command options6684 Node: Command options6478
Ref: #command-options6837 Ref: #command-options6631
Node: Command arguments7235 Node: Command arguments7029
Ref: #command-arguments7395 Ref: #command-arguments7189
Node: Special characters7516 Node: Special characters7310
Ref: #special-characters7674 Ref: #special-characters7468
Node: Input files8842 Node: Input files8636
Ref: #input-files8980 Ref: #input-files8774
Node: Smart dates10943 Node: Smart dates10737
Ref: #smart-dates11086 Ref: #smart-dates10880
Node: Report start & end date12065 Node: Report start & end date11859
Ref: #report-start-end-date12237 Ref: #report-start-end-date12031
Node: Report intervals13303 Node: Report intervals13097
Ref: #report-intervals13468 Ref: #report-intervals13262
Node: Period expressions13869 Node: Period expressions13663
Ref: #period-expressions14029 Ref: #period-expressions13823
Node: Depth limiting16369 Node: Depth limiting16163
Ref: #depth-limiting16515 Ref: #depth-limiting16309
Node: Pivoting16716 Node: Pivoting16510
Ref: #pivoting16836 Ref: #pivoting16630
Node: Cost18607 Node: Cost18401
Ref: #cost18717 Ref: #cost18511
Node: Market value18835 Node: Market value18629
Ref: #market-value18972 Ref: #market-value18766
Node: Regular expressions20272 Node: Regular expressions20066
Ref: #regular-expressions20410 Ref: #regular-expressions20204
Node: QUERIES21771 Node: QUERIES21565
Ref: #queries21875 Ref: #queries21669
Node: COMMANDS25540 Node: COMMANDS25334
Ref: #commands25654 Ref: #commands25448
Node: accounts26327 Node: accounts26121
Ref: #accounts26427 Ref: #accounts26221
Node: activity27409 Node: activity27203
Ref: #activity27521 Ref: #activity27315
Node: add27880 Node: add27674
Ref: #add27981 Ref: #add27775
Node: balance30639 Node: balance30433
Ref: #balance30752 Ref: #balance30546
Node: Flat mode33767 Node: Flat mode33561
Ref: #flat-mode33894 Ref: #flat-mode33688
Node: Depth limited balance reports34314 Node: Depth limited balance reports34108
Ref: #depth-limited-balance-reports34517 Ref: #depth-limited-balance-reports34311
Node: Multicolumn balance reports34937 Node: Multicolumn balance reports34731
Ref: #multicolumn-balance-reports35148 Ref: #multicolumn-balance-reports34942
Node: Custom balance output39796 Node: Custom balance output39590
Ref: #custom-balance-output39980 Ref: #custom-balance-output39774
Node: Colour support42073 Node: Colour support41867
Ref: #colour-support42234 Ref: #colour-support42028
Node: Output destination42407 Node: Output destination42201
Ref: #output-destination42565 Ref: #output-destination42359
Node: CSV output42835 Node: CSV output42629
Ref: #csv-output42954 Ref: #csv-output42748
Node: balancesheet43351 Node: balancesheet43145
Ref: #balancesheet43479 Ref: #balancesheet43273
Node: cashflow45386 Node: cashflow45180
Ref: #cashflow45503 Ref: #cashflow45297
Node: help47371 Node: help47165
Ref: #help47483 Ref: #help47277
Node: incomestatement48321 Node: incomestatement48115
Ref: #incomestatement48451 Ref: #incomestatement48245
Node: info50343 Node: info50137
Ref: #info50450 Ref: #info50244
Node: man50814 Node: man50608
Ref: #man50911 Ref: #man50705
Node: print51316 Node: print51110
Ref: #print51421 Ref: #print51215
Node: register55177 Node: register54971
Ref: #register55290 Ref: #register55084
Node: Custom register output59786 Node: Custom register output59580
Ref: #custom-register-output59917 Ref: #custom-register-output59711
Node: stats61214 Node: stats61008
Ref: #stats61320 Ref: #stats61114
Node: test62201 Node: test61995
Ref: #test62288 Ref: #test62082
Node: ADD-ON COMMANDS62656 Node: ADD-ON COMMANDS62450
Ref: #add-on-commands62768 Ref: #add-on-commands62562
Node: Official add-ons64055 Node: Official add-ons63849
Ref: #official-add-ons64197 Ref: #official-add-ons63991
Node: api64284 Node: api64078
Ref: #api64375 Ref: #api64169
Node: ui64427 Node: ui64221
Ref: #ui64528 Ref: #ui64322
Node: web64586 Node: web64380
Ref: #web64677 Ref: #web64471
Node: Third party add-ons64723 Node: Third party add-ons64517
Ref: #third-party-add-ons64900 Ref: #third-party-add-ons64694
Node: diff65035 Node: diff64829
Ref: #diff65134 Ref: #diff64928
Node: iadd65233 Node: iadd65027
Ref: #iadd65349 Ref: #iadd65143
Node: interest65432 Node: interest65226
Ref: #interest65555 Ref: #interest65349
Node: irr65650 Node: irr65444
Ref: #irr65750 Ref: #irr65544
Node: Experimental add-ons65828 Node: Experimental add-ons65622
Ref: #experimental-add-ons65982 Ref: #experimental-add-ons65776
Node: autosync66375 Node: autosync66169
Ref: #autosync66489 Ref: #autosync66283
Node: budget66728 Node: budget66522
Ref: #budget66852 Ref: #budget66646
Node: chart66918 Node: chart66712
Ref: #chart67037 Ref: #chart66831
Node: check67108 Node: check66902
Ref: #check67232 Ref: #check67026
Node: check-dates67299 Node: check-dates67093
Ref: #check-dates67441 Ref: #check-dates67235
Node: check-dupes67514 Node: check-dupes67308
Ref: #check-dupes67657 Ref: #check-dupes67451
Node: equity67734 Node: equity67528
Ref: #equity67862 Ref: #equity67656
Node: prices67981 Node: prices67775
Ref: #prices68110 Ref: #prices67904
Node: print-unique68165 Node: print-unique67959
Ref: #print-unique68314 Ref: #print-unique68108
Node: register-match68407 Node: register-match68201
Ref: #register-match68563 Ref: #register-match68357
Node: rewrite68661 Node: rewrite68455
Ref: #rewrite68782 Ref: #rewrite68576
 
End Tag Table End Tag Table

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

File diff suppressed because it is too large Load Diff