gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] [taler-exchange] branch master updated: doc fixes in format


From: gnunet
Subject: [GNUnet-SVN] [taler-exchange] branch master updated: doc fixes in format and typos.
Date: Fri, 10 May 2019 12:57:14 +0200

This is an automated email from the git hooks/post-receive script.

ng0 pushed a commit to branch master
in repository exchange.

The following commit(s) were added to refs/heads/master by this push:
     new 3f9aafdc doc fixes in format and typos.
3f9aafdc is described below

commit 3f9aafdc725e91480d6d3083459d8b941626af9b
Author: ng0 <address@hidden>
AuthorDate: Fri May 10 10:56:49 2019 +0000

    doc fixes in format and typos.
---
 doc/taler-exchange-dbinit.1    |  78 +++++++++++++----------
 doc/taler-exchange-httpd.1     | 140 ++++++++++++++++++++++++++---------------
 doc/taler-exchange-keycheck.1  |  64 +++++++++++--------
 doc/taler-exchange-keyup.1     |  88 +++++++++++++++-----------
 doc/taler-exchange-wire.1      |  58 +++++++++--------
 doc/taler-exchange-wirewatch.1 |  68 +++++++++++---------
 6 files changed, 290 insertions(+), 206 deletions(-)

diff --git a/doc/taler-exchange-dbinit.1 b/doc/taler-exchange-dbinit.1
index a1559959..c534b01e 100644
--- a/doc/taler-exchange-dbinit.1
+++ b/doc/taler-exchange-dbinit.1
@@ -1,35 +1,47 @@
-.TH TALER\-EXCHANGE\-DBINIT 1 "May 31, 2016" "GNU Taler"
-
-.SH NAME
-taler\-exchange\-dbinit \- Initialize Taler exchange database.
-
-.SH SYNOPSIS
-.B taler\-exchange\-dbinit
-.RI [ options ]
-.br
-
-.SH DESCRIPTION
-\fBtaler\-exchange\-dbinit\fP is a command line tool to initialize the Taler 
exchange database.  It creates the necessary tables and indices for the Taler 
exchange to operate.
-
-.SH OPTIONS
-.B
-.IP "\-d DIRNAME,  \-\-exchange-dir=DIRNAME"
-Use the configuration and other resources for the exchange to operate from 
DIRNAME.
-.B
-.IP "\-h, \-\-help"
+.Dd May 31, 2016
+.Dt TALER-EXCHANGE-DBINIT 1
+.Os
+.Sh NAME
+.Nm taler-exchange-dbinit
+.Nd Initialize Taler exchange database.
+.Sh SYNOPSIS
+.Nm
+.Op Fl d Ar DIRNAME | Fl -exchange-dir= Ns Ar DIRNAME
+.Op Fl h | -help
+.Op Fl g | -gc
+.Op Fl r | -reset
+.Op Fl v | -version
+.Sh DESCRIPTION
+.Nm
+is a command line tool to initialize the Taler exchange database.
+It creates the necessary tables and indices for the Taler exchange
+to operate.
+.Pp
+Its options are as follows:
+.Bl -tag -width indent
+.It Fl d Ar DIRNAME | Fl -exchange-dir= Ns Ar DIRNAME
+Use the configuration and other resources for the exchange to
+operate from
+.Ar DIRNAME .
+.It Fl h | -help
 Print short help on options.
-.B
-.IP "\-g, \-\-gc"
-Garbage collect database.  Deletes all unnecessary data in the database.
-.B
-.IP "\-r, \-\-reset"
-Drop tables. Dangerous, will delete all existing data in the database before 
creating the tables.
-.B
-.IP "\-v, \-\-version"
+.It Fl g | -gc
+Garbage collect database.
+Deletes all unnecessary data in the database.
+.It Fl r | -reset
+Drop tables.
+Dangerous, will delete all existing data in the database before
+creating the tables.
+.It Fl v | -version
 Print version information.
