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