$headContent

rpm:attached-rpm

Full name:

org.codehaus.mojo:rpm-maven-plugin:2.1-alpha-1:attached-rpm

Description:

Construct the RPM file and attaches it as a secondary artifact.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Since version: 2.0-beta-2.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
group String 2.0-beta-2 The package group for the package.
mappings List 2.0-beta-2 The list of file mappings.
name String 2.0-beta-2 The name portion of the output file name.
projversion String 2.0-beta-2 The version portion of the RPM file name.

Optional Parameters

Name Type Since Description
autoProvides boolean 2.0-beta-4 Automatically add provided shared libraries.
Default value is: true.
autoRequires boolean 2.0-beta-4 Automatically add requirements deduced from included shared libraries.
Default value is: true.
changelogFile File 2.0-beta-3 The changelog file. If the file does not exist, it is ignored.
classifier String 2.0-beta-2 The classifier for the rpm secondary artifact.
clean String 2.0-beta-2 Deprecated. Use cleanScriplet
cleanScript File 2.0-beta-2 Deprecated. Use cleanScriplet
cleanScriptlet Scriptlet 2.0-beta-4 The clean scriptlet.
conflicts LinkedHashSet 2.0-beta-2 The list of conflicts for this package.
copyright String 2.0-beta-2 The one-line copyright information.
defaultDirmode String 2.0-beta-2 The default directory mode (octal string) to assign to directories when installed.
Only applicable to a Mapping if filemode, username, AND groupname are NOT populated.
defaultFilemode String 2.0-beta-2 The default file mode (octal string) to assign to files when installed.
Only applicable to a Mapping if filemode, username, AND groupname are NOT populated.
defaultGroupname String 2.0-beta-2 The default group name for files when installed.
Only applicable to a Mapping if filemode, username, AND groupname are NOT populated.
defaultUsername String 2.0-beta-2 The default user name for files when installed.
Only applicable to a Mapping if filemode, username, AND groupname are NOT populated.
defineStatements List 2.0-beta-2 A list of %define arguments
description String 2.0-beta-2 The long description of the package.
disabled boolean 2.0 Indicates if the execution should be disabled. If true, nothing will occur during execution.
distribution String 2.0-beta-2 The distribution containing this package.
escapeString String 2.0 Expression preceded with the String won't be interpolated \${foo} will be replaced with ${foo}
filters List 2.0 Filters (property files) to include during the interpolation of the pom.xml.
icon File 2.0-beta-2 An icon for the package.
install String 2.0-beta-2 Deprecated. Use installScriplet
installScript File 2.0-beta-2 Deprecated. Use installScriplet
installScriptlet Scriptlet 2.0-beta-4 The installation scriptlet.
keyPassphrase Passphrase 2.0-beta-4 The passphrase for the keyname to sign the rpm. This utilizes expect and requires that expect be on the PATH.

Note that the data type used is NOTString.

<configuration>
    ...
    <keyPassphrase>
        <passphrase>password</passphrase>
    </keyPassphrase>



keyname String 2.0-beta-2 Set to a key name to sign the package using GPG. If keyPassphrase is not also provided, this will require the input of the passphrase at the terminal.
needarch String 2.0-beta-2 The target architecture for the rpm. The default value is noarch.

For passivity purposes, a value of true or false will indicate whether the architecture of the build machine will be used. Any other value (such as x86_64) will set the architecture of the rpm to x86_64.

