doc/src/test.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

<refentry>

	<refentryinfo>
		<title>test</title>
	</refentryinfo>

	<refmeta>
		<refentrytitle>test</refentrytitle>
		<manvolnum>1</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>test</refname>
		<refpurpose>message generator</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>test</command>
<group choice="opt"><arg>-b</arg><replaceable>seconds</replaceable></group>
<group choice="opt"><arg>-i</arg><replaceable>number</replaceable></group>
<group choice="opt"><arg>-n</arg><replaceable>number</replaceable></group>
<group choice="opt"><arg>-p</arg><replaceable>pri</replaceable></group>
<group choice="opt"><arg>-s</arg><replaceable>seconds</replaceable></group>
<group choice="opt"><arg>-t</arg><replaceable>tag</replaceable></group>
<group choice="opt"><arg>-x</arg><replaceable>prefix</replaceable></group>
		</cmdsynopsis>
	</refsynopsisdiv>

	<refsect1>
		<title>Description</title>
		<para>
The <command>test</command> utility generates bursts of test messages.
Each message has the following format:
<screen>
test message &lt;message number&gt;</screen>
		</para>
	</refsect1>

	<refsect1>
		<title>Options</title>
		<para>
			<variablelist>
				<varlistentry>
					<term>
<option>-b</option><replaceable>seconds</replaceable>
					</term>
					<listitem>
						<para>
Duration of the burst in seconds.
Default is 1.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-i</option><replaceable>number</replaceable>
					</term>
					<listitem>
						<para>
The maximum number of identical messages.
This feature is useful to test coalescer.
The implementation is simple but explanation is a bit difficult,
just look at issued messages when this number is 3, for example:
<screen>
test message 1
test message 2
test message 2
test message 3
test message 3
test message 3
test message 4
test message 5
test message 5
test message 6
test message 6
test message 6
...</screen>
Default is 1.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-n</option><replaceable>number</replaceable>
					</term>
					<listitem>
						<para>
The number of bursts.
Default is 1.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-p</option><replaceable>pri</replaceable>
					</term>
					<listitem>
						<para>
The priority of messages. It may be specified numerically or as a
<quote>facility.level</quote> pair.
For example, <option>-p local3.info</option>.
The default is <quote>user.notice</quote>.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-s</option><replaceable>seconds</replaceable>
					</term>
					<listitem>
						<para>
Pause between bursts in seconds.
Default is 1.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-t</option><replaceable>tag</replaceable>
					</term>
					<listitem>
						<para>
Mark every line in the log with the specified tag.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-x</option><replaceable>prefix</replaceable>
					</term>
					<listitem>
						<para>
Prefix for the test message.
						</para>
					</listitem>
				</varlistentry>
			</variablelist>
		</para>
	</refsect1>

</refentry>