Gecko [ 122.154.134.11 ]

Name	Size	Permission
411toppm.html	1.76 KB	-rw-r--r--
anytopnm.html	2.56 KB	-rw-r--r--
asciitopgm.html	2.4 KB	-rw-r--r--
atktopbm.html	945 B	-rw-r--r--
bioradtopgm.html	1.43 KB	-rw-r--r--
blend1.gif	18.25 KB	-rw-r--r--
blend3.gif	21.23 KB	-rw-r--r--
blend4.gif	24.56 KB	-rw-r--r--
blend6.gif	21.87 KB	-rw-r--r--
blend7.gif	26.28 KB	-rw-r--r--
bmptopnm.html	2.13 KB	-rw-r--r--
bmptoppm.html	562 B	-rw-r--r--
brushtopbm.html	953 B	-rw-r--r--
cameratopam.html	5.21 KB	-rw-r--r--
cistopbm.html	1.36 KB	-rw-r--r--
cmuwmtopbm.html	945 B	-rw-r--r--
ddbugtopbm.html	3.22 KB	-rw-r--r--
directory.html	32.33 KB	-rw-r--r--
escp2topbm.html	2.21 KB	-rw-r--r--
extendedopacity.html	6.7 KB	-rw-r--r--
eyuvtoppm.html	1.1 KB	-rw-r--r--
faxformat.html	3.66 KB	-rw-r--r--
fiascotopnm.html	6.04 KB	-rw-r--r--
fitstopnm.html	3.7 KB	-rw-r--r--
flatebug.png	32.86 KB	-rw-r--r--
fstopgm.html	1.95 KB	-rw-r--r--
g3topbm.html	4.36 KB	-rw-r--r--
gemtopbm.html	512 B	-rw-r--r--
gemtopnm.html	1.38 KB	-rw-r--r--
giftopnm.html	7.57 KB	-rw-r--r--
globe.jpg	14.04 KB	-rw-r--r--
gobot.gif	1.37 KB	-rw-r--r--
gouldtoppm.html	911 B	-rw-r--r--
hdifftopam.html	1.5 KB	-rw-r--r--
hipstopgm.html	1.03 KB	-rw-r--r--
hpcdtoppm.html	11.18 KB	-rw-r--r--
icontopbm.html	903 B	-rw-r--r--
ilbmtoppm.html	3.29 KB	-rw-r--r--
imgtoppm.html	1.03 KB	-rw-r--r--
index.html	41.28 KB	-rw-r--r--
infotopam.html	6.53 KB	-rw-r--r--
jbigtopnm.html	3.91 KB	-rw-r--r--
jpeg2ktopam.html	5.3 KB	-rw-r--r--
jpegtopnm.html	12.51 KB	-rw-r--r--
leaftoppm.html	1.1 KB	-rw-r--r--
liberror.html	8.46 KB	-rw-r--r--
libmaketmpfile.html	2.43 KB	-rw-r--r--
libmaketmpfilefd.html	1.72 KB	-rw-r--r--
libnetpbm.html	3.55 KB	-rw-r--r--
libnetpbm_dir.html	9.03 KB	-rw-r--r--
libnetpbm_draw.html	4.22 KB	-rw-r--r--
libnetpbm_image.html	23.34 KB	-rw-r--r--
libnetpbm_ug.html	10.79 KB	-rw-r--r--
libpbm.html	9.34 KB	-rw-r--r--
libpgm.html	7.63 KB	-rw-r--r--
libpm.html	16.81 KB	-rw-r--r--
libpnm.html	9.87 KB	-rw-r--r--
libppm.html	26.63 KB	-rw-r--r--
libsystem.html	14.36 KB	-rw-r--r--
libtmpfile.html	1.71 KB	-rw-r--r--
libtmpfilefd.html	1.3 KB	-rw-r--r--
lispmtopgm.html	1.94 KB	-rw-r--r--
macptopbm.html	1.87 KB	-rw-r--r--
manweb.html	9.26 KB	-rw-r--r--
mdatopbm.html	1.61 KB	-rw-r--r--
mgrtopbm.html	1.03 KB	-rw-r--r--
mrf.html	4.3 KB	-rw-r--r--
mrftopbm.html	1.54 KB	-rw-r--r--
mtvtoppm.html	1.04 KB	-rw-r--r--
neotoppm.html	1.18 KB	-rw-r--r--
palmtopnm.html	3.49 KB	-rw-r--r--
pam.html	11.75 KB	-rw-r--r--
pamaddnoise.html	3.96 KB	-rw-r--r--
pamarith.html	10.82 KB	-rw-r--r--
pambackground.html	4.85 KB	-rw-r--r--
pambayer.html	3.54 KB	-rw-r--r--
pamchannel.html	2.53 KB	-rw-r--r--
pamcomp.html	12.64 KB	-rw-r--r--
pamcut.html	6.69 KB	-rw-r--r--
pamdeinterlace.html	2.52 KB	-rw-r--r--
pamdepth.html	2.12 KB	-rw-r--r--
pamdice.html	4.52 KB	-rw-r--r--
pamditherbw.html	5.99 KB	-rw-r--r--
pamedge.html	2.24 KB	-rw-r--r--
pamendian.html	2.55 KB	-rw-r--r--
pamenlarge.html	2.18 KB	-rw-r--r--
pamfile.html	2.93 KB	-rw-r--r--
pamfixtrunc.html	3.12 KB	-rw-r--r--
pamflip.html	8.42 KB	-rw-r--r--
pamfunc.html	8.51 KB	-rw-r--r--
pamgauss.html	3.7 KB	-rw-r--r--
pamgradient.html	2.88 KB	-rw-r--r--
pamlookup.html	9.66 KB	-rw-r--r--
pammasksharpen.html	4.62 KB	-rw-r--r--
pammixinterlace.html	3.1 KB	-rw-r--r--
pamoil.html	2.36 KB	-rw-r--r--
pamperspective.html	17.28 KB	-rw-r--r--
pampick.html	2.35 KB	-rw-r--r--
pampop9.html	2.4 KB	-rw-r--r--
pamrgbatopng.html	2.26 KB	-rw-r--r--
pamscale.html	25.23 KB	-rw-r--r--
pamseq.html	2.77 KB	-rw-r--r--
pamsharpmap.html	2.38 KB	-rw-r--r--
pamsharpness.html	1.73 KB	-rw-r--r--
pamsistoaglyph.html	6.65 KB	-rw-r--r--
pamslice.html	4.2 KB	-rw-r--r--
pamsplit.html	2.8 KB	-rw-r--r--
pamstack.html	3.41 KB	-rw-r--r--
pamstereogram.html	10.08 KB	-rw-r--r--
pamstretch-gen.html	1.62 KB	-rw-r--r--
pamstretch.html	3.72 KB	-rw-r--r--
pamsumm.html	3.64 KB	-rw-r--r--
pamsummcol.html	4.1 KB	-rw-r--r--
pamthreshold.html	6.25 KB	-rw-r--r--
pamtilt.html	4.53 KB	-rw-r--r--
pamtodjvurle.html	1.78 KB	-rw-r--r--
pamtofits.html	4 KB	-rw-r--r--
pamtogif.html	13.12 KB	-rw-r--r--
pamtohdiff.html	3.32 KB	-rw-r--r--
pamtohtmltbl.html	2.71 KB	-rw-r--r--
pamtojpeg2k.html	8.36 KB	-rw-r--r--
pamtompfont.html	2.07 KB	-rw-r--r--
pamtooctaveimg.html	3.21 KB	-rw-r--r--
pamtopam.html	1.67 KB	-rw-r--r--
pamtopfm.html	3.1 KB	-rw-r--r--
pamtopnm.html	2.77 KB	-rw-r--r--
pamtosvg.html	7.02 KB	-rw-r--r--
pamtotga.html	4.42 KB	-rw-r--r--
pamtotiff.html	21.19 KB	-rw-r--r--
pamtouil.html	2.49 KB	-rw-r--r--
pamtoxvmini.html	1.09 KB	-rw-r--r--
pamundice.html	6.96 KB	-rw-r--r--
pamx.html	8.02 KB	-rw-r--r--
pbm.html	5.8 KB	-rw-r--r--
pbmclean.html	3.45 KB	-rw-r--r--
pbmlife.html	1 KB	-rw-r--r--
pbmmake.html	1.32 KB	-rw-r--r--
pbmmask.html	2.89 KB	-rw-r--r--
pbmminkowski.html	529 B	-rw-r--r--
pbmpage.html	2.84 KB	-rw-r--r--
pbmpscale.html	1.82 KB	-rw-r--r--
pbmreduce.html	2.29 KB	-rw-r--r--
pbmtext.html	9.38 KB	-rw-r--r--
pbmtextps.html	3.46 KB	-rw-r--r--
pbmto10x.html	1.37 KB	-rw-r--r--
pbmto4425.html	1.75 KB	-rw-r--r--
pbmtoascii.html	1.75 KB	-rw-r--r--
pbmtoatk.html	934 B	-rw-r--r--
pbmtobbnbg.html	1.32 KB	-rw-r--r--
pbmtocis.html	1.49 KB	-rw-r--r--
pbmtocmuwm.html	1.03 KB	-rw-r--r--
pbmtodjvurle.html	1.18 KB	-rw-r--r--
pbmtoepsi.html	3.24 KB	-rw-r--r--
pbmtoepson.html	3.11 KB	-rw-r--r--
pbmtoescp2.html	3.94 KB	-rw-r--r--
pbmtog3.html	2.24 KB	-rw-r--r--
pbmtogem.html	1.16 KB	-rw-r--r--
pbmtogo.html	1.24 KB	-rw-r--r--
pbmtoibm23xx.html	2.31 KB	-rw-r--r--
pbmtoicon.html	1005 B	-rw-r--r--
pbmtolj.html	3.34 KB	-rw-r--r--
pbmtoln03.html	1.45 KB	-rw-r--r--
pbmtolps.html	1.48 KB	-rw-r--r--
pbmtomacp.html	1.81 KB	-rw-r--r--
pbmtomatrixorbital.html	1.46 KB	-rw-r--r--
pbmtomda.html	1.75 KB	-rw-r--r--
pbmtomgr.html	1.03 KB	-rw-r--r--
pbmtomrf.html	1.4 KB	-rw-r--r--
pbmtonokia.html	3.28 KB	-rw-r--r--
pbmtopgm.html	2.47 KB	-rw-r--r--
pbmtopi3.html	1.11 KB	-rw-r--r--
pbmtopk.html	4.3 KB	-rw-r--r--
pbmtoplot.html	1.06 KB	-rw-r--r--
pbmtoppa.html	10.29 KB	-rw-r--r--
pbmtopsg3.html	1.8 KB	-rw-r--r--
pbmtoptx.html	1.05 KB	-rw-r--r--
pbmtowbmp.html	1.32 KB	-rw-r--r--
pbmtox10bm.html	631 B	-rw-r--r--
pbmtoxbm.html	1.49 KB	-rw-r--r--
pbmtoybm.html	1.13 KB	-rw-r--r--
pbmtozinc.html	1.11 KB	-rw-r--r--
pbmupc.html	1.91 KB	-rw-r--r--
pc1toppm.html	1.13 KB	-rw-r--r--
pcdindex.html	315 B	-rw-r--r--
pcdovtoppm.html	2.32 KB	-rw-r--r--
pcxtoppm.html	2.27 KB	-rw-r--r--
pfm.html	3.24 KB	-rw-r--r--
pfmtopam.html	1.89 KB	-rw-r--r--
pgm.html	6.86 KB	-rw-r--r--
pgmabel.html	3.27 KB	-rw-r--r--
pgmbentley.html	1.14 KB	-rw-r--r--
pgmcrater.html	6.58 KB	-rw-r--r--
pgmdeshadow.html	1.89 KB	-rw-r--r--
pgmedge.html	504 B	-rw-r--r--
pgmenhance.html	1.53 KB	-rw-r--r--
pgmhist.html	1.03 KB	-rw-r--r--
pgmkernel.html	2.26 KB	-rw-r--r--
pgmmake.html	1.72 KB	-rw-r--r--
pgmmedian.html	3.39 KB	-rw-r--r--
pgmminkowski.html	3.48 KB	-rw-r--r--
pgmmorphconv.html	3.87 KB	-rw-r--r--
pgmnoise.html	1.86 KB	-rw-r--r--
pgmnorm.html	504 B	-rw-r--r--
pgmoil.html	492 B	-rw-r--r--
pgmramp.html	2.7 KB	-rw-r--r--
pgmslice.html	478 B	-rw-r--r--
pgmtexture.html	2.16 KB	-rw-r--r--
pgmtofs.html	1.08 KB	-rw-r--r--
pgmtolispm.html	1.81 KB	-rw-r--r--
pgmtopbm.html	1.58 KB	-rw-r--r--
pgmtopgm.html	1.64 KB	-rw-r--r--
pgmtoppm.html	4.08 KB	-rw-r--r--
pi1toppm.html	1.17 KB	-rw-r--r--
pi3topbm.html	1.12 KB	-rw-r--r--
picttoppm.html	5.36 KB	-rw-r--r--
pjtoppm.html	1.27 KB	-rw-r--r--
pktopbm.html	2.04 KB	-rw-r--r--
pngtopam.html	8.02 KB	-rw-r--r--
pngtopnm.html	1.87 KB	-rw-r--r--
pnm.html	1.86 KB	-rw-r--r--
pnmalias.html	2.81 KB	-rw-r--r--
pnmarith.html	752 B	-rw-r--r--
pnmcat.html	2.42 KB	-rw-r--r--
pnmcolormap.html	8.08 KB	-rw-r--r--
pnmcomp.html	2.05 KB	-rw-r--r--
pnmconvol.html	11.35 KB	-rw-r--r--
pnmcrop.html	6.18 KB	-rw-r--r--
pnmcut.html	1000 B	-rw-r--r--
pnmdepth.html	840 B	-rw-r--r--
pnmenlarge.html	534 B	-rw-r--r--
pnmfile.html	509 B	-rw-r--r--
pnmflip.html	953 B	-rw-r--r--
pnmgamma.html	12.02 KB	-rw-r--r--
pnmhisteq.html	6.31 KB	-rw-r--r--
pnmhistmap.html	5.21 KB	-rw-r--r--
pnmindex.html	3.14 KB	-rw-r--r--
pnminterp.html	569 B	-rw-r--r--
pnminvert.html	1.27 KB	-rw-r--r--
pnmmargin.html	1.77 KB	-rw-r--r--
pnmmercator.html	5.44 KB	-rw-r--r--
pnmmontage.html	4.49 KB	-rw-r--r--
pnmnlfilt.html	7.24 KB	-rw-r--r--
pnmnoraw.html	751 B	-rw-r--r--
pnmnorm.html	10.82 KB	-rw-r--r--
pnmpad.html	4.78 KB	-rw-r--r--
pnmpaste.html	3.63 KB	-rw-r--r--
pnmpsnr.html	2.1 KB	-rw-r--r--
pnmquant.html	2.39 KB	-rw-r--r--
pnmremap.html	10.68 KB	-rw-r--r--
pnmrotate.html	4.94 KB	-rw-r--r--
pnmscale.html	1.01 KB	-rw-r--r--
pnmscalefixed.html	2.66 KB	-rw-r--r--
pnmshear.html	3.81 KB	-rw-r--r--
pnmsmooth.html	3.24 KB	-rw-r--r--
pnmsplit.html	676 B	-rw-r--r--
pnmstitch.html	4.03 KB	-rw-r--r--
pnmtile.html	1.4 KB	-rw-r--r--
pnmtoddif.html	2.26 KB	-rw-r--r--
pnmtofiasco.html	10.94 KB	-rw-r--r--
pnmtofits.html	495 B	-rw-r--r--
pnmtojbig.html	9.61 KB	-rw-r--r--
pnmtojpeg.html	21.33 KB	-rw-r--r--
pnmtopalm.html	9.55 KB	-rw-r--r--
pnmtopclxl.html	6 KB	-rw-r--r--
pnmtoplainpnm.html	733 B	-rw-r--r--
pnmtopng.html	17.96 KB	-rw-r--r--
pnmtopnm.html	2.51 KB	-rw-r--r--
pnmtops.html	15.06 KB	-rw-r--r--
pnmtorast.html	1.53 KB	-rw-r--r--
pnmtorle.html	3.25 KB	-rw-r--r--
pnmtosgi.html	1.96 KB	-rw-r--r--
pnmtosir.html	1.14 KB	-rw-r--r--
pnmtotiff.html	495 B	-rw-r--r--
pnmtotiffcmyk.html	7.16 KB	-rw-r--r--
pnmtoxwd.html	1.69 KB	-rw-r--r--
ppm.html	6.75 KB	-rw-r--r--
ppm3d.html	4.3 KB	-rw-r--r--
ppmbrighten.html	5.67 KB	-rw-r--r--
ppmchange.html	5.5 KB	-rw-r--r--
ppmcie.html	13.67 KB	-rw-r--r--
ppmcolormask.html	3.95 KB	-rw-r--r--
ppmcolors.html	497 B	-rw-r--r--
ppmdcfont.html	1.63 KB	-rw-r--r--
ppmddumpfont.html	1.11 KB	-rw-r--r--
ppmdim.html	1.34 KB	-rw-r--r--
ppmdist.html	2.07 KB	-rw-r--r--
ppmdither.html	2.05 KB	-rw-r--r--
ppmdmkfont.html	1.26 KB	-rw-r--r--
ppmdraw.html	8.33 KB	-rw-r--r--
ppmfade.html	4.86 KB	-rw-r--r--
ppmflash.html	2.04 KB	-rw-r--r--
ppmforge.html	16.43 KB	-rw-r--r--
ppmglobe.html	4.93 KB	-rw-r--r--
ppmhist.html	4.72 KB	-rw-r--r--
ppmlabel.html	5.82 KB	-rw-r--r--
ppmmake.html	1.9 KB	-rw-r--r--
ppmmix.html	1.35 KB	-rw-r--r--
ppmnorm.html	538 B	-rw-r--r--
ppmntsc.html	3.06 KB	-rw-r--r--
ppmpat.html	2.65 KB	-rw-r--r--
ppmquant.html	2.82 KB	-rw-r--r--
ppmquantall.html	2.16 KB	-rw-r--r--
ppmrainbow.html	3.37 KB	-rw-r--r--
ppmrelief.html	1.25 KB	-rw-r--r--
ppmrough.html	4.88 KB	-rw-r--r--
ppmshadow.html	10.07 KB	-rw-r--r--
ppmshift.html	2.4 KB	-rw-r--r--
ppmspread.html	1.37 KB	-rw-r--r--
ppmsvgalib.html	4.55 KB	-rw-r--r--
ppmtoacad.html	5.64 KB	-rw-r--r--
ppmtoarbtxt.html	5.09 KB	-rw-r--r--
ppmtobmp.html	3.99 KB	-rw-r--r--
ppmtoeyuv.html	1.28 KB	-rw-r--r--
ppmtogif.html	2.63 KB	-rw-r--r--
ppmtoicr.html	3.77 KB	-rw-r--r--
ppmtoilbm.html	5.25 KB	-rw-r--r--
ppmtojpeg.html	590 B	-rw-r--r--
ppmtoleaf.html	1.15 KB	-rw-r--r--
ppmtolj.html	1.97 KB	-rw-r--r--
ppmtomap.html	1.12 KB	-rw-r--r--
ppmtomitsu.html	4.1 KB	-rw-r--r--
ppmtompeg-par.gif	36.52 KB	-rw-r--r--
ppmtompeg-snr.gif	2.3 KB	-rw-r--r--
ppmtompeg.html	45.06 KB	-rw-r--r--
ppmtoneo.html	1.18 KB	-rw-r--r--
ppmtopcx.html	5.92 KB	-rw-r--r--
ppmtopgm.html	2.09 KB	-rw-r--r--
ppmtopi1.html	1.14 KB	-rw-r--r--
ppmtopict.html	1.67 KB	-rw-r--r--
ppmtopj.html	2.89 KB	-rw-r--r--
ppmtopjxl.html	3.02 KB	-rw-r--r--
ppmtoppm.html	1.8 KB	-rw-r--r--
ppmtopuzz.html	1.17 KB	-rw-r--r--
ppmtorgb3.html	1.55 KB	-rw-r--r--
ppmtosixel.html	2.67 KB	-rw-r--r--
ppmtoterm.html	2.79 KB	-rw-r--r--
ppmtotga.html	541 B	-rw-r--r--
ppmtouil.html	395 B	-rw-r--r--
ppmtowinicon.html	3.96 KB	-rw-r--r--
ppmtoxpm.html	6.95 KB	-rw-r--r--
ppmtoyuv.html	2.84 KB	-rw-r--r--
ppmtoyuvsplit.html	1.92 KB	-rw-r--r--
ppmtv.html	1.58 KB	-rw-r--r--
ppmwheel.html	1.84 KB	-rw-r--r--
psidtopgm.html	1.88 KB	-rw-r--r--
pstopnm.html	13.03 KB	-rw-r--r--
qrttoppm.html	982 B	-rw-r--r--
rasttopnm.html	1.26 KB	-rw-r--r--
rawtopgm.html	5.19 KB	-rw-r--r--
rawtoppm.html	2.98 KB	-rw-r--r--
rgb3toppm.html	1.27 KB	-rw-r--r--
rlatopam.html	1.34 KB	-rw-r--r--
rletopnm.html	3.79 KB	-rw-r--r--
sbigtopgm.html	1.3 KB	-rw-r--r--
sgitopnm.html	2.02 KB	-rw-r--r--
sirtopnm.html	1.22 KB	-rw-r--r--
sldtoppm.html	5.89 KB	-rw-r--r--
spctoppm.html	1.08 KB	-rw-r--r--
spottopgm.html	2.62 KB	-rw-r--r--
sputoppm.html	1.09 KB	-rw-r--r--
testimg.png	48.11 KB	-rw-r--r--
testimg_histbar.png	1.08 KB	-rw-r--r--
testimg_histdot.png	1014 B	-rw-r--r--
tgatoppm.html	2.12 KB	-rw-r--r--
thinkjettopbm.html	1.75 KB	-rw-r--r--
tifftopnm.html	13.08 KB	-rw-r--r--
vidtoppm.html	755 B	-rw-r--r--
wbmptopbm.html	1.31 KB	-rw-r--r--
winicontoppm.html	2.64 KB	-rw-r--r--
xbmtopbm.html	1.04 KB	-rw-r--r--
ximtoppm.html	2.14 KB	-rw-r--r--
xpmtoppm.html	2.62 KB	-rw-r--r--
xvminitoppm.html	1.38 KB	-rw-r--r--
xwdtopnm.html	4.34 KB	-rw-r--r--
ybmtopbm.html	1.12 KB	-rw-r--r--
yuvsplittoppm.html	1.68 KB	-rw-r--r--
yuvtoppm.html	1.54 KB	-rw-r--r--
zeisstopnm.html	1.33 KB	-rw-r--r--

Code Editor : libpm.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html> <head>
<title>Libnetbpm Utility Functions</title>
<meta name="manual_section" content="3">
</head>
<body>
<h1>Libnetpbm Utility Functions</h1>
Updated: 27 August 2006
 
<A HREF="#toc">Table Of Contents</A>

These library functions are part of <a href="index.html">Netpbm</a>.

This page documents functions in the Netpbm subroutine library that
are not directly related to image data.

For introductory and general information using libnetpbm, see
<a href="libnetpbm_ug.html">Libnetpbm User's Guide</a>.

The most commonly used libnetpbm functions are those that
read and write and process Netpbm images. Those are documented in <a
href="libnetpbm_image.html">Libnetpbm Netpbm Image Processing
Manual</a>

To use these services, #include pam.h.

<H2 id="functions">Functions</H2>

<h3 id="initialization">Initialization</h3>

<h4>Overview</h4>

void pm_init(
const char * progname,
unsigned int flags[]
);

void pm_proginit(
int * argcP,
char * argv[]
);

<h4>Description</h4>

All Netpbm programs must call pm_proginit() just after
startup, before they process their arguments. pm_proginit(),
among other things, processes Netpbm universal arguments and removes
them from the argument list.

A program that isn't a Netpbm program, but just uses libnetpbm
services, need not invoke pm_proginit. But such a program
must invoke pm_init().

