diff options
author | Alexis Hildebrandt <afh@surryhill.net> | 2015-02-24 20:42:50 +0100 |
---|---|---|
committer | Alexis Hildebrandt <afh@surryhill.net> | 2015-02-24 20:42:50 +0100 |
commit | af0da737fc4ef8f9ccebd3d43519610b8a8fcaa1 (patch) | |
tree | f039ac8b221ab214354c5e705baae82fe44cfde4 /doc | |
parent | 5e6d5e33af8dbfcca3030fda2dac068efa00944a (diff) | |
parent | 71e77570b717563244673d4aa525a3b049762983 (diff) | |
download | fork-ledger-af0da737fc4ef8f9ccebd3d43519610b8a8fcaa1.tar.gz fork-ledger-af0da737fc4ef8f9ccebd3d43519610b8a8fcaa1.tar.bz2 fork-ledger-af0da737fc4ef8f9ccebd3d43519610b8a8fcaa1.zip |
Merge pull request #402 from thdox/documentation
Documentation improvements
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ledger.1 | 6 | ||||
-rw-r--r-- | doc/ledger3.texi | 24 |
2 files changed, 14 insertions, 16 deletions
diff --git a/doc/ledger.1 b/doc/ledger.1 index b5b61b27..f4ee9625 100644 --- a/doc/ledger.1 +++ b/doc/ledger.1 @@ -640,11 +640,7 @@ entries. Opposite of Alias for .Fl \-first .It Fl \-help -Print a summary of all the options, and what they are used for. This -can be a handy way to remember which options do what. This help screen -is also printed if -.Nm -is run without a command. +Print this man page. .It Fl \-immediate Evaluate calculations immediately rather than lazily. .It Fl \-import Ar FILE diff --git a/doc/ledger3.texi b/doc/ledger3.texi index 24d4cb5c..bbb8e515 100644 --- a/doc/ledger3.texi +++ b/doc/ledger3.texi @@ -403,10 +403,11 @@ install` to install. If these intructions do not work for you can check the @section Getting help @findex help -Ledger has a complete online help system based on GNU Info. This -manual can be searched directly from the command-line using the -following options: @code{ledger --help} brings up this entire manual in -your TTY. +Ledger has a complete online help system based on GNU Info. This manual +can be searched directly from the command-line using @code{info ledger}, +which will bring up this entire manual in your TTY. Alternatively, the +shorter man page can be accessed from the command-line either via +@code{man ledger} or @code{ledger --help} If you need help on how to use Ledger, or run into problems, you can join the Ledger mailing list at @@ -5521,10 +5522,9 @@ Generate transactions based on previous postings. @item --help @itemx -h -Print summary of all options. +Display the man page for @file{ledger}. @item --version -@itemx -v Print version information and exit. @item --file @var{FILE} @@ -5798,6 +5798,7 @@ Group postings together, similar to the balance report. Use @file{FILE} for retrieving stored commodity prices. @item --price-exp @var{INT} +@itemx --leeway @var{INT} @itemx -Z @var{INT} Set expected freshness of prices in @var{INT} minutes. @@ -5864,7 +5865,7 @@ database. @item --help @itemx -h -Display the man page for ledger. +Display the man page for @file{ledger}. @item --init-file @var{FILE} Specify the location of the init file. The default is @file{~/.ledgerrc}. @@ -5924,7 +5925,7 @@ produce memory trace information. @value{FIXME:UNDOCUMENTED} @item --version -@value{FIXME:UNDOCUMENTED} +Print version information and exit. @end ftable @@ -6035,8 +6036,8 @@ Quiet balance assertions. Specify the location of the price entry data file. @item --price-exp @var{INT} -@itemx -Z @var{INT} @itemx --leeway @var{INT} +@itemx -Z @var{INT} Set the expected freshness of price quotes, in @var{INT} minutes. That is, if the last known quote for any commodity is older than this value, and if @option{--download} is being used, then the Internet will be @@ -6787,8 +6788,7 @@ variables}), instead of using actual command-line options: @item --help @itemx -h -Print a summary of all the options, and what they are used for. This -can be a handy way to remember which options do what. +Display the man page for @file{ledger}. @item --version Print the current version of ledger and exits. This is useful for @@ -7297,6 +7297,7 @@ The format of the file can be changed by telling ledger to use the @option{--pricedb-format @var{FORMAT_STRING}} you define. @item --price-exp @var{INT} +@itemx --leeway @var{INT} @itemx -Z @var{INT} Set the expected freshness of price quotes, in @var{INT} minutes. That is, if the last known quote for any commodity is older than this value, @@ -9772,6 +9773,7 @@ Enable tracing. The @var{INT} specifies the level of trace desired: @ @item --verbose +@itemx -v Print detailed information on the execution of Ledger. @item --verify |