xref: /freebsd/lib/libc/stdio/remove.3 (revision 069ac184)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek and the American National Standards Committee X3,
6.\" on Information Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. 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.Dd June 4, 1993
33.Dt REMOVE 3
34.Os
35.Sh NAME
36.Nm remove
37.Nd remove directory entry
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In stdio.h
42.Ft int
43.Fn remove "const char *path"
44.Sh DESCRIPTION
45The
46.Fn remove
47function removes the file or directory specified by
48.Fa path .
49.Pp
50If
51.Fa path
52specifies a directory,
53.Fn remove "path"
54is the equivalent of
55.Fn rmdir "path" .
56Otherwise, it is the equivalent of
57.Fn unlink "path" .
58.Sh RETURN VALUES
59.Rv -std remove
60.Sh ERRORS
61The
62.Fn remove
63function
64may fail and set
65.Va errno
66for any of the errors specified for the routines
67.Xr lstat 2 ,
68.Xr rmdir 2
69or
70.Xr unlink 2 .
71.Sh SEE ALSO
72.Xr rmdir 2 ,
73.Xr unlink 2
74.Sh STANDARDS
75The
76.Fn remove
77function conforms to
78.St -isoC
79and
80.St -xpg4.2 .
81