RPM

https://rpm.org/
Admin
RPM is a package management system used for building, installing, querying, and managing software...
Tokens:199,788
Snippets:2,525
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Querying package information with custom formats

Source: https://rpm.org/docs/latest/man/rpm-queryformat.7

Various command-line examples for extracting specific package details like size, installation time, file permissions, and dependencies.

```bash
rpm -qa --queryformat "%-30{NAME} %{SIZE:humaniec}\n"
```

```bash
rpm -q --queryformat "%{NAME} %{INSTALLTIME:date}\n" fileutils
```

```bash
rpm -q --queryformat "[%{FILEMODES:perms} %{FILENAMES}\n]" rpm
```

```bash
rpm -q --queryformat "[%{REQUIRENAME} %{REQUIREFLAGS:depflags} %{REQUIREVERSION}\n]" vlock
```

```bash
rpm -qa --queryformat "%-30{NAME} %|PREINPROG?{ %{PREINPROG}}:{ no}|\n"
```

--------------------------------

### Generate and install a base image manifest

Source: https://rpm.org/docs/latest/man/rpm-manifest.5

Creates a manifest file from currently installed packages and installs them to an alternative system root.

```bash
rpm -qa --qf '/mnt/Packages/%{nevra}.rpm\n' > mymanifest.mft
rpm -Uv --root /srv/test mymanifest.mft
```

--------------------------------

### Example Dependency Error Message

Source: https://rpm.org/docs/latest/manual/more_dependencies.html

This output appears when a package installation or upgrade fails due to missing dependencies.

```text
    failed dependencies:
        libICE.so.6  is needed by somepackage-2.11-1
        libSM.so.6  is needed by somepackage-2.11-1
        libc.so.5  is needed by somepackage-2.11-1
```

--------------------------------

### Install or upgrade a package

Source: https://rpm.org/docs/latest/man/rpm.8

Install or upgrade a package with verbose output and progress meters.

```bash
rpm -Uvh hello-2.0-1.noarch.rpm
```

--------------------------------

### %setup macro options

Source: https://rpm.org/docs/latest/manual/spec.html

Available options for the %setup macro used to manage source unpacking and build directory creation.

```rpm
-a N        unpack source N after changing to the build directory
-b N        unpack source N before changing to the build directory
-c          create the build directory (and change to it) before unpacking
-C          Create the build directory and ensure the archive contents
            are unpacked there, stripping the top level directory in the archive
            if it exists
-D          do not delete the build directory prior to unpacking (used
            when more than one source is to be unpacked with `-a` or `-b`)
-n DIR      set the name of build directory (default is `%{name}-%{version}`)
-T          skip the default unpacking of the first source (used with
            `-a` or `-b`)
-q          operate quietly

```

--------------------------------

### List installed packages

Source: https://rpm.org/docs/latest/man/rpm.8

List all installed packages using default formatting.

```bash
rpm -qa
```

--------------------------------

### Execute install stage with short-circuit

Source: https://rpm.org/docs/latest/man/rpmbuild.1

Runs only the %install stage, skipping previous steps. Requires a prior build to have been completed.

```bash
rpmbuild -bi --short-circuit hello.spec
```

--------------------------------

### Dependency Example

Source: https://rpm.org/docs/latest/manual/dependencies.html

An example of a package requirement specifying an epoch, version, and release.

```text
    Requires: perl >= 9:5.00502-3
```

--------------------------------

### Reproduce Disk Space Failure

Source: https://rpm.org/ticket/175

Example commands demonstrating an RPM installation failure due to insufficient temporary disk space during a package upgrade.

```bash
# rpm -Uvh /home/pmatilai/rpmbuild/RPMS/noarch/dsneedtest-1.0-1.noarch.rpm
Preparing...                ########################################### [100%]
   1:dsneedtest             ########################################### [100%]
# dd if=/dev/zero of=/boot/fillme
# rpm -Uvh --force dsneedtest-1.0-1.noarch.rpm
Preparing...                ########################################### [100%]
   1:dsneedtest             ########################################### [100%]
error: unpacking of archive failed on file /boot/de.txt;4c5ffe6f: cpio: write
error: dsneedtest-1.0-1.noarch: install failed
```

--------------------------------

### Expanded ISA Dependency Examples

Source: https://rpm.org/docs/latest/manual/arch_dependencies.html

Examples showing how the %{?_isa} macro resolves to specific architectures based on the build target.

```rpm
Requires: libbar-devel(x86-64) >= 2.2
```

```rpm
Requires: libbar-devel(x86-32) >= 2.2
```

--------------------------------

### Install Jekyll and Plugins

Source: https://rpm.org/docs/latest/manual/devel_documentation.html

Commands to install the Jekyll static site generator and the necessary plugins for local documentation rendering.

```bash
gem install jekyll
```

```bash
gem install jekyll-titles-from-headings jekyll-relative-links
```

--------------------------------

### Transaction scriptlet file list iteration

Source: https://rpm.org/docs/latest/man/rpm-queryformat.7

A scriptlet example demonstrating how to iterate over installed filenames. The trailing space inside the square brackets is required for proper expansion.

```bash
%post -q
for f in [%%{instfilenames} ]; do
    echo $f
done
```

--------------------------------

### Install software with %make_install

Source: https://rpm.org/docs/latest/manual/spec.html

The %make_install macro is used within the %install section to copy built software into the build root.

```rpm
%install
%make_install

```

--------------------------------

### Install package to alternative root

Source: https://rpm.org/docs/latest/man/rpm.8

Install packages from a manifest file into an alternative system root while excluding documentation.

```bash
rpm -Uvh --excludedocs --root /srv/test mydist-23.mft
```

--------------------------------

### PSM_INIT State Logic

Source: https://rpm.org/devel_doc/state_machines.html

Handles instance counting and initial setup based on the package goal.

```pseudocode
calculate pkg instance count
if goal PSM_PKGINSTALL
    increment pkg instance count
    Try to find matching NEVRAO header in rpmdb and save in PSM state.
    if JUSTDB  return
    if file count is <= 0 return
    strip PREFIX from files in old format relocatable packages?
    strip / from files in current format relocatable packages

if goal PSM_PKGERASE
    decrement pkg instance count
    retrieve pkg header from rpmdb
if goal PSM_PKGSAVE
   generate path to repackaged package
   open repackaged package for write

return
```

--------------------------------

### Example sysusers.d entry

Source: https://rpm.org/docs/latest/man/rpm-sysusers.7

A standard sysusers.d configuration line for creating a user.

```text
u dnsmasq - "Dnsmasq DHCP and DNS server" /var/lib/dnsmasq
```

--------------------------------

### Configure Prep Build Options

Source: https://rpm.org/docs/latest/manual/buildsystem.html

Example of overriding the default patch prefix stripping for the prep section.

```spec
BuildOption(prep): -p0
```

--------------------------------

### Dependency Generator Output Example

Source: https://rpm.org/docs/latest/manual/more_dependencies.html

A simple example of output generated by a dependency generator.

```text
    Foo-0.9
    perl(Widget)-0-1
```

--------------------------------

### RPM lead binary data examples

Source: https://rpm.org/docs/latest/manual/format_lead.html

Hexadecimal dumps representing the RPM lead structure from an example package.

```text
00000000: ed ab ee db 03 00 00 00
```

```text
00000008: 00 01 72 70 6d 2d 32 2e    ..rpm-2.
```

```text
00000010: 31 2e 32 2d 31 00 00 00    1.2-1...
00000018: 00 00 00 00 00 00 00 00    ........
00000020: 00 00 00 00 00 00 00 00    ........
00000028: 00 00 00 00 00 00 00 00    ........
00000030: 00 00 00 00 00 00 00 00    ........
00000038: 00 00 00 00 00 00 00 00    ........
00000040: 00 00 00 00 00 00 00 00    ........
00000048: 00 00 00 00 00 01 00 05    ........
```

```text
00000050: 04 00 00 00 68 e6 ff bf    ........
00000058: ab ad 00 08 3c eb ff bf    ........
```

--------------------------------

### Installation Constants (rpmcli.h)

Source: https://rpm.org/docs/latest/api/globals_i.html

A collection of constants used to define installation modes and flags within the RPM library.

```APIDOC
## Installation Constants

### Description
These constants are defined in `rpmcli.h` and are used to control the behavior of package installation, upgrade, and erasure operations.

### Constants
- **INSTALL_ALLMATCHES** - Flag to process all matches.
- **INSTALL_ERASE** - Flag to perform an erasure operation.
- **INSTALL_FRESHEN** - Flag to perform a freshen operation.
- **INSTALL_HASH** - Flag to display hash marks during installation.
- **INSTALL_INSTALL** - Flag to perform an install operation.
- **INSTALL_LABEL** - Flag to use labels.
- **INSTALL_NODEPS** - Flag to ignore package dependencies.
- **INSTALL_NOORDER** - Flag to ignore package ordering.
- **INSTALL_PERCENT** - Flag to display percentage progress.
- **INSTALL_REINSTALL** - Flag to perform a reinstall operation.
- **INSTALL_RESTORE** - Flag to perform a restore operation.
- **INSTALL_UPGRADE** - Flag to perform an upgrade operation.
```

--------------------------------

### Verify installed sysusers.d file

Source: https://rpm.org/docs/latest/man/rpm-sysusers.7

Commands to locate and inspect the installed sysusers.d configuration file.

```bash
$ rpm -ql dnsmasq | grep sysusers
/usr/lib/sysusers.d/dnsmasq.conf
$ cat /usr/lib/sysusers.d/dnsmasq.conf
u dnsmasq - "Dnsmasq DHCP and DNS server" /var/lib/dnsmasq
```

--------------------------------

### rpmInstall

Source: https://rpm.org/docs/latest/api/group__rpmcli.html

Installs RPM packages.

```APIDOC
### int rpmInstall (rpmts ts, struct rpmInstallArguments_s *ia, ARGV_t fileArgv)

### Description
Installs RPM packages using the provided transaction set and arguments.

### Parameters
- **ts** (rpmts) - Transaction set
- **ia** (struct rpmInstallArguments_s *) - Installation arguments
- **fileArgv** (ARGV_t) - List of files to install

### Returns
- **int** - 0 on success
```

--------------------------------

### Bad Version Format Example

Source: https://rpm.org/docs/latest/manual/dependencies.html

An example of a version change that causes incorrect ordering due to numerical comparison.

```text
  The date may be the older version, but it is numerically greater
  2 so it is considered newer :(
```

--------------------------------

### Verify installed system users and groups

Source: https://rpm.org/docs/latest/man/rpm-sysusers.7

Commands to verify that the system user and group were created correctly upon package installation.

```bash
$ getent passwd dnsmasq
dnsmasq:x:999:999:Dnsmasq DHCP and DNS server:/var/lib/dnsmasq:/usr/sbin/nologin
$ getent group dnsmasq
dnsmasq:x:999:
$ stat -c '%G:%g' /var/lib/dnsmasq
dnsmasq:999
```

--------------------------------

### Relocate multiple prefixes during installation

Source: https://rpm.org/docs/latest/manual/relocatable.html

Use the --relocate flag to map specific original prefixes to new installation paths.

```bash
  rpm ... --relocate /opt=/usr/opt --relocate /etc=/usr/etc ...

```

--------------------------------

### Query package file details

Source: https://rpm.org/docs/latest/man/rpm.8

List filenames and their corresponding digests for an installed package.

```bash
rpm -q --qf "[%{filenames} %{filedigests}\n]" openssh-server
```

--------------------------------

### rpmteSetDBInstance

Source: https://rpm.org/docs/latest/api/group__rpmte.html

Set the last instance installed to the database.

```APIDOC
## rpmteSetDBInstance

### Description
Set last instance installed to the database.

### Parameters
- **te** (rpmte) - Required - transaction element
- **instance** (unsigned int) - Required - Database instance of last install element.
```

--------------------------------

### rpmInstallSourcePackage

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Installs a source package from a file descriptor.

```APIDOC
## rpmInstallSourcePackage(rpmts ts, FD_t fd, char **specFilePtr, char **cookie)

### Description
Installs a source package using the provided transaction set and file descriptor.

### Parameters
- **ts** (rpmts) - transaction set
- **fd** (FD_t) - file handle
- **specFilePtr** (char **) - [out] address of spec file name (or NULL)
- **cookie** (char **) - [out] address of cookie pointer (or NULL)

### Returns
- **rpmRC** - return code
```

--------------------------------

### rpmInstallSource

Source: https://rpm.org/docs/latest/api/group__rpmcli.html

Installs an RPM source package.

```APIDOC
### int rpmInstallSource (rpmts ts, const char *arg, char **specFilePtr, char **cookie)

### Description
Installs an RPM source package into the transaction set.

### Parameters
- **ts** (rpmts) - Transaction set
- **arg** (const char *) - Source package argument
- **specFilePtr** (char **) - Pointer to spec file path
- **cookie** (char **) - Pointer to cookie string

### Returns
- **int** - 0 on success
```

--------------------------------

### Implement Autotools Build System Macros

Source: https://rpm.org/docs/latest/manual/buildsystem.html

Example implementation of build system macros for the autotools build system.

```spec
%buildsystem_autotools_conf() %configure %*
%buildsystem_autotools_build() %make_build %*
%buildsystem_autotools_install() %make_install %*
```

--------------------------------

### Manual RPM Linting Workflow

Source: https://rpm.org/ticket/2

Example of the manual process of running rpmlint on output files generated by rpmbuild.

```bash
$ rpmbuild -ba foobar.spec
[...]
Wrote: foobar-1.0-1.src.rpm
Wrote: foobar-1.0-1.i386.rpm

$ rpmlint foobar-1.0-1.src.rpm foobar-1.0-1.i386.rpm
```

--------------------------------

### posix.umask([MODE])

Source: https://rpm.org/docs/latest/man/rpm-lua.7

Gets or sets the process umask.

```APIDOC
## posix.umask([MODE])

### Description
Get or set process umask(2). MODE may be specified as an octal number or mode string.

### Parameters
- **MODE** (string/integer) - Optional - The umask value to set.
```

--------------------------------

### Simple %prep section

Source: https://rpm.org/docs/latest/manual/spec.html

A basic implementation of the %prep section using the %autosetup macro.

```rpm
%prep
%autosetup

```

--------------------------------

### Install a kernel package

Source: https://rpm.org/docs/latest/man/rpm.8

Install a kernel package quietly, allowing parallel installation with existing versions.

```bash
rpm -i kernel-6.15.4-200.x86_64.rpm
```

--------------------------------

### View Cherry-Plan Help

Source: https://rpm.org/devel_doc/release_maintaince.html

Display usage instructions for the git-cherry-plan utility.

```bash
git cherry-plan -h
```

--------------------------------

### Render Documentation Locally

Source: https://rpm.org/docs/latest/manual/devel_documentation.html

Commands to build or serve the Reference Manual locally using Jekyll.

```bash
jekyll build
```

```bash
jekyll serve
```

--------------------------------

### Define PSM_POST state transitions

Source: https://rpm.org/devel_doc/state_machines.html

Handles package installation and erasure logic, including script execution and database updates.

