diff options
Diffstat (limited to 'upstream/archlinux/man3/libalpm_packages.3')
| -rw-r--r-- | upstream/archlinux/man3/libalpm_packages.3 | 77 |
1 files changed, 72 insertions, 5 deletions
diff --git a/upstream/archlinux/man3/libalpm_packages.3 b/upstream/archlinux/man3/libalpm_packages.3 index 9bd81164..72c11325 100644 --- a/upstream/archlinux/man3/libalpm_packages.3 +++ b/upstream/archlinux/man3/libalpm_packages.3 @@ -1,4 +1,4 @@ -.TH "libalpm_packages" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_packages" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -9,11 +9,19 @@ libalpm_packages \- Package Functions .SH SYNOPSIS .br .PP +.SS "Data Structures" + +.in +1c +.ti -1c +.RI "struct \fBalpm_pkg_xdata_t\fP" +.br +.RI "The extended data type used to store non-standard package data fields\&. " +.in -1c .SS "Typedefs" .in +1c .ti -1c -.RI "typedef struct __alpm_pkg_t \fBalpm_pkg_t\fP" +.RI "typedef struct _alpm_pkg_t \fBalpm_pkg_t\fP" .br .RI "A package\&. " .in -1c @@ -21,7 +29,7 @@ libalpm_packages \- Package Functions .in +1c .ti -1c -.RI "enum \fBalpm_pkgreason_t\fP { \fBALPM_PKG_REASON_EXPLICIT\fP = 0, \fBALPM_PKG_REASON_DEPEND\fP = 1 }" +.RI "enum \fBalpm_pkgreason_t\fP { \fBALPM_PKG_REASON_EXPLICIT\fP = 0, \fBALPM_PKG_REASON_DEPEND\fP = 1, \fBALPM_PKG_REASON_UNKNOWN\fP = 2 }" .br .RI "Package install reasons\&. " .ti -1c @@ -81,6 +89,10 @@ They should not be freed nor modified in any way\&. For loaded packages, they will be freed when \fBalpm_pkg_free\fP is called\&. For database packages, they will be freed when the database is unregistered\&. .in +1c .ti -1c +.RI "\fBalpm_handle_t\fP * \fBalpm_pkg_get_handle\fP (\fBalpm_pkg_t\fP *pkg)" +.br +.RI "Gets the handle of a package\&. " +.ti -1c .RI "const char * \fBalpm_pkg_get_filename\fP (\fBalpm_pkg_t\fP *pkg)" .br .RI "Gets the name of the file from which the package was loaded\&. " @@ -205,6 +217,10 @@ For loaded packages, they will be freed when \fBalpm_pkg_free\fP is called\&. Fo .br .RI "Returns the method used to validate a package during install\&. " .ti -1c +.RI "\fBalpm_list_t\fP * \fBalpm_pkg_get_xdata\fP (\fBalpm_pkg_t\fP *pkg)" +.br +.RI "Gets the extended data field of a package\&. " +.ti -1c .RI "int \fBalpm_pkg_has_scriptlet\fP (\fBalpm_pkg_t\fP *pkg)" .br .RI "Returns whether the package has an install scriptlet\&. " @@ -254,14 +270,30 @@ Functions for reading the mtree Functions to manipulate libalpm packages +.SH "Data Structure Documentation" +.PP +.SH "struct alpm_pkg_xdata_t" +.PP +The extended data type used to store non-standard package data fields\&. +.PP +\fBData Fields:\fP +.RS 4 +char * \fIname\fP +.br +.PP +char * \fIvalue\fP +.br +.PP +.RE +.PP .SH "Typedef Documentation" .PP -.SS "typedef struct __alpm_pkg_t \fBalpm_pkg_t\fP" +.SS "typedef struct _alpm_pkg_t \fBalpm_pkg_t\fP" .PP A package\&. A package can be loaded from disk via \fBalpm_pkg_load\fP or retrieved from a database\&. Packages from databases are automatically freed when the database is unregistered\&. Packages loaded from a file must be freed manually\&. .PP -Packages can then be queried for metadata or added to a \fBtransaction \fP to be added or removed from the system\&. +Packages can then be queried for metadata or added to a transaction to be added or removed from the system\&. .SH "Enumeration Type Documentation" .PP .SS "enum \fBalpm_pkgfrom_t\fP" @@ -293,6 +325,9 @@ Explicitly requested by the user\&. .TP \fB\fIALPM_PKG_REASON_DEPEND \fP\fP Installed as a dependency for another package\&. +.TP +\fB\fIALPM_PKG_REASON_UNKNOWN \fP\fP +Failed parsing of local database\&. .SS "enum \fBalpm_pkgvalidation_t\fP" .PP @@ -699,6 +734,22 @@ a pointer to an internal list of strings\&. .RE .PP +.SS "\fBalpm_handle_t\fP * alpm_pkg_get_handle (\fBalpm_pkg_t\fP * pkg)" + +.PP +Gets the handle of a package\&. +.PP +\fBParameters\fP +.RS 4 +\fIpkg\fP a pointer to package +.RE +.PP +\fBReturns\fP +.RS 4 +the alpm handle that the package belongs to +.RE +.PP + .SS "\fBalpm_time_t\fP alpm_pkg_get_installdate (\fBalpm_pkg_t\fP * pkg)" .PP @@ -986,6 +1037,22 @@ a reference to an internal string .RE .PP +.SS "\fBalpm_list_t\fP * alpm_pkg_get_xdata (\fBalpm_pkg_t\fP * pkg)" + +.PP +Gets the extended data field of a package\&. +.PP +\fBParameters\fP +.RS 4 +\fIpkg\fP a pointer to package +.RE +.PP +\fBReturns\fP +.RS 4 +a reference to a list of \fBalpm_pkg_xdata_t\fP objects +.RE +.PP + .SS "int alpm_pkg_has_scriptlet (\fBalpm_pkg_t\fP * pkg)" .PP |