Sync usage with man page.
[netbsd-mini2440.git] / share / man / man9 / imax.9
blob13c3fbfd0b1bafc3dc6440d38276364f4d808c0b
1 .\"     $NetBSD: imax.9,v 1.4 2008/05/10 15:31:04 martin Exp $
2 .\"
3 .\" Copyright (c) 2006 Igor Sobrado
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 .\" POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .Dd April 23, 2006
28 .Dt IMAX 9
29 .Os
30 .Sh NAME
31 .Nm imax ,
32 .Nm imin ,
33 .Nm lmax ,
34 .Nm lmin ,
35 .Nm max ,
36 .Nm min ,
37 .Nm ulmax ,
38 .Nm ulmin
39 .Nd compare integers
40 .Sh SYNOPSIS
41 .Ft int
42 .Fn imax "int a" "int b"
43 .Ft int
44 .Fn imin "int a" "int b"
45 .Ft long
46 .Fn lmax "long a" "long b"
47 .Ft long
48 .Fn lmin "long a" "long b"
49 .Ft u_int
50 .Fn max "u_int a" "u_int b"
51 .Ft u_int
52 .Fn min "u_int a" "u_int b"
53 .Ft u_long
54 .Fn ulmax "u_long a" "u_long b"
55 .Ft u_long
56 .Fn ulmin "u_long a" "u_long b"
57 .Sh DESCRIPTION
58 The
59 .Fn imin ,
60 .Fn lmin ,
61 .Fn min ,
62 and
63 .Fn ulmin
64 functions return whichever argument is algebraically smaller, differing only
65 in their argument and return types: these functions operate on, respectively,
66 natural size, long, unsigned and unsigned long integers.
67 .Pp
68 The
69 .Fn imax ,
70 .Fn lmax ,
71 .Fn max ,
72 and
73 .Fn ulmax
74 functions are identical except that they return the algebraically larger
75 argument between
76 .Ar a
77 and
78 .Ar b .