zshrc: some further tuning to make grml-gen-zshrefcard output nice

Author: mika

etc/zsh/zshrc

@@ -1773,15 +1773,15 @@ fi
 
 # do we have GNU ls with color-support?
 if [[ "$TERM" != dumb ]]; then
-    #a1# execute \kbd{@a@}:\quad ls with colors
+    #a1# List files with colors (\kbd{ls -b -CF \ldots})
     alias ls='ls -b -CF '${ls_options:+"${ls_options[*]}"}
-    #a1# execute \kbd{@a@}:\quad list all files, with colors
+    #a1# List all files, with colors (\kbd{ls -la \ldots})
     alias la='ls -la '${ls_options:+"${ls_options[*]}"}
-    #a1# long colored list, without dotfiles (@a@)
+    #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
     alias ll='ls -l '${ls_options:+"${ls_options[*]}"}
-    #a1# long colored list, human readable sizes (@a@)
+    #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
     alias lh='ls -hAl '${ls_options:+"${ls_options[*]}"}
-    #a1# List files, append qualifier to filenames \\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
+    #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -lF \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
     alias l='ls -lF '${ls_options:+"${ls_options[*]}"}
 else
     alias ls='ls -b -CF'
@@ -2365,7 +2365,7 @@ alias help-zshglob=H-Glob
 HELP_LINES_PER_PAGE=20
 #v1# set location of help-zle cache file
 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
-#f1# helper function for help-zle, actually generates the help text
+# helper function for help-zle, actually generates the help text
 help_zle_parse_keybindings()
 {
     emulate -L zsh
@@ -2466,7 +2466,7 @@ help_zle_parse_keybindings()
 typeset -g help_zle_sln
 typeset -g -a help_zle_lines
 
-#f1# Provides (partially autogenerated) help on keybindings and the zsh line editor
+# Provides (partially autogenerated) help on keybindings and the zsh line editor
 help-zle()
 {
     emulate -L zsh
@@ -2480,8 +2480,8 @@ help-zle()
     help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
     zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
 }
-#k# display help for keybindings and ZLE (cycle pages with consecutive use)
-zle -N help-zle && bindkey '^xz' help-zle
+#k# display help for keybindings and ZLE
+zle -N help-zle && bindkey '^xz' help-zle # note: cycle pages with consecutive use of '^xz'
 
 # grep for running process, like: 'any vim'
 any() {
@@ -2621,6 +2621,7 @@ alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
 
 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
+#a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
 
 # work around non utf8 capable software in utf environment via $LANG and luit