shutdownscript.xml   [plain text]

<samba:parameter name="shutdown script"
                 context="G"
                 advanced="1" developer="1"
                 xmlns:samba="http://samba.org/common">
<listitem>
	<para><emphasis>This parameter only exists in the HEAD cvs branch</emphasis>
	This a full path name to a script called by <citerefentry><refentrytitle>smbd</refentrytitle>                                                    
        <manvolnum>8</manvolnum></citerefentry> that should start a shutdown procedure.</para>

	<para>This command will be run as the user connected to the server.</para>

	<para>%m %t %r %f parameters are expanded:</para>
	
	<itemizedlist>
		<listitem>
			<para><parameter moreinfo="none">%m</parameter> will be substituted with the
			shutdown message sent to the server.</para>
		</listitem>
		
		<listitem>
			<para><parameter moreinfo="none">%t</parameter> will be substituted with the
			number of seconds to wait before effectively starting the
			shutdown procedure.</para>
		</listitem>
		
		<listitem>
			<para><parameter moreinfo="none">%r</parameter> will be substituted with the
			switch <emphasis>-r</emphasis>. It means reboot after shutdown
			for NT.</para>
		</listitem>
		
		<listitem>
			<para><parameter moreinfo="none">%f</parameter> will be substituted with the
			switch <emphasis>-f</emphasis>. It means force the shutdown
			even if applications do not respond for NT.</para>
		</listitem>
	</itemizedlist>

	<para>Default: <emphasis>None</emphasis>.</para>

	<para>Example: <command moreinfo="none">shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f</command></para>

	<para>Shutdown script example:
<programlisting format="linespecific">
#!/bin/bash
		
$time=0
let &quot;time/60&quot;
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>

	<para>See also <link linkend="ABORTSHUTDOWNSCRIPT">
	<parameter moreinfo="none">abort shutdown script</parameter></link>.</para>
</listitem>
</samba:parameter>