ready for 2.26

4 files changed, 338 insertions, 59 deletions

diff --git a/Changes b/Changes
index bea08b4b1..20413c79d 100644
--- a/Changes
+++ b/Changes
@@ -1,6 +1,6 @@
-==================== Changes in man-pages-2.25 ====================
+==================== Changes in man-pages-2.26 ====================
 
-Released: 2006-03-02
+Released: 2006-03-21
 
 Contributors
 ------------
@@ -8,57 +8,191 @@ Contributors
 The following people contributed notes, ideas, or patches that have
 been incorporated in changes in this release:
 
-James Peach <jpeach@samba.org>
-Krzysztof Benedyczak <golbi@mat.uni.torun.pl>
-Marten von Gagern <Martin.vGagern@gmx.net>
-Michael Haardt <michael@moria.de>
-Michael Wronksi <michal.wronski@gmail.com>
+Alain Portal <aportal@univ-montp2.fr>
+Andi Kleen <ak@muc.de>
+Andries Brouwer <Andries.Brouwer@cwi.nl>
+Christoph Lameter <clameter@engr.sgi.com>
+Hasso Tepper <hasso@estpak.ee>
+Justin Pryzby <justinpryzby@users.sourceforge.net>
+Martin (Joey) Schulze <joey@infodrom.org>
+Nicolas Francois <nicolas.francois@centraliens.net>
+Paul Brook <paul@nowt.org>
+Siward de Groot <siward@wanadoo.nl>
+Steve Beattie <sbeattie@suse.de>
+Walter Harms <walter.harms@informatik.uni-oldenburg.de>
 
 Apologies if I missed anyone!
 
+Global changes
+--------------
+
+clone.2
+getdents.2
+gettid.2
+llseek.2
+mmap2.2
+modify_ldt.2
+pivot_root.2
+quotactl.2
+readdir.2
+sysctl.2
+syslog.2
+tkill.2
+    mtk, aeb, Steve Beattie
+        Added comment in SYNOPSIS to note that syscall(2) may be 
+        preferable over _syscallN (see intro(2)).
+
+Various minor formatting changes were done on a range of 
+pages in Section 7.  (No content was changed.)
 
 New pages
 ---------
 
-mq_close.3
-mq_getattr.3
-mq_notify.3
-mq_open.3
-mq_receive.3
-mq_send.3
-mq_unlink.3
+intro.2
+    mtk, aeb, Steve Beattie
+        Added some notes on syscall(2) versus _syscall.
+    
+openat.2
     mtk
-        New pages describing POSIX message queue API.
+        New page describing openat(2), added in kernel 2.6.16,
+        and some notes on rationale for the at*(2) system calls.
 
-posix_fallocate.3
-    mtk, after a suggestion by James Peach
-        New page describing posix_fallocate().
-    
-mq_overview.7
+mbind.2
+    Andi Kleen, Christoph Lameter, mtk
+       Added MPOL_MF_MOVE and MPOL_MF_MOVE_ALL descriptions,
+       from numactl-0.9.2 man page.
+       Plus a few other smaller fixes.
+
+ushare.2
+    mtk
+        New page describing unshare(2), added in kernel 2.6.16.
+
+fexecve.3
     mtk
-        New page giving overview of the POSIX message queue API.
+        New page describing fexecve(3).
 
+futimes.3
+    mtk
+        New page describing futimes(3).
+
+undocumented.3
+    mtk
+        Updated to remove a few function names that are now documented.
 
 Changes to individual pages
 ---------------------------
 
