Skip to content

Commit

Permalink
Merge pull request #65 from ovn-org/dist-docs-main
Browse files Browse the repository at this point in the history 
Pulling dist-docs from OVN main
  • Loading branch information
@putnopvut
putnopvut committed Feb 9, 2024
2 parents 03d51ba + bec41c7 commit 0f404d2
Show file tree
Hide file tree
Showing 69 changed files with 13,580 additions and 11,685 deletions.
4 changes: 2 additions & 2 deletions src/static/support/dist-docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<html><head>
<meta charset="UTF-8"></head>
<link rel="stylesheet" type="text/css" href="style.css">
<title>Open vSwitch 22.12.90 Documentation</title>
<title>Open vSwitch 24.03.90 Documentation</title>
</head><body>
<h1>Open vSwitch 22.12.90 Manpages</h1>
<h1>Open vSwitch 24.03.90 Manpages</h1>
<table>
<tr><td>ovn-appctl(8)</td><td><a href="ovn-appctl.8.pdf">PDF</a>, <a href="ovn-appctl.8.html">HTML</a>, <a href="ovn-appctl.8.txt">plain text</a></td></tr>
<tr><td>ovn-architecture(7)</td><td><a href="ovn-architecture.7.pdf">PDF</a>, <a href="ovn-architecture.7.html">HTML</a>, <a href="ovn-architecture.7.txt">plain text</a></td></tr>
Expand Down
2 changes: 1 addition & 1 deletion src/static/support/dist-docs/ovn-appctl.8
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" p
.\" -*- nroff -*-
.TH "ovn-appctl" 8 "ovn-appctl" "OVN 22\[char46]12\[char46]90" "OVN Manual"
.TH "ovn-appctl" 8 "ovn-appctl" "OVN 24\[char46]03\[char46]90" "OVN Manual"
.fp 5 L CR \\" Make fixed-width font available as \\fL.
.de TQ
. br
Expand Down
124 changes: 60 additions & 64 deletions src/static/support/dist-docs/ovn-appctl.8.html
View file

Large diffs are not rendered by default.

Binary file modified src/static/support/dist-docs/ovn-appctl.8.pdf
View file
Binary file not shown.
120 changes: 58 additions & 62 deletions src/static/support/dist-docs/ovn-appctl.8.txt
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
ovn-appctl(8) OVN Manual ovn-appctl(8)



NAME
ovn-appctl - utility for configuring running OVN daemons

Expand All @@ -14,13 +12,13 @@ SYNOPSIS
ovn-appctl -version

DESCRIPTION
OVN daemons accept certain commands at runtime to control their behav‐
OVN daemons accept certain commands at runtime to control their behav‐
ior and query their settings. Every daemon accepts a common set of com‐
mands documented under COMMON COMMANDS below. Some daemons support
additional commands documented in their own manpages.
mands documented under COMMON COMMANDS below. Some daemons support ad‐
ditional commands documented in their own manpages.

The ovn-appctl program provides a simple way to invoke these commands.
The command to be sent is specified on ovn-appctl’s command line as
The command to be sent is specified on ovn-appctl�’s command line as
non-option arguments. ovn-appctl sends the command and prints the dae‐
mon’s response on standard output.

Expand All @@ -33,8 +31,8 @@ COMMAND COMMANDS
General Commands
These commands display daemon-specific commands and the running ver‐
sion. Note that these commands are different from the -help and -ver‐
sion options that return information about the ovn-appctl utility
itself.
sion options that return information about the ovn-appctl utility it‐
self.

list-commands
Lists the commands supported by the target.
Expand All @@ -60,16 +58,16 @@ COMMAND COMMANDS
warn A low-level operation failed, but higher-level subsystems
may be able to recover.

info Information that may be useful in retrospect when inves‐
info Information that may be useful in retrospect when inves‐
tigating a problem.

dbg Information useful only to someone with intricate knowl‐
edge of the system, or that would commonly cause too-
voluminous log output. Log messages at this level are not
dbg Information useful only to someone with intricate knowl‐
edge of the system, or that would commonly cause too-vo‐
luminous log output. Log messages at this level are not
logged by default.

Every OVN daemon supports the following commands for examining and
adjusting log levels.
Every OVN daemon supports the following commands for examining and ad‐
justing log levels.

vlog/list
Lists the known logging modules and their current levels.
Expand All @@ -83,22 +81,22 @@ COMMAND COMMANDS
is a list of words separated by spaces or commas or
colons, up to one from each category below:

· A valid module name, as displayed by the vlog/list
command on ovn-appctl(8), limits the log level
• A valid module name, as displayed by the vlog/list
command on ovn-appctl(8), limits the log level
change to the specified module.

· syslog, console, or file, to limit the log level
change to only to the system log, to the console,
• syslog, console, or file, to limit the log level
change to only to the system log, to the console,
or to a file, respectively.

On Windows platform, syslog is accepted as a word
and is only useful if the target was started with
On Windows platform, syslog is accepted as a word
and is only useful if the target was started with
the --syslog-target option (the word has no effect
otherwise).

