30 Command Line
The command line tool can be invoked in several different ways:
- bnd general-options cmd cmd-options
- bnd general-options <file>.jar
- bnd general-options <file>.bnd
In this text
bnd is used as if it is a command line program. This should be set up as:
java -jar <path to bnd>.jar ...
Work is in progress to simplify this.
|-failok||Same as the property -failok. The current run will create a JAR file even if there were errors.|
|-exceptions||Will print the exception when the software has ran into a bad exception and bails out. Normally only a message is printed. For debugging or diagnostic reasons, the exception stack trace can be very helpful.|
print ( -verify | -manifest | -list | - all ) * <file>.jar +
The print function will take a list of JAR file and print one or more aspect of the JAR files. The following aspects can be added.
- -verify - Verify the JAR for consistency with the specification. The print will exit with an error if the verify fails
- -manifest - Show the manifest
- -list - List the entries in the JAR file
- -all - Do all (this is the default)
bnd print -verify *.jar
buildx ( -classpath LIST | -eclipse <file> | -noeclipse | -output <file> ) * <file>.bnd +
The build function will assemble a bundle from the bnd specification. The default name of the output bundle is the name of the bnd file with a .jar extension.
- -classpath - A list of JAR files and/or directories that should be placed on the class path before the calculation starts.
- -eclipse - Parse the file as an Eclipse .classpath file, use the information to create an Eclipse's project class path. If this option is used, the default .classpath file is not read.
- -noeclipse - Do not parse the .classpath file of an Eclipse project.
- -output - Override the default output name of the bundle or the directory. If the output is a directory, the name will be derived from the bnd file name.
bnd buildx -classpath bin -noeclipse -output test.jar xyz.bnd
wrap ( -classpath (<file>(','<file>)*)-output <file|dir> | -properties <file> ) *
-ignoremanifest? <file>.jar *
The wrap command takes an existing JAR file and guesses the manifest headers that will make this JAR useful for an OSGi Service Platform. If the output file is not overridden, the name of the input file is used with a .bar extension. The default bnd file for the header calculation is:
Export-Package: * Import-Package: <packages inside the target jar>
If the target bundle has a manifest, the headers are merged with the properties.
The defaults can be overridden with a specific properties file.
- -output - Set the output file or directory
- -classpath - Sets the classpath as a comma separated list
- -properties - Use a special property file for the manifest calculation.
- -ignoremanifest - Do not include the manifest headers from the target bundle
bnd wrap -classpath osgi.jar *.jar
List the Eclipse information in the current directory.
The bnd.jar file is a complete plugin. To install this plugin, place it in the eclipse/plugin directory (or extension directory) of your Eclipse installation and restart (!). The plugin will provides a 'Make Bundle' context menu when you select a file that ends with .bnd. Two menus are shown when you select a JAR file. You can 'Wrap JAR', turning it into a bundle with all imports and exports set (the extension will be .bar), or you can use 'Verify Bundle', and verify the bundle for compliance to the spec. Any errors or warnings are listed in a dialog box.
Additionally, the plugin registers an editor for JAR files. The editor shows the full output of the print command.