This can also be used in conjunction with Source targetArchitecture to flex the contents of the rpm based on the architecture.
obsoletes LinkedHashSet 2.0-beta-3 The list of obsoletes for this package.
packager String 2.0-beta-2 The name of the person or group creating the package.
postinstall String 2.0-beta-2 Deprecated. Use postinstallScriplet
postinstallScript File 2.0-beta-2 Deprecated. Use postinstallScriplet
postinstallScriptlet Scriptlet 2.0-beta-4 The post install scriptlet.
postremove String 2.0-beta-2 Deprecated. Use postremoveScriplet
postremoveScript File 2.0-beta-2 Deprecated. Use postremoveScriplet
postremoveScriptlet Scriptlet 2.0-beta-4 The post-removal scriptlet.
posttransScriptlet Scriptlet 2.0-beta-4 The posttrans script.
prefix String 2.0-beta-2 The relocation prefix for this package.
preinstall String 2.0-beta-2 Deprecated. Use preinstallScriplet
preinstallScript File 2.0-beta-2 Deprecated. Use preinstallScriplet
preinstallScriptlet Scriptlet 2.0-beta-4 The pre-installation scriptlet.
prepare String 2.0-beta-2 Deprecated. Use prepareScriplet
prepareScript File 2.0-beta-2 Deprecated. Use prepareScriplet
prepareScriptlet Scriptlet 2.0-beta-4 The prepare scriptlet;
preremove String 2.0-beta-2 Deprecated. Use preremoveScriplet
preremoveScript File 2.0-beta-2 Deprecated. Use preremoveScriplet
preremoveScriptlet Scriptlet 2.0-beta-4 The pre-removal scriptlet.
prereqs LinkedHashSet 2.0-beta-3 The list of prerequisites for this package.
pretransScriptlet Scriptlet 2.0-beta-4 The pretrans scriptlet.
provides LinkedHashSet 2.0-beta-2 The list of virtual packages provided by this package.
release String 2.0-beta-2 The release portion of the RPM file name.

Beginning with 2.0-beta-2, this is an optional parameter. By default, the release will be generated from the modifier portion of the project version using the following rules:

  • If no modifier exists, the release will be 1.
  • If the modifier ends with SNAPSHOT, the timestamp (in UTC) of the build will be appended to end.
  • All instances of '-' in the modifier will be replaced with '_'.
  • If a modifier exists and does not end with SNAPSHOT, "_1" will be appended to end.
requires LinkedHashSet 2.0-beta-2 The list of requirements for this package.
summary String 2.0-beta-2 The one-line description of the package.
targetOS String 2.0-beta-3 The target os for building the RPM. By default, this will be populated to Os.OS_NAME.

This can be used in conjunction with Source targetOSName to flex the contents of the rpm based on operating system.
targetVendor String 2.0-beta-3 The target vendor for building the RPM. By default, this will be populated to the result of rpm -E %{_host_vendor}.
triggers List 2.0-beta-4 The list of triggers to take place on installation of other packages. 
 <triggers>
     <installTrigger>
         <subpackage>optional</subpackage>
         <program>program to execute (if not shell) optional</program>
         <script>actual contents of script - optional</script>
         <scriptFile>location of file containing script - optional</script>
         <fileEncoding>character encoding for script file - recommended</fileEncoding>
         <triggers>
             <trigger>package/version to trigger on (i.e. jre > 1.5)</trigger>
             ...
         </triggers>
     </installTrigger>
     <removeTrigger>
         ...
     </removeTrigger>
     <postRemoveTrigger>
         ...
     </postRemoveTrigger>
     ...
 </triggers>

url String 2.0-beta-2 A URL for the vendor.
vendor String 2.0-beta-2 The vendor supplying the package.
verify String 2.0-beta-2 Deprecated. Use verifyScriplet
verifyScript File 2.0-beta-2 Deprecated. Use verifyScriplet
verifyScriptlet Scriptlet 2.0-beta-4 The verify scriptlet.
workarea File 2.0-beta-2 The area for RPM to use for building the package.
NOTE: The absolute path to the workarea MUST NOT have a space in any of the directory names.

Beginning with release 2.0-beta-3, sub-directories will be created within the workarea for each execution of the plugin within a life cycle.
The pattern will be workarea/name[-classifier].
The classifier portion is only applicable for the attached-rpm goal.

Parameter Details

autoProvides:

Automatically add provided shared libraries.
  • Type: boolean
  • Since: 2.0-beta-4
  • Required: No
  • Default: true

autoRequires:

Automatically add requirements deduced from included shared libraries.
  • Type: boolean
  • Since: 2.0-beta-4
  • Required: No
  • Default: true

changelogFile:

The changelog file. If the file does not exist, it is ignored.
  • Type: java.io.File
  • Since: 2.0-beta-3
  • Required: No

classifier:

The classifier for the rpm secondary artifact.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

clean:

Deprecated. Use cleanScriplet
The clean script.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

