diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HISTORY | 584 | ||||
| -rw-r--r-- | doc/INSTALL | 70 | ||||
| -rw-r--r-- | doc/TESTS | 99 | ||||
| -rw-r--r-- | doc/USERDOC | 108 |
4 files changed, 686 insertions, 175 deletions
diff --git a/doc/HISTORY b/doc/HISTORY index 5f91d170..308f903b 100644 --- a/doc/HISTORY +++ b/doc/HISTORY @@ -4,12 +4,14 @@ Netpbm. CHANGE HISTORY -------------- -19.06.28 BJH Release 10.73.28 +19.06.15 BJH Release 10.86.04 - pbmtozinc: fix wrong output on big-endian machines. Broken in + pamtris: Fix bug: debug trace left in + + pbmtozinc: Fix wrong output on big-endian machines. Broken in Netpbm 10.71 (June 2015). -19.05.04 BJH Release 10.73.27 +19.05.04 BJH Release 10.86.03 pnmtopng: Fix bug: Defaults to no filters. Should be all filters. Effect is larger PNG output. Broken after Netpbm @@ -20,7 +22,57 @@ CHANGE HISTORY Broken after Netpbm 10.26 (January 2005) but no later than Netpbm 10.35 (August 2006). -19.03.10 BJH Release 10.73.26 + pnmcrop: Don't allow -borderfile with -reportXXX. It doesn't + work. + +19.04.10 BJH Release 10.86.02 + + pnmcrop: fix bug: -bgcolor doesn't work. Always present + (-bgcolor was introduced in Netpbm 10.86 (March 2019)). + +19.04.06 BJH Release 10.86.01 + + pnmcrop: fix bug: incorrect identification of background with + -bgcolor and PBM or PGM image. Always present (-bgcolor was + introduced in Netpbm 10.86 (March 2019)). + +19.03.30 BJH Release 10.86.00 + + Add pamfind. + + Add pambrighten. + + Add pamhue. + + pnmcrop: Add -bg-color, bg-corner, -reportfull, -reportsize, + -blank-image . + + pamtopng: Add -interlace . + + pamenlarge: Add -scale, -xscale, -yscale . + + pamenlarge: Much faster for PBM with xscale factor above 10; + slightly faster for xscale factor 2-10. + + pamfile: Add -machine and -size . + + pamscale: Add -reportonly + + pamstretch-gen: Add -quiet, -plain. + + pamstretch-gen: Use -dropedge on the 'pamstretch' piece for + better looking output. + + pamstretch: Accept scale factor of 1 as a parameter (already + was accepted with -xscale and -yscale options). + + pamstretch: Don't mess with edge when scale factor is 1, + regardless of -dropedge and -blackedge. + + ppmwheel: Add -huevalue, -huesaturation, -maxval . + + various: Fix unnormalizing code so a value exactly between two + sample values rounds consistently up. Affects many programs. pstopnm: Fix bug: -textalphabits has no effect. Always broken. (-textalphabits was new in Netpbm 10.53 (December 2010)). @@ -32,8 +84,6 @@ CHANGE HISTORY pamtopng: Fix buffer overrun. Always broken (Pamtopng was new in Netpbm 10.71 (June 2015)). -19.02.09 BJH Release 10.73.25 - pnmtopng: fix bug: -interlace ignored. Broken in 10.55 (June 2011). @@ -47,25 +97,59 @@ CHANGE HISTORY ppmdraw: Fix bug: 'setlinetype nodiag' says invalid type. Always broken. (Ppmdraw was new in Netpbm 10.29 (August 2005)). -18.12.17 BJH Release 10.73.24 + Build: split link/ directory in package tree into staticlink/ + and sharedlink/ . Make 'installnetpbm' do separate prompts to + install static libraries and shared library stubs. Make + 'installnetpbm' install clean symlink in the usual case that the + shared library stub and shared library are in the same + directory. - bmptopnm: Fix wrong output for non-colormapped OS2 BMP. Broken - in Netpbm 10.18 (September 2003). + Build: update 'mkdeb' so it works on Debian 9 (in addition to + Debian 8). Thanks Neil R Ormos <ormos@ormos.org>. -18.11.05 BJH Release 10.73.23 +18.12.29 BJH Release 10.85.00 - bmptopnm: Fix array bounds violation when index value in raster - is too big. Broken after Netpbm 10.10 (October 2002) but before - 10.19 (November 2003). + pnmpaste: Add -nand, -nor, and -nxor. + + pamcut: add -cropleft, -cropright, -croptop, -cropbottom. + + ppmtobmp: respect -bpp with PBM input. + + bmptopnm: allow single color colormap with bpp 1. + + bmptopnm: validate plane count = 1. - Merge build: fix so legacy program names 'pnmtopnm', 'ppmnorm', - and 'ppmtotga' work again. + bmptopnm: Add RLE4 compression decoding. This was ostensibly + added in Netpbm 10.32 (February 2006), but never worked. + + Add pammixmulti. Thanks Scott Pakin (scott+pbm@pakin.org). -18.11.02 BJH Release 10.73.22 + pamtotga: Add -cmap16 . + + pamtris: Add -rgb, -grayscale. Add w parameter to vertex + instructions. Fix perspective correctness. Thanks Lucas Brunno + Luna <lucaslunar32@hotmail.com>. picttoppm: accept rectangle specifications in input that have the corners in any order, not just upper left, then lower right. + pamtotga: identify compressed colormapped format in error + message saying the program doesn't know how to interpret it. + + pamtotga: Ignore extra planes in black and white or grayscale + input instead of generating junk output. + + Merge build: make old names for JPEG, TIFF, and PNG converter + programs work (function previously omitted by design because it + was too hard). + + bmptopnm: Fix wrong output for non-colormapped OS2 BMP. Broken + in Netpbm 10.18 (September 2003). + + bmptopnm: Fix array bounds violation when index value in raster + is too big. Broken after Netpbm 10.11 (October 2002) but before + 10.19 (November 2003). + libnetpbm: Fix invalid memory reference in color name processing when trivial memory allocation fails. @@ -73,50 +157,132 @@ CHANGE HISTORY when it contains multiple delimiter characters in a row. Always broken (pamtojpeg2k was new in Netpbm 10.12 (November 2002)). - pamtojpeg2k: Fix incorrect metadata in output with GRAYSCALE PAM - input. Always broken (pamtojpeg2k was new in Netpbm 10.12 - (November 2002)). - pnmtojbig: fix incorrect handling of -x option. Always broken (pnmtojbig was new in Netpbm 9.2 (May 2000)). -18.09.29 BJH Release 10.73.21 + pjtoppm, pbmtoppa: fix arithmetic overflow. - pstopnm: Fix divide-by-zero crash when Postscript input says - the image has zero size. + Build: fix parallel make. - pstopnm: Fix divide-by-zero crash when computed resolution - rounds down to zero dots per inch. + Build: fix reference to nonexistent getline on Mac OS X 10.6. + + Build: fix reference to nonexistent strndup on Mac OS X 10.6. + + Merge build: fix duplicate symbol 'prefabCode' in g3topbm, + pbmtog3. Introduced in Netpbm 10.79 (June 2017). + +18.09.29 BJH Release 10.84.00 + + Add pamaltsat. Thanks Anton Shepelev <anton.txt@gmail.com>. + + Add pamtris. Thanks Lucas Brunno Luna + <lucaslunar32@hotmail.com>. + + libpbmfont, pbmtext: fix bugs with BDF file lines with + insufficient number of fields. Unknown effect. + + pbmtext: -wchar works with built-in fonts. + + pbmtext: improved -verbose information about BDF fonts: + include CHARSET_REGISTRY, CHARSET_ENCODING. + + libnetpbm font facilities: built-in fonts work with wide + characters. pbmtext; libnetpbm BDF font processing: fix invalid memory reference when BDF font file has invalid syntax. Broken in primordial Netpbm, ca 1993. + pamgetcolor: fix bug: gets color of only the top half of a + region. + + pnmfiasco, fiascotopnm: Fix trivial memory leak. Always broken + (programs were new in Netpbm 9.6, July 2000). + +18.06.30 BJH Release 10.83.00 + + Add pamlevels. Thanks Anton Shepelev <anton.txt@gmail.com>. + + Add pamgetcolor. Thanks Anton Shepelev <anton.txt@gmail.com>. + + Add rgb-<maxval>:r/g/b color specification format. + + pngtopam: Fix bogus warning of non-square pixels when image does + not contain pixel resolution information. Introduced in Netpbm + 10.48 (September 2009). + + pstopnm: Fix divide-by-zero crash when Postscript input says + the image has zero size. + + pstopnm: Fix divide-by-zero crash when computed resolution + rounds down to zero dots per inch. + pbmmask: Fix invalid memory reference with zero-dimension input image. Broken in primordial Netpbm, ca 1989. -18.06.27 BJH Release 10.73.20 + pamtojpeg2k: Fix incorrect metadata in output with GRAYSCALE PAM + input. Always broken (pamtojpeg2k was new in Netpbm 10.12 + (November 2002)). + + libnetpbm: Add pnm_colorspec_rgb_integer, + pnm_colorspec_rgb_norm, pnm_colorspec_rgb_x11, + pnm_colorspec_dict, pnm_colorspec_dict_close. - Pngtopam: Fix bogus warning of non-square pixels when image does - not contain pixel resolution information. Introduced in Netpbm - 10.48 (September 2009) + libnetpbm: Add pnm_parsecolor2. -18.04.28 BJH Release 10.73.19 + libnetpbm: Add pnm_allocpamtuplen, pnm_freepamtuplen. + + libnetpbm: Make the normalized tuple functions respect the + allocation depth specified in struct pam (member + 'allocation_depth') instead of using the actual tuple depth + (member 'depth'). ilbmtoppm: Fix bug: may fail with bogus error message about an invalid CLUT chunk if image has a CLUT chunk. Introduced after Netpbm 10.26 (January 2005) and at or before Netpbm 10.35 (August 2006). -18.02.17 BJH Release 10.73.18 +18.03.25 BJH Release 10.82.00 + + pbmtext: Add -wchar. + + pbmtext: Add -text-dump option. + + ppmhist: Add color summary to top of output, (except with + -noheader). + + pnmremap: Add -randomseed. + + pnmquant: Add -norandom, -randomseed. + + pamtogif: Add -noclear option. + + giftopnm: Check "data width" value from GIF image properly: + can't be bigger than 11, because the minimum code size is one + more than the data width and the maximum code size is 12. (Note + that GIF spec prohibits anything more than 8). + + pnmpsnr: Add -targetX options. + + ppmrainbow: Add "ppmrainbow: " to error messages, like other + programs. + + ppmrainbow: improve error message. g3topbm: Fix bug - produces invalid empty PBM image if input image is empty. + ppmpat: Fix bug - crash or junk output with -camo or -anticamo + and no -color. Introduced in Netpbm 10.78 (March 2017). + mrftopbm: Fix bug - wrong error messages or output when input - invalidly short. + invalidly short. Always broken (mrftopbm was new in Netpbm + 10.18 (September 2003). -17.10.28 BJH Release 10.73.17 + Build: fix compile failure on systems without strnlen (such + as MacOS X before 10.7). Broken in 10.81 (December 2017). + +17.12.30 BJH Release 10.81.00 sldtoppm: -lib and -dir don't work - always says slide not found. Broken in Netpbm 10.63 (June 2013). @@ -128,14 +294,29 @@ CHANGE HISTORY sldtoppm: fix bug: wild memory accesses, weird messages when invalid input file has unterminated strings. -17.09.28 BJH Release 10.73.16 +17.09.30 BJH Release 10.80.00 + + pnmtopalm: Refuse to create a compressed image with more than 8 + bits per pixel. + + pbmtext, libnetpbm font facilities: allow glyphs in font files + that have no bitmap data; just used for their advance value to + code a space. + + pbmtext: Improve error message when there is a problem reading + the font file. + + libnetpbm font facilities: consider font invalid if a glyph is + more than 65536 pixels high or wide. + + ppmshadow: handle images with a black background and low + contrast images (i.e. little difference between foreground and + background). ppmbrighten: fix bug: red pixels change hue. Introduced in after Netpbm 10.11 (October 2002) and before Netpbm 10.18 (September 2003). -17.09.13 BJH Release 10.73.15 - palmtopnm: fix crash if invalid input contains color index that is not in the palette. Always broken (palmtopnm was new in Netpbm 9.10 (October 2001)). @@ -144,34 +325,89 @@ CHANGE HISTORY -packbits_compression. Always broken. -packbits_compression was new in Netpbm 10.27 (March 2005). - pamtopdbimg: Fix incorrect output. Always broken (pamtopdbimg - was new in Netpbm 10.52.00 (October 2010)). + pnmtopalm: Correct error message recommending running + pnmquant when the real solution is to run pnmremap to modify the + image to Palm standard colors. -17.08.11 BJH Release 10.73.14 + pnmtopalm: Fix bug causing "color not in colormap" failure with + -colormap and maxval other than 255. libnetpbm: font facilities: fix invalid memory reference with certain font files. -17.06.30 BJH Release 10.73.13 + libnetpbm: ppm_readcolordict: Improve error message when there is + a problem reading the color dictionary. Affects ppmhist. - ppmcolormask: fix incorrect output when input maxval is not 255. - Always broken (ppmcolormask was new in Netpbm 9.0, April 2000). + pgmmake: Fix bug: treats non-numeric gray-level argument as zero. + Always broken (Pgmmake was new in Netpbm 10.32, February 2006). + + pdbimgtopam, pamtopdbimg: fix various cases of incorrect output, + some always present (programs were new in Netpbm 10.52.00 + (October 2010)). + + libnetpbm: pnm_parsecolorn(), pnm_parsecolor(): fix parsing of + rgb: color specifications: yields value slightly too dim. + Affects many programs. Broken in Netpbm 10.79 (June 2017). + + Makeman: make it work with Python 3.6 II. + +17.06.30 BJH Release 10.79.00 + + Add pamtable . + + pamgauss: Add -maximize, -oversample . Thanks Anton Shepelev + <anton.txt@gmail.com> + + pnmconvol: Extend -normalize to be applicable to convolution + kernels specified by PGM file. Thanks Anton Shepelev + <anton.txt@gmail.com> + + g3topbm: tolerate fill bits. -17.06.28 BJH Release 10.73.12 + pbmtog3: Add -align8, -align16. - pamgauss: Fix skewed output with even dimension. Always broken - (Pamgauss was added in Netpbm 10.23 (July 2004). + ppmshadow: Improve results for very small maxval. + + ppmshadow: eliminate extraneous messages from pnmconvol. + + libnetpbm: Add pnm_parsecolorn(). + + libnetpbm: Improve error message for purported image that is + exactly 1 byte long (so ends in the middle of what would be the + magic number). + + pbmtox10bm: Get the Perl interpreter for this Perl program from + the PATH instead of hardcoded as /usr/bin/perl (like all other + Netpbm Perl programs). + + ppmcolormask: fix incorrect output when input maxval is not 255. + Always broken (ppmcolormask was new in Netpbm 9.0, April 2000). bmptopnm: fix crash when input is a Windows BMP with negative number for width. Always broken. (bmptopnm was new, as bmptoppm, in original Netpbm, 1992). -17.05.27 BJH Release 10.73.11 + pamcomp: fix incorrect output with -mixtransparency. + Always broken. (-mixtransparency was new in Netpbm 10.56, + September 2011). + + pamcomp: remove debug trace message with -mixtransparency. + Always broken. (-mixtransparency was new in Netpbm 10.56, + September 2011). + + pnmtojpeg: fix array bounds violation in argument list. Always + broken (pnmtojpeg was new to Netpbm in Netpbm 8.2 (March 2000). pamcrater: fix incorrect output with non-square image. Introduced in Netpbm 10.69 (December 2014). -17.04.30 BJH Release 10.73.10 + svgtopam: fix treating negative width or height values in SVG + like twos complement positive numbers; fail instead. Always + broken (svgtopam was new in Netpbm 10.33 (March 2006)). + + svgtopam: fix error messages when input has splines or negative + positions. Always broken (svgtopam was new in Netpbm 10.33 + (March 2006)). libnetpbm: fix bug: pm_system_XXX closes Standard Input if you supply a Standard Output accepter but not a Standard Input @@ -184,105 +420,233 @@ CHANGE HISTORY (September 2007), but wouldn't even compile until Netpbm 10.42 (March 2008)). + installnetpbm: Accept globs for directory name responses + (notably, ~/DIR). + + makeman: Make it work with Python 3.6. + Build: don't try to build standardppmdfont.c if it already exists (so don't require ppmdcfont to exist). Broken around Netpbm 10.35 (2006). -17.04.15 BJH Release 10.73.09 + Build: Define _XOPEN_SOURCE=500 in source files that use M_PI. + While C libraries in the past have always provided this with + just _XOPEN_SOURCE=null, it appears that M_PI is actually + defined by Single Unix Specification 2, aka UNIX98, for which + you need _XOPEN_SOURCE=500, and Cygwin has changed to enforce + this. - pamcomp: fix incorrect output with -mixtransparency. - Always broken. (-mixtransparency was new in Netpbm 10.56, - September 2011). + Build: document MinGW _XOPEN_SOURCE incompatibility and add + warning to Configure. - pamcomp: remove debug trace message with -mixtransparency. - Always broken. (-mixtransparency was new in Netpbm 10.56, - September 2011). + Debian packaging: fix bug: don't try to include Manweb files, as + it is no longer packaged by 'make package'. - pnmtojpeg: fix array bounds violation in argument list. Always - broken (pnmtojpeg was new to Netpbm in Netpbm 8.2 (March 2000). +17.03.28 BJH Release 10.78.00 -17.03.28 BJH Release 10.73.08 + ppmpat: Add -color. - tifftonm: Fix incorrect PBM output with two-color paletted TIFF - image. Broken in primordial Netpbm, ca 1990. + ppmpat: Add -argyle1, -argyle2. + + pnmtotiff: Fail with -miniswhite or -minisblack on color image + rather than produce an invalid TIFF. tifftopnmcmyk: Default rows per strip to the TIFF library default instead of whatever yields 8K strips. + --version global option: with SOURCE_DATE_EPOCH environment + variable, display source code datetime instead of build + datetime. And when displaying build datetime, do it in the + local time of the process running the command instead of the + process that did the build. + + tifftonm: Fix incorrect PBM output with two-color paletted TIFF + image. Broken in primordial Netpbm, ca 1990. + + tifftopnm: Fix memory corruption when image is more pixels than + can be represented as a C unsigned integer. Broken in Netpbm + 10.11 (October 2002). + tifftopnmcmyk: Fix bug: fails with very wide images and no -rowsperstrip. Always broken. (Tifftopnmcmyk was new in Netpbm 8.2 (March 2000). + svgtopam: Fix crash when out of memory. Always broken (svgtopam + was new in Netpbm 10.33 (March 2006)). + + pnmcrop: Add -closeness + + libnetpbm: Add ppmd_pathbuilder_* functions. + libnetpbm: ppmd_fill_path: remove debug trace. Always broken (ppmd_fill_path was new in Netpbm 10.34 (June 2006). -16.01.29 BJH Release 10.73.07 + Build: don't create pointer man pages anymore. These were + classic man pages, created by 'make package', one for each + program, that just told the user to get the manual from the web + and that other options for manuals are available at install + time. Getting documentation online is commonplace enough now + that the user doesn't need to be told to do it or that there are + other options. The existence of pointer man pages was, + meanwhile, misleading, since it looked from the outside like + they actually contained documentation. - tifftopnm: Fix memory corruption when image is more pixels - than can be represented as a C unsigned integer. Broken in - Netpbm 10.11 (October 2002). + Build: Don't package or install Manweb setup (for accessing + manuals on the web with Manweb). Probably 100% unused and + distracting. - svgtopam: Fix crash when out of memory. Always broken - (svgtopam was new in Netpbm 10.33 (March 2006)). + Debian package: change dependencies to be compatible with + Debian 8. -16.12.25 BJH Release 10.73.06 +16.12.25 BJH Release 10.77.00 - pbmtoascii: fix bogus assertion failure. Introduced in - Netpbm 10.51 (June 2010) and visible only with a custom - build with assertion checking. + pnmpad: Fix bug: incorrect output width. Introduced in + Netpbm 10.72 (July 2015). -16.12.01 BJH Release 10.73.05 + Makeman: Slight improvement to formatting of man pages. + Thanks Werner LEMBERG <wl@gnu.org>. - pnmpad: fix bug: incorrect output width. Introduced in - Netpbm 10.72 (July 2015). + Test: Skip tests of some parts that are configured out of the + build. -16.09.02 BJH Release 10.73.05 +16.09.27 BJH Release 10.76.00 - pnmquantall: Fix failure when temporary file location is - not the same filesystem as the output file. + pnmquantall: Fix failure when temporary file location is not the + same filesystem as the output file. Always broken (pnmremap was + new in Netpbm 10.58 (March 2012)). pnmquantall: Fix incorrect handling of when the Pnmremap or - the final rename fails. - -16.08.13 BJH Release 10.73.04 + the final rename fails. Always broken (pnmremap was new + in Netpbm 10.58 (March 2012)). giftopnm: Fix bug: crash on little-endian computers that can't toleration unaligned memory access. Thanks Ignatios Souvatzis (is@netbsd.org). Broken in Netpbm 10.47 (June 2009). -16.06.26 BJH Release 10.73.03 + cmuwmtopbm: Fix trivial memory leak. Always broken (cmuwmtopbm + was in primordial Pbmplus, in 1988). - pamarith: fix incorrect output when maxvals differ, for - -add, -multiply, -mean, -min, -max. Broken in Netpbm 10.41 - (December 2007). + Build: Add PKG_CONFIG make variable. + + Build: tifftopnm.c: Fix undefined WIFSIGNALED, etc. + +16.06.26 BJH Release 10.75.00 + + pbmtextps: Add -leftmargin, -rightmargin, -topmargin, + -bottommargin, -ascent, -descent, -pad, -crop. -16.06.12 BJH Release 10.73.02 + pbmtextps: Add -dump-ps. pbmtextps: Abort with error instead of generating single space when user supplies no text. - pbmtextps: Fix bug: input text or font name with Postscript - control characters messes up the Postscript program. + pbmtextps: Accept fractional -fontsize. + + pbmtextps: Change margins for non-default fonts. + + pbmtextps: Minor output changes caused by code cleanup. + + bmptopnm: Add ability to convert Version 4 and 5 Windows BMP. + + pbmtext: Remove undocumented -dump option; add 'genfontc' + development tool (buildtools/ directory) to replace it. + + pbmtext: Add -dry-run + + pbmtext: Add -dump-sheet + + pbmtext: Speedup: renders directly in raw PBM. + + pbmreduce: Add -randomseed. + + anytopnm, pnmmargin, pnmquant, ppmquant, pnmquantall, pgmcrater, + ppmfade, ppmrainbow, ppmshadow, pbmtox10bm, pamstretch-gen: + Add -version. + + fiascotopnm: Change -version to include Netpbm version. -16.05.09 BJH Release 10.73.01 + libnetpbm: Add pm_system2(), pm_system2_lp(), pm_system2_vp() - + same as pm_system(), etc. but returns the termination status. - bmptopnm: fail properly with Version 4, 5 Windows BMP. + pamarith: Fix incorrect output when maxvals differ, for + -add, -multiply, -mean, -min, -max. Broken in Netpbm 10.41 + (December 2007). + + pbmtextps: Fix bug: input text or font name with Postscript + control characters messes up the Postscript program. Always + broken (pbmtextps was new in Netpbm 10.0 (June 2002). + + hpcdtoppm dummy version: Update web link to real version. - ppmhist: fix incorrect color names. Introduced in + ppmhist: Fix incorrect color names. Introduced in Netpbm 10.19 (November 2003). - pnmpaste: fix possible invalid memory access. Introduced in + ppmshadow: Fix bug: don't ignore invalid option. Introduced in + Netpbm 10.9 (September 2002). + + pnmpaste: Fix possible invalid memory access. Introduced in Netpbm 1.44 (September 2008). - pbmreduce: fix undefined behavior when scale factor argument is + pbmreduce: Fix undefined behavior when scale factor argument is too big. Always present (pbmreduce was new in September 1989). - cameratopam: fix invalid memory reference; effect unknown. + pbmtext: Fix bug: invalid memory reference when text contains + code points > 127. Broken in 10.74 (March 2016). + + pnmtofiasco, fiascotopnm: Fix incorrect math on systems with + unusual floating point representation. Always broken (programs + were new in Netpbm 9.6 (July 2000). + + cameratopam: Fix invalid memory reference; effect unknown. Introduced in Netpbm 10.68 (September 2014). - Install on Windows: fix backward compatibility symlinks for + Install on Windows: Fix backward compatibility symlinks for pnmtoplainpnm, pnmquantall. + Build: Remove use of strndup so it compiles on Mac OS X 10.6. + Broken in 10.74. + + Build: Remove use of isfinite so it compiles with C89 standard + compiler. + +16.03.27 BJH Release 10.74.00 + + pbmtext: Produce same image when you run pbmtext with -width + explicitly set to the width you get when you don't specify + width. + + pbmtext: Ignore -nomargins when -width is specified. + + pbmtext: Report when line ends are dropped because of + truncation. + + pbmtext: Fix bug: if input has a code point that is not in the + font, Pbmtext substitutes space, but behavior is undefined if + font doesn't have space either. Now it aborts the program in + that case. + + pbmtext: Fix bug: Respect -width when specified. + + pbmtext: Fix bug: Deal correctly with negative -space. + + pbmtext: Fix bug: Consider all characters in line, not just + first and last, in determining line width. + + libnetbpm font facility (so pbmtext): Fix bug: undefined + behavior when font definitions are invalid in any of various + ways. + + libnetpbm font facility (so pbmtext): Fix incorrect font names + in error messages. + + pnmtopsnr: Add -machine, -max . + + Netpbmlib: Add /usr/local/netpbm/lib and /etc/X11 to search + path for rgb.txt. + + makeman: Add some text replacements to solve glitches. + Handle &mdash, &minus. + 15.12.26 BJH Release 10.73.00 anytopnm: use --mime-type option instead of --mime on newer @@ -373,10 +737,10 @@ CHANGE HISTORY pamstereogram: Add -xbegin. Change default to render from center outwards intead of from right to left, thus making the center of the image the crispest part. Thanks Scott Pakin - (scott@pakin.org). + (scott+pbm@pakin.org). pamstereogram: Allow -xshift and -yshift to be negative. Thanks - Scott Pakin (scott@pakin.org). + Scott Pakin (scott+pbm@pakin.org). pnmpsnr: Add -rgb. @@ -485,10 +849,9 @@ CHANGE HISTORY test: replace some GNU-only code with more portable code that works on OS X. Thanks Ryan Schmidt <ryandesign@macports.org>. - makeman: deal properly with backlash in source. Thanks Willem - van Schaik <willem@schaik.com>. But something was wrong with - this change and it caused the program always to fail, so - we reversed this change in 10.72. + makeman: deal properly with backlash in source. But something + was wrong with this change and it caused the program always to + fail, so we reversed this change in 10.72. Build: don't build and install libjbig and libjasper if we are using external versions of them instead. @@ -1013,7 +1376,7 @@ CHANGE HISTORY get down to a compression ratio of 1. pamstereogram: -smoothing smooths images even without -texfile. - Thanks Scott Pakin (scott@pakin.org). + Thanks Scott Pakin (scott+pbm@pakin.org). pnmcat: set don't care bits in packed PBM output to zero so they are predictable. @@ -1105,10 +1468,10 @@ CHANGE HISTORY Elijah Griffin <eli@panix.com>. pamstereogram: Add -planes . Thanks Scott Pakin - (scott@pakin.org). + (scott+pbm@pakin.org). pamstereogram: improve verbose output. Thanks Scott Pakin - (scott@pakin.org). + (scott+pbm@pakin.org). pamstereogram: fix crash introduced in Netpbm 10.54 (March 2011). @@ -1171,7 +1534,7 @@ CHANGE HISTORY pngtopam: fix crash with invalid tIME chunk. Always broken. - pamarith: fix wrong result with -multiply. Broken in Neptbm + pamarith: fix wrong result with -multiply. Broken in Netpbm 10.41. pamscale: fix all black output with resampling. Always broken. @@ -1216,7 +1579,7 @@ CHANGE HISTORY "from bottom edge." ppmcie: fix bug: fails with "X coordinate out of range" error. - Introduced in Neptbm 10.51. + Introduced in Netpbm 10.51. bmptopnm: Fail properly with BMP that indicates an illegal bits per pixel. @@ -1780,8 +2143,9 @@ CHANGE HISTORY (produces grayscale output). Broken between Netpbm 10.19 and 10.26, inclusive. - pbmtomrf, mrftopbm: fix crashes, incorrect output in all - cases. Broken forever. + pbmtomrf, mrftopbm: fix crashes, incorrect output in all cases. + Always broken (mrftopbm was new in Netpbm 10.18 (September + 2003). pnm_alloctupletable, pnm_tuplehashtotable, pnm_computetuplefreqtable3: fix crash when out of memory, @@ -2114,7 +2478,7 @@ CHANGE HISTORY 07.06.26 BJH Release 10.39.00 - Add pamtooctave. Thanks Scott Pakin (scott@pakin.org). + Add pamtooctave. Thanks Scott Pakin (scott+pbm@pakin.org). Add pamundice. @@ -2627,7 +2991,7 @@ CHANGE HISTORY arguments; fix crash. pamstereogram: Fix crippling bugs. Thanks Scott Pakin - <scott@pakin.org>. + <scott+pbm@pakin.org>. giftopnm: Handle case of a clear code at the end of a block. @@ -3419,12 +3783,12 @@ CHANGE HISTORY Add pamperspective. Thanks Mark Weyer <Mark.Weyer@math.uni-freiburg.de>. - Add pamstereogram. Thanks Scott Pakin <scott@pakin.org>. + Add pamstereogram. Thanks Scott Pakin <scott+pbm@pakin.org>. Add pc1toppm. Thanks Roine Gustafsson <roine@users.sourceforge.net>. - Add pbmtodjvurle. Thanks Scott Pakin <scott@pakin.org>. + Add pbmtodjvurle. Thanks Scott Pakin <scott+pbm@pakin.org>. Add infotopam. Thanks Rich Griswold <griswold@acm.org>. @@ -3481,7 +3845,7 @@ CHANGE HISTORY Add pamsharpness, pamsharpmap. - Add ppmtodjvurle. Thanks Scott Pakin <scott@pakin.org>. + Add ppmtodjvurle. Thanks Scott Pakin <scott+pbm@pakin.org>. pstopnm: add -dpi option. diff --git a/doc/INSTALL b/doc/INSTALL index f0b3e87b..aad0a5e5 100644 --- a/doc/INSTALL +++ b/doc/INSTALL @@ -109,6 +109,35 @@ If you use the 'configure' program, be sure to edit config.mk _after_ you run 'configure', since 'configure' generates config.mk. +COMPILED-IN BUILD DATETIME +-------------------------- + +By default, the Netpbm build system builds the datetime that you built it +into libnetpbm, so the --version global command line option can display it. +It's actually just when you began building from a clean build tree; if you +modify code and rebuild, the build datetime does not change. + +This is problematic for any of various reasons you might want to compare two +versions of libnetpbm, or anything of which it is part, for equality. Two +libnetpbms that are identical except that they were built at different times +would compare as different. + +Furthermore, as version information, the modification datetime of the source +code is often more useful than the build datetime. + +For these reasons, it is possible to change this timestamping behavior by +setting the environment variable 'SOURCE_DATE_EPOCH'. That is supposed to be +the POSIX datetime value (decimal number of seconds since 1969, excluding leap +seconds) for when the source code was last modified. When you set this, +before doing 'make' for the first time in a clean build tree, the resulting +libnetpbm contains that information and not build datetime information, and +the --version global option causes a different message. + +The name and meaning of the environment variable is taken from a standard +described at https://reproducible-builds.org/specs/source-date-epoch/ on March +16, 2017. + + AUTOMATING THE BUILD -------------------- @@ -153,6 +182,45 @@ Netpbm has also been built for Windows using Djgpp, as late as 2001. See also the general installation instructions above. +Mingw Modification +------------------- + +With at least some versions of MinGW, you have to make a small change to +_mingw.h or you get a compilation failure for invalid syntax in that file +where it expands the macro _XOPEN_SOURCE. + +The problem is that many Netpbm programs declare that they need a C library +that conforms to any version of the X/Open (XPG, XSI, SUS) standard. The way +they do that is, in accordance with the earliest version of that standard, by +defining the macro _XOPEN_SOURCE with a null (zero-length) body. But MinGW is +not designed to work with programs that request anything earlier than Issue +(version) 5 of this standard, and in fact _mingw.h will not compile if the +macro expands to something other than a number. + +But it is easy to add pre-Issue 5 function to MinGW and having done so, your +MinGW installation will also work with lots of other code. All you have to do +is change + + if _XOPEN_SOURCE < 500 + +to + + if (_XOPEN_SOURCE + 0) < 500 + +in _mingw.h. This is the trick other C libraries use. + +(A user proposed that this change be distributed in _mingw.h, in April 2017 on +the mingw-users mailing list, but the maintainer was opposed to accomodating +programs written for the older standards). + +If you cannot change _mingw.h, you can alternatively change Netpbm. Find all +instances of + + #define _XOPEN_SOURCE + +and change them to + + #define _XOPEN_SOURCE 0 INSTALLATION - MAKING ONLY THE PARTS YOU NEED @@ -428,5 +496,3 @@ link is picking up the old system version instead. Why? Because the link options say to search /usr/lib _before_ the local build directory. And they do that because libpng-config erroneously says that you need a -L /usr/lib link option to find the Libpng library. - - diff --git a/doc/TESTS b/doc/TESTS index 65f91d26..9434f580 100644 --- a/doc/TESTS +++ b/doc/TESTS @@ -1,3 +1,5 @@ +Please cut and paste from below: +--------------------------------------------------------------------------- Contents ======== @@ -10,7 +12,7 @@ Contents 1.6 Testing package in designated directory 1.7 Pre-packaging check 1.8 Post-install check - 1.9 Skipping test items + 1.9 Testing less than everything 1.10 Valgrind 2. Troubleshooting @@ -68,14 +70,16 @@ appear at the end: ================= The tests require the Bash command shell. The script Execute-Tests has -some expressions unique to bash. Quite old versions work, at least back -to bash v. 2.05b. +some expressions unique to Bash. Quite old versions work, at least back +to Bash v. 2.05b. -The tests also use the following utilities: +Awk is also required, but the constructs are all simple. Gawk, Mawk and +BWK Awk (the "One True Awk") are all known to work. + +The tests use the following utilities: - sh - awk - - perl - cat - cksum @@ -89,6 +93,7 @@ The tests also use the following utilities: - grep - file - head + - iconv - mkdir - mktemp - rm @@ -141,8 +146,8 @@ packaging. This feature is intended for developers. This test method is incompatible with merge build. -Currently this test method reports several errors when Netpbm is compiled in a -separate build directory. +This works when Netpbm is compiled in the source tree and also when +a separate build directory is used. @@ -161,22 +166,27 @@ a non-standard location. This must be an absolute path. -1.9 Skipping test items -======================= +1.9 Testing less than everything +================================ The file test/Test-Order is a list of tests which are run. If you want to -skip any test, remove the line or comment it out with a "#". +skip a test, remove the line or comment it out with a "#". -The variable "target", a comma-separated list of Netpbm programs -provides another way to run only select tests. For example to run -only the test scripts which examine giftopnm and pamtogif, do: +If you want to run just a few of the tests, use the make variable "target", a +comma-separated list of Netpbm programs. make check target=giftopnm,pamtogif + This runs only the tests of 'giftopnm' and 'pamtogif', in the package + (staging) directory. + + make check-tree target=ppmbrighten + + This runs only the tests of 'ppmbrighten', from the build tree. 1.10 Valgrind -============ +============= You can run the whole test under Valgrind. This is an advanced feature intended for programmers who work on Netpbm code. @@ -206,18 +216,23 @@ test/Execute-Tests: vg_command_base="valgrind --trace-children=yes" -To run "valgrind --track-origins=yes", you must make two changes in -config.mk: +To get useful information from "--trace-origins=yes", you must make +two changes to config.mk before compilation: - Add -g to CFLAGS - Turn stripping off: STRIPFLAG = +Without these changes valgrind will report how many errors were +detected, of what kind, and at what addresses (in binary). With the +above "-g" turned on during compilation valgrind reports source file +and line numbers of detected problems. + Valgrind significantly increases execution time. If ordinary "make check" requires 10 seconds, "make check VALGRIND_TESTS=on" will require roughly 12 minutes, maybe more. You should consider either setting "target=..." or paring down the items in Test-Order. In the latter case, you probably don't need to run "all-in-place.test" -and "legacy-names.test". +and "legacy-names.test"; consider commenting them out. The option "--trace-children-skip" is used to prevent valgrind from stepping into child processes that are not relevant. This option @@ -244,12 +259,20 @@ problem, such as a misconfigured dynamic library or a directory-wide permission issue. This kind of failure is known to happen when N is set too high with "make -jN" (overambitious parallel make.) -The current test routines assume a typical build configuration - they are -not aware of the actual configuration you chose. If a choice you make -during configure causes "make" to skip compilation of certain programs, -the test routines won't know and will report failures. +Configuration choices affect tests. If a choice you make during configure +causes "make" to skip compilation of certain programs, the corresponding +test routines will be skipped and reported as NOT TESTABLE. However, +if you override a glitch with "make --keep-going" the test programs +won't know and quite certainly you'll get failure messages. + +If you run the tests as "make check-install" information about +configuration choices is deliberately ignored. This is because the +post-install check is typically run on systems with multiple versions +of Netpbm and in this case most users would want to get a clear idea +of absent components. -For details read 'Netpbm Library Prerequisites': +For details on the effects of missing libraries, read +'Netpbm Library Prerequisites': http://netpbm.sourceforge.net/prereq.html . @@ -271,6 +294,9 @@ When a test fails, a ".out" file will be produced in the can tell exactly what went wrong. Often one does not need to go this far; the error messages tell enough. +In some cases the ".ok" file is generated dynamically. See "2.5 +System Dependent Issues." + 2.3 Color dictionary file @@ -335,22 +361,33 @@ the tests on installed Netpbm programs, regardless of the version: ./configure # accept the defaults make check-install +As of this writing (April 2018) Debian is working on resolving the +fork. A new version, tagged as "experimental", based on the Sourceforge +line of source files is available. + + 2.5 System dependent issues =========================== -The tests have worked on x86 and x86_64 GNU/Linux systems, with several -versions of GCC and Clang. Reports from users of other systems including Mac -OS, Sun SPARC and BSD and compilers other than GCC are highly welcome. +The tests have worked on x86 and x86_64 GNU/Linux systems and with several +versions of GCC and Clang and also Mac OS/Clang. Reports from users of +other systems including OS, Sun SPARC and BSD and compilers other than +GCC are highly welcome. Floating point math precision seems to be an issue. Some discrepancies have been observed between x86 32 bit and 64 bit; the tests are written to work around them as much as possible. The use of the "--fast-math" -flag by default may also be a factor. +c compiler flag by default may also be a factor. -The current test framework checks whether the random number generator -is the one from glibc and skips certain tests if a different one is -detected. +Another cause of discrepancies is the qsort function. The tests are +written to circumvent this issue at some cost to accuracy and +coverage. + +The test directory Makefile checks whether the random number generator +is the one from glibc or Mac OS and automatically generates the proper +".ok" files from master files with the suffix ".rand-ok". If some other +random number generator is detected the affected tests are skipped. @@ -360,3 +397,7 @@ detected. When reporting problems with the tests, please give both the output of "make check" and the contents of the "netpbm-test" directory. + + + + diff --git a/doc/USERDOC b/doc/USERDOC index 9d883849..045794b9 100644 --- a/doc/USERDOC +++ b/doc/USERDOC @@ -32,11 +32,16 @@ This creates a directory "userguide" in your current directory containing all the same files that are on the web site. -An apparent alternative is just to copy the web site with something like GNU -Wget. However, the Sourceforge web server has limitations on how much you can +An alternative is just to copy the web site with something like GNU Wget. +However, the Sourceforge web server has limitations on how much you can download. In a February 2012 experiment, Sourceforge started refusing HTTP requests (with an Internal Server Error indication and a message saying there -had been too many requests) before all the files could be fetched. +had been too many requests) before all the files could be fetched. But you +can use Wget controls to fool Sourceforge. The following worked in January +2016: + + wget --wait=1 --random-wait \ + --recursive --relative http://netpbm.sourceforge.net/doc/ @@ -97,8 +102,8 @@ ways: 2) convert the HTML to formatted plain text (suitable as man "cat" pages) with the 'makecat' program in the 'buildtools' directory - of the Netpbm source tree. This program just does a - 'lynx -dump'. + of the Netpbm source tree. This program uses the dump feature + of the lynx text web browser for conversion. The "loss of quality" mentioned above is because: @@ -119,46 +124,81 @@ The "loss of quality" mentioned above is because: Also, these methods require manual effort, and technical understanding, on your part to set up. Setting it up is too complex for an automated process to do it for you with any significant -integrity. The examples are guidelines and you shouldn't expect them -to work literally in your situation. +integrity. The examples are guidelines and may not work literally +in your situation. -Here is an old example of making troff pages, which doesn't actually -work anymore, but might be helpful. You'll probably want to use a Subversion -export of the manual instead of a Wget download (see above). - mkdir netpbmdoc - cd netpbmdoc - wget --recursive --relative http://netpbm.sourceforge.net/doc/ - cd netpbm.sourceforge.net/doc - make MAKEMAN=/usr/src/netpbm/buildtools/makeman \ - -f /usr/src/netpbm/buildtools/manpage.mk manpages - make -f /usr/src/netpbm/buildtools/manpage.mk installman - cd ../../.. - rm -r netpbmdoc +MAKING TROFF MAN PAGES +---------------------- - man ppmtogif +1. Start work at the top-level directory of the source package. + +2. Download the HTML files using the subversion command. +The downloaded files will go into "./userguide/". + + svn export https://svn.code.sf.net/p/netpbm/code/userguide -Here is an example of making "cat" pages: +3. Create a work directory named "netpbmdoc". The troff man pages, +as they are converted from HTML pages by the makeman utility, will +be written here. mkdir netpbmdoc cd netpbmdoc - wget --recursive --relative http://netpbm.sourceforge.net/doc/ - cd netpbm.sourceforge.net/doc - /usr/src/netpbm/buildtools/makecat *.html - cp *.1 /usr/man/cat1/ - cd ../../.. - rm -r netpbmdoc + make USERGUIDE=../userguide/ -f ../buildtools/manpage.mk manpages - man ppmtogif +USERGUIDE is the directory containing the input HTML pages. Keep +it intact until installation is complete. + +4. Install the troff man pages, with MANDIR set up appropriately +to the destination. + +MANDIR and MANDIR/{man1,man3,man5} must be existing directories. +The install step usually requires superuser permissions. + + make MANDIR=/usr/local/netpbm/man USERGUIDE=../userguide/ \ + -f ../buildtools/manpage.mk installman + cd ../ + rm -rf netpbmdoc + +5. Adjust MANPATH if necessary and try showing one manual page. + + man pamflip + + +MAKING CAT PAGES +---------------- + +As with the above example for troff man pages, start at the top-level +directory of the source package. + + svn export https://svn.code.sf.net/p/netpbm/code/userguide + + cd ./userguide + ../buildtools/makecat *.html + + cp *.1 /usr/man/cat1/ # Usually requires superuser permission + +The makecat utility reads files from the current directory and writes +the results into the same directory. As noted above, it requires lynx +<http://lynx.invisible-island.net/>. DOCBOOK ------- -You can turn the Netpbm user manual into Docbook XML pages using -Doclifter. Because Doclifter works on troff pages, you have to -convert the documentation down to troff first, which means the Docbook -pages are of lower quality than the main HTML documentation. +You can turn the Netpbm user manual into Docbook XML pages using Doclifter. +Because Doclifter works on troff pages, you have to convert the documentation +down to troff first, which means the Docbook pages are of lower quality than +the master HTML documentation. + +To create Docbook XML, do as follows: + + mkdir netpbmdoc + cd netpbmdoc + make USERGUIDE=../userguide/ -f ../buildtools/manpage.mk xmlpages + +The 'make' executes the HTML to troff conversion step automatically. For the +troff to XML step, there are problems that have not been completely worked +out; conversion of several files will fail. -To create Docbook XML, follow the example above for creating troff -pages, and use 'make xmlpages' instead of 'make manpages'. +There is no equivalent for 'make installman' for the Docbook XML pages. |