doc: bump version to 1.3, update builtin manuals

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

View File

@ -8,7 +8,7 @@ m4_define({{_webcombined_}}, m4_ifdef({{WEB && COMBINED}},{{$1}}) )m4_dnl
m4_dnl
m4_define({{_author_}}, {{}})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 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.
@ -20,6 +20,7 @@ This doc is for version **_version_**.
m4_dnl Too painful for static generation, insert from site.js instead
m4_dnl Available versions:
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.1/$1.html">1.1</a>
m4_dnl | <a href="/doc/1.0/$1.html">1.0</a>

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"

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)
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
web apps operating on hledger data. It comes with a series of simple
@ -73,7 +73,7 @@ options as shown above.

Tag Table:
Node: Top74
Node: OPTIONS1226
Ref: #options1313
Node: OPTIONS1220
Ref: #options1307

End Tag Table

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)

View File

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

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"

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)
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
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:
Node: Top74
Node: CSV RULES816
Ref: #csv-rules926
Node: skip1169
Ref: #skip1265
Node: date-format1437
Ref: #date-format1566
Node: field list2072
Ref: #field-list2211
Node: field assignment2916
Ref: #field-assignment3073
Node: conditional block3577
Ref: #conditional-block3733
Node: include4629
Ref: #include4740
Node: CSV TIPS4971
Ref: #csv-tips5067
Node: CSV RULES810
Ref: #csv-rules920
Node: skip1163
Ref: #skip1259
Node: date-format1431
Ref: #date-format1560
Node: field list2066
Ref: #field-list2205
Node: field assignment2910
Ref: #field-assignment3067
Node: conditional block3571
Ref: #conditional-block3727
Node: include4623
Ref: #include4734
Node: CSV TIPS4965
Ref: #csv-tips5061

End Tag Table

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)

View File

@ -1,6 +1,6 @@
.\"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
(optional) a status character (empty, \f[C]!\f[], or \f[C]*\f[])
.IP \[bu] 2
(optional) a transaction code (any short number or text, eg a check
number)
(optional) a transaction code (any short number or text, enclosed in
parentheses)
.IP \[bu] 2
(optional) a transaction description (any remaining text until end of
line)

View File

@ -4,8 +4,8 @@ stdin.

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
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:
* (optional) a status character (empty, '!', or '*')
* (optional) a transaction code (any short number or text, eg a check
number)
* (optional) a transaction code (any short number or text, enclosed
in parentheses)
* (optional) a transaction description (any remaining text until end
of line)
@ -1047,10 +1047,10 @@ Text Wrangler https://github.com/ledger/ledger/wiki/Editing-Ledger-files-wit

Tag Table:
Node: Top78
Node: FILE FORMAT2298
Ref: #file-format2424
Node: Transactions2631
Ref: #transactions2754
Node: FILE FORMAT2292
Ref: #file-format2418
Node: Transactions2625
Ref: #transactions2748
Node: Postings3313
Ref: #postings3442
Node: Dates4437

View File

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

View File

@ -4,8 +4,8 @@ stdin.

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
of) timeclock.el's format, containing clock-in and clock-out entries as

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)

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"

View File

@ -4,8 +4,8 @@ stdin.

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
(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:
Node: Top78
Node: FILE FORMAT888
Ref: #file-format991
Node: FILE FORMAT882
Ref: #file-format985

End Tag Table

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)

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,
\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.
Vi\-style \f[C]h\f[]/\f[C]j\f[]/\f[C]k\f[]/\f[C]l\f[] movement keys are
also supported.
Vi\-style (\f[C]h\f[]/\f[C]j\f[]/\f[C]k\f[]/\f[C]l\f[]) and Emacs\-style
(\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
faster you may want to adjust it.
(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.
Or, it cancels a minibuffer edit or help dialog in progress.
.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
and any previous screens.
(With large files, this could cause a noticeable pause.)

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)
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
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'
returns to the previous screen, 'up'/'down'/'page up'/'page
down'/'home'/'end' move up and down through lists. Vi-style
'h'/'j'/'k'/'l' movement keys are also supported. A tip: movement speed
is limited by your keyboard repeat rate, to move faster you may want to
adjust it. (If you're on a mac, the Karabiner app is one way to do
that.)
('h'/'j'/'k'/'l') and Emacs-style ('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 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 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,
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
any previous screens. (With large files, this could cause a noticeable
pause.)
@ -361,19 +365,19 @@ to cancel the reload attempt.)

Tag Table:
Node: Top73
Node: OPTIONS831
Ref: #options930
Node: KEYS3671
Ref: #keys3768
Node: SCREENS6357
Ref: #screens6444
Node: Accounts screen6534
Ref: #accounts-screen6664
Node: Register screen8894
Ref: #register-screen9051
Node: Transaction screen11125
Ref: #transaction-screen11285
Node: Error screen12155
Ref: #error-screen12279
Node: OPTIONS825
Ref: #options924
Node: KEYS3665
Ref: #keys3762
Node: SCREENS6558
Ref: #screens6645
Node: Accounts screen6735
Ref: #accounts-screen6865
Node: Register screen9095
Ref: #register-screen9252
Node: Transaction screen11326
Ref: #transaction-screen11486
Node: Error screen12356
Ref: #error-screen12480

End Tag Table

View File

@ -151,10 +151,11 @@ KEYS
The cursor keys navigate: right (or enter) goes deeper, left returns to
the previous screen, up/down/page up/page down/home/end move up and
down through lists. Vi-style h/j/k/l movement keys are also supported.
A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust it. (If you're on a mac, the Karabiner
app is one way to do that.)
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:
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
one way to do that.)
With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown).
@ -176,6 +177,10 @@ KEYS
ESCAPE removes all filters and jumps back to the top screen. Or, it
cancels a minibuffer edit or help dialog in progress.
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
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.)
@ -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)

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"

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)
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
application for browsing and adding transactions, and optionally opens
@ -201,7 +201,7 @@ options as shown above.

Tag Table:
Node: Top74
Node: OPTIONS3162
Ref: #options3249
Node: OPTIONS3156
Ref: #options3243

End Tag Table

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)

View File

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

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)
hledger(1) hledger 1.2.98
*************************
hledger(1) hledger 1.3
**********************
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
@ -2113,129 +2113,129 @@ transactions.

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

End Tag Table

View File

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