doc: update manuals
This commit is contained in:
parent
fcfa7ed78a
commit
0bf0c30b8d
@ -1,2 +1,2 @@
|
|||||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||||
m4_define({{_monthyear_}}, {{September 2023}})m4_dnl
|
m4_define({{_monthyear_}}, {{November 2023}})m4_dnl
|
||||||
|
|||||||
@ -1,2 +1,2 @@
|
|||||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||||
m4_define({{_monthyear_}}, {{September 2023}})m4_dnl
|
m4_define({{_monthyear_}}, {{November 2023}})m4_dnl
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
.TH "HLEDGER-UI" "1" "September 2023" "hledger-ui-1.31.99 " "hledger User Manuals"
|
.TH "HLEDGER-UI" "1" "November 2023" "hledger-ui-1.31.99 " "hledger User Manuals"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -347,25 +347,28 @@ current transaction when invoked from the register and transaction
|
|||||||
screens, and at the error location (if possible) when invoked from the
|
screens, and at the error location (if possible) when invoked from the
|
||||||
error screen.
|
error screen.
|
||||||
.PP
|
.PP
|
||||||
\f[V]B\f[R] toggles cost mode, showing amounts in their cost\[aq]s
|
\f[V]B\f[R] toggles cost mode, showing amounts converted to their
|
||||||
commodity (like toggling the \f[V]-B/--cost\f[R] flag).
|
cost\[aq]s commodity (see hledger manual > Cost reporting.
|
||||||
.PP
|
.PP
|
||||||
\f[V]V\f[R] toggles value mode, showing amounts\[aq] current market
|
\f[V]V\f[R] toggles value mode, showing amounts converted to their
|
||||||
value in their default valuation commodity (like toggling the
|
market value (see hledger manual > Valuation flag).
|
||||||
\f[V]-V/--market\f[R] flag).
|
More specifically,
|
||||||
Note, \[dq]current market value\[dq] means the value on the report end
|
.IP "1." 3
|
||||||
date if specified, otherwise today.
|
By default, the \f[V]V\f[R] key toggles showing end value
|
||||||
To see the value on another date, you can temporarily set that as the
|
(\f[V]--value=end\f[R]) on or off.
|
||||||
report end date.
|
The valuation date will be the report end date if specified, otherwise
|
||||||
Eg: to see a transaction as it was valued on july 30, go to the accounts
|
today.
|
||||||
or register screen, press \f[V]/\f[R], and add \f[V]date:-7/30\f[R] to
|
.IP "2." 3
|
||||||
the query.
|
If you started hledger-ui with some other valuation (such as
|
||||||
|
\f[V]--value=then,EUR\f[R]), the \f[V]V\f[R] key toggles that off or on.
|
||||||
.PP
|
.PP
|
||||||
At most one of cost or value mode can be active at once.
|
Cost/value tips: - When showing end value, you can change the report end
|
||||||
.PP
|
date without restarting, by pressing \f[V]/\f[R] and adding a query like
|
||||||
There\[aq]s not yet any visual reminder when cost or value mode is
|
\f[V]date:..YYYY-MM-DD\f[R].
|
||||||
active; for now pressing \f[V]b\f[R] \f[V]b\f[R] \f[V]v\f[R] should
|
- Either cost mode, or value mode, can be active, but not both at once.
|
||||||
reliably reset to normal mode.
|
Cost mode takes precedence.
|
||||||
|
- There\[aq]s not yet any visual indicator that cost or value mode is
|
||||||
|
active, other than the amount values.
|
||||||
.PP
|
.PP
|
||||||
\f[V]q\f[R] quits the application.
|
\f[V]q\f[R] quits the application.
|
||||||
.PP
|
.PP
|
||||||
@ -436,6 +439,13 @@ This will be the running historical balance (what you would see on a
|
|||||||
bank\[aq]s website, eg) if not disturbed by a query.
|
bank\[aq]s website, eg) if not disturbed by a query.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
|
Note, this screen combines each transaction\[aq]s in-period postings to
|
||||||
|
a single line item, dated with the earliest in-period transaction or
|
||||||
|
posting date (like hledger\[aq]s \f[V]aregister\f[R]).
|
||||||
|
So custom posting dates can cause the running balance to be temporarily
|
||||||
|
inaccurate.
|
||||||
|
(See hledger manual > aregister and posting dates.)
|
||||||
|
.PP
|
||||||
Transactions affecting this account\[aq]s subaccounts will be included
|
Transactions affecting this account\[aq]s subaccounts will be included
|
||||||
in the register if the accounts screen is in tree mode, or if it\[aq]s
|
in the register if the accounts screen is in tree mode, or if it\[aq]s
|
||||||
in list mode but this account has subaccounts which are not shown due to
|
in list mode but this account has subaccounts which are not shown due to
|
||||||
|
|||||||
@ -377,22 +377,25 @@ cursor will be positioned at the current transaction when invoked from
|
|||||||
the register and transaction screens, and at the error location (if
|
the register and transaction screens, and at the error location (if
|
||||||
possible) when invoked from the error screen.
|
possible) when invoked from the error screen.
|
||||||
|
|
||||||
'B' toggles cost mode, showing amounts in their cost's commodity
|
'B' toggles cost mode, showing amounts converted to their cost's
|
||||||
(like toggling the '-B/--cost' flag).
|
commodity (see hledger manual > Cost reporting.
|
||||||
|
|
||||||
'V' toggles value mode, showing amounts' current market value in
|
'V' toggles value mode, showing amounts converted to their market
|
||||||
their default valuation commodity (like toggling the '-V/--market'
|
value (see hledger manual > Valuation flag). More specifically,
|
||||||
flag). Note, "current market value" means the value on the report end
|
|
||||||
date if specified, otherwise today. To see the value on another date,
|
|
||||||
you can temporarily set that as the report end date. Eg: to see a
|
|
||||||
transaction as it was valued on july 30, go to the accounts or register
|
|
||||||
screen, press '/', and add 'date:-7/30' to the query.
|
|
||||||
|
|
||||||
At most one of cost or value mode can be active at once.
|
1. By default, the 'V' key toggles showing end value ('--value=end')
|
||||||
|
on or off. The valuation date will be the report end date if
|
||||||
|
specified, otherwise today.
|
||||||
|
|
||||||
There's not yet any visual reminder when cost or value mode is
|
2. If you started hledger-ui with some other valuation (such as
|
||||||
active; for now pressing 'b' 'b' 'v' should reliably reset to normal
|
'--value=then,EUR'), the 'V' key toggles that off or on.
|
||||||
mode.
|
|
||||||
|
Cost/value tips: - When showing end value, you can change the report
|
||||||
|
end date without restarting, by pressing '/' and adding a query like
|
||||||
|
'date:..YYYY-MM-DD'. - Either cost mode, or value mode, can be active,
|
||||||
|
but not both at once. Cost mode takes precedence. - There's not yet
|
||||||
|
any visual indicator that cost or value mode is active, other than the
|
||||||
|
amount values.
|
||||||
|
|
||||||
'q' quits the application.
|
'q' quits the application.
|
||||||
|
|
||||||
@ -500,6 +503,12 @@ line represents one transaction, and shows:
|
|||||||
historical balance (what you would see on a bank's website,
|
historical balance (what you would see on a bank's website,
|
||||||
eg) if not disturbed by a query.
|
eg) if not disturbed by a query.
|
||||||
|
|
||||||
|
Note, this screen combines each transaction's in-period postings to a
|
||||||
|
single line item, dated with the earliest in-period transaction or
|
||||||
|
posting date (like hledger's 'aregister'). So custom posting dates can
|
||||||
|
cause the running balance to be temporarily inaccurate. (See hledger
|
||||||
|
manual > aregister and posting dates.)
|
||||||
|
|
||||||
Transactions affecting this account's subaccounts will be included in
|
Transactions affecting this account's subaccounts will be included in
|
||||||
the register if the accounts screen is in tree mode, or if it's in list
|
the register if the accounts screen is in tree mode, or if it's in list
|
||||||
mode but this account has subaccounts which are not shown due to a depth
|
mode but this account has subaccounts which are not shown due to a depth
|
||||||
@ -677,34 +686,34 @@ Node: MOUSE7825
|
|||||||
Ref: #mouse7920
|
Ref: #mouse7920
|
||||||
Node: KEYS8157
|
Node: KEYS8157
|
||||||
Ref: #keys8250
|
Ref: #keys8250
|
||||||
Node: SCREENS12763
|
Node: SCREENS12905
|
||||||
Ref: #screens12861
|
Ref: #screens13003
|
||||||
Node: Menu13441
|
Node: Menu13583
|
||||||
Ref: #menu13534
|
Ref: #menu13676
|
||||||
Node: Cash accounts13729
|
Node: Cash accounts13871
|
||||||
Ref: #cash-accounts13871
|
Ref: #cash-accounts14013
|
||||||
Node: Balance sheet accounts14055
|
Node: Balance sheet accounts14197
|
||||||
Ref: #balance-sheet-accounts14236
|
Ref: #balance-sheet-accounts14378
|
||||||
Node: Income statement accounts14356
|
Node: Income statement accounts14498
|
||||||
Ref: #income-statement-accounts14542
|
Ref: #income-statement-accounts14684
|
||||||
Node: All accounts14706
|
Node: All accounts14848
|
||||||
Ref: #all-accounts14852
|
Ref: #all-accounts14994
|
||||||
Node: Register15034
|
Node: Register15176
|
||||||
Ref: #register15158
|
Ref: #register15300
|
||||||
Node: Transaction17120
|
Node: Transaction17584
|
||||||
Ref: #transaction17243
|
Ref: #transaction17707
|
||||||
Node: Error18660
|
Node: Error19124
|
||||||
Ref: #error18754
|
Ref: #error19218
|
||||||
Node: TIPS18998
|
Node: TIPS19462
|
||||||
Ref: #tips19097
|
Ref: #tips19561
|
||||||
Node: Watch mode19139
|
Node: Watch mode19603
|
||||||
Ref: #watch-mode19246
|
Ref: #watch-mode19710
|
||||||
Node: Debug output20705
|
Node: Debug output21169
|
||||||
Ref: #debug-output20816
|
Ref: #debug-output21280
|
||||||
Node: ENVIRONMENT21028
|
Node: ENVIRONMENT21492
|
||||||
Ref: #environment21138
|
Ref: #environment21602
|
||||||
Node: BUGS21329
|
Node: BUGS21793
|
||||||
Ref: #bugs21412
|
Ref: #bugs21876
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|||||||
@ -314,21 +314,25 @@ KEYS
|
|||||||
register and transaction screens, and at the error location (if possi-
|
register and transaction screens, and at the error location (if possi-
|
||||||
ble) when invoked from the error screen.
|
ble) when invoked from the error screen.
|
||||||
|
|
||||||
B toggles cost mode, showing amounts in their cost's commodity (like
|
B toggles cost mode, showing amounts converted to their cost's commod-
|
||||||
toggling the -B/--cost flag).
|
ity (see hledger manual > Cost reporting.
|
||||||
|
|
||||||
V toggles value mode, showing amounts' current market value in their
|
V toggles value mode, showing amounts converted to their market value
|
||||||
default valuation commodity (like toggling the -V/--market flag).
|
(see hledger manual > Valuation flag). More specifically,
|
||||||
Note, "current market value" means the value on the report end date if
|
|
||||||
specified, otherwise today. To see the value on another date, you can
|
|
||||||
temporarily set that as the report end date. Eg: to see a transaction
|
|
||||||
as it was valued on july 30, go to the accounts or register screen,
|
|
||||||
press /, and add date:-7/30 to the query.
|
|
||||||
|
|
||||||
At most one of cost or value mode can be active at once.
|
1. By default, the V key toggles showing end value (--value=end) on or
|
||||||
|
off. The valuation date will be the report end date if specified,
|
||||||
|
otherwise today.
|
||||||
|
|
||||||
There's not yet any visual reminder when cost or value mode is active;
|
2. If you started hledger-ui with some other valuation (such as
|
||||||
for now pressing b b v should reliably reset to normal mode.
|
--value=then,EUR), the V key toggles that off or on.
|
||||||
|
|
||||||
|
Cost/value tips: - When showing end value, you can change the report
|
||||||
|
end date without restarting, by pressing / and adding a query like
|
||||||
|
date:..YYYY-MM-DD. - Either cost mode, or value mode, can be active,
|
||||||
|
but not both at once. Cost mode takes precedence. - There's not yet
|
||||||
|
any visual indicator that cost or value mode is active, other than the
|
||||||
|
amount values.
|
||||||
|
|
||||||
q quits the application.
|
q quits the application.
|
||||||
|
|
||||||
@ -389,6 +393,12 @@ SCREENS
|
|||||||
(what you would see on a bank's website, eg) if not disturbed by a
|
(what you would see on a bank's website, eg) if not disturbed by a
|
||||||
query.
|
query.
|
||||||
|
|
||||||
|
Note, this screen combines each transaction's in-period postings to a
|
||||||
|
single line item, dated with the earliest in-period transaction or
|
||||||
|
posting date (like hledger's aregister). So custom posting dates can
|
||||||
|
cause the running balance to be temporarily inaccurate. (See hledger
|
||||||
|
manual > aregister and posting dates.)
|
||||||
|
|
||||||
Transactions affecting this account's subaccounts will be included in
|
Transactions affecting this account's subaccounts will be included in
|
||||||
the register if the accounts screen is in tree mode, or if it's in list
|
the register if the accounts screen is in tree mode, or if it's in list
|
||||||
mode but this account has subaccounts which are not shown due to a
|
mode but this account has subaccounts which are not shown due to a
|
||||||
@ -527,4 +537,4 @@ LICENSE
|
|||||||
SEE ALSO
|
SEE ALSO
|
||||||
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
|
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
|
||||||
|
|
||||||
hledger-ui-1.31.99 September 2023 HLEDGER-UI(1)
|
hledger-ui-1.31.99 November 2023 HLEDGER-UI(1)
|
||||||
|
|||||||
@ -1,2 +1,2 @@
|
|||||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||||
m4_define({{_monthyear_}}, {{September 2023}})m4_dnl
|
m4_define({{_monthyear_}}, {{November 2023}})m4_dnl
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
.TH "HLEDGER-WEB" "1" "September 2023" "hledger-web-1.31.99 " "hledger User Manuals"
|
.TH "HLEDGER-WEB" "1" "November 2023" "hledger-web-1.31.99 " "hledger User Manuals"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -102,12 +102,11 @@ hledger-web normally serves static files itself, but if you wanted to
|
|||||||
serve them from another server for efficiency, you would set the url
|
serve them from another server for efficiency, you would set the url
|
||||||
with this.
|
with this.
|
||||||
.TP
|
.TP
|
||||||
\f[V]--capabilities=CAP[,CAP..]\f[R]
|
\f[V]--allow=view|add|edit\f[R]
|
||||||
enable the view, add, and/or manage capabilities (default: view,add)
|
set the user\[aq]s access level for changing data (default:
|
||||||
.TP
|
\f[V]add\f[R]).
|
||||||
\f[V]--capabilities-header=HTTPHEADER\f[R]
|
It also accepts \f[V]sandstorm\f[R] for use on that platform (reads
|
||||||
read capabilities to enable from a HTTP header, like
|
permissions from the \f[V]X-Sandstorm-Permissions\f[R] request header).
|
||||||
X-Sandstorm-Permissions (default: disabled)
|
|
||||||
.TP
|
.TP
|
||||||
\f[V]--test\f[R]
|
\f[V]--test\f[R]
|
||||||
run hledger-web\[aq]s tests and exit.
|
run hledger-web\[aq]s tests and exit.
|
||||||
|
|||||||
@ -110,14 +110,11 @@ will be applied in addition to any search query entered there.
|
|||||||
normally serves static files itself, but if you wanted to serve
|
normally serves static files itself, but if you wanted to serve
|
||||||
them from another server for efficiency, you would set the url with
|
them from another server for efficiency, you would set the url with
|
||||||
this.
|
this.
|
||||||
'--capabilities=CAP[,CAP..]'
|
'--allow=view|add|edit'
|
||||||
|
|
||||||
enable the view, add, and/or manage capabilities (default:
|
set the user's access level for changing data (default: 'add'). It
|
||||||
view,add)
|
also accepts 'sandstorm' for use on that platform (reads
|
||||||
'--capabilities-header=HTTPHEADER'
|
permissions from the 'X-Sandstorm-Permissions' request header).
|
||||||
|
|
||||||
read capabilities to enable from a HTTP header, like
|
|
||||||
X-Sandstorm-Permissions (default: disabled)
|
|
||||||
'--test'
|
'--test'
|
||||||
|
|
||||||
run hledger-web's tests and exit. hspec test runner args may
|
run hledger-web's tests and exit. hspec test runner args may
|
||||||
@ -648,28 +645,28 @@ Tag Table:
|
|||||||
Node: Top225
|
Node: Top225
|
||||||
Node: OPTIONS2580
|
Node: OPTIONS2580
|
||||||
Ref: #options2685
|
Ref: #options2685
|
||||||
Node: General help options5996
|
Node: General help options5973
|
||||||
Ref: #general-help-options6146
|
Ref: #general-help-options6123
|
||||||
Node: General input options6428
|
Node: General input options6405
|
||||||
Ref: #general-input-options6614
|
Ref: #general-input-options6591
|
||||||
Node: General reporting options7316
|
Node: General reporting options7293
|
||||||
Ref: #general-reporting-options7481
|
Ref: #general-reporting-options7458
|
||||||
Node: PERMISSIONS10871
|
Node: PERMISSIONS10848
|
||||||
Ref: #permissions11010
|
Ref: #permissions10987
|
||||||
Node: EDITING UPLOADING DOWNLOADING12222
|
Node: EDITING UPLOADING DOWNLOADING12199
|
||||||
Ref: #editing-uploading-downloading12403
|
Ref: #editing-uploading-downloading12380
|
||||||
Node: RELOADING13237
|
Node: RELOADING13214
|
||||||
Ref: #reloading13371
|
Ref: #reloading13348
|
||||||
Node: JSON API13804
|
Node: JSON API13781
|
||||||
Ref: #json-api13919
|
Ref: #json-api13896
|
||||||
Node: DEBUG OUTPUT19407
|
Node: DEBUG OUTPUT19384
|
||||||
Ref: #debug-output19532
|
Ref: #debug-output19509
|
||||||
Node: Debug output19559
|
Node: Debug output19536
|
||||||
Ref: #debug-output-119660
|
Ref: #debug-output-119637
|
||||||
Node: ENVIRONMENT20077
|
Node: ENVIRONMENT20054
|
||||||
Ref: #environment20196
|
Ref: #environment20173
|
||||||
Node: BUGS20313
|
Node: BUGS20290
|
||||||
Ref: #bugs20397
|
Ref: #bugs20374
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|||||||
@ -87,13 +87,10 @@ OPTIONS
|
|||||||
them from another server for efficiency, you would set the url
|
them from another server for efficiency, you would set the url
|
||||||
with this.
|
with this.
|
||||||
|
|
||||||
--capabilities=CAP[,CAP..]
|
--allow=view|add|edit
|
||||||
enable the view, add, and/or manage capabilities (default:
|
set the user's access level for changing data (default: add).
|
||||||
view,add)
|
It also accepts sandstorm for use on that platform (reads per-
|
||||||
|
missions from the X-Sandstorm-Permissions request header).
|
||||||
--capabilities-header=HTTPHEADER
|
|
||||||
read capabilities to enable from a HTTP header, like X-Sand-
|
|
||||||
storm-Permissions (default: disabled)
|
|
||||||
|
|
||||||
--test run hledger-web's tests and exit. hspec test runner args may
|
--test run hledger-web's tests and exit. hspec test runner args may
|
||||||
follow a --, eg: hledger-web --test -- --help
|
follow a --, eg: hledger-web --test -- --help
|
||||||
@ -567,4 +564,4 @@ LICENSE
|
|||||||
SEE ALSO
|
SEE ALSO
|
||||||
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
|
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
|
||||||
|
|
||||||
hledger-web-1.31.99 September 2023 HLEDGER-WEB(1)
|
hledger-web-1.31.99 November 2023 HLEDGER-WEB(1)
|
||||||
|
|||||||
@ -1,2 +1,2 @@
|
|||||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||||
m4_define({{_monthyear_}}, {{September 2023}})m4_dnl
|
m4_define({{_monthyear_}}, {{November 2023}})m4_dnl
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
2332
hledger/hledger.info
2332
hledger/hledger.info
File diff suppressed because it is too large
Load Diff
2988
hledger/hledger.txt
2988
hledger/hledger.txt
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user