.\" $HeadURL$ $LastChangedRevision$
.\"
.pso ade-config --format=man
.so \*[ade_include_prefix]/ade.man
.pso iofdb-config --format=man
.TH IOFDB 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.SH NAME
iofdb \- manage IOFDB database
.br
.ne 5
.SH SYNOPSIS
.B iofdb
\*[ade_standard_synopsis_component]
[
.B \-\-display\-currency=\fIcurrency\fR
]
[
.B \-\-display\-format=\fIformat\fR
]
[
.B \-\-display\-type=\fItype\fR
]
[
.B \-\-interactive=\fR{\fByes\fR|\fBno\fR}
.I action
.I object\-type
[
.I object-name \fR\.\.\.
]
.br
.ne 5
.SH DESCRIPTION
.B Iofdb
is the workhorse of the Information-Oriented Finance DataBase (see
.B iofdb\-intro\fR(1)). 
It performs all interaction with the database and only limited interaction with 
the user. (Interaction with the user is mostly handled by 
.B iofdbm\fR(1), which
delegates most of the work to 
.B iofdb\fR.)
.PP
.B Iofdb
is responsible for:
.IP \[bu] 2
recording opening (creating) of accounts
.IP \[bu]
recording closing (destroying) of accounts
.IP \[bu]
displaying account information (all account characteristics except how much is in it each account)
.IP \[bu]
recording changes in holdings (by asking the user how much is in each account)
.IP \[bu]
displaying holdings (how much is in each account)
.IP \[bu]
updating prices of currencies, listed stocks and unlisted stocks
.IP \[bu]
updating balance (recalculating balance based on last retrieved prices and last specified holdings)
.IP \[bu]
displaying of balance
.PP
The user, or more likely 
.B iofdbm\fR(1),
specifies which of the above to do by using a combination of the arguments
.I action 
(one of 
.B create\fR,
.B destroy\fR,
.B update\fR
or 
.B display\fR)
and
.I object\-type
(one of
.B account\fR,
.B holding\fR,
.B price\fR
or
.B balance\fR).
Note that certain actions require the plural of an object whereas others require the
singular, according to what is natural in the English language. 
An
.I object\-name
and possibly arguments 
.B must 
be provided to complete some actions (e.g. to open an 
account) and 
.B may 
be provided to complete other actions (e.g. to display information on only certain prices).
.br
.ne 5
.SH CONFIGURATION
See 
.B iofdb\-intro\fR(1).
.br
.ne 5
.SH OPTIONS
\*[ade_standard_options_component]
.TP 
.B \-\-display\-currency=\fIcurrency\fR
Sets the currency used for balances and the preferred currency for price lookups to 
.I currency\fR,
which is a three-letter uppercase ISO 4217 currency name, e.g.
.B EUR\fR,
.B USD\fR 
or 
.B FRF\fR. 
.TP
.B \-\-display\-format=\fIformat\fR
Sets the output format to
.I format\fR,
which is either
.B human 
or 
.B png\fR. 
.B human
format is a simple ASCII table. 
.B png
format 
is image data in PNG format (which the user should probably redirect to a file).
The image data is generated by
.B gnuplot\fR(1).
.TP
.B \-\-display\-type=\fItype\fR
Sets the type or range of data to 
.I type\fR,
which is one of
.B current
(only latest data is displayed; e.g. only the latest price of a foreign currency),
.B history
(all available data is displayed; e.g. all prices of a foreign currency) or
.B none
(no data is displayed). 
.TP
.B \-\-interactive=\fR{\fByes\fR|\fBno\fR}
When the parameter is 
.B no
then the behaviour of the 
.B update prices 
and
.B update holdings
commands are modified: the former command updates all prices except for
unlisted stocks (whose prices must be determined by asking the user)
and the latter produces an error (holdings must always determined by
asking the user). The default parameter is
.B yes\fR.
.br
.ne 5
.SH EXIT STATUS
On success
.B iofdb
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
None.
.br
.ne 5
.SH ENVIRONMENT VARIABLES
.TP 25
PATH
This is used to locate 
.B gnuplot\fR(1).
.br
.ne 5
.SH EXAMPLES
The following command will display details of accounts:
.IP
.nf
.fam C
.B iofdb --display-currency=EUR display accounts
.fam T
.fi
.PP
The following command create a PNG file of your balance since you started using IOFDB:
.IP
.nf
.fam C
.B iofdb --display-currency=EUR --display-type=history --display-format=png display balances > balance.png
.fam T
.fi
.PP
See
.B iofdb\-intro\fR(1)
for more examples.
.br
.ne 5
.SH CAVEATS
Use of the
.B --display-currency
option is not optional. 
.PP
The display currency should probably be set to your local currency.
.br
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B iofdb\fR.
.br
.ne 5
.SH SEE ALSO
gnuplot(1), iofdbm(1), iofdb-intro(1)
.br
.ne 5
.SH AUTHOR
ADE_APP_TOKEN_AUTHOR_NAME <ADE_APP_TOKEN_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2004-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
\*[ade_standard_copyright_component]