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

ui: doc: fix decapitalisation in manual, present since 1.19

Browse Source 
Added accidentally by 847fc23 on 2020-07-17.
This commit is contained in:
Simon Michael 2020-12-20 17:56:54 -08:00
parent 63876a4186
commit 4639522d9c
1 changed files with 47 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
hledger-ui/hledger-ui.m4.md
View File

@ -87,18 +87,18 @@ hledger help options:
_helpoptions_ _helpoptions_
a @file argument will be expanded to the contents of file, A @FILE argument will be expanded to the contents of FILE,
which should contain one command line option/argument per line. which should contain one command line option/argument per line.
(to prevent this, insert a `--` argument before.) (To prevent this, insert a `--` argument before.)
# keys # KEYS
`?` shows a help dialog listing all keys. `?` shows a help dialog listing all keys.
(some of these also appear in the quick help at the bottom of each screen.) (Some of these also appear in the quick help at the bottom of each screen.)
press `?` again (or `escape`, or `left`, or `q`) to close it. Press `?` again (or `ESCAPE`, or `LEFT`, or `q`) to close it.
the following keys work on most screens: The following keys work on most screens:
the cursor keys navigate: The cursor keys navigate:
`right` (or `enter`) goes deeper, `right` (or `enter`) goes deeper,
`left` returns to the previous screen, `left` returns to the previous screen,
`up`/`down`/`page up`/`page down`/`home`/`end` move up and down through lists. `up`/`down`/`page up`/`page down`/`home`/`end` move up and down through lists.
@ -108,90 +108,90 @@ A tip: movement speed is limited by your keyboard repeat rate,
to move faster you may want to adjust it. to move faster you may want to adjust it.
(If you're on a mac, the karabiner app is one way to do that.) (If you're on a mac, the karabiner app is one way to do that.)
with shift pressed, the cursor keys adjust the report period, With shift pressed, the cursor keys adjust the report period,
limiting the transactions to be shown (by default, all are shown). limiting the transactions to be shown (by default, all are shown).
`shift-down/up` steps downward and upward through these standard report period durations: `shift-down/up` steps downward and upward through these standard report period durations:
year, quarter, month, week, day. year, quarter, month, week, day.
then, `shift-left/right` moves to the previous/next period. Then, `shift-left/right` moves to the previous/next period.
`T` sets the report period to today. `T` sets the report period to today.
with the `--watch` option, when viewing a "current" period With the `--watch` option, when viewing a "current" period
(the current day, week, month, quarter, or year), (the current day, week, month, quarter, or year),
the period will move automatically to track the current date. the period will move automatically to track the current date.
to set a non-standard period, you can use `/` and a `date:` query. To set a non-standard period, you can use `/` and a `date:` query.
`/` lets you set a general filter query limiting the data shown, `/` lets you set a general filter query limiting the data shown,
using the same [query terms](hledger.html#queries) as in hledger and hledger-web. using the same [query terms](hledger.html#queries) as in hledger and hledger-web.
while editing the query, you can use [ctrl-a/e/d/k, bs, cursor keys](http://hackage.haskell.org/package/brick-0.7/docs/brick-widgets-edit.html#t:editor); While editing the query, you can use [CTRL-a/e/d/k, BS, cursor keys](http://hackage.haskell.org/package/brick-0.7/docs/brick-widgets-edit.html#t:editor);
press `enter` to set it, or `escape`to cancel. press `ENTER` to set it, or `ESCAPE`to cancel.
there are also keys for quickly adjusting some common filters like account depth and transaction status (see below). There are also keys for quickly adjusting some common filters like account depth and transaction status (see below).
`backspace` or `delete` removes all filters, showing all transactions. `BACKSPACE` or `DELETE` removes all filters, showing all transactions.
as mentioned above, by default hledger-ui hides future transactions - As mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic both ordinary transactions recorded in the journal, and periodic
transactions generated by rule. `f` toggles forecast mode, in which transactions generated by rule. `F` toggles forecast mode, in which
future/forecasted transactions are shown. *(experimental)* future/forecasted transactions are shown.
`escape` resets the UI state and jumps back to the top screen, `ESCAPE` resets the UI state and jumps back to the top screen,
restoring the app's initial state at startup. restoring the app's initial state at startup.
Or, it cancels minibuffer data entry or the help dialog. Or, it cancels minibuffer data entry or the help dialog.
`ctrl-l` redraws the screen and centers the selection if possible `CTRL-l` redraws the screen and centers the selection if possible
(selections near the top won't be centered, since we don't scroll above the top). (selections near the top won't be centered, since we don't scroll above the top).
`g` reloads from the data file(s) and updates the current screen and any `g` reloads from the data file(s) and updates the current screen and any
previous screens. (with large files, this could cause a noticeable pause.) previous screens. (With large files, this could cause a noticeable pause.)
`i` toggles balance assertion checking. `I` toggles balance assertion checking.
disabling balance assertions temporarily can be useful for troubleshooting. Disabling balance assertions temporarily can be useful for troubleshooting.
`a` runs command-line hledger's add command, and reloads the updated file. `a` runs command-line hledger's add command, and reloads the updated file.
this allows some basic data entry. This allows some basic data entry.
`a` is like `a`, but runs the [hledger-iadd](http://hackage.haskell.org/package/hledger-iadd) tool, `A` is like `a`, but runs the [hledger-iadd](http://hackage.haskell.org/package/hledger-iadd) tool,
which provides a terminal interface. which provides a terminal interface.
this key will be available if `hledger-iadd` is installed in $path. This key will be available if `hledger-iadd` is installed in $path.
`e` runs $hledger_ui_editor, or $editor, or a default (`emacsclient -a "" -nw`) on the journal file. `E` runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (`emacsclient -a "" -nw`) on the journal file.
with some editors (emacs, vi), the cursor will be positioned at the current transaction With some editors (emacs, vi), the 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 register and transaction screens, and at the error location (if possible)
when invoked from the error screen. when invoked from the error screen.
`b` toggles cost mode, showing amounts in their transaction price's `B` toggles cost mode, showing amounts in their transaction price's
commodity (like toggling the commodity (like toggling the
[`-b/--cost`](https://hledger.org/hledger.html#b-cost) flag). [`-B/--cost`](https://hledger.org/hledger.html#b-cost) flag).
`v` toggles value mode, showing amounts' current market value in their `V` toggles value mode, showing amounts' current market value in their
default valuation commodity (like toggling the default valuation commodity (like toggling the
[`-v/--market`](https://hledger.org/hledger.html#v-market-value) flag). [`-V/--market`](https://hledger.org/hledger.html#v-market-value) flag).
note, "current market value" means the value on the report end date if specified, otherwise today. 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. 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, Eg: to see a transaction as it was valued on july 30,
go to the accounts or register screen, go to the accounts or register screen,
press `/`, press `/`,
and add ` date:-7/30` to the query. and add ` date:-7/30` to the query.
at most one of cost or value mode can be active at once. At most one of cost or value mode can be active at once.
there's not yet any visual reminder when cost or value mode is active; 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. for now pressing `b` `b` `v` should reliably reset to normal mode.
with --watch active, if you save an edit to the journal file With `--watch` active, if you save an edit to the journal file
while viewing the transaction screen in cost or value mode, while viewing the transaction screen in cost or value mode,
the `b`/`v` keys will stop working. the `B`/`V` keys will stop working.
to work around, press g to force a manual reload, or exit the transaction screen. To work around, press `g` to force a manual reload, or exit the transaction screen.
`q` quits the application. `q` quits the application.
additional screen-specific keys are described below. Additional screen-specific keys are described below.
# screens # SCREENS
## accounts screen ## Accounts screen
this is normally the first screen displayed. This is normally the first screen displayed.
it lists accounts and their balances, like hledger's balance command. It lists accounts and their balances, like hledger's balance command.
by default, it shows all accounts and their latest ending balances (including the balances of subaccounts). By default, it shows all accounts and their latest ending balances (including the balances of subaccounts).
if you specify a query on the command line, it shows just the matched accounts and the balances from matched transactions. If you specify a query on the command line, it shows just the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default; press `t` to toggle tree mode. Account names are shown as a flat list by default; press `t` to toggle tree mode.
In list mode, account balances are exclusive of subaccounts, except where subaccounts are hidden by a depth limit (see below). In list mode, account balances are exclusive of subaccounts, except where subaccounts are hidden by a depth limit (see below).