NAME

SYNOPSIS

DESCRIPTION

By default, manvm will select the most “native” and up to date version of the Java VM when locating the manual page to be displayed. This selection process is akin to that used by javavm in that the same environment variables and processes are used.

The manual pages are displayed using man, and all applicable environment variables, save for MANPATH, are respected. Options may be passed to man using the JAVAVM_OPTS environment variable and its associated sub-variables and configuration file.

ENVIRONMENT

JAVA_HOME

The presence of this variable in the environment when executing manvm will override all other considerations regarding the Java VM whose on-line manual pages will be displayed and the manual pages located at ${JAVA_HOME}/man will be used.

JAVA_OS

A space delimited list of operating systems. The on-line manual pages to be displayed must come from a Java VM that has been created for one of the operating systems in the list.

Currently allowed operating system values are ‘native’ and ‘linux’.

JAVA_VENDOR

A space delimited list of Java VM vendors. The on-line manual pages to be displayed must come from a Java VM that has been released by one of the vendors in the list.

Currently allowed vendors are ‘openjdk’, ‘oracle’, and ‘sun’.

JAVA_VERSION

A space delimited list of versions of the Java VM from which the on-line manual pages may come. By appending a ‘+’ to a version, the on-line manual pages from any Java VM with a version greater than or equal to the given version will be used.

Currently allowed versions are ‘1.7’, ‘1.7+’, ‘1.8’, ‘1.8+’, ‘1.9’, ‘1.9+’, ‘7’, ‘7+’, ‘8’, ‘8+’, ‘9’, ‘9+’, ‘10’, ‘10+’, ‘11’, ‘11+’, ‘12’, ‘12+’, ‘13’, ‘13+’, ‘14’, ‘14+’, ‘15’, ‘15+’, ‘16’, ‘16+’, ‘17’, and ‘17+’.

JAVAVM_OPTS

The contents of this environment variable will be passed to the invoked man as options. For more information on environment variables which can be used to set options see /usr/local/etc/javavm_opts.conf.dist.

EXAMPLES

/usr/local/bin/manvm java

Display the on-line manual page for the java programme of the the most up to date and “native” Java VM registered with javavm.

JAVA_VERSION=8 /usr/local/bin/manvm javac

Display the on-line manual page for the javac programme for a Java VM which is version 8.

SEE ALSO