cleanScript:

Deprecated. Use cleanScriplet
The location of the clean script.

Beginning with release 2.0-beta-3, a File which does not exist is ignored.

  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

cleanScriptlet:

The clean scriptlet.
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

conflicts:

The list of conflicts for this package.
  • Type: java.util.LinkedHashSet
  • Since: 2.0-beta-2
  • Required: No

copyright:

The one-line copyright information.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

defaultDirmode:

The default directory mode (octal string) to assign to directories when installed.
Only applicable to a Mapping if filemode, username, AND groupname are NOT populated.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

defaultFilemode:

The default file mode (octal string) to assign to files when installed.
Only applicable to a Mapping if filemode, username, AND groupname are NOT populated.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

defaultGroupname:

The default group name for files when installed.
Only applicable to a Mapping if filemode, username, AND groupname are NOT populated.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

defaultUsername:

The default user name for files when installed.
Only applicable to a Mapping if filemode, username, AND groupname are NOT populated.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

defineStatements:

A list of %define arguments
  • Type: java.util.List
  • Since: 2.0-beta-2
  • Required: No

description:

The long description of the package.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No
  • Expression: ${project.description}

disabled:

Indicates if the execution should be disabled. If true, nothing will occur during execution.
  • Type: boolean
  • Since: 2.0
  • Required: No

distribution:

The distribution containing this package.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

escapeString:

Expression preceded with the String won't be interpolated \${foo} will be replaced with ${foo}
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${maven.rpm.escapeString}

filters:

Filters (property files) to include during the interpolation of the pom.xml.
  • Type: java.util.List
  • Since: 2.0
  • Required: No

group:

The package group for the package.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: Yes

icon:

An icon for the package.
  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

install:

Deprecated. Use installScriplet
The installation script.

Beginning with release 2.0-beta-3, a File which does not exist is ignored.

  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

installScript:

Deprecated. Use installScriplet
The location of the installation script.

Beginning with release 2.0-beta-3, a File which does not exist is ignored.

  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

installScriptlet:

The installation scriptlet.
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

keyPassphrase:

The passphrase for the keyname to sign the rpm. This utilizes expect and requires that expect be on the PATH.

Note that the data type used is NOTString.

<configuration>
    ...
    <keyPassphrase>
        <passphrase>password</passphrase>
    </keyPassphrase>


  • Type: org.codehaus.mojo.rpm.Passphrase
  • Since: 2.0-beta-4
  • Required: No

keyname:

Set to a key name to sign the package using GPG. If keyPassphrase is not also provided, this will require the input of the passphrase at the terminal.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No
  • Expression: ${gpg.keyname}

mappings:

The list of file mappings.
  • Type: java.util.List
  • Since: 2.0-beta-2
  • Required: Yes

name:

The name portion of the output file name.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: Yes
  • Expression: ${project.artifactId}

needarch:

The target architecture for the rpm. The default value is noarch.

For passivity purposes, a value of true or false will indicate whether the architecture of the build machine will be used. Any other value (such as x86_64) will set the architecture of the rpm to x86_64.

This can also be used in conjunction with Source targetArchitecture to flex the contents of the rpm based on the architecture.

  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

obsoletes:

The list of obsoletes for this package.
  • Type: java.util.LinkedHashSet
  • Since: 2.0-beta-3
  • Required: No

packager:

The name of the person or group creating the package.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No
  • Expression: ${project.organization.name}

postinstall:

Deprecated. Use postinstallScriplet
The post-installation script.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

postinstallScript:

Deprecated. Use postinstallScriplet
The location of the post-installation script.

Beginning with release 2.0-beta-3, a File which does not exist is ignored.

  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

postinstallScriptlet:

The post install scriptlet.
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

postremove:

Deprecated. Use postremoveScriplet
The post-removal script.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

postremoveScript:

Deprecated. Use postremoveScriplet
The location of the post-removal script.

Beginning with release 2.0-beta-3, a File which does not exist is ignored.

  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

postremoveScriptlet:

The post-removal scriptlet.
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

posttransScriptlet:

The posttrans script.
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

prefix:

The relocation prefix for this package.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

preinstall:

Deprecated. Use preinstallScriplet
The pre-installation script.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

