Merge pull request #232 from tuncer/doc-abbrev-cmd

Document support for abbreviated commands
This commit is contained in:
Jared Morrow 2014-02-25 07:50:09 -07:00
commit 3b08e93ef9

View file

@ -184,9 +184,21 @@ help() ->
"[var=value,...] <command,...>", "[var=value,...] <command,...>",
[{"var=value", "rebar global variables (e.g. force=1)"}, [{"var=value", "rebar global variables (e.g. force=1)"},
{"command", "Command to run (e.g. compile)"}]), {"command", "Command to run (e.g. compile)"}]),
?CONSOLE("To see a list of built-in commands, execute rebar -c.~n~n", []),
?CONSOLE( ?CONSOLE(
"Type 'rebar help <CMD1> <CMD2>' for help on specific commands." "Type 'rebar help <CMD1> <CMD2>' for help on specific commands."
"~n~n", []), "~n~n", []),
?CONSOLE(
"rebar allows you to abbreviate the command to run:~n"
"$ rebar co # same as rebar compile~n"
"$ rebar eu # same as rebar eunit~n"
"$ rebar g-d # same as rebar get-deps~n"
"$ rebar x eu # same as rebar xref eunit~n"
"$ rebar l-d # same as rebar list-deps~n"
"$ rebar l-d l-t # same as rebar list-deps list-templates~n"
"$ rebar list-d l-te # same as rebar list-deps list-templates~n"
"~n", []),
?CONSOLE( ?CONSOLE(
"Core rebar.config options:~n" "Core rebar.config options:~n"
" ~p~n" " ~p~n"