undelete (2)

Leading comments

 Copyright (c) 1994
	Jan-Simon Pendry
	The Regents of the University of California.  All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and t...

(The comments found at the beginning of the groff file "man2/undelete.2freebsd".)

NAME

undelete - attempt to recover a deleted file

LIBRARY

Lb libc

SYNOPSIS

In unistd.h Ft int Fn undelete const char *path

DESCRIPTION

The Fn undelete system call attempts to recover the deleted file named by Fa path . Currently, this works only when the named object is a whiteout in a union file system. The system call removes the whiteout causing any objects in a lower layer of the union stack to become visible once more.

Eventually, the Fn undelete functionality may be expanded to other file systems able to recover deleted files such as the log-structured file system.

RETURN VALUES

Rv -std undelete

ERRORS

The Fn undelete succeeds unless:

Bq Er ENOTDIR

A component of the path prefix is not a directory.

Bq Er ENAMETOOLONG

A component of a pathname exceeded 255 characters, or an entire path name exceeded 1023 characters.

Bq Er EEXIST

The path does not reference a whiteout.

Bq Er ENOENT

The named whiteout does not exist.

Bq Er EACCES

Search permission is denied for a component of the path prefix.

Bq Er EACCES

Write permission is denied on the directory containing the name to be undeleted.

Bq Er ELOOP

Too many symbolic links were encountered in translating the pathname.

Bq Er EPERM

The directory containing the name is marked sticky, and the containing directory is not owned by the effective user ID.

Bq Er EINVAL

The last component of the path is `..'

Bq Er EIO

An I/O error occurred while updating the directory entry.

Bq Er EROFS

The name resides on a read-only file system.

Bq Er EFAULT

The Fa path argument points outside the process's allocated address space.

SEE ALSO

unlink(2), mount_unionfs8

HISTORY

The Fn undelete system call first appeared in BSD 4.4 Lite