Skip to content

Commit 3936c96

Browse files
authored
Merge pull request #3201 from jsschultz/main
Update WinDbg docs for March release
2 parents a994372 + dd662c4 commit 3936c96

7 files changed

Lines changed: 143 additions & 49 deletions

File tree

windows-driver-docs-pr/debuggercmds/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
href: windbg-release-notes.md
99
- name: WinDbg - Command line startup options
1010
href: windbg-command-line-preview.md
11-
- name: WinDbg – Settings and workspaces
11+
- name: WinDbg – Settings, workspaces, and saved debug sessions
1212
href: windbg-setup-preview.md
1313
- name: WinDbg – Keyboard shortcuts
1414
href: windbg-keyboard-shortcuts.md

windows-driver-docs-pr/debuggercmds/using-debugger-commands.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
title: "Using Debugger Commands"
33
description: "This section describes using Debugger Commands. You enter commands at the prompt at the bottom of the window."
44
keywords: commands, debugger commands, meta-commands
5-
ms.date: 10/17/2023
5+
ms.date: 02/28/2026
66
ms.topic: how-to
7+
ai-usage: ai-assisted
78
---
89

910
# Using Debugger Commands
@@ -80,7 +81,7 @@ You can use standard editing keys when you enter a command:
8081

8182
You can press the TAB key to automatically complete your text entry. In any of the debuggers, press the TAB key after you enter at least one character to automatically complete a command. Press the TAB key repeatedly to cycle through text completion options, and hold down the SHIFT key and press TAB to cycle backward. You can also use wildcard characters in the text and press TAB to expand to the full set of text completion options. For example, if you type **fo\*!ba** and then press TAB, the debugger expands to the set of all symbols that start with "ba", in all modules with module names that start with "fo". As another example, you can complete all extension commands that have "prcb" in them by typing **!\*prcb** and then pressing TAB.
8283

83-
When you use the TAB key to perform text completion, if your text fragment begins with a period (.), the text is matched to a dot command. If your text fragment begins with an exclamation point (!), the text is matched to an extension command. Otherwise, the text is matched with a symbol. When you usee the TAB key to enter symbols, pressing the TAB key completes code and type symbols and module names. If no module name is apparent, local symbols and module names are completed. If a module or module pattern is given, symbol completion completes code and type symbols from all matches.
84+
When you use the TAB key to perform text completion, if your text fragment begins with a period (.), the text is matched to a dot command. If your text fragment begins with an exclamation point (!), the text is matched to an extension command. Otherwise, the text is matched with a symbol. When you use the TAB key to enter symbols, pressing the TAB key completes code and type symbols and module names. If no module name is apparent, local symbols and module names are completed. If a module or module pattern is given, symbol completion completes code and type symbols from all matches.
8485

8586
You can select and hold (or right-click) in the Debugger Command window to automatically paste the contents of the clipboard into the command that you are typing.
8687

@@ -92,7 +93,7 @@ If the last command that you issued presents a long display and you want to cut
9293

9394
In kernel-mode debugging, you can cancel commands from the keyboard of the target computer by pressing [**CTRL+C**](../debugger/ctrl-c--break-.md).
9495

95-
You can use the [**.cls (Clear Screen)**](-cls--clear-screen-.md) command to clear all of the text from the [Debugger Command window](../debugger/debugger-command-window.md). This command clears the whole command history. In WinDbg, you can clear the command history by using the **Edit | Clear Command Output** command or by selecting **Clear command output** on the shortcut menu of the Debugger Command window.
96+
You can use the [**.cls (Clear Screen)**](-cls--clear-screen-.md) command to clear all of the text from the [Debugger Command window](../debugger/debugger-command-window.md). This command clears the whole command history. In WinDbg, you can clear the command history by using **Clear History** on the **Command** ribbon tab, or by selecting **Clear command history** on the context menu (right-click) of the Command window.
9697

9798
### Expression Syntax
9899

@@ -122,19 +123,23 @@ You can use the scrollbar to view your previous commands and their output.
122123

123124
When you are using CDB or KD, any keyboard entry automatically scrolls down the Debugger Command window back to the bottom.
124125

