* mdocml: Improve documentation of the header/footer macros .Dt, .Os, .TH:
@ 2014-12-28 15:24 schwarze
0 siblings, 0 replies; only message in thread
From: schwarze @ 2014-12-28 15:24 UTC (permalink / raw)
To: source
Log Message:
-----------
Improve documentation of the header/footer macros .Dt, .Os, .TH:
* State the defaults for .Os and the fourth .TH argument.
* Sync the section titles, and stop advertising obscure sections that
aren't actually fully supported and certainly not recommended for use.
Modified Files:
--------------
mdocml:
man.7
mdoc.7
Revision Data
-------------
Index: man.7
===================================================================
RCS file: /home/cvs/mdocml/mdocml/man.7,v
retrieving revision 1.127
retrieving revision 1.128
diff -Lman.7 -Lman.7 -u -p -r1.127 -r1.128
--- man.7
+++ man.7
@@ -607,7 +607,8 @@ The scope of a sub-section is closed by
section, or end of file.
The paragraph left-margin width is reset to the default.
.Ss \&TH
-Sets the title of the manual page with the following syntax:
+Sets the title of the manual page for use in the page header
+and footer with the following syntax:
.Bd -filled -offset indent
.Pf \. Sx \&TH
.Ar title section date
@@ -629,6 +630,11 @@ is empty or not specified, the current d
The optional
.Ar source
string specifies the organisation providing the utility.
+When unspecified,
+.Xr mandoc 1
+uses its
+.Fl Ios
+argument.
The
.Ar volume
string replaces the default rendered volume, which is dictated by the
Index: mdoc.7
===================================================================
RCS file: /home/cvs/mdocml/mdocml/mdoc.7,v
retrieving revision 1.245
retrieving revision 1.246
diff -Lmdoc.7 -Lmdoc.7 -u -p -r1.245 -r1.246
--- mdoc.7
+++ mdoc.7
@@ -1314,38 +1314,26 @@ it should by convention be all caps.
The manual section.
This may be one of
.Cm 1
-.Pq utilities ,
+.Pq General Commands ,
.Cm 2
-.Pq system calls ,
+.Pq System Calls ,
.Cm 3
-.Pq libraries ,
+.Pq Library Functions ,
.Cm 3p
-.Pq Perl libraries ,
+.Pq Perl Library ,
.Cm 4
-.Pq devices ,
+.Pq Device Drivers ,
.Cm 5
-.Pq file formats ,
+.Pq File Formats ,
.Cm 6
-.Pq games ,
+.Pq Games ,
.Cm 7
-.Pq miscellaneous ,
+.Pq Miscellaneous Information ,
.Cm 8
-.Pq system utilities ,
-.Cm 9
-.Pq kernel functions ,
-.Cm X11
-.Pq X Window System ,
-.Cm X11R6
-.Pq X Window System ,
-.Cm unass
-.Pq unassociated ,
-.Cm local
-.Pq local system ,
-.Cm draft
-.Pq draft manual ,
+.Pq System Manager's Manual ,
or
-.Cm paper
-.Pq paper .
+.Cm 9
+.Pq Kernel Developer's Manual .
It should correspond to the manual's filename suffix and defaults to
the empty string if unspecified.
.It Ar arch
@@ -2100,8 +2088,16 @@ Its syntax is as follows:
The optional
.Ar system
parameter specifies the relevant operating system or environment.
-Left unspecified, it defaults to the local operating system version.
-This is the suggested form.
+It is suggested to leave it unspecified, in which case
+.Xr mandoc 1
+uses its
+.Fl Ios
+argument, or, if that isn't specified either,
+.Fa sysname
+and
+.Fa release
+as returned by
+.Xr uname 3 .
.Pp
Examples:
.Dl \&.Os
--
To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2014-12-28 15:24 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-12-28 15:24 mdocml: Improve documentation of the header/footer macros .Dt, .Os, .TH: schwarze
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).