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

ui: doc: clarify

Browse Source
This commit is contained in:
Simon Michael 2016-08-10 07:24:21 -07:00
parent af9daa3b11
commit 9df96cdace
4 changed files with 156 additions and 154 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
hledger-ui/doc/hledger-ui.1
View File

@ -213,9 +213,10 @@ be "TAG:multi:level:account:name".
.SH KEYS
.PP
\f[C]?\f[] shows a help dialog listing all keys.
(Some but not all of these also appear in the quick help at the bottom
of each screen.) Press \f[C]?\f[] again (or \f[C]ESCAPE\f[], or
\f[C]LEFT\f[]) to close it.
(Some of these also appear in the quick help at the bottom of each
screen.) Press \f[C]?\f[] again (or \f[C]ESCAPE\f[], or \f[C]LEFT\f[])
to close it.
The following keys work on most screens:
.PP
The cursor keys navigate: \f[C]right\f[] (or \f[C]enter\f[]) goes
deeper, \f[C]left\f[] returns to the previous screen,
@ -223,35 +224,34 @@ deeper, \f[C]left\f[] returns to the previous screen,
move up and down through lists.
Vi\-style \f[C]h\f[]/\f[C]j\f[]/\f[C]k\f[]/\f[C]l\f[] movement keys are
also supported.
(A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust that.
On a mac, the Karabiner app is one way to do that.)
A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust it.
(If you\[aq]re on a mac, the Karabiner app is one way to do that.)
.PP
On most screens, \f[C]/\f[] lets you set or change the filter query,
which limits the data shown (this filter is in addition to the quick
filters described below).
While editing the query you can use typical command\-line edit keys
(CTRL\-a/e/d/k, cursor keys etc.), and \f[C]ENTER\f[]to set the new
filter or \f[C]ESCAPE\f[]to cancel.
.PP
\f[C]d\f[] and \f[C]u\f[] cycle downward and upward through standard
report periods \- year, quarter, month, week, day.
When a standard report period is selected, \f[C]n\f[] and \f[C]p\f[]
step it to the next or previous period.
\f[C]Shift\-down/up/right/left\f[] can also be used for this.
With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown).
\f[C]shift\-down/up\f[] steps downward and upward through these standard
report period durations: year, quarter, month, week, day.
Then, \f[C]shift\-left/right\f[] moves to the previous/next period.
\f[C]t\f[] sets the report period to today.
For non\-standard periods, you can use \f[C]/\f[] to set a
\f[C]date:\f[] query.
(To set a non\-standard period, you can use \f[C]/\f[] and a
\f[C]date:\f[] query).
.PP
\f[C]BACKSPACE\f[] or \f[C]DELETE\f[] clears any filters in effect.
\f[C]/\f[] lets you set a general filter query limiting the data shown,
using the same query terms as in hledger and hledger\-web.
While editing the query, you can use CTRL\-a/e/d/k, BS, cursor keys;
press \f[C]ENTER\f[] to set it, or \f[C]ESCAPE\f[]to cancel.
There are also keys for quickly adjusting some common filters like
account depth and cleared/uncleared (see below).
\f[C]BACKSPACE\f[] or \f[C]DELETE\f[] removes all filters, showing all
transactions.
.PP
\f[C]ESCAPE\f[] removes any filters currently in effect, and jumps to
the top screen.
Or, it cancels a minibuffer edit or help dialog if one is active.
\f[C]ESCAPE\f[] removes all filters and jumps back to the top screen.
Or, it cancels a minibuffer edit or help dialog in progress.
.PP
\f[C]g\f[] reloads from the data file(s) and updates the current screen
and any previous screens.
(With large files, there can be a noticeable pause.)
(With large files, this could cause a noticeable pause.)
.PP
\f[C]I\f[] toggles balance assertion checking.
Disabling balance assertions temporarily can be useful for

68
hledger-ui/doc/hledger-ui.1.info
View File

