summaryrefslogtreecommitdiffstats
path: root/doc/man3/alpm_packages.3
blob: 5b193c0f8c7beb7d3a9e051adec36685fde53a7c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
.TH "Package Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Package Functions \- Functions to manipulate libalpm packages.  

.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "void * \fBalpm_pkg_getinfo\fP (pmpkg_t *pkg, unsigned char parm)"
.br
.ti -1c
.RI "int \fBalpm_pkg_load\fP (char *filename, pmpkg_t **pkg)"
.br
.ti -1c
.RI "int \fBalpm_pkg_free\fP (pmpkg_t *pkg)"
.br
.ti -1c
.RI "int \fBalpm_pkg_checksha1sum\fP (pmpkg_t *pkg)"
.br
.ti -1c
.RI "int \fBalpm_pkg_checkmd5sum\fP (pmpkg_t *pkg)"
.br
.ti -1c
.RI "int \fBalpm_pkg_vercmp\fP (const char *ver1, const char *ver2)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Functions to manipulate libalpm packages. 
.PP
.SH "Function Documentation"
.PP 
.SS "int alpm_pkg_checkmd5sum (pmpkg_t * pkg)"
.PP
Check the integrity (with md5) of a package from the sync cache. 
.PP
\fBParameters:\fP
.RS 4
\fIpkg\fP package pointer 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on error (pm_errno is set accordingly) 
.RE
.PP

.SS "int alpm_pkg_checksha1sum (pmpkg_t * pkg)"
.PP
Check the integrity (with sha1) of a package from the sync cache. 
.PP
\fBParameters:\fP
.RS 4
\fIpkg\fP package pointer 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on error (pm_errno is set accordingly) 
.RE
.PP

.SS "int alpm_pkg_free (pmpkg_t * pkg)"
.PP
Free a package. 
.PP
\fBParameters:\fP
.RS 4
\fIpkg\fP package pointer to free 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on error (pm_errno is set accordingly) 
.RE
.PP

.SS "void* alpm_pkg_getinfo (pmpkg_t * pkg, unsigned char parm)"
.PP
Get informations about a package. 
.PP
\fBParameters:\fP
.RS 4
\fIpkg\fP package pointer 
.br
\fIparm\fP name of the info to get 
.RE
.PP
\fBReturns:\fP
.RS 4
a char* on success (the value), NULL on error 
.RE
.PP

.SS "int alpm_pkg_load (char * filename, pmpkg_t ** pkg)"
.PP
Create a package from a file. 
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP location of the package tarball 
.br
\fIpkg\fP address of the package pointer 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on error (pm_errno is set accordingly) 
.RE
.PP

.SS "int alpm_pkg_vercmp (const char * ver1, const char * ver2)"
.PP
Compare versions. 
.PP
\fBParameters:\fP
.RS 4
\fIver1\fP first version 
.br
\fIver2\fP secont version 
.RE
.PP
\fBReturns:\fP
.RS 4
postive, 0 or negative if ver1 is less, equal or more than ver2, respectively. 
.RE
.PP