~ubuntu-branches/ubuntu/edgy/rpm/edgy

« back to all changes in this revision

Viewing changes to Perl-RPM/blib/man3/RPM.3pm

  • Committer: Bazaar Package Importer
  • Author(s): Joey Hess
  • Date: 2002-01-22 20:56:57 UTC
  • Revision ID: james.westby@ubuntu.com-20020122205657-l74j50mr9z8ofcl5
Tags: upstream-4.0.3
ImportĀ upstreamĀ versionĀ 4.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Automatically generated by Pod::Man version 1.02
 
2
.\" Sat Jul 21 11:16:32 2001
 
3
.\"
 
4
.\" Standard preamble:
 
5
.\" ======================================================================
 
6
.de Sh \" Subsection heading
 
7
.br
 
8
.if t .Sp
 
9
.ne 5
 
10
.PP
 
11
\fB\\$1\fR
 
12
.PP
 
13
..
 
14
.de Sp \" Vertical space (when we can't use .PP)
 
15
.if t .sp .5v
 
16
.if n .sp
 
17
..
 
18
.de Ip \" List item
 
19
.br
 
20
.ie \\n(.$>=3 .ne \\$3
 
21
.el .ne 3
 
22
.IP "\\$1" \\$2
 
23
..
 
24
.de Vb \" Begin verbatim text
 
25
.ft CW
 
26
.nf
 
27
.ne \\$1
 
28
..
 
29
.de Ve \" End verbatim text
 
30
.ft R
 
31
 
 
32
.fi
 
33
..
 
34
.\" Set up some character translations and predefined strings.  \*(-- will
 
35
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 
36
.\" double quote, and \*(R" will give a right double quote.  | will give a
 
37
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
 
38
.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
 
39
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
 
40
.tr \(*W-|\(bv\*(Tr
 
41
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 
42
.ie n \{\
 
43
.    ds -- \(*W-
 
44
.    ds PI pi
 
45
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 
46
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 
47
.    ds L" ""
 
48
.    ds R" ""
 
49
.    ds C` `
 
50
.    ds C' '
 
51
'br\}
 
52
.el\{\
 
53
.    ds -- \|\(em\|
 
54
.    ds PI \(*p
 
55
.    ds L" ``
 
56
.    ds R" ''
 
57
'br\}
 
58
.\"
 
59
.\" If the F register is turned on, we'll generate index entries on stderr
 
60
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
 
61
.\" index entries marked with X<> in POD.  Of course, you'll have to process
 
62
.\" the output yourself in some meaningful fashion.
 
63
.if \nF \{\
 
64
.    de IX
 
65
.    tm Index:\\$1\t\\n%\t"\\$2"
 
66
.    .
 
67
.    nr % 0
 
68
.    rr F
 
69
.\}
 
70
.\"
 
71
.\" For nroff, turn off justification.  Always turn off hyphenation; it
 
72
.\" makes way too many mistakes in technical documents.
 
73
.hy 0
 
74
.if n .na
 
75
.\"
 
76
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 
77
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 
78
.bd B 3
 
79
.    \" fudge factors for nroff and troff
 
80
.if n \{\
 
81
.    ds #H 0
 
82
.    ds #V .8m
 
83
.    ds #F .3m
 
84
.    ds #[ \f1
 
85
.    ds #] \fP
 
86
.\}
 
87
.if t \{\
 
88
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 
89
.    ds #V .6m
 
90
.    ds #F 0
 
91
.    ds #[ \&
 
92
.    ds #] \&
 
93
.\}
 
94
.    \" simple accents for nroff and troff
 
95
.if n \{\
 
96
.    ds ' \&
 
97
.    ds ` \&
 
98
.    ds ^ \&
 
99
.    ds , \&
 
100
.    ds ~ ~
 
101
.    ds /
 
102
.\}
 
103
.if t \{\
 
104
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 
105
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 
106
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 
107
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 
108
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 
109
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 
110
.\}
 
111
.    \" troff and (daisy-wheel) nroff accents
 
112
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 
113
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 
114
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 
115
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 
116
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 
117
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 
118
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 
119
.ds ae a\h'-(\w'a'u*4/10)'e
 
120
.ds Ae A\h'-(\w'A'u*4/10)'E
 
121
.    \" corrections for vroff
 
122
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 
123
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 
124
.    \" for low resolution devices (crt and lpr)
 
125
.if \n(.H>23 .if \n(.V>19 \
 
126
\{\
 
127
.    ds : e
 
128
.    ds 8 ss
 
129
.    ds o a
 
130
.    ds d- d\h'-1'\(ga
 
131
.    ds D- D\h'-1'\(hy
 
132
.    ds th \o'bp'
 
133
.    ds Th \o'LP'
 
134
.    ds ae ae
 
135
.    ds Ae AE
 
136
.\}
 
137
.rm #[ #] #H #V #F C
 
138
.\" ======================================================================
 
139
.\"
 
140
.IX Title "RPM 3"
 
141
.TH RPM 3 "perl v5.6.0" "2001-04-27" "User Contributed Perl Documentation"
 
142
.UC
 
143
.SH "NAME"
 
144
\&\s-1RPM\s0 \- Perl interface to the \s-1API\s0 for the \s-1RPM\s0 Package Manager
 
145
.SH "DESCRIPTION"
 
146
.IX Header "DESCRIPTION"
 
147
The \fBPerl-RPM\fR package is an extension for natively linking the
 
148
functionality of the \fB\s-1RPM\s0 Package Manager\fR with the extension facility of
 
149
Perl. The aim is to offer all the functionality made available via the C
 
150
\&\s-1API\s0 in the form of Perl object classes.
 
151
.PP
 
152
At present, the package-manipulation functionality is not yet implemented.
 
153
The \fB\s-1RPM:\s0:Database\fR and \fB\s-1RPM:\s0:Header\fR packages do provide access to the
 
154
information contained within the database of installed packages, and
 
155
individual package headers, respectively. The \fB\s-1RPM:\s0:Error\fR package is
 
156
available, which provides support routines for signaling and catching
 
157
errors. Additionally, there is the \fB\s-1RPM:\s0:Constants\fR package which provides
 
158
a number of values from the \fBrpm\fR library, referred to by the same name used
 
159
at the C level.
 
160
.SH "UTILITY FUNCTIONS"
 
161
.IX Header "UTILITY FUNCTIONS"
 
162
The following utility functions are exported by default from \fB\s-1RPM\s0\fR:
 
163
.Ip "rpm_osname" 4
 
164
.IX Item "rpm_osname"
 
165
Returns the text name of the O/S, as derived from the \fBrpm\fR configuration
 
166
files. This is the O/S token that \fBrpm\fR will use to refer to the running
 
167
system.
 
168
.Ip "rpm_archname" 4
 
169
.IX Item "rpm_archname"
 
170
As above, but returns the architecture string instead. Again, this may not
 
171
directly match the running system, but rather is the value that \fBrpm\fR is
 
172
using. \fBrpm\fR will use the lowest-matching architecture whenever possible,
 
173
for maximum cross-platform compatibility.
 
174
.PP
 
175
The following utility function may be explicitly requested via \fBuse\fR or
 
176
\&\fBimport\fR:
 
177
.Sp
 
178
Allows RPM-style comparison of version/release pairs without having the full
 
179
\&\fB\s-1RPM:\s0:Header\fR objects in memory. This enables programs to compare versions
 
180
without having to worry about how \s-1RPM\s0 handles the mixture of alphanumeric
 
181
cases that are supported internally. The return value is \-1, 0 or 1, as with
 
182
any comparison operator. This is purposefully named differently from the
 
183
\&\fBcmpver\fR method in \fB\s-1RPM:\s0:Header\fR so as to avoid confusion.
 
184
.SH "DIAGNOSTICS"
 
185
.IX Header "DIAGNOSTICS"
 
186
When an error occurs in either the C-level \fBrpm\fR library or internally
 
187
within these libraries, it is made available via a special dual-nature
 
188
variable \fB$RPM::err\fR. When evaluated in a numeric context, it returns the
 
189
integer code value of the error. When taken in a string context, it returns
 
190
the text message associated with the error. This is intended to closely
 
191
mimic the behavior of the special Perl variable "\f(CW\*(C`$!\*(C'\fR".
 
192
.SH "CAVEATS"
 
193
.IX Header "CAVEATS"
 
194
This is currently regarded as alpha-quality software. The interface is
 
195
subject to change in future releases.
 
196
.SH "SEE ALSO"
 
197
.IX Header "SEE ALSO"
 
198
the RPM::Constants manpage, the RPM::Database manpage, the RPM::Error manpage, the RPM::Header manpage,
 
199
the perl manpage, the rpm manpage
 
200
.SH "AUTHOR"
 
201
.IX Header "AUTHOR"
 
202
Randy J. Ray <rjray@blackperl.com>