summaryrefslogtreecommitdiff
path: root/doc/man/penny-suite.7
blob: d3b62228ef80bddef8cee32c3c725e20b384d899 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
.TH penny-suite 7
.
.SH NAME
penny-suite - extensible double-entry accounting system
.
.SH DESCRIPTION
.
This manual page lists all the different components of Penny and also
catalogues all the documentation files and manual pages that are
available.
.
.SH PENNY PROGRAMS
.
Penny consists of many programs. Each has its own manual page.
.
.TP
.BR penny (1)
.
reports on postings in your ledger file
.
.TP
.BR penny-selloff (1)
.
calculate capital gains and losses on commodity sales
.
.TP
.BR penny-diff (1)
.
show differences between ledger files
.
.TP
.BR penny-reprint (1)
.
tidy up a ledger file, retaining comments
.
.TP
.BR penny-reconcile (1)
.
marks cleared postings as reconciled
.
.SH PENNY MANUAL PAGES
.
In addition to the manual pages shown above, a few more overview man
pages are available.
.
.TP
.BR penny-basics (7)
.
getting started with
.B penny
.
.TP
.BR penny-examples (7)
.
more examples of
.B penny
usage
.
.TP
.BR penny-commodities (7)
.
tracking multiple commodities, such as stocks, with Penny
.
.TP
.BR penny-fit (1)
.
describes how you might be able to create a program that automatically
parses downloaded statements from your financial institution and
merges the resulting postings into your ledger file.
.
.TP
.BR penny-custom (7)
.
how to make a custom \fBpenny\fR program with your own settings
.
.SH SAMPLE FILES
.
There are many files available filled with sample data. They are in the
.I examples
directory of the
.B penny-bin
tarball.
.
.TP
.BR starter.pny
.
describes the basics of the Penny ledger file format, and contains
sample data. The
.BR penny-basics (7)
manual page uses the sample data from this file.
.
.TP
.BR stocks.pny
.
shows how to use Penny to track multiple commodities, like stocks
.
.TP
.BR stocks-realized.pny
.
shows an example of the results of using
.BR penny-selloff (1)
.
.
.SH TEXT FILES
.
Much documentation is available only in plain-text form. These files
are in the
.B doc
directory of the
.B penny-bin
tarball.
.
.TP
.BR amex-file-format.org
.
the file format American Express uses for its downloadable data
.
.TP
.BR bofa-file-format.org
.
the file format Bank of America uses for its downloadable data
.
.TP
.BR dependencies.dot
.
the dependencies between the various parts of the Penny library
.
.TP
.BR ledger-grammar.org
.
an EBNF grammar for the ledger file format
.
.SH HADDOCK
.
Feel free to examine the Haskell source code of the Penny library,
which also contains Haddock documentation markup.