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

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2021-09-20 16:56:36 -10:00
parent 44d494af07
commit 9cae7a076a
9 changed files with 2075 additions and 2016 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hledger-ui/hledger-ui.1
View File

@ -173,6 +173,10 @@ generate future transactions from periodic transaction rules, for the
next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible.
.TP
\f[B]\f[CB]--commodity-style\f[B]\f[R]
Override the commodity style in the output for the specified commodity.
For example \[aq]EUR1.000,00\[aq].
.TP
\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R]
Should color-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting

52
hledger-ui/hledger-ui.info
View File

@ -193,6 +193,10 @@ the data.
generate future transactions from periodic transaction rules, for
the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
'--commodity-style'
Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'.
'--color=WHEN (or --colour=WHEN)'
Should color-supporting commands use ANSI color codes in text
@ -600,30 +604,30 @@ Tag Table:
Node: Top221
Node: OPTIONS1647
Ref: #options1744
Node: KEYS6244
Ref: #keys6339
Node: SCREENS10410
Ref: #screens10508
Node: Accounts screen10598
Ref: #accounts-screen10726
Node: Register screen12941
Ref: #register-screen13096
Node: Transaction screen15093
Ref: #transaction-screen15251
Node: Error screen16121
Ref: #error-screen16243
Node: TIPS16487
Ref: #tips16586
Node: Watch mode16638
Ref: #watch-mode16755
Node: Watch mode limitations17501
Ref: #watch-mode-limitations17642
Node: ENVIRONMENT18778
Ref: #environment18889
Node: FILES19696
Ref: #files19795
Node: BUGS20008
Ref: #bugs20085
Node: KEYS6375
Ref: #keys6470
Node: SCREENS10541
Ref: #screens10639
Node: Accounts screen10729
Ref: #accounts-screen10857
Node: Register screen13072
Ref: #register-screen13227
Node: Transaction screen15224
Ref: #transaction-screen15382
Node: Error screen16252
Ref: #error-screen16374
Node: TIPS16618
Ref: #tips16717
Node: Watch mode16769
Ref: #watch-mode16886
Node: Watch mode limitations17632
Ref: #watch-mode-limitations17773
Node: ENVIRONMENT18909
Ref: #environment19020
Node: FILES19827
Ref: #files19926
Node: BUGS20139
Ref: #bugs20216

End Tag Table

4
hledger-ui/hledger-ui.txt
View File

@ -170,6 +170,10 @@ OPTIONS
for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
--commodity-style
Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'.
--color=WHEN (or --colour=WHEN)
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a color-

4
hledger-web/hledger-web.1
View File

@ -202,6 +202,10 @@ generate future transactions from periodic transaction rules, for the
next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible.
.TP
\f[B]\f[CB]--commodity-style\f[B]\f[R]
Override the commodity style in the output for the specified commodity.
For example \[aq]EUR1.000,00\[aq].
.TP
\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R]
Should color-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting

32
hledger-web/hledger-web.info
View File

@ -219,6 +219,10 @@ before options, as shown in the synopsis above.
generate future transactions from periodic transaction rules, for
the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
'--commodity-style'
Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'.
'--color=WHEN (or --colour=WHEN)'
Should color-supporting commands use ANSI color codes in text
@ -609,20 +613,20 @@ Tag Table:
Node: Top223
Node: OPTIONS1889
Ref: #options1994
Node: PERMISSIONS9526
Ref: #permissions9665
Node: EDITING UPLOADING DOWNLOADING10877
Ref: #editing-uploading-downloading11058
Node: RELOADING11892
Ref: #reloading12026
Node: JSON API12459
Ref: #json-api12573
Node: ENVIRONMENT18063
Ref: #environment18179
Node: FILES18912
Ref: #files19012
Node: BUGS19225
Ref: #bugs19303
Node: PERMISSIONS9657
Ref: #permissions9796
Node: EDITING UPLOADING DOWNLOADING11008
Ref: #editing-uploading-downloading11189
Node: RELOADING12023
Ref: #reloading12157
Node: JSON API12590
Ref: #json-api12704
Node: ENVIRONMENT18194
Ref: #environment18310
Node: FILES19043
Ref: #files19143
Node: BUGS19356
Ref: #bugs19434

End Tag Table

4
hledger-web/hledger-web.txt
View File

@ -193,6 +193,10 @@ OPTIONS
for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
--commodity-style
Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'.
--color=WHEN (or --colour=WHEN)
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a color-

17
hledger/hledger.1
View File

