aa02cd13ea914869933f9556b1ab7d6d2fc46619
[kai/samba-autobuild/.git] / docs-xml / 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         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">3.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>umount.cifs</refname>
16         <refpurpose>for normal, non-root users, to unmount their own Common Internet File System (CIFS) mounts</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21
22                 <command>umount.cifs</command>
23                 <arg choice="req">mount-point</arg>     
24                 <arg choice="opt">-nVvhfle</arg>        
25         </cmdsynopsis>
26 </refsynopsisdiv>
27
28 <refsect1>
29         <title>DESCRIPTION</title>
30
31         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
32         <manvolnum>7</manvolnum></citerefentry> suite.</para>
33
34         <para>umount.cifs unmounts a Linux CIFS filesystem. It can be invoked
35 indirectly by the
36 <citerefentry><refentrytitle>umount</refentrytitle><manvolnum>8</manvolnum></citerefentry> command 
37 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
38 support the cifs filesystem. The CIFS protocol is the successor to the 
39 SMB protocol and is supported by most Windows servers and many other
40 commercial servers and Network Attached Storage appliances as well as 
41 by the popular Open Source server Samba.
42         </para>
43
44         <para>
45         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.
46 It is possible to set the mode for umount.cifs to 
47 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
48 not needed if unmounts need only be performed by root users, or if user mounts and unmounts
49 can rely on specifying explicit entries in /etc/fstab See</para>
50         <para><citerefentry><refentrytitle>fstab</refentrytitle>
51         <manvolnum>5</manvolnum></citerefentry></para>
52 </refsect1>
53
54 <refsect1>
55         <title>OPTIONS</title>
56         <variablelist>
57                 <varlistentry>
58                 <term>-V</term>
59                 <listitem><para>Print version and exit.</para></listitem>
60                 </varlistentry>
61                 <varlistentry>
62                 <term>-h</term>
63                 <listitem><para>Print help message and exit.</para></listitem>
64                 </varlistentry>
65                 <varlistentry>
66                 <term>-r</term>
67                 <listitem><para>In case unmounting fails, try to remount
68                                 read-only.</para></listitem>
69                 </varlistentry>
70                 <varlistentry>
71                 <term>-d</term>
72                 <listitem><para>In case the unmounted device was a loop device,
73                                  also free this loop device.</para></listitem>
74                 </varlistentry>
75                 <varlistentry>
76                 <term>-f</term>
77                 <listitem><para>Force unmount (in case of an unreachable
78                                 server).</para></listitem>
79                 </varlistentry>
80                 <varlistentry>
81                 <term>-l</term>
82                 <listitem><para>Lazy unmount. Detach the filesystem from
83                                 the filesysetm hierarchy now, and
84                                 cleanup all references to the filesystem
85                                 as soon as it is not busy anymore.</para></listitem>
86                 </varlistentry>
87                 <varlistentry>
88                 <term>-e</term>
89                 <listitem><para>Mark the mount point as expired.  If a mount
90                                 point is not currently in use, then an initial
91                                 call to unmount with this flag fails with the
92                                 error EAGAIN, but marks the mount point as
93                                 expired.  The mount point remains expired as
94                                 long as it isn't accessed by any process.
95                                 A second unmount call specifying -e unmounts
96                                 an expired mount point.  This flag cannot be
97                                 specified with either -f or -l</para></listitem>
98                 </varlistentry>
99                 <varlistentry>
100                 <term>-v|--verbose</term>
101                 <listitem><para>Verbose Mode. Print additional debugging information</para></listitem>
102                 </varlistentry>
103                 <varlistentry>
104                 <term>-n|--no-mtab</term>
105                 <listitem><para>Do not update the mtab even if unmount completes successfully (/proc/mounts will still display the correct information)</para></listitem>
106                 </varlistentry>
107
108         </variablelist>
109 </refsect1>
110
111 <refsect1>
112         <title>NOTES</title>
113         
114         <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>
115 </refsect1>
116
117 <refsect1>
118         <title>CONFIGURATION</title>
119                 <para>
120 The primary mechanism for making configuration changes and for reading 
121 debug information for the cifs vfs is via the Linux /proc filesystem.
122 In the directory <filename>/proc/fs/cifs</filename> are various 
123 configuration files and pseudo files which can display debug information.  
124 For more information see the kernel file <filename>fs/cifs/README</filename>.
125 </para>
126 </refsect1>
127
128 <refsect1>
129         <title>BUGS</title>
130
131         <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).
132         </para>
133
134         <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>
135
136         <para>
137 Note that the typical response to a bug report is a suggestion
138 to try the latest version first. So please try doing that first,
139 and always include which versions you use of relevant software
140 when reporting bugs (minimum: umount.cifs (try umount.cifs -V), kernel (see /proc/version) and
141 server type you are trying to contact.
142 </para>
143 </refsect1>
144
145
146
147 <refsect1>
148         <title>VERSION</title>
149
150         <para>This man page is correct for version 1.34 of 
151         the cifs vfs filesystem (roughly Linux kernel 2.6.12).</para>
152 </refsect1>
153
154 <refsect1>
155         <title>SEE ALSO</title>
156         <para>
157         Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel
158         source tree may contain additional options and information.
159 </para>
160         <para><citerefentry><refentrytitle>mount.cifs</refentrytitle>
161         <manvolnum>8</manvolnum></citerefentry></para>
162
163 </refsect1>
164
165 <refsect1>
166         <title>AUTHOR</title>
167         
168         <para>Steve French</para>
169
170         <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> 
171         <para>The maintainer of the Linux cifs vfs and the userspace
172                 tool <emphasis>umount.cifs</emphasis> is <ulink url="mailto:sfrench@samba.org">Steve French</ulink>.
173                 The <ulink url="mailto:linux-cifs-client@lists.samba.org">Linux CIFS Mailing list</ulink> 
174                 is the preferred place to ask questions regarding these programs. 
175         </para>
176
177 </refsect1>
178
179 </refentry>