X-Git-Url: http://git.samba.org/?a=blobdiff_plain;f=README;h=bdc1cb205ce54a460b311e0abf260aac8632e079;hb=c1e41d489d8b199ad1f7f1546ae50461cda0fbce;hp=70b4b76ac3553c8e6a36bfdf6c4325217e75039f;hpb=3db52feb1f3b2c07ce0b06ad4a7099fa6efe3fc7;p=samba.git diff --git a/README b/README index 70b4b76ac35..bdc1cb205ce 100644 --- a/README +++ b/README @@ -1,47 +1,53 @@ -This is version 2.0.X of Samba, the free SMB and CIFS client and -server for unix and other operating systems. Samba is maintained by -the Samba Team, who support the original author, Andrew Tridgell. +This is the release version of Samba, the free SMB and CIFS client and +server and Domain Controller for UNIX and other operating +systems. Samba is maintained by the Samba Team, who support the +original author, Andrew Tridgell. >>>> Please read THE WHOLE of this file as it gives important information >>>> about the configuration and use of Samba. -NOTE: Installation instructions may be found in - docs/textdocs/UNIX_INSTALL.txt +NOTE: Installation instructions may be found + for the file/print server and domain member in: + docs/htmldocs/Samba3-HOWTO/install.html + + For the AD DC implementation a full HOWTO is provided at: + http://wiki.samba.org/index.php/Samba4/HOWTO This software is freely distributable under the GNU public license, a copy of which you should have received with this software (in a file called COPYING). -WHAT IS SMB? -============ +WHAT IS SMB/CIFS? +================= This is a big question. The very short answer is that it is the protocol by which a lot of -PC-related machines share files and printers and other informatiuon +PC-related machines share files and printers and other information such as lists of available files and printers. Operating systems that -support this natively include Windows NT, OS/2, and Linux and add on -packages that achieve the same thing are available for DOS, Windows, -VMS, Unix of all kinds, MVS, and more. Apple Macs and some Web Browsers -can speak this protocol as well. Alternatives to SMB include -Netware, NFS, Appletalk, Banyan Vines, Decnet etc; many of these have -advantages but none are both public specifications and widely -implemented in desktop machines by default. - -The Common Internet Filesystem (CIFS) is what the new SMB initiative +support this natively include Windows 9x, Windows NT (and derivatives), +OS/2, Mac OS X and Linux. Add on packages that achieve the same +thing are available for DOS, Windows 3.1, VMS, Unix of all kinds, +MVS, and more. Some Web Browsers can speak this protocol as well +(smb://). Alternatives to SMB include Netware, NFS, Appletalk, +Banyan Vines, Decnet etc; many of these have advantages but none are +both public specifications and widely implemented in desktop machines +by default. + +The Common Internet File system (CIFS) is what the new SMB initiative is called. For details watch http://samba.org/cifs. WHY DO PEOPLE WANT TO USE SMB? ============================== -1. Many people want to integrate their Microsoft or IBM style desktop - machines with their Unix or VMS (etc) servers. +1. Many people want to integrate their Microsoft desktop clients + with their Unix servers. 2. Others want to integrate their Microsoft (etc) servers with Unix - or VMS (etc) servers. This is a different problem to integrating - desktop clients. + servers. This is a different problem to integrating desktop + clients. 3. Others want to replace protocols like NFS, DecNet and Novell NCP, especially when used with PCs. @@ -50,18 +56,26 @@ WHY DO PEOPLE WANT TO USE SMB? WHAT CAN SAMBA DO? ================== -Here is a very short list of what samba includes, and what it does. For -many networks this can be simply summarised by "Samba provides a complete -replacement for Windows NT, Warp, NFS or Netware servers." +Please refer to the WHATSNEW.txt included with this README for +a list of features in the latest Samba release. + +Here is a very short list of what samba includes, and what it does. +For many networks this can be simply summarized by "Samba provides +a complete replacement for Windows NT, Warp, NFS or Netware servers." - a SMB server, to provide Windows NT and LAN Manager-style file and print services to SMB clients such as Windows 95, Warp Server, smbfs and others. +- a Windows Domain Controller (NT4 and AD) replacement. + +- a file/print server that can act as a member of a Windows NT 4.0 + or Active Directory domain. + - a NetBIOS (rfc1001/1002) nameserver, which amongst other things gives browsing support. Samba can be the master browser on your LAN if you wish. - a ftp-like SMB client so you can access PC resources (disks and -printers) from unix, Netware and other operating systems + printers) from UNIX, Netware, and other operating systems - a tar extension to the client for backing up PCs @@ -73,54 +87,52 @@ http://samba.org/samba, and browse the user survey. Related packages include: -- smbfs, a linux-only filesystem allowing you to mount remote SMB -filesystems from PCs on your linux box. This is included as standard with -Linux 2.0 and later. +- cifsvfs, an advanced Linux-only filesystem allowing you to mount + remote SMB filesystems from PCs on your Linux box. This is included + as standard with Linux 2.5 and later. -- tcpdump-smb, a extension to tcpdump to allow you to investigate SMB -networking problems over netbeui and tcp/ip. +- smbfs, the previous Linux-only filesystem allowing you to mount remote SMB + filesystems from PCs on your Linux box. This is included as standard with + Linux 2.0 and later. -- smblib, a library of smb functions which are designed to make it -easy to smb-ise any particular application. See -ftp://samba.org/pub/samba/smblib. CONTRIBUTIONS ============= -If you want to contribute to the development of the software then +1. To contribute via GitHub + - fork the official Samba team repository on GitHub + * see https://github.com/samba-team/samba + - become familiar with the coding standards as described in README.Coding + - make sure you read the Samba copyright policy + * see https://www.samba.org/samba/devel/copyright-policy.html + - create a feature branch + - make changes + - when committing, be sure to add signed-off-by tags + * see https://wiki.samba.org/index.php/CodeReview#commit_message_tags + - send a pull request for your branch through GitHub + - this will trigger an email to the samba-technical mailing list + - discussion happens on the samba-technical mailing list as described below + - more info on using Git for Samba development can be found on the Samba Wiki + * see https://wiki.samba.org/index.php/Using_Git_for_Samba_Development + +2. If you want to contribute to the development of the software then please join the mailing list. The Samba team accepts patches -(preferably in "diff -u" format, see docs/BUGS.txt for more details) -and are always glad to receive feedback or suggestions to the address -samba-bugs@samba.org. We have recently put a new bug tracking -system into place which should help the throughput quite a lot. You -can also get the Samba sourcecode straight from the CVS tree - see -http://samba.org/cvs.html. - -You could also send hardware/software/money/jewelry or pizza -vouchers directly to Andrew. The pizza vouchers would be especially -welcome, in fact there is a special field in the survey for people who -have paid up their pizza :-) - -If you like a particular feature then look through the CVS change-log -(on the web at http://samba.org/cgi-bin/cvsweb/samba) and see -who added it, then send them an email. +(preferably in "diff -u" format, see http://samba.org/samba/devel/ +for more details) and are always glad to receive feedback or +suggestions to the address samba@lists.samba.org. More information +on the various Samba mailing lists can be found at http://lists.samba.org/. -Remember that free software of this kind lives or dies by the response -we get. If noone tells us they like it then we'll probably move onto -something else. However, as you can see from the user survey quite a lot of -people do seem to like it at the moment :-) - -Andrew Tridgell -Email: samba-bugs@samba.org +You can also get the Samba sourcecode straight from the git repository - see +http://wiki.samba.org/index.php/Using_Git_for_Samba_Development. -3 Ballow Crescent -Macgregor, A.C.T. -2615 Australia - -Samba Team -Email: samba-bugs@samba.org +If you like a particular feature then look through the git change-log +(on the web at http://gitweb.samba.org/?p=samba.git;a=summary) and see +who added it, then send them an email. +Remember that free software of this kind lives or dies by the response +we get. If no one tells us they like it then we'll probably move onto +something else. MORE INFO ========= @@ -129,46 +141,78 @@ DOCUMENTATION ------------- There is quite a bit of documentation included with the package, -including man pages, and lots of .txt files with hints and useful +including man pages, and lots of .html files with hints and useful info. This is also available from the web page. There is a growing -collection of information under docs/faq; by the next release expect -this to be the default starting point. +collection of information under docs/. A list of Samba documentation in languages other than English is available on the web page. -If you would like to help with the documentation (and we _need_ help!) -then have a look at the mailing list samba-docs, archived at -http://lists.samba.org/ +If you would like to help with the documentation, please coordinate +on the samba@samba.org mailing list. See the next section for details +on subscribing to samba mailing lists. MAILING LIST ------------ -There is a mailing list for discussion of Samba. To subscribe send -mail to listproc@samba.org with a body of "subscribe samba Your Name" -Please do NOT send this request to the list alias instead. +Please do NOT send subscription/unsubscription requests to the lists! -To send mail to everyone on the list mail to samba@listproc.anu.edu.au +There is a mailing list for discussion of Samba. For details go to + or send mail to There is also an announcement mailing list where new versions are -announced. To subscribe send mail to listproc@samba.org with a -body of "subscribe samba-announce Your Name". All announcements also -go to the samba list. +announced. To subscribe go to or send mail +to . All announcements also +go to the samba list, so you only need to be on one. For details of other Samba mailing lists and for access to archives, see -http://lists.samba.org/ + + + +MAILING LIST ETIQUETTE +---------------------- + +A few tips when submitting to this or any mailing list. + +1. Make your subject short and descriptive. Avoid the words "help" or + "Samba" in the subject. The readers of this list already know that + a) you need help, and b) you are writing about samba (of course, + you may need to distinguish between Samba PDC and other file + sharing software). Avoid phrases such as "what is" and "how do + i". Some good subject lines might look like "Slow response with + Excel files" or "Migrating from Samba PDC to NT PDC". + +2. If you include the original message in your reply, trim it so that + only the relevant lines, enough to establish context, are + included. Chances are (since this is a mailing list) we've already + read the original message. + +3. Trim irrelevant headers from the original message in your + reply. All we need to see is a) From, b) Date, and c) Subject. We + don't even really need the Subject, if you haven't changed + it. Better yet is to just preface the original message with "On + [date] [someone] wrote:". + +4. Please don't reply to or argue about spam, spam filters or viruses + on any Samba lists. We do have a spam filtering system that is + working quite well thank you very much but occasionally unwanted + messages slip through. Deal with it. + +5. Never say "Me too." It doesn't help anyone solve the + problem. Instead, if you ARE having the same problem, give more + information. Have you seen something that the other writer hasn't + mentioned, which may be helpful? +6. If you ask about a problem, then come up with the solution on your + own or through another source, by all means post it. Someone else + may have the same problem and is waiting for an answer, but never + hears of it. -NEWS GROUP ----------- +7. Give as much *relevant* information as possible such as Samba + release number, OS, kernel version, etc... -You might also like to look at the usenet news group -comp.protocols.smb as it often contains lots of useful info and is -frequented by lots of Samba users. The newsgroup was initially setup -by people on the Samba mailing list. It is not, however, exclusive to -Samba, it is a forum for discussing the SMB protocol (which Samba -implements). The samba list is gatewayed to this newsgroup. +8. RTFM. Google. groups.google.com. WEB SITE @@ -176,9 +220,9 @@ WEB SITE A Samba WWW site has been setup with lots of useful info. Connect to: -http://samba.org/samba/ +http://samba.org/ As well as general information and documentation, this also has searchable archives of the mailing list and a user survey that shows who else is using -this package. Have you registered with the survey yet? :-) +this package.