[projects/rc-scripts.git] / doc / initlog.1

.TH initlog 8 "Sun Jan 24 1999"
.SH NAME
initlog \- log messages and events to the system logger
.SH SYNOPSIS
.B initlog
[\-cefnpqrs] [\-\-cmd=ARG] [\-\-event=ARG] [\-\-facility=ARG]
[\-\-name=ARG] [\-\-priority=ARG] [\-\-run=ARG] [\-\-string=ARG]
.SH DESCRIPTION
\fBinitlog\fR logs messages and events to the system logger.
It is mainly designed for use in init scripts. initlog
reads a configuration file
.I /etc/initlog.conf
by default, to determine its settings. Any line preceded with a 
.I #
is a comment, and the following configuration directives
are recognized:
.TP
.I facility <logging facility>
Sets the default logging facility
.TP
.I priority <logging priority>
Sets the default logging priority
.TP
.I ignore <regexp>
Messages that match the regular expression will not be logged.
.TP
initlog behavior can also be configured by command-line options.

.SS OPTIONS
.TP
.I "\-c, \-\-cmd=[program]"
Execute the specified program, logging anything output to
stdout or stderr.
.TP
.I "\-e, \-\-event=[number]"
Logs that the specified event happened. Usually used in conjuction
with \fB\-\-name\fR. Currently specified events are:
.nf
 \fB1\fR  the action completed successfully
 \fB2\fR  the action failed
 \fB3\fR  the action was cancelled at user request
 \fB4\fR  the action failed due to the failure of a dependent action
.TP
.I "\-f, \-\-facility=[facility]"

Log at the specified syslog facility. The default
is \fBdaemon\fR (see syslog(3)).
.TP
.I "\-n, \-\-name=[string]"
Log the event under the specified string, such as
"inetd".
.TP
.I "\-p, \-\-priority=[priority]"
Log at the specified syslog priority. The default
is \fBnotice\fR (see syslog(3)).
.TP
.I "\-q"
Do not print the program's output, unless it exits
with a non-zero exit code.
.TP
.I "\-r, \-\-run=[program]"
Execute the specified program, with an open file
descriptor so that the program can pass back
commands to initlog.
.TP
.I "\-s, \-\-string=[string]"
Log the specified string to the logger.
.TP
.I "\-\-conf=[file]"
Specifies an alternate configuration file.
.SH FILES
.I /etc/initlog.conf
.SH "SEE ALSO"
syslog(3), logger(1)
Commit	Line	Data
cee18a41 AM	1	.TH initlog 8 "Sun Jan 24 1999"
	2	.SH NAME
	3	initlog \- log messages and events to the system logger
	4	.SH SYNOPSIS
	5	.B initlog
de1fc6ce	6	[\-cefnpqrs] [\-\-cmd=ARG] [\-\-event=ARG] [\-\-facility=ARG]
cee18a41 AM	7	[\-\-name=ARG] [\-\-priority=ARG] [\-\-run=ARG] [\-\-string=ARG]
	8	.SH DESCRIPTION
	9	\fBinitlog\fR logs messages and events to the system logger.
de1fc6ce JR	10	It is mainly designed for use in init scripts. initlog
	11	reads a configuration file
	12	.I /etc/initlog.conf
	13	by default, to determine its settings. Any line preceded with a
	14	.I #
	15	is a comment, and the following configuration directives
	16	are recognized:
	17	.TP
	18	.I facility <logging facility>
	19	Sets the default logging facility
	20	.TP
	21	.I priority <logging priority>
	22	Sets the default logging priority
	23	.TP
	24	.I ignore <regexp>
	25	Messages that match the regular expression will not be logged.
	26	.TP
	27	initlog behavior can also be configured by command-line options.
cee18a41 AM	28
	29	.SS OPTIONS
	30	.TP
	31	.I "\-c, \-\-cmd=[program]"
	32	Execute the specified program, logging anything output to
	33	stdout or stderr.
	34	.TP
	35	.I "\-e, \-\-event=[number]"
	36	Logs that the specified event happened. Usually used in conjuction
	37	with \fB\-\-name\fR. Currently specified events are:
	38	.nf
	39	\fB1\fR the action completed successfully
	40	\fB2\fR the action failed
	41	\fB3\fR the action was cancelled at user request
	42	\fB4\fR the action failed due to the failure of a dependent action
	43	.TP
	44	.I "\-f, \-\-facility=[facility]"
	45
	46	Log at the specified syslog facility. The default
	47	is \fBdaemon\fR (see syslog(3)).
	48	.TP
	49	.I "\-n, \-\-name=[string]"
	50	Log the event under the specified string, such as
	51	"inetd".
	52	.TP
	53	.I "\-p, \-\-priority=[priority]"
	54	Log at the specified syslog priority. The default
	55	is \fBnotice\fR (see syslog(3)).
	56	.TP
de1fc6ce JR	57	.I "\-q"
	58	Do not print the program's output, unless it exits
	59	with a non-zero exit code.
	60	.TP
cee18a41 AM	61	.I "\-r, \-\-run=[program]"
	62	Execute the specified program, with an open file
	63	descriptor so that the program can pass back
	64	commands to initlog.
	65	.TP
de1fc6ce	66	.I "\-s, \-\-string=[string]"
cee18a41	67	Log the specified string to the logger.
de1fc6ce JR	68	.TP
	69	.I "\-\-conf=[file]"
	70	Specifies an alternate configuration file.
	71	.SH FILES
	72	.I /etc/initlog.conf
cee18a41 AM	73	.SH "SEE ALSO"
cee18a41 AM	74	syslog(3), logger(1)