libalpm
Arch Linux Package Manager Library
Functions
Options
Public API

Libalpm option getters and setters. More...

Collaboration diagram for Options:

Functions

alpm_cb_log alpm_option_get_logcb (alpm_handle_t *handle)
 Returns the callback used for logging.
int alpm_option_set_logcb (alpm_handle_t *handle, alpm_cb_log cb)
 Sets the callback used for logging.
alpm_cb_download alpm_option_get_dlcb (alpm_handle_t *handle)
 Returns the callback used to report download progress.
int alpm_option_set_dlcb (alpm_handle_t *handle, alpm_cb_download cb)
 Sets the callback used to report download progress.
alpm_cb_fetch alpm_option_get_fetchcb (alpm_handle_t *handle)
 Returns the downloading callback.
int alpm_option_set_fetchcb (alpm_handle_t *handle, alpm_cb_fetch cb)
 Sets the downloading callback.
alpm_cb_totaldl alpm_option_get_totaldlcb (alpm_handle_t *handle)
 Returns the callback used to report total download size.
int alpm_option_set_totaldlcb (alpm_handle_t *handle, alpm_cb_totaldl cb)
 Sets the callback used to report total download size.
alpm_cb_event alpm_option_get_eventcb (alpm_handle_t *handle)
 Returns the callback used for events.
int alpm_option_set_eventcb (alpm_handle_t *handle, alpm_cb_event cb)
 Sets the callback used for events.
alpm_cb_question alpm_option_get_questioncb (alpm_handle_t *handle)
 Returns the callback used for questions.
int alpm_option_set_questioncb (alpm_handle_t *handle, alpm_cb_question cb)
 Sets the callback used for questions.
alpm_cb_progress alpm_option_get_progresscb (alpm_handle_t *handle)
 Returns the callback used for operation progress.
int alpm_option_set_progresscb (alpm_handle_t *handle, alpm_cb_progress cb)
 Sets the callback used for operation progress.
const char * alpm_option_get_root (alpm_handle_t *handle)
 Returns the root of the destination filesystem.
const char * alpm_option_get_dbpath (alpm_handle_t *handle)
 Returns the path to the database directory.
const char * alpm_option_get_lockfile (alpm_handle_t *handle)
 Get the name of the database lock file.
const char * alpm_option_get_logfile (alpm_handle_t *handle)
 Returns the logfile name.
int alpm_option_set_logfile (alpm_handle_t *handle, const char *logfile)
 Sets the logfile name.
const char * alpm_option_get_gpgdir (alpm_handle_t *handle)
 Returns the path to libalpm's GnuPG home directory.
int alpm_option_set_gpgdir (alpm_handle_t *handle, const char *gpgdir)
 Sets the path to libalpm's GnuPG home directory.
int alpm_option_get_usesyslog (alpm_handle_t *handle)
 Returns whether to use syslog (0 is FALSE, TRUE otherwise).
int alpm_option_set_usesyslog (alpm_handle_t *handle, int usesyslog)
 Sets whether to use syslog (0 is FALSE, TRUE otherwise).
const char * alpm_option_get_arch (alpm_handle_t *handle)
 Returns the targeted architecture.
int alpm_option_set_arch (alpm_handle_t *handle, const char *arch)
 Sets the targeted architecture.
int alpm_option_get_usedelta (alpm_handle_t *handle)
int alpm_option_set_usedelta (alpm_handle_t *handle, int usedelta)
int alpm_option_get_checkspace (alpm_handle_t *handle)
int alpm_option_set_checkspace (alpm_handle_t *handle, int checkspace)
alpm_siglevel_t alpm_option_get_default_siglevel (alpm_handle_t *handle)
int alpm_option_set_default_siglevel (alpm_handle_t *handle, alpm_siglevel_t level)

Accessors to the list of package cache directories.

