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

moved around options

Browse source
This commit is contained in:
John Wiegley 2004-06-22 00:36:24 -04:00 • committed by johnw
parent adb3965e94
commit 7894005d28
2 changed files with 150 additions and 175 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

240
README
View file

@ -385,38 +385,33 @@ its various reports. It will always report balances in terms of the
commodity total, rather than the current value of those commodities. commodity total, rather than the current value of those commodities.
To enable pricing reports, three options are possible: To enable pricing reports, three options are possible:
**-B** :: **-P FILE** ::
Report commodities in terms of their "basis cost", or what they cost With this option, or if the environment variable =PRICE_HIST= is
at the time of purchase. Totals in the register and balance report set, pricing information obtained from the Internet will be kept
reflect the total amount spent. in this file. Also, this file will be read after all other ledger
files are read, so that full history information is available for
**-L MINS** :: reports.
When using the =-P= or =-Q= flags, the Internet is consulted only
if current pricing data is older than MINS minutes.
**-P** ::
Report commodities in terms of their market price. The Internet is
consulted for current prices, by calling an external script named
=getquote= (a sample Perl script is provided, but the interface is
kept simple so replacements may be made). Register reports always
give the total market value for the date of the entry -- which means
they may vary greatly from the sum of the values of the individual
entries.
**-Q FILE** ::
Works like the =-P= flag, except it reads and saves downloaded price
information in =FILE=, accumulating a history of prices for each
commodity. This is the same as using =-P= with the environment
variable =PRICE_HIST= set to =FILE=.
**-T** :: **-T** ::
Report only commodity totals, not the market value or basis cost. Report commodity totals only, not their market value or basis cost.
**-V** :: **-V** ::
Report the market value for commodities, but without consulting the Report commodity values in terms of their last known market price.
Internet for current prices. This uses only the pricing data saved
in the ledger file, or in the history file referenced by the **-B** ::
environment variable =PRICE_HIST=. Report commodities in terms of their "basis cost", or what they cost
at time of purchase. Thus, totals in the register and balance
report reflect the total amount spent.
**-Q FILE** ::
When needed (see the =-L= option) pricing quotes are obtained by
calling the script =getquote= (a sample Perl script is provided, but
the interface is kept simple so replacements may be made).
**-L MINS** ::
When using the =-Q= flag, new quotes are obtained only if current
pricing data is older than MINS minutes. The default is one day,
or 1440 minutes.
Note that the =-B=, =-T=, =-V=, and =-P= and =-Q= flags are all Note that the =-B=, =-T=, =-V=, and =-P= and =-Q= flags are all
mutually exclusive. Whichever option appears last is used. mutually exclusive. Whichever option appears last is used.
@ -1065,19 +1060,34 @@ launches =vi= to let you confirm that the entry looks appropriate.
** Option summary ** Option summary
**-B** :: *** Basic options
When printing accounts containing commodities, display the base
price for the commodity, rather than the quantity of that commodity **-v** ::
(the default) or its current price (if =-P= or =-Q= is used). This Display the version of ledger being used.
option causes only the price at time(s) of purchase to be
considered, not the current or historical price afterwards. **-h** ::
Print out quick help on the various options and commands.
**-f FILE[<verbatim>=</verbatim>ACCOUNT]** ::
Read ledger entries from FILE. This takes precedence over the
environment variable LEDGER. If "<verbatim>=</verbatim>ACCOUNT" is
appended to the filename, then all of the entries are seen as if the
transactions accounts were prefixed by "ACCOUNT:". There may be
multiple occurrences of the =-f= option.
**-i FILE** ::
Read in the list of patterns to include/exclude from FILE.
Ordinarily, these are specified as arguments after the command.
*** Filtering options
**-b DATE** :: **-b DATE** ::
Only consider entries occuring on or after the given date. Only consider entries occuring on or after the given date.
**-C** :: **-e DATE** ::
Only consider entries whose cleared flag has been set. The default Only consider entries occuring before the given date. The date is
is to consider both. not inclusive, so any entries occurring on that date will not be
used.
**-c** :: **-c** ::
Only consider entries occurring on or before the current date. Only consider entries occurring on or before the current date.
@ -1088,71 +1098,86 @@ launches =vi= to let you confirm that the entry looks appropriate.
such as "2004/05". It's a shorthand for having to specify -b and -e such as "2004/05". It's a shorthand for having to specify -b and -e
together. together.
**-E** :: **-C** ::
Also show empty accounts in the balance totals report. Only consider entries whose cleared flag has been set. The default
is to consider both.
**-e DATE** :: **-U** ::
Only consider entries occuring before the given date. The date is Show only uncleared transactions. The default is to consider both.
not inclusive, so any entries occurring on that date will not be
used.
**-F** ::
Print full account names in all cases, such as "Assets:Checking"
instead of just "Checking". Only used current by the "balance"
command.
**-f FILE[<verbatim>=</verbatim>ACCOUNT]** ::
Read ledger entries from FILE. This takes precedence over the
environment variable LEDGER. If "<verbatim>=</verbatim>ACCOUNT" is
appended to the filename, then all of the entries are seen as if the
transactions accounts were prefixed by "ACCOUNT:". There may be
multiple occurrences of the =-f= option.
**-G** ::
Modifies the output generated by -M to be friendly to programs like
Gnuplot. It strips away the commodity label, and outputs only two
columns: the date and the amount.
**-h** ::
Print out quick help on the various options and commands.
**-i FILE** ::
Read in the list of patterns to include/exclude from FILE.
Ordinarily, these are specified as arguments after the command.
**-L MINS** ::
Specifies the number of minutes old that pricing data can be, before
the =-Q= and =-P= options will download a new quote from the
Internet. =-P= only downloads the information, while =-Q= maintains
the information in a history file. The default value for this
option is one day, or 1440 minutes.
**-l AMT** :: **-l AMT** ::
Limit balance reports to those which are greater than AMT. Limit balance reports to those which are greater than AMT.
**-M** ::
When used with the "register" command, causes only monthly subtotals
to appear. This can be useful for looking at spending patterns.
TODO: Accept an argument which specifies the period to use.
**-N REGEXP** :: **-N REGEXP** ::
If an account matches REGEXP, only display it in the balance report If an account matches REGEXP, only display it in the balance report
if its total is negative. Useful to avoid seeing credit in accounts if its total is negative. Useful to avoid seeing credit in accounts
where one cannot spend that credit, and it will soon become negative where one cannot spend that credit, and it will soon become negative
anyway (such as credit cards). anyway (such as credit cards).
**-R** ::
Ignore all virtual transactions, and report only the real balance
for each account.
*** Output formatting options
**-n** :: **-n** ::
Do not show subtotals in the balance report, or split transactions Do not show subtotals in the balance report, or split transactions
in the register report. in the register report.
**-P** :: **-s** ::
Download current prices for all commodities by calling the script If an account has children, show them in the balance report.
"getquote". There is a "getquote" script included with ledger,
although any similar program could be used. It must take a single **-S** ::
argument, the name of the commodity, and must report the value as a Sort the ledger after reading it. This may affect "register" and
single amount, such as would appear in a ledger file. If the "print" output.
commodity has no price, nothing should be output and the exit code
should be set to a non-zero value. **-E** ::
Also show empty accounts in the balance totals report.
**-F** ::
Print full account names in all cases, such as "Assets:Checking"
instead of just "Checking". Only used current by the "balance"
command.
**-M** ::
When used with the "register" command, causes only monthly subtotals
to appear. This can be useful for looking at spending patterns.
TODO: Accept an argument which specifies the period to use.
**-G** ::
Modifies the output generated by -M to be friendly to programs like
Gnuplot. It strips away the commodity label, and outputs only two
columns: the date and the amount.
*** Commodity reporting options
**-P FILE** ::
With this option, or if the environment variable =PRICE_HIST= is
set, pricing information obtained from the Internet will be kept
in this file. Also, this file will be read after all other ledger
files are read, so that full history information is available for
reports.
**-T** ::
Report commodity totals only, not their market value or basis cost.
**-V** ::
Report commodity values in terms of their last known market price.
**-B** ::
Report commodities in terms of their "basis cost", or what they cost
at time of purchase. Thus, totals in the register and balance
report reflect the total amount spent.
**-Q FILE** ::
When needed (see the =-L= option) pricing quotes are obtained by
calling the script =getquote= (a sample Perl script is provided, but
the interface is kept simple so replacements may be made).
**-L MINS** ::
When using the =-Q= flag, new quotes are obtained only if current
pricing data is older than MINS minutes. The default is one day,
or 1440 minutes.
**-p ARG** :: **-p ARG** ::
If a string, such as "COMM=$1.20", the commodity COMM will be If a string, such as "COMM=$1.20", the commodity COMM will be
@ -1163,47 +1188,6 @@ launches =vi= to let you confirm that the entry looks appropriate.
use: -p "$=0.00280112 AU" (or whatever the current exchange rate use: -p "$=0.00280112 AU" (or whatever the current exchange rate
is). is).
**-Q FILE** ::
This option, like =-P=, downloads commodities prices from the
Internet as needed, by calling the script "getquote" (see above).
However, this option takes a string argument: the file to write the
downloaded pricing data to. On future runs, this pricing data is
consulted to see if it's fresh enough, to avoid downloading it from
the Internet again. The freshness period is given by the =-L=
option, specifying the maximum allowable age in minutes. The
default is one day. So, to report the current value of your
investments up to the day, add =-Q ~/.pricedb= to your ledger
command-line. Also, it is recommended that the =-Q= option always
appear after all uses of =-f=.
**-R** ::
Ignore all virtual transactions, and report only the real balance
for each account.
**-S** ::
Sort the ledger after reading it. This may affect "register" and
"print" output.
**-s** ::
If an account has children, show them in the balance report.
**-T** ::
Show only commodities totals, do not convert to the basis cost or
the current market value. This disables the effect of =-B=, =-P=
and =-Q=.
**-U** ::
Show only uncleared transactions. The default is to consider both.
**-V** ::
Report the market value for commodities, but without consulting the
Internet for current prices. This uses only the pricing data saved
in the ledger file, or in the history file referenced by the
environment variable =PRICE_HIST=.
**-v** ::
Display the version of ledger being used.
** Environment variables ** Environment variables
=LEDGER= :: =LEDGER= ::

