(exclude_vcs_files): Support for Bazaar, Mercurial and Darcs.
[tar/ericb.git] / src / tar.c
blob3ee9ff6ee4690c51718efb8b3baf26bf014d233b
1 /* A tar (tape archiver) program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
4 2001, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 Written by John Gilmore, starting 1985-08-25.
8 This program is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 3, or (at your option) any later
11 version.
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
16 Public License for more details.
18 You should have received a copy of the GNU General Public License along
19 with this program; if not, write to the Free Software Foundation, Inc.,
20 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
22 #include <system.h>
24 #include <fnmatch.h>
25 #include <argp.h>
26 #include <argp-namefrob.h>
27 #include <argp-fmtstream.h>
29 #include <signal.h>
30 #if ! defined SIGCHLD && defined SIGCLD
31 # define SIGCHLD SIGCLD
32 #endif
34 /* The following causes "common.h" to produce definitions of all the global
35 variables, rather than just "extern" declarations of them. GNU tar does
36 depend on the system loader to preset all GLOBAL variables to neutral (or
37 zero) values; explicit initialization is usually not done. */
38 #define GLOBAL
39 #include "common.h"
41 #include <argmatch.h>
42 #include <closeout.h>
43 #include <configmake.h>
44 #include <exitfail.h>
45 #include <getdate.h>
46 #include <rmt.h>
47 #include <rmt-command.h>
48 #include <prepargs.h>
49 #include <quotearg.h>
50 #include <version-etc.h>
51 #include <xstrtol.h>
52 #include <stdopen.h>
54 /* Local declarations. */
56 #ifndef DEFAULT_ARCHIVE_FORMAT
57 # define DEFAULT_ARCHIVE_FORMAT GNU_FORMAT
58 #endif
60 #ifndef DEFAULT_ARCHIVE
61 # define DEFAULT_ARCHIVE "tar.out"
62 #endif
64 #ifndef DEFAULT_BLOCKING
65 # define DEFAULT_BLOCKING 20
66 #endif
69 /* Miscellaneous. */
71 /* Name of option using stdin. */
72 static const char *stdin_used_by;
74 /* Doesn't return if stdin already requested. */
75 void
76 request_stdin (const char *option)
78 if (stdin_used_by)
79 USAGE_ERROR ((0, 0, _("Options `-%s' and `-%s' both want standard input"),
80 stdin_used_by, option));
82 stdin_used_by = option;
85 extern int rpmatch (char const *response);
87 /* Returns true if and only if the user typed an affirmative response. */
88 int
89 confirm (const char *message_action, const char *message_name)
91 static FILE *confirm_file;
92 static int confirm_file_EOF;
93 bool status = false;
95 if (!confirm_file)
97 if (archive == 0 || stdin_used_by)
99 confirm_file = fopen (TTY_NAME, "r");
100 if (! confirm_file)
101 open_fatal (TTY_NAME);
103 else
105 request_stdin ("-w");
106 confirm_file = stdin;
110 fprintf (stdlis, "%s %s?", message_action, quote (message_name));
111 fflush (stdlis);
113 if (!confirm_file_EOF)
115 char *response = NULL;
116 size_t response_size = 0;
117 if (getline (&response, &response_size, confirm_file) < 0)
118 confirm_file_EOF = 1;
119 else
120 status = rpmatch (response) > 0;
121 free (response);
124 if (confirm_file_EOF)
126 fputc ('\n', stdlis);
127 fflush (stdlis);
130 return status;
133 static struct fmttab {
134 char const *name;
135 enum archive_format fmt;
136 } const fmttab[] = {
137 { "v7", V7_FORMAT },
138 { "oldgnu", OLDGNU_FORMAT },
139 { "ustar", USTAR_FORMAT },
140 { "posix", POSIX_FORMAT },
141 #if 0 /* not fully supported yet */
142 { "star", STAR_FORMAT },
143 #endif
144 { "gnu", GNU_FORMAT },
145 { "pax", POSIX_FORMAT }, /* An alias for posix */
146 { NULL, 0 }
149 static void
150 set_archive_format (char const *name)
152 struct fmttab const *p;
154 for (p = fmttab; strcmp (p->name, name) != 0; )
155 if (! (++p)->name)
156 USAGE_ERROR ((0, 0, _("%s: Invalid archive format"),
157 quotearg_colon (name)));
159 archive_format = p->fmt;
162 const char *
163 archive_format_string (enum archive_format fmt)
165 struct fmttab const *p;
167 for (p = fmttab; p->name; p++)
168 if (p->fmt == fmt)
169 return p->name;
170 return "unknown?";
173 #define FORMAT_MASK(n) (1<<(n))
175 static void
176 assert_format(unsigned fmt_mask)
178 if ((FORMAT_MASK (archive_format) & fmt_mask) == 0)
179 USAGE_ERROR ((0, 0,
180 _("GNU features wanted on incompatible archive format")));
183 const char *
184 subcommand_string (enum subcommand c)
186 switch (c)
188 case UNKNOWN_SUBCOMMAND:
189 return "unknown?";
191 case APPEND_SUBCOMMAND:
192 return "-r";
194 case CAT_SUBCOMMAND:
195 return "-A";
197 case CREATE_SUBCOMMAND:
198 return "-c";
200 case DELETE_SUBCOMMAND:
201 return "-D";
203 case DIFF_SUBCOMMAND:
204 return "-d";
206 case EXTRACT_SUBCOMMAND:
207 return "-x";
209 case LIST_SUBCOMMAND:
210 return "-t";
212 case UPDATE_SUBCOMMAND:
213 return "-u";
215 default:
216 abort ();
220 void
221 tar_list_quoting_styles (argp_fmtstream_t fs, char *prefix)
223 int i;
225 for (i = 0; quoting_style_args[i]; i++)
226 argp_fmtstream_printf (fs, "%s%s\n", prefix, quoting_style_args[i]);
229 void
230 tar_set_quoting_style (char *arg)
232 int i;
234 for (i = 0; quoting_style_args[i]; i++)
235 if (strcmp (arg, quoting_style_args[i]) == 0)
237 set_quoting_style (NULL, i);
238 return;
240 FATAL_ERROR ((0, 0,
241 _("Unknown quoting style `%s'. Try `%s --quoting-style=help' to get a list."), arg, program_invocation_short_name));
245 /* Options. */
247 enum
249 ANCHORED_OPTION = CHAR_MAX + 1,
250 ATIME_PRESERVE_OPTION,
251 BACKUP_OPTION,
252 CHECK_DEVICE_OPTION,
253 CHECKPOINT_OPTION,
254 CHECKPOINT_ACTION_OPTION,
255 DELAY_DIRECTORY_RESTORE_OPTION,
256 HARD_DEREFERENCE_OPTION,
257 DELETE_OPTION,
258 EXCLUDE_CACHES_OPTION,
259 EXCLUDE_CACHES_UNDER_OPTION,
260 EXCLUDE_CACHES_ALL_OPTION,
261 EXCLUDE_OPTION,
262 EXCLUDE_TAG_OPTION,
263 EXCLUDE_TAG_UNDER_OPTION,
264 EXCLUDE_TAG_ALL_OPTION,
265 EXCLUDE_VCS_OPTION,
266 FORCE_LOCAL_OPTION,
267 GROUP_OPTION,
268 HANG_OPTION,
269 IGNORE_CASE_OPTION,
270 IGNORE_COMMAND_ERROR_OPTION,
271 IGNORE_FAILED_READ_OPTION,
272 INDEX_FILE_OPTION,
273 KEEP_NEWER_FILES_OPTION,
274 LZMA_OPTION,
275 MODE_OPTION,
276 MTIME_OPTION,
277 NEWER_MTIME_OPTION,
278 NO_ANCHORED_OPTION,
279 NO_CHECK_DEVICE_OPTION,
280 NO_DELAY_DIRECTORY_RESTORE_OPTION,
281 NO_IGNORE_CASE_OPTION,
282 NO_IGNORE_COMMAND_ERROR_OPTION,
283 NO_OVERWRITE_DIR_OPTION,
284 NO_QUOTE_CHARS_OPTION,
285 NO_RECURSION_OPTION,
286 NO_SAME_OWNER_OPTION,
287 NO_SAME_PERMISSIONS_OPTION,
288 NO_UNQUOTE_OPTION,
289 NO_WILDCARDS_MATCH_SLASH_OPTION,
290 NO_WILDCARDS_OPTION,
291 NULL_OPTION,
292 NUMERIC_OWNER_OPTION,
293 OCCURRENCE_OPTION,
294 OLD_ARCHIVE_OPTION,
295 ONE_FILE_SYSTEM_OPTION,
296 OVERWRITE_DIR_OPTION,
297 OVERWRITE_OPTION,
298 OWNER_OPTION,
299 PAX_OPTION,
300 POSIX_OPTION,
301 PRESERVE_OPTION,
302 QUOTE_CHARS_OPTION,
303 QUOTING_STYLE_OPTION,
304 RECORD_SIZE_OPTION,
305 RECURSION_OPTION,
306 RECURSIVE_UNLINK_OPTION,
307 REMOVE_FILES_OPTION,
308 RESTRICT_OPTION,
309 RMT_COMMAND_OPTION,
310 RSH_COMMAND_OPTION,
311 SAME_OWNER_OPTION,
312 SHOW_DEFAULTS_OPTION,
313 SHOW_OMITTED_DIRS_OPTION,
314 SHOW_TRANSFORMED_NAMES_OPTION,
315 SPARSE_VERSION_OPTION,
316 STRIP_COMPONENTS_OPTION,
317 SUFFIX_OPTION,
318 TEST_LABEL_OPTION,
319 TOTALS_OPTION,
320 TO_COMMAND_OPTION,
321 TRANSFORM_OPTION,
322 UNQUOTE_OPTION,
323 USAGE_OPTION,
324 USE_COMPRESS_PROGRAM_OPTION,
325 UTC_OPTION,
326 VERSION_OPTION,
327 VOLNO_FILE_OPTION,
328 WILDCARDS_MATCH_SLASH_OPTION,
329 WILDCARDS_OPTION
332 const char *argp_program_version = "tar (" PACKAGE_NAME ") " VERSION;
333 const char *argp_program_bug_address = "<" PACKAGE_BUGREPORT ">";
334 static char const doc[] = N_("\
335 GNU `tar' saves many files together into a single tape or disk archive, \
336 and can restore individual files from the archive.\n\
338 Examples:\n\
339 tar -cf archive.tar foo bar # Create archive.tar from files foo and bar.\n\
340 tar -tvf archive.tar # List all files in archive.tar verbosely.\n\
341 tar -xf archive.tar # Extract all files from archive.tar.\n")
342 "\v"
343 N_("The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
344 The version control may be set with --backup or VERSION_CONTROL, values are:\n\n\
345 none, off never make backups\n\
346 t, numbered make numbered backups\n\
347 nil, existing numbered if numbered backups exist, simple otherwise\n\
348 never, simple always make simple backups\n");
351 /* NOTE:
353 Available option letters are DEIJQY and eqy. Consider the following
354 assignments:
356 [For Solaris tar compatibility =/= Is it important at all?]
357 e exit immediately with a nonzero exit status if unexpected errors occur
358 E use extended headers (--format=posix)
360 [q alias for --occurrence=1 =/= this would better be used for quiet?]
361 [I same as T =/= will harm star compatibility]
363 y per-file gzip compression
364 Y per-block gzip compression */
366 static struct argp_option options[] = {
367 #define GRID 10
368 {NULL, 0, NULL, 0,
369 N_("Main operation mode:"), GRID },
371 {"list", 't', 0, 0,
372 N_("list the contents of an archive"), GRID+1 },
373 {"extract", 'x', 0, 0,
374 N_("extract files from an archive"), GRID+1 },
375 {"get", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
376 {"create", 'c', 0, 0,
377 N_("create a new archive"), GRID+1 },
378 {"diff", 'd', 0, 0,
379 N_("find differences between archive and file system"), GRID+1 },
380 {"compare", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
381 {"append", 'r', 0, 0,
382 N_("append files to the end of an archive"), GRID+1 },
383 {"update", 'u', 0, 0,
384 N_("only append files newer than copy in archive"), GRID+1 },
385 {"catenate", 'A', 0, 0,
386 N_("append tar files to an archive"), GRID+1 },
387 {"concatenate", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
388 {"delete", DELETE_OPTION, 0, 0,
389 N_("delete from the archive (not on mag tapes!)"), GRID+1 },
390 {"test-label", TEST_LABEL_OPTION, NULL, 0,
391 N_("test the archive volume label and exit"), GRID+1 },
392 #undef GRID
394 #define GRID 20
395 {NULL, 0, NULL, 0,
396 N_("Operation modifiers:"), GRID },
398 {"sparse", 'S', 0, 0,
399 N_("handle sparse files efficiently"), GRID+1 },
400 {"sparse-version", SPARSE_VERSION_OPTION, N_("MAJOR[.MINOR]"), 0,
401 N_("set version of the sparse format to use (implies --sparse)"), GRID+1},
402 {"incremental", 'G', 0, 0,
403 N_("handle old GNU-format incremental backup"), GRID+1 },
404 {"listed-incremental", 'g', N_("FILE"), 0,
405 N_("handle new GNU-format incremental backup"), GRID+1 },
406 {"ignore-failed-read", IGNORE_FAILED_READ_OPTION, 0, 0,
407 N_("do not exit with nonzero on unreadable files"), GRID+1 },
408 {"occurrence", OCCURRENCE_OPTION, N_("NUMBER"), OPTION_ARG_OPTIONAL,
409 N_("process only the NUMBERth occurrence of each file in the archive;"
410 " this option is valid only in conjunction with one of the subcommands"
411 " --delete, --diff, --extract or --list and when a list of files"
412 " is given either on the command line or via the -T option;"
413 " NUMBER defaults to 1"), GRID+1 },
414 {"seek", 'n', NULL, 0,
415 N_("archive is seekable"), GRID+1 },
416 {"no-check-device", NO_CHECK_DEVICE_OPTION, NULL, 0,
417 N_("do not check device numbers when creating incremental archives"),
418 GRID+1 },
419 {"check-device", CHECK_DEVICE_OPTION, NULL, 0,
420 N_("check device numbers when creating incremental archives (default)"),
421 GRID+1 },
422 #undef GRID
424 #define GRID 30
425 {NULL, 0, NULL, 0,
426 N_("Overwrite control:"), GRID },
428 {"verify", 'W', 0, 0,
429 N_("attempt to verify the archive after writing it"), GRID+1 },
430 {"remove-files", REMOVE_FILES_OPTION, 0, 0,
431 N_("remove files after adding them to the archive"), GRID+1 },
432 {"keep-old-files", 'k', 0, 0,
433 N_("don't replace existing files when extracting"), GRID+1 },
434 {"keep-newer-files", KEEP_NEWER_FILES_OPTION, 0, 0,
435 N_("don't replace existing files that are newer than their archive copies"), GRID+1 },
436 {"overwrite", OVERWRITE_OPTION, 0, 0,
437 N_("overwrite existing files when extracting"), GRID+1 },
438 {"unlink-first", 'U', 0, 0,
439 N_("remove each file prior to extracting over it"), GRID+1 },
440 {"recursive-unlink", RECURSIVE_UNLINK_OPTION, 0, 0,
441 N_("empty hierarchies prior to extracting directory"), GRID+1 },
442 {"no-overwrite-dir", NO_OVERWRITE_DIR_OPTION, 0, 0,
443 N_("preserve metadata of existing directories"), GRID+1 },
444 {"overwrite-dir", OVERWRITE_DIR_OPTION, 0, 0,
445 N_("overwrite metadata of existing directories when extracting (default)"),
446 GRID+1 },
447 #undef GRID
449 #define GRID 40
450 {NULL, 0, NULL, 0,
451 N_("Select output stream:"), GRID },
453 {"to-stdout", 'O', 0, 0,
454 N_("extract files to standard output"), GRID+1 },
455 {"to-command", TO_COMMAND_OPTION, N_("COMMAND"), 0,
456 N_("pipe extracted files to another program"), GRID+1 },
457 {"ignore-command-error", IGNORE_COMMAND_ERROR_OPTION, 0, 0,
458 N_("ignore exit codes of children"), GRID+1 },
459 {"no-ignore-command-error", NO_IGNORE_COMMAND_ERROR_OPTION, 0, 0,
460 N_("treat non-zero exit codes of children as error"), GRID+1 },
461 #undef GRID
463 #define GRID 50
464 {NULL, 0, NULL, 0,
465 N_("Handling of file attributes:"), GRID },
467 {"owner", OWNER_OPTION, N_("NAME"), 0,
468 N_("force NAME as owner for added files"), GRID+1 },
469 {"group", GROUP_OPTION, N_("NAME"), 0,
470 N_("force NAME as group for added files"), GRID+1 },
471 {"mtime", MTIME_OPTION, N_("DATE-OR-FILE"), 0,
472 N_("set mtime for added files from DATE-OR-FILE"), GRID+1 },
473 {"mode", MODE_OPTION, N_("CHANGES"), 0,
474 N_("force (symbolic) mode CHANGES for added files"), GRID+1 },
475 {"atime-preserve", ATIME_PRESERVE_OPTION,
476 N_("METHOD"), OPTION_ARG_OPTIONAL,
477 N_("preserve access times on dumped files, either by restoring the times"
478 " after reading (METHOD='replace'; default) or by not setting the times"
479 " in the first place (METHOD='system')"), GRID+1 },
480 {"touch", 'm', 0, 0,
481 N_("don't extract file modified time"), GRID+1 },
482 {"same-owner", SAME_OWNER_OPTION, 0, 0,
483 N_("try extracting files with the same ownership"), GRID+1 },
484 {"no-same-owner", NO_SAME_OWNER_OPTION, 0, 0,
485 N_("extract files as yourself"), GRID+1 },
486 {"numeric-owner", NUMERIC_OWNER_OPTION, 0, 0,
487 N_("always use numbers for user/group names"), GRID+1 },
488 {"preserve-permissions", 'p', 0, 0,
489 N_("extract information about file permissions (default for superuser)"),
490 GRID+1 },
491 {"same-permissions", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
492 {"no-same-permissions", NO_SAME_PERMISSIONS_OPTION, 0, 0,
493 N_("apply the user's umask when extracting permissions from the archive (default for ordinary users)"), GRID+1 },
494 {"preserve-order", 's', 0, 0,
495 N_("sort names to extract to match archive"), GRID+1 },
496 {"same-order", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
497 {"preserve", PRESERVE_OPTION, 0, 0,
498 N_("same as both -p and -s"), GRID+1 },
499 {"delay-directory-restore", DELAY_DIRECTORY_RESTORE_OPTION, 0, 0,
500 N_("delay setting modification times and permissions of extracted"
501 " directories until the end of extraction"), GRID+1 },
502 {"no-delay-directory-restore", NO_DELAY_DIRECTORY_RESTORE_OPTION, 0, 0,
503 N_("cancel the effect of --delay-directory-restore option"), GRID+1 },
504 #undef GRID
506 #define GRID 60
507 {NULL, 0, NULL, 0,
508 N_("Device selection and switching:"), GRID },
510 {"file", 'f', N_("ARCHIVE"), 0,
511 N_("use archive file or device ARCHIVE"), GRID+1 },
512 {"force-local", FORCE_LOCAL_OPTION, 0, 0,
513 N_("archive file is local even if it has a colon"), GRID+1 },
514 {"rmt-command", RMT_COMMAND_OPTION, N_("COMMAND"), 0,
515 N_("use given rmt COMMAND instead of rmt"), GRID+1 },
516 {"rsh-command", RSH_COMMAND_OPTION, N_("COMMAND"), 0,
517 N_("use remote COMMAND instead of rsh"), GRID+1 },
518 #ifdef DEVICE_PREFIX
519 {"-[0-7][lmh]", 0, NULL, OPTION_DOC, /* It is OK, since `name' will never be
520 translated */
521 N_("specify drive and density"), GRID+1 },
522 #endif
523 {NULL, '0', NULL, OPTION_HIDDEN, NULL, GRID+1 },
524 {NULL, '1', NULL, OPTION_HIDDEN, NULL, GRID+1 },
525 {NULL, '2', NULL, OPTION_HIDDEN, NULL, GRID+1 },
526 {NULL, '3', NULL, OPTION_HIDDEN, NULL, GRID+1 },
527 {NULL, '4', NULL, OPTION_HIDDEN, NULL, GRID+1 },
528 {NULL, '5', NULL, OPTION_HIDDEN, NULL, GRID+1 },
529 {NULL, '6', NULL, OPTION_HIDDEN, NULL, GRID+1 },
530 {NULL, '7', NULL, OPTION_HIDDEN, NULL, GRID+1 },
531 {NULL, '8', NULL, OPTION_HIDDEN, NULL, GRID+1 },
532 {NULL, '9', NULL, OPTION_HIDDEN, NULL, GRID+1 },
534 {"multi-volume", 'M', 0, 0,
535 N_("create/list/extract multi-volume archive"), GRID+1 },
536 {"tape-length", 'L', N_("NUMBER"), 0,
537 N_("change tape after writing NUMBER x 1024 bytes"), GRID+1 },
538 {"info-script", 'F', N_("NAME"), 0,
539 N_("run script at end of each tape (implies -M)"), GRID+1 },
540 {"new-volume-script", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
541 {"volno-file", VOLNO_FILE_OPTION, N_("FILE"), 0,
542 N_("use/update the volume number in FILE"), GRID+1 },
543 #undef GRID
545 #define GRID 70
546 {NULL, 0, NULL, 0,
547 N_("Device blocking:"), GRID },
549 {"blocking-factor", 'b', N_("BLOCKS"), 0,
550 N_("BLOCKS x 512 bytes per record"), GRID+1 },
551 {"record-size", RECORD_SIZE_OPTION, N_("NUMBER"), 0,
552 N_("NUMBER of bytes per record, multiple of 512"), GRID+1 },
553 {"ignore-zeros", 'i', 0, 0,
554 N_("ignore zeroed blocks in archive (means EOF)"), GRID+1 },
555 {"read-full-records", 'B', 0, 0,
556 N_("reblock as we read (for 4.2BSD pipes)"), GRID+1 },
557 #undef GRID
559 #define GRID 80
560 {NULL, 0, NULL, 0,
561 N_("Archive format selection:"), GRID },
563 {"format", 'H', N_("FORMAT"), 0,
564 N_("create archive of the given format"), GRID+1 },
566 {NULL, 0, NULL, 0, N_("FORMAT is one of the following:"), GRID+2 },
567 {" v7", 0, NULL, OPTION_DOC|OPTION_NO_TRANS, N_("old V7 tar format"),
568 GRID+3 },
569 {" oldgnu", 0, NULL, OPTION_DOC|OPTION_NO_TRANS,
570 N_("GNU format as per tar <= 1.12"), GRID+3 },
571 {" gnu", 0, NULL, OPTION_DOC|OPTION_NO_TRANS,
572 N_("GNU tar 1.13.x format"), GRID+3 },
573 {" ustar", 0, NULL, OPTION_DOC|OPTION_NO_TRANS,
574 N_("POSIX 1003.1-1988 (ustar) format"), GRID+3 },
575 {" pax", 0, NULL, OPTION_DOC|OPTION_NO_TRANS,
576 N_("POSIX 1003.1-2001 (pax) format"), GRID+3 },
577 {" posix", 0, NULL, OPTION_DOC|OPTION_NO_TRANS, N_("same as pax"), GRID+3 },
579 {"old-archive", OLD_ARCHIVE_OPTION, 0, 0, /* FIXME */
580 N_("same as --format=v7"), GRID+8 },
581 {"portability", 0, 0, OPTION_ALIAS, NULL, GRID+8 },
582 {"posix", POSIX_OPTION, 0, 0,
583 N_("same as --format=posix"), GRID+8 },
584 {"pax-option", PAX_OPTION, N_("keyword[[:]=value][,keyword[[:]=value]]..."), 0,
585 N_("control pax keywords"), GRID+8 },
586 {"label", 'V', N_("TEXT"), 0,
587 N_("create archive with volume name TEXT; at list/extract time, use TEXT as a globbing pattern for volume name"), GRID+8 },
588 #undef GRID
590 #define GRID 90
591 {NULL, 0, NULL, 0,
592 N_("Compression options:"), GRID },
593 {"auto-compress", 'a', 0, 0,
594 N_("use archive suffix to determine the compression program"), GRID+1 },
595 {"bzip2", 'j', 0, 0,
596 N_("filter the archive through bzip2"), GRID+1 },
597 {"gzip", 'z', 0, 0,
598 N_("filter the archive through gzip"), GRID+1 },
599 {"gunzip", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
600 {"ungzip", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
601 {"compress", 'Z', 0, 0,
602 N_("filter the archive through compress"), GRID+1 },
603 {"uncompress", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
604 {"lzma", LZMA_OPTION, 0, 0,
605 N_("filter the archive through lzma"), GRID+1 },
606 {"use-compress-program", USE_COMPRESS_PROGRAM_OPTION, N_("PROG"), 0,
607 N_("filter through PROG (must accept -d)"), GRID+1 },
608 #undef GRID
610 #define GRID 100
611 {NULL, 0, NULL, 0,
612 N_("Local file selection:"), GRID },
614 {"add-file", ARGP_KEY_ARG, N_("FILE"), 0,
615 N_("add given FILE to the archive (useful if its name starts with a dash)"), GRID+1 },
616 {"directory", 'C', N_("DIR"), 0,
617 N_("change to directory DIR"), GRID+1 },
618 {"files-from", 'T', N_("FILE"), 0,
619 N_("get names to extract or create from FILE"), GRID+1 },
620 {"null", NULL_OPTION, 0, 0,
621 N_("-T reads null-terminated names, disable -C"), GRID+1 },
622 {"unquote", UNQUOTE_OPTION, 0, 0,
623 N_("unquote filenames read with -T (default)"), GRID+1 },
624 {"no-unquote", NO_UNQUOTE_OPTION, 0, 0,
625 N_("do not unquote filenames read with -T"), GRID+1 },
626 {"exclude", EXCLUDE_OPTION, N_("PATTERN"), 0,
627 N_("exclude files, given as a PATTERN"), GRID+1 },
628 {"exclude-from", 'X', N_("FILE"), 0,
629 N_("exclude patterns listed in FILE"), GRID+1 },
630 {"exclude-caches", EXCLUDE_CACHES_OPTION, 0, 0,
631 N_("exclude contents of directories containing CACHEDIR.TAG, "
632 "except for the tag file itself"), GRID+1 },
633 {"exclude-caches-under", EXCLUDE_CACHES_UNDER_OPTION, 0, 0,
634 N_("exclude everything under directories containing CACHEDIR.TAG"),
635 GRID+1 },
636 {"exclude-caches-all", EXCLUDE_CACHES_ALL_OPTION, 0, 0,
637 N_("exclude directories containing CACHEDIR.TAG"), GRID+1 },
638 {"exclude-tag", EXCLUDE_TAG_OPTION, N_("FILE"), 0,
639 N_("exclude contents of directories containing FILE, except"
640 " for FILE itself"), GRID+1 },
641 {"exclude-tag-under", EXCLUDE_TAG_UNDER_OPTION, N_("FILE"), 0,
642 N_("exclude everything under directories containing FILE"), GRID+1 },
643 {"exclude-tag-all", EXCLUDE_TAG_ALL_OPTION, N_("FILE"), 0,
644 N_("exclude directories containing FILE"), GRID+1 },
645 {"exclude-vcs", EXCLUDE_VCS_OPTION, NULL, 0,
646 N_("exclude version control system directories"), GRID+1 },
647 {"no-recursion", NO_RECURSION_OPTION, 0, 0,
648 N_("avoid descending automatically in directories"), GRID+1 },
649 {"one-file-system", ONE_FILE_SYSTEM_OPTION, 0, 0,
650 N_("stay in local file system when creating archive"), GRID+1 },
651 {"recursion", RECURSION_OPTION, 0, 0,
652 N_("recurse into directories (default)"), GRID+1 },
653 {"absolute-names", 'P', 0, 0,
654 N_("don't strip leading `/'s from file names"), GRID+1 },
655 {"dereference", 'h', 0, 0,
656 N_("follow symlinks; archive and dump the files they point to"), GRID+1 },
657 {"hard-dereference", HARD_DEREFERENCE_OPTION, 0, 0,
658 N_("follow hard links; archive and dump the files they refer to"), GRID+1 },
659 {"starting-file", 'K', N_("MEMBER-NAME"), 0,
660 N_("begin at member MEMBER-NAME in the archive"), GRID+1 },
661 {"newer", 'N', N_("DATE-OR-FILE"), 0,
662 N_("only store files newer than DATE-OR-FILE"), GRID+1 },
663 {"after-date", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
664 {"newer-mtime", NEWER_MTIME_OPTION, N_("DATE"), 0,
665 N_("compare date and time when data changed only"), GRID+1 },
666 {"backup", BACKUP_OPTION, N_("CONTROL"), OPTION_ARG_OPTIONAL,
667 N_("backup before removal, choose version CONTROL"), GRID+1 },
668 {"suffix", SUFFIX_OPTION, N_("STRING"), 0,
669 N_("backup before removal, override usual suffix ('~' unless overridden by environment variable SIMPLE_BACKUP_SUFFIX)"), GRID+1 },
670 #undef GRID
672 #define GRID 110
673 {NULL, 0, NULL, 0,
674 N_("File name transformations:"), GRID },
675 {"strip-components", STRIP_COMPONENTS_OPTION, N_("NUMBER"), 0,
676 N_("strip NUMBER leading components from file names on extraction"),
677 GRID+1 },
678 {"transform", TRANSFORM_OPTION, N_("EXPRESSION"), 0,
679 N_("use sed replace EXPRESSION to transform file names"), GRID+1 },
680 #undef GRID
682 #define GRID 120
683 {NULL, 0, NULL, 0,
684 N_("File name matching options (affect both exclude and include patterns):"),
685 GRID },
686 {"ignore-case", IGNORE_CASE_OPTION, 0, 0,
687 N_("ignore case"), GRID+1 },
688 {"anchored", ANCHORED_OPTION, 0, 0,
689 N_("patterns match file name start"), GRID+1 },
690 {"no-anchored", NO_ANCHORED_OPTION, 0, 0,
691 N_("patterns match after any `/' (default for exclusion)"), GRID+1 },
692 {"no-ignore-case", NO_IGNORE_CASE_OPTION, 0, 0,
693 N_("case sensitive matching (default)"), GRID+1 },
694 {"wildcards", WILDCARDS_OPTION, 0, 0,
695 N_("use wildcards (default for exclusion)"), GRID+1 },
696 {"no-wildcards", NO_WILDCARDS_OPTION, 0, 0,
697 N_("verbatim string matching"), GRID+1 },
698 {"no-wildcards-match-slash", NO_WILDCARDS_MATCH_SLASH_OPTION, 0, 0,
699 N_("wildcards do not match `/'"), GRID+1 },
700 {"wildcards-match-slash", WILDCARDS_MATCH_SLASH_OPTION, 0, 0,
701 N_("wildcards match `/' (default for exclusion)"), GRID+1 },
702 #undef GRID
704 #define GRID 130
705 {NULL, 0, NULL, 0,
706 N_("Informative output:"), GRID },
708 {"verbose", 'v', 0, 0,
709 N_("verbosely list files processed"), GRID+1 },
710 {"checkpoint", CHECKPOINT_OPTION, N_("NUMBER"), OPTION_ARG_OPTIONAL,
711 N_("display progress messages every NUMBERth record (default 10)"),
712 GRID+1 },
713 {"checkpoint-action", CHECKPOINT_ACTION_OPTION, N_("ACTION"), 0,
714 N_("execute ACTION on each checkpoint"),
715 GRID+1 },
716 {"check-links", 'l', 0, 0,
717 N_("print a message if not all links are dumped"), GRID+1 },
718 {"totals", TOTALS_OPTION, N_("SIGNAL"), OPTION_ARG_OPTIONAL,
719 N_("print total bytes after processing the archive; "
720 "with an argument - print total bytes when this SIGNAL is delivered; "
721 "Allowed signals are: SIGHUP, SIGQUIT, SIGINT, SIGUSR1 and SIGUSR2; "
722 "the names without SIG prefix are also accepted"), GRID+1 },
723 {"utc", UTC_OPTION, 0, 0,
724 N_("print file modification dates in UTC"), GRID+1 },
725 {"index-file", INDEX_FILE_OPTION, N_("FILE"), 0,
726 N_("send verbose output to FILE"), GRID+1 },
727 {"block-number", 'R', 0, 0,
728 N_("show block number within archive with each message"), GRID+1 },
729 {"interactive", 'w', 0, 0,
730 N_("ask for confirmation for every action"), GRID+1 },
731 {"confirmation", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
732 {"show-defaults", SHOW_DEFAULTS_OPTION, 0, 0,
733 N_("show tar defaults"), GRID+1 },
734 {"show-omitted-dirs", SHOW_OMITTED_DIRS_OPTION, 0, 0,
735 N_("when listing or extracting, list each directory that does not match search criteria"), GRID+1 },
736 {"show-transformed-names", SHOW_TRANSFORMED_NAMES_OPTION, 0, 0,
737 N_("show file or archive names after transformation"),
738 GRID+1 },
739 {"show-stored-names", 0, 0, OPTION_ALIAS, NULL, GRID+1 },
740 {"quoting-style", QUOTING_STYLE_OPTION, N_("STYLE"), 0,
741 N_("set name quoting style; see below for valid STYLE values"), GRID+1 },
742 {"quote-chars", QUOTE_CHARS_OPTION, N_("STRING"), 0,
743 N_("additionally quote characters from STRING"), GRID+1 },
744 {"no-quote-chars", NO_QUOTE_CHARS_OPTION, N_("STRING"), 0,
745 N_("disable quoting for characters from STRING"), GRID+1 },
746 #undef GRID
748 #define GRID 140
749 {NULL, 0, NULL, 0,
750 N_("Compatibility options:"), GRID },
752 {NULL, 'o', 0, 0,
753 N_("when creating, same as --old-archive; when extracting, same as --no-same-owner"), GRID+1 },
754 #undef GRID
756 #define GRID 150
757 {NULL, 0, NULL, 0,
758 N_("Other options:"), GRID },
760 {"restrict", RESTRICT_OPTION, 0, 0,
761 N_("disable use of some potentially harmful options"), -1 },
763 {"help", '?', 0, 0, N_("give this help list"), -1},
764 {"usage", USAGE_OPTION, 0, 0, N_("give a short usage message"), -1},
765 {"version", VERSION_OPTION, 0, 0, N_("print program version"), -1},
766 /* FIXME -V (--label) conflicts with the default short option for
767 --version */
768 {"HANG", HANG_OPTION, "SECS", OPTION_ARG_OPTIONAL | OPTION_HIDDEN,
769 N_("hang for SECS seconds (default 3600)"), 0},
770 #undef GRID
772 {0, 0, 0, 0, 0, 0}
775 static char const *const atime_preserve_args[] =
777 "replace", "system", NULL
780 static enum atime_preserve const atime_preserve_types[] =
782 replace_atime_preserve, system_atime_preserve
785 /* Make sure atime_preserve_types has as much entries as atime_preserve_args
786 (minus 1 for NULL guard) */
787 ARGMATCH_VERIFY (atime_preserve_args, atime_preserve_types);
789 /* Wildcard matching settings */
790 enum wildcards
792 default_wildcards, /* For exclusion == enable_wildcards,
793 for inclusion == disable_wildcards */
794 disable_wildcards,
795 enable_wildcards
798 struct tar_args /* Variables used during option parsing */
800 struct textual_date *textual_date; /* Keeps the arguments to --newer-mtime
801 and/or --date option if they are
802 textual dates */
803 enum wildcards wildcards; /* Wildcard settings (--wildcards/
804 --no-wildcards) */
805 int matching_flags; /* exclude_fnmatch options */
806 int include_anchored; /* Pattern anchoring options used for
807 file inclusion */
808 bool o_option; /* True if -o option was given */
809 bool pax_option; /* True if --pax-option was given */
810 char const *backup_suffix_string; /* --suffix option argument */
811 char const *version_control_string; /* --backup option argument */
812 bool input_files; /* True if some input files where given */
813 int compress_autodetect; /* True if compression autodetection should
814 be attempted when creating archives */
818 #define MAKE_EXCL_OPTIONS(args) \
819 ((((args)->wildcards != disable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
820 | (args)->matching_flags \
821 | recursion_option)
823 #define MAKE_INCL_OPTIONS(args) \
824 ((((args)->wildcards == enable_wildcards) ? EXCLUDE_WILDCARDS : 0) \
825 | (args)->include_anchored \
826 | (args)->matching_flags \
827 | recursion_option)
829 void
830 exclude_vcs_files ()
832 int i;
833 static char *vcs_file[] = {
834 /* CVS: */
835 "CVS",
836 ".cvsignore",
837 /* RCS: */
838 "RCS",
839 /* SCCS: */
840 "SCCS",
841 /* SVN: */
842 ".svn",
843 /* git: */
844 ".git",
845 ".gitignore",
846 /* Arch: */
847 ".arch-ids",
848 "{arch}",
849 "=RELEASE-ID",
850 "=meta-update",
851 "=update",
852 /* Bazaar */
853 ".bzr",
854 ".bzrignore",
855 ".bzrtags",
856 /* Mercurial */
857 ".hg",
858 ".hgignore",
859 ".hgtags",
860 /* darcs */
861 "_darcs",
862 NULL
865 for (i = 0; vcs_file[i]; i++)
866 add_exclude (excluded, vcs_file[i], 0);
870 #ifdef REMOTE_SHELL
871 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
873 printer (stream, \
874 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
875 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
876 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
877 quoting_style_args[DEFAULT_QUOTING_STYLE], \
878 DEFAULT_RMT_COMMAND); \
879 printer (stream, " --rsh-command=%s", REMOTE_SHELL); \
880 printer (stream, "\n"); \
882 #else
883 # define DECL_SHOW_DEFAULT_SETTINGS(stream, printer) \
885 printer (stream, \
886 "--format=%s -f%s -b%d --quoting-style=%s --rmt-command=%s", \
887 archive_format_string (DEFAULT_ARCHIVE_FORMAT), \
888 DEFAULT_ARCHIVE, DEFAULT_BLOCKING, \
889 quoting_style_args[DEFAULT_QUOTING_STYLE], \
890 DEFAULT_RMT_COMMAND); \
891 printer (stream, "\n"); \
893 #endif
895 static void
896 show_default_settings (FILE *fp)
897 DECL_SHOW_DEFAULT_SETTINGS(fp, fprintf)
899 static void
900 show_default_settings_fs (argp_fmtstream_t fs)
901 DECL_SHOW_DEFAULT_SETTINGS(fs, argp_fmtstream_printf)
903 static void
904 set_subcommand_option (enum subcommand subcommand)
906 if (subcommand_option != UNKNOWN_SUBCOMMAND
907 && subcommand_option != subcommand)
908 USAGE_ERROR ((0, 0,
909 _("You may not specify more than one `-Acdtrux' option")));
911 subcommand_option = subcommand;
914 static void
915 set_use_compress_program_option (const char *string)
917 if (use_compress_program_option
918 && strcmp (use_compress_program_option, string) != 0)
919 USAGE_ERROR ((0, 0, _("Conflicting compression options")));
921 use_compress_program_option = string;
924 static RETSIGTYPE
925 sigstat (int signo)
927 compute_duration ();
928 print_total_stats ();
929 #ifndef HAVE_SIGACTION
930 signal (signo, sigstat);
931 #endif
934 static void
935 stat_on_signal (int signo)
937 #ifdef HAVE_SIGACTION
938 struct sigaction act;
939 act.sa_handler = sigstat;
940 sigemptyset (&act.sa_mask);
941 act.sa_flags = 0;
942 sigaction (signo, &act, NULL);
943 #else
944 signal (signo, sigstat);
945 #endif
948 void
949 set_stat_signal (const char *name)
951 static struct sigtab
953 char *name;
954 int signo;
955 } sigtab[] = {
956 { "SIGUSR1", SIGUSR1 },
957 { "USR1", SIGUSR1 },
958 { "SIGUSR2", SIGUSR2 },
959 { "USR2", SIGUSR2 },
960 { "SIGHUP", SIGHUP },
961 { "HUP", SIGHUP },
962 { "SIGINT", SIGINT },
963 { "INT", SIGINT },
964 { "SIGQUIT", SIGQUIT },
965 { "QUIT", SIGQUIT }
967 struct sigtab *p;
969 for (p = sigtab; p < sigtab + sizeof (sigtab) / sizeof (sigtab[0]); p++)
970 if (strcmp (p->name, name) == 0)
972 stat_on_signal (p->signo);
973 return;
975 FATAL_ERROR ((0, 0, _("Unknown signal name: %s"), name));
979 struct textual_date
981 struct textual_date *next;
982 struct timespec *ts;
983 const char *option;
984 const char *date;
987 static void
988 get_date_or_file (struct tar_args *args, const char *option,
989 const char *str, struct timespec *ts)
991 if (FILE_SYSTEM_PREFIX_LEN (str) != 0
992 || ISSLASH (*str)
993 || *str == '.')
995 struct stat st;
996 if (deref_stat (dereference_option, str, &st) != 0)
998 stat_error (str);
999 USAGE_ERROR ((0, 0, _("Date sample file not found")));
1001 *ts = get_stat_mtime (&st);
1003 else
1005 if (! get_date (ts, str, NULL))
1007 WARN ((0, 0, _("Substituting %s for unknown date format %s"),
1008 tartime (*ts, false), quote (str)));
1009 ts->tv_nsec = 0;
1011 else
1013 struct textual_date *p = xmalloc (sizeof (*p));
1014 p->ts = ts;
1015 p->option = option;
1016 p->date = str;
1017 p->next = args->textual_date;
1018 args->textual_date = p;
1023 static void
1024 report_textual_dates (struct tar_args *args)
1026 struct textual_date *p;
1027 for (p = args->textual_date; p; )
1029 struct textual_date *next = p->next;
1030 char const *treated_as = tartime (*p->ts, true);
1031 if (strcmp (p->date, treated_as) != 0)
1032 WARN ((0, 0, _("Option %s: Treating date `%s' as %s"),
1033 p->option, p->date, treated_as));
1034 free (p);
1035 p = next;
1040 static volatile int _argp_hang;
1042 enum read_file_list_state /* Result of reading file name from the list file */
1044 file_list_success, /* OK, name read successfully */
1045 file_list_end, /* End of list file */
1046 file_list_zero, /* Zero separator encountered where it should not */
1047 file_list_skip /* Empty (zero-length) entry encountered, skip it */
1050 /* Read from FP a sequence of characters up to FILENAME_TERMINATOR and put them
1051 into STK.
1053 static enum read_file_list_state
1054 read_name_from_file (FILE *fp, struct obstack *stk)
1056 int c;
1057 size_t counter = 0;
1059 for (c = getc (fp); c != EOF && c != filename_terminator; c = getc (fp))
1061 if (c == 0)
1063 /* We have read a zero separator. The file possibly is
1064 zero-separated */
1065 return file_list_zero;
1067 obstack_1grow (stk, c);
1068 counter++;
1071 if (counter == 0 && c != EOF)
1072 return file_list_skip;
1074 obstack_1grow (stk, 0);
1076 return (counter == 0 && c == EOF) ? file_list_end : file_list_success;
1080 static bool files_from_option; /* When set, tar will not refuse to create
1081 empty archives */
1082 static struct obstack argv_stk; /* Storage for additional command line options
1083 read using -T option */
1085 /* Prevent recursive inclusion of the same file */
1086 struct file_id_list
1088 struct file_id_list *next;
1089 ino_t ino;
1090 dev_t dev;
1093 static struct file_id_list *file_id_list;
1095 static void
1096 add_file_id (const char *filename)
1098 struct file_id_list *p;
1099 struct stat st;
1101 if (stat (filename, &st))
1102 stat_fatal (filename);
1103 for (p = file_id_list; p; p = p->next)
1104 if (p->ino == st.st_ino && p->dev == st.st_dev)
1106 FATAL_ERROR ((0, 0, _("%s: file list already read"),
1107 quotearg_colon (filename)));
1109 p = xmalloc (sizeof *p);
1110 p->next = file_id_list;
1111 p->ino = st.st_ino;
1112 p->dev = st.st_dev;
1113 file_id_list = p;
1116 /* Default density numbers for [0-9][lmh] device specifications */
1118 #ifndef LOW_DENSITY_NUM
1119 # define LOW_DENSITY_NUM 0
1120 #endif
1122 #ifndef MID_DENSITY_NUM
1123 # define MID_DENSITY_NUM 8
1124 #endif
1126 #ifndef HIGH_DENSITY_NUM
1127 # define HIGH_DENSITY_NUM 16
1128 #endif
1130 static void
1131 update_argv (const char *filename, struct argp_state *state)
1133 FILE *fp;
1134 size_t count = 0, i;
1135 char *start, *p;
1136 char **new_argv;
1137 size_t new_argc;
1138 bool is_stdin = false;
1139 enum read_file_list_state read_state;
1141 if (!strcmp (filename, "-"))
1143 is_stdin = true;
1144 request_stdin ("-T");
1145 fp = stdin;
1147 else
1149 add_file_id (filename);
1150 if ((fp = fopen (filename, "r")) == NULL)
1151 open_fatal (filename);
1154 while ((read_state = read_name_from_file (fp, &argv_stk)) != file_list_end)
1156 switch (read_state)
1158 case file_list_success:
1159 count++;
1160 break;
1162 case file_list_end: /* won't happen, just to pacify gcc */
1163 break;
1165 case file_list_zero:
1167 size_t size;
1169 WARN ((0, 0, N_("%s: file name read contains nul character"),
1170 quotearg_colon (filename)));
1172 /* Prepare new stack contents */
1173 size = obstack_object_size (&argv_stk);
1174 p = obstack_finish (&argv_stk);
1175 for (; size > 0; size--, p++)
1176 if (*p)
1177 obstack_1grow (&argv_stk, *p);
1178 else
1179 obstack_1grow (&argv_stk, '\n');
1180 obstack_1grow (&argv_stk, 0);
1181 count = 1;
1182 /* Read rest of files using new filename terminator */
1183 filename_terminator = 0;
1184 break;
1187 case file_list_skip:
1188 break;
1192 if (!is_stdin)
1193 fclose (fp);
1195 if (count == 0)
1196 return;
1198 start = obstack_finish (&argv_stk);
1200 if (filename_terminator == 0)
1201 for (p = start; *p; p += strlen (p) + 1)
1202 if (p[0] == '-')
1203 count++;
1205 new_argc = state->argc + count;
1206 new_argv = xmalloc (sizeof (state->argv[0]) * (new_argc + 1));
1207 memcpy (new_argv, state->argv, sizeof (state->argv[0]) * (state->argc + 1));
1208 state->argv = new_argv;
1209 memmove (&state->argv[state->next + count], &state->argv[state->next],
1210 (state->argc - state->next + 1) * sizeof (state->argv[0]));
1212 state->argc = new_argc;
1214 for (i = state->next, p = start; *p; p += strlen (p) + 1, i++)
1216 if (filename_terminator == 0 && p[0] == '-')
1217 state->argv[i++] = "--add-file";
1218 state->argv[i] = p;
1223 static void
1224 tar_help (struct argp_state *state)
1226 argp_fmtstream_t fs;
1227 state->flags |= ARGP_NO_EXIT;
1228 argp_state_help (state, state->out_stream,
1229 ARGP_HELP_STD_HELP & ~ARGP_HELP_BUG_ADDR);
1230 /* FIXME: use struct uparams.rmargin (from argp-help.c) instead of 79 */
1231 fs = argp_make_fmtstream (state->out_stream, 0, 79, 0);
1233 argp_fmtstream_printf (fs, "\n%s\n\n",
1234 _("Valid arguments for --quoting-style options are:"));
1235 tar_list_quoting_styles (fs, " ");
1237 argp_fmtstream_puts (fs, _("\n*This* tar defaults to:\n"));
1238 show_default_settings_fs (fs);
1239 argp_fmtstream_putc (fs, '\n');
1240 argp_fmtstream_printf (fs, _("Report bugs to %s.\n"),
1241 argp_program_bug_address);
1242 argp_fmtstream_free (fs);
1245 static error_t
1246 parse_opt (int key, char *arg, struct argp_state *state)
1248 struct tar_args *args = state->input;
1250 switch (key)
1252 case ARGP_KEY_ARG:
1253 /* File name or non-parsed option, because of ARGP_IN_ORDER */
1254 name_add_name (arg, MAKE_INCL_OPTIONS (args));
1255 args->input_files = true;
1256 break;
1258 case 'A':
1259 set_subcommand_option (CAT_SUBCOMMAND);
1260 break;
1262 case 'a':
1263 args->compress_autodetect = true;
1264 break;
1266 case 'b':
1268 uintmax_t u;
1269 if (! (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK
1270 && u == (blocking_factor = u)
1271 && 0 < blocking_factor
1272 && u == (record_size = u * BLOCKSIZE) / BLOCKSIZE))
1273 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1274 _("Invalid blocking factor")));
1276 break;
1278 case 'B':
1279 /* Try to reblock input records. For reading 4.2BSD pipes. */
1281 /* It would surely make sense to exchange -B and -R, but it seems
1282 that -B has been used for a long while in Sun tar and most
1283 BSD-derived systems. This is a consequence of the block/record
1284 terminology confusion. */
1286 read_full_records_option = true;
1287 break;
1289 case 'c':
1290 set_subcommand_option (CREATE_SUBCOMMAND);
1291 break;
1293 case 'C':
1294 name_add_dir (arg);
1295 break;
1297 case 'd':
1298 set_subcommand_option (DIFF_SUBCOMMAND);
1299 break;
1301 case 'f':
1302 if (archive_names == allocated_archive_names)
1303 archive_name_array = x2nrealloc (archive_name_array,
1304 &allocated_archive_names,
1305 sizeof (archive_name_array[0]));
1307 archive_name_array[archive_names++] = arg;
1308 break;
1310 case 'F':
1311 /* Since -F is only useful with -M, make it implied. Run this
1312 script at the end of each tape. */
1314 info_script_option = arg;
1315 multi_volume_option = true;
1316 break;
1318 case 'g':
1319 listed_incremental_option = arg;
1320 after_date_option = true;
1321 /* Fall through. */
1323 case 'G':
1324 /* We are making an incremental dump (FIXME: are we?); save
1325 directories at the beginning of the archive, and include in each
1326 directory its contents. */
1328 incremental_option = true;
1329 break;
1331 case 'h':
1332 /* Follow symbolic links. */
1333 dereference_option = true;
1334 break;
1336 case HARD_DEREFERENCE_OPTION:
1337 hard_dereference_option = true;
1338 break;
1340 case 'i':
1341 /* Ignore zero blocks (eofs). This can't be the default,
1342 because Unix tar writes two blocks of zeros, then pads out
1343 the record with garbage. */
1345 ignore_zeros_option = true;
1346 break;
1348 case 'I':
1349 USAGE_ERROR ((0, 0,
1350 _("Warning: the -I option is not supported;"
1351 " perhaps you meant -j or -T?")));
1352 break;
1354 case 'j':
1355 set_use_compress_program_option ("bzip2");
1356 break;
1358 case 'k':
1359 /* Don't replace existing files. */
1360 old_files_option = KEEP_OLD_FILES;
1361 break;
1363 case 'K':
1364 starting_file_option = true;
1365 addname (arg, 0);
1366 break;
1368 case ONE_FILE_SYSTEM_OPTION:
1369 /* When dumping directories, don't dump files/subdirectories
1370 that are on other filesystems. */
1371 one_file_system_option = true;
1372 break;
1374 case 'l':
1375 check_links_option = 1;
1376 break;
1378 case 'L':
1380 uintmax_t u;
1381 if (xstrtoumax (arg, 0, 10, &u, "") != LONGINT_OK)
1382 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1383 _("Invalid tape length")));
1384 tape_length_option = 1024 * (tarlong) u;
1385 multi_volume_option = true;
1387 break;
1389 case LZMA_OPTION:
1390 set_use_compress_program_option ("lzma");
1391 break;
1393 case 'm':
1394 touch_option = true;
1395 break;
1397 case 'M':
1398 /* Make multivolume archive: when we can't write any more into
1399 the archive, re-open it, and continue writing. */
1401 multi_volume_option = true;
1402 break;
1404 case MTIME_OPTION:
1405 get_date_or_file (args, "--mtime", arg, &mtime_option);
1406 set_mtime_option = true;
1407 break;
1409 case 'n':
1410 seekable_archive = true;
1411 break;
1413 case 'N':
1414 after_date_option = true;
1415 /* Fall through. */
1417 case NEWER_MTIME_OPTION:
1418 if (NEWER_OPTION_INITIALIZED (newer_mtime_option))
1419 USAGE_ERROR ((0, 0, _("More than one threshold date")));
1420 get_date_or_file (args,
1421 key == NEWER_MTIME_OPTION ? "--newer-mtime"
1422 : "--after-date", arg, &newer_mtime_option);
1423 break;
1425 case 'o':
1426 args->o_option = true;
1427 break;
1429 case 'O':
1430 to_stdout_option = true;
1431 break;
1433 case 'p':
1434 same_permissions_option = true;
1435 break;
1437 case 'P':
1438 absolute_names_option = true;
1439 break;
1441 case 'r':
1442 set_subcommand_option (APPEND_SUBCOMMAND);
1443 break;
1445 case 'R':
1446 /* Print block numbers for debugging bad tar archives. */
1448 /* It would surely make sense to exchange -B and -R, but it seems
1449 that -B has been used for a long while in Sun tar and most
1450 BSD-derived systems. This is a consequence of the block/record
1451 terminology confusion. */
1453 block_number_option = true;
1454 break;
1456 case 's':
1457 /* Names to extract are sorted. */
1459 same_order_option = true;
1460 break;
1462 case 'S':
1463 sparse_option = true;
1464 break;
1466 case SPARSE_VERSION_OPTION:
1467 sparse_option = true;
1469 char *p;
1470 tar_sparse_major = strtoul (arg, &p, 10);
1471 if (*p)
1473 if (*p != '.')
1474 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1475 tar_sparse_minor = strtoul (p + 1, &p, 10);
1476 if (*p)
1477 USAGE_ERROR ((0, 0, _("Invalid sparse version value")));
1480 break;
1482 case 't':
1483 set_subcommand_option (LIST_SUBCOMMAND);
1484 verbose_option++;
1485 break;
1487 case TEST_LABEL_OPTION:
1488 set_subcommand_option (LIST_SUBCOMMAND);
1489 test_label_option = true;
1490 break;
1492 case 'T':
1493 update_argv (arg, state);
1494 /* Indicate we've been given -T option. This is for backward
1495 compatibility only, so that `tar cfT archive /dev/null will
1496 succeed */
1497 files_from_option = true;
1498 break;
1500 case 'u':
1501 set_subcommand_option (UPDATE_SUBCOMMAND);
1502 break;
1504 case 'U':
1505 old_files_option = UNLINK_FIRST_OLD_FILES;
1506 break;
1508 case UTC_OPTION:
1509 utc_option = true;
1510 break;
1512 case 'v':
1513 verbose_option++;
1514 break;
1516 case 'V':
1517 volume_label_option = arg;
1518 break;
1520 case 'w':
1521 interactive_option = true;
1522 break;
1524 case 'W':
1525 verify_option = true;
1526 break;
1528 case 'x':
1529 set_subcommand_option (EXTRACT_SUBCOMMAND);
1530 break;
1532 case 'X':
1533 if (add_exclude_file (add_exclude, excluded, arg,
1534 MAKE_EXCL_OPTIONS (args), '\n')
1535 != 0)
1537 int e = errno;
1538 FATAL_ERROR ((0, e, "%s", quotearg_colon (arg)));
1540 break;
1542 case 'z':
1543 set_use_compress_program_option ("gzip");
1544 break;
1546 case 'Z':
1547 set_use_compress_program_option ("compress");
1548 break;
1550 case ANCHORED_OPTION:
1551 args->matching_flags |= EXCLUDE_ANCHORED;
1552 break;
1554 case ATIME_PRESERVE_OPTION:
1555 atime_preserve_option =
1556 (arg
1557 ? XARGMATCH ("--atime-preserve", arg,
1558 atime_preserve_args, atime_preserve_types)
1559 : replace_atime_preserve);
1560 if (! O_NOATIME && atime_preserve_option == system_atime_preserve)
1561 FATAL_ERROR ((0, 0,
1562 _("--atime-preserve='system' is not supported"
1563 " on this platform")));
1564 break;
1566 case CHECK_DEVICE_OPTION:
1567 check_device_option = true;
1568 break;
1570 case NO_CHECK_DEVICE_OPTION:
1571 check_device_option = false;
1572 break;
1574 case CHECKPOINT_OPTION:
1575 if (arg)
1577 char *p;
1579 if (*arg == '.')
1581 checkpoint_compile_action (".");
1582 arg++;
1584 checkpoint_option = strtoul (arg, &p, 0);
1585 if (*p)
1586 FATAL_ERROR ((0, 0,
1587 _("--checkpoint value is not an integer")));
1589 else
1590 checkpoint_option = DEFAULT_CHECKPOINT;
1591 break;
1593 case CHECKPOINT_ACTION_OPTION:
1594 checkpoint_compile_action (arg);
1595 break;
1597 case BACKUP_OPTION:
1598 backup_option = true;
1599 if (arg)
1600 args->version_control_string = arg;
1601 break;
1603 case DELAY_DIRECTORY_RESTORE_OPTION:
1604 delay_directory_restore_option = true;
1605 break;
1607 case NO_DELAY_DIRECTORY_RESTORE_OPTION:
1608 delay_directory_restore_option = false;
1609 break;
1611 case DELETE_OPTION:
1612 set_subcommand_option (DELETE_SUBCOMMAND);
1613 break;
1615 case EXCLUDE_OPTION:
1616 add_exclude (excluded, arg, MAKE_EXCL_OPTIONS (args));
1617 break;
1619 case EXCLUDE_CACHES_OPTION:
1620 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_contents,
1621 cachedir_file_p);
1622 break;
1624 case EXCLUDE_CACHES_UNDER_OPTION:
1625 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_under,
1626 cachedir_file_p);
1627 break;
1629 case EXCLUDE_CACHES_ALL_OPTION:
1630 add_exclusion_tag ("CACHEDIR.TAG", exclusion_tag_all,
1631 cachedir_file_p);
1632 break;
1634 case EXCLUDE_TAG_OPTION:
1635 add_exclusion_tag (arg, exclusion_tag_contents, NULL);
1636 break;
1638 case EXCLUDE_TAG_UNDER_OPTION:
1639 add_exclusion_tag (arg, exclusion_tag_under, NULL);
1640 break;
1642 case EXCLUDE_TAG_ALL_OPTION:
1643 add_exclusion_tag (arg, exclusion_tag_all, NULL);
1644 break;
1646 case EXCLUDE_VCS_OPTION:
1647 exclude_vcs_files ();
1648 break;
1650 case FORCE_LOCAL_OPTION:
1651 force_local_option = true;
1652 break;
1654 case 'H':
1655 set_archive_format (arg);
1656 break;
1658 case INDEX_FILE_OPTION:
1659 index_file_name = arg;
1660 break;
1662 case IGNORE_CASE_OPTION:
1663 args->matching_flags |= FNM_CASEFOLD;
1664 break;
1666 case IGNORE_COMMAND_ERROR_OPTION:
1667 ignore_command_error_option = true;
1668 break;
1670 case IGNORE_FAILED_READ_OPTION:
1671 ignore_failed_read_option = true;
1672 break;
1674 case KEEP_NEWER_FILES_OPTION:
1675 old_files_option = KEEP_NEWER_FILES;
1676 break;
1678 case GROUP_OPTION:
1679 if (! (strlen (arg) < GNAME_FIELD_SIZE
1680 && gname_to_gid (arg, &group_option)))
1682 uintmax_t g;
1683 if (xstrtoumax (arg, 0, 10, &g, "") == LONGINT_OK
1684 && g == (gid_t) g)
1685 group_option = g;
1686 else
1687 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1688 _("%s: Invalid group")));
1690 break;
1692 case MODE_OPTION:
1693 mode_option = mode_compile (arg);
1694 if (!mode_option)
1695 FATAL_ERROR ((0, 0, _("Invalid mode given on option")));
1696 initial_umask = umask (0);
1697 umask (initial_umask);
1698 break;
1700 case NO_ANCHORED_OPTION:
1701 args->include_anchored = 0; /* Clear the default for comman line args */
1702 args->matching_flags &= ~ EXCLUDE_ANCHORED;
1703 break;
1705 case NO_IGNORE_CASE_OPTION:
1706 args->matching_flags &= ~ FNM_CASEFOLD;
1707 break;
1709 case NO_IGNORE_COMMAND_ERROR_OPTION:
1710 ignore_command_error_option = false;
1711 break;
1713 case NO_OVERWRITE_DIR_OPTION:
1714 old_files_option = NO_OVERWRITE_DIR_OLD_FILES;
1715 break;
1717 case NO_QUOTE_CHARS_OPTION:
1718 for (;*arg; arg++)
1719 set_char_quoting (NULL, *arg, 0);
1720 break;
1722 case NO_WILDCARDS_OPTION:
1723 args->wildcards = disable_wildcards;
1724 break;
1726 case NO_WILDCARDS_MATCH_SLASH_OPTION:
1727 args->matching_flags |= FNM_FILE_NAME;
1728 break;
1730 case NULL_OPTION:
1731 filename_terminator = '\0';
1732 break;
1734 case NUMERIC_OWNER_OPTION:
1735 numeric_owner_option = true;
1736 break;
1738 case OCCURRENCE_OPTION:
1739 if (!arg)
1740 occurrence_option = 1;
1741 else
1743 uintmax_t u;
1744 if (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK)
1745 occurrence_option = u;
1746 else
1747 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1748 _("Invalid number")));
1750 break;
1752 case OVERWRITE_DIR_OPTION:
1753 old_files_option = DEFAULT_OLD_FILES;
1754 break;
1756 case OVERWRITE_OPTION:
1757 old_files_option = OVERWRITE_OLD_FILES;
1758 break;
1760 case OWNER_OPTION:
1761 if (! (strlen (arg) < UNAME_FIELD_SIZE
1762 && uname_to_uid (arg, &owner_option)))
1764 uintmax_t u;
1765 if (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK
1766 && u == (uid_t) u)
1767 owner_option = u;
1768 else
1769 FATAL_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1770 _("Invalid owner")));
1772 break;
1774 case QUOTE_CHARS_OPTION:
1775 for (;*arg; arg++)
1776 set_char_quoting (NULL, *arg, 1);
1777 break;
1779 case QUOTING_STYLE_OPTION:
1780 tar_set_quoting_style (arg);
1781 break;
1783 case PAX_OPTION:
1784 args->pax_option = true;
1785 xheader_set_option (arg);
1786 break;
1788 case POSIX_OPTION:
1789 set_archive_format ("posix");
1790 break;
1792 case PRESERVE_OPTION:
1793 /* FIXME: What it is good for? */
1794 same_permissions_option = true;
1795 same_order_option = true;
1796 break;
1798 case RECORD_SIZE_OPTION:
1800 uintmax_t u;
1801 if (! (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK
1802 && u == (size_t) u))
1803 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1804 _("Invalid record size")));
1805 record_size = u;
1806 if (record_size % BLOCKSIZE != 0)
1807 USAGE_ERROR ((0, 0, _("Record size must be a multiple of %d."),
1808 BLOCKSIZE));
1809 blocking_factor = record_size / BLOCKSIZE;
1811 break;
1813 case RECURSIVE_UNLINK_OPTION:
1814 recursive_unlink_option = true;
1815 break;
1817 case REMOVE_FILES_OPTION:
1818 remove_files_option = true;
1819 break;
1821 case RESTRICT_OPTION:
1822 restrict_option = true;
1823 break;
1825 case RMT_COMMAND_OPTION:
1826 rmt_command = arg;
1827 break;
1829 case RSH_COMMAND_OPTION:
1830 rsh_command_option = arg;
1831 break;
1833 case SHOW_DEFAULTS_OPTION:
1834 show_default_settings (stdout);
1835 close_stdout ();
1836 exit (0);
1838 case STRIP_COMPONENTS_OPTION:
1840 uintmax_t u;
1841 if (! (xstrtoumax (arg, 0, 10, &u, "") == LONGINT_OK
1842 && u == (size_t) u))
1843 USAGE_ERROR ((0, 0, "%s: %s", quotearg_colon (arg),
1844 _("Invalid number of elements")));
1845 strip_name_components = u;
1847 break;
1849 case SHOW_OMITTED_DIRS_OPTION:
1850 show_omitted_dirs_option = true;
1851 break;
1853 case SHOW_TRANSFORMED_NAMES_OPTION:
1854 show_transformed_names_option = true;
1855 break;
1857 case SUFFIX_OPTION:
1858 backup_option = true;
1859 args->backup_suffix_string = arg;
1860 break;
1862 case TO_COMMAND_OPTION:
1863 if (to_command_option)
1864 USAGE_ERROR ((0, 0, _("Only one --to-command option allowed")));
1865 to_command_option = arg;
1866 break;
1868 case TOTALS_OPTION:
1869 if (arg)
1870 set_stat_signal (arg);
1871 else
1872 totals_option = true;
1873 break;
1875 case TRANSFORM_OPTION:
1876 set_transform_expr (arg);
1877 break;
1879 case USE_COMPRESS_PROGRAM_OPTION:
1880 set_use_compress_program_option (arg);
1881 break;
1883 case VOLNO_FILE_OPTION:
1884 volno_file_option = arg;
1885 break;
1887 case WILDCARDS_OPTION:
1888 args->wildcards = enable_wildcards;
1889 break;
1891 case WILDCARDS_MATCH_SLASH_OPTION:
1892 args->matching_flags &= ~ FNM_FILE_NAME;
1893 break;
1895 case NO_RECURSION_OPTION:
1896 recursion_option = 0;
1897 break;
1899 case NO_SAME_OWNER_OPTION:
1900 same_owner_option = -1;
1901 break;
1903 case NO_SAME_PERMISSIONS_OPTION:
1904 same_permissions_option = -1;
1905 break;
1907 case RECURSION_OPTION:
1908 recursion_option = FNM_LEADING_DIR;
1909 break;
1911 case SAME_OWNER_OPTION:
1912 same_owner_option = 1;
1913 break;
1915 case UNQUOTE_OPTION:
1916 unquote_option = true;
1917 break;
1919 case NO_UNQUOTE_OPTION:
1920 unquote_option = false;
1921 break;
1923 case '0':
1924 case '1':
1925 case '2':
1926 case '3':
1927 case '4':
1928 case '5':
1929 case '6':
1930 case '7':
1932 #ifdef DEVICE_PREFIX
1934 int device = key - '0';
1935 int density;
1936 static char buf[sizeof DEVICE_PREFIX + 10];
1937 char *cursor;
1939 if (arg[1])
1940 argp_error (state, _("Malformed density argument: %s"), quote (arg));
1942 strcpy (buf, DEVICE_PREFIX);
1943 cursor = buf + strlen (buf);
1945 #ifdef DENSITY_LETTER
1947 sprintf (cursor, "%d%c", device, arg[0]);
1949 #else /* not DENSITY_LETTER */
1951 switch (arg[0])
1953 case 'l':
1954 device += LOW_DENSITY_NUM;
1955 break;
1957 case 'm':
1958 device += MID_DENSITY_NUM;
1959 break;
1961 case 'h':
1962 device += HIGH_DENSITY_NUM;
1963 break;
1965 default:
1966 argp_error (state, _("Unknown density: `%c'"), arg[0]);
1968 sprintf (cursor, "%d", device);
1970 #endif /* not DENSITY_LETTER */
1972 if (archive_names == allocated_archive_names)
1973 archive_name_array = x2nrealloc (archive_name_array,
1974 &allocated_archive_names,
1975 sizeof (archive_name_array[0]));
1976 archive_name_array[archive_names++] = xstrdup (buf);
1978 break;
1980 #else /* not DEVICE_PREFIX */
1982 argp_error (state,
1983 _("Options `-[0-7][lmh]' not supported by *this* tar"));
1985 #endif /* not DEVICE_PREFIX */
1987 case '?':
1988 tar_help (state);
1989 close_stdout ();
1990 exit (0);
1992 case USAGE_OPTION:
1993 argp_state_help (state, state->out_stream, ARGP_HELP_USAGE);
1994 close_stdout ();
1995 exit (0);
1997 case VERSION_OPTION:
1998 version_etc (state->out_stream, "tar", PACKAGE_NAME, VERSION,
1999 "John Gilmore", "Jay Fenlason", (char *) NULL);
2000 close_stdout ();
2001 exit (0);
2003 case HANG_OPTION:
2004 _argp_hang = atoi (arg ? arg : "3600");
2005 while (_argp_hang-- > 0)
2006 sleep (1);
2007 break;
2009 default:
2010 return ARGP_ERR_UNKNOWN;
2012 return 0;
2015 static struct argp argp = {
2016 options,
2017 parse_opt,
2018 N_("[FILE]..."),
2019 doc,
2020 NULL,
2021 NULL,
2022 NULL
2025 void
2026 usage (int status)
2028 argp_help (&argp, stderr, ARGP_HELP_SEE, (char*) program_name);
2029 close_stdout ();
2030 exit (status);
2033 /* Parse the options for tar. */
2035 static struct argp_option *
2036 find_argp_option (struct argp_option *o, int letter)
2038 for (;
2039 !(o->name == NULL
2040 && o->key == 0
2041 && o->arg == 0
2042 && o->flags == 0
2043 && o->doc == NULL); o++)
2044 if (o->key == letter)
2045 return o;
2046 return NULL;
2049 static void
2050 decode_options (int argc, char **argv)
2052 int idx;
2053 struct tar_args args;
2055 /* Set some default option values. */
2056 args.textual_date = NULL;
2057 args.wildcards = default_wildcards;
2058 args.matching_flags = 0;
2059 args.include_anchored = EXCLUDE_ANCHORED;
2060 args.o_option = false;
2061 args.pax_option = false;
2062 args.backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
2063 args.version_control_string = 0;
2064 args.input_files = false;
2065 args.compress_autodetect = false;
2067 subcommand_option = UNKNOWN_SUBCOMMAND;
2068 archive_format = DEFAULT_FORMAT;
2069 blocking_factor = DEFAULT_BLOCKING;
2070 record_size = DEFAULT_BLOCKING * BLOCKSIZE;
2071 excluded = new_exclude ();
2072 newer_mtime_option.tv_sec = TYPE_MINIMUM (time_t);
2073 newer_mtime_option.tv_nsec = -1;
2074 recursion_option = FNM_LEADING_DIR;
2075 unquote_option = true;
2076 tar_sparse_major = 1;
2077 tar_sparse_minor = 0;
2079 owner_option = -1;
2080 group_option = -1;
2082 check_device_option = true;
2084 /* Convert old-style tar call by exploding option element and rearranging
2085 options accordingly. */
2087 if (argc > 1 && argv[1][0] != '-')
2089 int new_argc; /* argc value for rearranged arguments */
2090 char **new_argv; /* argv value for rearranged arguments */
2091 char *const *in; /* cursor into original argv */
2092 char **out; /* cursor into rearranged argv */
2093 const char *letter; /* cursor into old option letters */
2094 char buffer[3]; /* constructed option buffer */
2096 /* Initialize a constructed option. */
2098 buffer[0] = '-';
2099 buffer[2] = '\0';
2101 /* Allocate a new argument array, and copy program name in it. */
2103 new_argc = argc - 1 + strlen (argv[1]);
2104 new_argv = xmalloc ((new_argc + 1) * sizeof (char *));
2105 in = argv;
2106 out = new_argv;
2107 *out++ = *in++;
2109 /* Copy each old letter option as a separate option, and have the
2110 corresponding argument moved next to it. */
2112 for (letter = *in++; *letter; letter++)
2114 struct argp_option *opt;
2116 buffer[1] = *letter;
2117 *out++ = xstrdup (buffer);
2118 opt = find_argp_option (options, *letter);
2119 if (opt && opt->arg)
2121 if (in < argv + argc)
2122 *out++ = *in++;
2123 else
2124 USAGE_ERROR ((0, 0, _("Old option `%c' requires an argument."),
2125 *letter));
2129 /* Copy all remaining options. */
2131 while (in < argv + argc)
2132 *out++ = *in++;
2133 *out = 0;
2135 /* Replace the old option list by the new one. */
2137 argc = new_argc;
2138 argv = new_argv;
2141 /* Parse all options and non-options as they appear. */
2143 prepend_default_options (getenv ("TAR_OPTIONS"), &argc, &argv);
2145 if (argp_parse (&argp, argc, argv, ARGP_IN_ORDER|ARGP_NO_HELP,
2146 &idx, &args))
2147 exit (TAREXIT_FAILURE);
2150 /* Special handling for 'o' option:
2152 GNU tar used to say "output old format".
2153 UNIX98 tar says don't chown files after extracting (we use
2154 "--no-same-owner" for this).
2156 The old GNU tar semantics is retained when used with --create
2157 option, otherwise UNIX98 semantics is assumed */
2159 if (args.o_option)
2161 if (subcommand_option == CREATE_SUBCOMMAND)
2163 /* GNU Tar <= 1.13 compatibility */
2164 set_archive_format ("v7");
2166 else
2168 /* UNIX98 compatibility */
2169 same_owner_option = -1;
2173 /* Handle operands after any "--" argument. */
2174 for (; idx < argc; idx++)
2176 name_add_name (argv[idx], MAKE_INCL_OPTIONS (&args));
2177 args.input_files = true;
2180 /* Warn about implicit use of the wildcards in command line arguments.
2181 See TODO */
2182 warn_regex_usage = args.wildcards == default_wildcards;
2184 /* Derive option values and check option consistency. */
2186 if (archive_format == DEFAULT_FORMAT)
2188 if (args.pax_option)
2189 archive_format = POSIX_FORMAT;
2190 else
2191 archive_format = DEFAULT_ARCHIVE_FORMAT;
2194 if ((volume_label_option && subcommand_option == CREATE_SUBCOMMAND)
2195 || incremental_option
2196 || multi_volume_option
2197 || sparse_option)
2198 assert_format (FORMAT_MASK (OLDGNU_FORMAT)
2199 | FORMAT_MASK (GNU_FORMAT)
2200 | FORMAT_MASK (POSIX_FORMAT));
2202 if (occurrence_option)
2204 if (!args.input_files)
2205 USAGE_ERROR ((0, 0,
2206 _("--occurrence is meaningless without a file list")));
2207 if (subcommand_option != DELETE_SUBCOMMAND
2208 && subcommand_option != DIFF_SUBCOMMAND
2209 && subcommand_option != EXTRACT_SUBCOMMAND
2210 && subcommand_option != LIST_SUBCOMMAND)
2211 USAGE_ERROR ((0, 0,
2212 _("--occurrence cannot be used in the requested operation mode")));
2215 if (seekable_archive && subcommand_option == DELETE_SUBCOMMAND)
2217 /* The current code in delete.c is based on the assumption that
2218 skip_member() reads all data from the archive. So, we should
2219 make sure it won't use seeks. On the other hand, the same code
2220 depends on the ability to backspace a record in the archive,
2221 so setting seekable_archive to false is technically incorrect.
2222 However, it is tested only in skip_member(), so it's not a
2223 problem. */
2224 seekable_archive = false;
2227 if (archive_names == 0)
2229 /* If no archive file name given, try TAPE from the environment, or
2230 else, DEFAULT_ARCHIVE from the configuration process. */
2232 archive_names = 1;
2233 archive_name_array[0] = getenv ("TAPE");
2234 if (! archive_name_array[0])
2235 archive_name_array[0] = DEFAULT_ARCHIVE;
2238 /* Allow multiple archives only with `-M'. */
2240 if (archive_names > 1 && !multi_volume_option)
2241 USAGE_ERROR ((0, 0,
2242 _("Multiple archive files require `-M' option")));
2244 if (listed_incremental_option
2245 && NEWER_OPTION_INITIALIZED (newer_mtime_option))
2246 USAGE_ERROR ((0, 0,
2247 _("Cannot combine --listed-incremental with --newer")));
2249 if (volume_label_option)
2251 if (archive_format == GNU_FORMAT || archive_format == OLDGNU_FORMAT)
2253 size_t volume_label_max_len =
2254 (sizeof current_header->header.name
2255 - 1 /* for trailing '\0' */
2256 - (multi_volume_option
2257 ? (sizeof " Volume "
2258 - 1 /* for null at end of " Volume " */
2259 + INT_STRLEN_BOUND (int) /* for volume number */
2260 - 1 /* for sign, as 0 <= volno */)
2261 : 0));
2262 if (volume_label_max_len < strlen (volume_label_option))
2263 USAGE_ERROR ((0, 0,
2264 ngettext ("%s: Volume label is too long (limit is %lu byte)",
2265 "%s: Volume label is too long (limit is %lu bytes)",
2266 volume_label_max_len),
2267 quotearg_colon (volume_label_option),
2268 (unsigned long) volume_label_max_len));
2270 /* else FIXME
2271 Label length in PAX format is limited by the volume size. */
2274 if (verify_option)
2276 if (multi_volume_option)
2277 USAGE_ERROR ((0, 0, _("Cannot verify multi-volume archives")));
2278 if (use_compress_program_option)
2279 USAGE_ERROR ((0, 0, _("Cannot verify compressed archives")));
2282 if (use_compress_program_option)
2284 if (multi_volume_option)
2285 USAGE_ERROR ((0, 0, _("Cannot use multi-volume compressed archives")));
2286 if (subcommand_option == UPDATE_SUBCOMMAND
2287 || subcommand_option == APPEND_SUBCOMMAND
2288 || subcommand_option == DELETE_SUBCOMMAND)
2289 USAGE_ERROR ((0, 0, _("Cannot update compressed archives")));
2290 if (subcommand_option == CAT_SUBCOMMAND)
2291 USAGE_ERROR ((0, 0, _("Cannot concatenate compressed archives")));
2294 /* It is no harm to use --pax-option on non-pax archives in archive
2295 reading mode. It may even be useful, since it allows to override
2296 file attributes from tar headers. Therefore I allow such usage.
2297 --gray */
2298 if (args.pax_option
2299 && archive_format != POSIX_FORMAT
2300 && (subcommand_option != EXTRACT_SUBCOMMAND
2301 || subcommand_option != DIFF_SUBCOMMAND
2302 || subcommand_option != LIST_SUBCOMMAND))
2303 USAGE_ERROR ((0, 0, _("--pax-option can be used only on POSIX archives")));
2305 /* If ready to unlink hierarchies, so we are for simpler files. */
2306 if (recursive_unlink_option)
2307 old_files_option = UNLINK_FIRST_OLD_FILES;
2310 if (test_label_option)
2312 /* --test-label is silent if the user has specified the label name to
2313 compare against. */
2314 if (!args.input_files)
2315 verbose_option++;
2317 else if (utc_option)
2318 verbose_option = 2;
2320 /* Forbid using -c with no input files whatsoever. Check that `-f -',
2321 explicit or implied, is used correctly. */
2323 switch (subcommand_option)
2325 case CREATE_SUBCOMMAND:
2326 if (!args.input_files && !files_from_option)
2327 USAGE_ERROR ((0, 0,
2328 _("Cowardly refusing to create an empty archive")));
2329 if (args.compress_autodetect && archive_names
2330 && strcmp (archive_name_array[0], "-"))
2331 set_comression_program_by_suffix (archive_name_array[0],
2332 use_compress_program_option);
2333 break;
2335 case EXTRACT_SUBCOMMAND:
2336 case LIST_SUBCOMMAND:
2337 case DIFF_SUBCOMMAND:
2338 for (archive_name_cursor = archive_name_array;
2339 archive_name_cursor < archive_name_array + archive_names;
2340 archive_name_cursor++)
2341 if (!strcmp (*archive_name_cursor, "-"))
2342 request_stdin ("-f");
2343 break;
2345 case CAT_SUBCOMMAND:
2346 case UPDATE_SUBCOMMAND:
2347 case APPEND_SUBCOMMAND:
2348 for (archive_name_cursor = archive_name_array;
2349 archive_name_cursor < archive_name_array + archive_names;
2350 archive_name_cursor++)
2351 if (!strcmp (*archive_name_cursor, "-"))
2352 USAGE_ERROR ((0, 0,
2353 _("Options `-Aru' are incompatible with `-f -'")));
2355 default:
2356 break;
2359 /* Initialize stdlis */
2360 if (index_file_name)
2362 stdlis = fopen (index_file_name, "w");
2363 if (! stdlis)
2364 open_error (index_file_name);
2366 else
2367 stdlis = to_stdout_option ? stderr : stdout;
2369 archive_name_cursor = archive_name_array;
2371 /* Prepare for generating backup names. */
2373 if (args.backup_suffix_string)
2374 simple_backup_suffix = xstrdup (args.backup_suffix_string);
2376 if (backup_option)
2378 backup_type = xget_version ("--backup", args.version_control_string);
2379 /* No backup is needed either if explicitely disabled or if
2380 the extracted files are not being written to disk. */
2381 if (backup_type == no_backups || EXTRACT_OVER_PIPE)
2382 backup_option = false;
2385 checkpoint_finish_compile ();
2387 if (verbose_option)
2388 report_textual_dates (&args);
2392 /* Tar proper. */
2394 /* Main routine for tar. */
2396 main (int argc, char **argv)
2398 set_start_time ();
2399 program_name = argv[0];
2401 setlocale (LC_ALL, "");
2402 bindtextdomain (PACKAGE, LOCALEDIR);
2403 textdomain (PACKAGE);
2405 exit_failure = TAREXIT_FAILURE;
2406 exit_status = TAREXIT_SUCCESS;
2407 filename_terminator = '\n';
2408 set_quoting_style (0, DEFAULT_QUOTING_STYLE);
2410 /* Make sure we have first three descriptors available */
2411 stdopen ();
2413 /* Pre-allocate a few structures. */
2415 allocated_archive_names = 10;
2416 archive_name_array =
2417 xmalloc (sizeof (const char *) * allocated_archive_names);
2418 archive_names = 0;
2420 obstack_init (&argv_stk);
2422 #ifdef SIGCHLD
2423 /* System V fork+wait does not work if SIGCHLD is ignored. */
2424 signal (SIGCHLD, SIG_DFL);
2425 #endif
2427 /* Decode options. */
2429 decode_options (argc, argv);
2431 name_init ();
2433 /* Main command execution. */
2435 if (volno_file_option)
2436 init_volume_number ();
2438 switch (subcommand_option)
2440 case UNKNOWN_SUBCOMMAND:
2441 USAGE_ERROR ((0, 0,
2442 _("You must specify one of the `-Acdtrux' options")));
2444 case CAT_SUBCOMMAND:
2445 case UPDATE_SUBCOMMAND:
2446 case APPEND_SUBCOMMAND:
2447 update_archive ();
2448 break;
2450 case DELETE_SUBCOMMAND:
2451 delete_archive_members ();
2452 break;
2454 case CREATE_SUBCOMMAND:
2455 create_archive ();
2456 break;
2458 case EXTRACT_SUBCOMMAND:
2459 extr_init ();
2460 read_and (extract_archive);
2462 /* FIXME: should extract_finish () even if an ordinary signal is
2463 received. */
2464 extract_finish ();
2466 break;
2468 case LIST_SUBCOMMAND:
2469 read_and (list_archive);
2470 break;
2472 case DIFF_SUBCOMMAND:
2473 diff_init ();
2474 read_and (diff_archive);
2475 break;
2478 if (totals_option)
2479 print_total_stats ();
2481 if (check_links_option)
2482 check_links ();
2484 if (volno_file_option)
2485 closeout_volume_number ();
2487 /* Dispose of allocated memory, and return. */
2489 free (archive_name_array);
2490 name_term ();
2492 if (exit_status == TAREXIT_FAILURE)
2493 error (0, 0, _("Exiting with failure status due to previous errors"));
2495 if (stdlis == stdout)
2496 close_stdout ();
2497 else if (ferror (stderr) || fclose (stderr) != 0)
2498 exit_status = TAREXIT_FAILURE;
2500 return exit_status;
2503 void
2504 tar_stat_init (struct tar_stat_info *st)
2506 memset (st, 0, sizeof (*st));
2509 void
2510 tar_stat_destroy (struct tar_stat_info *st)
2512 free (st->orig_file_name);
2513 free (st->file_name);
2514 free (st->link_name);
2515 free (st->uname);
2516 free (st->gname);
2517 free (st->sparse_map);
2518 free (st->dumpdir);
2519 xheader_destroy (&st->xhdr);
2520 memset (st, 0, sizeof (*st));
2523 /* Format mask for all available formats that support nanosecond
2524 timestamp resolution. */
2525 #define NS_PRECISION_FORMAT_MASK FORMAT_MASK (POSIX_FORMAT)
2527 /* Same as timespec_cmp, but ignore nanoseconds if current archive
2528 format does not provide sufficient resolution. */
2530 tar_timespec_cmp (struct timespec a, struct timespec b)
2532 if (!(FORMAT_MASK (current_format) & NS_PRECISION_FORMAT_MASK))
2533 a.tv_nsec = b.tv_nsec = 0;
2534 return timespec_cmp (a, b);