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