By &quot;Netpbm program,&quot; we mean a program that is part of
the Netpbm package or is intended to act like one. pm_proginit()
does things that all Netpbm programs do by convention. For example,
it scans the argument list for <a href="index.html#commonoptions">
common options</a>, handles them, and removes them from the argument
list. Ergo, if you want your program to have the same common options
as those in the Netpbm package, you might use pm_proginit(),
and if you don't, you must not.

pm_proginit() is primarily intended for Netpbm developers,
so you should not expect it to have stable function across releases,
and you must go to the comments in the source code to see exactly what
it does.

Any program that uses libnetpbm but does not call
pm_proginit (i.e. is not a Netpbm program) must call
pm_init(). The conventional place to do this is at the very
beginning of the program. This sets up some program-global variables
for use by the libnetpbm functions.

The progname argument is the program name for
libnetpbm functions to use in messages they issue. Normally,
you would use argv[0] for this.

flags is meaningless, but for forward compatibility, you
must set it to zero.

pm_init() and pm_proginit() have been around at least
since Netpbm 9.25 (March 2002). Another function named
pm_init() exists in older Netpbm, but was for internal use.
Netpbm programs of that era use pbm_init(), etc to do what
pm_proginit() does today. Today, pbm_init(), etc. exist
for backward compatibility and are identical the pm_proginit().