@ -195,6 +195,10 @@ generate future transactions from periodic transaction rules, for the
next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible.
.TP
\f[B]\f[CB]--commodity-style\f[B]\f[R]
Override the commodity style in the output for the specified commodity.
For example \[aq]EUR1.000,00\[aq].
.TP
\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R]
Should color-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting
@ -2375,10 +2379,13 @@ probably want to either clear tables of existing data (via
completely as otherwise your postings will be duped.
.SS Commodity styles
.PP
The display style of a commodity/currence is inferred according to the
The display style of a commodity/currency is inferred according to the
rules described in Commodity display style.
The inferred display style can be overriden by an optional
\f[C]-c/--commodity-style\f[R] option.
The inferred display style can be overridden by an optional
\f[C]-c/--commodity-style\f[R] option (Exceptions: as is the case for
inferred styles, price amounts, and all amounts displayed by the
\f[C]print\f[R] command, will be displayed with all of their decimal
digits visible, regardless of the specified precision).
For example, the following will override the display style for dollars.
.IP
.nf
@ -8347,7 +8354,9 @@ Assigning to \f[C]date\f[R] sets the transaction date.
\f[C]commentN\f[R], where N is a number, sets the Nth posting\[aq]s
comment.
.PP
Tips: - Only single-line comments can be assigned.
Tips: - You can assign multi-line comments by writing literal
\f[C]\[rs]n\f[R] in the code.
A comment starting with \f[C]\[rs]n\f[R] will begin on a new line.
- Comments can contain tags, as usual.
.SS account field
.PP

1022
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

44
hledger/hledger.txt
View File

@ -183,6 +183,10 @@ OPTIONS
for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
--commodity-style
Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'.
--color=WHEN (or --colour=WHEN)
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a color-
@ -542,6 +546,8 @@ TIME PERIODS
201813 6 digits with an invalid month is parsed as start of
6-digit year
20181301 8 digits with an invalid month is parsed as start of
8-digit year
20181232 8 digits with an invalid day gives an error
@ -679,6 +685,7 @@ TIME PERIODS
1, 2009
-p "from 2009/1" the same
-p "from 2009" the same
-p "to 2009" everything before january
1, 2009
@ -688,8 +695,6 @@ TIME PERIODS
-p "2009" the year 2009; equivalent
to "2009/1/1 to 2010/1/1"
-p "2009/1" the month of jan; equiva-
lent to "2009/1/1 to
2009/2/1"
@ -1338,7 +1343,6 @@ VALUATION
ing amounts cost period ends in interval, val- period ends DATE/today
with report ued at interval
interval start
running sum/average sum/average sum/average of sum/average sum/average
total/average of displayed of displayed displayed values of displayed of displayed
values values values values
@ -1372,6 +1376,13 @@ VALUATION
is, bs postings in period at respec- each period, sums of post-
--change, cf period tive posting valued at ings
--change) dates period ends
end balances sums of same as sums of values of period end value at
(bal -H, is costs of --value=end postings from balances, DATE/today of
--H, bs, cf) postings before period valued at sums of post-
@ -1548,10 +1559,13 @@ OUTPUT
or drop tables completely as otherwise your postings will be duped.
Commodity styles
The display style of a commodity/currence is inferred according to the
The display style of a commodity/currency is inferred according to the
rules described in Commodity display style. The inferred display style
can be overriden by an optional -c/--commodity-style option. For exam-
ple, the following will override the display style for dollars.
can be overridden by an optional -c/--commodity-style option (Excep-
tions: as is the case for inferred styles, price amounts, and all
amounts displayed by the print command, will be displayed with all of
their decimal digits visible, regardless of the specified precision).
For example, the following will override the display style for dollars.
$ hledger print -c '$1.000,0'
@ -2326,7 +2340,6 @@ COMMANDS
period end ues from report from report report start
start to period start to period to period end
end end
--his- change from sum of posting- period-end DATE-value of
torical journal start to date market val- value of change change from
/-H period end (his- ues from journal from journal journal start
@ -2947,6 +2960,8 @@ COMMANDS
-e 2021-01-01 end dates are exclusive
-e 2021 equivalent, per smart
dates
-p 2020 equivalent, the period's
begin date is ignored
date:2020 equivalent query
@ -4778,6 +4793,12 @@ JOURNAL FORMAT
ment until end of cur-
rent file or end
directive
commod- format declare a commodity and its number notation:
ity number notation & display following entries
style until end of cur-
@ -4785,10 +4806,6 @@ JOURNAL FORMAT
style: amounts of
that commodity in
reports
D declare a commodity to be default commodity:
used for commodityless following commod-
amounts, and its number ityless entries
@ -6115,8 +6132,9 @@ CSV FORMAT
commentN, where N is a number, sets the Nth posting's comment.
Tips: - Only single-line comments can be assigned. - Comments can con-
tain tags, as usual.
Tips: - You can assign multi-line comments by writing literal \n in the
code. A comment starting with \n will begin on a new line. - Comments
can contain tags, as usual.
account field
Assigning to accountN, where N is 1 to 99, sets the account name of the