lib/libc/stdio/remove.3

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