Add information about return code for immutable files.
[dragonfly.git] / lib / libc / 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 .\" $DragonFly: src/lib/libc/sys/unlink.2,v 1.3 2005/02/03 02:43:44 drhodus Exp $
35 .\"
36 .Dd June 4, 1993
37 .Dt UNLINK 2
38 .Os
39 .Sh NAME
40 .Nm unlink
41 .Nd remove directory entry
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In unistd.h
46 .Ft int
47 .Fn unlink "const char *path"
48 .Sh DESCRIPTION
49 The
50 .Fn unlink
51 function
52 removes the link named by
53 .Fa path
54 from its directory and decrements the link count of the
55 file which was referenced by the link.
56 If that decrement reduces the link count of the file
57 to zero,
58 and no process has the file open, then
59 all resources associated with the file are reclaimed.
60 If one or more process have the file open when the last link is removed,
61 the link is removed, but the removal of the file is delayed until
62 all references to it have been closed.
63 .Fa path
64 may not be a directory.
65 .Sh RETURN VALUES
66 .Rv -std unlink
67 .Sh ERRORS
68 The
69 .Fn unlink
70 succeeds unless:
71 .Bl -tag -width Er
72 .It Bq Er ENOTDIR
73 A component of the path prefix is not a directory.
74 .It Bq Er ENAMETOOLONG
75 A component of a pathname exceeded 255 characters,
76 or an entire path name exceeded 1023 characters.
77 .It Bq Er ENOENT
78 The named file does not exist.
79 .It Bq Er EACCES
80 Search permission is denied for a component of the path prefix.
81 .It Bq Er EACCES
82 Write permission is denied on the directory containing the link
83 to be removed.
84 .It Bq Er ELOOP
85 Too many symbolic links were encountered in translating the pathname.
86 .It Bq Er EPERM
87 The named file has its immutable or append-only flag set (see chflags(2)).
88 .It Bq Er EPERM
89 The named file is a directory.
90 .It Bq Er EPERM
91 The directory containing the file is marked sticky,
92 and neither the containing directory nor the file to be removed
93 are owned by the effective user ID.
94 .It Bq Er EBUSY
95 The entry to be unlinked is the mount point for a
96 mounted file system.
97 .It Bq Er EIO
98 An I/O error occurred while deleting the directory entry
99 or deallocating the inode.
100 .It Bq Er EROFS
101 The named file resides on a read-only file system.
102 .It Bq Er EFAULT
103 .Fa Path
104 points outside the process's allocated address space.
105 .El
106 .Sh SEE ALSO
107 .Xr close 2 ,
108 .Xr link 2 ,
109 .Xr rmdir 2 ,
110 .Xr symlink 7
111 .Sh HISTORY
112 An
113 .Fn unlink
114 function call appeared in
115 .At v6 .
116 .Pp
117 The
118 .Fn unlink
119 system call traditionally allows the super-user to unlink directories which
120 can damage the filesystem integrity.  This implementation no longer permits
121 it.