mirror of
https://github.com/simonmichael/hledger.git
synced 2024-12-26 03:42:25 +03:00
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_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_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
|
||||
error screen.
|
||||
.PP
|
||||
\f[V]B\f[R] toggles cost mode, showing amounts in their cost\[aq]s
|
||||
commodity (like toggling the \f[V]-B/--cost\f[R] flag).
|
||||
\f[V]B\f[R] toggles cost mode, showing amounts converted to their
|
||||
cost\[aq]s commodity (see hledger manual > Cost reporting.
|
||||
.PP
|
||||
\f[V]V\f[R] toggles value mode, showing amounts\[aq] current market
|
||||
value in their default valuation commodity (like toggling the
|
||||
\f[V]-V/--market\f[R] flag).
|
||||
Note, \[dq]current market value\[dq] 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 \f[V]/\f[R], and add \f[V]date:-7/30\f[R] to
|
||||
the query.
|
||||
\f[V]V\f[R] toggles value mode, showing amounts converted to their
|
||||
market value (see hledger manual > Valuation flag).
|
||||
More specifically,
|
||||
.IP "1." 3
|
||||
By default, the \f[V]V\f[R] key toggles showing end value
|
||||
(\f[V]--value=end\f[R]) on or off.
|
||||
The valuation date will be the report end date if specified, otherwise
|
||||
today.
|
||||
.IP "2." 3
|
||||
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
|
||||
At most one of cost or value mode can be active at once.
|
||||
.PP
|
||||
There\[aq]s not yet any visual reminder when cost or value mode is
|
||||
active; for now pressing \f[V]b\f[R] \f[V]b\f[R] \f[V]v\f[R] should
|
||||
reliably reset to normal mode.
|
||||
Cost/value tips: - When showing end value, you can change the report end
|
||||
date without restarting, by pressing \f[V]/\f[R] and adding a query like
|
||||
\f[V]date:..YYYY-MM-DD\f[R].
|
||||
- Either cost mode, or value mode, can be active, but not both at once.
|
||||
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
|
||||
\f[V]q\f[R] quits the application.
|
||||
.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.
|
||||
.RE
|
||||
.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
|
||||
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
|
||||
|
@ -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
|
||||
possible) when invoked from the error screen.
|
||||
|
||||
'B' toggles cost mode, showing amounts in their cost's commodity
|
||||
(like toggling the '-B/--cost' flag).
|
||||
'B' toggles cost mode, showing amounts converted to their cost's
|
||||
commodity (see hledger manual > Cost reporting.
|
||||
|
||||
'V' toggles value mode, showing amounts' current market value in
|
||||
their default valuation commodity (like toggling the '-V/--market'
|
||||
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.
|
||||
'V' toggles value mode, showing amounts converted to their market
|
||||
value (see hledger manual > Valuation flag). More specifically,
|
||||
|
||||
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; for now pressing 'b' 'b' 'v' should reliably reset to normal
|
||||
mode.
|
||||
2. If you started hledger-ui with some other valuation (such as
|
||||
'--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.
|
||||
|
||||
@ -500,6 +503,12 @@ line represents one transaction, and shows:
|
||||
historical balance (what you would see on a bank's website,
|
||||
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
|
||||
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
|
||||
@ -677,34 +686,34 @@ Node: MOUSE7825
|
||||
Ref: #mouse7920
|
||||
Node: KEYS8157
|
||||
Ref: #keys8250
|
||||
Node: SCREENS12763
|
||||
Ref: #screens12861
|
||||
Node: Menu13441
|
||||
Ref: #menu13534
|
||||
Node: Cash accounts13729
|
||||
Ref: #cash-accounts13871
|
||||
Node: Balance sheet accounts14055
|
||||
Ref: #balance-sheet-accounts14236
|
||||
Node: Income statement accounts14356
|
||||
Ref: #income-statement-accounts14542
|
||||
Node: All accounts14706
|
||||
Ref: #all-accounts14852
|
||||
Node: Register15034
|
||||
Ref: #register15158
|
||||
Node: Transaction17120
|
||||
Ref: #transaction17243
|
||||
Node: Error18660
|
||||
Ref: #error18754
|
||||
Node: TIPS18998
|
||||
Ref: #tips19097
|
||||
Node: Watch mode19139
|
||||
Ref: #watch-mode19246
|
||||
Node: Debug output20705
|
||||
Ref: #debug-output20816
|
||||
Node: ENVIRONMENT21028
|
||||
Ref: #environment21138
|
||||
Node: BUGS21329
|
||||
Ref: #bugs21412
|
||||
Node: SCREENS12905
|
||||
Ref: #screens13003
|
||||
Node: Menu13583
|
||||
Ref: #menu13676
|
||||
Node: Cash accounts13871
|
||||
Ref: #cash-accounts14013
|
||||
Node: Balance sheet accounts14197
|
||||
Ref: #balance-sheet-accounts14378
|
||||
Node: Income statement accounts14498
|
||||
Ref: #income-statement-accounts14684
|
||||
Node: All accounts14848
|
||||
Ref: #all-accounts14994
|
||||
Node: Register15176
|
||||
Ref: #register15300
|
||||
Node: Transaction17584
|
||||
Ref: #transaction17707
|
||||
Node: Error19124
|
||||
Ref: #error19218
|
||||
Node: TIPS19462
|
||||
Ref: #tips19561
|
||||
Node: Watch mode19603
|
||||
Ref: #watch-mode19710
|
||||
Node: Debug output21169
|
||||
Ref: #debug-output21280
|
||||
Node: ENVIRONMENT21492
|
||||
Ref: #environment21602
|
||||
Node: BUGS21793
|
||||
Ref: #bugs21876
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
@ -314,21 +314,25 @@ KEYS
|
||||
register and transaction screens, and at the error location (if possi-
|
||||
ble) when invoked from the error screen.
|
||||
|
||||
B toggles cost mode, showing amounts in their cost's commodity (like
|
||||
toggling the -B/--cost flag).
|
||||
B toggles cost mode, showing amounts converted to their cost's commod-
|
||||
ity (see hledger manual > Cost reporting.
|
||||
|
||||
V toggles value mode, showing amounts' current market value in their
|
||||
default valuation commodity (like toggling the -V/--market 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.
|
||||
V toggles value mode, showing amounts converted to their market value
|
||||
(see hledger manual > Valuation flag). More specifically,
|
||||
|
||||
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;
|
||||
for now pressing b b v should reliably reset to normal mode.
|
||||
2. If you started hledger-ui with some other valuation (such as
|
||||
--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.
|
||||
|
||||
@ -389,6 +393,12 @@ SCREENS
|
||||
(what you would see on a bank's website, 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
|
||||
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
|
||||
@ -527,4 +537,4 @@ LICENSE
|
||||
SEE ALSO
|
||||
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_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
|
||||
with this.
|
||||
.TP
|
||||
\f[V]--capabilities=CAP[,CAP..]\f[R]
|
||||
enable the view, add, and/or manage capabilities (default: view,add)
|
||||
.TP
|
||||
\f[V]--capabilities-header=HTTPHEADER\f[R]
|
||||
read capabilities to enable from a HTTP header, like
|
||||
X-Sandstorm-Permissions (default: disabled)
|
||||
\f[V]--allow=view|add|edit\f[R]
|
||||
set the user\[aq]s access level for changing data (default:
|
||||
\f[V]add\f[R]).
|
||||
It also accepts \f[V]sandstorm\f[R] for use on that platform (reads
|
||||
permissions from the \f[V]X-Sandstorm-Permissions\f[R] request header).
|
||||
.TP
|
||||
\f[V]--test\f[R]
|
||||
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
|
||||
them from another server for efficiency, you would set the url with
|
||||
this.
|
||||
'--capabilities=CAP[,CAP..]'
|
||||
'--allow=view|add|edit'
|
||||
|
||||
enable the view, add, and/or manage capabilities (default:
|
||||
view,add)
|
||||
'--capabilities-header=HTTPHEADER'
|
||||
|
||||
read capabilities to enable from a HTTP header, like
|
||||
X-Sandstorm-Permissions (default: disabled)
|
||||
set the user's access level for changing data (default: 'add'). It
|
||||
also accepts 'sandstorm' for use on that platform (reads
|
||||
permissions from the 'X-Sandstorm-Permissions' request header).
|
||||
'--test'
|
||||
|
||||
run hledger-web's tests and exit. hspec test runner args may
|
||||
@ -648,28 +645,28 @@ Tag Table:
|
||||
Node: Top225
|
||||
Node: OPTIONS2580
|
||||
Ref: #options2685
|
||||
Node: General help options5996
|
||||
Ref: #general-help-options6146
|
||||
Node: General input options6428
|
||||
Ref: #general-input-options6614
|
||||
Node: General reporting options7316
|
||||
Ref: #general-reporting-options7481
|
||||
Node: PERMISSIONS10871
|
||||
Ref: #permissions11010
|
||||
Node: EDITING UPLOADING DOWNLOADING12222
|
||||
Ref: #editing-uploading-downloading12403
|
||||
Node: RELOADING13237
|
||||
Ref: #reloading13371
|
||||
Node: JSON API13804
|
||||
Ref: #json-api13919
|
||||
Node: DEBUG OUTPUT19407
|
||||
Ref: #debug-output19532
|
||||
Node: Debug output19559
|
||||
Ref: #debug-output-119660
|
||||
Node: ENVIRONMENT20077
|
||||
Ref: #environment20196
|
||||
Node: BUGS20313
|
||||
Ref: #bugs20397
|
||||
Node: General help options5973
|
||||
Ref: #general-help-options6123
|
||||
Node: General input options6405
|
||||
Ref: #general-input-options6591
|
||||
Node: General reporting options7293
|
||||
Ref: #general-reporting-options7458
|
||||
Node: PERMISSIONS10848
|
||||
Ref: #permissions10987
|
||||
Node: EDITING UPLOADING DOWNLOADING12199
|
||||
Ref: #editing-uploading-downloading12380
|
||||
Node: RELOADING13214
|
||||
Ref: #reloading13348
|
||||
Node: JSON API13781
|
||||
Ref: #json-api13896
|
||||
Node: DEBUG OUTPUT19384
|
||||
Ref: #debug-output19509
|
||||
Node: Debug output19536
|
||||
Ref: #debug-output-119637
|
||||
Node: ENVIRONMENT20054
|
||||
Ref: #environment20173
|
||||
Node: BUGS20290
|
||||
Ref: #bugs20374
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
@ -87,13 +87,10 @@ OPTIONS
|
||||
them from another server for efficiency, you would set the url
|
||||
with this.
|
||||
|
||||
--capabilities=CAP[,CAP..]
|
||||
enable the view, add, and/or manage capabilities (default:
|
||||
view,add)
|
||||
|
||||
--capabilities-header=HTTPHEADER
|
||||
read capabilities to enable from a HTTP header, like X-Sand-
|
||||
storm-Permissions (default: disabled)
|
||||
--allow=view|add|edit
|
||||
set the user's access level for changing data (default: add).
|
||||
It also accepts sandstorm for use on that platform (reads per-
|
||||
missions from the X-Sandstorm-Permissions request header).
|
||||
|
||||
--test run hledger-web's tests and exit. hspec test runner args may
|
||||
follow a --, eg: hledger-web --test -- --help
|
||||
@ -567,4 +564,4 @@ LICENSE
|
||||
SEE ALSO
|
||||
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_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