1AA_ARCH_SPEC(5)                   AutoArchive                  AA_ARCH_SPEC(5)
2
3
4

NAME

6       aa_arch_spec - Archive Specification File
7

SYNOPSIS

9       ~/.config/aa/archive_specs/*.aa
10

DESCRIPTION

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

FILE FORMAT

16       Options in the .aa file are divided into sections.   A  section  begins
17       with  the  section name enclosed in square brackets.  It contains vari‐
18       ables which represents the options.
19
20       Variables are written in the option-name = value form, one variable per
21       line.   Boolean  values  are  written  as yes and no.  For path values,
22       tilde (~) is expanded to the user's home.  Form option-name  =  can  be
23       used to specify a variable with undefined value.
24
25       Values  of include-files and exclude-files options that contains spaces
26       has to be enclosed in double quotes ("").  They  may  contain  standard
27       shell wildcards.
28
29       When specifying the value it is possible to refer to other variables in
30       the form %(variable-name)s.
31
32       Lines beginning with # or ; are ignored and may be used for comments.
33
34       Two sections are valid: [Archive] (optional) and [Content].
35
36   Section [Archive]
37       This section can contain configuration options which are,  when  speci‐
38       fied,  overriding the ones specified in configuration files and command
39       line.
40
41       Options valid in the [Archive] section:
42
43          · archiver
44
45          · incremental
46
47          · restarting
48
49          · restart-after-level
50
51          · restart-after-age
52
53          · full-restart-after-count
54
55          · full-restart-after-age
56
57          · max-restart-level-size
58
59          · remove-obsolete-backups
60
61          · keep-old-backups
62
63          · number-of-old-backups
64
65          · compression-level
66
67          · dest-dir
68
69          · command-before-backup
70
71          · command-after-backup
72
73          · overwrite-at-start
74
75       See aa(1) for their description.
76
77   Section [Content]
78       This section contains options specific  to  an  archive.   All  options
79       except name are required.
80
81       Options valid in the [Content] section:
82
83          · name
84
85            Archive  name.   Created  backup  will be named according value of
86            this variable plus appropriate extension.  It is optional; default
87            value is the name of the .aa file without the extension.
88
89          · path
90
91            Path  to  archive root.  All paths and file names specified in the
92            same archive specification file will be relative to this path.  It
93            will be also the root of the created archive.
94
95          · include-files
96
97            List  of space separated file or directory names to backup.  Paths
98            here are relative to the path specified in  path  variable  above.
99            Starting  forward  slash (/) from absolute paths as well as parent
100            directory tokens (..) will be ignored.
101
102          · exclude-files
103
104            List of space separated file or directory  names  to  be  excluded
105            from  the  backup.   Use  exclude-files = to specify that no files
106            should be excluded.  Similarly to include-files  these  paths  are
107            relative to path.
108

LICENSE

110       This program is free software: you can redistribute it and/or modify it
111       under the terms of the GNU General Public License  version  3  as  pub‐
112       lished by the Free Software Foundation.
113
114       This  program  is  distributed  in the hope that it will be useful, but
115       WITHOUT ANY  WARRANTY;  without  even  the  implied  warranty  of  MER‐
116       CHANTABILITY  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
117       Public License for more details.
118
119       You should have received a copy of the GNU General Public License along
120       with this program.  If not, see <http://www.gnu.org/licenses/>.
121

SEE ALSO

123       aa(1), aa.conf(5)
124
126       2003 - 2016, Robert Cernansky
127
128
129
130
1311.3.0                          November 09, 2016               AA_ARCH_SPEC(5)
Impressum