From db769f667d93d9127b570570564589337c793fbe Mon Sep 17 00:00:00 2001
From: Aaron Griffin <aaron@archlinux.org>
Date: Sun, 15 Oct 2006 21:06:08 +0000
Subject: 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)

---
 doc/man3/alpm_list.3 | 107 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 107 insertions(+)
 create mode 100644 doc/man3/alpm_list.3

(limited to 'doc/man3/alpm_list.3')

diff --git a/doc/man3/alpm_list.3 b/doc/man3/alpm_list.3
new file mode 100644
index 00000000..18c48014
--- /dev/null
+++ b/doc/man3/alpm_list.3
@@ -0,0 +1,107 @@
+.TH "List Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+List Functions \- Functions to manipulate libalpm linked lists.  
+
+.PP
+.SS "Functions"
+
+.in +1c
+.ti -1c
+.RI "PMList * \fBalpm_list_first\fP (PMList *list)"
+.br
+.ti -1c
+.RI "PMList * \fBalpm_list_next\fP (PMList *entry)"
+.br
+.ti -1c
+.RI "void * \fBalpm_list_getdata\fP (PMList *entry)"
+.br
+.ti -1c
+.RI "int \fBalpm_list_free\fP (PMList *entry)"
+.br
+.ti -1c
+.RI "int \fBalpm_list_count\fP (PMList *list)"
+.br
+.in -1c
+.SH "Detailed Description"
+.PP 
+Functions to manipulate libalpm linked lists. 
+.PP
+.SH "Function Documentation"
+.PP 
+.SS "int alpm_list_count (PMList * list)"
+.PP
+Count the entries in a list. 
+.PP
+\fBParameters:\fP
+.RS 4
+\fIlist\fP the list to count 
+.RE
+.PP
+\fBReturns:\fP
+.RS 4
+number of entries on success, NULL on error 
+.RE
+.PP
+
+.SS "PMList* alpm_list_first (PMList * list)"
+.PP
+Get the first element of a list. 
+.PP
+\fBParameters:\fP
+.RS 4
+\fIlist\fP the list 
+.RE
+.PP
+\fBReturns:\fP
+.RS 4
+the first element 
+.RE
+.PP
+
+.SS "int alpm_list_free (PMList * entry)"
+.PP
+Free a list. 
+.PP
+\fBParameters:\fP
+.RS 4
+\fIentry\fP list to free 
+.RE
+.PP
+\fBReturns:\fP
+.RS 4
+0 on success, -1 on error 
+.RE
+.PP
+
+.SS "void* alpm_list_getdata (PMList * entry)"
+.PP
+Get the data of a list entry. 
+.PP
+\fBParameters:\fP
+.RS 4
+\fIentry\fP the list entry 
+.RE
+.PP
+\fBReturns:\fP
+.RS 4
+the data on success, NULL on error 
+.RE
+.PP
+
+.SS "PMList* alpm_list_next (PMList * entry)"
+.PP
+Get the next element of a list. 
+.PP
+\fBParameters:\fP
+.RS 4
+\fIentry\fP the list entry 
+.RE
+.PP
+\fBReturns:\fP
+.RS 4
+the next element on success, NULL on error 
+.RE
+.PP
+
-- 
cgit v1.2.3-70-g09d2