apv-regtool : ApVSys registration utility

      Copyright (C) 2002 Arnaud BERTRAND
      web-site: http://www.apvsys.org


NAME

apv-regtool


Purpose

This is the most important administrative command. This is the command to use to register a tool (a version of a tool) in the ApVSys database.

The options enable the ApVSys administrator to tune the commands to register in the system.


SYNOPSYS

 apv-regtool -t toolname -v version [-v version] [-c -m -l -f -a]
       [-u ] [-d -D] [-o otherOS] [ -r restriction_level ]
       [ -i included-pattern ] [ -e excluded-pattern ]
       [ -L username ]


OPTIONS

-t, --tool toolname
specifies the tool (toolname) to register.

Note: the toolname must be the name of the directory in $APVSYS_ROOT/OsName/vOsVersion containing the different versions of the tool (or an installation image: please read ap-linktool documentation)

e.g. to register gcc, under Solaris 8, the directory: /apvroot/SunOS/v5.8/gcc must contain the version(s) to (un)register.

-v, --version versionname
specifies the version(s) to (un)register, this option can appear several times to register several versions of the same tool.

Note 1: the versionname MUST always begin with ``v'' (the letter ``v'')

Note 2: the versionname must be the name of the directory in $APVSYS_ROOT/OsName/vOsVersion/toolname containing the version of the tool to register.

Note 3: instead of ``-t tool -v version'', the syntax ``-t tool/version'' can also be used.

-c, --commands
By default, everything (commands, manpages, infopages, libraries) are registered. this option enables the admin to select separately what must be registered.

This option is used to register the commands only ( the content of the bin directory )

-l, --libraries
By default, everything (commands, manpages, infopages, libraries) are registered. this option enables the admin to select separately what must be registered.

This option is used to register the libraries only ( the content of the lib directory )

-m, --manpages
By default, everything (commands, manpages, infopages, libraries) are registered. this option enables the admin to select separately what must be registered.

This option is used to register the manpages only ( the content of the man directory )

-f, --infopages
By default, everything (commands, manpages, infopages, libraries) are registered. this option enables the admin to select separately what must be registered.

This option is used to register the infopages only ( the content of the info directory )

-u, --unregister
This flag must be specified to UNREGISTER a version of a tool.

Note 1: To unregister a version, the installation directory $APVSYS_ROOT/OsName/vOsVersion/toolname/version STILL HAS TO EXIST. This directory can only be deleted AFTER the unregistration. If it was removed, apv-dbcheck would have to be used to clean-up the database properly. It takes more time but the result is the same, the tool will be properly removed.

Note 2: To -fully- unregister a version of a tool, the filter options ( -c,-l,-m,-f,-r,-i,-e ) CANNOT be used. It is of course possible to use these options to partially unregister a version of a tool.

-d, --default
This switch must be used to specify that the version to register ( the first one if several versions are specified) is registered in the CURRENT O.S. as the default version.

-D, --other-os-default
The same as -d but the version becomes the default for all the specified operating systems if several oprating systems are specified( see -o option)

-o, --other-os operating_system.
This switch can be used to register the version(s) in several operating systems at the same time. The tool will always be registered in the current O.S. This option can appear several times. The argument must be OsName/vOsVersion (e.g. ``SunOS/v5.8'' )

-i, --pattern-include regexp
It is sometimes interesting to (un)register only a subset of the entities (commands, manpages, ... ). With this option, only the entities matching regexp will be taken into account.

-e, --pattern-exclude regexp
It is sometimes interesting to ignore a subset of the entities during a (un)registration. This is typically the case with tools containing the flexlm commands (lmstart, lmstat, lmdown,..). With this option, the entities matching regexp will be ignored.

-L, --login username
This option is mandatory (for logging purpose) to keep log of who (un)registered what.

-r, --restriction-level xxx
This option can filter the entities to register in function of previous versions of the same tool or in function of other installed tools. this option also gives the opportunity to register interactively each entity.

This is really interesting, when some commands are common with other tools, to tune the commands to register.

xxx=0 (default)
All the entities are registered and nothing will be prompted

xxx=10
If an entity is already registered for another tool, the registration automatically skips this entity automatically.

xxx=11
If an entity is registered for another tool, the registration prompts interactively what to do for this entity.

xxx=20
If an entity has never been registered for this tool (it assumes the registration of other version of the same tool), the registration skips this entity

xxx=21
If an entity has never been registered for this tool, the registration will prompt interactively what to do for this entity.

xxx=3
With this value, the registration will prompt interactively what to do for each entity.

-h, --help
print a short help message


EXAMPLES

 > apv-regtool -t gcc -v 2.95.3 -d       ## self-explain
 > apv-regtool -t gcc -v 2.95.3 -u       ## unregistration

In the next example, gcc will be registered for the current OS, but also for the 2 other specified OS. If there is no directory gcc/v2.95.3 for these O.S., a link will automatically be created.

 > apv-regtool -t gcc -v 2.95.3 -D -o SunOS/v5.7 -o SunOS/v5.8

More complex but classical example. It assumes that the tool ``ncsim'' was previously installed with another ( or the same ) version and it does not register the entities beginning with ``lm'' ( typically the flexlm commands, which can be registered for the flexlm tool )

 > apv-regtool -t ncsim -v 3.3s10  -r 21 -e "^lm"


SEE ALSO

apvsys-intro(1) ap-environment(1) apv(1) apv-linktool(1) apv-regtool(1) apv-setdefault(1) apv-osmirror(1) apv-nativeoscheck(1) apv-dbcheck(1) apv-lib(1) apv-xcheck(1)