JHT ===> Added comment about internationaliasation and deleted dates.
[samba.git] / docs / manpages / smbrun.1
1 .TH SMBRUN 1 smbrun smbrun
2 .SH NAME
3 smbrun \- interface program between smbd and external programs
4 .SH SYNOPSIS
5 .B smbrun
6 .I shell-command
7 .SH DESCRIPTION
8 This program is part of the Samba suite.
9
10 .B smbrun
11 is a very small 'glue' program, which runs shell commands for
12 the
13 .B smbd
14 daemon (see
15 .BR smbd (8)).
16
17 It first changes to the highest effective user and group ID that it can, 
18 then runs the command line provided using the system() call. This program is
19 necessary to allow some operating systems to run external programs as non-root.
20 .SH OPTIONS
21 .I shell-command
22
23 .RS 3
24 The shell command to execute.
25
26 The command should have a fully-qualified path.
27 .RE
28 .SH ENVIRONMENT VARIABLES
29 The PATH variable set for the environment in which
30 .B smbrun
31 is executed will affect what executables are located and executed if a
32 fully-qualified path is not given in the command.
33 .SH INSTALLATION
34 The location of the server and its support files is a matter for individual
35 system administrators. The following are thus suggestions only.
36
37 It is recommended that the
38 .B smbrun
39 program be installed under the /usr/local/samba hierarchy, in a directory readable
40 by all, writeable only by root. The program should be executable by all.
41 The program should NOT be setuid or setgid!
42 .SH VERSION
43 This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
44 of the recent patches to it. These notes will necessarily lag behind 
45 development of the software, so it is possible that your version of 
46 the program has extensions or parameter semantics that differ from or are not 
47 covered by this man page. Please notify these to the address below for 
48 rectification.
49 .SH SEE ALSO
50 .BR smbd (8), 
51 .BR smb.conf (8) 
52 .SH DIAGNOSTICS
53 If
54 .B smbrun
55 cannot be located or cannot be executed by
56 .B smbd
57 then appropriate messages will be found in the
58 .B smbd
59 logs. Other diagnostics are
60 dependent on the shell-command being run. It is advisable for your shell
61 commands to issue suitable diagnostics to aid trouble-shooting.
62 .SH BUGS
63 None known.
64 .SH CREDITS
65 The original Samba software and related utilities were created by 
66 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
67 of the Source for this project.
68
69 This man page was written by Karl Auer. Bug reports to samba-bugs@anu.edu.au.
70
71 See
72 .BR smb.conf (5)
73 for a full list of contributors and details of how to 
74 submit bug reports, comments etc.