Add new framework for smb.conf(5). Please read README before trying to compile.
[Samba/gebeck_regimport.git] / docs / docbook / smbdotconf / misc / magicscript.xml
blob73abb50fc522b5db8e9c62b0b67b6442482575aa
1 <samba:parameter xmlns:samba="http://samba.org/common">
2                 <term><anchor id="MAGICSCRIPT"/>magic script (S)</term>
3                 <listitem><para>This parameter specifies the name of a file which, 
4                 if opened, will be executed by the server when the file is closed. 
5                 This allows a UNIX script to be sent to the Samba host and 
6                 executed on behalf of the connected user.</para>
8                 <para>Scripts executed in this way will be deleted upon 
9                 completion assuming that the user has the appropriate level 
10                 of privilege and the file permissions allow the deletion.</para>
12                 <para>If the script generates output, output will be sent to 
13                 the file specified by the <link linkend="MAGICOUTPUT"><parameter moreinfo="none">
14                 magic output</parameter></link> parameter (see above).</para>
16                 <para>Note that some shells are unable to interpret scripts 
17                 containing CR/LF instead of CR as 
18                 the end-of-line marker. Magic scripts must be executable 
19                 <emphasis>as is</emphasis> on the host, which for some hosts and 
20                 some shells will require filtering at the DOS end.</para>
22                 <para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and 
23                 should <emphasis>NOT</emphasis> be relied upon.</para>
25                 <para>Default: <emphasis>None. Magic scripts disabled.</emphasis></para>
26                 <para>Example: <command moreinfo="none">magic script = user.csh</command></para>
27                 </listitem>
28                 </samba:parameter>