summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/misc/magicscript.xml
blob: b621f00c389718916af45c30ccf424056455e7c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<samba:parameter name="magic script"
		 context="S"
		 type="string"
		 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
	<para>This parameter specifies the name of a file which, 
	if opened, will be executed by the server when the file is closed. 
	This allows a UNIX script to be sent to the Samba host and 
	executed on behalf of the connected user.</para>

	<para>Scripts executed in this way will be deleted upon 
	completion assuming that the user has the appropriate level 
	of privilege and the file permissions allow the deletion.</para>

	<para>If the script generates output, output will be sent to 
	the file specified by the <smbconfoption name="magic output"/>
	parameter (see above).</para>

	<para>Note that some shells are unable to interpret scripts 
	containing CR/LF instead of CR as 
	the end-of-line marker. Magic scripts must be executable 
	<emphasis>as is</emphasis> on the host, which for some hosts and 
	some shells will require filtering at the DOS end.</para>

	<para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and 
		should <emphasis>NOT</emphasis> be relied upon.</para>
</description>
<value type="default"></value>
<value type="example">user.csh</value>
</samba:parameter>