first draft of low-level design documents describing the operation of
[samba.git] / README
1 This is version 1.9 of Samba, the free SMB client and server for unix.
2
3 >>>> Please read THE WHOLE of this file as it gives important information
4 >>>> about the configuration and use of Samba.
5
6 This software is freely distributable under the GNU public license, a
7 copy of which you should have received with this software (in a file
8 called COPYING). 
9
10 WHAT CAN SAMBA DO?
11 ==================
12
13 Here is a very short list of what samba includes, and what it does. 
14
15 - a SMB server, to provide Windows NT and LAN Manager-style file and print 
16   services to SMB clients such as Windows 95, Warp Server, smbfs and others.
17
18 - a Netbios (rfc1001/1002) nameserver, which among other things gives 
19   browsing support. Samba can be the master browser on your LAN if you wish.
20
21 - a ftp-like SMB client so you can access PC resources (disks and
22 printers) from unix, Netware and other operating systems
23
24 - a tar extension to the client for backing up PCs
25
26 For a much better overview have a look at the web site at
27 http://samba.canberra.edu.au/pub/samba, and browse the user survey.
28
29 Related packages include:
30
31 - smbfs, a linux-only filesystem allowing you to mount remote SMB
32 filesystems from PCs on your linux box. This is included as standard with
33 Linux 2.0 and later.
34
35 - tcpdump-smb, a extension to tcpdump to allow you to investigate SMB
36 networking problems over netbeui and tcp/ip
37
38
39 CONTRIBUTIONS
40 =============
41
42 If you want to contribute to the development of the software then
43 please join the mailing list. I accept patches (preferably in 
44 "diff -u" format, see docs/BUGS.txt for more details) and am always glad to 
45 receive feedback or suggestions.
46
47 You could also send hardware/software/money/jewelry or pizza
48 vouchers directly to me. The pizza vouchers would be especially
49 welcome :-)
50
51 If you like a particular feature then look through the change-log and
52 see who added it, then send them an email.
53
54 Remember that free software of this kind lives or dies by the response
55 we get. If noone tells us they like it then we'll probably move onto
56 something else. However, as you can see from the user survey quite a lot of 
57 people do seem to like it at the moment :-)
58
59 Andrew Tridgell
60 Email: samba-bugs@samba.anu.edu.au
61
62 3 Ballow Crescent
63 Macgregor, A.C.T.
64 2615 Australia
65
66
67 MORE INFO
68 =========
69
70 DOCUMENTATION
71 -------------
72
73 There is quite a bit of documentation included with the package,
74 including man pages, and lots of .txt files with hints and useful
75 info.
76
77 FTP SITE
78 --------
79
80 The main anonymous ftp distribution site for this software is
81 samba.anu.edu.au in the directory pub/samba/.
82
83 MAILING LIST
84 ------------
85
86 There is a mailing list for discussion of Samba. To subscribe send
87 mail to listproc@samba.anu.edu.au with a body of "subscribe samba Your Name"
88
89 To send mail to everyone on the list mail to samba@listproc.anu.edu.au
90
91 There is also an announcement mailing list where I announce new
92 versions.  To subscribe send mail to listproc@samba.anu.edu.au with a body
93 of "subscribe samba-announce Your Name". All announcements also go to
94 the samba list.
95
96
97 NEWS GROUP
98 ----------
99
100 You might also like to look at the usenet news group
101 comp.protocols.smb as it often contains lots of useful info and is
102 frequented by lots of Samba users. The newsgroup was initially setup
103 by people on the Samba mailing list. It is not, however, exclusive to
104 Samba, it is a forum for discussing the SMB protocol (which Samba
105 implements).
106
107
108 WEB SITE
109 --------
110
111 A Samba WWW site has been setup with lots of useful info. Connect to:
112
113 http://samba.canberra.edu.au/pub/samba/
114
115 As well as general information and documentation, this also has searchable 
116 archives of the mailing list and a user survey that shows who else is using
117 this package. Have you registered with the survey yet? :-)
118
119 It is maintained by Paul Blackman (thanks Paul!). You can contact him
120 at ictinus@lake.canberra.edu.au.
121
122
123