Skip to content

Commit

Permalink
;doc: update manuals
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed Mar 25, 2024
1 parent 70b75e4 commit 76f98f2
Show file tree
Hide file tree
Showing 12 changed files with 4,058 additions and 3,603 deletions.
2 changes: 1 addition & 1 deletion hledger-lib/.date.m4
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{February 2024}})m4_dnl
m4_define({{_monthyear_}}, {{March 2024}})m4_dnl
2 changes: 1 addition & 1 deletion hledger-ui/.date.m4
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{February 2024}})m4_dnl
m4_define({{_monthyear_}}, {{March 2024}})m4_dnl
2 changes: 1 addition & 1 deletion hledger-ui/hledger-ui.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

.TH "HLEDGER\-UI" "1" "February 2024" "hledger-ui-1.32.99 " "hledger User Manuals"
.TH "HLEDGER\-UI" "1" "March 2024" "hledger-ui-1.32.99 " "hledger User Manuals"



Expand Down
2 changes: 1 addition & 1 deletion hledger-ui/hledger-ui.txt
Original file line number Diff line number Diff line change
Expand Up @@ -535,4 +535,4 @@ LICENSE
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)

hledger-ui-1.32.99 February 2024 HLEDGER-UI(1)
hledger-ui-1.32.99 March 2024 HLEDGER-UI(1)
2 changes: 1 addition & 1 deletion hledger-web/.date.m4
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{February 2024}})m4_dnl
m4_define({{_monthyear_}}, {{March 2024}})m4_dnl
11 changes: 10 additions & 1 deletion hledger-web/hledger-web.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

.TH "HLEDGER\-WEB" "1" "February 2024" "hledger-web-1.32.99 " "hledger User Manuals"
.TH "HLEDGER\-WEB" "1" "March 2024" "hledger-web-1.32.99 " "hledger User Manuals"



Expand Down Expand Up @@ -128,6 +128,15 @@ hledger\-web also supports many of hledger\[aq]s general options.
Query options and arguments may be used to set an initial filter, which
although not shown in the UI, will restrict the data shown, in addition
to any search query entered in the UI.
.PP
Note that hledger\-web shows accounts with zero balances by default,
like \f[CR]hledger\-ui\f[R] (and unlike \f[CR]hledger\f[R]).
Using the \f[CR]\-E/\-\-empty\f[R] flag at startup will hide them.
.PP
If you see accounts which appear to have a zero balance, but cannot be
hidden with \f[CR]\-E\f[R]: these have a mixed\-cost balance which looks
like zero when costs are hidden.
Currently hledger\-web does not show costs at all.
.SS General help options
.TP
\f[CR]\-h \-\-help\f[R]
Expand Down
53 changes: 31 additions & 22 deletions hledger-web/hledger-web.info
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,15 @@ options and arguments may be used to set an initial filter, which
although not shown in the UI, will restrict the data shown, in addition
to any search query entered in the UI.

Note that hledger-web shows accounts with zero balances by default,
like 'hledger-ui' (and unlike 'hledger'). Using the '-E/--empty' flag
at startup will hide them.

If you see accounts which appear to have a zero balance, but cannot
be hidden with '-E': these have a mixed-cost balance which looks like
zero when costs are hidden. Currently hledger-web does not show costs
at all.

* Menu:

* General help options::
Expand Down Expand Up @@ -631,28 +640,28 @@ Tag Table:
Node: Top223
Node: OPTIONS2578
Ref: #options2683
Node: General help options5257
Ref: #general-help-options5407
Node: General input options5689
Ref: #general-input-options5875
Node: General reporting options6532
Ref: #general-reporting-options6697
Node: PERMISSIONS10087
Ref: #permissions10226
Node: EDITING UPLOADING DOWNLOADING11438
Ref: #editing-uploading-downloading11619
Node: RELOADING12453
Ref: #reloading12587
Node: JSON API13020
Ref: #json-api13135
Node: DEBUG OUTPUT18623
Ref: #debug-output18748
Node: Debug output18775
Ref: #debug-output-118876
Node: ENVIRONMENT19293
Ref: #environment19412
Node: BUGS19529
Ref: #bugs19613
Node: General help options5648
Ref: #general-help-options5798
Node: General input options6080
Ref: #general-input-options6266
Node: General reporting options6923
Ref: #general-reporting-options7088
Node: PERMISSIONS10478
Ref: #permissions10617
Node: EDITING UPLOADING DOWNLOADING11829
Ref: #editing-uploading-downloading12010
Node: RELOADING12844
Ref: #reloading12978
Node: JSON API13411
Ref: #json-api13526
Node: DEBUG OUTPUT19014
Ref: #debug-output19139
Node: Debug output19166
Ref: #debug-output-119267
Node: ENVIRONMENT19684
Ref: #environment19803
Node: BUGS19920
Ref: #bugs20004

End Tag Table

Expand Down
Loading

0 comments on commit 76f98f2

Please sign in to comment.