aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBertrand Marc <beberking@gmail.com>2012-06-06 20:47:48 +0200
committerBertrand Marc <beberking@gmail.com>2012-06-06 20:47:48 +0200
commit740b30688bd745a527f96f9116c19acb3480971a (patch)
tree2709a3f4dba11c174aa9e1ba3612e30c578e76a9 /doc
parent2b81464a43485fcc8ce079fafdee7b7a171835f4 (diff)
Imported Upstream version 0.9.3upstream/0.9.3
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.in2
-rw-r--r--doc/man/Makefile.am4
-rw-r--r--doc/man/Makefile.in6
-rw-r--r--doc/man/gnunet-arm.13
-rw-r--r--doc/man/gnunet-core.135
-rw-r--r--doc/man/gnunet-gns.136
-rw-r--r--doc/man/gnunet-namestore.158
-rw-r--r--doc/man/gnunet-rsa.140
8 files changed, 184 insertions, 0 deletions
diff --git a/doc/Makefile.in b/doc/Makefile.in
index 601e718..f1b7b45 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -159,6 +159,7 @@ INSTALL_SCRIPT = @INSTALL_SCRIPT@
INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
INTLLIBS = @INTLLIBS@
INTL_MACOSX_LIBS = @INTL_MACOSX_LIBS@
+JAVAPORT = @JAVAPORT@
LD = @LD@
LDFLAGS = @LDFLAGS@
LIBADD_DL = @LIBADD_DL@
@@ -192,6 +193,7 @@ LT_DLLOADERS = @LT_DLLOADERS@
LT_DLPREOPEN = @LT_DLPREOPEN@
MAKEINFO = @MAKEINFO@
MKDIR_P = @MKDIR_P@
+MONKEYPREFIX = @MONKEYPREFIX@
MSGFMT = @MSGFMT@
MSGFMT_015 = @MSGFMT_015@
MSGMERGE = @MSGMERGE@
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 6d98ffa..c640460 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,13 +1,17 @@
man_MANS = \
gnunet-arm.1 \
+ gnunet-core.1 \
gnunet-directory.1 \
gnunet-download.1 \
gnunet-download-manager.1 \
gnunet-fs.1 \
+ gnunet-gns.1 \
+ gnunet-namestore.1 \
gnunet-nat-server.1 \
gnunet-peerinfo.1 \
gnunet-pseudonym.1 \
gnunet-publish.1 \
+ gnunet-rsa.1 \
gnunet-search.1 \
gnunet-statistics.1 \
gnunet-transport.1 \
diff --git a/doc/man/Makefile.in b/doc/man/Makefile.in
index f9c665d..76f2b02 100644
--- a/doc/man/Makefile.in
+++ b/doc/man/Makefile.in
@@ -144,6 +144,7 @@ INSTALL_SCRIPT = @INSTALL_SCRIPT@
INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
INTLLIBS = @INTLLIBS@
INTL_MACOSX_LIBS = @INTL_MACOSX_LIBS@
+JAVAPORT = @JAVAPORT@
LD = @LD@
LDFLAGS = @LDFLAGS@
LIBADD_DL = @LIBADD_DL@
@@ -177,6 +178,7 @@ LT_DLLOADERS = @LT_DLLOADERS@
LT_DLPREOPEN = @LT_DLPREOPEN@
MAKEINFO = @MAKEINFO@
MKDIR_P = @MKDIR_P@
+MONKEYPREFIX = @MONKEYPREFIX@
MSGFMT = @MSGFMT@
MSGFMT_015 = @MSGFMT_015@
MSGMERGE = @MSGMERGE@
@@ -295,14 +297,18 @@ top_builddir = @top_builddir@
top_srcdir = @top_srcdir@
man_MANS = \
gnunet-arm.1 \
+ gnunet-core.1 \
gnunet-directory.1 \
gnunet-download.1 \
gnunet-download-manager.1 \
gnunet-fs.1 \
+ gnunet-gns.1 \
+ gnunet-namestore.1 \
gnunet-nat-server.1 \
gnunet-peerinfo.1 \
gnunet-pseudonym.1 \
gnunet-publish.1 \
+ gnunet-rsa.1 \
gnunet-search.1 \
gnunet-statistics.1 \
gnunet-transport.1 \
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
index 1bd4467..86a748e 100644
--- a/doc/man/gnunet-arm.1
+++ b/doc/man/gnunet-arm.1
@@ -34,6 +34,9 @@ Stop the specified SERVICE if it is running. While this will kill the service r
.IP "\-s, \-\-start"
Start all GNUnet default services on this system (and also ARM). Naturally, if a service is demanded by a default service, it will then also be started. Running "gnunet-arm -s" is the usual way to start a GNUnet peer.
.B
+.IP "\-I, \-\-info"
+List all running services.
+.B
.IP "\-v, \-\-version"
Print GNUnet version number.
diff --git a/doc/man/gnunet-core.1 b/doc/man/gnunet-core.1
new file mode 100644
index 0000000..0971b42
--- /dev/null
+++ b/doc/man/gnunet-core.1
@@ -0,0 +1,35 @@
+.TH gnunet\-core "1" "1 Apr 2012" "GNUnet"
+.SH NAME
+gnunet\-core \- measure and control the core subsystem
+
+.SH SYNOPSIS
+.B gnunet\-core
+[\fIOPTIONS\fR]
+.SH DESCRIPTION
+.PP
+
+gnunet\-core is a tool to access various functions of GNUnet's core subsystem from the command\-line. The only function right now is to list the peers that are directly connected to this peer (with successful cryptographic handshake).
+
+.TP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
+configuration file to use
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print help page
+.TP
+\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
+Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+be verbose
+
+.SH NOTES
+
+
+.SH "REPORTING BUGS"
+Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+.SH "SEE ALSO"
+\fBgnunet\-transport\fP(1)
diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1
new file mode 100644
index 0000000..4d00c82
--- /dev/null
+++ b/doc/man/gnunet-gns.1
@@ -0,0 +1,36 @@
+.TH GNUNET\-GNS 1 "Mar 5, 2012" "GNUnet"
+
+.SH NAME
+gnunet\-gns \- manipulate GNUnet GNS zones
+
+.SH SYNOPSIS
+.B gnunet\-gns
+.RI [ options ] -z ZONEFILE
+.br
+
+.SH DESCRIPTION
+\fBgnunet\-gns\fP can be used to create and manipulate a GNS zone.
+
+.SH OPTIONS
+.B
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration file FILENAME.
+.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 "\-s NAME, \-\-shorten=NAME"
+GNS domain name to shorten
+.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>
+
+
+.SH "SEE ALSO"
+\fBgnunet\-namestore\fP(1)
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
new file mode 100644
index 0000000..4ecdbb0
--- /dev/null
+++ b/doc/man/gnunet-namestore.1
@@ -0,0 +1,58 @@
+.TH GNUNET\-NAMESTORE 1 "Mar 5, 2012" "GNUnet"
+
+.SH NAME
+gnunet\-namestore \- manipulate GNUnet zones
+
+.SH SYNOPSIS
+.B gnunet\-namestore
+.RI [ options ] -z ZONEFILE
+.br
+
+.SH DESCRIPTION
+\fBgnunet\-namestore\fP can be used to create and manipulate a GNS zone.
+
+.SH OPTIONS
+.B
+.IP "\-a, \-\-add"
+Desired operation is adding a record
+.B
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration file FILENAME.
+.B
+.IP "\-d, \-\-delete"
+Desired operation is deleting a record
+.B
+.IP "\-D, \-\-display"
+Desired operation is listing of matching records
+.B
+.IP "\-e TIME, \-\-expiration=TIME"
+Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m". Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years).
+.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 "\-n NAME, \-\-name=NAME"
+Name of the record to add/delete/display
+.B
+.IP "\-t TYPE, \-\-type=TYPE"
+Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.)
+.B
+.IP "\-v, \-\-version"
+Print GNUnet version number.
+.B
+.IP "\-V VALUE, \-\-value=VALUE"
+Value to store or remove from the GNS zone. Specific format depends on the record type. A records expect a dotted decimal IPv4 address, AAAA records an IPv6 address, PKEY a public key in GNUnet's printable format, and CNAME and NS records should be a domain name.
+.B
+.IP "\-z FILENAME, \-\-zonekey=FILENAME"
+Specifies the filename with the private key for the zone (mandatory option)
+
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+
+
+.SH "SEE ALSO"
+\fBgnunet\-gns\fP(1)
diff --git a/doc/man/gnunet-rsa.1 b/doc/man/gnunet-rsa.1
new file mode 100644
index 0000000..46f24de
--- /dev/null
+++ b/doc/man/gnunet-rsa.1
@@ -0,0 +1,40 @@
+.TH GNUNET\-RSA 1 "Mar 15, 2012" "GNUnet"
+
+.SH NAME
+gnunet\-rsa \- manipulate GNUnet RSA key files
+
+.SH SYNOPSIS
+.B gnunet\-rsa
+.RI [ options ] FILENAME
+.br
+
+.SH DESCRIPTION
+\fBgnunet\-rsa\fP can be used to create an RSA private key and to print the corresponding public key. You must specify a filename containing an RSA private key in GNUnet format as an argument. If the file does not exist, gnunet\-rsa will create a key. This may then take a while. If the option \-p is given, the corresponding public key will be printed to the console.
+
+.SH OPTIONS
+.B
+.IP "\-p, \-\-print-public-key"
+Print the corresponding public key to stdout.
+.B
+.IP "\-P, \-\-print-peer-identity"
+Print the corresponding peer identity (hash of the public key) to stdout. This hash is used for the name of peers.
+.B
+.IP "\-s, \-\-print-short-identity"
+Print the corresponding short hash (256-bit hash of the public key) to stdout. This hash is used for names in the zkey zone.
+.B
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration file FILENAME.
+.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 "\-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>
+