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, extensible, Integration Test Suite
  43                                 for the Network code of IPfire written in Python.
  44                 </para>
  45         </refsect1>
  46
  47         <refsect1>
  48                 <title>Options</title>
  49
  50                 <para>
  51                         The following options are understood:
  52                 </para>
  53
  54                 <variablelist>
  55                         <varlistentry>
  56                                 <term>
  57                                         <option>-d DIRECTORY</option>
  58                                 </term>
  59                                 <term>
  60                                         <option>--directory DIRECTORY</option>
  61                                 </term>
  62
  63                                 <listitem>
  64                                         <para>
  65                                                 Is the directory where all files of a test are located.
  66                                                 So this dir should contain at least a setting file and a recipe file
  67                                         </para>
  68
  69                                         <para>
  70                                                 For further details of the setting file layout and the recipe file layout, please consult the
  71                                                 <citerefentry>
  72                                                         <refentrytitle>nitsi.setting</refentrytitle>
  73                                                         <manvolnum>5</manvolnum>
  74                                                 </citerefentry>
  75                                                 <citerefentry>
  76                                                         <refentrytitle>nitsi.recipe</refentrytitle>
  77                                                         <manvolnum>5</manvolnum>
  78                                                 </citerefentry>
  79                                                 manual page.
  80                                         </para>
  81                                 </listitem>
  82                         </varlistentry>
  83
  84                         <varlistentry>
  85                                 <term>
  86                                         <option>-h</option>
  87                                 </term>
  88                                 <term>
  89                                         <option>--help</option>
  90                                 </term>
  91
  92                                 <listitem>
  93                                         <para>
  94                                                 Shows the help message provided by the program and exit.
  95                                         </para>
  96                                 </listitem>
  97                         </varlistentry>
  98                 </variablelist>
  99         </refsect1>
 100
 101         <refsect1>
 102                 <title>Bugs</title>
 103
 104                 <para>
 105                         Please report all bugs to the official bugtracker at
 106                         http://bugzilla.ipfire.org/.
 107                 </para>
 108         </refsect1>
 109
 110         <refsect1>
 111                 <title>See Also</title>
 112
 113                 <para>
 114                         <citerefentry>
 115                                 <refentrytitle>nitsi.setting</refentrytitle>
 116                                 <manvolnum>5</manvolnum>
 117                         </citerefentry>
 118                         <citerefentry>
 119                                 <refentrytitle>nitsi.recipe</refentrytitle>
 120                                 <manvolnum>5</manvolnum>
 121                         </citerefentry>
 122                 </para>
 123         </refsect1>
 124 </refentry>