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