Skip to content

Commit 7c576a8

Browse files
committed
Improve documentation.
1 parent 280eec7 commit 7c576a8

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

Cabal/doc/installing-packages.markdown

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -351,10 +351,10 @@ $ cabal --ignore-sandbox install text
351351

352352
## Displaying cabal environment information ##
353353

354-
A cabal environment (the directory containing a package) has a certain state.
355-
One example are the flags of the last (successful) configuration. The
356-
`cabal status` command will print a summary over several
357-
aspects of the environment, such as
354+
A cabal environment (the directory containing a package) has a certain
355+
state. One example are the flags of the last (successful)
356+
configuration. The `cabal status` command will print a summary over
357+
several aspects of the environment, such as
358358

359359
* the cabal version;
360360

@@ -376,6 +376,26 @@ Configured compiler:
376376
ghc-7.10.3
377377
~~~~~~~~~~~~~~~
378378

379+
Full list of options supported by `cabal status`:
380+
381+
* `--version` -- Print the version of this program.
382+
* `--versions` -- List the versions of all known/related programs
383+
(e.g. `ghc` and `ghc-pkg`).
384+
* `--compiler` -- Print the currently configured compiler info.
385+
* `--package` -- Print information about the package in the current directory.
386+
* `--plan` -- List all packages in the install plan for the current
387+
package. Implies `--package`.
388+
* `--sandbox` -- Print information about the currently configured sandbox
389+
(if any).
390+
* `--databases` -- List all packages in the global, local and sandbox
391+
package databases
392+
* `--check` -- Check package databases for consistency.
393+
* `--all` -- Include all the above information.
394+
395+
Please note that the output of `cabal status` is not intended to be
396+
machine parseable and should not be expected to be stable across
397+
versions.
398+
379399
## Creating a binary package ##
380400

381401
When creating binary packages (e.g. for Red Hat or Debian) one needs to

0 commit comments

Comments
 (0)