xref: /original-bsd/lib/libc/stdio/remove.3 (revision ba762ddc)
1.\" Copyright (c) 1990, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek.
6.\" %sccs.include.redist.man%
7.\"
8.\"     @(#)remove.3	5.3 (Berkeley) 04/19/91
9.\"
10.Dd
11.Dt REMOVE 3
12.Os
13.Sh NAME
14.Nm remove
15.Nd remove directory entry
16.Sh SYNOPSIS
17.Fd #include <stdio.h>
18.Ft int
19.Fn remove "const char *path"
20.Sh DESCRIPTION
21The
22.Fn remove
23function
24is an alias for the
25.Xr unlink 2
26system call.
27It deletes the file referenced by
28.Fa path .
29.Sh RETURN VALUES
30Upon successful completion,
31.Fn remove
32returns 0.
33Otherwise, \-1 is returned and the global variable
34.Va errno
35is set to indicate the error.
36.Sh ERRORS
37The
38.Fn remove
39function
40may fail and set
41.Va errno
42for any of the errors specified for the routine
43.Xr unlink 2 .
44.Sh SEE ALSO
45.Xr unlink 2
46.Sh STANDARDS
47The
48.Fn remove
49function conforms to
50.St -ansiC .
51