ceylon war(1) ceylon war(1)NAME
ceylon war - Generates a WAR file from a compiled `.car` file
SYNOPSIS
ceylon war [--cacherep=url] [--cwd=dir] [--exclude-
module=moduleOrFile...] [--maven-overrides=url]
[--name=name] [--no-default-repositories] [--offline]
[--out=dir] [--overrides=url] [--rep=url...] [--resource-
root=directory] [--sysrep=url] [--timeout=seconds]
[--verbose[=flags]] [--] {module-with-version}
DESCRIPTION
Generates a WAR file from the .car file of the given module-with-ver‐
sion, suitable for deploying to a standard Servlet container.
The version number is required since, in general, there can be multiple
versions available in the configured repositories.
The given module's .car file and those of its transitive dependencies
will be copied to the WEB-INF/lib of the generated WAR file. Dependen‐
cies which are provided by the application container (and thus not re‐
quired to be in WEB-INF/lib) can be excluded using --exclude-module.
OPTIONS
--cacherep=url
Specifies the folder to use for caching downloaded modules. (de‐
fault: ~/.ceylon/cache)
--cwd=dir
Specifies the current working directory for this tool. (default:
the directory where the tool is run from)
--exclude-module=moduleOrFile, -x moduleOrFile
Excludes modules from the WAR file. Can be a module name or a
file containing module names. Can be specified multiple times.
Note that this excludes the module from the WAR file, but if
your modules require that module to be present at runtime it
will still be required and may cause your application to fail to
start if it is not provided at runtime.
--maven-overrides=url
Specifies the xml file to use to load Maven artifact overrides.
See http://ceylon-lang.org/documentation/current/refer‐
ence/repository/maven/ for information. Deprecated: use --over‐
rides.
--name=name, -n name
Sets name of the WAR file (default: moduleName-version.war)
--no-default-repositories
Indicates that the default repositories should not be used.
--offline, -L
Enables offline mode that will prevent connections to remote
repositories.
--out=dir, -o dir
Sets the output directory for the WAR file (default: .)
--overrides=url
Specifies the xml file to use to load module overrides. See
http://ceylon-lang.org/documentation/current/reference/reposito‐
ry/maven/ for information. Experimental.
--rep=url
Specifies a module repository containing dependencies. Can be
specified multiple times. (default: modules, ~/.ceylon/repo,
http://modules.ceylon-lang.org/repo/1)
--resource-root=directory, -R directory
Sets the special resource directory whose files will end up in
the root of the resulting WAR file (default: web-content).
--sysrep=url
Specifies the system repository containing essential modules.
(default: $CEYLON_HOME/repo)
--timeout=seconds, -T seconds
Sets the timeout for connections to remote repositories, use 0
for no timeout (default: 20).
--verbose[=flags], -d
Produce verbose output. If no flags are given then be verbose
about everything, otherwise just be verbose about the flags
which are present. Allowed flags include: all, loader.
OVERRIDING WEB.XML
If you provide a custom WEB-INF/web.xml file in your WAR resource-root,
you'll need to include the listener (ceylon.war.WarInitializer) that is
set in the default web.xml. Without that listener, the metamodel will
not be properly initialized.
REPOSITORIES
Repositories like those specified with the --rep or --out options can
be file paths, HTTP urls to remote servers or can be names of reposito‐
ries when prepended with a + symbol. These names refer to repositories
defined in the configuration file or can be any of the following prede‐
fined names +SYSTEM, +CACHE, +LOCAL, +USER or +REMOTE. For more infor‐
mation see http://ceylon-lang.org/documentation/1.0/reference/tool/con‐
fig
28 October 2015 ceylon war(1)