Fix a typo
[tar/ericb.git] / src / tar.c
blobf3228e146c79ebcb9037a86e48599bfe5a8f3131
1 /* A tar (tape archiver) program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
4 2001, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 Written by John Gilmore, starting 1985-08-25.
8 This program is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 3, or (at your option) any later
11 version.
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
16 Public License for more details.
18 You should have received a copy of the GNU General Public License along
19 with this program; if not, write to the Free Software Foundation, Inc.,
20 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
22 #include <system.h>
24 #include <fnmatch.h>
25 #include <argp.h>
26 #include <argp-namefrob.h>
27 #include <argp-fmtstream.h>
29 #include <signal.h>
30 #if ! defined SIGCHLD && defined SIGCLD
31 # define SIGCHLD SIGCLD
32 #endif
34 /* The following causes "common.h" to produce definitions of all the global
35 variables, rather than just "extern" declarations of them. GNU tar does
36 depend on the system loader to preset all GLOBAL variables to neutral (or
37 zero) values; explicit initialization is usually not done. */
38 #define GLOBAL
39 #include "common.h"
41 #include <argmatch.h>
42 #include <closeout.h>
43 #include <configmake.h>
44 #include <exitfail.h>
45 #include <getdate.h>
46 #include <rmt.h>
47 #include <rmt-command.h>
48 #include <prepargs.h>
49 #include <quotearg.h>
50 #include <version-etc.h>
51 #include <xstrtol.h>
52 #include <stdopen.h>
54 /* Local declarations. */
56 #ifndef DEFAULT_ARCHIVE_FORMAT
57 # define DEFAULT_ARCHIVE_FORMAT GNU_FORMAT
58 #endif
60 #ifndef DEFAULT_ARCHIVE
61 # define DEFAULT_ARCHIVE "tar.out"
62 #endif
64 #ifndef DEFAULT_BLOCKING
65 # define DEFAULT_BLOCKING 20
66 #endif
69 /* Miscellaneous. */
71 /* Name of option using stdin. */
72 static const char *stdin_used_by;
74 /* Doesn't return if stdin already requested. */
75 void
76 request_stdin (const char *option)
78 if (stdin_used_by)
79 USAGE_ERROR ((0, 0, _("Options `-%s' and `-%s' both want standard input"),
80 stdin_used_by, option));
82 stdin_used_by = option;
85 extern int rpmatch (char const *response);
87 /* Returns true if and only if the user typed an affirmative response. */
88 int
89 confirm (const char *message_action, const char *message_name)
91 static FILE *confirm_file;
92 static int confirm_file_EOF;
93 bool status = false;
95 if (!confirm_file)
97 if (archive == 0 || stdin_used_by)
99 confirm_file = fopen (TTY_NAME, "r");
100 if (! confirm_file)
101 open_fatal (TTY_NAME);
103 else
105 request_stdin ("-w");
106 confirm_file = stdin;
110 fprintf (stdlis, "%s %s?", message_action, quote (message_name));
111 fflush (stdlis);
113 if (!confirm_file_EOF)
115 char *response = NULL;
116 size_t response_size = 0;
117 if (getline (&response, &response_size, confirm_file) < 0)
118 confirm_file_EOF = 1;
119 else
120 status = rpmatch (response) > 0;
121 free (response);
124 if (confirm_file_EOF)
126 fputc ('\n', stdlis);
127 fflush (stdlis);
130 return status;
133 static struct fmttab {
134 char const *name;
135 enum archive_format fmt;
136 } const fmttab[] = {
137 { "v7", V7_FORMAT },
138 { "oldgnu", OLDGNU_FORMAT },
139 { "ustar", USTAR_FORMAT },
140 { "posix", POSIX_FORMAT },
141 #if 0 /* not fully supported yet */
142 { "star", STAR_FORMAT },
143 #endif
144 { "gnu", GNU_FORMAT },
145 { "pax", POSIX_FORMAT }, /* An alias for posix */
146 { NULL, 0 }
149 static void
150 set_archive_format (char const *name)
152 struct fmttab const *p;
154 for (p = fmttab; strcmp (p->name, name) != 0; )
155 if (! (++p)->name)
156 USAGE_ERROR ((0, 0, _("%s: Invalid archive format"),
157 quotearg_colon (name)));
159 archive_format = p->fmt;
162 const char *
163 archive_format_string (enum archive_format fmt)
165 struct fmttab const *p;
167 for (p = fmttab; p->name; p++)
168 if (p->fmt == fmt)
169 return p->name;
170 return "unknown?";
173 #define FORMAT_MASK(n) (1<<(n))
175 static void
176 assert_format(unsigned fmt_mask)
178 if ((FORMAT_MASK (archive_format) & fmt_mask) == 0)
179 USAGE_ERROR ((0, 0,
180 _("GNU features wanted on incompatible archive format")));
183 const char *
184 subcommand_string (enum subcommand c)
186 switch (c)
188 case UNKNOWN_SUBCOMMAND:
189 return "unknown?";
191 case APPEND_SUBCOMMAND:
192 return "-r";
194 case CAT_SUBCOMMAND:
195 return "-A";
197 case CREATE_SUBCOMMAND:
198 return "-c";
200 case DELETE_SUBCOMMAND:
201 return "-D";
203 case DIFF_SUBCOMMAND:
204 return "-d";
206 case EXTRACT_SUBCOMMAND:
207 return "-x";
209 case LIST_SUBCOMMAND:
210 return "-t";
212 case UPDATE_SUBCOMMAND:
213 return "-u";
215 default:
216 abort ();
220 void
221 tar_list_quoting_styles (argp_fmtstream_t fs, char *prefix)
223 int i;
225 for (i = 0; quoting_style_args[i]; i++)
226 argp_fmtstream_printf (fs, "%s%s\n", prefix, quoting_style_args[i]);
229 void
230 tar_set_quoting_style (char *arg)
232 int i;
234 for (i = 0; quoting_style_args[i]; i++)
235 if (strcmp (arg, quoting_style_args[i]) == 0)
237 set_quoting_style (NULL, i);
238 return;
240 FATAL_ERROR ((0, 0,
241 _("Unknown quoting style `%s'. Try `%s --quoting-style=help' to get a list."), arg, program_invocation_short_name));
245 /* Options. */
247 enum
249 ANCHORED_OPTION = CHAR_MAX + 1,
250 ATIME_PRESERVE_OPTION,
251 BACKUP_OPTION,
252 CHECKPOINT_OPTION,
253 CHECKPOINT_ACTION_OPTION,
254 DELAY_DIRECTORY_RESTORE_OPTION,
255 HARD_DEREFERENCE_OPTION,
256 DELETE_OPTION,
257 EXCLUDE_CACHES_OPTION,
258 EXCLUDE_CACHES_UNDER_OPTION,
259 EXCLUDE_CACHES_ALL_OPTION,
260 EXCLUDE_OPTION,
261 EXCLUDE_TAG_OPTION,
262 EXCLUDE_TAG_UNDER_OPTION,
263 EXCLUDE_TAG_ALL_OPTION,
264 EXCLUDE_VCS_OPTION,
265 FORCE_LOCAL_OPTION,
266 GROUP_OPTION,
267 HANG_OPTION,
268 IGNORE_CASE_OPTION,
269 IGNORE_COMMAND_ERROR_OPTION,
270 IGNORE_FAILED_READ_OPTION,
271 INDEX_FILE_OPTION,
272 KEEP_NEWER_FILES_OPTION,
273 LZMA_OPTION,
274 MODE_OPTION,
275 MTIME_OPTION,
276 NEWER_MTIME_OPTION,
277 NO_ANCHORED_OPTION,
278 NO_DELAY_DIRECTORY_RESTORE_OPTION,
279 NO_IGNORE_CASE_OPTION,
280 NO_IGNORE_COMMAND_ERROR_OPTION,
281 NO_OVERWRITE_DIR_OPTION,
282 NO_QUOTE_CHARS_OPTION,
283 NO_RECURSION_OPTION,
284 NO_SAME_OWNER_OPTION,
285 NO_SAME_PERMISSIONS_OPTION,
286 NO_UNQUOTE_OPTION,
287 NO_WILDCARDS_MATCH_SLASH_OPTION,
288 NO_WILDCARDS_OPTION,
289 NULL_OPTION,
290 NUMERIC_OWNER_OPTION,
291 OCCURRENCE_OPTION,
292 OLD_ARCHIVE_OPTION,
293 ONE_FILE_SYSTEM_OPTION,
294 OVERWRITE_DIR_OPTION,
295 OVERWRITE_OPTION,
296 OWNER_OPTION,
297 PAX_OPTION,
298 POSIX_OPTION,
299 PRESERVE_OPTION,
300 QUOTE_CHARS_OPTION,
301 QUOTING_STYLE_OPTION,
302 RECORD_SIZE_OPTION,
303 RECURSION_OPTION,
304 RECURSIVE_UNLINK_OPTION,
305 REMOVE_FILES_OPTION,
306 RESTRICT_OPTION,
307 RMT_COMMAND_OPTION,
308 RSH_COMMAND_OPTION,
309 SAME_OWNER_OPTION,
310 SHOW_DEFAULTS_OPTION,
311 SHOW_OMITTED_DIRS_OPTION,
312 SHOW_TRANSFORMED_NAMES_OPTION,
313 SPARSE_VERSION_OPTION,
314 STRIP_COMPONENTS_OPTION,
315 SUFFIX_OPTION,
316 TEST_LABEL_OPTION,
317 TOTALS_OPTION,
318 TO_COMMAND_OPTION,
319 TRANSFORM_OPTION,
320 UNQUOTE_OPTION,
321 USAGE_OPTION,
322 USE_COMPRESS_PROGRAM_OPTION,
323 UTC_OPTION,
324 VERSION_OPTION,
325 VOLNO_FILE_OPTION,
326 WILDCARDS_MATCH_SLASH_OPTION,
327 WILDCARDS_OPTION
330 const char *argp_program_version = "tar (" PACKAGE_NAME ") " VERSION;
331 const char *argp_program_bug_address = "<" PACKAGE_BUGREPORT ">";
332 static char const doc[] = N_("\
333 GNU `tar' saves many files together into a single tape or disk archive, \
334 and can restore individual files from the archive.\n\
336 Examples:\n\
337 tar -cf archive.tar foo bar # Create archive.tar from files foo and bar.\n\
338 tar -tvf archive.tar # List all files in archive.tar verbosely.\n\
339 tar -xf archive.tar # Extract all files from archive.tar.\n")
340 "\v"
341 N_("The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
342 The version control may be set with --backup or VERSION_CONTROL, values are:\n\n\
343 none, off never make backups\n\
344 t, numbered make numbered backups\n\
345 nil, existing numbered if numbered backups exist, simple otherwise\n\
346 never, simple always make simple backups\n");
349 /* NOTE:
351 Available option letters are DEIJQY and eqy. Consider the following
352 assignments:
354 [For Solaris tar compatibility =/= Is it important at all?]
355 e exit immediately with a nonzero exit status if unexpected errors occur
356 E use extended headers (--format=posix)
358 [q alias for --occurrence=1 =/= this would better be used for quiet?]
359 [I same as T =/= will harm star compatibility]
361 y per-file gzip compression
362 Y per-block gzip compression */
364 static struct argp_option options[] = {
365 #define GRID 10
366 {NULL, 0, NULL, 0,
367 N_("Main operation mode:"), GRID },
369 {"list", 't', 0, 0,
370 N_("list the contents of an archive"), GRID+1 },
371 {"extract", 'x', 0, 0,
372 N_("extract files from an archive"), GRID+1 },
373 {"get", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
374 {"create", 'c', 0, 0,
375 N_("create a new archive"), GRID+1 },
376 {"diff", 'd', 0, 0,
377 N_("find differences between archive and file system"), GRID+1 },
378 {"compare", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
379 {"append", 'r', 0, 0,
380 N_("append files to the end of an archive"), GRID+1 },
381 {"update", 'u', 0, 0,
382 N_("only append files newer than copy in archive"), GRID+1 },
383 {"catenate", 'A', 0, 0,
384 N_("append tar files to an archive"), GRID+1 },
385 {"concatenate", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
386 {"delete", DELETE_OPTION, 0, 0,
387 N_("delete from the archive (not on mag tapes!)"), GRID+1 },
388 {"test-label", TEST_LABEL_OPTION, NULL, 0,
389 N_("test the archive volume label and exit"), GRID+1 },
390 #undef GRID
392 #define GRID 20
393 {NULL, 0, NULL, 0,
394 N_("Operation modifiers:"), GRID },
396 {"sparse", 'S', 0, 0,
397 N_("handle sparse files efficiently"), GRID+1 },
398 {"sparse-version", SPARSE_VERSION_OPTION, N_("MAJOR[.MINOR]"), 0,
399 N_("set version of the sparse format to use (implies --sparse)"), GRID+1},
400 {"incremental", 'G', 0, 0,
401 N_("handle old GNU-format incremental backup"), GRID+1 },
402 {"listed-incremental", 'g', N_("FILE"), 0,
403 N_("handle new GNU-format incremental backup"), GRID+1 },
404 {"ignore-failed-read", IGNORE_FAILED_READ_OPTION, 0, 0,
405 N_("do not exit with nonzero on unreadable files"), GRID+1 },
406 {"occurrence", OCCURRENCE_OPTION, N_("NUMBER"), OPTION_ARG_OPTIONAL,
407 N_("process only the NUMBERth occurrence of each file in the archive;"
408 " this option is valid only in conjunction with one of the subcommands"
409 " --delete, --diff, --extract or --list and when a list of files"
410 " is given either on the command line or via the -T option;"
411 " NUMBER defaults to 1"), GRID+1 },
412 {"seek", 'n', NULL, 0,
413 N_("archive is seekable"), GRID+1 },
414 #undef GRID
416 #define GRID 30
417 {NULL, 0, NULL, 0,
418 N_("Overwrite control:"), GRID },
420 {"verify", 'W', 0, 0,
421 N_("attempt to verify the archive after writing it"), GRID+1 },
422 {"remove-files", REMOVE_FILES_OPTION, 0, 0,
423 N_("remove files after adding them to the archive"), GRID+1 },
424 {"keep-old-files", 'k', 0, 0,
425 N_("don't replace existing files when extracting"), GRID+1 },
426 {"keep-newer-files", KEEP_NEWER_FILES_OPTION, 0, 0,
427 N_("don't replace existing files that are newer than their archive copies"), GRID+1 },
428 {"overwrite", OVERWRITE_OPTION, 0, 0,
429 N_("overwrite existing files when extracting"), GRID+1 },
430 {"unlink-first", 'U', 0, 0,
431 N_("remove each file prior to extracting over it"), GRID+1 },
432 {"recursive-unlink", RECURSIVE_UNLINK_OPTION, 0, 0,
433 N_("empty hierarchies prior to extracting directory"), GRID+1 },
434 {"no-overwrite-dir", NO_OVERWRITE_DIR_OPTION, 0, 0,
435 N_("preserve metadata of existing directories"), GRID+1 },
436 {"overwrite-dir", OVERWRITE_DIR_OPTION, 0, 0,
437 N_("overwrite metadata of existing directories when extracting (default)"),
438 GRID+1 },
439 #undef GRID
441 #define GRID 40
442 {NULL, 0, NULL, 0,
443 N_("Select output stream:"), GRID },
445 {"to-stdout", 'O', 0, 0,
446 N_("extract files to standard output"), GRID+1 },
447 {"to-command", TO_COMMAND_OPTION, N_("COMMAND"), 0,
448 N_("pipe extracted files to another program"), GRID+1 },
449 {"ignore-command-error", IGNORE_COMMAND_ERROR_OPTION, 0, 0,
450 N_("ignore exit codes of children"), GRID+1 },
451 {"no-ignore-command-error", NO_IGNORE_COMMAND_ERROR_OPTION, 0, 0,
452 N_("treat non-zero exit codes of children as error"), GRID+1 },
453 #undef GRID
455 #define GRID 50
456 {NULL, 0, NULL, 0,
457 N_("Handling of file attributes:"), GRID },
459 {"owner", OWNER_OPTION, N_("NAME"), 0,
460 N_("force NAME as owner for added files"), GRID+1 },
461 {"group", GROUP_OPTION, N_("NAME"), 0,
462 N_("force NAME as group for added files"), GRID+1 },
463 {"mtime", MTIME_OPTION, N_("DATE-OR-FILE"), 0,
464 N_("set mtime for added files from DATE-OR-FILE"), GRID+1 },
465 {"mode", MODE_OPTION, N_("CHANGES"), 0,
466 N_("force (symbolic) mode CHANGES for added files"), GRID+1 },
467 {"atime-preserve", ATIME_PRESERVE_OPTION,
468 N_("METHOD"), OPTION_ARG_OPTIONAL,
469 N_("preserve access times on dumped files, either by restoring the times"
470 " after reading (METHOD='replace'; default) or by not setting the times"
471 " in the first place (METHOD='system')"), GRID+1 },
472 {"touch", 'm', 0, 0,
473 N_("don't extract file modified time"), GRID+1 },
474 {"same-owner", SAME_OWNER_OPTION, 0, 0,
475 N_("try extracting files with the same ownership"), GRID+1 },
476 {"no-same-owner", NO_SAME_OWNER_OPTION, 0, 0,
477 N_("extract files as yourself"), GRID+1 },
478 {"numeric-owner", NUMERIC_OWNER_OPTION, 0, 0,
479 N_("always use numbers for user/group names"), GRID+1 },
480 {"preserve-permissions", 'p', 0, 0,
481 N_("extract information about file permissions (default for superuser)"),
482 GRID+1 },
483 {"same-permissions", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
484 {"no-same-permissions", NO_SAME_PERMISSIONS_OPTION, 0, 0,
485 N_("apply the user's umask when extracting permissions from the archive (default for ordinary users)"), GRID+1 },
486 {"preserve-order", 's', 0, 0,
487 N_("sort names to extract to match archive"), GRID+1 },
488 {"same-order", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
489 {"preserve", PRESERVE_OPTION, 0, 0,
490 N_("same as both -p and -s"), GRID+1 },
491 {"delay-directory-restore", DELAY_DIRECTORY_RESTORE_OPTION, 0, 0,
492 N_("delay setting modification times and permissions of extracted"
493 " directories until the end of extraction"), GRID+1 },
494 {"no-delay-directory-restore", NO_DELAY_DIRECTORY_RESTORE_OPTION, 0, 0,
495 N_("cancel the effect of --delay-directory-restore option"), GRID+1 },
496 #undef GRID
498 #define GRID 60
499 {NULL, 0, NULL, 0,
500 N_("Device selection and switching:"), GRID },
502 {"file", 'f', N_("ARCHIVE"), 0,
503 N_("use archive file or device ARCHIVE"), GRID+1 },
504 {"force-local", FORCE_LOCAL_OPTION, 0, 0,
505 N_("archive file is local even if it has a colon"), GRID+1 },
506 {"rmt-command", RMT_COMMAND_OPTION, N_("COMMAND"), 0,
507 N_("use given rmt COMMAND instead of rmt"), GRID+1 },
508 {"rsh-command", RSH_COMMAND_OPTION, N_("COMMAND"), 0,
509 N_("use remote COMMAND instead of rsh"), GRID+1 },
510 #ifdef DEVICE_PREFIX
511 {"-[0-7][lmh]", 0, NULL, OPTION_DOC, /* It is OK, since `name' will never be
512 translated */
513 N_("specify drive and density"), GRID+1 },
514 #endif
515 {NULL, '0', NULL, OPTION_HIDDEN, NULL, GRID+1 },
516 {NULL, '1', NULL, OPTION_HIDDEN, NULL, GRID+1 },
517 {NULL, '2', NULL, OPTION_HIDDEN, NULL, GRID+1 },
518 {NULL, '3', NULL, OPTION_HIDDEN, NULL, GRID+1 },
519 {NULL, '4', NULL, OPTION_HIDDEN, NULL, GRID+1 },
520 {NULL, '5', NULL, OPTION_HIDDEN, NULL, GRID+1 },
521 {NULL, '6', NULL, OPTION_HIDDEN, NULL, GRID+1 },
522 {NULL, '7', NULL, OPTION_HIDDEN, NULL, GRID+1 },
523 {NULL, '8', NULL, OPTION_HIDDEN, NULL, GRID+1 },
524 {NULL, '9', NULL, OPTION_HIDDEN, NULL, GRID+1 },
526 {"multi-volume", 'M', 0, 0,
527 N_("create/list/extract multi-volume archive"), GRID+1 },
528 {"tape-length", 'L', N_("NUMBER"), 0,
529 N_("change tape after writing NUMBER x 1024 bytes"), GRID+1 },
530 {"info-script", 'F', N_("NAME"), 0,
531 N_("run script at end of each tape (implies -M)"), GRID+1 },
532 {"new-volume-script", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
533 {"volno-file", VOLNO_FILE_OPTION, N_("FILE"), 0,
534 N_("use/update the volume number in FILE"), GRID+1 },
535 #undef GRID
537 #define GRID 70
538 {NULL, 0, NULL, 0,
539 N_("Device blocking:"), GRID },
541 {"blocking-factor", 'b', N_("BLOCKS"), 0,
542 N_("BLOCKS x 512 bytes per record"), GRID+1 },
543 {"record-size", RECORD_SIZE_OPTION, N_("NUMBER"), 0,
544 N_("NUMBER of bytes per record, multiple of 512"), GRID+1 },
545 {"ignore-zeros", 'i', 0, 0,
546 N_("ignore zeroed blocks in archive (means EOF)"), GRID+1 },
547 {"read-full-records", 'B', 0, 0,
548 N_("reblock as we read (for 4.2BSD pipes)"), GRID+1 },
549 #undef GRID
551 #define GRID 80
552 {NULL, 0, NULL, 0,
553 N_("Archive format selection:"), GRID },
555 {"format", 'H', N_("FORMAT"), 0,
556 N_("create archive of the given format"), GRID+1 },
558 {NULL, 0, NULL, 0, N_("FORMAT is one of the following:"), GRID+2 },
559 {" v7", 0, NULL, OPTION_DOC|OPTION_NO_TRANS, N_("old V7 tar format"),
560 GRID+3 },
561 {" oldgnu", 0, NULL, OPTION_DOC|OPTION_NO_TRANS,
562 N_("GNU format as per tar <= 1.12"), GRID+3 },
563 {" gnu", 0, NULL, OPTION_DOC|OPTION_NO_TRANS,
564 N_("GNU tar 1.13.x format"), GRID+3 },
565 {" ustar", 0, NULL, OPTION_DOC|OPTION_NO_TRANS,
566 N_("POSIX 1003.1-1988 (ustar) format"), GRID+3 },
567 {" pax", 0, NULL, OPTION_DOC|OPTION_NO_TRANS,
568 N_("POSIX 1003.1-2001 (pax) format"), GRID+3 },
569 {" posix", 0, NULL, OPTION_DOC|OPTION_NO_TRANS, N_("same as pax"), GRID+3 },
571 {"old-archive", OLD_ARCHIVE_OPTION, 0, 0, /* FIXME */
572 N_("same as --format=v7"), GRID+8 },
573 {"portability", 0, 0, OPTION_ALIAS, NULL, GRID+8 },
574 {"posix", POSIX_OPTION, 0, 0,
575 N_("same as --format=posix"), GRID+8 },
576 {"pax-option", PAX_OPTION, N_("keyword[[:]=value][,keyword[[:]=value]]..."), 0,
577 N_("control pax keywords"), GRID+8 },
578 {"label", 'V', N_("TEXT"), 0,
579 N_("create archive with volume name TEXT; at list/extract time, use TEXT as a globbing pattern for volume name"), GRID+8 },
580 #undef GRID
582 #define GRID 90
583 {NULL, 0, NULL, 0,
584 N_("Compression options:"), GRID },
585 {"auto-compress", 'a', 0, 0,
586 N_("use archive suffix to determine the compression program"), GRID+1 },
587 {"bzip2", 'j', 0, 0,
588 N_("filter the archive through bzip2"), GRID+1 },
589 {"gzip", 'z', 0, 0,
590 N_("filter the archive through gzip"), GRID+1 },
591 {"gunzip", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
592 {"ungzip", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
593 {"compress", 'Z', 0, 0,
594 N_("filter the archive through compress"), GRID+1 },
595 {"uncompress", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
596 {"lzma", LZMA_OPTION, 0, 0,
597 N_("filter the archive through lzma"), GRID+1 },
598 {"use-compress-program", USE_COMPRESS_PROGRAM_OPTION, N_("PROG"), 0,
599 N_("filter through PROG (must accept -d)"), GRID+1 },
600 #undef GRID
602 #define GRID 100
603 {NULL, 0, NULL, 0,
604 N_("Local file selection:"), GRID },
606 {"add-file", ARGP_KEY_ARG, N_("FILE"), 0,
607 N_("add given FILE to the archive (useful if its name starts with a dash)"), GRID+1 },
608 {"directory", 'C', N_("DIR"), 0,
609 N_("change to directory DIR"), GRID+1 },
610 {"files-from", 'T', N_("FILE"), 0,
611 N_("get names to extract or create from FILE"), GRID+1 },
612 {"null", NULL_OPTION, 0, 0,
613 N_("-T reads null-terminated names, disable -C"), GRID+1 },
614 {"unquote", UNQUOTE_OPTION, 0, 0,
615 N_("unquote filenames read with -T (default)"), GRID+1 },
616 {"no-unquote", NO_UNQUOTE_OPTION, 0, 0,
617 N_("do not unquote filenames read with -T"), GRID+1 },
618 {"exclude", EXCLUDE_OPTION, N_("PATTERN"), 0,
619 N_("exclude files, given as a PATTERN"), GRID+1 },
620 {"exclude-from", 'X', N_("FILE"), 0,
621 N_("exclude patterns listed in FILE"), GRID+1 },
622 {"exclude-caches", EXCLUDE_CACHES_OPTION, 0, 0,
623 N_("exclude contents of directories containing CACHEDIR.TAG, "
624 "except for the tag file itself"), GRID+1 },
625 {"exclude-caches-under", EXCLUDE_CACHES_UNDER_OPTION, 0, 0,
626 N_("exclude everything under directories containing CACHEDIR.TAG"),
627 GRID+1 },
628 {"exclude-caches-all", EXCLUDE_CACHES_ALL_OPTION, 0, 0,
629 N_("exclude directories containing CACHEDIR.TAG"), GRID+1 },
630 {"exclude-tag", EXCLUDE_TAG_OPTION, N_("FILE"), 0,
631 N_("exclude contents of directories containing FILE, except"
632 " for FILE itself"), GRID+1 },
633 {"exclude-tag-under", EXCLUDE_TAG_UNDER_OPTION, N_("FILE"), 0,
634 N_("exclude everything under directories containing FILE"), GRID+1 },
635 {"exclude-tag-all", EXCLUDE_TAG_ALL_OPTION, N_("FILE"), 0,
636 N_("exclude directories containing FILE"), GRID+1 },
637 {"exclude-vcs", EXCLUDE_VCS_OPTION, NULL, 0,
638 N_("exclude version control system directories"), GRID+1 },
639 {"no-recursion", NO_RECURSION_OPTION, 0, 0,
640 N_("avoid descending automatically in directories"), GRID+1 },
641 {"one-file-system", ONE_FILE_SYSTEM_OPTION, 0, 0,
642 N_("stay in local file system when creating archive"), GRID+1 },
643 {"recursion", RECURSION_OPTION, 0, 0,
644 N_("recurse into directories (default)"), GRID+1 },
645 {"absolute-names", 'P', 0, 0,
646 N_("don't strip leading `/'s from file names"), GRID+1 },
647 {"dereference", 'h', 0, 0,
648 N_("follow symlinks; archive and dump the files they point to"), GRID+1 },
649 {"hard-dereference", HARD_DEREFERENCE_OPTION, 0, 0,
650 N_("follow hard links; archive and dump the files they refer to"), GRID+1 },
651 {"starting-file", 'K', N_("MEMBER-NAME"), 0,
652 N_("begin at member MEMBER-NAME in the archive"), GRID+1 },
653 {"newer", 'N', N_("DATE-OR-FILE"), 0,
654 N_("only store files newer than DATE-OR-FILE"), GRID+1 },
655 {"after-date", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
656 {"newer-mtime", NEWER_MTIME_OPTION, N_("DATE"), 0,
657 N_("compare date and time when data changed only"), GRID+1 },
658 {"backup", BACKUP_OPTION, N_("CONTROL"), OPTION_ARG_OPTIONAL,
659 N_("backup before removal, choose version CONTROL"), GRID+1 },
660 {"suffix", SUFFIX_OPTION, N_("STRING"), 0,
661 N_("backup before removal, override usual suffix ('~' unless overridden by environment variable SIMPLE_BACKUP_SUFFIX)"), GRID+1 },
662 #undef GRID
664 #define GRID 110
665 {NULL, 0, NULL, 0,
666 N_("File name transformations:"), GRID },
667 {"strip-components", STRIP_COMPONENTS_OPTION, N_("NUMBER"), 0,
668 N_("strip NUMBER leading components from file names on extraction"),
669 GRID+1 },
670 {"transform", TRANSFORM_OPTION, N_("EXPRESSION"), 0,
671 N_("use sed replace EXPRESSION to transform file names"), GRID+1 },
672 #undef GRID
674 #define GRID 120
675 {NULL, 0, NULL, 0,
676 N_("File name matching options (affect both exclude and include patterns):"),
677 GRID },
678 {"ignore-case", IGNORE_CASE_OPTION, 0, 0,
679 N_("ignore case"), GRID+1 },
680 {"anchored", ANCHORED_OPTION, 0, 0,
681 N_("patterns match file name start"), GRID+1 },
682 {"no-anchored", NO_ANCHORED_OPTION, 0, 0,
683 N_("patterns match after any `/' (default for exclusion)"), GRID+1 },
684 {"no-ignore-case", NO_IGNORE_CASE_OPTION, 0, 0,
685 N_("case sensitive matching (default)"), GRID+1 },
686 {"wildcards", WILDCARDS_OPTION, 0, 0,
687 N_("use wildcards (default for exclusion)"), GRID+1 },
688 {"no-wildcards", NO_WILDCARDS_OPTION, 0, 0,
689 N_("verbatim string matching"), GRID+1 },
690 {"no-wildcards-match-slash", NO_WILDCARDS_MATCH_SLASH_OPTION, 0, 0,
691 N_("wildcards do not match `/'"), GRID+1 },
692 {"wildcards-match-slash", WILDCARDS_MATCH_SLASH_OPTION, 0, 0,
693 N_("wildcards match `/' (default for exclusion)"), GRID+1 },
694 #undef GRID
696 #define GRID 130
697 {NULL, 0, NULL, 0,
698 N_("Informative output:"), GRID },
700 {"verbose", 'v', 0, 0,
701 N_("verbosely list files processed"), GRID+1 },
702 {"checkpoint", CHECKPOINT_OPTION, N_("NUMBER"), OPTION_ARG_OPTIONAL,
703 N_("display progress messages every NUMBERth record (default 10)"),
704 GRID+1 },
705 {"checkpoint-action", CHECKPOINT_ACTION_OPTION, N_("ACTION"), 0,
706 N_("execute ACTION on each checkpoint"),
707 GRID+1 },
708 {"check-links", 'l', 0, 0,
709 N_("print a message if not all links are dumped"), GRID+1 },
710 {"totals", TOTALS_OPTION, N_("SIGNAL"), OPTION_ARG_OPTIONAL,
711 N_("print total bytes after processing the archive; "
712 "with an argument - print total bytes when this SIGNAL is delivered; "
713 "Allowed signals are: SIGHUP, SIGQUIT, SIGINT, SIGUSR1 and SIGUSR2; "
714 "the names without SIG prefix are also accepted"), GRID+1 },
715 {"utc", UTC_OPTION, 0, 0,
716 N_("print file modification dates in UTC"), GRID+1 },
717 {"index-file", INDEX_FILE_OPTION, N_("FILE"), 0,
718 N_("send verbose output to FILE"), GRID+1 },
719 {"block-number", 'R', 0, 0,
720 N_("show block number within archive with each message"), GRID+1 },
721 {"interactive", 'w', 0, 0,
722 N_("ask for confirmation for every action"), GRID+1 },
723 {"confirmation", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
724 {"show-defaults", SHOW_DEFAULTS_OPTION, 0, 0,
725 N_("show tar defaults"), GRID+1 },
726 {"show-omitted-dirs", SHOW_OMITTED_DIRS_OPTION, 0, 0,
727 N_("when listing or extracting, list each directory that does not match search criteria"), GRID+1 },
728 {"show-transformed-names", SHOW_TRANSFORMED_NAMES_OPTION, 0, 0,
729 N_("show file or archive names after transformation"),
730 GRID+1 },
731 {"show-stored-names", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
732 {"quoting-style", QUOTING_STYLE_OPTION, N_("STYLE"), 0,
733 N_("set name quoting style; see below for valid STYLE values"), GRID+1 },
734 {"quote-chars", QUOTE_CHARS_OPTION, N_("STRING"), 0,
735 N_("additionally quote characters from STRING"), GRID+1 },
736 {"no-quote-chars", NO_QUOTE_CHARS_OPTION, N_("STRING"), 0,
737 N_("disable quoting for characters from STRING"), GRID+1 },
738 #undef GRID
740 #define GRID 140
741 {NULL, 0, NULL, 0,
742 N_("Compatibility options:"), GRID },
744 {NULL, 'o', 0, 0,
745 N_("when creating, same as --old-archive; when extracting, same as --no-same-owner"), GRID+1 },
746 #undef GRID
748 #define GRID 150
749 {NULL, 0, NULL, 0,
750 N_("Other options:"), GRID },
752 {"restrict", RESTRICT_OPTION, 0, 0,
753 N_("disable use of some potentially harmful options"), -1 },
755 {"help", '?', 0, 0, N_("give this help list"), -1},
756 {"usage", USAGE_OPTION, 0, 0, N_("give a short usage message"), -1},
757 {"version", VERSION_OPTION, 0, 0, N_("print program version"), -1},
758 /* FIXME -V (--label) conflicts with the default short option for
759 --version */
760 {"HANG", HANG_OPTION, "SECS", OPTION_ARG_OPTIONAL | OPTION_HIDDEN,
761 N_("hang for SECS seconds (default 3600)"), 0},
762 #undef GRID
764 {0, 0, 0, 0, 0, 0}
767 static char const *const atime_preserve_args[] =
769 "replace", "system", NULL
772 static enum atime_preserve const atime_preserve_types[] =
774 replace_atime_preserve, system_atime_preserve
777 /* Make sure atime_preserve_types has as much entries as atime_preserve_args
778 (minus 1 for NULL guard) */
779 ARGMATCH_VERIFY (atime_preserve_args, atime_preserve_types);
781 /* Wildcard matching settings */
782 enum wildcards
784 default_wildcards, /* For exclusion == enable_wildcards,
785 for inclusion == disable_wildcards */
786 disable_wildcards,
787 enable_wildcards
790 struct tar_args /* Variables used during option parsing */
792 struct textual_date *textual_date; /* Keeps the arguments to --newer-mtime
793 and/or --date option if they are
794 textual dates */
795 enum wildcards wildcards; /* Wildcard settings (--wildcards/
796 --no-wildcards) */
797 int matching_flags; /* exclude_fnmatch options */
798 int include_anchored; /* Pattern anchoring options used for
799 file inclusion */
800 bool o_option; /* True if -o option was given */
801 bool pax_option; /* True if --pax-option was given */
802 char const *backup_suffix_string; /* --suffix option argument */
803 char const *version_control_string; /* --backup option argument */
804 bool input_files; /* True if some input files where given */
805 int compress_autodetect; /* True if compression autodetection should
806 be attempted when creating archives */
810 #define MAKE_EXCL_OPTIONS(args) \
811 ((((args)->wildcards != disable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
812 | (args)->matching_flags \
813 | recursion_option)
815 #define MAKE_INCL_OPTIONS(args) \
816 ((((args)->wildcards == enable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
817 | (args)->include_anchored \
818 | (args)->matching_flags \
819 | recursion_option)
821 void
822 exclude_vcs_files ()
824 int i;
825 static char *vcs_file[] = {
826 /* CVS: */
827 "CVS",
828 ".cvsignore",
829 /* RCS: */
830 "RCS",
831 /* SCCS: */
832 "SCCS",
833 /* SVN: */
834 ".svn",
835 /* git: */
836 ".git",
837 ".gitignore",
838 /* Arch: */
839 ".arch-ids",
840 "{arch}",
841 "=RELEASE-ID",
842 "=meta-update",
843 "=update",
844 NULL
847 for (i = 0; vcs_file[i]; i++)
848 add_exclude (excluded, vcs_file[i], 0);
852 #ifdef REMOTE_SHELL
853 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
855 printer (stream, \
856 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
857 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
858 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
859 quoting_style_args[DEFAULT_QUOTING_STYLE], \
860 DEFAULT_RMT_COMMAND); \
861 printer (stream, " --rsh-command=%s", REMOTE_SHELL); \
862 printer (stream, "\n"); \
864 #else
865 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
867 printer (stream, \
868 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
869 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
870 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
871 quoting_style_args[DEFAULT_QUOTING_STYLE], \
872 DEFAULT_RMT_COMMAND); \
873 printer (stream, "\n"); \
875 #endif
877 static void
878 show_default_settings (FILE *fp)
879 DECL_SHOW_DEFAULT_SETTINGS(fp, fprintf)
881 static void
882 show_default_settings_fs (argp_fmtstream_t fs)
883 DECL_SHOW_DEFAULT_SETTINGS(fs, argp_fmtstream_printf)
885 static void
886 set_subcommand_option (enum subcommand subcommand)
888 if (subcommand_option != UNKNOWN_SUBCOMMAND
889 && subcommand_option != subcommand)
890 USAGE_ERROR ((0, 0,
891 _("You may not specify more than one `-Acdtrux' option")));
893 subcommand_option = subcommand;
896 static void
897 set_use_compress_program_option (const char *string)
899 if (use_compress_program_option
900 && strcmp (use_compress_program_option, string) != 0)
901 USAGE_ERROR ((0, 0, _("Conflicting compression options")));
903 use_compress_program_option = string;
906 static RETSIGTYPE
907 sigstat (int signo)
909 compute_duration ();
910 print_total_stats ();
911 #ifndef HAVE_SIGACTION
912 signal (signo, sigstat);
913 #endif
916 static void
917 stat_on_signal (int signo)
919 #ifdef HAVE_SIGACTION
920 struct sigaction act;
921 act.sa_handler = sigstat;
922 sigemptyset (&act.sa_mask);
923 act.sa_flags = 0;
924 sigaction (signo, &act, NULL);
925 #else
926 signal (signo, sigstat);
927 #endif
930 void
931 set_stat_signal (const char *name)
933 static struct sigtab
935 char *name;
936 int signo;
937 } sigtab[] = {
938 { "SIGUSR1", SIGUSR1 },
939 { "USR1", SIGUSR1 },
940 { "SIGUSR2", SIGUSR2 },
941 { "USR2", SIGUSR2 },
942 { "SIGHUP", SIGHUP },
943 { "HUP", SIGHUP },
944 { "SIGINT", SIGINT },
945 { "INT", SIGINT },
946 { "SIGQUIT", SIGQUIT },
947 { "QUIT", SIGQUIT }
949 struct sigtab *p;
951 for (p = sigtab; p < sigtab + sizeof (sigtab) / sizeof (sigtab[0]); p++)
952 if (strcmp (p->name, name) == 0)
954 stat_on_signal (p->signo);
955 return;
957 FATAL_ERROR ((0, 0, _("Unknown signal name: %s"), name));
961 struct textual_date
963 struct textual_date *next;
964 struct timespec *ts;
965 const char *option;
966 const char *date;
969 static void
970 get_date_or_file (struct tar_args *args, const char *option,
971 const char *str, struct timespec *ts)
973 if (FILE_SYSTEM_PREFIX_LEN (str) != 0
974 || ISSLASH (*str)
975 || *str == '.')
977 struct stat st;
978 if (deref_stat (dereference_option, str, &st) != 0)
980 stat_error (str);
981 USAGE_ERROR ((0, 0, _("Date sample file not found")));
983 *ts = get_stat_mtime (&st);
985 else
987 if (! get_date (ts, str, NULL))
989 WARN ((0, 0, _("Substituting %s for unknown date format %s"),
990 tartime (*ts, false), quote (str)));
991 ts->tv_nsec = 0;
993 else
995 struct textual_date *p = xmalloc (sizeof (*p));
996 p->ts = ts;
997 p->option = option;
998 p->date = str;
999 p->next = args->textual_date;
1000 args->textual_date = p;
1005 static void
1006 report_textual_dates (struct tar_args *args)
1008 struct textual_date *p;
1009 for (p = args->textual_date; p; )
1011 struct textual_date *next = p->next;
1012 char const *treated_as = tartime (*p->ts, true);
1013 if (strcmp (p->date, treated_as) != 0)
1014 WARN ((0, 0, _("Option %s: Treating date `%s' as %s"),
1015 p->option, p->date, treated_as));
1016 free (p);
1017 p = next;
1022 static volatile int _argp_hang;
1024 enum read_file_list_state /* Result of reading file name from the list file */
1026 file_list_success, /* OK, name read successfully */
1027 file_list_end, /* End of list file */
1028 file_list_zero, /* Zero separator encountered where it should not */
1029 file_list_skip /* Empty (zero-length) entry encountered, skip it */
1032 /* Read from FP a sequence of characters up to FILENAME_TERMINATOR and put them
1033 into STK.
1035 static enum read_file_list_state
1036 read_name_from_file (FILE *fp, struct obstack *stk)
1038 int c;
1039 size_t counter = 0;
1041 for (c = getc (fp); c != EOF && c != filename_terminator; c = getc (fp))
1043 if (c == 0)
1045 /* We have read a zero separator. The file possibly is
1046 zero-separated */
1047 return file_list_zero;
1049 obstack_1grow (stk, c);
1050 counter++;
1053 if (counter == 0 && c != EOF)
1054 return file_list_skip;
1056 obstack_1grow (stk, 0);
1058 return (counter == 0 && c == EOF) ? file_list_end : file_list_success;
1062 static bool files_from_option; /* When set, tar will not refuse to create
1063 empty archives */
1064 static struct obstack argv_stk; /* Storage for additional command line options
1065 read using -T option */
1067 /* Prevent recursive inclusion of the same file */
1068 struct file_id_list
1070 struct file_id_list *next;
1071 ino_t ino;
1072 dev_t dev;
1075 static struct file_id_list *file_id_list;
1077 static void
1078 add_file_id (const char *filename)
1080 struct file_id_list *p;
1081 struct stat st;
1083 if (stat (filename, &st))
1084 stat_fatal (filename);
1085 for (p = file_id_list; p; p = p->next)
1086 if (p->ino == st.st_ino && p->dev == st.st_dev)
1088 FATAL_ERROR ((0, 0, _("%s: file list already read"),
1089 quotearg_colon (filename)));
1091 p = xmalloc (sizeof *p);
1092 p->next = file_id_list;
1093 p->ino = st.st_ino;
1094 p->dev = st.st_dev;
1095 file_id_list = p;
1098 /* Default density numbers for [0-9][lmh] device specifications */
1100 #ifndef LOW_DENSITY_NUM
1101 # define LOW_DENSITY_NUM 0
1102 #endif
1104 #ifndef MID_DENSITY_NUM
1105 # define MID_DENSITY_NUM 8
1106 #endif
1108 #ifndef HIGH_DENSITY_NUM
1109 # define HIGH_DENSITY_NUM 16
1110 #endif
1112 static void
1113 update_argv (const char *filename, struct argp_state *state)
1115 FILE *fp;
1116 size_t count = 0, i;
1117 char *start, *p;
1118 char **new_argv;
1119 size_t new_argc;
1120 bool is_stdin = false;
1121 enum read_file_list_state read_state;
1123 if (!strcmp (filename, "-"))
1125 is_stdin = true;
1126 request_stdin ("-T");
1127 fp = stdin;
1129 else
1131 add_file_id (filename);
1132 if ((fp = fopen (filename, "r")) == NULL)
1133 open_fatal (filename);
1136 while ((read_state = read_name_from_file (fp, &argv_stk)) != file_list_end)
1138 switch (read_state)
1140 case file_list_success:
1141 count++;
1142 break;
1144 case file_list_end: /* won't happen, just to pacify gcc */
1145 break;
1147 case file_list_zero:
1149 size_t size;
1151 WARN ((0, 0, N_("%s: file name read contains nul character"),
1152 quotearg_colon (filename)));
1154 /* Prepare new stack contents */
1155 size = obstack_object_size (&argv_stk);
1156 p = obstack_finish (&argv_stk);
1157 for (; size > 0; size--, p++)
1158 if (*p)
1159 obstack_1grow (&argv_stk, *p);
1160 else
1161 obstack_1grow (&argv_stk, '\n');
1162 obstack_1grow (&argv_stk, 0);
1163 count = 1;
1164 /* Read rest of files using new filename terminator */
1165 filename_terminator = 0;
1166 break;
1169 case file_list_skip:
1170 break;
1174 if (!is_stdin)
1175 fclose (fp);
1177 if (count == 0)
1178 return;
1180 start = obstack_finish (&argv_stk);
1182 if (filename_terminator == 0)
1183 for (p = start; *p; p += strlen (p) + 1)
1184 if (p[0] == '-')
1185 count++;
1187 new_argc = state->argc + count;
1188 new_argv = xmalloc (sizeof (state->argv[0]) * (new_argc + 1));
1189 memcpy (new_argv, state->argv, sizeof (state->argv[0]) * (state->argc + 1));
1190 state->argv = new_argv;
1191 memmove (&state->argv[state->next + count], &state->argv[state->next],
1192 (state->argc - state->next + 1) * sizeof (state->argv[0]));
1194 state->argc = new_argc;
1196 for (i = state->next, p = start; *p; p += strlen (p) + 1, i++)
1198 if (filename_terminator == 0 && p[0] == '-')
1199 state->argv[i++] = "--add-file";
1200 state->argv[i] = p;
1205 static void
1206 tar_help (struct argp_state *state)
1208 argp_fmtstream_t fs;
1209 state->flags |= ARGP_NO_EXIT;
1210 argp_state_help (state, state->out_stream,
1211 ARGP_HELP_STD_HELP & ~ARGP_HELP_BUG_ADDR);
1212 /* FIXME: use struct uparams.rmargin (from argp-help.c) instead of 79 */
1213 fs = argp_make_fmtstream (state->out_stream, 0, 79, 0);
1215 argp_fmtstream_printf (fs, "\n%s\n\n",
1216 _("Valid arguments for --quoting-style options are:"));
1217 tar_list_quoting_styles (fs, " ");
1219 argp_fmtstream_puts (fs, _("\n*This* tar defaults to:\n"));
1220 show_default_settings_fs (fs);
1221 argp_fmtstream_putc (fs, '\n');
1222 argp_fmtstream_printf (fs, _("Report bugs to %s.\n"),
1223 argp_program_bug_address);
1224 argp_fmtstream_free (fs);
1227 static error_t
1228 parse_opt (int key, char *arg, struct argp_state *state)
1230 struct tar_args *args = state->input;
1232 switch (key)
1234 case ARGP_KEY_ARG:
1235 /* File name or non-parsed option, because of ARGP_IN_ORDER */
1236 name_add_name (arg, MAKE_INCL_OPTIONS (args));
1237 args->input_files = true;
1238 break;
1240 case 'A':
1241 set_subcommand_option (CAT_SUBCOMMAND);
1242 break;
1244 case 'a':
1245 args->compress_autodetect = true;
1246 break;
1248 case 'b':
1250 uintmax_t u;
1251 if (! (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK
1252 && u == (blocking_factor = u)
1253 && 0 < blocking_factor
1254 && u == (record_size = u * BLOCKSIZE) / BLOCKSIZE))
1255 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1256 _("Invalid blocking factor")));
1258 break;
1260 case 'B':
1261 /* Try to reblock input records. For reading 4.2BSD pipes. */
1263 /* It would surely make sense to exchange -B and -R, but it seems
1264 that -B has been used for a long while in Sun tar and most
1265 BSD-derived systems. This is a consequence of the block/record
1266 terminology confusion. */
1268 read_full_records_option = true;
1269 break;
1271 case 'c':
1272 set_subcommand_option (CREATE_SUBCOMMAND);
1273 break;
1275 case 'C':
1276 name_add_dir (arg);
1277 break;
1279 case 'd':
1280 set_subcommand_option (DIFF_SUBCOMMAND);
1281 break;
1283 case 'f':
1284 if (archive_names == allocated_archive_names)
1285 archive_name_array = x2nrealloc (archive_name_array,
1286 &allocated_archive_names,
1287 sizeof (archive_name_array[0]));
1289 archive_name_array[archive_names++] = arg;
1290 break;
1292 case 'F':
1293 /* Since -F is only useful with -M, make it implied. Run this
1294 script at the end of each tape. */
1296 info_script_option = arg;
1297 multi_volume_option = true;
1298 break;
1300 case 'g':
1301 listed_incremental_option = arg;
1302 after_date_option = true;
1303 /* Fall through. */
1305 case 'G':
1306 /* We are making an incremental dump (FIXME: are we?); save
1307 directories at the beginning of the archive, and include in each
1308 directory its contents. */
1310 incremental_option = true;
1311 break;
1313 case 'h':
1314 /* Follow symbolic links. */
1315 dereference_option = true;
1316 break;
1318 case HARD_DEREFERENCE_OPTION:
1319 hard_dereference_option = true;
1320 break;
1322 case 'i':
1323 /* Ignore zero blocks (eofs). This can't be the default,
1324 because Unix tar writes two blocks of zeros, then pads out
1325 the record with garbage. */
1327 ignore_zeros_option = true;
1328 break;
1330 case 'I':
1331 USAGE_ERROR ((0, 0,
1332 _("Warning: the -I option is not supported;"
1333 " perhaps you meant -j or -T?")));
1334 break;
1336 case 'j':
1337 set_use_compress_program_option ("bzip2");
1338 break;
1340 case 'k':
1341 /* Don't replace existing files. */
1342 old_files_option = KEEP_OLD_FILES;
1343 break;
1345 case 'K':
1346 starting_file_option = true;
1347 addname (arg, 0);
1348 break;
1350 case ONE_FILE_SYSTEM_OPTION:
1351 /* When dumping directories, don't dump files/subdirectories
1352 that are on other filesystems. */
1353 one_file_system_option = true;
1354 break;
1356 case 'l':
1357 check_links_option = 1;
1358 break;
1360 case 'L':
1362 uintmax_t u;
1363 if (xstrtoumax (arg, 0, 10, &u, "") != LONGINT_OK)
1364 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1365 _("Invalid tape length")));
1366 tape_length_option = 1024 * (tarlong) u;
1367 multi_volume_option = true;
1369 break;
1371 case LZMA_OPTION:
1372 set_use_compress_program_option ("lzma");
1373 break;
1375 case 'm':
1376 touch_option = true;
1377 break;
1379 case 'M':
1380 /* Make multivolume archive: when we can't write any more into
1381 the archive, re-open it, and continue writing. */
1383 multi_volume_option = true;
1384 break;
1386 case MTIME_OPTION:
1387 get_date_or_file (args, "--mtime", arg, &mtime_option);
1388 set_mtime_option = true;
1389 break;
1391 case 'n':
1392 seekable_archive = true;
1393 break;
1395 case 'N':
1396 after_date_option = true;
1397 /* Fall through. */
1399 case NEWER_MTIME_OPTION:
1400 if (NEWER_OPTION_INITIALIZED (newer_mtime_option))
1401 USAGE_ERROR ((0, 0, _("More than one threshold date")));
1402 get_date_or_file (args,
1403 key == NEWER_MTIME_OPTION ? "--newer-mtime"
1404 : "--after-date", arg, &newer_mtime_option);
1405 break;
1407 case 'o':
1408 args->o_option = true;
1409 break;
1411 case 'O':
1412 to_stdout_option = true;
1413 break;
1415 case 'p':
1416 same_permissions_option = true;
1417 break;
1419 case 'P':
1420 absolute_names_option = true;
1421 break;
1423 case 'r':
1424 set_subcommand_option (APPEND_SUBCOMMAND);
1425 break;
1427 case 'R':
1428 /* Print block numbers for debugging bad tar archives. */
1430 /* It would surely make sense to exchange -B and -R, but it seems
1431 that -B has been used for a long while in Sun tar and most
1432 BSD-derived systems. This is a consequence of the block/record
1433 terminology confusion. */
1435 block_number_option = true;
1436 break;
1438 case 's':
1439 /* Names to extract are sorted. */
1441 same_order_option = true;
1442 break;
1444 case 'S':
1445 sparse_option = true;
1446 break;
1448 case SPARSE_VERSION_OPTION:
1449 sparse_option = true;
1451 char *p;
1452 tar_sparse_major = strtoul (arg, &p, 10);
1453 if (*p)
1455 if (*p != '.')
1456 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1457 tar_sparse_minor = strtoul (p + 1, &p, 10);
1458 if (*p)
1459 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1462 break;
1464 case 't':
1465 set_subcommand_option (LIST_SUBCOMMAND);
1466 verbose_option++;
1467 break;
1469 case TEST_LABEL_OPTION:
1470 set_subcommand_option (LIST_SUBCOMMAND);
1471 test_label_option = true;
1472 break;
1474 case 'T':
1475 update_argv (arg, state);
1476 /* Indicate we've been given -T option. This is for backward
1477 compatibility only, so that `tar cfT archive /dev/null will
1478 succeed */
1479 files_from_option = true;
1480 break;
1482 case 'u':
1483 set_subcommand_option (UPDATE_SUBCOMMAND);
1484 break;
1486 case 'U':
1487 old_files_option = UNLINK_FIRST_OLD_FILES;
1488 break;
1490 case UTC_OPTION:
1491 utc_option = true;
1492 break;
1494 case 'v':
1495 verbose_option++;
1496 break;
1498 case 'V':
1499 volume_label_option = arg;
1500 break;
1502 case 'w':
1503 interactive_option = true;
1504 break;
1506 case 'W':
1507 verify_option = true;
1508 break;
1510 case 'x':
1511 set_subcommand_option (EXTRACT_SUBCOMMAND);
1512 break;
1514 case 'X':
1515 if (add_exclude_file (add_exclude, excluded, arg,
1516 MAKE_EXCL_OPTIONS (args), '\n')
1517 != 0)
1519 int e = errno;
1520 FATAL_ERROR ((0, e, "%s", quotearg_colon (arg)));
1522 break;
1524 case 'z':
1525 set_use_compress_program_option ("gzip");
1526 break;
1528 case 'Z':
1529 set_use_compress_program_option ("compress");
1530 break;
1532 case ANCHORED_OPTION:
1533 args->matching_flags |= EXCLUDE_ANCHORED;
1534 break;
1536 case ATIME_PRESERVE_OPTION:
1537 atime_preserve_option =
1538 (arg
1539 ? XARGMATCH ("--atime-preserve", arg,
1540 atime_preserve_args, atime_preserve_types)
1541 : replace_atime_preserve);
1542 if (! O_NOATIME && atime_preserve_option == system_atime_preserve)
1543 FATAL_ERROR ((0, 0,
1544 _("--atime-preserve='system' is not supported"
1545 " on this platform")));
1546 break;
1548 case CHECKPOINT_OPTION:
1549 if (arg)
1551 char *p;
1553 if (*arg == '.')
1555 checkpoint_compile_action (".");
1556 arg++;
1558 checkpoint_option = strtoul (arg, &p, 0);
1559 if (*p)
1560 FATAL_ERROR ((0, 0,
1561 _("--checkpoint value is not an integer")));
1563 else
1564 checkpoint_option = DEFAULT_CHECKPOINT;
1565 break;
1567 case CHECKPOINT_ACTION_OPTION:
1568 checkpoint_compile_action (arg);
1569 break;
1571 case BACKUP_OPTION:
1572 backup_option = true;
1573 if (arg)
1574 args->version_control_string = arg;
1575 break;
1577 case DELAY_DIRECTORY_RESTORE_OPTION:
1578 delay_directory_restore_option = true;
1579 break;
1581 case NO_DELAY_DIRECTORY_RESTORE_OPTION:
1582 delay_directory_restore_option = false;
1583 break;
1585 case DELETE_OPTION:
1586 set_subcommand_option (DELETE_SUBCOMMAND);
1587 break;
1589 case EXCLUDE_OPTION:
1590 add_exclude (excluded, arg, MAKE_EXCL_OPTIONS (args));
1591 break;
1593 case EXCLUDE_CACHES_OPTION:
1594 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_contents,
1595 cachedir_file_p);
1596 break;
1598 case EXCLUDE_CACHES_UNDER_OPTION:
1599 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_under,
1600 cachedir_file_p);
1601 break;
1603 case EXCLUDE_CACHES_ALL_OPTION:
1604 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_all,
1605 cachedir_file_p);
1606 break;
1608 case EXCLUDE_TAG_OPTION:
1609 add_exclusion_tag (arg, exclusion_tag_contents, NULL);
1610 break;
1612 case EXCLUDE_TAG_UNDER_OPTION:
1613 add_exclusion_tag (arg, exclusion_tag_under, NULL);
1614 break;
1616 case EXCLUDE_TAG_ALL_OPTION:
1617 add_exclusion_tag (arg, exclusion_tag_all, NULL);
1618 break;
1620 case EXCLUDE_VCS_OPTION:
1621 exclude_vcs_files ();
1622 break;
1624 case FORCE_LOCAL_OPTION:
1625 force_local_option = true;
1626 break;
1628 case 'H':
1629 set_archive_format (arg);
1630 break;
1632 case INDEX_FILE_OPTION:
1633 index_file_name = arg;
1634 break;
1636 case IGNORE_CASE_OPTION:
1637 args->matching_flags |= FNM_CASEFOLD;
1638 break;
1640 case IGNORE_COMMAND_ERROR_OPTION:
1641 ignore_command_error_option = true;
1642 break;
1644 case IGNORE_FAILED_READ_OPTION:
1645 ignore_failed_read_option = true;
1646 break;
1648 case KEEP_NEWER_FILES_OPTION:
1649 old_files_option = KEEP_NEWER_FILES;
1650 break;
1652 case GROUP_OPTION:
1653 if (! (strlen (arg) < GNAME_FIELD_SIZE
1654 && gname_to_gid (arg, &group_option)))
1656 uintmax_t g;
1657 if (xstrtoumax (arg, 0, 10, &g, "") == LONGINT_OK
1658 && g == (gid_t) g)
1659 group_option = g;
1660 else
1661 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1662 _("%s: Invalid group")));
1664 break;
1666 case MODE_OPTION:
1667 mode_option = mode_compile (arg);
1668 if (!mode_option)
1669 FATAL_ERROR ((0, 0, _("Invalid mode given on option")));
1670 initial_umask = umask (0);
1671 umask (initial_umask);
1672 break;
1674 case NO_ANCHORED_OPTION:
1675 args->include_anchored = 0; /* Clear the default for comman line args */
1676 args->matching_flags &= ~ EXCLUDE_ANCHORED;
1677 break;
1679 case NO_IGNORE_CASE_OPTION:
1680 args->matching_flags &= ~ FNM_CASEFOLD;
1681 break;
1683 case NO_IGNORE_COMMAND_ERROR_OPTION:
1684 ignore_command_error_option = false;
1685 break;
1687 case NO_OVERWRITE_DIR_OPTION:
1688 old_files_option = NO_OVERWRITE_DIR_OLD_FILES;
1689 break;
1691 case NO_QUOTE_CHARS_OPTION:
1692 for (;*arg; arg++)
1693 set_char_quoting (NULL, *arg, 0);
1694 break;
1696 case NO_WILDCARDS_OPTION:
1697 args->wildcards = disable_wildcards;
1698 break;
1700 case NO_WILDCARDS_MATCH_SLASH_OPTION:
1701 args->matching_flags |= FNM_FILE_NAME;
1702 break;
1704 case NULL_OPTION:
1705 filename_terminator = '\0';
1706 break;
1708 case NUMERIC_OWNER_OPTION:
1709 numeric_owner_option = true;
1710 break;
1712 case OCCURRENCE_OPTION:
1713 if (!arg)
1714 occurrence_option = 1;
1715 else
1717 uintmax_t u;
1718 if (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK)
1719 occurrence_option = u;
1720 else
1721 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1722 _("Invalid number")));
1724 break;
1726 case OVERWRITE_DIR_OPTION:
1727 old_files_option = DEFAULT_OLD_FILES;
1728 break;
1730 case OVERWRITE_OPTION:
1731 old_files_option = OVERWRITE_OLD_FILES;
1732 break;
1734 case OWNER_OPTION:
1735 if (! (strlen (arg) < UNAME_FIELD_SIZE
1736 && uname_to_uid (arg, &owner_option)))
1738 uintmax_t u;
1739 if (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK
1740 && u == (uid_t) u)
1741 owner_option = u;
1742 else
1743 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1744 _("Invalid owner")));
1746 break;
1748 case QUOTE_CHARS_OPTION:
1749 for (;*arg; arg++)
1750 set_char_quoting (NULL, *arg, 1);
1751 break;
1753 case QUOTING_STYLE_OPTION:
1754 tar_set_quoting_style (arg);
1755 break;
1757 case PAX_OPTION:
1758 args->pax_option = true;
1759 xheader_set_option (arg);
1760 break;
1762 case POSIX_OPTION:
1763 set_archive_format ("posix");
1764 break;
1766 case PRESERVE_OPTION:
1767 /* FIXME: What it is good for? */
1768 same_permissions_option = true;
1769 same_order_option = true;
1770 break;
1772 case RECORD_SIZE_OPTION:
1774 uintmax_t u;
1775 if (! (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK
1776 && u == (size_t) u))
1777 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1778 _("Invalid record size")));
1779 record_size = u;
1780 if (record_size % BLOCKSIZE != 0)
1781 USAGE_ERROR ((0, 0, _("Record size must be a multiple of %d."),
1782 BLOCKSIZE));
1783 blocking_factor = record_size / BLOCKSIZE;
1785 break;
1787 case RECURSIVE_UNLINK_OPTION:
1788 recursive_unlink_option = true;
1789 break;
1791 case REMOVE_FILES_OPTION:
1792 remove_files_option = true;
1793 break;
1795 case RESTRICT_OPTION:
1796 restrict_option = true;
1797 break;
1799 case RMT_COMMAND_OPTION:
1800 rmt_command = arg;
1801 break;
1803 case RSH_COMMAND_OPTION:
1804 rsh_command_option = arg;
1805 break;
1807 case SHOW_DEFAULTS_OPTION:
1808 show_default_settings (stdout);
1809 close_stdout ();
1810 exit (0);
1812 case STRIP_COMPONENTS_OPTION:
1814 uintmax_t u;
1815 if (! (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK
1816 && u == (size_t) u))
1817 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1818 _("Invalid number of elements")));
1819 strip_name_components = u;
1821 break;
1823 case SHOW_OMITTED_DIRS_OPTION:
1824 show_omitted_dirs_option = true;
1825 break;
1827 case SHOW_TRANSFORMED_NAMES_OPTION:
1828 show_transformed_names_option = true;
1829 break;
1831 case SUFFIX_OPTION:
1832 backup_option = true;
1833 args->backup_suffix_string = arg;
1834 break;
1836 case TO_COMMAND_OPTION:
1837 if (to_command_option)
1838 USAGE_ERROR ((0, 0, _("Only one --to-command option allowed")));
1839 to_command_option = arg;
1840 break;
1842 case TOTALS_OPTION:
1843 if (arg)
1844 set_stat_signal (arg);
1845 else
1846 totals_option = true;
1847 break;
1849 case TRANSFORM_OPTION:
1850 set_transform_expr (arg);
1851 break;
1853 case USE_COMPRESS_PROGRAM_OPTION:
1854 set_use_compress_program_option (arg);
1855 break;
1857 case VOLNO_FILE_OPTION:
1858 volno_file_option = arg;
1859 break;
1861 case WILDCARDS_OPTION:
1862 args->wildcards = enable_wildcards;
1863 break;
1865 case WILDCARDS_MATCH_SLASH_OPTION:
1866 args->matching_flags &= ~ FNM_FILE_NAME;
1867 break;
1869 case NO_RECURSION_OPTION:
1870 recursion_option = 0;
1871 break;
1873 case NO_SAME_OWNER_OPTION:
1874 same_owner_option = -1;
1875 break;
1877 case NO_SAME_PERMISSIONS_OPTION:
1878 same_permissions_option = -1;
1879 break;
1881 case RECURSION_OPTION:
1882 recursion_option = FNM_LEADING_DIR;
1883 break;
1885 case SAME_OWNER_OPTION:
1886 same_owner_option = 1;
1887 break;
1889 case UNQUOTE_OPTION:
1890 unquote_option = true;
1891 break;
1893 case NO_UNQUOTE_OPTION:
1894 unquote_option = false;
1895 break;
1897 case '0':
1898 case '1':
1899 case '2':
1900 case '3':
1901 case '4':
1902 case '5':
1903 case '6':
1904 case '7':
1906 #ifdef DEVICE_PREFIX
1908 int device = key - '0';
1909 int density;
1910 static char buf[sizeof DEVICE_PREFIX + 10];
1911 char *cursor;
1913 if (arg[1])
1914 argp_error (state, _("Malformed density argument: %s"), quote (arg));
1916 strcpy (buf, DEVICE_PREFIX);
1917 cursor = buf + strlen (buf);
1919 #ifdef DENSITY_LETTER
1921 sprintf (cursor, "%d%c", device, arg[0]);
1923 #else /* not DENSITY_LETTER */
1925 switch (arg[0])
1927 case 'l':
1928 device += LOW_DENSITY_NUM;
1929 break;
1931 case 'm':
1932 device += MID_DENSITY_NUM;
1933 break;
1935 case 'h':
1936 device += HIGH_DENSITY_NUM;
1937 break;
1939 default:
1940 argp_error (state, _("Unknown density: `%c'"), arg[0]);
1942 sprintf (cursor, "%d", device);
1944 #endif /* not DENSITY_LETTER */
1946 if (archive_names == allocated_archive_names)
1947 archive_name_array = x2nrealloc (archive_name_array,
1948 &allocated_archive_names,
1949 sizeof (archive_name_array[0]));
1950 archive_name_array[archive_names++] = xstrdup (buf);
1952 break;
1954 #else /* not DEVICE_PREFIX */
1956 argp_error (state,
1957 _("Options `-[0-7][lmh]' not supported by *this* tar"));
1959 #endif /* not DEVICE_PREFIX */
1961 case '?':
1962 tar_help (state);
1963 close_stdout ();
1964 exit (0);
1966 case USAGE_OPTION:
1967 argp_state_help (state, state->out_stream, ARGP_HELP_USAGE);
1968 close_stdout ();
1969 exit (0);
1971 case VERSION_OPTION:
1972 version_etc (state->out_stream, "tar", PACKAGE_NAME, VERSION,
1973 "John Gilmore", "Jay Fenlason", (char *) NULL);
1974 close_stdout ();
1975 exit (0);
1977 case HANG_OPTION:
1978 _argp_hang = atoi (arg ? arg : "3600");
1979 while (_argp_hang-- > 0)
1980 sleep (1);
1981 break;
1983 default:
1984 return ARGP_ERR_UNKNOWN;
1986 return 0;
1989 static struct argp argp = {
1990 options,
1991 parse_opt,
1992 N_("[FILE]..."),
1993 doc,
1994 NULL,
1995 NULL,
1996 NULL
1999 void
2000 usage (int status)
2002 argp_help (&argp, stderr, ARGP_HELP_SEE, (char*) program_name);
2003 close_stdout ();
2004 exit (status);
2007 /* Parse the options for tar. */
2009 static struct argp_option *
2010 find_argp_option (struct argp_option *o, int letter)
2012 for (;
2013 !(o->name == NULL
2014 && o->key == 0
2015 && o->arg == 0
2016 && o->flags == 0
2017 && o->doc == NULL); o++)
2018 if (o->key == letter)
2019 return o;
2020 return NULL;
2023 static void
2024 decode_options (int argc, char **argv)
2026 int idx;
2027 struct tar_args args;
2029 /* Set some default option values. */
2030 args.textual_date = NULL;
2031 args.wildcards = default_wildcards;
2032 args.matching_flags = 0;
2033 args.include_anchored = EXCLUDE_ANCHORED;
2034 args.o_option = false;
2035 args.pax_option = false;
2036 args.backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
2037 args.version_control_string = 0;
2038 args.input_files = false;
2039 args.compress_autodetect = false;
2041 subcommand_option = UNKNOWN_SUBCOMMAND;
2042 archive_format = DEFAULT_FORMAT;
2043 blocking_factor = DEFAULT_BLOCKING;
2044 record_size = DEFAULT_BLOCKING * BLOCKSIZE;
2045 excluded = new_exclude ();
2046 newer_mtime_option.tv_sec = TYPE_MINIMUM (time_t);
2047 newer_mtime_option.tv_nsec = -1;
2048 recursion_option = FNM_LEADING_DIR;
2049 unquote_option = true;
2050 tar_sparse_major = 1;
2051 tar_sparse_minor = 0;
2053 owner_option = -1;
2054 group_option = -1;
2056 /* Convert old-style tar call by exploding option element and rearranging
2057 options accordingly. */
2059 if (argc > 1 && argv[1][0] != '-')
2061 int new_argc; /* argc value for rearranged arguments */
2062 char **new_argv; /* argv value for rearranged arguments */
2063 char *const *in; /* cursor into original argv */
2064 char **out; /* cursor into rearranged argv */
2065 const char *letter; /* cursor into old option letters */
2066 char buffer[3]; /* constructed option buffer */
2068 /* Initialize a constructed option. */
2070 buffer[0] = '-';
2071 buffer[2] = '\0';
2073 /* Allocate a new argument array, and copy program name in it. */
2075 new_argc = argc - 1 + strlen (argv[1]);
2076 new_argv = xmalloc ((new_argc + 1) * sizeof (char *));
2077 in = argv;
2078 out = new_argv;
2079 *out++ = *in++;
2081 /* Copy each old letter option as a separate option, and have the
2082 corresponding argument moved next to it. */
2084 for (letter = *in++; *letter; letter++)
2086 struct argp_option *opt;
2088 buffer[1] = *letter;
2089 *out++ = xstrdup (buffer);
2090 opt = find_argp_option (options, *letter);
2091 if (opt && opt->arg)
2093 if (in < argv + argc)
2094 *out++ = *in++;
2095 else
2096 USAGE_ERROR ((0, 0, _("Old option `%c' requires an argument."),
2097 *letter));
2101 /* Copy all remaining options. */
2103 while (in < argv + argc)
2104 *out++ = *in++;
2105 *out = 0;
2107 /* Replace the old option list by the new one. */
2109 argc = new_argc;
2110 argv = new_argv;
2113 /* Parse all options and non-options as they appear. */
2115 prepend_default_options (getenv ("TAR_OPTIONS"), &argc, &argv);
2117 if (argp_parse (&argp, argc, argv, ARGP_IN_ORDER|ARGP_NO_HELP,
2118 &idx, &args))
2119 exit (TAREXIT_FAILURE);
2122 /* Special handling for 'o' option:
2124 GNU tar used to say "output old format".
2125 UNIX98 tar says don't chown files after extracting (we use
2126 "--no-same-owner" for this).
2128 The old GNU tar semantics is retained when used with --create
2129 option, otherwise UNIX98 semantics is assumed */
2131 if (args.o_option)
2133 if (subcommand_option == CREATE_SUBCOMMAND)
2135 /* GNU Tar <= 1.13 compatibility */
2136 set_archive_format ("v7");
2138 else
2140 /* UNIX98 compatibility */
2141 same_owner_option = -1;
2145 /* Handle operands after any "--" argument. */
2146 for (; idx < argc; idx++)
2148 name_add_name (argv[idx], MAKE_INCL_OPTIONS (&args));
2149 args.input_files = true;
2152 /* Warn about implicit use of the wildcards in command line arguments.
2153 See TODO */
2154 warn_regex_usage = args.wildcards == default_wildcards;
2156 /* Derive option values and check option consistency. */
2158 if (archive_format == DEFAULT_FORMAT)
2160 if (args.pax_option)
2161 archive_format = POSIX_FORMAT;
2162 else
2163 archive_format = DEFAULT_ARCHIVE_FORMAT;
2166 if ((volume_label_option && subcommand_option == CREATE_SUBCOMMAND)
2167 || incremental_option
2168 || multi_volume_option
2169 || sparse_option)
2170 assert_format (FORMAT_MASK (OLDGNU_FORMAT)
2171 | FORMAT_MASK (GNU_FORMAT)
2172 | FORMAT_MASK (POSIX_FORMAT));
2174 if (occurrence_option)
2176 if (!args.input_files)
2177 USAGE_ERROR ((0, 0,
2178 _("--occurrence is meaningless without a file list")));
2179 if (subcommand_option != DELETE_SUBCOMMAND
2180 && subcommand_option != DIFF_SUBCOMMAND
2181 && subcommand_option != EXTRACT_SUBCOMMAND
2182 && subcommand_option != LIST_SUBCOMMAND)
2183 USAGE_ERROR ((0, 0,
2184 _("--occurrence cannot be used in the requested operation mode")));
2187 if (seekable_archive && subcommand_option == DELETE_SUBCOMMAND)
2189 /* The current code in delete.c is based on the assumption that
2190 skip_member() reads all data from the archive. So, we should
2191 make sure it won't use seeks. On the other hand, the same code
2192 depends on the ability to backspace a record in the archive,
2193 so setting seekable_archive to false is technically incorrect.
2194 However, it is tested only in skip_member(), so it's not a
2195 problem. */
2196 seekable_archive = false;
2199 if (archive_names == 0)
2201 /* If no archive file name given, try TAPE from the environment, or
2202 else, DEFAULT_ARCHIVE from the configuration process. */
2204 archive_names = 1;
2205 archive_name_array[0] = getenv ("TAPE");
2206 if (! archive_name_array[0])
2207 archive_name_array[0] = DEFAULT_ARCHIVE;
2210 /* Allow multiple archives only with `-M'. */
2212 if (archive_names > 1 && !multi_volume_option)
2213 USAGE_ERROR ((0, 0,
2214 _("Multiple archive files require `-M' option")));
2216 if (listed_incremental_option
2217 && NEWER_OPTION_INITIALIZED (newer_mtime_option))
2218 USAGE_ERROR ((0, 0,
2219 _("Cannot combine --listed-incremental with --newer")));
2221 if (volume_label_option)
2223 if (archive_format == GNU_FORMAT || archive_format == OLDGNU_FORMAT)
2225 size_t volume_label_max_len =
2226 (sizeof current_header->header.name
2227 - 1 /* for trailing '\0' */
2228 - (multi_volume_option
2229 ? (sizeof " Volume "
2230 - 1 /* for null at end of " Volume " */
2231 + INT_STRLEN_BOUND (int) /* for volume number */
2232 - 1 /* for sign, as 0 <= volno */)
2233 : 0));
2234 if (volume_label_max_len < strlen (volume_label_option))
2235 USAGE_ERROR ((0, 0,
2236 ngettext ("%s: Volume label is too long (limit is %lu byte)",
2237 "%s: Volume label is too long (limit is %lu bytes)",
2238 volume_label_max_len),
2239 quotearg_colon (volume_label_option),
2240 (unsigned long) volume_label_max_len));
2242 /* else FIXME
2243 Label length in PAX format is limited by the volume size. */
2246 if (verify_option)
2248 if (multi_volume_option)
2249 USAGE_ERROR ((0, 0, _("Cannot verify multi-volume archives")));
2250 if (use_compress_program_option)
2251 USAGE_ERROR ((0, 0, _("Cannot verify compressed archives")));
2254 if (use_compress_program_option)
2256 if (multi_volume_option)
2257 USAGE_ERROR ((0, 0, _("Cannot use multi-volume compressed archives")));
2258 if (subcommand_option == UPDATE_SUBCOMMAND
2259 || subcommand_option == APPEND_SUBCOMMAND
2260 || subcommand_option == DELETE_SUBCOMMAND)
2261 USAGE_ERROR ((0, 0, _("Cannot update compressed archives")));
2262 if (subcommand_option == CAT_SUBCOMMAND)
2263 USAGE_ERROR ((0, 0, _("Cannot concatenate compressed archives")));
2266 /* It is no harm to use --pax-option on non-pax archives in archive
2267 reading mode. It may even be useful, since it allows to override
2268 file attributes from tar headers. Therefore I allow such usage.
2269 --gray */
2270 if (args.pax_option
2271 && archive_format != POSIX_FORMAT
2272 && (subcommand_option != EXTRACT_SUBCOMMAND
2273 || subcommand_option != DIFF_SUBCOMMAND
2274 || subcommand_option != LIST_SUBCOMMAND))
2275 USAGE_ERROR ((0, 0, _("--pax-option can be used only on POSIX archives")));
2277 /* If ready to unlink hierarchies, so we are for simpler files. */
2278 if (recursive_unlink_option)
2279 old_files_option = UNLINK_FIRST_OLD_FILES;
2282 if (test_label_option)
2284 /* --test-label is silent if the user has specified the label name to
2285 compare against. */
2286 if (!args.input_files)
2287 verbose_option++;
2289 else if (utc_option)
2290 verbose_option = 2;
2292 /* Forbid using -c with no input files whatsoever. Check that `-f -',
2293 explicit or implied, is used correctly. */
2295 switch (subcommand_option)
2297 case CREATE_SUBCOMMAND:
2298 if (!args.input_files && !files_from_option)
2299 USAGE_ERROR ((0, 0,
2300 _("Cowardly refusing to create an empty archive")));
2301 if (args.compress_autodetect && archive_names
2302 && strcmp (archive_name_array[0], "-"))
2303 set_comression_program_by_suffix (archive_name_array[0],
2304 use_compress_program_option);
2305 break;
2307 case EXTRACT_SUBCOMMAND:
2308 case LIST_SUBCOMMAND:
2309 case DIFF_SUBCOMMAND:
2310 for (archive_name_cursor = archive_name_array;
2311 archive_name_cursor < archive_name_array + archive_names;
2312 archive_name_cursor++)
2313 if (!strcmp (*archive_name_cursor, "-"))
2314 request_stdin ("-f");
2315 break;
2317 case CAT_SUBCOMMAND:
2318 case UPDATE_SUBCOMMAND:
2319 case APPEND_SUBCOMMAND:
2320 for (archive_name_cursor = archive_name_array;
2321 archive_name_cursor < archive_name_array + archive_names;
2322 archive_name_cursor++)
2323 if (!strcmp (*archive_name_cursor, "-"))
2324 USAGE_ERROR ((0, 0,
2325 _("Options `-Aru' are incompatible with `-f -'")));
2327 default:
2328 break;
2331 /* Initialize stdlis */
2332 if (index_file_name)
2334 stdlis = fopen (index_file_name, "w");
2335 if (! stdlis)
2336 open_error (index_file_name);
2338 else
2339 stdlis = to_stdout_option ? stderr : stdout;
2341 archive_name_cursor = archive_name_array;
2343 /* Prepare for generating backup names. */
2345 if (args.backup_suffix_string)
2346 simple_backup_suffix = xstrdup (args.backup_suffix_string);
2348 if (backup_option)
2350 backup_type = xget_version ("--backup", args.version_control_string);
2351 /* No backup is needed either if explicitely disabled or if
2352 the extracted files are not being written to disk. */
2353 if (backup_type == no_backups || EXTRACT_OVER_PIPE)
2354 backup_option = false;
2357 checkpoint_finish_compile ();
2359 if (verbose_option)
2360 report_textual_dates (&args);
2364 /* Tar proper. */
2366 /* Main routine for tar. */
2368 main (int argc, char **argv)
2370 set_start_time ();
2371 program_name = argv[0];
2373 setlocale (LC_ALL, "");
2374 bindtextdomain (PACKAGE, LOCALEDIR);
2375 textdomain (PACKAGE);
2377 exit_failure = TAREXIT_FAILURE;
2378 exit_status = TAREXIT_SUCCESS;
2379 filename_terminator = '\n';
2380 set_quoting_style (0, DEFAULT_QUOTING_STYLE);
2382 /* Make sure we have first three descriptors available */
2383 stdopen ();
2385 /* Pre-allocate a few structures. */
2387 allocated_archive_names = 10;
2388 archive_name_array =
2389 xmalloc (sizeof (const char *) * allocated_archive_names);
2390 archive_names = 0;
2392 obstack_init (&argv_stk);
2394 #ifdef SIGCHLD
2395 /* System V fork+wait does not work if SIGCHLD is ignored. */
2396 signal (SIGCHLD, SIG_DFL);
2397 #endif
2399 /* Decode options. */
2401 decode_options (argc, argv);
2403 name_init ();
2405 /* Main command execution. */
2407 if (volno_file_option)
2408 init_volume_number ();
2410 switch (subcommand_option)
2412 case UNKNOWN_SUBCOMMAND:
2413 USAGE_ERROR ((0, 0,
2414 _("You must specify one of the `-Acdtrux' options")));
2416 case CAT_SUBCOMMAND:
2417 case UPDATE_SUBCOMMAND:
2418 case APPEND_SUBCOMMAND:
2419 update_archive ();
2420 break;
2422 case DELETE_SUBCOMMAND:
2423 delete_archive_members ();
2424 break;
2426 case CREATE_SUBCOMMAND:
2427 create_archive ();
2428 break;
2430 case EXTRACT_SUBCOMMAND:
2431 extr_init ();
2432 read_and (extract_archive);
2434 /* FIXME: should extract_finish () even if an ordinary signal is
2435 received. */
2436 extract_finish ();
2438 break;
2440 case LIST_SUBCOMMAND:
2441 read_and (list_archive);
2442 break;
2444 case DIFF_SUBCOMMAND:
2445 diff_init ();
2446 read_and (diff_archive);
2447 break;
2450 if (totals_option)
2451 print_total_stats ();
2453 if (check_links_option)
2454 check_links ();
2456 if (volno_file_option)
2457 closeout_volume_number ();
2459 /* Dispose of allocated memory, and return. */
2461 free (archive_name_array);
2462 name_term ();
2464 if (exit_status == TAREXIT_FAILURE)
2465 error (0, 0, _("Error exit delayed from previous errors"));
2467 if (stdlis == stdout)
2468 close_stdout ();
2469 else if (ferror (stderr) || fclose (stderr) != 0)
2470 exit_status = TAREXIT_FAILURE;
2472 return exit_status;
2475 void
2476 tar_stat_init (struct tar_stat_info *st)
2478 memset (st, 0, sizeof (*st));
2481 void
2482 tar_stat_destroy (struct tar_stat_info *st)
2484 free (st->orig_file_name);
2485 free (st->file_name);
2486 free (st->link_name);
2487 free (st->uname);
2488 free (st->gname);
2489 free (st->sparse_map);
2490 free (st->dumpdir);
2491 xheader_destroy (&st->xhdr);
2492 memset (st, 0, sizeof (*st));
2495 /* Format mask for all available formats that support nanosecond
2496 timestamp resolution. */
2497 #define NS_PRECISION_FORMAT_MASK FORMAT_MASK (POSIX_FORMAT)
2499 /* Same as timespec_cmp, but ignore nanoseconds if current archive
2500 format does not provide sufficient resolution. */
2502 tar_timespec_cmp (struct timespec a, struct timespec b)
2504 if (!(FORMAT_MASK (current_format) & NS_PRECISION_FORMAT_MASK))
2505 a.tv_nsec = b.tv_nsec = 0;
2506 return timespec_cmp (a, b);