From 0d897de7695b764b2dabd18aab09776b42ee3ec3 Mon Sep 17 00:00:00 2001 From: giraffedata Date: Sun, 12 Nov 2023 18:44:24 +0000 Subject: miscellaneous update git-svn-id: http://svn.code.sf.net/p/netpbm/code/userguide@4782 9d0c8265-081b-0410-96cb-a4ca84ce46f8 --- manweb.html | 41 +++++++++++++++++++++++++++++++++++ pamaddnoise.html | 4 ++-- pbmtomda.html | 11 +++++++--- pktopbm.html | 27 +++++++++++++++++------ pnmindex.html | 65 +++++++++++++++++++++++++++++++++----------------------- pnmtofiasco.html | 2 +- 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 + +

How To Make HTML Documentation

+ +

Pages displayed by manweb 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. + +

Readers might appreciate something roughly in the format of classic Unix + man pages (Name, Synopsis, etc.). + +

You can convert legacy nroff/troff man pages to passable HTML with the + program mandoc. You don't have to do this just to access the + information with manweb, because manweb falls back to + invoking man 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. + +

Example: + +

+    
+      $ mandoc -T html foo.1 >foo.html
+    
+

+ +

With a large number of pages, you could use find to do them all at + once and parallel to do them more quickly. + +

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

+  
+      $ mandoc -T html -O includes='./%N.html'; -O man='%N.%S.html' ...
+  
+

+ +This creates similar HTML links to HTML file names, and you then make symbolic +links for those names. + 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 gaussian.

This is valid only with -type=poisson. 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.

-lsigma value -

This is menaingful only for laplacian noise. +

This is meaningful only for laplacian noise.

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 @@ Pbmtomda User Manual

pbmtomda

-Updated: 03 June 1999 +Updated: 15 September 2023
Table Of Contents @@ -14,12 +14,17 @@ pbmtomda - convert a PBM image to a Microdesign .mda pbmtomda -[-d] -[-i] +[-dscale] +[-invert] [--] [pbmfile] +

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. diff --git a/pktopbm.html b/pktopbm.html index 961fb5fd..6d40b284 100644 --- a/pktopbm.html +++ b/pktopbm.html @@ -2,7 +2,7 @@ Pktopbm User Manual

pktopbm

-Updated: 06 August 1990 +Updated: 15 September 2023
Table Of Contents @@ -12,7 +12,7 @@ pktopbm - convert packed (PK) format font into PBM

SYNOPSIS

-pktopbm pkfile[.pk] [ -x width ] [ -y height ] [-c num] pbmfile ... +pktopbm pkfile [ -x width ] [ -y height ] [-c num] pbmfile ...

DESCRIPTION

@@ -36,20 +36,32 @@ Common Options), pktopbm recognizes the following command line options:

-c num -: -Sets the character number of the next bitmap written to num. +
-character num +: + 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.
-x width: -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.
-y width: -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.

HISTORY

+ +

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 -c options, with each applying to the + output file names that came after it. +

pnmindex

-Updated: 14 November 2015 +Updated: 08 November 2023
Table Of Contents @@ -17,14 +17,14 @@ pnmindex - build a visual index of a bunch of PNM images [-across=N] -[-colors=N] - [-black] [-title=title] [-quant|-noquant] +[-colors=N] + pnmfile ...

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.

This program is part of Netpbm. -pnmindex creates an index image containing thumbnail (small) -versions of a bunch of PNM files you supply. (Akin to a photographic +

pnmindex creates an index image containing thumbnail (small) +versions of a bunch of PNM files you supply (akin to a photographic "contact sheet").

pnmindex labels each thumbnail and, optionally, contains a @@ -64,44 +64,55 @@ command line options:

-size=N -

The size of each thumbnail. The image is scaled to fit maximally -inside a N x N pixel box without changing its aspect -ratio. Default is 100. +

The size of each thumbnail. The image is scaled down to fit maximally +inside a N x N pixel box without changing its aspect ratio. + +

If the input image is already smaller than this, its size remains the same +in the output. + +

The default is 100.

-across=N

The number of thumbnails in each row. Default is 6. -

-colors=N - -

The maximum number of colors allowed in the overall image. If it -would otherwise have more colors than these, pnmindex quantizes -the result. The default is 256. - -

However, this value is meaningless if you specify the --noquant option. -

-black -

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 -black option reverses this. +

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 +-black option reverses this.

-title=title

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

Default is no title. + +

-noquant + +

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 -colors).

-quant -

Enables quantization (to the number of colors specified by --colors). Quantization is on by default but you can disable -it with -noquant. +

This option has no effect; it explicitly selects the default behavior of +quantizing colors. See -noquant. -

-noquant +

-colors=N + +

The maximum number of colors allowed in the overall image. If it would +otherwise have more colors than these, pnmindex 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. + +

This value is meaningless if you specify the -noquant option or if +no input image is PPM. -

See -quant. +

The default is 256.

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.

Basic Options

-i name, --input-name=name +

-i name, --image-name=name

Compress the named images, not Standard Input. If name is -, read Standard Input. name 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 @@ Ppmpat User Manual

ppmpat

-Updated: 02 March 2016 +Updated: 12 November 2023
Table Of Contents @@ -90,8 +90,11 @@ in that order.

-poles -

Color gradients centered on randomly-placed poles. - +

Color gradients centered on randomly-placed poles: a Voronoi diagram. + +

(There are many examples of this pattern in nature. One is the hide of a +giraffe). +

If you specify -color, give two or more colors.

-squig -- cgit 1.4.1

How To Make HTML Documentation

pbmtomda

DESCRIPTION

pktopbm

SYNOPSIS

DESCRIPTION

HISTORY

SEE ALSO

pnmindex

Basic Options

ppmpat