summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/xwdtopnm.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man1/xwdtopnm.1')
-rw-r--r--upstream/debian-unstable/man1/xwdtopnm.1144
1 files changed, 144 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man1/xwdtopnm.1 b/upstream/debian-unstable/man1/xwdtopnm.1
new file mode 100644
index 00000000..74cd1869
--- /dev/null
+++ b/upstream/debian-unstable/man1/xwdtopnm.1
@@ -0,0 +1,144 @@
+\
+.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
+.\" Do not hand-hack it! If you have bug fixes or improvements, please find
+.\" the corresponding HTML page on the Netpbm website, generate a patch
+.\" against that, and send it to the Netpbm maintainer.
+.TH "Xwdtopnm User Manual" 1 "08 January 2010" "netpbm documentation"
+
+.SH NAME
+xwdtopnm - convert an X11 or X10 window dump file to a PNM image
+
+.UN synopsis
+.SH SYNOPSIS
+
+\fBxwdtopnm\fP
+[\fB-verbose\fP]
+[\fB-headerdump\fP]
+[\fIxwdfile\fP]
+
+.UN description
+.SH DESCRIPTION
+.PP
+This program is part of
+.BR "Netpbm" (1)\c
+\&.
+.PP
+\fBxwdtopnm\fP reads an X11 or X10 window dump file as input and
+produces a PNM image as output. The type of the output image depends
+on the input file - if it's black and white, the output is PBM. If
+it's grayscale, the output is PGM. Otherwise, it's PPM. The program
+tells you which type it is writing.
+.PP
+Using this program, you can convert anything you can display on an
+X workstation's screen into a PNM image. Just display whatever you're
+interested in, run the \fBxwd\fP program to capture the contents of
+the window, run it through \fBxwdtopnm\fP, and then use \fBpamcut\fP
+to select the part you want.
+.PP
+Note that a pseudocolor XWD image (typically what you get when you
+make a dump of a pseudocolor X window) has maxval 65535, which means
+the PNM file that \fBxwdtopnm\fP generates has maxval 65535. Many
+older image processing programs (that aren't part of the Netpbm
+package and don't use the Netpbm programming library) don't know how
+to handle a PNM image with maxval greater than 255 (because there are
+two bytes instead of one for each sample in the image). So you may
+want to run the output of \fBxwdtopnm\fP through \fBpamdepth\fP
+before feeding it to one of these old programs.
+.PP
+\fBxwdtopnm\fP can't convert every kind of XWD image (which essentially
+means it can't convert an XWD created from every kind of X display
+configuration). In particular, it cannot convert one with more than 24 bits
+per pixel.
+
+
+.UN options
+.SH OPTIONS
+.PP
+In addition to the options common to all programs based on libnetpbm
+(most notably \fB-quiet\fP, see
+.UR index.html#commonoptions
+ Common Options
+.UE
+\&), \fBxwdtopnm\fP recognizes the following
+command line options:
+
+
+.TP
+\fB-verbose\fP
+This option causes \fBxwdtopnm\fP to display handy information about the
+input image and the conversion process
+
+.TP
+\fB-headerdump\fP
+This option causes \fBxwdtopnm\fP to display the contents of the
+X11 header. It has no effect when the input is X10. This option was
+new in Netpbm 10.26 (December 2004).
+
+
+
+.UN notes
+.SH NOTES
+
+.UN twobytesamples
+.SS Two Byte Samples
+.PP
+\fBxwdtopnm\fP sometimes produces output with a maxval greater than 255,
+which means the maximum value of a sample (one intensity value, e.g. the
+red component of a pixel) is greater than 255 and therefore each sample
+takes 2 bytes to represent. This can be a problem because some programs
+expect those bytes in a different order from what the Netpbm format specs
+say, which is what \fBxwdtopnm\fP produces, which means they will see totally
+different colors than they should. \fBxv\fP is one such program.
+.PP
+If this is a problem (e.g. you want to look at the output of \fBxwdtopnm\fP
+with \fBxv\fP), there are two ways to fix it:
+
+
+.IP \(bu
+Pass the output through \fBpamendian\fP to produce the format the
+program expects.
+.IP \(bu
+Pass the output through \fBpamdepth\fP to reduce the maxval below 256
+so there is only one byte per sample.
+
+.PP
+Often, there is no good reason to have a maxval greater than 255. It
+happens because in XWD, but not PNM, each color component of a pixel can have
+different resolution, for example 5 bits for blue (maxval 31), 5 bits for red
+(maxval 31), and 6 bits for green (maxval 63), for a total of 16 bits per
+pixel. In order to reproduce the colors as closely as possible,
+\fBxwdtopnm\fP has to use a large maxval. In this example, it would use
+31 * 63 = 1953, and use 48 bits per pixel.
+.PP
+Because this is a common and frustrating problem when using \fBxwdtopnm\fP,
+the program issues a warning whenever it generates output with two byte
+samples. You can quiet this warning with the \fB-quiet\fP
+.UR index.html#commonoptions
+common option
+.UE
+\&. The warning was new in Netpbm 10.46
+(March 2009).
+
+
+.UN seealso
+.SH SEE ALSO
+.BR "pnmtoxwd" (1)\c
+\&,
+.BR "pamendian" (1)\c
+\&,
+.BR "pamdepth" (1)\c
+\&,
+.BR "pnm" (1)\c
+\&,
+\fBxwd\fP man page
+
+.UN author
+.SH AUTHOR
+
+Copyright (C) 1989, 1991 by Jef Poskanzer.
+.SH DOCUMENT SOURCE
+This manual page was generated by the Netpbm tool 'makeman' from HTML
+source. The master documentation is at
+.IP
+.B http://netpbm.sourceforge.net/doc/xwdtopnm.html
+.PP \ No newline at end of file