Unleashed v1.4
[unleashed.git] / share / man / man8 / syseventd.8
blob10aa18a796bb70573ace4877e779bce20b4aa68c
1 '\" te
2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH SYSEVENTD 8 "Jan 31, 2013"
8 .SH NAME
9 syseventd \- kernel system event notification daemon
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fB/usr/lib/sysevent/syseventd\fR [\fB-d\fR \fIdebug_level\fR] [\fB-r\fR \fIrootdir\fR]
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 \fBsyseventd\fR is a user-level daemon that accepts delivery of system event
20 buffers from the kernel. Once an event buffer has been delivered to
21 \fBsyseventd\fR, it, in turn, attempts to propagate the event to all interested
22 end event subscribers.
23 .sp
24 .LP
25 Event subscribers take the form of a \fBsyseventd\fR loadable module
26 (\fBSLM\fR). \fBsyseventd\fR passes the event buffer to each of its subscribers
27 and in return expects a notification as to the successful or unsuccessful
28 delivery attempt.
29 .sp
30 .LP
31 Upon successful delivery of the event buffer to all interested event
32 subscribers, \fBsyseventd\fR frees the event buffer from the kernel event
33 queue.
34 .SH OPTIONS
35 .sp
36 .LP
37 The following options are supported:
38 .sp
39 .ne 2
40 .na
41 \fB\fB-d\fR \fIdebug_level\fR\fR
42 .ad
43 .RS 18n
44 Enable debug mode. Messages are printed to the invoking user's terminal.
45 .RE
47 .sp
48 .ne 2
49 .na
50 \fB\fB-r\fR \fIrootdir\fR\fR
51 .ad
52 .RS 18n
53 Cause \fBsyseventd\fR to use an alternate root path when creating its door and
54 lock files. Modules continue to be loaded from the standard module directories.
55 .RE
57 .SH EXIT STATUS
58 .sp
59 .LP
60 The following exit values are returned:
61 .sp
62 .ne 2
63 .na
64 \fB\fB0\fR \fR
65 .ad
66 .RS 12n
67 Successful completion.
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fB\fBnon-zero\fR\fR
74 .ad
75 .RS 12n
76 An error occurred.
77 .RE
79 .SH FILES
80 .sp
81 .ne 2
82 .na
83 \fB\fB/var/run/syseventd.lock\fR\fR
84 .ad
85 .sp .6
86 .RS 4n
87 daemon lock file
88 .RE
90 .sp
91 .ne 2
92 .na
93 \fB\fB/var/run/sysevent_door\fR \fR
94 .ad
95 .sp .6
96 .RS 4n
97 kernel to \fBsyseventd\fR door file
98 .RE
101 .ne 2
103 \fB\fB/usr/lib/sysevent/modules\fR \fR
105 .sp .6
106 .RS 4n
107 \fBSLM\fR directory repository
111 .ne 2
113 \fB\fB/usr/platform/\fR\fB`\fR\fBuname
114 \(emi\fR\fB`\fR\fB/lib/sysevent/modules\fR\fR
116 .sp .6
117 .RS 4n
118 \fBSLM\fR directory repository
122 .ne 2
124 \fB\fB/usr/platform/\fR\fB`\fR\fBuname
125 \(emm\fR\fB`\fR\fB/lib/sysevent/modules\fR\fR
127 .sp .6
128 .RS 4n
129 \fBSLM\fR directory repository
132 .SH SEE ALSO
135 \fBsvcs\fR(1), \fBsvcadm\fR(8), \fBsyseventconfd\fR(8), \fBattributes\fR(5),
136 \fBsmf\fR(5)
137 .SH NOTES
140 The \fBsyseventd\fR service is managed by the service management facility,
141 \fBsmf\fR(5), under the service identifier:
143 .in +2
145 svc:/system/sysevent:default
147 .in -2
152 Administrative actions on this service, such as enabling, disabling, or
153 requesting restart, can be performed using \fBsvcadm\fR(8). The service's
154 status can be queried using the \fBsvcs\fR(1) command.