dot/xinitrc: Document the various terminal and Emacs size parameters.

diff --git a/dot/xinitrc b/dot/xinitrc
index 72afe36..9b4ab28 100755 (executable)
--- a/dot/xinitrc
+++ b/dot/xinitrc
@@ -210,6 +210,18 @@ emacs=$(pick_program emacs emacs23 emacs24 emacs22 emacs21 emacs)
 term=$(pick_program terminal pterm Eterm xterm)
 
 ## Emacs window measurements.
+##
+## e_colwd = basic width of a column in pixels
+## e_hextra = extra horizontal width in pixels
+##     Width of an N-column Emacs frame in pixels will be
+##     N*e_colwd + e_hextra
+## e_colchars = width of a column in Emacs `-geometry' units
+## e_cextra = extra horizontal width in Emacs `-geometry' units
+##     So an N-column frame should be reported to Emacs as being
+##     N*e_colchars + e_cextra geometry units wide
+## e_lineht = height of a character line in pixels
+## e_vextra = number of additional vertical cruft pixels
+##     So an N-line Emacs frame takes N*e_lineht + e_vextra pixels
 case "$emacs" in
   emacs21 | emacs)
     e_colwd=492 e_hextra=34
@@ -229,6 +241,10 @@ case "$emacs" in
 esac
 
 ## Terminal window measurements.
+##
+## t_wd = the window width, in pixels
+## t_lineht, t_vextra = height parameters: if the window is N lines high,
+##     then it will be N*t_lineht + t_vextra pixels high
 case "$term" in
   pterm) t_wd=504 t_lineht=13 t_vextra=23 geom=-geometry;;
   Eterm) t_wd=504 t_lineht=13 t_vextra=23 geom=-g;;