docs/docbook/manpages/smbmount.8.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="smbmount">
   3
   4 <refmeta>
   5         <refentrytitle>smbmount</refentrytitle>
   6         <manvolnum>8</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>smbmount</refname>
  12         <refpurpose>mount and smbfs filesystem</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>smbumount</command>
  18                 <arg choice="req">service</arg>
  19                 <arg choice="req">mount-point</arg>
  20                 <arg choice="opt">-o options</arg>
  21         </cmdsynopsis>
  22 </refsynopsisdiv>
  23
  24 <refsect1>
  25         <title>DESCRIPTION</title>
  26
  27         <para><command>smbmount</command> mounts a SMB filesystem. It
  28         is usually invoked as <command>mount.smb</command> from
  29         the <command>mount(8)</command> command when using the
  30         "-t smb" option. The kernel must support the smbfs filesystem. </para>
  31
  32         <para>Options to smbmount are specified as a comma separated list
  33         of key=value pairs.</para>
  34
  35         <para><emphasis>NOTE:</emphasis> <command>smbmount</command>
  36         calls <command>smbmnt(8)</command> to do the actual mount. You
  37         must make sure that <command>smbmnt</command> is in the path so
  38         that it can be found. </para>
  39
  40 </refsect1>
  41
  42 <refsect1>
  43         <title>OPTIONS</title>
  44
  45         <variablelist>
  46                 <varlistentry>
  47                 <term>username=&lt;arg&gt;</term>
  48                 <listitem><para>specifies the username to connect as. If
  49                 this is not given then the environment variable <parameter>
  50                 $USER</parameter> is used. This option can also take the
  51                 form "user%password" or "user/workgroup" or
  52                 "user/workgroup%password" to allow the password and workgroup
  53                 to be specified as part of the username.</para></listitem>
  54                 </varlistentry>
  55
  56
  57                 <varlistentry>
  58                 <term>password=&lt;arg&gt;</term>
  59                 <listitem><para>specifies the SMB password. If not given then
  60                 <command>smbmount</command> will prompt for a passeword, unless
  61                 the guest option is given. </para></listitem>
  62                 </varlistentry>
  63
  64
  65
  66                 <varlistentry>
  67                 <term>netbiosname=&lt;arg&gt;</term>
  68                 <listitem><para>sets the source NetBIOS name. It defaults
  69                 to the local hostname. </para></listitem>
  70                 </varlistentry>
  71
  72
  73
  74                 <varlistentry>
  75                 <term>uid=&lt;arg&gt;</term>
  76                 <listitem><para>sets the uid that files will be mounted as.
  77                 It may be specified as either a username or a numeric uid.
  78                 </para></listitem>
  79                 </varlistentry>
  80
  81
  82                 <varlistentry>
  83                 <term>gid=&lt;arg&gt;</term>
  84                 <listitem><para>sets the gid that files will be mounted as.
  85                 It may be specified as either a groupname or a numeric
  86                 gid. </para></listitem>
  87                 </varlistentry>
  88
  89
  90                 <varlistentry>
  91                 <term>port=&lt;arg&gt;</term>
  92                 <listitem><para>sets the remote SMB port number. The default
  93                 is 139. </para></listitem>
  94                 </varlistentry>
  95
  96
  97                 <varlistentry>
  98                 <term>fmask=&lt;arg&gt;</term>
  99                 <listitem><para>sets the file mask. This determines the
 100                 permissions that remote files have in the local filesystem.
 101                 The default is based on the current umask. </para></listitem>
 102                 </varlistentry>
 103
 104
 105                 <varlistentry>
 106                 <term>dmask=&lt;arg&gt;</term>
 107                 <listitem><para>sets the directory mask. This deterines the
 108                 permissions that remote directories have in the local filesystem.
 109                 The default is based on the current umask. </para></listitem>
 110                 </varlistentry>
 111
 112
 113                 <varlistentry>
 114                 <term>debug=&lt;arg&gt;</term>
 115                 <listitem><para>sets the debug level. This is useful for
 116                 tracking down SMB connection problems. </para></listitem>
 117                 </varlistentry>
 118
 119
 120                 <varlistentry>
 121                 <term>ip=&lt;arg&gt;</term>
 122                 <listitem><para>sets the destination host or IP address.
 123                 </para></listitem>
 124                 </varlistentry>
 125
 126
 127
 128                 <varlistentry>
 129                 <term>workgroup=&lt;arg&gt;</term>
 130                 <listitem><para>sets the workgroup on the destination </para>
 131                 </listitem>
 132                 </varlistentry>
 133
 134
 135                 <varlistentry>
 136                 <term>sockopt=&lt;arg&gt;</term>
 137                 <listitem><para>sets the TCP socket options. See the <ulink
 138                 url="smb.conf.5.html#SOCKETOPTIONS"><filename>smb.conf
 139                 </filename></ulink> <parameter>socket options</parameter> option.
 140                 </para></listitem>
 141                 </varlistentry>
 142
 143
 144                 <varlistentry>
 145                 <term>scope=&lt;arg&gt;</term>
 146                 <listitem><para>sets the NetBIOS scope </para></listitem>
 147                 </varlistentry>
 148
 149                 <varlistentry>
 150                 <term>guest</term>
 151                 <listitem><para>don't prompt for a password </para></listitem>
 152                 </varlistentry>
 153
 154
 155                 <varlistentry>
 156                 <term>ro</term>
 157                 <listitem><para>mount read-only </para></listitem>
 158                 </varlistentry>
 159
 160                 <varlistentry>
 161                 <term>rw</term><listitem><para>mount read-write </para></listitem>
 162                 </varlistentry>
 163         </variablelist>
 164
 165
 166 </refsect1>
 167
 168
 169 <refsect1>
 170         <title>AUTHOR</title>
 171
 172         <para>The current maintainer of smbfs and the userspace
 173         tools <command>smbmount</command>, <command>smbumount</command>,
 174         and <command>smbmnt</command> is <ulink
 175         url="mailto:urban@teststation.com">Urban Widmark</ulink></para>
 176
 177         <para>The conversion of this manpage for Samba 2.2 was performed
 178         by Gerald Carter</para>
 179 </refsect1>
 180
 181 </refentry>