[apple/configd.git] / configd.tproj / configd.8

.\"
.\"     @(#)configd.8
.\"
.Dd April 14, 2020
.Dt CONFIGD 8
.Os "Mac OS X"
.Sh NAME
.Nm configd
.Nd System Configuration Daemon
.Sh SYNOPSIS
.Nm
.Op Fl bdv
.Op Fl B Ar bundleID
.Op Fl V Ar bundleID
.Op Fl t Ar bundle-path
.Sh DESCRIPTION
The
.Nm
daemon
is responsible for many configuration aspects of the local system.
.Nm
maintains data reflecting the desired and current state of the system,
provides notifications to applications when this data changes,
and hosts a number of configuration agents in the form of loadable
bundles.
.Pp
Each configuration agent is responsible for a well-defined aspect
of configuration management. The agents look to one or more input
sources (preferences, low-level kernel events,
.Nm
notifications, etc) and, through
a set of policy modules, interacts with the system to establish
the desired operational configuration.
.Pp
Access to the data maintained by
.Nm
is via the SystemConfiguration.framework SCDynamicStore APIs.
.Sh OPTIONS
.Pp
The command line options are as follows:
.Bl -tag -width xx
.It Fl b
Don't actually load any bundles.
.It Fl B Ar bundleID
Prevents the loading of the bundle with the specified
.Ar bundleID .
.It Fl d
Run
.Nm
in the foreground without forking.  This is useful for debugging.
.It Fl v
Puts
.Nm
into verbose mode.  Displays debugging information about
bundles as they are being loaded.
.It Fl V Ar bundleID
Turns verbose mode on for the bundle with the specified
.Ar bundleID .
.It Fl t Ar bundle-path
Loads only the bundle specified by
.Ar bundle-path .
.El
.Sh BUNDLES
At the present time, the majority of the configuration agents (or bundles) hosted by
.Nm
are used to establish and maintain the network configuration.
These agents include:
.Pp
.Ss KernelEventMonitor
This bundle is responsible for monitoring kernel events and conveying changes to the network state (e.g. link status) to other configuration agents and interested applications.
.Ss InterfaceNamer
This bundle provides a name to each of the system's network interfaces.  The bundle queries the
IOKit Registry for a list of network devices attached to the system and gives them BSD style names such as
.Qq en0 .
.Ss IPConfiguration
This agent is responsible for establishing and maintaining IPv4 and IPv6 addresses on the system.  These addresses may be manually specified in the network preferences or acquired using DHCP (or BOOTP), DHCPv6, and RTADV.
.Ss IPMonitor
This agent is responsible for establishing and maintaining the primary network service, the default route, the active DNS configuration, and the active network proxies on the system.
.Ss LinkConfiguration
This agent is responsible for establishing and maintaining the media type, media options, and MTU for ethernet interfaces.
.Ss PreferencesMonitor
This agent is responsible for conveying the network configuration preferences specified by the administrator to the various configuration agents (IPv4, IPv6, ...).
.Ss PPPController
This agent is responsible for establishing and maintaining PPP connections on the system.
.Sh FILES
.Bl -tag -width xx
.It Pa /System/Library/SystemConfiguration/
Directory of
.Nm
bundles
.It Pa /Library/Preferences/SystemConfiguration/
Default directory for system configuration persistent store files.
.Bl -tag -width .../NetworkInterfaces.plist
.It Pa .../preferences.plist
Network configuration and computer/host names
.It Pa .../NetworkInterfaces.plist
Network interface --> BSD interface mappings
.El
.El
.Sh ERRORS
Log messages generated by
.Nm
and any configuration agents will are
sent to the system log daemon by
.Xr syslog 3 .
The syslog facility used is LOG_DAEMON.
If the
.Fl d
option is specified, log messages with written to stdout (or stderr if
the priority is greater than LOG_NOTICE).
.Sh SIGNALS
.Nm
was designed to run without any intervention but if you insist on sending a signal to the daemon then the following are available:
.Bl -tag -width SIGTERM
.It Dv SIGHUP
This signal, typically used to tell a daemon to reload its configuration, is ignored (there is no configuration).
.It Dv SIGTERM
This signal initiates a
.Qq graceful
shutdown of the daemon.
.El
.Sh SEE ALSO
./".Xr SystemConfiguration.framework 3 ,
.Xr scutil 8 ,
.Xr scselect 8
./".Xr launchd 8
.Sh HISTORY
The
.Nm
daemon appeared in Mac OS X Public Beta.
.Sh NOTES
Unless started with the
.Fl d
option,
.Nm
will register with
.Xr launchd 8
such that the daemon will be restarted in the event of a crash.
This registration will be removed during
.Qq graceful
shutdowns of the daemon.
.Pp
This daemon and its current behavior may change without notice.  Do not rely
on its existence or its behavior.  Consider it an unsupported command.
Commit	Line	Data
dbf6a266 A	1	.\"
	2	.\" @(#)configd.8
	3	.\"
