c16fc377e28fd0106a3a8a810b877ec668d47286
[dragonfly.git] / lib / libc / string / ffs.3
1 .\" Copyright (c) 1990, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Chris Torek.
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 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"     This product includes software developed by the University of
17 .\"     California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\"    may be used to endorse or promote products derived from this software
20 .\"    without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\"     @(#)ffs.3       8.2 (Berkeley) 4/19/94
35 .\" $FreeBSD: src/lib/libc/string/ffs.3,v 1.3.2.2 2001/12/14 18:33:59 ru Exp $
36 .\" $DragonFly: src/lib/libc/string/ffs.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
37 .\"
38 .Dd April 19, 1994
39 .Dt FFS 3
40 .Os
41 .Sh NAME
42 .Nm ffs
43 .Nd find first bit set in a bit string
44 .Sh LIBRARY
45 .Lb libc
46 .Sh SYNOPSIS
47 .In string.h
48 .Ft int
49 .Fn ffs "int value"
50 .Sh DESCRIPTION
51 The
52 .Fn ffs
53 function finds the first bit set in
54 .Fa value
55 and returns the index of that bit.
56 Bits are numbered starting from 1, starting at the right-most
57 bit.
58 A return value of 0 means that the argument was zero.
59 .Sh SEE ALSO
60 .Xr bitstring 3
61 .Sh HISTORY
62 The
63 .Fn ffs
64 function appeared in
65 .Bx 4.3 .