Changed ftp site and docs info in README (this file contains out-of-date
[jra/samba/.git] / README
1 This is version 1.9.17 of Samba, the free SMB client and server for unix
2 and other operating systems. Samba is maintained by the Samba Team,
3 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 WHAT CAN SAMBA DO?
32 ==================
33
34 Here is a very short list of what samba includes, and what it does. 
35
36 - a SMB server, to provide Windows NT and LAN Manager-style file and print 
37   services to SMB clients such as Windows 95, Warp Server, smbfs and others.
38
39 - a Netbios (rfc1001/1002) nameserver, which among other things gives 
40   browsing support. Samba can be the master browser on your LAN if you wish.
41
42 - a ftp-like SMB client so you can access PC resources (disks and
43 printers) from unix, Netware and other operating systems
44
45 - a tar extension to the client for backing up PCs
46
47 For a much better overview have a look at the web site at
48 http://samba.canberra.edu.au/pub/samba, and browse the user survey.
49
50 Related packages include:
51
52 - smbfs, a linux-only filesystem allowing you to mount remote SMB
53 filesystems from PCs on your linux box. This is included as standard with
54 Linux 2.0 and later.
55
56 - tcpdump-smb, a extension to tcpdump to allow you to investigate SMB
57 networking problems over netbeui and tcp/ip.
58
59 - smblib, a library of smb functions which are designed to make it
60 easy to smb-ise any particular application. See
61 ftp://samba.anu.edu.au/pub/samba/smblib.
62
63 CONTRIBUTIONS
64 =============
65
66 If you want to contribute to the development of the software then
67 please join the mailing list. The Samba team accepts patches
68 (preferably in "diff -u" format, see docs/BUGS.txt for more details)
69 and are always glad to receive feedback or suggestions to the address
70 samba-bugs@samba.anu.edu.au.
71
72 You could also send hardware/software/money/jewelry or pizza
73 vouchers directly to Andrew. The pizza vouchers would be especially
74 welcome, in fact there is a special field in the survey for people who
75 have paid up their pizza :-)
76
77 If you like a particular feature then look through the change-log and
78 see who added it, then send them an email.
79
80 Remember that free software of this kind lives or dies by the response
81 we get. If noone tells us they like it then we'll probably move onto
82 something else. However, as you can see from the user survey quite a lot of 
83 people do seem to like it at the moment :-)
84
85 Andrew Tridgell
86 Email: samba-bugs@samba.anu.edu.au
87
88 3 Ballow Crescent
89 Macgregor, A.C.T.
90 2615 Australia
91
92 Samba Team
93 Email: samba-bugs@samba.anu.edu.au
94
95 MORE INFO
96 =========
97
98 DOCUMENTATION
99 -------------
100
101 There is quite a bit of documentation included with the package,
102 including man pages, and lots of .txt files with hints and useful
103 info. This is also available from the web page. There is a growing
104 collection of information under docs/faq; by the next release expect
105 this to be the default starting point.
106
107 FTP SITE
108 --------
109
110 Please use a mirror site! The list of mirrors is in docs/MIRRORS.txt.
111 The master ftp site is samba.anu.edu.au in the directory pub/samba.
112
113 MAILING LIST
114 ------------
115
116 There is a mailing list for discussion of Samba. To subscribe send
117 mail to listproc@samba.anu.edu.au with a body of "subscribe samba Your Name"
118 Please do NOT send this request to the list alias instead.
119
120 To send mail to everyone on the list mail to samba@listproc.anu.edu.au
121
122 There is also an announcement mailing list where new versions are
123 announced.  To subscribe send mail to listproc@samba.anu.edu.au with a
124 body of "subscribe samba-announce Your Name". All announcements also
125 go to the samba list.
126
127
128 NEWS GROUP
129 ----------
130
131 You might also like to look at the usenet news group
132 comp.protocols.smb as it often contains lots of useful info and is
133 frequented by lots of Samba users. The newsgroup was initially setup
134 by people on the Samba mailing list. It is not, however, exclusive to
135 Samba, it is a forum for discussing the SMB protocol (which Samba
136 implements). The samba list is gatewayed to this newsgroup.
137
138
139 WEB SITE
140 --------
141
142 A Samba WWW site has been setup with lots of useful info. Connect to:
143
144 http://samba.canberra.edu.au/pub/samba/
145
146 As well as general information and documentation, this also has searchable 
147 archives of the mailing list and a user survey that shows who else is using
148 this package. Have you registered with the survey yet? :-)
149
150 It is maintained by Paul Blackman (thanks Paul!). You can contact him
151 at ictinus@lake.canberra.edu.au.
152