125-
In WinDbg, the display automatically scrolls down to the bottom whenever a command produces output or you press the ENTER key. If you want to disable this automatic scrolling, select the **Options** on the **View** menu and then clear the **Automatically scroll** check box.
126+
In WinDbg, the display automatically scrolls down to the bottom whenever a command produces output or you press the ENTER key. If you want to disable this automatic scrolling, toggle off the **Auto Scroll** button on the **Command** ribbon tab, or right-click in the Command window and uncheck **Automatically scroll**.
126127

127128
### WinDbg Text Features
128129

129-
In WinDbg, you can use several additional features to change how text is displayed in the [Debugger Command window](../debugger/debugger-command-window.md). You can access some of these features in the WinDbg window, some in the shortcut menu in the Debugger Command window, and some by selecting the appropriate menu icon.
130+
In WinDbg, you can use several additional features to change how text is displayed in the [Debugger Command window](../debugger/debugger-command-window.md). You can access some of these features from the **Command** ribbon tab and some from the context menu (right-click) in the Command window.
130131

131-
- The **Word wrap** command on the shortcut menu turns on and off the word wrap status. This command affects the whole window, not only commands that you use after this state is changed. Because many commands and extensions produce formatted displays, we typically do not recommend word wrap.
132+
- The **Word wrap** command on the context menu turns on and off the word wrap status. This command affects the whole window, not only commands that you use after this state is changed. Because many commands and extensions produce formatted displays, we typically do not recommend word wrap.
132133

133-
- The **Edit | Add to Command Output** menu command adds a comment in the Debugger Command window. The **Add to command output** command on the shortcut menu has the same effect.
134+
- The **Highlight Selection** button on the **Command** ribbon tab (or **Highlight selection** on the context menu) highlights or un-highlights the current text selection (Ctrl+Alt+H).
135+
136+
- The **Erase Selection** button on the **Command** ribbon tab (or **Erase selected text** on the context menu) erases the currently selected text from the command history.
137+
138+
- You can navigate between command sections using **Go to Previous** (Ctrl+[) and **Go to Next** (Ctrl+]) on the **Command** ribbon tab, or **Select previous command** and **Select next command** on the context menu.
134139

135140
- You can customize the colors that are used for the text and the background of the Debugger Command window. You can specify different colors for different kinds of text. For example, you can display the automatic register output in one color, error messages in another color, and **DbgPrint** messages in a third color.
136141

137-
- You can use all of the features common to WinDbg's debugging information windows, such as customizing the fonts and using special editing commands.
142+
- You can use all of the features common to WinDbg's debugging information windows, such as customizing the fonts and using special editing commands.
138143

139144
### Remote Debugging
140145

windows-driver-docs-pr/debuggercmds/windbg-command-line-preview.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: 'WinDbg: Command-Line Startup Options'
33
description: "This section covers the command-line startup options for WinDbg."
44
keywords: ["Command line startup options", "WinDbg", "Menu", "Windows Debugging"]
5-
ms.date: 09/11/2019
5+
ms.date: 02/28/2026
6+
ai-usage: ai-assisted
67
ms.topic: reference
78
---
89

@@ -29,6 +30,8 @@ The following tables summarize the available command-line options.
2930
| `-c command` | Executes a command line after the debugger is attached. This command must be enclosed in quotation marks. Multiple commands can be separated with semicolons. |
3031
| `-v` | Enables verbose output in the debugger. |
3132
| `-T Title` | Sets the window title. |
33+
| `-Q` | Disables automatic saving of settings. Settings changes are only persisted when you explicitly select **File** > **Save workspace** or **Save workspace as**. |
34+
| `-WF SettingsFile` | Loads settings from the specified workspace file. |
3235
| `-logo LogFile` | Log Open. Begins logging information to a log file. If the file exists, it will be overwritten. |
3336
| `-loga LogFile` | Log Append. Begins logging information to a log file. If the file exists, it will be appended to. |
3437
| `-e EventHandle` | Signals the event with the given handle after the next exception in a target. |
@@ -122,7 +125,6 @@ Option | Description
122125

123126
Option | Description
124127
|------ | -----------|
125-
`-Q` | Deprecated command-line option.
126128
`-QY` | Deprecated command-line option.
127129
`-QS` | Deprecated command-line option.
128130
`-QSY` | Deprecated command-line option.

