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

Move Ledger CLI command to @command. Also, fix commas in section title (makeinfo does not like that).

Browse source
This commit is contained in:
thdox 2013-05-19 18:00:06 +02:00
parent 78538acc48
commit ff90cb38db
1 changed files with 128 additions and 128 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

256
doc/ledger3.texi
View file

@ -487,11 +487,11 @@ $ ledger -f drewr3.dat register payee "Organic"
@findex cleared @findex cleared
A very useful report is to show what your obligations are versus what A very useful report is to show what your obligations are versus what
expenditures have actually been recorded. It can take several days expenditures have actually been recorded. It can take several days for
for a check to clear, but you should treat it as money spent. The a check to clear, but you should treat it as money spent. The
@code{cleared} report shows just that (note that the cleared report @command{cleared} report shows just that (note that the
will not format correctly for accounts that contain multiple @command{cleared} report will not format correctly for accounts that
commodities): contain multiple commodities):
@smallexample @smallexample
$ ledger -f drewr3.dat cleared $ ledger -f drewr3.dat cleared
@ -1819,7 +1819,7 @@ Warning: "FinanceData/Master.dat", line 15: Unknown account 'Allocation:Equities
@end smallexample @end smallexample
If you have a large Ledger register already created use the If you have a large Ledger register already created use the
@code{accounts} command to get started: @command{accounts} command to get started:
@smallexample @smallexample
$ ledger accounts >> Accounts.dat $ ledger accounts >> Accounts.dat
@ -2064,8 +2064,8 @@ capture Expenses:Deductible:Medical Medical
Would cause any posting with @code{Medical} in its name to be replaced Would cause any posting with @code{Medical} in its name to be replaced
with @code{Expenses:Deductible:Medical}. with @code{Expenses:Deductible:Medical}.
Ledger will display the mapped payees in @code{print} and Ledger will display the mapped payees in @command{print} and
@code{register} reports. @command{register} reports.
@item check @item check
@c instance_t::check_directive in textual.cc @c instance_t::check_directive in textual.cc
@ -2199,8 +2199,8 @@ a parsed payee, the declared payee name is substituted:
... ...
@end smallexample @end smallexample
Ledger will display the mapped payees in @code{print} and Ledger will display the mapped payees in @command{print} and
@code{register} reports. @command{register} reports.
@item apply tag @item apply tag
@c instance_t::tag_directive in textual.cc @c instance_t::tag_directive in textual.cc
@ -4059,14 +4059,14 @@ part of the balance.
@section Primary Financial Reports @section Primary Financial Reports
@menu @menu
* The balance Command:: * The @command{balance} command::
* The equity Command:: * The @command{equity} command::
* The register Command:: * The @command{register} command::
* The print Command:: * The @command{print} command::
@end menu @end menu
@node The balance Command, The equity Command, Primary Financial Reports, Primary Financial Reports @node The @command{balance} command, The @command{equity} command, Primary Financial Reports, Primary Financial Reports
@subsection The @code{balance} command @subsection The @command{balance} command
@findex balance @findex balance
The @command{balance} command reports the current balance of all The @command{balance} command reports the current balance of all
@ -4075,16 +4075,16 @@ balance report to the matching accounts. If an account contains
multiple types of commodities, each commodity's total is reported multiple types of commodities, each commodity's total is reported
separately. separately.
@node The equity Command, The register Command, The balance Command, Primary Financial Reports @node The @command{equity} command, The @command{register} command, The @command{balance} command, Primary Financial Reports
@subsection The @code{equity} command @subsection The @command{equity} command
@findex equity @findex equity
The @command{equity} command prints out accounts balances as if they The @command{equity} command prints out accounts balances as if they
were transactions. This makes it easy to establish the starting were transactions. This makes it easy to establish the starting
balances for an account, such as when @ref{Archiving Previous Years}. balances for an account, such as when @ref{Archiving Previous Years}.
@node The register Command, The print Command, The equity Command, Primary Financial Reports @node The @command{register} command, The @command{print} command, The @command{equity} command, Primary Financial Reports
@subsection The @code{register} command @subsection The @command{register} command
@findex register @findex register
The @command{register} command displays all the postings occurring The @command{register} command displays all the postings occurring
@ -4105,8 +4105,8 @@ included in the Ledger distribution. The only requirement is that you
add either @code{-j} or @code{-J} to your register command, in add either @code{-j} or @code{-J} to your register command, in
order to plot either the amount or total column, respectively. order to plot either the amount or total column, respectively.
@node The print Command, , The register Command, Primary Financial Reports @node The @command{print} command, , The @command{register} command, Primary Financial Reports
@subsection The @code{print} command @subsection The @command{print} command
@findex print @findex print
The @command{print} command prints out ledger transactions in a textual The @command{print} command prints out ledger transactions in a textual
@ -4123,24 +4123,24 @@ file whose formatting has gotten out of hand.
@menu @menu
* Comma Separated Values files:: * Comma Separated Values files::
* The lisp command:: * The @command{lisp} command::
* Emacs Org mode:: * Emacs @command{org} Mode::
* Org mode with Babel:: * Org mode with Babel::
* The pricemap Command:: * The @command{pricemap} command::
* The xml Command:: * The @command{xml} command::
* prices and pricedb:: * @command{prices} and @command{pricedb} commands::
@end menu @end menu
@node Comma Separated Values files, The lisp command, Reports in other Formats, Reports in other Formats @node Comma Separated Values files, The @command{lisp} command, Reports in other Formats, Reports in other Formats
@subsection Comma Separated Values files @subsection Comma Separated Values files
@menu @menu
* The csv command:: * The @command{csv} command::
* The convert command:: * The @command{convert} command::
@end menu @end menu
@node The csv command, The convert command, Comma Separated Values files, Comma Separated Values files @node The @command{csv} command, The @command{convert} command, Comma Separated Values files, Comma Separated Values files
@subsubsection The @code{csv} command @subsubsection The @command{csv} command
@findex csv @findex csv
The @command{csv} command will output print out the desired ledger The @command{csv} command will output print out the desired ledger
@ -4148,19 +4148,19 @@ transactions in a csv format suitable for import into other programs.
You can specify the transactions to print using all the normal You can specify the transactions to print using all the normal
limiting and searching functions. limiting and searching functions.
@node The convert command, , The csv command, Comma Separated Values files @node The @command{convert} command, , The @command{csv} command, Comma Separated Values files
@subsubsection The @code{convert} command @subsubsection The @command{convert} command
@cindex csv conversion @cindex csv conversion
@cindex reading csv @cindex reading csv
@cindex comma separated variable file reading @cindex comma separated variable file reading
@findex convert @findex convert
@findex --input-date-format @var{DATE_FORMAT} @findex --input-date-format @var{DATE_FORMAT}
The @code{convert} command parses a comma separated value (csv) file The @command{convert} command parses a comma separated value (csv) file
and outputs Ledger transactions. Many banks offer csv file downloads. and outputs Ledger transactions. Many banks offer csv file downloads.
Unfortunately, the file formats, aside the from commas, are all Unfortunately, the file formats, aside the from commas, are all
different. The ledger @code{convert} command tries to help as much as different. The ledger @command{convert} command tries to help as much
it can. as it can.
Your banks csv files will have fields in different orders from other Your banks csv files will have fields in different orders from other
banks, so there must be a way to tell Ledger what to expect. Insert banks, so there must be a way to tell Ledger what to expect. Insert
@ -4227,16 +4227,16 @@ is from the file above.
@findex --account @var{STR} @findex --account @var{STR}
@findex --rich-data @findex --rich-data
The @code{convert} command accepts three options, the most important The @command{convert} command accepts three options, the most important
ones are @code{--invert} which inverts the amount field, and ones are @code{--invert} which inverts the amount field, and
@code{--account @var{STR}} which you can use to specify the account to @code{--account @var{STR}} which you can use to specify the account to
balance against and @code{--rich-data}. When using the rich-data balance against and @code{--rich-data}. When using the rich-data switch
switch additional metadata is stored as tags. There is, for example, additional metadata is stored as tags. There is, for example, a UUID
a UUID field. If an entry with the same UUID tag is already included field. If an entry with the same UUID tag is already included in the
in the normal ledger file (specified via @code{-f} or via environment normal ledger file (specified via @code{-f} or via environment variable
variable @env{LEDGER_FILE}) this entry will not be printed again. @env{LEDGER_FILE}) this entry will not be printed again.
You can also use @code{convert} with @code{payee} and @code{account} You can also use @command{convert} with @code{payee} and @code{account}
directives. First, you can use the @code{payee} and @code{alias} directives. First, you can use the @code{payee} and @code{alias}
directive to rewrite the @code{payee} field based on some rules. Then directive to rewrite the @code{payee} field based on some rules. Then
you can use the account and its @code{payee} directive to specify the you can use the account and its @code{payee} directive to specify the
@ -4255,8 +4255,8 @@ match on the new payee field. During the @code{ledger convert} run
only the original payee name as specified in the csv data seems to be only the original payee name as specified in the csv data seems to be
used. used.
@node The lisp command, Emacs Org mode, Comma Separated Values files, Reports in other Formats @node The @command{lisp} command, Emacs @command{org} Mode, Comma Separated Values files, Reports in other Formats
@subsection The @code{lisp} command @subsection The @command{lisp} command
@findex lisp @findex lisp
@findex emacs @findex emacs
@ -4270,14 +4270,14 @@ directly by Emacs Lisp. The format of the @code{sexp} is:
@end smallexample @end smallexample
@noindent @noindent
@code{emacs} can also be used as a synonym for @code{lisp} @command{emacs} can also be used as a synonym for @command{lisp}.
@node Emacs Org mode, Org mode with Babel, The lisp command, Reports in other Formats @node Emacs @command{org} Mode, Org mode with Babel, The @command{lisp} command, Reports in other Formats
@subsection Emacs @code{org} Mode @subsection Emacs @command{org} Mode
@findex org @findex org
The @code{org} command produces a journal file suitable for use in the The @command{org} command produces a journal file suitable for use in
Emacs Org mode. More details on using Org mode can be found at the Emacs Org mode. More details on using Org mode can be found at
@url{http://www.orgmode.org}. @url{http://www.orgmode.org}.
Org mode has a sub-system known as Babel which allows for literate Org mode has a sub-system known as Babel which allows for literate
@ -4330,7 +4330,7 @@ default, will appear immediately below the source code block.
You can combine multiple source code blocks before executing ledger and You can combine multiple source code blocks before executing ledger and
do all kinds of other wonderful things with Babel (and Org mode). do all kinds of other wonderful things with Babel (and Org mode).
@node Org mode with Babel, The pricemap Command, Emacs Org mode, Reports in other Formats @node Org mode with Babel, The @command{pricemap} command, Emacs @command{org} Mode, Reports in other Formats
@subsection Org mode with Babel @subsection Org mode with Babel
Using Babel, it is possible to record financial transactions Using Babel, it is possible to record financial transactions
@ -4374,7 +4374,7 @@ The first two are described in more detail in this short tutorial.
@menu @menu
* Embedded Ledger example with single source block:: * Embedded Ledger example with single source block::
* Multiple Ledger source blocks with @command{noweb}:: * Multiple Ledger source blocks with @code{noweb}::
* Income Entries:: * Income Entries::
* Expenses:: * Expenses::
* Financial Summaries:: * Financial Summaries::
@ -4383,7 +4383,7 @@ The first two are described in more detail in this short tutorial.
* Summary:: * Summary::
@end menu @end menu
@node Embedded Ledger example with single source block, Multiple Ledger source blocks with @command{noweb}, Org mode with Babel, Org mode with Babel @node Embedded Ledger example with single source block, Multiple Ledger source blocks with @code{noweb}, Org mode with Babel, Org mode with Babel
@subsubsection Embedded Ledger example with single source block @subsubsection Embedded Ledger example with single source block
The easiest, albeit possibly less useful, way in which to use Ledger The easiest, albeit possibly less useful, way in which to use Ledger
@ -4423,7 +4423,7 @@ well as many other types of reports) using Babel to invoke Ledger with
specific arguments. The arguments are passed to Ledger using the specific arguments. The arguments are passed to Ledger using the
@code{:cmdline} header argument. In the code block above, there is no @code{:cmdline} header argument. In the code block above, there is no
such argument so the system takes the default. For Ledger code blocks, such argument so the system takes the default. For Ledger code blocks,
the default @code{:cmdline} argument is @code{bal} and the result of the default @code{:cmdline} argument is @command{bal} and the result of
evaluating this code block (@kbd{C-c C-c}) would be: evaluating this code block (@kbd{C-c C-c}) would be:
@smallexample @smallexample
@ -4450,10 +4450,10 @@ financial state. Eventually, Babel will support passing arguments to
currently. Instead, we can use the concepts of literary programming, as currently. Instead, we can use the concepts of literary programming, as
implemented by the @code{noweb} features of Babel, to help us. implemented by the @code{noweb} features of Babel, to help us.
@node Multiple Ledger source blocks with @command{noweb}, Income Entries, Embedded Ledger example with single source block, Org mode with Babel @node Multiple Ledger source blocks with @code{noweb}, Income Entries, Embedded Ledger example with single source block, Org mode with Babel
@subsubsection Multiple Ledger source blocks with @command{noweb} @subsubsection Multiple Ledger source blocks with @code{noweb}
The @command{noweb} feature of Babel allows us to expand references to The @code{noweb} feature of Babel allows us to expand references to
other code blocks within a code block. For Ledger, this can be used to other code blocks within a code block. For Ledger, this can be used to
group transactions according to type, say, and then bring various sets group transactions according to type, say, and then bring various sets
of transactions together to generate reports. of transactions together to generate reports.
@ -4461,7 +4461,7 @@ of transactions together to generate reports.
Using the same transactions used above, we could consider splitting Using the same transactions used above, we could consider splitting
these into expenses and income, as follows: these into expenses and income, as follows:
@node Income Entries, Expenses, Multiple Ledger source blocks with @command{noweb}, Org mode with Babel @node Income Entries, Expenses, Multiple Ledger source blocks with @code{noweb}, Org mode with Babel
@subsubsection Income Entries @subsubsection Income Entries
The first set of entries relates to income, either monthly pay or The first set of entries relates to income, either monthly pay or
@ -4621,8 +4621,8 @@ file and manipulated using Babel. However, only simple Ledger features
have been illustrated; please refer to the Ledger documentation for have been illustrated; please refer to the Ledger documentation for
examples of more complex operations with a ledger. examples of more complex operations with a ledger.
@node The pricemap Command, The xml Command, Org mode with Babel, Reports in other Formats @node The @command{pricemap} command, The @command{xml} command, Org mode with Babel, Reports in other Formats
@subsection The @code{pricemap} command @subsection The @command{pricemap} command
@findex pricemap @findex pricemap
If you have the @code{graphviz} graph visualization package installed, If you have the @code{graphviz} graph visualization package installed,
@ -4633,8 +4633,8 @@ This is probably not very interesting, unless you have many different
commodities valued in terms of each other. For example, multiple commodities valued in terms of each other. For example, multiple
currencies and multiples investments valued in those currencies. currencies and multiples investments valued in those currencies.
@node The xml Command, prices and pricedb, The pricemap Command, Reports in other Formats @node The @command{xml} command, @command{prices} and @command{pricedb} commands, The @command{pricemap} command, Reports in other Formats
@subsection The @code{xml} command @subsection The @command{xml} command
@findex xml @findex xml
By default, Ledger uses a human-readable data format, and displays its By default, Ledger uses a human-readable data format, and displays its
@ -4789,8 +4789,8 @@ That is the extent of the XML data format used by Ledger. It will
output such data if the @command{xml} command is used, and can read output such data if the @command{xml} command is used, and can read
the same data. the same data.
@node prices and pricedb, , The xml Command, Reports in other Formats @node @command{prices} and @command{pricedb} commands, , The @command{xml} command, Reports in other Formats
@subsection @code{prices} and @code{pricedb} commands @subsection @command{prices} and @command{pricedb} commands
@findex prices @findex prices
@findex pricedb @findex pricedb
@ -4809,17 +4809,17 @@ pricedb database files.
@findex --count @findex --count
@menu @menu
* accounts:: * @command{accounts}::
* payees:: * @command{payees}::
* commodities:: * @command{commodities}::
* tags:: * @command{tags}::
* entry and xact:: * @command{xact}::
* stats:: * @command{stats}::
* select:: * @command{select}::
@end menu @end menu
@node accounts, payees, Reports about your Journals, Reports about your Journals @node @command{accounts}, @command{payees}, Reports about your Journals, Reports about your Journals
@subsection @code{accounts} @subsection @command{accounts}
@findex accounts @findex accounts
The @command{accounts} reports all of the accounts in the journal. The @command{accounts} reports all of the accounts in the journal.
@ -4828,8 +4828,8 @@ to accounts matching the regex. The output is sorted by name. Using
the @code{--count} option will tell you how many entries use each the @code{--count} option will tell you how many entries use each
account. account.
@node payees, commodities, accounts, Reports about your Journals @node @command{payees}, @command{commodities}, @command{accounts}, Reports about your Journals
@subsection @code{payees} @subsection @command{payees}
@findex payees @findex payees
The @command{payees} reports all of the unique payees in the journal. The @command{payees} reports all of the unique payees in the journal.
@ -4844,7 +4844,7 @@ Oudtshoorn Municipality
Vaca Veronica Vaca Veronica
@end smallexample @end smallexample
@node commodities, tags, payees, Reports about your Journals @node @command{commodities}, @command{tags}, @command{payees}, Reports about your Journals
@subsection @command{commodities} @subsection @command{commodities}
@findex commodities @findex commodities
@ -4852,7 +4852,7 @@ Report all commodities present in the journals under consideration.
The output is sorted by name. Using the @code{--count} option will The output is sorted by name. Using the @code{--count} option will
tell you how many entries use each commodity. tell you how many entries use each commodity.
@node tags, entry and xact, commodities, Reports about your Journals @node @command{tags}, , @command{commodities}, Reports about your Journals
@subsection @command{tags} @subsection @command{tags}
@findex tags @findex tags
@findex --values @findex --values
@ -4862,16 +4862,15 @@ is sorted by name. Using the @code{--count} option will tell you how
many entries use each tag. Using the @code{--values} option will many entries use each tag. Using the @code{--values} option will
report the values used by each tag. report the values used by each tag.
@node entry and xact, stats, tags, Reports about your Journals @node @command{xact}, @command{stats}, @command{tags}, Reports about your Journals
@subsection @command{draft}, @command{entry} and @command{xact} @subsection @command{xact}
@findex draft @findex draft
@findex entry @findex entry
@findex xact @findex xact
The @code{draft}, @code{entry} and @command{xact} commands simplify The @command{xact} command simplify the creation of new transactions.
the creation of new transactions. It works on the principle that 80% It works on the principle that 80% of all postings are variants of
of all postings are variants of earlier postings. Here's how it earlier postings. Here's how it works:
works:
Say you currently have this posting in your ledger file: Say you currently have this posting in your ledger file:
@ -4882,12 +4881,12 @@ Say you currently have this posting in your ledger file:
Liabilities:MasterCard $-15.00 Liabilities:MasterCard $-15.00
@end smallexample @end smallexample
Now it's @code{2004/4/9}, and you've just eating at @code{Viva Now it's @code{2004/4/9}, and you've just eating at @code{Viva Italiano}
Italiano} again. The exact amounts are different, but the overall again. The exact amounts are different, but the overall form is the
form is the same. With the @command{xact} command you can type: same. With the @command{xact} command you can type:
@smallexample @smallexample
$ ledger entry 2004/4/9 viva food 11 tips 2.50 $ ledger xact 2004/4/9 viva food 11 tips 2.50
@end smallexample @end smallexample
This produces the following output: This produces the following output:
@ -4900,8 +4899,8 @@ This produces the following output:
@end smallexample @end smallexample
It works by finding a past posting matching the regular expression It works by finding a past posting matching the regular expression
@code{viva}, and assuming that any accounts or amounts specified will @code{viva}, and assuming that any accounts or amounts specified will be
be similar to that earlier posting. If Ledger does not succeed in similar to that earlier posting. If Ledger does not succeed in
generating a new transaction, an error is printed and the exit code is generating a new transaction, an error is printed and the exit code is
set to @samp{1}. set to @samp{1}.
@ -4909,26 +4908,27 @@ Here are a few more examples of the @command{xact} command, assuming
the above journal transaction: the above journal transaction:
@smallexample @smallexample
$ ledger entry 4/9 viva 11.50 $ ledger xact 4/9 viva 11.50
$ ledger entry 4/9 viva 11.50 checking # (from `checking') $ ledger xact 4/9 viva 11.50 checking # (from `checking')
$ ledger entry 4/9 viva food 11.50 tips 8 $ ledger xact 4/9 viva food 11.50 tips 8
$ ledger xact 4/9 viva food 11.50 tips 8 cash $ ledger xact 4/9 viva food 11.50 tips 8 cash
$ ledger xact 4/9 viva food $11.50 tips $8 cash $ ledger xact 4/9 viva food $11.50 tips $8 cash
$ ledger xact 4/9 viva dining "DM 11.50" $ ledger xact 4/9 viva dining "DM 11.50"
@end smallexample @end smallexample
@command{xact} is identical to @command{entry} and is provide for @command{draft} and @command{entry} are both synonyms of
backwards compatibility with Ledger 2.X. @command{xact}. @command{entry} is provided for backwards compatibility
with Ledger 2.X.
@node stats, select, entry and xact, Reports about your Journals @node @command{stats}, @command{select}, @command{xact}, Reports about your Journals
@subsection @code{stats} @subsection @command{stats}
@findex stats @findex stats
@findex stat @findex stat
FIX THIS ENTRY @c FIXME thdox FIX THIS ENTRY @c FIXME thdox
@node select, , stats, Reports about your Journals @node @command{select}, , @command{stats}, Reports about your Journals
@subsection @code{select} @subsection @command{select}
@findex select @findex select
FIX THIS ENTRY @c FIXME thdox FIX THIS ENTRY @c FIXME thdox
@ -5228,7 +5228,7 @@ Report each posting deviation from the average
@itemx -% @itemx -%
Show subtotals in the balance report as percentages Show subtotals in the balance report as percentages
@c @item --totals @c @item --totals
@c Include running total in the @code{xml} report @c Include running total in the @command{xml} report
@item --pivot @var{TAG} @item --pivot @var{TAG}
Produce a pivot table of the @var{TAG} type specified Produce a pivot table of the @var{TAG} type specified
@ -5637,7 +5637,7 @@ Print average values over the number of transactions instead of
running totals. running totals.
@item --balance-format @var{FORMAT_STRING} @item --balance-format @var{FORMAT_STRING}
Specify the format to use for the @code{balance} report (@pxref{Format Specify the format to use for the @command{balance} report (@pxref{Format
Strings}). The default is: Strings}). The default is:
@smallexample @smallexample
@ -5678,7 +5678,7 @@ displays transaction in the budget, in a balance report this displays
accounts in the budget (@pxref{Budgeting and Forecasting}). accounts in the budget (@pxref{Budgeting and Forecasting}).
@item --budget-format @var{FORMAT_STRING} @item --budget-format @var{FORMAT_STRING}
Specify the format to use for the @code{budget} report (@pxref{Format Specify the format to use for the @command{budget} report (@pxref{Format
Strings}). The default is: Strings}). The default is:
@smallexample @smallexample
@ -5700,7 +5700,7 @@ display and calculation.
@item --cleared-format @var{FORMAT_STRING} @item --cleared-format @var{FORMAT_STRING}
FIX THIS ENTRY @c FIXME thdox: to keep? FIX THIS ENTRY @c FIXME thdox: to keep?
Specify the format to use for the @code{cleared} report (@pxref{Format Specify the format to use for the @command{cleared} report (@pxref{Format
Strings}). The default is: Strings}). The default is:
@smallexample @smallexample
@ -5736,7 +5736,7 @@ Direct ledger to report the number of items when
appended to the commodities, accounts or payees command. appended to the commodities, accounts or payees command.
@item --csv-format @var{FORMAT_STRING} @item --csv-format @var{FORMAT_STRING}
Specify the format to use for the @code{csv} report (@pxref{Format Specify the format to use for the @command{csv} report (@pxref{Format
Strings}). The default is: Strings}). The default is:
@smallexample @smallexample
@ -5872,9 +5872,9 @@ Specify the end @var{DATE} for transaction to be considered in the
report. report.
@item --equity @item --equity
Related to the @code{equity} command (@pxref{The Related to the @command{equity} command (@pxref{The @command{equity}
equity Command}). Gives current account balances in the form of a command}). Gives current account balances in the form of a register
register report. report.
@item --exact @item --exact
FIX THIS ENTRY @c ASK JOHN FIX THIS ENTRY @c ASK JOHN
@ -6550,8 +6550,8 @@ meaningful in the @command{register} and @command{prices} reports.
@item --percent @item --percent
@itemx -% @itemx -%
Show account subtotals in the @command{balance} report as percentages Show account subtotals in the @command{balance} report as percentages of
of the parent account. the parent account.
@c @code{--totals} include running total information in the @c @code{--totals} include running total information in the
@c @command{xml} report. @c @command{xml} report.
@ -6609,7 +6609,7 @@ Set the reporting format for whatever report ledger is about to make.
each report type: each report type:
@item --balance-format @var{FORMAT_STRING} @item --balance-format @var{FORMAT_STRING}
Define the output format for the @code{balance} report. The default Define the output format for the @command{balance} report. The default
(defined in @code{report.h} is: (defined in @code{report.h} is:
@smallexample @smallexample
@ -6642,7 +6642,7 @@ Define the format for the cleared report. The default is:
@end smallexample @end smallexample
@item --register-format @var{FORMAT_STRING} @item --register-format @var{FORMAT_STRING}
Define the output format for the @code{register} report. The default Define the output format for the @command{register} report. The default
(defined in @code{report.h} is: (defined in @code{report.h} is:
@smallexample @smallexample
@ -6680,7 +6680,7 @@ Define the output format for the @code{register} report. The default
@end smallexample @end smallexample
@item --csv-format @var{FORMAT_STRING} @item --csv-format @var{FORMAT_STRING}
Set the format for @code{csv} reports. The default is: Set the format for @command{csv} reports. The default is:
@smallexample @smallexample
"%(quoted(date)), "%(quoted(date)),
@ -8723,20 +8723,20 @@ commodities.
@section Developer Commands @section Developer Commands
@menu @menu
* echo:: * @command{echo}::
* reload:: * @command{reload}::
* source:: * @command{source}::
* Debug Options:: * Debug Options::
* Pre-commands:: * Pre-commands::
@end menu @end menu
@node echo, reload, Developer Commands, Developer Commands @node @command{echo}, @command{reload}, Developer Commands, Developer Commands
@subsection @command{echo} @subsection @command{echo}
@findex echo @findex echo
This command simply echoes its argument back to the output. This command simply echoes its argument back to the output.
@node reload, source, echo, Developer Commands @node @command{reload}, @command{source}, @command{echo}, Developer Commands
@subsection @command{reload} @subsection @command{reload}
@findex reload @findex reload
@ -8744,16 +8744,16 @@ Forces ledger to reload any journal files. This function exists to
support external programs controlling a running ledger process and does support external programs controlling a running ledger process and does
nothing for a command line user. nothing for a command line user.
@node source, Debug Options, reload, Developer Commands @node @command{source}, Debug Options, @command{reload}, Developer Commands
@subsection @command{source} @subsection @command{source}
@findex source @findex source
The @code{source} command take a journal file as an argument and parses The @command{source} command take a journal file as an argument and
it checking for errors, no other reports are generated, and no other parses it checking for errors, no other reports are generated, and no
arguments are necessary. Ledger will return success if no errors are other arguments are necessary. Ledger will return success if no errors
found. are found.
@node Debug Options, Pre-commands, source, Developer Commands @node Debug Options, Pre-commands, @command{source}, Developer Commands
@subsection Debug Options @subsection Debug Options
These options are primarily for Ledger developers, but may be of some These options are primarily for Ledger developers, but may be of some
@ -8839,7 +8839,7 @@ will work. The difference between a pre-command and a regular command
is that pre-commands ignore the journal data file completely, nor is is that pre-commands ignore the journal data file completely, nor is
the user's init file read. the user's init file read.
@ftable @code @ftable @command
@item eval @var{VEXPR} @item eval @var{VEXPR}
Evaluate the given value expression against the model transaction Evaluate the given value expression against the model transaction
@ -8924,7 +8924,7 @@ true
FIX THIS ENTRY @c FIXME thdox FIX THIS ENTRY @c FIXME thdox
@item template @item template
Shows the insertion template that a @code{draft} or @code{xact} Shows the insertion template that a @command{draft} or @command{xact}
sub-command generates. This is a debugging command. sub-command generates. This is a debugging command.
@end ftable @end ftable
@ -8933,14 +8933,14 @@ sub-command generates. This is a debugging command.
@section Ledger Development Environment @section Ledger Development Environment
@menu @menu
* acprep build configuration tool:: * @code{acprep} build configuration tool::
* Testing Framework:: * Testing Framework::
@end menu @end menu
@node acprep build configuration tool, Testing Framework, Ledger Development Environment, Ledger Development Environment @node @code{acprep} build configuration tool, Testing Framework, Ledger Development Environment, Ledger Development Environment
@subsection @code{acprep} build configuration tool @subsection @code{acprep} build configuration tool
@node Testing Framework, , acprep build configuration tool, Ledger Development Environment @node Testing Framework, , @code{acprep} build configuration tool, Ledger Development Environment
@subsection Testing Framework @subsection Testing Framework
Ledger source ships with a fairly complete set of tests to verify that Ledger source ships with a fairly complete set of tests to verify that