| @@ -1,1635 +1,1641 @@ | | | @@ -1,1635 +1,1641 @@ |
1 | .\" $NetBSD: options.4,v 1.463 2017/02/19 11:16:45 wiz Exp $ | | 1 | .\" $NetBSD: options.4,v 1.464 2017/03/09 00:17:32 chs Exp $ |
2 | .\" | | 2 | .\" |
3 | .\" Copyright (c) 1996 | | 3 | .\" Copyright (c) 1996 |
4 | .\" Perry E. Metzger. All rights reserved. | | 4 | .\" Perry E. Metzger. All rights reserved. |
5 | .\" | | 5 | .\" |
6 | .\" Redistribution and use in source and binary forms, with or without | | 6 | .\" Redistribution and use in source and binary forms, with or without |
7 | .\" modification, are permitted provided that the following conditions | | 7 | .\" modification, are permitted provided that the following conditions |
8 | .\" are met: | | 8 | .\" are met: |
9 | .\" 1. Redistributions of source code must retain the above copyright | | 9 | .\" 1. Redistributions of source code must retain the above copyright |
10 | .\" notice, this list of conditions and the following disclaimer. | | 10 | .\" notice, this list of conditions and the following disclaimer. |
11 | .\" 2. Redistributions in binary form must reproduce the above copyright | | 11 | .\" 2. Redistributions in binary form must reproduce the above copyright |
12 | .\" notice, this list of conditions and the following disclaimer in the | | 12 | .\" notice, this list of conditions and the following disclaimer in the |
13 | .\" documentation and/or other materials provided with the distribution. | | 13 | .\" documentation and/or other materials provided with the distribution. |
14 | .\" 3. All advertising materials mentioning features or use of this software | | 14 | .\" 3. All advertising materials mentioning features or use of this software |
15 | .\" must display the following acknowledgment: | | 15 | .\" must display the following acknowledgment: |
16 | .\" This product includes software developed for the NetBSD Project | | 16 | .\" This product includes software developed for the NetBSD Project |
17 | .\" by Perry E. Metzger. | | 17 | .\" by Perry E. Metzger. |
18 | .\" 4. The name of the author may not be used to endorse or promote products | | 18 | .\" 4. The name of the author may not be used to endorse or promote products |
19 | .\" derived from this software without specific prior written permission. | | 19 | .\" derived from this software without specific prior written permission. |
20 | .\" | | 20 | .\" |
21 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | | 21 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
22 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | | 22 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
23 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | | 23 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
24 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | | 24 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
25 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | | 25 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
26 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | | 26 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
27 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | | 27 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
28 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | | 28 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
29 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | | 29 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
30 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | | 30 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
31 | .\" | | 31 | .\" |
32 | .\" | | 32 | .\" |
33 | .Dd February 19, 2017 | | 33 | .Dd February 19, 2017 |
34 | .Dt OPTIONS 4 | | 34 | .Dt OPTIONS 4 |
35 | .Os | | 35 | .Os |
36 | .Sh NAME | | 36 | .Sh NAME |
37 | .Nm options | | 37 | .Nm options |
38 | .Nd Miscellaneous kernel configuration options | | 38 | .Nd Miscellaneous kernel configuration options |
39 | .Sh SYNOPSIS | | 39 | .Sh SYNOPSIS |
40 | .Cd cinclude ... | | 40 | .Cd cinclude ... |
41 | .Cd config ... | | 41 | .Cd config ... |
42 | .Cd [no] file-system ... | | 42 | .Cd [no] file-system ... |
43 | .Cd ident ... | | 43 | .Cd ident ... |
44 | .Cd include ... | | 44 | .Cd include ... |
45 | .Cd [no] makeoptions ... | | 45 | .Cd [no] makeoptions ... |
46 | .Cd maxusers ... | | 46 | .Cd maxusers ... |
47 | .Cd [no] options ... | | 47 | .Cd [no] options ... |
48 | .Cd [no] pseudo-device ... | | 48 | .Cd [no] pseudo-device ... |
49 | .Sh DESCRIPTION | | 49 | .Sh DESCRIPTION |
50 | This manual page describes a number of miscellaneous kernel | | 50 | This manual page describes a number of miscellaneous kernel |
51 | configuration options that may be specified in a kernel config | | 51 | configuration options that may be specified in a kernel config |
52 | file. | | 52 | file. |
53 | See | | 53 | See |
54 | .Xr config 1 | | 54 | .Xr config 1 |
55 | and | | 55 | and |
56 | .Xr config 5 | | 56 | .Xr config 5 |
57 | for information on how to configure and build kernels. | | 57 | for information on how to configure and build kernels. |
58 | .Pp | | 58 | .Pp |
59 | The | | 59 | The |
60 | .Ar no | | 60 | .Ar no |
61 | form removes a previously specified option. | | 61 | form removes a previously specified option. |
62 | .Ss Keywords | | 62 | .Ss Keywords |
63 | The following keywords are recognized in a kernel configuration file: | | 63 | The following keywords are recognized in a kernel configuration file: |
64 | .Bl -ohang | | 64 | .Bl -ohang |
65 | .It Sy cinclude Qq Ar filename | | 65 | .It Sy cinclude Qq Ar filename |
66 | Conditionally includes another kernel configuration file whose name is | | 66 | Conditionally includes another kernel configuration file whose name is |
67 | .Ar filename , | | 67 | .Ar filename , |
68 | which may be double-quoted and may be an explicit path or relative to | | 68 | which may be double-quoted and may be an explicit path or relative to |
69 | the kernel source directory. | | 69 | the kernel source directory. |
70 | Failure to open the named file is ignored. | | 70 | Failure to open the named file is ignored. |
71 | .It Sy config Ar exec_name No root on Ar rootdev Oo type Ar fstype Oc \ | | 71 | .It Sy config Ar exec_name No root on Ar rootdev Oo type Ar fstype Oc \ |
72 | Oo dumps on Ar dumpdev Oc | | 72 | Oo dumps on Ar dumpdev Oc |
73 | Defines a configuration whose kernel executable is named | | 73 | Defines a configuration whose kernel executable is named |
74 | .Ar exec_name , | | 74 | .Ar exec_name , |
75 | normally | | 75 | normally |
76 | .Dq netbsd , | | 76 | .Dq netbsd , |
77 | with its root file system of type | | 77 | with its root file system of type |
78 | .Ar fstype | | 78 | .Ar fstype |
79 | on the device | | 79 | on the device |
80 | .Ar rootdev , | | 80 | .Ar rootdev , |
81 | and optionally specifying the location of kernel core dumps on the device | | 81 | and optionally specifying the location of kernel core dumps on the device |
82 | .Ar dumpdev . | | 82 | .Ar dumpdev . |
83 | .Ar dev | | 83 | .Ar dev |
84 | or | | 84 | or |
85 | .Ar dumpdev | | 85 | .Ar dumpdev |
86 | and | | 86 | and |
87 | .Ar fstype | | 87 | .Ar fstype |
88 | may be specified as | | 88 | may be specified as |
89 | .Dq \&? , | | 89 | .Dq \&? , |
90 | which is a wild card. | | 90 | which is a wild card. |
91 | The root | | 91 | The root |
92 | .Ar fstype | | 92 | .Ar fstype |
93 | and | | 93 | and |
94 | .Ar dumpdev | | 94 | .Ar dumpdev |
95 | are optional and assumed to be wild carded if they are not specified. | | 95 | are optional and assumed to be wild carded if they are not specified. |
96 | .It Ar device_instance No at Ar attachment \ | | 96 | .It Ar device_instance No at Ar attachment \ |
97 | Oo Ar locators value Oo ... Oc Oc Oo flags Ar value Oc | | 97 | Oo Ar locators value Oo ... Oc Oc Oo flags Ar value Oc |
98 | Define an instance of the device driver | | 98 | Define an instance of the device driver |
99 | .Ar device_instance | | 99 | .Ar device_instance |
100 | that attaches to the bus or device named | | 100 | that attaches to the bus or device named |
101 | .Ar attachment . | | 101 | .Ar attachment . |
102 | An | | 102 | An |
103 | .Ar attachment | | 103 | .Ar attachment |
104 | may require additional information on where the device can be found, such | | 104 | may require additional information on where the device can be found, such |
105 | as an address, channel, function, offset, and/or slot, referred to as | | 105 | as an address, channel, function, offset, and/or slot, referred to as |
106 | .Ar locators , | | 106 | .Ar locators , |
107 | whose | | 107 | whose |
108 | .Ar value | | 108 | .Ar value |
109 | often may be a wild card, | | 109 | often may be a wild card, |
110 | .Dq \&? . | | 110 | .Dq \&? . |
111 | Some device drivers have one or more | | 111 | Some device drivers have one or more |
112 | .Ar flags | | 112 | .Ar flags |
113 | that can be adjusted to affect the way they operate. | | 113 | that can be adjusted to affect the way they operate. |
114 | .It Sy file-system Ar fs_name Op , Ar fs_name Op ... | | 114 | .It Sy file-system Ar fs_name Op , Ar fs_name Op ... |
115 | Include support for the file-system | | 115 | Include support for the file-system |
116 | .Ar fs_name . | | 116 | .Ar fs_name . |
117 | .It Sy ident Qq Ar string | | 117 | .It Sy ident Qq Ar string |
118 | Sets the kernel identification string to | | 118 | Sets the kernel identification string to |
119 | .Ar string . | | 119 | .Ar string . |
120 | .It Sy include Qq Ar filename | | 120 | .It Sy include Qq Ar filename |
121 | Functions the same as | | 121 | Functions the same as |
122 | .Ar cinclude , | | 122 | .Ar cinclude , |
123 | except failure to open | | 123 | except failure to open |
124 | .Ar filename | | 124 | .Ar filename |
125 | produces a fatal error. | | 125 | produces a fatal error. |
126 | .It Sy options Ar option_name Op , Ar option_name=value Op ... | | 126 | .It Sy options Ar option_name Op , Ar option_name=value Op ... |
127 | Specifies (or sets) the option, or comma-separated list of options, | | 127 | Specifies (or sets) the option, or comma-separated list of options, |
128 | .Ar option_name . | | 128 | .Ar option_name . |
129 | Some options expect to be assigned a value, which may be an integer, | | 129 | Some options expect to be assigned a value, which may be an integer, |
130 | a double-quoted word, a bare word, or an empty string | | 130 | a double-quoted word, a bare word, or an empty string |
131 | .Pq Qq . | | 131 | .Pq Qq . |
132 | Note that those are eventually handled by the C compiler, so the rules | | 132 | Note that those are eventually handled by the C compiler, so the rules |
133 | of that language apply. | | 133 | of that language apply. |
134 | .Pp | | 134 | .Pp |
135 | .Em Note : | | 135 | .Em Note : |
136 | Options that are not defined by device definition files are passed to | | 136 | Options that are not defined by device definition files are passed to |
137 | the compile process as | | 137 | the compile process as |
138 | .Fl D | | 138 | .Fl D |
139 | flags to the C compiler. | | 139 | flags to the C compiler. |
140 | .It Sy makeoptions Ar name=value | | 140 | .It Sy makeoptions Ar name=value |
141 | Defines a | | 141 | Defines a |
142 | .Xr make 1 | | 142 | .Xr make 1 |
143 | macro | | 143 | macro |
144 | .Ar name | | 144 | .Ar name |
145 | with the value | | 145 | with the value |
146 | .Ar value | | 146 | .Ar value |
147 | in the kernel Makefile. | | 147 | in the kernel Makefile. |
148 | .It Sy maxusers Ar integer | | 148 | .It Sy maxusers Ar integer |
149 | Set the maxusers variable in the kernel. | | 149 | Set the maxusers variable in the kernel. |
150 | .It Sy no Ar keyword Ar name Op Ar arguments Op ... | | 150 | .It Sy no Ar keyword Ar name Op Ar arguments Op ... |
151 | For the | | 151 | For the |
152 | .Xr config 1 | | 152 | .Xr config 1 |
153 | .Ar keywords | | 153 | .Ar keywords |
154 | file-system, makeoptions, options, and pseudo-device, | | 154 | file-system, makeoptions, options, and pseudo-device, |
155 | .Ar no | | 155 | .Ar no |
156 | removes the file-system, makeoption, options, or pseudo-device, | | 156 | removes the file-system, makeoption, options, or pseudo-device, |
157 | .Ar name . | | 157 | .Ar name . |
158 | This is useful when a kernel configuration file includes another which | | 158 | This is useful when a kernel configuration file includes another which |
159 | has undesired options. | | 159 | has undesired options. |
160 | .Pp | | 160 | .Pp |
161 | For example, a local configuration file that wanted the kitchen sink, but | | 161 | For example, a local configuration file that wanted the kitchen sink, but |
162 | not COMPAT_09 or bridging, might be: | | 162 | not COMPAT_09 or bridging, might be: |
163 | .Bd -literal -offset indent | | 163 | .Bd -literal -offset indent |
164 | include "arch/i386/conf/GENERIC" | | 164 | include "arch/i386/conf/GENERIC" |
165 | no options COMPAT_09 | | 165 | no options COMPAT_09 |
166 | no pseudo-device bridge | | 166 | no pseudo-device bridge |
167 | .Ed | | 167 | .Ed |
168 | .It Sy pseudo-device Ar name Op Ar N | | 168 | .It Sy pseudo-device Ar name Op Ar N |
169 | Includes support for the pseudo-device | | 169 | Includes support for the pseudo-device |
170 | .Ar name . | | 170 | .Ar name . |
171 | Some pseudo-devices can have multiple or | | 171 | Some pseudo-devices can have multiple or |
172 | .Ar N | | 172 | .Ar N |
173 | instances. | | 173 | instances. |
174 | .El | | 174 | .El |
175 | .Ss Compatibility Options | | 175 | .Ss Compatibility Options |
176 | .Bl -ohang | | 176 | .Bl -ohang |
177 | .It Cd options COMPAT_09 | | 177 | .It Cd options COMPAT_09 |
178 | Enable binary compatibility with | | 178 | Enable binary compatibility with |
179 | .Nx 0.9 . | | 179 | .Nx 0.9 . |
180 | This enables support for | | 180 | This enables support for |
181 | 16-bit user, group, and process IDs (following revisions support | | 181 | 16-bit user, group, and process IDs (following revisions support |
182 | 32-bit identifiers). | | 182 | 32-bit identifiers). |
183 | It also allows the use of the deprecated | | 183 | It also allows the use of the deprecated |
184 | .Xr getdomainname 3 , | | 184 | .Xr getdomainname 3 , |
185 | .Xr setdomainname 3 , | | 185 | .Xr setdomainname 3 , |
186 | and | | 186 | and |
187 | .Xr uname 3 | | 187 | .Xr uname 3 |
188 | syscalls. | | 188 | syscalls. |
189 | This option also allows using numeric file system identifiers rather | | 189 | This option also allows using numeric file system identifiers rather |
190 | than strings. | | 190 | than strings. |
191 | Post | | 191 | Post |
192 | .Nx 0.9 | | 192 | .Nx 0.9 |
193 | versions use string identifiers. | | 193 | versions use string identifiers. |
194 | .It Cd options COMPAT_10 | | 194 | .It Cd options COMPAT_10 |
195 | Enable binary compatibility with | | 195 | Enable binary compatibility with |
196 | .Nx 1.0 . | | 196 | .Nx 1.0 . |
197 | This option allows the use of the file system name of | | 197 | This option allows the use of the file system name of |
198 | .Dq ufs | | 198 | .Dq ufs |
199 | as an alias for | | 199 | as an alias for |
200 | .Dq ffs . | | 200 | .Dq ffs . |
201 | The name | | 201 | The name |
202 | .Dq ffs | | 202 | .Dq ffs |
203 | should be used post 1.0 in | | 203 | should be used post 1.0 in |
204 | .Pa /etc/fstab | | 204 | .Pa /etc/fstab |
205 | and other files. | | 205 | and other files. |
206 | It also adds old syscalls for the | | 206 | It also adds old syscalls for the |
207 | .At V | | 207 | .At V |
208 | shared memory interface. | | 208 | shared memory interface. |
209 | This was changed post 1.0 to work on 64-bit architectures. | | 209 | This was changed post 1.0 to work on 64-bit architectures. |
210 | This option also enables | | 210 | This option also enables |
211 | .Dq sgtty | | 211 | .Dq sgtty |
212 | compatibility, without which programs using the old interface produce | | 212 | compatibility, without which programs using the old interface produce |
213 | an | | 213 | an |
214 | .Dq inappropriate ioctl | | 214 | .Dq inappropriate ioctl |
215 | error, and | | 215 | error, and |
216 | .Pa /dev/io | | 216 | .Pa /dev/io |
217 | only works when this option is set in the kernel, | | 217 | only works when this option is set in the kernel, |
218 | see | | 218 | see |
219 | .Xr io 4 | | 219 | .Xr io 4 |
220 | on ports that support it. | | 220 | on ports that support it. |
221 | .It Cd options COMPAT_11 | | 221 | .It Cd options COMPAT_11 |
222 | Enable binary compatibility with | | 222 | Enable binary compatibility with |
223 | .Nx 1.1 . | | 223 | .Nx 1.1 . |
224 | This allows binaries running on the i386 port to gain direct access to | | 224 | This allows binaries running on the i386 port to gain direct access to |
225 | the io ports by opening | | 225 | the io ports by opening |
226 | .Pa /dev/io | | 226 | .Pa /dev/io |
227 | read/write. | | 227 | read/write. |
228 | This functionality was replaced by | | 228 | This functionality was replaced by |
229 | .Xr i386_iopl 2 | | 229 | .Xr i386_iopl 2 |
230 | post 1.1. | | 230 | post 1.1. |
231 | On the | | 231 | On the |
232 | .Tn Atari | | 232 | .Tn Atari |
233 | port, the location of the disk label was moved after 1.1. | | 233 | port, the location of the disk label was moved after 1.1. |
234 | When the | | 234 | When the |
235 | .Em COMPAT_11 | | 235 | .Em COMPAT_11 |
236 | option is set, the kernel will read (pre) 1.1 style disk labels as a | | 236 | option is set, the kernel will read (pre) 1.1 style disk labels as a |
237 | last resort. | | 237 | last resort. |
238 | When a disk label is re-written, the old style label will be replaced | | 238 | When a disk label is re-written, the old style label will be replaced |
239 | with a post 1.1 style label. | | 239 | with a post 1.1 style label. |
240 | This also enables the | | 240 | This also enables the |
241 | .Em EXEC_ELF_NOTELESS | | 241 | .Em EXEC_ELF_NOTELESS |
242 | option. | | 242 | option. |
243 | .It Cd options COMPAT_12 | | 243 | .It Cd options COMPAT_12 |
244 | Enable binary compatibility with | | 244 | Enable binary compatibility with |
245 | .Nx 1.2 . | | 245 | .Nx 1.2 . |
246 | This allows the use of old syscalls for | | 246 | This allows the use of old syscalls for |
247 | .Fn reboot | | 247 | .Fn reboot |
248 | and | | 248 | and |
249 | .Fn swapon . | | 249 | .Fn swapon . |
250 | The syscall numbers were changed post 1.2 to add functionality to the | | 250 | The syscall numbers were changed post 1.2 to add functionality to the |
251 | .Xr reboot 2 | | 251 | .Xr reboot 2 |
252 | syscall, and the new | | 252 | syscall, and the new |
253 | .Xr swapctl 2 | | 253 | .Xr swapctl 2 |
254 | interface was introduced. | | 254 | interface was introduced. |
255 | This also enables the | | 255 | This also enables the |
256 | .Em EXEC_ELF_NOTELESS | | 256 | .Em EXEC_ELF_NOTELESS |
257 | option. | | 257 | option. |
258 | .It Cd options COMPAT_13 | | 258 | .It Cd options COMPAT_13 |
259 | Enable binary compatibility with | | 259 | Enable binary compatibility with |
260 | .Nx 1.3 . | | 260 | .Nx 1.3 . |
261 | This allows the use of old syscalls for | | 261 | This allows the use of old syscalls for |
262 | .Fn sigaltstack , | | 262 | .Fn sigaltstack , |
263 | and also enables the old | | 263 | and also enables the old |
264 | .Xr swapctl 2 | | 264 | .Xr swapctl 2 |
265 | command | | 265 | command |
266 | .Dv SWAP_STATS | | 266 | .Dv SWAP_STATS |
267 | (now called | | 267 | (now called |
268 | .Dv SWAP_OSTATS ) , | | 268 | .Dv SWAP_OSTATS ) , |
269 | which does not include the | | 269 | which does not include the |
270 | .Fa se_path | | 270 | .Fa se_path |
271 | member of | | 271 | member of |
272 | .Va struct swapent . | | 272 | .Va struct swapent . |
273 | .It Cd options COMPAT_14 | | 273 | .It Cd options COMPAT_14 |
274 | Enable binary compatibility with | | 274 | Enable binary compatibility with |
275 | .Nx 1.4 . | | 275 | .Nx 1.4 . |
276 | This allows some old | | 276 | This allows some old |
277 | .Xr ioctl 2 | | 277 | .Xr ioctl 2 |
278 | on | | 278 | on |
279 | .Xr wscons 4 | | 279 | .Xr wscons 4 |
280 | to be performed, and allows the | | 280 | to be performed, and allows the |
281 | .Dv NFSSVC_BIOD | | 281 | .Dv NFSSVC_BIOD |
282 | mode of the | | 282 | mode of the |
283 | .Xr nfssvc 2 | | 283 | .Xr nfssvc 2 |
284 | system call to be used for compatibility with the deprecated nfsiod program. | | 284 | system call to be used for compatibility with the deprecated nfsiod program. |
285 | .It Cd options COMPAT_15 | | 285 | .It Cd options COMPAT_15 |
286 | Enable binary compatibility with | | 286 | Enable binary compatibility with |
287 | .Nx 1.5 . | | 287 | .Nx 1.5 . |
288 | Since there were no API changes from | | 288 | Since there were no API changes from |
289 | .Nx 1.5 | | 289 | .Nx 1.5 |
290 | and | | 290 | and |
291 | .Nx 1.6 , | | 291 | .Nx 1.6 , |
292 | this option does nothing. | | 292 | this option does nothing. |
293 | .It Cd options COMPAT_16 | | 293 | .It Cd options COMPAT_16 |
294 | Enable binary compatibility with | | 294 | Enable binary compatibility with |
295 | .Nx 1.6 . | | 295 | .Nx 1.6 . |
296 | This allows the use of old signal trampoline code which has been deprecated | | 296 | This allows the use of old signal trampoline code which has been deprecated |
297 | with the addition of | | 297 | with the addition of |
298 | .Xr siginfo 2 . | | 298 | .Xr siginfo 2 . |
299 | .It Cd options COMPAT_20 | | 299 | .It Cd options COMPAT_20 |
300 | Enable binary compatibility with | | 300 | Enable binary compatibility with |
301 | .Nx 2.0 . | | 301 | .Nx 2.0 . |
302 | This allows the use of old syscalls for | | 302 | This allows the use of old syscalls for |
303 | .Fn statfs , | | 303 | .Fn statfs , |
304 | .Fn fstatfs , | | 304 | .Fn fstatfs , |
305 | .Fn getfsstat | | 305 | .Fn getfsstat |
306 | and | | 306 | and |
307 | .Fn fhstatfs , | | 307 | .Fn fhstatfs , |
308 | which have been deprecated with the addition of the | | 308 | which have been deprecated with the addition of the |
309 | .Xr statvfs 2 , | | 309 | .Xr statvfs 2 , |
310 | .Xr fstatvfs 2 , | | 310 | .Xr fstatvfs 2 , |
311 | .Xr getvfsstat 2 | | 311 | .Xr getvfsstat 2 |
312 | and | | 312 | and |
313 | .Xr fhstatvfs 2 | | 313 | .Xr fhstatvfs 2 |
314 | system calls. | | 314 | system calls. |
315 | .It Cd options COMPAT_30 | | 315 | .It Cd options COMPAT_30 |
316 | Enable binary compatibility with | | 316 | Enable binary compatibility with |
317 | .Nx 3.0 . | | 317 | .Nx 3.0 . |
318 | See | | 318 | See |
319 | .Xr compat_30 8 | | 319 | .Xr compat_30 8 |
320 | for details about the changes made after the | | 320 | for details about the changes made after the |
321 | .Nx 3.0 | | 321 | .Nx 3.0 |
322 | release. | | 322 | release. |
323 | .It Cd options COMPAT_40 | | 323 | .It Cd options COMPAT_40 |
324 | Enable binary compatibility with | | 324 | Enable binary compatibility with |
325 | .Nx 4.0 . | | 325 | .Nx 4.0 . |
326 | .It Cd options COMPAT_43 | | 326 | .It Cd options COMPAT_43 |
327 | Enables compatibility with | | 327 | Enables compatibility with |
328 | .Bx 4.3 . | | 328 | .Bx 4.3 . |
329 | This adds an old syscall for | | 329 | This adds an old syscall for |
330 | .Xr lseek 2 . | | 330 | .Xr lseek 2 . |
331 | It also adds the ioctls for | | 331 | It also adds the ioctls for |
332 | .Dv TIOCGETP | | 332 | .Dv TIOCGETP |
333 | and | | 333 | and |
334 | .Dv TIOCSETP . | | 334 | .Dv TIOCSETP . |
335 | The return values for | | 335 | The return values for |
336 | .Xr getpid 2 , | | 336 | .Xr getpid 2 , |
337 | .Xr getgid 2 , | | 337 | .Xr getgid 2 , |
338 | and | | 338 | and |
339 | .Xr getuid 2 | | 339 | .Xr getuid 2 |
340 | syscalls are modified as well, to return the parent's PID and | | 340 | syscalls are modified as well, to return the parent's PID and |
341 | UID as well as the current process's. | | 341 | UID as well as the current process's. |
342 | It also enables the deprecated | | 342 | It also enables the deprecated |
343 | .Dv NTTYDISC | | 343 | .Dv NTTYDISC |
344 | terminal line discipline. | | 344 | terminal line discipline. |
345 | It also provides backwards compatibility with | | 345 | It also provides backwards compatibility with |
346 | .Dq old | | 346 | .Dq old |
347 | SIOC[GS]IF{ADDR,DSTADDR,BRDADDR,NETMASK} interface ioctls, including | | 347 | SIOC[GS]IF{ADDR,DSTADDR,BRDADDR,NETMASK} interface ioctls, including |
348 | binary compatibility with code written before the introduction of the | | 348 | binary compatibility with code written before the introduction of the |
349 | sa_len field in sockaddrs. | | 349 | sa_len field in sockaddrs. |
350 | It also enables | | 350 | It also enables |
351 | support for some older pre | | 351 | support for some older pre |
352 | .Bx 4.4 | | 352 | .Bx 4.4 |
353 | socket calls. | | 353 | socket calls. |
354 | .It Cd options COMPAT_50 | | 354 | .It Cd options COMPAT_50 |
355 | Enable binary compatibility with | | 355 | Enable binary compatibility with |
356 | .Nx 5.0 . | | 356 | .Nx 5.0 . |
357 | .It Cd options COMPAT_60 | | 357 | .It Cd options COMPAT_60 |
358 | Enable binary compatibility with | | 358 | Enable binary compatibility with |
359 | .Nx 6.0 . | | 359 | .Nx 6.0 . |
360 | .It Cd options COMPAT_70 | | 360 | .It Cd options COMPAT_70 |
361 | Enable binary compatibility with | | 361 | Enable binary compatibility with |
362 | .Nx 7.0 . | | 362 | .Nx 7.0 . |
363 | .It Cd options COMPAT_BSDPTY | | 363 | .It Cd options COMPAT_BSDPTY |
364 | This option is currently on by default and enables the pty multiplexer | | 364 | This option is currently on by default and enables the pty multiplexer |
365 | .Xr ptm 4 | | 365 | .Xr ptm 4 |
366 | and | | 366 | and |
367 | .Xr ptmx 4 | | 367 | .Xr ptmx 4 |
368 | to find and use ptys named | | 368 | to find and use ptys named |
369 | .Pa /dev/ptyXX | | 369 | .Pa /dev/ptyXX |
370 | (master) and | | 370 | (master) and |
371 | .Pa /dev/ttyXX | | 371 | .Pa /dev/ttyXX |
372 | (slave). | | 372 | (slave). |
373 | Eventually this option will become optional as ptyfs based pseudo-ttys become | | 373 | Eventually this option will become optional as ptyfs based pseudo-ttys become |
374 | the default, see | | 374 | the default, see |
375 | .Xr mount_ptyfs 8 . | | 375 | .Xr mount_ptyfs 8 . |
376 | .It Cd options COMPAT_SVR4 | | 376 | .It Cd options COMPAT_SVR4 |
377 | On those architectures that support it, this enables binary | | 377 | On those architectures that support it, this enables binary |
378 | compatibility with | | 378 | compatibility with |
379 | .At V.4 | | 379 | .At V.4 |
380 | applications built for the same architecture. | | 380 | applications built for the same architecture. |
381 | This currently includes the i386, m68k, and sparc ports. | | 381 | This currently includes the i386, m68k, and sparc ports. |
382 | .It Cd options COMPAT_LINUX | | 382 | .It Cd options COMPAT_LINUX |
383 | On those architectures that support it, this enables binary | | 383 | On those architectures that support it, this enables binary |
384 | compatibility with Linux ELF and | | 384 | compatibility with Linux ELF and |
385 | .Xr a.out 5 | | 385 | .Xr a.out 5 |
386 | applications built for the same architecture. | | 386 | applications built for the same architecture. |
387 | This currently includes the alpha, arm, i386, m68k, mips, powerpc and | | 387 | This currently includes the alpha, arm, i386, m68k, mips, powerpc and |
388 | x86_64 ports. | | 388 | x86_64 ports. |
389 | .It Cd options COMPAT_LINUX32 | | 389 | .It Cd options COMPAT_LINUX32 |
390 | On those 64 bit architectures that support it, this enables binary | | 390 | On those 64 bit architectures that support it, this enables binary |
391 | compatibility with 32 bit Linux binaries. | | 391 | compatibility with 32 bit Linux binaries. |
392 | For now this is limited to running i386 ELF Linux binaries on amd64. | | 392 | For now this is limited to running i386 ELF Linux binaries on amd64. |
393 | .It Cd options COMPAT_SUNOS | | 393 | .It Cd options COMPAT_SUNOS |
394 | On those architectures that support it, this enables binary | | 394 | On those architectures that support it, this enables binary |
395 | compatibility with | | 395 | compatibility with |
396 | .Tn SunOS 4.1 | | 396 | .Tn SunOS 4.1 |
397 | applications built for the same architecture. | | 397 | applications built for the same architecture. |
398 | This currently includes the sparc, sparc64 and most or all m68k ports. | | 398 | This currently includes the sparc, sparc64 and most or all m68k ports. |
399 | Note that the sparc64 requires the | | 399 | Note that the sparc64 requires the |
400 | .Em COMPAT_NETBSD32 | | 400 | .Em COMPAT_NETBSD32 |
401 | option for 64-bit kernels, in addition to this option. | | 401 | option for 64-bit kernels, in addition to this option. |
402 | .It Cd options COMPAT_ULTRIX | | 402 | .It Cd options COMPAT_ULTRIX |
403 | On those architectures that support it, this enables binary | | 403 | On those architectures that support it, this enables binary |
404 | compatibility with | | 404 | compatibility with |
405 | .Tn ULTRIX | | 405 | .Tn ULTRIX |
406 | applications built for the same architecture. | | 406 | applications built for the same architecture. |
407 | This currently is limited to the pmax. | | 407 | This currently is limited to the pmax. |
408 | The functionality of this option is unknown. | | 408 | The functionality of this option is unknown. |
409 | .It Cd options COMPAT_FREEBSD | | 409 | .It Cd options COMPAT_FREEBSD |
410 | On those architectures that support it, this enables binary | | 410 | On those architectures that support it, this enables binary |
411 | compatibility with | | 411 | compatibility with |
412 | .Fx | | 412 | .Fx |
413 | applications built for the same architecture. | | 413 | applications built for the same architecture. |
414 | At the moment this is limited to the i386 port. | | 414 | At the moment this is limited to the i386 port. |
415 | .It Cd options COMPAT_IBCS2 | | 415 | .It Cd options COMPAT_IBCS2 |
416 | On those architectures that support it, this enables binary | | 416 | On those architectures that support it, this enables binary |
417 | compatibility with iBCS2 or SVR3 applications built for the same architecture. | | 417 | compatibility with iBCS2 or SVR3 applications built for the same architecture. |
418 | This is currently limited to the i386 and vax ports. | | 418 | This is currently limited to the i386 and vax ports. |
419 | .It Cd options COMPAT_OSF1 | | 419 | .It Cd options COMPAT_OSF1 |
420 | On those architectures that support it, this enables binary | | 420 | On those architectures that support it, this enables binary |
421 | compatibility with | | 421 | compatibility with |
422 | .Tn Digital | | 422 | .Tn Digital |
423 | .Ux | | 423 | .Ux |
424 | .Po | | 424 | .Po |
425 | formerly | | 425 | formerly |
426 | .Tn OSF/1 | | 426 | .Tn OSF/1 |
427 | .Pc | | 427 | .Pc |
428 | applications built for the same architecture. | | 428 | applications built for the same architecture. |
429 | This is currently limited to the alpha port. | | 429 | This is currently limited to the alpha port. |
430 | .It Cd options COMPAT_NOMID | | 430 | .It Cd options COMPAT_NOMID |
431 | Enable compatibility with | | 431 | Enable compatibility with |
432 | .Xr a.out 5 | | 432 | .Xr a.out 5 |
433 | executables that lack a machine ID. | | 433 | executables that lack a machine ID. |
434 | This includes | | 434 | This includes |
435 | .Nx 0.8 Ns 's | | 435 | .Nx 0.8 Ns 's |
436 | ZMAGIC format, and 386BSD and BSDI's | | 436 | ZMAGIC format, and 386BSD and BSDI's |
437 | QMAGIC, NMAGIC, and OMAGIC | | 437 | QMAGIC, NMAGIC, and OMAGIC |
438 | .Xr a.out 5 | | 438 | .Xr a.out 5 |
439 | formats. | | 439 | formats. |
440 | .It Cd options COMPAT_NETBSD32 | | 440 | .It Cd options COMPAT_NETBSD32 |
441 | On those architectures that support it, this enables binary | | 441 | On those architectures that support it, this enables binary |
442 | compatibility with 32-bit applications built for the same architecture. | | 442 | compatibility with 32-bit applications built for the same architecture. |
443 | This is currently limited to the amd64 and sparc64 ports, and only | | 443 | This is currently limited to the amd64 and sparc64 ports, and only |
444 | applicable for 64-bit kernels. | | 444 | applicable for 64-bit kernels. |
445 | .It Cd options COMPAT_SVR4_32 | | 445 | .It Cd options COMPAT_SVR4_32 |
446 | On those architectures that support it, this enables binary | | 446 | On those architectures that support it, this enables binary |
447 | compatibility with 32-bit SVR4 applications built for the same architecture. | | 447 | compatibility with 32-bit SVR4 applications built for the same architecture. |
448 | This is currently limited to the sparc64 port, and only applicable for | | 448 | This is currently limited to the sparc64 port, and only applicable for |
449 | 64-bit kernels. | | 449 | 64-bit kernels. |
450 | .It Cd options COMPAT_AOUT_M68K | | 450 | .It Cd options COMPAT_AOUT_M68K |
451 | On m68k architectures which have switched to ELF, | | 451 | On m68k architectures which have switched to ELF, |
452 | this enables binary compatibility with | | 452 | this enables binary compatibility with |
453 | .Nx Ns Tn /m68k | | 453 | .Nx Ns Tn /m68k |
454 | .Xr a.out 5 | | 454 | .Xr a.out 5 |
455 | executables on | | 455 | executables on |
456 | .Nx Ns Tn /m68k | | 456 | .Nx Ns Tn /m68k |
457 | ELF kernels. | | 457 | ELF kernels. |
458 | This handles alignment incompatibility of m68k ABI between | | 458 | This handles alignment incompatibility of m68k ABI between |
459 | a.out and ELF which causes the structure padding differences. | | 459 | a.out and ELF which causes the structure padding differences. |
460 | Currently only some system calls which use | | 460 | Currently only some system calls which use |
461 | .Va struct stat | | 461 | .Va struct stat |
462 | are adjusted and some binaries which use | | 462 | are adjusted and some binaries which use |
463 | .Xr sysctl 3 | | 463 | .Xr sysctl 3 |
464 | to retrieve network details would not work properly. | | 464 | to retrieve network details would not work properly. |
465 | .It Cd options EMUL_NATIVEROOT=string | | 465 | .It Cd options EMUL_NATIVEROOT=string |
466 | Just like emulated binaries first try looking up files in | | 466 | Just like emulated binaries first try looking up files in |
467 | an emulation root (e.g. | | 467 | an emulation root (e.g. |
468 | .Pa /emul/linux ) | | 468 | .Pa /emul/linux ) |
469 | before looking them up in real root, this option causes native | | 469 | before looking them up in real root, this option causes native |
470 | binaries to first look up files in an "emulation" directory too. | | 470 | binaries to first look up files in an "emulation" directory too. |
471 | This can be useful to test an amd64 kernel on top of an i386 system | | 471 | This can be useful to test an amd64 kernel on top of an i386 system |
472 | before full migration: by unpacking the amd64 distribution in e.g. | | 472 | before full migration: by unpacking the amd64 distribution in e.g. |
473 | .Pa /emul/netbsd64 | | 473 | .Pa /emul/netbsd64 |
474 | and specifying that location as | | 474 | and specifying that location as |
475 | .Cd EMUL_NATIVEROOT , | | 475 | .Cd EMUL_NATIVEROOT , |
476 | native amd64 binaries can be run while the root file system remains | | 476 | native amd64 binaries can be run while the root file system remains |
477 | populated with i386 binaries. | | 477 | populated with i386 binaries. |
478 | Beware of | | 478 | Beware of |
479 | .Pa /dev | | 479 | .Pa /dev |
480 | incompatibilities between i386 and amd64 if you do this. | | 480 | incompatibilities between i386 and amd64 if you do this. |
481 | .It Cd options EXEC_ELF_NOTELESS | | 481 | .It Cd options EXEC_ELF_NOTELESS |
482 | Run unidentified ELF binaries as | | 482 | Run unidentified ELF binaries as |
483 | .Nx | | 483 | .Nx |
484 | binaries. | | 484 | binaries. |
485 | This might be needed for very old | | 485 | This might be needed for very old |
486 | .Nx | | 486 | .Nx |
487 | ELF binaries on some archs. | | 487 | ELF binaries on some archs. |
488 | These old binaries didn't contain an appropriate | | 488 | These old binaries didn't contain an appropriate |
489 | .Li .note.netbsd.ident | | 489 | .Li .note.netbsd.ident |
490 | section, and thus can't be identified by the kernel as | | 490 | section, and thus can't be identified by the kernel as |
491 | .Nx | | 491 | .Nx |
492 | binaries otherwise. | | 492 | binaries otherwise. |
493 | Beware - if this option is on, the kernel would run | | 493 | Beware - if this option is on, the kernel would run |
494 | .Em any | | 494 | .Em any |
495 | unknown ELF binaries as if they were | | 495 | unknown ELF binaries as if they were |
496 | .Nx | | 496 | .Nx |
497 | binaries. | | 497 | binaries. |
498 | .El | | 498 | .El |
499 | .Ss Debugging Options | | 499 | .Ss Debugging Options |
500 | .Bl -ohang | | 500 | .Bl -ohang |
501 | .It Cd options DDB | | 501 | .It Cd options DDB |
502 | Compiles in a kernel debugger for diagnosing kernel problems. | | 502 | Compiles in a kernel debugger for diagnosing kernel problems. |
503 | See | | 503 | See |
504 | .Xr ddb 4 | | 504 | .Xr ddb 4 |
505 | for details. | | 505 | for details. |
506 | .Em NOTE : | | 506 | .Em NOTE : |
507 | not available on all architectures. | | 507 | not available on all architectures. |
508 | .It Cd options DDB_FROMCONSOLE=integer | | 508 | .It Cd options DDB_FROMCONSOLE=integer |
509 | If set to non-zero, DDB may be entered by sending a break on a serial | | 509 | If set to non-zero, DDB may be entered by sending a break on a serial |
510 | console or by a special key sequence on a graphics console. | | 510 | console or by a special key sequence on a graphics console. |
511 | A value of "0" ignores console breaks or key sequences. | | 511 | A value of "0" ignores console breaks or key sequences. |
512 | If not explicitly specified, the default value is "1". | | 512 | If not explicitly specified, the default value is "1". |
513 | Note that this sets the value of the | | 513 | Note that this sets the value of the |
514 | .Em ddb.fromconsole | | 514 | .Em ddb.fromconsole |
515 | .Xr sysctl 3 | | 515 | .Xr sysctl 3 |
516 | variable which may be changed at run time -- see | | 516 | variable which may be changed at run time -- see |
517 | .Xr sysctl 8 | | 517 | .Xr sysctl 8 |
518 | for details. | | 518 | for details. |
519 | .It Cd options DDB_HISTORY_SIZE=integer | | 519 | .It Cd options DDB_HISTORY_SIZE=integer |
520 | If this is non-zero, enable history editing in the kernel debugger | | 520 | If this is non-zero, enable history editing in the kernel debugger |
521 | and set the size of the history to this value. | | 521 | and set the size of the history to this value. |
522 | .It Cd options DDB_ONPANIC | | 522 | .It Cd options DDB_ONPANIC |
523 | The default if not specified is | | 523 | The default if not specified is |
524 | .Dq 1 | | 524 | .Dq 1 |
525 | - just enter into DDB. | | 525 | - just enter into DDB. |
526 | If set to | | 526 | If set to |
527 | .Dq 2 | | 527 | .Dq 2 |
528 | the kernel will | | 528 | the kernel will |
529 | attempt to print out a stack trace before entering into DDB. | | 529 | attempt to print out a stack trace before entering into DDB. |
530 | If set to | | 530 | If set to |
531 | .Dq 0 | | 531 | .Dq 0 |
532 | the kernel will attempt to print out a stack trace | | 532 | the kernel will attempt to print out a stack trace |
533 | and reboot the system. | | 533 | and reboot the system. |
534 | If set to | | 534 | If set to |
535 | .Dq -1 | | 535 | .Dq -1 |
536 | then neither a stack trace is printed or DDB entered - | | 536 | then neither a stack trace is printed or DDB entered - |
537 | it is as if DDB were not compiled into the kernel. | | 537 | it is as if DDB were not compiled into the kernel. |
538 | Note that this sets the value of the | | 538 | Note that this sets the value of the |
539 | .Em ddb.onpanic | | 539 | .Em ddb.onpanic |
540 | .Xr sysctl 3 | | 540 | .Xr sysctl 3 |
541 | variable which may be changed at run time -- see | | 541 | variable which may be changed at run time -- see |
542 | .Xr sysctl 8 | | 542 | .Xr sysctl 8 |
543 | for details. | | 543 | for details. |
544 | .It Cd options DDB_COMMANDONENTER=string | | 544 | .It Cd options DDB_COMMANDONENTER=string |
545 | This option specify commands which will be executed on each entry to DDB. | | 545 | This option specify commands which will be executed on each entry to DDB. |
546 | This sets the default value of the | | 546 | This sets the default value of the |
547 | .Em ddb.commandonenter | | 547 | .Em ddb.commandonenter |
548 | .Xr sysctl 3 | | 548 | .Xr sysctl 3 |
549 | variable which may be changed at run time. | | 549 | variable which may be changed at run time. |
550 | .It Cd options DDB_BREAK_CHAR=integer | | 550 | .It Cd options DDB_BREAK_CHAR=integer |
551 | This option overrides using break to enter the kernel debugger | | 551 | This option overrides using break to enter the kernel debugger |
552 | on the serial console. | | 552 | on the serial console. |
553 | The value given is the ASCII value to be used instead. | | 553 | The value given is the ASCII value to be used instead. |
554 | This is currently only supported by the com driver. | | 554 | This is currently only supported by the com driver. |
555 | .It Cd options DDB_VERBOSE_HELP | | 555 | .It Cd options DDB_VERBOSE_HELP |
556 | This option adds more verbose descriptions to the | | 556 | This option adds more verbose descriptions to the |
557 | .Em help | | 557 | .Em help |
558 | command. | | 558 | command. |
559 | .It Cd options KGDB | | 559 | .It Cd options KGDB |
560 | Compiles in a remote kernel debugger stub for diagnosing kernel problems | | 560 | Compiles in a remote kernel debugger stub for diagnosing kernel problems |
561 | using the | | 561 | using the |
562 | .Dq remote target | | 562 | .Dq remote target |
563 | feature of gdb. | | 563 | feature of gdb. |
564 | See | | 564 | See |
565 | .Xr gdb 1 | | 565 | .Xr gdb 1 |
566 | for details. | | 566 | for details. |
567 | .Em NOTE : | | 567 | .Em NOTE : |
568 | not available on all architectures. | | 568 | not available on all architectures. |
569 | .It Cd options KGDB_DEV | | 569 | .It Cd options KGDB_DEV |
570 | Device number | | 570 | Device number |
571 | .Po | | 571 | .Po |
572 | as a | | 572 | as a |
573 | .Dv dev_t | | 573 | .Dv dev_t |
574 | .Pc | | 574 | .Pc |
575 | of kgdb device. | | 575 | of kgdb device. |
576 | .It Cd options KGDB_DEVADDR | | 576 | .It Cd options KGDB_DEVADDR |
577 | Memory address of kgdb device. | | 577 | Memory address of kgdb device. |
578 | .It Cd options KGDB_DEVMODE | | 578 | .It Cd options KGDB_DEVMODE |
579 | Permissions of kgdb device. | | 579 | Permissions of kgdb device. |
580 | .It Cd options KGDB_DEVNAME | | 580 | .It Cd options KGDB_DEVNAME |
581 | Device name of kgdb device. | | 581 | Device name of kgdb device. |
582 | .It Cd options KGDB_DEVRATE | | 582 | .It Cd options KGDB_DEVRATE |
583 | Baud rate of kgdb device. | | 583 | Baud rate of kgdb device. |
584 | .It Cd makeoptions DEBUG="-g" | | 584 | .It Cd makeoptions DEBUG="-g" |
585 | The | | 585 | The |
586 | .Fl g | | 586 | .Fl g |
587 | flag causes | | 587 | flag causes |
588 | .Pa netbsd.gdb | | 588 | .Pa netbsd.gdb |
589 | to be built in addition to | | 589 | to be built in addition to |
590 | .Pa netbsd . | | 590 | .Pa netbsd . |
591 | .Pa netbsd.gdb | | 591 | .Pa netbsd.gdb |
592 | is useful for debugging kernel crash dumps with gdb. | | 592 | is useful for debugging kernel crash dumps with gdb. |
593 | See | | 593 | See |
594 | .Xr gdb 1 | | 594 | .Xr gdb 1 |
595 | for details. | | 595 | for details. |
596 | This also turns on | | 596 | This also turns on |
597 | .Em options DEBUG | | 597 | .Em options DEBUG |
598 | (which see). | | 598 | (which see). |
599 | .It Cd options DEBUG | | 599 | .It Cd options DEBUG |
600 | Turns on miscellaneous kernel debugging. | | 600 | Turns on miscellaneous kernel debugging. |
601 | Since options are turned into preprocessor defines (see above), | | 601 | Since options are turned into preprocessor defines (see above), |
602 | .Em options DEBUG | | 602 | .Em options DEBUG |
603 | is equivalent to doing a | | 603 | is equivalent to doing a |
604 | .Em #define DEBUG | | 604 | .Em #define DEBUG |
605 | throughout the kernel. | | 605 | throughout the kernel. |
606 | Much of the kernel has | | 606 | Much of the kernel has |
607 | .Em #ifdef DEBUG | | 607 | .Em #ifdef DEBUG |
608 | conditionalized debugging code. | | 608 | conditionalized debugging code. |
609 | Note that many parts of the kernel (typically device drivers) include their own | | 609 | Note that many parts of the kernel (typically device drivers) include their own |
610 | .Em #ifdef XXX_DEBUG | | 610 | .Em #ifdef XXX_DEBUG |
611 | conditionals instead. | | 611 | conditionals instead. |
612 | This option also turns on certain other options, | | 612 | This option also turns on certain other options, |
613 | which may decrease system performance. | | 613 | which may decrease system performance. |
614 | Systems with this option are not suitable for regular use, and are | | 614 | Systems with this option are not suitable for regular use, and are |
615 | intended only for debugging or looking for bugs. | | 615 | intended only for debugging or looking for bugs. |
616 | .It Cd options DIAGNOSTIC | | 616 | .It Cd options DIAGNOSTIC |
617 | Adds code to the kernel that does internal consistency checks. | | 617 | Adds code to the kernel that does internal consistency checks. |
618 | This code will cause the kernel to panic if corruption of internal data | | 618 | This code will cause the kernel to panic if corruption of internal data |
619 | structures is detected. | | 619 | structures is detected. |
620 | Historically, the performance degradation is sufficiently small that | | 620 | Historically, the performance degradation is sufficiently small that |
621 | it is reasonable for systems with | | 621 | it is reasonable for systems with |
622 | .Em options DIAGNOSTIC | | 622 | .Em options DIAGNOSTIC |
623 | to be in production use, with the real consideration not being | | 623 | to be in production use, with the real consideration not being |
624 | performance but instead a preference for more panics versus continued | | 624 | performance but instead a preference for more panics versus continued |
625 | operation with undetected problems. | | 625 | operation with undetected problems. |
626 | .It Cd options LOCKDEBUG | | 626 | .It Cd options LOCKDEBUG |
627 | Adds code to the kernel to detect incorrect use of locking primitives | | 627 | Adds code to the kernel to detect incorrect use of locking primitives |
628 | (mutex, rwlock). | | 628 | (mutex, rwlock). |
629 | This code will cause the kernel to check for dead lock conditions. | | 629 | This code will cause the kernel to check for dead lock conditions. |
630 | It will also check for memory being freed to not contain initialised | | 630 | It will also check for memory being freed to not contain initialised |
631 | lock primitives. | | 631 | lock primitives. |
632 | Functions for use in | | 632 | Functions for use in |
633 | .Xr ddb 4 | | 633 | .Xr ddb 4 |
634 | to check lock chains etc. are also enabled. | | 634 | to check lock chains etc. are also enabled. |
635 | These checks are very expensive and can decrease performance on | | 635 | These checks are very expensive and can decrease performance on |
636 | multi-processor machines by a factor of three. | | 636 | multi-processor machines by a factor of three. |
| | | 637 | .It Cd options KDTRACE_HOOKS |
| | | 638 | Adds hooks for the DTrace tracing facility, which allows users to |
| | | 639 | analyse many aspects of system and application behavior. |
| | | 640 | See |
| | | 641 | .Xr dtrace 1 |
| | | 642 | for details. |
637 | .It Cd options KSTACK_CHECK_MAGIC | | 643 | .It Cd options KSTACK_CHECK_MAGIC |
638 | Check kernel stack usage and panic if stack overflow is detected. | | 644 | Check kernel stack usage and panic if stack overflow is detected. |
639 | This check is performance sensitive because it scans stack on each context | | 645 | This check is performance sensitive because it scans stack on each context |
640 | switch. | | 646 | switch. |
641 | .It Cd options KTRACE | | 647 | .It Cd options KTRACE |
642 | Add hooks for the system call tracing facility, which allows users to | | 648 | Add hooks for the system call tracing facility, which allows users to |
643 | watch the system call invocation behavior of processes. | | 649 | watch the system call invocation behavior of processes. |
644 | See | | 650 | See |
645 | .Xr ktrace 1 | | 651 | .Xr ktrace 1 |
646 | for details. | | 652 | for details. |
647 | .It Cd options MSGBUFSIZE=integer | | 653 | .It Cd options MSGBUFSIZE=integer |
648 | This option sets the size of the kernel message buffer. | | 654 | This option sets the size of the kernel message buffer. |
649 | This buffer holds the kernel output of | | 655 | This buffer holds the kernel output of |
650 | .Fn printf | | 656 | .Fn printf |
651 | when not (yet) read by | | 657 | when not (yet) read by |
652 | .Xr syslogd 8 . | | 658 | .Xr syslogd 8 . |
653 | This is particularly useful when the system has crashed and you wish to lookup | | 659 | This is particularly useful when the system has crashed and you wish to lookup |
654 | the kernel output from just before the crash. | | 660 | the kernel output from just before the crash. |
655 | Also, since the autoconfig output becomes more and more verbose, | | 661 | Also, since the autoconfig output becomes more and more verbose, |
656 | it sometimes happens that the message buffer overflows before | | 662 | it sometimes happens that the message buffer overflows before |
657 | .Xr syslogd 8 | | 663 | .Xr syslogd 8 |
658 | was able to read it. | | 664 | was able to read it. |
659 | Note that not all systems are capable of obtaining a variable sized message | | 665 | Note that not all systems are capable of obtaining a variable sized message |
660 | buffer. | | 666 | buffer. |
661 | There are also some systems on which memory contents are not preserved | | 667 | There are also some systems on which memory contents are not preserved |
662 | across reboots. | | 668 | across reboots. |
663 | .It Cd options KERNHIST | | 669 | .It Cd options KERNHIST |
664 | Enables the kernel history logs, which create in-memory traces of | | 670 | Enables the kernel history logs, which create in-memory traces of |
665 | various kernel activities. | | 671 | various kernel activities. |
666 | These logs can be displayed by using | | 672 | These logs can be displayed by using |
667 | .Cm show kernhist | | 673 | .Cm show kernhist |
668 | from DDB. | | 674 | from DDB. |
669 | See the kernel source file | | 675 | See the kernel source file |
670 | .Pa sys/kern/kern_history.c | | 676 | .Pa sys/kern/kern_history.c |
671 | and the | | 677 | and the |
672 | .Xr kernhist 9 | | 678 | .Xr kernhist 9 |
673 | manual for details. | | 679 | manual for details. |
674 | .It Cd options KERNHIST_PRINT | | 680 | .It Cd options KERNHIST_PRINT |
675 | Prints the kernel history logs on the system console as entries are added. | | 681 | Prints the kernel history logs on the system console as entries are added. |
676 | Note that the output is | | 682 | Note that the output is |
677 | .Em extremely | | 683 | .Em extremely |
678 | voluminous, so this option is really only useful for debugging | | 684 | voluminous, so this option is really only useful for debugging |
679 | the very earliest parts of kernel initialization. | | 685 | the very earliest parts of kernel initialization. |
680 | .It Cd options UVMHIST | | 686 | .It Cd options UVMHIST |
681 | Like | | 687 | Like |
682 | .Em KERNHIST , | | 688 | .Em KERNHIST , |
683 | it enables the UVM history logs. | | 689 | it enables the UVM history logs. |
684 | These logs can be displayed by using | | 690 | These logs can be displayed by using |
685 | .Cm show kernhist | | 691 | .Cm show kernhist |
686 | from DDB. | | 692 | from DDB. |
687 | See the kernel source file | | 693 | See the kernel source file |
688 | .Pa sys/uvm/uvm_stat.c | | 694 | .Pa sys/uvm/uvm_stat.c |
689 | for details. | | 695 | for details. |
690 | .It Cd options UVMHIST_PRINT | | 696 | .It Cd options UVMHIST_PRINT |
691 | Like | | 697 | Like |
692 | .Em UVMHIST , | | 698 | .Em UVMHIST , |
693 | it prints the UVM history logs on the system console as entries are added. | | 699 | it prints the UVM history logs on the system console as entries are added. |
694 | Note that the output is | | 700 | Note that the output is |
695 | .Em extremely | | 701 | .Em extremely |
696 | voluminous, so this option is really only useful for debugging | | 702 | voluminous, so this option is really only useful for debugging |
697 | the very earliest parts of kernel initialization. | | 703 | the very earliest parts of kernel initialization. |
698 | .It Cd options UVMHIST_MAPHIST_SIZE | | 704 | .It Cd options UVMHIST_MAPHIST_SIZE |
699 | Set the size of the | | 705 | Set the size of the |
700 | .Dq maphist | | 706 | .Dq maphist |
701 | kernel history. | | 707 | kernel history. |
702 | The default is 100. | | 708 | The default is 100. |
703 | This option depends upon the | | 709 | This option depends upon the |
704 | .Em UVMHIST | | 710 | .Em UVMHIST |
705 | option. | | 711 | option. |
706 | .It Cd options UVMHIST_PDHIST_SIZE | | 712 | .It Cd options UVMHIST_PDHIST_SIZE |
707 | Set the size of the | | 713 | Set the size of the |
708 | .Dq pdhist | | 714 | .Dq pdhist |
709 | kernel history. | | 715 | kernel history. |
710 | The default is 100. | | 716 | The default is 100. |
711 | This option depends upon the | | 717 | This option depends upon the |
712 | .Em UVMHIST | | 718 | .Em UVMHIST |
713 | option. | | 719 | option. |
714 | .It Cd options BIOHIST | | 720 | .It Cd options BIOHIST |
715 | Like | | 721 | Like |
716 | .Em KERNHIST , | | 722 | .Em KERNHIST , |
717 | it enables the BIO history logs. | | 723 | it enables the BIO history logs. |
718 | These logs can be displayed by using | | 724 | These logs can be displayed by using |
719 | .Cm show kernhist | | 725 | .Cm show kernhist |
720 | from DDB, and can help in debugging problems with Buffered I/O operations. | | 726 | from DDB, and can help in debugging problems with Buffered I/O operations. |
721 | See the kernel source file | | 727 | See the kernel source file |
722 | .Pa sys/kern/vfs_vio.c | | 728 | .Pa sys/kern/vfs_vio.c |
723 | for details. | | 729 | for details. |
724 | .It Cd options BIOHIST_PRINT | | 730 | .It Cd options BIOHIST_PRINT |
725 | Like | | 731 | Like |
726 | .Em BIOHIST , | | 732 | .Em BIOHIST , |
727 | it prints the BIO history logs on the system console as entries are added. | | 733 | it prints the BIO history logs on the system console as entries are added. |
728 | Note that the output is | | 734 | Note that the output is |
729 | .Em extremely | | 735 | .Em extremely |
730 | voluminous, so this option is really only useful for debugging | | 736 | voluminous, so this option is really only useful for debugging |
731 | the very earliest parts of kernel initialization. | | 737 | the very earliest parts of kernel initialization. |
732 | .It Cd options BIOHIST_SIZE | | 738 | .It Cd options BIOHIST_SIZE |
733 | Set the size of the | | 739 | Set the size of the |
734 | .Dq biohist | | 740 | .Dq biohist |
735 | kernel history. | | 741 | kernel history. |
736 | The default is 500. | | 742 | The default is 500. |
737 | This option depends upon the | | 743 | This option depends upon the |
738 | .Em BIOHIST | | 744 | .Em BIOHIST |
739 | option. | | 745 | option. |
740 | .El | | 746 | .El |
741 | .Ss File Systems | | 747 | .Ss File Systems |
742 | .Bl -ohang | | 748 | .Bl -ohang |
743 | .It Cd file-system FFS | | 749 | .It Cd file-system FFS |
744 | Includes code implementing the Berkeley Fast File System | | 750 | Includes code implementing the Berkeley Fast File System |
745 | .Po Em FFS Pc . | | 751 | .Po Em FFS Pc . |
746 | Most machines need this if they are not running diskless. | | 752 | Most machines need this if they are not running diskless. |
747 | .It Cd file-system EXT2FS | | 753 | .It Cd file-system EXT2FS |
748 | Includes code implementing the Second Extended File System | | 754 | Includes code implementing the Second Extended File System |
749 | .Po Em ext2 Pc , | | 755 | .Po Em ext2 Pc , |
750 | revision 0 and revision 1 with the | | 756 | revision 0 and revision 1 with the |
751 | .Em filetype , | | 757 | .Em filetype , |
752 | .Em sparse_super | | 758 | .Em sparse_super |
753 | and | | 759 | and |
754 | .Em large_file | | 760 | .Em large_file |
755 | options. | | 761 | options. |
756 | This is the most commonly used file system on the Linux operating system, | | 762 | This is the most commonly used file system on the Linux operating system, |
757 | and is provided here for compatibility. | | 763 | and is provided here for compatibility. |
758 | Some of the specific features of | | 764 | Some of the specific features of |
759 | .Em ext2 | | 765 | .Em ext2 |
760 | like the "behavior on errors" are not implemented. | | 766 | like the "behavior on errors" are not implemented. |
761 | See | | 767 | See |
762 | .Xr mount_ext2fs 8 | | 768 | .Xr mount_ext2fs 8 |
763 | for details. | | 769 | for details. |
764 | .It Cd file-system LFS | | 770 | .It Cd file-system LFS |
765 | .Bq Em EXPERIMENTAL | | 771 | .Bq Em EXPERIMENTAL |
766 | Include the Log-structured File System | | 772 | Include the Log-structured File System |
767 | .Po Em LFS Pc . | | 773 | .Po Em LFS Pc . |
768 | See | | 774 | See |
769 | .Xr mount_lfs 8 | | 775 | .Xr mount_lfs 8 |
770 | and | | 776 | and |
771 | .Xr newfs_lfs 8 | | 777 | .Xr newfs_lfs 8 |
772 | for details. | | 778 | for details. |
773 | .It Cd file-system MFS | | 779 | .It Cd file-system MFS |
774 | Include the Memory File System | | 780 | Include the Memory File System |
775 | .Po Em MFS Pc . | | 781 | .Po Em MFS Pc . |
776 | This file system stores files in swappable memory, and produces | | 782 | This file system stores files in swappable memory, and produces |
777 | notable performance improvements when it is used as the file store | | 783 | notable performance improvements when it is used as the file store |
778 | for | | 784 | for |
779 | .Pa /tmp | | 785 | .Pa /tmp |
780 | and similar file systems. | | 786 | and similar file systems. |
781 | See | | 787 | See |
782 | .Xr mount_mfs 8 | | 788 | .Xr mount_mfs 8 |
783 | for details. | | 789 | for details. |
784 | .It Cd file-system NFS | | 790 | .It Cd file-system NFS |
785 | Include the client side of the Network File System | | 791 | Include the client side of the Network File System |
786 | .Pq Tn NFS | | 792 | .Pq Tn NFS |
787 | remote file sharing protocol. | | 793 | remote file sharing protocol. |
788 | Although the bulk of the code implementing | | 794 | Although the bulk of the code implementing |
789 | .Tn NFS | | 795 | .Tn NFS |
790 | is kernel based, several user level daemons are needed for it to work. | | 796 | is kernel based, several user level daemons are needed for it to work. |
791 | See | | 797 | See |
792 | .Xr mount_nfs 8 | | 798 | .Xr mount_nfs 8 |
793 | for details. | | 799 | for details. |
794 | .It Cd file-system CD9660 | | 800 | .It Cd file-system CD9660 |
795 | Includes code for the | | 801 | Includes code for the |
796 | .Tn ISO | | 802 | .Tn ISO |
797 | 9660 + Rock Ridge file system, which is the standard file system on many | | 803 | 9660 + Rock Ridge file system, which is the standard file system on many |
798 | .Tn CD-ROM | | 804 | .Tn CD-ROM |
799 | discs. | | 805 | discs. |
800 | Useful primarily if you have a | | 806 | Useful primarily if you have a |
801 | .Tn CD-ROM | | 807 | .Tn CD-ROM |
802 | drive. | | 808 | drive. |
803 | See | | 809 | See |
804 | .Xr mount_cd9660 8 | | 810 | .Xr mount_cd9660 8 |
805 | for details. | | 811 | for details. |
806 | .It Cd file-system MSDOSFS | | 812 | .It Cd file-system MSDOSFS |
807 | Includes the | | 813 | Includes the |
808 | .Tn MS-DOS | | 814 | .Tn MS-DOS |
809 | FAT file system, which is reportedly still used | | 815 | FAT file system, which is reportedly still used |
810 | by unfortunate people who have not heard about | | 816 | by unfortunate people who have not heard about |
811 | .Nx . | | 817 | .Nx . |
812 | Also implements the | | 818 | Also implements the |
813 | .Tn Windows 95 | | 819 | .Tn Windows 95 |
814 | extensions to the same, which permit the use of longer, mixed case | | 820 | extensions to the same, which permit the use of longer, mixed case |
815 | file names. | | 821 | file names. |
816 | See | | 822 | See |
817 | .Xr mount_msdos 8 | | 823 | .Xr mount_msdos 8 |
818 | and | | 824 | and |
819 | .Xr fsck_msdos 8 | | 825 | .Xr fsck_msdos 8 |
820 | for details. | | 826 | for details. |
821 | .It Cd file-system NTFS | | 827 | .It Cd file-system NTFS |
822 | .Bq Em EXPERIMENTAL | | 828 | .Bq Em EXPERIMENTAL |
823 | Includes code for the | | 829 | Includes code for the |
824 | .Tn Microsoft Windows NT | | 830 | .Tn Microsoft Windows NT |
825 | file system. | | 831 | file system. |
826 | See | | 832 | See |
827 | .Xr mount_ntfs 8 | | 833 | .Xr mount_ntfs 8 |
828 | for details. | | 834 | for details. |
829 | .It Cd file-system FDESC | | 835 | .It Cd file-system FDESC |
830 | Includes code for a file system, conventionally mounted on | | 836 | Includes code for a file system, conventionally mounted on |
831 | .Pa /dev/fd , | | 837 | .Pa /dev/fd , |
832 | which permits access to the per-process file descriptor space via | | 838 | which permits access to the per-process file descriptor space via |
833 | special files in the file system. | | 839 | special files in the file system. |
834 | See | | 840 | See |
835 | .Xr mount_fdesc 8 | | 841 | .Xr mount_fdesc 8 |
836 | for details. | | 842 | for details. |
837 | Note that this facility is redundant, and thus unneeded on most | | 843 | Note that this facility is redundant, and thus unneeded on most |
838 | .Nx | | 844 | .Nx |
839 | systems, since the | | 845 | systems, since the |
840 | .Xr fd 4 | | 846 | .Xr fd 4 |
841 | pseudo-device driver already provides identical functionality. | | 847 | pseudo-device driver already provides identical functionality. |
842 | On most | | 848 | On most |
843 | .Nx | | 849 | .Nx |
844 | systems, instances of | | 850 | systems, instances of |
845 | .Xr fd 4 | | 851 | .Xr fd 4 |
846 | are mknoded under | | 852 | are mknoded under |
847 | .Pa /dev/fd/ | | 853 | .Pa /dev/fd/ |
848 | and on | | 854 | and on |
849 | .Pa /dev/stdin , | | 855 | .Pa /dev/stdin , |
850 | .Pa /dev/stdout , | | 856 | .Pa /dev/stdout , |
851 | and | | 857 | and |
852 | .Pa /dev/stderr . | | 858 | .Pa /dev/stderr . |
853 | .It Cd file-system KERNFS | | 859 | .It Cd file-system KERNFS |
854 | Includes code which permits the mounting of a special file system | | 860 | Includes code which permits the mounting of a special file system |
855 | (normally mounted on | | 861 | (normally mounted on |
856 | .Pa /kern ) | | 862 | .Pa /kern ) |
857 | in which files representing various kernel variables and parameters | | 863 | in which files representing various kernel variables and parameters |
858 | may be found. | | 864 | may be found. |
859 | See | | 865 | See |
860 | .Xr mount_kernfs 8 | | 866 | .Xr mount_kernfs 8 |
861 | for details. | | 867 | for details. |
862 | .It Cd file-system NULLFS | | 868 | .It Cd file-system NULLFS |
863 | Includes code for a loopback file system. | | 869 | Includes code for a loopback file system. |
864 | This permits portions of the file hierarchy to be re-mounted in other places. | | 870 | This permits portions of the file hierarchy to be re-mounted in other places. |
865 | The code really exists to provide an example of a stackable file system layer. | | 871 | The code really exists to provide an example of a stackable file system layer. |
866 | See | | 872 | See |
867 | .Xr mount_null 8 | | 873 | .Xr mount_null 8 |
868 | for details. | | 874 | for details. |
869 | .It Cd file-system OVERLAY | | 875 | .It Cd file-system OVERLAY |
870 | Includes code for a file system filter. | | 876 | Includes code for a file system filter. |
871 | This permits the overlay file system to intercept all access to an underlying | | 877 | This permits the overlay file system to intercept all access to an underlying |
872 | file system. | | 878 | file system. |
873 | This file system is intended to serve as an example of a stacking file | | 879 | This file system is intended to serve as an example of a stacking file |
874 | system which has a need to interpose itself between an underlying file | | 880 | system which has a need to interpose itself between an underlying file |
875 | system and all other access. | | 881 | system and all other access. |
876 | See | | 882 | See |
877 | .Xr mount_overlay 8 | | 883 | .Xr mount_overlay 8 |
878 | for details. | | 884 | for details. |
879 | .It Cd file-system PROCFS | | 885 | .It Cd file-system PROCFS |
880 | Includes code for a special file system (conventionally mounted on | | 886 | Includes code for a special file system (conventionally mounted on |
881 | .Pa /proc ) | | 887 | .Pa /proc ) |
882 | in which the process space becomes visible in the file system. | | 888 | in which the process space becomes visible in the file system. |
883 | Among | | 889 | Among |
884 | other things, the memory spaces of processes running on the system are | | 890 | other things, the memory spaces of processes running on the system are |
885 | visible as files, and signals may be sent to processes by writing to | | 891 | visible as files, and signals may be sent to processes by writing to |
886 | .Pa ctl | | 892 | .Pa ctl |
887 | files in the procfs namespace. | | 893 | files in the procfs namespace. |
888 | See | | 894 | See |
889 | .Xr mount_procfs 8 | | 895 | .Xr mount_procfs 8 |
890 | for details. | | 896 | for details. |
891 | .It Cd file-system UDF | | 897 | .It Cd file-system UDF |
892 | .Bq Em EXPERIMENTAL | | 898 | .Bq Em EXPERIMENTAL |
893 | Includes code for the UDF file system commonly found on CD and DVD | | 899 | Includes code for the UDF file system commonly found on CD and DVD |
894 | media but also on USB sticks. | | 900 | media but also on USB sticks. |
895 | Currently supports read and write access upto UDF 2.01 and somewhat limited | | 901 | Currently supports read and write access upto UDF 2.01 and somewhat limited |
896 | write support for UDF 2.50. | | 902 | write support for UDF 2.50. |
897 | It is marked experimental since there is no | | 903 | It is marked experimental since there is no |
898 | .Xr fsck_udf 8 . | | 904 | .Xr fsck_udf 8 . |
899 | See | | 905 | See |
900 | .Xr mount_udf 8 | | 906 | .Xr mount_udf 8 |
901 | for details. | | 907 | for details. |
902 | .It Cd file-system UMAPFS | | 908 | .It Cd file-system UMAPFS |
903 | Includes a loopback file system in which user and group IDs may be | | 909 | Includes a loopback file system in which user and group IDs may be |
904 | remapped -- this can be useful when mounting alien file systems with | | 910 | remapped -- this can be useful when mounting alien file systems with |
905 | different UIDs and GIDs than the local system. | | 911 | different UIDs and GIDs than the local system. |
906 | See | | 912 | See |
907 | .Xr mount_umap 8 | | 913 | .Xr mount_umap 8 |
908 | for details. | | 914 | for details. |
909 | .It Cd file-system UNION | | 915 | .It Cd file-system UNION |
910 | .Bq Em EXPERIMENTAL | | 916 | .Bq Em EXPERIMENTAL |
911 | Includes code for the union file system, which permits directories to | | 917 | Includes code for the union file system, which permits directories to |
912 | be mounted on top of each other in such a way that both file systems | | 918 | be mounted on top of each other in such a way that both file systems |
913 | remain visible -- this permits tricks like allowing writing (and the | | 919 | remain visible -- this permits tricks like allowing writing (and the |
914 | deleting of files) on a read-only file system like a | | 920 | deleting of files) on a read-only file system like a |
915 | .Tn CD-ROM | | 921 | .Tn CD-ROM |
916 | by mounting a local writable file system on top of the read-only file system. | | 922 | by mounting a local writable file system on top of the read-only file system. |
917 | See | | 923 | See |
918 | .Xr mount_union 8 | | 924 | .Xr mount_union 8 |
919 | for details. | | 925 | for details. |
920 | .It Cd file-system CODA | | 926 | .It Cd file-system CODA |
921 | .Bq Em EXPERIMENTAL | | 927 | .Bq Em EXPERIMENTAL |
922 | Includes code for the Coda file system. | | 928 | Includes code for the Coda file system. |
923 | Coda is a distributed file system like NFS and AFS. | | 929 | Coda is a distributed file system like NFS and AFS. |
924 | It is freely available, like NFS, but it functions much like AFS in being a | | 930 | It is freely available, like NFS, but it functions much like AFS in being a |
925 | .Dq stateful | | 931 | .Dq stateful |
926 | file system. | | 932 | file system. |
927 | Both Coda and AFS cache files on your local machine to improve performance. | | 933 | Both Coda and AFS cache files on your local machine to improve performance. |
928 | Then Coda goes a step further than AFS by letting you access the cached | | 934 | Then Coda goes a step further than AFS by letting you access the cached |
929 | files when there is no available network, viz. disconnected laptops and | | 935 | files when there is no available network, viz. disconnected laptops and |
930 | network outages. | | 936 | network outages. |
931 | In Coda, both the client and server are outside the kernel which makes | | 937 | In Coda, both the client and server are outside the kernel which makes |
932 | them easier to experiment with. | | 938 | them easier to experiment with. |
933 | Coda is available for several UNIX and non-UNIX platforms. | | 939 | Coda is available for several UNIX and non-UNIX platforms. |
934 | See | | 940 | See |
935 | .Lk http://www.coda.cs.cmu.edu | | 941 | .Lk http://www.coda.cs.cmu.edu |
936 | for more details. | | 942 | for more details. |
937 | .Em NOTE : | | 943 | .Em NOTE : |
938 | You also need to enable the pseudo-device, vcoda, for the Coda | | 944 | You also need to enable the pseudo-device, vcoda, for the Coda |
939 | file system to work. | | 945 | file system to work. |
940 | .It Cd file-system SMBFS | | 946 | .It Cd file-system SMBFS |
941 | .Bq Em EXPERIMENTAL | | 947 | .Bq Em EXPERIMENTAL |
942 | Includes code for the SMB/CIFS file system. | | 948 | Includes code for the SMB/CIFS file system. |
943 | See | | 949 | See |
944 | .Xr mount_smbfs 8 | | 950 | .Xr mount_smbfs 8 |
945 | for details. | | 951 | for details. |
946 | .Em NOTE : | | 952 | .Em NOTE : |
947 | You also need to enable the pseudo-device, nsmb, for the SMB | | 953 | You also need to enable the pseudo-device, nsmb, for the SMB |
948 | file system to work. | | 954 | file system to work. |
949 | .It Cd file-system PTYFS | | 955 | .It Cd file-system PTYFS |
950 | .Bq Em EXPERIMENTAL | | 956 | .Bq Em EXPERIMENTAL |
951 | Includes code for a special file system (normally mounted on | | 957 | Includes code for a special file system (normally mounted on |
952 | .Pa /dev/pts ) | | 958 | .Pa /dev/pts ) |
953 | in which pseudo-terminal slave devices become visible in the file system. | | 959 | in which pseudo-terminal slave devices become visible in the file system. |
954 | See | | 960 | See |
955 | .Xr mount_ptyfs 8 | | 961 | .Xr mount_ptyfs 8 |
956 | for details. | | 962 | for details. |
957 | .It Cd file-system TMPFS | | 963 | .It Cd file-system TMPFS |
958 | Includes code for the efficient memory file system, normally used over | | 964 | Includes code for the efficient memory file system, normally used over |
959 | .Pa /tmp . | | 965 | .Pa /tmp . |
960 | See | | 966 | See |
961 | .Xr mount_tmpfs 8 | | 967 | .Xr mount_tmpfs 8 |
962 | for details. | | 968 | for details. |
963 | .It Cd file-system PUFFS | | 969 | .It Cd file-system PUFFS |
964 | Includes kernel support for the pass-to-userspace framework file system. | | 970 | Includes kernel support for the pass-to-userspace framework file system. |
965 | It can be used to implement file system functionality in userspace. | | 971 | It can be used to implement file system functionality in userspace. |
966 | See | | 972 | See |
967 | .Xr puffs 3 | | 973 | .Xr puffs 3 |
968 | for more details. | | 974 | for more details. |
969 | This enables for example sshfs: | | 975 | This enables for example sshfs: |
970 | .Xr mount_psshfs 8 . | | 976 | .Xr mount_psshfs 8 . |
971 | .El | | 977 | .El |
972 | .Ss File System Options | | 978 | .Ss File System Options |
973 | .Bl -ohang | | 979 | .Bl -ohang |
974 | .It Cd options DISKLABEL_EI | | 980 | .It Cd options DISKLABEL_EI |
975 | Enable | | 981 | Enable |
976 | .Dq Endian-Independent | | 982 | .Dq Endian-Independent |
977 | .Xr disklabel 5 | | 983 | .Xr disklabel 5 |
978 | support. | | 984 | support. |
979 | This allows a system to recognize a disklabel written in the other byte order. | | 985 | This allows a system to recognize a disklabel written in the other byte order. |
980 | For writing, when a label already exists, its byte order is preserved. | | 986 | For writing, when a label already exists, its byte order is preserved. |
981 | Otherwise, a new label is written in the native byte order. | | 987 | Otherwise, a new label is written in the native byte order. |
982 | To specify the byte order explicitly, the | | 988 | To specify the byte order explicitly, the |
983 | .Fl F | | 989 | .Fl F |
984 | option of | | 990 | option of |
985 | .Xr disklabel 8 | | 991 | .Xr disklabel 8 |
986 | should be used with the | | 992 | should be used with the |
987 | .Fl B | | 993 | .Fl B |
988 | option in order to avoid using | | 994 | option in order to avoid using |
989 | .Xr ioctl 2 , | | 995 | .Xr ioctl 2 , |
990 | which results in the default behavior explained above. | | 996 | which results in the default behavior explained above. |
991 | At the moment this option is restricted to the following ports: | | 997 | At the moment this option is restricted to the following ports: |
992 | amd64, bebox, emips, epoc32, evbarm, i386, ibmnws, landisk, mvmeppc, prep, | | 998 | amd64, bebox, emips, epoc32, evbarm, i386, ibmnws, landisk, mvmeppc, prep, |
993 | .\" riscv, | | 999 | .\" riscv, |
994 | rs6000, sandpoint, | | 1000 | rs6000, sandpoint, |
995 | .\" usermode, | | 1001 | .\" usermode, |
996 | xen, and zaurus; | | 1002 | xen, and zaurus; |
997 | also to machines of the | | 1003 | also to machines of the |
998 | .\" evbarm64, | | 1004 | .\" evbarm64, |
999 | evbmips and evbppc ports that support | | 1005 | evbmips and evbppc ports that support |
1000 | Master Boot Record (MBR). | | 1006 | Master Boot Record (MBR). |
1001 | .It Cd options MAGICLINKS | | 1007 | .It Cd options MAGICLINKS |
1002 | Enables the expansion of special strings | | 1008 | Enables the expansion of special strings |
1003 | .Po | | 1009 | .Po |
1004 | beginning with | | 1010 | beginning with |
1005 | .Dq @ | | 1011 | .Dq @ |
1006 | .Pc | | 1012 | .Pc |
1007 | when traversing symbolic links. | | 1013 | when traversing symbolic links. |
1008 | See | | 1014 | See |
1009 | .Xr symlink 7 | | 1015 | .Xr symlink 7 |
1010 | for a list of supported strings. | | 1016 | for a list of supported strings. |
1011 | Note that this option only controls the enabling of this feature | | 1017 | Note that this option only controls the enabling of this feature |
1012 | by the kernel at boot-up. | | 1018 | by the kernel at boot-up. |
1013 | This feature can still be manipulated with the | | 1019 | This feature can still be manipulated with the |
1014 | .Xr sysctl 8 | | 1020 | .Xr sysctl 8 |
1015 | command regardless of the setting of this option. | | 1021 | command regardless of the setting of this option. |
1016 | .It Cd options NFSSERVER | | 1022 | .It Cd options NFSSERVER |
1017 | Include the server side of the | | 1023 | Include the server side of the |
1018 | .Em NFS | | 1024 | .Em NFS |
1019 | (Network File System) remote file sharing protocol. | | 1025 | (Network File System) remote file sharing protocol. |
1020 | Although the bulk of the code implementing | | 1026 | Although the bulk of the code implementing |
1021 | .Em NFS | | 1027 | .Em NFS |
1022 | is kernel based, several user level daemons are needed for it to | | 1028 | is kernel based, several user level daemons are needed for it to |
1023 | work. | | 1029 | work. |
1024 | See | | 1030 | See |
1025 | .Xr mountd 8 | | 1031 | .Xr mountd 8 |
1026 | and | | 1032 | and |
1027 | .Xr nfsd 8 | | 1033 | .Xr nfsd 8 |
1028 | for details. | | 1034 | for details. |
1029 | .It Cd options NVNODE=integer | | 1035 | .It Cd options NVNODE=integer |
1030 | This option sets the size of the cache used by the name-to-inode translation | | 1036 | This option sets the size of the cache used by the name-to-inode translation |
1031 | routines, (a.k.a. the | | 1037 | routines, (a.k.a. the |
1032 | .Fn namei | | 1038 | .Fn namei |
1033 | cache, though called by many other names in the kernel source). | | 1039 | cache, though called by many other names in the kernel source). |
1034 | By default, this cache has | | 1040 | By default, this cache has |
1035 | .Dv (NPROC + NTEXT + 100) | | 1041 | .Dv (NPROC + NTEXT + 100) |
1036 | entries (NPROC set as 20 + 16 * MAXUSERS and NTEXT as 80 + NPROC / 8). | | 1042 | entries (NPROC set as 20 + 16 * MAXUSERS and NTEXT as 80 + NPROC / 8). |
1037 | A reasonable way to derive a value of | | 1043 | A reasonable way to derive a value of |
1038 | .Dv NVNODE , | | 1044 | .Dv NVNODE , |
1039 | should you notice a large number of namei cache misses with a tool such as | | 1045 | should you notice a large number of namei cache misses with a tool such as |
1040 | .Xr systat 1 , | | 1046 | .Xr systat 1 , |
1041 | is to examine your system's current computed value with | | 1047 | is to examine your system's current computed value with |
1042 | .Xr sysctl 8 , | | 1048 | .Xr sysctl 8 , |
1043 | (which calls this parameter "kern.maxvnodes") and to increase this value | | 1049 | (which calls this parameter "kern.maxvnodes") and to increase this value |
1044 | until either the namei cache hit rate improves or it is determined that | | 1050 | until either the namei cache hit rate improves or it is determined that |
1045 | your system does not benefit substantially from an increase in the size of | | 1051 | your system does not benefit substantially from an increase in the size of |
1046 | the namei cache. | | 1052 | the namei cache. |
1047 | .It Cd options NAMECACHE_ENTER_REVERSE | | 1053 | .It Cd options NAMECACHE_ENTER_REVERSE |
1048 | Causes the namei cache to always enter a reverse mapping (vnode -\*[Gt] name) | | 1054 | Causes the namei cache to always enter a reverse mapping (vnode -\*[Gt] name) |
1049 | as well as a normal one. | | 1055 | as well as a normal one. |
1050 | Normally, this is already done for directory vnodes, to speed up the getcwd | | 1056 | Normally, this is already done for directory vnodes, to speed up the getcwd |
1051 | operation. | | 1057 | operation. |
1052 | This option will cause longer hash chains in the reverse cache, and thus | | 1058 | This option will cause longer hash chains in the reverse cache, and thus |
1053 | slow down getcwd somewhat. | | 1059 | slow down getcwd somewhat. |
1054 | However, it does make vnode -\*[Gt] path translations possible in some cases. | | 1060 | However, it does make vnode -\*[Gt] path translations possible in some cases. |
1055 | For now, only useful if strict | | 1061 | For now, only useful if strict |
1056 | .Pa /proc/#/maps | | 1062 | .Pa /proc/#/maps |
1057 | emulation for Linux binaries is required. | | 1063 | emulation for Linux binaries is required. |
1058 | .El | | 1064 | .El |
1059 | .Ss Options for FFS/UFS File Systems | | 1065 | .Ss Options for FFS/UFS File Systems |
1060 | .Bl -ohang | | 1066 | .Bl -ohang |
1061 | .It Cd options WAPBL | | 1067 | .It Cd options WAPBL |
1062 | Enable | | 1068 | Enable |
1063 | .Dq Write Ahead Physical Block Logging file system journaling . | | 1069 | .Dq Write Ahead Physical Block Logging file system journaling . |
1064 | This provides rapid file system consistency checking after a system outage. | | 1070 | This provides rapid file system consistency checking after a system outage. |
1065 | It also provides better general use performance over regular FFS. | | 1071 | It also provides better general use performance over regular FFS. |
1066 | See also | | 1072 | See also |
1067 | .Xr wapbl 4 . | | 1073 | .Xr wapbl 4 . |
1068 | .It Cd options QUOTA | | 1074 | .It Cd options QUOTA |
1069 | Enables kernel support for traditional quotas in FFS. | | 1075 | Enables kernel support for traditional quotas in FFS. |
1070 | Traditional quotas store the quota information in external files and | | 1076 | Traditional quotas store the quota information in external files and |
1071 | require | | 1077 | require |
1072 | .Xr quotacheck 8 | | 1078 | .Xr quotacheck 8 |
1073 | and | | 1079 | and |
1074 | .Xr quotaon 8 | | 1080 | .Xr quotaon 8 |
1075 | at boot time. | | 1081 | at boot time. |
1076 | Traditional quotas are limited to 32-bit sizes and are at this point | | 1082 | Traditional quotas are limited to 32-bit sizes and are at this point |
1077 | considered a legacy feature. | | 1083 | considered a legacy feature. |
1078 | .It Cd options QUOTA2 | | 1084 | .It Cd options QUOTA2 |
1079 | Enables kernel support for in-volume quotas in FFS. | | 1085 | Enables kernel support for in-volume quotas in FFS. |
1080 | The quota information is file system metadata maintained by | | 1086 | The quota information is file system metadata maintained by |
1081 | .Xr fsck 8 | | 1087 | .Xr fsck 8 |
1082 | and/or WAPBL journaling. | | 1088 | and/or WAPBL journaling. |
1083 | MFS volumes can also use | | 1089 | MFS volumes can also use |
1084 | .Dv QUOTA2 | | 1090 | .Dv QUOTA2 |
1085 | quotas; see | | 1091 | quotas; see |
1086 | .Xr mount_mfs 8 | | 1092 | .Xr mount_mfs 8 |
1087 | for more information. | | 1093 | for more information. |
1088 | .It Cd options FFS_EI | | 1094 | .It Cd options FFS_EI |
1089 | Enable | | 1095 | Enable |
1090 | .Dq Endian-Independent | | 1096 | .Dq Endian-Independent |
1091 | FFS support. | | 1097 | FFS support. |
1092 | This allows a system to mount an FFS file system created for another | | 1098 | This allows a system to mount an FFS file system created for another |
1093 | architecture, at a small performance cost for all FFS file systems. | | 1099 | architecture, at a small performance cost for all FFS file systems. |
1094 | See also | | 1100 | See also |
1095 | .Xr newfs 8 , | | 1101 | .Xr newfs 8 , |
1096 | .Xr fsck_ffs 8 , | | 1102 | .Xr fsck_ffs 8 , |
1097 | .Xr dumpfs 8 | | 1103 | .Xr dumpfs 8 |
1098 | for file system byte order status and manipulation. | | 1104 | for file system byte order status and manipulation. |
1099 | .It Cd options FFS_NO_SNAPSHOT | | 1105 | .It Cd options FFS_NO_SNAPSHOT |
1100 | Disable support for the creation of file system internal snapshot | | 1106 | Disable support for the creation of file system internal snapshot |
1101 | of FFS file systems. | | 1107 | of FFS file systems. |
1102 | Maybe useful for install media kernels, small memory systems and | | 1108 | Maybe useful for install media kernels, small memory systems and |
1103 | embedded systems which don't require the snapshot support. | | 1109 | embedded systems which don't require the snapshot support. |
1104 | .It Cd options UFS_EXTATTR | | 1110 | .It Cd options UFS_EXTATTR |
1105 | Enable extended attribute support for UFS1 file systems. | | 1111 | Enable extended attribute support for UFS1 file systems. |
1106 | .It Cd options UFS_DIRHASH | | 1112 | .It Cd options UFS_DIRHASH |
1107 | Increase lookup performance by maintaining in-core hash tables | | 1113 | Increase lookup performance by maintaining in-core hash tables |
1108 | for large directories. | | 1114 | for large directories. |
1109 | .El | | 1115 | .El |
1110 | .Ss Options for the LFS File System | | 1116 | .Ss Options for the LFS File System |
1111 | .Bl -ohang | | 1117 | .Bl -ohang |
1112 | .\" .It Cd options LFS_KERNEL_RFW | | 1118 | .\" .It Cd options LFS_KERNEL_RFW |
1113 | .\" There is no documentation for this. (XXX) | | 1119 | .\" There is no documentation for this. (XXX) |
1114 | .\" .It Cd options LFS_QUOTA | | 1120 | .\" .It Cd options LFS_QUOTA |
1115 | .\" Enable traditional quota support for LFS. | | 1121 | .\" Enable traditional quota support for LFS. |
1116 | .\" (It is not clear if this works.) | | 1122 | .\" (It is not clear if this works.) |
1117 | .\" .It Cd options LFS_QUOTA2 | | 1123 | .\" .It Cd options LFS_QUOTA2 |
1118 | .\" Enable modernized 64-bit quota support for LFS. | | 1124 | .\" Enable modernized 64-bit quota support for LFS. |
1119 | .\" (This does not work yet.) | | 1125 | .\" (This does not work yet.) |
1120 | .It Cd options LFS_EI | | 1126 | .It Cd options LFS_EI |
1121 | Enable | | 1127 | Enable |
1122 | .Dq Endian-Independent | | 1128 | .Dq Endian-Independent |
1123 | LFS support. | | 1129 | LFS support. |
1124 | This allows (at a small performance cost) mounting an LFS file system | | 1130 | This allows (at a small performance cost) mounting an LFS file system |
1125 | created for another architecture. | | 1131 | created for another architecture. |
1126 | .\" .It Cd options LFS_EXTATTR | | 1132 | .\" .It Cd options LFS_EXTATTR |
1127 | .\" Enable extended attribute support for LFS. | | 1133 | .\" Enable extended attribute support for LFS. |
1128 | .\" (It is not clear if this works.) | | 1134 | .\" (It is not clear if this works.) |
1129 | .It Cd options LFS_DIRHASH | | 1135 | .It Cd options LFS_DIRHASH |
1130 | Increase lookup performance by maintaining in-core hash tables | | 1136 | Increase lookup performance by maintaining in-core hash tables |
1131 | for large directories. | | 1137 | for large directories. |
1132 | .El | | 1138 | .El |
1133 | .Ss Options for the ext2fs File System | | 1139 | .Ss Options for the ext2fs File System |
1134 | .Bl -ohang | | 1140 | .Bl -ohang |
1135 | .It Cd options EXT2FS_SYSTEM_FLAGS | | 1141 | .It Cd options EXT2FS_SYSTEM_FLAGS |
1136 | This option changes the behavior of the APPEND and IMMUTABLE flags | | 1142 | This option changes the behavior of the APPEND and IMMUTABLE flags |
1137 | for a file on an | | 1143 | for a file on an |
1138 | .Em ext2 | | 1144 | .Em ext2 |
1139 | file system. | | 1145 | file system. |
1140 | Without this option, the superuser or owner of the file can | | 1146 | Without this option, the superuser or owner of the file can |
1141 | set and clear them. | | 1147 | set and clear them. |
1142 | With this option, only the superuser can set them, and | | 1148 | With this option, only the superuser can set them, and |
1143 | they can't be cleared if the securelevel is greater than 0. | | 1149 | they can't be cleared if the securelevel is greater than 0. |
1144 | See also | | 1150 | See also |
1145 | .Xr chflags 1 | | 1151 | .Xr chflags 1 |
1146 | and | | 1152 | and |
1147 | .Xr secmodel_securelevel 9 . | | 1153 | .Xr secmodel_securelevel 9 . |
1148 | .El | | 1154 | .El |
1149 | .Ss Options for the NFS File System | | 1155 | .Ss Options for the NFS File System |
1150 | .Bl -ohang | | 1156 | .Bl -ohang |
1151 | .It Cd options NFS_BOOT_BOOTP | | 1157 | .It Cd options NFS_BOOT_BOOTP |
1152 | Enable use of the BOOTP protocol (RFCs 951 and 1048) to get configuration | | 1158 | Enable use of the BOOTP protocol (RFCs 951 and 1048) to get configuration |
1153 | information if NFS is used to mount the root file system. | | 1159 | information if NFS is used to mount the root file system. |
1154 | See | | 1160 | See |
1155 | .Xr diskless 8 | | 1161 | .Xr diskless 8 |
1156 | for details. | | 1162 | for details. |
1157 | .It Cd options NFS_BOOT_BOOTSTATIC | | 1163 | .It Cd options NFS_BOOT_BOOTSTATIC |
1158 | Enable use of static values defined as | | 1164 | Enable use of static values defined as |
1159 | .Dq NFS_BOOTSTATIC_MYIP , | | 1165 | .Dq NFS_BOOTSTATIC_MYIP , |
1160 | .Dq NFS_BOOTSTATIC_GWIP , | | 1166 | .Dq NFS_BOOTSTATIC_GWIP , |
1161 | .Dq NFS_BOOTSTATIC_SERVADDR , | | 1167 | .Dq NFS_BOOTSTATIC_SERVADDR , |
1162 | and | | 1168 | and |
1163 | .Dq NFS_BOOTSTATIC_SERVER | | 1169 | .Dq NFS_BOOTSTATIC_SERVER |
1164 | in kernel options to get configuration information | | 1170 | in kernel options to get configuration information |
1165 | if NFS is used to mount the root file system. | | 1171 | if NFS is used to mount the root file system. |
1166 | .It Cd options NFS_BOOT_DHCP | | 1172 | .It Cd options NFS_BOOT_DHCP |
1167 | Same as | | 1173 | Same as |
1168 | .Dq NFS_BOOT_BOOTP , | | 1174 | .Dq NFS_BOOT_BOOTP , |
1169 | but use the DHCP extensions to the | | 1175 | but use the DHCP extensions to the |
1170 | BOOTP protocol (RFC 1541). | | 1176 | BOOTP protocol (RFC 1541). |
1171 | .It Cd options NFS_BOOT_BOOTP_REQFILE | | 1177 | .It Cd options NFS_BOOT_BOOTP_REQFILE |
1172 | Specifies the string sent in the bp_file field of the BOOTP/DHCP | | 1178 | Specifies the string sent in the bp_file field of the BOOTP/DHCP |
1173 | request packet. | | 1179 | request packet. |
1174 | .It Cd options NFS_BOOT_BOOTPARAM | | 1180 | .It Cd options NFS_BOOT_BOOTPARAM |
1175 | Enable use of the BOOTPARAM protocol, consisting of RARP and | | 1181 | Enable use of the BOOTPARAM protocol, consisting of RARP and |
1176 | BOOTPARAM RPC, to get configuration information if NFS | | 1182 | BOOTPARAM RPC, to get configuration information if NFS |
1177 | is used to mount the root file system. | | 1183 | is used to mount the root file system. |
1178 | See | | 1184 | See |
1179 | .Xr diskless 8 | | 1185 | .Xr diskless 8 |
1180 | for details. | | 1186 | for details. |
1181 | .It Cd options NFS_BOOT_RWSIZE=value | | 1187 | .It Cd options NFS_BOOT_RWSIZE=value |
1182 | Set the initial NFS read and write sizes for diskless-boot requests. | | 1188 | Set the initial NFS read and write sizes for diskless-boot requests. |
1183 | The normal default is 8Kbytes. | | 1189 | The normal default is 8Kbytes. |
1184 | This option provides a way to lower the value (e.g., to 1024 bytes) | | 1190 | This option provides a way to lower the value (e.g., to 1024 bytes) |
1185 | as a workaround for buggy network interface cards or boot PROMs. | | 1191 | as a workaround for buggy network interface cards or boot PROMs. |
1186 | Once booted, the read and write request sizes can be increased by | | 1192 | Once booted, the read and write request sizes can be increased by |
1187 | remounting the file system. | | 1193 | remounting the file system. |
1188 | See | | 1194 | See |
1189 | .Xr mount_nfs 8 | | 1195 | .Xr mount_nfs 8 |
1190 | for details. | | 1196 | for details. |
1191 | .It Cd options NFS_V2_ONLY | | 1197 | .It Cd options NFS_V2_ONLY |
1192 | Reduce the size of the NFS client code by omitting code that's only required | | 1198 | Reduce the size of the NFS client code by omitting code that's only required |
1193 | for NFSv3 and NQNFS support, leaving only that code required to use NFSv2 | | 1199 | for NFSv3 and NQNFS support, leaving only that code required to use NFSv2 |
1194 | servers. | | 1200 | servers. |
1195 | .It Cd options NFS_BOOT_TCP | | 1201 | .It Cd options NFS_BOOT_TCP |
1196 | Use NFS over TCP instead of the default UDP, for mounting root. | | 1202 | Use NFS over TCP instead of the default UDP, for mounting root. |
1197 | .El | | 1203 | .El |
1198 | .Ss Buffer queue strategy options | | 1204 | .Ss Buffer queue strategy options |
1199 | The following options enable alternative buffer queue strategies. | | 1205 | The following options enable alternative buffer queue strategies. |
1200 | .Bl -ohang | | 1206 | .Bl -ohang |
1201 | .It Cd options BUFQ_READPRIO | | 1207 | .It Cd options BUFQ_READPRIO |
1202 | Enable experimental buffer queue strategy for disk I/O. | | 1208 | Enable experimental buffer queue strategy for disk I/O. |
1203 | In the default strategy, outstanding disk requests are ordered by | | 1209 | In the default strategy, outstanding disk requests are ordered by |
1204 | sector number and sent to the disk, regardless of whether the | | 1210 | sector number and sent to the disk, regardless of whether the |
1205 | operation is a read or write; this option gives priority to issuing | | 1211 | operation is a read or write; this option gives priority to issuing |
1206 | read requests over write requests. | | 1212 | read requests over write requests. |
1207 | Although requests may therefore be issued out of sector-order, causing | | 1213 | Although requests may therefore be issued out of sector-order, causing |
1208 | more seeks and thus lower overall throughput, interactive system | | 1214 | more seeks and thus lower overall throughput, interactive system |
1209 | responsiveness under heavy disk I/O load may be improved, as processes | | 1215 | responsiveness under heavy disk I/O load may be improved, as processes |
1210 | blocking on disk reads are serviced sooner (file writes typically | | 1216 | blocking on disk reads are serviced sooner (file writes typically |
1211 | don't cause applications to block). | | 1217 | don't cause applications to block). |
1212 | The performance effect varies greatly depending on the hardware, drive | | 1218 | The performance effect varies greatly depending on the hardware, drive |
1213 | firmware, file system configuration, workload, and desired performance | | 1219 | firmware, file system configuration, workload, and desired performance |
1214 | trade-off. | | 1220 | trade-off. |
1215 | Systems using drive write-cache (most modern IDE disks, by default) | | 1221 | Systems using drive write-cache (most modern IDE disks, by default) |
1216 | are unlikely to benefit and may well suffer; such disks acknowledge | | 1222 | are unlikely to benefit and may well suffer; such disks acknowledge |
1217 | writes very quickly, and optimize them internally according to | | 1223 | writes very quickly, and optimize them internally according to |
1218 | physical layout. | | 1224 | physical layout. |
1219 | Giving these disks as many requests to work with as possible (the | | 1225 | Giving these disks as many requests to work with as possible (the |
1220 | standard strategy) will typically produce the best results, especially | | 1226 | standard strategy) will typically produce the best results, especially |
1221 | if the drive has a large cache; the drive will silently complete | | 1227 | if the drive has a large cache; the drive will silently complete |
1222 | writes from cache as it seeks for reads. | | 1228 | writes from cache as it seeks for reads. |
1223 | Disks that support a large number of concurrent tagged requests (SCSI | | 1229 | Disks that support a large number of concurrent tagged requests (SCSI |
1224 | disks and many hardware RAID controllers) expose this internal | | 1230 | disks and many hardware RAID controllers) expose this internal |
1225 | scheduling with tagged responses, and don't block for reads; such | | 1231 | scheduling with tagged responses, and don't block for reads; such |
1226 | disks may not see a noticeable difference with either strategy. | | 1232 | disks may not see a noticeable difference with either strategy. |
1227 | However, if IDE disks are run with write-cache disabled for safety, | | 1233 | However, if IDE disks are run with write-cache disabled for safety, |
1228 | writes are not acknowledged until actually completed, and only one | | 1234 | writes are not acknowledged until actually completed, and only one |
1229 | request can be outstanding; a large number of small writes in one | | 1235 | request can be outstanding; a large number of small writes in one |
1230 | locality can keep the disk busy, starving reads elsewhere on the disk. | | 1236 | locality can keep the disk busy, starving reads elsewhere on the disk. |
1231 | Such systems are likely to see the most benefit from this option. | | 1237 | Such systems are likely to see the most benefit from this option. |
1232 | Finally, the performance interaction of this option with ffs soft | | 1238 | Finally, the performance interaction of this option with ffs soft |
1233 | dependencies can be subtle, as that mechanism can drastically alter | | 1239 | dependencies can be subtle, as that mechanism can drastically alter |
1234 | the workload for file system metadata writes. | | 1240 | the workload for file system metadata writes. |
1235 | .It Cd options BUFQ_PRIOCSCAN | | 1241 | .It Cd options BUFQ_PRIOCSCAN |
1236 | Enable another buffer queue strategy for disk I/O, per-priority cyclical scan. | | 1242 | Enable another buffer queue strategy for disk I/O, per-priority cyclical scan. |
1237 | .It Cd options NEW_BUFQ_STRATEGY | | 1243 | .It Cd options NEW_BUFQ_STRATEGY |
1238 | Synonym of | | 1244 | Synonym of |
1239 | .Em BUFQ_READPRIO . | | 1245 | .Em BUFQ_READPRIO . |
1240 | .El | | 1246 | .El |
1241 | .Ss Miscellaneous Options | | 1247 | .Ss Miscellaneous Options |
1242 | .Bl -ohang | | 1248 | .Bl -ohang |
1243 | .It Cd options CPU_UCODE | | 1249 | .It Cd options CPU_UCODE |
1244 | Support cpu microcode loading via | | 1250 | Support cpu microcode loading via |
1245 | .Xr cpuctl 8 . | | 1251 | .Xr cpuctl 8 . |
1246 | .It Cd options MEMORY_DISK_DYNAMIC | | 1252 | .It Cd options MEMORY_DISK_DYNAMIC |
1247 | This option makes the | | 1253 | This option makes the |
1248 | .Xr md 4 | | 1254 | .Xr md 4 |
1249 | .Tn RAM | | 1255 | .Tn RAM |
1250 | disk size dynamically sized. | | 1256 | disk size dynamically sized. |
1251 | It is incompatible with | | 1257 | It is incompatible with |
1252 | .Xr mdsetimage 8 . | | 1258 | .Xr mdsetimage 8 . |
1253 | .It Cd options MEMORY_DISK_HOOKS | | 1259 | .It Cd options MEMORY_DISK_HOOKS |
1254 | This option allows for some machine dependent functions to be called when | | 1260 | This option allows for some machine dependent functions to be called when |
1255 | the | | 1261 | the |
1256 | .Xr md 4 | | 1262 | .Xr md 4 |
1257 | .Tn RAM | | 1263 | .Tn RAM |
1258 | disk driver is configured. | | 1264 | disk driver is configured. |
1259 | This can result in automatically loading a | | 1265 | This can result in automatically loading a |
1260 | .Tn RAM | | 1266 | .Tn RAM |
1261 | disk from floppy on open (among other things). | | 1267 | disk from floppy on open (among other things). |
1262 | .It Cd options MEMORY_DISK_IS_ROOT | | 1268 | .It Cd options MEMORY_DISK_IS_ROOT |
1263 | Forces the | | 1269 | Forces the |
1264 | .Xr md 4 | | 1270 | .Xr md 4 |
1265 | .Tn RAM | | 1271 | .Tn RAM |
1266 | disk to be the root device. | | 1272 | disk to be the root device. |
1267 | This can only be overridden when | | 1273 | This can only be overridden when |
1268 | the kernel is booted in the 'ask-for-root' mode. | | 1274 | the kernel is booted in the 'ask-for-root' mode. |
1269 | .It Cd options MEMORY_DISK_ROOT_SIZE=integer | | 1275 | .It Cd options MEMORY_DISK_ROOT_SIZE=integer |
1270 | Allocates the given number of 512 byte blocks as memory for the | | 1276 | Allocates the given number of 512 byte blocks as memory for the |
1271 | .Xr md 4 | | 1277 | .Xr md 4 |
1272 | .Tn RAM | | 1278 | .Tn RAM |
1273 | disk, to be populated with | | 1279 | disk, to be populated with |
1274 | .Xr mdsetimage 8 . | | 1280 | .Xr mdsetimage 8 . |
1275 | .It Cd options MEMORY_DISK_SERVER=0 | | 1281 | .It Cd options MEMORY_DISK_SERVER=0 |
1276 | Do not include the interface to a userland memory disk server process. | | 1282 | Do not include the interface to a userland memory disk server process. |
1277 | Per default, this option is set to 1, including the support code. | | 1283 | Per default, this option is set to 1, including the support code. |
1278 | Useful for install media kernels. | | 1284 | Useful for install media kernels. |
1279 | .It Cd options MEMORY_DISK_RBFLAGS=value | | 1285 | .It Cd options MEMORY_DISK_RBFLAGS=value |
1280 | This option sets the | | 1286 | This option sets the |
1281 | .Xr reboot 2 | | 1287 | .Xr reboot 2 |
1282 | flags used when booting with a memory disk as root file system. | | 1288 | flags used when booting with a memory disk as root file system. |
1283 | Possible values include | | 1289 | Possible values include |
1284 | .Dv RB_AUTOBOOT | | 1290 | .Dv RB_AUTOBOOT |
1285 | (boot in the usual fashion - default value), and | | 1291 | (boot in the usual fashion - default value), and |
1286 | .Dv RB_SINGLE | | 1292 | .Dv RB_SINGLE |
1287 | (boot in single-user mode). | | 1293 | (boot in single-user mode). |
1288 | .It Cd options MODULAR | | 1294 | .It Cd options MODULAR |
1289 | Enables the framework for kernel modules (see | | 1295 | Enables the framework for kernel modules (see |
1290 | .Xr module 7 ) . | | 1296 | .Xr module 7 ) . |
1291 | .It Cd options MODULAR_DEFAULT_AUTOLOAD | | 1297 | .It Cd options MODULAR_DEFAULT_AUTOLOAD |
1292 | Enables the autoloading of kernel modules by default. | | 1298 | Enables the autoloading of kernel modules by default. |
1293 | This sets the default value of the | | 1299 | This sets the default value of the |
1294 | .Em kern.module.autoload | | 1300 | .Em kern.module.autoload |
1295 | .Xr sysctl 3 | | 1301 | .Xr sysctl 3 |
1296 | variable which may be changed at run time. | | 1302 | variable which may be changed at run time. |
1297 | .It Cd options VND_COMPRESSION | | 1303 | .It Cd options VND_COMPRESSION |
1298 | Enables the | | 1304 | Enables the |
1299 | .Xr vnd 4 | | 1305 | .Xr vnd 4 |
1300 | driver to also handle compressed images. | | 1306 | driver to also handle compressed images. |
1301 | See | | 1307 | See |
1302 | .Xr vndcompress 1 , | | 1308 | .Xr vndcompress 1 , |
1303 | .Xr vnd 4 | | 1309 | .Xr vnd 4 |
1304 | and | | 1310 | and |
1305 | .Xr vnconfig 8 | | 1311 | .Xr vnconfig 8 |
1306 | for more information. | | 1312 | for more information. |
1307 | .It Cd options SPLDEBUG | | 1313 | .It Cd options SPLDEBUG |
1308 | Help the kernel programmer find bugs related to the interrupt priority | | 1314 | Help the kernel programmer find bugs related to the interrupt priority |
1309 | level. | | 1315 | level. |
1310 | When | | 1316 | When |
1311 | .Fn spllower | | 1317 | .Fn spllower |
1312 | or | | 1318 | or |
1313 | .Fn splraise | | 1319 | .Fn splraise |
1314 | changes the current CPU's interrupt priority level to or from | | 1320 | changes the current CPU's interrupt priority level to or from |
1315 | .Dv IPL_HIGH , | | 1321 | .Dv IPL_HIGH , |
1316 | record a backtrace. | | 1322 | record a backtrace. |
1317 | Read | | 1323 | Read |
1318 | .Xr return_address 9 | | 1324 | .Xr return_address 9 |
1319 | for caveats about collecting backtraces. | | 1325 | for caveats about collecting backtraces. |
1320 | This feature is experimental, and it is only available on i386. | | 1326 | This feature is experimental, and it is only available on i386. |
1321 | See | | 1327 | See |
1322 | .Pa sys/kern/subr_spldebug.c . | | 1328 | .Pa sys/kern/subr_spldebug.c . |
1323 | .It Cd options TFTPROOT | | 1329 | .It Cd options TFTPROOT |
1324 | Download the root memory disk through TFTP at root mount time. | | 1330 | Download the root memory disk through TFTP at root mount time. |
1325 | This enables the use of a root | | 1331 | This enables the use of a root |
1326 | .Tn RAM | | 1332 | .Tn RAM |
1327 | disk without requiring it to be embedded in the kernel using | | 1333 | disk without requiring it to be embedded in the kernel using |
1328 | .Xr mdsetimage 8 . | | 1334 | .Xr mdsetimage 8 . |
1329 | The | | 1335 | The |
1330 | .Tn RAM | | 1336 | .Tn RAM |
1331 | disk name is obtained using DHCP's filename parameter. | | 1337 | disk name is obtained using DHCP's filename parameter. |
1332 | This option requires | | 1338 | This option requires |
1333 | .Em MEMORY_DISK_HOOKS , | | 1339 | .Em MEMORY_DISK_HOOKS , |
1334 | .Em MEMORY_DISK_DYNAMIC , | | 1340 | .Em MEMORY_DISK_DYNAMIC , |
1335 | and | | 1341 | and |
1336 | .Em MEMORY_DISK_IS_ROOT . | | 1342 | .Em MEMORY_DISK_IS_ROOT . |
1337 | It is incompatible with | | 1343 | It is incompatible with |
1338 | .Em MEMORY_DISK_ROOT_SIZE . | | 1344 | .Em MEMORY_DISK_ROOT_SIZE . |
1339 | .It Cd options HZ=integer | | 1345 | .It Cd options HZ=integer |
1340 | On ports that support it, set the system clock frequency (see | | 1346 | On ports that support it, set the system clock frequency (see |
1341 | .Xr hz 9 ) | | 1347 | .Xr hz 9 ) |
1342 | to the supplied value. | | 1348 | to the supplied value. |
1343 | Handle with care. | | 1349 | Handle with care. |
1344 | .It Cd options NTP | | 1350 | .It Cd options NTP |
1345 | Turns on in-kernel precision timekeeping support used by software | | 1351 | Turns on in-kernel precision timekeeping support used by software |
1346 | implementing | | 1352 | implementing |
1347 | .Em NTP | | 1353 | .Em NTP |
1348 | (Network Time Protocol, RFC 1305). | | 1354 | (Network Time Protocol, RFC 1305). |
1349 | The | | 1355 | The |
1350 | .Em NTP | | 1356 | .Em NTP |
1351 | option adds an in-kernel Phase-Locked Loop (PLL) for normal | | 1357 | option adds an in-kernel Phase-Locked Loop (PLL) for normal |
1352 | .Em NTP | | 1358 | .Em NTP |
1353 | operation, and a Frequency-Locked Loop (FLL) for intermittently-connected | | 1359 | operation, and a Frequency-Locked Loop (FLL) for intermittently-connected |
1354 | operation. | | 1360 | operation. |
1355 | .Xr ntpd 8 | | 1361 | .Xr ntpd 8 |
1356 | will employ a user-level PLL when kernel support is unavailable, | | 1362 | will employ a user-level PLL when kernel support is unavailable, |
1357 | but the in-kernel version has lower latency and more precision, and | | 1363 | but the in-kernel version has lower latency and more precision, and |
1358 | so typically keeps much better time. | | 1364 | so typically keeps much better time. |
1359 | .Pp | | 1365 | .Pp |
1360 | The interface to the kernel | | 1366 | The interface to the kernel |
1361 | .Em NTP | | 1367 | .Em NTP |
1362 | support is provided by the | | 1368 | support is provided by the |
1363 | .Xr ntp_adjtime 2 | | 1369 | .Xr ntp_adjtime 2 |
1364 | and | | 1370 | and |
1365 | .Xr ntp_gettime 2 | | 1371 | .Xr ntp_gettime 2 |
1366 | system calls, which are intended for use by | | 1372 | system calls, which are intended for use by |
1367 | .Xr ntpd 8 | | 1373 | .Xr ntpd 8 |
1368 | and are enabled by the option. | | 1374 | and are enabled by the option. |
1369 | On systems with sub-microsecond resolution timers, or where (HZ/100000) | | 1375 | On systems with sub-microsecond resolution timers, or where (HZ/100000) |
1370 | is not an integer, the | | 1376 | is not an integer, the |
1371 | .Em NTP | | 1377 | .Em NTP |
1372 | option also enables extended-precision arithmetic to keep track of | | 1378 | option also enables extended-precision arithmetic to keep track of |
1373 | fractional clock ticks at NTP time-format precision. | | 1379 | fractional clock ticks at NTP time-format precision. |
1374 | .It Cd options PPS_SYNC | | 1380 | .It Cd options PPS_SYNC |
1375 | This option enables a kernel serial line discipline for receiving time | | 1381 | This option enables a kernel serial line discipline for receiving time |
1376 | phase signals from an external reference clock such as a radio clock. | | 1382 | phase signals from an external reference clock such as a radio clock. |
1377 | .Po | | 1383 | .Po |
1378 | The | | 1384 | The |
1379 | .Em NTP | | 1385 | .Em NTP |
1380 | option (which see) must be on if the | | 1386 | option (which see) must be on if the |
1381 | .Em PPS_SYNC | | 1387 | .Em PPS_SYNC |
1382 | option is used | | 1388 | option is used |
1383 | .Pc . | | 1389 | .Pc . |
1384 | Some reference clocks generate a Pulse Per Second (PPS) signal in | | 1390 | Some reference clocks generate a Pulse Per Second (PPS) signal in |
1385 | phase with their time source. | | 1391 | phase with their time source. |
1386 | The | | 1392 | The |
1387 | .Em PPS | | 1393 | .Em PPS |
1388 | line discipline receives this signal on either the data leads | | 1394 | line discipline receives this signal on either the data leads |
1389 | or the DCD control lead of a serial port. | | 1395 | or the DCD control lead of a serial port. |
1390 | .Pp | | 1396 | .Pp |
1391 | .Em NTP | | 1397 | .Em NTP |
1392 | uses the PPS signal to discipline the local clock oscillator to a high | | 1398 | uses the PPS signal to discipline the local clock oscillator to a high |
1393 | degree of precision (typically less than 50 microseconds in time and | | 1399 | degree of precision (typically less than 50 microseconds in time and |
1394 | 0.1 ppm in accuracy). | | 1400 | 0.1 ppm in accuracy). |
1395 | .Em PPS | | 1401 | .Em PPS |
1396 | can also generate a serial output pulse when the system receives a PPS | | 1402 | can also generate a serial output pulse when the system receives a PPS |
1397 | interrupt. | | 1403 | interrupt. |
1398 | This can be used to measure the system interrupt latency and thus calibrate | | 1404 | This can be used to measure the system interrupt latency and thus calibrate |
1399 | .Em NTP | | 1405 | .Em NTP |
1400 | to account for it. | | 1406 | to account for it. |
1401 | Using | | 1407 | Using |
1402 | .Em PPS | | 1408 | .Em PPS |
1403 | usually requires a gadget box | | 1409 | usually requires a gadget box |
1404 | to convert from | | 1410 | to convert from |
1405 | .Tn TTL | | 1411 | .Tn TTL |
1406 | to | | 1412 | to |
1407 | .Tn RS-232 | | 1413 | .Tn RS-232 |
1408 | signal levels. | | 1414 | signal levels. |
1409 | The gadget box and PPS are described in more detail in the HTML documentation | | 1415 | The gadget box and PPS are described in more detail in the HTML documentation |
1410 | for | | 1416 | for |
1411 | .Xr ntpd 8 | | 1417 | .Xr ntpd 8 |
1412 | in | | 1418 | in |
1413 | .Pa /usr/share/doc/html/ntp . | | 1419 | .Pa /usr/share/doc/html/ntp . |
1414 | .Pp | | 1420 | .Pp |
1415 | .Nx | | 1421 | .Nx |
1416 | currently supports this option in | | 1422 | currently supports this option in |
1417 | .Xr com 4 | | 1423 | .Xr com 4 |
1418 | and | | 1424 | and |
1419 | .Xr zsc 4 . | | 1425 | .Xr zsc 4 . |
1420 | .It Cd options SETUIDSCRIPTS | | 1426 | .It Cd options SETUIDSCRIPTS |
1421 | Allows scripts with the setuid bit set to execute as the effective | | 1427 | Allows scripts with the setuid bit set to execute as the effective |
1422 | user rather than the real user, just like binary executables. | | 1428 | user rather than the real user, just like binary executables. |
1423 | .Pp | | 1429 | .Pp |
1424 | .Em NOTE : | | 1430 | .Em NOTE : |
1425 | Using this option will also enable | | 1431 | Using this option will also enable |
1426 | .Em options FDSCRIPTS | | 1432 | .Em options FDSCRIPTS |
1427 | .It Cd options FDSCRIPTS | | 1433 | .It Cd options FDSCRIPTS |
1428 | Allows execution of scripts with the execute bit set, but not the | | 1434 | Allows execution of scripts with the execute bit set, but not the |
1429 | read bit, by opening the file and passing the file descriptor to | | 1435 | read bit, by opening the file and passing the file descriptor to |
1430 | the shell, rather than the filename. | | 1436 | the shell, rather than the filename. |
1431 | .Pp | | 1437 | .Pp |
1432 | .Em NOTE : | | 1438 | .Em NOTE : |
1433 | Execute only (non-readable) scripts will have | | 1439 | Execute only (non-readable) scripts will have |
1434 | .Va argv[0] | | 1440 | .Va argv[0] |
1435 | set to | | 1441 | set to |
1436 | .Pa /dev/fd/* . | | 1442 | .Pa /dev/fd/* . |
1437 | What this option allows as far as security is | | 1443 | What this option allows as far as security is |
1438 | concerned, is the ability to safely ensure that the correct script | | 1444 | concerned, is the ability to safely ensure that the correct script |
1439 | is run by the interpreter, as it is passed as an already open file. | | 1445 | is run by the interpreter, as it is passed as an already open file. |
1440 | .It Cd options RTC_OFFSET=integer | | 1446 | .It Cd options RTC_OFFSET=integer |
1441 | The kernel (and typically the hardware battery backed-up clock on | | 1447 | The kernel (and typically the hardware battery backed-up clock on |
1442 | those machines that have one) keeps time in | | 1448 | those machines that have one) keeps time in |
1443 | .Em UTC | | 1449 | .Em UTC |
1444 | (Universal Coordinated Time, once known as | | 1450 | (Universal Coordinated Time, once known as |
1445 | .Em GMT , | | 1451 | .Em GMT , |
1446 | or Greenwich Mean Time) | | 1452 | or Greenwich Mean Time) |
1447 | and not in the time of the local time zone. | | 1453 | and not in the time of the local time zone. |
1448 | The | | 1454 | The |
1449 | .Em RTC_OFFSET | | 1455 | .Em RTC_OFFSET |
1450 | option is used on some ports (such as the i386) to tell the kernel | | 1456 | option is used on some ports (such as the i386) to tell the kernel |
1451 | that the hardware clock is offset from | | 1457 | that the hardware clock is offset from |
1452 | .Em UTC | | 1458 | .Em UTC |
1453 | by the specified number of minutes. | | 1459 | by the specified number of minutes. |
1454 | This is typically used when a machine boots several operating | | 1460 | This is typically used when a machine boots several operating |
1455 | systems and one of them wants the hardware clock to run in the | | 1461 | systems and one of them wants the hardware clock to run in the |
1456 | local time zone and not in | | 1462 | local time zone and not in |
1457 | .Em UTC , | | 1463 | .Em UTC , |
1458 | e.g. | | 1464 | e.g. |
1459 | .Em RTC_OFFSET=300 | | 1465 | .Em RTC_OFFSET=300 |
1460 | means | | 1466 | means |
1461 | the hardware clock is set to US Eastern Time (300 minutes behind | | 1467 | the hardware clock is set to US Eastern Time (300 minutes behind |
1462 | .Em UTC ) , | | 1468 | .Em UTC ) , |
1463 | and not | | 1469 | and not |
1464 | .Em UTC . | | 1470 | .Em UTC . |
1465 | (Note: | | 1471 | (Note: |
1466 | .Em RTC_OFFSET | | 1472 | .Em RTC_OFFSET |
1467 | is used to initialize a kernel variable named | | 1473 | is used to initialize a kernel variable named |
1468 | .Va rtc_offset | | 1474 | .Va rtc_offset |
1469 | which is the source actually used to determine the clock offset, and | | 1475 | which is the source actually used to determine the clock offset, and |
1470 | which may be accessed via the kern.rtc_offset sysctl variable. | | 1476 | which may be accessed via the kern.rtc_offset sysctl variable. |
1471 | See | | 1477 | See |
1472 | .Xr sysctl 8 | | 1478 | .Xr sysctl 8 |
1473 | and | | 1479 | and |
1474 | .Xr sysctl 3 | | 1480 | .Xr sysctl 3 |
1475 | for details. | | 1481 | for details. |
1476 | Since the kernel clock is initialized from the hardware clock very | | 1482 | Since the kernel clock is initialized from the hardware clock very |
1477 | early in the boot process, it is not possible to meaningfully change | | 1483 | early in the boot process, it is not possible to meaningfully change |
1478 | .Va rtc_offset | | 1484 | .Va rtc_offset |
1479 | in system initialization scripts. | | 1485 | in system initialization scripts. |
1480 | Changing this value currently may only be done at kernel compile | | 1486 | Changing this value currently may only be done at kernel compile |
1481 | time or by patching the kernel and rebooting). | | 1487 | time or by patching the kernel and rebooting). |
1482 | .Pp | | 1488 | .Pp |
1483 | .Em NOTE : | | 1489 | .Em NOTE : |
1484 | Unfortunately, in many cases where the hardware clock | | 1490 | Unfortunately, in many cases where the hardware clock |
1485 | is kept in local time, it is adjusted for Daylight Savings | | 1491 | is kept in local time, it is adjusted for Daylight Savings |
1486 | Time; this means that attempting to use | | 1492 | Time; this means that attempting to use |
1487 | .Em RTC_OFFSET | | 1493 | .Em RTC_OFFSET |
1488 | to let | | 1494 | to let |
1489 | .Nx | | 1495 | .Nx |
1490 | coexist with such an operating system, like Windows, | | 1496 | coexist with such an operating system, like Windows, |
1491 | would necessitate changing | | 1497 | would necessitate changing |
1492 | .Em RTC_OFFSET | | 1498 | .Em RTC_OFFSET |
1493 | twice a year. | | 1499 | twice a year. |
1494 | As such, this solution is imperfect. | | 1500 | As such, this solution is imperfect. |
1495 | .It Cd options MAXUPRC=integer | | 1501 | .It Cd options MAXUPRC=integer |
1496 | Sets the soft | | 1502 | Sets the soft |
1497 | .Dv RLIMIT_NPROC | | 1503 | .Dv RLIMIT_NPROC |
1498 | resource limit, which specifies the maximum number of simultaneous | | 1504 | resource limit, which specifies the maximum number of simultaneous |
1499 | processes a user is permitted to run, for process 0; | | 1505 | processes a user is permitted to run, for process 0; |
1500 | this value is inherited by its child processes. | | 1506 | this value is inherited by its child processes. |
1501 | It defaults to | | 1507 | It defaults to |
1502 | .Em CHILD_MAX , | | 1508 | .Em CHILD_MAX , |
1503 | which is currently defined to be 160. | | 1509 | which is currently defined to be 160. |
1504 | Setting | | 1510 | Setting |
1505 | .Em MAXUPRC | | 1511 | .Em MAXUPRC |
1506 | to a value less than | | 1512 | to a value less than |
1507 | .Em CHILD_MAX | | 1513 | .Em CHILD_MAX |
1508 | is not permitted, as this would result in a violation of the semantics of | | 1514 | is not permitted, as this would result in a violation of the semantics of |
1509 | .St -p1003.1-90 . | | 1515 | .St -p1003.1-90 . |
1510 | .It Cd options NOFILE=integer | | 1516 | .It Cd options NOFILE=integer |
1511 | Sets the soft | | 1517 | Sets the soft |
1512 | .Dv RLIMIT_NOFILE | | 1518 | .Dv RLIMIT_NOFILE |
1513 | resource limit, which specifies the maximum number of open | | 1519 | resource limit, which specifies the maximum number of open |
1514 | file descriptors for each process; | | 1520 | file descriptors for each process; |
1515 | this value is inherited by its child processes. | | 1521 | this value is inherited by its child processes. |
1516 | It defaults to | | 1522 | It defaults to |
1517 | .Em OPEN_MAX , | | 1523 | .Em OPEN_MAX , |
1518 | which is currently defined to be 128. | | 1524 | which is currently defined to be 128. |
1519 | .It Cd options MAXFILES=integer | | 1525 | .It Cd options MAXFILES=integer |
1520 | Sets the default value of the | | 1526 | Sets the default value of the |
1521 | .Em kern.maxfiles | | 1527 | .Em kern.maxfiles |
1522 | sysctl variable, which indicates the maximum number of files that may | | 1528 | sysctl variable, which indicates the maximum number of files that may |
1523 | be open in the system. | | 1529 | be open in the system. |
1524 | .It Cd options DEFCORENAME=string | | 1530 | .It Cd options DEFCORENAME=string |
1525 | Sets the default value of the | | 1531 | Sets the default value of the |
1526 | .Em kern.defcorename | | 1532 | .Em kern.defcorename |
1527 | sysctl variable, otherwise it is set to | | 1533 | sysctl variable, otherwise it is set to |
1528 | .Nm %n.core . | | 1534 | .Nm %n.core . |
1529 | See | | 1535 | See |
1530 | .Xr sysctl 8 | | 1536 | .Xr sysctl 8 |
1531 | and | | 1537 | and |
1532 | .Xr sysctl 3 | | 1538 | .Xr sysctl 3 |
1533 | for details. | | 1539 | for details. |
1534 | .It Cd options RASOPS_CLIPPING | | 1540 | .It Cd options RASOPS_CLIPPING |
1535 | Enables clipping within the | | 1541 | Enables clipping within the |
1536 | .Nm rasops | | 1542 | .Nm rasops |
1537 | raster-console output system. | | 1543 | raster-console output system. |
1538 | .Em NOTE : | | 1544 | .Em NOTE : |
1539 | only available on architectures that use | | 1545 | only available on architectures that use |
1540 | .Nm rasops | | 1546 | .Nm rasops |
1541 | for console output. | | 1547 | for console output. |
1542 | .It Cd options RASOPS_SMALL | | 1548 | .It Cd options RASOPS_SMALL |
1543 | Removes optimized character writing code from the | | 1549 | Removes optimized character writing code from the |
1544 | .Nm rasops | | 1550 | .Nm rasops |
1545 | raster-console output system. | | 1551 | raster-console output system. |
1546 | .Em NOTE : | | 1552 | .Em NOTE : |
1547 | only available on architectures that use | | 1553 | only available on architectures that use |
1548 | .Nm rasops | | 1554 | .Nm rasops |
1549 | for console output. | | 1555 | for console output. |
1550 | .It Cd options INCLUDE_CONFIG_FILE | | 1556 | .It Cd options INCLUDE_CONFIG_FILE |
1551 | Embeds the kernel config file used to define the kernel in the kernel | | 1557 | Embeds the kernel config file used to define the kernel in the kernel |
1552 | binary itself. | | 1558 | binary itself. |
1553 | The embedded data also includes any files directly included by the config | | 1559 | The embedded data also includes any files directly included by the config |
1554 | file itself, e.g. | | 1560 | file itself, e.g. |
1555 | .Pa GENERIC.local | | 1561 | .Pa GENERIC.local |
1556 | or | | 1562 | or |
1557 | .Pa std.$MACHINE . | | 1563 | .Pa std.$MACHINE . |
1558 | The embedded config file can be extracted from the resulting kernel with | | 1564 | The embedded config file can be extracted from the resulting kernel with |
1559 | .Xr config 1 | | 1565 | .Xr config 1 |
1560 | .Fl x , | | 1566 | .Fl x , |
1561 | or by the following command: | | 1567 | or by the following command: |
1562 | .Bd -literal -offset indent | | 1568 | .Bd -literal -offset indent |
1563 | strings netbsd | sed -n 's/^_CFG_//p' | unvis | | 1569 | strings netbsd | sed -n 's/^_CFG_//p' | unvis |
1564 | .Ed | | 1570 | .Ed |
1565 | .It Cd options INCLUDE_JUST_CONFIG | | 1571 | .It Cd options INCLUDE_JUST_CONFIG |
1566 | Similar to the above option, but includes just the actual config file, | | 1572 | Similar to the above option, but includes just the actual config file, |
1567 | not any included files. | | 1573 | not any included files. |
1568 | .It Cd options PIPE_SOCKETPAIR | | 1574 | .It Cd options PIPE_SOCKETPAIR |
1569 | Use slower, but smaller socketpair(2)-based pipe implementation instead | | 1575 | Use slower, but smaller socketpair(2)-based pipe implementation instead |
1570 | of default faster, but bigger one. | | 1576 | of default faster, but bigger one. |
1571 | Primarily useful for installation kernels. | | 1577 | Primarily useful for installation kernels. |
1572 | .It Cd options USERCONF | | 1578 | .It Cd options USERCONF |
1573 | Compiles in the in-kernel device configuration manager. | | 1579 | Compiles in the in-kernel device configuration manager. |
1574 | See | | 1580 | See |
1575 | .Xr userconf 4 | | 1581 | .Xr userconf 4 |
1576 | for details. | | 1582 | for details. |
1577 | .It Cd options PERFCTRS | | 1583 | .It Cd options PERFCTRS |
1578 | Compiles in kernel support for CPU performance-monitoring counters. | | 1584 | Compiles in kernel support for CPU performance-monitoring counters. |
1579 | See | | 1585 | See |
1580 | .Xr pmc 1 | | 1586 | .Xr pmc 1 |
1581 | for details. | | 1587 | for details. |
1582 | .Em NOTE : | | 1588 | .Em NOTE : |
1583 | not available on all architectures. | | 1589 | not available on all architectures. |
1584 | .It Cd options SCDEBUG_DEFAULT | | 1590 | .It Cd options SCDEBUG_DEFAULT |
1585 | Used with the | | 1591 | Used with the |
1586 | .Cd options SYSCALL_DEBUG | | 1592 | .Cd options SYSCALL_DEBUG |
1587 | described below to choose which types of events are displayed. | | 1593 | described below to choose which types of events are displayed. |
1588 | .Pp | | 1594 | .Pp |
1589 | .Bl -tag -width "SCDEBUG_KERNHIST" -compact -offset indent | | 1595 | .Bl -tag -width "SCDEBUG_KERNHIST" -compact -offset indent |
1590 | .It Dv SCDEBUG_CALLS | | 1596 | .It Dv SCDEBUG_CALLS |
1591 | Show system call entry points. | | 1597 | Show system call entry points. |
1592 | .It Dv SCDEBUG_RETURNS | | 1598 | .It Dv SCDEBUG_RETURNS |
1593 | Show system call exit points. | | 1599 | Show system call exit points. |
1594 | .It Dv SCDEBUG_ALL | | 1600 | .It Dv SCDEBUG_ALL |
1595 | Show all system call requestes, including unimplemented calls. | | 1601 | Show all system call requestes, including unimplemented calls. |
1596 | .It Dv SCDEBUG_SHOWARGS | | 1602 | .It Dv SCDEBUG_SHOWARGS |
1597 | Show the arguments provided. | | 1603 | Show the arguments provided. |
1598 | .It Dv SCDEBUG_KERNHIST | | 1604 | .It Dv SCDEBUG_KERNHIST |
1599 | Store a restricted form of the system call debug in a kernel history | | 1605 | Store a restricted form of the system call debug in a kernel history |
1600 | instead of printing it to the console. | | 1606 | instead of printing it to the console. |
1601 | This option relies upon | | 1607 | This option relies upon |
1602 | .Cd options KERNHIST . | | 1608 | .Cd options KERNHIST . |
1603 | .El | | 1609 | .El |
1604 | .Pp | | 1610 | .Pp |
1605 | The default value is | | 1611 | The default value is |
1606 | .Dv (SCDEBUG_CALLS|SCDEBUG_RETURNS|SCDEBUG_SHOWARGS) . | | 1612 | .Dv (SCDEBUG_CALLS|SCDEBUG_RETURNS|SCDEBUG_SHOWARGS) . |
1607 | .It Cd options SYSCALL_DEBUG | | 1613 | .It Cd options SYSCALL_DEBUG |
1608 | Useful for debugging system call issues, usually in early single user bringup. | | 1614 | Useful for debugging system call issues, usually in early single user bringup. |
1609 | By default, writes entries to the system console for most system call events. | | 1615 | By default, writes entries to the system console for most system call events. |
1610 | Can be configured with the | | 1616 | Can be configured with the |
1611 | .Cd options SCDEBUG_DEFAULT | | 1617 | .Cd options SCDEBUG_DEFAULT |
1612 | option to to use the | | 1618 | option to to use the |
1613 | .Cd options KERNHIST | | 1619 | .Cd options KERNHIST |
1614 | facility instead. | | 1620 | facility instead. |
1615 | .It Cd options SYSCALL_STATS | | 1621 | .It Cd options SYSCALL_STATS |
1616 | Count the number of times each system call number is called. | | 1622 | Count the number of times each system call number is called. |
1617 | The values can be read through the sysctl interface and displayed using | | 1623 | The values can be read through the sysctl interface and displayed using |
1618 | .Xr systat 1 . | | 1624 | .Xr systat 1 . |
1619 | .Em NOTE : | | 1625 | .Em NOTE : |
1620 | not yet available on all architectures. | | 1626 | not yet available on all architectures. |
1621 | .It Cd options SYSCALL_TIMES | | 1627 | .It Cd options SYSCALL_TIMES |
1622 | Count the time spent (using | | 1628 | Count the time spent (using |
1623 | .Fn cpu_counter32 ) | | 1629 | .Fn cpu_counter32 ) |
1624 | in each system call. | | 1630 | in each system call. |
1625 | .Em NOTE : | | 1631 | .Em NOTE : |
1626 | Using this option will also enable | | 1632 | Using this option will also enable |
1627 | .Cd options SYSCALL_STATS . | | 1633 | .Cd options SYSCALL_STATS . |
1628 | .It Cd options SYSCALL_TIMES_HASCOUNTER | | 1634 | .It Cd options SYSCALL_TIMES_HASCOUNTER |
1629 | Force use of | | 1635 | Force use of |
1630 | .Fn cpu_counter32 | | 1636 | .Fn cpu_counter32 |
1631 | even if | | 1637 | even if |
1632 | .Fn cpu_hascounter | | 1638 | .Fn cpu_hascounter |
1633 | reports false. | | 1639 | reports false. |
1634 | Useful for systems where the cycle counter doesn't run at a constant rate | | 1640 | Useful for systems where the cycle counter doesn't run at a constant rate |
1635 | (e.g. Soekris boxes). | | 1641 | (e.g. Soekris boxes). |