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
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. */
26 #include <argp-namefrob.h>
27 #include <argp-fmtstream.h>
30 #if ! defined SIGCHLD && defined SIGCLD
31 # define SIGCHLD SIGCLD
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. */
43 #include <configmake.h>
47 #include <rmt-command.h>
50 #include <version-etc.h>
54 /* Local declarations. */
56 #ifndef DEFAULT_ARCHIVE_FORMAT
57 # define DEFAULT_ARCHIVE_FORMAT GNU_FORMAT
60 #ifndef DEFAULT_ARCHIVE
61 # define DEFAULT_ARCHIVE "tar.out"
64 #ifndef DEFAULT_BLOCKING
65 # define DEFAULT_BLOCKING 20
71 /* Name of option using stdin. */
72 static const char *stdin_used_by
;
74 /* Doesn't return if stdin already requested. */
76 request_stdin (const char *option
)
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. */
89 confirm (const char *message_action
, const char *message_name
)
91 static FILE *confirm_file
;
92 static int confirm_file_EOF
;
97 if (archive
== 0 || stdin_used_by
)
99 confirm_file
= fopen (TTY_NAME
, "r");
101 open_fatal (TTY_NAME
);
105 request_stdin ("-w");
106 confirm_file
= stdin
;
110 fprintf (stdlis
, "%s %s?", message_action
, quote (message_name
));
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;
120 status
= rpmatch (response
) > 0;
124 if (confirm_file_EOF
)
126 fputc ('\n', stdlis
);
133 static struct fmttab
{
135 enum archive_format fmt
;
138 { "oldgnu", OLDGNU_FORMAT
},
139 { "ustar", USTAR_FORMAT
},
140 { "posix", POSIX_FORMAT
},
141 #if 0 /* not fully supported yet */
142 { "star", STAR_FORMAT
},
144 { "gnu", GNU_FORMAT
},
145 { "pax", POSIX_FORMAT
}, /* An alias for posix */
150 set_archive_format (char const *name
)
152 struct fmttab
const *p
;
154 for (p
= fmttab
; strcmp (p
->name
, name
) != 0; )
156 USAGE_ERROR ((0, 0, _("%s: Invalid archive format"),
157 quotearg_colon (name
)));
159 archive_format
= p
->fmt
;
163 archive_format_string (enum archive_format fmt
)
165 struct fmttab
const *p
;
167 for (p
= fmttab
; p
->name
; p
++)
173 #define FORMAT_MASK(n) (1<<(n))
176 assert_format(unsigned fmt_mask
)
178 if ((FORMAT_MASK (archive_format
) & fmt_mask
) == 0)
180 _("GNU features wanted on incompatible archive format")));
184 subcommand_string (enum subcommand c
)
188 case UNKNOWN_SUBCOMMAND
:
191 case APPEND_SUBCOMMAND
:
197 case CREATE_SUBCOMMAND
:
200 case DELETE_SUBCOMMAND
:
203 case DIFF_SUBCOMMAND
:
206 case EXTRACT_SUBCOMMAND
:
209 case LIST_SUBCOMMAND
:
212 case UPDATE_SUBCOMMAND
:
221 tar_list_quoting_styles (argp_fmtstream_t fs
, char *prefix
)
225 for (i
= 0; quoting_style_args
[i
]; i
++)
226 argp_fmtstream_printf (fs
, "%s%s\n", prefix
, quoting_style_args
[i
]);
230 tar_set_quoting_style (char *arg
)
234 for (i
= 0; quoting_style_args
[i
]; i
++)
235 if (strcmp (arg
, quoting_style_args
[i
]) == 0)
237 set_quoting_style (NULL
, i
);
241 _("Unknown quoting style `%s'. Try `%s --quoting-style=help' to get a list."), arg
, program_invocation_short_name
));
249 ANCHORED_OPTION
= CHAR_MAX
+ 1,
250 ATIME_PRESERVE_OPTION
,
253 DELAY_DIRECTORY_RESTORE_OPTION
,
255 EXCLUDE_CACHES_OPTION
,
256 EXCLUDE_CACHES_UNDER_OPTION
,
257 EXCLUDE_CACHES_ALL_OPTION
,
260 EXCLUDE_TAG_UNDER_OPTION
,
261 EXCLUDE_TAG_ALL_OPTION
,
267 IGNORE_COMMAND_ERROR_OPTION
,
268 IGNORE_FAILED_READ_OPTION
,
270 KEEP_NEWER_FILES_OPTION
,
276 NO_DELAY_DIRECTORY_RESTORE_OPTION
,
277 NO_IGNORE_CASE_OPTION
,
278 NO_IGNORE_COMMAND_ERROR_OPTION
,
279 NO_OVERWRITE_DIR_OPTION
,
280 NO_QUOTE_CHARS_OPTION
,
282 NO_SAME_OWNER_OPTION
,
283 NO_SAME_PERMISSIONS_OPTION
,
285 NO_WILDCARDS_MATCH_SLASH_OPTION
,
288 NUMERIC_OWNER_OPTION
,
291 ONE_FILE_SYSTEM_OPTION
,
292 OVERWRITE_DIR_OPTION
,
299 QUOTING_STYLE_OPTION
,
302 RECURSIVE_UNLINK_OPTION
,
308 SHOW_DEFAULTS_OPTION
,
309 SHOW_OMITTED_DIRS_OPTION
,
310 SHOW_TRANSFORMED_NAMES_OPTION
,
311 SPARSE_VERSION_OPTION
,
312 STRIP_COMPONENTS_OPTION
,
320 USE_COMPRESS_PROGRAM_OPTION
,
324 WILDCARDS_MATCH_SLASH_OPTION
,
328 const char *argp_program_version
= "tar (" PACKAGE_NAME
") " VERSION
;
329 const char *argp_program_bug_address
= "<" PACKAGE_BUGREPORT
">";
330 static char const doc
[] = N_("\
331 GNU `tar' saves many files together into a single tape or disk archive, \
332 and can restore individual files from the archive.\n\
335 tar -cf archive.tar foo bar # Create archive.tar from files foo and bar.\n\
336 tar -tvf archive.tar # List all files in archive.tar verbosely.\n\
337 tar -xf archive.tar # Extract all files from archive.tar.\n")
339 N_("The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
340 The version control may be set with --backup or VERSION_CONTROL, values are:\n\n\
341 none, off never make backups\n\
342 t, numbered make numbered backups\n\
343 nil, existing numbered if numbered backups exist, simple otherwise\n\
344 never, simple always make simple backups\n");
349 Available option letters are DEIJQY and eqy. Consider the following
352 [For Solaris tar compatibility =/= Is it important at all?]
353 e exit immediately with a nonzero exit status if unexpected errors occur
354 E use extended headers (--format=posix)
356 [q alias for --occurrence=1 =/= this would better be used for quiet?]
357 [I same as T =/= will harm star compatibility]
359 y per-file gzip compression
360 Y per-block gzip compression */
362 static struct argp_option options
[] = {
365 N_("Main operation mode:"), GRID
},
368 N_("list the contents of an archive"), GRID
+1 },
369 {"extract", 'x', 0, 0,
370 N_("extract files from an archive"), GRID
+1 },
371 {"get", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
372 {"create", 'c', 0, 0,
373 N_("create a new archive"), GRID
+1 },
375 N_("find differences between archive and file system"), GRID
+1 },
376 {"compare", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
377 {"append", 'r', 0, 0,
378 N_("append files to the end of an archive"), GRID
+1 },
379 {"update", 'u', 0, 0,
380 N_("only append files newer than copy in archive"), GRID
+1 },
381 {"catenate", 'A', 0, 0,
382 N_("append tar files to an archive"), GRID
+1 },
383 {"concatenate", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
384 {"delete", DELETE_OPTION
, 0, 0,
385 N_("delete from the archive (not on mag tapes!)"), GRID
+1 },
386 {"test-label", TEST_LABEL_OPTION
, NULL
, 0,
387 N_("test the archive volume label and exit"), GRID
+1 },
392 N_("Operation modifiers:"), GRID
},
394 {"sparse", 'S', 0, 0,
395 N_("handle sparse files efficiently"), GRID
+1 },
396 {"sparse-version", SPARSE_VERSION_OPTION
, N_("MAJOR[.MINOR]"), 0,
397 N_("set version of the sparse format to use (implies --sparse)"), GRID
+1},
398 {"incremental", 'G', 0, 0,
399 N_("handle old GNU-format incremental backup"), GRID
+1 },
400 {"listed-incremental", 'g', N_("FILE"), 0,
401 N_("handle new GNU-format incremental backup"), GRID
+1 },
402 {"ignore-failed-read", IGNORE_FAILED_READ_OPTION
, 0, 0,
403 N_("do not exit with nonzero on unreadable files"), GRID
+1 },
404 {"occurrence", OCCURRENCE_OPTION
, N_("NUMBER"), OPTION_ARG_OPTIONAL
,
405 N_("process only the NUMBERth occurrence of each file in the archive;"
406 " this option is valid only in conjunction with one of the subcommands"
407 " --delete, --diff, --extract or --list and when a list of files"
408 " is given either on the command line or via the -T option;"
409 " NUMBER defaults to 1"), GRID
+1 },
410 {"seek", 'n', NULL
, 0,
411 N_("archive is seekable"), GRID
+1 },
416 N_("Overwrite control:"), GRID
},
418 {"verify", 'W', 0, 0,
419 N_("attempt to verify the archive after writing it"), GRID
+1 },
420 {"remove-files", REMOVE_FILES_OPTION
, 0, 0,
421 N_("remove files after adding them to the archive"), GRID
+1 },
422 {"keep-old-files", 'k', 0, 0,
423 N_("don't replace existing files when extracting"), GRID
+1 },
424 {"keep-newer-files", KEEP_NEWER_FILES_OPTION
, 0, 0,
425 N_("don't replace existing files that are newer than their archive copies"), GRID
+1 },
426 {"overwrite", OVERWRITE_OPTION
, 0, 0,
427 N_("overwrite existing files when extracting"), GRID
+1 },
428 {"unlink-first", 'U', 0, 0,
429 N_("remove each file prior to extracting over it"), GRID
+1 },
430 {"recursive-unlink", RECURSIVE_UNLINK_OPTION
, 0, 0,
431 N_("empty hierarchies prior to extracting directory"), GRID
+1 },
432 {"no-overwrite-dir", NO_OVERWRITE_DIR_OPTION
, 0, 0,
433 N_("preserve metadata of existing directories"), GRID
+1 },
434 {"overwrite-dir", OVERWRITE_DIR_OPTION
, 0, 0,
435 N_("overwrite metadata of existing directories when extracting (default)"),
441 N_("Select output stream:"), GRID
},
443 {"to-stdout", 'O', 0, 0,
444 N_("extract files to standard output"), GRID
+1 },
445 {"to-command", TO_COMMAND_OPTION
, N_("COMMAND"), 0,
446 N_("pipe extracted files to another program"), GRID
+1 },
447 {"ignore-command-error", IGNORE_COMMAND_ERROR_OPTION
, 0, 0,
448 N_("ignore exit codes of children"), GRID
+1 },
449 {"no-ignore-command-error", NO_IGNORE_COMMAND_ERROR_OPTION
, 0, 0,
450 N_("treat non-zero exit codes of children as error"), GRID
+1 },
455 N_("Handling of file attributes:"), GRID
},
457 {"owner", OWNER_OPTION
, N_("NAME"), 0,
458 N_("force NAME as owner for added files"), GRID
+1 },
459 {"group", GROUP_OPTION
, N_("NAME"), 0,
460 N_("force NAME as group for added files"), GRID
+1 },
461 {"mtime", MTIME_OPTION
, N_("DATE-OR-FILE"), 0,
462 N_("set mtime for added files from DATE-OR-FILE"), GRID
+1 },
463 {"mode", MODE_OPTION
, N_("CHANGES"), 0,
464 N_("force (symbolic) mode CHANGES for added files"), GRID
+1 },
465 {"atime-preserve", ATIME_PRESERVE_OPTION
,
466 N_("METHOD"), OPTION_ARG_OPTIONAL
,
467 N_("preserve access times on dumped files, either by restoring the times"
468 " after reading (METHOD='replace'; default) or by not setting the times"
469 " in the first place (METHOD='system')"), GRID
+1 },
471 N_("don't extract file modified time"), GRID
+1 },
472 {"same-owner", SAME_OWNER_OPTION
, 0, 0,
473 N_("try extracting files with the same ownership"), GRID
+1 },
474 {"no-same-owner", NO_SAME_OWNER_OPTION
, 0, 0,
475 N_("extract files as yourself"), GRID
+1 },
476 {"numeric-owner", NUMERIC_OWNER_OPTION
, 0, 0,
477 N_("always use numbers for user/group names"), GRID
+1 },
478 {"preserve-permissions", 'p', 0, 0,
479 N_("extract information about file permissions (default for superuser)"),
481 {"same-permissions", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
482 {"no-same-permissions", NO_SAME_PERMISSIONS_OPTION
, 0, 0,
483 N_("apply the user's umask when extracting permissions from the archive (default for ordinary users)"), GRID
+1 },
484 {"preserve-order", 's', 0, 0,
485 N_("sort names to extract to match archive"), GRID
+1 },
486 {"same-order", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
487 {"preserve", PRESERVE_OPTION
, 0, 0,
488 N_("same as both -p and -s"), GRID
+1 },
489 {"delay-directory-restore", DELAY_DIRECTORY_RESTORE_OPTION
, 0, 0,
490 N_("delay setting modification times and permissions of extracted"
491 " directories until the end of extraction"), GRID
+1 },
492 {"no-delay-directory-restore", NO_DELAY_DIRECTORY_RESTORE_OPTION
, 0, 0,
493 N_("cancel the effect of --delay-directory-restore option"), GRID
+1 },
498 N_("Device selection and switching:"), GRID
},
500 {"file", 'f', N_("ARCHIVE"), 0,
501 N_("use archive file or device ARCHIVE"), GRID
+1 },
502 {"force-local", FORCE_LOCAL_OPTION
, 0, 0,
503 N_("archive file is local even if it has a colon"), GRID
+1 },
504 {"rmt-command", RMT_COMMAND_OPTION
, N_("COMMAND"), 0,
505 N_("use given rmt COMMAND instead of rmt"), GRID
+1 },
506 {"rsh-command", RSH_COMMAND_OPTION
, N_("COMMAND"), 0,
507 N_("use remote COMMAND instead of rsh"), GRID
+1 },
509 {"-[0-7][lmh]", 0, NULL
, OPTION_DOC
, /* It is OK, since `name' will never be
511 N_("specify drive and density"), GRID
+1 },
513 {NULL
, '0', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
514 {NULL
, '1', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
515 {NULL
, '2', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
516 {NULL
, '3', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
517 {NULL
, '4', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
518 {NULL
, '5', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
519 {NULL
, '6', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
520 {NULL
, '7', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
521 {NULL
, '8', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
522 {NULL
, '9', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
524 {"multi-volume", 'M', 0, 0,
525 N_("create/list/extract multi-volume archive"), GRID
+1 },
526 {"tape-length", 'L', N_("NUMBER"), 0,
527 N_("change tape after writing NUMBER x 1024 bytes"), GRID
+1 },
528 {"info-script", 'F', N_("NAME"), 0,
529 N_("run script at end of each tape (implies -M)"), GRID
+1 },
530 {"new-volume-script", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
531 {"volno-file", VOLNO_FILE_OPTION
, N_("FILE"), 0,
532 N_("use/update the volume number in FILE"), GRID
+1 },
537 N_("Device blocking:"), GRID
},
539 {"blocking-factor", 'b', N_("BLOCKS"), 0,
540 N_("BLOCKS x 512 bytes per record"), GRID
+1 },
541 {"record-size", RECORD_SIZE_OPTION
, N_("NUMBER"), 0,
542 N_("NUMBER of bytes per record, multiple of 512"), GRID
+1 },
543 {"ignore-zeros", 'i', 0, 0,
544 N_("ignore zeroed blocks in archive (means EOF)"), GRID
+1 },
545 {"read-full-records", 'B', 0, 0,
546 N_("reblock as we read (for 4.2BSD pipes)"), GRID
+1 },
551 N_("Archive format selection:"), GRID
},
553 {"format", 'H', N_("FORMAT"), 0,
554 N_("create archive of the given format"), GRID
+1 },
556 {NULL
, 0, NULL
, 0, N_("FORMAT is one of the following:"), GRID
+2 },
557 {" v7", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
, N_("old V7 tar format"),
559 {" oldgnu", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
560 N_("GNU format as per tar <= 1.12"), GRID
+3 },
561 {" gnu", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
562 N_("GNU tar 1.13.x format"), GRID
+3 },
563 {" ustar", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
564 N_("POSIX 1003.1-1988 (ustar) format"), GRID
+3 },
565 {" pax", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
566 N_("POSIX 1003.1-2001 (pax) format"), GRID
+3 },
567 {" posix", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
, N_("same as pax"), GRID
+3 },
569 {"old-archive", OLD_ARCHIVE_OPTION
, 0, 0, /* FIXME */
570 N_("same as --format=v7"), GRID
+8 },
571 {"portability", 0, 0, OPTION_ALIAS
, NULL
, GRID
+8 },
572 {"posix", POSIX_OPTION
, 0, 0,
573 N_("same as --format=posix"), GRID
+8 },
574 {"pax-option", PAX_OPTION
, N_("keyword[[:]=value][,keyword[[:]=value]]..."), 0,
575 N_("control pax keywords"), GRID
+8 },
576 {"label", 'V', N_("TEXT"), 0,
577 N_("create archive with volume name TEXT; at list/extract time, use TEXT as a globbing pattern for volume name"), GRID
+8 },
582 N_("Compression options:"), GRID
},
583 {"auto-compress", 'a', 0, 0,
584 N_("use archive suffix to determine the compression program"), GRID
+1 },
586 N_("filter the archive through bzip2"), GRID
+1 },
588 N_("filter the archive through gzip"), GRID
+1 },
589 {"gunzip", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
590 {"ungzip", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
591 {"compress", 'Z', 0, 0,
592 N_("filter the archive through compress"), GRID
+1 },
593 {"uncompress", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
594 {"lzma", LZMA_OPTION
, 0, 0,
595 N_("filter the archive through lzma"), GRID
+1 },
596 {"use-compress-program", USE_COMPRESS_PROGRAM_OPTION
, N_("PROG"), 0,
597 N_("filter through PROG (must accept -d)"), GRID
+1 },
602 N_("Local file selection:"), GRID
},
604 {"add-file", ARGP_KEY_ARG
, N_("FILE"), 0,
605 N_("add given FILE to the archive (useful if its name starts with a dash)"), GRID
+1 },
606 {"directory", 'C', N_("DIR"), 0,
607 N_("change to directory DIR"), GRID
+1 },
608 {"files-from", 'T', N_("FILE"), 0,
609 N_("get names to extract or create from FILE"), GRID
+1 },
610 {"null", NULL_OPTION
, 0, 0,
611 N_("-T reads null-terminated names, disable -C"), GRID
+1 },
612 {"unquote", UNQUOTE_OPTION
, 0, 0,
613 N_("unquote filenames read with -T (default)"), GRID
+1 },
614 {"no-unquote", NO_UNQUOTE_OPTION
, 0, 0,
615 N_("do not unquote filenames read with -T"), GRID
+1 },
616 {"exclude", EXCLUDE_OPTION
, N_("PATTERN"), 0,
617 N_("exclude files, given as a PATTERN"), GRID
+1 },
618 {"exclude-from", 'X', N_("FILE"), 0,
619 N_("exclude patterns listed in FILE"), GRID
+1 },
620 {"exclude-caches", EXCLUDE_CACHES_OPTION
, 0, 0,
621 N_("exclude contents of directories containing CACHEDIR.TAG, "
622 "except for the tag file itself"), GRID
+1 },
623 {"exclude-caches-under", EXCLUDE_CACHES_UNDER_OPTION
, 0, 0,
624 N_("exclude everything under directories containing CACHEDIR.TAG"),
626 {"exclude-caches-all", EXCLUDE_CACHES_ALL_OPTION
, 0, 0,
627 N_("exclude directories containing CACHEDIR.TAG"), GRID
+1 },
628 {"exclude-tag", EXCLUDE_TAG_OPTION
, N_("FILE"), 0,
629 N_("exclude contents of directories containing FILE, except"
630 " for FILE itself"), GRID
+1 },
631 {"exclude-tag-under", EXCLUDE_TAG_UNDER_OPTION
, N_("FILE"), 0,
632 N_("exclude everything under directories containing FILE"), GRID
+1 },
633 {"exclude-tag-all", EXCLUDE_TAG_ALL_OPTION
, N_("FILE"), 0,
634 N_("exclude directories containing FILE"), GRID
+1 },
635 {"exclude-vcs", EXCLUDE_VCS_OPTION
, NULL
, 0,
636 N_("exclude version control system directories"), GRID
+1 },
637 {"no-recursion", NO_RECURSION_OPTION
, 0, 0,
638 N_("avoid descending automatically in directories"), GRID
+1 },
639 {"one-file-system", ONE_FILE_SYSTEM_OPTION
, 0, 0,
640 N_("stay in local file system when creating archive"), GRID
+1 },
641 {"recursion", RECURSION_OPTION
, 0, 0,
642 N_("recurse into directories (default)"), GRID
+1 },
643 {"absolute-names", 'P', 0, 0,
644 N_("don't strip leading `/'s from file names"), GRID
+1 },
645 {"dereference", 'h', 0, 0,
646 N_("follow symlinks; archive and dump the files they point to"), GRID
+1 },
647 {"starting-file", 'K', N_("MEMBER-NAME"), 0,
648 N_("begin at member MEMBER-NAME in the archive"), GRID
+1 },
649 {"newer", 'N', N_("DATE-OR-FILE"), 0,
650 N_("only store files newer than DATE-OR-FILE"), GRID
+1 },
651 {"after-date", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
652 {"newer-mtime", NEWER_MTIME_OPTION
, N_("DATE"), 0,
653 N_("compare date and time when data changed only"), GRID
+1 },
654 {"backup", BACKUP_OPTION
, N_("CONTROL"), OPTION_ARG_OPTIONAL
,
655 N_("backup before removal, choose version CONTROL"), GRID
+1 },
656 {"suffix", SUFFIX_OPTION
, N_("STRING"), 0,
657 N_("backup before removal, override usual suffix ('~' unless overridden by environment variable SIMPLE_BACKUP_SUFFIX)"), GRID
+1 },
662 N_("File name transformations:"), GRID
},
663 {"strip-components", STRIP_COMPONENTS_OPTION
, N_("NUMBER"), 0,
664 N_("strip NUMBER leading components from file names on extraction"),
666 {"transform", TRANSFORM_OPTION
, N_("EXPRESSION"), 0,
667 N_("use sed replace EXPRESSION to transform file names"), GRID
+1 },
672 N_("File name matching options (affect both exclude and include patterns):"),
674 {"ignore-case", IGNORE_CASE_OPTION
, 0, 0,
675 N_("ignore case"), GRID
+1 },
676 {"anchored", ANCHORED_OPTION
, 0, 0,
677 N_("patterns match file name start"), GRID
+1 },
678 {"no-anchored", NO_ANCHORED_OPTION
, 0, 0,
679 N_("patterns match after any `/' (default for exclusion)"), GRID
+1 },
680 {"no-ignore-case", NO_IGNORE_CASE_OPTION
, 0, 0,
681 N_("case sensitive matching (default)"), GRID
+1 },
682 {"wildcards", WILDCARDS_OPTION
, 0, 0,
683 N_("use wildcards (default for exclusion)"), GRID
+1 },
684 {"no-wildcards", NO_WILDCARDS_OPTION
, 0, 0,
685 N_("verbatim string matching"), GRID
+1 },
686 {"no-wildcards-match-slash", NO_WILDCARDS_MATCH_SLASH_OPTION
, 0, 0,
687 N_("wildcards do not match `/'"), GRID
+1 },
688 {"wildcards-match-slash", WILDCARDS_MATCH_SLASH_OPTION
, 0, 0,
689 N_("wildcards match `/' (default for exclusion)"), GRID
+1 },
694 N_("Informative output:"), GRID
},
696 {"verbose", 'v', 0, 0,
697 N_("verbosely list files processed"), GRID
+1 },
698 {"checkpoint", CHECKPOINT_OPTION
, N_("[.]NUMBER"), OPTION_ARG_OPTIONAL
,
699 N_("display progress messages every NUMBERth record (default 10)"),
701 {"check-links", 'l', 0, 0,
702 N_("print a message if not all links are dumped"), GRID
+1 },
703 {"totals", TOTALS_OPTION
, N_("SIGNAL"), OPTION_ARG_OPTIONAL
,
704 N_("print total bytes after processing the archive; "
705 "with an argument - print total bytes when this SIGNAL is delivered; "
706 "Allowed signals are: SIGHUP, SIGQUIT, SIGINT, SIGUSR1 and SIGUSR2; "
707 "the names without SIG prefix are also accepted"), GRID
+1 },
708 {"utc", UTC_OPTION
, 0, 0,
709 N_("print file modification dates in UTC"), GRID
+1 },
710 {"index-file", INDEX_FILE_OPTION
, N_("FILE"), 0,
711 N_("send verbose output to FILE"), GRID
+1 },
712 {"block-number", 'R', 0, 0,
713 N_("show block number within archive with each message"), GRID
+1 },
714 {"interactive", 'w', 0, 0,
715 N_("ask for confirmation for every action"), GRID
+1 },
716 {"confirmation", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
717 {"show-defaults", SHOW_DEFAULTS_OPTION
, 0, 0,
718 N_("show tar defaults"), GRID
+1 },
719 {"show-omitted-dirs", SHOW_OMITTED_DIRS_OPTION
, 0, 0,
720 N_("when listing or extracting, list each directory that does not match search criteria"), GRID
+1 },
721 {"show-transformed-names", SHOW_TRANSFORMED_NAMES_OPTION
, 0, 0,
722 N_("show file or archive names after transformation"),
724 {"show-stored-names", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
725 {"quoting-style", QUOTING_STYLE_OPTION
, N_("STYLE"), 0,
726 N_("set name quoting style; see below for valid STYLE values"), GRID
+1 },
727 {"quote-chars", QUOTE_CHARS_OPTION
, N_("STRING"), 0,
728 N_("additionally quote characters from STRING"), GRID
+1 },
729 {"no-quote-chars", NO_QUOTE_CHARS_OPTION
, N_("STRING"), 0,
730 N_("disable quoting for characters from STRING"), GRID
+1 },
735 N_("Compatibility options:"), GRID
},
738 N_("when creating, same as --old-archive; when extracting, same as --no-same-owner"), GRID
+1 },
743 N_("Other options:"), GRID
},
745 {"restrict", RESTRICT_OPTION
, 0, 0,
746 N_("disable use of some potentially harmful options"), -1 },
748 {"help", '?', 0, 0, N_("give this help list"), -1},
749 {"usage", USAGE_OPTION
, 0, 0, N_("give a short usage message"), -1},
750 {"version", VERSION_OPTION
, 0, 0, N_("print program version"), -1},
751 /* FIXME -V (--label) conflicts with the default short option for
753 {"HANG", HANG_OPTION
, "SECS", OPTION_ARG_OPTIONAL
| OPTION_HIDDEN
,
754 N_("hang for SECS seconds (default 3600)"), 0},
760 static char const *const atime_preserve_args
[] =
762 "replace", "system", NULL
765 static enum atime_preserve
const atime_preserve_types
[] =
767 replace_atime_preserve
, system_atime_preserve
770 /* Make sure atime_preserve_types has as much entries as atime_preserve_args
771 (minus 1 for NULL guard) */
772 ARGMATCH_VERIFY (atime_preserve_args
, atime_preserve_types
);
774 /* Wildcard matching settings */
777 default_wildcards
, /* For exclusion == enable_wildcards,
778 for inclusion == disable_wildcards */
783 struct tar_args
/* Variables used during option parsing */
785 struct textual_date
*textual_date
; /* Keeps the arguments to --newer-mtime
786 and/or --date option if they are
788 enum wildcards wildcards
; /* Wildcard settings (--wildcards/
790 int matching_flags
; /* exclude_fnmatch options */
791 int include_anchored
; /* Pattern anchoring options used for
793 bool o_option
; /* True if -o option was given */
794 bool pax_option
; /* True if --pax-option was given */
795 char const *backup_suffix_string
; /* --suffix option argument */
796 char const *version_control_string
; /* --backup option argument */
797 bool input_files
; /* True if some input files where given */
798 int compress_autodetect
; /* True if compression autodetection should
799 be attempted when creating archives */
803 #define MAKE_EXCL_OPTIONS(args) \
804 ((((args)->wildcards != disable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
805 | (args)->matching_flags \
808 #define MAKE_INCL_OPTIONS(args) \
809 ((((args)->wildcards == enable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
810 | (args)->include_anchored \
811 | (args)->matching_flags \
818 static char *vcs_file
[] = {
840 for (i
= 0; vcs_file
[i
]; i
++)
841 add_exclude (excluded
, vcs_file
[i
], 0);
846 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
849 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
850 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
851 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
852 quoting_style_args[DEFAULT_QUOTING_STYLE], \
853 DEFAULT_RMT_COMMAND); \
854 printer (stream, " --rsh-command=%s", REMOTE_SHELL); \
855 printer (stream, "\n"); \
858 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
861 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
862 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
863 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
864 quoting_style_args[DEFAULT_QUOTING_STYLE], \
865 DEFAULT_RMT_COMMAND); \
866 printer (stream, "\n"); \
871 show_default_settings (FILE *fp
)
872 DECL_SHOW_DEFAULT_SETTINGS(fp
, fprintf
)
875 show_default_settings_fs (argp_fmtstream_t fs
)
876 DECL_SHOW_DEFAULT_SETTINGS(fs
, argp_fmtstream_printf
)
879 set_subcommand_option (enum subcommand subcommand
)
881 if (subcommand_option
!= UNKNOWN_SUBCOMMAND
882 && subcommand_option
!= subcommand
)
884 _("You may not specify more than one `-Acdtrux' option")));
886 subcommand_option
= subcommand
;
890 set_use_compress_program_option (const char *string
)
892 if (use_compress_program_option
893 && strcmp (use_compress_program_option
, string
) != 0)
894 USAGE_ERROR ((0, 0, _("Conflicting compression options")));
896 use_compress_program_option
= string
;
903 print_total_stats ();
904 #ifndef HAVE_SIGACTION
905 signal (signo
, sigstat
);
910 stat_on_signal (int signo
)
912 #ifdef HAVE_SIGACTION
913 struct sigaction act
;
914 act
.sa_handler
= sigstat
;
915 sigemptyset (&act
.sa_mask
);
917 sigaction (signo
, &act
, NULL
);
919 signal (signo
, sigstat
);
924 set_stat_signal (const char *name
)
931 { "SIGUSR1", SIGUSR1
},
933 { "SIGUSR2", SIGUSR2
},
935 { "SIGHUP", SIGHUP
},
937 { "SIGINT", SIGINT
},
939 { "SIGQUIT", SIGQUIT
},
944 for (p
= sigtab
; p
< sigtab
+ sizeof (sigtab
) / sizeof (sigtab
[0]); p
++)
945 if (strcmp (p
->name
, name
) == 0)
947 stat_on_signal (p
->signo
);
950 FATAL_ERROR ((0, 0, _("Unknown signal name: %s"), name
));
956 struct textual_date
*next
;
963 get_date_or_file (struct tar_args
*args
, const char *option
,
964 const char *str
, struct timespec
*ts
)
966 if (FILE_SYSTEM_PREFIX_LEN (str
) != 0
971 if (deref_stat (dereference_option
, str
, &st
) != 0)
974 USAGE_ERROR ((0, 0, _("Date sample file not found")));
976 *ts
= get_stat_mtime (&st
);
980 if (! get_date (ts
, str
, NULL
))
982 WARN ((0, 0, _("Substituting %s for unknown date format %s"),
983 tartime (*ts
, false), quote (str
)));
988 struct textual_date
*p
= xmalloc (sizeof (*p
));
992 p
->next
= args
->textual_date
;
993 args
->textual_date
= p
;
999 report_textual_dates (struct tar_args
*args
)
1001 struct textual_date
*p
;
1002 for (p
= args
->textual_date
; p
; )
1004 struct textual_date
*next
= p
->next
;
1005 char const *treated_as
= tartime (*p
->ts
, true);
1006 if (strcmp (p
->date
, treated_as
) != 0)
1007 WARN ((0, 0, _("Option %s: Treating date `%s' as %s"),
1008 p
->option
, p
->date
, treated_as
));
1015 static volatile int _argp_hang
;
1017 enum read_file_list_state
/* Result of reading file name from the list file */
1019 file_list_success
, /* OK, name read successfully */
1020 file_list_end
, /* End of list file */
1021 file_list_zero
, /* Zero separator encountered where it should not */
1022 file_list_skip
/* Empty (zero-length) entry encountered, skip it */
1025 /* Read from FP a sequence of characters up to FILENAME_TERMINATOR and put them
1028 static enum read_file_list_state
1029 read_name_from_file (FILE *fp
, struct obstack
*stk
)
1034 for (c
= getc (fp
); c
!= EOF
&& c
!= filename_terminator
; c
= getc (fp
))
1038 /* We have read a zero separator. The file possibly is
1040 return file_list_zero
;
1042 obstack_1grow (stk
, c
);
1046 if (counter
== 0 && c
!= EOF
)
1047 return file_list_skip
;
1049 obstack_1grow (stk
, 0);
1051 return (counter
== 0 && c
== EOF
) ? file_list_end
: file_list_success
;
1055 static bool files_from_option
; /* When set, tar will not refuse to create
1057 static struct obstack argv_stk
; /* Storage for additional command line options
1058 read using -T option */
1060 /* Prevent recursive inclusion of the same file */
1063 struct file_id_list
*next
;
1068 static struct file_id_list
*file_id_list
;
1071 add_file_id (const char *filename
)
1073 struct file_id_list
*p
;
1076 if (stat (filename
, &st
))
1077 stat_fatal (filename
);
1078 for (p
= file_id_list
; p
; p
= p
->next
)
1079 if (p
->ino
== st
.st_ino
&& p
->dev
== st
.st_dev
)
1081 FATAL_ERROR ((0, 0, _("%s: file list already read"),
1082 quotearg_colon (filename
)));
1084 p
= xmalloc (sizeof *p
);
1085 p
->next
= file_id_list
;
1091 /* Default density numbers for [0-9][lmh] device specifications */
1093 #ifndef LOW_DENSITY_NUM
1094 # define LOW_DENSITY_NUM 0
1097 #ifndef MID_DENSITY_NUM
1098 # define MID_DENSITY_NUM 8
1101 #ifndef HIGH_DENSITY_NUM
1102 # define HIGH_DENSITY_NUM 16
1106 update_argv (const char *filename
, struct argp_state
*state
)
1109 size_t count
= 0, i
;
1113 bool is_stdin
= false;
1114 enum read_file_list_state read_state
;
1116 if (!strcmp (filename
, "-"))
1119 request_stdin ("-T");
1124 add_file_id (filename
);
1125 if ((fp
= fopen (filename
, "r")) == NULL
)
1126 open_fatal (filename
);
1129 while ((read_state
= read_name_from_file (fp
, &argv_stk
)) != file_list_end
)
1133 case file_list_success
:
1137 case file_list_end
: /* won't happen, just to pacify gcc */
1140 case file_list_zero
:
1144 WARN ((0, 0, N_("%s: file name read contains nul character"),
1145 quotearg_colon (filename
)));
1147 /* Prepare new stack contents */
1148 size
= obstack_object_size (&argv_stk
);
1149 p
= obstack_finish (&argv_stk
);
1150 for (; size
> 0; size
--, p
++)
1152 obstack_1grow (&argv_stk
, *p
);
1154 obstack_1grow (&argv_stk
, '\n');
1155 obstack_1grow (&argv_stk
, 0);
1157 /* Read rest of files using new filename terminator */
1158 filename_terminator
= 0;
1162 case file_list_skip
:
1173 start
= obstack_finish (&argv_stk
);
1175 if (filename_terminator
== 0)
1176 for (p
= start
; *p
; p
+= strlen (p
) + 1)
1180 new_argc
= state
->argc
+ count
;
1181 new_argv
= xmalloc (sizeof (state
->argv
[0]) * (new_argc
+ 1));
1182 memcpy (new_argv
, state
->argv
, sizeof (state
->argv
[0]) * (state
->argc
+ 1));
1183 state
->argv
= new_argv
;
1184 memmove (&state
->argv
[state
->next
+ count
], &state
->argv
[state
->next
],
1185 (state
->argc
- state
->next
+ 1) * sizeof (state
->argv
[0]));
1187 state
->argc
= new_argc
;
1189 for (i
= state
->next
, p
= start
; *p
; p
+= strlen (p
) + 1, i
++)
1191 if (filename_terminator
== 0 && p
[0] == '-')
1192 state
->argv
[i
++] = "--add-file";
1199 tar_help (struct argp_state
*state
)
1201 argp_fmtstream_t fs
;
1202 state
->flags
|= ARGP_NO_EXIT
;
1203 argp_state_help (state
, state
->out_stream
,
1204 ARGP_HELP_STD_HELP
& ~ARGP_HELP_BUG_ADDR
);
1205 /* FIXME: use struct uparams.rmargin (from argp-help.c) instead of 79 */
1206 fs
= argp_make_fmtstream (state
->out_stream
, 0, 79, 0);
1208 argp_fmtstream_printf (fs
, "\n%s\n\n",
1209 _("Valid arguments for --quoting-style options are:"));
1210 tar_list_quoting_styles (fs
, " ");
1212 argp_fmtstream_puts (fs
, _("\n*This* tar defaults to:\n"));
1213 show_default_settings_fs (fs
);
1214 argp_fmtstream_putc (fs
, '\n');
1215 argp_fmtstream_printf (fs
, _("Report bugs to %s.\n"),
1216 argp_program_bug_address
);
1217 argp_fmtstream_free (fs
);
1221 parse_opt (int key
, char *arg
, struct argp_state
*state
)
1223 struct tar_args
*args
= state
->input
;
1228 /* File name or non-parsed option, because of ARGP_IN_ORDER */
1229 name_add_name (arg
, MAKE_INCL_OPTIONS (args
));
1230 args
->input_files
= true;
1234 set_subcommand_option (CAT_SUBCOMMAND
);
1238 args
->compress_autodetect
= true;
1244 if (! (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1245 && u
== (blocking_factor
= u
)
1246 && 0 < blocking_factor
1247 && u
== (record_size
= u
* BLOCKSIZE
) / BLOCKSIZE
))
1248 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1249 _("Invalid blocking factor")));
1254 /* Try to reblock input records. For reading 4.2BSD pipes. */
1256 /* It would surely make sense to exchange -B and -R, but it seems
1257 that -B has been used for a long while in Sun tar and most
1258 BSD-derived systems. This is a consequence of the block/record
1259 terminology confusion. */
1261 read_full_records_option
= true;
1265 set_subcommand_option (CREATE_SUBCOMMAND
);
1273 set_subcommand_option (DIFF_SUBCOMMAND
);
1277 if (archive_names
== allocated_archive_names
)
1278 archive_name_array
= x2nrealloc (archive_name_array
,
1279 &allocated_archive_names
,
1280 sizeof (archive_name_array
[0]));
1282 archive_name_array
[archive_names
++] = arg
;
1286 /* Since -F is only useful with -M, make it implied. Run this
1287 script at the end of each tape. */
1289 info_script_option
= arg
;
1290 multi_volume_option
= true;
1294 listed_incremental_option
= arg
;
1295 after_date_option
= true;
1299 /* We are making an incremental dump (FIXME: are we?); save
1300 directories at the beginning of the archive, and include in each
1301 directory its contents. */
1303 incremental_option
= true;
1307 /* Follow symbolic links. */
1308 dereference_option
= true;
1312 /* Ignore zero blocks (eofs). This can't be the default,
1313 because Unix tar writes two blocks of zeros, then pads out
1314 the record with garbage. */
1316 ignore_zeros_option
= true;
1321 _("Warning: the -I option is not supported;"
1322 " perhaps you meant -j or -T?")));
1326 set_use_compress_program_option ("bzip2");
1330 /* Don't replace existing files. */
1331 old_files_option
= KEEP_OLD_FILES
;
1335 starting_file_option
= true;
1339 case ONE_FILE_SYSTEM_OPTION
:
1340 /* When dumping directories, don't dump files/subdirectories
1341 that are on other filesystems. */
1342 one_file_system_option
= true;
1346 check_links_option
= 1;
1352 if (xstrtoumax (arg
, 0, 10, &u
, "") != LONGINT_OK
)
1353 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1354 _("Invalid tape length")));
1355 tape_length_option
= 1024 * (tarlong
) u
;
1356 multi_volume_option
= true;
1361 set_use_compress_program_option ("lzma");
1365 touch_option
= true;
1369 /* Make multivolume archive: when we can't write any more into
1370 the archive, re-open it, and continue writing. */
1372 multi_volume_option
= true;
1376 get_date_or_file (args
, "--mtime", arg
, &mtime_option
);
1377 set_mtime_option
= true;
1381 seekable_archive
= true;
1385 after_date_option
= true;
1388 case NEWER_MTIME_OPTION
:
1389 if (NEWER_OPTION_INITIALIZED (newer_mtime_option
))
1390 USAGE_ERROR ((0, 0, _("More than one threshold date")));
1391 get_date_or_file (args
,
1392 key
== NEWER_MTIME_OPTION
? "--newer-mtime"
1393 : "--after-date", arg
, &newer_mtime_option
);
1397 args
->o_option
= true;
1401 to_stdout_option
= true;
1405 same_permissions_option
= true;
1409 absolute_names_option
= true;
1413 set_subcommand_option (APPEND_SUBCOMMAND
);
1417 /* Print block numbers for debugging bad tar archives. */
1419 /* It would surely make sense to exchange -B and -R, but it seems
1420 that -B has been used for a long while in Sun tar and most
1421 BSD-derived systems. This is a consequence of the block/record
1422 terminology confusion. */
1424 block_number_option
= true;
1428 /* Names to extract are sorted. */
1430 same_order_option
= true;
1434 sparse_option
= true;
1437 case SPARSE_VERSION_OPTION
:
1438 sparse_option
= true;
1441 tar_sparse_major
= strtoul (arg
, &p
, 10);
1445 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1446 tar_sparse_minor
= strtoul (p
+ 1, &p
, 10);
1448 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1454 set_subcommand_option (LIST_SUBCOMMAND
);
1458 case TEST_LABEL_OPTION
:
1459 set_subcommand_option (LIST_SUBCOMMAND
);
1460 test_label_option
= true;
1464 update_argv (arg
, state
);
1465 /* Indicate we've been given -T option. This is for backward
1466 compatibility only, so that `tar cfT archive /dev/null will
1468 files_from_option
= true;
1472 set_subcommand_option (UPDATE_SUBCOMMAND
);
1476 old_files_option
= UNLINK_FIRST_OLD_FILES
;
1488 volume_label_option
= arg
;
1492 interactive_option
= true;
1496 verify_option
= true;
1500 set_subcommand_option (EXTRACT_SUBCOMMAND
);
1504 if (add_exclude_file (add_exclude
, excluded
, arg
,
1505 MAKE_EXCL_OPTIONS (args
), '\n')
1509 FATAL_ERROR ((0, e
, "%s", quotearg_colon (arg
)));
1514 set_use_compress_program_option ("gzip");
1518 set_use_compress_program_option ("compress");
1521 case ANCHORED_OPTION
:
1522 args
->matching_flags
|= EXCLUDE_ANCHORED
;
1525 case ATIME_PRESERVE_OPTION
:
1526 atime_preserve_option
=
1528 ? XARGMATCH ("--atime-preserve", arg
,
1529 atime_preserve_args
, atime_preserve_types
)
1530 : replace_atime_preserve
);
1531 if (! O_NOATIME
&& atime_preserve_option
== system_atime_preserve
)
1533 _("--atime-preserve='system' is not supported"
1534 " on this platform")));
1537 case CHECKPOINT_OPTION
:
1544 checkpoint_style
= checkpoint_dot
;
1547 checkpoint_option
= strtoul (arg
, &p
, 0);
1550 _("--checkpoint value is not an integer")));
1553 checkpoint_option
= 10;
1557 backup_option
= true;
1559 args
->version_control_string
= arg
;
1562 case DELAY_DIRECTORY_RESTORE_OPTION
:
1563 delay_directory_restore_option
= true;
1566 case NO_DELAY_DIRECTORY_RESTORE_OPTION
:
1567 delay_directory_restore_option
= false;
1571 set_subcommand_option (DELETE_SUBCOMMAND
);
1574 case EXCLUDE_OPTION
:
1575 add_exclude (excluded
, arg
, MAKE_EXCL_OPTIONS (args
));
1578 case EXCLUDE_CACHES_OPTION
:
1579 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_contents
,
1583 case EXCLUDE_CACHES_UNDER_OPTION
:
1584 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_under
,
1588 case EXCLUDE_CACHES_ALL_OPTION
:
1589 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_all
,
1593 case EXCLUDE_TAG_OPTION
:
1594 add_exclusion_tag (arg
, exclusion_tag_contents
, NULL
);
1597 case EXCLUDE_TAG_UNDER_OPTION
:
1598 add_exclusion_tag (arg
, exclusion_tag_under
, NULL
);
1601 case EXCLUDE_TAG_ALL_OPTION
:
1602 add_exclusion_tag (arg
, exclusion_tag_all
, NULL
);
1605 case EXCLUDE_VCS_OPTION
:
1606 exclude_vcs_files ();
1609 case FORCE_LOCAL_OPTION
:
1610 force_local_option
= true;
1614 set_archive_format (arg
);
1617 case INDEX_FILE_OPTION
:
1618 index_file_name
= arg
;
1621 case IGNORE_CASE_OPTION
:
1622 args
->matching_flags
|= FNM_CASEFOLD
;
1625 case IGNORE_COMMAND_ERROR_OPTION
:
1626 ignore_command_error_option
= true;
1629 case IGNORE_FAILED_READ_OPTION
:
1630 ignore_failed_read_option
= true;
1633 case KEEP_NEWER_FILES_OPTION
:
1634 old_files_option
= KEEP_NEWER_FILES
;
1638 if (! (strlen (arg
) < GNAME_FIELD_SIZE
1639 && gname_to_gid (arg
, &group_option
)))
1642 if (xstrtoumax (arg
, 0, 10, &g
, "") == LONGINT_OK
1646 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1647 _("%s: Invalid group")));
1652 mode_option
= mode_compile (arg
);
1654 FATAL_ERROR ((0, 0, _("Invalid mode given on option")));
1655 initial_umask
= umask (0);
1656 umask (initial_umask
);
1659 case NO_ANCHORED_OPTION
:
1660 args
->include_anchored
= 0; /* Clear the default for comman line args */
1661 args
->matching_flags
&= ~ EXCLUDE_ANCHORED
;
1664 case NO_IGNORE_CASE_OPTION
:
1665 args
->matching_flags
&= ~ FNM_CASEFOLD
;
1668 case NO_IGNORE_COMMAND_ERROR_OPTION
:
1669 ignore_command_error_option
= false;
1672 case NO_OVERWRITE_DIR_OPTION
:
1673 old_files_option
= NO_OVERWRITE_DIR_OLD_FILES
;
1676 case NO_QUOTE_CHARS_OPTION
:
1678 set_char_quoting (NULL
, *arg
, 0);
1681 case NO_WILDCARDS_OPTION
:
1682 args
->wildcards
= disable_wildcards
;
1685 case NO_WILDCARDS_MATCH_SLASH_OPTION
:
1686 args
->matching_flags
|= FNM_FILE_NAME
;
1690 filename_terminator
= '\0';
1693 case NUMERIC_OWNER_OPTION
:
1694 numeric_owner_option
= true;
1697 case OCCURRENCE_OPTION
:
1699 occurrence_option
= 1;
1703 if (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
)
1704 occurrence_option
= u
;
1706 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1707 _("Invalid number")));
1711 case OVERWRITE_DIR_OPTION
:
1712 old_files_option
= DEFAULT_OLD_FILES
;
1715 case OVERWRITE_OPTION
:
1716 old_files_option
= OVERWRITE_OLD_FILES
;
1720 if (! (strlen (arg
) < UNAME_FIELD_SIZE
1721 && uname_to_uid (arg
, &owner_option
)))
1724 if (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1728 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1729 _("Invalid owner")));
1733 case QUOTE_CHARS_OPTION
:
1735 set_char_quoting (NULL
, *arg
, 1);
1738 case QUOTING_STYLE_OPTION
:
1739 tar_set_quoting_style (arg
);
1743 args
->pax_option
= true;
1744 xheader_set_option (arg
);
1748 set_archive_format ("posix");
1751 case PRESERVE_OPTION
:
1752 /* FIXME: What it is good for? */
1753 same_permissions_option
= true;
1754 same_order_option
= true;
1757 case RECORD_SIZE_OPTION
:
1760 if (! (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1761 && u
== (size_t) u
))
1762 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1763 _("Invalid record size")));
1765 if (record_size
% BLOCKSIZE
!= 0)
1766 USAGE_ERROR ((0, 0, _("Record size must be a multiple of %d."),
1768 blocking_factor
= record_size
/ BLOCKSIZE
;
1772 case RECURSIVE_UNLINK_OPTION
:
1773 recursive_unlink_option
= true;
1776 case REMOVE_FILES_OPTION
:
1777 remove_files_option
= true;
1780 case RESTRICT_OPTION
:
1781 restrict_option
= true;
1784 case RMT_COMMAND_OPTION
:
1788 case RSH_COMMAND_OPTION
:
1789 rsh_command_option
= arg
;
1792 case SHOW_DEFAULTS_OPTION
:
1793 show_default_settings (stdout
);
1797 case STRIP_COMPONENTS_OPTION
:
1800 if (! (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1801 && u
== (size_t) u
))
1802 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1803 _("Invalid number of elements")));
1804 strip_name_components
= u
;
1808 case SHOW_OMITTED_DIRS_OPTION
:
1809 show_omitted_dirs_option
= true;
1812 case SHOW_TRANSFORMED_NAMES_OPTION
:
1813 show_transformed_names_option
= true;
1817 backup_option
= true;
1818 args
->backup_suffix_string
= arg
;
1821 case TO_COMMAND_OPTION
:
1822 if (to_command_option
)
1823 USAGE_ERROR ((0, 0, _("Only one --to-command option allowed")));
1824 to_command_option
= arg
;
1829 set_stat_signal (arg
);
1831 totals_option
= true;
1834 case TRANSFORM_OPTION
:
1835 set_transform_expr (arg
);
1838 case USE_COMPRESS_PROGRAM_OPTION
:
1839 set_use_compress_program_option (arg
);
1842 case VOLNO_FILE_OPTION
:
1843 volno_file_option
= arg
;
1846 case WILDCARDS_OPTION
:
1847 args
->wildcards
= enable_wildcards
;
1850 case WILDCARDS_MATCH_SLASH_OPTION
:
1851 args
->matching_flags
&= ~ FNM_FILE_NAME
;
1854 case NO_RECURSION_OPTION
:
1855 recursion_option
= 0;
1858 case NO_SAME_OWNER_OPTION
:
1859 same_owner_option
= -1;
1862 case NO_SAME_PERMISSIONS_OPTION
:
1863 same_permissions_option
= -1;
1866 case RECURSION_OPTION
:
1867 recursion_option
= FNM_LEADING_DIR
;
1870 case SAME_OWNER_OPTION
:
1871 same_owner_option
= 1;
1874 case UNQUOTE_OPTION
:
1875 unquote_option
= true;
1878 case NO_UNQUOTE_OPTION
:
1879 unquote_option
= false;
1891 #ifdef DEVICE_PREFIX
1893 int device
= key
- '0';
1895 static char buf
[sizeof DEVICE_PREFIX
+ 10];
1899 argp_error (state
, _("Malformed density argument: %s"), quote (arg
));
1901 strcpy (buf
, DEVICE_PREFIX
);
1902 cursor
= buf
+ strlen (buf
);
1904 #ifdef DENSITY_LETTER
1906 sprintf (cursor
, "%d%c", device
, arg
[0]);
1908 #else /* not DENSITY_LETTER */
1913 device
+= LOW_DENSITY_NUM
;
1917 device
+= MID_DENSITY_NUM
;
1921 device
+= HIGH_DENSITY_NUM
;
1925 argp_error (state
, _("Unknown density: `%c'"), arg
[0]);
1927 sprintf (cursor
, "%d", device
);
1929 #endif /* not DENSITY_LETTER */
1931 if (archive_names
== allocated_archive_names
)
1932 archive_name_array
= x2nrealloc (archive_name_array
,
1933 &allocated_archive_names
,
1934 sizeof (archive_name_array
[0]));
1935 archive_name_array
[archive_names
++] = xstrdup (buf
);
1939 #else /* not DEVICE_PREFIX */
1942 _("Options `-[0-7][lmh]' not supported by *this* tar"));
1944 #endif /* not DEVICE_PREFIX */
1952 argp_state_help (state
, state
->out_stream
, ARGP_HELP_USAGE
);
1956 case VERSION_OPTION
:
1957 version_etc (state
->out_stream
, "tar", PACKAGE_NAME
, VERSION
,
1958 "John Gilmore", "Jay Fenlason", (char *) NULL
);
1963 _argp_hang
= atoi (arg
? arg
: "3600");
1964 while (_argp_hang
-- > 0)
1969 return ARGP_ERR_UNKNOWN
;
1974 static struct argp argp
= {
1987 argp_help (&argp
, stderr
, ARGP_HELP_SEE
, (char*) program_name
);
1992 /* Parse the options for tar. */
1994 static struct argp_option
*
1995 find_argp_option (struct argp_option
*o
, int letter
)
2002 && o
->doc
== NULL
); o
++)
2003 if (o
->key
== letter
)
2009 decode_options (int argc
, char **argv
)
2012 struct tar_args args
;
2014 /* Set some default option values. */
2015 args
.textual_date
= NULL
;
2016 args
.wildcards
= default_wildcards
;
2017 args
.matching_flags
= 0;
2018 args
.include_anchored
= EXCLUDE_ANCHORED
;
2019 args
.o_option
= false;
2020 args
.pax_option
= false;
2021 args
.backup_suffix_string
= getenv ("SIMPLE_BACKUP_SUFFIX");
2022 args
.version_control_string
= 0;
2023 args
.input_files
= false;
2024 args
.compress_autodetect
= false;
2026 subcommand_option
= UNKNOWN_SUBCOMMAND
;
2027 archive_format
= DEFAULT_FORMAT
;
2028 blocking_factor
= DEFAULT_BLOCKING
;
2029 record_size
= DEFAULT_BLOCKING
* BLOCKSIZE
;
2030 excluded
= new_exclude ();
2031 newer_mtime_option
.tv_sec
= TYPE_MINIMUM (time_t);
2032 newer_mtime_option
.tv_nsec
= -1;
2033 recursion_option
= FNM_LEADING_DIR
;
2034 unquote_option
= true;
2035 tar_sparse_major
= 1;
2036 tar_sparse_minor
= 0;
2041 /* Convert old-style tar call by exploding option element and rearranging
2042 options accordingly. */
2044 if (argc
> 1 && argv
[1][0] != '-')
2046 int new_argc
; /* argc value for rearranged arguments */
2047 char **new_argv
; /* argv value for rearranged arguments */
2048 char *const *in
; /* cursor into original argv */
2049 char **out
; /* cursor into rearranged argv */
2050 const char *letter
; /* cursor into old option letters */
2051 char buffer
[3]; /* constructed option buffer */
2053 /* Initialize a constructed option. */
2058 /* Allocate a new argument array, and copy program name in it. */
2060 new_argc
= argc
- 1 + strlen (argv
[1]);
2061 new_argv
= xmalloc ((new_argc
+ 1) * sizeof (char *));
2066 /* Copy each old letter option as a separate option, and have the
2067 corresponding argument moved next to it. */
2069 for (letter
= *in
++; *letter
; letter
++)
2071 struct argp_option
*opt
;
2073 buffer
[1] = *letter
;
2074 *out
++ = xstrdup (buffer
);
2075 opt
= find_argp_option (options
, *letter
);
2076 if (opt
&& opt
->arg
)
2078 if (in
< argv
+ argc
)
2081 USAGE_ERROR ((0, 0, _("Old option `%c' requires an argument."),
2086 /* Copy all remaining options. */
2088 while (in
< argv
+ argc
)
2092 /* Replace the old option list by the new one. */
2098 /* Parse all options and non-options as they appear. */
2100 prepend_default_options (getenv ("TAR_OPTIONS"), &argc
, &argv
);
2102 if (argp_parse (&argp
, argc
, argv
, ARGP_IN_ORDER
|ARGP_NO_HELP
,
2104 exit (TAREXIT_FAILURE
);
2107 /* Special handling for 'o' option:
2109 GNU tar used to say "output old format".
2110 UNIX98 tar says don't chown files after extracting (we use
2111 "--no-same-owner" for this).
2113 The old GNU tar semantics is retained when used with --create
2114 option, otherwise UNIX98 semantics is assumed */
2118 if (subcommand_option
== CREATE_SUBCOMMAND
)
2120 /* GNU Tar <= 1.13 compatibility */
2121 set_archive_format ("v7");
2125 /* UNIX98 compatibility */
2126 same_owner_option
= -1;
2130 /* Handle operands after any "--" argument. */
2131 for (; idx
< argc
; idx
++)
2133 name_add_name (argv
[idx
], MAKE_INCL_OPTIONS (&args
));
2134 args
.input_files
= true;
2137 /* Warn about implicit use of the wildcards in command line arguments.
2139 warn_regex_usage
= args
.wildcards
== default_wildcards
;
2141 /* Derive option values and check option consistency. */
2143 if (archive_format
== DEFAULT_FORMAT
)
2145 if (args
.pax_option
)
2146 archive_format
= POSIX_FORMAT
;
2148 archive_format
= DEFAULT_ARCHIVE_FORMAT
;
2151 if ((volume_label_option
&& subcommand_option
== CREATE_SUBCOMMAND
)
2152 || incremental_option
2153 || multi_volume_option
2155 assert_format (FORMAT_MASK (OLDGNU_FORMAT
)
2156 | FORMAT_MASK (GNU_FORMAT
)
2157 | FORMAT_MASK (POSIX_FORMAT
));
2159 if (occurrence_option
)
2161 if (!args
.input_files
)
2163 _("--occurrence is meaningless without a file list")));
2164 if (subcommand_option
!= DELETE_SUBCOMMAND
2165 && subcommand_option
!= DIFF_SUBCOMMAND
2166 && subcommand_option
!= EXTRACT_SUBCOMMAND
2167 && subcommand_option
!= LIST_SUBCOMMAND
)
2169 _("--occurrence cannot be used in the requested operation mode")));
2172 if (seekable_archive
&& subcommand_option
== DELETE_SUBCOMMAND
)
2174 /* The current code in delete.c is based on the assumption that
2175 skip_member() reads all data from the archive. So, we should
2176 make sure it won't use seeks. On the other hand, the same code
2177 depends on the ability to backspace a record in the archive,
2178 so setting seekable_archive to false is technically incorrect.
2179 However, it is tested only in skip_member(), so it's not a
2181 seekable_archive
= false;
2184 if (archive_names
== 0)
2186 /* If no archive file name given, try TAPE from the environment, or
2187 else, DEFAULT_ARCHIVE from the configuration process. */
2190 archive_name_array
[0] = getenv ("TAPE");
2191 if (! archive_name_array
[0])
2192 archive_name_array
[0] = DEFAULT_ARCHIVE
;
2195 /* Allow multiple archives only with `-M'. */
2197 if (archive_names
> 1 && !multi_volume_option
)
2199 _("Multiple archive files require `-M' option")));
2201 if (listed_incremental_option
2202 && NEWER_OPTION_INITIALIZED (newer_mtime_option
))
2204 _("Cannot combine --listed-incremental with --newer")));
2206 if (volume_label_option
)
2208 if (archive_format
== GNU_FORMAT
|| archive_format
== OLDGNU_FORMAT
)
2210 size_t volume_label_max_len
=
2211 (sizeof current_header
->header
.name
2212 - 1 /* for trailing '\0' */
2213 - (multi_volume_option
2214 ? (sizeof " Volume "
2215 - 1 /* for null at end of " Volume " */
2216 + INT_STRLEN_BOUND (int) /* for volume number */
2217 - 1 /* for sign, as 0 <= volno */)
2219 if (volume_label_max_len
< strlen (volume_label_option
))
2221 ngettext ("%s: Volume label is too long (limit is %lu byte)",
2222 "%s: Volume label is too long (limit is %lu bytes)",
2223 volume_label_max_len
),
2224 quotearg_colon (volume_label_option
),
2225 (unsigned long) volume_label_max_len
));
2228 Label length in PAX format is limited by the volume size. */
2233 if (multi_volume_option
)
2234 USAGE_ERROR ((0, 0, _("Cannot verify multi-volume archives")));
2235 if (use_compress_program_option
)
2236 USAGE_ERROR ((0, 0, _("Cannot verify compressed archives")));
2239 if (use_compress_program_option
)
2241 if (multi_volume_option
)
2242 USAGE_ERROR ((0, 0, _("Cannot use multi-volume compressed archives")));
2243 if (subcommand_option
== UPDATE_SUBCOMMAND
2244 || subcommand_option
== APPEND_SUBCOMMAND
2245 || subcommand_option
== DELETE_SUBCOMMAND
)
2246 USAGE_ERROR ((0, 0, _("Cannot update compressed archives")));
2247 if (subcommand_option
== CAT_SUBCOMMAND
)
2248 USAGE_ERROR ((0, 0, _("Cannot concatenate compressed archives")));
2251 /* It is no harm to use --pax-option on non-pax archives in archive
2252 reading mode. It may even be useful, since it allows to override
2253 file attributes from tar headers. Therefore I allow such usage.
2256 && archive_format
!= POSIX_FORMAT
2257 && (subcommand_option
!= EXTRACT_SUBCOMMAND
2258 || subcommand_option
!= DIFF_SUBCOMMAND
2259 || subcommand_option
!= LIST_SUBCOMMAND
))
2260 USAGE_ERROR ((0, 0, _("--pax-option can be used only on POSIX archives")));
2262 /* If ready to unlink hierarchies, so we are for simpler files. */
2263 if (recursive_unlink_option
)
2264 old_files_option
= UNLINK_FIRST_OLD_FILES
;
2267 if (test_label_option
)
2269 /* --test-label is silent if the user has specified the label name to
2271 if (!args
.input_files
)
2274 else if (utc_option
)
2277 /* Forbid using -c with no input files whatsoever. Check that `-f -',
2278 explicit or implied, is used correctly. */
2280 switch (subcommand_option
)
2282 case CREATE_SUBCOMMAND
:
2283 if (!args
.input_files
&& !files_from_option
)
2285 _("Cowardly refusing to create an empty archive")));
2286 if (args
.compress_autodetect
&& archive_names
2287 && strcmp (archive_name_array
[0], "-"))
2288 set_comression_program_by_suffix (archive_name_array
[0],
2289 use_compress_program_option
);
2292 case EXTRACT_SUBCOMMAND
:
2293 case LIST_SUBCOMMAND
:
2294 case DIFF_SUBCOMMAND
:
2295 for (archive_name_cursor
= archive_name_array
;
2296 archive_name_cursor
< archive_name_array
+ archive_names
;
2297 archive_name_cursor
++)
2298 if (!strcmp (*archive_name_cursor
, "-"))
2299 request_stdin ("-f");
2302 case CAT_SUBCOMMAND
:
2303 case UPDATE_SUBCOMMAND
:
2304 case APPEND_SUBCOMMAND
:
2305 for (archive_name_cursor
= archive_name_array
;
2306 archive_name_cursor
< archive_name_array
+ archive_names
;
2307 archive_name_cursor
++)
2308 if (!strcmp (*archive_name_cursor
, "-"))
2310 _("Options `-Aru' are incompatible with `-f -'")));
2316 /* Initialize stdlis */
2317 if (index_file_name
)
2319 stdlis
= fopen (index_file_name
, "w");
2321 open_error (index_file_name
);
2324 stdlis
= to_stdout_option
? stderr
: stdout
;
2326 archive_name_cursor
= archive_name_array
;
2328 /* Prepare for generating backup names. */
2330 if (args
.backup_suffix_string
)
2331 simple_backup_suffix
= xstrdup (args
.backup_suffix_string
);
2335 backup_type
= xget_version ("--backup", args
.version_control_string
);
2336 /* No backup is needed either if explicitely disabled or if
2337 the extracted files are not being written to disk. */
2338 if (backup_type
== no_backups
|| EXTRACT_OVER_PIPE
)
2339 backup_option
= false;
2343 report_textual_dates (&args
);
2349 /* Main routine for tar. */
2351 main (int argc
, char **argv
)
2354 program_name
= argv
[0];
2356 setlocale (LC_ALL
, "");
2357 bindtextdomain (PACKAGE
, LOCALEDIR
);
2358 textdomain (PACKAGE
);
2360 exit_failure
= TAREXIT_FAILURE
;
2361 exit_status
= TAREXIT_SUCCESS
;
2362 filename_terminator
= '\n';
2363 set_quoting_style (0, DEFAULT_QUOTING_STYLE
);
2365 /* Make sure we have first three descriptors available */
2368 /* Pre-allocate a few structures. */
2370 allocated_archive_names
= 10;
2371 archive_name_array
=
2372 xmalloc (sizeof (const char *) * allocated_archive_names
);
2375 obstack_init (&argv_stk
);
2378 /* System V fork+wait does not work if SIGCHLD is ignored. */
2379 signal (SIGCHLD
, SIG_DFL
);
2382 /* Decode options. */
2384 decode_options (argc
, argv
);
2388 /* Main command execution. */
2390 if (volno_file_option
)
2391 init_volume_number ();
2393 switch (subcommand_option
)
2395 case UNKNOWN_SUBCOMMAND
:
2397 _("You must specify one of the `-Acdtrux' options")));
2399 case CAT_SUBCOMMAND
:
2400 case UPDATE_SUBCOMMAND
:
2401 case APPEND_SUBCOMMAND
:
2405 case DELETE_SUBCOMMAND
:
2406 delete_archive_members ();
2409 case CREATE_SUBCOMMAND
:
2413 case EXTRACT_SUBCOMMAND
:
2415 read_and (extract_archive
);
2417 /* FIXME: should extract_finish () even if an ordinary signal is
2423 case LIST_SUBCOMMAND
:
2424 read_and (list_archive
);
2427 case DIFF_SUBCOMMAND
:
2429 read_and (diff_archive
);
2434 print_total_stats ();
2436 if (check_links_option
)
2439 if (volno_file_option
)
2440 closeout_volume_number ();
2442 /* Dispose of allocated memory, and return. */
2444 free (archive_name_array
);
2447 if (exit_status
== TAREXIT_FAILURE
)
2448 error (0, 0, _("Error exit delayed from previous errors"));
2450 if (stdlis
== stdout
)
2452 else if (ferror (stderr
) || fclose (stderr
) != 0)
2453 exit_status
= TAREXIT_FAILURE
;
2459 tar_stat_init (struct tar_stat_info
*st
)
2461 memset (st
, 0, sizeof (*st
));
2465 tar_stat_destroy (struct tar_stat_info
*st
)
2467 free (st
->orig_file_name
);
2468 free (st
->file_name
);
2469 free (st
->link_name
);
2472 free (st
->sparse_map
);
2474 xheader_destroy (&st
->xhdr
);
2475 memset (st
, 0, sizeof (*st
));
2478 /* Format mask for all available formats that support nanosecond
2479 timestamp resolution. */
2480 #define NS_PRECISION_FORMAT_MASK FORMAT_MASK (POSIX_FORMAT)
2482 /* Same as timespec_cmp, but ignore nanoseconds if current archive
2483 format does not provide sufficient resolution. */
2485 tar_timespec_cmp (struct timespec a
, struct timespec b
)
2487 if (!(FORMAT_MASK (current_format
) & NS_PRECISION_FORMAT_MASK
))
2488 a
.tv_nsec
= b
.tv_nsec
= 0;
2489 return timespec_cmp (a
, b
);