-lseek.2
-    Michael Haardt
-        Add a case to the EINVAL error text.
+clone.2
+fork.2
+vfork.2
+    mtk
+        Added SEE ALSO pointing to new unshare.2.
+
+execve.2
+    mtk
+        Added SEE ALSO pointing to new fexecve.3.
+
+msgctl.2
+msgget.2
+msgop.2
+    mtk
+        Added SEE ALSO pointing to mq_overview.7.
+
+open.2
+    mtk
+        Added SEE ALSO pointing to new openat.2.
+        
+        Split out part of the RETURN VALUE text into separate 
+        NOTES section.
+
+        Modified wording referring that refers to raw(8) to
+        indicate that this interface is deprecated.
+
+poll.2
+    mtk
+        Added discussion of ppoll(2), which is new in 2.6.16.
+    
+ppoll.2
+    mtk
+        New link to poll.2.
+
+recvmsg.2
+sendmsg.2
+    mtk / Paul Brook
+        Added text to note that although POSIX says msg_controllen 
+        should be socklen_t, glibc actually uses size_t.
+        See Debian bug 356502 and the associated glibc bug report.
+        http://sourceware.org/bugzilla/show_bug.cgi?id=2448.
+    mtk
+        Various formatting fixes.
+
+select.2
+    mtk
+        Updated to reflect the fact that pselect() has been implemented
+        in the kernel in 2.6.16; various other minor wording changes.
+
+        pselect() prototype needs "#define _XOPEN_SOURCE 600".
+
+tempnam.3
+    Justin Pryzby
+        Clean up description of EEXIST error.
+        Debian bug 357893
+
+unlink.2
     mtk
-        Various minor wording fixes
-        Added SEE ALSO referring to new posix_fallocate.3.
+        Added a little extra text to clarify EISDIR vs EPERM.
 
-posix_fadvise.2
+utime.2
     mtk
-        Added "#define _XOPEN_SOURCE 600" to prototype.
-        Added SEE ALSO referring to new posix_fallocate.3.
+        Added new SEE ALSO entry pointing to new futimes.3 page.
 
-proc.5
+exec.3
+    mtk
+        Added SEE ALSO pointing to new fexecve.3.
+
+shm_unlink.3
+    mtk
+        New link to shm_open.3 (should have been made when page
+        was originally written).
+
+swab.3
+    Walter Harms
+        Add needed "#define _XOPEN_SOURCE".
+        
+capabilities.7
     mtk
-        Migrated information on POSIX message queues to new mqueue.7 page.
+        Various changes to bring this page closer to
+        current kernel versions.
 
 inotify.7
-    Marten von Gagern
-        Fix thinko: s/assuming a non-blocking/assuming a blocking/
+    mtk
+        Noted that glibc 2.4 is required to get glibc support
+        for inotify.
+
+mq_overview.7
+    mtk
+        Some rewording and added a few words about System V 
+        message queues.
+
+netlink.7
+    Hasso Tepper
+        Substantial updates to various parts of this page.
+    mtk, Alain Portal
+        Minor fixes
+
+pthreads.7
+    mtk
+        Updated to reflect that the NPTL limitation that only the main 
+        thread could call setsid() and setpgid() was removed in 2.6.16.
+
+raw.7
+    Hasso Tepper
+        Removed text implying that only in kernel 2.2 does IP_HDRINCL 
+        prevent datagrams from being fragmented.
+
+socket.7
+    mtk
+        Documented SO_SNDBUFFORCE and SO_RCVBUFFORCE socket options,
+        new in 2.6.14.
 
+        Placed socket options in alphabetical order.
diff --git a/Changes.old b/Changes.old
index 08fd7f5db..0d7c4e31c 100644
--- a/Changes.old
+++ b/Changes.old
@@ -54,7 +54,7 @@ of several Section 2 pages using the _syscallN() macros.
         -- erroneous semicolons at the end of _syscallN() were removed
            on various pages.
 
-        -- types such as "uint" in syscalN() declarations were changed
+        -- types such as "uint" in syscallN() declarations were changed
            to "unsigned int", etc.
 
         -- various other minor breakages in the synopses were fixed.
@@ -329,7 +329,7 @@ netdevice.7
    
 signal.7
     mtk
-        /proc/sys/kernel/rtsig-* were superceded by RLIMIT_SIGPENDING
+        /proc/sys/kernel/rtsig-* were superseded by RLIMIT_SIGPENDING
             in kernel 2.6.8.
             
 tcp.7
@@ -895,7 +895,7 @@ log1p.3
 
 makecontext.3
     Tanaka Akira
