diff options
author | julian <julian@FreeBSD.org> | 1999-10-21 09:06:11 +0000 |
---|---|---|
committer | julian <julian@FreeBSD.org> | 1999-10-21 09:06:11 +0000 |
commit | c5c63975d538cf48ceb99ba48c341293676d15c0 (patch) | |
tree | 722c03ee4d750dd89ed43b028c35302fbfd03bfd /usr.sbin/ngctl/ngctl.8 | |
parent | 028ec91c46f181b4be2318c3bba8d194b5583f87 (diff) | |
download | FreeBSD-src-c5c63975d538cf48ceb99ba48c341293676d15c0.zip FreeBSD-src-c5c63975d538cf48ceb99ba48c341293676d15c0.tar.gz |
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
Diffstat (limited to 'usr.sbin/ngctl/ngctl.8')
-rw-r--r-- | usr.sbin/ngctl/ngctl.8 | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/usr.sbin/ngctl/ngctl.8 b/usr.sbin/ngctl/ngctl.8 new file mode 100644 index 0000000..ee4f3be --- /dev/null +++ b/usr.sbin/ngctl/ngctl.8 @@ -0,0 +1,115 @@ +.\" Copyright (c) 1996-1999 Whistle Communications, Inc. +.\" All rights reserved. +.\" +.\" 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. +.\" +.\" 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: ngctl.8,v 1.6 1999/01/20 03:19:44 archie Exp $ +.\" +.Dd January 19, 1999 +.Dt NGCTL 8 +.Os FreeBSD 3 +.Sh NAME +.Nm ngctl +.Nd netgraph control utility +.Sh SYNOPSIS +.Nm ngctl +.Op Fl d +.Op Fl f Ar filename +.Op Fl n Ar nodename +.Op Ar command ... +.Sh DESCRIPTION +The +.Nm +utility creates a new netgraph node of type +.Em socket +which can be used to issue netgraph commands. +If no +.Fl f +flag is given, no +command is supplied on the command line, and standard input is a tty, +.Nm ngctl +will enter interactive mode. Otherwise +.Nm ngctl +will execute the supplied command(s) and exit immediately. +.Pp +The options are as follows: +.Bl -tag -width indent +.It Fl f Ar nodeinfo +Read commands from the named file. +A single dash represents the standard input. +Blank lines and lines starting with a ``#'' are ignored. +.It Fl n Ar nodename +Assign +.Em nodename +to the newly created netgraph node. The default name is +.Em ngctlXXX +where XXX is the process ID number. +.It Fl d +Increase the debugging verbosity level. +.El +.Sh COMMANDS +The currently supported commands in +.Nm ngctl +are: +.Pp +.Bd -literal -offset indent -compact +connect Connects two nodes +debug Get/set debugging verbosity level +help Show command summary or get help on a command +list Show information about all nodes +mkpeer Create and connect a new node to an existing node +name Assign a name to a node +read Read and execute commands from a file +rmhook Disconnect a node's hook +show Show information about a node +shutdown Shutdown a node +status Get human readable status from a node +types Show all installed node types +quit Exit program +.Ed +.Pp +The ``help'' command displays the available +commands, their usage, and a brief description. +.Sh EXIT VALUE +The +.Nm +utility exits 0 on success, and >0 if an error occurs. +.Sh SEE ALSO +.Xr netgraph 3 , +.Xr netgraph 4 . +.Xr nghook 8 . +.Sh AUTHOR +Archie Cobbs <archie@whistle.com> +.Sh HISTORY +The +.Em netgraph +system was designed and first implemented at Whistle Communications, Inc. +in a version FreeBSD 2.2 customized for the Whistle InterJet. |