restic-dump(1)

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

NAME

6       restic-dump - Print a backed-up file to stdout
7
8
9

SYNOPSIS

11       restic dump [flags] snapshotID file
12
13
14

DESCRIPTION

16       The  "dump" command extracts files from a snapshot from the repository.
17       If a single file is selected, it prints its contents to stdout. Folders
18       are  output  as  a tar (default) or zip file containing the contents of
19       the specified folder.  Pass "/" as file name to dump the whole snapshot
20       as an archive file.
21
22
23       The  special snapshotID "latest" can be used to use the latest snapshot
24       in the repository.
25
26
27       To include the folder content at the root of the archive, you  can  use
28       the ":" syntax, where "subfolder" is a path within the snapshot.
29
30
31

EXIT STATUS

33       Exit  status  is 0 if the command was successful, and non-zero if there
34       was any error.
35
36
37

OPTIONS

39       -a, --archive="tar"      set archive format as "tar" or "zip"
40
41
42       -h, --help[=false]      help for dump
43
44
45       -H, --host=[]      only consider snapshots for this host, when snapshot
46       ID "latest" is given (can be specified multiple times)
47
48
49       --path=[]       only consider snapshots including this (absolute) path,
50       when snapshot ID "latest" is given (can be specified multiple times)
51
52
53       --tag=[]      only consider  snapshots  including  tag[,tag,...],  when
54       snapshot ID "latest" is given (can be specified multiple times)
55
56
57

OPTIONS INHERITED FROM PARENT COMMANDS

59       --cacert=[]      file to load root certificates from (default: use sys‐
60       tem certificates or $RESTIC_CACERT)
61
62
63       --cache-dir=""      set the cache directory. (default: use  system  de‐
64       fault cache directory)
65
66
67       --cleanup-cache[=false]      auto remove old cache directories
68
69
70       --compression=auto      compression mode (only available for repository
71       format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)
72
73
74       --insecure-tls[=false]      skip TLS certificate verification when con‐
75       necting to the repository (insecure)
76
77
78       --json[=false]       set  output mode to JSON for commands that support
79       it
80
81
82       --key-hint=""      key ID of key  to  try  decrypting  first  (default:
83       $RESTIC_KEY_HINT)
84
85
86       --limit-download=0       limits  downloads  to a maximum rate in KiB/s.
87       (default: unlimited)
88
89
90       --limit-upload=0      limits uploads to a maximum rate in  KiB/s.  (de‐
91       fault: unlimited)
92
93
94       --no-cache[=false]      do not use a local cache
95
96
97       --no-lock[=false]      do not lock the repository, this allows some op‐
98       erations on read-only repositories
99
100
101       -o, --option=[]      set extended option (key=value, can  be  specified
102       multiple times)
103
104
105       --pack-size=0       set target pack size in MiB, created pack files may
106       be larger (default: $RESTIC_PACK_SIZE)
107
108
109       --password-command=""      shell command to obtain the repository pass‐
110       word from (default: $RESTIC_PASSWORD_COMMAND)
111
112
113       -p,  --password-file=""       file to read the repository password from
114       (default: $RESTIC_PASSWORD_FILE)
115
116
117       -q, --quiet[=false]      do not output comprehensive progress report
118
119
120       -r, --repo=""      repository to backup to or  restore  from  (default:
121       $RESTIC_REPOSITORY)
122
123
124       --repository-file=""       file  to  read  the repository location from
125       (default: $RESTIC_REPOSITORY_FILE)
126
127
128       --retry-lock=0s      retry to lock the  repository  if  it  is  already
129       locked, takes a value like 5m or 2h (default: no retries)
130
131
132       --tls-client-cert=""       path  to  a  file containing PEM encoded TLS
133       client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
134
135
136       -v, --verbose[=0]      be verbose (specify multiple times  or  a  level
137       using --verbose=n``, max level/times is 2)
138
139
140

NAME

SYNOPSIS

DESCRIPTION

EXIT STATUS

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO