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