summaryrefslogtreecommitdiffstats
path: root/doc/man3/alpm_packages.3
diff options
context:
space:
mode:
authorAaron Griffin <aaron@archlinux.org>2006-10-15 23:06:08 +0200
committerAaron Griffin <aaron@archlinux.org>2006-10-15 23:06:08 +0200
commitdb769f667d93d9127b570570564589337c793fbe (patch)
tree94f90c61fcf2e988f2a718b06925e0df20a29332 /doc/man3/alpm_packages.3
parente037328e219697f8453dc25df2b8f0d25bbc1acc (diff)
downloadpacman-db769f667d93d9127b570570564589337c793fbe.tar.gz
pacman-db769f667d93d9127b570570564589337c793fbe.tar.xz
Added alpm function docs along
pacman.c : Removed link to frugalware wiki sync.c : do not display Uncompressed size if 0 (archlinux has no USIZE)
Diffstat (limited to 'doc/man3/alpm_packages.3')
-rw-r--r--doc/man3/alpm_packages.3131
1 files changed, 131 insertions, 0 deletions
diff --git a/doc/man3/alpm_packages.3 b/doc/man3/alpm_packages.3
new file mode 100644
index 00000000..5b193c0f
--- /dev/null
+++ b/doc/man3/alpm_packages.3
@@ -0,0 +1,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
+