1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
|
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!--
`xsltproc -''-nonet \
-''-param man.charmap.use.subset "0" \
-''-param make.year.ranges "1" \
-''-param make.single.year.ranges "1" \
/usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
manpage.xml'
A manual page <package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A typical entry
in a Makefile or Makefile.am is:
DB2MAN = /usr/share/sgml/docbookstylesheet/xsl/docbook-xsl/manpages/docbook.xsl
XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
manpage.1: manpage.xml
$(XP) $(DB2MAN) $<
The xsltproc binary is found in the xsltproc package. The XSL files are in
docbook-xsl. A description of the parameters you can use can be found in the
docbook-xsl-doc-* packages. Please remember that if you create the nroff
version in one of the debian/rules file targets (such as build), you will need
to include xsltproc and docbook-xsl in your Build-Depends control field.
Alternatively use the xmlto command/package. That will also automatically
pull in xsltproc and docbook-xsl.
Notes for using docbook2x: docbook2x-man does not automatically create the
AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
<refsect1> ... </refsect1>.
To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
found in the docbook-xsl-doc-html package.
Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
General documentation about man-pages and man-page-formatting:
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "Yu-Chin">
<!ENTITY dhsurname "Tsai">
<!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
<!ENTITY dhusername "Yu-Chin Tsai">
<!ENTITY dhemail "thomas@clonezilla.org">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1) and
http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
<!ENTITY dhsection "8">
<!-- TITLE should be something like "User commands" or similar (see
http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
<!ENTITY dhtitle "Partclone User Manual">
<!ENTITY dhucpackage "PARTCLONE.RESTORE">
<!ENTITY dhpackage "partclone.restore">
]>
<refentry>
<refentryinfo>
<title>&dhtitle;</title>
<productname>&dhpackage;</productname>
<authorgroup>
<author>
<firstname>&dhfirstname;</firstname>
<surname>&dhsurname;</surname>
<contrib></contrib>
<address>
<email>&dhemail;</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2007</year>
<holder>&dhusername;</holder>
</copyright>
<legalnotice>
<para>This manual page was written for the Debian system
(and may be used by others).</para>
<para>Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General Public License,
Version 2 or (at your option) any later version published by
the Free Software Foundation.</para>
<para>On Debian systems, the complete text of the GNU General Public
License can be found in
<filename>/usr/share/common-licenses/GPL</filename>.</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>&dhucpackage;</refentrytitle>
<manvolnum>&dhsection;</manvolnum>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>restore partclone image to device.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<!-- These are several examples, how syntaxes could look -->
<arg choice="req">
<group choice="opt">
<arg choice="plain"><option>-s</option></arg>
<arg choice="plain"><option>--source</option></arg>
</group>
<replaceable class="option">source</replaceable>
</arg>
<arg choice="req">
<group choice="opt">
<group choice="opt">
<arg choice="plain"><option>-o</option></arg>
<arg choice="plain"><option>--output</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-O</option></arg>
<arg choice="plain"><option>--overwrite</option></arg>
</group>
</group>
<replaceable class="option">target</replaceable>
</arg>
<arg choice="opt">
<group choice="opt">
<arg choice="plain"><option>-dX</option></arg>
<arg choice="plain"><option>--debug=X</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>--restore_raw_file</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-z</option></arg>
<arg choice="plain"><option>--buffer_size</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-N</option></arg>
<arg choice="plain"><option>--ncurses</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-q</option></arg>
<arg choice="plain"><option>--quiet</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-f</option></arg>
<arg choice="plain"><option>--UI-fresh</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-F</option></arg>
<arg choice="plain"><option>--force</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-I</option></arg>
<arg choice="plain"><option>--ignore_fschk</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>--ignore_crc</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-C</option></arg>
<arg choice="plain"><option>--nocheck</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-R</option></arg>
<arg choice="plain"><option>--rescue</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-L</option></arg>
<arg choice="plain"><option>--logfile</option></arg>
</group>
<replaceable class="option">logfile</replaceable>
<group choice="opt">
<arg choice="plain"><option>-w</option></arg>
<arg choice="plain"><option>--skip_write_error</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>--write-direct-io</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-w</option></arg>
<arg choice="plain"><option>--skip_write_error</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-E</option></arg>
<arg choice="plain"><option>--offset=X</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-T</option></arg>
<arg choice="plain"><option>--btfiles</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-t</option></arg>
<arg choice="plain"><option>--btfiles_torrent</option></arg>
</group>
<group choice="opt">
<arg choice="plain"><option>-B</option></arg>
<arg choice="plain"><option>--no_block_detail</option></arg>
</group>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> is a part of <command>Partclone</command> project to restore all image made from partclone.[fstype] or partclone.dd.
Partclone provide utilities to backup used blocks and design for higher compatibility of the file system by using existing library, e.g. e2fslibs is used to read the used block of ext2 partition.</para>
<para><command>Partclone</command> supported file system include btrfs, ext2, ext3, ext4, reiserfs, reiser4, xfs and jfs for LINUX. Also support some non-linux operation system, ex: NTFS, FAT, EXFAT (for Windows), HFS plus (APPLE MAC OS), UFS2 (FreeBSD), VMFS (VMWare Vsphere). All partclone utils could be run like partclone.xxx is very smiliar fsck or mkfs. For example, for backup/restore hfsplus, just run partclone.hfsp.
</para>
</refsect1>
<refsect1 id="options">
<title>OPTIONS</title>
<para>The program follows the usual GNU command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<!-- Use the variablelist.term.separator and the
variablelist.term.break.after parameters to
control the term elements. -->
<varlistentry>
<term><option>-s <replaceable>FILE</replaceable></option></term>
<term><option>--source <replaceable>FILE</replaceable></option></term>
<listitem>
<para>Source FILE. The FILE could be a image file (made by partclone) or device depend on your action. Normally, backup source is device, restore source is image file.</para>
<para>Receving data from pipe line is supported ONLY for restoring, just ignore -s option or use '-' means receive data from stdin.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o <replaceable>FILE</replaceable></option></term>
<term><option>--output <replaceable>FILE</replaceable></option></term>
<listitem>
<para>Output FILE. The FILE could be a image file (partclone will generate) or device depend on your action. Normally, backup output to image file and restore output to device.</para>
<para>Sending data to pipe line is also supported ONLY for back-up, just ignore -o option or use '-' means send data to stdout.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-O <replaceable>FILE</replaceable></option></term>
<term><option>--overwrite <replaceable>FILE</replaceable></option></term>
<listitem>
<para>Overwrite FILE, overwriting if exists.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--restore_raw_file</option></term>
<listitem>
<para>Creating special raw file for loop device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-L <replaceable>FILE</replaceable></option></term>
<term><option>--logfile <replaceable>FILE</replaceable></option></term>
<listitem>
<para>put special path to record partclone log information. (default /var/log/partclone.log)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-R</option></term>
<term><option>--rescue</option></term>
<listitem>
<para>Continue after disk read errors.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-C</option></term>
<term><option>--no_check</option></term>
<listitem>
<para>Don't check device size and free space.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-N</option></term>
<term><option>--ncurses</option></term>
<listitem>
<para>Using Ncurses Text User Interface.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-X</option></term>
<term><option>--dialog</option></term>
<listitem>
<para>Output message as Dialog Format.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-I</option></term>
<term><option>--ignore_fschk</option></term>
<listitem>
<para>Ignore filesystem check.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--ignore_crc</option></term>
<listitem>
<para>Ignore crc check error.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-F</option></term>
<term><option>--force</option></term>
<listitem>
<para>Force progress.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f <replaceable>sec</replaceable></option></term>
<term><option>--UI-fresh <replaceable>sec</replaceable></option></term>
<listitem>
<para>put special second to different interval.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-z <replaceable>size</replaceable></option></term>
<term><option>--buffer_size <replaceable>size</replaceable></option></term>
<listitem>
<para>Read/write buffer size (default: 1048576)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<term><option>--quiet</option></term>
<listitem>
<para>Disable progress message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d<replaceable>level</replaceable></option></term>
<term><option>--debug <replaceable>level</replaceable></option></term>
<listitem>
<para>Set the debug level [1|2|3]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--version</option></term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="files">
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/var/log/partclone.log</filename></term>
<listitem>
<para>The log file of <application>&dhpackage;</application></para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="examples">
<title>EXAMPLES</title>
<screen>
restore /dev/hda1 from hda1.img and display debug information.
partclone.restore -d -s hda1.img -o /dev/hda1
restore image from clonezilla (split, gzip,) with stdin source
cat sda1.ext3-ptcl-img.gz.a* | gunzip -c | partclone.restore -d -s - -o /dev/sda1
restore raw image from partclone.dd
partclone.dd -d -c -s /dev/sda1 -o - | partclone.restore -d -s - -o /dev/sdb1
</screen>
</refsect1>
<refsect1 id="diagnostics">
<title>DIAGNOSTICS</title>
<para>The following diagnostics may be issued
on <filename class="devicefile">stderr</filename>:</para>
<variablelist>
</variablelist>
<para><command>&dhpackage;</command> provides some return codes, that can
be used in scripts:</para>
<segmentedlist>
<segtitle>Code</segtitle>
<segtitle>Diagnostic</segtitle>
<seglistitem>
<seg><errorcode>0</errorcode></seg>
<seg>Program exited successfully.</seg>
</seglistitem>
<seglistitem>
<seg><errorcode>1</errorcode></seg>
<seg>Clone or Restore seem failed.</seg>
</seglistitem>
</segmentedlist>
</refsect1>
<refsect1 id="bugs">
<!-- Or use this section to tell about upstream BTS. -->
<title>BUGS</title>
<para>Report bugs to &dhemail; or <ulink url="http://partclone.org"/>.</para>
<para>You can get support at http://partclone.org</para>
</refsect1>
<refsect1 id="see_also">
<title>SEE ALSO</title>
<!-- In alpabetical order. -->
<para>
<citerefentry>
<refentrytitle>partclone</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>partclone.chkimg</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>partclone.restore</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>partclone.dd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>partclone.info</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
|
