Debian Codegraph @

upstream/debian-unstable/man1/ppmtoicr.1

raw
1 \
2 .\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
3 .\" Do not hand-hack it! If you have bug fixes or improvements, please find
4 .\" the corresponding HTML page on the Netpbm website, generate a patch
5 .\" against that, and send it to the Netpbm maintainer.
6 .TH "Ppmtoicr User Manual" 1 "17 July 2022" "netpbm documentation"
7
8 .SH NAME
9
10 ppmtoicr - convert a PPM image into NCSA ICR format
11
12 .UN synopsis
13 .SH SYNOPSIS
14
15 \fBppmtoicr\fP
16
17 [\fB-windowname\fP \fIname\fP]
18
19 [\fB-expand\fP \fIexpand\fP]
20
21 [\fB-display\fP \fIdisplay\fP]
22
23 [\fIppmfile\fP]
24 .PP
25 Minimum unique abbreviation of option is acceptable. You may use double
26 hyphens instead of single hyphen to denote options. You may use white
27 space in place of the equals sign to separate an option name from its value.
28
29
30 .UN description
31 .SH DESCRIPTION
32 .PP
33 This program is part of
34 .BR "Netpbm" (1)\c
35 \&.
36 .PP
37 \fBppmtoicr\fP reads a PPM file as input. Produces an NCSA Telnet
38 Interactive Color Raster graphic file as output.
39
40 If \fIppmfile\fP is not supplied, \fBppmtoicr\fP reads from Standard
41 Input.
42 .PP
43 Interactive Color Raster (ICR) is a protocol for displaying raster
44 graphics on workstation screens. The protocol is implemented in NCSA
45 Telnet for the Macintosh version 2.3. The ICR protocol shares
46 characteristics of the Tektronix graphics terminal emulation protocol.
47 For example, escape sequences are used to control the display.
48 .PP
49 \fBppmtoicr\fP will output the appropriate sequences to create a
50 window of the dimensions of the input image, create a colormap of up
51 to 256 colors on the display, then load the picture data into the
52 window.
53 .PP
54 Note that there is no icrtoppm tool - this transformation is one
55 way.
56
57 .UN options
58 .SH OPTIONS
59 .PP
60 In addition to the options common to all programs based on libnetpbm
61 (most notably \fB-quiet\fP, see
62 .UR index.html#commonoptions
63 Common Options
64 .UE
65 \&), \fBppmtoicr\fP recognizes the following
66 command line options:
67
68
69 .TP
70 \fB-windowname\fP \fIname\fP
71 Output will be displayed in \fIname\fP.
72 .sp
73 \fIname\fP must be printable characters, and not '^'.
74 .sp
75 Default is to use the input file name if specified on the command line or
76 "untitled" if the input is from Standard Input. In the former case, any
77 unprintable character or '^' in the file name becomes a
78 '.' in the window name.
79
80 .TP
81 \fB-expand\fP \fIexpand\fP
82 Output will be expanded on display by factor \fIexpand\fP (For
83 example, a value of 2 will cause four pixels to be displayed for every
84 input pixel.)
85
86 .TP
87 \fB-display\fP \fIdisplay\fP
88 Output will be displayed on screen numbered \fIdisplay\fP
89
90
91
92 .UN examples
93 .SH EXAMPLES
94
95 To display a PPM file named \fBppmfile\fP using the protocol:
96
97 .nf
98 ppmtoicr ppmfile
99
100 .fi
101
102 This will create a window named \fIppmfile\fP on the display with the
103 correct dimensions for \fIppmfile\fP, create and download a colormap
104 of up to 256 colors, and download the picture into the window. You
105 may achieve the same effect with the following sequence:
106
107 .nf
108 ppmtoicr ppmfile > filename
109 cat filename
110
111 .fi
112 .PP
113 To display a GIF file using the protocol in a window titled after the
114 input file, zoom the displayed image by a factor of 2:
115
116 .nf
117 giftopnm giffile | ppmtoicr -windowname=giffile -expand=2
118
119 .fi
120
121 .UN limitations
122 .SH LIMITATIONS
123 .PP
124 The protocol uses frequent fflush() calls to speed up display. If
125 you save the output to a file for later display via \fBcat\fP,
126 \fBppmtoicr\fP will draw much more slowly. In either case,
127 increasing the blocksize limit on the display will speed up
128 transmission substantially.
129
130 .UN seealso
131 .SH SEE ALSO
132 .BR "ppm" (1)\c
133 \&
134 .PP
135 NCSA Telnet for the Macintosh, University of Illinois at
136 Urbana-Champaign (1989)
137
138 .UN history
139 .SH HISTORY
140 .PP
141 Until Netpbm 10.71 (June 2015), there was a \fB-rle\fP option documented,
142 which was said to cause the output to use run length encoding compression.
143 But because of a simple bug in option processing code, the option never had
144 any effect. And the compression code did not look like it worked anyway and
145 would take a fair amount of work to fix. Because it was unlikely anyone would
146 ever use this program again, much less want to use run length encoding, we
147 removed it from the documentation rather than fix the code.
148
149 .UN author
150 .SH AUTHOR
151
152 Copyright (C) 1990 by Kanthan Pillay (\[email protected]\fP),
153 Princeton University Computing and Information Technology.
154 .SH DOCUMENT SOURCE
155 This manual page was generated by the Netpbm tool 'makeman' from HTML
156 source. The master documentation is at
157 .IP
158 .B http://netpbm.sourceforge.net/doc/ppmtoicr.html
159 .PP