LDP
/
man-pages
mirror of https://github.com/mkerrisk/man-pages
0
1
Fork 0
Code Releases Activity

get_robust_list.2, get_thread_area.2, getcpu.2, getdents.2, gettid.2, io_cancel.2, io_destroy.2, io_getevents.2, io_setup.2, io_submit.2, ioprio_set.2, kexec_load.2, llseek.2, modify_ldt.2, mq_getsetattr.2, pivot_root.2, readdir.2, rt_sigqueueinfo.2, set_thread_area.2, sgetmask.2, spu_create.2, spu_run.2, subpage_prot.2, sysctl.2, tkill.2: Add note to SYNOPSIS that there is no glibc wrapper for system call 

Reduce the chance that the reader may be misled into thinking
that there is a wrapper function for this system call by noting
explicitly in the SYNOPSIS that there is no glibc wrapper and
pointing the reader to NOTES for further details.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2012-07-13 08:48:20 +02:00
parent 498a96a239
commit 45c99e3ec4
25 changed files with 123 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
man2/get_robust_list.2
View File

@ -24,7 +24,7 @@
.\" FIXME Something could be added to this page (or exit(2))
.\" about exit_robust_list processing
.\"
.TH GET_ROBUST_LIST 2 2012-05-03 Linux "Linux System Calls"
.TH GET_ROBUST_LIST 2 2012-07-13 Linux "Linux System Calls"
.SH NAME
get_robust_list, set_robust_list \- get/set list of robust futexes
.SH SYNOPSIS
@ -36,6 +36,9 @@ get_robust_list, set_robust_list \- get/set list of robust futexes
.BI " size_t *" len_ptr );
.BI "long set_robust_list(struct robust_list_head *" head ", size_t " len );
.fi
.IR Note :
There are no glibc wrappers for these system calls; see NOTES.
.SH DESCRIPTION
The robust futex implementation needs to maintain per-thread lists of robust
futexes which are unlocked when the thread exits.
@ -114,6 +117,8 @@ No library support is provided; use
.SH NOTES
These system calls are not needed by normal applications.
No support for them is provided in glibc.
In the unlikely event that you want to call them directly, use
.BR syscall (2).
A thread can have only one robust futex list;
therefore applications that wish

10
man2/get_thread_area.2
View File

@ -3,7 +3,7 @@
.\" See the file COPYING in the top level source directory for details.
.\"
.\" Written by Kent Yoder.
.TH GET_THREAD_AREA 2 2008-11-27 "Linux" "Linux Programmer's Manual"
.TH GET_THREAD_AREA 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
get_thread_area \- Get a Thread Local Storage (TLS) area
.SH "SYNOPSIS"
@ -12,6 +12,9 @@ get_thread_area \- Get a Thread Local Storage (TLS) area
.B #include <asm/ldt.h>
.sp
.BI "int get_thread_area(struct user_desc *" u_info );
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH "DESCRIPTION"
.BR get_thread_area ()
returns an entry in the current thread's Thread Local Storage (TLS) array.
@ -43,8 +46,9 @@ first appeared in Linux 2.5.32.
is Linux-specific and should not be used in programs
that are intended to be portable.
.SH NOTES
Glibc does not provide a wrapper for this system call;
call it using
Glibc does not provide a wrapper for this system call,
since it is generally intended only for use by threading libraries.
In the unlikely event that you want to call it directly, use
.BR syscall (2).
.SH "SEE ALSO"
.BR modify_ldt (2),

6
man2/getcpu.2
View File

@ -4,7 +4,7 @@
.\" and in case of nontrivial modification author and date
.\" of the modification is added to the header.
.\" 2008, mtk, various edits
.TH GETCPU 2 2012-05-09 "Linux" "Linux Programmer's Manual"
.TH GETCPU 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
getcpu \- determine CPU and NUMA node on which the calling thread is running
.SH SYNOPSIS
@ -13,7 +13,11 @@ getcpu \- determine CPU and NUMA node on which the calling thread is running
.sp
.BI "int getcpu(unsigned *" cpu ", unsigned *" node \
", struct getcpu_cache *" tcache );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
The
.BR getcpu ()

