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

docs

Browse Source
This commit is contained in:
Simon Michael 2008-12-05 10:02:58 +00:00
parent fae380e914
commit b8f8dad7d6
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Options.hs
View File

@ -23,7 +23,7 @@ usageftr = "\n" ++
" print - show formatted ledger entries\n" ++ " print - show formatted ledger entries\n" ++
" register - show register transactions\n" ++ " register - show register transactions\n" ++
"\n" ++ "\n" ++
"Dates can be y/m/d or ledger-style smart dates like november or last week.\n" ++ "All dates can be y/m/d or ledger-style smart dates like \"last month\".\n" ++
"Account and description patterns are regular expressions which filter by\n" ++ "Account and description patterns are regular expressions which filter by\n" ++
"account name and entry description. Prefix a pattern with - to negate it,\n" ++ "account name and entry description. Prefix a pattern with - to negate it,\n" ++
"and separate account and description patterns with --.\n" ++ "and separate account and description patterns with --.\n" ++
@ -39,8 +39,8 @@ options = [
Option ['f'] ["file"] (ReqArg File "FILE") filehelp, Option ['f'] ["file"] (ReqArg File "FILE") filehelp,
Option ['b'] ["begin"] (ReqArg Begin "DATE") "report on entries on or after this date", Option ['b'] ["begin"] (ReqArg Begin "DATE") "report on entries on or after this date",
Option ['e'] ["end"] (ReqArg End "DATE") "report on entries prior to this date", Option ['e'] ["end"] (ReqArg End "DATE") "report on entries prior to this date",
Option ['p'] ["period"] (ReqArg Period "EXPR") ("report on entries during this calendar period\n" ++ Option ['p'] ["period"] (ReqArg Period "EXPR") ("report on entries during the specified period\n" ++
"(where EXPR is a single smart DATE)\n"), "and/or with the specified reporting interval\n"),
Option ['C'] ["cleared"] (NoArg Cleared) "report only on cleared entries", Option ['C'] ["cleared"] (NoArg Cleared) "report only on cleared entries",
Option ['B'] ["cost","basis"] (NoArg CostBasis) "report cost basis of commodities", Option ['B'] ["cost","basis"] (NoArg CostBasis) "report cost basis of commodities",
Option [] ["depth"] (ReqArg Depth "N") "balance report: maximum account depth to show", Option [] ["depth"] (ReqArg Depth "N") "balance report: maximum account depth to show",

15
README
View File

@ -58,7 +58,7 @@ description patterns, the LEDGER environment variable, and these options::
Report filtering: Report filtering:
-b, --begin DATE set report begin date -b, --begin DATE set report begin date
-e, --end DATE set report end date -e, --end DATE set report end date
-p, --period EXPR report using the given period (limited support) -p, --period EXPR report using the given period
-C, --cleared consider only cleared transactions -C, --cleared consider only cleared transactions
-R, --real consider only real (non-virtual) transactions -R, --real consider only real (non-virtual) transactions
@ -76,9 +76,9 @@ description patterns, the LEDGER environment variable, and these options::
register [REGEXP]... show register of matching transactions register [REGEXP]... show register of matching transactions
print [REGEXP]... print all matching entries print [REGEXP]... print all matching entries
We handle simple display expressions consisting of a date predicate, We handle (almost) the full period expression syntax, and simple display
and simple period expressions consisting of a single smart date. expressions consisting of a date predicate. Also the following
Also the following hledger-specific features are supported:: hledger-specific features are supported::
--depth=N balance report: maximum account depth to show --depth=N balance report: maximum account depth to show
--options-anywhere allow options anywhere, use ^ for negative patterns --options-anywhere allow options anywhere, use ^ for negative patterns
@ -155,11 +155,10 @@ gnucash files, and the following options::
Other differences Other differences
................. .................
* hledger keeps differently-priced amounts of the same commodity separate, at the moment * hledger keeps differently-priced amounts of the same commodity separate at the moment
* hledger refers to the entry and transaction "description", ledger calls it "note" * hledger refers to the entry's and transaction's "description", ledger calls it "note"
* hledger doesn't require a space after flags like -f * hledger doesn't require a space before command-line option values
* hledger doesn't parse all ledger file constructs (and may choke ? please report) * hledger doesn't parse all ledger file constructs (and may choke ? please report)
* hledger interprets "last/this/next week" as weeks beginning on monday
* hledger provides "--cost" as a synonym for "--basis" * hledger provides "--cost" as a synonym for "--basis"
* hledger's "weekly" reporting intervals always start on mondays * hledger's "weekly" reporting intervals always start on mondays
* hledger shows start and end dates of full intervals, not just the span containing data * hledger shows start and end dates of full intervals, not just the span containing data