Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[9594] trunk/octave-forge/main/queueing/doc
|
From: <mma...@us...> - 2012-02-06 19:49:39
|
Revision: 9594
http://octave.svn.sourceforge.net/octave/?rev=9594&view=rev
Author: mmarzolla
Date: 2012-02-06 19:49:32 +0000 (Mon, 06 Feb 2012)
Log Message:
-----------
Updated installation instructions
Modified Paths:
--------------
trunk/octave-forge/main/queueing/doc/INSTALL
trunk/octave-forge/main/queueing/doc/installation.txi
trunk/octave-forge/main/queueing/doc/queueing.html
trunk/octave-forge/main/queueing/doc/queueing.pdf
Modified: trunk/octave-forge/main/queueing/doc/INSTALL
===================================================================
--- trunk/octave-forge/main/queueing/doc/INSTALL 2012-02-06 18:24:05 UTC (rev 9593)
+++ trunk/octave-forge/main/queueing/doc/INSTALL 2012-02-06 19:49:32 UTC (rev 9594)
@@ -17,56 +17,72 @@
=========================================================
The most recent version of `queueing' is 1.0.0 and can be downloaded
-from Octave-forge
+from Octave-Forge
- `http://octave.sourceforge.net/'
+ `http://octave.sourceforge.net/queueing/'
The package Web page is
`http://www.moreno.marzolla.name/software/queueing/'
- To install `queueing' in the system-wide location, such that all
-functions are automatically available when Octave starts, you can use
-`pkg install' command. At the Octave prompt, type the following:
+ If you have a recent version of GNU Octave and a network connection,
+you can install `queueing' directly from the prompt using this command:
- octave:1> pkg install queueing-1.0.0.tar.gz
+ octave:1> pkg install -forge queueing
- (Note: you may need to start Octave as root in order to allow the
+ The command above will automaticall download and install the latest
+version of the queueing toolbox from Octave Forge, and install it on
+your machine. You can verify that the package is indeed installed:
+
+ octave:1>pkg list queueing
+ Package Name | Version | Installation directory
+ --------------+---------+-----------------------
+ queueing *| 1.0.0 | /home/moreno/octave/queueing-1.0.0
+
+ Alternatively, you can first download `queueing' from Octave-Forge;
+then, to install the package in the system-wide location issue this
+command at the Octave prompt:
+
+ octave:1> pkg install _queueing-1.0.0.tar.gz_
+
+(you may need to start Octave as root in order to allow the
installation to copy the files to the target locations). After this,
all functions will be readily available each time Octave starts,
-without the need to tweak the search path. To uninstall `queueing', use
-the `pkg uninstall queueing' command.
+without the need to tweak the search path.
- If you do not have root access, you can do a local installation by
-issuing the following command at the Octave prompt:
+ If you do not have root access, you can do a local install using:
octave:1> pkg install -local queueing-1.0.0.tar.gz
- This will install `queueing' within the user's home directory, and
-the package will be available to that user only. *Note:* Octave version
+ This will install `queueing' within your home directory, and the
+package will be available to your user only. *Note:* Octave version
3.2.3 as shipped with Ubuntu 10.04 seems to ignore `-local' and always
tries to install the package on the system directory.
+ To remove `queueing' you can use
+
+ octave:1> pkg uninstall queueing
+
1.2 Manual installation
=======================
-If you want to install `queueing' in a custom location, you can
-download the source tarball from the URL above, and unpack it somewhere:
+If you want to manually install `queueing' in a custom location, you
+can download the tarball and unpack it somewhere:
- tar xfz queueing-1.0.0.tar.gz
- cd queueing-1.0.0/
+ tar xvfz queueing-1.0.0.tar.gz
+ cd queueing-1.0.0/queueing/
Copy all `.m' files from the `inst/' directory to some target
-location. Then, you can start Octave with the `-p' option to add the
-target location to the search path, so that Octave will find all
-`queueing' functions automatically:
+location. Then, start Octave with the `-p' option to add the target
+location to the search path, so that Octave will find all `queueing'
+functions automatically:
octave -p _/path/to/queueing_
For example, if all `queueing' m-files are in `/usr/local/queueing',
you can start Octave as follows:
- octave -p `/usr/local/queueing'
+ octave -p _/usr/local/queueing_
If you want, you can add the following line to `~/.octaverc':
@@ -79,10 +95,14 @@
1.3 Content of the source distribution
======================================
-The `queueing' package source code in the Subversion repository
-contains the following subdirectories (some of which are not included
-in the installation archive):
+The source code of the latest version of the `queueing' package can be
+found in the Subversion repository at the URL:
+`http://octave.svn.sourceforge.net/viewvc/octave/trunk/octave-forge/main/queueing/'
+
+ The source distribution contains the following directories (some of
+which are not included in the installation tarball):
+
`doc/'
Documentation source. Most of the documentation is extracted from
the comment blocks of individual function files from the `inst/'
Modified: trunk/octave-forge/main/queueing/doc/installation.txi
===================================================================
--- trunk/octave-forge/main/queueing/doc/installation.txi 2012-02-06 18:24:05 UTC (rev 9593)
+++ trunk/octave-forge/main/queueing/doc/installation.txi 2012-02-06 19:49:32 UTC (rev 9594)
@@ -56,41 +56,64 @@
@section Installation through Octave package management system
The most recent version of @code{queueing} is @value{VERSION} and can
-be downloaded from Octave-forge
+be downloaded from Octave-Forge
-@url{http://octave.sourceforge.net/}
+@url{http://octave.sourceforge.net/queueing/}
The package Web page is
@url{http://www.moreno.marzolla.name/software/queueing/}
-To install @code{queueing} in the system-wide location, such that all
-functions are automatically available when Octave starts, you can use
-@samp{pkg install} command. At the Octave prompt, type the following:
+If you have a recent version of GNU Octave and a network connection,
+you can install @code{queueing} directly from the prompt using this
+command:
@example
-octave:1> @kbd{pkg install queueing-@value{VERSION}.tar.gz}
+octave:1> @kbd{pkg install -forge queueing}
@end example
-(Note: you may need to start Octave as root in order to allow the
+The command above will automaticall download and install the latest
+version of the queueing toolbox from Octave Forge, and install it on
+your machine. You can verify that the package is indeed installed:
+
+@example
+octave:1>@kbd{pkg list queueing}
+Package Name | Version | Installation directory
+--------------+---------+-----------------------
+ queueing *| @value{VERSION} | /home/moreno/octave/queueing-@value{VERSION}
+@end example
+
+Alternatively, you can first download @code{queueing} from
+Octave-Forge; then, to install the package in the system-wide
+location issue this command at the Octave prompt:
+
+@example
+octave:1> @kbd{pkg install @emph{queueing-@value{VERSION}.tar.gz}}
+@end example
+
+@noindent (you may need to start Octave as root in order to allow the
installation to copy the files to the target locations). After this,
all functions will be readily available each time Octave starts,
-without the need to tweak the search path. To uninstall
-@code{queueing}, use the @samp{pkg uninstall queueing} command.
+without the need to tweak the search path.
-If you do not have root access, you can do a local installation by
-issuing the following command at the Octave prompt:
+If you do not have root access, you can do a local install using:
@example
octave:1> @kbd{pkg install -local queueing-@value{VERSION}.tar.gz}
@end example
-This will install @code{queueing} within the user's home directory,
-and the package will be available to that user only. @strong{Note:}
-Octave version 3.2.3 as shipped with Ubuntu 10.04 seems to ignore
+This will install @code{queueing} within your home directory, and the
+package will be available to your user only. @strong{Note:} Octave
+version 3.2.3 as shipped with Ubuntu 10.04 seems to ignore
@code{-local} and always tries to install the package on the system
directory.
+To remove @code{queueing} you can use
+
+@example
+octave:1> @kbd{pkg uninstall queueing}
+@end example
+
@c
@c
@c
@@ -98,19 +121,18 @@
@node Manual installation
@section Manual installation
-If you want to install @code{queueing} in a custom location, you can
-download the source tarball from the URL above, and unpack it
-somewhere:
+If you want to manually install @code{queueing} in a custom location,
+you can download the tarball and unpack it somewhere:
@example
-@kbd{tar xfz queueing-@value{VERSION}.tar.gz}
-@kbd{cd queueing-@value{VERSION}/}
+@kbd{tar xvfz queueing-@value{VERSION}.tar.gz}
+@kbd{cd queueing-@value{VERSION}/queueing/}
@end example
Copy all @code{.m} files from the @file{inst/} directory to some
-target location. Then, you can start Octave with the @option{-p}
-option to add the target location to the search path, so that Octave
-will find all @code{queueing} functions automatically:
+target location. Then, start Octave with the @option{-p} option to add
+the target location to the search path, so that Octave will find all
+@code{queueing} functions automatically:
@example
@kbd{octave -p @emph{/path/to/queueing}}
@@ -120,7 +142,7 @@
@file{/usr/local/queueing}, you can start Octave as follows:
@example
-@kbd{octave -p @file{/usr/local/queueing}}
+@kbd{octave -p @emph{/usr/local/queueing}}
@end example
If you want, you can add the following line to @file{~/.octaverc}:
@@ -140,10 +162,15 @@
@node Content of the source distribution
@section Content of the source distribution
-The @code{queueing} package source code in the Subversion repository
-contains the following subdirectories (some of which are not included
-in the installation archive):
+The source code of the latest version of the @code{queueing}
+package can be found in the Subversion repository at the URL:
+
+@url{http://octave.svn.sourceforge.net/viewvc/octave/trunk/octave-forge/main/queueing/}
+
+The source distribution contains the following directories (some of
+which are not included in the installation tarball):
+
@table @file
@item doc/
Documentation source. Most of the documentation is extracted from the
Modified: trunk/octave-forge/main/queueing/doc/queueing.html
===================================================================
--- trunk/octave-forge/main/queueing/doc/queueing.html 2012-02-06 18:24:05 UTC (rev 9593)
+++ trunk/octave-forge/main/queueing/doc/queueing.html 2012-02-06 19:49:32 UTC (rev 9594)
@@ -313,38 +313,55 @@
<h3 class="section">2.1 Installation through Octave package management system</h3>
<p>The most recent version of <code>queueing</code> is 1.0.0 and can
-be downloaded from Octave-forge
+be downloaded from Octave-Forge
- <p><a href="http://octave.sourceforge.net/">http://octave.sourceforge.net/</a>
+ <p><a href="http://octave.sourceforge.net/queueing/">http://octave.sourceforge.net/queueing/</a>
<p>The package Web page is
<p><a href="http://www.moreno.marzolla.name/software/queueing/">http://www.moreno.marzolla.name/software/queueing/</a>
- <p>To install <code>queueing</code> in the system-wide location, such that all
-functions are automatically available when Octave starts, you can use
-‘<samp><span class="samp">pkg install</span></samp>’ command. At the Octave prompt, type the following:
+ <p>If you have a recent version of GNU Octave and a network connection,
+you can install <code>queueing</code> directly from the prompt using this
+command:
-<pre class="example"> octave:1> <kbd>pkg install queueing-1.0.0.tar.gz</kbd>
+<pre class="example"> octave:1> <kbd>pkg install -forge queueing</kbd>
</pre>
- <p>(Note: you may need to start Octave as root in order to allow the
+ <p>The command above will automaticall download and install the latest
+version of the queueing toolbox from Octave Forge, and install it on
+your machine. You can verify that the package is indeed installed:
+
+<pre class="example"> octave:1><kbd>pkg list queueing</kbd>
+ Package Name | Version | Installation directory
+ --------------+---------+-----------------------
+ queueing *| 1.0.0 | /home/moreno/octave/queueing-1.0.0
+</pre>
+ <p>Alternatively, you can first download <code>queueing</code> from
+Octave-Forge; then, to install the package in the system-wide
+location issue this command at the Octave prompt:
+
+<pre class="example"> octave:1> <kbd>pkg install </kbd><em>queueing-1.0.0.tar.gz</em>
+</pre>
+ <p class="noindent">(you may need to start Octave as root in order to allow the
installation to copy the files to the target locations). After this,
all functions will be readily available each time Octave starts,
-without the need to tweak the search path. To uninstall
-<code>queueing</code>, use the ‘<samp><span class="samp">pkg uninstall queueing</span></samp>’ command.
+without the need to tweak the search path.
- <p>If you do not have root access, you can do a local installation by
-issuing the following command at the Octave prompt:
+ <p>If you do not have root access, you can do a local install using:
<pre class="example"> octave:1> <kbd>pkg install -local queueing-1.0.0.tar.gz</kbd>
</pre>
- <p>This will install <code>queueing</code> within the user's home directory,
-and the package will be available to that user only. <strong>Note:</strong>
-Octave version 3.2.3 as shipped with Ubuntu 10.04 seems to ignore
+ <p>This will install <code>queueing</code> within your home directory, and the
+package will be available to your user only. <strong>Note:</strong> Octave
+version 3.2.3 as shipped with Ubuntu 10.04 seems to ignore
<code>-local</code> and always tries to install the package on the system
directory.
-<div class="node">
+ <p>To remove <code>queueing</code> you can use
+
+<pre class="example"> octave:1> <kbd>pkg uninstall queueing</kbd>
+</pre>
+ <div class="node">
<a name="Manual-installation"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Content-of-the-source-distribution">Content of the source distribution</a>,
@@ -355,24 +372,23 @@
<h3 class="section">2.2 Manual installation</h3>
-<p>If you want to install <code>queueing</code> in a custom location, you can
-download the source tarball from the URL above, and unpack it
-somewhere:
+<p>If you want to manually install <code>queueing</code> in a custom location,
+you can download the tarball and unpack it somewhere:
-<pre class="example"> <kbd>tar xfz queueing-1.0.0.tar.gz</kbd>
- <kbd>cd queueing-1.0.0/</kbd>
+<pre class="example"> <kbd>tar xvfz queueing-1.0.0.tar.gz</kbd>
+ <kbd>cd queueing-1.0.0/queueing/</kbd>
</pre>
<p>Copy all <code>.m</code> files from the <samp><span class="file">inst/</span></samp> directory to some
-target location. Then, you can start Octave with the <samp><span class="option">-p</span></samp>
-option to add the target location to the search path, so that Octave
-will find all <code>queueing</code> functions automatically:
+target location. Then, start Octave with the <samp><span class="option">-p</span></samp> option to add
+the target location to the search path, so that Octave will find all
+<code>queueing</code> functions automatically:
<pre class="example"> <kbd>octave -p </kbd><em>/path/to/queueing</em>
</pre>
<p>For example, if all <code>queueing</code> m-files are in
<samp><span class="file">/usr/local/queueing</span></samp>, you can start Octave as follows:
-<pre class="example"> <kbd>octave -p </kbd><samp><span class="file">/usr/local/queueing</span></samp>
+<pre class="example"> <kbd>octave -p </kbd><em>/usr/local/queueing</em>
</pre>
<p>If you want, you can add the following line to <samp><span class="file">~/.octaverc</span></samp>:
@@ -393,10 +409,14 @@
<h3 class="section">2.3 Content of the source distribution</h3>
-<p>The <code>queueing</code> package source code in the Subversion repository
-contains the following subdirectories (some of which are not included
-in the installation archive):
+<p>The source code of the latest version of the <code>queueing</code>
+package can be found in the Subversion repository at the URL:
+ <p><a href="http://octave.svn.sourceforge.net/viewvc/octave/trunk/octave-forge/main/queueing/">http://octave.svn.sourceforge.net/viewvc/octave/trunk/octave-forge/main/queueing/</a>
+
+ <p>The source distribution contains the following directories (some of
+which are not included in the installation tarball):
+
<dl>
<dt><samp><span class="file">doc/</span></samp><dd>Documentation source. Most of the documentation is extracted from the
comment blocks of individual function files from the <samp><span class="file">inst/</span></samp>
Modified: trunk/octave-forge/main/queueing/doc/queueing.pdf
===================================================================
(Binary files differ)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
