;doc: regen manuals

[ci skip]
This commit is contained in:
Simon Michael 2019-11-21 17:32:30 -08:00
parent 332624f9fa
commit d8bf72ae73
3 changed files with 148 additions and 69 deletions

View File

@ -258,6 +258,34 @@ error screen.
.PP .PP
\f[C]q\f[R] quits the application. \f[C]q\f[R] quits the application.
.PP .PP
Experimental:
.PP
\f[C]B\f[R] toggles cost mode, showing amounts in their transaction
price\[aq]s commodity (like toggling the \f[C]-B/--cost\f[R] flag).
.PP
\f[C]V\f[R] toggles value mode, showing amounts\[aq] current market
value in their default valuation commodity (like toggling the
\f[C]-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, such as the transaction\[aq]s date,
you can temporarily set a date filter ending on the following day.
Eg to see the contemporaneous value of a transaction on july 30, go to
the accounts or register screen, press \f[C]/\f[R], add
\f[C]date:-7/30\f[R].
.PP
At most one of cost or value mode can be active at once (in hledger-ui).
.PP
There\[aq]s not yet any visual reminder when cost or value mode is
active; for now pressing \f[C]B\f[R] \f[C]B\f[R] \f[C]V\f[R] should
reliably reset to normal mode.
.PP
With --watch active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the
\f[C]B\f[R]/\f[C]V\f[R] keys will stop working.
To work around, press g to force a manual reload, or exit the
transaction screen.
.PP
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
.SH SCREENS .SH SCREENS
.SS Accounts screen .SS Accounts screen

View File

@ -250,6 +250,32 @@ possible) when invoked from the error screen.
'q' quits the application. 'q' quits the application.
Experimental:
'B' toggles cost mode, showing amounts in their transaction price's
commodity (like toggling the '-B/--cost' flag).
'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,
such as the transaction's date, you can temporarily set a date filter
ending on the following day. Eg to see the contemporaneous value of a
transaction on july 30, go to the accounts or register screen, press
'/', add 'date:-7/30'.
At most one of cost or value mode can be active at once (in
hledger-ui).
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.
With -watch active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the 'B'/'V' keys
will stop working. To work around, press g to force a manual reload, or
exit the transaction screen.
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
 
@ -403,15 +429,15 @@ Node: OPTIONS1103
Ref: #options1200 Ref: #options1200
Node: KEYS4591 Node: KEYS4591
Ref: #keys4686 Ref: #keys4686
Node: SCREENS7938 Node: SCREENS9049
Ref: #screens8023 Ref: #screens9134
Node: Accounts screen8113 Node: Accounts screen9224
Ref: #accounts-screen8241 Ref: #accounts-screen9352
Node: Register screen10457 Node: Register screen11568
Ref: #register-screen10612 Ref: #register-screen11723
Node: Transaction screen12608 Node: Transaction screen13719
Ref: #transaction-screen12766 Ref: #transaction-screen13877
Node: Error screen13636 Node: Error screen14747
Ref: #error-screen13758 Ref: #error-screen14869
 
End Tag Table End Tag Table

View File

@ -238,6 +238,31 @@ KEYS
q quits the application. q quits the application.
Experimental:
B toggles cost mode, showing amounts in their transaction price's com-
modity (like toggling the -B/--cost flag).
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, such as
the transaction's date, you can temporarily set a date filter ending on
the following day. Eg to see the contemporaneous value of a transac-
tion on july 30, go to the accounts or register screen, press /, add
date:-7/30.
At most one of cost or value mode can be active at once (in hledger-
ui).
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.
With --watch active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the B/V keys will
stop working. To work around, press g to force a manual reload, or
exit the transaction screen.
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
SCREENS SCREENS