standards: Manual Structure Details

1 
1 6.3 Manual Structure Details
1 ============================
1 
1 The title page of the manual should state the version of the programs or
1 packages documented in the manual.  The Top node of the manual should
1 also contain this information.  If the manual is changing more
1 frequently than or independent of the program, also state a version
1 number for the manual in both of these places.
1 
1    Each program documented in the manual should have a node named
1 'PROGRAM Invocation' or 'Invoking PROGRAM'.  This node (together with
1 its subnodes, if any) should describe the program's command line
1 arguments and how to run it (the sort of information people would look
1 for in a man page).  Start with an '@example' containing a template for
1 all the options and arguments that the program uses.
1 
1    Alternatively, put a menu item in some menu whose item name fits one
1 of the above patterns.  This identifies the node which that item points
1 to as the node for this purpose, regardless of the node's actual name.
1 
1    The '--usage' feature of the Info reader looks for such a node or
1 menu item in order to find the relevant text, so it is essential for
1 every Texinfo file to have one.
1 
1    If one manual describes several programs, it should have such a node
1 for each program described in the manual.
1