documenting USE_VALIDATION_AGENT in configuration
[monkeysphere.git] / etc / monkeysphere.conf
index aa3a6640bd129eb893fc0aa8c17a8aa77741e430..3a06e8a5515f743ba7bb9e63eb7e93e72a54a5b1 100644 (file)
@@ -1,28 +1,42 @@
-# MonkeySphere system-wide client configuration file.
+# Monkeysphere system-wide client configuration file.
 
 # This is an sh-style shell configuration file.  Variable names should
-# be separated from their assignements by a single '=' and no spaces.
+# be separated from their assignments by a single '=' and no spaces.
+# Environment variables with the same names as these variables but
+# prefaced by "MONKEYSPHERE_" will take precedence over the values
+# specified here.
 
-# GPG home directory
+# Log level.  Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in
+# increasing order of verbosity.
+#LOG_LEVEL=INFO
+
+# GPG home directory.  If not specified either here or in the
+# MONKEYSPHERE_GNUPGHOME environment variable, then the value of the
+# GNUPGHOME environment variable will be used.  If GNUPGHOME is not
+# set either, then the default value is listed below.
 #GNUPGHOME=~/.gnupg
 
-# GPG keyserver to search for keys
-#KEYSERVER=subkeys.pgp.net
+# GPG keyserver to search for keys.
+#KEYSERVER=pool.sks-keyservers.net
 
 # Set whether or not to check keyservers at every monkeysphere
 # interaction, including all ssh connections if you use the
-# monkeysphere-ssh-proxycommand.
+# monkeysphere ssh-proxycommand.
 # NOTE: setting CHECK_KEYSERVER to true will leak information about
 # the timing and frequency of your ssh connections to the maintainer
 # of the keyserver.
 #CHECK_KEYSERVER=true
 
-# ssh known_hosts file
+# The path to the SSH known_hosts file.
 #KNOWN_HOSTS=~/.ssh/known_hosts
 
 # Whether or not to hash the generated known_hosts lines.
-# Should be "true" or "false"
+# Should be "true" or "false".
 #HASH_KNOWN_HOSTS=true
 
-# ssh authorized_keys file (FIXME: why is this relevant in this file?)
+# The path to the SSH authorized_keys file.
 #AUTHORIZED_KEYS=~/.ssh/authorized_keys
+
+# Set to true to enable validation agent during X session startup
+# where available.
+#USE_VALIDATION_AGENT=false