preinstallScript:

Deprecated. Use preinstallScriplet
The location of the pre-installation script.

Beginning with release 2.0-beta-3, a File which does not exist is ignored.

  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

preinstallScriptlet:

The pre-installation scriptlet.
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

prepare:

Deprecated. Use prepareScriplet
The prepare script.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

prepareScript:

Deprecated. Use prepareScriplet
The location of the prepare script. A File which does not exist is ignored.
  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

prepareScriptlet:

The prepare scriptlet;
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

preremove:

Deprecated. Use preremoveScriplet
The pre-removal script.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

preremoveScript:

Deprecated. Use preremoveScriplet
The location of the pre-removal script.

Beginning with release 2.0-beta-3, a File which does not exist is ignored.

  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

preremoveScriptlet:

The pre-removal scriptlet.
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

prereqs:

The list of prerequisites for this package.
  • Type: java.util.LinkedHashSet
  • Since: 2.0-beta-3
  • Required: No

pretransScriptlet:

The pretrans scriptlet.
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

projversion:

The version portion of the RPM file name.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: Yes
  • Expression: ${project.version}

provides:

The list of virtual packages provided by this package.
  • Type: java.util.LinkedHashSet
  • Since: 2.0-beta-2
  • Required: No

release:

The release portion of the RPM file name.

Beginning with 2.0-beta-2, this is an optional parameter. By default, the release will be generated from the modifier portion of the project version using the following rules:

  • If no modifier exists, the release will be 1.
  • If the modifier ends with SNAPSHOT, the timestamp (in UTC) of the build will be appended to end.
  • All instances of '-' in the modifier will be replaced with '_'.
  • If a modifier exists and does not end with SNAPSHOT, "_1" will be appended to end.


  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

requires:

The list of requirements for this package.
  • Type: java.util.LinkedHashSet
  • Since: 2.0-beta-2
  • Required: No

summary:

The one-line description of the package.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No
  • Expression: ${project.name}

targetOS:

The target os for building the RPM. By default, this will be populated to Os.OS_NAME.

This can be used in conjunction with Source targetOSName to flex the contents of the rpm based on operating system.

  • Type: java.lang.String
  • Since: 2.0-beta-3
  • Required: No

targetVendor:

The target vendor for building the RPM. By default, this will be populated to the result of rpm -E %{_host_vendor}.
  • Type: java.lang.String
  • Since: 2.0-beta-3
  • Required: No

triggers:

The list of triggers to take place on installation of other packages. 
 <triggers>
     <installTrigger>
         <subpackage>optional</subpackage>
         <program>program to execute (if not shell) optional</program>
         <script>actual contents of script - optional</script>
         <scriptFile>location of file containing script - optional</script>
         <fileEncoding>character encoding for script file - recommended</fileEncoding>
         <triggers>
             <trigger>package/version to trigger on (i.e. jre > 1.5)</trigger>
             ...
         </triggers>
     </installTrigger>
     <removeTrigger>
         ...
     </removeTrigger>
     <postRemoveTrigger>
         ...
     </postRemoveTrigger>
     ...
 </triggers>
  • Type: java.util.List
  • Since: 2.0-beta-4
  • Required: No

url:

A URL for the vendor.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No
  • Expression: ${project.organization.url}

vendor:

The vendor supplying the package.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No
  • Expression: ${project.organization.name}

verify:

Deprecated. Use verifyScriplet
The verification script.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No

verifyScript:

Deprecated. Use verifyScriplet
The location of the verification script.

Beginning with release 2.0-beta-3, a File which does not exist is ignored.

  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

verifyScriptlet:

The verify scriptlet.
  • Type: org.codehaus.mojo.rpm.Scriptlet
  • Since: 2.0-beta-4
  • Required: No

workarea:

The area for RPM to use for building the package.
NOTE: The absolute path to the workarea MUST NOT have a space in any of the directory names.

Beginning with release 2.0-beta-3, sub-directories will be created within the workarea for each execution of the plugin within a life cycle.
The pattern will be workarea/name[-classifier].
The classifier portion is only applicable for the attached-rpm goal.

  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No
  • Expression: ${project.build.directory}/rpm