1RPM(8) System Manager's Manual RPM(8)
2
6 rpm - RPM Package Manager
7
9 QUERYING AND VERIFYING PACKAGES:
10 rpm {-q|--query} [select-options] [query-options]
11 rpm {-V|--verify} [select-options] [verify-options]
15 rpm --import PUBKEY ...
19 rpm {-K|--checksig} [--nosignature] [--nodigest]
23 PACKAGE_FILE ...
24 INSTALLING, UPGRADING, AND REMOVING PACKAGES:
27 rpm {-i|--install} [install-options] PACKAGE_FILE ...
28 rpm {-U|--upgrade} [install-options] PACKAGE_FILE ...
32 rpm {-F|--freshen} [install-options] PACKAGE_FILE ...
36 rpm {-e|--erase} [--allmatches] [--nodeps] [--noscripts]
40 [--notriggers] [--test] PACKAGE_NAME ...
41 MISCELLANEOUS:
44 rpm {--initdb|--rebuilddb}
45 rpm {--addsign|--resign} PACKAGE_FILE ...
49 rpm {--querytags|--showrc}
53 rpm {--setperms|--setugids} PACKAGE_NAME ...
57 select-options
60 [PACKAGE_NAME] [-a,--all] [-f,--file FILE]
61 [-g,--group GROUP] {-p,--package PACKAGE_FILE]
62 [--fileid ID] [--hdrid SHA1] [--pkgid MD5] [--tid TID]
63 [--querybynumber HDRNUM] [--triggeredby PACKAGE_NAME]
64 [--whatprovides CAPABILITY] [--whatrequires CAPABILITY]
65 query-options
68 [--changelog] [-c,--configfiles] [-d,--docfiles] [--dump]
69 [--filesbypkg] [-i,--info] [--last] [-l,--list]
70 [--provides] [--qf,--queryformat QUERYFMT]
71 [-R,--requires] [--obsoletes] [--scripts] [-s,--state]
72 [--triggers,--triggerscripts]
73 verify-options
76 [--nodeps] [--nofiles] [--noscripts]
77 [--nodigest] [--nosignature]
78 [--nolinkto] [--nofiledigest] [--nosize] [--nouser]
79 [--nogroup] [--nomtime] [--nomode] [--nordev]
80 [--nocaps]
81 install-options
84 [--aid] [--allfiles] [--badreloc] [--excludepath OLDPATH]
85 [--excludedocs] [--force] [-h,--hash]
86 [--ignoresize] [--ignorearch] [--ignoreos]
87 [--includedocs] [--justdb] [--nodeps]
88 [--nodigest] [--nosignature] [--nosuggest]
89 [--noorder] [--noscripts] [--notriggers]
90 [--oldpackage] [--percent] [--prefix NEWPATH]
91 [--relocate OLDPATH=NEWPATH]
92 [--replacefiles] [--replacepkgs]
93 [--test]
94
97 rpm is a powerful Package Manager, which can be used to build, install,
98 query, verify, update, and erase individual software packages. A pack‐
99 age consists of an archive of files and meta-data used to install and
100 erase the archive files. The meta-data includes helper scripts, file
101 attributes, and descriptive information about the package. Packages
102 come in two varieties: binary packages, used to encapsulate software to
103 be installed, and source packages, containing the source code and
104 recipe necessary to produce binary packages.
105 One of the following basic modes must be selected: Query, Verify, Sig‐
107 nature Check, Install/Upgrade/Freshen, Uninstall, Initialize Database,
108 Rebuild Database, Resign, Add Signature, Set Owners/Groups, Show Query‐
109 tags, and Show Configuration.
110 GENERAL OPTIONS
112 These options can be used in all the different modes.
113 -?, --help
115 Print a longer usage message then normal.
116 --version
118 Print a single line containing the version number of rpm being
119 used.
120 --quiet
122 Print as little as possible - normally only error messages will
123 be displayed.
124 -v Print verbose information - normally routine progress messages
126 will be displayed.
127 -vv Print lots of ugly debugging information.
129 --rcfile FILELIST
131 Each of the files in the colon separated FILELIST is read
132 sequentially by rpm for configuration information. Only the
133 first file in the list must exist, and tildes will be expanded
134 to the value of $HOME. The default FILELIST is
135 /usr/lib/rpm/rpmrc:/usr/lib/rpm/red‐
136 hat/rpmrc:/etc/rpmrc:~/.rpmrc.
137 --pipe CMD
139 Pipes the output of rpm to the command CMD.
140 --dbpath DIRECTORY
142 Use the database in DIRECTORY rather than the default path
143 /var/lib/rpm
144 --root DIRECTORY
146 Use the file system tree rooted at DIRECTORY for all operations.
147 Note that this means the database within DIRECTORY will be used
148 for dependency checks and any scriptlet(s) (e.g. %post if
149 installing, or %prep if building, a package) will be run after a
150 chroot(2) to DIRECTORY.
151 -D, --define='MACRO EXPR'
153 Defines MACRO with value EXPR.
154 -E, --eval='EXPR'
156 Prints macro expansion of EXPR.
157 INSTALL AND UPGRADE OPTIONS
159 In these options, PACKAGE_FILE can be either rpm binary file or ASCII
160 package manifest (see PACKAGE SELECTION OPTIONS), and may be specified
161 as an ftp or http URL, in which case the package will be downloaded
162 before being installed. See FTP/HTTP OPTIONS for information on rpm's
163 internal ftp and http client support.
164 The general form of an rpm install command is
166 rpm {-i|--install} [install-options] PACKAGE_FILE ...
168 This installs a new package.
170 The general form of an rpm upgrade command is
172 rpm {-U|--upgrade} [install-options] PACKAGE_FILE ...
174 This upgrades or installs the package currently installed to a newer
176 version. This is the same as install, except all other version(s) of
177 the package are removed after the new package is installed.
178 rpm {-F|--freshen} [install-options] PACKAGE_FILE ...
180 This will upgrade packages, but only ones for which an earlier version
182 is installed.
183 --aid Add suggested packages to the transaction set when needed.
185 --allfiles
187 Installs or upgrades all the missingok files in the package,
188 regardless if they exist.
189 --badreloc
191 Used with --relocate, permit relocations on all file paths, not
192 just those OLDPATH's included in the binary package relocation
193 hint(s).
194 --excludepath OLDPATH
196 Don't install files whose name begins with OLDPATH.
197 --excludedocs
199 Don't install any files which are marked as documentation (which
200 includes man pages and texinfo documents).
201 --force
203 Same as using --replacepkgs, --replacefiles, and --oldpackage.
204 -h, --hash
206 Print 50 hash marks as the package archive is unpacked. Use
207 with -v|--verbose for a nicer display.
208 --ignoresize
210 Don't check mount file systems for sufficient disk space before
211 installing this package.
212 --ignorearch
214 Allow installation or upgrading even if the architectures of the
215 binary package and host don't match.
216 --ignoreos
218 Allow installation or upgrading even if the operating systems of
219 the binary package and host don't match.
220 --includedocs
222 Install documentation files. This is the default behavior.
223 --justdb
225 Update only the database, not the filesystem.
226 --nodigest
228 Don't verify package or header digests when reading.
229 --nomanifest
231 Don't process non-package files as manifests.
232 --nosignature
234 Don't verify package or header signatures when reading.
235 --nodeps
237 Don't do a dependency check before installing or upgrading a
238 package.
239 --nosuggest
241 Don't suggest package(s) that provide a missing dependency.
242 --noorder
244 Don't reorder the packages for an install. The list of packages
245 would normally be reordered to satisfy dependencies.
246 --noscripts
248 --nopre
250 --nopost
252 --nopreun
254 --nopostun
256 Don't execute the scriptlet of the same name. The --noscripts
257 option is equivalent to
258 --nopre --nopost --nopreun --nopostun
260 and turns off the execution of the corresponding %pre, %post,
262 %preun, and %postun scriptlet(s).
263 --notriggers
265 --notriggerin
267 --notriggerun
269 --notriggerpostun
271 Don't execute any trigger scriptlet of the named type. The
272 --notriggers option is equivalent to
273 --notriggerin --notriggerun --notriggerpostun
275 and turns off execution of the corresponding %triggerin, %trig‐
277 gerun, and %triggerpostun scriptlet(s).
278 --oldpackage
280 Allow an upgrade to replace a newer package with an older one.
281 --percent
283 Print percentages as files are unpacked from the package ar‐
284 chive. This is intended to make rpm easy to run from other
285 tools.
286 --prefix NEWPATH
288 For relocatable binary packages, translate all file paths that
289 start with the installation prefix in the package relocation
290 hint(s) to NEWPATH.
291 --relocate OLDPATH=NEWPATH
293 For relocatable binary packages, translate all file paths that
294 start with OLDPATH in the package relocation hint(s) to NEWPATH.
295 This option can be used repeatedly if several OLDPATH's in the
296 package are to be relocated.
297 --replacefiles
299 Install the packages even if they replace files from other,
300 already installed, packages.
301 --replacepkgs
303 Install the packages even if some of them are already installed
304 on this system.
305 --test Do not install the package, simply check for and report poten‐
307 tial conflicts.
308 ERASE OPTIONS
310 The general form of an rpm erase command is
311 rpm {-e|--erase} [--allmatches] [--nodeps] [--noscripts] [--notriggers]
313 [--test] PACKAGE_NAME ...
314 The following options may also be used:
317 --allmatches
319 Remove all versions of the package which match PACKAGE_NAME.
320 Normally an error is issued if PACKAGE_NAME matches multiple
321 packages.
322 --nodeps
324 Don't check dependencies before uninstalling the packages.
325 --noscripts
327 --nopreun
329 --nopostun
331 Don't execute the scriptlet of the same name. The --noscripts
332 option during package erase is equivalent to
333 --nopreun --nopostun
335 and turns off the execution of the corresponding %preun, and
337 %postun scriptlet(s).
338 --notriggers
340 --notriggerun
342 --notriggerpostun
344 Don't execute any trigger scriptlet of the named type. The
345 --notriggers option is equivalent to
346 --notriggerun --notriggerpostun
348 and turns off execution of the corresponding %triggerun, and
350 %triggerpostun scriptlet(s).
351 --test Don't really uninstall anything, just go through the motions.
353 Useful in conjunction with the -vv option for debugging.
354 QUERY OPTIONS
356 The general form of an rpm query command is
357 rpm {-q|--query} [select-options] [query-options]
359 You may specify the format that package information should be printed
362 in. To do this, you use the
363 --qf|--queryformat QUERYFMT
365 option, followed by the QUERYFMT format string. Query formats are mod‐
367 ified versions of the standard printf(3) formatting. The format is made
368 up of static strings (which may include standard C character escapes
369 for newlines, tabs, and other special characters) and printf(3) type
370 formatters. As rpm already knows the type to print, the type specifier
371 must be omitted however, and replaced by the name of the header tag to
372 be printed, enclosed by {} characters. Tag names are case insensitive,
373 and the leading RPMTAG_ portion of the tag name may be omitted as well.
374 Alternate output formats may be requested by following the tag with
376 :typetag. Currently, the following types are supported:
377 :armor Wrap a public key in ASCII armor.
379 :arraysize
381 Display number of elements in array tags.
382 :base64
384 Encode binary data using base64.
385 :date Use strftime(3) "%c" format.
387 :day Use strftime(3) "%a %b %d %Y" format.
389 :depflags
391 Format dependency comparison operator.
392 :deptype
394 Format dependency type.
395 :fflags
397 Format file flags.
398 :fstate
400 Format file state.
401 :hex Format in hexadecimal.
403 :octal Format in octal.
405 :perms Format file permissions.
407 :pgpsig
409 Display signature fingerprint and time.
410 :shescape
412 Escape single quotes for use in a script.
413 :triggertype
415 Display trigger suffix.
416 :vflags
418 File verification flags.
419 :xml Wrap data in simple xml markup.
421 For example, to print only the names of the packages queried, you could
423 use %{NAME} as the format string. To print the packages name and dis‐
424 tribution information in two columns, you could use %-30{NAME}%{DISTRI‐
425 BUTION}. rpm will print a list of all of the tags it knows about when
426 it is invoked with the --querytags argument.
427 There are two subsets of options for querying: package selection, and
429 information selection.
430 PACKAGE SELECTION OPTIONS:
432 PACKAGE_NAME
433 Query installed package named PACKAGE_NAME.
434 -a, --all
436 Query all installed packages.
437 -f, --file FILE
439 Query package owning FILE.
440 --fileid ID
442 Query package that contains a given file identifier. The ID is
443 the digest of the file contents. For different packages differ‐
444 ent hash algorithms may have been used (MD5, SHA1, SHA256,
445 SHA384, SHA512, ...)
446 -g, --group GROUP
448 Query packages with the group of GROUP.
449 --hdrid SHA1
451 Query package that contains a given header identifier, i.e. the
452 SHA1 digest of the immutable header region.
453 -p, --package PACKAGE_FILE
455 Query an (uninstalled) package PACKAGE_FILE. The PACKAGE_FILE
456 may be specified as an ftp or http style URL, in which case the
457 package header will be downloaded and queried. See FTP/HTTP
458 OPTIONS for information on rpm's internal ftp and http client
459 support. The PACKAGE_FILE argument(s), if not a binary package,
460 will be interpreted as an ASCII package manifest unless --noman‐
461 ifest option is used. In manifests, comments are permitted,
462 starting with a '#', and each line of a package manifest file
463 may include white space separated glob expressions, including
464 URL's, that will be expanded to paths that are substituted in
465 place of the package manifest as additional PACKAGE_FILE argu‐
466 ments to the query.
467 --pkgid MD5
469 Query package that contains a given package identifier, i.e. the
470 MD5 digest of the combined header and payload contents.
471 --querybynumber HDRNUM
473 Query the HDRNUMth database entry directly; this is useful only
474 for debugging.
475 --specfile SPECFILE
477 Parse and query SPECFILE as if it were a package. Although not
478 all the information (e.g. file lists) is available, this type of
479 query permits rpm to be used to extract information from spec
480 files without having to write a specfile parser.
481 --tid TID
483 Query package(s) that have a given TID transaction identifier. A
484 unix time stamp is currently used as a transaction identifier.
485 All package(s) installed or erased within a single transaction
486 have a common identifier.
487 --triggeredby PACKAGE_NAME
489 Query packages that are triggered by package(s) PACKAGE_NAME.
490 --whatprovides CAPABILITY
492 Query all packages that provide the CAPABILITY capability.
493 --whatrequires CAPABILITY
495 Query all packages that require CAPABILITY for proper function‐
496 ing.
497 PACKAGE QUERY OPTIONS:
499 --changelog
500 Display change information for the package.
501 -c, --configfiles
503 List only configuration files (implies -l).
504 -d, --docfiles
506 List only documentation files (implies -l).
507 --dump Dump file information as follows (implies -l):
509 path size mtime digest mode owner group isconfig isdoc rdev symlink
512 --filesbypkg
515 List all the files in each selected package.
516 -i, --info
518 Display package information, including name, version, and
519 description. This uses the --queryformat if one was specified.
520 --last Orders the package listing by install time such that the latest
522 packages are at the top.
523 -l, --list
525 List files in package.
526 --provides
528 List capabilities this package provides.
529 -R, --requires
531 List capabilities on which this package depends.
532 --obsoletes
534 List packages this package obsoletes.
535 --scripts
537 List the package specific scriptlet(s) that are used as part of
538 the installation and uninstallation processes.
539 -s, --state
541 Display the states of files in the package (implies -l). The
542 state of each file is one of normal, not installed, or replaced.
543 --triggers, --triggerscripts
545 Display the trigger scripts, if any, which are contained in the
546 package.
547 VERIFY OPTIONS
549 The general form of an rpm verify command is
550 rpm {-V|--verify} [select-options] [verify-options]
552 Verifying a package compares information about the installed files in
555 the package with information about the files taken from the package
556 metadata stored in the rpm database. Among other things, verifying
557 compares the size, digest, permissions, type, owner and group of each
558 file. Any discrepancies are displayed. Files that were not installed
559 from the package, for example, documentation files excluded on instal‐
560 lation using the "--excludedocs" option, will be silently ignored.
561 The package selection options are the same as for package querying
563 (including package manifest files as arguments). Other options unique
564 to verify mode are:
565 --nodeps
567 Don't verify dependencies of packages.
568 --nodigest
570 Don't verify package or header digests when reading.
571 --nofiles
573 Don't verify any attributes of package files.
574 --noscripts
576 Don't execute the %verifyscript scriptlet (if any).
577 --nosignature
579 Don't verify package or header signatures when reading.
580 --nolinkto
582 --nofiledigest (formerly --nomd5)
584 --nosize
586 --nouser
588 --nogroup
590 --nomtime
592 --nomode
594 --nordev
596 Don't verify the corresponding file attribute.
597 The format of the output is a string of 8 characters, a possible
599 attribute marker:
600 c %config configuration file.
602 d %doc documentation file.
603 g %ghost file (i.e. the file contents are not included in the package payload).
604 l %license license file.
605 r %readme readme file.
606 from the package header, followed by the file name. Each of the 8
608 characters denotes the result of a comparison of attribute(s) of the
609 file to the value of those attribute(s) recorded in the database. A
610 single "." (period) means the test passed, while a single "?" (question
611 mark) indicates the test could not be performed (e.g. file permissions
612 prevent reading). Otherwise, the (mnemonically emBoldened) character
613 denotes failure of the corresponding --verify test:
614 S file Size differs
616 M Mode differs (includes permissions and file type)
617 5 digest (formerly MD5 sum) differs
618 D Device major/minor number mismatch
619 L readL[22mink(2) path mismatch
620 U User ownership differs
621 G Group ownership differs
622 T mTime differs
623 P caPabilities differ
624 DIGITAL SIGNATURE AND DIGEST VERIFICATION
627 The general forms of rpm digital signature commands are
628 rpm --import PUBKEY ...
630 rpm {--checksig} [--nosignature] [--nodigest]
633 PACKAGE_FILE ...
634 The --checksig option checks all the digests and signatures contained
637 in PACKAGE_FILE to ensure the integrity and origin of the package. Note
638 that signatures are now verified whenever a package is read, and
639 --checksig is useful to verify all of the digests and signatures asso‐
640 ciated with a package.
641 Digital signatures cannot be verified without a public key. An ASCII
643 armored public key can be added to the rpm database using --import. An
644 imported public key is carried in a header, and key ring management is
645 performed exactly like package management. For example, all currently
646 imported public keys can be displayed by:
647 rpm -qa gpg-pubkey*
649 Details about a specific public key, when imported, can be displayed by
651 querying. Here's information about the Red Hat GPG/DSA key:
652 rpm -qi gpg-pubkey-db42a60e
654 Finally, public keys can be erased after importing just like packages.
656 Here's how to remove the Red Hat GPG/DSA key
657 rpm -e gpg-pubkey-db42a60e
659 SIGNING A PACKAGE
661 rpm --addsign|--resign PACKAGE_FILE ...
662 Both of the --addsign and --resign options generate and insert new sig‐
665 natures for each package PACKAGE_FILE given, replacing any existing
666 signatures. There are two options for historical reasons, there is no
667 difference in behavior currently.
668 USING GPG TO SIGN PACKAGES
670 In order to sign packages using GPG, rpm must be configured to run GPG
671 and be able to find a key ring with the appropriate keys. By default,
672 rpm uses the same conventions as GPG to find key rings, namely the
673 $GNUPGHOME environment variable. If your key rings are not located
674 where GPG expects them to be, you will need to configure the macro
675 %_gpg_path to be the location of the GPG key rings to use.
676 For compatibility with older versions of GPG, PGP, and rpm, only V3
678 OpenPGP signature packets should be configured. Either DSA or RSA ver‐
679 ification algorithms can be used, but DSA is preferred.
680 If you want to be able to sign packages you create yourself, you also
682 need to create your own public and secret key pair (see the GPG man‐
683 ual). You will also need to configure the rpm macros
684 %_signature
686 The signature type. Right now only gpg and pgp are supported.
687 %_gpg_name
689 The name of the "user" whose key you wish to use to sign your
690 packages.
691 For example, to be able to use GPG to sign packages as the user "John
693 Doe <jdoe@foo.com>" from the key rings located in /etc/rpm/.gpg using
694 the executable /usr/bin/gpg you would include
695 %_signature gpg
697 %_gpg_path /etc/rpm/.gpg
698 %_gpg_name John Doe <jdoe@foo.com>
699 %__gpg /usr/bin/gpg
700 in a macro configuration file. Use /etc/rpm/macros for per-system con‐
702 figuration and ~/.rpmmacros for per-user configuration. Typically it's
703 sufficient to set just %_gpg_name.
704 REBUILD DATABASE OPTIONS
706 The general form of an rpm rebuild database command is
707 rpm {--initdb|--rebuilddb} [-v] [--dbpath DIRECTORY] [--root DIRECTORY]
709 Use --initdb to create a new database if one doesn't already exist
712 (existing database is not overwritten), use --rebuilddb to rebuild the
713 database indices from the installed package headers.
714 MISCELLANEOUS COMMANDS
716 rpm --showrc
717 shows the values rpm will use for all of the options are cur‐
718 rently set in rpmrc and macros configuration file(s).
719 rpm --setperms PACKAGE_NAME
721 sets permissions of files in the given package.
722 rpm --setugids PACKAGE_NAME
724 sets user/group ownership of files in the given package.
725 Options --setperms and --setugids are mutually exclusive.
727 FTP/HTTP OPTIONS
730 rpm can act as an FTP and/or HTTP client so that packages can be
731 queried or installed from the internet. Package files for install,
732 upgrade, and query operations may be specified as an ftp or http style
733 URL:
734 ftp://USER:PASSWORD@HOST:PORT/path/to/package.rpm
736 If the :PASSWORD portion is omitted, the password will be prompted for
738 (once per user/hostname pair). If both the user and password are omit‐
739 ted, anonymous ftp is used. In all cases, passive (PASV) ftp transfers
740 are performed.
741 rpm allows the following options to be used with ftp URLs:
743 --ftpproxy HOST
745 The host HOST will be used as a proxy server for all ftp trans‐
746 fers, which allows users to ftp through firewall machines which
747 use proxy systems. This option may also be specified by config‐
748 uring the macro %_ftpproxy.
749 --ftpport PORT
751 The TCP PORT number to use for the ftp connection on the proxy
752 ftp server instead of the default port. This option may also be
753 specified by configuring the macro %_ftpport.
754 rpm allows the following options to be used with http URLs:
756 --httpproxy HOST
758 The host HOST will be used as a proxy server for all http trans‐
759 fers. This option may also be specified by configuring the macro
760 %_httpproxy.
761 --httpport PORT
763 The TCP PORT number to use for the http connection on the proxy
764 http server instead of the default port. This option may also be
765 specified by configuring the macro %_httpport.
766
768 Executing rpmbuild
769 The build modes of rpm are now resident in the /usr/bin/rpmbuild exe‐
770 cutable. Install the package containing rpmbuild (usually rpm-build)
771 and see rpmbuild(8) for documentation of all the rpm build modes.
772
774 rpmrc Configuration
775 /usr/lib/rpm/rpmrc
776 /usr/lib/rpm/redhat/rpmrc
777 /etc/rpmrc
778 ~/.rpmrc
779 Macro Configuration
781 /usr/lib/rpm/macros
782 /usr/lib/rpm/redhat/macros
783 /etc/rpm/macros
784 ~/.rpmmacros
785 Database
787 /var/lib/rpm/Basenames
788 /var/lib/rpm/Conflictname
789 /var/lib/rpm/Dirnames
790 /var/lib/rpm/Filemd5s
791 /var/lib/rpm/Group
792 /var/lib/rpm/Installtid
793 /var/lib/rpm/Name
794 /var/lib/rpm/Packages
795 /var/lib/rpm/Providename
796 /var/lib/rpm/Provideversion
797 /var/lib/rpm/Pubkeys
798 /var/lib/rpm/Removed
799 /var/lib/rpm/Requirename
800 /var/lib/rpm/Requireversion
801 /var/lib/rpm/Sha1header
802 /var/lib/rpm/Sigmd5
803 /var/lib/rpm/Triggername
804 Temporary
806 /var/tmp/rpm*
807
809 popt(3),
810 rpm2cpio(8),
811 rpmbuild(8),
812 rpm --help - as rpm supports customizing the options via popt aliases
814 it's impossible to guarantee that what's described in the manual
815 matches what's available.
816 http://www.rpm.org/ <URL:http://www.rpm.org/>
819
821 Marc Ewing <marc@redhat.com>
822 Jeff Johnson <jbj@redhat.com>
823 Erik Troan <ewt@redhat.com>
824Red Hat, Inc. 09 June 2002 RPM(8)