]> git.proxmox.com Git - mirror_ovs.git/blame - lib/colors.man
tunnel: Bareudp Tunnel Support.
[mirror_ovs.git] / lib / colors.man
CommitLineData
e7019d99
QM
1.IP "\fB\-\-color\fR[\fB=\fR\fIwhen\fR]
2.
3Colorize the output (for some commands); \fIwhen\fR can be \fBnever\fR,
4\fBalways\fR, or \fBauto\fR (the default).
5.
6.RS
7.PP
8Only some commands support output coloring. Color names and default
9colors may change in future releases.
10.PP
11The environment variable \fBOVS_COLORS\fR can be used to specify user-defined
12colors and other attributes used to highlight various parts of the output. If
13set, its value is a colon-separated list of capabilities that defaults to
14\fBac:01;31:dr=34:le=31:pm=36:pr=35:sp=33:vl=32\fR. Supported capabilities were
15initially designed for coloring flows from \fBovs-ofctl dump-flows\fR
16\fIswitch\fR command, and they are as follows.
17.RS
18.TP
19\fBac=01;31\fR
20SGR substring for \fBactions=\fR keyword in a flow.
21The default is a bold red text foreground.
22.TP
23\fBdr=34\fR
24SGR substring for \fBdrop\fR keyword.
25The default is a dark blue text foreground.
26.TP
27\fBle=31\fR
28SGR substring for \fBlearn=\fR keyword in a flow.
29The default is a red text foreground.
30.TP
31\fBpm=36\fR
32SGR substring for flow match attribute names.
33The default is a cyan text foreground.
34.TP
35\fBpr=35\fR
36SGR substring for keywords in a flow that are followed by arguments inside
37parenthesis.
38The default is a magenta text foreground.
39.TP
40\fBsp=33\fR
41SGR substring for some special keywords in a flow, notably: \fBtable=\fR,
42\fBpriority=\fR, \fBload:\fR, \fBoutput:\fR, \fBmove:\fR, \fBgroup:\fR,
43\fBCONTROLLER:\fR, \fBset_field:\fR, \fBresubmit:\fR, \fBexit\fR.
44The default is a yellow text foreground.
45.TP
46\fBvl=32\fR
47SGR substring for a lone flow match attribute with no field name.
48The default is a green text foreground.
49.RE
50.PP
51See the Select Graphic Rendition (SGR) section in the documentation of the text
52terminal that is used for permitted values and their meaning as character
53attributes.
54.RE