aboutsummaryrefslogtreecommitdiff
blob: 491142d90989e484b4079cd0c403b778ae96f436 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
.. _`GNU Octave`: http://octave.org/
.. _`Octave-Forge`: http://octave.sf.net/
.. _`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://www.g-octave.org/trac/report
.. _Git: http://git-scm.com/
.. _PySVN: http://pysvn.tigris.org/

g-octave
========

Introduction
------------

What is GNU Octave?
~~~~~~~~~~~~~~~~~~~

`GNU Octave`_ is a high-level language, primarily intended for numerical
computations. It provides a convenient command line interface for solving
linear and nonlinear problems numerically, and for performing other numerical
experiments using a language that is mostly compatible with Matlab.
It may also be used as a batch-oriented language.


What is Octave Forge?
~~~~~~~~~~~~~~~~~~~~~

`Octave-Forge`_ is a central location for the collaborative development of
packages for `GNU Octave`_.

The `Octave-Forge`_ packages contains the source for all the functions and
are designed to work with the `GNU Octave`_ package system. 


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_, Paludis_ or pkgcore_.
It's capable to generate ebuilds and Manifest files (if needed)
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.


Dependencies
------------

`g-octave`_ have some basic dependencies:

* Python_ >= 2.6
* Portage_
* Paludis_ (optional)
* pkgcore_ (optional)

Settings
--------

All the settings are centralized on the file */etc/g-octave.cfg*. Please
read the comments and change what you need. The recommendation is to keep
everything as it is. :)

You can also use environment variables to configure `g-octave`.

http://doc.g-octave.org/latest/userguide/#configuring-g-octave


Configuring your package manager
--------------------------------

http://doc.g-octave.org/latest/userguide/#configuring-g-octave


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.

*-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)

*-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

*--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
--------------

Install the latest version of *control*: ::
    
    # g-octave control

Install the version 0.3.1 of *control*: ::

    # g-octave control-0.3.1

Upgrade to latest version available of *control*: ::
    
    # g-octave -u control

Remove the package *control*: ::

    # g-octave -C control

Get informations about the package *control*: ::

    # g-octave -i control

To install the package *control* from the octave-forge SVN repository: ::
    
    # g-octave control-9999
    
The options *verbose*, *ask* and *pretend* are passed to **emerge**.


How can I help?
---------------

The users can help testing and reporting bugs in our `issue tracker`_.
If you can help programming in Python_ you're always welcome. :)

`g-octave`_ ebuilds are available on the Git repository, or the
Gentoo science overlay.


Warning
-------

If you experienced some random errors when installing packages, please
retry, using the option *--force-all*, and report the issue to us.
If you don't want to lose all your ebuilds, you can try to use the option
*--force*, that will re-create only the affected ebuild.


Download Page
-------------

You can get the sources here:
http://www.g-octave.org/releases/

or clone the Git_ repository using: ::
    
    $ git clone git://git.overlays.gentoo.org/proj/g-octave.git


Authors
-------

Rafael Goncalves Martins *<rafael at rafaelmartins dot eng dot br>*