d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6c11797498
freebsd-skq/bin/rm/rm.1

233 lines
6.2 KiB
Groff
Raw Normal View History

/*- or .\"- or #- to begin license clauses.
2005-01-10 08:39:26 +00:00
.\"-
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.\" Copyright (c) 1990, 1993, 1994
.\" The Regents of the University of California. All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
Merge Lite2 mods, and -Wall cleaning. Unimplemented undelete(2) cruft is protected by a #ifdef (BSD4_4_LITE) that should be removed when this is supported by the kernel.
1996-12-14 06:11:53 +00:00
.\" @(#)rm.1 8.5 (Berkeley) 12/5/94
$Id$ -> $FreeBSD$
1999-08-27 23:15:48 +00:00
.\" $FreeBSD$
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.\"
Give a hint to the reader as to what the "whiteout" actually means.
2006-12-26 13:57:40 +00:00
.Dd December 26, 2006
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Dt RM 1
.Os
.Sh NAME
Add link(1) and unlink(1) as special cases of ln(1) and rm(1) respectively, in accordance with SUSv2. This differs from the approach taken in NetBSD, but provides less obscure error messages in at least the EISDIR case and does not take up additional disk space for new binaries. PR: 13071 PR: 13074 Requested by: James Howard <howardjp@wam.umd.edu>
1999-12-20 16:13:47 +00:00
.Nm rm ,
.Nm unlink
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Nd remove directory entries
.Sh SYNOPSIS
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 11:39:41 +00:00
.Nm
Sync program's usage() with manpage's SYNOPSIS.
2005-02-09 17:37:39 +00:00
.Op Fl f | i
.Op Fl dIPRrvW
mdoc(7) police: use the default ``file ...'' feature of the .Ar macro.
2001-02-13 09:56:35 +00:00
.Ar
Add link(1) and unlink(1) as special cases of ln(1) and rm(1) respectively, in accordance with SUSv2. This differs from the approach taken in NetBSD, but provides less obscure error messages in at least the EISDIR case and does not take up additional disk space for new binaries. PR: 13071 PR: 13074 Requested by: James Howard <howardjp@wam.umd.edu>
1999-12-20 16:13:47 +00:00
.Nm unlink
.Ar file
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Sh DESCRIPTION
The
.Nm rm -> .Nm.
1998-05-18 06:37:35 +00:00
.Nm
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
utility attempts to remove the non-directory type files specified on the
command line.
If the permissions of the file do not permit writing, and the standard
input device is a terminal, the user is prompted (on the standard error
output) for confirmation.
.Pp
The options are as follows:
Fix markup, add the EXIT STATUS section.
2006-12-26 13:44:41 +00:00
.Bl -tag -width indent
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.It Fl d
Attempt to remove directories as well as other types of files.
.It Fl f
Attempt to remove the files without prompting for confirmation,
regardless of the file's permissions.
If the file does not exist, do not display a diagnostic message or modify
the exit status to reflect an error.
The
.Fl f
option overrides any previous
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
.Fl i
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
options.
.It Fl i
Request confirmation before attempting to remove each file, regardless of
the file's permissions, or whether or not the standard input device is a
terminal.
The
.Fl i
option overrides any previous
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
.Fl f
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
options.
Add -I, an option that asks for confirmation once if recursively removing directories or if more than 3 files are listed in the command line. This feature is intended to provide a safe net but not being too annoying like having "rm -i" for every deleting operations, and is generally good for both newbies and power users, preventing them from being so easily run into ``rm -rf /'', ``rm -rf *'' and so forth. Originally implemented by Matthew Dillon for DragonFly, plus some improvements done by various DragonFly contributors. Approved by: murray (mentor; the original dillon's version) Discussed with: des Obtained from: DragonFly's bin/rm/ rm.c rev. 1.4 - 1.8 rm.1 rev. 1.3 - 1.4 MFC After: 1 month
2004-10-28 08:25:30 +00:00
.It Fl I
Correct a typo and make the documentation more mdoc(7) complaint. Pointed out by: dd Approved by: murray (mentor)
2004-11-01 16:52:34 +00:00
Request confirmation once if more than three files are being removed or if a
directory is being recursively removed.
This is a far less intrusive option than
Add -I, an option that asks for confirmation once if recursively removing directories or if more than 3 files are listed in the command line. This feature is intended to provide a safe net but not being too annoying like having "rm -i" for every deleting operations, and is generally good for both newbies and power users, preventing them from being so easily run into ``rm -rf /'', ``rm -rf *'' and so forth. Originally implemented by Matthew Dillon for DragonFly, plus some improvements done by various DragonFly contributors. Approved by: murray (mentor; the original dillon's version) Discussed with: des Obtained from: DragonFly's bin/rm/ rm.c rev. 1.4 - 1.8 rm.1 rev. 1.3 - 1.4 MFC After: 1 month
2004-10-28 08:25:30 +00:00
.Fl i
yet provides almost the same level of protection against mistakes.
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.It Fl P
Overwrite regular files before deleting them.
Files are overwritten three times, first with the byte pattern 0xff,
then 0x00, and then 0xff again, before they are deleted.
Correct a security issue introduced in previous commit: instead of removing the file and issue a warning about the removal, do not do any operation at all in case -P is specified when the dinode has hard links. With -f and -P specified together, we assume that the user wants rm to overwrite the contents of the file and remove it (destroy the contents of file but leave its hard links as is). The reason of doing it this way is that, in case where a hard link is created by a malicious user (currently this is permitted even if the user has no access to the file). Losing the link can potentially mean that the actual owner would lose control completely to the user who wants to obtain access in a future day. Discussed with: Peter Jermey
2006-10-31 02:22:36 +00:00
Files with multiple links will not be overwritten nor deleted unless
.Fl f
is specified, a warning is generated instead.
Be more reasonable when overwrite mode is specified while there is hard links. Overwritting when links > 1 would cause data loss, which is usually undesired. Inspired by: discussion on -hackers@ Suggested by: elessar at bsdforen de Obtained from: OpenBSD
2006-10-30 03:32:09 +00:00
.Pp
Handle the case where the -P flag is specified for a read-only file earlier, and more gracefully. Previously, this combination would be ignored early in the code where permissions are tested and fail later with a very unhelpful "permission denied" error. Instead, test for this flag in the same block that generates the "override?" messages for read-only files, but instead of trying to guess what the user has in mind, generate an error and exit. Update the man page to reflect this new behavior. Not objected to by: freebsd-hackers@
2005-09-29 20:40:29 +00:00
Specifying this flag for a read only file will cause
.Nm
to generate an error message and exit.
-mdoc sweep.
2005-11-17 12:15:23 +00:00
The file will not be removed or overwritten.
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.It Fl R
Fix markup, add the EXIT STATUS section.
2006-12-26 13:44:41 +00:00
Attempt to remove the file hierarchy rooted in each
.Ar file
argument.
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
The
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Fl R
option implies the
.Fl d
option.
If the
.Fl i
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
option is specified, the user is prompted for confirmation before
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
each directory's contents are processed (as well as before the attempt
is made to remove the directory).
If the user does not respond affirmatively, the file hierarchy rooted in
that directory is skipped.
.Pp
.It Fl r
Equivalent to
.Fl R .
brucify, `v' before `W', mention -v is non-standard in manpage and make code slightly easier to read Reviewed by: obrien
1999-09-04 03:40:10 +00:00
.It Fl v
Be verbose when deleting files, showing them as they are removed.
Merge Lite2 mods, and -Wall cleaning. Unimplemented undelete(2) cruft is protected by a #ifdef (BSD4_4_LITE) that should be removed when this is supported by the kernel.
1996-12-14 06:11:53 +00:00
.It Fl W
.Nm rm -> .Nm.
1998-05-18 06:37:35 +00:00
Attempt to undelete the named files.
Merge Lite2 mods, and -Wall cleaning. Unimplemented undelete(2) cruft is protected by a #ifdef (BSD4_4_LITE) that should be removed when this is supported by the kernel.
1996-12-14 06:11:53 +00:00
Currently, this option can only be used to recover
Give a hint to the reader as to what the "whiteout" actually means.
2006-12-26 13:57:40 +00:00
files covered by whiteouts in a union file system (see
.Xr undelete 2 ) .
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.El
.Pp
The
.Nm rm -> .Nm.
1998-05-18 06:37:35 +00:00
.Nm
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
utility removes symbolic links, not the files referenced by the links.
.Pp
Use .Dq instead of ``'' in manpage Use optimal blocksize for rm -P, instead of always using 8192-byte blocks to overwrite the file. Obtained from: OpenBSD
1999-05-28 12:47:31 +00:00
It is an error to attempt to remove the files
Markup fixes. Pointed out by: ru
2004-10-04 19:03:44 +00:00
.Pa / ,
.Pa .\&
Use .Dq instead of ``'' in manpage Use optimal blocksize for rm -P, instead of always using 8192-byte blocks to overwrite the file. Obtained from: OpenBSD
1999-05-28 12:47:31 +00:00
or
Markup fixes. Pointed out by: ru
2004-10-04 19:03:44 +00:00
.Pa .. .
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Pp
Add link(1) and unlink(1) as special cases of ln(1) and rm(1) respectively, in accordance with SUSv2. This differs from the approach taken in NetBSD, but provides less obscure error messages in at least the EISDIR case and does not take up additional disk space for new binaries. PR: 13071 PR: 13074 Requested by: James Howard <howardjp@wam.umd.edu>
1999-12-20 16:13:47 +00:00
When the utility is called as
.Nm unlink ,
only one argument,
which must not be a directory,
may be supplied.
No options may be supplied in this simple mode of operation,
Fix cut'n'paste niggles in previous commit.
1999-12-21 08:57:58 +00:00
which performs an
Add link(1) and unlink(1) as special cases of ln(1) and rm(1) respectively, in accordance with SUSv2. This differs from the approach taken in NetBSD, but provides less obscure error messages in at least the EISDIR case and does not take up additional disk space for new binaries. PR: 13071 PR: 13074 Requested by: James Howard <howardjp@wam.umd.edu>
1999-12-20 16:13:47 +00:00
.Xr unlink 2
Fix cut'n'paste niggles in previous commit.
1999-12-21 08:57:58 +00:00
operation on the passed argument.
Fix markup, add the EXIT STATUS section.
2006-12-26 13:44:41 +00:00
.Sh EXIT STATUS
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
The
.Nm rm -> .Nm.
1998-05-18 06:37:35 +00:00
.Nm
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
utility exits 0 if all of the named files or file hierarchies were removed,
or if the
.Fl f
option was specified and all of the existing files or file hierarchies were
removed.
If an error occurs,
.Nm rm -> .Nm.
1998-05-18 06:37:35 +00:00
.Nm
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
exits with a value >0.
Fix markup, add the EXIT STATUS section.
2006-12-26 13:44:41 +00:00
.Sh NOTES
Improve the wording in the NOTES section. Closes PR# 3223.
1997-04-08 20:27:48 +00:00
The
.Nm
command uses
fix usage string respond `Y' is equal to `y' Add a note how to delete file name with beginning `-'
1996-03-07 23:26:59 +00:00
.Xr getopt 3
Improve the wording in the NOTES section. Closes PR# 3223.
1997-04-08 20:27:48 +00:00
to parse its arguments, which allows it to accept
the
fix usage string respond `Y' is equal to `y' Add a note how to delete file name with beginning `-'
1996-03-07 23:26:59 +00:00
.Sq Li --
Improve the wording in the NOTES section. Closes PR# 3223.
1997-04-08 20:27:48 +00:00
option which will cause it to stop processing flag options at that
Mechanically kill hard sentence breaks.
2004-07-02 21:04:19 +00:00
point.
This will allow the removal of file names that begin
Improve the wording in the NOTES section. Closes PR# 3223.
1997-04-08 20:27:48 +00:00
with a dash
.Pq Sq - .
For example:
Fix markup, add the EXIT STATUS section.
2006-12-26 13:44:41 +00:00
.Pp
.Dl "rm -- -filename"
.Pp
Provide examples of how to remove file names that begin with a dash in non-getopt implementations. E.g.: rm /home/mpp/-filename rm ./-filename Requested by: bde
1997-04-09 05:04:43 +00:00
The same behavior can be obtained by using an absolute or relative
Mechanically kill hard sentence breaks.
2004-07-02 21:04:19 +00:00
path reference.
For example:
Fix markup, add the EXIT STATUS section.
2006-12-26 13:44:41 +00:00
.Pp
.Dl "rm /home/user/-filename"
.Dl "rm ./-filename"
Correct a security issue introduced in previous commit: instead of removing the file and issue a warning about the removal, do not do any operation at all in case -P is specified when the dinode has hard links. With -f and -P specified together, we assume that the user wants rm to overwrite the contents of the file and remove it (destroy the contents of file but leave its hard links as is). The reason of doing it this way is that, in case where a hard link is created by a malicious user (currently this is permitted even if the user has no access to the file). Losing the link can potentially mean that the actual owner would lose control completely to the user who wants to obtain access in a future day. Discussed with: Peter Jermey
2006-10-31 02:22:36 +00:00
.Pp
When
.Fl P
is specified with
.Fl f
the file will be overwritten and removed even if it has hard links.
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Sh COMPATIBILITY
The
.Nm rm -> .Nm.
1998-05-18 06:37:35 +00:00
.Nm
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
utility differs from historical implementations in that the
.Fl f
option only masks attempts to remove non-existent files instead of
masking a large variety of errors.
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
The
brucify, `v' before `W', mention -v is non-standard in manpage and make code slightly easier to read Reviewed by: obrien
1999-09-04 03:40:10 +00:00
.Fl v
option is non-standard and its use in scripts is not recommended.
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Pp
Also, historical
.Bx
implementations prompted on the standard output,
not the standard error output.
Add the new standard EXIT STATUS section where appropriate. Sort standard sections in the (documented) preferred order.
2005-01-16 16:41:59 +00:00
.Sh SEE ALSO
.Xr chflags 1 ,
.Xr rmdir 1 ,
.Xr undelete 2 ,
.Xr unlink 2 ,
.Xr fts 3 ,
.Xr getopt 3 ,
.Xr symlink 7
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Sh STANDARDS
The
.Nm rm -> .Nm.
1998-05-18 06:37:35 +00:00
.Nm
Update STANDARDS section on rm(1) to reflect current conformance. PR: 35471
2002-03-02 05:10:11 +00:00
command conforms to
.St -p1003.2 .
Fix cut'n'paste niggles in previous commit.
1999-12-21 08:57:58 +00:00
.Pp
The simplified
.Nm unlink
command conforms to
.St -susv2 .
[HISTORY] command appeared in Version 1 AT&T UNIX Obtained from: A Quarter Century of UNIX, Peter H. Salus, page 41
1996-08-29 18:06:19 +00:00
.Sh HISTORY
A
.Nm
command appeared in
.At v1 .
Add the new standard EXIT STATUS section where appropriate. Sort standard sections in the (documented) preferred order.
2005-01-16 16:41:59 +00:00
.Sh BUGS
The
.Fl P
option assumes that the underlying file system is a fixed-block file
system.
UFS is a fixed-block file system, LFS is not.
In addition, only regular files are overwritten, other types of files
are not.
Reference in New Issue Copy Permalink