Laserfiche WebLink
?DESCRIPTION? (the main body of the man page containing background material, information, <br />etc.), ?OPTIONS? (the command line options for the program), ?SEE ALSO ? (cross-references to <br />other applicable man pages), and ? AUTHOR? (the author of the software). Other appropriate <br />sections may include (but are not limited to): ?DIAGNOSTICS? (explains the return status for <br />routines and programs), ? ACKNOWLEDGMENTS? (thanks to persons who supply information to <br />the author), and ? RESTRICTIONS? or ?LIMITATIONS ? (limitations in the software). <br />It was previously mentioned that it would be nice to use file extensions like ?.1CRDSS? or <br />man <br />?.3CRDSS?; however, the command will not recognize these file extensions. It is still possible <br />to make this information to appear in the visible form of man pages. To do this, put as the <br />1CRDSS <br />nroff <br />second data item to the (title header) command. The guidelines for specifying project- <br />.TH <br />specific extensions for man pages are being developed. <br />SGI Implementation of Man Pages <br />man(1) <br />Man pages on SGIs are implemented in a unique manner. The man page for describes this <br />file organization. In summary, the SGI supports two man page directories: <br />/usr/share/catman <br />( contains source files) and with the following ?whatis? files <br />/usr/share/man /usr/catman <br />being available: and . It is the <br />/usr/share/catman/whatis /usr/catman/whatis <br />consultants experience that the file should be removed because only the <br />/usr/catman/whatis <br />whatis <br /> file is created when the command is run (although <br />/usr/share/catman/whatis <br />apropos <br /> appears to use the file first!). The subdirectories under the <br />/usr/catman/whatis <br />directories listed above have an intermediate layer that seems to be unique to SGI machines. This <br />layer consists of directories with names like ?a_man?, ?g_man?, ?local?, ?p_man?, and ?u_man?, <br />man(1) <br />each of which may have the familiar ?man? and ?cat? subdirectories. The man page for <br />states that the order of searches for man pages is: <br />/usr/share/catman/local/cat* <br />/usr/share/catman/local/man* <br />/usr/catman/local/cat* <br />/usr/catman/local/man* <br />/usr/share/catman/[agpu]_man* <br />/usr/share/man <br />/usr/catman <br />/usr/man <br />In general, SGI ships only the compiled man pages with the software and these are installed in the <br /> and directories. Man pages that are shipped in the SGI <br />/usr/share/catman /usr/catman <br />?inst? format should be installed where they are designed to be installed to avoid problems. The <br />pack <br />compiled man pages can be compressed with the command, which results in the compiled files <br />having the additional extension ?.z?. The packed files take up less space on the system but require <br />man <br />the command to execute an additional unpack step when displaying man pages. <br />A simple solution for creating a man page structure for CRDSS that is flexible and that allows for <br />porting to non-SGI platforms in the future is to select a directory in the supported man command <br />search pattern that is not used by SGI. This will allow CRDSS man pages to be installed without <br />having to worry about mixing with SGI man pages. This can be done easily by creating the directory <br />structure: <br />/usr/local/man/man1 <br />9 <br />A275 06.29.94 1.05-12 Malers <br />