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