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

ui: document latest keys

Browse Source
This commit is contained in:
Simon Michael 2016-06-07 09:38:31 -07:00
parent 6660a52139
commit 4d62ac5efc
4 changed files with 83 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -226,18 +226,22 @@ goes deeper, \f[C]left\f[] returns to the previous screen,
\f[C]up\f[]/\f[C]down\f[]/\f[C]page\ up\f[]/\f[C]page\ down\f[]/\f[C]home\f[]/\f[C]end\f[] \f[C]up\f[]/\f[C]down\f[]/\f[C]page\ up\f[]/\f[C]page\ down\f[]/\f[C]home\f[]/\f[C]end\f[]
move up and down through lists. move up and down through lists.
.PP .PP
\f[C]g\f[] gets the latest data and reloads the screen (and any previous \f[C]g\f[] gets the latest data and refreshes the screen (and any
screens). previous screens).
With large journal files, there can be a noticeable pause. With large journal files, there can be a noticeable pause.
.PP .PP
\f[C]q\f[] quits the application. \f[C]/\f[] lets you set or change the filter query, which limits the
data shown on most screens (in addition to the quick filters described
below).
While editing the query you can use typical command\-line edit keys
(ctrl\-a/e/k), press enter to set the new filter, or press escape to
cancel.
.PP .PP
\f[C]f\f[] lets you add or change the current filter query which limits \f[C]BACKSPACE\f[] or \f[C]DELETE\f[] clears any filters in effect.
the data shown on most screens. .PP
While editing, you can use typical command\-line edit keys, and press \f[C]ESCAPE\f[] clears any filters and jumps to the top screen.
enter to set the new filter, or escape to cancel. .PP
Note queries which filter by account name may not work well in the \f[C]q\f[] quits the application.
register screen.
.PP .PP
Additional screen\-specific keys are described below. Additional screen\-specific keys are described below.
.SH SCREENS .SH SCREENS
@ -330,6 +334,9 @@ transactions/postings are shown.
.PP .PP
Press \f[C]right\f[] or \f[C]enter\f[] to view the selected transaction Press \f[C]right\f[] or \f[C]enter\f[] to view the selected transaction
in full detail. in full detail.
.PP
Note, filter queries which filter by account name do not yet do much
useful on this screen.
.SS Transaction screen .SS Transaction screen
.PP .PP
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,

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

