Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 207 lines (133 sloc) 5.223 kb
89ba1a8 Rafael G. Martins changes on README.rst
authored
1 .. _`GNU Octave`: http://octave.org/
2 .. _`Octave-Forge`: http://octave.sf.net/
3385ac5 Rafael G. Martins updated README and manpage
authored
3 .. _`g-octave`: http://www.g-octave.org/
89ba1a8 Rafael G. Martins changes on README.rst
authored
4 .. _Python: http://python.org/
5 .. _Portage: http://www.gentoo.org/proj/en/portage/
6 .. _Paludis: http://paludis.pioto.org/
7 .. _pkgcore: http://www.pkgcore.org/
8 .. _`Gentoo Linux`: http://www.gentoo.org/
81c57c2 Rafael G. Martins moving g-octave to github. removed some deprecated doc
authored
9 .. _`issue tracker`: https://github.com/rafaelmartins/g-octave/issues
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
10 .. _Git: http://git-scm.com/
11 .. _PySVN: http://pysvn.tigris.org/
89ba1a8 Rafael G. Martins changes on README.rst
authored
12
1ae9a2e Rafael G. Martins started the README.rst
authored
13 g-octave
14 ========
15
16 Introduction
17 ------------
18
19 What is GNU Octave?
20 ~~~~~~~~~~~~~~~~~~~
21
89ba1a8 Rafael G. Martins changes on README.rst
authored
22 `GNU Octave`_ is a high-level language, primarily intended for numerical
1ae9a2e Rafael G. Martins started the README.rst
authored
23 computations. It provides a convenient command line interface for solving
24 linear and nonlinear problems numerically, and for performing other numerical
25 experiments using a language that is mostly compatible with Matlab.
26 It may also be used as a batch-oriented language.
27
28
29 What is Octave Forge?
30 ~~~~~~~~~~~~~~~~~~~~~
31
89ba1a8 Rafael G. Martins changes on README.rst
authored
32 `Octave-Forge`_ is a central location for the collaborative development of
33 packages for `GNU Octave`_.
1ae9a2e Rafael G. Martins started the README.rst
authored
34
89ba1a8 Rafael G. Martins changes on README.rst
authored
35 The `Octave-Forge`_ packages contains the source for all the functions and
36 are designed to work with the `GNU Octave`_ package system.
1ae9a2e Rafael G. Martins started the README.rst
authored
37
38
39 What is g-octave
40 ~~~~~~~~~~~~~~~~
41
89ba1a8 Rafael G. Martins changes on README.rst
authored
42 `g-octave`_ is a tool that generates and installs ebuilds for `Octave-Forge`_
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
43 packages "on-the-fly" to `Gentoo Linux`_, using Portage_, Paludis_ or pkgcore_.
44 It's capable to generate ebuilds and Manifest files (if needed)
45 for the packages, and to install them using an autogenerated overlay (named
46 g-octave). `g-octave`_ can also handle patches to the packages automatically.
47 The command line interface tries to be very similar to the interface of the
48 **emerge** tool.
1ae9a2e Rafael G. Martins started the README.rst
authored
49
50
c561036 Rafael G. Martins more changes on README.rst
authored
51 Dependencies
52 ------------
53
54 `g-octave`_ have some basic dependencies:
55
3385ac5 Rafael G. Martins updated README and manpage
authored
56 * Python_ >= 2.6
c561036 Rafael G. Martins more changes on README.rst
authored
57 * Portage_
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
58 * Paludis_ (optional)
59 * pkgcore_ (optional)
c561036 Rafael G. Martins more changes on README.rst
authored
60
a5e1d09 Rafael G. Martins added "Settings" section to README.rst and comments to etc/g-octave.cfg
authored
61 Settings
62 --------
63
64 All the settings are centralized on the file */etc/g-octave.cfg*. Please
65 read the comments and change what you need. The recommendation is to keep
66 everything as it is. :)
67
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
68 You can also use environment variables to configure `g-octave`.
a5e1d09 Rafael G. Martins added "Settings" section to README.rst and comments to etc/g-octave.cfg
authored
69
582bec3 Rafael G. Martins fix some documentation references
authored
70 http://docs.g-octave.org/en/latest/userguide/#configuring-g-octave
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
71
72
73 Configuring your package manager
74 --------------------------------
75
582bec3 Rafael G. Martins fix some documentation references
authored
76 http://docs.g-octave.org/en/latest/userguide/#configuring-g-octave
1ae9a2e Rafael G. Martins started the README.rst
authored
77
ab257c2 Rafael G. Martins small fixes and changes on README.rst
authored
78
79 CLI options
80 -----------
81
82 *--version*
83 show program's version number and exit
84
85 *-h, --help*
86 show this help message and exit
87
88 *-l, --list*
89 show a list of packages available to install and exit
90
91 *-i, --info*
92 show a description of the required package and exit
93
94 *-p, --pretend*
95 don't (un)merge packages, only create ebuilds and solve the dependencies
96
97 *-a, --ask*
98 ask to confirmation before perform (un)merges
99
100 *-v, --verbose*
101 Portage makes a lot of noise.
102
3385ac5 Rafael G. Martins updated README and manpage
authored
103 *-1, --oneshot*
104 do not add the packages to the world file for later updating.
105
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
106 *-u, --update*
107 try to update a package or all the installed packages
108
37c44c8 Rafael G. Martins added the search of packages
authored
109 *-s, --search*
110 search for packages with some term on the name (regular expressions allowed)
111
ab257c2 Rafael G. Martins small fixes and changes on README.rst
authored
112 *-C, --unmerge*
113 try to unmerge a package instead of merge
114
3385ac5 Rafael G. Martins updated README and manpage
authored
115 *--scm*
116 enable the installation of the current live version of a package, if disabled
117 on the configuration file
118
119 *--no-scm*
120 disable the installation of the current live version of a package, if
121 enabled on the configuration file
122
ab257c2 Rafael G. Martins small fixes and changes on README.rst
authored
123 *-f, --force*
124 forces the recreation of the ebuilds
125
126 *--force-all*
127 forces the recreation of the overlay and of the ebuilds
128
129 *--no-colors*
130 don't use colors on the CLI
89ba1a8 Rafael G. Martins changes on README.rst
authored
131
b7a4aaa Rafael G. Martins added the option --sync
authored
132 *--sync*
133 search for updates of the package database, patches and auxiliary files
134
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
135 *--config*
c3ecee7 Rafael G. Martins a bunch of documentation changes and fixes to the release
authored
136 return a value from the configuration file (/etc/g-octave.cfg)
137
3385ac5 Rafael G. Martins updated README and manpage
authored
138 *--list-raw*
139 show a list of packages available to install (a package per line,
140 without colors) and exit
141
89ba1a8 Rafael G. Martins changes on README.rst
authored
142
cbbb58a Rafael G. Martins changed URL; small fixes on scripts/g-octave; added usage examples to
authored
143 Usage Examples
144 --------------
145
146 Install the latest version of *control*: ::
147
148 # g-octave control
149
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
150 Install the version 0.3.1 of *control*: ::
cbbb58a Rafael G. Martins changed URL; small fixes on scripts/g-octave; added usage examples to
authored
151
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
152 # g-octave control-0.3.1
153
154 Upgrade to latest version available of *control*: ::
155
156 # g-octave -u control
cbbb58a Rafael G. Martins changed URL; small fixes on scripts/g-octave; added usage examples to
authored
157
158 Remove the package *control*: ::
159
160 # g-octave -C control
161
162 Get informations about the package *control*: ::
163
164 # g-octave -i control
c3ecee7 Rafael G. Martins a bunch of documentation changes and fixes to the release
authored
165
166 To install the package *control* from the octave-forge SVN repository: ::
167
168 # g-octave control-9999
cbbb58a Rafael G. Martins changed URL; small fixes on scripts/g-octave; added usage examples to
authored
169
170 The options *verbose*, *ask* and *pretend* are passed to **emerge**.
171
172
4b46fed Rafael G. Martins added a warning to scripts/g-octave and fixes on README.rst
authored
173 How can I help?
174 ---------------
175
176 The users can help testing and reporting bugs in our `issue tracker`_.
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
177 If you can help programming in Python_ you're always welcome. :)
4b46fed Rafael G. Martins added a warning to scripts/g-octave and fixes on README.rst
authored
178
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
179 `g-octave`_ ebuilds are available on the Git repository, or the
180 Gentoo science overlay.
cbbb58a Rafael G. Martins changed URL; small fixes on scripts/g-octave; added usage examples to
authored
181
182
183 Warning
184 -------
185
40abcf9 Rafael G. Martins changed README.rst
authored
186 If you experienced some random errors when installing packages, please
cbbb58a Rafael G. Martins changed URL; small fixes on scripts/g-octave; added usage examples to
authored
187 retry, using the option *--force-all*, and report the issue to us.
188 If you don't want to lose all your ebuilds, you can try to use the option
c3ecee7 Rafael G. Martins a bunch of documentation changes and fixes to the release
authored
189 *--force*, that will re-create only the affected ebuild.
cbbb58a Rafael G. Martins changed URL; small fixes on scripts/g-octave; added usage examples to
authored
190
4b46fed Rafael G. Martins added a warning to scripts/g-octave and fixes on README.rst
authored
191
34197c5 Rafael G. Martins small fix on g_octave/config.py; added "Download Page" section to
authored
192 Download Page
193 -------------
194
195 You can get the sources here:
81c57c2 Rafael G. Martins moving g-octave to github. removed some deprecated doc
authored
196 https://github.com/rafaelmartins/g-octave/downloads
34197c5 Rafael G. Martins small fix on g_octave/config.py; added "Download Page" section to
authored
197
033737b Rafael G. Martins disabled the logging for the tests. updated all the doc for the next rel...
authored
198 or clone the Git_ repository using: ::
34197c5 Rafael G. Martins small fix on g_octave/config.py; added "Download Page" section to
authored
199
81c57c2 Rafael G. Martins moving g-octave to github. removed some deprecated doc
authored
200 $ git clone git://github.com/rafaelmartins/g-octave.git
34197c5 Rafael G. Martins small fix on g_octave/config.py; added "Download Page" section to
authored
201
202
4b46fed Rafael G. Martins added a warning to scripts/g-octave and fixes on README.rst
authored
203 Authors
204 -------
205
206 Rafael Goncalves Martins *<rafael at rafaelmartins dot eng dot br>*
Something went wrong with that request. Please try again.