[Yum-devel] [PATCH] rework introduction to yum.8

Andrew Ford A.Ford at ford-mason.co.uk
Fri Jul 29 05:16:46 UTC 2011


The patch seemed to have been missed from my previous mail - however it was the first time I had used git-email.

Andrew


---
  docs/yum.8 |   89 ++++++++++++++++++++++++++++++++++++++---------------------
  1 files changed, 57 insertions(+), 32 deletions(-)

diff --git a/docs/yum.8 b/docs/yum.8
index ea18f34..f87a03c 100644
--- a/docs/yum.8
+++ b/docs/yum.8
@@ -6,16 +6,67 @@ yum \- Yellowdog Updater Modified
  \fByum\fP [options] [command] [package ...]
  .SH "DESCRIPTION"
  .PP
-\fByum\fP is an interactive, rpm based, package manager. It can automatically
+\fByum\fP is an extensible, high level, RPM-based, command line package
+manager.  It is similar to other high level package managers, such as apt-get
+and smart\&.  There are some GUI applications that interface directly to the
+\fByum\fP code, but more recent graphical interface development is happening
+with PackageKit and the gnome-packagekit application\&.
+.PP
+\fByum\fP can automatically
  perform system updates, including dependency analysis and obsolete processing
  based on "repository" metadata. It can also perform installation of new
  packages, removal of old packages and perform queries on the installed and/or
-available packages among many other commands/services (see below)\&. \fByum\fP
-is similar to other high level package managers like apt\-get and smart\&.
+available packages among many other commands/services (see below)\&.
+.PP
+\fByum\fP itself provides a number of core commands that are organized into three groups:
+.IP "\(bu" 4
+Reporting commands
+.IP "\(bu" 4
+Package installation, upgrade, and removal commands
+.IP "\(bu" 4
+Housekeeping and miscellaneous commands
+.PP
+Plugins may provide additional commands or options.  See the documentation for
+the individual plugins for details.
+.PP
+.SS "Specifying Package Names"
+A package can be specified to the install, update, remove, list, and info
+subcommands with any of the following combinations of name, version, release,
+architecture and epoch, as well as globs of any of those package label components:
+.IP
+.br
+\fBname\fP
+.br
+\fBname.arch\fP
+.br
+\fBname-ver\fP
+.br
+\fBname-ver-rel\fP
+.br
+\fBname-ver-rel.arch\fP
+.br
+\fBname-epoch:ver-rel.arch\fP
+.br
+\fBepoch:name-ver-rel.arch\fP
+.br
+\fB at groupname\fP
+.PP
+If the name starts with an @ character the rest of the name is taken to be a
+group name and is passed through to the relevant \fBgroups\fP subcommand.
  .PP
-While there are some graphical interfaces directly to the \fByum\fP code, more
-recent graphical interface development is happening with PackageKit and the
-gnome\-packagekit application\&.
+For example:
+.IP "\fByum remove kernel-2.4.1-10.i686\fP"
+this will remove this specific kernel-ver-rel.arch.
+.IP "\fByum list available 'foo*'\fP"
+this will list all available packages that match 'foo*'. (The single quotes
+will keep your shell from expanding the globs.)
+.IP "\fByum install '@Development Libraries'\fP"
+this will install all packages in the 'Development Libraries' group.
+.PP
+.SH CORE YUM COMMANDS
+.PP
+Unless the \-\-help or \-h option is given, one of the following commands or a
+command provided by a plugin must be specified\&.
  .PP
  \fIcommand\fP is one of:
  .br
@@ -558,32 +609,6 @@ security yum plugin.
  .IP

  .PP
-.SH "SPECIFYING PACKAGE NAMES"
-A package can be referred to for install, update, remove, list, info etc
-with any of the following as well as globs of any of the following:
-.IP
-.br
-\fBname\fP
-.br
-\fBname.arch\fP
-.br
-\fBname-ver\fP
-.br
-\fBname-ver-rel\fP
-.br
-\fBname-ver-rel.arch\fP
-.br
-\fBname-epoch:ver-rel.arch\fP
-.br
-\fBepoch:name-ver-rel.arch\fP
-.IP
-For example: \fByum remove kernel-2.4.1-10.i686\fP
-     this will remove this specific kernel-ver-rel.arch.
-.IP
-Or:          \fByum list available 'foo*'\fP
-     will list all available packages that match 'foo*'. (The single quotes will keep your shell from expanding the globs.)
-.IP
-.PP
  .SH "CLEAN OPTIONS"
  The following are the ways which you can invoke \fByum\fP in clean
  mode. Note that "all files" in the commands below means
-- 1.7.4.1



More information about the Yum-devel mailing list