diff options
Diffstat (limited to 'doc/ledger.1')
| -rw-r--r-- | doc/ledger.1 | 907 |
1 files changed, 580 insertions, 327 deletions
diff --git a/doc/ledger.1 b/doc/ledger.1 index fb434880..67c24470 100644 --- a/doc/ledger.1 +++ b/doc/ledger.1 @@ -5,17 +5,19 @@ .Nm ledger .Nd Command-line, double-entry account reporting tool .Sh SYNOPSIS -ledger +.Nm .Op Ar command .Op Ar options .Op Ar arguments .Sh DESCRIPTION -Ledger is a command-line accounting tool based on the power and completeness +.Nm +is a command-line accounting tool based on the power and completeness of double-entry accounting. It is only a reporting tool, which means it never -modifies your data files, but it does offers a large selection of reports, and -different ways to customize them to your liking. +modifies your data files, but it does offer a large selection of reports, and +different ways to customize them to your needs. .Sh COMMANDS -Ledger accepts several top-level commands, each of which generates a different +.Nm +accepts several top-level commands, each of which generates a different kind of basic report. Most of them accept a .Ar report-query argument, in order to determine what should be reported. To understand the @@ -26,21 +28,24 @@ see the section on In its most basic form, simply specifying one or more strings produces a report for all accounts containing those strings. .Pp -If no command is given, Ledger enters a +If no command is given, +.Nm +enters a .Tn REPL , -or command loop, allowing several commands to be executed against the same +or command loop, allowing several commands to be executed on the same dataset without reparsing. .Pp -The following is a complete list of reporting commands accepted by Ledger: +The following is a complete list of accepted reporting commands: .Bl -tag -width accounts -.It Nm accounts Oo Ar report-query Oc -Lists all accounts for postings matching the +.It Ic accounts Oo Ar report-query Oc +List all accounts for postings that match the .Ar report-query . .El .Bl -tag -width balance -.It Nm balance Oo Ar report-query Oc -Produces a balance report showing totals for all matching accounts, and -aggregate totals for parents of those accounts. Options most commonly used +.It Ic balance Oo Ar report-query Oc +Print a balance report showing totals for postings that match +.Ar report-query , +and aggregate totals for parents of those accounts. Options most commonly used with this command are: .Bl -tag -compact -width "--collapse (-n)" .It Fl \-basis Pq Fl B @@ -50,21 +55,21 @@ report which is guaranteed to always balance to zero, when no is specified. Only show totals for the top-most accounts. .It Fl \-empty Pq Fl E -Also show accounts whose total is zero. +Show accounts whose total is zero. .It Fl \-flat Rather than display a hierarchical tree, flatten the report to show subtotals for only accounts matching .Ar report-query . .It Fl \-no-total -Suppress the summary total shown at the bottom of the report (when not zero). +Suppress the summary total shown at the bottom of the report. .El .Pp The synonyms -.Nm bal +.Ic bal and -.Nm b +.Ic b are also accepted. -.It Nm budget Oo Ar report-query Oc +.It Ic budget Oo Ar report-query Oc A special balance report which includes three extra columns: the amount budgeted during the reporting period, how spending differed from the budget, and the percentage of budget spent (exceeds 100% if you go over budget). @@ -73,24 +78,27 @@ Note that budgeting requires one or more periodic transactions .Dc to be defined in your data file(s). See the manual for more information. -.It Nm cleared Oo Ar report-query Oc +.It Ic cleared Oo Ar report-query Oc A special balance report which adds two extra columns: the cleared balance for each account, and the date of the most recent cleared posting in that account. For this accounting to be meaningful, the cleared flag must be set on at least one posting. See the manual for more information. -.It Nm commodities Oo Ar report-query Oc -Lists all commodities for postings matching the +.It Ic commodities Oo Ar report-query Oc +List all commodities for postings matching the .Ar report-query . -.It Nm convert -Reads data from a CSV (comma-separated values) file and generates Ledger +.It Ic convert +Reads data from a CSV (comma-separated values) file and generates +.Nm transactions. -.It Nm csv Oo Ar report-query Oc +.It Ic csv Oo Ar report-query Oc Report of postings matching the .Ar report-query in CSV format (comma-separated values). Useful for exporting data to a spreadsheet for further analysis or charting. -.It Nm entry Oo Ar entry-template Oc -Generate and display a new, properly formatted Ledger transaction by comparing +.It Ic entry Oo Ar entry-template Oc +Generate and display a new, properly formatted +.Nm +transaction by comparing the .Ar entry-template to the transactions in your data file(s). For more information on draft @@ -99,53 +107,63 @@ section .Sx ENTRIES . .Pp The synonym -.Nm xact +.Ic xact is also accepted. -.It Nm emacs Oo Ar query Oc -Outputs posting and transaction data in a format readily consumed by the Emacs +.It Ic emacs Oo Ar query Oc +Output posting and transaction data in a format readily consumed by the Emacs editor, in a series of Lisp forms. This is used by the -.Li ledger.el -Emacs mode to process reporting data from Ledger. -.It Nm equity Oo Ar report-query Oc -Prints a series of transactions that balance current totals for +.Pa ledger.el +Emacs mode to process reporting data from +.Nm . +.It Ic equity Oo Ar report-query Oc +Print a transaction with a series of postings that balance current totals for accounts matching the .Ar report-query in a special account called .Li Equity:Opening Balances . The purpose of this report is to close the books for a prior year, while using -these equity transactions to carry forward those balances. -.It Nm org -Produces a journal file suitable for use in the Emacs org mode. -.It Nm payees Oo Ar report-query Oc -Lists all payees for postings matching the +these equity postings to carry forward those balances. +.It Ic org +Produce a journal file suitable for use in the Emacs org mode. +.It Ic payees Oo Ar report-query Oc +List all payees for postings matching the .Ar report-query . -.It Nm pricemap -Produces a file which can be used to generate a graph with graphviz showing -the relationship of commodities in the Ledger file. -.It Nm prices Oo Ar report-query Oc -Reports prices for all commodities in postings matching the +.It Ic pricemap +Produce a file which can be used to generate a graph with graphviz showing +the relationship of commodities in the +.Nm +file. +.It Ic prices Oo Ar report-query Oc +Report prices for all commodities in postings matching the .Ar report-query . The prices are reported with the granularity of a single day. -.It Nm pricedb Oo Ar report-query Oc -Reports prices for all commodities in postings matching the +.It Ic pricedb Oo Ar report-query Oc +Report prices for all commodities in postings matching the .Ar report-query . Prices are reported down to the second, using the same format as the -.Li ~/.pricedb +.Pa ~/.pricedb file. -.It Nm print Oo Ar report-query Oc -Prints out the full transactions of any matching postings using the same +.It Ic print Oo Ar report-query Oc +Print out the full transactions of any matching postings using the same format as they would appear in a data file. This can be used to extract -subsets from a Ledger file to transfer to other files. -.It Nm push Oo Ar options Oc +subsets from a +.Nm +file to transfer to other files. +.It Ic push Oo Ar options Oc In the .Tn REPL , -this command pushes a set of command-line options, so that they will apply to -all subsequent reports. -.It Nm pop +push a set of command-line +.Ar options , +so that they will apply to all subsequent reports. +.It Ic pop In the .Tn REPL , -pops any option settings that have been pushed. -.It Nm register Oo Ar report-query Oc +pop any option settings that have been +.Sm off +.Ic push +ed. +.Sm on +.It Ic register Oo Ar report-query Oc List all postings matching the .Ar report-query . This is one of the most common commands, and can be used to provide a variety @@ -162,10 +180,10 @@ Render all values in the given .Ar commodity , if a price conversion rate can be determined. Rates are always displayed relative to the date of the posting they are calculated for. This means a -.Nm register +.Ic register report is a historical value report. For current values, it may be preferable to use the -.Nm balance +.Ic balance report. .It Fl \-gain Pq Fl G Show any gains (or losses) in commodity values over time. @@ -179,24 +197,23 @@ Invert the value of amounts shown. .It Fl \-market Pq Fl V Show current market values for all amounts. This is determined in a somewhat magical fashion. It is probably more straightforward to use -.Fl \-exchange Ar commodity Pq Fl X . +.Fl \-exchange +option. .It Fl \-period Ar time-period Pq Fl p Show postings only for the given .Ar time-period . .It Fl \-related Pq Fl r Show postings that are related to those that would have been shown. It has the effect of displaying the -.Do -other side -.Dc -of the values. +.Qq other side +of the postings. .It Fl \-sort Ar value-expression Pq Fl S Sort postings by evaluating the given .Ar value-expression . Note that a comma-separated list of expressions is allowed, in which case each sorting term is used in order to determine the final ordering. For example, to search by date and then amount, one would use: -.Li -S 'date, amount' . +.Dl ledger reg --sort 'date, amount' .It Fl \-tail Ar number Only show the last .Ar number @@ -223,33 +240,37 @@ Group postings by month. Group postings by fiscal quarter. .It Fl \-yearly Pq Fl Y Group postings by year. -.It Fl \-dow +.It Fl \-days-of-week Group postings by the day of the week on which they took place. .It Fl \-subtotal Pq Fl s Group all postings together. This is very similar to the totals shown by the -.Nm balance +.Ic balance report. .El .Pp The synonyms -.Nm reg +.Ic reg and -.Nm r +.Ic r are also accepted. -.It Nm server +.It Ic server This command requires that Python support be active. If so, it starts up an -HTTP server listening for requests on port 9000. This provides an alternate +.Tn HTTP +server listening for requests on port 9000. This provides an alternate interface to creating and viewing reports. Note that this is very much a work-in-progress, and will not be fully functional until a later version. -.It Nm select Oo Ar sql-query Oc +.It Ic select Oo Ar sql-query Oc List all postings matching the .Ar sql-query . -This command allows to generate SQL-like queries. -.It Nm source -Parses a journal file and checks it for errors. Ledger will return success +This command allows to generate SQL-like queries, e.g.: +.Dl Li ledger select date,amount from posts where account=~/Income/ +.It Ic source +Parse a journal file and checks it for errors. +.Nm +will return success if no errors are found. -.It Nm stats Oo Ar report-query Oc -Provides summary information about all the postings matching +.It Ic stats Oo Ar report-query Oc +Provide summary information about all the postings matching .Ar report-query . It provides information such as: .Bl -bullet -offset indent -compact @@ -266,10 +287,16 @@ Uncleared postings .It Days since last posting .It -More... +Posts in the last 7 days +.It +Posts in the last 30 days +.It +Posts this month .El -.It Nm xml Oo Ar report-query Oc -Outputs data relating to the current report in XML format. It includes all +.It Ic xml Oo Ar report-query Oc +Output data relating to the current report in +.Tn XML +format. It includes all accounts and commodities involved in the report, plus the postings and the transactions they are contained in. See the manual for more information. .El @@ -278,7 +305,7 @@ transactions they are contained in. See the manual for more information. .It Fl \-abbrev-len Ar INT Set the minimum length an account can be abbreviated to if it doesn't fit inside the -.Nm account-width . +.Sy account-width . If .Ar INT is zero, then the @@ -286,21 +313,28 @@ account name will be truncated on the right. If .Ar INT is greater than -.Nm account-width +.Sy account-width then the account will be truncated on the left, with no shortening of the account names in order to fit into the desired width. -.It Fl \-account Ar STR +.It Fl \-account Ar EXPR Prepend -.Ar STR +.Ar EXPR to all accounts reported. That is, the option -.Nm --account Personal +.Fl \-account Ar \*q'Personal'\*q would tack -.Nm Personal: -to the beginning of every account reported in a balance report or register report. +.Ar Personal: +and +.Fl \-account Ar \*qtag('VAT')\*q +would tack the value of the VAT tag to the beginning of every account +reported in a +.Ic balance +or +.Ic register +report. .It Fl \-account-width Ar INT Set the width of the account column in the -.Nm register +.Ic register report to .Ar INT @@ -312,7 +346,7 @@ transactions used. Show only un-budgeted postings. .It Fl \-amount Ar EXPR Pq Fl t Apply the given value expression to the posting amount. Using -.Nm --amount Ar EXPR +.Fl \-amount Ar EXPR you can apply an arbitrary transformation to the postings. .It Fl \-amount-data Pq Fl j @@ -320,12 +354,18 @@ On a register report print only the dates and amount of postings. Useful for graphing and spreadsheet applications. .It Fl \-amount-width Ar INT Set the width in characters of the amount column in the -.Nm register +.Ic register report. .It Fl \-anon Anonymize registry output, mostly for sending in bug reports. +.It Fl \-ansi +Use color if the terminal supports it. +Alias for +.Fl \-color .It Fl \-args-only -Ignore init files and environment variables for the ledger run. +Ignore init files and environment variables for the +.Nm +run. .\".It Fl \-auto-match .It Fl \-aux-date Show auxiliary dates for all calculations. @@ -336,7 +376,7 @@ Print average values over the number of transactions instead of running totals. .It Fl \-balance-format Ar FMT Specify the format to use for the -.Nm balance +.Ic balance report. .\".It Fl \-base .It Fl \-basis Pq Fl B @@ -351,12 +391,13 @@ that date will be ignored. .It Fl \-bold-if Ar EXPR Print the entire line in bold if the given value expression is true. .It Fl \-budget -Only display budgeted items. In a register report this -displays transaction in the budget, in a balance report this displays -accounts in the budget. +Only display budgeted items. In a +.Ic register +report this displays transaction in the budget, in a balance report this +displays accounts in the budget. .It Fl \-budget-format Ar FMT Specify the format to use for the -.Nm budget +.Ic budget report. .It Fl \-by-payee Pq Fl P Group postings in the register report by common payee names. @@ -368,12 +409,10 @@ commodities and tags. Display only cleared postings. .It Fl \-cleared-format Ar FMT Specify the format to use for the -.Nm cleared +.Ic cleared report .It Fl \-collapse Pq Fl n -By default ledger prints all accounts in an account tree. With -.Fl \-collapse -it prints only the top level account specified. +Print only the top level accounts. .It Fl \-collapse-if-zero Collapse the account display only if it has a zero balance. .It Fl \-color @@ -381,95 +420,125 @@ Use color if the terminal supports it. Alias for .Fl \-ansi .It Fl \-columns Ar INT -Specify the width of the -.Nm register -report in characters. +Make the +.Ic register +report +.Ar INT +characters wide. By default +.Nm +will use all available columns in your terminal. .It Fl \-cost Report the cost basis on all posting. Alias for .Fl \-basis . .It Fl \-count -Direct ledger to report the number of items when appended to the -.Nm commodities , -.Nm accounts +Direct +.Nm +to report the number of items when appended to the +.Ic commodities , +.Ic accounts or -.Nm payees +.Ic payees commands. .It Fl \-csv-format Ar FMT -Specify the format to use for the -.Nm csv +Format +.Ic csv report +according to +.Ar FMT . .It Fl \-current Pq Fl c Shorthand for .Fl \-limit Ar "'date <= today'" . .It Fl \-daily Pq Fl D Shorthand for -.Fl \-period Ar "daily" . +.Fl \-period Ar daily . .It Fl \-date Ar EXPR Transform the date of the transaction using .Ar EXPR . .It Fl \-date-format Ar DATEFMT Pq Fl y -Specify the format ledger should use to print dates. +Print dates using +.Ar DATEFMT . +Refer to +.Xr strftime 3 +for details on the format string syntax. .\" .It Fl \-datetime-format Ar FMT .It Fl \-date-width Ar INT Specify the width, in characters, of the date column in the -.Nm register +.Ic register report. -.\".It Fl \-day-break +.It Fl \-day-break +Break up +.Ic register +report of timelog entries that span multiple days by day. +.It Fl \-days-of-week +Group transactions by the days of the week. +Alias for +.Fl \-dow . .It Fl \-dc Display register or balance in debit/credit format If you use .Fl \-dc -with either the register (reg) or balance (bal) commands, -you will now get separate columns for debits and credits. +with either the +.Ic register +or +.Ic balance +commands, you will now get separate columns for debits and credits. .It Fl \-debug Ar STR -If Ledger has been built with debug options this will provide extra +If +.Nm +has been built with debug options this will provide extra data during the run. .It Fl \-decimal-comma -Direct Ledger to parse journals using the European standard comma as +Direct +.Nm +to parse journals using the European standard comma as decimal separator, vice a period. .It Fl \-depth Ar INT Limit the depth of the account tree. In a balance report, for example, -a -.Fl \-depth 2 -statement will print balances only for account with -two levels, i.e. -.Nm Expenses:Entertainment +.Fl \-depth Ar 2 +will print balances only for accounts with two levels, i.e. +.Sy Expenses:Entertainment but not -.Nm Expenses:entertainment:Dining . -This is a display predicate, which -means it only affects display, not the total calculations. -.It Fl \-deviation Pq Fl D -Report each posting’s deviation from the average. It is only meaningful -in the register and prices reports. +.Sy Expenses:Entertainment:Dining . +This is a display predicate, which means it only affects display, +not the total calculations. +.It Fl \-deviation +Report each posting's deviation from the average. It is only meaningful +in the +.Ic register No and Ic prices +reports. .It Fl \-display Ar EXPR Pq Fl d Display lines that satisfy the expression .Ar EXPR . .It Fl \-display-amount Ar EXPR Apply a transformation to the -.Nm displayed +.Em displayed amount. This occurs after calculations occur. .It Fl \-display-total Ar EXPR Apply a transformation to the -.Nm displayed +.Em displayed total. This occurs after calculations occur. .It Fl \-dow Group transactions by the days of the week. Alias for -.Fl \-days-of-week +.Fl \-days-of-week . .It Fl \-download Cause quotes to be automagically downloaded, as needed, by running a script named -.Nm getquote +.Em getquote and expecting that script to return -a value understood by ledger. A sample implementation of -a -.Nm getquote +a value understood by +.Nm . +A sample implementation of a +.Em getquote script, implemented in Perl, is provided in the distribution. Downloaded quote price are then appended to the price database, usually specified using the environment variable -.Nm LEDGER_PRICE_DB . +.Ev LEDGER_PRICE_DB . +.It Fl \-effective +Show auxiliary dates for all calculations. Alias for +.Fl \-aux-date . .It Fl \-empty Pq Fl E Include empty accounts in report. .It Fl \-end Ar DATE Pq Fl e @@ -479,25 +548,24 @@ for a transaction to be considered in the report. .It Fl \-equity Related to the -.Nm equity +.Ic equity command. Gives current account balances in the form of a register report. .\".It Fl \-exact -.It Fl \-exchange Ar COMMODITY Oo , COMM, ... Oc Pq Fl X +.It Fl \-exchange Ar COMMODITY Oo , Ar COMMODITY, ... Oc Pq Fl X Display values in terms of the given .Ar COMMODITY . The latest available price is used. .\".It Fl \-explicit .It Fl \-file Ar FILE -Read -.Ar FILE -as a ledger file. +Read journal data from +.Ar FILE . .\".It Fl \-full-help .It Fl \-first Ar INT Print the first .Ar INT entries. Opposite of -.Fl \-tail Ar INT . +.Fl \-last Ar INT . Alias for .Fl \-head . .It Fl \-flat @@ -507,7 +575,9 @@ balance report will not use an indented tree. Output TTY color codes even if the TTY doesn't support them. Useful for TTYs that don't advertise their capabilities correctly. .It Fl \-force-pager -Force Ledger to paginate its output. +Force +.Nm +to paginate its output. .It Fl \-forecast-while Ar EXPR Continue forecasting while .Ar VEXPR @@ -530,15 +600,15 @@ transactions) in the report, in cases where you normally wouldn't want them. .It Fl \-group-by Ar EXPR Group transaction together in the -.Nm register +.Ic register report. .Ar EXPR can be anything, although most common would be -.Nm payee +.Ar payee or -.Nm commodity . +.Ar commodity . The -.Nm tags() +.Fn tag function is also useful here. .It Fl \-group-title-format Ar FMT Set the format for the headers that separate reports section of @@ -555,17 +625,21 @@ Alias for .It Fl \-help Print a summary of all the options, and what they are used for. This can be a handy way to remember which options do what. This help screen -is also printed if ledger is run without a command. +is also printed if +.Nm +is run without a command. .\".It Fl \-help-calc .\".It Fl \-help-comm .\".It Fl \-help-disp .It Fl \-immediate -Instruct ledger to evaluate calculations immediately rather than lazily. +Evaluate calculations immediately rather than lazily. .\".It Fl \-import .It Fl \-init-file Ar FILE Pq Fl i -Causes -.Nm FILE -to be read by ledger before any other ledger file. +Read +.Ar FILE +before any other +.Nm +file. This file may not contain any postings, but it may contain option settings. To specify options in the init file, use the same syntax as the command-line, but put each option on its own line. @@ -574,17 +648,19 @@ Use .Ar STR amounts in calculations. In case you know what amount a transaction should be, but the actual transaction has the -wrong value you can use metadata STR to specify the expected amount. +wrong value you can use metadata +.Ar STR +to specify the expected amount. .It Fl \-input-date-format Ar DATEFMT Specify the input date format for journal entries. .It Fl \-invert Change the sign of all reported values. -.It Fl \-last Ar INT +.It Fl \-last Ar INT . Report only the last .Ar INT -entries. Only useful on a register -report. -Alias for +entries. Opposite of +.Fl \-first Ar INT . +Only useful on a register report. Alias for .Fl \-tail . .It Fl \-leeway Ar INT Pq Fl Z Alias for @@ -608,27 +684,28 @@ Use the latest market value for all commodities. .It Fl \-master-account Ar STR Prepend all account names with .Ar STR -.It Fl \-meta Ar EXPR +.It Fl \-meta Ar STR In the register report, prepend the transaction with the value of the given -.Ar TAG . +tag +.Ar STR . .It Fl \-meta-width Ar INT Specify the width of the Meta column used for the .Fl \-meta Ar TAG options. .It Fl \-monthly Pq Fl M Shorthand for -.Fl \-period Ar "monthly" . +.Fl \-period Ar monthly . .It Fl \-no-aliases Aliases are completely ignored. .It Fl \-no-color Suppress any color TTY output. -.\".It Fl \-no-pager -Suppress any color TTY output. +.It Fl \-no-pager +Disables the pager on TTY output. .It Fl \-no-rounding Don't output -.Nm <Rounding> +.Qq Li <Rounding> postings. Note that this will cause the -running total to often not add up! It's main use is for +running total to often not add up! Its main use is for .Fl \-amount-data Pq Fl j and .Fl \-total-data Pq Fl J @@ -638,24 +715,35 @@ Suppress the output of group titles. .It Fl \-no-total Suppress printing the final total line in a balance report. .It Fl \-now Ar DATE -Define the current date in case to you to do calculate in the past or -future using -.Fl \-current . +Use +.Ar DATE +as the current date. This affects the output when using +.Fl \-period , +.Fl \-begin , +.Fl \-end , +or +.Fl \-current +to decide which dates lie in the past or future. .It Fl \-only Ar EXPR This is a postings predicate that applies after certain transforms have been executed, such as periodic gathering. .It Fl \-options -Display the options in effect for this Ledger invocation, along with +Display the options in effect for this +.Nm +invocation, along with their values and the source of those values. .It Fl \-output Ar FILE Pq Fl o -Redirect the output of ledger to the file defined in +Redirect the output of +.Nm +to .Ar FILE . .It Fl \-pager Ar STR -Specify the pager program to use as -.Ar STR . +Use +.Ar STR +as the pager program. .It Fl \-payee Sets a value expression for formatting the payee. In the -.Nm register +.Ic register report this prevents the second entry from having a date and payee for each transaction. .It Fl \-payee-width Ar INT @@ -666,23 +754,24 @@ report to Accounts, tags or commodities not previously declared will cause errors. .It Fl \-pending Use only postings that are marked pending. -.It Fl \-percent Pq Fl \b'%' +.It Fl \-percent Pq Fl % Calculate the percentage value of each account in a balance reports. Only works for account that have a single commodity. .It Fl \-period Ar PERIOD Pq Fl p Define a period expression that sets the time period during which transactions are to be accounted. For a -.Nm register +.Ic register report only the transactions that satisfy the period expression with be displayed. For a balance report only those transactions will be accounted in the final balances. .It Fl \-period-sort Sort the posting within transactions using the given value expression. -.\".It Fl \-permissive -.It Fl \-pivot Ar STR +.It Fl \-permissive +Quiet balance assertions. +.It Fl \-pivot Ar TAG Produce a balance pivot report -.Nm around +.Qq around the given .Ar TAG . .It Fl \-plot-amount-format Ar FMT @@ -691,7 +780,7 @@ Define the output format for an amount data plot. Define the output format for a total data plot. .It Fl \-prepend-format Ar FMT Prepend -.Ar STR +.Ar FMT to every line of the output. .It Fl \-prepend-width Ar INT Reserve @@ -711,10 +800,10 @@ is being used, then the Internet will be consulted again for a newer price. Otherwise, the old price is still considered to be fresh enough. Alias for -.Fl \-leeway Ar INT Pq Fl Z +.Fl \-leeway . .It Fl \-prices-format Ar FMT Set the format for the -.Nm prices +.Ic prices report. .It Fl \-pricedb-format Ar FMT Set the format expected for the historical price file. @@ -725,10 +814,10 @@ Show primary dates for all calculations. Alias for Report commodity totals (this is the default). .It Fl \-quarterly Shorthand for -.Fl \-period Ar "quarterly" . +.Fl \-period Ar quarterly . .It Fl \-raw In the -.Nm print +.Ic 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. Can be useful for minor cleanups, like just aligning @@ -737,22 +826,22 @@ amounts. Account using only real transactions ignoring virtual and automatic transactions. .It Fl \-recursive-aliases -Causes ledger to try to expand aliases recursively, i.e. try to expand +Causes +.Nm +to try to expand aliases recursively, i.e. try to expand the result of an earlier expansion again, until no more expansions apply. .It Fl \-register-format Ar FMT Define the output format for the -.Nm register +.Ic register report. .It Fl \-related Pq Fl r In a register report show the related account. This is the other -.Nm side +.Em side of the transaction. .It Fl \-related-all Show all postings in a transaction, similar to .Fl \-related -but show -.Nm both sides -of each transaction. +but show both sides of each transaction. .\".It Fl \-revalued .\".It Fl \-revalued-only .\".It Fl \-revalued-total Ar EXPR @@ -761,20 +850,27 @@ of each transaction. Set the random seed to .Ar INT for the -.Nm generate +.Ic generate command. Used as part of development testing. .It Fl \-script Ar FILE -Execute a ledger script. +Execute a +.Nm +script. .It Fl \-sort Ar EXPR Pq Fl S Sort the register report based on the value expression given to sort. .\".It Fl \-sort-all .It Fl \-sort-xacts Sort the posting within transactions using the given value expression. .It Fl \-start-of-week Ar STR -Tell ledger to use a particular day of the week to start its "weekly" -summary. +Use +.Ar STR +as the particular day of the week to start when using the +.Fl \-weekly +option. .Ar STR -can be day names, their abbreviations like "Mon", or the weekday number +can be day names, their abbreviations like +.Qq Mon , +or the weekday number starting at 0 for Sunday. .It Fl \-strict Accounts, tags or commodities not previously declared will cause warnings. @@ -786,8 +882,8 @@ Report only the last entries. Only useful on a register report. Alias for .Fl \-last Ar INT .It Fl \-time-colon -Display the value for a seconds based commodity as real hours and minutes, -thus 8100 seconds will be displayed as 2:15h instead of 2.25h. +Display the value for commodities based on seconds as hours and minutes. +Thus 8100s will be displayed as 2:15h instead of 2.25h. .\".It Fl \-time-report .It Fl \-total Ar EXPR Pq Fl T Define a value expression used to calculate the total in reports. @@ -799,15 +895,19 @@ Set the width of the total field in the register report. Enable tracing. The .Ar INT specifies the level of trace desired. -.It Fl \-truncate Ar CODE +.It Fl \-truncate Ar STR Indicates how truncation should happen when the contents of columns -exceed their width. Valid arguments are -.Nm leading , Nm middle , +exceed their width. Valid arguments for +.Ar STR +are +.Ar leading , +.Ar middle , and -.Nm trailing . +.Ar trailing . The default is smarter than any of these three, as it considers sub-names within the account name (that style is -called "abbreviate"). +called +.Qq abbreviate ) . .It Fl \-unbudgeted Show only un-budgeted postings. .It Fl \-uncleared Pq Fl U @@ -818,43 +918,45 @@ report. .It Fl \-unrealized-gains Allow the user to specify what account name should be used for unrealized gains. Defaults to -.Nm "Equity:Unrealized Gains" . +.Sy "Equity:Unrealized Gains" . Often set in one's -.Nm ~/.ledgerrc +.Pa ~/.ledgerrc file to change the default. .It Fl \-unrealized-losses Allow the user to specify what account name should be used for unrealized gains. Defaults to -.Nm "Equity:Unrealized Losses" . +.Sy "Equity:Unrealized Losses" . Often set in one's -.Nm ~/.ledgerrc +.Pa ~/.ledgerrc file to change the default. .It Fl \-unround Perform all calculations without rounding and display results to full precision. .It Fl \-values -Shows the values used by each tag when used in combination with the -.Nm tags +Show the values used by each tag when used in combination with the +.Ic tags command. .\".It Fl \-value-expr Ar EXPR .It Fl \-verbose -Print detailed information on the execution of Ledger. +Print detailed information on the execution of +.Nm . .It Fl \-verify Enable additional assertions during run-time. This causes a significant slowdown. When combined with .Fl \-debug Ar CODE -ledger will produce memory trace information. +.Nm +will produce memory trace information. .\".It Fl \-verify-memory .It Fl \-version Print version information and exit. .It Fl \-weekly Pq Fl W Shorthand for -.Fl \-period Ar "weekly" . +.Fl \-period Ar weekly . .It Fl \-wide Pq Fl w -Assume 132 columns instead of 80. +Assume 132 columns instead of the TTY width. .It Fl \-yearly Pq Fl Y Shorthand for -.Fl \-period Ar "yearly" . +.Fl \-period Ar yearly . .El .Sh PRE-COMMANDS Pre-commands are useful when you aren't sure how a command or option @@ -862,27 +964,46 @@ will work. The difference between a pre-command and a regular command is that pre-commands ignore the journal data file completely, nor is the user's init file read. .Bl -tag -width -indent -.It Nm args / query -Evaluate the given arguments and report how Ledger interprets it against -the following model transaction. -.It Nm eval +.It Ic args No / Ic query +Evaluate the given arguments and report how +.Nm +interprets it against the following model transaction: +.Bd -literal -offset indent +2004/05/27 Book Store + ; This note applies to all postings. :SecondTag: + Expenses:Books 20 BOOK @ $10 + ; Metadata: Some Value + ; Typed:: $100 + $200 + ; :ExampleTag: + ; Here follows a note describing the posting. + Liabilities:MasterCard $-200.00 +.Ed +.It Ic eval Evaluate the given value expression against the model transaction. -.It Nm format -Print details of how ledger uses the given formatting description and +.It Ic format +Print details of how +.Nm +uses the given formatting description and apply it against a model transaction. -.It Nm parse / expr -Print details of how ledger uses the given value expression description +.It Ic parse No / Ic expr +Print details of how +.Nm +uses the given value expression description and apply it against a model transaction. -.It Nm generate -Randomly generates syntactically valid Ledger data from a seed. Used +.It Ic generate +Randomly generates syntactically valid +.Nm +data from a seed. Used by the GenerateTests harness for development testing. -.It Nm period -Evaluate the given period and report how Ledger interprets it. -.It Nm script -.It Nm template +.It Ic period +Evaluate the given period and report how +.Nm +interprets it. +.\".It Ic script +.It Ic template Shows the insertion template that the -.Nm xact -sub-command generates. This is a debugging command. +.Ic xact +command generates. This is a debugging command. .El .Sh QUERIES The syntax for reporting queries can get somewhat complex. It is a series of @@ -895,45 +1016,56 @@ Thus, to report the current balance for all assets and liabilities, you would use: .Pp .Dl ledger bal asset liab -.It Nm payee Ar regex Pq \&@ Ns Ar regex +.It Ic payee Ar regex Pq Ic \&@ Ns Ar regex Query on the payee, rather than the account. -.It Nm tag Ar regex Pq \&% Ns Ar regex -.It Nm note Ar regex Pq \&= Ns Ar regex +.It Ic tag Ar regex Pq Ic \&% Ns Ar regex +.It Ic note Ar regex Pq Ic \&= Ns Ar regex Query on anything found in an item's note. -.It Nm code Ar regex Pq \&# Ns Ar regex +.It Ic code Ar regex Pq Ic \&# Ns Ar regex Query on the xact's optional code (which can be any string the user wishes). -.It Ar term Nm and Ar term +.It Ar term Cm and Ar term Query terms are joined by an implicit OR operator. You can change this to AND -by using that keyword. For example, to show food expenditures occurring at +by using the +.Cm and +keyword. For example, to show food expenditures occurring at Shakee's Pizza, you could say: .Pp -.Dl ledger reg food and @Shakee -.It Ar term Nm or Ar term +.Dl Li ledger reg food and @Shakee +.It Ar term Cm or Ar term When you wish to be more explicit, use the OR operator. -.It Nm show -.It Nm not Ar term +.It Ic show +.It Cm not Ar term Reverse the logical meaning of the following term. This can be used with parentheses to great effect: .Pp -.Dl ledger reg food and @Shakee and not dining +.Dl Li ledger reg food and @Shakee and not dining .It \&( Ar term No \&) If you wish to mix OR and AND operators, it is often helpful to surround logical units with parentheses. \fBNOTE\fR: Because of the way some shells interpret parentheses, you should always escape them: .Pp -.Dl ledger bal \e\\\&( assets or liab \e\\\&) and not food +.Dl Li ledger bal \e( assets or liab \e) and not food .El .Sh EXPRESSIONS .Bl -tag -width "partial_account" .It Fn abs value Return the absolute value of the given .Ar value . -.It Nm account -.It Nm account_base -.It Nm account_amount -.It Nm actual -.It Nm amount -.It Nm amount_expr +.It Sy account +Return the posting's account. +.It Sy account_base +Return the base account, i.e. everything after the last account delimiter ':'. +.\".It Sy account_amount +.It Sy actual +.\" Is there a difference between real and actual? +Return true if the transaction is real, i.e not a automated or virtual +transaction, false otherwise. +.It Sy amount +Return the amount of the posting. +.It Sy amount_expr +Return the calculated amount of the posting according to the +.Fl \-amount +option. .It Fn ansify_if value color bool Render the given .Ar value @@ -942,116 +1074,237 @@ as a string, applying the proper ANSI escape codes to display it in the given if .Ar bool is true. It typically checks the value of the option -.Nm Fl \-color , +.Fl \-color , for example: -.Dl ansify_if(amount, "blue", options.color) -.It Nm beg_line +.Dl Li ansify_if(amount, "blue", options.color) +.It Sy beg_line Line number where entry for posting begins. -.It Nm beg_pos +.It Sy beg_pos Character position where entry for posting begins. -.It Nm calculated -.It Nm cleared -.It Nm code +.\".It Sy calculated +.It Fn ceiling value +Return the next integer of +.Ar value +toward +infinity. +.It Sy cleared +Return true if the posting was cleared, false otherwise. +.It Sy code Return the transaction code, the string between the parenthesis after the date. -.It Nm comment -.It Nm commodity -.It Nm cost -.It Nm count -.It Nm date +.\".It Sy comment +.It Fn commodity value +Return the commodity of +.Ar value +or the posting amount when +.Ar value +was not specified. +.\".It Sy cost +.\".It Sy count +.It Sy date Return the date of the posting. -.It Nm depth -.It Nm depth_spacer -.It Nm display_amount -.It Nm display_total -.It Nm end_line +.\".It Sy depth +.\".It Sy depth_spacer +.\".It Sy display_amount +.\".It Sy display_total +.It Sy end_line Line number where entry for posting ends. -.It Nm end_pos +.It Sy end_pos Character position where entry for posting ends. -.It Nm filename -The name of the ledger data file from whence the posting came. -.It Nm format_date -.It Nm get_at -.It Nm has_meta -.It Nm has_tag -.It Nm is_seq -.It Nm join -.It Nm market -.It Nm meta -.It Nm note -.It Nm null -.It Nm options -.It Nm partial_account -.It Nm payee -.It Nm pending -.It Nm post -.It Nm print -.It Nm quantity -.It Nm quoted -.It Nm real -.It Nm rounded -.It Nm scrub -.It Nm status -.It Nm strip -.It Nm subcount -.It Nm tag -.It Nm today -.It Nm total -.It Nm total_expr -.It Nm truncate -.It Nm uncleared -.It Nm virtual -.It Nm xact +.It Fn floor value +Return the next integer of +.Ar value +toward -infinity. +.It Sy filename +The name of the +.Nm +data file from whence the posting came. +.It Fn format_date date format +Return the +.Ar date +as a string using +.Ar format . +Refer to +.Xr strftime 3 +for format string details. +.\".It Fn get_at +.\".It Fn has_meta +.It Fn has_tag tag +Return true if the posting has metadata named +.Ar tag , +false otherwise. +.\".It Fn is_seq +.It Fn join value +Replace all newlines in +.Ar value +with +.Li \en . +.It Fn market value datetime +Return the price of +.Ar value +at +.Ar datetime . +Note that +.Ar datetime +must be surrounded by brackets in order to be parsed correctly, e.g. +.Bq 2012/03/23 . +.\".It Sy meta +.I.\"t Sy note +.\".It Sy null +.It Sy options +A variable that allows access to the values of the given command-line options +using the long option names, e.g. to see whether +.Fl \-daily Pq Fl D +was given use +.Sy option.daily . +.\" .It Sy partial_account +.It Sy payee +Return the payee of the posting. +.It Fn percent value_a value_b +Return the percentage of +.Ar value_a +in relation to +.Ar value_b +(used as 100%). +.It Sy pending +Return true if the posting is marked as pending, false otherwise. +.It Fn percent value_a value_b +Return the percentage of +.Ar value_a +in relation to +.Ar value_b . +.\".It Sy post +.\" A variable scope +.\".It Sy print +.It Fn quantity value +Return the quantity of +.Ar value +for values that have a per-unit cost. +.It Fn quoted expression +Surround +.Ar expression +with double-quotes. +.It Sy real +.\" Is there a difference between real and actual? +Return true if the transaction is real, i.e not a automated or virtual +transaction, false otherwise. +.\".It Sy rounded +.It Fn roundto value n +Return +.Ar value +rounded to +.Ar n +digits. Does not affect formatting. +.\".It Sy scrub +.\".It Sy status +.\".It Sy strip +.\".It Sy subcount +.It Fn tag name +Return the value of tag named +.Ar name . +.\".It Fn to_amount value +.\".It Fn to_balance value +.\".It Fn to_boolean value +.\".It Fn to_date value +.\".It Fn to_datetime value +.It Fn to_int value +Return the integer value for +.Ar value . +.\".It Fn to_mask value +.\".It Fn to_sequence value +.It Fn to_string value +Convert +.Ar value +to a character string. +.It Sy today +Return today’s date. +.It Sy total +Return the total of the posting. +.It Sy total_expr +Return the calculated total of the posting according to the +.Fl \-total +option. +.It Fn trim value +Trim leading and trailing whitespace from +.Ar value . +.\".It Fn truncate +.\".It Sy uncleared +.It Sy virtual +Return true if the transaction is virtual, e.g automated, false otherwise. +.\".It Sy xact +.\" A variable scope .El -.Sh ENTRIES -.Sh FORMATS +.\".Sh ENTRIES +.\".Sh FORMATS .Sh DEBUG COMMANDS -In addition to the regular reporting commands, Ledger also accepts several +In addition to the regular reporting commands, +.Nm +also accepts several debug commands: .Bl -tag -width balance -.It Nm args Oo Ar report-query Oc -Accepts a -.Ar report-query -as its argument and displays it back to the user along with a complete -analysis of how Ledger interpreted it. Useful if you want to understand how -report queries are translated into value expressions. -.It Nm eval Oo Ar value-expression Oc -Evaluates the given +.It Ic args Oo Ar report-query Oc +Display complete analysis of how +.Nm +interpreted the given +.Ar report-query . +Useful if you want to understand how report queries are translated into value +expressions. +.It Ic eval Oo Ar value-expression Oc +Evaluate the given .Ar value-expression and prints the result. For more on value expressions, see the section .Sx EXPRESSIONS . -.It Nm format Oo Ar format-string Oc -Accepts a +.It Ic format Oo Ar format-string Oc +Display an analysis of how .Ar format-string -and displays an analysis of how it was parsed, and what it would look like -applied to a sample transaction. For more on format strings, see the section +was parsed, and what it would look like applied to a sample transaction. For +more on format strings, see the section .Sx FORMATS . -.It Nm generate -Generates 50 randomly composed yet valid Ledger transactions. -.It Nm parse Oo Ar value-expression Oc -Parses the given +.It Ic generate +Generate 50 randomly composed yet valid +.Nm +transactions. +.It Ic parse Oo Ar value-expression Oc +Parse the given .Ar value-expression and display an analysis of the expression tree and its evaluated value. For more on value expressions, see the section .Sx EXPRESSIONS . -.It Nm python Oo Ar file Oc -Invokes a Python interpreter to read the given +.It Ic python Oo Ar file Oc +Invoke a Python interpreter to read the given .Ar file . -What is special about this is that the ledger module is builtin, not read from -disk, so it doesn't require Ledger to be installed anywhere, or the shared +What is special about this is that the +.Nm +module is builtin, not read from +disk, so it doesn't require +.Nm +to be installed anywhere, or the shared library variants to be built. -.It Nm reload -Used only in the -.Tn REPL , -it causes an immediate reloading of all data files for the current session. -.It Nm template Oo Ar draft-template Oc -Accepts a +.It Ic reload +Reload all data files for the current session immediately. +Can only be used in the +.Tn REPL . +.It Ic template Oo Ar draft-template Oc +Display information about how .Ar draft-template -and displays information about how it was parsed. See the section on +was parsed. See the section on .Sx DRAFTS . .El +.Sh ENVIRONMENT +Every option to +.Nm +may be set using an environment variable if the option has a long name. +For example setting the environment variable +.Ev LEDGER_DATE_FORMAT="%d.%m.%Y' +will have the same effect as specifying +.Fl \-date-format Ar '%d.%m.%Y' +on the command-line. Options on the command-line always take precedence over +environment variable settings, however. .Sh FILES -~/.ledgerrc -Your personal ledger initializations. +.Bl -tag -width -indent +.It Pa ~/.ledgerrc +Your personal +.Nm +initializations. +.El .Sh SEE ALSO .Xr beancount 1 , .Xr hledger 1 |