diff options
Diffstat (limited to 'doc/man3')
53 files changed, 1014 insertions, 0 deletions
diff --git a/doc/man3/alpm_conflict_getinfo.3 b/doc/man3/alpm_conflict_getinfo.3 new file mode 100644 index 00000000..8bfc6275 --- /dev/null +++ b/doc/man3/alpm_conflict_getinfo.3 @@ -0,0 +1 @@ +.so man3/alpm_dep.3 diff --git a/doc/man3/alpm_databases.3 b/doc/man3/alpm_databases.3 new file mode 100644 index 00000000..84eda8c5 --- /dev/null +++ b/doc/man3/alpm_databases.3 @@ -0,0 +1,211 @@ +.TH "Database Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Database Functions \- Frunctions to query and manipulate the database of libalpm. + +.PP +.SS "Functions" + +.in +1c +.ti -1c +.RI "pmdb_t * \fBalpm_db_register\fP (char *treename, alpm_cb_db_register callback)" +.br +.ti -1c +.RI "int \fBalpm_db_unregister\fP (pmdb_t *db)" +.br +.ti -1c +.RI "void * \fBalpm_db_getinfo\fP (PM_DB *db, unsigned char parm)" +.br +.ti -1c +.RI "int \fBalpm_db_setserver\fP (pmdb_t *db, char *url)" +.br +.ti -1c +.RI "int \fBalpm_db_update\fP (int level, PM_DB *db)" +.br +.ti -1c +.RI "pmpkg_t * \fBalpm_db_readpkg\fP (pmdb_t *db, char *name)" +.br +.ti -1c +.RI "PMList * \fBalpm_db_getpkgcache\fP (pmdb_t *db)" +.br +.ti -1c +.RI "PMList * \fBalpm_db_whatprovides\fP (pmdb_t *db, char *name)" +.br +.ti -1c +.RI "pmgrp_t * \fBalpm_db_readgrp\fP (pmdb_t *db, char *name)" +.br +.ti -1c +.RI "PMList * \fBalpm_db_getgrpcache\fP (pmdb_t *db)" +.br +.in -1c +.SH "Detailed Description" +.PP +Frunctions to query and manipulate the database of libalpm. +.PP +.SH "Function Documentation" +.PP +.SS "PMList* alpm_db_getgrpcache (pmdb_t * db)" +.PP +Get the group cache of a package database +.PP +\fBParameters:\fP +.RS 4 +\fIdb\fP pointer to the package database to get the group from +.RE +.PP +\fBReturns:\fP +.RS 4 +the list of groups on success, NULL on error +.RE +.PP + +.SS "void* alpm_db_getinfo (PM_DB * db, unsigned char parm)" +.PP +Get informations about a database. +.PP +\fBParameters:\fP +.RS 4 +\fIdb\fP database pointer +.br +\fIparm\fP name of the info to get +.RE +.PP +\fBReturns:\fP +.RS 4 +a void* on success (the value), NULL on error +.RE +.PP + +.SS "PMList* alpm_db_getpkgcache (pmdb_t * db)" +.PP +Get the package cache of a package database +.PP +\fBParameters:\fP +.RS 4 +\fIdb\fP pointer to the package database to get the package from +.RE +.PP +\fBReturns:\fP +.RS 4 +the list of packages on success, NULL on error +.RE +.PP + +.SS "pmgrp_t* alpm_db_readgrp (pmdb_t * db, char * name)" +.PP +Get a group entry from a package database +.PP +\fBParameters:\fP +.RS 4 +\fIdb\fP pointer to the package database to get the group from +.br +\fIname\fP of the group +.RE +.PP +\fBReturns:\fP +.RS 4 +the groups entry on success, NULL on error +.RE +.PP + +.SS "pmpkg_t* alpm_db_readpkg (pmdb_t * db, char * name)" +.PP +Get a package entry from a package database +.PP +\fBParameters:\fP +.RS 4 +\fIdb\fP pointer to the package database to get the package from +.br +\fIname\fP of the package +.RE +.PP +\fBReturns:\fP +.RS 4 +the package entry on success, NULL on error +.RE +.PP + +.SS "pmdb_t* alpm_db_register (char * treename, alpm_cb_db_register callback)" +.PP +Register a package database +.PP +\fBParameters:\fP +.RS 4 +\fItreename\fP the name of the repository +.br +\fIcallback\fP a function to be called upon new database creation +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SS "int alpm_db_setserver (pmdb_t * db, char * url)" +.PP +Set the serverlist of a database. +.PP +\fBParameters:\fP +.RS 4 +\fIdb\fP database pointer +.br +\fIurl\fP url of the server +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SS "int alpm_db_unregister (pmdb_t * db)" +.PP +Unregister a package database +.PP +\fBParameters:\fP +.RS 4 +\fIdb\fP pointer to the package database to unregister +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SS "int alpm_db_update (int level, PM_DB * db)" +.PP +Update a package database +.PP +\fBParameters:\fP +.RS 4 +\fIlevel\fP control for checking lastupdate time +.br +\fIdb\fP pointer to the package database to update +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, > 0 on error (pm_errno is set accordingly), < 0 if up to date +.RE +.PP + +.SS "PMList* alpm_db_whatprovides (pmdb_t * db, char * name)" +.PP +Get the list of packages that a package provides +.PP +\fBParameters:\fP +.RS 4 +\fIdb\fP pointer to the package database to get the package from +.br +\fIname\fP name of the package +.RE +.PP +\fBReturns:\fP +.RS 4 +the list of packages on success, NULL on error +.RE +.PP + diff --git a/doc/man3/alpm_db_getgrpcache.3 b/doc/man3/alpm_db_getgrpcache.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_getgrpcache.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_db_getinfo.3 b/doc/man3/alpm_db_getinfo.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_getinfo.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_db_getpkgcache.3 b/doc/man3/alpm_db_getpkgcache.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_getpkgcache.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_db_readgrp.3 b/doc/man3/alpm_db_readgrp.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_readgrp.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_db_readpkg.3 b/doc/man3/alpm_db_readpkg.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_readpkg.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_db_register.3 b/doc/man3/alpm_db_register.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_register.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_db_search.3 b/doc/man3/alpm_db_search.3 new file mode 100644 index 00000000..e26f34ce --- /dev/null +++ b/doc/man3/alpm_db_search.3 @@ -0,0 +1 @@ +.so man3/alpm_sync.3 diff --git a/doc/man3/alpm_db_setserver.3 b/doc/man3/alpm_db_setserver.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_setserver.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_db_unregister.3 b/doc/man3/alpm_db_unregister.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_unregister.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_db_update.3 b/doc/man3/alpm_db_update.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_update.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_db_whatprovides.3 b/doc/man3/alpm_db_whatprovides.3 new file mode 100644 index 00000000..01b2bdc9 --- /dev/null +++ b/doc/man3/alpm_db_whatprovides.3 @@ -0,0 +1 @@ +.so man3/alpm_databases.3 diff --git a/doc/man3/alpm_dep.3 b/doc/man3/alpm_dep.3 new file mode 100644 index 00000000..49eaf0a1 --- /dev/null +++ b/doc/man3/alpm_dep.3 @@ -0,0 +1,57 @@ +.TH "Dependency Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Dependency Functions \- Functions to get informations about a libalpm dependency. + +.PP +.SS "Functions" + +.in +1c +.ti -1c +.RI "void * \fBalpm_dep_getinfo\fP (pmdepmissing_t *miss, unsigned char parm)" +.br +.ti -1c +.RI "void * \fBalpm_conflict_getinfo\fP (pmconflict_t *conflict, unsigned char parm)" +.br +.in -1c +.SH "Detailed Description" +.PP +Functions to get informations about a libalpm dependency. +.PP +.SH "Function Documentation" +.PP +.SS "void* alpm_conflict_getinfo (pmconflict_t * conflict, unsigned char parm)" +.PP +Get informations about a file conflict. +.PP +\fBParameters:\fP +.RS 4 +\fIconflict\fP database conflict structure +.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 "void* alpm_dep_getinfo (pmdepmissing_t * miss, unsigned char parm)" +.PP +Get informations about a dependency. +.PP +\fBParameters:\fP +.RS 4 +\fImiss\fP dependency 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 + diff --git a/doc/man3/alpm_dep_getinfo.3 b/doc/man3/alpm_dep_getinfo.3 new file mode 100644 index 00000000..8bfc6275 --- /dev/null +++ b/doc/man3/alpm_dep_getinfo.3 @@ -0,0 +1 @@ +.so man3/alpm_dep.3 diff --git a/doc/man3/alpm_fetch_pkgurl.3 b/doc/man3/alpm_fetch_pkgurl.3 new file mode 100644 index 00000000..5c237ae4 --- /dev/null +++ b/doc/man3/alpm_fetch_pkgurl.3 @@ -0,0 +1 @@ +.so man3/alpm_misc.3 diff --git a/doc/man3/alpm_get_md5sum.3 b/doc/man3/alpm_get_md5sum.3 new file mode 100644 index 00000000..5c237ae4 --- /dev/null +++ b/doc/man3/alpm_get_md5sum.3 @@ -0,0 +1 @@ +.so man3/alpm_misc.3 diff --git a/doc/man3/alpm_get_option.3 b/doc/man3/alpm_get_option.3 new file mode 100644 index 00000000..695ff9fd --- /dev/null +++ b/doc/man3/alpm_get_option.3 @@ -0,0 +1 @@ +.so man3/alpm_options.3 diff --git a/doc/man3/alpm_get_sha1sum.3 b/doc/man3/alpm_get_sha1sum.3 new file mode 100644 index 00000000..5c237ae4 --- /dev/null +++ b/doc/man3/alpm_get_sha1sum.3 @@ -0,0 +1 @@ +.so man3/alpm_misc.3 diff --git a/doc/man3/alpm_groups.3 b/doc/man3/alpm_groups.3 new file mode 100644 index 00000000..77fb4b71 --- /dev/null +++ b/doc/man3/alpm_groups.3 @@ -0,0 +1,37 @@ +.TH "Group Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Group Functions \- Functions to get informations about libalpm groups. + +.PP +.SS "Functions" + +.in +1c +.ti -1c +.RI "void * \fBalpm_grp_getinfo\fP (pmgrp_t *grp, unsigned char parm)" +.br +.in -1c +.SH "Detailed Description" +.PP +Functions to get informations about libalpm groups. +.PP +.SH "Function Documentation" +.PP +.SS "void* alpm_grp_getinfo (pmgrp_t * grp, unsigned char parm)" +.PP +Get informations about a group. +.PP +\fBParameters:\fP +.RS 4 +\fIgrp\fP group 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 + diff --git a/doc/man3/alpm_grp_getinfo.3 b/doc/man3/alpm_grp_getinfo.3 new file mode 100644 index 00000000..a85dd83a --- /dev/null +++ b/doc/man3/alpm_grp_getinfo.3 @@ -0,0 +1 @@ +.so man3/alpm_groups.3 diff --git a/doc/man3/alpm_initialize.3 b/doc/man3/alpm_initialize.3 new file mode 100644 index 00000000..bca122ef --- /dev/null +++ b/doc/man3/alpm_initialize.3 @@ -0,0 +1 @@ +.so man3/alpm_interface.3 diff --git a/doc/man3/alpm_interface.3 b/doc/man3/alpm_interface.3 new file mode 100644 index 00000000..a4b5443a --- /dev/null +++ b/doc/man3/alpm_interface.3 @@ -0,0 +1,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 + 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 + diff --git a/doc/man3/alpm_list_count.3 b/doc/man3/alpm_list_count.3 new file mode 100644 index 00000000..af27c84d --- /dev/null +++ b/doc/man3/alpm_list_count.3 @@ -0,0 +1 @@ +.so man3/alpm_list.3 diff --git a/doc/man3/alpm_list_first.3 b/doc/man3/alpm_list_first.3 new file mode 100644 index 00000000..af27c84d --- /dev/null +++ b/doc/man3/alpm_list_first.3 @@ -0,0 +1 @@ +.so man3/alpm_list.3 diff --git a/doc/man3/alpm_list_free.3 b/doc/man3/alpm_list_free.3 new file mode 100644 index 00000000..af27c84d --- /dev/null +++ b/doc/man3/alpm_list_free.3 @@ -0,0 +1 @@ +.so man3/alpm_list.3 diff --git a/doc/man3/alpm_list_getdata.3 b/doc/man3/alpm_list_getdata.3 new file mode 100644 index 00000000..af27c84d --- /dev/null +++ b/doc/man3/alpm_list_getdata.3 @@ -0,0 +1 @@ +.so man3/alpm_list.3 diff --git a/doc/man3/alpm_list_next.3 b/doc/man3/alpm_list_next.3 new file mode 100644 index 00000000..af27c84d --- /dev/null +++ b/doc/man3/alpm_list_next.3 @@ -0,0 +1 @@ +.so man3/alpm_list.3 diff --git a/doc/man3/alpm_log.3 b/doc/man3/alpm_log.3 new file mode 100644 index 00000000..1e2d9ac3 --- /dev/null +++ b/doc/man3/alpm_log.3 @@ -0,0 +1,35 @@ +.TH "Logging Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Logging Functions \- Functions to log using libalpm. + +.PP +.SS "Functions" + +.in +1c +.ti -1c +.RI "int \fBalpm_logaction\fP (char *fmt,...)" +.br +.in -1c +.SH "Detailed Description" +.PP +Functions to log using libalpm. +.PP +.SH "Function Documentation" +.PP +.SS "int alpm_logaction (char * fmt, ...)" +.PP +A printf-like function for logging. +.PP +\fBParameters:\fP +.RS 4 +\fIfmt\fP output format +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + diff --git a/doc/man3/alpm_logaction.3 b/doc/man3/alpm_logaction.3 new file mode 100644 index 00000000..bd21eb21 --- /dev/null +++ b/doc/man3/alpm_logaction.3 @@ -0,0 +1 @@ +.so man3/alpm_log.3 diff --git a/doc/man3/alpm_misc.3 b/doc/man3/alpm_misc.3 new file mode 100644 index 00000000..d2e8a3b0 --- /dev/null +++ b/doc/man3/alpm_misc.3 @@ -0,0 +1,93 @@ +.TH "Miscellaneous Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Miscellaneous Functions \- Various libalpm functions. + +.PP +.SS "Functions" + +.in +1c +.ti -1c +.RI "char * \fBalpm_get_md5sum\fP (char *name)" +.br +.ti -1c +.RI "char * \fBalpm_get_sha1sum\fP (char *name)" +.br +.ti -1c +.RI "char * \fBalpm_fetch_pkgurl\fP (char *url)" +.br +.ti -1c +.RI "int \fBalpm_parse_config\fP (char *file, alpm_cb_db_register callback, const char *this_section)" +.br +.in -1c +.SH "Detailed Description" +.PP +Various libalpm functions. +.PP +.SH "Function Documentation" +.PP +.SS "char* alpm_fetch_pkgurl (char * url)" +.PP +Fetch a remote pkg. +.PP +\fBParameters:\fP +.RS 4 +\fIurl\fP +.RE +.PP +\fBReturns:\fP +.RS 4 +the downloaded filename on success, NULL on error +.RE +.PP + +.SS "char* alpm_get_md5sum (char * name)" +.PP +Get the md5 sum of file. +.PP +\fBParameters:\fP +.RS 4 +\fIname\fP name of the file +.RE +.PP +\fBReturns:\fP +.RS 4 +the checksum on success, NULL on error +.RE +.PP + +.SS "char* alpm_get_sha1sum (char * name)" +.PP +Get the sha1 sum of file. +.PP +\fBParameters:\fP +.RS 4 +\fIname\fP name of the file +.RE +.PP +\fBReturns:\fP +.RS 4 +the checksum on success, NULL on error +.RE +.PP + +.SS "int alpm_parse_config (char * file, alpm_cb_db_register callback, const char * this_section)" +.PP +Parses a configuration file. +.PP +\fBParameters:\fP +.RS 4 +\fIfile\fP path to the config file. +.br +\fIcallback\fP a function to be called upon new database creation +.br +\fIthis_section\fP the config current section being parsed +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + diff --git a/doc/man3/alpm_options.3 b/doc/man3/alpm_options.3 new file mode 100644 index 00000000..c43a3039 --- /dev/null +++ b/doc/man3/alpm_options.3 @@ -0,0 +1,57 @@ +.TH "Library Options" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Library Options \- Functions to set and get libalpm options. + +.PP +.SS "Functions" + +.in +1c +.ti -1c +.RI "int \fBalpm_set_option\fP (unsigned char parm, unsigned long data)" +.br +.ti -1c +.RI "int \fBalpm_get_option\fP (unsigned char parm, long *data)" +.br +.in -1c +.SH "Detailed Description" +.PP +Functions to set and get libalpm options. +.PP +.SH "Function Documentation" +.PP +.SS "int alpm_get_option (unsigned char parm, long * data)" +.PP +Get the value of a library option. +.PP +\fBParameters:\fP +.RS 4 +\fIparm\fP the parameter to get +.br +\fIdata\fP pointer argument to get the value in +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SS "int alpm_set_option (unsigned char parm, unsigned long data)" +.PP +Set a library option. +.PP +\fBParameters:\fP +.RS 4 +\fIparm\fP the name of the parameter +.br +\fIdata\fP the value of the parameter +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + 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 + diff --git a/doc/man3/alpm_parse_config.3 b/doc/man3/alpm_parse_config.3 new file mode 100644 index 00000000..5c237ae4 --- /dev/null +++ b/doc/man3/alpm_parse_config.3 @@ -0,0 +1 @@ +.so man3/alpm_misc.3 diff --git a/doc/man3/alpm_pkg_checkmd5sum.3 b/doc/man3/alpm_pkg_checkmd5sum.3 new file mode 100644 index 00000000..133c7d41 --- /dev/null +++ b/doc/man3/alpm_pkg_checkmd5sum.3 @@ -0,0 +1 @@ +.so man3/alpm_packages.3 diff --git a/doc/man3/alpm_pkg_checksha1sum.3 b/doc/man3/alpm_pkg_checksha1sum.3 new file mode 100644 index 00000000..133c7d41 --- /dev/null +++ b/doc/man3/alpm_pkg_checksha1sum.3 @@ -0,0 +1 @@ +.so man3/alpm_packages.3 diff --git a/doc/man3/alpm_pkg_free.3 b/doc/man3/alpm_pkg_free.3 new file mode 100644 index 00000000..133c7d41 --- /dev/null +++ b/doc/man3/alpm_pkg_free.3 @@ -0,0 +1 @@ +.so man3/alpm_packages.3 diff --git a/doc/man3/alpm_pkg_getinfo.3 b/doc/man3/alpm_pkg_getinfo.3 new file mode 100644 index 00000000..133c7d41 --- /dev/null +++ b/doc/man3/alpm_pkg_getinfo.3 @@ -0,0 +1 @@ +.so man3/alpm_packages.3 diff --git a/doc/man3/alpm_pkg_load.3 b/doc/man3/alpm_pkg_load.3 new file mode 100644 index 00000000..133c7d41 --- /dev/null +++ b/doc/man3/alpm_pkg_load.3 @@ -0,0 +1 @@ +.so man3/alpm_packages.3 diff --git a/doc/man3/alpm_pkg_vercmp.3 b/doc/man3/alpm_pkg_vercmp.3 new file mode 100644 index 00000000..133c7d41 --- /dev/null +++ b/doc/man3/alpm_pkg_vercmp.3 @@ -0,0 +1 @@ +.so man3/alpm_packages.3 diff --git a/doc/man3/alpm_release.3 b/doc/man3/alpm_release.3 new file mode 100644 index 00000000..bca122ef --- /dev/null +++ b/doc/man3/alpm_release.3 @@ -0,0 +1 @@ +.so man3/alpm_interface.3 diff --git a/doc/man3/alpm_set_option.3 b/doc/man3/alpm_set_option.3 new file mode 100644 index 00000000..695ff9fd --- /dev/null +++ b/doc/man3/alpm_set_option.3 @@ -0,0 +1 @@ +.so man3/alpm_options.3 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 + diff --git a/doc/man3/alpm_sync_getinfo.3 b/doc/man3/alpm_sync_getinfo.3 new file mode 100644 index 00000000..e26f34ce --- /dev/null +++ b/doc/man3/alpm_sync_getinfo.3 @@ -0,0 +1 @@ +.so man3/alpm_sync.3 diff --git a/doc/man3/alpm_trans.3 b/doc/man3/alpm_trans.3 new file mode 100644 index 00000000..d574cdb1 --- /dev/null +++ b/doc/man3/alpm_trans.3 @@ -0,0 +1,141 @@ +.TH "Transaction Functions" 3 "16 Oct 2006" "libalpm" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Transaction Functions \- Functions to manipulate libalpm transactions. + +.PP +.SS "Functions" + +.in +1c +.ti -1c +.RI "void * \fBalpm_trans_getinfo\fP (unsigned char parm)" +.br +.ti -1c +.RI "int \fBalpm_trans_init\fP (unsigned char type, unsigned int flags, alpm_trans_cb_event event, alpm_trans_cb_conv conv, alpm_trans_cb_progress progress)" +.br +.ti -1c +.RI "int \fBalpm_trans_sysupgrade\fP ()" +.br +.ti -1c +.RI "int \fBalpm_trans_addtarget\fP (char *target)" +.br +.ti -1c +.RI "int \fBalpm_trans_prepare\fP (PMList **data)" +.br +.ti -1c +.RI "int \fBalpm_trans_commit\fP (PMList **data)" +.br +.ti -1c +.RI "int \fBalpm_trans_release\fP ()" +.br +.in -1c +.SH "Detailed Description" +.PP +Functions to manipulate libalpm transactions. +.PP +.SH "Function Documentation" +.PP +.SS "int alpm_trans_addtarget (char * target)" +.PP +Add a target to the transaction. +.PP +\fBParameters:\fP +.RS 4 +\fItarget\fP the name of the target to add +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SS "int alpm_trans_commit (PMList ** data)" +.PP +Commit a transaction. +.PP +\fBParameters:\fP +.RS 4 +\fIdata\fP the address of a PM_LIST where detailed description of an error can be dumped (ie. list of conflicting files) +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SS "void* alpm_trans_getinfo (unsigned char parm)" +.PP +Get informations about the transaction. +.PP +\fBParameters:\fP +.RS 4 +\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_trans_init (unsigned char type, unsigned int flags, alpm_trans_cb_event event, alpm_trans_cb_conv conv, alpm_trans_cb_progress progress)" +.PP +Initialize the transaction. +.PP +\fBParameters:\fP +.RS 4 +\fItype\fP type of the transaction +.br +\fIflags\fP flags of the transaction (like nodeps, etc) +.br +\fIevent\fP event callback function pointer +.br +\fIconv\fP question callback function pointer +.br +\fIprogress\fP progress callback function pointer +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SS "int alpm_trans_prepare (PMList ** data)" +.PP +Prepare a transaction. +.PP +\fBParameters:\fP +.RS 4 +\fIdata\fP the address of a PM_LIST where detailed description of an error can be dumped (ie. list of conflicting files) +.RE +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SS "int alpm_trans_release ()" +.PP +Release a transaction. +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SS "int alpm_trans_sysupgrade ()" +.PP +Search for packages to upgrade and add them to the transaction. +.PP +\fBReturns:\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + diff --git a/doc/man3/alpm_trans_addtarget.3 b/doc/man3/alpm_trans_addtarget.3 new file mode 100644 index 00000000..219cf744 --- /dev/null +++ b/doc/man3/alpm_trans_addtarget.3 @@ -0,0 +1 @@ +.so man3/alpm_trans.3 diff --git a/doc/man3/alpm_trans_commit.3 b/doc/man3/alpm_trans_commit.3 new file mode 100644 index 00000000..219cf744 --- /dev/null +++ b/doc/man3/alpm_trans_commit.3 @@ -0,0 +1 @@ +.so man3/alpm_trans.3 diff --git a/doc/man3/alpm_trans_getinfo.3 b/doc/man3/alpm_trans_getinfo.3 new file mode 100644 index 00000000..219cf744 --- /dev/null +++ b/doc/man3/alpm_trans_getinfo.3 @@ -0,0 +1 @@ +.so man3/alpm_trans.3 diff --git a/doc/man3/alpm_trans_init.3 b/doc/man3/alpm_trans_init.3 new file mode 100644 index 00000000..219cf744 --- /dev/null +++ b/doc/man3/alpm_trans_init.3 @@ -0,0 +1 @@ +.so man3/alpm_trans.3 diff --git a/doc/man3/alpm_trans_prepare.3 b/doc/man3/alpm_trans_prepare.3 new file mode 100644 index 00000000..219cf744 --- /dev/null +++ b/doc/man3/alpm_trans_prepare.3 @@ -0,0 +1 @@ +.so man3/alpm_trans.3 diff --git a/doc/man3/alpm_trans_release.3 b/doc/man3/alpm_trans_release.3 new file mode 100644 index 00000000..219cf744 --- /dev/null +++ b/doc/man3/alpm_trans_release.3 @@ -0,0 +1 @@ +.so man3/alpm_trans.3 diff --git a/doc/man3/alpm_trans_sysupgrade.3 b/doc/man3/alpm_trans_sysupgrade.3 new file mode 100644 index 00000000..219cf744 --- /dev/null +++ b/doc/man3/alpm_trans_sysupgrade.3 @@ -0,0 +1 @@ +.so man3/alpm_trans.3 |