1502 Remove conversion cruft from manpages
[unleashed.git] / usr / src / man / man3lib / libcommputil.3lib
blob21e7d6d5642a56692f83cd02d5b12962367f47c6
1 '\" te
2 .\" Copyright (c) 2007, 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 LIBCOMMPUTIL 3LIB "Oct 12, 2007"
7 .SH NAME
8 libcommputil \- communication protocol parser utilities library
9 .SH SYNOPSIS
10 .LP
11 .nf
12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lcommputil\fR [ \fIlibrary\fR... ]
13 #include <\fBsdp.h\fR>
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 The communication protocol parser utilities library is a placeholder for public
20 interfaces that facilitate parsing of various communication protocols.
21 Functions in this library parse the SDP (Session Description Protocol)
22 description, check for syntax conformance, and generate SDP descriptions.
23 .sp
24 .LP
25 SDP (Session Description Protocol), described in RFC 4566, describes multimedia
26 sessions for the purposes of session announcement, session invitation, and
27 other forms of multimedia session initiation.  SDP is used to convey session
28 information in Session Initiation Protocol (SIP), Streaming Media (Real Time
29 Streaming Protocol, RTSP), email, and World Wide Web and Multicast Session
30 Announcement.
31 .SH INTERFACES
32 .sp
33 .LP
34 The shared object \fBlibcommputil.so.1\fR provides the public interfaces
35 defined below. See \fBIntro\fR(3) for additional information on shared object
36 interfaces.
37 .sp
39 .sp
40 .TS
41 l l
42 l l .
43 \fBsdp_add_attribute\fR \fBsdp_add_bandwidth\fR
44 \fBsdp_add_connection\fR        \fBsdp_add_email\fR
45 \fBsdp_add_information\fR       \fBsdp_add_key\fR
46 \fBsdp_add_media\fR     \fBsdp_add_name\fR
47 \fBsdp_add_origin\fR    \fBsdp_add_phone\fR
48 \fBsdp_add_repeat\fR    \fBsdp_add_time\fR
49 \fBsdp_add_uri\fR       \fBsdp_add_zone\fR
50 \fBsdp_clone_session\fR \fBsdp_delete_attribute\fR
51 \fBsdp_delete_field\fR  \fBsdp_delete_media\fR
52 \fBsdp_delete_media_field\fR    \fBsdp_find_attribute\fR
53 \fBsdp_find_media\fR    \fBsdp_find_media_rtpmap\fR
54 \fBsdp_free_session\fR  \fBsdp_new_session\fR
55 \fBsdp_parse\fR \fBsdp_session_to_str\fR
56 .TE
58 .SH FILES
59 .sp
60 .ne 2
61 .na
62 \fB\fB/lib/libcommputil.so.1\fR\fR
63 .ad
64 .RS 29n
65 shared object.
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fB/lib/64/libcommputil.so.1\fR\fR
72 .ad
73 .RS 29n
74 64-bit shared object.
75 .RE
77 .SH ATTRIBUTES
78 .sp
79 .LP
80 See \fBattributes\fR(5) for description of the following attributes:
81 .sp
83 .sp
84 .TS
85 box;
86 c | c
87 l | l .
88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
90 Interface Stability     Committed
92 MT-Level        Safe
93 .TE
95 .SH SEE ALSO
96 .sp
97 .LP
98 \fBIntro\fR(3), \fBattributes\fR(5)