mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-16 10:20:30 +00:00
Code Issues Releases Activity

1. "braces" -> "brackets" when referring to [ and ].

Browse Source 
PR:		19894
Submitted by:	Tony Finch <dot@dotat.at>

2.   "brackets" -> "angle brackets" when referring to < and >.

3.  Clean up the bit about creating the usage() message.  After clarifying a
couple of points the sentence became rather long, and rather poor English, so
it was converted to a enumerated list instead.

parts 1, 2, 3:
Reviewed by:	sheldonh
This commit is contained in:
Ben Smithurst 2000-07-16 20:46:43 +00:00
parent e63d1b73d3
commit 044e09a0a8
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=63279
1 changed files with 27 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
share/man/man9/style.9
View File

@ -56,7 +56,7 @@ Kernel include files (i.e. sys/*.h) come first; normally, you'll need
OR <sys/param.h>, but not both! <sys/types.h> includes <sys/cdefs.h>,
and it's okay to depend on that.
.Bd -literal -offset 0i
#include <sys/types.h> /* Non-local includes in brackets. */
#include <sys/types.h> /* Non-local includes in angle brackets. */
.Ed
.Pp
If it's a network program, put the network include files next.
@ -470,16 +470,35 @@ Use
not fputs/puts/putchar/whatever; it's faster and usually cleaner, not
to mention avoiding stupid bugs.
.Pp
Usage statements should look like the manual pages synopsis. Options w/o
operands come first, in alphabetical order inside a single set of
braces, followed by options with operands, in alphabetical order,
each in braces, followed by required arguments in the order they
are specified, followed by optional arguments in the order they
are specified. A bar
Usage statements should look like the manual pages synopsis.
The usage statement should be structured in the following order:
.Pp
.Bl -enum -compat
.It
Options without operands come first,
in alphabetical order,
inside a single set of brackets.
.It
Options with operands come next,
also in alphabetical order,
with each option and its argument inside its own pair of brackets.
.It
Required arguments
.Pq if any
are next,
listed in the order they should be specified in the command line.
.It
Finally,
any optional arguments should be listed,
listed in the order they should be specified,
and all inside brackets.
.El
.Pp
A bar
.Pq Sq \&|
separates either-or options/arguments,
and multiple options/arguments which are specified together are
placed in a single set of braces.
placed in a single set of brackets.
.Pp
.Bd -ragged -offset 0.3i
"usage: f [-aDde] [-b b_arg] [-m m_arg] req1 req2 [opt1 [opt2]]\en"