From 3385ac5fbe796de19840a31dde9b77fe55322865 Mon Sep 17 00:00:00 2001 From: "Rafael G. Martins" Date: Wed, 4 Aug 2010 00:43:29 -0300 Subject: updated README and manpage --- README.rst | 57 +++++++++++++++++++++----------------------------------- g-octave.1.rst | 30 ++++++++++++++++++++--------- scripts/g-octave | 18 +++++++++--------- 3 files changed, 51 insertions(+), 54 deletions(-) diff --git a/README.rst b/README.rst index 16067a5..491142d 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,12 @@ .. _`GNU Octave`: http://octave.org/ .. _`Octave-Forge`: http://octave.sf.net/ -.. _`g-octave`: http://g-octave.rafaelmartins.eng.br/ +.. _`g-octave`: http://www.g-octave.org/ .. _Python: http://python.org/ .. _Portage: http://www.gentoo.org/proj/en/portage/ .. _Paludis: http://paludis.pioto.org/ .. _pkgcore: http://www.pkgcore.org/ .. _`Gentoo Linux`: http://www.gentoo.org/ -.. _`issue tracker`: http://g-octave.rafaelmartins.eng.br/report +.. _`issue tracker`: http://www.g-octave.org/trac/report .. _Git: http://git-scm.com/ .. _PySVN: http://pysvn.tigris.org/ @@ -53,28 +53,11 @@ Dependencies `g-octave`_ have some basic dependencies: -* Python_ 2.6 +* Python_ >= 2.6 * Portage_ -* PySVN_ (optional) * Paludis_ (optional) * pkgcore_ (optional) -`g-octave`_ also depends on some files, distributed by the maintainer, -like the package database (a tarball with the DESCRIPTION file of all -the packages), a file with the dependencies and the blacklist, a tarball -with the patches and a file that list the updated files. - -These files are needed because upstream don't ship a package database -(they only distribute a tarball with the sources of all the packages, so -we have a script that create the database using this tarball) and because -we don't want to do a new release every time that the eclass is changed -or that a new patch is added. All these files are automatically fetched -by `g-octave`_ - -At this time, these files are here: -http://soc.dev.gentoo.org/~rafaelmartins/g-octave/db/ - - Settings -------- @@ -84,26 +67,13 @@ everything as it is. :) You can also use environment variables to configure `g-octave`. -http://soc.dev.gentoo.org/~rafaelmartins/g-octave/docs/latest/userguide/#configuring-g-octave +http://doc.g-octave.org/latest/userguide/#configuring-g-octave Configuring your package manager -------------------------------- -g-octave can use all the 3 package managers available on Gentoo Linux: -**Portage**, **Paludis** and **Pkgcore**. - -You just need to setup the option `package_manager` with the lowercase -name of the package manager: `portage`, `paludis`, `pkgcore`. - -If you're using Paludis or Pkgcore, you'll need to configure the overlay -in your package manager configuration files. Please check the documentation -of your package manager: - -- Paludis: http://paludis.pioto.org/ -- Pkgcore: http://www.pkgcore.org/ - -Portage works out of the box. +http://doc.g-octave.org/latest/userguide/#configuring-g-octave CLI options @@ -130,6 +100,9 @@ CLI options *-v, --verbose* Portage makes a lot of noise. +*-1, --oneshot* + do not add the packages to the world file for later updating. + *-u, --update* try to update a package or all the installed packages @@ -139,6 +112,14 @@ CLI options *-C, --unmerge* try to unmerge a package instead of merge +*--scm* + enable the installation of the current live version of a package, if disabled + on the configuration file + +*--no-scm* + disable the installation of the current live version of a package, if + enabled on the configuration file + *-f, --force* forces the recreation of the ebuilds @@ -154,6 +135,10 @@ CLI options *--config* return a value from the configuration file (/etc/g-octave.cfg) +*--list-raw* + show a list of packages available to install (a package per line, + without colors) and exit + Usage Examples -------------- @@ -208,7 +193,7 @@ Download Page ------------- You can get the sources here: -http://soc.dev.gentoo.org/~rafaelmartins/g-octave/releases/ +http://www.g-octave.org/releases/ or clone the Git_ repository using: :: diff --git a/g-octave.1.rst b/g-octave.1.rst index cfb9fca..19deb68 100644 --- a/g-octave.1.rst +++ b/g-octave.1.rst @@ -30,8 +30,8 @@ g-octave can also handle patches to the packages automatically. The command line interface tries to be very similar to the interface of the emerge(1) tool. -At this moment g-octave depends on the Portage package manager to works, -but the support to Paludis and pkgcore is planned. +g-octave can use any of the 3 package managers available to Gentoo Linux: +Portage, Paludis and Pkgcore. OPTIONS @@ -41,27 +41,39 @@ OPTIONS -h, --help show this help message and exit -l, --list show a list of packages available to install and exit -i, --info show a description of the required package and exit --p, --pretend don't (un)merge packages, only create ebuilds and solve the dependencies +-p, --pretend don't (un)merge packages, only create ebuilds and solve + the dependencies -a, --ask ask to confirmation before perform (un)merges -v, --verbose Portage makes a lot of noise. +-1, --oneshot do not add the packages to the world file for later + updating. -u, --update try to update a package or all the installed packages --s, --search search for packages with some term on the name (regular expressions allowed) +-s, --search search for packages with some term on the name (regular + expressions allowed) -C, --unmerge try to unmerge a package instead of merge +--scm enable the installation of the current live version of + a package, if disabled on the configuration file +--no-scm disable the installation of the current live version + of a package, if enabled on the configuration file -f, --force forces the recreation of the ebuilds --force-all forces the recreation of the overlay and of the ebuilds --no-colors don't use colors on the CLI ---sync search for updates of the package database, patches and auxiliary files +--sync search for updates of the package database, patches + and auxiliary files --config return a value from the configuration file (/etc/g-octave.cfg) +--list-raw show a list of packages available to install (a package + per line, without colors) and exit SEE ALSO ======== -* http://soc.dev.gentoo.org/~rafaelmartins/g-octave/docs/ +* http://www.g-octave.org/ * http://git.overlays.gentoo.org/gitweb/?p=proj/g-octave.git;a=summary -BUGS -==== +BUGS TO +======= -* rafael@rafaelmartins.eng.br +* http://www.g-octave.org/trac/newticket +* http://www.g-octave.org/trac/report diff --git a/scripts/g-octave b/scripts/g-octave index a01635f..9451b87 100755 --- a/scripts/g-octave +++ b/scripts/g-octave @@ -70,14 +70,6 @@ def main(): help = 'show a list of packages available to install (separed by categories) and exit' ) - parser.add_option( - '--list-raw', - action = 'store_true', - dest = 'list_raw', - default = False, - help = 'show a list of packages available to install (a package per line, without colors) and exit' - ) - parser.add_option( '-i', '--info', action = 'store_true', @@ -159,7 +151,7 @@ def main(): ) parser.add_option( - '-f', '--force', + '--force', action = 'store_true', dest = 'force', default = False, @@ -198,6 +190,14 @@ def main(): help = 'return a value from the configuration file (/etc/g-octave.cfg)' ) + parser.add_option( + '--list-raw', + action = 'store_true', + dest = 'list_raw', + default = False, + help = 'show a list of packages available to install (a package per line, without colors) and exit' + ) + options, args = parser.parse_args() if not options.colors: -- cgit v1.2.3-65-gdbad