xref: /openbsd/lib/libc/stdio/remove.3 (revision 404b540a)
1.\"	$OpenBSD: remove.3,v 1.11 2007/05/31 19:19:31 jmc Exp $
2.\"
3.\" Copyright (c) 1990, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Chris Torek and the American National Standards Committee X3,
8.\" on Information Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)remove.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd $Mdocdate: May 31 2007 $
37.Dt REMOVE 3
38.Os
39.Sh NAME
40.Nm remove
41.Nd remove a file or directory
42.Sh SYNOPSIS
43.Fd #include <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
61Upon successful completion,
62.Fn remove
63returns 0.
64Otherwise, \-1 is returned and the global variable
65.Va errno
66is set to indicate the error.
67.Sh ERRORS
68The
69.Fn remove
70function may fail and set
71.Va errno
72for any of the errors specified for the routines
73.Xr rmdir 2
74or
75.Xr unlink 2 .
76.Sh SEE ALSO
77.Xr rmdir 2 ,
78.Xr unlink 2
79.Sh STANDARDS
80The
81.Fn remove
82function conforms to
83.St -ansiC
84and
85.St -xpg4.2 .
86