home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / OSK / NETWORK / netpbm_docs.lzh / NETPBM / DOCS / ppm.5 < prev    next >
Text File  |  1996-11-18  |  3KB  |  94 lines
  1. .TH ppm 5 "27 September 1991"
  2. .SH NAME
  3. ppm - portable pixmap file format
  4. .SH DESCRIPTION
  5. The portable pixmap format is a lowest common denominator color image
  6. file format.
  7. .IX "PPM file format"
  8. The definition is as follows:
  9. .IP - 2
  10. A "magic number" for identifying the file type.
  11. A ppm file's magic number is the two characters "P3".
  12. .IX "magic numbers"
  13. .IP - 2
  14. Whitespace (blanks, TABs, CRs, LFs).
  15. .IP - 2
  16. A width, formatted as ASCII characters in decimal.
  17. .IP - 2
  18. Whitespace.
  19. .IP - 2
  20. A height, again in ASCII decimal.
  21. .IP - 2
  22. Whitespace.
  23. .IP - 2
  24. The maximum color-component value, again in ASCII decimal.
  25. .IP - 2
  26. Whitespace.
  27. .IP - 2
  28. Width * height pixels, each three ASCII decimal values between 0 and the
  29. specified maximum value, starting at the top-left
  30. corner of the pixmap, proceeding in normal English reading order.
  31. The three values for each pixel represent red, green, and blue, respectively;
  32. a value of 0 means that color is off, and the maximum value means that color
  33. is maxxed out.
  34. .IP - 2
  35. Characters from a "#" to the next end-of-line are ignored (comments).
  36. .IP - 2
  37. No line should be longer than 70 characters.
  38. .PP
  39. Here is an example of a small pixmap in this format:
  40. .nf
  41. P3
  42. # feep.ppm
  43. 4 4
  44. 15
  45.  0  0  0    0  0  0    0  0  0   15  0 15
  46.  0  0  0    0 15  7    0  0  0    0  0  0
  47.  0  0  0    0  0  0    0 15  7    0  0  0
  48. 15  0 15    0  0  0    0  0  0    0  0  0
  49. .fi
  50. .PP
  51. Programs that read this format should be as lenient as possible,
  52. accepting anything that looks remotely like a pixmap.
  53. .PP
  54. There is also a variant on the format, available
  55. by setting the RAWBITS option at compile time.  This variant is
  56. different in the following ways:
  57. .IX RAWBITS
  58. .IP - 2
  59. The "magic number" is "P6" instead of "P3".
  60. .IP - 2
  61. The pixel values are stored as plain bytes, instead of ASCII decimal.
  62. .IP - 2
  63. Whitespace is not allowed in the pixels area, and only a single character
  64. of whitespace (typically a newline) is allowed after the maxval.
  65. .IP - 2
  66. The files are smaller and many times faster to read and write.
  67. .PP
  68. Note that this raw format can only be used for maxvals less than
  69. or equal to 255.
  70. If you use the
  71. .I ppm 
  72. library and try to write a file with a larger maxval,
  73. it will automatically fall back on the slower but more general plain
  74. format.
  75. .SH "SEE ALSO"
  76. giftoppm(1), gouldtoppm(1), ilbmtoppm(1), imgtoppm(1), mtvtoppm(1),
  77. pcxtoppm(1), pgmtoppm(1), pi1toppm(1), picttoppm(1), pjtoppm(1), qrttoppm(1),
  78. rawtoppm(1), rgb3toppm(1), sldtoppm(1), spctoppm(1), sputoppm(1), tgatoppm(1),
  79. ximtoppm(1), xpmtoppm(1), yuvtoppm(1),
  80. ppmtoacad(1), ppmtogif(1), ppmtoicr(1), ppmtoilbm(1), ppmtopcx(1), ppmtopgm(1),
  81. ppmtopi1(1), ppmtopict(1), ppmtopj(1), ppmtopuzz(1), ppmtorgb3(1),
  82. ppmtosixel(1), ppmtotga(1), ppmtouil(1), ppmtoxpm(1), ppmtoyuv(1),
  83. ppmdither(1), ppmforge(1), ppmhist(1), ppmmake(1), ppmpat(1), ppmquant(1),
  84. ppmquantall(1), ppmrelief(1),
  85. pnm(5), pgm(5), pbm(5)
  86. .SH AUTHOR
  87. Copyright (C) 1989, 1991 by Jef Poskanzer.
  88. .\" Permission to use, copy, modify, and distribute this software and its
  89. .\" documentation for any purpose and without fee is hereby granted, provided
  90. .\" that the above copyright notice appear in all copies and that both that
  91. .\" copyright notice and this permission notice appear in supporting
  92. .\" documentation.  This software is provided "as is" without express or
  93. .\" implied warranty.
  94.