Skip to content

Commit

Permalink
update log and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Thomas-Tsai
Thomas-Tsai committed Jun 21, 2024
1 parent 32d7495 commit ed0044d
Show file tree
Hide file tree
Showing 21 changed files with 719 additions and 521 deletions.
56 changes: 56 additions & 0 deletions ChangeLog
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,49 @@
2024-06-21 Thomas Tsai <[email protected]>

Merge pull request #54 from pfrouleau/review/include_NTFS_backup_boot_sector_in_the_image
Include the NTFS Boot Record backup in the cloned image

Merge pull request #55 from pfrouleau/fix/get_exec_name
Fix get_exec_name(): when partclone in installed, there is no '/' in argv0

update git version generate by describe

add option prog_second to display in seconds

2024-06-17 Thomas Tsai <[email protected]>

Merge pull request #249 from TMR5454/vmfs
Add missing return in libvmfs_version().

Merge pull request #248 from TMR5454/master
Fix tiny resource leak.

2024-06-17 Tamura Dai <[email protected]>

Add missing return in libvmfs_version().
libvmfs_version() return without int value.

Add missing return in libvmfs_version().
libvmfs_version() return without int value.

Fix tiny resource leak.

2024-06-14 Thomas Tsai <[email protected]>

Merge branch 'master' of github.com:Thomas-Tsai/partclone

update log and release 0.3.29

Merge pull request #247 from robert-scheck/bash-completion
Prefer bash-completion directory from pkg-config

add option --binary-prefix to display bit size in progress bar

2024-06-14 Robert Scheck <[email protected]>

Prefer bash-completion directory from pkg-config...
...with backwards compatibility for pkg-config < 0.28

2024-06-13 Thomas Tsai <[email protected]>

Merge branch 'master' of github.com:Thomas-Tsai/partclone
Expand Down Expand Up @@ -697,6 +739,20 @@

Update README.md

2021-02-12 Patrick Rouleau <[email protected]>

Fix get_exec_name(): when partclone is installed, there is no '/' in argv0
I forgot to test the case where partclone can be found through PATH and
in that case argv[0] does not contains a slash.

Include the NTFS Boot Record backup in the cloned image
NTFS stores a copy of its Boot Record after the end of the volume, which is
1 block smaller than the partition. This commit updates the NTFS's totalblock
to include that block.

With this change, the md5sum of the restored floppy.raw is identical to
the md5sum of the cloned one.

2021-01-06 Thomas Tsai <[email protected]>

