chiark / gitweb /
@@@ much mess, mostly manpages
[mLib] / sys / tv.3.in
similarity index 71%
rename from sys/tv.3
rename to sys/tv.3.in
index f24892d03cbc661790f94301ef4e6ff2170405ed..c5ed8dcff4a7023e5591cb8507696a4c4c258d83 100644 (file)
--- a/sys/tv.3
@@ -1,20 +1,53 @@
 .\" -*-nroff-*-
-.TH tv 3 "22 May 1999" "Straylight/Edgeware" "mLib utilities library"
-.SH NAME
-tv \- arithmetic on \fBstruct timeval\fR objects
+.\"
+.\" Manual for timeval arithmetic
+.\"
+.\" (c) 1999, 2001, 2005, 2009, 2024 Straylight/Edgeware
+.\"
+.
+.\"----- Licensing notice ---------------------------------------------------
+.\"
+.\" This file is part of the mLib utilities library.
+.\"
+.\" mLib is free software: you can redistribute it and/or modify it under
+.\" the terms of the GNU Library General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or (at
+.\" your option) any later version.
+.\"
+.\" mLib is distributed in the hope that it will be useful, but WITHOUT
+.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
+.\" License for more details.
+.\"
+.\" You should have received a copy of the GNU Library General Public
+.\" License along with mLib.  If not, write to the Free Software
+.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
+.\" USA.
+.
+.\"--------------------------------------------------------------------------
+.so ../defs.man \" @@@PRE@@@
+.
+.\"--------------------------------------------------------------------------
+.TH tv 3mLib "22 May 1999" "Straylight/Edgeware" "mLib utilities library"
 .\" @tv_add
 .\" @tv_addl
 .\" @tv_sub
 .\" @tv_subl
 .\" @tv_cmp
-.\"
+.
 .\" @TV_ADD
 .\" @TV_ADDL
 .\" @TV_SUB
 .\" @TV_SUBL
 .\" @TV_CMP
-.\"
+.
+.\"--------------------------------------------------------------------------
+.SH NAME
+tv \- arithmetic on \fBstruct timeval\fR objects
+.
+.\"--------------------------------------------------------------------------
 .SH SYNOPSIS
+.
 .nf
 .B "#include <mLib/tv.h>"
 .PP
@@ -49,7 +82,10 @@ tv \- arithmetic on \fBstruct timeval\fR objects
 .BI "int TV_CMP(const struct timeval *" a ", " op ,
 .BI "           const struct timeval *" b );
 .fi
+.
+.\"--------------------------------------------------------------------------
 .SH DESCRIPTION
+.
 The
 .B <mLib/tv.h>
 header file provides functions and macros which perform simple
@@ -142,11 +178,11 @@ works differently.  Given two arguments
 and
 .IR y ,
 it returns -1 if
-.IR x " < " y ,
+.IR x "\ <\ " y ,
 zero if
-.IR x " == " y ,
+.IR x "\ =\ " y ,
 or 1 if
-.IR x " > " y .
+.IR x "\ >\ " y .
 Hence, the result can be compared against zero in a relatively intuitive
 way (as for
 .BR strcmp (3),
@@ -168,7 +204,15 @@ like
 although I can't see why there'd be a problem.  (If there is one, then
 my implementation has it too, because they're the same.  I don't
 document the restriction because I don't think it exists.)
+.
+.\"--------------------------------------------------------------------------
 .SH "SEE ALSO"
+.
 .BR mLib (3).
+.
+.\"--------------------------------------------------------------------------
 .SH AUTHOR
+.
 Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------