2 <!DOCTYPE refentry PUBLIC
"-//OASIS/DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5 <refentry id=
"nitsi.setting">
7 <title>nitsi.settings
</title>
8 <productname>nitsi.settings
</productname>
12 <contrib>Developer
</contrib>
13 <firstname>Jonatan
</firstname>
14 <surname>Schlag
</surname>
15 <email>jonatan.schlag@ipfire.org
</email>
21 <refentrytitle>nitsi.settings
</refentrytitle>
22 <manvolnum>5</manvolnum>
26 <refname>nitsi.settings
</refname>
27 <refpurpose>Settings file for a NITSI test
</refpurpose>
32 <title>Description
</title>
35 The
<filename>settings
</filename> file is the main configuration file
36 of a
<command>nitsi
</command> test.
37 It specifies runtime configuration parameters for the test
38 and defines the virtual environment to be used.
42 The syntax of the configuration file is based on the INI configuration
44 Lines starting with hash (#) or semi-colon (;) are comments.
49 <title>DEFAULT configuration
</title>
52 The following options can be configured in the [DEFAULT] section:
63 This option will configure the name of the test
64 and should be in human-readable format.
71 <option>Description
</option>
76 A short short description of the test to explain
77 what it is trying to test and what results are expected when
85 <option>Copy_from
</option>
90 Lists files or directories which should be copied into
92 The paths are relative to the path of the test directory.
99 <option>Copy_to
</option>
104 The path to which the files should be copied. For example /root.
113 <title>VIRTUAL_ENVIRONMENT Configuration
</title>
116 The following options can be configured in the [VIRTUAL_ENVIRONMENT] section:
122 <option>Name
</option>
127 The name of the virtual environment to use.
134 <option>path
</option>
139 The path of the virtual environment relative to
140 the path of the test directory.
148 <title>Example
</title>
153 <member>[DEFAULT]
</member>
154 <member>Name = Hello World
</member>
155 <member>Description = This is a short description.
</member>
156 <member>Copy_from =
</member>
157 <member>Copy_to = /root/
</member>
158 <member>[VIRTUAL_ENVIRONMENT]
</member>
159 <member>Name = basic
</member>
160 <member>path = ../virtual-environment/basic
</member>
169 Please report all bugs to the official bugtracker at
170 http://bugzilla.ipfire.org/.
175 <title>See Also
</title>
179 <refentrytitle>nitsi
</refentrytitle>
180 <manvolnum>1</manvolnum>