docs/docbook/manpages/smbrun.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="findsmb">
   3
   4 <refmeta>
   5         <refentrytitle>smbrun</refentrytitle>
   6         <manvolnum>1</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>smbrun</refname>
  12         <refpurpose>interface program between smbd and external
  13         programs</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>smbrun</command>
  19                 <arg choice="req">&lt;shell command&gt;</arg>
  20         </cmdsynopsis>
  21 </refsynopsisdiv>
  22
  23 <refsect1>
  24         <title>DESCRIPTION</title>
  25
  26         <para>This tool is part of the <ulink url="samba.7.html">
  27         Samba</ulink> suite.</para>
  28
  29         <para><command>smbrun</command> is a very small 'glue' program,
  30         which runs shell commands for the <ulink url="smbd.8.html"><command>
  31         smbd(8)</command></ulink> daemon.</para>
  32
  33         <para>It first changes to the highest effective user and group
  34         ID that it can, then runs the command line provided using the
  35         system() call. This program is necessary to allow some operating
  36         systems to run external programs as non-root.</para>
  37 </refsect1>
  38
  39 <refsect1>
  40         <title>OPTIONS</title>
  41
  42         <variablelist>
  43                 <varlistentry>
  44                 <term>shell command</term>
  45                 <listitem><para>The shell command to execute.  The
  46                 command should have a fully-qualified path.</para></listitem>
  47                 </varlistentry>
  48         </variablelist>
  49 </refsect1>
  50
  51 <refsect1>
  52         <title>ENVIRONMENT VARIABLES</title>
  53
  54         <para>The <parameter>PATH</parameter> variable set for the
  55         environment in which <command>smbrun</command> is executed will affect
  56         what executables are located and executed if a fully-qualified path
  57         is not given in the command.</para>
  58 </refsect1>
  59
  60
  61 <refsect1>
  62         <title>DIAGNOSTICS</title>
  63
  64         <para>If <command>smbrun</command> cannot be located or cannot
  65         be executed by <ulink url="smbd.8.html"><command>smbd(8)</command>
  66         </ulink>, then appropriate messages will be found in the <command>
  67         smbd</command> logs. Other diagnostics are dependent on the shell-command
  68         being run. It is advisable for your shell commands to issue suitable
  69         diagnostics to aid trouble-shooting.</para>
  70 </refsect1>
  71
  72
  73 <refsect1>
  74         <title>VERSION</title>
  75
  76         <para>This man page is correct for version 2.2 of
  77         the Samba suite.</para>
  78 </refsect1>
  79
  80 <refsect1>
  81         <title>SEE ALSO</title>
  82         <para><ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>,
  83         <ulink url="smbclient.1.html"><command>smbclient(1)
  84         </command></ulink>, and <ulink url="nmblookup.1.html">
  85         <command>nmblookup(1)</command></ulink>
  86         </para>
  87 </refsect1>
  88
  89 <refsect1>
  90         <title>AUTHOR</title>
  91
  92         <para>The original Samba software and related utilities
  93         were created by Andrew Tridgell. Samba is now developed
  94         by the Samba Team as an Open Source project similar
  95         to the way the Linux kernel is developed.</para>
  96
  97         <para>The original Samba man pages were written by Karl Auer.
  98         The man page sources were converted to YODL format (another
  99         excellent piece of Open Source software, available at
 100         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 101         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 102         release by Jeremy Allison.  The conversion to DocBook for
 103         Samba 2.2 was done by Gerald Carter</para>
 104 </refsect1>
 105
 106 </refentry>