Commit Graph

8768 Commits

Author SHA1 Message Date
Radek Pazdera 95e1ffd564 ip.7: Document IP_MULTICAST_ALL
This commit adds documentation for the IP_MULTICAST_ALL socket
option.

The option was added to the Linux kernel in 2.6.31:

    Author Nivedita Singhvi <niv@us.ibm.com>
    Commit f771bef98004d9d141b085d987a77d06669d4f4f

The description is based on a previous one [3] posted by the
original author of the code -- Nivedita, but it is slightly
re-worded.

I tested it myself and it works as described.

References:
    [1] http://lxr.free-electrons.com/source/net/ipv4/ip_sockglue.c#L972
    [2] http://lxr.free-electrons.com/source/net/ipv4/igmp.c#L2267
    [3] http://patchwork.ozlabs.org/patch/28902/

Signed-off-by: Radek Pazdera <rpazdera@redhat.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 07:26:27 +02:00
Michael Kerrisk 72d34312e8 access.2: Clarify RETURN VALUE for F_OK
See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=705293

Reported-by: The Wanderer <wanderer@fastmail.fm>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 07:26:26 +02:00
Michael Kerrisk 2c28d337cb io_cancel.2: Improve description
Reported-by: Cyril Hrubis <chrubis@suse.cz>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 07:26:26 +02:00
Jeff Moyer 9f621816bc io_cancel.2: Improve description
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 07:26:26 +02:00
Jeff Moyer 1d79f88e2e io_destroy.2: Improve description
The description was rather vague, citing a "list of I/O contexts"
and stating that it "can" cancel outstanding requests.  This
update makes things more concrete so that the reader knows exactly
what's going on.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 07:26:26 +02:00
Jeff Moyer 3d083fa4de io_setup.2: Clarify nr_events
nr_events is technically the number of completion events that can
be stored in the completion ring.  The wording of the man page:
"capable of receiving at least nr_events" seems dubious to me,
only because I worry that folks might interpret that to mean
'nr_events' total, instead of 'nr_events' concurrently.

Further, I've added information on where to find the per-user
limit on 'nr_events', /proc/sys/fs/aio-max-nr.  Let me know if
you think that is not relevant.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 07:26:15 +02:00
Jeff Moyer c102d780c0 io_getevents.2: The 'timeout' argument is not updated
I looked back through the kernel code, and the timeout was
never updated in any case.  I've submitted a patch upstream
to change the comment above io_getevents.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 05:03:09 +02:00
Michael Kerrisk cc66e8b454 listxattr.2: Explain use of 'size' argument
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 05:03:09 +02:00
Michael Kerrisk a895613945 getcpu.2: Recommend that 'tcache' should be specified as NULL nowadays
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 05:03:09 +02:00
Mike Frysinger 7e8740aedd elf.5: Add byte positions for all EI_xxx fields
When describing e_ident, most of the EI_xxx defines mention the
exact byte number.  This is useful when manually hacking an ELF
with a hex editor.  However, the last few fields don't do this,
which means you have to count things up yourself.
Add a single word to each so you don't have to do that.

Signed-off-by: Mike Frysinger <vapier@gentoo.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 05:03:09 +02:00
Michael Kerrisk 39b6689e36 syscall.2: tfix
Reported-by: Mike Frysinger <vapier@gentoo.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-16 05:03:09 +02:00
Michael Kerrisk 08c9b3b9c8 syscall.2: Move "Architecture calling conventions" subsection
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Mike Frysinger 9390ee75bb syscall.2: Add PA-RISC details under calling conventions
Reviewed-by: Kyle McMartin <kyle@mcmartin.ca>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Michael Kerrisk 602c75a875 syscall.2: Improve "Architecture calling conventions" subsection
Split into tables so that the information does not render wider
than 80 columns. Add some explanation of tables and table columns.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Mike Frysinger d1c98faff7 syscall.2: Document the exact calling convention for architecture system calls
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Michael Kerrisk a60b1f03ae capabilities.7: srcfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Michael Kerrisk ddcf25aaab proc.5: Document /proc/sys/kernel/shm_rmid_forced
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Michael Kerrisk 0ef4c35ecb proc.5: Refer to sched_rr_get_interval(2) for info on sched_rr_timeslice_ms
Since Linux 3.9, /proc/sys/kernel/sched_rr_timeslice_ms can
be used to change the SCHED_RR quantum.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Michael Kerrisk 6565680737 sched_rr_get_interval.2: Document /proc/sys/kernel/sched_rr_timeslice_ms
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Michael Kerrisk a7a8cc53df proc.5: Add reference to capabilities(7) for /proc/sys/kernel/cap_last_cap
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Michael Kerrisk afae50e4aa capabilities.7: Document /proc/sys/kernel/cap_last_cap
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Brian M. Carlson a7a8f3b088 units.7: units should use an actual µ
The units(7) man page uses an ASCII u in place of the actual Greek
letter mu.  Since we're in the twenty-first century, with
UTF-8-compatible terminals and terminal emulators, we should use
the actual letter µ instead of an ASCII approximation.

