.\"                                      Hey, EMACS: -*- nroff -*-
.TH aapt 1 "October 15, 2014"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
aapt \- Android Asset Packaging Tool
.SH SYNOPSIS
.B aapt
.RI command\ [\ options\ ]\ files\ ...
.br
.PP
.B aapt
.RI l[ist]\ [\-v]\ [\-a]\ file.{zip,jar,apk}
.br
   List contents of Zip-compatible archive.
.PP

.B aapt
.RI d[ump]\ [\-\-values]\ WHAT\ file.{apk}\ [asset\ [asset\ ...]]

   strings        Print the contents of the resource table string pool in the APK.
   badging        Print the label and icon for the app declared in APK.
   permissions    Print the permissions from the APK.
   resources      Print the resource table from the APK.
   configurations Print the configurations in the APK.
   xmltree        Print the compiled xmls in the given assets.
   xmlstrings     Print the strings of the given compiled xml assets.

.B aapt
.RI p[ackage]\ [\-d]\ [\-f]\ [\-m]\ [\-u]\ [\-v]\ [\-x]\ [\-z]\ [\-M\ AndroidManifest.xml]

        [\-0 extension [\-0 extension ...]] [\-g tolerance] [\-j jarfile]
        [\-\-debug-mode] [\-\-min-sdk-version VAL] [\-\-target-sdk-version VAL]
        [\-\-app-version VAL] [\-\-app-version-name TEXT] [\-\-custom-package VAL]
        [\-\-rename-manifest-package PACKAGE]
        [\-\-rename-instrumentation-target-package PACKAGE]
        [\-\-utf16] [\-\-auto-add-overlay]
        [\-\-max-res-version VAL]
        [\-I base-package [\-I base-package ...]]
        [\-A asset-source-dir]  [\-G class-list-file] [\-P public-definitions-file]
        [\-S resource-sources [\-S resource-sources ...]]
        [\-F apk-file] [\-J R-file-dir]
        [\-\-product product1,product2,...]
        [\-c CONFIGS] [\-\-preferred-configurations CONFIGS]
        [raw-files-dir [raw-files-dir] ...]
        [\-\-output-text-symbols DIR]

   Package the android resources.  It will read assets and resources that are
   supplied with the \-M \-A \-S or raw-files-dir arguments.  The \-J \-P \-F and \-R
   options control which files are output.

.B aapt
.RI r[emove]\ [\-v]\ file.{zip,jar,apk}\ file1\ [file2\ ...]
   Delete specified files from Zip-compatible archive.

.B aapt
.RI a[dd]\ [\-v]\ file.{zip,jar,apk}\ file1\ [file2\ ...]
   Add specified files to Zip-compatible archive.

.B aapt
.RI c[runch]\ [\-v]\ \-S\ resource-sources\ ...\ \-C\ output-folder\ ...
   Do PNG preprocessing on one or several resource folders
   and store the results in the output folder.

.B aapt
.RI s[ingleCrunch]\ [\-v]\ \-i\ input-file\ \-o\ outputfile
   Do PNG preprocessing on a single file.

.B aapt
.RI v[ersion]
   Print program version.

.SH DESCRIPTION
The Android Asset Packaging Tool (aapt) takes your application resource files,
such as the AndroidManifest.xml file and the XML files for your Activities,
and compiles them. An R.java is also produced so you can reference your
resources from your Java code.
.PP

.SH OPTIONS
A summary of options is included below.
.TP
.B \-a
print Android-specific data (resources, manifest) when listing
.TP
.B \-c
specify which configurations to include.  The default is all
configurations.  The value of the parameter should be a comma
separated list of configuration values.  Locales should be specified
as either a language or language-region pair.  Some examples:
            en
            port,en
            port,land,en_US

If you put the special locale, zz_ZZ on the list, it will perform
pseudolocalization on the default locale, modifying all of the
strings so you can look for strings that missed the
internationalization process.  For example:
            port,land,zz_ZZ
