summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man1/ppmtosixel.1
blob: ef405350a569ad796167efcbbdfa2f613f0e3578 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
\
.\" 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 "Ppmtosixel User Manual" 0 "1 August 2023" "netpbm documentation"

.SH NAME

ppmtosixel - convert a PPM image to DEC sixel format

.UN synopsis
.SH SYNOPSIS

\fBppmtosixel\fP

[\fB-raw\fP]

[\fB-margin\fP]

[\fB-7bit\fP]

[\fIppmfile\fP]

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBppmtosixel\fP reads a PPM image as input and produces sixel
commands (SIX) as output.  The output is formatted for color printing
(e.g. for a DEC LJ250 color inkjet printer) or for color display on
DEC VT terminals and terminal emulators (VT240 and beyond).
.PP
If RGB values from the PPM file do not have maxval=100,
\fBppmtosixel\fP rescales them to maxval 100.  A printer control
header and a color assignment table begin the SIX file.  Image data is
in a compressed format by default.  A printer control footer ends the
image file.

.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
\&), \fBppmtosixel\fP recognizes the following
command line options:


.TP
\fB-raw\fP
If you specify this, each pixel will be explicitly described in
the image file.  If \fB-raw\fP is not specified, output will default
to compressed format in which identical adjacent pixels are replaced
by "repeat pixel" commands.  A raw file is often an order of
magnitude larger than a compressed file and prints much slower.

.TP
\fB-margin\fP
If you don't specify \fB-margin\fP, the image will start at the
left margin (of the window, paper, or whatever).  If you do
specify \fB-margin\fP, a 1.5 inch left margin will offset the image.

.TP
\fB-7bit\fP
If you don't specify \fB-7bit\fP, each control code will be
expressed as a single, 8-bit "C1" character.  If you do
specify \fB-7bit\fP, each control code will be expressed using two,
7-bit "C0" characters.
(See 
.UR https://en.wikipedia.org/wiki/C0_and_C1_control_codes
C0 and C1 control codes
.UE
\& for more information.)  In other
words, \fB-7bit\fP produces more portable sixel files, and its
absence produces smaller sixel files.
.sp
This option was new in Netpbm 11.04 (September 2023).
  


.UN printing
.SH PRINTING
.PP
Generally, sixel files must reach the printer unfiltered.
Use the lpr -x option or \fBcat filename > /dev/tty0?\fP.

.UN limitations
.SH LIMITATIONS

Upon rescaling, truncation of the least significant bits of RGB values
may result in poor color conversion.  If the original PPM maxval was
greater than 100, rescaling also reduces the image depth.  While the
actual RGB values from the ppm file are more or less retained, the
color palette of the LJ250 may not match the colors on your screen.
This seems to be a printer limitation.

.UN seealso
.SH SEE ALSO
.BR "ppm" (5)\c
\&

.UN author
.SH AUTHOR

Copyright (C) 1991 by Rick Vinci.
.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/ppmtosixel.html
.PP