zsh: Documentation updates for window name feature.

diff --git a/zsh/rc b/zsh/rc
index a8486a746e303a824dbb77f5223de3c14305561b..d101a3c22723da62d890215d1a61d86677873141 100644 (file)
--- a/zsh/rc
+++ b/zsh/rc
@@ -154,7 +154,7 @@ fi
 # running program.
 #
 # When a program is started preexec() sets the window's name to it; when it
-# stops precmd() resets the windows' name to 'zsh'.
+# stops precmd() resets the window's name to 'zsh'.
 #
 # It works with screen and xterm. If screen is running in X11 (DISPLAY is set)
 # and stumpwm is running then the window title is also set in stumpwm using
@@ -162,17 +162,18 @@ fi
 #
 # 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.
+# running on a different computer with ssh a @ is added at the beginning. This
+# only works if the .zshrc on the server also uses this command.
 if [[ $TERM == screen* || $TERM == xterm* ]]; then
-    # Set to a non empty value to reset the window name in the next precmd()
-    # call.
+    # Is set to a non empty value to reset the window name in the next
+    # precmd() call.
     window_reset=yes
-    # Set to a non empty value when the stump window manager is running.
+    # Is set to a non empty value when the stump window manager is running.
     ps aux | grep -q stumpwm | grep -v grep
     if [[ $? -eq 0 ]]; then
         window_stumpwm=yes
     fi
-    # Set to a non empty value when the shell is running as root.
+    # Is set to a non empty value when the shell is running as root.
     if [[ $(id -u) -eq 0 ]]; then
         window_root=yes
     fi
@@ -218,8 +219,8 @@ if [[ $TERM == screen* || $TERM == xterm* ]]; then
             program_name=!$program_name
         fi
 
-        # Add an at mark at the beginning if running ssh on a different
-        # computer.
+        # Add an at mark at the beginning if running through ssh on a
+        # different computer.
         if [[ -n $SSH_CONNECTION ]]; then
             program_name="@$program_name"
         fi