Le 20/10/2010 05:50, Jan Hauke Rahm a écrit : > Hi guys, Hi, > I have a slightly off-topic request. Would one of you be so kind and > review a man page of a tool that I and a friend of mine have written > recently and would like to include in Debian soon? Here is the beginning of a “form-only” proposition, in order to follow usual conventions as described in man(1), and usually adopted. Some comment about the proposed changes. Do you want me to continue the changes on the rest of the manual page? Here are some explanations: -\fBenum\fR [ \fIOPTIONS\fR ] \fILEFT\fR "\&.\&." [...] +\fBenum\fR [ \fIOPTIONS\fR ] \fILEFT\fR [\fB\&.\&.\fR] [...] If I'm not mistaken *..* is optional (thus within [ ]), and should be typed exactly as shown (thus bold) -Further details on [...] are covered in \fIUSAGE IN DETAIL\fR\&. +Further details on [...] are covered in \fBUSAGE IN DETAIL\fR\&. Title of section are usually typed as they are showed: in bold. -\fB\-i, \-\-seed\fR=\fINUMBER\fR +\fB\-i\fR, \fB\-\-seed=\fINUMBER\fR The comma should not be typed, so not in bold, but the equal sign should, so in bold. Cheers David
--- /tmp/enum.1 2010-10-20 16:36:31.000000000 -0400 +++ /tmp/enum-taffit.1 2010-10-20 17:41:41.000000000 -0400 @@ -32,7 +32,7 @@ .SH "SYNOPSIS" .SS "GENERAL" .sp -\fBenum\fR [ \fIOPTIONS\fR ] \fILEFT\fR "\&.\&." \fICOUNT\fR"x" \fISTEP\fR "\&.\&." \fIRIGHT\fR +\fBenum\fR [ \fIOPTIONS\fR ] \fILEFT\fR [\fB\&.\&.\fR] \fICOUNT\fR[\fBx\fR] \fISTEP\fR [\fB\&.\&.\fR] \fIRIGHT\fR .SS "SHORTCUTS" .sp \fBenum\fR [ \fIOPTIONS\fR ] \fILEFT\fR \fISTEP\fR \fIRIGHT\fR @@ -44,9 +44,9 @@ \&... .SH "DESCRIPTION" .sp -\fBenum\fR enumerates values (numbers) from \fILEFT\fR to \fIRIGHT\fR adding/subtracting \fISTEP\fR each time\&. If \fISTEP\fR is not provided it is implied\&. No more than \fICOUNT\fR values are printed\&. Before printing, values are passed through a formatter\&. Please see \fIOPTIONS\fR for details on controlling the formatter or \fIEXAMPLES\fR for use cases\&. +\fBenum\fR enumerates values (numbers) from \fILEFT\fR to \fIRIGHT\fR adding/subtracting \fISTEP\fR each time\&. If \fISTEP\fR is not provided it is implied\&. No more than \fICOUNT\fR values are printed\&. Before printing, values are passed through a formatter\&. Please see \fBOPTIONS\fR for details on controlling the formatter or \fBEXAMPLES\fR for use cases\&. .sp -Further details on usage of \fBenum\fR are covered in \fIUSAGE IN DETAIL\fR\&. +Further details on usage of \fBenum\fR are covered in \fBUSAGE IN DETAIL\fR\&. .SH "EXAMPLES" .SS "USE IN FOR\-LOOPS" .sp @@ -99,12 +99,12 @@ .SH "OPTIONS" .SS "RANDOM MODE" .PP -\fB\-r, \-\-random\fR +\fB\-r\fR, \fB\-\-random\fR .RS 4 Produces random numbers instead of monotone sequences, potentially with duplicates\&. .RE .PP -\fB\-i, \-\-seed\fR=\fINUMBER\fR +\fB\-i\fR, \fB\-\-seed=\fINUMBER\fR .RS 4 Pass \fINUMBER\fR
Attachment:
signature.asc
Description: OpenPGP digital signature