Merge pull request #402 from thdox/documentation

Documentation improvements
This commit is contained in:
Alexis Hildebrandt 2015-02-24 20:42:50 +01:00
commit af0da737fc
2 changed files with 14 additions and 16 deletions

View file

@ -640,11 +640,7 @@ entries. Opposite of
Alias for Alias for
.Fl \-first .Fl \-first
.It Fl \-help .It Fl \-help
Print a summary of all the options, and what they are used for. This Print this man page.
can be a handy way to remember which options do what. This help screen
is also printed if
.Nm
is run without a command.
.It Fl \-immediate .It Fl \-immediate
Evaluate calculations immediately rather than lazily. Evaluate calculations immediately rather than lazily.
.It Fl \-import Ar FILE .It Fl \-import Ar FILE

View file

@ -403,10 +403,11 @@ install` to install. If these intructions do not work for you can check the
@section Getting help @section Getting help
@findex help @findex help
Ledger has a complete online help system based on GNU Info. This Ledger has a complete online help system based on GNU Info. This manual
manual can be searched directly from the command-line using the can be searched directly from the command-line using @code{info ledger},
following options: @code{ledger --help} brings up this entire manual in which will bring up this entire manual in your TTY. Alternatively, the
your TTY. 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 If you need help on how to use Ledger, or run into problems, you can
join the Ledger mailing list at join the Ledger mailing list at
@ -5521,10 +5522,9 @@ Generate transactions based on previous postings.
@item --help @item --help
@itemx -h @itemx -h
Print summary of all options. Display the man page for @file{ledger}.
@item --version @item --version
@itemx -v
Print version information and exit. Print version information and exit.
@item --file @var{FILE} @item --file @var{FILE}
@ -5798,6 +5798,7 @@ Group postings together, similar to the balance report.
Use @file{FILE} for retrieving stored commodity prices. Use @file{FILE} for retrieving stored commodity prices.
@item --price-exp @var{INT} @item --price-exp @var{INT}
@itemx --leeway @var{INT}
@itemx -Z @var{INT} @itemx -Z @var{INT}
Set expected freshness of prices in @var{INT} minutes. Set expected freshness of prices in @var{INT} minutes.
@ -5864,7 +5865,7 @@ database.
@item --help @item --help
@itemx -h @itemx -h
Display the man page for ledger. Display the man page for @file{ledger}.
@item --init-file @var{FILE} @item --init-file @var{FILE}
Specify the location of the init file. The default is @file{~/.ledgerrc}. Specify the location of the init file. The default is @file{~/.ledgerrc}.
@ -5924,7 +5925,7 @@ produce memory trace information.
@value{FIXME:UNDOCUMENTED} @value{FIXME:UNDOCUMENTED}
@item --version @item --version
@value{FIXME:UNDOCUMENTED} Print version information and exit.
@end ftable @end ftable
@ -6035,8 +6036,8 @@ Quiet balance assertions.
Specify the location of the price entry data file. Specify the location of the price entry data file.
@item --price-exp @var{INT} @item --price-exp @var{INT}
@itemx -Z @var{INT}
@itemx --leeway @var{INT} @itemx --leeway @var{INT}
@itemx -Z @var{INT}
Set the expected freshness of price quotes, in @var{INT} minutes. That 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, 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 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 @item --help
@itemx -h @itemx -h
Print a summary of all the options, and what they are used for. This Display the man page for @file{ledger}.
can be a handy way to remember which options do what.
@item --version @item --version
Print the current version of ledger and exits. This is useful for 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. @option{--pricedb-format @var{FORMAT_STRING}} you define.
@item --price-exp @var{INT} @item --price-exp @var{INT}
@itemx --leeway @var{INT}
@itemx -Z @var{INT} @itemx -Z @var{INT}
Set the expected freshness of price quotes, in @var{INT} minutes. That 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, 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 @item --verbose
@itemx -v
Print detailed information on the execution of Ledger. Print detailed information on the execution of Ledger.
@item --verify @item --verify