openafs/doc/man-pages/pod1/translate_et.pod
Russ Allbery fc5acc0151 pretty-html-synopsis-20060228
Implement proper synopsis wrapping for HTML generation.

This was done in three pieces.  First, add HTML-specific tags to the POD to
mark the synopsis for HTML purposes so that we can apply style information
to it.  Second, update the style sheet to indent all lines except for the
first in the synopsis section.  Third, add the appropriate S<> tags around
option and argument pairs so that we don't wrap between the option and its
argument.

Unfortunately, due to the <I<foo>> style that looks nicer for other reasons,
we have to use the very verbose S<<< >>>.  Oh well.
2006-03-01 05:02:29 +00:00

52 lines
1004 B
Plaintext

=head1 NAME
translate_et - Translates numbered error codes into text messages
=head1 SYNOPSIS
=for html
<div class="synopsis">
S<<< B<translate_et> <I<error number>>+ >>>
=for html
</div>
=head1 DESCRIPTION
The B<translate_et> command translates each specified error number into a
text message.
This command does not use the syntax conventions of the AFS command
suites. Provide the command name in full.
=head1 OPTIONS
=over 4
=item <I<error number>>+
Specifies each error number to translate.
=back
=head1 EXAMPLES
The following command translates the error numbers 1 and 4:
% translate_et 1 4
1 ().1 = Not owner
4 ().4 = Interrupted system call
=head1 PRIVILEGE REQUIRED
None
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.