.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "SHTOOL-INSTALL.TMP 1"
.TH SHTOOL-INSTALL.TMP 1 "shtool 2.0.8" "18-Jul-2008" "GNU Portable Shell Tool"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
shtool\-install \- GNU shtool install(1) command
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBshtool install\fR
[\fB\-v\fR|\fB\-\-verbose\fR]
[\fB\-t\fR|\fB\-\-trace\fR]
[\fB\-d\fR|\fB\-\-mkdir\fR]
[\fB\-c\fR|\fB\-\-copy\fR]
[\fB\-C\fR|\fB\-\-compare\-copy\fR]
[\fB\-s\fR|\fB\-\-strip\fR]
[\fB\-m\fR|\fB\-\-mode\fR \fImode\fR]
[\fB\-o\fR|\fB\-\-owner\fR \fIowner\fR]
[\fB\-g\fR|\fB\-\-group\fR \fIgroup\fR]
[\fB\-e\fR|\fB\-\-exec\fR \fIsed-cmd\fR]
\&\fIfile\fR [\fIfile\fR ...]
\&\fIpath\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This command installs a one or more \fIfile\fRs to a given target \fIpath\fR
providing all important options of the \s-1BSD\s0 \fBinstall\fR\|(1) command.
The trick is that the functionality is provided in a portable way.
.SH "OPTIONS"
.IX Header "OPTIONS"
The following command line options are available.
.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4
.IX Item "-v, --verbose"
Display some processing information.
.IP "\fB\-t\fR, \fB\-\-trace\fR" 4
.IX Item "-t, --trace"
Enable the output of the essential shell commands which are executed.
.IP "\fB\-d\fR, \fB\-\-mkdir\fR" 4
.IX Item "-d, --mkdir"
To maximize \s-1BSD\s0 compatibility, the \s-1BSD "\s0\fBshtool\fR \f(CW\*(C`install \-d\*(C'\fR\*(L" usage is
internally mapped to the \*(R"\fBshtool\fR \f(CW\*(C`mkdir \-f \-p \-m 755\*(C'\fR" command.
.IP "\fB\-c\fR, \fB\-\-copy\fR" 4
.IX Item "-c, --copy"
Copy the \fIfile\fR to the target \fIpath\fR. Default is to move.
.IP "\fB\-C\fR, \fB\-\-compare\-copy\fR" 4
.IX Item "-C, --compare-copy"
Same as \fB\-c\fR except if the destination file already exists and is
identical to the source file, no installation is done and the target
remains untouched.
.IP "\fB\-s\fR, \fB\-\-strip\fR" 4
.IX Item "-s, --strip"
This option strips program executables during the installation, see
\&\fBstrip\fR\|(1). Default is to install verbatim.
.IP "\fB\-m\fR, \fB\-\-mode\fR \fImode\fR" 4
.IX Item "-m, --mode mode"
The file mode applied to the target, see \fBchmod\fR\|(1). Setting mode to
"\f(CW\*(C`\-\*(C'\fR" skips this step and leaves the operating system default which is
usually based on \fBumask\fR\|(1). Some file modes require superuser privileges
to be set. Default is 0755.
.IP "\fB\-o\fR, \fB\-\-owner\fR \fIowner\fR" 4
.IX Item "-o, --owner owner"
The file owner name or id applied to the target, see \fBchown\fR\|(1). This
option requires superuser privileges to execute. Default is to skip this
step and leave the operating system default which is usually based on
the executing uid or the parent setuid directory.
.IP "\fB\-g\fR, \fB\-\-group\fR \fIgroup\fR" 4
.IX Item "-g, --group group"
The file group name or id applied to the target, see \fBchgrp\fR\|(1). This
option requires superuser privileges to execute to the fullest extend,
otherwise the choice of \fIgroup\fR is limited on most operating systems.
Default is to skip this step and leave the operating system default
which is usually based on the executing gid or the parent setgid
directory.
.IP "\fB\-e\fR, \fB\-\-exec\fR \fIsed-cmd\fR" 4
.IX Item "-e, --exec sed-cmd"
This option can be used one or multiple times to apply one or more
\&\fBsed\fR\|(1) commands to the file contents during installation.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 6
\& #   Makefile
\& install:
\&      :
\&     shtool install \-c \-s \-m 4755 foo $(bindir)/
\&     shtool install \-c \-m 644 foo.man $(mandir)/man1/foo.1
\&     shtool install \-c \-m 644 \-e "s/@p@/$prefix/g" foo.conf $(etcdir)/
.Ve
.SH "HISTORY"
.IX Header "HISTORY"
The \fB\s-1GNU\s0 shtool\fR \fBinstall\fR command was originally written by Ralf S.
Engelschall <rse@engelschall.com> in 1997 for \fB\s-1GNU\s0 shtool\fR. It
was prompted by portability issues in the installation procedures of
\&\fB\s-1OSSP\s0\fR libraries.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBshtool\fR\|(1), \fBumask\fR\|(1), \fBchmod\fR\|(1), \fBchown\fR\|(1), \fBchgrp\fR\|(1), \fBstrip\fR\|(1), \fBsed\fR\|(1).