diff options
| author |   schwarze <schwarze@openbsd.org> | 2011-11-01 14:49:16 +0000 |
|---|---|---|
| committer | schwarze <schwarze@openbsd.org> | 2011-11-01 14:49:16 +0000 |
| commit | 201df4c24cfd5c2fe86b4710325f8e7ba3f41c1a (patch) | |
| tree | e4b19455ebf0a2681484aeb233f342232ce1ab2e /share/man/man7 | |
| parent | Security fix for CVE-2011-2939, Perl decode_xs heap-based buffer overflow. (diff) | |
| download | wireguard-openbsd-201df4c24cfd5c2fe86b4710325f8e7ba3f41c1a.tar.xz wireguard-openbsd-201df4c24cfd5c2fe86b4710325f8e7ba3f41c1a.zip | |
Clean up the description of .Dt:
- Volume and arch are both optional and not alternatives.
- Zap verbiage about what's obvious from the synopsis.
- For fixed argument strings, use .Cm, not .Ar.
- Update the list of architectures for OpenBSD.
Using lots of input from jmc@.
Diffstat (limited to 'share/man/man7')
| -rw-r--r-- | share/man/man7/mdoc.7 | 74 |
1 files changed, 36 insertions, 38 deletions
diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 519412bface..d91fdc1bcb6 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.7,v 1.89 2011/09/27 21:47:54 schwarze Exp $ +.\" $OpenBSD: mdoc.7,v 1.90 2011/11/01 14:49:16 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org> @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: September 27 2011 $ +.Dd $Mdocdate: November 1 2011 $ .Dt MDOC 7 .Os .Sh NAME @@ -1282,7 +1282,8 @@ Its syntax is as follows: .Ar title .Oo .Ar section -.Op Ar volume | arch +.Op Ar volume +.Op Ar arch .Oc .Oc .Ed @@ -1363,41 +1364,38 @@ or .Ar CON .Pq contributed manuals . .It Ar arch -This specifies a specific relevant architecture. -If -.Ar volume -is not provided, it may be used in its place, else it may be used -subsequent that. -It, too, is optional. -It must be one of -.Ar alpha , -.Ar amd64 , -.Ar amiga , -.Ar arc , -.Ar arm , -.Ar armish , -.Ar aviion , -.Ar hp300 , -.Ar hppa , -.Ar hppa64 , -.Ar i386 , -.Ar landisk , -.Ar loongson , -.Ar luna88k , -.Ar mac68k , -.Ar macppc , -.Ar mips64 , -.Ar mvme68k , -.Ar mvme88k , -.Ar pmax , -.Ar sgi , -.Ar socppc , -.Ar sparc , -.Ar sparc64 , -.Ar sun3 , -.Ar vax , -or -.Ar zaurus . +This specifies the machine architecture a manual page applies to, +where relevant. +For +.Ox , +the following are valid architectures: +.Cm alpha , +.Cm amd64 , +.Cm armish , +.Cm aviion , +.Cm beagle , +.Cm hp300 , +.Cm hppa , +.Cm hppa64 , +.Cm i386 , +.Cm ia64 , +.Cm landisk , +.Cm loongson , +.Cm luna88k , +.Cm mac68k , +.Cm macppc , +.Cm mips64 , +.Cm mvme68k , +.Cm mvme88k , +.Cm palm , +.Cm sgi , +.Cm socppc , +.Cm solbourne , +.Cm sparc , +.Cm sparc64 , +.Cm vax , +and +.Cm zaurus . .El .Pp Examples: |