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

doc: ui: document new keys

Browse Source
This commit is contained in:
Simon Michael 2016-06-03 10:22:04 -07:00
parent 54571ede20
commit 7338543699
4 changed files with 115 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -228,7 +228,7 @@ move up and down through lists.
.PP
\f[C]g\f[] gets the latest data and reloads the screen (and any previous
screens).
There may be a noticeable pause.
With large journal files, there can be a noticeable pause.
.PP
\f[C]q\f[] quits the application.
.PP
@ -253,23 +253,23 @@ Or, adjust the depth limit by pressing \f[C]\-\f[] or \f[C]+\f[]
(\f[C]=\f[] also works).
\f[C]0\f[] removes the depth limit.
.PP
\f[C]C\f[] toggles cleared mode.
In cleared mode, the accounts and balances are derived only from
transactions which are marked cleared (*).
\f[C]E\f[] toggles nonzero mode, in which only accounts with nonzero
balances are shown (hledger\-ui shows zero items by default, unlike
command\-line hledger).
.PP
\f[C]C\f[] toggles cleared mode, in which uncleared transactions (and
postings) are ignored.
.PP
\f[C]R\f[] toggles real mode, in which virtual postings are ignored.
.PP
Press \f[C]right\f[] or \f[C]enter\f[] to view an account\[aq]s
transactions register.
.SS Register screen
.PP
This screen lists all transactions affecting a particular account (like
a check register).
In cleared mode (press \f[C]C\f[]) it lists only transactions which are
marked cleared.
It does not otherwise filter by query.
.PP
Note this screen shows transactions, not postings (unlike hledger\[aq]s
register command).
This means:
This screen lists all transactions affecting a particular account, like
a check register.
Unlike hledger\[aq]s register command (which lists individual postings),
in hledger\-ui\[aq]s register:
.IP \[bu] 2
Each line represents a whole transaction.
.IP \[bu] 2
@ -308,6 +308,15 @@ $\ hledger\-ui\ \-\-register\ checking\ \-\-cleared
.fi
.RE
.PP
\f[C]E\f[] toggles nonzero mode, in which only transactions posting a
nonzero change are shown (hledger\-ui shows zero items by default,
unlike command\-line hledger).
.PP
\f[C]C\f[] toggles cleared mode, in which uncleared transactions (and
postings) are ignored.
.PP
\f[C]R\f[] toggles real mode, in which virtual postings are ignored.
.PP
Press \f[C]right\f[] or \f[C]enter\f[] to view the selected transaction
in full detail.
.SS Transaction screen

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

