aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
committerNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
commitd269419d23e8c4c062e21e5bd88cdee66a1680b0 (patch)
treec9661262fee4604bd83b0bc739e7223c8cddfb0a /doc
parent4be442739c7f6745848a2f5544a59592f06a6cb3 (diff)
downloadgnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.tar.gz
gnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.zip
doc/man: More fixes.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-arm.114
-rw-r--r--doc/man/gnunet-config.112
-rw-r--r--doc/man/gnunet-core.114
-rw-r--r--doc/man/gnunet-datastore.14
-rw-r--r--doc/man/gnunet-directory.112
-rw-r--r--doc/man/gnunet-download.129
-rw-r--r--doc/man/gnunet-gns-proxy.115
-rw-r--r--doc/man/gnunet-namestore-fcfsd.120
-rw-r--r--doc/man/gnunet-nat-auto.152
-rw-r--r--doc/man/gnunet-nat-server.122
-rw-r--r--doc/man/gnunet-peerinfo.117
-rw-r--r--doc/man/gnunet-resolver.116
-rw-r--r--doc/man/gnunet-scalarproduct.126
-rw-r--r--doc/man/gnunet-scrypt.116
-rw-r--r--doc/man/gnunet-statistics.117
-rw-r--r--doc/man/gnunet-testing-run-service.120
-rw-r--r--doc/man/gnunet-timeout.117
-rw-r--r--doc/man/gnunet-transport-certificate-creation.115
-rw-r--r--doc/man/gnunet-uri.117
-rw-r--r--doc/man/gnunet-zoneimport.130
-rw-r--r--doc/man/gnunet.conf.526
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
4gnunet\-arm \- control GNUnet services 3gnunet\-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
13the ARM service itself. The ARM service is a supervisor for GNUnet's 9the ARM service itself. The ARM service is a supervisor for GNUnet's
14service processes. ARM starts services on-demand or as configured and 10service processes. ARM starts services on-demand or as configured and
15re-starts them if they crash. 11re-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"
57Print GNUnet version number. 52Print GNUnet version number.
58
59
60.SH BUGS 53.SH BUGS
61Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 54Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
62electronic mail to <gnunet\-developers@gnu.org> 55electronic mail to <gnunet\-developers@gnu.org>
63
64.SH SEE ALSO 56.SH SEE ALSO
65gnunet\-config(1), gnunet\-setup(1) 57gnunet\-config(1), gnunet\-setup(1)
58.PP
66The full documentation for 59The full documentation for
67.B gnunet 60.B gnunet
68is maintained as a Texinfo manual. If the 61is maintained as a Texinfo manual.
62If the
69.B info 63.B info
70and 64and
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
4gnunet\-config \- manipulate GNUnet configuration files 3gnunet\-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"
48Print GNUnet version number. 43Print GNUnet version number.
49
50
51.SH BUGS 44.SH BUGS
52Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 45Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
53electronic mail to <gnunet\-developers@gnu.org> 46electronic mail to <gnunet\-developers@gnu.org>
54.SH SEE ALSO 47.SH SEE ALSO
55The full documentation for 48The full documentation for
56.B gnunet 49.B gnunet
57is maintained as a Texinfo manual. If the 50is maintained as a Texinfo manual.
51If the
58.B info 52.B info
59and 53and
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
3gnunet\-core \- monitor CORE subsystem 3gnunet\-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
11gnunet\-core is a tool to access various functions of GNUnet's core subsystem 8gnunet\-core is a tool to access various functions of GNUnet's core subsystem
12from the command\-line. The only function right now is to monitor the status 9from the command\-line. The only function right now is to monitor the status
13of peers known to the CORE service. 10of 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
17configuration file to use 13configuration 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
33be verbose 29be verbose
34
35.SH NOTES
36
37
38.SH BUGS 30.SH BUGS
39Report bugs by using mantis <https://gnunet.org/bugs/> or by sending 31Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
40electronic mail to <gnunet\-developers@gnu.org> 32electronic 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
43The full documentation for 36The full documentation for
44.B gnunet 37.B gnunet
45is maintained as a Texinfo manual. If the 38is maintained as a Texinfo manual.
39If the
46.B info 40.B info
47and 41and
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
3gnunet\-datastore \- dump or insert (restore) GNUnet datastore databases 3gnunet\-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
9gnunet\-datastore can be used to backup and restore or merge GNUnet 8gnunet\-datastore can be used to backup and restore or merge GNUnet
10datastores. 9datastores.
11This is useful if a datastore is to be migrated between SQL databases, 10This 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
41electronic mail to <gnunet\-developers@gnu.org> 40electronic 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
44The full documentation for 44The full documentation for
45.B gnunet 45.B gnunet
46is maintained as a Texinfo manual. 46is 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
3gnunet\-directory \- display directories 3gnunet\-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
37better idea to publish a collection of pictures or compressed sound files 36better idea to publish a collection of pictures or compressed sound files
38using a GNUnet directory instead of processing them with archivers such as 37using a GNUnet directory instead of processing them with archivers such as
39tar or zip first). Directories can contain arbitrary meta data for each file. 38tar or zip first). Directories can contain arbitrary meta data for each file.
40 39.PP
41If a directory has missing blocks (for example, some blocks failed to download), 40If a directory has missing blocks (for example, some blocks failed to download),
42GNUnet is typically able to retrieve information about other files in the 41GNUnet is typically able to retrieve information about other files in the
43directory. Files in a GNUnet directory have no particular order; the GNUnet 42directory. 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
45fit the information about files into blocks of 32k. Respecting 32k boundaries 44fit the information about files into blocks of 32k. Respecting 32k boundaries
46where possible makes it easier for gnunet\-directory (and other tools) to 45where possible makes it easier for gnunet\-directory (and other tools) to
47recover information from partially downloaded directory files. 46recover information from partially downloaded directory files.
48 47.PP
49At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP 48At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP
50and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be 49and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be
51published in a namespace. 50published in a namespace.
52 51.PP
53GNUnet directories use the (unregistered) 52GNUnet directories use the (unregistered)
54mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal 53mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal
55search results. The directory file can be downloaded to disk 54search 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)
65The full documentation for 64The full documentation for
66.B gnunet 65.B gnunet
67is maintained as a Texinfo manual. If the 66is maintained as a Texinfo manual.
67If the
68.B info 68.B info
69and 69and
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
3gnunet\-download \- a command line interface for downloading files from GNUnet 3gnunet\-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
9Download files from GNUnet. 8Download 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
13set desired level of receiver anonymity. Default is 1. 11set 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
17use config file (defaults: ~/.config/gnunet.conf) 14use 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
21causes gnunet\-download to delete incomplete downloads when aborted with 17causes 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,
24terminating gnunet\-download with a signal will cause incomplete 20terminating gnunet\-download with a signal will cause incomplete
25downloads to stay on disk. If gnunet\-download runs to (normal) completion 21downloads to stay on disk. If gnunet\-download runs to (normal) completion
26finishing the download, this option has no effect. 22finishing 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
30print help page 25print 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
34Change the loglevel. Possible values for LOGLEVEL are 28Change the loglevel. Possible values for LOGLEVEL are
35ERROR, WARNING, INFO and DEBUG. 29ERROR, 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
39Only search locally, do not forward requests to other peers. 32Only 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
43write the file to FILENAME. Hint: when recursively downloading a directory, 35write 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.
45If no FILENAME is specified, gnunet\-download constructs a temporary ID from 37If no FILENAME is specified, gnunet\-download constructs a temporary ID from
46the URI of the file. The final filename is constructed based on meta\-data 38the URI of the file. The final filename is constructed based on meta\-data
47extracted using libextractor (if available). 39extracted 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
51set the maximum number of parallel downloads that is allowed. More parallel 42set 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
56be used to limit the number of blocks that are concurrently requested). 47be used to limit the number of blocks that are concurrently requested).
57As a result, the value only matters for recursive downloads. 48As a result, the value only matters for recursive downloads.
58The default value is 32. 49The 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
62set the maximum number of parallel requests that is allowed. If multiple 52set 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
71bandwidth are not fully utilized and if the parallelism limit (\-p option) 61bandwidth are not fully utilized and if the parallelism limit (\-p option)
72is not reached. This option also only matters for recursive downloads. 62is not reached. This option also only matters for recursive downloads.
73The default value is 4092. 63The default value is 4092.
74
75.TP 64.TP
76\fB\-R\fR, \fB\-\-recursive\fR 65\fB\-R\fR, \fB\-\-recursive\fR
77download directories recursively (and in parallel). Note that the URI 66download directories recursively (and in parallel). Note that the URI
@@ -83,15 +72,12 @@ information will be stored in "DIRNAME/.gnd". However, it is also
83possible to specify "DIRNAME.gnd", in which case the files from the 72possible to specify "DIRNAME.gnd", in which case the files from the
84directory will end up in "DIRNAME/", while GNUnet's directory meta 73directory will end up in "DIRNAME/", while GNUnet's directory meta
85data will be in "DIRNAME.gnd". 74data will be in "DIRNAME.gnd".
86
87.TP 75.TP
88\fB\-v\fR, \fB\-\-version\fR 76\fB\-v\fR, \fB\-\-version\fR
89print the version number 77print the version number
90
91.TP 78.TP
92\fB\-V\fR, \fB\-\-verbose\fR 79\fB\-V\fR, \fB\-\-verbose\fR
93print progress information 80print progress information
94
95.SH NOTES 81.SH NOTES
96The GNUNET_URI is typically obtained from 82The GNUNET_URI is typically obtained from
97gnunet\-search. gnunet\-fs\-gtk can also be used instead of 83gnunet\-search. gnunet\-fs\-gtk can also be used instead of
@@ -102,9 +88,7 @@ already present. GNUnet's file\-encoding will ensure file integrity,
102even if the existing file was not downloaded from GNUnet in the first 88even if the existing file was not downloaded from GNUnet in the first
103place. Temporary information will be appended to the target file until 89place. Temporary information will be appended to the target file until
104the download is completed. 90the download is completed.
105
106.SH SETTING ANONYMITY LEVEL 91.SH SETTING ANONYMITY LEVEL
107
108The \fB\-a\fR option can be used to specify additional anonymity 92The \fB\-a\fR option can be used to specify additional anonymity
109constraints. If set to 0, GNUnet will try to download the file as fast 93constraints. If set to 0, GNUnet will try to download the file as fast
110as possible, including using non-anonymous methods. If you set it to 94as 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
121a higher anonymity level, which in this case will determine 105a higher anonymity level, which in this case will determine
122performance. Also, peers that cache content in the network always use 106performance. Also, peers that cache content in the network always use
123anonymity level 1. 107anonymity level 1.
124 108.PP
125This option can be used to limit requests further than that. In 109This option can be used to limit requests further than that. In
126particular, you can require GNUnet to receive certain amounts of 110particular, you can require GNUnet to receive certain amounts of
127traffic from other peers before sending your queries. This way, you 111traffic from other peers before sending your queries. This way, you
128can gain very high levels of anonymity \- at the expense of much more 112can gain very high levels of anonymity \- at the expense of much more
129traffic and much higher latency. So set it only if you really believe 113traffic and much higher latency. So set it only if you really believe
130you need it. 114you need it.
131 115.PP
132The definition of ANONYMITY\-RECEIVE is the following. 0 means no 116The definition of ANONYMITY\-RECEIVE is the following. 0 means no
133anonymity is required. Otherwise a value of 'v' means that 1 out of v 117anonymity is required. Otherwise a value of 'v' means that 1 out of v
134bytes of "anonymous" traffic can be from the local user, leaving 'v-1' 118bytes 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
137originate n/(v-1) bytes of queries in the same time\-period. The 121originate n/(v-1) bytes of queries in the same time\-period. The
138time\-period is twice the average delay that GNUnet defers forwarded 122time\-period is twice the average delay that GNUnet defers forwarded
139queries. 123queries.
140 124.PP
141The default is 1 and this should be fine for most users. Also notice 125The default is 1 and this should be fine for most users. Also notice
142that if you choose very large values, you may end up having no 126that if you choose very large values, you may end up having no
143throughput at all, especially if many of your fellow GNUnet\-peers all 127throughput at all, especially if many of your fellow GNUnet\-peers all
144do the same. 128do 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
157The full documentation for 141The full documentation for
158.B gnunet 142.B gnunet
159is maintained as a Texinfo manual. If the 143is maintained as a Texinfo manual.
144If the
160.B info 145.B info
161and 146and
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
4gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy 3gnunet\-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
12Most users will want to run this SOCKS proxy. It can be used in 8Most users will want to run this SOCKS proxy. It can be used in
13combination with browsers that support the SOCKS 4a protocol. 9combination with browsers that support the SOCKS 4a protocol.
14 10.PP
15The proxy will perform SSL authentication of GNS names and rewrite GNS 11The proxy will perform SSL authentication of GNS names and rewrite GNS
16enabled HTML content. To assert the validity of GNS names a local root 12enabled HTML content. To assert the validity of GNS names a local root
17CA certificate has to be generated that is used by the proxy. Thus 13CA 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
19of this proxy or the \-\-authority switch is used to specify an 15of this proxy or the \-\-authority switch is used to specify an
20appropriate CA certificate that is already trusted by the browser. 16appropriate 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"
44Print GNUnet version number. 39Print GNUnet version number.
45
46
47.SH BUGS 40.SH BUGS
48Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 41Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
49electronic mail to <bug\-gnunet@gnu.org> 42electronic mail to <bug\-gnunet@gnu.org>
50.SH SEE ALSO 43.SH SEE ALSO
51gnunet\-gns(1) 44gnunet\-gns(1)
45.PP
52The full documentation for 46The full documentation for
53.B gnunet 47.B gnunet
54is maintained as a Texinfo manual. If the 48is maintained as a Texinfo manual.
49If the
55.B info 50.B info
56and 51and
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
4gnunet\-namestore-fcfsd \- HTTP server for GNU Name System First-Come-First-Served name registration 3gnunet\-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
12Most users will not want to run an FCFS\-zone and thus will not need 8Most users will not want to run an FCFS\-zone and thus will not need
13this program. 9this 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
16names to be mapped to their GNS zone. Names are made available on a 12names to be mapped to their GNS zone. Names are made available on a
17First Come First Served basis (hence fcfs). Registered names do not 13First Come First Served basis (hence fcfs). Registered names do not
18expire. The HTTP server is run on the port that is specified in the 14expire. The HTTP server is run on the port that is specified in the
19configuration file in section "[fcfsd]" under the name "HTTPPORT". 15configuration file in section "[fcfsd]" under the name "HTTPPORT".
20 16.PP
21It is possible to manage gnunet\-gns\-fcfsd using 17It is possible to manage gnunet\-gns\-fcfsd using
22gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i 18gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i
23fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your 19fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your
24configuration and the "-z ZONE" in as the "OPTION". 20configuration and the "-z ZONE" in as the "OPTION".
25 21.PP
26An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are 22An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are
27encouraged to register their zone with the gnunet.org FCFS authority. 23encouraged to register their zone with the gnunet.org FCFS authority.
28 24.PP
29If you want to run your own FCFS registrar, you need to first create a 25If you want to run your own FCFS registrar, you need to first create a
30pseudonym (using "gnunet\-identity \-C NAME"), and use it with the 26pseudonym (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
32gnunet\-arm). 28gnunet\-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"
50Specifies for which EGO should FCFSD manage the zone. 45Specifies for which EGO should FCFSD manage the zone.
51
52.SH BUGS 46.SH BUGS
53Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 47Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
54electronic mail to <bug\-gnunet@gnu.org> 48electronic mail to <bug\-gnunet@gnu.org>
55.SH SEE ALSO 49.SH SEE ALSO
56gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1) 50gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1)
51.PP
57The full documentation for 52The full documentation for
58.B gnunet 53.B gnunet
59is maintained as a Texinfo manual. If the 54is maintained as a Texinfo manual.
55If the
60.B info 56.B info
61and 57and
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
4gnunet\-nat\-auto \- autoconfigure and test NAT traversal 3gnunet\-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
13This tool allows testing various NAT traversal functions, as well 8This tool allows testing various NAT traversal functions, as well
14as attempting auto\-configuration. 9as attempting auto\-configuration.
15
16.SH OPTIONS 10.SH OPTIONS
17.B 11.B
18.IP "\-a, \-\-auto" 12.IP "\-a, \-\-auto"
19Attempt auto\-configuration for NAT traversal. 13Attempt auto\-configuration for NAT traversal.
20
21.B 14.B
22.IP "\-c FILENAME, \-\-config=FILENAME" 15.IP "\-c FILENAME, \-\-config=FILENAME"
23Use the configuration file FILENAME. 16Use the configuration file FILENAME.
24
25.B 17.B
26.IP "\-S NAME, \-\-section=NAME" 18.IP "\-S NAME, \-\-section=NAME"
27Name of the configuration section with details about the configuration 19Name of the configuration section with details about the configuration
28to test. For example "transport-tcp". 20to test. For example "transport-tcp".
29
30.IP "\-t, \-\-tcp" 21.IP "\-t, \-\-tcp"
31Use TCP. 22Use TCP.
32
33.B 23.B
34.IP "\-u, \-\-udp" 24.IP "\-u, \-\-udp"
35Use UDP. 25Use UDP.
36
37.B 26.B
38.IP "\-w, \-\-write" 27.IP "\-w, \-\-write"
39Write configuration to configuration file, useful in combination with 28Write configuration to configuration file, useful in combination with
40autoconfiguration (\-a). 29autoconfiguration (\-a).
41
42.SH EXAMPLES 30.SH EXAMPLES
43.PP 31.PP
44
45\fBAutomatic configuration:\fR 32\fBAutomatic configuration:\fR
46 33.TP
47Probe and write result to configuration: 34# gnunet\-nat\-auto \-aw
48 35Probe 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
54Test TCP configuration: 39# gnunet\-nat\-auto -t \-S transport-tcp
55 40Test TCP configuration
56 # gnunet\-nat\-auto -t \-S transport-tcp 41.TP
57 42# gnunet\-nat\-auto -t \-S transport-http
58Test HTTP configuration: 43Test HTTP configuration
59 44.TP
60 # gnunet\-nat\-auto -t \-S transport-http 45# gnunet\-nat\-auto -u \-S transport-udp
61 46Test UDP configuration
62Test UDP configuration:
63
64 # gnunet\-nat\-auto -u \-S transport-udp
65
66
67.SH BUGS 47.SH BUGS
68Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 48Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
69electronic mail to <gnunet\-developers@gnu.org> 49electronic mail to <gnunet\-developers@gnu.org>
70.SH SEE ALSO 50.SH SEE ALSO
71gnunet\-transport(1) gnunet\-nat(1) 51gnunet\-transport(1) gnunet\-nat(1)
52.PP
72The full documentation for 53The full documentation for
73.B gnunet 54.B gnunet
74is maintained as a Texinfo manual. If the 55is maintained as a Texinfo manual.
56If the
75.B info 57.B info
76and 58and
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
4gnunet\-nat\-server \- help GNUnet setup test network setup with NAT 3gnunet\-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
14Normal GNUnet end-users should not concern themselves with 9Normal GNUnet end-users should not concern themselves with
15gnunet\-nat\-server. In fact, distributions are encouraged to 10gnunet\-nat\-server. In fact, distributions are encouraged to
16consider not shipping it at all. Running gnunet\-nat\-server's is 11consider not shipping it at all. Running gnunet\-nat\-server's is
17similar to running hostlist servers: it is a special service to the 12similar to running hostlist servers: it is a special service to the
18community with special requirements and no benefit to those running 13community with special requirements and no benefit to those running
19the service. 14the service.
20 15.PP
21This program will listen on the specified PORT for incoming requests 16This program will listen on the specified PORT for incoming requests
22to test a peer's network connectivity. Incoming requests can ask it 17to test a peer's network connectivity. Incoming requests can ask it
23to connect to a given IPv4 address (and port) using TCP or UDP and to 18to 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
25can also be asked to send a "fake" ICMP response message to a given 20can also be asked to send a "fake" ICMP response message to a given
26IPv4 address (for autonomous NAT traversal \-\-\- see the description 21IPv4 address (for autonomous NAT traversal \-\-\- see the description
27in the respective research paper). 22in the respective research paper).
28 23.PP
29The idea is that gnunet\-nat\-server will be run on some trusted hosts 24The idea is that gnunet\-nat\-server will be run on some trusted hosts
30with unrestricted connectivity to allow GNUnet users to test their 25with unrestricted connectivity to allow GNUnet users to test their
31network configuration. As written, the code allows any user on the 26network configuration. As written, the code allows any user on the
32Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary 27Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary
33data to any TCP or UDP port at any address. We believe that this is 28data to any TCP or UDP port at any address. We believe that this is
34generally harmless. 29generally harmless.
35 30.PP
36When running gnunet\-nat\-server, make sure to use a configuration 31When running gnunet\-nat\-server, make sure to use a configuration
37that disables most NAT options but enables 'enable_nat_client' and 32that disables most NAT options but enables 'enable_nat_client' and
38sets 'internal_address' to the global IP address of your local host. 33sets 'internal_address' to the global IP address of your local host.
39Also, the gnunet\-helper\-nat\-client should be installed locally and 34Also, the gnunet\-helper\-nat\-client should be installed locally and
40run with root privileges (SUID), otherwise the gnunet\-nat\-server 35run with root privileges (SUID), otherwise the gnunet\-nat\-server
41will not work properly. 36will not work properly.
42 37.PP
43Note that gnunet\-nat\-server could be run via gnunet\-arm but 38Note that gnunet\-nat\-server could be run via gnunet\-arm but
44typically is not. Also, the name of the host and port that 39typically is not. Also, the name of the host and port that
45gnunet\-nat\-server is run on should be specified in the NATSERVER 40gnunet\-nat\-server is run on should be specified in the NATSERVER
46option in the [setup] section of the configuration file of hosts that 41option in the [setup] section of the configuration file of hosts that
47are supposed to autoconfigure with this server. 42are 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"
53Use the configuration file FILENAME. 46Use the configuration file FILENAME.
54
55.SH BUGS 47.SH BUGS
56Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 48Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
57electronic mail to <gnunet\-developers@gnu.org> 49electronic mail to <gnunet\-developers@gnu.org>
58.SH SEE ALSO 50.SH SEE ALSO
59gnunet\-transport(1) 51gnunet\-transport(1)
52.PP
60The full documentation for 53The full documentation for
61.B gnunet 54.B gnunet
62is maintained as a Texinfo manual. If the 55is maintained as a Texinfo manual.
56If the
63.B info 57.B info
64and 58and
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
4gnunet\-peerinfo \- Display information about other peers. 3gnunet\-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"
18Load config file (default: ~/.config/gnunet.conf) 13Load config file (default: ~/.config/gnunet.conf)
19.B 14.B
20.IP "\-g, \-\-get\-hello 15.IP "\-g, \-\-get\-hello"
21Output HELLO uri(s) 16Output 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"
36Disable resolution of IPs to hostnames 31Disable resolution of IPs to hostnames
37.B 32.B
38.IP "\-p, \-\-put\-hello=HELLO 33.IP "\-p, \-\-put\-hello=HELLO"
39Add given HELLO uri to the database 34Add 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"
50Print the version number 45Print the version number
51
52
53.SH BUGS 46.SH BUGS
54Report bugs by using mantis <https://gnunet.org/bugs/> or by sending 47Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
55electronic mail to <gnunet\-developers@gnu.org> 48electronic mail to <gnunet\-developers@gnu.org>
56.SH SEE ALSO 49.SH SEE ALSO
57gnunet.conf(5) 50gnunet.conf(5)
51.PP
58The full documentation for 52The full documentation for
59.B gnunet 53.B gnunet
60is maintained as a Texinfo manual. If the 54is maintained as a Texinfo manual.
55If the
61.B info 56.B info
62and 57and
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
4gnunet\-resolver \- build-in GNUnet stub resolver 3gnunet\-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"
33Print GNUnet version number. 28Print GNUnet version number.
34
35.SH BUGS 29.SH BUGS
36Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 30Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
37.SH "SEE ALSO" 31electronic mail to <gnunet\-developers@gnu.org>
32.SH SEE ALSO
38The full documentation for 33The full documentation for
39.B gnunet 34.B gnunet
40is maintained as a Texinfo manual. If the 35is maintained as a Texinfo manual.
36If the
41.B info 37.B info
42and 38and
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
4gnunet\-vectorproduct \- compute a vectorproduct 3gnunet\-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
13across two peers \fBAlice\fP and \fBBob\fP. 9across two peers \fBAlice\fP and \fBBob\fP.
14 10.PP
15A client can issue one of two messages to its service: 11A client can issue one of two messages to its service:
16.TS 12.TS
17tab (@); 13tab (@);
@@ -23,17 +19,16 @@ T}
23Elements to support a peer in computing a vectorproduct (\fBBob\fP) 19Elements to support a peer in computing a vectorproduct (\fBBob\fP)
24T} 20T}
25.TE 21.TE
26
27Both requests must share the same SID, which can be an arbitrary 22Both requests must share the same SID, which can be an arbitrary
28string identifying the session. SIDs should be unique, however it is 23string identifying the session. SIDs should be unique, however it is
29sufficient to guarantee the uniqueness of the tupel element count and 24sufficient to guarantee the uniqueness of the tupel element count and
30session ID. 25session 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
33service, it will internally be checked by the client for 28service, it will internally be checked by the client for
34validity. Invalid values here result in the client or the service 29validity. Invalid values here result in the client or the service
35failing the session. 30failing the session.
36 31.PP
37Elements are handed over as signed decimal integers, the element count 32Elements are handed over as signed decimal integers, the element count
38supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also 33supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also
39supply a mask for these values to her service, which allows partial 34supply 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
42other value means the element will not be masked. \fBAlice\fP\'s 37other value means the element will not be masked. \fBAlice\fP\'s
43client will also mask all 0-values to avoid information leakage to 38client will also mask all 0-values to avoid information leakage to
44\fBBob\fP. 39\fBBob\fP.
45 40.PP
46The protocol by definition relies on \fBAlice\fP and \fBBob\fP being 41The protocol by definition relies on \fBAlice\fP and \fBBob\fP being
47benign, thus \fBBob\fP can arbitrarily falsify his information. Both 42benign, thus \fBBob\fP can arbitrarily falsify his information. Both
48peers collaborate to achieve a correct result. 43peers 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"
80Print GNUnet version number. 74Print GNUnet version number.
81
82
83.SH BUGS 75.SH BUGS
84Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 76Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
85 77electronic mail to <gnunet\-developers@gnu.org>
86.SH SEE ALSO 78.SH SEE ALSO
87gnunet\-peerinfo(1) 79gnunet\-peerinfo(1)
80.PP
88The full documentation for 81The full documentation for
89.B gnunet 82.B gnunet
90is maintained as a Texinfo manual. If the 83is maintained as a Texinfo manual.
84If the
91.B info 85.B info
92and 86and
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
4gnunet\-scrypt \- Manipulate GNUnet proof of work files. 3gnunet\-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
13of work files. 9of 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"
42Print GNUnet version number. 37Print GNUnet version number.
43
44.SH BUGS 38.SH BUGS
45Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 39Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
46.SH "SEE ALSO" 40electronic mail to <gnunet\-developers@gnu.org>
41.SH SEE ALSO
47The full documentation for 42The full documentation for
48.B gnunet 43.B gnunet
49is maintained as a Texinfo manual. If the 44is maintained as a Texinfo manual.
45If the
50.B info 46.B info
51and 47and
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
4gnunet\-statistics \- Display statistics about your GNUnet system 3gnunet\-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
14various aspect of GNUnet's operation. This tool only works if the 10various aspect of GNUnet's operation. This tool only works if the
15"statistics" service is available. 11"statistics" service is available.
16gnunet\-statistics can be used to set a value by giving the options 12gnunet\-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"
52Print GNUnet version number. 47Print GNUnet version number.
53
54
55.SH BUGS 48.SH BUGS
56Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org> 49Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending
57 50electronic mail to <gnunet\-developers@gnu.org>
58.SH SEE ALSO 51.SH SEE ALSO
59gnunet\-service\-statistics(1) 52gnunet\-service\-statistics(1)
53.PP
60The full documentation for 54The full documentation for
61.B gnunet 55.B gnunet
62is maintained as a Texinfo manual. If the 56is maintained as a Texinfo manual.
57If the
63.B info 58.B info
64and 59and
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
4gnunet\-testing\-run\-service \- Command line tool to start a service for testing. 3gnunet\-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
13service for testing. It starts a peer, running only the service 9service for testing. It starts a peer, running only the service
14specified on the command line, outputs the path to the temporary 10specified on the command line, outputs the path to the temporary
15configuration file to stdout. 11configuration file to stdout.
16 12.PP
17The peer will run until this program is killed, or stdin is 13The peer will run until this program is killed, or stdin is
18closed. When reading the character 'r' from stdin, the running service 14closed. When reading the character 'r' from stdin, the running service
19is restarted with the same configuration. 15is restarted with the same configuration.
20 16.PP
21This executable is intended to be used by gnunet-java, in order to 17This executable is intended to be used by gnunet-java, in order to
22reliably start and stop services for test cases. 18reliably 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"
33Name of the service to run. 28Name of the service to run.
34
35.SH BUGS 29.SH BUGS
36Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 30Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
37.SH "SEE ALSO" 31electronic mail to <gnunet\-developers@gnu.org>
32.SH SEE ALSO
38The full documentation for 33The full documentation for
39.B gnunet 34.B gnunet
40is maintained as a Texinfo manual. If the 35is maintained as a Texinfo manual.
36If the
41.B info 37.B info
42and 38and
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
4gnunet\-timeout \- run process with timeout 3gnunet\-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
13timeout. Provided as the standard "timout" utility may not be 9timeout. Provided as the standard "timout" utility may not be
14available on all platforms. 10available on all platforms.
15
16.SH BUGS 11.SH BUGS
17Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 12Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
18 13electronic mail to <gnunet\-developers@gnu.org>
19.SH SEE 14.SH SEE ALSO
20timeout(1) 15timeout(1)
16.PP
21The full documentation for 17The full documentation for
22.B gnunet 18.B gnunet
23is maintained as a Texinfo manual. If the 19is maintained as a Texinfo manual.
20If the
24.B info 21.B info
25and 22and
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
4gnunet\-transport\-certificate\-creation \- create certificate for HTTPS transport 3gnunet\-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
13private key and then a self-signed certificate for HTTPS transport. 9private key and then a self-signed certificate for HTTPS transport.
14
15.SH BUGS 10.SH BUGS
16Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 11Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
17 12electronic mail to <gnunet\-developers@gnu.org>
18.SH SEE ALSO 13.SH SEE ALSO
19gnunet\-transport(1) 14gnunet\-transport(1)
15.PP
20The full documentation for 16The full documentation for
21.B gnunet 17.B gnunet
22is maintained as a Texinfo manual. If the 18is maintained as a Texinfo manual.
19If the
23.B info 20.B info
24and 21and
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
4gnunet\-uri \- invoke default handler for GNUnet URIs 3gnunet\-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
13GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" 9GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS"
14and thus the specific tool to handle the URI depends on the subsystem. 10and thus the specific tool to handle the URI depends on the subsystem.
15gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM 11gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM
16in the configuration section "uri") and invoke it. 12in 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"
30Print GNUnet version number. 25Print GNUnet version number.
31
32
33.SH BUGS 26.SH BUGS
34Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 27Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
35.SH "SEE ALSO" 28electronic mail to <gnunet\-developers@gnu.org>
29.SH SEE ALSO
36The full documentation for 30The full documentation for
37.B gnunet 31.B gnunet
38is maintained as a Texinfo manual. If the 32is maintained as a Texinfo manual.
33If the
39.B info 34.B info
40and 35and
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
4gnunet\-zoneimport \- import DNS zone into GNS zone 3gnunet\-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
12stdin and issues DNS queries for each of the domain names given. It 8stdin 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
17records into GNS records (in particular converting NS records and glue 13records into GNS records (in particular converting NS records and glue
18records to GNS2DNS records) and add them to the namestore under the 14records to GNS2DNS records) and add them to the namestore under the
19label ("example" in the examples above). 15label ("example" in the examples above).
20 16.PP
21The arguments given to gnunet\-zoneimport is a list of IP addresses of 17The arguments given to gnunet\-zoneimport is a list of IP addresses of
22DNS servers to query. 18DNS servers to query.
23 19.PP
24gnunet\-zoneimport will usually never terminate: it will check when 20gnunet\-zoneimport will usually never terminate: it will check when
25DNS records expire, and re-issue requests when the old DNS records 21DNS records expire, and re-issue requests when the old DNS records
26have expired so that GNS always has the latest data. 22have expired so that GNS always has the latest data.
27 23.PP
28gnunet\-zoneimport will issue many DNS queries in parallel, but is 24gnunet\-zoneimport will issue many DNS queries in parallel, but is
29rate-limited in various ways, so most DNS servers should easily handle 25rate-limited in various ways, so most DNS servers should easily handle
30the load. gnunet\-zoneimport will perform a limited number of retries 26the load. gnunet\-zoneimport will perform a limited number of retries
31if queries fail. 27if queries fail.
32 28.PP
33gnunet\-zoneimport operates incrementally. It will check if the 29gnunet\-zoneimport operates incrementally. It will check if the
34namestore already has (non-expired) records stored for a given name in 30namestore already has (non-expired) records stored for a given name in
35the respective zone and not issue those requests again. Thus, it is 31the respective zone and not issue those requests again. Thus, it is
36fine to restart gnunet\-zoneimport whenever the list of domain names 32fine to restart gnunet\-zoneimport whenever the list of domain names
37changes. 33changes.
38 34.PP
39Finally, gnunet\-zoneimport keeps information for each domain name in 35Finally, gnunet\-zoneimport keeps information for each domain name in
40memory. This consumes about 200 bytes per domain name, or 1 GB for 5 36memory. This consumes about 200 bytes per domain name, or 1 GB for 5
41million labels. 37million 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
55given like "1 week" or "1 h". If DNS returns records with a shorter 50given like "1 week" or "1 h". If DNS returns records with a shorter
56lifetime, gnunet\-zoneimport will simply bump the lifetime to the 51lifetime, gnunet\-zoneimport will simply bump the lifetime to the
57specified value (relative to the time of the import). Default is zero. 52specified value (relative to the time of the import). Default is zero.
58
59.IP "\-s MAPSIZE, \-\-size=MAPSIZE" 53.IP "\-s MAPSIZE, \-\-size=MAPSIZE"
60Specifies the size (in number of entries) to use for the main hash 54Specifies the size (in number of entries) to use for the main hash
61map. The value provided should be at least twice the number of domain 55map. 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
64the automatic growth mechanism to work (that one is limited to at most 58the automatic growth mechanism to work (that one is limited to at most
6516 MB allocations for security reasons). Do not worry about this 5916 MB allocations for security reasons). Do not worry about this
66unless you are importing millions of domain names from a zone. 60unless you are importing millions of domain names from a zone.
67
68.SH NOTES 61.SH NOTES
69 62.TP
70Typical invocaton would be: 63Typical 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
78Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 66Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
79electronic mail to <gnunet\-developers@gnu.org> 67electronic mail to <gnunet\-developers@gnu.org>
80.SH SEE ALSO 68.SH SEE ALSO
81gnunet\-gns(1), gnunet\-namestore(1) 69gnunet\-gns(1), gnunet\-namestore(1)
70.PP
82The full documentation for 71The full documentation for
83.B gnunet 72.B gnunet
84is maintained as a Texinfo manual. If the 73is maintained as a Texinfo manual.
74If the
85.B info 75.B info
86and 76and
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
4gnunet.conf \- GNUnet configuration file 4gnunet.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
10A GNUnet setup typically consists of a set of service processes run by a user 8A 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.
12The default location for the configuration file for the services is 10The 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
17configuration. The parts of GNUnet that are run as a normal user may have 15configuration. The parts of GNUnet that are run as a normal user may have
18config options too and they read from "$HOME/.config/gnunet.conf". 16config options too and they read from "$HOME/.config/gnunet.conf".
19The latter config file can skip any options for the services. 17The latter config file can skip any options for the services.
20 18.PP
21.TP
22The basic structure of the configuration file is the following. The file is 19The basic structure of the configuration file is the following. The file is
23split into sections. Every section begins with "[SECTIONNAME]" and contains 20split into sections. Every section begins with "[SECTIONNAME]" and contains
24a number of options of the form "OPTION=VALUE". 21a 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
31work out of the box with those. See the examples section below for 28work out of the box with those. See the examples section below for
32some common setups on top of that. 29some common setups on top of that.
33
34.SH General OPTIONS 30.SH General OPTIONS
35.PP
36Many options will be common between sections. They can be repeated under 31Many options will be common between sections. They can be repeated under
37each section with different values. The "[PATHS]" section is special. 32each section with different values. The "[PATHS]" section is special.
38Here, it is possible to specify values for variables like "GNUNET_HOME". 33Here, it is possible to specify values for variables like "GNUNET_HOME".
@@ -46,11 +41,8 @@ place of the absolute definition of "/tmp".
46So instead of "/tmp/foo" you would write "$GNUNET_TMP/foo". 41So 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
52The following options are generic and shared by all services: 45The 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
125This example is a simple way to get started, using a server that has a known 110This example is a simple way to get started, using a server that has a known
126list of peers to get you started. Most users will be behind a firewall on 111list of peers to get you started. Most users will be behind a firewall on
127IPv4, as such NAT is enabled. Please rememeber to change your IP address 112IPv4, 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
150electronic mail to <bug-gnunet@gnu.org> 134electronic 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
153The full documentation for 138The full documentation for
154.B gnunet 139.B gnunet
155is maintained as a Texinfo manual. If the 140is maintained as a Texinfo manual.
141If the
156.B info 142.B info
157and 143and
158.B gnunet 144.B gnunet
@@ -168,4 +154,4 @@ will give you access to a tutorial for developers.
168.PP 154.PP
169Depending on your installation, this information is also 155Depending on your installation, this information is also
170available in 156available 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).