Merge pull request #152 from robert-scheck/c99-for-loop
Expand Down
13 changes: 9 additions & 4 deletions docs/partclone.8
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: PARTCLONE
.\" Author: Yu-Chin Tsai <[email protected]>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/14/2024
.\" Date: 06/21/2024
.\" Manual: Partclone User Manual
.\" Source: partclone
.\" Language: English
.\"
.TH "PARTCLONE" "8" "06/14/2024" "partclone" "Partclone User Manual"
.TH "PARTCLONE" "8" "06/21/2024" "partclone" "Partclone User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -31,7 +31,7 @@
partclone \- The utility for clone and restore a partition\&.
.SH "SYNOPSIS"
.HP \w'\fBpartclone\&.[fstype]\fR\ 'u
\fBpartclone\&.[fstype]\fR {[\fB\-c\fR\ |\ \fB\-\-clone\fR]\ [\fB\-r\fR\ |\ \fB\-\-restore\fR]\ [\fB\-b\fR\ |\ \fB\-\-dev\-to\-dev\fR]} {[\fB\-s\fR\ |\ \fB\-\-source\fR]\ \fIsource\fR} {[[\fB\-o\fR\ |\ \fB\-\-output\fR]\ [\fB\-O\fR\ |\ \fB\-\-overwrite\fR]]\ \fItarget\fR} [[\fB\-dX\fR\ |\ \fB\-\-debug=X\fR]\ [\fB\-\-restore_raw_file\fR]\ [\fB\-z\fR\ |\ \fB\-\-buffer_size\fR]\ [\fB\-N\fR\ |\ \fB\-\-ncurses\fR]\ [\fB\-q\fR\ |\ \fB\-\-quiet\fR]\ [\fB\-f\fR\ |\ \fB\-\-UI\-fresh\fR]\ [\fB\-F\fR\ |\ \fB\-\-force\fR]\ [\fB\-I\fR\ |\ \fB\-\-ignore_fschk\fR]\ [\fB\-i\fR\ |\ \fB\-\-ignore_crc\fR]\ [\fB\-C\fR\ |\ \fB\-\-nocheck\fR]\ [\fB\-R\fR\ |\ \fB\-\-rescue\fR]\ [\fB\-L\fR\ |\ \fB\-\-logfile\fR]\ \fIlogfile\fR\ [\fB\-R\fR\ |\ \fB\-\-rescue\fR]\ [\fB\-L\fR\ |\ \fB\-\-logfile\fR]\ \fIlogfile\fR\ [\fB\-X\fR\ |\ \fB\-\-compresscmd\fR]\ [\fB\-D\fR\ |\ \fB\-\-domain\fR]\ [\fB\-\-offset_domain\fR]\ [\fB\-aX\fR\ |\ \fB\-\-checksum\-mode=X\fR]\ [\fB\-kX\fR\ |\ \fB\-\-blocks\-per\-checksum=X\fR]\ [\fB\-K\fR\ |\ \fB\-\-no\-reseed\fR]\ [\fB\-w\fR\ |\ \fB\-\-skip_write_error\fR]\ [\fB\-E\fR\ |\ \fB\-\-offset=X\fR]\ [\fB\-T\fR\ |\ \fB\-\-btfiles\fR]\ [\fB\-t\fR\ |\ \fB\-\-btfiles_torrent\fR]\ [\fB\-n\fR\ |\ \fB\-\-note\fR]\ [\fB\-B\fR\ |\ \fB\-\-no_block_detail\fR]\ [\fB\-\-binary\-prefix\fR]\ [\fB\-\-write\-direct\-io\fR]\ [\fB\-\-read\-direct\-io\fR]]
\fBpartclone\&.[fstype]\fR {[\fB\-c\fR\ |\ \fB\-\-clone\fR]\ [\fB\-r\fR\ |\ \fB\-\-restore\fR]\ [\fB\-b\fR\ |\ \fB\-\-dev\-to\-dev\fR]} {[\fB\-s\fR\ |\ \fB\-\-source\fR]\ \fIsource\fR} {[[\fB\-o\fR\ |\ \fB\-\-output\fR]\ [\fB\-O\fR\ |\ \fB\-\-overwrite\fR]]\ \fItarget\fR} [[\fB\-dX\fR\ |\ \fB\-\-debug=X\fR]\ [\fB\-\-restore_raw_file\fR]\ [\fB\-z\fR\ |\ \fB\-\-buffer_size\fR]\ [\fB\-N\fR\ |\ \fB\-\-ncurses\fR]\ [\fB\-q\fR\ |\ \fB\-\-quiet\fR]\ [\fB\-f\fR\ |\ \fB\-\-UI\-fresh\fR]\ [\fB\-F\fR\ |\ \fB\-\-force\fR]\ [\fB\-I\fR\ |\ \fB\-\-ignore_fschk\fR]\ [\fB\-i\fR\ |\ \fB\-\-ignore_crc\fR]\ [\fB\-C\fR\ |\ \fB\-\-nocheck\fR]\ [\fB\-R\fR\ |\ \fB\-\-rescue\fR]\ [\fB\-L\fR\ |\ \fB\-\-logfile\fR]\ \fIlogfile\fR\ [\fB\-R\fR\ |\ \fB\-\-rescue\fR]\ [\fB\-L\fR\ |\ \fB\-\-logfile\fR]\ \fIlogfile\fR\ [\fB\-X\fR\ |\ \fB\-\-compresscmd\fR]\ [\fB\-D\fR\ |\ \fB\-\-domain\fR]\ [\fB\-\-offset_domain\fR]\ [\fB\-aX\fR\ |\ \fB\-\-checksum\-mode=X\fR]\ [\fB\-kX\fR\ |\ \fB\-\-blocks\-per\-checksum=X\fR]\ [\fB\-K\fR\ |\ \fB\-\-no\-reseed\fR]\ [\fB\-w\fR\ |\ \fB\-\-skip_write_error\fR]\ [\fB\-E\fR\ |\ \fB\-\-offset=X\fR]\ [\fB\-T\fR\ |\ \fB\-\-btfiles\fR]\ [\fB\-t\fR\ |\ \fB\-\-btfiles_torrent\fR]\ [\fB\-n\fR\ |\ \fB\-\-note\fR]\ [\fB\-B\fR\ |\ \fB\-\-no_block_detail\fR]\ [\fB\-\-binary\-prefix\fR]\ [\fB\-\-prog\-second\fR]\ [\fB\-\-write\-direct\-io\fR]\ [\fB\-\-read\-direct\-io\fR]]
.SH "DESCRIPTION"
.PP
\fBpartclone\fR\&.[fstype] is a part of
Expand Down Expand Up @@ -227,7 +227,12 @@ Show progress message without block detail
.PP
\fB\-\-binary\-prefix\fR
.RS 4
Show progress with bit size
Show progress with bit size (default is MB, GB\&.\&.\&.)
.RE
.PP
\fB\-\-prog\-second\fR
.RS 4
Show progress in seconds (default is minute)
.RE
.PP
\fB\-E\fR, \fB\-\-offset=X\fR
Expand Down
53 changes: 47 additions & 6 deletions docs/partclone.dd.8
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: PARTCLONE.DD
.\" Author: Yu-Chin Tsai <[email protected]>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 10/04/2023
.\" Date: 06/21/2024
.\" Manual: Partclone User Manual
.\" Source: partclone.dd
.\" Language: English
.\"
.TH "PARTCLONE\&.DD" "8" "10/04/2023" "partclone.dd" "Partclone User Manual"
.TH "PARTCLONE\&.DD" "8" "06/21/2024" "partclone.dd" "Partclone User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -31,7 +31,7 @@
partclone.dd \- unsupported file system backup utility\&.(like `dd` )
.SH "SYNOPSIS"
.HP \w'\fBpartclone\&.dd\fR\ 'u
\fBpartclone\&.dd\fR {[\fB\-s\fR\ |\ \fB\-\-source\fR]\ \fIsource\fR} {[[\fB\-o\fR\ |\ \fB\-\-output\fR]\ [\fB\-O\fR\ |\ \fB\-\-overwrite\fR]]\ \fItarget\fR} [[\fB\-dX\fR\ |\ \fB\-\-debug=X\fR]\ [\fB\-\-restore_raw_file\fR]\ [\fB\-z\fR\ |\ \fB\-\-buffer_size\fR]\ [\fB\-N\fR\ |\ \fB\-\-ncurses\fR]\ [\fB\-q\fR\ |\ \fB\-\-quiet\fR]\ [\fB\-f\fR\ |\ \fB\-\-UI\-fresh\fR]\ [\fB\-F\fR\ |\ \fB\-\-force\fR]\ [\fB\-C\fR\ |\ \fB\-\-nocheck\fR]\ [\fB\-R\fR\ |\ \fB\-\-rescue\fR]\ [\fB\-L\fR\ |\ \fB\-\-logfile\fR]\ \fIlogfile\fR\ [\fB\-D\fR\ |\ \fB\-\-domain\fR]\ [\fB\-\-offset_domain\fR]\ [\fB\-w\fR\ |\ \fB\-\-skip_write_error\fR]\ [\fB\-E\fR\ |\ \fB\-\-offset=X\fR]\ [\fB\-T\fR\ |\ \fB\-\-btfiles\fR]\ [\fB\-t\fR\ |\ \fB\-\-btfiles_torrent\fR]\ [\fB\-B\fR\ |\ \fB\-\-no_block_detail\fR]\ [\fB\-\-write\-direct\-io\fR]\ [\fB\-\-read\-direct\-io\fR]]
\fBpartclone\&.dd\fR {[\fB\-s\fR\ |\ \fB\-\-source\fR]\ \fIsource\fR} {[[\fB\-o\fR\ |\ \fB\-\-output\fR]\ [\fB\-O\fR\ |\ \fB\-\-overwrite\fR]]\ \fItarget\fR} [[\fB\-dX\fR\ |\ \fB\-\-debug=X\fR]\ [\fB\-\-restore_raw_file\fR]\ [\fB\-z\fR\ |\ \fB\-\-buffer_size\fR]\ [\fB\-N\fR\ |\ \fB\-\-ncurses\fR]\ [\fB\-q\fR\ |\ \fB\-\-quiet\fR]\ [\fB\-f\fR\ |\ \fB\-\-UI\-fresh\fR]\ [\fB\-F\fR\ |\ \fB\-\-force\fR]\ [\fB\-I\fR\ |\ \fB\-\-ignore_fschk\fR]\ [\fB\-i\fR\ |\ \fB\-\-ignore_crc\fR]\ [\fB\-C\fR\ |\ \fB\-\-nocheck\fR]\ [\fB\-R\fR\ |\ \fB\-\-rescue\fR]\ [\fB\-L\fR\ |\ \fB\-\-logfile\fR]\ \fIlogfile\fR\ [\fB\-R\fR\ |\ \fB\-\-rescue\fR]\ [\fB\-L\fR\ |\ \fB\-\-logfile\fR]\ \fIlogfile\fR\ [\fB\-D\fR\ |\ \fB\-\-domain\fR]\ [\fB\-\-offset_domain\fR]\ [\fB\-aX\fR\ |\ \fB\-\-checksum\-mode=X\fR]\ [\fB\-kX\fR\ |\ \fB\-\-blocks\-per\-checksum=X\fR]\ [\fB\-K\fR\ |\ \fB\-\-no\-reseed\fR]\ [\fB\-w\fR\ |\ \fB\-\-skip_write_error\fR]\ [\fB\-E\fR\ |\ \fB\-\-offset=X\fR]\ [\fB\-T\fR\ |\ \fB\-\-btfiles\fR]\ [\fB\-t\fR\ |\ \fB\-\-btfiles_torrent\fR]\ [\fB\-B\fR\ |\ \fB\-\-no_block_detail\fR]\ [\fB\-\-binary\-prefix\fR]\ [\fB\-\-prog\-second\fR]\ [\fB\-\-write\-direct\-io\fR]\ [\fB\-\-read\-direct\-io\fR]]
.SH "DESCRIPTION"
.PP
\fBpartclone\&.dd\fR
Expand All @@ -47,14 +47,14 @@ The program follows the usual GNU command line syntax, with long options startin
.PP
\fB\-s \fR\fB\fIFILE\fR\fR, \fB\-\-source \fR\fB\fIFILE\fR\fR
.RS 4
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\&.
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\&.
.sp
Receving data from pipe line is supported ONLY for restoring, just ignore \-s option or use \*(Aq\-\*(Aq means receive data from stdin\&.
.RE
.PP
\fB\-o \fR\fB\fIFILE\fR\fR, \fB\-\-output \fR\fB\fIFILE\fR\fR
.RS 4
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\&.
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\&.
.sp
Sending data to pipe line is also supported ONLY for back\-up, just ignore \-o option or use \*(Aq\-\*(Aq means send data to stdout\&.
.RE
Expand All @@ -64,6 +64,11 @@ Sending data to pipe line is also supported ONLY for back\-up, just ignore \-o o
Overwrite FILE, overwriting if exists\&.
.RE
.PP
\fB\-W \fR\fB\fIFILE\fR\fR, \fB\-\-restore_raw_file \fR\fB\fIFILE\fR\fR
.RS 4
create special raw file for loop device\&.
.RE
.PP
\fB\-D\fR, \fB\-\-domain\fR
.RS 4
Create GNU Ddrescue domain log file from source device\&. This is a human readable file in which + marks used block areas and ? marks free areas\&.
Expand All @@ -81,7 +86,7 @@ Creating special raw file for loop device\&.
.PP
\fB\-L \fR\fB\fIFILE\fR\fR, \fB\-\-logfile \fR\fB\fIFILE\fR\fR
.RS 4
put special path to record partclone log information\&.(default /var/log/partclone\&.log)
put special path to record partclone log information\&. (default /var/log/partclone\&.log)
.RE
.PP
\fB\-R\fR, \fB\-\-rescue\fR
Expand All @@ -99,6 +104,16 @@ Don\*(Aqt check device size and free space\&.
Using Ncurses Text User Interface\&.
.RE
.PP
\fB\-I\fR, \fB\-\-ignore_fschk\fR
.RS 4
Ignore filesystem check\&.
.RE
.PP
\fB\-i\fR, \fB\-\-ignore_crc\fR
.RS 4
Ignore crc check error\&.
.RE
.PP
\fB\-F\fR, \fB\-\-force\fR
.RS 4
Force progress\&.
Expand All @@ -124,6 +139,22 @@ Disable progress message\&.
Set the debug level [1|2|3]
.RE
.PP
\fB\-aX\fR, \fB\-\-checksum\-mode=X\fR
.RS 4
Checksum formula to use to add error detection
.sp
where X:
.sp
0: No checksum (no slowdown, smallest image)
.sp
1: CRC32 (Fast to compute, basic detection)
.RE
.PP
\fB\-kX\fR, \fB\-\-blocks\-per\-checksum=X\fR
.RS 4
Write one checksum for every X blocks
.RE
.PP
\fB\-w\fR, \fB\-\-skip_write_error\fR
.RS 4
Continue restore while write errors
Expand All @@ -144,6 +175,16 @@ Reading data from SOURCE partition without cache
Show progress message without block detail
.RE
.PP
\fB\-\-binary\-prefix\fR
.RS 4
Show progress with bit size (default is MB, GB\&.\&.\&.)
.RE
.PP
\fB\-\-prog\-second\fR
.RS 4
Show progress in seconds (default is minute)
.RE
.PP
\fB\-E\fR, \fB\-\-offset=X\fR
.RS 4
Add offset X (bytes) to OUTPUT
Expand Down
Loading

0 comments on commit ed0044d

Please sign in to comment.