man/man1/install.1

   1 .TH INSTALL 1
   2 .SH NAME
   3 install \- install files
   4 .SH SYNOPSIS
   5 .in +5
   6 .ti -5
   7 .B install
   8 .RB [ \-cpsz\fIN\fP "] [" \-l
   9 .IR linktype ]
  10 .RB [ \-o
  11 .IR owner ]
  12 .RB [ \-g
  13 .IR group ]
  14 .RB [ \-m
  15 .IR mode ]
  16 .RB [ \-S
  17 .IR stack ]
  18 .RI [ file1 ]
  19 .I file2
  20 .br
  21 .ti -5
  22 .B install
  23 .RB [ \-cpsz\fIN\fP "] [" \-l
  24 .IR linktype ]
  25 .RB [ \-o
  26 .IR owner ]
  27 .RB [ \-g
  28 .IR group ]
  29 .RB [ \-m
  30 .IR mode ]
  31 .RB [ \-S
  32 .IR stack ]
  33 .IR file " ... " dir
  34 .br
  35 .ti -5
  36 .B install
  37 .RB [ \-c ]
  38 .B \-d
  39 .RB [ \-o
  40 .IR owner ]
  41 .RB [ \-g
  42 .IR group ]
  43 .RB [ \-m
  44 .IR mode ]
  45 .I directory
  46 .in -5
  47 .SH DESCRIPTION
  48 .de SP
  49 .if t .sp 0.4
  50 .if n .sp
  51 ..
  52 .B Install
  53 puts executables, manual pages, and library files in their proper place
  54 in the bin, man, and lib directories.  The first two forms of the
  55 command are like
  56 .BR cp (1)
  57 copying either one file to another or copying several files to a
  58 directory.  The "\fB\-d\fP" form is like
  59 .BR mkdir (1)
  60 with the
  61 .B \-p
  62 flag.
  63 .I File1
  64 may be omitted if neither
  65 .B \-l
  66 nor
  67 .B \-c
  68 is given to change the attributes of
  69 .IR file2 .
  70 .PP
  71 Attributes are always copied from the source file, use the options to change.
  72 Note that the source file's attributes are changed with the destination file
  73 if they are linked.  So copy the file if you change it in a way that makes
  74 it read-only.  You would otherwise not be able to compile a command again.
  75 .SH OPTIONS
  76 .TP
  77 .BI \-l " linktype"
  78 Link the destination to the source file instead of copying it.  This is done
  79 to either save space on a file system with both the source and the bin
  80 directories on it, or to install synonyms to a command. The
  81 .I linktype
  82 argument can either be
  83 .I h
  84 (hard)
  85 or
  86 .I s
  87 (symbolic).
  88 .TP
  89 .B \-c
  90 Copy the source file to its proper place.  This option is the default if
  91 .B \-l
  92 is not given.  With
  93 .BR \-l ,
  94 the file is copied if the link fails. This option is also allowed with
  95 .BR \-d .
  96 In this case the
  97 .BR \-c
  98 is ignored.
  99 .TP
 100 .B \-p
 101 Preserve timestamp on source file or directory.
 102 .TP
 103 .B \-s
 104 Strip the destination file of its symbol table,
 105 .I if
 106 it is an executable, and
 107 .I if
 108 it is actually copied.  It has no effect on a link or a non-executable.
 109 .TP
 110 .B \-z
 111 Compress the executable using
 112 .BR compress (1)
 113 and prepend a header line that calls
 114 .BR zexec (1)
 115 to decompress and execute the binary.  This will on average save 40% disk
 116 space at the expense of a slower startup time.  Like
 117 .B \-s
 118 the file must be actually copied for the flag to have effect.
 119 .TP
 120 .BI \- N
 121 Use
 122 .BI "gzip \-" N
 123 to compress the binary.  You may see up to 60% space savings, but it will
 124 take much longer.
 125 .I N
 126 is a digit from 1 to 9 telling the compression effort, see
 127 .BR gzip (1).
 128 .TP
 129 .B \-d
 130 Make a directory, usually to install files in a separate directory in a
 131 library.  Intermediate directories in the path are created with the same
 132 attributes as the final directory.  Only the attributes of the final
 133 directory are set if the directory exists.
 134 .TP
 135 .BI \-o " owner"
 136 Set the owner of the target.  This only works if the invoker is the
 137 super-user, or if
 138 .B install
 139 is run setuid root and the invoker is a member of group zero.  If
 140 .B \-o
 141 is omitted then the ownership is copied from the source file, or set to
 142 the id of the invoker if a directory is made.
 143 .TP
 144 .BI \-g " group"
 145 Like
 146 .BR \-o ,
 147 but for the group ownership of the target.
 148 .TP
 149 .BI \-m " mode"
 150 .I Mode
 151 is an octal number that specifies the mode the target should get.  The
 152 default is the source file's mode with a
 153 .B chmod a+rX
 154 applied to it, or 755 for a new directory.  Implies
 155 .BR "\-o 0" ,
 156 or
 157 .BR "\-g 0"
 158 if a file is to be set-uid or set-gid and the invoker has permission to
 159 change ownership.  This trick allows a group 0 member to install third party
 160 software, even though it expects to be installed by root.
 161 .TP
 162 .BI \-S " stack"
 163 Sets the maximum amount of heap + stack that an executable may have when
 164 running.  The argument is a C-style decimal, octal or hexadecimal
 165 number, optionally followed by the multipliers
 166 .BR m ,
 167 .BR k ,
 168 .BR w ,
 169 and
 170 .B b
 171 for mega (1024*1024), kilo (1024), "word" (2 or 4), and byte (1).  Uppercase
 172 .B M
 173 is also accepted for those who know what S.I. means.  The compilers use
 174 .B \-S 32kw
 175 by default, that translates to 64kb for an 8086, and 128kb for other
 176 architectures.  This option is ignored on a non-executable.
 177 .SH "SEE ALSO"
 178 .BR ln (1),
 179 .BR cp (1),
 180 .BR strip (1),
 181 .BR compress (1),
 182 .BR gzip (1),
 183 .BR zexec (1),
 184 .BR chown (8),
 185 .BR chgrp (1),
 186 .BR chmod (1),
 187 .BR chmem (1),
 188 .BR mkdir (1).
 189 .SH BUGS
 190 Uppercase
 191 .BR K ,
 192 .BR W ,
 193 and
 194 .B B
 195 are also accepted for those who don't know what S.I. means.
 196 .SH AUTHOR
 197 Kees J. Bot (kjb@cs.vu.nl)