-
-.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
-
-.SH "SEE ALSO"
-\fBtaler\-exchange\-httpd\fP(1), \fBtaler\-exchange\-keyup\fP(1), 
\fBtaler\-exchange\-reservemod\fP(1), \fBtaler.conf\fP(5)
+.El
+.Sh SEE ALSO
+.Xr taler-exchange-httpd 1 ,
+.Xr taler-exchange-keyup 1 ,
+.Xr taler-exchange-reservemod 1 ,
+.Xr taler.conf 5 .
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt address@hidden .
diff --git a/doc/taler-exchange-httpd.1 b/doc/taler-exchange-httpd.1
index 0db57138..9cb178ab 100644
--- a/doc/taler-exchange-httpd.1
+++ b/doc/taler-exchange-httpd.1
@@ -1,56 +1,92 @@
-.TH TALER\-EXCHANGE\-HTTPD 1 "Apr 22, 2015" "GNU Taler"
-
-.SH NAME
-taler\-exchange\-httpd \- Run Taler exchange (with RESTful API)
-
-.SH SYNOPSIS
-.B taler\-exchange\-httpd
-.RI [ options ]
-.br
-
-.SH DESCRIPTION
-\fBtaler\-exchange\-httpd\fP is a command line tool to run the Taler exchange 
(HTTP server).  The required configuration, keys and database must exist before 
running this command.
-
-.SH OPTIONS
-.B
-.IP "\-C,  \-\-connection-close"
-Force each HTTP connection to be closed after each request (useful in 
combination with \-f to avoid having to wait for nc to time out).
-.B
-.IP "\-c FILENAME,  \-\-config=FILENAME"
-Use the configuration and other resources for the merchant to operate from 
FILENAME.
-.B
-.IP "\-h, \-\-help"
+.Dd April 22, 2015
+.Dt TALER-EXCHANGE-HTTPD 1
+.Os
+.Sh NAME
+.Nm taler-exchange-httpd
+.Nd Run Taler exchange (with RESTful API)
+.Sh SYNOPSIS
+.Nm
+.Op Fl C | -connection-close
+.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl f Ar FILENAME | Fl -file-input= Ns Ar FILENAME
+.Op Fl h | -help
+.Op Fl i | -init-db
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+.Op Fl t Ar SECONDS | Fl -timeout= Ns Ar SECONDS
+.Op Fl v | -version
+.Sh DESCRIPTION
+.Nm
+is a command line tool to run the Taler exchange (HTTP server).
+The required configuration, keys and database must exist before
+running this command.
+.Pp
+Its options are as follows:
+.Bl -tag -width indent
+.It Fl C | -connection-close
+Force each HTTP connection to be closed after each request (useful
+in combination with
+.Fl f
+to avoid having to wait for nc to time out).
+.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+Use the configuration and other resources for the merchant to operate
+from FILENAME.
+.It Fl h | -help
 Print short help on options.
-.B
-.IP "\-i, \-\-init-db"
+.It Fl i | -init-db
 Initialize the database by creating tables and indices if necessary.
-.B
-.IP "\-v, \-\-version"
+.It Fl v | -version
 Print version information.
-.B
-.IP "\-f FILENAME, \-\-file\-input=FILENAME"
-This option is only available if the exchange was compiled with the configure 
option
-\-\-enable\-developer\-mode.  It is used for generating test cases against the 
exchange using AFL.  When this option is present, the HTTP server will (1) 
terminate after the first client's HTTP connection is completed, and (2) 
automatically start such a client using a helper process based on the 'nc' or 
'ncat' binary using FILENAME as the standard input to the helper process.  As a 
result, the process will effectively run with FILENAME as the input from an 
HTTP client and then immediatel [...]
-.B
-.IP "\-t SECONDS, \-\-timeout=SECONDS"
-Specifies the number of SECONDS after which the HTTPD should close (idle) HTTP 
connections.
-.B
-.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Specifies the log level to use.  Accepted values are: DEBUG, INFO, WARNING, 
ERROR.
-
-.SH SIGNALS
-.B
-.IP SIGUSR1
-Sending a SIGUSR1 to the process will cause it to reload denomination and 
signing keys.
-.B
-.IP SIGTERM
+.It Fl f Ar FILENAME | Fl -file-input= Ns Ar FILENAME
+This option is only available if the exchange was compiled with the
+configure option --enable-developer-mode.
+It is used for generating test cases against the exchange using AFL.
+When this option is present, the HTTP server will
+.Bl -enum -offset indent -compact
+.It
+terminate after the first client's HTTP connection is completed, and
+.It
+automatically start such a client using a helper process based on the
+.Xr nc 1
+or
+.Xr ncat 1
+binary using FILENAME as the standard input to the helper process.
+.El
+As a result, the process will effectively run with
+.Ar FILENAME
+as the input from an HTTP client and then immediately exit.
+This is useful to test taler-exchange-httpd against many different
+possible inputs in a controlled way.
+.It Fl t Ar SECONDS | Fl -timeout= Ns Ar SECONDS
+Specifies the number of SECONDS after which the HTTPD should
+close (idle) HTTP connections.
+.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+Specifies the log level to use.
+Accepted values are: DEBUG, INFO, WARNING, ERROR.
+.El
+.Sh SIGNALS
+.Nm
+responds to the following signals:
+.Bl -tag -width indent
+.It Dv SIGUSR1
+Sending a SIGUSR1 to the process will cause it to reload denomination
+and signing keys.
+.It Dv SIGTERM
 Sending a SIGTERM to the process will cause it to shutdown cleanly.
-.B
-.IP SIGHUP
-Sending a SIGHUP to the process will cause it to re-execute the 
taler\-exchange\-httpd binary in the PATH, passing it the existing listen 
socket. Then the old server process will automatically exit after it is done 
handling existing client connections; the new server process will accept and 
handle new client connections.
-
-.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
-
-.SH "SEE ALSO"
-\fBtaler\-exchange\-dbinit\fP(1), \fBtaler\-exchange\-keyup\fP(1), 
\fBtaler\-exchange\-reservemod\fP(1), \fBtaler.conf\fP(5)
+.It Dv SIGHUP
+Sending a SIGHUP to the process will cause it to re-execute the
+taler-exchange-httpd binary in the PATH, passing it the existing
+listen socket.
+Then the old server process will automatically exit after it is done
+handling existing client connections; the new server process will
+accept and handle new client connections.
+.El
+.Sh SEE ALSO
+.Xr taler-exchange-dbinit 1 ,
+.Xr taler-exchange-keyup 1 ,
+.Xr taler-exchange-reservemod 1 ,
+.Xr taler.conf 5 .
+.Sh BUGS
+Report bugs by using
+.Lk https://gnunet.org/bugs
+or by sending electronic mail to
+.Aq Mt address@hidden .
diff --git a/doc/taler-exchange-keycheck.1 b/doc/taler-exchange-keycheck.1
index 3f338233..ca97c3da 100644
--- a/doc/taler-exchange-keycheck.1
+++ b/doc/taler-exchange-keycheck.1
@@ -1,29 +1,39 @@
-.TH TALER\-EXCHANGE\-KEYCHECK 1 "Apr 22, 2015" "GNU Taler"
-
-.SH NAME
-taler\-exchange\-keycheck \- Check validity of Taler signing and denomination 
keys.
-
-.SH SYNOPSIS
-.B taler\-exchange\-keycheck
-.RI [ options ]
-.br
-
-.SH DESCRIPTION
-\fBtaler\-exchange\-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,  \-\-exchange-dir=DIRNAME"
-Use the configuration and other resources for the exchange to operate from 
DIRNAME.
-.B
-.IP "\-h, \-\-help"
+.Dd April 22, 2015
+.Dt TALER-EXCHANGE-KEYCHECK 1
+.Os
+.Sh NAME
+.Nm taler\-exchange\-keycheck
+.Nd check validity of Taler signing and denomination keys
+.Sh SYNOPSIS
+.Nm
+.Op Fl d Ar DIRNAME | Fl -exchange-dir= Ns Ar DIRNAME
+.Op Fl h | -help
+.Op Fl v | -version
+.Sh DESCRIPTION
+.Nm
+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.
+.Pp
+Its options are as follows:
+.Bl -tag -width indent
+.It Fl d Ar DIRNAME | Fl -exchange-dir= Ns Ar DIRNAME
+Use the configuration and other resources for the exchange
+to operate from
+.Ar DIRNAME .
+.It Fl h | -help
 Print short help on options.
-.B
-.IP "\-v, \-\-version"
+.It Fl v | -version
 Print version information.
