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

OPTIONS INHERITED FROM PARENT COMMANDS

117       --cacert=[]      file to load root certificates from (default: use sys‐
118       tem certificates)
119
120
121       --cache-dir=""       set  the cache directory. (default: use system de‐
122       fault cache directory)
123
124
125       --cleanup-cache[=false]      auto remove old cache directories
126
127
128       --json[=false]      set output mode to JSON for commands  that  support
129       it
130
131
132       --key-hint=""       key  ID  of  key  to try decrypting first (default:
133       $RESTIC_KEY_HINT)
134
135
136       --limit-download=0      limits downloads to a maximum  rate  in  KiB/s.
137       (default: unlimited)
138
139
140       --limit-upload=0       limits  uploads to a maximum rate in KiB/s. (de‐
141       fault: unlimited)
142
143
144       --no-cache[=false]      do not use a local cache
145
146
147       --no-lock[=false]      do not lock the repository, this allows some op‐
148       erations on read-only repositories
149
150
151       -o,  --option=[]       set extended option (key=value, can be specified
152       multiple times)
153
154
155       --password-command=""      shell command to obtain the repository pass‐
156       word from (default: $RESTIC_PASSWORD_COMMAND)
157
158
159       -p,  --password-file=""       file to read the repository password from
160       (default: $RESTIC_PASSWORD_FILE)
161
162
163       -q, --quiet[=false]      do not output comprehensive progress report
164
165
166       -r, --repo=""      repository to backup to or  restore  from  (default:
167       $RESTIC_REPOSITORY)
168
169
170       --repository-file=""       file  to  read  the repository location from
171       (default: $RESTIC_REPOSITORY_FILE)
172
173
174       --tls-client-cert=""      path to a file  containing  PEM  encoded  TLS
175       client certificate and private key
176
177
178       -v,  --verbose[=0]       be  verbose (specify multiple times or a level
179       using --verbose=n, max level/times is 3)
180
181
182

NAME

SYNOPSIS

DESCRIPTION

EXIT STATUS

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO