summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/misc/magicscript.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docbook/smbdotconf/misc/magicscript.xml')
-rw-r--r--docs/docbook/smbdotconf/misc/magicscript.xml28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/docbook/smbdotconf/misc/magicscript.xml b/docs/docbook/smbdotconf/misc/magicscript.xml
new file mode 100644
index 0000000000..73abb50fc5
--- /dev/null
+++ b/docs/docbook/smbdotconf/misc/magicscript.xml
@@ -0,0 +1,28 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+ <term><anchor id="MAGICSCRIPT"/>magic script (S)</term>
+ <listitem><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 <link linkend="MAGICOUTPUT"><parameter moreinfo="none">
+ magic output</parameter></link> 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>
+
+ <para>Default: <emphasis>None. Magic scripts disabled.</emphasis></para>
+ <para>Example: <command moreinfo="none">magic script = user.csh</command></para>
+ </listitem>
+ </samba:parameter>