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