aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd/desc.rb
diff options
context:
space:
mode:
Diffstat (limited to 'Library/Homebrew/cmd/desc.rb')
-rw-r--r--Library/Homebrew/cmd/desc.rb10
1 files changed, 10 insertions, 0 deletions
diff --git a/Library/Homebrew/cmd/desc.rb b/Library/Homebrew/cmd/desc.rb
index df228d643..e7e7528fc 100644
--- a/Library/Homebrew/cmd/desc.rb
+++ b/Library/Homebrew/cmd/desc.rb
@@ -1,3 +1,13 @@
+#: * `desc` <formula>:
+#: Display <formula>'s name and one-line description.
+#:
+#: * `desc` [`-s`|`-n`|`-d`] <pattern>:
+#: Search both name and description (`-s`), just the names (`-n`), or just the
+#: descriptions (`-d`) for `<pattern>`. `<pattern>` is by default interpreted
+#: as a literal string; if flanked by slashes, it is instead interpreted as a
+#: regular expression. Formula descriptions are cached; the cache is created on
+#: the first search, making that search slower than subsequent ones.
+
require "descriptions"
require "cmd/search"