```pseudo-code
if test return OK
if goal PSM_PKGINSTALL
   calculate install time
   set RPMTAG_FILESTATES in header      # ???
   set RPMTAG_INSTALLTIME in header
   set RPMTAG_INSTALLCOLOR in header
   # 
   # Remove header with same NEVRA (color?)
   transition to PSM_RPMDB_REMOVE
   #
   # Add new header to rpm db
   transition to PSM_RPMDB_ADD
   if %post allowed
      transition to PSM_SCRIPT  # Run %post script
   if %triggerin allowed
      transition to PSM_TRIGGERS                # Run %triggerin in other packages
      transition to PSM_IMMED_TRIGGERS   # Run %triggerin in this package
   if not apply only
      mark replaced files  # ???
if goal PSM_PKGERASE
   # Special note:  %postun failures do not cause PSM to return an error???
   if %postun allowed
      transition to PSM_SCRIPT    # Run %postun
   if %triggerpostun allowed
      transition to PSM_TRIGGERS   # Run %triggerpostun in other packages
   if not apply only
      transition to PSM_RPMDB_REMOVE   # Remove header from db
#
# Exit chroot
transition to PSM_CHROOT_OUT
return OK
```

--------------------------------

### Query file class using rpm -q

Source: https://rpm.org/ticket/25

Example command to check the file class of a specific package file.

```bash
$ rpm -q --fileclass telnet
/usr/bin/telnet 0
/usr/share/man/man1/telnet.1.gz 0
```

--------------------------------

### Define BuildRequires for a package

Source: https://rpm.org/docs/latest/manual/spec.html

Examples of specifying build-time dependencies, including basic requirements and version-specific constraints.

```text
	BuildRequires: gcc
```

```text
	BuildRequires: e2fsprofs-devel = 1.17-1
```

--------------------------------

### Example RPM tag output

Source: https://rpm.org/docs/latest/man/rpm-queryformat.7

Sample output showing tag names, internal numbers, and data types.

```text
BASENAMES              1117 argv
BUILDHOST              1007 string
BUILDTIME              1006 int32
DESCRIPTION            1005 i18nstring
EPOCH                  1003 int32
INSTALLTIME            1008 int32
NAME                   1000 string
RELEASE                1002 string
SIZE                   1009 int32
SUMMARY                1004 i18nstring
VERSION                1001 string
```

--------------------------------

### VCS-backed source management with %autosetup

Source: https://rpm.org/docs/latest/manual/autosetup.html

Using the -S flag to initialize a git repository and apply patches via git commits.

```RPM Spec
%autosetup -S git
```

--------------------------------

### Freshen installed packages

Source: https://rpm.org/docs/latest/man/rpm.8

Freshen installed packages from a local directory with verbose output.

```bash
rpm -Fvh *.rpm
```

--------------------------------

### Re-create RPM Database from Package List

Source: https://rpm.org/user_doc/db_recovery.html

Re-initialize the RPM database using a list of installed packages.

```bash
rpm -i --justdb PACKAGES
```

--------------------------------

### Install GitHub CLI on Fedora

Source: https://rpm.org/devel_doc/release_maintaince.html

Install the GitHub CLI utility required for commit grouping.

```bash
dnf install gh
```

--------------------------------

### Installation Enumerators

Source: https://rpm.org/docs/latest/api/globals_eval_i.html

A list of enumerator values used for controlling package installation behavior in the RPM library.

```APIDOC
## Enumerator Values (i)

### Description
These enumerators are defined in `rpmcli.h` and are used to configure installation flags for the RPM package manager.

### Enumerators
- **INSTALL_ALLMATCHES**
- **INSTALL_ERASE**
- **INSTALL_FRESHEN**
- **INSTALL_HASH**
- **INSTALL_INSTALL**
- **INSTALL_LABEL**
- **INSTALL_NODEPS**
- **INSTALL_NOORDER**
- **INSTALL_PERCENT**
- **INSTALL_REINSTALL**
- **INSTALL_RESTORE**
- **INSTALL_UPGRADE**
```

--------------------------------

### Duplicate %triggerin definition example

Source: https://rpm.org/ticket/103

Example of a specfile containing multiple %triggerin definitions with identical conditions.

```rpm
%triggerin -- foo
echo footrigger1

%triggerin -- foo
echo footrigger2

```

--------------------------------

### Create directories with posix.mkdir

Source: https://rpm.org/docs/latest/man/rpm-lua.7

Creates a new directory at the specified path.

```lua
posix.mkdir('/tmp')
```

--------------------------------

### Update /etc/shells on package install/removal

Source: https://rpm.org/docs/latest/man/rpm-scriptlets.7

Uses %post and %postun to manage shell registration in /etc/shells based on the installation state.

```shell
%post
if [ $1 -eq 1 ]; then
    # Initial install
    grep -q '^/bin/mysh$' /etc/shells || echo '/bin/mysh' >> /etc/shells
fi

%postun
if [ $1 -eq 0 ] ; then
    # Package removal, not upgrade
    sed -i '/^/bin/mysh$/d' /etc/shells
fi
```

--------------------------------

### Initialize Release Branch

Source: https://rpm.org/devel_doc/release_maintaince.html

Create a copy of the release plan and a new topic branch for the release.

