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. */
27 #include <argp-namefrob.h>
28 #include <argp-fmtstream.h>
31 #if ! defined SIGCHLD && defined SIGCLD
32 # define SIGCHLD SIGCLD
35 /* The following causes "common.h" to produce definitions of all the global
36 variables, rather than just "extern" declarations of them. GNU tar does
37 depend on the system loader to preset all GLOBAL variables to neutral (or
38 zero) values; explicit initialization is usually not done. */
44 #include <configmake.h>
48 #include <rmt-command.h>
51 #include <version-etc.h>
55 /* Local declarations. */
57 #ifndef DEFAULT_ARCHIVE_FORMAT
58 # define DEFAULT_ARCHIVE_FORMAT GNU_FORMAT
61 #ifndef DEFAULT_ARCHIVE
62 # define DEFAULT_ARCHIVE "tar.out"
65 #ifndef DEFAULT_BLOCKING
66 # define DEFAULT_BLOCKING 20
72 /* Name of option using stdin. */
73 static const char *stdin_used_by
;
75 /* Doesn't return if stdin already requested. */
77 request_stdin (const char *option
)
80 USAGE_ERROR ((0, 0, _("Options `-%s' and `-%s' both want standard input"),
81 stdin_used_by
, option
));
83 stdin_used_by
= option
;
86 extern int rpmatch (char const *response
);
88 /* Returns true if and only if the user typed an affirmative response. */
90 confirm (const char *message_action
, const char *message_name
)
92 static FILE *confirm_file
;
93 static int confirm_file_EOF
;
98 if (archive
== 0 || stdin_used_by
)
100 confirm_file
= fopen (TTY_NAME
, "r");
102 open_fatal (TTY_NAME
);
106 request_stdin ("-w");
107 confirm_file
= stdin
;
111 fprintf (stdlis
, "%s %s?", message_action
, quote (message_name
));
114 if (!confirm_file_EOF
)
116 char *response
= NULL
;
117 size_t response_size
= 0;
118 if (getline (&response
, &response_size
, confirm_file
) < 0)
119 confirm_file_EOF
= 1;
121 status
= rpmatch (response
) > 0;
125 if (confirm_file_EOF
)
127 fputc ('\n', stdlis
);
134 static struct fmttab
{
136 enum archive_format fmt
;
139 { "oldgnu", OLDGNU_FORMAT
},
140 { "ustar", USTAR_FORMAT
},
141 { "posix", POSIX_FORMAT
},
142 #if 0 /* not fully supported yet */
143 { "star", STAR_FORMAT
},
145 { "gnu", GNU_FORMAT
},
146 { "pax", POSIX_FORMAT
}, /* An alias for posix */
151 set_archive_format (char const *name
)
153 struct fmttab
const *p
;
155 for (p
= fmttab
; strcmp (p
->name
, name
) != 0; )
157 USAGE_ERROR ((0, 0, _("%s: Invalid archive format"),
158 quotearg_colon (name
)));
160 archive_format
= p
->fmt
;
164 archive_format_string (enum archive_format fmt
)
166 struct fmttab
const *p
;
168 for (p
= fmttab
; p
->name
; p
++)
174 #define FORMAT_MASK(n) (1<<(n))
177 assert_format(unsigned fmt_mask
)
179 if ((FORMAT_MASK (archive_format
) & fmt_mask
) == 0)
181 _("GNU features wanted on incompatible archive format")));
185 subcommand_string (enum subcommand c
)
189 case UNKNOWN_SUBCOMMAND
:
192 case APPEND_SUBCOMMAND
:
198 case CREATE_SUBCOMMAND
:
201 case DELETE_SUBCOMMAND
:
204 case DIFF_SUBCOMMAND
:
207 case EXTRACT_SUBCOMMAND
:
210 case LIST_SUBCOMMAND
:
213 case UPDATE_SUBCOMMAND
:
222 tar_list_quoting_styles (argp_fmtstream_t fs
, char *prefix
)
226 for (i
= 0; quoting_style_args
[i
]; i
++)
227 argp_fmtstream_printf (fs
, "%s%s\n", prefix
, quoting_style_args
[i
]);
231 tar_set_quoting_style (char *arg
)
235 for (i
= 0; quoting_style_args
[i
]; i
++)
236 if (strcmp (arg
, quoting_style_args
[i
]) == 0)
238 set_quoting_style (NULL
, i
);
242 _("Unknown quoting style `%s'. Try `%s --quoting-style=help' to get a list."), arg
, program_invocation_short_name
));
250 ANCHORED_OPTION
= CHAR_MAX
+ 1,
251 ATIME_PRESERVE_OPTION
,
254 DELAY_DIRECTORY_RESTORE_OPTION
,
256 EXCLUDE_CACHES_OPTION
,
257 EXCLUDE_CACHES_UNDER_OPTION
,
258 EXCLUDE_CACHES_ALL_OPTION
,
261 EXCLUDE_TAG_UNDER_OPTION
,
262 EXCLUDE_TAG_ALL_OPTION
,
267 IGNORE_COMMAND_ERROR_OPTION
,
268 IGNORE_FAILED_READ_OPTION
,
270 KEEP_NEWER_FILES_OPTION
,
275 NO_DELAY_DIRECTORY_RESTORE_OPTION
,
276 NO_IGNORE_CASE_OPTION
,
277 NO_IGNORE_COMMAND_ERROR_OPTION
,
278 NO_OVERWRITE_DIR_OPTION
,
279 NO_QUOTE_CHARS_OPTION
,
281 NO_SAME_OWNER_OPTION
,
282 NO_SAME_PERMISSIONS_OPTION
,
284 NO_WILDCARDS_MATCH_SLASH_OPTION
,
287 NUMERIC_OWNER_OPTION
,
290 ONE_FILE_SYSTEM_OPTION
,
291 OVERWRITE_DIR_OPTION
,
298 QUOTING_STYLE_OPTION
,
301 RECURSIVE_UNLINK_OPTION
,
307 SHOW_DEFAULTS_OPTION
,
308 SHOW_OMITTED_DIRS_OPTION
,
309 SHOW_TRANSFORMED_NAMES_OPTION
,
310 SPARSE_VERSION_OPTION
,
311 STRIP_COMPONENTS_OPTION
,
319 USE_COMPRESS_PROGRAM_OPTION
,
323 WILDCARDS_MATCH_SLASH_OPTION
,
327 const char *argp_program_version
= "tar (" PACKAGE_NAME
") " VERSION
;
328 const char *argp_program_bug_address
= "<" PACKAGE_BUGREPORT
">";
329 static char const doc
[] = N_("\
330 GNU `tar' saves many files together into a single tape or disk archive, \
331 and can restore individual files from the archive.\n\
334 tar -cf archive.tar foo bar # Create archive.tar from files foo and bar.\n\
335 tar -tvf archive.tar # List all files in archive.tar verbosely.\n\
336 tar -xf archive.tar # Extract all files from archive.tar.\n")
338 N_("The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
339 The version control may be set with --backup or VERSION_CONTROL, values are:\n\n\
340 none, off never make backups\n\
341 t, numbered make numbered backups\n\
342 nil, existing numbered if numbered backups exist, simple otherwise\n\
343 never, simple always make simple backups\n");
348 Available option letters are DEIJQY and aeqy. Consider the following
351 [For Solaris tar compatibility =/= Is it important at all?]
352 e exit immediately with a nonzero exit status if unexpected errors occur
353 E use extended headers (--format=posix)
355 [q alias for --occurrence=1 =/= this would better be used for quiet?]
356 [I same as T =/= will harm star compatibility]
358 y per-file gzip compression
359 Y per-block gzip compression */
361 static struct argp_option options
[] = {
364 N_("Main operation mode:"), GRID
},
367 N_("list the contents of an archive"), GRID
+1 },
368 {"extract", 'x', 0, 0,
369 N_("extract files from an archive"), GRID
+1 },
370 {"get", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
371 {"create", 'c', 0, 0,
372 N_("create a new archive"), GRID
+1 },
374 N_("find differences between archive and file system"), GRID
+1 },
375 {"compare", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
376 {"append", 'r', 0, 0,
377 N_("append files to the end of an archive"), GRID
+1 },
378 {"update", 'u', 0, 0,
379 N_("only append files newer than copy in archive"), GRID
+1 },
380 {"catenate", 'A', 0, 0,
381 N_("append tar files to an archive"), GRID
+1 },
382 {"concatenate", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
383 {"delete", DELETE_OPTION
, 0, 0,
384 N_("delete from the archive (not on mag tapes!)"), GRID
+1 },
385 {"test-label", TEST_LABEL_OPTION
, NULL
, 0,
386 N_("test the archive volume label and exit"), GRID
+1 },
391 N_("Operation modifiers:"), GRID
},
393 {"sparse", 'S', 0, 0,
394 N_("handle sparse files efficiently"), GRID
+1 },
395 {"sparse-version", SPARSE_VERSION_OPTION
, N_("MAJOR[.MINOR]"), 0,
396 N_("set version of the sparse format to use (implies --sparse)"), GRID
+1},
397 {"incremental", 'G', 0, 0,
398 N_("handle old GNU-format incremental backup"), GRID
+1 },
399 {"listed-incremental", 'g', N_("FILE"), 0,
400 N_("handle new GNU-format incremental backup"), GRID
+1 },
401 {"ignore-failed-read", IGNORE_FAILED_READ_OPTION
, 0, 0,
402 N_("do not exit with nonzero on unreadable files"), GRID
+1 },
403 {"occurrence", OCCURRENCE_OPTION
, N_("NUMBER"), OPTION_ARG_OPTIONAL
,
404 N_("process only the NUMBERth occurrence of each file in the archive;"
405 " this option is valid only in conjunction with one of the subcommands"
406 " --delete, --diff, --extract or --list and when a list of files"
407 " is given either on the command line or via the -T option;"
408 " NUMBER defaults to 1"), GRID
+1 },
409 {"seek", 'n', NULL
, 0,
410 N_("archive is seekable"), GRID
+1 },
415 N_("Overwrite control:"), GRID
},
417 {"verify", 'W', 0, 0,
418 N_("attempt to verify the archive after writing it"), GRID
+1 },
419 {"remove-files", REMOVE_FILES_OPTION
, 0, 0,
420 N_("remove files after adding them to the archive"), GRID
+1 },
421 {"keep-old-files", 'k', 0, 0,
422 N_("don't replace existing files when extracting"), GRID
+1 },
423 {"keep-newer-files", KEEP_NEWER_FILES_OPTION
, 0, 0,
424 N_("don't replace existing files that are newer than their archive copies"), GRID
+1 },
425 {"overwrite", OVERWRITE_OPTION
, 0, 0,
426 N_("overwrite existing files when extracting"), GRID
+1 },
427 {"unlink-first", 'U', 0, 0,
428 N_("remove each file prior to extracting over it"), GRID
+1 },
429 {"recursive-unlink", RECURSIVE_UNLINK_OPTION
, 0, 0,
430 N_("empty hierarchies prior to extracting directory"), GRID
+1 },
431 {"no-overwrite-dir", NO_OVERWRITE_DIR_OPTION
, 0, 0,
432 N_("preserve metadata of existing directories"), GRID
+1 },
433 {"overwrite-dir", OVERWRITE_DIR_OPTION
, 0, 0,
434 N_("overwrite metadata of existing directories when extracting (default)"),
440 N_("Select output stream:"), GRID
},
442 {"to-stdout", 'O', 0, 0,
443 N_("extract files to standard output"), GRID
+1 },
444 {"to-command", TO_COMMAND_OPTION
, N_("COMMAND"), 0,
445 N_("pipe extracted files to another program"), GRID
+1 },
446 {"ignore-command-error", IGNORE_COMMAND_ERROR_OPTION
, 0, 0,
447 N_("ignore exit codes of children"), GRID
+1 },
448 {"no-ignore-command-error", NO_IGNORE_COMMAND_ERROR_OPTION
, 0, 0,
449 N_("treat non-zero exit codes of children as error"), GRID
+1 },
454 N_("Handling of file attributes:"), GRID
},
456 {"owner", OWNER_OPTION
, N_("NAME"), 0,
457 N_("force NAME as owner for added files"), GRID
+1 },
458 {"group", GROUP_OPTION
, N_("NAME"), 0,
459 N_("force NAME as group for added files"), GRID
+1 },
460 {"mtime", MTIME_OPTION
, N_("DATE-OR-FILE"), 0,
461 N_("set mtime for added files from DATE-OR-FILE"), GRID
+1 },
462 {"mode", MODE_OPTION
, N_("CHANGES"), 0,
463 N_("force (symbolic) mode CHANGES for added files"), GRID
+1 },
464 {"atime-preserve", ATIME_PRESERVE_OPTION
,
465 N_("METHOD"), OPTION_ARG_OPTIONAL
,
466 N_("preserve access times on dumped files, either by restoring the times"
467 " after reading (METHOD='replace'; default) or by not setting the times"
468 " in the first place (METHOD='system')"), GRID
+1 },
470 N_("don't extract file modified time"), GRID
+1 },
471 {"same-owner", SAME_OWNER_OPTION
, 0, 0,
472 N_("try extracting files with the same ownership"), GRID
+1 },
473 {"no-same-owner", NO_SAME_OWNER_OPTION
, 0, 0,
474 N_("extract files as yourself"), GRID
+1 },
475 {"numeric-owner", NUMERIC_OWNER_OPTION
, 0, 0,
476 N_("always use numbers for user/group names"), GRID
+1 },
477 {"preserve-permissions", 'p', 0, 0,
478 N_("extract information about file permissions (default for superuser)"),
480 {"same-permissions", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
481 {"no-same-permissions", NO_SAME_PERMISSIONS_OPTION
, 0, 0,
482 N_("apply the user's umask when extracting permissions from the archive (default for ordinary users)"), GRID
+1 },
483 {"preserve-order", 's', 0, 0,
484 N_("sort names to extract to match archive"), GRID
+1 },
485 {"same-order", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
486 {"preserve", PRESERVE_OPTION
, 0, 0,
487 N_("same as both -p and -s"), GRID
+1 },
488 {"delay-directory-restore", DELAY_DIRECTORY_RESTORE_OPTION
, 0, 0,
489 N_("delay setting modification times and permissions of extracted"
490 " directories until the end of extraction"), GRID
+1 },
491 {"no-delay-directory-restore", NO_DELAY_DIRECTORY_RESTORE_OPTION
, 0, 0,
492 N_("cancel the effect of --delay-directory-restore option"), GRID
+1 },
497 N_("Device selection and switching:"), GRID
},
499 {"file", 'f', N_("ARCHIVE"), 0,
500 N_("use archive file or device ARCHIVE"), GRID
+1 },
501 {"force-local", FORCE_LOCAL_OPTION
, 0, 0,
502 N_("archive file is local even if it has a colon"), GRID
+1 },
503 {"rmt-command", RMT_COMMAND_OPTION
, N_("COMMAND"), 0,
504 N_("use given rmt COMMAND instead of rmt"), GRID
+1 },
505 {"rsh-command", RSH_COMMAND_OPTION
, N_("COMMAND"), 0,
506 N_("use remote COMMAND instead of rsh"), GRID
+1 },
508 {"-[0-7][lmh]", 0, NULL
, OPTION_DOC
, /* It is OK, since `name' will never be
510 N_("specify drive and density"), GRID
+1 },
512 {NULL
, '0', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
513 {NULL
, '1', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
514 {NULL
, '2', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
515 {NULL
, '3', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
516 {NULL
, '4', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
517 {NULL
, '5', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
518 {NULL
, '6', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
519 {NULL
, '7', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
520 {NULL
, '8', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
521 {NULL
, '9', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
523 {"multi-volume", 'M', 0, 0,
524 N_("create/list/extract multi-volume archive"), GRID
+1 },
525 {"tape-length", 'L', N_("NUMBER"), 0,
526 N_("change tape after writing NUMBER x 1024 bytes"), GRID
+1 },
527 {"info-script", 'F', N_("NAME"), 0,
528 N_("run script at end of each tape (implies -M)"), GRID
+1 },
529 {"new-volume-script", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
530 {"volno-file", VOLNO_FILE_OPTION
, N_("FILE"), 0,
531 N_("use/update the volume number in FILE"), GRID
+1 },
536 N_("Device blocking:"), GRID
},
538 {"blocking-factor", 'b', N_("BLOCKS"), 0,
539 N_("BLOCKS x 512 bytes per record"), GRID
+1 },
540 {"record-size", RECORD_SIZE_OPTION
, N_("NUMBER"), 0,
541 N_("NUMBER of bytes per record, multiple of 512"), GRID
+1 },
542 {"ignore-zeros", 'i', 0, 0,
543 N_("ignore zeroed blocks in archive (means EOF)"), GRID
+1 },
544 {"read-full-records", 'B', 0, 0,
545 N_("reblock as we read (for 4.2BSD pipes)"), GRID
+1 },
550 N_("Archive format selection:"), GRID
},
552 {"format", 'H', N_("FORMAT"), 0,
553 N_("create archive of the given format"), GRID
+1 },
555 {NULL
, 0, NULL
, 0, N_("FORMAT is one of the following:"), GRID
+2 },
556 {" v7", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
, N_("old V7 tar format"),
558 {" oldgnu", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
559 N_("GNU format as per tar <= 1.12"), GRID
+3 },
560 {" gnu", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
561 N_("GNU tar 1.13.x format"), GRID
+3 },
562 {" ustar", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
563 N_("POSIX 1003.1-1988 (ustar) format"), GRID
+3 },
564 {" pax", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
565 N_("POSIX 1003.1-2001 (pax) format"), GRID
+3 },
566 {" posix", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
, N_("same as pax"), GRID
+3 },
568 {"old-archive", OLD_ARCHIVE_OPTION
, 0, 0, /* FIXME */
569 N_("same as --format=v7"), GRID
+8 },
570 {"portability", 0, 0, OPTION_ALIAS
, NULL
, GRID
+8 },
571 {"posix", POSIX_OPTION
, 0, 0,
572 N_("same as --format=posix"), GRID
+8 },
573 {"pax-option", PAX_OPTION
, N_("keyword[[:]=value][,keyword[[:]=value]]..."), 0,
574 N_("control pax keywords"), GRID
+8 },
575 {"label", 'V', N_("TEXT"), 0,
576 N_("create archive with volume name TEXT; at list/extract time, use TEXT as a globbing pattern for volume name"), GRID
+8 },
578 N_("filter the archive through bzip2"), GRID
+8 },
580 N_("filter the archive through gzip"), GRID
+8 },
581 {"gunzip", 0, 0, OPTION_ALIAS
, NULL
, GRID
+8 },
582 {"ungzip", 0, 0, OPTION_ALIAS
, NULL
, GRID
+8 },
583 {"compress", 'Z', 0, 0,
584 N_("filter the archive through compress"), GRID
+8 },
585 {"uncompress", 0, 0, OPTION_ALIAS
, NULL
, GRID
+8 },
586 {"use-compress-program", USE_COMPRESS_PROGRAM_OPTION
, N_("PROG"), 0,
587 N_("filter through PROG (must accept -d)"), GRID
+8 },
592 N_("Local file selection:"), GRID
},
594 {"add-file", ARGP_KEY_ARG
, N_("FILE"), 0,
595 N_("add given FILE to the archive (useful if its name starts with a dash)"), GRID
+1 },
596 {"directory", 'C', N_("DIR"), 0,
597 N_("change to directory DIR"), GRID
+1 },
598 {"files-from", 'T', N_("FILE"), 0,
599 N_("get names to extract or create from FILE"), GRID
+1 },
600 {"null", NULL_OPTION
, 0, 0,
601 N_("-T reads null-terminated names, disable -C"), GRID
+1 },
602 {"unquote", UNQUOTE_OPTION
, 0, 0,
603 N_("unquote filenames read with -T (default)"), GRID
+1 },
604 {"no-unquote", NO_UNQUOTE_OPTION
, 0, 0,
605 N_("do not unquote filenames read with -T"), GRID
+1 },
606 {"exclude", EXCLUDE_OPTION
, N_("PATTERN"), 0,
607 N_("exclude files, given as a PATTERN"), GRID
+1 },
608 {"exclude-from", 'X', N_("FILE"), 0,
609 N_("exclude patterns listed in FILE"), GRID
+1 },
610 {"exclude-caches", EXCLUDE_CACHES_OPTION
, 0, 0,
611 N_("exclude contents of directories containing CACHEDIR.TAG, "
612 "except for the tag file itself"), GRID
+1 },
613 {"exclude-caches-under", EXCLUDE_CACHES_UNDER_OPTION
, 0, 0,
614 N_("exclude everything under directories containing CACHEDIR.TAG"),
616 {"exclude-caches-all", EXCLUDE_CACHES_ALL_OPTION
, 0, 0,
617 N_("exclude directories containing CACHEDIR.TAG"), GRID
+1 },
618 {"exclude-tag", EXCLUDE_TAG_OPTION
, N_("FILE"), 0,
619 N_("exclude contents of directories containing FILE, except"
620 " for FILE itself"), GRID
+1 },
621 {"exclude-tag-under", EXCLUDE_TAG_UNDER_OPTION
, N_("FILE"), 0,
622 N_("exclude everything under directories containing FILE"), GRID
+1 },
623 {"exclude-tag-all", EXCLUDE_TAG_ALL_OPTION
, N_("FILE"), 0,
624 N_("exclude directories containing FILE"), GRID
+1 },
625 {"no-recursion", NO_RECURSION_OPTION
, 0, 0,
626 N_("avoid descending automatically in directories"), GRID
+1 },
627 {"one-file-system", ONE_FILE_SYSTEM_OPTION
, 0, 0,
628 N_("stay in local file system when creating archive"), GRID
+1 },
629 {"recursion", RECURSION_OPTION
, 0, 0,
630 N_("recurse into directories (default)"), GRID
+1 },
631 {"absolute-names", 'P', 0, 0,
632 N_("don't strip leading `/'s from file names"), GRID
+1 },
633 {"dereference", 'h', 0, 0,
634 N_("follow symlinks; archive and dump the files they point to"), GRID
+1 },
635 {"starting-file", 'K', N_("MEMBER-NAME"), 0,
636 N_("begin at member MEMBER-NAME in the archive"), GRID
+1 },
637 {"newer", 'N', N_("DATE-OR-FILE"), 0,
638 N_("only store files newer than DATE-OR-FILE"), GRID
+1 },
639 {"after-date", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
640 {"newer-mtime", NEWER_MTIME_OPTION
, N_("DATE"), 0,
641 N_("compare date and time when data changed only"), GRID
+1 },
642 {"backup", BACKUP_OPTION
, N_("CONTROL"), OPTION_ARG_OPTIONAL
,
643 N_("backup before removal, choose version CONTROL"), GRID
+1 },
644 {"suffix", SUFFIX_OPTION
, N_("STRING"), 0,
645 N_("backup before removal, override usual suffix ('~' unless overridden by environment variable SIMPLE_BACKUP_SUFFIX)"), GRID
+1 },
650 N_("File name transformations:"), GRID
},
651 {"strip-components", STRIP_COMPONENTS_OPTION
, N_("NUMBER"), 0,
652 N_("strip NUMBER leading components from file names on extraction"),
654 {"transform", TRANSFORM_OPTION
, N_("EXPRESSION"), 0,
655 N_("use sed replace EXPRESSION to transform file names"), GRID
+1 },
660 N_("File name matching options (affect both exclude and include patterns):"),
662 {"ignore-case", IGNORE_CASE_OPTION
, 0, 0,
663 N_("ignore case"), GRID
+1 },
664 {"anchored", ANCHORED_OPTION
, 0, 0,
665 N_("patterns match file name start"), GRID
+1 },
666 {"no-anchored", NO_ANCHORED_OPTION
, 0, 0,
667 N_("patterns match after any `/' (default for exclusion)"), GRID
+1 },
668 {"no-ignore-case", NO_IGNORE_CASE_OPTION
, 0, 0,
669 N_("case sensitive matching (default)"), GRID
+1 },
670 {"wildcards", WILDCARDS_OPTION
, 0, 0,
671 N_("use wildcards (default for exclusion)"), GRID
+1 },
672 {"no-wildcards", NO_WILDCARDS_OPTION
, 0, 0,
673 N_("verbatim string matching"), GRID
+1 },
674 {"no-wildcards-match-slash", NO_WILDCARDS_MATCH_SLASH_OPTION
, 0, 0,
675 N_("wildcards do not match `/'"), GRID
+1 },
676 {"wildcards-match-slash", WILDCARDS_MATCH_SLASH_OPTION
, 0, 0,
677 N_("wildcards match `/' (default for exclusion)"), GRID
+1 },
682 N_("Informative output:"), GRID
},
684 {"verbose", 'v', 0, 0,
685 N_("verbosely list files processed"), GRID
+1 },
686 {"checkpoint", CHECKPOINT_OPTION
, N_("[.]NUMBER"), OPTION_ARG_OPTIONAL
,
687 N_("display progress messages every NUMBERth record (default 10)"),
689 {"check-links", 'l', 0, 0,
690 N_("print a message if not all links are dumped"), GRID
+1 },
691 {"totals", TOTALS_OPTION
, N_("SIGNAL"), OPTION_ARG_OPTIONAL
,
692 N_("print total bytes after processing the archive; "
693 "with an argument - print total bytes when this SIGNAL is delivered; "
694 "Allowed signals are: SIGHUP, SIGQUIT, SIGINT, SIGUSR1 and SIGUSR2; "
695 "the names without SIG prefix are also accepted"), GRID
+1 },
696 {"utc", UTC_OPTION
, 0, 0,
697 N_("print file modification dates in UTC"), GRID
+1 },
698 {"index-file", INDEX_FILE_OPTION
, N_("FILE"), 0,
699 N_("send verbose output to FILE"), GRID
+1 },
700 {"block-number", 'R', 0, 0,
701 N_("show block number within archive with each message"), GRID
+1 },
702 {"interactive", 'w', 0, 0,
703 N_("ask for confirmation for every action"), GRID
+1 },
704 {"confirmation", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
705 {"show-defaults", SHOW_DEFAULTS_OPTION
, 0, 0,
706 N_("show tar defaults"), GRID
+1 },
707 {"show-omitted-dirs", SHOW_OMITTED_DIRS_OPTION
, 0, 0,
708 N_("when listing or extracting, list each directory that does not match search criteria"), GRID
+1 },
709 {"show-transformed-names", SHOW_TRANSFORMED_NAMES_OPTION
, 0, 0,
710 N_("show file or archive names after transformation"),
712 {"show-stored-names", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
713 {"quoting-style", QUOTING_STYLE_OPTION
, N_("STYLE"), 0,
714 N_("set name quoting style; see below for valid STYLE values"), GRID
+1 },
715 {"quote-chars", QUOTE_CHARS_OPTION
, N_("STRING"), 0,
716 N_("additionally quote characters from STRING"), GRID
+1 },
717 {"no-quote-chars", NO_QUOTE_CHARS_OPTION
, N_("STRING"), 0,
718 N_("disable quoting for characters from STRING"), GRID
+1 },
723 N_("Compatibility options:"), GRID
},
726 N_("when creating, same as --old-archive; when extracting, same as --no-same-owner"), GRID
+1 },
731 N_("Other options:"), GRID
},
733 {"restrict", RESTRICT_OPTION
, 0, 0,
734 N_("disable use of some potentially harmful options"), -1 },
736 {"help", '?', 0, 0, N_("give this help list"), -1},
737 {"usage", USAGE_OPTION
, 0, 0, N_("give a short usage message"), -1},
738 {"version", VERSION_OPTION
, 0, 0, N_("print program version"), -1},
739 /* FIXME -V (--label) conflicts with the default short option for
741 {"HANG", HANG_OPTION
, "SECS", OPTION_ARG_OPTIONAL
| OPTION_HIDDEN
,
742 N_("hang for SECS seconds (default 3600)"), 0},
748 static char const *const atime_preserve_args
[] =
750 "replace", "system", NULL
753 static enum atime_preserve
const atime_preserve_types
[] =
755 replace_atime_preserve
, system_atime_preserve
758 /* Make sure atime_preserve_types has as much entries as atime_preserve_args
759 (minus 1 for NULL guard) */
760 ARGMATCH_VERIFY (atime_preserve_args
, atime_preserve_types
);
762 /* Wildcard matching settings */
765 default_wildcards
, /* For exclusion == enable_wildcards,
766 for inclusion == disable_wildcards */
771 struct tar_args
/* Variables used during option parsing */
773 struct textual_date
*textual_date
; /* Keeps the arguments to --newer-mtime
774 and/or --date option if they are
776 enum wildcards wildcards
; /* Wildcard settings (--wildcards/
778 int matching_flags
; /* exclude_fnmatch options */
779 int include_anchored
; /* Pattern anchoring options used for
781 bool o_option
; /* True if -o option was given */
782 bool pax_option
; /* True if --pax-option was given */
783 char const *backup_suffix_string
; /* --suffix option argument */
784 char const *version_control_string
; /* --backup option argument */
785 bool input_files
; /* True if some input files where given */
788 #define MAKE_EXCL_OPTIONS(args) \
789 ((((args)->wildcards != disable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
790 | (args)->matching_flags \
793 #define MAKE_INCL_OPTIONS(args) \
794 ((((args)->wildcards == enable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
795 | (args)->include_anchored \
796 | (args)->matching_flags \
800 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
803 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
804 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
805 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
806 quoting_style_args[DEFAULT_QUOTING_STYLE], \
807 DEFAULT_RMT_COMMAND); \
808 printer (stream, " --rsh-command=%s", REMOTE_SHELL); \
809 printer (stream, "\n"); \
812 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
815 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
816 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
817 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
818 quoting_style_args[DEFAULT_QUOTING_STYLE], \
819 DEFAULT_RMT_COMMAND); \
820 printer (stream, "\n"); \
825 show_default_settings (FILE *fp
)
826 DECL_SHOW_DEFAULT_SETTINGS(fp
, fprintf
)
829 show_default_settings_fs (argp_fmtstream_t fs
)
830 DECL_SHOW_DEFAULT_SETTINGS(fs
, argp_fmtstream_printf
)
833 set_subcommand_option (enum subcommand subcommand
)
835 if (subcommand_option
!= UNKNOWN_SUBCOMMAND
836 && subcommand_option
!= subcommand
)
838 _("You may not specify more than one `-Acdtrux' option")));
840 subcommand_option
= subcommand
;
844 set_use_compress_program_option (const char *string
)
846 if (use_compress_program_option
847 && strcmp (use_compress_program_option
, string
) != 0)
848 USAGE_ERROR ((0, 0, _("Conflicting compression options")));
850 use_compress_program_option
= string
;
857 print_total_stats ();
858 #ifndef HAVE_SIGACTION
859 signal (signo
, sigstat
);
864 stat_on_signal (int signo
)
866 #ifdef HAVE_SIGACTION
867 struct sigaction act
;
868 act
.sa_handler
= sigstat
;
869 sigemptyset (&act
.sa_mask
);
871 sigaction (signo
, &act
, NULL
);
873 signal (signo
, sigstat
);
878 set_stat_signal (const char *name
)
885 { "SIGUSR1", SIGUSR1
},
887 { "SIGUSR2", SIGUSR2
},
889 { "SIGHUP", SIGHUP
},
891 { "SIGINT", SIGINT
},
893 { "SIGQUIT", SIGQUIT
},
898 for (p
= sigtab
; p
< sigtab
+ sizeof (sigtab
) / sizeof (sigtab
[0]); p
++)
899 if (strcmp (p
->name
, name
) == 0)
901 stat_on_signal (p
->signo
);
904 FATAL_ERROR ((0, 0, _("Unknown signal name: %s"), name
));
910 struct textual_date
*next
;
917 get_date_or_file (struct tar_args
*args
, const char *option
,
918 const char *str
, struct timespec
*ts
)
920 if (FILE_SYSTEM_PREFIX_LEN (str
) != 0
925 if (deref_stat (dereference_option
, str
, &st
) != 0)
928 USAGE_ERROR ((0, 0, _("Date sample file not found")));
930 *ts
= get_stat_mtime (&st
);
934 if (! get_date (ts
, str
, NULL
))
936 WARN ((0, 0, _("Substituting %s for unknown date format %s"),
937 tartime (*ts
, false), quote (str
)));
942 struct textual_date
*p
= xmalloc (sizeof (*p
));
946 p
->next
= args
->textual_date
;
947 args
->textual_date
= p
;
953 report_textual_dates (struct tar_args
*args
)
955 struct textual_date
*p
;
956 for (p
= args
->textual_date
; p
; )
958 struct textual_date
*next
= p
->next
;
959 char const *treated_as
= tartime (*p
->ts
, true);
960 if (strcmp (p
->date
, treated_as
) != 0)
961 WARN ((0, 0, _("Option %s: Treating date `%s' as %s"),
962 p
->option
, p
->date
, treated_as
));
969 static volatile int _argp_hang
;
971 enum read_file_list_state
/* Result of reading file name from the list file */
973 file_list_success
, /* OK, name read successfully */
974 file_list_end
, /* End of list file */
975 file_list_zero
, /* Zero separator encountered where it should not */
976 file_list_skip
/* Empty (zero-length) entry encountered, skip it */
979 /* Read from FP a sequence of characters up to FILENAME_TERMINATOR and put them
982 static enum read_file_list_state
983 read_name_from_file (FILE *fp
, struct obstack
*stk
)
988 for (c
= getc (fp
); c
!= EOF
&& c
!= filename_terminator
; c
= getc (fp
))
992 /* We have read a zero separator. The file possibly is
994 return file_list_zero
;
996 obstack_1grow (stk
, c
);
1000 if (counter
== 0 && c
!= EOF
)
1001 return file_list_skip
;
1003 obstack_1grow (stk
, 0);
1005 return (counter
== 0 && c
== EOF
) ? file_list_end
: file_list_success
;
1009 static bool files_from_option
; /* When set, tar will not refuse to create
1011 static struct obstack argv_stk
; /* Storage for additional command line options
1012 read using -T option */
1014 /* Prevent recursive inclusion of the same file */
1017 struct file_id_list
*next
;
1022 static struct file_id_list
*file_id_list
;
1025 add_file_id (const char *filename
)
1027 struct file_id_list
*p
;
1030 if (stat (filename
, &st
))
1031 stat_fatal (filename
);
1032 for (p
= file_id_list
; p
; p
= p
->next
)
1033 if (p
->ino
== st
.st_ino
&& p
->dev
== st
.st_dev
)
1035 FATAL_ERROR ((0, 0, _("%s: file list already read"),
1036 quotearg_colon (filename
)));
1038 p
= xmalloc (sizeof *p
);
1039 p
->next
= file_id_list
;
1045 /* Default density numbers for [0-9][lmh] device specifications */
1047 #ifndef LOW_DENSITY_NUM
1048 # define LOW_DENSITY_NUM 0
1051 #ifndef MID_DENSITY_NUM
1052 # define MID_DENSITY_NUM 8
1055 #ifndef HIGH_DENSITY_NUM
1056 # define HIGH_DENSITY_NUM 16
1060 update_argv (const char *filename
, struct argp_state
*state
)
1063 size_t count
= 0, i
;
1067 bool is_stdin
= false;
1068 enum read_file_list_state read_state
;
1070 if (!strcmp (filename
, "-"))
1073 request_stdin ("-T");
1078 add_file_id (filename
);
1079 if ((fp
= fopen (filename
, "r")) == NULL
)
1080 open_fatal (filename
);
1083 while ((read_state
= read_name_from_file (fp
, &argv_stk
)) != file_list_end
)
1087 case file_list_success
:
1091 case file_list_end
: /* won't happen, just to pacify gcc */
1094 case file_list_zero
:
1098 WARN ((0, 0, N_("%s: file name read contains nul character"),
1099 quotearg_colon (filename
)));
1101 /* Prepare new stack contents */
1102 size
= obstack_object_size (&argv_stk
);
1103 p
= obstack_finish (&argv_stk
);
1104 for (; size
> 0; size
--, p
++)
1106 obstack_1grow (&argv_stk
, *p
);
1108 obstack_1grow (&argv_stk
, '\n');
1109 obstack_1grow (&argv_stk
, 0);
1111 /* Read rest of files using new filename terminator */
1112 filename_terminator
= 0;
1116 case file_list_skip
:
1127 start
= obstack_finish (&argv_stk
);
1129 if (filename_terminator
== 0)
1130 for (p
= start
; *p
; p
+= strlen (p
) + 1)
1134 new_argc
= state
->argc
+ count
;
1135 new_argv
= xmalloc (sizeof (state
->argv
[0]) * (new_argc
+ 1));
1136 memcpy (new_argv
, state
->argv
, sizeof (state
->argv
[0]) * (state
->argc
+ 1));
1137 state
->argv
= new_argv
;
1138 memmove (&state
->argv
[state
->next
+ count
], &state
->argv
[state
->next
],
1139 (state
->argc
- state
->next
+ 1) * sizeof (state
->argv
[0]));
1141 state
->argc
= new_argc
;
1143 for (i
= state
->next
, p
= start
; *p
; p
+= strlen (p
) + 1, i
++)
1145 if (filename_terminator
== 0 && p
[0] == '-')
1146 state
->argv
[i
++] = "--add-file";
1153 tar_help (struct argp_state
*state
)
1155 argp_fmtstream_t fs
;
1156 state
->flags
|= ARGP_NO_EXIT
;
1157 argp_state_help (state
, state
->out_stream
,
1158 ARGP_HELP_STD_HELP
& ~ARGP_HELP_BUG_ADDR
);
1159 /* FIXME: use struct uparams.rmargin (from argp-help.c) instead of 79 */
1160 fs
= argp_make_fmtstream (state
->out_stream
, 0, 79, 0);
1162 argp_fmtstream_printf (fs
, "\n%s\n\n",
1163 _("Valid arguments for --quoting-style options are:"));
1164 tar_list_quoting_styles (fs
, " ");
1166 argp_fmtstream_puts (fs
, _("\n*This* tar defaults to:\n"));
1167 show_default_settings_fs (fs
);
1168 argp_fmtstream_putc (fs
, '\n');
1169 argp_fmtstream_printf (fs
, _("Report bugs to %s.\n"),
1170 argp_program_bug_address
);
1171 argp_fmtstream_free (fs
);
1175 parse_opt (int key
, char *arg
, struct argp_state
*state
)
1177 struct tar_args
*args
= state
->input
;
1182 /* File name or non-parsed option, because of ARGP_IN_ORDER */
1183 name_add_name (arg
, MAKE_INCL_OPTIONS (args
));
1184 args
->input_files
= true;
1188 set_subcommand_option (CAT_SUBCOMMAND
);
1194 if (! (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1195 && u
== (blocking_factor
= u
)
1196 && 0 < blocking_factor
1197 && u
== (record_size
= u
* BLOCKSIZE
) / BLOCKSIZE
))
1198 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1199 _("Invalid blocking factor")));
1204 /* Try to reblock input records. For reading 4.2BSD pipes. */
1206 /* It would surely make sense to exchange -B and -R, but it seems
1207 that -B has been used for a long while in Sun tar and most
1208 BSD-derived systems. This is a consequence of the block/record
1209 terminology confusion. */
1211 read_full_records_option
= true;
1215 set_subcommand_option (CREATE_SUBCOMMAND
);
1223 set_subcommand_option (DIFF_SUBCOMMAND
);
1227 if (archive_names
== allocated_archive_names
)
1228 archive_name_array
= x2nrealloc (archive_name_array
,
1229 &allocated_archive_names
,
1230 sizeof (archive_name_array
[0]));
1232 archive_name_array
[archive_names
++] = arg
;
1236 /* Since -F is only useful with -M, make it implied. Run this
1237 script at the end of each tape. */
1239 info_script_option
= arg
;
1240 multi_volume_option
= true;
1244 listed_incremental_option
= arg
;
1245 after_date_option
= true;
1249 /* We are making an incremental dump (FIXME: are we?); save
1250 directories at the beginning of the archive, and include in each
1251 directory its contents. */
1253 incremental_option
= true;
1257 /* Follow symbolic links. */
1258 dereference_option
= true;
1262 /* Ignore zero blocks (eofs). This can't be the default,
1263 because Unix tar writes two blocks of zeros, then pads out
1264 the record with garbage. */
1266 ignore_zeros_option
= true;
1271 _("Warning: the -I option is not supported;"
1272 " perhaps you meant -j or -T?")));
1276 set_use_compress_program_option ("bzip2");
1280 /* Don't replace existing files. */
1281 old_files_option
= KEEP_OLD_FILES
;
1285 starting_file_option
= true;
1289 case ONE_FILE_SYSTEM_OPTION
:
1290 /* When dumping directories, don't dump files/subdirectories
1291 that are on other filesystems. */
1292 one_file_system_option
= true;
1296 check_links_option
= 1;
1302 if (xstrtoumax (arg
, 0, 10, &u
, "") != LONGINT_OK
)
1303 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1304 _("Invalid tape length")));
1305 tape_length_option
= 1024 * (tarlong
) u
;
1306 multi_volume_option
= true;
1311 touch_option
= true;
1315 /* Make multivolume archive: when we can't write any more into
1316 the archive, re-open it, and continue writing. */
1318 multi_volume_option
= true;
1322 get_date_or_file (args
, "--mtime", arg
, &mtime_option
);
1323 set_mtime_option
= true;
1327 seekable_archive
= true;
1331 after_date_option
= true;
1334 case NEWER_MTIME_OPTION
:
1335 if (NEWER_OPTION_INITIALIZED (newer_mtime_option
))
1336 USAGE_ERROR ((0, 0, _("More than one threshold date")));
1337 get_date_or_file (args
,
1338 key
== NEWER_MTIME_OPTION
? "--newer-mtime"
1339 : "--after-date", arg
, &newer_mtime_option
);
1343 args
->o_option
= true;
1347 to_stdout_option
= true;
1351 same_permissions_option
= true;
1355 absolute_names_option
= true;
1359 set_subcommand_option (APPEND_SUBCOMMAND
);
1363 /* Print block numbers for debugging bad tar archives. */
1365 /* It would surely make sense to exchange -B and -R, but it seems
1366 that -B has been used for a long while in Sun tar and most
1367 BSD-derived systems. This is a consequence of the block/record
1368 terminology confusion. */
1370 block_number_option
= true;
1374 /* Names to extract are sorted. */
1376 same_order_option
= true;
1380 sparse_option
= true;
1383 case SPARSE_VERSION_OPTION
:
1384 sparse_option
= true;
1387 tar_sparse_major
= strtoul (arg
, &p
, 10);
1391 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1392 tar_sparse_minor
= strtoul (p
+ 1, &p
, 10);
1394 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1400 set_subcommand_option (LIST_SUBCOMMAND
);
1404 case TEST_LABEL_OPTION
:
1405 set_subcommand_option (LIST_SUBCOMMAND
);
1406 test_label_option
= true;
1410 update_argv (arg
, state
);
1411 /* Indicate we've been given -T option. This is for backward
1412 compatibility only, so that `tar cfT archive /dev/null will
1414 files_from_option
= true;
1418 set_subcommand_option (UPDATE_SUBCOMMAND
);
1422 old_files_option
= UNLINK_FIRST_OLD_FILES
;
1434 volume_label_option
= arg
;
1438 interactive_option
= true;
1442 verify_option
= true;
1446 set_subcommand_option (EXTRACT_SUBCOMMAND
);
1450 if (add_exclude_file (add_exclude
, excluded
, arg
,
1451 MAKE_EXCL_OPTIONS (args
), '\n')
1455 FATAL_ERROR ((0, e
, "%s", quotearg_colon (arg
)));
1460 set_use_compress_program_option ("gzip");
1464 set_use_compress_program_option ("compress");
1467 case ANCHORED_OPTION
:
1468 args
->matching_flags
|= EXCLUDE_ANCHORED
;
1471 case ATIME_PRESERVE_OPTION
:
1472 atime_preserve_option
=
1474 ? XARGMATCH ("--atime-preserve", arg
,
1475 atime_preserve_args
, atime_preserve_types
)
1476 : replace_atime_preserve
);
1477 if (! O_NOATIME
&& atime_preserve_option
== system_atime_preserve
)
1479 _("--atime-preserve='system' is not supported"
1480 " on this platform")));
1483 case CHECKPOINT_OPTION
:
1490 checkpoint_style
= checkpoint_dot
;
1493 checkpoint_option
= strtoul (arg
, &p
, 0);
1496 _("--checkpoint value is not an integer")));
1499 checkpoint_option
= 10;
1503 backup_option
= true;
1505 args
->version_control_string
= arg
;
1508 case DELAY_DIRECTORY_RESTORE_OPTION
:
1509 delay_directory_restore_option
= true;
1512 case NO_DELAY_DIRECTORY_RESTORE_OPTION
:
1513 delay_directory_restore_option
= false;
1517 set_subcommand_option (DELETE_SUBCOMMAND
);
1520 case EXCLUDE_OPTION
:
1521 add_exclude (excluded
, arg
, MAKE_EXCL_OPTIONS (args
));
1524 case EXCLUDE_CACHES_OPTION
:
1525 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_contents
,
1529 case EXCLUDE_CACHES_UNDER_OPTION
:
1530 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_under
,
1534 case EXCLUDE_CACHES_ALL_OPTION
:
1535 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_all
,
1539 case EXCLUDE_TAG_OPTION
:
1540 add_exclusion_tag (arg
, exclusion_tag_contents
, NULL
);
1543 case EXCLUDE_TAG_UNDER_OPTION
:
1544 add_exclusion_tag (arg
, exclusion_tag_under
, NULL
);
1547 case EXCLUDE_TAG_ALL_OPTION
:
1548 add_exclusion_tag (arg
, exclusion_tag_all
, NULL
);
1551 case FORCE_LOCAL_OPTION
:
1552 force_local_option
= true;
1556 set_archive_format (arg
);
1559 case INDEX_FILE_OPTION
:
1560 index_file_name
= arg
;
1563 case IGNORE_CASE_OPTION
:
1564 args
->matching_flags
|= FNM_CASEFOLD
;
1567 case IGNORE_COMMAND_ERROR_OPTION
:
1568 ignore_command_error_option
= true;
1571 case IGNORE_FAILED_READ_OPTION
:
1572 ignore_failed_read_option
= true;
1575 case KEEP_NEWER_FILES_OPTION
:
1576 old_files_option
= KEEP_NEWER_FILES
;
1580 if (! (strlen (arg
) < GNAME_FIELD_SIZE
1581 && gname_to_gid (arg
, &group_option
)))
1584 if (xstrtoumax (arg
, 0, 10, &g
, "") == LONGINT_OK
1588 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1589 _("%s: Invalid group")));
1594 mode_option
= mode_compile (arg
);
1596 FATAL_ERROR ((0, 0, _("Invalid mode given on option")));
1597 initial_umask
= umask (0);
1598 umask (initial_umask
);
1601 case NO_ANCHORED_OPTION
:
1602 args
->include_anchored
= 0; /* Clear the default for comman line args */
1603 args
->matching_flags
&= ~ EXCLUDE_ANCHORED
;
1606 case NO_IGNORE_CASE_OPTION
:
1607 args
->matching_flags
&= ~ FNM_CASEFOLD
;
1610 case NO_IGNORE_COMMAND_ERROR_OPTION
:
1611 ignore_command_error_option
= false;
1614 case NO_OVERWRITE_DIR_OPTION
:
1615 old_files_option
= NO_OVERWRITE_DIR_OLD_FILES
;
1618 case NO_QUOTE_CHARS_OPTION
:
1620 set_char_quoting (NULL
, *arg
, 0);
1623 case NO_WILDCARDS_OPTION
:
1624 args
->wildcards
= disable_wildcards
;
1627 case NO_WILDCARDS_MATCH_SLASH_OPTION
:
1628 args
->matching_flags
|= FNM_FILE_NAME
;
1632 filename_terminator
= '\0';
1635 case NUMERIC_OWNER_OPTION
:
1636 numeric_owner_option
= true;
1639 case OCCURRENCE_OPTION
:
1641 occurrence_option
= 1;
1645 if (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
)
1646 occurrence_option
= u
;
1648 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1649 _("Invalid number")));
1653 case OVERWRITE_DIR_OPTION
:
1654 old_files_option
= DEFAULT_OLD_FILES
;
1657 case OVERWRITE_OPTION
:
1658 old_files_option
= OVERWRITE_OLD_FILES
;
1662 if (! (strlen (arg
) < UNAME_FIELD_SIZE
1663 && uname_to_uid (arg
, &owner_option
)))
1666 if (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1670 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1671 _("Invalid owner")));
1675 case QUOTE_CHARS_OPTION
:
1677 set_char_quoting (NULL
, *arg
, 1);
1680 case QUOTING_STYLE_OPTION
:
1681 tar_set_quoting_style (arg
);
1685 args
->pax_option
= true;
1686 xheader_set_option (arg
);
1690 set_archive_format ("posix");
1693 case PRESERVE_OPTION
:
1694 /* FIXME: What it is good for? */
1695 same_permissions_option
= true;
1696 same_order_option
= true;
1699 case RECORD_SIZE_OPTION
:
1702 if (! (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1703 && u
== (size_t) u
))
1704 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1705 _("Invalid record size")));
1707 if (record_size
% BLOCKSIZE
!= 0)
1708 USAGE_ERROR ((0, 0, _("Record size must be a multiple of %d."),
1710 blocking_factor
= record_size
/ BLOCKSIZE
;
1714 case RECURSIVE_UNLINK_OPTION
:
1715 recursive_unlink_option
= true;
1718 case REMOVE_FILES_OPTION
:
1719 remove_files_option
= true;
1722 case RESTRICT_OPTION
:
1723 restrict_option
= true;
1726 case RMT_COMMAND_OPTION
:
1730 case RSH_COMMAND_OPTION
:
1731 rsh_command_option
= arg
;
1734 case SHOW_DEFAULTS_OPTION
:
1735 show_default_settings (stdout
);
1739 case STRIP_COMPONENTS_OPTION
:
1742 if (! (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1743 && u
== (size_t) u
))
1744 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1745 _("Invalid number of elements")));
1746 strip_name_components
= u
;
1750 case SHOW_OMITTED_DIRS_OPTION
:
1751 show_omitted_dirs_option
= true;
1754 case SHOW_TRANSFORMED_NAMES_OPTION
:
1755 show_transformed_names_option
= true;
1759 backup_option
= true;
1760 args
->backup_suffix_string
= arg
;
1763 case TO_COMMAND_OPTION
:
1764 if (to_command_option
)
1765 USAGE_ERROR ((0, 0, _("Only one --to-command option allowed")));
1766 to_command_option
= arg
;
1771 set_stat_signal (arg
);
1773 totals_option
= true;
1776 case TRANSFORM_OPTION
:
1777 set_transform_expr (arg
);
1780 case USE_COMPRESS_PROGRAM_OPTION
:
1781 set_use_compress_program_option (arg
);
1784 case VOLNO_FILE_OPTION
:
1785 volno_file_option
= arg
;
1788 case WILDCARDS_OPTION
:
1789 args
->wildcards
= enable_wildcards
;
1792 case WILDCARDS_MATCH_SLASH_OPTION
:
1793 args
->matching_flags
&= ~ FNM_FILE_NAME
;
1796 case NO_RECURSION_OPTION
:
1797 recursion_option
= 0;
1800 case NO_SAME_OWNER_OPTION
:
1801 same_owner_option
= -1;
1804 case NO_SAME_PERMISSIONS_OPTION
:
1805 same_permissions_option
= -1;
1808 case RECURSION_OPTION
:
1809 recursion_option
= FNM_LEADING_DIR
;
1812 case SAME_OWNER_OPTION
:
1813 same_owner_option
= 1;
1816 case UNQUOTE_OPTION
:
1817 unquote_option
= true;
1820 case NO_UNQUOTE_OPTION
:
1821 unquote_option
= false;
1833 #ifdef DEVICE_PREFIX
1835 int device
= key
- '0';
1837 static char buf
[sizeof DEVICE_PREFIX
+ 10];
1841 argp_error (state
, _("Malformed density argument: %s"), quote (arg
));
1843 strcpy (buf
, DEVICE_PREFIX
);
1844 cursor
= buf
+ strlen (buf
);
1846 #ifdef DENSITY_LETTER
1848 sprintf (cursor
, "%d%c", device
, arg
[0]);
1850 #else /* not DENSITY_LETTER */
1855 device
+= LOW_DENSITY_NUM
;
1859 device
+= MID_DENSITY_NUM
;
1863 device
+= HIGH_DENSITY_NUM
;
1867 argp_error (state
, _("Unknown density: `%c'"), arg
[0]);
1869 sprintf (cursor
, "%d", device
);
1871 #endif /* not DENSITY_LETTER */
1873 if (archive_names
== allocated_archive_names
)
1874 archive_name_array
= x2nrealloc (archive_name_array
,
1875 &allocated_archive_names
,
1876 sizeof (archive_name_array
[0]));
1877 archive_name_array
[archive_names
++] = xstrdup (buf
);
1881 #else /* not DEVICE_PREFIX */
1884 _("Options `-[0-7][lmh]' not supported by *this* tar"));
1886 #endif /* not DEVICE_PREFIX */
1894 argp_state_help (state
, state
->out_stream
, ARGP_HELP_USAGE
);
1898 case VERSION_OPTION
:
1899 version_etc (state
->out_stream
, "tar", PACKAGE_NAME
, VERSION
,
1900 "John Gilmore", "Jay Fenlason", (char *) NULL
);
1905 _argp_hang
= atoi (arg
? arg
: "3600");
1906 while (_argp_hang
-- > 0)
1911 return ARGP_ERR_UNKNOWN
;
1916 static struct argp argp
= {
1929 argp_help (&argp
, stderr
, ARGP_HELP_SEE
, (char*) program_name
);
1934 /* Parse the options for tar. */
1936 static struct argp_option
*
1937 find_argp_option (struct argp_option
*options
, int letter
)
1940 !(options
->name
== NULL
1941 && options
->key
== 0
1942 && options
->arg
== 0
1943 && options
->flags
== 0
1944 && options
->doc
== NULL
); options
++)
1945 if (options
->key
== letter
)
1951 decode_options (int argc
, char **argv
)
1954 struct tar_args args
;
1956 /* Set some default option values. */
1957 args
.textual_date
= NULL
;
1958 args
.wildcards
= default_wildcards
;
1959 args
.matching_flags
= 0;
1960 args
.include_anchored
= EXCLUDE_ANCHORED
;
1961 args
.o_option
= false;
1962 args
.pax_option
= false;
1963 args
.backup_suffix_string
= getenv ("SIMPLE_BACKUP_SUFFIX");
1964 args
.version_control_string
= 0;
1965 args
.input_files
= false;
1967 subcommand_option
= UNKNOWN_SUBCOMMAND
;
1968 archive_format
= DEFAULT_FORMAT
;
1969 blocking_factor
= DEFAULT_BLOCKING
;
1970 record_size
= DEFAULT_BLOCKING
* BLOCKSIZE
;
1971 excluded
= new_exclude ();
1972 newer_mtime_option
.tv_sec
= TYPE_MINIMUM (time_t);
1973 newer_mtime_option
.tv_nsec
= -1;
1974 recursion_option
= FNM_LEADING_DIR
;
1975 unquote_option
= true;
1976 tar_sparse_major
= 1;
1977 tar_sparse_minor
= 0;
1982 /* Convert old-style tar call by exploding option element and rearranging
1983 options accordingly. */
1985 if (argc
> 1 && argv
[1][0] != '-')
1987 int new_argc
; /* argc value for rearranged arguments */
1988 char **new_argv
; /* argv value for rearranged arguments */
1989 char *const *in
; /* cursor into original argv */
1990 char **out
; /* cursor into rearranged argv */
1991 const char *letter
; /* cursor into old option letters */
1992 char buffer
[3]; /* constructed option buffer */
1994 /* Initialize a constructed option. */
1999 /* Allocate a new argument array, and copy program name in it. */
2001 new_argc
= argc
- 1 + strlen (argv
[1]);
2002 new_argv
= xmalloc ((new_argc
+ 1) * sizeof (char *));
2007 /* Copy each old letter option as a separate option, and have the
2008 corresponding argument moved next to it. */
2010 for (letter
= *in
++; *letter
; letter
++)
2012 struct argp_option
*opt
;
2014 buffer
[1] = *letter
;
2015 *out
++ = xstrdup (buffer
);
2016 opt
= find_argp_option (options
, *letter
);
2017 if (opt
&& opt
->arg
)
2019 if (in
< argv
+ argc
)
2022 USAGE_ERROR ((0, 0, _("Old option `%c' requires an argument."),
2027 /* Copy all remaining options. */
2029 while (in
< argv
+ argc
)
2033 /* Replace the old option list by the new one. */
2039 /* Parse all options and non-options as they appear. */
2041 prepend_default_options (getenv ("TAR_OPTIONS"), &argc
, &argv
);
2043 if (argp_parse (&argp
, argc
, argv
, ARGP_IN_ORDER
|ARGP_NO_HELP
,
2045 exit (TAREXIT_FAILURE
);
2048 /* Special handling for 'o' option:
2050 GNU tar used to say "output old format".
2051 UNIX98 tar says don't chown files after extracting (we use
2052 "--no-same-owner" for this).
2054 The old GNU tar semantics is retained when used with --create
2055 option, otherwise UNIX98 semantics is assumed */
2059 if (subcommand_option
== CREATE_SUBCOMMAND
)
2061 /* GNU Tar <= 1.13 compatibility */
2062 set_archive_format ("v7");
2066 /* UNIX98 compatibility */
2067 same_owner_option
= -1;
2071 /* Handle operands after any "--" argument. */
2072 for (; index
< argc
; index
++)
2074 name_add_name (argv
[index
], MAKE_INCL_OPTIONS (&args
));
2075 args
.input_files
= true;
2078 /* Warn about implicit use of the wildcards in command line arguments.
2080 warn_regex_usage
= args
.wildcards
== default_wildcards
;
2082 /* Derive option values and check option consistency. */
2084 if (archive_format
== DEFAULT_FORMAT
)
2086 if (args
.pax_option
)
2087 archive_format
= POSIX_FORMAT
;
2089 archive_format
= DEFAULT_ARCHIVE_FORMAT
;
2092 if ((volume_label_option
&& subcommand_option
== CREATE_SUBCOMMAND
)
2093 || incremental_option
2094 || multi_volume_option
2096 assert_format (FORMAT_MASK (OLDGNU_FORMAT
)
2097 | FORMAT_MASK (GNU_FORMAT
)
2098 | FORMAT_MASK (POSIX_FORMAT
));
2100 if (occurrence_option
)
2102 if (!args
.input_files
)
2104 _("--occurrence is meaningless without a file list")));
2105 if (subcommand_option
!= DELETE_SUBCOMMAND
2106 && subcommand_option
!= DIFF_SUBCOMMAND
2107 && subcommand_option
!= EXTRACT_SUBCOMMAND
2108 && subcommand_option
!= LIST_SUBCOMMAND
)
2110 _("--occurrence cannot be used in the requested operation mode")));
2113 if (seekable_archive
&& subcommand_option
== DELETE_SUBCOMMAND
)
2115 /* The current code in delete.c is based on the assumption that
2116 skip_member() reads all data from the archive. So, we should
2117 make sure it won't use seeks. On the other hand, the same code
2118 depends on the ability to backspace a record in the archive,
2119 so setting seekable_archive to false is technically incorrect.
2120 However, it is tested only in skip_member(), so it's not a
2122 seekable_archive
= false;
2125 if (archive_names
== 0)
2127 /* If no archive file name given, try TAPE from the environment, or
2128 else, DEFAULT_ARCHIVE from the configuration process. */
2131 archive_name_array
[0] = getenv ("TAPE");
2132 if (! archive_name_array
[0])
2133 archive_name_array
[0] = DEFAULT_ARCHIVE
;
2136 /* Allow multiple archives only with `-M'. */
2138 if (archive_names
> 1 && !multi_volume_option
)
2140 _("Multiple archive files require `-M' option")));
2142 if (listed_incremental_option
2143 && NEWER_OPTION_INITIALIZED (newer_mtime_option
))
2145 _("Cannot combine --listed-incremental with --newer")));
2147 if (volume_label_option
)
2149 if (archive_format
== GNU_FORMAT
|| archive_format
== OLDGNU_FORMAT
)
2151 size_t volume_label_max_len
=
2152 (sizeof current_header
->header
.name
2153 - 1 /* for trailing '\0' */
2154 - (multi_volume_option
2155 ? (sizeof " Volume "
2156 - 1 /* for null at end of " Volume " */
2157 + INT_STRLEN_BOUND (int) /* for volume number */
2158 - 1 /* for sign, as 0 <= volno */)
2160 if (volume_label_max_len
< strlen (volume_label_option
))
2162 ngettext ("%s: Volume label is too long (limit is %lu byte)",
2163 "%s: Volume label is too long (limit is %lu bytes)",
2164 volume_label_max_len
),
2165 quotearg_colon (volume_label_option
),
2166 (unsigned long) volume_label_max_len
));
2169 Label length in PAX format is limited by the volume size. */
2174 if (multi_volume_option
)
2175 USAGE_ERROR ((0, 0, _("Cannot verify multi-volume archives")));
2176 if (use_compress_program_option
)
2177 USAGE_ERROR ((0, 0, _("Cannot verify compressed archives")));
2180 if (use_compress_program_option
)
2182 if (multi_volume_option
)
2183 USAGE_ERROR ((0, 0, _("Cannot use multi-volume compressed archives")));
2184 if (subcommand_option
== UPDATE_SUBCOMMAND
2185 || subcommand_option
== APPEND_SUBCOMMAND
2186 || subcommand_option
== DELETE_SUBCOMMAND
)
2187 USAGE_ERROR ((0, 0, _("Cannot update compressed archives")));
2188 if (subcommand_option
== CAT_SUBCOMMAND
)
2189 USAGE_ERROR ((0, 0, _("Cannot concatenate compressed archives")));
2192 /* It is no harm to use --pax-option on non-pax archives in archive
2193 reading mode. It may even be useful, since it allows to override
2194 file attributes from tar headers. Therefore I allow such usage.
2197 && archive_format
!= POSIX_FORMAT
2198 && (subcommand_option
!= EXTRACT_SUBCOMMAND
2199 || subcommand_option
!= DIFF_SUBCOMMAND
2200 || subcommand_option
!= LIST_SUBCOMMAND
))
2201 USAGE_ERROR ((0, 0, _("--pax-option can be used only on POSIX archives")));
2203 /* If ready to unlink hierarchies, so we are for simpler files. */
2204 if (recursive_unlink_option
)
2205 old_files_option
= UNLINK_FIRST_OLD_FILES
;
2208 if (test_label_option
)
2210 /* --test-label is silent if the user has specified the label name to
2212 if (!args
.input_files
)
2215 else if (utc_option
)
2218 /* Forbid using -c with no input files whatsoever. Check that `-f -',
2219 explicit or implied, is used correctly. */
2221 switch (subcommand_option
)
2223 case CREATE_SUBCOMMAND
:
2224 if (!args
.input_files
&& !files_from_option
)
2226 _("Cowardly refusing to create an empty archive")));
2229 case EXTRACT_SUBCOMMAND
:
2230 case LIST_SUBCOMMAND
:
2231 case DIFF_SUBCOMMAND
:
2232 for (archive_name_cursor
= archive_name_array
;
2233 archive_name_cursor
< archive_name_array
+ archive_names
;
2234 archive_name_cursor
++)
2235 if (!strcmp (*archive_name_cursor
, "-"))
2236 request_stdin ("-f");
2239 case CAT_SUBCOMMAND
:
2240 case UPDATE_SUBCOMMAND
:
2241 case APPEND_SUBCOMMAND
:
2242 for (archive_name_cursor
= archive_name_array
;
2243 archive_name_cursor
< archive_name_array
+ archive_names
;
2244 archive_name_cursor
++)
2245 if (!strcmp (*archive_name_cursor
, "-"))
2247 _("Options `-Aru' are incompatible with `-f -'")));
2253 /* Initialize stdlis */
2254 if (index_file_name
)
2256 stdlis
= fopen (index_file_name
, "w");
2258 open_error (index_file_name
);
2261 stdlis
= to_stdout_option
? stderr
: stdout
;
2263 archive_name_cursor
= archive_name_array
;
2265 /* Prepare for generating backup names. */
2267 if (args
.backup_suffix_string
)
2268 simple_backup_suffix
= xstrdup (args
.backup_suffix_string
);
2272 backup_type
= xget_version ("--backup", args
.version_control_string
);
2273 /* No backup is needed either if explicitely disabled or if
2274 the extracted files are not being written to disk. */
2275 if (backup_type
== no_backups
|| EXTRACT_OVER_PIPE
)
2276 backup_option
= false;
2280 report_textual_dates (&args
);
2286 /* Main routine for tar. */
2288 main (int argc
, char **argv
)
2291 program_name
= argv
[0];
2293 setlocale (LC_ALL
, "");
2294 bindtextdomain (PACKAGE
, LOCALEDIR
);
2295 textdomain (PACKAGE
);
2297 exit_failure
= TAREXIT_FAILURE
;
2298 exit_status
= TAREXIT_SUCCESS
;
2299 filename_terminator
= '\n';
2300 set_quoting_style (0, DEFAULT_QUOTING_STYLE
);
2302 /* Make sure we have first three descriptors available */
2305 /* Pre-allocate a few structures. */
2307 allocated_archive_names
= 10;
2308 archive_name_array
=
2309 xmalloc (sizeof (const char *) * allocated_archive_names
);
2312 obstack_init (&argv_stk
);
2315 /* System V fork+wait does not work if SIGCHLD is ignored. */
2316 signal (SIGCHLD
, SIG_DFL
);
2319 /* Decode options. */
2321 decode_options (argc
, argv
);
2325 /* Main command execution. */
2327 if (volno_file_option
)
2328 init_volume_number ();
2330 switch (subcommand_option
)
2332 case UNKNOWN_SUBCOMMAND
:
2334 _("You must specify one of the `-Acdtrux' options")));
2336 case CAT_SUBCOMMAND
:
2337 case UPDATE_SUBCOMMAND
:
2338 case APPEND_SUBCOMMAND
:
2342 case DELETE_SUBCOMMAND
:
2343 delete_archive_members ();
2346 case CREATE_SUBCOMMAND
:
2350 case EXTRACT_SUBCOMMAND
:
2352 read_and (extract_archive
);
2354 /* FIXME: should extract_finish () even if an ordinary signal is
2360 case LIST_SUBCOMMAND
:
2361 read_and (list_archive
);
2364 case DIFF_SUBCOMMAND
:
2366 read_and (diff_archive
);
2371 print_total_stats ();
2373 if (check_links_option
)
2376 if (volno_file_option
)
2377 closeout_volume_number ();
2379 /* Dispose of allocated memory, and return. */
2381 free (archive_name_array
);
2384 if (exit_status
== TAREXIT_FAILURE
)
2385 error (0, 0, _("Error exit delayed from previous errors"));
2387 if (stdlis
== stdout
)
2389 else if (ferror (stderr
) || fclose (stderr
) != 0)
2390 exit_status
= TAREXIT_FAILURE
;
2396 tar_stat_init (struct tar_stat_info
*st
)
2398 memset (st
, 0, sizeof (*st
));
2402 tar_stat_destroy (struct tar_stat_info
*st
)
2404 free (st
->orig_file_name
);
2405 free (st
->file_name
);
2406 free (st
->link_name
);
2409 free (st
->sparse_map
);
2411 xheader_destroy (&st
->xhdr
);
2412 memset (st
, 0, sizeof (*st
));
2415 /* Format mask for all available formats that support nanosecond
2416 timestamp resolution. */
2417 #define NS_PRECISION_FORMAT_MASK FORMAT_MASK (POSIX_FORMAT)
2419 /* Same as timespec_cmp, but ignore nanoseconds if current archive
2420 format does not provide sufficient resolution. */
2422 tar_timespec_cmp (struct timespec a
, struct timespec b
)
2424 if (!(FORMAT_MASK (current_format
) & NS_PRECISION_FORMAT_MASK
))
2425 a
.tv_nsec
= b
.tv_nsec
= 0;
2426 return timespec_cmp (a
, b
);