docs: Add missing prefixpath options for mount.cifs.
[Samba.git] / docs-xml / manpages-3 / mount.cifs.8.xml
blob21c7f609e970306ca7505fa967291ada1f43f081
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="mount.cifs.8">
5 <refmeta>
6         <refentrytitle>mount.cifs</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">3.5</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>mount.cifs</refname>
16         <refpurpose>mount using the Common Internet File System (CIFS)</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <cmdsynopsis>
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>
29 <refsect1>
30         <title>DESCRIPTION</title>
32         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
33         <manvolnum>7</manvolnum></citerefentry> suite.</para>
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>
45         <para>
46         The mount.cifs utility attaches the UNC name (exported network resource)
47         specified as <emphasis>service</emphasis> (using //server/share syntax,
48         where "server" is the server name or IP address and "share" is the name
49         of the share) to the local directory <emphasis>mount-point</emphasis>.
50         </para>
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 the cifs filesystem kernel module (cifs.ko) supports them.   
56 Unrecognized cifs mount options passed to the cifs vfs kernel code will be logged to the
57 kernel log.
59         </para>
61         <para><emphasis>mount.cifs</emphasis> causes the cifs vfs to launch a thread named cifsd. After mounting it keeps running until
62                 the mounted resource is unmounted (usually via the umount utility).
63         </para>
65         <para>
66                 <emphasis>mount.cifs -V</emphasis> command displays the version of cifs mount helper.
67         </para>
68         <para>
70                 <emphasis>modinfo cifs</emphasis> command displays the version of cifs module.
71         </para>
73 </refsect1>
75 <refsect1>
76         <title>OPTIONS</title>
77         <variablelist>
78                 <varlistentry><term>user=<replaceable>arg</replaceable></term>
80                 <listitem><para>specifies the username to connect as. If
81                                 this is not given, then the environment variable <emphasis>USER</emphasis> is used. This option can also take the
82 form "user%password" or "workgroup/user" or
83 "workgroup/user%password" to allow the password and workgroup
84 to be specified as part of the username.
85                 </para>
87 <note>
88         <para>
89         The cifs vfs accepts the parameter <parameter>user=</parameter>, or for users familiar with smbfs it accepts the longer form of the parameter <parameter>username=</parameter>.  Similarly the longer smbfs style parameter names may be accepted as synonyms for the shorter cifs parameters <parameter>pass=</parameter>,<parameter>dom=</parameter> and <parameter>cred=</parameter>.
90         </para>
91 </note>
93                 </listitem>
94         </varlistentry>
96         <varlistentry><term>password=<replaceable>arg</replaceable></term>
98                 <listitem><para>specifies the CIFS password. If this
99 option is not given then the environment variable
100 <emphasis>PASSWD</emphasis> is used. If the password is not specified
101 directly or indirectly via an argument to mount, <emphasis>mount.cifs</emphasis> will prompt
102 for a password, unless the guest option is specified.
103 </para>
105 <para>Note that a password which contains the delimiter
106 character (i.e. a comma ',') will fail to be parsed correctly
107 on the command line.  However, the same password defined
108 in the PASSWD environment variable or via a credentials file (see
109 below) or entered at the password prompt will be read correctly.
110 </para>
111         </listitem></varlistentry>
113         <varlistentry><term>credentials=<replaceable>filename</replaceable></term>
115                 <listitem><para>
116                                 specifies a file that contains a username
117                                 and/or password and optionally the name of the
118                                 workgroup. The format of the file is:
119                         </para>
121 <programlisting>
122                 username=<replaceable>value</replaceable>
123                 password=<replaceable>value</replaceable>
124                 domain=<replaceable>value</replaceable>
125 </programlisting>
127                 <para>
128 This is preferred over having passwords in plaintext in a
129 shared file, such as <filename>/etc/fstab</filename>. Be sure to protect any
130 credentials file properly.
131                 </para>
132         </listitem></varlistentry>
134         <varlistentry>
135                 <term>uid=<replaceable>arg</replaceable></term>
136                 <listitem>
138         <para>sets the uid that will own all files or directories on the
139 mounted filesystem when the server does not provide ownership
140 information. It may be specified as either a username or a numeric uid.
141 When not specified, the default is uid 0.  The mount.cifs helper must be
142 at version 1.10 or higher to support specifying the uid in non-numeric
143 form. See the section on FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS below for more
144 information.  </para>
146 </listitem>
147 </varlistentry>
149 <varlistentry>
150         <term>prefixpath=<replaceable>arg</replaceable></term>
151         <listitem>
152                 <para>
153                         It's possible to mount a subdirectory of a share. The preferred way
154                         to do this is to append the path to the UNC when mounting. However,
155                         it's also possible to do the same by setting this option and
156                         providing the path there.
157                 </para>
158         </listitem>
159 </varlistentry>
161 <varlistentry>
162         <term>forceuid</term>
163         <listitem>
164                 <para>instructs the client to ignore any uid provided by
165 the server for files and directories and to always assign the owner to
166 be the value of the uid= option. See the section on FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS below for more information.</para>
167         </listitem>
168 </varlistentry>
170 <varlistentry>
171         <term>gid=<replaceable>arg</replaceable></term>
172         <listitem>
174                 <para>sets the gid that will own all files or
175 directories on the mounted filesystem when the server does not provide
176 ownership information.  It may be specified as either a groupname or a
177 numeric gid.  When not specified, the default is gid 0. The mount.cifs
178 helper must be at version 1.10 or higher to support specifying the gid
179 in non-numeric form. See the section on FILE AND DIRECTORY OWNERSHIP AND
180 PERMISSIONS below for more information.</para>
182         </listitem>
183 </varlistentry>
185 <varlistentry>
186         <term>forcegid</term>
187         <listitem>
188                 <para>instructs the client to ignore any gid provided by
189 the server for files and directories and to always assign the owner to
190 be the value of the gid= option. See the section on FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS below for more information.</para>
191         </listitem>
192 </varlistentry>
194 <varlistentry>
195                 <term>port=<replaceable>arg</replaceable></term>
197                 <listitem><para>sets the port number on the server to attempt to contact to negotiate
198 CIFS support.  If the CIFS server is not listening on this port or
199 if it is not specified, the default ports will be tried i.e. 
200 port 445 is tried and if no response then port 139 is tried.
201                 </para></listitem>
202         </varlistentry>
204         <varlistentry>
205                 <term>servern=<replaceable>arg</replaceable></term>
207                 <listitem><para>
208                 Specify the server netbios name (RFC1001 name) to use
209                 when attempting to setup a session to the server. Although
210                 rarely needed for mounting to newer servers, this option
211                 is needed for mounting to some older servers (such
212                 as OS/2 or Windows 98 and Windows ME) since when connecting
213                 over port 139 they, unlike most newer servers, do not
214                 support a default server name.  A server name can be up
215                 to 15 characters long and is usually uppercased.
216                 </para></listitem>
217         </varlistentry>
219         <varlistentry>
220                 <term>netbiosname=<replaceable>arg</replaceable></term>
222                 <listitem><para>When mounting to servers via port 139, specifies the RFC1001
223                 source name to use to represent the client netbios machine
224                 name when doing the RFC1001 netbios session initialize.
225                 </para></listitem>
226         </varlistentry>
228         <varlistentry>
229                 <term>file_mode=<replaceable>arg</replaceable></term>
231                 <listitem><para>If the server does not support the CIFS Unix extensions this
232                                 overrides the default file mode.</para></listitem>
233         </varlistentry>
235         <varlistentry>
236                 <term>dir_mode=<replaceable>arg</replaceable></term>
238                 <listitem><para>If the server does not support the CIFS Unix extensions this
239                                 overrides the default mode for directories. </para></listitem>
240         </varlistentry>
242         <varlistentry>
243                 <term>ip=<replaceable>arg</replaceable></term>
245                 <listitem><para>sets the destination IP address.  This option is set automatically if the server name portion of the requested UNC name can be resolved so rarely needs to be specified by the user.</para></listitem>
246         </varlistentry>
248         <varlistentry>
249                 <term>domain=<replaceable>arg</replaceable></term>
251                 <listitem><para>sets the domain (workgroup) of the user </para></listitem>
252         </varlistentry>
254         <varlistentry>
255                 <term>guest</term>
257                 <listitem><para>don't prompt for a password </para></listitem>
259         </varlistentry>
261         <varlistentry>
262                 <term>iocharset</term>
264                 <listitem><para>Charset used to convert local path names to and from
265                 Unicode. Unicode is used by default for network path
266                 names if the server supports it. If iocharset is
267                 not specified then the nls_default specified
268                 during the local client kernel build will be used.
269                 If server does not support Unicode, this parameter is
270                 unused. </para></listitem>
272         </varlistentry>
274         <varlistentry>
275                 <term>ro</term>
277                 <listitem><para>mount read-only</para></listitem>
279         </varlistentry>
281         <varlistentry>
282                 <term>rw</term>
283                 <listitem><para>mount read-write</para></listitem>
284         </varlistentry>
286         <varlistentry>
287                 <term>setuids</term>
288                 <listitem><para>If the CIFS Unix extensions are negotiated with the server
289                 the client will attempt to set the effective uid and gid of
290                 the local process on newly created files, directories, and
291                 devices (create, mkdir, mknod). If the CIFS Unix Extensions
292                 are not negotiated, for newly created files and directories
293                 instead of using the default uid and gid specified on the
294                 the mount, cache the new file's uid and gid locally which means
295                 that the uid for the file can change when the inode is
296                 reloaded (or the user remounts the share).</para></listitem>
297         </varlistentry>
299         <varlistentry>
300                 <term>nosetuids</term>
301                 <listitem><para>The client will not attempt to set the uid and gid on
302                 on newly created files, directories, and devices (create,
303                 mkdir, mknod) which will result in the server setting the
304                 uid and gid to the default (usually the server uid of the
305                 user who mounted the share).  Letting the server (rather than
306                 the client) set the uid and gid is the default.If the CIFS
307                 Unix Extensions are not negotiated then the uid and gid for
308                 new files will appear to be the uid (gid) of the mounter or the
309                 uid (gid) parameter specified on the mount.</para></listitem>
310         </varlistentry>
312         <varlistentry>
313                 <term>perm</term>
314                 <listitem><para>Client does permission checks (vfs_permission check of uid
315                 and gid of the file against the mode and desired operation),
316                 Note that this is in addition to the normal ACL check on the
317                 target machine done by the server software.
318                 Client permission checking is enabled by default.</para></listitem>
319         </varlistentry>
321         <varlistentry>
322                 <term>noperm</term>
323                 <listitem><para>Client does not do permission checks.  This can expose
324                 files on this mount to access by other users on the local
325                 client system. It is typically only needed when the server
326                 supports the CIFS Unix Extensions but the UIDs/GIDs on the
327                 client and server system do not match closely enough to allow
328                 access by the user doing the mount.
329                 Note that this does not affect the normal ACL check on the
330                 target machine done by the server software (of the server
331                 ACL against the user name provided at mount time).</para></listitem>
332         </varlistentry>
334         <varlistentry>
335                 <term>dynperm</term>
336                 <listitem><para>Instructs the server to maintain ownership and
337 permissions in memory that can't be stored on the server. This information can disappear at any time (whenever the inode is flushed from the cache), so while this may help make some applications work, it's behavior is somewhat unreliable. See the section below on FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS for more information.
338                 </para></listitem>
339         </varlistentry>
341         <varlistentry>
342                 <term>directio</term>
343                 <listitem><para>Do not do inode data caching on files opened on this mount.
344                 This precludes mmaping files on this mount. In some cases
345                 with fast networks and little or no caching benefits on the
346                 client (e.g. when the application is doing large sequential
347                 reads bigger than page size without rereading the same data)
348                 this can provide better performance than the default
349                 behavior which caches reads (readahead) and writes
350                 (writebehind) through the local Linux client pagecache
351                 if oplock (caching token) is granted and held. Note that
352                 direct allows write operations larger than page size
353                 to be sent to the server. On some kernels this requires the cifs.ko module
354                 to be built with the CIFS_EXPERIMENTAL configure option.</para></listitem>
355         </varlistentry>
357         <varlistentry>
358                 <term>mapchars</term>
359                 <listitem><para>Translate six of the seven reserved characters (not backslash, but including the colon, question mark, pipe, asterik, greater than and less than characters)
360                 to the remap range (above 0xF000), which also
361                 allows the CIFS client to recognize files created with
362                 such characters by Windows's POSIX emulation. This can
363                 also be useful when mounting to most versions of Samba
364                 (which also forbids creating and opening files
365                 whose names contain any of these seven characters).
366                 This has no effect if the server does not support
367                 Unicode on the wire. Please note that the files created
368                 with mapchars mount option may not be accessible
369                 if the share is mounted without that option.</para></listitem>
370         </varlistentry>
372         <varlistentry>
373                 <term>nomapchars</term>
374                 <listitem><para>Do not translate any of these seven characters (default)</para></listitem>
375         </varlistentry>
377         <varlistentry>
378                 <term>intr</term>
379                 <listitem><para>currently unimplemented</para></listitem>
380         </varlistentry>
382         <varlistentry>
383                 <term>nointr</term>
384                 <listitem><para>(default) currently unimplemented </para></listitem>
385         </varlistentry>
387         <varlistentry>
388                 <term>hard</term>
389                 <listitem><para>The  program  accessing  a file on the cifs mounted file system will hang when the
390               server crashes.</para></listitem>
391         </varlistentry>
393         <varlistentry>
394                 <term>soft</term>
395                 <listitem><para>(default) The  program  accessing  a file on the cifs mounted file system will not hang when the server crashes and will return errors to the user application.</para></listitem>
396         </varlistentry>
398         <varlistentry>
399                 <term>noacl</term>
400                 <listitem><para>Do not allow POSIX ACL operations even if server would support them.</para><para>
401                 The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers
402                 version 3.0.10 and later.  Setting POSIX ACLs requires enabling both XATTR and
403                 then POSIX support in the CIFS configuration options when building the cifs
404                 module.  POSIX ACL support can be disabled on a per mount basis by specifying
405                 "noacl" on mount.</para>
406                 </listitem>
407         </varlistentry>
409         <varlistentry>
410                 <term>nocase</term>
411                 <listitem>
412                 <para>Request case insensitive path name matching (case
413                 sensitive is the default if the server suports it).
414                 </para>
415                 </listitem>
416         </varlistentry>
418         <varlistentry>
419                 <term>sec=</term>
420                 <listitem>
421                 <para>Security mode.  Allowed values are:</para>
422                         <itemizedlist>
423                         <listitem><para>none    attempt to connection as a null user (no name) </para></listitem>
424                         <listitem><para>krb5    Use Kerberos version 5 authentication</para></listitem>
425                         <listitem><para>krb5i   Use Kerberos authentication and packet signing</para></listitem>
426                         <listitem><para>ntlm    Use NTLM password hashing (default)</para></listitem>
427                         <listitem><para>ntlmi   Use NTLM password hashing with signing (if
428                                 /proc/fs/cifs/PacketSigningEnabled on or if
429                                 server requires signing also can be the default)</para></listitem>
430                         <listitem><para>ntlmv2  Use NTLMv2 password hashing</para></listitem>
431                         <listitem><para>ntlmv2i Use NTLMv2 password hashing with packet signing</para></listitem>
432                         </itemizedlist>
434                         <para>[NB This [sec parameter] is under development and expected to be available in cifs kernel module 1.40 and later]
435                 </para>
436                 </listitem>
437         </varlistentry>
439         <varlistentry>
440                 <term>nobrl</term>
441                 <listitem>
442                 <para>Do not send byte range lock requests to the server.
443                 This is necessary for certain applications that break
444                 with cifs style mandatory byte range locks (and most
445                 cifs servers do not yet support requesting advisory
446                 byte range locks).
447                 </para>
448                 </listitem>
449         </varlistentry>
451         <varlistentry>
452                 <term>sfu</term>
453                 <listitem>
454                 <para>
455                 When the CIFS Unix Extensions are not negotiated, attempt to
456                 create device files and fifos in a format compatible with
457                 Services for Unix (SFU).  In addition retrieve bits 10-12
458                 of the mode via the SETFILEBITS extended attribute (as
459                 SFU does).  In the future the bottom 9 bits of the mode
460                 mode also will be emulated using queries of the security
461                 descriptor (ACL). [NB: requires version 1.39 or later
462                 of the CIFS VFS.  To recognize symlinks and be able
463                 to create symlinks in an SFU interoperable form
464                 requires version 1.40 or later of the CIFS VFS kernel module.
465                 </para>
466                 </listitem>
467         </varlistentry>
469         <varlistentry>
470                 <term>serverino</term>
471                 <listitem><para>Use inode numbers (unique persistent file identifiers)
472                 returned by the server instead of automatically generating
473                 temporary inode numbers on the client.  Although server inode numbers
474                 make it easier to spot hardlinked files (as they will have
475                 the same inode numbers) and inode numbers may be persistent (which is
476                 userful for some sofware),
477                 the server does not guarantee that the inode numbers
478                 are unique if multiple server side mounts are exported under a
479                 single share (since inode numbers on the servers might not
480                 be unique if multiple filesystems are mounted under the same
481                 shared higher level directory).  Note that not all 
482                 servers support returning server inode numbers, although
483                 those that support the CIFS Unix Extensions, and Windows 2000 and
484                 later servers typically do support this (although not necessarily
485                 on every local server filesystem). Parameter has no effect if
486                 the server lacks support for returning inode numbers or equivalent.
487                 </para></listitem>
488         </varlistentry>
490         <varlistentry>
491                 <term>noserverino</term>
492                 <listitem>
493                 <para>
494                         Client generates inode numbers (rather than
495                 using the actual one from the server) by default.
496                 </para>
497                 <para>
498                         See section <emphasis>INODE NUMBERS</emphasis> for
499                 more information.
500                 </para></listitem>
501         </varlistentry>
503         <varlistentry>
504                 <term>nounix</term>
505                 <listitem>
506                 <para>
507                         Disable the CIFS Unix Extensions for this mount. This
508                 can be useful in order to turn off multiple settings at once.
509                 This includes POSIX acls, POSIX locks, POSIX paths, symlink
510                 support and retrieving uids/gids/mode from the server. This
511                 can also be useful to work around a bug in a server that
512                 supports Unix Extensions.
513                 </para>
514                 <para>
515                 See section <emphasis>INODE NUMBERS</emphasis> for
516                 more information.
517                 </para> </listitem>
518         </varlistentry>
520         <varlistentry>
521                 <term>nouser_xattr</term>
522                 <listitem><para>(default) Do not allow getfattr/setfattr to get/set xattrs, even if server would support it otherwise. </para></listitem>
523         </varlistentry>
525         <varlistentry>
526                 <term>rsize=<replaceable>arg</replaceable></term>
527                 <listitem><para>default network read size (usually 16K). The client currently
528                 can not use rsize larger than CIFSMaxBufSize. CIFSMaxBufSize
529                 defaults to 16K and may be changed (from 8K to the maximum
530                 kmalloc size allowed by your kernel) at module install time
531                 for cifs.ko. Setting CIFSMaxBufSize to a very large value
532                 will cause cifs to use more memory and may reduce performance
533                 in some cases.  To use rsize greater than 127K (the original
534                 cifs protocol maximum) also requires that the server support
535                 a new Unix Capability flag (for very large read) which some
536                 newer servers (e.g. Samba 3.0.26 or later) do. rsize can be
537                 set from a minimum of 2048 to a maximum of 130048 (127K or
538                 CIFSMaxBufSize, whichever is smaller)
540                 </para></listitem>
541         </varlistentry>
543         <varlistentry>
544                 <term>wsize=<replaceable>arg</replaceable></term>
546                 <listitem><para>default network write size (default 57344)
547                 maximum wsize currently allowed by CIFS is 57344 (fourteen
548                 4096 byte pages)</para></listitem>
549         </varlistentry>
550          <varlistentry>
551                 <term>--verbose</term>
552                 <listitem><para>Print additional debugging information for the mount. Note that this parameter must be specified before the -o. For example:</para><para>mount -t cifs //server/share /mnt --verbose -o user=username</para></listitem>
553         </varlistentry>
556         </variablelist>
557 </refsect1>
559 <refsect1>
560         <title>SERVICE FORMATTING AND DELIMITERS</title>
562         <para>
563                 It's generally preferred to use forward slashes (/) as a delimiter in service names. They are considered to be the "universal delimiter" since they are generally not allowed to be embedded within path components on Windows machines and the client can convert them to blackslashes (\) unconditionally. Conversely, backslash characters are allowed by POSIX to be part of a path component, and can't be automatically converted in the same way.
564         </para>
565         <para>
566                 mount.cifs will attempt to convert backslashes to forward slashes where it's able to do so, but it cannot do so in any path component following the sharename.
567         </para>
568 </refsect1>
570 <refsect1>
571         <title>INODE NUMBERS</title>
572         <para>
573                 When Unix Extensions are enabled, we use the actual inode
574         number provided by the server in response to the POSIX calls as an
575         inode number.
576         </para>
577         <para>
578                 When Unix Extensions are disabled and "serverino" mount option
579         is enabled there is no way to get the server inode number. The
580         client typically maps the server-assigned "UniqueID" onto an inode
581         number.
582         </para>
583         <para>
584                 Note that the UniqueID is a different value from the server
585         inode number. The UniqueID value is unique over the scope of the entire
586         server and is often greater than 2 power 32. This value often makes
587         programs that are not compiled with LFS (Large File Support), to
588         trigger a glibc EOVERFLOW error as this won't fit in the target
589         structure field. It is strongly recommended to compile your programs
590         with LFS support (i.e. with -D_FILE_OFFSET_BITS=64) to prevent this
591         problem. You can also use "noserverino" mount option to generate inode
592         numbers smaller than 2 power 32 on the client. But you may not be able
593         to detect hardlinks properly.
594         </para>
595 </refsect1>
597 <refsect1>
598         <title>FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS</title>
600         <para> The core CIFS protocol does not provide unix ownership
601 information or mode for files and directories. Because of this, files
602 and directories will generally appear to be owned by whatever values the
603 uid= or gid= options are set, and will have permissions set to the
604 default file_mode and dir_mode for the mount. Attempting to change these
605 values via chmod/chown will return success but have no effect.</para>
607         <para>When the client and server negotiate unix extensions,
608 files and directories will be assigned the uid, gid, and mode provided
609 by the server. Because CIFS mounts are generally single-user, and the
610 same credentials are used no matter what user accesses the mount, newly
611 created files and directories will generally be given ownership
612 corresponding to whatever credentials were used to mount the
613 share.</para>
615         <para>If the uid's and gid's being used do not match on the
616 client and server, the forceuid and forcegid options may be helpful.
617 Note however, that there is no corresponding option to override the
618 mode. Permissions assigned to a file when forceuid or forcegid are in
619 effect may not reflect the the real permissions.</para>
621         <para>When unix extensions are not negotiated, it's also
622 possible to emulate them locally on the server using the "dynperm" mount
623 option. When this mount option is in effect, newly created files and
624 directories will receive what appear to be proper permissions. These
625 permissions are not stored on the server however and can disappear at
626 any time in the future (subject to the whims of the kernel flushing out
627 the inode cache). In general, this mount option is discouraged.
628         </para>
630         <para>It's also possible to override permission checking on the client
631 altogether via the noperm option. Server-side permission checks cannot be
632 overriden. The permission checks done by the server will always correspond to
633 the credentials used to mount the share, and not necessarily to the user who is accessing the share.</para>
635 </refsect1>
637 <refsect1>
638         <title>ENVIRONMENT VARIABLES</title>
640         <para>
641                 The variable <emphasis>USER</emphasis> may contain the username of the
642 person to be used to authenticate to the server.
643 The variable can be used to set both username and
644 password by using the format username%password.
645         </para>
646         
647         <para>
648                 The variable <emphasis>PASSWD</emphasis> may contain the password of the
649 person using the client.
650         </para>
652         <para>
653                 The variable <emphasis>PASSWD_FILE</emphasis> may contain the pathname
654 of a file to read the password from. A single line of input is
655 read and used as the password.
656         </para>
658 </refsect1>
660 <refsect1>
661         <title>NOTES</title>
662         
663         <para>This command may be used only by root, unless installed setuid, in which case the noeexec and nosuid mount flags are enabled. When installed as a setuid program, the program follows the conventions set forth by the mount program for user mounts.</para>
665         <para>
666         Some samba client tools like smbclient(8) honour client-side
667         configuration parameters present in smb.conf. Unlike those
668         client tools, <emphasis>mount.cifs</emphasis> ignores smb.conf
669         completely.
670         </para>
672 </refsect1>
674 <refsect1>
675         <title>CONFIGURATION</title>
676                 <para>
677 The primary mechanism for making configuration changes and for reading 
678 debug information for the cifs vfs is via the Linux /proc filesystem.
679 In the directory <filename>/proc/fs/cifs</filename> are various 
680 configuration files and pseudo files which can display debug information.  
681 There are additional startup options such as maximum buffer size and number
682 of buffers which only may be set when the kernel cifs vfs (cifs.ko module) is 
683 loaded.  These can be seen by running the modinfo utility against the file
684 cifs.ko which will list the options that may be passed to cifs during module
685 installation (device driver load).
686 For more information see the kernel file <filename>fs/cifs/README</filename>.
687 </para>
688 </refsect1>
690 <refsect1>
691         <title>BUGS</title>
693         <para>Mounting using the CIFS URL specification is currently not supported.
694         </para>
696         <para>The credentials file does not handle usernames or passwords with
697                 leading space.</para>
699         <para>
700 Note that the typical response to a bug report is a suggestion
701 to try the latest version first. So please try doing that first,
702 and always include which versions you use of relevant software
703 when reporting bugs (minimum: mount.cifs (try mount.cifs -V), kernel (see /proc/version) and
704 server type you are trying to contact.
705 </para>
706 </refsect1>
710 <refsect1>
711         <title>VERSION</title>
713         <para>This man page is correct for version 1.52 of 
714         the cifs vfs filesystem (roughly Linux kernel 2.6.24).</para>
715 </refsect1>
717 <refsect1>
718         <title>SEE ALSO</title>
719         <para>
720         Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel
721         source tree may contain additional options and information.
722 </para>
723         <para><citerefentry><refentrytitle>umount.cifs</refentrytitle>
724         <manvolnum>8</manvolnum></citerefentry></para>
726 </refsect1>
728 <refsect1>
729         <title>AUTHOR</title>
730         
731         <para>Steve French</para>
733         <para>The syntax and manpage were loosely based on that of smbmount. It 
734                 was converted to Docbook/XML by Jelmer Vernooij.</para>
736         <para>The maintainer of the Linux cifs vfs and the userspace
737                 tool <emphasis>mount.cifs</emphasis> is <ulink url="mailto:sfrench@samba.org">Steve French</ulink>.
738                 The <ulink url="mailto:linux-cifs-client@lists.samba.org">Linux CIFS Mailing list</ulink> 
739                 is the preferred place to ask questions regarding these programs. 
740         </para>
742 </refsect1>
744 </refentry>