```bash
cp <stable>.plan <release>.plan
git checkout -b <release>
```

--------------------------------

### Bad Version Increment Example

Source: https://rpm.org/docs/latest/manual/dependencies.html

An example of a version increment that causes unexpected ordering due to ASCII comparison.

```text
  The 'a' (ASCII 97) is compared against 'A' (ASCII 65), making 2.1.7a
  the newer version.
```

--------------------------------

### Apply Release Plan

Source: https://rpm.org/devel_doc/release_maintaince.html

Execute the cherry-pick process defined in the plan file.

```bash
git cherry-plan apply
```

--------------------------------

### rpmlogOpen

Source: https://rpm.org/docs/latest/api/group__rpmlog.html

Initializes the logging facility.

```APIDOC
## void rpmlogOpen(const char *ident, int option, int facility)

### Description
Opens the logging facility with the specified identifier, options, and facility.

### Parameters
- **ident** (const char *) - Identifier string for the log.
- **option** (int) - Logging options.
- **facility** (int) - Logging facility.
```

--------------------------------

### rpmswInit

Source: https://rpm.org/docs/latest/api/rpmsw_8h_source.html

Initializes the timing system.

```APIDOC
### rpmswInit

**Signature:** `rpmtime_t rpmswInit(void)`

Initializes the timing mechanisms and returns the initial time value.
```

--------------------------------

### rpmtxnRebuildKeystore()

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Rebuilds the key store using current settings and fills it with keys from the keyring.

```APIDOC
## rpmtxnRebuildKeystore(rpmtxn kxn, const char *from)

### Description
Rebuild key store using current settings and fill it with keys form keyring.

### Parameters
- **kxn** (rpmtxn) - Required - Keystore handle
- **from** (const char *) - Required - Backend to get the keys from

### Returns
- **rpmRC** - RPMRC_OK on success
```

--------------------------------

### rpmswInit

Source: https://rpm.org/docs/latest/api/group__rpmsw.html

Initialize the statistics module and return benchmark overhead.

```APIDOC
## rpmswInit(void)

### Description
Return benchmark time stamp overhead.

### Returns
- **rpmtime_t** - Overhead in micro-seconds
```

--------------------------------

### Initialize a new RPM database

Source: https://rpm.org/docs/latest/man/rpmdb.8

Creates a new database in the specified directory.

```bash
rpmdb --initdb --dbpath /tmp/testdb
```

--------------------------------

### Display Help

Source: https://rpm.org/docs/latest/man/rpmkeys.8

Displays the help information for the rpmkeys command.

```bash
rpmkeys --help
```

--------------------------------

### Querying Scriptlet Arguments with RPM

Source: https://rpm.org/ticket/847

Examples of querying scriptlet program information using standard RPM commands and query formats.

```bash
$ rpm -qp --scripts foo-1.0-3.fc14.x86_64.rpm 
postinstall program: /bin/echo

$ rpm -qp --qf="%{POSTINPROG}\n" foo-1.0-3.fc14.x86_64.rpm 
/bin/echo

$ rpm -qp --qf="%{POSTINFLAGS}\n" foo-1.0-3.fc14.x86_64.rpm 
(none)
```

```bash
[pmatilai@localhost ~]$ rpm -qp --scripts /home/pmatilai/rpmbuild/RPMS/x86_64/argtest-1.0-4.x86_64.rpm
preinstall program: /bin/echo -a -c -e
postinstall scriptlet (using /bin/sh -x):
echo "echo this"
preuninstall scriptlet (using /bin/bash --posix --version -l -v -x):
echo "echo that"
postuninstall scriptlet (using /bin/sh):
echo "postun, nuting special"
posttrans scriptlet (using /usr/bin/python):
print "foo"
verify program: /sbin/ldconfig -x -y
[pmatilai@localhost ~]$
```

--------------------------------

### rpmtsFlags()

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Get transaction flags.

```APIDOC
## rpmtsFlags(rpmts ts)

### Description
Get transaction flags, i.e. bits that control rpmtsRun().

### Parameters
- **ts** (rpmts) - Required - transaction set

### Returns
- **transaction flags** (rpmtransFlags)
```

--------------------------------

### rpmdsInit()

Source: https://rpm.org/docs/latest/api/group__rpmds.html

Initializes a dependency set iterator.

```APIDOC
## rpmdsInit()

### Description
Initializes the dependency set iterator.

### Parameters
- **ds** (rpmds) - The dependency set.

### Returns
- (rpmds) The dependency set.
```

--------------------------------

### rpmInstallSourcePackage

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Installs a source package into the transaction.

```APIDOC
## rpmInstallSourcePackage

### Description
Installs a source package into the specified transaction.

### Signature
`rpmRC rpmInstallSourcePackage(rpmts ts, FD_t fd, char **specFilePtr, char **cookie)`

### Parameters
- **ts** (rpmts) - The transaction set.
- **fd** (FD_t) - The file descriptor of the source package.
- **specFilePtr** (char **) - Pointer to store the spec file path.
- **cookie** (char **) - Pointer to store the cookie string.
```

--------------------------------

### rpmtsAddInstallElement

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Adds an installation element to the transaction.

