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

Proposed by edso
Status: Merged
Merged at revision: 867
Proposed branch: lp:~ed.so/duplicity/duplicity.manpage
Merge into: lp:duplicity/0.6
Diff against target: 169 lines (+33/-56)
1 file modified
bin/duplicity.1 (+33/-56)
To merge this branch: bzr merge lp:~ed.so/duplicity/duplicity.manpage
Reviewer Review Type Date Requested Status
duplicity-team Pending
Review via email: mp+125757@code.launchpad.net

Description of the change

- disabled hyphenation and block justification for better readablility of command line examples.
- reformatted REQUIREMENTS section for hopefully better online rendering
- minor clarifications

To post a comment you must log in.
866. By ede

missing space

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-03-13 20:53:35 +0000
+++ bin/duplicity.1 2012-09-21 15:55:21 +0000
@@ -1,4 +1,9 @@
1.TH DUPLICITY 1 "$reldate" "Version $version" "User Manuals" \" -*- nroff -*-1.TH DUPLICITY 1 "$reldate" "Version $version" "User Manuals" \" -*- nroff -*-
2.\" disable justification (adjust text to left margin only)
3.\" command line examples stay readable through that
4.ad l
5.\" disable hyphenation
6.nh
27
3.SH NAME8.SH NAME
4duplicity \- Encrypted incremental backup to local or remote storage.9duplicity \- Encrypted incremental backup to local or remote storage.
@@ -10,64 +15,43 @@
10It is best used under GNU/Linux.15It is best used under GNU/Linux.
1116
12Some backends also require additional components (probably available as packages for your specific platform):17Some backends also require additional components (probably available as packages for your specific platform):
13.IP * 218.TP
14.B "boto backend"19.BR "boto backend" " (S3 Amazon Web Services)"
15(S3 Amazon Web Services)
16.RS
17.IP - 2
18.B boto20.B boto
19- http://github.com/boto/boto21- http://github.com/boto/boto
20.RE22.TP
21.IP * 2
22.B "ftp backend"23.B "ftp backend"
23.RS
24.IP - 2
25.B NcFTP Client24.B NcFTP Client
26- http://www.ncftp.com/25- http://www.ncftp.com/
27.RE26.TP
28.IP * 2
29.B "ftps backend"27.B "ftps backend"
30.RS
31.IP - 2
32.B LFTP Client28.B LFTP Client
33- http://lftp.yar.ru/29- http://lftp.yar.ru/
34.RE30.TP
35.IP * 231.BR "gio backend" " (Gnome VFS API)"
36.B "gio backend"
37(Gnome VFS API)
38.RS
39.IP - 2
40.B PyGObject32.B PyGObject
41- http://live.gnome.org/PyGObject33- http://live.gnome.org/PyGObject
42.IP - 234.br
43.B D-Bus35.B D-Bus
44(dbus)- http://www.freedesktop.org/wiki/Software/dbus36(dbus)- http://www.freedesktop.org/wiki/Software/dbus
45.RE37.PP
46.IP * 238There are two
47.B "ssh backends"39.B ssh backends
48(scp/sftp/ssh see 40for scp/sftp/ssh access (also see
49.B --ssh-backend41.BR --ssh-backend ).
50)42.TP
51.RS43.BR "ssh paramiko backend" " (enabled by default)"
52.IP * 244.B paramiko
53.B ssh paramiko backend45(SSH2 for python)
54(default)46- http://www.lag.net/paramiko/
55.RS47.br
56.IP - 248.B pycrypto
57.B paramiko 49(Python Cryptography Toolkit)
58SSH2 for python - http://www.lag.net/paramiko/50- http://www.dlitz.net/software/pycrypto/
59.IP - 251.TP
60.B pycrypto
61Python Cryptography Toolkit - http://www.dlitz.net/software/pycrypto/
62.RE
63.IP * 2
64.B ssh pexpect backend52.B ssh pexpect backend
65.RS
66.IP - 2
67.B sftp/scp client binaries53.B sftp/scp client binaries
68OpenSSH - http://www.openssh.com/54OpenSSH - http://www.openssh.com/
69.RE
70.RE
7155
72.SH SYNOPSIS56.SH SYNOPSIS
73.B duplicity [full|incremental]57.B duplicity [full|incremental]
@@ -198,24 +182,25 @@
198FTP_PASSWORD=mypassword duplicity /local/dir ftp://user@other.host/some_dir182FTP_PASSWORD=mypassword duplicity /local/dir ftp://user@other.host/some_dir
199183
200.SH ACTIONS184.SH ACTIONS
201Duplicity knows actions, which can be finetuned with options.185Duplicity knows action commands, which can be finetuned with options.
202The actions for backup (full,incr) and restoration (restore) can as well be186The actions for backup (full,incr) and restoration (restore) can as well be
203left out as duplicity detects in what mode it should switch to by the order187left out as duplicity detects in what mode it should switch to by the order
204of target URL and local folder. If the target URL comes before the local folder188of target URL and local folder. If the target URL comes before the local folder
205a restore is in order, is the local folder before target URL then this folder189a restore is in order, is the local folder before target URL then this folder
206is about to be backed up to the target URL.190is about to be backed up to the target URL.
191.br
192If a backup is in order and old signatures can be found duplicity automatically
193performs an incremental backup.
207194
208.TP195.TP
209.B full196.B full
210Perform a full backup. If this is set, a new backup chain is started even if197Perform a full backup. A new backup chain is started even if
211signatures are available for an incremental backup.198signatures are available for an incremental backup.
212199
213.TP200.TP
214.BR incr201.BR incr
215If this is requested an incremental backup will be performed.202If this is requested an incremental backup will be performed.
216Duplicity will abort if old signatures cannot be203Duplicity will abort if no old signatures can be found.
217found. The default is to switch to full backup under these
218conditions.
219204
220.TP205.TP
221.B collection-status206.B collection-status
@@ -756,18 +741,14 @@
756like in this example:741like in this example:
757.RS742.RS
758.PP743.PP
759.ad l
760duplicity --ssh-options="-oProtocol=2 -oIdentityFile=/my/backup/id" /home/me scp://uid@other.host/some_dir744duplicity --ssh-options="-oProtocol=2 -oIdentityFile=/my/backup/id" /home/me scp://uid@other.host/some_dir
761.TP745.TP
762.B NOTE:746.B NOTE:
763.I ssh paramiko backend747.I ssh paramiko backend
764currently supports only the748currently supports only the
765.nh
766.B -oIdentityFile749.B -oIdentityFile
767.hy
768setting.750setting.
769.RE751.RE
770.ad n
771752
772.TP753.TP
773.BI "--tempdir " directory754.BI "--tempdir " directory
@@ -1300,18 +1281,14 @@
1300scp or sftp.1281scp or sftp.
1301To make it even more confusing the user can choose between two ssh backends 1282To make it even more confusing the user can choose between two ssh backends
1302see1283see
1303.nh
1304.B --ssh\-backend1284.B --ssh\-backend
1305.hy
1306for details.1285for details.
1307.PP1286.PP
1308.BR "SSH paramiko backend " "(selected by default)"1287.BR "SSH paramiko backend " "(selected by default)"
1309is complete reimplementation of ssh protocols natively in python. Advantages 1288is complete reimplementation of ssh protocols natively in python. Advantages
1310are speed and maintainability. Minor disadvantage is that extra packages are 1289are speed and maintainability. Minor disadvantage is that extra packages are
1311needed see1290needed see
1312.nh
1313.B REQUIREMENTS1291.B REQUIREMENTS
1314.hy
1315above. In1292above. In
1316.I sftp1293.I sftp
1317(default) mode all operations are done via the according sftp commands. In1294(default) mode all operations are done via the according sftp commands. In

Subscribers

People subscribed via source and target branches

to all changes: