Documentation updates
 

Document the following:

* -R can take a group
* -S can take a group and provision

I also split up the -S description into multiple paragraphs because it
was getting too large.

Signed-off-by: Nathan Jones <nathanj@insightbb.com>
---
doc/pacman.8.txt | 25 +++++++++++++++++++------
1 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt
index 99133dd..a106c94 100644
--- a/doc/pacman.8.txt
+++ b/doc/pacman.8.txt
@@ -43,10 +43,12 @@ Operations
individual '.tar.gz' packages. See <<QO,Query Options>> below.

*-R, --remove*::
- Remove a package from the system. Files belonging to the specified
- package will be deleted, and the database will be updated. Most
- configuration files will be saved with a `.pacsave` extension unless the
- '--nosave' option is used. See <<RO,Remove Options>> below.
+ Remove a package from the system. Groups can also be specified to be
+ removed, in which case every package in that group will be removed.
+ Files belonging to the specified package will be deleted, and the
+ database will be updated. Most configuration files will be saved
+ with a `.pacsave` extension unless the '--nosave' option is used.
+ See <<RO,Remove Options>> below.

*-S, --sync*::
Synchronize packages. Packages are installed directly from the ftp
@@ -54,8 +56,19 @@ Operations
example, `pacman -S qt` will download and install qt and all the
packages it depends on. If a package name exists in more than one repo, the
repo can be explicitly specified to clarify the package to install:
- `pacman -S testing/qt`. You can also use `pacman -Su` to upgrade all
- packages that are out of date. See <<SO,Sync Options>> below.
+ `pacman -S testing/qt`.
++
+In addition to packages, groups can be specified as well. For
+example, `pacman -S gnome` will install every package in the gnome
+group, as well as the dependencies of those packages.
++
+Packages which provide other packages are also handled. For example,
+`pacman -S foo` will first look for a foo package. If foo is not found,
+packages which provide the same functionality as foo will be searched
+for. If any package is found, it will be installed.
++
+You can also use `pacman -Su` to upgrade all packages that are out
+of date. See <<SO,Sync Options>> below.

*-U, --upgrade*::
Upgrade or add a package to the system. Either a URL or file path can be
--
1.5.3.7

_______________________________________________
pacman-dev mailing list
pacman-dev@archlinux.org
http://archlinux.org/mailman/listinfo/pacman-dev

Documentation updates
 

Nathan Jones wrote:
> Document the following:
>
> * -R can take a group
> * -S can take a group and provision
>
> I also split up the -S description into multiple paragraphs because it
> was getting too large.
>
> Signed-off-by: Nathan Jones <nathanj@insightbb.com>
> ---
> doc/pacman.8.txt | 25 +++++++++++++++++++------
> 1 files changed, 19 insertions(+), 6 deletions(-)
>
> diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt
> index 99133dd..a106c94 100644
> --- a/doc/pacman.8.txt
> +++ b/doc/pacman.8.txt
> @@ -43,10 +43,12 @@ Operations
> individual '.tar.gz' packages. See <<QO,Query Options>> below.
>
> *-R, --remove*::
> - Remove a package from the system. Files belonging to the specified
> - package will be deleted, and the database will be updated. Most
> - configuration files will be saved with a `.pacsave` extension unless the
> - '--nosave' option is used. See <<RO,Remove Options>> below.
> + Remove a package from the system. Groups can also be specified to be
> + removed, in which case every package in that group will be removed.
> + Files belonging to the specified package will be deleted, and the
> + database will be updated. Most configuration files will be saved
> + with a `.pacsave` extension unless the '--nosave' option is used.
> + See <<RO,Remove Options>> below.
>
> *-S, --sync*::
> Synchronize packages. Packages are installed directly from the ftp
> @@ -54,8 +56,19 @@ Operations
> example, `pacman -S qt` will download and install qt and all the
> packages it depends on. If a package name exists in more than one repo, the
> repo can be explicitly specified to clarify the package to install:
> - `pacman -S testing/qt`. You can also use `pacman -Su` to upgrade all
> - packages that are out of date. See <<SO,Sync Options>> below.
> + `pacman -S testing/qt`.
> ++
> +In addition to packages, groups can be specified as well. For
> +example, `pacman -S gnome` will install every package in the gnome
> +group, as well as the dependencies of those packages.
>
Minor point, but since pacman has moved to being distribution agnostic,
do we want to mention specific package names or stick to "foo"? This
would look strange on a distro that didn't provide GNOME.

> ++
> +Packages which provide other packages are also handled. For example,
> +`pacman -S foo` will first look for a foo package. If foo is not found,
> +packages which provide the same functionality as foo will be searched
> +for. If any package is found, it will be installed.
> ++
> +You can also use `pacman -Su` to upgrade all packages that are out
> +of date. See <<SO,Sync Options>> below.
>
> *-U, --upgrade*::
> Upgrade or add a package to the system. Either a URL or file path can be
>




_______________________________________________
pacman-dev mailing list
pacman-dev@archlinux.org
http://archlinux.org/mailman/listinfo/pacman-dev