| blob | 5adc8fed43af77ff1dd28a3b789c4f26199707ae |
1 '\" te
2 .\" Copyright 1989 AT&T Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH INSTALLF 1M "Oct 30, 2007"
7 .SH NAME
8 installf \- add a file to the software installation database
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBinstallf\fR [\fB-c\fR \fIclass\fR] [ [\fB-M\fR] \fB-R\fR \fIroot_path\fR] [\fB-V\fR \fIfs_file\fR] \fIpkginst\fR \fIpathname\fR
13 [\fIftype\fR [\fImajor\fR \fIminor\fR] [\fImode\fR \fIowner\fR \fIgroup\fR]]
14 .fi
16 .LP
17 .nf
18 \fBinstallf\fR [\fB-c\fR \fIclass\fR] [ [\fB-M\fR] \fB-R\fR \fIroot_path\fR] [\fB-V\fR \fIfs_file\fR] \fIpkginst\fR -
19 .fi
21 .LP
22 .nf
23 \fBinstallf\fR \fB-f\fR [\fB-c\fR \fIclass\fR] [ [\fB-M\fR] \fB-R\fR \fIroot_path\fR] [\fB-V\fR \fIfs_file\fR] \fIpkginst\fR
24 .fi
26 .SH DESCRIPTION
27 .sp
28 .LP
29 \fBinstallf\fR informs the system that a pathname not listed in the
30 \fBpkgmap\fR(4) file is being created or modified. It should be invoked before
31 any file modifications have occurred.
32 .sp
33 .LP
34 When the second synopsis is used, the pathname descriptions will be read from
35 standard input. These descriptions are the same as would be given in the first
36 synopsis but the information is given in the form of a list. The descriptions
37 should be in the form:
38 .sp
39 .LP
40 \fIpathname\fR [ \fIftype\fR [\| \fImajor\fR \fIminor\fR ] [ \fImode\fR
41 \fIowner\fR \fIgroup\fR ]\|]
42 .sp
43 .LP
44 After all files have been appropriately created and/or modified, \fBinstallf\fR
45 should be invoked with the \fB-f\fR synopsis to indicate that installation is
46 final. Links will be created at this time and, if attribute information for a
47 pathname was not specified during the original invocation of \fBinstallf\fR, or
48 was not already stored on the system, the current attribute values for the
49 pathname will be stored. Otherwise, \fBinstallf\fR verifies that attribute
50 values match those given on the command line, making corrections as necessary.
51 In all cases, the current content information is calculated and stored
52 appropriately.
53 .sp
54 .LP
55 Package commands are \fBlargefile\fR(5)-aware. They handle files larger than 2
56 GB in the same way they handle smaller files. In their current implementations,
57 \fBpkgadd\fR(1M), \fBpkgtrans\fR(1) and other package commands can process a
58 datastream of up to 4 GB.
59 .SH OPTIONS
60 .sp
61 .ne 2
62 .na
63 \fB\fB-c\fR \fIclass\fR\fR
64 .ad
65 .RS 16n
66 Class to which installed objects should be associated. Default class is
67 \fBnone\fR.
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fB\fB-f\fR\fR
74 .ad
75 .RS 16n
76 Indicates that installation is complete. This option is used with the final
77 invocation of \fBinstallf\fR (for all files of a given class).
78 .RE
80 .sp
81 .ne 2
82 .na
83 \fB\fB-M\fR\fR
84 .ad
85 .RS 16n
86 Instruct \fBinstallf\fR not to use the \fB$\fR\fIroot_path\fR\fB/etc/vfstab\fR
87 file for determining the client's mount points. This option assumes the mount
88 points are correct on the server and it behaves consistently with Solaris 2.5
89 and earlier releases.
90 .RE
92 .sp
93 .ne 2
94 .na
95 \fB\fB\fR\fB-R\fR \fIroot_path\fR\fR
96 .ad
97 .RS 16n
98 Define the full path name of a directory to use as the \fIroot_path\fR. All
99 files, including package system information files, are relocated to a directory
100 tree starting in the specified \fIroot_path\fR. The \fIroot_path\fR can be
101 specified when installing to a client from a server (for example,
102 \fB/export/root/client1\fR).
103 .sp
104 \fBinstallf\fR inherits the value of the \fBPKG_INSTALL_ROOT\fR environment
105 variable. (See ENVIRONMENT VARIABLES, below.) If \fBPKG_INSTALL_ROOT\fR is set,
106 such as when the \fB-R\fR option is used with \fBpkgadd\fR(1M) or
107 \fBpkgrm\fR(1M), there is no need to use the \fBinstallf\fR \fB-R\fR option.
108 .LP
109 Note -
110 .sp
111 .RS 2
112 The root file system of any non-global zones must not be referenced with the
113 \fB-R\fR option. Doing so might damage the global zone's file system, might
114 compromise the security of the global zone, and might damage the non-global
115 zone's file system. See \fBzones\fR(5).
116 .RE
117 .RE
119 .sp
120 .ne 2
121 .na
122 \fB\fB-V\fR \fIfs_file\fR\fR
123 .ad
124 .RS 16n
125 Specify an alternative \fIfs_file\fR to map the client's file systems. For
126 example, used in situations where the \fB$\fR\fIroot_path\fR\fB/etc/vfstab\fR
127 file is non-existent or unreliable.
128 .RE
130 .SH OPERANDS
131 .sp
132 .ne 2
133 .na
134 \fB\fIpkginst\fR\fR
135 .ad
136 .RS 12n
137 Name of package instance with which the pathname should be associated.
138 .RE
140 .sp
141 .ne 2
142 .na
143 \fB\fIpathname\fR\fR
144 .ad
145 .RS 12n
146 Pathname that is being created or modified.
147 .RE
149 .sp
150 .ne 2
151 .na
152 \fB\fIftype\fR\fR
153 .ad
154 .RS 12n
155 A one-character field that indicates the file type. Possible file types
156 include:
157 .sp
158 .ne 2
159 .na
160 \fB\fBb\fR\fR
161 .ad
162 .RS 5n
163 block special device
164 .RE
166 .sp
167 .ne 2
168 .na
169 \fB\fBc\fR\fR
170 .ad
171 .RS 5n
172 character special device
173 .RE
175 .sp
176 .ne 2
177 .na
178 \fB\fBd\fR\fR
179 .ad
180 .RS 5n
181 directory
182 .RE
184 .sp
185 .ne 2
186 .na
187 \fB\fBe\fR\fR
188 .ad
189 .RS 5n
190 a file to be edited upon installation or removal
191 .RE
193 .sp
194 .ne 2
195 .na
196 \fB\fBf\fR\fR
197 .ad
198 .RS 5n
199 a standard executable or data file
200 .RE
202 .sp
203 .ne 2
204 .na
205 \fB\fBl\fR\fR
206 .ad
207 .RS 5n
208 linked file
209 .RE
211 .sp
212 .ne 2
213 .na
214 \fB\fBp\fR\fR
215 .ad
216 .RS 5n
217 named pipe
218 .RE
220 .sp
221 .ne 2
222 .na
223 \fB\fBs\fR\fR
224 .ad
225 .RS 5n
226 symbolic link
227 .RE
229 .sp
230 .ne 2
231 .na
232 \fB\fBv\fR\fR
233 .ad
234 .RS 5n
235 volatile file (one whose contents are expected to change)
236 .RE
238 .sp
239 .ne 2
240 .na
241 \fB\fBx\fR\fR
242 .ad
243 .RS 5n
244 an exclusive directory
245 .RE
247 .RE
249 .sp
250 .ne 2
251 .na
252 \fB\fImajor\fR\fR
253 .ad
254 .RS 12n
255 The major device number. The field is only specified for block or character
256 special devices.
257 .RE
259 .sp
260 .ne 2
261 .na
262 \fB\fIminor\fR\fR
263 .ad
264 .RS 12n
265 The minor device number. The field is only specified for block or character
266 special devices.
267 .RE
269 .sp
270 .ne 2
271 .na
272 \fB\fImode\fR\fR
273 .ad
274 .RS 12n
275 The octal mode of the file (for example, 0664). A question mark (\fB?\fR)
276 indicates that the mode will be left unchanged, implying that the file already
277 exists on the target machine. This field is not used for linked or symbolically
278 linked files.
279 .RE
281 .sp
282 .ne 2
283 .na
284 \fB\fIowner\fR\fR
285 .ad
286 .RS 12n
287 The owner of the file (for example, \fBbin\fR or \fBroot\fR). The field is
288 limited to 14 characters in length. A question mark (\fB?\fR) indicates that
289 the owner will be left unchanged, implying that the file already exists on the
290 target machine. This field is not used for linked or symbolically linked files.
291 .RE
293 .sp
294 .ne 2
295 .na
296 \fB\fIgroup\fR\fR
297 .ad
298 .RS 12n
299 The group to which the file belongs (for example, \fBbin\fR or \fBsys\fR). The
300 field is limited to 14 characters in length. A question mark (\fB?\fR)
301 indicates that the group will be left unchanged, implying that the file already
302 exists on the target machine. This field is not used for linked or symbolically
303 linked files.
304 .RE
306 .SH EXAMPLES
307 .LP
308 \fBExample 1 \fRBasic Usage
309 .sp
310 .LP
311 The following example shows the use of \fBinstallf\fR, invoked from an optional
312 pre-install or post-install script:
314 .sp
315 .in +2
316 .nf
317 # create /dev/xt directory
318 # (needs to be done before drvinstall)
319 installf $PKGINST /dev/xt d 755 root sys ||
320 exit 2
321 majno=`/usr/sbin/drvinstall \fB-m\fR /etc/master.d/xt
322 \fB-d\fR $BASEDIR/data/xt.o \fB-v\fR1.0` ||
323 exit 2
324 i=00
325 while [ $i \(milt $limit ]
326 do
327 for j in 0 1 2 3 4 5 6 7
328 do
329 echo /dev/xt$i$j c $majno `expr $i ? 8 + $j`
330 644 root sys |
331 echo /dev/xt$i$j=/dev/xt/$i$j
332 done
333 i=`expr $i + 1`
334 [ $i \(mile 9 ] && i="0$i" #add leading zero
335 done | installf $PKGINST \(mi || exit 2
336 # finalized installation, create links
337 installf \fB-f\fR $PKGINST || exit 2
338 .fi
339 .in -2
340 .sp
342 .SH ENVIRONMENT VARIABLES
343 .sp
344 .LP
345 \fBinstallf\fR inherits the value of the following environment variable. This
346 variable is set when \fBpkgadd\fR(1M) or \fBpkgrm\fR(1M) is invoked with the
347 \fB-R\fR option.
348 .sp
349 .ne 2
350 .na
351 \fB\fBPKG_INSTALL_ROOT\fR\fR
352 .ad
353 .RS 20n
354 If present, defines the full path name of a directory to use as the system's
355 \fBPKG_INSTALL_ROOT\fR path. All product and package information files are then
356 looked for in the directory tree, starting with the specified
357 \fBPKG_INSTALL_ROOT\fR path. If not present, the default system path of \fB/\fR
358 is used.
359 .RE
361 .SH EXIT STATUS
362 .sp
363 .ne 2
364 .na
365 \fB\fB0\fR\fR
366 .ad
367 .RS 6n
368 Successful operation.
369 .RE
371 .sp
372 .ne 2
373 .na
374 \fB\fB>0\fR\fR
375 .ad
376 .RS 6n
377 An error occurred.
378 .RE
380 .SH SEE ALSO
381 .sp
382 .LP
383 \fBpkginfo\fR(1), \fBpkgmk\fR(1), \fBpkgparam\fR(1), \fBpkgproto\fR(1),
384 \fBpkgtrans\fR(1), \fBpkgadd\fR(1M), \fBpkgask\fR(1M), \fBpkgchk\fR(1M),
385 \fBpkgrm\fR(1M), \fBremovef\fR(1M), \fBpkgmap\fR(4), \fBspace\fR(4),
386 \fBattributes\fR(5), \fBlargefile\fR(5)
387 .sp
388 .LP
389 \fI\fR
390 .SH NOTES
391 .sp
392 .LP
393 When \fIftype\fR is specified, all applicable fields, as shown below, must be
394 defined:
395 .sp
397 .sp
398 .TS
399 box;
400 l l
401 l l .
402 \fIftype\fR Required Fields
403 \fBp\fR, \fBx\fR, \fBd\fR, \fBf\fR, \fBv\fR, or \fBe\fR \fBmode owner group\fR
404 \fBc\fR or \fBb\fR \fBmajor minor mode owner group\fR
405 .TE
407 .sp
408 .LP
409 The \fBinstallf\fR command will create directories, named pipes and special
410 devices on the original invocation. Links are created when \fBinstallf\fR is
411 invoked with the \fB-f\fR option to indicate installation is complete.
412 .sp
413 .LP
414 Links should be specified as \fIpath1\fR\fB=\fR\fIpath2.\fR \fIpath1\fR
415 indicates the destination and \fIpath2\fR indicates the source file.
416 .sp
417 .LP
418 Files installed with \fBinstallf\fR will be placed in the class \fBnone\fR,
419 unless a class is defined with the command. Subsequently, they will be removed
420 when the associated package is deleted. If this file should not be deleted at
421 the same time as the package, be certain to assign it to a class which is
422 ignored at removal time. If special action is required for the file before
423 removal, a class must be defined with the command and an appropriate class
424 action script delivered with the package.
425 .sp
426 .LP
427 When classes are used, \fBinstallf\fR must be used in one of the following
428 forms:
429 .sp
430 .in +2
431 .nf
432 installf \fB-c\fR class1 .\|.\|.\|
433 installf \fB-f\fR \fB-c\fR class1 .\|.\|.\|
434 installf \fB-c\fR class2 .\|.\|.\|
435 installf \fB-f\fR \fB-c\fR class2 .\|.\|.\|
436 .fi
437 .in -2
438 .sp