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
1=== modified file 'bin/duplicity.1'
2--- bin/duplicity.1 2012-03-13 20:53:35 +0000
3+++ bin/duplicity.1 2012-09-21 15:55:21 +0000
4@@ -1,4 +1,9 @@
5 .TH DUPLICITY 1 "$reldate" "Version $version" "User Manuals" \" -*- nroff -*-
6+.\" disable justification (adjust text to left margin only)
7+.\" command line examples stay readable through that
8+.ad l
9+.\" disable hyphenation
10+.nh
11
12 .SH NAME
13 duplicity \- Encrypted incremental backup to local or remote storage.
14@@ -10,64 +15,43 @@
15 It is best used under GNU/Linux.
16
17 Some backends also require additional components (probably available as packages for your specific platform):
18-.IP * 2
19-.B "boto backend"
20-(S3 Amazon Web Services)
21-.RS
22-.IP - 2
23+.TP
24+.BR "boto backend" " (S3 Amazon Web Services)"
25 .B boto
26 - http://github.com/boto/boto
27-.RE
28-.IP * 2
29+.TP
30 .B "ftp backend"
31-.RS
32-.IP - 2
33 .B NcFTP Client
34 - http://www.ncftp.com/
35-.RE
36-.IP * 2
37+.TP
38 .B "ftps backend"
39-.RS
40-.IP - 2
41 .B LFTP Client
42 - http://lftp.yar.ru/
43-.RE
44-.IP * 2
45-.B "gio backend"
46-(Gnome VFS API)
47-.RS
48-.IP - 2
49+.TP
50+.BR "gio backend" " (Gnome VFS API)"
51 .B PyGObject
52 - http://live.gnome.org/PyGObject
53-.IP - 2
54+.br
55 .B D-Bus
56 (dbus)- http://www.freedesktop.org/wiki/Software/dbus
57-.RE
58-.IP * 2
59-.B "ssh backends"
60-(scp/sftp/ssh see
61-.B --ssh-backend
62-)
63-.RS
64-.IP * 2
65-.B ssh paramiko backend
66-(default)
67-.RS
68-.IP - 2
69-.B paramiko
70-SSH2 for python - http://www.lag.net/paramiko/
71-.IP - 2
72-.B pycrypto
73-Python Cryptography Toolkit - http://www.dlitz.net/software/pycrypto/
74-.RE
75-.IP * 2
76+.PP
77+There are two
78+.B ssh backends
79+for scp/sftp/ssh access (also see
80+.BR --ssh-backend ).
81+.TP
82+.BR "ssh paramiko backend" " (enabled by default)"
83+.B paramiko
84+(SSH2 for python)
85+- http://www.lag.net/paramiko/
86+.br
87+.B pycrypto
88+(Python Cryptography Toolkit)
89+- http://www.dlitz.net/software/pycrypto/
90+.TP
91 .B ssh pexpect backend
92-.RS
93-.IP - 2
94 .B sftp/scp client binaries
95 OpenSSH - http://www.openssh.com/
96-.RE
97-.RE
98
99 .SH SYNOPSIS
100 .B duplicity [full|incremental]
101@@ -198,24 +182,25 @@
102 FTP_PASSWORD=mypassword duplicity /local/dir ftp://user@other.host/some_dir
103
104 .SH ACTIONS
105-Duplicity knows actions, which can be finetuned with options.
106+Duplicity knows action commands, which can be finetuned with options.
107 The actions for backup (full,incr) and restoration (restore) can as well be
108 left out as duplicity detects in what mode it should switch to by the order
109 of target URL and local folder. If the target URL comes before the local folder
110 a restore is in order, is the local folder before target URL then this folder
111 is about to be backed up to the target URL.
112+.br
113+If a backup is in order and old signatures can be found duplicity automatically
114+performs an incremental backup.
115
116 .TP
117 .B full
118-Perform a full backup. If this is set, a new backup chain is started even if
119+Perform a full backup. A new backup chain is started even if
120 signatures are available for an incremental backup.
121
122 .TP
123 .BR incr
124 If this is requested an incremental backup will be performed.
125-Duplicity will abort if old signatures cannot be
126-found. The default is to switch to full backup under these
127-conditions.
128+Duplicity will abort if no old signatures can be found.
129
130 .TP
131 .B collection-status
132@@ -756,18 +741,14 @@
133 like in this example:
134 .RS
135 .PP
136-.ad l
137 duplicity --ssh-options="-oProtocol=2 -oIdentityFile=/my/backup/id" /home/me scp://uid@other.host/some_dir
138 .TP
139 .B NOTE:
140 .I ssh paramiko backend
141 currently supports only the
142-.nh
143 .B -oIdentityFile
144-.hy
145 setting.
146 .RE
147-.ad n
148
149 .TP
150 .BI "--tempdir " directory
151@@ -1300,18 +1281,14 @@
152 scp or sftp.
153 To make it even more confusing the user can choose between two ssh backends
154 see
155-.nh
156 .B --ssh\-backend
157-.hy
158 for details.
159 .PP
160 .BR "SSH paramiko backend " "(selected by default)"
161 is complete reimplementation of ssh protocols natively in python. Advantages
162 are speed and maintainability. Minor disadvantage is that extra packages are
163 needed see
164-.nh
165 .B REQUIREMENTS
166-.hy
167 above. In
168 .I sftp
169 (default) mode all operations are done via the according sftp commands. In

Subscribers

People subscribed via source and target branches

to all changes: