diff options
author | ng0 <ng0@n0.is> | 2019-05-10 10:56:49 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-05-10 10:56:49 +0000 |
commit | 3f9aafdc725e91480d6d3083459d8b941626af9b (patch) | |
tree | 15132765d583fbb78c5ca51f3474cfc9ca710576 /doc/taler-exchange-httpd.1 | |
parent | 39263a48d3c2b48eb9178f56c549bd4d34a18050 (diff) | |
download | exchange-3f9aafdc725e91480d6d3083459d8b941626af9b.tar.xz |
doc fixes in format and typos.
Diffstat (limited to 'doc/taler-exchange-httpd.1')
-rw-r--r-- | doc/taler-exchange-httpd.1 | 140 |
1 files changed, 88 insertions, 52 deletions
diff --git a/doc/taler-exchange-httpd.1 b/doc/taler-exchange-httpd.1 index 0db571382..9cb178abf 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 immediately exit. This is useful to test taler\-exchange\-httpd against many different possible inputs in a controlled way. -.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 <taler@gnu.org> - -.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 taler@gnu.org . |