```APIDOC
## rpmtsAddInstallElement

### Description
Adds a package header to the transaction for installation.

### Signature
int rpmtsAddInstallElement(rpmts ts, Header h, const fnpyKey key, int upgrade, rpmRelocation *relocs)
```

--------------------------------

### RPM CLI Initialization and Configuration

Source: https://rpm.org/docs/latest/api/rpmcli_8h_source.html

Functions and global variables for initializing the RPM CLI environment and managing configuration settings.

```c
extern struct poptOption rpmcliAllPoptTable[];

extern const char * rpmcliPipeOutput;
extern const char * rpmcliRcfile;
extern const char * rpmcliRootDir;

poptContext
rpmcliInit(int argc, char *const argv[], struct poptOption * optionsTable);

void rpmcliConfigured(void);

poptContext
rpmcliFini(poptContext optCon);
```

--------------------------------

### rpmdsSingle

Source: https://rpm.org/docs/latest/api/group__rpmds.html

Creates, loads, and initializes a dependency set of size 1.

```APIDOC
## rpmdsSingle

### Description
Create, load and initialize a dependency set of size 1.

### Parameters
- **tagN** (rpmTagVal) - Type of dependency.
- **N** (const char *) - Name.
- **EVR** (const char *) - Epoch:version-release.
- **Flags** (rpmsenseFlags) - Comparison flags.

### Returns
- **rpmds** - New dependency set.
```

--------------------------------

### Dependency Breakdown

Source: https://rpm.org/docs/latest/manual/dependencies.html

The parsed components of the example dependency.

```text
    epoch=9
    version=5.00502
    release=3
```

--------------------------------

### RPM Header Data Alignment Example

Source: https://rpm.org/docs/latest/manual/format_header.html

Demonstration of padding bytes inserted to ensure proper alignment for INT32 data types.

```hex
00000060: 00 00 03 ef 00 00 00 06 00 00 00 28 00 00 00 01    ................
00000070: 00 00 03 f1 00 00 00 04 00 00 00 40 00 00 00 01    ................
...
00000240: 72 2e 72 65 64 68 61 74 2e 63 6f 6d 00 00 00 00    r.redhat.com....
00000250: 00 09 9b 31 52 65 64 20 48 61 74 20 4c 69 6e 75    ....Red Hat Linu
```

--------------------------------

### rpmtsInitDB()

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Initializes the database used by the transaction.

```APIDOC
## rpmtsInitDB()

### Description
Initialize the database used by the transaction.

### Parameters
- **ts** (rpmts) - Transaction set
- **perms** (int) - Database permissions (mode bits)

### Returns
- 0 on success
```

--------------------------------

### rpmtsPlugins

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Get the plugins associated with a transaction set.

```APIDOC
## rpmtsPlugins

### Description
Get the plugins associated with a transaction set.

### Parameters
- **ts** (rpmts) - Required - transaction set

### Returns
- **plugins** (rpmPlugins) - The plugins associated with the transaction set.
```

--------------------------------

### rpmtsGetRdb

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Get transaction set database handle.

```APIDOC
## rpmdb rpmtsGetRdb(rpmts ts)

### Description
Get transaction set database handle.

### Parameters
- **ts** (rpmts) - transaction set

### Returns
- transaction database handle
```

--------------------------------

### rpmcliInit

Source: https://rpm.org/docs/latest/api/group__rpmcli.html

Initializes the RPM CLI context using the provided command line arguments and options table.

```APIDOC
## rpmcliInit

### Description
Initializes the RPM CLI context. This function sets up the popt context for command line parsing.

### Signature
poptContext rpmcliInit(int argc, char *const argv[], struct poptOption *optionsTable)
```

--------------------------------

### rpmtsGetNotifyStyle

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Get transaction notify callback style.

```APIDOC
## int rpmtsGetNotifyStyle(rpmts ts)

### Description
Get transaction notify callback style.

### Parameters
- **ts** (rpmts) - transaction set

### Returns
- current callback style
```

--------------------------------

### rpmtsFilterFlags()

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Get the problem ignore bit mask.

```APIDOC
## rpmtsFilterFlags(rpmts ts)

### Description
Get problem ignore bit mask, i.e. bits to filter encountered problems.

### Parameters
- **ts** (rpmts) - Required - transaction set

### Returns
- **ignore bit mask** (rpmprobFilterFlags)
```

--------------------------------

### Query binary packages from a spec file

Source: https://rpm.org/docs/latest/man/rpmspec.1

Lists the binary packages that would be generated from the specified spec file.

```bash
rpmspec -q rpm.spec
```

```text
rpm-4.11.3-3.fc20.x86_64
rpm-libs-4.11.3-3.fc20.x86_64
rpm-build-libs-4.11.3-3.fc20.x86_64
...
```

--------------------------------

### rpmcliInit

Source: https://rpm.org/docs/latest/api/group__rpmcli.html

Initializes the RPM CLI executable context.

```APIDOC
## rpmcliInit

### Description
Initialize most everything needed by an rpm CLI executable context.

### Parameters
- **argc** (int) - Number of arguments
- **argv** (char *const[]) - Argument array
- **optionsTable** (struct poptOption *) - Popt option table

### Returns
- **poptContext** - The popt context or NULL on failure.
```

