1PARTCLONE(8) Partclone User Manual PARTCLONE(8)
2
6 partclone - The utility for clone and restore a partition.
7
9 partclone.[fstype]
10 {[-c | --clone] [-r | --restore] [-b | --dev-to-dev]}
11 {[-s | --source] source}
12 {[[-o | --output] [-O | --overwrite]] target}
13 [[-dX | --debug=X] [--restore_raw_file] [-z | --buffer_size] [-N | --ncurses] [-q | --quiet] [-f | --UI-fresh] [-F | --force] [-I | --ignore_fschk] [-i | --ignore_crc] [-C | --nocheck] [-R | --rescue] [-L | --logfile] logfile [-R | --rescue] [-L | --logfile] logfile [-X | --compresscmd] [-D | --domain] [--offset_domain] [-aX | --checksum-mode=X] [-kX | --blocks-per-checksum=X] [-K | --no-reseed] [-w | --skip_write_error] [-E | --offset=X] [-T | --btfiles] [-t | --btfiles_torrent] [-n | --note] [-B | --no_block_detail] [--write-direct-io] [--read-direct-io]]
14
16 partclone.[fstype] is a part of Partclone project. Partclone provide
17 utilities to backup used blocks and design for higher compatibility of
18 the file system by using existing library, e.g. e2fslibs is used to
19 read the used block of ext2 partition.
20 Partclone supported file system include btrfs, ext2, ext3, ext4,
22 reiserfs, reiser4, xfs and jfs for LINUX. Also support some non-linux
23 operation system, ex: NTFS, FAT and EXFAT (for Windows), HFS plus
24 (APPLE MAC OS), UFS2 (FreeBSD), VMFS (VMWare Vsphere) and MINIX
25 (MINIX3).
26 All partclone utils could be run like partclone.[fstype] is very
28 smiliar fsck or mkfs. For example, for backup/restore hfsplus, just run
29 partclone.hfsp
30 File System partclone.[fstype]
32 btrfs partclone.btrfs
34 ext2, ext3, ext4 partclone.[ext2 | ext3 | ext4]
35 reiserfs 3.5 partclone.reiserfs
36 reiser 4 partclone.reiser4
37 xfs partclone.xfs
38 ufs | ufs2 partclone.ufs
39 jfs partclone.jfs
40 hfs plusfs partclone.[hfs+ | hfsplus]
41 vmfs partclone.[vmfs | vmfs5]
42 ntfs partclone.ntfs
43 fat12, fat16, fat32 partclone.[fat12 | fat16 | fat32]
44 exfat partclone.exfat
45 minix partclone.minix
46 f2fs partclone.f2fs
47 nilfs2 partclone.nilfs2
48 apfs partclone.apfs
49 others (Not Supported FS) partclone.imager
50
53 The program follows the usual GNU command line syntax, with long
54 options starting with two dashes (`-'). A summary of options is
55 included below.
56 -s FILE, --source FILE
58 Source FILE. The FILE could be a image file (made by partclone) or
59 device depend on your action. Normally, backup source is device,
60 restore source is image file.
61 Receving data from pipe line is supported ONLY for restoring, just
63 ignore -s option or use '-' means receive data from stdin.
64 -o FILE, --output FILE
66 Output FILE. The FILE could be a image file (partclone will
67 generate) or device depend on your action. Normally, backup output
68 to image file and restore output to device.
69 Sending data to pipe line is also supported ONLY for back-up, just
71 ignore -o option or use '-' means send data to stdout.
72 -O FILE, --overwrite FILE
74 Overwrite FILE, overwriting if exists.
75 -c, --clone
77 Save partition to the special image format.
78 -r, --restore
80 Restore partition from the special image format.
81 -b, --dev-to-dev
83 Local device to device copy on-the-fly, source and output both are
84 device.
85 -D, --domain
87 Create GNU Ddrescue domain log file from source device. This is a
88 human readable file in which + marks used block areas and ? marks
89 free areas.
90 --offset_domain=X
92 Add X (in bytes) to all positions reported in the domain log file
93 --restore_raw_file
95 Creating special raw file for loop device.
96 -L FILE, --logfile FILE
98 put special path to record partclone log information. (default
99 /var/log/partclone.log)
100 -R, --rescue
102 Continue after disk read errors.
103 -C, --no_check
105 Don't check device size and free space.
106 -N, --ncurses
108 Using Ncurses Text User Interface.
109 -I, --ignore_fschk
111 Ignore filesystem check.
112 -i, --ignore_crc
114 Ignore crc check error.
115 -F, --force
117 Force progress.
118 -f sec, --UI-fresh sec
120 put special second to different interval.
121 -z size, --buffer_size size
123 Read/write buffer size (default: 1048576)
124 -q, --quiet
126 Disable progress message.
127 -dlevel, --debug level
129 Set the debug level [1|2|3]
130 -x, --compresscmd CMD
132 Start CMD as an output pipe to compress the cloned image
133 -aX, --checksum-mode=X
135 Checksum formula to use to add error detection
136 where X:
138 0: No checksum (no slowdown, smallest image)
140 1: CRC32 (Fast to compute, basic detection)
142 -kX, --blocks-per-checksum=X
144 Write one checksum for every X blocks
145 -w, --skip_write_error
147 Continue restore while write errors
148 --write-direct-io
150 Writing data to TARGET partition without cache
151 --read-direct-io
153 Reading data from SOURCE partition without cache
154 -B, --no_block_detail
156 Show progress message without block detail
157 -E, --offset=X
159 Add offset X (bytes) to OUTPUT
160 -T, --btfiles
162 Restore block as file for ClonezillaBT.
163 -t, --btfiles_torrent
165 Restore block as file for ClonezillaBT but only generate torrent.
166 -n, --note NOTE
168 Display Message Note (128 words).
169 -h, --help
171 Show summary of options.
172 -v, --version
174 Show version of program.
175
177 /var/log/partclone.log
178 The log file of partclone
179
181 clone /dev/hda1 to hda1.img and display debug information.
182 partclone.ext3 -c -d -s /dev/hda1 -o hda1.img
183 restore /dev/hda1 from hda1.img and display debug information.
185 partclone.extfs -r -d -s hda1.img -o /dev/hda1
186 restore image from clonezilla (split, gzip,) with stdin source
188 cat sda1.ext3-ptcl-img.gz.a* | gunzip -c | partclone.ext3 -d -r -s - -o /dev/sda1
189
192 The following diagnostics may be issued on stderr:
193 partclone provides some return codes, that can be used in scripts:
195 Code Diagnostic
197 0 Program exited successfully.
198 1 Clone or Restore seem failed.
200
203 Report bugs to thomas@clonezilla.org or http://partclone.org.
204 You can get support at http://partclone.org
206
208 partclone(8), partclone.chkimg(8), partclone.restore(8),
209 partclone.dd(8), partclone.info(8)
210
212 Yu-Chin Tsai <thomas@clonezilla.org>
213
215 Copyright © 2007 Yu-Chin Tsai
216 This manual page was written for the Debian system (and may be used by
218 others).
219 Permission is granted to copy, distribute and/or modify this document
221 under the terms of the GNU General Public License, Version 2 or (at
222 your option) any later version published by the Free Software
223 Foundation.
224 On Debian systems, the complete text of the GNU General Public License
226 can be found in /usr/share/common-licenses/GPL.
227partclone 10/04/2023 PARTCLONE(8)