lib/libcr/sys/unlink.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)unlink.2    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/unlink.2,v 1.8.2.4 2001/12/14 18:34:02 ru Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt UNLINK 2
  37 .Os
  38 .Sh NAME
  39 .Nm unlink
  40 .Nd remove directory entry
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft int
  46 .Fn unlink "const char *path"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn unlink
  50 function
  51 removes the link named by
  52 .Fa path
  53 from its directory and decrements the link count of the
  54 file which was referenced by the link.
  55 If that decrement reduces the link count of the file
  56 to zero,
  57 and no process has the file open, then
  58 all resources associated with the file are reclaimed.
  59 If one or more process have the file open when the last link is removed,
  60 the link is removed, but the removal of the file is delayed until
  61 all references to it have been closed.
  62 .Fa path
  63 may not be a directory.
  64 .Sh RETURN VALUES
  65 .Rv -std unlink
  66 .Sh ERRORS
  67 The
  68 .Fn unlink
  69 succeeds unless:
  70 .Bl -tag -width Er
  71 .It Bq Er ENOTDIR
  72 A component of the path prefix is not a directory.
  73 .It Bq Er ENAMETOOLONG
  74 A component of a pathname exceeded 255 characters,
  75 or an entire path name exceeded 1023 characters.
  76 .It Bq Er ENOENT
  77 The named file does not exist.
  78 .It Bq Er EACCES
  79 Search permission is denied for a component of the path prefix.
  80 .It Bq Er EACCES
  81 Write permission is denied on the directory containing the link
  82 to be removed.
  83 .It Bq Er ELOOP
  84 Too many symbolic links were encountered in translating the pathname.
  85 .It Bq Er EPERM
  86 The named file is a directory.
  87 .It Bq Er EPERM
  88 The directory containing the file is marked sticky,
  89 and neither the containing directory nor the file to be removed
  90 are owned by the effective user ID.
  91 .It Bq Er EBUSY
  92 The entry to be unlinked is the mount point for a
  93 mounted file system.
  94 .It Bq Er EIO
  95 An I/O error occurred while deleting the directory entry
  96 or deallocating the inode.
  97 .It Bq Er EROFS
  98 The named file resides on a read-only file system.
  99 .It Bq Er EFAULT
 100 .Fa Path
 101 points outside the process's allocated address space.
 102 .El
 103 .Sh SEE ALSO
 104 .Xr close 2 ,
 105 .Xr link 2 ,
 106 .Xr rmdir 2 ,
 107 .Xr symlink 7
 108 .Sh HISTORY
 109 An
 110 .Fn unlink
 111 function call appeared in
 112 .At v6 .
 113 .Pp
 114 The
 115 .Fn unlink
 116 system call traditionally allows the super-user to unlink directories which
 117 can damage the filesystem integrity.  This implementation no longer permits
 118 it.