man: Fix spelling issues, wording and wrong page references in nitsi.1
[nitsi.git] / man / nitsi.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <refentry id="nitsi">
6         <refentryinfo>
7                 <title>nitsi</title>
8                 <productname>nitsi</productname>
9
10                 <authorgroup>
11                         <author>
12                                 <contrib>Developer</contrib>
13                                 <firstname>Jonatan</firstname>
14                                 <surname>Schlag</surname>
15                                 <email>jonatan.schlag@ipfire.org</email>
16                         </author>
17                 </authorgroup>
18         </refentryinfo>
19
20         <refmeta>
21                 <refentrytitle>nitsi</refentrytitle>
22                 <manvolnum>1</manvolnum>
23         </refmeta>
24
25         <refnamediv>
26                 <refname>nitsi</refname>
27                 <refpurpose>Networking Integration Test Suite for IPFire</refpurpose>
28         </refnamediv>
29
30         <refsynopsisdiv>
31                 <cmdsynopsis>
32                         <command>nitsi</command>
33                         <arg choice="opt" rep="repeat">OPTIONS</arg>
34                         <arg choice="plain">COMMAND</arg>
35                 </cmdsynopsis>
36         </refsynopsisdiv>
37
38         <refsect1>
39                 <title>Description</title>
40
41                 <para>
42                         <command>nitsi</command> is a simple and extensible
43                         suite for running integration tests for the network
44                         code of IPFire. It is written in pure Python.
45                 </para>
46         </refsect1>
47
48         <refsect1>
49                 <title>Options</title>
50
51                 <para>
52                         The following options are understood:
53                 </para>
54
55                 <variablelist>
56                         <varlistentry>
57                                 <term>
58                                         <option>-d DIRECTORY</option>
59                                 </term>
60                                 <term>
61                                         <option>--directory DIRECTORY</option>
62                                 </term>
63
64                                 <listitem>
65                                         <para>
66                                                 The directory where all files of a test are located.
67                                                 It should contain at least a setting file and a recipe file.
68                                         </para>
69
70                                         <para>
71                                                 For further details of the setting file layout and the recipe file layout,
72                                                 please consult the
73                                                 <citerefentry>
74                                                         <refentrytitle>nitsi.settings</refentrytitle>
75                                                         <manvolnum>5</manvolnum>
76                                                 </citerefentry>
77                                                 and
78                                                 <citerefentry>
79                                                         <refentrytitle>nitsi.recipe</refentrytitle>
80                                                         <manvolnum>5</manvolnum>
81                                                 </citerefentry>
82                                                 manual pages.
83                                         </para>
84                                 </listitem>
85                         </varlistentry>
86
87                         <varlistentry>
88                                 <term>
89                                         <option>-h</option>
90                                 </term>
91                                 <term>
92                                         <option>--help</option>
93                                 </term>
94
95                                 <listitem>
96                                         <para>
97                                                 Shows the help message provided by the program and exit.
98                                         </para>
99                                 </listitem>
100                         </varlistentry>
101                 </variablelist>
102         </refsect1>
103
104         <refsect1>
105                 <title>Bugs</title>
106
107                 <para>
108                         Please report all bugs to the official bugtracker at
109                         https://bugzilla.ipfire.org/.
110                 </para>
111         </refsect1>
112
113         <refsect1>
114                 <title>See Also</title>
115
116                 <para>
117                         <citerefentry>
118                                 <refentrytitle>nitsi.settings</refentrytitle>
119                                 <manvolnum>5</manvolnum>
120                         </citerefentry>
121                         <citerefentry>
122                                 <refentrytitle>nitsi.recipe</refentrytitle>
123                                 <manvolnum>5</manvolnum>
124                         </citerefentry>
125                 </para>
126         </refsect1>
127 </refentry>