From 25e2534794b56f1e216f2e6a5892c8b942327229 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Mon, 18 Apr 2016 17:00:54 -0700 Subject: [PATCH] doc: update all docs mentioning -h and --help --- hledger-ui/doc/hledger-ui.1 | 9 +++++++-- hledger-ui/doc/hledger-ui.1.m4.md | 7 +++++-- hledger-ui/doc/hledger-ui.1.txt | 5 +++-- hledger-web/doc/hledger-web.1 | 9 +++++++-- hledger-web/doc/hledger-web.1.m4.md | 7 +++++-- hledger-web/doc/hledger-web.1.txt | 5 +++-- hledger/doc/examples.m4.md | 2 +- hledger/doc/hledger.1 | 6 +++--- hledger/doc/hledger.1.txt | 6 +++--- hledger/doc/options.m4.md | 4 ++-- 10 files changed, 39 insertions(+), 21 deletions(-) diff --git a/hledger-ui/doc/hledger-ui.1 b/hledger-ui/doc/hledger-ui.1 index 51953c2f5..126016c5c 100644 --- a/hledger-ui/doc/hledger-ui.1 +++ b/hledger-ui/doc/hledger-ui.1 @@ -69,8 +69,13 @@ commodity (accounts screen only) .RS .RE .TP -.B \f[C]\-h\ \-\-help\f[] -show help +.B \f[C]\-h\f[] +show usage +.RS +.RE +.TP +.B \f[C]\-\-help\f[] +show detailed help .RS .RE .TP diff --git a/hledger-ui/doc/hledger-ui.1.m4.md b/hledger-ui/doc/hledger-ui.1.m4.md index 94f380c53..a4ee9d96e 100644 --- a/hledger-ui/doc/hledger-ui.1.m4.md +++ b/hledger-ui/doc/hledger-ui.1.m4.md @@ -74,8 +74,11 @@ Any QUERYARGS are interpreted as a hledger search query which filters the data. : show amounts as their current market value in their default valuation commodity (accounts screen only) -`-h --help` -: show help +`-h` +: show usage + +`--help` +: show detailed help `--version` : show version information diff --git a/hledger-ui/doc/hledger-ui.1.txt b/hledger-ui/doc/hledger-ui.1.txt index c4e4e7335..82c30ad1d 100644 --- a/hledger-ui/doc/hledger-ui.1.txt +++ b/hledger-ui/doc/hledger-ui.1.txt @@ -54,8 +54,9 @@ OOPPTTIIOONNSS show amounts as their current market value in their default val- uation commodity (accounts screen only) - --hh ----hheellpp - show help + --hh show usage + + ----hheellpp show detailed help ----vveerrssiioonn show version information diff --git a/hledger-web/doc/hledger-web.1 b/hledger-web/doc/hledger-web.1 index 1602546ac..b489f9e86 100644 --- a/hledger-web/doc/hledger-web.1 +++ b/hledger-web/doc/hledger-web.1 @@ -108,8 +108,13 @@ with this. .RS .RE .TP -.B \f[C]\-h\ \-\-help\f[] -show help +.B \f[C]\-h\f[] +show usage +.RS +.RE +.TP +.B \f[C]\-\-help\f[] +show detailed help .RS .RE .TP diff --git a/hledger-web/doc/hledger-web.1.m4.md b/hledger-web/doc/hledger-web.1.m4.md index 5c0ee6869..21351603a 100644 --- a/hledger-web/doc/hledger-web.1.m4.md +++ b/hledger-web/doc/hledger-web.1.m4.md @@ -117,8 +117,11 @@ You would change this when sharing over the network, or integrating within a lar hledger-web normally serves static files itself, but if you wanted to serve them from another server for efficiency, you would set the url with this. -`-h --help` -: show help +`-h` +: show usage + +`--help` +: show detailed help `--version` : show version information diff --git a/hledger-web/doc/hledger-web.1.txt b/hledger-web/doc/hledger-web.1.txt index 9efd875c0..bafdb5fbf 100644 --- a/hledger-web/doc/hledger-web.1.txt +++ b/hledger-web/doc/hledger-web.1.txt @@ -88,8 +88,9 @@ OOPPTTIIOONNSS them from another server for efficiency, you would set the url with this. - --hh ----hheellpp - show help + --hh show usage + + ----hheellpp show detailed help ----vveerrssiioonn show version information diff --git a/hledger/doc/examples.m4.md b/hledger/doc/examples.m4.md index ad8e0b9a5..29762a1ce 100644 --- a/hledger/doc/examples.m4.md +++ b/hledger/doc/examples.m4.md @@ -56,7 +56,7 @@ More commands: $ hledger # show available commands $ hledger add # add more transactions to the journal file $ hledger balance # all accounts with aggregated balances -$ hledger balance --help # show help for balance command +$ hledger balance --help # show detailed help for balance command $ hledger balance --depth 1 # only top-level accounts $ hledger register # show account postings, with running total $ hledger reg income # show postings to/from income accounts diff --git a/hledger/doc/hledger.1 b/hledger/doc/hledger.1 index d9de53de2..a84c5e810 100644 --- a/hledger/doc/hledger.1 +++ b/hledger/doc/hledger.1 @@ -133,7 +133,7 @@ More commands: $\ hledger\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ available\ commands $\ hledger\ add\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ add\ more\ transactions\ to\ the\ journal\ file $\ hledger\ balance\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ all\ accounts\ with\ aggregated\ balances -$\ hledger\ balance\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ help\ for\ balance\ command +$\ hledger\ balance\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ detailed\ help\ for\ balance\ command $\ hledger\ balance\ \-\-depth\ 1\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ only\ top\-level\ accounts $\ hledger\ register\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ account\ postings,\ with\ running\ total $\ hledger\ reg\ income\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ postings\ to/from\ income\ accounts @@ -172,12 +172,12 @@ General options are always available and can appear anywhere in the command line: .TP .B \f[C]\-h\f[] -show general usage or (after command) command usage +show general usage (or if after COMMAND, the command\[aq]s usage) .RS .RE .TP .B \f[C]\-\-help\f[] -show detailed help (man page) +show detailed help (or if after COMMAND, the command\[aq]s help) .RS .RE .TP diff --git a/hledger/doc/hledger.1.txt b/hledger/doc/hledger.1.txt index f9b302933..537ee5c75 100644 --- a/hledger/doc/hledger.1.txt +++ b/hledger/doc/hledger.1.txt @@ -95,7 +95,7 @@ EEXXAAMMPPLLEESS $ hledger # show available commands $ hledger add # add more transactions to the journal file $ hledger balance # all accounts with aggregated balances - $ hledger balance --help # show help for balance command + $ hledger balance --help # show detailed help for balance command $ hledger balance --depth 1 # only top-level accounts $ hledger register # show account postings, with running total $ hledger reg income # show postings to/from income accounts @@ -124,9 +124,9 @@ OOPPTTIIOONNSS There are three kinds of options. General options are always available and can appear anywhere in the command line: - --hh show general usage or (after command) command usage + --hh show general usage (or if after COMMAND, the command's usage) - ----hheellpp show detailed help (man page) + ----hheellpp show detailed help (or if after COMMAND, the command's help) ----vveerrssiioonn show version information diff --git a/hledger/doc/options.m4.md b/hledger/doc/options.m4.md index 48646eafa..524906a3f 100644 --- a/hledger/doc/options.m4.md +++ b/hledger/doc/options.m4.md @@ -23,10 +23,10 @@ There are three kinds of options. General options are always available and can appear anywhere in the command line: `-h` -: show general usage or (after command) command usage +: show general usage (or if after COMMAND, the command's usage) `--help` -: show detailed help (man page) +: show detailed help (or if after COMMAND, the command's help) `--version` : show version information