Sweep-fix man page section order to match mdoc(7), part 5/5.
[dragonfly.git] / 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: src/usr.sbin/nghook/nghook.8,v 1.3.2.4 2001/08/16 15:56:11 ru Exp $
34 .\"  $DragonFly: src/usr.sbin/nghook/nghook.8,v 1.3 2006/02/17 19:40:20 swildner Exp $
35 .\" $Whistle: nghook.8,v 1.4 1999/01/20 03:19:45 archie Exp $
36 .\"
37 .Dd January 19, 1999
38 .Dt NGHOOK 8
39 .Os
40 .Sh NAME
41 .Nm nghook
42 .Nd connect to a
43 .Xr netgraph 4
44 node
45 .Sh SYNOPSIS
46 .Nm
47 .Op Fl a
48 .Op Fl d
49 .Ar path
50 .Op Ar hookname
51 .Sh DESCRIPTION
52 .Nm
53 creates a
54 .Xr ng_socket 4
55 socket type node and connects it to hook
56 .Ar hookname
57 of the node found at
58 .Ar path .
59 If
60 .Ar hookname
61 is omitted,
62 .Dq debug
63 is assumed.
64 .Pp
65 At this point all data written to standard input is sent
66 to the node and all data received from the node is relayed
67 to standard output.
68 .Pp
69 The options are as follows:
70 .Pp
71 .Bl -tag -width indent
72 .It Fl a
73 Output each read packet in
74 .Tn ASCII .
75 .It Fl d
76 Increase the debugging verbosity level.
77 .El
78 .Sh SEE ALSO
79 .Xr netgraph 3 ,
80 .Xr netgraph 4 ,
81 .Xr ngctl 8
82 .Sh HISTORY
83 The
84 .Em netgraph
85 system was designed and first implemented at Whistle Communications, Inc.\&
86 in a version of
87 .Fx 2.2
88 customized for the Whistle InterJet.
89 .Sh AUTHORS
90 .An Archie Cobbs Aq archie@whistle.com
91 .Sh BUGS
92 Although all input is read in unbuffered mode,
93 there's no way to control the packetization of the input.