@ -149,38 +149,40 @@ File: hledger-ui.1.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
2 KEYS
******
`?' shows a help dialog listing all keys. (Some but not all of these
also appear in the quick help at the bottom of each screen.) Press `?'
again (or `ESCAPE', or `LEFT') to close it.
`?' shows a help dialog listing all keys. (Some of these also appear in
the quick help at the bottom of each screen.) Press `?' again (or
`ESCAPE', or `LEFT') to close it. The following keys work on most
screens:
The cursor keys navigate: `right' (or `enter') goes deeper, `left'
returns to the previous screen, `up'/`down'/`page up'/`page
down'/`home'/`end' move up and down through lists. Vi-style
`h'/`j'/`k'/`l' movement keys are also supported. (A tip: movement
speed is limited by your keyboard repeat rate, to move faster you may
want to adjust that. On a mac, the Karabiner app is one way to do that.)
`h'/`j'/`k'/`l' movement keys are also supported. A tip: movement speed
is limited by your keyboard repeat rate, to move faster you may want to
adjust it. (If you're on a mac, the Karabiner app is one way to do
that.)
On most screens, `/' lets you set or change the filter query, which
limits the data shown (this filter is in addition to the quick filters
described below). While editing the query you can use typical
command-line edit keys (CTRL-a/e/d/k, cursor keys etc.), and `ENTER'to
set the new filter or `ESCAPE'to cancel.
With shift pressed, the cursor keys adjust the report period,
limiting the transactions to be shown (by default, all are shown).
`shift-down/up' steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then,
`shift-left/right' moves to the previous/next period. `t' sets the
report period to today. (To set a non-standard period, you can use `/'
and a `date:' query).
`d' and `u' cycle downward and upward through standard report
periods - year, quarter, month, week, day. When a standard report period
is selected, `n' and `p' step it to the next or previous period.
`Shift-down/up/right/left' can also be used for this. `t' sets the
report period to today. For non-standard periods, you can use `/' to
set a `date:' query.
`/' lets you set a general filter query limiting the data shown,
using the same query terms as in hledger and hledger-web. While editing
the query, you can use CTRL-a/e/d/k, BS, cursor keys; press `ENTER' to
set it, or `ESCAPE'to cancel. There are also keys for quickly adjusting
some common filters like account depth and cleared/uncleared (see
below). `BACKSPACE' or `DELETE' removes all filters, showing all
transactions.
`BACKSPACE' or `DELETE' clears any filters in effect.
`ESCAPE' removes any filters currently in effect, and jumps to the
top screen. Or, it cancels a minibuffer edit or help dialog if one is
active.
`ESCAPE' removes all filters and jumps back to the top screen. Or,
it cancels a minibuffer edit or help dialog in progress.
`g' reloads from the data file(s) and updates the current screen and
any previous screens. (With large files, there can be a noticeable
any previous screens. (With large files, this could cause a noticeable
pause.)
`I' toggles balance assertion checking. Disabling balance assertions
@ -347,15 +349,15 @@ Node: OPTIONS831
Ref: #options930
Node: KEYS3743
Ref: #keys3840
Node: SCREENS6107
Ref: #screens6194
Node: Accounts screen6284
Ref: #accounts-screen6414
Node: Register screen7880
Ref: #register-screen8037
Node: Transaction screen9997
Ref: #transaction-screen10157
Node: Error screen11024
Ref: #error-screen11148
Node: SCREENS6241
Ref: #screens6328
Node: Accounts screen6418
Ref: #accounts-screen6548
Node: Register screen8014
Ref: #register-screen8171
Node: Transaction screen10131
Ref: #transaction-screen10291
Node: Error screen11158
Ref: #error-screen11282

End Tag Table

40
hledger-ui/doc/hledger-ui.1.m4.md
View File

@ -73,39 +73,39 @@ _reportingoptions_
# KEYS
`?` shows a help dialog listing all keys.
(Some but not all 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`) to close it.
The following keys work on most screens:
The cursor keys navigate:
`right` (or `enter`) goes deeper,
`left` returns to the previous screen,
`up`/`down`/`page up`/`page down`/`home`/`end` move up and down through lists.
Vi-style `h`/`j`/`k`/`l` movement keys are also supported.
(A tip: movement speed is limited by your keyboard repeat rate,
to move faster you may want to adjust that.
On a mac, the Karabiner app is one way to do that.)
A tip: movement speed is limited by your keyboard repeat rate,
to move faster you may want to adjust it.
(If you're on a mac, the Karabiner app is one way to do that.)
On most screens,
`/` lets you set or change the [filter query](/hledger.html#queries),
which limits the data shown (this filter is in addition to the quick
filters described below). While editing the query you can use typical
command-line edit keys
([CTRL-a/e/d/k, cursor keys etc.](http://hackage.haskell.org/package/brick-0.7/docs/Brick-Widgets-Edit.html#t:Editor)),
and `ENTER`to set the new filter or `ESCAPE`to cancel.
`d` and `u` cycle downward and upward through standard report periods - year, quarter, month, week, day.
When a standard report period is selected, `n` and `p` step it to the next or previous period.
`Shift-down/up/right/left` can also be used for this.
With shift pressed, the cursor keys adjust the report period,
limiting the transactions to be shown (by default, all are shown).
`shift-down/up` steps downward and upward through these standard report period durations:
year, quarter, month, week, day.
Then, `shift-left/right` moves to the previous/next period.
`t` sets the report period to today.
For non-standard periods, you can use `/` to set a [`date:` query](manual.html#queries).
(To set a non-standard period, you can use `/` and a `date:` query).
`BACKSPACE` or `DELETE` clears any filters in effect.
`/` 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.
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.
There are also keys for quickly adjusting some common filters like account depth and cleared/uncleared (see below).
`BACKSPACE` or `DELETE` removes all filters, showing all transactions.
`ESCAPE` removes any filters currently in effect, and jumps to the top screen.
Or, it cancels a minibuffer edit or help dialog if one is active.
`ESCAPE` removes all filters and jumps back to the top screen.
Or, it cancels a minibuffer edit or help dialog in progress.
`g` reloads from the data file(s) and updates the current screen and any
previous screens. (With large files, there can be a noticeable pause.)
previous screens. (With large files, this could cause a noticeable pause.)
`I` toggles balance assertion checking.
Disabling balance assertions temporarily can be useful for troubleshooting.

46
hledger-ui/doc/hledger-ui.1.txt
View File

@ -138,38 +138,38 @@ OPTIONS
name will be "TAG:multi:level:account:name".
KEYS
? shows a help dialog listing all keys. (Some but not all of these
also appear in the quick help at the bottom of each screen.) Press ?
again (or ESCAPE, or LEFT) to close it.
? shows a help dialog listing all keys. (Some of these also appear in
the quick help at the bottom of each screen.) Press ? again (or ESCAPE,
or LEFT) to close it. The following keys work on most screens:
The cursor keys navigate: right (or enter) goes deeper, left returns to
the previous screen, up/down/page up/page down/home/end move up and
down through lists. Vi-style h/j/k/l movement keys are also supported.
(A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust that. On a mac, the Karabiner app is one
way to do that.)
A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust it. (If you're on a mac, the Karabiner
app is one way to do that.)
On most screens, / lets you set or change the filter query, which lim-
its the data shown (this filter is in addition to the quick filters
described below). While editing the query you can use typical com-
mand-line edit keys (CTRL-a/e/d/k, cursor keys etc.), and ENTERto set
the new filter or ESCAPEto cancel.
With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown).
shift-down/up steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then,
shift-left/right moves to the previous/next period. t sets the report
period to today. (To set a non-standard period, you can use / and a
date: query).
d and u cycle downward and upward through standard report periods -
year, quarter, month, week, day. When a standard report period is
selected, n and p step it to the next or previous period.
Shift-down/up/right/left can also be used for this. t sets the report
period to today. For non-standard periods, you can use / to set a
date: query.
/ lets you set a general filter query limiting the data shown, using
the same query terms as in hledger and hledger-web. While editing the
query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
it, or ESCAPEto cancel. There are also keys for quickly adjusting some
common filters like account depth and cleared/uncleared (see below).
BACKSPACE or DELETE removes all filters, showing all transactions.
BACKSPACE or DELETE clears any filters in effect.
ESCAPE removes any filters currently in effect, and jumps to the top
screen. Or, it cancels a minibuffer edit or help dialog if one is
active.
ESCAPE removes all filters and jumps back to the top screen. Or, it
cancels a minibuffer edit or help dialog in progress.
g reloads from the data file(s) and updates the current screen and any
previous screens. (With large files, there can be a noticeable pause.)
previous screens. (With large files, this could cause a noticeable
pause.)
I toggles balance assertion checking. Disabling balance assertions
temporarily can be useful for troubleshooting.