@ -158,7 +158,7 @@ Generally the cursor keys navigate; `right' (or `enter') goes deeper,
down'/`home'/`end' move up and down through lists.
`g' gets the latest data and reloads the screen (and any previous
screens). There may be a noticeable pause.
screens). With large journal files, there can be a noticeable pause.
`q' quits the application.
@ -197,8 +197,14 @@ depth limit by pressing a number key, `1' to `9'. Or, adjust the depth
limit by pressing `-' or `+' (`=' also works). `0' removes the depth
limit.
`C' toggles cleared mode. In cleared mode, the accounts and balances
are derived only from transactions which are marked cleared (*).
`E' toggles nonzero mode, in which only accounts with nonzero
balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger).
`C' toggles cleared mode, in which uncleared transactions (and
postings) are ignored.
`R' toggles real mode, in which virtual postings are ignored.
Press `right' or `enter' to view an account's transactions register.
@ -208,13 +214,9 @@ File: hledger-ui.1.info, Node: Register screen, Next: Transaction screen, Pre
3.2 Register screen
===================
This screen lists all transactions affecting a particular account (like
a check register). In cleared mode (press `C') it lists only
transactions which are marked cleared. It does not otherwise filter by
query.
Note this screen shows transactions, not postings (unlike hledger's
register command). This means:
This screen lists all transactions affecting a particular account, like
a check register. Unlike hledger's register command (which lists
individual postings), in hledger-ui's register:
* Each line represents a whole transaction.
@ -245,6 +247,15 @@ register command). This means:
$ hledger-ui --register checking --cleared
`E' toggles nonzero mode, in which only transactions posting a
nonzero change are shown (hledger-ui shows zero items by default, unlike
command-line hledger).
`C' toggles cleared mode, in which uncleared transactions (and
postings) are ignored.
`R' toggles real mode, in which virtual postings are ignored.
Press `right' or `enter' to view the selected transaction in full
detail.
@ -290,15 +301,15 @@ Node: OPTIONS714
Ref: #options813
Node: KEYS3689
Ref: #keys3786
Node: SCREENS4183
Ref: #screens4270
Node: Accounts screen4360
Ref: #accounts-screen4490
Node: Register screen5335
Ref: #register-screen5492
Node: Transaction screen6874
Ref: #transaction-screen7034
Node: Error screen7901
Ref: #error-screen8025
Node: SCREENS4209
Ref: #screens4296
Node: Accounts screen4386
Ref: #accounts-screen4516
Node: Register screen5535
Ref: #register-screen5692
Node: Transaction screen7264
Ref: #transaction-screen7424
Node: Error screen8291
Ref: #error-screen8415

End Tag Table

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

@ -87,7 +87,8 @@ _reportingoptions_
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.
`g` gets the latest data and reloads the screen (and any previous screens). There may be a noticeable pause.
`g` gets the latest data and reloads the screen (and any previous
screens). With large journal files, there can be a noticeable pause.
`q` quits the application.
@ -109,19 +110,23 @@ To see less detail, set a depth limit by pressing a number key, `1` to `9`.
Or, adjust the depth limit by pressing `-` or `+` (`=` also works).
`0` removes the depth limit.
`C` toggles cleared mode. In cleared mode, the accounts and balances
are derived only from transactions which are marked cleared (*).
`E` toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line
hledger).
`C` toggles cleared mode, in which
[uncleared transactions (and postings)](/journal.html#transactions) are
ignored.
`R` toggles real mode, in which [virtual postings](/journal.html#virtual-postings) are ignored.
Press `right` or `enter` to view an account's transactions register.
## Register screen
This screen lists all transactions affecting a particular account (like a check register).
In cleared mode (press `C`) it lists only transactions which are marked cleared.
It does not otherwise filter by query.
Note this screen shows transactions, not postings (unlike hledger's
register command). This means:
This screen lists all transactions affecting a particular account, like
a check register. Unlike hledger's register command (which
lists individual postings), in hledger-ui's register:
- Each line represents a whole transaction.
@ -152,7 +157,18 @@ register command). This means:
$ hledger-ui --register checking --cleared
```
Press `right` or `enter` to view the selected transaction in full detail.
`E` toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default,
unlike command-line hledger).
`C` toggles cleared mode, in which
[uncleared transactions (and postings)](/journal.html#transactions) are
ignored.
`R` toggles real mode, in which [virtual postings](/journal.html#virtual-postings) are ignored.
Press `right` or `enter` to view the selected transaction in full
detail.
## Transaction screen

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

@ -150,7 +150,7 @@ KKEEYYSS
up and down through lists.
g gets the latest data and reloads the screen (and any previous
screens). There may be a noticeable pause.
screens). With large journal files, there can be a noticeable pause.
q quits the application.
@ -171,18 +171,21 @@ SSCCRREEEENNSS
depth limit by pressing a number key, 1 to 9. Or, adjust the depth
limit by pressing - or + (= also works). 0 removes the depth limit.
C toggles cleared mode. In cleared mode, the accounts and balances are
derived only from transactions which are marked cleared (*).
E toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line
hledger).
C toggles cleared mode, in which uncleared transactions (and postings)
are ignored.
R toggles real mode, in which virtual postings are ignored.
Press right or enter to view an account's transactions register.
RReeggiisstteerr ssccrreeeenn
This screen lists all transactions affecting a particular account (like
a check register). In cleared mode (press C) it lists only transac-
tions which are marked cleared. It does not otherwise filter by query.
Note this screen shows transactions, not postings (unlike hledger's
register command). This means:
This screen lists all transactions affecting a particular account, like
a check register. Unlike hledger's register command (which lists indi-
vidual postings), in hledger-ui's register:
+o Each line represents a whole transaction.
@ -210,36 +213,45 @@ SSCCRREEEENNSS
$ hledger-ui --begin 'this month' desc:market
$ hledger-ui --register checking --cleared
E toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger).
C toggles cleared mode, in which uncleared transactions (and postings)
are ignored.
R toggles real mode, in which virtual postings are ignored.
Press right or enter to view the selected transaction in full detail.
TTrraannssaaccttiioonn ssccrreeeenn
This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour-
This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour-
nal(5)).
The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more
The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more
(or in certain cases, fewer).
up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary
up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary
depending on which account register you came from (remember most trans-
actions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload).
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,
press g again to reload and restore normal operation.
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.
CCOOLLUUMMNNSS sets the screen width to use (normally the full terminal
CCOOLLUUMMNNSS sets the screen width to use (normally the full terminal
width).
FFIILLEESS
@ -248,7 +260,7 @@ FFIILLEESS
file.
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.
-f- doesn't work (hledger-ui can't read from stdin).
@ -259,14 +271,14 @@ BBUUGGSS
which may cause a noticeable pause. Also there is no visual indication
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
heading to indicate which is being displayed.
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)
@ -280,7 +292,7 @@ CCOOPPYYRRIIGGHHTT
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-
dot(5), ledger(1)