Commit Graph

188 Commits

Author SHA1 Message Date
Michael Kerrisk 02f95a3178 socket.7: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-05-07 15:30:18 +12:00
Michael Kerrisk 42bd5b3db0 socket.7: Correct description of SO_BROADCAST
As reported by Alexey:

socket(7) says:

SO_BROADCAST
  Set  or  get  the broadcast flag. When enabled, datagram sockets
  receive packets sent to a broadcast address and they are allowed
  to  send  packets  to  a  broadcast address.  This option has no
  effect on stream-oriented sockets.

I believe the second sentence is half wrong: when I try it, it
only affects the ability to send broadcast datagrams. You can only
receive broadcast datagrams if you bind to INADDR_ANY and don't
connect. The POSIX standard agrees with my tests and disagrees
with the manpage:

http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_10.html

Reported-by: Alexey Toptygin <alexeyt@freeshell.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-04-23 21:02:31 +12:00
Michael Kerrisk 56bf261344 socket.7: tfix
Reported-by: Nick Black <dankamongmen@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2011-09-16 07:00:47 +02:00
Michael Kerrisk 26ae585e9b socket.7: srcfix: Updated fixme
Signed-off-by: Michael Kerrisk <mtk@konstanz.(none)>
2010-08-31 07:05:20 +02:00
Michael Kerrisk 6d7f2c1382 socket.7: srcfix: update FIXME
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-06-19 06:52:28 +02:00
Michael Kerrisk e2ec4f17cd socket.7: srcfix: Added FIXME
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-06-13 04:31:58 +02:00
Michael Kerrisk fa574567cc socket.7: Use consistent language to describe read-only socket options
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-06-13 04:26:57 +02:00
Jan Engelhardt dd2127e08c socket.7: Document SO_DOMAIN and SO_PROTOCOL
These read-only socket options were new in Linux 2.6.32.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-06-13 04:21:37 +02:00
Michael Kerrisk e5dbf5a253 socket.7: srcfix: update FIXME
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-02-21 15:14:52 +01:00
Michael Kerrisk fe1598f64b socket.7: srcfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-02-21 15:14:10 +01:00
Michael Kerrisk 486e5d0009 socket.7: srcfix: Updated FIXME
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-02-21 15:14:10 +01:00
Michael Kerrisk 8cf1b72a81 socket.7:srcfix: Added FIXMEs
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-19 01:43:43 +01:00
Michael Kerrisk 3b777affca close.2, epoll_create.2, epoll_ctl.2, fcntl.2, madvise.2, mmap.2, mremap.2, select_tut.2, setgid.2, setuid.2, syscalls.2, vmsplice.2, dlopen.3, fts.3, getpw.3, stdio.3, fd.4, initrd.4, random.4, sd.4, bootparam.7, capabilities.7, cpuset.7, epoll.7, inotify.7, man.7, socket.7, x25.7: Global fix: s/re-/re/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "re-" etc.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 18:45:23 +01:00
Michael Kerrisk ff40dbb354 accept.2, connect.2, eventfd.2, flock.2, open.2, posix_fadvise.2, read.2, recv.2, sched_setscheduler.2, select_tut.2, send.2, signalfd.2, splice.2, timerfd_create.2, write.2, flockfile.3, mkfifo.3, mq_notify.3, mq_open.3, pthread_tryjoin_np.3, scanf.3, random.4, ddp.7, epoll.7, fifo.7, ip.7, pipe.7, socket.7, spufs.7: Global fix: s/non-blocking/nonblocking/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 17:43:10 +01:00
Michael Kerrisk c7094399ad intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 17:40:55 +01:00
Michael Kerrisk c4e7b71426 getpeername.2, getsockname.2, getsockopt.2, recv.2, send.2, shutdown.2, sockatmark.3, socket.7, udplite.7: SYNOPSIS: Rename socket file descriptor argument to 'sockfd'
Many sockets man pages use the name 'sockfd' already.
For consistency, changes the others to do so as well.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-12-05 22:28:56 -05:00
Michael Kerrisk c24995b98f socket.7: SEE ALSO: add tcp(7) and udp(7)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-12-05 22:18:09 -05:00
Michael Kerrisk 5a2ff571fb connect.2, listen.2, send.2, uname.2, cmsg.3, proc.5, arp.7, ddp.7, icmp.7, ip.7, raw.7, socket.7, tcp.7, udp.7: Global fix: eliminate mention of the obsolete sysctl(2) interface
Many pages still mention use of the obsolete sysctl(2) system
call, or used the term "sysctls"; rewrite these mentions to
instead be in terms of /proc interfaces.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-11-25 20:54:11 -05:00
Michael Kerrisk cabf996a6b arp.7, ddp.7, icmp.7, ip.7, socket.7, tcp.7: ffix: Convert /proc file names from bold to italic
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=506335
Reported-by: Eugen Dedu <Eugen.Dedu@pu-pm.univ-fcomte.fr>
2008-11-25 20:54:10 -05:00
Michael Kerrisk 0b8a445926 socket.7: SEE ALSO: add unix(7)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-10-29 14:54:13 -05:00
Michael Kerrisk d0cb7cc649 grfix: s/null terminated string/null-terminated string/ 2008-09-26 07:13:25 +02:00
Michael Kerrisk d4c8c97c31 s/PF_/AF_/ for socket family constants. Reasons: the AF_ and
PF_ constants have always had the same values; there never has
been a protocol family that had more than one address family,
and POSIX.1-2001 only specifies the AF_* constants.
2008-08-08 16:47:53 +00:00
Michael Kerrisk 77117f4fc5 Reverting blunder in commit 4699 2008-08-08 16:41:48 +00:00
Michael Kerrisk 10874173db s/PF_/AF_/ for socket family conistants. Reasons: the AF_ and
PF_ constants have always had the same values; there never has
been a protocol family that had more than one address family,
and POSIX.1-2001 only specifies the AF_* constants.
2008-08-08 16:28:06 +00:00
Michael Kerrisk c4bb193f3c s/parameter/argument/ when talking about the things given
to a function call, for consistency with majority usage.
2008-07-10 20:53:08 +00:00
Michael Kerrisk 61792fc66b ffix 2008-09-18 12:30:41 +00:00
Michael Kerrisk 6f36deb49c s/realtime/real-time/ 2008-03-19 13:23:34 +00:00
Michael Kerrisk eba722884d s/nonzero/non-zero/ 2008-03-19 13:16:39 +00:00
Michael Kerrisk fcbe9025d0 grfix 2008-03-19 08:53:45 +00:00
Michael Kerrisk 24d6938351 Small rewording of discussion of O_ASYNC. 2007-12-26 11:31:06 +00:00
Michael Kerrisk c382a36592 hyphenation fixes 2007-12-25 22:02:19 +00:00
Michael Kerrisk e2badfdf26 Hyphenation fixes 2007-12-25 20:50:22 +00:00
Michael Kerrisk 5895e7eb8d wspace in SYNOPSIS 2007-12-23 13:45:24 +00:00
Michael Kerrisk a08ea57c20 Make the standard indent for code samples, shell session
logs, etc. to be ".in +4n".
2007-12-19 05:53:30 +00:00
Michael Kerrisk 3d07eed115 Added section number to page xref. 2007-11-16 06:45:58 +00:00
Michael Kerrisk 0daa9e92d0 Fix redundant formatting macros 2007-09-20 16:26:31 +00:00
Michael Kerrisk c11b1abf2e Change mtk's email address 2007-09-20 06:52:22 +00:00
Michael Kerrisk 748a6c2b4f tfix 2007-09-18 18:51:51 +00:00
Michael Kerrisk 635e8d5a19 Removed trailing white space at end of lines 2007-09-10 04:17:16 +00:00
Michael Kerrisk 57c3a13b09 Small wording tweaks for SO_RCVTIME/SO_SNDTIMEO 2007-08-28 03:19:01 +00:00
Michael Kerrisk 6486ef0578 Clarify that SO_SNDTIMEO and SO_RCVTIMEO only have effect for
socket I/O calls; not for multiplexing system calls like
select() and poll().
2007-08-27 15:46:06 +00:00
Michael Kerrisk 74d3223314 ffix/spfix 2007-08-27 08:36:21 +00:00
Michael Kerrisk 604e3ffbf5 Added FIXME. 2007-06-28 17:26:49 +00:00
Michael Kerrisk f19a0f03ee ffix 2007-06-23 07:56:56 +00:00
Michael Kerrisk 097585edcb ffix 2007-06-22 20:40:07 +00:00
Michael Kerrisk 7b2b5ea4fb ffix 2007-06-20 22:20:03 +00:00
Michael Kerrisk f27b37350d Document argument type for SO_REUSEADDR. See Debian bug 255881. 2007-06-17 17:03:38 +00:00
Michael Kerrisk 0e1ad98ccf Updated FIXMEs 2007-06-13 21:48:16 +00:00
Michael Kerrisk 75b94dc35c Change "e.g. " to "e.g., ", or in some cases, "for example, ".
Change "i.e. " to i.e.., ", or in some cases, "that is, ".
2007-06-08 11:56:22 +00:00
Michael Kerrisk d9bfdb9c21 Convert to American spelling conventions 2007-06-08 09:56:56 +00:00
Michael Kerrisk d9343c5c13 Removed version number from .TH line 2007-05-30 05:36:26 +00:00
Michael Kerrisk 8d548bfe96 Removed out-of-date FIXME 2007-05-21 10:10:10 +00:00
Michael Kerrisk 2b2581ee37 Fix inconsistencies in order of .SH sections 2007-05-19 04:30:20 +00:00
Michael Kerrisk 63f6a20a1a Add section numbers to page xrefs 2007-05-11 23:29:44 +00:00
Michael Kerrisk c13182efa3 Wrapped long lines, wrapped at sentence boundaries; stripped trailing
white space.
2007-04-12 22:42:49 +00:00
Michael Kerrisk cf0a9ace57 ffix 2007-04-05 12:36:57 +00:00
Michael Kerrisk 6b86408509 Place socket options in alpha order. 2006-09-26 13:48:33 +00:00
Michael Kerrisk 4dec66f990 Updated CONFORMING TO section 2006-08-03 13:58:08 +00:00
Michael Kerrisk a28e26a155 s%IO%I/O% 2006-07-21 14:56:18 +00:00
Michael Kerrisk d7090f5bd5 ffix 2006-07-19 23:59:09 +00:00
Michael Kerrisk acac588130 Removed FIXME 2006-05-04 00:10:03 +00:00
Michael Kerrisk 218e46f883 Small FIXME formatting fixes 2006-03-23 02:13:08 +00:00
Michael Kerrisk ec4db3e713 place socket options in alpahbetical order 2006-03-15 09:04:45 +00:00
Michael Kerrisk 594a37e793 ffix 2006-03-15 08:52:00 +00:00
Michael Kerrisk bdca4aead8 Documented SO_SNDBUFFORCE and SO_RCVBUFFORCE socket options, new in 2.6.14. 2006-03-15 08:47:24 +00:00
Michael Kerrisk 8786649296 Wrap long lines; .ta + TABs with spaces in code examples 2006-03-07 02:02:26 +00:00
Michael Kerrisk c533af9d27 Reformatted FIXMEs 2006-02-10 18:46:42 +00:00
Michael Kerrisk 6b4d3c70d5 typo fix 2006-01-13 08:17:15 +00:00
Michael Kerrisk 56185b42e7 Formatting and source code line break changes (no changes to content!) 2006-01-03 10:58:34 +00:00
Michael Kerrisk 17805f5b31 Noted the Linux-specific feature whereby setsockopt() doubles
the value given for SO_SNDBUF and SO_RCVBUF.

