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

doc: bump version to 1.3, update builtin manuals

Browse Source
This commit is contained in:
Simon Michael 2017-06-30 20:45:50 +01:00
parent 50efcfe359
commit c4248072db
26 changed files with 308 additions and 293 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/lib.m4
View File

@ -8,7 +8,7 @@ m4_define({{_webcombined_}}, m4_ifdef({{WEB && COMBINED}},{{$1}}) )m4_dnl
m4_dnl m4_dnl
m4_define({{_author_}}, {{}})m4_dnl m4_define({{_author_}}, {{}})m4_dnl
m4_define({{_monthyear_}}, {{June 2017}})m4_dnl m4_define({{_monthyear_}}, {{June 2017}})m4_dnl
m4_define({{_version_}}, {{1.2.98}})m4_dnl m4_define({{_version_}}, {{1.3}})m4_dnl
m4_dnl m4_dnl
m4_dnl Links to dev and recent release versions of a manual. m4_dnl Links to dev and recent release versions of a manual.
m4_dnl $1 is the manual's web slug: hledger, hledger-ui, journal, csv etc. m4_dnl $1 is the manual's web slug: hledger, hledger-ui, journal, csv etc.
@ -20,6 +20,7 @@ This doc is for version **_version_**.
m4_dnl Too painful for static generation, insert from site.js instead m4_dnl Too painful for static generation, insert from site.js instead
m4_dnl Available versions: m4_dnl Available versions:
m4_dnl <a href="/$1.html">dev</a> m4_dnl <a href="/$1.html">dev</a>
m4_dnl | <a href="/doc/1.3/$1.html">1.3</a>
m4_dnl | <a href="/doc/1.2/$1.html">1.2</a> m4_dnl | <a href="/doc/1.2/$1.html">1.2</a>
m4_dnl | <a href="/doc/1.1/$1.html">1.1</a> m4_dnl | <a href="/doc/1.1/$1.html">1.1</a>
m4_dnl | <a href="/doc/1.0/$1.html">1.0</a> m4_dnl | <a href="/doc/1.0/$1.html">1.0</a>

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

@ -1,5 +1,5 @@
.TH "hledger\-api" "1" "June 2017" "hledger\-api 1.2.98" "hledger User Manuals" .TH "hledger\-api" "1" "June 2017" "hledger\-api 1.3" "hledger User Manuals"

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

@ -3,8 +3,8 @@ This is hledger-api.1.info, produced by makeinfo version 6.0 from stdin.
 
File: hledger-api.1.info, Node: Top, Next: OPTIONS, Up: (dir) File: hledger-api.1.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-api(1) hledger-api 1.2.98 hledger-api(1) hledger-api 1.3
********************************* ******************************
hledger-api is a simple web API server, intended to support client-side hledger-api is a simple web API server, intended to support client-side
web apps operating on hledger data. It comes with a series of simple web apps operating on hledger data. It comes with a series of simple
@ -73,7 +73,7 @@ options as shown above.
 
Tag Table: Tag Table:
Node: Top74 Node: Top74
Node: OPTIONS1226 Node: OPTIONS1220
Ref: #options1313 Ref: #options1307
 
End Tag Table End Tag Table

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

@ -107,4 +107,4 @@ SEE ALSO
hledger-api 1.2.98 June 2017 hledger-api(1) hledger-api 1.3 June 2017 hledger-api(1)

4
hledger-api/hledger-api.hs
View File

