.\"
.\" Man page for queue.sh (and the former manpath)
.\"
.\" Copyright (c) 2004-2008, Laurent Mazet.
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the README file that comes with the man 1.0
.\" distribution.  
.\"
.\" Laurent Mazet
.\" laurent.mazet@motorola.com
.\"
.Dd August 1, 2005
.Os CRM Motorola
.Dt QUEUE.SH 1 1
.\"
.\"
.Sh NAME
.Nm queue.sh
.Nd dispatch batch program on a cluster of computers
.\"
.\"
.Sh SYNOPSIS
.Nm queue.sh
.Fl a | -add
.Ar directory scripts
.Nm queue.sh
.Fl e | -erase
.Ar jids
.Nm queue.sh
.Fl h | -help
.Nm queue.sh
.Fl k | -kill
.Nm queue.sh
.Fl l | le | la | -list | -listended | -listall
.Nm queue.sh
.Fl r | -stat
.Nm queue.sh
.Fl s | -start
.Nm queue.sh
.Fl v | -version
.Nm queue.sh
.Fl x | -lock
.\"
.\"
.Sh DESCRIPTION
.Nm queue.sh
dispatch batch program on a cluster of computers. This is not a true load-balancing scheduler but It's more likely a batch queue without any server.
.\"
.\"
.Sh USER OPTIONS
.Bl -tag -width 6n -compact
.It Fl a Ar directory scripts
.It Fl -add Ar directory scripts
This form is used to add one or several jobs on the queue by specifying the
.Ar script(s)
you want to execute and its
.Ar directory .
You have to be sure that all data and library need by your program is linked into the program directory or any of its sub-directories. You can't add any parameter to the job script and you can add several scripts from a directory at the same time.
.Pp
.It Fl e Ar jids
.It Fl -erase Ar jids
This form is used to remove one or several waiting jobs from the queue or to kill one or several jobs in action. The killing action is not instantaneous and need 60 seconds to be executed.
.Pp
.It Fl h
.It Fl -help
is used to display queue (short) help.
.Pp
.It Fl l | le | la
.It Fl -list | -listended | -listall
Those options are used to list respectively the user jobs in action or waiting, the user ended jobs, or all current jobs in action.
.Pp
.It Fl v
.It Fl -version
is used to display queue version.
.El
.\"
.\"
.Sh ADMINISTRATOR OPTIONS
.Bl -tag -width 6n -compact
.It Fl c
.It Fl -count
is used to count active queues
.Pp
.It Fl k
.It Fl -kill
is used to kill all running queues on a node. Active process are re-sceduled in top of the list. Only queue user can do it.
.Pp
.It Fl r
.It Fl -stat
is used to compute statistics on queue usage.
.Pp
.It Fl s
.It Fl -start
is used to start a new queue on a node. Only queue user can do it.
.El
.\"
.\"
.Sh FILES
.Bl -tag -width 6n
.Sm off
.It Pa /home/queue/spool/ Ar user
.Sm on
directory where batch programs are copied and executed.
.Sm off
.El
.\"
.\"
.Sh AUTHORS
Written by Laurent Mazet.
.\"
.\"
.Sh "REPORTING BUGS"
Report bugs to <laurent.mazet@motorola.com>.
.\"
.\"
.Sh COPYRIGHT
Copyright \(co 2004-2008 Laurent Mazet.
.br
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.