c956c85e	4	.Dd April 14, 2020
dbf6a266	5	.Dt CONFIGD 8
edebe297	6	.Os "Mac OS X"
dbf6a266 A	7	.Sh NAME
	8	.Nm configd
	9	.Nd System Configuration Daemon
	10	.Sh SYNOPSIS
	11	.Nm
	12	.Op Fl bdv
	13	.Op Fl B Ar bundleID
	14	.Op Fl V Ar bundleID
	15	.Op Fl t Ar bundle-path
	16	.Sh DESCRIPTION
	17	The
	18	.Nm
	19	daemon
	20	is responsible for many configuration aspects of the local system.
	21	.Nm
	22	maintains data reflecting the desired and current state of the system,
	23	provides notifications to applications when this data changes,
	24	and hosts a number of configuration agents in the form of loadable
	25	bundles.
	26	.Pp
	27	Each configuration agent is responsible for a well-defined aspect
	28	of configuration management. The agents look to one or more input
	29	sources (preferences, low-level kernel events,
	30	.Nm
	31	notifications, etc) and, through
	32	a set of policy modules, interacts with the system to establish
	33	the desired operational configuration.
	34	.Pp
	35	Access to the data maintained by
	36	.Nm
	37	is via the SystemConfiguration.framework SCDynamicStore APIs.
	38	.Sh OPTIONS
	39	.Pp
	40	The command line options are as follows:
	41	.Bl -tag -width xx
	42	.It Fl b
	43	Don't actually load any bundles.
	44	.It Fl B Ar bundleID
	45	Prevents the loading of the bundle with the specified
	46	.Ar bundleID .
	47	.It Fl d
	48	Run
	49	.Nm
	50	in the foreground without forking. This is useful for debugging.
	51	.It Fl v
	52	Puts
	53	.Nm
5e9ce69e	54	into verbose mode. Displays debugging information about
dbf6a266 A	55	bundles as they are being loaded.
dbf6a266 A	56	.It Fl V Ar bundleID
5e9ce69e	57	Turns verbose mode on for the bundle with the specified
dbf6a266 A	58	.Ar bundleID .
	59	.It Fl t Ar bundle-path
	60	Loads only the bundle specified by
	61	.Ar bundle-path .
	62	.El
	63	.Sh BUNDLES
	64	At the present time, the majority of the configuration agents (or bundles) hosted by
	65	.Nm
	66	are used to establish and maintain the network configuration.
	67	These agents include:
	68	.Pp
dbf6a266 A	69	.Ss KernelEventMonitor
	70	This bundle is responsible for monitoring kernel events and conveying changes to the network state (e.g. link status) to other configuration agents and interested applications.
	71	.Ss InterfaceNamer
	72	This bundle provides a name to each of the system's network interfaces. The bundle queries the
	73	IOKit Registry for a list of network devices attached to the system and gives them BSD style names such as
	74	.Qq en0 .
	75	.Ss IPConfiguration
c956c85e	76	This agent is responsible for establishing and maintaining IPv4 and IPv6 addresses on the system. These addresses may be manually specified in the network preferences or acquired using DHCP (or BOOTP), DHCPv6, and RTADV.
dbf6a266 A	77	.Ss IPMonitor
	78	This agent is responsible for establishing and maintaining the primary network service, the default route, the active DNS configuration, and the active network proxies on the system.
	79	.Ss LinkConfiguration
	80	This agent is responsible for establishing and maintaining the media type, media options, and MTU for ethernet interfaces.
	81	.Ss PreferencesMonitor
a40a14f8	82	This agent is responsible for conveying the network configuration preferences specified by the administrator to the various configuration agents (IPv4, IPv6, ...).
dbf6a266 A	83	.Ss PPPController
	84	This agent is responsible for establishing and maintaining PPP connections on the system.
	85	.Sh FILES
	86	.Bl -tag -width xx
	87	.It Pa /System/Library/SystemConfiguration/
	88	Directory of
	89	.Nm
	90	bundles
	91	.It Pa /Library/Preferences/SystemConfiguration/
	92	Default directory for system configuration persistent store files.
c956c85e	93	.Bl -tag -width .../NetworkInterfaces.plist
dbf6a266	94	.It Pa .../preferences.plist
c956c85e	95	Network configuration and computer/host names
dbf6a266 A	96	.It Pa .../NetworkInterfaces.plist
dbf6a266 A	97	Network interface --> BSD interface mappings
dbf6a266 A	98	.El
	99	.El
	100	.Sh ERRORS
	101	Log messages generated by
	102	.Nm
	103	and any configuration agents will are
	104	sent to the system log daemon by
	105	.Xr syslog 3 .
	106	The syslog facility used is LOG_DAEMON.
	107	If the
	108	.Fl d
	109	option is specified, log messages with written to stdout (or stderr if
	110	the priority is greater than LOG_NOTICE).
	111	.Sh SIGNALS
	112	.Nm
	113	was designed to run without any intervention but if you insist on sending a signal to the daemon then the following are available:
	114	.Bl -tag -width SIGTERM
	115	.It Dv SIGHUP
6bb65964	116	This signal, typically used to tell a daemon to reload its configuration, is ignored (there is no configuration).
dbf6a266 A	117	.It Dv SIGTERM
	118	This signal initiates a
	119	.Qq graceful
	120	shutdown of the daemon.
	121	.El
	122	.Sh SEE ALSO
	123	./".Xr SystemConfiguration.framework 3 ,
	124	.Xr scutil 8 ,
	125	.Xr scselect 8
edebe297	126	./".Xr launchd 8
dbf6a266 A	127	.Sh HISTORY
	128	The
	129	.Nm
	130	daemon appeared in Mac OS X Public Beta.
	131	.Sh NOTES
	132	Unless started with the
	133	.Fl d
	134	option,
	135	.Nm
	136	will register with
edebe297	137	.Xr launchd 8
dbf6a266 A	138	such that the daemon will be restarted in the event of a crash.
	139	This registration will be removed during
	140	.Qq graceful
	141	shutdowns of the daemon.
	142	.Pp
	143	This daemon and its current behavior may change without notice. Do not rely
	144	on its existence or its behavior. Consider it an unsupported command.