libalpm_packages(3)

📦
version 7.1.0.r9.g54d9411 · 3 versions
, in arch rolling, epel 10, fedora 43, fedora 44

💖 libalpm_packages 💖

okay so bestie, welcome to the libalpm_packages page — straight out of the Library Functions Manual (libalpm_packages(3), iykyk). this is the whole package-handling corner of libalpm and honestly? it's giving main character energy. 🎀

✨ NAME ✨

libalpm_packages — Package Functions

  • Functions to manipulate libalpm packages 🫶

✨ SYNOPSIS ✨

🦋 Data Structures 🦋

  • struct alpm_pkg_xdata_t — the extended data type used to store non-standard package data fields.

🎀 Typedefs 🎀

  • typedef struct _alpm_pkg_t alpm_pkg_t — a package.

🌸 Enumerations 🌸

  • enum alpm_pkgreason_t { ALPM_PKG_REASON_EXPLICIT = 0, ALPM_PKG_REASON_DEPEND = 1, ALPM_PKG_REASON_UNKNOWN = 2 } — package install reasons.
  • enum alpm_pkgfrom_t { ALPM_PKG_FROM_FILE = 1, ALPM_PKG_FROM_LOCALDB, ALPM_PKG_FROM_SYNCDB } — location a package object was loaded from.
  • enum alpm_pkgvalidation_t { ALPM_PKG_VALIDATION_UNKNOWN = 0, ALPM_PKG_VALIDATION_NONE = (1 << 0), ALPM_PKG_VALIDATION_MD5SUM = (1 << 1), ALPM_PKG_VALIDATION_SHA256SUM = (1 << 2), ALPM_PKG_VALIDATION_SIGNATURE = (1 << 3) } — method used to validate a package.

🔥 Functions 🔥

  • int alpm_pkg_load (alpm_handle_t *handle, const char *filename, int full, int level, alpm_pkg_t **pkg) — create a package from a file.
  • int alpm_fetch_pkgurl (alpm_handle_t *handle, const alpm_list_t *urls, alpm_list_t **fetched) — fetch a list of remote packages.
  • alpm_pkg_t * alpm_pkg_find (alpm_list_t *haystack, const char *needle) — find a package in a list by name.
  • int alpm_pkg_free (alpm_pkg_t *pkg) — free a package.
  • int alpm_pkg_checkmd5sum (alpm_pkg_t *pkg) — check the integrity (with md5) of a package from the sync cache.
  • int alpm_pkg_vercmp (const char *a, const char *b) — compare two version strings and determine which one is 'newer'.
  • alpm_list_t * alpm_pkg_compute_requiredby (alpm_pkg_t *pkg) — computes the list of packages requiring a given package.
  • alpm_list_t * alpm_pkg_compute_optionalfor (alpm_pkg_t *pkg) — computes the list of packages optionally requiring a given package.
  • int alpm_pkg_should_ignore (alpm_handle_t *handle, alpm_pkg_t *pkg) — test if a package should be ignored.

👑 Package Property Accessors 👑

any pointer these functions hand back points to internal structures that libalpm allocated itself.

bestie, do not free them, do not modify them, in any way. that's the rule. 💅

