xref: /netbsd-src/lib/libc/stdio/remove.3 (revision eb7c1594f145c931049e1fd9eb056a5987e87e59)
1*eb7c1594Sagc.\"	$NetBSD: remove.3,v 1.12 2003/08/07 16:43:30 agc Exp $
2389c46c5Sjtc.\"
3389c46c5Sjtc.\" Copyright (c) 1990, 1991, 1993
4389c46c5Sjtc.\"	The Regents of the University of California.  All rights reserved.
561f28255Scgd.\"
661f28255Scgd.\" This code is derived from software contributed to Berkeley by
761f28255Scgd.\" Chris Torek and the American National Standards Committee X3,
861f28255Scgd.\" on Information Processing Systems.
961f28255Scgd.\"
1061f28255Scgd.\" Redistribution and use in source and binary forms, with or without
1161f28255Scgd.\" modification, are permitted provided that the following conditions
1261f28255Scgd.\" are met:
1361f28255Scgd.\" 1. Redistributions of source code must retain the above copyright
1461f28255Scgd.\"    notice, this list of conditions and the following disclaimer.
1561f28255Scgd.\" 2. Redistributions in binary form must reproduce the above copyright
1661f28255Scgd.\"    notice, this list of conditions and the following disclaimer in the
1761f28255Scgd.\"    documentation and/or other materials provided with the distribution.
18*eb7c1594Sagc.\" 3. Neither the name of the University nor the names of its contributors
1961f28255Scgd.\"    may be used to endorse or promote products derived from this software
2061f28255Scgd.\"    without specific prior written permission.
2161f28255Scgd.\"
2261f28255Scgd.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2361f28255Scgd.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2461f28255Scgd.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2561f28255Scgd.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2661f28255Scgd.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2761f28255Scgd.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2861f28255Scgd.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2961f28255Scgd.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
3061f28255Scgd.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
3161f28255Scgd.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3261f28255Scgd.\" SUCH DAMAGE.
3361f28255Scgd.\"
34389c46c5Sjtc.\"     @(#)remove.3	8.1 (Berkeley) 6/4/93
3561f28255Scgd.\"
36389c46c5Sjtc.Dd June 4, 1993
3761f28255Scgd.Dt REMOVE 3
3861f28255Scgd.Os
3961f28255Scgd.Sh NAME
4061f28255Scgd.Nm remove
4161f28255Scgd.Nd remove directory entry
42312aca53Sperry.Sh LIBRARY
43312aca53Sperry.Lb libc
4461f28255Scgd.Sh SYNOPSIS
45472351e1Swiz.In stdio.h
4661f28255Scgd.Ft int
4761f28255Scgd.Fn remove "const char *path"
4861f28255Scgd.Sh DESCRIPTION
4961f28255ScgdThe
5061f28255Scgd.Fn remove
5104adc81fSyamtfunction removes the file or directory specified by
5261f28255Scgd.Fa path .
5304adc81fSyamt.Pp
5404adc81fSyamtIf
5504adc81fSyamt.Fa path
5604adc81fSyamtspecifies a directory,
5704adc81fSyamt.Fn remove "path"
5804adc81fSyamtis the equivalent of
5904adc81fSyamt.Fn rmdir "path" .
6004adc81fSyamtOtherwise, it is the equivalent of
6104adc81fSyamt.Fn unlink "path" .
6261f28255Scgd.Sh RETURN VALUES
6361f28255ScgdUpon successful completion,
6461f28255Scgd.Fn remove
6561f28255Scgdreturns 0.
6661f28255ScgdOtherwise, \-1 is returned and the global variable
6761f28255Scgd.Va errno
6861f28255Scgdis set to indicate the error.
6961f28255Scgd.Sh ERRORS
7061f28255ScgdThe
7161f28255Scgd.Fn remove
7261f28255Scgdfunction
7361f28255Scgdmay fail and set
7461f28255Scgd.Va errno
7504adc81fSyamtfor any of the errors specified for the routines
7604adc81fSyamt.Xr rmdir 2
7704adc81fSyamtor
7861f28255Scgd.Xr unlink 2 .
7961f28255Scgd.Sh SEE ALSO
8072a0532bSkleink.Xr rmdir 2 ,
817d96f3efSjdolecek.Xr unlink 2 ,
827d96f3efSjdolecek.Xr symlink 7
8361f28255Scgd.Sh STANDARDS
8461f28255ScgdThe
8561f28255Scgd.Fn remove
8661f28255Scgdfunction conforms to
8761f28255Scgd.St -ansiC .
88