| 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 "Ppmtosixel User Manual" 1 "1 August 2023" "netpbm documentation" |
| 7 |
|
| 8 |
.SH NAME |
| 9 |
|
| 10 |
ppmtosixel - convert a PPM image to DEC sixel format |
| 11 |
|
| 12 |
.UN synopsis |
| 13 |
.SH SYNOPSIS |
| 14 |
|
| 15 |
\fBppmtosixel\fP |
| 16 |
|
| 17 |
[\fB-raw\fP] |
| 18 |
|
| 19 |
[\fB-margin\fP] |
| 20 |
|
| 21 |
[\fB-7bit\fP] |
| 22 |
|
| 23 |
[\fIppmfile\fP] |
| 24 |
|
| 25 |
.UN description |
| 26 |
.SH DESCRIPTION |
| 27 |
.PP |
| 28 |
This program is part of |
| 29 |
.BR "Netpbm" (1)\c |
| 30 |
\&. |
| 31 |
.PP |
| 32 |
\fBppmtosixel\fP reads a PPM image as input and produces sixel |
| 33 |
commands (SIX) as output. The output is formatted for color printing |
| 34 |
(e.g. for a DEC LJ250 color inkjet printer) or for color display on |
| 35 |
DEC VT terminals and terminal emulators (VT240 and beyond). |
| 36 |
.PP |
| 37 |
If RGB values from the PPM file do not have maxval=100, |
| 38 |
\fBppmtosixel\fP rescales them to maxval 100. A printer control |
| 39 |
header and a color assignment table begin the SIX file. Image data is |
| 40 |
in a compressed format by default. A printer control footer ends the |
| 41 |
image file. |
| 42 |
|
| 43 |
.UN options |
| 44 |
.SH OPTIONS |
| 45 |
.PP |
| 46 |
In addition to the options common to all programs based on libnetpbm |
| 47 |
(most notably \fB-quiet\fP, see |
| 48 |
.UR index.html#commonoptions |
| 49 |
Common Options |
| 50 |
.UE |
| 51 |
\&), \fBppmtosixel\fP recognizes the following |
| 52 |
command line options: |
| 53 |
|
| 54 |
|
| 55 |
.TP |
| 56 |
\fB-raw\fP |
| 57 |
If you specify this, each pixel will be explicitly described in |
| 58 |
the image file. If \fB-raw\fP is not specified, output will default |
| 59 |
to compressed format in which identical adjacent pixels are replaced |
| 60 |
by "repeat pixel" commands. A raw file is often an order of |
| 61 |
magnitude larger than a compressed file and prints much slower. |
| 62 |
|
| 63 |
.TP |
| 64 |
\fB-margin\fP |
| 65 |
If you don't specify \fB-margin\fP, the image will start at the |
| 66 |
left margin (of the window, paper, or whatever). If you do |
| 67 |
specify \fB-margin\fP, a 1.5 inch left margin will offset the image. |
| 68 |
|
| 69 |
.TP |
| 70 |
\fB-7bit\fP |
| 71 |
If you don't specify \fB-7bit\fP, each control code will be |
| 72 |
expressed as a single, 8-bit "C1" character. If you do |
| 73 |
specify \fB-7bit\fP, each control code will be expressed using two, |
| 74 |
7-bit "C0" characters. |
| 75 |
(See |
| 76 |
.UR https://en.wikipedia.org/wiki/C0_and_C1_control_codes |
| 77 |
C0 and C1 control codes |
| 78 |
.UE |
| 79 |
\& for more information.) In other |
| 80 |
words, \fB-7bit\fP produces more portable sixel files, and its |
| 81 |
absence produces smaller sixel files. |
| 82 |
.sp |
| 83 |
This option was new in Netpbm 11.04 (September 2023). |
| 84 |
|
| 85 |
|
| 86 |
|
| 87 |
.UN printing |
| 88 |
.SH PRINTING |
| 89 |
.PP |
| 90 |
Generally, sixel files must reach the printer unfiltered. |
| 91 |
Use the lpr -x option or \fBcat filename > /dev/tty0?\fP. |
| 92 |
|
| 93 |
.UN limitations |
| 94 |
.SH LIMITATIONS |
| 95 |
|
| 96 |
Upon rescaling, truncation of the least significant bits of RGB values |
| 97 |
may result in poor color conversion. If the original PPM maxval was |
| 98 |
greater than 100, rescaling also reduces the image depth. While the |
| 99 |
actual RGB values from the ppm file are more or less retained, the |
| 100 |
color palette of the LJ250 may not match the colors on your screen. |
| 101 |
This seems to be a printer limitation. |
| 102 |
|
| 103 |
.UN seealso |
| 104 |
.SH SEE ALSO |
| 105 |
.BR "ppm" (1)\c |
| 106 |
\& |
| 107 |
|
| 108 |
.UN author |
| 109 |
.SH AUTHOR |
| 110 |
|
| 111 |
Copyright (C) 1991 by Rick Vinci. |
| 112 |
.SH DOCUMENT SOURCE |
| 113 |
This manual page was generated by the Netpbm tool 'makeman' from HTML |
| 114 |
source. The master documentation is at |
| 115 |
.IP |
| 116 |
.B http://netpbm.sourceforge.net/doc/ppmtosixel.html |
| 117 |
.PP |