zsh: Add documentation to window name feature.

diff --git a/zsh/rc b/zsh/rc
index 0370fb00d8ddf720ae4949e05551af5ce9f044b2..e6a27ef5f85aebf98494ee68361d5daf51531f7a 100644 (file)
--- a/zsh/rc
+++ b/zsh/rc
@@ -137,6 +137,10 @@ fi
 # It works with screen and xterm. If screen is running in X11 (DISPLAY is set)
 # and stumpwm is used (it's tested if stumpish is available) then the window
 # title is also set in stumpwm using stumpish.
+#
+# If a command is run with sudo or if the shell is running as root then a ! is
+# added at the beginning of the command to make this clear. If a command is
+# running on a different computer with ssh a @ is added at the beginning.
 if [[ $TERM == screen* || $TERM == xterm* ]]; then
     # Set to a non empty value to reset the window name in the next precmd()
     # call.