1 '\" te
2 .\" Copyright (c) 2006, 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 LIBPAPI 3LIB "Dec 18, 2006"
7 .SH NAME
8 libpapi \- Free Standards Group Open Printing API (PAPI) library functions
9 .SH SYNOPSIS
10 .LP
11 .nf
12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpapi\fR [ \fIlibrary\fR\&.\|.\|. ]
13 #include <papi.h>
14 .fi
15
16 .SH DESCRIPTION
17 .sp
18 .LP
19 Functions in this library provide an interface for interaction with print
20 services as described in v1.0 of the Free Standards Group (FSG) Open Printing
21 API (PAPI).
22 .sp
23 .LP
24 This particular implementation of the PAPI includes naming support as described
25 in the \fBprinters.conf\fR(4) and \fBprinters\fR(4) manual pages. It also
26 supplies support for interaction with local LP services, remote LPD services,
27 and remote IPP services through the use of loadable modules that export the
28 same interface. These modules should not be linked with directly, but can be
29 used directly at runtime through the use of \fBLD_PRELOAD\fR for debugging
30 purposes.
31 .SH INTERFACES
32 .sp
33 .LP
34 The shared object \fBlibpapi.so.0\fR provides the public interfaces defined
35 below. See \fBIntro\fR(3) for additional information on shared object
36 interfaces.
37 .SS "Attribute"
38 .sp
39
40 .sp
41 .TS
42 l l
43 l l .
44 \fBpapiAttributeListAddBoolean\fR \fBpapiAttributeListAddCollection\fR
45 \fBpapiAttributeListAddDatetime\fR \fBpapiAttributeListAddInteger\fR
46 \fBpapiAttributeListAddMetadata\fR \fBpapiAttributeListAddRange\fR
47 \fBpapiAttributeListAddResolution\fR \fBpapiAttributeListAddString\fR
48 \fBpapiAttributeListAddValue\fR \fBpapiAttributeListDelete\fR
49 \fBpapiAttributeListFind\fR \fBpapiAttributeListFree\fR
50 \fBpapiAttributeListFromString\fR \fBpapiAttributeListGetBoolean\fR
51 \fBpapiAttributeListGetCollection\fR \fBpapiAttributeListGetDatetime\fR
52 \fBpapiAttributeListGetInteger\fR \fBpapiAttributeListGetMetadata\fR
53 \fBpapiAttributeListGetNext\fR \fBpapiAttributeListGetRange\fR
54 \fBpapiAttributeListGetResolution\fR \fBpapiAttributeListGetString\fR
55 \fBpapiAttributeListGetValue\fR \fBpapiAttributeListToString\fR
56 .TE
57
58 .SS "Service"
59 .sp
60
61 .sp
62 .TS
63 l l
64 l l .
65 \fBpapiServiceCreate\fR \fBpapiServiceDestroy\fR
66 \fBpapiServiceGetAppData\fR \fBpapiServiceGetAttributeList\fR
67 \fBpapiServiceGetEncryption\fR \fBpapiServiceGetPassword\fR
68 \fBpapiServiceGetServiceName\fR \fBpapiServiceGetStatusMessage\fR
69 \fBpapiServiceGetUserName\fR \fBpapiServiceSetAppData\fR
70 \fBpapiServiceSetAuthCB\fR \fBpapiServiceSetEncryption\fR
71 \fBpapiServiceSetPassword\fR \fBpapiServiceSetUserName\fR
72 .TE
73
74 .SS "Printer"
75 .sp
76
77 .sp
78 .TS
79 l l
80 l l .
81 \fBpapiPrinterAdd\fR \fBpapiPrinterDisable\fR
82 \fBpapiPrinterEnable\fR \fBpapiPrinterFree\fR
83 \fBpapiPrinterGetAttributeList\fR \fBpapiPrinterListFree\fR
84 \fBpapiPrinterListJobs\fR \fBpapiPrinterModify\fR
85 \fBpapiPrinterPause\fR \fBpapiPrinterPurgeJobs\fR
86 \fBpapiPrinterQuery\fR \fBpapiPrinterRemove\fR
87 \fBpapiPrinterResume\fR \fBpapiPrintersList\fR
88 .TE
89
90 .SS "Job"
91 .sp
92
93 .sp
94 .TS
95 l l
96 l l .
97 \fBpapiJobCancel\fR \fBpapiJobFree\fR
98 \fBpapiJobGetAttributeList\fR \fBpapiJobGetId\fR
99 \fBpapiJobGetJobTicket\fR \fBpapiJobGetPrinterName\fR
100 \fBpapiJobHold\fR \fBpapiJobListFree\fR
101 \fBpapiJobModify\fR \fBpapiJobMove\fR
102 \fBpapiJobPromote\fR \fBpapiJobQuery\fR
103 \fBpapiJobRelease\fR \fBpapiJobRestart\fR
104 \fBpapiJobStreamClose\fR \fBpapiJobStreamOpen\fR
105 \fBpapiJobStreamWrite\fR \fBpapiJobSubmit\fR
106 \fBpapiJobSubmitByReference\fR \fBpapiJobValidate\fR
107 .TE
108
109 .SS "Miscellaneous"
110 .sp
111
112 .sp
113 .TS
114 l l
115 l l .
116 \fBpapiLibrarySupportedCall\fR \fBpapiLibrarySupportedCalls\fR
117 \fBpapiStatusString\fR
118 .TE
119
120 .SH FILES
121 .sp
122 .ne 2
123 .na
124 \fB\fB/usr/lib/libpapi.so.0\fR\fR
125 .ad
126 .sp .6
127 .RS 4n
128 shared object
129 .RE
130
131 .sp
132 .ne 2
133 .na
134 \fB\fB/usr/lib/libpapi-common.so.0\fR\fR
135 .ad
136 .sp .6
137 .RS 4n
138 private shared code
139 .RE
140
141 .sp
142 .ne 2
143 .na
144 \fB\fB/usr/lib/print/psm-lpd.so\fR\fR
145 .ad
146 .sp .6
147 .RS 4n
148 private rfc1179 support
149 .RE
150
151 .sp
152 .ne 2
153 .na
154 \fB\fB/usr/lib/print/psm-lpsched.so\fR\fR
155 .ad
156 .sp .6
157 .RS 4n
158 private LP support
159 .RE
160
161 .sp
162 .ne 2
163 .na
164 \fB\fB/usr/lib/print/psm-ipp.so\fR\fR
165 .ad
166 .sp .6
167 .RS 4n
168 private IPP support
169 .RE
170
171 .sp
172 .ne 2
173 .na
174 \fB\fB/usr/lib/libipp-core.so\fR\fR
175 .ad
176 .sp .6
177 .RS 4n
178 private IPP marshalling support
179 .RE
180
181 .sp
182 .ne 2
183 .na
184 \fB\fB/usr/lib/libipp-listener.so\fR\fR
185 .ad
186 .sp .6
187 .RS 4n
188 private IPP operations support
189 .RE
190
191 .sp
192 .ne 2
193 .na
194 \fB\fB/usr/lip/libhttp-core.so\fR\fR
195 .ad
196 .sp .6
197 .RS 4n
198 private HTTP support
199 .RE
200
201 .SH ATTRIBUTES
202 .sp
203 .LP
204 See \fBattributes\fR(5) for descriptions of the following attributes:
205 .sp
206
207 .sp
208 .TS
209 box;
210 c | c
211 l | l .
212 ATTRIBUTE TYPE ATTRIBUTE VALUE
213 _
214 Interface Stability Volatile
215 _
216 MT-Level Safe
217 .TE
218
219 .SH SEE ALSO
220 .sp
221 .LP
222 \fBIntro\fR(3), \fBprinters\fR(4), \fBprinters.conf\fR(4), \fBattributes\fR(5)
|
1 '\" te
2 .\" Copyright (c) 2006, 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 LIBPAPI 3LIB "Aug 19, 2019"
7 .SH NAME
8 libpapi \- Free Standards Group Open Printing API (PAPI) library functions
9 .SH SYNOPSIS
10 .nf
11 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lpapi\fR [ \fIlibrary\fR... ]
12 #include <papi.h>
13 .fi
14
15 .SH DESCRIPTION
16 Functions in this library provide an interface for interaction with print
17 services as described in v1.0 of the Free Standards Group (FSG) Open Printing
18 API (PAPI).
19 .sp
20 .LP
21 This particular implementation of the PAPI includes naming support as described
22 in the \fBprinters.conf\fR(4) and \fBprinters\fR(4) manual pages. It also
23 supplies support for interaction with local LP services, remote LPD services,
24 and remote IPP services through the use of loadable modules that export the
25 same interface. These modules should not be linked with directly, but can be
26 used directly at runtime through the use of \fBLD_PRELOAD\fR for debugging
27 purposes.
28 .SH INTERFACES
29 The shared object \fBlibpapi.so.0\fR provides the public interfaces defined
30 below. See \fBIntro\fR(3) for additional information on shared object
31 interfaces.
32 .SS "Attribute"
33 .TS
34 l l
35 l l .
36 \fBpapiAttributeListAddBoolean\fR \fBpapiAttributeListAddCollection\fR
37 \fBpapiAttributeListAddDatetime\fR \fBpapiAttributeListAddInteger\fR
38 \fBpapiAttributeListAddMetadata\fR \fBpapiAttributeListAddRange\fR
39 \fBpapiAttributeListAddResolution\fR \fBpapiAttributeListAddString\fR
40 \fBpapiAttributeListAddValue\fR \fBpapiAttributeListDelete\fR
41 \fBpapiAttributeListFind\fR \fBpapiAttributeListFree\fR
42 \fBpapiAttributeListFromString\fR \fBpapiAttributeListGetBoolean\fR
43 \fBpapiAttributeListGetCollection\fR \fBpapiAttributeListGetDatetime\fR
44 \fBpapiAttributeListGetInteger\fR \fBpapiAttributeListGetMetadata\fR
45 \fBpapiAttributeListGetNext\fR \fBpapiAttributeListGetRange\fR
46 \fBpapiAttributeListGetResolution\fR \fBpapiAttributeListGetString\fR
47 \fBpapiAttributeListGetValue\fR \fBpapiAttributeListToString\fR
48 .TE
49
50 .SS "Service"
51 .TS
52 l l
53 l l .
54 \fBpapiServiceCreate\fR \fBpapiServiceDestroy\fR
55 \fBpapiServiceGetAppData\fR \fBpapiServiceGetAttributeList\fR
56 \fBpapiServiceGetEncryption\fR \fBpapiServiceGetPassword\fR
57 \fBpapiServiceGetServiceName\fR \fBpapiServiceGetStatusMessage\fR
58 \fBpapiServiceGetUserName\fR \fBpapiServiceSetAppData\fR
59 \fBpapiServiceSetAuthCB\fR \fBpapiServiceSetEncryption\fR
60 \fBpapiServiceSetPassword\fR \fBpapiServiceSetUserName\fR
61 .TE
62
63 .SS "Printer"
64 .TS
65 l l
66 l l .
67 \fBpapiPrinterAdd\fR \fBpapiPrinterDisable\fR
68 \fBpapiPrinterEnable\fR \fBpapiPrinterFree\fR
69 \fBpapiPrinterGetAttributeList\fR \fBpapiPrinterListFree\fR
70 \fBpapiPrinterListJobs\fR \fBpapiPrinterModify\fR
71 \fBpapiPrinterPause\fR \fBpapiPrinterPurgeJobs\fR
72 \fBpapiPrinterQuery\fR \fBpapiPrinterRemove\fR
73 \fBpapiPrinterResume\fR \fBpapiPrintersList\fR
74 .TE
75
76 .SS "Job"
77 .TS
78 l l
79 l l .
80 \fBpapiJobCancel\fR \fBpapiJobFree\fR
81 \fBpapiJobGetAttributeList\fR \fBpapiJobGetId\fR
82 \fBpapiJobGetJobTicket\fR \fBpapiJobGetPrinterName\fR
83 \fBpapiJobHold\fR \fBpapiJobListFree\fR
84 \fBpapiJobModify\fR \fBpapiJobMove\fR
85 \fBpapiJobPromote\fR \fBpapiJobQuery\fR
86 \fBpapiJobRelease\fR \fBpapiJobRestart\fR
87 \fBpapiJobStreamClose\fR \fBpapiJobStreamOpen\fR
88 \fBpapiJobStreamWrite\fR \fBpapiJobSubmit\fR
89 \fBpapiJobSubmitByReference\fR \fBpapiJobValidate\fR
90 .TE
91
92 .SS "Miscellaneous"
93 .TS
94 l l
95 l l .
96 \fBpapiLibrarySupportedCall\fR \fBpapiLibrarySupportedCalls\fR
97 \fBpapiStatusString\fR
98 .TE
99
100 .SH FILES
101 .ne 2
102 .na
103 \fB/usr/lib/libpapi.so.0\fR
104 .ad
105 .sp .6
106 .RS 4n
107 shared object
108 .RE
109
110 .sp
111 .ne 2
112 .na
113 \fB/usr/lib/libpapi-common.so.0\fR
114 .ad
115 .sp .6
116 .RS 4n
117 private shared code
118 .RE
119
120 .sp
121 .ne 2
122 .na
123 \fB/usr/lib/print/psm-lpd.so\fR
124 .ad
125 .sp .6
126 .RS 4n
127 private rfc1179 support
128 .RE
129
130 .sp
131 .ne 2
132 .na
133 \fB/usr/lib/print/psm-lpsched.so\fR
134 .ad
135 .sp .6
136 .RS 4n
137 private LP support
138 .RE
139
140 .sp
141 .ne 2
142 .na
143 \fB/usr/lib/print/psm-ipp.so\fR
144 .ad
145 .sp .6
146 .RS 4n
147 private IPP support
148 .RE
149
150 .sp
151 .ne 2
152 .na
153 \fB/usr/lib/libipp-core.so\fR
154 .ad
155 .sp .6
156 .RS 4n
157 private IPP marshalling support
158 .RE
159
160 .sp
161 .ne 2
162 .na
163 \fB/usr/lib/libipp-listener.so\fR
164 .ad
165 .sp .6
166 .RS 4n
167 private IPP operations support
168 .RE
169
170 .sp
171 .ne 2
172 .na
173 \fB/usr/lip/libhttp-core.so\fR
174 .ad
175 .sp .6
176 .RS 4n
177 private HTTP support
178 .RE
179
180 .SH ATTRIBUTES
181 See \fBattributes\fR(5) for descriptions of the following attributes:
182 .sp
183
184 .sp
185 .TS
186 box;
187 c | c
188 l | l .
189 ATTRIBUTE TYPE ATTRIBUTE VALUE
190 _
191 Interface Stability Volatile
192 _
193 MT-Level Safe
194 .TE
195
196 .SH SEE ALSO
197 \fBIntro\fR(3), \fBprinters\fR(4), \fBprinters.conf\fR(4), \fBattributes\fR(5)
|