Module Name: src
Committed By: wiz
Date: Thu Apr 28 14:59:27 UTC 2011
Modified Files:
src/lib/libcom_err: com_err.3
Log Message:
New sentence, new line. Use more markup.
To generate a diff of this commit:
cvs rdiff -u -r1.2 -r1.3 src/lib/libcom_err/com_err.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libcom_err/com_err.3
diff -u src/lib/libcom_err/com_err.3:1.2 src/lib/libcom_err/com_err.3:1.3
--- src/lib/libcom_err/com_err.3:1.2 Wed Apr 30 13:10:51 2008
+++ src/lib/libcom_err/com_err.3 Thu Apr 28 14:59:27 2011
@@ -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 ""
