diff options
author | giraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8> | 2020-07-11 03:14:39 +0000 |
---|---|---|
committer | giraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8> | 2020-07-11 03:14:39 +0000 |
commit | a87703a515ec08a0637c2b3b3e6cd0ef1a7e78ff (patch) | |
tree | 0e462a89e51e65b0d293104f437aa371d8e56ee1 /ppmtoarbtxt.html | |
parent | e4dbb262ce92440414dad7735f9b9264e47cffa0 (diff) | |
download | netpbm-mirror-a87703a515ec08a0637c2b3b3e6cd0ef1a7e78ff.tar.gz netpbm-mirror-a87703a515ec08a0637c2b3b3e6cd0ef1a7e78ff.tar.xz netpbm-mirror-a87703a515ec08a0637c2b3b3e6cd0ef1a7e78ff.zip |
cleanup
git-svn-id: http://svn.code.sf.net/p/netpbm/code/userguide@3893 9d0c8265-081b-0410-96cb-a4ca84ce46f8
Diffstat (limited to 'ppmtoarbtxt.html')
-rw-r--r-- | ppmtoarbtxt.html | 170 |
1 files changed, 87 insertions, 83 deletions
diff --git a/ppmtoarbtxt.html b/ppmtoarbtxt.html index 5bc55b37..fef1cb18 100644 --- a/ppmtoarbtxt.html +++ b/ppmtoarbtxt.html @@ -1,24 +1,23 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> -<HTML><HEAD><TITLE>Ppmtoarbtxt User Manual</TITLE></HEAD> -<BODY> -<H1>ppmtoarbtxt</H1> -<BR> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.3//EN"> +<html><head><title>Ppmtoarbtxt User Manual</title></head> +<body> +<h1>ppmtoarbtxt</h1> Updated: 26 November 2014 -<BR> -<A HREF="#index">Table Of Contents</A> +<br> +<a href="#index">Table Of Contents</a> -<H2>NAME</H2> +<h2>NAME</h2> ppmtoarbtxt - generate image in arbitrary text format from PPM image -<H2 id="synopsis">SYNOPSIS</H2> +<h2 id="synopsis">SYNOPSIS</h2> -<B>ppmtoarbtxt</B> -<I>bodytmpl</I> -[<B>-hd</B> <I>headtmpl</I>] -[<B>-tl</B> <I>tailtmpl</I>] -[<I>ppmfile</I>] +<b>ppmtoarbtxt</b> +<i>bodytmpl</i> +[<b>-hd</b> <i>headtmpl</i>] +[<b>-tl</b> <i>tailtmpl</i>] +[<i>ppmfile</i>] -<H2 id="description">DESCRIPTION</H2> +<h2 id="description">DESCRIPTION</h2> <p>This program is part of <a href="index.html">Netpbm</a>. @@ -29,7 +28,7 @@ PNM raw format). <b>ppmtoarbtxt</b> reads a PPM image as input. For each pixel in the image, <b>ppmtoarbtxt</b> writes the contents of the template file -<I>bodytmpl</I>, with certain substitutions based on the value of the +<i>bodytmpl</i>, with certain substitutions based on the value of the pixel, to Standard Output. <p>You may also supply a head template file, in which case <b>ppmtoarbtxt</b> @@ -47,7 +46,7 @@ literal text of the template file, except with substitution specifier replaced with something else. The program recognizes a substitution specifier as text of the form <b>#(</b>...<b>)</b>. -<P><b>ppmtoarbtxt</b> treats white space in the template files the same as any +<p><b>ppmtoarbtxt</b> treats white space in the template files the same as any other characters, placing it in the output, with one exception: If the template file ends with a newline character, <b>ppmtoarbtxt</b> ignores it -- it does not include it in the output. @@ -69,13 +68,13 @@ and fails. <p>Useful in a body template, to do substitutions based on a particular pixel: -<DL COMPACT> -<DT><B>#(ired</B><I> format blackref whiteref</I><B>)</B> +<dl compact> +<dt><b>#(ired</b><i> format blackref whiteref</i><b>)</b> -<DD>generates an integer in the range <I>blackref</I> to -<I>whiteref</I> in a format specified by <I>format</I> representing the red -intensity of the pixel. A red intensity of 0 becomes <I>blackref</I>; a red -intensity of maxval becomes <I>whiteref</I>, with the rest linearly +<dd>generates an integer in the range <i>blackref</i> to +<i>whiteref</i> in a format specified by <i>format</i> representing the red +intensity of the pixel. A red intensity of 0 becomes <i>blackref</i>; a red +intensity of maxval becomes <i>whiteref</i>, with the rest linearly interpolated in between. <p><i>format</i> is a printf-like format specifier like "%d". @@ -86,47 +85,47 @@ makes sense; there are values you could specify that could even crash the program. To avoid unexpected behavior, keep format strings simple and hardcoded, and never include a per cent sign or newline. -<p><B>#(ired)</B> is equivalent to <B>#(ired %d 0 255)</B>. +<p><b>#(ired)</b> is equivalent to <b>#(ired %d 0 255)</b>. -<DT><B>#(igreen</B><I> format blackref whiteref</I><B>)</B> +<dt><b>#(igreen</b><i> format blackref whiteref</i><b>)</b> -<DD>Same as <B>#(ired...</B>, but for green. +<dd>Same as <b>#(ired...</b>, but for green. -<DT><B>#(iblue</B><I> format blackref whiteref</I><B>)</B> +<dt><b>#(iblue</b><i> format blackref whiteref</i><b>)</b> -<DD>Same as <B>#(ired...</B>, but for blue. +<dd>Same as <b>#(ired...</b>, but for blue. -<DT><B>#(ilum</B><I> format blackref whiteref</I><B>)</B> +<dt><b>#(ilum</b><i> format blackref whiteref</i><b>)</b> -<DD>Same as <B>#(ired...</B>, but representing the luminance value +<dd>Same as <b>#(ired...</b>, but representing the luminance value (0.299*red + 0.587*green + 0.114*blue) of the pixel. -<DT><B>#(fred</B><I> format blackref whiteref</I><B>)</B> +<dt><b>#(fred</b><i> format blackref whiteref</i><b>)</b> -<DD>Same as <B>#(ired...</B>, but generates a floating point number instead +<dd>Same as <b>#(ired...</b>, but generates a floating point number instead of an integer. <p>In this case, the second argument to the <b>fprintf</b> that uses <i>format</i> has a double precision floating point data type. -<p><B>#(fred)</B> is equivalent to <B>#(fred %f 0.0 1.0)</B>. +<p><b>#(fred)</b> is equivalent to <b>#(fred %f 0.0 1.0)</b>. -<DT><B>#(fgreen </B><I>format blackref whiteref</I><B>)</B> +<dt><b>#(fgreen </b><i>format blackref whiteref</i><b>)</b> -<DD>Same as <B>#(fred...</B>, but for green. +<dd>Same as <b>#(fred...</b>, but for green. -<DT><B>#(fblue </B><I>format blackref whiteref</I><B>)</B> +<dt><b>#(fblue </b><i>format blackref whiteref</i><b>)</b> -<DD>Same as <B>#(fred...</B>, but for blue. +<dd>Same as <b>#(fred...</b>, but for blue. -<DT><B>#(flum </B><I>format blackref whiteref</I><B>)</B> +<dt><b>#(flum </b><i>format blackref whiteref</i><b>)</b> -<DD>Same as <B>#(fred...</B>, but representing the luminance value +<dd>Same as <b>#(fred...</b>, but representing the luminance value (0.299*red + 0.587*green + 0.114*blue) of the pixel. -<DT><B>#(posx </B><i>format</i><b>)</b> +<dt><b>#(posx </b><i>format</i><b>)</b> -<DD>Generates the horizontal position of the pixel, in pixels from the left +<dd>Generates the horizontal position of the pixel, in pixels from the left edge of the image. <p>The second argument to the <b>fprintf</b> that uses <i>format</i> has an @@ -134,11 +133,11 @@ unsigned integer data type. <p><i>format</i> defaults to <b>%u</b> -<DT><B>#(posy </B><i>format</i><b>)</b> +<dt><b>#(posy </b><i>format</i><b>)</b> -<DD>Same as <b>#(width...</b>, but for the vertical position. +<dd>Same as <b>#(width...</b>, but for the vertical position. -</DL> +</dl> <p>If you use any of the above substitution specifiers in a head or tail template, the result is undefined. @@ -146,43 +145,48 @@ template, the result is undefined. <p>Useful in a head or tail template, to do substitutions based on whole-image attributes: -<DL COMPACT> -<DT><B>#(width </B><i>format</i><b>)</b> +<dl compact> +<dt><b>#(width </b><i>format</i><b>)</b> -<DD>Generates the width in pixels of the image. +<dd>Generates the width in pixels of the image. <p>The second argument to the <b>fprintf</b> that uses <i>format</i> has an unsigned integer data type. <p><i>format</i> defaults to <b>%u</b> -<DT><B>#(height </B><i>format</i><b>)</b> +<dt><b>#(height </b><i>format</i><b>)</b> -<DD>Same as <b>#(width...</b>, but for the height of the image. +<dd>Same as <b>#(width...</b>, but for the height of the image. </dl> -<H2 id="options">OPTIONS</H2> +<h2 id="options">OPTIONS</h2> + +<p>In addition to the options common to all programs based on libnetpbm +(most notably <b>-quiet</b>, see <a href="index.html#commonoptions"> +Common Options</a>), <b>ppmtoarbtxt</b> recognizes the following +command line options: -<DL COMPACT> -<DT><B>-hd</B> <I>headtmpl</I> +<dl compact> +<dt><b>-hd</b> <i>headtmpl</i> -<DD>This option specifies a head template (<i>headtmpl</i> is the name of the +<dd>This option specifies a head template (<i>headtmpl</i> is the name of the head template file); it causes <b>ppmtoarbtxt</b> to place the contents of the -file named <I>headtmpl</I> at the beginning of the output +file named <i>headtmpl</i> at the beginning of the output -<DT><B>-tl</B> <I>tailtmpl</I> +<dt><b>-tl</b> <i>tailtmpl</i> -<DD>This option specifies a tail template; it is analogous to <b>-hd</b>. +<dd>This option specifies a tail template; it is analogous to <b>-hd</b>. -</DL> +</dl> -<H2 id="examples">EXAMPLES</H2> +<h2 id="examples">EXAMPLES</h2> -<h3>gray inversion</H3> +<h3>gray inversion</h3> -<P>Here we generate a PGM plain-format image with gray inversion +<p>Here we generate a PGM plain-format image with gray inversion (like <b>ppmtopgm | pnminvert</b>). <p>Contents of our head template file: @@ -193,7 +197,7 @@ P2 255 </pre> -<P>Contents of our body skeleton file: +<p>Contents of our body skeleton file: <pre> #(ilum %d 255 0) @@ -201,7 +205,7 @@ P2 <h3>povray file</h3> -<P>Here we generate a povray file where each pixel is represented by a +<p>Here we generate a povray file where each pixel is represented by a sphere at location (x,y,z) = (posx,height-posy,luminance). The color of the sphere is the color of the pixel. @@ -234,34 +238,34 @@ sphere { <#(posx),#(height)-#(posy),#(ilum %d 0 10)>, 0.5 } </pre> -<H2 id="seealso">SEE ALSO</H2> +<h2 id="seealso">SEE ALSO</h2> -<A href="pnmtoplainpnm.html">pnmtoplainpnm</A> -<A href="pamtable.html">pamtable</A> -<A href="ppm.html">ppm</A> +<a href="pnmtoplainpnm.html">pnmtoplainpnm</a> +<a href="pamtable.html">pamtable</a> +<a href="ppm.html">ppm</a> -<H2 id="history">HISTORY</H2> +<h2 id="history">HISTORY</h2> -<P><B>ppmtoarbtxt</b> was added to Netpbm in Release 10.14 (March 2003). +<p><b>ppmtoarbtxt</b> was added to Netpbm in Release 10.14 (March 2003). It existed under the name <b>ppmtotxt</b> since 1995. -<H2 id="author">AUTHOR</H2> +<h2 id="author">AUTHOR</h2> Copyright (C) 1995 by Peter Kirchgessner -<HR> -<H2 id="index">Table Of Contents</H2> -<UL> -<LI><A HREF="#synopsis">SYNOPSIS</A> -<LI><A HREF="#description">DESCRIPTION</A> +<hr> +<h2 id="index">Table Of Contents</h2> +<ul> +<li><a href="#synopsis">SYNOPSIS</a> +<li><a href="#description">DESCRIPTION</a> <ul> - <li><A HREF="#templatefiles">Template Files</A> + <li><a href="#templatefiles">Template Files</a> </ul> -<LI><A HREF="#options">OPTIONS</A> -<LI><A HREF="#examples">EXAMPLES</A> -<LI><A HREF="#seealso">SEE ALSO</A> -<LI><A HREF="#history">HISTORY</A> -<LI><A HREF="#author">AUTHOR</A> -</UL> -</BODY> -</HTML> +<li><a href="#options">OPTIONS</a> +<li><a href="#examples">EXAMPLES</a> +<li><a href="#seealso">SEE ALSO</a> +<li><a href="#history">HISTORY</a> +<li><a href="#author">AUTHOR</a> +</ul> +</body> +</html> |