[apple/libc.git] / stdio / FreeBSD / remove.3

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