projects / apple / libc.git / blame
| Commit | Line | Data |
|---|---|---|
| 5b2abdfb | 1 | .\" Copyright (c) 1990, 1991, 1993 |
| e9ce8d39 A |
2 | .\" The Regents of the University of California. All rights reserved. |
| 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. | |
| e9ce8d39 A |
16 | .\" 4. Neither the name of the University nor the names of its contributors |
| 17 | .\" may be used to endorse or promote products derived from this software | |
| 18 | .\" without specific prior written permission. | |
| 19 | .\" | |
| 20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
| 21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
| 24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
| 25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
| 26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
| 27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
| 28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
| 29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
| 30 | .\" SUCH DAMAGE. | |
| 31 | .\" | |
| 5b2abdfb | 32 | .\" @(#)remove.3 8.1 (Berkeley) 6/4/93 |
| 1f2f436a | 33 | .\" $FreeBSD: src/lib/libc/stdio/remove.3,v 1.10 2007/01/09 00:28:07 imp Exp $ |
| e9ce8d39 | 34 | .\" |
| 5b2abdfb A |
35 | .Dd June 4, 1993 |
| 36 | .Dt REMOVE 3 | |
| e9ce8d39 A |
37 | .Os |
| 38 | .Sh NAME | |
| 5b2abdfb A |
39 | .Nm remove |
| 40 | .Nd remove directory entry | |
| e9ce8d39 A |
41 | .Sh LIBRARY |
| 42 | .Lb libc | |
| 43 | .Sh SYNOPSIS | |
| 5b2abdfb | 44 | .In stdio.h |
| e9ce8d39 | 45 | .Ft int |
| 5b2abdfb | 46 | .Fn remove "const char *path" |
| e9ce8d39 A |
47 | .Sh DESCRIPTION |
| 48 | The | |
| 5b2abdfb A |
49 | .Fn remove |
| 50 | function removes the file or directory specified by | |
| 51 | .Fa path . | |
| 52 | .Pp | |
| e9ce8d39 | 53 | If |
| 5b2abdfb A |
54 | .Fa path |
| 55 | specifies a directory, | |
| 56 | .Fn remove "path" | |
| 57 | is the equivalent of | |
| 58 | .Fn rmdir "path" . | |
| 59 | Otherwise, it is the equivalent of | |
| 60 | .Fn unlink "path" . | |
| e9ce8d39 | 61 | .Sh RETURN VALUES |
| 5b2abdfb | 62 | .Rv -std remove |
| e9ce8d39 | 63 | .Sh ERRORS |
| 5b2abdfb A |
64 | The |
| 65 | .Fn remove | |
| 66 | function | |
| 67 | may fail and set | |
| 68 | .Va errno | |
| 69 | for any of the errors specified for the routines | |
| 70 | .Xr lstat 2 , | |
| ad3c9f2a | 71 | .Xr rmdir 2 , |
| 5b2abdfb A |
72 | or |
| 73 | .Xr unlink 2 . | |
| e9ce8d39 | 74 | .Sh SEE ALSO |
| 5b2abdfb A |
75 | .Xr rmdir 2 , |
| 76 | .Xr unlink 2 | |
| 77 | .Sh STANDARDS | |
| e9ce8d39 | 78 | The |
| 5b2abdfb A |
79 | .Fn remove |
| 80 | function conforms to | |
| 81 | .St -isoC | |
| 82 | and | |
| 83 | .St -xpg4.2 . |