On Sun, Jun 13, 2010 at 3:28 PM, Nico Schottelius wrote:

Signed-off-by: Nico Schottelius ---  doc/pacman.8.txt |   10 ++++++++++  1 files changed, 10 insertions(+), 0 deletions(-)

Not inline, but ok, I will just copy/paste below :) diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index 3d14a42..3175ba5 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -415,6 +415,16 @@ original=X, current=Y, new=Z:: necessary changes into the original file. +Examples +-------- + +pacman -Syu:: + Update package list and upgrade all packages afterwards. + Yeah this is typically the important commands that are not obvious when just quickly browsing the man page. But as I said, it's already covered in the wiki : http://wiki.archlinux.org/index.php/Pacman#Upgrading_packages +pacman -U <'path'>:: + Install package found in the specified file. + This one looks like the abstract description we already have, just shorter : -U, --upgrade Upgrade or add package(s) to the system and install the required dependencies from sync repos. Either a URL or file path can be specified. This is a “remove-then-add” process. See Upgrade Options below; also see Handling Config Files for an explanation on how pacman takes care of config files.

From: Nico Schottelius Signed-off-by: Nico Schottelius --- 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..febb802 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 <'regexp'>:: + Search for regexp in package database. + +pacman -S <'packages'>:: + Download and install packages including dependencies. + +pacman -U <'paths'>:: + Install package found in the specified file(s). + +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

From: Nico Schottelius Signed-off-by: Nico Schottelius --- 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

From: Nico Schottelius Signed-off-by: Nico Schottelius --- 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..e0314dc 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 /home/nico/ceofhack-0.6-1-x86_64.pkg.tar.gz:: + Install ceofhack from a package file (as genererated by PKGBUILD from AUR). + +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

From: Nico Schottelius Signed-off-by: Nico Schottelius --- doc/makepkg.8.txt | 18 ++++++++++++++++++ doc/pacman.8.txt | 19 +++++++++++++++++++ 2 files changed, 37 insertions(+), 0 deletions(-) diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index a2fdb3f..ca99419 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -187,6 +187,24 @@ 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 + $ cp /usr/share/pacman/PKGBUILD.proto PKGBUILD + # edit PKGBUILD to your needs + $ 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..e0314dc 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 /home/nico/ceofhack-0.6-1-x86_64.pkg.tar.gz:: + Install ceofhack from a package file (as genererated by PKGBUILD from AUR). + +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

From: Nico Schottelius Signed-off-by: Nico Schottelius Signed-off-by: Xavier Chantry --- doc/pacman.8.txt | 22 ++++++++++++++++++++++ 1 files changed, 22 insertions(+), 0 deletions(-) diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index 3d14a42..e66e25c 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -415,6 +415,28 @@ 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 /home/nico/ceofhack-0.6-1-x86_64.pkg.tar.gz:: + Install ceofhack from a package file (as genererated by PKGBUILD from AUR). + +pacman -Syu:: + Update package list and upgrade all packages afterwards. + +pacman -Syu gpm:: + Update package list, upgrade all packages, and then install or upgrade gpm. + +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.1

Am 01.07.2010 03:21, schrieb Allan McRae:

On 01/07/10 06:23, Xavier Chantry wrote:

...

From: Nico Schottelius

Signed-off-by: Nico Schottelius Signed-off-by: Xavier Chantry ---

I like these examples. A couple of small changes and you get a Signed-off-by: Allan

...

doc/pacman.8.txt | 22 ++++++++++++++++++++++ 1 files changed, 22 insertions(+), 0 deletions(-)

diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index 3d14a42..e66e25c 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -415,6 +415,28 @@ 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 /home/nico/ceofhack-0.6-1-x86_64.pkg.tar.gz::

Generalize to /home/user/

...

+ Install ceofhack from a package file (as genererated by PKGBUILD from AUR).

We should not be mentioning the AUR. How about: Install ceofhack-0.6-1 package from a local file.

...

+ +pacman -Syu:: + Update package list and upgrade all packages afterwards. + +pacman -Syu gpm:: + Update package list, upgrade all packages, and then install or upgrade gpm. This should read "and then install gpm", or "and then install gpm additionally". If gpm was previously installed, it should be up-to-date after an -Syu - you cannot upgrade any further atm, you can only install new packages.

