[src/trunk]: src/sbin/canconfig New sentence, new line. Fix typos. More consi...

[wiz <wiz%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/53a00af1a681
branches:  trunk
changeset: 824252:53a00af1a681
user:      wiz <wiz%NetBSD.org@localhost>
date:      Mon May 29 08:46:23 2017 +0000

description:
New sentence, new line. Fix typos. More consistent grammar.
Comment out empty EXAMPLES section. Remove unnecessary macros.

diffstat:

 sbin/canconfig/canconfig.8 |  52 ++++++++++++++++++++++-----------------------
 1 files changed, 25 insertions(+), 27 deletions(-)

diffs (122 lines):

diff -r e6572e716474 -r 53a00af1a681 sbin/canconfig/canconfig.8
--- a/sbin/canconfig/canconfig.8        Mon May 29 08:42:33 2017 +0000
+++ b/sbin/canconfig/canconfig.8        Mon May 29 08:46:23 2017 +0000
@@ -1,7 +1,7 @@
-.\"    $NetBSD: canconfig.8,v 1.2 2017/05/27 21:02:55 bouyer Exp $
+.\"    $NetBSD: canconfig.8,v 1.3 2017/05/29 08:46:23 wiz Exp $
 .\"
 .\" Copyright (c) 2017 Manuel Bouyer.
- *
+.\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
@@ -10,7 +10,7 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
- *
+.\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
@@ -20,9 +20,9 @@
 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 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 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.    
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd Apris 15, 2017
+.Dd April 15, 2017
 .Dt CANCONFIG 8
 .Os
 .Sh NAME
@@ -43,9 +43,8 @@
 utility is used to configure CAN network interface parameters and retrieve
 CAN network interface parameters and status from the kernel.
 .Ss Timing
-.Pp
 The base time unit used to define the network bit rate is the time quanta (tq),
-its value is defined by the input clock freqency and the prescaler value
+its value is defined by the input clock frequency and the prescaler value
 as (1/ freq * prescaler).
 .Pp
 The network bit time is split in 4 segments:
@@ -60,13 +59,13 @@
 The sample point is between phase_seg1 and phase_seg2.
 .Pp
 The receiver hardware is allowed to shorten prop_seg or phase_seg2 to
-resynchronise with the sender. The swj (Synchronisation Jump Width) parameter
+resynchronize with the sender.
+The swj (Synchronisation Jump Width) parameter
 defines by how much the hardware can shorten these segments.
 .Pp
 Some hardware can use 3 sample points instead of one, and keep the majority as
 the final value.
 .Ss Options
-.Pp
 The options are as follows:
 .Bl -tag -width indent
 .It Fl a
@@ -79,43 +78,42 @@
 the status of that interface is displayed.
 .Pp
 The following sub-commands are available:
-.Pp
 .Bl -tag -width indent
 .It Cm up
-Start network operations on the interface. Requires that all timing parameters
-have been set.
+Start network operations on the interface.
+Requires that all timing parameters have been set.
 .It Cm down
 Stop network operations on the interface.
 .It Cm brp Ar value
 Set the value of the baud rate prescaler.
 .It Cm prop_seg Ar value
-set the number of tq for the propagation segment.
+Set the number of tq for the propagation segment.
 .It Cm phase_seg1 Ar value
-set the number of tq for the phase segment 1.
+Set the number of tq for the phase segment 1.
 .It Cm phase_seg2 Ar value
-set the number of tq for the phase segment 2.
+Set the number of tq for the phase segment 2.
 .It Cm sjw Ar value
-set the number of tq for the Synchronisation Jump Width.
+Set the number of tq for the Synchronisation Jump Width.
 .It Cm 3samples
-enables triple-sampling.
+Enable triple-sampling.
 .It Cm -3samples
-disables triple-sampling.
+Disable triple-sampling.
 .It Cm listenonly
-enables listenonly mode. In this mode the controller is passive, and
-doesn't send ACKs on the bus.
+Enable listen-only mode.
+In this mode the controller is passive, and doesn't send ACKs on the bus.
 .It Cm -listenonly
-disables listenonly mode.
+Disable listen-only mode.
 .It Cm loopback
-enables loopback mode. In this mode, the controller doens't expect ACK from
-the bus.
+Enable loopback mode.
+In this mode, the controller doesn't expect ACK from the bus.
 .It Cm -loopback
-disables loopback mode.
+Disable loopback mode.
 .El
-.Sh EXAMPLES
-TODO
+.\".Sh EXAMPLES
+.\"TODO
 .Sh SEE ALSO
 .Xr ifconfig.if 5 ,
-.Xr ifconfig 8 ,
+.Xr ifconfig 8
 .Sh HISTORY
 The
 .Nm