docs/docbook/manpages/mount.cifs.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   3
   4 <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
   5 ]>
   6 <refentry id="mount.cifs.8">
   7
   8 <refmeta>
   9         <refentrytitle>mount.cifs</refentrytitle>
  10         <manvolnum>8</manvolnum>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>mount.cifs</refname>
  16         <refpurpose>mount using the Common Internet File System (CIFS)</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21
  22                 <command>mount.cifs</command>
  23                 <arg choice="req">service</arg>
  24                 <arg choice="req">mount-point</arg>
  25                 <arg choice="opt">-o options</arg>
  26         </cmdsynopsis>
  27 </refsynopsisdiv>
  28
  29 <refsect1>
  30         <title>DESCRIPTION</title>
  31
  32         <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
  33         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  34
  35         <para>mount.cifs mounts a Linux CIFS filesystem. It
  36 is usually invoked indirectly by
  37 the <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> command when using the
  38 "-t cifs" option. This command only works in Linux, and the kernel must
  39 support the cifs filesystem. The CIFS protocol is the successor to the
  40 SMB protocol and is supported by most Windows servers and many other
  41 commercial servers and Network Attached Storage appliances as well as
  42 by the popular Open Source server Samba.
  43         </para>
  44
  45         <para>
  46         The mount.cifs utility attaches the UNC name (exported network resource) to
  47         the local directory <emphasis>mount-point</emphasis>. It is possible to set the mode for mount.cifs to
  48 setuid root to allow non-root users to mount shares to directories for which they
  49 have write permission.
  50         </para>
  51
  52         <para>
  53                 Options to <emphasis>mount.cifs</emphasis> are specified as a comma-separated
  54 list of key=value pairs. It is possible to send options other
  55 than those listed here, assuming that cifs supports them. If
  56 you get mount failures, check your kernel log for errors on
  57 unknown options.
  58         </para>
  59
  60         <para><emphasis>mount.cifs</emphasis> is a daemon. After mounting it keeps running until
  61                 the mounted resource is unmounted (usually via the umount utility)
  62         </para>
  63
  64 </refsect1>
  65
  66 <refsect1>
  67         <title>OPTIONS</title>
  68         <variablelist>
  69                 <varlistentry><term>username=<replaceable>arg</replaceable></term>
  70
  71                 <listitem><para>specifies the username to connect as. If
  72                                 this is not given, then the environment variable <emphasis>USER</emphasis> is used. This option can also take the
  73 form "user%password" or "user/workgroup" or
  74 "user/workgroup%password" to allow the password and workgroup
  75 to be specified as part of the username.
  76                 </para></listitem>
  77         </varlistentry>
  78
  79         <varlistentry><term>password=<replaceable>arg</replaceable></term>
  80
  81                 <listitem><para>specifies the CIFS password. If this
  82 option is not given then the environment variable
  83 <emphasis>PASSWD</emphasis> is used. If it can find
  84 no password <emphasis>mount.cifs</emphasis> will prompt
  85 for a passeword, unless the guest option is
  86 given.
  87 </para>
  88
  89 <para>Note that password which contain the arguement delimiter
  90 character (i.e. a comma ',') will failed to be parsed correctly
  91 on the command line.  However, the same password defined
  92 in the PASSWD environment variable or a credentials file (see
  93 below) will be read correctly.
  94 </para>
  95         </listitem></varlistentry>
  96
  97         <varlistentry><term>credentials=<replaceable>filename</replaceable></term>
  98
  99                 <listitem><para>
 100                                 specifies a file that contains a username
 101                                 and/or password. The format of the file is:
 102                         </para>
 103
 104 <programlisting>
 105 .nf
 106                 username = <replaceable>value</replaceable>
 107                 password = <replaceable>value</replaceable>
 108 .fi
 109 </programlisting>
 110
 111                 <para>
 112 This is preferred over having passwords in plaintext in a
 113 shared file, such as <filename>/etc/fstab</filename>. Be sure to protect any
 114 credentials file properly.
 115                 </para>
 116         </listitem></varlistentry>
 117
 118         <varlistentry>
 119                 <term>uid=<replaceable>arg</replaceable></term>
 120
 121                 <listitem><para>sets the uid that will own all files on
 122         the mounted filesystem.
 123         It may be specified as either a username or a numeric uid.
 124         This parameter is ignored when the target server supports
 125         the CIFS Unix extensions.</para></listitem>
 126         </varlistentry>
 127
 128         <varlistentry>
 129                 <term>gid=<replaceable>arg</replaceable></term>
 130
 131                 <listitem><para>sets the gid that will own all files on
 132 the mounted filesystem.
 133 It may be specified as either a groupname or a numeric
 134 gid. This parameter is ignored when the target server supports
 135 the CIFS Unix extensions.
 136                 </para></listitem>
 137         </varlistentry>
 138
 139         <varlistentry>
 140                 <term>port=<replaceable>arg</replaceable></term>
 141
 142                 <listitem><para>sets the port number on the server to attempt to contact to negotiate
 143 CIFS support.  If the CIFS server is not listening on this port or
 144 if it is not specified, the default ports will be tried i.e.
 145 port 445 is tried and if no response then port 139 is tried.
 146                 </para></listitem>
 147         </varlistentry>
 148
 149         <varlistentry>
 150                 <term>file_mode=<replaceable>arg</replaceable></term>
 151
 152                 <listitem><para>If the server does not support the CIFS Unix extensions this
 153                                 overrides default file mode which will be used locally.</para></listitem>
 154         </varlistentry>
 155
 156         <varlistentry>
 157                 <term>dir_mode=<replaceable>arg</replaceable></term>
 158
 159                 <listitem><para>If the server does not support the CIFS Unix extensions this
 160                                 overrides the default mode for directories. </para></listitem>
 161         </varlistentry>
 162
 163         <varlistentry>
 164                 <term>ip=<replaceable>arg</replaceable></term>
 165
 166                 <listitem><para>sets the destination host or IP address.</para></listitem>
 167         </varlistentry>
 168
 169         <varlistentry>
 170                 <term>domain=<replaceable>arg</replaceable></term>
 171
 172                 <listitem><para>sets the domain (workgroup) of the user </para></listitem>
 173         </varlistentry>
 174
 175         <varlistentry>
 176                 <term>guest</term>
 177
 178                 <listitem><para>don't prompt for a password </para></listitem>
 179
 180         </varlistentry>
 181
 182         <varlistentry>
 183                 <term>ro</term>
 184
 185                 <listitem><para>mount read-only</para></listitem>
 186
 187         </varlistentry>
 188
 189         <varlistentry>
 190                 <term>rw</term>
 191                 <listitem><para>mount read-write</para></listitem>
 192         </varlistentry>
 193
 194         <varlistentry>
 195                 <term>rsize</term>
 196                 <listitem><para>default network read size</para></listitem>
 197         </varlistentry>
 198
 199         <varlistentry>
 200                 <term>wsize</term>
 201
 202                 <listitem><para>default network write size</para></listitem>
 203         </varlistentry>
 204
 205         </variablelist>
 206 </refsect1>
 207
 208 <refsect1>
 209         <title>ENVIRONMENT VARIABLES</title>
 210
 211         <para>
 212                 The variable <emphasis>USER</emphasis> may contain the username of the
 213 person using the client.  This information is used only if the
 214 protocol level is high enough to support session-level
 215 passwords. The variable can be used to set both username and
 216 password by using the format username%password.
 217         </para>
 218
 219         <para>
 220                 The variable <emphasis>PASSWD</emphasis> may contain the password of the
 221 person using the client.  This information is used only if the
 222 protocol level is high enough to support session-level
 223 passwords.
 224         </para>
 225
 226         <para>
 227                 The variable <emphasis>PASSWD_FILE</emphasis> may contain the pathname
 228 of a file to read the password from. A single line of input is
 229 read and used as the password.
 230         </para>
 231
 232 </refsect1>
 233
 234 <refsect1>
 235         <title>NOTES</title>
 236
 237         <para>This command may be used only by root.</para>
 238 </refsect1>
 239
 240 <refsect1>
 241         <title>CONFIGURATION</title>
 242                 <para>
 243 The primary mechanism for making configuration changes and for reading
 244 debug information for the cifs vfs is via the Linux /proc filesystem.
 245 In the directory /proc/fs/cifs are various configuration files and
 246 pseudo files which can display debug information.  For more
 247 information see the kernel file fs/cifs/README
 248 </para>
 249 </refsect1>
 250
 251 <refsect1>
 252         <title>BUGS</title>
 253
 254         <para>Passwords and other options containing , can not be handled.
 255 For passwords an alternative way of passing them is in a credentials
 256 file or in the PASSWD environment.</para>
 257
 258         <para>The credentials file does not handle usernames or passwords with
 259                 leading space.</para>
 260
 261         <para>
 262 Note that the typical response to a bug report is suggestion
 263 to try the latest version first. So please try doing that first,
 264 and always include which versions you use of relevant software
 265 when reporting bugs (minimum: samba, kernel, distribution)
 266 </para>
 267 </refsect1>
 268
 269
 270
 271 <refsect1>
 272         <title>VERSION</title>
 273
 274         <para>This man page is correct for version 3.0 of
 275         the Samba suite.</para>
 276 </refsect1>
 277
 278 <refsect1>
 279         <title>SEE ALSO</title>
 280         <para>
 281         Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel
 282         source tree may contain additional options and information.
 283 </para>
 284 </refsect1>
 285
 286 <refsect1>
 287         <title>AUTHOR</title>
 288
 289         <para>Steve French</para>
 290
 291         <para>The syntax and manpage were loosely based on that of smbmount. It
 292                 was converted to Docbook/XML by Jelmer Vernooij.</para>
 293
 294         <para>The current maintainer of the Linux cifs vfs and the userspace
 295                 tool <emphasis>mount.cifs</emphasis> is <ulink url="mailto:sfrench@samba.org">Steve French</ulink>.
 296                 The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink>
 297                 is the preferred place to ask questions regarding these programs.
 298         </para>
 299
 300 </refsect1>
 301
 302 </refentry>