htop-osx: add setuid caveats

From discussion in #11727.

1 files changed, 11 insertions, 0 deletions

diff --git a/Library/Formula/htop-osx.rb b/Library/Formula/htop-osx.rb
index 91104e52b..984ad5ada 100644
--- a/Library/Formula/htop-osx.rb
+++ b/Library/Formula/htop-osx.rb
@@ -12,4 +12,15 @@ class HtopOsx < Formula
     system "./configure", "--disable-dependency-tracking", "--prefix=#{prefix}"
     system "make", "install", "DEFAULT_INCLUDES='-iquote .'"
   end
+
+  def caveats; <<-EOS.undent
+    htop-osx requires root privileges to correctly display all running processes.
+    You can either run the program via `sudo` or set the setuid bit:
+
+      sudo chown root:wheel #{bin}/htop
+      sudo chmod u+s #{bin}/htop
+
+    You should be certain that you trust any software you granting root privileges.
+    EOS
+  end
 end