-
Notifications
You must be signed in to change notification settings - Fork 542
-
Notifications
You must be signed in to change notification settings - Fork 542
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
pod2man documentation on writing a man page #521
Comments
From The RT System itselfSince the goal is for this to be an eventual replacement for the current NOTES The name of the program being documented is conventionally written in References to other programs or functions are normally in the form of The major headers should be set out using a `=head1' directive, and are The standard sections of a manual page are: NAME foo, bar - programs to do something Manual page indexers are often extremely picky about the format of SYNOPSIS DESCRIPTION =head2 A Sample Subection =head2 Yet Another Sample Subection OPTIONS B<--section>=I<manext> Synonymous options (like both the short and long forms) are RETURN VALUE ERRORS DIAGNOSTICS EXAMPLES ENVIRONMENT FILES CAVEATS BUGS RESTRICTIONS NOTES SEE ALSO AUTHOR HISTORY In addition, some systems use CONFORMING TO to note conformance to Section ordering varies, although NAME should *always* be the first For additional information that may be more accurate for your specific -- |
@iabyn - Status changed from 'stalled' to 'resolved' |
Migrated from rt.perl.org#1368 (status was 'resolved')
Searchable as RT1368$
The text was updated successfully, but these errors were encountered: