update control to reflect move of primary repo to collab-maint
[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 version
15 number and `m' is the minor version number.  BETA versions of sudo may
16 also be available.  If you join the `sudo-workers' mailing list you
17 will get the BETA announcements (see the `Mailing lists' section below).
18
19 What's new
20 ==========
21 See the NEWS file for a list of major changes in this release.
22 For a complete list of changes, see the ChangeLog file.  For a
23 summary of major changes to the current stable release, see the web
24 page, http://www.sudo.ws/sudo/stable.html.
25
26 If you are upgrading from an earlier version of Sudo, please see
27 the UPGRADE file in the doc directory.
28
29 For a history of sudo please see the HISTORY file in the doc directory.
30 You can find a list of contributors to sudo in the doc/CONTRIBUTORS file.
31
32 System requirements
33 ===================
34 To build sudo from the source distribution you need a POSIX-compliant
35 operating system (any modern version of BSD, Linux or Unix should
36 work), an ANSI/ISO C compiler that supports variadic marcos (a C99
37 feature) 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 from http://flex.sourceforge.net/.
44 You can get GNU bison from ftp://ftp.gnu.org/pub/gnu/bison/ or any
45 GNU mirror.
46
47 Building the release
48 ====================
49 Please read the installation guide in the `INSTALL' file before
50 trying to build sudo.  Pay special attention to the "OS dependent notes"
51 section.
52
53 Copyright
54 =========
55 Sudo is distributed under an ISC-style license.
56 Please refer to the `LICENSE' file included with the release for details.
57
58 Mailing lists
59 =============
60 sudo-announce   This list receives announcements whenever a new version
61                 of sudo is released.
62                 http://www.sudo.ws/mailman/listinfo/sudo-announce
63
64 sudo-users      This list is for questions and general discussion about sudo.
65                 http://www.sudo.ws/mailman/listinfo/sudo-users
66
67 sudo-workers    This list is for people working on and porting sudo.
68                 http://www.sudo.ws/mailman/listinfo/sudo-workers
69
70 sudo-commits    This list receives a message for each commit made to
71                 the sudo source repository.
72                 http://www.sudo.ws/mailman/listinfo/sudo-commits
73
74 To subscribe to a list, visit its url (as listed above) and enter
75 your email address to subscribe.  Digest versions are available but
76 these are fairly low traffic lists so the digest versions are not
77 a significant win.
78
79 Mailing list archives are also available.  See the mailing list web sites
80 for the appropriate links.
81
82 Web page
83 ========
84 There is a sudo web page at http://www.sudo.ws/ that contains
85 an overview of sudo, documentation, downloads, information about
86 beta versions and other useful info.
87
88 Bug reports
89 ===========
90 If you have found what you believe to be a bug, you can file a bug
91 report in the sudo bug database, on the web at http://www.sudo.ws/bugs/.
92
93 Please read over the `TROUBLESHOOTING' file in the doc directory *before*
94 submitting a bug report.  When reporting bugs, please be sure to include
95 the version of sudo you are using as well as the platform you are running
96 it on.