Skip to content

Commit 1652d8a

Browse files
igsilyaigsilya
committed
support: Update man pages to v3.4.1.
Signed-off-by: Ilya Maximets <[email protected]>
1 parent 0f0aaee commit 1652d8a

File tree

119 files changed

+310
-313
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+310
-313
lines changed

‎support/dist-docs/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<html><head>
22
<meta charset="UTF-8"></head>
33
<link rel="stylesheet" type="text/css" href="style.css">
4-
<title>Open vSwitch 3.4.0 Documentation</title>
4+
<title>Open vSwitch 3.4.1 Documentation</title>
55
</head><body>
6-
<h1>Open vSwitch 3.4.0 Manpages</h1>
6+
<h1>Open vSwitch 3.4.1 Manpages</h1>
77
<table>
88
<tr><td>ovs-actions(7)</td><td><a href="ovs-actions.7.pdf">PDF</a>, <a href="ovs-actions.7.html">HTML</a>, <a href="ovs-actions.7.txt">plain text</a></td></tr>
99
<tr><td>ovs-appctl(8)</td><td><a href="ovs-appctl.8.pdf">PDF</a>, <a href="ovs-appctl.8.html">HTML</a>, <a href="ovs-appctl.8.txt">plain text</a></td></tr>

‎support/dist-docs/ovs-actions.7‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "OVS-ACTIONS" "7" "Aug 15, 2024" "3.4" "Open vSwitch"
30+
.TH "OVS-ACTIONS" "7" "Nov 16, 2024" "3.4" "Open vSwitch"
3131
.SH NAME
3232
ovs-actions \- OpenFlow actions and instructions with Open vSwitch extensions
3333
.SH INTRODUCTION

‎support/dist-docs/ovs-actions.7.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2274,5 +2274,5 @@
22742274
2016-2024, The Open vSwitch Development Community
22752275

22762276

2277-
3.4 Aug 15, 2024 <u>OVS-ACTIONS</u>(7)
2277+
3.4 Nov 16, 2024 <u>OVS-ACTIONS</u>(7)
22782278
</pre></body></html>

‎support/dist-docs/ovs-actions.7.pdf‎

216 Bytes
Binary file not shown.

‎support/dist-docs/ovs-actions.7.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2273,4 +2273,4 @@ COPYRIGHT
22732273
2016-2024, The Open vSwitch Development Community
22742274

22752275

2276-
3.4 Aug 15, 2024 OVS-ACTIONS(7)
2276+
3.4 Nov 16, 2024 OVS-ACTIONS(7)

‎support/dist-docs/ovs-appctl.8‎

