Assorted markup, grammar, and spelling fixes.

1 files changed, 131 insertions, 58 deletions

diff --git a/usr.sbin/dconschat/dconschat.8 b/usr.sbin/dconschat/dconschat.8
index e11d224..f560740 100644
--- a/usr.sbin/dconschat/dconschat.8
+++ b/usr.sbin/dconschat/dconschat.8
@@ -30,7 +30,8 @@
 .Os
 .Sh NAME
 .Nm dconschat
-.Nd user interface to dcons
+.Nd user interface to
+.Xr dcons 4
 .Sh SYNOPSIS
 .Nm
 .Op Fl brvwRT1
@@ -55,83 +56,121 @@ utility is designed to provide a way for users to access
 (dumb console device) on a local or remote system.
 The
 .Nm
-interacts with
+utility interacts with
 .Xr dcons 4
 using
 .Xr kvm 3
 or
-.Xr firewire 4 
-and interact with a user over tty or TCP/IP.
+.Xr firewire 4 ,
+and interacts with the user over TTY or TCP/IP.
 To access remote
 .Xr dcons 4
 using
 .Xr firewire 4 ,
-you have to specify target EUI64 address by
+you have to specify target EUI64 address using the
 .Fl t
 option.
 .Pp
 The
 .Nm
-and
+utility and the
 .Xr dcons 4
-communicate using 2 port, one for console port and the other for
-remote gdb port.
+driver communicate using 2 ports, one for the console port and another
+for remote
+.Xr gdb 1
+port.
 Users are supposed to access
 .Nm
-using tty, telnet and gdb.
-You can specify listen ports for console and gdb port by
+using TTY,
+.Xr telnet 1
+and
+.Xr gdb 1 .
+You can specify listen ports for console and
+.Xr gdb 1
+port using the
 .Fl C
 and
 .Fl G
-options respectively. The port number 0 has special meaning that
-current tty(stdin/out) is used instead of TCP/IP.
+options respectively.
+The port number 0 has special meaning that
+current TTY (stdin/stdout) is used instead of TCP/IP.
 A negative port number will disable the port.
-To quit dconschat, send a CR + '~' + '.' sequence to the console port
+To quit
+.Nm ,
+send a CR +
+.Ql ~
++
+.Ql \&.
+sequence to the console port,
 or send signal to the process.
 .Pp
 By analogy with
 .Xr pty 4
-device, the 
+device, the
 .Xr dcons 4
 acts as a slave device and
 .Nm
 acts as a master device with
 .Xr telnetd 8 .
-.Pp
-.Bl -tag -width indent 
+.Bl -tag -width indent
 .It Fl b
-Translate Ctrl-C to ALT_BREAK(CR + '~' + Ctrl-B) on gdb port.
+Translate Ctrl-C to ALT_BREAK (CR +
+.Ql ~
++ Ctrl-B) on
+.Xr gdb 1
+port.
 .It Fl r
 Replay old buffer on connection.
 .It Fl v
-Verbose debug output. Multiple '-v' increase verbosity.
+Verbose debug output.
+Multiple
+.Fl v
+options increase verbosity.
 .It Fl w
-Listen on wildcard address rather than localhost.
+Listen on a wildcard address rather than localhost.
 .It Fl R
-Read-only. Don't write anything on dcons buffer.
+Read-only.
+Do not write anything to the
+.Xr dcons 4
+buffer.
 .It Fl T
-Enable ad hoc workaround for telnet protocol to
+Enable ad-hoc workaround for the TELNET protocol to
 remove unnecessary byte sequences.
-It should be set when you access dconschat using telnet.
+It should be set when you access
+.Nm
+using
+.Xr telnet 1 .
 .It Fl 1
-One-Shot. Read available buffer then exit. This implies
+One-shot.
+Read available buffer, then exit.
+This implies the
 .Fl r
 option.
 .It Fl h Ar hz
-Specify polling rate. The default value is 100.
+Specify polling rate.
+The default value is 100.
 .It Fl C Ar console_port
-Specify console port. The default value is 0(stdin/stdout).
+Specify the console port.
+The default value is 0 (stdin/stdout).
 .It Fl G Ar gdb_port
-Specify gdb port.. The default value is -1(disabled).
+Specify
+.Xr gdb 1
+port.
+The default value is \-1 (disabled).
 .It Fl M Ar core
 Specify core file.
 .It Fl N Ar system
-Specify system file such as /boot/kernel/kernel.
+Specify system file such as
+.Pa /boot/kernel/kernel .
 .It Fl t Ar target_eui64
-Specify the 64bit extended unique identifier of the target and use FireWire to access remote
+Specify the 64-bit extended unique identifier of the target,
+and use FireWire to access remote
 .Xr dcons 4 .
 .It Fl a Ar address
-Specify the physical/IO address of the dcons buffer. See
+Specify the physical I/O address of the
+.Xr dcons 4
+buffer.
+See
 .Xr dcons 4
 for details.
 If this option is not specified,
@@ -141,19 +180,21 @@ You are supposed to enable
 .Xr dcons_crom 4
 on the target to omit this option.
 .It Fl u Ar bus_num
-Specify FireWire bus number. The default is 0.
+Specify FireWire bus number.
+The default is 0.
 .El
-.Sh EXAMPLE
+.Sh EXAMPLES
 To use
-.Nm 
+.Nm
 with FireWire for remote
-.Xr dcons ,
-you have to specify the eui64 of the target.
+.Xr dcons 4 ,
+you have to specify the EUI64 of the target.
 You can obtain EUI64 by running
-.Xr fwcontorl 4
+.Xr fwcontrol 8
 without options.
-The first EUI64 is of the host running fwcontrol and others on the
-bus follow.
+The first EUI64 is of the host running
+.Xr fwcontrol 8
+and others on the bus follow.
 .Bd -literal -offset indent
 # fwcontrol
 2 devices (info_len=2)
@@ -162,48 +203,80 @@ node           EUI64          status
    0  00-11-22-33-44-55-66-77      1
 .Ed
 .Pp
-The EUI64 doesn't change unless you change the hardware
+The EUI64 does not change unless you change the hardware
 as the ethernet address.
 .Pp
-Now we can run the
+Now we can run
 .Nm .
 .Bd -literal -offset indent
 # dconschat -br -G 12345 -t 00-11-22-33-44-55-66-77
 .Ed
 .Pp
-You'll get console output of the target and login prompt if a getty is
-running on dcons. You can break to DDB with ALT_BREAK (CR + '~' + Ctrl-B)
-if DDB and ALT_BREAK_TO_DEBUGGER is enabled in the target kernel.
-To quit the session, type CR + '~' + '.' in the console port.
+You will get console output of the target and login prompt if a
+.Xr getty 8
+is running on
+.Xr dcons 4 .
+You can break to DDB with ALT_BREAK (CR +
+.Ql ~
++ Ctrl-B)
+if
+.Dv DDB
+and
+.Dv ALT_BREAK_TO_DEBUGGER
+are enabled in the target kernel.
+To quit the session, type CR +
+.Ql ~
++
+.Ql \&.
+in the console port.
 .Pp
-Using gdb port is almost the same as remote gdb over serial line except
-using TCP/IP instead of /dev/cu*. See 
-"On-line Kernel Debugging Using Remote GDB"
-section of The FreeBSD Developers Handbook and
+Using
+.Xr gdb 1
+port is almost the same as remote
+.Xr gdb 1
+over serial line except
+using TCP/IP instead of
+.Pa /dev/cu* .
+See
+.Sx "On-line Kernel Debugging Using Remote GDB"
+section of
+.%T "The FreeBSD Developers Handbook"
+and
 .Xr gdb 4
-for detail. 
+for details.
 .Bd -literal -offset indent
 % gdb -k kernel.debug
 (kgdb) target remote :12345
 .Ed
 .Pp
-Once gdb is attached and you specified '-b' option to dconschat,
-typing "Ctrl-C" on gdb causes break to debugger.
+Once
+.Xr gdb 1
+is attached and you specified the
+.Fl b
+option to
+.Nm ,
+typing Ctrl-C in
+.Xr gdb 1
+causes a break to debugger.
 .Pp
-The following command get console log from crash dump:
+The following command gets the console log from the crash dump:
 .Bd -literal -offset indent
 # dconschat -1 -M vmcore.0 -N kernel.0
 .Ed
 .Pp
-If you want access to the console using telnet, try the following:
+If you want access to the console using
+.Xr telnet 1 ,
+try the following:
 .Bd -literal -offset indent
 # dconschat -rTC 5555 &
 # telnet localhost 5555
 .Ed
 .Pp
-You may want to keep logging console output of several machines. Conserve-com
-in the ports collection may help you. Insert the following lines
-in the conserver.cf.
+You may want to keep logging console output of several machines.
+.Nm conserver-com
+in the Ports collection may help you.
+Insert the following lines in
+.Pa conserver.cf :
 .Bd -literal -offset indent
 console local {
 	master localhost;
@@ -217,7 +290,7 @@ console remote {
 }
 .Ed
 .Sh FILES
-.Bl -tag -width indent
+.Bl -tag -width indent -compact
 .It Pa /dev/fwmem0.0
 .It Pa /dev/mem
 .It Pa /dev/kmem
@@ -237,5 +310,5 @@ console remote {
 .Sh AUTHORS
 .An Hidetoshi Shimokawa Aq simokawa@FreeBSD.org
 .Sh BUGS
-This utility is still under development.
-.Pp
+This utility is
+.Ud .