Description

This article is from the Apple II GNO FAQ, by Devin Reade with numerous contributions by others.

3.5: I'm writing a manual page. What format should I use?

    A#3.5:	While man can handle both manually-edited preformatted pages and
pages that are aroff source (created by AppleWorks-GS or a
compatible editor), the recommended format is to use nroff source
with tmac "an" extensions.

The reason for this is that only nroff source can be reformatted
"on the fly" to suit different terminal characteristics.  See also
Q#3.7.
    

 

Continue to:

• prev: 3.4: I've just finished writing a new program (or library or whatever).What documentation should I include?
• Index
• next: 3.6: What should be in a manual page?

Share and Enjoy

Tags

pc, hardware, Apple II, Apple ][ or Apple //, apple, gno, unix