summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-10-09 10:56:24 +0000
committerChristian Grothoff <christian@grothoff.org>2013-10-09 10:56:24 +0000
commitf25eb6591309f140fc4d8e3196114be8eccfde46 (patch)
treec6e6eb2848d4c38534c92ded7f15d1541822a918 /doc
parent3270d23ef28d309ca386d6d6706788b2f36fc010 (diff)
-xdg changes: docu
Diffstat (limited to 'doc')
-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).
.PP
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
-Use alternate config file (if this option is not specified, the default is ~/.gnunet/gnunet.conf).
+Use alternate config file (if this option is not specified, the default is ~/.config/gnunet.conf).
.TP
\fB\-D\fR, \fB\-\-disable\-extractor\fR
@@ -78,7 +78,7 @@ Share a directory "$HOME/gnunet\-share/":
.SH FILES
.TP
-~/.gnunet/gnunet.conf
+~/.config/gnunet.conf
GNUnet configuration file
.SH "REPORTING BUGS"
Report 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.
.TP
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
-use config file (defaults: ~/.gnunet/gnunet.conf)
+use config file (defaults: ~/.config/gnunet.conf)
.TP
\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
.SH FILES
.TP
-~/.gnunet/gnunet.conf
+~/.config/gnunet.conf
GNUnet configuration file
.SH "REPORTING BUGS"
Report 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.
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
-Load config file (default: ~/.gnunet/gnunet.conf)
+Load config file (default: ~/.config/gnunet.conf)
.B
.IP "\-g, \-\-get\-hello
Output 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
GNUnet 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.
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
-Use alternate config file (if this option is not specified, the default is ~/.gnunet/gnunet.conf).
+Use alternate config file (if this option is not specified, the default is ~/.config/gnunet.conf).
.TP
\fB\-D\fR, \fB\-\-disable\-extractor\fR
@@ -164,7 +164,7 @@ Update the previous entry, do not allow any future updates:
.SH FILES
.TP
-~/.gnunet/gnunet.conf
+~/.config/gnunet.conf
GNUnet configuration file
.SH "REPORTING BUGS"
Report 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
.TP
\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR
-use config file (defaults: ~/.gnunet/gnunet.conf)
+use config file (defaults: ~/.config/gnunet.conf)
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -85,7 +85,7 @@ The first line contains the command to run to download the file. The suggested
.SH FILES
.TP
-~/.gnunet/gnunet.conf
+~/.config/gnunet.conf
GNUnet configuration file; specifies the default value for the timeout
.SH "REPORTING BUGS"
Report 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
gnunet\-unindex is used for deleting indexed files from GNUnet.
.TP
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
-use config file (defaults: ~/.gnunet/gnunet.conf)
+use config file (defaults: ~/.config/gnunet.conf)
.TP
\fB\-h\fR, \fB\-\-help\fR
print help page
@@ -29,7 +29,7 @@ You can only unindex files that you indexed and that you still have available lo
.TP
.SH FILES
.TP
-~/.gnunet/gnunet.conf
+~/.config/gnunet.conf
GNUnet configuration file
.SH "REPORTING BUGS"
Report 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 @@
.SH NAME
gnunet.conf \- GNUnet configuration file
.SH SYNOPSIS
-~/.gnunet/gnunet.conf
+~/.config/gnunet.conf
.SH DESCRIPTION
.PP
-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.
+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.
.TP
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_
.SH General OPTIONS
.PP
-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.
+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.
.PP
The following options are generic and shared by all services:
.IP HOSTNAME
The hostname specifies the machine on which the service is running. This is usually "localhost".
-.IP HOME
- Which home directory should be used for the service. Usually "$SERVICEHOME".
.IP BINARY
The filename that implements the service. For example "gnunet-service-ats".
.IP AUTOSTART
@@ -88,7 +86,7 @@ This example is a simple way to get started, using a server that has a known lis
.SH FILES
.TP
-~/.gnunet/gnunet.conf
+~/.config/gnunet.conf
GNUnet configuration file
.SH "REPORTING BUGS"
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug-gnunet@gnu.org>