lib/libc/stdio/remove.3 - master - nerfur/openbsd-src

lib/libc/stdio/remove.3
80 строк3 KB
schwarze
Use .Rv where appropriate, and move it to RETURN VALUES;
29 янв 2015, 04:46
29 янв 2015, 04:46ee10762
.\"	$OpenBSD: remove.3,v 1.13 2015/01/29 01:46:30 schwarze Exp $
.\"
.\" 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. 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
.\"
.Dd $Mdocdate: January 29 2015 $
.Dt REMOVE 3
.Os
.Sh NAME
.Nm remove
.Nd remove a file or directory
.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
.Sh ERRORS
The
.Fn remove
function may fail and set
.Va errno
for any of the errors specified for the routines
.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 -ansiC
and
.St -xpg4.2 .