xref: /minix3/lib/libc/stdio/remove.3 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\"	$NetBSD: remove.3,v 1.12 2003/08/07 16:43:30 agc Exp $
2*2fe8fb19SBen Gras.\"
3*2fe8fb19SBen Gras.\" Copyright (c) 1990, 1991, 1993
4*2fe8fb19SBen Gras.\"	The Regents of the University of California.  All rights reserved.
5*2fe8fb19SBen Gras.\"
6*2fe8fb19SBen Gras.\" This code is derived from software contributed to Berkeley by
7*2fe8fb19SBen Gras.\" Chris Torek and the American National Standards Committee X3,
8*2fe8fb19SBen Gras.\" on Information Processing Systems.
9*2fe8fb19SBen Gras.\"
10*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
11*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
12*2fe8fb19SBen Gras.\" are met:
13*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
14*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
15*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
16*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
17*2fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
18*2fe8fb19SBen Gras.\" 3. Neither the name of the University nor the names of its contributors
19*2fe8fb19SBen Gras.\"    may be used to endorse or promote products derived from this software
20*2fe8fb19SBen Gras.\"    without specific prior written permission.
21*2fe8fb19SBen Gras.\"
22*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23*2fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24*2fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25*2fe8fb19SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26*2fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27*2fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28*2fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29*2fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30*2fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31*2fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32*2fe8fb19SBen Gras.\" SUCH DAMAGE.
33*2fe8fb19SBen Gras.\"
34*2fe8fb19SBen Gras.\"     @(#)remove.3	8.1 (Berkeley) 6/4/93
35*2fe8fb19SBen Gras.\"
36*2fe8fb19SBen Gras.Dd June 4, 1993
37*2fe8fb19SBen Gras.Dt REMOVE 3
38*2fe8fb19SBen Gras.Os
39*2fe8fb19SBen Gras.Sh NAME
40*2fe8fb19SBen Gras.Nm remove
41*2fe8fb19SBen Gras.Nd remove directory entry
42*2fe8fb19SBen Gras.Sh LIBRARY
43*2fe8fb19SBen Gras.Lb libc
44*2fe8fb19SBen Gras.Sh SYNOPSIS
45*2fe8fb19SBen Gras.In stdio.h
46*2fe8fb19SBen Gras.Ft int
47*2fe8fb19SBen Gras.Fn remove "const char *path"
48*2fe8fb19SBen Gras.Sh DESCRIPTION
49*2fe8fb19SBen GrasThe
50*2fe8fb19SBen Gras.Fn remove
51*2fe8fb19SBen Grasfunction removes the file or directory specified by
52*2fe8fb19SBen Gras.Fa path .
53*2fe8fb19SBen Gras.Pp
54*2fe8fb19SBen GrasIf
55*2fe8fb19SBen Gras.Fa path
56*2fe8fb19SBen Grasspecifies a directory,
57*2fe8fb19SBen Gras.Fn remove "path"
58*2fe8fb19SBen Grasis the equivalent of
59*2fe8fb19SBen Gras.Fn rmdir "path" .
60*2fe8fb19SBen GrasOtherwise, it is the equivalent of
61*2fe8fb19SBen Gras.Fn unlink "path" .
62*2fe8fb19SBen Gras.Sh RETURN VALUES
63*2fe8fb19SBen GrasUpon successful completion,
64*2fe8fb19SBen Gras.Fn remove
65*2fe8fb19SBen Grasreturns 0.
66*2fe8fb19SBen GrasOtherwise, \-1 is returned and the global variable
67*2fe8fb19SBen Gras.Va errno
68*2fe8fb19SBen Grasis set to indicate the error.
69*2fe8fb19SBen Gras.Sh ERRORS
70*2fe8fb19SBen GrasThe
71*2fe8fb19SBen Gras.Fn remove
72*2fe8fb19SBen Grasfunction
73*2fe8fb19SBen Grasmay fail and set
74*2fe8fb19SBen Gras.Va errno
75*2fe8fb19SBen Grasfor any of the errors specified for the routines
76*2fe8fb19SBen Gras.Xr rmdir 2
77*2fe8fb19SBen Grasor
78*2fe8fb19SBen Gras.Xr unlink 2 .
79*2fe8fb19SBen Gras.Sh SEE ALSO
80*2fe8fb19SBen Gras.Xr rmdir 2 ,
81*2fe8fb19SBen Gras.Xr unlink 2 ,
82*2fe8fb19SBen Gras.Xr symlink 7
83*2fe8fb19SBen Gras.Sh STANDARDS
84*2fe8fb19SBen GrasThe
85*2fe8fb19SBen Gras.Fn remove
86*2fe8fb19SBen Grasfunction conforms to
87*2fe8fb19SBen Gras.St -ansiC .
88