293 useradd/del/mod should be ZFS-aware
[illumos-gate.git] / usr / src / man / man1m / slpd.1m
bloba17acdd96df632a39f3abd4352d6b9401afdae6a
1 '\" te
2 .\" Copyright (C) 2004, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SLPD 1M "Aug 23, 2004"
7 .SH NAME
8 slpd \- Service Location Protocol Daemon
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/lib/inet/slpd\fR [\fB-f\fR \fIconfiguration-file\fR]
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBslpd\fR daemon provides common server functionality for the Service
19 Location Protocol ("\fBSLP\fR") versions 1 and 2, as defined by \fBIETF\fR in
20 \fIRFC 2165\fR and \fIRFC 2608\fR. \fBSLP\fR provides a scalable framework for
21 the discovery and selection of network services.
22 .sp
23 .LP
24 \fBslpd\fR provides the following framework services:
25 .sp
26 .ne 2
27 .na
28 \fBDirectory Agent\fR
29 .ad
30 .sp .6
31 .RS 4n
32 This service automatically caches service advertisements from service agents to
33 provide them to user agents, and makes directory agent advertisements of its
34 services. This service is optional. \fBslpd\fR does not provide directory agent
35 service by default. Directory agents are not databases, and they do not need to
36 be maintained.
37 .RE
39 .sp
40 .ne 2
41 .na
42 \fBService Agent Server\fR
43 .ad
44 .sp .6
45 .RS 4n
46 All service agents on the local host register and deregister with this server.
47 This service responds to all requests for services, and forwards registrations
48 to directory agents. By default, \fBslpd\fR is a service agent server.
49 .RE
51 .sp
52 .ne 2
53 .na
54 \fBPassive Directory Agent Discovery \fR
55 .ad
56 .sp .6
57 .RS 4n
58 This service listens for directory agent advertisements and maintains a table
59 of active directory agents.  When a user agent wishes to discover a directory
60 agent, it can simply query \fBslpd\fR, obviating the need to perform discovery
61 by means of multicast. By default, \fBslpd\fR performs this service.
62 .RE
64 .sp
65 .ne 2
66 .na
67 \fBProxy Registration\fR
68 .ad
69 .sp .6
70 .RS 4n
71 This service can act as a proxy service agent for services that cannot register
72 themselves. \fBslpd\fR reads the proxy registration file for information on
73 services it is to proxy. By default, no services are registered by proxy.
74 .RE
76 .sp
77 .LP
78 All configuration options are available from the configuration file. \fBslpd\fR
79 reads its configuration file upon startup.
80 .sp
81 .LP
82 Stop and start the slpd daemon using \fBsvcadm\fR(1M).  Use the command
83 \fBsvcadm enable network/slp\fR to start the slpd daemon.  Use the command
84 \fBsvcadm disable network/slp\fR to stop it.
85 .sp
86 .LP
87 The file \fB/etc/inet/slp.conf\fR must exist before the \fBslp\fR service can
88 start the daemon. Only the example file \fB/etc/inet/slp.conf.example\fR is
89 present by default. To enable \fBSLP\fR, copy \fB/etc/inet/slp.conf.example\fR
90 to \fB/etc/inet/slp.conf\fR.
91 .SH OPTIONS
92 .sp
93 .LP
94 The following options are supported:
95 .sp
96 .ne 2
97 .na
98 \fB\fB-f\fR \fIconfiguration-file\fR\fR
99 .ad
100 .RS 25n
101 Specify an alternate configuration file
104 .SH EXAMPLES
106 \fBExample 1 \fRStopping the \fBslpd\fR daemon
109 The following command stops the \fBslpd\fR daemon:
112 .in +2
114 example# svcadm disable network/slp
116 .in -2
120 \fBExample 2 \fRRestarting the \fBslpd\fR daemon
123 The following command restarts the \fBslpd\fR daemon:
126 .in +2
128 example# svcadm restart network/slp
130 .in -2
133 .SH FILES
135 .ne 2
137 \fB\fB/etc/inet/slp.conf\fR\fR
139 .RS 22n
140 The default configuration file
144 .ne 2
146 \fB\fBslpd.reg\fR\fR
148 .RS 22n
149 The proxy registration file
152 .SH ATTRIBUTES
155 See \fBattributes\fR(5)  for descriptions of the following attributes:
160 box;
161 c | c
162 l | l .
163 ATTRIBUTE TYPE  ATTRIBUTE VALUE
165 CSI     Enabled
167 Interface Stability     Evolving
170 .SH SEE ALSO
173 \fBsvcs\fR(1), \fBsvcadm\fR(1M), \fBslp_api\fR(3SLP), \fBslp.conf\fR(4),
174 \fBslpd.reg\fR(4), \fBattributes\fR(5), \fBsmf\fR(5), \fBslp\fR(7P)
177 \fI\fR
180 Guttman, E.,  Perkins, C., Veizades, J., and Day, M., \fIRFC 2608, Service
181 Location Protocol, Version 2\fR, The Internet Society, June 1999.
182 .SH NOTES
185 The \fBslpd\fR service is managed by the service management facility,
186 \fBsmf\fR(5), under the service identifier:
188 .in +2
190 svc:/network/slp
192 .in -2
197 Administrative actions on this service, such as enabling, disabling, or
198 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
199 status can be queried using the \fBsvcs\fR(1) command.