Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

debian::javahelper::eclipse(3) [debian man page]

Debian::Javahelper::Eclipse(3)					    Javahelper					    Debian::Javahelper::Eclipse(3)

NAME

       Debian::Javahelper::Eclipse - Eclipse Helper Library.

SYNOPSIS

	use Debian::Javahelper::Eclipse;

	my @orbitdeps = ();
	push(@orbitdeps, {
	    EOB_SYM_NAME => 'org.apache.commons.net',
	    EOB_SYS_JAR  => '/usr/share/java/commons-net2.jar'});
	#...
	# Install the feature to "$dropins/$name"
	install_zipped_feature($zip, "$dropins/$name");
	#  and symlink the following orbitdeps.
	install_zipped_feature($zip, "$dropins/$name", @orbitdeps);

DESCRIPTION

       This module is used by the eclipse related javahelpers to share common code.

       Please note this API is not stable and backwards compatibility is not guaranteed at the current time. Please contact the maintainers if you
       are interested in a stable API.

   Definitions
       A bundle refers to a jar file. An orbit dependency (a.k.a orbitdep) is a bundle, which is used by eclipse or one of its features without
       being a part of eclipse or said feature.

       This module keeps track of bundles via hashes; see the EOB_* constants for relevant keys (and their expected values).

   Constants
       EOB_SYM_NAME
	   Key for hashes to fetch the symbolic name of a bundle.

       EOB_BUNDLE_VERSION
	   Key for hashes to fetch the version of a bundle.

       EOB_SYS_JAR
	   Key for hashes to fetch the path to the system installed jar file.

	   Only valid for an orbit dependency and cannot be used with manifests.

   Methods
       install_zipped_feature($fzip, $loc[, $orbitdeps[, $package, $needs]])
	   Unpacks the zipped feature $fzip into $loc, which should be a subfolder of a dropins folder (e.g. /usr/share/eclipse/dropins/emf). This
	   can also be used to install the feature into a "build environment". In this case it should be installed into the same folder as the SDK
	   is (this folder is usually called "SDK").

	   If $orbitdeps is present, it should be an ARRAY ref containing orbit dependencies, which will be symlinked after unpacking. This sub
	   only needs the EOB_SYM_NAME and EOB_SYS_JAR to be set and valid. Orbit dependencies not present in the installed folder will be
	   ignored, so it is safe to have unrelated orbit dependencies in the ARRAY ref.

	   If $package and $needs are present, the former should be the name of a debian package and the latter a hashref. The sub will populate
	   the $needs hashref with which orbit dependencies are used by the package.  The $needs hashref can be re-used in multiple calls to this
	   sub.

	   Keys in $needs will be the path to the orbit jar's real location (EOB_SYS_JAR) and the value a new hashref. This hashref has as keys
	   the names of packages and as values 1. The $needs is used by jh_installeclipse to populate the ${orbit:Depends} variables for packages.

AUTHOR

       Niels Thykier <niels@thykier.net>

COPYRIGHT AND LICENSE

       Copyright 2010 by Niels Thykier

       This module is free software; you may redistribute it and/or modify it under the terms of GNU GPL 2.

0.43								    2011-02-17					    Debian::Javahelper::Eclipse(3)

Check Out this Related Man Page

JH_MANIFEST(1)							    Javahelper							    JH_MANIFEST(1)

NAME

       jh_manifest - Adds or/and modifies manifests for jars

SYNOPSIS

       jh_manifest  [debhelperoptions]	[options]  jar1 ... jarN

       jh_manifest  [debhelperoptions]	[options]

DESCRIPTION

       Javahelper tool to add or update manifests in a jar file. It can be used in two modes. If passed jar files, it will only process these jar
       files. Otherwise it will update all jar files in the packages it acts on.

       When processing a package, the debhelper(7) exclude option will make jh_manifest ignore matching jar files.

FILES

       debian/package.manifest (or debian/manifest)
	   This file consist of a list of jar files and values to add to their manifests. Values in this file will take precedence over values in
	   the original manifest (and command line arguments over values in this file).

	   It is allowed to list a link in this file instead of an actual jar file, provided that the link can be resolved when jh_manifest
	   processes it.

	   If a jar file is listed here cannot be found, jh_manifest will print a warning, unless the jar file has been excluded.

	   As of javahelper >= 0.32, you may add comments in this file. If the line starts with a "#" it is completely ignored.

	   This file is ignored if jh_manifest is passed jar files via command line.

OPTIONS

       -c classpath, --classpath=classpath
	   Sets the Class-Path attribute of all processed jar files to classpath.

	   If not passed, then the CLASSPATH environment variable will be used in the given jar file do not have a Class-Path attribute.

       -m class, --main=class
	   Sets the Main-Class attribute to class in all processed jar files.

       -o options, --javaopts=options
	   Sets the Debian-Java-Parameters to options in all processed jar files. This attribute is used by jarwrapper to start java with extra
	   options (e.g. to make more memory available).

       -j /path/to/java/home, --java-home=/path/to/java/home
	   Sets the Debian-Java-Home attribute to /path/to/java/home in all processed jars. This attribute is used by jarwrapper to determine
	   which JVM to use.

EXAMPLES

       An example debian/manifest file:

	# use the symlink so we do not have to update with the next upstream release.
	usr/share/java/my.jar:
	 Class-Path: dep1.jar dep2.jar
	 Main-Class: some.awesome.Class
	usr/share/java/dep2.jar:
	 Class-Path: dep1.jar

SEE ALSO

       debhelper(7)

       This program is a part of javahelper and uses debhelper as backend. There are also tutorials in /usr/share/doc/javahelper.

AUTHOR

       Niels Thykier <niels@thykier.net>

COPYRIGHT AND LICENSE

       Copyright 2010 by Niels Thykier

       This tool is free software; you may redistribute it and/or modify it under the terms of GNU GPL 2.

0.43								    2012-03-12							    JH_MANIFEST(1)
Man Page