share/man/man8/ng_ether.8

   1 .\" Copyright (c) 2000 Whistle Communications, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Subject to the following obligations and disclaimer of warranty, use and
   5 .\" redistribution of this software, in source or object code forms, with or
   6 .\" without modifications are expressly permitted by Whistle Communications;
   7 .\" provided, however, that:
   8 .\" 1. Any and all reproductions of the source or object code must include the
   9 .\"    copyright notice above and the following disclaimer of warranties; and
  10 .\" 2. No rights are granted, in any manner or form, to use Whistle
  11 .\"    Communications, Inc. trademarks, including the mark "WHISTLE
  12 .\"    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  13 .\"    such appears in the above copyright notice or in the software.
  14 .\"
  15 .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  17 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  18 .\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  20 .\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  21 .\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  22 .\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  23 .\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  24 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  25 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  26 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  27 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30 .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  31 .\" OF SUCH DAMAGE.
  32 .\"
  33 .\" Author: Archie Cobbs <archie@whistle.com>
  34 .\"
  35 .\" $FreeBSD$
  36 .\"
  37 .Dd January 25, 2000
  38 .Dt NG_ETHER 8
  39 .Os FreeBSD
  40 .Sh NAME
  41 .Nm ng_ether
  42 .Nd Ethernet netgraph node type
  43 .Sh SYNOPSIS
  44 .Fd #include <netgraph/ng_ether.h>
  45 .Sh DESCRIPTION
  46 The
  47 .Nm ether
  48 netgraph node type allows Ethernet interfaces to interact with
  49 the
  50 .Xr netgraph 4
  51 networking subsystem.  The kernel must be compiled with
  52 .Bd -literal
  53     options NETGRAPH
  54 .Ed
  55 .Pp
  56 for this functionality to be enabled.
  57 This causes a netgraph node to be automatically created for each Ethernet
  58 interface in the system.  The node will have a name equal to
  59 the name of the interface, and it will be persistent.
  60 .Pp
  61 The Ethernet interface continues to function normally until a connection
  62 is made to one of the two supported hooks,
  63 .Dv orphans
  64 or
  65 .Dv divert .
  66 The
  67 .Dv orphans
  68 hook is used to receive Ethernet frames received by the device and
  69 having an unknown or unsupported Ethertype.
  70 The
  71 .Dv divert
  72 hook is used to divert
  73 .Em all
  74 Ethernet frames received by the device; the interface will otherwise
  75 appear to go silent until this hook is disconnected.
  76 .Pp
  77 Either hook may be used to transmit Ethernet frames by transmitting packets
  78 to the hook.  In all cases, frames are raw Ethernet frames with the standard
  79 14 byte Ethernet header (but no checksum).
  80 .Sh HOOKS
  81 This node type supports the following hooks:
  82 .Pp
  83 .Bl -tag -width orphans
  84 .It Dv orphans
  85 This hook transmits Ethernet frames received by the device and
  86 having an unknown or unsupported Ethertype.  Frames received on
  87 this hook are written as-is out on the wire.
  88 .It Dv divert
  89 When connected, this hook transmits all Ethernet frames received by the device.
  90 Frames received on this hook are written as-is out on the wire.
  91 .El
  92 .Sh CONTROL MESSAGES
  93 This node type supports only the generic control messages.
  94 .Sh SHUTDOWN
  95 This node is persistent.  Upon receipt of a
  96 .Dv NGM_SHUTDOWN
  97 control message, all hooks are disconnected.
  98 .Sh EXAMPLE
  99 This command will dump all packets received by the
 100 .Dv fxp0
 101 interface to standard output as decoded hex and ASCII:
 102 .Bl -literal
 103
 104     nghook -a fxp0: divert
 105 .El
 106 .Sh SEE ALSO
 107 .Xr arp 4 ,
 108 .Xr netgraph 4 ,
 109 .Xr netintro 4 ,
 110 .Xr ifconfig 8 ,
 111 .Xr nghook 8 ,
 112 .Xr ngctl 8
 113 .Sh AUTHOR
 114 .An Julian Elischer Aq julian@FreeBSD.org