From bfae74a18b1e2c86c46ac0875d5769e6aa40194f Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 7 Jun 2016 09:41:36 -0700 Subject: [PATCH] ui: doc: fix filter query link --- hledger-ui/doc/hledger-ui.1 | 6 +-- hledger-ui/doc/hledger-ui.1.info | 25 ++++----- hledger-ui/doc/hledger-ui.1.m4.md | 7 +-- hledger-ui/doc/hledger-ui.1.txt | 87 ++++++++++++++++--------------- 4 files changed, 64 insertions(+), 61 deletions(-) diff --git a/hledger-ui/doc/hledger-ui.1 b/hledger-ui/doc/hledger-ui.1 index 58d078326..db69bfacc 100644 --- a/hledger-ui/doc/hledger-ui.1 +++ b/hledger-ui/doc/hledger-ui.1 @@ -226,9 +226,9 @@ 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[] move up and down through lists. .PP -\f[C]g\f[] gets the latest data and refreshes the screen (and any -previous screens). -With large journal files, there can be a noticeable pause. +\f[C]g\f[] gets the latest data and refreshes the current screen and any +previous screens. +(With large journal files, there can be a noticeable pause.) .PP \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 diff --git a/hledger-ui/doc/hledger-ui.1.info b/hledger-ui/doc/hledger-ui.1.info index 796f2970b..7acdc0c74 100644 --- a/hledger-ui/doc/hledger-ui.1.info +++ b/hledger-ui/doc/hledger-ui.1.info @@ -157,8 +157,9 @@ 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 refreshes the screen (and any previous -screens). With large journal files, there can be a noticeable pause. + `g' gets the latest data and refreshes the current screen and any +previous screens. (With large journal files, there can be a noticeable +pause.) `/' lets you set or change the filter query, which limits the data shown on most screens (in addition to the quick filters described @@ -316,15 +317,15 @@ Node: OPTIONS714 Ref: #options813 Node: KEYS3689 Ref: #keys3786 -Node: SCREENS4611 -Ref: #screens4698 -Node: Accounts screen4788 -Ref: #accounts-screen4918 -Node: Register screen6022 -Ref: #register-screen6179 -Node: Transaction screen7932 -Ref: #transaction-screen8092 -Node: Error screen8959 -Ref: #error-screen9083 +Node: SCREENS4619 +Ref: #screens4706 +Node: Accounts screen4796 +Ref: #accounts-screen4926 +Node: Register screen6030 +Ref: #register-screen6187 +Node: Transaction screen7940 +Ref: #transaction-screen8100 +Node: Error screen8967 +Ref: #error-screen9091  End Tag Table diff --git a/hledger-ui/doc/hledger-ui.1.m4.md b/hledger-ui/doc/hledger-ui.1.m4.md index 4dc68f618..7aa8b0bc8 100644 --- a/hledger-ui/doc/hledger-ui.1.m4.md +++ b/hledger-ui/doc/hledger-ui.1.m4.md @@ -87,10 +87,11 @@ _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 refreshes the screen (and any previous -screens). With large journal files, there can be a noticeable pause. +`g` gets the latest data and refreshes the current screen and any +previous screens. (With large journal files, there can be a noticeable +pause.) -`/` lets you set or change the [filter query](/journal.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 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, diff --git a/hledger-ui/doc/hledger-ui.1.txt b/hledger-ui/doc/hledger-ui.1.txt index 2df0f9b17..3285db72d 100644 --- a/hledger-ui/doc/hledger-ui.1.txt +++ b/hledger-ui/doc/hledger-ui.1.txt @@ -149,13 +149,14 @@ KKEEYYSS 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 refreshes the screen (and any previous - screens). With large journal files, there can be a noticeable pause. + g gets the latest data and refreshes the current screen and any previ- + ous screens. (With large journal files, there can be a noticeable + pause.) - / 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 + / 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. BACKSPACE or DELETE clears any filters in effect. @@ -168,25 +169,25 @@ KKEEYYSS SSCCRREEEENNSS AAccccoouunnttss ssccrreeeenn - This is normally the first screen displayed. It lists accounts and - their balances, like hledger's balance command. By default, it shows - 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- + This is normally the first screen displayed. It lists accounts and + their balances, like hledger's balance command. By default, it shows + 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- 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. - 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 + 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 limit by pressing - or + (= also works). 0 removes the depth limit. - E toggles nonzero mode, in which only accounts with nonzero balances - are shown (hledger-ui shows zero items by default, unlike command-line + 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 not shown. U toggles uncleared mode, in which only uncleared + C toggles cleared mode, in which uncleared transactions and postings + are not shown. U toggles uncleared mode, in which only uncleared transactions/postings are shown. R toggles real mode, in which virtual postings are ignored. @@ -200,17 +201,17 @@ SSCCRREEEENNSS +o Each line represents a whole transaction. - +o For each transaction, it shows the other account(s) involved, in - abbreviated form. (If there are both real and virtual postings, it + +o For each transaction, it shows the other account(s) involved, in + abbreviated form. (If there are both real and virtual postings, it shows only the accounts affected by real postings.) - +o It shows the overall change to the current account's balance from - each transaction; positive for an inflow to this account, negative + +o It shows the overall change to the current account's balance from + each transaction; positive for an inflow to this account, negative for an outflow. +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- - wise it shows a running total starting from zero. Eg, these will + rent account's historic balance as of the transaction date. Other- + wise it shows a running total starting from zero. Eg, these will show historic balances: $ hledger-ui @@ -224,49 +225,49 @@ 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- + 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 not shown. U toggles uncleared mode, in which only uncleared + C toggles cleared mode, in which uncleared transactions and postings + are not shown. U toggles uncleared mode, in which only uncleared transactions/postings are shown. R toggles real mode, in which virtual postings are ignored. 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. 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 @@ -275,7 +276,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). @@ -286,14 +287,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) @@ -307,7 +308,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)