path: root/doc/src/syslogd.xml

<refentry>

	<refentryinfo>
		<title>syslogd</title>
	</refentryinfo>

	<refmeta>
		<refentrytitle>syslogd</refentrytitle>
		<manvolnum>1</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>syslogd</refname>
		<refpurpose>service process (daemon)</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>syslogd</command>
<group choice="opt"><arg>-c</arg><arg>--conf</arg></group>
<group choice="opt"><arg>-h</arg><arg>--help</arg></group>
<group choice="opt"><arg>-i</arg><arg>--install</arg></group>
<group choice="opt"><arg>-I</arg><arg>--instance</arg><replaceable>name</replaceable></group>
<group choice="opt"><arg>-p</arg><arg>--priority</arg><replaceable>name</replaceable></group>
<group choice="opt"><arg>-r</arg><arg>--remove</arg></group>
<arg choice="opt">--restart</arg>
<group choice="opt"><arg>-s</arg><arg>--shutdown</arg></group>
<arg choice="opt">--start</arg>
<group choice="opt"><arg>-v</arg><arg>--verbose</arg></group>
<arg choice="opt">--version</arg>
		</cmdsynopsis>
	</refsynopsisdiv>
	
	<refsect1>
		<title>Options</title>
		<para>
			<variablelist>
				<varlistentry>
					<term>
<option>-c</option> | <option>--conf</option>
					</term>
					<listitem>
						<para>
Specify alternate configuration file.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-h</option> | <option>--help</option>
					</term>
					<listitem>
						<para>
Display help message.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-i</option> | <option>--install</option>
					</term>
					<listitem>
						<para>
Install and start service.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-I</option> | <option>--instance</option><replaceable>name</replaceable>
					</term>
					<listitem>
						<para>
Specify instance name for the daemon.
This option is useful to install and run multiple daemons in the system.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-p</option> | <option>--priority</option><replaceable>name</replaceable>
					</term>
					<listitem>
						<para>
Set priority class for the daemon.
Name may be <quote>normal</quote>, <quote>high</quote> or <quote>highest</quote>.
Default is <quote>normal</quote>.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-r</option> | <option>--remove</option>
					</term>
					<listitem>
						<para>
Stop and remove service.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>--restart</option>
					</term>
					<listitem>
						<para>
Restart service.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-s</option> | <option>--shutdown</option>
					</term>
					<listitem>
						<para>
Gracefully shutdown service.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>--start</option>
					</term>
					<listitem>
						<para>
Start installed service.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-v</option> | <option>--verbose</option>
					</term>
					<listitem>
						<para>
Increase verbosity level.
This option may be specified multiple times.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>--version</option>
					</term>
					<listitem>
						<para>
Display version.
						</para>
					</listitem>
				</varlistentry>
			</variablelist>
		</para>
	</refsect1>
	
</refentry>