.\" Copyright (c) 2012 Joseph Koshy.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" This software is provided by Joseph Koshy ``as is'' and
.\" any express or implied warranties, including, but not limited to, the
.\" implied warranties of merchantability and fitness for a particular purpose
.\" are disclaimed.  in no event shall Joseph Koshy be liable
.\" for any direct, indirect, incidental, special, exemplary, or consequential
.\" damages (including, but not limited to, procurement of substitute goods
.\" or services; loss of use, data, or profits; or business interruption)
.\" however caused and on any theory of liability, whether in contract, strict
.\" liability, or tort (including negligence or otherwise) arising in any way
.\" out of the use of this software, even if advised of the possibility of
.\" such damage.
.\"
.\" $Id$
.\"
.Dd August 29, 2012
.Os
.Dt YABS 1
.Sh NAME
.Nm yabs
.Nd yet another job scheduler
.Sh SYNOPSIS
.Nm
.Op Fl c Ar configdir
.Op Fl d
.Op Fl v
.Ar jobname
.Pp
.Nm
.Ar sub-command
.Op Ar sub-command-options
.Sh DESCRIPTION
The
.Nm
utility schedules jobs that span multiple machines.
A typical use for this utility would be to control multi-machine
software builds.
.Pp
The first form of invocation is used to invoke a job.
The argument
.Ar jobname
should specify the name of job description specified in a
configuration file.
.Pp
The second form of invocation is used inside slave and scheduler
scripts.
.Pp
The
.Nm
utility recognizes the following options:
.Bl -tag -width indent
.It Fl c Ar configdir
Search for configuration information in directory
.Ar configdir .
This option may be specified multiple times.
The default is to look under
.Pa $HOME/.yabs
and the system default directory
.Pa /etc/yabs .
.It Fl d
Enable job debugging.
.It Fl v
Be verbose.
.El
.Sh EXIT STATUS
.Ex -std
.Sh FILES
.Bl -tag -width indent
.It Pa /etc/yabs/default/
System-wide default configuration information.
.It Pa /etc/yabs/ Ns Ar jobname
System-wide configuration for job
.Ar jobname .
.It Pa $HOME/.yabs/default
Per-user default configuration information.
.It Pa $HOME/.yabs/ Ns Ar jobname
Per-user configuration for job
.Ar jobname .
.It Pa /var/log/yabs/ Ns Ar jobname Ns . Ns Ar number Ns /
Directory containing the log files generated by a job.
.El
.Sh ENVIRONMENT
.Bl -tag -width indent
.It Li YABS_JOB
(Set by
.Nm )
The current job identifier.
This a string of the form
.Dq Ar jobname Ns . Ns Ar number .
.It Li YABS_SLAVE
(Set by
.Nm )
The current slave identifier.
.El
.Sh EXAMPLES
To invoke a job named
.Sq myjob ,
use:
.Dl $ yabs myjob
.Sh SEE ALSO
.Xr sh 1
.Sh HISTORY
The
.Nm
utility was created by
.An "Joseph Koshy" Aq jkoshy@users.sourceforge.net
under the aegis of the Elftoolchain project.