diff options
Diffstat (limited to 'doc/man/gnunet.conf.5')
-rw-r--r-- | doc/man/gnunet.conf.5 | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5 index f2864c185..de2211f74 100644 --- a/doc/man/gnunet.conf.5 +++ b/doc/man/gnunet.conf.5 | |||
@@ -2,11 +2,11 @@ | |||
2 | .SH NAME | 2 | .SH NAME |
3 | gnunet.conf \- GNUnet configuration file | 3 | gnunet.conf \- GNUnet configuration file |
4 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
5 | ~/.gnunet/gnunet.conf | 5 | ~/.config/gnunet.conf |
6 | .SH DESCRIPTION | 6 | .SH DESCRIPTION |
7 | .PP | 7 | .PP |
8 | 8 | ||
9 | A GNUnet setup typically consists of a a set of service processes run by a user "gnunet" and a set of user-interface processes run by a standard account. The default location for the configuration file for the services is "~gnunet/.gnunet/gnunet.conf"; however, as normal users also may need read-access to this configuration, you might want to instead put the service process configuration in "/etc/gnunet.conf". gnunet\-setup (part of the GTK package) can be used to edit this configuration. The parts of GNUnet that is ran as a normal user may have config options too and they read from "$HOME/.gnunet/gnunet.conf". The latter config file can skip any options for the services. | 9 | A GNUnet setup typically consists of a a set of service processes run by a user "gnunet" and a set of user-interface processes run by a standard account. The default location for the configuration file for the services is "~gnunet/.config/gnunet.conf"; however, as normal users also may need read-access to this configuration, you might want to instead put the service process configuration in "/etc/gnunet.conf". gnunet\-setup (part of the GTK package) can be used to edit this configuration. The parts of GNUnet that is ran as a normal user may have config options too and they read from "$HOME/.config/gnunet.conf". The latter config file can skip any options for the services. |
10 | 10 | ||
11 | .TP | 11 | .TP |
12 | The basic structure of the configuration file is the following. The file is split into sections. Every section begins with "[SECTIONNAME]" and contains a number of options of the form "OPTION=VALUE". Empty lines and lines beginning with a "#" are treated as comments. Almost all options are optional and the tools resort to reasonable defaults if they are not present. | 12 | The basic structure of the configuration file is the following. The file is split into sections. Every section begins with "[SECTIONNAME]" and contains a number of options of the form "OPTION=VALUE". Empty lines and lines beginning with a "#" are treated as comments. Almost all options are optional and the tools resort to reasonable defaults if they are not present. |
@@ -15,15 +15,13 @@ Default values for all of the options can be found in the files in the "$GNUNET_ | |||
15 | 15 | ||
16 | .SH General OPTIONS | 16 | .SH General OPTIONS |
17 | .PP | 17 | .PP |
18 | Many options will be common between sections. They can be repeated under each section with different values. The "[PATHS]" section is special. Here, it is possible to specify values for variables like "SERVICEHOME". Then, in all filenames that begin with "$SERVICEHOME" the "$SERVICEHOME" will be replaced with the respective value at runtime. The main use of this is to redefine "$SERVICEHOME", which by default points to "$HOME/.gnunet/". By setting this variable, you can change the location where GNUnet stores its internal data. | 18 | Many options will be common between sections. They can be repeated under each section with different values. The "[PATHS]" section is special. Here, it is possible to specify values for variables like "GNUNET_HOME". Then, in all filenames that begin with "$GNUNET_HOME" the "$GNUNET_HOME" will be replaced with the respective value at runtime. The main use of this is to redefine "$GNUNET_HOME", which by default points to "$HOME/.config/". By setting this variable, you can change the location where GNUnet stores its internal data. |
19 | .PP | 19 | .PP |
20 | 20 | ||
21 | The following options are generic and shared by all services: | 21 | The following options are generic and shared by all services: |
22 | 22 | ||
23 | .IP HOSTNAME | 23 | .IP HOSTNAME |
24 | The hostname specifies the machine on which the service is running. This is usually "localhost". | 24 | The hostname specifies the machine on which the service is running. This is usually "localhost". |
25 | .IP HOME | ||
26 | Which home directory should be used for the service. Usually "$SERVICEHOME". | ||
27 | .IP BINARY | 25 | .IP BINARY |
28 | The filename that implements the service. For example "gnunet-service-ats". | 26 | The filename that implements the service. For example "gnunet-service-ats". |
29 | .IP AUTOSTART | 27 | .IP AUTOSTART |
@@ -88,7 +86,7 @@ This example is a simple way to get started, using a server that has a known lis | |||
88 | 86 | ||
89 | .SH FILES | 87 | .SH FILES |
90 | .TP | 88 | .TP |
91 | ~/.gnunet/gnunet.conf | 89 | ~/.config/gnunet.conf |
92 | GNUnet configuration file | 90 | GNUnet configuration file |
93 | .SH "REPORTING BUGS" | 91 | .SH "REPORTING BUGS" |
94 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug-gnunet@gnu.org> | 92 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug-gnunet@gnu.org> |