-
-.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
-
-.SH "SEE ALSO"
-\fBtaler\-exchange\-httpd\fP(1), \fBtaler\-exchange\-keyup\fP(1), 
\fBtaler\-exchange\-dbinit\fP(1), \fBtaler.conf\fP(5)
+.El
+.Sh SEE ALSO
+.Xr taler-exchange-httpd 1 ,
+.Xr taler-exchange-keyup 1 ,
+.Xr taler-exchange-dbinit 1 ,
+.Xr taler.conf 5 .
+.Sh BUGS
+Report bugs by using
+.Lk https://gnunet.org/bugs/
+or by sending electronic mail to
+.Aq Mt address@hidden .
diff --git a/doc/taler-exchange-keyup.1 b/doc/taler-exchange-keyup.1
index 7859d8a8..61cca2fe 100644
--- a/doc/taler-exchange-keyup.1
+++ b/doc/taler-exchange-keyup.1
@@ -1,41 +1,55 @@
-.TH TALER\-EXCHANGE\-KEYUP 1 "Apr 7, 2017" "GNU Taler"
-
-.SH NAME
-taler\-exchange\-keyup \- Setup Taler exchange denomination and signing keys.
-
-.SH SYNOPSIS
-.B taler\-exchange\-keyup
-.RI [ options ]
-.br
-
-.SH DESCRIPTION
-\fBtaler\-exchange\-keyup\fP is a command line tool to setup Taler 
denomination and signing keys.  This tool requires access to the exchange'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,  \-\-exchange-dir=DIRNAME"
-Use the configuration and other resources for the exchange to operate from 
DIRNAME.
-.B
-.IP "\-h, \-\-help"
+.Dd April 7, 2017
+.Dt TALER\-EXCHANGE\-KEYUP 1
+.Os
+.Sh NAME
+.Nm taler\-exchange\-keyup
+.Nd setup Taler exchange denomination and signing keys
+.Sh SYNOPSIS
+.Nm
+.Op Fl d Ar DIRNAME | Fl -exchange-dir= Ns Ar DIRNAME
+.Op Fl h | -help
+.Op Fl m Ar FILE | Fl -master-key= Ns Ar FILE
+.Op Fl o Ar FILE | Fl -output= Ns Ar FILE
+.Op Fl r Ar DKH | Fl -revoke= Ns Ar DKH
+.Op Fl t Ar TIMESTAMP | Fl -time= Ns Ar TIMESTAMP
+.Op Fl v | -version
+.Sh DESCRIPTION
+.Nm
+is a command line tool to setup Taler denomination and signing keys.
+This tool requires access to the exchange'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.
+.Pp
+Its options are as follows:
+.Bl -tag -width indent
+.It Fl d Ar DIRNAME | Fl -exchange-dir= Ns Ar DIRNAME
+Use the configuration and other resources for the exchange to
+operate from
+.Ar DIRNAME .
+.It Fl h | -help
 Print short help on options.
-.B
-.IP "\-m FILE,  \-\-master-key=FILE"
+.It Fl m Ar FILE | Fl -master-key= Ns Ar FILE
 Location of the private EdDSA offline master key of the exchange.
-.B
-.IP "\-o FILE,  \-\-ouptut=FILE"
-Where to write a denomination key signing request file to be given to the 
auditor.
-.B
-.IP "\-r DKH,  \-\-revoke=DKH"
+.It Fl o Ar FILE | Fl -output= Ns Ar FILE
+Where to write a denomination key signing request file to be given
+to the auditor.
+.It Fl r Ar DKH | Fl -revoke= Ns Ar DKH
 Revoke the denomination key where the denomination public key's hash is DKH.
-.B
-.IP "\-t TIMESTAMP,  \-\-time=TIMESTAMP"
-Operate as if the current time was TIMESTAMP.
-.B
-.IP "\-v, \-\-version"
+.It Fl t Ar TIMESTAMP | Fl -time= Ns Ar TIMESTAMP
+Operate as if the current time was
+.Ar TIMESTAMP .
+.It Fl v | -version
 Print version information.
-
-.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
-
-.SH "SEE ALSO"
-\fBtaler\-exchange\-httpd\fP(1), \fBtaler\-exchange\-keyup\fP(1), 
\fBtaler\-exchange\-keycheck\fP(1), \fBtaler.conf\fP(5)
+.El
+.Sh SEE ALSO
+.Xr taler-exchange-httpd 1 ,
+.Xr taler-exchange-keyup 1 ,
+.Xr taler-exchange-keycheck 1 ,
+.Xr taler.conf 5 .
+.Sh BUGS
+Report bugs by using
+.Lk https://gnunet.org/bugs/
+or by sending electronic mail to
+.Aq Mt address@hidden .
diff --git a/doc/taler-exchange-wire.1 b/doc/taler-exchange-wire.1
index 256daab7..d4970446 100644
--- a/doc/taler-exchange-wire.1
+++ b/doc/taler-exchange-wire.1
@@ -1,28 +1,34 @@
-.TH TALER\-EXCHANGE\-WIRE 1 "Mar 18, 2018" "GNU Taler"
-
-.SH NAME
-taler\-exchange\-wire \- Create the master-key signed responses to /wire.
-
-.SH SYNOPSIS
-.B taler\-exchange\-wire
-.RI [ options ]
-.br
-
-.SH DESCRIPTION
-\fBtaler\-exchange\-wire\fP is used to create the exchange's reply to a /wire 
request.  It converts the bank details into the appropriate signed response.  
This needs to be done using the long-term offline master key.
-
-.SH OPTIONS
-.B
-.IP "\-m MASTERKEYFILE,  \-\-master=MASTERKEYFILE"
-Specifies the name of the file containing the exchange's master key.
-.IP "\-h, \-\-help"
+.Dd March 18, 2018
+.Dt TALER-EXCHANGE-WIRE 1
+.Os
+.Sh NAME
+.Nm taler-exchange-wire
+.Nd create the master-key signed responses to /wire
+.Sh SYNOPSIS
+.Nm
+.Op Fl h | -help
+.Op Fl m Ar MASTERKEYFILE | Fl -master= Ns Ar MASTERKEYFILE
+.Op Fl v | -version
+.Sh DESCRIPTION
+.Nm
+is used to create the exchange's reply to a /wire request.
+It converts the bank details into the appropriate signed response.
+This needs to be done using the long-term offline master key.
+.Pp
+Its options are as follows:
+.Bl -tag -width indent
+.It Fl h | -help
 Print short help on options.
