| Commit | Line | Data |
|---|---|---|
| 984263bc MD |
1 | .\" Copyright (c) 1995 |
| 2 | .\" Jordan K. Hubbard | |
| 3 | .\" | |
| 4 | .\" Redistribution and use in source and binary forms, with or without | |
| 5 | .\" modification, are permitted provided that the following conditions | |
| 6 | .\" are met: | |
| 7 | .\" 1. Redistributions of source code must retain the above copyright | |
| 8 | .\" notice, this list of conditions and the following disclaimer. | |
| 9 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
| 10 | .\" notice, this list of conditions and the following disclaimer in the | |
| 11 | .\" documentation and/or other materials provided with the distribution. | |
| 12 | .\" | |
| 13 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND | |
| 14 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 15 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 16 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE | |
| 17 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
| 18 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
| 19 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
| 20 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
| 21 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
| 22 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
| 23 | .\" SUCH DAMAGE. | |
| 24 | .\" | |
| 445243bf | 25 | .\" $FreeBSD: src/share/man/man5/rc.conf.5,v 1.197 2003/07/28 13:56:00 mbr Exp $ |
| 2feb07f7 SW |
26 | .\" |
| 27 | .Dd April 8, 2010 | |
| 984263bc MD |
28 | .Dt RC.CONF 5 |
| 29 | .Os | |
| 30 | .Sh NAME | |
| 31 | .Nm rc.conf | |
| 32 | .Nd system configuration information | |
| 33 | .Sh DESCRIPTION | |
| 34 | The file | |
| 35 | .Nm | |
| 36 | contains descriptive information about the local host name, configuration | |
| 37 | details for any potential network interfaces and which services should be | |
| 445243bf RG |
38 | started up at system initial boot time. |
| 39 | In new installations, the | |
| 984263bc | 40 | .Nm |
| d566b9ec | 41 | file is generally initialized by the installer. |
| 984263bc MD |
42 | .Pp |
| 43 | The purpose of | |
| 44 | .Nm | |
| 225e0ed5 SW |
45 | is not to run commands or perform system startup actions directly. |
| 46 | Instead, it is included by the various generic startup scripts in | |
| 984263bc MD |
47 | .Pa /etc |
| 48 | which conditionalize their | |
| 49 | internal actions according to the settings found there. | |
| 50 | .Pp | |
| 51 | The | |
| 717e8ef7 TN |
52 | .Pa /etc/defaults/rc.conf |
| 53 | file specifies the default settings for all the available options, | |
| 54 | the | |
| 984263bc | 55 | .Pa /etc/rc.conf |
| 717e8ef7 | 56 | file specifies override settings. |
| 445243bf | 57 | Options need only be specified in |
| 984263bc | 58 | .Pa /etc/rc.conf |
| 717e8ef7 | 59 | when the system administrator wishes to override the defaults. |
| 984263bc MD |
60 | The file |
| 61 | .Pa /etc/rc.conf.local | |
| 62 | is used to override settings in | |
| 63 | .Pa /etc/rc.conf | |
| 64 | for historical reasons. | |
| 65 | See the | |
| 445243bf RG |
66 | .Va rc_conf_files |
| 67 | variable below. | |
| 984263bc MD |
68 | .Pp |
| 69 | The following list provides a name and short description for each | |
| 70 | variable that can be set in the | |
| 71 | .Nm | |
| 10efbc86 SW |
72 | file. |
| 73 | To set a variable of | |
| 74 | .Vt bool | |
| 75 | type, specify either | |
| 76 | .Dq Li YES , | |
| 77 | .Dq Li TRUE , | |
| 78 | .Dq Li ON , | |
| 79 | or | |
| 80 | .Dq Li 1 . | |
| 81 | To unset, specify | |
| 82 | .Dq Li NO , | |
| 83 | .Dq Li FALSE , | |
| 84 | .Dq Li OFF , | |
| 85 | or | |
| 86 | .Dq Li 0 . | |
| 87 | These values are case insensitive. | |
| 88 | The | |
| 89 | .Va _enable | |
| f0cc8c84 | 90 | postfix in the name of a variable for starting a service can be |
| 10efbc86 SW |
91 | omitted (as in |
| 92 | .Nx ) . | |
| 445243bf RG |
93 | .Bl -tag -width indent-two |
| 94 | .It Va rc_debug | |
| 95 | .Pq Vt bool | |
| 96 | If set to | |
| 97 | .Dq Li YES , | |
| 98 | enable output of debug messages from rc scripts. | |
| 99 | This variable can be helpful in diagnosing mistakes when | |
| 100 | editing or integrating new scripts. | |
| 101 | Beware that this produces copious output to the terminal and | |
| 102 | .Xr syslog 3 . | |
| 103 | .It Va rc_info | |
| 104 | .Pq Vt bool | |
| 105 | If set to | |
| 106 | .Dq Li NO , | |
| 107 | disable informational messages from the rc scripts. | |
| 108 | Informational messages are displayed when | |
| 225e0ed5 | 109 | a condition that is not serious enough to warrant a warning or an error occurs. |
| 984263bc MD |
110 | .It Va swapfile |
| 111 | .Pq Vt str | |
| 112 | If set to | |
| 445243bf RG |
113 | .Dq Li NO , |
| 114 | no swapfile is installed, otherwise the value is used as the full | |
| 984263bc MD |
115 | pathname to a file to use for additional swap space. |
| 116 | .It Va apm_enable | |
| 117 | .Pq Vt bool | |
| 118 | If set to | |
| 445243bf | 119 | .Dq Li YES , |
| 225e0ed5 | 120 | enable support for Automatic Power Management with the |
| 984263bc MD |
121 | .Xr apm 8 |
| 122 | command. | |
| 123 | .It Va apmd_enable | |
| 124 | .Pq Vt bool | |
| 125 | Run | |
| 126 | .Xr apmd 8 | |
| 127 | to handle APM event from userland. | |
| 445243bf | 128 | This also enables support for APM. |
| 984263bc MD |
129 | .It Va apmd_flags |
| 130 | .Pq Vt str | |
| 131 | If | |
| 132 | .Va apmd_enable | |
| 133 | is set to | |
| 445243bf | 134 | .Dq Li YES , |
| 984263bc MD |
135 | these are the flags to pass to the |
| 136 | .Xr apmd 8 | |
| 137 | daemon. | |
| 50449d08 LF |
138 | .It Va battd_enable |
| 139 | Enable | |
| fd5819c4 | 140 | .Xr battd 8 |
| 50449d08 LF |
141 | to monitor the status of batteries present in the system. |
| 142 | This also enables support for APM. | |
| 143 | .It Va battd_flags | |
| 144 | .Pq Vt str | |
| 145 | If | |
| 146 | .Va battd_enable | |
| 147 | is set to | |
| 148 | .Dq Li YES , | |
| 149 | these are the flags to pass to the | |
| fd5819c4 | 150 | .Xr battd 8 |
| 50449d08 | 151 | daemon. |
| 4b8c406a SW |
152 | .It Va devd_enable |
| 153 | .Pq Vt bool | |
| 154 | Run | |
| 155 | .Xr devd 8 | |
| 156 | to handle device added, removed or unknown events from the kernel. | |
| 157 | .It Va devd_flags | |
| 158 | .Pq Vt str | |
| 159 | If | |
| 160 | .Va devd_enable | |
| 161 | is set to | |
| 162 | .Dq Li YES , | |
| 163 | these are the flags to pass to the | |
| 164 | .Xr devd 8 | |
| 165 | daemon. | |
| eb3a3472 HT |
166 | .It Va sensorsd_enable |
| 167 | .Pq Vt bool | |
| 168 | Set to | |
| 169 | .Dq Li NO | |
| 170 | by default. | |
| 171 | Setting this to | |
| 172 | .Dq Li YES | |
| 173 | enables | |
| 174 | .Xr sensorsd 8 , | |
| 175 | a sensors monitoring and logging daemon. | |
| 176 | .It Va sensorsd_flags | |
| 177 | .Pq Vt str | |
| 178 | Empty by default. | |
| 717e8ef7 | 179 | Additional flags passed to the |
| eb3a3472 HT |
180 | .Xr sensorsd 8 |
| 181 | program. | |
| 01b70f3f SW |
182 | .It Va hotplugd_enable |
| 183 | .Pq Vt bool | |
| 184 | Set to | |
| 185 | .Dq Li NO | |
| 186 | by default. | |
| 187 | Setting this to | |
| 188 | .Dq Li YES | |
| 189 | enables | |
| 190 | .Xr hotplugd 8 , | |
| 191 | a devices hot plugging monitoring daemon. | |
| 192 | .It Va hotplugd_flags | |
| 193 | .Pq Vt str | |
| 194 | Empty by default. | |
| 195 | Additional flags passed to the | |
| 196 | .Xr hotplugd 8 | |
| 197 | program. | |
| 984263bc MD |
198 | .It Va pccard_ifconfig |
| 199 | .Pq Vt str | |
| 200 | List of arguments to be passed to | |
| 201 | .Xr ifconfig 8 | |
| 225e0ed5 | 202 | at boot time or on insertion of the card (e.g.\& |
| 445243bf RG |
203 | .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0 |
| 204 | for a fixed address or | |
| 205 | .Dq Li DHCP | |
| 206 | for a DHCP client). | |
| 984263bc MD |
207 | .It Va pccard_ether_delay |
| 208 | .Pq Vt str | |
| 209 | Set the delay before starting | |
| 210 | .Xr dhclient 8 | |
| 445243bf RG |
211 | in the |
| 212 | .Pa /etc/pccard_ether | |
| 984263bc MD |
213 | script. |
| 214 | This defaults to 5 seconds to work around a bug in the | |
| 215 | .Xr ed 4 | |
| 216 | driver which can lead to system hangs when using some newer | |
| 217 | .Xr ed 4 | |
| 218 | based cards. | |
| 445243bf RG |
219 | .It Va removable_interfaces |
| 220 | .Pq Vt str | |
| 221 | List of removable network interfaces to be supported by | |
| 222 | .Pa /etc/pccard_ether . | |
| 984263bc MD |
223 | .It Va local_startup |
| 224 | .Pq Vt str | |
| 225 | List of directories to search for startup script files. | |
| 226 | .It Va script_name_sep | |
| 227 | .Pq Vt str | |
| 228 | The field separator to use for breaking down the list of startup script files | |
| 229 | into individual filenames. | |
| 230 | The default is a space. | |
| 231 | It is not necessary to change this unless there are startup scripts with names | |
| 232 | containing spaces. | |
| 5c8b08ff SW |
233 | .It Va hostapd_enable |
| 234 | .Pq Vt bool | |
| 235 | Set to | |
| 236 | .Dq Li YES | |
| 237 | to start | |
| 238 | .Xr hostapd 8 | |
| 239 | at system boot time. | |
| 984263bc MD |
240 | .It Va hostname |
| 241 | .Pq Vt str | |
| 445243bf | 242 | The fully qualified domain name (FQDN) of this host on the network. |
| 984263bc MD |
243 | This should almost certainly be set to something meaningful, even if |
| 244 | there is no network connection. | |
| 245 | If | |
| 246 | .Xr dhclient 8 | |
| 247 | is used to set the hostname via DHCP, | |
| 248 | this variable should be set to an empty string. | |
| 445243bf RG |
249 | .It Va ipv6_enable |
| 250 | .Pq Vt bool | |
| 251 | Enable support for IPv6 networking. | |
| 252 | Note that this requires that the kernel have been compiled with | |
| 253 | .Cd "options INET6" . | |
| 984263bc MD |
254 | .It Va nisdomainname |
| 255 | .Pq Vt str | |
| 256 | The NIS domain name of this host, or | |
| 445243bf | 257 | .Dq Li NO |
| 984263bc | 258 | if NIS is not used. |
| 445243bf | 259 | .It Va dhclient_program |
| 984263bc MD |
260 | .Pq Vt str |
| 261 | Path to the DHCP client program | |
| 717e8ef7 TN |
262 | (default |
| 263 | .Pa /sbin/dhclient ) . | |
| 445243bf | 264 | .It Va dhclient_flags |
| 984263bc MD |
265 | .Pq Vt str |
| 266 | Additional flags to pass to the DHCP client program. | |
| 27e9fed5 SW |
267 | .It Va pf_enable |
| 268 | .Pq Vt bool | |
| 269 | Set to | |
| 270 | .Dq Li YES | |
| 271 | to load | |
| 272 | .Xr pf 4 | |
| 273 | at startup. | |
| 274 | If the kernel was not built with | |
| 275 | .Cd "device pf" , | |
| 276 | the | |
| 277 | .Pa pf.ko | |
| 278 | kernel module will be loaded. | |
| 279 | See also | |
| 280 | .Va firewall_enable | |
| 281 | and | |
| 282 | .Va ipfilter_enable . | |
| 283 | .It Va pf_rules | |
| 284 | .Pq Vt str | |
| 285 | Path to the | |
| 286 | .Xr pf 4 | |
| 287 | ruleset definition file. | |
| 288 | .It Va pf_program | |
| 289 | .Pq Vt str | |
| 290 | Path to | |
| 291 | .Xr pfctl 8 . | |
| 292 | .It Va pf_flags | |
| 293 | .Pq Vt str | |
| 294 | If | |
| 295 | .Va pf_enable | |
| 296 | is set to | |
| 297 | .Dq Li YES , | |
| 298 | these are the flags to pass to | |
| 299 | .Xr pfctl 8 | |
| 300 | when loading the ruleset. | |
| 301 | .It Va pflog_enable | |
| 302 | .Pq Vt bool | |
| 303 | Set this to | |
| 304 | .Dq Li YES | |
| 305 | to enable | |
| 306 | .Xr pflogd 8 | |
| 307 | which logs packets from | |
| 308 | .Xr pf 4 . | |
| 309 | .It Va pflog_logfile | |
| 310 | .Pq Vt str | |
| 311 | If | |
| 312 | .Va pflog_enable | |
| 313 | is set to | |
| 314 | .Dq Li YES | |
| 315 | this specifies the path of the log file. | |
| 316 | .It Va pflog_program | |
| 317 | .Pq Vt str | |
| 318 | Path to | |
| 319 | .Xr pflogd 8 . | |
| 320 | .It Va pflog_flags | |
| 321 | .Pq Vt str | |
| 322 | If | |
| 323 | .Va pflog_enable | |
| 324 | is set to | |
| 325 | .Dq Li YES , | |
| 326 | these are the flags to pass to | |
| 327 | .Xr pflogd 8 . | |
| 984263bc MD |
328 | .It Va firewall_enable |
| 329 | .Pq Vt bool | |
| 330 | Set to | |
| 445243bf | 331 | .Dq Li YES |
| 984263bc MD |
332 | to load firewall rules at startup. |
| 333 | If the kernel was not built with | |
| 445243bf RG |
334 | .Cd "options IPFIREWALL" , |
| 335 | the | |
| 336 | .Pa ipfw.ko | |
| 984263bc MD |
337 | kernel module will be loaded. |
| 338 | See also | |
| 27e9fed5 SW |
339 | .Va pf_enable |
| 340 | and | |
| 984263bc | 341 | .Va ipfilter_enable . |
| 445243bf RG |
342 | .It Va ipv6_firewall_enable |
| 343 | .Pq Vt bool | |
| 344 | The IPv6 equivalent of | |
| 345 | .Va firewall_enable . | |
| 346 | Set to | |
| 347 | .Dq Li YES | |
| 348 | to load IPv6 firewall rules at startup. | |
| 349 | If the kernel was not built with | |
| 350 | .Cd "options IPV6FIREWALL" , | |
| 351 | the | |
| 352 | .Pa ip6fw.ko | |
| 353 | kernel module will be loaded. | |
| 984263bc MD |
354 | .It Va firewall_script |
| 355 | .Pq Vt str | |
| 717e8ef7 TN |
356 | The full path to the firewall script to run |
| 357 | (default | |
| 358 | .Pa /etc/rc.firewall ) . | |
| 445243bf RG |
359 | .It Va ipv6_firewall_script |
| 360 | .Pq Vt str | |
| 361 | The IPv6 equivalent of | |
| 362 | .Va firewall_script . | |
| 984263bc MD |
363 | .It Va firewall_type |
| 364 | .Pq Vt str | |
| 365 | Names the firewall type from the selection in | |
| 366 | .Pa /etc/rc.firewall , | |
| 445243bf RG |
367 | or the file which contains the local firewall ruleset. |
| 368 | Valid selections from | |
| 369 | .Pa /etc/rc.firewall | |
| 370 | are: | |
| 371 | .Pp | |
| 372 | .Bl -tag -width ".Li simple" -compact | |
| 373 | .It Li open | |
| 374 | unrestricted IP access | |
| 375 | .It Li closed | |
| 376 | all IP services disabled, except via | |
| 377 | .Dq Li lo0 | |
| 378 | .It Li client | |
| d7b5790d | 379 | basic protection for a workstation on a LAN |
| 445243bf | 380 | .It Li simple |
| d7b5790d SW |
381 | alias for |
| 382 | .Li client . | |
| 445243bf RG |
383 | .El |
| 384 | .Pp | |
| 225e0ed5 | 385 | If a filename is specified, the full path must be given. |
| d7b5790d | 386 | .It Va firewall_trusted_nets |
| 9534e380 | 387 | .Pq Vt str |
| d7b5790d SW |
388 | List of trusted networks (if |
| 389 | .Va firewall_type | |
| 390 | is set to | |
| 391 | .Li client ) . | |
| 392 | .It Va firewall_trusted_interfaces | |
| 9534e380 | 393 | .Pq Vt str |
| d7b5790d SW |
394 | List of trusted network interfaces (if |
| 395 | .Va firewall_type | |
| 396 | is set to | |
| 397 | .Li client ) . | |
| 398 | .It Va firewall_allowed_icmp_types | |
| 9534e380 | 399 | .Pq Vt str |
| d7b5790d SW |
400 | List of allowed ICMP types (if |
| 401 | .Va firewall_type | |
| 402 | is set to | |
| 403 | .Li client ) . | |
| 404 | .It Va firewall_open_tcp_ports | |
| 9534e380 | 405 | .Pq Vt str |
| d7b5790d SW |
406 | List of TCP ports to open (if |
| 407 | .Va firewall_type | |
| 408 | is set to | |
| 409 | .Li client ) . | |
| 410 | .It Va firewall_open_udp_ports | |
| 9534e380 | 411 | .Pq Vt str |
| d7b5790d SW |
412 | List of UDP ports to open (if |
| 413 | .Va firewall_type | |
| 414 | is set to | |
| 415 | .Li client ) . | |
| 445243bf RG |
416 | .It Va ipv6_firewall_type |
| 417 | .Pq Vt str | |
| 418 | The IPv6 equivalent of | |
| 419 | .Va firewall_type . | |
| 984263bc MD |
420 | .It Va firewall_quiet |
| 421 | .Pq Vt bool | |
| 422 | Set to | |
| 445243bf RG |
423 | .Dq Li YES |
| 424 | to disable the display of firewall rules on the console during boot. | |
| 425 | .It Va ipv6_firewall_quiet | |
| 426 | .Pq Vt bool | |
| 427 | The IPv6 equivalent of | |
| 428 | .Va firewall_quiet . | |
| 984263bc MD |
429 | .It Va firewall_logging |
| 430 | .Pq Vt bool | |
| 431 | Set to | |
| 445243bf RG |
432 | .Dq Li YES |
| 433 | to enable firewall event logging. | |
| 984263bc MD |
434 | This is equivalent to the |
| 435 | .Dv IPFIREWALL_VERBOSE | |
| 436 | kernel option. | |
| 445243bf RG |
437 | .It Va ipv6_firewall_logging |
| 438 | .Pq Vt bool | |
| 439 | The IPv6 equivalent of | |
| 440 | .Va firewall_logging . | |
| 984263bc MD |
441 | .It Va firewall_flags |
| 442 | .Pq Vt str | |
| 443 | Flags passed to | |
| 444 | .Xr ipfw 8 | |
| 445 | if | |
| 446 | .Va firewall_type | |
| 447 | specifies a filename. | |
| 445243bf RG |
448 | .It Va ipv6_firewall_flags |
| 449 | .Pq Vt str | |
| 450 | The IPv6 equivalent of | |
| 451 | .Va firewall_flags . | |
| 984263bc MD |
452 | .It Va natd_program |
| 453 | .Pq Vt str | |
| 454 | Path to | |
| 455 | .Xr natd 8 . | |
| 456 | .It Va natd_enable | |
| 457 | .Pq Vt bool | |
| 458 | Set to | |
| 445243bf RG |
459 | .Dq Li YES |
| 460 | to enable | |
| 461 | .Xr natd 8 . | |
| 984263bc MD |
462 | .Va firewall_enable |
| 463 | must also be set to | |
| 445243bf | 464 | .Dq Li YES , |
| 984263bc MD |
465 | and |
| 466 | .Xr divert 4 | |
| 467 | sockets must be enabled in the kernel. | |
| 468 | .It Va natd_interface | |
| 469 | .Pq Vt str | |
| 445243bf RG |
470 | This is the name of the public interface on which |
| 471 | .Xr natd 8 | |
| 472 | should run. | |
| 984263bc MD |
473 | The interface may be given as an interface name or as an IP address. |
| 474 | .It Va natd_flags | |
| 475 | .Pq Vt str | |
| 445243bf RG |
476 | Additional |
| 477 | .Xr natd 8 | |
| 478 | flags should be placed here. | |
| 479 | The | |
| 984263bc MD |
480 | .Fl n |
| 481 | or | |
| 482 | .Fl a | |
| 483 | flag is automatically added with the above | |
| 484 | .Va natd_interface | |
| 485 | as an argument. | |
| 486 | .\" ----- ipfilter_enable setting -------------------------------- | |
| 487 | .It Va ipfilter_enable | |
| 488 | .Pq Vt bool | |
| 489 | Set to | |
| 445243bf | 490 | .Dq Li NO |
| 984263bc MD |
491 | by default. |
| 492 | Setting this to | |
| 445243bf | 493 | .Dq Li YES |
| 984263bc MD |
494 | enables |
| 495 | .Xr ipf 8 | |
| 496 | packet filtering. | |
| 497 | .Pp | |
| 498 | Typical usage will require putting | |
| 499 | .Bd -literal | |
| 500 | ipfilter_enable="YES" | |
| 501 | ipnat_enable="YES" | |
| 502 | ipmon_enable="YES" | |
| 503 | ipfs_enable="YES" | |
| 504 | .Ed | |
| 505 | .Pp | |
| 506 | into | |
| 507 | .Pa /etc/rc.conf | |
| 508 | and editing | |
| 509 | .Pa /etc/ipf.rules | |
| 510 | and | |
| 511 | .Pa /etc/ipnat.rules | |
| 512 | appropriately. | |
| 513 | .Pp | |
| 514 | Note that | |
| 515 | .Va ipfilter_enable | |
| 516 | and | |
| 517 | .Va ipnat_enable | |
| 518 | can be enabled independently. | |
| 519 | .Va ipmon_enable | |
| 520 | and | |
| 521 | .Va ipfs_enable | |
| 522 | both require at least one of | |
| 523 | .Va ipfilter_enable | |
| 524 | and | |
| 525 | .Va ipnat_enable | |
| 526 | to be enabled. | |
| 527 | .Pp | |
| 528 | Having | |
| 529 | .Bd -literal | |
| 445243bf RG |
530 | options IPFILTER |
| 531 | options IPFILTER_LOG | |
| 532 | options IPFILTER_DEFAULT_BLOCK | |
| 984263bc MD |
533 | .Ed |
| 534 | .Pp | |
| 535 | in the kernel configuration file is a good idea, too. | |
| 27e9fed5 SW |
536 | See also |
| 537 | .Va pf_enable | |
| 538 | and | |
| 539 | .Va firewall_enable . | |
| 984263bc MD |
540 | .\" ----- ipfilter_program setting ------------------------------ |
| 541 | .It Va ipfilter_program | |
| 542 | .Pq Vt str | |
| 543 | Path to | |
| 544 | .Xr ipf 8 | |
| 545 | (default | |
| 546 | .Pa /sbin/ipf ) . | |
| 547 | .\" ----- ipfilter_rules setting -------------------------------- | |
| 548 | .It Va ipfilter_rules | |
| 549 | .Pq Vt str | |
| 550 | Set to | |
| 445243bf | 551 | .Pa /etc/ipf.rules |
| 984263bc | 552 | by default. |
| 717e8ef7 | 553 | The name of the filter rule definition file. |
| 984263bc MD |
554 | The file is expected to be readable for the |
| 555 | .Xr ipf 8 | |
| 556 | command to execute. | |
| 445243bf RG |
557 | .\" ----- ipv6_ipfilter_rules setting --------------------------- |
| 558 | .It Va ipv6_ipfilter_rules | |
| 559 | .Pq Vt str | |
| 560 | Set to | |
| 561 | .Pa /etc/ipf6.rules | |
| 562 | by default. | |
| 717e8ef7 | 563 | The name of the IPv6 filter rule definition file. |
| 445243bf RG |
564 | The file is expected to be readable for the |
| 565 | .Xr ipf 8 | |
| 566 | command to execute. | |
| 984263bc MD |
567 | .\" ----- ipfilter_flags setting -------------------------------- |
| 568 | .It Va ipfilter_flags | |
| 569 | .Pq Vt str | |
| 570 | Empty by default. | |
| 717e8ef7 | 571 | Flags passed to the |
| 984263bc MD |
572 | .Xr ipf 8 |
| 573 | program. | |
| 574 | .\" ----- ipnat_enable setting ---------------------------------- | |
| 575 | .It Va ipnat_enable | |
| 576 | .Pq Vt bool | |
| 577 | Set to | |
| 445243bf | 578 | .Dq Li NO |
| 984263bc MD |
579 | by default. |
| 580 | Set it to | |
| 445243bf | 581 | .Dq Li YES |
| 984263bc | 582 | to enable |
| a523caf4 | 583 | .Xr ipnat 8 |
| 984263bc MD |
584 | network address translation. |
| 585 | See | |
| 586 | .Va ipfilter_enable | |
| 587 | for a detailed discussion. | |
| 588 | .\" ----- ipnat_program setting --------------------------------- | |
| 589 | .It Va ipnat_program | |
| 590 | .Pq Vt str | |
| 591 | Path to | |
| a523caf4 | 592 | .Xr ipnat 8 |
| 984263bc MD |
593 | (default |
| 594 | .Pa /sbin/ipnat ) . | |
| 595 | .\" ----- ipnat_rules setting ----------------------------------- | |
| 596 | .It Va ipnat_rules | |
| 597 | .Pq Vt str | |
| 598 | Set to | |
| 445243bf | 599 | .Pa /etc/ipnat.rules |
| 984263bc | 600 | by default. |
| 717e8ef7 | 601 | The name of the file |
| 984263bc MD |
602 | holding the network address translation definition. |
| 603 | This file is expected to be readable for the | |
| a523caf4 | 604 | .Xr ipnat 8 |
| 984263bc MD |
605 | command to execute. |
| 606 | .\" ----- ipnat_flags setting ----------------------------------- | |
| 607 | .It Va ipnat_flags | |
| 608 | .Pq Vt str | |
| 609 | Empty by default. | |
| 717e8ef7 | 610 | Flags passed to the |
| a523caf4 | 611 | .Xr ipnat 8 |
| 984263bc MD |
612 | program. |
| 613 | .\" ----- ipmon_enable setting ---------------------------------- | |
| 614 | .It Va ipmon_enable | |
| 615 | .Pq Vt bool | |
| 616 | Set to | |
| 445243bf | 617 | .Dq Li NO |
| 984263bc MD |
618 | by default. |
| 619 | Set it to | |
| 445243bf | 620 | .Dq Li YES |
| 984263bc MD |
621 | to enable |
| 622 | .Xr ipmon 8 | |
| 623 | monitoring (logging | |
| 624 | .Xr ipf 8 | |
| 625 | and | |
| a523caf4 | 626 | .Xr ipnat 8 |
| 984263bc MD |
627 | events). |
| 628 | Setting this variable needs setting | |
| 629 | .Va ipfilter_enable | |
| 630 | or | |
| 631 | .Va ipnat_enable | |
| 632 | too. | |
| 633 | See | |
| 634 | .Va ipfilter_enable | |
| 635 | for a detailed discussion. | |
| 636 | .\" ----- ipmon_program setting --------------------------------- | |
| 637 | .It Va ipmon_program | |
| 638 | .Pq Vt str | |
| 639 | Path to | |
| 640 | .Xr ipmon 8 | |
| 641 | (default | |
| 642 | .Pa /sbin/ipmon ) . | |
| 643 | .\" ----- ipmon_flags setting ----------------------------------- | |
| 644 | .It Va ipmon_flags | |
| 645 | .Pq Vt str | |
| 646 | Set to | |
| 445243bf | 647 | .Dq Li -Ds |
| 984263bc | 648 | by default. |
| 717e8ef7 | 649 | Flags passed to the |
| 984263bc MD |
650 | .Xr ipmon 8 |
| 651 | program. | |
| 652 | Another typical example would be | |
| 445243bf | 653 | .Dq Fl D Pa /var/log/ipflog |
| 984263bc MD |
654 | to have |
| 655 | .Xr ipmon 8 | |
| 656 | log directly to a file bypassing | |
| 657 | .Xr syslogd 8 . | |
| 658 | Make sure to adjust | |
| 659 | .Pa /etc/newsyslog.conf | |
| 660 | in such case like this: | |
| 661 | .Bd -literal | |
| 662 | /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid | |
| 663 | .Ed | |
| 664 | .\" ----- ipfs_enable setting ----------------------------------- | |
| 665 | .It Va ipfs_enable | |
| 666 | .Pq Vt bool | |
| 667 | Set to | |
| 445243bf | 668 | .Dq Li NO |
| 984263bc MD |
669 | by default. |
| 670 | Set it to | |
| 445243bf | 671 | .Dq Li YES |
| 984263bc MD |
672 | to enable |
| 673 | .Xr ipfs 8 | |
| 674 | saving the filter and NAT state tables during shutdown | |
| 675 | and reloading them during startup again. | |
| 676 | Setting this variable needs setting | |
| 677 | .Va ipfilter_enable | |
| 678 | or | |
| 679 | .Va ipnat_enable | |
| 680 | to | |
| 445243bf | 681 | .Dq Li YES |
| 984263bc MD |
682 | too. |
| 683 | See | |
| 684 | .Va ipfilter_enable | |
| 685 | for a detailed discussion. | |
| 686 | Note that if | |
| 687 | .Va kern_securelevel | |
| 688 | is set to 3, | |
| 689 | .Va ipfs_enable | |
| 225e0ed5 | 690 | cannot be used because the raised securelevel will prevent |
| 984263bc MD |
691 | .Xr ipfs 8 |
| 692 | from saving the state tables at shutdown time. | |
| 693 | .\" ----- ipfs_program setting ---------------------------------- | |
| 694 | .It Va ipfs_program | |
| 695 | .Pq Vt str | |
| 696 | Path to | |
| 697 | .Xr ipfs 8 | |
| 698 | (default | |
| 699 | .Pa /sbin/ipfs ) . | |
| 700 | .\" ----- ipfs_flags setting ------------------------------------ | |
| 701 | .It Va ipfs_flags | |
| 702 | .Pq Vt str | |
| 703 | Empty by default. | |
| 717e8ef7 | 704 | Flags passed to the |
| 984263bc MD |
705 | .Xr ipfs 8 |
| 706 | program. | |
| 707 | .\" ----- end of added ipf hook --------------------------------- | |
| 708 | .It Va tcp_extensions | |
| 709 | .Pq Vt bool | |
| 710 | Set to | |
| 445243bf | 711 | .Dq Li YES |
| 984263bc | 712 | by default. |
| 445243bf RG |
713 | Setting this to |
| 714 | .Dq Li NO | |
| 715 | disables certain TCP options as described by | |
| 984263bc | 716 | .Rs |
| 445243bf | 717 | .%T "RFC 1323" |
| 984263bc MD |
718 | .Re |
| 719 | Setting this to | |
| 445243bf | 720 | .Dq Li NO |
| 984263bc MD |
721 | might help remedy such problems with connections as randomly hanging |
| 722 | or other weird behavior. | |
| 225e0ed5 | 723 | Some network devices are known to be broken with respect to these options. |
| 984263bc MD |
724 | .It Va log_in_vain |
| 725 | .Pq Vt int | |
| 726 | Set to 0 by default. | |
| 727 | The | |
| 728 | .Xr sysctl 8 | |
| 729 | variables, | |
| 445243bf | 730 | .Va net.inet.tcp.log_in_vain |
| 984263bc | 731 | and |
| 445243bf | 732 | .Va net.inet.udp.log_in_vain , |
| 984263bc MD |
733 | as described in |
| 734 | .Xr tcp 4 | |
| 735 | and | |
| 736 | .Xr udp 4 , | |
| 737 | are set to the given value. | |
| 738 | .It Va tcp_keepalive | |
| 739 | .Pq Vt bool | |
| 740 | Set to | |
| 445243bf | 741 | .Dq Li YES |
| 984263bc | 742 | by default. |
| 445243bf RG |
743 | Setting to |
| 744 | .Dq Li NO | |
| 745 | will disable probing idle TCP connections to verify that the | |
| 984263bc MD |
746 | peer is still up and reachable. |
| 747 | .It Va tcp_drop_synfin | |
| 748 | .Pq Vt bool | |
| 749 | Set to | |
| 445243bf | 750 | .Dq Li NO |
| 984263bc | 751 | by default. |
| 445243bf RG |
752 | Setting to |
| 753 | .Dq Li YES | |
| 754 | will cause the kernel to ignore TCP frames that have both | |
| 984263bc | 755 | the SYN and FIN flags set. |
| 225e0ed5 SW |
756 | This prevents OS fingerprinting, but may break some legitimate applications. |
| 757 | This option is only available if the kernel was built with the | |
| 984263bc MD |
758 | .Dv TCP_DROP_SYNFIN |
| 759 | option. | |
| 760 | .It Va icmp_drop_redirect | |
| 761 | .Pq Vt bool | |
| 762 | Set to | |
| 445243bf | 763 | .Dq Li NO |
| 984263bc | 764 | by default. |
| 445243bf RG |
765 | Setting to |
| 766 | .Dq Li YES | |
| 767 | will cause the kernel to ignore ICMP REDIRECT packets. | |
| 768 | Refer to | |
| 769 | .Xr icmp 4 | |
| 770 | for more information. | |
| 984263bc MD |
771 | .It Va icmp_log_redirect |
| 772 | .Pq Vt bool | |
| 773 | Set to | |
| 445243bf | 774 | .Dq Li NO |
| 984263bc | 775 | by default. |
| 445243bf RG |
776 | Setting to |
| 777 | .Dq Li YES | |
| 778 | will cause the kernel to log ICMP REDIRECT packets. | |
| 984263bc MD |
779 | Note that |
| 780 | the log messages are not rate-limited, so this option should only be used | |
| 781 | for troubleshooting networks. | |
| 445243bf RG |
782 | Refer to |
| 783 | .Xr icmp 4 | |
| 784 | for more information. | |
| 785 | .It Va icmp_bmcastecho | |
| 786 | .Pq Vt bool | |
| 787 | Set to | |
| 788 | .Dq Li YES | |
| 789 | to respond to broadcast or multicast ICMP ping packets. | |
| 790 | Refer to | |
| 791 | .Xr icmp 4 | |
| 792 | for more information. | |
| 793 | .It Va ip_portrange_first | |
| 794 | .Pq Vt int | |
| 795 | If not set to | |
| 796 | .Dq Li NO , | |
| 797 | this is the first port in the default portrange. | |
| 798 | Refer to | |
| 799 | .Xr ip 4 | |
| 800 | for more information. | |
| 801 | .It Va ip_portrange_last | |
| 802 | .Pq Vt int | |
| 803 | If not set to | |
| 804 | .Dq Li NO , | |
| 805 | this is the last port in the default portrange. | |
| 806 | Refer to | |
| 807 | .Xr ip 4 | |
| 808 | for more information. | |
| 717e8ef7 TN |
809 | .\" |
| 810 | .It Va ifconfig_ Ns Aq Ar interface | |
| 984263bc | 811 | .Pq Vt str |
| 717e8ef7 TN |
812 | Configuration for |
| 813 | .Dq interface . | |
| 814 | Typically includes IP address. | |
| 445243bf RG |
815 | Assuming that the interface in question was |
| 816 | .Li ed0 , | |
| 225e0ed5 | 817 | it might look something like this: |
| 984263bc | 818 | .Bd -literal |
| 717e8ef7 | 819 | ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000" |
| 984263bc MD |
820 | .Ed |
| 821 | .Pp | |
| 445243bf RG |
822 | If the |
| 823 | .Pa /etc/start_if. Ns Aq Ar interface | |
| 824 | file is present, it is read and executed by the | |
| 825 | .Xr sh 1 | |
| 225e0ed5 | 826 | interpreter before configuring the interface as specified in the |
| 445243bf RG |
827 | .Va ifconfig_ Ns Aq Ar interface |
| 828 | and | |
| 829 | .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n | |
| 830 | variables. | |
| 831 | .Pp | |
| f26c267a SW |
832 | It is possible to bring up an interface with DHCP by adding |
| 833 | .Dq Li DHCP | |
| 834 | to the | |
| 984263bc | 835 | .Va ifconfig_ Ns Aq Ar interface |
| f26c267a | 836 | variable. |
| 445243bf RG |
837 | For instance, to initialize the |
| 838 | .Li ed0 | |
| 225e0ed5 | 839 | device via DHCP, it is possible to use something like: |
| 984263bc MD |
840 | .Bd -literal |
| 841 | ifconfig_ed0="DHCP" | |
| 842 | .Ed | |
| f26c267a SW |
843 | .Pp |
| 844 | Also, if your interface needs WPA authentication, it is possible to add | |
| 845 | .Dq Li WPA | |
| 846 | to the | |
| 847 | .Va ifconfig_ Ns Aq Ar interface | |
| 848 | variable. | |
| e7e53421 | 849 | This will start |
| bd3478c4 | 850 | .Xr wpa_supplicant 8 . |
| e7e53421 MS |
851 | See |
| 852 | .Xr wpa_supplicant.conf 5 | |
| 853 | for configuring authentication information. | |
| f26c267a SW |
854 | .Pp |
| 855 | Finally, you can add | |
| 856 | .Xr ifconfig 8 | |
| 857 | options in this variable, in addition to the | |
| 858 | .Pa /etc/start_if. Ns Aq Ar interface | |
| 859 | file. | |
| 860 | For instance, to initialize the | |
| 861 | .Li wi0 | |
| 862 | device via DHCP, using WPA authentication and 802.11b mode, it is | |
| 863 | possible to use something like: | |
| 864 | .Bd -literal | |
| 865 | ifconfig_wi0="up DHCP WPA mode 11b" | |
| 866 | .Ed | |
| 867 | .Pp | |
| 717e8ef7 TN |
868 | .\" |
| 869 | .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n | |
| 870 | .Pq Vt str | |
| 871 | Configuration to establish an additional network address for | |
| 872 | .Dq interface . | |
| 873 | Assuming that the interface in question was | |
| 874 | .Li ed0 , | |
| 875 | it might look something like this: | |
| 876 | .Bd -literal | |
| 877 | ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff" | |
| 878 | ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff" | |
| 879 | .Ed | |
| 880 | .Pp | |
| 881 | And so on. | |
| 882 | For each | |
| 883 | .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n | |
| 884 | entry that is found, its contents are passed to | |
| 885 | .Xr ifconfig 8 . | |
| 886 | Execution stops at the first unsuccessful access, so if | |
| 887 | something like this is present: | |
| 888 | .Bd -literal | |
| 889 | ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff" | |
| 890 | ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff" | |
| 891 | ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff" | |
| 892 | ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff" | |
| 893 | .Ed | |
| 894 | .Pp | |
| 895 | Then note that alias4 would | |
| 896 | .Em not | |
| 897 | be added since the search would stop with the missing alias3 entry. | |
| 898 | .Pp | |
| 899 | .\" | |
| 900 | .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name | |
| 901 | .Pq Vt str | |
| 902 | New name for | |
| 903 | .Dq interface . | |
| 904 | It is possible to rename interface by doing: | |
| f26c267a SW |
905 | .Bd -literal |
| 906 | ifconfig_ed0_name="net0" | |
| 907 | ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000" | |
| 908 | .Ed | |
| 717e8ef7 TN |
909 | .It Va network_interfaces |
| 910 | .Pq Vt str | |
| 911 | The list of network interfaces to configure on this host, | |
| 912 | or | |
| 913 | .Dq Li auto | |
| 914 | to configure all network interfaces | |
| 915 | (default | |
| 916 | .Dq Li auto ) . | |
| 917 | For example, if the only network devices to be configured are the loopback device | |
| 918 | .Pq Li lo0 | |
| 919 | and a NIC using the | |
| 920 | .Xr ed 4 | |
| 921 | driver, this could be set to | |
| 922 | .Dq Li "lo0 ed0" . | |
| 923 | An | |
| 924 | .Va ifconfig_ Ns Aq Ar interface | |
| 925 | variable is assumed to exist for each value of | |
| 926 | .Ar interface . | |
| 445243bf RG |
927 | .It Va ipv6_network_interfaces |
| 928 | .Pq Vt str | |
| 929 | This is the IPv6 equivalent of | |
| 930 | .Va network_interfaces . | |
| 931 | Instead of setting the ifconfig variables as | |
| 932 | .Va ifconfig_ Ns Aq Ar interface | |
| 933 | they should be set as | |
| 934 | .Va ipv6_ifconfig_ Ns Aq Ar interface . | |
| 935 | Aliases should be set as | |
| 936 | .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n . | |
| 445243bf RG |
937 | Interfaces that do not have a |
| 938 | .Va ipv6_ifconfig_ Ns Aq Ar interface | |
| 939 | setting will be auto configured by | |
| 940 | .Xr rtsol 8 | |
| 941 | if the | |
| 942 | .Va ipv6_gateway_enable | |
| 943 | is set to | |
| 944 | .Dq Li NO . | |
| 945 | Note that the IPv6 networking code does not support the | |
| 946 | .Pa /etc/start_if. Ns Aq Ar interface | |
| 947 | files. | |
| 717e8ef7 TN |
948 | .It Va ipv6_prefix_ Ns Aq Ar interface |
| 949 | .Pq Vt str | |
| 950 | Assign prefix to | |
| 951 | .Ar interface , | |
| 952 | prefixlen 64 is used. | |
| 445243bf RG |
953 | .It Va ipv6_default_interface |
| 954 | .Pq Vt str | |
| 955 | If not set to | |
| 956 | .Dq Li NO , | |
| 957 | this is the default output interface for scoped addresses. | |
| 958 | Now this works only for IPv6 link local multicast addresses. | |
| 984263bc MD |
959 | .It Va cloned_interfaces |
| 960 | .Pq Vt str | |
| 961 | Set to the list of clonable network interfaces to create on this host. | |
| 962 | Entries in | |
| 963 | .Va cloned_interfaces | |
| 964 | are automatically appended to | |
| 965 | .Va network_interfaces | |
| 966 | for configuration. | |
| 967 | .It Va gif_interfaces | |
| 968 | .Pq Vt str | |
| 969 | Set to the list of | |
| 970 | .Xr gif 4 | |
| 971 | tunnel interfaces to configure on this host. | |
| 972 | A | |
| 973 | .Va gifconfig_ Ns Aq Ar interface | |
| 974 | variable is assumed to exist for each value of | |
| 975 | .Ar interface . | |
| 976 | The value of this variable is used to configure the link layer of the | |
| 977 | tunnel according to the syntax of the | |
| 978 | .Cm tunnel | |
| 979 | option to | |
| 980 | .Xr ifconfig 8 . | |
| 225e0ed5 | 981 | Additionally, this option ensures that each listed interface is created via the |
| 984263bc MD |
982 | .Cm create |
| 983 | option to | |
| 984 | .Xr ifconfig 8 | |
| 985 | before attempting to configure it. | |
| 445243bf RG |
986 | .It Va sppp_interfaces |
| 987 | .Pq Vt str | |
| 988 | Set to the list of | |
| 989 | .Xr sppp 4 | |
| 990 | interfaces to configure on this host. | |
| 991 | A | |
| 992 | .Va spppconfig_ Ns Aq Ar interface | |
| 993 | variable is assumed to exist for each value of | |
| 994 | .Ar interface . | |
| 995 | Each interface should also be configured by a general | |
| 996 | .Va ifconfig_ Ns Aq Ar interface | |
| 997 | setting. | |
| 998 | Refer to | |
| 999 | .Xr spppcontrol 8 | |
| 1000 | for more information about available options. | |
| 984263bc MD |
1001 | .It Va ppp_enable |
| 1002 | .Pq Vt bool | |
| 1003 | If set to | |
| 445243bf | 1004 | .Dq Li YES , |
| 984263bc MD |
1005 | run the |
| 1006 | .Xr ppp 8 | |
| 1007 | daemon. | |
| 1008 | .It Va ppp_mode | |
| 1009 | .Pq Vt str | |
| 1010 | Mode in which to run the | |
| 1011 | .Xr ppp 8 | |
| 445243bf RG |
1012 | daemon. |
| 1013 | Accepted modes are | |
| 1014 | .Dq Li auto , | |
| 1015 | .Dq Li ddial , | |
| 1016 | .Dq Li direct | |
| 984263bc | 1017 | and |
| 445243bf | 1018 | .Dq Li dedicated . |
| 984263bc MD |
1019 | See the manual for a full description. |
| 1020 | .It Va ppp_nat | |
| 1021 | .Pq Vt bool | |
| 1022 | If set to | |
| 445243bf RG |
1023 | .Dq Li YES , |
| 1024 | enables network address translation. | |
| 984263bc MD |
1025 | Used in conjunction with |
| 1026 | .Va gateway_enable | |
| 1027 | allows hosts on private network addresses access to the Internet using | |
| 1028 | this host as a network address translating router. | |
| 1029 | .It Va ppp_profile | |
| 1030 | .Pq Vt str | |
| 1031 | The name of the profile to use from | |
| 1032 | .Pa /etc/ppp/ppp.conf . | |
| 1033 | .It Va ppp_user | |
| 1034 | .Pq Vt str | |
| 445243bf RG |
1035 | The name of the user under which |
| 1036 | .Xr ppp 8 | |
| 1037 | should be started. | |
| 225e0ed5 | 1038 | By default, |
| 445243bf RG |
1039 | .Xr ppp 8 |
| 1040 | is started as | |
| 1041 | .Dq Li root . | |
| 984263bc MD |
1042 | .It Va rc_conf_files |
| 1043 | .Pq Vt str | |
| 1044 | This option is used to specify a list of files that will override | |
| 1045 | the settings in | |
| 1046 | .Pa /etc/defaults/rc.conf . | |
| 1047 | The files will be read in the order in which they are specified and should | |
| 1048 | include the full path to the file. | |
| 1049 | By default, the files specified are | |
| 1050 | .Pa /etc/rc.conf | |
| 1051 | and | |
| 1052 | .Pa /etc/rc.conf.local | |
| 1053 | .It Va fsck_y_enable | |
| 1054 | .Pq Vt bool | |
| 1055 | If set to | |
| 445243bf | 1056 | .Dq Li YES , |
| 984263bc | 1057 | .Xr fsck 8 |
| 445243bf RG |
1058 | will be run with the |
| 1059 | .Fl y | |
| 225e0ed5 | 1060 | flag if the initial preen of the file systems fails. |
| 445243bf RG |
1061 | .It Va netfs_types |
| 1062 | .Pq Vt str | |
| 1063 | List of file system types that are network-based. | |
| 1064 | This list should generally not be modified by end users. | |
| 1065 | Use | |
| 1066 | .Va extra_netfs_types | |
| 1067 | instead. | |
| 1068 | .It Va extra_netfs_types | |
| 1069 | .Pq Vt str | |
| 1070 | If set to something other than | |
| 1071 | .Dq Li NO | |
| 225e0ed5 | 1072 | (the default), this variable extends the list of file system types |
| 445243bf RG |
1073 | for which automatic mounting at startup by |
| 1074 | .Xr rc 8 | |
| 1075 | should be delayed until the network is initialized. | |
| 1076 | It should contain | |
| 1077 | a whitespace-separated list of network file system descriptor pairs, | |
| 1078 | each consisting of a file system type as passed to | |
| 1079 | .Xr mount 8 | |
| 225e0ed5 | 1080 | and a human-readable, one-word description, joined with a colon |
| 445243bf RG |
1081 | .Pq Ql \&: . |
| 1082 | Extending the default list in this way is only necessary | |
| 1083 | when third party file system types are used. | |
| a46854c7 MS |
1084 | .It Va devfs_config_files |
| 1085 | .Pq Vt str | |
| 1086 | This option is used to specify a list of configuration files containing | |
| 1087 | .Xr devfs 5 | |
| 1088 | rules that will be applied by | |
| 1089 | .Xr devfsctl 8 | |
| 1090 | in the order in which they are specified and must include the full path | |
| 1091 | to the file. | |
| 984263bc MD |
1092 | .It Va syslogd_enable |
| 1093 | .Pq Vt bool | |
| 1094 | If set to | |
| 445243bf | 1095 | .Dq Li YES , |
| 984263bc MD |
1096 | run the |
| 1097 | .Xr syslogd 8 | |
| 1098 | daemon. | |
| 1099 | .It Va syslogd_program | |
| 1100 | .Pq Vt str | |
| 1101 | Path to | |
| 1102 | .Xr syslogd 8 | |
| 1103 | (default | |
| 1104 | .Pa /usr/sbin/syslogd ) . | |
| 1105 | .It Va syslogd_flags | |
| 1106 | .Pq Vt str | |
| 1107 | If | |
| 1108 | .Va syslogd_enable | |
| 1109 | is set to | |
| 445243bf | 1110 | .Dq Li YES , |
| 984263bc MD |
1111 | these are the flags to pass to |
| 1112 | .Xr syslogd 8 . | |
| 1113 | .It Va inetd_enable | |
| 1114 | .Pq Vt bool | |
| 1115 | If set to | |
| 445243bf | 1116 | .Dq Li YES , |
| 984263bc MD |
1117 | run the |
| 1118 | .Xr inetd 8 | |
| 1119 | daemon. | |
| 1120 | .It Va inetd_program | |
| 1121 | .Pq Vt str | |
| 1122 | Path to | |
| 1123 | .Xr inetd 8 | |
| 1124 | (default | |
| 1125 | .Pa /usr/sbin/inetd ) . | |
| 1126 | .It Va inetd_flags | |
| 1127 | .Pq Vt str | |
| 1128 | If | |
| 1129 | .Va inetd_enable | |
| 1130 | is set to | |
| 445243bf | 1131 | .Dq Li YES , |
| 984263bc MD |
1132 | these are the flags to pass to |
| 1133 | .Xr inetd 8 . | |
| 1134 | .It Va named_enable | |
| 1135 | .Pq Vt bool | |
| 1136 | If set to | |
| 445243bf | 1137 | .Dq Li YES , |
| 984263bc MD |
1138 | run the |
| 1139 | .Xr named 8 | |
| 1140 | daemon. | |
| 1141 | .It Va named_program | |
| 1142 | .Pq Vt str | |
| 1143 | Path to | |
| 1144 | .Xr named 8 | |
| 1145 | (default | |
| 1146 | .Pa /usr/sbin/named ) . | |
| 1147 | .It Va named_flags | |
| 1148 | .Pq Vt str | |
| 1149 | If | |
| 1150 | .Va named_enable | |
| 1151 | is set to | |
| 445243bf | 1152 | .Dq Li YES , |
| 984263bc MD |
1153 | these are the flags to pass to |
| 1154 | .Xr named 8 . | |
| 445243bf RG |
1155 | .It Va named_pidfile |
| 1156 | .Pq Vt str | |
| 1157 | This is the default path to the | |
| 1158 | .Xr named 8 | |
| 1159 | daemon's PID file. | |
| 1160 | Change it if you change the location in | |
| a523caf4 | 1161 | .Pa /etc/namedb/named.conf . |
| 445243bf RG |
1162 | .It Va named_chrootdir |
| 1163 | .Pq Vt str | |
| 1164 | The root directory for a name server run in a | |
| 1165 | .Xr chroot 8 | |
| 1166 | environment. | |
| 1167 | If left empty | |
| 1168 | .Xr named 8 | |
| 1169 | will not be run in a | |
| 1170 | .Xr chroot 8 | |
| 1171 | environment. | |
| 984263bc MD |
1172 | .It Va rwhod_enable |
| 1173 | .Pq Vt bool | |
| 1174 | If set to | |
| 445243bf | 1175 | .Dq Li YES , |
| 984263bc MD |
1176 | run the |
| 1177 | .Xr rwhod 8 | |
| 1178 | daemon at boot time. | |
| 1179 | .It Va rwhod_flags | |
| 1180 | .Pq Vt str | |
| 1181 | If | |
| 1182 | .Va rwhod_enable | |
| 1183 | is set to | |
| 445243bf | 1184 | .Dq Li YES , |
| 984263bc MD |
1185 | these are the flags to pass to it. |
| 1186 | .It Va amd_enable | |
| 1187 | .Pq Vt bool | |
| 1188 | If set to | |
| 445243bf | 1189 | .Dq Li YES , |
| 984263bc MD |
1190 | run the |
| 1191 | .Xr amd 8 | |
| 1192 | daemon at boot time. | |
| 1193 | .It Va amd_flags | |
| 1194 | .Pq Vt str | |
| 1195 | If | |
| 1196 | .Va amd_enable | |
| 1197 | is set to | |
| 445243bf | 1198 | .Dq Li YES , |
| 984263bc MD |
1199 | these are the flags to pass to it. |
| 1200 | See the | |
| 1201 | .Xr amd 8 | |
| 445243bf | 1202 | manpage for more information. |
| 984263bc MD |
1203 | .It Va amd_map_program |
| 1204 | .Pq Vt str | |
| 225e0ed5 | 1205 | If set, the specified program is run to get the list of |
| 984263bc MD |
1206 | .Xr amd 8 |
| 1207 | maps. | |
| 1208 | For example, if the | |
| 1209 | .Xr amd 8 | |
| 225e0ed5 | 1210 | maps are stored in NIS, one can set this to run |
| 984263bc MD |
1211 | .Xr ypcat 1 |
| 1212 | to get a list of | |
| 1213 | .Xr amd 8 | |
| 1214 | maps from the | |
| 1215 | .Pa amd.master | |
| 1216 | NIS map. | |
| 1217 | .It Va update_motd | |
| 1218 | .Pq Vt bool | |
| 1219 | If set to | |
| 445243bf | 1220 | .Dq Li YES , |
| 984263bc | 1221 | .Pa /etc/motd |
| 225e0ed5 | 1222 | will be updated at boot time to reflect the kernel release being run. |
| 445243bf RG |
1223 | If set to |
| 1224 | .Dq Li NO , | |
| 984263bc | 1225 | .Pa /etc/motd |
| 445243bf | 1226 | will not be updated. |
| 984263bc MD |
1227 | .It Va nfs_client_enable |
| 1228 | .Pq Vt bool | |
| 1229 | If set to | |
| 445243bf | 1230 | .Dq Li YES , |
| 14791e19 | 1231 | setup NFS client parameters at boot time. |
| 984263bc MD |
1232 | .It Va nfs_access_cache |
| 1233 | .Pq Vt int | |
| 1234 | If | |
| 1235 | .Va nfs_client_enable | |
| 1236 | is set to | |
| 445243bf | 1237 | .Dq Li YES , |
| 984263bc | 1238 | this can be set to |
| 445243bf | 1239 | .Dq Li 0 |
| 984263bc | 1240 | to disable NFS ACCESS RPC caching, or to the number of seconds for which |
| 225e0ed5 | 1241 | NFS ACCESS results should be cached. |
| d615ff4f | 1242 | A value of 2-10 seconds will substantially reduce network traffic for |
| 225e0ed5 SW |
1243 | many NFS operations. |
| 1244 | The default is 5 seconds. | |
| 1245 | Note that the attribute cache holds stat information only. | |
| 1246 | The NFS data cache is independent of the attribute cache and is only | |
| 1247 | invalidated when the client detects that the server has modified the | |
| 1248 | underlying file. | |
| 1249 | This value specifies a maximum timeout. | |
| 1250 | The NFS client will automatically use a shorter timeout for files which | |
| 1251 | have been recently modified. | |
| d615ff4f MD |
1252 | .It Va nfs_neg_cache |
| 1253 | .Pq Vt int | |
| 1254 | If | |
| 1255 | .Va nfs_client_enable | |
| 1256 | is set to | |
| 1257 | .Dq Li YES , | |
| 1258 | this can be set to | |
| 1259 | .Dq Li 0 | |
| 3f5e28f4 | 1260 | to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent |
| d615ff4f MD |
1261 | filenames), or to the number of seconds for which negative lookups should |
| 1262 | be cached. | |
| 984263bc | 1263 | A value of 2-10 seconds will substantially reduce network |
| 225e0ed5 SW |
1264 | traffic for many NFS operations, especially source code builds. |
| 1265 | The default is 3 seconds. | |
| 984263bc MD |
1266 | .It Va nfs_server_enable |
| 1267 | .Pq Vt bool | |
| 1268 | If set to | |
| 445243bf | 1269 | .Dq Li YES , |
| 984263bc MD |
1270 | run the NFS server daemons at boot time. |
| 1271 | .It Va nfs_server_flags | |
| 1272 | .Pq Vt str | |
| 1273 | If | |
| 1274 | .Va nfs_server_enable | |
| 1275 | is set to | |
| 445243bf | 1276 | .Dq Li YES , |
| 984263bc MD |
1277 | these are the flags to pass to the |
| 1278 | .Xr nfsd 8 | |
| 1279 | daemon. | |
| 445243bf | 1280 | .It Va mountd_enable |
| 984263bc MD |
1281 | .Pq Vt bool |
| 1282 | If set to | |
| 445243bf | 1283 | .Dq Li YES , |
| 984263bc MD |
1284 | and no |
| 1285 | .Va nfs_server_enable | |
| 1286 | is set, start | |
| 1287 | .Xr mountd 8 , | |
| 1288 | but not | |
| 1289 | .Xr nfsd 8 | |
| 1290 | daemon. | |
| 1291 | It is commonly needed to run CFS without real NFS used. | |
| 1292 | .It Va mountd_flags | |
| 1293 | .Pq Vt str | |
| 1294 | If | |
| 1295 | .Va mountd_enable | |
| 1296 | is set to | |
| 1297 | .Dq Li YES , | |
| 1298 | these are the flags to pass to the | |
| 445243bf | 1299 | .Xr mountd 8 |
| 984263bc MD |
1300 | daemon. |
| 1301 | .It Va weak_mountd_authentication | |
| 1302 | .Pq Vt bool | |
| 1303 | If set to | |
| 445243bf | 1304 | .Dq Li YES , |
| 225e0ed5 | 1305 | allow services like PCNFSD to make non-privileged mount requests. |
| 984263bc MD |
1306 | .It Va nfs_reserved_port_only |
| 1307 | .Pq Vt bool | |
| 1308 | If set to | |
| 445243bf | 1309 | .Dq Li YES , |
| 984263bc MD |
1310 | provide NFS services only on a secure port. |
| 1311 | .It Va nfs_bufpackets | |
| 1312 | .Pq Vt int | |
| 1313 | If set to a number, indicates the number of packets worth of | |
| 1314 | socket buffer space to reserve on an NFS client. | |
| 1315 | The kernel default is typically 4. | |
| 225e0ed5 SW |
1316 | Using a higher number may be useful on gigabit networks to improve performance. |
| 1317 | The minimum value is 2 and the maximum is 64. | |
| 72067a39 MD |
1318 | .It Va rpc_umntall_enable |
| 1319 | .Pq Vt bool | |
| 1320 | If set to | |
| 1321 | .Dq Li YES | |
| 1322 | (default) and we are also an NFS client, run | |
| 1323 | .Xr rpc.umntall 8 | |
| 1324 | at boot time to clear out old mounts on remote servers. | |
| 1325 | If set to | |
| 1326 | .Dq Li NO | |
| 1327 | then | |
| 1328 | .Xr rpc.umntall 8 | |
| 1329 | will not be run at boot time. | |
| 984263bc MD |
1330 | .It Va rpc_lockd_enable |
| 1331 | .Pq Vt bool | |
| 1332 | If set to | |
| 445243bf | 1333 | .Dq Li YES |
| 984263bc MD |
1334 | and also an NFS server, run |
| 1335 | .Xr rpc.lockd 8 | |
| 1336 | at boot time. | |
| 52163b73 SW |
1337 | .It Va rpc_lockd_flags |
| 1338 | .Pq Vt str | |
| 1339 | If | |
| 1340 | .Va rpc_lockd_enable | |
| 1341 | is set to | |
| 1342 | .Dq Li YES , | |
| 1343 | these are the flags to pass to | |
| 1344 | .Xr rpc.lockd 8 . | |
| 984263bc MD |
1345 | .It Va rpc_statd_enable |
| 1346 | .Pq Vt bool | |
| 1347 | If set to | |
| 445243bf | 1348 | .Dq Li YES |
| 984263bc MD |
1349 | and also an NFS server, run |
| 1350 | .Xr rpc.statd 8 | |
| 1351 | at boot time. | |
| 52163b73 SW |
1352 | .It Va rpc_statd_flags |
| 1353 | .Pq Vt str | |
| 1354 | If | |
| 1355 | .Va rpc_statd_enable | |
| 1356 | is set to | |
| 1357 | .Dq Li YES , | |
| 1358 | these are the flags to pass to | |
| 1359 | .Xr rpc.statd 8 . | |
| 445243bf | 1360 | .It Va rpcbind_program |
| 984263bc | 1361 | .Pq Vt str |
| 717e8ef7 | 1362 | Path to program for rpcbind daemon |
| 984263bc | 1363 | (default |
| 3b813696 | 1364 | .Pa /usr/sbin/rpcbind ) . |
| 445243bf | 1365 | .It Va rpcbind_enable |
| 984263bc MD |
1366 | .Pq Vt bool |
| 1367 | If set to | |
| 445243bf | 1368 | .Dq Li YES , |
| 717e8ef7 TN |
1369 | run |
| 1370 | .Va rpcbind_program | |
| 1371 | at boot time. | |
| 445243bf | 1372 | .It Va rpcbind_flags |
| 984263bc MD |
1373 | .Pq Vt str |
| 1374 | If | |
| 445243bf | 1375 | .Va rpcbind_enable |
| 984263bc | 1376 | is set to |
| 445243bf | 1377 | .Dq Li YES , |
| 717e8ef7 TN |
1378 | these are the flags to pass to |
| 1379 | .Va rpcbind_program . | |
| 445243bf | 1380 | .It Va keyserv_enable |
| 984263bc MD |
1381 | .Pq Vt bool |
| 1382 | If set to | |
| 445243bf RG |
1383 | .Dq Li YES , |
| 1384 | run the | |
| 1385 | .Xr keyserv 8 | |
| 1386 | daemon on boot for running Secure RPC. | |
| 1387 | .It Va keyserv_flags | |
| 984263bc MD |
1388 | .Pq Vt str |
| 1389 | If | |
| 445243bf | 1390 | .Va keyserv_enable |
| 984263bc | 1391 | is set to |
| 445243bf RG |
1392 | .Dq Li YES , |
| 1393 | these are the flags to pass to | |
| 1394 | .Xr keyserv 8 | |
| 984263bc MD |
1395 | daemon. |
| 1396 | .It Va pppoed_enable | |
| 1397 | .Pq Vt bool | |
| 1398 | If set to | |
| 445243bf RG |
1399 | .Dq Li YES , |
| 1400 | run the | |
| 984263bc MD |
1401 | .Xr pppoed 8 |
| 1402 | daemon at boot time to provide PPP over Ethernet services. | |
| 850afac2 | 1403 | .It Va pppoed_provider |
| 984263bc MD |
1404 | .Pq Vt str |
| 1405 | .Xr pppoed 8 | |
| 850afac2 | 1406 | listens to requests to this provider and ultimately runs |
| 984263bc MD |
1407 | .Xr ppp 8 |
| 1408 | with a | |
| 1409 | .Ar system | |
| 1410 | argument of the same name. | |
| 1411 | .It Va pppoed_flags | |
| 1412 | .Pq Vt str | |
| 1413 | Additional flags to pass to | |
| 1414 | .Xr pppoed 8 . | |
| 1415 | .It Va pppoed_interface | |
| 1416 | .Pq Vt str | |
| 445243bf RG |
1417 | The network interface to run |
| 1418 | .Xr pppoed 8 | |
| 1419 | on. | |
| 1420 | This is mandatory when | |
| 984263bc MD |
1421 | .Va pppoed_enable |
| 1422 | is set to | |
| 445243bf | 1423 | .Dq Li YES . |
| 984263bc | 1424 | .It Va timed_enable |
| 445243bf RG |
1425 | .Pq Vt bool |
| 1426 | If set to | |
| 1427 | .Dq Li YES , | |
| 1428 | run the | |
| 984263bc | 1429 | .Xr timed 8 |
| 445243bf | 1430 | service at boot time. |
| 225e0ed5 | 1431 | This command is intended for networks of machines where a consistent |
| 445243bf RG |
1432 | .Dq "network time" |
| 1433 | for all hosts must be established. | |
| 225e0ed5 SW |
1434 | This is often useful in large NFS environments where time stamps on |
| 1435 | files are expected to be consistent network-wide. | |
| 984263bc MD |
1436 | .It Va timed_flags |
| 1437 | .Pq Vt str | |
| 1438 | If | |
| 1439 | .Va timed_enable | |
| 1440 | is set to | |
| 445243bf | 1441 | .Dq Li YES , |
| 984263bc MD |
1442 | these are the flags to pass to the |
| 1443 | .Xr timed 8 | |
| 1444 | service. | |
| 850afac2 SW |
1445 | .It Va dntpd_enable |
| 1446 | .Pq Vt bool | |
| 1447 | If set to | |
| 1448 | .Dq Li YES , | |
| 1449 | run | |
| 1450 | .Xr dntpd 8 | |
| 1451 | at system boot time. | |
| 1452 | .It Va dntpd_program | |
| 1453 | .Pq Vt str | |
| 1454 | Path to | |
| 1455 | .Xr dntpd 8 | |
| 1456 | (default | |
| 1457 | .Pa /usr/sbin/dntpd ) . | |
| 1458 | .It Va dntpd_flags | |
| 1459 | .Pq Vt str | |
| 1460 | If | |
| 1461 | .Va dntpd_enable | |
| 1462 | is set to | |
| 1463 | .Dq Li YES , | |
| 1464 | these are the flags to pass to the | |
| 1465 | .Xr dntpd 8 | |
| 1466 | daemon. | |
| 5f834906 SW |
1467 | .It Va btconfig_enable |
| 1468 | .Pq Vt bool | |
| 1469 | If set to | |
| 1470 | .Dq Li YES , | |
| 1471 | configure Bluetooth devices via | |
| 1472 | .Xr btconfig 8 | |
| 1473 | at system boot time. | |
| 1474 | .It Va btconfig_devices | |
| 1475 | .Pq Vt str | |
| 1476 | If | |
| 1477 | .Va btconfig_enable | |
| 1478 | is set to | |
| 1479 | .Dq Li YES , | |
| 1480 | this is the list of Bluetooth devices to configure. | |
| 1481 | If | |
| 1482 | .Va btconfig_devices | |
| 1483 | is not specified, all devices known to the system will be configured. | |
| 1484 | A | |
| 1485 | .Va btconfig_ Ns Aq Ar device | |
| 1486 | variable can be set to specify parameters to be passed to | |
| 1487 | .Ar device . | |
| 1488 | .It Va btconfig_args | |
| 1489 | .Pq Vt str | |
| 1490 | If | |
| 1491 | .Va btconfig_enable | |
| 1492 | is set to | |
| 1493 | .Dq Li YES , | |
| 1494 | this is the list of configuration parameters to pass to all Bluetooth | |
| 1495 | devices. | |
| 1496 | .It Va sdpd_enable | |
| 1497 | .Pq Vt bool | |
| 1498 | If set to | |
| 1499 | .Dq Li YES , | |
| 1500 | run the Service Discovery Profile daemon | |
| 1501 | .Xr ( sdpd 8 ) | |
| 1502 | at system boot time. | |
| 1503 | .It Va sdpd_flags | |
| 1504 | .Pq Vt str | |
| 1505 | If | |
| 1506 | .Va sdpd_enable | |
| 1507 | is set to | |
| 1508 | .Dq Li YES , | |
| 1509 | these are the flags to pass to the | |
| 1510 | .Xr sdpd 8 | |
| 1511 | daemon. | |
| ec4e37b7 HT |
1512 | .It Va bthcid_enable |
| 1513 | .Pq Vt bool | |
| 1514 | If set to | |
| 1515 | .Dq Li YES , | |
| 1516 | run the Bluetooth Link Key/PIN Code Manager daemon | |
| 1517 | .Xr ( bthcid 8 ) | |
| 1518 | at system boot time. | |
| 1519 | .It Va bthcid_flags | |
| 1520 | .Pq Vt str | |
| 1521 | If | |
| 1522 | .Va bthcid_enable | |
| 1523 | is set to | |
| 1524 | .Dq Li YES , | |
| 1525 | these are the flags to pass to the | |
| 1526 | .Xr bthcid 8 | |
| 1527 | daemon. | |
| 984263bc MD |
1528 | .It Va nis_client_enable |
| 1529 | .Pq Vt bool | |
| 1530 | If set to | |
| 445243bf RG |
1531 | .Dq Li YES , |
| 1532 | run the | |
| 984263bc MD |
1533 | .Xr ypbind 8 |
| 1534 | service at system boot time. | |
| 1535 | .It Va nis_client_flags | |
| 1536 | .Pq Vt str | |
| 1537 | If | |
| 1538 | .Va nis_client_enable | |
| 1539 | is set to | |
| 445243bf | 1540 | .Dq Li YES , |
| 984263bc MD |
1541 | these are the flags to pass to the |
| 1542 | .Xr ypbind 8 | |
| 1543 | service. | |
| 1544 | .It Va nis_ypset_enable | |
| 1545 | .Pq Vt bool | |
| 1546 | If set to | |
| 445243bf RG |
1547 | .Dq Li YES , |
| 1548 | run the | |
| 984263bc MD |
1549 | .Xr ypset 8 |
| 1550 | daemon at system boot time. | |
| 1551 | .It Va nis_ypset_flags | |
| 1552 | .Pq Vt str | |
| 1553 | If | |
| 1554 | .Va nis_ypset_enable | |
| 1555 | is set to | |
| 445243bf | 1556 | .Dq Li YES , |
| 984263bc MD |
1557 | these are the flags to pass to the |
| 1558 | .Xr ypset 8 | |
| 1559 | daemon. | |
| 1560 | .It Va nis_server_enable | |
| 1561 | .Pq Vt bool | |
| 1562 | If set to | |
| 445243bf RG |
1563 | .Dq Li YES , |
| 1564 | run the | |
| 984263bc MD |
1565 | .Xr ypserv 8 |
| 1566 | daemon at system boot time. | |
| 1567 | .It Va nis_server_flags | |
| 1568 | .Pq Vt str | |
| 1569 | If | |
| 1570 | .Va nis_server_enable | |
| 1571 | is set to | |
| 445243bf | 1572 | .Dq Li YES , |
| 984263bc MD |
1573 | these are the flags to pass to the |
| 1574 | .Xr ypserv 8 | |
| 1575 | daemon. | |
| 1576 | .It Va nis_ypxfrd_enable | |
| 1577 | .Pq Vt bool | |
| 1578 | If set to | |
| 445243bf RG |
1579 | .Dq Li YES , |
| 1580 | run the | |
| 984263bc MD |
1581 | .Xr rpc.ypxfrd 8 |
| 1582 | daemon at system boot time. | |
| 1583 | .It Va nis_ypxfrd_flags | |
| 1584 | .Pq Vt str | |
| 1585 | If | |
| 1586 | .Va nis_ypxfrd_enable | |
| 1587 | is set to | |
| 445243bf | 1588 | .Dq Li YES , |
| 984263bc MD |
1589 | these are the flags to pass to the |
| 1590 | .Xr rpc.ypxfrd 8 | |
| 1591 | daemon. | |
| 1592 | .It Va nis_yppasswdd_enable | |
| 1593 | .Pq Vt bool | |
| 1594 | If set to | |
| 445243bf RG |
1595 | .Dq Li YES , |
| 1596 | run the | |
| 984263bc MD |
1597 | .Xr rpc.yppasswdd 8 |
| 1598 | daemon at system boot time. | |
| 1599 | .It Va nis_yppasswdd_flags | |
| 1600 | .Pq Vt str | |
| 1601 | If | |
| 1602 | .Va nis_yppasswdd_enable | |
| 1603 | is set to | |
| 445243bf | 1604 | .Dq Li YES , |
| 984263bc MD |
1605 | these are the flags to pass to the |
| 1606 | .Xr rpc.yppasswdd 8 | |
| 1607 | daemon. | |
| 445243bf RG |
1608 | .It Va rpc_ypupdated_enable |
| 1609 | .Pq Vt bool | |
| 1610 | If set to | |
| 1611 | .Dq Li YES , | |
| 1612 | run the | |
| 1613 | .Nm rpc.ypupdated | |
| 1614 | daemon at system boot time. | |
| 984263bc MD |
1615 | .It Va defaultrouter |
| 1616 | .Pq Vt str | |
| 1617 | If not set to | |
| 445243bf RG |
1618 | .Dq Li NO , |
| 1619 | create a default route to this host name or IP address | |
| 984263bc MD |
1620 | (use an IP address if this router is also required to get to the |
| 1621 | name server!). | |
| 445243bf RG |
1622 | .It Va ipv6_defaultrouter |
| 1623 | .Pq Vt str | |
| 1624 | The IPv6 equivalent of | |
| 1625 | .Va defaultrouter . | |
| 984263bc MD |
1626 | .It Va static_routes |
| 1627 | .Pq Vt str | |
| 225e0ed5 | 1628 | Set to the list of static routes that are to be added at system boot time. |
| 445243bf RG |
1629 | If not set to |
| 1630 | .Dq Li NO | |
| 984263bc MD |
1631 | then for each whitespace separated |
| 1632 | .Ar element | |
| 1633 | in the value, a | |
| 1634 | .Va route_ Ns Aq Ar element | |
| 225e0ed5 | 1635 | variable is assumed to exist whose contents will later be passed to a |
| 445243bf RG |
1636 | .Dq Nm route Cm add |
| 1637 | operation. | |
| 1638 | .It Va ipv6_static_routes | |
| 1639 | .Pq Vt str | |
| 1640 | The IPv6 equivalent of | |
| 1641 | .Va static_routes . | |
| 1642 | If not set to | |
| 1643 | .Dq Li NO | |
| 1644 | then for each whitespace separated | |
| 1645 | .Ar element | |
| 1646 | in the value, a | |
| 1647 | .Va ipv6_route_ Ns Aq Ar element | |
| 225e0ed5 | 1648 | variable is assumed to exist whose contents will later be passed to a |
| 445243bf | 1649 | .Dq Nm route Cm add Fl inet6 |
| 984263bc MD |
1650 | operation. |
| 1651 | .It Va gateway_enable | |
| 1652 | .Pq Vt bool | |
| 1653 | If set to | |
| 445243bf RG |
1654 | .Dq Li YES , |
| 1655 | configure host to act as an IP router, e.g. to forward packets | |
| 984263bc | 1656 | between interfaces. |
| 445243bf RG |
1657 | .It Va ipv6_gateway_enable |
| 1658 | .Pq Vt bool | |
| 1659 | The IPv6 equivalent of | |
| 1660 | .Va gateway_enable . | |
| 984263bc MD |
1661 | .It Va router_enable |
| 1662 | .Pq Vt bool | |
| 1663 | If set to | |
| 445243bf | 1664 | .Dq Li YES , |
| 225e0ed5 | 1665 | run a routing daemon of some sort, based on the settings of |
| 221b91ff | 1666 | .Va router_program |
| 984263bc MD |
1667 | and |
| 1668 | .Va router_flags . | |
| 445243bf RG |
1669 | .It Va ipv6_router_enable |
| 1670 | .Pq Vt bool | |
| 1671 | The IPv6 equivalent of | |
| 1672 | .Va router_enable . | |
| 1673 | If set to | |
| 1674 | .Dq Li YES , | |
| 225e0ed5 | 1675 | run a routing daemon of some sort, based on the settings of |
| 221b91ff | 1676 | .Va ipv6_router_program |
| 445243bf RG |
1677 | and |
| 1678 | .Va ipv6_router_flags . | |
| 221b91ff | 1679 | .It Va router_program |
| 984263bc MD |
1680 | .Pq Vt str |
| 1681 | If | |
| 1682 | .Va router_enable | |
| 1683 | is set to | |
| 445243bf | 1684 | .Dq Li YES , |
| 717e8ef7 TN |
1685 | this is the name of the routing daemon to use |
| 1686 | (default | |
| 1687 | .Pa /sbin/routed ) . | |
| 221b91ff | 1688 | .It Va ipv6_router_program |
| 445243bf RG |
1689 | .Pq Vt str |
| 1690 | The IPv6 equivalent of | |
| 717e8ef7 TN |
1691 | .Va router_program |
| 1692 | (default | |
| 1693 | .Pa /sbin/route6d ) . | |
| 984263bc MD |
1694 | .It Va router_flags |
| 1695 | .Pq Vt str | |
| 1696 | If | |
| 1697 | .Va router_enable | |
| 1698 | is set to | |
| 445243bf | 1699 | .Dq Li YES , |
| 984263bc | 1700 | these are the flags to pass to the routing daemon. |
| 445243bf RG |
1701 | .It Va ipv6_router_flags |
| 1702 | .Pq Vt str | |
| 1703 | The IPv6 equivalent of | |
| 1704 | .Va router_flags . | |
| 984263bc MD |
1705 | .It Va mrouted_enable |
| 1706 | .Pq Vt bool | |
| 1707 | If set to | |
| 445243bf RG |
1708 | .Dq Li YES , |
| 1709 | run the multicast routing daemon, | |
| 984263bc | 1710 | .Xr mrouted 8 . |
| 445243bf RG |
1711 | .It Va mroute6d_enable |
| 1712 | .Pq Vt bool | |
| 1713 | The IPv6 equivalent of | |
| 1714 | .Va mrouted_enable . | |
| 1715 | If set to | |
| 1716 | .Dq Li YES , | |
| 1717 | run the IPv6 multicast routing daemon. | |
| 1718 | Note that no IPv6 multicast routing daemon is included in the | |
| 9bb2a92d | 1719 | .Dx |
| 445243bf RG |
1720 | base system but |
| 1721 | .Xr pim6dd 8 | |
| 28feafc7 SW |
1722 | can be installed from the |
| 1723 | .Xr pkgsrc 7 | |
| 1724 | collection. | |
| 984263bc MD |
1725 | .It Va mrouted_flags |
| 1726 | .Pq Vt str | |
| 1727 | If | |
| 1728 | .Va mrouted_enable | |
| 1729 | is set to | |
| 445243bf RG |
1730 | .Dq Li YES , |
| 1731 | these are the flags to pass to the | |
| 1732 | .Xr mrouted 8 | |
| 1733 | daemon. | |
| 1734 | .It Va mroute6d_flags | |
| 1735 | .Pq Vt str | |
| 1736 | The IPv6 equivalent of | |
| 1737 | .Va mrouted_flags . | |
| 1738 | If | |
| 1739 | .Va mroute6d_enable | |
| 1740 | is set to | |
| 1741 | .Dq Li YES , | |
| 1742 | these are the flags passed to the IPv6 multicast routing daemon. | |
| 1743 | .It Va mroute6d_program | |
| 1744 | .Pq Vt str | |
| 1745 | If | |
| 1746 | .Va mroute6d_enable | |
| 1747 | is set to | |
| 1748 | .Dq Li YES , | |
| 1749 | this is the path to the IPv6 multicast routing daemon. | |
| 1750 | .It Va rtadvd_enable | |
| 1751 | .Pq Vt bool | |
| 1752 | If set to | |
| 1753 | .Dq Li YES , | |
| 1754 | run the | |
| 1755 | .Xr rtadvd 8 | |
| 1756 | daemon at boot time. | |
| 1757 | .Xr rtadvd 8 | |
| 1758 | will only run if | |
| 1759 | .Va ipv6_gateway_enable | |
| 1760 | is also set to | |
| 1761 | .Dq Li YES . | |
| 1762 | The | |
| 1763 | .Xr rtadvd 8 | |
| 1764 | utility sends router advertisement packets to the interfaces specified in | |
| 1765 | .Va rtadvd_interfaces . | |
| 1766 | .Xr rtadvd 8 | |
| 1767 | and should only be enabled with great care. | |
| 1768 | You may want to fine-tune | |
| 1769 | .Xr rtadvd.conf 5 . | |
| 1770 | .It Va rtadvd_interfaces | |
| 1771 | .Pq Vt str | |
| 1772 | If | |
| 1773 | .Va rtadvd_enable | |
| 1774 | is set to | |
| 1775 | .Dq Li YES | |
| 1776 | this is the list of interfaces to use. | |
| bdbd8a5b SW |
1777 | .It Va rtsold_enable |
| 1778 | .Pq Vt bool | |
| 1779 | If set to | |
| 1780 | .Dq Li YES , | |
| 1781 | run the | |
| 1782 | .Xr rtsold 8 | |
| 1783 | daemon at boot time. | |
| 1784 | The | |
| 1785 | .Xr rtsold 8 | |
| 1786 | daemon is used for automatic discovery of non-link local addresses. | |
| 1787 | .It Va rtsold_flags | |
| 1788 | .Pq Vt str | |
| 1789 | If | |
| 1790 | .Va rtsold_enable | |
| 1791 | is set to | |
| 1792 | .Dq Li YES , | |
| 1793 | these are the flags to pass to the | |
| 1794 | .Xr rtsold 8 | |
| 1795 | daemon. | |
| 984263bc MD |
1796 | .It Va ipxgateway_enable |
| 1797 | .Pq Vt bool | |
| 1798 | If set to | |
| 445243bf RG |
1799 | .Dq Li YES , |
| 1800 | enable the routing of IPX traffic. | |
| 984263bc MD |
1801 | .It Va ipxrouted_enable |
| 1802 | .Pq Vt bool | |
| 1803 | If set to | |
| 445243bf RG |
1804 | .Dq Li YES , |
| 1805 | run the | |
| 984263bc MD |
1806 | .Xr IPXrouted 8 |
| 1807 | daemon at system boot time. | |
| 1808 | .It Va ipxrouted_flags | |
| 1809 | .Pq Vt str | |
| 1810 | If | |
| 1811 | .Va ipxrouted_enable | |
| 1812 | is set to | |
| 445243bf | 1813 | .Dq Li YES , |
| 984263bc MD |
1814 | these are the flags to pass to the |
| 1815 | .Xr IPXrouted 8 | |
| 1816 | daemon. | |
| 1817 | .It Va arpproxy_all | |
| 1818 | .Pq Vt bool | |
| 1819 | If set to | |
| 445243bf RG |
1820 | .Dq Li YES , |
| 1821 | enable global proxy ARP. | |
| 984263bc MD |
1822 | .It Va forward_sourceroute |
| 1823 | .Pq Vt bool | |
| 1824 | If set to | |
| 445243bf RG |
1825 | .Dq Li YES |
| 1826 | and | |
| 984263bc MD |
1827 | .Va gateway_enable |
| 1828 | is also set to | |
| 445243bf RG |
1829 | .Dq Li YES , |
| 1830 | source-routed packets are forwarded. | |
| 984263bc MD |
1831 | .It Va accept_sourceroute |
| 1832 | .Pq Vt bool | |
| 1833 | If set to | |
| 445243bf RG |
1834 | .Dq Li YES , |
| 1835 | the system will accept source-routed packets directed at it. | |
| 984263bc MD |
1836 | .It Va rarpd_enable |
| 1837 | .Pq Vt bool | |
| 1838 | If set to | |
| 445243bf RG |
1839 | .Dq Li YES , |
| 1840 | run the | |
| 984263bc MD |
1841 | .Xr rarpd 8 |
| 1842 | daemon at system boot time. | |
| 1843 | .It Va rarpd_flags | |
| 1844 | .Pq Vt str | |
| 1845 | If | |
| 1846 | .Va rarpd_enable | |
| 1847 | is set to | |
| 445243bf | 1848 | .Dq Li YES , |
| 984263bc MD |
1849 | these are the flags to pass to the |
| 1850 | .Xr rarpd 8 | |
| 1851 | daemon. | |
| 445243bf RG |
1852 | .It Va bootparamd_enable |
| 1853 | .Pq Vt bool | |
| 1854 | If set to | |
| 1855 | .Dq Li YES , | |
| 1856 | run the | |
| 1857 | .Xr bootparamd 8 | |
| 1858 | daemon at system boot time. | |
| 1859 | .It Va bootparamd_flags | |
| 1860 | .Pq Vt str | |
| 1861 | If | |
| 1862 | .Va bootparamd_enable | |
| 1863 | is set to | |
| 1864 | .Dq Li YES , | |
| 1865 | these are the flags to pass to the | |
| 1866 | .Xr bootparamd 8 | |
| 1867 | daemon. | |
| 1868 | .It Va stf_interface_ipv4addr | |
| 1869 | .Pq Vt str | |
| 1870 | If not set to | |
| 1871 | .Dq Li NO , | |
| 225e0ed5 | 1872 | this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface). |
| 445243bf RG |
1873 | Specify this entry to enable the 6to4 interface. |
| 1874 | .It Va stf_interface_ipv4plen | |
| 1875 | .Pq Vt int | |
| 1876 | Prefix length for 6to4 IPv4 addresses, to limit peer address range. | |
| 1877 | An effective value is 0-31. | |
| 1878 | .It Va stf_interface_ipv6_ifid | |
| 1879 | .Pq Vt str | |
| 1880 | IPv6 interface ID for | |
| 1881 | .Xr stf 4 . | |
| 1882 | This can be set to | |
| 1883 | .Dq Li AUTO . | |
| 1884 | .It Va stf_interface_ipv6_slaid | |
| 1885 | .Pq Vt str | |
| 1886 | IPv6 Site Level Aggregator for | |
| 1887 | .Xr stf 4 . | |
| 1888 | .It Va ipv6_faith_prefix | |
| 1889 | .Pq Vt str | |
| 1890 | If not set to | |
| 1891 | .Dq Li NO , | |
| 225e0ed5 | 1892 | this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator. |
| 445243bf RG |
1893 | You also need |
| 1894 | .Xr faithd 8 | |
| 1895 | setup. | |
| 1896 | .It Va ipv6_ipv4mapping | |
| 1897 | .Pq Vt bool | |
| 1898 | If set to | |
| 1899 | .Dq Li YES | |
| 1900 | this enables IPv4 mapped IPv6 address communication (like | |
| 1901 | .Li ::ffff:a.b.c.d ) . | |
| 984263bc MD |
1902 | .It Va atm_enable |
| 1903 | .Pq Vt bool | |
| 1904 | Set to | |
| 445243bf | 1905 | .Dq Li YES |
| 984263bc MD |
1906 | to enable the configuration of ATM interfaces at system boot time. |
| 1907 | For all of the ATM variables described below, please refer to the | |
| 1908 | .Xr atm 8 | |
| 1909 | man page for further details on the available command parameters. | |
| 1910 | Also refer to the files in | |
| 1911 | .Pa /usr/share/examples/atm | |
| 1912 | for more detailed configuration information. | |
| 445243bf | 1913 | .It Va atm_netif_ Ns Aq Ar intf |
| 984263bc MD |
1914 | .Pq Vt str |
| 1915 | For the ATM physical interface | |
| 445243bf RG |
1916 | .Ar intf , |
| 1917 | this variable defines the name prefix and count for the ATM network | |
| 1918 | interfaces to be created. | |
| 984263bc | 1919 | The value will be passed as the parameters of an |
| 445243bf | 1920 | .Dq Nm atm Cm "set netif" Ar intf |
| 984263bc | 1921 | command. |
| 445243bf | 1922 | .It Va atm_sigmgr_ Ns Aq Ar intf |
| 984263bc MD |
1923 | .Pq Vt str |
| 1924 | For the ATM physical interface | |
| 445243bf | 1925 | .Ar intf , |
| 984263bc MD |
1926 | this variable defines the ATM signalling manager to be used. |
| 1927 | The value will be passed as the parameters of an | |
| 445243bf | 1928 | .Dq Nm atm Cm attach Ar intf |
| 984263bc | 1929 | command. |
| 445243bf | 1930 | .It Va atm_prefix_ Ns Aq Ar intf |
| 984263bc MD |
1931 | .Pq Vt str |
| 1932 | For the ATM physical interface | |
| 445243bf | 1933 | .Ar intf , |
| 984263bc | 1934 | this variable defines the NSAP prefix for interfaces using a UNI signalling |
| 445243bf RG |
1935 | manager. |
| 1936 | If set to | |
| 1937 | .Dq Li ILMI , | |
| 1938 | the prefix will automatically be set via the | |
| 984263bc | 1939 | .Xr ilmid 8 |
| 445243bf RG |
1940 | daemon. |
| 1941 | Otherwise, the value will be passed as the parameters of an | |
| 1942 | .Dq Nm atm Cm "set prefix" Ar intf | |
| 984263bc | 1943 | command. |
| 445243bf | 1944 | .It Va atm_macaddr_ Ns Aq Ar intf |
| 984263bc MD |
1945 | .Pq Vt str |
| 1946 | For the ATM physical interface | |
| 445243bf | 1947 | .Ar intf , |
| 984263bc | 1948 | this variable defines the MAC address for interfaces using a UNI signalling |
| 445243bf RG |
1949 | manager. |
| 1950 | If set to | |
| 1951 | .Dq Li NO , | |
| 1952 | the hardware MAC address contained in the ATM interface card will be used. | |
| 984263bc | 1953 | Otherwise, the value will be passed as the parameters of an |
| 445243bf | 1954 | .Dq Nm atm Cm "set mac" Ar intf |
| 984263bc | 1955 | command. |
| 445243bf | 1956 | .It Va atm_arpserver_ Ns Aq Ar netif |
| 984263bc MD |
1957 | .Pq Vt str |
| 1958 | For the ATM network interface | |
| 445243bf | 1959 | .Ar netif , |
| 984263bc | 1960 | this variable defines the ATM address for a host which is to provide ATMARP |
| 445243bf | 1961 | service. |
| 225e0ed5 | 1962 | This variable is only applicable to interfaces using a UNI signalling manager. |
| 445243bf RG |
1963 | If set to |
| 1964 | .Dq Li local , | |
| 1965 | this host will become an ATMARP server. | |
| 984263bc | 1966 | The value will be passed as the parameters of an |
| 445243bf | 1967 | .Dq Nm atm Cm "set arpserver" Ar netif |
| 984263bc | 1968 | command. |
| 445243bf | 1969 | .It Va atm_scsparp_ Ns Aq Ar netif |
| 984263bc MD |
1970 | .Pq Vt bool |
| 1971 | If set to | |
| 445243bf RG |
1972 | .Dq Li YES , |
| 1973 | SCSP/ATMARP service for the network interface | |
| 1974 | .Ar netif | |
| 984263bc MD |
1975 | will be initiated using the |
| 1976 | .Xr scspd 8 | |
| 1977 | and | |
| 1978 | .Xr atmarpd 8 | |
| 445243bf RG |
1979 | daemons. |
| 1980 | This variable is only applicable if | |
| 984263bc | 1981 | .Va atm_arpserver_ Ns Aq Ar netif |
| 445243bf RG |
1982 | is set to |
| 1983 | .Dq Li local . | |
| 984263bc MD |
1984 | .It Va atm_arps |
| 1985 | .Pq Vt str | |
| 225e0ed5 | 1986 | Set to the list of permanent ATM ARP entries to be added at system boot time. |
| 445243bf | 1987 | For each whitespace separated |
| 984263bc MD |
1988 | .Ar element |
| 1989 | in the value, an | |
| 1990 | .Va atm_arp_ Ns Aq Ar element | |
| 445243bf | 1991 | variable is assumed to exist. |
| 225e0ed5 | 1992 | The value of each of these variables will be passed as the parameters of an |
| 445243bf | 1993 | .Dq Nm atm Cm "add arp" |
| 984263bc | 1994 | command. |
| 445243bf RG |
1995 | .It Va keybell |
| 1996 | .Pq Vt str | |
| 1997 | The keyboard bell sound. | |
| 1998 | Set to | |
| 1999 | .Dq Li normal , | |
| 2000 | .Dq Li visual , | |
| 2001 | .Dq Li off , | |
| 2002 | or | |
| 2003 | .Dq Li NO | |
| 2004 | if the default behavior is desired. | |
| 2005 | For details, refer to the | |
| 2006 | .Xr kbdcontrol 1 | |
| 2007 | manpage. | |
| 984263bc MD |
2008 | .It Va keymap |
| 2009 | .Pq Vt str | |
| 2010 | If set to | |
| 445243bf RG |
2011 | .Dq Li NO , |
| 2012 | no keymap is installed, otherwise the value is used to install | |
| 984263bc | 2013 | the keymap file in |
| 445243bf | 2014 | .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd . |
| 984263bc MD |
2015 | .It Va keyrate |
| 2016 | .Pq Vt str | |
| 445243bf RG |
2017 | The keyboard repeat speed. |
| 2018 | Set to | |
| 2019 | .Dq Li slow , | |
| 2020 | .Dq Li normal , | |
| 2021 | .Dq Li fast , | |
| 984263bc | 2022 | or |
| 445243bf | 2023 | .Dq Li NO |
| 984263bc MD |
2024 | if the default behavior is desired. |
| 2025 | .It Va keychange | |
| 2026 | .Pq Vt str | |
| 2027 | If not set to | |
| 445243bf RG |
2028 | .Dq Li NO , |
| 2029 | attempt to program the function keys with the value. | |
| 225e0ed5 | 2030 | The value should be a single string of the form: |
| 445243bf | 2031 | .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... . |
| 984263bc MD |
2032 | .It Va cursor |
| 2033 | .Pq Vt str | |
| 2034 | Can be set to the value of | |
| 445243bf RG |
2035 | .Dq Li normal , |
| 2036 | .Dq Li blink , | |
| 2037 | .Dq Li destructive , | |
| 984263bc | 2038 | or |
| 445243bf | 2039 | .Dq Li NO |
| 984263bc MD |
2040 | to set the cursor behavior explicitly or choose the default behavior. |
| 2041 | .It Va scrnmap | |
| 2042 | .Pq Vt str | |
| 2043 | If set to | |
| 445243bf RG |
2044 | .Dq Li NO , |
| 2045 | no screen map is installed, otherwise the value is used to install | |
| 984263bc | 2046 | the screen map file in |
| 445243bf | 2047 | .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value . |
| 984263bc MD |
2048 | .It Va font8x16 |
| 2049 | .Pq Vt str | |
| 2050 | If set to | |
| 445243bf RG |
2051 | .Dq Li NO , |
| 2052 | the default 8x16 font value is used for screen size requests, otherwise | |
| 984263bc | 2053 | the value in |
| 445243bf | 2054 | .Pa /usr/share/syscons/fonts/ Ns Aq Ar value |
| 984263bc MD |
2055 | is used. |
| 2056 | .It Va font8x14 | |
| 2057 | .Pq Vt str | |
| 2058 | If set to | |
| 445243bf RG |
2059 | .Dq Li NO , |
| 2060 | the default 8x14 font value is used for screen size requests, otherwise | |
| 984263bc | 2061 | the value in |
| 445243bf | 2062 | .Pa /usr/share/syscons/fonts/ Ns Aq Ar value |
| 984263bc MD |
2063 | is used. |
| 2064 | .It Va font8x8 | |
| 2065 | .Pq Vt str | |
| 2066 | If set to | |
| 445243bf RG |
2067 | .Dq Li NO , |
| 2068 | the default 8x8 font value is used for screen size requests, otherwise | |
| 984263bc | 2069 | the value in |
| 445243bf | 2070 | .Pa /usr/share/syscons/fonts/ Ns Aq Ar value |
| 984263bc MD |
2071 | is used. |
| 2072 | .It Va blanktime | |
| 2073 | .Pq Vt int | |
| 2074 | If set to | |
| 445243bf | 2075 | .Dq Li NO , |
| 225e0ed5 | 2076 | the default screen blanking interval is used, otherwise it is set to |
| 984263bc MD |
2077 | .Ar value |
| 2078 | seconds. | |
| 2079 | .It Va saver | |
| 2080 | .Pq Vt str | |
| 2081 | If not set to | |
| 445243bf RG |
2082 | .Dq Li NO , |
| 2083 | this is the actual screen saver to use | |
| 2084 | .Li ( blank , snake , daemon , | |
| 2085 | etc). | |
| 984263bc MD |
2086 | .It Va moused_enable |
| 2087 | .Pq Vt str | |
| 2088 | If set to | |
| 445243bf | 2089 | .Dq Li YES , |
| 984263bc MD |
2090 | the |
| 2091 | .Xr moused 8 | |
| 2092 | daemon is started for doing cut/paste selection on the console. | |
| 2093 | .It Va moused_type | |
| 2094 | .Pq Vt str | |
| 2095 | This is the protocol type of the mouse connected to this host. | |
| 2096 | This variable must be set if | |
| 2097 | .Va moused_enable | |
| 2098 | is set to | |
| 445243bf | 2099 | .Dq Li YES . |
| 984263bc MD |
2100 | The |
| 2101 | .Xr moused 8 | |
| 2102 | daemon | |
| 2103 | is able to detect the appropriate mouse type automatically in many cases. | |
| 2104 | Set this variable to | |
| 445243bf | 2105 | .Dq Li auto |
| 984263bc MD |
2106 | to let the daemon detect it, or |
| 2107 | select one from the following list if the automatic detection fails. | |
| 2108 | .Pp | |
| 2109 | If the mouse is attached to the PS/2 mouse port, choose | |
| 445243bf | 2110 | .Dq Li auto |
| 984263bc | 2111 | or |
| 445243bf RG |
2112 | .Dq Li ps/2 , |
| 2113 | regardless of the brand and model of the mouse. | |
| 225e0ed5 | 2114 | Likewise, if the mouse is attached to the bus mouse port, choose |
| 445243bf | 2115 | .Dq Li auto |
| 984263bc | 2116 | or |
| 445243bf | 2117 | .Dq Li busmouse . |
| 984263bc MD |
2118 | All other protocols are for serial mice and will not work with |
| 2119 | the PS/2 and bus mice. | |
| 2120 | If this is a USB mouse, | |
| 445243bf | 2121 | .Dq Li auto |
| 984263bc | 2122 | is the only protocol type which will work. |
| 445243bf RG |
2123 | .Pp |
| 2124 | .Bl -tag -width ".Li x10mouseremote" -compact | |
| 2125 | .It Li microsoft | |
| 2126 | Microsoft mouse (serial) | |
| 2127 | .It Li intellimouse | |
| 2128 | Microsoft IntelliMouse (serial) | |
| 2129 | .It Li mousesystems | |
| 2130 | Mouse systems Corp. mouse (serial) | |
| 2131 | .It Li mmseries | |
| 2132 | MM Series mouse (serial) | |
| 2133 | .It Li logitech | |
| 2134 | Logitech mouse (serial) | |
| 2135 | .It Li busmouse | |
| 2136 | A bus mouse | |
| 2137 | .It Li mouseman | |
| 2138 | Logitech MouseMan and TrackMan (serial) | |
| 2139 | .It Li glidepoint | |
| 2140 | ALPS GlidePoint (serial) | |
| 2141 | .It Li thinkingmouse | |
| 2142 | Kensington ThinkingMouse (serial) | |
| 2143 | .It Li ps/2 | |
| 2144 | PS/2 mouse | |
| 2145 | .It Li mmhittab | |
| 2146 | MM HitTablet (serial) | |
| 2147 | .It Li x10mouseremote | |
| 2148 | X10 MouseRemote (serial) | |
| 2149 | .It Li versapad | |
| 2150 | Interlink VersaPad (serial) | |
| 2151 | .El | |
| 984263bc MD |
2152 | .Pp |
| 2153 | Even if the mouse is not in the above list, it may be compatible | |
| 2154 | with one in the list. | |
| 2155 | Refer to the man page for | |
| 2156 | .Xr moused 8 | |
| 2157 | for compatibility information. | |
| 2158 | .Pp | |
| 2159 | It should also be noted that while this is enabled, any | |
| 2160 | other client of the mouse (such as an X server) should access | |
| 445243bf RG |
2161 | the mouse through the virtual mouse device, |
| 2162 | .Pa /dev/sysmouse , | |
| 2163 | and configure it as a | |
| 2164 | .Dq Li sysmouse | |
| 2165 | type mouse, since all | |
| 225e0ed5 | 2166 | mouse data is converted to this single canonical format when using |
| 984263bc | 2167 | .Xr moused 8 . |
| 445243bf RG |
2168 | If the client program does not support the |
| 2169 | .Dq Li sysmouse | |
| 225e0ed5 | 2170 | type, specify the |
| 445243bf RG |
2171 | .Dq Li mousesystems |
| 2172 | type. | |
| 984263bc MD |
2173 | It is the second preferred type. |
| 2174 | .It Va moused_port | |
| 2175 | .Pq Vt str | |
| 2176 | If | |
| 2177 | .Va moused_enable | |
| 2178 | is set to | |
| 445243bf | 2179 | .Dq Li YES , |
| 984263bc MD |
2180 | this is the actual port the mouse is on. |
| 2181 | It might be | |
| 2182 | .Pa /dev/cuaa0 | |
| 2183 | for a COM1 serial mouse, | |
| 2184 | .Pa /dev/psm0 | |
| 2185 | for a PS/2 mouse or | |
| 2186 | .Pa /dev/mse0 | |
| 2187 | for a bus mouse, for example. | |
| 2188 | .It Va moused_flags | |
| 2189 | .Pq Vt str | |
| 2190 | If | |
| 2191 | .Va moused_type | |
| 2192 | is set, these are the additional flags to pass to the | |
| 2193 | .Xr moused 8 | |
| 2194 | daemon. | |
| 445243bf RG |
2195 | .It Va mousechar_start |
| 2196 | .Pq Vt int | |
| 2197 | If set to | |
| 2198 | .Dq Li NO , | |
| 2199 | the default mouse cursor character range | |
| 2200 | .Li 0xd0 Ns - Ns Li 0xd3 | |
| 225e0ed5 | 2201 | is used, otherwise the range start is set to |
| 445243bf RG |
2202 | .Ar value |
| 2203 | character, see | |
| 2204 | .Xr vidcontrol 1 . | |
| 2205 | Use if the default range is occupied in the language code table. | |
| 850afac2 SW |
2206 | .It Va vidhistory |
| 2207 | .Pq Vt int | |
| 2208 | Set the size of the history (scrollback) buffer in lines. | |
| 984263bc MD |
2209 | .It Va allscreens_flags |
| 2210 | .Pq Vt str | |
| 2211 | If set, | |
| 2212 | .Xr vidcontrol 1 | |
| 2213 | is run with these options for each of the virtual terminals | |
| 2214 | .Pq Pa /dev/ttyv* . | |
| 2215 | For example, | |
| 445243bf | 2216 | .Dq Fl m Cm on |
| 225e0ed5 | 2217 | will enable the mouse pointer on all virtual terminals if |
| 984263bc MD |
2218 | .Va moused_enable |
| 2219 | is set to | |
| 445243bf RG |
2220 | .Dq Li YES . |
| 2221 | .It Va allscreens_kbdflags | |
| 2222 | .Pq Vt str | |
| 2223 | If set, | |
| 2224 | .Xr kbdcontrol 1 | |
| 2225 | is run with these options for each of the virtual terminals | |
| 2226 | .Pq Pa /dev/ttyv* . | |
| 2227 | For example, | |
| 2228 | .Dq Fl h Li 200 | |
| 2229 | will set the | |
| 2230 | .Xr syscons 4 | |
| 2231 | scrollback (history) buffer to 200 lines. | |
| 984263bc MD |
2232 | .It Va cron_enable |
| 2233 | .Pq Vt bool | |
| 2234 | If set to | |
| 445243bf RG |
2235 | .Dq Li YES , |
| 2236 | run the | |
| 984263bc MD |
2237 | .Xr cron 8 |
| 2238 | daemon at system boot time. | |
| 2239 | .It Va cron_program | |
| 2240 | .Pq Vt str | |
| 2241 | Path to | |
| 2242 | .Xr cron 8 | |
| 2243 | (default | |
| 2244 | .Pa /usr/sbin/cron ) . | |
| 2245 | .It Va cron_flags | |
| 2246 | .Pq Vt str | |
| 2247 | If | |
| 2248 | .Va cron_enable | |
| 2249 | is set to | |
| 445243bf | 2250 | .Dq Li YES , |
| 984263bc MD |
2251 | these are the flags to pass to |
| 2252 | .Xr cron 8 . | |
| 2253 | .It Va lpd_program | |
| 2254 | .Pq Vt str | |
| 2255 | Path to | |
| 2256 | .Xr lpd 8 | |
| 2257 | (default | |
| 2258 | .Pa /usr/sbin/lpd ) . | |
| 2259 | .It Va lpd_enable | |
| 2260 | .Pq Vt bool | |
| 2261 | If set to | |
| 445243bf RG |
2262 | .Dq Li YES , |
| 2263 | run the | |
| 984263bc MD |
2264 | .Xr lpd 8 |
| 2265 | daemon at system boot time. | |
| 2266 | .It Va lpd_flags | |
| 2267 | .Pq Vt str | |
| 2268 | If | |
| 2269 | .Va lpd_enable | |
| 2270 | is set to | |
| 445243bf | 2271 | .Dq Li YES , |
| 984263bc MD |
2272 | these are the flags to pass to the |
| 2273 | .Xr lpd 8 | |
| 2274 | daemon. | |
| 52163b73 SW |
2275 | .It Va nscd_enable |
| 2276 | .Pq Vt bool | |
| 2277 | If set to | |
| 2278 | .Dq Li YES , | |
| 2279 | run the | |
| 2280 | .Xr nscd 8 | |
| 2281 | daemon at system boot time. | |
| 850afac2 SW |
2282 | .It Va mixer_enable |
| 2283 | .Pq Vt bool | |
| 2284 | If set to | |
| 2285 | .Dq Li YES , | |
| 2286 | preserve | |
| 2287 | .Xr mixer 8 | |
| 2288 | settings across reboots. | |
| 984263bc MD |
2289 | .It Va mta_start_script |
| 2290 | .Pq Vt str | |
| 717e8ef7 | 2291 | The full path to the script to run to start |
| 984263bc MD |
2292 | a mail transfer agent. |
| 2293 | The default is | |
| 2294 | .Pa /etc/rc.sendmail . | |
| 2295 | The | |
| 2296 | .Va sendmail_* | |
| 2297 | variables which | |
| 2298 | .Pa /etc/rc.sendmail | |
| 2299 | uses are documented in the | |
| 2300 | .Xr rc.sendmail 8 | |
| 2301 | man page. | |
| a12bb799 SW |
2302 | .It Va fixbootfile |
| 2303 | .Pq Vt bool | |
| 2304 | In a | |
| 2305 | .Sq HAMMER ROOT with UFS /boot | |
| 2306 | setup, the boot loader will not set up the | |
| 2307 | .Va kern.bootfile | |
| 2308 | sysctl correctly. | |
| 2309 | The system will attempt to fix this on its own. | |
| 2310 | Set this variable to | |
| 2311 | .Dq Li NO | |
| 2312 | to turn this behavior off. | |
| 984263bc MD |
2313 | .It Va dumpdev |
| 2314 | .Pq Vt str | |
| 2315 | Indicates the device (usually a swap partition) to which a crash dump | |
| 2316 | should be written in the event of a system crash. | |
| 2317 | The value of this variable is passed as the argument to | |
| 2318 | .Xr dumpon 8 . | |
| 2319 | To disable crash dumps, set this variable to | |
| 445243bf | 2320 | .Dq Li NO . |
| 984263bc MD |
2321 | .It Va dumpdir |
| 2322 | .Pq Vt str | |
| 2323 | When the system reboots after a crash and a crash dump is found on the | |
| 2324 | device specified by the | |
| 2325 | .Va dumpdev | |
| 2326 | variable, | |
| 2327 | .Xr savecore 8 | |
| 2328 | will save that crash dump and a copy of the kernel to the directory | |
| 2329 | specified by the | |
| 2330 | .Va dumpdir | |
| 2331 | variable. | |
| 2332 | The default value is | |
| 445243bf | 2333 | .Pa /var/crash . |
| 984263bc | 2334 | Set to |
| 445243bf | 2335 | .Dq Li NO |
| 984263bc MD |
2336 | to not run |
| 2337 | .Xr savecore 8 | |
| 2338 | at boot time when | |
| 2339 | .Va dumpdir | |
| 2340 | is set. | |
| 2341 | .It Va savecore_flags | |
| 2342 | .Pq Vt str | |
| 2343 | If crash dumps are enabled, these are the flags to pass to the | |
| 2344 | .Xr savecore 8 | |
| 2345 | utility. | |
| 2346 | .It Va enable_quotas | |
| 2347 | .Pq Vt bool | |
| 2348 | Set to | |
| 445243bf | 2349 | .Dq Li YES |
| 984263bc MD |
2350 | to turn on user disk quotas on system startup via the |
| 2351 | .Xr quotaon 8 | |
| 2352 | command. | |
| 2353 | .It Va check_quotas | |
| 2354 | .Pq Vt bool | |
| 2355 | Set to | |
| 445243bf | 2356 | .Dq Li YES |
| 984263bc MD |
2357 | to enable user disk quota checking via the |
| 2358 | .Xr quotacheck 8 | |
| 2359 | command. | |
| 2360 | .It Va accounting_enable | |
| 2361 | .Pq Vt bool | |
| 2362 | Set to | |
| 445243bf | 2363 | .Dq Li YES |
| 984263bc MD |
2364 | to enable system accounting through the |
| 2365 | .Xr accton 8 | |
| 2366 | facility. | |
| 984263bc MD |
2367 | .It Va linux_enable |
| 2368 | .Pq Vt bool | |
| 2369 | Set to | |
| 445243bf | 2370 | .Dq Li YES |
| 225e0ed5 | 2371 | to enable Linux/ELF binary emulation at system initial boot time. |
| 445243bf RG |
2372 | .It Va sysvipc_enable |
| 2373 | .Pq Vt bool | |
| 2374 | If set to | |
| 2375 | .Dq Li YES , | |
| 2376 | load System V IPC primitives at boot time. | |
| de5b97b6 MD |
2377 | .\" ----- cleanvar_enable setting-------------------------------- |
| 2378 | .It Va cleanvar_enable | |
| 2379 | .Pq Vt bool | |
| 2380 | Set to | |
| 2381 | .Dq Li YES | |
| 2382 | to have | |
| 2383 | .Pa /var/run , | |
| 2384 | .Pa /var/spool/lock | |
| 2385 | and | |
| 2386 | .Pa /var/spool/uucp/.Temp/* | |
| 2387 | cleaned at startup. | |
| 2388 | .\" ----- clear_tmp_enable setting------------------------------- | |
| 984263bc MD |
2389 | .It Va clear_tmp_enable |
| 2390 | .Pq Vt bool | |
| 2391 | Set to | |
| 445243bf | 2392 | .Dq Li YES |
| 984263bc MD |
2393 | to have |
| 2394 | .Pa /tmp | |
| 2395 | cleaned at startup. | |
| de5b97b6 | 2396 | .\" ----- ldconfig_paths setting -------------------------------- |
| 984263bc MD |
2397 | .It Va ldconfig_paths |
| 2398 | .Pq Vt str | |
| 2399 | Set to the list of shared library paths to use with | |
| 2400 | .Xr ldconfig 8 . | |
| 2401 | NOTE: | |
| 2402 | .Pa /usr/lib | |
| 2403 | will always be added first, so it need not appear in this list. | |
| 2404 | .It Va ldconfig_insecure | |
| 2405 | .Pq Vt bool | |
| 2406 | The | |
| 2407 | .Xr ldconfig 8 | |
| 2408 | utility normally refuses to use directories | |
| 2409 | which are writable by anyone except root. | |
| 2410 | Set this variable to | |
| 445243bf | 2411 | .Dq Li YES |
| 984263bc | 2412 | to disable that security check during system startup. |
| 984263bc MD |
2413 | .It Va kern_securelevel |
| 2414 | .Pq Vt int | |
| 2415 | The kernel security level to set at startup. | |
| 2416 | The allowed range of | |
| 2417 | .Ar value | |
| 225e0ed5 | 2418 | ranges from \-1 (the compile time default) to 3 (the most secure). |
| 445243bf | 2419 | See |
| 984263bc | 2420 | .Xr init 8 |
| 225e0ed5 | 2421 | for the list of possible security levels and their effect on system operation. |
| 984263bc MD |
2422 | .It Va start_vinum |
| 2423 | .Pq Vt bool | |
| 2424 | Set to | |
| 445243bf | 2425 | .Dq Li YES |
| 984263bc MD |
2426 | to start |
| 2427 | .Xr vinum 8 | |
| 2428 | at system boot time. | |
| 984263bc MD |
2429 | .It Va sshd_enable |
| 2430 | .Pq Vt bool | |
| 2431 | Set to | |
| 445243bf | 2432 | .Dq Li YES |
| 984263bc MD |
2433 | to start |
| 2434 | .Xr sshd 8 | |
| 2435 | at system boot time. | |
| 850afac2 SW |
2436 | .It Va sshd_program |
| 2437 | .Pq Vt str | |
| 2438 | Path to the SSH server program | |
| 717e8ef7 TN |
2439 | (default |
| 2440 | .Pa /usr/sbin/sshd ) . | |
| 984263bc MD |
2441 | .It Va sshd_flags |
| 2442 | .Pq Vt str | |
| 2443 | If | |
| 2444 | .Va sshd_enable | |
| 2445 | is set to | |
| 445243bf | 2446 | .Dq Li YES , |
| 984263bc MD |
2447 | these are the flags to pass to the |
| 2448 | .Xr sshd 8 | |
| 2449 | daemon. | |
| 850afac2 SW |
2450 | .It Va ftpd_enable |
| 2451 | .Pq Vt bool | |
| 2452 | Set to | |
| 2453 | .Dq Li YES | |
| 2454 | to start | |
| 2455 | .Xr ftpd 8 | |
| 2456 | at system boot time. | |
| 2457 | .It Va ftpd_flags | |
| 2458 | .Pq Vt str | |
| 2459 | If | |
| 2460 | .Va ftpd_enable | |
| 2461 | is set to | |
| 2462 | .Dq Li YES , | |
| 2463 | these are the flags to pass to the | |
| 2464 | .Xr ftpd 8 | |
| 2465 | daemon. | |
| 445243bf RG |
2466 | .It Va usbd_enable |
| 2467 | .Pq Vt bool | |
| 2468 | If set to | |
| 2469 | .Dq Li YES , | |
| 2470 | run the | |
| 2471 | .Xr usbd 8 | |
| 2472 | daemon at boot time. | |
| 2473 | .It Va usbd_flags | |
| 2474 | .Pq Vt str | |
| 2475 | If | |
| 2476 | .Va usbd_enable | |
| 2477 | is set to | |
| 2478 | .Dq Li YES , | |
| 2479 | these are the flags passed to | |
| 2480 | .Xr usbd 8 | |
| 2481 | daemon. | |
| 2482 | .It Va watchdogd_enable | |
| 2483 | .Pq Vt bool | |
| 2484 | If set to | |
| 2485 | .Dq Li YES , | |
| 2486 | start the | |
| 2487 | .Xr watchdogd 8 | |
| 2488 | daemon at boot time. | |
| 2489 | This requires that the kernel have been compiled with | |
| 2490 | .Cd "options WATCHDOG" . | |
| 2491 | .It Va jail_enable | |
| 2492 | .Pq Vt bool | |
| 2493 | If set to | |
| 2494 | .Dq Li NO , | |
| 2495 | any configured jails will not be started. | |
| 2496 | .It Va jail_list | |
| 2497 | .Pq Vt str | |
| 2498 | A space separated list of names for jails. | |
| 2499 | This is purely a configuration aid to help identify and | |
| 2500 | configure multiple jails. | |
| 2501 | The names specified in this list will be used to | |
| 2502 | identify settings common to an instance of a jail. | |
| 2503 | Assuming that the jail in question was named | |
| 2504 | .Li vjail , | |
| 56be8454 | 2505 | you would have the following dependent variables: |
| 445243bf RG |
2506 | .Bd -literal |
| 2507 | jail_vjail_hostname="jail.example.com" | |
| 2508 | jail_vjail_ip="192.168.1.100" | |
| 2509 | jail_vjail_rootdir="/var/jails/vjail/root" | |
| 445243bf RG |
2510 | .Ed |
| 2511 | .Pp | |
| b58abc5e SW |
2512 | .It Va jail_flags |
| 2513 | .Pq Vt str | |
| 2514 | Unset by default. | |
| 2515 | When set, use as default value for | |
| 2516 | .Va jail_ Ns Ao Ar jname Ac Ns Va _flags | |
| 2517 | for every jail in | |
| 2518 | .Va jail_list . | |
| 2519 | .It Va jail_interface | |
| 2520 | .Pq Vt str | |
| 2521 | Unset by default. | |
| 2522 | When set, use as default value for | |
| 2523 | .Va jail_ Ns Ao Ar jname Ac Ns Va _interface | |
| 2524 | for every jail in | |
| 2525 | .Va jail_list . | |
| 2526 | .It Va jail_fstab | |
| 2527 | .Pq Vt str | |
| 2528 | Unset by default. | |
| 2529 | When set, use as default value for | |
| 2530 | .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab | |
| 2531 | for every jail in | |
| 2532 | .Va jail_list . | |
| 2533 | .It Va jail_mount_enable | |
| 2534 | .Pq Vt bool | |
| 2535 | Set to | |
| 2536 | .Dq Li NO | |
| 2537 | by default. | |
| 2538 | When set to | |
| 2539 | .Dq Li YES , | |
| 2540 | sets | |
| 2541 | .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable | |
| 2542 | to | |
| 2543 | .Dq Li YES | |
| 2544 | by default for every jail in | |
| 2545 | .Va jail_list . | |
| 2546 | .It Va jail_fdesc_enable | |
| 2547 | .Pq Vt bool | |
| 2548 | Set to | |
| 2549 | .Dq Li NO | |
| 2550 | by default. | |
| 2551 | When set to | |
| 2552 | .Dq Li YES , | |
| 2553 | sets | |
| 2554 | .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable | |
| 2555 | to | |
| 2556 | .Dq Li YES | |
| 2557 | by default for every jail in | |
| 2558 | .Va jail_list . | |
| 2559 | .It Va jail_procfs_enable | |
| 2560 | .Pq Vt bool | |
| 2561 | Set to | |
| 2562 | .Dq Li NO | |
| 2563 | by default. | |
| 2564 | When set to | |
| 2565 | .Dq Li YES , | |
| 2566 | sets | |
| 2567 | .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable | |
| 2568 | to | |
| 2569 | .Dq Li YES | |
| 2570 | by default for every jail in | |
| 2571 | .Va jail_list . | |
| 2572 | .It Va jail_exec_start | |
| 2573 | .Pq Vt str | |
| 2574 | Unset by default. | |
| 2575 | When set, use as default value for | |
| 2576 | .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start | |
| 2577 | for every jail in | |
| 2578 | .Va jail_list . | |
| 2579 | .It Va jail_exec_stop | |
| 2580 | Unset by default. | |
| 2581 | When set, use as default value for | |
| 2582 | .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop | |
| 2583 | for every jail in | |
| 2584 | .Va jail_list . | |
| 2585 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir | |
| 2586 | .Pq Vt str | |
| 2587 | Unset by default. | |
| 2588 | Set to the root directory used by jail | |
| 2589 | .Va jname . | |
| 2590 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname | |
| 2591 | .Pq Vt str | |
| 2592 | Unset by default. | |
| 2593 | Set to the fully qualified domain name (FQDN) assigned to jail | |
| 2594 | .Va jname . | |
| 2595 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip | |
| 2596 | .Pq Vt str | |
| 2597 | Unset by default. | |
| 2598 | Set to the IP address assigned to jail | |
| 2599 | .Va jname . | |
| 2600 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags | |
| 2601 | .Pq Vt str | |
| 2602 | Set to | |
| 2603 | .Dq Li -l -U root | |
| 2604 | by default. | |
| 2605 | These are flags to pass to | |
| 20ab1ccc | 2606 | .Xr jail 8 . |
| b58abc5e SW |
2607 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface |
| 2608 | .Pq Vt str | |
| 2609 | Unset by default. | |
| 2610 | When set, sets the interface to use when setting IP address alias. | |
| 2611 | Note that the alias is created at jail startup and removed at jail shutdown. | |
| 2612 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab | |
| 2613 | .Pq Vt str | |
| 2614 | Set to | |
| 2615 | .Pa /etc/fstab. Ns Aq Ar jname | |
| 2616 | by default. | |
| 2617 | This is the file system information file to use for jail | |
| 2618 | .Va jname . | |
| 2619 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable | |
| 2620 | .Pq Vt bool | |
| 2621 | Set to | |
| 2622 | .Dq Li NO | |
| 2623 | by default. | |
| 2624 | When set to | |
| 2625 | .Dq Li YES , | |
| 2626 | mount all file systems from | |
| 2627 | .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab | |
| 2628 | at jail startup. | |
| 2629 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable | |
| 2630 | .Pq Vt bool | |
| 2631 | Set to | |
| 2632 | .Dq Li NO | |
| 2633 | by default. | |
| 2634 | When set to | |
| 2635 | .Dq Li YES , | |
| 2636 | mount the file-descriptor file system inside jail | |
| 2637 | .Ar jname | |
| 2638 | at jail startup. | |
| 2639 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable | |
| 2640 | .Pq Vt bool | |
| 2641 | Set to | |
| 2642 | .Dq Li NO | |
| 2643 | by default. | |
| 2644 | When set to | |
| 2645 | .Dq Li YES , | |
| 2646 | mount the process file system inside jail | |
| 2647 | .Ar jname | |
| 2648 | at jail startup. | |
| 2649 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start | |
| 2650 | .Pq Vt str | |
| 2651 | Set to | |
| 2652 | .Dq Li /bin/sh /etc/rc | |
| 2653 | by default. | |
| 2654 | This is the command executed at jail startup. | |
| 2655 | .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop | |
| 2656 | .Pq Vt str | |
| 2657 | Set to | |
| 2658 | .Dq Li /bin/sh /etc/rc.shutdown | |
| 2659 | by default. | |
| 2660 | This is the command executed at jail shutdown. | |
| 445243bf RG |
2661 | .It Va jail_set_hostname_allow |
| 2662 | .Pq Vt bool | |
| 2663 | If set to | |
| 2664 | .Dq Li NO , | |
| 2665 | do not allow the root user in a jail to set its hostname. | |
| 2666 | .It Va jail_socket_unixiproute_only | |
| 2667 | .Pq Vt bool | |
| 2668 | If set to | |
| b58abc5e SW |
2669 | .Dq Li YES , |
| 2670 | do not allow any sockets, | |
| 2671 | besides UNIX/IP/route sockets, | |
| 2672 | to be used within a jail. | |
| 445243bf RG |
2673 | .It Va jail_sysvipc_allow |
| 2674 | .Pq Vt bool | |
| 2675 | If set to | |
| 2676 | .Dq Li YES , | |
| 2677 | allow applications within a jail to use System V IPC. | |
| 842eea5b SW |
2678 | .It Va newsyslog_enable |
| 2679 | .Pq Vt bool | |
| 2680 | If set to | |
| 2681 | .Dq Li YES , | |
| 2682 | run | |
| 2683 | .Xr newsyslog 8 | |
| 2684 | before syslogd starts. | |
| 2685 | .It Va newsyslog_flags | |
| 2686 | .Pq Vt str | |
| 2687 | If | |
| 2688 | .Va newsyslog_enable | |
| 2689 | is set to | |
| 2690 | .Dq Li YES , | |
| 2691 | these are the flags passed to | |
| 2692 | .Xr newsyslog 8 . | |
| 850afac2 SW |
2693 | .It Va resident_enable |
| 2694 | .Pq Vt bool | |
| 2695 | If set to | |
| 2696 | .Dq Li YES , | |
| 2697 | make the dynamic binaries listed in | |
| 2698 | .Pa /etc/resident.conf | |
| 2699 | resident. | |
| 2700 | .It Va varsym_enable | |
| 2701 | .Pq Vt bool | |
| 2702 | If set to | |
| 2703 | .Dq Li YES , | |
| 2704 | process | |
| 2705 | .Pa /etc/varsym.conf | |
| 2706 | to set system-wide variables for variant symlinks. | |
| 705d55f1 | 2707 | .It Va rand_irqs |
| 850afac2 SW |
2708 | .Pq Vt str |
| 2709 | Set either to | |
| 2710 | .Dq Li NO | |
| 2711 | or a whitespace separated list of IRQ numbers which will be used as a source of | |
| 2712 | randomness. | |
| 984263bc MD |
2713 | .\" ----- isdn settings --------------------------------- |
| 2714 | .It Va isdn_enable | |
| 2715 | .Pq Vt bool | |
| 2716 | Set to | |
| 445243bf | 2717 | .Dq Li NO |
| 984263bc MD |
2718 | by default. |
| 2719 | When set to | |
| 445243bf RG |
2720 | .Dq Li YES , |
| 2721 | starts the | |
| 2722 | .Xr isdnd 8 | |
| 225e0ed5 | 2723 | daemon at system boot time. |
| 984263bc MD |
2724 | .It Va isdn_flags |
| 2725 | .Pq Vt str | |
| 2726 | Set to | |
| 445243bf | 2727 | .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9 |
| 984263bc MD |
2728 | by default. |
| 2729 | Additional flags to pass to | |
| 2730 | .Xr isdnd 8 | |
| 2731 | (but see | |
| 2732 | .Va isdn_fsdev | |
| 2733 | and | |
| 2734 | .Va isdn_ttype | |
| 2735 | for certain tunable parameters). | |
| 2736 | .It Va isdn_ttype | |
| 2737 | .Pq Vt str | |
| 2738 | Set to | |
| 445243bf | 2739 | .Dq Li cons25 |
| 984263bc MD |
2740 | by default. |
| 2741 | The terminal type of the output device when | |
| 2742 | .Xr isdnd 8 | |
| 445243bf | 2743 | operates in full-screen mode. |
| 984263bc MD |
2744 | .It Va isdn_screenflags |
| 2745 | .Pq Vt str | |
| 2746 | Set to | |
| 445243bf | 2747 | .Dq Li NO |
| 984263bc | 2748 | by default. |
| 445243bf | 2749 | The video mode for full-screen mode (only for |
| 984263bc MD |
2750 | .Xr syscons 4 |
| 2751 | console driver, see | |
| 2752 | .Xr vidcontrol 1 | |
| 2753 | for valid modes). | |
| 2754 | .It Va isdn_fsdev | |
| 2755 | .Pq Vt str | |
| 2756 | Set to | |
| 445243bf | 2757 | .Dq Li NO |
| 984263bc MD |
2758 | by default. |
| 2759 | The output device for | |
| 2760 | .Xr isdnd 8 | |
| 445243bf RG |
2761 | in full-screen mode (or |
| 2762 | .Dq Li NO | |
| 984263bc MD |
2763 | for daemon mode). |
| 2764 | .It Va isdn_trace | |
| 2765 | .Pq Vt bool | |
| 2766 | Set to | |
| 445243bf | 2767 | .Dq Li NO |
| 984263bc MD |
2768 | by default. |
| 2769 | When set to | |
| 445243bf | 2770 | .Dq Li YES , |
| 984263bc | 2771 | enables the ISDN protocol trace utility |
| 445243bf | 2772 | .Xr isdntrace 8 |
| 984263bc MD |
2773 | at system boot time. |
| 2774 | .It Va isdn_traceflags | |
| 2775 | .Pq Vt str | |
| 2776 | Set to | |
| 445243bf | 2777 | .Dq Fl f Pa /var/tmp/isdntrace0 |
| 984263bc MD |
2778 | by default. |
| 2779 | Flags for | |
| 445243bf | 2780 | .Xr isdntrace 8 . |
| 984263bc | 2781 | .\" ----------------------------------------------------- |
| 445243bf RG |
2782 | .It Va entropy_dir |
| 2783 | .Pq Vt str | |
| 2784 | Set to | |
| 2785 | .Dq Li NO | |
| 2786 | to disable caching entropy via | |
| 2787 | .Xr cron 8 . | |
| 2788 | Otherwise set to the directory used to store entropy files in. | |
| 2789 | .It Va entropy_file | |
| 2790 | .Pq Vt str | |
| 2791 | Set to | |
| 2792 | .Dq Li NO | |
| 2793 | to disable caching entropy through reboots. | |
| 225e0ed5 | 2794 | Otherwise set to the filename used to store cached entropy through reboots. |
| 445243bf RG |
2795 | This file should be located on the root file system to seed the |
| 2796 | .Xr random 4 | |
| 2797 | device as early as possible in the boot process. | |
| 445243bf RG |
2798 | .It Va ipsec_enable |
| 2799 | .Pq Vt bool | |
| 2800 | Set to | |
| 2801 | .Dq Li YES | |
| 2802 | to run | |
| 2803 | .Xr setkey 8 | |
| 2804 | on | |
| 2805 | .Va ipsec_file | |
| 2806 | at boot time. | |
| 2807 | .It Va ipsec_file | |
| 2808 | .Pq Vt str | |
| 2809 | Configuration file for | |
| 2810 | .Xr setkey 8 . | |
| 2811 | .It Va dmesg_enable | |
| 2812 | .Pq Vt bool | |
| 2813 | Set to | |
| 2814 | .Dq Li YES | |
| 2815 | to save | |
| 2816 | .Xr dmesg 8 | |
| 2817 | to | |
| 2818 | .Pa /var/run/dmesg.boot | |
| 2819 | on boot. | |
| 2820 | .It Va rcshutdown_timeout | |
| 2821 | .Pq Vt int | |
| 2822 | If set, start a watchdog timer in the background which will terminate | |
| 2823 | .Pa rc.shutdown | |
| 2824 | if | |
| 2825 | .Xr shutdown 8 | |
| 2826 | has not completed within the specified time (in seconds). | |
| 2feb07f7 SW |
2827 | .It Va vkernel_enable |
| 2828 | .Pq Vt bool | |
| 2829 | If set to | |
| 2830 | .Dq Li NO , | |
| 2831 | any configured vkernels will not be started. | |
| 2832 | .It Va vkernel_list | |
| 2833 | .Pq Vt str | |
| 2834 | A space separated list of names for vkernels. | |
| 2835 | This is purely a configuration aid to help identify and | |
| 2836 | configure multiple vkernels. | |
| 2837 | The names specified in this list will be used to | |
| 2838 | identify settings common to a vkernel instance. | |
| 2839 | Assuming that the vkernel in question was named | |
| 2840 | .Li example , | |
| 2841 | you would have the following dependent variables | |
| 2842 | (filled with reference values in this text): | |
| 2843 | .Bd -literal | |
| 2844 | vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug" | |
| 2845 | vkernel_example_memsize="64m" | |
| 2846 | vkernel_example_rootimg_list="/var/vkernel/rootimg.01" | |
| 2847 | vkernel_example_iface_list="auto:bridge0" | |
| 2848 | vkernel_example_logfile="/dev/null" | |
| 2849 | vkernel_example_flags="-U" | |
| 2850 | .Ed | |
| 2851 | .Pp | |
| 2852 | The last three are optional. | |
| 2853 | They default to an empty string if not set, except for logfile which defaults to | |
| 2854 | .Pa /dev/null | |
| 2855 | if it is not set. | |
| 984263bc MD |
2856 | .El |
| 2857 | .Sh FILES | |
| 717e8ef7 | 2858 | .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact |
| 984263bc MD |
2859 | .It Pa /etc/defaults/rc.conf |
| 2860 | .It Pa /etc/rc.conf | |
| 2861 | .It Pa /etc/rc.conf.local | |
| 717e8ef7 | 2862 | .It Pa /etc/start_if. Ns Aq Ar interface |
| 984263bc MD |
2863 | .El |
| 2864 | .Sh SEE ALSO | |
| 2865 | .Xr catman 1 , | |
| 2866 | .Xr gdb 1 , | |
| 2867 | .Xr info 1 , | |
| 445243bf | 2868 | .Xr kbdcontrol 1 , |
| 850afac2 | 2869 | .Xr varsym 1 , |
| 984263bc | 2870 | .Xr vidcontrol 1 , |
| 445243bf | 2871 | .Xr ip 4 , |
| 27e9fed5 SW |
2872 | .Xr ipf 4 , |
| 2873 | .Xr ipfw 4 , | |
| 445243bf | 2874 | .Xr kld 4 , |
| 27e9fed5 | 2875 | .Xr pf 4 , |
| 984263bc MD |
2876 | .Xr tcp 4 , |
| 2877 | .Xr udp 4 , | |
| 2878 | .Xr exports 5 , | |
| 2879 | .Xr motd 5 , | |
| 850afac2 SW |
2880 | .Xr resident.conf 5 , |
| 2881 | .Xr varsym.conf 5 , | |
| 984263bc MD |
2882 | .Xr accton 8 , |
| 2883 | .Xr amd 8 , | |
| 2884 | .Xr apm 8 , | |
| 2885 | .Xr atm 8 , | |
| 5f834906 | 2886 | .Xr btconfig 8 , |
| ec4e37b7 | 2887 | .Xr bthcid 8 , |
| 984263bc | 2888 | .Xr cron 8 , |
| 4b8c406a | 2889 | .Xr devd 8 , |
| 984263bc | 2890 | .Xr dhclient 8 , |
| c54db4b1 | 2891 | .Xr dntpd 8 , |
| 850afac2 | 2892 | .Xr ftpd 8 , |
| 984263bc MD |
2893 | .Xr ifconfig 8 , |
| 2894 | .Xr inetd 8 , | |
| 2895 | .Xr isdnd 8 , | |
| 2896 | .Xr isdntrace 8 , | |
| b58abc5e | 2897 | .Xr jail 8 , |
| 984263bc | 2898 | .Xr lpd 8 , |
| 375d1659 | 2899 | .Xr makewhatis 8 , |
| 850afac2 | 2900 | .Xr mixer 8 , |
| 984263bc MD |
2901 | .Xr mountd 8 , |
| 2902 | .Xr moused 8 , | |
| 2903 | .Xr mrouted 8 , | |
| 2904 | .Xr named 8 , | |
| 2905 | .Xr nfsd 8 , | |
| 984263bc | 2906 | .Xr pcnfsd 8 , |
| 27e9fed5 SW |
2907 | .Xr pfctl 8 , |
| 2908 | .Xr pflogd 8 , | |
| 984263bc MD |
2909 | .Xr quotacheck 8 , |
| 2910 | .Xr quotaon 8 , | |
| 2911 | .Xr rc 8 , | |
| 2912 | .Xr rc.sendmail 8 , | |
| 850afac2 SW |
2913 | .Xr resident 8 , |
| 2914 | .Xr rndcontrol 8 , | |
| 984263bc MD |
2915 | .Xr route 8 , |
| 2916 | .Xr routed 8 , | |
| 3b813696 | 2917 | .Xr rpcbind 8 , |
| 984263bc MD |
2918 | .Xr rpc.lockd 8 , |
| 2919 | .Xr rpc.statd 8 , | |
| 717e8ef7 | 2920 | .Xr rtadvd 8 , |
| bdbd8a5b | 2921 | .Xr rtsold 8 , |
| 984263bc MD |
2922 | .Xr rwhod 8 , |
| 2923 | .Xr savecore 8 , | |
| 5f834906 | 2924 | .Xr sdpd 8 , |
| eb3a3472 | 2925 | .Xr sensorsd 8 , |
| 984263bc MD |
2926 | .Xr sshd 8 , |
| 2927 | .Xr swapon 8 , | |
| 2928 | .Xr sysctl 8 , | |
| 2929 | .Xr syslogd 8 , | |
| 2930 | .Xr timed 8 , | |
| 445243bf | 2931 | .Xr usbd 8 , |
| 984263bc | 2932 | .Xr vinum 8 , |
| 984263bc MD |
2933 | .Xr yp 8 , |
| 2934 | .Xr ypbind 8 , | |
| 2935 | .Xr ypserv 8 , | |
| 2936 | .Xr ypset 8 | |
| 2937 | .Sh HISTORY | |
| 2938 | The | |
| 2939 | .Nm | |
| 2940 | file appeared in | |
| 2941 | .Fx 2.2.2 . | |
| 2942 | .Sh AUTHORS | |
| 2943 | .An Jordan K. Hubbard . |