updated the WHATSNEW in preparation for an alpha release
[sfrench/samba-autobuild/.git] / README
1 This is version 2.0.0alphaX of Samba, the free SMB and CIFS client and
2 server for unix and other operating systems. Samba is maintained by
3 the Samba Team, who support the original author, Andrew Tridgell.
4
5 >>>> Please read THE WHOLE of this file as it gives important information
6 >>>> about the configuration and use of Samba.
7
8 This software is freely distributable under the GNU public license, a
9 copy of which you should have received with this software (in a file
10 called COPYING). 
11
12 WHAT IS SMB?
13 ============
14
15 This is a big question. 
16
17 The very short answer is that it is the protocol by which a lot of
18 PC-related machines share files and printers and other informatiuon
19 such as lists of available files and printers. Operating systems that
20 support this natively include Windows NT, OS/2, and Linux and add on
21 packages that achieve the same thing are available for DOS, Windows,
22 VMS, Unix of all kinds, MVS, and more. Apple Macs and some Web Browsers
23 can speak this protocol as well.  Alternatives to SMB include
24 Netware, NFS, Appletalk, Banyan Vines, Decnet etc; many of these have
25 advantages but none are both public specifications and widely
26 implemented in desktop machines by default.
27
28 The Common Internet Filesystem is what the new SMB initiative is
29 called. For details watch http://samba.anu.edu.au/cifs.
30
31 WHY DO PEOPLE WANT TO USE SMB?
32 ==============================
33
34 1. Many people want to integrate their Microsoft or IBM style desktop
35    machines with their Unix or VMS (etc) servers.
36
37 2. Others want to integrate their Microsoft (etc) servers with Unix
38    or VMS (etc) servers. This is a different problem to integrating
39    desktop clients.
40
41 3. Others want to replace protocols like NFS, DecNet and Novell NCP,
42    especially when used with PCs.
43
44
45 WHAT CAN SAMBA DO?
46 ==================
47
48 Here is a very short list of what samba includes, and what it does. For
49 many networks this can be simply summarised by "Samba provides a complete
50 replacement for Windows NT, Warp, NFS or Netware servers."
51
52 - a SMB server, to provide Windows NT and LAN Manager-style file and print 
53   services to SMB clients such as Windows 95, Warp Server, smbfs and others.
54
55 - a Netbios (rfc1001/1002) nameserver, which among other things gives 
56   browsing support. Samba can be the master browser on your LAN if you wish.
57
58 - a ftp-like SMB client so you can access PC resources (disks and
59 printers) from unix, Netware and other operating systems
60
61 - a tar extension to the client for backing up PCs
62
63 For a much better overview have a look at the web site at
64 http://samba.anu.edu.au/samba, and browse the user survey.
65
66 Related packages include:
67
68 - smbfs, a linux-only filesystem allowing you to mount remote SMB
69 filesystems from PCs on your linux box. This is included as standard with
70 Linux 2.0 and later.
71
72 - tcpdump-smb, a extension to tcpdump to allow you to investigate SMB
73 networking problems over netbeui and tcp/ip.
74
75 - smblib, a library of smb functions which are designed to make it
76 easy to smb-ise any particular application. See
77 ftp://samba.anu.edu.au/pub/samba/smblib.
78
79 CONTRIBUTIONS
80 =============
81
82 If you want to contribute to the development of the software then
83 please join the mailing list. The Samba team accepts patches
84 (preferably in "diff -u" format, see docs/BUGS.txt for more details)
85 and are always glad to receive feedback or suggestions to the address
86 samba-bugs@samba.anu.edu.au. We have recently put a new bug tracking
87 system into place which should help the throughput quite a lot. You
88 can also get the Samba sourcecode straight from the CVS tree - see
89 http://samba.anu.edu.au/cvs.html.
90
91 You could also send hardware/software/money/jewelry or pizza
92 vouchers directly to Andrew. The pizza vouchers would be especially
93 welcome, in fact there is a special field in the survey for people who
94 have paid up their pizza :-)
95
96 If you like a particular feature then look through the CVS change-log
97 (on the web at http://samba.anu.edu.au/cgi-bin/cvsweb/samba) and see
98 who added it, then send them an email.
99
100 Remember that free software of this kind lives or dies by the response
101 we get. If noone tells us they like it then we'll probably move onto
102 something else. However, as you can see from the user survey quite a lot of 
103 people do seem to like it at the moment :-)
104
105 Andrew Tridgell
106 Email: samba-bugs@samba.anu.edu.au
107
108 3 Ballow Crescent
109 Macgregor, A.C.T.
110 2615 Australia
111
112 Samba Team
113 Email: samba-bugs@samba.anu.edu.au
114
115 MORE INFO
116 =========
117
118 DOCUMENTATION
119 -------------
120
121 There is quite a bit of documentation included with the package,
122 including man pages, and lots of .txt files with hints and useful
123 info. This is also available from the web page. There is a growing
124 collection of information under docs/faq; by the next release expect
125 this to be the default starting point.
126
127 A list of Samba documentation in languages other than English is
128 available on the web page.
129
130 If you would like to help with the documentation (and we _need_ help!)
131 then have a look at the mailing list samba-docs, archived at
132 http://samba.anu.edu.au/listproc/samba-docs.
133
134 FTP SITE
135 --------
136
137 Please use a mirror site! The list of mirrors is in docs/MIRRORS.txt.
138 The master ftp site is samba.anu.edu.au in the directory pub/samba.
139
140 MAILING LIST
141 ------------
142
143 There is a mailing list for discussion of Samba. To subscribe send
144 mail to listproc@samba.anu.edu.au with a body of "subscribe samba Your Name"
145 Please do NOT send this request to the list alias instead.
146
147 To send mail to everyone on the list mail to samba@listproc.anu.edu.au
148
149 There is also an announcement mailing list where new versions are
150 announced.  To subscribe send mail to listproc@samba.anu.edu.au with a
151 body of "subscribe samba-announce Your Name". All announcements also
152 go to the samba list.
153
154
155 NEWS GROUP
156 ----------
157
158 You might also like to look at the usenet news group
159 comp.protocols.smb as it often contains lots of useful info and is
160 frequented by lots of Samba users. The newsgroup was initially setup
161 by people on the Samba mailing list. It is not, however, exclusive to
162 Samba, it is a forum for discussing the SMB protocol (which Samba
163 implements). The samba list is gatewayed to this newsgroup.
164
165
166 WEB SITE
167 --------
168
169 A Samba WWW site has been setup with lots of useful info. Connect to:
170
171 http://samba.anu.edu.au/samba/
172
173 As well as general information and documentation, this also has searchable 
174 archives of the mailing list and a user survey that shows who else is using
175 this package. Have you registered with the survey yet? :-)
176
177 It is maintained by Paul Blackman (thanks Paul!). You can contact him
178 at ictinus@samba.anu.edu.au.
179