don't forget the NULL
[Samba.git] / README
blobfe20f671e1185957511981974b9b051a058cd048
1 This is version 2.2.X 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.
5 >>>> Please read THE WHOLE of this file as it gives important information
6 >>>> about the configuration and use of Samba.
8 NOTE: Installation instructions may be found in 
9       docs/htmldocs/UNIX_INSTALL.html
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). 
16 WHAT IS SMB?
17 ============
19 This is a big question. 
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.
32 The Common Internet Filesystem (CIFS) is what the new SMB initiative
33 is called. For details watch http://samba.org/cifs.
36 WHY DO PEOPLE WANT TO USE SMB?
37 ==============================
39 1. Many people want to integrate their Microsoft or IBM style desktop
40    machines with their Unix or VMS (etc) servers.
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.
46 3. Others want to replace protocols like NFS, DecNet and Novell NCP,
47    especially when used with PCs.
50 WHAT CAN SAMBA DO?
51 ==================
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."
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.
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.
63 - a ftp-like SMB client so you can access PC resources (disks and
64 printers) from unix, Netware and other operating systems
66 - a tar extension to the client for backing up PCs
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.
71 For a much better overview have a look at the web site at
72 http://samba.org/samba, and browse the user survey.
74 Related packages include:
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.
80 - tcpdump-smb, a extension to tcpdump to allow you to investigate SMB
81 networking problems over netbeui and tcp/ip.
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.
88 CONTRIBUTIONS
89 =============
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/textdocs/BUGS.txt for more details)
94 and are always glad to receive feedback or suggestions to the address
95 samba@lists.samba.org. We have recently put a new bug tracking
96 system into place which should help the throughput quite a lot. You
97 can also get the Samba sourcecode straight from the CVS tree - see
98 http://samba.org/cvs.html.
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 :-)
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.
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 :-)
114 Samba Team
115 Email: samba@samba.org
118 MORE INFO
119 =========
121 DOCUMENTATION
122 -------------
124 There is quite a bit of documentation included with the package,
125 including man pages, and lots of .txt files with hints and useful
126 info. This is also available from the web page. There is a growing
127 collection of information under docs/faq; by the next release expect
128 this to be the default starting point.
130 A list of Samba documentation in languages other than English is
131 available on the web page.
133 If you would like to help with the documentation (and we _need_ help!)
134 then have a look at the mailing list samba-docs, archived at
135 http://lists.samba.org/
138 MAILING LIST
139 ------------
141 Please do NOT send subscription/unsubscription requests to the lists!
143 There is a mailing list for discussion of Samba.  For details go to
144 <http://lists.samba.org/> or send mail to <samba-subscribe@lists.samba.org>
146 There is also an announcement mailing list where new versions are
147 announced.  To subscribe go to <http://lists.samba.org/> or send mail
148 to <samba-announce-subscribe@lists.samba.org>.  All announcements also
149 go to the samba list, so you only need to be on one.
151 For details of other Samba mailing lists and for access to archives, see
152 <http://lists.samba.org/>
155 MAILING LIST ETIQUETTE
156 ----------------------
158 A few tips when submitting to this or any mailing list.
160 1. Make your subject short and descriptive. Avoid the words "help" or
161    "Samba" in the subject. The readers of this list already know that
162    a) you need help, and b) you are writing about samba (of course,
163    you may need to distinguish between Samba PDC and other file
164    sharing software). Avoid phrases such as "what is" and "how do
165    i". Some good subject lines might look like "Slow response with
166    Excel files" or "Migrating from Samba PDC to NT PDC".
168 2. If you include the original message in your reply, trim it so that
169    only the relevant lines, enough to establish context, are
170    included. Chances are (since this is a mailing list) we've already
171    read the original message.
173 3. Trim irrelevant headers from the original message in your
174    reply. All we need to see is a) From, b) Date, and c) Subject. We
175    don't even really need the Subject, if you haven't changed
176    it. Better yet is to just preface the original message with "On
177    [date] [someone] wrote:".
179 4. Please don't reply to or argue about spam, spam filters or viruses
180    on any Samba lists. We do have a spam filtering system that is
181    working quite well thank you very much but occasionally unwanted
182    messages slip through. Deal with it.
184 5. Never say "Me too." It doesn't help anyone solve the
185    problem. Instead, if you ARE having the same problem, give more
186    information. Have you seen something that the other writer hasn't
187    mentioned, which may be helpful?
189 6. If you ask about a problem, then come up with the solution on your
190    own or through another source, by all means post it. Someone else
191    may have the same problem and is waiting for an answer, but never
192    hears of it.
194 7. Give as much *relevant* information as possible such as Samba
195    release number, OS, kernel version, etc...
197 8. RTFM. Google. groups.google.com.
200 NEWS GROUP
201 ----------
203 You might also like to look at the usenet news group
204 comp.protocols.smb as it often contains lots of useful info and is
205 frequented by lots of Samba users. The newsgroup was initially setup
206 by people on the Samba mailing list. It is not, however, exclusive to
207 Samba, it is a forum for discussing the SMB protocol (which Samba
208 implements). The samba list is gatewayed to this newsgroup.
211 WEB SITE
212 --------
214 A Samba WWW site has been setup with lots of useful info. Connect to:
216 http://samba.org/samba/
218 As well as general information and documentation, this also has searchable 
219 archives of the mailing list and a user survey that shows who else is using
220 this package. Have you registered with the survey yet? :-)