[pacman-dev] [PATCH] manpage update: add real world examples with full path
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 n...@kr.ethz.ch Signed-off-by: Nico Schottelius n...@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 -- 1.7.1
Re: [pacman-dev] [PATCH] manpage update: add real world examples with full path
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 -- PGP key: 7ED9 F7D3 6B10 81D7 0EC5 5C09 D7DC C8E4 3187 7DF0
[pacman-dev] [PATCH] manpage example updates
From: Nico Schottelius n...@kr.ethz.ch Signed-off-by: Nico Schottelius n...@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 -- 1.7.1
[pacman-dev] (no subject)
Next try, with more options and fixed makepkg variant.
[pacman-dev] [PATCH] manpage update: add real world examples
From: Nico Schottelius n...@kr.ethz.ch Signed-off-by: Nico Schottelius n...@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
Re: [pacman-dev] [PATCH] manpage example updates
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 -- 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/ ... pgpMI3fenatPc.pgp Description: PGP signature
[pacman-dev] [PATCH] manpage update: add real world examples with full path
From: Nico Schottelius n...@kr.ethz.ch Signed-off-by: Nico Schottelius n...@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 -- 1.7.1
[pacman-dev] [PATCH] manpage update: add real world examples with full path and aur ref
From: Nico Schottelius n...@kr.ethz.ch Signed-off-by: Nico Schottelius n...@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 -- 1.7.1
Re: [pacman-dev] [PATCH] manpage update: add real world examples with full path and aur ref
Nico Schottelius [Mon, Jun 14, 2010 at 02:53:46PM +0200]: From: Nico Schottelius n...@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 ;-) -- 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/ ... pgpLaTvLhIJbd.pgp Description: PGP signature
[pacman-dev] [PATCH] manpage update: add real world examples with full path
From: Nico Schottelius n...@kr.ethz.ch Signed-off-by: Nico Schottelius n...@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 -- 1.7.1
Re: [pacman-dev] [PATCH] manpage update: add real world examples with full path and aur ref
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 Schotteliusn...@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. -- 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/ ... pgpiU19w2mDwA.pgp Description: PGP signature
Re: [pacman-dev] Examples in the manpages
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 -- 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/ ... pgpBphJf11Vce.pgp Description: PGP signature
Re: [pacman-dev] Examples in the manpages
Ray Rashif [Sun, Jun 13, 2010 at 10:57:40AM +0800]:
On 13 June 2010 09:45, Ivan S. Freitas ivansichfrei...@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
--
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/ ...
pgpjwoHNrDwwj.pgp
Description: PGP signature
Re: [pacman-dev] Examples in the manpages
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=9d04a7451d32f8b2aa9152e866da10084d442a51 [1] git://git.schottelius.org/foreign/pacman -- 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/ ... pgpmFh1EyaGsi.pgp Description: PGP signature
Re: [pacman-dev] Examples in the manpages
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=9abd1a4c00cd0e0b29948cdfc51364ba249fdace 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/ ... pgpQmX9XT4wp5.pgp Description: PGP signature
[pacman-dev] [PATCH 1/2] add two entries to pacman manpage examples section
Signed-off-by: Nico Schottelius n...@kr.ethz.ch --- doc/pacman.8.txt | 10 ++ 1 files changed, 10 insertions(+), 0 deletions(-) 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. + +pacman -U 'path':: + Install package found in the specified file. + + Configuration - See linkman:pacman.conf[5] for more details on configuring pacman using the
Re: [pacman-dev] [PATCH 1/2] add two entries to pacman manpage examples section
Xavier Chantry [Sun, Jun 13, 2010 at 03:36:08PM +0200]: On Sun, Jun 13, 2010 at 3:28 PM, Nico Schottelius nico-pacman-...@schottelius.org wrote: Signed-off-by: Nico Schottelius n...@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 -- 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/ ... pgpxkd1lhUl3I.pgp Description: PGP signature
[pacman-dev] Examples in the manpages
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 -- 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/ ... pgpANYkSAiQV0.pgp Description: PGP signature
Re: [pacman-dev] Examples in the manpages
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 -- 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/ ... pgpabZgJNQGKy.pgp Description: PGP signature
