Manifest

   1 Copyright (C) 1997-2001 - Samba-Team
   2
   3 The Samba package you have just unpacked contains the following:
   4
   5 Directory       Notes:
   6 =========       ======
   7
   8 docs            (Samba Documentation):
   9 ----            ----------------------
  10
  11         The Samba documentation for the 2.2 release has had all the man pages
  12         converted to DocBook v4.1 source format. Because of this the man pages
  13         are now available in both traditional man page format (in
  14         the doc/manpages directory) and in HTML format (in the
  15         docs/htmldocs directory).
  16
  17         The text documentation files have been moved into a
  18         docs/textdocs directory and are in the (slow) process
  19         of being converted to DocBook source format to allow them
  20         to be easily converted to HTML.
  21
  22         Note in particular two files - docs/textdocs/<your OS>_INSTALL.txt
  23         and docs/textdocs/DIAGNOSIS.txt.
  24
  25         There is the potential for there to be many *INSTALL.txt files, one
  26         for each OS that Samba supports. However we are moving all this into
  27         the new structure. For now, most people will be using
  28         htmldocs/UNIX_INSTALL.txt
  29
  30         Please pay close attention to all the files with a .txt extension
  31         in the docs/textdocs directory and the htmldocs/* files. Most problems
  32         can be solved by reference to the two files mentioned.
  33
  34         The FAQ documentation can be accessed starting from Samba-meta-FAQ.html,
  35         in the docs/faq directory. This is incomplete, but to quote from the
  36         abstract, it:
  37
  38         "contains overview information for the Samba suite of programs,
  39         a quick-start guide, and pointers to all other Samba documentation.
  40         Other FAQs exist for specific client and server issues, and HOWTO
  41         documents for more extended topics to do with Samba software."
  42
  43
  44 examples        (Example configuration files):
  45 --------        ------------------------------
  46
  47         Please pay close attention to the reference smb.conf file
  48         smb.conf.default that has now been included as the master guide.
  49
  50         Do read the smb.conf manual page in considering what settings are
  51         appropriate for your site.
  52
  53         There are lots of interesting examples of how people have been able
  54         to implement Samba for their use. Users may also be interested in
  55         the VFS (Virtual File System) modules under this directory.
  56
  57 SWAT:           The Samba Web Administration Tool
  58 -----           ---------------------------------
  59
  60         SWAT is a web based tool for configuring and optimising the smb.conf
  61         file. To use it, you need to have SWAT enabled in your inetd control
  62         file (for more information check the packaging directories for examples
  63         of how this can be done). Then you connect to SWAT using your favourite
  64         web browser - point it at http://hostname:901, then log on as "root"
  65         using the root password. If you log on using a non-root account SWAT
  66         will not allow the smb.conf file to be changed.
  67
  68
  69 packaging       (Only for those wishing to build binary distributions):
  70 ---------       -------------------------------------------------------
  71
  72         Currently support is included for the following Linux Distributions :
  73
  74                 Caldera, RedHat, SuSE, Mandrake, and TurboLinux.
  75
  76         Packaging support for TuboLinux is under ~samba/packaging/PHT - the
  77         previous name of the company was Pacific HiTech, hence the PHT.
  78
  79         In addition, packaging support is available for SGI and Solaris systems.
  80
  81         SCO OpenServer and SCO UnixWare have been acquired by Caldera. We expect
  82         that Caldera will in future integrate Samba into the above operating
  83         systems. UnixWare has been renamed to OpenUnix. Look under the directory
  84         ~samba/packaging/Caldera for packaging support for these platforms.
  85
  86         We hope that other Unix OS vendors will contribute their binary
  87         distribution packaging control files - and we hope to make their binary
  88         packages available on the master ftp site under:
  89
  90                 ftp://samba.org/pub/samba/Binary_Packages/"OS_Vendor"
  91
  92
  93 source          (The official Samba source files - expect more of these!):
  94 ------          ----------------------------------------------------------
  95
  96         To build your own binary files you will need a suitable ansi C
  97         compiler.
  98
  99         For Samba 2.2 the GNU autoconf system has been adopted. In
 100         order to build a default Samba for your platform cd into
 101         the source/ directory and then type :
 102
 103                 ./configure
 104
 105         followed by :
 106
 107                 make
 108
 109         To install the binaries built by the above type :
 110
 111                 make install
 112
 113         then set up your configuration files.
 114
 115         NOTE: OS Vendors who provide Samba binary packages will generally
 116         integrate all Samba files into their preferred directory locations.
 117         These may differ from the default location ALWAYS used by the Samba
 118         sources. Please be careful when upgrading a vendor provided binary
 119         distribution from files you have built yourself.
 120