<h3 id="file">File Or Image Stream Access</h3>

<h4>Overview</h4>

FILE *pm_openr(
char * name
);

FILE *pm_openw(
char * name
);

FILE *pm_openr_seekable(
const char * name
);

FILE *pm_close(
FILE * fp
);

void pm_tell2(
FILE * fileP,
pm_filepos * fileposP,
unsigned int fileposSize
);

unsigned int pm_tell(
FILE * fileP
);

void pm_seek2(
FILE * fileP,
const pm_filepos * fileposP,
unsigned int fileposSize
);

void pm_seek(
FILE * fileP,
unsigned long filepos
);

char *pm_read_unknown_size(
FILE * fp,
long * nread
);

<h4>Description</h4>

An image stream is just a file stream (represented in the standard C
library as type FILE *).

These routines work on files &gt; 2 GiB if the underlying system does,
using the standard large file interface. Before Netpbm 10.15 (April 2003),
though, they would fail to open any file that large or process any offset
in a file that could not be represented in 32 bits.

pm_openr() opens the given file for reading, with
appropriate error checking. A filename of - is taken to mean
Standard Input. pm_openw() opens the given file for writing,
with appropriate error checking. pm_close() closes the file
descriptor, with appropriate error checking.

pm_openr_seekable() appears to open the file just like
pm_openr(), but the file thus opened is guaranteed to be
seekable (you can use ftell() and fseek() on it).
pm_openr_seekable() pulls this off by copying the entire file
to a temporary file and giving you the handle of the temporary file,
if it has to. If the file you name is a regular file, it's already
seekable so pm_openr_seekable() just does the same thing as
pm_openr().

