summaryrefslogtreecommitdiffstats
path: root/usr.sbin/ngctl
diff options
context:
space:
mode:
authorjulian <julian@FreeBSD.org>1999-12-21 01:25:21 +0000
committerjulian <julian@FreeBSD.org>1999-12-21 01:25:21 +0000
commit443430016ec78bb04567a578c007b74e84575dd1 (patch)
treec186d4285318db13cd0ced96f929b0001e3d7016 /usr.sbin/ngctl
parentb8abdf85cef25cc056288b6e4a2e277af4cb63ed (diff)
downloadFreeBSD-src-443430016ec78bb04567a578c007b74e84575dd1.zip
FreeBSD-src-443430016ec78bb04567a578c007b74e84575dd1.tar.gz
Manual page style work.
Submitted by: Alexey Zelkin <phantom@FreeBSD.org> thanks!
Diffstat (limited to 'usr.sbin/ngctl')
-rw-r--r--usr.sbin/ngctl/ngctl.839
1 files changed, 25 insertions, 14 deletions
diff --git a/usr.sbin/ngctl/ngctl.8 b/usr.sbin/ngctl/ngctl.8
index 44b5402..11cf21f 100644
--- a/usr.sbin/ngctl/ngctl.8
+++ b/usr.sbin/ngctl/ngctl.8
@@ -40,7 +40,7 @@
.Nm ngctl
.Nd netgraph control utility
.Sh SYNOPSIS
-.Nm ngctl
+.Nm
.Op Fl d
.Op Fl f Ar filename
.Op Fl n Ar nodename
@@ -55,19 +55,21 @@ If no
.Fl f
flag is given, no
command is supplied on the command line, and standard input is a tty,
-.Nm ngctl
+.Nm
will enter interactive mode. Otherwise
-.Nm ngctl
+.Nm
will execute the supplied command(s) and exit immediately.
.Pp
Nodes can be created, removed, joined together, etc.
-ASCII formatted control messages can be sent to any node if that node
+.Tn ASCII
+formatted control messages can be sent to any node if that node
supports binary/ASCII control message conversion.
.Pp
In interactive mode,
.Nm
will display any control messages and data packets received by the socket node.
-In the case of control messages, the message arguments are displayed in ASCII
+In the case of control messages, the message arguments are displayed in
+.Tn ASCII
form if the originating node supports conversion.
.Pp
The options are as follows:
@@ -75,7 +77,9 @@ The options are as follows:
.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.
+Blank lines and lines starting with a
+.Dq #
+are ignored.
.It Fl n Ar nodename
Assign
.Em nodename
@@ -87,7 +91,7 @@ Increase the debugging verbosity level.
.El
.Sh COMMANDS
The currently supported commands in
-.Nm ngctl
+.Nm
are:
.Pp
.Bd -literal -offset indent -compact
@@ -107,8 +111,13 @@ types Show all installed node types
quit Exit program
.Ed
.Pp
-Some commands have aliases, e.g., ``ls'' is the same as ``list''.
-The ``help'' command displays the available
+Some commands have aliases, e.g.,
+.Dq ls
+is the same as
+.Dq list .
+The
+.Dq help
+command displays the available
commands, their usage and aliases, and a brief description.
.Sh EXIT VALUE
The
@@ -116,12 +125,14 @@ The
utility exits 0 on success, and >0 if an error occurs.
.Sh SEE ALSO
.Xr netgraph 3 ,
-.Xr netgraph 4 .
+.Xr netgraph 4 ,
.Xr nghook 8 .
-.Sh AUTHOR
-Archie Cobbs <archie@whistle.com>
.Sh HISTORY
The
-.Em netgraph
+.Nm netgraph
system was designed and first implemented at Whistle Communications, Inc. in
-a version FreeBSD 2.2 customized for the Whistle InterJet.
+a version
+.Fx 2.2
+customized for the Whistle InterJet.
+.Sh AUTHORS
+.An Archie Cobbs Aq archie@whistle.com
OpenPOWER on IntegriCloud