Skip to content

Commit

Permalink
Merge pull request #4 from CodingWonders/dt_help/dt_pre_2411
Browse files Browse the repository at this point in the history
Help documentation contents for DISMTools 0.4.1 Preview 1
  • Loading branch information
CodingWonders authored Jan 5, 2024
2 parents e03358b + 6440d0e commit 239478c
Show file tree
Hide file tree
Showing 12 changed files with 125 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/docs/getting_started/msmg_migration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Coming from MSMG Toolkit

<p align="center">
<img src="../../../res/getting_started/msmg_toolkit.png" />
<img src="../../res/getting_started/msmg_toolkit.png" />
</p>

MSMG Toolkit is a free and open-source UI for DISM operations, which lets you integrate packages, manage features, and more. If you are coming from this utility to DISMTools, here are some changes:
Expand All @@ -11,7 +11,7 @@ MSMG Toolkit is a free and open-source UI for DISM operations, which lets you in
MSMG Toolkit is a terminal user interface (TUI) front-end with menus that you can operate by pressing a keyboard button. This is still intuitive, but not as much as a graphical user interface (GUI) front-end; which DISMTools and other UIs are.

<p align="center">
<img src="../../../res/product.png" />
<img src="../../res/product.png" />
</p>

## Operations
Expand Down
128 changes: 123 additions & 5 deletions docs/docs/img_tasks/tools/mimgmgr.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ The mounted image manager allows you to manage your mounted images easily. You c
- Remove volume images (for images with multiple indexes)
- Load a mount directory to projects with no images loaded

DISMTools 0.3 introduces a command-line version of this tool. For more information, check [its dedicated page](../../cli_tools/mimgmgr.md).

## Operations

### Unmounting a Windows image
Expand All @@ -25,7 +23,7 @@ You can unmount a Windows image saving changes, discarding them, or with more se
<img src="../../../res/img_tasks/tools/mimgmgr/img_unmount.png" />
</p>

For read-only mounted images, clicking this button will directly unmount the image discarding changes. For more information, go to the [image unmount](https://example.com) page.
For read-only mounted images, clicking this button will directly unmount the image discarding changes. For more information, go to the [image unmount](../../mgmt/unmount_image) page.

### Reloading the servicing session/repairing the component store

Expand All @@ -44,8 +42,128 @@ This will open the mount directory in File Explorer, allowing you to browse the

### Removing volume images

If the mounted image contains more than 1 index, you are able to remove volume images from it easily. Specify the indexes to remove, and click OK. For more information, refer to the [volume image removal](https://example.com) page.
If the mounted image contains more than 1 index, you are able to remove volume images from it easily. Specify the indexes to remove, and click OK. For more information, refer to the [volume image removal](../../mgmt/delete_image) page.

### Loading mounted images

If you've opened a project with no images loaded, you can easily load the mounted image you want to the project.
If you've opened a project with no images loaded, you can easily load the mounted image you want to the project.

## Command-line version

DISMTools 0.3 introduces a command-line version of the mounted image manager with which you can easily manage your mounted images as well.

### Differences from the GUI version

- The mounted image list is not updated automatically in the CLI version

### Accessing this version

You can access the CLI version of the mounted image manager through the Command Console in the Tools menu by typing `mimgmgr`. You will then see an overview of the mounted images:

<p align="center">
<img src="../../../res/img_tasks/tools/mimgmgr/cli/mimgmgr_defaultview.png" />
</p>

### Usage

When you load this version of the mounted image manager, you need to **mark an image for management**. You can easily do this by pressing the M key and selecting an image using its number. If the list was modified in the background, you'll see an updated list.

<p align="center">
<img src="../../../res/img_tasks/tools/mimgmgr/cli/mimgmgr_mark_image.png" />
</p>

After marking an image, you can then perform management actions with it.

<p align="center">
<img src="../../../res/img_tasks/tools/mimgmgr/cli/mimgmgr_marked_image.png" />
</p>

### Tasks

These are the tasks you can do with this version of the mounted image manager:

- If you want to switch to another image, you can **mark it** (M key)
- Depending on the status of the image (R key):

- If it needs a servicing session reload (`Status: NeedsRemount`), you can **reload** it
- If it needs a component store repair (`Status: Invalid`), you can **repair** it

- When you've finished working with an image, you can **unmount it** (U key)
- You can **access its mount directory** (A key)
- If the image contains multiple indexes (volume images), you can remove those from it (V key) or switch to another index (S key, *DISMTools 0.3.3 and later*)
- If images were mounted or unmounted from an external program, you can **update the mounted image listing** (L key)
- If the image is mounted with read-only privileges, you can **enable write permissions** (E key)

Then, press ENTER to perform an action.

#### Unmounting an image

**NOTE:** if the image is mounted with read-only privileges, this action will directly unmount it discarding changes

<p align="center">
<img src="../../../res/img_tasks/tools/mimgmgr/cli/mimgmgr_unmount_image.png" />
</p>

In this menu:

- You can **commit the changes of an image and unmount it** (C key)
- You can **discard the changes of an image and unmount it** (D key)
- You can **configure unmount settings** (S key)

**Unmount settings**

**NOTE:** these settings only apply to the commit operation. You can't change settings for read-only mounted images.

<p align="center">
<img src="../../../res/img_tasks/tools/mimgmgr/cli/mimgmgr_unmount_settings.png" />
</p>

These are the same settings you would find in the [image unmount dialog](../../mgmt/unmount_image). Configure them as you like and press ENTER to perform the unmount operation.

#### Removing volume images

**NOTE:** this task is only applicable to images with multiple indexes

<p align="center">
<img src="../../../res/img_tasks/tools/mimgmgr/cli/mimgmgr_delete_image.png" />
</p>

In this menu you can **mark the volume images (indexes) to remove** (M key) and **proceed with the removal operation** (P key).

Do note that proceeding with the volume image operation will unmount the image **discarding changes**. Make sure you have saved them before beginning.

During this operation, you can view the image that is being removed. Once this process finishes, you'll go back to the main menu.

<p align="center">
<img src="https://github.com/CodingWonders/DISMTools/assets/101426328/abb6704d-2e2b-493f-a80a-431b04fee453" />
</p>

**Marking volume images to remove**

From the image index list shown above, you can pick the volume images to remove by specifying its number. You can specify multiple indexes by separating numbers with commas (`,`). Finally, press ENTER:

<p align="center">
<img src="../../../res/img_tasks/tools/mimgmgr/cli/mimgmgr_delete_image_indexmark.png" />
</p>

#### Switching indexes

**NOTE:** this task is only applicable to images with multiple indexes

<p align="center">
<img src="../../../res/img_tasks/tools/mimgmgr/cli/mimgmgr_switch_image.png" />
</p>

In this menu you can **specify the target index to mount** (S key), **specify the unmount operation** (C key) and **proceed with the switch operation** (P key).

**Specifying the target index**

From the image index list shown above, you can pick the target index to mount by specifying its number. Finally, press ENTER:

<p align="center">
<img src="../../../res/img_tasks/tools/mimgmgr/cli/mimgmgr_delete_image_indexmark.png" />
</p>

#### Enabling write permissions

This is an automated process that unmounts a read-only mounted image and mounts it again with write permissions. **Make sure the location of the source image file is still available before proceeding**.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,4 @@ nav:
- Overview: cli_tools/cmd_console.md
- Tools:
- Command help: cli_tools/cmdhelp.md
- Mounted image manager (CLI version): cli_tools/mimgmgr.md
- Extended AppX package getter: cli_tools/extappx.md

0 comments on commit 239478c

Please sign in to comment.