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.\" $DragonFly: src/lib/libc/sys/undelete.2,v 1.2 2003/06/17 04:26:47 dillon Exp $ 32.\" 33.Dd October 18, 1994 34.Dt UNDELETE 2 35.Os 36.Sh NAME 37.Nm undelete 38.Nd attempt to recover a deleted file 39.Sh LIBRARY 40.Lb libc 41.Sh SYNOPSIS 42.In unistd.h 43.Ft int 44.Fn undelete "const char *path" 45.Sh DESCRIPTION 46The 47.Fn undelete 48function attempts to recover the deleted file named by 49.Fa path . 50Currently, this works only when the named object 51is a whiteout in a union filesystem. 52The system call removes the whiteout causing 53any objects in a lower layer of the 54union stack to become visible once more. 55.Pp 56Eventually, the 57.Fn undelete 58functionality may be expanded to other filesystems able to recover 59deleted files such as the log-structured filesystem. 60.Sh RETURN VALUES 61.Rv -std undelete 62.Sh ERRORS 63The 64.Fn undelete 65succeeds unless: 66.Bl -tag -width Er 67.It Bq Er ENOTDIR 68A component of the path prefix is not a directory. 69.It Bq Er ENAMETOOLONG 70A component of a pathname exceeded 255 characters, 71or an entire path name exceeded 1023 characters. 72.It Bq Er EEXIST 73The path does not reference a whiteout. 74.It Bq Er ENOENT 75The named whiteout does not exist. 76.It Bq Er EACCES 77Search permission is denied for a component of the path prefix. 78.It Bq Er EACCES 79Write permission is denied on the directory containing the name 80to be undeleted. 81.It Bq Er ELOOP 82Too many symbolic links were encountered in translating the pathname. 83.It Bq Er EPERM 84The directory containing the name is marked sticky, 85and the containing directory is not owned by the effective user ID. 86.It Bq Er EIO 87An I/O error occurred while updating the directory entry. 88.It Bq Er EROFS 89The name resides on a read-only file system. 90.It Bq Er EFAULT 91.Fa Path 92points outside the process's allocated address space. 93.El 94.Sh SEE ALSO 95.Xr unlink 2 , 96.Xr mount_union 8 97.Sh HISTORY 98An 99.Fn undelete 100function call first appeared in 101.Bx 4.4 Lite . 102