.de1 NOP
.  it 1 an-trap
.  if \\n[.$] \,\\$*\/
..
.ie t \
.ds B-Font [CB]
.ds I-Font [CI]
.ds R-Font [CR]
.el \
.ds B-Font B
.ds I-Font I
.ds R-Font R
.TH occtl 8 "2017-03-24" "0.11.6" "System Management"
.\"
.\" DO NOT EDIT THIS FILE (in-mem file)
.\"
.\" It has been AutoGen-ed
.\" From the definitions ../src/occtl/args.def.tmp
.\" and the template file agman-cmd.tpl
.SH NAME
\f\*[B-Font]occtl\fP
\- OpenConnect VPN server control
.SH SYNOPSIS
Openconnect VPN server control (occtl) is a tool to control
the ocserv VPN server.
.SH DESCRIPTION
This a control tool that can be used to send commands to ocserv. When
called without any arguments the tool can be used interactively, where 
each command is entered on a command prompt; alternatively the tool
can be called with the command specified as parameter. In the latter
case the tool's exit code will reflect the successful execution of
the command.
.SH "OPTIONS"
.TP
.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]file\f[], \f\*[B-Font]\-\-socket\-file\f[]=\f\*[I-Font]file\f[]
Specify the server's occtl socket file.
.sp
This option is only needed if you have multiple servers.
.TP
.NOP \f\*[B-Font]\-j\f[], \f\*[B-Font]\-\-json\f[]
Output will be JSON formatted.
.sp
This option can only be used with non-interactive output, e.g., 'occtl \--json show users'.
.TP
.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-no\-pager\f[]
No pager will be used over output data.
.sp
.TP
.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[]
Display usage information and exit.
.TP
.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
Pass the extended usage information through a pager.
.TP
.NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]}]
Output version of program and exit.  The default mode is `v', a simple
version.  The `c' mode will print copyright information and `n' will
print the full copyright notice.
.PP
.SH "IMPLEMENTATION NOTES"
This tool uses unix domain sockets to connect to ocserv.
.SH EXAMPLES
The tool can be run interactively when run with no arguments. When
arguments are given they are interpreted as commands. For example:
.br
.in +4
.nf
$ occtl show users
.in -4
.fi
.sp
Any command line arguments to be used as options must preceed the
command (if any), as shown below.
.br
.in +4
.nf
$ occtl \-\-json show users
.in -4
.fi
.SH "EXIT STATUS"
One of the following exit values will be returned:
.TP
.NOP 0 " (EXIT_SUCCESS)"
Successful program execution.
.TP
.NOP 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.TP
.NOP 70 " (EX_SOFTWARE)"
libopts had an internal operational error.  Please report
it to autogen-users@lists.sourceforge.net.  Thank you.
.PP
.SH "SEE ALSO"
ocserv(8)
.SH "AUTHORS"
Nikos Mavrogiannopoulos
.SH "COPYRIGHT"
Copyright (C) 2014-2016 Red Hat all rights reserved.
This program is released under the terms of the GNU General Public License, version 2.
.SH "BUGS"
Please send bug reports to: openconnect-devel@lists.infradead.org
.SH "NOTES"
This manual page was \fIAutoGen\fP-erated from the \fBocctl\fP
option definitions.