aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/man/gnunet-auto-share.14
-rw-r--r--doc/man/gnunet-download.14
-rw-r--r--doc/man/gnunet-peerinfo.12
-rw-r--r--doc/man/gnunet-publish.14
-rw-r--r--doc/man/gnunet-search.14
-rw-r--r--doc/man/gnunet-unindex.14
-rw-r--r--doc/man/gnunet.conf.510
7 files changed, 15 insertions, 17 deletions
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index 267c8e2e1..24adf905a 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -12,7 +12,7 @@ You can use automatic meta\-data extraction (based on libextractor).
12.PP 12.PP
13 13
14\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 14\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
15Use alternate config file (if this option is not specified, the default is ~/.gnunet/gnunet.conf). 15Use alternate config file (if this option is not specified, the default is ~/.config/gnunet.conf).
16 16
17.TP 17.TP
18\fB\-D\fR, \fB\-\-disable\-extractor\fR 18\fB\-D\fR, \fB\-\-disable\-extractor\fR
@@ -78,7 +78,7 @@ Share a directory "$HOME/gnunet\-share/":
78 78
79.SH FILES 79.SH FILES
80.TP 80.TP
81~/.gnunet/gnunet.conf 81~/.config/gnunet.conf
82GNUnet configuration file 82GNUnet configuration file
83.SH "REPORTING BUGS" 83.SH "REPORTING BUGS"
84Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 84Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index 95925c25d..f9cf9d1c9 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -14,7 +14,7 @@ set desired level of receiver anonymity. Default is 1.
14 14
15.TP 15.TP
16\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 16\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
17use config file (defaults: ~/.gnunet/gnunet.conf) 17use config file (defaults: ~/.config/gnunet.conf)
18 18
19.TP 19.TP
20\fB\-D, \fB\-\-delete\-incomplete\fR 20\fB\-D, \fB\-\-delete\-incomplete\fR
@@ -73,7 +73,7 @@ The default is 1 and this should be fine for most users. Also notice that if yo
73 73
74.SH FILES 74.SH FILES
75.TP 75.TP
76~/.gnunet/gnunet.conf 76~/.config/gnunet.conf
77GNUnet configuration file 77GNUnet configuration file
78.SH "REPORTING BUGS" 78.SH "REPORTING BUGS"
79Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 79Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1
index eb63d454b..6d89f461a 100644
--- a/doc/man/gnunet-peerinfo.1
+++ b/doc/man/gnunet-peerinfo.1
@@ -15,7 +15,7 @@ gnunet\-peerinfo \- Display information about other peers.
15.SH OPTIONS 15.SH OPTIONS
16.B 16.B
17.IP "\-c FILENAME, \-\-config=FILENAME" 17.IP "\-c FILENAME, \-\-config=FILENAME"
18Load config file (default: ~/.gnunet/gnunet.conf) 18Load config file (default: ~/.config/gnunet.conf)
19.B 19.B
20.IP "\-g, \-\-get\-hello 20.IP "\-g, \-\-get\-hello
21Output HELLO uri(s) 21Output HELLO uri(s)
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index ff37610ff..eee24c8d7 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -25,7 +25,7 @@ You can use automatic meta\-data extraction (based on libextractor) or the comma
25GNUnet supports two styles of publishing files on the network. Publishing a file means that a copy of the file is made in the local (!) database of the node. Indexing a file means that an index is added to the local (!) database with symbolic links to the file itself. The links will use the SHA-512 hash of the entire file as the filename. Indexing is generally significantly more efficient and the default choice. However, indexing only works if the indexed file can be read (using the same absolute path) by gnunet-service-fs. If this is not the case, indexing will fail (and gnunet\-publish will automatically revert to publishing instead). Regardless of which method is used to publish the file, the file will be slowly (depending on how often it is requested and on how much bandwidth is available) dispersed into the network. If you publish or index a file and then leave the network, it will almost always NOT be available anymore. 25GNUnet supports two styles of publishing files on the network. Publishing a file means that a copy of the file is made in the local (!) database of the node. Indexing a file means that an index is added to the local (!) database with symbolic links to the file itself. The links will use the SHA-512 hash of the entire file as the filename. Indexing is generally significantly more efficient and the default choice. However, indexing only works if the indexed file can be read (using the same absolute path) by gnunet-service-fs. If this is not the case, indexing will fail (and gnunet\-publish will automatically revert to publishing instead). Regardless of which method is used to publish the file, the file will be slowly (depending on how often it is requested and on how much bandwidth is available) dispersed into the network. If you publish or index a file and then leave the network, it will almost always NOT be available anymore.
26 26
27\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 27\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
28Use alternate config file (if this option is not specified, the default is ~/.gnunet/gnunet.conf). 28Use alternate config file (if this option is not specified, the default is ~/.config/gnunet.conf).
29 29
30.TP 30.TP
31\fB\-D\fR, \fB\-\-disable\-extractor\fR 31\fB\-D\fR, \fB\-\-disable\-extractor\fR
@@ -164,7 +164,7 @@ Update the previous entry, do not allow any future updates:
164 164
165.SH FILES 165.SH FILES
166.TP 166.TP
167~/.gnunet/gnunet.conf 167~/.config/gnunet.conf
168GNUnet configuration file 168GNUnet configuration file
169.SH "REPORTING BUGS" 169.SH "REPORTING BUGS"
170Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 170Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 137125967..7f30812e0 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -23,7 +23,7 @@ The default is 1 and this should be fine for most users. Also notice that if yo
23 23
24.TP 24.TP
25\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR 25\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR
26use config file (defaults: ~/.gnunet/gnunet.conf) 26use config file (defaults: ~/.config/gnunet.conf)
27 27
28.TP 28.TP
29\fB\-h\fR, \fB\-\-help\fR 29\fB\-h\fR, \fB\-\-help\fR
@@ -85,7 +85,7 @@ The first line contains the command to run to download the file. The suggested
85 85
86.SH FILES 86.SH FILES
87.TP 87.TP
88~/.gnunet/gnunet.conf 88~/.config/gnunet.conf
89GNUnet configuration file; specifies the default value for the timeout 89GNUnet configuration file; specifies the default value for the timeout
90.SH "REPORTING BUGS" 90.SH "REPORTING BUGS"
91Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 91Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
diff --git a/doc/man/gnunet-unindex.1 b/doc/man/gnunet-unindex.1
index 907c26f13..b3a1de6e3 100644
--- a/doc/man/gnunet-unindex.1
+++ b/doc/man/gnunet-unindex.1
@@ -9,7 +9,7 @@ gnunet\-unindex \- a command line interface for deleting indexed files from GNUn
9gnunet\-unindex is used for deleting indexed files from GNUnet. 9gnunet\-unindex is used for deleting indexed files from GNUnet.
10.TP 10.TP
11\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 11\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
12use config file (defaults: ~/.gnunet/gnunet.conf) 12use config file (defaults: ~/.config/gnunet.conf)
13.TP 13.TP
14\fB\-h\fR, \fB\-\-help\fR 14\fB\-h\fR, \fB\-\-help\fR
15print help page 15print help page
@@ -29,7 +29,7 @@ You can only unindex files that you indexed and that you still have available lo
29.TP 29.TP
30.SH FILES 30.SH FILES
31.TP 31.TP
32~/.gnunet/gnunet.conf 32~/.config/gnunet.conf
33GNUnet configuration file 33GNUnet configuration file
34.SH "REPORTING BUGS" 34.SH "REPORTING BUGS"
35Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 35Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
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
3gnunet.conf \- GNUnet configuration file 3gnunet.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
9A 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. 9A 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
12The 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. 12The 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
18Many 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. 18Many 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
21The following options are generic and shared by all services: 21The 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
92GNUnet configuration file 90GNUnet configuration file
93.SH "REPORTING BUGS" 91.SH "REPORTING BUGS"
94Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug-gnunet@gnu.org> 92Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug-gnunet@gnu.org>