diff options
| author |   Ingo Schwarze <schwarze@openbsd.org> | 2011-11-01 14:59:27 +0000 |
|---|---|---|
| committer | Ingo Schwarze <schwarze@openbsd.org> | 2011-11-01 14:59:27 +0000 |
| commit | 2c9cfb763db88e1a0c573ea2da8dac644f88f1f6 (patch) | |
| tree | ac54a8143717c16ffc7b37e30e27464293babab4 /mdoc.7 | |
| parent | 52d53c193cd7956397a9fae2a041aaef9aec2e5b (diff) | |
| download | mandoc-2c9cfb763db88e1a0c573ea2da8dac644f88f1f6.tar.gz mandoc-2c9cfb763db88e1a0c573ea2da8dac644f88f1f6.tar.zst mandoc-2c9cfb763db88e1a0c573ea2da8dac644f88f1f6.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.
Using lots of input from jmc@.
Also, state that the list of valid architectures varies by OS.
If a downstream distribution wants to provide a specific list,
maintaining a local patch is the way to go.
Diffstat (limited to 'mdoc.7')
| -rw-r--r-- | mdoc.7 | 54 |
1 files changed, 16 insertions, 38 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.212 2011/09/27 21:49:23 schwarze Exp $ +.\" $Id: mdoc.7,v 1.213 2011/11/01 14:59:27 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,42 +1364,19 @@ 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 mvmeppc , -.Ar pmax , -.Ar sgi , -.Ar socppc , -.Ar sparc , -.Ar sparc64 , -.Ar sun3 , -.Ar vax , +This specifies the machine architecture a manual page applies to, +where relevant, for example +.Cm alpha , +.Cm amd64 , +.Cm i386 , or -.Ar zaurus . +.Cm sparc64 . +The list of supported architectures varies by operating system. +For the full list of all architectures recognized by +.Xr mandoc 1 , +see the file +.Pa arch.in +in the source distribution. .El .Pp Examples: |