alpm_list_talpm_option_get_cachedirs (alpm_handle_t *handle)
int alpm_option_set_cachedirs (alpm_handle_t *handle, alpm_list_t *cachedirs)
int alpm_option_add_cachedir (alpm_handle_t *handle, const char *cachedir)
int alpm_option_remove_cachedir (alpm_handle_t *handle, const char *cachedir)

Accessors to the list of no-upgrade files.

These functions modify the list of files which should not be updated by package installation.

alpm_list_talpm_option_get_noupgrades (alpm_handle_t *handle)
int alpm_option_add_noupgrade (alpm_handle_t *handle, const char *pkg)
int alpm_option_set_noupgrades (alpm_handle_t *handle, alpm_list_t *noupgrade)
int alpm_option_remove_noupgrade (alpm_handle_t *handle, const char *pkg)

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_list_talpm_option_get_noextracts (alpm_handle_t *handle)
int alpm_option_add_noextract (alpm_handle_t *handle, const char *pkg)
int alpm_option_set_noextracts (alpm_handle_t *handle, alpm_list_t *noextract)
int alpm_option_remove_noextract (alpm_handle_t *handle, const char *pkg)

Accessors to the list of ignored packages.

These functions modify the list of packages that should be ignored by a sysupgrade.

alpm_list_talpm_option_get_ignorepkgs (alpm_handle_t *handle)
int alpm_option_add_ignorepkg (alpm_handle_t *handle, const char *pkg)
int alpm_option_set_ignorepkgs (alpm_handle_t *handle, alpm_list_t *ignorepkgs)
int alpm_option_remove_ignorepkg (alpm_handle_t *handle, const char *pkg)

Accessors to the list of ignored groups.

These functions modify the list of groups whose packages should be ignored by a sysupgrade.

alpm_list_talpm_option_get_ignoregroups (alpm_handle_t *handle)
int alpm_option_add_ignoregroup (alpm_handle_t *handle, const char *grp)
int alpm_option_set_ignoregroups (alpm_handle_t *handle, alpm_list_t *ignoregrps)
int alpm_option_remove_ignoregroup (alpm_handle_t *handle, const char *grp)

Detailed Description

Libalpm option getters and setters.


Function Documentation

int alpm_option_add_cachedir ( alpm_handle_t handle,
const char *  cachedir 
)

Definition at line 377 of file handle.c.

References _alpm_log(), ALPM_ERR_MEMORY, ALPM_ERR_WRONG_ARGS, alpm_list_add(), ALPM_LOG_DEBUG, ASSERT, __alpm_handle_t::cachedirs, CHECK_HANDLE, and RET_ERR.

Referenced by _alpm_filecache_setup(), and alpm_option_set_cachedirs().

Here is the call graph for this function:

Here is the caller graph for this function:

int alpm_option_add_ignoregroup ( alpm_handle_t handle,
const char *  grp 
)

Definition at line 561 of file handle.c.

References alpm_list_add(), CHECK_HANDLE, and __alpm_handle_t::ignoregroup.

Here is the call graph for this function:

int alpm_option_add_ignorepkg ( alpm_handle_t handle,
const char *  pkg 
)

Definition at line 534 of file handle.c.

References alpm_list_add(), CHECK_HANDLE, and __alpm_handle_t::ignorepkg.

Here is the call graph for this function:

int alpm_option_add_noextract ( alpm_handle_t handle,
const char *  pkg 
)

Definition at line 507 of file handle.c.

References alpm_list_add(), CHECK_HANDLE, and __alpm_handle_t::noextract.

Here is the call graph for this function:

int alpm_option_add_noupgrade ( alpm_handle_t handle,
const char *  pkg 
)

Definition at line 480 of file handle.c.

References alpm_list_add(), CHECK_HANDLE, and __alpm_handle_t::noupgrade.

Here is the call graph for this function:

const char* alpm_option_get_arch ( alpm_handle_t handle)

Returns the targeted architecture.

