aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/syslogd.xml
blob: f6f29d28d9d9d75295b71215041ded5757e89615 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<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>&nbsp;name</replaceable></group>
<group choice="opt"><arg>-p</arg><arg>--priority</arg><replaceable>&nbsp;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>-t</arg><arg>--trace</arg><replaceable>&nbsp;file</replaceable></group>
<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>&nbsp;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>&nbsp;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>-t</option> | <option>--trace</option><replaceable>&nbsp;file</replaceable>
					</term>
					<listitem>
						<para>
Write error and trace messages to the specified file.
If filename begins with <quote>+</quote>, new messages will be appended to the
end of existing file.
Otherwise the file will be overwritten.
						</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>
	
	<refsect1>
		<title>Multiple instances</title>
		<para>
It is possible to have multiple instances of the daemon in the system.
Each instance should use its own configuration file.
This could be done specifying <option>--conf</option> option or just placing
instances in different directories.
		</para>
		<para>
Each instance should be configured to listen on its own interface and/or port
and to write messages into its own log files.
		</para>
		<para>
If option <option>--instance</option> is not specified, the instance is default.
Otherwise, all other options will apply to the specified instance.
For example, to install a different instance with name <quote>test</quote> and
high priority issue the following command:
			<screen>
syslogd --install --instance test --conf another.conf.file --priority high</screen>
Examples of control commands:
			<screen>
syslogd --shutdown --instance test
syslogd --start --instance test</screen>
To remove instance the following command should be issued:
			<screen>
syslogd --remove --instance test</screen>
		</para>
	</refsect1>

</refentry>