8
man2/getdents.2
View File

@ -24,7 +24,7 @@
.\" Modified 22 July 1995 by Michael Chastain <mec@duracef.shout.net>:
.\" Derived from 'readdir.2'.
.\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
.TH GETDENTS 2 2010-11-21 "Linux" "Linux Programmer's Manual"
.TH GETDENTS 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
getdents \- get directory entries
.SH SYNOPSIS
@ -32,6 +32,9 @@ getdents \- get directory entries
.BI "int getdents(unsigned int " fd ", struct linux_dirent *" dirp ,
.BI " unsigned int " count );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
This is not the function you are interested in.
Look at
@ -165,6 +168,9 @@ Glibc does not provide a wrapper for this system call; call it using
You will need to define the
.I linux_dirent
structure yourself.
However, you probably want to use
.BR readdir (3)
instead.
This call supersedes
.BR readdir (2).

5
man2/gettid.2
View File

@ -23,7 +23,7 @@
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH GETTID 2 2008-04-14 "Linux" "Linux Programmer's Manual"
.TH GETTID 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
gettid \- get thread identification
.SH SYNOPSIS
@ -32,6 +32,9 @@ gettid \- get thread identification
.sp
.B pid_t gettid(void);
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
.BR gettid ()
returns the caller's thread ID (TID).

5
man2/io_cancel.2
View File

@ -2,7 +2,7 @@
.\" This file is distributed according to the GNU General Public License.
.\" See the file COPYING in the top level source directory for details.
.\"
.TH IO_CANCEL 2 2012-05-08 "Linux" "Linux Programmer's Manual"
.TH IO_CANCEL 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
io_cancel \- cancel an outstanding asynchronous I/O operation
.SH "SYNOPSIS"
@ -12,6 +12,9 @@ io_cancel \- cancel an outstanding asynchronous I/O operation
.BI "int io_cancel(aio_context_t " ctx_id ", struct iocb *" iocb ,
.BI " struct io_event *" result );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH "DESCRIPTION"
.PP
The

5
man2/io_destroy.2
View File

@ -3,7 +3,7 @@
.\" See the file COPYING in the top level source directory for details.
.\"
.\" ..
.TH IO_DESTROY 2 2012-05-08 "Linux" "Linux Programmer's Manual"
.TH IO_DESTROY 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
io_destroy \- destroy an asynchronous I/O context
.SH "SYNOPSIS"
@ -12,6 +12,9 @@ io_destroy \- destroy an asynchronous I/O context
.BI "int io_destroy(aio_context_t " ctx_id );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH "DESCRIPTION"
.PP
The

5
man2/io_getevents.2
View File

@ -2,7 +2,7 @@
.\" This file is distributed according to the GNU General Public License.
.\" See the file COPYING in the top level source directory for details.
.\"
.TH IO_GETEVENTS 2 2012-05-08 "Linux" "Linux Programmer's Manual"
.TH IO_GETEVENTS 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
io_getevents \- read asynchronous I/O events from the completion queue
.SH "SYNOPSIS"
@ -15,6 +15,9 @@ io_getevents \- read asynchronous I/O events from the completion queue
.BI " struct io_event *" events \
", struct timespec *" timeout );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH "DESCRIPTION"
.PP
The

5
man2/io_setup.2
View File

@ -2,7 +2,7 @@
.\" This file is distributed according to the GNU General Public License.
.\" See the file COPYING in the top level source directory for details.
.\"
.TH IO_SETUP 2 2012-05-08 "Linux" "Linux Programmer's Manual"
.TH IO_SETUP 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
io_setup \- create an asynchronous I/O context
.SH "SYNOPSIS"
@ -11,6 +11,9 @@ io_setup \- create an asynchronous I/O context
.BI "int io_setup(unsigned " nr_events ", aio_context_t *" ctx_idp );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH "DESCRIPTION"
.PP
The

5
man2/io_submit.2
View File

