Skip to content

Commit 23dbaca

Browse files
committed
Updating manpages before 3.7.0
1 parent 9c24f55 commit 23dbaca

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

manpages/rebar3.1

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "REBAR3" "1" "January 2017" "Erlang"
1+
.TH "REBAR3" "1" "November 2018" "Erlang"
22

33
.SH NAME
44

@@ -62,8 +62,10 @@ Remove compiled beam files from apps.
6262
.IP
6363
\fI--profile\fR: Clean under profile. Equivalent to `rebar3 as <profile> clean`
6464
.TP
65-
\fBcompile\fR
65+
\fBcompile\fR [\fI-d\fR|\fI--deps_only\fR]
6666
Compile apps .app.src and .erl files.
67+
.IP
68+
\fI--deps_only\fR: Only compile dependencies, no project apps will be built.
6769
.TP
6870
\fBcover\fR [\fI-r\fR|\fI--reset\fR] [\fI-v\fR|\fI--verbose\fR] [\fI-m\fR|\fI--min_coverage\fR]
6971
Perform coverage analysis.
@@ -131,7 +133,7 @@ Run Common Tests.
131133
.IP
132134
\fI--include\fR: Directories containing additional include files
133135
.IP
134-
\fI--readable\fR: Shows test case names and only displays logs to shell on failures
136+
\fI--readable\fR: Shows test case names and only displays logs to shell on failures (true | compact | false)
135137
.IP
136138
\fI--verbose\fR: Verbose output
137139
.IP
@@ -226,7 +228,7 @@ Print paths to build dirs in current profile.
226228
\fI--rel\fR: Return the `rel' path of the current profile.
227229
.TP
228230
\fBpkgs\fR
229-
List available packages.
231+
List information for a package.
230232
.TP
231233
\fBrelease\fR [\fI-n\fR|\fI--relname\fR] [\fI-v\fR|\fI--relvsn\fR] [\fI-g\fR|\fI--goal\fR] [\fI-u\fR|\fI--upfrom\fR] [\fI-o\fR|\fI--output-dir\fR] [\fI-h\fR|\fI--help\fR] [\fI-l\fR|\fI--lib-dir\fR] [\fI-p\fR|\fI--path\fR] [\fI--default-libs\fR] [\fI-V\fR|\fI--verbose\fR] [\fI-d\fR|\fI--dev-mode\fR] [\fI-i\fR|\fI--include-erts\fR] [\fI-a\fR|\fI--override\fR] [\fI-c\fR|\fI--config\fR] [\fI--overlay_vars\fR] [\fI--vm_args\fR] [\fI--sys_config\fR] [\fI--system_libs\fR] [\fI--version\fR] [\fI-r\fR|\fI--root\fR]
232234
Build release of project.
@@ -317,7 +319,7 @@ Create relup of releases.
317319
\fBreport\fR
318320
Provide a crash report to be sent to the rebar3 issues page.
319321
.TP
320-
\fBshell\fR [\fI--config\fR] [\fI--name\fR] [\fI--sname\fR] [\fI--setcookie\fR] [\fI--script\fR] [\fI--apps\fR] [\fI--user_drv_args\fR]
322+
\fBshell\fR [\fI--config\fR] [\fI--name\fR] [\fI--sname\fR] [\fI--setcookie\fR] [\fI--script\fR] [\fI--apps\fR] [\fI--start-clean\fR] [\fI--user_drv_args\fR]
321323
Run shell with project apps and deps in path.
322324
.IP
323325
\fI--config\fR: Path to the config file to use. Defaults to {shell, [{config, File}]} and then the relx sys.config file if not specified.
@@ -332,6 +334,8 @@ Run shell with project apps and deps in path.
332334
.IP
333335
\fI--apps\fR: A list of apps to boot before starting the shell. (E.g. --apps app1,app2,app3) Defaults to rebar.config {shell, [{apps, Apps}]} or relx apps if not specified.
334336
.IP
337+
\fI--start-clean\fR: Cancel any applications in the 'apps' list or release.
338+
.IP
335339
\fI--user_drv_args\fR: Arguments passed to user_drv start function for creating custom shells.
336340
.TP
337341
\fBtar\fR [\fI-n\fR|\fI--relname\fR] [\fI-v\fR|\fI--relvsn\fR] [\fI-g\fR|\fI--goal\fR] [\fI-u\fR|\fI--upfrom\fR] [\fI-o\fR|\fI--output-dir\fR] [\fI-h\fR|\fI--help\fR] [\fI-l\fR|\fI--lib-dir\fR] [\fI-p\fR|\fI--path\fR] [\fI--default-libs\fR] [\fI-V\fR|\fI--verbose\fR] [\fI-d\fR|\fI--dev-mode\fR] [\fI-i\fR|\fI--include-erts\fR] [\fI-a\fR|\fI--override\fR] [\fI-c\fR|\fI--config\fR] [\fI--overlay_vars\fR] [\fI--vm_args\fR] [\fI--sys_config\fR] [\fI--system_libs\fR] [\fI--version\fR] [\fI-r\fR|\fI--root\fR]
@@ -429,5 +433,9 @@ How much color to show in the terminal. Defaults to \fIhigh\fR.
429433
\fBREBAR_CONFIG\fR
430434
Name of rebar configuration files. Defaults to \fIrebar.config\fR
431435

436+
.TP
437+
\fBREBAR_GIT_CLONE_OPTIONS\fR
438+
Arguments to add after each \fIgit clone\fR operation. For example, the value \fI--reference ~/.cache/repos.reference\fR allows to create a cache of all fetched repositories across builds
439+
432440
.SH Configuration File Options
433441
See \fIhttp://www.rebar3.org/v3.0/docs/configuration\fR

0 commit comments

Comments
 (0)