d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
d41aa7462a
freebsd-skq/usr.sbin/nghook/nghook.8

147 lines
4.4 KiB
Groff
Raw Normal View History

Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
.\"
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.\" Subject to the following obligations and disclaimer of warranty, use and
.\" redistribution of this software, in source or object code forms, with or
.\" without modifications are expressly permitted by Whistle Communications;
.\" provided, however, that:
.\" 1. Any and all reproductions of the source or object code must include the
.\" copyright notice above and the following disclaimer of warranties; and
.\" 2. No rights are granted, in any manner or form, to use Whistle
.\" Communications, Inc. trademarks, including the mark "WHISTLE
.\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as
.\" such appears in the above copyright notice or in the software.
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
.\"
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
.\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
.\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
.\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
.\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
.\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
.\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
.\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
.\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
.\" OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\" $Whistle: nghook.8,v 1.4 1999/01/20 03:19:45 archie Exp $
.\"
.Dd January 19, 1999
.Dt NGHOOK 8
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 15:12:08 +00:00
.Os
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.Sh NAME
.Nm nghook
.Nd connect to a
Fix minor typo.
1999-12-22 01:25:07 +00:00
.Xr netgraph 4
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
node
.Sh SYNOPSIS
.Nm
Put all the argument-less options together in the synopsis as required by style(9).
2003-08-13 07:43:08 +00:00
.Op Fl Sadlns
Allow nghook to execute a program with the data socket connected to stdin and stdout instead of relaying the data. Now it is possible to say: nghook -e path: hook /usr/local/bin/foo arg1 arg2 and foo will have the hook to path: at file descriptors 0 and 1. Add an option to specify control messages to be send to the node before either executing the program or entering the data relay loop.
2003-10-24 10:01:36 +00:00
.Op Fl m Ar msg
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.Ar path
.Op Ar hookname
Allow nghook to execute a program with the data socket connected to stdin and stdout instead of relaying the data. Now it is possible to say: nghook -e path: hook /usr/local/bin/foo arg1 arg2 and foo will have the hook to path: at file descriptors 0 and 1. Add an option to specify control messages to be send to the node before either executing the program or entering the data relay loop.
2003-10-24 10:01:36 +00:00
.Pp
.Nm
.Fl e
.Op Fl n
.Op Fl m Ar msg
.Ar path
.Ar hookname
.Ar program
.Op Ar args...
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.Sh DESCRIPTION
The .Nm utility
2002-07-14 14:47:15 +00:00
The
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.Nm
The .Nm utility
2002-07-14 14:47:15 +00:00
utility creates a
Correct cross-references: ng_bpf.8 --> ng_bpf.4 ng_ether.8 --> ng_ether.4 ng_iface.8 --> ng_iface.4 ng_pppoe.8 --> ng_pppoe.4 ng_socket.8 --> ng_socket.4 ng_tty.8 --> ng_tty.4 ng_{type}.4 --> /dev/null MFC after: 1 week
2001-06-05 12:40:03 +00:00
.Xr ng_socket 4
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
socket type node and connects it to hook
.Ar hookname
of the node found at
.Ar path .
If
.Ar hookname
Manual page style work. Submitted by: Alexey Zelkin <phantom@FreeBSD.org> thanks!
1999-12-21 01:25:21 +00:00
is omitted,
.Dq debug
is assumed.
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.Pp
Allow nghook to execute a program with the data socket connected to stdin and stdout instead of relaying the data. Now it is possible to say: nghook -e path: hook /usr/local/bin/foo arg1 arg2 and foo will have the hook to path: at file descriptors 0 and 1. Add an option to specify control messages to be send to the node before either executing the program or entering the data relay loop.
2003-10-24 10:01:36 +00:00
If the
.Fl e
option is given the third argument is interpreted as the path to a program
and this program is executed with the remaining arguments as its arguments.
Before executing the program netgraph messages (specified by the
.Fl m
option) are sent to the node.
The program is executed with its standard input (unless closed by
.Fl n )
and output connected to the hook.
.Pp
If the
.Fl e
option is not given all data written to standard input is sent
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
to the node and all data received from the node is relayed
Allow nghook to execute a program with the data socket connected to stdin and stdout instead of relaying the data. Now it is possible to say: nghook -e path: hook /usr/local/bin/foo arg1 arg2 and foo will have the hook to path: at file descriptors 0 and 1. Add an option to specify control messages to be send to the node before either executing the program or entering the data relay loop.
2003-10-24 10:01:36 +00:00
to standard output. Messages specified with
.Fl m
are send to the node before the loop is entered.
The .Nm utility
2002-07-14 14:47:15 +00:00
The
Add '-n' flag: don't attempt to read any data from standard input.
2000-07-27 21:55:48 +00:00
.Nm
The .Nm utility
2002-07-14 14:47:15 +00:00
utility exits when
Add '-n' flag: don't attempt to read any data from standard input.
2000-07-27 21:55:48 +00:00
.Dv EOF
Allow nghook to execute a program with the data socket connected to stdin and stdout instead of relaying the data. Now it is possible to say: nghook -e path: hook /usr/local/bin/foo arg1 arg2 and foo will have the hook to path: at file descriptors 0 and 1. Add an option to specify control messages to be send to the node before either executing the program or entering the data relay loop.
2003-10-24 10:01:36 +00:00
is detected on standard input in this case.
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.Pp
The options are as follows:
.Pp
.Bl -tag -width indent
Implement two command line options that allow one to change the file descriptors that are used for input and output. That allows one, for example, to use nghook to bi-directionally pipe the input and output into/from another non-netgraph-aware program.
2003-08-13 07:42:07 +00:00
.It Fl S
Use file descriptor 0 for output instead of the default 1.
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.It Fl a
Add '-n' flag: don't attempt to read any data from standard input.
2000-07-27 21:55:48 +00:00
Output each packet read in human-readable decoded
.Tn ASCII
form instead of raw binary.
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.It Fl d
Increase the debugging verbosity level.
Allow nghook to execute a program with the data socket connected to stdin and stdout instead of relaying the data. Now it is possible to say: nghook -e path: hook /usr/local/bin/foo arg1 arg2 and foo will have the hook to path: at file descriptors 0 and 1. Add an option to specify control messages to be send to the node before either executing the program or entering the data relay loop.
2003-10-24 10:01:36 +00:00
.It Fl e
Execute the program specified by the third argument.
Add the '-l' flag to nghook which loops the received data back.
2000-07-18 16:52:27 +00:00
.It Fl l
Loops all received data back to the hook in addition to writing it
to standard output.
Allow nghook to execute a program with the data socket connected to stdin and stdout instead of relaying the data. Now it is possible to say: nghook -e path: hook /usr/local/bin/foo arg1 arg2 and foo will have the hook to path: at file descriptors 0 and 1. Add an option to specify control messages to be send to the node before either executing the program or entering the data relay loop.
2003-10-24 10:01:36 +00:00
.It Fl m Ar msg
Before executing the program (in
.Fl e
mode) send the given ASCII control message to the node.
This option may be given more than once.
Add '-n' flag: don't attempt to read any data from standard input.
2000-07-27 21:55:48 +00:00
.It Fl n
Don't attempt to read any data from standard input.
The .Nm utility
2002-07-14 14:47:15 +00:00
The
Add '-n' flag: don't attempt to read any data from standard input.
2000-07-27 21:55:48 +00:00
.Nm
The .Nm utility
2002-07-14 14:47:15 +00:00
utility will continue reading from the node until stopped by a signal.
Implement two command line options that allow one to change the file descriptors that are used for input and output. That allows one, for example, to use nghook to bi-directionally pipe the input and output into/from another non-netgraph-aware program.
2003-08-13 07:42:07 +00:00
.It Fl s
Use file descriptor 1 for input instead of the default 0.
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.El
.Sh BUGS
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
Although all input is read in unbuffered mode,
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
there's no way to control the packetization of the input.
Allow nghook to execute a program with the data socket connected to stdin and stdout instead of relaying the data. Now it is possible to say: nghook -e path: hook /usr/local/bin/foo arg1 arg2 and foo will have the hook to path: at file descriptors 0 and 1. Add an option to specify control messages to be send to the node before either executing the program or entering the data relay loop.
2003-10-24 10:01:36 +00:00
.Pp
If the node sends a reponse to a message (specified by
.Fl m Ns No ),
this response is lost.
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.Sh SEE ALSO
.Xr netgraph 3 ,
mdoc(7) police: sort SEE ALSO xrefs (sort -b -f +2 -3 +1 -2).
2001-07-06 16:46:48 +00:00
.Xr netgraph 4 ,
Add '-n' flag: don't attempt to read any data from standard input.
2000-07-27 21:55:48 +00:00
.Xr ngctl 8
Whistle's Netgraph link-layer (sometimes more) networking infrastructure. Been in production for 3 years now. Gives Instant Frame relay to if_sr and if_ar drivers, and PPPOE support soon. See: ftp://ftp.whistle.com/pub/archie/netgraph/index.html for on-line manual pages. Reviewed by: Doug Rabson (dfr@freebsd.org) Obtained from: Whistle CVS tree
1999-10-21 09:06:11 +00:00
.Sh HISTORY
The
.Em netgraph
mdoc(7) police: protect trailing full stops of abbreviations with a trailing zero-width space: `e.g.\&'.
2001-08-10 13:45:36 +00:00
system was designed and first implemented at Whistle Communications, Inc.\&
Manual page style work. Submitted by: Alexey Zelkin <phantom@FreeBSD.org> thanks!
1999-12-21 01:25:21 +00:00
in a version of
.Fx 2.2
customized for the Whistle InterJet.
Add '-n' flag: don't attempt to read any data from standard input.
2000-07-27 21:55:48 +00:00
.Sh AUTHORS
Manual page style work. Submitted by: Alexey Zelkin <phantom@FreeBSD.org> thanks!
1999-12-21 01:25:21 +00:00
.An Archie Cobbs Aq archie@whistle.com
Reference in New Issue Copy Permalink