bin/rm/rm.1

   1 .\"-
   2 .\" Copyright (c) 1990, 1993, 1994
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" the Institute of Electrical and Electronics Engineers, Inc.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)rm.1        8.5 (Berkeley) 12/5/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd October 30, 2006
  36 .Dt RM 1
  37 .Os
  38 .Sh NAME
  39 .Nm rm ,
  40 .Nm unlink
  41 .Nd remove directory entries
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl f | i
  45 .Op Fl dIPRrvW
  46 .Ar
  47 .Nm unlink
  48 .Ar file
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility attempts to remove the non-directory type files specified on the
  53 command line.
  54 If the permissions of the file do not permit writing, and the standard
  55 input device is a terminal, the user is prompted (on the standard error
  56 output) for confirmation.
  57 .Pp
  58 The options are as follows:
  59 .Bl -tag -width Fl
  60 .It Fl d
  61 Attempt to remove directories as well as other types of files.
  62 .It Fl f
  63 Attempt to remove the files without prompting for confirmation,
  64 regardless of the file's permissions.
  65 If the file does not exist, do not display a diagnostic message or modify
  66 the exit status to reflect an error.
  67 The
  68 .Fl f
  69 option overrides any previous
  70 .Fl i
  71 options.
  72 .It Fl i
  73 Request confirmation before attempting to remove each file, regardless of
  74 the file's permissions, or whether or not the standard input device is a
  75 terminal.
  76 The
  77 .Fl i
  78 option overrides any previous
  79 .Fl f
  80 options.
  81 .It Fl I
  82 Request confirmation once if more than three files are being removed or if a
  83 directory is being recursively removed.
  84 This is a far less intrusive option than
  85 .Fl i
  86 yet provides almost the same level of protection against mistakes.
  87 .It Fl P
  88 Overwrite regular files before deleting them.
  89 Files are overwritten three times, first with the byte pattern 0xff,
  90 then 0x00, and then 0xff again, before they are deleted.
  91 Files with multiple links will not be overwritten nor deleted unless
  92 .Fl f
  93 is specified, a warning is generated instead.
  94 .Pp
  95 Specifying this flag for a read only file will cause
  96 .Nm
  97 to generate an error message and exit.
  98 The file will not be removed or overwritten.
  99 .It Fl R
 100 Attempt to remove the file hierarchy rooted in each file argument.
 101 The
 102 .Fl R
 103 option implies the
 104 .Fl d
 105 option.
 106 If the
 107 .Fl i
 108 option is specified, the user is prompted for confirmation before
 109 each directory's contents are processed (as well as before the attempt
 110 is made to remove the directory).
 111 If the user does not respond affirmatively, the file hierarchy rooted in
 112 that directory is skipped.
 113 .Pp
 114 .It Fl r
 115 Equivalent to
 116 .Fl R .
 117 .It Fl v
 118 Be verbose when deleting files, showing them as they are removed.
 119 .It Fl W
 120 Attempt to undelete the named files.
 121 Currently, this option can only be used to recover
 122 files covered by whiteouts.
 123 .El
 124 .Pp
 125 The
 126 .Nm
 127 utility removes symbolic links, not the files referenced by the links.
 128 .Pp
 129 It is an error to attempt to remove the files
 130 .Pa / ,
 131 .Pa .\&
 132 or
 133 .Pa .. .
 134 .Pp
 135 When the utility is called as
 136 .Nm unlink ,
 137 only one argument,
 138 which must not be a directory,
 139 may be supplied.
 140 No options may be supplied in this simple mode of operation,
 141 which performs an
 142 .Xr unlink 2
 143 operation on the passed argument.
 144 .Pp
 145 The
 146 .Nm
 147 utility exits 0 if all of the named files or file hierarchies were removed,
 148 or if the
 149 .Fl f
 150 option was specified and all of the existing files or file hierarchies were
 151 removed.
 152 If an error occurs,
 153 .Nm
 154 exits with a value >0.
 155 .Sh NOTE
 156 The
 157 .Nm
 158 command uses
 159 .Xr getopt 3
 160 to parse its arguments, which allows it to accept
 161 the
 162 .Sq Li --
 163 option which will cause it to stop processing flag options at that
 164 point.
 165 This will allow the removal of file names that begin
 166 with a dash
 167 .Pq Sq - .
 168 For example:
 169 .Dl rm -- -filename
 170 The same behavior can be obtained by using an absolute or relative
 171 path reference.
 172 For example:
 173 .Dl rm /home/user/-filename
 174 .Dl rm ./-filename
 175 .Pp
 176 When
 177 .Fl P
 178 is specified with
 179 .Fl f
 180 the file will be overwritten and removed even if it has hard links.
 181 .Sh COMPATIBILITY
 182 The
 183 .Nm
 184 utility differs from historical implementations in that the
 185 .Fl f
 186 option only masks attempts to remove non-existent files instead of
 187 masking a large variety of errors.
 188 The
 189 .Fl v
 190 option is non-standard and its use in scripts is not recommended.
 191 .Pp
 192 Also, historical
 193 .Bx
 194 implementations prompted on the standard output,
 195 not the standard error output.
 196 .Sh SEE ALSO
 197 .Xr chflags 1 ,
 198 .Xr rmdir 1 ,
 199 .Xr undelete 2 ,
 200 .Xr unlink 2 ,
 201 .Xr fts 3 ,
 202 .Xr getopt 3 ,
 203 .Xr symlink 7
 204 .Sh STANDARDS
 205 The
 206 .Nm
 207 command conforms to
 208 .St -p1003.2 .
 209 .Pp
 210 The simplified
 211 .Nm unlink
 212 command conforms to
 213 .St -susv2 .
 214 .Sh HISTORY
 215 A
 216 .Nm
 217 command appeared in
 218 .At v1 .
 219 .Sh BUGS
 220 The
 221 .Fl P
 222 option assumes that the underlying file system is a fixed-block file
 223 system.
 224 UFS is a fixed-block file system, LFS is not.
 225 In addition, only regular files are overwritten, other types of files
 226 are not.