From bd2d9b829c8cb86e223994885017adb130b33156 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 8 Jul 2017 08:15:33 +0100 Subject: [PATCH] help: yet another manual tweak; update builtin manuals [ci skip] --- hledger/doc/commands.m4.md | 12 ++-- hledger/doc/hledger.1 | 29 ++++---- hledger/doc/hledger.1.info | 141 +++++++++++++++++++------------------ hledger/doc/hledger.1.txt | 29 ++++---- 4 files changed, 112 insertions(+), 99 deletions(-) diff --git a/hledger/doc/commands.m4.md b/hledger/doc/commands.m4.md index 1d1d662a4..4bd3fb6c3 100644 --- a/hledger/doc/commands.m4.md +++ b/hledger/doc/commands.m4.md @@ -319,17 +319,21 @@ Manuals: hledger hledger-ui hledger-web hledger-api journal csv timeclock timedo }}) _shell_({{ -$ hledger help cli | less - -hledger(1) hledger User Manuals hledger(1) - +$ hledger help h --man +hledger(1) hledger User Manuals hledger(1) NAME hledger - a command-line accounting tool SYNOPSIS hledger [-f FILE] COMMAND [OPTIONS] [ARGS] + hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS] + hledger + +DESCRIPTION + hledger is a cross-platform program for tracking money, time, or any +... }}) ## incomestatement diff --git a/hledger/doc/hledger.1 b/hledger/doc/hledger.1 index bf4c8ba23..462807e64 100644 --- a/hledger/doc/hledger.1 +++ b/hledger/doc/hledger.1 @@ -1850,37 +1850,40 @@ Show any of the hledger manuals. .PP The \f[C]help\f[] command displays any of the main hledger manuals, in one of several ways. -Run it with no argument to list the manuals (their names are shortened -for easier typing), and run \f[C]hledger\ help\ MANUAL\f[] to select -one. +Run it with no argument to list the manuals, or provide a full or +partial manual name to select one. .PP -hledger help will choose one of these docs viewers, in order of -preference: info, man, $PAGER, less, stdout (and it always prints on -stdout when piped). -Or you can force a particular viewer with the \f[C]\-\-info\f[], +hledger manuals are available in several formats. +hledger help will use the first of these display methods that it finds: +info, man, $PAGER, less, stdout (or when non\-interactive, just stdout). +You can force a particular viewer with the \f[C]\-\-info\f[], \f[C]\-\-man\f[], \f[C]\-\-pager\f[], \f[C]\-\-cat\f[] flags. .IP .nf \f[C] $\ hledger\ help -Please\ choose\ a\ manual: -hledger\ help\ cli|ui|web|api|journal|csv|timeclock|timedot +Please\ choose\ a\ manual\ by\ typing\ "hledger\ help\ MANUAL"\ (a\ substring\ is\ ok). +Manuals:\ hledger\ hledger\-ui\ hledger\-web\ hledger\-api\ journal\ csv\ timeclock\ timedot \f[] .fi .IP .nf \f[C] -$\ hledger\ help\ cli\ |\ less - -hledger(1)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger\ User\ Manuals\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger(1) - +$\ hledger\ help\ h\ \-\-man +hledger(1)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger\ User\ Manuals\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger(1) NAME \ \ \ \ \ \ \ hledger\ \-\ a\ command\-line\ accounting\ tool SYNOPSIS \ \ \ \ \ \ \ hledger\ [\-f\ FILE]\ COMMAND\ [OPTIONS]\ [ARGS] +\ \ \ \ \ \ \ hledger\ [\-f\ FILE]\ ADDONCMD\ \-\-\ [OPTIONS]\ [ARGS] +\ \ \ \ \ \ \ hledger + +DESCRIPTION +\ \ \ \ \ \ \ hledger\ \ is\ \ a\ \ cross\-platform\ \ program\ \ for\ tracking\ money,\ time,\ or\ any +\&... \f[] .fi .SS incomestatement diff --git a/hledger/doc/hledger.1.info b/hledger/doc/hledger.1.info index 460abc5c0..719cc182a 100644 --- a/hledger/doc/hledger.1.info +++ b/hledger/doc/hledger.1.info @@ -1440,30 +1440,33 @@ File: hledger.1.info, Node: help, Next: incomestatement, Prev: cashflow, Up: Show any of the hledger manuals. The 'help' command displays any of the main hledger manuals, in one -of several ways. Run it with no argument to list the manuals (their -names are shortened for easier typing), and run 'hledger help MANUAL' to -select one. +of several ways. Run it with no argument to list the manuals, or +provide a full or partial manual name to select one. - hledger help will choose one of these docs viewers, in order of -preference: info, man, $PAGER, less, stdout (and it always prints on -stdout when piped). Or you can force a particular viewer with the -'--info', '--man', '--pager', '--cat' flags. + hledger manuals are available in several formats. hledger help will +use the first of these display methods that it finds: info, man, $PAGER, +less, stdout (or when non-interactive, just stdout). You can force a +particular viewer with the '--info', '--man', '--pager', '--cat' flags. $ hledger help -Please choose a manual: -hledger help cli|ui|web|api|journal|csv|timeclock|timedot - -$ hledger help cli | less - -hledger(1) hledger User Manuals hledger(1) +Please choose a manual by typing "hledger help MANUAL" (a substring is ok). +Manuals: hledger hledger-ui hledger-web hledger-api journal csv timeclock timedot +$ hledger help h --man +hledger(1) hledger User Manuals hledger(1) NAME hledger - a command-line accounting tool SYNOPSIS hledger [-f FILE] COMMAND [OPTIONS] [ARGS] + hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS] + hledger + +DESCRIPTION + hledger is a cross-platform program for tracking money, time, or any +...  File: hledger.1.info, Node: incomestatement, Next: print, Prev: help, Up: COMMANDS @@ -2133,61 +2136,61 @@ 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 +Node: incomestatement48334 +Ref: #incomestatement48465 +Node: print50357 +Ref: #print50472 +Node: register54228 +Ref: #register54341 +Node: Custom register output58837 +Ref: #custom-register-output58968 +Node: stats60265 +Ref: #stats60371 +Node: test61252 +Ref: #test61339 +Node: ADD-ON COMMANDS61707 +Ref: #add-on-commands61819 +Node: Official add-ons63106 +Ref: #official-add-ons63248 +Node: api63335 +Ref: #api63426 +Node: ui63478 +Ref: #ui63579 +Node: web63637 +Ref: #web63728 +Node: Third party add-ons63774 +Ref: #third-party-add-ons63951 +Node: diff64086 +Ref: #diff64185 +Node: iadd64284 +Ref: #iadd64400 +Node: interest64483 +Ref: #interest64606 +Node: irr64701 +Ref: #irr64801 +Node: Experimental add-ons64879 +Ref: #experimental-add-ons65033 +Node: autosync65426 +Ref: #autosync65540 +Node: budget65779 +Ref: #budget65903 +Node: chart65969 +Ref: #chart66088 +Node: check66159 +Ref: #check66283 +Node: check-dates66350 +Ref: #check-dates66492 +Node: check-dupes66565 +Ref: #check-dupes66708 +Node: equity66785 +Ref: #equity66913 +Node: prices67032 +Ref: #prices67161 +Node: print-unique67216 +Ref: #print-unique67365 +Node: register-match67458 +Ref: #register-match67614 +Node: rewrite67712 +Ref: #rewrite67833  End Tag Table diff --git a/hledger/doc/hledger.1.txt b/hledger/doc/hledger.1.txt index 0d13b0b05..da344b030 100644 --- a/hledger/doc/hledger.1.txt +++ b/hledger/doc/hledger.1.txt @@ -1287,30 +1287,33 @@ COMMANDS Show any of the hledger manuals. The help command displays any of the main hledger manuals, in one of - several ways. Run it with no argument to list the manuals (their names - are shortened for easier typing), and run hledger help MANUAL to select - one. + several ways. Run it with no argument to list the manuals, or provide + a full or partial manual name to select one. - hledger help will choose one of these docs viewers, in order of prefer- - ence: info, man, $PAGER, less, stdout (and it always prints on stdout - when piped). Or you can force a particular viewer with the --info, - --man, --pager, --cat flags. + hledger manuals are available in several formats. hledger help will + use the first of these display methods that it finds: info, man, + $PAGER, less, stdout (or when non-interactive, just stdout). You can + force a particular viewer with the --info, --man, --pager, --cat flags. $ hledger help - Please choose a manual: - hledger help cli|ui|web|api|journal|csv|timeclock|timedot - - $ hledger help cli | less - - hledger(1) hledger User Manuals hledger(1) + Please choose a manual by typing "hledger help MANUAL" (a substring is ok). + Manuals: hledger hledger-ui hledger-web hledger-api journal csv timeclock timedot + $ hledger help h --man + hledger(1) hledger User Manuals hledger(1) NAME hledger - a command-line accounting tool SYNOPSIS hledger [-f FILE] COMMAND [OPTIONS] [ARGS] + hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS] + hledger + + DESCRIPTION + hledger is a cross-platform program for tracking money, time, or any + ... incomestatement Show an income statement. Alias: is.