Noted kernel imposed minimum values for SO_SNDBUF and SO_RCVBUF.
2005-12-15 12:36:08 +00:00
Michael Kerrisk 514d7e5b92 Updated discussion of SO_BSDCOMPAT.
Reformatted some long lines.
2005-12-14 10:27:30 +00:00
Michael Kerrisk 7199370f3a Further refinement of SO_TIMESTAMP from Urs Thuermann. 2005-12-13 10:46:50 +00:00
Michael Kerrisk 7b5c3d0a78 Von: Urs Thuermann <urs@isnogud.escape.de>
An: "Michael Kerrisk" <mtk-manpages@gmx.net>
Betreff: Re: PATCH: man-pages-2.15, socket option SO_TIMESTAMP
Datum: 02 Dec 2005 08:00:11 +0100

Hello Michael,

> Okay -- let me know if your patch is still good to go after you've
> done your reading/testing.  Maybe I will try to do another 
> man-page release tomorrow, if you you can confirm the details in 2.6.

I have compared 2.4 and 2.6 src again and wrote two small test
programs (one sending udp packets, one receiving the packets and
calling SIOCGSTAMP w/ and w/o SO_TIMESTAMP).  Both, 2.4 and 2.6 have
the same behavior, which may be considered a bug.

When a packet is received its timestamp is stored in the sock
structure in kernel for SIOCGSTAMP to be retreived if SO_TIMESTAMP is
not set, otherwise it is written into a cmsg structure to be returned
with the recvmsg syscall.

