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

12
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,6 +123,16 @@ 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

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

10
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

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

10
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

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

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

@ -116,14 +116,8 @@ OPTIONS
General help options: General 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