Imported Debian patch 4.84-8
[hcoop/debian/exim4.git] / debian / manpages / exiwhat.8
1 .\" Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH EXIWHAT 8 "March 26, 2003"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh disable hyphenation
10 .\" .hy enable hyphenation
11 .\" .ad l left justify
12 .\" .ad b justify to both left and right margins
13 .\" .nf disable filling
14 .\" .fi enable filling
15 .\" .br insert line break
16 .\" .sp <n> insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .\" \(oqthis text is enclosed in single quotes\(cq
19 .\" \(lqthis text is enclosed in double quotes\(rq
20 .SH NAME
21 exiwhat \- Finding out what Exim processes are doing
22 .SH SYNOPSIS
23 .B exiwhat
24
25 .SH DESCRIPTION
26 On operating systems that can restart a system call after receiving a
27 signal (most modern OS), an
28 .B Exim
29 process responds to the SIGUSR1 signal by writing a line describing what
30 it is doing to the file exim\-process.info in the Exim spool directory.
31 The
32 .B exiwhat
33 script sends the signal to all
34 .B Exim
35 processes it can find, having first emptied the file.
36 It then waits for one second to allow the
37 .B Exim
38 processes to react before displaying the results.
39 In order to run
40 .B exiwhat
41 successfully you have to have sufficient privilege to send the signal to
42 the
43 .B Exim
44 processes, so it is normally run as root.
45
46 Unfortunately, the
47 .B ps
48 command which
49 .B exiwhat
50 uses to find
51 .B Exim
52 processes varies in different operating systems.
53 Not only are different options used, but the format of the output is
54 different.
55 For this reason, there are some system configuration options that configure
56 exactly how
57 .B exiwhat
58 works.
59 If it doesn't seem to be working for you, check the following compile-time
60 options:
61 .TP
62 .I EXIWHAT_PS_CMD
63 the command for running \(lqps\(rq
64 .TP
65 .I EXIWHAT_PS_ARG
66 the argument for \(lqps\(rq
67 .TP
68 .I EXIWHAT_EGREP_ARG
69 the argument for \(lqegrep\(rq to select from \(lqps\(rq output
70 .TP
71 .I EXIWHAT_KILL_ARG
72 the argument for the \(lqkill\(rq command
73 .PP
74 An example of typical output from
75 .B exiwhat
76 is
77
78 .nf
79 164 daemon: \-q1h, listening on port 25
80 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
81 10492 delivering 0tAycK-0002ij-00 to mail.ref.example [10.19.42.42]
82 (editor@ref.example)
83 10592 handling incoming call from [192.168.243.242]
84 10628 accepting a local non-SMTP message
85 .fi
86
87 The first number in the output line is the process number.
88 The third line has been split here, in order to fit it on the page.
89
90 .SH BUGS
91 This manual page needs a major re-work. If somebody knows better groff
92 than us and has more experience in writing manual pages, any patches
93 would be greatly appreciated.
94
95 .SH SEE ALSO
96 .BR exim (8),
97 /usr/share/doc/exim4\-base/
98
99 .SH AUTHOR
100 This manual page was stitched together from spec.txt by
101 Andreas Metzler <ametzler at downhill.at.eu.org>,
102 for the Debian GNU/Linux system (but may be used by others).