summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/logon
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/logon')
-rw-r--r--docs/smbdotconf/logon/adduserscript.xml64
-rw-r--r--docs/smbdotconf/logon/addusertogroupscript.xml15
-rw-r--r--docs/smbdotconf/logon/logonpath.xml26
-rw-r--r--docs/smbdotconf/logon/logonscript.xml11
-rw-r--r--docs/smbdotconf/logon/shutdownscript.xml5
5 files changed, 65 insertions, 56 deletions
diff --git a/docs/smbdotconf/logon/adduserscript.xml b/docs/smbdotconf/logon/adduserscript.xml
index 1dd71b3867..8f50bc0a69 100644
--- a/docs/smbdotconf/logon/adduserscript.xml
+++ b/docs/smbdotconf/logon/adduserscript.xml
@@ -4,39 +4,45 @@
advanced="1" developer="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>This is the full pathname to a script that will
- be run <emphasis>AS ROOT</emphasis> by <citerefentry><refentrytitle>smbd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> under special circumstances described below.</para>
+ <para>
+ This is the full pathname to a script that will be run <emphasis>AS ROOT</emphasis> by
+ <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>
+ under special circumstances described below.
+ </para>
- <para>Normally, a Samba server requires that UNIX users are
- created for all users accessing files on this server. For sites
- that use Windows NT account databases as their primary user database
- creating these users and keeping the user list in sync with the
- Windows NT PDC is an onerous task. This option allows smbd to create the required UNIX users
- <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.</para>
+ <para>
+ Normally, a Samba server requires that UNIX users are created for all users accessing
+ files on this server. For sites that use Windows NT account databases as their primary
+ user database creating these users and keeping the user list in sync with the Windows
+ NT PDC is an onerous task. This option allows smbd to create the required UNIX users
+ <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.
+ </para>
- <para>In order to use this option, <citerefentry><refentrytitle>smbd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> must <emphasis>NOT</emphasis> be set to <parameter moreinfo="none">security = share</parameter>
- and <parameter moreinfo="none">add user script</parameter>
- must be set to a full pathname for a script that will create a UNIX
- user given one argument of <parameter moreinfo="none">%u</parameter>, which expands into
- the UNIX user name to create.</para>
+ <para>
+ In order to use this option, <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> must <emphasis>NOT</emphasis> be set to
+ <smbconfoption name="security">share</smbconfoption> and <smbconfoption name="add user script"/>
+ must be set to a full pathname for a script that will create a UNIX user given one argument of
+ <parameter moreinfo="none">%u</parameter>, which expands into the UNIX user name to create.
+ </para>
- <para>When the Windows user attempts to access the Samba server,
- at login (session setup in the SMB protocol) time, <citerefentry><refentrytitle>smbd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> contacts the <parameter moreinfo="none">password server</parameter> and
- attempts to authenticate the given user with the given password. If the
- authentication succeeds then <command moreinfo="none">smbd</command>
- attempts to find a UNIX user in the UNIX password database to map the
- Windows user into. If this lookup fails, and <parameter moreinfo="none">add user script
- </parameter> is set then <command moreinfo="none">smbd</command> will
- call the specified script <emphasis>AS ROOT</emphasis>, expanding
- any <parameter moreinfo="none">%u</parameter> argument to be the user name to create.</para>
+ <para>
+ When the Windows user attempts to access the Samba server, at login (session setup in
+ the SMB protocol) time, <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> contacts the <smbconfoption name="password server"/>
+ and attempts to authenticate the given user with the given password. If the authentication
+ succeeds then <command moreinfo="none">smbd</command> attempts to find a UNIX user in the UNIX
+ password database to map the Windows user into. If this lookup fails, and
+ <smbconfoption name="add user script"/> is set then <command moreinfo="none">smbd</command> will
+ call the specified script <emphasis>AS ROOT</emphasis>, expanding any
+ <parameter moreinfo="none">%u</parameter> argument to be the user name to create.
+ </para>
- <para>If this script successfully creates the user then <command moreinfo="none">smbd
- </command> will continue on as though the UNIX user
- already existed. In this way, UNIX users are dynamically created to
- match existing Windows NT accounts.</para>
+ <para>
+ If this script successfully creates the user then <command moreinfo="none">smbd</command> will
+ continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to
+ match existing Windows NT accounts.
+ </para>
<para>
See also <smbconfoption name="security"/>, <smbconfoption name="password server"/>,
diff --git a/docs/smbdotconf/logon/addusertogroupscript.xml b/docs/smbdotconf/logon/addusertogroupscript.xml
index 62ebfe5654..f7eb410024 100644
--- a/docs/smbdotconf/logon/addusertogroupscript.xml
+++ b/docs/smbdotconf/logon/addusertogroupscript.xml
@@ -4,16 +4,17 @@
advanced="1" developer="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>Full path to the script that will be called when
- a user is added to a group using the Windows NT domain administration
- tools. It will be run by <citerefentry><refentrytitle>smbd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> <emphasis>AS ROOT</emphasis>.
- Any <parameter moreinfo="none">%g</parameter> will be replaced with the group name and
+ <para>
+ Full path to the script that will be called when a user is added to a group using the Windows NT domain administration
+ tools. It will be run by <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>
+ <emphasis>AS ROOT</emphasis>. Any <parameter moreinfo="none">%g</parameter> will be replaced with the group name and
any <parameter moreinfo="none">%u</parameter> will be replaced with the user name.
</para>
- <para>Note that the <command>adduser</command> command used in the example below does
- not support the used syntax on all systems. </para>
+ <para>
+ Note that the <command>adduser</command> command used in the example below does
+ not support the used syntax on all systems.
+ </para>
</description>
<value type="default"></value>
diff --git a/docs/smbdotconf/logon/logonpath.xml b/docs/smbdotconf/logon/logonpath.xml
index b8dd04ee0d..f281284d70 100644
--- a/docs/smbdotconf/logon/logonpath.xml
+++ b/docs/smbdotconf/logon/logonpath.xml
@@ -38,18 +38,16 @@
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine.
</para>
- <warning>
- <para>
- Do not quote the value. Setting this as <quote>\\%N\profile\%U</quote>
- will break profile handling. Where the tdbsam or ldapsam passdb backend
- is used, at the time the user account is created the value configured
- for this parameter is written to the passdb backend and that value will
- over-ride the parameter value present in the smb.conf file. Any error
- present in the passdb backend account record must be editted using the
- appropriate tool (pdbedit on the command-line, or any other locally
- provided system tool.
- </para>
- </warning>
+ <warning><para>
+ Do not quote the value. Setting this as <quote>\\%N\profile\%U</quote>
+ will break profile handling. Where the tdbsam or ldapsam passdb backend
+ is used, at the time the user account is created the value configured
+ for this parameter is written to the passdb backend and that value will
+ over-ride the parameter value present in the smb.conf file. Any error
+ present in the passdb backend account record must be editted using the
+ appropriate tool (pdbedit on the command-line, or any other locally
+ provided system tool.
+ </para></warning>
<para>Note that this option is only useful if Samba is set up as a domain controller.</para>
@@ -63,9 +61,9 @@
<para>
An example of use is:
-<screen>
+<programlisting>
logon path = \\PROFILESERVER\PROFILE\%U
-</screen>
+</programlisting>
</para>
</description>
<value type="default">\\%N\%U\profile</value>
diff --git a/docs/smbdotconf/logon/logonscript.xml b/docs/smbdotconf/logon/logonscript.xml
index 13ce9a0c03..5b304514d0 100644
--- a/docs/smbdotconf/logon/logonscript.xml
+++ b/docs/smbdotconf/logon/logonscript.xml
@@ -15,17 +15,20 @@
service specifies a <smbconfoption name="path"/> of <filename
moreinfo="none">/usr/local/samba/netlogon</filename>, and <smbconfoption name="logon
script">STARTUP.BAT</smbconfoption>, then the file that will be downloaded is:
- <screen>
+<programlisting>
/usr/local/samba/netlogon/STARTUP.BAT
- </screen>
+</programlisting>
</para>
<para>
The contents of the batch file are entirely your choice. A suggested command would be to add <command
moreinfo="none">NET TIME \\SERVER /SET /YES</command>, to force every machine to synchronize clocks with the
same time server. Another use would be to add <command moreinfo="none">NET USE U: \\SERVER\UTILS</command>
- for commonly used utilities, or <screen> <userinput>NET USE Q: \\SERVER\ISO9001_QA</userinput></screen> for
- example.
+ for commonly used utilities, or
+<programlisting>
+<userinput>NET USE Q: \\SERVER\ISO9001_QA</userinput>
+</programlisting>
+ for example.
</para>
<para>
diff --git a/docs/smbdotconf/logon/shutdownscript.xml b/docs/smbdotconf/logon/shutdownscript.xml
index 00edf7e4b7..6183540c3f 100644
--- a/docs/smbdotconf/logon/shutdownscript.xml
+++ b/docs/smbdotconf/logon/shutdownscript.xml
@@ -49,8 +49,9 @@ let &quot;time++&quot;
/sbin/shutdown $3 $4 +$time $1 &amp;
</programlisting>
-Shutdown does not return so we need to launch it in background.
-</para>
+ Shutdown does not return so we need to launch it in background.
+ </para>
+
</description>
<related>abort shutdown script</related>
<value type="default"></value>