aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/man.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-11-02 06:22:44 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-11-02 06:22:44 +0000
commita39b97ef0c1432973b5d815709925a82507c100b (patch)
tree9ca38e01caeb3a842bd0520375f0e52e83099515 /man.7
parentf50364828978249af6c0a2c5e92ee923b8d86c75 (diff)
downloadmandoc-a39b97ef0c1432973b5d815709925a82507c100b.tar.gz
mandoc-a39b97ef0c1432973b5d815709925a82507c100b.tar.zst
mandoc-a39b97ef0c1432973b5d815709925a82507c100b.zip
Added mandoc_a2time() for proper date conversion.
Fitted TH and Dd handlers to use mandoc_a2time(). Documented date syntax for -man, fixed documentation for -mdoc.
Diffstat (limited to 'man.7')
-rw-r--r--man.760
1 files changed, 40 insertions, 20 deletions
diff --git a/man.7 b/man.7
index d94497dc..c3b313a9 100644
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\" $Id: man.7,v 1.42 2009/10/31 08:37:26 kristaps Exp $
+.\" $Id: man.7,v 1.43 2009/11/02 06:22:45 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -14,7 +14,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: October 31 2009 $
+.Dd $Mdocdate: November 2 2009 $
.Dt MAN 7
.Os
.
@@ -119,6 +119,23 @@ from input. These are later re-added, if applicable, by a front-end
utility such as
.Xr mandoc 1 .
.
+.Ss Dates
+The
+.Sx \&TH
+macro is the only
+.Nm
+macro that requires a date. The form for this date is the ISO-8601
+standard
+.Cm YYYY-MM-DD .
+.
+.Ss Scaling Widths
+Many macros support scaled widths for their arguments, such as
+stipulating a two-inch list indentation with the following:
+.Bd -literal -offset indent
+\&.Bl -tag -width 2i
+.Ed
+.
+.
.Ss Scaling Widths
Many macros support scaled widths for their arguments, such as
stipulating a two-inch paragraph indentation with the following:
@@ -202,7 +219,7 @@ Beyond
at least one macro or text node must appear in the document. Documents
are generally structured as follows:
.Bd -literal -offset indent
-\&.TH FOO 1 "13 Aug 2009"
+\&.TH FOO 1 2009-10-10
\&.
\&.SH NAME
\efBfoo\efR \e(en a description goes here
@@ -614,26 +631,29 @@ subsequent sub-section, section, or end of file. The paragraph
left-margin width is re-set to the default.
.Ss \&TH
Sets the title of the manual page with the following syntax:
-.Bd -literal -offset indent
-\&.TH title section [date [source [volume]]]
-.Ed
-.
.Pp
-At least the
-.Va title
-and
-.Va section
+.D1 \. Ns Sx \&TH No Cm title msec Op Cm date Op Cm src Op Cm vol
+.Pp
+At least the upper-case document title
+.Cm title
+and numeric manual section
+.Cm msec
arguments must be provided. The
-.Va date
-argument should be formatted as
-.Qq %b [%d] %Y
-format, described in
-.Xr strptime 3 .
-The
-.Va source
+.Cm date
+argument should be formatted as described in
+.Sx Dates :
+if it does not conform, the current date is used instead. The
+.Cm src
string specifies the organisation providing the utility. The
-.Va volume
-replaces the default rendered volume as dictated by the manual section.
+.Cm vol
+string replaces the default rendered volume, which is dictated by the
+manual section.
+.Pp
+Examples:
+.Bd -literal -offset indent
+\&.TH CVS 5 "1992-02-12" GNU
+.Ed
+.
.Ss \&TP
Begin a paragraph where the head, if exceeding the indentation width, is
followed by a newline; if not, the body follows on the same line after a