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 .\" 3. 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 November 10, 2018
  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 dIRrvWx
  46 .Ar
  47 .Nm unlink
  48 .Op Fl -
  49 .Ar file
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 utility attempts to remove the non-directory type files specified on the
  54 command line.
  55 If the permissions of the file do not permit writing, and the standard
  56 input device is a terminal, the user is prompted (on the standard error
  57 output) for confirmation.
  58 .Pp
  59 The options are as follows:
  60 .Bl -tag -width indent
  61 .It Fl d
  62 Attempt to remove directories as well as other types of files.
  63 .It Fl f
  64 Attempt to remove the files without prompting for confirmation,
  65 regardless of the file's permissions.
  66 If the file does not exist, do not display a diagnostic message or modify
  67 the exit status to reflect an error.
  68 The
  69 .Fl f
  70 option overrides any previous
  71 .Fl i
  72 options.
  73 .It Fl i
  74 Request confirmation before attempting to remove each file, regardless of
  75 the file's permissions, or whether or not the standard input device is a
  76 terminal.
  77 The
  78 .Fl i
  79 option overrides any previous
  80 .Fl f
  81 options.
  82 .It Fl I
  83 Request confirmation once if more than three files are being removed or if a
  84 directory is being recursively removed.
  85 This is a far less intrusive option than
  86 .Fl i
  87 yet provides almost the same level of protection against mistakes.
  88 .It Fl P
  89 This flag has no effect.
  90 It is kept only for backwards compatibility with
  91 .Bx 4.4 Lite2 .
  92 .It Fl R
  93 Attempt to remove the file hierarchy rooted in each
  94 .Ar file
  95 argument.
  96 The
  97 .Fl R
  98 option implies the
  99 .Fl d
 100 option.
 101 If the
 102 .Fl i
 103 option is specified, the user is prompted for confirmation before
 104 each directory's contents are processed (as well as before the attempt
 105 is made to remove the directory).
 106 If the user does not respond affirmatively, the file hierarchy rooted in
 107 that directory is skipped.
 108 .It Fl r
 109 Equivalent to
 110 .Fl R .
 111 .It Fl v
 112 Be verbose when deleting files, showing them as they are removed.
 113 .It Fl W
 114 Attempt to undelete the named files.
 115 Currently, this option can only be used to recover
 116 files covered by whiteouts in a union file system (see
 117 .Xr undelete 2 ) .
 118 .It Fl x
 119 When removing a hierarchy, do not cross mount points.
 120 .El
 121 .Pp
 122 The
 123 .Nm
 124 utility removes symbolic links, not the files referenced by the links.
 125 .Pp
 126 It is an error to attempt to remove the files
 127 .Pa / ,
 128 .Pa .\&
 129 or
 130 .Pa .. .
 131 .Pp
 132 When the utility is called as
 133 .Nm unlink ,
 134 only one argument,
 135 which must not be a directory,
 136 may be supplied.
 137 No options may be supplied in this simple mode of operation,
 138 which performs an
 139 .Xr unlink 2
 140 operation on the passed argument.
 141 However, the usual option-end delimiter,
 142 .Fl - ,
 143 may optionally precede the argument.
 144 .Sh EXIT STATUS
 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 NOTES
 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 .Pp
 170 .Dl "rm -- -filename"
 171 .Pp
 172 The same behavior can be obtained by using an absolute or relative
 173 path reference.
 174 For example:
 175 .Pp
 176 .Dl "rm /home/user/-filename"
 177 .Dl "rm ./-filename"
 178 .Sh EXAMPLES
 179 Recursively remove all files contained within the
 180 .Pa foobar
 181 directory hierarchy:
 182 .Pp
 183 .Dl $ rm -rf foobar
 184 .Pp
 185 Any of these commands will remove the file
 186 .Pa -f :
 187 .Bd -literal -offset indent
 188 $ rm -- -f
 189 $ rm ./-f
 190 $ unlink -f
 191 .Ed
 192 .Sh COMPATIBILITY
 193 The
 194 .Nm
 195 utility differs from historical implementations in that the
 196 .Fl f
 197 option only masks attempts to remove non-existent files instead of
 198 masking a large variety of errors.
 199 The
 200 .Fl v
 201 option is non-standard and its use in scripts is not recommended.
 202 .Pp
 203 Also, historical
 204 .Bx
 205 implementations prompted on the standard output,
 206 not the standard error output.
 207 .Pp
 208 The
 209 .Fl P
 210 option does not have any effect as of
 211 .Fx 13
 212 and may be removed in the future.
 213 .Sh SEE ALSO
 214 .Xr chflags 1 ,
 215 .Xr rmdir 1 ,
 216 .Xr undelete 2 ,
 217 .Xr unlink 2 ,
 218 .Xr fts 3 ,
 219 .Xr getopt 3 ,
 220 .Xr symlink 7
 221 .Sh STANDARDS
 222 The
 223 .Nm
 224 command conforms to
 225 .St -p1003.1-2013 .
 226 .Pp
 227 The simplified
 228 .Nm unlink
 229 command conforms to
 230 .St -susv2 .
 231 .Sh HISTORY
 232 A
 233 .Nm
 234 command appeared in
 235 .At v1 .