bin/rm/rm.1

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