[Emacs-diffs] emacs/doc/lispref frames.texi

[Eli Zaretskii]

CVSROOT:        /cvsroot/emacs
Module name:    emacs
Changes by:     Eli Zaretskii <eliz>    09/01/17 18:43:24

Modified files:
        doc/lispref    : frames.texi 

Log message:
        (Terminal Parameters): Document `terminal-parameters', 
`terminal-parameter',
        and `set-terminal-parameter'.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/emacs/doc/lispref/frames.texi?cvsroot=emacs&r1=1.21&r2=1.22

Patches:
Index: frames.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/doc/lispref/frames.texi,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -b -r1.21 -r1.22
--- frames.texi 17 Jan 2009 16:31:21 -0000      1.21
+++ frames.texi 17 Jan 2009 18:43:24 -0000      1.22
@@ -1053,17 +1053,48 @@
 @section Terminal Parameters
 @cindex terminal parameters
 
-  This subsection describes how to read and change the parameter
-values of a terminal.
+  Each terminal has a list of associated parameters.  These
address@hidden parameters} are mostly a convenient way of storage for
+terminal-local variables, but some terminal parameters have a special
+meaning.
+
+  This section describes functions to read and change the parameter values
+of a terminal.  They all accept as their argument either a terminal or
+a frame; the latter means use that frame's terminal.  An argument of
address@hidden means the selected frame's terminal.
 
 @defun terminal-parameters &optional terminal
+This function returns an alist listing all the parameters of
address@hidden and their values.
 @end defun
 
 @defun terminal-parameter terminal parameter
+This function returns the value of the parameter @var{parameter} (a
+symbol) of @var{terminal}.  If @var{terminal} has no setting for
address@hidden, this function returns @code{nil}.
 @end defun
 
 @defun set-terminal-parameter terminal parameter value
address@hidden defun
+This function sets the parameter @var{parm} of @var{terminal} to the
+specified @var{value}, and returns the previous value of that
+parameter.
address@hidden defun
+
+Here's a list of a few terminal parameters that have a special
+meaning:
+
address@hidden @code
address@hidden background-mode
+The classification of the terminal's background color, either
address@hidden or @code{dark}.
address@hidden normal-erase-is-backspace
+Value is either 1 or 0, depending on whether
address@hidden is turned on or off on this
+terminal.  @xref{DEL Does Not Delete,,, emacs, The Emacs Manual}.
address@hidden terminal-initted
+After the terminal is initialized, this is set to the
+terminal-specific initialization function.
address@hidden table
 
 @node Frame Titles
 @section Frame Titles
@@ -1440,16 +1471,6 @@
 Emacs does provide events that you can use to keep track of such
 changes.  @xref{Misc Events}.
 
address@hidden suspend-frame
address@hidden defun
-
address@hidden FIXME: xref to suspend-emacs, and xref there.
address@hidden suspend-tty &optional tty
address@hidden defun
-
address@hidden resume-tty &optional tty
address@hidden defun
-
 @node Raising and Lowering
 @section Raising and Lowering Frames