Changes between Version 20 and Version 21 of MovedToGitHub/Building

Timestamp:

Nov 16, 2008, 12:52:23 AM (13 years ago)

Author:

Waldorf

Comment:

New chapter "Environment Variables" - part 1

MovedToGitHub/Building

@@ -73 +73 @@
 }}}
 
-=== Switches ===
+== Switches ==
 The transmission ./configure (or ./autogen.sh) script allows you to switch on/off certain parts. To use these, you'll either use --enable-* or --disable-*. eg. To disable the GTK client: --disable-gtk.
 
@@ -85 +85 @@
  * beos = enables beos client (unsupported)
 
+== Environment Variables ==
+Transmission listens to a few environment variables to know where to keep the configuration files and controlling debug output.
+
+=== Environment ===
+Default location for these variables can be found on the [ConfigFiles#Locations Configuration Files] page.
+
+==== Transmission Specific ====
+ * {{{TRANSMISSION_HOME}}} = if set, this will override the default configuration folder's location
+ * {{{TRANSMISSION_WEB_HOME}}} = if set, this will override the default Web UI folder's location
+ * {{{HOME}}} (optional) = if set, this will override where Transmission thinks your home directory is
+
+If {{{TRANSMISSION_HOME}}} isn't set, {{{HOME}}} is used to determine the location of the configuration folder's location. Also, it is used for the default download folder, unless specified otherwise in the preferences. ({{{$HOME/Downloads/}}}) 
+
+==== XDG Environment Variables ====
+The [http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html XDG Base Directory] Specification provides some common paths in user's home to store personal application configurations, or, using their own words "defines where these files should be looked for by defining one or more base directories relative to which files should be located". (Linux / GTK only)
+ * {{{XDG_CONFIG_HOME}}} = specifies where your per-user configuration files should be stored (default: {{{$HOME/.config/}}})
+ * {{{XDG_DATA_HOME}}} = specifies where your per-user data files should be stored (default: {{{$HOME/.local/share/}}})
+ * {{{XDG_DATA_DIRS}}} = specifies a preference-ordered list of directories to search for data files in addition to the {{{XDG_DATA_HOME}}} (separated by a {{{:}}})
+
+Normally, these should not be changed, as they are not Transmission specific. If you need to override the default configuration folder's location, use the {{{TRANSMISSION_HOME}}} instead. The {{{XDG_DATA_HOME}}} and {{{XDG_DATA_DIRS}}} are only used to search for the Web UI.
+
+=== Debug === 
+ * 
+ * 
+ * 
+ * 
+ * 
+
+
 ----
 == Comments ==