1 /* A tar (tape archiver) program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
4 2001, 2003, 2004, 2005, 2006 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 2, 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. */
46 #include <localedir.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
,
261 IGNORE_COMMAND_ERROR_OPTION
,
262 IGNORE_FAILED_READ_OPTION
,
264 KEEP_NEWER_FILES_OPTION
,
269 NO_DELAY_DIRECTORY_RESTORE_OPTION
,
270 NO_IGNORE_CASE_OPTION
,
271 NO_IGNORE_COMMAND_ERROR_OPTION
,
272 NO_OVERWRITE_DIR_OPTION
,
273 NO_QUOTE_CHARS_OPTION
,
275 NO_SAME_OWNER_OPTION
,
276 NO_SAME_PERMISSIONS_OPTION
,
278 NO_WILDCARDS_MATCH_SLASH_OPTION
,
281 NUMERIC_OWNER_OPTION
,
284 ONE_FILE_SYSTEM_OPTION
,
285 OVERWRITE_DIR_OPTION
,
292 QUOTING_STYLE_OPTION
,
295 RECURSIVE_UNLINK_OPTION
,
301 SHOW_DEFAULTS_OPTION
,
302 SHOW_OMITTED_DIRS_OPTION
,
303 SHOW_TRANSFORMED_NAMES_OPTION
,
304 SPARSE_VERSION_OPTION
,
305 STRIP_COMPONENTS_OPTION
,
313 USE_COMPRESS_PROGRAM_OPTION
,
317 WILDCARDS_MATCH_SLASH_OPTION
,
321 const char *argp_program_version
= "tar (" PACKAGE_NAME
") " VERSION
;
322 const char *argp_program_bug_address
= "<" PACKAGE_BUGREPORT
">";
323 static char doc
[] = N_("GNU `tar' saves many files together into a single tape or disk archive, and can restore individual files from the archive.\n\
326 tar -cf archive.tar foo bar # Create archive.tar from files foo and bar.\n\
327 tar -tvf archive.tar # List all files in archive.tar verbosely.\n\
328 tar -xf archive.tar # Extract all files from archive.tar.\n\
329 \vThe backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
330 The version control may be set with --backup or VERSION_CONTROL, values are:\n\n\
331 none, off never make backups\n\
332 t, numbered make numbered backups\n\
333 nil, existing numbered if numbered backups exist, simple otherwise\n\
334 never, simple always make simple backups\n");
339 Available option letters are DEIJQY and aeqy. Consider the following
342 [For Solaris tar compatibility =/= Is it important at all?]
343 e exit immediately with a nonzero exit status if unexpected errors occur
344 E use extended headers (--format=posix)
346 [q alias for --occurrence=1 =/= this would better be used for quiet?]
347 [I same as T =/= will harm star compatibility]
349 y per-file gzip compression
350 Y per-block gzip compression */
352 static struct argp_option options
[] = {
355 N_("Main operation mode:"), GRID
},
358 N_("list the contents of an archive"), GRID
+1 },
359 {"extract", 'x', 0, 0,
360 N_("extract files from an archive"), GRID
+1 },
361 {"get", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
362 {"create", 'c', 0, 0,
363 N_("create a new archive"), GRID
+1 },
365 N_("find differences between archive and file system"), GRID
+1 },
366 {"compare", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
367 {"append", 'r', 0, 0,
368 N_("append files to the end of an archive"), GRID
+1 },
369 {"update", 'u', 0, 0,
370 N_("only append files newer than copy in archive"), GRID
+1 },
371 {"catenate", 'A', 0, 0,
372 N_("append tar files to an archive"), GRID
+1 },
373 {"concatenate", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
374 {"delete", DELETE_OPTION
, 0, 0,
375 N_("delete from the archive (not on mag tapes!)"), GRID
+1 },
376 {"test-label", TEST_LABEL_OPTION
, NULL
, 0,
377 N_("test the archive volume label and exit"), GRID
+1 },
382 N_("Operation modifiers:"), GRID
},
384 {"sparse", 'S', 0, 0,
385 N_("handle sparse files efficiently"), GRID
+1 },
386 {"sparse-version", SPARSE_VERSION_OPTION
, N_("MAJOR[.MINOR]"), 0,
387 N_("set version of the sparse format to use"), GRID
+1},
388 {"incremental", 'G', 0, 0,
389 N_("handle old GNU-format incremental backup"), GRID
+1 },
390 {"listed-incremental", 'g', N_("FILE"), 0,
391 N_("handle new GNU-format incremental backup"), GRID
+1 },
392 {"ignore-failed-read", IGNORE_FAILED_READ_OPTION
, 0, 0,
393 N_("do not exit with nonzero on unreadable files"), GRID
+1 },
394 {"occurrence", OCCURRENCE_OPTION
, N_("NUMBER"), OPTION_ARG_OPTIONAL
,
395 N_("process only the NUMBERth occurrence of each file in the archive;"
396 " this option is valid only in conjunction with one of the subcommands"
397 " --delete, --diff, --extract or --list and when a list of files"
398 " is given either on the command line or via the -T option;"
399 " NUMBER defaults to 1"), GRID
+1 },
400 {"seek", 'n', NULL
, 0,
401 N_("archive is seekable"), GRID
+1 },
406 N_("Overwrite control:"), GRID
+1 },
408 {"verify", 'W', 0, 0,
409 N_("attempt to verify the archive after writing it"), GRID
+1 },
410 {"remove-files", REMOVE_FILES_OPTION
, 0, 0,
411 N_("remove files after adding them to the archive"), GRID
+1 },
412 {"keep-old-files", 'k', 0, 0,
413 N_("don't replace existing files when extracting"), GRID
+1 },
414 {"keep-newer-files", KEEP_NEWER_FILES_OPTION
, 0, 0,
415 N_("don't replace existing files that are newer than their archive copies"), GRID
+1 },
416 {"overwrite", OVERWRITE_OPTION
, 0, 0,
417 N_("overwrite existing files when extracting"), GRID
+1 },
418 {"unlink-first", 'U', 0, 0,
419 N_("remove each file prior to extracting over it"), GRID
+1 },
420 {"recursive-unlink", RECURSIVE_UNLINK_OPTION
, 0, 0,
421 N_("empty hierarchies prior to extracting directory"), GRID
+1 },
422 {"no-overwrite-dir", NO_OVERWRITE_DIR_OPTION
, 0, 0,
423 N_("preserve metadata of existing directories"), GRID
+1 },
424 {"overwrite-dir", OVERWRITE_DIR_OPTION
, 0, 0,
425 N_("overwrite metadata of existing directories when extracting (default)"),
431 N_("Select output stream:"), GRID
},
433 {"to-stdout", 'O', 0, 0,
434 N_("extract files to standard output"), GRID
+1 },
435 {"to-command", TO_COMMAND_OPTION
, N_("COMMAND"), 0,
436 N_("pipe extracted files to another program"), GRID
+1 },
437 {"ignore-command-error", IGNORE_COMMAND_ERROR_OPTION
, 0, 0,
438 N_("ignore exit codes of children"), GRID
+1 },
439 {"no-ignore-command-error", NO_IGNORE_COMMAND_ERROR_OPTION
, 0, 0,
440 N_("treat non-zero exit codes of children as error"), GRID
+1 },
445 N_("Handling of file attributes:"), GRID
},
447 {"owner", OWNER_OPTION
, N_("NAME"), 0,
448 N_("force NAME as owner for added files"), GRID
+1 },
449 {"group", GROUP_OPTION
, N_("NAME"), 0,
450 N_("force NAME as group for added files"), GRID
+1 },
451 {"mtime", MTIME_OPTION
, N_("DATE-OR-FILE"), 0,
452 N_("set mtime for added files from DATE-OR-FILE"), GRID
+1 },
453 {"mode", MODE_OPTION
, N_("CHANGES"), 0,
454 N_("force (symbolic) mode CHANGES for added files"), GRID
+1 },
455 {"atime-preserve", ATIME_PRESERVE_OPTION
,
456 N_("METHOD"), OPTION_ARG_OPTIONAL
,
457 N_("preserve access times on dumped files, either by restoring the times"
458 " after reading (METHOD='replace'; default) or by not setting the times"
459 " in the first place (METHOD='system')"), GRID
+1 },
461 N_("don't extract file modified time"), GRID
+1 },
462 {"same-owner", SAME_OWNER_OPTION
, 0, 0,
463 N_("try extracting files with the same ownership"), GRID
+1 },
464 {"no-same-owner", NO_SAME_OWNER_OPTION
, 0, 0,
465 N_("extract files as yourself"), GRID
+1 },
466 {"numeric-owner", NUMERIC_OWNER_OPTION
, 0, 0,
467 N_("always use numbers for user/group names"), GRID
+1 },
468 {"preserve-permissions", 'p', 0, 0,
469 N_("extract information about file permissions (default for superuser)"),
471 {"same-permissions", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
472 {"no-same-permissions", NO_SAME_PERMISSIONS_OPTION
, 0, 0,
473 N_("apply the user's umask when extracting permissions from the archive (default for ordinary users)"), GRID
+1 },
474 {"preserve-order", 's', 0, 0,
475 N_("sort names to extract to match archive"), GRID
+1 },
476 {"same-order", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
477 {"preserve", PRESERVE_OPTION
, 0, 0,
478 N_("same as both -p and -s"), GRID
+1 },
479 {"delay-directory-restore", DELAY_DIRECTORY_RESTORE_OPTION
, 0, 0,
480 N_("delay setting modification times and permissions of extracted"
481 " directories until the end of extraction"), GRID
+1 },
482 {"no-delay-directory-restore", NO_DELAY_DIRECTORY_RESTORE_OPTION
, 0, 0,
483 N_("cancel the effect of --delay-directory-restore option"), GRID
+1 },
488 N_("Device selection and switching:\n"), GRID
+1 },
490 {"file", 'f', N_("ARCHIVE"), 0,
491 N_("use archive file or device ARCHIVE"), GRID
+1 },
492 {"force-local", FORCE_LOCAL_OPTION
, 0, 0,
493 N_("archive file is local even if it has a colon"), GRID
+1 },
494 {"rmt-command", RMT_COMMAND_OPTION
, N_("COMMAND"), 0,
495 N_("use given rmt COMMAND instead of rmt"), GRID
+1 },
496 {"rsh-command", RSH_COMMAND_OPTION
, N_("COMMAND"), 0,
497 N_("use remote COMMAND instead of rsh"), GRID
+1 },
499 {"-[0-7][lmh]", 0, NULL
, OPTION_DOC
, /* It is OK, since `name' will never be
501 N_("specify drive and density"), GRID
+1 },
503 {NULL
, '0', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
504 {NULL
, '1', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
505 {NULL
, '2', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
506 {NULL
, '3', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
507 {NULL
, '4', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
508 {NULL
, '5', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
509 {NULL
, '6', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
510 {NULL
, '7', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
511 {NULL
, '8', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
512 {NULL
, '9', NULL
, OPTION_HIDDEN
, NULL
, GRID
+1 },
514 {"multi-volume", 'M', 0, 0,
515 N_("create/list/extract multi-volume archive"), GRID
+1 },
516 {"tape-length", 'L', N_("NUMBER"), 0,
517 N_("change tape after writing NUMBER x 1024 bytes"), GRID
+1 },
518 {"info-script", 'F', N_("NAME"), 0,
519 N_("run script at end of each tape (implies -M)"), GRID
+1 },
520 {"new-volume-script", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
521 {"volno-file", VOLNO_FILE_OPTION
, N_("FILE"), 0,
522 N_("use/update the volume number in FILE"), GRID
+1 },
527 N_("Device blocking:"), GRID
+1 },
529 {"blocking-factor", 'b', N_("BLOCKS"), 0,
530 N_("BLOCKS x 512 bytes per record"), GRID
+1 },
531 {"record-size", RECORD_SIZE_OPTION
, N_("NUMBER"), 0,
532 N_("NUMBER of bytes per record, multiple of 512"), GRID
+1 },
533 {"ignore-zeros", 'i', 0, 0,
534 N_("ignore zeroed blocks in archive (means EOF)"), GRID
+1 },
535 {"read-full-records", 'B', 0, 0,
536 N_("reblock as we read (for 4.2BSD pipes)"), GRID
+1 },
541 N_("Archive format selection:"), GRID
},
543 {"format", 'H', N_("FORMAT"), 0,
544 N_("create archive of the given format"), GRID
+1 },
546 {NULL
, 0, NULL
, 0, N_("FORMAT is one of the following:"), GRID
+2 },
547 {" v7", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
, N_("old V7 tar format"),
549 {" oldgnu", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
550 N_("GNU format as per tar <= 1.12"), GRID
+3 },
551 {" gnu", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
552 N_("GNU tar 1.13.x format"), GRID
+3 },
553 {" ustar", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
554 N_("POSIX 1003.1-1988 (ustar) format"), GRID
+3 },
555 {" pax", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
,
556 N_("POSIX 1003.1-2001 (pax) format"), GRID
+3 },
557 {" posix", 0, NULL
, OPTION_DOC
|OPTION_NO_TRANS
, N_("same as pax"), GRID
+3 },
559 {"old-archive", OLD_ARCHIVE_OPTION
, 0, 0, /* FIXME */
560 N_("same as --format=v7"), GRID
+8 },
561 {"portability", 0, 0, OPTION_ALIAS
, NULL
, GRID
+8 },
562 {"posix", POSIX_OPTION
, 0, 0,
563 N_("same as --format=posix"), GRID
+8 },
564 {"pax-option", PAX_OPTION
, N_("keyword[[:]=value][,keyword[[:]=value]]..."), 0,
565 N_("control pax keywords"), GRID
+8 },
566 {"label", 'V', N_("TEXT"), 0,
567 N_("create archive with volume name TEXT; at list/extract time, use TEXT as a globbing pattern for volume name"), GRID
+8 },
569 N_("filter the archive through bzip2"), GRID
+8 },
571 N_("filter the archive through gzip"), GRID
+8 },
572 {"gunzip", 0, 0, OPTION_ALIAS
, NULL
, GRID
+8 },
573 {"ungzip", 0, 0, OPTION_ALIAS
, NULL
, GRID
+8 },
574 {"compress", 'Z', 0, 0,
575 N_("filter the archive through compress"), GRID
+8 },
576 {"uncompress", 0, 0, OPTION_ALIAS
, NULL
, GRID
+8 },
577 {"use-compress-program", USE_COMPRESS_PROGRAM_OPTION
, N_("PROG"), 0,
578 N_("filter through PROG (must accept -d)"), GRID
+8 },
583 N_("Local file selection:"), GRID
},
585 {"add-file", ARGP_KEY_ARG
, N_("FILE"), 0,
586 N_("add given FILE to the archive (useful if its name starts with a dash)"), GRID
+1 },
587 {"directory", 'C', N_("DIR"), 0,
588 N_("change to directory DIR"), GRID
+1 },
589 {"files-from", 'T', N_("FILE"), 0,
590 N_("get names to extract or create from FILE"), GRID
+1 },
591 {"null", NULL_OPTION
, 0, 0,
592 N_("-T reads null-terminated names, disable -C"), GRID
+1 },
593 {"unquote", UNQUOTE_OPTION
, 0, 0,
594 N_("unquote filenames read with -T (default)"), GRID
+1 },
595 {"no-unquote", NO_UNQUOTE_OPTION
, 0, 0,
596 N_("do not unquote filenames read with -T"), GRID
+1 },
597 {"exclude", EXCLUDE_OPTION
, N_("PATTERN"), 0,
598 N_("exclude files, given as a PATTERN"), GRID
+1 },
599 {"exclude-from", 'X', N_("FILE"), 0,
600 N_("exclude patterns listed in FILE"), GRID
+1 },
601 {"exclude-caches", EXCLUDE_CACHES_OPTION
, 0, 0,
602 N_("exclude directories containing a cache tag"), GRID
+1 },
603 {"no-recursion", NO_RECURSION_OPTION
, 0, 0,
604 N_("avoid descending automatically in directories"), GRID
+1 },
605 {"one-file-system", ONE_FILE_SYSTEM_OPTION
, 0, 0,
606 N_("stay in local file system when creating archive"), GRID
+1 },
607 {"recursion", RECURSION_OPTION
, 0, 0,
608 N_("recurse into directories (default)"), GRID
+1 },
609 {"absolute-names", 'P', 0, 0,
610 N_("don't strip leading `/'s from file names"), GRID
+1 },
611 {"dereference", 'h', 0, 0,
612 N_("follow symlinks; archive and dump the files they point to"), GRID
+1 },
613 {"starting-file", 'K', N_("MEMBER-NAME"), 0,
614 N_("begin at member MEMBER-NAME in the archive"), GRID
+1 },
615 {"newer", 'N', N_("DATE-OR-FILE"), 0,
616 N_("only store files newer than DATE-OR-FILE"), GRID
+1 },
617 {"after-date", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
618 {"newer-mtime", NEWER_MTIME_OPTION
, N_("DATE"), 0,
619 N_("compare date and time when data changed only"), GRID
+1 },
620 {"backup", BACKUP_OPTION
, N_("CONTROL"), OPTION_ARG_OPTIONAL
,
621 N_("backup before removal, choose version CONTROL"), GRID
+1 },
622 {"suffix", SUFFIX_OPTION
, N_("STRING"), 0,
623 N_("backup before removal, override usual suffix ('~' unless overridden by environment variable SIMPLE_BACKUP_SUFFIX)"), GRID
+1 },
628 N_("File name transformations:"), GRID
},
629 {"strip-components", STRIP_COMPONENTS_OPTION
, N_("NUMBER"), 0,
630 N_("strip NUMBER leading components from file names on extraction"),
632 {"transform", TRANSFORM_OPTION
, N_("EXPRESSION"), 0,
633 N_("use sed replace EXPRESSION to transform file names"), GRID
+1 },
638 N_("File name matching options (affect both exclude and include patterns):"),
640 {"ignore-case", IGNORE_CASE_OPTION
, 0, 0,
641 N_("ignore case"), GRID
+1 },
642 {"anchored", ANCHORED_OPTION
, 0, 0,
643 N_("patterns match file name start"), GRID
+1 },
644 {"no-anchored", NO_ANCHORED_OPTION
, 0, 0,
645 N_("patterns match after any `/' (default for exclusion)"), GRID
+1 },
646 {"no-ignore-case", NO_IGNORE_CASE_OPTION
, 0, 0,
647 N_("case sensitive matching (default)"), GRID
+1 },
648 {"wildcards", WILDCARDS_OPTION
, 0, 0,
649 N_("use wildcards (default for exclusion)"), GRID
+1 },
650 {"no-wildcards", NO_WILDCARDS_OPTION
, 0, 0,
651 N_("verbatim string matching"), GRID
+1 },
652 {"no-wildcards-match-slash", NO_WILDCARDS_MATCH_SLASH_OPTION
, 0, 0,
653 N_("wildcards do not match `/'"), GRID
+1 },
654 {"wildcards-match-slash", WILDCARDS_MATCH_SLASH_OPTION
, 0, 0,
655 N_("wildcards match `/' (default for exclusion)"), GRID
+1 },
660 N_("Informative output:"), GRID
},
662 {"verbose", 'v', 0, 0,
663 N_("verbosely list files processed"), GRID
+1 },
664 {"checkpoint", CHECKPOINT_OPTION
, N_("[.]NUMBER"), OPTION_ARG_OPTIONAL
,
665 N_("display progress messages every NUMBERth record (default 10)"),
667 {"check-links", 'l', 0, 0,
668 N_("print a message if not all links are dumped"), GRID
+1 },
669 {"totals", TOTALS_OPTION
, N_("SIGNAL"), OPTION_ARG_OPTIONAL
,
670 N_("print total bytes after processing the archive; "
671 "with an argument - print total bytes when this SIGNAL is delivered; "
672 "Allowed signals are: SIGHUP, SIGQUIT, SIGINT, SIGUSR1 and SIGUSR2; "
673 "the names without SIG prefix are also accepted"), GRID
+1 },
674 {"utc", UTC_OPTION
, 0, 0,
675 N_("print file modification dates in UTC"), GRID
+1 },
676 {"index-file", INDEX_FILE_OPTION
, N_("FILE"), 0,
677 N_("send verbose output to FILE"), GRID
+1 },
678 {"block-number", 'R', 0, 0,
679 N_("show block number within archive with each message"), GRID
+1 },
680 {"interactive", 'w', 0, 0,
681 N_("ask for confirmation for every action"), GRID
+1 },
682 {"confirmation", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
683 {"show-defaults", SHOW_DEFAULTS_OPTION
, 0, 0,
684 N_("show tar defaults"), GRID
+1 },
685 {"show-omitted-dirs", SHOW_OMITTED_DIRS_OPTION
, 0, 0,
686 N_("when listing or extracting, list each directory that does not match search criteria"), GRID
+1 },
687 {"show-transformed-names", SHOW_TRANSFORMED_NAMES_OPTION
, 0, 0,
688 N_("show file or archive names after transformation"),
690 {"show-stored-names", 0, 0, OPTION_ALIAS
, NULL
, GRID
+1 },
691 {"quoting-style", QUOTING_STYLE_OPTION
, N_("STYLE"), 0,
692 N_("set name quoting style; see below for valid STYLE values"), GRID
+1 },
693 {"quote-chars", QUOTE_CHARS_OPTION
, N_("STRING"), 0,
694 N_("additionally quote characters from STRING"), GRID
+1 },
695 {"no-quote-chars", NO_QUOTE_CHARS_OPTION
, N_("STRING"), 0,
696 N_("disable quoting for characters from STRING"), GRID
+1 },
701 N_("Compatibility options:"), GRID
},
704 N_("when creating, same as --old-archive; when extracting, same as --no-same-owner"), GRID
+1 },
709 N_("Other options:"), GRID
},
711 {"restrict", RESTRICT_OPTION
, 0, 0,
712 N_("disable use of some potentially harmful options"), -1 },
714 {"help", '?', 0, 0, N_("give this help list"), -1},
715 {"usage", USAGE_OPTION
, 0, 0, N_("give a short usage message"), -1},
716 {"version", VERSION_OPTION
, 0, 0, N_("print program version"), -1},
717 /* FIXME -V (--label) conflicts with the default short option for
719 {"HANG", HANG_OPTION
, "SECS", OPTION_ARG_OPTIONAL
| OPTION_HIDDEN
,
720 N_("hang for SECS seconds (default 3600)"), 0},
726 static char const *const atime_preserve_args
[] =
728 "replace", "system", NULL
731 static enum atime_preserve
const atime_preserve_types
[] =
733 replace_atime_preserve
, system_atime_preserve
736 /* Make sure atime_preserve_types has as much entries as atime_preserve_args
737 (minus 1 for NULL guard) */
738 ARGMATCH_VERIFY (atime_preserve_args
, atime_preserve_types
);
740 /* Wildcard matching settings */
743 default_wildcards
, /* For exclusion == enable_wildcards,
744 for inclusion == disable_wildcards */
749 struct tar_args
/* Variables used during option parsing */
751 struct textual_date
*textual_date
; /* Keeps the arguments to --newer-mtime
752 and/or --date option if they are
754 enum wildcards wildcards
; /* Wildcard settings (--wildcards/
756 int matching_flags
; /* exclude_fnmatch options */
757 int include_anchored
; /* Pattern anchoring options used for
759 bool o_option
; /* True if -o option was given */
760 bool pax_option
; /* True if --pax-option was given */
761 char const *backup_suffix_string
; /* --suffix option argument */
762 char const *version_control_string
; /* --backup option argument */
763 bool input_files
; /* True if some input files where given */
766 #define MAKE_EXCL_OPTIONS(args) \
767 ((((args)->wildcards != disable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
768 | (args)->matching_flags \
771 #define MAKE_INCL_OPTIONS(args) \
772 ((((args)->wildcards == enable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
773 | (args)->include_anchored \
774 | (args)->matching_flags \
778 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
781 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
782 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
783 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
784 quoting_style_args[DEFAULT_QUOTING_STYLE], \
785 DEFAULT_RMT_COMMAND); \
786 printer (stream, " --rsh-command=%s", REMOTE_SHELL); \
787 printer (stream, "\n"); \
790 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
793 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
794 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
795 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
796 quoting_style_args[DEFAULT_QUOTING_STYLE], \
797 DEFAULT_RMT_COMMAND); \
798 printer (stream, "\n"); \
803 show_default_settings (FILE *fp
)
804 DECL_SHOW_DEFAULT_SETTINGS(fp
, fprintf
)
807 show_default_settings_fs (argp_fmtstream_t fs
)
808 DECL_SHOW_DEFAULT_SETTINGS(fs
, argp_fmtstream_printf
)
811 set_subcommand_option (enum subcommand subcommand
)
813 if (subcommand_option
!= UNKNOWN_SUBCOMMAND
814 && subcommand_option
!= subcommand
)
816 _("You may not specify more than one `-Acdtrux' option")));
818 subcommand_option
= subcommand
;
822 set_use_compress_program_option (const char *string
)
824 if (use_compress_program_option
825 && strcmp (use_compress_program_option
, string
) != 0)
826 USAGE_ERROR ((0, 0, _("Conflicting compression options")));
828 use_compress_program_option
= string
;
835 print_total_stats ();
836 #ifndef HAVE_SIGACTION
837 signal (signo
, sigstat
);
842 stat_on_signal (int signo
)
844 #ifdef HAVE_SIGACTION
845 struct sigaction act
;
846 act
.sa_handler
= sigstat
;
847 sigemptyset (&act
.sa_mask
);
849 sigaction (signo
, &act
, NULL
);
851 signal (signo
, sigstat
);
856 set_stat_signal (const char *name
)
863 { "SIGUSR1", SIGUSR1
},
865 { "SIGUSR2", SIGUSR2
},
867 { "SIGHUP", SIGHUP
},
869 { "SIGINT", SIGINT
},
871 { "SIGQUIT", SIGQUIT
},
876 for (p
= sigtab
; p
< sigtab
+ sizeof (sigtab
) / sizeof (sigtab
[0]); p
++)
877 if (strcmp (p
->name
, name
) == 0)
879 stat_on_signal (p
->signo
);
882 FATAL_ERROR ((0, 0, _("Unknown signal name: %s"), name
));
888 struct textual_date
*next
;
895 get_date_or_file (struct tar_args
*args
, const char *option
,
896 const char *str
, struct timespec
*ts
)
898 if (FILE_SYSTEM_PREFIX_LEN (str
) != 0
903 if (deref_stat (dereference_option
, str
, &st
) != 0)
906 USAGE_ERROR ((0, 0, _("Date sample file not found")));
908 *ts
= get_stat_mtime (&st
);
912 if (! get_date (ts
, str
, NULL
))
914 WARN ((0, 0, _("Substituting %s for unknown date format %s"),
915 tartime (*ts
, false), quote (str
)));
920 struct textual_date
*p
= xmalloc (sizeof (*p
));
924 p
->next
= args
->textual_date
;
925 args
->textual_date
= p
;
931 report_textual_dates (struct tar_args
*args
)
933 struct textual_date
*p
;
934 for (p
= args
->textual_date
; p
; )
936 struct textual_date
*next
= p
->next
;
937 char const *treated_as
= tartime (*p
->ts
, true);
938 if (strcmp (p
->date
, treated_as
) != 0)
939 WARN ((0, 0, _("Option %s: Treating date `%s' as %s"),
940 p
->option
, p
->date
, treated_as
));
947 static volatile int _argp_hang
;
949 enum read_file_list_state
/* Result of reading file name from the list file */
951 file_list_success
, /* OK, name read successfully */
952 file_list_end
, /* End of list file */
953 file_list_zero
/* Zero separator encountered where it should not */
956 /* Read from FP a sequence of characters up to FILENAME_TERMINATOR and put them
959 static enum read_file_list_state
960 read_name_from_file (FILE *fp
, struct obstack
*stk
)
965 for (c
= getc (fp
); c
!= EOF
&& c
!= filename_terminator
; c
= getc (fp
))
969 /* We have read a zero separator. The file possibly is
971 /* FATAL_ERROR((0, 0, N_("file name contains null character"))); */
972 return file_list_zero
;
974 obstack_1grow (stk
, c
);
978 obstack_1grow (stk
, 0);
980 return (counter
== 0 && c
== EOF
) ? file_list_end
: file_list_success
;
984 static bool files_from_option
; /* When set, tar will not refuse to create
986 static struct obstack argv_stk
; /* Storage for additional command line options
987 read using -T option */
989 /* Prevent recursive inclusion of the same file */
992 struct file_id_list
*next
;
997 static struct file_id_list
*file_id_list
;
1000 add_file_id (const char *filename
)
1002 struct file_id_list
*p
;
1005 if (stat (filename
, &st
))
1006 stat_fatal (filename
);
1007 for (p
= file_id_list
; p
; p
= p
->next
)
1008 if (p
->ino
== st
.st_ino
&& p
->dev
== st
.st_dev
)
1010 FATAL_ERROR ((0, 0, _("%s: file list already read"),
1011 quotearg_colon (filename
)));
1013 p
= xmalloc (sizeof *p
);
1014 p
->next
= file_id_list
;
1020 /* Default density numbers for [0-9][lmh] device specifications */
1022 #ifndef LOW_DENSITY_NUM
1023 # define LOW_DENSITY_NUM 0
1026 #ifndef MID_DENSITY_NUM
1027 # define MID_DENSITY_NUM 8
1030 #ifndef HIGH_DENSITY_NUM
1031 # define HIGH_DENSITY_NUM 16
1035 update_argv (const char *filename
, struct argp_state
*state
)
1038 size_t count
= 0, i
;
1042 bool is_stdin
= false;
1043 enum read_file_list_state read_state
;
1045 if (!strcmp (filename
, "-"))
1048 request_stdin ("-T");
1053 add_file_id (filename
);
1054 if ((fp
= fopen (filename
, "r")) == NULL
)
1055 open_fatal (filename
);
1058 while ((read_state
= read_name_from_file (fp
, &argv_stk
)) == file_list_success
)
1061 if (read_state
== file_list_zero
)
1065 WARN ((0, 0, N_("%s: file name read contains nul character"),
1066 quotearg_colon (filename
)));
1068 /* Prepare new stack contents */
1069 size
= obstack_object_size (&argv_stk
);
1070 p
= obstack_finish (&argv_stk
);
1071 for (; size
> 0; size
--, p
++)
1073 obstack_1grow (&argv_stk
, *p
);
1075 obstack_1grow (&argv_stk
, '\n');
1076 obstack_1grow (&argv_stk
, 0);
1079 /* Read rest of files using new filename terminator */
1080 filename_terminator
= 0;
1081 while (read_name_from_file (fp
, &argv_stk
) == file_list_success
)
1091 start
= obstack_finish (&argv_stk
);
1093 if (filename_terminator
== 0)
1094 for (p
= start
; *p
; p
+= strlen (p
) + 1)
1098 new_argc
= state
->argc
+ count
;
1099 new_argv
= xmalloc (sizeof (state
->argv
[0]) * (new_argc
+ 1));
1100 memcpy (new_argv
, state
->argv
, sizeof (state
->argv
[0]) * (state
->argc
+ 1));
1101 state
->argv
= new_argv
;
1102 memmove (&state
->argv
[state
->next
+ count
], &state
->argv
[state
->next
],
1103 (state
->argc
- state
->next
+ 1) * sizeof (state
->argv
[0]));
1105 state
->argc
= new_argc
;
1107 for (i
= state
->next
, p
= start
; *p
; p
+= strlen (p
) + 1, i
++)
1109 if (filename_terminator
== 0 && p
[0] == '-')
1110 state
->argv
[i
++] = "--add-file";
1117 tar_help (struct argp_state
*state
)
1119 argp_fmtstream_t fs
;
1120 state
->flags
|= ARGP_NO_EXIT
;
1121 argp_state_help (state
, state
->out_stream
,
1122 ARGP_HELP_STD_HELP
& ~ARGP_HELP_BUG_ADDR
);
1123 /* FIXME: use struct uparams.rmargin (from argp-help.c) instead of 79 */
1124 fs
= argp_make_fmtstream (state
->out_stream
, 0, 79, 0);
1126 argp_fmtstream_printf (fs
, "\n%s\n\n",
1127 _("Valid arguments for --quoting-style options are:"));
1128 tar_list_quoting_styles (fs
, " ");
1130 argp_fmtstream_puts (fs
, _("\n*This* tar defaults to:\n"));
1131 show_default_settings_fs (fs
);
1132 argp_fmtstream_putc (fs
, '\n');
1133 argp_fmtstream_printf (fs
, _("Report bugs to %s.\n"),
1134 argp_program_bug_address
);
1135 argp_fmtstream_free (fs
);
1139 parse_opt (int key
, char *arg
, struct argp_state
*state
)
1141 struct tar_args
*args
= state
->input
;
1146 /* File name or non-parsed option, because of ARGP_IN_ORDER */
1147 name_add_name (arg
, MAKE_INCL_OPTIONS (args
));
1148 args
->input_files
= true;
1152 set_subcommand_option (CAT_SUBCOMMAND
);
1158 if (! (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1159 && u
== (blocking_factor
= u
)
1160 && 0 < blocking_factor
1161 && u
== (record_size
= u
* BLOCKSIZE
) / BLOCKSIZE
))
1162 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1163 _("Invalid blocking factor")));
1168 /* Try to reblock input records. For reading 4.2BSD pipes. */
1170 /* It would surely make sense to exchange -B and -R, but it seems
1171 that -B has been used for a long while in Sun tar and most
1172 BSD-derived systems. This is a consequence of the block/record
1173 terminology confusion. */
1175 read_full_records_option
= true;
1179 set_subcommand_option (CREATE_SUBCOMMAND
);
1187 set_subcommand_option (DIFF_SUBCOMMAND
);
1191 if (archive_names
== allocated_archive_names
)
1192 archive_name_array
= x2nrealloc (archive_name_array
,
1193 &allocated_archive_names
,
1194 sizeof (archive_name_array
[0]));
1196 archive_name_array
[archive_names
++] = arg
;
1200 /* Since -F is only useful with -M, make it implied. Run this
1201 script at the end of each tape. */
1203 info_script_option
= arg
;
1204 multi_volume_option
= true;
1208 listed_incremental_option
= arg
;
1209 after_date_option
= true;
1213 /* We are making an incremental dump (FIXME: are we?); save
1214 directories at the beginning of the archive, and include in each
1215 directory its contents. */
1217 incremental_option
= true;
1221 /* Follow symbolic links. */
1222 dereference_option
= true;
1226 /* Ignore zero blocks (eofs). This can't be the default,
1227 because Unix tar writes two blocks of zeros, then pads out
1228 the record with garbage. */
1230 ignore_zeros_option
= true;
1235 _("Warning: the -I option is not supported;"
1236 " perhaps you meant -j or -T?")));
1240 set_use_compress_program_option ("bzip2");
1244 /* Don't replace existing files. */
1245 old_files_option
= KEEP_OLD_FILES
;
1249 starting_file_option
= true;
1253 case ONE_FILE_SYSTEM_OPTION
:
1254 /* When dumping directories, don't dump files/subdirectories
1255 that are on other filesystems. */
1256 one_file_system_option
= true;
1260 check_links_option
= 1;
1266 if (xstrtoumax (arg
, 0, 10, &u
, "") != LONGINT_OK
)
1267 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1268 _("Invalid tape length")));
1269 tape_length_option
= 1024 * (tarlong
) u
;
1270 multi_volume_option
= true;
1275 touch_option
= true;
1279 /* Make multivolume archive: when we can't write any more into
1280 the archive, re-open it, and continue writing. */
1282 multi_volume_option
= true;
1286 get_date_or_file (args
, "--mtime", arg
, &mtime_option
);
1287 set_mtime_option
= true;
1291 seekable_archive
= true;
1295 after_date_option
= true;
1298 case NEWER_MTIME_OPTION
:
1299 if (NEWER_OPTION_INITIALIZED (newer_mtime_option
))
1300 USAGE_ERROR ((0, 0, _("More than one threshold date")));
1301 get_date_or_file (args
,
1302 key
== NEWER_MTIME_OPTION
? "--newer-mtime"
1303 : "--after-date", arg
, &newer_mtime_option
);
1307 args
->o_option
= true;
1311 to_stdout_option
= true;
1315 same_permissions_option
= true;
1319 absolute_names_option
= true;
1323 set_subcommand_option (APPEND_SUBCOMMAND
);
1327 /* Print block numbers for debugging bad tar archives. */
1329 /* It would surely make sense to exchange -B and -R, but it seems
1330 that -B has been used for a long while in Sun tar ans most
1331 BSD-derived systems. This is a consequence of the block/record
1332 terminology confusion. */
1334 block_number_option
= true;
1338 /* Names to extr are sorted. */
1340 same_order_option
= true;
1344 sparse_option
= true;
1347 case SPARSE_VERSION_OPTION
:
1350 tar_sparse_major
= strtoul (arg
, &p
, 10);
1354 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1355 tar_sparse_minor
= strtoul (p
+ 1, &p
, 10);
1357 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1363 set_subcommand_option (LIST_SUBCOMMAND
);
1367 case TEST_LABEL_OPTION
:
1368 set_subcommand_option (LIST_SUBCOMMAND
);
1369 test_label_option
= true;
1373 update_argv (arg
, state
);
1374 /* Indicate we've been given -T option. This is for backward
1375 compatibility only, so that `tar cfT archive /dev/null will
1377 files_from_option
= true;
1381 set_subcommand_option (UPDATE_SUBCOMMAND
);
1385 old_files_option
= UNLINK_FIRST_OLD_FILES
;
1397 volume_label_option
= arg
;
1401 interactive_option
= true;
1405 verify_option
= true;
1409 set_subcommand_option (EXTRACT_SUBCOMMAND
);
1413 if (add_exclude_file (add_exclude
, excluded
, arg
,
1414 MAKE_EXCL_OPTIONS (args
), '\n')
1418 FATAL_ERROR ((0, e
, "%s", quotearg_colon (arg
)));
1423 set_use_compress_program_option ("gzip");
1427 set_use_compress_program_option ("compress");
1430 case ANCHORED_OPTION
:
1431 args
->matching_flags
|= EXCLUDE_ANCHORED
;
1434 case ATIME_PRESERVE_OPTION
:
1435 atime_preserve_option
=
1437 ? XARGMATCH ("--atime-preserve", arg
,
1438 atime_preserve_args
, atime_preserve_types
)
1439 : replace_atime_preserve
);
1440 if (! O_NOATIME
&& atime_preserve_option
== system_atime_preserve
)
1442 _("--atime-preserve='system' is not supported"
1443 " on this platform")));
1446 case CHECKPOINT_OPTION
:
1453 checkpoint_style
= checkpoint_dot
;
1456 checkpoint_option
= strtoul (arg
, &p
, 0);
1459 _("--checkpoint value is not an integer")));
1462 checkpoint_option
= 10;
1466 backup_option
= true;
1468 args
->version_control_string
= arg
;
1471 case DELAY_DIRECTORY_RESTORE_OPTION
:
1472 delay_directory_restore_option
= true;
1475 case NO_DELAY_DIRECTORY_RESTORE_OPTION
:
1476 delay_directory_restore_option
= false;
1480 set_subcommand_option (DELETE_SUBCOMMAND
);
1483 case EXCLUDE_OPTION
:
1484 add_exclude (excluded
, arg
, MAKE_EXCL_OPTIONS (args
));
1487 case EXCLUDE_CACHES_OPTION
:
1488 exclude_caches_option
= true;
1491 case FORCE_LOCAL_OPTION
:
1492 force_local_option
= true;
1496 set_archive_format (arg
);
1499 case INDEX_FILE_OPTION
:
1500 index_file_name
= arg
;
1503 case IGNORE_CASE_OPTION
:
1504 args
->matching_flags
|= FNM_CASEFOLD
;
1507 case IGNORE_COMMAND_ERROR_OPTION
:
1508 ignore_command_error_option
= true;
1511 case IGNORE_FAILED_READ_OPTION
:
1512 ignore_failed_read_option
= true;
1515 case KEEP_NEWER_FILES_OPTION
:
1516 old_files_option
= KEEP_NEWER_FILES
;
1520 if (! (strlen (arg
) < GNAME_FIELD_SIZE
1521 && gname_to_gid (arg
, &group_option
)))
1524 if (xstrtoumax (arg
, 0, 10, &g
, "") == LONGINT_OK
1528 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1529 _("%s: Invalid group")));
1534 mode_option
= mode_compile (arg
);
1536 FATAL_ERROR ((0, 0, _("Invalid mode given on option")));
1537 initial_umask
= umask (0);
1538 umask (initial_umask
);
1541 case NO_ANCHORED_OPTION
:
1542 args
->include_anchored
= 0; /* Clear the default for comman line args */
1543 args
->matching_flags
&= ~ EXCLUDE_ANCHORED
;
1546 case NO_IGNORE_CASE_OPTION
:
1547 args
->matching_flags
&= ~ FNM_CASEFOLD
;
1550 case NO_IGNORE_COMMAND_ERROR_OPTION
:
1551 ignore_command_error_option
= false;
1554 case NO_OVERWRITE_DIR_OPTION
:
1555 old_files_option
= NO_OVERWRITE_DIR_OLD_FILES
;
1558 case NO_QUOTE_CHARS_OPTION
:
1560 set_char_quoting (NULL
, *arg
, 0);
1563 case NO_WILDCARDS_OPTION
:
1564 args
->wildcards
= disable_wildcards
;
1567 case NO_WILDCARDS_MATCH_SLASH_OPTION
:
1568 args
->matching_flags
|= FNM_FILE_NAME
;
1572 filename_terminator
= '\0';
1575 case NUMERIC_OWNER_OPTION
:
1576 numeric_owner_option
= true;
1579 case OCCURRENCE_OPTION
:
1581 occurrence_option
= 1;
1585 if (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
)
1586 occurrence_option
= u
;
1588 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1589 _("Invalid number")));
1593 case OVERWRITE_DIR_OPTION
:
1594 old_files_option
= DEFAULT_OLD_FILES
;
1597 case OVERWRITE_OPTION
:
1598 old_files_option
= OVERWRITE_OLD_FILES
;
1602 if (! (strlen (arg
) < UNAME_FIELD_SIZE
1603 && uname_to_uid (arg
, &owner_option
)))
1606 if (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1610 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1611 _("Invalid owner")));
1615 case QUOTE_CHARS_OPTION
:
1617 set_char_quoting (NULL
, *arg
, 1);
1620 case QUOTING_STYLE_OPTION
:
1621 tar_set_quoting_style (arg
);
1625 args
->pax_option
= true;
1626 xheader_set_option (arg
);
1630 set_archive_format ("posix");
1633 case PRESERVE_OPTION
:
1634 /* FIXME: What it is good for? */
1635 same_permissions_option
= true;
1636 same_order_option
= true;
1639 case RECORD_SIZE_OPTION
:
1642 if (! (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1643 && u
== (size_t) u
))
1644 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1645 _("Invalid record size")));
1647 if (record_size
% BLOCKSIZE
!= 0)
1648 USAGE_ERROR ((0, 0, _("Record size must be a multiple of %d."),
1650 blocking_factor
= record_size
/ BLOCKSIZE
;
1654 case RECURSIVE_UNLINK_OPTION
:
1655 recursive_unlink_option
= true;
1658 case REMOVE_FILES_OPTION
:
1659 remove_files_option
= true;
1662 case RESTRICT_OPTION
:
1663 restrict_option
= true;
1666 case RMT_COMMAND_OPTION
:
1670 case RSH_COMMAND_OPTION
:
1671 rsh_command_option
= arg
;
1674 case SHOW_DEFAULTS_OPTION
:
1675 show_default_settings (stdout
);
1679 case STRIP_COMPONENTS_OPTION
:
1682 if (! (xstrtoumax (arg
, 0, 10, &u
, "") == LONGINT_OK
1683 && u
== (size_t) u
))
1684 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg
),
1685 _("Invalid number of elements")));
1686 strip_name_components
= u
;
1690 case SHOW_OMITTED_DIRS_OPTION
:
1691 show_omitted_dirs_option
= true;
1694 case SHOW_TRANSFORMED_NAMES_OPTION
:
1695 show_transformed_names_option
= true;
1699 backup_option
= true;
1700 args
->backup_suffix_string
= arg
;
1703 case TO_COMMAND_OPTION
:
1704 if (to_command_option
)
1705 USAGE_ERROR ((0, 0, _("Only one --to-command option allowed")));
1706 to_command_option
= arg
;
1711 set_stat_signal (arg
);
1713 totals_option
= true;
1716 case TRANSFORM_OPTION
:
1717 set_transform_expr (arg
);
1720 case USE_COMPRESS_PROGRAM_OPTION
:
1721 set_use_compress_program_option (arg
);
1724 case VOLNO_FILE_OPTION
:
1725 volno_file_option
= arg
;
1728 case WILDCARDS_OPTION
:
1729 args
->wildcards
= enable_wildcards
;
1732 case WILDCARDS_MATCH_SLASH_OPTION
:
1733 args
->matching_flags
&= ~ FNM_FILE_NAME
;
1736 case NO_RECURSION_OPTION
:
1737 recursion_option
= 0;
1740 case NO_SAME_OWNER_OPTION
:
1741 same_owner_option
= -1;
1744 case NO_SAME_PERMISSIONS_OPTION
:
1745 same_permissions_option
= -1;
1748 case RECURSION_OPTION
:
1749 recursion_option
= FNM_LEADING_DIR
;
1752 case SAME_OWNER_OPTION
:
1753 same_owner_option
= 1;
1756 case UNQUOTE_OPTION
:
1757 unquote_option
= true;
1760 case NO_UNQUOTE_OPTION
:
1761 unquote_option
= false;
1773 #ifdef DEVICE_PREFIX
1775 int device
= key
- '0';
1777 static char buf
[sizeof DEVICE_PREFIX
+ 10];
1781 argp_error (state
, _("Malformed density argument: %s"), quote (arg
));
1783 strcpy (buf
, DEVICE_PREFIX
);
1784 cursor
= buf
+ strlen (buf
);
1786 #ifdef DENSITY_LETTER
1788 sprintf (cursor
, "%d%c", device
, arg
[0]);
1790 #else /* not DENSITY_LETTER */
1795 device
+= LOW_DENSITY_NUM
;
1799 device
+= MID_DENSITY_NUM
;
1803 device
+= HIGH_DENSITY_NUM
;
1807 argp_error (state
, _("Unknown density: `%c'"), arg
[0]);
1809 sprintf (cursor
, "%d", device
);
1811 #endif /* not DENSITY_LETTER */
1813 if (archive_names
== allocated_archive_names
)
1814 archive_name_array
= x2nrealloc (archive_name_array
,
1815 &allocated_archive_names
,
1816 sizeof (archive_name_array
[0]));
1817 archive_name_array
[archive_names
++] = xstrdup (buf
);
1821 #else /* not DEVICE_PREFIX */
1824 _("Options `-[0-7][lmh]' not supported by *this* tar"));
1826 #endif /* not DEVICE_PREFIX */
1834 argp_state_help (state
, state
->out_stream
, ARGP_HELP_USAGE
);
1838 case VERSION_OPTION
:
1839 version_etc (state
->out_stream
, "tar", PACKAGE_NAME
, VERSION
,
1840 "John Gilmore", "Jay Fenlason", (char *) NULL
);
1845 _argp_hang
= atoi (arg
? arg
: "3600");
1846 while (_argp_hang
-- > 0)
1851 return ARGP_ERR_UNKNOWN
;
1856 static struct argp argp
= {
1869 argp_help (&argp
, stderr
, ARGP_HELP_SEE
, (char*) program_name
);
1874 /* Parse the options for tar. */
1876 static struct argp_option
*
1877 find_argp_option (struct argp_option
*options
, int letter
)
1880 !(options
->name
== NULL
1881 && options
->key
== 0
1882 && options
->arg
== 0
1883 && options
->flags
== 0
1884 && options
->doc
== NULL
); options
++)
1885 if (options
->key
== letter
)
1891 decode_options (int argc
, char **argv
)
1894 struct tar_args args
;
1896 /* Set some default option values. */
1897 args
.textual_date
= NULL
;
1898 args
.wildcards
= default_wildcards
;
1899 args
.matching_flags
= 0;
1900 args
.include_anchored
= EXCLUDE_ANCHORED
;
1901 args
.o_option
= false;
1902 args
.pax_option
= false;
1903 args
.backup_suffix_string
= getenv ("SIMPLE_BACKUP_SUFFIX");
1904 args
.version_control_string
= 0;
1905 args
.input_files
= false;
1907 subcommand_option
= UNKNOWN_SUBCOMMAND
;
1908 archive_format
= DEFAULT_FORMAT
;
1909 blocking_factor
= DEFAULT_BLOCKING
;
1910 record_size
= DEFAULT_BLOCKING
* BLOCKSIZE
;
1911 excluded
= new_exclude ();
1912 newer_mtime_option
.tv_sec
= TYPE_MINIMUM (time_t);
1913 newer_mtime_option
.tv_nsec
= -1;
1914 recursion_option
= FNM_LEADING_DIR
;
1915 unquote_option
= true;
1916 tar_sparse_major
= 1;
1917 tar_sparse_minor
= 0;
1922 /* Convert old-style tar call by exploding option element and rearranging
1923 options accordingly. */
1925 if (argc
> 1 && argv
[1][0] != '-')
1927 int new_argc
; /* argc value for rearranged arguments */
1928 char **new_argv
; /* argv value for rearranged arguments */
1929 char *const *in
; /* cursor into original argv */
1930 char **out
; /* cursor into rearranged argv */
1931 const char *letter
; /* cursor into old option letters */
1932 char buffer
[3]; /* constructed option buffer */
1934 /* Initialize a constructed option. */
1939 /* Allocate a new argument array, and copy program name in it. */
1941 new_argc
= argc
- 1 + strlen (argv
[1]);
1942 new_argv
= xmalloc ((new_argc
+ 1) * sizeof (char *));
1947 /* Copy each old letter option as a separate option, and have the
1948 corresponding argument moved next to it. */
1950 for (letter
= *in
++; *letter
; letter
++)
1952 struct argp_option
*opt
;
1954 buffer
[1] = *letter
;
1955 *out
++ = xstrdup (buffer
);
1956 opt
= find_argp_option (options
, *letter
);
1957 if (opt
&& opt
->arg
)
1959 if (in
< argv
+ argc
)
1962 USAGE_ERROR ((0, 0, _("Old option `%c' requires an argument."),
1967 /* Copy all remaining options. */
1969 while (in
< argv
+ argc
)
1973 /* Replace the old option list by the new one. */
1979 /* Parse all options and non-options as they appear. */
1981 prepend_default_options (getenv ("TAR_OPTIONS"), &argc
, &argv
);
1983 if (argp_parse (&argp
, argc
, argv
, ARGP_IN_ORDER
|ARGP_NO_HELP
,
1985 exit (TAREXIT_FAILURE
);
1988 /* Special handling for 'o' option:
1990 GNU tar used to say "output old format".
1991 UNIX98 tar says don't chown files after extracting (we use
1992 "--no-same-owner" for this).
1994 The old GNU tar semantics is retained when used with --create
1995 option, otherwise UNIX98 semantics is assumed */
1999 if (subcommand_option
== CREATE_SUBCOMMAND
)
2001 /* GNU Tar <= 1.13 compatibility */
2002 set_archive_format ("v7");
2006 /* UNIX98 compatibility */
2007 same_owner_option
= -1;
2011 /* Handle operands after any "--" argument. */
2012 for (; index
< argc
; index
++)
2014 name_add_name (argv
[index
], MAKE_INCL_OPTIONS (&args
));
2015 args
.input_files
= true;
2018 /* Warn about implicit use of the wildcards in command line arguments.
2020 warn_regex_usage
= args
.wildcards
== default_wildcards
;
2022 /* Derive option values and check option consistency. */
2024 if (archive_format
== DEFAULT_FORMAT
)
2026 if (args
.pax_option
)
2027 archive_format
= POSIX_FORMAT
;
2029 archive_format
= DEFAULT_ARCHIVE_FORMAT
;
2032 if ((volume_label_option
&& subcommand_option
== CREATE_SUBCOMMAND
)
2033 || incremental_option
2034 || multi_volume_option
2036 assert_format (FORMAT_MASK (OLDGNU_FORMAT
)
2037 | FORMAT_MASK (GNU_FORMAT
)
2038 | FORMAT_MASK (POSIX_FORMAT
));
2040 if (multi_volume_option
2041 && archive_format
== POSIX_FORMAT
2042 && subcommand_option
== CREATE_SUBCOMMAND
2043 && !tape_length_option
)
2045 _("creating multi-volume archives in posix format requires using --tape-length (-L) option")));
2047 if (occurrence_option
)
2049 if (!args
.input_files
)
2051 _("--occurrence is meaningless without a file list")));
2052 if (subcommand_option
!= DELETE_SUBCOMMAND
2053 && subcommand_option
!= DIFF_SUBCOMMAND
2054 && subcommand_option
!= EXTRACT_SUBCOMMAND
2055 && subcommand_option
!= LIST_SUBCOMMAND
)
2057 _("--occurrence cannot be used in the requested operation mode")));
2060 if (seekable_archive
&& subcommand_option
== DELETE_SUBCOMMAND
)
2062 /* The current code in delete.c is based on the assumption that
2063 skip_member() reads all data from the archive. So, we should
2064 make sure it won't use seeks. On the other hand, the same code
2065 depends on the ability to backspace a record in the archive,
2066 so setting seekable_archive to false is technically incorrect.
2067 However, it is tested only in skip_member(), so it's not a
2069 seekable_archive
= false;
2072 if (archive_names
== 0)
2074 /* If no archive file name given, try TAPE from the environment, or
2075 else, DEFAULT_ARCHIVE from the configuration process. */
2078 archive_name_array
[0] = getenv ("TAPE");
2079 if (! archive_name_array
[0])
2080 archive_name_array
[0] = DEFAULT_ARCHIVE
;
2083 /* Allow multiple archives only with `-M'. */
2085 if (archive_names
> 1 && !multi_volume_option
)
2087 _("Multiple archive files require `-M' option")));
2089 if (listed_incremental_option
2090 && NEWER_OPTION_INITIALIZED (newer_mtime_option
))
2092 _("Cannot combine --listed-incremental with --newer")));
2094 if (volume_label_option
)
2096 if (archive_format
== GNU_FORMAT
|| archive_format
== OLDGNU_FORMAT
)
2098 size_t volume_label_max_len
=
2099 (sizeof current_header
->header
.name
2100 - 1 /* for trailing '\0' */
2101 - (multi_volume_option
2102 ? (sizeof " Volume "
2103 - 1 /* for null at end of " Volume " */
2104 + INT_STRLEN_BOUND (int) /* for volume number */
2105 - 1 /* for sign, as 0 <= volno */)
2107 if (volume_label_max_len
< strlen (volume_label_option
))
2109 ngettext ("%s: Volume label is too long (limit is %lu byte)",
2110 "%s: Volume label is too long (limit is %lu bytes)",
2111 volume_label_max_len
),
2112 quotearg_colon (volume_label_option
),
2113 (unsigned long) volume_label_max_len
));
2116 Label length in PAX format is limited by the volume size. */
2121 if (multi_volume_option
)
2122 USAGE_ERROR ((0, 0, _("Cannot verify multi-volume archives")));
2123 if (use_compress_program_option
)
2124 USAGE_ERROR ((0, 0, _("Cannot verify compressed archives")));
2127 if (use_compress_program_option
)
2129 if (multi_volume_option
)
2130 USAGE_ERROR ((0, 0, _("Cannot use multi-volume compressed archives")));
2131 if (subcommand_option
== UPDATE_SUBCOMMAND
2132 || subcommand_option
== APPEND_SUBCOMMAND
2133 || subcommand_option
== DELETE_SUBCOMMAND
)
2134 USAGE_ERROR ((0, 0, _("Cannot update compressed archives")));
2135 if (subcommand_option
== CAT_SUBCOMMAND
)
2136 USAGE_ERROR ((0, 0, _("Cannot concatenate compressed archives")));
2139 /* It is no harm to use --pax-option on non-pax archives in archive
2140 reading mode. It may even be useful, since it allows to override
2141 file attributes from tar headers. Therefore I allow such usage.
2144 && archive_format
!= POSIX_FORMAT
2145 && (subcommand_option
!= EXTRACT_SUBCOMMAND
2146 || subcommand_option
!= DIFF_SUBCOMMAND
2147 || subcommand_option
!= LIST_SUBCOMMAND
))
2148 USAGE_ERROR ((0, 0, _("--pax-option can be used only on POSIX archives")));
2150 /* If ready to unlink hierarchies, so we are for simpler files. */
2151 if (recursive_unlink_option
)
2152 old_files_option
= UNLINK_FIRST_OLD_FILES
;
2155 if (test_label_option
)
2157 /* --test-label is silent if the user has specified the label name to
2159 if (!args
.input_files
)
2162 else if (utc_option
)
2165 /* Forbid using -c with no input files whatsoever. Check that `-f -',
2166 explicit or implied, is used correctly. */
2168 switch (subcommand_option
)
2170 case CREATE_SUBCOMMAND
:
2171 if (!args
.input_files
&& !files_from_option
)
2173 _("Cowardly refusing to create an empty archive")));
2176 case EXTRACT_SUBCOMMAND
:
2177 case LIST_SUBCOMMAND
:
2178 case DIFF_SUBCOMMAND
:
2179 for (archive_name_cursor
= archive_name_array
;
2180 archive_name_cursor
< archive_name_array
+ archive_names
;
2181 archive_name_cursor
++)
2182 if (!strcmp (*archive_name_cursor
, "-"))
2183 request_stdin ("-f");
2186 case CAT_SUBCOMMAND
:
2187 case UPDATE_SUBCOMMAND
:
2188 case APPEND_SUBCOMMAND
:
2189 for (archive_name_cursor
= archive_name_array
;
2190 archive_name_cursor
< archive_name_array
+ archive_names
;
2191 archive_name_cursor
++)
2192 if (!strcmp (*archive_name_cursor
, "-"))
2194 _("Options `-Aru' are incompatible with `-f -'")));
2200 archive_name_cursor
= archive_name_array
;
2202 /* Prepare for generating backup names. */
2204 if (args
.backup_suffix_string
)
2205 simple_backup_suffix
= xstrdup (args
.backup_suffix_string
);
2209 backup_type
= xget_version ("--backup", args
.version_control_string
);
2210 /* No backup is needed either if explicitely disabled or if
2211 the extracted files are not being written to disk. */
2212 if (backup_type
== no_backups
|| EXTRACT_OVER_PIPE
)
2213 backup_option
= false;
2217 report_textual_dates (&args
);
2223 /* Main routine for tar. */
2225 main (int argc
, char **argv
)
2228 program_name
= argv
[0];
2230 setlocale (LC_ALL
, "");
2231 bindtextdomain (PACKAGE
, LOCALEDIR
);
2232 textdomain (PACKAGE
);
2234 exit_failure
= TAREXIT_FAILURE
;
2235 exit_status
= TAREXIT_SUCCESS
;
2236 filename_terminator
= '\n';
2237 set_quoting_style (0, DEFAULT_QUOTING_STYLE
);
2239 /* Make sure we have first three descriptors available */
2242 /* Pre-allocate a few structures. */
2244 allocated_archive_names
= 10;
2245 archive_name_array
=
2246 xmalloc (sizeof (const char *) * allocated_archive_names
);
2249 obstack_init (&argv_stk
);
2252 /* System V fork+wait does not work if SIGCHLD is ignored. */
2253 signal (SIGCHLD
, SIG_DFL
);
2256 /* Decode options. */
2258 decode_options (argc
, argv
);
2261 /* Main command execution. */
2263 if (volno_file_option
)
2264 init_volume_number ();
2266 switch (subcommand_option
)
2268 case UNKNOWN_SUBCOMMAND
:
2270 _("You must specify one of the `-Acdtrux' options")));
2272 case CAT_SUBCOMMAND
:
2273 case UPDATE_SUBCOMMAND
:
2274 case APPEND_SUBCOMMAND
:
2278 case DELETE_SUBCOMMAND
:
2279 delete_archive_members ();
2282 case CREATE_SUBCOMMAND
:
2286 case EXTRACT_SUBCOMMAND
:
2288 read_and (extract_archive
);
2290 /* FIXME: should extract_finish () even if an ordinary signal is
2296 case LIST_SUBCOMMAND
:
2297 read_and (list_archive
);
2300 case DIFF_SUBCOMMAND
:
2302 read_and (diff_archive
);
2307 print_total_stats ();
2309 if (check_links_option
)
2312 if (volno_file_option
)
2313 closeout_volume_number ();
2315 /* Dispose of allocated memory, and return. */
2317 free (archive_name_array
);
2320 if (stdlis
== stdout
)
2323 if (exit_status
== TAREXIT_FAILURE
)
2324 error (0, 0, _("Error exit delayed from previous errors"));
2325 if (ferror (stderr
) || fclose (stderr
) != 0)
2326 exit_status
= TAREXIT_FAILURE
;
2331 tar_stat_init (struct tar_stat_info
*st
)
2333 memset (st
, 0, sizeof (*st
));
2337 tar_stat_destroy (struct tar_stat_info
*st
)
2339 free (st
->orig_file_name
);
2340 free (st
->file_name
);
2341 free (st
->link_name
);
2344 free (st
->sparse_map
);
2346 memset (st
, 0, sizeof (*st
));
2349 /* Format mask for all available formats that support nanosecond
2350 timestamp resolution. */
2351 #define NS_PRECISION_FORMAT_MASK FORMAT_MASK (POSIX_FORMAT)
2353 /* Same as timespec_cmp, but ignore nanoseconds if current archive
2354 format does not provide sufficient resolution. */
2356 tar_timespec_cmp (struct timespec a
, struct timespec b
)
2358 if (!(FORMAT_MASK (current_format
) & NS_PRECISION_FORMAT_MASK
))
2359 a
.tv_nsec
= b
.tv_nsec
= 0;
2360 return timespec_cmp (a
, b
);