[GNUnet-SVN] r30048 - gnunet/doc/man

[gnunet]

Author: grothoff
Date: 2013-10-09 12:56:24 +0200 (Wed, 09 Oct 2013)
New Revision: 30048

Modified:
   gnunet/doc/man/gnunet-auto-share.1
   gnunet/doc/man/gnunet-download.1
   gnunet/doc/man/gnunet-peerinfo.1
   gnunet/doc/man/gnunet-publish.1
   gnunet/doc/man/gnunet-search.1
   gnunet/doc/man/gnunet-unindex.1
   gnunet/doc/man/gnunet.conf.5
Log:
-xdg changes: docu

Modified: gnunet/doc/man/gnunet-auto-share.1
===================================================================
--- gnunet/doc/man/gnunet-auto-share.1  2013-10-09 10:56:18 UTC (rev 30047)
+++ gnunet/doc/man/gnunet-auto-share.1  2013-10-09 10:56:24 UTC (rev 30048)
@@ -12,7 +12,7 @@
 .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 @@
 
 .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 
<address@hidden>

Modified: gnunet/doc/man/gnunet-download.1
===================================================================
--- gnunet/doc/man/gnunet-download.1    2013-10-09 10:56:18 UTC (rev 30047)
+++ gnunet/doc/man/gnunet-download.1    2013-10-09 10:56:24 UTC (rev 30048)
@@ -14,7 +14,7 @@
 
 .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 @@
 
 .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 
<address@hidden>

Modified: gnunet/doc/man/gnunet-peerinfo.1
===================================================================
--- gnunet/doc/man/gnunet-peerinfo.1    2013-10-09 10:56:18 UTC (rev 30047)
+++ gnunet/doc/man/gnunet-peerinfo.1    2013-10-09 10:56:24 UTC (rev 30048)
@@ -15,7 +15,7 @@
 .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)

Modified: gnunet/doc/man/gnunet-publish.1
===================================================================
--- gnunet/doc/man/gnunet-publish.1     2013-10-09 10:56:18 UTC (rev 30047)
+++ gnunet/doc/man/gnunet-publish.1     2013-10-09 10:56:24 UTC (rev 30048)
@@ -25,7 +25,7 @@
 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 @@
 
 .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 
<address@hidden>

Modified: gnunet/doc/man/gnunet-search.1
===================================================================
--- gnunet/doc/man/gnunet-search.1      2013-10-09 10:56:18 UTC (rev 30047)
+++ gnunet/doc/man/gnunet-search.1      2013-10-09 10:56:24 UTC (rev 30048)
@@ -23,7 +23,7 @@
 
 .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 @@
 
 .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 
<address@hidden>

Modified: gnunet/doc/man/gnunet-unindex.1
===================================================================
--- gnunet/doc/man/gnunet-unindex.1     2013-10-09 10:56:18 UTC (rev 30047)
+++ gnunet/doc/man/gnunet-unindex.1     2013-10-09 10:56:24 UTC (rev 30048)
@@ -9,7 +9,7 @@
 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 @@
 .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 
<address@hidden>

Modified: gnunet/doc/man/gnunet.conf.5
===================================================================
--- gnunet/doc/man/gnunet.conf.5        2013-10-09 10:56:18 UTC (rev 30047)
+++ gnunet/doc/man/gnunet.conf.5        2013-10-09 10:56:24 UTC (rev 30048)
@@ -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 @@
 
 .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 @@
 
 .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 <address@hidden>