· off, emer, err, warn, info, or dbg, to control the
log level. Messages of the given severity or
higher will be logged, and messages of lower
• off, emer, err, warn, info, or dbg, to control the
log level. Messages of the given severity or
higher will be logged, and messages of lower
severity will be filtered out. off filters out all
messages.

Expand All @@ -111,19 +109,19 @@ COMMAND COMMANDS
tern are copied literally to the log, but special escapes
beginning with % are expanded as follows:

· %A : The name of the application logging the mes‐
• %A : The name of the application logging the mes‐
sage, e.g. ovn-controller.

· %B : The RFC5424 syslog PRI of the message.
• %B : The RFC5424 syslog PRI of the message.

· %c : The name of the module (as shown by ovn-
appctl -list) logging the message.
• %c : The name of the module (as shown by ovn-ap‐
pctl -list) logging the message.

· %d : The current date and time in ISO 8601 format
• %d : The current date and time in ISO 8601 format
(YYYY-MM-DD HH:MM:SS).

· %d{format} : The current date and time in the
specified format, which takes the same format as
• %d{format} : The current date and time in the
specified format, which takes the same format as
the template argument to strftime(3). As an exten‐
sion, any # characters in format will be replaced
by fractional seconds, e.g. use %H:%M:%S.### for
Expand All @@ -132,64 +130,64 @@ COMMAND COMMANDS
places after the third will always be reported as
zero.

· %D : The current UTC date and time in ISO 8601
• %D : The current UTC date and time in ISO 8601
format (YYYY-MM-DD HH:MM:SS).

· %D{format} : The current UTC date and time in the
• %D{format} : The current UTC date and time in the
specified format, which takes the same format as
the template argument to strftime(3). Supports the
same extension for sub-second resolution as
same extension for sub-second resolution as
%d{...}.

· %E : The hostname of the node running the applica‐
• %E : The hostname of the node running the applica‐
tion.

· %m : The message being logged.
• %m : The message being logged.

· %N : A serial number for this message within this
• %N : A serial number for this message within this
run of the program, as a decimal number. The first
message a program logs has serial number 1, the
message a program logs has serial number 1, the
second one has serial number 2, and so on.

· %n : A new-line.
• %n : A new-line.

· %p : The level at which the message is logged,
• %p : The level at which the message is logged,
e.g. DBG.

· %P : The program’s process ID (pid), as a decimal
• %P : The program’s process ID (pid), as a decimal
number.

· %r : The number of milliseconds elapsed from the
start of the application to the time the message
• %r : The number of milliseconds elapsed from the
start of the application to the time the message
was logged.

· %t : The subprogram name, that is, an identifying
name for the process or thread that emitted the
log message, such as monitor for the process used
for -monitor or main for the primary process or
• %t : The subprogram name, that is, an identifying
name for the process or thread that emitted the
log message, such as monitor for the process used
for -monitor or main for the primary process or
thread in a program.

· %T : The subprogram name enclosed in parentheses,
e.g. (monitor), or the empty string for the pri‐
• %T : The subprogram name enclosed in parentheses,
e.g. (monitor), or the empty string for the pri‐
mary process or thread in a program.

· %% : A literal %.
• %% : A literal %.

A few options may appear between the % and the format
A few options may appear between the % and the format
specifier character, in this order:

· - : Left justify the escape’s expansion within its
• - : Left justify the escape’s expansion within its
field width. Right justification is the default.

· - : Pad the field to the field width with 0s. Pad‐
ding with spaces is the default.
• - : Pad the field to the field width with 0s.
Padding with spaces is the default.

width A number specifies the minimum field width. If the
escape expands to fewer characters than width then it is
padded to fill the field width. (A field wider than width
is not truncated to fit.)

The default pattern for console and file output is
The default pattern for console and file output is
%D{%Y-%m-%dT %H:%M:%SZ}|%05N|%c|%p|%m; for syslog output,
%05N|%c|%p|%m.

Expand All @@ -201,16 +199,16 @@ COMMAND COMMANDS
local7.

vlog/close
Causes the daemon to close its log file, if it is open.
Causes the daemon to close its log file, if it is open.
(Use vlog/reopen to reopen it later.)

vlog/reopen
Causes the daemon to close its log file, if it is open,
and then reopen it. (This is useful after rotating log
Causes the daemon to close its log file, if it is open,
and then reopen it. (This is useful after rotating log
files, to cause a new log file to be used.)

This has no effect if the target application was not
invoked with the --log-file option.
This has no effect if the target application was not in‐
voked with the --log-file option.

OPTIONS
-h
Expand All @@ -221,6 +219,4 @@ OPTIONS
--version
Prints version information to the console.



OVN 22.12.90 ovn-appctl ovn-appctl(8)
OVN 24.03.90 ovn-appctl ovn-appctl(8)
Loading

0 comments on commit 0f404d2

Please sign in to comment.