summaryrefslogtreecommitdiff
path: root/doc/Ledger.scriv/126.rtfd
diff options
context:
space:
mode:
authorJohn Wiegley <johnw@newartisans.com>2009-10-25 23:08:07 -0400
committerJohn Wiegley <johnw@newartisans.com>2009-10-25 23:11:30 -0400
commit1f5ceb0db50df9ad0f9048ee02ad749507cbd737 (patch)
treea8609fdcd28aa4d371aebf8a9867e43014e652f1 /doc/Ledger.scriv/126.rtfd
parent9dadaebfeb461ba795124281018d0f7eac200cf4 (diff)
downloadfork-ledger-1f5ceb0db50df9ad0f9048ee02ad749507cbd737.tar.gz
fork-ledger-1f5ceb0db50df9ad0f9048ee02ad749507cbd737.tar.bz2
fork-ledger-1f5ceb0db50df9ad0f9048ee02ad749507cbd737.zip
Added beginning draft of manual for 3.0
This is being kept in Scrivener format, for ease of writing.
Diffstat (limited to 'doc/Ledger.scriv/126.rtfd')
-rw-r--r--doc/Ledger.scriv/126.rtfd/TXT.rtf39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/Ledger.scriv/126.rtfd/TXT.rtf b/doc/Ledger.scriv/126.rtfd/TXT.rtf
new file mode 100644
index 00000000..8f83e21b
--- /dev/null
+++ b/doc/Ledger.scriv/126.rtfd/TXT.rtf
@@ -0,0 +1,39 @@
+{\rtf1\ansi\ansicpg1252\cocoartf949\cocoasubrtf460
+{\fonttbl\f0\fmodern\fcharset0 Courier;}
+{\colortbl;\red255\green255\blue255;}
+\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\sl264\slmult1\ql\qnatural\pardirnatural
+
+\f0\fs28 \cf0 This chapter describes ledger's features and serves as a quick\
+reference. You may wish to survey this to get an overview before diving\
+in to the @ref\{Ledger Tutorial\} and more detailed examples that follow.\
+\
+Ledger has a very simple command-line interface, named---enticing\
+enough---@command\{ledger\}. It supports a few reporting commands, and\
+a large number of options for refining the output from those commands.\
+The basic syntax of any ledger command is:\
+\
+@example\
+ledger [OPTIONS...] COMMAND [ARGS...]\
+@end example\
+\
+Command options must always precede the command word. After the\
+command word there may appear any number of arguments. For most\
+commands, these arguments are regular expressions that cause the\
+output to relate only to postings matching those regular\
+expressions. For the @command\{transaction\} command, the arguments have a\
+special meaning, described below.\
+\
+The regular expressions arguments always match the account name that a\
+posting refers to. To match on the payee of the transaction instead,\
+precede the regular expression with @samp\{--\}. For example, the\
+following balance command reports account totals for rent, food and\
+movies, but only those whose payee matches Freddie:\
+\
+@example\
+ledger bal rent food movies -- freddie\
+@end example\
+\
+There are many, many command options available with the\
+@command\{ledger\} command, and it takes a while to master them.\
+However, none of them are required to use the basic reporting\
+commands.} \ No newline at end of file