small fixes and changes on README.rst

1 files changed, 52 insertions, 18 deletions

diff --git a/README.rst b/README.rst
index 5337cfa..8f51cc8 100644
--- a/README.rst
+++ b/README.rst
@@ -4,7 +4,6 @@ g-octave
 Introduction
 ------------
 
-
 What is GNU Octave?
 ~~~~~~~~~~~~~~~~~~~
 
@@ -31,15 +30,11 @@ What is g-octave
 ~~~~~~~~~~~~~~~~
 
 g-octave is a tool that generates and installs ebuilds for Octave-Forge
-packages "on-the-fly" to Gentoo Linux, using Portage.
-
-It's capable to generate ebuilds and Manifest files for the packages, and
-to install them using an autogenerated overlay (named g-octave).
-
-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** tool.
+packages "on-the-fly" to Gentoo Linux, using Portage. It's capable to
+generate ebuilds and Manifest files for the packages, and to install
+them using an autogenerated overlay (named g-octave). 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** tool.
 
 At this moment g-octave depends on the Portage package manager to works,
 but the support to Paludis and pkgcore is planned.
@@ -57,26 +52,28 @@ Below is a list of features implemented and planned to the next releases.
 * Creation of the Manifest files **(done)**
 * Creation of the overlay automatically **(done)**
 * Installation of the packages automatically **(done)**
-* Update the packages already installed
+* Update of the packages already installed
 * Remotion of the installed packages **(done)**
 * Installation of the packages with patches automatically **(done)**
 * List the packages available to install **(done)**
 * Shows detailed info about a package **(done)**
 * Supports multiple versions of the same package **(done)**
-* Forces the recreation of an ebuild **(done)**
-* Forces the recreation of the overlay **(done)**
 * Download auxiliary files (patches, blacklist, dependency list, package
   database and the eclass) from a mirror using wget **(done)**
 * The user can choose with which download manager will fetch these files
-* Blocks a package to be installed, based on the blacklist, provided by
-  the maintainer of g-octave **(done)**
-* Resolution of the dependencies of packages from the Portage tree, based on the
-  dependency list, provided by the maintainer of g-octave **(done)**
+* The user can force the recreation of an ebuild **(done)**
+* The user can force the recreation of the overlay **(done)**
+* Mask a package to be installed, based on the blacklist, provided by the
+  maintainer of g-octave **(done)**
+* Show the masked packages on the list of packages, with some alert
+* Resolution of the dependencies of packages from the Portage tree, based
+  on the dependency list, provided by the maintainer of g-octave **(done)**
+* Supports the installation of multiple packages (not only the dependencies)
 * Handle updates of the eclass and auxiliary files automatically **(done)**
 * Support to Portage **(done)**
 * Support to Paludis
 * Support to pkgcore
-* Configuration file to the main settings **(done)**
+* Configuration file to the main settings (/etc/g-octave.cfg) **(done)**
 
 
 To-Do
@@ -91,5 +88,42 @@ We have other goals besides implementing the remaining features:
 * Convince upstream to distribute a package database
 * Improve the use as a normal user, using "--pretend"
 * Improve the script to generate the package database
+* Improve the details available on the packages list
 * more...
 
+
+CLI options
+-----------
+
+*--version*
+    show program's version number and exit
+
+*-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
+
+*-a, --ask*
+    ask to confirmation before perform (un)merges
+
+*-v, --verbose*
+    Portage makes a lot of noise.
+
+*-C, --unmerge*
+    try to unmerge a package instead of merge
+
+*-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