xref: /netbsd-src/share/man/man9/SET.9 (revision 3740bd8e73cd43e2b8092a7f1adacb404cb8af26)
1.\" $NetBSD: SET.9,v 1.5 2015/12/13 23:32:52 wiz Exp $
2.\"
3.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jukka Ruohonen.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd December 13, 2015
31.Dt SET 9
32.Os
33.Sh NAME
34.Nm SET
35.Nd primitive bit macros
36.Sh SYNOPSIS
37.In sys/types.h
38.Ft void
39.Fn SET "val" "x"
40.Ft int
41.Fn ISSET "val" "x"
42.Ft void
43.Fn CLR "val" "x"
44.Sh DESCRIPTION
45These macros define three standard bit operations:
46.Bl -enum -offset indent
47.It
48.Fn SET
49sets the set bits from
50.Fa x
51in
52.Fa val ;
53.It
54.Fn CLR
55clears the set bits from
56.Fa x
57in
58.Fa val ;
59and
60.It
61.Fn ISSET
62returns true if any of the set bits from
63.Fa x
64are set in
65.Fa val .
66.El
67.Sh SEE ALSO
68.Xr bits 3
69.Sh BUGS
70The rationale is to provide clarity in the source code,
71but arguably these operations are clear enough without the use of the macros.
72