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