Print this page
10832 system.4 refers to coffexec
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man4/system.4
+++ new/usr/src/man/man4/system.4
1 1 '\" te
2 2 .\" Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
3 3 .\" Copyright 2016 Hans Rosenfeld <rosenfeld@grumpf.hope-2000.org>
4 4 .\" Copyright 2019 OmniOS Community Edition (OmniOSce) Association.
5 +.\" Copyright 2019 Peter Tribble
5 6 .\" Copyright 1989 AT&T
6 7 .\" 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.
7 8 .\" 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.
8 9 .\" 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]
9 -.TH SYSTEM 4 "Jan 29, 2019"
10 +.TH SYSTEM 4 "Apr 20, 2019"
10 11 .SH NAME
11 12 system \- system configuration information file
12 13 .SH DESCRIPTION
13 14 .LP
14 15 The \fBsystem\fR file is used for customizing the operation of the operating
15 16 system kernel. The recommended procedure is to preserve the original
16 17 \fBsystem\fR file before modifying it.
17 18 .sp
18 19 .LP
19 20 It is not recommended to edit the \fB/etc/system\fR file directly but rather
20 21 to deliver configuration fragments into files under \fB/etc/system.d\fR;
21 22 files in this directory are combined in alphabetical order and read by the
22 23 kernel before \fB/etc/system\fR is processed. Directives in \fB/etc/system\fR
23 24 therefore take precedence over any settings delivered in fragment files.
24 25 .sp
25 26 .LP
26 27 The recommended naming schema for the fragment files is to use the name of
27 28 the package which is delivering the file with '\fB/\fR' characters replaced
28 29 by '\fB:\fR'; file names that start with a dot (\fB.\fR) will be ignored.
29 30 .sp
30 31 .LP
31 32 If \fB/etc/system.d/\fR exists and contains any fragment files,
32 33 then the directory must also be writable or it will not be possible to
33 34 create or update the system boot archive.
34 35 .sp
35 36 .LP
36 37 The \fBsystem\fR file contains commands which are read by the kernel during
37 38 initialization and used to customize the operation of your system. These
38 39 commands are useful for modifying the system's treatment of its loadable kernel
39 40 modules.
40 41 .sp
41 42 .LP
42 43 The syntax of the \fBsystem\fR file consists of a list of keyword/value pairs
43 44 which are recognized by the system as valid commands. Comment lines must begin
44 45 with an asterisk (\fB*\fR) or a hash mark (\fB#\fR) and end with a newline
45 46 character. All commands are case-insensitive except where noted.
46 47 .sp
47 48 .LP
48 49 Commands that modify the system's operation with respect to loadable kernel
49 50 modules require you to specify the module type by listing the module's
50 51 namespace. The following namespaces are currently supported on all platforms:
51 52 .sp
52 53 .ne 2
53 54 .na
54 55 \fB\fBdrv\fR\fR
55 56 .ad
56 57 .RS 10n
57 58 Modules in this namespace are device drivers.
58 59 .RE
59 60
60 61 .sp
↓ open down ↓ |
41 lines elided |
↑ open up ↑ |
61 62 .ne 2
62 63 .na
63 64 \fB\fBexec\fR\fR
64 65 .ad
65 66 .RS 10n
66 67 Modules in this namespace are execution format modules. The following
67 68 \fBexec\fR modules are currently provided:
68 69 .sp
69 70 .ne 2
70 71 .na
71 -\fBOnly on SPARC system:\fR
72 +\fBOnly on SPARC systems:\fR
72 73 .ad
73 74 .RS 28n
74 75 .sp
75 76 .in +2
76 77 .nf
77 78 aoutexec
78 79 .fi
79 80 .in -2
80 -.sp
81 -
82 -.RE
83 -
84 -.sp
85 -.ne 2
86 -.na
87 -\fBOnly on x86 system:\fR
88 -.ad
89 -.RS 28n
90 -.sp
91 -.in +2
92 -.nf
93 -coffexec
94 -.fi
95 -.in -2
96 81 .sp
97 82
98 83 .RE
99 84
100 85 .sp
101 86 .ne 2
102 87 .na
103 88 \fBOn SPARC and IA systems:\fR
104 89 .ad
105 90 .RS 28n
106 91 .sp
107 92 .in +2
108 93 .nf
109 94 elfexec
110 95 intpexec
111 96 javaexec
112 97 .fi
113 98 .in -2
114 99 .sp
115 100
116 101 .RE
117 102
118 103 .RE
119 104
120 105 .sp
121 106 .ne 2
122 107 .na
123 108 \fB\fBfirmware\fR\fR
124 109 .ad
125 110 .RS 10n
126 111 Raw firmware images in subdirectories, one for each device driver
127 112 module using \fBfirmload\fR(9F).
128 113 .RE
129 114
130 115 .sp
131 116 .ne 2
132 117 .na
133 118 \fB\fBfs\fR\fR
134 119 .ad
135 120 .RS 10n
136 121 These modules are filesystems.
137 122 .RE
138 123
139 124 .sp
140 125 .ne 2
141 126 .na
142 127 \fB\fBsched\fR\fR
143 128 .ad
144 129 .RS 10n
145 130 These modules implement a process scheduling algorithm.
146 131 .RE
147 132
148 133 .sp
149 134 .ne 2
150 135 .na
151 136 \fB\fBstrmod\fR\fR
152 137 .ad
153 138 .RS 10n
154 139 These modules are \fBSTREAMS\fR modules.
155 140 .RE
156 141
157 142 .sp
158 143 .ne 2
159 144 .na
160 145 \fB\fBsys\fR\fR
161 146 .ad
162 147 .RS 10n
163 148 These modules implement loadable system-call modules.
164 149 .RE
165 150
166 151 .sp
167 152 .ne 2
168 153 .na
169 154 \fB\fBmisc\fR\fR
170 155 .ad
171 156 .RS 10n
172 157 These modules do not fit into any of the above categories, so are considered
173 158 "miscellaneous" modules.
174 159 .RE
175 160
176 161 .sp
177 162 .LP
178 163 SPARC only:
179 164 .sp
180 165 .ne 2
181 166 .na
182 167 \fB\fBdacf\fR\fR
183 168 .ad
184 169 .RS 8n
185 170 These modules provide rules and actions for device auto-configuration.
186 171 .RE
187 172
188 173 .sp
189 174 .ne 2
190 175 .na
191 176 \fB\fBtod\fR\fR
192 177 .ad
193 178 .RS 8n
194 179 These modules provide support for the time of day hardware.
195 180 .RE
196 181
197 182 .sp
198 183 .ne 2
199 184 .na
200 185 \fB\fBcpu\fR\fR
201 186 .ad
202 187 .RS 8n
203 188 These modules provide \fBCPU\fR-specific kernel routines.
204 189 .RE
205 190
206 191 .sp
207 192 .LP
208 193 A description of each of the supported commands follows:
209 194 .sp
210 195 .ne 2
211 196 .na
212 197 \fB\fBexclude:\fR <\fInamespace\fR>/<\fImodulename\fR>\fR
213 198 .ad
214 199 .sp .6
215 200 .RS 4n
216 201 Do not allow the listed loadable kernel module to be loaded. \fBexclude\fR
217 202 commands are cumulative; the list of modules to \fBexclude\fR is created by
218 203 combining every \fBexclude\fR entry in the \fBsystem\fR file.
219 204 .RE
220 205
221 206 .sp
222 207 .ne 2
223 208 .na
224 209 \fB\fBinclude:\fR <\fInamespace\fR>/<\fImodulename\fR>\fR
225 210 .ad
226 211 .sp .6
227 212 .RS 4n
228 213 Include the listed loadable kernel module. This is the system's default, so
229 214 using \fBinclude\fR does not modify the system's operation. \fBinclude\fR
230 215 commands are cumulative.
231 216 .RE
232 217
233 218 .sp
234 219 .ne 2
235 220 .na
236 221 \fB\fBforceload:\fR <\fInamespace\fR>/<\fImodulename\fR>\fR
237 222 .ad
238 223 .sp .6
239 224 .RS 4n
240 225 Force this kernel module to be loaded during kernel initialization. The default
241 226 action is to automatically load the kernel module when its services are first
242 227 accessed. \fBforceload\fR commands are cumulative.
243 228 .RE
244 229
245 230 .sp
246 231 .ne 2
247 232 .na
248 233 \fB\fBrootdev:\fR <\fIdevice name\fR>\fR
249 234 .ad
250 235 .sp .6
251 236 .RS 4n
252 237 Set the root device to the listed value instead of using the default root
253 238 device as supplied by the boot program.
254 239 .RE
255 240
256 241 .sp
257 242 .ne 2
258 243 .na
259 244 \fB\fBrootfs:\fR <\fIroot filesystem type\fR>\fR
260 245 .ad
261 246 .sp .6
262 247 .RS 4n
263 248 Set the root filesystem type to the listed value.
264 249 .RE
265 250
266 251 .sp
267 252 .ne 2
268 253 .na
269 254 \fB\fBmoddir:\fR <\fIfirst module path\fR>[[{:, }<\fIsecond ...\fR>]...]\fR
270 255 .ad
271 256 .sp .6
272 257 .RS 4n
273 258 Set the search path for loadable kernel modules. This command operates very
274 259 much like the \fBPATH\fR shell variable. Multiple directories to search can be
275 260 listed together, delimited either by blank spaces or colons.
276 261 .RE
277 262
278 263 .sp
279 264 .ne 2
280 265 .na
281 266 \fB\fBset\fR [\fI<module>\fR:]\fI<symbol>\fR {=, |, &} [~][-]\fI<value>\fR\fR
282 267 .ad
283 268 .sp .6
284 269 .RS 4n
285 270 Set an integer or character pointer in the kernel or in the selected kernel
286 271 module to a new value. This command is used to change kernel and module
287 272 parameters and thus modify the operation of your system. Assignment operations
288 273 are not cumulative, whereas bitwise \fBAND\fR and \fBOR\fR operations are
289 274 cumulative.
290 275 .sp
291 276 Operations that are supported for modifying integer variables are: simple
292 277 assignment, inclusive bitwise \fBOR,\fR bitwise \fBAND,\fR one's complement,
293 278 and negation. Variables in a specific loadable module can be targeted for
294 279 modification by specifying the variable name prefixed with the kernel module
295 280 name and a colon (:) separator. Values can be specified as hexadecimal (0x10),
296 281 Octal (046), or Decimal (5).
297 282 .sp
298 283 The only operation supported for modifying character pointers is simple
299 284 assignment. Static string data such as character arrays cannot be modified
300 285 using the \fBset\fR command. Use care and ensure that the variable you are
301 286 modifying is in fact a character pointer. The \fBset\fR command is very
302 287 powerful, and will likely cause problems if used carelessly. The following
303 288 escape sequences are supported within the quoted string:
304 289 .sp
305 290 .in +2
306 291 .nf
307 292 \en (newline)
308 293 \et (tab)
309 294 \eb (backspace)
310 295 .fi
311 296 .in -2
312 297 .sp
313 298
314 299 .RE
315 300
316 301 .SH EXAMPLES
317 302 .LP
318 303 \fBExample 1 \fRA sample \fBsystem\fR file.
319 304 .sp
320 305 .LP
321 306 The following is a sample \fBsystem\fR file.
322 307
323 308 .sp
324 309 .in +2
325 310 .nf
326 311 * Force the ELF exec kernel module to be loaded during kernel
327 312 * initialization. Execution type modules are in the exec namespace.
328 313 forceload: exec/elfexec
329 314 * Change the root device to /sbus@1,f8000000/esp@0,800000/sd@3,0:a.
330 315 * You can derive root device names from /devices.
331 316 * Root device names must be the fully expanded Open Boot Prom
332 317 * device name. This command is platform and configuration specific.
333 318 * This example uses the first partition (a) of the SCSI disk at
334 319 * SCSI target 3 on the esp host adapter in slot 0 (on board)
335 320 * of the SBus of the machine.
336 321 * Adapter unit-address 3,0 at sbus unit-address 0,800000.
337 322 rootdev: /sbus@1,f8000000/esp@0,800000/sd@3,0:a
338 323 * Set the filesystem type of the root to ufs. Note that
339 324 * the equal sign can be used instead of the colon.
340 325 rootfs:ufs
341 326 * Set the search path for kernel modules to look first in
342 327 * /usr/phil/mod_test for modules, then in /kernel/modules (the
343 328 * default) if not found. Useful for testing new modules.
344 329 * Note that you can delimit your module pathnames using
345 330 * colons instead of spaces: moddir:/newmodules:/kernel/modules
346 331 moddir:/usr/phil/mod_test /kernel/modules.
347 332 * Set the configuration option {_POSIX_CHOWN_RESTRICTED} :
348 333 * This configuration option is enabled by default.
349 334 set rstchown = 1
350 335 * Disable the configuration option {_POSIX_CHOWN_RESTRICTED} :
351 336 set rstchown = 0
352 337 * Turn on debugging messages in the modules mydriver. This is useful
353 338 * during driver development.
354 339 set mydriver:debug = 1
355 340 * Bitwise AND the kernel variable "moddebug" with the
356 341 * one's complement of the hex value 0x880, and set
357 342 * "moddebug" to this new value.
358 343 set moddebug & ~0x880
359 344 * Demonstrate the cumulative effect of the SET
360 345 * bitwise AND/OR operations by further modifying "moddebug"
361 346 * by ORing it with 0x40.
362 347 set moddebug | 0x40
363 348 .fi
364 349 .in -2
365 350 .sp
366 351
367 352 .SH SEE ALSO
368 353 .LP
369 354 \fBboot\fR(1M), \fBinit\fR(1M), \fBkernel\fR(1M)
370 355 .SH WARNINGS
371 356 .LP
372 357 Use care when modifying the \fBsystem\fR file; it modifies the operation of the
373 358 kernel. If you preserved the original \fBsystem\fR file, you can boot using
374 359 \fBboot -a\fR, which will ask you to specify the path to the saved file. This
375 360 should allow the system to boot correctly. If you cannot locate a \fBsystem\fR
376 361 file that will work, you may specify \fB/dev/null\fR. This acts as an empty
377 362 \fBsystem\fR file, and the system will attempt to boot using its default
378 363 settings.
379 364 .SH NOTES
380 365 .LP
381 366 The \fBsystem\fR files are read only once, at boot time.
↓ open down ↓ |
276 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX