xwd Command

Purpose

Dumps the image of an Enhanced X-Windows window.

Syntax

xwd [ -add Value ] [  -frame ] [  -display  Display ] [  -help ] [  -nobdrs ] [  -xy ] [  -out File ] [  -root -id id -name Name ] [  -icmap ] [  -screen ]

Description

The xwd command is an Enhanced X-Windows window dumping utility. The xwd command allows you to store window images in a specially formatted dump file. This file can then be read by various other X utilities that perform functions such as redisplaying, printing, editing, formatting, archiving, and image processing. Select the target window by clicking the mouse in the desired window. The keyboard bell rings once at the beginning of the dump and twice when the dump is completed.

Flags

Item Description
-add Value Specifies a signed value to add to every pixel. This option is specific to X11R5.
-frame This option indicates that the window manager frame should be included when manually selecting a window.
-display Display Specifies the server connection.
-help Prints the usage command syntax summary.
-nobdrs Specifies that the window dump does not include the pixels that compose the X window border. This is useful if you want to include the window contents in a document as an illustration. The result of the -nobdrs flag depends on which window manager is running. Many window managers remove all borders from the client. For example, the XGetWindowAttributes function returns the value of 0 for the border_width field regardless of the border width when the client was started. Therefore, any border that is visible on the screen belongs to the window manager; the client has no knowledge of it. In this case, the -nobdrs flag has no effect.
-out File Specifies the output file on the command line. The default is to output to standard out.
-root Indicates that the root window should be selected for the window dump, without requiring the user to select a window with the pointer. This option is specific to X11R5.
-id id Indicates that the window with the specified resource id should be selected for the window dump, without requiring the user to select a window with the pointer. This option is specific to X11R5.
-name Name Indicates that the window with the specified WM_NAME property should be selected for the window dump, without requiring the user to select a window with the pointer. This option is specific to X11R5.
-icmap Forces the first installed colormap of the screen to be used to obtain RGB values. By default, the colormap of the chosen window is used. This option is specific to X11R5.
-screen Indicates that the GetImage request used to obtain the image should be done on the root window, rather than directly on the specified window. In this way, you can obtain pieces of the other windows that overlap the specified window and, more importantly, capture menus or other popups that are independent windows but appear over the specified window. This option is specific to X11R5.
-xy Selects xy format dumping instead of the default z format. This option applies to color displays only.

File

Item Description
XWDFile.h X Window dump file format definition file.