docs/78479: SO_NOSIGPIPE socket option undocumented

[Mikko Työläjärvi]

>Number:         78479
>Category:       docs
>Synopsis:       SO_NOSIGPIPE socket option undocumented
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Mar 06 03:00:33 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator:     Mikko Tyolajarvi
>Release:        FreeBSD 6.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD sotec.home 6.0-CURRENT FreeBSD 6.0-CURRENT #28: Sat Mar 5 16:58:15 PST 2005 mikko at sotec.home:/usr/obj/usr/src/sys/SOTEC i386

>Description:

The SO_NOSIGPIPE socket option that can be used to disable SIGPIPE
generation on a per-socket basis is not mentioned in getsockopt(2).

>How-To-Repeat:

man getsockopt

>Fix:

Somehting like this:

Index: getsockopt.2
===================================================================
RCS file: /home/ncvs/src/lib/libc/sys/getsockopt.2,v
retrieving revision 1.32
diff -b -u -r1.32 getsockopt.2
--- getsockopt.2	20 Jan 2005 09:17:05 -0000	1.32
+++ getsockopt.2	6 Mar 2005 02:05:26 -0000
@@ -163,6 +163,7 @@
  .It Dv SO_SNDTIMEO Ta "set timeout value for output"
  .It Dv SO_RCVTIMEO Ta "set timeout value for input"
  .It Dv SO_ACCEPTFILTER Ta "set accept filter on listening socket"
+.It Dv SO_NOSIGPIPE Ta "disable generation of SIGPIPE for the socket"
  .It Dv SO_TYPE Ta "get the type of the socket (get only)"
  .It Dv SO_ERROR Ta "get and clear error on the socket (get only)"
  .El
@@ -355,6 +356,13 @@
  Passing in an
  .Fa optval
  of NULL will remove the filter.
+.Pp
+The
+.Dv SO_NOSIGPIPE
+option disables the SIGPIPE signal normally sent when writing to a
+connected socket where the other end has been closed returns with
+the error
+.Er EPIPE .
  .Pp
  Finally,
  .Dv SO_TYPE



>Release-Note:
>Audit-Trail:
>Unformatted: