NetBSD/share/man/man3/stdbool.3

79 lines
2.3 KiB
Groff

.\" $NetBSD: stdbool.3,v 1.2 2010/05/14 02:45:39 joerg 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 March 21, 2010
.Dt STDBOOL 3
.Os
.Sh NAME
.Nm stdbool
.Nd standard boolean types
.Sh SYNOPSIS
.In stdbool.h
.Sh DESCRIPTION
The
.In stdbool.h
header defines four macros:
.Bl -enum -offset 4n
.It
.Vt bool ,
which expands to
.Vt _Bool ;
.It
.Vt true ,
which expands to the integer constant 1;
.It
.Vt false ,
which expands to the integer constant 0; and
.It
.Vt __bool_true_false_are_defined ,
which expands to the constant 1.
.El
.Pp
The ability to undefine and redefine the macros
.Vt bool ,
.Vt true ,
and
.Vt false
is an obsolescent feature that may
be withdrawn in a future version of a standard.
.Sh SEE ALSO
.Xr stdint 3
.Sh STANDARDS
The
.In stdbool.h
header conforms to
.St -isoC-99
and
.St -p1003.1-2001 .
.Sh HISTORY
The
.In stdbool.h
header was first introduced in
.Nx 1.6 .