diff options
author | Nils Gillmann <ng0@n0.is> | 2018-10-27 20:29:27 +0000 |
---|---|---|
committer | Nils Gillmann <ng0@n0.is> | 2018-10-27 20:29:27 +0000 |
commit | d269419d23e8c4c062e21e5bd88cdee66a1680b0 (patch) | |
tree | c9661262fee4604bd83b0bc739e7223c8cddfb0a | |
parent | 4be442739c7f6745848a2f5544a59592f06a6cb3 (diff) | |
download | gnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.tar.gz gnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.zip |
doc/man: More fixes.
Signed-off-by: Nils Gillmann <ng0@n0.is>
-rw-r--r-- | doc/man/gnunet-arm.1 | 14 | ||||
-rw-r--r-- | doc/man/gnunet-config.1 | 12 | ||||
-rw-r--r-- | doc/man/gnunet-core.1 | 14 | ||||
-rw-r--r-- | doc/man/gnunet-datastore.1 | 4 | ||||
-rw-r--r-- | doc/man/gnunet-directory.1 | 12 | ||||
-rw-r--r-- | doc/man/gnunet-download.1 | 29 | ||||
-rw-r--r-- | doc/man/gnunet-gns-proxy.1 | 15 | ||||
-rw-r--r-- | doc/man/gnunet-namestore-fcfsd.1 | 20 | ||||
-rw-r--r-- | doc/man/gnunet-nat-auto.1 | 52 | ||||
-rw-r--r-- | doc/man/gnunet-nat-server.1 | 22 | ||||
-rw-r--r-- | doc/man/gnunet-peerinfo.1 | 17 | ||||
-rw-r--r-- | doc/man/gnunet-resolver.1 | 16 | ||||
-rw-r--r-- | doc/man/gnunet-scalarproduct.1 | 26 | ||||
-rw-r--r-- | doc/man/gnunet-scrypt.1 | 16 | ||||
-rw-r--r-- | doc/man/gnunet-statistics.1 | 17 | ||||
-rw-r--r-- | doc/man/gnunet-testing-run-service.1 | 20 | ||||
-rw-r--r-- | doc/man/gnunet-timeout.1 | 17 | ||||
-rw-r--r-- | doc/man/gnunet-transport-certificate-creation.1 | 15 | ||||
-rw-r--r-- | doc/man/gnunet-uri.1 | 17 | ||||
-rw-r--r-- | doc/man/gnunet-zoneimport.1 | 30 | ||||
-rw-r--r-- | doc/man/gnunet.conf.5 | 26 |
21 files changed, 141 insertions, 270 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1 index fdcc7d820..0e7486d28 100644 --- a/doc/man/gnunet-arm.1 +++ b/doc/man/gnunet-arm.1 | |||
@@ -1,19 +1,14 @@ | |||
1 | .TH GNUNET\-ARM 1 "Jan 4, 2012" "GNUnet" | 1 | .TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-arm \- control GNUnet services | 3 | gnunet\-arm \- control GNUnet services |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-arm | 5 | .B gnunet\-arm |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | \fBgnunet\-arm\fP can be used to start or stop GNUnet services, including | 8 | \fBgnunet\-arm\fP can be used to start or stop GNUnet services, including |
13 | the ARM service itself. The ARM service is a supervisor for GNUnet's | 9 | the ARM service itself. The ARM service is a supervisor for GNUnet's |
14 | service processes. ARM starts services on-demand or as configured and | 10 | service processes. ARM starts services on-demand or as configured and |
15 | re-starts them if they crash. | 11 | re-starts them if they crash. |
16 | |||
17 | .SH OPTIONS | 12 | .SH OPTIONS |
18 | .B | 13 | .B |
19 | .IP "\-c FILENAME, \-\-config=FILENAME" | 14 | .IP "\-c FILENAME, \-\-config=FILENAME" |
@@ -55,17 +50,16 @@ List all running services. | |||
55 | .B | 50 | .B |
56 | .IP "\-v, \-\-version" | 51 | .IP "\-v, \-\-version" |
57 | Print GNUnet version number. | 52 | Print GNUnet version number. |
58 | |||
59 | |||
60 | .SH BUGS | 53 | .SH BUGS |
61 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending | 54 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
62 | electronic mail to <gnunet\-developers@gnu.org> | 55 | electronic mail to <gnunet\-developers@gnu.org> |
63 | |||
64 | .SH SEE ALSO | 56 | .SH SEE ALSO |
65 | gnunet\-config(1), gnunet\-setup(1) | 57 | gnunet\-config(1), gnunet\-setup(1) |
58 | .PP | ||
66 | The full documentation for | 59 | The full documentation for |
67 | .B gnunet | 60 | .B gnunet |
68 | is maintained as a Texinfo manual. If the | 61 | is maintained as a Texinfo manual. |
62 | If the | ||
69 | .B info | 63 | .B info |
70 | and | 64 | and |
71 | .B gnunet | 65 | .B gnunet |
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1 index 43e7a011b..c4f979fb0 100644 --- a/doc/man/gnunet-config.1 +++ b/doc/man/gnunet-config.1 | |||
@@ -1,16 +1,11 @@ | |||
1 | .TH GNUNET\-CONFIG 1 "Jul 15, 2012" "GNUnet" | 1 | .TH GNUNET-CONFIG 1 "July 15, 2012" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-config \- manipulate GNUnet configuration files | 3 | gnunet\-config \- manipulate GNUnet configuration files |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-config | 5 | .B gnunet\-config |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | \fBgnunet\-config\fP can be used to read or modify GNUnet configuration files. | 8 | \fBgnunet\-config\fP can be used to read or modify GNUnet configuration files. |
13 | |||
14 | .SH OPTIONS | 9 | .SH OPTIONS |
15 | .B | 10 | .B |
16 | .IP "\-f, \-\-filename" | 11 | .IP "\-f, \-\-filename" |
@@ -46,15 +41,14 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | |||
46 | .B | 41 | .B |
47 | .IP "\-v, \-\-version" | 42 | .IP "\-v, \-\-version" |
48 | Print GNUnet version number. | 43 | Print GNUnet version number. |
49 | |||
50 | |||
51 | .SH BUGS | 44 | .SH BUGS |
52 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending | 45 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
53 | electronic mail to <gnunet\-developers@gnu.org> | 46 | electronic mail to <gnunet\-developers@gnu.org> |
54 | .SH SEE ALSO | 47 | .SH SEE ALSO |
55 | The full documentation for | 48 | The full documentation for |
56 | .B gnunet | 49 | .B gnunet |
57 | is maintained as a Texinfo manual. If the | 50 | is maintained as a Texinfo manual. |
51 | If the | ||
58 | .B info | 52 | .B info |
59 | and | 53 | and |
60 | .B gnunet | 54 | .B gnunet |
diff --git a/doc/man/gnunet-core.1 b/doc/man/gnunet-core.1 index 12d936f7a..dd2b566f9 100644 --- a/doc/man/gnunet-core.1 +++ b/doc/man/gnunet-core.1 | |||
@@ -1,17 +1,13 @@ | |||
1 | .TH gnunet\-core "1" "11 Apr 2014" "GNUnet" | 1 | .TH GNUNET-CORE "1" "April 11, 2014" "GNUnet" |
2 | .SH NAME | 2 | .SH NAME |
3 | gnunet\-core \- monitor CORE subsystem | 3 | gnunet\-core \- monitor CORE subsystem |
4 | |||
5 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
6 | .B gnunet\-core | 5 | .B gnunet\-core |
7 | [\fIOPTIONS\fR] | 6 | [\fIOPTIONS\fR] |
8 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
9 | .PP | ||
10 | |||
11 | gnunet\-core is a tool to access various functions of GNUnet's core subsystem | 8 | gnunet\-core is a tool to access various functions of GNUnet's core subsystem |
12 | from the command\-line. The only function right now is to monitor the status | 9 | from the command\-line. The only function right now is to monitor the status |
13 | of peers known to the CORE service. | 10 | of peers known to the CORE service. |
14 | |||
15 | .TP | 11 | .TP |
16 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR | 12 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR |
17 | configuration file to use | 13 | configuration file to use |
@@ -31,18 +27,16 @@ print the version number | |||
31 | .TP | 27 | .TP |
32 | \fB\-V\fR, \fB\-\-verbose\fR | 28 | \fB\-V\fR, \fB\-\-verbose\fR |
33 | be verbose | 29 | be verbose |
34 | |||
35 | .SH NOTES | ||
36 | |||
37 | |||
38 | .SH BUGS | 30 | .SH BUGS |
39 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending | 31 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending |
40 | electronic mail to <gnunet\-developers@gnu.org> | 32 | electronic mail to <gnunet\-developers@gnu.org> |
41 | .SH SEE ALSO | 33 | .SH SEE ALSO |
42 | \fBgnunet\-transport\fP(1) | 34 | \fBgnunet\-transport\fP(1) |
35 | .PP | ||
43 | The full documentation for | 36 | The full documentation for |
44 | .B gnunet | 37 | .B gnunet |
45 | is maintained as a Texinfo manual. If the | 38 | is maintained as a Texinfo manual. |
39 | If the | ||
46 | .B info | 40 | .B info |
47 | and | 41 | and |
48 | .B gnunet | 42 | .B gnunet |
diff --git a/doc/man/gnunet-datastore.1 b/doc/man/gnunet-datastore.1 index 535aedbf5..4cb536f51 100644 --- a/doc/man/gnunet-datastore.1 +++ b/doc/man/gnunet-datastore.1 | |||
@@ -1,11 +1,10 @@ | |||
1 | .TH gnunet\-datastore "1" "April 13, 2017" "GNUnet" | 1 | .TH GNUNET-DATASTORE "1" "April 13, 2017" "GNUnet" |
2 | .SH NAME | 2 | .SH NAME |
3 | gnunet\-datastore \- dump or insert (restore) GNUnet datastore databases | 3 | gnunet\-datastore \- dump or insert (restore) GNUnet datastore databases |
4 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
5 | .B gnunet\-datastore | 5 | .B gnunet\-datastore |
6 | [\fIOPTIONS\fR] | 6 | [\fIOPTIONS\fR] |
7 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
8 | .PP | ||
9 | gnunet\-datastore can be used to backup and restore or merge GNUnet | 8 | gnunet\-datastore can be used to backup and restore or merge GNUnet |
10 | datastores. | 9 | datastores. |
11 | This is useful if a datastore is to be migrated between SQL databases, | 10 | This is useful if a datastore is to be migrated between SQL databases, |
@@ -41,6 +40,7 @@ Report bugs by using mantis <https://gnunet.org/bugs/> or by sending | |||
41 | electronic mail to <gnunet\-developers@gnu.org> | 40 | electronic mail to <gnunet\-developers@gnu.org> |
42 | .SH SEE ALSO | 41 | .SH SEE ALSO |
43 | \fBgnunet\-publish\fP(1) | 42 | \fBgnunet\-publish\fP(1) |
43 | .PP | ||
44 | The full documentation for | 44 | The full documentation for |
45 | .B gnunet | 45 | .B gnunet |
46 | is maintained as a Texinfo manual. | 46 | is maintained as a Texinfo manual. |
diff --git a/doc/man/gnunet-directory.1 b/doc/man/gnunet-directory.1 index a8aa515e4..109b2fc6c 100644 --- a/doc/man/gnunet-directory.1 +++ b/doc/man/gnunet-directory.1 | |||
@@ -1,7 +1,6 @@ | |||
1 | .TH gnunet-directory "1" "25 Feb 2012" "GNUnet" | 1 | .TH GNUNET-DIRECTORY "1" "February 25, 2012" "GNUnet" |
2 | .SH NAME | 2 | .SH NAME |
3 | gnunet\-directory \- display directories | 3 | gnunet\-directory \- display directories |
4 | |||
5 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
6 | .B gnunet\-directory | 5 | .B gnunet\-directory |
7 | [\fIOPTIONS\fR] (FILENAME)* | 6 | [\fIOPTIONS\fR] (FILENAME)* |
@@ -37,7 +36,7 @@ availability but does not produce useless duplicates (for example, it is a | |||
37 | better idea to publish a collection of pictures or compressed sound files | 36 | better idea to publish a collection of pictures or compressed sound files |
38 | using a GNUnet directory instead of processing them with archivers such as | 37 | using a GNUnet directory instead of processing them with archivers such as |
39 | tar or zip first). Directories can contain arbitrary meta data for each file. | 38 | tar or zip first). Directories can contain arbitrary meta data for each file. |
40 | 39 | .PP | |
41 | If a directory has missing blocks (for example, some blocks failed to download), | 40 | If a directory has missing blocks (for example, some blocks failed to download), |
42 | GNUnet is typically able to retrieve information about other files in the | 41 | GNUnet is typically able to retrieve information about other files in the |
43 | directory. Files in a GNUnet directory have no particular order; the GNUnet | 42 | directory. Files in a GNUnet directory have no particular order; the GNUnet |
@@ -45,11 +44,11 @@ code that generates a directory can reorder the entries in order to better | |||
45 | fit the information about files into blocks of 32k. Respecting 32k boundaries | 44 | fit the information about files into blocks of 32k. Respecting 32k boundaries |
46 | where possible makes it easier for gnunet\-directory (and other tools) to | 45 | where possible makes it easier for gnunet\-directory (and other tools) to |
47 | recover information from partially downloaded directory files. | 46 | recover information from partially downloaded directory files. |
48 | 47 | .PP | |
49 | At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP | 48 | At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP |
50 | and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be | 49 | and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be |
51 | published in a namespace. | 50 | published in a namespace. |
52 | 51 | .PP | |
53 | GNUnet directories use the (unregistered) | 52 | GNUnet directories use the (unregistered) |
54 | mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal | 53 | mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal |
55 | search results. The directory file can be downloaded to disk | 54 | search results. The directory file can be downloaded to disk |
@@ -64,7 +63,8 @@ electronic mail to <gnunet\-developers@gnu.org> | |||
64 | \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1) | 63 | \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1) |
65 | The full documentation for | 64 | The full documentation for |
66 | .B gnunet | 65 | .B gnunet |
67 | is maintained as a Texinfo manual. If the | 66 | is maintained as a Texinfo manual. |
67 | If the | ||
68 | .B info | 68 | .B info |
69 | and | 69 | and |
70 | .B gnunet | 70 | .B gnunet |
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1 index aa1328c00..58e82e790 100644 --- a/doc/man/gnunet-download.1 +++ b/doc/man/gnunet-download.1 | |||
@@ -1,21 +1,17 @@ | |||
1 | .TH GNUNET-DOWNLOAD "1" "31 Jan 2016" "GNUnet" | 1 | .TH GNUNET-DOWNLOAD "1" "January 31, 2016" "GNUnet" |
2 | .SH NAME | 2 | .SH NAME |
3 | gnunet\-download \- a command line interface for downloading files from GNUnet | 3 | gnunet\-download \- a command line interface for downloading files from GNUnet |
4 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
5 | .B gnunet\-download | 5 | .B gnunet\-download |
6 | [\fIOPTIONS\fR] \-\- GNUNET_URI | 6 | [\fIOPTIONS\fR] \-\- GNUNET_URI |
7 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
8 | .PP | ||
9 | Download files from GNUnet. | 8 | Download files from GNUnet. |
10 | |||
11 | .TP | 9 | .TP |
12 | \fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR | 10 | \fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR |
13 | set desired level of receiver anonymity. Default is 1. | 11 | set desired level of receiver anonymity. Default is 1. |
14 | |||
15 | .TP | 12 | .TP |
16 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR | 13 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR |
17 | use config file (defaults: ~/.config/gnunet.conf) | 14 | use config file (defaults: ~/.config/gnunet.conf) |
18 | |||
19 | .TP | 15 | .TP |
20 | \fB\-D, \fB\-\-delete\-incomplete\fR | 16 | \fB\-D, \fB\-\-delete\-incomplete\fR |
21 | causes gnunet\-download to delete incomplete downloads when aborted with | 17 | causes gnunet\-download to delete incomplete downloads when aborted with |
@@ -24,20 +20,16 @@ download will not be deleted even with this option. Without this option, | |||
24 | terminating gnunet\-download with a signal will cause incomplete | 20 | terminating gnunet\-download with a signal will cause incomplete |
25 | downloads to stay on disk. If gnunet\-download runs to (normal) completion | 21 | downloads to stay on disk. If gnunet\-download runs to (normal) completion |
26 | finishing the download, this option has no effect. | 22 | finishing the download, this option has no effect. |
27 | |||
28 | .TP | 23 | .TP |
29 | \fB\-h\fR, \fB\-\-help\fR | 24 | \fB\-h\fR, \fB\-\-help\fR |
30 | print help page | 25 | print help page |
31 | |||
32 | .TP | 26 | .TP |
33 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR | 27 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR |
34 | Change the loglevel. Possible values for LOGLEVEL are | 28 | Change the loglevel. Possible values for LOGLEVEL are |
35 | ERROR, WARNING, INFO and DEBUG. | 29 | ERROR, WARNING, INFO and DEBUG. |
36 | |||
37 | .TP | 30 | .TP |
38 | \fB\-n\fR, \fB\-\-no-network\fR | 31 | \fB\-n\fR, \fB\-\-no-network\fR |
39 | Only search locally, do not forward requests to other peers. | 32 | Only search locally, do not forward requests to other peers. |
40 | |||
41 | .TP | 33 | .TP |
42 | \fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR | 34 | \fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR |
43 | write the file to FILENAME. Hint: when recursively downloading a directory, | 35 | write the file to FILENAME. Hint: when recursively downloading a directory, |
@@ -45,7 +37,6 @@ append a '/' to the end of the FILENAME to create a directory of that name. | |||
45 | If no FILENAME is specified, gnunet\-download constructs a temporary ID from | 37 | If no FILENAME is specified, gnunet\-download constructs a temporary ID from |
46 | the URI of the file. The final filename is constructed based on meta\-data | 38 | the URI of the file. The final filename is constructed based on meta\-data |
47 | extracted using libextractor (if available). | 39 | extracted using libextractor (if available). |
48 | |||
49 | .TP | 40 | .TP |
50 | \fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR | 41 | \fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR |
51 | set the maximum number of parallel downloads that is allowed. More parallel | 42 | set the maximum number of parallel downloads that is allowed. More parallel |
@@ -56,7 +47,6 @@ used to limit the number of files that are downloaded in parallel (\-r can | |||
56 | be used to limit the number of blocks that are concurrently requested). | 47 | be used to limit the number of blocks that are concurrently requested). |
57 | As a result, the value only matters for recursive downloads. | 48 | As a result, the value only matters for recursive downloads. |
58 | The default value is 32. | 49 | The default value is 32. |
59 | |||
60 | .TP | 50 | .TP |
61 | \fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR | 51 | \fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR |
62 | set the maximum number of parallel requests that is allowed. If multiple | 52 | set the maximum number of parallel requests that is allowed. If multiple |
@@ -71,7 +61,6 @@ recursive downloads with many large files if memory and network | |||
71 | bandwidth are not fully utilized and if the parallelism limit (\-p option) | 61 | bandwidth are not fully utilized and if the parallelism limit (\-p option) |
72 | is not reached. This option also only matters for recursive downloads. | 62 | is not reached. This option also only matters for recursive downloads. |
73 | The default value is 4092. | 63 | The default value is 4092. |
74 | |||
75 | .TP | 64 | .TP |
76 | \fB\-R\fR, \fB\-\-recursive\fR | 65 | \fB\-R\fR, \fB\-\-recursive\fR |
77 | download directories recursively (and in parallel). Note that the URI | 66 | download directories recursively (and in parallel). Note that the URI |
@@ -83,15 +72,12 @@ information will be stored in "DIRNAME/.gnd". However, it is also | |||
83 | possible to specify "DIRNAME.gnd", in which case the files from the | 72 | possible to specify "DIRNAME.gnd", in which case the files from the |
84 | directory will end up in "DIRNAME/", while GNUnet's directory meta | 73 | directory will end up in "DIRNAME/", while GNUnet's directory meta |
85 | data will be in "DIRNAME.gnd". | 74 | data will be in "DIRNAME.gnd". |
86 | |||
87 | .TP | 75 | .TP |
88 | \fB\-v\fR, \fB\-\-version\fR | 76 | \fB\-v\fR, \fB\-\-version\fR |
89 | print the version number | 77 | print the version number |
90 | |||
91 | .TP | 78 | .TP |
92 | \fB\-V\fR, \fB\-\-verbose\fR | 79 | \fB\-V\fR, \fB\-\-verbose\fR |
93 | print progress information | 80 | print progress information |
94 | |||
95 | .SH NOTES | 81 | .SH NOTES |
96 | The GNUNET_URI is typically obtained from | 82 | The GNUNET_URI is typically obtained from |
97 | gnunet\-search. gnunet\-fs\-gtk can also be used instead of | 83 | gnunet\-search. gnunet\-fs\-gtk can also be used instead of |
@@ -102,9 +88,7 @@ already present. GNUnet's file\-encoding will ensure file integrity, | |||
102 | even if the existing file was not downloaded from GNUnet in the first | 88 | even if the existing file was not downloaded from GNUnet in the first |
103 | place. Temporary information will be appended to the target file until | 89 | place. Temporary information will be appended to the target file until |
104 | the download is completed. | 90 | the download is completed. |
105 | |||
106 | .SH SETTING ANONYMITY LEVEL | 91 | .SH SETTING ANONYMITY LEVEL |
107 | |||
108 | The \fB\-a\fR option can be used to specify additional anonymity | 92 | The \fB\-a\fR option can be used to specify additional anonymity |
109 | constraints. If set to 0, GNUnet will try to download the file as fast | 93 | constraints. If set to 0, GNUnet will try to download the file as fast |
110 | as possible, including using non-anonymous methods. If you set it to | 94 | as possible, including using non-anonymous methods. If you set it to |
@@ -121,14 +105,14 @@ anonymity level 0, the peers publishing the data might be sharing with | |||
121 | a higher anonymity level, which in this case will determine | 105 | a higher anonymity level, which in this case will determine |
122 | performance. Also, peers that cache content in the network always use | 106 | performance. Also, peers that cache content in the network always use |
123 | anonymity level 1. | 107 | anonymity level 1. |
124 | 108 | .PP | |
125 | This option can be used to limit requests further than that. In | 109 | This option can be used to limit requests further than that. In |
126 | particular, you can require GNUnet to receive certain amounts of | 110 | particular, you can require GNUnet to receive certain amounts of |
127 | traffic from other peers before sending your queries. This way, you | 111 | traffic from other peers before sending your queries. This way, you |
128 | can gain very high levels of anonymity \- at the expense of much more | 112 | can gain very high levels of anonymity \- at the expense of much more |
129 | traffic and much higher latency. So set it only if you really believe | 113 | traffic and much higher latency. So set it only if you really believe |
130 | you need it. | 114 | you need it. |
131 | 115 | .PP | |
132 | The definition of ANONYMITY\-RECEIVE is the following. 0 means no | 116 | The definition of ANONYMITY\-RECEIVE is the following. 0 means no |
133 | anonymity is required. Otherwise a value of 'v' means that 1 out of v | 117 | anonymity is required. Otherwise a value of 'v' means that 1 out of v |
134 | bytes of "anonymous" traffic can be from the local user, leaving 'v-1' | 118 | bytes of "anonymous" traffic can be from the local user, leaving 'v-1' |
@@ -137,12 +121,11 @@ bytes of messages from foreign peers (using anonymous routing), it may | |||
137 | originate n/(v-1) bytes of queries in the same time\-period. The | 121 | originate n/(v-1) bytes of queries in the same time\-period. The |
138 | time\-period is twice the average delay that GNUnet defers forwarded | 122 | time\-period is twice the average delay that GNUnet defers forwarded |
139 | queries. | 123 | queries. |
140 | 124 | .PP | |
141 | The default is 1 and this should be fine for most users. Also notice | 125 | The default is 1 and this should be fine for most users. Also notice |
142 | that if you choose very large values, you may end up having no | 126 | that if you choose very large values, you may end up having no |
143 | throughput at all, especially if many of your fellow GNUnet\-peers all | 127 | throughput at all, especially if many of your fellow GNUnet\-peers all |
144 | do the same. | 128 | do the same. |
145 | |||
146 | .SH FILES | 129 | .SH FILES |
147 | .TP | 130 | .TP |
148 | ~/.config/gnunet.conf | 131 | ~/.config/gnunet.conf |
@@ -154,9 +137,11 @@ mail to <gnunet\-developers@gnu.org> | |||
154 | \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), | 137 | \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), |
155 | \fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5), | 138 | \fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5), |
156 | \fBgnunet\-service\-fs\fP(1) | 139 | \fBgnunet\-service\-fs\fP(1) |
140 | .PP | ||
157 | The full documentation for | 141 | The full documentation for |
158 | .B gnunet | 142 | .B gnunet |
159 | is maintained as a Texinfo manual. If the | 143 | is maintained as a Texinfo manual. |
144 | If the | ||
160 | .B info | 145 | .B info |
161 | and | 146 | and |
162 | .B gnunet | 147 | .B gnunet |
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1 index ccb0f7206..f99be5104 100644 --- a/doc/man/gnunet-gns-proxy.1 +++ b/doc/man/gnunet-gns-proxy.1 | |||
@@ -1,24 +1,19 @@ | |||
1 | .TH GNUNET\-GNS\-PROXY 1 "Oct 25, 2012" "GNUnet" | 1 | .TH GNUNET-GNS-PROXY 1 "October 25, 2012" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy | 3 | gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-gns\-proxy | 5 | .B gnunet\-gns\-proxy |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | Most users will want to run this SOCKS proxy. It can be used in | 8 | Most users will want to run this SOCKS proxy. It can be used in |
13 | combination with browsers that support the SOCKS 4a protocol. | 9 | combination with browsers that support the SOCKS 4a protocol. |
14 | 10 | .PP | |
15 | The proxy will perform SSL authentication of GNS names and rewrite GNS | 11 | The proxy will perform SSL authentication of GNS names and rewrite GNS |
16 | enabled HTML content. To assert the validity of GNS names a local root | 12 | enabled HTML content. To assert the validity of GNS names a local root |
17 | CA certificate has to be generated that is used by the proxy. Thus | 13 | CA certificate has to be generated that is used by the proxy. Thus |
18 | "gnunet-gns-proxy-setup-ca" should be executed before the first launch | 14 | "gnunet-gns-proxy-setup-ca" should be executed before the first launch |
19 | of this proxy or the \-\-authority switch is used to specify an | 15 | of this proxy or the \-\-authority switch is used to specify an |
20 | appropriate CA certificate that is already trusted by the browser. | 16 | appropriate CA certificate that is already trusted by the browser. |
21 | |||
22 | .SH OPTIONS | 17 | .SH OPTIONS |
23 | .B | 18 | .B |
24 | .IP "\-c FILENAME, \-\-config=FILENAME" | 19 | .IP "\-c FILENAME, \-\-config=FILENAME" |
@@ -42,16 +37,16 @@ ERROR. | |||
42 | .B | 37 | .B |
43 | .IP "\-v, \-\-version" | 38 | .IP "\-v, \-\-version" |
44 | Print GNUnet version number. | 39 | Print GNUnet version number. |
45 | |||
46 | |||
47 | .SH BUGS | 40 | .SH BUGS |
48 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending | 41 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
49 | electronic mail to <bug\-gnunet@gnu.org> | 42 | electronic mail to <bug\-gnunet@gnu.org> |
50 | .SH SEE ALSO | 43 | .SH SEE ALSO |
51 | gnunet\-gns(1) | 44 | gnunet\-gns(1) |
45 | .PP | ||
52 | The full documentation for | 46 | The full documentation for |
53 | .B gnunet | 47 | .B gnunet |
54 | is maintained as a Texinfo manual. If the | 48 | is maintained as a Texinfo manual. |
49 | If the | ||
55 | .B info | 50 | .B info |
56 | and | 51 | and |
57 | .B gnunet | 52 | .B gnunet |
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1 index fc0f40eef..3f22145e2 100644 --- a/doc/man/gnunet-namestore-fcfsd.1 +++ b/doc/man/gnunet-namestore-fcfsd.1 | |||
@@ -1,36 +1,31 @@ | |||
1 | .TH GNUNET\-NAMESTORE-FCFSD 1 "5 Sep 2013" "GNUnet" | 1 | .TH GNUNET-NAMESTORE-FCFSD 1 "September 5, 2013" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-namestore-fcfsd \- HTTP server for GNU Name System First-Come-First-Served name registration | 3 | gnunet\-namestore-fcfsd \- HTTP server for GNU Name System First-Come-First-Served name registration |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-namestore-fcfsd | 5 | .B gnunet\-namestore-fcfsd |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | Most users will not want to run an FCFS\-zone and thus will not need | 8 | Most users will not want to run an FCFS\-zone and thus will not need |
13 | this program. | 9 | this program. |
14 | 10 | .PP | |
15 | \fBgnunet\-gns-fcfsd\fP runs a web server where users can register | 11 | \fBgnunet\-gns-fcfsd\fP runs a web server where users can register |
16 | names to be mapped to their GNS zone. Names are made available on a | 12 | names to be mapped to their GNS zone. Names are made available on a |
17 | First Come First Served basis (hence fcfs). Registered names do not | 13 | First Come First Served basis (hence fcfs). Registered names do not |
18 | expire. The HTTP server is run on the port that is specified in the | 14 | expire. The HTTP server is run on the port that is specified in the |
19 | configuration file in section "[fcfsd]" under the name "HTTPPORT". | 15 | configuration file in section "[fcfsd]" under the name "HTTPPORT". |
20 | 16 | .PP | |
21 | It is possible to manage gnunet\-gns\-fcfsd using | 17 | It is possible to manage gnunet\-gns\-fcfsd using |
22 | gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i | 18 | gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i |
23 | fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your | 19 | fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your |
24 | configuration and the "-z ZONE" in as the "OPTION". | 20 | configuration and the "-z ZONE" in as the "OPTION". |
25 | 21 | .PP | |
26 | An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are | 22 | An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are |
27 | encouraged to register their zone with the gnunet.org FCFS authority. | 23 | encouraged to register their zone with the gnunet.org FCFS authority. |
28 | 24 | .PP | |
29 | If you want to run your own FCFS registrar, you need to first create a | 25 | If you want to run your own FCFS registrar, you need to first create a |
30 | pseudonym (using "gnunet\-identity \-C NAME"), and use it with the | 26 | pseudonym (using "gnunet\-identity \-C NAME"), and use it with the |
31 | "-z" option. After that, you can start the FCFSD service (possibly using | 27 | "-z" option. After that, you can start the FCFSD service (possibly using |
32 | gnunet\-arm). | 28 | gnunet\-arm). |
33 | |||
34 | .SH OPTIONS | 29 | .SH OPTIONS |
35 | .B | 30 | .B |
36 | .IP "\-c FILENAME, \-\-config=FILENAME" | 31 | .IP "\-c FILENAME, \-\-config=FILENAME" |
@@ -48,15 +43,16 @@ Print GNUnet version number. | |||
48 | .B | 43 | .B |
49 | .IP "\-z EGO, \-\-zone=EGO" | 44 | .IP "\-z EGO, \-\-zone=EGO" |
50 | Specifies for which EGO should FCFSD manage the zone. | 45 | Specifies for which EGO should FCFSD manage the zone. |
51 | |||
52 | .SH BUGS | 46 | .SH BUGS |
53 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending | 47 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
54 | electronic mail to <bug\-gnunet@gnu.org> | 48 | electronic mail to <bug\-gnunet@gnu.org> |
55 | .SH SEE ALSO | 49 | .SH SEE ALSO |
56 | gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1) | 50 | gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1) |
51 | .PP | ||
57 | The full documentation for | 52 | The full documentation for |
58 | .B gnunet | 53 | .B gnunet |
59 | is maintained as a Texinfo manual. If the | 54 | is maintained as a Texinfo manual. |
55 | If the | ||
60 | .B info | 56 | .B info |
61 | and | 57 | and |
62 | .B gnunet | 58 | .B gnunet |
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1 index ca50d76fc..bc95972c4 100644 --- a/doc/man/gnunet-nat-auto.1 +++ b/doc/man/gnunet-nat-auto.1 | |||
@@ -1,77 +1,59 @@ | |||
1 | .TH GNUNET\-NAT\-AUTO 1 "6 Jan 2017" "GNUnet" | 1 | .TH GNUNET-NAT-AUTO 1 "January 6, 2017" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-nat\-auto \- autoconfigure and test NAT traversal | 3 | gnunet\-nat\-auto \- autoconfigure and test NAT traversal |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-nat\-auto | 5 | .B gnunet\-nat\-auto |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | |||
13 | This tool allows testing various NAT traversal functions, as well | 8 | This tool allows testing various NAT traversal functions, as well |
14 | as attempting auto\-configuration. | 9 | as attempting auto\-configuration. |
15 | |||
16 | .SH OPTIONS | 10 | .SH OPTIONS |
17 | .B | 11 | .B |
18 | .IP "\-a, \-\-auto" | 12 | .IP "\-a, \-\-auto" |
19 | Attempt auto\-configuration for NAT traversal. | 13 | Attempt auto\-configuration for NAT traversal. |
20 | |||
21 | .B | 14 | .B |
22 | .IP "\-c FILENAME, \-\-config=FILENAME" | 15 | .IP "\-c FILENAME, \-\-config=FILENAME" |
23 | Use the configuration file FILENAME. | 16 | Use the configuration file FILENAME. |
24 | |||
25 | .B | 17 | .B |
26 | .IP "\-S NAME, \-\-section=NAME" | 18 | .IP "\-S NAME, \-\-section=NAME" |
27 | Name of the configuration section with details about the configuration | 19 | Name of the configuration section with details about the configuration |
28 | to test. For example "transport-tcp". | 20 | to test. For example "transport-tcp". |
29 | |||
30 | .IP "\-t, \-\-tcp" | 21 | .IP "\-t, \-\-tcp" |
31 | Use TCP. | 22 | Use TCP. |
32 | |||
33 | .B | 23 | .B |
34 | .IP "\-u, \-\-udp" | 24 | .IP "\-u, \-\-udp" |
35 | Use UDP. | 25 | Use UDP. |
36 | |||
37 | .B | 26 | .B |
38 | .IP "\-w, \-\-write" | 27 | .IP "\-w, \-\-write" |
39 | Write configuration to configuration file, useful in combination with | 28 | Write configuration to configuration file, useful in combination with |
40 | autoconfiguration (\-a). | 29 | autoconfiguration (\-a). |
41 | |||
42 | .SH EXAMPLES | 30 | .SH EXAMPLES |
43 | .PP | 31 | .PP |
44 | |||
45 | \fBAutomatic configuration:\fR | 32 | \fBAutomatic configuration:\fR |
46 | 33 | .TP | |
47 | Probe and write result to configuration: | 34 | # gnunet\-nat\-auto \-aw |
48 | 35 | Probe and write result to configuration | |
49 | # gnunet\-nat\-auto \-aw | 36 | .PP |
50 | |||
51 | |||
52 | \fBTest configuration:\fR | 37 | \fBTest configuration:\fR |
53 | 38 | .TP | |
54 | Test TCP configuration: | 39 | # gnunet\-nat\-auto -t \-S transport-tcp |
55 | 40 | Test TCP configuration | |
56 | # gnunet\-nat\-auto -t \-S transport-tcp | 41 | .TP |
57 | 42 | # gnunet\-nat\-auto -t \-S transport-http | |
58 | Test HTTP configuration: | 43 | Test HTTP configuration |
59 | 44 | .TP | |
60 | # gnunet\-nat\-auto -t \-S transport-http | 45 | # gnunet\-nat\-auto -u \-S transport-udp |
61 | 46 | Test UDP configuration | |
62 | Test UDP configuration: | ||
63 | |||
64 | # gnunet\-nat\-auto -u \-S transport-udp | ||
65 | |||
66 | |||
67 | .SH BUGS | 47 | .SH BUGS |
68 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending | 48 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
69 | electronic mail to <gnunet\-developers@gnu.org> | 49 | electronic mail to <gnunet\-developers@gnu.org> |
70 | .SH SEE ALSO | 50 | .SH SEE ALSO |
71 | gnunet\-transport(1) gnunet\-nat(1) | 51 | gnunet\-transport(1) gnunet\-nat(1) |
52 | .PP | ||
72 | The full documentation for | 53 | The full documentation for |
73 | .B gnunet | 54 | .B gnunet |
74 | is maintained as a Texinfo manual. If the | 55 | is maintained as a Texinfo manual. |
56 | If the | ||
75 | .B info | 57 | .B info |
76 | and | 58 | and |
77 | .B gnunet | 59 | .B gnunet |
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1 index a97768340..1fdf1e265 100644 --- a/doc/man/gnunet-nat-server.1 +++ b/doc/man/gnunet-nat-server.1 | |||
@@ -1,23 +1,18 @@ | |||
1 | .TH GNUNET\-NAT\-SERVER 1 "25 Feb 2012" "GNUnet" | 1 | .TH GNUNET-NAT-SERVER 1 "February 25, 2012" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-nat\-server \- help GNUnet setup test network setup with NAT | 3 | gnunet\-nat\-server \- help GNUnet setup test network setup with NAT |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-nat\-server | 5 | .B gnunet\-nat\-server |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .RI PORT | 7 | .RI PORT |
10 | .br | ||
11 | |||
12 | .SH DESCRIPTION | 8 | .SH DESCRIPTION |
13 | |||
14 | Normal GNUnet end-users should not concern themselves with | 9 | Normal GNUnet end-users should not concern themselves with |
15 | gnunet\-nat\-server. In fact, distributions are encouraged to | 10 | gnunet\-nat\-server. In fact, distributions are encouraged to |
16 | consider not shipping it at all. Running gnunet\-nat\-server's is | 11 | consider not shipping it at all. Running gnunet\-nat\-server's is |
17 | similar to running hostlist servers: it is a special service to the | 12 | similar to running hostlist servers: it is a special service to the |
18 | community with special requirements and no benefit to those running | 13 | community with special requirements and no benefit to those running |
19 | the service. | 14 | the service. |
20 | 15 | .PP | |
21 | This program will listen on the specified PORT for incoming requests | 16 | This program will listen on the specified PORT for incoming requests |
22 | to test a peer's network connectivity. Incoming requests can ask it | 17 | to test a peer's network connectivity. Incoming requests can ask it |
23 | to connect to a given IPv4 address (and port) using TCP or UDP and to | 18 | to connect to a given IPv4 address (and port) using TCP or UDP and to |
@@ -25,41 +20,40 @@ send a 2-byte test message using the specified address. The program | |||
25 | can also be asked to send a "fake" ICMP response message to a given | 20 | can also be asked to send a "fake" ICMP response message to a given |
26 | IPv4 address (for autonomous NAT traversal \-\-\- see the description | 21 | IPv4 address (for autonomous NAT traversal \-\-\- see the description |
27 | in the respective research paper). | 22 | in the respective research paper). |
28 | 23 | .PP | |
29 | The idea is that gnunet\-nat\-server will be run on some trusted hosts | 24 | The idea is that gnunet\-nat\-server will be run on some trusted hosts |
30 | with unrestricted connectivity to allow GNUnet users to test their | 25 | with unrestricted connectivity to allow GNUnet users to test their |
31 | network configuration. As written, the code allows any user on the | 26 | network configuration. As written, the code allows any user on the |
32 | Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary | 27 | Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary |
33 | data to any TCP or UDP port at any address. We believe that this is | 28 | data to any TCP or UDP port at any address. We believe that this is |
34 | generally harmless. | 29 | generally harmless. |
35 | 30 | .PP | |
36 | When running gnunet\-nat\-server, make sure to use a configuration | 31 | When running gnunet\-nat\-server, make sure to use a configuration |
37 | that disables most NAT options but enables 'enable_nat_client' and | 32 | that disables most NAT options but enables 'enable_nat_client' and |
38 | sets 'internal_address' to the global IP address of your local host. | 33 | sets 'internal_address' to the global IP address of your local host. |
39 | Also, the gnunet\-helper\-nat\-client should be installed locally and | 34 | Also, the gnunet\-helper\-nat\-client should be installed locally and |
40 | run with root privileges (SUID), otherwise the gnunet\-nat\-server | 35 | run with root privileges (SUID), otherwise the gnunet\-nat\-server |
41 | will not work properly. | 36 | will not work properly. |
42 | 37 | .PP | |
43 | Note that gnunet\-nat\-server could be run via gnunet\-arm but | 38 | Note that gnunet\-nat\-server could be run via gnunet\-arm but |
44 | typically is not. Also, the name of the host and port that | 39 | typically is not. Also, the name of the host and port that |
45 | gnunet\-nat\-server is run on should be specified in the NATSERVER | 40 | gnunet\-nat\-server is run on should be specified in the NATSERVER |
46 | option in the [setup] section of the configuration file of hosts that | 41 | option in the [setup] section of the configuration file of hosts that |
47 | are supposed to autoconfigure with this server. | 42 | are supposed to autoconfigure with this server. |
48 | |||
49 | |||
50 | .SH OPTIONS | 43 | .SH OPTIONS |
51 | .B | 44 | .B |
52 | .IP "\-c FILENAME, \-\-config=FILENAME" | 45 | .IP "\-c FILENAME, \-\-config=FILENAME" |
53 | Use the configuration file FILENAME. | 46 | Use the configuration file FILENAME. |
54 | |||
55 | .SH BUGS | 47 | .SH BUGS |
56 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending | 48 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
57 | electronic mail to <gnunet\-developers@gnu.org> | 49 | electronic mail to <gnunet\-developers@gnu.org> |
58 | .SH SEE ALSO | 50 | .SH SEE ALSO |
59 | gnunet\-transport(1) | 51 | gnunet\-transport(1) |
52 | .PP | ||
60 | The full documentation for | 53 | The full documentation for |
61 | .B gnunet | 54 | .B gnunet |
62 | is maintained as a Texinfo manual. If the | 55 | is maintained as a Texinfo manual. |
56 | If the | ||
63 | .B info | 57 | .B info |
64 | and | 58 | and |
65 | .B gnunet | 59 | .B gnunet |
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1 index 5c610b59f..03246d968 100644 --- a/doc/man/gnunet-peerinfo.1 +++ b/doc/man/gnunet-peerinfo.1 | |||
@@ -1,23 +1,18 @@ | |||
1 | .TH GNUNET\-PEERINFO 1 "Mar 4, 2013" "GNUnet" | 1 | .TH GNUNET-PEERINFO 1 "March 4, 2013" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-peerinfo \- Display information about other peers. | 3 | gnunet\-peerinfo \- Display information about other peers. |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-peerinfo | 5 | .B gnunet\-peerinfo |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | .PP | 8 | .PP |
13 | \fBgnunet\-peerinfo\fP display the known addresses and trust of known peers. | 9 | \fBgnunet\-peerinfo\fP display the known addresses and trust of known peers. |
14 | |||
15 | .SH OPTIONS | 10 | .SH OPTIONS |
16 | .B | 11 | .B |
17 | .IP "\-c FILENAME, \-\-config=FILENAME" | 12 | .IP "\-c FILENAME, \-\-config=FILENAME" |
18 | Load config file (default: ~/.config/gnunet.conf) | 13 | Load config file (default: ~/.config/gnunet.conf) |
19 | .B | 14 | .B |
20 | .IP "\-g, \-\-get\-hello | 15 | .IP "\-g, \-\-get\-hello" |
21 | Output HELLO uri(s) | 16 | Output HELLO uri(s) |
22 | .B | 17 | .B |
23 | .IP "\-h, \-\-help" | 18 | .IP "\-h, \-\-help" |
@@ -35,7 +30,7 @@ Log messages to LOGFILE | |||
35 | .IP "\-n, \-\-numeric" | 30 | .IP "\-n, \-\-numeric" |
36 | Disable resolution of IPs to hostnames | 31 | Disable resolution of IPs to hostnames |
37 | .B | 32 | .B |
38 | .IP "\-p, \-\-put\-hello=HELLO | 33 | .IP "\-p, \-\-put\-hello=HELLO" |
39 | Add given HELLO uri to the database | 34 | Add given HELLO uri to the database |
40 | .B | 35 | .B |
41 | .IP "\-q, \-\-quiet" | 36 | .IP "\-q, \-\-quiet" |
@@ -48,16 +43,16 @@ order to consider this peer one of their friends in F2F mode). | |||
48 | .B | 43 | .B |
49 | .IP "\-v, \-\-version" | 44 | .IP "\-v, \-\-version" |
50 | Print the version number | 45 | Print the version number |
51 | |||
52 | |||
53 | .SH BUGS | 46 | .SH BUGS |
54 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending | 47 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending |
55 | electronic mail to <gnunet\-developers@gnu.org> | 48 | electronic mail to <gnunet\-developers@gnu.org> |
56 | .SH SEE ALSO | 49 | .SH SEE ALSO |
57 | gnunet.conf(5) | 50 | gnunet.conf(5) |
51 | .PP | ||
58 | The full documentation for | 52 | The full documentation for |
59 | .B gnunet | 53 | .B gnunet |
60 | is maintained as a Texinfo manual. If the | 54 | is maintained as a Texinfo manual. |
55 | If the | ||
61 | .B info | 56 | .B info |
62 | and | 57 | and |
63 | .B gnunet | 58 | .B gnunet |
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-resolver.1 index 743731fc4..56eef560d 100644 --- a/doc/man/gnunet-resolver.1 +++ b/doc/man/gnunet-resolver.1 | |||
@@ -1,16 +1,11 @@ | |||
1 | .TH GNUNET\-RESOLVER 1 "Jan 4, 2012" "GNUnet" | 1 | .TH GNUNET-RESOLVER 1 "January 4, 2012" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-resolver \- build-in GNUnet stub resolver | 3 | gnunet\-resolver \- build-in GNUnet stub resolver |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-resolver | 5 | .B gnunet\-resolver |
8 | .RI [ options ] [ hostname ] | 6 | .RI [ options ] [ hostname ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | \fBgnunet\-resolver\fP uses build-in GNUnet stub resolver. | 8 | \fBgnunet\-resolver\fP uses build-in GNUnet stub resolver. |
13 | |||
14 | .SH OPTIONS | 9 | .SH OPTIONS |
15 | .B | 10 | .B |
16 | .IP "\-c FILENAME, \-\-config=FILENAME" | 11 | .IP "\-c FILENAME, \-\-config=FILENAME" |
@@ -31,13 +26,14 @@ Perform a reverse lookup. | |||
31 | .B | 26 | .B |
32 | .IP "\-v, \-\-version" | 27 | .IP "\-v, \-\-version" |
33 | Print GNUnet version number. | 28 | Print GNUnet version number. |
34 | |||
35 | .SH BUGS | 29 | .SH BUGS |
36 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 30 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
37 | .SH "SEE ALSO" | 31 | electronic mail to <gnunet\-developers@gnu.org> |
32 | .SH SEE ALSO | ||
38 | The full documentation for | 33 | The full documentation for |
39 | .B gnunet | 34 | .B gnunet |
40 | is maintained as a Texinfo manual. If the | 35 | is maintained as a Texinfo manual. |
36 | If the | ||
41 | .B info | 37 | .B info |
42 | and | 38 | and |
43 | .B gnunet | 39 | .B gnunet |
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1 index 548a03943..4ccb2a740 100644 --- a/doc/man/gnunet-scalarproduct.1 +++ b/doc/man/gnunet-scalarproduct.1 | |||
@@ -1,17 +1,13 @@ | |||
1 | .TH GNUNET\-VECTORPRODUCT 1 "8 Aug 2013" "GNUnet" | 1 | .TH GNUNET-VECTORPRODUCT 1 "August 8, 2013" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-vectorproduct \- compute a vectorproduct | 3 | gnunet\-vectorproduct \- compute a vectorproduct |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-vectorproduct | 5 | .B gnunet\-vectorproduct |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | \fBgnunet-vectorproduct\fP enables you to compute a vectorproduct | 8 | \fBgnunet-vectorproduct\fP enables you to compute a vectorproduct |
13 | across two peers \fBAlice\fP and \fBBob\fP. | 9 | across two peers \fBAlice\fP and \fBBob\fP. |
14 | 10 | .PP | |
15 | A client can issue one of two messages to its service: | 11 | A client can issue one of two messages to its service: |
16 | .TS | 12 | .TS |
17 | tab (@); | 13 | tab (@); |
@@ -23,17 +19,16 @@ T} | |||
23 | Elements to support a peer in computing a vectorproduct (\fBBob\fP) | 19 | Elements to support a peer in computing a vectorproduct (\fBBob\fP) |
24 | T} | 20 | T} |
25 | .TE | 21 | .TE |
26 | |||
27 | Both requests must share the same SID, which can be an arbitrary | 22 | Both requests must share the same SID, which can be an arbitrary |
28 | string identifying the session. SIDs should be unique, however it is | 23 | string identifying the session. SIDs should be unique, however it is |
29 | sufficient to guarantee the uniqueness of the tupel element count and | 24 | sufficient to guarantee the uniqueness of the tupel element count and |
30 | session ID. | 25 | session ID. |
31 | 26 | .PP | |
32 | \fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s | 27 | \fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s |
33 | service, it will internally be checked by the client for | 28 | service, it will internally be checked by the client for |
34 | validity. Invalid values here result in the client or the service | 29 | validity. Invalid values here result in the client or the service |
35 | failing the session. | 30 | failing the session. |
36 | 31 | .PP | |
37 | Elements are handed over as signed decimal integers, the element count | 32 | Elements are handed over as signed decimal integers, the element count |
38 | supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also | 33 | supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also |
39 | supply a mask for these values to her service, which allows partial | 34 | supply a mask for these values to her service, which allows partial |
@@ -42,11 +37,10 @@ masked by setting their the corresponding mask element to zero, any | |||
42 | other value means the element will not be masked. \fBAlice\fP\'s | 37 | other value means the element will not be masked. \fBAlice\fP\'s |
43 | client will also mask all 0-values to avoid information leakage to | 38 | client will also mask all 0-values to avoid information leakage to |
44 | \fBBob\fP. | 39 | \fBBob\fP. |
45 | 40 | .PP | |
46 | The protocol by definition relies on \fBAlice\fP and \fBBob\fP being | 41 | The protocol by definition relies on \fBAlice\fP and \fBBob\fP being |
47 | benign, thus \fBBob\fP can arbitrarily falsify his information. Both | 42 | benign, thus \fBBob\fP can arbitrarily falsify his information. Both |
48 | peers collaborate to achieve a correct result. | 43 | peers collaborate to achieve a correct result. |
49 | |||
50 | .SH OPTIONS | 44 | .SH OPTIONS |
51 | .B | 45 | .B |
52 | .IP "\-e ELEMENTS, \-\-elements=ELEMENTS" | 46 | .IP "\-e ELEMENTS, \-\-elements=ELEMENTS" |
@@ -78,16 +72,16 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | |||
78 | .B | 72 | .B |
79 | .IP "\-v, \-\-version" | 73 | .IP "\-v, \-\-version" |
80 | Print GNUnet version number. | 74 | Print GNUnet version number. |
81 | |||
82 | |||
83 | .SH BUGS | 75 | .SH BUGS |
84 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 76 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
85 | 77 | electronic mail to <gnunet\-developers@gnu.org> | |
86 | .SH SEE ALSO | 78 | .SH SEE ALSO |
87 | gnunet\-peerinfo(1) | 79 | gnunet\-peerinfo(1) |
80 | .PP | ||
88 | The full documentation for | 81 | The full documentation for |
89 | .B gnunet | 82 | .B gnunet |
90 | is maintained as a Texinfo manual. If the | 83 | is maintained as a Texinfo manual. |
84 | If the | ||
91 | .B info | 85 | .B info |
92 | and | 86 | and |
93 | .B gnunet | 87 | .B gnunet |
diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1 index a05888dcd..d156e17e8 100644 --- a/doc/man/gnunet-scrypt.1 +++ b/doc/man/gnunet-scrypt.1 | |||
@@ -1,17 +1,12 @@ | |||
1 | .TH GNUNET\-SCRYPT 1 "Sep 13, 2014" "GNUnet" | 1 | .TH GNUNET-SCRYPT 1 "September 13, 2014" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-scrypt \- Manipulate GNUnet proof of work files. | 3 | gnunet\-scrypt \- Manipulate GNUnet proof of work files. |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-scrypt | 5 | .B gnunet\-scrypt |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | \fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof | 8 | \fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof |
13 | of work files. | 9 | of work files. |
14 | |||
15 | .SH OPTIONS | 10 | .SH OPTIONS |
16 | .B | 11 | .B |
17 | .IP "\-b BITS, \-\-bits=BITS" | 12 | .IP "\-b BITS, \-\-bits=BITS" |
@@ -40,13 +35,14 @@ Time to wait between calculations. | |||
40 | .B | 35 | .B |
41 | .IP "\-v, \-\-version" | 36 | .IP "\-v, \-\-version" |
42 | Print GNUnet version number. | 37 | Print GNUnet version number. |
43 | |||
44 | .SH BUGS | 38 | .SH BUGS |
45 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 39 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
46 | .SH "SEE ALSO" | 40 | electronic mail to <gnunet\-developers@gnu.org> |
41 | .SH SEE ALSO | ||
47 | The full documentation for | 42 | The full documentation for |
48 | .B gnunet | 43 | .B gnunet |
49 | is maintained as a Texinfo manual. If the | 44 | is maintained as a Texinfo manual. |
45 | If the | ||
50 | .B info | 46 | .B info |
51 | and | 47 | and |
52 | .B gnunet | 48 | .B gnunet |
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1 index 6b3d06f59..e61a8493c 100644 --- a/doc/man/gnunet-statistics.1 +++ b/doc/man/gnunet-statistics.1 | |||
@@ -1,21 +1,16 @@ | |||
1 | .TH GNUNET\-STATISTICS 1 "Jan 4, 2012" "GNUnet" | 1 | .TH GNUNET-STATISTICS 1 "January 4, 2012" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-statistics \- Display statistics about your GNUnet system | 3 | gnunet\-statistics \- Display statistics about your GNUnet system |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-statistics | 5 | .B gnunet\-statistics |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .RI [ VALUE ] | 7 | .RI [ VALUE ] |
10 | .br | ||
11 | |||
12 | .SH DESCRIPTION | 8 | .SH DESCRIPTION |
13 | \fBgnunet\-statistics\fP is used to display detailed information about | 9 | \fBgnunet\-statistics\fP is used to display detailed information about |
14 | various aspect of GNUnet's operation. This tool only works if the | 10 | various aspect of GNUnet's operation. This tool only works if the |
15 | "statistics" service is available. | 11 | "statistics" service is available. |
16 | gnunet\-statistics can be used to set a value by giving the options | 12 | gnunet\-statistics can be used to set a value by giving the options |
17 | \-n, \-s and also a VALUE. | 13 | \-n, \-s and also a VALUE. |
18 | |||
19 | .SH OPTIONS | 14 | .SH OPTIONS |
20 | .B | 15 | .B |
21 | .IP "\-c FILENAME, \-\-config=FILENAME" | 16 | .IP "\-c FILENAME, \-\-config=FILENAME" |
@@ -50,16 +45,16 @@ folder containing the data of all testbed nodes like \fBgnunet\-statistics -t /t | |||
50 | .B | 45 | .B |
51 | .IP "\-v, \-\-version" | 46 | .IP "\-v, \-\-version" |
52 | Print GNUnet version number. | 47 | Print GNUnet version number. |
53 | |||
54 | |||
55 | .SH BUGS | 48 | .SH BUGS |
56 | Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 49 | Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending |
57 | 50 | electronic mail to <gnunet\-developers@gnu.org> | |
58 | .SH SEE ALSO | 51 | .SH SEE ALSO |
59 | gnunet\-service\-statistics(1) | 52 | gnunet\-service\-statistics(1) |
53 | .PP | ||
60 | The full documentation for | 54 | The full documentation for |
61 | .B gnunet | 55 | .B gnunet |
62 | is maintained as a Texinfo manual. If the | 56 | is maintained as a Texinfo manual. |
57 | If the | ||
63 | .B info | 58 | .B info |
64 | and | 59 | and |
65 | .B gnunet | 60 | .B gnunet |
diff --git a/doc/man/gnunet-testing-run-service.1 b/doc/man/gnunet-testing-run-service.1 index ec7cdcdfa..60c40bf7f 100644 --- a/doc/man/gnunet-testing-run-service.1 +++ b/doc/man/gnunet-testing-run-service.1 | |||
@@ -1,26 +1,21 @@ | |||
1 | .TH GNUNET\-TESTING\-RUN\-SERVICE 1 "Aug 25, 2013" "GNUnet" | 1 | .TH GNUNET-TESTING-RUN-SERVICE 1 "August 25, 2013" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-testing\-run\-service \- Command line tool to start a service for testing. | 3 | gnunet\-testing\-run\-service \- Command line tool to start a service for testing. |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-testing\-run\-service | 5 | .B gnunet\-testing\-run\-service |
8 | .RI [ options ] | 6 | .RI [ options ] |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | \fBgnunet\-testing\-run\-service\fP is a command line tool to start a | 8 | \fBgnunet\-testing\-run\-service\fP is a command line tool to start a |
13 | service for testing. It starts a peer, running only the service | 9 | service for testing. It starts a peer, running only the service |
14 | specified on the command line, outputs the path to the temporary | 10 | specified on the command line, outputs the path to the temporary |
15 | configuration file to stdout. | 11 | configuration file to stdout. |
16 | 12 | .PP | |
17 | The peer will run until this program is killed, or stdin is | 13 | The peer will run until this program is killed, or stdin is |
18 | closed. When reading the character 'r' from stdin, the running service | 14 | closed. When reading the character 'r' from stdin, the running service |
19 | is restarted with the same configuration. | 15 | is restarted with the same configuration. |
20 | 16 | .PP | |
21 | This executable is intended to be used by gnunet-java, in order to | 17 | This executable is intended to be used by gnunet-java, in order to |
22 | reliably start and stop services for test cases. | 18 | reliably start and stop services for test cases. |
23 | |||
24 | .SH OPTIONS | 19 | .SH OPTIONS |
25 | .B | 20 | .B |
26 | .IP "\-c FILENAME, \-\-config=FILENAME" | 21 | .IP "\-c FILENAME, \-\-config=FILENAME" |
@@ -31,13 +26,14 @@ Print short help on options. | |||
31 | .B | 26 | .B |
32 | .IP "\-s SERVICE, \-\-service=SERVICE" | 27 | .IP "\-s SERVICE, \-\-service=SERVICE" |
33 | Name of the service to run. | 28 | Name of the service to run. |
34 | |||
35 | .SH BUGS | 29 | .SH BUGS |
36 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 30 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
37 | .SH "SEE ALSO" | 31 | electronic mail to <gnunet\-developers@gnu.org> |
32 | .SH SEE ALSO | ||
38 | The full documentation for | 33 | The full documentation for |
39 | .B gnunet | 34 | .B gnunet |
40 | is maintained as a Texinfo manual. If the | 35 | is maintained as a Texinfo manual. |
36 | If the | ||
41 | .B info | 37 | .B info |
42 | and | 38 | and |
43 | .B gnunet | 39 | .B gnunet |
diff --git a/doc/man/gnunet-timeout.1 b/doc/man/gnunet-timeout.1 index d23389523..8adb85571 100644 --- a/doc/man/gnunet-timeout.1 +++ b/doc/man/gnunet-timeout.1 | |||
@@ -1,26 +1,23 @@ | |||
1 | .TH GNUNET\-TIMOUET 1 "Jun 5, 2018" "GNUnet" | 1 | .TH GNUNET-TIMOUET 1 "June 5, 2018" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-timeout \- run process with timeout | 3 | gnunet\-timeout \- run process with timeout |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-timeout | 5 | .B gnunet\-timeout |
8 | .RI TIMEOUT PROGRAM ARGS | 6 | .RI TIMEOUT PROGRAM ARGS |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | \fBgnunet\-timeout\fP can be used to run another process with a | 8 | \fBgnunet\-timeout\fP can be used to run another process with a |
13 | timeout. Provided as the standard "timout" utility may not be | 9 | timeout. Provided as the standard "timout" utility may not be |
14 | available on all platforms. | 10 | available on all platforms. |
15 | |||
16 | .SH BUGS | 11 | .SH BUGS |
17 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 12 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
18 | 13 | electronic mail to <gnunet\-developers@gnu.org> | |
19 | .SH SEE | 14 | .SH SEE ALSO |
20 | timeout(1) | 15 | timeout(1) |
16 | .PP | ||
21 | The full documentation for | 17 | The full documentation for |
22 | .B gnunet | 18 | .B gnunet |
23 | is maintained as a Texinfo manual. If the | 19 | is maintained as a Texinfo manual. |
20 | If the | ||
24 | .B info | 21 | .B info |
25 | and | 22 | and |
26 | .B gnunet | 23 | .B gnunet |
diff --git a/doc/man/gnunet-transport-certificate-creation.1 b/doc/man/gnunet-transport-certificate-creation.1 index 894ed2de8..0e1e681f8 100644 --- a/doc/man/gnunet-transport-certificate-creation.1 +++ b/doc/man/gnunet-transport-certificate-creation.1 | |||
@@ -1,25 +1,22 @@ | |||
1 | .TH GNUNET\-TRANSPORT\-CERTIFICATE\-CREATION 1 "Jan 31, 2014" "GNUnet" | 1 | .TH GNUNET\-TRANSPORT-CERTIFICATE-CREATION 1 "January 31, 2014" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-transport\-certificate\-creation \- create certificate for HTTPS transport | 3 | gnunet\-transport\-certificate\-creation \- create certificate for HTTPS transport |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-transport\-certificate\-creation | 5 | .B gnunet\-transport\-certificate\-creation |
8 | .I privatekey certificate | 6 | .I privatekey certificate |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | \fBgnunet\-transport\-certificate\-creation\fP uses openssl to generate a RSA | 8 | \fBgnunet\-transport\-certificate\-creation\fP uses openssl to generate a RSA |
13 | private key and then a self-signed certificate for HTTPS transport. | 9 | private key and then a self-signed certificate for HTTPS transport. |
14 | |||
15 | .SH BUGS | 10 | .SH BUGS |
16 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 11 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
17 | 12 | electronic mail to <gnunet\-developers@gnu.org> | |
18 | .SH SEE ALSO | 13 | .SH SEE ALSO |
19 | gnunet\-transport(1) | 14 | gnunet\-transport(1) |
15 | .PP | ||
20 | The full documentation for | 16 | The full documentation for |
21 | .B gnunet | 17 | .B gnunet |
22 | is maintained as a Texinfo manual. If the | 18 | is maintained as a Texinfo manual. |
19 | If the | ||
23 | .B info | 20 | .B info |
24 | and | 21 | and |
25 | .B gnunet | 22 | .B gnunet |
diff --git a/doc/man/gnunet-uri.1 b/doc/man/gnunet-uri.1 index bfb8fa0f8..72105c4c8 100644 --- a/doc/man/gnunet-uri.1 +++ b/doc/man/gnunet-uri.1 | |||
@@ -1,20 +1,15 @@ | |||
1 | .TH GNUNET\-URI 1 "Jun 26, 2012" "GNUnet" | 1 | .TH GNUNET-URI 1 "June 26, 2012" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-uri \- invoke default handler for GNUnet URIs | 3 | gnunet\-uri \- invoke default handler for GNUnet URIs |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-uri | 5 | .B gnunet\-uri |
8 | .RI URI | 6 | .RI URI |
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
12 | \fBgnunet\-uri\fP can be used to invoke the correct tool to handle a | 8 | \fBgnunet\-uri\fP can be used to invoke the correct tool to handle a |
13 | GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" | 9 | GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" |
14 | and thus the specific tool to handle the URI depends on the subsystem. | 10 | and thus the specific tool to handle the URI depends on the subsystem. |
15 | gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM | 11 | gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM |
16 | in the configuration section "uri") and invoke it. | 12 | in the configuration section "uri") and invoke it. |
17 | |||
18 | .SH OPTIONS | 13 | .SH OPTIONS |
19 | .B | 14 | .B |
20 | .IP "\-c FILENAME, \-\-config=FILENAME" | 15 | .IP "\-c FILENAME, \-\-config=FILENAME" |
@@ -28,14 +23,14 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | |||
28 | .B | 23 | .B |
29 | .IP "\-v, \-\-version" | 24 | .IP "\-v, \-\-version" |
30 | Print GNUnet version number. | 25 | Print GNUnet version number. |
31 | |||
32 | |||
33 | .SH BUGS | 26 | .SH BUGS |
34 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 27 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
35 | .SH "SEE ALSO" | 28 | electronic mail to <gnunet\-developers@gnu.org> |
29 | .SH SEE ALSO | ||
36 | The full documentation for | 30 | The full documentation for |
37 | .B gnunet | 31 | .B gnunet |
38 | is maintained as a Texinfo manual. If the | 32 | is maintained as a Texinfo manual. |
33 | If the | ||
39 | .B info | 34 | .B info |
40 | and | 35 | and |
41 | .B gnunet | 36 | .B gnunet |
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1 index 0b3f44fff..97d784136 100644 --- a/doc/man/gnunet-zoneimport.1 +++ b/doc/man/gnunet-zoneimport.1 | |||
@@ -1,12 +1,8 @@ | |||
1 | .TH GNUNET\-ZONEIMPORT 1 "Apr 23, 2018" "GNUnet" | 1 | .TH GNUNET-ZONEIMPORT 1 "April 23, 2018" "GNUnet" |
2 | |||
3 | .SH NAME | 2 | .SH NAME |
4 | gnunet\-zoneimport \- import DNS zone into GNS zone | 3 | gnunet\-zoneimport \- import DNS zone into GNS zone |
5 | |||
6 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
7 | .B gnunet\-zoneimport [IP]+ | 5 | .B gnunet\-zoneimport [IP]+ |
8 | .br | ||
9 | |||
10 | .SH DESCRIPTION | 6 | .SH DESCRIPTION |
11 | \fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from | 7 | \fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from |
12 | stdin and issues DNS queries for each of the domain names given. It | 8 | stdin and issues DNS queries for each of the domain names given. It |
@@ -17,29 +13,28 @@ will look for an ego called "com.fr"). If so, it will convert the DNS | |||
17 | records into GNS records (in particular converting NS records and glue | 13 | records into GNS records (in particular converting NS records and glue |
18 | records to GNS2DNS records) and add them to the namestore under the | 14 | records to GNS2DNS records) and add them to the namestore under the |
19 | label ("example" in the examples above). | 15 | label ("example" in the examples above). |
20 | 16 | .PP | |
21 | The arguments given to gnunet\-zoneimport is a list of IP addresses of | 17 | The arguments given to gnunet\-zoneimport is a list of IP addresses of |
22 | DNS servers to query. | 18 | DNS servers to query. |
23 | 19 | .PP | |
24 | gnunet\-zoneimport will usually never terminate: it will check when | 20 | gnunet\-zoneimport will usually never terminate: it will check when |
25 | DNS records expire, and re-issue requests when the old DNS records | 21 | DNS records expire, and re-issue requests when the old DNS records |
26 | have expired so that GNS always has the latest data. | 22 | have expired so that GNS always has the latest data. |
27 | 23 | .PP | |
28 | gnunet\-zoneimport will issue many DNS queries in parallel, but is | 24 | gnunet\-zoneimport will issue many DNS queries in parallel, but is |
29 | rate-limited in various ways, so most DNS servers should easily handle | 25 | rate-limited in various ways, so most DNS servers should easily handle |
30 | the load. gnunet\-zoneimport will perform a limited number of retries | 26 | the load. gnunet\-zoneimport will perform a limited number of retries |
31 | if queries fail. | 27 | if queries fail. |
32 | 28 | .PP | |
33 | gnunet\-zoneimport operates incrementally. It will check if the | 29 | gnunet\-zoneimport operates incrementally. It will check if the |
34 | namestore already has (non-expired) records stored for a given name in | 30 | namestore already has (non-expired) records stored for a given name in |
35 | the respective zone and not issue those requests again. Thus, it is | 31 | the respective zone and not issue those requests again. Thus, it is |
36 | fine to restart gnunet\-zoneimport whenever the list of domain names | 32 | fine to restart gnunet\-zoneimport whenever the list of domain names |
37 | changes. | 33 | changes. |
38 | 34 | .PP | |
39 | Finally, gnunet\-zoneimport keeps information for each domain name in | 35 | Finally, gnunet\-zoneimport keeps information for each domain name in |
40 | memory. This consumes about 200 bytes per domain name, or 1 GB for 5 | 36 | memory. This consumes about 200 bytes per domain name, or 1 GB for 5 |
41 | million labels. | 37 | million labels. |
42 | |||
43 | .SH OPTIONS | 38 | .SH OPTIONS |
44 | .B | 39 | .B |
45 | .IP "\-c FILENAME, \-\-config=FILENAME" | 40 | .IP "\-c FILENAME, \-\-config=FILENAME" |
@@ -55,7 +50,6 @@ is less than RELATIVETIME into the future. RELATIVETIME is a time | |||
55 | given like "1 week" or "1 h". If DNS returns records with a shorter | 50 | given like "1 week" or "1 h". If DNS returns records with a shorter |
56 | lifetime, gnunet\-zoneimport will simply bump the lifetime to the | 51 | lifetime, gnunet\-zoneimport will simply bump the lifetime to the |
57 | specified value (relative to the time of the import). Default is zero. | 52 | specified value (relative to the time of the import). Default is zero. |
58 | |||
59 | .IP "\-s MAPSIZE, \-\-size=MAPSIZE" | 53 | .IP "\-s MAPSIZE, \-\-size=MAPSIZE" |
60 | Specifies the size (in number of entries) to use for the main hash | 54 | Specifies the size (in number of entries) to use for the main hash |
61 | map. The value provided should be at least twice the number of domain | 55 | map. The value provided should be at least twice the number of domain |
@@ -64,24 +58,20 @@ large zones where the number of records encountered is too large for | |||
64 | the automatic growth mechanism to work (that one is limited to at most | 58 | the automatic growth mechanism to work (that one is limited to at most |
65 | 16 MB allocations for security reasons). Do not worry about this | 59 | 16 MB allocations for security reasons). Do not worry about this |
66 | unless you are importing millions of domain names from a zone. | 60 | unless you are importing millions of domain names from a zone. |
67 | |||
68 | .SH NOTES | 61 | .SH NOTES |
69 | 62 | .TP | |
70 | Typical invocaton would be: | 63 | Typical invocaton would be: |
71 | |||
72 | $ gnunet\-zoneimport 1.2.3.4 < names.txt | 64 | $ gnunet\-zoneimport 1.2.3.4 < names.txt |
73 | |||
74 | |||
75 | |||
76 | |||
77 | .SH BUGS | 65 | .SH BUGS |
78 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending | 66 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
79 | electronic mail to <gnunet\-developers@gnu.org> | 67 | electronic mail to <gnunet\-developers@gnu.org> |
80 | .SH SEE ALSO | 68 | .SH SEE ALSO |
81 | gnunet\-gns(1), gnunet\-namestore(1) | 69 | gnunet\-gns(1), gnunet\-namestore(1) |
70 | .PP | ||
82 | The full documentation for | 71 | The full documentation for |
83 | .B gnunet | 72 | .B gnunet |
84 | is maintained as a Texinfo manual. If the | 73 | is maintained as a Texinfo manual. |
74 | If the | ||
85 | .B info | 75 | .B info |
86 | and | 76 | and |
87 | .B gnunet | 77 | .B gnunet |
diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5 index 3aee4ed71..3c88305ba 100644 --- a/doc/man/gnunet.conf.5 +++ b/doc/man/gnunet.conf.5 | |||
@@ -1,12 +1,10 @@ | |||
1 | .\" -*- mode: nroff -*- | 1 | .\" -*- mode: nroff -*- |
2 | .TH GNUNET.CONF "5" "26 October 2018" "GNUnet" | 2 | .TH GNUNET.CONF "5" "October 26, 2018" "GNUnet" |
3 | .SH NAME | 3 | .SH NAME |
4 | gnunet.conf \- GNUnet configuration file | 4 | gnunet.conf \- GNUnet configuration file |
5 | .SH SYNOPSIS | 5 | .SH SYNOPSIS |
6 | ~/.config/gnunet.conf | 6 | ~/.config/gnunet.conf |
7 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
8 | .PP | ||
9 | |||
10 | A GNUnet setup typically consists of a set of service processes run by a user | 8 | A GNUnet setup typically consists of a set of service processes run by a user |
11 | "gnunet" and a set of user-interface processes run by a standard account. | 9 | "gnunet" and a set of user-interface processes run by a standard account. |
12 | The default location for the configuration file for the services is | 10 | The default location for the configuration file for the services is |
@@ -17,8 +15,7 @@ gnunet\-setup (part of the GNUnet GTK package) can be used to edit this | |||
17 | configuration. The parts of GNUnet that are run as a normal user may have | 15 | configuration. The parts of GNUnet that are run as a normal user may have |
18 | config options too and they read from "$HOME/.config/gnunet.conf". | 16 | config options too and they read from "$HOME/.config/gnunet.conf". |
19 | The latter config file can skip any options for the services. | 17 | The latter config file can skip any options for the services. |
20 | 18 | .PP | |
21 | .TP | ||
22 | The basic structure of the configuration file is the following. The file is | 19 | The basic structure of the configuration file is the following. The file is |
23 | split into sections. Every section begins with "[SECTIONNAME]" and contains | 20 | split into sections. Every section begins with "[SECTIONNAME]" and contains |
24 | a number of options of the form "OPTION=VALUE". | 21 | a number of options of the form "OPTION=VALUE". |
@@ -30,9 +27,7 @@ Default values for all of the options can be found in the files in the | |||
30 | "$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will | 27 | "$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will |
31 | work out of the box with those. See the examples section below for | 28 | work out of the box with those. See the examples section below for |
32 | some common setups on top of that. | 29 | some common setups on top of that. |
33 | |||
34 | .SH General OPTIONS | 30 | .SH General OPTIONS |
35 | .PP | ||
36 | Many options will be common between sections. They can be repeated under | 31 | Many options will be common between sections. They can be repeated under |
37 | each section with different values. The "[PATHS]" section is special. | 32 | each section with different values. The "[PATHS]" section is special. |
38 | Here, it is possible to specify values for variables like "GNUNET_HOME". | 33 | Here, it is possible to specify values for variables like "GNUNET_HOME". |
@@ -46,11 +41,8 @@ place of the absolute definition of "/tmp". | |||
46 | So instead of "/tmp/foo" you would write "$GNUNET_TMP/foo". | 41 | So instead of "/tmp/foo" you would write "$GNUNET_TMP/foo". |
47 | The usage of "$GNUNET_TMP/foo", will result in "$TMPDIR/gnunet/foo", or | 42 | The usage of "$GNUNET_TMP/foo", will result in "$TMPDIR/gnunet/foo", or |
48 | "$TMP/gnunet/foo" and finally, if "TMPDIR" is undefined, "/tmp/gnunet/foo". | 43 | "$TMP/gnunet/foo" and finally, if "TMPDIR" is undefined, "/tmp/gnunet/foo". |
49 | |||
50 | .PP | 44 | .PP |
51 | |||
52 | The following options are generic and shared by all services: | 45 | The following options are generic and shared by all services: |
53 | |||
54 | .IP HOSTNAME | 46 | .IP HOSTNAME |
55 | The hostname specifies the machine on which the service is running. | 47 | The hostname specifies the machine on which the service is running. |
56 | This is usually "localhost". | 48 | This is usually "localhost". |
@@ -93,12 +85,7 @@ The following options are generic and shared by all services: | |||
93 | Set to YES if this service should be run per-user, NO if this is a system | 85 | Set to YES if this service should be run per-user, NO if this is a system |
94 | service. End-users should never have to change the defaults GNUnet provides | 86 | service. End-users should never have to change the defaults GNUnet provides |
95 | for this option. | 87 | for this option. |
96 | |||
97 | |||
98 | |||
99 | .B | ||
100 | .SH ATS Options | 88 | .SH ATS Options |
101 | |||
102 | .IP UNSPECIFIED_QUOTA_IN | 89 | .IP UNSPECIFIED_QUOTA_IN |
103 | quotes in KiB or MiB per seconds. Or use the word "unlimited" | 90 | quotes in KiB or MiB per seconds. Or use the word "unlimited" |
104 | .IP UNSPECIFIED_QUOTA_OUT | 91 | .IP UNSPECIFIED_QUOTA_OUT |
@@ -119,9 +106,7 @@ The following options are generic and shared by all services: | |||
119 | quotes in KiB or MiB per seconds. Or use the word "unlimited" | 106 | quotes in KiB or MiB per seconds. Or use the word "unlimited" |
120 | .IP WLAN_QUOTA_OUT | 107 | .IP WLAN_QUOTA_OUT |
121 | quotes in KiB or MiB per seconds. Or use the word "unlimited" | 108 | quotes in KiB or MiB per seconds. Or use the word "unlimited" |
122 | |||
123 | .SH EXAMPLES | 109 | .SH EXAMPLES |
124 | |||
125 | This example is a simple way to get started, using a server that has a known | 110 | This example is a simple way to get started, using a server that has a known |
126 | list of peers to get you started. Most users will be behind a firewall on | 111 | list of peers to get you started. Most users will be behind a firewall on |
127 | IPv4, as such NAT is enabled. Please rememeber to change your IP address | 112 | IPv4, as such NAT is enabled. Please rememeber to change your IP address |
@@ -140,7 +125,6 @@ to the actual external address for your usage. | |||
140 | [arm] | 125 | [arm] |
141 | START_SYSTEM_SERVICES = YES | 126 | START_SYSTEM_SERVICES = YES |
142 | START_USER_SERVICES = NO | 127 | START_USER_SERVICES = NO |
143 | |||
144 | .SH FILES | 128 | .SH FILES |
145 | .TP | 129 | .TP |
146 | ~/.config/gnunet.conf | 130 | ~/.config/gnunet.conf |
@@ -150,9 +134,11 @@ Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending | |||
150 | electronic mail to <bug-gnunet@gnu.org> | 134 | electronic mail to <bug-gnunet@gnu.org> |
151 | .SH SEE ALSO | 135 | .SH SEE ALSO |
152 | \fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) | 136 | \fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) |
137 | .PP | ||
153 | The full documentation for | 138 | The full documentation for |
154 | .B gnunet | 139 | .B gnunet |
155 | is maintained as a Texinfo manual. If the | 140 | is maintained as a Texinfo manual. |
141 | If the | ||
156 | .B info | 142 | .B info |
157 | and | 143 | and |
158 | .B gnunet | 144 | .B gnunet |
@@ -168,4 +154,4 @@ will give you access to a tutorial for developers. | |||
168 | .PP | 154 | .PP |
169 | Depending on your installation, this information is also | 155 | Depending on your installation, this information is also |
170 | available in | 156 | available in |
171 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). \ No newline at end of file | 157 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). |