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