1This file documents the installation procedure of the Octave 'queueing'
2package.
3
4   'queueing' is free software; you can redistribute it and/or modify it
5under the terms of the GNU General Public License, version 3 or later,
6as published by the Free Software Foundation.
7
8     Note: This file ('INSTALL') is automatically generated from
9     'doc/installation.txi' in the 'queueing' source tree.  Do not
10     modify this document directly, as changes will be lost.  Modify
11     'doc/installation.txi' instead.
12
131 Installation and Getting Started
14**********************************
15
161.1 Installation through Octave package management system
17=========================================================
18
19The most recent version of 'queueing' is 1.2.7 and can be downloaded
20from Octave-Forge
21
22   <https://octave.sourceforge.io/queueing/>
23
24   Additional information can be found at
25
26   <http://www.moreno.marzolla.name/software/queueing/>
27
28   To install 'queueing', follow these steps:
29
30  1. If you have a recent version of GNU Octave and a network
31     connection, you can install 'queueing' from Octave command prompt
32     using this command:
33
34          octave:1> pkg install -forge queueing
35
36     The command above will download and install the latest version of
37     the 'queueing' package from Octave Forge, and install it on your
38     machine.
39
40     If you do not have root access, you can perform a local install
41     with:
42
43          octave:1> pkg install -local -forge queueing
44
45     This will install 'queueing' in your home directory, and the
46     package will be available to the current user only.
47
48  2. Alternatively, you can first download the 'queueing' tarball from
49     Octave-Forge; to install the package in the system-wide location
50     issue this command at the Octave prompt:
51
52          octave:1> pkg install _queueing-1.2.7.tar.gz_
53
54     (you may need to start Octave as root in order to allow the
55     installation to copy the files to the target locations).  After
56     this, all functions will be available each time Octave starts,
57     without the need to tweak the search path.
58
59     If you do not have root access, you can do a local install using:
60
61          octave:1> pkg install -local queueing-1.2.7.tar.gz
62
63  3. Use the 'pkg list' command at the Octave prompt to check that the
64     'queueing' package has been succesfully installed; you should see
65     something like:
66
67          octave:1>pkg list queueing
68          Package Name  | Version | Installation directory
69          --------------+---------+-----------------------
70              queueing  |   1.2.7 | /home/moreno/octave/queueing-1.2.7
71
72  4. Starting from version 1.1.1, 'queueing' is no longer automatically
73     loaded on Octave start.  To make the functions available for use,
74     you need to issue the command
75
76          octave:1>pkg load queueing
77
78     at the Octave prompt.  To automatically load 'queueing' each time
79     Octave starts, you can add the command above to the startup script
80     (usually, '~/.octaverc' on Unix systems).
81
82  5. To completely remove 'queueing' from your system, use the 'pkg
83     uninstall' command:
84
85          octave:1> pkg uninstall queueing
86
871.2 Manual installation
88=======================
89
90If you want to manually install 'queueing' in a custom location, you can
91download the tarball and unpack it somewhere:
92
93     tar xvfz queueing-1.2.7.tar.gz
94     cd queueing-1.2.7/queueing/
95
96   Copy all '.m' files from the 'inst/' directory to some target
97location.  Then, start Octave with the '-p' option to add the target
98location to the search path, so that Octave will find all 'queueing'
99functions automatically:
100
101     octave -p _/path/to/queueing_
102
103   For example, if all 'queueing' m-files are in '/usr/local/queueing',
104you can start Octave as follows:
105
106     octave -p _/usr/local/queueing_
107
108   If you want, you can add the following line to '~/.octaverc':
109
110     addpath("_/path/to/queueing_");
111
112so that the path '/path/to/queueing' is automatically added to the
113search path each time Octave is started, and you no longer need to
114specify the '-p' option on the command line.
115
116