85
reports.cc
View file

@ -820,42 +820,49 @@ static void show_help(std::ostream& out)
std::cerr std::cerr
<< "usage: ledger [options] COMMAND [options] [REGEXPS]" << std::endl << "usage: ledger [options] COMMAND [options] [REGEXPS]" << std::endl
<< std::endl << std::endl
<< "ledger options:" << std::endl << "Basic options:" << std::endl
<< " -B report commodities in terms of their basis cost" << std::endl << " -h display this help text" << std::endl
<< " -v display version information" << std::endl
<< " -f FILE specify pathname of ledger data file" << std::endl
<< " -i FILE read list of inclusion regexps from FILE" << std::endl
<< std::endl
<< "Report filtering:" << std::endl
<< " -b DATE specify a beginning date" << std::endl << " -b DATE specify a beginning date" << std::endl
<< " -C show only cleared transactions and balances" << std::endl << " -e DATE specify an ending date" << std::endl
<< " -c do not show future entries (same as -e TODAY)" << std::endl << " -c do not show future entries (same as -e TODAY)" << std::endl
<< " -d DATE specify a date mask ('-d mon', for all mondays)" << std::endl << " -d DATE specify a date mask ('-d mon', for all mondays)" << std::endl
<< " -E also show accounts with zero totals" << std::endl << " -C show only cleared transactions and balances" << std::endl
<< " -e DATE specify an ending date" << std::endl
<< " -F print each account's full name" << std::endl
<< " -f FILE specify pathname of ledger data file" << std::endl
<< " -G use with -M to produce gnuplot-friendly output" << std::endl
<< " -h display this help text" << std::endl
<< " -i FILE read the list of inclusion regexps from FILE" << std::endl
<< " -L MINS fetch price quotes if info older than MINS" << std::endl
<< " -l AMT don't print balance totals whose abs value is <AMT" << std::endl
<< " -M print register using monthly sub-totals" << std::endl
<< " -N REGEX accounts matching REGEXP only display if negative" << std::endl
<< " -n do not calculate parent account totals" << std::endl
<< " -P download price quotes from the Internet" << std::endl
<< " (works by running the command \"getquote SYMBOL\")" << std::endl
<< " -p ARG set a direct price conversion: COMM=PRICE" << std::endl
<< " -Q FILE keep price histories in FILE (implies -P)" << std::endl
<< " -R do not factor in virtual transactions" << std::endl
<< " -S sort the output of \"print\" by date" << std::endl
<< " -s show sub-accounts in balance totals" << std::endl
<< " -T report only commodities totals, not their value" << std::endl
<< " -U show only uncleared transactions and balances" << std::endl << " -U show only uncleared transactions and balances" << std::endl
<< " -V report commodity values, but don't download quotes" << std::endl << " -l AMT don't print balance totals whose abs value is <AMT" << std::endl
<< " -v display version information" << std::endl << std::endl << " -N REGEX accounts matching REGEXP only display if negative" << std::endl
<< " -R do not consider virtual transactions: real only" << std::endl
<< std::endl
<< "Customizing output:" << std::endl
<< " -n do not calculate parent account totals" << std::endl
<< " -s show sub-accounts in balance totals" << std::endl
<< " -S sort the output of \"print\" by date" << std::endl
<< " -E show accounts that total to zero" << std::endl
<< " -F print each account's full name" << std::endl
<< " -M print register using monthly sub-totals" << std::endl
<< " -G use with -M to produce gnuplot-friendly output" << std::endl
<< std::endl
<< "Commodity prices:" << std::endl
<< " -P FILE sets the price database, for reading/writing price info" << std::endl
<< " -T report commodity totals, not their market value" << std::endl
<< " -V report the market value of commodities" << std::endl
<< " -B report cost basis of commodities" << std::endl
<< " -Q download new price inforamtion (when needed) from the Internet" << std::endl
<< " (works by running \"getquote SYMBOL\")" << std::endl
<< " -L MINS with -Q, fetch quotes only if data is older than MINS" << std::endl
<< " -p STR specifies a direct commodity conversion: COMM=AMOUNT" << std::endl
<< std::endl
<< "commands:" << std::endl << "commands:" << std::endl
<< " balance show balance totals" << std::endl << " balance show balance totals" << std::endl
<< " register display a register for ACCOUNT" << std::endl << " register display a register for ACCOUNT" << std::endl
<< " print print all ledger entries" << std::endl << " print print all ledger entries" << std::endl
<< " equity generate equity ledger for all entries" << std::endl << " equity generate equity ledger for all entries" << std::endl
<< " entry output a newly formed entry, based on arguments" << " entry output a newly formed entry, based on arguments" << std::endl
<< std::endl; << " price show the last known price for matching commodities" << std::endl;
} }
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
@ -946,39 +953,23 @@ int main(int argc, char * argv[])
break; break;
case 'P': case 'P':
cost_basis = false;
use_history = true;
get_quotes = true;
read_prices = true;
break;
case 'Q':
cost_basis = false;
use_history = true;
get_quotes = true;
read_prices = true;
price_db = optarg; price_db = optarg;
break; break;
case 'V': case 'Q':
cost_basis = false; get_quotes = true;
use_history = true;
get_quotes = false;
read_prices = true;
break; break;
case 'B': case 'B':
cost_basis = true; cost_basis = true;
// fall through...
case 'V':
use_history = true; use_history = true;
get_quotes = false;
read_prices = false;
break; break;
case 'T': case 'T':
cost_basis = false; cost_basis = false;
use_history = false; use_history = false;
get_quotes = false;
read_prices = false;
break; break;
case 'L': case 'L':