summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorthdox <thdox@free.fr>2015-02-22 16:52:21 +0100
committerthdox <thdox@free.fr>2015-02-24 20:23:01 +0100
commit87d938f9c3c3b25f03f07251a649f003e48602d0 (patch)
treed87cfaef4021ad68ac48a5d187ddda0bf70c44da
parent788ffc2a4bfdb95782163eeb463ff9c05947a311 (diff)
downloadfork-ledger-87d938f9c3c3b25f03f07251a649f003e48602d0.tar.gz
fork-ledger-87d938f9c3c3b25f03f07251a649f003e48602d0.tar.bz2
fork-ledger-87d938f9c3c3b25f03f07251a649f003e48602d0.zip
Improve documentation for --auto-match option.
-rw-r--r--doc/ledger.17
-rw-r--r--doc/ledger3.texi22
2 files changed, 19 insertions, 10 deletions
diff --git a/doc/ledger.1 b/doc/ledger.1
index 8925e6f9..b5b61b27 100644
--- a/doc/ledger.1
+++ b/doc/ledger.1
@@ -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
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index a4e055d0..e2502cbe 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -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}