xref: /openbsd/lib/libc/stdio/remove.3 (revision 07ea8d15)
1.\"	$OpenBSD: remove.3,v 1.2 1996/08/19 08:33:01 tholo 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. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"	This product includes software developed by the University of
21.\"	California, Berkeley and its contributors.
22.\" 4. Neither the name of the University nor the names of its contributors
23.\"    may be used to endorse or promote products derived from this software
24.\"    without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36.\" SUCH DAMAGE.
37.\"
38.Dd June 4, 1993
39.Dt REMOVE 3
40.Os
41.Sh NAME
42.Nm remove
43.Nd remove directory entry
44.Sh SYNOPSIS
45.Fd #include <stdio.h>
46.Ft int
47.Fn remove "const char *path"
48.Sh DESCRIPTION
49The
50.Fn remove
51function
52is an alias for the
53.Xr unlink 2
54system call.
55It deletes the file referenced by
56.Fa path .
57.Sh RETURN VALUES
58Upon successful completion,
59.Fn remove
60returns 0.
61Otherwise, \-1 is returned and the global variable
62.Va errno
63is set to indicate the error.
64.Sh ERRORS
65The
66.Fn remove
67function
68may fail and set
69.Va errno
70for any of the errors specified for the routine
71.Xr unlink 2 .
72.Sh SEE ALSO
73.Xr unlink 2
74.Sh STANDARDS
75The
76.Fn remove
77function conforms to
78.St -ansiC .
79