@ -157,16 +157,20 @@ Generally the cursor keys navigate; `right' (or `enter') goes deeper,
`left' returns to the previous screen, `up'/`down'/`page up'/`page `left' returns to the previous screen, `up'/`down'/`page up'/`page
down'/`home'/`end' move up and down through lists. down'/`home'/`end' move up and down through lists.
`g' gets the latest data and reloads the screen (and any previous `g' gets the latest data and refreshes the screen (and any previous
screens). With large journal files, there can be a noticeable pause. screens). With large journal files, there can be a noticeable pause.
`q' quits the application. `/' lets you set or change the filter query, which limits the data
shown on most screens (in addition to the quick filters described
below). While editing the query you can use typical command-line edit
keys (ctrl-a/e/k), press enter to set the new filter, or press escape to
cancel.
`f' lets you add or change the current filter query which limits the `BACKSPACE' or `DELETE' clears any filters in effect.
data shown on most screens. While editing, you can use typical
command-line edit keys, and press enter to set the new filter, or escape `ESCAPE' clears any filters and jumps to the top screen.
to cancel. Note queries which filter by account name may not work well
in the register screen. `q' quits the application.
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
@ -267,6 +271,9 @@ uncleared transactions/postings are shown.
Press `right' or `enter' to view the selected transaction in full Press `right' or `enter' to view the selected transaction in full
detail. detail.
Note, filter queries which filter by account name do not yet do much
useful on this screen.
 
File: hledger-ui.1.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS File: hledger-ui.1.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS
@ -309,15 +316,15 @@ Node: OPTIONS714
Ref: #options813 Ref: #options813
Node: KEYS3689 Node: KEYS3689
Ref: #keys3786 Ref: #keys3786
Node: SCREENS4506 Node: SCREENS4611
Ref: #screens4593 Ref: #screens4698
Node: Accounts screen4683 Node: Accounts screen4788
Ref: #accounts-screen4813 Ref: #accounts-screen4918
Node: Register screen5917 Node: Register screen6022
Ref: #register-screen6074 Ref: #register-screen6179
Node: Transaction screen7731 Node: Transaction screen7932
Ref: #transaction-screen7891 Ref: #transaction-screen8092
Node: Error screen8758 Node: Error screen8959
Ref: #error-screen8882 Ref: #error-screen9083
 
End Tag Table End Tag Table

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

@ -87,16 +87,20 @@ _reportingoptions_
Generally the cursor keys navigate; `right` (or `enter`) goes deeper, `left` returns to the previous screen, Generally 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. `up`/`down`/`page up`/`page down`/`home`/`end` move up and down through lists.
`g` gets the latest data and reloads the screen (and any previous `g` gets the latest data and refreshes the screen (and any previous
screens). With large journal files, there can be a noticeable pause. screens). With large journal files, there can be a noticeable pause.
`q` quits the application. `/` lets you set or change the [filter query](/journal.html#queries),
which limits the data shown on most screens (in addition to the quick
filters described below). While editing the query you can use typical
command-line edit keys (ctrl-a/e/k), press enter to set the new filter,
or press escape to cancel.
`f` lets you add or change the current `BACKSPACE` or `DELETE` clears any filters in effect.
[filter query](/journal.html#queries) which limits the data shown on
most screens. While editing, you can use typical command-line edit keys, `ESCAPE` clears any filters and jumps to the top screen.
and press enter to set the new filter, or escape to cancel. Note queries
which filter by account name may not work well in the register screen. `q` quits the application.
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
@ -178,6 +182,9 @@ transactions/postings are shown.
Press `right` or `enter` to view the selected transaction in full Press `right` or `enter` to view the selected transaction in full
detail. detail.
Note, filter queries which filter by account name do not yet do much
useful on this screen.
## Transaction screen ## Transaction screen
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,

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

@ -149,16 +149,20 @@ KKEEYYSS
returns to the previous screen, up/down/page up/page down/home/end move returns to the previous screen, up/down/page up/page down/home/end move
up and down through lists. up and down through lists.
g gets the latest data and reloads the screen (and any previous g gets the latest data and refreshes the screen (and any previous
screens). With large journal files, there can be a noticeable pause. screens). With large journal files, there can be a noticeable pause.
q quits the application. / lets you set or change the filter query, which limits the data shown
on most screens (in addition to the quick filters described below).
While editing the query you can use typical command-line edit keys
(ctrl-a/e/k), press enter to set the new filter, or press escape to
cancel.
f lets you add or change the current filter query which limits the data BACKSPACE or DELETE clears any filters in effect.
shown on most screens. While editing, you can use typical command-line
edit keys, and press enter to set the new filter, or escape to cancel. ESCAPE clears any filters and jumps to the top screen.
Note queries which filter by account name may not work well in the reg-
ister screen. q quits the application.
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
@ -232,34 +236,37 @@ SSCCRREEEENNSS
Press right or enter to view the selected transaction in full detail. Press right or enter to view the selected transaction in full detail.
Note, filter queries which filter by account name do not yet do much
useful on this screen.
TTrraannssaaccttiioonn ssccrreeeenn TTrraannssaaccttiioonn ssccrreeeenn
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour- similar to hledger's print command and journal format (hledger_jour-
nal(5)). nal(5)).
The transaction's date(s) and any cleared flag, transaction code, The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more shown. Simple transactions have two postings, but there can be more
(or in certain cases, fewer). (or in certain cases, fewer).
up and down will step through all transactions listed in the previous up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary show your position within that account register. They will vary
depending on which account register you came from (remember most trans- depending on which account register you came from (remember most trans-
actions appear in multiple account registers). The #N number preceding actions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour- them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload). nal, which is a more stable id (at least until the next reload).
EErrrroorr ssccrreeeenn EErrrroorr ssccrreeeenn
This screen will appear if there is a problem, such as a parse error, This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem described, when you press g to reload. Once you have fixed the problem described,
press g again to reload and restore normal operation. press g again to reload and restore normal operation.
EENNVVIIRROONNMMEENNTT EENNVVIIRROONNMMEENNTT
LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is
~/.hledger.journal. ~/.hledger.journal.
CCOOLLUUMMNNSS sets the screen width to use (normally the full terminal CCOOLLUUMMNNSS sets the screen width to use (normally the full terminal
width). width).
FFIILLEESS FFIILLEESS
@ -268,7 +275,7 @@ FFIILLEESS
file. file.
BBUUGGSS BBUUGGSS
The need to precede options with -- when invoked from hledger is awk- The need to precede options with -- when invoked from hledger is awk-
ward. ward.
-f- doesn't work (hledger-ui can't read from stdin). -f- doesn't work (hledger-ui can't read from stdin).
@ -279,14 +286,14 @@ BBUUGGSS
which may cause a noticeable pause. Also there is no visual indication which may cause a noticeable pause. Also there is no visual indication
that this is in progress. that this is in progress.
The register screen's switching between historic balance and running The register screen's switching between historic balance and running
total based on query arguments may be confusing, and there is no column total based on query arguments may be confusing, and there is no column
heading to indicate which is being displayed. heading to indicate which is being displayed.
RREEPPOORRTTIINNGG BBUUGGSS RREEPPOORRTTIINNGG BBUUGGSS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list) or hledger mail list)
@ -300,7 +307,7 @@ CCOOPPYYRRIIGGHHTT
SSEEEE AALLSSOO SSEEEE AALLSSOO
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1) dot(5), ledger(1)