From 3fe1cfae7ea2ad7d83e0b0f70de62e60a4e9d3b2 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Thu, 13 Mar 2008 15:17:02 -0700 Subject: [PATCH] Rewrite vlogconf manpage to reflect current implementation. --- man/man8/vlogconf.8 | 57 +++++++++++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 17 deletions(-) diff --git a/man/man8/vlogconf.8 b/man/man8/vlogconf.8 index 720a68cd..46842fe8 100644 --- a/man/man8/vlogconf.8 +++ b/man/man8/vlogconf.8 @@ -1,41 +1,64 @@ -.TH vlogconf 8 "December 2007" "OpenFlow" "OpenFlow Manual" +.TH vlogconf 8 "March 2008" "OpenFlow" "OpenFlow Manual" .SH NAME vlogconf \- configuration utility for OpenFlow logging in userspace .SH SYNOPSIS -\fBvlogconf\fR [OPTIONS] +\fBvlogconf\fR [\fB-h\fR | \fB--help\fR] [TARGET...] [ACTION...] +.sp 1 +The available TARGET options are: .br -\fBvlogconf\fR \fIMODULE\fR \fIFACILITY\fR \fILEVEL\fR +[\fB-a\fR | \fB--all\fR] [\fB-t\fR PID | \fB--target=\fIPID\fR] +.sp 1 +The available ACTION options are: +.br +[\fB-l\fR | \fB--list\fR] [\fB-s\fR +\fIMODULE\fB:\fIFACILITY\fB:\fILEVEL\fR | +\fB--set=\fIMODULE\fB:\fIFACILITY\fB:\fILEVEL\fR] .SH DESCRIPTION The \fBvlogconf\fR program configures the logging system used by the OpenFlow userspace programs. The logging configuration may be modified while OpenFlow programs are running. -\fIMODULE\fR \- The module for which the logging level is being -modified. To see a list of supported modules, rerun \fBvlogconf\fR with -the \fI\-print\fR option. +\fBvlogconf\fR applies one or more actions to each of one or more +target processes. Targets may be specified as: -\fIFACILITY\fR \- The method of logging. Valid values are \fBSYSLOG\fR and -\fBCONSOLE\fR. +.TP +\fB-a\fR, \fB--all\fR +All running processes that \fBvlogconf\fR can control. -\fILEVEL\fR \- The level with which the module should be logged. Valid -values are \fBDBG\fR (debug), \fBWARN\fR (warning), \fBERR\fR (error), -and \fBEMER\fR (emergency). +.TP +\fB-t \fIPID\fR, \fB--target=\fIPID\fR +The process with the specified \fIPID\fR. \fIPID\fR may also specify +an absolute path (beginning with `/') to the Unix domain socket for a +\fBvlogconf\fR-controllable process. + +.PP +The available actions are: -.SH OPTIONS .TP -\fB\-p\fR, \fB\-\^\-print\fR -Prints the current logging configuration. +\fB-l\fR, \fB--list\fR +Print the list of known modules and their current logging levels to +stdout. .TP -\fB\-a\fR, \fB\-\^\-all\fR \fIlevel\fR -Sets all modules and facilities to the specified level. +\fB-s\fR \fIMODULE\fB:\fIFACILITY\fB:\fILEVEL\fR, \fB--set=\fIMODULE\fB:\fIFACILITY\fB:\fILEVEL\fR + +Sets the logging level for \fIMODULE\fR in \fIFACILITY\fR to +\fILEVEL\fR. \fIMODULE\fR may be any valid module name (as displayed +by the \fB--list\fR option) or the special name \fBANY\fR to set all +modules logging level. \fIFACILITY\fR may be \fBsyslog\fR or +\fBconsole\fR to set the levels for logging to the system log or to +the console, respectively, or \fBANY\fR to set the logging levels for +both modules. \fILEVEL\fR must be one of \fBemer\fR, \fBerr\fR, +\fBwarn\fR, or \fBdbg\fR, designating the minimum severity of a +message for it to be logged. +.SH OPTIONS .TP \fB\-h\fR, \fB\-\^\-help\fR -Prints a brief help message to the console. +Prints a brief help message to the console and exits. .SH "SEE ALSO" -- 2.30.2