summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-05-09 20:19:27 +0000
committerng0 <ng0@n0.is>2019-05-09 20:19:27 +0000
commitb5faf6b49637dc6abcb42c81337d783324c54be7 (patch)
tree5cd259bcd0297f874146ea17cdd3d844be553810
parentce63ca3ca49d8a4dc741cd014601584e3d5cfe54 (diff)
man pages.
-rw-r--r--doc/man/gnunet-arm.129
-rw-r--r--doc/man/gnunet-fs.110
-rw-r--r--doc/man/gnunet-nse.127
-rw-r--r--doc/man/gnunet-scrypt.113
-rw-r--r--doc/man/gnunet-uri.115
5 files changed, 55 insertions, 39 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
index c25b10bb5..599478a07 100644
--- a/doc/man/gnunet-arm.1
+++ b/doc/man/gnunet-arm.1
@@ -26,8 +26,7 @@
.Os
.Sh NAME
.Nm gnunet-arm
-.Nd
-control GNUnet services
+.Nd control GNUnet services
.Sh SYNOPSIS
.Nm
.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
@@ -49,9 +48,11 @@ control GNUnet services
.Op Fl v | \-version
.Sh DESCRIPTION
.Nm
-can be used to start or stop GNUnet services, including the ARM service itself.
+can be used to start or stop GNUnet services,
+including the ARM service itself.
The ARM service is a supervisor for GNUnet's service processes.
-ARM starts services on-demand or as configured and restarts them if they crash.
+ARM starts services on-demand or as configured and restarts them
+if they crash.
.Bl -tag -width Ds
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
Use the configuration file FILENAME.
@@ -59,21 +60,26 @@ Use the configuration file FILENAME.
Delete config file and directory on exit.
.It Fl e | \-end
Shutdown all GNUnet services (including ARM itself).
-Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer.
+Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer.
.It Fl E | \-no-stderr
Don't let gnunet-arm inherit standard error.
.It Fl h | \-help
Print short help on options.
.It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE
Starts the specified SERVICE if it is not already running.
-More specifically, this makes the service behave as if it were in the default services list.
+More specifically, this makes the service behave as if it were in
+the default services list.
.It Fl I | \-info
List all running services.
.It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE
Stop the specified SERVICE if it is running.
-While this will kill the service right now, the service may be restarted immediately if other services depend on it (service is then started 'on-demand').
-If the service used to be a 'default' service, its default-service status will be revoked.
-If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time.
+While this will kill the service right now, the service may be
+restarted immediately if other services depend on it (service is
+then started 'on-demand').
+If the service used to be a 'default' service, its default-service
+status will be revoked.
+If the service was not a default service, it will just
+be (temporarily) stopped, but could be re-started on-demand at any time.
.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
Write logs to FILENAME.
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
@@ -90,8 +96,9 @@ Don't print status messages.
Stop and start all GNUnet default services.
.It Fl 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.
+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.
.It Fl T DELAY | \-timeout= Ns Ar DELAY
Exit with error status if operation does not finish after DELAY
.It Fl v | \-version
diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1
index 556452425..b61485ebf 100644
--- a/doc/man/gnunet-fs.1
+++ b/doc/man/gnunet-fs.1
@@ -26,8 +26,7 @@
.Os
.Sh NAME
.Nm gnunet-fs
-.Nd
-measure and control the fs subsystem
+.Nd measure and control the FS subsystem
.Sh SYNOPSIS
.Nm
.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
@@ -38,7 +37,8 @@ measure and control the fs subsystem
.Op Fl V | \-verbose
.Sh DESCRIPTION
.Nm
-is a tool to access various functions of GNUnet's FS subsystem from the command-line.
+is a tool to access various functions of GNUnet's FS subsystem
+from the command-line.
Most of these are not expected to be useful for end-users.
gnunet-fs can currently only be used to obtain a list of indexed files.
Other functions should be added in the near future.
@@ -59,7 +59,7 @@ Be verbose.
.El
.Sh SEE ALSO
.Xr gnunet-publish 1
-.sp
+.Pp
The full documentation for gnunet is maintained as a Texinfo manual.
If the
.Xr info 1
@@ -72,7 +72,7 @@ should give you access to the complete handbook,
.Dl info gnunet-c-tutorial
.Pp
will give you access to a tutorial for developers.
-.sp
+.Pp
Depending on your installation, this information is also available in
.Xr gnunet 7 and
.Xr gnunet-c-tutorial 7 .
diff --git a/doc/man/gnunet-nse.1 b/doc/man/gnunet-nse.1
index 4c5d98220..6c89848d2 100644
--- a/doc/man/gnunet-nse.1
+++ b/doc/man/gnunet-nse.1
@@ -29,25 +29,26 @@
.Nd show network size estimates from NSE service
.Sh SYNOPSIS
.Nm
-.Op Fl c Ar file | Fl -config Ns = Ns file
-.Op Fl h | \-help
-.Op Fl l file | Fl -logfile Ns = Ns file
-.Op Fl L Ar loglevel | Fl -loglevel Ns = Ns loglevel
-.Op Fl v | \-version
+.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl h | -help
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+.Op Fl v | -version
.Sh DESCRIPTION
.Nm
-is a command line tool to show network size estimates from the NSE service of GNUnet.
+is a command line tool to show network size estimates from
+the NSE service of GNUnet.
.Bl -tag -width Ds
-.It Fl c Ar file | Fl -config Ns = Ns file
+.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
Use the configuration file FILENAME.
-.It Fl h | \-help
+.It Fl h | -help
Print short help on options.
-.It Fl l file | Fl -logfile Ns = Ns file
-Configure logging to write logs to LOGFILE.
-.It Fl L Ar loglevel | Fl -loglevel Ns = Ns loglevel
+.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
-.It Fl v | \-version
+.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+Configure logging to write logs to LOGFILE.
+.It Fl v | -version
Print GNUnet version number.
.El
.Sh FILES
@@ -68,7 +69,7 @@ should give you access to the complete handbook,
info gnunet-c-tutorial
.Ed
will give you access to a tutorial for developers.
-.sp
+.Pp
Depending on your installation, this information is also
available in
.Xr gnunet 7 and
diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1
index 169dba243..eadb8e26e 100644
--- a/doc/man/gnunet-scrypt.1
+++ b/doc/man/gnunet-scrypt.1
@@ -26,8 +26,7 @@
.Os
.Sh NAME
.Nm gnunet-scrypt
-.Nd
-manipulate GNUnet proof of work files
+.Nd manipulate GNUnet proof of work files
.Sh SYNOPSIS
.Nm
.Op Fl b Ar BITS | Fl \-bits= Ns Ar BITS
@@ -46,11 +45,15 @@ is a command line tool to manipulate GNUnet proof of work files.
.It Fl b Ar BITS | Fl \-bits= Ns Ar BITS
Number of bits to require for the proof of work.
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
-Use the configuration file FILENAME.
+Use the configuration file
+.Ar FILENAME .
.It Fl h | \-help
Print short help on options.
.It Fl k Ar FILENAME | Fl \-keyfile= Ns Ar FILENAME
-File with private key, otherwise default is used.
+Use
+.Ar FILENAME
+as the file with private key, otherwise the default
+private key file is used.
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
@@ -75,7 +78,7 @@ should give you access to the complete handbook,
.Dl info gnunet-c-tutorial
.Pp
will give you access to a tutorial for developers.
-.sp
+.Pp
Depending on your installation, this information is also available in
.Xr gnunet 7 and
.Xr gnunet-c-tutorial 7 .
diff --git a/doc/man/gnunet-uri.1 b/doc/man/gnunet-uri.1
index d8f75e929..edfab2f4f 100644
--- a/doc/man/gnunet-uri.1
+++ b/doc/man/gnunet-uri.1
@@ -26,20 +26,22 @@
.Os
.Sh NAME
.Nm gnunet-uri
-.Nd
-invoke default handler for GNUnet URIs
+.Nd invoke default handler for GNUnet URIs
.Sh SYNOPSIS
.Nm
.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
.Op Fl h | \-help
.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.Op Fl l | \-logfile= Ns Ar FILENAME
.Op Fl v | \-version
URI
.Sh DESCRIPTION
.Nm
can be used to invoke the correct tool to handle a GNUnet URI.
-GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" and thus the specific tool to handle the URI depends on the subsystem.
-gnunet-uri will determine the correct tool (by looking for SUBSYSTEM in the configuration section "uri") and invoke it.
+GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" and
+thus the specific tool to handle the URI depends on the subsystem.
+gnunet-uri will determine the correct tool (by looking for SUBSYSTEM
+in the configuration section "uri") and invoke it.
.Bl -tag -width Ds
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
Use the configuration file FILENAME.
@@ -48,6 +50,9 @@ Print short help on options.
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
+.It Fl l | \-logfile= Ns Ar FILENAME
+Configure logging to write logs to
+.Ar FILENAME .
.It Fl v | \-version
Print GNUnet version number.
.El
@@ -64,7 +69,7 @@ should give you access to the complete handbook,
.Dl info gnunet-c-tutorial
.Pp
will give you access to a tutorial for developers.
-.sp
+.Pp
Depending on your installation, this information is also available in
.Xr gnunet 7 and
.Xr gnunet-c-tutorial 7 .