But if it is, say, a pipe, it isn't seekable. So
pm_openr_seekable() reads the pipe until EOF into a temporary
file, then opens that temporary file and returns the handle of the
temporary file. The temporary file is seekable. The file
pm_openr_seekable() creates is one that the operating system
recognizes as temporary, so when you close the file, by any means, it
gets deleted.

You need a seekable file if you intend to make multiple passes through
the file. The only alternative is to read the entire image into
memory and work from that copy. That may use too much memory. Note
that the image takes less space in the file cache than in a buffer in
memory. As much as 96 times less space! Each sample is an integer in
the buffer, which is usually 96 bits. In the file, a sample may be as
small as 1 bit and rarely more than 8 bits.

pm_tell2() returns a handle for the current position of the
image stream (file), whether it be the header or a row of the raster.
Use the handle as an argument to pm_seek2() to reposition the
file there later. The file must be seekable (which you can ensure by
opening it with pm_openr_seekable()) or this may fail.

The file position handle is of type pm_filepos, which is
intended to be opaque, i.e. used only with these two functions. In
practice, it is a file offset and is 32 bits or 64 bits depending upon
the capability of the underlying system. For maximum backward and
forward compatibility, the functions that take or return a
pm_filepos have a fileposSize argument for the size of
the data structure. In C, simply code sizeof(pm_filepos) for
that.

