.\" Man page generated from reStructuredText.
.
.TH "CIRCUSCTL" "1" "November 30, 2015" "0.12.1" "Circus"
.SH NAME
circusctl \- circus daemon control insterface
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
circusctl [options] command [args]
.SH DESCRIPTION
.sp
circusctl is front end to control the Circus daemon. It is designed to
help the administrator control the functionning of the Circud
\fBcircusd\fP daemon.
.SH COMMANDS
.INDENT 0.0
.TP
.B add
Add a watcher
.TP
.B decr
Decrement the number of processes in a watcher
.TP
.B dstats
Get circusd stats
.TP
.B get
Get the value of specific watcher options
.TP
.B globaloptions
Get the arbiter options
.TP
.B incr
Increment the number of processes in a watcher
.TP
.B ipython
Create shell into circusd process
.TP
.B list
Get list of watchers or processes in a watcher
.TP
.B listen
Subscribe to a watcher event
.TP
.B listsockets
Get the list of sockets
.TP
.B numprocesses
Get the number of processes
.TP
.B numwatchers
Get the number of watchers
.TP
.B options
Get the value of all options for a watcher
.TP
.B quit
Quit the arbiter immediately
.TP
.B reload
Reload the arbiter or a watcher
.TP
.B reloadconfig
Reload the configuration file
.TP
.B restart
Restart the arbiter or a watcher
.TP
.B rm
Remove a watcher
.TP
.B set
Set a watcher option
.TP
.B signal
Send a signal
.TP
.B start
Start the arbiter or a watcher
.TP
.B stats
Get process infos
.TP
.B status
Get the status of a watcher or all watchers
.TP
.B stop
Stop watchers
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-endpoint \fIENDPOINT\fP
connection endpoint
.TP
.B \-h, \-\-help
Show the help message and exit
.TP
.B \-\-json
output to JSON
.TP
.B \-\-prettify
prettify output
.TP
.B \-\-ssh \fISSH\fP
SSH Server in the format \fBuser@host:port\fP
.TP
.B \-\-ssh_keyfile \fISSH_KEYFILE\fP
path to the keyfile to authorise the user
.TP
.B \-\-timeout \fITIMEOUT\fP
connection timeout
.TP
.B \-\-version
Displays Circus version and exits.
.UNINDENT
.SH SEE ALSO
.sp
\fIcircus\fP (1), \fIcircusd\fP (1), \fIcircusd\-stats\fP (1), \fIcircus\-plugin\fP (1), \fIcircus\-top\fP (1).
.sp
Full Documentation is available at \fI\%http://circus.readthedocs.org\fP
.SH AUTHOR
David Douard
.\" Generated by docutils manpage writer.
.