for loaded packages, they get freed when alpm_pkg_free is called. for database packages, they get freed when the database is unregistered.

  • alpm_handle_t * alpm_pkg_get_handle (alpm_pkg_t *pkg) — gets the handle of a package.
  • const char * alpm_pkg_get_filename (alpm_pkg_t *pkg) — gets the name of the file from which the package was loaded.
  • const char * alpm_pkg_get_base (alpm_pkg_t *pkg) — returns the package base name.
  • const char * alpm_pkg_get_name (alpm_pkg_t *pkg) — returns the package name.
  • const char * alpm_pkg_get_version (alpm_pkg_t *pkg) — returns the package version as a string.
  • alpm_pkgfrom_t alpm_pkg_get_origin (alpm_pkg_t *pkg) — returns the origin of the package.
  • const char * alpm_pkg_get_desc (alpm_pkg_t *pkg) — returns the package description.
  • const char * alpm_pkg_get_url (alpm_pkg_t *pkg) — returns the package URL.
  • alpm_time_t alpm_pkg_get_builddate (alpm_pkg_t *pkg) — returns the build timestamp of the package.
  • alpm_time_t alpm_pkg_get_installdate (alpm_pkg_t *pkg) — returns the install timestamp of the package.
  • const char * alpm_pkg_get_packager (alpm_pkg_t *pkg) — returns the packager's name.
  • const char * alpm_pkg_get_md5sum (alpm_pkg_t *pkg) — returns the package's MD5 checksum as a string.
  • const char * alpm_pkg_get_sha256sum (alpm_pkg_t *pkg) — returns the package's SHA256 checksum as a string.
  • const char * alpm_pkg_get_arch (alpm_pkg_t *pkg) — returns the architecture for which the package was built.
  • off_t alpm_pkg_get_size (alpm_pkg_t *pkg) — returns the size of the package.
  • off_t alpm_pkg_get_isize (alpm_pkg_t *pkg) — returns the installed size of the package.
  • alpm_pkgreason_t alpm_pkg_get_reason (alpm_pkg_t *pkg) — returns the package installation reason.
  • alpm_list_t * alpm_pkg_get_licenses (alpm_pkg_t *pkg) — returns the list of package licenses.
  • alpm_list_t * alpm_pkg_get_groups (alpm_pkg_t *pkg) — returns the list of package groups.
  • alpm_list_t * alpm_pkg_get_depends (alpm_pkg_t *pkg) — returns the list of package dependencies as alpm_depend_t.
  • alpm_list_t * alpm_pkg_get_optdepends (alpm_pkg_t *pkg) — returns the list of package optional dependencies.
  • alpm_list_t * alpm_pkg_get_checkdepends (alpm_pkg_t *pkg) — returns a list of package check dependencies.
  • alpm_list_t * alpm_pkg_get_makedepends (alpm_pkg_t *pkg) — returns a list of package make dependencies.
  • alpm_list_t * alpm_pkg_get_conflicts (alpm_pkg_t *pkg) — returns the list of packages conflicting with pkg.
  • alpm_list_t * alpm_pkg_get_provides (alpm_pkg_t *pkg) — returns the list of packages provided by pkg.
  • alpm_list_t * alpm_pkg_get_replaces (alpm_pkg_t *pkg) — returns the list of packages to be replaced by pkg.
  • alpm_filelist_t * alpm_pkg_get_files (alpm_pkg_t *pkg) — returns the list of files installed by pkg.
  • alpm_list_t * alpm_pkg_get_backup (alpm_pkg_t *pkg) — returns the list of files backed up when installing pkg.
  • alpm_db_t * alpm_pkg_get_db (alpm_pkg_t *pkg) — returns the database containing pkg.
  • const char * alpm_pkg_get_base64_sig (alpm_pkg_t *pkg) — returns the base64 encoded package signature.
  • int alpm_pkg_get_sig (alpm_pkg_t *pkg, unsigned char **sig, size_t *sig_len) — extracts package signature either from embedded package signature or, if it is absent, then reads data from the detached signature file.
  • int alpm_pkg_get_validation (alpm_pkg_t *pkg) — returns the method used to validate a package during install.
  • alpm_list_t * alpm_pkg_get_xdata (alpm_pkg_t *pkg) — gets the extended data field of a package.
  • int alpm_pkg_has_scriptlet (alpm_pkg_t *pkg) — returns whether the package has an install scriptlet.
  • off_t alpm_pkg_download_size (alpm_pkg_t *newpkg) — returns the size of the files that will be downloaded to install a package.
  • int alpm_pkg_set_reason (alpm_pkg_t *pkg, alpm_pkgreason_t reason) — set install reason for a package in the local database.

📜 Changelog functions 📜

functions for reading the changelog 🌈

  • void * alpm_pkg_changelog_open (alpm_pkg_t *pkg) — open a package changelog for reading.
  • size_t alpm_pkg_changelog_read (void *ptr, size_t size, const alpm_pkg_t *pkg, void *fp) — read data from an open changelog 'file stream'.
  • int alpm_pkg_changelog_close (const alpm_pkg_t *pkg, void *fp) — close a package changelog for reading.

🌳 Mtree functions 🌳

functions for reading the mtree 🌿

  • struct archive * alpm_pkg_mtree_open (alpm_pkg_t *pkg) — open a package mtree file for reading.
  • int alpm_pkg_mtree_next (const alpm_pkg_t *pkg, struct archive *archive, struct archive_entry **entry) — read next entry from a package mtree file.
  • int alpm_pkg_mtree_close (const alpm_pkg_t *pkg, struct archive *archive) — close a package mtree file.

🌈 Detailed Description 🌈

functions to manipulate libalpm packages 🫶

💜 Data Structure Documentation 💜

struct alpm_pkg_xdata_t

the extended data type used to store non-standard package data fields. it's the lil bonus bucket. 🍓

Data Fields:

  • char * name
  • char * value

🧚 Typedef Documentation 🧚

typedef struct _alpm_pkg_t alpm_pkg_t

a package. a package can be loaded from disk via alpm_pkg_load, or it can be retrieved from a database. packages that came from databases are automatically freed when the database is unregistered — no takebacks needed. packages loaded from a file? those you must free manually, bestie, nobody's gonna do it for you. 😭

and once you've got one, you can query it for metadata, or add it to a transaction to be added to or removed from the system. iconic. ✨

🌸 Enumeration Type Documentation 🌸

enum alpm_pkgfrom_t

location a package object was loaded from. 📍

Enumerator

  • ALPM_PKG_FROM_FILE — loaded from a file via alpm_pkg_load.
  • ALPM_PKG_FROM_LOCALDB — from the local database.
  • ALPM_PKG_FROM_SYNCDB — from a sync database.

enum alpm_pkgreason_t

package install reasons. why is this thing here, fr fr 🤔

Enumerator

  • ALPM_PKG_REASON_EXPLICIT — explicitly requested by the user.
  • ALPM_PKG_REASON_DEPEND — installed as a dependency for another package.
  • ALPM_PKG_REASON_UNKNOWN — failed parsing of local database.

enum alpm_pkgvalidation_t

method used to validate a package. the vibe check, basically. ✅

Enumerator

  • ALPM_PKG_VALIDATION_UNKNOWN — the package's validation type is unknown.
  • ALPM_PKG_VALIDATION_NONE — the package does not have any validation.
  • ALPM_PKG_VALIDATION_MD5SUM — the package is validated with md5.
  • ALPM_PKG_VALIDATION_SHA256SUM — the package is validated with sha256.
  • ALPM_PKG_VALIDATION_SIGNATURE — the package is validated with a PGP signature.

🔥 Function Documentation 🔥

int alpm_fetch_pkgurl (alpm_handle_t * handle, const alpm_list_t * urls, alpm_list_t ** fetched)

fetch a list of remote packages. go get 'em. 🏃‍♀️

Parameters

  • handle — the context handle
  • urls — list of package URLs to download
  • fetched — list of filepaths to the fetched packages, each item corresponds to one in the urls list. this is an output parameter, so the caller should provide a pointer to an empty list (*fetched === NULL) and the callee fills the list with data. don't you dare pre-fill it. 🙈

Returns

0 on success or -1 on failure

int alpm_pkg_changelog_close (const alpm_pkg_t * pkg, void * fp)

close a package changelog for reading. bye bestie 👋

Parameters

  • pkg — the package to close the changelog of (either file or db)
  • fp — the 'file stream' to the package changelog to close

Returns

0 on success, -1 on error

void * alpm_pkg_changelog_open (alpm_pkg_t * pkg)

open a package changelog for reading. it's similar to fopen in functionality, except that the returned 'file stream' could really be from an archive as well as from the database. plot twist. 😮

Parameters

  • pkg — the package to read the changelog of (either file or db)

Returns

a 'file stream' to the package changelog

size_t alpm_pkg_changelog_read (void * ptr, size_t size, const alpm_pkg_t * pkg, void * fp)

read data from an open changelog 'file stream'. similar to fread in functionality — this function takes a buffer and an amount of data to read. if an error occurs, pm_errno will be set. 👀

Parameters

  • ptr — a buffer to fill with raw changelog data
  • size — the size of the buffer
  • pkg — the package that the changelog is being read from
  • fp — a 'file stream' to the package changelog

Returns

the number of characters read, or 0 if there is no more data or an error occurred.

int alpm_pkg_checkmd5sum (alpm_pkg_t * pkg)

check the integrity (with md5) of a package from the sync cache. 🔍

Parameters

  • pkg — package pointer
  • Returns — 0 when it slays (success), -1 when it doesn't (error, and pm_errno gets set accordingly). 💅

🌈 alpm_list_t * alpm_pkg_compute_optionalfor (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_compute_optionalfor (alpm_pkg_t * pkg)

Computes the list of packages that optionally require a given package. Bestie, the thing this hands back is a newly allocated list of package names (char*), and you — yes you, the caller — have to free it. No one else is coming to clean that up for you. 🧹✨

Parameters

  • pkg — a package

Returns

  • the list of packages optionally requiring pkg 🫶

🌸 alpm_list_t * alpm_pkg_compute_requiredby (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_compute_requiredby (alpm_pkg_t * pkg)

Computes the list of packages that actually require a given package — the hard requirement girlies, not the optional ones. Same deal as above: the return value is a newly allocated list of package names (char*) and it should be freed by the caller. Periodt. 💖

Parameters

  • pkg — a package

Returns

  • the list of packages requiring pkg 🔥

🦋 off_t alpm_pkg_download_size (alpm_pkg_t * newpkg)

off_t alpm_pkg_download_size (alpm_pkg_t * newpkg)

Tells you how many bytes of files are gonna get downloaded to install a package. Like, the actual download weight. 📦⬇️

Parameters

  • newpkg — the new package to upgrade to

Returns

  • the size of the download 📏

💜 alpm_pkg_t * alpm_pkg_find (alpm_list_t * haystack, const char * needle)

alpm_pkg_t * alpm_pkg_find (alpm_list_t * haystack, const char * needle)

Find a package in a list, by name. Classic needle-in-a-haystack situation but the haystack is a list of packages and honestly it's giving search energy. 🔍

Parameters

  • haystack — a list of alpm_pkg_t
  • needle — the package name

Returns

  • a pointer to the package if found, or NULL 😭

🎀 int alpm_pkg_free (alpm_pkg_t * pkg)

int alpm_pkg_free (alpm_pkg_t * pkg)

Frees a package. Heads up though: only packages loaded with alpm_pkg_load can be freed by you. Packages that came from databases? Those get freed by libalpm itself when they're unregistered. So don't go freeing things that aren't yours to free, bestie, that's not the vibe. 🙈

Parameters

  • pkg — package pointer to free

Returns

  • 0 on success, -1 on error (pm_errno is set accordingly)

✨ const char * alpm_pkg_get_arch (alpm_pkg_t * pkg)

const char * alpm_pkg_get_arch (alpm_pkg_t * pkg)

Returns the architecture the package was built for. 🏗️

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

🌈 alpm_list_t * alpm_pkg_get_backup (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_backup (alpm_pkg_t * pkg)

Returns the list of files that get backed up when installing pkg. Keep those safe, they're precious. 💾

Parameters

  • pkg — a pointer to package

Returns

  • a reference to a list of alpm_backup_t objects

🌸 const char * alpm_pkg_get_base (alpm_pkg_t * pkg)

const char * alpm_pkg_get_base (alpm_pkg_t * pkg)

Returns the package base name. The main character it was built from. 👑

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

🦋 const char * alpm_pkg_get_base64_sig (alpm_pkg_t * pkg)

const char * alpm_pkg_get_base64_sig (alpm_pkg_t * pkg)

Returns the base64 encoded package signature. Encoded and ready. 🔐

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

💜 alpm_time_t alpm_pkg_get_builddate (alpm_pkg_t * pkg)

alpm_time_t alpm_pkg_get_builddate (alpm_pkg_t * pkg)

Returns the build timestamp of the package — when it was born, basically. 🎂

Parameters

  • pkg — a pointer to package

Returns

  • the timestamp of the build time ⏰

🎀 alpm_list_t * alpm_pkg_get_checkdepends (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_checkdepends (alpm_pkg_t * pkg)

Returns a list of package check dependencies. The ones you need for testing, iykyk. 🧪

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal list of alpm_depend_t structures

✨ alpm_list_t * alpm_pkg_get_conflicts (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_conflicts (alpm_pkg_t * pkg)

Returns the list of packages that conflict with pkg. It's giving drama, but the technical kind. 💀

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal list of alpm_depend_t structures

🌈 alpm_db_t * alpm_pkg_get_db (alpm_pkg_t * pkg)

alpm_db_t * alpm_pkg_get_db (alpm_pkg_t * pkg)

Returns the database containing pkg. Specifically it hands you a pointer to the alpm_db_t structure the package is originating from — or NULL if the package was loaded from a file. So if you get NULL, don't panic, it just means the package isn't a database girlie. 🗄️

Parameters

  • pkg — a pointer to package

Returns

  • a pointer to the DB containing pkg, or NULL.

🌸 alpm_list_t * alpm_pkg_get_depends (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_depends (alpm_pkg_t * pkg)

Returns the list of package dependencies as alpm_depend_t. The whole squad it needs. 💅

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal list of alpm_depend_t structures

🦋 const char * alpm_pkg_get_desc (alpm_pkg_t * pkg)

const char * alpm_pkg_get_desc (alpm_pkg_t * pkg)

Returns the package description. The little bio. 📝

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

💜 const char * alpm_pkg_get_filename (alpm_pkg_t * pkg)

const char * alpm_pkg_get_filename (alpm_pkg_t * pkg)

Gets the name of the file from which the package was loaded. Where it came from. 📁

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

🎀 alpm_filelist_t * alpm_pkg_get_files (alpm_pkg_t * pkg)

alpm_filelist_t * alpm_pkg_get_files (alpm_pkg_t * pkg)

Returns the list of files installed by pkg. Important detail: the filenames are relative to the install root, and they do not include leading slashes. So no / at the front, okay bestie? 🚫

Parameters

  • pkg — a pointer to package

Returns

  • a pointer to a filelist object containing a count and an array of package file objects

✨ alpm_list_t * alpm_pkg_get_groups (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_groups (alpm_pkg_t * pkg)

Returns the list of package groups. The cliques it runs with. 👯

Parameters

  • pkg — a pointer to package

Returns

  • a pointer to an internal list of strings.

🌈 alpm_handle_t * alpm_pkg_get_handle (alpm_pkg_t * pkg)

alpm_handle_t * alpm_pkg_get_handle (alpm_pkg_t * pkg)

Gets the handle of a package. Every package has a home handle and this is how you find it. 🏠

Parameters

  • pkg — a pointer to package

Returns

  • the alpm handle that the package belongs to

🌸 alpm_time_t alpm_pkg_get_installdate (alpm_pkg_t * pkg)

alpm_time_t alpm_pkg_get_installdate (alpm_pkg_t * pkg)

Returns the install timestamp of the package — when it actually moved in. 📦🏡

Parameters

  • pkg — a pointer to package

Returns

  • the timestamp of the install time ⏰

🦋 off_t alpm_pkg_get_isize (alpm_pkg_t * pkg)

off_t alpm_pkg_get_isize (alpm_pkg_t * pkg)

Returns the installed size of the package. How much space it's taking up once it's settled in. 📐

Parameters

  • pkg — a pointer to package

Returns

  • the total size of files installed by the package.

💜 alpm_list_t * alpm_pkg_get_licenses (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_licenses (alpm_pkg_t * pkg)

Returns the list of package licenses. Legal girlie behavior. ⚖️

Parameters

  • pkg — a pointer to package

Returns

  • a pointer to an internal list of strings.

🎀 alpm_list_t * alpm_pkg_get_makedepends (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_makedepends (alpm_pkg_t * pkg)

Returns a list of package make dependencies. The build-time besties. 🔨

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal list of alpm_depend_t structures

✨ const char * alpm_pkg_get_md5sum (alpm_pkg_t * pkg)

const char * alpm_pkg_get_md5sum (alpm_pkg_t * pkg)

Returns the package's MD5 checksum as a string. Fun fact: the returned string is a sequence of 32 lowercase hexadecimal digits. Count them if you want, they're all there. 🔢

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

🌈 const char * alpm_pkg_get_name (alpm_pkg_t * pkg)

const char * alpm_pkg_get_name (alpm_pkg_t * pkg)

Returns the package name. The whole identity. 🪪

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

🌸 alpm_list_t * alpm_pkg_get_optdepends (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_optdepends (alpm_pkg_t * pkg)

Returns the list of package optional dependencies. The "would be nice but not required" girlies. 🫶

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal list of alpm_depend_t structures

🦋 alpm_pkgfrom_t alpm_pkg_get_origin (alpm_pkg_t * pkg)

alpm_pkgfrom_t alpm_pkg_get_origin (alpm_pkg_t * pkg)

Returns the origin of the package. Where it's from, its lore. 🌍

Returns

  • an alpm_pkgfrom_t constant, -1 on error

💜 const char * alpm_pkg_get_packager (alpm_pkg_t * pkg)

const char * alpm_pkg_get_packager (alpm_pkg_t * pkg)

Returns the packager's name. Credit where credit is due. 🏆

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

🎀 alpm_list_t * alpm_pkg_get_provides (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_provides (alpm_pkg_t * pkg)

Returns the list of packages provided by pkg. It's giving "I can be that for you". 💁‍♀️

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal list of alpm_depend_t structures

✨ alpm_pkgreason_t alpm_pkg_get_reason (alpm_pkg_t * pkg)

alpm_pkgreason_t alpm_pkg_get_reason (alpm_pkg_t * pkg)

Returns the package installation reason. Why is it here? We asked, and it answered. 🧐

Parameters

  • pkg — a pointer to package

Returns

  • an enum member giving the install reason.

🌈 alpm_list_t * alpm_pkg_get_replaces (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_replaces (alpm_pkg_t * pkg)

Returns the list of packages to be replaced by pkg. Out with the old, in with the new. 🔄

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal list of alpm_depend_t structures

🌸 const char * alpm_pkg_get_sha256sum (alpm_pkg_t * pkg)

const char * alpm_pkg_get_sha256sum (alpm_pkg_t * pkg)

Returns the package's SHA256 checksum as a string. And because more digits = more drama, this one is a sequence of 64 lowercase hexadecimal digits. Double the MD5, double the fun. 🔐

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

🦋 int alpm_pkg_get_sig (alpm_pkg_t * pkg, unsigned char ** sig, size_t * sig_len)

int alpm_pkg_get_sig (alpm_pkg_t * pkg, unsigned char ** sig, size_t * sig_len)

Extracts the package signature — either from the embedded package signature, or if that's absent, it reads the data from the detached signature file instead. Either way, you're getting that signature. 🔏

Parameters

  • pkg — a pointer to package.
  • sig — output parameter for signature data. The callee function allocates a buffer needed for the signature data. Caller is responsible for freeing this buffer. Yes, that means you. 👀
  • sig_len — output parameter for the signature data length.

Returns

  • 0 on success, a negative number on error.

💜 off_t alpm_pkg_get_size (alpm_pkg_t * pkg)

off_t alpm_pkg_get_size (alpm_pkg_t * pkg)

Returns the size of the package. But heads up: this is only available for sync database packages and package files — not those loaded from the local database. So if you're getting nothing, that's why, bestie. 🚫

Parameters

  • pkg — a pointer to package

Returns

  • the size of the package in bytes.

🎀 const char * alpm_pkg_get_url (alpm_pkg_t * pkg)

const char * alpm_pkg_get_url (alpm_pkg_t * pkg)

Returns the package URL. The link in the bio. 🔗

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

✨ int alpm_pkg_get_validation (alpm_pkg_t * pkg)

int alpm_pkg_get_validation (alpm_pkg_t * pkg)

Returns the method used to validate a package during install. The vibe check it passes through. ✅

Parameters

  • pkg — a pointer to package

Returns

  • an enum member giving the validation method

🌈 const char * alpm_pkg_get_version (alpm_pkg_t * pkg)

const char * alpm_pkg_get_version (alpm_pkg_t * pkg)

Returns the package version as a string. Key detail: this includes all available epoch, version, and pkgrel components. And if you need to compare version strings, use alpm_pkg_vercmp() for that, don't try to do it yourself. 🔢

Parameters

  • pkg — a pointer to package

Returns

  • a reference to an internal string

🌸 alpm_list_t * alpm_pkg_get_xdata (alpm_pkg_t * pkg)

alpm_list_t * alpm_pkg_get_xdata (alpm_pkg_t * pkg)

Gets the extended data field of a package. The bonus content. 🌟

Parameters

  • pkg — a pointer to package

Returns

  • a reference to a list of alpm_pkg_xdata_t objects

🦋 int alpm_pkg_has_scriptlet (alpm_pkg_t * pkg)

int alpm_pkg_has_scriptlet (alpm_pkg_t * pkg)

Returns whether the package has an install scriptlet. Yes or no, does it have a little script moment. 📜

Returns

  • 0 if FALSE, TRUE otherwise

💜 int alpm_pkg_load (alpm_handle_t * handle, const char * filename, int full, int level, alpm_pkg_t ** pkg)

int alpm_pkg_load (alpm_handle_t * handle, const char * filename, int full, int level, alpm_pkg_t ** pkg)

Create a package from a file. ✨ Here's the tea: if full is false, the archive is read only until all necessary metadata is found. If it's true, the entire archive is read — which serves as a verification of integrity and the filelist can be created. And the allocated structure? Free it using alpm_pkg_free(). Don't leave it hanging. 🫶

Parameters

  • handle — the context handle
  • filename — location of the package tarball
  • full — whether to stop the load after metadata is read, or continue through the full archive
  • level — what level of package signature checking to perform on the package; note that this must be a .sig file type verification
  • pkg — address of the package pointer

Returns

  • 0 on success, -1 on error (pm_errno is set accordingly)

🎀 int alpm_pkg_mtree_close (const alpm_pkg_t * pkg, struct archive * archive)

int alpm_pkg_mtree_close (const alpm_pkg_t * pkg, struct archive * archive)

Close a package mtree file. Wrapping it up, saying goodbye. 👋

Parameters

  • pkg — the local package to close the mtree of
  • archive — the archive to close

✨ int alpm_pkg_mtree_next (const alpm_pkg_t * pkg, struct archive * archive, struct archive_entry ** entry)

int alpm_pkg_mtree_next (const alpm_pkg_t * pkg, struct archive * archive, struct archive_entry ** entry)

Read the next entry from a package mtree file. Next, please. ➡️

💖 Parameters 💖

  • pkg — the package that the mtree file is being read from 🎀
  • archive — the archive structure reading from the mtree file
  • entry — an archive_entry to store the entry header information

💖 Returns 💖

0 on success, 1 if end of archive is reached, -1 otherwise. Slay.

🌸 struct archive * alpm_pkg_mtree_open (alpm_pkg_t * pkg) 🌸

Open a package mtree file for reading. bestie we are literally opening the thing. 🔓

Parameters

  • pkg — the local package to read the mtree of

Returns

an archive structure for the package mtree file. it's giving "here's your handle, go wild" ✨

🦋 int alpm_pkg_set_reason (alpm_pkg_t * pkg, alpm_pkgreason_t reason) 🦋

Set install reason for a package in the local database.

🚨 okay so this is the important bit: the provided package object must be from the local database or this method will fail. no cap.

The write to the local database is performed immediately. like, no queue, no vibe check, it just goes. 💅

Parameters

  • pkg — the package to update
  • reason — the new install reason

Returns

0 on success, -1 on error (pm_errno is set accordingly). if you get -1, go read pm_errno, she's trying to tell you something 😭

🌈 int alpm_pkg_should_ignore (alpm_handle_t * handle, alpm_pkg_t * pkg) 🌈

Test if a package should be ignored. 🔍

She checks if the package is ignored via IgnorePkg, or if the package is in a group ignored via IgnoreGroup. two whole ways to get ignored, main character energy fr.

Parameters

  • handle — the context handle
  • pkg — the package to test

Returns

1 if the package should be ignored, 0 otherwise. simple as that. periodt. 💖

⭐ int alpm_pkg_vercmp (const char * a, const char * b) ⭐

Compare two version strings and determine which one is 'newer'. 🔥

Returns a value comparable to the way strcmp works. So: returns 1 if a is newer than b, 0 if a and b are the same version, or -1 if b is newer than a. classic three-way girlie behavior, we love her.

Different epoch values for version strings will override any further comparison. If no epoch is provided, 0 is assumed. 👑

💀 Keep in mind that the pkgrel is only compared if it is available on both versions handed to this function. For example, comparing 1.5-1 and 1.5 will yield 0; comparing 1.5-1 and 1.5-2 will yield -1 as expected. This is mainly for supporting versioned dependencies that do not include the pkgrel. iykyk 🙈

🧚 Author 🧚

Generated automatically by Doxygen for libalpm from the source code.

and that's the whole page bestie!! 🫶 this one came from the libalpm source and she's dated with the libalpm version stamp, and the footer literally just says libalpm + libalpm_packages(3) like a lil name tag at the bottom of the page. so iconic of her honestly. go forth and vercmp responsibly 💅✨🌸

📦 where this page comes from