From 8ac3665cb9058a06ef49ad115e0c5d1b6ea139a2 Mon Sep 17 00:00:00 2001 From: thdox Date: Sun, 21 Dec 2014 18:25:51 +0100 Subject: Fixes: - typo fixes - @keywords consistency fixes - add some @kindex and @cindex - buffer names highlighted as @file{} - menu item highlighted as @samp{} --- doc/ledger-mode.texi | 87 ++++++++++++++++++++++++++++------------------------ 1 file changed, 47 insertions(+), 40 deletions(-) (limited to 'doc/ledger-mode.texi') diff --git a/doc/ledger-mode.texi b/doc/ledger-mode.texi index ca91d178..2b70df67 100644 --- a/doc/ledger-mode.texi +++ b/doc/ledger-mode.texi @@ -225,9 +225,9 @@ Emacs will prompt for a report name. There are a few built-in reports, and you can add any report you need @xref{Adding and Editing Reports}. In the Minibuffer type @samp{account}. When prompted for an account -type @samp{checking}. In another buffer you will see a Ledger register +type @samp{checking}. In a buffer named @file{*Ledger Report*}, you will see a Ledger register report. You can move around the buffer, with the point on a transaction, -type @kbd{C-c C-c}. Ledger-mode will take you directly to that +type @kbd{RET}. Ledger-mode will take you directly to that transaction in the @file{demo.ledger} buffer. Another built-in report is the balance report. In the @@ -277,7 +277,7 @@ payees and accounts. Included files are not currently included in the completion scan. Repeatedly hitting @kbd{TAB} will cycle through the possible completions. -Ledger-mode can also help you keep your amounts in aligned. Setting +Ledger-mode can also help you keep your amounts aligned. Setting @option{ledger-post-auto-adjust-amounts} to true tells Ledger-mode to automatically place any amounts such that their last digit is aligned to the column specified by @option{ledger-post-amount-alignment-column}, @@ -290,15 +290,18 @@ which defaults to @samp{52}. @xref{Ledger Post Customization Group}. @node Setting a Transactions Effective Date, Quick Balance Display, Adding Transactions, Adding Transactions @subsection Setting a Transactions Effective Date +@kindex C-c C-t +@cindex effective date -Ledger provide for adding information to a transaction that add details +Ledger provides for adding information to a transaction that add details to the dates. For example, you can specify when the transaction was -enter, when the transation clear, or when individual postings cleared. -Ledger-mode referes to these additional dates as ``effective dates''. -To set the effect date of a transaction place the point in the first +entered, when the transaction was cleared, or when individual postings +were cleared. +Ledger-mode refers to these additional dates as @emph{effective} dates. +To set the effective date of a transaction, place the point in the first line of a transaction and type @kbd{C-c C-t}. The effective date will -be added to the transacation. To set the effective date for an -inividual posting, place point in the posting and type @kbd{C-c C-t} and +be added to the transaction. To set the effective date for an +individual posting, place point in the posting and type @kbd{C-c C-t} and the effective date for that posting will be added at the end of the posting. @@ -390,12 +393,14 @@ while in a posting. This places an asterisk prior to the posting. @node Formatting Transactions, Deleting Transactions, Marking Transactions, The Ledger Buffer @section Formatting Transactions -When editing a transaction, liberal use of the TAB key can keep the -transaction well formatted. If you want to have ledger-mode cleanup the -formatting of a trasnaction you can use Align Transaction or Align -Region from the menu bar. +@cindex transaction, formatting -The menu item ``Clean-up Buffer'' sorts all transactions in the buffer +When editing a transaction, liberal use of the @kbd{TAB} key can keep the +transaction well formatted. If you want to have Ledger-mode cleanup the +formatting of a transaction you can use @samp{Align Transaction} or @samp{Align +Region} from the menu bar. + +The menu item @samp{Clean-up Buffer} sorts all transactions in the buffer by date, removes extraneous empty lines and aligns every transaction. @@ -639,13 +644,15 @@ type @kbd{t} and enter the new target value. @node Running Basic Reports, Adding and Editing Reports, The Report Buffer, The Report Buffer @section Running Reports @kindex C-c C-o C-r +@kindex C-c C-o C-g +@kindex C-c C-o C-a @cindex report, running The real power behind Ledger is in its amazing reporting capability. Ledger-mode provides easy facility to run reports directly from Emacs. It has four reports built-in and facilities for adding custom reports. -Typing @kbd{C-c C-o C-r} or using menu @samp{Ledger Run Report} prompts +Typing @kbd{C-c C-o C-r} or using menu @samp{Run Report} prompts for the name of a saved report. The built-in reports are: @table @var @@ -666,16 +673,16 @@ transactions involving that account. @end table -While viewing reports you can easily swtich back and forth between the -ledger buffer and the report buffer. I ntransaction reports typing -@kbd{RETURN} will take you to that transaction in the ledger buffer. -While in theledger buffer @kbd{C-c C-o C-g} returns you to the report +While viewing reports you can easily switch back and forth between the +ledger buffer and the @file{*Ledger Report*} buffer. In @file{*Ledger Report*} buffer, typing +@kbd{RET} will take you to that transaction in the ledger buffer. +While in the ledger buffer @kbd{C-c C-o C-g} returns you to the @file{*Ledger Report*} buffer. -By default ledger-mode will refresh the report buffer when the ledger -buffer is saved. iF you want to rerun the report at another time time +By default Ledger-mode will refresh the report buffer when the ledger +buffer is saved. If you want to rerun the report at another time @kbd{C-c C-o C-a}. This is useful if you have other programs altering -your ledger file outside of emacs. +your ledger file outside of Emacs. @node Adding and Editing Reports, Reversing Report Order, Running Basic Reports, The Report Buffer @@ -707,7 +714,7 @@ buffer you will have the option to give it a new name, or overwrite the old report. Deleting reports is accomplished by typing @kbd{C-c C-o C-e} or using -@samp{Edit Reports} menu in the ledger buffer, or typing @kbd{e} in the +@samp{Edit Report} menu in the ledger buffer, or typing @kbd{e} in the @file{*Ledger Report*} buffer. This takes you to the Emacs customization window for the Ledger Reports variables. Use the widgets to delete the report you want removed. @@ -817,25 +824,25 @@ characters to specify when the transactions should appear. @node Transactions that occur on specific dates, Transactions that occur on specific days, Specifying Upcoming Transactions, Specifying Upcoming Transactions @subsection Transactions that occur on specific dates -Many times you will repetitive transactions that occur on the same day +Many times you will enter repetitive transactions that occur on the same day of the month each month. These can be specified using a wild card in the year and month with a fixed date in the day. The following entry specifies a transaction that occurs on the first and fifteenth of every month in every year. @example [*/*/1,15] Paycheck - Income:Job $1000.00 - Assets:Checking + Income:Job $1000.00 + Assets:Checking @end example Some transactions do not occur every month. Comma separated lists of -the months, or E for even, or O for odd number months can also be +the months, or @samp{E} for even, or @samp{O} for odd number months can also be specified. The following entry specifies a bi-monthly exterminator bill that occurs in the even months: @example [*/E/01] Exterminator - Expenses:Home $100.00 - Asset:Checking + Expenses:Home $100.00 + Assets:Checking @end example @node Transactions that occur on specific days, , Transactions that occur on specific dates, Specifying Upcoming Transactions @@ -844,13 +851,13 @@ in the even months: Some transactions occur every relative to the day of the week rather than the date of the month. For example, many people are paid every two weeks without regard to the day of the month. Other events may occur on -specific days regaless of the date. For example the following +specific days regardless of the date. For example the following transactions creates a transaction every other Thursday: @example [2014/11/27+2Th] Paycheck - Income:Job $1000.00 - Assets; Checking + Income:Job $1000.00 + Assets:Checking @end example It is necessary to specify a starting date in order for this type of @@ -858,8 +865,8 @@ recurrence relation to be specified. The day names are two character codes that default to Mo, Tu, We, Th, Fr, Sa, Su, for Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday respectively. You can change the codes to something more convenient for your locale by -customizing the ledger @code{ledger-schedule-week-days}. They must be 2 -character long. +customizing the ledger @var{ledger-schedule-week-days}. They must be two +characters long. @@ -934,11 +941,11 @@ the reconcile regex. @item ledger-buffer-tracks-reconcile-buffer If non-nil, then when the cursor is moved to a new transaction in the -reconcile window. +@file{*Reconcile*} window. @item ledger-reconcile-force-window-bottom -If non-nil, make the reconcile window appear along the bottom of the -register window and resize. +If non-nil, make the @file{*Reconcile*} window appear along the bottom +of the register window and resize. @item ledger-reconcile-toggle-to-pending If non-nil, then toggle between uncleared and pending @samp{!}. If @@ -1006,13 +1013,13 @@ Default face for Ledger occur mode shown transactions. Face for Ledger comments. @item ledger-font-reconciler-uncleared-face -Default face for uncleared transactions in the reconcile window. +Default face for uncleared transactions in the @file{*Reconcile*} buffer. @item ledger-font-reconciler-cleared-face -Default face for cleared @samp{*} transactions in the reconcile window. +Default face for cleared @samp{*} transactions in the @file{*Reconcile*} buffer. @item ledger-font-reconciler-pending-face -Default face for pending @samp{!} transactions in the reconcile window. +Default face for pending @samp{!} transactions in the @file{*Reconcile*} buffer. @item ledger-font-report-clickable-face FIXME -- cgit v1.2.3 From 66265e76d54128588032958033bb143f30a24977 Mon Sep 17 00:00:00 2001 From: thdox Date: Sun, 21 Dec 2014 18:29:09 +0100 Subject: M-x delete-trailing-whitespace --- doc/ledger-mode.texi | 4 +-- doc/ledger3.texi | 70 ++++++++++++++++++++++++++-------------------------- 2 files changed, 37 insertions(+), 37 deletions(-) (limited to 'doc/ledger-mode.texi') diff --git a/doc/ledger-mode.texi b/doc/ledger-mode.texi index 2b70df67..563abf12 100644 --- a/doc/ledger-mode.texi +++ b/doc/ledger-mode.texi @@ -290,8 +290,8 @@ which defaults to @samp{52}. @xref{Ledger Post Customization Group}. @node Setting a Transactions Effective Date, Quick Balance Display, Adding Transactions, Adding Transactions @subsection Setting a Transactions Effective Date -@kindex C-c C-t -@cindex effective date +@kindex C-c C-t +@cindex effective date Ledger provides for adding information to a transaction that add details to the dates. For example, you can specify when the transaction was diff --git a/doc/ledger3.texi b/doc/ledger3.texi index c223650a..2a3f2879 100644 --- a/doc/ledger3.texi +++ b/doc/ledger3.texi @@ -31,44 +31,44 @@ @c @c To specially mark a @smallexample append @c command:UUID, where @c UUID is the first 7 digits from the commands sha1sum, e.g.: -@c +@c @c @smallexample @c command:CDE330A @c $ ledger -f sample.dat reg expenses @c @end smallexample -@c +@c @c Then DocTests.py will look for corresponding documented output, @c which may appear anywhere in the file, and is marked with @c @smallexample @c output:UUID where UUID is the UUID from the @c corresponding ledger command example, e.g.: -@c +@c @c @smallexample @c output:CDE330A @c 04-May-27 Book Store Expenses:Books $20.00 $20.00 @c Expenses:Cards $40.00 $60.00 @c Expenses:Docs $30.00 $90.0 @c @end smallexample -@c +@c @c Now where does this data in sample.dat come from? @c DocTests.py is a bit smart about ledger's file argument, since @c it will check if the given filename exists in the test/input/ @c directory. -@c +@c @c Sometimes the journal data for an example is specified within @c the documentation itself, in that case the journal example data @c needs to be specially marked as well using @smallexample @c input:UUID, @c again with the UUID being the UUID of the corresponding ledger example @c command. If multiple inputs with the same UUID are found they will be @c concatenated together and given as one set of data to the example command. -@c +@c @c @smallexample @c input:35CB2A3 @c 2014/02/09 The Italian Place @c Expenses:Food:Dining $ 36.84 @c Assets:Cash @c @end smallexample -@c +@c @c @smallexample @c command:35CB2A3 @c $ ledger -f inline.dat accounts @c @end smallexample -@c +@c @c @smallexample @c output:35CB2A3 @c Assets:Cash @c Expenses:Food:Dining @@ -89,10 +89,10 @@ @c Additionally DocTests.py will pass --init-file /dev/null to ledger to @c ignore any default arguments to ledger the user running the tests @c has configured. -@c +@c @c To manually run the tests in this file run: @c $ ./test/DocTests.py -vv --ledger ./ledger --file ./doc/ledger3.texi - + @copying @@ -1995,8 +1995,8 @@ freeform text editor to enter transactions makes it easy to keep the data, but also easy to enter accounts or payees inconsistently or with spelling errors. -In order to combat inconsistency you can define allowable accounts and -payees. For simplicity, create a separate text file and define accounts +In order to combat inconsistency you can define allowable accounts and +payees. For simplicity, create a separate text file and define accounts and payees like @smallexample @@ -2248,7 +2248,7 @@ $ ledger balance --no-total --recursive-aliases ^Exp $10.00 Expenses:Entertainment:Dining @end smallexample -The option @option{--no-aliases} completely disables alias expansion. +The option @option{--no-aliases} completely disables alias expansion. All accounts are read verbatim as they are in the ledger file. @item assert @@ -2268,7 +2268,7 @@ balance to zero. Ledger allows you to leave one posting with no amount and automatically balance the transaction in the posting. The @code{bucket} allows you to fill in all postings and automatically generate an additional posting to the bucket account -balancing the transaction. If any transaction is unbalanced, it +balancing the transaction. If any transaction is unbalanced, it will automatically be balanced against the @code{bucket} account. The following example sets @samp{Assets:Checking} as the bucket: @@ -2325,7 +2325,7 @@ commodity CAD @end smallexample The @code{commodity} directive supports several optional -sub-directives, if they immediately follow the commodity directive +sub-directives, if they immediately follow the commodity directive and---if they are on successive lines---begin with whitespace: @smallexample @c input:validate @@ -2529,8 +2529,8 @@ tag Receipt The @code{check} and @code{assert} sub-directives warn or error (respectively) if the given value expression evaluates to false within the context of any use of the related tag. In such a context, -``value'' is bound to the value of the tag (which may be something else -but a string if typed metadata is used!). Such checks or assertions are +``value'' is bound to the value of the tag (which may be something else +but a string if typed metadata is used!). Such checks or assertions are not called if no value is given. @item test @@ -3390,7 +3390,7 @@ buy and sell whole lots. The @{@{$500.00@}@} is @emph{not} an attribute of the commodity, whereas @{$5.00@} is. In fact, when you write @{@{$500.00@}@}, Ledger just divides that value by 10 and sees @{$50.00@}. So if you use the print command to look at this -transaction, you'll see the single braces form in the output. +transaction, you'll see the single braces form in the output. The double braces price form is a shorthand only. Plus, it comes with dangers. This works fine: @@ -3714,9 +3714,9 @@ This becomes: @node Referring to the matching posting's account, Applying metadata to every matched posting, Accessing the matching posting's amount, Automated Transactions @subsection Referring to the matching posting's account -Sometimes you want to refer to the account that was matched -in some way within the automated transaction itself. This is -done by using the string @samp{$account}, anywhere within the +Sometimes you want to refer to the account that was matched +in some way within the automated transaction itself. This is +done by using the string @samp{$account}, anywhere within the account part of the automated posting: @smallexample @c input:validate @@ -5531,7 +5531,7 @@ Accounts, tags or commodities not previously declared will cause errors. @item --check-payees Enable strict and pedantic checking for payees as well as accounts, -commodities and tags. This only works in conjunction with +commodities and tags. This only works in conjunction with @option{--strict} or @option{--pedantic}. @item --immediate @@ -5847,7 +5847,7 @@ a decimal separator, not the usual period. @item --download @itemx -Q -Direct Ledger to download prices using the script defined via the option +Direct Ledger to download prices using the script defined via the option @option{--getquote @var{FILE}}. @item --explicit @@ -6049,7 +6049,7 @@ $ ledger reg Expenses --begin Dec --bold-if "amount>100" @end smallexample @noindent -list all transactions since the beginning of December and print in +list all transactions since the beginning of December and print in bold any posting greater than $100. @item --budget @@ -6141,7 +6141,7 @@ Transform the date of the transaction using @var{EXPR}. @item --date-format @var{DATE_FORMAT} @itemx -y @var{DATE_FORMAT} -Specify the format ledger should use to read and print dates +Specify the format ledger should use to read and print dates (@pxref{Date and Time Format Codes}). @item --date-width @var{INT} @@ -6154,7 +6154,7 @@ FIX THIS ENTRY @c ASK JOHN @item --dc Display register or balance in debit/credit format If you use @option{--dc} with either the @command{register} (reg) or -@command{balance} (bal) commands, you will now get extra columns. +@command{balance} (bal) commands, you will now get extra columns. The register goes from this: @smallexample @@ -6449,7 +6449,7 @@ Only works for accounts that have a single commodity. Define a period expression that sets the time period during which transactions are to be accounted. For a @command{register} report only the transactions that satisfy the period expression with be displayed. -For a @command{balance} report only those transactions will be accounted +For a @command{balance} report only those transactions will be accounted in the final balances. @item --pivot @var{TAG} @@ -6907,8 +6907,8 @@ to see if weekend spending is more than on weekdays. @item --sort @var{VEXPR} @itemx -S @var{VEXPR} Sort a report by comparing the values determined using the value -expression @var{VEXPR}. For example, using @samp{-S "-abs(total)"} in the -@command{balance} report will sort account balances from greatest to least, +expression @var{VEXPR}. For example, using @samp{-S "-abs(total)"} in the +@command{balance} report will sort account balances from greatest to least, using the absolute value of the total. For more on how to use value expressions, see @ref{Value Expressions}. @@ -7296,7 +7296,7 @@ which allows you to report most everything in EUR if you use @samp{-X EUR}, except for certain accounts or postings which should always be valuated in another currency. For example: -@c TODO is this example missing the actual line to get the effect? +@c TODO is this example missing the actual line to get the effect? @c it looks like it only contains a match, but no effect @smallexample @c input:validate = /^Assets:Brokerage:CAD$/ @@ -7563,7 +7563,7 @@ This report continues outputting postings until the running total is greater than $-500.00. A final posting is always shown, to inform you what the total afterwards would be. -Forecasting can also be used with the @command{balance} report, +Forecasting can also be used with the @command{balance} report, but by date only, and not against the running total: @smallexample @c command:validate @@ -7584,7 +7584,7 @@ o 2013/03/29 03:39:00 This records a check-in to the given ACCOUNT, and a check-out. You can be checked-in to multiple accounts at a time, if you wish, and they can span multiple days (use @option{--day-break} to break them up in the -report). The number of seconds between check-in and check-out is accumulated +report). The number of seconds between check-in and check-out is accumulated as time to that ACCOUNT. If the checkout uses a capital @samp{O}, the transaction is marked ``cleared''. You can use an optional PAYEE for whatever meaning you like. @@ -7596,8 +7596,8 @@ information. Or you can use Org mode's time-clocking abilities and the @file{org2tc} script developed by John Wiegley. These timelog entries can appear in a separate file, or directly in -your main ledger file. The initial @samp{i} and @samp{o} characters -count as Ledger ``directives'', and are accepted anywhere that +your main ledger file. The initial @samp{i} and @samp{o} characters +count as Ledger ``directives'', and are accepted anywhere that ordinary transactions are valid. @node Value Expressions, Format Strings, Time Keeping, Top @@ -7673,7 +7673,7 @@ $ ledger -b "this month" register checking @findex --total @var{VEXPR} Below are the one letter variables available in any value expression. -For the @command{register} and @command{print} commands, these variables +For the @command{register} and @command{print} commands, these variables relate to individual postings, and sometimes the account affected by a posting. For the @command{balance} command, these variables relate to accounts, often with a subtle difference in meaning. The use of each -- cgit v1.2.3 From 77b5d0aee0bb80cc36de37f0e4c42610ee99f790 Mon Sep 17 00:00:00 2001 From: thdox Date: Mon, 22 Dec 2014 09:58:44 +0100 Subject: Indented with Emacs: M-x fill-paragraph --- doc/ledger-mode.texi | 45 ++++----- doc/ledger3.texi | 262 +++++++++++++++++++++++++++------------------------ 2 files changed, 162 insertions(+), 145 deletions(-) (limited to 'doc/ledger-mode.texi') diff --git a/doc/ledger-mode.texi b/doc/ledger-mode.texi index 563abf12..b76cb309 100644 --- a/doc/ledger-mode.texi +++ b/doc/ledger-mode.texi @@ -225,10 +225,10 @@ Emacs will prompt for a report name. There are a few built-in reports, and you can add any report you need @xref{Adding and Editing Reports}. In the Minibuffer type @samp{account}. When prompted for an account -type @samp{checking}. In a buffer named @file{*Ledger Report*}, you will see a Ledger register -report. You can move around the buffer, with the point on a transaction, -type @kbd{RET}. Ledger-mode will take you directly to that -transaction in the @file{demo.ledger} buffer. +type @samp{checking}. In a buffer named @file{*Ledger Report*}, you +will see a Ledger register report. You can move around the buffer, with +the point on a transaction, type @kbd{RET}. Ledger-mode will take you +directly to that transaction in the @file{demo.ledger} buffer. Another built-in report is the balance report. In the @file{demo.ledger} buffer, type @kbd{C-c C-o C-r}. When prompted for @@ -395,10 +395,10 @@ while in a posting. This places an asterisk prior to the posting. @section Formatting Transactions @cindex transaction, formatting -When editing a transaction, liberal use of the @kbd{TAB} key can keep the -transaction well formatted. If you want to have Ledger-mode cleanup the -formatting of a transaction you can use @samp{Align Transaction} or @samp{Align -Region} from the menu bar. +When editing a transaction, liberal use of the @kbd{TAB} key can keep +the transaction well formatted. If you want to have Ledger-mode cleanup +the formatting of a transaction you can use @samp{Align Transaction} or +@samp{Align Region} from the menu bar. The menu item @samp{Clean-up Buffer} sorts all transactions in the buffer by date, removes extraneous empty lines and aligns every transaction. @@ -674,10 +674,10 @@ transactions involving that account. @end table While viewing reports you can easily switch back and forth between the -ledger buffer and the @file{*Ledger Report*} buffer. In @file{*Ledger Report*} buffer, typing -@kbd{RET} will take you to that transaction in the ledger buffer. -While in the ledger buffer @kbd{C-c C-o C-g} returns you to the @file{*Ledger Report*} -buffer. +ledger buffer and the @file{*Ledger Report*} buffer. In @file{*Ledger +Report*} buffer, typing @kbd{RET} will take you to that transaction in +the ledger buffer. While in the ledger buffer @kbd{C-c C-o C-g} returns +you to the @file{*Ledger Report*} buffer. By default Ledger-mode will refresh the report buffer when the ledger buffer is saved. If you want to rerun the report at another time @@ -719,7 +719,8 @@ Deleting reports is accomplished by typing @kbd{C-c C-o C-e} or using customization window for the Ledger Reports variables. Use the widgets to delete the report you want removed. -Typing @kbd{C-c C-o C-s} will prompt for a name and save the current report. +Typing @kbd{C-c C-o C-s} will prompt for a name and save the current +report. @node Expansion Formats, Make Report Transactions Active, Adding and Editing Reports, Adding and Editing Reports @subsection Expansion Formats @@ -824,9 +825,9 @@ characters to specify when the transactions should appear. @node Transactions that occur on specific dates, Transactions that occur on specific days, Specifying Upcoming Transactions, Specifying Upcoming Transactions @subsection Transactions that occur on specific dates -Many times you will enter repetitive transactions that occur on the same day -of the month each month. These can be specified using a wild card in -the year and month with a fixed date in the day. The following entry +Many times you will enter repetitive transactions that occur on the same +day of the month each month. These can be specified using a wild card +in the year and month with a fixed date in the day. The following entry specifies a transaction that occurs on the first and fifteenth of every month in every year. @example @@ -836,9 +837,9 @@ month in every year. @end example Some transactions do not occur every month. Comma separated lists of -the months, or @samp{E} for even, or @samp{O} for odd number months can also be -specified. The following entry specifies a bi-monthly exterminator bill that occurs -in the even months: +the months, or @samp{E} for even, or @samp{O} for odd number months can +also be specified. The following entry specifies a bi-monthly +exterminator bill that occurs in the even months: @example [*/E/01] Exterminator Expenses:Home $100.00 @@ -1016,10 +1017,12 @@ Face for Ledger comments. Default face for uncleared transactions in the @file{*Reconcile*} buffer. @item ledger-font-reconciler-cleared-face -Default face for cleared @samp{*} transactions in the @file{*Reconcile*} buffer. +Default face for cleared @samp{*} transactions in the @file{*Reconcile*} +buffer. @item ledger-font-reconciler-pending-face -Default face for pending @samp{!} transactions in the @file{*Reconcile*} buffer. +Default face for pending @samp{!} transactions in the @file{*Reconcile*} +buffer. @item ledger-font-report-clickable-face FIXME diff --git a/doc/ledger3.texi b/doc/ledger3.texi index 3646557a..739b5539 100644 --- a/doc/ledger3.texi +++ b/doc/ledger3.texi @@ -2023,7 +2023,8 @@ $ ledger accounts >> Accounts.dat @end smallexample @noindent -You will have to edit this file to add the @code{account} directive in front of every line. +You will have to edit this file to add the @code{account} directive in +front of every line. @node Journal Format, Converting from other formats, Keeping it Consistent, Keeping a Journal @section Journal Format @@ -2148,8 +2149,8 @@ account Expenses:Food @end smallexample The @code{note} sub-directive associates a textual note with the -account. This can be accessed later using the @code{note} value expression -function in any account context. +account. This can be accessed later using the @code{note} value +expression function in any account context. The @code{alias} sub-directive, which can occur multiple times, allows the alias to be used in place of the full account name anywhere that @@ -2226,9 +2227,9 @@ $ ledger bal --no-total ^Exp $10.00 Expenses:Entertainment:Dining @end smallexample -With the option @option{--recursive-aliases}, aliases can refer to other aliases, -the following example produces exactly the same transactions and account names -as the preceding one: +With the option @option{--recursive-aliases}, aliases can refer to other +aliases, the following example produces exactly the same transactions +and account names as the preceding one: @smallexample @c input:validate alias Entertainment=Expenses:Entertainment @@ -2316,8 +2317,8 @@ check Start a block comment, closed by @code{end comment}. @item commodity -Pre-declare commodity names. This only has an effect if @option{--strict} -or @option{--pedantic} is used (see below). +Pre-declare commodity names. This only has an effect if +@option{--strict} or @option{--pedantic} is used (see below). @smallexample @c input:validate commodity $ @@ -2344,8 +2345,8 @@ format this commodity. In the future, using this directive will disable Ledger's observation of other ways that commodity is used, and will provide the ``canonical'' representation. -The @code{nomarket} sub-directive states that the commodity's price should -never be auto-downloaded. +The @code{nomarket} sub-directive states that the commodity's price +should never be auto-downloaded. The @code{default} sub-directive marks this as the ``default'' commodity. @@ -2517,8 +2518,8 @@ tag CSV @end smallexample The @code{tag} directive supports two optional sub-directives, if they -immediately follow the tag directive and---if on a successive line---begin -with whitespace: +immediately follow the tag directive and---if on a successive +line---begin with whitespace: @smallexample @c input:validate tag Receipt @@ -2815,9 +2816,9 @@ you a place to put those codes: @findex --uncleared @findex --pending -A transaction can have a ``state'': cleared, pending, or uncleared. -The default is uncleared. To mark a transaction cleared, put an asterisk @samp{*} -before the payee, after the date or code: +A transaction can have a ``state'': cleared, pending, or uncleared. The +default is uncleared. To mark a transaction cleared, put an asterisk +@samp{*} before the payee, after the date or code: @smallexample @c input:validate 2012-03-10 * KFC @@ -2975,9 +2976,10 @@ used as the payee name for that posting. This affects the @command{register} report, the @command{payees} report, and the @option{--by-payee} option. -This is useful when for example you deposit 4 checks at a time to -the bank. On the bank statement, there is just one amount @samp{$400}, -but you can specify from whom each check came from, as shown by example below: +This is useful when for example you deposit 4 checks at a time to the +bank. On the bank statement, there is just one amount @samp{$400}, but +you can specify from whom each check came from, as shown by example +below: @smallexample @c input:validate 2010-06-17 Sample @@ -3138,8 +3140,8 @@ A balance assignment has this form: Assets:Cash = $500.00 @end smallexample -This sets the amount of the second posting to whatever it would need -to be for the total in @samp{Assets:Cash} to be $500.00 after the posting. +This sets the amount of the second posting to whatever it would need to +be for the total in @samp{Assets:Cash} to be $500.00 after the posting. If the resulting amount is not $-20.00 in this case, it is an error. @node Resetting a balance, Balancing transactions, Balance assignments, Balance verification @@ -3174,9 +3176,9 @@ As a consequence of all the above, consider the following transaction: @end smallexample What this says is: set the amount of the posting to whatever value is -needed so that @samp{Assets:Brokerage} contains 10 AAPL. Then, because this -posting must balance, ensure that its value is zero. This can only be -true if Assets:Brokerage does indeed contain 10 AAPL at that point in +needed so that @samp{Assets:Brokerage} contains 10 AAPL. Then, because +this posting must balance, ensure that its value is zero. This can only +be true if Assets:Brokerage does indeed contain 10 AAPL at that point in the input file. A balanced virtual transaction is used simply to indicate to Ledger that @@ -3246,9 +3248,10 @@ Said another way, whenever Ledger sees a posting cost of the form "AMOUNT @@ AMOUNT", the commodity used in the second amount is marked ``primary''. -The only meaning a primary commodity has is that the @option{--market (-V)} -flag will never convert a primary commodity into any other commodity. -@option{--exchange @var{COMMODITY} (-X)} still will, however. +The only meaning a primary commodity has is that the @option{--market +(-V)} flag will never convert a primary commodity into any other +commodity. @option{--exchange @var{COMMODITY} (-X)} still will, +however. @node Posting cost expressions, Total posting costs, Explicit posting costs, Transactions @section Posting cost expressions @@ -3386,12 +3389,12 @@ but is not required to be used with them: @end smallexample It should be noted that this is a convenience only for cases where you -buy and sell whole lots. The @{@{$500.00@}@} is @emph{not} an -attribute of the commodity, whereas @{$5.00@} is. In fact, when you write +buy and sell whole lots. The @{@{$500.00@}@} is @emph{not} an attribute +of the commodity, whereas @{$5.00@} is. In fact, when you write @{@{$500.00@}@}, Ledger just divides that value by 10 and sees @{$50.00@}. So if you use the print command to look at this -transaction, you'll see the single braces form in the output. -The double braces price form is a shorthand only. +transaction, you'll see the single braces form in the output. The +double braces price form is a shorthand only. Plus, it comes with dangers. This works fine: @@ -3522,8 +3525,8 @@ indicate a virtual cost: Income:Capital Gains $-125.00 @end smallexample -You can specify any combination of lot prices, dates or notes, in any order. -They are all optional. +You can specify any combination of lot prices, dates or notes, in any +order. They are all optional. To show all lot information in a report, use @option{--lots}. @@ -3881,8 +3884,8 @@ This entry accomplishes this. Every month you'll see an automatic $37.50 deficit like you should, while your checking account really knows that it debited $225 this month. -And using the @option{--effective} option, the initial date will be overridden -by the effective dates. +And using the @option{--effective} option, the initial date will be +overridden by the effective dates. @smallexample @c command:6453542 $ ledger --effective register Groceries @@ -4401,10 +4404,11 @@ report -J -l "Ua>=@{\$0.01@}" -d "d>=[last feb]" reg ^assets ^liab The last report uses both a calculation predicate @option{--limit @var{EXPR} (-l)} and a display predicate @option{--display @var{EXPR} (-d)}. The calculation predicate limits the report to postings whose -amount is greater than or equal to $1 (which can only happen if the posting amount -is in dollars). The display predicate limits the transactions -@emph{displayed} to just those since last February, even though those -transactions from before will be computed as part of the balance. +amount is greater than or equal to $1 (which can only happen if the +posting amount is in dollars). The display predicate limits the +transactions @emph{displayed} to just those since last February, even +though those transactions from before will be computed as part of the +balance. @node Reporting Commands, Command-line Syntax, Building Reports, Top @chapter Reporting Commands @@ -4449,11 +4453,11 @@ balances for an account, such as when @ref{Archiving Previous Years}. @findex --amount-data @findex --total-data -The @command{register} command displays all the postings occurring -in a single account, line by line. The account regex must be -specified as the only argument to this command. If any regexes occur -after the required account name, the register will contain only those -postings that match, which makes it very useful for hunting down a particular +The @command{register} command displays all the postings occurring in +a single account, line by line. The account regex must be specified as +the only argument to this command. If any regexes occur after the +required account name, the register will contain only those postings +that match, which makes it very useful for hunting down a particular posting. The output from @command{register} is very close to what a typical @@ -4465,8 +4469,8 @@ If you have ``Gnuplot'' installed, you may plot the amount or running total of any register by using the script @file{report}, which is included in the Ledger distribution. The only requirement is that you add either @option{--amount-data (-j)} or @option{--total-data (-J)} to -your @command{register} command, in order to plot either the amount or total -column, respectively. +your @command{register} command, in order to plot either the amount or +total column, respectively. @node The @command{print} command, , The @command{register} command, Primary Financial Reports @subsection The @command{print} command @@ -4547,9 +4551,10 @@ Transaction Number,Date,Description,Memo,Amount Debit,Amount Credit,Balance,Chec Unfortunately, as it stands Ledger cannot read it, but you can. Ledger expects the first line to contain a description of the fields on each -line of the file. The fields ledger can recognize contain these case-insensitive strings -@code{date}, @code{posted}, @code{code}, @code{payee} or @code{desc} or @code{description}, -@code{amount}, @code{cost}, @code{total}, and @code{note}. +line of the file. The fields ledger can recognize contain these +case-insensitive strings @code{date}, @code{posted}, @code{code}, +@code{payee} or @code{desc} or @code{description}, @code{amount}, +@code{cost}, @code{total}, and @code{note}. Delete the account description lines at the top, and replace the first line in the data above with: @@ -5194,18 +5199,20 @@ pricedb database files. @subsection @command{accounts} @findex accounts -The @command{accounts} command reports all of the accounts in the journal. -Following the command with a regular expression will limit the output to -accounts matching the regex. The output is sorted by name. Using the -@option{--count} option will tell you how many entries use each account. +The @command{accounts} command reports all of the accounts in the +journal. Following the command with a regular expression will limit the +output to accounts matching the regex. The output is sorted by name. +Using the @option{--count} option will tell you how many entries use +each account. @node @command{payees}, @command{commodities}, @command{accounts}, Reports about your Journals @subsection @command{payees} @findex payees -The @command{payees} command reports all of the unique payees in the journal. -Using the @option{--count} option will tell you how many entries use -each payee. To filter the payees displayed you must use the prefix @@: +The @command{payees} command reports all of the unique payees in the +journal. Using the @option{--count} option will tell you how many +entries use each payee. To filter the payees displayed you must use the +prefix @@: @smallexample $ ledger payees @@Nic @@ -5228,10 +5235,10 @@ you how many entries use each commodity. @findex tags @findex --values -The @command{tags} command reports all of the tags in the journal. The output -is sorted by name. Using the @option{--count} option will tell you how -many entries use each tag. Using the @option{--values} option will -report the values used by each tag. +The @command{tags} command reports all of the tags in the journal. The +output is sorted by name. Using the @option{--count} option will tell +you how many entries use each tag. Using the @option{--values} option +will report the values used by each tag. @node @command{xact}, @command{stats}, @command{tags}, Reports about your Journals @subsection @command{xact} @@ -5405,7 +5412,8 @@ Print account balances as transactions. Print price history for matching commodities. @item pricedb -Print price history for matching commodities in a format readable by ledger. +Print price history for matching commodities in a format readable by +ledger. @item xact Generate transactions based on previous postings. @@ -5933,9 +5941,9 @@ a misspelled commodity or account) it will issue a warning giving you the file and line number of the problem. @item --recursive-aliases -Normally, ledger only expands aliases once. With this option, ledger tries -to expand the result of alias expansion recursively, until no more expansions -apply. +Normally, ledger only expands aliases once. With this option, ledger +tries to expand the result of alias expansion recursively, until no more +expansions apply. @item --time-colon The @option{--time-colon} option will display the value for a seconds @@ -6225,8 +6233,8 @@ in the register and prices reports. Display only lines that satisfy the expression @var{EXPR}. @item --display-amount @var{EXPR} -Apply a transformation to the @emph{displayed} amount. This happens after -calculations occur. +Apply a transformation to the @emph{displayed} amount. This happens +after calculations occur. @item --display-total @var{EXPR} Apply a transformation to the @emph{displayed} total. This happens after @@ -6312,8 +6320,8 @@ or @code{commodity}. The @code{tags()} function is also useful here. @item --group-title-format @var{FORMAT_STRING} Set the format for the headers that separates the report sections of -a grouped report. Only has an effect with a @option{--group-by @var{EXPR}} -register report. +a grouped report. Only has an effect with a @option{--group-by +@var{EXPR}} register report. @smallexample $ ledger reg Expenses --group-by "payee" --group-title-format "------------------------ %-20(value) ---------------------\n" @@ -6509,10 +6517,10 @@ Report commodity totals (this is the default). Synonym for @samp{--period "quarterly"}. @item --raw -In the @command{print} report, show transactions using the exact same syntax as -specified by the user in their data file. Don't do any massaging or -interpreting. This can be useful for minor cleanups, like just aligning -amounts. +In the @command{print} report, show transactions using the exact same +syntax as specified by the user in their data file. Don't do any +massaging or interpreting. This can be useful for minor cleanups, like +just aligning amounts. @item --real @itemx -R @@ -6523,8 +6531,8 @@ transactions. Define the output format for the @command{register} report. @item --related -In a @command{register} report show the related account. This is the other -@emph{side} of the transaction. +In a @command{register} report show the related account. This is the +other @emph{side} of the transaction. @item --related-all Show all postings in a transaction, similar to @option{--related} but @@ -6544,12 +6552,13 @@ FIX THIS ENTRY FIX THIS ENTRY @c FIXME thdox @item --seed @var{FIXME} -Set the random seed to @var{FIXME} for the @code{generate} command. Used as part of -development testing. +Set the random seed to @var{FIXME} for the @code{generate} command. +Used as part of development testing. @item --sort @var{VEXPR} @itemx -S @var{VEXPR} -Sort the @command{register} report based on the value expression given to sort. +Sort the @command{register} report based on the value expression given +to sort. @item --sort-all @var{FIXME} FIX THIS ENTRY @@ -6569,8 +6578,8 @@ FIX THIS ENTRY @item --tail @var{INT} @itemx --last @var{INT} -Report only the last @var{INT} entries. Only useful in a @command{register} -report. +Report only the last @var{INT} entries. Only useful in +a @command{register} report. @item --time-report FIX THIS ENTRY @c FIXME thdox @@ -6722,8 +6731,8 @@ Set the reporting period to @var{STR}. This will subtotal all matching transactions within each period separately, making it easy to see weekly, monthly, quarterly, etc., posting totals. A period string can even specify the beginning and end of the report range, using simple -terms like @samp{last June} or @samp{next month}. For more details on period -expressions, see @ref{Period Expressions}. +terms like @samp{last June} or @samp{next month}. For more details on +period expressions, see @ref{Period Expressions}. @item --period-sort @var{VEXPR} Sort the postings within each reporting period using the value @@ -6894,7 +6903,8 @@ Report posting totals by month. @item --yearly @itemx -Y -Report posting totals by year. For more complex periods, use @option{--period}. +Report posting totals by year. For more complex periods, use +@option{--period}. @c TODO end this sentence @item --period @var{PERIOD_EXPRESSION} @@ -6907,10 +6917,10 @@ to see if weekend spending is more than on weekdays. @item --sort @var{VEXPR} @itemx -S @var{VEXPR} Sort a report by comparing the values determined using the value -expression @var{VEXPR}. For example, using @samp{-S "-abs(total)"} in the -@command{balance} report will sort account balances from greatest to least, -using the absolute value of the total. For more on how to use value expressions, -see @ref{Value Expressions}. +expression @var{VEXPR}. For example, using @samp{-S "-abs(total)"} in +the @command{balance} report will sort account balances from greatest to +least, using the absolute value of the total. For more on how to use +value expressions, see @ref{Value Expressions}. @item --pivot @var{TAG} Produce a pivot table around the @var{TAG} provided. This requires @@ -7334,13 +7344,14 @@ these values: @itemize @item Register Report -For the @command{register} report, use the value of that commodity on the date of -the posting being reported, with a @samp{} posting added at -the end if today's value is different from the value of the last -posting. +For the @command{register} report, use the value of that commodity on +the date of the posting being reported, with a @samp{} posting +added at the end if today's value is different from the value of the +last posting. @item Balance Report -For the @command{balance} report, use the value of that commodity as of today. +For the @command{balance} report, use the value of that commodity as of +today. @end itemize @@ -7353,16 +7364,16 @@ You can also now use @option{--exchange @var{COMMODITY} (-X)} (and and @option{--price (-I)}, to see valuation reports of just your basis costs or lot prices. -Finally, sometimes, you may seek to only report one (or some subset) -of the commodities in terms of another commodity. In this -situation, you can use the syntax -@option{--exchange @var{COMMODITY1}:@var{COMMODITY2}} to request that -ledger always display @var{COMMODITY1} in terms of @var{COMMODITY2}, -but you want no other commodities to be automatically displayed in terms of -@var{COMMODITY2} without additional @option{--exchange} options. For -example, if you wanted to report EUR and BTC in terms of USD, but report -all other commodities without conversion to USD, you could use: -@option{--exchange EUR:USD --exchange BTC:USD}. +Finally, sometimes, you may seek to only report one (or some subset) of +the commodities in terms of another commodity. In this situation, you +can use the syntax @option{--exchange @var{COMMODITY1}:@var{COMMODITY2}} +to request that ledger always display @var{COMMODITY1} in terms of +@var{COMMODITY2}, but you want no other commodities to be automatically +displayed in terms of @var{COMMODITY2} without additional +@option{--exchange} options. For example, if you wanted to report EUR +and BTC in terms of USD, but report all other commodities without +conversion to USD, you could use: @option{--exchange EUR:USD --exchange +BTC:USD}. @node Environment variables, , Commodity reporting, Detailed Option Description @subsection Environment variables @@ -7584,10 +7595,10 @@ o 2013/03/29 03:39:00 This records a check-in to the given ACCOUNT, and a check-out. You can be checked-in to multiple accounts at a time, if you wish, and they can span multiple days (use @option{--day-break} to break them up in the -report). The number of seconds between check-in and check-out is accumulated -as time to that ACCOUNT. If the checkout uses a capital @samp{O}, the -transaction is marked ``cleared''. You can use an optional PAYEE for -whatever meaning you like. +report). The number of seconds between check-in and check-out is +accumulated as time to that ACCOUNT. If the checkout uses a capital +@samp{O}, the transaction is marked ``cleared''. You can use an +optional PAYEE for whatever meaning you like. Now, there are a few ways to generate this information. You can use the @file{timeclock.el} package, which is part of Emacs. Or you can @@ -7683,10 +7694,11 @@ variable for both is specified. @item t This maps to whatever the user specified with @option{--amount -@var{EXPR} (-t)}. In a @command{register} report, @option{--amount @var{EXPR} -(-t)} changes the value column; in a @command{balance} report, it has no meaning -by default. If @option{--amount @var{EXPR} (-t)} was not specified, the -current report style's value expression is used. +@var{EXPR} (-t)}. In a @command{register} report, @option{--amount +@var{EXPR} (-t)} changes the value column; in a @command{balance} +report, it has no meaning by default. If @option{--amount @var{EXPR} +(-t)} was not specified, the current report style's value expression is +used. @item T This maps to whatever the user specified with @option{--total @@ -7880,9 +7892,10 @@ Useful for specifying a date in plain terms. For example, you could say @samp{expr date =~ /2014/}. @item expr comment =~ /REGEX/ -A regular expression that matches against a posting's comment field. This -searches only a posting's field, not the transaction's note or comment field. -For example, @code{ledger reg "expr" "comment =~ /landline/"} will match: +A regular expression that matches against a posting's comment +field. This searches only a posting's field, not the transaction's note +or comment field. For example, @code{ledger reg "expr" "comment =~ +/landline/"} will match: @smallexample 2014/1/29 Phone bill @@ -7905,8 +7918,8 @@ instead. @item expr note =~ /REGEX/ A regular expression that matches against a transaction's note field. This searches all comments in the transaction, including comments on -individual postings. Thus, @samp{ledger reg "expr" "note =~ /landline/"} will -match both all the three examples below: +individual postings. Thus, @samp{ledger reg "expr" "note =~ /landline/"} +will match both all the three examples below: @smallexample 2014/1/29 Phone bill @@ -8509,7 +8522,8 @@ generated the posting. @table @code @item filename -the name of ledger the data file from whence the posting came, abbreviated @samp{S}. +the name of ledger the data file from whence the posting came, +abbreviated @samp{S}. @item beg_pos character position in @code{filename} where entry for posting begins, @@ -8815,10 +8829,10 @@ querying ad reporting on your data. @item Textual journal parser -There is a textual parser, wholly contained in @file{textual.cc}, which knows -how to parse text into journal objects, which then get ``finalized'' and -added to the journal. Finalization is the step that enforces the -double-entry guarantee. +There is a textual parser, wholly contained in @file{textual.cc}, which +knows how to parse text into journal objects, which then get +``finalized'' and added to the journal. Finalization is the step that +enforces the double-entry guarantee. @item Iterators @@ -8836,8 +8850,8 @@ the user passed to @option{--sort @var{VEXPR}}. Many reports bring pseudo-journal objects into existence, like postings which report totals in a @samp{Total} account. These objects are -created and managed by a @code{temporaries_t} object, which gets used in many -places by the reporting filters. +created and managed by a @code{temporaries_t} object, which gets used in +many places by the reporting filters. @item Option handling @@ -9296,8 +9310,8 @@ Print detailed information on the execution of Ledger. @item --verify Enable additional assertions during run-time. This causes a significant -slowdown. When combined with @option{--debug @var{CODE}} ledger will produce -memory trace information. +slowdown. When combined with @option{--debug @var{CODE}} ledger will +produce memory trace information. @item --verify-memory FIX THIS ENTRY @c FIXME thdox @@ -9401,8 +9415,8 @@ true FIX THIS ENTRY @c FIXME thdox @item template -Shows the insertion template that the @command{xact} sub-command generates. -This is a debugging command. +Shows the insertion template that the @command{xact} sub-command +generates. This is a debugging command. @end ftable -- cgit v1.2.3