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