xref: /freebsd/share/man/man9/VOP_REMOVE.9 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1fab63cc4SDoug Rabson.\" -*- nroff -*-
2fab63cc4SDoug Rabson.\"
3fab63cc4SDoug Rabson.\" Copyright (c) 1996 Doug Rabson
4fab63cc4SDoug Rabson.\"
5fab63cc4SDoug Rabson.\" All rights reserved.
6fab63cc4SDoug Rabson.\"
7fab63cc4SDoug Rabson.\" This program is free software.
8fab63cc4SDoug Rabson.\"
9fab63cc4SDoug Rabson.\" Redistribution and use in source and binary forms, with or without
10fab63cc4SDoug Rabson.\" modification, are permitted provided that the following conditions
11fab63cc4SDoug Rabson.\" are met:
12fab63cc4SDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
13fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
14fab63cc4SDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
15fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
16fab63cc4SDoug Rabson.\"    documentation and/or other materials provided with the distribution.
17fab63cc4SDoug Rabson.\"
18fab63cc4SDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19fab63cc4SDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20fab63cc4SDoug Rabson.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21fab63cc4SDoug Rabson.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22fab63cc4SDoug Rabson.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23fab63cc4SDoug Rabson.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24fab63cc4SDoug Rabson.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25fab63cc4SDoug Rabson.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26fab63cc4SDoug Rabson.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27fab63cc4SDoug Rabson.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28fab63cc4SDoug Rabson.\"
29fab63cc4SDoug Rabson.Dd July 24, 1996
30fab63cc4SDoug Rabson.Dt VOP_REMOVE 9
31*aa12cea2SUlrich Spörlein.Os
32fab63cc4SDoug Rabson.Sh NAME
33fab63cc4SDoug Rabson.Nm VOP_REMOVE ,
34fab63cc4SDoug Rabson.Nm VOP_RMDIR
35fab63cc4SDoug Rabson.Nd remove a file or directory
36fab63cc4SDoug Rabson.Sh SYNOPSIS
3732eef9aeSRuslan Ermilov.In sys/param.h
3832eef9aeSRuslan Ermilov.In sys/vnode.h
39fab63cc4SDoug Rabson.Ft int
40fab63cc4SDoug Rabson.Fn VOP_REMOVE "struct vnode *dvp" "struct vnode *vp" "struct componentname *cnp"
41fab63cc4SDoug Rabson.Ft int
42fab63cc4SDoug Rabson.Fn VOP_RMDIR "struct vnode *dvp" "struct vnode *vp" "struct componentname *cnp"
43fab63cc4SDoug Rabson.Sh DESCRIPTION
44fab63cc4SDoug RabsonThese entry points remove files and directories respectively.
45fab63cc4SDoug Rabson.Pp
46fab63cc4SDoug RabsonThe arguments are:
47fab63cc4SDoug Rabson.Bl -tag -width dvp
480640e9e0SHiten Pandya.It Fa dvp
490a57ea7dSRuslan ErmilovThe vnode of the directory.
500640e9e0SHiten Pandya.It Fa vp
510a57ea7dSRuslan ErmilovThe vnode of the file to be removed.
520640e9e0SHiten Pandya.It Fa cnp
530a57ea7dSRuslan ErmilovPathname information about the file.
54fab63cc4SDoug Rabson.El
55fab63cc4SDoug Rabson.Sh LOCKS
56fab63cc4SDoug RabsonBoth
57fab63cc4SDoug Rabson.Fa dvp
58fab63cc4SDoug Rabsonand
59fab63cc4SDoug Rabson.Fa vp
60fe11eb74SMatthew Dillonshould be locked on entry and remain locked on return.
61fab63cc4SDoug Rabson.Sh RETURN VALUES
62fab63cc4SDoug RabsonZero is returned on success, otherwise an error code is returned.
63fab63cc4SDoug Rabson.Sh ERRORS
64eaa8b244SMike Pritchard.Bl -tag -width Er
65fab63cc4SDoug Rabson.It Bq Er EPERM
66cc258457SDon LewisThe file is immutable.
67fab63cc4SDoug Rabson.It Bq Er ENOTEMPTY
6881f8d226SDon LewisAn attempt was made to remove a directory which is not empty.
69fab63cc4SDoug Rabson.El
70fab63cc4SDoug Rabson.Sh SEE ALSO
71fab63cc4SDoug Rabson.Xr vnode 9 ,
72fab63cc4SDoug Rabson.Xr VOP_LOOKUP 9
73fab63cc4SDoug Rabson.Sh AUTHORS
74571dba6eSHiten PandyaThis manual page was written by
75aaf1f16eSPhilippe Charnier.An Doug Rabson .
76