Article View: comp.text
Article #1538Re: man page standards
From: Neil Weisenfeld
Date: Wed, 26 Aug 1992 16:48
Date: Wed, 26 Aug 1992 16:48
31 lines
1684 bytes
1684 bytes
markm@iris.mincom.oz.au (Mark McCafferty) writes: : Are there any generic standards for the preparation of man pages? : We are using HP/UX nroff, using the 'an' macros. : : BTW are there any explanations of the 'an' macros? : : thx : mark Hmm, somehow I think this question wasn't really about the various standards committees that are working on the man macros...Maybe I'm wrong, but just in case I'm not... If you are interested in writing man pages (not writing man macros), the best reference you'll find is by doing "man 7 man" which should give you the documentation on the man macros. The classic book "The Unix Programming Environment" by Kernighan and Pike gives an intro to man page writing that should be good enough to get started. Also check out some of the man pages that are already there. Sometimes you find that they were generated automatically from (presumably) some other format, but you might find some that are intelligently done. --Neil -- Neil I. Weisenfeld National Institutes of Health Computer Engineer Building 12A, Room 2033 weisen@alw.nih.gov Bethesda, MD 20892 uunet!nih-csl!weisen phone: (301) 402-2788
Technical Details
Message-ID:
<1992Aug26.164857.13589@alw.nih.gov>Path:
arc1-ca.pugleaf.net!sparky!uunet!nih-csl!daedalus.dcrt.nih.gov!weisenReferences:
<2879@iris.mincom.oz.au>Show Full Headers
Complete Article Headers
Newsgroups: comp.text Path: arc1-ca.pugleaf.net!sparky!uunet!nih-csl!daedalus.dcrt.nih.gov!weisen From: weisen@daedalus.dcrt.nih.gov (Neil Weisenfeld) Subject: Re: man page standards Message-ID: <1992Aug26.164857.13589@alw.nih.gov> Sender: postman@alw.nih.gov (AMDS Postmaster) Organization: National Inst. of Health, DCRT, CSL X-Newsreader: Tin 1.1 PL4 References: <2879@iris.mincom.oz.au> Date: Wed, 26 Aug 1992 16:48:57 GMT Lines: 31