aboutsummaryrefslogtreecommitdiff
path: root/doc
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 /doc
parentce63ca3ca49d8a4dc741cd014601584e3d5cfe54 (diff)
downloadgnunet-b5faf6b49637dc6abcb42c81337d783324c54be7.tar.gz
gnunet-b5faf6b49637dc6abcb42c81337d783324c54be7.zip
man pages.
Diffstat (limited to 'doc')
-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 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-arm 28.Nm gnunet-arm
29.Nd 29.Nd control GNUnet services
30control GNUnet services
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
@@ -49,9 +48,11 @@ control GNUnet services
49.Op Fl v | \-version 48.Op Fl v | \-version
50.Sh DESCRIPTION 49.Sh DESCRIPTION
51.Nm 50.Nm
52can be used to start or stop GNUnet services, including the ARM service itself. 51can be used to start or stop GNUnet services,
52including the ARM service itself.
53The ARM service is a supervisor for GNUnet's service processes. 53The ARM service is a supervisor for GNUnet's service processes.
54ARM starts services on-demand or as configured and restarts them if they crash. 54ARM starts services on-demand or as configured and restarts them
55if they crash.
55.Bl -tag -width Ds 56.Bl -tag -width Ds
56.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 57.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
57Use the configuration file FILENAME. 58Use the configuration file FILENAME.
@@ -59,21 +60,26 @@ Use the configuration file FILENAME.
59Delete config file and directory on exit. 60Delete config file and directory on exit.
60.It Fl e | \-end 61.It Fl e | \-end
61Shutdown all GNUnet services (including ARM itself). 62Shutdown all GNUnet services (including ARM itself).
62Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. 63Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer.
63.It Fl E | \-no-stderr 64.It Fl E | \-no-stderr
64Don't let gnunet-arm inherit standard error. 65Don't let gnunet-arm inherit standard error.
65.It Fl h | \-help 66.It Fl h | \-help
66Print short help on options. 67Print short help on options.
67.It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE 68.It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE
68Starts the specified SERVICE if it is not already running. 69Starts the specified SERVICE if it is not already running.
69More specifically, this makes the service behave as if it were in the default services list. 70More specifically, this makes the service behave as if it were in
71the default services list.
70.It Fl I | \-info 72.It Fl I | \-info
71List all running services. 73List all running services.
72.It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE 74.It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE
73Stop the specified SERVICE if it is running. 75Stop the specified SERVICE if it is running.
74While 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'). 76While this will kill the service right now, the service may be
75If the service used to be a 'default' service, its default-service status will be revoked. 77restarted immediately if other services depend on it (service is
76If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time. 78then started 'on-demand').
79If the service used to be a 'default' service, its default-service
80status will be revoked.
81If the service was not a default service, it will just
82be (temporarily) stopped, but could be re-started on-demand at any time.
77.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 83.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
78Write logs to FILENAME. 84Write logs to FILENAME.
79.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 85.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
@@ -90,8 +96,9 @@ Don't print status messages.
90Stop and start all GNUnet default services. 96Stop and start all GNUnet default services.
91.It Fl s | \-start 97.It Fl s | \-start
92Start all GNUnet default services on this system (and also ARM). 98Start all GNUnet default services on this system (and also ARM).
93Naturally, if a service is demanded by a default service, it will then also be started. 99Naturally, if a service is demanded by a default service, it will
94Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. 100then also be started.
101Running "gnunet-arm -s" is the usual way to start a GNUnet peer.
95.It Fl T DELAY | \-timeout= Ns Ar DELAY 102.It Fl T DELAY | \-timeout= Ns Ar DELAY
96Exit with error status if operation does not finish after DELAY 103Exit with error status if operation does not finish after DELAY
97.It Fl v | \-version 104.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 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-fs 28.Nm gnunet-fs
29.Nd 29.Nd measure and control the FS subsystem
30measure and control the fs subsystem
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
@@ -38,7 +37,8 @@ measure and control the fs subsystem
38.Op Fl V | \-verbose 37.Op Fl V | \-verbose
39.Sh DESCRIPTION 38.Sh DESCRIPTION
40.Nm 39.Nm
41is a tool to access various functions of GNUnet's FS subsystem from the command-line. 40is a tool to access various functions of GNUnet's FS subsystem
41from the command-line.
42Most of these are not expected to be useful for end-users. 42Most of these are not expected to be useful for end-users.
43gnunet-fs can currently only be used to obtain a list of indexed files. 43gnunet-fs can currently only be used to obtain a list of indexed files.
44Other functions should be added in the near future. 44Other functions should be added in the near future.
@@ -59,7 +59,7 @@ Be verbose.
59.El 59.El
60.Sh SEE ALSO 60.Sh SEE ALSO
61.Xr gnunet-publish 1 61.Xr gnunet-publish 1
62.sp 62.Pp
63The full documentation for gnunet is maintained as a Texinfo manual. 63The full documentation for gnunet is maintained as a Texinfo manual.
64If the 64If the
65.Xr info 1 65.Xr info 1
@@ -72,7 +72,7 @@ should give you access to the complete handbook,
72.Dl info gnunet-c-tutorial 72.Dl info gnunet-c-tutorial
73.Pp 73.Pp
74will give you access to a tutorial for developers. 74will give you access to a tutorial for developers.
75.sp 75.Pp
76Depending on your installation, this information is also available in 76Depending on your installation, this information is also available in
77.Xr gnunet 7 and 77.Xr gnunet 7 and
78.Xr gnunet-c-tutorial 7 . 78.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 @@
29.Nd show network size estimates from NSE service 29.Nd show network size estimates from NSE service
30.Sh SYNOPSIS 30.Sh SYNOPSIS
31.Nm 31.Nm
32.Op Fl c Ar file | Fl -config Ns = Ns file 32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
33.Op Fl h | \-help 33.Op Fl h | -help
34.Op Fl l file | Fl -logfile Ns = Ns file 34.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
35.Op Fl L Ar loglevel | Fl -loglevel Ns = Ns loglevel 35.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
36.Op Fl v | \-version 36.Op Fl v | -version
37.Sh DESCRIPTION 37.Sh DESCRIPTION
38.Nm 38.Nm
39is a command line tool to show network size estimates from the NSE service of GNUnet. 39is a command line tool to show network size estimates from
40the NSE service of GNUnet.
40.Bl -tag -width Ds 41.Bl -tag -width Ds
41.It Fl c Ar file | Fl -config Ns = Ns file 42.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
42Use the configuration file FILENAME. 43Use the configuration file FILENAME.
43.It Fl h | \-help 44.It Fl h | -help
44Print short help on options. 45Print short help on options.
45.It Fl l file | Fl -logfile Ns = Ns file 46.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
46Configure logging to write logs to LOGFILE.
47.It Fl L Ar loglevel | Fl -loglevel Ns = Ns loglevel
48Use LOGLEVEL for logging. 47Use LOGLEVEL for logging.
49Valid values are DEBUG, INFO, WARNING and ERROR. 48Valid values are DEBUG, INFO, WARNING and ERROR.
50.It Fl v | \-version 49.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
50Configure logging to write logs to LOGFILE.
51.It Fl v | -version
51Print GNUnet version number. 52Print GNUnet version number.
52.El 53.El
53.Sh FILES 54.Sh FILES
@@ -68,7 +69,7 @@ should give you access to the complete handbook,
68 info gnunet-c-tutorial 69 info gnunet-c-tutorial
69.Ed 70.Ed
70will give you access to a tutorial for developers. 71will give you access to a tutorial for developers.
71.sp 72.Pp
72Depending on your installation, this information is also 73Depending on your installation, this information is also
73available in 74available in
74.Xr gnunet 7 and 75.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 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-scrypt 28.Nm gnunet-scrypt
29.Nd 29.Nd manipulate GNUnet proof of work files
30manipulate GNUnet proof of work files
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl b Ar BITS | Fl \-bits= Ns Ar BITS 32.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.
46.It Fl b Ar BITS | Fl \-bits= Ns Ar BITS 45.It Fl b Ar BITS | Fl \-bits= Ns Ar BITS
47Number of bits to require for the proof of work. 46Number of bits to require for the proof of work.
48.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 47.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
49Use the configuration file FILENAME. 48Use the configuration file
49.Ar FILENAME .
50.It Fl h | \-help 50.It Fl h | \-help
51Print short help on options. 51Print short help on options.
52.It Fl k Ar FILENAME | Fl \-keyfile= Ns Ar FILENAME 52.It Fl k Ar FILENAME | Fl \-keyfile= Ns Ar FILENAME
53File with private key, otherwise default is used. 53Use
54.Ar FILENAME
55as the file with private key, otherwise the default
56private key file is used.
54.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 57.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
55Use LOGLEVEL for logging. 58Use LOGLEVEL for logging.
56Valid values are DEBUG, INFO, WARNING and ERROR. 59Valid values are DEBUG, INFO, WARNING and ERROR.
@@ -75,7 +78,7 @@ should give you access to the complete handbook,
75.Dl info gnunet-c-tutorial 78.Dl info gnunet-c-tutorial
76.Pp 79.Pp
77will give you access to a tutorial for developers. 80will give you access to a tutorial for developers.
78.sp 81.Pp
79Depending on your installation, this information is also available in 82Depending on your installation, this information is also available in
80.Xr gnunet 7 and 83.Xr gnunet 7 and
81.Xr gnunet-c-tutorial 7 . 84.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 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-uri 28.Nm gnunet-uri
29.Nd 29.Nd invoke default handler for GNUnet URIs
30invoke default handler for GNUnet URIs
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl h | \-help 33.Op Fl h | \-help
35.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 34.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
35.Op Fl l | \-logfile= Ns Ar FILENAME
36.Op Fl v | \-version 36.Op Fl v | \-version
37URI 37URI
38.Sh DESCRIPTION 38.Sh DESCRIPTION
39.Nm 39.Nm
40can be used to invoke the correct tool to handle a GNUnet URI. 40can be used to invoke the correct tool to handle a GNUnet URI.
41GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" and thus the specific tool to handle the URI depends on the subsystem. 41GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" and
42gnunet-uri will determine the correct tool (by looking for SUBSYSTEM in the configuration section "uri") and invoke it. 42thus the specific tool to handle the URI depends on the subsystem.
43gnunet-uri will determine the correct tool (by looking for SUBSYSTEM
44in the configuration section "uri") and invoke it.
43.Bl -tag -width Ds 45.Bl -tag -width Ds
44.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 46.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
45Use the configuration file FILENAME. 47Use the configuration file FILENAME.
@@ -48,6 +50,9 @@ Print short help on options.
48.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 50.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
49Use LOGLEVEL for logging. 51Use LOGLEVEL for logging.
50Valid values are DEBUG, INFO, WARNING and ERROR. 52Valid values are DEBUG, INFO, WARNING and ERROR.
53.It Fl l | \-logfile= Ns Ar FILENAME
54Configure logging to write logs to
55.Ar FILENAME .
51.It Fl v | \-version 56.It Fl v | \-version
52Print GNUnet version number. 57Print GNUnet version number.
53.El 58.El
@@ -64,7 +69,7 @@ should give you access to the complete handbook,
64.Dl info gnunet-c-tutorial 69.Dl info gnunet-c-tutorial
65.Pp 70.Pp
66will give you access to a tutorial for developers. 71will give you access to a tutorial for developers.
67.sp 72.Pp
68Depending on your installation, this information is also available in 73Depending on your installation, this information is also available in
69.Xr gnunet 7 and 74.Xr gnunet 7 and
70.Xr gnunet-c-tutorial 7 . 75.Xr gnunet-c-tutorial 7 .