proc.5: Note kernel version for /proc/PID/smaps VmFlags "wf" flag

[thirdparty/man-pages.git] / man3 / offsetof.3

diff --git a/man3/offsetof.3 b/man3/offsetof.3
index 516abd9940490459b4a5a21608358186eea5bf9f..6f79533a1cf29d83c200d05eff7c11bb3bbfec4e 100644 (file)
--- a/man3/offsetof.3
+++ b/man3/offsetof.3
@@ -1,6 +1,7 @@
 .\" Copyright (C) 2006 Justin Pryzby <pryzbyj@justinpryzby.com>
-.\"     and Copyright (C) 2006 Michael Kerrisk <mtk-manpages@gmx.net>
+.\"     and Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
 .\"
+.\" %%%LICENSE_START(PERMISSIVE_MISC)
 .\" Permission is hereby granted, free of charge, to any person obtaining
 .\" a copy of this software and associated documentation files (the
 .\" "Software"), to deal in the Software without restriction, including
@@ -19,50 +20,69 @@
 .\" CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 .\" TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 .\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+.\" %%%LICENSE_END
 .\"
 .\" References:
 .\"   /usr/lib/gcc/i486-linux-gnu/4.1.1/include/stddef.h
 .\"   glibc-doc
-.TH OFFSETOF 3 "2006-05-23" GNU "Linux Programmer's Manual"
+.TH OFFSETOF 3 2019-03-06 "GNU" "Linux Programmer's Manual"
 .SH NAME
 offsetof \- offset of a structure member
 .SH SYNOPSIS
-\fB#include <stddef.h>
-
-\fBsize_t offsetof(\fItype\fP, \fPmember\fP);
+.nf
+.B #include <stddef.h>
+.PP
+.BI "size_t offsetof(" type ", " member );
+.fi
 .SH DESCRIPTION
-The macro \fBoffsetof\fP() returns the offset of the field
-\fImember\fP from the start of the structure \fItype\fP.
-
-This macro is useful because the sizes of the fields that compose 
-a structure can vary across implementations, 
-and compilers may insert different numbers of padding 
+The macro
+.BR offsetof ()
+returns the offset of the field
+.I member
+from the start of the structure
+.IR type .
+.PP
+This macro is useful because the sizes of the fields that compose
+a structure can vary across implementations,
+and compilers may insert different numbers of padding
 bytes between fields.
 Consequently, an element's offset is not necessarily
 given by the sum of the sizes of the previous elements.
-
-A compiler error will result if 
-\fImember\fP is not aligned to a byte boundary 
+.PP
+A compiler error will result if
+.I member
+is not aligned to a byte boundary
 (i.e., it is a bit field).
-.SH "RETURN VALUE"
-\fBoffsetof\fP() returns the offset of the given element within the
-given type, in units of bytes.
+.SH RETURN VALUE
+.BR offsetof ()
+returns the offset of the given
+.I member
+within the given
+.IR type ,
+in units of bytes.
+.SH CONFORMING TO
+POSIX.1-2001, POSIX.1-2008, C89, C99.
 .SH EXAMPLE
-On a Linux/x86 system, when compiled using the default \fBgcc\fP(1)
+On a Linux/i386 system, when compiled using the default
+.BR gcc (1)
 options, the program below produces the following output:
-.fi
-
-    $ ./a.out
-    offsets: i=0; c=4; d=8 a=16
-    sizeof(struct s)=16
-    
-.nf
-.nf
+.PP
+.in +4n
+.EX
+.RB "$" " ./a.out"
+offsets: i=0; c=4; d=8 a=16
+sizeof(struct s)=16
+.EE
+.in
+.SS Program source
+\&
+.EX
 #include <stddef.h>
 #include <stdio.h>
 #include <stdlib.h>
 
-int main()
+int
+main(void)
 {
     struct s {
         int i;
@@ -72,19 +92,12 @@ int main()
     };
 
     /* Output is compiler dependent */
-    
-    printf("offsets: i=%ld; c=%ld; d=%ld a=%ld\\n",
-            (long) offsetof(struct s, i), 
-            (long) offsetof(struct s, c),
-            (long) offsetof(struct s, d), 
-            (long) offsetof(struct s, a));
-    printf("sizeof(struct s)=%ld\\n", (long) sizeof(struct s));
-    
+
+    printf("offsets: i=%zd; c=%zd; d=%zd a=%zd\en",
+            offsetof(struct s, i), offsetof(struct s, c),
+            offsetof(struct s, d), offsetof(struct s, a));
+    printf("sizeof(struct s)=%zd\en", sizeof(struct s));
+
     exit(EXIT_SUCCESS);
 }
-.fi
-.SH "CONFORMING TO"
-C99, POSIX.1-2001.
-.\" .SH SEE ALSO
-.\" FIXME . When one day readdir_r(3) is documented, it should have 
-.\" a SEE ALSO that refers to this page.
+.EE