windows-driver-docs-pr/debuggercmds/windbg-file-preview.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: 'WinDbg: File Menu'
33
description: "This article describes how to use the File menu in the WinDbg debugger."
44
keywords: ["File Menu", "WinDbg", "Menu", "Windows Debugging"]
5-
ms.date: 01/10/2020
5+
ms.date: 02/28/2026
6+
ai-usage: ai-assisted
67
ms.topic: how-to
78
---
89

@@ -18,9 +19,9 @@ When you first open the **File** menu, you see **Start debugging** and your rece
1819

1920
#### Recent
2021

21-
The recent list contains a list of your recent workspaces and debugger connections. For more information on how to work with settings and workspaces, see [WinDbg setup: Settings and workspaces](windbg-setup-preview.md).
22+
The recent list contains a list of your recent debug sessions and debugger connections. For more information on how to work with settings, workspaces, and debug sessions, see [WinDbg setup: Settings, workspaces, and saved debug sessions](windbg-setup-preview.md).
2223

23-
You can use the right-click menu to manage your workspaces, like pinning, renaming, and moving them. You can also edit them in Notepad.
24+
You can use the right-click menu to manage your recent debug sessions, like pinning, renaming, and moving them. You can also edit them in Notepad.
2425

2526
:::image type="content" source="images/windbgx-workspace-right-click.png" alt-text="Right-click the menu for a workspace file with options to open, rename, edit in Notepad, pin, remove from lists, and clear unpinned targets.":::
2627

@@ -29,18 +30,32 @@ You can use the right-click menu to manage your workspaces, like pinning, renami
2930
Use the other tabs in the **Start debugging** section to start a new debugger session, like attaching or starting a process. For more information on starting a new session, see [WinDbg: Start a user-mode session](windbg-user-mode-preview.md)
3031
and [WinDbg: Start a kernel mode session](windbg-kernel-mode-preview.md).
3132

32-
### Save workspace
33+
### Save debug session
34+
35+
Use **Save debug session** to save the current target connection information to a file. Debug session files use the `.debugtarget` extension. This option is only available when a debug target is active.
36+
37+
The default location for debug session files is:
3338

34-
Use **Save workspace** to save the current workspace.
39+
```console
40+
C:\Users\*UserName*\AppData\Local\DBG\Targets
41+
```
3542

36-
Session connection information is stored in workspace configuration files. Workspace files are stored with a .debugTarget file extension.
43+
### Open workspace
3744

38-
The default location for workspace files is:
45+
Use **Open workspace** to load settings from a previously saved workspace file. Workspace files use the `.xml` extension and are stored by default in:
3946

4047
```console
41-
C:\Users\*UserName*\AppData\Local\DBG\targets
48+
C:\Users\*UserName*\AppData\Local\DBG\Workspaces
4249
```
4350

51+
### Save workspace
52+
53+
Use **Save workspace** to save the current settings to the active workspace file.
54+
55+
### Save workspace as
56+
57+
Use **Save workspace as** to save the current settings to a new workspace file.
58+
4459
### Open source file
4560

4661
Use **Open source file** to open a source file. Do this step when you want to work with other source files that didn't load because of code execution. For more information on working with source files, see [Source code debugging in WinDbg (Classic)](../debugger/source-window.md).
@@ -51,7 +66,7 @@ Use **Open script** to open an existing JavaScript or NatVis script. For more in
5166

5267
### Settings
5368

54-
Use **Settings** to set the source and symbol path and choose the light or dark theme for the debugger. For more information on settings, see [WinDbg setup: Settings and workspaces](windbg-setup-preview.md).
69+
Use **Settings** to set the source and symbol path and choose the theme for the debugger. The available themes are System (follows OS setting), Light, and Dark. For more information on settings, see [WinDbg setup: Settings, workspaces, and saved debug sessions](windbg-setup-preview.md).
5570

5671
### About
5772

windows-driver-docs-pr/debuggercmds/windbg-notes-etc-preview.md

Lines changed: 49 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,72 @@
11
---
22
title: 'WinDbg: Notes, Command, Memory, and Source Menus'
3-
description: "This article describes how to work with the Notes, Command, Memory, and Source menus."
3+
description: "This article describes how to work with the Notes, Command, Memory, and Source ribbon tab menus."
44
keywords: ["Notes, Command, Memory and Source Menus", "WinDbg", "Menu", "Windows Debugging"]
5-
ms.date: 01/10/2020
5+
ms.date: 02/28/2026
66
ms.topic: how-to
7+
ai-usage: ai-assisted
78
---
89

