Print this page
6282 ONBLD man pages not pbchk clean
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>
@@ -17,18 +17,16 @@
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\" CDDL HEADER END
.\"
-.TH interface_check 1ONBLD "25 March 2010"
+.TH INTERFACE_CHECK 1ONBLD "Mar 25, 2010"
.SH NAME
interface_check \- check shared object interfaces
.SH SYNOPSIS
\fBinterface_check [-hIo] [-c vertype_module] [-E errfile] [-e exfile] [-f listfile] [-i intffile] [-w outdir] file | dir, ...\fP
-.LP
.SH DESCRIPTION
-.IX "OS-Net build tools" "interface_check" "" "\fBinterface_check\fP"
The
.I interface_check
command attempts to check a number of ELF versioning attributes
for consistency with common build rules and practices.
In addition, a complete breakdown of the file's version definitions can
@@ -117,11 +115,10 @@
auditing a shared objects interfaces from release-to-release. Any
addition, deletion or regrouping of versioning information can be
detected by inspecting this database with
.I interface_cmp.
.sp
-.LP
.SH OPTIONS
.LP
The following options are supported:
.TP 4
.B \-c vertype_module
@@ -178,11 +175,10 @@
Produce one-liner output, with each line of diagnostic output
prefixed with the object pathname.
.TP
.B -w outdir
Interpret the paths of all input and output files relative to \fIoutdir\fP.
-.LP
.SH EXCEPTION FILE FORMAT
Exceptions to the rules enforced by
.I interface_check
are be specified using an exception file. The \fB-e\fP option is used to
specify an explicit exception file. Otherwise, if used in an activated
@@ -192,11 +188,11 @@
$CODEMGR_WS/exception_list/interface_check does not exist,
.I interface_check
will use
.I /opt/onbld/etc/exception_list/interface_check
as a fallback default exception file.
-.p
+.P
To run
.I interface_check
without applying exceptions, specify \fB-e\fP with a value of /dev/null.
.P
A '#' character at the beginning of a line, or at any point in
@@ -232,46 +228,39 @@
The exceptions understood by
.I interface_check
are:
.sp
.ne 2
-.mk
.na
\fBNONSTD_VERNAME\fR
.ad
.RS 17n
-.rt
.sp
Objects that are allowed to deviate from our standard version names.
.RE
.sp
.ne 2
-.mk
.na
\fBNOVERDEF\fR
.ad
.RS 17n
-.rt
Objects that are not expected to contain versioning information.
Note that PLUGIN objects are automatically exempt from this,
so these directives are generally applied to non-plugin objects
.RE
.sp
.ne 2
-.mk
.na
\fBPLUGIN\fR
.ad
.RS 17n
-.rt
Sharable objects underneath these parts of the tree are taken to be plugins.
Plugins are not required to have versioned file names, and are not required
to be internally versioned.
.RE
-.LP
.SH INTERFACE DESCRIPTION FILE FORMAT
When the \fB-i\fP option is used
.I interface_check
produces an \fIInterface Description File\fP that captures a description of
the interfaces provided by each ELF object processed.
@@ -288,11 +277,10 @@
description of each object starts with an OBJECT directive, and follows the
form shown below, using /lib/amd64/libadm.so.1 as an example:
.sp
.in +4
.nf
-.CR
OBJECT lib/amd64/libadm.so.1
CLASS ELFCLASS64
TYPE ET_DYN
ALIAS lib/64/libadm.so
ALIAS lib/64/libadm.so.1
@@ -328,11 +316,10 @@
defined in the version, and INHERIT for those that are inherited. Using
\fB-I\fP for the above example produces the following output:
.sp
.in +4
.nf
-.CR
OBJECT lib/amd64/libadm.so.1
CLASS ELFCLASS64
TYPE ET_DYN
ALIAS lib/64/libadm.so
ALIAS lib/64/libadm.so.1
@@ -360,11 +347,10 @@
.sp
The \fB-I\fP option is primary used for debugging
.I interface_check
and
.I interface_cmp.
-.LP
.SH EXAMPLES
The following example uses
.I interface_check
to generate an interface database for a workspace:
.PP
@@ -387,7 +373,7 @@
.BR interface_cmp(1ONBLD),
.BR ld(1),
.BR ldd(1),
.BR elfdump(1),
.BR pvs(1).
-.LP
-.TZ LLM
+
+