.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "HCP 8"
.TH HCP 8 "2023-10-16" "perl v5.8.8" "R1Soft Linux Admin Toolset"
.SH "NAME"
hcp \- Hot Copy creates point\-in\-time snapshots of any Linux block device
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
hcp [\-m mount\-point] [\-\-skip\-mount] [\-\-read\-only] [\-c \s-1DEVICE\s0] [\-q \s-1QUOTA\s0] [\s-1DEVICE\s0]
.PP
hcp \-l
.PP
hcp \-r [\s-1DEVICE\s0]
.PP
hcp \-s [\s-1DEVICE\s0]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Hot Copy creates a consistent point-in-time snapshot of a Linux block
device. Hot Copy does not use \s-1LVM\s0. Hot Copy snapshots are readable and
writable. Hot Copy by default uses the free space on the real block
device to store changed blocks.
.SH "COPY-ON-WRITE CHANGED BLOCKS STORAGE"
.IX Header "COPY-ON-WRITE CHANGED BLOCKS STORAGE"
A copy-on-write method is used so Hot Copy uses no space until your real
block device is changed. As writes are made to the real block device Hot
Copy makes a block-level backup copy of blocks before they are
overwritten. The changed blocks are stored in the Hot Copy changed block
storage device. This can be specified with the \fB(\-c)\fR option. By
default changed blocks are stored on the same block device you are taking
a Hot Copy of. To prevent the Hot Copy changed blocks from potentially
filling up your storage device with changed blocks during the
copy-on-write used to maintain the snapshot hcp uses a free space quota.
If the percentage of free space on your changed blocks storage device is
less than or equal to this percentage (default is 5%) then the Hot Copy
will stop working.
.SH "WRITABLE HOT COPIES"
.IX Header "WRITABLE HOT COPIES"
Hot Copies are both readable and writable. When you write to the Hot Copy
as your writes are made changed blocks must be stored and space is
consumed on your changed blocks storage device. If you prefer read-only
snapshots you can specify your Hot Copy be mounted with read-only with the
\&\fB\-o\fR command line option.
.SH "DEVICE DRIVER"
.IX Header "DEVICE DRIVER"
Hot Copy requires a Linux Device Driver, which must be installed.
Pre-built hcp drivers are available for many popular kernels in
\&\s-1RPM\s0 and \s-1APT\s0 packages. The hcp-setup utility can be used to build
hcp device drivers against custom kernels or kernels that
R1Soft does not yet have binary builds for. See \fBhcp-setup\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fB\-m, \-\-mount\-point\fR specify mount point of Hot Copy (default is /var/hotcopy/device)
.PP
\&\fB\-\-skip\-mount\fR do not mount the Hot Copy
.PP
\&\fB\-o, \-\-read\-only\fR mount the Hot Copy read-only
.PP
\&\fB\-c, \-\-changed\-blocks\fR specify an alternate device to store changed blocks
.PP
\&\fB\-l, \-\-list\fR list active Hot Copies
.PP
\&\fB\-r, \-\-remove\fR remove specified Hot Copy device
.PP
\&\fB\-q, \-\-quota\fR specify free space quota for change blocks storage (default is 5%). If your changed blocks storage device has less than or equal to this percentage of free space the Hot Copy will be aborted.
.PP
\&\fB\-s, \-\-show\-hcp\-device\fR print the Hot Copy device (/dev/hcpX) corresponding to the real block device given
.PP
\&\fB\-v, \-\-version\fR print version information about hcp command line utility and hcp device driver
.PP
\&\fB\-h, \-\-help\fR print help dialogue
.PP
\&\fB\s-1DEVICE\s0\fR the block device to make a snapshot of.
.PP
\&\fB\s-1QUOTA\s0\fR integer percentage of free space quota for changed blocks.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Create a new Hot Copy session:
.PP
.Vb 1
\& hcp /dev/sdb1
.Ve
.PP
Remove a Hot Copy session:
.PP
.Vb 1
\& hcp -r /dev/hcp1
.Ve
.PP
List available Hot Copy sessions:
.PP
.Vb 1
\& hcp -l
.Ve
.PP
Create a new Hot Copy session with a specified free space quota for changed blocks of 10%:
.PP
.Vb 1
\& hcp -q 10 /dev/sdb1
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Thank you for using Hot Copy!
.PP
R1Soft makes the only Continuous Data Protection software for Linux.
.PP
Documentation http://wiki.r1soft.com
.PP
Forums http://forum.r1soft.com
.SH "REPORTING BUGS"
.IX Header "REPORTING BUGS"
Report bugs to http://forum.r1soft.com
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2008 Idera, Inc. R1Soft and Idera are divisions
of Idera.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIhcp\-setup\fR\|(8), \fIhcp\-device\fR\|(4)
Mini Shell