aboutsummaryrefslogtreecommitdiff
blob: da81089e83ac231cf858fe424c5d431e6fa579f3 (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
User Guide
==========

This is a small user guide for g-Octave, with some instructions to the
end user.


Installing g-Octave
-------------------

The ebuilds for g-Octave will be available on the Portage tree as soon
as possible. For now, they can be found on the Gentoo ``science`` overlay.
To install it with ``layman`` and ``git`` installed, type::

    # layman -a science


After you have the overlay installed, you can install the package, using: ::
    
    # emerge -av app-portage/g-octave

We have 2 ebuilds, one for the latest stable release (for ``~x86`` and ``~amd64``)
and one live ebuild, that installs g-Octave from the mercurial repository
(without keywords). If you want to use the live ebuild, you need to unmask
this ebuild, adding the line below to ``/etc/portage/package.keywords``::

    app-portage/g-octave **

The live ebuild is only recommended for who want to help testing new
features, or for developers.

Stable users (with ``x86`` or ``amd64``) that wants to test the latest
release will need to unmask the ebuild too, adding this to
/etc/portage/package.keywords (e.g. for ``x86``)::

    app-portage/g-octave ~x86

The source code of g-Octave can be found in this Mercurial repository:

http://g-octave.rafaelmartins.eng.br/hg/

You can clone the mercurial repository using this command (with Mercurial
installed, of course)::
    
    $ hg clone http://g-octave.rafaelmartins.eng.br/hg/ g-octave

The release tarballs can be found here:

http://g-octave.rafaelmartins.eng.br/distfiles/releases/


Configuring g-Octave
--------------------

If you installed g-Octave correctly, you should find a configuration file
at ``/etc/g-octave.cfg``.

The main options are ``db`` and ``overlay``, that defines the directory paths
for the package database and the generated overlay, respectively.

Other options are available. Please read the comments in the configuration
file.


Syncronizing the package database
---------------------------------

Currently g-Octave depends on an external package database, in order to
create the ebuilds for the packages. You'll need to fetch this database
in the first time that you run g-Octave: ::
    
    # g-octave --sync


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

Portage needs to be able to find the ebuilds generated by g-Octave, then
you'll need to add the directory path of the overlay (configured in the
previous step) to the variable ``PORTDIR_OVERLAY``, in the file
``/etc/make.conf``.

You can use something like this command: ::
    
    # echo 'PORTDIR_OVERLAY="/path/to/your/overlay ${PORTDIR_OVERLAY}"' >> /etc/make.conf


Installing packages
-------------------

You can list all the available packages using this command: ::
    
    # g-octave --list

or ::
    
    # g-octave -l

To install a package, use: ::
    
    # g-octave packagename

or ::
    
    # g-octave packagename-version

For example: ::
    
    # g-octave control-1.0.11

``g-octave`` command-line tool supports some options for the installation
of packages:
    
``-a`` or ``--ask``
    Ask before install the package
``-p`` or ``--pretend``
    Only pretend the installation of the package

You can get some information about the package using this command: ::

    # g-octave --info packagename

or ::
    
    # g-octave -i packagename


Installing packages from the octave-forge SVN repository
--------------------------------------------------------

If you want to test some new feature, or to use the new version of the
packages ever, you'll like to install your packages directly from the
SVN repository.

To install a package from SVN, type::
    
    # g-octave packagename-9999

All the common g-octave options for install packages are allowed, and
the special version ``9999`` says to g-octave that you want to use the
SVN version.

In order to be able to install packages from svn you need to install
g-octave with the USE flag ``svn`` enabled.


Uninstalling packages
---------------------

You can uninstall packages using this command: ::

    # g-octave --unmerge packagename

or ::
    
    # g-octave -C packagename-version

The options ``--ask`` and ``--verbose`` are also supported.