usr/src/man/man2/umount.2

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH UMOUNT 2 "Aug 4, 2008"
   8 .SH NAME
   9 umount, umount2 \- unmount a file system
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/mount.h>
  14
  15 \fBint\fR \fBumount\fR(\fBconst char *\fR\fIfile\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBumount2\fR(\fBconst char *\fR\fIfile\fR, \fBint\fR \fImflag\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBumount()\fR  function requests that a previously mounted file system
  27 contained on a block special device or directory be unmounted.  The \fIfile\fR
  28 argument is a pointer to the absolute pathname of the file system to be
  29 unmounted. After unmounting the file system, the directory upon which the file
  30 system was mounted reverts to its ordinary interpretation.
  31 .sp
  32 .LP
  33 The \fBumount2()\fR  function is identical to \fBumount()\fR, with the
  34 additional capability of unmounting file systems even if there are open files
  35 active. The \fImflag\fR argument must contain one of the following values:
  36 .sp
  37 .ne 2
  38 .na
  39 \fB0\fR
  40 .ad
  41 .RS 12n
  42 Perform a normal unmount that is equivalent to \fBumount()\fR. The
  43 \fBumount2()\fR function  returns \fBEBUSY\fR if there are open files active
  44 within the file system to be unmounted.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBMS_FORCE\fR\fR
  51 .ad
  52 .RS 12n
  53 Unmount the file system, even if there are open files active. A forced unmount
  54 can result in loss of data, so it should be used only when a regular unmount is
  55 unsuccessful. The \fBumount2()\fR function  returns \fBENOTSUP\fR if the
  56 specified file systems does not support \fBMS_FORCE\fR. Only file systems of
  57 type \fBnfs\fR, \fBufs\fR, \fBpcfs\fR, and \fBzfs\fR support \fBMS_FORCE\fR.
  58 .RE
  59
  60 .SH RETURN VALUES
  61 .sp
  62 .LP
  63 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  64 returned and \fBerrno\fR is set to indicate the error.
  65 .SH ERRORS
  66 .sp
  67 .LP
  68 The \fBumount()\fR and \fBumount2()\fR functions will fail if:
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBEACCES\fR\fR
  73 .ad
  74 .RS 16n
  75 The permission bits of the mount point do not permit read/write access or
  76 search permission is denied on a component of the path prefix.
  77 .sp
  78 The calling process is not the owner of the mountpoint.
  79 .sp
  80 The mountpoint is not a regular file or a directory and the caller does not
  81 have all privileges available in a its zone.
  82 .sp
  83 The special device device does not permit read access in the case of read-only
  84 mounts or read-write access in the case of read/write mounts.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBEBUSY\fR\fR
  91 .ad
  92 .RS 16n
  93 A file on \fIfile\fR is busy.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBEFAULT\fR\fR
 100 .ad
 101 .RS 16n
 102 The file pointed to by \fIfile\fR points to an illegal address.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBEINVAL\fR\fR
 109 .ad
 110 .RS 16n
 111 The file pointed to by \fIfile\fR is not mounted.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBELOOP\fR\fR
 118 .ad
 119 .RS 16n
 120 Too many symbolic links were encountered in translating the path pointed to by
 121 \fIfile\fR.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBENAMETOOLONG\fR\fR
 128 .ad
 129 .RS 16n
 130 The length of the \fIfile\fR argument exceeds  \fIPATH_MAX\fR, or the length of
 131 a  \fIfile\fR component exceeds \fINAME_MAX\fR while \fB_POSIX_NO_TRUNC\fR is
 132 in effect.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBENOENT\fR\fR
 139 .ad
 140 .RS 16n
 141 The file pointed to by \fIfile\fR does not exist or is not an absolute path.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBENOLINK\fR\fR
 148 .ad
 149 .RS 16n
 150 The file pointed to by \fIfile\fR is on a remote machine and the link to that
 151 machine is no longer active.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fBENOTBLK\fR\fR
 158 .ad
 159 .RS 16n
 160 The file pointed to by \fIfile\fR is not a block special device.
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fBEPERM\fR\fR
 167 .ad
 168 .RS 16n
 169 The {\fBPRIV_SYS_MOUNT\fR} privilege is not asserted in the effective set of
 170 the calling process.
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fBEREMOTE\fR\fR
 177 .ad
 178 .RS 16n
 179 The file pointed to by \fIfile\fR is remote.
 180 .RE
 181
 182 .sp
 183 .LP
 184 The \fBumount2()\fR function will fail if:
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fBENOTSUP\fR\fR
 189 .ad
 190 .RS 11n
 191 The file pointed to by \fIfile\fR does not support this operation.
 192 .RE
 193
 194 .SH USAGE
 195 .sp
 196 .LP
 197 The \fBumount()\fR and \fBumount2()\fR functions can be invoked only by a
 198 process that has the {\fBPRIV_SYS_MOUNT\fR} privilege asserted in its effective
 199 set.
 200 .sp
 201 .LP
 202 Because it provides greater functionality, the \fBumount2()\fR function is
 203 preferred.
 204 .SH SEE ALSO
 205 .sp
 206 .LP
 207 \fBmount\fR(2), \fBprivileges\fR(5)