summaryrefslogtreecommitdiffstats
path: root/upstream/fedora-40/man1/ppmtoicr.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/fedora-40/man1/ppmtoicr.1')
-rw-r--r--upstream/fedora-40/man1/ppmtoicr.1159
1 files changed, 159 insertions, 0 deletions
diff --git a/upstream/fedora-40/man1/ppmtoicr.1 b/upstream/fedora-40/man1/ppmtoicr.1
new file mode 100644
index 00000000..a13741d5
--- /dev/null
+++ b/upstream/fedora-40/man1/ppmtoicr.1
@@ -0,0 +1,159 @@
+\
+.\" 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 "Ppmtoicr User Manual" 0 "17 July 2022" "netpbm documentation"
+
+.SH NAME
+
+ppmtoicr - convert a PPM image into NCSA ICR format
+
+.UN synopsis
+.SH SYNOPSIS
+
+\fBppmtoicr\fP
+
+[\fB-windowname\fP \fIname\fP]
+
+[\fB-expand\fP \fIexpand\fP]
+
+[\fB-display\fP \fIdisplay\fP]
+
+[\fIppmfile\fP]
+.PP
+Minimum unique abbreviation of option is acceptable. You may use double
+hyphens instead of single hyphen to denote options. You may use white
+space in place of the equals sign to separate an option name from its value.
+
+
+.UN description
+.SH DESCRIPTION
+.PP
+This program is part of
+.BR "Netpbm" (1)\c
+\&.
+.PP
+\fBppmtoicr\fP reads a PPM file as input. Produces an NCSA Telnet
+Interactive Color Raster graphic file as output.
+
+If \fIppmfile\fP is not supplied, \fBppmtoicr\fP reads from Standard
+Input.
+.PP
+Interactive Color Raster (ICR) is a protocol for displaying raster
+graphics on workstation screens. The protocol is implemented in NCSA
+Telnet for the Macintosh version 2.3. The ICR protocol shares
+characteristics of the Tektronix graphics terminal emulation protocol.
+For example, escape sequences are used to control the display.
+.PP
+\fBppmtoicr\fP will output the appropriate sequences to create a
+window of the dimensions of the input image, create a colormap of up
+to 256 colors on the display, then load the picture data into the
+window.
+.PP
+Note that there is no icrtoppm tool - this transformation is one
+way.
+
+.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
+\&), \fBppmtoicr\fP recognizes the following
+command line options:
+
+
+.TP
+\fB-windowname\fP \fIname\fP
+Output will be displayed in \fIname\fP.
+.sp
+\fIname\fP must be printable characters, and not '^'.
+.sp
+Default is to use the input file name if specified on the command line or
+ "untitled" if the input is from Standard Input. In the former case, any
+ unprintable character or '^' in the file name becomes a
+ '.' in the window name.
+
+.TP
+\fB-expand\fP \fIexpand\fP
+Output will be expanded on display by factor \fIexpand\fP (For
+example, a value of 2 will cause four pixels to be displayed for every
+input pixel.)
+
+.TP
+\fB-display\fP \fIdisplay\fP
+Output will be displayed on screen numbered \fIdisplay\fP
+
+
+
+.UN examples
+.SH EXAMPLES
+
+To display a PPM file named \fBppmfile\fP using the protocol:
+
+.nf
+ ppmtoicr ppmfile
+
+.fi
+
+This will create a window named \fIppmfile\fP on the display with the
+correct dimensions for \fIppmfile\fP, create and download a colormap
+of up to 256 colors, and download the picture into the window. You
+may achieve the same effect with the following sequence:
+
+.nf
+ ppmtoicr ppmfile > filename
+ cat filename
+
+.fi
+.PP
+To display a GIF file using the protocol in a window titled after the
+input file, zoom the displayed image by a factor of 2:
+
+.nf
+ giftopnm giffile | ppmtoicr -windowname=giffile -expand=2
+
+.fi
+
+.UN limitations
+.SH LIMITATIONS
+.PP
+The protocol uses frequent fflush() calls to speed up display. If
+you save the output to a file for later display via \fBcat\fP,
+\fBppmtoicr\fP will draw much more slowly. In either case,
+increasing the blocksize limit on the display will speed up
+transmission substantially.
+
+.UN seealso
+.SH SEE ALSO
+.BR "ppm" (1)\c
+\&
+.PP
+NCSA Telnet for the Macintosh, University of Illinois at
+Urbana-Champaign (1989)
+
+.UN history
+.SH HISTORY
+.PP
+Until Netpbm 10.71 (June 2015), there was a \fB-rle\fP option documented,
+which was said to cause the output to use run length encoding compression.
+But because of a simple bug in option processing code, the option never had
+any effect. And the compression code did not look like it worked anyway and
+would take a fair amount of work to fix. Because it was unlikely anyone would
+ever use this program again, much less want to use run length encoding, we
+removed it from the documentation rather than fix the code.
+
+.UN author
+.SH AUTHOR
+
+Copyright (C) 1990 by Kanthan Pillay (\fIsvpillay@Princeton.EDU\fP),
+Princeton University Computing and Information Technology.
+.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/ppmtoicr.html
+.PP \ No newline at end of file