taler/exchange
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

adding man pages

Browse Source
This commit is contained in:
Christian Grothoff 2015-04-19 16:45:27 +02:00
parent 81e8a9b99c
commit 1db6ae0671
8 changed files with 235 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
contrib/mint-template/config/mint-common.conf
View File

@ -12,4 +12,4 @@ DB = postgres:///taler
PORT = 4241
# Master public key used to sign the mint's various keys
TMH_MASTER_PUBLIC_KEY = ...
MASTER_PUBLIC_KEY = ...

11
doc/Makefile.am
View File

@ -2,5 +2,14 @@
SUBDIRS = . doxygen
man_MANS = \
taler-mint-dbinit.1 \
taler-mint-httpd.1 \
taler-mint-keyup.1 \
taler-mint-keycheck.1 \
taler-mint-reservemod.1 \
taler.conf.5
EXTRA_DIST = \
coding-style.txt
coding-style.txt \
${man_MANS}

29
doc/taler-mint-dbinit.1 Normal file
View File

@ -0,0 +1,29 @@
.TH TALER\-MINT\-DBINIT 1 "Apr 22, 2015" "GNU Taler"
.SH NAME
taler\-mint\-dbinit \- Initialize Taler mint database.
.SH SYNOPSIS
.B taler\-mint\-dbinit
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-mint\-dbinit\fP is a command line tool to initialize the Taler mint database. It creates the necessary tables and indices for the Taler mint to operate.
.SH OPTIONS
.B
.IP "\-d DIRNAME, \-\-mint-dir=DIRNAME"
Use the configuration and other resources for the mint to operate from DIRNAME.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-v, \-\-version"
Print version information.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-mint\-httpd\fP(1), \fBtaler\-mint\-keyup\fP(1), \fBtaler\-mint\-reservemod\fP(1), \fBtaler.conf\fP(5)

29
doc/taler-mint-httpd.1 Normal file
View File

@ -0,0 +1,29 @@
.TH TALER\-MINT\-HTTPD 1 "Apr 22, 2015" "GNU Taler"
.SH NAME
taler\-mint\-httpd \- Run Taler mint (with RESTful API)
.SH SYNOPSIS
.B taler\-mint\-httpd
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-mint\-httpd\fP is a command line tool to run the Taler mint (HTTP server). The required configuration, keys and database must exist before running this command.
.SH OPTIONS
.B
.IP "\-d DIRNAME, \-\-mint-dir=DIRNAME"
Use the configuration and other resources for the mint to operate from DIRNAME.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-v, \-\-version"
Print version information.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-mint\-dbinit\fP(1), \fBtaler\-mint\-keyup\fP(1), \fBtaler\-mint\-reservemod\fP(1), \fBtaler.conf\fP(5)

29
doc/taler-mint-keycheck.1 Normal file
View File

@ -0,0 +1,29 @@
.TH TALER\-MINT\-KEYCHECK 1 "Apr 22, 2015" "GNU Taler"
.SH NAME
taler\-mint\-keycheck \- Check validity of Taler signing and denomination keys.
.SH SYNOPSIS
.B taler\-mint\-keycheck
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-mint\-keycheck\fP can be used to check if the signing and denomination keys in the operation directory are well-formed. This can be useful after importing fresh keys from the offline system to ensure that the files are correct.
.SH OPTIONS
.B
.IP "\-d DIRNAME, \-\-mint-dir=DIRNAME"
Use the configuration and other resources for the mint to operate from DIRNAME.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-v, \-\-version"
Print version information.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-mint\-httpd\fP(1), \fBtaler\-mint\-keyup\fP(1), \fBtaler\-mint\-dbinit\fP(1), \fBtaler.conf\fP(5)

35
doc/taler-mint-keyup.1 Normal file
View File