See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=704787

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-08 12:32:44 +02:00
Mike Frysinger 6acbcbc659 quotactl.2: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-07 10:41:49 +02:00
Andrew Clayton 1ba74ca217 pthread_setname_np.3: The thread argument is passed in by value
Signed-off-by: Andrew Clayton <andrew@digital-domain.net>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-02 09:12:53 +02:00
Michael Kerrisk ca972ff960 syscall.2: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-02 09:11:02 +02:00
Michael Kerrisk 63ec43ae07 posix_fadvise.2, pread.2, readahead.2, sync_file_range.2, truncate.2: Refer to syscall(2) for ABI semantics on certain 32-bit architectures
Also: in sync_file_range.2 and posix_fadvise.2 remove description
of conventional calling signature as flawed, and in
posix_fadvise.2, de-emphasize focus on ARM, and rather phrase
as a more general discussion of certain architectures.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-02 08:08:14 +02:00
Michael Kerrisk bed6b26e9f syscall.2: Corrections and improvements to Changhee Han's patch
Reported-by: Mike Frysinger <vapier@gentoo.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
Michael Kerrisk 9e5c5e5f00 syscall.2: Refine discussion of ARM and other ABIs
Reported-by: Mike Frysinger <vapier@gentoo.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
Michael Kerrisk 9525301640 syscall.2: Minor fix-ups to Changhee Han's patch
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
Changhee Han 638fd4bfda syscall.2: Add notes that caution users when passing arguments to syscall()
For example, passing 'long long' on ARM-32 requires special
treatment.

Signed-off-by: Changhee Han <ch0.han@lge.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
Simon Paillard b18188c545 time.1, addseverity.3, fdim.3, fmtmsg.3, getttyent.3, key_setsecret.3, setnetgrent.3, tty_ioctl.4: License headers: consistent format
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
Simon Paillard 6229018159 kcmp.2, quotactl.2, subpage_prot.2, get_nprocs_conf.3, if_nameindex.3, if_nametoindex.3: tfix
There are some extra dots in the license text compared to original one.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
Michael Kerrisk cd05d2ff0b sched_getcpu.3: Update feature test macro requirements
The requirements quietly changed changed in glibc 2.14

