From owner-freebsd-doc Sun Jul 16 11:10: 9 2000 Delivered-To: freebsd-doc@freebsd.org Received: from freefall.freebsd.org (freefall.FreeBSD.ORG [204.216.27.21]) by hub.freebsd.org (Postfix) with ESMTP id 2538937BAC7 for ; Sun, 16 Jul 2000 11:10:06 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.9.3/8.9.2) id LAA60708; Sun, 16 Jul 2000 11:10:06 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Date: Sun, 16 Jul 2000 11:10:06 -0700 (PDT) Message-Id: <200007161810.LAA60708@freefall.freebsd.org> To: freebsd-doc@freebsd.org Cc: From: Ben Smithurst Subject: Re: docs/19894: confusingly-named punctuation in style(9) Reply-To: Ben Smithurst Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org The following reply was made to PR docs/19894; it has been noted by GNATS. From: Ben Smithurst To: Sheldon Hearn Cc: FreeBSD-gnats-submit@FreeBSD.ORG Subject: Re: docs/19894: confusingly-named punctuation in style(9) Date: Sun, 16 Jul 2000 18:48:38 +0100 Sheldon Hearn wrote: >> -Usage statements should look like the manual pages synopsis. Options w/o >> +Usage statements should look like the manual pages synopsis. Options without > > Break that sentence off onto its own new line. :-) Doh! I was trying to change as few lines as possible to make the diff easier to read... > Options without operands come first, in alphabetical order > inside a single set of brackets, > followed by options with operands, in alphabetical order, > each in brackets, > followed by required arguments in the order they are specified, > not in brackets, > followed by optional arguments in the order they are specified, > in brackets. That's one long sentence. :-( > I think it might be better to do this as a bullet list. I guess that's an excuse for me to learn how to do bullet lists in mdoc. :-) mdoc.samples should explain all, I hope... -- Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D FreeBSD Documentation Project / To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message