selftest.target: Add tests for check.
[ira/wip.git] / README
1 This is the release 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/Samba3-HOWTO/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/CIFS?
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 information
23 such as lists of available files and printers. Operating systems that
24 support this natively include Windows 9x, Windows NT (and derivatives), 
25 OS/2, Mac OS X and Linux.  Add on packages that achieve the same 
26 thing are available for DOS, Windows 3.1, VMS, Unix of all kinds, 
27 MVS, and more.  Some Web Browsers can speak this protocol as well 
28 (smb://).  Alternatives to SMB include Netware, NFS, Appletalk, 
29 Banyan Vines, Decnet etc; many of these have advantages but none are 
30 both public specifications and widely implemented in desktop machines 
31 by default.
32
33 The Common Internet File system (CIFS) is what the new SMB initiative
34 is called. For details watch http://samba.org/cifs.
35
36
37 WHY DO PEOPLE WANT TO USE SMB?
38 ==============================
39
40 1. Many people want to integrate their Microsoft desktop clients
41    with their Unix servers.
42
43 2. Others want to integrate their Microsoft (etc) servers with Unix
44    servers. This is a different problem to integrating desktop 
45    clients.
46
47 3. Others want to replace protocols like NFS, DecNet and Novell NCP,
48    especially when used with PCs.
49
50
51 WHAT CAN SAMBA DO?
52 ==================
53
54 Please refer to the WHATSNEW.txt included with this README for
55 a list of features in the latest Samba release.
56
57 Here is a very short list of what samba includes, and what it does. 
58 For many networks this can be simply summarized by "Samba provides 
59 a complete replacement for Windows NT, Warp, NFS or Netware servers."
60
61 - a SMB server, to provide Windows NT and LAN Manager-style file and print 
62   services to SMB clients such as Windows 95, Warp Server, smbfs and others.
63
64 - a Windows Domain Controller (NT4 and AD) replacement.
65
66 - a file/print server that can act as a member of a Windows NT 4.0
67   or Active Directory domain.
68
69 - a NetBIOS (rfc1001/1002) nameserver, which amongst other things gives 
70   browsing support. Samba can be the master browser on your LAN if you wish.
71
72 - a ftp-like SMB client so you can access PC resources (disks and
73   printers) from UNIX, Netware, and other operating systems
74
75 - a tar extension to the client for backing up PCs
76
77 - limited command-line tool that supports some of the NT administrative
78   functionality, which can be used on Samba, NT workstation and NT server.
79
80 For a much better overview have a look at the web site at
81 http://samba.org/samba, and browse the user survey.
82
83 Related packages include:
84
85 - cifsvfs, an advanced Linux-only filesystem allowing you to mount 
86   remote SMB filesystems from PCs on your Linux box. This is included 
87   as standard with Linux 2.5 and later.
88
89 - smbfs, the previous Linux-only filesystem allowing you to mount remote SMB
90   filesystems from PCs on your Linux box. This is included as standard with
91   Linux 2.0 and later.
92
93
94
95 CONTRIBUTIONS
96 =============
97
98 If you want to contribute to the development of the software then
99 please join the mailing list. The Samba team accepts patches
100 (preferably in "diff -u" format, see http://samba.org/samba/devel/ 
101 for more details) and are always glad to receive feedback or 
102 suggestions to the address samba@lists.samba.org.  More information
103 on the various Samba mailing lists can be found at http://lists.samba.org/.
104
105 You can also get the Samba sourcecode straight from the git repository - see
106 http://wiki.samba.org/index.php/Using_Git_for_Samba_Development.
107
108 If you like a particular feature then look through the git change-log
109 (on the web at http://gitweb.samba.org/?p=samba.git;a=summary) and see
110 who added it, then send them an email.
111
112 Remember that free software of this kind lives or dies by the response
113 we get. If no one tells us they like it then we'll probably move onto
114 something else.
115
116 MORE INFO
117 =========
118
119 DOCUMENTATION
120 -------------
121
122 There is quite a bit of documentation included with the package,
123 including man pages, and lots of .html files with hints and useful
124 info. This is also available from the web page. There is a growing
125 collection of information under docs/.
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, please coodinate 
131 on the samba@samba.org mailing list.  See the next section for details 
132 on subscribing to samba mailing lists.
133
134
135 MAILING LIST
136 ------------
137
138 Please do NOT send subscription/unsubscription requests to the lists!
139
140 There is a mailing list for discussion of Samba.  For details go to
141 <http://lists.samba.org/> or send mail to <samba-subscribe@lists.samba.org>
142
143 There is also an announcement mailing list where new versions are
144 announced.  To subscribe go to <http://lists.samba.org/> or send mail
145 to <samba-announce-subscribe@lists.samba.org>.  All announcements also
146 go to the samba list, so you only need to be on one.
147
148 For details of other Samba mailing lists and for access to archives, see
149 <http://lists.samba.org/>
150
151
152 MAILING LIST ETIQUETTE
153 ----------------------
154
155 A few tips when submitting to this or any mailing list.
156
157 1. Make your subject short and descriptive. Avoid the words "help" or
158    "Samba" in the subject. The readers of this list already know that
159    a) you need help, and b) you are writing about samba (of course,
160    you may need to distinguish between Samba PDC and other file
161    sharing software). Avoid phrases such as "what is" and "how do
162    i". Some good subject lines might look like "Slow response with
163    Excel files" or "Migrating from Samba PDC to NT PDC".
164
165 2. If you include the original message in your reply, trim it so that
166    only the relevant lines, enough to establish context, are
167    included. Chances are (since this is a mailing list) we've already
168    read the original message.
169
170 3. Trim irrelevant headers from the original message in your
171    reply. All we need to see is a) From, b) Date, and c) Subject. We
172    don't even really need the Subject, if you haven't changed
173    it. Better yet is to just preface the original message with "On
174    [date] [someone] wrote:".
175
176 4. Please don't reply to or argue about spam, spam filters or viruses
177    on any Samba lists. We do have a spam filtering system that is
178    working quite well thank you very much but occasionally unwanted
179    messages slip through. Deal with it.
180
181 5. Never say "Me too." It doesn't help anyone solve the
182    problem. Instead, if you ARE having the same problem, give more
183    information. Have you seen something that the other writer hasn't
184    mentioned, which may be helpful?
185
186 6. If you ask about a problem, then come up with the solution on your
187    own or through another source, by all means post it. Someone else
188    may have the same problem and is waiting for an answer, but never
189    hears of it.
190
191 7. Give as much *relevant* information as possible such as Samba
192    release number, OS, kernel version, etc...
193
194 8. RTFM. Google. groups.google.com.
195
196
197 WEB SITE
198 --------
199
200 A Samba WWW site has been setup with lots of useful info. Connect to:
201
202 http://samba.org/
203
204 As well as general information and documentation, this also has searchable 
205 archives of the mailing list and a user survey that shows who else is using
206 this package.
207