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

ui: doc: a key runs add

Browse Source
This commit is contained in:
Simon Michael 2016-06-09 09:56:36 -07:00
parent a6d859c273
commit a70eca8e01
4 changed files with 73 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -226,9 +226,13 @@ 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 refreshes the current screen and any \f[C]g\f[] reloads from the data file(s) and updates the current screen
previous screens. and any previous screens.
(With large journal files, there can be a noticeable pause.) (With large files, there can be a noticeable pause.)
.PP
\f[C]a\f[] runs command\-line hledger\[aq]s add command, and reloads
hledger\-ui.
This allows some basic data entry.
.PP .PP
\f[C]/\f[] lets you set or change the filter query, which limits the \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 data shown on most screens (in addition to the quick filters described

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

@ -157,10 +157,13 @@ 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 refreshes the current screen and any `g' reloads from the data file(s) and updates the current screen and
previous screens. (With large journal files, there can be a noticeable any previous screens. (With large files, there can be a noticeable
pause.) pause.)
`a' runs command-line hledger's add command, and reloads hledger-ui.
This allows some basic data entry.
`/' lets you set or change the filter query, which limits the data `/' lets you set or change the filter query, which limits the data
shown on most screens (in addition to the quick filters described shown on most screens (in addition to the quick filters described
below). While editing the query you can use typical command-line edit below). While editing the query you can use typical command-line edit
@ -317,15 +320,15 @@ Node: OPTIONS714
Ref: #options813 Ref: #options813
Node: KEYS3689 Node: KEYS3689
Ref: #keys3786 Ref: #keys3786
Node: SCREENS4619 Node: SCREENS4726
Ref: #screens4706 Ref: #screens4813
Node: Accounts screen4796 Node: Accounts screen4903
Ref: #accounts-screen4926 Ref: #accounts-screen5033
Node: Register screen6030 Node: Register screen6137
Ref: #register-screen6187 Ref: #register-screen6294
Node: Transaction screen7940 Node: Transaction screen8047
Ref: #transaction-screen8100 Ref: #transaction-screen8207
Node: Error screen8967 Node: Error screen9074
Ref: #error-screen9091 Ref: #error-screen9198
 
End Tag Table End Tag Table

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

@ -87,9 +87,11 @@ _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 refreshes the current screen and any `g` reloads from the data file(s) and updates the current screen and any
previous screens. (With large journal files, there can be a noticeable previous screens. (With large files, there can be a noticeable pause.)
pause.)
`a` runs command-line hledger's add command, and reloads hledger-ui.
This allows some basic data entry.
`/` lets you set or change the [filter query](/hledger.html#queries), `/` lets you set or change the [filter query](/hledger.html#queries),
which limits the data shown on most screens (in addition to the quick which limits the data shown on most screens (in addition to the quick

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

@ -149,14 +149,16 @@ 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 refreshes the current screen and any previ- g reloads from the data file(s) and updates the current screen and any
ous screens. (With large journal files, there can be a noticeable previous screens. (With large files, there can be a noticeable pause.)
pause.)
/ lets you set or change the filter query, which limits the data shown a runs command-line hledger's add command, and reloads hledger-ui.
on most screens (in addition to the quick filters described below). This allows some basic data entry.
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 / 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. cancel.
BACKSPACE or DELETE clears any filters in effect. BACKSPACE or DELETE clears any filters in effect.
@ -169,25 +171,25 @@ KKEEYYSS
SSCCRREEEENNSS SSCCRREEEENNSS
AAccccoouunnttss ssccrreeeenn AAccccoouunnttss ssccrreeeenn
This is normally the first screen displayed. It lists accounts and This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances. if you specify a query all accounts and their latest ending balances. if you specify a query
on the command line, it shows just the matched accounts and the bal- on the command line, it shows just the matched accounts and the bal-
ances from matched transactions. ances from matched transactions.
When not in flat mode, indentation indicates the account hierarchy. F When not in flat mode, indentation indicates the account hierarchy. F
toggles flat mode on and off. toggles flat mode on and off.
By default, all subaccounts are displayed. To see less detail, set a By default, all subaccounts are displayed. To see less detail, set a
depth limit by pressing a number key, 1 to 9. Or, adjust the depth 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. limit by pressing - or + (= also works). 0 removes the depth limit.
E toggles nonzero mode, in which only accounts with nonzero balances E toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line are shown (hledger-ui shows zero items by default, unlike command-line
hledger). hledger).
C toggles cleared mode, in which uncleared transactions and postings C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared are not shown. U toggles uncleared mode, in which only uncleared
transactions/postings are shown. transactions/postings are shown.
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
@ -201,17 +203,17 @@ SSCCRREEEENNSS
+o Each line represents a whole transaction. +o Each line represents a whole transaction.
+o For each transaction, it shows the other account(s) involved, in +o For each transaction, it shows the other account(s) involved, in
abbreviated form. (If there are both real and virtual postings, it abbreviated form. (If there are both real and virtual postings, it
shows only the accounts affected by real postings.) shows only the accounts affected by real postings.)
+o It shows the overall change to the current account's balance from +o It shows the overall change to the current account's balance from
each transaction; positive for an inflow to this account, negative each transaction; positive for an inflow to this account, negative
for an outflow. for an outflow.
+o When no query other than a date limit is in effect, it shows the cur- +o When no query other than a date limit is in effect, it shows the cur-
rent account's historic balance as of the transaction date. Other- rent account's historic balance as of the transaction date. Other-
wise it shows a running total starting from zero. Eg, these will wise it shows a running total starting from zero. Eg, these will
show historic balances: show historic balances:
$ hledger-ui $ hledger-ui
@ -225,49 +227,49 @@ SSCCRREEEENNSS
$ hledger-ui --begin 'this month' desc:market $ hledger-ui --begin 'this month' desc:market
$ hledger-ui --register checking --cleared $ hledger-ui --register checking --cleared
E toggles nonzero mode, in which only transactions posting a nonzero E toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com- change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger). mand-line hledger).
C toggles cleared mode, in which uncleared transactions and postings C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared are not shown. U toggles uncleared mode, in which only uncleared
transactions/postings are shown. transactions/postings are shown.
R toggles real mode, in which virtual 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. 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 Note, filter queries which filter by account name do not yet do much
useful on this screen. 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
@ -276,7 +278,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).
@ -287,14 +289,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)
@ -308,7 +310,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)