[src/trunk]: src/lib/libc/time mdoc'ify

[wiz <wiz%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/750fc8ce9ff7
branches:  trunk
changeset: 515100:750fc8ce9ff7
user:      wiz <wiz%NetBSD.org@localhost>
date:      Sun Sep 16 16:53:45 2001 +0000

description:
mdoc'ify

diffstat:

 lib/libc/time/tzfile.5 |  159 ++++++++++++++++++++++++------------------------
 lib/libc/time/zdump.8  |   53 ++++++++-------
 2 files changed, 108 insertions(+), 104 deletions(-)

diffs (294 lines):

diff -r 56a9b4c78e11 -r 750fc8ce9ff7 lib/libc/time/tzfile.5
--- a/lib/libc/time/tzfile.5    Sun Sep 16 16:40:44 2001 +0000
+++ b/lib/libc/time/tzfile.5    Sun Sep 16 16:53:45 2001 +0000
@@ -1,139 +1,140 @@
-.\"    $NetBSD: tzfile.5,v 1.8 1998/09/10 15:58:40 kleink Exp $
-.TH TZFILE 5
-.SH NAME
-tzfile \- time zone information
-.SH SYNOPSIS
-.B
-#include <tzfile.h>
-.SH DESCRIPTION
+.\"    $NetBSD: tzfile.5,v 1.9 2001/09/16 16:53:45 wiz Exp $
+.\"
+.\" @(#)tzfile.5       7.11
+.\" This file is in the public domain, so clarified as of
+.\" 1996-06-05 by Arthur David Olson (arthur_david_olson%nih.gov@localhost).
+.Dd September 16, 2001
+.Os
+.Dt TZFILE 5
+.Sh NAME
+.Nm tzfile
+.Nd time zone information
+.Sh SYNOPSIS
+.Fd #include <tzfile.h>
+.Sh DESCRIPTION
 The time zone information files used by
-.IR tzset (3)
-begin with the magic characters "TZif" to identify then as
-time zone information files,
+.Xr tzset 3
+begin with the magic characters
+.Dq TZif
+to identify them as time zone information files,
 followed by sixteen bytes reserved for future use,
 followed by six four-byte values of type
-.BR long ,
-written in a ``standard'' byte order
-(the high-order byte of the value is written first).
-These values are,
-in order:
-.TP
-.I tzh_ttisgmtcnt
+.Fa long ,
+written in a
+.Dq standard
+byte order (the high-order byte of the value is written first).
+These values are, in order:
+.Bl -tag -width XXXXXX -compact
+.It Va tzh_ttisgmtcnt
 The number of UTC/local indicators stored in the file.
-.TP
-.I tzh_ttisstdcnt
+.It Va tzh_ttisstdcnt
 The number of standard/wall indicators stored in the file.
-.TP
-.I tzh_leapcnt
+.It Va tzh_leapcnt
 The number of leap seconds for which data is stored in the file.
-.TP
-.I tzh_timecnt
-The number of "transition times" for which data is stored
-in the file.
-.TP
-.I tzh_typecnt
-The number of "local time types" for which data is stored
-in the file (must not be zero).
-.TP
-.I tzh_charcnt
+.It Va tzh_timecnt
+The number of
+.Dq transition times
+for which data is stored in the file.
+.It Va tzh_typecnt
+The number of
+.Dq local time types
+for which data is stored in the file (must not be zero).
+.It Va tzh_charcnt
 The number of characters of "time zone abbreviation strings"
 stored in the file.
-.PP
+.El
+.Pp
 The above header is followed by
-.I tzh_timecnt
+.Va tzh_timecnt
 four-byte values of type
-.BR long ,
+.Fa long ,
 sorted in ascending order.
-These values are written in ``standard'' byte order.
-Each is used as a transition time (as returned by
-.IR time (2))
+These values are written in
+.Dq standard
+byte order.  Each is used as a transition time (as returned by
+.Xr time 3 )
 at which the rules for computing local time change.
 Next come
-.I tzh_timecnt
+.Va tzh_timecnt
 one-byte values of type
-.BR "unsigned char" ;
-each one tells which of the different types of ``local time'' types
-described in the file is associated with the same-indexed transition time.
-These values serve as indices into an array of
-.I ttinfo
+.Fa unsigned char ;
+each one tells which of the different types of
+.Dq local time
+types described in the file is associated with the same-indexed
+transition time.  These values serve as indices into an array of
+.Fa ttinfo
 structures that appears next in the file;
 these structures are defined as follows:
-.in +.5i
-.sp
-.nf
-.ta .5i +\w'unsigned int\0\0'u
+.Bd -literal
 struct ttinfo {
        long    tt_gmtoff;
        int     tt_isdst;
        unsigned int    tt_abbrind;
 };
-.in -.5i
-.fi
-.sp
+.Ed
 Each structure is written as a four-byte value for
-.I tt_gmtoff
+.Va tt_gmtoff
 of type
-.BR long ,
+.Fa long ,
 in a standard byte order, followed by a one-byte value for
-.I tt_isdst
+.Va tt_isdst
 and a one-byte value for
-.IR tt_abbrind .
+.Va tt_abbrind .
 In each structure,
-.I tt_gmtoff
+.Va tt_gmtoff
 gives the number of seconds to be added to UTC,
-.I tt_isdst
+.Va tt_isdst
 tells whether
-.I tm_isdst
+.Va tm_isdst
 should be set by
-.I localtime (3)
+.Xr localtime 3
 and
-.I tt_abbrind
+.Va tt_abbrind
 serves as an index into the array of time zone abbreviation characters
 that follow the
-.I ttinfo
+.Va ttinfo
 structure(s) in the file.
-.PP
+.Pp
 Then there are
-.I tzh_leapcnt
+.Va tzh_leapcnt
 pairs of four-byte values, written in standard byte order;
 the first value of each pair gives the time
 (as returned by
-.IR time(3))
+.Xr time 3 )
 at which a leap second occurs;
 the second gives the
-.I total
+.Em total
 number of leap seconds to be applied after the given time.
 The pairs of values are sorted in ascending order by time.
-.PP
+.Pp
 Then there are
-.I tzh_ttisstdcnt
+.Va tzh_ttisstdcnt
 standard/wall indicators, each stored as a one-byte value;
 they tell whether the transition times associated with local time types
 were specified as standard time or wall clock time,
 and are used when a time zone file is used in handling POSIX-style
 time zone environment variables.
-.PP
+.Pp
 Finally there are
-.I tzh_ttisgmtcnt
+.Va tzh_ttisgmtcnt
 UTC/local indicators, each stored as a one-byte value;
 they tell whether the transition times associated with local time types
 were specified as UTC or local time,
 and are used when a time zone file is used in handling POSIX-style
 time zone environment variables.
-.PP
-.I Localtime
+.Pp
+.Xr localtime 3
 uses the first standard-time
-.I ttinfo
+.Fa ttinfo
 structure in the file
 (or simply the first
-.I ttinfo
+.Fa ttinfo
 structure in the absence of a standard-time structure)
 if either
-.I tzh_timecnt
+.Va tzh_timecnt
 is zero or the time argument is less than the first transition time recorded
 in the file.
-.SH SEE ALSO
-ctime(3)
-.\" @(#)tzfile.5       7.11
-.\" This file is in the public domain, so clarified as of
-.\" 1996-06-05 by Arthur David Olson (arthur_david_olson%nih.gov@localhost).
+.Sh SEE ALSO
+.Xr ctime 3 ,
+.Xr localtime 3 ,
+.Xr time 3
diff -r 56a9b4c78e11 -r 750fc8ce9ff7 lib/libc/time/zdump.8
--- a/lib/libc/time/zdump.8     Sun Sep 16 16:40:44 2001 +0000
+++ b/lib/libc/time/zdump.8     Sun Sep 16 16:53:45 2001 +0000
@@ -1,25 +1,27 @@
-.\"    $NetBSD: zdump.8,v 1.3 1996/09/10 22:04:34 jtc Exp $
-.TH ZDUMP 8
-.SH NAME
-zdump \- time zone dumper
-.SH SYNOPSIS
-.B zdump
-[
-.B \-v
-] [
-.B \-c
-cutoffyear ] [ zonename ... ]
-.SH DESCRIPTION
-.I Zdump
+.\"    $NetBSD: zdump.8,v 1.4 2001/09/16 17:05:17 wiz Exp $
+.\" @(#)zdump.8        7.3
+.Dd September 16, 2001
+.Os
+.Dt ZDUMP 8
+.Sh NAME
+.Nm zdump
+.Nd time zone dumper
+.Sh SYNOPSIS
+.Nm zdump
+.Op Fl v
+.Op Fl c Ar cutoffyear
+.Op Ar zonename ...
+.Sh DESCRIPTION
+.Nm
 prints the current time in each
-.I zonename
+.Ar zonename
 named on the command line.
-.PP
+.Pp
 These options are available:
-.TP
-.B \-v
+.Bl -tag -width XXX -compact
+.It Fl v
 For each
-.I zonename
+.Ar zonename
 on the command line,
 print the time at the lowest possible time value,
 the time one day after the lowest possible time value,
@@ -28,13 +30,14 @@
 the time at one day less than the highest possible time value,
 and the time at the highest possible time value,
 Each line ends with
-.B isdst=1
+.Dl isdst=1
 if the given time is Daylight Saving Time or
-.B isdst=0
+.Dl isdst=0
 otherwise.
-.TP
-.BI "\-c " cutoffyear
+.It Fl c Ar cutoffyear
 Cut off the verbose output near the start of the given year.
-.SH "SEE ALSO"
-ctime(3), tzfile(5), zic(8)
-.\" @(#)zdump.8        7.3
+.El
+.Sh SEE ALSO
+.Xr ctime 3 ,
+.Xr tzfile 5 ,
+.Xr zic 8