@ -2,7 +2,7 @@
.\" This file is distributed according to the GNU General Public License.
.\" See the file COPYING in the top level source directory for details.
.\"
.TH IO_SUBMIT 2 2012-05-08 "Linux" "Linux Programmer's Manual"
.TH IO_SUBMIT 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
io_submit \- submit asynchronous I/O blocks for processing
.SH "SYNOPSIS"
@ -12,6 +12,9 @@ io_submit \- submit asynchronous I/O blocks for processing
.BI "int io_submit(aio_context_t " ctx_id ", long " nr \
", struct iocb **" iocbpp );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH "DESCRIPTION"
.PP
The

5
man2/ioprio_set.2
View File

@ -22,7 +22,7 @@
.\" with various additions by Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.\"
.TH IOPRIO_SET 2 2008-07-09 "Linux" "Linux Programmer's Manual"
.TH IOPRIO_SET 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
ioprio_get, ioprio_set \- get/set I/O scheduling class and priority
.SH SYNOPSIS
@ -30,6 +30,9 @@ ioprio_get, ioprio_set \- get/set I/O scheduling class and priority
.BI "int ioprio_get(int " which ", int " who );
.BI "int ioprio_set(int " which ", int " who ", int " ioprio );
.fi
.IR Note :
There are no glibc wrappers for these system calls; see NOTES.
.SH DESCRIPTION
The
.BR ioprio_get ()

5
man2/kexec_load.2
View File

@ -22,7 +22,7 @@
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH KEXEC_LOAD 2 2010-11-04 "Linux" "Linux Programmer's Manual"
.TH KEXEC_LOAD 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
kexec_load \- load a new kernel for later execution
.SH SYNOPSIS
@ -32,6 +32,9 @@ kexec_load \- load a new kernel for later execution
.br
.BI " struct kexec_segment *" segments \
", unsigned long " flags ");"
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
The
.BR kexec_load ()

5
man2/llseek.2
View File

@ -23,7 +23,7 @@
.\" Written 10 June 1995 by Andries Brouwer <aeb@cwi.nl>
.\" Modified Thu Oct 31 15:16:23 1996 by Eric S. Raymond <esr@thyrsus.com>
.\"
.TH LLSEEK 2 2007-06-01 "Linux" "Linux Programmer's Manual"
.TH LLSEEK 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
_llseek \- reposition read/write file offset
.SH SYNOPSIS
@ -35,6 +35,9 @@ _llseek \- reposition read/write file offset
.BI " unsigned long " offset_low ", loff_t *" result ,
.BI " unsigned int " whence );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
The
.BR _llseek ()

5
man2/modify_ldt.2
View File

@ -22,7 +22,7 @@
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
.\" USA.
.\"
.TH MODIFY_LDT 2 2007-06-01 "Linux" "Linux Programmer's Manual"
.TH MODIFY_LDT 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
modify_ldt \- get or set ldt
.SH SYNOPSIS
@ -31,6 +31,9 @@ modify_ldt \- get or set ldt
.sp
.BI "int modify_ldt(int " "func" ", void *" "ptr" ", unsigned long " "bytecount" );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
.BR modify_ldt ()
reads or writes the local descriptor table (ldt) for a process.

5
man2/mq_getsetattr.2
View File

@ -23,7 +23,7 @@
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH MQ_GETSETATTR 2 2010-08-29 "Linux" "Linux Programmer's Manual"
.TH MQ_GETSETATTR 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
mq_getsetattr \- get/set message queue attributes
.SH SYNOPSIS
@ -34,6 +34,9 @@ mq_getsetattr \- get/set message queue attributes
.BI "int mq_getsetattr(mqd_t " mqdes ", struct mq_attr *" newattr ","
.BI " struct mq_attr *" oldattr );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
Do not use this system call.

5
man2/pivot_root.2
View File

@ -4,11 +4,14 @@
.\" Written 2000-02-23 by Werner Almesberger
.\" Modified 2004-06-17 Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.TH PIVOT_ROOT 2 2007-06-01 "Linux" "Linux Programmer's Manual"
.TH PIVOT_ROOT 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
pivot_root \- change the root file system
.SH SYNOPSIS
.BI "int pivot_root(const char *" new_root ", const char *" put_old );
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
.BR pivot_root ()
moves the root file system of the calling process to the

8
man2/readdir.2
View File

