.\" 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-SETUP 8"
.TH HCP-SETUP 8 "2023-10-16" "perl v5.8.8" "R1Soft Linux Admin Toolset"
.SH "NAME"
hcp\-setup \- Hot Copy device driver installation utility
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
hcp-setup [\-k \s-1KERNEL_SOURCE_DIR\s0]
.PP
hcp-setup \-\-test
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
R1Soft Hot Copy requires a proprietary R1Soft Linux device driver
to work. R1Soft provides thousands of pre-compiled binary compatible
kernel modules for popular Linux distributions including: \s-1RHE\s0, CentOS,
Fedora, Ubuntu, Debian, Virtuozzo, and OpenVZ.
.PP
The easiest way to install the Hot Copy device driver is to download the
r1soft\-cdp\-kernel\-modules\-`uname \-r`.(rpm or deb) \s-1RPM\s0 or .deb package. These
are available for download at http://www.r1soft.com
.PP
To check if a binary compatible Hot Copy driver is available check for
your system's running kernel's /proc/version (# cat /proc/version) string
at http://www.r1soft.com/distros
.SH "hcp-setup FIRST CHECKS FOR PRE-BUILT BINARY COMPATIBLE DEVICE DRIVER"
.IX Header "hcp-setup FIRST CHECKS FOR PRE-BUILT BINARY COMPATIBLE DEVICE DRIVER"
hcp-setup is used to build a proprietary R1Soft Hot Copy Linux device
driver. hcp-setup will first compute the \s-1MD5\s0 checksum of your running
kernel's /proc/version string:
# echo \-n \*(L"$(cat /proc/version)\*(R"|md5sum)
.PP
It will then look for an existing binary compatible device driver on the
R1Soft download servers. If one exists it will be downloaded. If an
existing binary Hot Copy device driver exactly matching your running
kernel is not available than hcp-setup will attempt to build a new device
driver from source using your system's kernel source or kernel headers.
.SH "BUILDING HOT COPY DRIVER FROM SOURCE hcp-setup will tar up your kernel source tree or headers and upload them to an R1Soft build server over HTTPS using XML\-RPC. Once your system's kernel headers or source have been uploaded the R1Soft build server will compile a Hot Copy device driver as a kernel module and hcp-setup will automatically download it to your system."
.IX Header "BUILDING HOT COPY DRIVER FROM SOURCE hcp-setup will tar up your kernel source tree or headers and upload them to an R1Soft build server over HTTPS using XML-RPC. Once your system's kernel headers or source have been uploaded the R1Soft build server will compile a Hot Copy device driver as a kernel module and hcp-setup will automatically download it to your system."
\&\fBIn order for hcp-setup to work your Linux server must have \s-1HTTPS\s0
Internet access to krnlbld.r1soft.com\fR
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fB\-\-kernel\fR specify location of kernel source or kernel headers (default is /lib/modules/`uname \-r`/build)
.PP
\&\fB\-\-destdir\fR download compiled kernel module to this directory (default is /lib/modules/r1soft)
.PP
\&\fB\-\-test\fR test connection to R1Soft build servers kmod32.r1soft.com, kmod64.r1soft.com
.PP
\&\fB\-\-no\-cache\fR don't get a pre-built binary module, force building from source
.PP
\&\fB\-\-cache\-only\fR Don't compile a module form source check for a matching binary device driver only
.PP
\&\fB\-\-debug\fR print debugging information
.PP
\&\fB\-\-server\fR specify an alternative R1Soft build server
.PP
\&\fB\-\-version\fR print version information about hcp command line utility and hcp device driver
.PP
\&\fB\-\-help\fR print help dialogue
.PP
\&\fB\s-1KERNEL_SOURCE_DIR\s0\fR path to kernel module source or devel header files (default is /lib/modules/`uname \-r`/build)
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Install a Hot Copy device driver
.PP
.Vb 1
\& hcp-setup
.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\fR\|(8), \fIhcp\-device\fR\|(4)
Mini Shell