1
.. IVLE - Informatics Virtual Learning Environment
2
Copyright (C) 2007-2009 The University of Melbourne
4
.. This program is free software; you can redistribute it and/or modify
5
it under the terms of the GNU General Public License as published by
6
the Free Software Foundation; either version 2 of the License, or
7
(at your option) any later version.
9
.. This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
GNU General Public License for more details.
14
.. You should have received a copy of the GNU General Public License
15
along with this program; if not, write to the Free Software
16
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22
IVLE has a number of Admin scripts to configure IVLE or for functionality not
23
directly in the web application.
25
Most of these script are required to be run as root.
30
.. program:: ivle-addexercise
32
:program:`ivle-addexercise <EXERCISE>`
34
Adds an XML encoded exercise to the IVLE database.
36
.. cmdoption:: <EXERCISE>
38
The XML file containing the exercise to be uploaded.
43
.. program:: ivle-adduser
45
:program:`ivle-adduser [OPTIONS] <LOGIN> <FULLNAME>`
47
Script to create a new user.
49
.. FIXME: "This can also be done through the administration interface."
52
This script wraps common.makeuser. It also creates a unix account which
53
common.makeuser does not. (This script may not be appropriate for production
54
on a multi-node environment)
56
.. cmdoption:: <LOGIN>
58
The login name of the new user
60
.. cmdoption:: <FULLNAME>
62
The full name of the user
64
.. cmdoption:: -p <PASSWORD>, --password <PASSWORD>
68
.. cmdoption:: -n <NICK>, --nick <NICK>
70
Display name (defaults to <FULLNAME>)
72
.. cmdoption:: -e <EMAIL>, --email <EMAIL>
76
.. cmdoption:: -s <SID>, --studentid <SID>
80
.. cmdoption:: --admin
82
Give the user full administrative privileges
88
.. program:: ivle-buildjail
90
:program:`ivle-buildjail [OPTIONS]`
92
.. cmdoption:: -r, --recreate
94
Completely recreate the jail - don't just update its IVLE code.
98
This may download hundreds of megabytes from the location specified by
101
.. cmdoption:: -u, --upgrade
103
Apply any package updates in the jail.
105
.. cmdoption:: -m <MIRROR>, --mirror <MIRROR>
113
.. program:: ivle-cloneworksheets
115
:program:`ivle-cloneworksheets <OLDSUBJECTCODE> <OLDYEAR> <OLDSEMESTER>
116
<NEWSUBJECTCODE> <NEWYEAR> <NEWSEMESTER>`
118
Populates the subject specified by ``<NEWSUBJECTCODE> <NEWYEAR>
119
<NEWSEMESTER>`` with a copy of the worksheets from the subject specified by
120
``<OLDSUBJECTCODE> <OLDYEAR> <OLDSEMESTER>``.
126
.. program:: ivle-config
128
:program:`ivle-config [ARG1] [ARG2] ...`
130
Configures IVLE with machine-specific details, most notably, various paths.
131
Either prompts the administrator for these details or accepts them as
134
Command-line arguments may be any of the :ref:`configuration option
135
<ref-configuration-options>` used in :file:`ivle.conf`. They are provided in
136
the form of :samp:`--{section}/{subsection}/{property} {VALUE}` such as
137
``--urls/root ivle.org`` or ``--media/externals/jquery
138
/usr/share/javascript/jquery``.
140
Automatically creates the file :file:`/etc/ivle.conf`.
146
.. program:: ivle-createdatadirs
148
:program:`ivle-createdatadirs`
150
Creates an IVLE data hierarchy if it does not already exist.
156
.. program:: ivle-enrol
158
:program:`ivle-enrol <LOGIN> <SUBJECTCODE> <YEAR> <SEMESTER> [ROLE]`
160
Script to enrol a user in an offering.
162
.. cmdoption:: <LOGIN>
164
The login of the user to enrol.
166
.. cmdoption:: <SUBJECTCODE>
168
The subject code of the offering.
170
.. cmdoption:: <YEAR>
172
The year of the offering.
174
.. cmdoption:: <SEMESTER>
176
The semester of the offering
178
.. cmdoption:: [ROLE]
180
Set the role of the user. Should be one of 'student' (default), 'tutor' or
187
.. program:: ivle-enrolallusers
189
:program:`ivle-enrolallusers`
191
Script to add enrolments for all users on the system.
192
Pulls from the configured :ref:`subject pulldown module
193
<ref-subject-pulldown-modules>` the subjects each student
194
is enrolled in, and adds enrolments to the database.
195
Does not remove any enrolments.
197
Requires root to run.
199
.. cmdoption:: -u <LOGIN>, --user <LOGIN>
201
Just perform enrolment for user ``<LOGIN>``
203
.. cmdoption:: -v, --verbose
205
Print out the details of each enrolment.
207
.. cmdoption:: -y, --year
209
If specified, year to make enrolments for (default is the current year)
212
ivle-fetchsubmissions
213
---------------------
215
.. program:: ivle-fetchsubmissions
217
:program:`ivle-fetchsubmissions [OPTIONS] <SUBJECT> <PROJECTNAME>`
219
Retrieves all submissions for a given project. Places each submission in its
220
own directory, in a subdirectory of '.'. Any errors are reported to stderr
221
(otherwise is silent).
223
Requires root to run.
225
.. cmdoption:: <SUBJECT>
227
The short name given to the subject
229
.. cmdoption:: <PROJECTNAME>
231
The name of the project to retrieve.
233
.. cmdoption:: -s <SEMESTER>, --semester <SEMESTER>
235
Semester of the subject's offering (eg. 2009/1). Defaults to the currently
238
.. cmdoption:: -d <PATH>, --dest <PATH>
240
Destination directory (defaults to '.') to place submissions. Will create
241
subdirectories in this directory of the form
242
``subject/year/semester/project``.
244
.. cmdoption:: -z, --zip
246
Store each submission in a Zip file.
248
.. cmdoption:: -v, --verbose
250
Print out the name of each submission as it is extracted.
252
.. cmdoption:: --no-txt
254
Disable writing a text file with metadata about each submission.
260
.. program:: ivle-listusers
262
:program:`ivle-listusers [OPTIONS]`
264
Gets a list of all users in the IVLE database.
266
Requires root to run.
268
.. cmdoption:: -n, --names
270
Only prints the logins of users
276
.. program:: ivle-marks
278
:program:`ivle-marks [OPTIONS] <SUBJECT>`
280
Reports each student's marks for a given subject offering.
282
Requires root to run.
284
.. cmdoption:: <SUBJECT>
286
The short name given to the subject
288
.. cmdoption:: -s <SEMESTER>, --semester <SEMESTER>
290
Semester of the subject's offering (eg. 2009/1). Defaults to the currently
293
.. cmdoption:: -c <CUTOFF>, --cutoff <CUTOFF>
295
Cutoff date (calculate the marks as of this date). Should be provided in
296
the form of ``YYYY-MM-DD H:M:S``.
302
.. program:: ivle-mountallusers
304
:program:`ivle-mountallusers`
306
Attempts to mount the jails of all users.
310
Administrators should not be required to manually run this script for
311
regular operation. IVLE will automatically mount user's jails on demand.
313
Requires root to run.
315
.. cmdoption:: -v, --verbose
317
Prints the details of each user's jail being mounted/unmounted
319
.. cmdoption:: -u, --unmount
321
Unmount jails instead of mounting them.
324
ivle-refreshfilesystem
325
----------------------
327
.. program:: ivle-refreshfilesystem
329
:program:`ivle-refreshfilesystem`
331
Refresh parts of the filesystem that are generated from the database.
333
In particular, the Subversion authorisation files are rewritten.
339
.. program:: ivle-remakeuser
341
:program:`ivle-remakeuser [OPTIONS] <USER>`
343
:program:`ivle-remakeuser [OPTIONS] -a`
345
Rebuilds the Jail of a user or all users in IVLE. This will not delete the
346
data of the users being rebuilt.
348
Requires root to run.
350
.. cmdoption:: <USER>
352
Login of the user whose Jail will be rebuilt.
354
.. cmdoption:: -v, --verbose
356
Prints the details of each user's jail being remade.
358
.. cmdoption:: -a, --all
360
Rebuild all users Jails.
366
.. program:: ivle-showenrolment
368
:program:`ivle-showenrolment <USER>`
370
Shows the enrolments of a user. Prints subject code, subject name, year,
371
semester and role the user has in each subject they are enrolled in.
373
Requires root to run.
375
.. cmdoption:: <USER>
377
Login of the user to view enrolments details.
added
removed
doc/man/scripts.rst
