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