.\"Generated by nroff_060126.wdt (26-Jan-06). Do NOT edit this output file. Instead, edit the source FM+SGML file.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH OVCREG 1 "" "" ""
.ds )H Hewlett-Packard Company
.ds ]L
.ds ]W June 2007
.SH NAME
ovcreg - component registration tool
.SH "SYNOPSIS"

.PP
ovcreg -h|-help 

.PP
ovcreg -check [\fI<filename>\fR] 

.PP
ovcreg -add [\fI<filename>\fR] 

.PP
ovcreg -del [\fI<component>\fR] 

.PP
ovcreg -version 

.SH "DESCRIPTION"

.LP
ovcreg is used to register a component with (and de-register the component from) the OvCtrl. The ovcreg command can also be used to check a component registration file for syntactical correctness.

.LP
If the OvCtrl daemon (ovcd) is running at the time of registration, it will be informed about the new component only if the -add option was applied and the component is not started. The OvCtrl shows the new component the next time the ovc command is called with the -status option.

.LP
If the OvCtrl daemon (ovcd) is running, the component will be stopped if the -del(ete) option was applied. NOTE: this option will \fInot\fR stop CORE components, which are denoted by the option \fICoreProcess\fR in the registration file. CORE components should be stopped with ovc command and the -kill option.

.Sh "Parameters"

.LP
ovcreg recognizes the following options:

.TP
-h|-help

Displays \fIall\fR available options for the ovcreg command.

.TP
-check [<\fIfilename\fR>]

Checks the syntax of <\fIfilename\fR>. <\fIfilename\fR> must not contain more than one component.

.TP
-add [<\fIfilename\fR>]

Checks the syntax of <\fIfilename\fR> and stores a copy in the configuration directory. Adding a component with a name which is already registered with the OvCtrl will overwrite the original registration with the new one. <\fIfilename\fR> must not contain more than one component.

.TP
-del [<\fIcomponent\fR>]

Stops and de-registers the specified <\fIcomponent\fR> from the OvCtrl and deletes the specified <\fIcomponent\fR> registration file. NOTE: the delete option does not stop CORE components. 

.TP
-version

Displays the version of ovcreg

.SH "AUTHOR"

.LP
ovcreg was developed by Hewlett-Packard Company.

.SH "EXIT STATUS"

.LP
The following exit values are returned:

.TP
0

Success - The syntax of the file is correct and the registration file is successfully added or deleted.

.TP
1

Wrong usage

.TP
2

Parsing error

.TP
3

Error deleting registration file

.TP
5

Error writing XML file

.TP
6

Component is not registered

.TP
7

Error stopping component

.TP
8

Error deleting component

.SH "FILES"

.LP
Registration files for components registered with the OvCtrl for the supported platforms reside in the following locations:

.TP 3
\(bu 
AIX, HP-UX, Linux, Solaris: 

/var/opt/OV/conf/ctrl/*.xml

.TP
\(bu 
True64: 

/usr/var/opt/OV/conf/ctrl/*.xml

.TP
\(bu 
MS Windows: 

C:\\Program Files\\HP OpenView\\data\\conf\\ctrl\\*.xml
.LP

.LP
Note that the user can change the specified default location for the registration files on machines running Microsoft Windows. 

.SH "EXAMPLES"

.LP
The following examples show how to use the ovcreg command and some of its options to control and display important information about registered components.

.TP 3
\(bu 
To check the syntax of the component registration file: opcle.xml:

ovcreg -check opcle.xml

.TP
\(bu 
To check the syntax of the component registration file, opcle.xml, and add the component defined in the component registration file, opcle.xml to the OvCtrl:

ovcreg -add opcle.xml

.TP
\(bu 
To stop and de-register the component registered as opcle:

ovcreg -del opcle
.LP

.SH "SEE ALSO"

.LP
ovc