/
j4status-nl.conf.xml
214 lines (188 loc) · 8.43 KB
/
j4status-nl.conf.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % config SYSTEM "config.ent">
%config;
]>
<!--
j4status - Status line generator
Copyright © 2012-2018 Quentin "Sardem FF7" Glidic
This file is part of j4status.
j4status is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
j4status is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with j4status. If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="j4status-nl.conf">
<refentryinfo>
<title>&PACKAGE_NAME; Manual</title>
<productname>&PACKAGE_NAME;</productname>
<productnumber>&PACKAGE_VERSION;</productnumber>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Quentin</firstname>
<surname>Glidic</surname>
<email>sardemff7@j4tools.org</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>j4status-nl.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>j4status-nl.conf</refname>
<refpurpose>j4status Netlink plugin configuration</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para>
Configuration for the Netlink plugin
</para>
<para>
The Netlink plugin use the main j4status configuration file (see <citerefentry><refentrytitle>j4status.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
</para>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para>
It controls the Netlink plugin behavior.
</para>
</refsect1>
<refsect1 id="sections">
<title>Sections</title>
<refsect2 id="section-nl">
<title>Section <varname>[Netlink]</varname></title>
<variablelist>
<varlistentry>
<term>
<varname>Interfaces=</varname>
(<type>list of interfaces names</type>, defaults to <literal>empty</literal>)
</term>
<listitem>
<para>The list of interfaces the plugin will monitor.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="section-nl-formats">
<title>Section <varname>[Netlink Formats]</varname></title>
<variablelist>
<varlistentry>
<term>
<varname>Addresses=</varname>
(An <type>enumeration</type>:
<simplelist type='inline'>
<member><literal>"IPv4"</literal></member>
<member><literal>"IPv6"</literal></member>
<member><literal>"All"</literal></member>
</simplelist>,
defaults to <literal>"All"</literal>)
</term>
<listitem>
<para>Which addresses to display.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<varname>Up=</varname>
(<type>format string</type>, defaults to <literal>"${addresses}"</literal>)
</term>
<listitem>
<para>This format is used for all non-WiFi active interfaces.</para>
<para><replaceable>reference</replaceable> can be:</para>
<variablelist>
<varlistentry>
<term><literal>addresses</literal></term>
<listitem>
<para>The addresses of the interface.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<varname>Down=</varname>
(<type>format string</type>, defaults to <literal>"Down"</literal>)
</term>
<listitem>
<para>This format is used for non-WiFi inactive interfaces.</para>
<para>No <replaceable>reference</replaceable> for this format.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<varname>UpWiFi=</varname>
(<type>format string</type>, defaults to <literal>"${addresses} (${strength}${strength:+% }${ssid/^.+$/at \0, }${bitrate:+${bitrate(p)}b/s})"</literal>)
</term>
<listitem>
<para>This format is used for active WiFi interfaces.</para>
<para><replaceable>reference</replaceable> can be:</para>
<variablelist>
<varlistentry>
<term><literal>addresses</literal></term>
<listitem>
<para>The addresses of the interface.</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><literal>strength</literal></term>
<listitem>
<para>The strength of the signal (percentage).</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><literal>ssid</literal></term>
<listitem>
<para>The SSID.</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><literal>bitrate</literal></term>
<listitem>
<para>The bitrate of the connection (with full unit).</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<varname>DownWiFi=</varname>
(<type>format string</type>, defaults to <literal>"Down${aps/^.+$/ (\0 APs)}"</literal>)
</term>
<listitem>
<para>This format is used for inactive WiFi interfaces.</para>
<para><replaceable>reference</replaceable> can be:</para>
<variablelist>
<varlistentry>
<term><literal>aps</literal></term>
<listitem>
<para>The numbre of available access points.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 id="see-also">
<title>See Also</title>
<para>
<citerefentry><refentrytitle>j4status.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>