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

ui: tweak --change help

Browse Source
This commit is contained in:
Simon Michael 2016-11-24 20:24:07 -08:00
parent 6dd406779b
commit 3387b45a90
5 changed files with 101 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-ui/Hledger/UI/UIOptions.hs
View File

@ -30,7 +30,7 @@ uiflags = [
,flagReq ["theme"] (\s opts -> Right $ setopt "theme" s opts) "THEME" ("use this custom display theme ("++intercalate ", " themeNames++")") ,flagReq ["theme"] (\s opts -> Right $ setopt "theme" s opts) "THEME" ("use this custom display theme ("++intercalate ", " themeNames++")")
,flagReq ["register"] (\s opts -> Right $ setopt "register" s opts) "ACCTREGEX" "start in the (first) matched account's register" ,flagReq ["register"] (\s opts -> Right $ setopt "register" s opts) "ACCTREGEX" "start in the (first) matched account's register"
,flagNone ["change"] (\opts -> setboolopt "change" opts) ,flagNone ["change"] (\opts -> setboolopt "change" opts)
"show period balances (changes) at startup" "show period balances (changes) at startup instead of historical balances"
-- ,flagNone ["cumulative"] (\opts -> setboolopt "cumulative" opts) -- ,flagNone ["cumulative"] (\opts -> setboolopt "cumulative" opts)
-- "show balance change accumulated across periods (in multicolumn reports)" -- "show balance change accumulated across periods (in multicolumn reports)"
-- ,flagNone ["historical","H"] (\opts -> setboolopt "historical" opts) -- ,flagNone ["historical","H"] (\opts -> setboolopt "historical" opts)

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

@ -55,7 +55,7 @@ start in the (first) matched account\[aq]s register screen
.RE .RE
.TP .TP
.B \f[C]\-\-change\f[] .B \f[C]\-\-change\f[]
show period balances (changes) at startup show period balances (changes) at startup instead of historical balances
.RS .RS
.RE .RE
.TP .TP

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

@ -47,7 +47,8 @@ the data.
start in the (first) matched account's register screen start in the (first) matched account's register screen
`--change' `--change'
show period balances (changes) at startup show period balances (changes) at startup instead of historical
balances
`--flat' `--flat'
show full account names, unindented show full account names, unindented
@ -357,17 +358,17 @@ Tag Table:
Node: Top88 Node: Top88
Node: OPTIONS823 Node: OPTIONS823
Ref: #options922 Ref: #options922
Node: KEYS3909 Node: KEYS3945
Ref: #keys4006 Ref: #keys4042
Node: SCREENS6407 Node: SCREENS6443
Ref: #screens6494 Ref: #screens6530
Node: Accounts screen6584 Node: Accounts screen6620
Ref: #accounts-screen6714 Ref: #accounts-screen6750
Node: Register screen8752 Node: Register screen8788
Ref: #register-screen8909 Ref: #register-screen8945
Node: Transaction screen10797 Node: Transaction screen10833
Ref: #transaction-screen10957 Ref: #transaction-screen10993
Node: Error screen11824 Node: Error screen11860
Ref: #error-screen11948 Ref: #error-screen11984
 
End Tag Table End Tag Table

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

@ -59,7 +59,7 @@ Any QUERYARGS are interpreted as a hledger search query which filters the data.
: start in the (first) matched account's register screen : start in the (first) matched account's register screen
`--change` `--change`
: show period balances (changes) at startup : show period balances (changes) at startup instead of historical balances
`--flat` `--flat`
: show full account names, unindented : show full account names, unindented

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

@ -45,7 +45,8 @@ OPTIONS
start in the (first) matched account's register screen start in the (first) matched account's register screen
--change --change
show period balances (changes) at startup show period balances (changes) at startup instead of historical
balances
--flat show full account names, unindented --flat show full account names, unindented
@ -57,7 +58,7 @@ OPTIONS
-h show general usage (or after COMMAND, the command's usage) -h show general usage (or after COMMAND, the command's usage)
--help show the current program's manual as plain text (or after an --help show the current program's manual as plain text (or after an
add-on COMMAND, the add-on's manual) add-on COMMAND, the add-on's manual)
--man show the current program's manual with man --man show the current program's manual with man
@ -74,7 +75,7 @@ OPTIONS
use a different input file. For stdin, use - use a different input file. For stdin, use -
--rules-file=RULESFILE --rules-file=RULESFILE
Conversion rules file to use when reading CSV (default: Conversion rules file to use when reading CSV (default:
FILE.rules) FILE.rules)
--alias=OLD=NEW --alias=OLD=NEW
@ -107,7 +108,7 @@ OPTIONS
multiperiod/multicolumn report by year multiperiod/multicolumn report by year
-p --period=PERIODEXP -p --period=PERIODEXP
set start date, end date, and/or reporting interval all at once set start date, end date, and/or reporting interval all at once
(overrides the flags above) (overrides the flags above)
--date2 --date2
@ -135,60 +136,60 @@ OPTIONS
show amounts in their cost price's commodity show amounts in their cost price's commodity
--pivot TAG --pivot TAG
will transform the journal before any other processing by will transform the journal before any other processing by
replacing the account name of every posting having the tag TAG replacing the account name of every posting having the tag TAG
with content VALUE by the account name "TAG:VALUE". with content VALUE by the account name "TAG:VALUE".
The TAG will only match if it is a full-length match. The pivot will The TAG will only match if it is a full-length match. The pivot will
only happen if the TAG is on a posting, not if it is on the transac- only happen if the TAG is on a posting, not if it is on the transac-
tion. If the tag value is a multi:level:account:name the new account tion. If the tag value is a multi:level:account:name the new account
name will be "TAG:multi:level:account:name". name will be "TAG:multi:level:account:name".
--anon show anonymized accounts and payees --anon show anonymized accounts and payees
KEYS KEYS
? shows a help dialog listing all keys. (Some of these also appear in ? 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, 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: 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 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 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. 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 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 faster you may want to adjust it. (If you're on a mac, the Karabiner
app is one way to do that.) app is one way to do that.)
With shift pressed, the cursor keys adjust the report period, limiting With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown). the transactions to be shown (by default, all are shown).
shift-down/up steps downward and upward through these standard report shift-down/up steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then, period durations: year, quarter, month, week, day. Then,
shift-left/right moves to the previous/next period. t sets the report 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 period to today. (To set a non-standard period, you can use / and a
date: query). date: query).
/ lets you set a general filter query limiting the data shown, using / 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 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 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 it, or ESCAPEto cancel. There are also keys for quickly adjusting some
common filters like account depth and cleared/uncleared (see below). common filters like account depth and cleared/uncleared (see below).
BACKSPACE or DELETE removes all filters, showing all transactions. BACKSPACE or DELETE removes all filters, showing all transactions.
ESCAPE removes all filters and jumps back to the top screen. Or, it ESCAPE removes all filters and jumps back to the top screen. Or, it
cancels a minibuffer edit or help dialog in progress. cancels a minibuffer edit or help dialog in progress.
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 previous screens. (With large files, this could cause a noticeable
pause.) pause.)
I toggles balance assertion checking. Disabling balance assertions I toggles balance assertion checking. Disabling balance assertions
temporarily can be useful for troubleshooting. temporarily can be useful for troubleshooting.
a runs command-line hledger's add command, and reloads the updated a runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry. file. This allows some basic data entry.
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac- E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac-
sclient -a "" -nw) on the journal file. With some editors (emacs, vi), sclient -a "" -nw) on the journal file. With some editors (emacs, vi),
the cursor will be positioned at the current transaction when invoked the cursor will be positioned at the current transaction when invoked
from the register and transaction screens, and at the error location from the register and transaction screens, and at the error location
(if possible) when invoked from the error screen. (if possible) when invoked from the error screen.
q quits the application. q quits the application.
@ -197,42 +198,42 @@ KEYS
SCREENS SCREENS
Accounts screen Accounts screen
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 (including the balances all accounts and their latest ending balances (including the balances
of subaccounts). if you specify a query on the command line, it shows of subaccounts). if you specify a query on the command line, it shows
just the matched accounts and the balances from matched transactions. just the matched accounts and the balances from matched transactions.
Account names are normally indented to show the hierarchy (tree mode). Account names are normally indented to show the hierarchy (tree mode).
To see less detail, set a depth limit by pressing a number key, 1 to 9. To see less detail, set a depth limit by pressing a number key, 1 to 9.
0 shows even less detail, collapsing all accounts to a single total. - 0 shows even less detail, collapsing all accounts to a single total. -
and + (or =) decrease and increase the depth limit. To remove the and + (or =) decrease and increase the depth limit. To remove the
depth limit, set it higher than the maximum account depth, or press depth limit, set it higher than the maximum account depth, or press
ESCAPE. ESCAPE.
F toggles flat mode, in which accounts are shown as a flat list, with F toggles flat mode, in which accounts are shown as a flat list, with
their full names. In this mode, account balances exclude subaccounts, their full names. In this mode, account balances exclude subaccounts,
except for accounts at the depth limit (as with hledger's balance com- except for accounts at the depth limit (as with hledger's balance com-
mand). mand).
H toggles between showing historical balances or period balances. His- H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before (filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log. the report period. They are more useful eg when viewing a time log.
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.
Z toggles nonzero mode, in which only accounts with nonzero balances Z 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).
Press right or enter to view an account's transactions register. Press right or enter to view an account's transactions register.
@ -241,62 +242,62 @@ SCREENS
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows: a check register. Each line represents one transaction and shows:
o the other account(s) involved, in abbreviated form. (If there are o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected both real and virtual postings, it shows only the accounts affected
by real postings.) by real postings.)
o the overall change to the current account's balance; positive for an o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow. inflow to this account, negative for an outflow.
o the running historical total or period total for the current account, o the running historical total or period total for the current account,
after the transaction. This can be toggled with H. Similar to the after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while (filtered by the filter query) before the report start date, while
the period total is not. If the historical total is not disturbed by the period total is not. If the historical total is not disturbed by
a filter query, it will be the running historical balance you would a filter query, it will be the running historical balance you would
see on a bank register for the current account. see on a bank register for the current account.
If the accounts screen was in tree mode, the register screen will If the accounts screen was in tree mode, the register screen will
include transactions from both the current account and its subaccounts. include transactions from both the current account and its subaccounts.
If the accounts screen was in flat mode, and a non-depth-clipped If the accounts screen was in flat mode, and a non-depth-clipped
account was selected, the register screen will exclude transactions account was selected, the register screen will exclude transactions
from subaccounts. In other words, the register always shows the trans- from subaccounts. In other words, the register always shows the trans-
actions responsible for the period balance shown on the accounts actions responsible for the period balance shown on the accounts
screen. As on the accounts screen, this can be toggled with F. screen. As on the accounts screen, this can be toggled with F.
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.
Z toggles nonzero mode, in which only transactions posting a nonzero Z 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).
Press right (or enter) to view the selected transaction in detail. Press right (or enter) to view the selected transaction in detail.
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,
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).
Error screen Error screen
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, press g when you press g to reload. Once you have fixed the problem, press g
again to reload and resume normal operation. (Or, you can press escape again to reload and resume normal operation. (Or, you can press escape
to cancel the reload attempt.) to cancel the reload attempt.)
@ -304,17 +305,17 @@ ENVIRONMENT
COLUMNS The screen width to use. Default: the full terminal width. COLUMNS The screen width to use. Default: the full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default: LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal). nal).
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). C:/Users/USER/.hledger.journal).
BUGS BUGS
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).
@ -325,14 +326,14 @@ BUGS
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.
REPORTING BUGS REPORTING BUGS
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)
@ -346,7 +347,7 @@ COPYRIGHT
SEE ALSO SEE ALSO
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)