sysgather - a configuration file mismanager
$Ringlet: sysgather.pl 319 2006-02-14 12:28:18Z roam $
sysgather [-hnvV] [-f file] command [package...]
The sysgather utility stores various collections of configuration files, both for the system and for applications, in order to facilitate keeping them under version control.
The configuration files are organized into collections, or packages. Each package is defined by a section in the sysgather.conf file. An example of a package could be the base system configuration files (most of the contents of the /etc directory), the Apache webserver configuration files (httpd.conf, access.conf, mime.types, etc.), or a user's dotfiles.
If the special value
ALL is specified as the only package name,
sysgather operates on all the groups defined on the
line in the
default section of its configuration file.
The sysgather utility processes two configuration files: a system-wide
one, located in /usr/local/etc/sysgather.conf, and a per-user file
containing additional definitions and overrides, located in each user's
home directory and named .sysgather.conf. If the per-user file exists,
any collections defined within it replace the corresponding collections
from the system-wide file, and any variables in the
will also replace the corresponding variables from the system-wide file.
Note: If this option is present, the ~/.sysgather.conf file is not processed after the specified configuration file.
The sysgather utility recognizes the following commands:
The configuration file for the sysgather utility usually goes by the name of sysgather.conf. It is separated into several sections, of which only one is mandatory - the default section.
Currently, the default section only contains one setting: the groups variable, a list of file collections for sysgather to process. For each name in this list, sysgather looks for a configuration file section by the same name, and treats it as a file collection section.
A file collection is, simply put, a list of files to keep under version control together. Each collection is represented by a INI-style group - the name of the group serves as the name of the collection. There are two kinds of variables within the group - collection properties and source file specifications.
There are two modes of sysgather operation - source files and actual
files. The files listed in the
files property are the actual files
that will be kept track of. For some of them, a source file may be
specified - an ``original'', vendor version. This may be useful for
keeping track of local changes and merging the vendor modifications
For each collection, the following configuration directives may be specified:
confdir, paths relative to
confdir, or absolute paths.
For each of the actual files listed in the
files directive, a source
file may be specified. This is done by defining a
the same name as the actual file, the value of which is the name of
the source file relative to
For an example, please consult the various configuration files in the /usr/local/share/examples/sysgather/ directory, as well as the sample sysgather.conf file provided with the sysgather distribution.
Grab the base system's default configuration files for an import into a version control system:
sysgather source sys-fbsd5
Fetch the currently-used versions of the system files and the Apache webserver configuration for a check-in into the version control system:
sysgather get sys-fbsd5 apache
Display the differences between the stored files and the currently active Apache configuration:
sysgather diff apache
Put the stored configuration files (presumably after a version control check-in) as the active configuration for the Apache webserver:
sysgather put apache
The sysgather utility was written by Peter Pentchev in 2005.
Peter Pentchev <firstname.lastname@example.org>