From 61c296305814a003d4e2fad1bf8b165357eb4c79 Mon Sep 17 00:00:00 2001 From: giraffedata Date: Mon, 7 Mar 2022 02:35:02 +0000 Subject: miscellaneous update git-svn-id: http://svn.code.sf.net/p/netpbm/code/userguide@4296 9d0c8265-081b-0410-96cb-a4ca84ce46f8 --- pnmtorle.html | 82 +++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 46 insertions(+), 36 deletions(-) diff --git a/pnmtorle.html b/pnmtorle.html index f488edb9..82491eb6 100644 --- a/pnmtorle.html +++ b/pnmtorle.html @@ -3,7 +3,7 @@

pnmtorle

-Updated: 31 March 1994 +Updated: 07 March 2022
Table Of Contents @@ -15,12 +15,18 @@ pnmtorle - convert a Netpbm image file into an RLE image file. pnmtorle -[-h] -[-v] -[-a] -[-o outfile] +[-header] +[-verbose] +[-alpha] +[-outfile=outfile] [pnmfile] +

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. + +

DESCRIPTION

This program is part of Netpbm. @@ -29,67 +35,71 @@ pnmtorle - convert a Netpbm image file into an RLE image file. You can include a transparency mask. If the input is a multiple image file, the output consists of several concatenated RLE images. -

The RLE file will contain either a three channel color image (24 -bits) or a single channel grayscale image (8 bits) depending upon the -pnm file depth. If a converted ppm is displayed on an 8 bit display, -the image must be dithered. In order to produce a better looking -image (on 8 bit displays), it is recommended that the image be -quantizing (to 8 bit mapped color) prior to its display. This may be -done by piping the output of this program into the Utah mcut or -rlequant utilities. We show an example of this later. +

pnmfile is the name of the Netpbm image input file. If you don't +specify this argument, input is from Standard Input. + +

The RLE file will contain either a three channel color image (24 bits) or a +single channel grayscale image (8 bits) depending upon the type of Netpbm +input. If the Netpbm input is color, the RLE output is 3 channel 24 bit +color. If the Netpbm input is grayscale or black and white, the RLE output is +single channel grayscale. +

OPTIONS

In addition to the options common to all programs based on libnetpbm -(most notably -quiet, see -Common Options), pnmtorle recognizes the following -command line options: +

In addition to the options common to all programs based on libnetpbm (most +notably -quiet, see Common +Options), pnmtorle recognizes the following command line options:

-v - +
-verbose: -This option will cause pnmtorle to operate in verbose mode. The header -information is written to "stderr". Actually, there is not much header -information stored in a Netpbm file, so this information is minimal. -
-h + This option will cause pnmtorle to operate in verbose mode. The + program writes header information to Standard Error. Actually, there is not + much header information stored in a Netpbm file, so this information is + minimal. + +
Before Netpbm 10.98 (March 2022), this option is just -v. + +
-header: -This option allows the header of the Netpbm image to be dumped to "stderr" -without converting the file. It is equivalent to using the -v option except -that no file conversion takes place. -
-a +This option causes the program to dump the header of the Netpbm image to be +Standard Error without converting the file. It is equivalent to using +the -verbose option except that no file conversion takes place. + +
Before Netpbm 10.98 (March 2022), this option is just -h. + +
-alpha: -This option causes pnmtorle to include an transparency channel in the +This option causes pnmtorle to include a transparency channel in the output image. The transparency channel is based on the image: Wherever a pixel is black, the corresponding trasparency value is transparent. Everywhere else, the transparency value is fully opaque. -
-o outfile +
-outfile outfile: If you specify this option, pnmtorle writes the output to this file. If outfile is - or you don't specify --o, pnmtorle writes the output to Standard Output. +-outfile, pnmtorle writes the output to Standard Output. -
pnmfile + Before Netpbm 10.98 (March 2022), this option is just -o.and + must be separated from its value by a space, not an equal sign. -: -The name of the Netpbm image data file to be converted. If not specified, -standard input is assumed.

EXAMPLES

-   pnmtorle -v file.ppm -o file.rle
+   pnmtorle -verbose file.ppm -outfile=file.rle

While running in verbose mode, convert file.ppm to RLE format and store resulting data in file.rle.

-   pnmtorle -h file.pgm
+   pnmtorle -header file.pgm

Dump the header information of the Netpbm file called file.pgm. -- cgit 1.4.1