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 Sadlns 47.Op Fl m Ar msg 48.Ar path 49.Op Ar hookname 50.Pp 51.Nm 52.Fl e 53.Op Fl n 54.Op Fl m Ar msg 55.Ar path 56.Ar hookname 57.Ar program 58.Op Ar args... 59.Sh DESCRIPTION 60The 61.Nm 62utility creates a 63.Xr ng_socket 4 64socket type node and connects it to hook 65.Ar hookname 66of the node found at 67.Ar path . 68If 69.Ar hookname 70is omitted, 71.Dq debug 72is assumed. 73.Pp 74If the 75.Fl e 76option is given the third argument is interpreted as the path to a program 77and this program is executed with the remaining arguments as its arguments. 78Before executing the program netgraph messages (specified by the 79.Fl m 80option) are sent to the node. 81The program is executed with its standard input (unless closed by 82.Fl n ) 83and output connected to the hook. 84.Pp 85If the 86.Fl e 87option is not given all data written to standard input is sent 88to the node and all data received from the node is relayed 89to standard output. Messages specified with 90.Fl m 91are send to the node before the loop is entered. 92The 93.Nm 94utility exits when 95.Dv EOF 96is detected on standard input in this case. 97.Pp 98The options are as follows: 99.Pp 100.Bl -tag -width indent 101.It Fl S 102Use file descriptor 0 for output instead of the default 1. 103.It Fl a 104Output each packet read in human-readable decoded 105.Tn ASCII 106form instead of raw binary. 107.It Fl d 108Increase the debugging verbosity level. 109.It Fl e 110Execute the program specified by the third argument. 111.It Fl l 112Loops all received data back to the hook in addition to writing it 113to standard output. 114.It Fl m Ar msg 115Before executing the program (in 116.Fl e 117mode) send the given ASCII control message to the node. 118This option may be given more than once. 119.It Fl n 120Don't attempt to read any data from standard input. 121The 122.Nm 123utility will continue reading from the node until stopped by a signal. 124.It Fl s 125Use file descriptor 1 for input instead of the default 0. 126.El 127.Sh BUGS 128Although all input is read in unbuffered mode, 129there's no way to control the packetization of the input. 130.Pp 131If the node sends a reponse to a message (specified by 132.Fl m Ns No ), 133this response is lost. 134.Sh SEE ALSO 135.Xr netgraph 3 , 136.Xr netgraph 4 , 137.Xr ngctl 8 138.Sh HISTORY 139The 140.Em netgraph 141system was designed and first implemented at Whistle Communications, Inc.\& 142in a version of 143.Fx 2.2 144customized for the Whistle InterJet. 145.Sh AUTHORS 146.An Archie Cobbs Aq archie@whistle.com 147