aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd/--env.rb
diff options
context:
space:
mode:
authorEricFromCanada2018-02-01 16:06:17 -0500
committerEricFromCanada2018-02-01 16:06:17 -0500
commit1d2b4ed321c55df609d69e3505e3d37ad28c6fb8 (patch)
tree72a5116eff4d631e28832a3adef59ee16cc03be4 /Library/Homebrew/cmd/--env.rb
parent2020f382cb6cc51d58f7cf6c2895361129f11b5a (diff)
downloadbrew-1d2b4ed321c55df609d69e3505e3d37ad28c6fb8.tar.bz2
docs: add more missing option descriptions
and improve wording or formatting where necessary.
Diffstat (limited to 'Library/Homebrew/cmd/--env.rb')
-rw-r--r--Library/Homebrew/cmd/--env.rb10
1 files changed, 8 insertions, 2 deletions
diff --git a/Library/Homebrew/cmd/--env.rb b/Library/Homebrew/cmd/--env.rb
index 90beee89c..e0a2b9f19 100644
--- a/Library/Homebrew/cmd/--env.rb
+++ b/Library/Homebrew/cmd/--env.rb
@@ -1,5 +1,11 @@
-#: * `--env`:
-#: Show a summary of the Homebrew build environment.
+#: * `--env` [`--shell=`(<shell>|`auto`)|`--plain`]:
+#: Show a summary of the Homebrew build environment as a plain list.
+#:
+#: Pass `--shell=`<shell> to generate a list of environment variables for the
+#: specified shell, or `--shell=auto` to detect the current shell.
+#:
+#: If the command's output is sent through a pipe and no shell is specified,
+#: the list is formatted for export to `bash`(1) unless `--plain` is passed.
require "extend/ENV"
require "build_environment"