xref: /freebsd/bin/rm/rm.1 (revision afe61c15161c324a7af299a9b8457aba5afc92db)
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.2 (Berkeley) 4/18/94
36.\"
37.Dd April 18, 1994
38.Dt RM 1
39.Os
40.Sh NAME
41.Nm rm
42.Nd remove directory entries
43.Sh SYNOPSIS
44.Nm rm
45.Op Fl f | Fl i
46.Op Fl dPRr
47.Ar file ...
48.Sh DESCRIPTION
49The
50.Nm rm
51utility attempts to remove the non-directory type files specified on the
52command line.
53If the permissions of the file do not permit writing, and the standard
54input device is a terminal, the user is prompted (on the standard error
55output) for confirmation.
56.Pp
57The options are as follows:
58.Bl -tag -width flag
59.It Fl d
60Attempt to remove directories as well as other types of files.
61.It Fl f
62Attempt to remove the files without prompting for confirmation,
63regardless of the file's permissions.
64If the file does not exist, do not display a diagnostic message or modify
65the exit status to reflect an error.
66The
67.Fl f
68option overrides any previous
69.Fl i
70options.
71.It Fl i
72Request confirmation before attempting to remove each file, regardless of
73the file's permissions, or whether or not the standard input device is a
74terminal.
75The
76.Fl i
77option overrides any previous
78.Fl f
79options.
80.It Fl P
81Overwrite regular files before deleting them.
82Files are overwritten three times, first with the byte pattern 0xff,
83then 0x00, and then 0xff again, before they are deleted.
84.It Fl R
85Attempt to remove the file hierarchy rooted in each file argument.
86The
87.Fl R
88option implies the
89.Fl d
90option.
91If the
92.Fl i
93option is specified, the user is prompted for confirmation before
94each directory's contents are processed (as well as before the attempt
95is made to remove the directory).
96If the user does not respond affirmatively, the file hierarchy rooted in
97that directory is skipped.
98.Pp
99.It Fl r
100Equivalent to
101.Fl R .
102.El
103.Pp
104The
105.Nm rm
106utility removes symbolic links, not the files referenced by the links.
107.Pp
108It is an error to attempt to remove the files ``.'' and ``..''.
109.Pp
110The
111.Nm rm
112utility exits 0 if all of the named files or file hierarchies were removed,
113or if the
114.Fl f
115option was specified and all of the existing files or file hierarchies were
116removed.
117If an error occurs,
118.Nm rm
119exits with a value >0.
120.Sh SEE ALSO
121.Xr rmdir 1 ,
122.Xr unlink 2 ,
123.Xr fts 3 ,
124.Xr symlink 7
125.Sh BUGS
126The
127.Fl P
128option assumes that the underlying file system is a fixed-block file
129system.
130UFS is a fixed-block file system, LFS is not.
131In addition, only regular files are overwritten, other types of files
132are not.
133.Sh COMPATIBILITY
134The
135.Nm rm
136utility differs from historical implementations in that the
137.Fl f
138option only masks attempts to remove non-existent files instead of
139masking a large variety of errors.
140.Pp
141Also, historical
142.Bx
143implementations prompted on the standard output,
144not the standard error output.
145.Sh STANDARDS
146The
147.Nm rm
148command is expected to be
149.St -p1003.2
150compatible.
151