See also http://www.sourceware.org/bugzilla/show_bug.cgi?id=4749

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
Michael Kerrisk 33a0ccb293 intro.1, _syscall.2, access.2, arch_prctl.2, cacheflush.2, chown.2, clock_getres.2, clone.2, create_module.2, fcntl.2, flock.2, get_kernel_syms.2, get_robust_list.2, get_thread_area.2, getcpu.2, getpriority.2, getrlimit.2, getrusage.2, ioprio_set.2, kexec_load.2, madvise.2, mbind.2, migrate_pages.2, mknod.2, mmap.2, mount.2, move_pages.2, mprotect.2, open.2, pause.2, pciconfig_read.2, perf_event_open.2, prctl.2, ptrace.2, query_module.2, read.2, reboot.2, recv.2, s390_runtime_instr.2, sched_setscheduler.2, select_tut.2, send.2, set_mempolicy.2, setfsgid.2, setfsuid.2, sigaction.2, spu_create.2, spu_run.2, stime.2, swapon.2, syslog.2, timer_create.2, timer_getoverrun.2, times.2, tkill.2, umount.2, unimplemented.2, ustat.2, vm86.2, wait.2, abs.3, aio_read.3, aio_write.3, bsd_signal.3, catgets.3, clearenv.3, cmsg.3, dbopen.3, dirfd.3, dlopen.3, exec.3, fenv.3, ferror.3, fmemopen.3, fnmatch.3, fopen.3, futimes.3, getaddrinfo.3, getifaddrs.3, getipnodebyname.3, hsearch.3, if_nameindex.3, inet_pton.3, mblen.3, mbrlen.3, mbsrtowcs.3, mbtowc.3, mcheck.3, memfrob.3, mq_notify.3, netlink.3, posix_memalign.3, printf.3, pthread_attr_setscope.3, pthread_cleanup_push.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setcancelstate.3, pthread_setconcurrency.3, raise.3, resolver.3, rpc.3, rtime.3, rtnetlink.3, scanf.3, setbuf.3, setnetgrent.3, shm_open.3, sigpause.3, sigset.3, sigwait.3, sockatmark.3, strcasecmp.3, strcmp.3, strdup.3, strftime.3, strptime.3, strsignal.3, strverscmp.3, sysv_signal.3, termios.3, wcrtomb.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wctomb.3, wprintf.3, console_codes.4, cpuid.4, msr.4, rtc.4, sk98lin.4, st.4, tty.4, charmap.5, core.5, elf.5, hosts.equiv.5, proc.5, resolv.conf.5, services.5, slabinfo.5, arp.7, bootparam.7, capabilities.7, charsets.7, cpuset.7, ddp.7, epoll.7, feature_test_macros.7, futex.7, hier.7, icmp.7, inotify.7, ip.7, ipv6.7, man-pages.7, mdoc.7, mdoc.samples.7, netdevice.7, netlink.7, numa.7, packet.7, path_resolution.7, posixoptions.7, pthreads.7, raw.7, rtld-audit.7, rtnetlink.7, sem_overview.7, sigevent.7, socket.7, spufs.7, tcp.7, udp.7, unicode.7, uri.7, utf-8.7, intro.8, ldconfig.8, sync.8: Global fix: fix placement of word "only"
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
Michael Kerrisk 90878f7c26 proc.5: wfix (mainly "only")
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
Michael Kerrisk 3580a42f2f proc.5: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:46 +02:00
David Prévot 16e64bae16 proc.5: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Michael Kerrisk 1e9736f39d getdents.2: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
David Prévot b36f83cf95 getdents.2: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Krzysztof Konopko 1391278030 proc.5: Simplify the example of printing out environ
The binutils package contains a very handy utility to
print out null-byte delimited strings from a file.  This
can replace a rather complex expression with cat(1)
provided as an example for printing out /proc/[pid]/environ.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Michael Kerrisk b6bc918e7a syscalls.2, iso_8859-5.7, iso_8859-7.7, koi8-r.7, koi8-u.7: Table edits to eliminate warnings
Eliminate tbl warning "table wider than line width".

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Michael Kerrisk ab13a138cd sched_setscheduler.2: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Simon Paillard 182090db96 proc.5: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Michael Kerrisk b4be4f08bb lseek.2: _GNU_SOURCE must be defined to get SEEK_DATE and SEEK_HOLE definitions
See http://sourceware.org/bugzilla/show_bug.cgi?id=15312

Reported-by: Andreas Jaeger <aj@suse.de>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Michael Kerrisk d80cadc13a readdir.2: readdir(2) doesn't exist on x86-64
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Michael Kerrisk 09ddc8db5c arch_prctl.2: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Michael Kerrisk b41a5d542d semop.2: Clarify the discussion of 'semadj'
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-04-01 14:53:45 +02:00
Michael Kerrisk 73f4bf1eab readir.3, seekdir.3, telldir.3: Eliminate the implication that these functions deal with "offsets"
The directory position dealt with by the readdir() and
friends is not a simple file offset in modern file systems.
Typically, it is some kind of cookie value. Add text and
make other changes to these pages to eliminate the
implication that this is an offset, and warn the reader
that directory positions should be treated strictly as
opaque values.

In the process, rename the 'offset' argument of seekdir(3)
to 'loc', and add some text to readdir(3) to note that
the 'd_off' field is the same value returned by telldir(3)
at the current directory position.

See also https://lwn.net/Articles/544298/

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-25 13:03:39 +01:00
Michael Kerrisk eda9aaf6ba getdents.2: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-25 12:12:28 +01:00
Michael Kerrisk b7ac18e926 umask.2: SEE ALSO: add acl(5)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-25 12:12:28 +01:00