diff --git a/hledger/Hledger/Cli/CliOptions.hs b/hledger/Hledger/Cli/CliOptions.hs index dc707517d..91f7efed1 100644 --- a/hledger/Hledger/Cli/CliOptions.hs +++ b/hledger/Hledger/Cli/CliOptions.hs @@ -99,9 +99,9 @@ import Hledger.Cli.Version helpflags :: [Flag RawOpts] helpflags = [ flagNone ["h"] (setboolopt "h") "show general usage or (after command) command usage" - ,flagNone ["help"] (setboolopt "help") "show manual" - ,flagNone ["man"] (setboolopt "man") "show manual with man" - ,flagNone ["info"] (setboolopt "info") "show manual with info" + ,flagNone ["help"] (setboolopt "help") "show the current program's manual as plain text (or after an add-on COMMAND, the add-on's manual)" + ,flagNone ["man"] (setboolopt "man") "show the current program's manual with man" + ,flagNone ["info"] (setboolopt "info") "show the current program's manual with info" -- ,flagNone ["browse-args"] (setboolopt "browse-args") "use a web UI to select options and build up a command line" ,flagReq ["debug"] (\s opts -> Right $ setopt "debug" s opts) "N" "show increasing amounts of debug output if N is 1-9. With no argument, show level 1" ,flagNone ["version"] (setboolopt "version") "show version information" diff --git a/hledger/Hledger/Cli/Help.hs b/hledger/Hledger/Cli/Help.hs index 75bfa9948..737f2875b 100644 --- a/hledger/Hledger/Cli/Help.hs +++ b/hledger/Hledger/Cli/Help.hs @@ -21,7 +21,7 @@ import Hledger.Cli.CliOptions import Hledger.Cli.DocFiles helpmode = (defCommandMode $ ["help"] ++ aliases) { - modeHelp = "show manual" `withAliases` aliases + modeHelp = "show any of the hledger manuals" `withAliases` aliases ,modeGroupFlags = Group { groupUnnamed = [] ,groupHidden = [] diff --git a/hledger/Hledger/Cli/Info.hs b/hledger/Hledger/Cli/Info.hs index ce15c3e8c..bd6bd3f0e 100644 --- a/hledger/Hledger/Cli/Info.hs +++ b/hledger/Hledger/Cli/Info.hs @@ -21,7 +21,7 @@ import Hledger.Cli.CliOptions import Hledger.Cli.DocFiles infomode = (defCommandMode $ ["info"] ++ aliases) { - modeHelp = "show manual with info" `withAliases` aliases + modeHelp = "show any of the hledger manuals with info" `withAliases` aliases ,modeGroupFlags = Group { groupUnnamed = [] ,groupHidden = [] diff --git a/hledger/Hledger/Cli/Man.hs b/hledger/Hledger/Cli/Man.hs index a15864c62..837159273 100644 --- a/hledger/Hledger/Cli/Man.hs +++ b/hledger/Hledger/Cli/Man.hs @@ -21,7 +21,7 @@ import Hledger.Cli.CliOptions import Hledger.Cli.DocFiles manmode = (defCommandMode $ ["man"] ++ aliases) { - modeHelp = "show manual with man" `withAliases` aliases + modeHelp = "show any of the hledger manuals with man" `withAliases` aliases ,modeGroupFlags = Group { groupUnnamed = [] ,groupHidden = [] diff --git a/hledger/doc/commands.m4.md b/hledger/doc/commands.m4.md index 830ee03c8..099c4cd26 100644 --- a/hledger/doc/commands.m4.md +++ b/hledger/doc/commands.m4.md @@ -234,7 +234,7 @@ Total: ``` ## help -Show one of the hledger manuals. +Show any of the hledger manuals. The `help` command displays any of the main [hledger man pages](/docs.html). (Unlike `hledger --help`, which displays only the hledger man page.) @@ -304,7 +304,7 @@ Total: ``` ## info -Show one of the hledger manuals using 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. @@ -314,7 +314,7 @@ 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 one of the hledger manuals using 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. diff --git a/hledger/doc/hledger.1 b/hledger/doc/hledger.1 index b286bcee4..2d63457d6 100644 --- a/hledger/doc/hledger.1 +++ b/hledger/doc/hledger.1 @@ -198,18 +198,18 @@ show general usage (or if after COMMAND, the command\[aq]s usage) .RE .TP .B \f[C]\-\-help\f[] -show hledger manual (or if after an add\-on COMMAND, show the -add\-on\[aq]s manual) +show the current program\[aq]s manual as plain text (or after an add\-on +COMMAND, the add\-on\[aq]s manual) .RS .RE .TP .B \f[C]\-\-man\f[] -show manual with man +show the current program\[aq]s manual with man .RS .RE .TP .B \f[C]\-\-info\f[] -show manual with info +show the current program\[aq]s manual with info .RS .RE .TP @@ -1401,7 +1401,7 @@ Total: .fi .SS help .PP -Show one of the hledger manuals. +Show any of the hledger manuals. .PP The \f[C]help\f[] command displays any of the main hledger man pages. (Unlike \f[C]hledger\ \-\-help\f[], which displays only the hledger man @@ -1483,7 +1483,7 @@ Total: .fi .SS info .PP -Show one of the hledger manuals using 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. @@ -1494,7 +1494,7 @@ As with help, run it with no arguments to list available topics (manuals). .SS man .PP -Show one of the hledger manuals using man. +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. diff --git a/hledger/doc/hledger.1.info b/hledger/doc/hledger.1.info index 579100c72..a46f4ce8a 100644 --- a/hledger/doc/hledger.1.info +++ b/hledger/doc/hledger.1.info @@ -162,14 +162,14 @@ available and can appear anywhere in the command line: show general usage (or if after COMMAND, the command's usage) `--help' - show hledger manual (or if after an add-on COMMAND, show the - add-on's manual) + show the current program's manual as plain text (or after an add-on + COMMAND, the add-on's manual) `--man' - show manual with man + show the current program's manual with man `--info' - show manual with info + show the current program's manual with info `--version' show version @@ -1177,7 +1177,7 @@ File: hledger.1.info, Node: help, Next: incomestatement, Prev: cashflow, Up: 4.7 help ======== -Show one of the hledger manuals. +Show any of the hledger manuals. The `help' command displays any of the main hledger man pages. (Unlike `hledger --help', which displays only the hledger man page.) @@ -1252,7 +1252,7 @@ File: hledger.1.info, Node: info, Next: man, Prev: incomestatement, Up: COMM 4.9 info ======== -Show one of the hledger manuals using 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 @@ -1268,7 +1268,7 @@ File: hledger.1.info, Node: man, Next: print, Prev: info, Up: COMMANDS 4.10 man ======== -Show one of the hledger manuals using 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 @@ -2039,99 +2039,99 @@ in hledger add.  Tag Table: Node: Top82 -Node: EXAMPLES1754 -Ref: #examples1856 -Node: OPTIONS3860 -Ref: #options3964 -Node: Multiple files7217 -Ref: #multiple-files7342 -Node: Repeated options7607 -Ref: #repeated-options7759 -Node: Depth limiting7879 -Ref: #depth-limiting8024 -Node: Smart dates8225 -Ref: #smart-dates8366 -Node: Reporting interval9363 -Ref: #reporting-interval9522 -Node: Period expressions9865 -Ref: #period-expressions10032 -Node: Regular Expressions12078 -Ref: #regular-expressions12220 -Node: QUERIES13703 -Ref: #queries13807 -Node: COMMANDS17109 -Ref: #commands17223 -Node: accounts17896 -Ref: #accounts17996 -Node: activity18978 -Ref: #activity19090 -Node: add19449 -Ref: #add19550 -Node: balance22209 -Ref: #balance22322 -Node: Flat mode25038 -Ref: #flat-mode25165 -Node: Depth limited balance reports25584 -Ref: #depth-limited-balance-reports25787 -Node: Multicolumn balance reports26208 -Ref: #multicolumn-balance-reports26410 -Node: Market value31059 -Ref: #market-value31223 -Node: Custom balance output31716 -Ref: #custom-balance-output31889 -Node: Output destination33993 -Ref: #output-destination34158 -Node: CSV output34428 -Ref: #csv-output34547 -Node: balancesheet34944 -Ref: #balancesheet35072 -Node: cashflow35724 -Ref: #cashflow35841 -Node: help36531 -Ref: #help36643 -Node: incomestatement37480 -Ref: #incomestatement37610 -Node: info38337 -Ref: #info38444 -Node: man38806 -Ref: #man38903 -Node: print39306 -Ref: #print39411 -Node: register40762 -Ref: #register40875 -Node: Custom register output45216 -Ref: #custom-register-output45347 -Node: stats46644 -Ref: #stats46750 -Node: test47631 -Ref: #test47718 -Node: ADD-ON COMMANDS48085 -Ref: #add-on-commands48221 -Node: api49509 -Ref: #api49601 -Node: autosync49635 -Ref: #autosync49750 -Node: diff52065 -Ref: #diff52175 -Node: equity52839 -Ref: #equity52953 -Node: interest54281 -Ref: #interest54398 -Node: irr57482 -Ref: #irr57595 -Node: print-unique59970 -Ref: #print-unique60100 -Node: rewrite60358 -Ref: #rewrite60477 -Node: ui61006 -Ref: #ui61106 -Node: web61147 -Ref: #web61235 -Node: TROUBLESHOOTING61268 -Ref: #troubleshooting61387 -Node: Run-time problems61441 -Ref: #run-time-problems61584 -Node: Known limitations63528 -Ref: #known-limitations63671 +Node: EXAMPLES1748 +Ref: #examples1850 +Node: OPTIONS3854 +Ref: #options3958 +Node: Multiple files7275 +Ref: #multiple-files7400 +Node: Repeated options7665 +Ref: #repeated-options7817 +Node: Depth limiting7937 +Ref: #depth-limiting8082 +Node: Smart dates8283 +Ref: #smart-dates8424 +Node: Reporting interval9421 +Ref: #reporting-interval9580 +Node: Period expressions9923 +Ref: #period-expressions10090 +Node: Regular Expressions12136 +Ref: #regular-expressions12278 +Node: QUERIES13761 +Ref: #queries13865 +Node: COMMANDS17167 +Ref: #commands17281 +Node: accounts17954 +Ref: #accounts18054 +Node: activity19036 +Ref: #activity19148 +Node: add19507 +Ref: #add19608 +Node: balance22267 +Ref: #balance22380 +Node: Flat mode25096 +Ref: #flat-mode25223 +Node: Depth limited balance reports25642 +Ref: #depth-limited-balance-reports25845 +Node: Multicolumn balance reports26266 +Ref: #multicolumn-balance-reports26468 +Node: Market value31117 +Ref: #market-value31281 +Node: Custom balance output31774 +Ref: #custom-balance-output31947 +Node: Output destination34051 +Ref: #output-destination34216 +Node: CSV output34486 +Ref: #csv-output34605 +Node: balancesheet35002 +Ref: #balancesheet35130 +Node: cashflow35782 +Ref: #cashflow35899 +Node: help36589 +Ref: #help36701 +Node: incomestatement37538 +Ref: #incomestatement37668 +Node: info38395 +Ref: #info38502 +Node: man38864 +Ref: #man38961 +Node: print39364 +Ref: #print39469 +Node: register40820 +Ref: #register40933 +Node: Custom register output45274 +Ref: #custom-register-output45405 +Node: stats46702 +Ref: #stats46808 +Node: test47689 +Ref: #test47776 +Node: ADD-ON COMMANDS48143 +Ref: #add-on-commands48279 +Node: api49567 +Ref: #api49659 +Node: autosync49693 +Ref: #autosync49808 +Node: diff52123 +Ref: #diff52233 +Node: equity52897 +Ref: #equity53011 +Node: interest54339 +Ref: #interest54456 +Node: irr57540 +Ref: #irr57653 +Node: print-unique60028 +Ref: #print-unique60158 +Node: rewrite60416 +Ref: #rewrite60535 +Node: ui61064 +Ref: #ui61164 +Node: web61205 +Ref: #web61293 +Node: TROUBLESHOOTING61326 +Ref: #troubleshooting61445 +Node: Run-time problems61499 +Ref: #run-time-problems61642 +Node: Known limitations63586 +Ref: #known-limitations63729  End Tag Table diff --git a/hledger/doc/hledger.1.txt b/hledger/doc/hledger.1.txt index d3aa818c9..a7b227ad8 100644 --- a/hledger/doc/hledger.1.txt +++ b/hledger/doc/hledger.1.txt @@ -139,12 +139,12 @@ OOPPTTIIOONNSS --hh show general usage (or if after COMMAND, the command's usage) - ----hheellpp show hledger manual (or if after an add-on COMMAND, show the - add-on's manual) + ----hheellpp show the current program's manual as plain text (or after an + add-on COMMAND, the add-on's manual) - ----mmaann show manual with man + ----mmaann show the current program's manual with man - ----iinnffoo show manual with info + ----iinnffoo show the manual with info ----vveerrssiioonn show version @@ -966,7 +966,7 @@ CCOOMMMMAANNDDSS $-1 hheellpp - Show one of the hledger manuals. + Show any of the hledger manuals. The help command displays any of the main hledger man pages. (Unlike hledger --help, which displays only the hledger man page.) Run it with @@ -1027,7 +1027,7 @@ CCOOMMMMAANNDDSS 0 iinnffoo - Show one of the hledger manuals using 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- @@ -1038,7 +1038,7 @@ CCOOMMMMAANNDDSS als). mmaann - Show one of the hledger manuals using 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 diff --git a/hledger/doc/options.m4.md b/hledger/doc/options.m4.md index 86cb07e09..0353bbbf5 100644 --- a/hledger/doc/options.m4.md +++ b/hledger/doc/options.m4.md @@ -26,13 +26,13 @@ General options are always available and can appear anywhere in the command line : show general usage (or if after COMMAND, the command's usage) `--help` -: show hledger manual (or if after an add-on COMMAND, show the add-on's manual) +: show the current program's manual as plain text (or after an add-on COMMAND, the add-on's manual) `--man` -: show manual with man +: show the current program's manual with man `--info` -: show manual with info +: show the current program's manual with info `--version` : show version