summaryrefslogtreecommitdiff
path: root/doc/man3/alpm_sync.3
diff options
context:
space:
mode:
authorAaron Griffin <aaron@archlinux.org>2006-10-15 21:06:08 +0000
committerAaron Griffin <aaron@archlinux.org>2006-10-15 21:06:08 +0000
commitdb769f667d93d9127b570570564589337c793fbe (patch)
tree94f90c61fcf2e988f2a718b06925e0df20a29332 /doc/man3/alpm_sync.3
parente037328e219697f8453dc25df2b8f0d25bbc1acc (diff)
downloadpacman-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_sync.3')
-rw-r--r--doc/man3/alpm_sync.355
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/man3/alpm_sync.3 b/doc/man3/alpm_sync.3
new file mode 100644
index 00000000..c406ff92
--- /dev/null
+++ b/doc/man3/alpm_sync.3
@@ -0,0 +1,55 @@
+.TH "Sync Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+Sync Functions \- Functions to get informations about libalpm syncs.
+
+.PP
+.SS "Functions"
+
+.in +1c
+.ti -1c
+.RI "void * \fBalpm_sync_getinfo\fP (pmsyncpkg_t *sync, unsigned char parm)"
+.br
+.ti -1c
+.RI "PMList * \fBalpm_db_search\fP (pmdb_t *db)"
+.br
+.in -1c
+.SH "Detailed Description"
+.PP
+Functions to get informations about libalpm syncs.
+.PP
+.SH "Function Documentation"
+.PP
+.SS "PMList* alpm_db_search (pmdb_t * db)"
+.PP
+Searches a database
+.PP
+\fBParameters:\fP
+.RS 4
+\fIdb\fP pointer to the package database to search in
+.RE
+.PP
+\fBReturns:\fP
+.RS 4
+the list of packages on success, NULL on error
+.RE
+.PP
+
+.SS "void* alpm_sync_getinfo (pmsyncpkg_t * sync, unsigned char parm)"
+.PP
+Get informations about a sync.
+.PP
+\fBParameters:\fP
+.RS 4
+\fIsync\fP 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
+