Changeset 516 for yum/trunk/docs

yum/trunk

Property svn:mergeinfo set to
/yum/vendor/current merged eligible

yum/trunk/docs/yum.8

-              r2
+              r516
 .I \fR * update [package1] [package2] [\&.\&.\&.]
 .br
+.I \fR * update-to [package1] [package2] [\&.\&.\&.]
+.br
 .I \fR * check\-update
 .br
 .I \fR * upgrade [package1] [package2] [\&.\&.\&.]
+.br
+.I \fR * upgrade-to [package1] [package2] [\&.\&.\&.]
+.br
+.I \fR * distribution-synchronization [package1] [package2] [\&.\&.\&.]
 .br
 .I \fR * remove | erase package1 [package2] [\&.\&.\&.]
 …
 .I \fR * makecache
 .br
+.I \fR * groupinstall group1 [group2] [\&.\&.\&.]
+.br
+.I \fR * groupupdate group1 [group2] [\&.\&.\&.]
+.br
+.I \fR * grouplist [hidden] [groupwildcard] [\&.\&.\&.]
+.br
+.I \fR * groupremove group1 [group2] [\&.\&.\&.]
+.br
+.I \fR * groupinfo group1 [\&.\&.\&.]
+.I \fR * groups  [\&.\&.\&.]
 .br
 .I \fR * search string1 [string2] [\&.\&.\&.]
 …
 .br
 .I \fR * localinstall rpmfile1 [rpmfile2] [\&.\&.\&.]
+.br
+.I \fR * localupdate rpmfile1 [rpmfile2] [\&.\&.\&.]
+    (maintained for legacy reasons only - use install)
+.br
+.I \fR * localupdate rpmfile1 [rpmfile2] [\&.\&.\&.]
+    (maintained for legacy reasons only - use update)
 .br
 .I \fR * reinstall package1 [package2] [\&.\&.\&.]
 …
 .I \fR * repolist [all|enabled|disabled]
 .br
 .I \fR * version [all|installed|available|group-*|grouplist|groupinfo]
 .br
 .I \fR * history [info|list|summary|redo|undo|new]
+.I \fR * version [ all | installed | available | group-* | nogroups* | grouplist | groupinfo ]
+.br
+.I \fR * history [info|list|packages-list|summary|addon-info|redo|undo|rollback|new]
 .br
 .I \fR * check
 …
 If no package matches the given package name(s), they are assumed to be a shell
 glob and any matches are then installed\&. If the name starts with an
+@ character the rest of the name is used as though passed to the groupinstall command\&. If the name is a file, then install works
+@ character the rest of the name is used as though passed to the groupinstall
+command\&. If the name starts with a - character, then a search is done within
+the transaction and any matches are removed. If the name is a file, then install works
 like localinstall\&. If the name doesn't match a package, then package
 "provides" are searched (Eg. "_sqlitecache.so()(64bit)") as are
 …
 obsoletes in its calculations - this makes it better for distro\-version
 changes, for example: upgrading from somelinux 8.0 to somelinux 9.
+Note that "\fBupdate\fP" works on installed packages first, and only if there
+are no matches does it look for available packages. The difference is most
+noticable when you do "\fBupdate\fP foo-1-2" which will act exactly as
+"\fBupdate\fP foo" if foo-1-2 is installed. You can use the "\fBupdate-to\fP"
+if you'd prefer that nothing happen in the above case.
+.IP
+.IP "\fBupdate-to\fP"
+This command works like "\fBupdate\fP" but always specifies the version of the
+package we want to update to.
 .IP
 .IP "\fBcheck\-update\fP"
 …
 for more details.
 .IP