-        Fix description of RETURN VAUE for makecontext()
+        Fix description of RETURN VALUE for makecontext()
         As per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=311800
 
 on_exit.3
@@ -1001,7 +1001,7 @@ close.2
 dup.2
     mtk
         Consistent use of terms "open file description",
-            "file status flags", and "file decriptor flags"
+            "file status flags", and "file descriptor flags"
         Removed mention of lock sharing -- it was not
             accurate.
         Minor formatting fixes
@@ -1009,7 +1009,7 @@ dup.2
 fcntl.2
     mtk
         Consistent use of terms "open file description",
-            "file status flags", and "file decriptor flags"
+            "file status flags", and "file descriptor flags"
         Some rewriting of discussion of file descriptor flags
         Under F_DUPFD, replaced some text duplicated in dup.2
             with a cross ref to dup.2
@@ -1018,7 +1018,7 @@ fcntl.2
 fpclassify.3
     mtk / Martin (Joey) Schulze / Bas Zoetekouw
         The return value of isinf() changed in glibc 2.02
-        to differentiate positive and neagtive infinity.
+        to differentiate positive and negative infinity.
         See: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=285765
 
 getgid.2
@@ -1159,7 +1159,7 @@ Removed Pages
 
 sstk.2
     mtk
-        AFAIK, this sytem call has never actually done anything (other
+        AFAIK, this system call has never actually done anything (other
             than be a stub) on any Unix.
 
 Changes to individual pages
@@ -2288,7 +2288,7 @@ HOWTOHELP
 
 poll.2
    mtk
-       Added NOTES about INFTIM contant provided on some other 
+       Added NOTES about INFTIM constant provided on some other 
        implementations.
        
 shmop.2
diff --git a/HOWTOHELP b/HOWTOHELP
index a2fba9358..0756ec317 100644
--- a/HOWTOHELP
+++ b/HOWTOHELP
@@ -1,5 +1,14 @@
 The following notes are written for people who want to help with 
-maintaining manual pages in the man-pages package.
+maintaining manual pages in the Linux man-pages package.
+
+Send suggestions and corrections to:
+
+        mtk-manpages@gmx.net
+
+Cheers
+
+Michael Kerrisk
+man-pages maintainer
 
 
 THINGS YOU CAN DO TO HELP
@@ -168,11 +177,15 @@ function.  However, note the following:
    description of the interface.  An example program that does nothing 
    other than call an interface usually serves little purpose.
 
--- Example programs should be fairly short.
+-- Example programs should be fairly short (preferably < 100 lines;
+   ideally < 50 lines).
 
 -- Example programs should do error checking after system calls and 
    library function calls.
 
+-- Exaample programs should be commplete, and compile without 
+   warnings when compiled with "cc -Wall",
+
 -- Where possible and appropriate, example programs should allow 
    experimentation, by varying their behaviour based on inputs 
    (ideally from command-line arguments, or alternatively, via 
@@ -185,7 +198,7 @@ Ritchie, with a few concessions:
    may be okay.  (Avoid the use of TAB characters in source code!)
 
 -- In the interests of keeping a program short, compressing 
-   error-handling code as follows is acceptable:
+   error-handling code such as the following is acceptable:
 
         if (func(...) == -1)
             { perror("func"); exit(EXIT_FAILURE); }
@@ -242,20 +255,58 @@ If you are thinking of writing one or more of these pages, then:
 System Calls
 ------------
 
-add_key(2)  
-keyctl(2)  
-request_key(2)  
+add_key(2)  	    (new in 2.6.10)
+keyctl(2)  	    (new in 2.6.10)
+request_key(2) 	    (new in 2.6.10)
     See:
         Documentation/keys.txt
         Documentation/keys-request-key.txt
+
         
 ioprio_get(2)       (new in kernel 2.6.13) 
 ioprio_set(2)       (new in kernel 2.6.13)
     See Documentation/block/ioprio.txt
 
+
 restart_syscall(2)  (new in 2.6)
 set_zone_reclaim(2) (new in kernel 2.6.13)
-sys_kexec_load(2)   (new in kernel 2.6.13)
+kexec_load(2)       (new in kernel 2.6.13)
+
+migrate_pages(2)    (new in 2.6.16)
+		    See Documentation/vm/page_migration
+
+preadv(2), pwritev(2) (new in ?? -- see 
+                       http://www.lwn.net/Articles/164887/ )
+    
+    
+epoll_pwait(2)        (probably will arrive in 2.6.17)
+
+    
+The new *at(2) system calls in 2.6.16: 
+
+    openat(2)       S                           [Already documented]
+    faccessat(2)
+    fstatat(2)      S   f (AT_SYMLINK_NOFOLLOW)
+    fchmodat(2)
+    fchownat(2)     S   f (AT_SYMLINK_NOFOLLOW)
+    futimesat(2)    S                           [See also glibc wrapper]
+    mkdirat(2)
+    mknodat(2)
+    linkat(2)         2
+    unlinkat(2)     S   f (AT_REMOVEDIR)
+    symlinkat(2)
+    readlinkat(2)
+    renameat(2)       2
+
+In the above list: functions marked '2' take two dirfd arguments; 
+functions marked 'f' take a flags argument that is not present 
+in their traditional counterparts (and possible flag values
+are listed in parentheses); and functions marked 'S' have
+counterparts (not exactly the same) on Solaris.
+
+Note that openat(2) is already documented and includes some NOTES 
+on the rationale for the *at() interfaces; this page could serve 
+as a template for the documentation of the remaining system calls.
 
 
 /sys file system
@@ -270,27 +321,108 @@ this page.
 Library Functions
 -----------------
 
-(See a further list of missing pages in the "undocumented(3)" manual page.)
+(See a further list of missing pages in the "undocumented(3)" manual page.
+
+Searches like the following are likely to sugest other functions
+that need to be documented:
+
+
+MPDIR=~/man-pages	# Directory containing uncopressed man-pages
+GLIBCDIR=/SOME_DIR      # Directory containing glibc tree
+
+for f in  $(cat $(echo $GLIBCDIR/abilist/*.abilist) | grep -v 'GLIBC' | \
+	awk '{print $1}' | grep -v '^_' | sort -u); do 
+    if ! test -f $MPDIR/man3/$f.3 > /dev/null 2>&1 && \
+		! test -f $MPDIR/man2/$f.2 > /dev/null 2>&1 ; then
+	echo $f; 
+    fi
+done
+)
 
 adjtime(3)  
-dlinfo(3)   (Solaris and FreeBSD have a similar function.)
+bsd_signal(3)
+clock_nanosleep(3)
+crypt_r(3)    (To be added to crypt.3)
+dlinfo(3)     (Solaris and FreeBSD have a similar function.)
 dladdr1(3)
-dlmopen(3) (Since glibc 2.3.4; probably to be documented on dlopen.3 page)
-memmem(3) (GNU extension)
-readdir_r(3) (probably as additional text in readdir.3)
+dlmopen(3)    (Since glibc 2.3.4; probably to be documented in dlopen.3)
+euidaccess(3) / eaccess(3)
+fdopendir(3)  (since glibc 2.4)
+fopencookie(3)
+getsubopt(3)
+getutmp(3)
+getutmpx(3)
+gnu_get_libc_release
+gnu_get_libc_version
+mallinfo(3)
+mallopt(3)
+mcheck(3), mprobe(3)
+memmem(3)     (GNU extension)
+mkfifoat(3) -- see notes on the *at(2) syscalls above (since glibc 2.4)
+readdir_r(3)  (probably as additional text in readdir.3)
+open_wmemstream(3)   (since glibc 2.4)
+posix_madvise(3)
+program_invocation_name(3)
+program_invocation_short_name(3)
 sigstack(3)
 sigwait(3)
+sockatmasrk(3)
 strftime_l(3) (since glibc 2.3)
 strptime_l(3) (since glibc 2.3.2)
+sysv_signal(3)
+updwtmpx(3)
+
+sigandset(3), sigosset(3), sigisemptyset(3) 
+    (perhaps on same page as sigemptyset(3))
+
+fwscanf(3), swscanf(3), vfwscanf(3), vswscanf(3), wscanf(3) 
+
+
+argp_error(3)
+argp_failure(3)
+argp_help(3)
+argp_parse(3)
+argp_program_bug_address(3)
+argp_program_version(3)
+argp_program_version_hook(3)
+argp_state_help(3)
+argp_usage(3)
+
+
+posix_spawn(3)
+posix_spawnattr_destroy(3)
+posix_spawnattr_getflags(3)
+posix_spawnattr_getpgroup(3)
+posix_spawnattr_getschedparam(3)
+posix_spawnattr_getschedpolicy(3)
+posix_spawnattr_getsigdefault(3)
+posix_spawnattr_getsigmask(3)
+posix_spawnattr_init(3)
+posix_spawnattr_setflags(3)
+posix_spawnattr_setpgroup(3)
+posix_spawnattr_setschedparam(3)
+posix_spawnattr_setschedpolicy(3)
+posix_spawnattr_setsigdefault(3)
+posix_spawnattr_setsigmask(3)
+posix_spawn_file_actions_addclose(3)
+posix_spawn_file_actions_adddup2(3)
+posix_spawn_file_actions_addopen(3)
+posix_spawn_file_actions_destroy(3)
+posix_spawn_file_actions_init(3)
+posix_spawnp(3)
+
+
+if_freenameindex(3)
+if_indextoname(3)
+if_nameindex(3)
+if_nametoindex(3)
 
-The POSIX semaphores API: sem_close(3), sem_destroy(3), 
-sem_getvalue(3), sem_init(3), sem_open(3), sem_post(3), 
-sem_timedwait(3), sem_trywait(3), sem_unlink(3) 
 
 getaddrinfo_a(3), gai_cancel(3), gai_error(3), gai_suspend(3) 
 (libanl; since glibc 2.2.3; See 
 http://people.redhat.com/~drepper/asynchnl.pdf)
 
+
 Various wide character functions (with their traditional equivalents 
 mentioned in parentheses):
 
@@ -315,6 +447,7 @@ wcsftime(3)      (strftime(3))
         After these manual pages are written, add SEE ALSO entries 
         from the pages for the traditional functions to the pages 
         describing their wide-character equivalents.
+
     
 And last, but far from least, the POSIX threads API.  Note that there is
 an existing, outdated set of pages supplied with glibc that document the
@@ -325,8 +458,8 @@ the complete API, describing details where LinuxThreads and NPTL diverge
 from the standard.  The existing pthreads(7) manual page, which gives an 
 overview of Pthreads implementations on Linux,  is designed as a base 
 document for these manual pages.  The list of required manual pages is
-long; those marked with more asterisks are probably the most desirable 
-to get done first:
+long (related functions can be grouped on a single page); those marked 
+with more asterisks are probably the most desirable to get done first:
 
 pthread_atfork()                        *
 pthread_attr_destroy()                  
@@ -436,3 +569,15 @@ pthread_timedjoin_np()
 pthread_tryjoin_np()
 pthread_yield()                         *
 pthread_yield_np()
+
+And new in glibc 2.4:
+
+pthread_mutex_consistent_np()
+pthread_mutexattr_getrobust_np()
+pthread_mutexattr_setrobust_np()
+pthread_mutexattr_getprotocol()
+pthread_mutexattr_setprotocol()
+pthread_mutexattr_getprioceiling()
+pthread_mutexattr_setprioceiling()
+pthread_mutex_getprioceiling()
+pthread_mutex_setprioceiling()
diff --git a/man-pages-2.26.lsm b/man-pages-2.26.lsm
index 5883d617d..467926ffe 100644
--- a/man-pages-2.26.lsm
+++ b/man-pages-2.26.lsm
@@ -1,7 +1,7 @@
 Begin3
 Title:          Section 2, 3, 4, 5 and 7 man pages for Linux
 Version:        2.26
-Entered-date:   2005-??-??
+Entered-date:   2005-03-21
 Description:    Linux and POSIX manual pages
 Keywords:       man pages
 Author:         several