From 40006cf2127df247dd6fc2200b3fac4021c1c9d8 Mon Sep 17 00:00:00 2001
From: Andreas Schneider <asn@samba.org>
Date: Wed, 31 Aug 2011 12:13:22 +0200
Subject: doc: Reflect the latest changes to the rpc_server option.

bug #8425.
---
 docs-xml/smbdotconf/misc/rpcserver.xml | 84 ++++++++++++++++++++++++++--------
 1 file changed, 66 insertions(+), 18 deletions(-)

(limited to 'docs-xml')

diff --git a/docs-xml/smbdotconf/misc/rpcserver.xml b/docs-xml/smbdotconf/misc/rpcserver.xml
index d92d203d07..6984668835 100644
--- a/docs-xml/smbdotconf/misc/rpcserver.xml
+++ b/docs-xml/smbdotconf/misc/rpcserver.xml
@@ -5,42 +5,90 @@
                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 <description>
 	<para>
-	Defines what kind of rpc server to use for a named pipe.
-	The rpc_server prefix must be followed by the pipe name, and a value.
+		With this option you can define if a rpc service should be
+		running internal/embedded in smbd or should be redirected to an
+		external daemon like Samba4, the endpoint mapper daemon, the
+		spoolss daemon or the new LSA service daemon. The rpc_server
+		prefix must be followed by the pipe name, and a value.
 	</para>
 
 	<para>
-	Three possible values are currently supported:
+		This option can be set for each available rpc service in Samba.
+		The following list shows all available pipe names services you
+		can modify with this options.
+	</para>
+
+	<itemizedlist>
+		<listitem><para>epmapper     - Endpoint Mapper</para></listitem>
+		<listitem><para>winreg       - Remote Registry Service</para></listitem>
+		<listitem><para>srvsvc       - Remote Server Services</para></listitem>
+		<listitem><para>lsarpc       - Local Security Authority</para></listitem>
+		<listitem><para>samr         - Security Account Management</para></listitem>
+		<listitem><para>netlogon     - Netlogon Remote Protocol</para></listitem>
+		<listitem><para>netdfs       - Settings for Distributed File System</para></listitem>
+		<listitem><para>dssetup      - Active Directory Setup</para></listitem>
+		<listitem><para>wkssvc       - Workstation Services</para></listitem>
+		<listitem><para>spoolss      - Network Printing Spooler</para></listitem>
+		<listitem><para>svcctl       - Service Control</para></listitem>
+		<listitem><para>ntsvcs       - Plug and Play Services</para></listitem>
+		<listitem><para>eventlog     - Event Logger</para></listitem>
+		<listitem><para>initshutdown - Init Shutdown Service</para></listitem>
+	</itemizedlist>
+
+	<para>
+		Three possible values currently supported are:
 		<command moreinfo="none">embedded</command>
-		<command moreinfo="none">daemon</command>
 		<command moreinfo="none">external</command>
+		<command moreinfo="none">disabled</command>
+	</para>
+
+	<para>
+		The classic method is to run every pipe as an internal function
+		<emphasis>embedded</emphasis> in smbd. The defaults may vary
+		depending on the service.
 	</para>
 
 	<para>
-	The classic method is to run every pipe as an internal function
-	<emphasis>embedded</emphasis> in smbd.
+		Choosing the <emphasis>external</emphasis> option allows to run
+		separate daemon or even a completely independent (3rd party)
+		server capable of interfacing with samba via the MS-RPC
+		interface over named pipes.
 	</para>
 
 	<para>
-	An alternative method is to fork a <emphasis>daemon</emphasis>
-	early on at smbd startup time. This is supported only for selected
-	pipes.
+		Currently in Samba3 we support thre daemons, spoolssd, epmd and
+		lsasd. These daemons can be enabled using the
+		<emphasis>rpc_daemon</emphasis> option. For spoolssd you have
+		to to enable the deamon and proxy the named pipe with:
+		Currently in Samba3 we support thre daemons, spoolssd, epmd and
+		lsasd. These daemons can be enabled using the
+		<emphasis>rpc_daemon</emphasis> option.
 	</para>
 
 	<para>
-	Choosing the <emphasis>external</emphasis> option allows to run a
-	completely independent (3rd party) server capable of interfacing
-	with samba via the MS-RPC interface over named pipes.
+		Examples:
+		<programlisting>
+			rpc_daemon:lsasd = fork
+			rpc_server:lsarpc = external
+			rpc_server:samr = external
+			rpc_server:netlogon = external
+
+			rpc_server:spoolss = external
+			rpc_server:epmapper = disabled
+		</programlisting>
 	</para>
 
 	<para>
-	Currently only the spoolss pipe can be configured in
-	<emphasis>daemon</emphasis> mode like this:
-	<programlisting>
-	rpc_server:spoolss = daemon
-	</programlisting>
+		There is one special option which allows you to enable rpc
+		services to listen for ncacn_ip_tcp connections too. Currently
+		this is only used for testing and doesn't scale!
+
+		<programlisting>
+			rpc_server:tcpip = yes
+		</programlisting>
 	</para>
+
 </description>
 
-<value type="default">none</value>
+<value type="default">embedded</value>
 </samba:parameter>
-- 
cgit