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 // DJGPP lacks SA_RESTART, but it shouldn't give EINTR
146 // in most places either.
147 # if defined(__DJGPP__) && !defined(SA_RESTART)
148 # 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. That way we don't
154 // need to block them either in signals_block() to keep stdio
155 // functions from getting EINTR.
156 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)
313 // If the size of the input file is unknown or the size told us is
314 // clearly wrong since we have processed more data than the alleged
315 // size of the file, show a static string indicating that we have
316 // no idea of the completion percentage.
317 if (expected_in_size == 0 || in_pos > expected_in_size)
320 // Never show 100.0 % before we actually are finished.
321 double percentage = (double)(in_pos) / (double)(expected_in_size)
324 static char buf[sizeof("99.9 %")];
325 snprintf(buf, sizeof(buf), "%.1f %%", percentage);
331 /// Make the string containing the amount of input processed, amount of
332 /// output produced, and the compression ratio.
334 progress_sizes(uint64_t compressed_pos, uint64_t uncompressed_pos, bool final)
336 // This is enough to hold sizes up to about 99 TiB if thousand
337 // separator is used, or about 1 PiB without thousand separator.
338 // After that the progress indicator will look a bit silly, since
339 // the compression ratio no longer fits with three decimal places.
343 size_t left = sizeof(buf);
345 // Print the sizes. If this the final message, use more reasonable
346 // units than MiB if the file was small.
347 const enum nicestr_unit unit_min = final ? NICESTR_B : NICESTR_MIB;
348 my_snprintf(&pos, &left, "%s / %s",
349 uint64_to_nicestr(compressed_pos,
350 unit_min, NICESTR_TIB, false, 0),
351 uint64_to_nicestr(uncompressed_pos,
352 unit_min, NICESTR_TIB, false, 1));
354 // Avoid division by zero. If we cannot calculate the ratio, set
355 // it to some nice number greater than 10.0 so that it gets caught
356 // in the next if-clause.
357 const double ratio = uncompressed_pos > 0
358 ? (double)(compressed_pos) / (double)(uncompressed_pos)
361 // If the ratio is very bad, just indicate that it is greater than
362 // 9.999. This way the length of the ratio field stays fixed.
364 snprintf(pos, left, " > %.3f", 9.999);
366 snprintf(pos, left, " = %.3f", ratio);
372 /// Make the string containing the processing speed of uncompressed data.
374 progress_speed(uint64_t uncompressed_pos, uint64_t elapsed)
376 // Don't print the speed immediately, since the early values look
378 if (elapsed < 3000000)
381 static const char unit[][8] = {
387 size_t unit_index = 0;
389 // Calculate the speed as KiB/s.
390 double speed = (double)(uncompressed_pos)
391 / ((double)(elapsed) * (1024.0 / 1e6));
393 // Adjust the unit of the speed if needed.
394 while (speed > 999.0) {
396 if (++unit_index == ARRAY_SIZE(unit))
397 return ""; // Way too fast ;-)
400 // Use decimal point only if the number is small. Examples:
405 static char buf[sizeof("999 GiB/s")];
406 snprintf(buf, sizeof(buf), "%.*f %s",
407 speed > 9.9 ? 0 : 1, speed, unit[unit_index]);
412 /// Make a string indicating elapsed or remaining time. The format is either
413 /// M:SS or H:MM:SS depending on if the time is an hour or more.
415 progress_time(uint64_t useconds)
417 // 9999 hours = 416 days
418 static char buf[sizeof("9999:59:59")];
420 uint32_t seconds = useconds / 1000000;
422 // Don't show anything if the time is zero or ridiculously big.
423 if (seconds == 0 || seconds > ((9999 * 60) + 59) * 60 + 59)
426 uint32_t minutes = seconds / 60;
430 const uint32_t hours = minutes / 60;
432 snprintf(buf, sizeof(buf),
433 "%" PRIu32 ":%02" PRIu32 ":%02" PRIu32,
434 hours, minutes, seconds);
436 snprintf(buf, sizeof(buf), "%" PRIu32 ":%02" PRIu32,
444 /// Return a string containing estimated remaining time when
445 /// reasonably possible.
447 progress_remaining(uint64_t in_pos, uint64_t elapsed)
449 // Don't show the estimated remaining time when it wouldn't
451 // - Input size is unknown.
452 // - Input has grown bigger since we started (de)compressing.
453 // - We haven't processed much data yet, so estimate would be
455 // - Only a few seconds has passed since we started (de)compressing,
456 // so estimate would be too inaccurate.
457 if (expected_in_size == 0 || in_pos > expected_in_size
458 || in_pos < (UINT64_C(1) << 19) || elapsed < 8000000)
461 // Calculate the estimate. Don't give an estimate of zero seconds,
462 // since it is possible that all the input has been already passed
463 // to the library, but there is still quite a bit of output pending.
464 uint32_t remaining = (double)(expected_in_size - in_pos)
465 * ((double)(elapsed) / 1e6) / (double)(in_pos);
469 static char buf[sizeof("9 h 55 min")];
471 // Select appropriate precision for the estimated remaining time.
472 if (remaining <= 10) {
473 // A maximum of 10 seconds remaining.
474 // Show the number of seconds as is.
475 snprintf(buf, sizeof(buf), "%" PRIu32 " s", remaining);
477 } else if (remaining <= 50) {
478 // A maximum of 50 seconds remaining.
479 // Round up to the next multiple of five seconds.
480 remaining = (remaining + 4) / 5 * 5;
481 snprintf(buf, sizeof(buf), "%" PRIu32 " s", remaining);
483 } else if (remaining <= 590) {
484 // A maximum of 9 minutes and 50 seconds remaining.
485 // Round up to the next multiple of ten seconds.
486 remaining = (remaining + 9) / 10 * 10;
487 snprintf(buf, sizeof(buf), "%" PRIu32 " min %" PRIu32 " s",
488 remaining / 60, remaining % 60);
490 } else if (remaining <= 59 * 60) {
491 // A maximum of 59 minutes remaining.
492 // Round up to the next multiple of a minute.
493 remaining = (remaining + 59) / 60;
494 snprintf(buf, sizeof(buf), "%" PRIu32 " min", remaining);
496 } else if (remaining <= 9 * 3600 + 50 * 60) {
497 // A maximum of 9 hours and 50 minutes left.
498 // Round up to the next multiple of ten minutes.
499 remaining = (remaining + 599) / 600 * 10;
500 snprintf(buf, sizeof(buf), "%" PRIu32 " h %" PRIu32 " min",
501 remaining / 60, remaining % 60);
503 } else if (remaining <= 23 * 3600) {
504 // A maximum of 23 hours remaining.
505 // Round up to the next multiple of an hour.
506 remaining = (remaining + 3599) / 3600;
507 snprintf(buf, sizeof(buf), "%" PRIu32 " h", remaining);
509 } else if (remaining <= 9 * 24 * 3600 + 23 * 3600) {
510 // A maximum of 9 days and 23 hours remaining.
511 // Round up to the next multiple of an hour.
512 remaining = (remaining + 3599) / 3600;
513 snprintf(buf, sizeof(buf), "%" PRIu32 " d %" PRIu32 " h",
514 remaining / 24, remaining % 24);
516 } else if (remaining <= 999 * 24 * 3600) {
517 // A maximum of 999 days remaining. ;-)
518 // Round up to the next multiple of a day.
519 remaining = (remaining + 24 * 3600 - 1) / (24 * 3600);
520 snprintf(buf, sizeof(buf), "%" PRIu32 " d", remaining);
523 // The estimated remaining time is too big. Don't show it.
531 /// Calculate the elapsed time as microseconds.
533 progress_elapsed(void)
535 return my_time() - start_time;
539 /// Get information about position in the stream. This is currently simple,
540 /// but it will become more complicated once we have multithreading support.
542 progress_pos(uint64_t *in_pos,
543 uint64_t *compressed_pos, uint64_t *uncompressed_pos)
545 *in_pos = progress_strm->total_in;
547 if (opt_mode == MODE_COMPRESS) {
548 *compressed_pos = progress_strm->total_out;
549 *uncompressed_pos = progress_strm->total_in;
551 *compressed_pos = progress_strm->total_in;
552 *uncompressed_pos = progress_strm->total_out;
560 message_progress_update(void)
562 if (!progress_needs_updating)
565 // Calculate how long we have been processing this file.
566 const uint64_t elapsed = progress_elapsed();
569 if (progress_next_update > elapsed)
572 progress_next_update = elapsed + 1000000;
575 // Get our current position in the stream.
577 uint64_t compressed_pos;
578 uint64_t uncompressed_pos;
579 progress_pos(&in_pos, &compressed_pos, &uncompressed_pos);
581 // Block signals so that fprintf() doesn't get interrupted.
584 // Print the filename if it hasn't been printed yet.
585 if (!current_filename_printed)
588 // Print the actual progress message. The idea is that there is at
589 // least three spaces between the fields in typical situations, but
590 // even in rare situations there is at least one space.
591 fprintf(stderr, "\r %6s %35s %9s %10s %10s\r",
592 progress_percentage(in_pos),
593 progress_sizes(compressed_pos, uncompressed_pos, false),
594 progress_speed(uncompressed_pos, elapsed),
595 progress_time(elapsed),
596 progress_remaining(in_pos, elapsed));
599 // Updating the progress info was finished. Reset
600 // progress_needs_updating to wait for the next SIGALRM.
602 // NOTE: This has to be done before alarm(1) or with (very) bad
603 // luck we could be setting this to false after the alarm has already
605 progress_needs_updating = false;
607 if (verbosity >= V_VERBOSE && progress_automatic) {
608 // Mark that the progress indicator is active, so if an error
609 // occurs, the error message gets printed cleanly.
610 progress_active = true;
612 // Restart the timer so that progress_needs_updating gets
613 // set to true after about one second.
616 // The progress message was printed because user had sent us
617 // SIGALRM. In this case, each progress message is printed
622 // When SIGALRM isn't supported and we get here, it's always due to
623 // automatic progress update. We set progress_active here too like
625 assert(verbosity >= V_VERBOSE);
626 assert(progress_automatic);
627 progress_active = true;
637 progress_flush(bool finished)
639 if (!progress_started || verbosity < V_VERBOSE)
643 uint64_t compressed_pos;
644 uint64_t uncompressed_pos;
645 progress_pos(&in_pos, &compressed_pos, &uncompressed_pos);
647 // Avoid printing intermediate progress info if some error occurs
648 // in the beginning of the stream. (If something goes wrong later in
649 // the stream, it is sometimes useful to tell the user where the
650 // error approximately occurred, especially if the error occurs
651 // after a time-consuming operation.)
652 if (!finished && !progress_active
653 && (compressed_pos == 0 || uncompressed_pos == 0))
656 progress_active = false;
658 const uint64_t elapsed = progress_elapsed();
662 // When using the auto-updating progress indicator, the final
663 // statistics are printed in the same format as the progress
665 if (progress_automatic) {
666 fprintf(stderr, "\r %6s %35s %9s %10s %10s\n",
667 finished ? "100 %" : progress_percentage(in_pos),
668 progress_sizes(compressed_pos, uncompressed_pos, true),
669 progress_speed(uncompressed_pos, elapsed),
670 progress_time(elapsed),
671 finished ? "" : progress_remaining(in_pos, elapsed));
673 // The filename is always printed.
674 fprintf(stderr, "%s: ", filename);
676 // Percentage is printed only if we didn't finish yet.
678 // Don't print the percentage when it isn't known
679 // (starts with a dash).
680 const char *percentage = progress_percentage(in_pos);
681 if (percentage[0] != '-')
682 fprintf(stderr, "%s, ", percentage);
685 // Size information is always printed.
686 fprintf(stderr, "%s", progress_sizes(
687 compressed_pos, uncompressed_pos, true));
689 // The speed and elapsed time aren't always shown.
690 const char *speed = progress_speed(uncompressed_pos, elapsed);
691 if (speed[0] != '\0')
692 fprintf(stderr, ", %s", speed);
694 const char *elapsed_str = progress_time(elapsed);
695 if (elapsed_str[0] != '\0')
696 fprintf(stderr, ", %s", elapsed_str);
708 message_progress_end(bool success)
710 assert(progress_started);
711 progress_flush(success);
712 progress_started = false;
718 vmessage(enum message_verbosity v, const char *fmt, va_list ap)
720 if (v <= verbosity) {
723 progress_flush(false);
725 fprintf(stderr, "%s: ", progname);
726 vfprintf(stderr, fmt, ap);
737 message(enum message_verbosity v, const char *fmt, ...)
741 vmessage(v, fmt, ap);
748 message_warning(const char *fmt, ...)
752 vmessage(V_WARNING, fmt, ap);
755 set_exit_status(E_WARNING);
761 message_error(const char *fmt, ...)
765 vmessage(V_ERROR, fmt, ap);
768 set_exit_status(E_ERROR);
774 message_fatal(const char *fmt, ...)
778 vmessage(V_ERROR, fmt, ap);
781 tuklib_exit(E_ERROR, E_ERROR, false);
788 message_fatal(_("Internal error (bug)"));
793 message_signal_handler(void)
795 message_fatal(_("Cannot establish signal handlers"));
800 message_strm(lzma_ret code)
804 return _("No integrity check; not verifying file integrity");
806 case LZMA_UNSUPPORTED_CHECK:
807 return _("Unsupported type of integrity check; "
808 "not verifying file integrity");
811 return strerror(ENOMEM);
813 case LZMA_MEMLIMIT_ERROR:
814 return _("Memory usage limit reached");
816 case LZMA_FORMAT_ERROR:
817 return _("File format not recognized");
819 case LZMA_OPTIONS_ERROR:
820 return _("Unsupported options");
822 case LZMA_DATA_ERROR:
823 return _("Compressed data is corrupt");
826 return _("Unexpected end of input");
829 case LZMA_STREAM_END:
831 case LZMA_PROG_ERROR:
832 return _("Internal error (bug)");
840 message_mem_needed(enum message_verbosity v, uint64_t memusage)
845 // Convert memusage to MiB, rounding up to the next full MiB.
846 // This way the user can always use the displayed usage as
847 // the new memory usage limit. (If we rounded to the nearest,
848 // the user might need to +1 MiB to get high enough limit.)
849 memusage = round_up_to_mib(memusage);
851 // 2^64 with thousand separators + " MiB" suffix + '\0' = 26 + 4 + 1
852 char memlimitstr[32];
854 // Show the memory usage limit as MiB unless it is less than 1 MiB.
855 // This way it's easy to notice errors where one has typed
856 // --memory=123 instead of --memory=123MiB.
857 uint64_t memlimit = hardware_memlimit_get();
858 if (memlimit < (UINT32_C(1) << 20)) {
859 snprintf(memlimitstr, sizeof(memlimitstr), "%s B",
860 uint64_to_str(memlimit, 1));
862 // Round up just like with memusage. If this function is
863 // called for informational purposes (to just show the
864 // current usage and limit), we should never show that
865 // the usage is higher than the limit, which would give
866 // a false impression that the memory usage limit isn't
867 // properly enforced.
868 snprintf(memlimitstr, sizeof(memlimitstr), "%s MiB",
869 uint64_to_str(round_up_to_mib(memlimit), 1));
872 message(v, _("%s MiB of memory is required. The limit is %s."),
873 uint64_to_str(memusage, 0), memlimitstr);
879 /// \brief Convert uint32_t to a nice string for --lzma[12]=dict=SIZE
881 /// The idea is to use KiB or MiB suffix when possible.
883 uint32_to_optstr(uint32_t num)
887 if ((num & ((UINT32_C(1) << 20) - 1)) == 0)
888 snprintf(buf, sizeof(buf), "%" PRIu32 "MiB", num >> 20);
889 else if ((num & ((UINT32_C(1) << 10) - 1)) == 0)
890 snprintf(buf, sizeof(buf), "%" PRIu32 "KiB", num >> 10);
892 snprintf(buf, sizeof(buf), "%" PRIu32, num);
899 message_filters_to_str(const lzma_filter *filters, bool all_known)
901 static char buf[512];
904 size_t left = sizeof(buf);
906 for (size_t i = 0; filters[i].id != LZMA_VLI_UNKNOWN; ++i) {
907 // Add the dashes for the filter option. A space is
908 // needed after the first and later filters.
909 my_snprintf(&pos, &left, "%s", i == 0 ? "--" : " --");
911 switch (filters[i].id) {
912 case LZMA_FILTER_LZMA1:
913 case LZMA_FILTER_LZMA2: {
914 const lzma_options_lzma *opt = filters[i].options;
915 const char *mode = NULL;
916 const char *mf = NULL;
924 case LZMA_MODE_NORMAL:
960 // Add the filter name and dictionary size, which
962 my_snprintf(&pos, &left, "lzma%c=dict=%s",
963 filters[i].id == LZMA_FILTER_LZMA2
965 uint32_to_optstr(opt->dict_size));
967 // With LZMA1 also lc/lp/pb are known when
968 // decompressing, but this function is never
969 // used to print information about .lzma headers.
970 assert(filters[i].id == LZMA_FILTER_LZMA2
973 // Print the rest of the options, which are known
974 // only when compressing.
976 my_snprintf(&pos, &left,
977 ",lc=%" PRIu32 ",lp=%" PRIu32
979 ",mode=%s,nice=%" PRIu32 ",mf=%s"
981 opt->lc, opt->lp, opt->pb,
982 mode, opt->nice_len, mf, opt->depth);
986 case LZMA_FILTER_X86:
987 case LZMA_FILTER_POWERPC:
988 case LZMA_FILTER_IA64:
989 case LZMA_FILTER_ARM:
990 case LZMA_FILTER_ARMTHUMB:
991 case LZMA_FILTER_SPARC: {
992 static const char bcj_names[][9] = {
1001 const lzma_options_bcj *opt = filters[i].options;
1002 my_snprintf(&pos, &left, "%s", bcj_names[filters[i].id
1003 - LZMA_FILTER_X86]);
1005 // Show the start offset only when really needed.
1006 if (opt != NULL && opt->start_offset != 0)
1007 my_snprintf(&pos, &left, "=start=%" PRIu32,
1013 case LZMA_FILTER_DELTA: {
1014 const lzma_options_delta *opt = filters[i].options;
1015 my_snprintf(&pos, &left, "delta=dist=%" PRIu32,
1021 // This should be possible only if liblzma is
1022 // newer than the xz tool.
1023 my_snprintf(&pos, &left, "UNKNOWN");
1033 message_filters_show(enum message_verbosity v, const lzma_filter *filters)
1038 fprintf(stderr, _("%s: Filter chain: %s\n"), progname,
1039 message_filters_to_str(filters, true));
1045 message_try_help(void)
1047 // Print this with V_WARNING instead of V_ERROR to prevent it from
1048 // showing up when --quiet has been specified.
1049 message(V_WARNING, _("Try `%s --help' for more information."),
1056 message_memlimit(void)
1059 printf("%" PRIu64 "\n", hardware_memlimit_get());
1061 printf(_("%s MiB (%s bytes)\n"),
1063 round_up_to_mib(hardware_memlimit_get()), 0),
1064 uint64_to_str(hardware_memlimit_get(), 1));
1066 tuklib_exit(E_SUCCESS, E_ERROR, verbosity != V_SILENT);
1071 message_version(void)
1073 // It is possible that liblzma version is different than the command
1074 // line tool version, so print both.
1076 printf("XZ_VERSION=%d\nLIBLZMA_VERSION=%d\n",
1077 LZMA_VERSION, lzma_version_number());
1079 printf("xz (" PACKAGE_NAME ") " LZMA_VERSION_STRING "\n");
1080 printf("liblzma %s\n", lzma_version_string());
1083 tuklib_exit(E_SUCCESS, E_ERROR, verbosity != V_SILENT);
1088 message_help(bool long_help)
1090 printf(_("Usage: %s [OPTION]... [FILE]...\n"
1091 "Compress or decompress FILEs in the .xz format.\n\n"),
1094 puts(_("Mandatory arguments to long options are mandatory for "
1095 "short options too.\n"));
1098 puts(_(" Operation mode:\n"));
1101 " -z, --compress force compression\n"
1102 " -d, --decompress force decompression\n"
1103 " -t, --test test compressed file integrity\n"
1104 " -l, --list list information about files"));
1107 puts(_("\n Operation modifiers:\n"));
1110 " -k, --keep keep (don't delete) input files\n"
1111 " -f, --force force overwrite of output file and (de)compress links\n"
1112 " -c, --stdout write to standard output and don't delete input files"));
1116 " --no-sparse do not create sparse files when decompressing\n"
1117 " -S, --suffix=.SUF use the suffix `.SUF' on compressed files\n"
1118 " --files=[FILE] read filenames to process from FILE; if FILE is\n"
1119 " omitted, filenames are read from the standard input;\n"
1120 " filenames must be terminated with the newline character\n"
1121 " --files0=[FILE] like --files but use the null character as terminator"));
1124 puts(_("\n Basic file format and compression options:\n"));
1126 " -F, --format=FMT file format to encode or decode; possible values are\n"
1127 " `auto' (default), `xz', `lzma', and `raw'\n"
1128 " -C, --check=CHECK integrity check type: `crc32', `crc64' (default),\n"
1129 " `sha256', or `none' (use with caution)"));
1133 " -0 .. -9 compression preset; 0-2 fast compression, 3-5 good\n"
1134 " compression, 6-9 excellent compression; default is 6"));
1137 " -e, --extreme use more CPU time when encoding to increase compression\n"
1138 " ratio without increasing memory usage of the decoder"));
1141 puts(_( // xgettext:no-c-format
1142 " -M, --memory=NUM use roughly NUM bytes of memory at maximum; 0 indicates\n"
1143 " the default setting, which is 40 % of total RAM"));
1147 "\n Custom filter chain for compression (alternative for using presets):"));
1149 #if defined(HAVE_ENCODER_LZMA1) || defined(HAVE_DECODER_LZMA1) \
1150 || defined(HAVE_ENCODER_LZMA2) || defined(HAVE_DECODER_LZMA2)
1153 " --lzma1[=OPTS] LZMA1 or LZMA2; OPTS is a comma-separated list of zero or\n"
1154 " --lzma2[=OPTS] more of the following options (valid values; default):\n"
1155 " preset=NUM reset options to preset number NUM (0-9)\n"
1156 " dict=NUM dictionary size (4KiB - 1536MiB; 8MiB)\n"
1157 " lc=NUM number of literal context bits (0-4; 3)\n"
1158 " lp=NUM number of literal position bits (0-4; 0)\n"
1159 " pb=NUM number of position bits (0-4; 2)\n"
1160 " mode=MODE compression mode (fast, normal; normal)\n"
1161 " nice=NUM nice length of a match (2-273; 64)\n"
1162 " mf=NAME match finder (hc3, hc4, bt2, bt3, bt4; bt4)\n"
1163 " depth=NUM maximum search depth; 0=automatic (default)"));
1168 " --x86[=OPTS] x86 BCJ filter\n"
1169 " --powerpc[=OPTS] PowerPC BCJ filter (big endian only)\n"
1170 " --ia64[=OPTS] IA64 (Itanium) BCJ filter\n"
1171 " --arm[=OPTS] ARM BCJ filter (little endian only)\n"
1172 " --armthumb[=OPTS] ARM-Thumb BCJ filter (little endian only)\n"
1173 " --sparc[=OPTS] SPARC BCJ filter\n"
1174 " Valid OPTS for all BCJ filters:\n"
1175 " start=NUM start offset for conversions (default=0)"));
1177 #if defined(HAVE_ENCODER_DELTA) || defined(HAVE_DECODER_DELTA)
1180 " --delta[=OPTS] Delta filter; valid OPTS (valid values; default):\n"
1181 " dist=NUM distance between bytes being subtracted\n"
1182 " from each other (1-256; 1)"));
1187 puts(_("\n Other options:\n"));
1190 " -q, --quiet suppress warnings; specify twice to suppress errors too\n"
1191 " -v, --verbose be verbose; specify twice for even more verbose"));
1195 " -Q, --no-warn make warnings not affect the exit status"));
1197 " --robot use machine-parsable messages (useful for scripts)"));
1200 " --info-memory display the memory usage limit and exit"));
1202 " -h, --help display the short help (lists only the basic options)\n"
1203 " -H, --long-help display this long help and exit"));
1206 " -h, --help display this short help and exit\n"
1207 " -H, --long-help display the long help (lists also the advanced options)"));
1211 " -V, --version display the version number and exit"));
1213 puts(_("\nWith no FILE, or when FILE is -, read standard input.\n"));
1217 "On this system and configuration, this program will use a maximum of roughly\n"
1218 "%s MiB RAM and "), uint64_to_str(round_up_to_mib(hardware_memlimit_get()), 0));
1219 printf(N_("one thread.\n\n", "%s threads.\n\n",
1220 hardware_threadlimit_get()),
1221 uint64_to_str(hardware_threadlimit_get(), 0));
1224 // TRANSLATORS: This message indicates the bug reporting address
1225 // for this package. Please add _another line_ saying
1226 // "Report translation bugs to <...>\n" with the email or WWW
1227 // address for translation bugs. Thanks.
1228 printf(_("Report bugs to <%s> (in English or Finnish).\n"),
1230 printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
1232 tuklib_exit(E_SUCCESS, E_ERROR, verbosity != V_SILENT);