1 ///////////////////////////////////////////////////////////////////////////////
4 /// \brief Printing messages to stderr
6 // Author: Lasse Collin
8 // This file has been put into the public domain.
9 // You can do whatever you want with this file.
11 ///////////////////////////////////////////////////////////////////////////////
15 #ifdef HAVE_SYS_TIME_H
16 # include <sys/time.h>
22 /// Name of the program which is prefixed to the error messages.
23 static const char *argv0;
25 /// Number of the current file
26 static unsigned int files_pos = 0;
28 /// Total number of input files; zero if unknown.
29 static unsigned int files_total;
32 static enum message_verbosity verbosity = V_WARNING;
34 /// Filename which we will print with the verbose messages
35 static const char *filename;
37 /// True once the a filename has been printed to stderr as part of progress
38 /// message. If automatic progress updating isn't enabled, this becomes true
39 /// after the first progress message has been printed due to user sending
40 /// SIGINFO, SIGUSR1, or SIGALRM. Once this variable is true, we will print
41 /// an empty line before the next filename to make the output more readable.
42 static bool first_filename_printed = false;
44 /// This is set to true when we have printed the current filename to stderr
45 /// as part of a progress message. This variable is useful only if not
46 /// updating progress automatically: if user sends many SIGINFO, SIGUSR1, or
47 /// SIGALRM signals, we won't print the name of the same file multiple times.
48 static bool current_filename_printed = false;
50 /// True if we should print progress indicator and update it automatically
51 /// if also verbose >= V_VERBOSE.
52 static bool progress_automatic;
54 /// True if message_progress_start() has been called but
55 /// message_progress_end() hasn't been called yet.
56 static bool progress_started = false;
58 /// This is true when a progress message was printed and the cursor is still
59 /// on the same line with the progress message. In that case, a newline has
60 /// to be printed before any error messages.
61 static bool progress_active = false;
63 /// Pointer to lzma_stream used to do the encoding or decoding.
64 static lzma_stream *progress_strm;
66 /// Expected size of the input stream is needed to show completion percentage
67 /// and estimate remaining time.
68 static uint64_t expected_in_size;
70 /// Time when we started processing the file
71 static uint64_t start_time;
74 // Use alarm() and SIGALRM when they are supported. This has two minor
75 // advantages over the alternative of polling gettimeofday():
76 // - It is possible for the user to send SIGINFO, SIGUSR1, or SIGALRM to
77 // get intermediate progress information even when --verbose wasn't used
78 // or stderr is not a terminal.
79 // - alarm() + SIGALRM seems to have slightly less overhead than polling
83 /// The signal handler for SIGALRM sets this to true. It is set back to false
84 /// once the progress message has been updated.
85 static volatile sig_atomic_t progress_needs_updating = false;
87 /// Signal handler for SIGALRM
89 progress_signal_handler(int sig lzma_attribute((unused)))
91 progress_needs_updating = true;
97 /// This is true when progress message printing is wanted. Using the same
98 /// variable name as above to avoid some ifdefs.
99 static bool progress_needs_updating = false;
101 /// Elapsed time when the next progress message update should be done.
102 static uint64_t progress_next_update;
107 /// Get the current time as microseconds since epoch
112 gettimeofday(&tv, NULL);
113 return (uint64_t)(tv.tv_sec) * UINT64_C(1000000) + tv.tv_usec;
117 /// Wrapper for snprintf() to help constructing a string in pieces.
118 static void lzma_attribute((format(printf, 3, 4)))
119 my_snprintf(char **pos, size_t *left, const char *fmt, ...)
123 const int len = vsnprintf(*pos, *left, fmt, ap);
126 // If an error occurred, we want the caller to think that the whole
127 // buffer was used. This way no more data will be written to the
128 // buffer. We don't need better error handling here.
129 if (len < 0 || (size_t)(len) >= *left) {
141 message_init(const char *given_argv0)
143 // Name of the program
146 // If --verbose is used, we use a progress indicator if and only
147 // if stderr is a terminal. If stderr is not a terminal, we print
148 // verbose information only after finishing the file. As a special
149 // exception, even if --verbose was not used, user can send SIGALRM
150 // to make us print progress information once without automatic
152 progress_automatic = isatty(STDERR_FILENO);
154 // Commented out because COLUMNS is rarely exported to environment.
155 // Most users have at least 80 columns anyway, let's think something
156 // fancy here if enough people complain.
158 if (progress_automatic) {
159 // stderr is a terminal. Check the COLUMNS environment
160 // variable to see if the terminal is wide enough. If COLUMNS
161 // doesn't exist or it has some unparseable value, we assume
162 // that the terminal is wide enough.
163 const char *columns_str = getenv("COLUMNS");
164 if (columns_str != NULL) {
166 const long columns = strtol(columns_str, &endptr, 10);
167 if (*endptr != '\0' || columns < 80)
168 progress_automatic = false;
174 // At least DJGPP lacks SA_RESTART. It's not essential for us (the
175 // rest of the code can handle interrupted system calls), so just
178 # define SA_RESTART 0
180 // Establish the signal handlers which set a flag to tell us that
181 // progress info should be updated. Since these signals don't
182 // require any quick action, we set SA_RESTART.
183 static const int sigs[] = {
196 sigemptyset(&sa.sa_mask);
197 sa.sa_flags = SA_RESTART;
198 sa.sa_handler = &progress_signal_handler;
200 for (size_t i = 0; i < ARRAY_SIZE(sigs); ++i)
201 if (sigaction(sigs[i], &sa, NULL))
202 message_signal_handler();
210 message_verbosity_increase(void)
212 if (verbosity < V_DEBUG)
220 message_verbosity_decrease(void)
222 if (verbosity > V_SILENT)
230 message_set_files(unsigned int files)
237 /// Prints the name of the current file if it hasn't been printed already,
238 /// except if we are processing exactly one stream from stdin to stdout.
239 /// I think it looks nicer to not print "(stdin)" when --verbose is used
240 /// in a pipe and no other files are processed.
244 if (!current_filename_printed
245 && (files_total != 1 || filename != stdin_filename)) {
248 // If a file was already processed, put an empty line
249 // before the next filename to improve readability.
250 if (first_filename_printed)
253 first_filename_printed = true;
254 current_filename_printed = true;
256 // If we don't know how many files there will be due
257 // to usage of --files or --files0.
258 if (files_total == 0)
259 fprintf(stderr, "%s (%u)\n", filename,
262 fprintf(stderr, "%s (%u/%u)\n", filename,
263 files_pos, files_total);
273 message_progress_start(
274 lzma_stream *strm, const char *src_name, uint64_t in_size)
276 // Store the pointer to the lzma_stream used to do the coding.
277 // It is needed to find out the position in the stream.
278 progress_strm = strm;
280 // Store the processing start time of the file and its expected size.
281 // If we aren't printing any statistics, then these are unused. But
282 // since it is possible that the user sends us a signal to show
283 // statistics, we need to have these available anyway.
284 start_time = my_time();
286 expected_in_size = in_size;
288 // Indicate that progress info may need to be printed before
289 // printing error messages.
290 progress_started = true;
292 // Indicate the name of this file hasn't been printed to
294 current_filename_printed = false;
296 // Start numbering the files starting from one.
299 // If progress indicator is wanted, print the filename and possibly
300 // the file count now.
301 if (verbosity >= V_VERBOSE && progress_automatic) {
302 // Print the filename to stderr if that is appropriate with
303 // the current settings.
306 // Start the timer to display the first progress message
307 // after one second. An alternative would be to show the
308 // first message almost immediatelly, but delaying by one
309 // second looks better to me, since extremely early
310 // progress info is pretty much useless.
312 // First disable a possibly existing alarm.
314 progress_needs_updating = false;
317 progress_needs_updating = true;
318 progress_next_update = 1000000;
326 /// Make the string indicating completion percentage.
328 progress_percentage(uint64_t in_pos, bool final)
330 static char buf[sizeof("100.0 %")];
335 // Use floating point conversion of snprintf() also for
336 // 100.0 % instead of fixed string, because the decimal
337 // separator isn't a dot in all locales.
340 // If the size of the input file is unknown or the size told us is
341 // clearly wrong since we have processed more data than the alleged
342 // size of the file, show a static string indicating that we have
343 // no idea of the completion percentage.
344 if (expected_in_size == 0 || in_pos > expected_in_size)
347 // Never show 100.0 % before we actually are finished.
348 percentage = (double)(in_pos) / (double)(expected_in_size)
352 snprintf(buf, sizeof(buf), "%.1f %%", percentage);
359 progress_sizes_helper(char **pos, size_t *left, uint64_t value, bool final)
361 // Allow high precision only for the final message, since it looks
362 // stupid for in-progress information.
364 // At maximum of four digits is allowed for exact byte count.
366 my_snprintf(pos, left, "%'" PRIu64 " B", value);
370 // At maximum of five significant digits is allowed for KiB.
371 if (value < UINT64_C(10239900)) {
372 my_snprintf(pos, left, "%'.1f KiB",
373 (double)(value) / 1024.0);
378 // Otherwise we use MiB.
379 my_snprintf(pos, left, "%'.1f MiB",
380 (double)(value) / (1024.0 * 1024.0));
386 /// Make the string containing the amount of input processed, amount of
387 /// output produced, and the compression ratio.
389 progress_sizes(uint64_t compressed_pos, uint64_t uncompressed_pos, bool final)
391 // This is enough to hold sizes up to about 99 TiB if thousand
392 // separator is used, or about 1 PiB without thousand separator.
393 // After that the progress indicator will look a bit silly, since
394 // the compression ratio no longer fits with three decimal places.
398 size_t left = sizeof(buf);
400 // Print the sizes. If this the final message, use more reasonable
401 // units than MiB if the file was small.
402 progress_sizes_helper(&pos, &left, compressed_pos, final);
403 my_snprintf(&pos, &left, " / ");
404 progress_sizes_helper(&pos, &left, uncompressed_pos, final);
406 // Avoid division by zero. If we cannot calculate the ratio, set
407 // it to some nice number greater than 10.0 so that it gets caught
408 // in the next if-clause.
409 const double ratio = uncompressed_pos > 0
410 ? (double)(compressed_pos) / (double)(uncompressed_pos)
413 // If the ratio is very bad, just indicate that it is greater than
414 // 9.999. This way the length of the ratio field stays fixed.
416 snprintf(pos, left, " > %.3f", 9.999);
418 snprintf(pos, left, " = %.3f", ratio);
424 /// Make the string containing the processing speed of uncompressed data.
426 progress_speed(uint64_t uncompressed_pos, uint64_t elapsed)
428 // Don't print the speed immediatelly, since the early values look
429 // like somewhat random.
430 if (elapsed < 3000000)
433 static const char unit[][8] = {
439 size_t unit_index = 0;
441 // Calculate the speed as KiB/s.
442 double speed = (double)(uncompressed_pos)
443 / ((double)(elapsed) * (1024.0 / 1e6));
445 // Adjust the unit of the speed if needed.
446 while (speed > 999.0) {
448 if (++unit_index == ARRAY_SIZE(unit))
449 return ""; // Way too fast ;-)
452 // Use decimal point only if the number is small. Examples:
457 static char buf[sizeof("999 GiB/s")];
458 snprintf(buf, sizeof(buf), "%.*f %s",
459 speed > 9.9 ? 0 : 1, speed, unit[unit_index]);
464 /// Make a string indicating elapsed or remaining time. The format is either
465 /// M:SS or H:MM:SS depending on if the time is an hour or more.
467 progress_time(uint64_t useconds)
469 // 9999 hours = 416 days
470 static char buf[sizeof("9999:59:59")];
472 uint32_t seconds = useconds / 1000000;
474 // Don't show anything if the time is zero or ridiculously big.
475 if (seconds == 0 || seconds > ((9999 * 60) + 59) * 60 + 59)
478 uint32_t minutes = seconds / 60;
482 const uint32_t hours = minutes / 60;
484 snprintf(buf, sizeof(buf),
485 "%" PRIu32 ":%02" PRIu32 ":%02" PRIu32,
486 hours, minutes, seconds);
488 snprintf(buf, sizeof(buf), "%" PRIu32 ":%02" PRIu32,
496 /// Make the string to contain the estimated remaining time, or if the amount
497 /// of input isn't known, how much time has elapsed.
499 progress_remaining(uint64_t in_pos, uint64_t elapsed)
501 // Show the amount of time spent so far when making an estimate of
502 // remaining time wouldn't be reasonable:
503 // - Input size is unknown.
504 // - Input has grown bigger since we started (de)compressing.
505 // - We haven't processed much data yet, so estimate would be
507 // - Only a few seconds has passed since we started (de)compressing,
508 // so estimate would be too inaccurate.
509 if (expected_in_size == 0 || in_pos > expected_in_size
510 || in_pos < (UINT64_C(1) << 19) || elapsed < 8000000)
511 return progress_time(elapsed);
513 // Calculate the estimate. Don't give an estimate of zero seconds,
514 // since it is possible that all the input has been already passed
515 // to the library, but there is still quite a bit of output pending.
516 uint32_t remaining = (double)(expected_in_size - in_pos)
517 * ((double)(elapsed) / 1e6) / (double)(in_pos);
521 static char buf[sizeof("9 h 55 min")];
523 // Select appropriate precision for the estimated remaining time.
524 if (remaining <= 10) {
525 // At maximum of 10 seconds remaining.
526 // Show the number of seconds as is.
527 snprintf(buf, sizeof(buf), "%" PRIu32 " s", remaining);
529 } else if (remaining <= 50) {
530 // At maximum of 50 seconds remaining.
531 // Round up to the next multiple of five seconds.
532 remaining = (remaining + 4) / 5 * 5;
533 snprintf(buf, sizeof(buf), "%" PRIu32 " s", remaining);
535 } else if (remaining <= 590) {
536 // At maximum of 9 minutes and 50 seconds remaining.
537 // Round up to the next multiple of ten seconds.
538 remaining = (remaining + 9) / 10 * 10;
539 snprintf(buf, sizeof(buf), "%" PRIu32 " min %" PRIu32 " s",
540 remaining / 60, remaining % 60);
542 } else if (remaining <= 59 * 60) {
543 // At maximum of 59 minutes remaining.
544 // Round up to the next multiple of a minute.
545 remaining = (remaining + 59) / 60;
546 snprintf(buf, sizeof(buf), "%" PRIu32 " min", remaining);
548 } else if (remaining <= 9 * 3600 + 50 * 60) {
549 // At maximum of 9 hours and 50 minutes left.
550 // Round up to the next multiple of ten minutes.
551 remaining = (remaining + 599) / 600 * 10;
552 snprintf(buf, sizeof(buf), "%" PRIu32 " h %" PRIu32 " min",
553 remaining / 60, remaining % 60);
555 } else if (remaining <= 23 * 3600) {
556 // At maximum of 23 hours remaining.
557 // Round up to the next multiple of an hour.
558 remaining = (remaining + 3599) / 3600;
559 snprintf(buf, sizeof(buf), "%" PRIu32 " h", remaining);
561 } else if (remaining <= 9 * 24 * 3600 + 23 * 3600) {
562 // At maximum of 9 days and 23 hours remaining.
563 // Round up to the next multiple of an hour.
564 remaining = (remaining + 3599) / 3600;
565 snprintf(buf, sizeof(buf), "%" PRIu32 " d %" PRIu32 " h",
566 remaining / 24, remaining % 24);
568 } else if (remaining <= 999 * 24 * 3600) {
569 // At maximum of 999 days remaining. ;-)
570 // Round up to the next multiple of a day.
571 remaining = (remaining + 24 * 3600 - 1) / (24 * 3600);
572 snprintf(buf, sizeof(buf), "%" PRIu32 " d", remaining);
575 // The estimated remaining time is so big that it's better
576 // that we just show the elapsed time.
577 return progress_time(elapsed);
584 /// Calculate the elapsed time as microseconds.
586 progress_elapsed(void)
588 return my_time() - start_time;
592 /// Get information about position in the stream. This is currently simple,
593 /// but it will become more complicated once we have multithreading support.
595 progress_pos(uint64_t *in_pos,
596 uint64_t *compressed_pos, uint64_t *uncompressed_pos)
598 *in_pos = progress_strm->total_in;
600 if (opt_mode == MODE_COMPRESS) {
601 *compressed_pos = progress_strm->total_out;
602 *uncompressed_pos = progress_strm->total_in;
604 *compressed_pos = progress_strm->total_in;
605 *uncompressed_pos = progress_strm->total_out;
613 message_progress_update(void)
615 if (!progress_needs_updating)
618 // Calculate how long we have been processing this file.
619 const uint64_t elapsed = progress_elapsed();
622 if (progress_next_update > elapsed)
625 progress_next_update = elapsed + 1000000;
628 // Get our current position in the stream.
630 uint64_t compressed_pos;
631 uint64_t uncompressed_pos;
632 progress_pos(&in_pos, &compressed_pos, &uncompressed_pos);
634 // Block signals so that fprintf() doesn't get interrupted.
637 // Print the filename if it hasn't been printed yet.
640 // Print the actual progress message. The idea is that there is at
641 // least three spaces between the fields in typical situations, but
642 // even in rare situations there is at least one space.
643 fprintf(stderr, " %7s %43s %9s %10s\r",
644 progress_percentage(in_pos, false),
645 progress_sizes(compressed_pos, uncompressed_pos, false),
646 progress_speed(uncompressed_pos, elapsed),
647 progress_remaining(in_pos, elapsed));
650 // Updating the progress info was finished. Reset
651 // progress_needs_updating to wait for the next SIGALRM.
653 // NOTE: This has to be done before alarm(1) or with (very) bad
654 // luck we could be setting this to false after the alarm has already
656 progress_needs_updating = false;
658 if (verbosity >= V_VERBOSE && progress_automatic) {
659 // Mark that the progress indicator is active, so if an error
660 // occurs, the error message gets printed cleanly.
661 progress_active = true;
663 // Restart the timer so that progress_needs_updating gets
664 // set to true after about one second.
667 // The progress message was printed because user had sent us
668 // SIGALRM. In this case, each progress message is printed
673 // When SIGALRM isn't supported and we get here, it's always due to
674 // automatic progress update. We set progress_active here too like
676 assert(verbosity >= V_VERBOSE);
677 assert(progress_automatic);
678 progress_active = true;
688 progress_flush(bool finished)
690 if (!progress_started || verbosity < V_VERBOSE)
694 uint64_t compressed_pos;
695 uint64_t uncompressed_pos;
696 progress_pos(&in_pos, &compressed_pos, &uncompressed_pos);
698 // Avoid printing intermediate progress info if some error occurs
699 // in the beginning of the stream. (If something goes wrong later in
700 // the stream, it is sometimes useful to tell the user where the
701 // error approximately occurred, especially if the error occurs
702 // after a time-consuming operation.)
703 if (!finished && !progress_active
704 && (compressed_pos == 0 || uncompressed_pos == 0))
707 progress_active = false;
709 const uint64_t elapsed = progress_elapsed();
710 const char *elapsed_str = progress_time(elapsed);
714 // When using the auto-updating progress indicator, the final
715 // statistics are printed in the same format as the progress
717 if (progress_automatic) {
718 // Using floating point conversion for the percentage instead
719 // of static "100.0 %" string, because the decimal separator
720 // isn't a dot in all locales.
721 fprintf(stderr, " %7s %43s %9s %10s\n",
722 progress_percentage(in_pos, finished),
723 progress_sizes(compressed_pos, uncompressed_pos, true),
724 progress_speed(uncompressed_pos, elapsed),
727 // The filename is always printed.
728 fprintf(stderr, "%s: ", filename);
730 // Percentage is printed only if we didn't finish yet.
731 // FIXME: This may look weird when size of the input
734 fprintf(stderr, "%s, ",
735 progress_percentage(in_pos, false));
737 // Size information is always printed.
738 fprintf(stderr, "%s", progress_sizes(
739 compressed_pos, uncompressed_pos, true));
741 // The speed and elapsed time aren't always shown.
742 const char *speed = progress_speed(uncompressed_pos, elapsed);
743 if (speed[0] != '\0')
744 fprintf(stderr, ", %s", speed);
746 if (elapsed_str[0] != '\0')
747 fprintf(stderr, ", %s", elapsed_str);
759 message_progress_end(bool success)
761 assert(progress_started);
762 progress_flush(success);
763 progress_started = false;
769 vmessage(enum message_verbosity v, const char *fmt, va_list ap)
771 if (v <= verbosity) {
774 progress_flush(false);
776 fprintf(stderr, "%s: ", argv0);
777 vfprintf(stderr, fmt, ap);
788 message(enum message_verbosity v, const char *fmt, ...)
792 vmessage(v, fmt, ap);
799 message_warning(const char *fmt, ...)
803 vmessage(V_WARNING, fmt, ap);
806 set_exit_status(E_WARNING);
812 message_error(const char *fmt, ...)
816 vmessage(V_ERROR, fmt, ap);
819 set_exit_status(E_ERROR);
825 message_fatal(const char *fmt, ...)
829 vmessage(V_ERROR, fmt, ap);
839 message_fatal(_("Internal error (bug)"));
844 message_signal_handler(void)
846 message_fatal(_("Cannot establish signal handlers"));
851 message_strm(lzma_ret code)
855 return _("No integrity check; not verifying file integrity");
857 case LZMA_UNSUPPORTED_CHECK:
858 return _("Unsupported type of integrity check; "
859 "not verifying file integrity");
862 return strerror(ENOMEM);
864 case LZMA_MEMLIMIT_ERROR:
865 return _("Memory usage limit reached");
867 case LZMA_FORMAT_ERROR:
868 return _("File format not recognized");
870 case LZMA_OPTIONS_ERROR:
871 return _("Unsupported options");
873 case LZMA_DATA_ERROR:
874 return _("Compressed data is corrupt");
877 return _("Unexpected end of input");
880 case LZMA_STREAM_END:
882 case LZMA_PROG_ERROR:
883 return _("Internal error (bug)");
891 message_filters(enum message_verbosity v, const lzma_filter *filters)
896 fprintf(stderr, _("%s: Filter chain:"), argv0);
898 for (size_t i = 0; filters[i].id != LZMA_VLI_UNKNOWN; ++i) {
899 fprintf(stderr, " --");
901 switch (filters[i].id) {
902 case LZMA_FILTER_LZMA1:
903 case LZMA_FILTER_LZMA2: {
904 const lzma_options_lzma *opt = filters[i].options;
913 case LZMA_MODE_NORMAL:
948 fprintf(stderr, "lzma%c=dict=%" PRIu32
949 ",lc=%" PRIu32 ",lp=%" PRIu32
951 ",mode=%s,nice=%" PRIu32 ",mf=%s"
953 filters[i].id == LZMA_FILTER_LZMA2
956 opt->lc, opt->lp, opt->pb,
957 mode, opt->nice_len, mf, opt->depth);
961 case LZMA_FILTER_X86:
962 fprintf(stderr, "x86");
965 case LZMA_FILTER_POWERPC:
966 fprintf(stderr, "powerpc");
969 case LZMA_FILTER_IA64:
970 fprintf(stderr, "ia64");
973 case LZMA_FILTER_ARM:
974 fprintf(stderr, "arm");
977 case LZMA_FILTER_ARMTHUMB:
978 fprintf(stderr, "armthumb");
981 case LZMA_FILTER_SPARC:
982 fprintf(stderr, "sparc");
985 case LZMA_FILTER_DELTA: {
986 const lzma_options_delta *opt = filters[i].options;
987 fprintf(stderr, "delta=dist=%" PRIu32, opt->dist);
992 fprintf(stderr, "UNKNOWN");
1003 message_try_help(void)
1005 // Print this with V_WARNING instead of V_ERROR to prevent it from
1006 // showing up when --quiet has been specified.
1007 message(V_WARNING, _("Try `%s --help' for more information."), argv0);
1013 message_version(void)
1015 // It is possible that liblzma version is different than the command
1016 // line tool version, so print both.
1017 printf("xz " LZMA_VERSION_STRING "\n");
1018 printf("liblzma %s\n", lzma_version_string());
1024 message_help(bool long_help)
1026 printf(_("Usage: %s [OPTION]... [FILE]...\n"
1027 "Compress or decompress FILEs in the .xz format.\n\n"),
1030 puts(_("Mandatory arguments to long options are mandatory for "
1031 "short options too.\n"));
1034 puts(_(" Operation mode:\n"));
1037 " -z, --compress force compression\n"
1038 " -d, --decompress force decompression\n"
1039 " -t, --test test compressed file integrity\n"
1040 " -l, --list list information about files"));
1043 puts(_("\n Operation modifiers:\n"));
1046 " -k, --keep keep (don't delete) input files\n"
1047 " -f, --force force overwrite of output file and (de)compress links\n"
1048 " -c, --stdout write to standard output and don't delete input files"));
1052 " -S, --suffix=.SUF use the suffix `.SUF' on compressed files\n"
1053 " --files=[FILE] read filenames to process from FILE; if FILE is\n"
1054 " omitted, filenames are read from the standard input;\n"
1055 " filenames must be terminated with the newline character\n"
1056 " --files0=[FILE] like --files but use the null character as terminator"));
1059 puts(_("\n Basic file format and compression options:\n"));
1061 " -F, --format=FMT file format to encode or decode; possible values are\n"
1062 " `auto' (default), `xz', `lzma', and `raw'\n"
1063 " -C, --check=CHECK integrity check type: `crc32', `crc64' (default),\n"
1068 " -0 .. -9 compression preset; 0-2 fast compression, 3-5 good\n"
1069 " compression, 6-9 excellent compression; default is 6"));
1072 " -e, --extreme use more CPU time when encoding to increase compression\n"
1073 " ratio without increasing memory usage of the decoder"));
1077 " -M, --memory=NUM use roughly NUM bytes of memory at maximum; 0 indicates\n"
1078 " the default setting, which depends on the operation mode\n"
1079 " and the amount of physical memory (RAM)"));
1083 "\n Custom filter chain for compression (alternative for using presets):"));
1085 #if defined(HAVE_ENCODER_LZMA1) || defined(HAVE_DECODER_LZMA1) \
1086 || defined(HAVE_ENCODER_LZMA2) || defined(HAVE_DECODER_LZMA2)
1089 " --lzma1[=OPTS] LZMA1 or LZMA2; OPTS is a comma-separated list of zero or\n"
1090 " --lzma2[=OPTS] more of the following options (valid values; default):\n"
1091 " preset=NUM reset options to preset number NUM (0-9)\n"
1092 " dict=NUM dictionary size (4KiB - 1536MiB; 8MiB)\n"
1093 " lc=NUM number of literal context bits (0-4; 3)\n"
1094 " lp=NUM number of literal position bits (0-4; 0)\n"
1095 " pb=NUM number of position bits (0-4; 2)\n"
1096 " mode=MODE compression mode (fast, normal; normal)\n"
1097 " nice=NUM nice length of a match (2-273; 64)\n"
1098 " mf=NAME match finder (hc3, hc4, bt2, bt3, bt4; bt4)\n"
1099 " depth=NUM maximum search depth; 0=automatic (default)"));
1104 " --x86 x86 filter (sometimes called BCJ filter)\n"
1105 " --powerpc PowerPC (big endian) filter\n"
1106 " --ia64 IA64 (Itanium) filter\n"
1107 " --arm ARM filter\n"
1108 " --armthumb ARM-Thumb filter\n"
1109 " --sparc SPARC filter"));
1111 #if defined(HAVE_ENCODER_DELTA) || defined(HAVE_DECODER_DELTA)
1114 " --delta[=OPTS] Delta filter; valid OPTS (valid values; default):\n"
1115 " dist=NUM distance between bytes being subtracted\n"
1116 " from each other (1-256; 1)"));
1119 #if defined(HAVE_ENCODER_SUBBLOCK) || defined(HAVE_DECODER_SUBBLOCK)
1122 " --subblock[=OPTS] Subblock filter; valid OPTS (valid values; default):\n"
1123 " size=NUM number of bytes of data per subblock\n"
1124 " (1 - 256Mi; 4Ki)\n"
1125 " rle=NUM run-length encoder chunk size (0-256; 0)"));
1130 puts(_("\n Other options:\n"));
1133 " -q, --quiet suppress warnings; specify twice to suppress errors too\n"
1134 " -v, --verbose be verbose; specify twice for even more verbose"));
1138 " -Q, --no-warn make warnings not affect the exit status"));
1143 " -h, --help display the short help (lists only the basic options)\n"
1144 " -H, --long-help display this long help"));
1147 " -h, --help display this short help\n"
1148 " -H, --long-help display the long help (lists also the advanced options)"));
1151 " -V, --version display the version number"));
1153 puts(_("\nWith no FILE, or when FILE is -, read standard input.\n"));
1157 "On this system and configuration, this program will use at maximum of roughly\n"
1158 "%'" PRIu64 " MiB RAM and "), hardware_memlimit_get() / (1024 * 1024));
1159 printf(N_("one thread.\n\n", "%'" PRIu32 " threads.\n\n",
1160 hardware_threadlimit_get()),
1161 hardware_threadlimit_get());
1164 printf(_("Report bugs to <%s> (in English or Finnish).\n"),
1166 printf(_("XZ Utils home page: <http://tukaani.org/xz/>\n"));