ledger/doc/Ledger.scriv/snapshots/161.snapshots
John Wiegley 1f5ceb0db5 Added beginning draft of manual for 3.0
This is being kept in Scrivener format, for ease of writing.
2009-10-25 23:11:30 -04:00

520 lines
11 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>$archiver</key>
<string>NSKeyedArchiver</string>
<key>$objects</key>
<array>
<string>$null</string>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>37</integer>
</dict>
<key>NS.objects</key>
<array>
<dict>
<key>CF$UID</key>
<integer>2</integer>
</dict>
</array>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>33</integer>
</dict>
<key>NS.keys</key>
<array>
<dict>
<key>CF$UID</key>
<integer>3</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>4</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>5</integer>
</dict>
</array>
<key>NS.objects</key>
<array>
<dict>
<key>CF$UID</key>
<integer>6</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>7</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>35</integer>
</dict>
</array>
</dict>
<string>Title</string>
<string>Text</string>
<string>Date</string>
<string>Untitled Snapshot</string>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>34</integer>
</dict>
<key>NSAttributes</key>
<dict>
<key>CF$UID</key>
<integer>10</integer>
</dict>
<key>NSDelegate</key>
<dict>
<key>CF$UID</key>
<integer>0</integer>
</dict>
<key>NSString</key>
<dict>
<key>CF$UID</key>
<integer>8</integer>
</dict>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>9</integer>
</dict>
<key>NS.string</key>
<string>@c -c, --current show only current and past transactions (not future)
@option{--current}(@option{-c}) displays transactions occurring on or
before the current date. Any transaction recorded for a future date will be
ignored, as if it had not been seen. This is useful if you happen to
pre-record transactions, but still wish to view your balances in terms of
what is available today.
@c -b, --begin DATE set report begin date
@c -e, --end DATE set report end date
@option{--begin DATE} (@option{-b DATE}) limits the report to only
those transactions occurring on or after @var{DATE}. The running total in
the register will start at zero with the first posting, even if
there are earlier transactions.
To limit the display only, but still add earlier postings to the
running total, use the display expression @samp{-d 'd&gt;=[DATE]'}):
@example
ledger --basis -b may -d 'd&gt;=[5/14]' reg ^assets
@end example
Reports:
@smallexample
2004/05/14 Pay day Assets:Bank:Checking $500.00 $3,000.00
2004/05/27 Credit card company Assets:Bank:Checking $-20.00 $2,980.00
@end smallexample
In this example, the displayed postings start from @samp{5/14},
but the calculated total starts from the beginning of @samp{may}.
@option{--end DATE} (@option{-e DATE}) states when reporting should
end, both calculation and display. The ending date is inclusive.
The @var{DATE} argument to the @option{-b} and @option{-e} options can
be rather flexible. Assuming the current date to be November 15,
2004, then all of the following are equivalent:
@example
ledger -b oct bal
ledger -b "this oct" bal
ledger -b 2004/10 bal
ledger -b 10 bal
ledger -b last bal
ledger -b "last month" bal
@end example
@c -p, --period STR report using the given period
@c --period-sort EXPR sort each report period's transactions by EXPR
To constrain the report to a specific time period, use
@option{--period} (@option{-p}). A time period may have both a
beginning and an end, or neither, as well as a specified interval.
Here are a few examples:
@example
ledger -p 2004 bal
ledger -p august bal
ledger -p "from aug to oct" bal
ledger -p "daily from 8/1 to 8/15" bal
ledger -p "weekly since august" bal
ledger -p "monthly from feb to oct" bal
ledger -p "quarterly in 2004" bal
ledger -p yearly bal
@end example
See @ref{Period expressions} for more on syntax. Also, all of the
options @option{-b}, @option{-e} and @option{-p} may be used together,
but whatever information occurs last takes priority. An example of
such usage (in a script, perhaps) would be:
@example
ledger -b 2004 -e 2005 -p monthly reg ^expenses
@end example
This command is identical to:
@example
ledger -p "monthly in 2004" reg ^expenses
@end example
The postings within a period may be sorted using
@option{--period-sort}, which takes a value expression. This is
similar to the @option{--sort} option, except that it sorts within
each period transaction, rather than sorting all postings in the report.
See the documentation on @option{--sort} below for more details.</string>
</dict>
<dict>
<key>$classes</key>
<array>
<string>NSMutableString</string>
<string>NSString</string>
<string>NSObject</string>
</array>
<key>$classname</key>
<string>NSMutableString</string>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>33</integer>
</dict>
<key>NS.keys</key>
<array>
<dict>
<key>CF$UID</key>
<integer>11</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>12</integer>
</dict>
</array>
<key>NS.objects</key>
<array>
<dict>
<key>CF$UID</key>
<integer>13</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>30</integer>
</dict>
</array>
</dict>
<string>NSParagraphStyle</string>
<string>NSFont</string>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>29</integer>
</dict>
<key>NSAlignment</key>
<integer>4</integer>
<key>NSLineHeightMultiple</key>
<real>1.1000000238418579</real>
<key>NSTabStops</key>
<dict>
<key>CF$UID</key>
<integer>14</integer>
</dict>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>28</integer>
</dict>
<key>NS.objects</key>
<array>
<dict>
<key>CF$UID</key>
<integer>15</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>17</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>18</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>19</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>20</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>21</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>22</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>23</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>24</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>25</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>26</integer>
</dict>
<dict>
<key>CF$UID</key>
<integer>27</integer>
</dict>
</array>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>28</real>
</dict>
<dict>
<key>$classes</key>
<array>
<string>NSTextTab</string>
<string>NSObject</string>
</array>
<key>$classname</key>
<string>NSTextTab</string>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>56</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>84</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>112</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>140</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>168</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>196</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>224</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>252</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>280</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>308</real>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>16</integer>
</dict>
<key>NSLocation</key>
<real>336</real>
</dict>
<dict>
<key>$classes</key>
<array>
<string>NSArray</string>
<string>NSObject</string>
</array>
<key>$classname</key>
<string>NSArray</string>
</dict>
<dict>
<key>$classes</key>
<array>
<string>NSParagraphStyle</string>
<string>NSObject</string>
</array>
<key>$classname</key>
<string>NSParagraphStyle</string>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>32</integer>
</dict>
<key>NSName</key>
<dict>
<key>CF$UID</key>
<integer>31</integer>
</dict>
<key>NSSize</key>
<real>14</real>
<key>NSfFlags</key>
<integer>16</integer>
</dict>
<string>Courier</string>
<dict>
<key>$classes</key>
<array>
<string>NSFont</string>
<string>NSObject</string>
</array>
<key>$classname</key>
<string>NSFont</string>
</dict>
<dict>
<key>$classes</key>
<array>
<string>NSDictionary</string>
<string>NSObject</string>
</array>
<key>$classname</key>
<string>NSDictionary</string>
</dict>
<dict>
<key>$classes</key>
<array>
<string>KBWordCountingTextStorage</string>
<string>NSTextStorage</string>
<string>NSMutableAttributedString</string>
<string>NSAttributedString</string>
<string>NSObject</string>
</array>
<key>$classname</key>
<string>KBWordCountingTextStorage</string>
</dict>
<dict>
<key>$class</key>
<dict>
<key>CF$UID</key>
<integer>36</integer>
</dict>
<key>NS.time</key>
<real>267380389.018765</real>
</dict>
<dict>
<key>$classes</key>
<array>
<string>NSDate</string>
<string>NSObject</string>
</array>
<key>$classname</key>
<string>NSDate</string>
</dict>
<dict>
<key>$classes</key>
<array>
<string>NSMutableArray</string>
<string>NSArray</string>
<string>NSObject</string>
</array>
<key>$classname</key>
<string>NSMutableArray</string>
</dict>
</array>
<key>$top</key>
<dict>
<key>Snapshots</key>
<dict>
<key>CF$UID</key>
<integer>1</integer>
</dict>
</dict>
<key>$version</key>
<integer>100000</integer>
</dict>
</plist>