pm_seek() and pm_tell are for backward compatibility
only. Do not use them in new code. These functions are not capable of
handle positions in files whose byte offset cannot be represented in 32
bits.

pm_tell2() and pm_seek2() replaced pm_tell() and
pm_seek() in Netpbm 10.15 (April 2003).

pm_read_unknown_size() reads an entire file or input stream
of unknown size to a buffer. It allocates more memory as needed. The
calling routine has to free the allocated buffer with free().

pm_read_unknown_size() returns a pointer to the allocated
buffer. The nread argument returns the number of bytes read.

<h3 id="endian">Endian I/O</h3>

<h4>Entry Points</h4>

void pm_readchar(
FILE * in,
char * sP
);

void pm_writechar(
FILE * out,
char s
);

int pm_readbigshort(
FILE * in,
short * sP
);

int pm_writebigshort(
FILE * out,
short s
);

int pm_readbiglong(
FILE * in,
long * lP
);

int pm_writebiglong(
FILE * out,
long l
);

int pm_readlittleshort(
FILE * in,
short * sP
);

int pm_writelittleshort(
FILE * out,
short s
);

int pm_readlittlelong(
FILE * in,
long * lP
);

int pm_writelittlelong(
FILE * out,
long l
);

void pm_readcharu(
FILE * in,
char * sP
);

