Dear pacman-devs,
after a funny replace pacman-with-pacman-git evening, I digged around a bit into makepkg and pacman and noticed there are no examples in the manpages.
Is that intented or would you like to/accept patches which add the EXAMPLES section?
Cheers,
Nico
On 13/06/10 10:53, Nico Schottelius wrote:
Dear pacman-devs,
after a funny replace pacman-with-pacman-git evening, I digged around a bit into makepkg and pacman and noticed there are no examples in the manpages.
Is that intented or would you like to/accept patches which add the EXAMPLES section?
Can you clarify what sort of examples you think would be useful?
Allan
Allan McRae [Sun, Jun 13, 2010 at 11:18:42AM +1000]:
On 13/06/10 10:53, Nico Schottelius wrote:
Dear pacman-devs,
after a funny replace pacman-with-pacman-git evening, I digged around a bit into makepkg and pacman and noticed there are no examples in the manpages.
Is that intented or would you like to/accept patches which add the EXAMPLES section?
Can you clarify what sort of examples you think would be useful?
The first thing that came to my mind is:
How to use makepkg correctly (Running it for pacman-git's PKGCONFIG results in ==> ERROR: Install file (pacman.install) does not exist.)
How to install a package from a file One finds this on the wiki, but I would prefer to have it available offline
How to upgrade your system How to remove a package How to downgrade a package
That's not much for now, but having examples gives a better and faster insight into the application (git devs did that pretty good).
Nico
How to use makepkg correctly (Running it for pacman-git's PKGCONFIG results in ==> ERROR: Install file (pacman.install) does not exist.)
How to install a package from a file One finds this on the wiki, but I would prefer to have it available offline
How to upgrade your system How to remove a package How to downgrade a package
That's not much for now, but having examples gives a better and faster insight into the application (git devs did that pretty good).
Can I sugest the pacman tips available in the wiki? http://wiki.archlinux.org/index.php/Pacman_Tips#Aliases
Nico
-- New PGP key: 7ED9 F7D3 6B10 81D7 0EC5 5C09 D7DC C8E4 3187 7DF0 Please resign, if you signed 9885188C or 8D0E27A4.
Currently moving *.schottelius.org to http://www.nico.schottelius.org/ ...
On 13 June 2010 09:45, Ivan S. Freitas ivansichfreitas@gmail.com wrote:
How to use makepkg correctly (Running it for pacman-git's PKGCONFIG results in ==> ERROR: Install file (pacman.install) does not exist.)
How to install a package from a file One finds this on the wiki, but I would prefer to have it available offline
How to upgrade your system How to remove a package How to downgrade a package
That's not much for now, but having examples gives a better and faster insight into the application (git devs did that pretty good).
Can I sugest the pacman tips available in the wiki? http://wiki.archlinux.org/index.php/Pacman_Tips#Aliases
I don't think those would be wise additions to a manual.
Example(s):
pacman -S package - install a package
And stuff like the above are a waste over what is already obvious from the manual anyway.
The downgrade one..you could probably forget about it as well. The only helpful example with regards to usage would be nested commands which not everyone is aware of, I would guess:
pacman -S package1-{foo,bar1-{one,two}}
But, good examples are good examples, if you can come up with them :)
-- GPG/PGP ID: B42DDCAD
Ray Rashif [Sun, Jun 13, 2010 at 10:57:40AM +0800]:
On 13 June 2010 09:45, Ivan S. Freitas ivansichfreitas@gmail.com wrote:
How to use makepkg correctly (Running it for pacman-git's PKGCONFIG results in ==> ERROR: Install file (pacman.install) does not exist.)
How to install a package from a file One finds this on the wiki, but I would prefer to have it available offline
How to upgrade your system How to remove a package How to downgrade a package
That's not much for now, but having examples gives a better and faster insight into the application (git devs did that pretty good).
Can I sugest the pacman tips available in the wiki? http://wiki.archlinux.org/index.php/Pacman_Tips#Aliases
I don't think those would be wise additions to a manual.
Example(s):
pacman -S package - install a package
That wasn't meant, although I don't consider it harmful, because "sync" is probably not what one associates with "install" in general.
If you reread my post above, you'll notice that I refer pacman -U /path/to/pkg, which is absolutely not obvious for a newbie.
And stuff like the above are a waste over what is already obvious from the manual anyway.
Not sure whether I can agree with this statement - if there's one person repoting to not understanding the manual, there are probably hundreds more who haven't reported, and thus its worth to add information.
The downgrade one..you could probably forget about it as well. The only helpful example with regards to usage would be nested commands which not everyone is aware of, I would guess:
pacman -S package1-{foo,bar1-{one,two}}
But, good examples are good examples, if you can come up with them :)
I'll probably add some ideas to a git repo and let me blame for the proposed ideas afterwards, so no confusion comes up.
Nico
Hey Ivan,
Ivan S. Freitas [Sat, Jun 12, 2010 at 10:45:30PM -0300]:
How to use makepkg correctly (Running it for pacman-git's PKGCONFIG results in ==> ERROR: Install file (pacman.install) does not exist.)
How to install a package from a file One finds this on the wiki, but I would prefer to have it available offline
How to upgrade your system How to remove a package How to downgrade a package
That's not much for now, but having examples gives a better and faster insight into the application (git devs did that pretty good).
Can I sugest the pacman tips available in the wiki? http://wiki.archlinux.org/index.php/Pacman_Tips#Aliases
I'm not really sure whether we mean the same - I'm more speaking about basic usage of pacman and to understand it, which belongs to a manpage imho.
But that's probably more a thinking way issue, because I expect a manpage of a program to tell me enough to understand everything a program provides.
Nico
On Sun, Jun 13, 2010 at 2:53 AM, Nico Schottelius nico-pacman-dev@schottelius.org wrote:
Dear pacman-devs,
after a funny replace pacman-with-pacman-git evening, I digged around a bit into makepkg and pacman and noticed there are no examples in the manpages.
Is that intented or would you like to/accept patches which add the EXAMPLES section?
I remember a discussion about this on irc a while ago. I completely agree that EXAMPLES section is very nice, it's always the first thing I look up in a man page of a new program, and I am disappointed when I don't find any, and delighted when I find one :)
However, I was also wondering some times ago what the purpose of our wiki page was. It seemed like a duplicate of our man pages, and thus two places we needed to keep in sync and update. Then I realized the wiki page was actually the EXAMPLES section we don't have, it doesn't present options like in our man pages, it presents them by examples. http://wiki.archlinux.org/index.php/Pacman
So I am happy with how things are now, adding something has the risk of causing more duplication and more work.
Hello devs,
I'm happy for all the feedback and published a very simple change to pacman(8), which demonstrates how I would populate the section [0].
If you like it, you can pull from [1] and let me know. I would go for makepkg next, to have a hint on how to use it.
Cheers,
Nico
[0] http://git.schottelius.org/?p=foreign/pacman;a=commit;h=9d04a7451d32f8b2aa91... [1] git://git.schottelius.org/foreign/pacman
And another one for makepkg, which would saved my a lot of time searching around the net:
http://git.schottelius.org/?p=foreign/pacman;a=commitdiff;h=9abd1a4c00cd0e0b...
Nico
On Sun, Jun 13, 2010 at 2:34 PM, Nico Schottelius nico-pacman-dev@schottelius.org wrote:
And another one for makepkg, which would saved my a lot of time searching around the net:
http://git.schottelius.org/?p=foreign/pacman;a=commitdiff;h=9abd1a4c00cd0e0b...
As I said, I am happy with just having examples on the wiki page.
If you insist on having an examples section in the man pages, please re-send your patch inline, like with git send-email. That would allow us to give inline comments.
Signed-off-by: Nico Schottelius nico@kr.ethz.ch --- doc/pacman.8.txt | 10 ++++++++++ 1 files changed, 10 insertions(+), 0 deletions(-)
On Sun, Jun 13, 2010 at 3:28 PM, Nico Schottelius nico-pacman-dev@schottelius.org wrote:
Signed-off-by: Nico Schottelius nico@kr.ethz.ch
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.
Xavier Chantry [Sun, Jun 13, 2010 at 03:36:08PM +0200]:
On Sun, Jun 13, 2010 at 3:28 PM, Nico Schottelius nico-pacman-dev@schottelius.org wrote:
Signed-off-by: Nico Schottelius nico@kr.ethz.ch
doc/pacman.8.txt | 10 ++++++++++ 1 files changed, 10 insertions(+), 0 deletions(-)
Not inline, but ok, I will just copy/paste below :)
Seems --inline to git send-email wasn't the right then :-/
+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
Understood. I'm probably stopping my effort right here, if it's agreed that the wiki is the primary documentation for pacman.
I'm probably thinking in different context than the typical archlinux-dev, for me it's important software can be re-used at other places and thus I don't think putting "how to get used to tool x" information into a distribution wiki is a great idea.
But again, it may be that my thinking way is not compatible to what you prefer here.
+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.
It is indeed. But if I want to find out "how to install a package from a file", I will go to the examples section instead of reading the whole manpage at first.
Nico
On Sun, Jun 13, 2010 at 3:44 PM, Nico Schottelius nico-pacman-dev@schottelius.org wrote:
Seems --inline to git send-email wasn't the right then :-/
Ah well, maybe it's just gmail that does not support these inline mails. But if you don't use any arguments, it should work fine by default.
+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
Understood. I'm probably stopping my effort right here, if it's agreed that the wiki is the primary documentation for pacman.
I'm probably thinking in different context than the typical archlinux-dev, for me it's important software can be re-used at other places and thus I don't think putting "how to get used to tool x" information into a distribution wiki is a great idea.
But again, it may be that my thinking way is not compatible to what you prefer here.
Well we try to keep pacman/makepkg as general as possible and avoid distrib specific bits. So it can be re-used on other systems.
But the project is still developed by ArchLinux developers for ArchLinux and all resources are hosted on archlinux.org All resources on archlinux.org are available from any systems, fortunately the web is standard enough for that :)
Anyway I have nothing against your proposal, I think it's fine, and it's not my call anyway. There is another question : if we want to extend these EXAMPLES section with more stuff from http://wiki.archlinux.org/index.php/Pacman (and maybe http://wiki.archlinux.org/index.php/Pacman_Tips ?), should we put everything in the same man page, or make separate pages ?
Am 13.06.2010 16:21, schrieb Xavier Chantry:
Anyway I have nothing against your proposal, I think it's fine, and it's not my call anyway.
I actually like it a lot, too.
There is another question : if we want to extend these EXAMPLES section with more stuff from http://wiki.archlinux.org/index.php/Pacman (and maybe http://wiki.archlinux.org/index.php/Pacman_Tips ?), should we put everything in the same man page, or make separate pages ?
I think we should not have more than 5 examples there, and only very typical ones, such that a newcomer would pick them up first.
You want people to know -Syu, -S, and -U first.
On Sun, Jun 13, 2010 at 4:36 PM, Thomas Bächler thomas@archlinux.org wrote:
Am 13.06.2010 16:21, schrieb Xavier Chantry:
Anyway I have nothing against your proposal, I think it's fine, and it's not my call anyway.
I actually like it a lot, too.
There is another question : if we want to extend these EXAMPLES section with more stuff from http://wiki.archlinux.org/index.php/Pacman (and maybe http://wiki.archlinux.org/index.php/Pacman_Tips ?), should we put everything in the same man page, or make separate pages ?
I think we should not have more than 5 examples there, and only very typical ones, such that a newcomer would pick them up first.
You want people to know -Syu, -S, and -U first.
Uhm actually I would place -Ss before -U, because it's almost required for -S 1) search with -Ss 2) install with -S 3) upgrade with -Syu 4) install AUR package with makepkg -si (or makepkg -s + pacman -U but I dont use that much)
Let's remove all other operations and options which are completely useless :)
Uhm actually I would place -Ss before -U, because it's almost required for -S
- search with -Ss
- install with -S
- upgrade with -Syu
- install AUR package with makepkg -si (or makepkg -s + pacman -U but
I dont use that much)
This one I think would be helpful: 5) clean cache with -Sc (or Scc)
"Ivan S. Freitas" ivansichfreitas@gmail.com wrote:
[...]
This one I think would be helpful: 5) clean cache with -Sc (or Scc)
Oh yes, this one took me some time on pacman -h (with the right switch -S) to get it :)
On Mon, 14 Jun 2010 00:58:36 +0200, Dominic Reich dr@dark-fellow.info wrote:
"Ivan S. Freitas" ivansichfreitas@gmail.com wrote:
[...]
This one I think would be helpful: 5) clean cache with -Sc (or Scc)
Oh yes, this one took me some time on pacman -h (with the right switch -S) to get it :)
And what about at least one nested usage like:
sudo pacman -Rcsn $(pacman -Qqdt)
On 14/06/10 21:05, Pierre Schmitz wrote:
On Mon, 14 Jun 2010 00:58:36 +0200, Dominic Reichdr@dark-fellow.info wrote:
"Ivan S. Freitas"ivansichfreitas@gmail.com wrote:
[...]
This one I think would be helpful: 5) clean cache with -Sc (or Scc)
Oh yes, this one took me some time on pacman -h (with the right switch -S) to get it :)
And what about at least one nested usage like:
sudo pacman -Rcsn $(pacman -Qqdt)
Please, please, nothing with -Rc in it...
Next try, with more options and fixed makepkg variant.
From: Nico Schottelius nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@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..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
On Mon, Jun 14, 2010 at 1:23 PM, Nico Schottelius nico-pacman-dev@schottelius.org wrote:
From: Nico Schottelius nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@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..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).
That looks good to me. I am just wondering if instead of <'regexp'> <'packages'> <'paths'> , we want to put specific examples there. Just to increase the differences between general descriptions and examples section. What do you think ?
From: Nico Schottelius nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@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
On Mon, Jun 14, 2010 at 1:55 PM, Nico Schottelius nico-pacman-dev@schottelius.org wrote:
From: Nico Schottelius nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@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.
From: Nico Schottelius nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@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..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
Xavier Chantry [Mon, Jun 14, 2010 at 02:09:49PM +0200]:
I like this, just one comment left : I would rather use a standard filename produced by makepkg.
Was my intent, wrong c&p in the last version.
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.
Also put a real path there, to make sure it's understandable that's a /path/to/ construct and not "needs to be in current directory", like makepkg requires.
Nico
2010/6/14 Xavier Chantry chantry.xavier@gmail.com:
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.
I agree. And what about, instead of "# create PKGBUILD", something like: $ cp /usr/share/pacman/PKGBUILD.proto PKGBUILD # edit PKGBUILD to your needs
I think it's important to mention the templates, I find them very useful.
Corrado
From: Nico Schottelius nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@kr.ethz.ch --- doc/makepkg.8.txt | 25 +++++++++++++++++++++++++ doc/pacman.8.txt | 19 +++++++++++++++++++ 2 files changed, 44 insertions(+), 0 deletions(-)
diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index a2fdb3f..57d1fef 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -187,6 +187,31 @@ 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 + +To build and install package "ceofhack" from AUR: + + $ mkdir ceofhack-aur + $ cd ceofhack-aur + $ wget http://aur.archlinux.org/packages/ceofhack/ceofhack/PKGBUILD + $ makepkg -si + + +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
Nico Schottelius [Mon, Jun 14, 2010 at 02:53:46PM +0200]:
From: Nico Schottelius nico@kr.ethz.ch
template + insatll pkg from aur added.
Can someone please apply one of the patches?
It get rather crowded to see what I changed if I have to resend full patched-patch ;-)
On 14/06/10 22:56, Nico Schottelius wrote:
Nico Schottelius [Mon, Jun 14, 2010 at 02:53:46PM +0200]:
From: Nico Schotteliusnico@kr.ethz.ch
template + insatll pkg from aur added.
No. pacman is not Arch specific so the AUR is not to be mentioned.
From: Nico Schottelius nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@kr.ethz.ch --- 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
On 14/06/10 23:15, Nico Schottelius wrote:
From: Nico Schotteliusnico@kr.ethz.ch
Signed-off-by: Nico Schotteliusnico@kr.ethz.ch
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.
Surely that is covered by "man PKGBUILD".
Anyway, I think the makepkg section is unnecessary... here is why
allan@mugen ~
makepkg
==> ERROR: PKGBUILD does not exist.
What is a PKGBUILD? There are heaps of links in "man makepkg" to a PKGBUILD man page so...
allan@mugen ~
man PKGBUILD
Now, that does not say where to find the prototypes, but I think it is the PKGBUILD man page that should be adjusted. It also should be adjusted to remove reference to Arch. But it does provide examples.
Also, the directory /usr/share/pacman is configurable, so should not be hard coded.
Allan
On Mon, Jun 14, 2010 at 3:41 PM, Allan McRae allan@archlinux.org wrote:
==> ERROR: PKGBUILD does not exist.
What is a PKGBUILD? There are heaps of links in "man makepkg" to a PKGBUILD man page so...
allan@mugen ~
man PKGBUILD
Now, that does not say where to find the prototypes, but I think it is the PKGBUILD man page that should be adjusted. It also should be adjusted to remove reference to Arch. But it does provide examples.
Also, the directory /usr/share/pacman is configurable, so should not be hard coded.
I just see now that my git tree is dirty with a previous version of that patch. So NAK on the makepkg part but the pacman one is fine ?
I think Nico put enough effort with many resubmits already, and the idea is not bad, so I can just pick the pacman part of the last patch and push that to my tree, if that's ok.
On 25/06/10 06:14, Xavier Chantry wrote:
On Mon, Jun 14, 2010 at 3:41 PM, Allan McRaeallan@archlinux.org wrote:
==> ERROR: PKGBUILD does not exist.
What is a PKGBUILD? There are heaps of links in "man makepkg" to a PKGBUILD man page so...
allan@mugen ~
man PKGBUILD
Now, that does not say where to find the prototypes, but I think it is the PKGBUILD man page that should be adjusted. It also should be adjusted to remove reference to Arch. But it does provide examples.
Also, the directory /usr/share/pacman is configurable, so should not be hard coded.
I just see now that my git tree is dirty with a previous version of that patch. So NAK on the makepkg part but the pacman one is fine ?
I think Nico put enough effort with many resubmits already, and the idea is not bad, so I can just pick the pacman part of the last patch and push that to my tree, if that's ok.
From memory, the examples added to the pacman man page seemed reasonable. I'm too lazy to find that last patch version but make sure there is a "pacman -Syu <pkg>" in there and go for it.
Allan
From: Nico Schottelius nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@kr.ethz.ch Signed-off-by: Xavier Chantry chantry.xavier@gmail.com --- 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
On 01/07/10 06:23, Xavier Chantry wrote:
From: Nico Schotteliusnico@kr.ethz.ch
Signed-off-by: Nico Schotteliusnico@kr.ethz.ch Signed-off-by: Xavier Chantrychantry.xavier@gmail.com
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.
+pacman -Scc::
- Remove *all* packages from cache (-Sc removes only uninstalled ones).
The -Sc description is kind of wrong (think KeepCurrent), so it should just be removed.
Configuration
See linkman:pacman.conf[5] for more details on configuring pacman using the
Am 01.07.2010 03:21, schrieb Allan McRae:
On 01/07/10 06:23, Xavier Chantry wrote:
From: Nico Schotteliusnico@kr.ethz.ch
Signed-off-by: Nico Schotteliusnico@kr.ethz.ch Signed-off-by: Xavier Chantrychantry.xavier@gmail.com
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.
From: Nico Schottelius nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@kr.ethz.ch Signed-off-by: Xavier Chantry chantry.xavier@gmail.com --- 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 01/07/10 17:07, Xavier Chantry wrote:
From: Nico Schotteliusnico@kr.ethz.ch
Signed-off-by: Nico Schotteliusnico@kr.ethz.ch Signed-off-by: Xavier Chantrychantry.xavier@gmail.com
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
Allan McRae [Mon, Jun 14, 2010 at 11:11:13PM +1000]:
On 14/06/10 22:56, Nico Schottelius wrote:
Nico Schottelius [Mon, Jun 14, 2010 at 02:53:46PM +0200]:
From: Nico Schotteliusnico@kr.ethz.ch
template + insatll pkg from aur added.
No. pacman is not Arch specific so the AUR is not to be mentioned.
Err yes, completly true, that's what I'm saying... Sorry, patch without aur sent.
On 14.06.2010 14:53, Nico Schottelius wrote:
+To build and install package "ceofhack" from AUR:
- $ mkdir ceofhack-aur
- $ cd ceofhack-aur
- $ wget http://aur.archlinux.org/packages/ceofhack/ceofhack/PKGBUILD
- $ makepkg -si
I do not think the AUR should be mentioned since it is an Arch-only thing. Apart from that, your commands only work for PKGBUILDs that do not require local sources or changelog/install files.
+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).
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 nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@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..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
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 nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@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
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
Dave Reisner [Tue, Oct 04, 2011 at 09:29:51AM -0400]:
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.
Oh, yes, sorry, did not upgrade pacman the lasttime I checked the manpage.
Thanks for the pointer & sorry for the noise.
Nico
On Tue, Oct 4, 2011 at 9:08 PM, Nico Schottelius nico-pacman-dev@schottelius.org 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 nico@kr.ethz.ch
Signed-off-by: Nico Schottelius nico@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.
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
Xavier Chantry [Mon, Jun 14, 2010 at 01:45:33PM +0200]:
That looks good to me. I am just wondering if instead of <'regexp'> <'packages'> <'paths'> , we want to put specific examples there. Just to increase the differences between general descriptions and examples section. What do you think ?
You're absolutely right, they are examples and should not be "possible examples", but real world examples. Patch sent.
Nico
pacman-dev@lists.archlinux.org