diff options
author | mpp <mpp@FreeBSD.org> | 1996-02-12 05:17:28 +0000 |
---|---|---|
committer | mpp <mpp@FreeBSD.org> | 1996-02-12 05:17:28 +0000 |
commit | a3442b676bb2e6c36a4eb19a39be7684a128b261 (patch) | |
tree | 8273642bd20d70cba3a0f7be12d63d63f4aeaa3f /share/man | |
parent | 0796408d4a65a408fb888b67c7c5281e1c2b15f9 (diff) | |
download | FreeBSD-src-a3442b676bb2e6c36a4eb19a39be7684a128b261.zip FreeBSD-src-a3442b676bb2e6c36a4eb19a39be7684a128b261.tar.gz |
Add a pbm(5) (portable bitmap format) man page since we have a
few man pages that reference it.
Diffstat (limited to 'share/man')
-rw-r--r-- | share/man/man5/Makefile | 2 | ||||
-rw-r--r-- | share/man/man5/pbm.5 | 77 |
2 files changed, 78 insertions, 1 deletions
diff --git a/share/man/man5/Makefile b/share/man/man5/Makefile index 3eb8318..624f0fc 100644 --- a/share/man/man5/Makefile +++ b/share/man/man5/Makefile @@ -2,7 +2,7 @@ #MISSING: dump.5 plot.5 MAN5= a.out.5 acct.5 core.5 dir.5 disktab.5 ethers.5 fs.5 fbtab.5 fstab.5 \ - group.5 hosts.5 link.5 networks.5 passwd.5 phones.5 printcap.5 \ + group.5 hosts.5 link.5 networks.5 passwd.5 pbm.5 phones.5 printcap.5 \ procfs.5 protocols.5 remote.5 resolver.5 services.5 shells.5 \ stab.5 sysconfig.5 types.5 utmp.5 hosts.equiv.5 MLINKS= fs.5 inode.5 utmp.5 wtmp.5 utmp.5 lastlog.5 dir.5 dirent.5 \ diff --git a/share/man/man5/pbm.5 b/share/man/man5/pbm.5 new file mode 100644 index 0000000..6029920 --- /dev/null +++ b/share/man/man5/pbm.5 @@ -0,0 +1,77 @@ +.TH pbm 5 "27 September 1991" +.SH NAME +pbm - portable bitmap file format +.SH DESCRIPTION +The portable bitmap format is a lowest common denominator monochrome +file format. +.IX "PBM file format" +It was originally designed to make it reasonable to mail bitmaps +between different types of machines using the typical stupid network +mailers we have today. +Now it serves as the common language of a large family of bitmap +conversion filters. +The definition is as follows: +.IP - 2 +A "magic number" for identifying the file type. +A pbm file's magic number is the two characters "P1". +.IX "magic numbers" +.IP - 2 +Whitespace (blanks, TABs, CRs, LFs). +.IP - 2 +A width, formatted as ASCII characters in decimal. +.IP - 2 +Whitespace. +.IP - 2 +A height, again in ASCII decimal. +.IP - 2 +Whitespace. +.IP - 2 +Width * height bits, each either '1' or '0', starting at the top-left +corner of the bitmap, proceeding in normal English reading order. +.IP - 2 +The character '1' means black, '0' means white. +.IP - 2 +Whitespace in the bits section is ignored. +.IP - 2 +Characters from a "#" to the next end-of-line are ignored (comments). +.IP - 2 +No line should be longer than 70 characters. +.PP +Here is an example of a small bitmap in this format: +.nf +P1 +# feep.pbm +24 7 +0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 +0 1 1 1 1 0 0 1 1 1 1 0 0 1 1 1 1 0 0 1 1 1 1 0 +0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 1 0 +0 1 1 1 0 0 0 1 1 1 0 0 0 1 1 1 0 0 0 1 1 1 1 0 +0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 +0 1 0 0 0 0 0 1 1 1 1 0 0 1 1 1 1 0 0 1 0 0 0 0 +0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 +.fi +.PP +Programs that read this format should be as lenient as possible, +accepting anything that looks remotely like a bitmap. +.PP +There is also a variant on the format, available +by setting the RAWBITS option at compile time. This variant is +.IX RAWBITS +different in the following ways: +.IP - 2 +The "magic number" is "P4" instead of "P1". +.IP - 2 +The bits are stored eight per byte, high bit first low bit last. +.IP - 2 +No whitespace is allowed in the bits section, and only a single character +of whitespace (typically a newline) is allowed after the height. +.IP - 2 +The files are eight times smaller and many times faster to read and write. +.SH AUTHOR +Copyright (C) 1989, 1991 by Jef Poskanzer. +.\" Permission to use, copy, modify, and distribute this software and its +.\" documentation for any purpose and without fee is hereby granted, provided +.\" that the above copyright notice appear in all copies and that both that +.\" copyright notice and this permission notice appear in supporting +.\" documentation. This software is provided "as is" without express or +.\" implied warranty. |