Print this page
12743 man page spelling mistakes
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man1m/picld.1m
+++ new/usr/src/man/man1m/picld.1m
1 1 '\" te
2 2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
3 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 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 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 PICLD 1M "Aug 10, 2004"
6 +.TH PICLD 1M "May 16, 2020"
7 7 .SH NAME
8 8 picld \- PICL daemon
9 9 .SH SYNOPSIS
10 -.LP
11 10 .nf
12 11 \fB/usr/lib/picl/picld\fR
13 12 .fi
14 13
15 14 .SH DESCRIPTION
16 -.sp
17 -.LP
18 15 The Platform Information and Control Library (\fBPICL\fR) provides a mechanism
19 16 to publish platform-specific information for clients to access in a
20 17 platform-independent way. \fBpicld\fR maintains and controls access to the
21 18 \fBPICL\fR information from clients and plug-in modules. The daemon is started
22 19 in both single-user and multi-user boot mode.
23 20 .sp
24 21 .LP
25 22 Upon startup, the \fBPICL\fR daemon loads and initializes the plug-in modules.
26 23 These modules use the \fBlibpicltree\fR(3PICLTREE) interface to create nodes
27 24 and properties in the \fBPICL\fR tree to publish platform configuration
28 25 information. After the plug-in modules are initialized, the daemon opens the
29 26 \fBPICL\fR daemon door to service client requests to access information in the
30 27 \fBPICL\fR tree.
31 28 .SS "PICL Tree"
32 -.sp
33 -.LP
34 29 The \fBPICL\fR tree is the repository of all the nodes and properties created
35 30 by the plug-in modules to represent the platform configuration. Every node in
36 31 the \fBPICL\fR tree is an instance of a well-defined \fBPICL\fR class. The name
37 32 of the base \fBPICL\fR class is \fBpicl\fR, which defines a basic set of
38 33 properties that all nodes in the tree must possess. Two of those properties are
39 34 \fBname\fR and \fB_class\fR, where \fBname\fR contains the name of the node,
40 35 and the \fB_class\fR contains the \fBPICL\fR class name of the node. Certain
41 36 nodes in the \fBPICL\fR tree have well-known names. For example, the name of
42 37 the root node of the \fBPICL\fR tree is \fB/\fR and the name of the root node
43 38 of the sub-tree containing platform device nodes is \fBplatform\fR.
44 39 .SS "PICL plug-in Modules"
45 -.sp
46 -.LP
47 40 The \fBPICL\fR plug-in modules are shared objects that publish
48 41 platform-specific data in the \fBPICL\fR tree. They are located in well-known
49 42 directories so that the daemon can locate and load them.
50 43 .sp
51 44 .LP
52 45 Plug-in modules are located in one of the following plug-in directories
53 -depending on the plaform-specific nature of the data that they collect and
46 +depending on the platform-specific nature of the data that they collect and
54 47 publish:
55 48 .sp
56 49 .in +2
57 50 .nf
58 51 /usr/platform/`uname -i`/lib/picl/plugins
59 52 /usr/platform/`uname -m`/lib/picl/plugins
60 53 .fi
61 54 .in -2
62 55 .sp
63 56
64 57 .sp
65 58 .LP
66 59 A plug-in module can specify its dependency on another plug-in module using the
67 60 \fB-l\fR or \fB-R\fR linker option. The plug-ins are loaded by the daemon using
68 61 \fBdlopen\fR(3C) according to the specified dependencies. Each plug-in module
69 62 must define a \fB\&.init\fR section, which is executed when the plug-in module
70 63 is loaded, to register themselves with the daemon. See
71 64 \fBpicld_plugin_register\fR(3PICLTREE) for additional information on plug-in
72 65 registration.
73 66 .sp
74 67 .LP
75 68 The plug-in modules use the \fBlibpicltree\fR(3PICLTREE) interface to publish
76 69 nodes and properties in the \fBPICL\fR tree so that clients can access them.
77 70 .sp
78 71 .LP
79 72 When the \fBPICL\fR daemon invokes the initialization routine of the plug-in
80 73 module, the plug-in collects the platform information and creates nodes and/or
81 74 properties to represent the configuration in the \fBPICL\fR tree. A plug-in can
82 75 create additional threads to monitor the platform configuration and update the
83 76 \fBPICL\fR tree with any changes. This enables a \fBPICL\fR plug-in to operate
84 77 as a daemon within the \fBPICL\fR framework.
↓ open down ↓ |
21 lines elided |
↑ open up ↑ |
85 78 .sp
86 79 .LP
87 80 An environmental monitor is an example of a plug-in module that uses a thread
88 81 to monitor the temperatures and fan speeds of the platform, then publishes the
89 82 environmental information in the \fBPICL\fR tree so clients can access them.
90 83 .sp
91 84 .LP
92 85 Clients use the \fBlibpicl\fR(3PICL) interface to send requests to \fBpicld\fR
93 86 for accessing the \fBPICL\fR tree.
94 87 .SH EXIT STATUS
95 -.sp
96 -.LP
97 88 \fBpicld\fR does not return an exit status.
98 89 .SH FILES
99 -.sp
100 90 .ne 2
101 91 .na
102 92 \fB\fB/var/run/picld_door\fR\fR
103 93 .ad
104 94 .RS 23n
105 95 \fBPICL\fR daemon door
106 96 .RE
107 97
108 98 .sp
109 99 .ne 2
110 100 .na
111 101 \fB\fB/usr/lib/picl/picld\fR\fR
112 102 .ad
113 103 .RS 23n
114 104 \fBPICL\fR daemon
115 105 .RE
116 106
117 107 .SH SEE ALSO
118 -.sp
119 -.LP
120 108 \fBsvcs\fR(1), \fBsvcadm\fR(1M), \fBdlopen\fR(3C), \fBlibpicl\fR(3PICL),
121 109 \fBlibpicltree\fR(3PICLTREE), \fBpicld_log\fR(3PICLTREE),
122 110 \fBpicld_plugin_register\fR(3PICLTREE), \fBattributes\fR(5), \fBsmf\fR(5)
123 111 .SH NOTES
124 -.sp
125 -.LP
126 112 The \fBpicld\fR service is managed by the service management facility,
127 113 \fBsmf\fR(5), under the service identifier:
128 114 .sp
129 115 .in +2
130 116 .nf
131 117 svc:/system/picl
132 118 .fi
133 119 .in -2
134 120 .sp
135 121
136 122 .sp
137 123 .LP
138 124 Administrative actions on this service, such as enabling, disabling, or
139 125 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
140 126 status can be queried using the \fBsvcs\fR(1) command.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX