docs/docbook/smbdotconf/misc/magicscript.xml

   1 <samba:parameter name="magic script"
   2                  context="S"
   3                  xmlns:samba="http://samba.org/common">
   4 <listitem>
   5         <para>This parameter specifies the name of a file which,
   6         if opened, will be executed by the server when the file is closed.
   7         This allows a UNIX script to be sent to the Samba host and
   8         executed on behalf of the connected user.</para>
   9
  10         <para>Scripts executed in this way will be deleted upon
  11         completion assuming that the user has the appropriate level
  12         of privilege and the file permissions allow the deletion.</para>
  13
  14         <para>If the script generates output, output will be sent to
  15         the file specified by the <link linkend="MAGICOUTPUT"><parameter moreinfo="none">
  16         magic output</parameter></link> parameter (see above).</para>
  17
  18         <para>Note that some shells are unable to interpret scripts
  19         containing CR/LF instead of CR as
  20         the end-of-line marker. Magic scripts must be executable
  21         <emphasis>as is</emphasis> on the host, which for some hosts and
  22         some shells will require filtering at the DOS end.</para>
  23
  24         <para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and
  25         should <emphasis>NOT</emphasis> be relied upon.</para>
  26
  27         <para>Default: <emphasis>None. Magic scripts disabled.</emphasis></para>
  28
  29         <para>Example: <command moreinfo="none">magic script = user.csh</command></para>
  30 </listitem>
  31 </samba:parameter>