From ed0ec6d849a8d1f5afdd3cf13b01f4e5654e9d81 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 20 Feb 2016 23:58:07 -0800 Subject: [PATCH] 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. --- hledger-ui/hledger-ui.1 | 33 ++---- hledger-ui/hledger-ui.1.md | 62 +--------- site/manual.md | 230 ++++++++++--------------------------- 3 files changed, 70 insertions(+), 255 deletions(-) diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index ebefd2a51..7b7ca0ae6 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -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 diff --git a/hledger-ui/hledger-ui.1.md b/hledger-ui/hledger-ui.1.md index 66cd8e9cd..afdbe868f 100644 --- a/hledger-ui/hledger-ui.1.md +++ b/hledger-ui/hledger-ui.1.md @@ -2,17 +2,6 @@ % % October 2015 - - -
- # 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). -
- -
- - - - - - - - - - - - -
- hledger-ui is hledger's curses-style interface. -It reads a hledger journal file -
-(~/.hledger.journal, $LEDGER_FILE, or -f FILE; see hledger(1) or hledger_journal(5))a -
-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. -
- # 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. - -
diff --git a/site/manual.md b/site/manual.md index f365b41a0..471123b09 100644 --- a/site/manual.md +++ b/site/manual.md @@ -2310,16 +2310,6 @@ See the package page for more. #### ui - -
-