Annotation of src/share/man/man5/rc.conf.5, Revision 1.160
1.160 ! roy 1: .\" $NetBSD: rc.conf.5,v 1.159 2015/03/30 11:01:53 wiz Exp $
1.1 mrg 2: .\"
3: .\" Copyright (c) 1996 Matthew R. Green
1.117 mrg 4: .\" All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\" 1. Redistributions of source code must retain the above copyright
10: .\" notice, this list of conditions and the following disclaimer.
11: .\" 2. Redistributions in binary form must reproduce the above copyright
12: .\" notice, this list of conditions and the following disclaimer in the
13: .\" documentation and/or other materials provided with the distribution.
14: .\"
15: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20: .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21: .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22: .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23: .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25: .\" SUCH DAMAGE.
26: .\"
1.5 cjs 27: .\" Copyright (c) 1997 Curt J. Sampson
1.8 mikel 28: .\" Copyright (c) 1997 Michael W. Long
1.139 jruoho 29: .\" Copyright (c) 1998-2010 The NetBSD Foundation, Inc.
1.1 mrg 30: .\" All rights reserved.
31: .\"
1.27 lukem 32: .\" This document is derived from works contributed to The NetBSD Foundation
33: .\" by Luke Mewburn.
34: .\"
1.1 mrg 35: .\" Redistribution and use in source and binary forms, with or without
36: .\" modification, are permitted provided that the following conditions
37: .\" are met:
38: .\" 1. Redistributions of source code must retain the above copyright
39: .\" notice, this list of conditions and the following disclaimer.
40: .\" 2. Redistributions in binary form must reproduce the above copyright
41: .\" notice, this list of conditions and the following disclaimer in the
42: .\" documentation and/or other materials provided with the distribution.
1.12 mrg 43: .\" 3. The name of the author may not be used to endorse or promote products
1.1 mrg 44: .\" derived from this software without specific prior written permission.
45: .\"
46: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
47: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
48: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
49: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
50: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
51: .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
52: .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
53: .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
54: .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56: .\" SUCH DAMAGE.
57: .\"
1.160 ! roy 58: .Dd July 9, 2015
1.1 mrg 59: .Dt RC.CONF 5
1.21 garbled 60: .Os
1.1 mrg 61: .Sh NAME
62: .Nm rc.conf
63: .Nd system startup configuration file
64: .Sh DESCRIPTION
65: The
66: .Nm
67: file specifies which services are enabled during system startup by
1.35 lukem 68: the startup scripts invoked by
1.67 wiz 69: .Pa /etc/rc
1.58 lukem 70: (see
71: .Xr rc 8 ) ,
72: and the shutdown scripts invoked by
73: .Pa /etc/rc.shutdown .
1.1 mrg 74: The
75: .Nm
76: file is a shell script that is sourced by
1.58 lukem 77: .Xr rc 8 ,
78: meaning that
1.1 mrg 79: .Nm
1.8 mikel 80: must contain valid shell commands.
1.1 mrg 81: .Pp
1.65 abs 82: Listed below are the standard
1.8 mikel 83: .Nm
1.11 mikel 84: variables that may be set, the values to which each may be set,
1.8 mikel 85: a brief description of what each variable does, and a reference to
1.71 grant 86: relevant manual pages.
87: Third party packages may test for additional variables.
1.10 cjs 88: .Pp
1.58 lukem 89: By default,
90: .Nm
91: reads
92: .Pa /etc/defaults/rc.conf
93: (if it is readable)
94: to obtain default values for various variables, and the end-user
95: may override these by appending appropriate entries to the end of
1.76 wiz 96: .Nm .
1.58 lukem 97: .Pp
98: .Xr rc.d 8
99: scripts that use
100: .Ic load_rc_config
101: from
102: .Xr rc.subr 8
103: also support sourcing an optional end-user provided per-script override
104: file
105: .Pa /etc/rc.conf.d/ Ns Ar service ,
106: (where
107: .Ar service
108: is the contents of the
109: .Sy name
110: variable in the
111: .Xr rc.d 8
112: script).
113: This may contain variable overrides, including allowing the end-user
114: to override various
115: .Ic run_rc_command
116: .Xr rc.d 8
117: control variables, and thus changing the operation of the script
118: without requiring editing of the script.
1.132 apb 119: .Ss Variable naming conventions and data types
120: Most variables are one of two types: enabling variables or flags
121: variables.
122: Enabling variables, such as
123: .Sy inetd ,
124: are generally named after the program or the system they enable,
125: and have boolean values (specified using
126: .Sq Ic YES ,
127: .Sq Ic TRUE ,
128: .Sq Ic ON
129: or
130: .Sq Ic 1
131: for true, and
132: .Sq Ic NO ,
133: .Sq Ic FALSE ,
134: .Sq Ic OFF
135: or
136: .Sq Ic 0
137: for false, with the values being case insensitive).
138: Flags variables, such as
139: .Sy inetd_flags
140: have the same name with "_flags" appended, and determine what
141: arguments are passed to the program if it is enabled.
142: .Pp
143: If a variable that
144: .Xr rc 8
145: expects to be set is not set, or the value is not one of the allowed
146: values, a warning will be printed.
1.49 wiz 147: .Ss Overall control
1.35 lukem 148: .Bl -tag -width net_interfaces
1.88 jmmv 149: .It Sy do_rcshutdown
1.132 apb 150: Boolean value.
151: If false,
1.88 jmmv 152: .Xr shutdown 8
153: will not run
154: .Pa /etc/rc.shutdown .
155: .It Sy rcshutdown_rcorder_flags
156: A string.
157: Extra arguments to the
158: .Xr rcorder 8
159: run by
160: .Pa /etc/rc.shutdown .
161: .It Sy rcshutdown_timeout
162: A number.
163: If non-blank, use this as the number of seconds to run a watchdog timer for
164: which will terminate
165: .Pa /etc/rc.shutdown
166: if the timer expires before the shutdown script completes.
1.35 lukem 167: .It Sy rc_configured
1.132 apb 168: Boolean value.
169: If false then the system will drop into single-user mode during boot.
1.50 lukem 170: .It Sy rc_fast_and_loose
1.54 lukem 171: If set to a non-empty string,
1.50 lukem 172: each script in
173: .Pa /etc/rc.d
174: will be executed in the current shell rather than a sub shell.
175: This may be faster on slow machines that have an expensive
176: .Xr fork 2
177: operation.
178: .Bl -hang
1.51 wiz 179: .It Em Note :
1.50 lukem 180: Use this at your own risk!
181: A rogue command or script may inadvertently prevent boot to multiuser.
182: .El
1.61 lukem 183: .It Sy rc_rcorder_flags
184: A string.
185: Extra arguments to the
186: .Xr rcorder 8
187: run by
188: .Pa /etc/rc .
1.129 joerg 189: .It Sy rc_directories
190: A string.
191: Space separated list of directories searched for rc scripts.
192: The default is
193: .Pa /etc/rc.d .
194: All directories in
195: .Ev rc_directories
196: must be located in the root filesystem, otherwise they will be silently
197: skipped.
1.133 apb 198: .It Sy rc_silent
199: Boolean value.
1.134 wiz 200: If true then the usual output is suppressed, and
1.133 apb 201: .Xr rc 8
202: invokes the command specified in the
203: .Va rc_silent_cmd
204: variable once for each line of suppressed output.
205: The default value of
206: .Va rc_silent
207: is set from the
208: .Dv AB_SILENT
209: flag in the kernel's
210: .Va boothowto
211: variable (see
212: .Xr boot 8 ,
213: .Xr reboot 2 ) .
214: .It Sy rc_silent_cmd
215: A command to be executed once per line of suppressed output, when
216: .Va rc_silent
217: is true.
218: The default value of
219: .Va rc_silent_cmd
220: is
221: .Dq twiddle ,
222: which will display a spinning symbol instead of each line of output.
223: Another useful value is
224: .Dq \&: ,
225: which will display nothing at all.
1.35 lukem 226: .El
1.49 wiz 227: .Ss Basic network configuration
1.11 mikel 228: .Bl -tag -width net_interfaces
1.50 lukem 229: .It Sy defaultroute
230: A string.
1.99 ghen 231: Default IPv4 network route.
1.50 lukem 232: If empty or not set, then the contents of
233: .Pa /etc/mygate
234: (if it exists) are used.
1.99 ghen 235: .It Sy defaultroute6
236: A string.
237: Default IPv6 network route.
238: If empty or not set, then the contents of
239: .Pa /etc/mygate6
240: (if it exists) are used.
1.9 lukem 241: .It Sy domainname
1.50 lukem 242: A string.
1.18 lukem 243: .Tn NIS
244: (YP) domain of host.
1.9 lukem 245: If empty or not set, then the contents of
246: .Pa /etc/defaultdomain
247: (if it exists) are used.
1.74 martin 248: .It Sy force_down_interfaces
249: A space separated list of interface names.
1.75 wiz 250: These interfaces will be configured down when going from multiuser to singleuser
1.74 martin 251: mode or on system shutdown.
252: .Pp
253: This is important for some stateful interfaces, for example PPP over ISDN
254: connections that cost money by connection time or PPPoE interfaces which
1.75 wiz 255: have no direct means of noticing
1.74 martin 256: .Dq disconnect
257: events.
258: .Pp
259: All active
260: .Xr pppoe 4
261: and
262: .Xr ippp 4
263: interfaces will be automatically added to this list.
1.88 jmmv 264: .It Sy hostname
265: A string.
266: Name of host.
267: If empty or not set, then the contents of
268: .Pa /etc/myname
269: (if it exists) are used.
1.15 mrg 270: .El
1.49 wiz 271: .Ss Boottime file-system and swap configuration
1.35 lukem 272: .Bl -tag -width net_interfaces
1.57 lukem 273: .It Sy critical_filesystems_local
1.50 lukem 274: A string.
1.35 lukem 275: File systems mounted very early in the system boot before networking
276: services are available.
277: Usually
278: .Pa /var
279: is part of this, because it is needed by services such as
1.44 wiz 280: .Xr dhclient 8
1.35 lukem 281: which may be required to get the network operational.
1.135 apb 282: The default is
283: .Dq "OPTIONAL:/var" ,
284: where the
1.153 jdf 285: .Dq "OPTIONAL:"
1.135 apb 286: prefix means that it's not an error if the file system is not
287: present in
1.136 wiz 288: .Xr fstab 5 .
1.57 lukem 289: .It Sy critical_filesystems_remote
1.50 lukem 290: A string.
1.35 lukem 291: File systems such as
1.15 mrg 292: .Pa /usr
1.35 lukem 293: that may require network services to be available to mount,
294: that must be available early in the system boot for general services to use.
1.135 apb 295: The default is
296: .Dq "OPTIONAL:/usr" ,
297: where the
1.153 jdf 298: .Dq "OPTIONAL:"
1.142 jruoho 299: prefix means that it is not an error if the file system is not
1.135 apb 300: present in
1.136 wiz 301: .Xr fstab 5 .
1.82 martti 302: .It Sy fsck_flags
303: A string.
304: A file system is checked with
305: .Xr fsck 8
306: during boot before mounting it.
307: This option may be used to override the default command-line options
308: passed to the
309: .Xr fsck 8
310: program.
311: .Pp
312: When set to
313: .Fl y ,
314: .Xr fsck 8
315: assumes yes as the answer to all operator questions during file system checks.
316: This might be important with hosts where the administrator does not have
317: access to the console and an unsuccessful shutdown must not make the host
318: unbootable even if the file system checks would fail in preen mode.
1.15 mrg 319: .It Sy no_swap
1.132 apb 320: Boolean value.
321: Should be true if you have deliberately configured your system with no swap.
322: If false and no swap devices are configured, the system will warn you.
1.158 chopps 323: .It Sy resize_root
324: Boolean value.
1.159 wiz 325: Set to true to have the system resize the root file system to fill its
1.158 chopps 326: partition.
327: Will only attempt to resize the root file system if it is of type ffs and does
328: not have logging enabled.
329: Defaults to false.
1.56 lukem 330: .It Sy swapoff
1.132 apb 331: Boolean value.
1.56 lukem 332: Remove block-type swap devices at shutdown time.
333: Useful if swapping onto RAIDframe devices.
1.9 lukem 334: .El
1.153 jdf 335: .Ss Block device subsystems
1.11 mikel 336: .Bl -tag -width net_interfaces
1.139 jruoho 337: .It Sy ccd
338: Boolean value.
339: Configures concatenated disk devices according to
340: .Xr ccd.conf 5 .
341: .It Sy cgd
342: Boolean value.
343: Configures cryptographic disk devices.
344: Requires
345: .Pa /etc/cgd/cgd.conf .
346: See
347: .Xr cgdconfig 8
348: for additional details.
1.153 jdf 349: .It Sy lvm
350: Boolean value.
351: Configures the logical volume manager.
352: See
353: .Xr lvm 8
354: for additional details.
355: .It Sy raidframe
356: Boolean value.
357: Configures
358: .Xr raid 4 ,
359: RAIDframe disk devices.
360: See
361: .Xr raidctl 8
362: for additional details.
363: .El
364: .Ss One-time actions to perform or programs to run on boot-up
365: .Bl -tag -width net_interfaces
366: .It Sy accounting
367: Boolean value.
368: Enables process accounting with
369: .Xr accton 8 .
370: Requires
371: .Pa /var/account/acct
372: to exist.
1.34 enami 373: .It Sy clear_tmp
1.132 apb 374: Boolean value.
1.139 jruoho 375: Clear
376: .Pa /tmp
377: after reboot.
1.27 lukem 378: .It Sy dmesg
1.132 apb 379: Boolean value.
1.27 lukem 380: Create
381: .Pa /var/run/dmesg.boot
382: from the output of
383: .Xr dmesg 8 .
384: Passes
385: .Sy dmesg_flags .
1.139 jruoho 386: .It Sy envsys
387: Boolean value.
388: Sets preferences for the environmental systems framework,
389: .Xr envsys 4 .
390: Requires
391: .Pa /etc/envsys.conf ,
392: which is described in
393: .Xr envsys.conf 5 .
1.130 mbalmer 394: .It Sy gpio
1.132 apb 395: Boolean value.
1.130 mbalmer 396: Configure
397: .Xr gpio 4
1.139 jruoho 398: devices.
1.130 mbalmer 399: See
400: .Xr gpio.conf 5 .
1.139 jruoho 401: .It Sy ldconfig
402: Boolean value.
403: Configures
404: .Xr a.out 5
405: runtime link editor directory cache.
1.88 jmmv 406: .It Sy mixerctl
1.132 apb 407: Boolean value.
1.88 jmmv 408: Read
409: .Xr mixerctl.conf 5
410: for how to set mixer values.
411: List in
412: .Sy mixerctl_mixers
413: the devices whose settings are to be saved at shutdown and
414: restored at start-up.
1.48 ad 415: .It Sy newsyslog
1.132 apb 416: Boolean value.
1.48 ad 417: Run
418: .Nm newsyslog
1.71 grant 419: to trim logfiles before syslogd starts.
420: Intended for laptop users.
1.50 lukem 421: Passes
422: .Sy newsyslog_flags .
1.112 elad 423: .It Sy per_user_tmp
1.132 apb 424: Boolean value.
1.112 elad 425: Enables a per-user
426: .Pa /tmp
427: directory.
428: .Sy per_user_tmp_dir
429: can be used to override the default location of the
430: .Dq real
431: temporary directories,
432: .Dq Pa /private/tmp .
1.142 jruoho 433: See
1.146 jruoho 434: .Xr security 7
1.142 jruoho 435: for additional details.
1.139 jruoho 436: .It Sy quota
437: Boolean value.
438: Checks and enables quotas by running
1.143 wiz 439: .Xr quotacheck 8
1.139 jruoho 440: and
441: .Xr quotaon 8 .
1.157 apb 442: .It Sy random_seed
443: Boolean value.
444: During boot-up, runs the
445: .Xr rndctl 8
446: utility with the
447: .Fl L
448: flag to seed the random number subsystem from an entropy file.
449: During shutdown, runs the
450: .Xr rndctl 8
451: utility with the
452: .Fl S
453: flag to save some random information to the entropy file.
454: The entropy file name is specified by the
455: .Sy random_file
456: variable, and defaults to
457: .Pa /var/db/entropy-file .
458: The entropy file must be on a local file system that is writable early during
459: boot-up (just after the file systems specified in
460: .Sy critical_filesystems_local
461: have been mounted), and correspondingly late during shutdown.
1.127 apb 462: .It Sy rndctl
1.132 apb 463: Boolean value.
1.127 apb 464: Runs the
465: .Xr rndctl 8
466: utility one or more times according to the specification in
467: .Sy rndctl_flags .
468: .Pp
469: If
470: .Sy rndctl_flags
471: does not contain a semicolon
472: .Pq Ql \&;
473: then it is expected to contain zero or more flags,
474: followed by one or more device or type names.
475: The
476: .Xr rndctl 8
477: command will be executed once for each device or type name.
478: If the specified flags do not include any of
479: .Fl c , C , e ,
480: or
481: .Fl E ,
482: then the flags
483: .Fl c
484: and
485: .Fl e
486: are added, to specify that entropy from the relevant device or type
487: should be both collected and estimated.
488: If the specified flags do not include either of
489: .Fl d
490: or
491: .Fl t ,
492: then the flag
493: .Fl d
494: is added, to specify that the non-flag arguments are device names,
495: not type names.
496: .Pp
497: .Sy rndctl_flags
498: may contain multiple semicolon-separated segments, in which each
499: segment contains flags and device or type names as described above.
500: This allows different flags to be associated with different
501: device or type names.
502: For example, given
503: .Li rndctl_flags="wd0 wd1; -t tty; -c -t net" ,
504: the following commands will be executed:
505: .Li "rndctl -c -e -d wd0" ;
506: .Li "rndctl -c -e -d wd1" ;
507: .Li "rndctl -c -e -t tty" ;
508: .Li "rndctl -c -t net" .
1.139 jruoho 509: .It Sy rtclocaltime
510: Boolean value.
511: Sets the real time clock to local time by adjusting the
512: .Xr sysctl 7
513: value of
514: .Pa kern.rtc_offset .
515: The offset from UTC is calculated automatically according
516: to the time zone information in the file
517: .Pa /etc/localtime .
1.88 jmmv 518: .It Sy savecore
1.132 apb 519: Boolean value.
1.88 jmmv 520: Runs the
521: .Xr savecore 8
522: utility.
523: Passes
524: .Sy savecore_flags .
1.89 atatat 525: The directory where crash dumps are stored is specified by
526: .Sy savecore_dir .
527: The default setting is
1.91 wiz 528: .Dq Pa /var/crash .
1.139 jruoho 529: .It Sy sysdb
530: Boolean value.
531: Builds various system databases, including
1.152 joerg 532: .Pa /var/run/dev.cdb ,
1.139 jruoho 533: .Pa /etc/spwd.db ,
534: .Pa /var/db/netgroup.db ,
1.152 joerg 535: .Pa /var/db/services.cdb ,
1.139 jruoho 536: and entries for
537: .Xr utmp 5 .
1.66 takemura 538: .It Sy tpctl
1.132 apb 539: Boolean value.
1.66 takemura 540: Run
541: .Xr tpctl 8
542: to calibrate touch panel device.
543: Passes
544: .Sy tpctl_flags .
1.88 jmmv 545: .It Sy update_motd
1.132 apb 546: Boolean value.
1.88 jmmv 547: Updates the
548: .Nx
549: version string in the
550: .Pa /etc/motd
551: file to reflect the version of the running kernel.
552: See
553: .Xr motd 5 .
1.85 uebayasi 554: .It Sy virecover
1.132 apb 555: Boolean value.
1.86 uebayasi 556: Send notification mail to users if any recoverable files exist in
1.85 uebayasi 557: .Pa /var/tmp/vi.recover .
1.108 reed 558: Read
559: .Xr virecover 8
560: for more information.
1.139 jruoho 561: .It Sy wdogctl
562: Boolean value.
563: Configures watchdog timers.
564: Passes
565: .Sy wdogctl_flags .
566: Refer to
567: .Xr wdogctl 8
568: for information on how to configure a timer.
1.19 mrg 569: .El
1.153 jdf 570: .Ss System security settings
1.35 lukem 571: .Bl -tag -width net_interfaces
1.19 mrg 572: .It Sy securelevel
1.34 enami 573: A number.
574: The system securelevel is set to the specified value early
1.19 mrg 575: in the boot process, before any external logins, or other programs
1.34 enami 576: that run users job, are started.
1.46 mjl 577: If set to nothing, the default action is taken, as described in
1.121 reed 578: .Xr init 8
579: and
580: .Xr secmodel_securelevel 9 ,
1.46 mjl 581: which contains definitive information about the system securelevel.
1.55 mrg 582: Note that setting
583: .Sy securelevel
584: to 0 in
585: .Nm
586: will actually result in the system booting with securelevel set to 1, as
587: .Xr init 8
588: will raise the level when
1.58 lukem 589: .Xr rc 8
590: completes.
1.93 elad 591: .It Sy permit_nonalpha
1.153 jdf 592: Boolean value.
1.93 elad 593: Allow passwords to include non-alpha characters, usually to allow
1.94 wiz 594: NIS/YP netgroups.
1.153 jdf 595: .It Sy veriexec
596: Boolean value.
597: Load Veriexec fingerprints during startup.
598: Read
599: .Xr veriexecctl 8
600: for more information.
1.95 elad 601: .It Sy veriexec_strict
602: A number.
603: Controls the strict level of Veriexec.
604: Level 0 is learning mode, used when building the signatures file.
605: It will only output messages but will not enforce anything.
606: Level 1 will only prevent access to files with a fingerprint
1.98 wiz 607: mismatch.
608: Level 2 will also deny writing to and removing of
1.95 elad 609: monitored files, as well as enforce access type (as specified in
1.98 wiz 610: the signatures file).
611: Level 3 will take a step further and prevent
1.95 elad 612: access to files that are not monitored.
613: .It Sy veriexec_verbose
614: A number.
615: Controls the verbosity of Veriexec.
616: Recommended operation is at level 0, verbose output (mostly used when
617: building the signatures file) is at level 1.
618: Level 2 is for debugging only and should not be used.
1.114 elad 619: .It Sy veriexec_flags
620: A string.
621: Flags to pass to the
622: .Nm veriexecctl
623: command.
1.8 mikel 624: .El
1.49 wiz 625: .Ss Networking startup
1.11 mikel 626: .Bl -tag -width net_interfaces
1.88 jmmv 627: .It Sy altqd
1.132 apb 628: Boolean value.
1.88 jmmv 629: ALTQ configuration/monitoring daemon.
630: Passes
631: .Sy altqd_flags .
632: .It Sy auto_ifconfig
1.132 apb 633: Boolean value.
1.88 jmmv 634: Sets the
635: .Sy net_interfaces
636: variable (see below) to the output of
637: .Xr ifconfig 8
638: with the
639: .Dq Li -l
640: flag and suppresses warnings about interfaces in this list that
641: do not have an ifconfig file or variable.
642: .It Sy dhclient
1.132 apb 643: Boolean value.
644: Set true to configure some or all network interfaces using
1.116 joerg 645: the ISC DHCP client.
1.88 jmmv 646: If you set
647: .Sy dhclient
1.132 apb 648: true, then
1.88 jmmv 649: .Pa /var
1.132 apb 650: must be in
1.88 jmmv 651: .Sy critical_filesystems_local ,
1.132 apb 652: or
653: .Pa /var
654: must be on the root file system,
655: or you must modify the
1.88 jmmv 656: .Sy dhclient_flags
1.132 apb 657: variable to direct the DHCP client to store the leases file
658: in some other directory on the root file system.
1.88 jmmv 659: You must not provide ifconfig information or ifaliases
660: information for any interface that is to be configured using the DHCP client.
661: Interface aliases can be set up in the DHCP client configuration
662: file if needed - see
663: .Xr dhclient.conf 5
664: for details.
665: .Pp
666: Passes
667: .Sy dhclient_flags
668: to the DHCP client.
669: See
670: .Xr dhclient 8
671: for complete documentation.
672: If you wish to configure all broadcast
673: network interfaces using the DHCP client, you can leave this blank.
674: To configure only specific interfaces, name the interfaces to be configured
675: on the command line.
676: .Pp
677: If you must run the DHCP client before mounting critical file systems,
678: then you should specify an alternate location for the DHCP client's lease
679: file in the
680: .Sy dhclient_flags
681: variable - for example, "-lf /tmp/dhclient.leases".
1.154 roy 682: .It Sy dhcpcd
683: Boolean value.
684: Set true to configure some or all network interfaces using dhcpcd.
685: If you set
686: .Sy dhcpcd
687: true, then
688: .Pa /var
689: must be in
690: .Sy critical_filesystems_local ,
691: or
692: .Pa /var
693: must be on the root file system.
694: If you need to restrict dhcpcd to one or a number of interfaces,
695: or need a separate configuration per interface,
696: then this should be done in the configuration file - see
697: .Xr dhcpcd.conf 5
698: for details.
1.160 ! roy 699: dhcpcd presently ignores the
! 700: .Sy wpa_supplicant
! 701: varaible in rc.conf and will start wpa_supplicant if a suitable
! 702: wpa_supplicant.conf is found unless otherwise instructed in
! 703: .Xr dhcpcd.conf 5 .
1.116 joerg 704: .It Sy dhcpcd_flags
1.154 roy 705: Passes
706: .Sy dhcpcd_flags
707: to dhcpcd.
708: See
1.118 wiz 709: .Xr dhcpcd 8
1.154 roy 710: for complete documentation.
1.88 jmmv 711: .It Sy flushroutes
1.132 apb 712: Boolean value.
1.88 jmmv 713: Flushes the route table on networking startup.
714: Useful when coming up to multiuser mode after going down to
715: single-user mode.
1.139 jruoho 716: .It Sy ftp_proxy
717: Boolean value.
718: Runs
719: .Xr ftp-proxy 8 ,
720: the proxy daemon for the Internet File Transfer Protocol.
1.100 rpaulo 721: .It Sy hostapd
1.132 apb 722: Boolean value.
1.100 rpaulo 723: Runs
1.101 wiz 724: .Xr hostapd 8 ,
1.100 rpaulo 725: the authenticator for IEEE 802.11 networks.
1.88 jmmv 726: .It Sy ifaliases_*
727: A string.
728: List of
729: .Sq Em "address netmask"
730: pairs to configure additional network addresses for the given
731: configured interface
732: .Dq *
733: (e.g.
734: .Sy ifaliases_le0 ) .
735: If
736: .Em netmask
737: is
738: .Dq - ,
739: then use the default netmask for the interface.
740: .Pp
741: .Sy ifaliases_*
1.151 dholland 742: covers limited cases only and is considered unrecommended.
1.88 jmmv 743: We recommend using
1.120 apb 744: .Sy ifconfig_nnX
745: variables or
1.88 jmmv 746: .Pa /etc/ifconfig.xxN
1.120 apb 747: files with multiple lines instead.
1.88 jmmv 748: .It Sy ifwatchd
1.132 apb 749: Boolean value.
1.88 jmmv 750: Monitor dynamic interfaces and perform actions upon address changes.
751: Passes
752: .Sy ifwatchd_flags .
753: .It Sy ip6mode
754: A string.
755: An IPv6 node can be a router
756: .Pq nodes that forward packet for others
757: or a host
758: .Pq nodes that do not forward .
759: A host can be autoconfigured
760: based on the information advertised by adjacent IPv6 routers.
761: By setting
762: .Sy ip6mode
763: to
764: .Dq Li router ,
765: .Dq Li host ,
766: or
767: .Dq Li autohost ,
768: you can configure your node as a router,
769: a non-autoconfigured host, or an autoconfigured host.
770: Invalid values will be ignored, and the node will be configured as
771: a non-autoconfigured host.
772: You may want to check
773: .Sy rtsol
774: and
775: .Sy rtsold
776: as well, if you set the variable to
777: .Dq Li autohost .
1.96 rpaulo 778: .It Sy ip6uniquelocal
1.132 apb 779: Boolean value.
1.96 rpaulo 780: If
781: .Sy ip6mode
782: is equal to
1.132 apb 783: .Dq Li router ,
1.96 rpaulo 784: and
785: .Sy ip6uniquelocal
1.132 apb 786: is false,
1.96 rpaulo 787: a reject route will be installed on boot to avoid misconfiguration relating
788: to unique-local addresses.
1.132 apb 789: If
790: .Sy ip6uniquelocal
791: is true, the reject route won't be installed.
1.7 cjs 792: .It Sy ipfilter
1.132 apb 793: Boolean value.
1.17 fair 794: Runs
1.7 cjs 795: .Xr ipf 8
1.11 mikel 796: to load in packet filter specifications from
1.7 cjs 797: .Pa /etc/ipf.conf
1.17 fair 798: at network boot time, before any interfaces are configured.
1.128 hannken 799: Passes
800: .Sy ipfilter_flags .
1.17 fair 801: See
1.35 lukem 802: .Xr ipf.conf 5 .
1.52 martti 803: .It Sy ipfs
1.132 apb 804: Boolean value.
1.52 martti 805: Runs
806: .Xr ipfs 8
807: to save and restore information for ipnat and ipfilter state tables.
808: The information is stored in
809: .Pa /var/db/ipf/ipstate.ipf
810: and
811: .Pa /var/db/ipf/ipnat.ipf .
812: Passes
813: .Sy ipfs_flags .
1.35 lukem 814: .It Sy ipmon
1.132 apb 815: Boolean value.
1.35 lukem 816: Runs
817: .Xr ipmon 8
818: to read
819: .Xr ipf 8
820: packet log information and log it to a file or the system log.
821: Passes
822: .Sy ipmon_flags .
1.70 grant 823: .It Sy ipmon_flags
1.73 wiz 824: A string.
825: Specifies arguments to supply to
1.72 grant 826: .Xr ipmon 8 .
827: Defaults to
828: .Dq Li -ns .
829: A typical example would be
1.70 grant 830: .Dq Fl nD Pa /var/log/ipflog
831: to have
832: .Xr ipmon 8
833: log directly to a file bypassing
834: .Xr syslogd 8 .
1.72 grant 835: If the
836: .Dq -D
837: argument is used, remember to modify
1.70 grant 838: .Pa /etc/newsyslog.conf
1.72 grant 839: accordingly; for example:
1.70 grant 840: .Bd -literal
841: /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
842: .Ed
1.88 jmmv 843: .It Sy ipnat
1.132 apb 844: Boolean value.
1.50 lukem 845: Runs
1.88 jmmv 846: .Xr ipnat 8
847: to load in the IP network address translation (NAT) rules from
848: .Pa /etc/ipnat.conf
849: at network boot time, before any interfaces are configured.
850: See
851: .Xr ipnat.conf 5 .
852: .It Sy ipsec
1.132 apb 853: Boolean value.
1.88 jmmv 854: Runs
855: .Xr setkey 8
856: to load in IPsec manual keys and policies from
857: .Pa /etc/ipsec.conf
858: at network boot time, before any interfaces are configured.
1.10 cjs 859: .It Sy net_interfaces
1.50 lukem 860: A string.
1.10 cjs 861: The list of network interfaces to be configured at boot time.
1.42 itojun 862: For each interface "xxN", the system first looks for ifconfig
1.120 apb 863: parameters in the variable
864: .Sy ifconfig_xxN ,
865: and then in the file
866: .Pa /etc/ifconfig.xxN .
1.17 fair 867: If
1.10 cjs 868: .Sy auto_ifconfig
1.132 apb 869: is false, and neither the variable nor the file is found,
1.10 cjs 870: a warning is printed.
1.120 apb 871: Information in either the variable or the file is parsed identically,
872: except that, if an
873: .Sy ifconfig_xxN
874: variable contains a single line with embedded semicolons,
875: then the value is split into multiple lines prior to further parsing,
876: treating the semicolon as a line separator.
1.150 jruoho 877: .Pp
1.154 roy 878: One common case it to set the
1.120 apb 879: .Sy ifconfig_xxN
880: variable to a set of arguments to be passed to an
881: .Xr ifconfig 8
882: command after the interface name.
1.42 itojun 883: Refer to
884: .Xr ifconfig.if 5
885: for more details on
1.120 apb 886: .Pa /etc/ifconfig.xxN
887: files, and note that the information there also applies to
888: .Sy ifconfig_xxN
889: variables (after the variables are split into lines).
1.10 cjs 890: .It Sy ntpdate
1.132 apb 891: Boolean value.
1.17 fair 892: Runs
1.10 cjs 893: .Xr ntpdate 8
894: to set the system time from one of the hosts in
895: .Sy ntpdate_hosts .
896: If
897: .Sy ntpdate_hosts
898: is empty, it will attempt to find a list of hosts in
899: .Pa /etc/ntp.conf .
1.50 lukem 900: Passes
901: .Sy ntpdate_flags .
1.119 yamt 902: .It Sy pf
1.132 apb 903: Boolean value.
1.119 yamt 904: Enable
905: .Xr pf 4
906: at network boot time:
907: Load the initial configuration
908: .Xr pf.boot.conf 5
909: before the network is up.
910: After the network has been configured, then load the final ruleset
911: .Xr pf.conf 5 .
912: .It Sy pf_rules
913: A string.
914: The path of the
915: .Xr pf.conf 5
916: ruleset that will be used when loading the final ruleset.
917: .It Sy pflogd
1.132 apb 918: Boolean value.
1.119 yamt 919: Run
920: .Xr pflogd 8
921: for dumping packet filter logging information to a file.
1.155 prlw1 922: .It Sy ppp
1.156 wiz 923: A boolean.
924: Toggles starting
1.155 prlw1 925: .Xr pppd 8
1.156 wiz 926: on startup.
927: See
1.155 prlw1 928: .Sy ppp_peers
929: below.
1.14 mrg 930: .It Sy ppp_peers
1.50 lukem 931: A string.
1.14 mrg 932: If
1.155 prlw1 933: .Sy ppp
934: is true and
1.14 mrg 935: .Sy ppp_peers
936: is not empty, then
1.50 lukem 937: .Pa /etc/rc.d/ppp
1.14 mrg 938: will check each word in
939: .Sy ppp_peers
1.50 lukem 940: for a corresponding ppp configuration file in
1.14 mrg 941: .Pa /etc/ppp/peers
942: and will call
943: .Xr pppd 8
944: with the
945: .Dq call Sy peer
946: option.
1.88 jmmv 947: .It Sy racoon
1.132 apb 948: Boolean value.
1.88 jmmv 949: Runs
950: .Xr racoon 8 ,
951: the IKE (ISAKMP/Oakley) key management daemon.
1.24 itojun 952: .It Sy rtsol
1.132 apb 953: Boolean value.
1.24 itojun 954: Run
955: .Xr rtsol 8 ,
1.60 lukem 956: router solicitation command for IPv6 hosts.
957: On nomadic hosts like notebook computers, you may want to enable
1.25 itojun 958: .Sy rtsold
959: as well.
1.24 itojun 960: Passes
961: .Sy rtsol_flags .
1.60 lukem 962: This is only for autoconfigured IPv6 hosts, so set
1.29 itojun 963: .Sy ip6mode
1.60 lukem 964: to
965: .Dq Li autohost
1.111 wiz 966: if you use it.
1.110 rpaulo 967: .It Sy wpa_supplicant
1.132 apb 968: Boolean value.
1.110 rpaulo 969: Run
970: .Xr wpa_supplicant 8 ,
971: WPA/802.11i Supplicant for wireless network devices.
1.137 apb 972: If you set
1.144 snj 973: .Sy wpa_supplicant
1.137 apb 974: true, then
975: .Pa /usr
976: must be in
977: .Sy critical_filesystems_local ,
978: or
979: .Pa /usr
980: must be on the root file system.
1.160 ! roy 981: dhcpcd ignores this variable, see the
! 982: .Sy dhcpcd
! 983: variable for details.
1.6 perry 984: .El
1.49 wiz 985: .Ss Daemons required by other daemons
1.11 mikel 986: .Bl -tag -width net_interfaces
1.10 cjs 987: .It Sy inetd
1.132 apb 988: Boolean value.
1.17 fair 989: Runs the
1.10 cjs 990: .Xr inetd 8
1.11 mikel 991: daemon to start network server processes (as listed in
1.5 cjs 992: .Pa /etc/inetd.conf )
1.17 fair 993: as necessary.
994: Passes
1.10 cjs 995: .Sy inetd_flags .
996: The
1.40 lukem 997: .Dq Li -l
1.10 cjs 998: flag turns on libwrap connection logging.
1.34 enami 999: .It Sy rpcbind
1.132 apb 1000: Boolean value.
1.17 fair 1001: The
1.34 enami 1002: .Xr rpcbind 8
1.8 mikel 1003: daemon is required for any
1004: .Xr rpc 3
1.17 fair 1005: services.
1.18 lukem 1006: These include NFS,
1007: .Tn NIS ,
1.138 reed 1008: .Xr rpc.bootparamd 8 ,
1009: .Xr rpc.rstatd 8 ,
1010: .Xr rpc.rusersd 8 ,
1.5 cjs 1011: and
1.138 reed 1012: .Xr rpc.rwalld 8 .
1.50 lukem 1013: Passes
1014: .Sy rpcbind_flags .
1.5 cjs 1015: .El
1.49 wiz 1016: .Ss Commonly used daemons
1.11 mikel 1017: .Bl -tag -width net_interfaces
1.88 jmmv 1018: .It Sy cron
1.132 apb 1019: Boolean value.
1.88 jmmv 1020: Run
1021: .Xr cron 8 .
1.139 jruoho 1022: .It Sy ftpd
1.153 jdf 1023: Boolean value.
1.139 jruoho 1024: Runs the
1025: .Xr ftpd 8
1026: daemon and passes
1027: .Sy ftpd_flags .
1.123 mishka 1028: .It Sy httpd
1.132 apb 1029: Boolean value.
1.124 wiz 1030: Runs the
1.123 mishka 1031: .Xr httpd 8
1032: daemon and passes
1033: .Sy httpd_flags .
1034: .It Sy httpd_wwwdir
1035: A string.
1.126 wiz 1036: The
1.123 mishka 1037: .Xr httpd 8
1038: WWW root directory.
1.126 wiz 1039: Used only if
1.123 mishka 1040: .Sy httpd
1.132 apb 1041: is true.
1.123 mishka 1042: The default setting is
1043: .Dq Pa /var/www .
1044: .It Sy httpd_wwwuser
1045: A string.
1046: If non-blank and
1047: .Sy httpd
1.132 apb 1048: is true, run
1.123 mishka 1049: .Xr httpd 8
1.124 wiz 1050: and cause it to switch to the specified user after initialization.
1.123 mishka 1051: It is preferred to
1052: .Sy httpd_user
1053: because
1054: .Xr httpd 8
1.124 wiz 1055: is requiring extra privileges to start listening on default port 80.
1.123 mishka 1056: The default setting is
1057: .Dq Dv _httpd .
1.88 jmmv 1058: .It Sy lpd
1.132 apb 1059: Boolean value.
1.88 jmmv 1060: Runs
1061: .Xr lpd 8
1062: and passes
1063: .Sy lpd_flags .
1064: The
1065: .Dq Li -l
1066: flag will turn on extra logging.
1.144 snj 1067: .It Sy mdnsd
1068: Boolean value.
1069: Runs
1070: .Xr mdnsd 8 .
1.10 cjs 1071: .It Sy named
1.132 apb 1072: Boolean value.
1.17 fair 1073: Runs
1.10 cjs 1074: .Xr named 8
1075: and passes
1076: .Sy named_flags .
1.50 lukem 1077: .It Sy named_chrootdir
1078: A string.
1079: If non-blank and
1080: .Sy named
1.132 apb 1081: is true, run
1.50 lukem 1082: .Xr named 8
1083: as the unprivileged user and group
1084: .Sq named ,
1085: .Xr chroot 2 Ns ed
1086: to
1087: .Sy named_chrootdir .
1.81 wiz 1088: .Sy named_chrootdir Ns Pa /var/run/log
1.50 lukem 1089: will be added to the list of log sockets that
1090: .Xr syslogd 8
1091: listens to.
1.34 enami 1092: .It Sy ntpd
1.132 apb 1093: Boolean value.
1.17 fair 1094: Runs
1.34 enami 1095: .Xr ntpd 8
1.10 cjs 1096: and passes
1.34 enami 1097: .Sy ntpd_flags .
1.50 lukem 1098: .It Sy ntpd_chrootdir
1099: A string.
1100: If non-blank and
1101: .Sy ntpd
1.132 apb 1102: is true, run
1.50 lukem 1103: .Xr ntpd 8
1104: as the unprivileged user and group
1105: .Sq ntpd ,
1106: .Xr chroot 2 Ns ed
1107: to
1108: .Sy ntpd_chrootdir .
1.81 wiz 1109: .Sy ntpd_chrootdir Ns Pa /var/run/log
1.50 lukem 1110: will be added to the list of log sockets that
1111: .Xr syslogd 8
1112: listens to.
1.62 lukem 1113: This option requires that the kernel has
1114: .Dl pseudo-device clockctl
1.63 lukem 1115: compiled in, and that
1116: .Pa /dev/clockctl
1117: is present.
1.88 jmmv 1118: .It Sy postfix
1.132 apb 1119: Boolean value.
1.88 jmmv 1120: Starts
1121: .Xr postfix 1
1122: mail system.
1123: .It Sy sshd
1.132 apb 1124: Boolean value.
1.88 jmmv 1125: Runs
1126: .Xr sshd 8
1127: and passes
1128: .Sy sshd_flags .
1129: .It Sy syslogd
1.132 apb 1130: Boolean value.
1.17 fair 1131: Runs
1.88 jmmv 1132: .Xr syslogd 8
1.10 cjs 1133: and passes
1.88 jmmv 1134: .Sy syslogd_flags .
1135: .It Sy timed
1.132 apb 1136: Boolean value.
1.36 lukem 1137: Runs
1.88 jmmv 1138: .Xr timed 8
1.36 lukem 1139: and passes
1.88 jmmv 1140: .Sy timed_flags .
1141: The
1142: .Dq Li -M
1143: option allows
1144: .Xr timed 8
1145: to be a master time source as well as a slave.
1146: If you are also running
1147: .Xr ntpd 8 ,
1148: only one machine running both should have the
1149: .Dq Li -M
1150: flag given to
1151: .Xr timed 8 .
1.5 cjs 1152: .El
1.49 wiz 1153: .Ss Routing daemons
1.11 mikel 1154: .Bl -tag -width net_interfaces
1.10 cjs 1155: .It Sy mrouted
1.132 apb 1156: Boolean value.
1.17 fair 1157: Runs
1.10 cjs 1158: .Xr mrouted 8 ,
1.17 fair 1159: the DVMRP multicast routing protocol daemon.
1160: Passes
1.10 cjs 1161: .Sy mrouted_flags .
1.24 itojun 1162: .It Sy route6d
1.132 apb 1163: Boolean value.
1.24 itojun 1164: Runs
1165: .Xr route6d 8 ,
1166: the RIPng routing protocol daemon for IPv6.
1167: Passes
1168: .Sy route6d_flags .
1.88 jmmv 1169: .It Sy routed
1.132 apb 1170: Boolean value.
1.88 jmmv 1171: Runs
1172: .Xr routed 8 ,
1173: the RIP routing protocol daemon.
1174: Passes
1175: .Sy routed_flags .
1.132 apb 1176: .\" This should be false
1.88 jmmv 1177: .\" if
1178: .\" .Sy gated
1.132 apb 1179: .\" is true.
1.25 itojun 1180: .It Sy rtsold
1.132 apb 1181: Boolean value.
1.25 itojun 1182: Runs
1183: .Xr rtsold 8 ,
1184: the IPv6 router solicitation daemon.
1185: .Xr rtsold 8
1.60 lukem 1186: periodically transmits router solicitation packets
1187: to find IPv6 routers on the network.
1188: This configuration is mainly for nomadic hosts like notebook computers.
1189: Stationary hosts should work fine with just
1190: .Sy rtsol .
1.25 itojun 1191: Passes
1192: .Sy rtsold_flags .
1.60 lukem 1193: This is only for autoconfigured IPv6 hosts, so set
1.29 itojun 1194: .Sy ip6mode
1.60 lukem 1195: to
1196: .Dq Li autohost
1197: if you use it.
1.5 cjs 1198: .El
1.49 wiz 1199: .Ss Daemons used to boot other hosts over a network
1.11 mikel 1200: .Bl -tag -width net_interfaces
1.10 cjs 1201: .It Sy bootparamd
1.132 apb 1202: Boolean value.
1.17 fair 1203: Runs
1.10 cjs 1204: .Xr bootparamd 8 ,
1205: the boot parameter server, with
1.11 mikel 1206: .Sy bootparamd_flags
1.17 fair 1207: as options.
1208: Used to boot
1.8 mikel 1209: .Nx
1.17 fair 1210: and
1211: .Tn "SunOS 4.x"
1212: systems.
1.10 cjs 1213: .It Sy dhcpd
1.132 apb 1214: Boolean value.
1.17 fair 1215: Runs
1.10 cjs 1216: .Xr dhcpd 8 ,
1.17 fair 1217: the Dynamic Host Configuration Protocol (DHCP) daemon,
1218: for assigning IP addresses to hosts and passing boot information.
1219: Passes
1.10 cjs 1220: .Sy dhcpd_flags .
1.35 lukem 1221: .It Sy dhcrelay
1.132 apb 1222: Boolean value.
1.35 lukem 1223: Runs
1224: .Xr dhcrelay 8 .
1225: Passes
1226: .Sy dhcrelay_flags .
1.10 cjs 1227: .It Sy mopd
1.132 apb 1228: Boolean value.
1.17 fair 1229: Runs
1.10 cjs 1230: .Xr mopd 8 ,
1.17 fair 1231: the
1232: .Tn DEC
1233: .Tn MOP
1234: protocol daemon; used for booting
1235: .Tn VAX
1236: and other
1237: .Tn DEC
1238: machines.
1.10 cjs 1239: Passes
1240: .Sy mopd_flags .
1.50 lukem 1241: .It Sy ndbootd
1.132 apb 1242: Boolean value.
1.50 lukem 1243: Runs
1244: .Xr ndbootd 8 ,
1245: the Sun Network Disk (ND) Protocol server.
1246: Passes
1247: .Sy ndbootd_flags .
1.88 jmmv 1248: .It Sy rarpd
1.132 apb 1249: Boolean value.
1.88 jmmv 1250: Runs
1251: .Xr rarpd 8 ,
1252: the reverse ARP daemon, often used to boot
1253: .Nx
1254: and Sun workstations.
1255: Passes
1256: .Sy rarpd_flags .
1257: .It Sy rbootd
1.132 apb 1258: Boolean value.
1.88 jmmv 1259: Runs
1260: .Xr rbootd 8 ,
1261: the
1262: .Tn HP
1263: boot protocol daemon; used for booting
1264: .Tn HP
1265: workstations.
1266: Passes
1267: .Sy rbootd_flags .
1.24 itojun 1268: .It Sy rtadvd
1.132 apb 1269: Boolean value.
1.24 itojun 1270: Runs
1271: .Xr rtadvd 8 ,
1272: the IPv6 router advertisement daemon, which is used to advertise
1273: information about the subnet to IPv6 end hosts.
1274: Passes
1275: .Sy rtadvd_flags .
1.60 lukem 1276: This is only for IPv6 routers, so set
1277: .Sy ip6mode
1.35 lukem 1278: to
1.60 lukem 1279: .Dq Li router
1.35 lukem 1280: if you use it.
1281: .El
1.49 wiz 1282: .Ss X Window System daemons
1.35 lukem 1283: .Bl -tag -width net_interfaces
1284: .It Sy xdm
1.132 apb 1285: Boolean value.
1.35 lukem 1286: Runs the
1287: .Xr xdm 1
1288: X display manager.
1289: These X daemons are available only with the optional X distribution of
1290: .Nx .
1.88 jmmv 1291: .It Sy xfs
1.132 apb 1292: Boolean value.
1.88 jmmv 1293: Runs the
1294: .Xr xfs 1
1295: X11 font server, which supplies local X font files to X terminals.
1.5 cjs 1296: .El
1.49 wiz 1297: .Ss NIS (YP) daemons
1.11 mikel 1298: .Bl -tag -width net_interfaces
1.10 cjs 1299: .It Sy ypbind
1.132 apb 1300: Boolean value.
1.17 fair 1301: Runs
1.10 cjs 1302: .Xr ypbind 8 ,
1.18 lukem 1303: which lets
1304: .Tn NIS
1305: (YP) clients use information from a
1306: .Tn NIS
1307: server.
1.17 fair 1308: Passes
1.10 cjs 1309: .Sy ypbind_flags .
1.88 jmmv 1310: .It Sy yppasswdd
1.132 apb 1311: Boolean value.
1.88 jmmv 1312: Runs
1313: .Xr yppasswdd 8 ,
1314: which allows remote
1315: .Tn NIS
1316: users to update password on master server.
1317: Passes
1318: .Sy yppasswdd_flags .
1.10 cjs 1319: .It Sy ypserv
1.132 apb 1320: Boolean value.
1.17 fair 1321: Runs
1.10 cjs 1322: .Xr ypserv 8 ,
1.18 lukem 1323: the
1324: .Tn NIS
1325: (YP) server for distributing information from certain files in
1.5 cjs 1326: .Pa /etc .
1.10 cjs 1327: Passes
1328: .Sy ypserv_flags .
1329: The
1.40 lukem 1330: .Dq Li -d
1.10 cjs 1331: flag causes it to use DNS for lookups in
1332: .Pa /etc/hosts
1333: that fail.
1.88 jmmv 1334: .El
1335: .Ss NFS daemons and parameters
1336: .Bl -tag -width net_interfaces
1337: .It Sy amd
1.132 apb 1338: Boolean value.
1.88 jmmv 1339: Runs
1340: .Xr amd 8 ,
1341: the automounter daemon, which automatically mounts NFS file systems
1342: whenever a file or directory within that file system is accessed.
1343: Passes
1344: .Sy amd_flags .
1345: .It Sy amd_dir
1346: A string.
1347: The
1348: .Xr amd 8
1349: mount directory.
1350: Used only if
1351: .Sy amd
1.132 apb 1352: is true.
1.88 jmmv 1353: .It Sy lockd
1.132 apb 1354: Boolean value.
1.17 fair 1355: Runs
1.88 jmmv 1356: .Xr rpc.lockd 8
1357: if
1358: .Sy nfs_server
1359: and/or
1360: .Sy nfs_client
1.132 apb 1361: are true.
1.17 fair 1362: Passes
1.88 jmmv 1363: .Sy lockd_flags .
1.47 lukem 1364: .It Sy mountd
1.132 apb 1365: Boolean value.
1.47 lukem 1366: Runs
1367: .Xr mountd 8
1368: and passes
1369: .Sy mountd_flags .
1.5 cjs 1370: .It Sy nfs_client
1.132 apb 1371: Boolean value.
1.34 enami 1372: The number of local NFS asynchronous I/O server is now controlled via
1373: .Xr sysctl 8 .
1.1 mrg 1374: .It Sy nfs_server
1.132 apb 1375: Boolean value.
1.17 fair 1376: Sets up a host to be a NFS server by running
1.47 lukem 1377: .Xr nfsd 8
1.17 fair 1378: and passing
1.47 lukem 1379: .Sy nfsd_flags .
1.10 cjs 1380: .It Sy statd
1.132 apb 1381: Boolean value.
1.17 fair 1382: Runs
1.10 cjs 1383: .Xr rpc.statd 8 ,
1384: a status monitoring daemon used when
1.17 fair 1385: .Xr rpc.lockd 8
1.50 lukem 1386: is running, if
1.3 scottr 1387: .Sy nfs_server
1.50 lukem 1388: and/or
1.3 scottr 1389: .Sy nfs_client
1.132 apb 1390: are true.
1.17 fair 1391: Passes
1.10 cjs 1392: .Sy statd_flags .
1.13 jonathan 1393: .El
1.147 plunky 1394: .Ss Bluetooth support
1.102 gdamore 1395: .Bl -tag -width net_interfaces
1.147 plunky 1396: .It Sy bluetooth
1.132 apb 1397: Boolean value.
1.147 plunky 1398: Configure Bluetooth support, comprising the following tasks:
1399: .Bl -dash -compact
1400: .It
1401: attach serial Bluetooth controllers as listed in the
1402: .Pa /etc/bluetooth/btdevctl.conf
1403: configuration file.
1404: .It
1405: enable Bluetooth controllers with useful defaults, plus
1406: additional options as detailed below.
1407: .It
1408: optionally, start
1409: .Xr bthcid 8 ,
1410: the Bluetooth Link Key/PIN Code manager, passing
1411: .Sy bthcid_flags .
1412: .It
1413: configure local Bluetooth drivers as listed in the
1414: .Pa /etc/bluetooth/btdevctl.conf
1415: configuration file.
1416: .It
1417: optionally, start
1418: .Xr sdpd 8 ,
1419: the Service Discovery server, passing
1420: .Sy sdpd_flags .
1421: .El
1.102 gdamore 1422: .It Sy btconfig_devices
1.147 plunky 1423: A string.
1424: An optional list of Bluetooth controllers to configure.
1425: .It Sy btconfig_{dev}
1426: A string.
1427: Additional configuration options for specific Bluetooth controllers.
1.102 gdamore 1428: .It Sy btconfig_args
1.147 plunky 1429: A string.
1430: Additional configuration options for Bluetooth controllers without
1431: specific options as above.
1.102 gdamore 1432: .It Sy bthcid
1.132 apb 1433: Boolean value.
1.147 plunky 1434: If set to false, disable starting the Bluetooth Link Key/PIN Code manager.
1.102 gdamore 1435: .It Sy sdpd
1.132 apb 1436: Boolean value.
1.147 plunky 1437: If set to false, disable starting the Bluetooth Service Discovery server.
1.102 gdamore 1438: .El
1.49 wiz 1439: .Ss Other daemons
1.11 mikel 1440: .Bl -tag -width net_interfaces
1.139 jruoho 1441: .It Sy identd
1442: Boolean value.
1443: Runs
1444: .Xr identd 8 ,
1445: the daemon for the user identification protocol.
1446: Passes
1447: .Sy identd_flags .
1448: .It Sy iscsi_target
1449: Boolean value.
1450: Runs the server for iSCSI requests,
1451: .Xr iscsi-target 8 .
1452: Passes
1453: .Sy iscsi_target_flags .
1.50 lukem 1454: .It Sy isdnd
1.132 apb 1455: Boolean value.
1.50 lukem 1456: Runs
1457: .Xr isdnd 8 ,
1458: the isdn4bsd ISDN connection management daemon.
1459: Passes
1460: .Sy isdnd_flags .
1461: .It Sy isdn_autoupdown
1.132 apb 1462: Boolean value.
1.50 lukem 1463: Set all configured ISDN interfaces to
1464: .Dq up .
1465: If
1466: .Sy isdn_interfaces
1467: is not blank, only the listed interfaces will be modified.
1468: Used only if
1469: .Sy isdnd
1.132 apb 1470: is true.
1.88 jmmv 1471: .It Sy kdc
1.132 apb 1472: Boolean value.
1.88 jmmv 1473: Runs the
1474: .Xr kdc 8
1475: Kerberos v4 and v5 server.
1476: This should be run on Kerberos master and slave servers.
1.5 cjs 1477: .It Sy rwhod
1.132 apb 1478: Boolean value.
1.17 fair 1479: Runs
1.11 mikel 1480: .Xr rwhod 8
1.10 cjs 1481: to support the
1.11 mikel 1482: .Xr rwho 1
1.17 fair 1483: and
1484: .Xr ruptime 1
1485: commands.
1.35 lukem 1486: .El
1.49 wiz 1487: .Ss Hardware daemons
1.35 lukem 1488: .Bl -tag -width net_interfaces
1489: .It Sy apmd
1.132 apb 1490: Boolean value.
1.35 lukem 1491: Runs
1492: .Xr apmd 8
1493: and passes
1494: .Sy apmd_flags .
1.100 rpaulo 1495: .It Sy irdaattach
1.132 apb 1496: Boolean value.
1.100 rpaulo 1497: Runs
1498: .Xr irdaattach 8
1499: and passes
1500: .Sy irdaattach_flags .
1.88 jmmv 1501: .It Sy moused
1.132 apb 1502: Boolean value.
1.88 jmmv 1503: Runs
1504: .Xr moused 8 ,
1505: to pass serial mouse data to the wscons mouse mux.
1506: Passes
1507: .Sy moused_flags .
1.16 mrg 1508: .It Sy screenblank
1.132 apb 1509: Boolean value.
1.17 fair 1510: Runs
1511: .Xr screenblank 1
1.16 mrg 1512: and passes
1513: .Sy screenblank_flags .
1.35 lukem 1514: .It Sy wscons
1.132 apb 1515: Boolean value.
1.35 lukem 1516: Configures the
1517: .Xr wscons 4
1518: console driver, from the configuration file
1519: .Pa /etc/wscons.conf .
1.69 wiz 1520: .It Sy wsmoused
1.132 apb 1521: Boolean value.
1.69 wiz 1522: Runs
1523: .Xr wsmoused 8 ,
1524: to provide copy and paste text support in wscons displays.
1525: Passes
1526: .Sy wsmoused_flags .
1.1 mrg 1527: .El
1528: .Sh FILES
1.39 lukem 1529: .Bl -tag -width /etc/defaults/rc.conf -compact
1530: .It Pa /etc/rc.conf
1531: The file
1532: .Nm
1533: resides in
1534: .Pa /etc .
1535: .It Pa /etc/defaults/rc.conf
1536: Default settings for
1.76 wiz 1537: .Nm ,
1.58 lukem 1538: sourced by
1539: .Nm
1540: before the end-user configuration section.
1541: .It Pa /etc/rc.conf.d/ Ns Ar foo
1542: .Ar foo Ns No -specific
1543: .Nm
1544: overrides.
1.39 lukem 1545: .El
1.1 mrg 1546: .Sh SEE ALSO
1.8 mikel 1547: .Xr boot 8 ,
1.34 enami 1548: .Xr rc 8 ,
1.88 jmmv 1549: .Xr rc.d 8 ,
1.64 atatat 1550: .Xr rc.subr 8 ,
1.88 jmmv 1551: .Xr rcorder 8
1.1 mrg 1552: .Sh HISTORY
1553: The
1554: .Nm
1555: file appeared in
1556: .Nx 1.3 .
CVSweb <webmaster@jp.NetBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to rc.conf.5 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [cvs.NetBSD.org] / src / share / man / man5