Lines changed: 48 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "OVS-APPCTL" "8" "Aug 15, 2024" "3.4" "Open vSwitch"
30+
.TH "OVS-APPCTL" "8" "Nov 16, 2024" "3.4" "Open vSwitch"
3131
.SH NAME
3232
ovs-appctl \- utility for configuring running Open vSwitch daemons
3333
.SH SYNOPSIS
3434
.sp
3535
\fBovs\-appctl\fP
36-
[\fB\-\-target=\(ga\(ga<target> | \(ga\(ga\-t\fP <target>]
37-
[\fB\-\-timeout=\(ga\(ga<secs> | \(ga\(ga\-T\fP <secs>]
38-
[\fB\-\-format=\(ga\(ga<format> | \(ga\(ga\-f\fP <format>]
36+
[\fB\-\-target=\fP\fItarget\fP | \fB\-t\fP \fItarget\fP]
37+
[\fB\-\-timeout=\fP\fIsecs\fP | \fB\-T\fP \fIsecs\fP]
38+
[\fB\-\-format=\fP\fIformat\fP | \fB\-f\fP \fIformat\fP]
3939
[\fB\-\-pretty\fP]
40-
<command> [<arg>…]
40+
\fIcommand\fP [\fIarg\fP \fB\&...\fP]
4141
.sp
4242
\fBovs\-appctl \-\-help\fP
4343
.sp
@@ -59,11 +59,11 @@ command and prints the daemon’s response on standard output.
5959
In normal use only a single option is accepted:
6060
.INDENT 0.0
6161
.IP \(bu 2
62-
\fB\-t\fP <target> or \fB\-\-target\fP <target>
62+
\fB\-t\fP \fItarget\fP or \fB\-\-target=\fP\fItarget\fP
6363
.sp
6464
Tells \fBovs\-appctl\fP which daemon to contact.
6565
.sp
66-
If <target> begins with \fB/\fP it must name a Unix domain socket on
66+
If \fItarget\fP begins with \fB/\fP it must name a Unix domain socket on
6767
which an Open vSwitch daemon is listening for control channel
6868
connections. By default, each daemon listens on a Unix domain socket
6969
in the rundir (e.g. \fB/run\fP) named \fB<program>.<pid>.ctl\fP, where
@@ -73,33 +73,33 @@ example, if \fBovs\-vswitchd\fP has PID 123, it would listen on
7373
.sp
7474
Otherwise, \fBovs\-appctl\fP looks in the rundir for a pidfile, that is,
7575
a file whose contents are the process ID of a running process as a
76-
decimal number, named \fB<target>.pid\fP\&. (The \fB\-\-pidfile\fP option
76+
decimal number, named \fItarget\fP\fB\&.pid\fP\&. (The \fB\-\-pidfile\fP option
7777
makes an Open vSwitch daemon create a pidfile.) \fBovs\-appctl\fP reads
7878
the pidfile, then looks in the rundir for a Unix socket named
79-
\fB<target>.<pid>.ctl\fP, where <pid> is replaced by the process ID read
79+
\fItarget\fP\fB\&.<pid>.ctl\fP, where <pid> is replaced by the process ID read
8080
from the pidfile, and uses that file as if it had been specified
8181
directly as the target.
8282
.sp
83-
On Windows, <target> can be an absolute path to a file that contains a
83+
On Windows, \fItarget\fP can be an absolute path to a file that contains a
8484
localhost TCP port on which an Open vSwitch daemon is listening for
8585
control channel connections. By default, each daemon writes the TCP
8686
port on which it is listening for control connection into the file
87-
\fB<program>.ctl\fP located inside the rundir. If <target> is not an
87+
\fB<program>.ctl\fP located inside the rundir. If \fItarget\fP is not an
8888
absolute path, \fBovs\-appctl\fP looks in the rundir for a file named
89-
\fB<target>.ctl\fP\&. The default target is \fBovs\-vswitchd\fP\&.
89+
\fItarget\fP\fB\&.ctl\fP\&. The default \fItarget\fP is \fBovs\-vswitchd\fP\&.
9090
.IP \(bu 2
91-
\fB\-T <secs>\fP or \fB\-\-timeout=<secs>\fP
91+
\fB\-T\fP \fIsecs\fP or \fB\-\-timeout=\fP\fIsecs\fP
9292
.sp
93-
By default, or with a <secs> of \fB0\fP, \fBovs\-appctl\fP waits forever to
93+
By default, or with a \fIsecs\fP of \fB0\fP, \fBovs\-appctl\fP waits forever to
9494
connect to the daemon and receive a response. This option limits
95-
runtime to approximately <secs> seconds. If the timeout expires,
95+
runtime to approximately \fIsecs\fP seconds. If the timeout expires,
9696
\fBovs\-appctl\fP exits with a \fBSIGALRM\fP signal.
9797
.IP \(bu 2
98-
\fB\-f <format>\fP or \fB\-\-format=<format>\fP
98+
\fB\-f\fP \fIformat\fP or \fB\-\-format=\fP\fIformat\fP
9999
.sp
100100
Tells \fBovs\-appctl\fP which output format to use. By default, or with a
101-
<format> of \fBtext\fP, \fBovs\-appctl\fP will print plain\-text for humans.
102-
When <format> is \fBjson\fP, \fBovs\-appctl\fP will return a JSON document.
101+
\fIformat\fP of \fBtext\fP, \fBovs\-appctl\fP will print plain\-text for humans.
102+
When \fIformat\fP is \fBjson\fP, \fBovs\-appctl\fP will return a JSON document.
103103
When \fBjson\fP is requested, but a command has not implemented JSON
104104
output, the plain\-text output will be wrapped in a provisional JSON
105105
document with the following structure:
@@ -194,10 +194,10 @@ Lists the known logging modules and their current levels.
194194
.sp
195195
Lists logging pattern used for each destination.
196196
.IP \(bu 2
197-
\fBvlog/set\fP [<spec>]
197+
\fBvlog/set\fP [\fIspec\fP]
198198
.sp
199-
Sets logging levels. Without any <spec>, sets the log level for
200-
every module and destination to \fBdbg\fP\&. Otherwise, <spec> is a
199+
Sets logging levels. Without any \fIspec\fP, sets the log level for
200+
every module and destination to \fBdbg\fP\&. Otherwise, \fIspec\fP is a
201201
list of words separated by spaces or commas or colons, up to one from
202202
each category below:
203203
.INDENT 2.0
@@ -210,7 +210,7 @@ module.
210210
change to only to the system log, to the console, or to a file,
211211
respectively.
212212
.sp
213-
On Windows platform, \fBsyslog\fP is only useful if <target> was
213+
On Windows platform, \fBsyslog\fP is only useful if \fItarget\fP was
214214
started with the \fB\-\-syslog\-target\fP option (it has no effect
215215
otherwise).
216216
.IP \(bu 2
@@ -220,20 +220,20 @@ will be logged, and messages of lower severity will be filtered out.
220220
\fBoff\fP filters out all messages.
221221
.UNINDENT
222222
.sp
223-
Case is not significant within <spec>.
223+
Case is not significant within \fIspec\fP\&.
224224
.sp
225225
Regardless of the log levels set for \fBfile\fP, logging to a file
226226
will not take place unless the target application was invoked with the
227227
\fB\-\-log\-file\fP option.
228228
.sp
229229
For compatibility with older versions of OVS, \fBany\fP is accepted
230-
within <spec> but it has no effect.
230+
within \fIspec\fP but it has no effect.
231231
.IP \(bu 2
232-
\fBvlog/set PATTERN:<destination>:<pattern>\fP
232+
\fBvlog/set PATTERN:\fP\fIdestination\fP:\fIpattern\fP
233233
.sp
234-
Sets the log pattern for <destination> to <pattern>. Each time a
235-
message is logged to <destination>, <pattern> determines the
236-
message’s formatting. Most characters in <pattern> are copied
234+
Sets the log pattern for \fIdestination\fP to \fIpattern\fP\&. Each time a
235+
message is logged to \fIdestination\fP, \fIpattern\fP determines the
236+
message’s formatting. Most characters in \fIpattern\fP are copied
237237
literally to the log, but special escapes beginning with \fB%\fP are
238238
expanded as follows:
239239
.INDENT 2.0
@@ -253,29 +253,29 @@ the message.
253253
.IP \(bu 2
254254
\fB%d\fP
255255
.sp
256-
The current date and time in ISO 8601 format (YYYY\-MM\-DD HH:MM:SS).
256+
The current date and time in ISO 8601 format (\fBYYYY\-MM\-DD HH:MM:SS\fP).
257257
.IP \(bu 2
258-
\fB%d{<format>}\fP
258+
\fB%d{\fP\fIformat\fP\fB}\fP
259259
.sp
260-
The current date and time in the specified <format>, which takes
261-
the same format as the <template> argument to \fBstrftime(3)\fP\&. As
262-
an extension, any \fB#\fP characters in <format> will be replaced by
260+
The current date and time in the specified \fIformat\fP, which takes
261+
the same format as the \fBtemplate\fP argument to \fBstrftime(3)\fP\&. As
262+
an extension, any \fB#\fP characters in \fIformat\fP will be replaced by
263263
fractional seconds, e.g. use \fB%H:%M:%S.###\fP for the time to the
264264
nearest millisecond. Sub\-second times are only approximate and
265265
currently decimal places after the third will always be reported
266266
as zero.
267267
.IP \(bu 2
268268
\fB%D\fP
269269
.sp
270-
The current UTC date and time in ISO 8601 format (YYYY\-MM\-DD
271-
HH:MM:SS).
270+
The current UTC date and time in ISO 8601 format
271+
(\fBYYYY\-MM\-DD HH:MM:SS\fP).
272272
.IP \(bu 2
273-
\fB%D{<format>}\fP
273+
\fB%D{\fP\fIformat\fP\fB}\fP
274274
.sp
275-
The current UTC date and time in the specified <format>, which
276-
takes the same format as the <template> argument to
277-
\fBstrftime\(ga\(ga(3). Supports the same extension for sub\-second
278-
resolution as \(ga\(ga%d{...}\fP\&.
275+
The current UTC date and time in the specified \fIformat\fP, which
276+
takes the same format as the \fBtemplate\fP argument to
277+
\fBstrftime(3)\fP\&. Supports the same extension for sub\-second
278+
resolution as \fB%d{...}\fP\&.
279279
.IP \(bu 2
280280
\fB%E\fP
281281
.sp
@@ -340,23 +340,24 @@ justification is the default.
340340
Pad the field to the field width with \fB0\fP characters. Padding
341341
with spaces is the default.
342342
.IP \(bu 2
343-
<width>
343+
\fIwidth\fP
344344
.sp
345345
A number specifies the minimum field width. If the escape expands
346-
to fewer characters than <width> then it is padded to fill the
347-
field width. (A field wider than <width> is not truncated to
346+
to fewer characters than \fIwidth\fP then it is padded to fill the
347+
field width. (A field wider than \fIwidth\fP is not truncated to
348348
fit.)
349349
.UNINDENT
350350
.sp
351-
The default pattern for console and file output is \fB%D{%Y\-%m\-%dT
352-
%H:%M:%SZ}|%05N|%c|%p|%m\fP; for syslog output, \fB%05N|%c|%p|%m\fP\&.
351+
The default pattern for console and file output is
352+
\fB%D{%Y\-%m\-%dT %H:%M:%SZ}|%05N|%c|%p|%m\fP; for syslog output,
353+
\fB%05N|%c|%p|%m\fP\&.
353354
.sp
354355
Daemons written in Python (e.g. \fBovs\-monitor\-ipsec\fP) do not allow
355356
control over the log pattern.
356357
.IP \(bu 2
357-
\fBvlog/set FACILITY:<facility>\fP
358+
\fBvlog/set FACILITY:\fP\fIfacility\fP
358359
.sp
359-
Sets the RFC5424 facility of the log message. <facility> can be one
360+
Sets the RFC5424 facility of the log message. \fIfacility\fP can be one
360361
of \fBkern\fP, \fBuser\fP, \fBmail\fP, \fBdaemon\fP, \fBauth\fP, \fBsyslog\fP,
361362
\fBlpr\fP, \fBnews\fP, \fBuucp\fP, \fBclock\fP, \fBftp\fP, \fBntp\fP, \fBaudit\fP,
362363
\fBalert\fP, \fBclock2\fP, \fBlocal0\fP, \fBlocal1\fP, \fBlocal2\fP,

0 commit comments

Comments
 (0)