1 /* A tar (tape archiver) program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
4 2001, 2003, 2004 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 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
28 #if ! defined SIGCHLD && defined SIGCLD
29 # define SIGCHLD SIGCLD
32 /* The following causes "common.h" to produce definitions of all the global
33 variables, rather than just "extern" declarations of them. GNU tar does
34 depend on the system loader to preset all GLOBAL variables to neutral (or
35 zero) values; explicit initialization is usually not done. */
40 #include <localedir.h>
45 /* Local declarations. */
47 #ifndef DEFAULT_ARCHIVE_FORMAT
48 # define DEFAULT_ARCHIVE_FORMAT GNU_FORMAT
51 #ifndef DEFAULT_ARCHIVE
52 # define DEFAULT_ARCHIVE "tar.out"
55 #ifndef DEFAULT_BLOCKING
56 # define DEFAULT_BLOCKING 20
62 /* Name of option using stdin. */
63 static const char *stdin_used_by
;
65 /* Doesn't return if stdin already requested. */
67 request_stdin (const char *option
)
70 USAGE_ERROR ((0, 0, _("Options `-%s' and `-%s' both want standard input"),
71 stdin_used_by
, option
));
73 stdin_used_by
= option
;
76 /* Returns true if and only if the user typed 'y' or 'Y'. */
78 confirm (const char *message_action
, const char *message_name
)
80 static FILE *confirm_file
;
81 static int confirm_file_EOF
;
85 if (archive
== 0 || stdin_used_by
)
87 confirm_file
= fopen (TTY_NAME
, "r");
89 open_fatal (TTY_NAME
);
98 fprintf (stdlis
, "%s %s?", message_action
, quote (message_name
));
102 int reply
= confirm_file_EOF
? EOF
: getc (confirm_file
);
105 for (character
= reply
;
107 character
= getc (confirm_file
))
108 if (character
== EOF
)
110 confirm_file_EOF
= 1;
111 fputc ('\n', stdlis
);
115 return reply
== 'y' || reply
== 'Y';
119 static struct fmttab
{
121 enum archive_format fmt
;
124 { "oldgnu", OLDGNU_FORMAT
},
125 { "ustar", USTAR_FORMAT
},
126 { "posix", POSIX_FORMAT
},
127 #if 0 /* not fully supported yet */
128 { "star", STAR_FORMAT
},
130 { "gnu", GNU_FORMAT
},
135 set_archive_format (char const *name
)
137 struct fmttab
const *p
;
139 for (p
= fmttab
; strcmp (p
->name
, name
) != 0; )
141 USAGE_ERROR ((0, 0, _("%s: Invalid archive format"),
142 quotearg_colon (name
)));
144 archive_format
= p
->fmt
;
148 archive_format_string (enum archive_format fmt
)
150 struct fmttab
const *p
;
152 for (p
= fmttab
; p
->name
; p
++)
158 #define FORMAT_MASK(n) (1<<(n))
161 assert_format(unsigned fmt_mask
)
163 if ((FORMAT_MASK(archive_format
) & fmt_mask
) == 0)
165 _("GNU features wanted on incompatible archive format")));
172 /* For long options that unconditionally set a single flag, we have getopt
173 do it. For the others, we share the code for the equivalent short
174 named option, the name of which is stored in the otherwise-unused `val'
175 field of the `struct option'; for long options that have no equivalent
176 short option, we use non-characters as pseudo short options,
177 starting at CHAR_MAX + 1 and going upwards. */
181 ANCHORED_OPTION
= CHAR_MAX
+ 1,
182 ATIME_PRESERVE_OPTION
,
191 IGNORE_FAILED_READ_OPTION
,
193 KEEP_NEWER_FILES_OPTION
,
197 NO_IGNORE_CASE_OPTION
,
198 NO_OVERWRITE_DIR_OPTION
,
200 NO_WILDCARDS_MATCH_SLASH_OPTION
,
202 NUMERIC_OWNER_OPTION
,
210 RECURSIVE_UNLINK_OPTION
,
214 SHOW_DEFAULTS_OPTION
,
215 SHOW_OMITTED_DIRS_OPTION
,
216 STRIP_COMPONENTS_OPTION
,
219 USE_COMPRESS_PROGRAM_OPTION
,
223 WILDCARDS_MATCH_SLASH_OPTION
226 /* If nonzero, display usage information and exit. */
227 static int show_help
;
229 /* If nonzero, print the version on standard output and exit. */
230 static int show_version
;
232 static struct option long_options
[] =
234 {"absolute-names", no_argument
, 0, 'P'},
235 {"after-date", required_argument
, 0, 'N'},
236 {"anchored", no_argument
, 0, ANCHORED_OPTION
},
237 {"append", no_argument
, 0, 'r'},
238 {"atime-preserve", no_argument
, 0, ATIME_PRESERVE_OPTION
},
239 {"backup", optional_argument
, 0, BACKUP_OPTION
},
240 {"block-number", no_argument
, 0, 'R'},
241 {"blocking-factor", required_argument
, 0, 'b'},
242 {"bzip2", no_argument
, 0, 'j'},
243 {"catenate", no_argument
, 0, 'A'},
244 {"checkpoint", no_argument
, 0, CHECKPOINT_OPTION
},
245 {"check-links", no_argument
, &check_links_option
, 1},
246 {"compare", no_argument
, 0, 'd'},
247 {"compress", no_argument
, 0, 'Z'},
248 {"concatenate", no_argument
, 0, 'A'},
249 {"confirmation", no_argument
, 0, 'w'},
250 /* FIXME: --selective as a synonym for --confirmation? */
251 {"create", no_argument
, 0, 'c'},
252 {"delete", no_argument
, 0, DELETE_OPTION
},
253 {"dereference", no_argument
, 0, 'h'},
254 {"diff", no_argument
, 0, 'd'},
255 {"directory", required_argument
, 0, 'C'},
256 {"exclude", required_argument
, 0, EXCLUDE_OPTION
},
257 {"exclude-from", required_argument
, 0, 'X'},
258 {"extract", no_argument
, 0, 'x'},
259 {"file", required_argument
, 0, 'f'},
260 {"files-from", required_argument
, 0, 'T'},
261 {"force-local", no_argument
, 0, FORCE_LOCAL_OPTION
},
262 {"format", required_argument
, 0, FORMAT_OPTION
},
263 {"get", no_argument
, 0, 'x'},
264 {"group", required_argument
, 0, GROUP_OPTION
},
265 {"gunzip", no_argument
, 0, 'z'},
266 {"gzip", no_argument
, 0, 'z'},
267 {"help", no_argument
, &show_help
, 1},
268 {"ignore-case", no_argument
, 0, IGNORE_CASE_OPTION
},
269 {"ignore-failed-read", no_argument
, 0, IGNORE_FAILED_READ_OPTION
},
270 {"ignore-zeros", no_argument
, 0, 'i'},
271 /* FIXME: --ignore-end as a new name for --ignore-zeros? */
272 {"incremental", no_argument
, 0, 'G'},
273 {"index-file", required_argument
, 0, INDEX_FILE_OPTION
},
274 {"info-script", required_argument
, 0, 'F'},
275 {"interactive", no_argument
, 0, 'w'},
276 {"keep-newer-files", no_argument
, 0, KEEP_NEWER_FILES_OPTION
},
277 {"keep-old-files", no_argument
, 0, 'k'},
278 {"label", required_argument
, 0, 'V'},
279 {"list", no_argument
, 0, 't'},
280 {"listed-incremental", required_argument
, 0, 'g'},
281 {"mode", required_argument
, 0, MODE_OPTION
},
282 {"multi-volume", no_argument
, 0, 'M'},
283 {"new-volume-script", required_argument
, 0, 'F'},
284 {"newer", required_argument
, 0, 'N'},
285 {"newer-mtime", required_argument
, 0, NEWER_MTIME_OPTION
},
286 {"null", no_argument
, 0, NULL_OPTION
},
287 {"no-anchored", no_argument
, 0, NO_ANCHORED_OPTION
},
288 {"no-ignore-case", no_argument
, 0, NO_IGNORE_CASE_OPTION
},
289 {"no-overwrite-dir", no_argument
, 0, NO_OVERWRITE_DIR_OPTION
},
290 {"no-wildcards", no_argument
, 0, NO_WILDCARDS_OPTION
},
291 {"no-wildcards-match-slash", no_argument
, 0, NO_WILDCARDS_MATCH_SLASH_OPTION
},
292 {"no-recursion", no_argument
, &recursion_option
, 0},
293 {"no-same-owner", no_argument
, &same_owner_option
, -1},
294 {"no-same-permissions", no_argument
, &same_permissions_option
, -1},
295 {"numeric-owner", no_argument
, 0, NUMERIC_OWNER_OPTION
},
296 {"occurrence", optional_argument
, 0, OCCURRENCE_OPTION
},
297 {"old-archive", no_argument
, 0, 'o'},
298 {"one-file-system", no_argument
, 0, 'l'},
299 {"overwrite", no_argument
, 0, OVERWRITE_OPTION
},
300 {"owner", required_argument
, 0, OWNER_OPTION
},
301 {"pax-option", required_argument
, 0, PAX_OPTION
},
302 {"portability", no_argument
, 0, 'o'},
303 {"posix", no_argument
, 0, POSIX_OPTION
},
304 {"preserve", no_argument
, 0, PRESERVE_OPTION
},
305 {"preserve-order", no_argument
, 0, 's'},
306 {"preserve-permissions", no_argument
, 0, 'p'},
307 {"recursion", no_argument
, &recursion_option
, FNM_LEADING_DIR
},
308 {"recursive-unlink", no_argument
, 0, RECURSIVE_UNLINK_OPTION
},
309 {"read-full-records", no_argument
, 0, 'B'},
310 /* FIXME: --partial-blocks might be a synonym for --read-full-records? */
311 {"record-size", required_argument
, 0, RECORD_SIZE_OPTION
},
312 {"remove-files", no_argument
, 0, REMOVE_FILES_OPTION
},
313 {"rmt-command", required_argument
, 0, RMT_COMMAND_OPTION
},
314 {"rsh-command", required_argument
, 0, RSH_COMMAND_OPTION
},
315 {"same-order", no_argument
, 0, 's'},
316 {"same-owner", no_argument
, &same_owner_option
, 1},
317 {"same-permissions", no_argument
, 0, 'p'},
318 {"show-defaults", no_argument
, 0, SHOW_DEFAULTS_OPTION
},
319 {"show-omitted-dirs", no_argument
, 0, SHOW_OMITTED_DIRS_OPTION
},
320 {"sparse", no_argument
, 0, 'S'},
321 {"starting-file", required_argument
, 0, 'K'},
322 {"strip-components", required_argument
, 0, STRIP_COMPONENTS_OPTION
},
323 {"suffix", required_argument
, 0, SUFFIX_OPTION
},
324 {"tape-length", required_argument
, 0, 'L'},
325 {"to-stdout", no_argument
, 0, 'O'},
326 {"totals", no_argument
, 0, TOTALS_OPTION
},
327 {"touch", no_argument
, 0, 'm'},
328 {"uncompress", no_argument
, 0, 'Z'},
329 {"ungzip", no_argument
, 0, 'z'},
330 {"unlink-first", no_argument
, 0, 'U'},
331 {"update", no_argument
, 0, 'u'},
332 {"utc", no_argument
, 0, UTC_OPTION
},
333 {"use-compress-program", required_argument
, 0, USE_COMPRESS_PROGRAM_OPTION
},
334 {"verbose", no_argument
, 0, 'v'},
335 {"verify", no_argument
, 0, 'W'},
336 {"version", no_argument
, &show_version
, 1},
337 {"volno-file", required_argument
, 0, VOLNO_FILE_OPTION
},
338 {"wildcards", no_argument
, 0, WILDCARDS_OPTION
},
339 {"wildcards-match-slash", no_argument
, 0, WILDCARDS_MATCH_SLASH_OPTION
},
344 /* Print a usage message and exit with STATUS. */
348 if (status
!= TAREXIT_SUCCESS
)
349 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
354 GNU `tar' saves many files together into a single tape or disk archive, and\n\
355 can restore individual files from the archive.\n"),
357 printf (_("\nUsage: %s [OPTION]... [FILE]...\n\
360 %s -cf archive.tar foo bar # Create archive.tar from files foo and bar.\n\
361 %s -tvf archive.tar # List all files in archive.tar verbosely.\n\
362 %s -xf archive.tar # Extract all files from archive.tar.\n"),
363 program_name
, program_name
, program_name
, program_name
);
366 If a long option shows an argument as mandatory, then it is mandatory\n\
367 for the equivalent short option also. Similarly for optional arguments.\n"),
371 Main operation mode:\n\
372 -t, --list list the contents of an archive\n\
373 -x, --extract, --get extract files from an archive\n\
374 -c, --create create a new archive\n\
375 -d, --diff, --compare find differences between archive and file system\n\
376 -r, --append append files to the end of an archive\n\
377 -u, --update only append files newer than copy in archive\n\
378 -A, --catenate append tar files to an archive\n\
379 --concatenate same as -A\n\
380 --delete delete from the archive (not on mag tapes!)\n"),
384 Operation modifiers:\n\
385 -W, --verify attempt to verify the archive after writing it\n\
386 --remove-files remove files after adding them to the archive\n\
387 -k, --keep-old-files don't replace existing files when extracting\n\
388 --keep-newer-files don't replace existing files that are newer\n\
389 than their archive copies\n\
390 --overwrite overwrite existing files when extracting\n\
391 --no-overwrite-dir preserve metadata of existing directories\n\
392 -U, --unlink-first remove each file prior to extracting over it\n\
393 --recursive-unlink empty hierarchies prior to extracting directory\n\
394 -S, --sparse handle sparse files efficiently\n\
395 -O, --to-stdout extract files to standard output\n\
396 -G, --incremental handle old GNU-format incremental backup\n\
397 -g, --listed-incremental=FILE\n\
398 handle new GNU-format incremental backup\n\
399 --ignore-failed-read do not exit with nonzero on unreadable files\n\
400 --occurrence[=NUM] process only the NUMth occurrence of each file in\n\
401 the archive. This option is valid only in\n\
402 conjunction with one of the subcommands --delete,\n\
403 --diff, --extract or --list and when a list of\n\
404 files is given either on the command line or\n\
406 NUM defaults to 1.\n"),
410 Handling of file attributes:\n\
411 --owner=NAME force NAME as owner for added files\n\
412 --group=NAME force NAME as group for added files\n\
413 --mode=CHANGES force (symbolic) mode CHANGES for added files\n\
414 --atime-preserve don't change access times on dumped files\n\
415 -m, --modification-time don't extract file modified time\n\
416 --same-owner try extracting files with the same ownership\n\
417 --no-same-owner extract files as yourself\n\
418 --numeric-owner always use numbers for user/group names\n\
419 -p, --same-permissions extract permissions information\n\
420 --no-same-permissions do not extract permissions information\n\
421 --preserve-permissions same as -p\n\
422 -s, --same-order sort names to extract to match archive\n\
423 --preserve-order same as -s\n\
424 --preserve same as both -p and -s\n"),
428 Device selection and switching:\n\
429 -f, --file=ARCHIVE use archive file or device ARCHIVE\n\
430 --force-local archive file is local even if has a colon\n\
431 --rmt-command=COMMAND use given rmt COMMAND instead of /etc/rmt\n\
432 --rsh-command=COMMAND use remote COMMAND instead of rsh\n\
433 -[0-7][lmh] specify drive and density\n\
434 -M, --multi-volume create/list/extract multi-volume archive\n\
435 -L, --tape-length=NUM change tape after writing NUM x 1024 bytes\n\
436 -F, --info-script=FILE run script at end of each tape (implies -M)\n\
437 --new-volume-script=FILE same as -F FILE\n\
438 --volno-file=FILE use/update the volume number in FILE\n"),
443 -b, --blocking-factor=BLOCKS BLOCKS x 512 bytes per record\n\
444 --record-size=SIZE SIZE bytes per record, multiple of 512\n\
445 -i, --ignore-zeros ignore zeroed blocks in archive (means EOF)\n\
446 -B, --read-full-records reblock as we read (for 4.2BSD pipes)\n"),
450 Archive format selection:\n\
451 --format=FMTNAME create archive of the given format.\n\
452 FMTNAME is one of the following:\n\
453 v7 old V7 tar format\n\
454 oldgnu GNU format as per tar <= 1.12\n\
455 gnu GNU tar 1.13 format\n\
456 ustar POSIX 1003.1-1988 (ustar) format\n\
457 posix POSIX 1003.1-2001 (pax) format\n\
458 --old-archive, --portability same as --format=v7\n\
459 --posix same as --format=posix\n\
460 --pax-option keyword[[:]=value][,keyword[[:]=value], ...]\n\
461 control pax keywords\n\
462 -V, --label=NAME create archive with volume name NAME\n\
463 PATTERN at list/extract time, a globbing PATTERN\n\
464 -j, --bzip2 filter the archive through bzip2\n\
465 -z, --gzip, --ungzip filter the archive through gzip\n\
466 -Z, --compress, --uncompress filter the archive through compress\n\
467 --use-compress-program=PROG filter through PROG (must accept -d)\n"),
471 Local file selection:\n\
472 -C, --directory=DIR change to directory DIR\n\
473 -T, --files-from=NAME get names to extract or create from file NAME\n\
474 --null -T reads null-terminated names, disable -C\n\
475 --exclude=PATTERN exclude files, given as a PATTERN\n\
476 -X, --exclude-from=FILE exclude patterns listed in FILE\n\
477 --anchored exclude patterns match file name start (default)\n\
478 --no-anchored exclude patterns match after any /\n\
479 --ignore-case exclusion ignores case\n\
480 --no-ignore-case exclusion is case sensitive (default)\n\
481 --wildcards exclude patterns use wildcards (default)\n\
482 --no-wildcards exclude patterns are plain strings\n\
483 --wildcards-match-slash exclude pattern wildcards match '/' (default)\n\
484 --no-wildcards-match-slash exclude pattern wildcards do not match '/'\n\
485 -P, --absolute-names don't strip leading `/'s from file names\n\
486 -h, --dereference dump instead the files symlinks point to\n\
487 --no-recursion avoid descending automatically in directories\n\
488 -l, --one-file-system stay in local file system when creating archive\n\
489 -K, --starting-file=NAME begin at file NAME in the archive\n\
490 --strip-components=NUM strip NUM leading components from file names\n\
491 before extraction\n"),
495 -N, --newer=DATE-OR-FILE only store files newer than DATE-OR-FILE\n\
496 --newer-mtime=DATE compare date and time when data changed only\n\
497 --after-date=DATE same as -N\n"),
501 --backup[=CONTROL] backup before removal, choose version control\n\
502 --suffix=SUFFIX backup before removal, override usual suffix\n"),
506 Informative output:\n\
507 --help print this help, then exit\n\
508 --version print tar program version number, then exit\n\
509 -v, --verbose verbosely list files processed\n\
510 --checkpoint print directory names while reading the archive\n\
511 --check-links print a message if not all links are dumped\n\
512 --totals print total bytes written while creating archive\n\
513 --index-file=FILE send verbose output to FILE\n\
514 --utc print file modification dates in UTC\n\
515 -R, --block-number show block number within archive with each message\n\
516 -w, --interactive ask for confirmation for every action\n\
517 --confirmation same as -w\n"),
521 Compatibility options:\n\
522 -o when creating, same as --old-archive\n\
523 when extracting, same as --no-same-owner\n"),
528 The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
529 The version control may be set with --backup or VERSION_CONTROL, values are:\n\
531 t, numbered make numbered backups\n\
532 nil, existing numbered if numbered backups exist, simple otherwise\n\
533 never, simple always make simple backups\n"),
537 ARCHIVE may be FILE, HOST:FILE or USER@HOST:FILE; DATE may be a textual date\n\
538 or a file name starting with `/' or `.', in which case the file's date is used.\n\
539 *This* `tar' defaults to `--format=%s -f%s -b%d'.\n"),
540 archive_format_string (DEFAULT_ARCHIVE_FORMAT
),
541 DEFAULT_ARCHIVE
, DEFAULT_BLOCKING
);
542 printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT
);
547 /* Parse the options for tar. */
549 /* Available option letters are DEHIJQY and aenqy. Some are reserved:
551 e exit immediately with a nonzero exit status if unexpected errors occur
552 E use extended headers (draft POSIX headers, that is)
553 I same as T (for compatibility with Solaris tar)
554 n the archive is quickly seekable, so don't worry about random seeks
555 q stop after extracting the first occurrence of the named file
556 y per-file gzip compression
557 Y per-block gzip compression */
559 #define OPTION_STRING \
560 "-01234567ABC:F:GIK:L:MN:OPRST:UV:WX:Zb:cdf:g:hijklmoprstuvwxyz"
563 set_subcommand_option (enum subcommand subcommand
)
565 if (subcommand_option
!= UNKNOWN_SUBCOMMAND
566 && subcommand_option
!= subcommand
)
568 _("You may not specify more than one `-Acdtrux' option")));
570 subcommand_option
= subcommand
;
574 set_use_compress_program_option (const char *string
)
576 if (use_compress_program_option
&& strcmp (use_compress_program_option
, string
) != 0)
577 USAGE_ERROR ((0, 0, _("Conflicting compression options")));
579 use_compress_program_option
= string
;
583 decode_options (int argc
, char **argv
)
585 int optchar
; /* option letter */
586 int input_files
; /* number of input files */
587 char const *textual_date_option
= 0;
588 char const *backup_suffix_string
;
589 char const *version_control_string
= 0;
590 int exclude_options
= EXCLUDE_WILDCARDS
;
594 /* Set some default option values. */
596 subcommand_option
= UNKNOWN_SUBCOMMAND
;
597 archive_format
= DEFAULT_FORMAT
;
598 blocking_factor
= DEFAULT_BLOCKING
;
599 record_size
= DEFAULT_BLOCKING
* BLOCKSIZE
;
600 excluded
= new_exclude ();
601 newer_mtime_option
.tv_sec
= TYPE_MINIMUM (time_t);
602 newer_mtime_option
.tv_nsec
= -1;
603 recursion_option
= FNM_LEADING_DIR
;
608 backup_suffix_string
= getenv ("SIMPLE_BACKUP_SUFFIX");
610 /* Convert old-style tar call by exploding option element and rearranging
611 options accordingly. */
613 if (argc
> 1 && argv
[1][0] != '-')
615 int new_argc
; /* argc value for rearranged arguments */
616 char **new_argv
; /* argv value for rearranged arguments */
617 char *const *in
; /* cursor into original argv */
618 char **out
; /* cursor into rearranged argv */
619 const char *letter
; /* cursor into old option letters */
620 char buffer
[3]; /* constructed option buffer */
621 const char *cursor
; /* cursor in OPTION_STRING */
623 /* Initialize a constructed option. */
628 /* Allocate a new argument array, and copy program name in it. */
630 new_argc
= argc
- 1 + strlen (argv
[1]);
631 new_argv
= xmalloc ((new_argc
+ 1) * sizeof (char *));
636 /* Copy each old letter option as a separate option, and have the
637 corresponding argument moved next to it. */
639 for (letter
= *in
++; *letter
; letter
++)
642 *out
++ = xstrdup (buffer
);
643 cursor
= strchr (OPTION_STRING
, *letter
);
644 if (cursor
&& cursor
[1] == ':')
646 if (in
< argv
+ argc
)
649 USAGE_ERROR ((0, 0, _("Old option `%c' requires an argument."),
654 /* Copy all remaining options. */
656 while (in
< argv
+ argc
)
660 /* Replace the old option list by the new one. */
666 /* Parse all options and non-options as they appear. */
670 prepend_default_options (getenv ("TAR_OPTIONS"), &argc
, &argv
);
672 while (optchar
= getopt_long (argc
, argv
, OPTION_STRING
, long_options
, 0),
677 usage (TAREXIT_FAILURE
);
683 /* File name or non-parsed option, because of RETURN_IN_ORDER
684 ordering triggered by the leading dash in OPTION_STRING. */
691 set_subcommand_option (CAT_SUBCOMMAND
);
697 if (! (xstrtoumax (optarg
, 0, 10, &u
, "") == LONGINT_OK
698 && u
== (blocking_factor
= u
)
699 && 0 < blocking_factor
700 && u
== (record_size
= u
* BLOCKSIZE
) / BLOCKSIZE
))
701 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (optarg
),
702 _("Invalid blocking factor")));
707 /* Try to reblock input records. For reading 4.2BSD pipes. */
709 /* It would surely make sense to exchange -B and -R, but it seems
710 that -B has been used for a long while in Sun tar and most
711 BSD-derived systems. This is a consequence of the block/record
712 terminology confusion. */
714 read_full_records_option
= true;
718 set_subcommand_option (CREATE_SUBCOMMAND
);
727 set_subcommand_option (DIFF_SUBCOMMAND
);
731 if (archive_names
== allocated_archive_names
)
733 allocated_archive_names
*= 2;
735 xrealloc (archive_name_array
,
736 sizeof (const char *) * allocated_archive_names
);
738 archive_name_array
[archive_names
++] = optarg
;
742 /* Since -F is only useful with -M, make it implied. Run this
743 script at the end of each tape. */
745 info_script_option
= optarg
;
746 multi_volume_option
= true;
750 listed_incremental_option
= optarg
;
751 after_date_option
= true;
755 /* We are making an incremental dump (FIXME: are we?); save
756 directories at the beginning of the archive, and include in each
757 directory its contents. */
759 incremental_option
= true;
763 /* Follow symbolic links. */
764 dereference_option
= true;
768 /* Ignore zero blocks (eofs). This can't be the default,
769 because Unix tar writes two blocks of zeros, then pads out
770 the record with garbage. */
772 ignore_zeros_option
= true;
777 _("Warning: the -I option is not supported;"
778 " perhaps you meant -j or -T?")));
782 set_use_compress_program_option ("bzip2");
786 /* Don't replace existing files. */
787 old_files_option
= KEEP_OLD_FILES
;
791 starting_file_option
= true;
796 /* When dumping directories, don't dump files/subdirectories
797 that are on other filesystems. */
799 one_file_system_option
= true;
805 if (xstrtoumax (optarg
, 0, 10, &u
, "") != LONGINT_OK
)
806 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (optarg
),
807 _("Invalid tape length")));
808 tape_length_option
= 1024 * (tarlong
) u
;
809 multi_volume_option
= true;
818 /* Make multivolume archive: when we can't write any more into
819 the archive, re-open it, and continue writing. */
821 multi_volume_option
= true;
826 after_date_option
= true;
829 case NEWER_MTIME_OPTION
:
830 if (NEWER_OPTION_INITIALIZED (newer_mtime_option
))
831 USAGE_ERROR ((0, 0, _("More than one threshold date")));
833 if (FILESYSTEM_PREFIX_LEN (optarg
) != 0
838 if (deref_stat (dereference_option
, optarg
, &st
) != 0)
841 USAGE_ERROR ((0, 0, _("Date file not found")));
843 newer_mtime_option
.tv_sec
= st
.st_mtime
;
844 newer_mtime_option
.tv_nsec
= TIMESPEC_NS (st
.st_mtim
);
848 if (! get_date (&newer_mtime_option
, optarg
, NULL
))
850 WARN ((0, 0, _("Substituting %s for unknown date format %s"),
851 tartime (newer_mtime_option
.tv_sec
), quote (optarg
)));
852 newer_mtime_option
.tv_nsec
= 0;
855 textual_date_option
= optarg
;
859 #endif /* not MSDOS */
866 to_stdout_option
= true;
870 same_permissions_option
= true;
874 absolute_names_option
= true;
878 set_subcommand_option (APPEND_SUBCOMMAND
);
882 /* Print block numbers for debugging bad tar archives. */
884 /* It would surely make sense to exchange -B and -R, but it seems
885 that -B has been used for a long while in Sun tar ans most
886 BSD-derived systems. This is a consequence of the block/record
887 terminology confusion. */
889 block_number_option
= true;
893 /* Names to extr are sorted. */
895 same_order_option
= true;
899 sparse_option
= true;
903 set_subcommand_option (LIST_SUBCOMMAND
);
908 files_from_option
= optarg
;
912 set_subcommand_option (UPDATE_SUBCOMMAND
);
916 old_files_option
= UNLINK_FIRST_OLD_FILES
;
928 volume_label_option
= optarg
;
932 interactive_option
= true;
936 verify_option
= true;
940 set_subcommand_option (EXTRACT_SUBCOMMAND
);
944 if (add_exclude_file (add_exclude
, excluded
, optarg
,
945 exclude_options
| recursion_option
, '\n')
949 FATAL_ERROR ((0, e
, "%s", quotearg_colon (optarg
)));
955 _("Warning: the -y option is not supported;"
956 " perhaps you meant -j?")));
960 set_use_compress_program_option ("gzip");
964 set_use_compress_program_option ("compress");
967 case ANCHORED_OPTION
:
968 exclude_options
|= EXCLUDE_ANCHORED
;
971 case ATIME_PRESERVE_OPTION
:
972 atime_preserve_option
= true;
975 case CHECKPOINT_OPTION
:
976 checkpoint_option
= true;
980 backup_option
= true;
982 version_control_string
= optarg
;
986 set_subcommand_option (DELETE_SUBCOMMAND
);
990 add_exclude (excluded
, optarg
, exclude_options
| recursion_option
);
993 case FORCE_LOCAL_OPTION
:
994 force_local_option
= true;
998 set_archive_format (optarg
);
1001 case INDEX_FILE_OPTION
:
1002 index_file_name
= optarg
;
1005 case IGNORE_CASE_OPTION
:
1006 exclude_options
|= FNM_CASEFOLD
;
1009 case IGNORE_FAILED_READ_OPTION
:
1010 ignore_failed_read_option
= true;
1013 case KEEP_NEWER_FILES_OPTION
:
1014 old_files_option
= KEEP_NEWER_FILES
;
1018 if (! (strlen (optarg
) < GNAME_FIELD_SIZE
1019 && gname_to_gid (optarg
, &group_option
)))
1022 if (xstrtoumax (optarg
, 0, 10, &g
, "") == LONGINT_OK
1026 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (optarg
),
1027 _("%s: Invalid group")));
1033 = mode_compile (optarg
,
1034 MODE_MASK_EQUALS
| MODE_MASK_PLUS
| MODE_MASK_MINUS
);
1035 if (mode_option
== MODE_INVALID
)
1036 FATAL_ERROR ((0, 0, _("Invalid mode given on option")));
1037 if (mode_option
== MODE_MEMORY_EXHAUSTED
)
1041 case NO_ANCHORED_OPTION
:
1042 exclude_options
&= ~ EXCLUDE_ANCHORED
;
1045 case NO_IGNORE_CASE_OPTION
:
1046 exclude_options
&= ~ FNM_CASEFOLD
;
1049 case NO_OVERWRITE_DIR_OPTION
:
1050 old_files_option
= NO_OVERWRITE_DIR_OLD_FILES
;
1053 case NO_WILDCARDS_OPTION
:
1054 exclude_options
&= ~ EXCLUDE_WILDCARDS
;
1057 case NO_WILDCARDS_MATCH_SLASH_OPTION
:
1058 exclude_options
|= FNM_FILE_NAME
;
1062 filename_terminator
= '\0';
1065 case NUMERIC_OWNER_OPTION
:
1066 numeric_owner_option
= true;
1069 case OCCURRENCE_OPTION
:
1071 occurrence_option
= 1;
1075 if (xstrtoumax (optarg
, 0, 10, &u
, "") == LONGINT_OK
)
1076 occurrence_option
= u
;
1078 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (optarg
),
1079 _("Invalid number")));
1083 case OVERWRITE_OPTION
:
1084 old_files_option
= OVERWRITE_OLD_FILES
;
1088 if (! (strlen (optarg
) < UNAME_FIELD_SIZE
1089 && uname_to_uid (optarg
, &owner_option
)))
1092 if (xstrtoumax (optarg
, 0, 10, &u
, "") == LONGINT_OK
1096 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (optarg
),
1097 _("Invalid owner")));
1103 xheader_set_option (optarg
);
1107 set_archive_format ("posix");
1110 case PRESERVE_OPTION
:
1111 same_permissions_option
= true;
1112 same_order_option
= true;
1115 case RECORD_SIZE_OPTION
:
1118 if (! (xstrtoumax (optarg
, 0, 10, &u
, "") == LONGINT_OK
1119 && u
== (size_t) u
))
1120 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (optarg
),
1121 _("Invalid record size")));
1123 if (record_size
% BLOCKSIZE
!= 0)
1124 USAGE_ERROR ((0, 0, _("Record size must be a multiple of %d."),
1126 blocking_factor
= record_size
/ BLOCKSIZE
;
1130 case RECURSIVE_UNLINK_OPTION
:
1131 recursive_unlink_option
= true;
1134 case REMOVE_FILES_OPTION
:
1135 remove_files_option
= true;
1138 case RMT_COMMAND_OPTION
:
1139 rmt_command_option
= optarg
;
1142 case RSH_COMMAND_OPTION
:
1143 rsh_command_option
= optarg
;
1146 case SHOW_DEFAULTS_OPTION
:
1147 printf ("--format=%s -f%s -b%d\n",
1148 archive_format_string (DEFAULT_ARCHIVE_FORMAT
),
1149 DEFAULT_ARCHIVE
, DEFAULT_BLOCKING
);
1152 case STRIP_COMPONENTS_OPTION
:
1155 if (! (xstrtoumax (optarg
, 0, 10, &u
, "") == LONGINT_OK
1156 && u
== (size_t) u
))
1157 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (optarg
),
1158 _("Invalid number of elements")));
1159 strip_name_components
= u
;
1164 backup_option
= true;
1165 backup_suffix_string
= optarg
;
1169 totals_option
= true;
1172 case USE_COMPRESS_PROGRAM_OPTION
:
1173 set_use_compress_program_option (optarg
);
1176 case VOLNO_FILE_OPTION
:
1177 volno_file_option
= optarg
;
1180 case WILDCARDS_OPTION
:
1181 exclude_options
|= EXCLUDE_WILDCARDS
;
1184 case WILDCARDS_MATCH_SLASH_OPTION
:
1185 exclude_options
&= ~ FNM_FILE_NAME
;
1197 #ifdef DEVICE_PREFIX
1199 int device
= optchar
- '0';
1201 static char buf
[sizeof DEVICE_PREFIX
+ 10];
1204 density
= getopt_long (argc
, argv
, "lmh", 0, 0);
1205 strcpy (buf
, DEVICE_PREFIX
);
1206 cursor
= buf
+ strlen (buf
);
1208 #ifdef DENSITY_LETTER
1210 sprintf (cursor
, "%d%c", device
, density
);
1212 #else /* not DENSITY_LETTER */
1239 usage (TAREXIT_FAILURE
);
1241 sprintf (cursor
, "%d", device
);
1243 #endif /* not DENSITY_LETTER */
1245 if (archive_names
== allocated_archive_names
)
1247 allocated_archive_names
*= 2;
1248 archive_name_array
=
1249 xrealloc (archive_name_array
,
1250 sizeof (const char *) * allocated_archive_names
);
1252 archive_name_array
[archive_names
++] = strdup (buf
);
1256 #else /* not DEVICE_PREFIX */
1259 _("Options `-[0-7][lmh]' not supported by *this* tar")));
1261 #endif /* not DEVICE_PREFIX */
1264 /* Special handling for 'o' option:
1266 GNU tar used to say "output old format".
1267 UNIX98 tar says don't chown files after extracting (we use
1268 "--no-same-owner" for this).
1270 The old GNU tar semantics is retained when used with --create
1271 option, otherwise UNIX98 semantics is assumed */
1275 if (subcommand_option
== CREATE_SUBCOMMAND
)
1277 /* GNU Tar <= 1.13 compatibility */
1278 set_archive_format ("v7");
1282 /* UNIX98 compatibility */
1283 same_owner_option
= 1;
1287 /* Handle operands after any "--" argument. */
1288 for (; optind
< argc
; optind
++)
1290 name_add (argv
[optind
]);
1294 /* Process trivial options. */
1298 printf ("tar (%s) %s\n%s\n", PACKAGE_NAME
, PACKAGE_VERSION
,
1299 "Copyright (C) 2004 Free Software Foundation, Inc.");
1301 This program comes with NO WARRANTY, to the extent permitted by law.\n\
1302 You may redistribute it under the terms of the GNU General Public License;\n\
1303 see the file named COPYING for details."));
1305 puts (_("Written by John Gilmore and Jay Fenlason."));
1307 exit (TAREXIT_SUCCESS
);
1311 usage (TAREXIT_SUCCESS
);
1313 /* Derive option values and check option consistency. */
1315 if (archive_format
== DEFAULT_FORMAT
)
1318 archive_format
= POSIX_FORMAT
;
1320 archive_format
= DEFAULT_ARCHIVE_FORMAT
;
1323 if (volume_label_option
&& subcommand_option
== CREATE_SUBCOMMAND
)
1324 assert_format (FORMAT_MASK (OLDGNU_FORMAT
)
1325 | FORMAT_MASK (GNU_FORMAT
));
1328 if (incremental_option
|| multi_volume_option
)
1329 assert_format (FORMAT_MASK (OLDGNU_FORMAT
) | FORMAT_MASK (GNU_FORMAT
));
1332 assert_format (FORMAT_MASK (OLDGNU_FORMAT
)
1333 | FORMAT_MASK (GNU_FORMAT
)
1334 | FORMAT_MASK (POSIX_FORMAT
));
1336 if (occurrence_option
)
1338 if (!input_files
&& !files_from_option
)
1340 _("--occurrence is meaningless without a file list")));
1341 if (subcommand_option
!= DELETE_SUBCOMMAND
1342 && subcommand_option
!= DIFF_SUBCOMMAND
1343 && subcommand_option
!= EXTRACT_SUBCOMMAND
1344 && subcommand_option
!= LIST_SUBCOMMAND
)
1346 _("--occurrence cannot be used in the requested operation mode")));
1349 if (archive_names
== 0)
1351 /* If no archive file name given, try TAPE from the environment, or
1352 else, DEFAULT_ARCHIVE from the configuration process. */
1355 archive_name_array
[0] = getenv ("TAPE");
1356 if (! archive_name_array
[0])
1357 archive_name_array
[0] = DEFAULT_ARCHIVE
;
1360 /* Allow multiple archives only with `-M'. */
1362 if (archive_names
> 1 && !multi_volume_option
)
1364 _("Multiple archive files require `-M' option")));
1366 if (listed_incremental_option
1367 && NEWER_OPTION_INITIALIZED (newer_mtime_option
))
1369 _("Cannot combine --listed-incremental with --newer")));
1371 if (volume_label_option
)
1373 size_t volume_label_max_len
=
1374 (sizeof current_header
->header
.name
1375 - 1 /* for trailing '\0' */
1376 - (multi_volume_option
1377 ? (sizeof " Volume "
1378 - 1 /* for null at end of " Volume " */
1379 + INT_STRLEN_BOUND (int) /* for volume number */
1380 - 1 /* for sign, as 0 <= volno */)
1382 if (volume_label_max_len
< strlen (volume_label_option
))
1384 ngettext ("%s: Volume label is too long (limit is %lu byte)",
1385 "%s: Volume label is too long (limit is %lu bytes)",
1386 volume_label_max_len
),
1387 quotearg_colon (volume_label_option
),
1388 (unsigned long) volume_label_max_len
));
1393 if (multi_volume_option
)
1394 USAGE_ERROR ((0, 0, _("Cannot verify multi-volume archives")));
1395 if (use_compress_program_option
)
1396 USAGE_ERROR ((0, 0, _("Cannot verify compressed archives")));
1399 if (use_compress_program_option
)
1401 if (multi_volume_option
)
1402 USAGE_ERROR ((0, 0, _("Cannot use multi-volume compressed archives")));
1403 if (subcommand_option
== UPDATE_SUBCOMMAND
)
1404 USAGE_ERROR ((0, 0, _("Cannot update compressed archives")));
1407 /* It is no harm to use --pax-option on non-pax archives in archive
1408 reading mode. It may even be useful, since it allows to override
1409 file attributes from tar headers. Therefore I allow such usage.
1412 && archive_format
!= POSIX_FORMAT
1413 && (subcommand_option
!= EXTRACT_SUBCOMMAND
1414 || subcommand_option
!= DIFF_SUBCOMMAND
1415 || subcommand_option
!= LIST_SUBCOMMAND
))
1416 USAGE_ERROR ((0, 0, _("--pax-option can be used only on POSIX archives")));
1418 /* If ready to unlink hierarchies, so we are for simpler files. */
1419 if (recursive_unlink_option
)
1420 old_files_option
= UNLINK_FIRST_OLD_FILES
;
1425 if (!rmt_command_option
)
1426 rmt_command_option
= DEFAULT_RMT_COMMAND
;
1428 /* Forbid using -c with no input files whatsoever. Check that `-f -',
1429 explicit or implied, is used correctly. */
1431 switch (subcommand_option
)
1433 case CREATE_SUBCOMMAND
:
1434 if (input_files
== 0 && !files_from_option
)
1436 _("Cowardly refusing to create an empty archive")));
1439 case EXTRACT_SUBCOMMAND
:
1440 case LIST_SUBCOMMAND
:
1441 case DIFF_SUBCOMMAND
:
1442 for (archive_name_cursor
= archive_name_array
;
1443 archive_name_cursor
< archive_name_array
+ archive_names
;
1444 archive_name_cursor
++)
1445 if (!strcmp (*archive_name_cursor
, "-"))
1446 request_stdin ("-f");
1449 case CAT_SUBCOMMAND
:
1450 case UPDATE_SUBCOMMAND
:
1451 case APPEND_SUBCOMMAND
:
1452 for (archive_name_cursor
= archive_name_array
;
1453 archive_name_cursor
< archive_name_array
+ archive_names
;
1454 archive_name_cursor
++)
1455 if (!strcmp (*archive_name_cursor
, "-"))
1457 _("Options `-Aru' are incompatible with `-f -'")));
1463 archive_name_cursor
= archive_name_array
;
1465 /* Prepare for generating backup names. */
1467 if (backup_suffix_string
)
1468 simple_backup_suffix
= xstrdup (backup_suffix_string
);
1471 backup_type
= xget_version ("--backup", version_control_string
);
1473 if (verbose_option
&& textual_date_option
)
1475 /* FIXME: tartime should support nanoseconds, too, so that this
1476 comparison doesn't complain about lost nanoseconds. */
1477 char const *treated_as
= tartime (newer_mtime_option
.tv_sec
);
1478 if (strcmp (textual_date_option
, treated_as
) != 0)
1480 ngettext ("Treating date `%s' as %s + %ld nanosecond",
1481 "Treating date `%s' as %s + %ld nanoseconds",
1482 newer_mtime_option
.tv_nsec
),
1483 textual_date_option
, treated_as
, newer_mtime_option
.tv_nsec
));
1490 /* Main routine for tar. */
1492 main (int argc
, char **argv
)
1494 #if HAVE_CLOCK_GETTIME
1495 if (clock_gettime (CLOCK_REALTIME
, &start_timespec
) != 0)
1497 start_time
= time (0);
1498 program_name
= argv
[0];
1499 setlocale (LC_ALL
, "");
1500 bindtextdomain (PACKAGE
, LOCALEDIR
);
1501 textdomain (PACKAGE
);
1503 exit_status
= TAREXIT_SUCCESS
;
1504 filename_terminator
= '\n';
1505 set_quoting_style (0, escape_quoting_style
);
1507 /* Pre-allocate a few structures. */
1509 allocated_archive_names
= 10;
1510 archive_name_array
=
1511 xmalloc (sizeof (const char *) * allocated_archive_names
);
1515 /* System V fork+wait does not work if SIGCHLD is ignored. */
1516 signal (SIGCHLD
, SIG_DFL
);
1521 /* Decode options. */
1523 decode_options (argc
, argv
);
1526 /* Main command execution. */
1528 if (volno_file_option
)
1529 init_volume_number ();
1531 switch (subcommand_option
)
1533 case UNKNOWN_SUBCOMMAND
:
1535 _("You must specify one of the `-Acdtrux' options")));
1537 case CAT_SUBCOMMAND
:
1538 case UPDATE_SUBCOMMAND
:
1539 case APPEND_SUBCOMMAND
:
1543 case DELETE_SUBCOMMAND
:
1544 delete_archive_members ();
1547 case CREATE_SUBCOMMAND
:
1552 print_total_written ();
1555 case EXTRACT_SUBCOMMAND
:
1557 read_and (extract_archive
);
1559 /* FIXME: should extract_finish () even if an ordinary signal is
1565 case LIST_SUBCOMMAND
:
1566 read_and (list_archive
);
1569 case DIFF_SUBCOMMAND
:
1571 read_and (diff_archive
);
1575 if (check_links_option
)
1578 if (volno_file_option
)
1579 closeout_volume_number ();
1581 /* Dispose of allocated memory, and return. */
1583 free (archive_name_array
);
1586 if (stdlis
!= stderr
&& (ferror (stdlis
) || fclose (stdlis
) != 0))
1587 FATAL_ERROR ((0, 0, _("Error in writing to standard output")));
1588 if (exit_status
== TAREXIT_FAILURE
)
1589 error (0, 0, _("Error exit delayed from previous errors"));
1590 if (ferror (stderr
) || fclose (stderr
) != 0)
1591 exit_status
= TAREXIT_FAILURE
;
1596 tar_stat_init (struct tar_stat_info
*st
)
1598 memset (st
, 0, sizeof (*st
));
1602 tar_stat_destroy (struct tar_stat_info
*st
)
1604 free (st
->orig_file_name
);
1605 free (st
->file_name
);
1606 free (st
->link_name
);
1609 free (st
->sparse_map
);
1610 memset (st
, 0, sizeof (*st
));