@ -25,7 +25,7 @@
.\" In 1.3.X, returns only one entry each time; return value is different.
.\" Modified 2004-12-01, mtk, fixed headers listed in SYNOPSIS
.\"
.TH READDIR 2 2008-10-02 "Linux" "Linux Programmer's Manual"
.TH READDIR 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
readdir \- read directory entry
.SH SYNOPSIS
@ -34,6 +34,9 @@ readdir \- read directory entry
.BI "int readdir(unsigned int " fd ", struct old_linux_dirent *" dirp ","
.BI " unsigned int " count );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
This is not the function you are interested in.
Look at
@ -114,6 +117,9 @@ Glibc does not provide a wrapper for this system call; call it using
You will need to define the
.I old_linux_dirent
structure yourself.
However, probably you should use
.BR readdir (3)
instead.
.SH "SEE ALSO"
.BR getdents (2),
.BR readdir (3)

5
man2/rt_sigqueueinfo.2
View File

@ -20,7 +20,7 @@
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH RT_SIGQUEUEINFO 2 2011-09-18 "Linux" "Linux Programmer's Manual"
.TH RT_SIGQUEUEINFO 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
rt_sigqueueinfo, rt_tgsigqueueinfo \- queue a signal and data
.SH SYNOPSIS
@ -30,6 +30,9 @@ rt_sigqueueinfo, rt_tgsigqueueinfo \- queue a signal and data
.BI "int rt_tgsigqueueinfo(pid_t " tgid ", pid_t " tid ", int " sig ,
.BI " siginfo_t *" uinfo );
.fi
.IR Note :
There are no glibc wrappers for these system calls; see NOTES.
.SH DESCRIPTION
The
.BR rt_sigqueueinfo ()

10
man2/set_thread_area.2
View File

@ -4,7 +4,7 @@
.\"
.\" Author: Kent Yoder
.\"
.TH SET_THREAD_AREA 2 2008-11-27 "Linux" "Linux Programmer's Manual"
.TH SET_THREAD_AREA 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
set_thread_area \- Set a Thread Local Storage (TLS) area
.SH "SYNOPSIS"
@ -13,6 +13,9 @@ set_thread_area \- Set a Thread Local Storage (TLS) area
.B #include <asm/ldt.h>
.sp
.BI "int set_thread_area(struct user_desc *" u_info );
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH "DESCRIPTION"
.BR set_thread_area ()
sets an entry in the current thread's Thread Local Storage (TLS) array.
@ -61,8 +64,9 @@ first appeared in Linux 2.5.29.
is Linux-specific and should not be used in programs that are intended
to be portable.
.SH NOTES
Glibc does not provide a wrapper for this system call;
call it using
Glibc does not provide a wrapper for this system call,
since it is generally intended only for use by threading libraries.
In the unlikely event that you want to call it directly, use
.BR syscall (2).
.SH "SEE ALSO"
.BR get_thread_area (2)

8
man2/sgetmask.2
View File

@ -21,13 +21,16 @@
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH SGETMASK 2 2007-07-05 "Linux" "Linux Programmer's Manual"
.TH SGETMASK 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
sgetmask, ssetmask \- manipulation of signal mask (obsolete)
.SH SYNOPSIS
.B "long sgetmask(void);"
.sp
.BI "long ssetmask(long " newmask );
.IR Note :
There are no glibc wrappers for these system calls; see NOTES.
.SH DESCRIPTION
These system calls are obsolete.
.IR "Do not use them" ;
@ -61,7 +64,8 @@ These system calls always succeed.
.SH CONFORMING TO
These system calls are Linux-specific.
.SH NOTES
Glibc does not provide wrappers for these system calls; use
Glibc does not provide wrappers for these obsolete system calls;
in the unlikely event that you want to call them, use
.BR syscall (2).
These system calls are unaware of signal numbers greater than 31

5
man2/spu_create.2
View File

