diff options
| author | giraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8> | 2023-11-12 18:44:24 +0000 |
|---|---|---|
| committer | giraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8> | 2023-11-12 18:44:24 +0000 |
| commit | 0d897de7695b764b2dabd18aab09776b42ee3ec3 (patch) | |
| tree | 9a47801441dd70ea29f4f8ba19629c4c73504e82 | |
| parent | 851f8a113827e42ae618423fdab09cb0a67dc4e4 (diff) | |
| download | netpbm-mirror-0d897de7695b764b2dabd18aab09776b42ee3ec3.tar.gz netpbm-mirror-0d897de7695b764b2dabd18aab09776b42ee3ec3.tar.xz netpbm-mirror-0d897de7695b764b2dabd18aab09776b42ee3ec3.zip | |
miscellaneous update
git-svn-id: http://svn.code.sf.net/p/netpbm/code/userguide@4782 9d0c8265-081b-0410-96cb-a4ca84ce46f8
| -rw-r--r-- | manweb.html | 41 | ||||
| -rw-r--r-- | pamaddnoise.html | 4 | ||||
| -rw-r--r-- | pbmtomda.html | 11 | ||||
| -rw-r--r-- | pktopbm.html | 27 | ||||
| -rw-r--r-- | pnmindex.html | 65 | ||||
| -rw-r--r-- | pnmtofiasco.html | 2 | ||||
| -rw-r--r-- | ppmpat.html | 9 |
7 files changed, 116 insertions, 43 deletions
diff --git a/manweb.html b/manweb.html index 129d3e33..2087ab17 100644 --- a/manweb.html +++ b/manweb.html @@ -239,4 +239,45 @@ Example: webdir=/usr/share/manweb browser=netscape </pre> + +<h3>How To Make HTML Documentation</h3> + +<p>Pages displayed by <b>manweb</b> don't have to have any particular + format. You can write anything you want in HTML, using any web page + generation tools or just by typing HTML in a text editor. + +<p>Readers might appreciate something roughly in the format of classic Unix + man pages (Name, Synopsis, etc.). + +<p>You can convert legacy nroff/troff man pages to passable HTML with the + program <b>mandoc</b>. You don't have to do this just to access the + information with <b>manweb</b>, because <b>manweb</b> falls back to + invoking <b>man</b> if it doesn't find HTML pages, but if you are + maintaining documentation, you might use this as a starting point for + maintaining it in HTML in the future. + +<p>Example: + + <pre> + <code> + $ mandoc -T html foo.1 >foo.html + </code> + </pre> + +<p>With a large number of pages, you could use <b>find</b> to do them all at + once and <b>parallel</b> to do them more quickly. + +<p>If you're converting a large collection of man pages, you'll have + to deal with linked header files and linked manuals (where the troff + man page refers to other pages) with something like this: + +<pre> + <code> + $ mandoc -T html -O includes='./%N.html'; -O man='%N.%S.html' ... + </code> +</pre> + +This creates similar HTML links to HTML file names, and you then make symbolic +links for those names. + </body> </html> diff --git a/pamaddnoise.html b/pamaddnoise.html index 0d1609bd..f2ca91ef 100644 --- a/pamaddnoise.html +++ b/pamaddnoise.html @@ -115,7 +115,7 @@ type option. The default noise type is <b>gaussian</b>. <dd> This is valid only with <b>-type=poisson</b>. It is the expected value -of the Poisson distribution for a sample value of mximum intensity. The +of the Poisson distribution for a sample value of maximum intensity. The expected value for other intensities is proportional; e.g. for half intensity, it is half this value. @@ -123,7 +123,7 @@ it is half this value. <dt><b>-lsigma</b> <i>value</i> -<dd>This is menaingful only for laplacian noise. +<dd>This is meaningful only for laplacian noise. <p>The default value is 10.0. diff --git a/pbmtomda.html b/pbmtomda.html index 01fbfffe..9bc89b3d 100644 --- a/pbmtomda.html +++ b/pbmtomda.html @@ -2,7 +2,7 @@ <html><head><title>Pbmtomda User Manual</title></head> <body> <h1>pbmtomda</h1> -Updated: 03 June 1999 +Updated: 15 September 2023 <br> <a href="#index">Table Of Contents</a> @@ -14,12 +14,17 @@ pbmtomda - convert a PBM image to a Microdesign .mda <b>pbmtomda</b> -[<b>-d</b>] -[<b>-i</b>] +[<b>-dscale</b>] +[<b>-invert</b>] [<b>--</b>] [<i>pbmfile</i>] +<p>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. + <h2 id="description">DESCRIPTION</h2> <p>This program is part of <a href="index.html">Netpbm</a>. diff --git a/pktopbm.html b/pktopbm.html index 961fb5fd..6d40b284 100644 --- a/pktopbm.html +++ b/pktopbm.html @@ -2,7 +2,7 @@ <html><head><title>Pktopbm User Manual</title></head> <body> <h1>pktopbm</h1> -Updated: 06 August 1990 +Updated: 15 September 2023 <br> <a href="#index">Table Of Contents</a> @@ -12,7 +12,7 @@ pktopbm - convert packed (PK) format font into PBM <h2 id="synopsis">SYNOPSIS</h2> -pktopbm pkfile[.pk] [ -x width ] [ -y height ] [-c num] pbmfile ... +pktopbm pkfile [ -x width ] [ -y height ] [-c num] pbmfile ... <h2 id="description">DESCRIPTION</h2> @@ -36,20 +36,32 @@ Common Options</a>), <b>pktopbm</b> recognizes the following command line options: <dl compact> -<dt><b>-c</b> <i>num</i> -<dd> -Sets the character number of the next bitmap written to <i>num</i>. +<dt><b>-character</b> <i>num</i> + <dd> + This is the code point (character number) to which the first + specified output file pertains. Ergo, there is no output for any + code point lower than this. <dt><b>-x</b> <i>width</i> <dd> -Sets the width of the image in columns. + The width of the image in columns. + + The default is what is specified in the font file. <dt><b>-y</b> <i>width</i> <dd> -Sets the height of the image in rows. +The height of the image in rows. +The default is what is specified in the font file. </dl> +<h2 id="history">HISTORY</h2> + +<p>Before Netpbm 11.04 (September 2023), the program would sometimes add + the suffix ".pk" to the specified input file name. It also + let you specify multiple <b>-c</b> options, with each applying to the + output file names that came after it. + <h2 id="seealso">SEE ALSO</h2> <a href="pbmtopk.html">pbmtopk</a>, @@ -68,6 +80,7 @@ in March 1995. <li><a href="#synopsis">SYNOPSIS</a> <li><a href="#description">DESCRIPTION</a> <li><a href="#options">OPTIONS</a> +<li><a href="#history">HISTORY</a> <li><a href="#seealso">SEE ALSO</a> <li><a href="#author">AUTHOR</a> </ul> diff --git a/pnmindex.html b/pnmindex.html index cbf629cd..785fadbc 100644 --- a/pnmindex.html +++ b/pnmindex.html @@ -2,7 +2,7 @@ <html><head><title>Pnmindex User Manual</title></head> <body> <h1>pnmindex</h1> -Updated: 14 November 2015 +Updated: 08 November 2023 <br> <a href="#index">Table Of Contents</a> @@ -17,14 +17,14 @@ pnmindex - build a visual index of a bunch of PNM images [<b>-across=</b><i>N</i>] -[<b>-colors=</b><i>N</i>] - [<b>-black</b>] [<b>-title=</b><i>title</i>] [<b>-quant</b>|<b>-noquant</b>] +[<b>-colors=</b><i>N</i>] + <i>pnmfile</i> ... <p>You can use the minimum unique abbreviation of the options. You can use @@ -36,8 +36,8 @@ with white space instead of an equals sign. <p>This program is part of <a href="index.html">Netpbm</a>. -<b>pnmindex</b> creates an index image containing thumbnail (small) -versions of a bunch of PNM files you supply. (Akin to a photographic +<p><b>pnmindex</b> creates an index image containing thumbnail (small) +versions of a bunch of PNM files you supply (akin to a photographic "contact sheet"). <p><b>pnmindex</b> labels each thumbnail and, optionally, contains a @@ -64,44 +64,55 @@ command line options: <dl compact> <dt><b>-size=</b><i>N</i> -<dd>The size of each thumbnail. The image is scaled to fit maximally -inside a <i>N</i> x <i>N</i> pixel box without changing its aspect -ratio. Default is 100. +<dd>The size of each thumbnail. The image is scaled down to fit maximally +inside a <i>N</i> x <i>N</i> pixel box without changing its aspect ratio. + +<p>If the input image is already smaller than this, its size remains the same +in the output. + +<p>The default is 100. <dt><b>-across=</b><i>N</i> <dd>The number of thumbnails in each row. Default is 6. -<dt><b>-colors=</b><i>N</i> - -<dd>The maximum number of colors allowed in the overall image. If it -would otherwise have more colors than these, <b>pnmindex</b> quantizes -the result. The default is 256. - -<p>However, this value is meaningless if you specify the -<b>-noquant</b> option. - <dt><b>-black</b> -<dd>This controls the color of the padding between the images; -normally it's white and the labels are black lettering on white -background, but the <b>-black</b> option reverses this. +<dd>This controls the color of the padding between the images; by default it +is white and the labels are black lettering on white background, but the +<b>-black</b> option reverses this. <dt><b>-title=</b><i>title</i> <dd> -Specifies a title top place at the top of the image. -Default is no title. +This specifies a title top place at the top of the image. + +<p>Default is no title. + +<dt><b>-noquant</b> + +<dd>Disables color quantization. By default, if any input image is PPM, the +program reduces the number of colors to the number of colors specified +by <b>-colors</b>). <dt><b>-quant</b> -<dd>Enables quantization (to the number of colors specified by -<b>-colors</b>). Quantization is on by default but you can disable -it with <b>-noquant.</b> +<dd>This option has no effect; it explicitly selects the default behavior of +quantizing colors. See <b>-noquant</b>. -<dt><b>-noquant</b> +<dt><b>-colors=</b><i>N</i> + +<dd>The maximum number of colors allowed in the overall image. If it would +otherwise have more colors than these, <b>pnmindex</b> quantizes the result. +To reduce the effect of the colors in one thumbnail on the colors used for +another, the program quantizes colors to this number in each thumbnail +independently, then quantizes the colors in each row of thumbnails to this +number, then quantizes the colors in the entire output image to this number. + +<p>This value is meaningless if you specify the <b>-noquant</b> option or if +no input image is PPM. -<dd>See <b>-quant</b>. +<p>The default is 256. </dl> diff --git a/pnmtofiasco.html b/pnmtofiasco.html index 7caf4637..722bb20c 100644 --- a/pnmtofiasco.html +++ b/pnmtofiasco.html @@ -40,7 +40,7 @@ options are case sensitive. <h3 id="basicopts">Basic Options</h3> <dl compact> -<dt><b>-i</b> <i>name</i>, <b>--input-name=</b><i>name</i> +<dt><b>-i</b> <i>name</i>, <b>--image-name=</b><i>name</i> <dd>Compress the named images, not Standard Input. If <i>name</i> is <b>-</b>, read Standard Input. <i>name</i> has to be either an image diff --git a/ppmpat.html b/ppmpat.html index 3c395e0a..05ddb31a 100644 --- a/ppmpat.html +++ b/ppmpat.html @@ -2,7 +2,7 @@ <html><head><title>Ppmpat User Manual</title></head> <body> <h1>ppmpat</h1> -Updated: 02 March 2016 +Updated: 12 November 2023 <br> <a href="#index">Table Of Contents</a> @@ -90,8 +90,11 @@ in that order. <dt><b>-poles</b> -<dd>Color gradients centered on randomly-placed poles. - +<dd>Color gradients centered on randomly-placed poles: a Voronoi diagram. + +<p>(There are many examples of this pattern in nature. One is the hide of a +giraffe). + <p>If you specify -color, give two or more colors. <dt><b>-squig</b> |