Revert "doc: try making hledger-ui web manual from man page"
This wasn't right, leave the UI doc in the manual as it was for now.
This commit is contained in:
Simon Michael
parent
6259701842
commit
ed0ec6d849
@ -21,34 +21,15 @@ file format.
|
||||
hledger is inspired by and largely compatible with ledger(1).
|
||||
.PP
|
||||
hledger\-ui is hledger\[aq]s curses\-style interface.
|
||||
It reads a hledger journal file
|
||||
.PP
|
||||
(~/.hledger.journal, $LEDGER_FILE, or \-f FILE; see hledger(1) or
|
||||
hledger_journal(5))a
|
||||
.PP
|
||||
and provides a simple full\-screen console interface for viewing account
|
||||
balances and transactions.
|
||||
.PP
|
||||
It reads a hledger journal file (~/.hledger.journal, $LEDGER_FILE, or
|
||||
\-f FILE) and provides a simple full\-screen console interface for
|
||||
viewing account balances and transactions.
|
||||
It is simpler and more convenient for browsing than the command\-line
|
||||
interface, but lighter and faster than hledger\-web.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ hledger\ ui\ \-\-\ \-\-help
|
||||
hledger\-ui\ [OPTIONS]\ [PATTERNS]
|
||||
\ \ browse\ accounts,\ postings\ and\ entries\ in\ a\ full\-window\ curses\ interface
|
||||
|
||||
Flags:
|
||||
\ \ \ \ \ \-\-theme=THEME\ \ \ \ \ \ \ \ \ use\ this\ custom\ display\ theme\ (default,\ terminal,
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ greenterm)
|
||||
\ \ \ \ \ \-\-register=ACCTREGEX\ \ start\ in\ the\ (first)\ matched\ account\[aq]s\ register
|
||||
\ \ \ \ \ \-\-flat\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ show\ full\ account\ names,\ unindented
|
||||
\ \ \ \ \ \-\-no\-elide\ \ \ \ \ \ \ \ \ \ \ \ don\[aq]t\ compress\ empty\ parent\ accounts\ on\ one\ line
|
||||
\ \ \-V\ \-\-value\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ show\ amounts\ as\ their\ market\ value\ in\ their
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ default\ valuation\ commodity\ (accounts\ screen)
|
||||
\ \ ...
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
The journal file is \f[C]~/.hledger.journal\f[], \f[C]$LEDGER_FILE\f[],
|
||||
or another file specified with \-f.
|
||||
For more about the format, see hledger(1) or hledger_journal(5).
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
Note: if invoking hledger\-ui as a hledger subcommand, write
|
||||
|
||||
@ -2,17 +2,6 @@
|
||||
%
|
||||
% October 2015
|
||||
|
||||
<!--
|
||||
doc generation process:
|
||||
core docs live in per-package, man-page-structured markdown files like this one
|
||||
the whole file is used to generate a man page, with filters:
|
||||
html blocks and inline html are stripped
|
||||
content between \<!-- USERGUIDE --\> and \<!-- /USERGUIDE --\> is reused for the user guide, with filters:
|
||||
heading levels are increased (+4)
|
||||
-->
|
||||
|
||||
<div class="manpage">
|
||||
|
||||
# NAME
|
||||
|
||||
hledger-ui - curses-style interface for the hledger accounting tool
|
||||
@ -28,52 +17,15 @@ hledger is a cross-platform program for tracking money, time, or any other commo
|
||||
using double-entry accounting and a simple, editable file format.
|
||||
hledger is inspired by and largely compatible with ledger(1).
|
||||
|
||||
</div>
|
||||
|
||||
<div class="userguide">
|
||||
|
||||
<style>
|
||||
.highslide img {max-width:250px; float:right; margin:0 0 1em 1em;}
|
||||
.highslide-caption {color:white; background-color:black;}
|
||||
</style>
|
||||
<a href="images/hledger-ui/hledger-ui-sample-acc2.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc2.png" title="Accounts screen with query and depth limit" /></a>
|
||||
<a href="images/hledger-ui/hledger-ui-sample-acc.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc.png" title="Accounts screen" /></a>
|
||||
<a href="images/hledger-ui/hledger-ui-sample-acc-greenterm.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc-greenterm.png" title="Accounts screen with greenterm theme" /></a>
|
||||
<a href="images/hledger-ui/hledger-ui-sample-txn.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-txn.png" title="Transaction screen" /></a>
|
||||
<a href="images/hledger-ui/hledger-ui-sample-reg.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-reg.png" title="Register screen" /></a>
|
||||
<!-- <br clear=all> -->
|
||||
<a href="images/hledger-ui/hledger-ui-bcexample-acc.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc.png" title="beancount example accounts" /></a>
|
||||
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade:cash.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade:cash.png" title="beancount example's etrade cash subaccount" /></a>
|
||||
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" title="beancount example's etrade investments, all commoditiess" /></a>
|
||||
|
||||
</div>
|
||||
|
||||
hledger-ui is hledger's curses-style interface.
|
||||
It reads a hledger journal file
|
||||
<div class="manpage">
|
||||
(~/.hledger.journal, $LEDGER_FILE, or -f FILE; see hledger(1) or hledger_journal(5))a
|
||||
</div>
|
||||
and provides a simple full-screen console interface for viewing account balances and transactions.
|
||||
|
||||
It is simpler and more convenient for
|
||||
It reads a hledger journal file (~/.hledger.journal, $LEDGER_FILE, or -f FILE) and
|
||||
provides a simple full-screen console interface for viewing account
|
||||
balances and transactions. It is simpler and more convenient for
|
||||
browsing than the command-line interface, but lighter and faster than
|
||||
hledger-web.
|
||||
|
||||
```{.shell .noclear}
|
||||
$ hledger ui -- --help
|
||||
hledger-ui [OPTIONS] [PATTERNS]
|
||||
browse accounts, postings and entries in a full-window curses interface
|
||||
|
||||
Flags:
|
||||
--theme=THEME use this custom display theme (default, terminal,
|
||||
greenterm)
|
||||
--register=ACCTREGEX start in the (first) matched account's register
|
||||
--flat show full account names, unindented
|
||||
--no-elide don't compress empty parent accounts on one line
|
||||
-V --value show amounts as their market value in their
|
||||
default valuation commodity (accounts screen)
|
||||
...
|
||||
```
|
||||
The journal file is `~/.hledger.journal`, `$LEDGER_FILE`, or another file specified with -f.
|
||||
For more about the format, see hledger(1) or hledger_journal(5).
|
||||
|
||||
# OPTIONS
|
||||
|
||||
@ -252,8 +204,6 @@ 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.
|
||||
|
||||
<div class="manpage">
|
||||
|
||||
# ENVIRONMENT
|
||||
|
||||
**LEDGER_FILE**
|
||||
@ -283,5 +233,3 @@ visual indication that this is in progress.
|
||||
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.
|
||||
|
||||
</div>
|
||||
|
||||
190
site/manual.md
190
site/manual.md
@ -2310,16 +2310,6 @@ See the package page for more.
|
||||
|
||||
#### ui
|
||||
|
||||
<!--
|
||||
possible new doc generation process:
|
||||
core docs live in per-package, man-page-structured markdown files like this one
|
||||
the whole file is used to generate a man page, with filters:
|
||||
html blocks and inline html are stripped
|
||||
content between \<!-- USERGUIDE --\> and \<!-- /USERGUIDE --\> is reused for the user guide, with filters:
|
||||
heading levels are increased (+4)
|
||||
-->
|
||||
<div class="userguide">
|
||||
|
||||
<style>
|
||||
.highslide img {max-width:250px; float:right; margin:0 0 1em 1em;}
|
||||
.highslide-caption {color:white; background-color:black;}
|
||||
@ -2334,15 +2324,11 @@ content between \<!-- USERGUIDE --\> and \<!-- /USERGUIDE --\> is reused for the
|
||||
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade:cash.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade:cash.png" title="beancount example's etrade cash subaccount" /></a>
|
||||
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" title="beancount example's etrade investments, all commoditiess" /></a>
|
||||
|
||||
</div>
|
||||
|
||||
hledger-ui is hledger's curses-style interface. It reads a hledger
|
||||
journal file
|
||||
and provides a simple full-screen console interface for viewing account
|
||||
balances and transactions.
|
||||
|
||||
It is simpler and more convenient for browsing than the command-line
|
||||
interface, but lighter and faster than hledger-web.
|
||||
[hledger-ui](http://hackage.haskell.org/package/hledger-ui) is hledger's curses-style interface.
|
||||
It provides a simple full-screen console interface for viewing account
|
||||
balances and transactions. It is simpler and more efficient for
|
||||
browsing than the hledger CLI, but lighter and faster than
|
||||
hledger-web.
|
||||
|
||||
```{.shell .noclear}
|
||||
$ hledger ui -- --help
|
||||
@ -2360,138 +2346,41 @@ Flags:
|
||||
...
|
||||
```
|
||||
|
||||
OPTIONS
|
||||
=======
|
||||
##### Keys
|
||||
|
||||
Note: if invoking hledger-ui as a hledger subcommand, write `--` before
|
||||
options as shown above.
|
||||
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.
|
||||
|
||||
Any QUERYARGS are interpreted as a hledger search query which filters
|
||||
the data.
|
||||
|
||||
`--flat`
|
||||
: show full account names, unindented
|
||||
|
||||
`--no-elide`
|
||||
: don't compress empty parent accounts on one line
|
||||
|
||||
`--register=ACCTREGEX`
|
||||
: start in the (first) matched account's register screen
|
||||
|
||||
`--theme=default|terminal|greenterm`
|
||||
: use this custom display theme
|
||||
|
||||
`-V --value`
|
||||
: show amounts as their current market value in their default
|
||||
valuation commodity (accounts screen only)
|
||||
|
||||
`-h --help`
|
||||
: show help
|
||||
|
||||
`--version`
|
||||
: show version information
|
||||
|
||||
hledger options:
|
||||
----------------
|
||||
|
||||
The following common hledger options should also work:
|
||||
|
||||
`-f FILE --file=FILE`
|
||||
: use a different input file. For stdin, use -
|
||||
|
||||
`--rules-file=RULESFILE`
|
||||
: Conversion rules file to use when reading CSV (default: FILE.rules)
|
||||
|
||||
`--alias=OLD=NEW`
|
||||
: display accounts named OLD as NEW
|
||||
|
||||
`--ignore-assertions`
|
||||
: ignore any failing balance assertions in the journal
|
||||
|
||||
`--debug=N`
|
||||
: show debug output if N is 1-9 (default: 0)
|
||||
|
||||
`-b --begin=DATE`
|
||||
: include postings/txns on or after this date
|
||||
|
||||
`-e --end=DATE`
|
||||
: include postings/txns before this date
|
||||
|
||||
`-p --period=PERIODEXP`
|
||||
: set start date, end date, and/or reporting interval all at once
|
||||
(overrides the flags above)
|
||||
|
||||
`--date2 --aux-date`
|
||||
: use postings/txns' secondary dates instead
|
||||
|
||||
`-C --cleared`
|
||||
: include only cleared postings/txns
|
||||
|
||||
`--pending`
|
||||
: include only pending postings/txns
|
||||
|
||||
`-U --uncleared`
|
||||
: include only uncleared (and pending) postings/txns
|
||||
|
||||
`-R --real`
|
||||
: include only non-virtual postings
|
||||
|
||||
`--depth=N`
|
||||
: hide accounts/postings deeper than N
|
||||
|
||||
`-E --empty`
|
||||
: show empty/zero things which are normally omitted
|
||||
|
||||
`-B --cost`
|
||||
: show amounts in their cost price's commodity
|
||||
|
||||
KEYS
|
||||
====
|
||||
|
||||
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). There may be a noticeable pause.
|
||||
|
||||
`q` quits the application.
|
||||
|
||||
Some screens have additional key bindings, described below.
|
||||
|
||||
SCREENS
|
||||
=======
|
||||
##### Accounts screen
|
||||
|
||||
Accounts screen
|
||||
---------------
|
||||
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 balances from matched transactions.
|
||||
|
||||
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 balances from
|
||||
matched transactions.
|
||||
When not in flat mode, indentation indicates the account hierarchy. `F` toggles flat mode on and off.
|
||||
|
||||
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 limit by pressing `-` or `+` (`=` also works).
|
||||
`0` removes the depth limit.
|
||||
|
||||
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.
|
||||
|
||||
`C` toggles cleared mode. In cleared mode, the accounts and balances are
|
||||
derived only from transactions which are marked cleared (\*).
|
||||
`C` toggles cleared mode. In cleared mode, the accounts and balances
|
||||
are derived only from transactions which are marked cleared (*).
|
||||
|
||||
Press `right` or `enter` to view an account's transactions register.
|
||||
|
||||
Register screen
|
||||
---------------
|
||||
##### 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.
|
||||
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:
|
||||
@ -2511,50 +2400,47 @@ register command). This means:
|
||||
Otherwise it shows a running total starting from zero. Eg, these
|
||||
will show historic balances:
|
||||
|
||||
```
|
||||
$ hledger-ui
|
||||
$ hledger-ui --begin 'this month'
|
||||
$ hledger-ui --register checking date:2015/10
|
||||
```
|
||||
|
||||
while these will show a running total, since the queries are not
|
||||
just date limits:
|
||||
while these will show a running total, since the queries are not just date limits:
|
||||
|
||||
```
|
||||
$ hledger-ui checking
|
||||
$ hledger-ui --begin 'this month' desc:market
|
||||
$ hledger-ui --register checking --cleared
|
||||
```
|
||||
|
||||
Press `right` or `enter` to view the selected transaction in full
|
||||
detail.
|
||||
Press `right` or `enter` to view the selected transaction in full detail.
|
||||
|
||||
Transaction screen
|
||||
------------------
|
||||
##### Transaction screen
|
||||
|
||||
This screen shows a single transaction, as a general journal entry,
|
||||
similar to hledger's print command and journal format
|
||||
(hledger\_journal(5)).
|
||||
similar to hledger's print command and journal format (hledger_journal(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 (or in
|
||||
certain cases, fewer).
|
||||
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 depending on which account register you came from (remember most
|
||||
transactions appear in multiple account registers). The \#N number
|
||||
transactions appear in multiple account registers). The #N number
|
||||
preceding them is the transaction's position within the complete
|
||||
unfiltered journal, 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,
|
||||
when you press g to reload. Once you have fixed the problem described,
|
||||
press g again to reload and restore normal operation.
|
||||
|
||||
|
||||
|
||||
#### web
|
||||
|
||||
<style>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user