Therefore, SIOCGSTAMP doesn't get the correct timestamp, when
SO_TIMESTAMP is set.  Instead, SIOCGSTAMP returns an ENOENT error, if
there has never been a packet reception while SO_TIMESTAMP unset,
since the field in the sock structure in the kernel is initialized to
"no timestamp" (0 in 2.4, -1 in 2.6).  Otherwise, SIOCGSTAMP returns
the timestamp found in the sock structure which is from the last
packet when SO_TIMESTAMP was not set, i.e. it may not be the timestamp
of the last packet received.

I have updated the man page socket(7) accordingly.  Patch is below.

urs
2005-12-08 16:36:30 +00:00
Michael Kerrisk d994d57949 Added text noting that select()/poll() do no respect SO_RCVLOWAT. 2005-11-30 16:09:42 +00:00
Michael Kerrisk fb8959ea57 Added FIXME? 2005-11-15 15:00:12 +00:00
Michael Kerrisk 8478ee0279 Formatting fixes 2005-11-02 13:55:25 +00:00
Michael Kerrisk a749f870a8 s/XXX/FIXME/ 2005-10-26 11:27:52 +00:00
Michael Kerrisk 1e32103455 Formatting fixes 2005-10-20 15:11:10 +00:00
Michael Kerrisk b5cc2ffbaa Formatting fixes 2005-10-19 14:48:35 +00:00
Michael Kerrisk e1d6264d9f Manual fixes for parentheses formatting 2005-10-19 07:29:28 +00:00
Michael Kerrisk f8b8dd887d Update description of SO_RCVLOWAT and SO_SNDLOWAT.
(fix derived from Fedora man-pages-2.07-7).
2005-10-04 13:18:49 +00:00
Michael Kerrisk 73b3a56860 Clarified details of use of SO_PEERCRED. 2005-08-16 17:17:16 +00:00
Michael Kerrisk 357cf3fe97 id --> ID 2005-07-18 16:02:32 +00:00
Michael Kerrisk 4d9b698450 Hyphenation/dash fixes 2005-07-06 07:41:37 +00:00
Michael Kerrisk 3df839779c Minor formatting fixes 2005-06-21 14:45:03 +00:00
Michael Kerrisk 8729177b44 global edit s/ -1/ \\-1/g 2005-06-15 14:10:23 +00:00
Michael Kerrisk 305a0578bf Global change of email address for MTK (now: mtk-manpages@gmx.net) 2004-11-03 14:43:40 +00:00
Michael Kerrisk fea681dafb Import of man-pages 1.70 2004-11-03 13:51:07 +00:00