910
# WinDbg: Notes, Command, Memory, and Source menus
1011

11-
This article describes how to work with the **Notes**, **Command**, **Memory**, and **Source** menus in WinDbg.
12+
This article describes how to work with the **Notes**, **Command**, **Memory**, and **Source** ribbon tab menus in WinDbg. These ribbon tabs appear when the corresponding tool window is active.
1213

1314
## Notes
1415

15-
Use the **Notes** menu to:
16+
Use the **Notes** ribbon tab to:
1617

1718
- Open a notes file.
1819
- Save a notes file.
1920

2021
## Command
2122

22-
Use the **Command** menu to:
23+
The **Command** ribbon tab appears when the Command window is active. It contains the following groups:
2324

24-
- Prefer Debugger Markup Language (DML).
25-
- Highlight and clear highlighting for the current text selection (Ctrl+Alt+H).
26-
- Clear the Command window text.
27-
- Save window text to a .dml file.
25+
### Preferences
26+
27+
- **Prefer DML** - Toggle whether commands in the engine provide plain text or Debugger Markup Language (DML) output, if available.
28+
- **Auto Scroll** - Toggle whether the command window scroll position automatically synchronizes with the latest output.
29+
30+
### Selection
31+
32+
- **Highlight Selection** - Highlight or un-highlight the current text selection (Ctrl+Alt+H).
33+
- **Erase Selection** - Erase the currently selected text from the command history.
34+
- **Go to Previous** - Go to and select the previous command and its output (Ctrl+[).
35+
- **Go to Next** - Go to and select the next command and its output (Ctrl+]).
36+
37+
### Actions
38+
39+
- **Clear History** - Erase all command window text.
40+
- **Export History** - Write the command window text to a file.
41+
42+
### Command window context menu
43+
44+
You can also right-click in the Command window to access these options from a context menu:
45+
46+
- **Prefer DML** - Toggle DML output preference.
47+
- **Automatically scroll** - Toggle automatic scrolling.
48+
- **Highlight selection** (Ctrl+Alt+H) - Highlight or un-highlight the current text selection.
49+
- **Erase selected text** - Erase the selected text from the command history.
50+
- **Select previous command** (Ctrl+[) - Navigate to and select the previous command section.
51+
- **Select next command** (Ctrl+]) - Navigate to and select the next command section.
52+
- **Clear command history** - Erase all command window text.
53+
- **Export command history** - Write the command window text to a file.
54+
55+
### Command window settings
56+
57+
Additional command window settings are available in the **Settings** page (accessible from the **File** menu) under **Command window**:
58+
59+
- **Command output settings**:
60+
- Copy text with formatting (font and colors).
61+
- Display tabular links (dx -g) in the UI instead of the console.
62+
- Disable keyboard shortcut to jump by section in command window output.
63+
- Maximum command output size (in lines).
64+
- **Command prompt settings**:
65+
- Show command completion suggestions automatically.
2866

2967
## Memory
3068

31-
Use the **Memory** menu to:
69+
Use the **Memory** ribbon tab to:
3270

3371
- Set a data model memory query.
3472
- Set the memory size, for example, to byte or long.
@@ -37,7 +75,7 @@ Use the **Memory** menu to:
3775

3876
## Source
3977

40-
Use the **Source** menu to:
78+
Use the **Source** ribbon tab to:
4179

4280
- Open a source file.
4381
- Set an instruction pointer.

windows-driver-docs-pr/debuggercmds/windbg-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Watch the following episodes of the [Defrag Tools](</shows/defrag-tools/>) show
102102
Review the following articles for information about installing and configuring WinDbg:
103103

104104
- [WinDbg: Command-line startup options](windbg-command-line-preview.md)
105-
- [WinDbg: Settings and workspaces](windbg-setup-preview.md)
105+
- [WinDbg: Settings, workspaces, and saved debug sessions](windbg-setup-preview.md)
106106
- [WinDbg: Keyboard shortcuts](windbg-keyboard-shortcuts.md)
107107

108108
## Provide feedback

0 commit comments

Comments
 (0)