void pm_writecharu(
FILE * out,
char s
);

int pm_readbigshortu(
FILE * in,
short * sP
);

int pm_writebigshortu(
FILE * out,
short s
);

int pm_readbiglongu(
FILE * in,
long * lP
);

int pm_writebiglongu(
FILE * out,
long l
);

int pm_readlittleshortu(
FILE * in,
short * sP
);

int pm_writelittleshortu(
FILE * out,
short s
);

int pm_readlittlelongu(
FILE * in,
long * lP
);

int pm_writelittlelongu(
FILE * out,
long l
);

<h4>Description</h4>

pm_readchar(), pm_writechar(), pm_readbigshort(),
pm_writebigshort(), pm_readbiglong(),
pm_writebiglong(), pm_readlittleshort(),
pm_writelittleshort(), pm_readlittlelong(), and
pm_writelittlelong() are routines to read and write 1-byte,
2-byte, and 4-byte pure binary integers in either big- or
little-endian byte order. Note that a &quot;long int&quot; C type might
be wider than 4 bytes, but the &quot;long&quot; routines still read and
write 4 bytes.

pm_readbiglongu(), etc. (names ending in u) are the same
except they work on unsigned versions of the type.

The routines with declared return values always return 0. Before
Netpbm 10.27 (March 2005), they returned -1 on failure, including EOF.
Now, they issue an error message to Standard Error and abort the program
if the I/O fails or encounters EOF.

The 1-byte routines were new in Netpbm 10.27 (March 2005).
The unsigned versions were new somewhere around Netpbm 10.21 (2004).

<H3 id="maxval">Maxval Arithmetic</H3>

<h4>Entry Points</h4>

int pm_maxvaltobits(
int maxval
);

int pm_bitstomaxval(
int bits
);

unsigned int pm_lcm(
unsigned int x,
unsigned int y,
unsigned int z,
unsigned int limit
);

<h4>Description</h4>

pm_maxvaltobits() and pm_bitstomaxval() convert
between a maxval and the minimum number of bits required to hold it.

pm_lcm() computes the least common multiple of 3 integers.
You also specify a limit and if the LCM would be higher than that
limit, pm_lcm() just returns that limit.

<H3 id="gamma">Gamma Arithmetic</H3>

<h4>Entry Points</h4>

float pm_gamma709(
float intensity
);

