root/docs/executable/noitd.xml

Revision 23dea7e00df87480acb58bb3398283c2bb227949, 4.2 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 3 years ago)

pull docs into master

  • Property mode set to 100644
Line 
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
2   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
3 [
4   <!ENTITY % magic.fixup SYSTEM "http://labs.omniti.com/docbook/ent">
5   %magic.fixup;
6 ]>
7
8 <refentry id="executable.noitd">
9   <refmeta>
10     <refentrytitle>noitd</refentrytitle>
11     <manvolnum>8</manvolnum>
12   </refmeta>
13
14   <refentryinfo>
15     <date>21/01/2010</date>
16   </refentryinfo>
17
18   <refnamediv>
19     <refname>noitd</refname>
20     <refpurpose>Reconnoiter scout daemon</refpurpose>
21   </refnamediv>
22
23   <refsynopsisdiv>
24     <cmdsynopsis>
25       <command>noitd</command>
26       <arg choice="opt">-c</arg>
27       <arg choice="opt">-u <replaceable>user</replaceable></arg>
28       <arg choice="opt">-g <replaceable>group</replaceable></arg>
29       <arg choice="opt">-t <replaceable>path</replaceable></arg>
30       <arg choice="opt">-d</arg>
31       <arg choice="opt">-D</arg>
32       <arg choice="opt">-l <replaceable>logstream</replaceable></arg>
33       <arg choice="opt">-L <replaceable>logstream</replaceable></arg>
34       <arg choice="opt">-M</arg>
35       <arg choice="opt">-h</arg>
36     </cmdsynopsis>
37   </refsynopsisdiv>
38
39   <refsect1>
40     <title>Description</title>
41 <para>
42   <command>noitd</command> is the daemon that performs all health and metric
43   checks.  Generally, one is run in each environment (secured submet).
44 </para>
45
46 <variablelist>
47   <varlistentry><term><option>-u</option></term>
48     <listitem>
49       <para>
50         Optionally specifies a username or uid under which to operate.
51       </para>
52     </listitem>
53   </varlistentry>
54   <varlistentry><term><option>-g</option></term>
55     <listitem>
56       <para>
57         Optionally specifies a group name or gid under which to operate.
58       </para>
59     </listitem>
60   </varlistentry> 
61   <varlistentry><term><option>-t</option></term>
62     <listitem>
63       <para>
64         Optionally specifies a path to chroot(2) for operation.  Measures
65         must be taken to ensure that log files can be accessed in the
66         chrooted environment.
67       </para>
68     </listitem>
69   </varlistentry>
70   <varlistentry><term><option>-c</option></term>
71     <listitem>
72       <para>
73         Specifies a configuration file to read.  The initial configuration
74         is read from this file and <command>write config</command> commands
75         will write to this file.  The default location of the configuration
76         file is <filename>noitd.conf</filename> in the sysconfdir specified
77         at build time.
78       </para>
79     </listitem>
80   </varlistentry>
81   <varlistentry><term><option>-l</option></term>
82     <listitem>
83       <para>
84         Marks the enabled bit for the specified log stream.  This enables
85         the stream even if it is disabled in the configuration file.  It
86         must exist in the configuration file.
87       </para>
88     </listitem>
89   </varlistentry>
90   <varlistentry><term><option>-L</option></term>
91     <listitem>
92       <para>
93         Disables the enabled bit for the specified log stream.  This disables
94         the stream even if it is enabled in the configuration file.  It
95         must exist in the configuration file.
96       </para>
97     </listitem>
98   </varlistentry>
99   <varlistentry><term><option>-D</option></term>
100     <listitem>
101       <para>
102         Instructs <command>noitd</command> to run in the foreground.
103         Normally, noitd consists of a management process and a child
104         process that performs all actions.  This prevents that scenario
105         and runs only the child process attached to the terminal.  This
106         is primarily for debugging purposes.
107       </para>
108     </listitem>
109   </varlistentry>
110   <varlistentry><term><option>-d</option></term>
111     <listitem>
112       <para>
113         Enables the debug output facility despite configuration to the
114         contrary.
115       </para>
116     </listitem>
117   </varlistentry>
118   <varlistentry><term><option>-M</option></term>
119     <listitem>
120       <para>
121         Instructs <command>noitd</command> to exit immediately if there
122         where any problems loading specified modules.
123       </para>
124     </listitem>
125   </varlistentry>
126   <varlistentry><term><option>-h</option></term>
127     <listitem>
128       <para>
129         Displays the usage information.
130       </para>
131     </listitem>
132   </varlistentry>
133 </variablelist>
134 </refsect1>
135 </refentry>
136
137 <!--
138 vim:ts=2:sw=2:et:
139 -->
140
Note: See TracBrowser for help on using the browser.