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 .TP
  61 \fB-s PATTERN:\fIfacility\fB:\fIpattern\fR, \fB--set=PATTERN:\fIfacility\fB:\fIpattern\fR
  62
  63 Sets the log pattern for \fIfacility\fR to \fIpattern\fR.  Each time a
  64 message is logged to \fIfacility\fR, \fIpattern\fR determines the
  65 message's formatting.  Most characters in \fIpattern\fR are copied
  66 literally to the log, but special escapes beginning with \fB%\fR are
  67 expanded as follows:
  68
  69 .RS
  70 .TP
  71 \fB%A\fR
  72 The name of the application logging the message, e.g. \fBsecchan\fR.
  73
  74 .TP
  75 \fB%c\fR
  76 The name of the module (as shown by \fBvlogconf --list\fR) logging
  77 the message.
  78
  79 .TP
  80 \fB%d\fR
  81 The current date and time in ISO 8601 format (YYYY-MM-DD HH:MM:SS).
  82
  83 .TP
  84 \fB%d{\fIformat\fB}\fR
  85 The current date and time in the specified \fIformat\fR, which takes
  86 the same format as the \fItemplate\fR argument to \fBstrftime\fR(3).
  87
  88 .TP
  89 \fB%m\fR
  90 The message being logged.
  91
  92 .TP
  93 \fB%N\fR
  94 A serial number for this message within this run of the program, as a
  95 decimal number.  The first message a program logs has serial number 1,
  96 the second one has serial number 2, and so on.
  97
  98 .TP
  99 \fB%n\fR
 100 A new-line.
 101
 102 .TP
 103 \fB%p\fR
 104 The level at which the message is logged, e.g. \fBDBG\fR.
 105
 106 .TP
 107 \fB%P\fR
 108 The program's process ID (pid), as a decimal number.
 109
 110 .TP
 111 \fB%r\fR
 112 The number of milliseconds elapsed from the start of the application
 113 to the time the message was logged.
 114
 115 .TP
 116 \fB%%\fR
 117 A literal \fB%\fR.
 118 .RE
 119
 120 .IP
 121 A few options may appear between the \fB%\fR and the format specifier
 122 character, in this order:
 123
 124 .RS
 125 .TP
 126 \fB-\fR
 127 Left justify the escape's expansion within its field width.  Right
 128 justification is the default.
 129
 130 .TP
 131 \fB0\fR
 132 Pad the field to the field width with \fB0\fRs.  Padding with spaces
 133 is the default.
 134
 135 .TP
 136 \fIwidth\fR
 137 A number specifies the minimum field width.  If the escape expands to
 138 fewer characters than \fIwidth\fR then it is padded to fill the field
 139 width.  (A field wider than \fIwidth\fR is not truncated to fit.)
 140 .RE
 141
 142 .IP
 143 The default pattern for console output is \fB%d{%b %d
 144 %H:%M:%S}|%05N|%c|%p|%m\fR; for syslog output, \fB%05N|%c|%p|%m\fR.
 145
 146 .SH OPTIONS
 147 .TP
 148 \fB\-h\fR, \fB\-\^\-help\fR
 149 Prints a brief help message to the console and exits.
 150
 151
 152 .SH "SEE ALSO"
 153
 154 .BR dpctl (8),
 155 .BR secchan (8),
 156 .BR controller (8)