Definition at line 249 of file handle.c.

References __alpm_handle_t::arch, and CHECK_HANDLE.

Definition at line 195 of file handle.c.

References __alpm_handle_t::cachedirs, and CHECK_HANDLE.

Referenced by main().

Here is the caller graph for this function:

Definition at line 261 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::checkspace.

const char* alpm_option_get_dbpath ( alpm_handle_t handle)

Returns the path to the database directory.

Read-only.

Definition at line 189 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::dbpath.

Referenced by main().

Here is the caller graph for this function:

Definition at line 628 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::siglevel.

Referenced by pacman_upgrade().

Here is the caller graph for this function:

Returns the callback used to report download progress.

Definition at line 147 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::dlcb.

Returns the callback used for events.

Definition at line 165 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::eventcb.

Returns the downloading callback.

Definition at line 153 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::fetchcb.

const char* alpm_option_get_gpgdir ( alpm_handle_t handle)

Returns the path to libalpm's GnuPG home directory.

Definition at line 213 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::gpgdir.

Referenced by main().

Here is the caller graph for this function:

Definition at line 243 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::ignoregroup.

Definition at line 237 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::ignorepkg.

const char* alpm_option_get_lockfile ( alpm_handle_t handle)

Get the name of the database lock file.

Read-only.

Definition at line 207 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::lockfile.

Referenced by main(), and trans_init_error().

Here is the caller graph for this function:

Returns the callback used for logging.

Definition at line 141 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::logcb.

const char* alpm_option_get_logfile ( alpm_handle_t handle)

Returns the logfile name.

Definition at line 201 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::logfile.

Referenced by main().

Here is the caller graph for this function:

Definition at line 231 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::noextract.

Definition at line 225 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::noupgrade.

Returns the callback used for operation progress.

Definition at line 177 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::progresscb.

Returns the callback used for questions.

Definition at line 171 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::questioncb.

const char* alpm_option_get_root ( alpm_handle_t handle)

Returns the root of the destination filesystem.

Read-only.

Definition at line 183 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::root.

Referenced by dump_pkg_backups(), dump_pkg_files(), and main().

Here is the caller graph for this function:

Returns the callback used to report total download size.

Definition at line 159 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::totaldlcb.

Definition at line 255 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::usedelta.

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

Definition at line 219 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::usesyslog.

int alpm_option_remove_cachedir ( alpm_handle_t handle,
const char *  cachedir 
)

Definition at line 411 of file handle.c.

References ALPM_ERR_MEMORY, ALPM_ERR_WRONG_ARGS, alpm_list_remove_str(), ASSERT, __alpm_handle_t::cachedirs, CHECK_HANDLE, FREE, and RET_ERR.

Here is the call graph for this function:

int alpm_option_remove_ignoregroup ( alpm_handle_t handle,
const char *  grp 
)

Definition at line 576 of file handle.c.

References alpm_list_remove_str(), CHECK_HANDLE, FREE, and __alpm_handle_t::ignoregroup.

Here is the call graph for this function:

int alpm_option_remove_ignorepkg ( alpm_handle_t handle,
const char *  pkg 
)

Definition at line 549 of file handle.c.

References alpm_list_remove_str(), CHECK_HANDLE, FREE, and __alpm_handle_t::ignorepkg.

Here is the call graph for this function:

int alpm_option_remove_noextract ( alpm_handle_t handle,
const char *  pkg 
)

Definition at line 522 of file handle.c.

References alpm_list_remove_str(), CHECK_HANDLE, FREE, and __alpm_handle_t::noextract.

Here is the call graph for this function:

int alpm_option_remove_noupgrade ( alpm_handle_t handle,
const char *  pkg 
)

Definition at line 495 of file handle.c.

References alpm_list_remove_str(), CHECK_HANDLE, FREE, and __alpm_handle_t::noupgrade.

Here is the call graph for this function:

