Merge lp:~ed.so/duplicity/manpage into lp:duplicity/0.6

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
Reviewer Review Type Date Requested Status
duplicity-team Pending
Review via email: mp+133811@code.launchpad.net

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
=== modified file 'bin/duplicity.1'
--- bin/duplicity.1 2012-10-17 14:04:27 +0000
+++ bin/duplicity.1 2012-11-11 01:40:25 +0000
@@ -68,50 +68,39 @@
68.SH SYNOPSIS68.SH SYNOPSIS
69.B duplicity [full|incremental]69.B duplicity [full|incremental]
70.I [options]70.I [options]
71.I source_directory target_url71source_directory target_url
7272
73.B duplicity verify73.B duplicity verify
74.I [options]74.I [options] [--file-to-restore <relpath>]
75.I [--file-to-restore <relpath>]75source_url target_directory
76.I source_url target_directory
7776
78.B duplicity collection-status77.B duplicity collection-status
79.I [options]78.I [options]
80.I target_url79target_url
8180
82.B duplicity list-current-files81.B duplicity list-current-files
83.I [options]82.I [options] [--time time]
84.I [--time time]83target_url
85.I target_url
8684
87.B duplicity [restore]85.B duplicity [restore]
88.I [options]86.I [options] [--file-to-restore <relpath>] [--time time]
89.I [--file-to-restore <relpath>]87source_url target_directory
90.I [--time time]88
91.I source_url target_directory89.B duplicity remove-older-than <time>
9290.I [options] [--force]
93.B duplicity remove-older-than91target_url
94.I time92
95.I [options]93.B duplicity remove-all-but-n-full <count>
96.I [--force]94.I [options] [--force]
97.I target_url95target_url
9896
99.B duplicity remove-all-but-n-full97.B duplicity remove-all-inc-of-but-n-full <count>
100.I count98.I [options] [--force]
101.I [options]99target_url
102.I [--force]
103.I target_url
104
105.B duplicity remove-all-inc-of-but-n-full
106.I count
107.I [options]
108.I [--force]
109.I target_url
110100
111.B duplicity cleanup101.B duplicity cleanup
112.I [options]102.I [options] [--force] [--extra-clean]
113.I [--force]103target_url
114.I target_url
115104
116.SH DESCRIPTION105.SH DESCRIPTION
117Duplicity incrementally backs up files and directory106Duplicity incrementally backs up files and directory
@@ -291,7 +280,7 @@
291.TP280.TP
292.BI --allow-source-mismatch281.BI --allow-source-mismatch
293Do not abort on attempts to use the same archive dir or remote backend282Do not abort on attempts to use the same archive dir or remote backend
294to back up different directories. duplicity will tell you if you need283to back up different directories. duplicity will tell you if you need
295this switch.284this switch.
296285
297.TP286.TP
@@ -632,12 +621,9 @@
632.I orig621.I orig
633in the backup as if it were the path622in the backup as if it were the path
634.I new.623.I new.
635Can be passed multiple times. An example:624Can be passed multiple times. An example:
636.PP625
637.RS
638duplicity restore --rename Documents/metal Music/metal sftp://uid@other.host/some_dir /home/me626duplicity restore --rename Documents/metal Music/metal sftp://uid@other.host/some_dir /home/me
639.PP
640.RE
641627
642.TP628.TP
643.BI "--rsync-options " options629.BI "--rsync-options " options
@@ -646,12 +632,9 @@
646list should be of the form "opt1=parm1 opt2=parm2" where the option string is632list should be of the form "opt1=parm1 opt2=parm2" where the option string is
647quoted and the only spaces allowed are between options. The option string633quoted and the only spaces allowed are between options. The option string
648will be passed verbatim to rsync, after any internally generated option634will be passed verbatim to rsync, after any internally generated option
649designating the remote port to use. Here is a possibly useful example:635designating the remote port to use. Here is a possibly useful example:
650.PP636
651.RS
652duplicity --rsync-options="--partial-dir=.rsync-partial" /home/me rsync://uid@other.host/some_dir637duplicity --rsync-options="--partial-dir=.rsync-partial" /home/me rsync://uid@other.host/some_dir
653.PP
654.RE
655638
656.TP639.TP
657.BI "--s3-european-buckets"640.BI "--s3-european-buckets"
@@ -759,10 +742,9 @@
759differs slightly hence the options should therefore be given in the long option format described in742differs slightly hence the options should therefore be given in the long option format described in
760.BR ssh_config(5) ,743.BR ssh_config(5) ,
761like in this example:744like in this example:
762.RS745
763.PP
764duplicity --ssh-options="-oProtocol=2 -oIdentityFile=/my/backup/id" /home/me scp://uid@other.host/some_dir746duplicity --ssh-options="-oProtocol=2 -oIdentityFile=/my/backup/id" /home/me scp://uid@other.host/some_dir
765.TP747
766.B NOTE:748.B NOTE:
767.I ssh paramiko backend749.I ssh paramiko backend
768currently supports only the750currently supports only the
@@ -1000,18 +982,29 @@
1000system. The file selection system comprises a number of file982system. The file selection system comprises a number of file
1001selection conditions, which are set using one of the following command983selection conditions, which are set using one of the following command
1002line options:984line options:
1003.BR --exclude ,985.RS
1004.BR --exclude-device-files ,986--exclude
1005.BR --exclude-filelist ,987.br
1006.BR --exclude-filelist-stdin ,988--exclude-device-files
1007.BR --exclude-globbing-filelist ,989.br
1008.BR --exclude-regexp ,990--exclude-filelist
1009.BR --include ,991.br
1010.BR --include-filelist ,992--exclude-filelist-stdin
1011.BR --include-filelist-stdin ,993.br
1012.BR --include-globbing-filelist ,994--exclude-globbing-filelist
1013and995.br
1014.BR --include-regexp .996--exclude-regexp
997.br
998--include
999.br
1000--include-filelist
1001.br
1002--include-filelist-stdin
1003.br
1004--include-globbing-filelist
1005.br
1006--include-regexp
1007.RE
1015Each file selection condition either matches or doesn't match a given1008Each file selection condition either matches or doesn't match a given
1016file. A given file is excluded by the file selection system exactly1009file. A given file is excluded by the file selection system exactly
1017when the first matching file selection condition specifies that the1010when the first matching file selection condition specifies that the
@@ -1048,15 +1041,15 @@
1048.BR include-globbing-filelist ,1041.BR include-globbing-filelist ,
1049and1042and
1050.B exclude-globbing-filelist1043.B exclude-globbing-filelist
1051options accept1044options accept some
1052.IR "extended shell globbing patterns" .1045.IR "extended shell globbing patterns" .
1053These patterns can contain the special patterns1046These patterns can contain
1054.BR * ,1047.BR * ,
1055.BR ** ,1048.BR ** ,
1056.BR ? ,1049.BR ? ,
1057and1050and
1058.BR [...] .1051.B [...]
1059As in a normal shell,1052(character ranges). As in a normal shell,
1060.B *1053.B *
1061can be expanded to any string of characters not containing "/",1054can be expanded to any string of characters not containing "/",
1062.B ?1055.B ?
@@ -1076,66 +1069,52 @@
1076before duplicity sees them.1069before duplicity sees them.
10771070
1078The1071The
1079.BI "--exclude " pattern1072.B --exclude
1080option matches a file iff:1073pattern option matches a file if:
10811074.IP 1.
1082.TP
1083.B 1.
1084.I pattern1075.I pattern
1085can be expanded into the file's filename, or1076can be expanded into the file's filename, or
10861077.IP 2.
1087.TP
1088.B 2.
1089the file is inside a directory matched by the option.1078the file is inside a directory matched by the option.
1090.PP1079.PP
1091.RE1080Conversely, the
1092Conversely,1081.B "--include "
1093.BI "--include " pattern1082pattern matches a file if:
1094matches a file iff:1083.IP 1.
1095
1096.TP
1097.B 1.
1098.I pattern1084.I pattern
1099can be expanded into the file's filename,1085can be expanded into the file's filename, or
11001086.IP 2.
1101.TP
1102.B 2.
1103the file is inside a directory matched by the option, or1087the file is inside a directory matched by the option, or
11041088.IP 3.
1105.TP
1106.B 3.
1107the file is a directory which contains a file matched by the option.1089the file is a directory which contains a file matched by the option.
1108.PP1090.PP
1109.RE
1110For example,1091For example,
1111.PP1092
1112.RS
1113.B --exclude1093.B --exclude
1114/usr/local1094/usr/local
1115.PP1095
1116.RE1096matches e.g. /usr/local, /usr/local/lib, and /usr/local/lib/netscape. It
1117matches /usr/local, /usr/local/lib, and /usr/local/lib/netscape. It
1118is the same as --exclude /usr/local --exclude '/usr/local/**'.1097is the same as --exclude /usr/local --exclude '/usr/local/**'.
1119.PP1098
1120.RS1099Or
1100.br
1121.B --include1101.B --include
1122/usr/local1102/usr/local
1123.PP1103
1124.RE
1125specifies that /usr, /usr/local, /usr/local/lib, and1104specifies that /usr, /usr/local, /usr/local/lib, and
1126/usr/local/lib/netscape (but not /usr/doc) all be backed up. Thus you1105/usr/local/lib/netscape (but not /usr/doc) all be backed up. Thus you
1127don't have to worry about including parent directories to make sure1106don't have to worry about including parent directories to make sure
1128that included subdirectories have somewhere to go. Finally,1107that included subdirectories have somewhere to go.
1129.PP1108
1130.RS1109Finally,
1110.br
1131.B --include1111.B --include
1132ignorecase:'/usr/[a-z0-9]foo/*/**.py'1112ignorecase:'/usr/[a-z0-9]foo/*/**.py'
1133.PP1113
1134.RE
1135would match a file like /usR/5fOO/hello/there/world.py. If it did1114would match a file like /usR/5fOO/hello/there/world.py. If it did
1136match anything, it would also match /usr. If there is no existing1115match anything, it would also match /usr. If there is no existing
1137file that the given pattern can be expanded into, the option will not1116file that the given pattern can be expanded into, the option will not
1138match /usr.1117match /usr alone.
11391118
1140The1119The
1141.BR --include-filelist ,1120.BR --include-filelist ,
@@ -1151,9 +1130,7 @@
1151interpreted similarly to the way1130interpreted similarly to the way
1152.I extended shell patterns1131.I extended shell patterns
1153are, with a few exceptions:1132are, with a few exceptions:
11541133.IP 1.
1155.TP
1156.B 1.
1157Globbing patterns like1134Globbing patterns like
1158.BR * ,1135.BR * ,
1159.BR ** ,1136.BR ** ,
@@ -1161,40 +1138,33 @@
1161and1138and
1162.B [...]1139.B [...]
1163are not expanded.1140are not expanded.
11641141.IP 2.
1165.TP
1166.B 2.
1167Include patterns do not match files in a directory that is included.1142Include patterns do not match files in a directory that is included.
1168So /usr/local in an include file will not match /usr/local/doc.1143So /usr/local in an include file will not match /usr/local/doc.
11691144.IP 3.
1170.TP
1171.B 3.
1172Lines starting with "+ " are interpreted as include directives, even1145Lines starting with "+ " are interpreted as include directives, even
1173if found in a filelist referenced by1146if found in a filelist referenced by
1174.BR --exclude-filelist .1147.BR --exclude-filelist .
1175Similarly, lines starting with "- " exclude files even if they are1148Similarly, lines starting with "- " exclude files even if they are
1176found within an include filelist.1149found within an include filelist.
11771150.PP
1178.RE
1179For example, if file "list.txt" contains the lines:1151For example, if file "list.txt" contains the lines:
11801152
1181.RS1153.RS
1182/usr/local1154/usr/local
1183.RE1155.br
1184.RS
1185- /usr/local/doc1156- /usr/local/doc
1186.RE1157.br
1187.RS
1188/usr/local/bin1158/usr/local/bin
1189.RE1159.br
1190.RS
1191+ /var1160+ /var
1192.RE1161.br
1193.RS
1194- /var1162- /var
1163.RE
11951164
1196.RE1165then
1197then "--include-filelist list.txt" would include /usr, /usr/local, and1166.B "--include-filelist list.txt"
1167would include /usr, /usr/local, and
1198/usr/local/bin. It would exclude /usr/local/doc,1168/usr/local/bin. It would exclude /usr/local/doc,
1199/usr/local/doc/python, etc. It neither excludes nor includes1169/usr/local/doc/python, etc. It neither excludes nor includes
1200/usr/local/man, leaving the fate of this directory to the next1170/usr/local/man, leaving the fate of this directory to the next
@@ -1215,26 +1185,25 @@
1215allowed). For instance, if the file "globbing-list.txt" contains the1185allowed). For instance, if the file "globbing-list.txt" contains the
1216lines:1186lines:
12171187
1218.RE
1219.RS1188.RS
1220dir/foo1189dir/foo
1221.RE1190.br
1222.RS
1223+ dir/bar1191+ dir/bar
1224.RE1192.br
1225.RS
1226- **1193- **
1194.RE
12271195
1228.RE1196Then
1229Then "--include-globbing-filelist globbing-list.txt" would be exactly1197.B "--include-globbing-filelist globbing-list.txt"
1230the same as specifying "--include dir/foo --include dir/bar --exclude **"1198would be exactly the same as specifying
1199.B "--include dir/foo --include dir/bar --exclude **"
1231on the command line.1200on the command line.
12321201
1233Finally, the1202Finally, the
1234.B --include-regexp1203.B --include-regexp
1235and1204and
1236.B --exclude-regexp1205.B --exclude-regexp
1237allow files to be included and excluded if their filenames match a1206options allow files to be included and excluded if their filenames match a
1238python regular expression. Regular expression syntax is too1207python regular expression. Regular expression syntax is too
1239complicated to explain here, but is covered in Python's library1208complicated to explain here, but is covered in Python's library
1240reference. Unlike the1209reference. Unlike the

Subscribers

People subscribed via source and target branches

to all changes: