Cleanup git-status by not showing some unnecessary files.
[sliver-openvswitch.git] / utilities / vlogconf.8
1 .TH vlogconf 8 "June 2008" "OpenFlow" "OpenFlow Manual"
2
3 .SH NAME
4 vlogconf \- configuration utility for OpenFlow logging in userspace
5
6 .SH SYNOPSIS
7 \fBvlogconf\fR [\fB-h\fR | \fB--help\fR] [\fItarget\fR...] [\fIaction\fR...]
8 .sp 1
9 The available \fItarget\fR options are:
10 .br
11 [\fB-a\fR | \fB--all\fR] [\fB-t\fR \fIpid\fR | \fB--target=\fIpid\fR]
12 .sp 1
13 The available \fIaction\fR options are:
14 .br
15 [\fB-l\fR | \fB--list\fR] [\fB-s\fR
16 \fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]] |
17 \fB--set=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]
18
19 .SH DESCRIPTION
20 The \fBvlogconf\fR program configures the logging system used by 
21 OpenFlow userspace programs.  The logging configuration may be modified 
22 while OpenFlow programs are running.
23
24 \fBvlogconf\fR applies one or more actions to each of one or more
25 target processes.  Targets may be specified as:
26
27 .TP
28 \fB-a\fR, \fB--all\fR
29 All running processes that \fBvlogconf\fR can control.
30
31 .TP
32 \fB-t \fIpid\fR, \fB--target=\fIpid\fR
33 The process with the specified \fIpid\fR.  \fIpid\fR may also specify
34 an absolute path (beginning with `/') to the Unix domain socket for a
35 \fBvlogconf\fR-controllable process.
36
37 .PP
38 The available actions are:
39
40 .TP
41 \fB-l\fR, \fB--list\fR
42 Print the list of known modules and their current logging levels to
43 stdout.
44
45 .TP
46 \fB-s\fR \fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB--set=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
47
48 Sets the logging level for \fImodule\fR in \fIfacility\fR to
49 \fIlevel\fR.  The \fImodule\fR may be any valid module name (as
50 displayed by the \fB--list\fR option) or the special name \fBANY\fR to
51 set the logging levels for all modules.  The \fIfacility\fR may be
52 \fBsyslog\fR or \fBconsole\fR to set the levels for logging to the
53 system log or to the console, respectively, or \fBANY\fR to set the
54 logging levels for both facilities.  If it is omitted,
55 \fIfacility\fR defaults to \fBANY\fR.  The \fIlevel\fR must be one of
56 \fBemer\fR, \fBerr\fR, \fBwarn\fR, or \fBdbg\fR, designating the
57 minimum severity of a message for it to be logged.  If it is omitted,
58 \fIlevel\fR defaults to \fBdbg\fR.
59
60 .SH OPTIONS
61 .TP
62 \fB\-h\fR, \fB\-\^\-help\fR
63 Prints a brief help message to the console and exits.
64
65
66 .SH "SEE ALSO"
67
68 .BR dpctl (8),
69 .BR secchan (8),
70 .BR controller (8)