JHT ===> Added comment about internationaliasation and deleted dates.
[samba.git] / docs / INSTALL.txt
index 6455a0fe18723c83ba543b415f34710cb195dd31..ee305dc2dc5eb879221fdf93ea9809605113bdb7 100644 (file)
@@ -1,5 +1,9 @@
-HOW TO INSTALL AND TEST SAMBA
-=============================
+Contributor:   Andrew Tridgell <samba-bugs@samba.anu.edu.au>
+Date:          Unknown
+Status:                Current
+
+Subject:       HOW TO INSTALL AND TEST SAMBA
+===============================================================================
 
 
 STEP 0. Read the man pages. They contain lots of useful info that will
@@ -8,6 +12,10 @@ try something like:
 
        nroff -man smbd.8 | more
 
+Unfortunately, having said this, the man pages are sadly out of date and
+really need more effort to maintain them. Other sources of information 
+are pointed to by the Samba web site, http://samba.canberra.edu.au/pub/samba.
+
 STEP 1. Building the binaries
 
 To do this, first edit the file source/Makefile. You will find that
@@ -49,10 +57,11 @@ options.
 
 The simplest useful configuration file would be something like this:
 
-[homes]
-       workgroup = MYGROUP
-       guest ok = no
-       read only = no
+   workgroup = MYGROUP
+
+   [homes]
+      guest ok = no
+      read only = no
 
 which would allow connections by anyone with an account on the server,
 using either their login name or "homes" as the service name. (Note
@@ -143,9 +152,11 @@ You can then run startsmb by hand or execute it from /etc/rc.local
 
 To kill it send a kill signal to the processes nmbd and smbd.
 
+NOTE: If you use the SVR4 style init system then you may like to look
+at the examples/svr4-startup script to make Samba fit into that system.
 
 
-STEP 7. Try listing the shares available on your server
+STEP 6. Try listing the shares available on your server
 
 smbclient -L yourhostname 
 
@@ -160,7 +171,7 @@ details. (you can force it to list the shares without a password by
 adding the option -U% to the command line. This will not work with
 non-Samba servers)
 
-STEP 8. try connecting with the unix client. eg:
+STEP 7. try connecting with the unix client. eg:
 
 smbclient '\\yourhostname\aservice'
 
@@ -177,7 +188,7 @@ smbclient '\\bambi\fred'
 NOTE: The number of slashes to use depends on the type of shell you
 use. You may need '\\\\bambi\\fred' with some shells.
 
-STEP 9. Try connecting from a dos/WfWg/Win95/NT/os-2 client. Try
+STEP 8. Try connecting from a dos/WfWg/Win95/NT/os-2 client. Try
 mounting disks. eg:
 
 net use d: \\servername\service
@@ -225,11 +236,12 @@ setting for this to work. I do not recommend scope IDs.
 CHOOSING THE PROTOCOL LEVEL
 ===========================
 
-The SMB protocol has many dialects. Currently Samba supports 4, called
+The SMB protocol has many dialects. Currently Samba supports 5, called
 CORE, COREPLUS, LANMAN1, LANMAN2 and NT1.
 
-You can choose what protocols to support in the smb.conf file. The
-default is NT1 and that is the best for the vast majority of sites.
+You can choose what maximum protocol to support in the smb.conf
+file. The default is NT1 and that is the best for the vast majority of
+sites.
 
 In older versions of Samba you may have found it necessary to use
 COREPLUS. The limitations that led to this have mostly been fixed. It
@@ -308,7 +320,9 @@ compatability modes called DENY_FCB and DENY_DOS.
 
 You can disable share modes using "share modes = no". This may be
 useful on a heavily loaded server as the share modes code is very
-slow. 
+slow. See also the FAST_SHARE_MODES option in the Makefile for a way
+to do full share modes very fast using shared memory (if your OS
+supports it).
 
 
 MAPPING USERNAMES
@@ -317,3 +331,12 @@ MAPPING USERNAMES
 If you have different usernames on the PCs and the unix server then
 take a look at the "username map" option. See the smb.conf man page
 for details.
+
+
+OTHER CHARACTER SETS
+====================
+
+If you have problems using filenames with accented characters in them
+(like the German, French or Scandinavian character sets) then I
+recommmend you look at the "valid chars" option in smb.conf and also
+take a look at the validchars package in the examples directory.