< Previous PageNext Page >

A Simple Command Example

Listing 1-2 is an example of how to write an MPGL manual page for a single command or a series of commands with the same syntax.

Listing 5-2 A simple MPGL example for a command

<docdate>August 28, 2002</docdate>
<doctitle>Document title</doctitle>
        <name>foo<desc>this is a description</desc></name>
        <name>bar<desc>this is also a description</desc></name>
        <flag optional="1">a<arg>attributes</arg><desc>This is the atts flag</desc></flag>
        <flag>d<arg>date</arg><desc>This is the date flag</desc></flag>
        <flag>x<desc>This is the -x flag</desc></flag>
        <arg>filename<desc>This is the filename</desc></arg>
        <p>Returns kIONotANumber if you can't count.</p>
        <p>Returns kIOMoron if you REALLY can't count.</p>
        <file>/path/to/filename<desc>This is a waste of time</desc></file>
        <file>/path/to/another/filename<desc>This is also a waste of time</desc></file>
        <p>This is a text container, really, but generally contains
        lines like this:</p>
        <manpage>foo<section>1</section>, </manpage>
        <p>Here's a list of conformance:</p>
            <li>Single UNIX Specification</li>
        <p>Here's a definition list:</p>
                <dt>This is foo</dt>
                <dt>This is bar</dt>
        This program should be history....
        <p>Here are some bugs:</p>
                <li>Bug one....</li>
                <li>Bug two....</li>
                <li>Bug three....</li>
        <p>I think that pretty much covers it.</p>

< Previous PageNext Page >

© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (Last updated: 2004-05-27)