[src/trunk]: src New sentence, new line. Use more markup.

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

details:   https://anonhg.NetBSD.org/src/rev/e13973cebb32
branches:  trunk
changeset: 764595:e13973cebb32
user:      wiz <wiz%NetBSD.org@localhost>
date:      Thu Apr 28 14:59:27 2011 +0000

description:
New sentence, new line. Use more markup.

diffstat:

 lib/libcom_err/com_err.3        |  35 +++++++++++++++++-----------
 usr.bin/compile_et/compile_et.1 |  48 ++++++++++++++++++++++++----------------
 2 files changed, 50 insertions(+), 33 deletions(-)

diffs (186 lines):

diff -r ab64c9d267f7 -r e13973cebb32 lib/libcom_err/com_err.3
--- a/lib/libcom_err/com_err.3  Thu Apr 28 14:55:59 2011 +0000
+++ b/lib/libcom_err/com_err.3  Thu Apr 28 14:59:27 2011 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: com_err.3,v 1.2 2008/04/30 13:10:51 martin Exp $
+.\"     $NetBSD: com_err.3,v 1.3 2011/04/28 14:59:27 wiz Exp $
 .\"
 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -42,10 +42,10 @@
 .Sh LIBRARY
 Common Error Library (libcom_err, -lcom_err)
 .Sh SYNOPSIS
-.Fd #include <stdio.h>
-.Fd #include <stdarg.h>
-.Fd #include <krb5/com_err.h>
-.Fd #include \&"XXX_err.h\&"
+.In stdio.h
+.In stdarg.h
+.In krb5/com_err.h
+.In \&"XXX_err.h\&"
 .Pp
 typedef void (*errf)(const char *, long, const char *, ...);
 .Ft void
@@ -69,15 +69,18 @@
 .Nm
 library provides a common error-reporting mechanism for defining and
 accessing error codes and descriptions for application software
-packages.  Error descriptions are defined in a table and error codes
-are used to index the table.  The error table, the descriptions and
-the error codes are generated using
+packages.
+Error descriptions are defined in a table and error codes are used
+to index the table.
+The error table, the descriptions and the error codes are generated
+using
 .Xr compile_et 1 .
 .Pp
 The error table is registered with the
 .Nm
 library by calling its initialisation function defined in its header
-file.  The initialisation function is generally defined as
+file.
+The initialisation function is generally defined as
 .Fn initialize_<name>_error_table ,
 where
 .Em name
@@ -100,10 +103,13 @@
 and a string produced using the
 .Xr printf 3
 .Fa format
-string and any following arguments.  If
+string and any following arguments.
+If
 .Fa format
-is NULL, the formatted message will not be
-printed.  The argument
+is
+.Dv NULL ,
+the formatted message will not be printed.
+The argument
 .Fa format
 may not be omitted.
 .It Fn com_err_va "whoami" "code" "format" "va_list args"
@@ -155,8 +161,9 @@
 .Fn set_com_err_hook
  has been called, calls to
 .Fn com_err
-will turn into calls to the new hook routine.  This function is
-intended to be used in daemons to use a routine which calls
+will turn into calls to the new hook routine.
+This function is intended to be used in daemons to use a routine
+which calls
 .Xr syslog 3 ,
 or in a window system application to pop up a dialogue box.
 .It Fn reset_com_err_hook ""
diff -r ab64c9d267f7 -r e13973cebb32 usr.bin/compile_et/compile_et.1
--- a/usr.bin/compile_et/compile_et.1   Thu Apr 28 14:55:59 2011 +0000
+++ b/usr.bin/compile_et/compile_et.1   Thu Apr 28 14:59:27 2011 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: compile_et.1,v 1.5 2010/04/05 21:33:09 pgoyette Exp $
+.\"     $NetBSD: compile_et.1,v 1.6 2011/04/28 15:01:27 wiz Exp $
 .\"
 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -35,8 +35,8 @@
 .Nd error table compiler
 .Sh SYNOPSIS
 .Nm
-.Op Ar --version
-.Op Ar --help
+.Op Fl Fl help
+.Op Fl Fl version
 .Ar file
 .Sh DESCRIPTION
 The
@@ -46,7 +46,8 @@
 .Ar file
 and generates a C source file suitable for use with the
 .Xr com_err 3
-library.  The source file
+library.
+The source file
 .Ar file
 must end with a suffix of
 .Dq .et
@@ -59,23 +60,26 @@
 .Pa file.c
 which should be compiled and linked with the executable.
 .Pp
-The source file is a plain ASCII text file.  A
+The source file is a plain ASCII text file.
+A
 .Dq \&#
 in the source file
 is treated as a comment character, and all remaining text to the end
-of the source line will be ignored.  The source file consists of the
-following declarations:
+of the source line will be ignored.
+The source file consists of the following declarations:
 .Bl -tag -offset indent -width XXXXXX
 .It id [ Em base ] Em string
 Defines an identification string (such as a version string) which is
-recorded in the generated files.  It is mandatory and must be the
-first declaration in the source file.
+recorded in the generated files.
+It is mandatory and must be the first declaration in the source
+file.
 .It et Em name
 Specifies the name of the error table to be
 .Em name .
 It is mandatory and must be declared after the id declaration and
-before all other declarations.  The name of table is limited to four
-ASCII characters.  The optional argument
+before all other declarations.
+The name of table is limited to four ASCII characters.
+The optional argument
 .Em base
 specifies the base value of error codes the table.
 .Pp
@@ -83,13 +87,14 @@
 .Fn initialize_<name>_error_table
 which must be called to register the error table with the
 .Xr com_err 3
-library.  A re-entrant (thread-safe) version called
+library.
+A re-entrant (thread-safe) version called
 .Fn initialize_<name>_error_table_r
 is also defined.
 .It prefix Op Em string
-Defines a prefix to be applied to all error code names.  If no string
-is specified, the prefix is not defined.  It is an optional
-declaration and can appear more than once.
+Defines a prefix to be applied to all error code names.
+If no string is specified, the prefix is not defined.
+It is an optional declaration and can appear more than once.
 .It index Em val
 Specifies the index
 .Em val
@@ -101,8 +106,8 @@
 .Em cname
 and its associated error message
 .Em msg .
-The error codes are assigned sequentially increasing numbers.  The
-name is placed into the C header file as an enumerated type.
+The error codes are assigned sequentially increasing numbers.
+The name is placed into the C header file as an enumerated type.
 .It end
 Indicates the end of the error table.
 .El
@@ -133,8 +138,13 @@
 .Pa test_err.h
 containing the enumerated type
 .Va test_error_number
-with values TEST_PERM, TEST_IO, TEST_NOMEM and
-TEST_INVAL, and a C source file
+with values
+.Dv TEST_PERM ,
+.Dv TEST_IO ,
+.Dv TEST_NOMEM
+and
+.Dv TEST_INVAL ,
+and a C source file
 .Pa test_err.c
 containing the
 .Xr com_err 3