float pm_ungamma709(
float brightness
);

<h4>Description</h4>

In graphics processing, there are two common ways of representing
numerically the intensity of a pixel, or a component of a pixel.

The obvious way is with a number that is directly proportional to
the light intensity (e.g. 10 means twice as many milliwatts per square
centimeter as 5). There are two problems with this:

<ul>
 <li>To the human eye, a 1 milliwatt per square centimeter difference
 in a bright image is much less apparent than a 1 milliwatt per
 square centimeter difference in a dark image. So if you have
 a fixed number of bits in which to store the intensity value,
 you're wasting resolution at the bright end and skimping on it at
 the dark end.
 <li>Monitor inputs and camera outputs aren't directly proportional to
 the light intensity they project or detect.
</ul>

For these reasons, light intensities are often represented in
graphics processing by an exponential scale. The transfer function is
called a gamma function and the resulting numbers are called
gamma-corrected or gamma-adjusted. There are various gamma functions.
The Netpbm formats specify that intensities are represented by
gamma-adjusted numbers of a particular gamma transfer function.

These functions let you convert back and forth between these two
scales, using the same gamma transfer function that is specified in the
Netpbm format specifications.

pm_gamma709 converts from an intensity-proportional intensity
value to a gamma-adjusted intensity value (roughly proportional to
brightness, which is the human subjective perception of intensity),
using the ITU-R Recommendation BT.709 gamma transfer function.

pm_ungamma709 is the inverse of pm_gamma709.

<H3 id="message">Messages</H3>

<h4>Overview</h4>

void pm_message(
char * fmt,
... );

void pm_setusermessagefn(pm_usermessagefn * function);

<h4>Description</h4>

pm_message() is a printf() style routine to write an
informational message to the Standard Error file stream.
pm_message() suppresses the message, however, if the user
specified the -quiet <a href="index.html#commonoptions">common
option</a> on the command line. Note that Netpbm programs are often
used interactively, but also often used by programs. In the
interactive case, it is nice to issue messages about what the program
is doing, but in the program case, such messages are usually
undesirable. By using pm_message() for all your messages, you
make your program usable in both cases. Without any effort on your
part, program users of your program can avoid the messages by
specifying the -quiet option.

Netpbm distinguishes between error messages and information
messages; pm_message() is just for informational messages. To
issue an error message, see
<a href="liberror.html#pm_errormsg">pm_errormsg()</a>.

pm_setusermessagefn registers a handler for informational
messages, called a user message routine. Any library function
(including pm_message()) that wants to issue an informational
message in the future will call that function with the message as an
argument instead of writing the message to Standard Error.

The argument the user message routine gets is English text designed
for human reading. It is just the text of the message; there is no
attempt at formatting in it (so you won't see any newline or tab
characters).

To capture error messages in addition to informational messages,
see
<a href="liberror.html#pm_setusererrormsgfn">pm_setusererrormsgfn()</a>.

You can remove the user message routine, so that the library issues
future informational messages in its default way (write to Standard
Error) by specifying a null pointer for function.

Example:

<pre>
<code>
 static pm_usermessagefn logfilewrite;

static void
    logfilewrite(const char * const msg) {
        fprintf(mymsglog, &quot;Netpbm message: %s&quot;, msg);
    }

pm_setusermessagefn(&amp;logfilewrite);
 
 pm_message(&quot;Message for the message log&quot;);
</code>
</pre>

<h3 id="system">System Utilities</h3>

<ul>
<li><a href="libsystem.html">pm_system</a>
<li><a href="libtmpfile.html">pm_tmpfile</a>
</ul>

<H3 id="keyword">Keyword Matching</H3>

<h4>Entry Points</h4>

void pm_keymatch();

<h4>Description</h4>

This subroutine is obsolete. It used to be used for command line
option processing. Today, you can do better option processing more
easily with the shhopt facility. See any recent program in the Netpbm
package for an example.

pm_keymatch() does a case-insensitive match of str
against keyword. str can be a leading substring of
keyword, but at least minchars must be present.

<HR>
<H2 id="toc">Table Of Contents</H2>

<ul>
 <li><a href="#functions">Functions</a>
 <ul>
 <li><a href="#initialization">Initialization</a>
 <li><a href="#file">File Or Image Stream Access</a>
 <li><a href="#endian">Endian I/O</a>
 <li><a href="#maxval">Maxval Arithmetic</a>
 <li><a href="#gamma">Gamma Arithmetic</a>
 <li><a href="#message">Messages</a>
 <li><a href="#system">System Utilities</a>
 <li><a href="#keyword">Keyword Matching</a>
 </ul>
 </ul>

</body> </html>

${this.title}

Code Editor : libpm.html