Merge commit 'upstream/1.7.6p1'
[debian/sudo] / README
1 This is Sudo version 1.7.5
2
3 The sudo philosophy
4 ===================
5 Sudo is a program designed to allow a sysadmin to give limited root privileges
6 to users and log root activity.  The basic philosophy is to give as few
7 privileges as possible but still allow people to get their work done.
8
9 Where to find sudo
10 ==================
11 Before you try and build sudo, *please* make sure you have the current
12 version.  The latest sudo may always be gotten via anonymous ftp from
13 ftp.sudo.ws in the directory /pub/sudo/ or from the sudo web site,
14 http://www.sudo.ws/
15
16 The distribution is sudo-M.m.tar.gz where `M' is the major
17 version number and `m' is the minor version number.
18 BETA versions of sudo may also be available.  If you join
19 the `sudo-workers' mailing list you will get the BETA announcements
20 (see the `Mailing lists' section below).
21
22 What's new
23 ==========
24 See the NEWS file for a list of major changes in this release.
25 For a complete list of changes, see the ChangeLog file.  For a
26 summary of major changes to the current stable release, see the web
27 page, http://www.sudo.ws/sudo/stable.html.
28
29 If you are upgrading from an earlier version of Sudo, please see
30 the UPGRADE file.
31
32 For a history of sudo please see the HISTORY file.
33
34 System requirements
35 ===================
36 To build sudo from the source distribution you need a machine running
37 Unix (most flavors of BSD, SYSV, or POSIX will do), a working C
38 compiler, and the ar, make and ranlib utilities.
39
40 If you wish to modify the parser then you will need flex version
41 2.5.2 or later and either bison or byacc (sudo comes with a pre-flex'd
42 tokenizer and pre-yacc'd grammar parser).  You'll also have to
43 uncomment a few lines from the Makefile or run configure with the
44 --with-devel option.  You can get flex via anonymous ftp from
45 ftp://ftp.ee.lbl.gov/pub/flex* as well as any GNU mirror.  You can
46 get GNU bison from ftp://ftp.gnu.org/pub/gnu/bison/ or any GNU
47 mirror.
48
49 Building the release
50 ====================
51 Please read the installation guide in the `INSTALL' file before
52 trying to build sudo.  Pay special attention to the "OS dependent notes"
53 section.
54
55 Copyright
56 =========
57 Sudo is distributed under an ISC-style license.
58 Please refer to the `LICENSE' file included with the release for details.
59
60 Mailing lists
61 =============
62 sudo-announce   This list receives announcements whenever a new version
63                 of sudo is released.
64                 http://www.sudo.ws/mailman/listinfo/sudo-announce
65
66 sudo-users      This list is for questions and general discussion about sudo.
67                 http://www.sudo.ws/mailman/listinfo/sudo-users
68
69 sudo-workers    This list is for people working on and porting sudo.
70                 http://www.sudo.ws/mailman/listinfo/sudo-workers
71
72 sudo-commits    This list receives a message for each commit made to
73                 the sudo source repository.
74                 http://www.sudo.ws/mailman/listinfo/sudo-commits
75
76 To subscribe to a list, visit its url (as listed above) and enter
77 your email address to subscribe.  Digest versions are available but
78 these are fairly low traffic lists so the digest versions are not
79 a significant win.
80
81 Mailing list archives are also available.  See the mailing list web sites
82 for the appropriate links.
83
84 Web page
85 ========
86 There is a sudo web page at http://www.sudo.ws/ that contains
87 an overview of sudo, documentation, downloads, information about
88 beta versions and other useful info.
89
90 Bug reports
91 ===========
92 If you have found what you believe to be a bug, you can file a bug
93 report in the sudo bug database, on the web at http://www.sudo.ws/bugs/.
94
95 Please read over the `TROUBLESHOOTING' file *before* submitting a bug
96 report.  When reporting bugs, please be sure to include the version of
97 sudo you are using as well as the platform you are running it on.