Adding missing docs to tree.
[kai/samba-autobuild/.git] / docs / htmldocs / compiling.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 36. How to compile SAMBA</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"><link rel="home" href="index.html" title="SAMBA Project Documentation"><link rel="up" href="Appendixes.html" title="Part VI. Appendixes"><link rel="previous" href="Appendixes.html" title="Part VI. Appendixes"><link rel="next" href="Portability.html" title="Chapter 37. Portability"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 36. How to compile SAMBA</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="Appendixes.html">Prev</a> </td><th width="60%" align="center">Part VI. Appendixes</th><td width="20%" align="right"> <a accesskey="n" href="Portability.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="compiling"></a>Chapter 36. How to compile SAMBA</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jelmer</span> <span class="othername">R.</span> <span class="surname">Vernooij</span></h3><div class="affiliation"><span class="orgname">The Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:jelmer@samba.org">jelmer@samba.org</a>&gt;</tt></p></div></div></div></div><div><div class="author"><h3 class="author"><span class="surname">Someone; Jerry perhaps?</span></h3></div></div><div><p class="pubdate"> 22 May 2001 </p></div><div><p class="pubdate"> 18 March 2003 </p></div></div><div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="compiling.html#id3007789">Access Samba source code via CVS</a></dt><dd><dl><dt><a href="compiling.html#id3007797">Introduction</a></dt><dt><a href="compiling.html#id3007826">CVS Access to samba.org</a></dt></dl></dd><dt><a href="compiling.html#id3009294">Accessing the samba sources via rsync and ftp</a></dt><dt><a href="compiling.html#id3009342">Verifying Samba's PGP signature</a></dt><dt><a href="compiling.html#id3009477">Building the Binaries</a></dt><dd><dl><dt><a href="compiling.html#id3009615">Compiling samba with Active Directory support</a></dt></dl></dd><dt><a href="compiling.html#id3010510">Starting the smbd and nmbd</a></dt><dd><dl><dt><a href="compiling.html#id3010602">Starting from inetd.conf</a></dt><dt><a href="compiling.html#id3010805">Alternative: starting it as a daemon</a></dt></dl></dd><dt><a href="compiling.html#id3010900">Common Errors</a></dt></dl></div><p>
3 You can obtain the samba source from the
4 <a href="http://samba.org/" target="_top">samba website</a>. To obtain a development version, 
5 you can download samba from CVS or using rsync.
6 </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3007789"></a>Access Samba source code via CVS</h2></div></div><div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id3007797"></a>Introduction</h3></div></div><div></div></div><p>
7 Samba is developed in an open environment.  Developers use CVS
8 (Concurrent Versioning System) to &quot;checkin&quot; (also known as 
9 &quot;commit&quot;) new source code.  Samba's various CVS branches can
10 be accessed via anonymous CVS using the instructions
11 detailed in this chapter.
12 </p><p>
13 This chapter is a modified version of the instructions found at
14 <a href="http://samba.org/samba/cvs.html" target="_top">http://samba.org/samba/cvs.html</a>
15 </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id3007826"></a>CVS Access to samba.org</h3></div></div><div></div></div><p>
16 The machine samba.org runs a publicly accessible CVS 
17 repository for access to the source code of several packages, 
18 including samba, rsync, distcc, ccache and jitterbug. There are two main ways
19 of accessing the CVS server on this host.
20 </p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id3007841"></a>Access via CVSweb</h4></div></div><div></div></div><p>
21 You can access the source code via your 
22 favourite WWW browser. This allows you to access the contents of 
23 individual files in the repository and also to look at the revision 
24 history and commit logs of individual files. You can also ask for a diff 
25 listing between any two versions on the repository.
26 </p><p>
27 Use the URL : <a href="http://samba.org/cgi-bin/cvsweb" target="_top">http://samba.org/cgi-bin/cvsweb</a>
28 </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id3007871"></a>Access via cvs</h4></div></div><div></div></div><p>
29 You can also access the source code via a 
30 normal cvs client.  This gives you much more control over what you can 
31 do with the repository and allows you to checkout whole source trees 
32 and keep them up to date via normal cvs commands. This is the 
33 preferred method of access if you are a developer and not
34 just a casual browser.
35 </p><p>
36 To download the latest cvs source code, point your
37 browser at the URL :
38 <a href="http://www.cyclic.com/" target="_top">http://www.cyclic.com/</a>.
39 and click on the 'How to get cvs' link. CVS is free software under 
40 the GNU GPL (as is Samba).  Note that there are several graphical CVS clients
41 which provide a graphical interface to the sometimes mundane CVS commands.
42 Links to theses clients are also available from the Cyclic website.
43 </p><p>
44 To gain access via anonymous cvs use the following steps. 
45 For this example it is assumed that you want a copy of the 
46 samba source code. For the other source code repositories 
47 on this system just substitute the correct package name
48 </p><div class="procedure"><p class="title"><b>Procedure 36.1. Retrieving samba using CVS</b></p><ol type="1"><li><p>
49         Install a recent copy of cvs. All you really need is a 
50         copy of the cvs client binary. 
51         </p></li><li><p>
52         Run the command 
53         </p><p>
54         <b class="userinput"><tt>cvs -d :pserver:cvs@samba.org:/cvsroot login</tt></b>
55         </p></li><li><p>
56         When it asks you for a password type <b class="userinput"><tt>cvs</tt></b>.
57         </p></li><li><p>
58         Run the command 
59         </p><p>
60         <b class="userinput"><tt>cvs -d :pserver:cvs@samba.org:/cvsroot co samba</tt></b>
61         </p><p>
62         This will create a directory called samba containing the 
63         latest samba source code (i.e. the HEAD tagged cvs branch). This 
64         currently corresponds to the 3.0 development tree. 
65         </p><p>
66         CVS branches other then HEAD can be obtained by using the
67         <tt class="option">-r</tt> and defining a tag name.  A list of branch tag names 
68         can be found on the &quot;Development&quot; page of the samba web site.  A common
69         request is to obtain the latest 3.0 release code.  This could be done by 
70         using the following userinput.
71         </p><p>
72         <b class="userinput"><tt>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_3_0 samba</tt></b>
73         </p></li><li><p>
74         Whenever you want to merge in the latest code changes use 
75         the following command from within the samba directory: 
76         </p><p>
77         <b class="userinput"><tt>cvs update -d -P</tt></b>
78         </p></li></ol></div></div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3009294"></a>Accessing the samba sources via rsync and ftp</h2></div></div><div></div></div><p>
79         pserver.samba.org also exports unpacked copies of most parts of the CVS
80         tree at <a href="ftp://pserver.samba.org/pub/unpacked" target="_top">ftp://pserver.samba.org/pub/unpacked</a> and also via anonymous rsync at 
81         <a href="rsync://pserver.samba.org/ftp/unpacked/" target="_top">rsync://pserver.samba.org/ftp/unpacked/</a>. I recommend using rsync rather than ftp.
82         See <a href="http://rsync.samba.org/" target="_top">the rsync homepage</a> for more info on rsync.                       
83         </p><p>
84         The disadvantage of the unpacked trees is that they do not support automatic
85         merging of local changes like CVS does.  rsync access is most convenient 
86         for an initial install.                       
87         </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3009342"></a>Verifying Samba's PGP signature</h2></div></div><div></div></div><p>
88 In these days of insecurity, it's strongly recommended that you verify the PGP
89 signature for any source file before installing it. Even if you're not 
90 downloading from a mirror site, verifying PGP signatures should be a
91 standard reflex.
92 </p><p>
93 With that said, go ahead and download the following files:
94 </p><pre class="screen">
95 <tt class="prompt">$ </tt><b class="userinput"><tt> wget http://us1.samba.org/samba/ftp/samba-2.2.8a.tar.asc</tt></b>
96 <tt class="prompt">$ </tt><b class="userinput"><tt> wget http://us1.samba.org/samba/ftp/samba-pubkey.asc</tt></b>
97 </pre><p>
98 The first file is the PGP signature for the Samba source file; the other is the Samba public
99 PGP key itself. Import the public PGP key with:
100 </p><pre class="screen">
101         <tt class="prompt">$ </tt><b class="userinput"><tt>gpg --import samba-pubkey.asc</tt></b>
102 </pre><p>
103 And verify the Samba source code integrity with:
104 </p><pre class="screen">
105         <tt class="prompt">$ </tt><b class="userinput"><tt>gzip -d samba-2.2.8a.tar.gz</tt></b>
106         <tt class="prompt">$ </tt><b class="userinput"><tt>gpg --verify samba-2.2.8a.tar.asc</tt></b>
107 </pre><p>
108 If you receive a message like, &quot;Good signature from Samba Distribution 
109 Verification Key...&quot;
110 then all is well. The warnings about trust relationships can be ignored. An
111 example of what you would not want to see would be:
112 </p><tt class="computeroutput">
113      gpg: BAD signature from &quot;Samba Distribution Verification Key&quot;
114 </tt></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3009477"></a>Building the Binaries</h2></div></div><div></div></div><p>To do this, first run the program <b class="userinput"><tt>./configure
115         </tt></b> in the source directory. This should automatically 
116         configure Samba for your operating system. If you have unusual 
117         needs then you may wish to run</p><p><tt class="prompt">root# </tt><b class="userinput"><tt>./configure --help
118         </tt></b></p><p>first to see what special options you can enable.
119         Then executing</p><p><tt class="prompt">root# </tt><b class="userinput"><tt>make</tt></b></p><p>will create the binaries. Once it's successfully 
120         compiled you can use </p><p><tt class="prompt">root# </tt><b class="userinput"><tt>make install</tt></b></p><p>to install the binaries and manual pages. You can 
121         separately install the binaries and/or man pages using</p><p><tt class="prompt">root# </tt><b class="userinput"><tt>make installbin
122         </tt></b></p><p>and</p><p><tt class="prompt">root# </tt><b class="userinput"><tt>make installman
123         </tt></b></p><p>Note that if you are upgrading for a previous version 
124         of Samba you might like to know that the old versions of 
125         the binaries will be renamed with a &quot;.old&quot; extension. You 
126         can go back to the previous version with</p><p><tt class="prompt">root# </tt><b class="userinput"><tt>make revert
127         </tt></b></p><p>if you find this version a disaster!</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id3009615"></a>Compiling samba with Active Directory support</h3></div></div><div></div></div><p>In order to compile samba with ADS support, you need to have installed
128         on your system:</p><div class="itemizedlist"><ul type="disc"><li><p>the MIT kerberos development libraries
129             (either install from the sources or use a package). The
130             heimdal libraries will not work.</p></li><li><p>the OpenLDAP development libraries.</p></li></ul></div><p>If your kerberos libraries are in a non-standard location then
131                 remember to add the configure option 
132                 <tt class="option">--with-krb5=<i class="replaceable"><tt>DIR</tt></i></tt>.</p><p>After you run configure make sure that 
133                 <tt class="filename">include/config.h</tt> it generates contains lines like 
134                 this:</p><pre class="programlisting">
135 #define HAVE_KRB5 1
136 #define HAVE_LDAP 1
137 </pre><p>If it doesn't then configure did not find your krb5 libraries or
138         your ldap libraries. Look in <tt class="filename">config.log</tt> to figure
139         out why and fix it.</p><div xmlns:ns99="" class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id3010424"></a>Installing the required packages for Debian</h4></div></div><div></div></div><p>On Debian you need to install the following packages:</p><ns99:p>
140                 </ns99:p><table class="simplelist" border="0" summary="Simple list"><tr><td>libkrb5-dev</td></tr><tr><td>krb5-user</td></tr></table><ns99:p>
141         </ns99:p></div><div xmlns:ns100="" class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id3010457"></a>Installing the required packages for RedHat</h4></div></div><div></div></div><p>On RedHat this means you should have at least: </p><ns100:p>
142                 </ns100:p><table class="simplelist" border="0" summary="Simple list"><tr><td>krb5-workstation (for kinit)</td></tr><tr><td>krb5-libs (for linking with)</td></tr><tr><td>krb5-devel (because you are compiling from source)</td></tr></table><ns100:p>
143         </ns100:p><p>in addition to the standard development environment.</p><p>Note that these are not standard on a RedHat install, and you may need
144         to get them off CD2.</p></div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3010510"></a>Starting the <span class="application">smbd</span> and <span class="application">nmbd</span></h2></div></div><div></div></div><p>You must choose to start <span class="application">smbd</span> and <span class="application">nmbd</span> either
145         as daemons or from <span class="application">inetd</span>Don't try
146         to do both!  Either you can put them in <tt class="filename">
147         inetd.conf</tt> and have them started on demand
148         by <span class="application">inetd</span>, or you can start them as
149         daemons either from the command line or in <tt class="filename">
150         /etc/rc.local</tt>. See the man pages for details
151         on the command line options. Take particular care to read
152         the bit about what user you need to be in order to start
153         Samba.  In many cases you must be root.</p><p>The main advantage of starting <span class="application">smbd</span>
154         and <span class="application">nmbd</span> using the recommended daemon method
155         is that they will respond slightly more quickly to an initial connection
156         request.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id3010602"></a>Starting from inetd.conf</h3></div></div><div></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The following will be different if 
157                 you use NIS, NIS+ or LDAP to distribute services maps.</p></div><p>Look at your <tt class="filename">/etc/services</tt>. 
158                 What is defined at port 139/tcp. If nothing is defined 
159                 then add a line like this:</p><pre class="programlisting">netbios-ssn     139/tcp</pre><p>similarly for 137/udp you should have an entry like:</p><pre class="programlisting">netbios-ns        137/udp</pre><p>Next edit your <tt class="filename">/etc/inetd.conf</tt> 
160                 and add two lines something like this:</p><pre class="programlisting">
161                 netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd smbd 
162                 netbios-ns dgram udp wait root /usr/local/samba/bin/nmbd nmbd 
163                 </pre><p>The exact syntax of <tt class="filename">/etc/inetd.conf</tt> 
164                 varies between unixes. Look at the other entries in inetd.conf 
165                 for a guide.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Some unixes already have entries like netbios_ns 
166                 (note the underscore) in <tt class="filename">/etc/services</tt>. 
167                 You must either edit <tt class="filename">/etc/services</tt> or
168                 <tt class="filename">/etc/inetd.conf</tt> to make them consistent.
169                 </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>On many systems you may need to use the 
170                 <i class="parameter"><tt>interfaces</tt></i> option in <tt class="filename">smb.conf</tt> to specify the IP
171                 address and netmask of your interfaces. Run 
172                 <span class="application">ifconfig</span> 
173                 as root if you don't know what the broadcast is for your
174                 net. <span class="application">nmbd</span> tries to determine it at run 
175                 time, but fails on some unixes. 
176                 </p></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Many unixes only accept around 5 
177                 parameters on the command line in <tt class="filename">inetd.conf</tt>. 
178                 This means you shouldn't use spaces between the options and 
179                 arguments, or you should use a script, and start the script 
180                 from <b class="command">inetd</b>.</p></div><p>Restart <span class="application">inetd</span>, perhaps just send 
181                         it a HUP. If you have installed an earlier version of <span class="application">nmbd</span> then
182                         you may need to kill <span class="application">nmbd</span> as well.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id3010805"></a>Alternative: starting it as a daemon</h3></div></div><div></div></div><p>To start the server as a daemon you should create 
183                 a script something like this one, perhaps calling 
184                 it <tt class="filename">startsmb</tt>.</p><pre class="programlisting">
185                 #!/bin/sh
186                 /usr/local/samba/bin/smbd -D 
187                 /usr/local/samba/bin/nmbd -D 
188                 </pre><p>then make it executable with <b class="command">chmod 
189                 +x startsmb</b></p><p>You can then run <b class="command">startsmb</b> by 
190                 hand or execute it from <tt class="filename">/etc/rc.local</tt>
191                 </p><p>To kill it send a kill signal to the processes 
192                         <span class="application">nmbd</span> and <span class="application">smbd</span>.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>If you use the SVR4 style init system then 
193                 you may like to look at the <tt class="filename">examples/svr4-startup</tt>
194                 script to make Samba fit into that system.</p></div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3010900"></a>Common Errors</h2></div></div><div></div></div><p>&#8220;<span class="quote">
195 I'm using gcc 3 and I've compiled Samba-3 from the CVS and the 
196 binaries are very large files (40 Mb and 20 Mb). I've the same result with
197 <tt class="option">--enable-shared</tt>  ?
198 </span>&#8221;
199 </p><p>
200 The dwarf format used by GCC 3 for storing debugging symbols is very inefficient.       
201 Strip the binaries, don't compile with -g or compile with -gstabs.
202 </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="Appendixes.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="Appendixes.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="Portability.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Part VI. Appendixes </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 37. Portability</td></tr></table></div></body></html>