+.IP "\fBupgrade-to\fP"
+This command works like "\fBupgrade\fP" but always specifies the version of the
+package we want to update to.
+.IP
+.IP "\fBdistribution\-synchronization\fP or \fBdistro\-sync\fP"
+Synchronizes the installed package set with the latest packages available, this
+is done by either obsoleting, upgrading or downgrading as appropriate. This will
+"normally" do the same thing as the upgrade command however if you have the
+package FOO installed at version 4, and the latest available is only
+version 3, then this command will \fBdowngrade\fP FOO to version 3.
+If you give the optional argument "full", then the command will also reinstall
+packages where the install checksum and the available checksum do not match. And
+remove old packages (can be used to sync. rpmdb versions). The optional argument
+"different" can be used to specify the default operation.
+This command does not perform operations on groups, local packages or negative
+selections.
+.IP
 .IP "\fBremove\fP or \fBerase\fP"
 Are used to remove the specified packages from the system
 …
 removed\&. remove operates on groups, files, provides and filelists just like
 the "install" command\&.(See \fBSpecifying package names\fP for more information)
+Note that "yum" is included in the protected_packages configuration, by default.
+So you can't accidentally remove yum itself.
 .IP
 .IP "\fBlist\fP"
 …
 .IP
 .IP "\fBsearch\fP"
+Is used to find any packages matching a string in the description, summary
+and package name fields of an rpm. Useful for finding a package
+you do not know by name but know by some word related to it.
+This is used to find packages when you know something about the package but
+aren't sure of it's name. By default search will try searching just package
+names and summaries, but if that "fails" it will then try descriptions and url.
+Yum search orders the results so that those packages matching more terms will
+appear first.
+You can force searching everything by specifying "all" as the first argument.
 .IP
 .IP "\fBinfo\fP"
 …
 \fByum\fP repos.
 .IP
+.IP "\fBgroupinstall\fP"
+Is used to install all of the individual packages in a group, of the specified
+.IP "\fBgroups\fP"
+A command, new in 3.4.2, that collects all the subcommands that act on groups together.
+"\fBgroup install\fP" is used to install all of the individual packages in a group, of the specified
 types (this works as if you'd taken each of those package names and put them on
 the command line for a "yum install" command).
  The group_package_types configuration option specifies which types will
 be installed.
+.IP
+.IP "\fBgroupupdate\fP"
+Is just an alias for groupinstall, which will do the right thing because
+"\fBgroup update\fP" is just an alias for groupinstall, which will do the right thing because
 "yum install X" and "yum update X" do the same thing, when X is already
 installed.
+.IP
+.IP "\fBgrouplist\fP"
+Is used to list the available groups from all \fByum\fP repos. Groups are marked
+"\fBgroup list\fP" is used to list the available groups from all \fByum\fP repos. Groups are marked
 as "installed" if all mandatory packages are installed, or if a group doesn't
 have any mandatory packages then it is installed if any of the optional or
 …
 "user visible". If you pass the \-v option, to enable verbose mode, then the
 groupids are displayed.
+.IP
+.IP "\fBgroupremove\fP"
+Is used to remove all of the packages in a group, unlike "groupinstall" this
+"\fBgroup remove\fP" is used to remove all of the packages in a group, unlike "groupinstall" this
 will remove everything regardless of group_package_types. It is worth pointing
