| -augment PARAMETER ( ',' PARAMETER ) * |
Add requirements and capabilities to the resources during resolving. |
Workspace |
| -baseline selector |
Control what bundles are enabled for baselining and optionally specify the baseline version or file. |
Project |
| -baselinerepo qname |
Define the repository to calculate baselining against |
Workspace |
| -builderignore PATH-SPEC ( ',' PATH-SPEC ) * |
List of project-relative directories to be ignored by the builder. |
Project |
| -buildpath PATH |
Provides the class path for building the jar, the entries are references to the repositories. |
Project |
| -buildrepo repo ( ',' repo ) * |
After building a JAR, release the JAR to the given repositories. |
Project |
| -buildtool toolspec (EXPERIMENTAL!) |
A specification for the bnd CLI to install a build tool, like gradle, in the workspace |
bnd |
| -bumppolicy |
The policy for the bump command |
Macro |
| -bundleannotations SELECTORS |
Selects the classes that need processing for standard OSGi Bundle annotations. |
Project |
| -cdiannotations SELECTORS |
Selects the packages that need processing for CDI annotations. |
Project |
| -check 'ALL' | ( 'IMPORTS' | 'EXPORTS' ) * |
Enable additional checking |
Analyzer |
| -classpath FILE (',' FILE) * |
Specify additional file based entries (either directories or JAR files) to add to the used classpath. |
Analyzer |
| -compression DEFLATE | STORE |
Set the compression level for the generated JAR, the default is DEFLATE |
Builder |
| Conditional-Package PACKAGE-SPEC ( ',' PACKAGE-SPEC ) * |
Recursively add packages from the class path when referred and when they match one of the package specifications. |
Project |
| -conditionalpackage PACKAGE-SPEC ( ',' PACKAGE-SPEC ) * |
Recursively add packages from the class path when referred and when they match one of the package specifications. |
Project |
| -conduit |
This project is a front to one or more JARs in the file system |
Project |
| -connection-settings |
Setting up the communications for bnd |
|
| -consumer-policy VERSION-MASK |
Specify the default version bump policy for a consumer when a binary incompatible change is detected. |
Project |
| -contract |
Establishes a link to a contract and handles the low level details. |
Project |
| -define-contract |
Define a contract when one cannot be added to the buildpath. |
Project |
| -dependson SELECTORS |
Add dependencies from the current project to other projects, before this project is built, any project this project depends on will be built first. |
Project |
| -deploy |
Deploy this project through Deploy plugins (MavenDeploy plugin). Needs work |
Project |
| -deployrepo |
Deploy this project through Deploy plugins (MavenDeploy plugin). Needs work |
Project |
| -diffignore SELECTORS |
Manifest header names and resource paths to ignore during baseline comparison. |
Project |
| -diffpackages SELECTORS |
The names of exported packages to baseline. |
Project |
| -digests DIGEST ( ',' DIGEST ) * |
Set the digest algorithms to use |
Project |
| -distro REPO (',' REPO) |
Resolve against pre-defined system capabilities |
Workspace |
| -donotcopy |
Set the default filters for file resources that should not be copied. |
Project |
| -dsannotations-options SELECTORS |
Options for controlling DS annotation processing. |
Project |
| -dsannotations SELECTORS |
Selects the packages that need processing for standard OSGi DS annotations. |
Project |
| -eeprofile 'auto' | PROFILE + |
Provides control over what Java 8 profile to use. |
Project |
| -executable ( rejar= STORE | DEFLATE ) ( ',' strip= matcher ( ',' matcher )* ) ( ',' location= FORMAT ) |
Process an executable jar to strip optional directories of the contained bundles, and/or change their compression. The location string can also be calculated from bsn and version |
Project |
| -export-apiguardian PACKAGE-SPEC, ( ',' PACKAGE-SPEC )* |
Exports the given packages where the the `@API` annotation is found on contained classes. |
Project |
| -export PATH ( ';' PARAMETER )* ( ',' PATH ( ';' PARAMETER )* )* |
Turns a bndrun file into its deployable format |
Project |
| -exportcontents PACKAGE-SPEC, ( ',' PACKAGE-SPEC )* |
Exports the given packages but does not try to include them from the class path. The packages should be loaded with alternative means. |
Project |
| -exportreport report-def ( ',' report-def )* |
Configure a list of reports to be exported. |
Workspace & Project |
| -extension |
A plugin that is loaded to its url, downloaded and then provides a header used instantiate the plugin. |
Project |
| -failok ('true' | 'false')? |
Will ignore any error during building and assume all went ok. |
Project |
| -fixupmessages SELECTOR ( ';' ( is | replace | restrict ) )* ... |
Fixup errors and warnings. |
Project |
| -generate srcs ';output=' DIR ( ';' ( system | generate | classpath))* ... |
Generate sources |
Project |
| -groupid groupId |
Set the default Maven groupId |
Project |
| -include PATH-SPEC ( ',' PATH-SPEC ) * |
Include a number of files from the file system |
Project |
| -includepackage PACKAGE-SPEC, ( ',' PACKAGE-SPEC )* |
Include a number of packages from the class path |
Builder |
| -includeresource iclause |
Include resources from the file system |
Builder & Executable |
| -invalidfilenames |
Specify file/directory names that should not be used because they are not portable. |
Project |
| -javaagent BOOLEAN |
Specify if classpath jars with Premain-Class headers are to be used as java agents |
Project |
| -library library ( ',' library )* |
Apply a bnd library to the workspace, project, or bndrun file |
Workspace or Project |
| -make |
If a resource is not found, specify a recipe to make it. |
Project |
| -manifest FILE |
Override manifest calculation and set fixed manifest |
Builder |
| -manifest-name RESOURCE |
Set the resource path to the manifest, for certain standards the manifest has a different name. |
Ant |
| -maven-dependencies* entry ( ',' entry )* |
Configure maven dependency information for the generated pom |
Project |
| -maven-release ('local'|'remote') ( ',' option )* |
Set the Maven release options for the Maven Bnd Repository |
Project |
| -maven-scope dependency-scope |
Set the default Maven dependency scope to use when generating dependency information in the generated pom |
Project |
| -metatype-options SELECTORS |
Restricts the use of Metatype Annotation to a minimum version. |
Project |
| -metatype CLASS-SPEC ( ',' CLASS-SPEC )* |
Create metatype XML resources in the bundle based on the OCD annotations. |
Builder |
| -namesection RESOURCE-SPEC ( ',' RESOURCE-SPEC ) * |
Create a name section (second part of manifest) with optional property expansion and addition of custom attributes. Patterns not ending with \"/\" target resources. Those ending with \"/\" target packages. |
Builder |
| -nobuildincache BOOLEAN |
Do not use a build in cache for the launcher and JUnit. |
Builder |
| -nobundles BOOLEAN |
Do not build the project. |
Builder |
| -noclassforname BOOLEAN |
Do not add package reference to classes loaded with Class.forName(String). |
Builder |
| -nodefaultversion BOOLEAN |
Do not add a default version to exported packages when no version is present. |
Builder |
| -noee BOOLEAN |
Donot add an automatic requirement on an EE capability based on the class format. |
Ant |
| -noextraheaders BOOLEAN |
Do not add a any extra headers specific for bnd. |
Builder |
| -noimportjava BOOLEAN |
Do not import java.* packages. |
Analyzer |
| -nojunit BOOLEAN |
Indicate that this project does not have JUnit tests |
Ant |
| -nojunitosgi BOOLEAN |
Indicate that this project does not have JUnit OSGi tests |
Ant |
| -nomanifest BOOLEAN |
Do not safe the manifest in the JAR. |
Ant |
| -noparallel CATEGORY;task=TASKS |
Prevent Gradle tasks in the same category from executing in parallel. |
Workspace |
| -nouses BOOLEAN |
Do not calculate uses directives on package exports or on capabilities. |
Project |
| -output FILE |
Specify the output directory or file. |
Analyzer |
| -outputmask TEMPLATE ? |
If set, is used a template to calculate the output file. It can use any macro but the ${@bsn} and ${@version} macros refer to the current JAR being saved. The default is bsn + ".jar". |
Project |
| -package |
Packaging options |
Project |
| -pedantic BOOLEAN |
Warn about things that are not really wrong but still not right. |
Processor |
| -plugin.* plugin-def ( ',' plugin-def )* |
Load plugins and their parameters. |
Processor |
| -pluginpath* PARAMETERS |
Define JARs to be loaded in the local classloader for plugins. |
Processor |
| -pom BOOLEAN | PROPERTIES |
Generate a maven pom in the JAR |
Processor |
| -prepare makespec ( ',' makespec )* |
Execute a number of shell commands before every build (might not work on Windows) |
Project |
| -preprocessmatchers SELECTOR |
Specify which files can be preprocessed |
Builder |
| -privatepackage PACKAGE-SPEC |
Specify the private packages, these packages are included from the class path. Alternative to Private-Package, this version is not included in the manifest. |
Builder |
| -profile KEY |
Sets a prefix that is used when a variable is not found, it is then re-searched under "[<[profile]>]<[key]>". |
Builder |
| -provider-policy VERSION-MASK |
Specify the default version bump policy for a provider when a binary incompatible change is detected. |
Project |
| -releaserepo* NAME ( ',' NAME ) * |
Define the names of the repositories to use for a release |
Project |
| -remoteworkspace (true|false) |
Enable the workspace to server remote requests from the local system, needed for Launchpad |
Project |
| -removeheaders KEY-SELECTOR ( '.' KEY-SELECTOR ) * |
Remove matching headers from the manifest. |
Project |
| -reportconfig plugin-def ( ',' plugin-def )* |
Configure a the content of report. |
Workspace & Project |
| -reportnewer BOOLEAN |
Report any entries that were added to the build since the last JAR was made. |
Project |
| -reproducible BOOLEAN | TIMESTAMP |
Ensure the bundle can be built in a reproducible manner. |
Builder |
| -require-bnd (FILTER ( ',' FILTER )* )? |
The filter can test against 'version', which will contain the Bnd version. If it does not match, Bnd will generate an error. |
Project |
| -resolve.effective qname (',' qname ) |
Set the use effectives for the resolver |
Workspace |
| -resolve.excludesystem true|false |
A property used by the resolver, if set to true (default) it excludes the system resource |
Runtime |
| -resolve (manual|auto|beforelaunch|batch|cache) |
Defines when/how resolving is done to calculate the -runbundles |
Workspace |
| -resolve.preferences qname ( ',' qname ) |
Override the default order and selection of repositories |
Workspace |
| -resolvedebug INTEGER |
Display debugging information for a resolve operation |
Workspace |
| -resourceonly BOOLEAN |
Ignores warning if the bundle only contains resources and no classes. |
Project |
| -runblacklist requirement (',' requirement) |
Blacklist a set of bundles for a resolve operation |
Workspace |
| -runbuilds BOOLEAN |
Defines if this should add the bundles build by this project to the -runbundles. For a bndrun file this is default false, for a bnd file this is default true. |
Project |
| -runbundles* REPO-ENTRY ( ',' REPO-ENTRY )* |
Add additional bundles, specified with their bsn and version like in -buildpath, that are installed and started before the project is run. |
Project |
| -runee EE |
Define the runtime Execution Environment capabilities, default Java 6. |
Builder |
| -runenv PROPERTIES |
Specify a JDB port on invocation when launched outside a debugger so the debugger can attach later. |
Project |
| -runframework ( 'none' | 'services' | ANY )? |
Sets the type of framework to run. If 'none', an internal dummy framework is used. Otherwise the Java META-INF/services model is used for the FrameworkFactory interface name. |
Launcher |
| -runframeworkrestart BOOLEAN |
Restart the framework in the same VM if the framework is stopped or updated. |
Project |
| -runfw REPO-ENTRY |
Specify the framework JAR's entry in a repository. |
Launcher |
| -runjdb ADDRESS |
Specify a JDB socket transport address on invocation when launched outside a debugger so the debugger can attach later. |
Project |
| -runkeep true | false |
Decides to keep the framework storage directory between launching |
Project |
| -runnoreferences BOOLEAN |
Do not use the `reference:` URL scheme for installing a bundle in the installer. |
Launcher |
| -runpath REPO-ENTRY ( ',' REPO-ENTRY ) |
Additional JARs for the remote VM path, should include the framework. |
Project |
| -runprogramargs |
Additional arguments for the program invokation. |
Project |
| -runproperties PROPERTIES |
Define system properties for the remote VM. |
Launcher |
| -runprovidedcapabilities |
Extra capabilities for a distro resolve |
Workspace |
| -runrepos REPO-NAME ( ',' REPO-NAME )* |
Order and select the repository for resolving against. The default order is all repositories in their plugin creation order. |
Resolve |
| -runrequires REQUIREMENT ( ',' REQUIREMENT )* |
The root requirements for a resolve intended to create a constellation for the -runbundles. |
Resolve |
| -runstartlevel ( order | begin | step )* |
Assign a start level to each run-bundle after resolving |
Project |
| -runstorage FILE |
Define the directory to use for the framework's work area. |
Project |
| -runsystemcapabilities* CAPABILITY (',' CAPABILITY ) |
Define extra capabilities for the remote VM. |
Launcher |
| -runsystempackages* PARAMETERS |
Define extra system packages (packages exported from the remote VM -runpath). |
Launcher |
| -runtimeout DURATION |
|
Project |
| -runtrace BOOLEAN |
Trace the launched process in detail |
Launcher |
| -runvm KEYS |
Additional arguments for the VM invocation. Arguments are added as-is. |
Project |
| -savemanifest FILE |
Write out the manifest to a separate file after it has been calculated. |
Builder |
| -sign PARAMETERS |
Report any entries that were added to the build since the last JAR was made. |
Project |
| -snapshot STRING |
String to substitute for "SNAPSHOT" in the bundle version's qualifier |
Project |
| -sourcepath |
List of directory names that used to find sources. |
Builder |
| -sources BOOLEAN |
Include the source code (if available on the -sourcepath) in the bundle at OSGI-OPT/src |
Builder |
| -stalecheck srcs ';newer=' depends ( ';' ( warning | error | command ))* ... |
Perform a stale check of files and directories before building a jar |
Project |
| -standalone repo-spec (, repo-spec ) |
Disconnects the bndrun file from the workspace and defines its on repositories |
Run |
| -strict BOOLEAN |
If strict is true, then extra verification is done. |
Processor |
| -sub FILE-SPEC ( ',' FILE-SPEC )* |
Build a set of bnd files that use this bnd file as a basis. The list of bnd file can be specified with wildcards. |
Builder |
| -systemproperties PROPERTIES |
These system properties are set in the local JVM when a workspace is started. This was mainly added to allow one to set JVM options via system properties. |
Workspace |
| -testcontinuous BOOLEAN |
Do not exit after running the test suites but keep watching the bundles and rerun the test cases if the bundle is updated. |
Test |
| -tester REPO-SPEC |
Species the tester (bundle) that is supposed to test the code. The default is biz.aQute.tester |
Project |
| -testpackages PACKAGE-SPEC ( ',' PACKAGE-SPEC ) |
|
Project |
| -testpath REPO-SPEC ( ',' REPO-SPEC ) |
The specified JARs from a repository are added to the remote JVM's classpath if the JVM is started in test mode in addition to the -runpath JARs. |
Project |
| -testsources REGEX ( ',' REGEX )* |
Specification to find JUnit test cases by traversing the test src directory and looking for java classes. The default is (.*).java. |
Project |
| -testunresolved BOOLEAN |
Will execute a JUnit testcase ahead of any other test case that will abort if there are any unresolved bundles. |
Project |
| -undertest true |
Will be set by the project when it builds a JAR in test mode, intended to be used by plugins. |
Project |
| -upto VERSION |
Specify the highest compatibility version, will disable any incompatible features added after this version. |
Project |
| -wab FILE ( ',' FILE )* |
Create a Web Archive Bundle (WAB) or a WAR |
Builder |
| -wablib FILE ( ',' FILE )* |
Specify the libraries that must be included in a Web Archive Bundle (WAB) or WAR. |
Builder |
| -workingset PARAMETER ( ',' PARAMETER ) * |
Group the workspace into different working sets |
Workspace |
Intro
Headers
Instructions
Macros
Commands
