'\" t
.\"     Title: zorpctl
.\"    Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 03/06/2012
.\"    Manual: [FIXME: manual]
.\"    Source: [FIXME: source]
.\"  Language: English
.\"
.TH "ZORPCTL" "8" "03/06/2012" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
zorpctl_ \- Start and stop zorp instances\&.
.SH "SYNOPSIS"
.HP \w'\fBzorpctl\ command\fR\ 'u
\fBzorpctl command\fR [options\ [instances/@instance\-list\-file]]
.SH "DESCRIPTION"
.PP

\fBzorpctl\fR
starts and stops
zorp(8)
instances based on the contents of the
instances\&.conf(5)
file\&. Multiple instance names can be specified in the command\-line or in a file to start or stop several instances\&. If an error occurs while stopping or starting an instance, an exclamation mark is appended to the instance name as
\fBzorpctl\fR
processes the request, and a summary is printed when the program exits\&. If no instance is specified, the command is executed on all instances\&. The instances to be controlled can be specified in a file instead of listing them in the command line, e\&.g\&.:
\fBzorpctl command options instances\&.txt\fR\&. The
instances\&.txt
should contain every instance name in a new line\&.
.SH "COMMANDS"
.PP
\fBstart\fR
.RS 4
Starts the specified Zorp instance(s)\&.
.RE
.PP
\fBforce\-start\fR
.RS 4
Starts the specified Zorp instance(s) even if they are disabled\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the specified Zorp instance(s)\&.
.RE
.PP
\fBforce\-stop\fR
.RS 4
Forces the specified Zorp instance(s) to stop using the KILL signal\&.
.RE
.PP
\fBrestart\fR
.RS 4
Restart the specified Zorp instance(s)\&.
.RE
.PP
\fBforce\-restart\fR
.RS 4
Forces the specified Zorp instance(s) to restart by stopping them using the KILL signal\&.
.RE
.PP
\fBreload\fR
.RS 4
Reload the specified Zorp instance(s)\&.
.RE
.PP
\fBstatus\fR
.RS 4
Display the status of the specified Zorp instance(s)\&.
.PP
\fB\-\-verbose\fR or \fB\-v\fR
.RS 4
Display detailed status information\&.
.RE
.RE
.PP
\fBgui\-status\fR
.RS 4
Display the status of the specified Zorp instance(s) in an internal format easily parsable by ZMC\&. NOTE: This command is mainly used internally within Zorp, and the structure of its output may change\&.
.RE
.PP
\fBversion\fR
.RS 4
Display version information on Zorp\&.
.RE
.PP
\fBinclog\fR
.RS 4
Raise the verbosity (log) level of the specified Zorp instance(s) by one\&.
.RE
.PP
\fBdeclog\fR
.RS 4
Decrease the verbosity (log) level of the specified Zorp instance(s) by one\&.
.RE
.PP
\fBlog\fR
.RS 4
Change various log related settings in the specified Zorp instance(s) using the following options:
.PP
\fB\-\-vinc\fR or \fB\-i\fR
.RS 4
Increase verbosity level by one\&.
.RE
.PP
\fB\-\-vdec\fR or \fB\-d\fR
.RS 4
Decrease verbosity level by one\&.
.RE
.PP
\fB\-\-vset <verbosity>\fR or \fB\-s <verbosity>\fR
.RS 4
Set verbosity level to <verbosity>\&.
.RE
.PP
\fB\-\-log\-spec <spec>\fR or \fB\-S <spec> \fR
.RS 4
Set verbosity mask on a per category basis\&. The format of this value is described in
zorp(8)\&.
.RE
.PP
\fB\-\-help\fR or \fB\-h\fR
.RS 4
Display this help screen on the options of the
\fBlog\fR
command\&.
.RE
.RE
.PP
\fBszig\fR
.RS 4
Display internal information from the specified Zorp instance(s)\&. The information to be disblayed can be specified with the following options:
.PP
\fB\-\-walk\fR or \fB\-w\fR
.RS 4
Walk the specified tree\&.
.RE
.PP
\fB\-\-root [node]\fR or \fB\-r [node]\fR
.RS 4
Set the root node of the walk operation to [node]\&.
.RE
.PP
\fB\-\-help\fR or \fB\-h\fR
.RS 4
Display a brief help on the options of the
\fBszig\fR
command\&.
.RE
.RE
.PP
\fBhelp\fR
.RS 4
Display a brief help message\&.
.RE
.SH "EXAMPLES"
.PP

\fBzorpctl start zorp_ftp\fR
.PP
The command above starts the zorp instance named
\fIzorp\-ftp\fR
with parameters described in the
instances\&.conf
file\&.
.SH "FILES"
.PP
The default location for
instances\&.conf
is
/etc/zorp/instances\&.conf\&.
.SH "AUTHOR"
.PP
This manual page was written by the BalaBit Documentation Team <documentation@balabit\&.com>\&.
.SH "COPYRIGHT"
.PP
Copyright \(co 2006 BalaBit IT Security Ltd\&. All rights reserved\&. For more information about the legal status of this document please read:
\m[blue]\fBhttp://www\&.balabit\&.com/products/zorp/docs/legal_notice\&.bbq\fR\m[]