Fix smb.conf.5.xml and friends:
[abartlet/samba.git/.git] / docs / docbook / manpages / smbmnt.8.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2 <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
3 ]>
4 <refentry id="smbmnt.8">
5
6 <refmeta>
7         <refentrytitle>smbmnt</refentrytitle>
8         <manvolnum>8</manvolnum>
9 </refmeta>
10
11
12 <refnamediv>
13         <refname>smbmnt</refname>
14         <refpurpose>helper utility for mounting SMB filesystems</refpurpose>
15 </refnamediv>
16
17 <refsynopsisdiv>
18         <cmdsynopsis>
19                 <command>smbmnt</command>
20                 <arg choice="req">mount-point</arg>
21                 <arg choice="opt">-s &lt;share&gt;</arg>
22                 <arg choice="opt">-r</arg>
23                 <arg choice="opt">-u &lt;uid&gt;</arg>
24                 <arg choice="opt">-g &lt;gid&gt;</arg>
25                 <arg choice="opt">-f &lt;mask&gt;</arg>
26                 <arg choice="opt">-d &lt;mask&gt;</arg>
27                 <arg choice="opt">-o &lt;options&gt;</arg>
28                 <arg choice="opt">-h</arg>
29         </cmdsynopsis>
30 </refsynopsisdiv>
31
32 <refsect1>
33         <title>DESCRIPTION</title>
34
35         <para><command>smbmnt</command> is a helper application used 
36         by the smbmount program to do the actual mounting of SMB shares. 
37         <command>smbmnt</command> can be installed setuid root if you want
38         normal users to be able to mount their SMB shares.</para>
39
40         <para>A setuid smbmnt will only allow mounts on directories owned
41         by the user, and that the user has write permission on.</para>
42
43         <para>The <command>smbmnt</command> program is normally invoked 
44         by <citerefentry><refentrytitle>smbmount</refentrytitle>
45         <manvolnum>8</manvolnum></citerefentry>. It should not be invoked directly by users. </para>
46
47         <para>smbmount searches the normal PATH for smbmnt. You must ensure
48         that the smbmnt version in your path matches the smbmount used.</para>
49
50 </refsect1>
51
52 <refsect1>
53         <title>OPTIONS</title>
54
55         <variablelist>
56                 <varlistentry>
57                 <term>-r</term>
58                 <listitem><para>mount the filesystem read-only 
59                 </para></listitem>
60                 </varlistentry>
61
62                 <varlistentry>
63                 <term>-u uid</term>
64                 <listitem><para>specify the uid that the files will 
65                 be owned by </para></listitem>
66                 </varlistentry>
67
68                 <varlistentry>
69                 <term>-g gid</term>
70                 <listitem><para>specify the gid that the files will be 
71                 owned by </para></listitem>
72                 </varlistentry>
73
74                 <varlistentry>
75                 <term>-f mask</term>
76                 <listitem><para>specify the octal file mask applied
77                 </para></listitem>
78                 </varlistentry>
79
80                 <varlistentry>
81                 <term>-d mask</term>
82                 <listitem><para>specify the octal directory mask 
83                 applied  </para></listitem>
84                 </varlistentry>
85
86                 <varlistentry>
87                 <term>-o options</term>
88                 <listitem><para>
89                 list of options that are passed as-is to smbfs, if this
90                 command is run on a 2.4 or higher Linux kernel.
91                 </para></listitem>
92                 </varlistentry>
93
94                 &stdarg.help;
95
96         </variablelist>
97 </refsect1>
98
99
100 <refsect1>
101         <title>AUTHOR</title>
102         
103         <para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield 
104         and others.</para>
105         
106         <para>The current maintainer of smbfs and the userspace
107         tools <command>smbmount</command>, <command>smbumount</command>,
108         and <command>smbmnt</command> is <ulink 
109         url="mailto:urban@teststation.com">Urban Widmark</ulink>.
110         The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink>
111         is the preferred place to ask questions regarding these programs.
112         </para>
113         
114         <para>The conversion of this manpage for Samba 2.2 was performed 
115         by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
116         was done by Alexander Bokovoy.</para>
117 </refsect1>
118
119 </refentry>