NetBSD-5.0.2/dist/atf/tools/atf-cleanup.1

Compare this file to the similar file:
Show the results in this format:
.\"
.\" Automated Testing Framework (atf)
.\"
.\" Copyright (c) 2007, 2008 The NetBSD Foundation, Inc.
.\" 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 the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd August 18, 2007
.Dt ATF-CLEANUP 1
.Os
.Sh NAME
.Nm atf-cleanup
.Nd safe removal of directory hierarchies
.Sh SYNOPSIS
.Nm
.Ar path1
.Op Ar .. pathN
.Nm
.Fl h
.Sh DESCRIPTION
.Nm
is a utility that removes files and directories recursively, but doing
it in a safe manner to avoid crossing mount point boundaries.
Before the removal of a given tree,
.Nm
will look for file systems mounted anywhere inside it and try to unmount
them.
If all mount points were properly unmounted, it later proceeds to do the
real removal.
This tool is used internally by test programs to clean up the test cases'
work directories, as they may have left other file systems mounted inside
them.
.Pp
In the first synopsis form,
.Nm
proceeds to scan and remove all the given files or directories.
.Pp
In the second synopsis form,
.Nm
will print information about all supported options and their purpose.
.Pp
The following options are available:
.Bl -tag -width flag
.It Fl h
Shows a short summary of all available options and their purpose.
.El
.Sh SEE ALSO
.Xr atf 7