-doxygen

[oweals/gnunet.git] / src / util / util.conf

diff --git a/src/util/util.conf b/src/util/util.conf
index d97bc17cd5253ffba46fab6e4d9c578e720fa28c..3df538f5df0deb2fb1961d68f80481eec468e33d 100644 (file)
--- a/src/util/util.conf
+++ b/src/util/util.conf
@@ -1,16 +1,50 @@
 [PATHS]
-SERVICEHOME = ~/.gnunet/
-# SERVICEHOME = /var/lib/gnunet/
+# The PATHS section is special, as filenames including $-expression are
+# expanded using the values from PATHS or the system environment (PATHS
+# is checked first).  GNUnet also supports expanding $-expressions using
+# defaults with the syntax "${VAR:-default}".  Here, "default" can again
+# be a $-expression.
+#
+# We usually want $HOME for $GNUNET_HOME, but we allow testcases to
+# easily override this by setting $GNUNET_TEST_HOME.
+#
+GNUNET_HOME = ${GNUNET_TEST_HOME:-${HOME:-${USERPROFILE}}}
+
+# see XDG Base Directory Specification at
+# http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
+# for how these should be used.
+
+# Persistant data storage
+GNUNET_DATA_HOME = ${XDG_DATA_HOME:-$GNUNET_HOME/.local/share}/gnunet/
+
+# Configuration files
+GNUNET_CONFIG_HOME = ${XDG_CONFIG_HOME:-$GNUNET_HOME/.config}/gnunet/
+
+# Cached data, no big deal if lost
+GNUNET_CACHE_HOME = ${XDG_CACHE_HOME:-$GNUNET_HOME/.cache}/gnunet/
+
+# Runtime data (i.e UNIX domain sockets, locks, always lost on system boot)
+# This is the variable for system-wide services; use GNUNET_USER_RUNTIME_DIR
+# for per-user services (where USER_SERVICE=YES is set)
+GNUNET_RUNTIME_DIR = ${XDG_RUNTIME_DIR:-${TMPDIR:-${TMP:-/tmp}}}/gnunet-system-runtime/
+
+# Runtime data for per-user services
+GNUNET_USER_RUNTIME_DIR = ${XDG_RUNTIME_DIR:-${TMPDIR:-${TMP:-/tmp}}}/gnunet-${USERHOME:-${USER:-user}}-runtime/
+
+
+# Legacy option...
+# GNUNET_TEST_HOME = ~/.gnunet/
+# GNUNET_TEST_HOME = /var/lib/gnunet/
+
 # DEFAULTCONFIG = /etc/gnunet.conf
 # If 'DEFAULTCONFIG' is not defined, the current
 # configuration file is assumed to be the default,
 # which is what we want by default...
 
+
 [PEER]
-PRIVATE_KEY = $SERVICEHOME/private.ecc
+PRIVATE_KEY = $GNUNET_DATA_HOME/private_key.ecc
 
-[client]
-HOME = $SERVICEHOME
 
 [TESTING]
 SPEEDUP_INTERVAL = 0 ms