diff options
Diffstat (limited to 'doc/src/test.xml')
| -rw-r--r-- | doc/src/test.xml | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/doc/src/test.xml b/doc/src/test.xml new file mode 100644 index 0000000..2c6c6d5 --- /dev/null +++ b/doc/src/test.xml @@ -0,0 +1,131 @@ +<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> + </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 <message number></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 see 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> + </variablelist> + </para> + </refsect1> + +</refentry> |