8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3c / getpagesize.3c
blobcd864261995828dda92bba65b71993f6a054f441
1 '\" te
2 .\"  Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\"  This notice shall appear on any product containing this material.
7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
10 .TH GETPAGESIZE 3C "Jun 27, 2000"
11 .SH NAME
12 getpagesize \- get system page size
13 .SH SYNOPSIS
14 .LP
15 .nf
16 #include <unistd.h>
18 \fBint\fR \fBgetpagesize\fR(\fBvoid\fR);
19 .fi
21 .SH DESCRIPTION
22 .sp
23 .LP
24 The \fBgetpagesize()\fR function returns the number of bytes in a page. Page
25 granularity is the granularity of many of the memory management calls.
26 .sp
27 .LP
28 The page size is a system page size and need not be the same as the underlying
29 hardware page size.
30 .sp
31 .LP
32 The \fBgetpagesize()\fR function is equivalent to \fBsysconf(_SC_PAGE_SIZE)\fR
33 and \fBsysconf(_SC_PAGESIZE)\fR. See \fBsysconf\fR(3C).
34 .SH RETURN VALUES
35 .sp
36 .LP
37 The \fBgetpagesize()\fR function returns the current page size.
38 .SH ERRORS
39 .sp
40 .LP
41 No errors are defined.
42 .SH USAGE
43 .sp
44 .LP
45 The value returned by \fBgetpagesize()\fR need not be the minimum value that
46 \fBmalloc\fR(3C) can allocate.  Moreover, the application cannot assume that an
47 object of this size can be allocated with \fBmalloc()\fR.
48 .SH ATTRIBUTES
49 .sp
50 .LP
51 See \fBattributes\fR(5) for descriptions of the following attributes:
52 .sp
54 .sp
55 .TS
56 box;
57 c | c
58 l | l .
59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
61 MT-Level        MT-Safe
62 .TE
64 .SH SEE ALSO
65 .sp
66 .LP
67 \fBpagesize\fR(1), \fBbrk\fR(2), \fBgetrlimit\fR(2), \fBmmap\fR(2),
68 \fBmprotect\fR(2), \fBmunmap\fR(2), \fBmalloc\fR(3C), \fBmsync\fR(3C),
69 \fBsysconf\fR(3C), \fBattributes\fR(5)