kernel: Remove the old unionfs that was unhooked from the build since 2004.
[dragonfly.git] / lib / libc / sys / undelete.2
1 .\" Copyright (c) 1994
2 .\"     Jan-Simon Pendry
3 .\"     The Regents of the University of California.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. Neither the name of the University nor the names of its contributors
14 .\"    may be used to endorse or promote products derived from this software
15 .\"    without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" SUCH DAMAGE.
28 .\"
29 .\"     @(#)undelete.2  8.4 (Berkeley) 10/18/94
30 .\" $FreeBSD: src/lib/libc/sys/undelete.2,v 1.4.2.5 2001/12/14 18:34:02 ru Exp $
31 .\"
32 .Dd October 18, 1994
33 .Dt UNDELETE 2
34 .Os
35 .Sh NAME
36 .Nm undelete
37 .Nd attempt to recover a deleted file
38 .Sh LIBRARY
39 .Lb libc
40 .Sh SYNOPSIS
41 .In unistd.h
42 .Ft int
43 .Fn undelete "const char *path"
44 .Sh DESCRIPTION
45 The
46 .Fn undelete
47 function attempts to recover the deleted file named by
48 .Fa path .
49 Currently, this works only when the named object
50 is a whiteout in a union filesystem.
51 The system call removes the whiteout causing
52 any objects in a lower layer of the
53 union stack to become visible once more.
54 .Pp
55 Eventually, the
56 .Fn undelete
57 functionality may be expanded to other filesystems able to recover
58 deleted files such as the log-structured filesystem.
59 .Sh RETURN VALUES
60 .Rv -std undelete
61 .Sh ERRORS
62 The
63 .Fn undelete
64 succeeds unless:
65 .Bl -tag -width Er
66 .It Bq Er ENOTDIR
67 A component of the path prefix is not a directory.
68 .It Bq Er ENAMETOOLONG
69 A component of a pathname exceeded 255 characters,
70 or an entire path name exceeded 1023 characters.
71 .It Bq Er EEXIST
72 The path does not reference a whiteout.
73 .It Bq Er ENOENT
74 The named whiteout does not exist.
75 .It Bq Er EACCES
76 Search permission is denied for a component of the path prefix.
77 .It Bq Er EACCES
78 Write permission is denied on the directory containing the name
79 to be undeleted.
80 .It Bq Er ELOOP
81 Too many symbolic links were encountered in translating the pathname.
82 .It Bq Er EPERM
83 The directory containing the name is marked sticky,
84 and the containing directory is not owned by the effective user ID.
85 .It Bq Er EIO
86 An I/O error occurred while updating the directory entry.
87 .It Bq Er EROFS
88 The name resides on a read-only file system.
89 .It Bq Er EFAULT
90 .Fa Path
91 points outside the process's allocated address space.
92 .El
93 .Sh SEE ALSO
94 .Xr unlink 2
95 .Sh HISTORY
96 An
97 .Fn undelete
98 function call first appeared in
99 .Bx 4.4 Lite .