| blob | aedc119be2575fc30394b4a379d10d4ec77de455 |
1 '\" te
2 .\" Copyright 2017 Peter Tribble
3 .\" Copyright 2015 Joyent, Inc.
4 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
5 .\" 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
6 .\" See the License for the specific language governing permissions and limitations under the License. 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
7 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
8 .TH INTRO 3 "Nov 26, 2017"
9 .SH NAME
10 Intro, intro \- introduction to functions and libraries
11 .SH DESCRIPTION
12 .LP
13 This section describes functions found in various Solaris libraries, other than
14 those functions described in Section 2 of this manual that directly invoke UNIX
15 system primitives. Function declarations can be obtained from the
16 \fB#include\fR files indicated on each page. Pages are grouped by library and
17 are identified by the library name (or an abbreviation of the library name)
18 after the section number. Collections of related libraries are grouped into
19 volumes as described below. The first volume contains pages describing the
20 contents of each shared library and each header used by the functions, macros,
21 and external variables described in the remaining volumes.
22 .SS "Library Interfaces and Headers"
23 .LP
24 This volume describes the contents of each shared library and each header used
25 by functions, macros, and external variables described in the remaining
26 volumes.
27 .sp
28 .ne 2
29 .na
30 \fB(3LIB)\fR
31 .ad
32 .sp .6
33 .RS 4n
34 The libraries described in this section are implemented as shared objects.
35 .sp
36 Descriptions of shared objects can include a definition of the global symbols
37 that define the shared objects' public interface, for example \fBSUNW_1.1\fR.
38 Other interfaces can exist within the shared object, for example
39 \fBSUNWprivate.1.1\fR. The public interface provides a stable, committed set of
40 symbols for application development. The private interfaces are for internal
41 use only, and could change at any time.
42 .RE
44 .sp
45 .ne 2
46 .na
47 \fB(3HEAD)\fR
48 .ad
49 .sp .6
50 .RS 4n
51 The headers described in this section are used by functions, macros, and
52 external variables. Headers contain function prototypes, definitions of
53 symbolic constants, common structures, preprocessor macros, and defined types.
54 Each function described in the remaining five volumes specifies the headers
55 that an application must include in order to use that function. In most cases
56 only one header is required. These headers are present on an application
57 development system; they do have to be present on the target execution system.
58 .RE
60 .SS "Basic Library Functions"
61 .LP
62 The functions described in this volume are the core C library functions that
63 are basic to application development.
64 .sp
65 .ne 2
66 .na
67 \fB(3C)\fR
68 .ad
69 .sp .6
70 .RS 4n
71 These functions, together with those of Section 2, constitute the standard C
72 library, \fBlibc\fR, which is automatically linked by the C compilation system.
73 The standard C library is implemented as a shared object, \fBlibc.so\fR. See
74 \fBlibc\fR(3LIB) and the "C Compilation System" chapter of the \fIANSI C
75 Programmer's Guide\fR for a discussion. Some functions behave differently in
76 standard-conforming environments. This behavior is noted on the individual
77 manual pages. See \fBstandards\fR(5).
78 .sp
79 The \fBlibpthread\fR and \fBlibthread\fR libraries are filter libraries on
80 \fBlibc\fR that are used for building multithreaded applications:
81 \fBlibpthread\fR implements the POSIX (see \fBstandards\fR(5)) threads
82 interface, whereas \fBlibthread\fR implements the Solaris threads interface.
83 See \fBMULTITHREADED APPLICATIONS\fR, below.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB(3C_DB)\fR
90 .ad
91 .sp .6
92 .RS 4n
93 These functions constitute the threads debugging library, \fBlibc_db\fR. This
94 library is implemented as a shared object, \fBlibc_db.so\fR, but is not
95 automatically linked by the C compilation system. Specify \fB-lc_db\fR on the
96 \fBcc\fR command line to link with this library. See \fBlibc_db\fR(3LIB).
97 .RE
99 .sp
100 .ne 2
101 .na
102 \fB(3MALLOC)\fR
103 .ad
104 .sp .6
105 .RS 4n
106 These functions constitute the various memory allocation libraries:
107 \fBlibmalloc\fR, \fBlibbsdmalloc\fR, \fBlibmapmalloc\fR, \fBlibmtmalloc\fR, and
108 \fBlibumem\fR. Each of these libraries is implemented as a shared object
109 (\fBlibmalloc.so\fR, \fBlibbsdmalloc.so\fR, \fBlibmapmalloc.so\fR,
110 \fBlibmtmalloc.so\fR, and \fBlibumem.so\fR). These libraries are not
111 automatically linked by the C compilation system. Specify \fB-lmalloc\fR,
112 \fB-lbsdmalloc\fR, \fB-lmapmalloc\fR, \fB-lmtmalloc\fR, and \fB-lumem\fR to
113 link with, respectively, \fBlibmalloc\fR, \fBlibbsdmalloc\fR,
114 \fBlibmapmalloc\fR, \fBlibmtmalloc\fR, and \fBlibumem\fR. See
115 \fBlibmalloc\fR(3LIB), \fBlibbsdmalloc\fR(3LIB), \fBlibmapmalloc\fR(3LIB),
116 \fBlibmtmalloc\fR(3LIB), and \fBlibumem\fR(3LIB).
117 .RE
119 .SS "Networking Library Functions"
120 .LP
121 The functions described in this volume comprise the various networking
122 libraries.
123 .sp
124 .ne 2
125 .na
126 \fB(3COMMPUTIL)\fR
127 .ad
128 .sp .6
129 .RS 4n
130 These functions constitute the communication protocol parser utilities library,
131 \fBlibcommputil\fR. This library is implemented as a shared object,
132 \fBlibcommputil.so\fR, but it is not automatically linked by the C compilation
133 system. Specify \fB-lcommputil\fR on the \fBcc\fR command line to link with
134 this library. See \fBlibcommputil\fR(3LIB).
135 .RE
137 .sp
138 .ne 2
139 .na
140 \fB(3DLPI)\fR
141 .ad
142 .sp .6
143 .RS 4n
144 These functions constitute the data link provider interface library,
145 \fBlibdlpi\fR. This library is implemented as a shared object,
146 \fBlibdlpi.so\fR, but it is not automatically linked by the C compilation
147 system. Specify \fB-ldlpi\fR on the \fBcc\fR command line to link with this
148 library. See \fBlibdlpi\fR(3LIB).
149 .RE
151 .sp
152 .ne 2
153 .na
154 \fB(3DNS_SD)\fR
155 .ad
156 .sp .6
157 .RS 4n
158 These functions constitute the DNS service discovery library, \fBlibdns_sd\fR.
159 This library is implemented as a shared object, \fBlibdns_sd.so\fR, but it is
160 not automatically linked by the C compilation system. Specify \fB-ldns_sd\fR on
161 the \fBcc\fR command line to link with this library. See \fBlibdns_sd\fR(3LIB).
162 .RE
164 .sp
165 .ne 2
166 .na
167 \fB(3GSS)\fR
168 .ad
169 .sp .6
170 .RS 4n
171 These functions constitute the generic security services library. This library
172 is implemented as a shared object, \fBlibgss.so\fR, but it is not automatically
173 linked by the C compilation system. Specify \fB-lgss\fR on the \fBcc\fR command
174 line to link with this library. See \fBlibgss\fR(3LIB).
175 .RE
177 .sp
178 .ne 2
179 .na
180 \fB(3LDAP)\fR
181 .ad
182 .sp .6
183 .RS 4n
184 These functions constitute the lightweight directory access protocol library,
185 \fBlibldap\fR. This library is implemented as a shared object,
186 \fBlibldap.so\fR, but is not automatically linked by the C compilation system.
187 Specify \fB-lldap\fR on the \fBcc\fR command line to link with this library.
188 See \fBldap\fR(3LDAP).
189 .RE
191 .sp
192 .ne 2
193 .na
194 \fB(3RESOLV)\fR
195 .ad
196 .sp .6
197 .RS 4n
198 These functions constitute the resolver library, \fBlibresolv\fR. This library
199 is implemented as a shared object, \fBlibresolv.so\fR, but is not automatically
200 linked by the C compilation system. Specify \fB-lresolv\fR on the \fBcc\fR
201 command line to link with this library. See \fBlibresolv\fR(3LIB).
202 .RE
204 .sp
205 .ne 2
206 .na
207 \fB(3RPC)\fR
208 .ad
209 .sp .6
210 .RS 4n
211 These functions constitute the remote procedure call libraries, \fBlibrpcsvc\fR
212 and \fBlibrpcsoc\fR. The latter is provided for compatibility only; new
213 applications should not link to it. Both libraries are implemented as shared
214 objects, \fBlibrpcsvc.so\fR and \fBlibrpcsoc.so\fR, respectively. Neither
215 library is automatically linked by the C compilation system. Specify
216 \fB-lrpcsvc\fR or \fB-lrpcsoc\fR on the \fBcc\fR command line to link with
217 these libraries. See \fBlibrpcsvc\fR(3LIB).
218 .RE
220 .sp
221 .ne 2
222 .na
223 \fB(3SASL)\fR
224 .ad
225 .sp .6
226 .RS 4n
227 These functions constitute the simple authentication and security layer
228 library, \fBlibsasl\fR. This library is implemented as a shared object,
229 \fBlibsasl.so\fR, but it is not automatically linked by the C compilation
230 system. Specify \fB-lsasl\fR on the \fBcc\fR command line to link with this
231 library. See \fBlibsasl\fR(3LIB).
232 .RE
234 .sp
235 .ne 2
236 .na
237 \fB(3SIP)\fR
238 .ad
239 .sp .6
240 .RS 4n
241 These functions constitute the session initiation protocol library,
242 \fBlibsip\fR. This library is implemented as a shared object, \fBlibsip.so\fR,
243 but it is not automatically linked by the C compilation system. Specify
244 \fB-lsip\fR on the \fBcc\fR command line to link with this library. See
245 \fBlibsip\fR(3LIB).
246 .RE
248 .SS "Curses Library Functions"
249 .LP
250 The functions described in this volume comprise the libraries that provide
251 graphics and character screen updating capabilities.
252 .sp
253 .ne 2
254 .na
255 \fB(3CURSES)\fR
256 .ad
257 .sp .6
258 .RS 4n
259 The functions constitute the following libraries:
260 .sp
261 .ne 2
262 .na
263 \fB\fBlibcurses\fR\fR
264 .ad
265 .sp .6
266 .RS 4n
267 These functions constitute the curses library, \fBlibcurses\fR. This library is
268 implemented as a shared object, \fBlibcurses.so\fR, but is not automatically
269 linked by the C compilation system. Specify \fB-lcurses\fR on the \fBcc\fR
270 command line to link with this library. See \fBlibcurses\fR(3LIB).
271 .RE
273 .sp
274 .ne 2
275 .na
276 \fB\fBlibform\fR\fR
277 .ad
278 .sp .6
279 .RS 4n
280 These functions constitute the forms library, \fBlibform\fR. This library is
281 implemented as a shared object, \fBlibform.so\fR, but is not automatically
282 linked by the C compilation system. Specify \fB-lform\fR on the \fBcc\fR
283 command line to link with this library. See \fBlibform\fR(3LIB).
284 .RE
286 .sp
287 .ne 2
288 .na
289 \fB\fBlibmenu\fR\fR
290 .ad
291 .sp .6
292 .RS 4n
293 These functions constitute the menus library, \fBlibmenu\fR. This library is
294 implemented as a shared object, \fBlibmenu.so\fR, but is not automatically
295 linked by the C compilation system. Specify \fB-lmenu\fR on the \fBcc\fR
296 command line to link with this library. See \fBlibmenu\fR(3LIB).
297 .RE
299 .sp
300 .ne 2
301 .na
302 \fB\fBlibpanel\fR\fR
303 .ad
304 .sp .6
305 .RS 4n
306 These functions constitute the panels library, \fBlibpanel\fR. This library is
307 implemented as a shared object, \fBlibpanel.so\fR, but is not automatically
308 linked by the C compilation system. Specify \fB-lpanel\fR on the \fBcc\fR
309 command line to link with this library. See \fBlibpanel\fR(3LIB).
310 .RE
312 .RE
314 .SS "Extended Library Functions"
315 .LP
316 The functions described in this volume comprise the following specialized
317 libraries:
318 .sp
319 .ne 2
320 .na
321 \fB(3BSM)\fR
322 .ad
323 .sp .6
324 .RS 4n
325 These functions constitute the auditing library, \fBlibbsm\fR. This
326 library is implemented as a shared object, \fBlibbsm.so\fR, but is not
327 automatically linked by the C compilation system. Specify \fB-lbsm\fR on the
328 \fBcc\fR command line to link with this library. See \fBlibbsm\fR(3LIB).
329 .RE
331 .sp
332 .ne 2
333 .na
334 \fB(3CFGADM)\fR
335 .ad
336 .sp .6
337 .RS 4n
338 These functions constitute the configuration administration library,
339 \fBlibcfgadm\fR. This library is implemented as a shared object,
340 \fBlibcfgadm.so\fR, but is not automatically linked by the C compilation
341 system. Specify \fB-lcfgadm\fR on the \fBcc\fR command line to link with this
342 library. See \fBlibcfgadm\fR(3LIB).
343 .RE
345 .sp
346 .ne 2
347 .na
348 \fB(3CONTRACT)\fR
349 .ad
350 .sp .6
351 .RS 4n
352 These functions constitute the contract management library, \fBlibcontract\fR.
353 This library is implemented as a shared object, \fBlibcontract.so\fR, but is
354 not automatically linked by the C compilation system. Specify \fB-lcontract\fR
355 on the \fBcc\fR command line to link with this library. See
356 \fBlibcontract\fR(3LIB).
357 .RE
359 .sp
360 .ne 2
361 .na
362 \fB(3CPC)\fR
363 .ad
364 .sp .6
365 .RS 4n
366 These functions constitute the CPU performance counter library, \fBlibcpc\fR,
367 and the process context library, \fBlibpctx\fR. These libraries are implemented
368 as shared objects, \fBlibcpc.so\fR and \fBlibpctx.so\fR, respectively, but are
369 not automatically linked by the C compilation system. Specify \fB-lcpc\fR or
370 \fB-lpctx\fR on the \fBcc\fR command line to link with these libraries. See
371 \fBlibcpc\fR(3LIB) and \fBlibpctx\fR(3LIB).
372 .RE
374 .sp
375 .ne 2
376 .na
377 \fB(3DAT)\fR
378 .ad
379 .sp .6
380 .RS 4n
381 These functions constitute the direct access transport library, \fBlibdat\fR.
382 This library is implemented as a shared object, \fBlibdat.so\fR, but is not
383 automatically linked by the C compilation system. Specify \fB-ldat\fR on the
384 \fBcc\fR command line to link with this library. See \fBlibdat\fR(3LIB).
385 .RE
387 .sp
388 .ne 2
389 .na
390 \fB(3DEVID)\fR
391 .ad
392 .sp .6
393 .RS 4n
394 These functions constitute the device \fBID\fR library, \fBlibdevid\fR. This
395 library is implemented as a shared object, \fBlibdevid.so\fR, but is not
396 automatically linked by the C compilation system. Specify \fB-ldevid\fR on the
397 \fBcc\fR command line to link with this library. See \fBlibdevid\fR(3LIB).
398 .RE
400 .sp
401 .ne 2
402 .na
403 \fB(3DEVINFO)\fR
404 .ad
405 .sp .6
406 .RS 4n
407 These functions constitute the device information library, \fBlibdevinfo\fR.
408 This library is implemented as a shared object, \fBlibdevinfo.so\fR, but is not
409 automatically linked by the C compilation system. Specify \fB-ldevinfo\fR on
410 the \fBcc\fR command line to link with this library. See
411 \fBlibdevinfo\fR(3LIB).
412 .RE
414 .sp
415 .ne 2
416 .na
417 \fB(3ELF)\fR
418 .ad
419 .sp .6
420 .RS 4n
421 These functions constitute the ELF access library, \fBlibelf\fR, (Extensible
422 Linking Format). This library provides the interface for the creation and
423 analyses of "elf" files; executables, objects, and shared objects. \fBlibelf\fR
424 is implemented as a shared object, \fBlibelf.so\fR, but is not automatically
425 linked by the C compilation system. Specify \fB-lelf\fR on the \fBcc\fR command
426 line to link with this library. See \fBlibelf\fR(3LIB).
427 .RE
429 .sp
430 .ne 2
431 .na
432 \fB(3EXACCT)\fR
433 .ad
434 .sp .6
435 .RS 4n
436 These functions constitute the extended accounting access library,
437 \fBlibexacct\fR, and the project database access library, \fBlibproject\fR.
438 These libraries are implemented as shared objects, \fBlibexacct.so\fR and
439 \fBlibproject.so\fR, respectively, but are not automatically linked by the C
440 compilation system. Specify \fB-lexacct\fR or \fB-lproject\fR on the \fBcc\fR
441 command line to link with these libraries. See \fBlibexacct\fR(3LIB) and
442 \fBlibproject\fR(3LIB).
443 .RE
445 .sp
446 .ne 2
447 .na
448 \fB(3FCOE)\fR
449 .ad
450 .sp .6
451 .RS 4n
452 These functions constitute the Fibre Channel over Ethernet port management
453 library. This library is implemented as a shared object, \fBlibfcoe.so\fR, but
454 is not automatically linked by the C compilation system. Specify \fB-lfcoe\fR
455 on the \fBcc\fR command line to link with this library. See
456 \fBlibfcoe\fR(3LIB).
457 .RE
459 .sp
460 .ne 2
461 .na
462 \fB(3FSTYP)\fR
463 .ad
464 .sp .6
465 .RS 4n
466 These functions constitute the file system type identification library. This
467 library is implemented as a shared object, \fBlibfstyp.so\fR, but is not
468 automatically linked by the C compilation system. Specify \fB-lfstyp\fR on the
469 \fBcc\fR command line to link with this library. See \fBlibfstyp\fR(3LIB).
470 .RE
472 .sp
473 .ne 2
474 .na
475 \fB(3GEN)\fR
476 .ad
477 .sp .6
478 .RS 4n
479 These functions constitute the string pattern-matching and pathname
480 manipulation library, \fBlibgen\fR. This library is implemented as a shared
481 object, \fBlibgen.so\fR, but is not automatically linked by the C compilation
482 system. Specify \fB-lgen\fR on the \fBcc\fR command line to link with this
483 library. See \fBlibgen\fR(3LIB).
484 .RE
486 .sp
487 .ne 2
488 .na
489 \fB(3HBAAPI)\fR
490 .ad
491 .sp .6
492 .RS 4n
493 These functions constitute the common fibre channel HBA information library,
494 \fBlibhbaapi\fR. This library is implemented as a shared object,
495 \fBlibhbaapi.so\fR, but is not automatically linked by the C compilation
496 system. Specify \fB-lhbaapi\fR on the \fBcc\fR command line to link with this
497 library. See \fBlibhbaapi\fR(3LIB).
498 .RE
500 .sp
501 .ne 2
502 .na
503 \fB(3ISCSIT)\fR
504 .ad
505 .sp .6
506 .RS 4n
507 These functions constitute the iSCSI Management library, \fBlibiscsit\fR. This
508 library is implemented as a shared object, \fBlibiscsit.so\fR, but is not
509 automatically linked by the C compilation system. Specify \fB-liscsit\fR on the
510 \fBcc\fR command line to link with this library. See \fBlibiscsit\fR(3LIB).
511 .RE
513 .sp
514 .ne 2
515 .na
516 \fB(3KSTAT)\fR
517 .ad
518 .sp .6
519 .RS 4n
520 These functions constitute the kernel statistics library, which is implemented
521 as a shared object, \fBlibkstat.so\fR, but is not automatically linked by the C
522 compilation system. Specify \fB-lkstat\fR on the \fBcc\fR command line to link
523 with this library. See \fBlibkstat\fR(3LIB).
524 .RE
526 .sp
527 .ne 2
528 .na
529 \fB(3KVM)\fR
530 .ad
531 .sp .6
532 .RS 4n
533 These functions allow access to the kernel's virtual memory library, which is
534 implemented as a shared object, \fBlibkvm.so\fR, but is not automatically
535 linked by the C compilation system. Specify \fB-lkvm\fR on the \fBcc\fR command
536 line to link with this library. See \fBlibkvm\fR(3LIB).
537 .RE
539 .sp
540 .ne 2
541 .na
542 \fB(3LGRP)\fR
543 .ad
544 .sp .6
545 .RS 4n
546 These functions constitute the locality group library, which is implemented as
547 a shared object, \fBliblgrp.so\fR, but is not automatically linked by the C
548 compilation system. Specify \fB-llgrp\fR on the \fBcc\fR command line to link
549 with this library. See \fBliblgrp\fR(3LIB).
550 .RE
552 .sp
553 .ne 2
554 .na
555 \fB(3M)\fR
556 .ad
557 .sp .6
558 .RS 4n
559 These functions constitute the mathematical library, \fBlibm\fR. This library
560 is implemented as a shared object, \fBlibm.so\fR, but is not automatically
561 linked by the C compilation system. Specify \fB-lm\fR on the \fBcc\fR command
562 line to link with this library. See \fBlibm\fR(3LIB).
563 .RE
565 .sp
566 .ne 2
567 .na
568 \fB(3MAIL)\fR
569 .ad
570 .sp .6
571 .RS 4n
572 These functions constitute the user mailbox management library, \fBlibmail\fR.
573 This library is implemented as a shared object, \fBlibmail.so\fR, but is not
574 automatically linked by the C compilation system. Specify \fB-lmail\fR on the
575 \fBcc\fR command line to link with this library. See \fBlibmail\fR(3LIB).
576 .RE
578 .sp
579 .ne 2
580 .na
581 \fB(3MP)\fR
582 .ad
583 .sp .6
584 .RS 4n
585 These functions constitute the integer mathematical library, \fBlibmp\fR. This
586 library is implemented as a shared object, \fBlibmp.so\fR, but is not
587 automatically linked by the C compilation system. Specify \fB-lmp\fR on the
588 \fBcc\fR command line to link with this library. See \fBlibmp\fR(3LIB).
589 .RE
591 .sp
592 .ne 2
593 .na
594 \fB(3MPAPI)\fR
595 .ad
596 .sp .6
597 .RS 4n
598 These functions constitute the Common Multipath Management library,
599 \fBlibMPAPI\fR. This library is implemented as a shared object,
600 \fBlibMPAPI.so\fR, but is not automatically linked by the C compilation system.
601 Specify \fB-lMPAPI\fR on the \fBcc\fR command line to link with this library.
602 See \fBlibMPAPI\fR(3LIB).
603 .RE
605 .sp
606 .ne 2
607 .na
608 \fB(3MVEC)\fR
609 .ad
610 .sp .6
611 .RS 4n
612 These functions constitute the vector mathematical library, \fBlibmvec\fR. This
613 library is implemented as a shared object, \fBlibmvec.so\fR, but is not
614 automatically linked by the C compilation system. Specify \fB-lmvec\fR on the
615 \fBcc\fR command line to link with this library. See \fBlibmvec\fR(3LIB).
616 .RE
618 .sp
619 .ne 2
620 .na
621 \fB(3NVPAIR)\fR
622 .ad
623 .sp .6
624 .RS 4n
625 These functions constitute the name-value pair library, \fBlibnvpair\fR. This
626 library is implemented as a shared object, \fBlibnvpair.so\fR, but is not
627 automatically linked by the C compilation system. Specify \fB-lnvpair\fR on the
628 \fBcc\fR command line to link with this library. See \fBlibnvpair\fR(3LIB).
629 .RE
631 .sp
632 .ne 2
633 .na
634 \fB(3PAM)\fR
635 .ad
636 .sp .6
637 .RS 4n
638 These functions constitute the pluggable authentication module library,
639 \fBlibpam\fR. This library is implemented as a shared object, \fBlibpam.so\fR,
640 but is not automatically linked by the C compilation system. Specify
641 \fB-lpam\fR on the \fBcc\fR command line to link with this library. See
642 \fBlibpam\fR(3LIB).
643 .RE
645 .sp
646 .ne 2
647 .na
648 \fB(3PAPI)\fR
649 .ad
650 .sp .6
651 .RS 4n
652 These functions constitute the Free Standards Group Open Printing API (PAPI)
653 library, \fBlibpapi\fR. This library is implemented as a shared object,
654 \fBlibpapi.so\fR, but is not automatically linked by the C compilation system.
655 Specify \fB-lpapi\fR on the \fBcc\fR command line to link with this library.
656 See \fBlibpapi\fR(3LIB).
657 .RE
659 .sp
660 .ne 2
661 .na
662 \fB(3PICL)\fR
663 .ad
664 .sp .6
665 .RS 4n
666 These functions constitute the PICL library, \fBlibpicl\fR. This library is
667 implemented as a shared object, \fBlibpicl.so\fR, but is not automatically
668 linked by the C compilation system. Specify \fB-lpicl\fR on the \fBcc\fR
669 command line to link with this library. See \fBlibpicl\fR(3LIB) and
670 \fBlibpicl\fR(3PICL).
671 .RE
673 .sp
674 .ne 2
675 .na
676 \fB(3PICLTREE)\fR
677 .ad
678 .sp .6
679 .RS 4n
680 These functions constitute the PICL plug-in library, \fBlibpicltree\fR. This
681 library is implemented as a shared object, \fBlibpicltree.so\fR, but is not
682 automatically linked by the C compilation system. Specify \fB-lpicltree\fR on
683 the \fBcc\fR command line to link with this library. See
684 \fBlibpicltree\fR(3LIB) and \fBlibpicltree\fR(3PICLTREE).
685 .RE
687 .sp
688 .ne 2
689 .na
690 \fB(3POOL)\fR
691 .ad
692 .sp .6
693 .RS 4n
694 These functions constitute the pool configuration manipulation library,
695 \fBlibpool\fR. This library is implemented as a shared object,
696 \fBlibpool.so\fR, but is not automatically linked by the C compilation system.
697 Specify \fB-lpool\fR on the \fBcc\fR command line to link with this library.
698 See \fBlibpool\fR(3LIB).
699 .RE
701 .sp
702 .ne 2
703 .na
704 \fB(3PROC)\fR
705 .ad
706 .sp .6
707 .RS 4n
708 These functions constitute the process manipulation library,
709 \fBlibproc\fR. This library is implemented as a shared object,
710 \fBlibproc.so\fR, but it is not automatically linked by the C compilation
711 system. Specify \fB-lproc\fR on the \fBcc\fR command line to link with this
712 library. See \fBlibproc\fR(3LIB).
713 .RE
715 .sp
716 .ne 2
717 .na
718 \fB(3PROJECT)\fR
719 .ad
720 .sp .6
721 .RS 4n
722 These functions constitute the project database access library,
723 \fBlibproject\fR. This library is implemented as a shared object,
724 \fBlibproject.so\fR, but is not automatically linked by the C compilation
725 system. Specify \fB-lproject\fR on the \fBcc\fR command line to link with this
726 library. See \fBlibproject\fR(3LIB).
727 .RE
729 .sp
730 .ne 2
731 .na
732 \fB(3RSM)\fR
733 .ad
734 .sp .6
735 .RS 4n
736 These functions constitute the remote shared memory library, \fBlibrsm\fR. This
737 library is implemented as a shared object, \fBlibrsm.so\fR, but is not
738 automatically linked by the C compilation system. Specify \fB-lrsm\fR on the
739 \fBcc\fR command line to link with this library. See \fBlibrsm\fR(3LIB).
740 .RE
742 .sp
743 .ne 2
744 .na
745 \fB(3SCF)\fR
746 .ad
747 .sp .6
748 .RS 4n
749 These functions constitute the object-caching memory allocation library,
750 \fBlibscf\fR. This library is implemented as a shared object, \fBlibscf.so\fR,
751 but is not automatically linked by the C compilation system. Specify
752 \fB-lscf\fR on the \fBcc\fR command line to link with this library. See
753 \fBlibscf\fR(3LIB).
754 .RE
756 .sp
757 .ne 2
758 .na
759 \fB(3SEC)\fR
760 .ad
761 .sp .6
762 .RS 4n
763 These functions constitute the file access control library, \fBlibsec\fR. This
764 library is implemented as a shared object, \fBlibsec.so\fR, but is not
765 automatically linked by the C compilation system. Specify \fB-lsec\fR on the
766 \fBcc\fR command line to link with this library. See \fBlibsec\fR(3LIB).
767 .RE
769 .sp
770 .ne 2
771 .na
772 \fB(3SECDB)\fR
773 .ad
774 .sp .6
775 .RS 4n
776 These functions constitute the security attributes database library,
777 \fBlibsecdb\fR. This library is implemented as a shared object,
778 \fBlibsecdb.so\fR, but is not automatically linked by the C compilation system.
779 Specify \fB-lsecdb\fR on the \fBcc\fR command line to link with this library.
780 See \fBlibsecdb\fR(3LIB).
781 .RE
783 .sp
784 .ne 2
785 .na
786 \fB(3STMF)\fR
787 .ad
788 .sp .6
789 .RS 4n
790 These functions constitute the SCSI Target Mode Framework library,
791 \fBlibstmf\fR. This library is implemented as a shared object,
792 \fBlibstmf.so\fR, but is not automatically linked by the C compilation system.
793 Specify \fB-lstmf\fR on the \fBcc\fR command line to link with this library.
794 See \fBlibstmf\fR(3LIB).
795 .RE
797 .sp
798 .ne 2
799 .na
800 \fB(3SYSEVENT)\fR
801 .ad
802 .sp .6
803 .RS 4n
804 These functions constitute the system event library, \fBlibsysevent\fR. This
805 library is implemented as a shared object, \fBlibsysevent.so\fR, but is not
806 automatically linked by the C compilation system. Specify \fB-lsysevent\fR on
807 the \fBcc\fR command line to link with this library. See
808 \fBlibsysevent\fR(3LIB).
809 .RE
811 .sp
812 .ne 2
813 .na
814 \fB(3TECLA)\fR
815 .ad
816 .sp .6
817 .RS 4n
818 These functions constitute the interactive command-line input library,
819 \fBlibtecla\fR. This library is implemented as a shared object,
820 \fBlibtecla.so\fR, but is not automatically linked by the C compilation system.
821 Specify \fB-ltecla\fR on the \fBcc\fR command line to link with this library.
822 See \fBlibtecla\fR(3LIB).
823 .RE
825 .sp
826 .ne 2
827 .na
828 \fB(3UUID)\fR
829 .ad
830 .sp .6
831 .RS 4n
832 These functions constitute the universally unique identifier library,
833 \fBlibuuid\fR. This library is implemented as a shared object,
834 \fBlibuuid.so\fR, but is not automatically linked by the C compilation system.
835 Specify \fB-luuid\fR on the \fBcc\fR command line to link with this library.
836 See \fBlibuuid\fR(3LIB).
837 .RE
839 .sp
840 .ne 2
841 .na
842 \fB(3VOLMGT)\fR
843 .ad
844 .sp .6
845 .RS 4n
846 These functions constitute the volume management library, \fBlibvolmgt\fR. This
847 library is implemented as a shared object, \fBlibvolmgt.so\fR, but is not
848 automatically linked by the C compilation system. Specify \fB-lvolmgt\fR on the
849 \fBcc\fR command line to link with this library. See \fBlibvolmgt\fR(3LIB).
850 .RE
852 .SH DEFINITIONS
853 .LP
854 A character is any bit pattern able to fit into a byte on the machine. In some
855 international languages, however, a "character" might require more than one
856 byte, and is represented in multi-bytes.
857 .sp
858 .LP
859 The null character is a character with value 0, conventionally represented in
860 the C language as \fB\e\|0\fR\&. A character array is a sequence of characters.
861 A null-terminated character array (a \fIstring\fR) is a sequence of characters,
862 the last of which is the null character. The null string is a character array
863 containing only the terminating null character. A null pointer is the value
864 that is obtained by casting \fB0\fR into a pointer. C guarantees that this
865 value will not match that of any legitimate pointer, so many functions that
866 return pointers return \fINULL\fR to indicate an error. The macro \fINULL\fR is
867 defined in <\fBstdio.h\fR>. Types of the form \fBsize_t\fR are defined in the
868 appropriate headers.
869 .SH MULTITHREADED APPLICATIONS
870 .LP
871 Both POSIX threads and Solaris threads can be used within the same application.
872 Their implementations are completely compatible with each other; however, only
873 POSIX threads guarantee portability to other POSIX-conforming environments.
874 .sp
875 .LP
876 The \fBlibpthread\fR(3LIB) and \fBlibthread\fR(3LIB) libraries are implemented
877 as filters on \fBlibc\fR(3LIB).
878 .sp
879 .LP
880 When compiling a multithreaded application, the \fB-mt\fR option must be
881 specified on the command line.
882 .sp
883 .LP
884 There is no need for a multithreaded application to link with \fB-lthread\fR.
885 An application must link with \fB-lpthread\fR only when POSIX semantics for
886 \fBfork\fR(2) are desired. When an application is linked with \fB-lpthread\fR,
887 a call to \fBfork()\fR assumes the behavior \fBfork1\fR(2) rather than the
888 default behavior that forks all threads.
889 .sp
890 .LP
891 When compiling a POSIX-conforming application, either the \fB_POSIX_C_SOURCE\fR
892 or \fB_POSIX_PTHREAD_SEMANTICS\fR option must be specified on the command line.
893 For POSIX.1c-conforming applications, define the \fB_POSIX_C_SOURCE\fR flag to
894 be >= 199506L:
895 .sp
896 .in +2
897 .nf
898 \fBcc\fR \fB-mt\fR [ \fIflag\fR... ] \fIfile\fR... \fB-D_POSIX_C_SOURCE=199506L\fR \fB-lpthread\fR
899 .fi
900 .in -2
902 .sp
903 .LP
904 For POSIX behavior with the Solaris \fBfork()\fR and \fBfork1()\fR distinction,
905 compile as follows:
906 .sp
907 .in +2
908 .nf
909 \fBcc\fR \fB-mt\fR [ \fIflag\fR... ] \fIfile\fR... \fB-D_POSIX_PTHREAD_SEMANTICS\fR
910 .fi
911 .in -2
913 .sp
914 .LP
915 For Solaris threads behavior, compile as follows:
916 .sp
917 .in +2
918 .nf
919 \fBcc\fR \fB-mt\fR [ \fIflag\fR... ] \fIfile\fR...
920 .fi
921 .in -2
923 .sp
924 .LP
925 Unsafe interfaces should be called only from the main thread to ensure the
926 application's safety.
927 .sp
928 .LP
929 MT-Safe interfaces are denoted in the \fBATTRIBUTES\fR section of the functions
930 and libraries manual pages (see \fBattributes\fR(5)). If a manual page does not
931 state explicitly that an interface is MT-Safe, the user should assume that the
932 interface is unsafe.
933 .SH REALTIME APPLICATIONS
934 .LP
935 The environment variable \fBLD_BIND_NOW\fR must be set to a non-null value to
936 enable early binding. Refer to the "When Relocations are Processed" chapter in
937 \fILinker and Libraries Guide\fR for additional information.
938 .SH FILES
939 .ne 2
940 .na
941 \fB\fIINCDIR\fR\fR
942 .ad
943 .RS 15n
944 usually \fB/usr/include\fR
945 .RE
947 .sp
948 .ne 2
949 .na
950 \fB\fILIBDIR\fR\fR
951 .ad
952 .RS 15n
953 usually either \fB/lib\fR or \fB/usr/lib\fR (32-bit) or either \fB/lib/64\fR or
954 \fB/usr/lib/64\fR (64-bit)
955 .RE
957 .sp
958 .ne 2
959 .na
960 \fB\fILIBDIR\fR\fB/*.so\fR\fR
961 .ad
962 .RS 15n
963 shared libraries
964 .RE
966 .SH ACKNOWLEDGMENTS
967 .LP
968 Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to
969 reproduce portions of its copyrighted documentation. Original documentation
970 from The Open Group can be obtained online at
971 http://www.opengroup.org/bookstore/\&.
972 .sp
973 .LP
974 The Institute of Electrical and Electronics Engineers and The Open Group, have
975 given us permission to reprint portions of their documentation.
976 .sp
977 .LP
978 In the following statement, the phrase ``this text'' refers to portions of the
979 system documentation.
980 .sp
981 .LP
982 Portions of this text are reprinted and reproduced in electronic form in the
983 SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for
984 Information Technology -- Portable Operating System Interface (POSIX), The Open
985 Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
986 Electrical and Electronics Engineers, Inc and The Open Group. In the event of
987 any discrepancy between these versions and the original IEEE and The Open Group
988 Standard, the original IEEE and The Open Group Standard is the referee
989 document. The original Standard can be obtained online at
990 http://www.opengroup.org/unix/online.html\&.
991 .sp
992 .LP
993 This notice shall appear on any product containing this material.
994 .SH SEE ALSO
995 .LP
996 \fBar\fR(1), \fBld\fR(1), \fBfork\fR(2), \fBstdio\fR(3C), \fBattributes\fR(5),
997 \fBstandards\fR(5)
998 .sp
999 .LP
1000 \fILinker and Libraries Guide\fR
1001 .sp
1002 .LP
1003 \fIPerformance Profiling Tools\fR
1004 .sp
1005 .LP
1006 \fIANSI C Programmer's Guide\fR
1007 .SH DIAGNOSTICS
1008 .LP
1009 For functions that return floating-point values, error handling varies
1010 according to compilation mode. Under the \fB-Xt\fR (default) option to
1011 \fBcc\fR, these functions return the conventional values \fB0\fR,
1012 \fB\(+-HUGE\fR, or \fBNaN\fR when the function is undefined for the given
1013 arguments or when the value is not representable. In the \fB-Xa\fR and
1014 \fB-Xc\fR compilation modes, \fB\(+-HUGE_VAL\fR is returned instead of
1015 \fB\(+-HUGE\fR\&. (\fBHUGE_VAL\fR and \fBHUGE\fR are defined in \fBmath.h\fR to
1016 be infinity and the largest-magnitude single-precision number, respectively.)
1017 .SH NOTES
1018 .LP
1019 None of the functions, external variables, or macros should be redefined in the
1020 user's programs. Any other name can be redefined without affecting the behavior
1021 of other library functions, but such redefinition might conflict with a
1022 declaration in an included header.
1023 .sp
1024 .LP
1025 The headers in \fIINCDIR\fR provide function prototypes (function declarations
1026 including the types of arguments) for most of the functions listed in this
1027 manual. Function prototypes allow the compiler to check for correct usage of
1028 these functions in the user's program. The \fBlint\fR program checker can also
1029 be used and will report discrepancies even if the headers are not included with
1030 \fB#include\fR statements. Definitions for Sections 2 and 3C are checked
1031 automatically. Other definitions can be included by using the \fB-l\fR option
1032 to \fBlint\fR. (For example, \fB-lm\fR includes definitions for \fBlibm\fR.)
1033 Use of \fBlint\fR is highly recommended. See the \fBlint\fR chapter in
1034 \fIPerformance Profiling Tools\fR
1035 .sp
1036 .LP
1037 Users should carefully note the difference between STREAMS and \fIstream\fR.
1038 STREAMS is a set of kernel mechanisms that support the development of network
1039 services and data communication drivers. It is composed of utility routines,
1040 kernel facilities, and a set of data structures. A \fIstream\fR is a file with
1041 its associated buffering. It is declared to be a pointer to a type \fBFILE\fR
1042 defined in \fB<stdio.h>\fR.
1043 .sp
1044 .LP
1045 In detailed definitions of components, it is sometimes necessary to refer to
1046 symbolic names that are implementation-specific, but which are not necessarily
1047 expected to be accessible to an application program. Many of these symbolic
1048 names describe boundary conditions and system limits.
1049 .sp
1050 .LP
1051 In this section, for readability, these implementation-specific values are
1052 given symbolic names. These names always appear enclosed in curly brackets to
1053 distinguish them from symbolic names of other implementation-specific constants
1054 that are accessible to application programs by headers. These names are not
1055 necessarily accessible to an application program through a header, although
1056 they can be defined in the documentation for a particular system.
1057 .sp
1058 .LP
1059 In general, a portable application program should not refer to these symbolic
1060 names in its code. For example, an application program would not be expected to
1061 test the length of an argument list given to a routine to determine if it was
1062 greater than {\fBARG_MAX\fR}.