~vorlon/ubuntu/raring/upstart/lp.1199778

« back to all changes in this revision

Viewing changes to logd/man/logd.8

  • Committer: Scott James Remnant
  • Date: 2008-06-08 01:13:33 UTC
  • Revision ID: scott@netsplit.com-20080608011333-x1j4n0v4cg4hba3w
* logd/Makefile.am, logd/main.c, logd/man/logd.8, logd/jobs.d/logd.in:
Consign logd to oblivion.  We haven't supported it for ages, it has
non-working issues, and there's got to be a better way to do this.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH logd 8 "October 2006" "Upstart"
2
 
.\"
3
 
.SH NAME
4
 
logd \- job output logging daemon
5
 
.\"
6
 
.SH SYNOPSIS
7
 
\fBlogd\fR [\fIOPTION\fR]...
8
 
.\"
9
 
.SH DESCRIPTION
10
 
.B logd
11
 
is started by
12
 
.BR init (8)
13
 
to receive the output of jobs with
14
 
.I console logged
15
 
in their job definition, which is the default if no other
16
 
.I console
17
 
setting is given.
18
 
 
19
 
Output is timestamped and written, with the job name, to
20
 
.I /var/log/boot
21
 
or stored in memory until the file is writable.
22
 
.\"
23
 
.SH OPTIONS
24
 
.TP
25
 
.B --daemon
26
 
Detaches from the terminal and runs in the background.
27
 
.\"
28
 
.SH STARTUP
29
 
To eliminate race conditions on startup, such as not being ready to receive
30
 
connections when the first job is started, the following procedure is used.
31
 
 
32
 
Once ready to receive connections,
33
 
.B logd
34
 
raises the
35
 
.I SIGSTOP
36
 
signal, putting itself to sleep until continued by another process.
37
 
 
38
 
After starting
39
 
.BR logd ,
40
 
.BR init (8)
41
 
waits for the process to stop if it hasn't already, and then sends it the
42
 
.I SIGCONT
43
 
signal so that it can proceed.  Only once this has happened, will
44
 
.BR init (8)
45
 
start other jobs.
46
 
 
47
 
When the
48
 
.I --daemon
49
 
option is given, this is not performed; instead
50
 
.B logd
51
 
will not detach from the console until it is listening on the socket.
52
 
.\"
53
 
.SH SOCKET PROTOCOL
54
 
.B logd
55
 
listens on a
56
 
.BR unix (7)
57
 
stream socket in the abstract namespace, bound to
58
 
.IR /com/ubuntu/upstart/logd .
59
 
 
60
 
.BR init (8)
61
 
opens a new connection for each job that is to be logged, binding the
62
 
socket to the standard input, output and error file descriptors for the job.
63
 
 
64
 
Before running the job, it sends the job name on the socket so that it can be
65
 
logged along with the messages.  This is sent as a
66
 
.I size_t
67
 
that contains the length of the name to read, followed by that many
68
 
character bytes.  The NULL terminator is not sent as part of the protocol,
69
 
it is up to the receiver to add that if required.
70
 
 
71
 
Further information about the job, such as its description, can be obtained
72
 
by opening an ordinary connection to the
73
 
.BR init (8)
74
 
daemon and querying it using the name received.
75
 
.\"
76
 
.SH AUTHOR
77
 
Written by Scott James Remnant.
78
 
.\"
79
 
.SH REPORTING BUGS
80
 
Report bugs at https://launchpad.net/products/upstart/+bugs
81
 
.\"
82
 
.SH COPYRIGHT
83
 
Copyright \(co 2006 Canonical Ltd.
84
 
.br
85
 
This is free software; see the source for copying conditions.  There is NO
86
 
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
87
 
.\"
88
 
.SH SEE ALSO
89
 
.BR init (8)