]> wimlib.net Git - wimlib/blobdiff - programs/imagex.c
wimlib-imagex: Update help
[wimlib] / programs / imagex.c
index b983c7f317b36bce77ebbb8c0cb5245a7f4dd6f4..347564c55a8c3e4787205dc618f033f93212eee1 100644 (file)
@@ -142,7 +142,6 @@ enum {
        IMAGEX_NORPFIX_OPTION,
        IMAGEX_NOCHECK_OPTION,
        IMAGEX_NO_ACLS_OPTION,
-       IMAGEX_NO_PACK_STREAMS_OPTION,
        IMAGEX_NOT_PIPABLE_OPTION,
        IMAGEX_PACK_STREAMS_OPTION,
        IMAGEX_PATH_OPTION,
@@ -232,6 +231,8 @@ static const struct option export_options[] = {
        {T("nocheck"),     no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
        {T("no-check"),    no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
        {T("compress"),    required_argument, NULL, IMAGEX_COMPRESS_OPTION},
+       {T("pack-streams"),no_argument,       NULL, IMAGEX_PACK_STREAMS_OPTION},
+       {T("chunk-size"),  required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
        {T("ref"),         required_argument, NULL, IMAGEX_REF_OPTION},
        {T("threads"),     required_argument, NULL, IMAGEX_THREADS_OPTION},
        {T("rebuild"),     no_argument,       NULL, IMAGEX_REBUILD_OPTION},
@@ -292,6 +293,7 @@ static const struct option optimize_options[] = {
        {T("compress-slow"), no_argument,     NULL, IMAGEX_COMPRESS_SLOW_OPTION},
        {T("recompress-slow"), no_argument,     NULL, IMAGEX_COMPRESS_SLOW_OPTION},
        {T("chunk-size"),  required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
+       {T("pack-streams"),no_argument,       NULL, IMAGEX_PACK_STREAMS_OPTION},
        {T("threads"),     required_argument, NULL, IMAGEX_THREADS_OPTION},
        {T("pipable"),     no_argument,       NULL, IMAGEX_PIPABLE_OPTION},
        {T("not-pipable"), no_argument,       NULL, IMAGEX_NOT_PIPABLE_OPTION},
@@ -417,6 +419,8 @@ get_compression_type(const tchar *optarg)
                return WIMLIB_COMPRESSION_TYPE_LZX;
        else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
                return WIMLIB_COMPRESSION_TYPE_XPRESS;
+       else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms")))
+               return WIMLIB_COMPRESSION_TYPE_LZMS;
        else if (!tstrcasecmp(optarg, T("none")))
                return WIMLIB_COMPRESSION_TYPE_NONE;
        else {
@@ -430,8 +434,10 @@ static int
 set_compress_slow(void)
 {
        int ret;
-       static const struct wimlib_lzx_params slow_params = {
-               .size_of_this = sizeof(struct wimlib_lzx_params),
+       static const struct wimlib_lzx_compressor_params slow_params = {
+               .hdr = {
+                       .size = sizeof(struct wimlib_lzx_compressor_params),
+               },
                .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
                .alg_params = {
                        .slow = {
@@ -446,7 +452,8 @@ set_compress_slow(void)
                        },
                },
        };
-       ret = wimlib_lzx_set_default_params(&slow_params);
+       ret = wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
+                                                  &slow_params.hdr);
        if (ret)
                imagex_error(T("Couldn't set slow compression parameters.!"));
        return ret;
@@ -1049,6 +1056,34 @@ get_unit(uint64_t total_bytes, const tchar **name_ret)
        }
 }
 
+static struct wimlib_progress_info_scan last_scan_progress;
+
+static void
+report_scan_progress(const struct wimlib_progress_info_scan *scan, bool done)
+{
+       uint64_t prev_count, cur_count;
+
+       prev_count = last_scan_progress.num_nondirs_scanned +
+                    last_scan_progress.num_dirs_scanned;
+       cur_count = scan->num_nondirs_scanned + scan->num_dirs_scanned;
+
+       if (done || prev_count == 0 || cur_count >= prev_count + 100 ||
+           cur_count % 128 == 0)
+       {
+               unsigned unit_shift;
+               const tchar *unit_name;
+
+               unit_shift = get_unit(scan->num_bytes_scanned, &unit_name);
+               imagex_printf(T("\r%"PRIu64" %"TS" scanned (%"PRIu64" files, "
+                               "%"PRIu64" directories)"),
+                             scan->num_bytes_scanned >> unit_shift,
+                             unit_name,
+                             scan->num_nondirs_scanned,
+                             scan->num_dirs_scanned);
+               last_scan_progress = *scan;
+       }
+}
+
 /* Progress callback function passed to various wimlib functions. */
 static int
 imagex_progress_func(enum wimlib_progress_msg msg,
@@ -1057,6 +1092,7 @@ imagex_progress_func(enum wimlib_progress_msg msg,
        unsigned percent_done;
        unsigned unit_shift;
        const tchar *unit_name;
+
        if (imagex_be_quiet)
                return 0;
        switch (msg) {
@@ -1103,23 +1139,28 @@ imagex_progress_func(enum wimlib_progress_msg msg,
                                  "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
                               info->scan.wim_target_path);
                } else {
-                       imagex_printf(T(" (loading as root of WIM image)...\n"));
+                       imagex_printf(T("\n"));
                }
+               memset(&last_scan_progress, 0, sizeof(last_scan_progress));
                break;
        case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
                switch (info->scan.status) {
                case WIMLIB_SCAN_DENTRY_OK:
-                       imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
+                       report_scan_progress(&info->scan, false);
                        break;
                case WIMLIB_SCAN_DENTRY_EXCLUDED:
-                       imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
+                       imagex_printf(T("\nExcluding \"%"TS"\" from capture\n"), info->scan.cur_path);
                        break;
                case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
-                       imagex_printf(T("WARNING: Excluding unsupported file or directory\n"
+                       imagex_printf(T("\nWARNING: Excluding unsupported file or directory\n"
                                        "         \"%"TS"\" from capture\n"), info->scan.cur_path);
                        break;
                }
                break;
+       case WIMLIB_PROGRESS_MSG_SCAN_END:
+               report_scan_progress(&info->scan, true);
+               imagex_printf(T("\n"));
+               break;
        case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
                unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
                percent_done = TO_PERCENT(info->integrity.completed_bytes,
@@ -1512,7 +1553,7 @@ imagex_apply(int argc, tchar **argv, int cmd)
                        extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
                        break;
                case IMAGEX_VERBOSE_OPTION:
-                       extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
+                       /* No longer does anything.  */
                        break;
                case IMAGEX_REF_OPTION:
                        ret = string_set_append(&refglobs, optarg);
@@ -1669,7 +1710,8 @@ imagex_capture_or_append(int argc, tchar **argv, int cmd)
        int c;
        int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
        int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
-                             WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
+                             WIMLIB_ADD_IMAGE_FLAG_WINCONFIG |
+                             WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
        int write_flags = 0;
        int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
        uint32_t chunk_size = UINT32_MAX;
@@ -1748,7 +1790,7 @@ imagex_capture_or_append(int argc, tchar **argv, int cmd)
                        add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
                        break;
                case IMAGEX_VERBOSE_OPTION:
-                       add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
+                       /* No longer does anything.  */
                        break;
                case IMAGEX_THREADS_OPTION:
                        num_threads = parse_num_threads(optarg);
@@ -1827,13 +1869,14 @@ imagex_capture_or_append(int argc, tchar **argv, int cmd)
 
        /* Set default compression type.  */
        if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
-               struct wimlib_lzx_params params;
+               struct wimlib_lzx_compressor_params params;
                memset(&params, 0, sizeof(params));
-               params.size_of_this = sizeof(params);
+               params.hdr.size = sizeof(params);
                params.algorithm = WIMLIB_LZX_ALGORITHM_FAST;
                params.use_defaults = 1;
 
-               wimlib_lzx_set_default_params(&params);
+               wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
+                                                    &params.hdr);
                compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
        }
 
@@ -2369,6 +2412,7 @@ imagex_export(int argc, tchar **argv, int cmd)
        bool wim_is_new;
        STRING_SET(refglobs);
        unsigned num_threads = 0;
+       uint32_t chunk_size = UINT32_MAX;
 
        for_opt(c, export_options) {
                switch (c) {
@@ -2387,6 +2431,14 @@ imagex_export(int argc, tchar **argv, int cmd)
                        if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
                                goto out_err;
                        break;
+               case IMAGEX_PACK_STREAMS_OPTION:
+                       write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
+                       break;
+               case IMAGEX_CHUNK_SIZE_OPTION:
+                       chunk_size = parse_chunk_size(optarg);
+                       if (chunk_size == UINT32_MAX)
+                               goto out_err;
+                       break;
                case IMAGEX_REF_OPTION:
                        ret = string_set_append(&refglobs, optarg);
                        if (ret)
@@ -2504,7 +2556,17 @@ imagex_export(int argc, tchar **argv, int cmd)
                if (ret)
                        goto out_free_src_wim;
 
-               wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
+               /* Use same chunk size if compression type is the same.  */
+               if (compression_type == src_info.compression_type &&
+                   chunk_size == UINT32_MAX)
+                       wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
+       }
+
+       if (chunk_size != UINT32_MAX) {
+               /* Set destination chunk size.  */
+               ret = wimlib_set_output_chunk_size(dest_wim, chunk_size);
+               if (ret)
+                       goto out_free_dest_wim;
        }
 
        image = wimlib_resolve_image(src_wim, src_image_num_or_name);
@@ -2649,7 +2711,7 @@ imagex_extract(int argc, tchar **argv, int cmd)
                        open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
                        break;
                case IMAGEX_VERBOSE_OPTION:
-                       extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
+                       /* No longer does anything.  */
                        break;
                case IMAGEX_REF_OPTION:
                        ret = string_set_append(&refglobs, optarg);
@@ -2785,10 +2847,7 @@ print_resource(const struct wimlib_resource_entry *resource,
 {
        tprintf(T("Uncompressed size     = %"PRIu64" bytes\n"),
                resource->uncompressed_size);
-       if (resource->is_packed_streams) {
-               tprintf(T("Raw uncompressed size = %"PRIu64" bytes\n"),
-                       resource->raw_resource_uncompressed_size);
-
+       if (resource->packed) {
                tprintf(T("Raw compressed size   = %"PRIu64" bytes\n"),
                        resource->raw_resource_compressed_size);
 
@@ -2805,7 +2864,6 @@ print_resource(const struct wimlib_resource_entry *resource,
                        resource->offset);
        }
 
-
        tprintf(T("Part Number           = %u\n"), resource->part_number);
        tprintf(T("Reference Count       = %u\n"), resource->reference_count);
 
@@ -2822,7 +2880,7 @@ print_resource(const struct wimlib_resource_entry *resource,
                tprintf(T("WIM_RESHDR_FLAG_FREE  "));
        if (resource->is_spanned)
                tprintf(T("WIM_RESHDR_FLAG_SPANNED  "));
-       if (resource->is_packed_streams)
+       if (resource->packed)
                tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS  "));
        tputchar(T('\n'));
        tputchar(T('\n'));
@@ -3322,6 +3380,10 @@ imagex_optimize(int argc, tchar **argv, int cmd)
                        if (chunk_size == UINT32_MAX)
                                goto out_err;
                        break;
+               case IMAGEX_PACK_STREAMS_OPTION:
+                       write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
+                       write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
+                       break;
                case IMAGEX_THREADS_OPTION:
                        num_threads = parse_num_threads(optarg);
                        if (num_threads == UINT_MAX)
@@ -3514,7 +3576,8 @@ imagex_update(int argc, tchar **argv, int cmd)
        int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
        int write_flags = 0;
        int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
-       int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
+       int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
+                               WIMLIB_ADD_FLAG_VERBOSE;
        int default_delete_flags = 0;
        unsigned num_threads = 0;
        int c;
@@ -3573,7 +3636,7 @@ imagex_update(int argc, tchar **argv, int cmd)
 
                /* Default add options */
                case IMAGEX_VERBOSE_OPTION:
-                       default_add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
+                       /* No longer does anything.  */
                        break;
                case IMAGEX_DEREFERENCE_OPTION:
                        default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
@@ -3749,36 +3812,33 @@ static const tchar *usage_strings[] = {
 [CMD_APPEND] =
 T(
 "    %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
-"                    [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
-"                    [--check] [--nocheck] [--flags EDITION_ID] [--verbose]\n"
-"                    [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
-"                    [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
-"                    [--norpfix] [--unix-data] [--pipable]\n"
+"                    [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
+"                    [--nocheck] [--flags EDITION_ID] [--dereference]\n"
+"                    [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
+"                    [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
 "                    [--update-of=[WIMFILE:]IMAGE]\n"
 ),
 [CMD_APPLY] =
 T(
 "    %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
 "                    (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
-"                    [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
-"                    [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
-"                    [--include-invalid-names]\n"
+"                    [--symlink] [--ref=\"GLOB\"] [--no-acls] [--strict-acls]\n"
+"                    [--rpfix] [--norpfix] [--include-invalid-names]\n"
 ),
 [CMD_CAPTURE] =
 T(
 "    %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
-"                   [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
-"                    [--check] [--nocheck] [--compress=TYPE]\n"
-"                    [--flags EDITION_ID] [--verbose] [--dereference]\n"
-"                    [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
-"                    [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
-"                    [--unix-data] [--pipable] [--update-of=[WIMFILE:]IMAGE]\n"
+"                   [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
+"                    [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
+"                    [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
+"                    [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
+"                    [--norpfix] [--update-of=[WIMFILE:]IMAGE]\n"
 "                    [--delta-from=WIMFILE]\n"
 ),
 [CMD_DELETE] =
 T(
-"    %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
-"                    [--soft]\n"
+"    %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n"
+"                    [--check] [--soft]\n"
 ),
 [CMD_DIR] =
 T(
@@ -3790,21 +3850,19 @@ T(
 "                    DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
 "                    [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
 "                    [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
-"                    [--pipable] [--not-pipable]\n"
 ),
 [CMD_EXTRACT] =
 T(
 "    %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
-"                    [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
-"                    [--no-acls] [--strict-acls] [--to-stdout]\n"
-"                    [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
+"                    [--check] [--ref=\"GLOB\"] [--no-acls] [--strict-acls]\n"
+"                    [--to-stdout] [--dest-dir=CMD_DIR]\n"
+"                    [--include-invalid-names]\n"
 ),
 [CMD_INFO] =
 T(
 "    %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
-"                    [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
-"                    [--lookup-table] [--xml] [--extract-xml FILE]\n"
-"                    [--metadata]\n"
+"                    [NEW_DESC]]] [--boot] [--check] [--nocheck] [--xml]\n"
+"                    [--extract-xml FILE] [--header] [--lookup-table]\n"
 ),
 [CMD_JOIN] =
 T(
@@ -3814,21 +3872,21 @@ T(
 [CMD_MOUNT] =
 T(
 "    %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
-"                    [--check] [--debug] [--streams-interface=INTERFACE]\n"
-"                    [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
+"                    [--check] [--streams-interface=INTERFACE]\n"
+"                    [--ref=\"GLOB\"] [--allow-other]\n"
 ),
 [CMD_MOUNTRW] =
 T(
 "    %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
-"                    [--check] [--debug] [--streams-interface=INTERFACE]\n"
-"                    [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
+"                    [--check] [--streams-interface=INTERFACE]\n"
+"                    [--staging-dir=CMD_DIR] [--allow-other]\n"
 ),
 #endif
 [CMD_OPTIMIZE] =
 T(
 "    %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
 "                    [--recompress-slow] [--compress=TYPE]\n"
-"                    [--threads=NUM_THREADS] [--pipable] [--not-pipable]\n"
+"                    [--threads=NUM_THREADS]\n"
 ),
 [CMD_SPLIT] =
 T(
@@ -3952,6 +4010,7 @@ usage_all(FILE *fp)
 "    %"TS" --version\n"
 "\n"
 "    The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
+"    Uncommon options are not listed; see the documentation for full details.\n"
 "\n"
        );
        tfprintf(fp, extra, invocation_name, invocation_name);