3 Command-Line Interface
Available subcommands:
compile (Command: enigma compile),
dependencies (Command: enigma dependencies),
install (Command: enigma install),
launch (Command: enigma launch),
test (Command: enigma test).
3.1 Command: enigma
usage: enigma [ <option> ... ] <subcommand> [<subcommand-arguments>] ... |
requires a subcommand, one of: compile, dependencies, install, launch or test |
|
<option> is one of |
|
-V, --version |
Show the program's currently used version |
--license |
Show the program's license |
-C <directory>, --directory <directory> |
Change to directory directory before doing anything else |
--no-color |
Suppress displaying colors by the program |
--user-emacs-directory <directory> |
Overwrite the user's Emacs directory |
--emacs-exe <emacs-exe> |
Set a custom GNU Emacs executable path |
--help, -h |
Show this help |
-- |
Do not treat any remaining argument as a switch (at this level) |
|
Multiple single-letter switches can be combined after |
one `-`. For example, `-h-` is the same as `-h --`. |
|
Available subcommands: |
- compile - compile found Emacs Lisp files, |
- dependencies - install Emacs Lisp files' dependencies ("Package-Requires"), |
- install - install (suitable) Emacs Lisp files as packages (their parent dir), |
- launch - launch GNU Emacs in a prepared environment, |
- test - run found Emacs Lisp tests (supports: ert, ert-runner or buttercup). |
|
Original author: Maciej xgqt Barć. Licensed under the permissive |
copyleft MPL-2.0 license (http://mozilla.org/MPL/2.0/). No warranty. |
|
|
3.2 Command: enigma compile
usage: enigma compile [ <option> ... ] [<emacs-flags>] ... |
|
<option> is one of |
|
--help, -h |
Show this help |
-- |
Do not treat any remaining argument as a switch (at this level) |
|
Multiple single-letter switches can be combined after |
one `-`. For example, `-h-` is the same as `-h --`. |
|
3.3 Command: enigma dependencies
usage: enigma dependencies [ <option> ... ] [<emacs-flags>] ... |
|
<option> is one of |
|
* --clear-package-archives |
Clear the Emacs package-archives of any records |
* --add-package-archive <package-archive-url> |
Register a package-archive record |
--help, -h |
Show this help |
-- |
Do not treat any remaining argument as a switch (at this level) |
|
* Asterisks indicate options allowed multiple times. |
|
Multiple single-letter switches can be combined after |
one `-`. For example, `-h-` is the same as `-h --`. |
|
3.4 Command: enigma install
usage: enigma install [ <option> ... ] [<emacs-flags>] ... |
|
<option> is one of |
|
* --clear-package-archives |
Clear the Emacs package-archives of any records |
* --add-package-archive <package-archive-url> |
Register a package-archive record |
--help, -h |
Show this help |
-- |
Do not treat any remaining argument as a switch (at this level) |
|
* Asterisks indicate options allowed multiple times. |
|
Multiple single-letter switches can be combined after |
one `-`. For example, `-h-` is the same as `-h --`. |
|
3.5 Command: enigma launch
usage: enigma launch [ <option> ... ] [<emacs-flags>] ... |
|
<option> is one of |
|
--help, -h |
Show this help |
-- |
Do not treat any remaining argument as a switch (at this level) |
|
Multiple single-letter switches can be combined after |
one `-`. For example, `-h-` is the same as `-h --`. |
|
3.6 Command: enigma test
usage: enigma test [ <option> ... ] [<emacs-flags>] ... |
|
<option> is one of |
|
--buttercup-exe <buttercup-exe> |
Set a custom Buttercup executable path |
--ert-runner-exe <ert-runner-exe> |
Set a custom ERT-Runner executable path |
--help, -h |
Show this help |
-- |
Do not treat any remaining argument as a switch (at this level) |
|
Multiple single-letter switches can be combined after |
one `-`. For example, `-h-` is the same as `-h --`. |
|