xref: /freebsd/usr.sbin/nghook/nghook.8 (revision 2a4a1db342263067035ce69a4017c645da63455d)
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
43node
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.Nm
54creates a
55.Xr ng_socket 4
56socket type node and connects it to hook
57.Ar hookname
58of the node found at
59.Ar path .
60If
61.Ar hookname
62is omitted,
63.Dq debug
64is assumed.
65.Pp
66At this point all data written to standard input is sent
67to the node and all data received from the node is relayed
68to standard output.
69.Nm
70exits when
71.Dv EOF
72is detected on standard input.
73.Pp
74The options are as follows:
75.Pp
76.Bl -tag -width indent
77.It Fl a
78Output each packet read in human-readable decoded
79.Tn ASCII
80form instead of raw binary.
81.It Fl d
82Increase the debugging verbosity level.
83.It Fl l
84Loops all received data back to the hook in addition to writing it
85to standard output.
86.It Fl n
87Don't attempt to read any data from standard input.
88.Nm
89will continue reading from the node until stopped by a signal.
90.El
91.Sh BUGS
92Although all input is read in unbuffered mode,
93there's no way to control the packetization of the input.
94.Sh SEE ALSO
95.Xr netgraph 3 ,
96.Xr netgraph 4 ,
97.Xr ngctl 8
98.Sh HISTORY
99The
100.Em netgraph
101system was designed and first implemented at Whistle Communications, Inc.\&
102in a version of
103.Fx 2.2
104customized for the Whistle InterJet.
105.Sh AUTHORS
106.An Archie Cobbs Aq archie@whistle.com
107