docs-xml/smbdotconf/misc/magicscript.xml

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