Annotation of pkgsrc/lang/java-wrapper/files/java-wrapper.1, revision 1.1
1.1 ! jmmv 1: .\" $NetBSD$
! 2: .\"
! 3: .\" java-wrapper - Runs different Java implementations transparently.
! 4: .\" Copyright (c) 2004 Julio M. Merino Vidal <jmmv@NetBSD.org>
! 5: .\"
! 6: .\" Redistribution and use in source and binary forms, with or without
! 7: .\" modification, are permitted provided that the following conditions
! 8: .\" are met:
! 9: .\" 1. Redistributions of source code must retain the above copyright
! 10: .\" notice, this list of conditions and the following disclaimer.
! 11: .\" 2. Neither the name of The NetBSD Foundation nor the names of its
! 12: .\" contributors may be used to endorse or promote products derived
! 13: .\" from this software without specific prior written permission.
! 14: .\" 3. Neither the name of author nor the names of its contributors may
! 15: .\" be used to endorse or promote products derived from this software
! 16: .\" without specific prior written permission.
! 17: .\"
! 18: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
! 19: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
! 20: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
! 21: .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
! 22: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
! 23: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
! 24: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
! 25: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
! 26: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
! 27: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
! 28: .\" POSSIBILITY OF SUCH DAMAGE.
! 29: .\"
! 30: .Dd June 4, 2004
! 31: .Dt JAVA-WRAPPER 1
! 32: .Os
! 33: .Sh NAME
! 34: .Nm java-wrapper
! 35: .Nd runs different Java implementations transparently
! 36: .Sh SYNOPSIS
! 37: .Nm appletviewer
! 38: .Op Ar arg1 .. argN
! 39: .Nm jar
! 40: .Op Ar arg1 .. argN
! 41: .Nm java
! 42: .Op Ar arg1 .. argN
! 43: .Nm javac
! 44: .Op Ar arg1 .. argN
! 45: .Nm javadoc
! 46: .Op Ar arg1 .. argN
! 47: .Nm javah
! 48: .Op Ar arg1 .. argN
! 49: .Nm javap
! 50: .Op Ar arg1 .. argN
! 51: .Sh DESCRIPTION
! 52: .Nm
! 53: is a small wrapper that overrides the most common Java programs.
! 54: It executes the right Java implementation based on user's preference.
! 55: .Pp
! 56: A configuration file is used to specify which Java implementation is chosen.
! 57: The wrapper first tries to read
! 58: .Pa ~/.java-wrapper.conf ,
! 59: falling back to
! 60: .Pa @PKG_SYSCONFDIR@/java-wrapper.conf
! 61: if not found (note that one of them must exist; otherwise it will simply
! 62: abort execution).
! 63: .Pp
! 64: The configuration file simply defines some variables that map Java programs
! 65: to Java implementations.
! 66: Each variable contains the name of an implementation, installed from pkgsrc,
! 67: like
! 68: .Sq sun14
! 69: or
! 70: .Sq kaffe .
! 71: Variables doing this mapping have the same name as the Java program, but in
! 72: uppercase letters:
! 73: .Va APPLETVIEWER ,
! 74: .Va JAR ,
! 75: .Va JAVA ,
! 76: .Va JAVAC ,
! 77: .Va JAVADOC ,
! 78: .Va JAVAH ,
! 79: and
! 80: .Va JAVAP .
! 81: Even though, there is an special variable called
! 82: .Va DEFAULT .
! 83: This one sets the name of the implementation used in case any of the specific
! 84: variables are unset or empty.
! 85: .Pp
! 86: The real binary is then searched in
! 87: .Pa @PREFIX@/bin/,
! 88: using the name given in the variable, followed by a dash, followed by the
! 89: Java program.
! 90: For example, if you set
! 91: .Sq JAVA=sun14 ,
! 92: whenever you run
! 93: .Nm java ,
! 94: you will be really executing
! 95: .Pa @PREFIX@/bin/sun14-java .
! 96: .Sh FILES
! 97: .Bl -tag -width @PKG_SYSCONFDIR@/java-wrapper.conf -compact
! 98: .It Pa @PREFIX@/bin/
! 99: Location of real Java binaries.
! 100: .It Pa @PKG_SYSCONFDIR@/java-wrapper.conf
! 101: System wide configuration file.
! 102: .It Pa ~/.java-wrapper.conf
! 103: User specific configuration file.
! 104: .El
! 105: .Sh AUTHORS
! 106: .An Julio M. Merino Vidal Aq jmmv@NetBSD.org
CVSweb <webmaster@jp.NetBSD.org>