aa_arch_spec man page

aa_arch_spec — Archive Specification File




Archive specification file contains all information needed for creation of a single archive.

File Format

Options in the .aa file are divided into sections.  A section begins with the section name enclosed in square brackets.  It contains variables which represents the options.

Variables are written in the option-name = value form, one variable per line.  Boolean values are written as yes and no.  For path values, tilde (~) is expanded to the user's home.  Form option-name = can be used to specify a variable with undefined value.

Values of include-files and exclude-files options that contains spaces has to be enclosed in double quotes ("").  They may contain standard shell wildcards.

When specifying the value it is possible to refer to other variables in the form %(variable-name)s.

Lines beginning with # or ; are ignored and may be used for comments.

Two sections are valid: [Archive] (optional) and [Content].

Section [Archive]

This section can contain configuration options which are, when specified, overriding the ones specified in configuration files and command line.

Options valid in the [Archive] section:

  • archiver
  • incremental
  • restarting
  • restart-after-level
  • restart-after-age
  • full-restart-after-count
  • full-restart-after-age
  • max-restart-level-size
  • remove-obsolete-backups
  • keep-old-backups
  • number-of-old-backups
  • compression-level
  • dest-dir
  • command-before-backup
  • command-after-backup
  • overwrite-at-start

See aa(1) for their description.

Section [Content]

This section contains options specific to an archive.  All options except name are required.

Options valid in the [Content] section:

  • name

    Archive name.  Created backup will be named according value of this variable plus appropriate extension.  It is optional; default value is the name of the .aa file without the extension.

  • path

    Path to archive root.  All paths and file names specified in the same archive specification file will be relative to this path.  It will be also the root of the created archive.

  • include-files

    List of space separated file or directory names to backup.  Paths here are relative to the path specified in path variable above.  Starting forward slash (/) from absolute paths as well as parent directory tokens (..) will be ignored.

  • exclude-files

    List of space separated file or directory names to be excluded from the backup.  Use exclude-files = to specify that no files should be excluded.  Similarly to include-files these paths are relative to path.


This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.

See Also

aa(1), aa.conf(5)

Referenced By

aa(1), aa.conf(5).

November 09, 2016 1.3.0 AutoArchive