From 50977288bb9b436ee7075a9f22ccb9ec4ee4cc7c Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 7 Jul 2017 15:58:26 +0100 Subject: [PATCH] doc: updates (#579) --- hledger/doc/commands.m4.md | 22 ---- hledger/doc/hledger.1 | 24 ----- hledger/doc/hledger.1.info | 214 ++++++++++++++++--------------------- hledger/doc/hledger.1.txt | 21 ---- 4 files changed, 92 insertions(+), 189 deletions(-) diff --git a/hledger/doc/commands.m4.md b/hledger/doc/commands.m4.md index 0cc5b4578..f7d55f54b 100644 --- a/hledger/doc/commands.m4.md +++ b/hledger/doc/commands.m4.md @@ -402,28 +402,6 @@ Normally incomestatement shows revenues/expenses per period, though as with [multicolumn balance reports](#multicolumn-balance-reports) you can alter the report mode with `--change`/`--cumulative`/`--historical`. -... -## info -Show any of the hledger manuals using info. - -The `info` command displays any of the [hledger reference manuals](/docs.html) -using the [info](https://en.wikipedia.org/wiki/Info_(Unix)) hypertextual documentation viewer. -This can be a very efficient way to browse large manuals. -It requires the "info" program to be available in your PATH. - -As with [help](#help), run it with no arguments to list available topics (manuals). - -## man -Show any of the hledger manuals using man. - -The `man` command displays any of the [hledger reference manuals](/docs.html) -using [man](https://en.wikipedia.org/wiki/Man_page), the standard documentation viewer on unix systems. -This will fit the text to your terminal width, and probably invoke a pager automatically. -It requires the "man" program to be available in your PATH. - -As with [help](#help), run it with no arguments to list available topics (manuals). -``` - ## print Show transactions from the journal. diff --git a/hledger/doc/hledger.1 b/hledger/doc/hledger.1 index 5f91aeacf..bf4c8ba23 100644 --- a/hledger/doc/hledger.1 +++ b/hledger/doc/hledger.1 @@ -1982,30 +1982,6 @@ report period. Normally incomestatement shows revenues/expenses per period, though as with multicolumn balance reports you can alter the report mode with \f[C]\-\-change\f[]/\f[C]\-\-cumulative\f[]/\f[C]\-\-historical\f[]. -.PP -\&... -## info Show any of the hledger manuals using info. -.PP -The \f[C]info\f[] command displays any of the hledger reference manuals -using the info hypertextual documentation viewer. -This can be a very efficient way to browse large manuals. -It requires the "info" program to be available in your PATH. -.PP -As with help, run it with no arguments to list available topics -(manuals). -.SS man -.PP -Show any of the hledger manuals using man. -.PP -The \f[C]man\f[] command displays any of the hledger reference manuals -using man, the standard documentation viewer on unix systems. -This will fit the text to your terminal width, and probably invoke a -pager automatically. -It requires the "man" program to be available in your PATH. -.PP -As with help, run it with no arguments to list available topics -(manuals). -``` .SS print .PP Show transactions from the journal. diff --git a/hledger/doc/hledger.1.info b/hledger/doc/hledger.1.info index 6089d9ae4..460abc5c0 100644 --- a/hledger/doc/hledger.1.info +++ b/hledger/doc/hledger.1.info @@ -786,7 +786,6 @@ displayed in the command list ('hledger is'). * cashflow:: * help:: * incomestatement:: -* man:: * print:: * register:: * stats:: @@ -1467,7 +1466,7 @@ SYNOPSIS hledger [-f FILE] COMMAND [OPTIONS] [ARGS]  -File: hledger.1.info, Node: incomestatement, Next: man, Prev: help, Up: COMMANDS +File: hledger.1.info, Node: incomestatement, Next: print, Prev: help, Up: COMMANDS 4.8 incomestatement =================== @@ -1542,38 +1541,11 @@ each report period. Normally incomestatement shows revenues/expenses per period, though as with multicolumn balance reports you can alter the report mode with '--change'/'--cumulative'/'--historical'. - ... ## info Show any of the hledger manuals using info. - - The 'info' command displays any of the hledger reference manuals -using the info hypertextual documentation viewer. This can be a very -efficient way to browse large manuals. It requires the "info" program -to be available in your PATH. - - As with help, run it with no arguments to list available topics -(manuals). -  -File: hledger.1.info, Node: man, Next: print, Prev: incomestatement, Up: COMMANDS +File: hledger.1.info, Node: print, Next: register, Prev: incomestatement, Up: COMMANDS -4.9 man -======= - -Show any of the hledger manuals using man. - - The 'man' command displays any of the hledger reference manuals using -man, the standard documentation viewer on unix systems. This will fit -the text to your terminal width, and probably invoke a pager -automatically. It requires the "man" program to be available in your -PATH. - - As with help, run it with no arguments to list available topics -(manuals). "' - - -File: hledger.1.info, Node: print, Next: register, Prev: man, Up: COMMANDS - -4.10 print -========== +4.9 print +========= Show transactions from the journal. @@ -1666,7 +1638,7 @@ $ hledger print -Ocsv  File: hledger.1.info, Node: register, Next: stats, Prev: print, Up: COMMANDS -4.11 register +4.10 register ============= Show postings and their running total. Alias: reg. @@ -1771,7 +1743,7 @@ length and comparable to the others in the report.  File: hledger.1.info, Node: Custom register output, Up: register -4.11.1 Custom register output +4.10.1 Custom register output ----------------------------- register uses the full terminal width by default, except on windows. @@ -1803,7 +1775,7 @@ output.  File: hledger.1.info, Node: stats, Next: test, Prev: register, Up: COMMANDS -4.12 stats +4.11 stats ========== Show some journal statistics. @@ -1835,7 +1807,7 @@ output destination.  File: hledger.1.info, Node: test, Prev: stats, Up: COMMANDS -4.13 test +4.12 test ========= Run built-in unit tests. @@ -2133,91 +2105,89 @@ Node: QUERIES21565 Ref: #queries21669 Node: COMMANDS25334 Ref: #commands25448 -Node: accounts26112 -Ref: #accounts26212 -Node: activity27194 -Ref: #activity27306 -Node: add27665 -Ref: #add27766 -Node: balance30424 -Ref: #balance30537 -Node: Flat mode33552 -Ref: #flat-mode33679 -Node: Depth limited balance reports34099 -Ref: #depth-limited-balance-reports34302 -Node: Multicolumn balance reports34722 -Ref: #multicolumn-balance-reports34933 -Node: Custom balance output39581 -Ref: #custom-balance-output39765 -Node: Colour support41858 -Ref: #colour-support42019 -Node: Output destination42192 -Ref: #output-destination42350 -Node: CSV output42620 -Ref: #csv-output42739 -Node: balancesheet43136 -Ref: #balancesheet43264 -Node: cashflow45171 -Ref: #cashflow45288 -Node: help47156 -Ref: #help47268 -Node: incomestatement48098 -Ref: #incomestatement48227 -Node: man50499 -Ref: #man50605 -Node: print51014 -Ref: #print51119 -Node: register54875 -Ref: #register54988 -Node: Custom register output59484 -Ref: #custom-register-output59615 -Node: stats60912 -Ref: #stats61018 -Node: test61899 -Ref: #test61986 -Node: ADD-ON COMMANDS62354 -Ref: #add-on-commands62466 -Node: Official add-ons63753 -Ref: #official-add-ons63895 -Node: api63982 -Ref: #api64073 -Node: ui64125 -Ref: #ui64226 -Node: web64284 -Ref: #web64375 -Node: Third party add-ons64421 -Ref: #third-party-add-ons64598 -Node: diff64733 -Ref: #diff64832 -Node: iadd64931 -Ref: #iadd65047 -Node: interest65130 -Ref: #interest65253 -Node: irr65348 -Ref: #irr65448 -Node: Experimental add-ons65526 -Ref: #experimental-add-ons65680 -Node: autosync66073 -Ref: #autosync66187 -Node: budget66426 -Ref: #budget66550 -Node: chart66616 -Ref: #chart66735 -Node: check66806 -Ref: #check66930 -Node: check-dates66997 -Ref: #check-dates67139 -Node: check-dupes67212 -Ref: #check-dupes67355 -Node: equity67432 -Ref: #equity67560 -Node: prices67679 -Ref: #prices67808 -Node: print-unique67863 -Ref: #print-unique68012 -Node: register-match68105 -Ref: #register-match68261 -Node: rewrite68359 -Ref: #rewrite68480 +Node: accounts26104 +Ref: #accounts26204 +Node: activity27186 +Ref: #activity27298 +Node: add27657 +Ref: #add27758 +Node: balance30416 +Ref: #balance30529 +Node: Flat mode33544 +Ref: #flat-mode33671 +Node: Depth limited balance reports34091 +Ref: #depth-limited-balance-reports34294 +Node: Multicolumn balance reports34714 +Ref: #multicolumn-balance-reports34925 +Node: Custom balance output39573 +Ref: #custom-balance-output39757 +Node: Colour support41850 +Ref: #colour-support42011 +Node: Output destination42184 +Ref: #output-destination42342 +Node: CSV output42612 +Ref: #csv-output42731 +Node: balancesheet43128 +Ref: #balancesheet43256 +Node: cashflow45163 +Ref: #cashflow45280 +Node: help47148 +Ref: #help47260 +Node: incomestatement48090 +Ref: #incomestatement48221 +Node: print50113 +Ref: #print50228 +Node: register53984 +Ref: #register54097 +Node: Custom register output58593 +Ref: #custom-register-output58724 +Node: stats60021 +Ref: #stats60127 +Node: test61008 +Ref: #test61095 +Node: ADD-ON COMMANDS61463 +Ref: #add-on-commands61575 +Node: Official add-ons62862 +Ref: #official-add-ons63004 +Node: api63091 +Ref: #api63182 +Node: ui63234 +Ref: #ui63335 +Node: web63393 +Ref: #web63484 +Node: Third party add-ons63530 +Ref: #third-party-add-ons63707 +Node: diff63842 +Ref: #diff63941 +Node: iadd64040 +Ref: #iadd64156 +Node: interest64239 +Ref: #interest64362 +Node: irr64457 +Ref: #irr64557 +Node: Experimental add-ons64635 +Ref: #experimental-add-ons64789 +Node: autosync65182 +Ref: #autosync65296 +Node: budget65535 +Ref: #budget65659 +Node: chart65725 +Ref: #chart65844 +Node: check65915 +Ref: #check66039 +Node: check-dates66106 +Ref: #check-dates66248 +Node: check-dupes66321 +Ref: #check-dupes66464 +Node: equity66541 +Ref: #equity66669 +Node: prices66788 +Ref: #prices66917 +Node: print-unique66972 +Ref: #print-unique67121 +Node: register-match67214 +Ref: #register-match67370 +Node: rewrite67468 +Ref: #rewrite67589  End Tag Table diff --git a/hledger/doc/hledger.1.txt b/hledger/doc/hledger.1.txt index 1f6ed6c06..0d13b0b05 100644 --- a/hledger/doc/hledger.1.txt +++ b/hledger/doc/hledger.1.txt @@ -1380,27 +1380,6 @@ COMMANDS period, though as with multicolumn balance reports you can alter the report mode with --change/--cumulative/--historical. - ... ## info Show any of the hledger manuals using info. - - The info command displays any of the hledger reference manuals using - the info hypertextual documentation viewer. This can be a very effi- - cient way to browse large manuals. It requires the "info" program to - be available in your PATH. - - As with help, run it with no arguments to list available topics (manu- - als). - - man - Show any of the hledger manuals using man. - - The man command displays any of the hledger reference manuals using - man, the standard documentation viewer on unix systems. This will fit - the text to your terminal width, and probably invoke a pager automati- - cally. It requires the "man" program to be available in your PATH. - - As with help, run it with no arguments to list available topics (manu- - als). ``` - print Show transactions from the journal.