docs/manpages-3/umount.cifs.8.xml

   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="umount.cifs.8">
   4
   5 <refmeta>
   6         <refentrytitle>umount.cifs</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>umount.cifs</refname>
  13         <refpurpose>for normal, non-root users, to unmount their own Common Internet File System (CIFS) mounts</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18
  19                 <command>umount.cifs</command>
  20                 <arg choice="req">mount-point</arg>
  21                 <arg choice="opt">-nVvhfle</arg>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  29         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  30
  31         <para>umount.cifs unmounts a Linux CIFS filesystem. It can be invoked
  32 indirectly by the
  33 <citerefentry><refentrytitle>umount</refentrytitle><manvolnum>8</manvolnum></citerefentry> command
  34 when umount.cifs is in /sbin directory, unless you specify the "-i" option to umount.  Specifying -i to umount avoids execution of umount helpers such as umount.cifs. The umount.cifs command only works in Linux, and the kernel must
  35 support the cifs filesystem. The CIFS protocol is the successor to the
  36 SMB protocol and is supported by most Windows servers and many other
  37 commercial servers and Network Attached Storage appliances as well as
  38 by the popular Open Source server Samba.
  39         </para>
  40
  41         <para>
  42         The umount.cifs utility detaches the local directory <emphasis>mount-point</emphasis> from the corresponding UNC name (exported network resource) and frees the associated kernel resources.
  43 It is possible to set the mode for umount.cifs to
  44 setuid root (or equivalently update the /etc/permissions file) to allow non-root users to umount shares to directories for which they have write permission.  The umount.cifs utility is typically
  45 not needed if unmounts need only be performed by root users, or if user mounts and unmounts
  46 can rely on specifying explicit entries in /etc/fstab See</para>
  47         <para><citerefentry><refentrytitle>fstab</refentrytitle>
  48         <manvolnum>5</manvolnum></citerefentry></para>
  49 </refsect1>
  50
  51 <refsect1>
  52         <title>OPTIONS</title>
  53         <variablelist>
  54         <varlistentry>
  55                 <term>--verbose</term>
  56                 <listitem><para>print additional debugging information</para></listitem>
  57         </varlistentry>
  58         <varlistentry>
  59                 <term>--no-mtab</term>
  60                 <listitem><para>Do not update the mtab even if unmount completes successfully (/proc/mounts will still display the correct information)</para></listitem>
  61         </varlistentry>
  62
  63         </variablelist>
  64 </refsect1>
  65
  66 <refsect1>
  67         <title>NOTES</title>
  68
  69         <para>This command is normally intended to be installed setuid (since root users can already run unmount).  An alternative to using umount.cifs is to add specfic entries for the user mounts that you wish a particular user or users to mount and unmount to /etc/fstab</para>
  70 </refsect1>
  71
  72 <refsect1>
  73         <title>CONFIGURATION</title>
  74                 <para>
  75 The primary mechanism for making configuration changes and for reading
  76 debug information for the cifs vfs is via the Linux /proc filesystem.
  77 In the directory <filename>/proc/fs/cifs</filename> are various
  78 configuration files and pseudo files which can display debug information.
  79 For more information see the kernel file <filename>fs/cifs/README</filename>.
  80 </para>
  81 </refsect1>
  82
  83 <refsect1>
  84         <title>BUGS</title>
  85
  86         <para>At this time umount.cifs does not lock the mount table using the same lock as the umount utility does, so do not attempt to do multiple unmounts from different processes (and in particular unmounts of a cifs mount and another type of filesystem mount at the same time).
  87         </para>
  88
  89         <para>If the same mount point is mounted multiple times by cifs, umount.cifs will remove all of the matching entries from the mount table (although umount.cifs will actually only unmount the last one), rather than only removing the last matching entry in /etc/mtab.  The pseudofile /proc/mounts will display correct information though, and the lack of an entry in /etc/mtab does not prevent subsequent unmounts.</para>
  90
  91         <para>
  92 Note that the typical response to a bug report is a suggestion
  93 to try the latest version first. So please try doing that first,
  94 and always include which versions you use of relevant software
  95 when reporting bugs (minimum: umount.cifs (try umount.cifs -V), kernel (see /proc/version) and
  96 server type you are trying to contact.
  97 </para>
  98 </refsect1>
  99
 100
 101
 102 <refsect1>
 103         <title>VERSION</title>
 104
 105         <para>This man page is correct for version 1.34 of
 106         the cifs vfs filesystem (roughly Linux kernel 2.6.12).</para>
 107 </refsect1>
 108
 109 <refsect1>
 110         <title>SEE ALSO</title>
 111         <para>
 112         Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel
 113         source tree may contain additional options and information.
 114 </para>
 115         <para><citerefentry><refentrytitle>mount.cifs</refentrytitle>
 116         <manvolnum>8</manvolnum></citerefentry></para>
 117
 118 </refsect1>
 119
 120 <refsect1>
 121         <title>AUTHOR</title>
 122
 123         <para>Steve French</para>
 124
 125         <para>The syntax was loosely based on the umount utility and the manpage was loosely based on that of mount.cifs.8. The man page was created by Steve French</para>
 126         <para>The maintainer of the Linux cifs vfs and the userspace
 127                 tool <emphasis>umount.cifs</emphasis> is <ulink url="mailto:sfrench@samba.org">Steve French</ulink>.
 128                 The <ulink url="mailto:linux-cifs-client@lists.samba.org">Linux CIFS Mailing list</ulink>
 129                 is the preferred place to ask questions regarding these programs.
 130         </para>
 131
 132 </refsect1>
 133
 134 </refentry>