NAME

xas-supctl - the control program for XAS Supervisor

SYNOPSIS

xas-supctl [--help] [--debug] [--manual] [--version]

 options:
   --start        start a process
   --stop         stop a process
   --kill         kills a process
   --pause        pause a process
   --resume       resume a process
   --status       returns the status of a process
   --list         list processes
   --help         outputs simple help text
   --manual       outputs the procedures manual
   --version      outputs the apps version
   --debug        toogles debugging output
   --alerts       toogles alert notifications
   --log-file     name of the log file 
   --log-type     toggles the log type
   --log-facility changes the log facility

DESCRIPTION

This procedure is used to communicate with the XAS Supervisor. It allows you to start/stop/pause/resume and list the know processes with the supervisor.

OPTIONS AND ARGUMENTS

--start <name>

Starts the named process.

--stop <name>

Stops the named process.

--kill <name>

Kills the named process.

--pause <name>

Pauses the named process.

--resume <name>

Resumes the named process.

--status <name>

Returns the status of the named process.

--list

Lists all of the known processes on the supervisor.

--help

Displays a simple help message.

--debug

Turns on debbuging.

--alerts

Togggles alert notification.

--log-type

Toggles the log type. Defaults to 'console'. Can be 'console', 'file', 'json' or 'syslog'.

--log-facility

Toggles the log facilty. Defaults to 'local6'. This follows syslog convention.

--log-file

Optional logfile. When specified the log type is set to 'file'.

--manual

The complete documentation.

--version

Prints out the apps version

EXIT CODES

 0 - success
 1 - failure

SEE ALSO

XAS::Apps::Supervisor::Client

XAS::Supervisor

XAS

AUTHOR

Kevin L. Esteb, <kevin@kesteb.us>

COPYRIGHT AND LICENSE

Copyright (c) 2012-2015 Kevin L. Esteb

This is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0. For details, see the full text of the license at http://www.perlfoundation.org/artistic_license_2_0.