1 /* `rm' file deletion utility for GNU.
2 Copyright (C) 88, 90, 91, 1994-2004 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software Foundation,
16 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18 /* Written by Paul Rubin, David MacKenzie, and Richard Stallman.
19 Reworked to use chdir and avoid recursion by Jim Meyering. */
21 /* Implementation overview:
23 In the `usual' case, RM saves no state for directories it is processing.
24 When a removal fails (either due to an error or to an interactive `no'
25 reply), the failure is noted (see description of `ht' in remove.c's
26 remove_cwd_entries function) so that when/if the containing directory
27 is reopened, RM doesn't try to remove the entry again.
29 RM may delete arbitrarily deep hierarchies -- even ones in which file
30 names (from root to leaf) are longer than the system-imposed maximum.
31 It does this by using chdir to change to each directory in turn before
32 removing the entries in that directory.
34 RM detects directory cycles lazily. See lib/cycle-check.c.
36 RM is careful to avoid forming full file names whenever possible.
37 A full file name is formed only when it is about to be used -- e.g.
38 in a diagnostic or in an interactive-mode prompt.
40 RM minimizes the number of lstat system calls it makes. On systems
41 that have valid d_type data in directory entries, RM makes only one
42 lstat call per command line argument -- regardless of the depth of
48 #include <sys/types.h>
56 #include "root-dev-ino.h"
58 /* The official name of this program (e.g., no `g' prefix). */
59 #define PROGRAM_NAME "rm"
62 "Paul Rubin", "David MacKenzie, Richard Stallman", "Jim Meyering"
64 /* Name this program was run with. */
67 /* For long options that have no equivalent short option, use a
68 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
71 NO_PRESERVE_ROOT = CHAR_MAX + 1,
73 PRESUME_INPUT_TTY_OPTION
76 static struct option const long_opts[] =
78 {"directory", no_argument, NULL, 'd'},
79 {"force", no_argument, NULL, 'f'},
80 {"interactive", no_argument, NULL, 'i'},
82 {"no-preserve-root", no_argument, NULL, NO_PRESERVE_ROOT},
83 {"preserve-root", no_argument, NULL, PRESERVE_ROOT},
85 /* This is solely for testing. Do not document. */
86 /* It is relatively difficult to ensure that there is a tty on stdin.
87 Since rm acts differently depending on that, without this option,
88 it'd be harder to test the parts of rm that depend on that setting. */
89 {"presume-input-tty", no_argument, NULL, PRESUME_INPUT_TTY_OPTION},
91 {"recursive", no_argument, NULL, 'r'},
92 {"verbose", no_argument, NULL, 'v'},
93 {GETOPT_HELP_OPTION_DECL},
94 {GETOPT_VERSION_OPTION_DECL},
101 if (status != EXIT_SUCCESS)
102 fprintf (stderr, _("Try `%s --help' for more information.\n"),
106 char *base = base_name (program_name);
107 printf (_("Usage: %s [OPTION]... FILE...\n"), program_name);
109 Remove (unlink) the FILE(s).\n\
111 -d, --directory unlink FILE, even if it is a non-empty directory\n\
112 (super-user only; this works only if your system\n\
113 supports `unlink' for nonempty directories)\n\
114 -f, --force ignore nonexistent files, never prompt\n\
115 -i, --interactive prompt before any removal\n\
118 --no-preserve-root do not treat `/' specially (the default)\n\
119 --preserve-root fail to operate recursively on `/'\n\
120 -r, -R, --recursive remove the contents of directories recursively\n\
121 -v, --verbose explain what is being done\n\
123 fputs (HELP_OPTION_DESCRIPTION, stdout);
124 fputs (VERSION_OPTION_DESCRIPTION, stdout);
127 To remove a file whose name starts with a `-', for example `-foo',\n\
128 use one of these commands:\n\
136 Note that if you use rm to remove a file, it is usually possible to recover\n\
137 the contents of that file. If you want more assurance that the contents are\n\
138 truly unrecoverable, consider using shred.\n\
140 printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
146 rm_option_init (struct rm_options *x)
148 x->unlink_dirs = false;
149 x->ignore_missing_files = false;
150 x->interactive = false;
151 x->recursive = false;
152 x->root_dev_ino = NULL;
153 x->stdin_tty = isatty (STDIN_FILENO);
156 /* Since this program exits immediately after calling `rm', rm need not
157 expend unnecessary effort to preserve the initial working directory. */
158 x->require_restore_cwd = false;
162 main (int argc, char **argv)
164 bool preserve_root = false;
168 initialize_main (&argc, &argv);
169 program_name = argv[0];
170 setlocale (LC_ALL, "");
171 bindtextdomain (PACKAGE, LOCALEDIR);
172 textdomain (PACKAGE);
174 atexit (close_stdout);
178 while ((c = getopt_long (argc, argv, "dfirvR", long_opts, NULL)) != -1)
183 x.unlink_dirs = true;
187 x.interactive = false;
188 x.ignore_missing_files = true;
192 x.interactive = true;
193 x.ignore_missing_files = false;
201 case NO_PRESERVE_ROOT:
202 preserve_root = false;
206 preserve_root = true;
209 case PRESUME_INPUT_TTY_OPTION:
217 case_GETOPT_HELP_CHAR;
218 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
220 usage (EXIT_FAILURE);
226 if (x.ignore_missing_files)
230 error (0, 0, _("missing operand"));
231 usage (EXIT_FAILURE);
235 if (x.recursive & preserve_root)
237 static struct dev_ino dev_ino_buf;
238 x.root_dev_ino = get_root_dev_ino (&dev_ino_buf);
239 if (x.root_dev_ino == NULL)
240 error (EXIT_FAILURE, errno, _("failed to get attributes of %s"),
245 size_t n_files = argc - optind;
246 char const *const *file = (char const *const *) argv + optind;
248 enum RM_status status = rm (n_files, file, &x);
249 assert (VALID_STATUS (status));
250 exit (status == RM_ERROR ? EXIT_FAILURE : EXIT_SUCCESS);