aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-core.140
-rw-r--r--doc/man/gnunet-dns2gns.139
-rw-r--r--doc/man/gnunet-qr.131
-rw-r--r--doc/man/gnunet-scalarproduct.189
-rw-r--r--doc/man/gnunet-transport.190
-rw-r--r--doc/man/gnunet.conf.5.in294
6 files changed, 345 insertions, 238 deletions
diff --git a/doc/man/gnunet-core.1 b/doc/man/gnunet-core.1
index 5fae7b858..5b61ab953 100644
--- a/doc/man/gnunet-core.1
+++ b/doc/man/gnunet-core.1
@@ -26,39 +26,41 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-core 28.Nm gnunet-core
29.Nd 29.Nd monitor CORE subsystem
30monitor CORE subsystem
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
34.Op Fl h | \-help 33.Op Fl h | -help
35.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 34.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
36.Op Fl m | \-monitor 35.Op Fl m | -monitor
37.Op Fl v | \-version 36.Op Fl v | -version
38.Op Fl V | \-verbose 37.Op Fl V | -verbose
39.Sh DESCRIPTION 38.Sh DESCRIPTION
40.Nm 39.Nm
41is a tool to access various functions of GNUnet's core subsystem from the command-line. 40is a tool to access various functions of GNUnet's core subsystem
42The only function right now is to monitor the status of peers known to the CORE service. 41from the command-line.
43.Bl -tag -width Ds 42The only function right now is to monitor the status of peers
44.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 43known to the CORE service.
44.Bl -tag -width indent
45.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
45Configuration file to use. 46Configuration file to use.
46.It Fl h | \-help 47.It Fl h | -help
47Print the help page. 48Print the help page.
48.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 49.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
49Change the loglevel. 50Change the loglevel.
50Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 51Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
51.It Fl m | \-monitor 52.It Fl m | -monitor
52in monitor mode, gnunet-core will continuously print the connection status, instead of giving just a snapshot. 53In monitor mode, gnunet-core will continuously print the connection status,
53.It Fl v | \-version 54instead of giving just a snapshot.
55.It Fl v | -version
54Print the version number. 56Print the version number.
55.It Fl V | \-verbose 57.It Fl V | -verbose
56Be verbose. 58Be verbose.
57.El 59.El
58.\".Sh EXAMPLES 60.\".Sh EXAMPLES
59.Sh SEE ALSO 61.Sh SEE ALSO
60.Xr gnunet-transport 1 62.Xr gnunet-transport 1
61.sp 63.Pp
62The full documentation for gnunet is maintained as a Texinfo manual. 64The full documentation for gnunet is maintained as a Texinfo manual.
63If the 65If the
64.Xr info 1 66.Xr info 1
diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1
index cf7fd2319..5507a148d 100644
--- a/doc/man/gnunet-dns2gns.1
+++ b/doc/man/gnunet-dns2gns.1
@@ -26,38 +26,41 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-dns2gns 28.Nm gnunet-dns2gns
29.Nd 29.Nd run a DNS-to-GNS proxy
30run a DNS-to-GNS proxy
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
34.Op Fl d Ar IP | Fl \-dns= Ns Ar IP 33.Op Fl d Ar IP | Fl -dns= Ns Ar IP
35.Op Fl h | \-help 34.Op Fl h | -help
36.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 35.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
37.Op Fl v | \-version 36.Op Fl v | -version
38.Sh DESCRIPTION 37.Sh DESCRIPTION
39.Nm 38.Nm
40runs a DNS resolver which delegates requests GNS if the TLD matches one configured for GNS. 39runs a DNS resolver which delegates requests GNS if the TLD
40matches one configured for GNS.
41All other requests are forwarded to DNS. 41All other requests are forwarded to DNS.
42This DNS proxy is useful for enabling non-personalized GNS\-resolution to an entire network or to offer GNS\-resolution to DNS users. 42This DNS proxy is useful for enabling non-personalized GNS-resolution to an
43.Bl -tag -width Ds 43entire network or to offer GNS-resolution to DNS users.
44.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 44.Bl -tag -width indent
45Use the configuration file FILENAME. 45.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
46.It Fl d Ar IP | Fl \-dns= Ns Ar IP 46Use the configuration file
47IP address of a recursive DNS resolver that should be used for non-GADS hostnames. 47.Ar FILENAME .
48.It Fl h | \-help 48.It Fl d Ar IP | Fl -dns= Ns Ar IP
49IP address of a recursive DNS resolver that should be used
50for non-GADS hostnames.
51.It Fl h | -help
49Print short help on options. 52Print short help on options.
50.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 53.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
51Use LOGLEVEL for logging. 54Use LOGLEVEL for logging.
52Valid values are DEBUG, INFO, WARNING and ERROR. 55Valid values are DEBUG, INFO, WARNING and ERROR.
53.It Fl v | \-version 56.It Fl v | -version
54Print GNUnet version number. 57Print GNUnet version number.
55.El 58.El
56.Sh SEE ALSO 59.Sh SEE ALSO
57.Xr gnunet-gns-fcfs 1 , 60.Xr gnunet-gns-fcfs 1 ,
58.Xr gnunet-gns 1 , 61.Xr gnunet-gns 1 ,
59.Xr gnunet-identity 1 62.Xr gnunet-identity 1
60.sp 63.Pp
61The full documentation for gnunet is maintained as a Texinfo manual. 64The full documentation for gnunet is maintained as a Texinfo manual.
62If the 65If the
63.Xr info 1 66.Xr info 1
diff --git a/doc/man/gnunet-qr.1 b/doc/man/gnunet-qr.1
index d445df0f2..16ce7857d 100644
--- a/doc/man/gnunet-qr.1
+++ b/doc/man/gnunet-qr.1
@@ -26,28 +26,29 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-qr 28.Nm gnunet-qr
29.Nd 29.Nd scan a QR code using a video device and import
30scan a QR code using a video device and import
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
34.Op Fl d Ar DEVICE | Fl \-device= Ns Ar DEVICE 33.Op Fl d Ar DEVICE | Fl -device= Ns Ar DEVICE
35.Op Fl h | \-help 34.Op Fl h | -help
36.Op Fl s | \-silent 35.Op Fl s | -silent
37.Op Fl v | \-verbose 36.Op Fl v | -verbose
38.Sh DESCRIPTION 37.Sh DESCRIPTION
39.Nm 38.Nm
40is a command line tool to scan a QR code using a video device and import. 39is a command line tool to scan a QR code using a video device and import.
41.Bl -tag -width Ds 40.Bl -tag -width indent
42.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 41.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
43Use the configuration file FILENAME. 42Use the configuration file
44.It Fl d Ar DEVICE | Fl \-device= Ns Ar DEVICE 43.Ar FILENAME .
45Use device DEVICE. 44.It Fl d Ar DEVICE | Fl -device= Ns Ar DEVICE
46.It Fl h | \-help 45Use device
46.Ar DEVICE .
47.It Fl h | -help
47Print short help on options. 48Print short help on options.
48.It Fl s | \-silent 49.It Fl s | -silent
49Do not show preview windows. 50Do not show preview windows.
50.It Fl v | \-verbose 51.It Fl v | -verbose
51Be verbose. 52Be verbose.
52.El 53.El
53.Sh SEE ALSO 54.Sh SEE ALSO
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1
index a5c7413ad..88ebb93e7 100644
--- a/doc/man/gnunet-scalarproduct.1
+++ b/doc/man/gnunet-scalarproduct.1
@@ -26,86 +26,83 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-scalarproduct 28.Nm gnunet-scalarproduct
29.Nd 29.Nd compute a vectorproduct
30compute a vectorproduct
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl e Ar ELEMENTS | Fl \-elements= Ns Ar ELEMENTS 32.Op Fl e Ar ELEMENTS | Fl -elements= Ns Ar ELEMENTS
34.Op Fl m Ar MASK | Fl \-mask= Ns Ar MASK 33.Op Fl m Ar MASK | Fl -mask= Ns Ar MASK
35.Op Fl k Ar KEY | Fl \-key= Ns Ar KEY 34.Op Fl k Ar KEY | Fl -key= Ns Ar KEY
36.Op Fl c Ar FILENAME | \-config= Ns Ar FILENAME 35.Op Fl c Ar FILENAME | -config= Ns Ar FILENAME
37.Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID 36.Op Fl p Ar PEERID | Fl -peer= Ns Ar PEERID
38.Op Fl h | \-help 37.Op Fl h | -help
39.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 38.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
40.Op Fl v | \-version 39.Op Fl v | -version
41.Sh DESCRIPTION 40.Sh DESCRIPTION
42.Nm 41.Nm
43enables you to compute a vectorproduct across two peers \fBAlice\fP and \fBBob\fP. 42enables you to compute a vectorproduct across two peers
43.Sy Alice
44and
45.Sy Bob .
44.Pp 46.Pp
45A client can issue one of two messages to its service: 47A client can issue one of two messages to its service:
46.TS 48.Bl -enum -width 3n -offset indent
47tab (@); 49.It
48l lx. 50A request to compute a vectorproduct with another peer (Alice)
491@T{ 51.It
50A request to compute a vectorproduct with another peer (\fBAlice\fP) 52Elements to support a peer in computing a vectorproduct (Bob)
51T} 53.El
522@T{ 54.Pp
53Elements to support a peer in computing a vectorproduct (\fBBob\fP)
54T}
55.TE
56Both requests must share the same SID, which can be an arbitrary 55Both requests must share the same SID, which can be an arbitrary
57string identifying the session. SIDs should be unique, however it is 56string identifying the session. SIDs should be unique, however it is
58sufficient to guarantee the uniqueness of the tupel element count and 57sufficient to guarantee the uniqueness of the tupel element count and
59session ID. 58session ID.
60.Pp 59.Pp
61\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s 60Alice's client must supply the ASCII encoded peer ID of bob's
62service, it will internally be checked by the client for 61service, it will internally be checked by the client for
63validity. Invalid values here result in the client or the service 62validity. Invalid values here result in the client or the service
64failing the session. 63failing the session.
65.Pp 64.Pp
66Elements are handed over as signed decimal integers, the element count 65Elements are handed over as signed decimal integers, the element count
67supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also 66supplied by Alice and Bob must match. Alice can also
68supply a mask for these values to her service, which allows partial 67supply a mask for these values to her service, which allows partial
69vector products to be computed across the vector. Elements can be 68vector products to be computed across the vector. Elements can be
70masked by setting their the corresponding mask element to zero, any 69masked by setting their the corresponding mask element to zero, any
71other value means the element will not be masked. \fBAlice\fP\'s 70other value means the element will not be masked. Alice's
72client will also mask all 0-values to avoid information leakage to 71client will also mask all 0-values to avoid information leakage to
73\fBBob\fP. 72Bob.
74.Pp 73.Pp
75The protocol by definition relies on \fBAlice\fP and \fBBob\fP being 74The protocol by definition relies on Alice and Bob being
76benign, thus \fBBob\fP can arbitrarily falsify his information. Both 75benign, thus Bob can arbitrarily falsify his information. Both
77peers collaborate to achieve a correct result. 76peers collaborate to achieve a correct result.
78.Pp 77.Pp
79The options of 78The options are as follows:
80.Nm 79.Bl -tag -width indent
81are: 80.It Fl e Ar ELEMENTS | Fl -elements= Ns Ar ELEMENTS
82.Bl -tag -width Ds 81The element-vector the vectorproduct should be computed over in
83.It Fl e Ar ELEMENTS | Fl \-elements= Ns Ar ELEMENTS 82signed decimal form, eg: "42,1,-3,3,7".
84The element-vector the vectorproduct should be computed over in signed decimal form, eg: "42,1,-3,3,7".
85Zero value elements will be automatically masked. 83Zero value elements will be automatically masked.
86.It Fl m Ar MASK | Fl \-mask= Ns Ar MASK 84.It Fl m Ar MASK | Fl -mask= Ns Ar MASK
87Elements in the vector can be masked. 85Elements in the vector can be masked.
88There must be at least two elements left in the vector to compute a vectorproduct. 86There must be at least two elements left in the vector to
87compute a vectorproduct.
89Non-Zero values indicate an element is not maskes. 88Non-Zero values indicate an element is not maskes.
90.It Fl k Ar KEY | Fl \-key= Ns Ar KEY 89.It Fl k Ar KEY | Fl -key= Ns Ar KEY
91The session key, a shared string of arbitrary length from which the SID will be generated. 90The session key, a shared string of arbitrary length from which
92.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 91the SID will be generated.
92.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
93Use the configuration file FILENAME. 93Use the configuration file FILENAME.
94.It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID 94.It Fl p Ar PEERID | Fl -peer= Ns Ar PEERID
95The remote peer's ASCII-armored gnunet-peer ID as output by 95The remote peer's ASCII-armored gnunet-peer ID as output by
96.Xr gnunet-peerinfo 1 . 96.Xr gnunet-peerinfo 1 .
97If this option is not given, the peer will take the \fBBob\fP\'s role. 97If this option is not given, the peer will take the Bob's role.
98.It Fl h | \-help 98.It Fl h | -help
99Print short help on options. 99Print short help on options.
100.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 100.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
101Use LOGLEVEL for logging. 101Use LOGLEVEL for logging.
102Valid values are DEBUG, INFO, WARNING and ERROR. 102Valid values are DEBUG, INFO, WARNING and ERROR.
103.It Fl v | \-version 103.It Fl v | -version
104Print GNUnet version number. 104Print GNUnet version number.
105.El 105.El
106.Sh BUGS
107Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
108electronic mail to <gnunet\-developers@gnu.org>
109.Sh SEE ALSO 106.Sh SEE ALSO
110.Xr gnunet-peerinfo 1 107.Xr gnunet-peerinfo 1
111.sp 108.sp
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1
index 64cfce385..3c463d76e 100644
--- a/doc/man/gnunet-transport.1
+++ b/doc/man/gnunet-transport.1
@@ -26,66 +26,70 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-transport 28.Nm gnunet-transport
29.Nd 29.Nd measure and control the transport subsystem
30measure and control the transport subsystem
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl b | \-benchmark 32.Op Fl b | -benchmark
34.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 33.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl D | \-disconnect 34.Op Fl D | -disconnect
36.Op Fl e | \-events 35.Op Fl e | -events
37.Op Fl h | \-help 36.Op Fl h | -help
38.Op Fl i | \-information 37.Op Fl i | -information
39.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 38.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
40.Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE 39.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
41.Op Fl m | \-monitor 40.Op Fl m | -monitor
42.Op Fl p Ar PEER | Fl \-peer= Ns Ar PEER 41.Op Fl p Ar PEER | Fl -peer= Ns Ar PEER
43.Op Fl P | \-plugins 42.Op Fl P | -plugins
44.Op Fl s | \-send 43.Op Fl s | -send
45.Op Fl v | \-version 44.Op Fl v | -version
46.Op Fl V | \-verbose 45.Op Fl V | -verbose
47.Sh DESCRIPTION 46.Sh DESCRIPTION
48.Nm 47.Nm
49is a tool to access various functions of GNUnet's transport subsystem from the command-line. 48is a tool to access various functions of GNUnet's transport subsystem
49from the command-line.
50Most of these are not expected to be useful for end-users. 50Most of these are not expected to be useful for end-users.
51gnunet-transport can be used to evaluate the performance of the transports, force a peer to connect to another peer (if possible). 51gnunet-transport can be used to evaluate the performance of
52the transports, force a peer to connect to another peer (if possible).
52Other functions should be added in the near future. 53Other functions should be added in the near future.
53.Bl -tag -width Ds 54.Bl -tag -width indent
54.It Fl b | \-benchmark 55.It Fl b | -benchmark
55measure how fast we are receiving data (from all connections). 56Measure how fast we are receiving data (from all connections).
56On exit, the data rate will be reported. 57On exit, the data rate will be reported.
57Runs until aborted with CTRL-C. 58Runs until aborted with CTRL-C.
58.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 59.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
59configuration file to use 60configuration file to use
60.It Fl D | \-disconnect 61.It Fl D | -disconnect
61force disconnection from a peer (used in conjunction with \-p). 62Force disconnection from a peer (used in conjunction with
63.Fl p Ns ).
62Note that you can use the gnunet-ats command-line tool to suggest connects. 64Note that you can use the gnunet-ats command-line tool to suggest connects.
63.It Fl e | \-events 65.It Fl e | -events
64provide information about all connect and disconnect events (continuously) 66Provide information about all connect and disconnect events (continuously).
65.It Fl h | \-help 67.It Fl h | -help
66Print the help page. 68Print the help page.
67.It Fl i | \-information 69.It Fl i | -information
68print information about our current connections (once) 70Print information about our current connections (once).
69.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 71.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
70Change the loglevel. 72Change the loglevel.
71Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 73Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
72.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE 74.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
73Configure logging to write logs to LOGFILE. 75Configure logging to write logs to LOGFILE.
74.It Fl m | \-monitor 76.It Fl m | -monitor
75print information about our current connections (continuously) 77Print information about our current connections (continuously).
76.It Fl p Ar PEER | Fl \-peer= Ns Ar PEER 78.It Fl p Ar PEER | Fl -peer= Ns Ar PEER
77the peer identity to connect to or monitor 79The peer identity to connect to or monitor.
78.It Fl P | \-plugins 80.It Fl P | -plugins
79monitor session state of transport plugins 81Monitor session state of transport plugins.
80.It Fl s | \-send 82.It Fl s | -send
81Transmit (dummy) traffic as quickly as possible to the peer specified with the 83Transmit (dummy) traffic as quickly as possible to the peer specified with the
82.Fl p 84.Fl p
83option. 85option.
84The rate will still be limited by the quota(s) determined by the peers (ATS subsystem). 86The rate will still be limited by the quota(s) determined by
85Will run until CTRL-C is pressed or until the connection to the other peer is disrupted. 87the peers (ATS subsystem).
86.It Fl v | \-version 88Will run until CTRL-C is pressed or until the connection
87print the version number 89to the other peer is disrupted.
88.It Fl V | \-verbose 90.It Fl v | -version
91Print out the version number.
92.It Fl V | -verbose
89be verbose 93be verbose
90.El 94.El
91.Sh SEE ALSO 95.Sh SEE ALSO
diff --git a/doc/man/gnunet.conf.5.in b/doc/man/gnunet.conf.5.in
index 69f9c59da..4ec58fe52 100644
--- a/doc/man/gnunet.conf.5.in
+++ b/doc/man/gnunet.conf.5.in
@@ -7,18 +7,18 @@
7.\" any later version published by the Free Software Foundation; with no 7.\" any later version published by the Free Software Foundation; with no
8.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A 8.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
9.\" copy of the license is included in the file 9.\" copy of the license is included in the file
10.\" ``FDL-1.3''. 10.\" FDL-1.3.
11.\" 11.\"
12.\" A copy of the license is also available from the Free Software 12.\" A copy of the license is also available from the Free Software
13.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}. 13.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html.
14.\" 14.\"
15.\" Alternately, this document is also available under the General 15.\" Alternately, this document is also available under the General
16.\" Public License, version 3 or later, as published by the Free Software 16.\" Public License, version 3 or later, as published by the Free Software
17.\" Foundation. A copy of the license is included in the file 17.\" Foundation. A copy of the license is included in the file
18.\" ``GPL3''. 18.\" GPL3.
19.\" 19.\"
20.\" A copy of the license is also available from the Free Software 20.\" A copy of the license is also available from the Free Software
21.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. 21.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html.
22.\" 22.\"
23.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later 23.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
24.\" 24.\"
@@ -27,17 +27,19 @@
27.Os 27.Os
28.Sh NAME 28.Sh NAME
29.Nm gnunet.conf 29.Nm gnunet.conf
30.Nd 30.Nd GNUnet configuration file
31GNUnet configuration file
32.Sh DESCRIPTION 31.Sh DESCRIPTION
33A GNUnet setup typically consists of a set of service processes run by a user "gnunet" and a set of user-interface processes run by a standard account. 32A GNUnet setup typically consists of a set of service processes run by a
33user "gnunet" and a set of user-interface processes run by a standard account.
34The default location for the configuration file for the services is 34The default location for the configuration file for the services is
35.Pa ~gnunet/.config/gnunet.conf Ns . 35.Pa ~gnunet/.config/gnunet.conf Ns .
36However, as normal users also may need read-access to this configuration, you might want to instead put the service process configuration in 36However, as normal users also may need read-access to this configuration,
37you might want to instead put the service process configuration in
37.Pa @SYSCONFDIR@/gnunet.conf Ns . 38.Pa @SYSCONFDIR@/gnunet.conf Ns .
38.Xr gnunet-setup 1 , 39.Xr gnunet-setup 1 ,
39part of gnunet-gtk, can be used to edit this configuration. 40part of gnunet-gtk, can be used to edit this configuration.
40The parts of GNUnet that are run as a normal user may have config options too and they read from 41The parts of GNUnet that are run as a normal user may have config
42options too and they read from
41.Pa $HOME/.config/gnunet.conf Ns . 43.Pa $HOME/.config/gnunet.conf Ns .
42The latter config file can skip any options for the services. 44The latter config file can skip any options for the services.
43.Pp 45.Pp
@@ -46,36 +48,48 @@ The basic structure of the configuration file is the following.
46.It 48.It
47The file is split into sections. 49The file is split into sections.
48.It 50.It
49Every section begins with "[SECTIONNAME]". 51Every section begins with a token in square brakets.
52The current section ends when a new section starts or end of file is
53encountered.
54.It
50A section contains a number of options of the form "OPTION=VALUE". 55A section contains a number of options of the form "OPTION=VALUE".
51.It 56.It
57Whitespace surounding the "=" token is striped out, in other words
58"OPTION = VALUE" and "OPTION=VALUE" are treated equal.
59.It
52Empty lines and lines beginning with a "#" are treated as comments. 60Empty lines and lines beginning with a "#" are treated as comments.
53.It 61.It
54Almost all options are optional. 62Boolean values are given as "YES" and "NO".
55The tools resort to reasonable defaults if an option is not present.
56.El 63.El
57.Pp 64.Pp
65Almost all options are optional.
66The tools resort to reasonable defaults if an option is not present.
58Default values for all of the options can be found in the files in the 67Default values for all of the options can be found in the files in the
59.Pa $GNUNET_PREFIX/share/gnunet/config.d/ 68.Pa $GNUNET_PREFIX/share/gnunet/config.d/
60directory. 69directory.
61A typical setup will work out of the box with those. 70A typical setup will work out of the box with those.
62See the examples section below for some common setups on top of that. 71See the examples section below for some common setups on top of that.
63.Ss Variable naming conventions and data types 72.Ss Variable naming conventions and data types
64Boolean values for options are set via "YES" or "NO" values, without the double-quotes. 73Boolean values for options are set via "YES" or "NO" values, without the
65.sp 74double-quotes.
66Options which include "PATH" or "path" define a path on the file-system and can take additional variables in the path, such as 75.Pp
76Options which include "PATH" or "path" define a path on the file-system
77and can take additional variables in the path, such as
67.Ev $GNUNET_TMP . 78.Ev $GNUNET_TMP .
68.sp 79.Pp
69Section names as listed more in detail below, are small letters only enclosed by square brakets. 80Section names as listed more in detail below, are small letters only
81enclosed by square brakets.
70.Ss GENERAL OPTIONS 82.Ss GENERAL OPTIONS
71Many options will be common between sections. 83Many options will be common between sections.
72They can be repeated under each section with different values. 84They can be repeated under each section with different values.
73The "[PATHS]" section is special. 85The "[PATHS]" section is special.
74Here, it is possible to specify values for variables like "GNUNET_HOME". 86Here, it is possible to specify values for variables like "GNUNET_HOME".
75Then, in all filenames that begin with "$GNUNET_HOME" the "$GNUNET_HOME" will be replaced with the respective value at runtime. 87Then, in all filenames that begin with "$GNUNET_HOME" the "$GNUNET_HOME" will
88be replaced with the respective value at runtime.
76The main use of this is to redefine "$GNUNET_HOME", which by default points to 89The main use of this is to redefine "$GNUNET_HOME", which by default points to
77.Pa $HOME/.config/ Ns . 90.Pa $HOME/.config/ Ns .
78By setting this variable, you can change the location where GNUnet stores its internal data. 91By setting this variable, you can change the location where GNUnet stores
92its internal data.
79.Pa gnunet.conf 93.Pa gnunet.conf
80accepts the variable 94accepts the variable
81.Ev GNUNET_TMP 95.Ev GNUNET_TMP
@@ -105,32 +119,43 @@ The filename that implements the service.
105For example "gnunet-service-ats". 119For example "gnunet-service-ats".
106.It IMMEDIATE_START 120.It IMMEDIATE_START
107Start the service always when the peer starts. 121Start the service always when the peer starts.
108Set to YES for services that should always be launched, even if no other service explicitly needs them. 122Set to YES for services that should always be launched, even if no other
123service explicitly needs them.
109.It START_ON_DEMAND 124.It START_ON_DEMAND
110Set to YES to automatically start the service when it is requested by another service. 125Set to YES to automatically start the service when it is requested by another
126service.
111YES for most GNUnet services. 127YES for most GNUnet services.
112.It NOARMBIND 128.It NOARMBIND
113Set to YES to never have ARM bind to the respective socket. 129Set to YES to never have ARM bind to the respective socket.
114This option is mostly for debugging in situations where ARM cannot pass the pre-bound socket to the child due to interference from PREFIX-commands. 130This option is mostly for debugging in situations where ARM cannot pass the
131pre-bound socket to the child due to interference from PREFIX-commands.
115This option is only effective in combination with IMMEDIATE_START being YES. 132This option is only effective in combination with IMMEDIATE_START being YES.
116NO by default. 133NO by default.
117.It PREFIX 134.It PREFIX
118PREFIX the given command (with its arguments) to the actual BINARY to be executed. 135PREFIX the given command (with its arguments) to the actual BINARY
119Useful to run certain services under special supervisors (like strace or valgrind). 136to be executed.
137Useful to run certain services under special supervisors like strace,
138dtrace, or valgrind.
120Typically used in combination with IMMEDIATE_START and NOARMBIND. 139Typically used in combination with IMMEDIATE_START and NOARMBIND.
121Empty by default. 140Empty by default.
122.It ACCEPT_FROM 141.It ACCEPT_FROM
123A semi-column separated list of IPv4 addresses that are allowed to use the service; usually 127.0.0.1. 142A semi-column separated list of IPv4 addresses that are allowed to use
143the service; usually 127.0.0.1.
124.It ACCEPT_FROM6 144.It ACCEPT_FROM6
125A semi-column separated list of IPv6 addresses that are allowed to use the service; usually ::1. 145A semi-column separated list of IPv6 addresses that are allowed to use
146the service; usually ::1.
126.It UNIXPATH 147.It UNIXPATH
127Path to use for the UNIX domain socket for inter process communication with the service on POSIX systems. 148Path to use for the UNIX domain socket for inter process communication with
149the service on POSIX systems.
128.It UNIX_MATCH_UID 150.It UNIX_MATCH_UID
129If UNIX domain sockets are used, set this to YES if only users with the same UID are allowed to access the service. 151If UNIX domain sockets are used, set this to YES if only users with the
152same UID are allowed to access the service.
130.It UNIX_MATCH_GID 153.It UNIX_MATCH_GID
131If UNIX domain sockets are used, set this to YES if only users with the same GID are allowed to access the service. 154If UNIX domain sockets are used, set this to YES if only users with the
155same GID are allowed to access the service.
132.It RUN_PER_USER 156.It RUN_PER_USER
133End-users should never have to change the defaults GNUnet provides for this option. 157End-users should never have to change the defaults GNUnet provides for
158this option.
134.Bl -tag -width Ds 159.Bl -tag -width Ds
135.It YES 160.It YES
136Set to YES if this service should be run per-user. 161Set to YES if this service should be run per-user.
@@ -138,9 +163,10 @@ Set to YES if this service should be run per-user.
138Set to NO if this is a system service. 163Set to NO if this is a system service.
139.El 164.El
140.El 165.El
141In the following sections the absence of a default value is either expressed as "Default value:" followed by nothing, or the lack of this line. 166In the following sections the absence of a default value is either
167expressed as "Default value:" followed by nothing, or the lack of this line.
142.Ss ARM 168.Ss ARM
143.Bl -tag -width Ds 169.Bl -tag -width indent
144.It PORT 170.It PORT
145Default value: 2087 171Default value: 2087
146.It HOSTNAME 172.It HOSTNAME
@@ -153,7 +179,7 @@ Default value: 127.0.0.1;
153Default value: ::1; 179Default value: ::1;
154.It UNIXPATH 180.It UNIXPATH
155Special case, uses user runtime dir even for per-system service. 181Special case, uses user runtime dir even for per-system service.
156.sp 182.Pp
157Default value: $GNUNET_USER_RUNTIME_DIR/gnunet-service-arm.sock 183Default value: $GNUNET_USER_RUNTIME_DIR/gnunet-service-arm.sock
158.It UNIX_MATCH_UID 184.It UNIX_MATCH_UID
159Default value: YES 185Default value: YES
@@ -164,29 +190,47 @@ In the
164.Fl l 190.Fl l
165option, format characters from 191option, format characters from
166.Xr strftime 3 192.Xr strftime 3
167are allowed; In the GLOBAL_POSTFIX, "{}" stands for the name of the respective service. 193are allowed; In the GLOBAL_POSTFIX, "{}" stands for the name of the
168Thus the following example for this option would introduce per-service logging with a new log file each day. 194respective service.
195Thus the following example for this option would introduce per-service logging
196with a new log file each day.
169Note that only the last 3 log files are preserved. 197Note that only the last 3 log files are preserved.
170Example: -l $GNUNET_CACHE_HOME/{}-%Y-%m-%d.log 198Example:
171.sp 199.Pp
200.Bd literal
201-l $GNUNET_CACHE_HOME/{}-%Y-%m-%d.log
202.Ed
203.Pp
172Default value: 204Default value:
173.It GLOBAL_PREFIX 205.It GLOBAL_PREFIX
174Default value: 206Default value:
175.It START_SYSTEM_SERVICES 207.It START_SYSTEM_SERVICES
176If set to YES, ARM will only start services that are marked as system-level services (and we'll expect a second ARM to be run per-user to run user-level services). 208If set to YES, ARM will only start services that are marked as system-level
177Note that in this case you must have manually created a different configuration file with the user where at least this and the START_USER_SERVICES options differ. 209services (and we'll expect a second ARM to be run per-user to run
210user-level services).
211Note that in this case you must have manually created a different configuration
212file with the user where at least this and the START_USER_SERVICES
213options differ.
178.It START_USER_SERVICES 214.It START_USER_SERVICES
179If set to YES, ARM will only start services that are marked as per-user services (and we'll expect a system user to run ARM to provide system-level services). 215If set to YES, ARM will only start services that are marked as per-user
180Per-user services enable better personalization and priviledge separation and in particular ensures that personal data is stored under $HOME, which might be important in a multi-user system (or if $HOME is encrypted and /var/ is not). 216services (and we'll expect a system user to run ARM to provide system-level
181.sp 217services).
182Note that if you have different ARM services for SYSTEM and USER, and you are not on UNIX, you need to change the PORT option for the USER ARM instances to some free port (counting down from 2085 should provide free ports). 218Per-user services enable better personalization and priviledge separation and
219in particular ensures that personal data is stored under $HOME, which might be
220important in a multi-user system (or if $HOME is encrypted and
221.Pa /var/
222is not).
223.Pp
224Note that if you have different ARM services for SYSTEM and USER, and you are
225not on UNIX, you need to change the PORT option for the USER ARM instances to
226some free port (counting down from 2085 should provide free ports).
183.It RESOURCE_DIAGNOSTICS 227.It RESOURCE_DIAGNOSTICS
184File where we should log per-service resource consumption on exit. 228File where we should log per-service resource consumption on exit.
185.sp 229.Pp
186Default value: resource.log 230Default value: resource.log
187.It USERNAME 231.It USERNAME
188Name of the user that will be used to provide the service. 232Name of the user that will be used to provide the service.
189.sp 233.Pp
190Default value: 234Default value:
191.It MAXBUF 235.It MAXBUF
192Default value: 236Default value:
@@ -224,7 +268,7 @@ Default value: YES
224.It MODE 268.It MODE
225Designated assignment mode. 269Designated assignment mode.
226Possible values: PROPORTIONAL, MLP, RIL. 270Possible values: PROPORTIONAL, MLP, RIL.
227.sp 271.Pp
228Default value: proportional 272Default value: proportional
229.It UNSPECIFIED_QUOTA_IN 273.It UNSPECIFIED_QUOTA_IN
230quotes in KiB or MiB per seconds. 274quotes in KiB or MiB per seconds.
@@ -282,7 +326,7 @@ The bigger, the more respect is payed to preferences.
282.It PROP_STABILITY_FACTOR 326.It PROP_STABILITY_FACTOR
283Should we stick to existing connections are prefer to switch? 327Should we stick to existing connections are prefer to switch?
284[1.0...2.0], lower value prefers to switch, bigger value is more tolerant. 328[1.0...2.0], lower value prefers to switch, bigger value is more tolerant.
285.sp 329.Pp
286Default value: 1.25 330Default value: 1.25
287.It MLP_MAX_DURATION 331.It MLP_MAX_DURATION
288Maximum duration for a solution process (both LP and MILP). 332Maximum duration for a solution process (both LP and MILP).
@@ -290,17 +334,17 @@ Default value: 3 s
290.It MLP_MAX_ITERATIONS 334.It MLP_MAX_ITERATIONS
291Maximum numbero of iterations for a solution process (only LP). 335Maximum numbero of iterations for a solution process (only LP).
292Tolerated MIP Gap [0.0 .. 1.0]. 336Tolerated MIP Gap [0.0 .. 1.0].
293.sp 337.Pp
294Default value: 0.025 338Default value: 0.025
295.It MLP_MAX_MIP_GAP 339.It MLP_MAX_MIP_GAP
296Tolerated LP/MIP Gap [0.0 .. 1.0]. 340Tolerated LP/MIP Gap [0.0 .. 1.0].
297.sp 341.Pp
298Default value: 0.025 342Default value: 0.025
299.It MLP_MAX_LP_MIP_GAP 343.It MLP_MAX_LP_MIP_GAP
300Default value: 0.025 344Default value: 0.025
301.It MLP_MAX_ITERATIONS 345.It MLP_MAX_ITERATIONS
302Maximum number of iterations for a solution process. 346Maximum number of iterations for a solution process.
303.sp 347.Pp
304Default value: 1024 348Default value: 1024
305.It MLP_COEFFICIENT_D 349.It MLP_COEFFICIENT_D
306Default value: 1.0 350Default value: 1.0
@@ -314,23 +358,23 @@ Default value: 1024
314Default value: 4 358Default value: 4
315.It MLP_DUMP_PROBLEM_ALL 359.It MLP_DUMP_PROBLEM_ALL
316Dump all problems to disk. 360Dump all problems to disk.
317.sp 361.Pp
318Default value: YES 362Default value: YES
319.It MLP_DUMP_SOLUTION_ALL 363.It MLP_DUMP_SOLUTION_ALL
320Dump all solution to disk. 364Dump all solution to disk.
321.sp 365.Pp
322Default value: YES 366Default value: YES
323.It MLP_GLPK_VERBOSE 367.It MLP_GLPK_VERBOSE
324Print GLPK output. 368Print GLPK output.
325.sp 369.Pp
326Default value: YES 370Default value: YES
327.It MLP_DUMP_PROBLEM_ON_FAIL 371.It MLP_DUMP_PROBLEM_ON_FAIL
328Dump all problems to disk. 372Dump all problems to disk.
329.sp 373.Pp
330Default value: YES 374Default value: YES
331.It MLP_DUMP_SOLUTION_ON_FAIL 375.It MLP_DUMP_SOLUTION_ON_FAIL
332Dump all solution to disk. 376Dump all solution to disk.
333.sp 377.Pp
334Default value: YES 378Default value: YES
335.It RIL_STEP_TIME_MIN 379.It RIL_STEP_TIME_MIN
336Default value: 500 ms 380Default value: 500 ms
@@ -338,7 +382,7 @@ Default value: 500 ms
338Default value: 1000 ms 382Default value: 1000 ms
339.It RIL_ALGORITHM 383.It RIL_ALGORITHM
340Possible values: SARSA or Q-LEARNING. 384Possible values: SARSA or Q-LEARNING.
341.sp 385.Pp
342Default value: Q-LEARNING 386Default value: Q-LEARNING
343.It RIL_DISCOUNT_BETA 387.It RIL_DISCOUNT_BETA
344Default value: 0.7 388Default value: 0.7
@@ -378,51 +422,52 @@ Default value: NO
378.It UNIX_MATCH_GID 422.It UNIX_MATCH_GID
379Default value: YES 423Default value: YES
380.It REFRESH_CONNECTION_TIME 424.It REFRESH_CONNECTION_TIME
381How often do we send KEEPALIVE messages on connections to keep them from timing out? 425How often do we send KEEPALIVE messages on connections to keep them from
382.sp 426timing out?
427.Pp
383Default value: 5 min 428Default value: 5 min
384.It DROP_PERCENT 429.It DROP_PERCENT
385Percentage of packets CADET is artificially dropping. 430Percentage of packets CADET is artificially dropping.
386Used for testing only! 431Used for testing only!
387.It ID_ANNOUNCE_TIME 432.It ID_ANNOUNCE_TIME
388How frequently do we usually anounce our presence in the DHT? 433How frequently do we usually anounce our presence in the DHT?
389.sp 434.Pp
390Default value: 1 h 435Default value: 1 h
391.It CONNECT_TIMEOUT 436.It CONNECT_TIMEOUT
392Default value: 30 s 437Default value: 30 s
393.It DHT_REPLICATION_LEVEL 438.It DHT_REPLICATION_LEVEL
394What is the replication level we give to the DHT when announcing our existence? 439What is the replication level we give to the DHT when announcing our existence?
395Usually there is no need to change this. 440Usually there is no need to change this.
396.sp 441.Pp
397Default value: 3 442Default value: 3
398.It MAX_TUNNELS 443.It MAX_TUNNELS
399Not implemented 444Not implemented
400.sp 445.Pp
401Default value: 1000 446Default value: 1000
402.It MAX_CONNECTIONS 447.It MAX_CONNECTIONS
403Not implemented, replaced by MAX_ROUTES in NEW CADET! 448Not implemented, replaced by MAX_ROUTES in NEW CADET!
404.sp 449.Pp
405Default value: 1000 450Default value: 1000
406.It MAX_ROUTES 451.It MAX_ROUTES
407How many routes do we participate in at most? 452How many routes do we participate in at most?
408Should be smaller than MAX_MSGS_QUEUE. 453Should be smaller than MAX_MSGS_QUEUE.
409.sp 454.Pp
410Default value: 5000 455Default value: 5000
411.It MAX_MSGS_QUEUE 456.It MAX_MSGS_QUEUE
412Not implemented 457Not implemented
413.sp 458.Pp
414Default value: 10000 459Default value: 10000
415.It MAX_PEERS 460.It MAX_PEERS
416Not implemented 461Not implemented
417.sp 462.Pp
418Default value: 1000 463Default value: 1000
419.It RATCHET_TIME 464.It RATCHET_TIME
420How often do we advance the ratchet even if there is not any traffic? 465How often do we advance the ratchet even if there is not any traffic?
421.sp 466.Pp
422Default value: 1 h 467Default value: 1 h
423.It RATCHET_MESSAGES 468.It RATCHET_MESSAGES
424How often do we advance the ratched if there is traffic? 469How often do we advance the ratched if there is traffic?
425.sp 470.Pp
426Default value: 64 471Default value: 64
427.El 472.El
428.Ss COMMUNICATOR-UNIX 473.Ss COMMUNICATOR-UNIX
@@ -483,8 +528,9 @@ Default value: NO
483.It PREFIX 528.It PREFIX
484.It USE_EPHEMERAL_KEYS 529.It USE_EPHEMERAL_KEYS
485Default value: YES 530Default value: YES
486.sp 531.Pp
487This MUST be set to YES in production, only set to NO for testing for performance (testbed/cluster-scale use!). 532This MUST be set to YES in production, only set to NO for testing for
533performance (testbed/cluster-scale use!).
488.El 534.El
489.Ss DATACACHE-POSTGRES 535.Ss DATACACHE-POSTGRES
490.Bl -tag -width Ds 536.Bl -tag -width Ds
@@ -550,8 +596,57 @@ Default value: 3306
550Default value: 1024 596Default value: 1024
551.El 597.El
552.Ss DHT 598.Ss DHT
553.Bl -tag -width Ds 599.Bl -tag -width indent
600.It IMMEDIATE_START Ar boolean
601Default value: YES
602.It START_ON_DEMAND Ar boolean
603Default value: YES
604.It PORT Ar integer
605Default value: 2095
606.It HOSTNAME Ar string
607Default value: localhost
608.It BINARY Ar string
609Default value: gnunet-service-dht
610.It ACCEPT_FROM Ar string
611Default value: 127.0.0.1;
612.It ACCEPT_FROM6 Ar string
613Default value: ::1;
614.It BUCKET_SIZE Ar integer
615Default value: 4
616.It UNIXPATH Ar path
617Default value: $GNUNET_RUNTIME_DIR/gnunet-service-dht.sock
618.It UNIX_MATCH_UID Ar boolean
619Default value: NO
620.It UNIX_MATCH_GID Ar boolean
621Default value: YES
622.It DISABLE_SOCKET_FORWARDING Ar boolean
623Default value: NO
624.It USERNAME =
625.It MAXBUF =
626.It TIMEOUT =
627.It DISABLEV6 =
628.It BINDTO =
629.It REJECT_FROM =
630.It REJECT_FROM6 =
631.It PREFIX =
632.It
633# Should the DHT cache results that we are routing in the DATACACHE as well?
634CACHE_RESULTS = YES
635.It
636# Special option to disable DHT calling 'try_connect' (for testing)
637DISABLE_TRY_CONNECT = NO
554.El 638.El
639.Ss DHTCACHE
640.Bl -tag -width indent
641.It DATABASE
642Default value: heap
643.It QUOTA
644Default value: 50 MB
645.It DISABLE_BF_RC Ar boolean
646Disable RC-file for Bloom filter?
647(for benchmarking with limited IO availability)
648.Pp
649Default value: NO
555.Ss EXIT 650.Ss EXIT
556.Bl -tag -width Ds 651.Bl -tag -width Ds
557.El 652.El
@@ -694,29 +789,30 @@ Default value: $GNUNET_USER_RUNTIME_DIR/gnunet-service-zonemaster.sock
694.It PORT 789.It PORT
695Default value: 2123 790Default value: 2123
696.It UNIX_MATCH_UID 791.It UNIX_MATCH_UID
697Do we require users that want to access GNS to run this process (usually not a good idea)? 792Do we require users that want to access GNS to run this process (usually
698.sp 793not a good idea)?
794.Pp
699Default value: NO 795Default value: NO
700.It UNIX_MATCH_GID 796.It UNIX_MATCH_GID
701Do we require users that want to access GNS to be in the 'gnunet' group? 797Do we require users that want to access GNS to be in the 'gnunet' group?
702.sp 798.Pp
703Default value: NO 799Default value: NO
704.It MAX_PARALLEL_BACKGROUND_QUERIES 800.It MAX_PARALLEL_BACKGROUND_QUERIES
705How many queries is GNS allowed to perform in the background at the same time? 801How many queries is GNS allowed to perform in the background at the same time?
706.sp 802.Pp
707Default value: 1000 803Default value: 1000
708.It ZONE_PUBLISH_TIME_WINDOW 804.It ZONE_PUBLISH_TIME_WINDOW
709How frequently do we try to publish our full zone? 805How frequently do we try to publish our full zone?
710.sp 806.Pp
711Default value: 4 h 807Default value: 4 h
712.It USE_CACHE 808.It USE_CACHE
713Using caching or always ask DHT? 809Using caching or always ask DHT?
714.sp 810.Pp
715Default value: YES 811Default value: YES
716.It PREFIX 812.It PREFIX
717.El 813.El
718.Ss ZONEMASTER-MONITOR 814.Ss ZONEMASTER-MONITOR
719.Bl -tag -width Ds 815.Bl -tag -width indent
720.It START_ON_DEMAND 816.It START_ON_DEMAND
721Default value: YES 817Default value: YES
722.It IMMEDIATE_START 818.It IMMEDIATE_START
@@ -730,35 +826,39 @@ Default value: $GNUNET_USER_RUNTIME_DIR/gnunet-service-zonemaster-monitor.sock
730.It PORT 826.It PORT
731Default value: 2124 827Default value: 2124
732.It UNIX_MATCH_UID 828.It UNIX_MATCH_UID
733Do we require users that want to access GNS to run this process (usually not a good idea)? 829Do we require users that want to access GNS to run this process (usually not
734.sp 830a good idea)?
831.Pp
735Default value: NO 832Default value: NO
736.It UNIX_MATCH_GID 833.It UNIX_MATCH_GID
737Do we require users that want to access GNS to be in the 'gnunet' group? 834Do we require users that want to access GNS to be in the 'gnunet' group?
738.sp 835.Pp
739Default value: NO 836Default value:
837.Li NO
740.El 838.El
741.Sh EXAMPLES 839.Sh EXAMPLES
742This example is a simple way to get started, using a server that has a known list of peers to get you started. 840This example is a simple way to get started, using a server that has a known
841list of peers to get you started.
743Most users will be behind a firewall on IPv4, as such NAT is enabled. 842Most users will be behind a firewall on IPv4, as such NAT is enabled.
744Please remember to change your IP address to the actual external address for your usage. 843Please remember to change your IP address to the actual external address
844for your usage.
745.Bd -literal -offset indent -compact 845.Bd -literal -offset indent -compact
746 [hostlist] 846[hostlist]
747 OPTIONS = \-b \-e 847OPTIONS = \-b \-e
748 848
749 [nat] 849[nat]
750 BEHIND_NAT = YES 850BEHIND_NAT = YES
751 ENABLE_UPNP = YES 851ENABLE_UPNP = YES
752 DISABLEV6 = YES 852DISABLEV6 = YES
753 EXTERNAL_ADDRESS = 157.166.249.10 853EXTERNAL_ADDRESS = 157.166.249.10
754 854
755 [arm] 855[arm]
756 START_SYSTEM_SERVICES = YES 856START_SYSTEM_SERVICES = YES
757 START_USER_SERVICES = NO 857START_USER_SERVICES = NO
758.Ed 858.Ed
759.Sh FILES 859.Sh FILES
760.Pa ~gnunet/.config/gnunet.conf 860.Pa ~gnunet/.config/gnunet.conf
761GNUnet syste-user configuration file 861GNUnet system-user configuration file
762.Pa $HOME/.config/gnunet.conf 862.Pa $HOME/.config/gnunet.conf
763User specific GNUnet configuration file 863User specific GNUnet configuration file
764.Pa @SYSCONFDIR@/gnunet.conf 864.Pa @SYSCONFDIR@/gnunet.conf
@@ -769,8 +869,8 @@ GNUnet configuration directory with all default option values
769.Xr env 1 , 869.Xr env 1 ,
770.Xr gnunet-arm 1 , 870.Xr gnunet-arm 1 ,
771.Xr gnunet-setup 1 , 871.Xr gnunet-setup 1 ,
772.Xr strftime 3 872.Xr strftime 3 .
773.sp 873.Pp
774The full documentation for gnunet is maintained as a Texinfo manual. 874The full documentation for gnunet is maintained as a Texinfo manual.
775If the 875If the
776.Xr info 1 876.Xr info 1
@@ -783,7 +883,7 @@ should give you access to the complete handbook,
783.Dl info gnunet-c-tutorial 883.Dl info gnunet-c-tutorial
784.Pp 884.Pp
785will give you access to a tutorial for developers. 885will give you access to a tutorial for developers.
786.sp 886.Pp
787Depending on your installation, this information is also available in 887Depending on your installation, this information is also available in
788.Xr gnunet 7 and 888.Xr gnunet 7 and
789.Xr gnunet-c-tutorial 7 . 889.Xr gnunet-c-tutorial 7 .