usr.sbin/nghook/nghook.8

   1 .\" Copyright (c) 1996-1999 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 .\"  $FreeBSD$
  34 .\" $Whistle: nghook.8,v 1.4 1999/01/20 03:19:45 archie Exp $
  35 .\"
  36 .Dd January 19, 1999
  37 .Dt NGHOOK 8
  38 .Os
  39 .Sh NAME
  40 .Nm nghook
  41 .Nd connect to a
  42 .Xr netgraph 4
  43 node
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl a
  47 .Op Fl d
  48 .Op Fl l
  49 .Op Fl n
  50 .Ar path
  51 .Op Ar hookname
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 utility creates a
  56 .Xr ng_socket 4
  57 socket type node and connects it to hook
  58 .Ar hookname
  59 of the node found at
  60 .Ar path .
  61 If
  62 .Ar hookname
  63 is omitted,
  64 .Dq debug
  65 is assumed.
  66 .Pp
  67 At this point all data written to standard input is sent
  68 to the node and all data received from the node is relayed
  69 to standard output.
  70 The
  71 .Nm
  72 utility exits when
  73 .Dv EOF
  74 is detected on standard input.
  75 .Pp
  76 The options are as follows:
  77 .Pp
  78 .Bl -tag -width indent
  79 .It Fl a
  80 Output each packet read in human-readable decoded
  81 .Tn ASCII
  82 form instead of raw binary.
  83 .It Fl d
  84 Increase the debugging verbosity level.
  85 .It Fl l
  86 Loops all received data back to the hook in addition to writing it
  87 to standard output.
  88 .It Fl n
  89 Don't attempt to read any data from standard input.
  90 The
  91 .Nm
  92 utility will continue reading from the node until stopped by a signal.
  93 .El
  94 .Sh BUGS
  95 Although all input is read in unbuffered mode,
  96 there's no way to control the packetization of the input.
  97 .Sh SEE ALSO
  98 .Xr netgraph 3 ,
  99 .Xr netgraph 4 ,
 100 .Xr ngctl 8
 101 .Sh HISTORY
 102 The
 103 .Em netgraph
 104 system was designed and first implemented at Whistle Communications, Inc.\&
 105 in a version of
 106 .Fx 2.2
 107 customized for the Whistle InterJet.
 108 .Sh AUTHORS
 109 .An Archie Cobbs Aq archie@whistle.com