summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlexis Hildebrandt <afh@surryhill.net>2014-02-07 18:38:43 +0100
committerAlexis Hildebrandt <afh@surryhill.net>2014-02-07 18:39:35 +0100
commita1cc8ca15ae1761fbcb4c6ec9f8af82e8ab411ab (patch)
tree6a059d6c511825a9f1a544538d31a636bda2f695 /doc
parentfbbb379fe08b051b40c071041108a2526533f417 (diff)
downloadfork-ledger-a1cc8ca15ae1761fbcb4c6ec9f8af82e8ab411ab.tar.gz
fork-ledger-a1cc8ca15ae1761fbcb4c6ec9f8af82e8ab411ab.tar.bz2
fork-ledger-a1cc8ca15ae1761fbcb4c6ec9f8af82e8ab411ab.zip
Add support to check documentation examples with inline data
Diffstat (limited to 'doc')
-rw-r--r--doc/ledger3.texi58
1 files changed, 33 insertions, 25 deletions
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index acf58698..48fafc13 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -1503,7 +1503,7 @@ entry.
For example, the following entries reflect transaction made for a
business trip to Europe from the US:
-@smallexample
+@smallexample @c input:82150D9
2011/09/23 Cash in Munich
Assets:Cash E50.00
Assets:Checking $-66.00
@@ -1519,8 +1519,11 @@ spent on Dinner in Munich.
Running a ledger balance report shows:
-@smallexample
+@smallexample @c command:82150D9
$ ledger -f example.dat bal
+@end smallexample
+
+@smallexample @c output:82150D9
$-66.00
E15.00 Assets
E15.00 Cash
@@ -3641,7 +3644,7 @@ the money to be evenly distributed over the next six months so that
your monthly budgets gradually take a hit for the vegetables you'll
pick up from the co-op, even though you've already paid for them.
-@smallexample
+@smallexample @c input:6453542
2008/10/16 * (2090) Bountiful Blessings Farm
Expenses:Food:Groceries $ 37.50 ; [=2008/10/01]
Expenses:Food:Groceries $ 37.50 ; [=2008/11/01]
@@ -3659,15 +3662,17 @@ really knows that it debited $225 this month.
And using @option{--effective} option, initial date will be overridden
by effective dates.
-@smallexample
+@smallexample @c command:6453542
$ ledger --effective register Groceries
+@end smallexample
-08-Oct-01 Bountiful Blessi.. Expe:Food:Groceries $ 37.50 $ 37.50
-08-Nov-01 Bountiful Blessi.. Expe:Food:Groceries $ 37.50 $ 75.00
-08-Dec-01 Bountiful Blessi.. Expe:Food:Groceries $ 37.50 $ 112.50
-09-Jan-01 Bountiful Blessi.. Expe:Food:Groceries $ 37.50 $ 150.00
-09-Feb-01 Bountiful Blessi.. Expe:Food:Groceries $ 37.50 $ 187.50
-09-Mar-01 Bountiful Blessi.. Expe:Food:Groceries $ 37.50 $ 225.00
+@smallexample @c output:6453542
+08-Oct-01 Bountiful Blessings.. Expense:Food:Groceries $ 37.50 $ 37.50
+08-Nov-01 Bountiful Blessings.. Expense:Food:Groceries $ 37.50 $ 75.00
+08-Dec-01 Bountiful Blessings.. Expense:Food:Groceries $ 37.50 $ 112.50
+09-Jan-01 Bountiful Blessings.. Expense:Food:Groceries $ 37.50 $ 150.00
+09-Feb-01 Bountiful Blessings.. Expense:Food:Groceries $ 37.50 $ 187.50
+09-Mar-01 Bountiful Blessings.. Expense:Food:Groceries $ 37.50 $ 225.00
@end smallexample
@node Periodic Transactions, Concrete Example of Automated Transactions, Effective Dates, Automated Transactions
@@ -3792,14 +3797,14 @@ options.
The balance report is the most commonly used report. The simplest
invocation is:
-@smallexample
+@smallexample @c command:1D00D56
$ ledger balance -f drewr3.dat
@end smallexample
@noindent
which will print the balances of every account in your journal.
-@smallexample
+@smallexample @c output:1D00D56
$ -3,804.00 Assets
$ 1,396.00 Checking
$ 30.00 Business
@@ -3826,8 +3831,11 @@ Most times this is more than you want. Limiting the results to
specific accounts is as easy as entering the names of the accounts
after the command.
-@smallexample
+@smallexample @c command:06B2AD4
$ ledger balance -f drewr3.dat Auto MasterCard
+@end smallexample
+
+@smallexample @c output:06B2AD4
$ 5,500.00 Expenses:Auto
$ -20.00 Liabilities:MasterCard
--------------------
@@ -4992,7 +5000,7 @@ earlier postings. Here's how it works:
Say you currently have this posting in your ledger file:
-@smallexample
+@smallexample @c input:03ACB97
2004/03/15 * Viva Italiano
Expenses:Food $12.45
Expenses:Tips $2.55
@@ -5003,17 +5011,17 @@ Now it's @samp{2004/4/9}, and you've just eating at @samp{Viva Italiano}
again. The exact amounts are different, but the overall form is the
same. With the @command{xact} command you can type:
-@smallexample
+@smallexample @c command:03ACB97
$ ledger xact 2004/4/9 viva food 11 tips 2.50
@end smallexample
This produces the following output:
-@smallexample
+@smallexample @c output:03ACB97
2004/04/09 Viva Italiano
- Expenses:Food $11.00
- Expenses:Tips $2.50
- Liabilities:MasterCard $-13.50
+ Expenses:Food $11.00
+ Expenses:Tips $2.50
+ Liabilities:MasterCard
@end smallexample
It works by finding a past posting matching the regular expression
@@ -6491,7 +6499,7 @@ In the balance report, it shows all the accounts affected by
transactions having a related posting. For example, if a file had
this transaction:
-@smallexample
+@smallexample @c input:94C5675
2004/03/20 Safeway
Expenses:Food $65.00
Expenses:Cash $20.00
@@ -6500,16 +6508,16 @@ this transaction:
And the register command was:
-@smallexample
-$ ledger -r register food
+@smallexample @c command:94C5675
+$ ledger -f example.dat -r register food
@end smallexample
The following would be output, showing the postings related to the
posting that matched:
-@smallexample
-2004/03/20 Safeway Expenses:Cash $-20.00 $-20.00
- Assets:Checking $85.00 $65.00
+@smallexample @c output:94C5675
+04-Mar-20 Safeway Expenses:Cash $20.00 $20.00
+ Assets:Checking $-85.00 $-65.00
@end smallexample
@item --budget