xref: /netbsd/lib/libc/stdio/remove.3 (revision bf9ec67e)
1.\"	$NetBSD: remove.3,v 1.8 2002/02/07 07:00:26 ross 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.\"     @(#)remove.3	8.1 (Berkeley) 6/4/93
39.\"
40.Dd June 4, 1993
41.Dt REMOVE 3
42.Os
43.Sh NAME
44.Nm remove
45.Nd remove directory entry
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.Fd #include \*[Lt]stdio.h\*[Gt]
50.Ft int
51.Fn remove "const char *path"
52.Sh DESCRIPTION
53The
54.Fn remove
55function
56is an alias for the
57.Xr unlink 2
58system call.
59It deletes the file referenced by
60.Fa path .
61.Sh RETURN VALUES
62Upon successful completion,
63.Fn remove
64returns 0.
65Otherwise, \-1 is returned and the global variable
66.Va errno
67is set to indicate the error.
68.Sh ERRORS
69The
70.Fn remove
71function
72may fail and set
73.Va errno
74for any of the errors specified for the routine
75.Xr unlink 2 .
76.Sh SEE ALSO
77.Xr rmdir 2 ,
78.Xr unlink 2 ,
79.Xr symlink 7
80.Sh STANDARDS
81The
82.Fn remove
83function conforms to
84.St -ansiC .
85