Updated Manifest for 2.0.
[tprouty/samba.git] / Manifest
1 Copyright (C) 1997-1998 - Samba-Team
2
3 The Samba package you have just unpacked contains the following:
4
5 Directory       Notes:
6 =========       ======
7 docs            (Samba Documentation):
8 --------------------------------------
9
10         The Samba documentation for the 2.0 release has had all the man pages
11         converted to YODL source format. Because of this the man pages
12         are now available in both traditional man page format (in
13         the doc/manpages directory) and in HTML format (in the 
14         docs/htmldocs directory).
15
16         The text documentation files have been moved into a
17         docs/textdocs directory and are in the (slow) process
18         of being converted to YODL source format to allow them
19         to be easily converted to HTML/SGML.
20     
21         Note in particular two files - docs/textdocs/<your OS>_INSTALL.txt 
22     and docs/textdocs/DIAGNOSIS.txt.
23
24         There is the potential for there to be many *INSTALL.txt files, one
25         for each OS that Samba supports. However we are moving all this into
26         the new structure. For now, most people will be using UNIX_INSTALL.txt.
27
28         Please pay close attention to all the files with a .txt extension
29         in the docs/textdocs directory. Most problems can be solved by reference to the 
30         two files mentioned.
31
32         The FAQ documentation can be accessed starting from Samba-meta-FAQ.html,
33         in the docs/faq directory. This is incomplete, but to quote from the 
34         abstract, it:
35         
36         "contains overview information for the Samba suite of programs, 
37         a quick-start guide, and pointers to all other Samba documentation. 
38         Other FAQs exist for specific client and server issues, and HOWTO 
39         documents for more extended topics to do with Samba software."
40
41
42 examples        (Example configuration files):
43 ----------------------------------------------
44         Please pay close attention to the reference smb.conf file
45         smb.conf.default that has now been included as the master guide.
46
47         Do read the smb.conf manual page in considering what settings are
48         appropriate for your site.
49
50
51 packaging       (Only for those wishing to build binary distributions):
52 -----------------------------------------------------------------------
53         Currently support is included for the following Linux Distributions :
54         Pacfic HiTech, RedHat and SuSE. In addition, packaging support is
55         available for SGI and Solaris systems. We hope that
56         other Unix OS vendors will contribute their binary distribution
57         packaging control files - and we hope to make their binary packages
58         available on the master ftp site under:
59                 samba.anu.edu.au/pub/samba/Binary_Packages/"OS_Vendor"
60
61
62 source          (The official Samba source files - expect more of these!):
63 --------------------------------------------------------------------------
64         To build your own binary files you will need a suitable ansi C
65         compiler.
66
67         For Samba 2.0 the GNU autoconf system has been adopted. In
68         order to build a default Samba for your platform cd into
69         the source/ directory and then type :
70
71         ./configure
72
73         followed by :
74
75         make
76
77         To install the binaries built by the above type :
78
79         make install
80  
81         then set up your configuration files.
82
83         NOTE: OS Vendors who provide Samba binary packages will generally
84         integrate all Samba files into their preferred directory locations.
85         These may differ from the default location ALWAYS used by the Samba
86         sources. Please be careful when upgrading a vendor provided binary
87         distribution from files you have built yourself.