.TP
.B \-d
one or more device assets to include, separated by commas
.TP
.B \-f
force overwrite of existing files
.TP
.B \-g
specify a pixel tolerance to force images to grayscale, default 0
.TP
.B \-j
specify a jar or zip file containing classes to include
.TP
.B \-k
junk path of file(s) added
.TP
.B \-m
make package directories under location specified by \-J
.TP
.B \-u
update existing packages (add new, replace older, remove deleted files)
.TP
.B \-v
verbose output
.TP
.B \-x
create extending (non-application) resource IDs
.TP
.B \-z
require localization of resource attributes marked with
localization="suggested"
.TP
.B \-A
additional directory in which to find raw asset files
.TP
.B \-G
A file to output proguard options into.
.TP
.B \-F
specify the apk file to output
.TP
.B \-I
add an existing package to base include set
.TP
.B \-J
specify where to output R.java resource constant definitions
.TP
.B \-M
specify full path to AndroidManifest.xml to include in zip
.TP
.B \-P
specify where to output public resource definitions
.TP
.B \-S
directory in which to find resources.  Multiple directories will be scanned
and the first match found (left to right) will take precedence.
.TP
.B \-0
specifies an additional extension for which such files will not
be stored compressed in the .apk.  An empty string means to not
compress any files at all.
.TP
.B \-\-debug-mode
inserts android:debuggable="true" in to the application node of the
manifest, making the application debuggable even on production devices.
.TP
.B \-\-min-sdk-version
inserts android:minSdkVersion in to manifest.  If the version is 7 or
higher, the default encoding for resources will be in UTF-8.
.TP
.B \-\-target-sdk-version
inserts android:targetSdkVersion in to manifest.
.TP
.B \-\-max-res-version
ignores versioned resource directories above the given value.
.TP
.B \-\-values
when used with "dump resources" also includes resource values.
.TP
.B \-\-version-code
inserts android:versionCode in to manifest.
.TP
.B \-\-version-name
inserts android:versionName in to manifest.
.TP
.B \-\-custom-package
generates R.java into a different package.
.TP
.B \-\-extra-packages
generate R.java for libraries. Separate libraries with ':'.
.TP
.B \-\-generate-dependencies
generate dependency files in the same directories for R.java and resource package
.TP
.B \-\-auto-add-overlay
Automatically add resources that are only in overlays.
.TP
.B \-\-preferred-configurations
Like the \-c option for filtering out unneeded configurations, but
only expresses a preference.  If there is no resource available with
the preferred configuration then it will not be stripped.
.TP
.B \-\-rename-manifest-package
Rewrite the manifest so that its package name is the package name
given here.  Relative class names (for example .Foo) will be
changed to absolute names with the old package so that the code
does not need to change.
.TP
.B \-\-rename-instrumentation-target-package
Rewrite the manifest so that all of its instrumentation
components target the given package.  Useful when used in
conjunction with \-\-rename-manifest-package to fix tests against
a package that has been renamed.
.TP
.B \-\-product
Specifies which variant to choose for strings that have
product variants
.TP
.B \-\-utf16
changes default encoding for resources to UTF-16.  Only useful when API
level is set to 7 or higher where the default encoding is UTF-8.
.TP
.B \-\-non-constant-id
Make the resources ID non constant. This is required to make an R java class
that does not contain the final value but is used to make reusable compiled
libraries that need to access resources.
.TP
.B \-\-error-on-failed-insert
Forces aapt to return an error if it fails to insert values into the manifest
with \-\-debug-mode, \-\-min-sdk-version, \-\-target-sdk-version \-\-version-code
and \-\-version-name.
Insertion typically fails if the manifest already defines the attribute.
.TP
.B \-\-output-text-symbols
Generates a text file containing the resource symbols of the R class in the
specified folder.
.TP
.B \-\-ignore-assets
Assets to be ignored.
.SH AUTHOR
aapt was written by The Android Open Source Project.
.PP