--------------------------------

### rpmteVfyLevel

Source: https://rpm.org/docs/latest/api/group__rpmte.html

Get the enforced per-package verify level.

```APIDOC
## int rpmteVfyLevel(rpmte te)

### Description
Get enforced per-package verify level. If per-package verify level isn't set for this element, rpmtsVfyLevel() value is returned.

### Parameters
- **te** (rpmte) - transaction element

### Returns
- package verify level
```

--------------------------------

### Query system configuration with posix.sysconf

Source: https://rpm.org/docs/latest/man/rpm-lua.7

Retrieves system configuration variables. Returns a table of all available settings if no selector is specified.

```lua
posix.sysconf('open_max')
```

--------------------------------

### rpmRestore()

Source: https://rpm.org/docs/latest/api/group__rpmcli.html

Restores file metadata such as permissions for installed packages.

```APIDOC
## int rpmRestore(rpmts ts, struct rpmInstallArguments_s * ia, ARGV_const_t argv)

### Description
Restore file metadata (perms etc) of installed package(s).

### Parameters
- **ts** (rpmts) - Transaction set
- **ia** (struct rpmInstallArguments_s *) - Control args/bits
- **argv** (ARGV_const_t) - Array of package names (NULL terminated)

### Returns
0 on success
```

--------------------------------

### Observe rpm.mi output across versions

Source: https://rpm.org/ticket/153

Example outputs observed when running the test script on different RPM versions.

```text
mi true
count(): 0
real: 15
```

```text
mi true
count(): 0
real: 37
```

```text
mi false
len: 0
count(): 0
real: 25
```

--------------------------------

### Get file suffix

Source: https://rpm.org/docs/latest/manual/macros

Extracts the file extension from a path.

```rpm
%{suffix:myfile.zip}
```

--------------------------------

### Get terminal name

Source: https://rpm.org/docs/latest/man/rpm-lua.7

Retrieves the name of the controlling terminal.

```lua
print(posix.ctermid())
```

--------------------------------

### Retrieve system information with posix.uname

Source: https://rpm.org/docs/latest/man/rpm-lua.7

Returns system information based on the provided format string.

```lua
print(posix.uname('%s %r'))
```

--------------------------------

### Get header instance

Source: https://rpm.org/docs/latest/api/header_8h_source.html

Retrieves the instance identifier of the header.

```c
unsigned int headerGetInstance(Header h)
```

--------------------------------

### Execute rpmbuild with conditional switches

Source: https://rpm.org/docs/latest/manual/conditionalbuilds.html

Example command line usage to enable or disable specific features during a package build.

```bash
$ rpmbuild -ba newpackage.spec --with gnutls --without openssl
```

--------------------------------

### rpmteDBInstance

Source: https://rpm.org/docs/latest/api/group__rpmte.html

Retrieve the last instance installed to the database for a transaction element.

```APIDOC
## unsigned int rpmteDBInstance(rpmte te)

### Description
Retrieve last instance installed to the database.

### Parameters
- **te** (rpmte) - Required - transaction element

### Returns
- **last install instance** (unsigned int)
```

--------------------------------

### Automated patch application with %autosetup

Source: https://rpm.org/docs/latest/manual/autosetup.html

The simplified approach using %autosetup to apply all patches declared in the spec automatically.

```RPM Spec
%prep
%autosetup
```

--------------------------------

### Get environment variables with %{getenv}

Source: https://rpm.org/docs/latest/man/rpm-macros.7

Retrieves the value of an environment variable.

```rpm

%{getenv:HOME}


```

--------------------------------

### Convert URL to path with %{url2path}

Source: https://rpm.org/docs/latest/man/rpm-macros.7

Translates a URL into a local file system path.

```rpm

%{url2path:http://rpm.org/not/there}


```

--------------------------------

### Get file suffix with %{suffix}

Source: https://rpm.org/docs/latest/man/rpm-macros.7

Extracts the file extension from a filename.

```rpm

%{suffix:myfile.zip}


```

--------------------------------

### Get process information with posix.getprocessid

Source: https://rpm.org/docs/latest/man/rpm-lua.7

Retrieves specific process identifiers.

```lua
if posix.getprocessid('pid') == 1 then
    ...
end
```

--------------------------------

### Configure rpmbuild autosigning with Sequoia

Source: https://rpm.org/docs/latest/man/rpm-setup-autosign.1

Sets up automatic signing for rpmbuild using the Sequoia PGP tool.

```bash
rpm-setup-autosign -p sq
```

--------------------------------

### Get login name with posix.getlogin

Source: https://rpm.org/docs/latest/man/rpm-lua.7

Retrieves the current login name.

```lua
n = posix.getlogin()
```

--------------------------------

### rpm.spawn({COMMAND} [, {ACTIONS}])

Source: https://rpm.org/docs/latest/man/rpm-lua.7

Executes an external program with optional input/output redirection.

```APIDOC
## rpm.spawn({COMMAND} [, {ACTIONS}])

### Description
Spawns an external program. Returns the exit status (zero on success) or a tuple (nil, message, code) on failure.

### Parameters
- **COMMAND** (table) - Required - A table consisting of the command and its arguments.
- **ACTIONS** (table) - Optional - A table for execution actions (stdin, stdout, stderr paths).
```

