[mirror_ovs.git] / lib / unixctl.man

.IP "\fB\-\-unixctl=\fIsocket\fR"
Sets the name of the control socket on which \fB\*(PN\fR listens for
runtime management commands (see \fBRUNTIME MANAGEMENT COMMANDS\fR,
below).  If \fIsocket\fR does not begin with \fB/\fR, it is
interpreted as relative to \fB@RUNDIR@\fR.  If \fB\-\-unixctl\fR is
not used at all, the default socket is
\fB@RUNDIR@/\*(PN.\fIpid\fB.ctl\fR, where \fIpid\fR is \fB\*(PN\fR's
process ID.
.IP
On Windows a local named pipe is used to listen for runtime management
commands.  A file is created in the absolute path as pointed by
\fIsocket\fR or if \fB\-\-unixctl\fR is not used at all, a file is
created as \fB\*(PN.ctl\fR in the configured \fIOVS_RUNDIR\fR
directory.  The file exists just to mimic the behavior of a Unix domain socket.
.IP
Specifying \fBnone\fR for \fIsocket\fR disables the control socket
feature.
Commit	Line	Data
7b38bdc8 BP	1	.IP "\fB\-\-unixctl=\fIsocket\fR"
	2	Sets the name of the control socket on which \fB\*(PN\fR listens for
	3	runtime management commands (see \fBRUNTIME MANAGEMENT COMMANDS\fR,
	4	below). If \fIsocket\fR does not begin with \fB/\fR, it is
	5	interpreted as relative to \fB@RUNDIR@\fR. If \fB\-\-unixctl\fR is
	6	not used at all, the default socket is
	7	\fB@RUNDIR@/\(PN.\fIpid\fB.ctl\fR, where \fIpid\fR is \fB\(PN\fR's
	8	process ID.
cb54a8c5	9	.IP
922247c6 AS	10	On Windows a local named pipe is used to listen for runtime management
	11	commands. A file is created in the absolute path as pointed by
	12	\fIsocket\fR or if \fB\-\-unixctl\fR is not used at all, a file is
	13	created as \fB\*(PN.ctl\fR in the configured \fIOVS_RUNDIR\fR
	14	directory. The file exists just to mimic the behavior of a Unix domain socket.
cb54a8c5	15	.IP
614c4892 BP	16	Specifying \fBnone\fR for \fIsocket\fR disables the control socket
614c4892 BP	17	feature.