summaryrefslogtreecommitdiffstats
path: root/doc/man3/alpm_interface.3
blob: a4b5443a9b900ca303be0e35b7ef1c90e5b0523e (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
.TH "Interface Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Interface Functions \- Function to initialize and release libalpm.  

.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBalpm_initialize\fP (char *root)"
.br
.ti -1c
.RI "int \fBalpm_release\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
Function to initialize and release libalpm. 
.PP
.SH "Function Documentation"
.PP 
.SS "int alpm_initialize (char * root)"
.PP
Initializes the library. This must be called before any other functions are called. 
.PP
\fBParameters:\fP
.RS 4
\fIroot\fP the full path of the root we'll be installing to (usually /) 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on error (pm_errno is set accordingly) 
.RE
.PP

.SS "int alpm_release ()"
.PP
Release the library. This should be the last alpm call you make. 
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on error (pm_errno is set accordingly) 
.RE
.PP