summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2014-01-31 15:22:57 +0000
committerChristian Grothoff <christian@grothoff.org>2014-01-31 15:22:57 +0000
commit12e3ee5beb64ee106df8e8974c228a003a676a53 (patch)
tree996dd9559467b5287333aa07b0821ba8255a65ad /doc
parent74cfcca085115026f8e7c2b17168c72ed9a70240 (diff)
importing man pages written by Bertrand Marc for Debian
Diffstat (limited to 'doc')
-rw-r--r--doc/man/Makefile.am5
-rw-r--r--doc/man/gnunet-gns-import.117
-rw-r--r--doc/man/gnunet-resolver.115
-rw-r--r--doc/man/gnunet-testing-run-service.130
-rw-r--r--doc/man/gnunet-testing.147
-rw-r--r--doc/man/gnunet-transport-certificate-creation.119
6 files changed, 125 insertions, 8 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 0154229e3..7417b3fb5 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -15,19 +15,24 @@ man_MANS = \
gnunet-ecc.1 \
gnunet-fs.1 \
gnunet-gns.1 \
+ gnunet-gns-import.1 \
gnunet-gns-proxy.1 \
gnunet-identity.1 \
+ gnunet-mesh.1 \
gnunet-namecache.1 \
gnunet-namestore.1 \
gnunet-namestore-fcfsd.1 \
gnunet-nat-server.1 \
gnunet-peerinfo.1 \
gnunet-publish.1 \
+ gnunet-resolver.1 \
gnunet-revocation.1 \
gnunet-scalarproduct.1 \
gnunet-search.1 \
gnunet-statistics.1 \
+ gnunet-testing-run-service.1 \
gnunet-transport.1 \
+ gnunet-transport-certificate-creation.1 \
gnunet-unindex.1 \
gnunet-uri.1 \
gnunet-vpn.1
diff --git a/doc/man/gnunet-gns-import.1 b/doc/man/gnunet-gns-import.1
new file mode 100644
index 000000000..f90f7f375
--- /dev/null
+++ b/doc/man/gnunet-gns-import.1
@@ -0,0 +1,17 @@
+.TH GNUNET\-GNS\-IMPORT 1 "Jan 31, 2014" "GNUnet"
+
+.SH NAME
+gnunet\-gns\-import \- import some GNS authorities into your GNS namestore
+
+.SH SYNOPSIS
+.B gnunet\-gns\-import
+.br
+
+.SH DESCRIPTION
+\fBgnunet\-gns\-import\fP calls gnunet-namestore to fetch some GNS authorities into your GNS namestore.
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+
+.SH SEE ALSO
+gnunet\-gns(1), gnunet\-namestore(1)
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-resolver.1
index 0666f65df..0c314bc66 100644
--- a/doc/man/gnunet-resolver.1
+++ b/doc/man/gnunet-resolver.1
@@ -1,15 +1,15 @@
.TH GNUNET\-RESOLVER 1 "Jan 4, 2012" "GNUnet"
.SH NAME
-gnunet\-resolver \- perform DNS resolution using GNUnet resolver service
+gnunet\-resolver \- build-in GNUnet stub resolver
.SH SYNOPSIS
.B gnunet\-resolver
-.RI [ options ] HOSTNAME
+.RI [ options ] [ hostname ]
.br
.SH DESCRIPTION
-\fBgnunet\-resolver\fP can be used to lookup the IP address(es) for a hostname or the hostname for an IP address. gnunet\-resolver uses the GNUnet service infrastructure to do this, but otherwise does nothing special.
+\fBgnunet\-resolver\fP uses build-in GNUnet stub resolver.
.SH OPTIONS
.B
@@ -22,15 +22,14 @@ Print short help on options.
.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 "\-r, \-\-reverse"
Perform a reverse lookup.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.
-
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org>
-
-.SH SEE ALSO
-gnunet\-transport(1), nslookup(1)
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
diff --git a/doc/man/gnunet-testing-run-service.1 b/doc/man/gnunet-testing-run-service.1
new file mode 100644
index 000000000..7df698225
--- /dev/null
+++ b/doc/man/gnunet-testing-run-service.1
@@ -0,0 +1,30 @@
+.TH GNUNET\-TESTING\-RUN\-SERVICE 1 "Aug 25, 2013" "GNUnet"
+
+.SH NAME
+gnunet\-testing\-run\-service \- Command line tool to start a service for testing.
+
+.SH SYNOPSIS
+.B gnunet\-testing\-run\-service
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\fBgnunet\-testing\-run\-service\fP is a command line tool to start a service for testing. It starts a peer, running only the service specified on the command line, outputs the path to the temporary configuration file to stdout.
+
+The peer will run until this program is killed, or stdin is closed. When reading the character 'r' from stdin, the running service is restarted with the same configuration.
+
+This executable is intended to be used by gnunet-java, in order to reliably start and stop services for test cases.
+
+.SH OPTIONS
+.B
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Name of the template configuration file to use (optional).
+.B
+.IP "\-h, \-\-help"
+Print short help on options.
+.B
+.IP "\-s SERVICE, \-\-service=SERVICE"
+Name of the service to run.
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
diff --git a/doc/man/gnunet-testing.1 b/doc/man/gnunet-testing.1
new file mode 100644
index 000000000..82ea62e71
--- /dev/null
+++ b/doc/man/gnunet-testing.1
@@ -0,0 +1,47 @@
+.TH GNUNET\-TESTING 1 "Jan 4, 2012" "GNUnet"
+
+.SH NAME
+gnunet\-testing \- Command line tool to access the testing library.
+
+.SH SYNOPSIS
+.B gnunet\-testing
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\fBgnunet\-testing\fP is a command line tool to access the testing library.
+
+.SH OPTIONS
+.B
+.IP "\-C, \-\-cfg"
+Create unique configuration files.
+.B
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration file FILENAME.
+.B
+.IP "\-H, \-\-hostkeys"
+Host key file.
+.B
+.IP "\-h, \-\-help"
+Print short help on options.
+.B
+.IP "\-k, \-\-key"
+Create hostkey files from pre-computed hostkey list.
+.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, \-\-number"
+Number of unique configuration files or hostkeys to create.
+.B
+.IP "\-t, \-\-template"
+Configuration template.
+.B
+.IP "\-v, \-\-version"
+Print GNUnet version number.
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
diff --git a/doc/man/gnunet-transport-certificate-creation.1 b/doc/man/gnunet-transport-certificate-creation.1
new file mode 100644
index 000000000..89df87f4b
--- /dev/null
+++ b/doc/man/gnunet-transport-certificate-creation.1
@@ -0,0 +1,19 @@
+.TH GNUNET\-TRANSPORT\-CERTIFICATE\-CREATION 1 "Jan 31, 2014" "GNUnet"
+
+.SH NAME
+gnunet\-transport\-certificate\-creation \- create certificate for HTTPS transport
+
+.SH SYNOPSIS
+.B gnunet\-transport\-certificate\-creation
+.I privatekey certificate
+.br
+
+.SH DESCRIPTION
+\fBgnunet\-transport\-certificate\-creation\fP uses openssl to generate a RSA
+private key and then a self-signed certificate for HTTPS transport.
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+
+.SH SEE ALSO
+gnunet\-transport(1)