1*3b2bd0f6Slogwang.\" Copyright (c) 1996-1999 Whistle Communications, Inc. 2*3b2bd0f6Slogwang.\" All rights reserved. 3*3b2bd0f6Slogwang.\" 4*3b2bd0f6Slogwang.\" Subject to the following obligations and disclaimer of warranty, use and 5*3b2bd0f6Slogwang.\" redistribution of this software, in source or object code forms, with or 6*3b2bd0f6Slogwang.\" without modifications are expressly permitted by Whistle Communications; 7*3b2bd0f6Slogwang.\" provided, however, that: 8*3b2bd0f6Slogwang.\" 1. Any and all reproductions of the source or object code must include the 9*3b2bd0f6Slogwang.\" copyright notice above and the following disclaimer of warranties; and 10*3b2bd0f6Slogwang.\" 2. No rights are granted, in any manner or form, to use Whistle 11*3b2bd0f6Slogwang.\" Communications, Inc. trademarks, including the mark "WHISTLE 12*3b2bd0f6Slogwang.\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as 13*3b2bd0f6Slogwang.\" such appears in the above copyright notice or in the software. 14*3b2bd0f6Slogwang.\" 15*3b2bd0f6Slogwang.\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND 16*3b2bd0f6Slogwang.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO 17*3b2bd0f6Slogwang.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, 18*3b2bd0f6Slogwang.\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF 19*3b2bd0f6Slogwang.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 20*3b2bd0f6Slogwang.\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 21*3b2bd0f6Slogwang.\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS 22*3b2bd0f6Slogwang.\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. 23*3b2bd0f6Slogwang.\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES 24*3b2bd0f6Slogwang.\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING 25*3b2bd0f6Slogwang.\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 26*3b2bd0f6Slogwang.\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR 27*3b2bd0f6Slogwang.\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY 28*3b2bd0f6Slogwang.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29*3b2bd0f6Slogwang.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30*3b2bd0f6Slogwang.\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY 31*3b2bd0f6Slogwang.\" OF SUCH DAMAGE. 32*3b2bd0f6Slogwang.\" 33*3b2bd0f6Slogwang.\" $FreeBSD$ 34*3b2bd0f6Slogwang.\" $Whistle: ngctl.8,v 1.6 1999/01/20 03:19:44 archie Exp $ 35*3b2bd0f6Slogwang.\" 36*3b2bd0f6Slogwang.Dd January 19, 1999 37*3b2bd0f6Slogwang.Dt NGCTL 8 38*3b2bd0f6Slogwang.Os 39*3b2bd0f6Slogwang.Sh NAME 40*3b2bd0f6Slogwang.Nm ngctl 41*3b2bd0f6Slogwang.Nd netgraph control utility 42*3b2bd0f6Slogwang.Sh SYNOPSIS 43*3b2bd0f6Slogwang.Nm 44*3b2bd0f6Slogwang.Op Fl d 45*3b2bd0f6Slogwang.Op Fl f Ar filename 46*3b2bd0f6Slogwang.Op Fl n Ar nodename 47*3b2bd0f6Slogwang.Op Ar command ... 48*3b2bd0f6Slogwang.Sh DESCRIPTION 49*3b2bd0f6SlogwangThe 50*3b2bd0f6Slogwang.Nm 51*3b2bd0f6Slogwangutility creates a new netgraph node of type 52*3b2bd0f6Slogwang.Em socket 53*3b2bd0f6Slogwangwhich can be used to issue netgraph commands. 54*3b2bd0f6SlogwangIf no 55*3b2bd0f6Slogwang.Fl f 56*3b2bd0f6Slogwangflag is given, no 57*3b2bd0f6Slogwangcommand is supplied on the command line, and standard input is a tty, 58*3b2bd0f6Slogwang.Nm 59*3b2bd0f6Slogwangwill enter interactive mode. 60*3b2bd0f6SlogwangOtherwise 61*3b2bd0f6Slogwang.Nm 62*3b2bd0f6Slogwangwill execute the supplied command(s) and exit immediately. 63*3b2bd0f6Slogwang.Pp 64*3b2bd0f6SlogwangNodes can be created, removed, joined together, etc. 65*3b2bd0f6Slogwang.Tn ASCII 66*3b2bd0f6Slogwangformatted control messages can be sent to any node if that node 67*3b2bd0f6Slogwangsupports binary/ASCII control message conversion. 68*3b2bd0f6Slogwang.Pp 69*3b2bd0f6SlogwangIn interactive mode, 70*3b2bd0f6Slogwang.Nm 71*3b2bd0f6Slogwangwill display any control messages and data packets received by the socket node. 72*3b2bd0f6SlogwangIn the case of control messages, the message arguments are displayed in 73*3b2bd0f6Slogwang.Tn ASCII 74*3b2bd0f6Slogwangform if the originating node supports conversion. 75*3b2bd0f6Slogwang.Pp 76*3b2bd0f6SlogwangThe options are as follows: 77*3b2bd0f6Slogwang.Bl -tag -width indent 78*3b2bd0f6Slogwang.It Fl f Ar nodeinfo 79*3b2bd0f6SlogwangRead commands from the named file. 80*3b2bd0f6SlogwangA single dash represents the standard input. 81*3b2bd0f6SlogwangBlank lines and lines starting with a 82*3b2bd0f6Slogwang.Dq # 83*3b2bd0f6Slogwangare ignored. 84*3b2bd0f6Slogwang.It Fl n Ar nodename 85*3b2bd0f6SlogwangAssign 86*3b2bd0f6Slogwang.Em nodename 87*3b2bd0f6Slogwangto the newly created netgraph node. 88*3b2bd0f6SlogwangThe default name is 89*3b2bd0f6Slogwang.Em ngctlXXX 90*3b2bd0f6Slogwangwhere XXX is the process ID number. 91*3b2bd0f6Slogwang.It Fl d 92*3b2bd0f6SlogwangIncrease the debugging verbosity level. 93*3b2bd0f6Slogwang.El 94*3b2bd0f6Slogwang.Sh COMMANDS 95*3b2bd0f6SlogwangThe currently supported commands in 96*3b2bd0f6Slogwang.Nm 97*3b2bd0f6Slogwangare: 98*3b2bd0f6Slogwang.Pp 99*3b2bd0f6Slogwang.Bd -literal -offset indent -compact 100*3b2bd0f6Slogwangconfig get or set configuration of node at <path> 101*3b2bd0f6Slogwangconnect Connects hook <peerhook> of the node at <relpath> to <hook> 102*3b2bd0f6Slogwangdebug Get/set debugging verbosity level 103*3b2bd0f6Slogwangdot Produce a GraphViz (.dot) of the entire netgraph. 104*3b2bd0f6Slogwanghelp Show command summary or get more help on a specific command 105*3b2bd0f6Slogwanglist Show information about all nodes 106*3b2bd0f6Slogwangmkpeer Create and connect a new node to the node at "path" 107*3b2bd0f6Slogwangmsg Send a netgraph control message to the node at "path" 108*3b2bd0f6Slogwangname Assign name <name> to the node at <path> 109*3b2bd0f6Slogwangread Read and execute commands from a file 110*3b2bd0f6Slogwangrmhook Disconnect hook "hook" of the node at "path" 111*3b2bd0f6Slogwangshow Show information about the node at <path> 112*3b2bd0f6Slogwangshutdown Shutdown the node at <path> 113*3b2bd0f6Slogwangstatus Get human readable status information from the node at <path> 114*3b2bd0f6Slogwangtypes Show information about all installed node types 115*3b2bd0f6Slogwangwrite Send a data packet down the hook named by "hook". 116*3b2bd0f6Slogwangquit Exit program 117*3b2bd0f6Slogwang.Ed 118*3b2bd0f6Slogwang.Pp 119*3b2bd0f6SlogwangSome commands have aliases, e.g., 120*3b2bd0f6Slogwang.Dq ls 121*3b2bd0f6Slogwangis the same as 122*3b2bd0f6Slogwang.Dq list . 123*3b2bd0f6SlogwangThe 124*3b2bd0f6Slogwang.Dq help 125*3b2bd0f6Slogwangcommand displays the available 126*3b2bd0f6Slogwangcommands, their usage and aliases, and a brief description. 127*3b2bd0f6Slogwang.Sh EXIT STATUS 128*3b2bd0f6Slogwang.Ex -std 129*3b2bd0f6Slogwang.Sh SEE ALSO 130*3b2bd0f6Slogwang.Xr netgraph 3 , 131*3b2bd0f6Slogwang.Xr netgraph 4 , 132*3b2bd0f6Slogwang.Xr nghook 8 133*3b2bd0f6Slogwang.Sh HISTORY 134*3b2bd0f6SlogwangThe 135*3b2bd0f6Slogwang.Nm netgraph 136*3b2bd0f6Slogwangsystem was designed and first implemented at Whistle Communications, Inc.\& in 137*3b2bd0f6Slogwanga version of 138*3b2bd0f6Slogwang.Fx 2.2 139*3b2bd0f6Slogwangcustomized for the Whistle InterJet. 140*3b2bd0f6Slogwang.Sh AUTHORS 141*3b2bd0f6Slogwang.An Archie Cobbs Aq Mt [email protected] 142