man: Do not install timeval(3bsd) nor timespec(3bsd) These are system types, which we should not be documenting. Rewrite the man pages around the TIMEVAL_TO_TIMESPEC and TIMESPEC_TO_TIMEVAL macros.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
diff --git a/man/Makefile.am b/man/Makefile.am
index 27aae67..12539ba 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -174,13 +174,11 @@ dist_man_MANS = \
timercmp.3bsd \
timerisset.3bsd \
timersub.3bsd \
- timespec.3bsd \
timespecadd.3bsd \
timespecclear.3bsd \
timespeccmp.3bsd \
timespecisset.3bsd \
timespecsub.3bsd \
- timeval.3bsd \
tree.3bsd \
# EOL
diff --git a/man/TIMESPEC_TO_TIMEVAL.3bsd b/man/TIMESPEC_TO_TIMEVAL.3bsd
index e47176e..28ebcf4 100644
--- a/man/TIMESPEC_TO_TIMEVAL.3bsd
+++ b/man/TIMESPEC_TO_TIMEVAL.3bsd
@@ -1 +1,100 @@
-.so man3/timeval.3bsd
+.\" $NetBSD: timeval.3,v 1.12 2011/04/12 08:39:26 jruoho Exp $
+.\"
+.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Jukka Ruohonen.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd April 12, 2011
+.Dt TIMEVAL_TO_TIMESPEC 3bsd
+.Os
+.Sh NAME
+.Nm TIMEVAL_TO_TIMESPEC ,
+.Nm TIMESPEC_TO_TIMEVAL
+.Nd time structures conversion macros
+.Sh LIBRARY
+.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
+.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
+.Lb libbsd
+.Sh SYNOPSIS
+.In sys/time.h
+(See
+.Xr libbsd 7
+for include usage.)
+.Ft void
+.Fn TIMEVAL_TO_TIMESPEC "struct timeval *tv" "struct timespec *ts"
+.Ft void
+.Fn TIMESPEC_TO_TIMEVAL "struct timeval *tv" "struct timespec *ts"
+.Sh DESCRIPTION
+The
+.Va timeval
+structure represents elapsed time, in whole seconds,
+and the rest of the elapsed time in microseconds.
+.Pp
+The
+.Va timespec
+structure represents elapsed time, in whole seconds,
+and the rest of the elapsed time in nanoseconds.
+.Pp
+A microsecond is equal to one millionth of a second,
+1000 nanoseconds, or 1/1000 milliseconds.
+To ease the conversions, the macros
+.Fn TIMEVAL_TO_TIMESPEC
+and
+.Fn TIMESPEC_TO_TIMEVAL
+can be used to convert between
+.Em struct timeval
+and
+.Em struct timespec .
+.Sh EXAMPLES
+It can be stressed that the traditional
+.Tn UNIX
+.Va timeval
+and
+.Va timespec
+structures represent elapsed time, measured by the system clock.
+The following sketch implements a function suitable
+for use in a context where the
+.Va timespec
+structure is required for a conditional timeout:
+.Bd -literal -offset indent
+static void
+example(struct timespec *spec, time_t minutes)
+{
+ struct timeval elapsed;
+
+ (void)gettimeofday(&elapsed, NULL);
+
+ TIMEVAL_TO_TIMESPEC(&elapsed, spec);
+
+ /* Add the offset for timeout in minutes. */
+ spec->tv_sec = spec->tv_sec + minutes * 60;
+}
+.Ed
+.Pp
+A better alternative would use the more precise
+.Xr clock_gettime 2 .
+.Sh SEE ALSO
+.Xr timeradd 3bsd
diff --git a/man/TIMEVAL_TO_TIMESPEC.3bsd b/man/TIMEVAL_TO_TIMESPEC.3bsd
index e47176e..7741548 100644
--- a/man/TIMEVAL_TO_TIMESPEC.3bsd
+++ b/man/TIMEVAL_TO_TIMESPEC.3bsd
@@ -1 +1 @@
-.so man3/timeval.3bsd
+.so man3/TIMESPEC_TO_TIMEVAL.3bsd
diff --git a/man/timespec.3bsd b/man/timespec.3bsd
deleted file mode 100644
index e47176e..0000000
--- a/man/timespec.3bsd
+++ /dev/null
@@ -1 +0,0 @@
-.so man3/timeval.3bsd
diff --git a/man/timeval.3bsd b/man/timeval.3bsd
deleted file mode 100644
index 59613e1..0000000
--- a/man/timeval.3bsd
+++ /dev/null
@@ -1,134 +0,0 @@
-.\" $NetBSD: timeval.3,v 1.12 2011/04/12 08:39:26 jruoho Exp $
-.\"
-.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
-.\" All rights reserved.
-.\"
-.\" This code is derived from software contributed to The NetBSD Foundation
-.\" by Jukka Ruohonen.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
-.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
-.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
-.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-.\" POSSIBILITY OF SUCH DAMAGE.
-.\"
-.Dd April 12, 2011
-.Dt timeval 3bsd
-.Os
-.Sh NAME
-.Nm timeval ,
-.Nm timespec
-.Nd time structures
-.Sh LIBRARY
-.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
-.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
-.Lb libbsd
-.Sh SYNOPSIS
-.In sys/time.h
-(See
-.Xr libbsd 7
-for include usage.)
-.Ft void
-.Fn TIMEVAL_TO_TIMESPEC "struct timeval *tv" "struct timespec *ts"
-.Ft void
-.Fn TIMESPEC_TO_TIMEVAL "struct timeval *tv" "struct timespec *ts"
-.Sh DESCRIPTION
-The
-.In sys/time.h
-header, included by
-.In time.h ,
-defines various structures related to time and timers.
-.Bl -enum -offset 1n
-.It
-The following structure is used by
-.Xr gettimeofday 2 ,
-among others:
-.Bd -literal -offset indent
-struct timeval {
- time_t tv_sec;
- suseconds_t tv_usec;
-};
-.Ed
-.Pp
-The
-.Va tv_sec
-member represents the elapsed time, in whole seconds.
-The
-.Va tv_usec
-member captures rest of the elapsed time,
-represented as the number of microseconds.
-.It
-The following structure is used by
-.Xr nanosleep 2 ,
-among others:
-.Bd -literal -offset indent
-struct timespec {
- time_t tv_sec;
- long tv_nsec;
-};
-.Ed
-.Pp
-The
-.Va tv_sec
-member is again the elapsed time in whole seconds.
-The
-.Va tv_nsec
-member represents the rest of the elapsed time in nanoseconds.
-.Pp
-A microsecond is equal to one millionth of a second,
-1000 nanoseconds, or 1/1000 milliseconds.
-To ease the conversions, the macros
-.Fn TIMEVAL_TO_TIMESPEC
-and
-.Fn TIMESPEC_TO_TIMEVAL
-can be used to convert between
-.Em struct timeval
-and
-.Em struct timespec .
-.El
-.Sh EXAMPLES
-It can be stressed that the traditional
-.Tn UNIX
-.Va timeval
-and
-.Va timespec
-structures represent elapsed time, measured by the system clock.
-The following sketch implements a function suitable
-for use in a context where the
-.Va timespec
-structure is required for a conditional timeout:
-.Bd -literal -offset indent
-static void
-example(struct timespec *spec, time_t minutes)
-{
- struct timeval elapsed;
-
- (void)gettimeofday(&elapsed, NULL);
-
- _DIAGASSERT(spec != NULL);
- TIMEVAL_TO_TIMESPEC(&elapsed, spec);
-
- /* Add the offset for timeout in minutes. */
- spec->tv_sec = spec->tv_sec + minutes * 60;
-}
-.Ed
-.Pp
-A better alternative would use the more precise
-.Xr clock_gettime 2 .
-.Sh SEE ALSO
-.Xr timeradd 3bsd