sfos/ledger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[doc] Add documentation for several options

Browse source
This commit is contained in:
Alexis Hildebrandt 2015-02-15 09:27:01 +01:00
parent d5e1308d07
commit bd427a9d32
2 changed files with 90 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
doc/ledger.1
View file

@ -191,7 +191,8 @@ Show any gains (or losses) in commodity values over time.
Only show the top
.Ar number
postings.
.\".It Fl \-historical Pq Fl H
.It Fl \-historical Pq Fl H
Value commodities at the time of their acquisition.
.It Fl \-invert
Invert the value of amounts shown.
.It Fl \-market Pq Fl V
@ -366,7 +367,9 @@ Alias for
Ignore init files and environment variables for the
.Nm
run.
.\".It Fl \-auto-match
.It Fl \-auto-match
Automatically match accounts from ledger journal for transactions
during csv convert.
.It Fl \-aux-date
Show auxiliary dates for all calculations.
Alias for
@ -378,7 +381,9 @@ running totals.
Specify the format to use for the
.Ic balance
report.
.\".It Fl \-base
.It Fl \-base
Reduce convertible commodities down the bottom of the conversion, e.g.
display time in seconds.
.It Fl \-basis Pq Fl B
Report the cost basis on all posting.
Alias for
@ -460,7 +465,12 @@ Print dates using
Refer to
.Xr strftime 3
for details on the format string syntax.
.\" .It Fl \-datetime-format Ar FMT
.It Fl \-datetime-format Ar DATETIMEFMT
Print datetimes using
.Ar DATETIMEFMT .
Refer to
.Xr strftime 3
for details on the format string syntax.
.It Fl \-date-width Ar INT
Specify the width, in characters, of the date column in the
.Ic register
@ -550,7 +560,9 @@ Related to the
.Ic equity
command. Gives current account balances in the form of a register
report.
.\".It Fl \-exact
.It Fl \-exact
Report beginning and ending of periods by the date of the first and last
posting occurring in that period.
.It Fl \-exchange Ar COMMODITY Oo , Ar COMMODITY, ... Oc Pq Fl X
Display values in terms of the given
.Ar COMMODITY .
@ -628,7 +640,10 @@ is also printed if
is run without a command.
.It Fl \-immediate
Evaluate calculations immediately rather than lazily.
.\".It Fl \-import
.It Fl \-import Ar FILE
Import
.Ar FILE
as Python module.
.It Fl \-init-file Ar FILE Pq Fl i
Read
.Ar FILE
@ -673,7 +688,9 @@ purchased.
.It Fl \-lots
Report the date and price at which each commodity was purchased in
a balance report.
.\".It Fl \-lots-actual
.It Fl \-lots-actual
Preserve the uniqueness of commodities so they aren't merged during
reporting without printing the lot annotations.
.It Fl \-market Pq Fl V
Use the latest market value for all commodities.
.It Fl \-master-account Ar STR
@ -837,9 +854,23 @@ of the transaction.
Show all postings in a transaction, similar to
.Fl \-related
but show both sides of each transaction.
.\".It Fl \-revalued
.\".It Fl \-revalued-only
.\".It Fl \-revalued-total Ar EXPR
.It Fl \-revalued
Report discrepancy in values for manual reports by inserting
<Revalued>
postings.
This is implied when using
the
.Fl \-exchange Pq Fl X
or
.Fl \-market Pq Fl V
option.
.It Fl \-revalued-only
Show only
<Revalued>
postings.
.It Fl \-revalued-total
Display the sum of the revalued postings as the running total, which serves
to show unrealized capital in a gain/losses report.
.\".It Fl \-rich-data
.It Fl \-seed Ar INT
Set the random seed to
@ -852,8 +883,9 @@ Execute a
.Nm
script.
.It Fl \-sort Ar EXPR Pq Fl S
Sort the register report based on the value expression given to sort.
.\".It Fl \-sort-all
Sort the register report based on the value expression
.Ar EXPR .
.\".It Fl \-sort-all Ar EXPR
.It Fl \-sort-xacts
Sort the posting within transactions using the given value expression.
.It Fl \-start-of-week Ar STR
@ -879,7 +911,10 @@ entries. Only useful on a register report. Alias for
.It Fl \-time-colon
Display the value for commodities based on seconds as hours and minutes.
Thus 8100s will be displayed as 2:15h instead of 2.25h.
.\".It Fl \-time-report
.It Fl \-time-report
Add two columns to the
.Ic balance
report to show the earliest checkin and checkout times for timelog entries.
.It Fl \-total Ar EXPR Pq Fl T
Define a value expression used to calculate the total in reports.
.It Fl \-total-data Pq Fl J
@ -931,7 +966,8 @@ precision.
Show the values used by each tag when used in combination with the
.Ic tags
command.
.\".It Fl \-value-expr Ar EXPR
.It Fl \-value-expr Ar EXPR
Set a global value expression annotation.
.It Fl \-verbose
Print detailed information on the execution of
.Nm .
@ -941,7 +977,9 @@ slowdown. When combined with
.Fl \-debug Ar CODE
.Nm
will produce memory trace information.
.\".It Fl \-verify-memory
.It Fl \-verify-memory
Verify that every constructed object is properly destructed. This is for
debugging purposes only.
.It Fl \-version
Print version information and exit.
.It Fl \-weekly Pq Fl W

