slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme upates

Browse Source
This commit is contained in:
Simon Michael 2009-05-25 00:33:13 +00:00
parent 4d83ae928b
commit 3706e23c59
1 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README
View File

@ -40,8 +40,8 @@ option (which may be - for standard input). Basic usage is::
hledger [OPTIONS] [COMMAND [PATTERNS]] hledger [OPTIONS] [COMMAND [PATTERNS]]
COMMAND is one of balance, print, register, ui, web, test (defaulting to COMMAND is one of balance, print, register, ui, web, test (defaulting to
balance). PATTERNS are zero or more regular expressions used to narrow the balance). PATTERNS are zero or more regular expressions used to filter by
results. Here are some commands to try:: account name or transaction description. Here are some commands to try::
export LEDGER=sample.ledger export LEDGER=sample.ledger
hledger --help # show usage & options hledger --help # show usage & options
@ -52,16 +52,16 @@ results. Here are some commands to try::
hledger reg checking # checking transactions hledger reg checking # checking transactions
hledger reg desc:shop # transactions with shop in the description hledger reg desc:shop # transactions with shop in the description
hledger histogram # transactions per day, or other interval hledger histogram # transactions per day, or other interval
hledger ui # interactive ui, if installed with -fvty hledger ui # curses ui, if installed with -fvty
hledger web # web ui, installed with -fhapps hledger web # web ui, if installed with -fhapps
echo >new; hledger -f new add # input transactions from the command line hledger -f new.ledger add # record transactions from the command line
Time reporting Time reporting
-------------- --------------
hledger will also read timeclock.el-format timelog entries. As a hledger will also read timelog files in timeclock.el format. If you
convenience, if you invoke hledger via a link or copy named "hours", it invoke hledger via a symlink or copy named "hours", it looks for your
uses your timelog file (~/.timelog or $TIMELOG) by default.:: timelog file (~/.timelog or $TIMELOG) by default.::
hours [OPTIONS] [COMMAND [PATTERNS]] hours [OPTIONS] [COMMAND [PATTERNS]]
@ -73,13 +73,13 @@ Timelog entries look like this::
The clockin description is treated as an account name. Here are some The clockin description is treated as an account name. Here are some
queries to try:: queries to try::
ln -s `which hledger` ~/bin/hours # add the "hours" symlink in your path ln -s `which hledger` ~/bin/hours # set up "hours" in your path
export TIMELOG=sample.timelog export TIMELOG=sample.timelog
hours # time logged today, if any hours # show all time balances
hours -p 'last month' # last month hours -p 'last week' # last week
hours -p thisyear # the space is optional hours -p thismonth # the space is optional
hours -p 'from 1/15' register proj # project sessions since last jan 15 hours -p 'from 1/15' register project # project sessions since jan 15
hours -p 'weekly this year' reg --depth 1 # weekly time summary hours -p 'weekly' reg --depth 1 -E # weekly time summary
Features Features
-------- --------
@ -87,8 +87,7 @@ Features
This version of hledger mimics a subset of ledger 3.x, and adds some This version of hledger mimics a subset of ledger 3.x, and adds some
features of its own. We currently support regular ledger entries, timelog features of its own. We currently support regular ledger entries, timelog
entries, multiple commodities, virtual transactions, account and entries, multiple commodities, virtual transactions, account and
description patterns, the LEDGER environment variable, and these commands description filtering, and these commands and options::
and options::
Commands: Commands:
balance [REGEXP]... show balance totals for matching accounts balance [REGEXP]... show balance totals for matching accounts
@ -126,10 +125,10 @@ We handle (almost) the full period expression syntax, and very limited
display expressions consisting of a simple date predicate. Also the display expressions consisting of a simple date predicate. Also the
following new commands are supported:: following new commands are supported::
histogram show a (textual) barchart of transaction counts histogram show a barchart of transaction counts per interval
add input transactions from the command line add record transactions from the command line
convert convert CSV bank data to ledger journal format convert convert CSV bank data to ledger journal format
ui a simple interactive text ui (only on unix platforms) ui a simple curses ui (only on unix platforms)
web a simple web ui web a simple web ui
stats report some ledger statistics stats report some ledger statistics
test run self-tests test run self-tests