Provided by: xstow_0.5.1-5_i386 bug

NAME

       xstow.ini, config file for XStow

CONTENT

       The xstow.ini file contains some static informations about your system.
       It’s possible setting most necessary values by setting the required
       command line option, but in some cases this won’t make sense if you are
       using xstow quite often.

SYNTAX

       The syntax of the configuration file is simple. It’s the same as it is
       used by KDE and GNOME.

       The data is splitted into keys values and sections. The ’#’ sign marks
       a comment. Here is an example:

               [traserve-links]
               keep-targets = true
               link = /usr/tmp  # comment

[traserve-links]

keep-targets = true

value.

PROCESSING

       XStow processes the config files one after another. Static
       configuration options like the [debug]=>module option can be
       overwritten by the next config file. List keys like
       [traverse-links]=>link will be appended to the list.

       If you wan’t more informations about the current stow setup call XStow
       like this:

               xstow -s -dl 1 dummy-package | less

       For getting information about which config files were processed you
       will have to set some environment values (see xstow(1) for details).
       Eg.:

               XSTOW_DEBUG_LEVEL=1 xstow -s -dl 1 dummy-package | less

DESCRIPTION

       SECTION traserve-links

       In this section a number of links are listed, which xstow will identify
       as links that are not part of an xstow managed package.  Eg.: For
       conforming to the FHS it is common setting a link from /usr/share/man
       to /usr/man. This will cause old applications installing theire
       manpages in /usr/share/man, rather than in /usr/man.

       But xstow is paranoid and believes that the link contains to something
       else and it is not allowed writing data into the directory the link
       points to.

       The simple solution is telling xstow which links should be handled as
       normal directories. These links can be listed in this section.

link = LINK
link.  It is allowed that there are more than one link keys in this section.

keep-targets = BOOL
in this section will automatically added to the keep-dirs section. This avoids
add-if-target = PATTERN
it is no problem setting [links]=>absolute-links to true and using a pattern
like /* here.  If keep-targets is set to true the applied links will added to
the keep-dirs list too.

add-if-target-regex = REGEX
Does the same as add-if-target, but support regular expressions. XStow will

SECTION keep-dirs

too.

dir = DIR
should be kept.  It is allowed that there are more than one dir keys in this
section. The value should not end with a/!!

SECTION matches

ignore = PATTERN
one ignore keys in this section.

ignore-regex = PATTERN
Does the same as ignore, but support regular expressions. XStow will always
copy = PATTERN
The directory index of the GNU info(1) files is a file named ’dir’. Files that
there are more than one copy keys in this section.

copy-regex = PATTERN
Does the same as copy, but support regular expressions. XStow will always try
nignore = NIGNORE_RULE
"systree/bintree".  For using nignore support fnmatch and configration file
"systree":

        [systree]
        dir       = /usr
        dir       = /usr/local
        follow    = false
package.

SECTION NIGNORE-SUB-RULE

dir = DIR

SECTION stow-dirs


dir = DIR
allowed that there are more than one dir keys in this section. The value
should not end with a/!!

auto-add-dirs = PATTERN
configuration files.  It is allowed that there are more than one auto-add-dirs
auto-add-dirs-regex = REGEX
Does the same as auto-add-dirs, but support regular expressions. XStow will

SECTION protect-dirs

        make install DESTDIR=/stow/package_name
dir = DIR
there are more than one dir keys in this section. The value should not end
with a/!!

auto-add-dirs = PATTERN
there are more than one auto-add-dirs keys in this section.

auto-add-dirs-regex = REGEX
Does the same as auto-add-dirs, but support regular expressions. XStow will
target = DIR
there are more than one target keys in this section. The value should not end
with a/!!

target-add-traversable-links = BOOL

SECTION debug

option.

module = MODULE
level = INTEGER

SECTION config-files


in-home BOOL
in-stow-dir BOOL
in-other-stow-dirs BOOL
file FILE
It is allowed that there are more than one file keys in this section.

SECTION links


absolute-paths = BOOL

EXAMPLE xstow.ini

       EXAMPLE 1

       Here is an example xstow.ini which is common for a system where xstow
       is managing the /usr/local tree.

               [traverse-links]
               keep-targets = true
               link = /usr/local/tmp
               link = /usr/local/var
               link = /usr/local/man
               link = /usr/local/doc
               link = /usr/local/info

               [keep-dirs]
               dir = /usr/local/bin
               dir = /usr/local/sbin
               dir = /usr/local/lib
               dir = /usr/local/include

               [matches]
               ignore = *~
               ignore = core
               ignore = core.*
               ignore = CVS

               [stow-dirs]
               dir = /usr/local/stow
               dir = /usr/local/stow2

       EXAMPLE 2

       This is an example xstow.ini for a system where xstow is managing the
       ’/usr/local’ tree, but the stow directory is ’/stow’.

               [matches]
               ignore = *~
               ignore = CVS
               ignore = core*

               [stow-dirs]
               dir = /stow

               [protect-dirs]
               target = /usr/local

SEE ALSO

       xstow(1)

       In the document directory of this package is a more advanced sample
       xstow.ini file.