@ -0,0 +1,35 @@
.TH TALER\-MINT\-KEYUP 1 "Apr 22, 2015" "GNU Taler"
.SH NAME
taler\-mint\-keyup \- Setup Taler mint denomination and signing keys.
.SH SYNOPSIS
.B taler\-mint\-keyup
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-mint\-keyup\fP is a command line tool to setup Taler denomination and signing keys. This tool requires access to the mint's long-term offline signing key and should be run in a secure (offline) environment under strict controls. The resulting keys can then be copied to the main online directory where the Taler HTTP server operates.
.SH OPTIONS
.B
.IP "\-d DIRNAME, \-\-mint-dir=DIRNAME"
Use the configuration and other resources for the mint to operate from DIRNAME.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-m FILE, \-\-master-key=FILE"
Location of the private EdDSA offline master key of the mint.
.B
.IP "\-t TIMESTAMP, \-\-time=TIMESTAMP"
Operate as if the current time was TIMESTAMP.
.B
.IP "\-v, \-\-version"
Print version information.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-mint\-httpd\fP(1), \fBtaler\-mint\-keyup\fP(1), \fBtaler\-mint\-keycheck\fP(1), \fBtaler.conf\fP(5)

35
doc/taler-mint-reservemod.1 Normal file
View File

@ -0,0 +1,35 @@
.TH TALER\-MINT\-RESERVEMOD 1 "Apr 22, 2015" "GNU Taler"
.SH NAME
taler\-mint\-reservemod \- Modify reserve balance in the Taler mint database.
.SH SYNOPSIS
.B taler\-mint\-reservemod
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-mint\-reservemod\fP is a command line tool to modify reserves in the Taler mint database. Basically, it can be used to import deposits, either for testing or as part of the import from the list of incoming transactions.
.SH OPTIONS
.B
.IP "\-a DENOM, \-\-add=DENOM"
Amount to add to the reserve.
.B
.IP "\-d DIRNAME, \-\-mint-dir=DIRNAME"
Use the configuration and other resources for the mint to operate from DIRNAME.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-R KEY, \-\-reserve=KEY"
Public EdDSA key of the reserve to modify.
.B
.IP "\-v, \-\-version"
Print version information.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-mint\-httpd\fP(1), \fBtaler\-mint\-keyup\fP(1), \fBtaler\-mint\-dbinit\fP(1), \fBtaler.conf\fP(5)

67
doc/taler.conf.5 Normal file
View File

@ -0,0 +1,67 @@
.TH TALER.CONF 5 "Apr 22, 2015" "GNU Taler"
.SH NAME
taler.conf \- Taler configuration file.
.SH SYNOPSIS
.B DIRNAME/taler.conf
.SH DESCRIPTION
The basic structure of the configuration file is the following. The file is split into sections. Every section begins with "[SECTIONNAME]" and contains a number of options of the form "OPTION=VALUE". Empty lines and lines beginning with a "#" are treated as comments.
.SH MINT OPTIONS
The following options are from the "[mint]" section and used by most mint tools:
.IP CURRENCY
Name of the currency, i.e. "EUR" for Euro.
.IP WIREFORMAT
Format used for wire transfers to the merchant, i.e. "SEPA".
.IP DB
How to access the database, i.e. "postgres:///taler"
.IP PORT
Port on which the HTTP server listens, i.e. 8080.
.IP MASTER_PUBLIC_KEY
Crockford Base32-encoded master public key, public version of the mint\'s long\-time offline signing key.
.SH COIN OPTIONS
The following options must be in sections starting with "[coin_]" and are used by taler\-mint\-keyup to create denomination keys:
.IP VALUE
Value of the coin, i.e. "EUR:1.50" for 1 Euro and 50 Cents (per coin).
.IP DURATION_OVERLAP
How much should validity periods for these coins overlap?
.IP DURATION_WITHDRAW
How long should the same key be used for clients to withdraw coins of this value?
.IP DURATION_SPEND
How long do clients have to spend these coins?
.IP FEE_WITHDRAW
What fee is charged for withdrawl?
.IP FEE_DEPOSIT
What fee is charged for depositing?
.IP FEE_REFRESH
What fee is charged for refreshing?
.IP RSA_KEYSIZE
What is the RSA keysize modulos (in bits)?
.SH KEY OPTIONS
The following options are from the "[mint_keys]" section and used by most taler\-mint\-keyup to create keys:
.IP SIGNKEY_DURATION
For how long is a signing key valid?
.IP LEGAL_DURATION
For how long are signatures with signing keys legally valid?
.IP LOOKAHEAD_SIGN
How long do we generate denomination and signing keys ahead of time?
.IP LOOKAHEAD_PROVIDE
How long into the future do we provide signing and denomination keys to clients?
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-mint\-httpd\fP(1), \fBtaler\-mint\-keyup\fP(1), \fBtaler\-mint\-reservemod\fP(1), \fBtaler\-mint\-dbinit\fP(1)