Improve documentation for --auto-match option.

This commit is contained in:
thdox 2015-02-22 16:52:21 +01:00
parent 788ffc2a4b
commit 87d938f9c3
2 changed files with 19 additions and 10 deletions

View file

@ -368,8 +368,9 @@ Ignore init files and environment variables for the
.Nm
run.
.It Fl \-auto-match
Automatically match accounts from ledger journal for transactions
during csv convert.
When generating a ledger transaction from a CSV file using the
.Ic convert
command, automatically match an account from the Ledger journal.
.It Fl \-aux-date
Show auxiliary dates for all calculations.
Alias for
@ -878,7 +879,7 @@ postings.
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
When generating ledger transaction from CSV file using the
When generating a ledger transaction from a CSV file using the
.Ic convert
command, add CSV, Imported, and UUID meta-data.
.It Fl \-seed Ar INT

View file

@ -4635,13 +4635,16 @@ Ledger will include @samp{; transid: 767718} in the first transaction
from the file above.
@findex --invert
@findex --auto-match
@findex --account @var{STR}
@findex --rich-data
The @command{convert} command accepts three options. They are
@option{--invert} which inverts the amount field, @option{--account
@var{STR}} which you can use to specify the account to balance against,
and @option{--rich-data} which stores additional metadata as tags.
The @command{convert} command accepts four options. They are
@option{--invert} which inverts the amount field, @option{--auto-match}
which automatically matches an account from the Ledger journal for every
CSV line, @option{--account @var{STR}} which you can use to specify the
account to balance against, and @option{--rich-data} which stores
additional tag/value pairs.
Using the two first lines of the above csv file,
@ -4686,6 +4689,10 @@ normal ledger file (specified via @option{--file @var{FILE} (-f)} or via
the environment variable @env{LEDGER_FILE}) this entry will not be
printed again.
In the output above, the account is @samp{Expenses:Unknown} for CSV
lines. You can use the @option{--auto-match} option to automatically
match an account from your Ledger journal.
You can also use @command{convert} with @code{payee} and @code{account}
directives. First, you can use the @code{payee} and @code{alias}
directive to rewrite the @code{payee} field based on some rules. Then
@ -6117,8 +6124,9 @@ Set the width in characters of the amount column in the
Anonymize registry output, mostly for sending in bug reports.
@item --auto-match
Automatically match accounts from ledger journal for transactions
during csv convert.
When generating a ledger transaction from a CSV file using the
@command{convert} command, automatically match an account from the
Ledger journal.
@item --aux-date
@itemx --effective
@ -6667,7 +6675,7 @@ to show unrealized capital in a gain/losses report.
@item --rich-data
@itemx --detail
When generating ledger transaction from CSV file using the
When generating a ledger transaction from a CSV file using the
@command{convert} command, add CSV, Imported, and UUID metadata.
@item --seed @var{INT}