aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorRalph Sennhauser <sera@gentoo.org>2013-02-10 18:35:25 +0000
committerRalph Sennhauser <sera@gentoo.org>2013-02-10 18:35:25 +0000
commitf3e27ddd9580a278d1e623f59095d658d84c94ca (patch)
tree592c4c0de45ef000255d8bfa3490e8ab4ae92521 /man
parentFix shebangs to be usable in Prefix (diff)
downloadjava-config-f3e27ddd9580a278d1e623f59095d658d84c94ca.tar.gz
java-config-f3e27ddd9580a278d1e623f59095d658d84c94ca.tar.bz2
java-config-f3e27ddd9580a278d1e623f59095d658d84c94ca.zip
Fix man page
svn path=/projects/java-config-2/trunk/; revision=9194
Diffstat (limited to 'man')
-rw-r--r--man/java-config-2.1123
1 files changed, 60 insertions, 63 deletions
diff --git a/man/java-config-2.1 b/man/java-config-2.1
index 691c858..9518e70 100644
--- a/man/java-config-2.1
+++ b/man/java-config-2.1
@@ -1,12 +1,12 @@
-.TH "JAVA-CONFIG" "1" "June 2005" "java-config 2.0.0" "User Commands"
+.TH "JAVA-CONFIG" "1" "September 2011" "java-config 2.2.0" "User Commands"
.SH "NAME"
-java\-config \- The Java configuration tool for Gentoo
+java-config - The Java configuration tool for Gentoo
.SH "SYNOPSIS"
-.B java\-config
+.B java-config
\fI[options]\fB
.SH "DESCRIPTION"
.PP
-.I java\-config
+.I java-config
Is used to query/set properties of your system's Java environment. It can be
used to list available VMs, java packages, set system default JVM and set user
default JVM.
@@ -14,104 +14,102 @@ default JVM.
In addition, it is used by Portage as a common interface to querying
properties about the various JVMs.
.SH "OPTIONS "
+.TP
+\fB--select-vm=VM\fI
+Use this vm instead of the active vm when returning information.
.TP
-\fB\-c \-\-javac\fI
+\fB-c, --javac\fI
Show full path to currently selected Java compiler.
.TP
-\fB\-j \-\-jar\fI
+\fB-j, --jar\fI
Show full path to currently selected
.I jar
command.
.TP
-\fB\-O \-\-jdk\-home\fI
-Show path to currently selected JDK.
+\fB-o, -O, --java-home, --jdk-home, --jre-home\fI
+Print JAVA_HOME of currently selected JVM.
.TP
-\fB\-o \-\-jre\-home\fI
-Show path to currently selected JRE.
+\fB-t, --tools\fI
+Print path to tools.jar
.TP
-\fB\-v \-\-java\-version\fI
+\fB-v, --java-version\fI
Query current JVM for version.
.TP
-\fB\-p [pkg1[\-SLOT],pkg2[\-SLOT],...] \-\-classpath[=package1,package2,...]\fI
+\fB-p [pkg1[-SLOT],pkg2[-SLOT],...] --classpath[=package1,package2,...]\fI
Calculate classpath for a package. If a package is installed in different
slots you can also specify the slot to get the specific classpath informations.
+.TP
+\fB-g VAR, --get-env=VAR\fI
+Print an environment variable from the active VM.
.TP
-\fB\-e filename \-\-exec=filename\fI
-Figure full path to one of the JDK/JRE utilities, such as
+\fB\-e command, --exec=command\fI
+Run the specified JDK/JRE utility of the active vm, such as
.I keytool
,
.I rmic
and others.
.
.TP
-\fB\-i PACKAGE(S), \-\-library=PACKAGE(S)\fI
+\fB-i PACKAGE(S), --library=PACKAGE(S)\fI
Print java library paths for these packages. Used for example in wrapper
scripts like this: -Djava.library.path=$(java-config -i swt-3). Follows the same
-pkg[\-SLOT] convention as for example \-\-classpath.
+pkg[-SLOT] convention as for example --classpath.
.
.TP
-\fB\-l \-\-list\-available\-packages\fI
+\fB-l, --list-available-packages\fI
List available Java packages. Used for selection by
-.I \-\-classpath
-,
-.I \-\-set\-system\-classpath
-and
-.I \-\-set\-user\-classpath
-.
+.I --classpath
.TP
-\fB\-L \-\-list\-available\-vms\fI
+\fB-L, --list-available-vms\fI
Lists available JVMs. Used with
-.I \-\-set\-system\-vm
+.I --set-system-vm
and
-.I \-\-set\-user\-vm
+.I -set-user-vm
.
.TP
-\fB\-S <vm\-id> \-\-set\-system\-vm=<vm\-id>\fI
-Sets the system\-wide default JVM.
-.TP
-\fB\-s <vm\-id> \-\-set\-user\-vm=<vm\-id>\fI
-Sets the user\-specific JVM by putting all necessary env vars into
-.I $HOME/.gentoo/java\-env .
+\fB-S <vm-id>, --set-system-vm=<vm-id>\fI
+Sets the system-wide default JVM.
.TP
-\fB\-f \-\-show\-active\-vm\fI
-Show the JVM that's currently active, as set via \-\-set\-system\-vm or \-\-set\-user\-vm.
+\fB-s <vm-id>, --set-user-vm=<vm-id>\fI
+Sets the user-specific JVM by putting all necessary env vars into
+.I $HOME/.gentoo/java-env .
.TP
-\fB\-A <pkg1>,<pkg2>,... \-\-set\-system\-classpath=<package1>,<package2>,...\fI
-Sets the system\-wide default CLASSPATH.
+\fB-f, --show-active-vm\fI
+Show the JVM that's currently active, as set via --set-system-vm or --set-user-vm.
.TP
-\fB\-a <pkg1>,<pkg2>,... \-\-set\-user\-classpath=<package1>,<package2>,...\fI
-Sets the user\-specific CLASSPATH by putting all necessary env vars into
-.I $HOME/.gentoo/java\-env\-classpath
-(sourced from $HOME/.gentoo/java\-env).
+\fB-n, --nocolor\fI
+Turn off all colors.
.TP
-\fB\-X \-\-clean\-system\-classpath\fI
-Cleans the system\-wide default classpath, leaving only vm needed jars
-on it.
+\fB-P <vm-id>, --print=<vm-id>\fI
+Print the environment information for the specified virtual machine.
.TP
-\fB\-x \-\-clean\-user\-classpath\fI
-Cleans the user specific classpath that was specified by
-.I \-\-set\-user\-classpath
-by deleting
-.I $HOME/.gentoo/java\-env\-classpath .
-.
+\fB-d, --with-dependencies\fI
+Include package dependencies in --classpath and --library calls.
.TP
-\fB\-n \-\-nocolor\fI
-Turn off all colors.
+\fB-r, --runtime\fI
+Print the runtime classpath.
.TP
-\fB\-P <vm\-id> \-\-print=<vm\-id>\fI
-Print the environment information for the specified virtual machine.
-.
+\fB--package=PACKAGE(S)\fI
+Retrieve a value from a packages package.env file, value is specified by --query.
+.TP
+\fB-q QUERY, --query=QUERY\fI
+Value to retieve from packages package.env file, specified by --package.
+.TP
+\fB--get-virtual-providers=PACKAGE(S)\fI
+Return a list of packages that provide a virtual.
.SH "NOTES"
-You can get the <vm\-id> that is used with
-.I \-\-set\-system\-vm=<vm\-id>
+You can get the <vm-id> that is used with
+.I --set-system-vm=<vm-id>
and
-.I \-\-set\-user\-vm=<vm\-id>
+.I --set-user-vm=<vm-id>
in the output of
-.I java\-config \-\-list\-available\-vms
-inside the brackets. Ex. [blackdown\-jdk\-1.4.1] and you can use this to
+.I java-config --list-available-vms
+inside the brackets. Ex. [blackdown-jdk-1.4.1] and you can use this to
set your default Java Virtual Machine.
+.SH "MAINTAINER"
+java@gentoo.org
.SH "AUTHORS"
Karl Trygve Kalleberg <karltk@gentoo.org>
.br
@@ -120,10 +118,9 @@ Adrian Almenar <strider@gentoo.org>
Jason Mobarak <aether@gentoo.org>
.SH "BUGS"
-Report any bugs you find to http://bugs.gentoo.org/.
+Report any bugs you find to https://bugs.gentoo.org/.
.SH "SEE ALSO"
-env\-update(5)
-.TP
-The \fI/usr/bin/java\-config\fR script.
+env-update(5)
.TP
+The \fI/usr/bin/java-config\fR script.