docs/index.html

   1 <!--#include virtual="/samba/header.html" -->
   2   <title>Samba Documentation</title>
   3 <!--#include virtual="/samba/learn_samba_menu.html" -->
   4
   5 <h2>Documentation</h2>
   6
   7 <p>The documentation (and in particular the man pages) given on this web page
   8 are taken from the latest development version of Samba. If you are using an
   9 earlier version of Samba then you may find some differences.</p>
  10
  11 <h3>Documentation</h3>
  12 <ul>
  13   <li><a href="man/manpages-3/">Samba man pages</a>. You can also download the
  14       <a href="http://www.samba.org/~samba-bugs/docs/">tarball
  15       of the daily docs build</a> which includes the HTML and PDF versions of both
  16       the Samba3-HOWTO and Samba3-ByExample.</li>
  17   <li><a href="/samba/docs/using_samba/toc.html">Using Samba, 2ed, O'Reilly
  18       &amp; Associates</a> (Feb. 2003).  (Jan 2007: The 3rd edition
  19       has been released and will be available online soon).</li>
  20   <li><a href="http://www.oregontechsupport.com/samba/">The Unofficial
  21       Samba HOWTO, by David Lechnyr</a></li>
  22   <li>PDF version of the
  23       <a href="/samba/docs/Samba24Hc13.pdf">Troubleshooting Techniques</a>
  24       chapter from the second edition of Sam's Teach Yourself Samba in 24 Hours
  25       (Dec. 2001)</li>
  26   <li><a href="/samba/ftp/slides/">Slide presentations</a> by Samba Team
  27       members</li>
  28   <li><a href="http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html">Introduction
  29       to Samba 3.0</a> by Motonobu Takahashi (written in Japanese).</li>
  30   <li><a href="http://www.linux-mag.com/2001-05/smb_01.html">Understanding
  31       the Network Neighborhood</a>, by team member Chris Hertel.  This
  32       article appeared in the May 2001 issue of <a
  33       href="http://www.linux-mag.com/">Linux Magazine</a>.</li>
  34   <li><a href="http://www.ubiqx.org/cifs/">Implementing CIFS</a>; an
  35       on-line book describing the workings and implementation
  36       of the CIFS protocol suite.</li>
  37   <li><a href="ftp://ftp.stratus.com/pub/vos/customers/samba/">Samba 2.0.x
  38       Troubleshooting guide</a> from
  39       <a href="mailto:Paul_Green@alum.mit.edu">Paul Green</a></li>
  40   <li>How to use <a href="swat_ssl.html">SWAT with SSL security (updated for OpenSSL)</a></li>
  41   <li><a href="/samba/docs/10years.html">Ten Years of Samba</a></li>
  42   <li><a href="GPL.html">Samba Licensing (GNU GPL)</a></li>
  43   <li><a href="http://tldp.org/HOWTO/Samba-Authenticated-Gateway-HOWTO.html">Samba
  44       Authenticated Gateway HOWTO</a></li>
  45 </ul>
  46
  47 <h4>Older (but hopefully still valid) misc docs</h4>
  48 <ul>
  49   <li><a href="SambaIntro.html">An Introduction to Samba</a></li>
  50   <li><a href="http://www.samba.org/cifs/docs/what-is-smb.html">What is
  51       SMB?</a></li>
  52   <li><a href="http://www.samba.org/cifs/">What is CIFS?</a></li>
  53 </ul>
  54
  55 <h4>Translations</h4>
  56 <ul>
  57   <li><a href="http://home.gna.org/sambadoc/">Samba HOWTO Collection in
  58     French</a></li>
  59   <li><a href="http://gertranssmb3.berlios.de/">Samba HOWTO Collection in German
  60   <li><a href="http://www.samba.gr.jp/project/translation/Samba3-HOWTO/
  61 ">Samba HOWTO Collection in Japanese</a></li>
  62   <li><a href="http://smb-conf.ru/">Samba 3 smb.conf man page in Russian</a></li>
  63 </ul>
  64
  65 <h3>Contributing</h3>
  66 <p>Contributions are always welcome to Samba documentation.  Like everything
  67    else concerning Samba, these docs are maintained by members of the Samba
  68    community, and any help is much appreciated.  Contributions can be simple
  69    typo corrections or a write up of new or previously undocumented
  70    features.</p>
  71
  72 <p>The documentation is located in the docs-xml directory in each release
  73    branch. Please see the
  74    <a href="http://wiki.samba.org/index.php/Using_Git_for_Samba_Development">
  75    Samba Wiki</a> for information about the release branches and a short
  76    introduction into git.</p>
  77
  78 <p>Documentation "patches" can be reported through
  79    <a href="https://bugzilla.samba.org/">bugzilla</a>. From the bugzilla home
  80    page, select 'Enter a new bug report,' choose the appropriate Samba
  81    branch, and finally, on the bug report form, specify 'Docs' in the
  82    component menu. Don't forget to attach your documentation fixes
  83    against the Docbook XML source files (not the generated man pages).</p>
  84
  85 <hr />
  86
  87 <h3><a name="SambaBook">Samba Books</a></h3>
  88
  89 <div class="book">
  90   <a href="http://www.oreilly.com/catalog/samba3/">
  91   <img src="http://www.oreilly.com/catalog/covers/0596007698_cat.gif"
  92   alt="Using Samba, 3rd ed."/></a><em>Using Samba</em> has been updated to
  93   cover recent Samba 3.0 features and expanded to address more
  94   topics.  The online version is not yet available in the Samba
  95   releases.  However, you can read a sample chapter and purchase hard copies
  96   from <a href="http://www.oreilly.com/catalog/samba3/">O'Reilly</a>.
  97 </div>
  98
  99 <div class="book">
 100   <a href="http://www.amazon.com/exec/obidos/tg/detail/-/0131453556/qid=1066665885/sr=1-1/ref=sr_1_1/102-7153927-8348145?v=glance&amp;s=books">
 101   <img src="http://images.pearsoned-ema.com/jpeg/small/0131453556.jpg" alt="Official Samba 3 HOWTO" /></a>
 102   <p>The current Samba-3 release version of the <a href="/samba/docs/man/Samba3-HOWTO/">Samba3-HOWTO</a>
 103   is available in <a href="/samba/docs/Samba3-HOWTO.pdf">PDF</a> and <a href="/samba/docs/man/Samba3-HOWTO/">HTML</a>
 104   formats.  Hard copy of this document be purchased from <a href="http://www.amazon.com/exec/obidos/tg/detail/-/0131882228">
 105   Amazon.com (title: The Official Samba-3 HOWTO and Reference Guide, Second Edition).</a></p>
 106 </div>
 107
 108 <div class="book">
 109   <a href="http://www.amazon.com/exec/obidos/tg/detail/-/0131472216/qid=1081554032/sr=8-3/ref=sr_8_xs_ap_i3_zgl14/002-4578714-9739259?v=glance&amp;s=books&amp;n=507846">
 110   <img src="http://images.pearsoned-ema.com/jpeg/small/0131472216.jpg" alt="Samba 3 By Example" /></a>
 111   <p>The current Samba-3 release version of the <a href="/samba/docs/man/Samba3-ByExample/">Samba3-ByExample</a> may be found here in
 112   <a href="/samba/docs/Samba3-ByExample.pdf">PDF</a> and <a href="/samba/docs/man/Samba3-ByExample/">HTML</a>
 113   formats. Hard copy (which includes a CDROM with all Example files) may purchased from
 114   <a href="http://www.amazon.com/exec/obidos/tg/detail/-/013188221X">Amazon.com (title: Samba-3 by Example, Second Edition).</a></p>
 115 </div>
 116
 117
 118 <div class="book">
 119     <p>Team member Chris Hertel has written a book titled <b>Implementing CIFS</b>,
 120     which explores the workings and quirks of the SMB/CIFS
 121     protocol suite.  It is aimed at network managers, security analysts, and
 122     SMB/CIFS implementors.  In the spirit of Open Source, the entire
 123     content of the book is available <a href="http://ubiqx.org/cifs/">online</a>!</p>
 124 </div>
 125
 126     <p class="plugs">More Samba Books on the <a href="/samba/books.html">Samba
 127     Books</a> page.</p>
 128
 129 <h3>Further Online Resources</h3>
 130
 131 <dl>
 132 <dt><a href="http://www.microsoft.com/mind/1196/cifs.asp">CIFS: A Common
 133     Internet File System</a></dt>
 134 <dd>Paul Leach and Dan Perry. Microsoft Interactive Developer magazine,
 135     November, 1996</dd>
 136 </dl>
 137
 138 <dl>
 139 <dt><a href="http://ubiqx.org/cifs/rfc-draft/rfc1001.html">IETF RFC 1001:
 140        Protocol Standard for a NetBIOS Service on a TCP/UDP Transport:
 141        Concepts and Methods</a></dt>
 142 <dd>IETF STD #19, March, 1987</dd>
 143 </dl>
 144
 145 <dl>
 146 <dt><a href="http://ubiqx.org/cifs/rfc-draft/rfc1002.html">IETF RFC 1002:
 147        Protocol Standard for a NetBIOS Service on a TCP/UDP Transport:
 148        Detailed Specifications</a></dt>
 149 <dd>IETF STD #19, March, 1987</dd>
 150 </dl>
 151
 152 <dl>
 153 <dt><a href="http://ubiqx.org/cifs/References.html">Implementing CIFS:
 154     References</a></dt>
 155 <dd>Christopher R. Hertel</dd>
 156 </dl>
 157
 158 <dl>
 159 <dt><a
 160 href="http://ourworld.compuserve.com/homepages/timothydevans/contents.htm">NetBIOS
 161 NetBEUI NBF Networking</a></dt>
 162 <dd>Timothy D. Evans</dd>
 163 </dl>
 164
 165 <dl>
 166 <dt><a href="http://members.tripod.com/~Gavin_Winston/NETBIOS.HTM">NetBIOS
 167     Specification</a></dt>
 168 <dd>Gavin Winston</dd>
 169 </dl>
 170
 171 <dl>
 172 <dt><a href="http://www.snia.org/tech_activities/CIFS/">SNIA CIFS
 173     specification</a></dt>
 174 <dd>Storage Network Industry Association</dd>
 175 </dl>
 176
 177 <dl>
 178 <dt><a href="http://czyborra.com/">Unicode in the Unix Environment</a></dt>
 179 <dd>Roman Czyborra</dd>
 180 </dl>
 181
 182 <!--#include virtual="/samba/footer.html" -->
 183