restic-backup(1)

1restic backup(1)                                              restic backup(1)
2
3
4

NAME

6       restic-backup - Create a new backup of files and/or directories
7
8
9

SYNOPSIS

11       restic backup [flags] FILE/DIR [FILE/DIR] ...
12
13
14

DESCRIPTION

16       The "backup" command creates a new snapshot and saves the files and
17       directories given as the arguments.
18
19
20

EXIT STATUS

22       Exit status is 0 if the command was successful.  Exit status is 1 if
23       there was a fatal error (no snapshot created).  Exit status is 3 if
24       some source data could not be read (incomplete snapshot created).
25
26
27

OPTIONS

29       -e, --exclude=[]
30           exclude a pattern (can be specified multiple times)
31
32
33       --exclude-caches[=false]
34           excludes cache directories that are marked with a CACHEDIR.TAG
35       file. See ⟨https://bford.info/cachedir/⟩ for the Cache Directory
36       Tagging Standard
37
38
39       --exclude-file=[]
40           read exclude patterns from a file (can be specified multiple times)
41
42
43       --exclude-if-present=[]
44           takes filename[:header], exclude contents of directories containing
45       filename (except filename itself) if header of that file is as provided
46       (can be specified multiple times)
47
48
49       --exclude-larger-than=""
50           max size of the files to be backed up (allowed suffixes: k/K, m/M,
51       g/G, t/T)
52
53
54       --files-from=[]
55           read the files to backup from file (can be combined with file args;
56       can be specified multiple times)
57
58
59       --files-from-raw=[]
60           read the files to backup from file (can be combined with file args;
61       can be specified multiple times)
62
63
64       --files-from-verbatim=[]
65           read the files to backup from file (can be combined with file args;
66       can be specified multiple times)
67
68
69       -f, --force[=false]
70           force re-reading the target files/directories (overrides the
71       "parent" flag)
72
73
74       -h, --help[=false]
75           help for backup
76
77
78       -H, --host=""
79           set the hostname for the snapshot manually. To prevent an expensive
80       rescan use the "parent" flag
81
82
83       --iexclude=[]
84           same as --exclude pattern but ignores the casing of filenames
85
86
87       --iexclude-file=[]
88           same as --exclude-file but ignores casing of filenames in patterns
89
90
91       --ignore-ctime[=false]
92           ignore ctime changes when checking for modified files
93
94
95       --ignore-inode[=false]
96           ignore inode number changes when checking for modified files
97
98
99       -x, --one-file-system[=false]
100           exclude other file systems
101
102
103       --parent=""
104           use this parent snapshot (default: last snapshot in the repo that
105       has the same target files/directories)
106
107
108       --stdin[=false]
109           read backup from stdin
110
111
112       --stdin-filename="stdin"
113           filename to use when reading from stdin
114
115
116       --tag=[]
117           add tags for the new snapshot in the format tag[,tag,...] (can be
118       specified multiple times)
119
120
121       --time=""
122           time of the backup (ex. '2012-11-01 22:08:41') (default: now)
123
124
125       --with-atime[=false]
126           store the atime for all files and directories
127
128
129

OPTIONS INHERITED FROM PARENT COMMANDS

131       --cacert=[]
132           file to load root certificates from (default: use system
133       certificates)
134
135
136       --cache-dir=""
137           set the cache directory. (default: use system default cache
138       directory)
139
140
141       --cleanup-cache[=false]
142           auto remove old cache directories
143
144
145       --json[=false]
146           set output mode to JSON for commands that support it
147
148
149       --key-hint=""
150           key ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
151
152
153       --limit-download=0
154           limits downloads to a maximum rate in KiB/s. (default: unlimited)
155
156
157       --limit-upload=0
158           limits uploads to a maximum rate in KiB/s. (default: unlimited)
159
160
161       --no-cache[=false]
162           do not use a local cache
163
164
165       --no-lock[=false]
166           do not lock the repository, this allows some operations on
167       read-only repositories
168
169
170       -o, --option=[]
171           set extended option (key=value, can be specified multiple times)
172
173
174       --password-command=""
175           shell command to obtain the repository password from (default:
176       $RESTIC_PASSWORD_COMMAND)
177
178
179       -p, --password-file=""
180           file to read the repository password from (default:
181       $RESTIC_PASSWORD_FILE)
182
183
184       -q, --quiet[=false]
185           do not output comprehensive progress report
186
187
188       -r, --repo=""
189           repository to backup to or restore from (default:
190       $RESTIC_REPOSITORY)
191
192
193       --repository-file=""
194           file to read the repository location from (default:
195       $RESTIC_REPOSITORY_FILE)
196
197
198       --tls-client-cert=""
199           path to a file containing PEM encoded TLS client certificate and
200       private key
201
202
203       -v, --verbose[=0]
204           be verbose (specify multiple times or a level using --verbose=n,
205       max level/times is 3)
206
207
208

NAME

SYNOPSIS

DESCRIPTION

EXIT STATUS

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO