pkgbuilds/gdocsfs/src/README.txt

   1 This directory holds run-time configuration information for Subversion
   2 clients.  The configuration files all share the same syntax, but you
   3 should examine a particular file to learn what configuration
   4 directives are valid for that file.
   5
   6 The syntax is standard INI format:
   7
   8    - Empty lines, and lines starting with '#', are ignored.
   9      The first significant line in a file must be a section header.
  10
  11    - A section starts with a section header, which must start in
  12      the first column:
  13
  14        [section-name]
  15
  16    - An option, which must always appear within a section, is a pair
  17      (name, value).  There are two valid forms for defining an
  18      option, both of which must start in the first column:
  19
  20        name: value
  21        name = value
  22
  23      Whitespace around the separator (:, =) is optional.
  24
  25    - Section and option names are case-insensitive, but case is
  26      preserved.
  27
  28    - An option's value may be broken into several lines.  The value
  29      continuation lines must start with at least one whitespace.
  30      Trailing whitespace in the previous line, the newline character
  31      and the leading whitespace in the continuation line is compressed
  32      into a single space character.
  33
  34    - All leading and trailing whitespace around a value is trimmed,
  35      but the whitespace within a value is preserved, with the
  36      exception of whitespace around line continuations, as
  37      described above.
  38
  39    - When a value is a boolean, any of the following strings are
  40      recognised as truth values (case does not matter):
  41
  42        true      false
  43        yes       no
  44        on        off
  45        1         0
  46
  47    - When a value is a list, it is comma-separated.  Again, the
  48      whitespace around each element of the list is trimmed.
  49
  50    - Option values may be expanded within a value by enclosing the
  51      option name in parentheses, preceded by a percent sign and
  52      followed by an 's':
  53
  54        %(name)s
  55
  56      The expansion is performed recursively and on demand, during
  57      svn_option_get.  The name is first searched for in the same
  58      section, then in the special [DEFAULT] section. If the name
  59      is not found, the whole '%(name)s' placeholder is left
  60      unchanged.
  61
  62      Any modifications to the configuration data invalidate all
  63      previously expanded values, so that the next svn_option_get
  64      will take the modifications into account.
  65
  66 The syntax of the configuration files is a subset of the one used by
  67 Python's ConfigParser module; see
  68
  69    http://www.python.org/doc/current/lib/module-ConfigParser.html
  70
  71 Configuration data in the Windows registry
  72 ==========================================
  73
  74 On Windows, configuration data may also be stored in the registry. The
  75 functions svn_config_read and svn_config_merge will read from the
  76 registry when passed file names of the form:
  77
  78    REGISTRY:<hive>/path/to/config-key
  79
  80 The REGISTRY: prefix must be in upper case. The <hive> part must be
  81 one of:
  82
  83    HKLM for HKEY_LOCAL_MACHINE
  84    HKCU for HKEY_CURRENT_USER
  85
  86 The values in config-key represent the options in the [DEFAULT] section.
  87 The keys below config-key represent other sections, and their values
  88 represent the options. Only values of type REG_SZ whose name doesn't
  89 start with a '#' will be used; other values, as well as the keys'
  90 default values, will be ignored.
  91
  92
  93 File locations
  94 ==============
  95
  96 Typically, Subversion uses two config directories, one for site-wide
  97 configuration,
  98
  99   Unix:
 100     /etc/subversion/servers
 101     /etc/subversion/config
 102     /etc/subversion/hairstyles
 103   Windows:
 104     %ALLUSERSPROFILE%\Application Data\Subversion\servers
 105     %ALLUSERSPROFILE%\Application Data\Subversion\config
 106     %ALLUSERSPROFILE%\Application Data\Subversion\hairstyles
 107     REGISTRY:HKLM\Software\Tigris.org\Subversion\Servers
 108     REGISTRY:HKLM\Software\Tigris.org\Subversion\Config
 109     REGISTRY:HKLM\Software\Tigris.org\Subversion\Hairstyles
 110
 111 and one for per-user configuration:
 112
 113   Unix:
 114     ~/.subversion/servers
 115     ~/.subversion/config
 116     ~/.subversion/hairstyles
 117   Windows:
 118     %APPDATA%\Subversion\servers
 119     %APPDATA%\Subversion\config
 120     %APPDATA%\Subversion\hairstyles
 121     REGISTRY:HKCU\Software\Tigris.org\Subversion\Servers
 122     REGISTRY:HKCU\Software\Tigris.org\Subversion\Config
 123     REGISTRY:HKCU\Software\Tigris.org\Subversion\Hairstyles
 124