Debian Codegraph @

README

raw
1 # GNU inetutils - The GNU Networking Utilities
2
3 GNU Networking Utilities (Inetutils) are the traditional network
4 clients, servers and utilities. Included are ftp, hostname, ifconfig,
5 inetd, logger, ping, rsh, rlogin, talk, telnet, tftp, syslogd,
6 traceroute, whois, and dnsdomainname.
7
8 Send bug reports to <[email protected]>.
9
10 # Licensing
11
12 GNU Inetutils is licensed under the GNU General Public License version
13 3.0 or later - see the file [COPYING](COPYING).
14
15 The manual (see doc/) is under the GNU Free Documentation License
16 version 1.3 or later, see [doc/fdl-1.3.texi](doc/fdl-1.3.texi).
17
18 Other files are licensed as indicated in each file. There may be
19 exceptions to these general rules, see each file for precise
20 information.
21
22 For any copyright year range specified as YYYY-ZZZZ in this package
23 note that the range specifies every single year in that closed
24 interval.
25
26 # Building
27
28 See the file INSTALL for generic installation instructions.
29
30 The file `paths` contains a list of all paths used by programs in this
31 distribution, and rules to find values for them. To change a path
32 PATH_FOO, you may either tell configure, by using
33 `--with-path-foo=VALUE` (where VALUE may contain references to make
34 variables such as `$(bindir)`), or edit the `paths` file. See further
35 below for some important cases.
36
37 If you wish to build only the clients or only the servers, you may
38 wish to use the `--disable-servers` or `--disable-clients` options
39 when invoking `configure`. You can also use `--enable-<program>` or
40 `--disable-<program>` to control whether to build individual programs;
41 if you explicitly specify whether to build a program, that will
42 override the values specified by `--disable-clients` or
43 `--disable-servers`.
44
45 # History
46
47 The individual utilities were originally derived from the 4.4BSDLite2
48 distribution. Many features were integrated from NetBSD, OpenBSD,
49 FreeBSD and GNU/Linux.
50
51 # Join GNU
52
53 If you are the author of an awesome program and want to join us in
54 writing Free (libre) Software, please consider making it an official
55 GNU program and become a GNU Maintainer. You can find instructions on
56 how to do this here: http://www.gnu.org/help/evaluation
57
58 # Testing
59
60 Some words on testing are in order. The three tests `ftp-localhost`,
61 `ping`, and `traceroute`, all need to be run by root. Several tests
62 will depend on infrastructure files in `/etc/`, but most tests will
63 complain about their obvious needs. Anyway, these dependencies are
64 important whenever chrooted builds are conducted.
65
66 At the time of running a test, the shell variables TEST_IPV4 and
67 TEST_IPV6 are influential. Regard them as taking one of three values:
68 `yes`, `no`, or `auto`. When assigned the value `auto`, a small check
69 at runtime will determine if the corresponding address family is available,
70 and accordingly include it during test. The values `yes`, and `no`,
71 include or exclude the corresponding address family unconditionally.
72
73 During configuration time, TEST_IPV# is essentially set to `auto`,
74 except that `-enable-ipv#` assigns `yes`, and `--disable-ipv#` assigns
75 `no` unconditionally. Note however, that `--disable-ipv6` retains
76 its property of removing all support for IPv6 in every executable,
77 while `--disable-ipv4` only affects the testing target `check` and scripts.
78
79 During chrooted tests, the runtime check for either family can be
80 fooled, so setting `TEST_IPV6=yes` might be necessary. On the other
81 hand, chrooting similar to a FreeBSD jail, normally changes the address
82 of `localhost`, so similar environments will need counteractions like
83 `TARGET=10.0.6.1`.
84
85 # Whois
86
87 The GNU whois client reads a whois-servers file to figure out which
88 whois server to use. It won't always pick the best server;
89 whois.internic.net seems to know something about nic.ddn.mil, but the
90 GNU whois client will use nic.ddn.mil to look up nic.ddn.mil if you
91 use the configuration file we supply. Our configuration file probably
92 also does not have a complete list of whois servers; feel free to send
93 information about additional whois servers to the bug reporting
94 address.
95
96 # Notes on setuid-executables:
97
98 - All of the r* client commands, `rcp`, `rlogin`, `rsh`, used to need
99 to be installed as setuid root to work correctly, since they use
100 privileged ports for communication. However, some modern operating
101 systems now offer capabilities that avoid the need for setuid
102 settings, and this is accounted for in our present code.
103 CAP_NET_BIND_SERVICE and PRIV_NET_PRIVADDR are relevant for the
104 above three programs.
105
106 - Similarly, `ping`, `ping6`, and `traceroute`, used to depend on
107 setuid installation, but also these are now content with
108 capabilities like CAP_NET_RAW, PRIV_NET_ICMPACCESS, and
109 PRIV_NET_RAWACCESS.
110
111 # Notes on hard-coded file locations
112
113 - Some of the buildable executables depend critically on hard-coded
114 file locations for correct execution. The most important, where
115 care is needed, are highlighted below.
116
117 - `ftpd` needs access to several configuration files, in order that
118 all use cases be covered. Both of PATH_FTPCHROOT and
119 PATH_FTPWELCOME are normally positioned correctly in sysconfdir by
120 default, whereas PATH_FTPUSERS usually is desired to state
121 `/etc/ftpusers`, but not all systems manage this. Particular care
122 should be given to PATH_FTPLOGINMESG, since it defaults to
123 `/etc/motd`, which cannot be claimed as universally ideal. A
124 sensible counter measure could be
125
126 `./configure --with-path-ftploginmesg=$(sysconfdir)/ftpmotd`
127
128 This would, however, complicate matter for chrooted users, so a
129 minor variation on the default could be preferable:
130
131 `./configure --with-path-ftploginmesg=/etc/ftpmotd`
132
133 Finally, the fall-back value `/etc/nologin` for PATH_NOLOGIN is in
134 effect for every systems lacking <paths.h>, but this sets the most
135 plausible location in any case.
136
137 - `rcp` relies on PATH_RSH for proper hand-over. Use the
138 configuration switch `--with-path-rsh=VALUE` for overriding the
139 detected value. It should point to the intended location of `rsh`,
140 particularly when built with Kerberos support.
141
142 - Similarly, `rsh` needs PATH_RLOGIN to locate `rlogin` for correct
143 delegation. The switch `--with-path-rlogin=VALUE` may come handy
144 to ensure that `rsh` as well as `rlogin` offer identical Kerberos
145 support.
146
147 # Some known deficiencies:
148
149 - Non-Shishi Kerberos support does not build. Patches welcome.
150
151 - Shishi Kerberos support is only implemented for `rcp`, `rlogin`,
152 `rlogind`, `rsh`, `rshd`, `telnet`, and `telnetd`.
153
154 - Not all utilities are Kerberized even when built with Kerberos
155 libraries, including `rcp` for non-Shishi Kerberos.
156
157 - InetUtils does not build on HP-UX 11.00, Cygwin, Minix, MinGW,
158 MSCV, BeOS, Haiku (and probably other systems as well). Patches
159 welcome.
160
161 ========================================================================
162
163 Copyright (C) 1997-2026 Free Software Foundation, Inc.
164
165 Copying and distribution of this file, with or without modification,
166 are permitted in any medium without royalty provided the copyright
167 notice and this notice are preserved. This file is offered as-is,
168 without any warranty.