summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorkevlo <kevlo@FreeBSD.org>2012-02-08 08:42:17 +0000
committerkevlo <kevlo@FreeBSD.org>2012-02-08 08:42:17 +0000
commitf0596397a6ddff1ba920f96fffd52b8043862267 (patch)
treea5ddacfef8fd378705ffc857f7ae26d083da2079 /share
parent621953c56b219810b088bf066721acb078cf2d71 (diff)
downloadFreeBSD-src-f0596397a6ddff1ba920f96fffd52b8043862267.zip
FreeBSD-src-f0596397a6ddff1ba920f96fffd52b8043862267.tar.gz
Add offsetof.3 man page
Obtained from: OpenBSD
Diffstat (limited to 'share')
-rw-r--r--share/man/man3/Makefile1
-rw-r--r--share/man/man3/offsetof.347
2 files changed, 48 insertions, 0 deletions
diff --git a/share/man/man3/Makefile b/share/man/man3/Makefile
index 4706506..d1453eb 100644
--- a/share/man/man3/Makefile
+++ b/share/man/man3/Makefile
@@ -10,6 +10,7 @@ MAN= assert.3 \
fpgetround.3 \
intro.3 \
makedev.3 \
+ offsetof.3 \
${PTHREAD_MAN} \
queue.3 \
siginfo.3 \
diff --git a/share/man/man3/offsetof.3 b/share/man/man3/offsetof.3
new file mode 100644
index 0000000..e63916b
--- /dev/null
+++ b/share/man/man3/offsetof.3
@@ -0,0 +1,47 @@
+.\" $OpenBSD: offsetof.3,v 1.2 2010/02/18 18:30:19 jmc Exp $
+.\"
+.\" Copyright (c) 2010 Thomas Pfaff <tpfaff@tp76.info>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd February 18 2010
+.Dt OFFSETOF 3
+.Os
+.Sh NAME
+.Nm offsetof
+.Nd offset of a structure member
+.Sh SYNOPSIS
+.Fd #include <stddef.h>
+.Ft size_t
+.Fn offsetof "type" "member"
+.Sh DESCRIPTION
+The
+.Fn offsetof
+macro expands to an integer constant expression of type
+.Ft size_t
+and yields the offset,
+in bytes, of the field
+.Ar member
+from the start of the structure
+.Ar type .
+.Pp
+A compiler error will result if
+.Ar member
+is not aligned to a byte boundary (i.e. it is a bit-field).
+.Sh STANDARDS
+The
+.Fn offsetof
+macro conforms to
+.St -ansiC .
OpenPOWER on IntegriCloud