.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "GRADLE 1" .TH GRADLE 1 "2019-06-21" "Gradle 4.4.1" "Gradle Command Line Manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" gradle \- Adaptable, fast automation for all .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBgradle\fR [\fIoption...\fR] [\fItask...\fR] .SH "OPTIONS" .IX Header "OPTIONS" A detailed guide of the command line interface is provided on Gradle's official website. The project itself does not provide a manpage, therefore maintaining it is error-prone and costly. .PP The summary of the options is provided below. .IP "\fB\-?\fR, \fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-?, -h, --help" Shows a help message. .IP "\fB\-a\fR, \fB\-\-no\-rebuild\fR (deprecated)" 4 .IX Item "-a, --no-rebuild (deprecated)" Do not rebuild project dependencies. .IP "\fB\-\-all\fR" 4 .IX Item "--all" Shows additional detail in the task listing. See the documentation section \fB\s-1LISTING TASKS\s0\fR. .IP "\fB\-b\fR, \fB\-\-build\-file\fR" 4 .IX Item "-b, --build-file" Specifies the build file. See the documentation section \fB\s-1SELECTING BUILD\s0\fR. .IP "\fB\-\-build\-cache\fR (incubating)" 4 .IX Item "--build-cache (incubating)" Enables the Gradle build cache. Gradle will try to reuse outputs from previous builds. .IP "\fB\-\-no\-build\-cache\fR (incubating)" 4 .IX Item "--no-build-cache (incubating)" Disables the Gradle build cache. .IP "\fB\-c\fR, \fB\-\-settings\-file\fR" 4 .IX Item "-c, --settings-file" Specifies the settings file. .IP "\fB\-\-console\fR" 4 .IX Item "--console" Specifies which type of console output to generate. .Sp Set to \fBplain\fR to generate plain text only. This option disables all color and other rich output in the console output. .Sp Set to \fBauto\fR (the default) to enable color and other rich output in the console output when the build process is attached to a console, or to generate plain text only when not attached to a console. .Sp Set to \fBrich\fR to enable color and other rich output in the console output, regardless of whether the build process is not attached to a console. When not attached to a console, the build output will use \s-1ANSI\s0 control characters to generate the rich output. .Sp Set to \fBverbose\fR to enable color and other rich output like the \fBrich\fR, but output more detailed message (task name, output, etc.) .IP "\fB\-\-continue\fR" 4 .IX Item "--continue" Continues task execution after a task failure. .IP "\fB\-\-configure\-on\-demand\fR (incubating)" 4 .IX Item "--configure-on-demand (incubating)" Only relevant projects are configured in this build run. This means faster builds for large multi-projects. See the documentation section \fB\s-1CONFIGURATION ON DEMAND\s0\fR. .IP "\fB\-\-no\-configure\-on\-demand\fR (incubating)" 4 .IX Item "--no-configure-on-demand (incubating)" Disables the use of configuration on demand. .IP "\fB\-D\fR, \fB\-\-system\-prop\fR" 4 .IX Item "-D, --system-prop" Sets a system property of the \s-1JVM,\s0 for example \fB\-Dmyprop=myvalue\fR. See the documentation section \fB\s-1GRADLE PROPERTIES AND SYSTEM PROPERTIES\s0\fR. .IP "\fB\-d\fR, \fB\-\-debug\fR" 4 .IX Item "-d, --debug" Log in debug mode (includes normal stacktrace). See the documentation section \fB\s-1LOGGING\s0\fR. .IP "\fB\-g\fR, \fB\-\-gradle\-user\-home\fR" 4 .IX Item "-g, --gradle-user-home" Specifies the Gradle user home directory. The default is the \fB.gradle\fR directory in the user's home directory. .IP "\fB\-\-include\-build\fR" 4 .IX Item "--include-build" Run the build as a composite, including the specified build. See the documentation section \fB\s-1COMPOSITE BUILDS\s0\fR. .IP "\fB\-I\fR, \fB\-\-init\-script\fR" 4 .IX Item "-I, --init-script" Specifies an initialization script. See the documentation section \fB\s-1INIT SCRIPTS\s0\fR. .IP "\fB\-i\fR, \fB\-\-info\fR" 4 .IX Item "-i, --info" Set log level to info. See the documentation section \fB\s-1LOGGING\s0\fR. .IP "\fB\-m\fR, \fB\-\-dry\-run\fR" 4 .IX Item "-m, --dry-run" Runs the build with all task actions disabled. See the documentation section \fB\s-1DRY RUN\s0\fR. .IP "\fB\-\-offline\fR" 4 .IX Item "--offline" Specifies that the build should operate without accessing network resources. See the documentation section \fB\s-1CACHE COMMAND LINE OPTIONS\s0\fR. .IP "\fB\-P\fR, \fB\-\-project\-prop\fR" 4 .IX Item "-P, --project-prop" Sets a project property of the root project, for example \fB\-Pmyprop=myvalue\fR. See the documentation section \fB\s-1GRADLE PROPERTIES AND SYSTEM PROPERTIES\s0\fR. .IP "\fB\-p\fR, \fB\-\-project\-dir\fR" 4 .IX Item "-p, --project-dir" Specifies the start directory for Gradle. Defaults to current directory. See the documentation section \fB\s-1SELECTING BUILD\s0\fR. .IP "\fB\-\-parallel\fR (incubating)" 4 .IX Item "--parallel (incubating)" Build projects in parallel. Gradle will attempt to determine the optimal number of executor threads to use. This option should only be used with decoupled projects (see the documentation section \fB\s-1DECOUPLED PROJECTS\s0\fR). For limitations of this option please see the documentation section \fB\s-1PARALLEL EXECUTION\s0\fR. .IP "\fB\-\-no\-parallel\fR (incubating)" 4 .IX Item "--no-parallel (incubating)" Disables parallel execution to build projects. .IP "\fB\-\-max\-workers\fR (incubating)" 4 .IX Item "--max-workers (incubating)" Sets the maximum number of workers that Gradle may use. For example \fB\-\-max\-workers=3\fR. The default is the number of processors. .IP "\fB\-\-profile\fR" 4 .IX Item "--profile" Profiles build execution time and generates a report in the \fB buildDir /reports/profile\fR directory. See the documentation section \fB\s-1PROFILING BUILD\s0\fR. .IP "\fB\-\-project\-cache\-dir\fR" 4 .IX Item "--project-cache-dir" Specifies the project-specific cache directory. Default value is \fB.gradle\fR in the root project directory. .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 .IX Item "-q, --quiet" Log errors only. See the documentation section \fB\s-1LOGGING\s0\fR. .IP "\fB\-\-recompile\-scripts\fR (deprecated)" 4 .IX Item "--recompile-scripts (deprecated)" Forces scripts to be recompiled, bypassing caching. This option has been deprecated and is scheduled to be removed Gradle 5.0. You should avoid using it. .IP "\fB\-\-refresh\-dependencies\fR" 4 .IX Item "--refresh-dependencies" Refresh the state of dependencies. See the documentation section \fB\s-1CACHE COMMAND LINE OPTIONS\s0\fR. .IP "\fB\-\-rerun\-tasks\fR" 4 .IX Item "--rerun-tasks" Specifies that any task optimization is ignored. .IP "\fB\-S\fR, \fB\-\-full\-stacktrace\fR" 4 .IX Item "-S, --full-stacktrace" Print out the full (very verbose) stacktrace for any exceptions. See the documentation section \fB\s-1LOGGING\s0\fR. .IP "\fB\-s\fR, \fB\-\-stacktrace\fR" 4 .IX Item "-s, --stacktrace" Print out the stacktrace also for user exceptions (e.g. compile error). See the documentation section \fB\s-1LOGGING\s0\fR. .IP "\fB\-\-scan\fR (incubating)" 4 .IX Item "--scan (incubating)" Creates a build scan. Gradle will auto-apply the build scan plugin with a compatible version. For more information about build scans, please visit . .IP "\fB\-\-no\-scan\fR (incubating)" 4 .IX Item "--no-scan (incubating)" Disables the creation of a build scan. For more information about build scans, please visit . .IP "\fB\-t\fR, \fB\-\-continuous\fR (incubating)" 4 .IX Item "-t, --continuous (incubating)" Enables the documentation section \fB\s-1CONTINUOUS BUILD,CONTINUOUS BUILDING\s0\fR \- Gradle will automatically re-run when changes are detected. .IP "\fB\-u\fR, \fB\-\-no\-search\-upward\fR" 4 .IX Item "-u, --no-search-upward" Don't search in parent directories for a \fBsettings.gradle\fR file. .IP "\fB\-v\fR, \fB\-\-version\fR" 4 .IX Item "-v, --version" Prints version info. .IP "\fB\-w\fR, \fB\-\-warn\fR" 4 .IX Item "-w, --warn" Set log level to warn. See the documentation section \fB\s-1LOGGING\s0\fR .IP "\fB\-x\fR, \fB\-\-exclude\-task\fR" 4 .IX Item "-x, --exclude-task" Specifies a task to be excluded from execution. See the documentation section \fB\s-1EXCLUDING TASKS FROM THE COMMAND LINE\s0\fR. .Sp The above information is printed to the console when you execute \fBgradle \-h\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" .SH "AUTHORS" .IX Header "AUTHORS" Gradle developers