@ -35,12 +35,12 @@ import Text.Printf
import Hledger.Query import Hledger.Query
import Hledger.Cli hiding (Reader, version) import Hledger.Cli hiding (Reader, version)
hledgerApiVersion="1.2.98" hledgerApiVersion="1.3"
-- https://github.com/docopt/docopt.hs#readme -- https://github.com/docopt/docopt.hs#readme
doc :: Docopt doc :: Docopt
doc = [docopt| doc = [docopt|
hledger-api 1.2.98 hledger-api 1.3
Serves hledger data and reports as a JSON web API. Serves hledger data and reports as a JSON web API.

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

@ -1,5 +1,5 @@
.TH "hledger_csv" "5" "June 2017" "hledger 1.2.98" "hledger User Manuals" .TH "hledger_csv" "5" "June 2017" "hledger 1.3" "hledger User Manuals"

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

@ -3,8 +3,8 @@ This is hledger_csv.5.info, produced by makeinfo version 6.0 from stdin.
 
File: hledger_csv.5.info, Node: Top, Next: CSV RULES, Up: (dir) File: hledger_csv.5.info, Node: Top, Next: CSV RULES, Up: (dir)
hledger_csv(5) hledger 1.2.98 hledger_csv(5) hledger 1.3
***************************** **************************
hledger can read CSV files, converting each CSV record into a journal hledger can read CSV files, converting each CSV record into a journal
entry (transaction), if you provide some conversion hints in a "rules entry (transaction), if you provide some conversion hints in a "rules
@ -201,21 +201,21 @@ order of same-day entries will be preserved, usually.
 
Tag Table: Tag Table:
Node: Top74 Node: Top74
Node: CSV RULES816 Node: CSV RULES810
Ref: #csv-rules926 Ref: #csv-rules920
Node: skip1169 Node: skip1163
Ref: #skip1265 Ref: #skip1259
Node: date-format1437 Node: date-format1431
Ref: #date-format1566 Ref: #date-format1560
Node: field list2072 Node: field list2066
Ref: #field-list2211 Ref: #field-list2205
Node: field assignment2916 Node: field assignment2910
Ref: #field-assignment3073 Ref: #field-assignment3067
Node: conditional block3577 Node: conditional block3571
Ref: #conditional-block3733 Ref: #conditional-block3727
Node: include4629 Node: include4623
Ref: #include4740 Ref: #include4734
Node: CSV TIPS4971 Node: CSV TIPS4965
Ref: #csv-tips5067 Ref: #csv-tips5061
 
End Tag Table End Tag Table

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

@ -171,4 +171,4 @@ SEE ALSO
hledger 1.2.98 June 2017 hledger_csv(5) hledger 1.3 June 2017 hledger_csv(5)

6
hledger-lib/doc/hledger_journal.5
View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger_journal" "5" "June 2017" "hledger 1.2.98" "hledger User Manuals" .TH "hledger_journal" "5" "June 2017" "hledger 1.3" "hledger User Manuals"
@ -69,8 +69,8 @@ This can be followed by any of the following, separated by spaces:
.IP \[bu] 2 .IP \[bu] 2
(optional) a status character (empty, \f[C]!\f[], or \f[C]*\f[]) (optional) a status character (empty, \f[C]!\f[], or \f[C]*\f[])
.IP \[bu] 2 .IP \[bu] 2
(optional) a transaction code (any short number or text, eg a check (optional) a transaction code (any short number or text, enclosed in
number) parentheses)
.IP \[bu] 2 .IP \[bu] 2
(optional) a transaction description (any remaining text until end of (optional) a transaction description (any remaining text until end of
line) line)

16
hledger-lib/doc/hledger_journal.5.info
View File

@ -4,8 +4,8 @@ stdin.
 
File: hledger_journal.5.info, Node: Top, Next: FILE FORMAT, Up: (dir) File: hledger_journal.5.info, Node: Top, Next: FILE FORMAT, Up: (dir)
hledger_journal(5) hledger 1.2.98 hledger_journal(5) hledger 1.3
********************************* ******************************
hledger's usual data source is a plain text file containing journal hledger's usual data source is a plain text file containing journal
entries in hledger journal format. This file represents a standard entries in hledger journal format. This file represents a standard
@ -89,8 +89,8 @@ with a simple date in column 0. This can be followed by any of the
following, separated by spaces: following, separated by spaces:
* (optional) a status character (empty, '!', or '*') * (optional) a status character (empty, '!', or '*')
* (optional) a transaction code (any short number or text, eg a check * (optional) a transaction code (any short number or text, enclosed
number) in parentheses)
* (optional) a transaction description (any remaining text until end * (optional) a transaction description (any remaining text until end
of line) of line)
@ -1047,10 +1047,10 @@ Text Wrangler https://github.com/ledger/ledger/wiki/Editing-Ledger-files-wit
 
Tag Table: Tag Table:
Node: Top78 Node: Top78
Node: FILE FORMAT2298 Node: FILE FORMAT2292
Ref: #file-format2424 Ref: #file-format2418
Node: Transactions2631 Node: Transactions2625
Ref: #transactions2754 Ref: #transactions2748
Node: Postings3313 Node: Postings3313
Ref: #postings3442 Ref: #postings3442
Node: Dates4437 Node: Dates4437

6
hledger-lib/doc/hledger_journal.5.txt
View File

@ -60,8 +60,8 @@ FILE FORMAT
o (optional) a status character (empty, !, or *) o (optional) a status character (empty, !, or *)
o (optional) a transaction code (any short number or text, eg a check o (optional) a transaction code (any short number or text, enclosed in
number) parentheses)
o (optional) a transaction description (any remaining text until end of o (optional) a transaction description (any remaining text until end of
line) line)
@ -835,4 +835,4 @@ SEE ALSO
hledger 1.2.98 June 2017 hledger_journal(5) hledger 1.3 June 2017 hledger_journal(5)

2
hledger-lib/doc/hledger_timeclock.5
View File

@ -1,5 +1,5 @@
.TH "hledger_timeclock" "5" "June 2017" "hledger 1.2.98" "hledger User Manuals" .TH "hledger_timeclock" "5" "June 2017" "hledger 1.3" "hledger User Manuals"

4
hledger-lib/doc/hledger_timeclock.5.info
View File

@ -4,8 +4,8 @@ stdin.
 
File: hledger_timeclock.5.info, Node: Top, Up: (dir) File: hledger_timeclock.5.info, Node: Top, Up: (dir)
hledger_timeclock(5) hledger 1.2.98 hledger_timeclock(5) hledger 1.3
*********************************** ********************************
hledger can read timeclock files. As with Ledger, these are (a subset hledger can read timeclock files. As with Ledger, these are (a subset
of) timeclock.el's format, containing clock-in and clock-out entries as of) timeclock.el's format, containing clock-in and clock-out entries as

2
hledger-lib/doc/hledger_timeclock.5.txt
View File

@ -79,4 +79,4 @@ SEE ALSO
hledger 1.2.98 June 2017 hledger_timeclock(5) hledger 1.3 June 2017 hledger_timeclock(5)

2
hledger-lib/doc/hledger_timedot.5
View File

@ -1,5 +1,5 @@
.TH "hledger_timedot" "5" "June 2017" "hledger 1.2.98" "hledger User Manuals" .TH "hledger_timedot" "5" "June 2017" "hledger 1.3" "hledger User Manuals"

8
hledger-lib/doc/hledger_timedot.5.info
View File

@ -4,8 +4,8 @@ stdin.
 
File: hledger_timedot.5.info, Node: Top, Next: FILE FORMAT, Up: (dir) File: hledger_timedot.5.info, Node: Top, Next: FILE FORMAT, Up: (dir)
hledger_timedot(5) hledger 1.2.98 hledger_timedot(5) hledger 1.3
********************************* ******************************
Timedot is a plain text format for logging dated, categorised quantities Timedot is a plain text format for logging dated, categorised quantities
(eg time), supported by hledger. It is convenient for approximate and (eg time), supported by hledger. It is convenient for approximate and
@ -106,7 +106,7 @@ $ hledger -f t.timedot --alias /\\./=: bal date:2016/2/4
 
Tag Table: Tag Table:
Node: Top78 Node: Top78
Node: FILE FORMAT888 Node: FILE FORMAT882
Ref: #file-format991 Ref: #file-format985
 
End Tag Table End Tag Table

2
hledger-lib/doc/hledger_timedot.5.txt
View File

@ -120,4 +120,4 @@ SEE ALSO
hledger 1.2.98 June 2017 hledger_timedot(5) hledger 1.3 June 2017 hledger_timedot(5)

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

@ -1,5 +1,5 @@
.TH "hledger\-ui" "1" "June 2017" "hledger\-ui 1.2.98" "hledger User Manuals" .TH "hledger\-ui" "1" "June 2017" "hledger\-ui 1.3" "hledger User Manuals"
@ -232,8 +232,9 @@ The cursor keys navigate: \f[C]right\f[] (or \f[C]enter\f[]) goes
deeper, \f[C]left\f[] returns to the previous screen, deeper, \f[C]left\f[] returns to the previous screen,
\f[C]up\f[]/\f[C]down\f[]/\f[C]page\ up\f[]/\f[C]page\ down\f[]/\f[C]home\f[]/\f[C]end\f[] \f[C]up\f[]/\f[C]down\f[]/\f[C]page\ up\f[]/\f[C]page\ down\f[]/\f[C]home\f[]/\f[C]end\f[]
move up and down through lists. 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 Vi\-style (\f[C]h\f[]/\f[C]j\f[]/\f[C]k\f[]/\f[C]l\f[]) and Emacs\-style
also supported. (\f[C]CTRL\-p\f[]/\f[C]CTRL\-n\f[]/\f[C]CTRL\-f\f[]/\f[C]CTRL\-b\f[])
movement keys are also supported.
A tip: movement speed is limited by your keyboard repeat rate, to move A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust it. faster you may want to adjust it.
(If you\[aq]re on a mac, the Karabiner app is one way to do that.) (If you\[aq]re on a mac, the Karabiner app is one way to do that.)
@ -262,6 +263,10 @@ transactions.
\f[C]ESCAPE\f[] removes all filters and jumps back to the top screen. \f[C]ESCAPE\f[] removes all filters and jumps back to the top screen.
Or, it cancels a minibuffer edit or help dialog in progress. Or, it cancels a minibuffer edit or help dialog in progress.
.PP .PP
\f[C]CTRL\-l\f[] redraws the screen and centers the selection if
possible (selections near the top won\[aq]t be centered, since we
don\[aq]t scroll above the top).
.PP
\f[C]g\f[] reloads from the data file(s) and updates the current screen \f[C]g\f[] reloads from the data file(s) and updates the current screen
and any previous screens. and any previous screens.
(With large files, this could cause a noticeable pause.) (With large files, this could cause a noticeable pause.)

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

@ -3,8 +3,8 @@ This is hledger-ui.1.info, produced by makeinfo version 6.0 from stdin.
 
File: hledger-ui.1.info, Node: Top, Next: OPTIONS, Up: (dir) File: hledger-ui.1.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-ui(1) hledger-ui 1.2.98 hledger-ui(1) hledger-ui 1.3
******************************* ****************************
hledger-ui is hledger's curses-style interface, providing an efficient hledger-ui is hledger's curses-style interface, providing an efficient
full-window text UI for viewing accounts and transactions, and some full-window text UI for viewing accounts and transactions, and some
@ -167,10 +167,10 @@ screens:
The cursor keys navigate: 'right' (or 'enter') goes deeper, 'left' The cursor keys navigate: 'right' (or 'enter') goes deeper, 'left'
returns to the previous screen, 'up'/'down'/'page up'/'page returns to the previous screen, 'up'/'down'/'page up'/'page
down'/'home'/'end' move up and down through lists. Vi-style down'/'home'/'end' move up and down through lists. Vi-style
'h'/'j'/'k'/'l' movement keys are also supported. A tip: movement speed ('h'/'j'/'k'/'l') and Emacs-style ('CTRL-p'/'CTRL-n'/'CTRL-f'/'CTRL-b')
is limited by your keyboard repeat rate, to move faster you may want to movement keys are also supported. A tip: movement speed is limited by
adjust it. (If you're on a mac, the Karabiner app is one way to do your keyboard repeat rate, to move faster you may want to adjust it.
that.) (If you're on a mac, the Karabiner app is one way to do that.)
With shift pressed, the cursor keys adjust the report period, With shift pressed, the cursor keys adjust the report period,
limiting the transactions to be shown (by default, all are shown). limiting the transactions to be shown (by default, all are shown).
@ -193,6 +193,10 @@ transactions.
'ESCAPE' removes all filters and jumps back to the top screen. Or, 'ESCAPE' removes all filters and jumps back to the top screen. Or,
it cancels a minibuffer edit or help dialog in progress. it cancels a minibuffer edit or help dialog in progress.
'CTRL-l' redraws the screen and centers the selection if possible
(selections near the top won't be centered, since we don't scroll above
the top).
'g' reloads from the data file(s) and updates the current screen and 'g' reloads from the data file(s) and updates the current screen and
any previous screens. (With large files, this could cause a noticeable any previous screens. (With large files, this could cause a noticeable
pause.) pause.)
@ -361,19 +365,19 @@ to cancel the reload attempt.)
 
Tag Table: Tag Table:
Node: Top73 Node: Top73
Node: OPTIONS831 Node: OPTIONS825
Ref: #options930 Ref: #options924
Node: KEYS3671 Node: KEYS3665
Ref: #keys3768 Ref: #keys3762
Node: SCREENS6357 Node: SCREENS6558
Ref: #screens6444 Ref: #screens6645
Node: Accounts screen6534 Node: Accounts screen6735
Ref: #accounts-screen6664 Ref: #accounts-screen6865
Node: Register screen8894 Node: Register screen9095
Ref: #register-screen9051 Ref: #register-screen9252
Node: Transaction screen11125 Node: Transaction screen11326
Ref: #transaction-screen11285 Ref: #transaction-screen11486
Node: Error screen12155 Node: Error screen12356
Ref: #error-screen12279 Ref: #error-screen12480
 
End Tag Table End Tag Table

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

@ -151,45 +151,50 @@ KEYS
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 movement keys are also supported. down through lists. Vi-style (h/j/k/l) and Emacs-style
A tip: movement speed is limited by your keyboard repeat rate, to move (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also supported. A tip:
faster you may want to adjust it. (If you're on a mac, the Karabiner movement speed is limited by your keyboard repeat rate, to move faster
app is one way to do that.) you may want to adjust it. (If you're on a mac, the Karabiner app is
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.
g reloads from the data file(s) and updates the current screen and any CTRL-l redraws the screen and centers the selection if possible (selec-
previous screens. (With large files, this could cause a noticeable tions near the top won't be centered, since we don't scroll above the
top).
g reloads from the data file(s) and updates the current screen and any
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.
@ -198,44 +203,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.
@ -244,65 +249,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.)
@ -310,17 +315,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).
@ -328,13 +333,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.
@ -342,7 +347,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)
@ -356,7 +361,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)
@ -364,4 +369,4 @@ SEE ALSO
hledger-ui 1.2.98 June 2017 hledger-ui(1) hledger-ui 1.3 June 2017 hledger-ui(1)

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

@ -1,5 +1,5 @@
.TH "hledger\-web" "1" "June 2017" "hledger\-web 1.2.98" "hledger User Manuals" .TH "hledger\-web" "1" "June 2017" "hledger\-web 1.3" "hledger User Manuals"

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

@ -3,8 +3,8 @@ This is hledger-web.1.info, produced by makeinfo version 6.0 from stdin.
 
File: hledger-web.1.info, Node: Top, Next: OPTIONS, Up: (dir) File: hledger-web.1.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-web(1) hledger-web 1.2.98 hledger-web(1) hledger-web 1.3
********************************* ******************************
hledger-web is hledger's web interface. It starts a simple web hledger-web is hledger's web interface. It starts a simple web
application for browsing and adding transactions, and optionally opens application for browsing and adding transactions, and optionally opens
@ -201,7 +201,7 @@ options as shown above.
 
Tag Table: Tag Table:
Node: Top74 Node: Top74
Node: OPTIONS3162 Node: OPTIONS3156
Ref: #options3249 Ref: #options3243
 
End Tag Table End Tag Table

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

@ -237,4 +237,4 @@ SEE ALSO
hledger-web 1.2.98 June 2017 hledger-web(1) hledger-web 1.3 June 2017 hledger-web(1)

2
hledger/doc/hledger.1
View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger" "1" "June 2017" "hledger 1.2.98" "hledger User Manuals" .TH "hledger" "1" "June 2017" "hledger 1.3" "hledger User Manuals"

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

@ -3,8 +3,8 @@ This is hledger.1.info, produced by makeinfo version 6.0 from stdin.
 
File: hledger.1.info, Node: Top, Next: EXAMPLES, Up: (dir) File: hledger.1.info, Node: Top, Next: EXAMPLES, Up: (dir)
hledger(1) hledger 1.2.98 hledger(1) hledger 1.3
************************* **********************
This is hledger's command-line interface (there are also curses and web This is hledger's command-line interface (there are also curses and web
interfaces). Its basic function is to read a plain text file describing interfaces). Its basic function is to read a plain text file describing
@ -2113,129 +2113,129 @@ transactions.
 
Tag Table: Tag Table:
Node: Top70 Node: Top70
Node: EXAMPLES1892 Node: EXAMPLES1886
Ref: #examples1994 Ref: #examples1988
Node: OPTIONS3640 Node: OPTIONS3634
Ref: #options3744 Ref: #options3738
Node: General options4025 Node: General options4019
Ref: #general-options4152 Ref: #general-options4146
Node: Command options6690 Node: Command options6684
Ref: #command-options6843 Ref: #command-options6837
Node: Command arguments7241 Node: Command arguments7235
Ref: #command-arguments7401 Ref: #command-arguments7395
Node: Special characters7522 Node: Special characters7516
Ref: #special-characters7680 Ref: #special-characters7674
Node: Input files8848 Node: Input files8842
Ref: #input-files8986 Ref: #input-files8980
Node: Smart dates10949 Node: Smart dates10943
Ref: #smart-dates11092 Ref: #smart-dates11086
Node: Report start & end date12071 Node: Report start & end date12065
Ref: #report-start-end-date12243 Ref: #report-start-end-date12237
Node: Report intervals13309 Node: Report intervals13303
Ref: #report-intervals13474 Ref: #report-intervals13468
Node: Period expressions13875 Node: Period expressions13869
Ref: #period-expressions14035 Ref: #period-expressions14029
Node: Depth limiting16375 Node: Depth limiting16369
Ref: #depth-limiting16521 Ref: #depth-limiting16515
Node: Pivoting16722 Node: Pivoting16716
Ref: #pivoting16842 Ref: #pivoting16836
Node: Cost18613 Node: Cost18607
Ref: #cost18723 Ref: #cost18717
Node: Market value18841 Node: Market value18835
Ref: #market-value18978 Ref: #market-value18972
Node: Regular expressions20278 Node: Regular expressions20272
Ref: #regular-expressions20416 Ref: #regular-expressions20410
Node: QUERIES21777 Node: QUERIES21771
Ref: #queries21881 Ref: #queries21875
Node: COMMANDS25546 Node: COMMANDS25540
Ref: #commands25660 Ref: #commands25654
Node: accounts26333 Node: accounts26327
Ref: #accounts26433 Ref: #accounts26427
Node: activity27415 Node: activity27409
Ref: #activity27527 Ref: #activity27521
Node: add27886 Node: add27880
Ref: #add27987 Ref: #add27981
Node: balance30645 Node: balance30639
Ref: #balance30758 Ref: #balance30752
Node: Flat mode33773 Node: Flat mode33767
Ref: #flat-mode33900 Ref: #flat-mode33894
Node: Depth limited balance reports34320 Node: Depth limited balance reports34314
Ref: #depth-limited-balance-reports34523 Ref: #depth-limited-balance-reports34517
Node: Multicolumn balance reports34943 Node: Multicolumn balance reports34937
Ref: #multicolumn-balance-reports35154 Ref: #multicolumn-balance-reports35148
Node: Custom balance output39802 Node: Custom balance output39796
Ref: #custom-balance-output39986 Ref: #custom-balance-output39980
Node: Colour support42079 Node: Colour support42073
Ref: #colour-support42240 Ref: #colour-support42234
Node: Output destination42413 Node: Output destination42407
Ref: #output-destination42571 Ref: #output-destination42565
Node: CSV output42841 Node: CSV output42835
Ref: #csv-output42960 Ref: #csv-output42954
Node: balancesheet43357 Node: balancesheet43351
Ref: #balancesheet43485 Ref: #balancesheet43479
Node: cashflow45392 Node: cashflow45386
Ref: #cashflow45509 Ref: #cashflow45503
Node: help47377 Node: help47371
Ref: #help47489 Ref: #help47483
Node: incomestatement48327 Node: incomestatement48321
Ref: #incomestatement48457 Ref: #incomestatement48451
Node: info50349 Node: info50343
Ref: #info50456 Ref: #info50450
Node: man50820 Node: man50814
Ref: #man50917 Ref: #man50911
Node: print51322 Node: print51316
Ref: #print51427 Ref: #print51421
Node: register55183 Node: register55177
Ref: #register55296 Ref: #register55290
Node: Custom register output59792 Node: Custom register output59786
Ref: #custom-register-output59923 Ref: #custom-register-output59917
Node: stats61220 Node: stats61214
Ref: #stats61326 Ref: #stats61320
Node: test62207 Node: test62201
Ref: #test62294 Ref: #test62288
Node: ADD-ON COMMANDS62662 Node: ADD-ON COMMANDS62656
Ref: #add-on-commands62774 Ref: #add-on-commands62768
Node: Official add-ons64061 Node: Official add-ons64055
Ref: #official-add-ons64203 Ref: #official-add-ons64197
Node: api64290 Node: api64284
Ref: #api64381 Ref: #api64375
Node: ui64433 Node: ui64427
Ref: #ui64534 Ref: #ui64528
Node: web64592 Node: web64586
Ref: #web64683 Ref: #web64677
Node: Third party add-ons64729 Node: Third party add-ons64723
Ref: #third-party-add-ons64906 Ref: #third-party-add-ons64900
Node: diff65041 Node: diff65035
Ref: #diff65140 Ref: #diff65134
Node: iadd65239 Node: iadd65233
Ref: #iadd65355 Ref: #iadd65349
Node: interest65438 Node: interest65432
Ref: #interest65561 Ref: #interest65555
Node: irr65656 Node: irr65650
Ref: #irr65756 Ref: #irr65750
Node: Experimental add-ons65834 Node: Experimental add-ons65828
Ref: #experimental-add-ons65988 Ref: #experimental-add-ons65982
Node: autosync66381 Node: autosync66375
Ref: #autosync66495 Ref: #autosync66489
Node: budget66734 Node: budget66728
Ref: #budget66858 Ref: #budget66852
Node: chart66924 Node: chart66918
Ref: #chart67043 Ref: #chart67037
Node: check67114 Node: check67108
Ref: #check67238 Ref: #check67232
Node: check-dates67305 Node: check-dates67299
Ref: #check-dates67447 Ref: #check-dates67441
Node: check-dupes67520 Node: check-dupes67514
Ref: #check-dupes67663 Ref: #check-dupes67657
Node: equity67740 Node: equity67734
Ref: #equity67868 Ref: #equity67862
Node: prices67987 Node: prices67981
Ref: #prices68116 Ref: #prices68110
Node: print-unique68171 Node: print-unique68165
Ref: #print-unique68320 Ref: #print-unique68314
Node: register-match68413 Node: register-match68407
Ref: #register-match68569 Ref: #register-match68563
Node: rewrite68667 Node: rewrite68661
Ref: #rewrite68788 Ref: #rewrite68782
 
End Tag Table End Tag Table

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

@ -1878,4 +1878,4 @@ SEE ALSO
hledger 1.2.98 June 2017 hledger(1) hledger 1.3 June 2017 hledger(1)