share/man/man4/icmp.4

   1 .\" Copyright (c) 1986, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)icmp.4      8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD: src/share/man/man4/icmp.4,v 1.7.2.4 2001/12/17 11:30:12 ru Exp $
  34 .\"
  35 .Dd June 5, 1993
  36 .Dt ICMP 4
  37 .Os
  38 .Sh NAME
  39 .Nm icmp
  40 .Nd Internet Control Message Protocol
  41 .Sh SYNOPSIS
  42 .In sys/types.h
  43 .In sys/socket.h
  44 .In netinet/in.h
  45 .Ft int
  46 .Fn socket AF_INET SOCK_RAW proto
  47 .Sh DESCRIPTION
  48 .Tn ICMP
  49 is the error and control message protocol used
  50 by
  51 .Tn IP
  52 and the Internet protocol family.  It may be accessed
  53 through a
  54 .Dq raw socket
  55 for network monitoring
  56 and diagnostic functions.
  57 The
  58 .Fa proto
  59 parameter to the socket call to create an
  60 .Tn ICMP
  61 socket
  62 is obtained from
  63 .Xr getprotobyname 3 .
  64 .Tn ICMP
  65 sockets are connectionless,
  66 and are normally used with the
  67 .Xr sendto 2
  68 and
  69 .Xr recvfrom 2
  70 calls, though the
  71 .Xr connect 2
  72 call may also be used to fix the destination for future
  73 packets (in which case the
  74 .Xr read 2
  75 or
  76 .Xr recv 2
  77 and
  78 .Xr write 2
  79 or
  80 .Xr send 2
  81 system calls may be used).
  82 .Pp
  83 Outgoing packets automatically have an
  84 .Tn IP
  85 header prepended to
  86 them (based on the destination address).
  87 Incoming packets are received with the
  88 .Tn IP
  89 header and options intact.
  90 .Sh ERRORS
  91 A socket operation may fail with one of the following errors returned:
  92 .Bl -tag -width Er
  93 .It Bq Er EISCONN
  94 when trying to establish a connection on a socket which
  95 already has one, or when trying to send a datagram with the destination
  96 address specified and the socket is already connected;
  97 .It Bq Er ENOTCONN
  98 when trying to send a datagram, but
  99 no destination address is specified, and the socket hasn't been
 100 connected;
 101 .It Bq Er ENOBUFS
 102 when the system runs out of memory for
 103 an internal data structure;
 104 .It Bq Er EADDRNOTAVAIL
 105 when an attempt is made to create a
 106 socket with a network address for which no network interface
 107 exists.
 108 .El
 109 .Sh SEE ALSO
 110 .Xr recv 2 ,
 111 .Xr send 2 ,
 112 .Xr inet 4 ,
 113 .Xr intro 4 ,
 114 .Xr ip 4
 115 .Sh HISTORY
 116 The
 117 .Nm
 118 protocol appeared in
 119 .Bx 4.3 .