xref: /freebsd/lib/libc/stdio/remove.3 (revision 63f537551380d2dab29fa402ad1269feae17e594)
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.\"     @(#)remove.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd June 4, 1993
35.Dt REMOVE 3
36.Os
37.Sh NAME
38.Nm remove
39.Nd remove directory entry
40.Sh LIBRARY
41.Lb libc
42.Sh SYNOPSIS
43.In stdio.h
44.Ft int
45.Fn remove "const char *path"
46.Sh DESCRIPTION
47The
48.Fn remove
49function removes the file or directory specified by
50.Fa path .
51.Pp
52If
53.Fa path
54specifies a directory,
55.Fn remove "path"
56is the equivalent of
57.Fn rmdir "path" .
58Otherwise, it is the equivalent of
59.Fn unlink "path" .
60.Sh RETURN VALUES
61.Rv -std remove
62.Sh ERRORS
63The
64.Fn remove
65function
66may fail and set
67.Va errno
68for any of the errors specified for the routines
69.Xr lstat 2 ,
70.Xr rmdir 2
71or
72.Xr unlink 2 .
73.Sh SEE ALSO
74.Xr rmdir 2 ,
75.Xr unlink 2
76.Sh STANDARDS
77The
78.Fn remove
79function conforms to
80.St -isoC
81and
82.St -xpg4.2 .
83