install/install.1

   1 .\"     $NetBSD: install.1,v 1.11 1998/09/28 08:16:15 christos Exp $
   2 .\"
   3 .\" Copyright (c) 1987, 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)install.1   8.1 (Berkeley) 6/6/93
  35 .\"
  36 .Dd June 6, 1993
  37 .Dt INSTALL 1
  38 .Os BSD 4.2
  39 .Sh NAME
  40 .Nm install
  41 .Nd install binaries
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl cps
  45 .Op Fl f Ar flags
  46 .Op Fl m Ar mode
  47 .Op Fl o Ar owner
  48 .Op Fl g Ar group
  49 .Op Fl l Ar linkflags
  50 .Op Fl S Ar stripflag
  51 .Ar file1 file2
  52 .Nm ""
  53 .Op Fl cps
  54 .Op Fl f Ar flags
  55 .Op Fl m Ar mode
  56 .Op Fl o Ar owner
  57 .Op Fl g Ar group
  58 .Op Fl l Ar linkflags
  59 .Op Fl S Ar stripflag
  60 .Ar file1
  61 \&...
  62 .Ar fileN directory
  63 .Nm ""
  64 .Fl pd
  65 .Op Fl m Ar mode
  66 .Op Fl o Ar owner
  67 .Op Fl g Ar group
  68 .Ar directory
  69 \&...
  70 .Sh DESCRIPTION
  71 The file(s) are moved (copied if the
  72 .Fl c
  73 option is specified, or linked if the
  74 .Fl l
  75 option is specified) to the target file or directory.
  76 If the destination is a directory, then the
  77 .Ar file
  78 is moved into
  79 .Ar directory
  80 with its original filename.
  81 If the target file already exists, it is overwritten if permissions
  82 allow.
  83 .Pp
  84 .Bl -tag -width Ds
  85 .It Fl c
  86 Copy the file.
  87 This flag turns off the default behavior of
  88 .Nm
  89 where it deletes the original file after creating the target.
  90 .It Fl f
  91 Specify the target's file flags.
  92 (See
  93 .Xr chflags 1
  94 for a list of possible flags and their meanings.)
  95 .It Fl g
  96 Specify a group.
  97 .It Fl m
  98 Specify an alternative mode.
  99 The default mode is set to rwxr-xr-x (0755).
 100 The specified mode may be either an octal or symbolic value; see
 101 .Xr chmod  1
 102 for a description of possible mode values.
 103 .It Fl l Ar linkflags
 104 Instead of copying the file make a link to the source. The type of the
 105 link is determined by the
 106 .Ar linkflags
 107 argument. Valid
 108 .Ar linkflags
 109 are:
 110 .Ar a
 111 (absolute),
 112 .Ar r
 113 (relative),
 114 .Ar h
 115 (hard),
 116 .Ar s
 117 (symbolic),
 118 .Ar m
 119 (mixed). Absolute and relative have effect only for symbolic links. Mixed links
 120 are hard links for files on the same filesystem, symbolic otherwise.
 121 .It Fl o
 122 Specify an owner.
 123 .It Fl p
 124 Preserve the source files access and modification times.
 125 .It Fl s
 126 .Nm
 127 exec's the command
 128 .Xr strip  1
 129 to strip binaries so that install can be portable over a large
 130 number of systems and binary types.  If the environment variable
 131 .Ev STRIP
 132 is set, it is used as the
 133 .Xr strip 1
 134 program.
 135 .It Fl S Ar stripflags
 136 .Nm
 137 passes
 138 .Ar stripflags
 139 as option arguments to
 140 .Xr strip  1 .
 141 When -S is used,
 142 .Xr strip  1
 143 is invoked via the
 144 .Xr sh  1
 145 shell, allowing a single -S argument be to specified to
 146 .Nm
 147 which the shell can then tokenize. Normally,
 148 .Nm
 149 invokes
 150 .Xr strip  1
 151 directly. This flag implies -s.
 152 .It Fl d
 153 Create directories.
 154 Missing parent directories are created as required.
 155 .El
 156 .Pp
 157 By default,
 158 .Nm
 159 preserves all file flags, with the exception of the ``nodump'' flag.
 160 .Pp
 161 The
 162 .Nm
 163 utility attempts to prevent moving a file onto itself.
 164 .Pp
 165 Installing
 166 .Pa /dev/null
 167 creates an empty file.
 168 .Pp
 169 Upon successful completion a value of 0 is returned.
 170 Otherwise, a value of 1 is returned.
 171 .Sh SEE ALSO
 172 .Xr chflags 1 ,
 173 .Xr chgrp 1 ,
 174 .Xr chmod 1 ,
 175 .Xr cp 1 ,
 176 .Xr mv 1 ,
 177 .Xr strip 1 ,
 178 .Xr chown 8
 179 .Sh HISTORY
 180 The
 181 .Nm
 182 utility appeared in
 183 .Bx 4.2 .