vmkinst − Install a VisionX module

vmkinst [-H] [if=<input file>] [-t] [-l] [-a] [-i] [-f] [-v]

vmkinst installs a VisionX module. The input file should be the tarball containing the module.

vmkinst requires the module conform to certain requirements. All files in the distribution should be in a single directory, including documentation. A Vmakefile is expected, as vmkinst will run vmkmf and then perform a ‘make install‘. If any additional installations are needed, they should be in a separate script file called module.inst (where module is the module name). Note this script should not be a shell script because it may not be run on a UNIX platform.

vmkinst will copy the man pages into their appropriate locations. Man pages are put into the VisionX man directory. Text versions (and the text index) are placed into VisionX text directory and the HTML versions (and the two HTML indices) are placed into the HTML directory. The index files should be created prior to installation (with vmkman) and included in the distribution.

Finally, a text file called module.info (where module is the module name) should be included. This file is used when generating the HTML pages.

Vmkinst calls vmkidx, which will update the man indices.

A log file named module.inst.log (where ’module’ is the module name) is created as well.

SAMPLE MODULE: vmod.Z vmod/README (Release Notes)

vmod/Vmakefile (standard Vmakefile)

vmod/vmod.inst (TK script with extra instructions - Optional)

vmod/vmod.info (Paragraph(s) describing module)

vmod/vprogram.c

vmod/vprogram.1

(the following files are generated by vmkman (linux only) after all of the above files are completed.)

vmod/vprogram.1.html (html man page, created by vmkman)

vmod/vprogram.txt (text man page, created by vmkman)

vmod/vmod.mt (module text index, created by vmkman)

vmod/vmod.mha (module html alphabetic index, created by vmkman)

vmod/vmod.mhs (module html subject index, created by vmkman)

vmod/infvmod.html (module html info page, created by vmkman)

if=<input file>

Input module tarball

-l

List all files in the distribution

-t

Print the .info file to the screen

-a

Install all modules in directory (checks .tar, .tgz, .gz, and .Z)

-a

Display all installed modules

-f

Force the install to proceed even if there are compilation errors

-v

Verbose

*

This must be run as VisionX

*

Vmkinst requires a fully functional v4 installation and modules must conform to VisionX module specifications

--

--

vmkman (1), vmkidx (1), vmkmf (1),

Benjamin Stein