int alpm_option_set_arch ( alpm_handle_t handle,
const char *  arch 
)

Sets the targeted architecture.

Definition at line 588 of file handle.c.

References __alpm_handle_t::arch, CHECK_HANDLE, and FREE.

int alpm_option_set_cachedirs ( alpm_handle_t handle,
alpm_list_t cachedirs 
)

Definition at line 395 of file handle.c.

References alpm_option_add_cachedir(), __alpm_handle_t::cachedirs, CHECK_HANDLE, __alpm_list_t::data, FREELIST, and __alpm_list_t::next.

Here is the call graph for this function:

int alpm_option_set_checkspace ( alpm_handle_t handle,
int  checkspace 
)

Definition at line 607 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::checkspace.

Sets the callback used to report download progress.

Definition at line 286 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::dlcb.

Sets the callback used for events.

Definition at line 307 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::eventcb.

Sets the downloading callback.

Definition at line 293 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::fetchcb.

int alpm_option_set_gpgdir ( alpm_handle_t handle,
const char *  gpgdir 
)

Sets the path to libalpm's GnuPG home directory.

Definition at line 456 of file handle.c.

References _alpm_log(), ALPM_ERR_WRONG_ARGS, ALPM_LOG_DEBUG, CHECK_HANDLE, FREE, __alpm_handle_t::gpgdir, and __alpm_handle_t::pm_errno.

Here is the call graph for this function:

int alpm_option_set_ignoregroups ( alpm_handle_t handle,
alpm_list_t ignoregrps 
)

Definition at line 568 of file handle.c.

References alpm_list_strdup(), CHECK_HANDLE, FREELIST, and __alpm_handle_t::ignoregroup.

Here is the call graph for this function:

int alpm_option_set_ignorepkgs ( alpm_handle_t handle,
alpm_list_t ignorepkgs 
)

Definition at line 541 of file handle.c.

References alpm_list_strdup(), CHECK_HANDLE, FREELIST, and __alpm_handle_t::ignorepkg.

Here is the call graph for this function:

int alpm_option_set_logcb ( alpm_handle_t handle,
alpm_cb_log  cb 
)

Sets the callback used for logging.

Definition at line 279 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::logcb.

Referenced by main().

Here is the caller graph for this function:

int alpm_option_set_logfile ( alpm_handle_t handle,
const char *  logfile 
)

Sets the logfile name.

Definition at line 431 of file handle.c.

References _alpm_log(), ALPM_ERR_WRONG_ARGS, ALPM_LOG_DEBUG, CHECK_HANDLE, FREE, __alpm_handle_t::logfile, __alpm_handle_t::logstream, and __alpm_handle_t::pm_errno.

Here is the call graph for this function:

int alpm_option_set_noextracts ( alpm_handle_t handle,
alpm_list_t noextract 
)

Definition at line 514 of file handle.c.

References alpm_list_strdup(), CHECK_HANDLE, FREELIST, and __alpm_handle_t::noextract.

Here is the call graph for this function:

int alpm_option_set_noupgrades ( alpm_handle_t handle,
alpm_list_t noupgrade 
)

Definition at line 487 of file handle.c.

References alpm_list_strdup(), CHECK_HANDLE, FREELIST, and __alpm_handle_t::noupgrade.

Here is the call graph for this function:

Sets the callback used for operation progress.

Definition at line 321 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::progresscb.

Sets the callback used for questions.

Definition at line 314 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::questioncb.

Sets the callback used to report total download size.

Definition at line 300 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::totaldlcb.

int alpm_option_set_usedelta ( alpm_handle_t handle,
int  usedelta 
)

Definition at line 600 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::usedelta.

int alpm_option_set_usesyslog ( alpm_handle_t handle,
int  usesyslog 
)

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

Definition at line 473 of file handle.c.

References CHECK_HANDLE, and __alpm_handle_t::usesyslog.