Merge lp:~ed.so/duplicity/manpage into lp:duplicity/0.6
- manpage
- Merge into 0.6-series
Proposed by
Kenneth Loafman
Status: | Merged |
---|---|
Merged at revision: | 895 |
Proposed branch: | lp:~ed.so/duplicity/manpage |
Merge into: | lp:duplicity/0.6 |
Diff against target: |
380 lines (+101/-132) 1 file modified
bin/duplicity.1 (+101/-132) |
To merge this branch: | bzr merge lp:~ed.so/duplicity/manpage |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
duplicity-team | Pending | ||
Review via email:
|
Commit message
Description of the change
more formatting fixes, clarifications in sections EXAMPLES, FILE SELECTION
To post a comment you must log in.
lp:~ed.so/duplicity/manpage
updated
- 895. By Kenneth Loafman
-
* Merged in lp:~ed.so/duplicity/manpage
- more formatting fixes, clarifications in sections EXAMPLES, FILE SELECTION
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file 'bin/duplicity.1' | |||
2 | --- bin/duplicity.1 2012-10-17 14:04:27 +0000 | |||
3 | +++ bin/duplicity.1 2012-11-11 01:40:25 +0000 | |||
4 | @@ -68,50 +68,39 @@ | |||
5 | 68 | .SH SYNOPSIS | 68 | .SH SYNOPSIS |
6 | 69 | .B duplicity [full|incremental] | 69 | .B duplicity [full|incremental] |
7 | 70 | .I [options] | 70 | .I [options] |
9 | 71 | .I source_directory target_url | 71 | source_directory target_url |
10 | 72 | 72 | ||
11 | 73 | .B duplicity verify | 73 | .B duplicity verify |
15 | 74 | .I [options] | 74 | .I [options] [--file-to-restore <relpath>] |
16 | 75 | .I [--file-to-restore <relpath>] | 75 | source_url target_directory |
14 | 76 | .I source_url target_directory | ||
17 | 77 | 76 | ||
18 | 78 | .B duplicity collection-status | 77 | .B duplicity collection-status |
19 | 79 | .I [options] | 78 | .I [options] |
21 | 80 | .I target_url | 79 | target_url |
22 | 81 | 80 | ||
23 | 82 | .B duplicity list-current-files | 81 | .B duplicity list-current-files |
27 | 83 | .I [options] | 82 | .I [options] [--time time] |
28 | 84 | .I [--time time] | 83 | target_url |
26 | 85 | .I target_url | ||
29 | 86 | 84 | ||
30 | 87 | .B duplicity [restore] | 85 | .B duplicity [restore] |
53 | 88 | .I [options] | 86 | .I [options] [--file-to-restore <relpath>] [--time time] |
54 | 89 | .I [--file-to-restore <relpath>] | 87 | source_url target_directory |
55 | 90 | .I [--time time] | 88 | |
56 | 91 | .I source_url target_directory | 89 | .B duplicity remove-older-than <time> |
57 | 92 | 90 | .I [options] [--force] | |
58 | 93 | .B duplicity remove-older-than | 91 | target_url |
59 | 94 | .I time | 92 | |
60 | 95 | .I [options] | 93 | .B duplicity remove-all-but-n-full <count> |
61 | 96 | .I [--force] | 94 | .I [options] [--force] |
62 | 97 | .I target_url | 95 | target_url |
63 | 98 | 96 | ||
64 | 99 | .B duplicity remove-all-but-n-full | 97 | .B duplicity remove-all-inc-of-but-n-full <count> |
65 | 100 | .I count | 98 | .I [options] [--force] |
66 | 101 | .I [options] | 99 | target_url |
45 | 102 | .I [--force] | ||
46 | 103 | .I target_url | ||
47 | 104 | |||
48 | 105 | .B duplicity remove-all-inc-of-but-n-full | ||
49 | 106 | .I count | ||
50 | 107 | .I [options] | ||
51 | 108 | .I [--force] | ||
52 | 109 | .I target_url | ||
67 | 110 | 100 | ||
68 | 111 | .B duplicity cleanup | 101 | .B duplicity cleanup |
72 | 112 | .I [options] | 102 | .I [options] [--force] [--extra-clean] |
73 | 113 | .I [--force] | 103 | target_url |
71 | 114 | .I target_url | ||
74 | 115 | 104 | ||
75 | 116 | .SH DESCRIPTION | 105 | .SH DESCRIPTION |
76 | 117 | Duplicity incrementally backs up files and directory | 106 | Duplicity incrementally backs up files and directory |
77 | @@ -291,7 +280,7 @@ | |||
78 | 291 | .TP | 280 | .TP |
79 | 292 | .BI --allow-source-mismatch | 281 | .BI --allow-source-mismatch |
80 | 293 | Do not abort on attempts to use the same archive dir or remote backend | 282 | Do not abort on attempts to use the same archive dir or remote backend |
82 | 294 | to back up different directories. duplicity will tell you if you need | 283 | to back up different directories. duplicity will tell you if you need |
83 | 295 | this switch. | 284 | this switch. |
84 | 296 | 285 | ||
85 | 297 | .TP | 286 | .TP |
86 | @@ -632,12 +621,9 @@ | |||
87 | 632 | .I orig | 621 | .I orig |
88 | 633 | in the backup as if it were the path | 622 | in the backup as if it were the path |
89 | 634 | .I new. | 623 | .I new. |
93 | 635 | Can be passed multiple times. An example: | 624 | Can be passed multiple times. An example: |
94 | 636 | .PP | 625 | |
92 | 637 | .RS | ||
95 | 638 | duplicity restore --rename Documents/metal Music/metal sftp://uid@other.host/some_dir /home/me | 626 | duplicity restore --rename Documents/metal Music/metal sftp://uid@other.host/some_dir /home/me |
96 | 639 | .PP | ||
97 | 640 | .RE | ||
98 | 641 | 627 | ||
99 | 642 | .TP | 628 | .TP |
100 | 643 | .BI "--rsync-options " options | 629 | .BI "--rsync-options " options |
101 | @@ -646,12 +632,9 @@ | |||
102 | 646 | list should be of the form "opt1=parm1 opt2=parm2" where the option string is | 632 | list should be of the form "opt1=parm1 opt2=parm2" where the option string is |
103 | 647 | quoted and the only spaces allowed are between options. The option string | 633 | quoted and the only spaces allowed are between options. The option string |
104 | 648 | will be passed verbatim to rsync, after any internally generated option | 634 | will be passed verbatim to rsync, after any internally generated option |
108 | 649 | designating the remote port to use. Here is a possibly useful example: | 635 | designating the remote port to use. Here is a possibly useful example: |
109 | 650 | .PP | 636 | |
107 | 651 | .RS | ||
110 | 652 | duplicity --rsync-options="--partial-dir=.rsync-partial" /home/me rsync://uid@other.host/some_dir | 637 | duplicity --rsync-options="--partial-dir=.rsync-partial" /home/me rsync://uid@other.host/some_dir |
111 | 653 | .PP | ||
112 | 654 | .RE | ||
113 | 655 | 638 | ||
114 | 656 | .TP | 639 | .TP |
115 | 657 | .BI "--s3-european-buckets" | 640 | .BI "--s3-european-buckets" |
116 | @@ -759,10 +742,9 @@ | |||
117 | 759 | differs slightly hence the options should therefore be given in the long option format described in | 742 | differs slightly hence the options should therefore be given in the long option format described in |
118 | 760 | .BR ssh_config(5) , | 743 | .BR ssh_config(5) , |
119 | 761 | like in this example: | 744 | like in this example: |
122 | 762 | .RS | 745 | |
121 | 763 | .PP | ||
123 | 764 | duplicity --ssh-options="-oProtocol=2 -oIdentityFile=/my/backup/id" /home/me scp://uid@other.host/some_dir | 746 | duplicity --ssh-options="-oProtocol=2 -oIdentityFile=/my/backup/id" /home/me scp://uid@other.host/some_dir |
125 | 765 | .TP | 747 | |
126 | 766 | .B NOTE: | 748 | .B NOTE: |
127 | 767 | .I ssh paramiko backend | 749 | .I ssh paramiko backend |
128 | 768 | currently supports only the | 750 | currently supports only the |
129 | @@ -1000,18 +982,29 @@ | |||
130 | 1000 | system. The file selection system comprises a number of file | 982 | system. The file selection system comprises a number of file |
131 | 1001 | selection conditions, which are set using one of the following command | 983 | selection conditions, which are set using one of the following command |
132 | 1002 | line options: | 984 | line options: |
145 | 1003 | .BR --exclude , | 985 | .RS |
146 | 1004 | .BR --exclude-device-files , | 986 | --exclude |
147 | 1005 | .BR --exclude-filelist , | 987 | .br |
148 | 1006 | .BR --exclude-filelist-stdin , | 988 | --exclude-device-files |
149 | 1007 | .BR --exclude-globbing-filelist , | 989 | .br |
150 | 1008 | .BR --exclude-regexp , | 990 | --exclude-filelist |
151 | 1009 | .BR --include , | 991 | .br |
152 | 1010 | .BR --include-filelist , | 992 | --exclude-filelist-stdin |
153 | 1011 | .BR --include-filelist-stdin , | 993 | .br |
154 | 1012 | .BR --include-globbing-filelist , | 994 | --exclude-globbing-filelist |
155 | 1013 | and | 995 | .br |
156 | 1014 | .BR --include-regexp . | 996 | --exclude-regexp |
157 | 997 | .br | ||
158 | 998 | --include | ||
159 | 999 | .br | ||
160 | 1000 | --include-filelist | ||
161 | 1001 | .br | ||
162 | 1002 | --include-filelist-stdin | ||
163 | 1003 | .br | ||
164 | 1004 | --include-globbing-filelist | ||
165 | 1005 | .br | ||
166 | 1006 | --include-regexp | ||
167 | 1007 | .RE | ||
168 | 1015 | Each file selection condition either matches or doesn't match a given | 1008 | Each file selection condition either matches or doesn't match a given |
169 | 1016 | file. A given file is excluded by the file selection system exactly | 1009 | file. A given file is excluded by the file selection system exactly |
170 | 1017 | when the first matching file selection condition specifies that the | 1010 | when the first matching file selection condition specifies that the |
171 | @@ -1048,15 +1041,15 @@ | |||
172 | 1048 | .BR include-globbing-filelist , | 1041 | .BR include-globbing-filelist , |
173 | 1049 | and | 1042 | and |
174 | 1050 | .B exclude-globbing-filelist | 1043 | .B exclude-globbing-filelist |
176 | 1051 | options accept | 1044 | options accept some |
177 | 1052 | .IR "extended shell globbing patterns" . | 1045 | .IR "extended shell globbing patterns" . |
179 | 1053 | These patterns can contain the special patterns | 1046 | These patterns can contain |
180 | 1054 | .BR * , | 1047 | .BR * , |
181 | 1055 | .BR ** , | 1048 | .BR ** , |
182 | 1056 | .BR ? , | 1049 | .BR ? , |
183 | 1057 | and | 1050 | and |
186 | 1058 | .BR [...] . | 1051 | .B [...] |
187 | 1059 | As in a normal shell, | 1052 | (character ranges). As in a normal shell, |
188 | 1060 | .B * | 1053 | .B * |
189 | 1061 | can be expanded to any string of characters not containing "/", | 1054 | can be expanded to any string of characters not containing "/", |
190 | 1062 | .B ? | 1055 | .B ? |
191 | @@ -1076,66 +1069,52 @@ | |||
192 | 1076 | before duplicity sees them. | 1069 | before duplicity sees them. |
193 | 1077 | 1070 | ||
194 | 1078 | The | 1071 | The |
200 | 1079 | .BI "--exclude " pattern | 1072 | .B --exclude |
201 | 1080 | option matches a file iff: | 1073 | pattern option matches a file if: |
202 | 1081 | 1074 | .IP 1. | |
198 | 1082 | .TP | ||
199 | 1083 | .B 1. | ||
203 | 1084 | .I pattern | 1075 | .I pattern |
204 | 1085 | can be expanded into the file's filename, or | 1076 | can be expanded into the file's filename, or |
208 | 1086 | 1077 | .IP 2. | |
206 | 1087 | .TP | ||
207 | 1088 | .B 2. | ||
209 | 1089 | the file is inside a directory matched by the option. | 1078 | the file is inside a directory matched by the option. |
210 | 1090 | .PP | 1079 | .PP |
218 | 1091 | .RE | 1080 | Conversely, the |
219 | 1092 | Conversely, | 1081 | .B "--include " |
220 | 1093 | .BI "--include " pattern | 1082 | pattern matches a file if: |
221 | 1094 | matches a file iff: | 1083 | .IP 1. |
215 | 1095 | |||
216 | 1096 | .TP | ||
217 | 1097 | .B 1. | ||
222 | 1098 | .I pattern | 1084 | .I pattern |
227 | 1099 | can be expanded into the file's filename, | 1085 | can be expanded into the file's filename, or |
228 | 1100 | 1086 | .IP 2. | |
225 | 1101 | .TP | ||
226 | 1102 | .B 2. | ||
229 | 1103 | the file is inside a directory matched by the option, or | 1087 | the file is inside a directory matched by the option, or |
233 | 1104 | 1088 | .IP 3. | |
231 | 1105 | .TP | ||
232 | 1106 | .B 3. | ||
234 | 1107 | the file is a directory which contains a file matched by the option. | 1089 | the file is a directory which contains a file matched by the option. |
235 | 1108 | .PP | 1090 | .PP |
236 | 1109 | .RE | ||
237 | 1110 | For example, | 1091 | For example, |
240 | 1111 | .PP | 1092 | |
239 | 1112 | .RS | ||
241 | 1113 | .B --exclude | 1093 | .B --exclude |
242 | 1114 | /usr/local | 1094 | /usr/local |
246 | 1115 | .PP | 1095 | |
247 | 1116 | .RE | 1096 | matches e.g. /usr/local, /usr/local/lib, and /usr/local/lib/netscape. It |
245 | 1117 | matches /usr/local, /usr/local/lib, and /usr/local/lib/netscape. It | ||
248 | 1118 | is the same as --exclude /usr/local --exclude '/usr/local/**'. | 1097 | is the same as --exclude /usr/local --exclude '/usr/local/**'. |
251 | 1119 | .PP | 1098 | |
252 | 1120 | .RS | 1099 | Or |
253 | 1100 | .br | ||
254 | 1121 | .B --include | 1101 | .B --include |
255 | 1122 | /usr/local | 1102 | /usr/local |
258 | 1123 | .PP | 1103 | |
257 | 1124 | .RE | ||
259 | 1125 | specifies that /usr, /usr/local, /usr/local/lib, and | 1104 | specifies that /usr, /usr/local, /usr/local/lib, and |
261 | 1126 | /usr/local/lib/netscape (but not /usr/doc) all be backed up. Thus you | 1105 | /usr/local/lib/netscape (but not /usr/doc) all be backed up. Thus you |
262 | 1127 | don't have to worry about including parent directories to make sure | 1106 | don't have to worry about including parent directories to make sure |
266 | 1128 | that included subdirectories have somewhere to go. Finally, | 1107 | that included subdirectories have somewhere to go. |
267 | 1129 | .PP | 1108 | |
268 | 1130 | .RS | 1109 | Finally, |
269 | 1110 | .br | ||
270 | 1131 | .B --include | 1111 | .B --include |
271 | 1132 | ignorecase:'/usr/[a-z0-9]foo/*/**.py' | 1112 | ignorecase:'/usr/[a-z0-9]foo/*/**.py' |
274 | 1133 | .PP | 1113 | |
273 | 1134 | .RE | ||
275 | 1135 | would match a file like /usR/5fOO/hello/there/world.py. If it did | 1114 | would match a file like /usR/5fOO/hello/there/world.py. If it did |
276 | 1136 | match anything, it would also match /usr. If there is no existing | 1115 | match anything, it would also match /usr. If there is no existing |
277 | 1137 | file that the given pattern can be expanded into, the option will not | 1116 | file that the given pattern can be expanded into, the option will not |
279 | 1138 | match /usr. | 1117 | match /usr alone. |
280 | 1139 | 1118 | ||
281 | 1140 | The | 1119 | The |
282 | 1141 | .BR --include-filelist , | 1120 | .BR --include-filelist , |
283 | @@ -1151,9 +1130,7 @@ | |||
284 | 1151 | interpreted similarly to the way | 1130 | interpreted similarly to the way |
285 | 1152 | .I extended shell patterns | 1131 | .I extended shell patterns |
286 | 1153 | are, with a few exceptions: | 1132 | are, with a few exceptions: |
290 | 1154 | 1133 | .IP 1. | |
288 | 1155 | .TP | ||
289 | 1156 | .B 1. | ||
291 | 1157 | Globbing patterns like | 1134 | Globbing patterns like |
292 | 1158 | .BR * , | 1135 | .BR * , |
293 | 1159 | .BR ** , | 1136 | .BR ** , |
294 | @@ -1161,40 +1138,33 @@ | |||
295 | 1161 | and | 1138 | and |
296 | 1162 | .B [...] | 1139 | .B [...] |
297 | 1163 | are not expanded. | 1140 | are not expanded. |
301 | 1164 | 1141 | .IP 2. | |
299 | 1165 | .TP | ||
300 | 1166 | .B 2. | ||
302 | 1167 | Include patterns do not match files in a directory that is included. | 1142 | Include patterns do not match files in a directory that is included. |
303 | 1168 | So /usr/local in an include file will not match /usr/local/doc. | 1143 | So /usr/local in an include file will not match /usr/local/doc. |
307 | 1169 | 1144 | .IP 3. | |
305 | 1170 | .TP | ||
306 | 1171 | .B 3. | ||
308 | 1172 | Lines starting with "+ " are interpreted as include directives, even | 1145 | Lines starting with "+ " are interpreted as include directives, even |
309 | 1173 | if found in a filelist referenced by | 1146 | if found in a filelist referenced by |
310 | 1174 | .BR --exclude-filelist . | 1147 | .BR --exclude-filelist . |
311 | 1175 | Similarly, lines starting with "- " exclude files even if they are | 1148 | Similarly, lines starting with "- " exclude files even if they are |
312 | 1176 | found within an include filelist. | 1149 | found within an include filelist. |
315 | 1177 | 1150 | .PP | |
314 | 1178 | .RE | ||
316 | 1179 | For example, if file "list.txt" contains the lines: | 1151 | For example, if file "list.txt" contains the lines: |
317 | 1180 | 1152 | ||
318 | 1181 | .RS | 1153 | .RS |
319 | 1182 | /usr/local | 1154 | /usr/local |
322 | 1183 | .RE | 1155 | .br |
321 | 1184 | .RS | ||
323 | 1185 | - /usr/local/doc | 1156 | - /usr/local/doc |
326 | 1186 | .RE | 1157 | .br |
325 | 1187 | .RS | ||
327 | 1188 | /usr/local/bin | 1158 | /usr/local/bin |
330 | 1189 | .RE | 1159 | .br |
329 | 1190 | .RS | ||
331 | 1191 | + /var | 1160 | + /var |
334 | 1192 | .RE | 1161 | .br |
333 | 1193 | .RS | ||
335 | 1194 | - /var | 1162 | - /var |
336 | 1163 | .RE | ||
337 | 1195 | 1164 | ||
340 | 1196 | .RE | 1165 | then |
341 | 1197 | then "--include-filelist list.txt" would include /usr, /usr/local, and | 1166 | .B "--include-filelist list.txt" |
342 | 1167 | would include /usr, /usr/local, and | ||
343 | 1198 | /usr/local/bin. It would exclude /usr/local/doc, | 1168 | /usr/local/bin. It would exclude /usr/local/doc, |
344 | 1199 | /usr/local/doc/python, etc. It neither excludes nor includes | 1169 | /usr/local/doc/python, etc. It neither excludes nor includes |
345 | 1200 | /usr/local/man, leaving the fate of this directory to the next | 1170 | /usr/local/man, leaving the fate of this directory to the next |
346 | @@ -1215,26 +1185,25 @@ | |||
347 | 1215 | allowed). For instance, if the file "globbing-list.txt" contains the | 1185 | allowed). For instance, if the file "globbing-list.txt" contains the |
348 | 1216 | lines: | 1186 | lines: |
349 | 1217 | 1187 | ||
350 | 1218 | .RE | ||
351 | 1219 | .RS | 1188 | .RS |
352 | 1220 | dir/foo | 1189 | dir/foo |
355 | 1221 | .RE | 1190 | .br |
354 | 1222 | .RS | ||
356 | 1223 | + dir/bar | 1191 | + dir/bar |
359 | 1224 | .RE | 1192 | .br |
358 | 1225 | .RS | ||
360 | 1226 | - ** | 1193 | - ** |
361 | 1194 | .RE | ||
362 | 1227 | 1195 | ||
366 | 1228 | .RE | 1196 | Then |
367 | 1229 | Then "--include-globbing-filelist globbing-list.txt" would be exactly | 1197 | .B "--include-globbing-filelist globbing-list.txt" |
368 | 1230 | the same as specifying "--include dir/foo --include dir/bar --exclude **" | 1198 | would be exactly the same as specifying |
369 | 1199 | .B "--include dir/foo --include dir/bar --exclude **" | ||
370 | 1231 | on the command line. | 1200 | on the command line. |
371 | 1232 | 1201 | ||
372 | 1233 | Finally, the | 1202 | Finally, the |
373 | 1234 | .B --include-regexp | 1203 | .B --include-regexp |
374 | 1235 | and | 1204 | and |
375 | 1236 | .B --exclude-regexp | 1205 | .B --exclude-regexp |
377 | 1237 | allow files to be included and excluded if their filenames match a | 1206 | options allow files to be included and excluded if their filenames match a |
378 | 1238 | python regular expression. Regular expression syntax is too | 1207 | python regular expression. Regular expression syntax is too |
379 | 1239 | complicated to explain here, but is covered in Python's library | 1208 | complicated to explain here, but is covered in Python's library |
380 | 1240 | reference. Unlike the | 1209 | reference. Unlike the |