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 January 28, 1999
  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 dfiPRrvW
  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 P
  84 Overwrite regular files before deleting them.
  85 Files are overwritten three times, first with the byte pattern 0xff,
  86 then 0x00, and then 0xff again, before they are deleted.
  87 .It Fl R
  88 Attempt to remove the file hierarchy rooted in each file argument.
  89 The
  90 .Fl R
  91 option implies the
  92 .Fl d
  93 option.
  94 If the
  95 .Fl i
  96 option is specified, the user is prompted for confirmation before
  97 each directory's contents are processed (as well as before the attempt
  98 is made to remove the directory).
  99 If the user does not respond affirmatively, the file hierarchy rooted in
 100 that directory is skipped.
 101 .Pp
 102 .It Fl r
 103 Equivalent to
 104 .Fl R .
 105 .It Fl v
 106 Be verbose when deleting files, showing them as they are removed.
 107 .It Fl W
 108 Attempt to undelete the named files.
 109 Currently, this option can only be used to recover
 110 files covered by whiteouts.
 111 .El
 112 .Pp
 113 The
 114 .Nm
 115 utility removes symbolic links, not the files referenced by the links.
 116 .Pp
 117 It is an error to attempt to remove the files
 118 .Dq .\&
 119 or
 120 .Dq .. .
 121 .Pp
 122 When the utility is called as
 123 .Nm unlink ,
 124 only one argument,
 125 which must not be a directory,
 126 may be supplied.
 127 No options may be supplied in this simple mode of operation,
 128 which performs an
 129 .Xr unlink 2
 130 operation on the passed argument.
 131 .Pp
 132 The
 133 .Nm
 134 utility exits 0 if all of the named files or file hierarchies were removed,
 135 or if the
 136 .Fl f
 137 option was specified and all of the existing files or file hierarchies were
 138 removed.
 139 If an error occurs,
 140 .Nm
 141 exits with a value >0.
 142 .Sh NOTE
 143 The
 144 .Nm
 145 command uses
 146 .Xr getopt 3
 147 to parse its arguments, which allows it to accept
 148 the
 149 .Sq Li --
 150 option which will cause it to stop processing flag options at that
 151 point.  This will allow the removal of file names that begin
 152 with a dash
 153 .Pq Sq - .
 154 For example:
 155 .Dl rm -- -filename
 156 The same behavior can be obtained by using an absolute or relative
 157 path reference.  For example:
 158 .Dl rm /home/user/-filename
 159 .Dl rm ./-filename
 160 .Sh SEE ALSO
 161 .Xr chflags 1 ,
 162 .Xr rmdir 1 ,
 163 .Xr undelete 2 ,
 164 .Xr unlink 2 ,
 165 .Xr fts 3 ,
 166 .Xr getopt 3 ,
 167 .Xr symlink 7
 168 .Sh BUGS
 169 The
 170 .Fl P
 171 option assumes that the underlying file system is a fixed-block file
 172 system.
 173 UFS is a fixed-block file system, LFS is not.
 174 In addition, only regular files are overwritten, other types of files
 175 are not.
 176 .Sh COMPATIBILITY
 177 The
 178 .Nm
 179 utility differs from historical implementations in that the
 180 .Fl f
 181 option only masks attempts to remove non-existent files instead of
 182 masking a large variety of errors.
 183 The
 184 .Fl v
 185 option is non-standard and its use in scripts is not recommended.
 186 .Pp
 187 Also, historical
 188 .Bx
 189 implementations prompted on the standard output,
 190 not the standard error output.
 191 .Sh STANDARDS
 192 The
 193 .Nm
 194 command conforms to
 195 .St -p1003.2 .
 196 .Pp
 197 The simplified
 198 .Nm unlink
 199 command conforms to
 200 .St -susv2 .
 201 .Sh HISTORY
 202 A
 203 .Nm
 204 command appeared in
 205 .At v1 .