diff options
Diffstat (limited to 'doc/man/gnunet.conf.5')
-rw-r--r-- | doc/man/gnunet.conf.5 | 50 |
1 files changed, 28 insertions, 22 deletions
diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5 index 3dd8c7b62..3c88305ba 100644 --- a/doc/man/gnunet.conf.5 +++ b/doc/man/gnunet.conf.5 | |||
@@ -1,11 +1,10 @@ | |||
1 | .TH GNUNET.CONF "5" "05 May 2018" "GNUnet" | 1 | .\" -*- mode: nroff -*- |
2 | .TH GNUNET.CONF "5" "October 26, 2018" "GNUnet" | ||
2 | .SH NAME | 3 | .SH NAME |
3 | gnunet.conf \- GNUnet configuration file | 4 | gnunet.conf \- GNUnet configuration file |
4 | .SH SYNOPSIS | 5 | .SH SYNOPSIS |
5 | ~/.config/gnunet.conf | 6 | ~/.config/gnunet.conf |
6 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
7 | .PP | ||
8 | |||
9 | A GNUnet setup typically consists of a set of service processes run by a user | 8 | A GNUnet setup typically consists of a set of service processes run by a user |
10 | "gnunet" and a set of user-interface processes run by a standard account. | 9 | "gnunet" and a set of user-interface processes run by a standard account. |
11 | The default location for the configuration file for the services is | 10 | The default location for the configuration file for the services is |
@@ -16,8 +15,7 @@ gnunet\-setup (part of the GNUnet GTK package) can be used to edit this | |||
16 | configuration. The parts of GNUnet that are run as a normal user may have | 15 | configuration. The parts of GNUnet that are run as a normal user may have |
17 | config options too and they read from "$HOME/.config/gnunet.conf". | 16 | config options too and they read from "$HOME/.config/gnunet.conf". |
18 | The latter config file can skip any options for the services. | 17 | The latter config file can skip any options for the services. |
19 | 18 | .PP | |
20 | .TP | ||
21 | The basic structure of the configuration file is the following. The file is | 19 | The basic structure of the configuration file is the following. The file is |
22 | split into sections. Every section begins with "[SECTIONNAME]" and contains | 20 | split into sections. Every section begins with "[SECTIONNAME]" and contains |
23 | a number of options of the form "OPTION=VALUE". | 21 | a number of options of the form "OPTION=VALUE". |
@@ -29,9 +27,7 @@ Default values for all of the options can be found in the files in the | |||
29 | "$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will | 27 | "$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will |
30 | work out of the box with those. See the examples section below for | 28 | work out of the box with those. See the examples section below for |
31 | some common setups on top of that. | 29 | some common setups on top of that. |
32 | |||
33 | .SH General OPTIONS | 30 | .SH General OPTIONS |
34 | .PP | ||
35 | Many options will be common between sections. They can be repeated under | 31 | Many options will be common between sections. They can be repeated under |
36 | each section with different values. The "[PATHS]" section is special. | 32 | each section with different values. The "[PATHS]" section is special. |
37 | Here, it is possible to specify values for variables like "GNUNET_HOME". | 33 | Here, it is possible to specify values for variables like "GNUNET_HOME". |
@@ -45,11 +41,8 @@ place of the absolute definition of "/tmp". | |||
45 | So instead of "/tmp/foo" you would write "$GNUNET_TMP/foo". | 41 | So instead of "/tmp/foo" you would write "$GNUNET_TMP/foo". |
46 | The usage of "$GNUNET_TMP/foo", will result in "$TMPDIR/gnunet/foo", or | 42 | The usage of "$GNUNET_TMP/foo", will result in "$TMPDIR/gnunet/foo", or |
47 | "$TMP/gnunet/foo" and finally, if "TMPDIR" is undefined, "/tmp/gnunet/foo". | 43 | "$TMP/gnunet/foo" and finally, if "TMPDIR" is undefined, "/tmp/gnunet/foo". |
48 | |||
49 | .PP | 44 | .PP |
50 | |||
51 | The following options are generic and shared by all services: | 45 | The following options are generic and shared by all services: |
52 | |||
53 | .IP HOSTNAME | 46 | .IP HOSTNAME |
54 | The hostname specifies the machine on which the service is running. | 47 | The hostname specifies the machine on which the service is running. |
55 | This is usually "localhost". | 48 | This is usually "localhost". |
@@ -92,12 +85,7 @@ The following options are generic and shared by all services: | |||
92 | Set to YES if this service should be run per-user, NO if this is a system | 85 | Set to YES if this service should be run per-user, NO if this is a system |
93 | service. End-users should never have to change the defaults GNUnet provides | 86 | service. End-users should never have to change the defaults GNUnet provides |
94 | for this option. | 87 | for this option. |
95 | |||
96 | |||
97 | |||
98 | .B | ||
99 | .SH ATS Options | 88 | .SH ATS Options |
100 | |||
101 | .IP UNSPECIFIED_QUOTA_IN | 89 | .IP UNSPECIFIED_QUOTA_IN |
102 | quotes in KiB or MiB per seconds. Or use the word "unlimited" | 90 | quotes in KiB or MiB per seconds. Or use the word "unlimited" |
103 | .IP UNSPECIFIED_QUOTA_OUT | 91 | .IP UNSPECIFIED_QUOTA_OUT |
@@ -118,9 +106,7 @@ The following options are generic and shared by all services: | |||
118 | quotes in KiB or MiB per seconds. Or use the word "unlimited" | 106 | quotes in KiB or MiB per seconds. Or use the word "unlimited" |
119 | .IP WLAN_QUOTA_OUT | 107 | .IP WLAN_QUOTA_OUT |
120 | quotes in KiB or MiB per seconds. Or use the word "unlimited" | 108 | quotes in KiB or MiB per seconds. Or use the word "unlimited" |
121 | |||
122 | .SH EXAMPLES | 109 | .SH EXAMPLES |
123 | |||
124 | This example is a simple way to get started, using a server that has a known | 110 | This example is a simple way to get started, using a server that has a known |
125 | list of peers to get you started. Most users will be behind a firewall on | 111 | list of peers to get you started. Most users will be behind a firewall on |
126 | IPv4, as such NAT is enabled. Please rememeber to change your IP address | 112 | IPv4, as such NAT is enabled. Please rememeber to change your IP address |
@@ -139,13 +125,33 @@ to the actual external address for your usage. | |||
139 | [arm] | 125 | [arm] |
140 | START_SYSTEM_SERVICES = YES | 126 | START_SYSTEM_SERVICES = YES |
141 | START_USER_SERVICES = NO | 127 | START_USER_SERVICES = NO |
142 | |||
143 | .SH FILES | 128 | .SH FILES |
144 | .TP | 129 | .TP |
145 | ~/.config/gnunet.conf | 130 | ~/.config/gnunet.conf |
146 | GNUnet configuration file | 131 | GNUnet configuration file |
147 | .SH "REPORTING BUGS" | 132 | .SH BUGS |
148 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic | 133 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
149 | mail to <bug-gnunet@gnu.org> | 134 | electronic mail to <bug-gnunet@gnu.org> |
150 | .SH "SEE ALSO" | 135 | .SH SEE ALSO |
151 | \fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) | 136 | \fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) |
137 | .PP | ||
138 | The full documentation for | ||
139 | .B gnunet | ||
140 | is maintained as a Texinfo manual. | ||
141 | If the | ||
142 | .B info | ||
143 | and | ||
144 | .B gnunet | ||
145 | programs are properly installed at your site, the command | ||
146 | .IP | ||
147 | .B info gnunet | ||
148 | .PP | ||
149 | should give you access to the complete handbook, | ||
150 | .IP | ||
151 | .B info gnunet-c-tutorial | ||
152 | .PP | ||
153 | will give you access to a tutorial for developers. | ||
154 | .PP | ||
155 | Depending on your installation, this information is also | ||
156 | available in | ||
157 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | ||