[][src]Crate alpm_sys_fork

Modules

_alpm_db_usage_
_alpm_loglevel_t
_alpm_pkgvalidation_t
_alpm_question_type_t
_alpm_siglevel_t
_alpm_transflag_t
alpm_caps

Structs

__alpm_list_t
__va_list_tag
_alpm_backup_t

Local package or package file backup entry

_alpm_conflict_t

Conflict

_alpm_delta_t

Package upgrade delta

_alpm_depend_t

Dependency

_alpm_depmissing_t

Missing dependency

_alpm_event_any_t
_alpm_event_database_missing_t
_alpm_event_delta_patch_t
_alpm_event_hook_run_t
_alpm_event_hook_t
_alpm_event_optdep_removal_t
_alpm_event_package_operation_t
_alpm_event_pacnew_created_t
_alpm_event_pacsave_created_t
_alpm_event_pkgdownload_t
_alpm_event_scriptlet_info_t
_alpm_file_t

File in a package

_alpm_fileconflict_t

File conflict

_alpm_filelist_t

Package filelist container

_alpm_group_t

Package group

_alpm_pgpkey_t
_alpm_question_any_t
_alpm_question_conflict_t
_alpm_question_corrupted_t
_alpm_question_import_key_t
_alpm_question_install_ignorepkg_t
_alpm_question_remove_pkgs_t
_alpm_question_replace_t
_alpm_question_select_provider_t
_alpm_siglist_t

Signature list. Contains the number of signatures found and a pointer to an array of results. The array is of size count.

_alpm_sigresult_t

Signature result. Contains the key, status, and validity of a given signature.

archive
archive_entry

Enums

_alpm_depmod_t

Types of version constraints in dependency specs.

_alpm_errno_t

@addtogroup alpm_api_errors Error Codes @{

_alpm_event_type_t

Type of events.

_alpm_fileconflicttype_t

File conflict type. Whether the conflict results from a file existing on the filesystem, or with another target in the transaction.

_alpm_hook_when_t
_alpm_package_operation_t
_alpm_pkgfrom_t

Location a package object was loaded from.

_alpm_pkgreason_t

Package install reasons.

_alpm_progress_t

Progress

_alpm_sigstatus_t

PGP signature verification status return codes

_alpm_sigvalidity_t

PGP signature verification status return codes

alpm_depmod_t

Types of version constraints in dependency specs.

alpm_errno_t

@addtogroup alpm_api_errors Error Codes @{

alpm_event_type_t

Type of events.

alpm_fileconflicttype_t

File conflict type. Whether the conflict results from a file existing on the filesystem, or with another target in the transaction.

alpm_hook_when_t
alpm_package_operation_t
alpm_pkgfrom_t

Location a package object was loaded from.

alpm_pkgreason_t

Package install reasons.

alpm_progress_t

Progress

alpm_sigstatus_t

PGP signature verification status return codes

alpm_sigvalidity_t

PGP signature verification status return codes

Functions

alpm_add_pkg

Add a package to the transaction. If the package was loaded by alpm_pkg_load(), it will be freed upon alpm_trans_release() invocation. @param handle the context handle @param pkg the package to add @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_capabilities
alpm_checkconflicts
alpm_checkdeps

@addtogroup alpm_api_depends Dependency Functions Functions dealing with libalpm representation of dependency information. @{

alpm_compute_md5sum

@}

alpm_compute_sha256sum
alpm_conflict_free
alpm_db_add_server
alpm_db_check_pgp_signature
alpm_db_get_group

Get a group entry from a package database. @param db pointer to the package database to get the group from @param name of the group @return the groups entry on success, NULL on error

alpm_db_get_groupcache

Get the group cache of a package database. @param db pointer to the package database to get the group from @return the list of groups on success, NULL on error

alpm_db_get_name

Get the name of a package database. @param db pointer to the package database @return the name of the package database, NULL on error

alpm_db_get_pkg

Get a package entry from a package database. @param db pointer to the package database to get the package from @param name of the package @return the package entry on success, NULL on error

alpm_db_get_pkgcache

Get the package cache of a package database. @param db pointer to the package database to get the package from @return the list of packages on success, NULL on error

alpm_db_get_servers

@name Accessors to the list of servers for a database. @{

alpm_db_get_siglevel

Get the signature verification level for a database. Will return the default verification level if this database is set up with ALPM_SIG_USE_DEFAULT. @param db pointer to the package database @return the signature verification level

alpm_db_get_usage

Gets the usage of a database. @param db pointer to the package database to get the status of @param usage pointer to an alpm_db_usage_t to store db's status @return 0 on success, or -1 on error

alpm_db_get_valid

Check the validity of a database. This is most useful for sync databases and verifying signature status. If invalid, the handle error code will be set accordingly. @param db pointer to the package database @return 0 if valid, -1 if invalid (pm_errno is set accordingly)

alpm_db_remove_server
alpm_db_search

Searches a database with regular expressions. @param db pointer to the package database to search in @param needles a list of regular expressions to search for @return the list of packages matching all regular expressions on success, NULL on error

alpm_db_set_servers
alpm_db_set_usage

Sets the usage of a database. @param db pointer to the package database to set the status for @param usage a bitmask of alpm_db_usage_t values @return 0 on success, or -1 on error

alpm_db_unregister

Unregister a package database. @param db pointer to the package database to unregister @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_db_update

@}

alpm_decode_signature
alpm_dep_compute_string

Returns a newly allocated string representing the dependency information. @param dep a dependency info structure @return a formatted string, e.g. "glibc>=2.12"

alpm_dep_free

Free a dependency info structure @param dep struct to free

alpm_dep_from_string

Return a newly allocated dependency information parsed from a string @param depstring a formatted string, e.g. "glibc=2.12" @return a dependency info structure

alpm_depmissing_free
alpm_errno

Returns the current error code from the handle.

alpm_extract_keyid
alpm_fetch_pkgurl

Fetch a remote pkg. @param handle the context handle @param url URL of the package to download @return the downloaded filepath on success, NULL on error

alpm_fileconflict_free
alpm_filelist_contains

Determines whether a package filelist contains a given path. The provided path should be relative to the install root with no leading slashes, e.g. "etc/localtime". When searching for directories, the path must have a trailing slash. @param filelist a pointer to a package filelist @param path the path to search for in the package @return a pointer to the matching file or NULL if not found

alpm_find_dbs_satisfier
alpm_find_group_pkgs
alpm_find_satisfier
alpm_get_localdb

Get the database of locally installed packages. The returned pointer points to an internal structure of libalpm which should only be manipulated through libalpm functions. @return a reference to the local database

alpm_get_syncdbs

Get the list of sync databases. Returns a list of alpm_db_t structures, one for each registered sync database. @param handle the context handle @return a reference to an internal list of alpm_db_t structures

alpm_initialize
alpm_list_add
alpm_list_add_sorted
alpm_list_append
alpm_list_append_strdup
alpm_list_copy
alpm_list_copy_data
alpm_list_count
alpm_list_diff
alpm_list_diff_sorted
alpm_list_find
alpm_list_find_ptr
alpm_list_find_str
alpm_list_free
alpm_list_free_inner
alpm_list_join
alpm_list_last
alpm_list_mmerge
alpm_list_msort
alpm_list_next
alpm_list_nth
alpm_list_previous
alpm_list_remove
alpm_list_remove_dupes
alpm_list_remove_item
alpm_list_remove_str
alpm_list_reverse
alpm_list_strdup
alpm_list_to_array
alpm_logaction
alpm_option_add_assumeinstalled
alpm_option_add_cachedir
alpm_option_add_hookdir
alpm_option_add_ignoregroup
alpm_option_add_ignorepkg
alpm_option_add_noextract
alpm_option_add_noupgrade
alpm_option_add_overwrite_file
alpm_option_get_arch

Returns the targeted architecture.

alpm_option_get_assumeinstalled

@name Accessors to the list of ignored dependencies. These functions modify the list of dependencies that should be ignored by a sysupgrade. @{

alpm_option_get_cachedirs

@name Accessors to the list of package cache directories. @{

alpm_option_get_checkspace
alpm_option_get_dbext
alpm_option_get_dbpath

Returns the path to the database directory. Read-only.

alpm_option_get_default_siglevel
alpm_option_get_deltaratio
alpm_option_get_dlcb

Returns the callback used to report download progress.

alpm_option_get_eventcb

Returns the callback used for events.

alpm_option_get_fetchcb

Returns the downloading callback.

alpm_option_get_gpgdir

Returns the path to libalpm's GnuPG home directory.

alpm_option_get_hookdirs

@name Accessors to the list of package hook directories. @{

alpm_option_get_ignoregroups

@name Accessors to the list of ignored groups. These functions modify the list of groups whose packages should be ignored by a sysupgrade. @{

alpm_option_get_ignorepkgs

@name Accessors to the list of ignored packages. These functions modify the list of packages that should be ignored by a sysupgrade. @{

alpm_option_get_local_file_siglevel
alpm_option_get_lockfile

Get the name of the database lock file. Read-only.

alpm_option_get_logcb

Returns the callback used for logging.

alpm_option_get_logfile

Returns the logfile name.

alpm_option_get_noextracts

@name Accessors to the list of no-extract files. These functions modify the list of filenames which should be skipped packages which should not be upgraded by a sysupgrade operation. @{

alpm_option_get_noupgrades

@name Accessors to the list of no-upgrade files. These functions modify the list of files which should not be updated by package installation. @{

alpm_option_get_overwrite_files

@}

alpm_option_get_progresscb

Returns the callback used for operation progress.

alpm_option_get_questioncb

Returns the callback used for questions.

alpm_option_get_remote_file_siglevel
alpm_option_get_root

Returns the root of the destination filesystem. Read-only.

alpm_option_get_totaldlcb

Returns the callback used to report total download size.

alpm_option_get_usesyslog

Returns whether to use syslog (0 is FALSE, TRUE otherwise).

alpm_option_match_noextract
alpm_option_match_noupgrade
alpm_option_remove_assumeinstalled
alpm_option_remove_cachedir
alpm_option_remove_hookdir
alpm_option_remove_ignoregroup
alpm_option_remove_ignorepkg
alpm_option_remove_noextract
alpm_option_remove_noupgrade
alpm_option_remove_overwrite_file
alpm_option_set_arch

Sets the targeted architecture.

alpm_option_set_assumeinstalled
alpm_option_set_cachedirs
alpm_option_set_checkspace
alpm_option_set_dbext
alpm_option_set_default_siglevel
alpm_option_set_deltaratio
alpm_option_set_disable_dl_timeout
alpm_option_set_dlcb

Sets the callback used to report download progress.

alpm_option_set_eventcb

Sets the callback used for events.

alpm_option_set_fetchcb

Sets the downloading callback.

alpm_option_set_gpgdir

Sets the path to libalpm's GnuPG home directory.

alpm_option_set_hookdirs
alpm_option_set_ignoregroups
alpm_option_set_ignorepkgs
alpm_option_set_local_file_siglevel
alpm_option_set_logcb

Sets the callback used for logging.

alpm_option_set_logfile

Sets the logfile name.

alpm_option_set_noextracts
alpm_option_set_noupgrades
alpm_option_set_overwrite_files
alpm_option_set_progresscb

Sets the callback used for operation progress.

alpm_option_set_questioncb

Sets the callback used for questions.

alpm_option_set_remote_file_siglevel
alpm_option_set_totaldlcb

Sets the callback used to report total download size.

alpm_option_set_usesyslog

Sets whether to use syslog (0 is FALSE, TRUE otherwise).

alpm_pkg_changelog_close
alpm_pkg_changelog_open

Open a package changelog for reading. Similar to fopen in functionality, except that the returned 'file stream' could really be from an archive as well as from the database. @param pkg the package to read the changelog of (either file or db) @return a 'file stream' to the package changelog

alpm_pkg_changelog_read

Read data from an open changelog 'file stream'. Similar to fread in functionality, this function takes a buffer and amount of data to read. If an error occurs pm_errno will be set. @param ptr a buffer to fill with raw changelog data @param size the size of the buffer @param pkg the package that the changelog is being read from @param fp a 'file stream' to the package changelog @return the number of characters read, or 0 if there is no more data or an error occurred.

alpm_pkg_check_pgp_signature
alpm_pkg_checkmd5sum

Check the integrity (with md5) of a package from the sync cache. @param pkg package pointer @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_pkg_compute_optionalfor

Computes the list of packages optionally requiring a given package. The return value of this function is a newly allocated list of package names (char*), it should be freed by the caller. @param pkg a package @return the list of packages optionally requiring pkg

alpm_pkg_compute_requiredby

Computes the list of packages requiring a given package. The return value of this function is a newly allocated list of package names (char*), it should be freed by the caller. @param pkg a package @return the list of packages requiring pkg

alpm_pkg_download_size

Returns the size of download. Returns the size of the files that will be downloaded to install a package. @param newpkg the new package to upgrade to @return the size of the download

alpm_pkg_find

Find a package in a list by name. @param haystack a list of alpm_pkg_t @param needle the package name @return a pointer to the package if found or NULL

alpm_pkg_free

Free a package. @param pkg package pointer to free @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_pkg_get_arch

Returns the architecture for which the package was built. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_backup

Returns the list of files backed up when installing pkg. @param pkg a pointer to package @return a reference to a list of alpm_backup_t objects

alpm_pkg_get_base

Returns the package base name. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_base64_sig

Returns the base64 encoded package signature. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_builddate

Returns the build timestamp of the package. @param pkg a pointer to package @return the timestamp of the build time

alpm_pkg_get_checkdepends

Returns a list of package check dependencies @param pkg a pointer to package @return a reference to an internal list of alpm_depend_t structures.

alpm_pkg_get_conflicts

Returns the list of packages conflicting with pkg. @param pkg a pointer to package @return a reference to an internal list of alpm_depend_t structures.

alpm_pkg_get_db

Returns the database containing pkg. Returns a pointer to the alpm_db_t structure the package is originating from, or NULL if the package was loaded from a file. @param pkg a pointer to package @return a pointer to the DB containing pkg, or NULL.

alpm_pkg_get_deltas

Returns the list of available deltas for pkg. @param pkg a pointer to package @return a reference to an internal list of strings.

alpm_pkg_get_depends

Returns the list of package dependencies as alpm_depend_t. @param pkg a pointer to package @return a reference to an internal list of alpm_depend_t structures.

alpm_pkg_get_desc

Returns the package description. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_filename

Gets the name of the file from which the package was loaded. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_files

Returns the list of files installed by pkg. The filenames are relative to the install root, and do not include leading slashes. @param pkg a pointer to package @return a pointer to a filelist object containing a count and an array of package file objects

alpm_pkg_get_groups

Returns the list of package groups. @param pkg a pointer to package @return a pointer to an internal list of strings.

alpm_pkg_get_installdate

Returns the install timestamp of the package. @param pkg a pointer to package @return the timestamp of the install time

alpm_pkg_get_isize

Returns the installed size of the package. @param pkg a pointer to package @return the total size of files installed by the package.

alpm_pkg_get_licenses

Returns the list of package licenses. @param pkg a pointer to package @return a pointer to an internal list of strings.

alpm_pkg_get_makedepends

Returns a list of package make dependencies @param pkg a pointer to package @return a reference to an internal list of alpm_depend_t structures.

alpm_pkg_get_md5sum

Returns the package's MD5 checksum as a string. The returned string is a sequence of 32 lowercase hexadecimal digits. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_name

Returns the package name. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_optdepends

Returns the list of package optional dependencies. @param pkg a pointer to package @return a reference to an internal list of alpm_depend_t structures.

alpm_pkg_get_origin

Returns the origin of the package. @return an alpm_pkgfrom_t constant, -1 on error

alpm_pkg_get_packager

Returns the packager's name. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_provides

Returns the list of packages provided by pkg. @param pkg a pointer to package @return a reference to an internal list of alpm_depend_t structures.

alpm_pkg_get_reason

Returns the package installation reason. @param pkg a pointer to package @return an enum member giving the install reason.

alpm_pkg_get_replaces

Returns the list of packages to be replaced by pkg. @param pkg a pointer to package @return a reference to an internal list of alpm_depend_t structures.

alpm_pkg_get_sha256sum

Returns the package's SHA256 checksum as a string. The returned string is a sequence of 64 lowercase hexadecimal digits. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_size

Returns the size of the package. This is only available for sync database packages and package files, not those loaded from the local database. @param pkg a pointer to package @return the size of the package in bytes.

alpm_pkg_get_url

Returns the package URL. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_get_validation

Returns the method used to validate a package during install. @param pkg a pointer to package @return an enum member giving the validation method

alpm_pkg_get_version

Returns the package version as a string. This includes all available epoch, version, and pkgrel components. Use alpm_pkg_vercmp() to compare version strings if necessary. @param pkg a pointer to package @return a reference to an internal string

alpm_pkg_has_scriptlet

Returns whether the package has an install scriptlet. @return 0 if FALSE, TRUE otherwise

alpm_pkg_load

Create a package from a file. If full is false, the archive is read only until all necessary metadata is found. If it is true, the entire archive is read, which serves as a verification of integrity and the filelist can be created. The allocated structure should be freed using alpm_pkg_free(). @param handle the context handle @param filename location of the package tarball @param full whether to stop the load after metadata is read or continue through the full archive @param level what level of package signature checking to perform on the package; note that this must be a '.sig' file type verification @param pkg address of the package pointer @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_pkg_mtree_close
alpm_pkg_mtree_next

Read next entry from a package mtree file. @param pkg the package that the mtree file is being read from @param archive the archive structure reading from the mtree file @param entry an archive_entry to store the entry header information @return 0 if end of archive is reached, non-zero otherwise.

alpm_pkg_mtree_open

Open a package mtree file for reading. @param pkg the local package to read the changelog of @return a archive structure for the package mtree file

alpm_pkg_set_reason

Set install reason for a package in the local database. The provided package object must be from the local database or this method will fail. The write to the local database is performed immediately. @param pkg the package to update @param reason the new install reason @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_pkg_should_ignore

Test if a package should be ignored. Checks if the package is ignored via IgnorePkg, or if the package is in a group ignored via IgnoreGroup. @param handle the context handle @param pkg the package to test @return 1 if the package should be ignored, 0 otherwise

alpm_pkg_unused_deltas
alpm_pkg_vercmp

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

alpm_register_syncdb

Register a sync database of packages. @param handle the context handle @param treename the name of the sync repository @param level what level of signature checking to perform on the database; note that this must be a '.sig' file type verification @return an alpm_db_t* on success (the value), NULL on error

alpm_release
alpm_remove_pkg

Add a package removal action to the transaction. @param handle the context handle @param pkg the package to uninstall @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_siglist_cleanup
alpm_strerror

Returns the string corresponding to an error number.

alpm_sync_newversion
alpm_sync_sysupgrade

Search for packages to upgrade and add them to the transaction. @param handle the context handle @param enable_downgrade allow downgrading of packages if the remote version is lower @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_trans_commit

Commit a transaction. @param handle the context handle @param data the address of an alpm_list where detailed description of an error can be dumped (i.e. list of conflicting files) @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_trans_get_add

Returns a list of packages added by the transaction. @param handle the context handle @return a list of alpm_pkg_t structures

alpm_trans_get_flags

Returns the bitfield of flags for the current transaction. @param handle the context handle @return the bitfield of transaction flags

alpm_trans_get_remove

Returns the list of packages removed by the transaction. @param handle the context handle @return a list of alpm_pkg_t structures

alpm_trans_init

Initialize the transaction. @param handle the context handle @param flags flags of the transaction (like nodeps, etc; see alpm_transflag_t) @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_trans_interrupt

Interrupt a transaction. @param handle the context handle @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_trans_prepare

Prepare a transaction. @param handle the context handle @param data the address of an alpm_list where a list of alpm_depmissing_t objects is dumped (conflicting packages) @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_trans_release

Release a transaction. @param handle the context handle @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_unlock
alpm_unregister_all_syncdbs

Unregister all package databases. @param handle the context handle @return 0 on success, -1 on error (pm_errno is set accordingly)

alpm_version

Type Definitions

__builtin_va_list
__int64_t
__mode_t
__off_t
alpm_backup_t
alpm_cb_download

Type of download progress callbacks. @param filename the name of the file being downloaded @param xfered the number of transferred bytes @param total the total number of bytes to transfer

alpm_cb_event

Event callback.

alpm_cb_fetch

A callback for downloading files @param url the URL of the file to be downloaded @param localpath the directory to which the file should be downloaded @param force whether to force an update, even if the file is the same @return 0 on success, 1 if the file exists and is identical, -1 on error.

alpm_cb_log
alpm_cb_progress

Progress callback

alpm_cb_question

Question callback

alpm_cb_totaldl
alpm_conflict_t
alpm_db_t
alpm_db_usage_t
alpm_delta_t
alpm_depend_t
alpm_depmissing_t
alpm_event_any_t
alpm_event_database_missing_t
alpm_event_delta_patch_t
alpm_event_hook_run_t
alpm_event_hook_t
alpm_event_optdep_removal_t
alpm_event_package_operation_t
alpm_event_pacnew_created_t
alpm_event_pacsave_created_t
alpm_event_pkgdownload_t
alpm_event_scriptlet_info_t
alpm_event_t
alpm_file_t
alpm_fileconflict_t
alpm_filelist_t
alpm_group_t
alpm_handle_t
alpm_list_fn_cmp
alpm_list_fn_free
alpm_list_t
alpm_loglevel_t

Logging Levels

alpm_pgpkey_t
alpm_pkg_t
alpm_pkgvalidation_t

Method used to validate a package.

alpm_question_any_t
alpm_question_conflict_t
alpm_question_corrupted_t
alpm_question_import_key_t
alpm_question_install_ignorepkg_t
alpm_question_remove_pkgs_t
alpm_question_replace_t
alpm_question_select_provider_t
alpm_question_t
alpm_question_type_t

Type of questions. Unlike the events or progress enumerations, this enum has bitmask values so a frontend can use a bitmask map to supply preselected answers to the different types of questions.

alpm_siglevel_t

PGP signature verification options

alpm_siglist_t
alpm_sigresult_t
alpm_time_t

@addtogroup alpm_api Public API The libalpm Public API @{

alpm_trans_t
alpm_transflag_t

Transaction flags

mode_t
off_t
va_list

Unions

_alpm_event_t

Events. This is an union passed to the callback, that allows the frontend to know which type of event was triggered (via type). It is then possible to typecast the pointer to the right structure, or use the union field, in order to access event-specific data.

_alpm_question_t

Questions. This is an union passed to the callback, that allows the frontend to know which type of question was triggered (via type). It is then possible to typecast the pointer to the right structure, or use the union field, in order to access question-specific data.