diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2007-05-12 09:06:04 +0000 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2007-05-12 09:06:04 +0000 |
| commit | 60a90ecdae7bf6d1a91dc5d1d7177e400b114e47 (patch) | |
| tree | 9f7c19a897084607a9688be5414d0d4cd6391b54 /man3/offsetof.3 | |
| parent | d92a60f2575c95cd532b822e4fb983c3a9e35641 (diff) | |
| download | man-pages-60a90ecdae7bf6d1a91dc5d1d7177e400b114e47.tar.gz | |
Convert function formatting of the form "\fBname\fP()" to ".BR name ()".
Diffstat (limited to 'man3/offsetof.3')
| -rw-r--r-- | man3/offsetof.3 | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/man3/offsetof.3 b/man3/offsetof.3 index b282410457..75ba7551fb 100644 --- a/man3/offsetof.3 +++ b/man3/offsetof.3 @@ -31,7 +31,9 @@ offsetof \- offset of a structure member \fBsize_t offsetof(\fItype\fP, \fPmember\fP); .SH DESCRIPTION -The macro \fBoffsetof\fP() returns the offset of the field +The macro +.BR offsetof () +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 @@ -45,10 +47,12 @@ A compiler error will result if \fImember\fP 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 +.BR offsetof () +returns the offset of the given element within the given type, in units of bytes. .SH EXAMPLE -On a Linux/x86 system, when compiled using the default \fBgcc\fP(1) +On a Linux/x86 system, when compiled using the default +.BR gcc (1) options, the program below produces the following output: .fi |