-.B
-.IP "\-v, \-\-version"
+.It Fl m Ar MASTERKEYFILE | Fl -master= Ns Ar MASTERKEYFILE
+Specifies the name of the file containing the exchange's master key.
+.It Fl v | -version
 Print version information.
-
-.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
-
-.SH "SEE ALSO"
-\fBtaler\-exchange\-httpd\fP(1), \fBtaler.conf\fP(5)
+.El
+.Sh SEE ALSO
+.Xr taler-exchange-httpd 1 ,
+.Xr taler.conf 5 .
+.Sh BUGS
+Report bugs by using
+.Lk https://gnunet.org/bugs/
+or by sending electronic mail to
+.Aq Mt address@hidden .
diff --git a/doc/taler-exchange-wirewatch.1 b/doc/taler-exchange-wirewatch.1
index 9b030ab3..447e1217 100644
--- a/doc/taler-exchange-wirewatch.1
+++ b/doc/taler-exchange-wirewatch.1
@@ -1,35 +1,41 @@
-.TH TALER\-EXCHANGE\-WIREWATCH 1 "May 5, 2017" "GNU Taler"
-
-.SH NAME
-taler\-exchange\-wirewatch \- Watch for incoming wire transfers
-
-.SH SYNOPSIS
-.B taler\-exchange\-wirewatch
-.RI [ options ]
-.br
-
-.SH DESCRIPTION
-\fBtaler\-exchange\-wirewatch\fP is a command line tool to import wire 
transactions into the Taler exchange database.
-
-.SH OPTIONS
-.B
-.IP "\-t PLUGINNAME,  \-\-type=PLUGINNAME"
+.Dd May 5, 2017
+.Dt TALER-EXCHANGE-WIREWATCH 1
+.Os
+.Sh NAME
+.Nm taler-exchange-wirewatch
+.Nd watch for incoming wire transfers
+.Sh SYNOPSIS
+.Nm
+.Op Fl t Ar PLUGINNAME | Fl -type= Ns Ar PLUGINNAME
+.Op Fl h | -help
+.Op Fl T | -test
+.Op Fl r | -reset
+.Op Fl v | -version
+.Sh DESCRIPTION
+.Nm
+is a command line tool to import wire transactions into the
+Taler exchange database.
+.Pp
+Its options are as follows:
+.Bl -tag -width indent
+.It Fl t Ar PLUGINNAME | Fl -type= Ns Ar PLUGINNAME
 Use the specified wire plugin and its configuration to talk to the bank.
-.B
-.IP "\-h, \-\-help"
+.It Fl h | -help
 Print short help on options.
-.B
-.IP "\-T,  \-\-test"
+.It Fl T | -test
 Run in test mode and exit when idle.
-.B
-.IP "\-r,  \-\-reset"
-Ignore our own database and start with transactions from the beginning of time.
-.B
-.IP "\-v, \-\-version"
+.It Fl r | -reset
+Ignore our own database and start with transactions
+from the beginning of time.
+.It Fl v | -version
 Print version information.
-.B
-.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
-
-.SH "SEE ALSO"
-\fBtaler\-exchange\-aggregator\fP(1), \fBtaler\-exchange\-httpd\fP(1), 
\fBtaler.conf\fP(5)
+.El
+.Sh SEE ALSO
+.Xr taler-exchange-aggregator 1 ,
+.Xr taler-exchange-httpd 1 ,
+.Xr taler.conf 5 .
+.Sh BUGS
+Report bugs by using
+.Lk https://gnunet.org/bugs/
+or by sending electronic mail to
+.Aq Mt address@hidden .

-- 
To stop receiving notification emails like this one, please contact
address@hidden



reply via email to

[Prev in Thread] Current Thread [Next in Thread]