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