|
|
2ff057 |
/*! \mainpage librpm API Documentation.
|
|
|
2ff057 |
This documents the librpm API as available to rpm itself and to the
|
|
|
2ff057 |
various depsolvers or language bindings that rely upon it.
|
|
|
2ff057 |
|
|
|
2ff057 |
It enables to build tools for:
|
|
|
2ff057 |
- \link rpmbuild creating \endlink,
|
|
|
2ff057 |
- \link rpmsign signing \endlink,
|
|
|
2ff057 |
- \link rpmtd querying \endlink,
|
|
|
2ff057 |
- or \link rpmts (un)installing \endlink RPM packages.
|
|
|
2ff057 |
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup buildsign Building & signing packages:
|
|
|
2ff057 |
*
|
|
|
2ff057 |
* @{
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmbuild Build API.
|
|
|
2ff057 |
\brief API for building packages.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup signature Signature Tags API.
|
|
|
2ff057 |
\brief List of signature tags.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmsign Signature API.
|
|
|
2ff057 |
\brief How to add or remove a signature from a package header.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** @}*/
|
|
|
2ff057 |
|
|
|
2ff057 |
/** \defgroup datatypes Data types:
|
|
|
2ff057 |
*
|
|
|
2ff057 |
* @{
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmtypes RPM data types.
|
|
|
2ff057 |
\brief The abstract RPM data types.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmstring String Manipulation API.
|
|
|
2ff057 |
\brief String Manipulation API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmstrpool String Pool API.
|
|
|
2ff057 |
\brief How to store strings in pools.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** @} */
|
|
|
2ff057 |
/** \defgroup install (un)Installing packages:
|
|
|
2ff057 |
*
|
|
|
2ff057 |
* @{
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmds Dependency Set API.
|
|
|
2ff057 |
\brief How to compare dependencies.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmcallback Callback signature & types.
|
|
|
2ff057 |
\brief The signature of function to register as callback and the cases where it can be called
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmts Transaction Set API.
|
|
|
2ff057 |
\brief How to create, run & destroy a package transaction.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmte Transaction Element API.
|
|
|
2ff057 |
\brief How to retrieve information from a transaction element.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmps Problem Set API.
|
|
|
2ff057 |
\brief Problem Set API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmprob Problem Element API.
|
|
|
2ff057 |
\brief Problem Element API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmvf Verify API.
|
|
|
2ff057 |
\brief How to verify a package
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** @} */
|
|
|
2ff057 |
|
|
|
2ff057 |
/** \defgroup rpmfiles File Info Set API.
|
|
|
2ff057 |
\brief File Info Set API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmfi File Info Set Iterator API.
|
|
|
2ff057 |
\brief File Info Set Iterator API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmfc File Classification API.
|
|
|
2ff057 |
\brief Structures and methods for build-time file classification
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmkeyring RPM keyring API.
|
|
|
2ff057 |
\brief RPM keyring API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmmacro Macro API.
|
|
|
2ff057 |
\brief Macro API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmlog Logging API.
|
|
|
2ff057 |
\brief RPM Logging facilities.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmpgp OpenPGP API.
|
|
|
2ff057 |
\brief OpenPGP constants and structures from RFC-2440.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup headquery Querying package headers:
|
|
|
2ff057 |
*
|
|
|
2ff057 |
* @{
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup header Header API.
|
|
|
2ff057 |
\brief How to manipulate package headers (which carries all information about a package).
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmtag RPM Tag API.
|
|
|
2ff057 |
\brief Manipulating RPM tags (accessing values, types, ...)
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmtd RPM Tag Data Container API.
|
|
|
2ff057 |
\brief How to retrieve data from package headers.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** @} */
|
|
|
2ff057 |
/** \defgroup io I/O
|
|
|
2ff057 |
*
|
|
|
2ff057 |
* @{
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup header Header API.
|
|
|
2ff057 |
/** \defgroup rpmdb Database API.
|
|
|
2ff057 |
\brief Opening & accessing the RPM indices using Berkeley DB (the so called rpmdb)
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmio RPM IO API.
|
|
|
2ff057 |
\brief The RPM IO API (Fd_t is RPM equivalent to libc's FILE).
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmfileutil File and Path Manipulation API.
|
|
|
2ff057 |
\brief File and path manipulation helper functions.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmurl URL Manipulation API.
|
|
|
2ff057 |
\brief A couple utils for URL Manipulation.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmargv Argument Manipulation API.
|
|
|
2ff057 |
\brief Argument Manipulation API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmcli Command Line API.
|
|
|
2ff057 |
\brief Parsing RPM command line arguments.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** @} */
|
|
|
2ff057 |
/** \defgroup rpmsq Signal Queue API.
|
|
|
2ff057 |
\brief Signal Queue API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmsw Statistics API.
|
|
|
2ff057 |
\brief Statistics API.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** \defgroup rpmrc RPMRC.
|
|
|
2ff057 |
\brief Reading config files and getting some important configuration values.
|
|
|
2ff057 |
*/
|
|
|
2ff057 |
/** @} */
|