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