summary refs log tree commit diff
path: root/rletopnm.html
diff options
context:
space:
mode:
authorgiraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8>2006-12-25 03:06:05 +0000
committergiraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8>2006-12-25 03:06:05 +0000
commit1017cbebe5d5edd859e0fddad0a8600f509f4821 (patch)
tree78bdf336648566f7a7d55f42837357dea3dd674c /rletopnm.html
parent16f2ac126651015a376eba864a3a35f738b0b25a (diff)
downloadnetpbm-mirror-1017cbebe5d5edd859e0fddad0a8600f509f4821.tar.gz
netpbm-mirror-1017cbebe5d5edd859e0fddad0a8600f509f4821.tar.xz
netpbm-mirror-1017cbebe5d5edd859e0fddad0a8600f509f4821.zip
Place user guide into Subversion repository
git-svn-id: http://svn.code.sf.net/p/netpbm/code/userguide@181 9d0c8265-081b-0410-96cb-a4ca84ce46f8
Diffstat (limited to 'rletopnm.html')
-rw-r--r--rletopnm.html147
1 files changed, 147 insertions, 0 deletions
diff --git a/rletopnm.html b/rletopnm.html
new file mode 100644
index 00000000..f1520cf7
--- /dev/null
+++ b/rletopnm.html
@@ -0,0 +1,147 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<HTML><HEAD><TITLE>Rletopnm User Manual</TITLE></HEAD>
+<BODY>
+<H1>RLETOPNM</H1>
+Updated: 13 April 2000
+<BR>
+<A HREF="#index">Table Of Contents</A>
+<H2>NAME</H2>
+
+rletopnm - convert a Utah Raster Tools RLE image file to a PNM image file.
+
+<H2 id="synopsis">SYNOPSIS</H2>
+
+<B>rletopnm</B>
+
+[<B>--alphaout=</B>{<I>alpha-filename</I>,<B>-</B>}]
+[<B>--headerdump</B>|<B>-h</B>]
+
+[<B>--verbose</B>|<B>-v</B>]
+
+[<I>rlefile</I>|<B>-</B>]
+
+<P>All options may be abbreviated to their minimum unique abbreviation
+and options and arguments may be in any order.
+
+<H2 id="description">DESCRIPTION</H2>
+
+<p>This program is part of <a href="index.html">Netpbm</a>.
+
+<p><b>rletopnm</b> converts Utah Raster Toolkit RLE image files to PNM
+image files.  <B>rletopnm</B> handles four types of RLE files:
+Grayscale (8 bit data, no color map), Pseudocolor (8 bit data with a
+color map), Truecolor (24 bit data with color map), and Directcolor
+(24 bit data, no color map).  <B>rletopnm</B> generates a PPM file for
+all these cases except for the Grayscale file, for which
+<B>rletopnm</B> generates a PGM file.
+
+<P><I>rlefile</I> is the RLE input file.  If it is absent or <B>-</B>,
+the input comes from Standard Input.
+
+<H2 id="options">OPTIONS</H2>
+
+<DL COMPACT>
+<DT><B>--alphaout=</B><I>alpha-filename</I>
+
+<DD>
+<B>rletopnm </B> creates a PGM (portable graymap) file containing the
+alpha channel values in the input image.  If the input image doesn't
+contain an alpha channel, the <I>alpha-filename</I> file contains all
+zero (transparent) alpha values.  If you don't specify
+<B>--alphaout</B>, <B>rletopnm</B> does not generate an alpha file,
+and if the input image has an alpha channel, <B>rletopnm</B> simply
+discards it.
+
+<P>If you specify <B>-</B> as the filename, <B>rletopnm</B> writes the
+alpha output to Standard Output and discards the image.
+
+<P>See <B><A HREF="pamcomp.html">pamcomp</A></B> for one way to use
+the alpha output file.
+
+<DT><B>--verbose</B>
+
+<DD>This option causes <B>rletopnm </B> to operate in verbose mode.
+It prints messages about what it's doing, including the contents of
+the RLE image header, to Standard Error.
+
+<DT><B>--headerdump</B>
+
+<DD>This option causes <B>rletopnm</B> to operate in header dump mode.
+It prints the contents of the RLE image header to Standard Error, but
+does not produce any other output.
+
+</DL>
+
+<H2 id="examples">EXAMPLES</H2>
+
+<ul>
+<li>While running in verbose mode, convert lenna.rle to PPM format and
+store the resulting image as lenna.ppm:
+
+<pre>
+<kbd>
+    rletopnm --verbose lenna.rle &gt;lenna.ppm
+</kbd>
+</pre>
+
+<li>Dump the header information of the RLE file called file.rle:
+
+<pre>
+<kbd>
+    rletopnm --headerdump file.rle
+</kbd>
+</pre>
+
+<li>Convert RLE file dart.rle to PPM format as dart.ppm.  Store the
+alpha channel of dart.rle as dartalpha.pgm (if dart.rle doesn't have
+an alpha channel, store a fully transparent alpha mask as
+dartalpha.pgm):
+
+<pre>
+<kbd>
+    rletopnm --alphaout=dartalpha.pgm dart.rle &gt;dart.ppm
+</kbd>
+</pre>
+
+</ul>
+
+<H2 id="seealso">SEE ALSO</H2>
+
+<B><A HREF="pnmtorle.html">pnmtorle</A></B>,
+
+<B><A HREF="pnmconvol.html">pnmconvol</A></B>,
+
+<B><A HREF="pnm.html">pnm</A></B>,
+
+<B><A HREF="ppm.html">ppm</A></B>,
+
+<B><A HREF="pgm.html">pgm</A></B>,
+
+<H2 id="author">AUTHOR</H2>
+
+Wes Barris
+<BR>
+
+Army High Performance Computing Research Center (AHPCRC)
+<BR>
+
+Minnesota Supercomputer Center, Inc.
+
+<P>Modifications by Eric Haines to support raw and plain formats.
+
+<P>Modifications by Bryan Henderson to create alpha files and use
+mnemonic options.
+
+<HR>
+<A NAME="index">&nbsp;</A>
+<H2>Table Of Contents</H2>
+<UL>
+<LI><A HREF="#synopsis">SYNOPSIS</A>
+<LI><A HREF="#description">DESCRIPTION</A>
+<LI><A HREF="#options">OPTIONS</A>
+<LI><A HREF="#examples">EXAMPLES</A>
+<LI><A HREF="#seealso">SEE ALSO</A>
+<LI><A HREF="#author">AUTHOR</A>
+</UL>
+</BODY>
+</HTML>