prepare upload
[packages/xinetd.git] / debian / README.update-inetd
1 (Lack of) update-inetd functionality with xinetd
2 ------------------------------------------------
3
4 The update-inetd script is used by Debian packages which rely on inetd.  The
5 purpose of the script is to update /etc/inetd.conf so that the network
6 service(s) provided by the package in question are added or enabled.
7
8 Beginning with 1:2.3.11-2, xinetd is shipped with an optional inetd.conf
9 compatibility mode. That is, xinetd reads xinetd.conf, then inetd.conf and
10 adds services accordingly. So, when this mode is used, and that a service
11 is added by update-inetd to inetd.conf, xinetd can be reloaded, and the
12 service becomes available through xinetd, without an xinetd.conf
13 modification.
14
15 To enable the inetd.conf compatibility mode, you can edit
16 /etc/default/xinetd and add -inetd_compat to XINETD_OPTS
17
18 However, you will want to put some services' configurations in xinetd.conf to
19 customize them.
20
21 Since the update-inetd script currently does not modify /etc/xinetd.conf,
22 instead telling the user to do this manually, there are two ways of converting
23 your inetd.conf file into xinetd.conf file : either with the xconv.pl script,
24 or with the itox program, both provided by xinetd.
25
26
27  * Using itox
28    
29    The following command will output the appropriate xinetd.conf entry for
30    this service, so you can add the output to xinetd.conf yourself:
31
32         echo "line from /etc/inetd.conf" | itox
33
34    However, if the service uses a daemon such as /usr/sbin/tcpd, then this
35    should be specified using the "-daemon_dir" option.  This example:
36
37         echo "smtp stream tcp nowait root /usr/sbin/tcpd /usr/sbin/in.smtpd" \
38          | itox -daemon_dir /usr/sbin/tcpd
39
40    would produce this:
41
42         service smtp
43         {
44                 socket_type     = stream
45                 protocol        = tcp
46                 wait            = no
47                 user            = root
48                 server          = /usr/sbin/in.smtpd
49         }
50
51  * Using xconv.pl
52
53    Mostly everything said above, regarding itox, also applies to xconv.pl -
54    the only difference is that xconv.pl is a Perl script, a bit newer than
55    than itox, and made exactly for the purpose of converting whole
56    inetd.conf file into xinetd.conf file. It's best to invoke it this way:
57
58         xconv.pl < /etc/inetd.conf > /etc/xinetd.conf
59
60    This will read the whole inetd.conf file and create full xinetd.conf
61    file.
62
63 You should also read the inetd.conf and xinetd.conf manual pages, and this will
64 hopefully make more sense.
65
66 Work is currently being done on a new update-inetd which will automatically
67 take care of everything, but that hasn't been implemented just yet.
68
69
70  -- Norbert Veber <nveber@debian.org>  Tue, 9 June 1998 22:18:25 -0500
71     Josip Rodin <jrodin@jagor.srce.hr>  Wed, 20 Oct 1999 20:56:07 +0200
72     Thomas Seyrat <tomasera@debian.org>  Fri, 15 Aug 2003 17:39:58 +0200