diff options
Diffstat (limited to 'upstream/archlinux/man3/libalpm_databases.3')
| -rw-r--r-- | upstream/archlinux/man3/libalpm_databases.3 | 107 |
1 files changed, 104 insertions, 3 deletions
diff --git a/upstream/archlinux/man3/libalpm_databases.3 b/upstream/archlinux/man3/libalpm_databases.3 index 4c3f3381..0f8343c8 100644 --- a/upstream/archlinux/man3/libalpm_databases.3 +++ b/upstream/archlinux/man3/libalpm_databases.3 @@ -1,4 +1,4 @@ -.TH "libalpm_databases" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_databases" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -10,7 +10,7 @@ libalpm_databases \- Database .in +1c .ti -1c -.RI "typedef struct __alpm_db_t \fBalpm_db_t\fP" +.RI "typedef struct _alpm_db_t \fBalpm_db_t\fP" .br .RI "A database\&. " .in -1c @@ -46,6 +46,10 @@ libalpm_databases \- Database .br .RI "Unregister a package database\&. " .ti -1c +.RI "\fBalpm_handle_t\fP * \fBalpm_db_get_handle\fP (\fBalpm_db_t\fP *db)" +.br +.RI "Get the handle of a package database\&. " +.ti -1c .RI "const char * \fBalpm_db_get_name\fP (const \fBalpm_db_t\fP *db)" .br .RI "Get the name of a package database\&. " @@ -101,6 +105,22 @@ libalpm_databases \- Database .RI "int \fBalpm_db_remove_server\fP (\fBalpm_db_t\fP *db, const char *url)" .br .RI "Remove a download server from a database\&. " +.ti -1c +.RI "\fBalpm_list_t\fP * \fBalpm_db_get_cache_servers\fP (const \fBalpm_db_t\fP *db)" +.br +.RI "Get the list of cache servers assigned to this db\&. " +.ti -1c +.RI "int \fBalpm_db_set_cache_servers\fP (\fBalpm_db_t\fP *db, \fBalpm_list_t\fP *servers)" +.br +.RI "Sets the list of cache servers for the database to use\&. " +.ti -1c +.RI "int \fBalpm_db_add_cache_server\fP (\fBalpm_db_t\fP *db, const char *url)" +.br +.RI "Add a download cache server to a database\&. " +.ti -1c +.RI "int \fBalpm_db_remove_cache_server\fP (\fBalpm_db_t\fP *db, const char *url)" +.br +.RI "Remove a download cache server from a database\&. " .in -1c .SS "Usage accessors" @@ -121,7 +141,7 @@ libalpm_databases \- Database Functions to query and manipulate the database of libalpm\&. .SH "Typedef Documentation" .PP -.SS "typedef struct __alpm_db_t \fBalpm_db_t\fP" +.SS "typedef struct _alpm_db_t \fBalpm_db_t\fP" .PP A database\&. A database is a container that stores metadata about packages\&. @@ -159,6 +179,24 @@ Enable sysupgrades with this database\&. Enable all usage levels\&. .SH "Function Documentation" .PP +.SS "int alpm_db_add_cache_server (\fBalpm_db_t\fP * db, const char * url)" + +.PP +Add a download cache server to 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_add_server (\fBalpm_db_t\fP * db, const char * url)" .PP @@ -177,6 +215,22 @@ Add a download server to a database\&. .RE .PP +.SS "\fBalpm_list_t\fP * alpm_db_get_cache_servers (const \fBalpm_db_t\fP * db)" + +.PP +Get the list of cache servers assigned to this db\&. +.PP +\fBParameters\fP +.RS 4 +\fIdb\fP pointer to the database to get the servers from +.RE +.PP +\fBReturns\fP +.RS 4 +a char* list of servers +.RE +.PP + .SS "\fBalpm_group_t\fP * alpm_db_get_group (\fBalpm_db_t\fP * db, const char * name)" .PP @@ -211,6 +265,22 @@ the list of groups on success, NULL on error .RE .PP +.SS "\fBalpm_handle_t\fP * alpm_db_get_handle (\fBalpm_db_t\fP * db)" + +.PP +Get the handle of a package database\&. +.PP +\fBParameters\fP +.RS 4 +\fIdb\fP pointer to the package database +.RE +.PP +\fBReturns\fP +.RS 4 +the alpm handle that the package database belongs to +.RE +.PP + .SS "const char * alpm_db_get_name (const \fBalpm_db_t\fP * db)" .PP @@ -327,6 +397,24 @@ Check the validity of a database\&. This is most useful for sync databases and v .RE .PP +.SS "int alpm_db_remove_cache_server (\fBalpm_db_t\fP * db, const char * url)" + +.PP +Remove a download cache server from 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 server not present, -1 on error (pm_errno is set accordingly) +.RE +.PP + .SS "int alpm_db_remove_server (\fBalpm_db_t\fP * db, const char * url)" .PP @@ -365,6 +453,19 @@ Searches a database with regular expressions\&. .RE .PP +.SS "int alpm_db_set_cache_servers (\fBalpm_db_t\fP * db, \fBalpm_list_t\fP * servers)" + +.PP +Sets the list of cache servers for the database to use\&. +.PP +\fBParameters\fP +.RS 4 +\fIdb\fP the database to set the servers\&. The list will be duped and the original will still need to be freed by the caller\&. +.br +\fIservers\fP a char* list of servers\&. +.RE +.PP + .SS "int alpm_db_set_servers (\fBalpm_db_t\fP * db, \fBalpm_list_t\fP * servers)" .PP |