--------------------------------

### rgetprogname / rsetprogname

Source: https://rpm.org/docs/latest/api/rpmutil_8h.html

Functions to get or set the current program name.

```APIDOC
## rgetprogname / rsetprogname

### Description
Utility functions to manage the program name string.

### Signatures
const char *rgetprogname(void);
void rsetprogname(const char *name);
```

--------------------------------

### rpmtsRootDir

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Get transaction rootDir, i.e. path to chroot(2).

```APIDOC
## rpmtsRootDir

### Description
Get transaction rootDir, i.e. path to chroot(2).

### Parameters
- **ts** (rpmts) - Required - transaction set

### Returns
- **const char *** (const char *) - Transaction rootDir.
```

--------------------------------

### rpmtsGetTid

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Get transaction id, i.e. transaction time stamp.

```APIDOC
## rpm_tid_t rpmtsGetTid(rpmts ts)

### Description
Get transaction id, i.e. transaction time stamp.

### Parameters
- **ts** (rpmts) - transaction set

### Returns
- transaction id
```

--------------------------------

### Configure RPM for Sequoia PGP

Source: https://rpm.org/docs/latest/man/rpmsign.1

Add these macros to ~/.config/rpm/macros to set the signing implementation and key ID.

```text
%_openpgp_sign sq
%_openpgp_sign_id 7B36C3EE0CCE86EDBC3EFF2685B274E29F798E08
```

--------------------------------

### Get string from header

Source: https://rpm.org/docs/latest/api/header_8h_source.html

Retrieves a string value associated with a tag.

```c
const char * headerGetString(Header h, rpmTagVal tag)
```

--------------------------------

### Define RPMFILE_IS_INSTALLED macro

Source: https://rpm.org/docs/latest/api/rpmfiles_8h.html

Checks if a file state corresponds to an installed status.

```c
#define RPMFILE_IS_INSTALLED | ( |  | __x_| ) |   
((_x) == RPMFILE_STATE_NORMAL || (_x) == RPMFILE_STATE_NETSHARED)
```

--------------------------------

### rpmkxnBegin

Source: https://rpm.org/docs/latest/api/group__rpmts.html

Creates a keystore (lock) handle.

```APIDOC
## rpmkxnBegin(rpmts ts, rpmtxnFlags flags)

### Description
Initializes a new keystore handle for the given transaction set.

### Parameters
- **ts** (rpmts) - transaction set
- **flags** (rpmtxnFlags) - flags

### Returns
- **rpmtxn** - transaction handle
```

--------------------------------

### RPM File State Definitions

Source: https://rpm.org/docs/latest/api/rpmfiles_8h_source.html

Enumeration representing the installation state of a file.

```c
typedef enum rpmfileState_e {
 RPMFILE_STATE_MISSING = -1, /* used for unavailable data */
 RPMFILE_STATE_NORMAL = 0,
 RPMFILE_STATE_REPLACED = 1,
 RPMFILE_STATE_NOTINSTALLED = 2,
 RPMFILE_STATE_NETSHARED = 3,
 RPMFILE_STATE_WRONGCOLOR = 4
} rpmfileState;
```

```c
#define RPMFILE_IS_INSTALLED(_x) ((_x) == RPMFILE_STATE_NORMAL || (_x) == RPMFILE_STATE_NETSHARED)
```

--------------------------------

### rpmInitCrypto()

Source: https://rpm.org/docs/latest/api/group__rpmcrypto.html

Perform cryptography initialization.

```APIDOC
## int rpmInitCrypto(void)

### Description
Perform cryptography initialization. It must be called before any cryptography can be used within rpm. It's not normally necessary to call it directly as it's called in general rpm initialization routines.

### Returns
- 0 on success, -1 on failure
```

--------------------------------

### Import header from blob

Source: https://rpm.org/docs/latest/api/header_8h_source.html

Creates a header from a binary blob.

```c
Header headerImport(void *blob, unsigned int bsize, headerImportFlags flags)
```

--------------------------------

### posix.umask([MODE])

Source: https://rpm.org/docs/latest/manual/lua.html

Gets or sets the process file mode creation mask.

```APIDOC
## posix.umask([MODE])

### Description
Get or set process umask(2). MODE may be specified as an octal number or mode string.

### Parameters
- **MODE** (integer/string) - Optional - The new umask value.
```

--------------------------------

### Get XDG directory

Source: https://rpm.org/docs/latest/manual/macros

Expands to standard XDG base directory paths.

```rpm
%{xdg config}
```

--------------------------------

### rpmKeyringNew()

Source: https://rpm.org/docs/latest/api/group__rpmkeyring.html

Creates a new, empty keyring handle.

```APIDOC
## rpmKeyringNew()

### Description
Create a new, empty keyring.

### Returns
- **rpmKeyring** - new keyring handle
```

--------------------------------

### Get dirname of path with %{dirname}

Source: https://rpm.org/docs/latest/man/rpm-macros.7

Returns the directory component of a file path.

```rpm

%{dirname:/some/dir/file.suf}


```
Tokens:
Raw