diff options
| -rw-r--r-- | docs/docbook/projdoc/ADS-HOWTO.sgml | 2 | ||||
| -rw-r--r-- | docs/docbook/projdoc/Browsing.sgml | 102 | ||||
| -rw-r--r-- | docs/docbook/projdoc/Bugs.sgml | 24 | ||||
| -rw-r--r-- | docs/docbook/projdoc/Compiling.sgml | 42 | ||||
| -rw-r--r-- | docs/docbook/projdoc/PAM-Authentication-And-Samba.sgml | 2 |
5 files changed, 84 insertions, 88 deletions
diff --git a/docs/docbook/projdoc/ADS-HOWTO.sgml b/docs/docbook/projdoc/ADS-HOWTO.sgml index 5e93c62876..8146df0781 100644 --- a/docs/docbook/projdoc/ADS-HOWTO.sgml +++ b/docs/docbook/projdoc/ADS-HOWTO.sgml @@ -125,7 +125,7 @@ server? Does it have an encoding type of DES-CBC-MD5 ? <para> On your Samba server try to login to a Win2000 server or your Samba server using smbclient and kerberos. Use smbclient as usual, but -specify the -k option to choose kerberos authentication. +specify the <parameter>-k</parameter> option to choose kerberos authentication. </para> </sect1> diff --git a/docs/docbook/projdoc/Browsing.sgml b/docs/docbook/projdoc/Browsing.sgml index 2de0f446a6..43cc498618 100644 --- a/docs/docbook/projdoc/Browsing.sgml +++ b/docs/docbook/projdoc/Browsing.sgml @@ -16,7 +16,7 @@ <para> SMB networking provides a mechanism by which clients can access a list -of machines in a network, a so-called "browse list". This list +of machines in a network, a so-called <command>browse list</command>. This list contains machines that are ready to offer file and/or print services to other machines within the network. Thus it does not include machines which aren't currently able to do server tasks. The browse @@ -26,7 +26,7 @@ document. </para> <para> -MS Windows 2000 and later, as with Samba-3 and later, can be +MS Windows 2000 and later, as with Samba 3 and later, can be configured to not use NetBIOS over TCP/IP. When configured this way it is imperative that name resolution (using DNS/LDAP/ADS) be correctly configured and operative. Browsing will NOT work if name resolution @@ -80,15 +80,16 @@ recommended that you use one and only one Samba server as your WINS server. <para> To get browsing to work you need to run nmbd as usual, but will need -to use the "workgroup" option in smb.conf to control what workgroup -Samba becomes a part of. +to use the <command>workgroup</command> option in <filename>smb.conf</filename> +to control what workgroup Samba becomes a part of. </para> <para> Samba also has a useful option for a Samba server to offer itself for browsing on another subnet. It is recommended that this option is only used for 'unusual' purposes: announcements over the internet, for -example. See "remote announce" in the smb.conf man page. +example. See <command>remote announce</command> in the +<filename>smb.conf</filename> man page. </para> </sect1> @@ -99,19 +100,19 @@ example. See "remote announce" in the smb.conf man page. If something doesn't work then hopefully the log.nmb file will help you track down the problem. Try a debug level of 2 or 3 for finding problems. Also note that the current browse list usually gets stored -in text form in a file called browse.dat. +in text form in a file called <filename>browse.dat</filename>. </para> <para> Note that if it doesn't work for you, then you should still be able to -type the server name as \\SERVER in filemanager then hit enter and -filemanager should display the list of available shares. +type the server name as <filename>\\SERVER</filename> in filemanager then +hit enter and filemanager should display the list of available shares. </para> <para> Some people find browsing fails because they don't have the global -"guest account" set to a valid account. Remember that the IPC$ -connection that lists the shares is done as guest, and thus you must +<command>guest account</command> set to a valid account. Remember that the +IPC$ connection that lists the shares is done as guest, and thus you must have a valid guest account. </para> @@ -125,15 +126,6 @@ server resources. </emphasis></para> <para> -Also, a lot of people are getting bitten by the problem of too many -parameters on the command line of nmbd in inetd.conf. This trick is to -not use spaces between the option and the parameter (eg: -d2 instead -of -d 2), and to not use the -B and -N options. New versions of nmbd -are now far more likely to correctly find your broadcast and network -address, so in most cases these aren't needed. -</para> - -<para> The other big problem people have is that their broadcast address, netmask or IP address is wrong (specified with the "interfaces" option in smb.conf) @@ -436,13 +428,13 @@ least set the parameter to 'no' on all these machines. </para> <para> -Machines with "<command>wins support = yes</command>" will keep a list of +Machines with <command>wins support = yes</command> will keep a list of all NetBIOS names registered with them, acting as a DNS for NetBIOS names. </para> <para> You should set up only ONE wins server. Do NOT set the -"<command>wins support = yes</command>" option on more than one Samba +<command>wins support = yes</command> option on more than one Samba server. </para> @@ -455,8 +447,8 @@ refuse to document these replication protocols Samba cannot currently participate in these replications. It is possible in the future that a Samba->Samba WINS replication protocol may be defined, in which case more than one Samba machine could be set up as a WINS server -but currently only one Samba server should have the "wins support = yes" -parameter set. +but currently only one Samba server should have the +<command>wins support = yes</command> parameter set. </para> <para> @@ -482,8 +474,8 @@ machine or its IP address. <para> Note that this line MUST NOT BE SET in the smb.conf file of the Samba server acting as the WINS server itself. If you set both the -"<command>wins support = yes</command>" option and the -"<command>wins server = <name></command>" option then +<command>wins support = yes</command> option and the +<command>wins server = <name></command> option then nmbd will fail to start. </para> @@ -572,17 +564,18 @@ master browser. </para> <para> -The "local master" parameter allows Samba to act as a local master -browser. The "preferred master" causes nmbd to force a browser -election on startup and the "os level" parameter sets Samba high -enough so that it should win any browser elections. +The <command>local master</command> parameter allows Samba to act as a +local master browser. The <command>preferred master</command> causes nmbd +to force a browser election on startup and the <command>os level</command> +parameter sets Samba high enough so that it should win any browser elections. </para> <para> If you have an NT machine on the subnet that you wish to be the local master browser then you can disable Samba from becoming a local master browser by setting the following -options in the [global] section of the smb.conf file : +options in the <command>[global]</command> section of the +<filename>smb.conf</filename> file : </para> <para> @@ -605,15 +598,16 @@ you must not set up a Samba server as a domain master browser. By default, a Windows NT Primary Domain Controller for a Domain name is also the Domain master browser for that name, and many things will break if a Samba server registers the Domain master -browser NetBIOS name (DOMAIN<1B>) with WINS instead of the PDC. +browser NetBIOS name (<replaceable>DOMAIN</replaceable><1B>) +with WINS instead of the PDC. </para> <para> For subnets other than the one containing the Windows NT PDC you may set up Samba servers as local master browsers as described. To make a Samba server a local master browser set -the following options in the [global] section of the smb.conf -file : +the following options in the <command>[global]</command> section +of the <filename>smb.conf</filename> file : </para> <para> @@ -627,10 +621,11 @@ os level = 65 <para> If you wish to have a Samba server fight the election with machines -on the same subnet you may set the "os level" parameter to lower -levels. By doing this you can tune the order of machines that +on the same subnet you may set the <command>os level</command> parameter +to lower levels. By doing this you can tune the order of machines that will become local master browsers if they are running. For -more details on this see the section "FORCING SAMBA TO BE THE MASTER" +more details on this see the section <link linkend="browse-force-master"> +Forcing samba to be the master browser</link> below. </para> @@ -639,7 +634,8 @@ If you have Windows NT machines that are members of the domain on all subnets, and you are sure they will always be running then you can disable Samba from taking part in browser elections and ever becoming a local master browser by setting following options -in the [global] section of the smb.conf file : +in the <command>[global]</command> section of the <filename>smb.conf</filename> +file : </para> <para> @@ -653,26 +649,26 @@ in the [global] section of the smb.conf file : </sect1> -<sect1> +<sect1 id="browse-force-master"> <title>Forcing samba to be the master</title> <para> -Who becomes the "master browser" is determined by an election process -using broadcasts. Each election packet contains a number of parameters +Who becomes the <command>master browser</command> is determined by an election +process using broadcasts. Each election packet contains a number of parameters which determine what precedence (bias) a host should have in the election. By default Samba uses a very low precedence and thus loses elections to just about anyone else. </para> <para> -If you want Samba to win elections then just set the "os level" global -option in smb.conf to a higher number. It defaults to 0. Using 34 +If you want Samba to win elections then just set the <command>os level</command> global +option in <filename>smb.conf</filename> to a higher number. It defaults to 0. Using 34 would make it win all elections over every other system (except other samba systems!) </para> <para> -A "os level" of 2 would make it beat WfWg and Win95, but not MS Windows +A <command>os level</command> of 2 would make it beat WfWg and Win95, but not MS Windows NT/2K Server. A MS Windows NT/2K Server domain controller uses level 32. </para> @@ -680,18 +676,18 @@ NT/2K Server. A MS Windows NT/2K Server domain controller uses level 32. <para> If you want samba to force an election on startup, then set the -"preferred master" global option in smb.conf to "yes". Samba will +<command>preferred master</command> global option in <filename>smb.conf</filename> to "yes". Samba will then have a slight advantage over other potential master browsers that are not preferred master browsers. Use this parameter with care, as if you have two hosts (whether they are windows 95 or NT or -samba) on the same local subnet both set with "preferred master" to +samba) on the same local subnet both set with <command>preferred master</command> to "yes", then periodically and continually they will force an election in order to become the local master browser. </para> <para> -If you want samba to be a "domain master browser", then it is -recommended that you also set "preferred master" to "yes", because +If you want samba to be a <command>domain master browser</command>, then it is +recommended that you also set <command>preferred master</command> to "yes", because samba will not become a domain master browser for the whole of your LAN or WAN if it is not also a local master browser on its own broadcast isolated subnet. @@ -715,8 +711,8 @@ the current domain master browser fail. <para> The domain master is responsible for collating the browse lists of multiple subnets so that browsing can occur between subnets. You can -make samba act as the domain master by setting "domain master = yes" -in smb.conf. By default it will not be a domain master. +make samba act as the domain master by setting <command>domain master = yes</command> +in <filename>smb.conf</filename>. By default it will not be a domain master. </para> <para> @@ -733,8 +729,8 @@ browse lists. <para> If you want samba to be the domain master then I suggest you also set -the "os level" high enough to make sure it wins elections, and set -"preferred master" to "yes", to get samba to force an election on +the <command>os level</command> high enough to make sure it wins elections, and set +<command>preferred master</command> to "yes", to get samba to force an election on startup. </para> @@ -804,8 +800,8 @@ that browsing and name lookups won't work. <para> Samba now supports machines with multiple network interfaces. If you -have multiple interfaces then you will need to use the "interfaces" -option in smb.conf to configure them. See smb.conf(5) for details. +have multiple interfaces then you will need to use the <command>interfaces</command> +option in smb.conf to configure them. See <filename>smb.conf(5)</filename> for details. </para> </sect1> </chapter> diff --git a/docs/docbook/projdoc/Bugs.sgml b/docs/docbook/projdoc/Bugs.sgml index 4e4f7b9084..9c6be75c8d 100644 --- a/docs/docbook/projdoc/Bugs.sgml +++ b/docs/docbook/projdoc/Bugs.sgml @@ -100,8 +100,8 @@ include = /usr/local/samba/lib/smb.conf.%m <para> then create a file -<filename>/usr/local/samba/lib/smb.conf.machine</filename> where -"machine" is the name of the client you wish to debug. In that file +<filename>/usr/local/samba/lib/smb.conf.<replaceable>machine</replaceable></filename> where +<replaceable>machine</replaceable> is the name of the client you wish to debug. In that file put any smb.conf commands you want, for example <command>log level=</command> may be useful. This also allows you to experiment with different security systems, protocol levels etc on just @@ -112,7 +112,7 @@ one machine. The <filename>smb.conf</filename> entry <command>log level =</command> is synonymous with the entry <command>debuglevel =</command> that has been used in older versions of Samba and is being retained for backwards -compatibility of smb.conf files. +compatibility of <filename>smb.conf</filename> files. </para> <para> @@ -132,7 +132,7 @@ large volume of log data. If you get a "INTERNAL ERROR" message in your log files it means that Samba got an unexpected signal while running. It is probably a segmentation fault and almost certainly means a bug in Samba (unless -you have faulty hardware or system software) +you have faulty hardware or system software). </para> <para> @@ -148,7 +148,7 @@ possible. Please make this reasonably detailed. </para> <para> -You may also find that a core file appeared in a "corefiles" +You may also find that a core file appeared in a <filename>corefiles</filename> subdirectory of the directory where you keep your samba log files. This file is the most useful tool for tracking down the bug. To use it you do this: @@ -158,13 +158,13 @@ use it you do this: <para> adding appropriate paths to smbd and core so gdb can find them. If you -don't have gdb then try "dbx". Then within the debugger use the -command "where" to give a stack trace of where the problem +don't have gdb then try <userinput>dbx</userinput>. Then within the debugger use the +command <userinput>where</userinput> to give a stack trace of where the problem occurred. Include this in your mail. </para> <para> -If you known any assembly language then do a "disass" of the routine +If you known any assembly language then do a <userinput>disass</userinput> of the routine where the problem occurred (if its in a library routine then disassemble the routine that called it) and try to work out exactly where the problem is by looking at the surrounding code. Even if you @@ -180,8 +180,8 @@ useful. Unfortunately some unixes (in particular some recent linux kernels) refuse to dump a core file if the task has changed uid (which smbd does often). To debug with this sort of system you could try to attach -to the running process using "gdb smbd PID" where you get PID from -smbstatus. Then use "c" to continue and try to cause the core dump +to the running process using <userinput>gdb smbd <replaceable>PID</replaceable></userinput> where you get <replaceable>PID</replaceable> from +<application>smbstatus</application>. Then use <userinput>c</userinput> to continue and try to cause the core dump using the client. The debugger should catch the fault and tell you where it occurred. </para> @@ -193,8 +193,8 @@ where it occurred. <para> The best sort of bug report is one that includes a fix! If you send us -patches please use <command>diff -u</command> format if your version of -diff supports it, otherwise use <command>diff -c4</command>. Make sure +patches please use <userinput>diff -u</userinput> format if your version of +diff supports it, otherwise use <userinput>diff -c4</userinput>. Make sure your do the diff against a clean version of the source and let me know exactly what version you used. </para> diff --git a/docs/docbook/projdoc/Compiling.sgml b/docs/docbook/projdoc/Compiling.sgml index a5ff783244..1578522139 100644 --- a/docs/docbook/projdoc/Compiling.sgml +++ b/docs/docbook/projdoc/Compiling.sgml @@ -107,7 +107,7 @@ on this system just substitute the correct package name </para> <para> - <command>cvs -d :pserver:cvs@samba.org:/cvsroot login</command> + <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot login</userinput> </para> <para> @@ -122,7 +122,7 @@ on this system just substitute the correct package name </para> <para> - <command>cvs -d :pserver:cvs@samba.org:/cvsroot co samba</command> + <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co samba</userinput> </para> <para> @@ -135,11 +135,11 @@ on this system just substitute the correct package name CVS branches other HEAD can be obtained by using the <parameter>-r</parameter> and defining a tag name. A list of branch tag names can be found on the "Development" page of the samba web site. A common request is to obtain the - latest 2.2 release code. This could be done by using the following command. + latest 2.2 release code. This could be done by using the following userinput. </para> <para> - <command>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_2_2 samba</command> + <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_2_2 samba</userinput> </para> </listitem> @@ -150,7 +150,7 @@ on this system just substitute the correct package name </para> <para> - <command>cvs update -d -P</command> + <userinput>cvs update -d -P</userinput> </para> </listitem> </orderedlist> @@ -180,8 +180,8 @@ on this system just substitute the correct package name <sect1> <title>Building the Binaries</title> - <para>To do this, first run the program <command>./configure - </command> in the source directory. This should automatically + <para>To do this, first run the program <userinput>./configure + </userinput> in the source directory. This should automatically configure Samba for your operating system. If you have unusual needs then you may wish to run</para> @@ -282,18 +282,18 @@ on this system just substitute the correct package name <title>Starting the smbd and nmbd</title> <para>You must choose to start smbd and nmbd either - as daemons or from <command>inetd</command>. Don't try + as daemons or from <application>inetd</application>Don't try to do both! Either you can put them in <filename> inetd.conf</filename> and have them started on demand - by <command>inetd</command>, or you can start them as + by <application>inetd</application>, or you can start them as daemons either from the command line or in <filename> /etc/rc.local</filename>. See the man pages for details on the command line options. Take particular care to read the bit about what user you need to be in order to start Samba. In many cases you must be root.</para> - <para>The main advantage of starting <command>smbd</command> - and <command>nmbd</command> using the recommended daemon method + <para>The main advantage of starting <application>smbd</application> + and <application>nmbd</application> using the recommended daemon method is that they will respond slightly more quickly to an initial connection request.</para> @@ -332,21 +332,21 @@ on this system just substitute the correct package name <para>NOTE: On many systems you may need to use the "interfaces" option in smb.conf to specify the IP address - and netmask of your interfaces. Run <command>ifconfig</command> + and netmask of your interfaces. Run <application>ifconfig</application> as root if you don't know what the broadcast is for your - net. <command>nmbd</command> tries to determine it at run - time, but fails on some unixes. See the section on "testing nmbd" - for a method of finding if you need to do this.</para> + net. <application>nmbd</application> tries to determine it at run + time, but fails on some unixes. + </para> - <para>!!!WARNING!!! Many unixes only accept around 5 + <warning><para>Many unixes only accept around 5 parameters on the command line in <filename>inetd.conf</filename>. This means you shouldn't use spaces between the options and arguments, or you should use a script, and start the script - from <command>inetd</command>.</para> + from <command>inetd</command>.</para></warning> <para>Restart <command>inetd</command>, perhaps just send - it a HUP. If you have installed an earlier version of <command> - nmbd</command> then you may need to kill nmbd as well.</para> + it a HUP. If you have installed an earlier version of <application> + nmbd</application> then you may need to kill nmbd as well.</para> </sect2> <sect2> @@ -372,9 +372,9 @@ on this system just substitute the correct package name <para>To kill it send a kill signal to the processes <command>nmbd</command> and <command>smbd</command>.</para> - <para>NOTE: If you use the SVR4 style init system then + <note><para>If you use the SVR4 style init system then you may like to look at the <filename>examples/svr4-startup</filename> - script to make Samba fit into that system.</para> + script to make Samba fit into that system.</para></note> </sect2> </sect1> </chapter> diff --git a/docs/docbook/projdoc/PAM-Authentication-And-Samba.sgml b/docs/docbook/projdoc/PAM-Authentication-And-Samba.sgml index e13a81eac5..ac9385f3de 100644 --- a/docs/docbook/projdoc/PAM-Authentication-And-Samba.sgml +++ b/docs/docbook/projdoc/PAM-Authentication-And-Samba.sgml @@ -37,7 +37,7 @@ or by editing individual files that are located in <filename>/etc/pam.d</filenam is located other than default then the path may be specified as: <programlisting> - eg: "auth required /other_path/pam_strange_module.so" + auth required /other_path/pam_strange_module.so </programlisting> </para> </note> |