external/bsd/atf/dist/tools/atf-cleanup.1

   1 .\"
   2 .\" Automated Testing Framework (atf)
   3 .\"
   4 .\" Copyright (c) 2007, 2008 The NetBSD Foundation, Inc.
   5 .\" 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 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  17 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd August 18, 2007
  30 .Dt ATF-CLEANUP 1
  31 .Os
  32 .Sh NAME
  33 .Nm atf-cleanup
  34 .Nd safe removal of directory hierarchies
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Ar path1
  38 .Op Ar .. pathN
  39 .Nm
  40 .Fl h
  41 .Sh DESCRIPTION
  42 .Nm
  43 is a utility that removes files and directories recursively, but doing
  44 it in a safe manner to avoid crossing mount point boundaries.
  45 Before the removal of a given tree,
  46 .Nm
  47 will look for file systems mounted anywhere inside it and try to unmount
  48 them.
  49 If all mount points were properly unmounted, it later proceeds to do the
  50 real removal.
  51 This tool is used internally by test programs to clean up the test cases'
  52 work directories, as they may have left other file systems mounted inside
  53 them.
  54 .Pp
  55 In the first synopsis form,
  56 .Nm
  57 proceeds to scan and remove all the given files or directories.
  58 .Pp
  59 In the second synopsis form,
  60 .Nm
  61 will print information about all supported options and their purpose.
  62 .Pp
  63 The following options are available:
  64 .Bl -tag -width flag
  65 .It Fl h
  66 Shows a short summary of all available options and their purpose.
  67 .El
  68 .Sh SEE ALSO
  69 .Xr atf 7