1 ///////////////////////////////////////////////////////////////////////////////
4 /// \brief Printing messages
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 /// Number of the current file
23 static unsigned int files_pos = 0;
25 /// Total number of input files; zero if unknown.
26 static unsigned int files_total;
29 static enum message_verbosity verbosity = V_WARNING;
31 /// Filename which we will print with the verbose messages
32 static const char *filename;
34 /// True once the a filename has been printed to stderr as part of progress
35 /// message. If automatic progress updating isn't enabled, this becomes true
36 /// after the first progress message has been printed due to user sending
37 /// SIGINFO, SIGUSR1, or SIGALRM. Once this variable is true, we will print
38 /// an empty line before the next filename to make the output more readable.
39 static bool first_filename_printed = false;
41 /// This is set to true when we have printed the current filename to stderr
42 /// as part of a progress message. This variable is useful only if not
43 /// updating progress automatically: if user sends many SIGINFO, SIGUSR1, or
44 /// SIGALRM signals, we won't print the name of the same file multiple times.
45 static bool current_filename_printed = false;
47 /// True if we should print progress indicator and update it automatically
48 /// if also verbose >= V_VERBOSE.
49 static bool progress_automatic;
51 /// True if message_progress_start() has been called but
52 /// message_progress_end() hasn't been called yet.
53 static bool progress_started = false;
55 /// This is true when a progress message was printed and the cursor is still
56 /// on the same line with the progress message. In that case, a newline has
57 /// to be printed before any error messages.
58 static bool progress_active = false;
60 /// Pointer to lzma_stream used to do the encoding or decoding.
61 static lzma_stream *progress_strm;
63 /// Expected size of the input stream is needed to show completion percentage
64 /// and estimate remaining time.
65 static uint64_t expected_in_size;
67 /// Time when we started processing the file
68 static uint64_t start_time;
71 // Use alarm() and SIGALRM when they are supported. This has two minor
72 // advantages over the alternative of polling gettimeofday():
73 // - It is possible for the user to send SIGINFO, SIGUSR1, or SIGALRM to
74 // get intermediate progress information even when --verbose wasn't used
75 // or stderr is not a terminal.
76 // - alarm() + SIGALRM seems to have slightly less overhead than polling
80 /// The signal handler for SIGALRM sets this to true. It is set back to false
81 /// once the progress message has been updated.
82 static volatile sig_atomic_t progress_needs_updating = false;
84 /// Signal handler for SIGALRM
86 progress_signal_handler(int sig lzma_attribute((unused)))
88 progress_needs_updating = true;
94 /// This is true when progress message printing is wanted. Using the same
95 /// variable name as above to avoid some ifdefs.
96 static bool progress_needs_updating = false;
98 /// Elapsed time when the next progress message update should be done.
99 static uint64_t progress_next_update;
104 /// Get the current time as microseconds since epoch
109 gettimeofday(&tv, NULL);
110 return (uint64_t)(tv.tv_sec) * UINT64_C(1000000) + tv.tv_usec;
117 // If --verbose is used, we use a progress indicator if and only
118 // if stderr is a terminal. If stderr is not a terminal, we print
119 // verbose information only after finishing the file. As a special
120 // exception, even if --verbose was not used, user can send SIGALRM
121 // to make us print progress information once without automatic
123 progress_automatic = isatty(STDERR_FILENO);
125 // Commented out because COLUMNS is rarely exported to environment.
126 // Most users have at least 80 columns anyway, let's think something
127 // fancy here if enough people complain.
129 if (progress_automatic) {
130 // stderr is a terminal. Check the COLUMNS environment
131 // variable to see if the terminal is wide enough. If COLUMNS
132 // doesn't exist or it has some unparsable value, we assume
133 // that the terminal is wide enough.
134 const char *columns_str = getenv("COLUMNS");
135 if (columns_str != NULL) {
137 const long columns = strtol(columns_str, &endptr, 10);
138 if (*endptr != '\0' || columns < 80)
139 progress_automatic = false;
145 // At least DJGPP lacks SA_RESTART. It's not essential for us (the
146 // rest of the code can handle interrupted system calls), so just
149 # define SA_RESTART 0
151 // Establish the signal handlers which set a flag to tell us that
152 // progress info should be updated. Since these signals don't
153 // require any quick action, we set SA_RESTART.
154 static const int sigs[] = {
167 sigemptyset(&sa.sa_mask);
168 sa.sa_flags = SA_RESTART;
169 sa.sa_handler = &progress_signal_handler;
171 for (size_t i = 0; i < ARRAY_SIZE(sigs); ++i)
172 if (sigaction(sigs[i], &sa, NULL))
173 message_signal_handler();
181 message_verbosity_increase(void)
183 if (verbosity < V_DEBUG)
191 message_verbosity_decrease(void)
193 if (verbosity > V_SILENT)
200 extern enum message_verbosity
201 message_verbosity_get(void)
208 message_set_files(unsigned int files)
215 /// Prints the name of the current file if it hasn't been printed already,
216 /// except if we are processing exactly one stream from stdin to stdout.
217 /// I think it looks nicer to not print "(stdin)" when --verbose is used
218 /// in a pipe and no other files are processed.
222 if (files_total != 1 || filename != stdin_filename) {
225 FILE *file = opt_mode == MODE_LIST ? stdout : stderr;
227 // If a file was already processed, put an empty line
228 // before the next filename to improve readability.
229 if (first_filename_printed)
232 first_filename_printed = true;
233 current_filename_printed = true;
235 // If we don't know how many files there will be due
236 // to usage of --files or --files0.
237 if (files_total == 0)
238 fprintf(file, "%s (%u)\n", filename,
241 fprintf(file, "%s (%u/%u)\n", filename,
242 files_pos, files_total);
252 message_filename(const char *src_name)
254 // Start numbering the files starting from one.
258 if (verbosity >= V_VERBOSE
259 && (progress_automatic || opt_mode == MODE_LIST))
262 current_filename_printed = false;
269 message_progress_start(lzma_stream *strm, uint64_t in_size)
271 // Store the pointer to the lzma_stream used to do the coding.
272 // It is needed to find out the position in the stream.
273 progress_strm = strm;
275 // Store the processing start time of the file and its expected size.
276 // If we aren't printing any statistics, then these are unused. But
277 // since it is possible that the user sends us a signal to show
278 // statistics, we need to have these available anyway.
279 start_time = my_time();
280 expected_in_size = in_size;
282 // Indicate that progress info may need to be printed before
283 // printing error messages.
284 progress_started = true;
286 // If progress indicator is wanted, print the filename and possibly
287 // the file count now.
288 if (verbosity >= V_VERBOSE && progress_automatic) {
289 // Start the timer to display the first progress message
290 // after one second. An alternative would be to show the
291 // first message almost immediately, but delaying by one
292 // second looks better to me, since extremely early
293 // progress info is pretty much useless.
295 // First disable a possibly existing alarm.
297 progress_needs_updating = false;
300 progress_needs_updating = true;
301 progress_next_update = 1000000;
309 /// Make the string indicating completion percentage.
311 progress_percentage(uint64_t in_pos, bool final)
313 static char buf[sizeof("100.0 %")];
318 // Use floating point conversion of snprintf() also for
319 // 100.0 % instead of fixed string, because the decimal
320 // separator isn't a dot in all locales.
323 // If the size of the input file is unknown or the size told us is
324 // clearly wrong since we have processed more data than the alleged
325 // size of the file, show a static string indicating that we have
326 // no idea of the completion percentage.
327 if (expected_in_size == 0 || in_pos > expected_in_size)
330 // Never show 100.0 % before we actually are finished.
331 percentage = (double)(in_pos) / (double)(expected_in_size)
335 snprintf(buf, sizeof(buf), "%.1f %%", percentage);
341 /// Make the string containing the amount of input processed, amount of
342 /// output produced, and the compression ratio.
344 progress_sizes(uint64_t compressed_pos, uint64_t uncompressed_pos, bool final)
346 // This is enough to hold sizes up to about 99 TiB if thousand
347 // separator is used, or about 1 PiB without thousand separator.
348 // After that the progress indicator will look a bit silly, since
349 // the compression ratio no longer fits with three decimal places.
353 size_t left = sizeof(buf);
355 // Print the sizes. If this the final message, use more reasonable
356 // units than MiB if the file was small.
357 const enum nicestr_unit unit_min = final ? NICESTR_B : NICESTR_MIB;
358 my_snprintf(&pos, &left, "%s / %s",
359 uint64_to_nicestr(compressed_pos,
360 unit_min, NICESTR_MIB, false, 0),
361 uint64_to_nicestr(uncompressed_pos,
362 unit_min, NICESTR_MIB, false, 1));
364 // Avoid division by zero. If we cannot calculate the ratio, set
365 // it to some nice number greater than 10.0 so that it gets caught
366 // in the next if-clause.
367 const double ratio = uncompressed_pos > 0
368 ? (double)(compressed_pos) / (double)(uncompressed_pos)
371 // If the ratio is very bad, just indicate that it is greater than
372 // 9.999. This way the length of the ratio field stays fixed.
374 snprintf(pos, left, " > %.3f", 9.999);
376 snprintf(pos, left, " = %.3f", ratio);
382 /// Make the string containing the processing speed of uncompressed data.
384 progress_speed(uint64_t uncompressed_pos, uint64_t elapsed)
386 // Don't print the speed immediately, since the early values look
388 if (elapsed < 3000000)
391 static const char unit[][8] = {
397 size_t unit_index = 0;
399 // Calculate the speed as KiB/s.
400 double speed = (double)(uncompressed_pos)
401 / ((double)(elapsed) * (1024.0 / 1e6));
403 // Adjust the unit of the speed if needed.
404 while (speed > 999.0) {
406 if (++unit_index == ARRAY_SIZE(unit))
407 return ""; // Way too fast ;-)
410 // Use decimal point only if the number is small. Examples:
415 static char buf[sizeof("999 GiB/s")];
416 snprintf(buf, sizeof(buf), "%.*f %s",
417 speed > 9.9 ? 0 : 1, speed, unit[unit_index]);
422 /// Make a string indicating elapsed or remaining time. The format is either
423 /// M:SS or H:MM:SS depending on if the time is an hour or more.
425 progress_time(uint64_t useconds)
427 // 9999 hours = 416 days
428 static char buf[sizeof("9999:59:59")];
430 uint32_t seconds = useconds / 1000000;
432 // Don't show anything if the time is zero or ridiculously big.
433 if (seconds == 0 || seconds > ((9999 * 60) + 59) * 60 + 59)
436 uint32_t minutes = seconds / 60;
440 const uint32_t hours = minutes / 60;
442 snprintf(buf, sizeof(buf),
443 "%" PRIu32 ":%02" PRIu32 ":%02" PRIu32,
444 hours, minutes, seconds);
446 snprintf(buf, sizeof(buf), "%" PRIu32 ":%02" PRIu32,
454 /// Make the string to contain the estimated remaining time, or if the amount
455 /// of input isn't known, how much time has elapsed.
457 progress_remaining(uint64_t in_pos, uint64_t elapsed)
459 // Show the amount of time spent so far when making an estimate of
460 // remaining time wouldn't be reasonable:
461 // - Input size is unknown.
462 // - Input has grown bigger since we started (de)compressing.
463 // - We haven't processed much data yet, so estimate would be
465 // - Only a few seconds has passed since we started (de)compressing,
466 // so estimate would be too inaccurate.
467 if (expected_in_size == 0 || in_pos > expected_in_size
468 || in_pos < (UINT64_C(1) << 19) || elapsed < 8000000)
469 return progress_time(elapsed);
471 // Calculate the estimate. Don't give an estimate of zero seconds,
472 // since it is possible that all the input has been already passed
473 // to the library, but there is still quite a bit of output pending.
474 uint32_t remaining = (double)(expected_in_size - in_pos)
475 * ((double)(elapsed) / 1e6) / (double)(in_pos);
479 static char buf[sizeof("9 h 55 min")];
481 // Select appropriate precision for the estimated remaining time.
482 if (remaining <= 10) {
483 // A maximum of 10 seconds remaining.
484 // Show the number of seconds as is.
485 snprintf(buf, sizeof(buf), "%" PRIu32 " s", remaining);
487 } else if (remaining <= 50) {
488 // A maximum of 50 seconds remaining.
489 // Round up to the next multiple of five seconds.
490 remaining = (remaining + 4) / 5 * 5;
491 snprintf(buf, sizeof(buf), "%" PRIu32 " s", remaining);
493 } else if (remaining <= 590) {
494 // A maximum of 9 minutes and 50 seconds remaining.
495 // Round up to the next multiple of ten seconds.
496 remaining = (remaining + 9) / 10 * 10;
497 snprintf(buf, sizeof(buf), "%" PRIu32 " min %" PRIu32 " s",
498 remaining / 60, remaining % 60);
500 } else if (remaining <= 59 * 60) {
501 // A maximum of 59 minutes remaining.
502 // Round up to the next multiple of a minute.
503 remaining = (remaining + 59) / 60;
504 snprintf(buf, sizeof(buf), "%" PRIu32 " min", remaining);
506 } else if (remaining <= 9 * 3600 + 50 * 60) {
507 // A maximum of 9 hours and 50 minutes left.
508 // Round up to the next multiple of ten minutes.
509 remaining = (remaining + 599) / 600 * 10;
510 snprintf(buf, sizeof(buf), "%" PRIu32 " h %" PRIu32 " min",
511 remaining / 60, remaining % 60);
513 } else if (remaining <= 23 * 3600) {
514 // A maximum of 23 hours remaining.
515 // Round up to the next multiple of an hour.
516 remaining = (remaining + 3599) / 3600;
517 snprintf(buf, sizeof(buf), "%" PRIu32 " h", remaining);
519 } else if (remaining <= 9 * 24 * 3600 + 23 * 3600) {
520 // A maximum of 9 days and 23 hours remaining.
521 // Round up to the next multiple of an hour.
522 remaining = (remaining + 3599) / 3600;
523 snprintf(buf, sizeof(buf), "%" PRIu32 " d %" PRIu32 " h",
524 remaining / 24, remaining % 24);
526 } else if (remaining <= 999 * 24 * 3600) {
527 // A maximum of 999 days remaining. ;-)
528 // Round up to the next multiple of a day.
529 remaining = (remaining + 24 * 3600 - 1) / (24 * 3600);
530 snprintf(buf, sizeof(buf), "%" PRIu32 " d", remaining);
533 // The estimated remaining time is so big that it's better
534 // that we just show the elapsed time.
535 return progress_time(elapsed);
542 /// Calculate the elapsed time as microseconds.
544 progress_elapsed(void)
546 return my_time() - start_time;
550 /// Get information about position in the stream. This is currently simple,
551 /// but it will become more complicated once we have multithreading support.
553 progress_pos(uint64_t *in_pos,
554 uint64_t *compressed_pos, uint64_t *uncompressed_pos)
556 *in_pos = progress_strm->total_in;
558 if (opt_mode == MODE_COMPRESS) {
559 *compressed_pos = progress_strm->total_out;
560 *uncompressed_pos = progress_strm->total_in;
562 *compressed_pos = progress_strm->total_in;
563 *uncompressed_pos = progress_strm->total_out;
571 message_progress_update(void)
573 if (!progress_needs_updating)
576 // Calculate how long we have been processing this file.
577 const uint64_t elapsed = progress_elapsed();
580 if (progress_next_update > elapsed)
583 progress_next_update = elapsed + 1000000;
586 // Get our current position in the stream.
588 uint64_t compressed_pos;
589 uint64_t uncompressed_pos;
590 progress_pos(&in_pos, &compressed_pos, &uncompressed_pos);
592 // Block signals so that fprintf() doesn't get interrupted.
595 // Print the filename if it hasn't been printed yet.
596 if (!current_filename_printed)
599 // Print the actual progress message. The idea is that there is at
600 // least three spaces between the fields in typical situations, but
601 // even in rare situations there is at least one space.
602 fprintf(stderr, " %7s %43s %9s %10s\r",
603 progress_percentage(in_pos, false),
604 progress_sizes(compressed_pos, uncompressed_pos, false),
605 progress_speed(uncompressed_pos, elapsed),
606 progress_remaining(in_pos, elapsed));
609 // Updating the progress info was finished. Reset
610 // progress_needs_updating to wait for the next SIGALRM.
612 // NOTE: This has to be done before alarm(1) or with (very) bad
613 // luck we could be setting this to false after the alarm has already
615 progress_needs_updating = false;
617 if (verbosity >= V_VERBOSE && progress_automatic) {
618 // Mark that the progress indicator is active, so if an error
619 // occurs, the error message gets printed cleanly.
620 progress_active = true;
622 // Restart the timer so that progress_needs_updating gets
623 // set to true after about one second.
626 // The progress message was printed because user had sent us
627 // SIGALRM. In this case, each progress message is printed
632 // When SIGALRM isn't supported and we get here, it's always due to
633 // automatic progress update. We set progress_active here too like
635 assert(verbosity >= V_VERBOSE);
636 assert(progress_automatic);
637 progress_active = true;
647 progress_flush(bool finished)
649 if (!progress_started || verbosity < V_VERBOSE)
653 uint64_t compressed_pos;
654 uint64_t uncompressed_pos;
655 progress_pos(&in_pos, &compressed_pos, &uncompressed_pos);
657 // Avoid printing intermediate progress info if some error occurs
658 // in the beginning of the stream. (If something goes wrong later in
659 // the stream, it is sometimes useful to tell the user where the
660 // error approximately occurred, especially if the error occurs
661 // after a time-consuming operation.)
662 if (!finished && !progress_active
663 && (compressed_pos == 0 || uncompressed_pos == 0))
666 progress_active = false;
668 const uint64_t elapsed = progress_elapsed();
669 const char *elapsed_str = progress_time(elapsed);
673 // When using the auto-updating progress indicator, the final
674 // statistics are printed in the same format as the progress
676 if (progress_automatic) {
677 // Using floating point conversion for the percentage instead
678 // of static "100.0 %" string, because the decimal separator
679 // isn't a dot in all locales.
680 fprintf(stderr, " %7s %43s %9s %10s\n",
681 progress_percentage(in_pos, finished),
682 progress_sizes(compressed_pos, uncompressed_pos, true),
683 progress_speed(uncompressed_pos, elapsed),
686 // The filename is always printed.
687 fprintf(stderr, "%s: ", filename);
689 // Percentage is printed only if we didn't finish yet.
690 // FIXME: This may look weird when size of the input
693 fprintf(stderr, "%s, ",
694 progress_percentage(in_pos, false));
696 // Size information is always printed.
697 fprintf(stderr, "%s", progress_sizes(
698 compressed_pos, uncompressed_pos, true));
700 // The speed and elapsed time aren't always shown.
701 const char *speed = progress_speed(uncompressed_pos, elapsed);
702 if (speed[0] != '\0')
703 fprintf(stderr, ", %s", speed);
705 if (elapsed_str[0] != '\0')
706 fprintf(stderr, ", %s", elapsed_str);
718 message_progress_end(bool success)
720 assert(progress_started);
721 progress_flush(success);
722 progress_started = false;
728 vmessage(enum message_verbosity v, const char *fmt, va_list ap)
730 if (v <= verbosity) {
733 progress_flush(false);
735 fprintf(stderr, "%s: ", progname);
736 vfprintf(stderr, fmt, ap);
747 message(enum message_verbosity v, const char *fmt, ...)
751 vmessage(v, fmt, ap);
758 message_warning(const char *fmt, ...)
762 vmessage(V_WARNING, fmt, ap);
765 set_exit_status(E_WARNING);
771 message_error(const char *fmt, ...)
775 vmessage(V_ERROR, fmt, ap);
778 set_exit_status(E_ERROR);
784 message_fatal(const char *fmt, ...)
788 vmessage(V_ERROR, fmt, ap);
791 tuklib_exit(E_ERROR, E_ERROR, false);
798 message_fatal(_("Internal error (bug)"));
803 message_signal_handler(void)
805 message_fatal(_("Cannot establish signal handlers"));
810 message_strm(lzma_ret code)
814 return _("No integrity check; not verifying file integrity");
816 case LZMA_UNSUPPORTED_CHECK:
817 return _("Unsupported type of integrity check; "
818 "not verifying file integrity");
821 return strerror(ENOMEM);
823 case LZMA_MEMLIMIT_ERROR:
824 return _("Memory usage limit reached");
826 case LZMA_FORMAT_ERROR:
827 return _("File format not recognized");
829 case LZMA_OPTIONS_ERROR:
830 return _("Unsupported options");
832 case LZMA_DATA_ERROR:
833 return _("Compressed data is corrupt");
836 return _("Unexpected end of input");
839 case LZMA_STREAM_END:
841 case LZMA_PROG_ERROR:
842 return _("Internal error (bug)");
850 message_mem_needed(enum message_verbosity v, uint64_t memusage)
855 // Convert memusage to MiB, rounding up to the next full MiB.
856 // This way the user can always use the displayed usage as
857 // the new memory usage limit. (If we rounded to the nearest,
858 // the user might need to +1 MiB to get high enough limit.)
859 memusage = round_up_to_mib(memusage);
861 // 2^64 with thousand separators + " MiB" suffix + '\0' = 26 + 4 + 1
862 char memlimitstr[32];
864 // Show the memory usage limit as MiB unless it is less than 1 MiB.
865 // This way it's easy to notice errors where one has typed
866 // --memory=123 instead of --memory=123MiB.
867 uint64_t memlimit = hardware_memlimit_get();
868 if (memlimit < (UINT32_C(1) << 20)) {
869 snprintf(memlimitstr, sizeof(memlimitstr), "%s B",
870 uint64_to_str(memlimit, 1));
872 // Round up just like with memusage. If this function is
873 // called for informational purposes (to just show the
874 // current usage and limit), we should never show that
875 // the usage is higher than the limit, which would give
876 // a false impression that the memory usage limit isn't
877 // properly enforced.
878 snprintf(memlimitstr, sizeof(memlimitstr), "%s MiB",
879 uint64_to_str(round_up_to_mib(memlimit), 1));
882 message(v, _("%s MiB of memory is required. The limit is %s."),
883 uint64_to_str(memusage, 0), memlimitstr);
890 message_filters(enum message_verbosity v, const lzma_filter *filters)
895 fprintf(stderr, _("%s: Filter chain:"), progname);
897 for (size_t i = 0; filters[i].id != LZMA_VLI_UNKNOWN; ++i) {
898 fprintf(stderr, " --");
900 switch (filters[i].id) {
901 case LZMA_FILTER_LZMA1:
902 case LZMA_FILTER_LZMA2: {
903 const lzma_options_lzma *opt = filters[i].options;
912 case LZMA_MODE_NORMAL:
947 fprintf(stderr, "lzma%c=dict=%" PRIu32
948 ",lc=%" PRIu32 ",lp=%" PRIu32
950 ",mode=%s,nice=%" PRIu32 ",mf=%s"
952 filters[i].id == LZMA_FILTER_LZMA2
955 opt->lc, opt->lp, opt->pb,
956 mode, opt->nice_len, mf, opt->depth);
960 case LZMA_FILTER_X86:
961 fprintf(stderr, "x86");
964 case LZMA_FILTER_POWERPC:
965 fprintf(stderr, "powerpc");
968 case LZMA_FILTER_IA64:
969 fprintf(stderr, "ia64");
972 case LZMA_FILTER_ARM:
973 fprintf(stderr, "arm");
976 case LZMA_FILTER_ARMTHUMB:
977 fprintf(stderr, "armthumb");
980 case LZMA_FILTER_SPARC:
981 fprintf(stderr, "sparc");
984 case LZMA_FILTER_DELTA: {
985 const lzma_options_delta *opt = filters[i].options;
986 fprintf(stderr, "delta=dist=%" PRIu32, opt->dist);
991 fprintf(stderr, "UNKNOWN");
1002 message_try_help(void)
1004 // Print this with V_WARNING instead of V_ERROR to prevent it from
1005 // showing up when --quiet has been specified.
1006 message(V_WARNING, _("Try `%s --help' for more information."),
1013 message_memlimit(void)
1016 printf("%" PRIu64 "\n", hardware_memlimit_get());
1018 printf(_("%s MiB (%s bytes)\n"),
1019 uint64_to_str(hardware_memlimit_get() >> 20, 0),
1020 uint64_to_str(hardware_memlimit_get(), 1));
1022 tuklib_exit(E_SUCCESS, E_ERROR, verbosity != V_SILENT);
1027 message_version(void)
1029 // It is possible that liblzma version is different than the command
1030 // line tool version, so print both.
1032 printf("XZ_VERSION=%d\nLIBLZMA_VERSION=%d\n",
1033 LZMA_VERSION, lzma_version_number());
1035 printf("xz (" PACKAGE_NAME ") " LZMA_VERSION_STRING "\n");
1036 printf("liblzma %s\n", lzma_version_string());
1039 tuklib_exit(E_SUCCESS, E_ERROR, verbosity != V_SILENT);
1044 message_help(bool long_help)
1046 printf(_("Usage: %s [OPTION]... [FILE]...\n"
1047 "Compress or decompress FILEs in the .xz format.\n\n"),
1050 puts(_("Mandatory arguments to long options are mandatory for "
1051 "short options too.\n"));
1054 puts(_(" Operation mode:\n"));
1057 " -z, --compress force compression\n"
1058 " -d, --decompress force decompression\n"
1059 " -t, --test test compressed file integrity\n"
1060 " -l, --list list information about files"));
1063 puts(_("\n Operation modifiers:\n"));
1066 " -k, --keep keep (don't delete) input files\n"
1067 " -f, --force force overwrite of output file and (de)compress links\n"
1068 " -c, --stdout write to standard output and don't delete input files"));
1072 " --no-sparse do not create sparse files when decompressing\n"
1073 " -S, --suffix=.SUF use the suffix `.SUF' on compressed files\n"
1074 " --files=[FILE] read filenames to process from FILE; if FILE is\n"
1075 " omitted, filenames are read from the standard input;\n"
1076 " filenames must be terminated with the newline character\n"
1077 " --files0=[FILE] like --files but use the null character as terminator"));
1080 puts(_("\n Basic file format and compression options:\n"));
1082 " -F, --format=FMT file format to encode or decode; possible values are\n"
1083 " `auto' (default), `xz', `lzma', and `raw'\n"
1084 " -C, --check=CHECK integrity check type: `crc32', `crc64' (default),\n"
1085 " `sha256', or `none' (use with caution)"));
1089 " -0 .. -9 compression preset; 0-2 fast compression, 3-5 good\n"
1090 " compression, 6-9 excellent compression; default is 6"));
1093 " -e, --extreme use more CPU time when encoding to increase compression\n"
1094 " ratio without increasing memory usage of the decoder"));
1097 puts(_( // xgettext:no-c-format
1098 " -M, --memory=NUM use roughly NUM bytes of memory at maximum; 0 indicates\n"
1099 " the default setting, which is 40 % of total RAM"));
1103 "\n Custom filter chain for compression (alternative for using presets):"));
1105 #if defined(HAVE_ENCODER_LZMA1) || defined(HAVE_DECODER_LZMA1) \
1106 || defined(HAVE_ENCODER_LZMA2) || defined(HAVE_DECODER_LZMA2)
1109 " --lzma1[=OPTS] LZMA1 or LZMA2; OPTS is a comma-separated list of zero or\n"
1110 " --lzma2[=OPTS] more of the following options (valid values; default):\n"
1111 " preset=NUM reset options to preset number NUM (0-9)\n"
1112 " dict=NUM dictionary size (4KiB - 1536MiB; 8MiB)\n"
1113 " lc=NUM number of literal context bits (0-4; 3)\n"
1114 " lp=NUM number of literal position bits (0-4; 0)\n"
1115 " pb=NUM number of position bits (0-4; 2)\n"
1116 " mode=MODE compression mode (fast, normal; normal)\n"
1117 " nice=NUM nice length of a match (2-273; 64)\n"
1118 " mf=NAME match finder (hc3, hc4, bt2, bt3, bt4; bt4)\n"
1119 " depth=NUM maximum search depth; 0=automatic (default)"));
1124 " --x86[=OPTS] x86 BCJ filter\n"
1125 " --powerpc[=OPTS] PowerPC BCJ filter (big endian only)\n"
1126 " --ia64[=OPTS] IA64 (Itanium) BCJ filter\n"
1127 " --arm[=OPTS] ARM BCJ filter (little endian only)\n"
1128 " --armthumb[=OPTS] ARM-Thumb BCJ filter (little endian only)\n"
1129 " --sparc[=OPTS] SPARC BCJ filter\n"
1130 " Valid OPTS for all BCJ filters:\n"
1131 " start=NUM start offset for conversions (default=0)"));
1133 #if defined(HAVE_ENCODER_DELTA) || defined(HAVE_DECODER_DELTA)
1136 " --delta[=OPTS] Delta filter; valid OPTS (valid values; default):\n"
1137 " dist=NUM distance between bytes being subtracted\n"
1138 " from each other (1-256; 1)"));
1141 #if defined(HAVE_ENCODER_SUBBLOCK) || defined(HAVE_DECODER_SUBBLOCK)
1144 " --subblock[=OPTS] Subblock filter; valid OPTS (valid values; default):\n"
1145 " size=NUM number of bytes of data per subblock\n"
1146 " (1 - 256Mi; 4Ki)\n"
1147 " rle=NUM run-length encoder chunk size (0-256; 0)"));
1152 puts(_("\n Other options:\n"));
1155 " -q, --quiet suppress warnings; specify twice to suppress errors too\n"
1156 " -v, --verbose be verbose; specify twice for even more verbose"));
1160 " -Q, --no-warn make warnings not affect the exit status"));
1162 " --robot use machine-parsable messages (useful for scripts)"));
1165 " --info-memory display the memory usage limit and exit"));
1167 " -h, --help display the short help (lists only the basic options)\n"
1168 " -H, --long-help display this long help and exit"));
1171 " -h, --help display this short help and exit\n"
1172 " -H, --long-help display the long help (lists also the advanced options)"));
1176 " -V, --version display the version number and exit"));
1178 puts(_("\nWith no FILE, or when FILE is -, read standard input.\n"));
1182 "On this system and configuration, this program will use a maximum of roughly\n"
1183 "%s MiB RAM and "), uint64_to_str(hardware_memlimit_get() / (1024 * 1024), 0));
1184 printf(N_("one thread.\n\n", "%s threads.\n\n",
1185 hardware_threadlimit_get()),
1186 uint64_to_str(hardware_threadlimit_get(), 0));
1189 // TRANSLATORS: This message indicates the bug reporting address
1190 // for this package. Please add _another line_ saying
1191 // "Report translation bugs to <...>\n" with the email or WWW
1192 // address for translation bugs. Thanks.
1193 printf(_("Report bugs to <%s> (in English or Finnish).\n"),
1195 printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
1197 tuklib_exit(E_SUCCESS, E_ERROR, verbosity != V_SILENT);