xref: /netbsd-src/lib/libc/sys/unlink.2 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1.\" Copyright (c) 1980, 1991 Regents of the University of California.
2.\" 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.\"     from: @(#)unlink.2	6.3 (Berkeley) 3/10/91
33.\"	$Id: unlink.2,v 1.6 1994/04/22 00:13:54 jtc Exp $
34.\"
35.Dd March 10, 1991
36.Dt UNLINK 2
37.Os BSD 4
38.Sh NAME
39.Nm unlink
40.Nd remove directory entry
41.Sh SYNOPSIS
42.Fd #include <unistd.h>
43.Ft int
44.Fn unlink "const char *path"
45.Sh DESCRIPTION
46The
47.Fn unlink
48function
49removes the link named by
50.Fa path
51from its directory and decrements the link count of the
52file which was referenced by the link.
53If that decrement reduces the link count of the file
54to zero,
55and no process has the file open, then
56all resources associated with the file are reclaimed.
57If one or more process have the file open when the last link is removed,
58the link is removed, but the removal of the file is delayed until
59all references to it have been closed.
60.Sh RETURN VALUES
61Upon successful completion, a value of 0 is returned.
62Otherwise, a value of -1 is returned and
63.Va errno
64is set to indicate the error.
65.Sh ERRORS
66The
67.Fn unlink
68succeeds unless:
69.Bl -tag -width Er
70.It Bq Er ENOTDIR
71A component of the path prefix is not a directory.
72.It Bq Er ENAMETOOLONG
73A component of a pathname exceeded
74.Dv {NAME_MAX}
75characters, or an entire path name exceeded
76.Dv {PATH_MAX}
77characters.
78.It Bq Er ENOENT
79The named file does not exist.
80.It Bq Er EACCES
81Search permission is denied for a component of the path prefix.
82.It Bq Er EACCES
83Write permission is denied on the directory containing the link
84to be removed.
85.It Bq Er ELOOP
86Too many symbolic links were encountered in translating the pathname.
87.It Bq Er EPERM
88The named file is a directory and the effective user ID
89of the process is not the super-user.
90.It Bq Er EPERM
91The directory containing the file is marked sticky,
92and neither the containing directory nor the file to be removed
93are owned by the effective user ID.
94.It Bq Er EBUSY
95The entry to be unlinked is the mount point for a
96mounted file system.
97.It Bq Er EIO
98An I/O error occurred while deleting the directory entry
99or deallocating the inode.
100.It Bq Er EROFS
101The named file resides on a read-only file system.
102.It Bq Er EFAULT
103.Fa Path
104points 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.Sh HISTORY
111An
112.Fn unlink
113function call appeared in
114.At v6 .
115