From 8bf2952c875e9b5660ca6b27b8ec09d8682b34d0 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Tue, 30 Sep 2014 21:53:46 +0000 Subject: Adding man pages from Bertrand Marc. Thanks! --- doc/man/Makefile.am | 4 ++++ doc/man/gnunet-qr.1 | 32 ++++++++++++++++++++++++++++ doc/man/gnunet-scrypt.1 | 44 +++++++++++++++++++++++++++++++++++++++ doc/man/gnunet-testbed-profiler.1 | 44 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 124 insertions(+) create mode 100644 doc/man/gnunet-qr.1 create mode 100644 doc/man/gnunet-scrypt.1 create mode 100644 doc/man/gnunet-testbed-profiler.1 (limited to 'doc/man') diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 6bc86cebf..b6d9a4a18 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -3,6 +3,7 @@ man_MANS = \ gnunet-arm.1 \ gnunet-ats.1 \ gnunet-auto-share.1 \ + gnunet-bcd.1 \ gnunet-config.1 \ gnunet-core.1 \ gnunet-conversation.1 \ @@ -25,11 +26,14 @@ man_MANS = \ gnunet-nat-server.1 \ gnunet-peerinfo.1 \ gnunet-publish.1 \ + gnunet-qr.1 \ gnunet-resolver.1 \ gnunet-revocation.1 \ gnunet-scalarproduct.1 \ + gnunet-scrypt.1 \ gnunet-search.1 \ gnunet-statistics.1 \ + gnunet-testbed-profiler.1 \ gnunet-testing-run-service.1 \ gnunet-transport.1 \ gnunet-transport-certificate-creation.1 \ diff --git a/doc/man/gnunet-qr.1 b/doc/man/gnunet-qr.1 new file mode 100644 index 000000000..6c3261d02 --- /dev/null +++ b/doc/man/gnunet-qr.1 @@ -0,0 +1,32 @@ +.TH GNUNET\-QR 1 "Sep 13, 2014" "GNUnet" + +.SH NAME +gnunet\-qr \- Scan a QR code using a video device and import. + +.SH SYNOPSIS +.B gnunet\-qr +.RI [ options ] +.br + +.SH DESCRIPTION +\fBgnunet\-qr\fP is a command line tool to scan a QR code using a video device and import. + +.SH OPTIONS +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-d DEVICE, \-\-device=DEVICE" +Use device DEVICE. +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-s, \-\-silent" +Do not show preview windows. +.B +.IP "\-v, \-\-verbose" +Be verbose. + +.SH BUGS +Report bugs by using Mantis or by sending electronic mail to diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1 new file mode 100644 index 000000000..3b11ca52e --- /dev/null +++ b/doc/man/gnunet-scrypt.1 @@ -0,0 +1,44 @@ +.TH GNUNET\-SCRYPT 1 "Sep 13, 2014" "GNUnet" + +.SH NAME +gnunet\-scrypt \- Manipulate GNUnet proof of work files. + +.SH SYNOPSIS +.B gnunet\-scrypt +.RI [ options ] +.br + +.SH DESCRIPTION +\fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof of work files. + +.SH OPTIONS +.B +.IP "\-b BITS, \-\-bits=BITS" +Number of bits to require for the proof of work. +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-k FILE, \-\-keyfile=FILE" +File with private key, otherwise default is used. +.B +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" +Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. +.B +.IP "\-l LOGFILE, \-\-logfile=LOGFILE" +Configure logging to write logs to LOGFILE. +.B +.IP "\-o FILE, \-\-outfile=FILE" +File with proof of work, otherwise default is used. +.B +.IP "\-t TIME, \-\-timeout=TIME" +Time to wait between calculations. +.B +.IP "\-v, \-\-version" +Print GNUnet version number. + +.SH BUGS +Report bugs by using Mantis or by sending electronic mail to diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-testbed-profiler.1 new file mode 100644 index 000000000..3911085f2 --- /dev/null +++ b/doc/man/gnunet-testbed-profiler.1 @@ -0,0 +1,44 @@ +.TH GNUNET\-TESTBED\-PROFILER 1 "Sep 13, 2014" "GNUnet" + +.SH NAME +gnunet\-testbed\-profiler \- Profiling driver for the testbed. + +.SH SYNOPSIS +.B gnunet\-testbed\-profiler +.RI [ options ] +.br + +.SH DESCRIPTION +\fBgnunet\-testbed\-profiler\fP is a command line profiling driver for the testbed. + +.SH OPTIONS +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-e COUNT, \-\-num\-errors=COUNT" +Tolerate COUNT number of continious timeout failures. +.B +.IP "\-H FILENAME, \-\-hosts=FILENAME" +Name of the file with the login information for the testbed. +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" +Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. +.B +.IP "\-l LOGFILE, \-\-logfile=LOGFILE" +Configure logging to write logs to LOGFILE. +.B +.IP "\-n, \-\-non\-interactive" +Run profiler in non-interactive mode where upon testbed setup the profiler does not wait for a keystroke but continues to run until a termination signal is received. +.B +.IP "\-p COUNT, \-\-num\-peers=COUNT" +Create COUNT number of peers. +.B +.IP "\-v, \-\-version" +Print GNUnet version number. + +.SH BUGS +Report bugs by using Mantis or by sending electronic mail to -- cgit v1.2.3