xref: /386bsd/usr/src/bin/rm/rm.1 (revision a2142627)
1.\" Copyright (c) 1990 The Regents of the University of California.
2.\" 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	6.9 (Berkeley) 7/27/91
36.\"
37.Dd July 27, 1991
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 dRr
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 R
81Attempt to remove the file hierarchy rooted in each file argument.
82The
83.Fl R
84option implies the
85.Fl d
86option.
87If the
88.Fl i
89option is specified, the user is prompted for confirmation before
90each directory's contents are processed (as well as before the attempt
91is made to remove the directory).
92If the user does not respond affirmatively, the file hierarchy rooted in
93that directory is skipped.
94.Pp
95.It Fl r
96Equivalent to
97.Fl R .
98.El
99.Pp
100The
101.Nm rm
102utility removes symbolic links, not the files referenced by the links.
103.Pp
104It is an error to attempt to remove the files ``.'' and ``..''.
105.Pp
106The
107.Nm rm
108utility exits 0 if all of the named files or file hierarchies were removed,
109or if the
110.Fl f
111option was specified and all of the existing files or file hierarchies were
112removed.
113If an error occurs,
114.Nm rm
115exits with a value >0.
116.Sh SEE ALSO
117.Xr rmdir 1 ,
118.Xr unlink 2 ,
119.Xr fts 3
120.Sh COMPATIBILITY
121The
122.Nm rm
123utility differs from historical implementations in that the
124.Fl f
125option only masks attempts to remove non-existent files instead of
126masking a large variety of errors.
127.Pp
128Also, historical
129.Bx
130implementations prompted on the standard output,
131not the standard error output.
132.Sh STANDARDS
133The
134.Nm rm
135command is expected to be
136.St -p1003.2
137compatible.
138