diff options
Diffstat (limited to 'upstream/archlinux/man3p/remove.3p')
-rw-r--r-- | upstream/archlinux/man3p/remove.3p | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/remove.3p b/upstream/archlinux/man3p/remove.3p new file mode 100644 index 00000000..1ff8bd17 --- /dev/null +++ b/upstream/archlinux/man3p/remove.3p @@ -0,0 +1,99 @@ +'\" et +.TH REMOVE "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual" +.\" +.SH PROLOG +This manual page is part of the POSIX Programmer's Manual. +The Linux implementation of this interface may differ (consult +the corresponding Linux manual page for details of Linux behavior), +or the interface may not be implemented on Linux. +.\" +.SH NAME +remove +\(em remove a file +.SH SYNOPSIS +.LP +.nf +#include <stdio.h> +.P +int remove(const char *\fIpath\fP); +.fi +.SH DESCRIPTION +The functionality described on this reference page is aligned with the +ISO\ C standard. Any conflict between the requirements described here and the +ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard. +.P +The +\fIremove\fR() +function shall cause the file named by the pathname pointed to by +.IR path +to be no longer accessible by that name. A subsequent attempt to open +that file using that name shall fail, unless it is created anew. +.P +If +.IR path +does not name a directory, \fIremove\fP(\fIpath\fP) shall be equivalent +to \fIunlink\fP(\fIpath\fP). +.P +If +.IR path +names a directory, \fIremove\fP(\fIpath\fP) shall be equivalent to +\fIrmdir\fP(\fIpath\fP). +.SH "RETURN VALUE" +Refer to +.IR "\fIrmdir\fR\^(\|)" +or +.IR "\fIunlink\fR\^(\|)". +.SH ERRORS +Refer to +.IR "\fIrmdir\fR\^(\|)" +or +.IR "\fIunlink\fR\^(\|)". +.LP +.IR "The following sections are informative." +.SH EXAMPLES +.SS "Removing Access to a File" +.P +The following example shows how to remove access to a file named +.BR /home/cnd/old_mods . +.sp +.RS 4 +.nf + +#include <stdio.h> +.P +int status; +\&... +status = remove("/home/cnd/old_mods"); +.fi +.P +.RE +.SH "APPLICATION USAGE" +None. +.SH RATIONALE +None. +.SH "FUTURE DIRECTIONS" +None. +.SH "SEE ALSO" +.IR "\fIrmdir\fR\^(\|)", +.IR "\fIunlink\fR\^(\|)" +.P +The Base Definitions volume of POSIX.1\(hy2017, +.IR "\fB<stdio.h>\fP" +.\" +.SH COPYRIGHT +Portions of this text are reprinted and reproduced in electronic form +from IEEE Std 1003.1-2017, Standard for Information Technology +-- Portable Operating System Interface (POSIX), The Open Group Base +Specifications Issue 7, 2018 Edition, +Copyright (C) 2018 by the Institute of +Electrical and Electronics Engineers, Inc and The Open Group. +In the event of any discrepancy between this version and the original IEEE and +The Open Group Standard, the original IEEE and The Open Group Standard +is the referee document. The original Standard can be obtained online at +http://www.opengroup.org/unix/online.html . +.PP +Any typographical or formatting errors that appear +in this page are most likely +to have been introduced during the conversion of the source files to +man page format. To report such errors, see +https://www.kernel.org/doc/man-pages/reporting_bugs.html . |