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