+out that packages can be in more than one group, so "groupinstall X Y" followed
+by "groupremove Y" does not do give you the same result as "groupinstall X".
+.IP
+.IP "\fBgroupinfo\fP"
+Is used to give the description and package list of a group (and which type
+out that packages can be in more than one group, so "group install X Y" followed
+by "group remove Y" does not do give you the same result as "group install X".
+The groupremove_leaf_only configuration changes the behaviour of this command
+to only remove packages which aren't required by something else.
+"\fBgroup info\fP" is used to give the description and package list of a group (and which type
 those packages are marked as). Note that you can use the yum-filter-data and
 yum-list-data plugins to get/use the data the other way around (Ie. what
 …
 mode, then the package names are matched against installed/available packages
 similar to the list command.
 .IP
+.IP
 .IP "\fBshell\fP"
 Is used to enter the 'yum shell', when a filename is specified the contents of
 …
 Is used to install a set of local rpm files. If required the enabled
 repositories will be used to resolve dependencies. Note that the install command
+will do a local install, if given a filename.
+will do a local install, if given a filename. This option is maintained for legacy
+reasons only.
 .IP
 .IP "\fBlocalupdate\fP"
 …
 the remaining specified packages will be ignored.
 If required the enabled repositories will be used to resolve dependencies. Note
+that the update command will do a local install, if given a filename.
+that the update command will do a local update, if given a filename. This option is maintained for
+legacy reasons only.
 .IP
 .IP "\fBreinstall\fP"
 …
 should work (and thus. all the simple cases will work). Also this does not
 work for "installonly" packages, like Kernels. downgrade operates
 on groups, files, provides and filelists just like the "install" command\&.
+on groups, files, provides, filelists and rpm files just like the "install" command\&.
 .IP
 .IP "\fBdeplist\fP"
 Produces a list of all dependencies and what packages provide those
+dependencies for the given packages.
+dependencies for the given packages. As of 3.2.30 it now just shows the latest
+version of each package that matches (this can be changed by
+using --showduplicates) and it only shows the newest providers (which can be
+changed by using --verbose).
 .IP
 .IP "\fBrepolist\fP"
 …
 You can pass repo id or name arguments, or wildcards which to match against
 both of those. However if the ir or name matches exactly then the repo will
+both of those. However if the id or name matches exactly then the repo will
 be listed even if you are listing enabled repos. and it is disabled.
 …
 the yumdb. Note that this rpmdb version is now also used significantly within
 yum (esp. in yum history).
+The version command will now show "groups" of packages as a separate version,
+and so takes sub-commands:
+"version grouplist" - List the defined version groups.
+"version groupinfo" - Get the complete list of packages within one or more version groups.
+"version installed" - This is the default, only show the version information for installed packages.
+"version available" - Only show the version information for available packages.
+"version all" - Show the version information for installed and available packages.
+"version nogroups | nogroups-*" - Just show the main version information.
+"version group-*" - Just show the grouped version information, if more arguments are given then only show the data for those groups.
 .IP
 .IP "\fBhistory\fP"
 The history command allows the user to view what has happened in past
 transactions (assuming the history_record config. option is set). You can use
 info/list/summary to view what happened, undo/redo to act on that information
 and new to start a new history file.
+info/list/packages-list/summary to view what happened, undo/redo/rollback to act
+on that information and new to start a new history file.
 The info/list/summary commands take either a transaction id or a package (with
 …
 no arguments. list can be passed the keyword "all" to list all the transactions.
+The undo/redo commands take either a transaction id or the keyword last and
+an offset from the last transaction (Eg. if you've done 250 transactions,
+"last" refers to transaction 250, and "last-4" refers to transaction 246).
+The packages-list command takes a package  (with wildcards, as in
+\fBSpecifying package names\fP).
+The undo/redo/rollback commands take either a single transaction id or the
+keyword last and an offset from the last transaction (Eg. if you've done 250
+transactions, "last" refers to transaction 250, and "last-4" refers to
+transaction 246).
+The undo/redo commands act on the specified transaction, undo'ing or repeating
+the work of that transaction. While the rollback command will undo all
+transactions upto the point of the specified transaction. For example, if you
+have 3 transactions, where package A; B and C where installed respectively.
+Then "undo 1" will try to remove pacakge A, "redo 1" will try to install package
+A (if it is not still installed), and "rollback 1" will try to remove packages
+B and C. Note that after a "rollback 1" you will have a fourth transaction,
+although the ending rpmdb version (see: yum version) should be the same in
+transactions 1 and 4.
+The addon-info command takes a transaction ID, and the packages-list command
+takes a package (with wildcards).
+In "history list" you can change the behaviour of the 2nd column via. the
+configuration option history_list_view.
 In "history list" output the Altered column also gives some extra information
+if there was something not good with the transaction.
+if there was something not good with the transaction (this is also shown at the
+end of the package column in the packages-list command).
 .I \fB>\fR - The rpmdb was changed, outside yum, after the transaction.
 …
 .br
 .I \fB#\fR - The transaction completed, but with a non-zero status.
+.br
+.I \fBE\fR - The transaction completed fine, but had warning/error output during the transaction.
+.br
+.I \fBP\fR - The transaction completed fine, but problems already existed in the rpmdb.
+.br
+.I \fBs\fR - The transaction completed fine, but --skip-broken was enabled and had to skip some packages.
 .br
 …
 can pass the check command the arguments "dependencies" or "duplicates", to
 limit the checking that is performed (the default is "all" which does both).
+The info command can also take ranges of transaction ids, of the form
+start..end, which will then display a merged history as if all the
+transactions in the range had happened at once\&.
+.br
+Eg. "history info 1..4" will merge the first four transactions and display them
+as a single transaction.
 .IP
 .IP "\fBhelp\fP"
 …
 .IP "\fB\-C, \-\-cacheonly\fP"
 Tells yum to run entirely from system cache - does not download or
+update any headers unless it has to to perform the requested action.
+update any headers unless it has to to perform the requested action. If you're
+using this as a user yum will not use the tempcache for the user but will only
+use the system cache in the system cachedir.
 .IP "\fB\-\-version\fP"
 Reports the \fByum\fP version number and installed package versions for
 …
 .IP "\fB\-\-installroot=root\fP"
 Specifies an alternative installroot, relative to which all packages will be
+installed.
+installed. Think of this like doing "chroot <root> yum" except using
+\-\-installroot allows yum to work before the chroot is created.
+Note: You may also want to use the option \-\-releasever=/ when creating the
+installroot as otherwise the $releasever value is taken from the rpmdb within
+the installroot (and thus. will be empty, before creation).
 .br
 Configuration Option: \fBinstallroot\fP
 …
 .IP "\fB\-\-releasever=version\fP"
 Pretend the current release version is the given string. This is very useful
+when combined with \-\-installroot. Note that with the default upstream cachedir,
+of /var/cache/yum, using this option will corrupt your cache (and you can use
+$releasever in your cachedir configuration to stop this).
+when combined with \-\-installroot. You can also use \-\-releasever=/ to take
+the releasever information from outside the installroot.
+Note that with the default upstream cachedir, of /var/cache/yum, using this
+option will corrupt your cache (and you can use $releasever in your cachedir
+configuration to stop this).
 .PP
 .IP "\fB\-t, \-\-tolerant\fP"
 This option currently does nothing.
 .br
+.IP "\fB\-\-setopt=option=value\fP"
+Set any config option in yum config or repo files. For options in the global
+config just use: \-\-setopt=option=value for repo options use: \-\-setopt=repoid.option=value
+.PP
 .SH "LIST OPTIONS"
 The following are the ways which you can invoke \fByum\fP in list
 …
 availability of packages. Using this option will force yum to download all the
 metadata the next time it is run.
-.IP "\fByum clean dbcache\fP"
-Eliminate the sqlite cache used for faster access to metadata.
-Using this option will force yum to download the sqlite metadata the next time
-it is run, or recreate the sqlite metadata if using an older repo.
 .IP "\fByum clean dbcache\fP"

yum/trunk/docs/yum.conf.5

-              r2
+              r516
 .IP
+\fBprotected_packages\fR
+This is a list of packages that yum should never completely remove. They are
+protected via. Obsoletes as well as user/plugin removals.
+The default is: yum glob:/etc/yum/protected.d/*.conf
+So any packages which should be protected can do so by including a file in
+/etc/yum/protected.d with their package name in it.
+Also if this configuration is set to anything, then yum will protect the
+package corresponding to the running version of the kernel.
+.IP
+\fBprotected_multilib\fR
+Either `1' or `0'. This tells yum whether or not it should perform a check to
+make sure that multilib packages are the same version. For example, if this
+option is off (rpm behaviour) pkgA-1.x86_64 and pkgA-2.i386 can be installed
+at the same time. However this is very rarely desired.
+Install only packages, like the kernel, are exempt from this check.
+The default is `1'.
+.IP
 \fBlogfile\fR
 Full directory and file name for where yum should write its log file.
 …
 Either `1' or `0'. This tells yum whether or not it should perform a GPG
 signature check on packages. When this is set in the [main] section it sets the
+default for all repositories. This option also determines whether or not an
+install of a package from a local RPM file will be GPG signature checked. The
+default is `0'.
+default for all repositories.
+The default is `0'.
+\fBlocalpkg_gpgcheck\fR
+Either `1' or `0'. This tells yum whether or not it should perform a GPG
+signature check on local packages (packages in a file, not in a repositoy).
+The default is `0'.
 .IP
 …
 .IP
 \fBinstallonlypkgs \fR
+List of packages that should only ever be installed, never updated. Kernels
+in particular fall into this category. Defaults to kernel, kernel-smp,
+kernel-bigmem, kernel-enterprise, kernel-debug, kernel-unsupported.
+List of package provides that should only ever be installed, never updated.
+Kernels in particular fall into this category. Defaults to kernel,
+kernel-bigmem, kernel-enterprise, kernel-smp, kernel-modules, kernel-debug,
+kernel-unsupported, kernel-source, kernel-devel, kernel-PAE, kernel-PAE-debug.
+Note that because these are provides, and not just package names, kernel-devel
+will also apply to kernel-debug-devel, etc.
 .IP
 …
 .IP
+\fBgroupremove_leaf_only \fR
+Either `0' or `1'. Used to determine yum's behaviour when the groupremove
+command is run.  If \fBgroupremove_leaf_only\fR is `0' (default) then
+all packages in the group will be removed.  If \fBgroupremove_leaf_only\fR is
+`1' then only those packages in the group that aren't required by another
+package will be removed.
+.IP
 \fBenable_group_conditionals\fR
 Either `0' or `1'. Determines whether yum will allow the use of conditionals
 …
 \fBtsflags\fR
 Comma or space separated list of transaction flags to pass to the rpm
+transaction set. These include 'noscripts', 'notriggers', 'nodocs', 'test', and 'repackage'.
+transaction set. These include 'noscripts', 'notriggers', 'nodocs', 'test', 'justdb' and 'nocontexts'. 'repackage' is also available but that does nothing
+with newer rpm versions.
 You can set all/any of them. However, if you don't know what these do in the
 context of an rpm transaction set you're best leaving it alone. Default is
 …
 .IP
 \fBsslverify \fR
+Boolean - should yum verify SSL certificates/hosts at all. Defaults to True
+Boolean - should yum verify SSL certificates/hosts at all. Defaults to True.
+Note that the plugin yum-rhn-plugin will force this value to true, and may
+alter other ssl settings (like hostname checking), even if it the machine
+is not registered.
 .IP
 …
 Path to the SSL client certificate yum should use to connect to repos/remote sites
 Defaults to none.
+Note that if you are using curl compiled against NSS (default in Fedora/RHEL),
+curl treats sslclientcert values with the same basename as _identical_. This
+version of yum will check that this isn't true and output an error when the
+repositories "foo" and "bar" violate this, like so:
+sslclientcert basename shared between foo and bar
 .IP
 …
 history undo/redo commands. Defaults to True.
+Note that if history is recorded, yum uses that information to see if any
+modifications to the rpmdb have been done outside of yum. These are always bad,
+from yum's point of view, and so yum will issue a warning and automatically
+run some of "yum check" to try and find some of the worst problems altering
+the rpmdb might have caused.
+.IP
+This means that turning this option off will stop yum from being able to
+detect when the rpmdb has changed and thus. it will never warn you or
+automatically run "yum check". The problems will likely still be there, and
+yumdb etc. will still be wrong but yum will not warn you about it.
 .IP
 \fBhistory_record_packages \fR
 …
 .IP
+\fBhistory_list_view \fR
+Which column of information to display in the "yum history list" command. There
+are currently three options: users, cmds (or commands), auto.
+Older versions of yum acted like "users", which always outputs the user who
+initiated the yum transaction. You can now specify "commands" which will instead
+always output the command line of the transaction. You can also specify
+"single-user-commands" which will display the users if there are more than one,
+otherwise it will display the command line.
+You can also specify "default" which currently selects "single-user-commands".
+.IP
 \fBcommands\fR
 List of functional commands to run if no functional commands are specified
 …
 .IP
 \fBsyslog_ident \fR
+XXX not implemented yet
+Identification (program name) for syslog messages.
 .IP
 \fBsyslog_facility \fR
+XXX not implemented yet
+Facility name for syslog messages, see syslog(3).  Default is `LOG_USER'.
+.IP
+\fBsyslog_device \fR
+Where to log syslog messages. Can be a local device (path) or a host:port
+string to use a remote syslog.  If empty or points to a nonexistent device,
+syslog logging is disabled.  Default is `/dev/log'.
 .IP
 …
 \fBproxy_password \fR
 password for this proxy
+.IP
+\fBusername \fR
+username to use for basic authentication to a repo or really any url.
+.IP
+\fBpassword \fR
+password to use with the username for basic authentication.
 .IP
 …
 lower the value of this option. You can also change from the default of using
 seconds to using days, hours or minutes by appending a d, h or m respectively.
 The default is 1.5 hours, to compliment yum-updatesd running once an hour.
+The default is 6 hours, to compliment yum-updatesd running once an hour.
 It's also possible to use the word "never", meaning that the metadata will
 never expire. Note that when using a metalink file the metalink must always
 …
 .IP
 \fBcolor \fR
+Display colorized output automatically, depending on the output terminal,
+always (using ANSI codes) or never.
+Whether to display colorized output automatically, depending on the output
+terminal, can be changed to always (using ANSI codes) or never.
+Default is `auto'.
+Possible values are: auto, never, always.
 Command-line option: \fB\-\-color\fP
 …
 Default is `normal'.
 See color_list_installed_older for possible values.
+.IP
+\fBclean_requirements_on_remove \fR
+When removing packages (by removal, update or obsoletion) go through each
+package's dependencies. If any of them are no longer required by any other
+package then also mark them to be removed.
+Boolean (1, 0, True, False, yes,no) Defaults to False
 .SH "[repository] OPTIONS"
 …
 .IP
+\fBgpgcakey\fR
+A URL pointing to the ASCII-armored CA key file for the repository. This is a normal
+gpg public key - but this key will be used to validate detached signatures of all
+other keys. The idea is you are asked to confirm import for this key. After that any other
+gpg key needed for package or repository verification, if it has a detached signature which matches this
+key will be automatically imported without user confirmation.
+.IP
 \fBexclude\fR
 Same as the [main] \fBexclude\fR option but only for this repository.
 …
 If this is unset it inherits it from the global setting
+.IP
+\fBusername \fR
+username to use for basic authentication to a repo or really any url.
+If this is unset it inherits it from the global setting
+.IP
+\fBpassword \fR
+password to use with the username for basic authentication.
+If this is unset it inherits it from the global setting
 .IP
 \fBcost \fR
 …
 Included files may contain further include lines. Yum will abort with an error
 if an inclusion loop is detected.
+.SH "GLOB: FOR LIST OPTIONS"
+.LP
+Any of the configurations options which are a list of items can be specfied
+using the glob syntax: \fBglob:/etc/path/somewhere.d/*.conf\fR. This
+will read in all files matching that glob and include all lines in each file
+(excluding comments and blank lines) as items in the list.
+.LP
 .SH "VARIABLES"
 …
 configuration file variable will not be replaced.
+.LP
+As of 3.2.28, any file in /etc/yum/vars is turned into a variable named after
+the filename (or overrides any of the above variables).
+Note that no warnings/errors are given if the files are unreadable, so creating
+files that only root can read may be confusing for users.
+Also note that only the first line will be read and all new line
+characters are removed, as a convenience. However, no other checking is
+performed on the data. This means it is possible to have bad character
+data in any value.
 .SH "FILES"
 …
 /etc/yum/repos.d/
 /etc/yum/pluginconf.d/
+/etc/yum/protected.d
+/etc/yum/vars
 .SH "SEE ALSO"

Context Navigation

Legend:

yum/trunk

yum/trunk/docs/yum.8

yum/trunk/docs/yum.conf.5

Download in other formats: