]> git.saurik.com Git - apple/configd.git/blob - configd.tproj/configd.8
configd-204.tar.gz
[apple/configd.git] / configd.tproj / configd.8
1 .\"
2 .\" @(#)configd.8
3 .\"
4 .Dd November 4, 2003
5 .Dt CONFIGD 8
6 .Os "Mac OS X"
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
54 into verbose mode. Displays debugging information about
55 bundles as they are being loaded.
56 .It Fl V Ar bundleID
57 Turns verbose mode on for the bundle with the specified
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
69 .Ss ATconfig
70 This bundle is responsible for establishing and maintaining the AppleTalk network configuration on the system.
71 .Ss KernelEventMonitor
72 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.
73 .Ss InterfaceNamer
74 This bundle provides a name to each of the system's network interfaces. The bundle queries the
75 IOKit Registry for a list of network devices attached to the system and gives them BSD style names such as
76 .Qq en0 .
77 .Ss IPConfiguration
78 This agent is responsible for establishing and maintaining IPv4 addresses on the system. These addresses may be manually specified in the network preferences or acquired using DHCP (or BOOTP).
79 .Ss IP6Configuration
80 This agent is responsible for establishing and maintaining IPv6 addresses on the system.
81 .Ss IPMonitor
82 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.
83 .Ss LinkConfiguration
84 This agent is responsible for establishing and maintaining the media type, media options, and MTU for ethernet interfaces.
85 .Ss PreferencesMonitor
86 This agent is responsible for conveying the network configuration preferences specified by the administrator to the various configuration agents (AppleTalk, IPv4, IPv6, ...).
87 .Ss PPPController
88 This agent is responsible for establishing and maintaining PPP connections on the system.
89 .Sh FILES
90 .Bl -tag -width xx
91 .It Pa /System/Library/SystemConfiguration/
92 Directory of
93 .Nm
94 bundles
95 .It Pa /Library/Preferences/SystemConfiguration/
96 Default directory for system configuration persistent store files.
97 .Bl -tag -width .../VirtualNetworkInterfaces.plist
98 .It Pa .../preferences.plist
99 System configuration
100 .It Pa .../NetworkInterfaces.plist
101 Network interface --> BSD interface mappings
102 .It Pa .../VirtualNetworkInterfaces.plist
103 Virtual network interface (VLAN) configuration
104 .El
105 .El
106 .Sh ERRORS
107 Log messages generated by
108 .Nm
109 and any configuration agents will are
110 sent to the system log daemon by
111 .Xr syslog 3 .
112 The syslog facility used is LOG_DAEMON.
113 If the
114 .Fl d
115 option is specified, log messages with written to stdout (or stderr if
116 the priority is greater than LOG_NOTICE).
117 .Sh SIGNALS
118 .Nm
119 was designed to run without any intervention but if you insist on sending a signal to the daemon then the following are available:
120 .Bl -tag -width SIGTERM
121 .It Dv SIGHUP
122 This signal, typically used to tell a daemon to reload it's configuration, is ignored (there is no configuration).
123 .It Dv SIGTERM
124 This signal initiates a
125 .Qq graceful
126 shutdown of the daemon.
127 .El
128 .Sh SEE ALSO
129 ./".Xr SystemConfiguration.framework 3 ,
130 .Xr scutil 8 ,
131 .Xr scselect 8
132 ./".Xr launchd 8
133 .Sh HISTORY
134 The
135 .Nm
136 daemon appeared in Mac OS X Public Beta.
137 .Sh NOTES
138 Unless started with the
139 .Fl d
140 option,
141 .Nm
142 will register with
143 .Xr launchd 8
144 such that the daemon will be restarted in the event of a crash.
145 This registration will be removed during
146 .Qq graceful
147 shutdowns of the daemon.
148 .Pp
149 This daemon and its current behavior may change without notice. Do not rely
150 on its existence or its behavior. Consider it an unsupported command.