On 01/07/10 17:07, Xavier Chantry wrote:

From: Nico Schottelius

Signed-off-by: Nico Schottelius Signed-off-by: Xavier Chantry

Signed-off-by: Allan

--- doc/pacman.8.txt | 19 +++++++++++++++++++ 1 files changed, 19 insertions(+), 0 deletions(-)

diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index 3d14a42..de1f51f 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 /home/user/ceofhack-0.6-1-x86_64.pkg.tar.gz:: + Install ceofhack-0.6-1 package from a local file. + +pacman -Syu:: + Update package list and upgrade all packages afterwards. + +pacman -Syu gpm:: + Update package list, upgrade all packages, and then install gpm if it + wasn't already installed. + Configuration ------------- See linkman:pacman.conf[5] for more details on configuring pacman using the

On Tue, Oct 04, 2011 at 03:08:07PM +0200, Nico Schottelius wrote:

Hello .*,

This is a resent from the discussion from Mon, 14 Jun 2010 14:26:50 +0200, which seems never to get through to get applied.

http://projects.archlinux.org/pacman.git/commit/?id=9ebb59680530 Looks like the pacman portion of this was applied and shipped with the 3.5 release.

Can you check && apply?

Cheers,

Nico

From: Nico Schottelius

Signed-off-by: Nico Schottelius --- 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 +

If this is the only example we're going to add, I think we're setting a very poor standard. Checksums should always come from upstream, or else they don't have much meaning. There was a lot of discussion here (6/10) with no real constructive outcome other than -- "we're not really sure we want this in makepkg's manpage": http://mailman.archlinux.org/pipermail/pacman-dev/2010-June/011088.html

+Files +----- +PKGBUILD:: + Package build description file in the *current* directory. +

We have a whole manpage for this, and its linked in the SEE ALSO section of makepkg(8). I don't think this is needed. Seems inline with Allan's comments from above.

+ 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..e0314dc 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 /home/nico/ceofhack-0.6-1-x86_64.pkg.tar.gz:: + Install ceofhack from a package file (as genererated by PKGBUILD from AUR). + +pacman -Syu:: + Update package list and upgrade all packages afterwards. + +pacman -Scc:: + Remove *all* packages from cache (-Sc removes only uninstalled ones). + +

And as I already mentioned, this is in the pacman manpage installed on your system today. d

On Tue, Oct 4, 2011 at 9:08 PM, Nico Schottelius wrote:

Hello .*,

This is a resent from the discussion from Mon, 14 Jun 2010 14:26:50 +0200, which seems never to get through to get applied.

Can you check && apply?

Cheers,

Nico

From: Nico Schottelius

Signed-off-by: Nico Schottelius ---  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. + +

This is really redundant- anyone who knows what a PKGBUILD is knows how to use makepkg. Users of makepkg are required to read `makepkg --help` and the man page, after which the example above is just boring. Also misleading as `makepkg -g >> PKGBUILD` is not really the right way to do it- the packager should always first try to obtain checksums from upstream if possible. Also, fundamentally, why is this workflow an example? What's so special about the -g option it's picked out for demonstration? Just because *you* use it? That's pretty random, really.

 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..e0314dc 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 /home/nico/ceofhack-0.6-1-x86_64.pkg.tar.gz:: +       Install ceofhack from a package file (as genererated by PKGBUILD from AUR). + +pacman -Syu:: +       Update package list and upgrade all packages afterwards. + +pacman -Scc:: +       Remove *all* packages from cache (-Sc removes only uninstalled ones). + +

Surprisingly this is already in pacman man page... Again, why no example for -R, for example? Such examples are doomed to randomness. The only reason I think examples are justified is when they actually add clarification that otherwise can't be delivered. Take the date(1) man page: $ date --date='@2147483647' gives an example of a DATE STRING, which is explained nowhere else in the man page. $ TZ='America/Los_Angeles' date demonstrats the effect of TZ environment, which is also not mentioned elsewhere. On the other hand, the pacman examples above says almost nothing new. They're not only random, but also boring. I vote for removing this completely.

 Configuration  -------------  See linkman:pacman.conf[5] for more details on configuring pacman using the -- 1.7.1