[pacman-dev] [PATCH] manpage update: add real world examples

[Xavier Chantry]

On Mon, Jun 14, 2010 at 1:55 PM, Nico Schottelius
<nico-pacman-dev at schottelius.org> wrote:
> From: Nico Schottelius <nico at kr.ethz.ch>
>
> Signed-off-by: Nico Schottelius <nico at kr.ethz.ch>
> ---
>  doc/makepkg.8.txt |   16 ++++++++++++++++
>  doc/pacman.8.txt  |   19 +++++++++++++++++++
>  2 files changed, 35 insertions(+), 0 deletions(-)
>
> diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt
> index a2fdb3f..da8d750 100644
> --- a/doc/makepkg.8.txt
> +++ b/doc/makepkg.8.txt
> @@ -187,6 +187,22 @@ Environment Variables
>        corresponding value defined in linkman:makepkg.conf[5].
>
>
> +Examples
> +--------
> +To create a new package from scratch and let makepkg handle integrity checks:
> +
> +   $ mkdir mypkg
> +   $ cd mypkg
> +   # create PKGBUILD
> +   $ makepkg -g >> PKGBUILD
> +   $ makepkg
> +
> +Files
> +-----
> +PKGBUILD::
> +       Package build description file in the *current* directory.
> +
> +
>  Configuration
>  -------------
>  See linkman:makepkg.conf[5] for more details on configuring makepkg using the
> diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt
> index 3d14a42..69bed21 100644
> --- a/doc/pacman.8.txt
> +++ b/doc/pacman.8.txt
> @@ -415,6 +415,25 @@ original=X, current=Y, new=Z::
>        necessary changes into the original file.
>
>
> +Examples
> +--------
> +
> +pacman -Ss ne.hack::
> +       Search for regexp "ne.hack" in package database.
> +
> +pacman -S gpm::
> +       Download and install gpm including dependencies.
> +
> +pacman -U ./ceofhack-0.6.tar.xz::
> +       Install ceofhack found in the local file ceofhack-0.6.tar.xz.
> +
> +pacman -Syu::
> +       Update package list and upgrade all packages afterwards.
> +
> +pacman -Scc::
> +       Remove *all* packages from cache (-Sc removes only uninstalled ones).
> +
> +
>  Configuration
>  -------------
>  See linkman:pacman.conf[5] for more details on configuring pacman using the
> --
> 1.7.1
>
>
>

I like this, just one comment left : I would rather use a standard
filename produced by makepkg.
This is not enforced by pacman, but I would rather put one anyway in
the man page, e.g. zlib-1.2.5-1-x86_64.pkg.tar.xz
(-rel version , arch , .pkg)
And hopefully people know that ./ is not necessary and just indicate a path.