@ -21,7 +21,7 @@
.\" 2007-07-10, some polishing by mtk
.\" 2007-09-28, updates for newer kernels by Jeremy Kerr <jk@ozlabs.org>
.\"
.TH SPU_CREATE 2 2007-12-20 Linux "Linux Programmer's Manual"
.TH SPU_CREATE 2 2012-07-13 Linux "Linux Programmer's Manual"
.SH NAME
spu_create \- create a new spu context
.SH SYNOPSIS
@ -33,6 +33,9 @@ spu_create \- create a new spu context
.BI "int spu_create(const char *" pathname ", int " flags ", mode_t " mode ","
.BI " int " neighbor_fd ");"
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
The
.BR spu_create ()

5
man2/spu_run.2
View File

@ -22,7 +22,7 @@
.\" 2007-09-28, updates for newer kernels, added example
.\" by Jeremy Kerr <jk@ozlabs.org>
.\"
.TH SPU_RUN 2 2007-11-25 Linux "Linux Programmer's Manual"
.TH SPU_RUN 2 2012-07-13 Linux "Linux Programmer's Manual"
.SH NAME
spu_run \- execute an SPU context
.SH SYNOPSIS
@ -32,6 +32,9 @@ spu_run \- execute an SPU context
.BI "int spu_run(int " fd ", unsigned int *" npc \
", unsigned int *" event ");"
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
The
.BR spu_run ()

8
man2/subpage_prot.2
View File

@ -25,7 +25,7 @@
.\" in kernel commit fa28237cfcc5827553044cbd6ee52e33692b0faa
.\" both written by Paul Mackerras <paulus@samba.org>
.\"
.TH SUBPAGE_PROT 2 2010-10-30 "Linux" "Linux Programmer's Manual"
.TH SUBPAGE_PROT 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
subpage_prot \- define a subpage protection for an address range
.SH SYNOPSIS
@ -33,6 +33,9 @@ subpage_prot \- define a subpage protection for an address range
.BI "long subpage_prot(unsigned long " addr ", unsigned long " len ,
.BI " uint32_t *" map ");
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
The PowerPC-specific
.BR subpage_prot ()
@ -91,6 +94,9 @@ No library support is provided.
.SH CONFORMING TO
This system call is Linux-specific.
.SH NOTES
Glibc does not provide a wrapper for this system call; call it using
.BR syscall (2).
Normal page protections (at the 64-kB page level) also apply;
the subpage protection mechanism is an additional constraint,
so putting 0 in a 2-bit field won't allow writes to a page that is otherwise

10
man2/sysctl.2
View File

@ -25,7 +25,7 @@
.\" Modified Tue Oct 22 22:28:41 1996 by Eric S. Raymond <esr@thyrsus.com>
.\" Modified Mon Jan 5 20:31:04 1998 by aeb.
.\"
.TH SYSCTL 2 2008-11-20 "Linux" "Linux Programmer's Manual"
.TH SYSCTL 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
sysctl \- read/write system parameters
.SH SYNOPSIS
@ -36,6 +36,9 @@ sysctl \- read/write system parameters
.sp
.BI "int _sysctl(struct __sysctl_args *" args );
.fi
.IR Note :
There is no glibc wrapper for this system call; see NOTES.
.SH DESCRIPTION
.B Do not use this system call!
See NOTES.
@ -109,8 +112,9 @@ function is the same in both.
.SH NOTES
Glibc does not provide a wrapper for this system call; call it using
.BR syscall (2).
Or rather... don't call it:
Or rather...
.I don't
call it:
use of this system call has long been discouraged,
and it is so unloved that
\fBit is likely to disappear in a future kernel version\fP.

5
man2/tkill.2
View File

@ -26,7 +26,7 @@
.\" 2004-05-31, added tgkill, ahu, aeb
.\" 2008-01-15 mtk -- rewote DESCRIPTION
.\"
.TH TKILL 2 2011-09-18 "Linux" "Linux Programmer's Manual"
.TH TKILL 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.SH NAME
tkill, tgkill \- send a signal to a thread
.SH SYNOPSIS
@ -35,6 +35,9 @@ tkill, tgkill \- send a signal to a thread
.sp
.BI "int tgkill(int " tgid ", int " tid ", int " sig );
.fi
.IR Note :
There are no glibc wrappers for these system calls; see NOTES.
.SH DESCRIPTION
.BR tgkill ()
sends the signal