Manual page template

Here is a basic template for man pages, including all applicable headings:

   <HTML>
   <HEAD>
   <TITLE>Man page title(SECT)</TITLE>
   

<!-- var Contents = "/topicID/CONTENTS.html" var PrintSequence = "/topicID/CONTENTS.html" if ( parent.RightHistory != null ) parent.RightHistory(document.URL) // --> </SCRIPT>

</HEAD> <BODY> <H1>Man page title(SECT)</H1> <HR> <B>One-line description</B> <P> <H2>Synopsis</H2> <PRE> Syntax statement </PRE> Required for command, routine, and function; optional for file and structure; and not included in driver and X client manual pages. <H2>Description</H2> Required for all manual pages. <H2>Files</H2> Optional for all manual pages. <H2>Usage</H2> Optional for all manual pages. <H2>Resources</H2> Required for X client; not included for all other manual pages. <H2>Exit codes</H2> Required for commands; not included for all other manual pages. <H2>Return values</H2> Required for routine and function; not included for all other manual pages. <H2>Diagnostics</H2> Required for command, routine, and function; not included for file and structure; and optional for all other manual pages. <H2>Warnings</H2> Optional for all manual pages. <H2>References</H2> Required for all manual pages except X clients. <H2>Security restrictions</H2> Not included for routine, function, file, structure, and driver; optional for command and X client manual pages. <H2>Notices</H2> Optional for all manual pages. <H2>Examples</H2> Not included for driver and optional for all other manual pages. <H2>Backward compatibility</H2> Optional for all manual pages. <H2>Standards compliance</H2> Included on Intro manual pages only. <HR> </BODY></HTML>


© 1999 The Santa Cruz Operation, Inc. All rights reserved.
UnixWare 7 Release 7.1.1 - 5 November 1999