(lispref.info)A Sample Variable Description

Prev: A Sample Function Description Up: Format of Descriptions

A Sample Variable Description

   A "variable" is a name that can hold a value.  Although any variable
can be set by the user, certain variables that exist specifically so
that users can change them are called "user options".  Ordinary
variables and user options are described using a format like that for
functions except that there are no arguments.

   Here is a description of the imaginary `electric-future-map'

 - Variable: electric-future-map
     The value of this variable is a full keymap used by electric
     command future mode.  The functions in this map will allow you to
     edit commands you have not yet thought about executing.

   User option descriptions have the same format, but `Variable' is
replaced by `User Option'.

automatically generated by info2www