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: ngctl.8,v 1.6 1999/01/20 03:19:44 archie Exp $ 35.\" 36.Dd January 19, 1999 37.Dt NGCTL 8 38.Os FreeBSD 3 39.Sh NAME 40.Nm ngctl 41.Nd netgraph control utility 42.Sh SYNOPSIS 43.Nm 44.Op Fl d 45.Op Fl f Ar filename 46.Op Fl n Ar nodename 47.Op Ar command ... 48.Sh DESCRIPTION 49The 50.Nm 51utility creates a new netgraph node of type 52.Em socket 53which can be used to issue netgraph commands. 54If no 55.Fl f 56flag is given, no 57command is supplied on the command line, and standard input is a tty, 58.Nm 59will enter interactive mode. Otherwise 60.Nm 61will execute the supplied command(s) and exit immediately. 62.Pp 63Nodes can be created, removed, joined together, etc. 64.Tn ASCII 65formatted control messages can be sent to any node if that node 66supports binary/ASCII control message conversion. 67.Pp 68In interactive mode, 69.Nm 70will display any control messages and data packets received by the socket node. 71In the case of control messages, the message arguments are displayed in 72.Tn ASCII 73form if the originating node supports conversion. 74.Pp 75The options are as follows: 76.Bl -tag -width indent 77.It Fl f Ar nodeinfo 78Read commands from the named file. 79A single dash represents the standard input. 80Blank lines and lines starting with a 81.Dq # 82are ignored. 83.It Fl n Ar nodename 84Assign 85.Em nodename 86to the newly created netgraph node. The default name is 87.Em ngctlXXX 88where XXX is the process ID number. 89.It Fl d 90Increase the debugging verbosity level. 91.El 92.Sh COMMANDS 93The currently supported commands in 94.Nm 95are: 96.Pp 97.Bd -literal -offset indent -compact 98connect Connects two nodes 99debug Get/set debugging verbosity level 100help Show command summary or get help on a command 101list Show information about all nodes 102mkpeer Create and connect a new node to an existing node 103msg Send an ASCII formatted message to a node 104name Assign a name to a node 105read Read and execute commands from a file 106rmhook Disconnect a node's hook 107show Show information about a node 108shutdown Shutdown a node 109status Get human readable status from a node 110types Show all installed node types 111quit Exit program 112.Ed 113.Pp 114Some commands have aliases, e.g., 115.Dq ls 116is the same as 117.Dq list . 118The 119.Dq help 120command displays the available 121commands, their usage and aliases, and a brief description. 122.Sh EXIT VALUE 123The 124.Nm 125utility exits 0 on success, and >0 if an error occurs. 126.Sh SEE ALSO 127.Xr netgraph 3 , 128.Xr netgraph 4 , 129.Xr nghook 8 . 130.Sh HISTORY 131The 132.Nm netgraph 133system was designed and first implemented at Whistle Communications, Inc. in 134a version 135.Fx 2.2 136customized for the Whistle InterJet. 137.Sh AUTHORS 138.An Archie Cobbs Aq archie@whistle.com 139