Wiki code for Recommended Installation Locations for Solaris-compatible Software Components

Hide Line numbers
1: ||**Table of Contents**|**Overview**|**BestPractice Synopsis**
2: |
3: [[Applicability>>#Applicability]]
4: [[Background>>#Background]]
5: [[Policy>>#Policy]]
6: [[Exemptions>>#Exemptions]]
7: [[Appeals>>#Appeals]]
8: [[Interface>>#Interface]]
9: [[CaseHistory>>#CaseHistory]]
10: [[ManPages>>#ManPages]]
11: [[References>>#References]]
12: ||Category|Software
13: |Owner|SAC
14: |Author|PSARC
15: |Changes|PSARC
16: |Authority|SAC
17: |Policy Version|1.2
18: |Status|Approved March 23, 1999
19: |Last Reviewed|March, 1999
20: |Effective|Solaris 2.x
21: | This document is a summary of recommendations for installation locations of package objects on Foundation Solaris 2.x.
22: | |
23: ----
24: == Applicability
25: ----
26: == Background
27: ----
28: == BestPractice
29: * **Applies to** All software installed on Solaris
30: * **Authority** SAC
31: * **Approval** PSARC 1998/374 1998/09/30
32: * **Effective** Solaris 2.x
33: * **Policy** This project documents what the ARCs have approved for standard directories in the Solaris Foundation filesystems and what can be found in the System V ABI documentation. It is assumed that the information this project provides will be publically posted (perhaps to enhance the filesystem(5) manpage) and used by the ARCs and SCs in guiding project teams.
34: * **Details** The following table is a summary of recommendations for installation locations of package objects on //Foundation Solaris 2.x//.
35:  The //Installation Location for Bundled Foundation Solaris software// column contains the locations by which Solaris diversity can be delivered either as add-on application software or as add-on system modules.
36: //Platform// in the definitions below refers to the Instruction Set Architecture (ISA) or processor type (uname -p).
37: //Platform-specific// in the definitions below generally refers to the specific hardware implementation (uname -i).
38: // System Software// is defined to be software required for initial installation and/or booting of a system and to provide a sufficient execution environment for additional software.
39: // Add On Software// is all other software not required at initial system installation or boot to provide a fully operational system environment. For additional details on Solaris directory structure and filesystem organization, see filesystem(5).
40: |= Type of File |= Installation Location for
41: |= Bundled Foundation Solaris software|= Add-on system software or applications
42: | Platform dependent [[[1]>>#f1]] modules required for boot. (see kernel(1M)) |/kernel/|/kernel/
43:  (system software only)
44: | SPARC 64-bit
45:  Platform dependent
46:  modules required for boot
47:  [Solaris 2.7 and beyond] |/kernel///subsystem///sparcv9/|/kernel///subsystem///sparcv9/
48:  (system software only)
49: | Intel IA64 64-bit
50:  Platform dependent
51:  modules required for boot
52:  [Solaris future] |/kernel///subsystem///ia64/
53:  (NOTE: "ia64" is an example;
54:  the actual name may be different) |/kernel///subsystem///ia64/ (system software only)
55:  (NOTE: "ia64" is an example;
56:  the actual name may be different)
57: | Platform dependent
58:  configuration files for
59:  the system node and
60:  not shared between
61:  systems |/etc/|/etc/opt/$PKG/
62: | Platform dependent
63:  subsystem configuration
64:  files for the system node
65:  and not shared between
66:  systems |/etc///subsystem///|/etc/opt/$PKG/
67: | non-permanent temporary
68:  files created by the system |/etc/volatile/|/etc/volatile/ (system software only)
69: | Essential executables used
70:  in the booting process and
71:  in manual system recovery.
72:  The full complement of
73:  utilities is available only
74:  after /usr is mounted. |/sbin/|/opt/$PKG/sbin/
75:  Not Applicable since one
76:  cannot assume that /opt
77:  is part of the root
78:  filesystem.
79: | non-permanent (contents
80:  cleared during system
81:  boot) temporary files
82:  created by applications |/tmp/|/tmp/
83: | This directory contains
84:  files installed by
85:  add-on software
86:  application packages | Should not be Applicable |/opt/
87: | system or node specific changing files (logs, databases) |/var/|/var/opt/$PKG/
88: | status log files produced by
89:  software management
90:  functions and/or
91:  applications. E.g., log files
92:  produced for product installation. |/var/sadm/system/logs/|/var/sadm/system/logs/
93: | files that vary in size or
94:  presence during normal
95:  system operations created
96:  by application packages | Not Applicable |/var/opt/
97: | files that vary in size or
98:  presence during normal
99:  system operations created
100:  by applications. Contents
101:  are preserved across the
102:  system boot operation. |/var/tmp/|/var/tmp/
103: | Platform-specific[[[2]>>#f2]] modules required for boot |/platform/`uname -i`/kernel/[[[3]>>#f3]]|/platform/`uname -i`/kernel/
104:  (system software only)
105: | SPARC 64-bit
106:  Platform-specific
107:  modules required for boot
108:  [Solaris 2.7 and beyond] |/platform/`uname -i`/kernel///subsystem///sparcv9/| Not Applicable
109: | Intel IA64 64-bit
110:  Platform dependent
111:  modules required for boot
112:  [Solaris future] |/platform/`uname -i`/kernel///subsystem///ia64/
113:  (NOTE: "ia64" is an example;
114:  the actual name may be different) | Not Applicable
115: | Hardware class specific
116:  modules required for boot |/platform/`uname -m`/kernel/|/platform/`uname -m`/kernel/
117:  (system software only)
118: | Platform-specific shared
119:  objects required for boot |/platform/`uname -i`/lib/|/platform/`uname -i`/lib/
120:  (system software only)
121: | Platform-specific
122:  administrative utilities
123:  required for boot
124: |/platform/`uname -i`/sbin/|/platform/`uname -i`/sbin/
125:  (system software only)
126: | usr platform dependent
127:  loadable modules |/usr/kernel/| Not Applicable
128: | usr platform-specific
129:  modules |/usr/platform/`uname -i`/kernel/|/usr/platform/`uname -i`/kernel/
130:  (system software only)
131: | Platform-specific
132:  daemon and shared
133:  objects |/usr/platform/`uname -i`/lib/|/usr/platform/`uname -i`/lib/
134:  (system software only)
135: | SPARC 64-bit
136:  Platform-specific
137:  daemon and shared
138:  objects
139:  [Solaris 2.7 and beyond] |/usr/platform/`uname -i`/lib/sparcv9/|/usr/platform/`uname -i`/lib/sparcv9/
140:  (system software only)
141: | Intel IA64 64-bit
142:  Platform-specific
143:  daemon and shared
144:  objects
145:  [Solaris future] |/usr/platform/`uname -i`/lib/ia64/ (NOTE: "ia64" is an example;
146:  the actual name may be different) |/usr/platform/`uname -i`/lib/ia64
147:  (system software only)
148:  (NOTE: "ia64" is an example;
149:  the actual name may be different)
150: | Platform-specific System
151:  administration utilities |/usr/platform/`uname -i`/sbin/|/usr/platform/`uname -i`/sbin/
152:  (system software only)
153: | Platform-specific System
154:  (sys, vm) header files |/usr/platform/`uname -i`/include/|/usr/platform/`uname -i`/include/
155:  (system software only)
156: | Platform-specific System
157:  manual pages for
158:  documenting platform-
159:  specific shared objects,
160:  administration utilities,
161:  configuration files,
162:  special files/modules,
163:  and header files |/usr/platform/`uname -i`/[s]man/
164:  /usr/platform/`uname -i`/[s]man/[s]man3x/
165:  /usr/platform/`uname -i`/[s]man/[s]man1m/
166:  /usr/platform/`uname -i`/[s]man/[s]man4/
167:  /usr/platform/`uname -i`/[s]man/[s]man7d/
168:  /usr/platform/`uname -i`/[s]man/[s]man9e/|/usr/platform/`uname -i`/[s]man
169:  (system software only)
170:  platform-specific shared objects
171:  platform-specific utilities
172:  platform-specific file formats
173:  platform-specific special files
174:  platform-specific device headers
175: | Platform dependent
176:  user-invoked executables;
177:  commands expected to be
178:  run users as part of their
179:  normal PATH. |/usr/bin/
180:  All user-level commands should be run out
181:  of this directory. For executable that have to
182:  be different on a 64-bit system than on a
183:  32-bit system, a wrapper that selects the
184:  appropriate executable is placed here.
185:  See isaexec(3C). |/opt/$PKG/bin/
186: | SPARC 64-bit Platform
187:  dependent user-invoked
188:  executables that have to be
189:  different on a 64-bit
190:  system.
191:  [Solaris 2.7 and beyond] |/usr/bin/sparcv9/
192:  see isaexec(3C).
193:  Note that this directory shall not be part
194:  of the user’s PATH, as the user should never
195:  directly invoke an executable in this
196:  directory; rather the identically-named
197:  wrapper in /usr/bin is invoked and
198:  that in turn invokes the executable in this
199:  directory, when appropriate. |/opt/$PKG/bin/sparcv9/
200: | Intel IA64 64-bit Platform
201:  dependent user-invoked
202:  executables that have to be
203:  different on a 64-bit
204:  system.
205:  [Solaris future] |/usr/bin/ia64/
206:  see isaexec(3C)
207:  (NOTE: "ia64" is an example;
208:  the actual name may be different)
209:  Note that this directory shall not be part
210:  of the user’s PATH, as the user should never
211:  directly invoke an executable in this
212:  directory; rather the identically-named
213:  wrapper in /usr/bin is invoked and
214:  that in turn invokes the executable in this
215:  directory, when appropriate. |/opt/$PKG/bin/ia64/
216:  (NOTE: "ia64" is an example;
217:  the actual name may be different)
218: | Platform dependent
219:  subsystem user-invoked
220:  executables; commands
221:  expected to be run users as
222:  part of their normal PATH |/usr/bin///subsystem[[[4]>>#f4]]///
223:  see isaexec(3C). | /opt/$PKG/bin/
224: | SPARC 64-bit Platform
225:  dependent user-invoked
226:  executables that have to be
227:  different on a 64-bit
228:  system.
229:  [Solaris 2.7 and beyond] |/usr/bin///subsystem[[[4]>>#f4]]///sparcv9/
230:  see isaexec(3C)
231:  Note that this directory shall not be part
232:  of the user’s PATH, as the user should never
233:  directly invoke an executable in this
234:  directory; rather the identically-named
235:  wrapper in /usr/bin is invoked and
236:  that in turn invokes the executable in this
237:  directory, when appropriate. |/opt/$PKG/bin/sparcv9/
238: | Intel IA64 64-bit Platform
239:  dependent user-invoked
240:  executables that have to be
241:  different on a 64-bit
242:  system.
243:  [Solaris future] | /usr/bin///subsystem[[[4]>>#f4]]///ia64/
244:  see isaexec(3C)
245:  (NOTE: "ia64" is an example;
246:  the actual name may be different)
247:  Note that this directory shall not be part
248:  of the user’s PATH, as the user should never
249:  directly invoke an executable in this
250:  directory; rather the identically-named
251:  wrapper in /usr/bin is invoked and
252:  that in turn invokes the executable in this
253:  directory, when appropriate | /opt/$PKG/bin/ia64/
254:  (NOTE: "ia64" is an example;
255:  the actual name may be different)
256: | Platform dependent
257:  subsystem user-invoked
258:  executables; commands
259:  expected to be run users as
260:  part of their normal PATH
261: |/usr///subsystem[[[4]>>#f4]]///bin/
262:  see isaexec(3C)|/opt/$PKG/bin/
263: | SPARC 64-bit Platform
264:  dependent user-invoked
265:  executables that have to be
266:  different on a 64-bit
267:  system.
268:  [Solaris 2.7 and beyond] | /usr///subsystem[[[4]>>#f4]]///bin/sparcv9/
269:  see isaexec(3C)
270:  Note that this directory shall not be part
271:  of the user’s PATH, as the user should never
272:  directly invoke an executable in this
273:  directory; rather the identically-named
274:  wrapper in /usr/bin is invoked and
275:  that in turn invokes the executable in this
276:  directory, when appropriate |/opt/$PKG/bin/sparcv9/
277: | Intel IA64 64-bit Platform
278:  dependent user-invoked
279:  executables that have to be
280:  different on a 64-bit
281:  system.
282:  [Solaris future] | /usr///subsystem[[[4]>>#f4]]///bin/ia64/
283:  see isaexec(3C)
284:  (NOTE: "ia64" is an example;
285:  the actual name may be different)
286:  Note that this directory shall not be part
287:  of the user’s PATH, as the user should never
288:  directly invoke an executable in this
289:  directory; rather the identically-named
290:  wrapper in /usr/bin is invoked and
291:  that in turn invokes the executable in this
292:  directory, when appropriate |/opt/$PKG/bin/ia64/
293:  (NOTE: "ia64" is an example;
294:  the actual name may be different)
295: | Platform dependent
296:  libraries, commands,
297:  daemons, never directly
298:  executed by a human |/usr/lib/|/opt/$PKG/lib/
299: | SPARC 64-bit
300:  Platform dependent
301:  libraries, commands,
302:  daemons, never
303:  directly executed by a
304:  human |/usr/lib/sparcv9/|/opt/$PKG/lib/sparcv9/
305: | Intel IA64 64-bit Platform
306:  dependent libraries,
307:  commands, daemons, never
308:  directly executed by a
309:  human |/usr/lib/ia64/
310:  (NOTE: "ia64" is an example;
311:  the actual name may be different) |/opt/$PKG/lib/ia64/
312:  (NOTE: "ia64" is an example;
313:  the actual name may be different)
314: | Platform dependent
315:  subsystem extensions;
316:  libraries, commands,
317:  daemons, never directly
318:  executed by a human | /usr/lib///subsystem[[[4]>>#f4]]/// |/opt/$PKG/lib/
319: | SPARC 64-bit
320:  Platform dependent
321:  libraries, commands,
322:  daemons, never
323:  directly executed by a
324:  human | /usr/lib///subsystem[[[4]>>#f4]]///sparcv9/|/opt/$PKG/lib/sparcv9/
325: | Intel IA64 64-bit Platform
326:  dependent libraries,
327:  commands, daemons, never
328:  directly executed by a
329:  human | /usr/lib///subsystem[[[4]>>#f4]]///ia64/
330:  (NOTE: "ia64" is an example;
331:  the actual name may be different) |/opt/$PKG/lib/ia64/
332:  (NOTE: "ia64" is an example;
333:  the actual name may be different)
334: | Platform dependent
335:  subsystem extensions;
336:  libraries, commands,
337:  daemons, never directly
338:  executed by a human | /usr///subsystem[[[4]>>#f4]]///lib/|/opt/$PKG/lib/
339: | SPARC 64-bit
340:  Platform dependent
341:  libraries, commands,
342:  daemons, never
343:  directly executed by a
344:  human | /usr///subsystem[[[4]>>#f4]]///lib/sparcv9/|/opt/$PKG/lib/sparcv9/
345: | Intel IA64 64-bit Platform
346:  dependent libraries,
347:  commands, daemons, never
348:  directly executed by a
349:  human | /usr///subsystem[[[4]>>#f4]]///lib/ia64/
350:  (NOTE: "ia64" is an example;
351:  the actual name may be
352:  different) |/opt/$PKG/lib/ia64/
353:  (NOTE: "ia64" is an example;
354:  the actual name may be different)
355: | Platform dependent
356:  system administration
357:  utilities expected to be
358:  run only by administrators |/usr/sbin/| /opt/$PKG/sbin/
359: | Platform dependent
360:  system administration
361:  subsystem utilities
362:  expected to be run only
363:  by administrators | /usr/sbin///subsystem[[[4]>>#f4]]///|/opt/$PKG/sbin/
364: | Platform dependent
365:  system administration
366:  subsystem utilities
367:  expected to be run only
368:  by administrators | /usr///subsystem[[[4]>>#f4]]///sbin/|/opt/$PKG/sbin/
369: | platform independent[[[5]>>#f5]]
370:  sharable files | /usr/share/| Not Applicable
371: | platform independent
372:  sharable databases | /usr/share/lib/| Not Applicable
373: | platform independent
374:  sharable manual pages | /usr/share/[s]man/| /opt/$PKG/[s]man/
375: 
376: ----
377: 
378:  1. A //platform dependent// file is one that is installed on all platforms, but whose contents vary depending on the platform in question.
379:  Executable files are the classic // platform dependent// file, but there can also be // platform dependent// shell scripts or configuration files.
380:  One example is ///kernel/genunix//.
381: 
382:   2. A // platform specific// file is one that is only installed on a subset of the supported platforms. // Platform specific// files can be further sub-divided into // platform dependent// and // platform independent//. A // platform specific platform independent// file is one that is only present on some platforms, but is always the same (if it is present).
383:  A // platform specific platform dependent// file is only present on some platforms, and its contents differ on different platforms.
384: 
385:   3. The minimal default kernel search path is
386: ///platform/`uname -i`/kernel:/kernel:/usr/kernel//,
387:  but some systems may have a search path of
388: ///platform/`uname -i`/kernel:/platform/`uname -m`/kernel:/kernel:/usr/kernel//.
389:  See kernel(1M) for details.
390: 
391:   4. There is no recommended convention to use for a given //subsystem//, but a single //subsystem// should not mix conventions of ///usr/*///subsystem//// and ///usr///subsystem///*//.
392: 
393:   5. A //platform independent// file is one that is installed on all platforms, and whose contents are the same on all platforms. Portable shell scripts, standard configuration files, and manual page sources are common examples of // platform independent// files.
394: 
395: ----
396: 
397: == Exemptions
398: 
399: ----
400: 
401: == Appeals
402: 
403: ----
404: 
405: == Interface
406: 
407: |Exported Interface Name |Stability Classification |ARC Case |Comments
408: |filesystem locations|Evolving|PSARC/1998/374|SUN NON-PROPRIETARY INFORMATION
409: 
410: ----
411: 
412: == CaseHistory
413: 
414: |=Case|=Type|=Name
415: |PSARC/1998/374|OnePager| Solaris Platform Installed Object Paths  
416: |LSARC/1992/011|OnePager| Name Changes for SunPro Packages and Install Directory  
417: |PSARC/1992/169|Unknown| /kernel/unix dependencies
418: |PSARC/1992/170|Unknown| /kernel directory layout
419: |PSARC/1992/171|Unknown| userland machine dependencies
420: |PSARC/1993/242|FastTrack| KBI Implementation (Phase 2)  
421: |PSARC/1993/271|OnePager| PKG REORG: Footprint Reduction  
422: |PSARC/1993/321|OnePager| KBI (Kernel Binary Interface)  
423: |PSARC/1993/636|OnePager| SHWP Certified CD install  
424: |PSARC/1993/638|OnePager| SHWP Certified CD /platform support  
425: |PSARC/1994/291|OnePager| KBI Versioning  
426: |PSARC/1994/331|FastTrack| Restructuring /var/sadm  
427: |PSARC/1994/400|FastTrack| Changes to KBI VM interfaces  
428: |PSARC/1994/440|FastTrack| Platform Definition File  
429: |PSARC/1994/441|OnePager| PSMI for PowerPC  
430: |PSARC/1995/028|FastTrack| Maintain Namespace for eeprom(1M)  
431: |PSARC/1995/029|FastTrack| Modified Implementation of Platform Dependent Executables  
432: |PSARC/1995/109|FastTrack| /usr/openwin/platform  
433: |PSARC/1995/422|OnePager| PSMI Extensions  
434: |PSARC/1996/039|OnePager| Solaris Packaging Requirements  
435: |PSARC/1997/310|FastTrack| PSMI Version 1.2  
436: |PSARC/1997/386|FastTrack| Platform Names for Solaris x86  
437: |PSARC/1998/231|FastTrack| New Algorithm for x86 Platform Name  
438: 
439: ----
440: 
441: == ManPages
442: 
443: |=Document|=Description
444: |filesystem.5| 
445: |kernel.1M | 
446: |isaexec.3C | 
447: 
448: ----
449: 
450: == References
451: 
452: |
OpenSolaris

Top Menu

Wiki code for Recommended Installation Locations for Solaris-compatible Software Components

Search

Collectives

Community Group

Project

User Group

Subsites

Community Group arc Pages
