xref: /openbsd-src/lib/libc/stdio/remove.3 (revision ee10762e100ef47e82bb9da2ebe88f56c8db1013)
1*ee10762eSschwarze.\"	$OpenBSD: remove.3,v 1.13 2015/01/29 01:46:30 schwarze Exp $
2df930be7Sderaadt.\"
3df930be7Sderaadt.\" Copyright (c) 1990, 1991, 1993
4df930be7Sderaadt.\"	The Regents of the University of California.  All rights reserved.
5df930be7Sderaadt.\"
6df930be7Sderaadt.\" This code is derived from software contributed to Berkeley by
7df930be7Sderaadt.\" Chris Torek and the American National Standards Committee X3,
8df930be7Sderaadt.\" on Information Processing Systems.
9df930be7Sderaadt.\"
10df930be7Sderaadt.\" Redistribution and use in source and binary forms, with or without
11df930be7Sderaadt.\" modification, are permitted provided that the following conditions
12df930be7Sderaadt.\" are met:
13df930be7Sderaadt.\" 1. Redistributions of source code must retain the above copyright
14df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer.
15df930be7Sderaadt.\" 2. Redistributions in binary form must reproduce the above copyright
16df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer in the
17df930be7Sderaadt.\"    documentation and/or other materials provided with the distribution.
186580fee3Smillert.\" 3. Neither the name of the University nor the names of its contributors
19df930be7Sderaadt.\"    may be used to endorse or promote products derived from this software
20df930be7Sderaadt.\"    without specific prior written permission.
21df930be7Sderaadt.\"
22df930be7Sderaadt.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23df930be7Sderaadt.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24df930be7Sderaadt.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25df930be7Sderaadt.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26df930be7Sderaadt.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27df930be7Sderaadt.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28df930be7Sderaadt.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29df930be7Sderaadt.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30df930be7Sderaadt.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31df930be7Sderaadt.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32df930be7Sderaadt.\" SUCH DAMAGE.
33df930be7Sderaadt.\"
34b091175dSmillert.\"	@(#)remove.3	8.1 (Berkeley) 6/4/93
35b091175dSmillert.\"
36*ee10762eSschwarze.Dd $Mdocdate: January 29 2015 $
37df930be7Sderaadt.Dt REMOVE 3
38df930be7Sderaadt.Os
39df930be7Sderaadt.Sh NAME
40df930be7Sderaadt.Nm remove
41b091175dSmillert.Nd remove a file or directory
42df930be7Sderaadt.Sh SYNOPSIS
4364d4e987Stedu.In stdio.h
44df930be7Sderaadt.Ft int
45df930be7Sderaadt.Fn remove "const char *path"
46df930be7Sderaadt.Sh DESCRIPTION
47df930be7SderaadtThe
48df930be7Sderaadt.Fn remove
49b091175dSmillertfunction removes the file or directory specified by
50df930be7Sderaadt.Fa path .
51b091175dSmillert.Pp
52b091175dSmillertIf
53b091175dSmillert.Fa path
54b091175dSmillertspecifies a directory,
55b091175dSmillert.Fn remove "path"
56b091175dSmillertis the equivalent of
57b091175dSmillert.Fn rmdir "path" .
58b091175dSmillertOtherwise, it is the equivalent of
59b091175dSmillert.Fn unlink "path" .
60df930be7Sderaadt.Sh RETURN VALUES
61*ee10762eSschwarze.Rv -std
62df930be7Sderaadt.Sh ERRORS
63df930be7SderaadtThe
64df930be7Sderaadt.Fn remove
6550772e64Saaronfunction may fail and set
66df930be7Sderaadt.Va errno
67b091175dSmillertfor any of the errors specified for the routines
68b091175dSmillert.Xr rmdir 2
69b091175dSmillertor
70b091175dSmillert.Xr unlink 2 .
71df930be7Sderaadt.Sh SEE ALSO
72b091175dSmillert.Xr rmdir 2 ,
731bb16d52Saaron.Xr unlink 2
74df930be7Sderaadt.Sh STANDARDS
75df930be7SderaadtThe
76df930be7Sderaadt.Fn remove
77df930be7Sderaadtfunction conforms to
78b091175dSmillert.St -ansiC
79b091175dSmillertand
80b091175dSmillert.St -xpg4.2 .
81