75
doc/ledger3.texi
View file

@ -5468,7 +5468,7 @@ Redirect output to @file{FILE}.
Specify an options file.
@item --import @var{FILE}
@value{FIXME:UNDOCUMENTED}
Import @var{FILE} as Python module.
@item --account @var{STR}
@itemx -a @var{STR}
@ -5733,8 +5733,9 @@ Set expected freshness of prices in @var{INT} minutes.
@itemx -Q
Download quotes using the script named @file{getquote}.
@item --getquote @var{FILE}
Sets the path to a user-defined script to download commodity prices.
@c FIXME: The option doesn't exist currently.
@c @item --getquote @var{FILE}
@c Sets the path to a user-defined script to download commodity prices.
@item --quantity
@itemx -O
@ -5884,7 +5885,6 @@ days by day.
@c @end smallexample
@c @smallexample @c output:
@c @end smallexample
@value{FIXME:UNDOCUMENTED}
@item --decimal-comma
Direct Ledger to parse journals using the European standard comma as
@ -5892,8 +5892,9 @@ a decimal separator, not the usual period.
@item --download
@itemx -Q
Direct Ledger to download prices using the script defined via the option
@option{--getquote @var{FILE}}.
Direct Ledger to download prices.
@c using the script defined via the option
@c @option{--getquote @var{FILE}}.
@item --explicit
@c see test/baseline/opt-explicit.test
@ -5903,11 +5904,12 @@ Direct Ledger to download prices using the script defined via the option
@itemx -f @var{FILE}
Specify the input @file{FILE} for this invocation.
@item --getquote @var{FILE}
@cindex getquote
@cindex download prices
Tell ledger where to find the user defined script to download prices
information.
@c FIXME: The option doesn't exist currently.
@c @item --getquote @var{FILE}
@c @cindex getquote
@c @cindex download prices
@c Tell ledger where to find the user defined script to download prices
@c information.
@item --input-date-format @var{DATE_FORMAT}
Specify the input date format for journal entries. For example,
@ -5990,8 +5992,9 @@ based commodity as real hours and minutes.
For example 8100 seconds by default will be displayed as 2.25 whereas
with the @option{--time-colon} option they will be displayed as 2:15.
@item --value-expr @var{FIXME}
@value{FIXME:UNDOCUMENTED}
@item --value-expr @var{VEXPR}
Set a global value expression annotation.
@c needs example
@end ftable
@ -6051,9 +6054,8 @@ Set the width in characters of the amount column in the
Anonymize registry output, mostly for sending in bug reports.
@item --auto-match
@c Automatically match accounts from ledger journal when using convert command
@c see test/baseline/opt-auto-match.dat
@value{FIXME:UNDOCUMENTED}
Automatically match accounts from ledger journal for transactions
during csv convert.
@item --aux-date
@itemx --effective
@ -6077,10 +6079,8 @@ Strings}). The default is:
@end smallexample
@item --base
@c Report commodity in the base commodity s instead of h
@c Does this apply to other commodities too?
@c see test/baseline/opt-base.test/
@value{FIXME:UNDOCUMENTED}
Reduce convertible commodities down the bottom of the conversion, e.g.
display time in seconds. This also applies to custom commodity conversions.
@item --basis
@itemx -B
@ -6200,10 +6200,7 @@ Specify the width, in characters, of the date column in the
@command{register} report.
@item --datetime-format @var{DATETIME_FORMAT}
@c Specify the format ledger should use to print datetimes in
@c @command{balance} @option{--timelog-report} reports.
@c see test/baseline/opt-datetime-format.test
@value{FIXME:UNDOCUMENTED}
Specify the format ledger should use to print datetimes.
@item --dc
Display register or balance in debit/credit format If you use
@ -6311,7 +6308,8 @@ command}). Gives current account balances in the form of a register
report.
@item --exact
@value{FIXME:UNDOCUMENTED}
Report beginning and ending of periods by the date of the first and last
posting occurring in that period.
@item --exchange @var{COMMODITY}
@itemx -X @var{COMMODITY}
@ -6389,10 +6387,10 @@ Print the first @var{INT} entries. Opposite of @option{--tail
@item --historical
@itemx -H
@value{FIXME:UNDOCUMENTED}
Value commodities at the time of their acquisition.
@item --immediate
@value{FIXME:UNDOCUMENTED}
Evaluate calculations immediately rather than lazily.
@item --inject
Use @code{Expected} amounts in calculations. In case you know
@ -6433,8 +6431,8 @@ Report the date and price at which each commodity was purchased in
a balance report.
@item --lots-actual
@c see test/baseline/opt-lots-actual.test
@value{FIXME:UNDOCUMENTED}
Preserve the uniqueness of commodities so they aren't merged during
reporting without printing the lot annotations.
@item --market
@itemx -V
@ -6589,15 +6587,16 @@ Show all postings in a transaction, similar to @option{--related} but
show both @emph{sides} of each transaction.
@item --revalued
@c see test/baeline/opt-revalued.test
@value{FIXME:UNDOCUMENTED}
Report discrepancy in values for manual reports by inserting @code{<Revalued>}
postings. This is implied when using the @option{--exchange} or
@option{--market} option.
@item --revalued-only
@c see test/baeline/opt-revalued-only.test
@value{FIXME:UNDOCUMENTED}
Show only @code{<Revalued>} postings.
@item --revalued-total @var{FIXME}
@value{FIXME:UNDOCUMENTED}
Display the sum of the revalued postings as the running total, which serves
to show unrealized capital in a gain/losses report.
@item --rich-data
@itemx --detail
@ -6637,9 +6636,8 @@ Report only the last @var{INT} entries. Only useful in
a @command{register} report.
@item --time-report
@c Display begin and end time for each timelog entry in balance reports
@c see test/baseline/opt-time-report.test
@value{FIXME:UNDOCUMENTED}
Add two columns to the balance report to show the earliest checkin and
checkout times for timelog entries.
@item --total @var{VEXPR}
@itemx -T @var{VEXPR}
@ -9708,7 +9706,8 @@ slowdown. When combined with @option{--debug @var{CODE}} ledger will
produce memory trace information.
@item --verify-memory
@value{FIXME:UNDOCUMENTED}
Verify that every constructed object is properly destructed. This is for
debugging purposes only.
@item --version
Print version information and exit.