aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorPavel Janík2001-10-28 18:50:45 +0000
committerPavel Janík2001-10-28 18:50:45 +0000
commit4707d2d07995b52a096c85f874d69893dd86e774 (patch)
tree49f783cf4f673031d2c3101e44cad0bbdf6f85d4 /src
parent60b541d11562da4bdc6c691e621af6ddf1f4f6d1 (diff)
downloademacs-4707d2d07995b52a096c85f874d69893dd86e774.tar.gz
emacs-4707d2d07995b52a096c85f874d69893dd86e774.zip
Change doc-string comments to `new style' [w/`doc:' keyword].
Fix typos in comments.
Diffstat (limited to 'src')
-rw-r--r--src/ChangeLog4
-rw-r--r--src/keyboard.c738
2 files changed, 370 insertions, 372 deletions
diff --git a/src/ChangeLog b/src/ChangeLog
index cb6a27c6a4e..3e91f708bbc 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,5 +1,9 @@
12001-10-28 Pavel Jan,Bm(Bk <Pavel@Janik.cz> 12001-10-28 Pavel Jan,Bm(Bk <Pavel@Janik.cz>
2 2
3 * keyboard.c: Change doc-string comments to `new style' [w/`doc:'
4 keyword].
5 Fix typos in comments.
6
3 * emacs.c (bug_reporting_address): New function. 7 * emacs.c (bug_reporting_address): New function.
4 Use it when displaying usage message. 8 Use it when displaying usage message.
5 9
diff --git a/src/keyboard.c b/src/keyboard.c
index edeccde7fed..659a297b5a3 100644
--- a/src/keyboard.c
+++ b/src/keyboard.c
@@ -975,12 +975,12 @@ force_auto_save_soon ()
975} 975}
976 976
977DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "", 977DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
978 "Invoke the editor command loop recursively.\n\ 978 doc: /* Invoke the editor command loop recursively.
979To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\ 979To get out of the recursive edit, a command can do `(throw 'exit nil)';
980that tells this function to return.\n\ 980that tells this function to return.
981Alternately, `(throw 'exit t)' makes this function signal an error.\n\ 981Alternately, `(throw 'exit t)' makes this function signal an error.
982This function is called by the editor initialization to begin editing.") 982This function is called by the editor initialization to begin editing. */)
983 () 983 ()
984{ 984{
985 int count = specpdl_ptr - specpdl; 985 int count = specpdl_ptr - specpdl;
986 Lisp_Object buffer; 986 Lisp_Object buffer;
@@ -1266,8 +1266,8 @@ top_level_1 ()
1266} 1266}
1267 1267
1268DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "", 1268DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
1269 "Exit all recursive editing levels.") 1269 doc: /* Exit all recursive editing levels. */)
1270 () 1270 ()
1271{ 1271{
1272#ifdef HAVE_X_WINDOWS 1272#ifdef HAVE_X_WINDOWS
1273 if (display_hourglass_p) 1273 if (display_hourglass_p)
@@ -1277,8 +1277,8 @@ DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
1277} 1277}
1278 1278
1279DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "", 1279DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
1280 "Exit from the innermost recursive edit or minibuffer.") 1280 doc: /* Exit from the innermost recursive edit or minibuffer. */)
1281 () 1281 ()
1282{ 1282{
1283 if (command_loop_level > 0 || minibuf_level > 0) 1283 if (command_loop_level > 0 || minibuf_level > 0)
1284 Fthrow (Qexit, Qnil); 1284 Fthrow (Qexit, Qnil);
@@ -1288,8 +1288,8 @@ DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0,
1288} 1288}
1289 1289
1290DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "", 1290DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
1291 "Abort the command that requested this recursive edit or minibuffer input.") 1291 doc: /* Abort the command that requested this recursive edit or minibuffer input. */)
1292 () 1292 ()
1293{ 1293{
1294 if (command_loop_level > 0 || minibuf_level > 0) 1294 if (command_loop_level > 0 || minibuf_level > 0)
1295 Fthrow (Qexit, Qt); 1295 Fthrow (Qexit, Qt);
@@ -3110,12 +3110,12 @@ tracking_off (old_value)
3110} 3110}
3111 3111
3112DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0, 3112DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
3113 "Evaluate BODY with mouse movement events enabled.\n\ 3113 doc: /* Evaluate BODY with mouse movement events enabled.
3114Within a `track-mouse' form, mouse motion generates input events that\n\ 3114Within a `track-mouse' form, mouse motion generates input events that
3115you can read with `read-event'.\n\ 3115you can read with `read-event'.
3116Normally, mouse motion is ignored.\n\ 3116Normally, mouse motion is ignored.
3117usage: (track-mouse BODY ...)") 3117usage: (track-mouse BODY ...) */)
3118 (args) 3118 (args)
3119 Lisp_Object args; 3119 Lisp_Object args;
3120{ 3120{
3121 int count = specpdl_ptr - specpdl; 3121 int count = specpdl_ptr - specpdl;
@@ -5864,13 +5864,13 @@ modify_event_symbol (symbol_num, modifiers, symbol_kind, name_alist_or_stem,
5864 event type as a number or a symbol. */ 5864 event type as a number or a symbol. */
5865 5865
5866DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0, 5866DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
5867 "Convert the event description list EVENT-DESC to an event type.\n\ 5867 doc: /* Convert the event description list EVENT-DESC to an event type.
5868EVENT-DESC should contain one base event type (a character or symbol)\n\ 5868EVENT-DESC should contain one base event type (a character or symbol)
5869and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\ 5869and zero or more modifier names (control, meta, hyper, super, shift, alt,
5870drag, down, double or triple). The base must be last.\n\ 5870drag, down, double or triple). The base must be last.
5871The return value is an event type (a character or symbol) which\n\ 5871The return value is an event type (a character or symbol) which
5872has the same base event type and all the specified modifiers.") 5872has the same base event type and all the specified modifiers. */)
5873 (event_desc) 5873 (event_desc)
5874 Lisp_Object event_desc; 5874 Lisp_Object event_desc;
5875{ 5875{
5876 Lisp_Object base; 5876 Lisp_Object base;
@@ -8977,60 +8977,53 @@ read_key_sequence (keybuf, bufsize, prompt, dont_downcase_last,
8977 return t; 8977 return t;
8978} 8978}
8979 8979
8980#if 0 /* This doc string is too long for some compilers.
8981 This commented-out definition serves for DOC. */
8982DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 4, 0,
8983 "Read a sequence of keystrokes and return as a string or vector.\n\
8984The sequence is sufficient to specify a non-prefix command in the\n\
8985current local and global maps.\n\
8986\n\
8987First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
8988Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
8989as a continuation of the previous key.\n\
8990\n\
8991The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
8992convert the last event to lower case. (Normally any upper case event\n\
8993is converted to lower case if the original event is undefined and the lower\n\
8994case equivalent is defined.) A non-nil value is appropriate for reading\n\
8995a key sequence to be defined.\n\
8996\n\
8997A C-g typed while in this function is treated like any other character,\n\
8998and `quit-flag' is not set.\n\
8999\n\
9000If the key sequence starts with a mouse click, then the sequence is read\n\
9001using the keymaps of the buffer of the window clicked in, not the buffer\n\
9002of the selected window as normal.\n\
9003""\n\
9004`read-key-sequence' drops unbound button-down events, since you normally\n\
9005only care about the click or drag events which follow them. If a drag\n\
9006or multi-click event is unbound, but the corresponding click event would\n\
9007be bound, `read-key-sequence' turns the event into a click event at the\n\
9008drag's starting position. This means that you don't have to distinguish\n\
9009between click and drag, double, or triple events unless you want to.\n\
9010\n\
9011`read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
9012lines separating windows, and scroll bars with imaginary keys\n\
9013`mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
9014\n\
9015Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
9016function will process a switch-frame event if the user switches frames\n\
9017before typing anything. If the user switches frames in the middle of a\n\
9018key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
9019is nil, then the event will be put off until after the current key sequence.\n\
9020\n\
9021`read-key-sequence' checks `function-key-map' for function key\n\
9022sequences, where they wouldn't conflict with ordinary bindings. See\n\
9023`function-key-map' for more details.\n\
9024\n\
9025The optional fifth argument COMMAND-LOOP, if non-nil, means\n\
9026that this key sequence is being read by something that will\n\
9027read commands one after another. It should be nil if the caller\n\
9028will read just one key sequence.")
9029 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame, command-loop)
9030#endif
9031
9032DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0, 8980DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
9033 0) 8981 doc: /* Read a sequence of keystrokes and return as a string or vector.
8982The sequence is sufficient to specify a non-prefix command in the
8983current local and global maps.
8984
8985First arg PROMPT is a prompt string. If nil, do not prompt specially.
8986Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
8987as a continuation of the previous key.
8988
8989The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
8990convert the last event to lower case. (Normally any upper case event
8991is converted to lower case if the original event is undefined and the lower
8992case equivalent is defined.) A non-nil value is appropriate for reading
8993a key sequence to be defined.
8994
8995A C-g typed while in this function is treated like any other character,
8996and `quit-flag' is not set.
8997
8998If the key sequence starts with a mouse click, then the sequence is read
8999using the keymaps of the buffer of the window clicked in, not the buffer
9000of the selected window as normal.
9001
9002`read-key-sequence' drops unbound button-down events, since you normally
9003only care about the click or drag events which follow them. If a drag
9004or multi-click event is unbound, but the corresponding click event would
9005be bound, `read-key-sequence' turns the event into a click event at the
9006drag's starting position. This means that you don't have to distinguish
9007between click and drag, double, or triple events unless you want to.
9008
9009`read-key-sequence' prefixes mouse events on mode lines, the vertical
9010lines separating windows, and scroll bars with imaginary keys
9011`mode-line', `vertical-line', and `vertical-scroll-bar'.
9012
9013Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9014function will process a switch-frame event if the user switches frames
9015before typing anything. If the user switches frames in the middle of a
9016key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9017is nil, then the event will be put off until after the current key sequence.
9018
9019`read-key-sequence' checks `function-key-map' for function key
9020sequences, where they wouldn't conflict with ordinary bindings. See
9021`function-key-map' for more details.
9022
9023The optional fifth argument COMMAND-LOOP, if non-nil, means
9024that this key sequence is being read by something that will
9025read commands one after another. It should be nil if the caller
9026will read just one key sequence. */)
9034 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame, 9027 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9035 command_loop) 9028 command_loop)
9036 Lisp_Object prompt, continue_echo, dont_downcase_last; 9029 Lisp_Object prompt, continue_echo, dont_downcase_last;
@@ -9089,9 +9082,9 @@ DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
9089 9082
9090DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector, 9083DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
9091 Sread_key_sequence_vector, 1, 5, 0, 9084 Sread_key_sequence_vector, 1, 5, 0,
9092 "Like `read-key-sequence' but always return a vector.") 9085 doc: /* Like `read-key-sequence' but always return a vector. */)
9093 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame, 9086 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9094 command_loop) 9087 command_loop)
9095 Lisp_Object prompt, continue_echo, dont_downcase_last; 9088 Lisp_Object prompt, continue_echo, dont_downcase_last;
9096 Lisp_Object can_return_switch_frame, command_loop; 9089 Lisp_Object can_return_switch_frame, command_loop;
9097{ 9090{
@@ -9143,15 +9136,15 @@ DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
9143} 9136}
9144 9137
9145DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0, 9138DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
9146 "Execute CMD as an editor command.\n\ 9139 doc: /* Execute CMD as an editor command.
9147CMD must be a symbol that satisfies the `commandp' predicate.\n\ 9140CMD must be a symbol that satisfies the `commandp' predicate.
9148Optional second arg RECORD-FLAG non-nil\n\ 9141Optional second arg RECORD-FLAG non-nil
9149means unconditionally put this command in `command-history'.\n\ 9142means unconditionally put this command in `command-history'.
9150Otherwise, that is done only if an arg is read using the minibuffer.\n\ 9143Otherwise, that is done only if an arg is read using the minibuffer.
9151The argument KEYS specifies the value to use instead of (this-command-keys)\n\ 9144The argument KEYS specifies the value to use instead of (this-command-keys)
9152when reading the arguments; if it is nil, (this-command-keys) is used.\n\ 9145when reading the arguments; if it is nil, (this-command-keys) is used.
9153The argument SPECIAL, if non-nil, means that this command is executing\n\ 9146The argument SPECIAL, if non-nil, means that this command is executing
9154a special event, so ignore the prefix argument and don't clear it.") 9147a special event, so ignore the prefix argument and don't clear it. */)
9155 (cmd, record_flag, keys, special) 9148 (cmd, record_flag, keys, special)
9156 Lisp_Object cmd, record_flag, keys, special; 9149 Lisp_Object cmd, record_flag, keys, special;
9157{ 9150{
@@ -9243,9 +9236,9 @@ a special event, so ignore the prefix argument and don't clear it.")
9243 9236
9244 9237
9245DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command, 9238DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
9246 1, 1, "P", 9239 1, 1, "P",
9247 "Read function name, then read its arguments and call it.") 9240 doc: /* Read function name, then read its arguments and call it. */)
9248 (prefixarg) 9241 (prefixarg)
9249 Lisp_Object prefixarg; 9242 Lisp_Object prefixarg;
9250{ 9243{
9251 Lisp_Object function; 9244 Lisp_Object function;
@@ -9496,9 +9489,9 @@ requeued_events_pending_p ()
9496 9489
9497 9490
9498DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0, 9491DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
9499 "T if command input is currently available with no waiting.\n\ 9492 doc: /* T if command input is currently available with no waiting.
9500Actually, the value is nil only if we can be sure that no input is available.") 9493Actually, the value is nil only if we can be sure that no input is available. */)
9501 () 9494 ()
9502{ 9495{
9503 if (!NILP (Vunread_command_events) || unread_command_char != -1) 9496 if (!NILP (Vunread_command_events) || unread_command_char != -1)
9504 return (Qt); 9497 return (Qt);
@@ -9508,8 +9501,8 @@ Actually, the value is nil only if we can be sure that no input is available.")
9508} 9501}
9509 9502
9510DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0, 9503DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
9511 "Return vector of last 100 events, not counting those from keyboard macros.") 9504 doc: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9512 () 9505 ()
9513{ 9506{
9514 Lisp_Object *keys = XVECTOR (recent_keys)->contents; 9507 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
9515 Lisp_Object val; 9508 Lisp_Object val;
@@ -9530,17 +9523,17 @@ DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
9530} 9523}
9531 9524
9532DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0, 9525DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
9533 "Return the key sequence that invoked this command.\n\ 9526 doc: /* Return the key sequence that invoked this command.
9534The value is a string or a vector.") 9527The value is a string or a vector. */)
9535 () 9528 ()
9536{ 9529{
9537 return make_event_array (this_command_key_count, 9530 return make_event_array (this_command_key_count,
9538 XVECTOR (this_command_keys)->contents); 9531 XVECTOR (this_command_keys)->contents);
9539} 9532}
9540 9533
9541DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0, 9534DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
9542 "Return the key sequence that invoked this command, as a vector.") 9535 doc: /* Return the key sequence that invoked this command, as a vector. */)
9543 () 9536 ()
9544{ 9537{
9545 return Fvector (this_command_key_count, 9538 return Fvector (this_command_key_count,
9546 XVECTOR (this_command_keys)->contents); 9539 XVECTOR (this_command_keys)->contents);
@@ -9548,11 +9541,11 @@ DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys
9548 9541
9549DEFUN ("this-single-command-keys", Fthis_single_command_keys, 9542DEFUN ("this-single-command-keys", Fthis_single_command_keys,
9550 Sthis_single_command_keys, 0, 0, 0, 9543 Sthis_single_command_keys, 0, 0, 0,
9551 "Return the key sequence that invoked this command.\n\ 9544 doc: /* Return the key sequence that invoked this command.
9552Unlike `this-command-keys', this function's value\n\ 9545Unlike `this-command-keys', this function's value
9553does not include prefix arguments.\n\ 9546does not include prefix arguments.
9554The value is always a vector.") 9547The value is always a vector. */)
9555 () 9548 ()
9556{ 9549{
9557 return Fvector (this_command_key_count 9550 return Fvector (this_command_key_count
9558 - this_single_command_key_start, 9551 - this_single_command_key_start,
@@ -9562,30 +9555,30 @@ The value is always a vector.")
9562 9555
9563DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys, 9556DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
9564 Sthis_single_command_raw_keys, 0, 0, 0, 9557 Sthis_single_command_raw_keys, 0, 0, 0,
9565 "Return the raw events that were read for this command.\n\ 9558 doc: /* Return the raw events that were read for this command.
9566Unlike `this-single-command-keys', this function's value\n\ 9559Unlike `this-single-command-keys', this function's value
9567shows the events before all translations (except for input methods).\n\ 9560shows the events before all translations (except for input methods).
9568The value is always a vector.") 9561The value is always a vector. */)
9569 () 9562 ()
9570{ 9563{
9571 return Fvector (raw_keybuf_count, 9564 return Fvector (raw_keybuf_count,
9572 (XVECTOR (raw_keybuf)->contents)); 9565 (XVECTOR (raw_keybuf)->contents));
9573} 9566}
9574 9567
9575DEFUN ("reset-this-command-lengths", Freset_this_command_lengths, 9568DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
9576 Sreset_this_command_lengths, 0, 0, 0, 9569 Sreset_this_command_lengths, 0, 0, 0,
9577 "Used for complicated reasons in `universal-argument-other-key'.\n\ 9570 doc: /* Used for complicated reasons in `universal-argument-other-key'.
9578\n\ 9571
9579`universal-argument-other-key' rereads the event just typed.\n\ 9572`universal-argument-other-key' rereads the event just typed.
9580It then gets translated through `function-key-map'.\n\ 9573It then gets translated through `function-key-map'.
9581The translated event gets included in the echo area and in\n\ 9574The translated event gets included in the echo area and in
9582the value of `this-command-keys' in addition to the raw original event.\n\ 9575the value of `this-command-keys' in addition to the raw original event.
9583That is not right.\n\ 9576That is not right.
9584\n\ 9577
9585Calling this function directs the translated event to replace\n\ 9578Calling this function directs the translated event to replace
9586the original event, so that only one version of the event actually\n\ 9579the original event, so that only one version of the event actually
9587appears in the echo area and in the value of `this-command-keys.'.") 9580appears in the echo area and in the value of `this-command-keys'. */)
9588 () 9581 ()
9589{ 9582{
9590 before_command_restore_flag = 1; 9583 before_command_restore_flag = 1;
9591 before_command_key_count_1 = before_command_key_count; 9584 before_command_key_count_1 = before_command_key_count;
@@ -9594,10 +9587,10 @@ appears in the echo area and in the value of `this-command-keys.'.")
9594} 9587}
9595 9588
9596DEFUN ("clear-this-command-keys", Fclear_this_command_keys, 9589DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
9597 Sclear_this_command_keys, 0, 0, 0, 9590 Sclear_this_command_keys, 0, 0, 0,
9598 "Clear out the vector that `this-command-keys' returns.\n\ 9591 doc: /* Clear out the vector that `this-command-keys' returns.
9599Clear vector containing last 100 events.") 9592Clear vector containing last 100 events. */)
9600 () 9593 ()
9601{ 9594{
9602 int i; 9595 int i;
9603 9596
@@ -9611,8 +9604,8 @@ Clear vector containing last 100 events.")
9611} 9604}
9612 9605
9613DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0, 9606DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
9614 "Return the current depth in recursive edits.") 9607 doc: /* Return the current depth in recursive edits. */)
9615 () 9608 ()
9616{ 9609{
9617 Lisp_Object temp; 9610 Lisp_Object temp;
9618 XSETFASTINT (temp, command_loop_level + minibuf_level); 9611 XSETFASTINT (temp, command_loop_level + minibuf_level);
@@ -9620,10 +9613,10 @@ DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
9620} 9613}
9621 9614
9622DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1, 9615DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
9623 "FOpen dribble file: ", 9616 "FOpen dribble file: ",
9624 "Start writing all keyboard characters to a dribble file called FILE.\n\ 9617 doc: /* Start writing all keyboard characters to a dribble file called FILE.
9625If FILE is nil, close any open dribble file.") 9618If FILE is nil, close any open dribble file. */)
9626 (file) 9619 (file)
9627 Lisp_Object file; 9620 Lisp_Object file;
9628{ 9621{
9629 if (dribble) 9622 if (dribble)
@@ -9642,9 +9635,9 @@ If FILE is nil, close any open dribble file.")
9642} 9635}
9643 9636
9644DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0, 9637DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
9645 "Discard the contents of the terminal input buffer.\n\ 9638 doc: /* Discard the contents of the terminal input buffer.
9646Also cancel any kbd macro being defined.") 9639Also cancel any kbd macro being defined. */)
9647 () 9640 ()
9648{ 9641{
9649 current_kboard->defining_kbd_macro = Qnil; 9642 current_kboard->defining_kbd_macro = Qnil;
9650 update_mode_lines++; 9643 update_mode_lines++;
@@ -9662,18 +9655,19 @@ Also cancel any kbd macro being defined.")
9662} 9655}
9663 9656
9664DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "", 9657DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
9665 "Stop Emacs and return to superior process. You can resume later.\n\ 9658 doc: /* Stop Emacs and return to superior process. You can resume later.
9666If `cannot-suspend' is non-nil, or if the system doesn't support job\n\ 9659If `cannot-suspend' is non-nil, or if the system doesn't support job
9667control, run a subshell instead.\n\n\ 9660control, run a subshell instead.
9668If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\ 9661
9669to be read as terminal input by Emacs's parent, after suspension.\n\ 9662If optional arg STUFFSTRING is non-nil, its characters are stuffed
9670\n\ 9663to be read as terminal input by Emacs's parent, after suspension.
9671Before suspending, run the normal hook `suspend-hook'.\n\ 9664
9672After resumption run the normal hook `suspend-resume-hook'.\n\ 9665Before suspending, run the normal hook `suspend-hook'.
9673\n\ 9666After resumption run the normal hook `suspend-resume-hook'.
9674Some operating systems cannot stop the Emacs process and resume it later.\n\ 9667
9675On such systems, Emacs starts a subshell instead of suspending.") 9668Some operating systems cannot stop the Emacs process and resume it later.
9676 (stuffstring) 9669On such systems, Emacs starts a subshell instead of suspending. */)
9670 (stuffstring)
9677 Lisp_Object stuffstring; 9671 Lisp_Object stuffstring;
9678{ 9672{
9679 int count = specpdl_ptr - specpdl; 9673 int count = specpdl_ptr - specpdl;
@@ -9972,17 +9966,17 @@ quit_throw_to_read_char ()
9972} 9966}
9973 9967
9974DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0, 9968DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
9975 "Set mode of reading keyboard input.\n\ 9969 doc: /* Set mode of reading keyboard input.
9976First arg INTERRUPT non-nil means use input interrupts;\n\ 9970First arg INTERRUPT non-nil means use input interrupts;
9977 nil means use CBREAK mode.\n\ 9971 nil means use CBREAK mode.
9978Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\ 9972Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
9979 (no effect except in CBREAK mode).\n\ 9973 (no effect except in CBREAK mode).
9980Third arg META t means accept 8-bit input (for a Meta key).\n\ 9974Third arg META t means accept 8-bit input (for a Meta key).
9981 META nil means ignore the top bit, on the assumption it is parity.\n\ 9975 META nil means ignore the top bit, on the assumption it is parity.
9982 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\ 9976 Otherwise, accept 8-bit input and don't use the top bit for Meta.
9983Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\ 9977Optional fourth arg QUIT if non-nil specifies character to use for quitting.
9984See also `current-input-mode'.") 9978See also `current-input-mode'. */)
9985 (interrupt, flow, meta, quit) 9979 (interrupt, flow, meta, quit)
9986 Lisp_Object interrupt, flow, meta, quit; 9980 Lisp_Object interrupt, flow, meta, quit;
9987{ 9981{
9988 if (!NILP (quit) 9982 if (!NILP (quit)
@@ -10044,20 +10038,20 @@ See also `current-input-mode'.")
10044} 10038}
10045 10039
10046DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0, 10040DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
10047 "Return information about the way Emacs currently reads keyboard input.\n\ 10041 doc: /* Return information about the way Emacs currently reads keyboard input.
10048The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\ 10042The value is a list of the form (INTERRUPT FLOW META QUIT), where
10049 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\ 10043 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10050 nil, Emacs is using CBREAK mode.\n\ 10044 nil, Emacs is using CBREAK mode.
10051 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\ 10045 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10052 terminal; this does not apply if Emacs uses interrupt-driven input.\n\ 10046 terminal; this does not apply if Emacs uses interrupt-driven input.
10053 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\ 10047 META is t if accepting 8-bit input with 8th bit as Meta flag.
10054 META nil means ignoring the top bit, on the assumption it is parity.\n\ 10048 META nil means ignoring the top bit, on the assumption it is parity.
10055 META is neither t nor nil if accepting 8-bit input and using\n\ 10049 META is neither t nor nil if accepting 8-bit input and using
10056 all 8 bits as the character code.\n\ 10050 all 8 bits as the character code.
10057 QUIT is the character Emacs currently uses to quit.\n\ 10051 QUIT is the character Emacs currently uses to quit.
10058The elements of this list correspond to the arguments of\n\ 10052The elements of this list correspond to the arguments of
10059`set-input-mode'.") 10053`set-input-mode'. */)
10060 () 10054 ()
10061{ 10055{
10062 Lisp_Object val[4]; 10056 Lisp_Object val[4];
10063 10057
@@ -10492,377 +10486,377 @@ syms_of_keyboard ()
10492 defsubr (&Sexecute_extended_command); 10486 defsubr (&Sexecute_extended_command);
10493 10487
10494 DEFVAR_LISP ("last-command-char", &last_command_char, 10488 DEFVAR_LISP ("last-command-char", &last_command_char,
10495 "Last input event that was part of a command."); 10489 doc: /* Last input event that was part of a command. */);
10496 10490
10497 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char, 10491 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char,
10498 "Last input event that was part of a command."); 10492 doc: /* Last input event that was part of a command. */);
10499 10493
10500 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event, 10494 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event,
10501 "Last input event in a command, except for mouse menu events.\n\ 10495 doc: /* Last input event in a command, except for mouse menu events.
10502Mouse menus give back keys that don't look like mouse events;\n\ 10496Mouse menus give back keys that don't look like mouse events;
10503this variable holds the actual mouse event that led to the menu,\n\ 10497this variable holds the actual mouse event that led to the menu,
10504so that you can determine whether the command was run by mouse or not."); 10498so that you can determine whether the command was run by mouse or not. */);
10505 10499
10506 DEFVAR_LISP ("last-input-char", &last_input_char, 10500 DEFVAR_LISP ("last-input-char", &last_input_char,
10507 "Last input event."); 10501 doc: /* Last input character. */);
10508 10502
10509 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char, 10503 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char,
10510 "Last input event."); 10504 doc: /* Last input event. */);
10511 10505
10512 DEFVAR_LISP ("unread-command-events", &Vunread_command_events, 10506 DEFVAR_LISP ("unread-command-events", &Vunread_command_events,
10513 "List of events to be read as the command input.\n\ 10507 doc: /* List of events to be read as the command input.
10514These events are processed first, before actual keyboard input."); 10508These events are processed first, before actual keyboard input. */);
10515 Vunread_command_events = Qnil; 10509 Vunread_command_events = Qnil;
10516 10510
10517 DEFVAR_INT ("unread-command-char", &unread_command_char, 10511 DEFVAR_INT ("unread-command-char", &unread_command_char,
10518 "If not -1, an object to be read as next command input event."); 10512 doc: /* If not -1, an object to be read as next command input event. */);
10519 10513
10520 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events, 10514 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events,
10521 "List of events to be processed as input by input methods.\n\ 10515 doc: /* List of events to be processed as input by input methods.
10522These events are processed after `unread-command-events', but\n\ 10516These events are processed after `unread-command-events', but
10523before actual keyboard input."); 10517before actual keyboard input. */);
10524 Vunread_post_input_method_events = Qnil; 10518 Vunread_post_input_method_events = Qnil;
10525 10519
10526 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events, 10520 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events,
10527 "List of events to be processed as input by input methods.\n\ 10521 doc: /* List of events to be processed as input by input methods.
10528These events are processed after `unread-command-events', but\n\ 10522These events are processed after `unread-command-events', but
10529before actual keyboard input."); 10523before actual keyboard input. */);
10530 Vunread_input_method_events = Qnil; 10524 Vunread_input_method_events = Qnil;
10531 10525
10532 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char, 10526 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char,
10533 "Meta-prefix character code.\n\ 10527 doc: /* Meta-prefix character code.
10534Meta-foo as command input turns into this character followed by foo."); 10528Meta-foo as command input turns into this character followed by foo. */);
10535 XSETINT (meta_prefix_char, 033); 10529 XSETINT (meta_prefix_char, 033);
10536 10530
10537 DEFVAR_KBOARD ("last-command", Vlast_command, 10531 DEFVAR_KBOARD ("last-command", Vlast_command,
10538 "The last command executed.\n\ 10532 doc: /* The last command executed.
10539Normally a symbol with a function definition, but can be whatever was found\n\ 10533Normally a symbol with a function definition, but can be whatever was found
10540in the keymap, or whatever the variable `this-command' was set to by that\n\ 10534in the keymap, or whatever the variable `this-command' was set to by that
10541command.\n\ 10535command.
10542\n\ 10536
10543The value `mode-exit' is special; it means that the previous command\n\ 10537The value `mode-exit' is special; it means that the previous command
10544read an event that told it to exit, and it did so and unread that event.\n\ 10538read an event that told it to exit, and it did so and unread that event.
10545In other words, the present command is the event that made the previous\n\ 10539In other words, the present command is the event that made the previous
10546command exit.\n\ 10540command exit.
10547\n\ 10541
10548The value `kill-region' is special; it means that the previous command\n\ 10542The value `kill-region' is special; it means that the previous command
10549was a kill command."); 10543was a kill command. */);
10550 10544
10551 DEFVAR_KBOARD ("real-last-command", Vreal_last_command, 10545 DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
10552 "Same as `last-command', but never altered by Lisp code."); 10546 doc: /* Same as `last-command', but never altered by Lisp code. */);
10553 10547
10554 DEFVAR_LISP ("this-command", &Vthis_command, 10548 DEFVAR_LISP ("this-command", &Vthis_command,
10555 "The command now being executed.\n\ 10549 doc: /* The command now being executed.
10556The command can set this variable; whatever is put here\n\ 10550The command can set this variable; whatever is put here
10557will be in `last-command' during the following command."); 10551will be in `last-command' during the following command. */);
10558 Vthis_command = Qnil; 10552 Vthis_command = Qnil;
10559 10553
10560 DEFVAR_INT ("auto-save-interval", &auto_save_interval, 10554 DEFVAR_INT ("auto-save-interval", &auto_save_interval,
10561 "*Number of input events between auto-saves.\n\ 10555 doc: /* *Number of input events between auto-saves.
10562Zero means disable autosaving due to number of characters typed."); 10556Zero means disable autosaving due to number of characters typed. */);
10563 auto_save_interval = 300; 10557 auto_save_interval = 300;
10564 10558
10565 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout, 10559 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout,
10566 "*Number of seconds idle time before auto-save.\n\ 10560 doc: /* *Number of seconds idle time before auto-save.
10567Zero or nil means disable auto-saving due to idleness.\n\ 10561Zero or nil means disable auto-saving due to idleness.
10568After auto-saving due to this many seconds of idle time,\n\ 10562After auto-saving due to this many seconds of idle time,
10569Emacs also does a garbage collection if that seems to be warranted."); 10563Emacs also does a garbage collection if that seems to be warranted. */);
10570 XSETFASTINT (Vauto_save_timeout, 30); 10564 XSETFASTINT (Vauto_save_timeout, 30);
10571 10565
10572 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes, 10566 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes,
10573 "*Nonzero means echo unfinished commands after this many seconds of pause.\n\ 10567 doc: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10574The value may be integer or floating point."); 10568The value may be integer or floating point. */);
10575 Vecho_keystrokes = make_number (1); 10569 Vecho_keystrokes = make_number (1);
10576 10570
10577 DEFVAR_INT ("polling-period", &polling_period, 10571 DEFVAR_INT ("polling-period", &polling_period,
10578 "*Interval between polling for input during Lisp execution.\n\ 10572 doc: /* *Interval between polling for input during Lisp execution.
10579The reason for polling is to make C-g work to stop a running program.\n\ 10573The reason for polling is to make C-g work to stop a running program.
10580Polling is needed only when using X windows and SIGIO does not work.\n\ 10574Polling is needed only when using X windows and SIGIO does not work.
10581Polling is automatically disabled in all other cases."); 10575Polling is automatically disabled in all other cases. */);
10582 polling_period = 2; 10576 polling_period = 2;
10583 10577
10584 DEFVAR_LISP ("double-click-time", &Vdouble_click_time, 10578 DEFVAR_LISP ("double-click-time", &Vdouble_click_time,
10585 "*Maximum time between mouse clicks to make a double-click.\n\ 10579 doc: /* *Maximum time between mouse clicks to make a double-click.
10586Measured in milliseconds. nil means disable double-click recognition;\n\ 10580Measured in milliseconds. nil means disable double-click recognition;
10587t means double-clicks have no time limit and are detected\n\ 10581t means double-clicks have no time limit and are detected
10588by position only."); 10582by position only. */);
10589 Vdouble_click_time = make_number (500); 10583 Vdouble_click_time = make_number (500);
10590 10584
10591 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz, 10585 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz,
10592 "*Maximum mouse movement between clicks to make a double-click.\n\ 10586 doc: /* *Maximum mouse movement between clicks to make a double-click.
10593On window-system frames, value is the number of pixels the mouse may have\n\ 10587On window-system frames, value is the number of pixels the mouse may have
10594moved horizontally or vertically between two clicks to make a double-click.\n\ 10588moved horizontally or vertically between two clicks to make a double-click.
10595On non window-system frames, value is interpreted in units of 1/8 characters\n\ 10589On non window-system frames, value is interpreted in units of 1/8 characters
10596instead of pixels."); 10590instead of pixels. */);
10597 double_click_fuzz = 3; 10591 double_click_fuzz = 3;
10598 10592
10599 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus, 10593 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus,
10600 "*Non-nil means inhibit local map menu bar menus."); 10594 doc: /* *Non-nil means inhibit local map menu bar menus. */);
10601 inhibit_local_menu_bar_menus = 0; 10595 inhibit_local_menu_bar_menus = 0;
10602 10596
10603 DEFVAR_INT ("num-input-keys", &num_input_keys, 10597 DEFVAR_INT ("num-input-keys", &num_input_keys,
10604 "Number of complete key sequences read as input so far.\n\ 10598 doc: /* Number of complete key sequences read as input so far.
10605This includes key sequences read from keyboard macros.\n\ 10599This includes key sequences read from keyboard macros.
10606The number is effectively the number of interactive command invocations."); 10600The number is effectively the number of interactive command invocations. */);
10607 num_input_keys = 0; 10601 num_input_keys = 0;
10608 10602
10609 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events, 10603 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events,
10610 "Number of input events read from the keyboard so far.\n\ 10604 doc: /* Number of input events read from the keyboard so far.
10611This does not include events generated by keyboard macros."); 10605This does not include events generated by keyboard macros. */);
10612 num_nonmacro_input_events = 0; 10606 num_nonmacro_input_events = 0;
10613 10607
10614 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame, 10608 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame,
10615 "The frame in which the most recently read event occurred.\n\ 10609 doc: /* The frame in which the most recently read event occurred.
10616If the last event came from a keyboard macro, this is set to `macro'."); 10610If the last event came from a keyboard macro, this is set to `macro'. */);
10617 Vlast_event_frame = Qnil; 10611 Vlast_event_frame = Qnil;
10618 10612
10619 /* This variable is set up in sysdep.c. */ 10613 /* This variable is set up in sysdep.c. */
10620 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char, 10614 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char,
10621 "The ERASE character as set by the user with stty."); 10615 doc: /* The ERASE character as set by the user with stty. */);
10622 10616
10623 DEFVAR_LISP ("help-char", &Vhelp_char, 10617 DEFVAR_LISP ("help-char", &Vhelp_char,
10624 "Character to recognize as meaning Help.\n\ 10618 doc: /* Character to recognize as meaning Help.
10625When it is read, do `(eval help-form)', and display result if it's a string.\n\ 10619When it is read, do `(eval help-form)', and display result if it's a string.
10626If the value of `help-form' is nil, this char can be read normally."); 10620If the value of `help-form' is nil, this char can be read normally. */);
10627 XSETINT (Vhelp_char, Ctl ('H')); 10621 XSETINT (Vhelp_char, Ctl ('H'));
10628 10622
10629 DEFVAR_LISP ("help-event-list", &Vhelp_event_list, 10623 DEFVAR_LISP ("help-event-list", &Vhelp_event_list,
10630 "List of input events to recognize as meaning Help.\n\ 10624 doc: /* List of input events to recognize as meaning Help.
10631These work just like the value of `help-char' (see that)."); 10625These work just like the value of `help-char' (see that). */);
10632 Vhelp_event_list = Qnil; 10626 Vhelp_event_list = Qnil;
10633 10627
10634 DEFVAR_LISP ("help-form", &Vhelp_form, 10628 DEFVAR_LISP ("help-form", &Vhelp_form,
10635 "Form to execute when character `help-char' is read.\n\ 10629 doc: /* Form to execute when character `help-char' is read.
10636If the form returns a string, that string is displayed.\n\ 10630If the form returns a string, that string is displayed.
10637If `help-form' is nil, the help char is not recognized."); 10631If `help-form' is nil, the help char is not recognized. */);
10638 Vhelp_form = Qnil; 10632 Vhelp_form = Qnil;
10639 10633
10640 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command, 10634 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command,
10641 "Command to run when `help-char' character follows a prefix key.\n\ 10635 doc: /* Command to run when `help-char' character follows a prefix key.
10642This command is used only when there is no actual binding\n\ 10636This command is used only when there is no actual binding
10643for that character after that prefix key."); 10637for that character after that prefix key. */);
10644 Vprefix_help_command = Qnil; 10638 Vprefix_help_command = Qnil;
10645 10639
10646 DEFVAR_LISP ("top-level", &Vtop_level, 10640 DEFVAR_LISP ("top-level", &Vtop_level,
10647 "Form to evaluate when Emacs starts up.\n\ 10641 doc: /* Form to evaluate when Emacs starts up.
10648Useful to set before you dump a modified Emacs."); 10642Useful to set before you dump a modified Emacs. */);
10649 Vtop_level = Qnil; 10643 Vtop_level = Qnil;
10650 10644
10651 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table, 10645 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table,
10652 "Translate table for keyboard input, or nil.\n\ 10646 doc: /* Translate table for keyboard input, or nil.
10653Each character is looked up in this string and the contents used instead.\n\ 10647Each character is looked up in this string and the contents used instead.
10654The value may be a string, a vector, or a char-table.\n\ 10648The value may be a string, a vector, or a char-table.
10655If it is a string or vector of length N,\n\ 10649If it is a string or vector of length N,
10656character codes N and up are untranslated.\n\ 10650character codes N and up are untranslated.
10657In a vector or a char-table, an element which is nil means \"no translation\"."); 10651In a vector or a char-table, an element which is nil means "no translation". */);
10658 Vkeyboard_translate_table = Qnil; 10652 Vkeyboard_translate_table = Qnil;
10659 10653
10660 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend, 10654 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
10661 "Non-nil means to always spawn a subshell instead of suspending.\n\ 10655 doc: /* Non-nil means to always spawn a subshell instead of suspending.
10662\(Even if the operating system has support for stopping a process.\)"); 10656\(Even if the operating system has support for stopping a process.\) */);
10663 cannot_suspend = 0; 10657 cannot_suspend = 0;
10664 10658
10665 DEFVAR_BOOL ("menu-prompting", &menu_prompting, 10659 DEFVAR_BOOL ("menu-prompting", &menu_prompting,
10666 "Non-nil means prompt with menus when appropriate.\n\ 10660 doc: /* Non-nil means prompt with menus when appropriate.
10667This is done when reading from a keymap that has a prompt string,\n\ 10661This is done when reading from a keymap that has a prompt string,
10668for elements that have prompt strings.\n\ 10662for elements that have prompt strings.
10669The menu is displayed on the screen\n\ 10663The menu is displayed on the screen
10670if X menus were enabled at configuration\n\ 10664if X menus were enabled at configuration
10671time and the previous event was a mouse click prefix key.\n\ 10665time and the previous event was a mouse click prefix key.
10672Otherwise, menu prompting uses the echo area."); 10666Otherwise, menu prompting uses the echo area. */);
10673 menu_prompting = 1; 10667 menu_prompting = 1;
10674 10668
10675 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char, 10669 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char,
10676 "Character to see next line of menu prompt.\n\ 10670 doc: /* Character to see next line of menu prompt.
10677Type this character while in a menu prompt to rotate around the lines of it."); 10671Type this character while in a menu prompt to rotate around the lines of it. */);
10678 XSETINT (menu_prompt_more_char, ' '); 10672 XSETINT (menu_prompt_more_char, ' ');
10679 10673
10680 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers, 10674 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers,
10681 "A mask of additional modifier keys to use with every keyboard character.\n\ 10675 doc: /* A mask of additional modifier keys to use with every keyboard character.
10682Emacs applies the modifiers of the character stored here to each keyboard\n\ 10676Emacs applies the modifiers of the character stored here to each keyboard
10683character it reads. For example, after evaluating the expression\n\ 10677character it reads. For example, after evaluating the expression
10684 (setq extra-keyboard-modifiers ?\\C-x)\n\ 10678 (setq extra-keyboard-modifiers ?\\C-x)
10685all input characters will have the control modifier applied to them.\n\ 10679all input characters will have the control modifier applied to them.
10686\n\ 10680
10687Note that the character ?\\C-@, equivalent to the integer zero, does\n\ 10681Note that the character ?\\C-@, equivalent to the integer zero, does
10688not count as a control character; rather, it counts as a character\n\ 10682not count as a control character; rather, it counts as a character
10689with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\ 10683with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
10690cancels any modification."); 10684cancels any modification. */);
10691 extra_keyboard_modifiers = 0; 10685 extra_keyboard_modifiers = 0;
10692 10686
10693 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark, 10687 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark,
10694 "If an editing command sets this to t, deactivate the mark afterward.\n\ 10688 doc: /* If an editing command sets this to t, deactivate the mark afterward.
10695The command loop sets this to nil before each command,\n\ 10689The command loop sets this to nil before each command,
10696and tests the value when the command returns.\n\ 10690and tests the value when the command returns.
10697Buffer modification stores t in this variable."); 10691Buffer modification stores t in this variable. */);
10698 Vdeactivate_mark = Qnil; 10692 Vdeactivate_mark = Qnil;
10699 10693
10700 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal, 10694 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal,
10701 "Temporary storage of pre-command-hook or post-command-hook."); 10695 doc: /* Temporary storage of pre-command-hook or post-command-hook. */);
10702 Vcommand_hook_internal = Qnil; 10696 Vcommand_hook_internal = Qnil;
10703 10697
10704 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook, 10698 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook,
10705 "Normal hook run before each command is executed.\n\ 10699 doc: /* Normal hook run before each command is executed.
10706If an unhandled error happens in running this hook,\n\ 10700If an unhandled error happens in running this hook,
10707the hook value is set to nil, since otherwise the error\n\ 10701the hook value is set to nil, since otherwise the error
10708might happen repeatedly and make Emacs nonfunctional."); 10702might happen repeatedly and make Emacs nonfunctional. */);
10709 Vpre_command_hook = Qnil; 10703 Vpre_command_hook = Qnil;
10710 10704
10711 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook, 10705 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook,
10712 "Normal hook run after each command is executed.\n\ 10706 doc: /* Normal hook run after each command is executed.
10713If an unhandled error happens in running this hook,\n\ 10707If an unhandled error happens in running this hook,
10714the hook value is set to nil, since otherwise the error\n\ 10708the hook value is set to nil, since otherwise the error
10715might happen repeatedly and make Emacs nonfunctional."); 10709might happen repeatedly and make Emacs nonfunctional. */);
10716 Vpost_command_hook = Qnil; 10710 Vpost_command_hook = Qnil;
10717 10711
10718 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook, 10712 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook,
10719 "Normal hook run after each command is executed, if idle.\n\ 10713 doc: /* Normal hook run after each command is executed, if idle.
10720Errors running the hook are caught and ignored.\n\ 10714Errors running the hook are caught and ignored.
10721This feature is obsolete; use idle timers instead. See `etc/NEWS'."); 10715This feature is obsolete; use idle timers instead. See `etc/NEWS'. */);
10722 Vpost_command_idle_hook = Qnil; 10716 Vpost_command_idle_hook = Qnil;
10723 10717
10724 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay, 10718 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay,
10725 "Delay time before running `post-command-idle-hook'.\n\ 10719 doc: /* Delay time before running `post-command-idle-hook'.
10726This is measured in microseconds."); 10720This is measured in microseconds. */);
10727 post_command_idle_delay = 100000; 10721 post_command_idle_delay = 100000;
10728 10722
10729#if 0 10723#if 0
10730 DEFVAR_LISP ("echo-area-clear-hook", ..., 10724 DEFVAR_LISP ("echo-area-clear-hook", ...,
10731 "Normal hook run when clearing the echo area."); 10725 doc: /* Normal hook run when clearing the echo area. */);
10732#endif 10726#endif
10733 Qecho_area_clear_hook = intern ("echo-area-clear-hook"); 10727 Qecho_area_clear_hook = intern ("echo-area-clear-hook");
10734 SET_SYMBOL_VALUE (Qecho_area_clear_hook, Qnil); 10728 SET_SYMBOL_VALUE (Qecho_area_clear_hook, Qnil);
10735 10729
10736 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag, 10730 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag,
10737 "t means menu bar, specified Lucid style, needs to be recomputed."); 10731 doc: /* t means menu bar, specified Lucid style, needs to be recomputed. */);
10738 Vlucid_menu_bar_dirty_flag = Qnil; 10732 Vlucid_menu_bar_dirty_flag = Qnil;
10739 10733
10740 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items, 10734 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items,
10741 "List of menu bar items to move to the end of the menu bar.\n\ 10735 doc: /* List of menu bar items to move to the end of the menu bar.
10742The elements of the list are event types that may have menu bar bindings."); 10736The elements of the list are event types that may have menu bar bindings. */);
10743 Vmenu_bar_final_items = Qnil; 10737 Vmenu_bar_final_items = Qnil;
10744 10738
10745 DEFVAR_KBOARD ("overriding-terminal-local-map", 10739 DEFVAR_KBOARD ("overriding-terminal-local-map",
10746 Voverriding_terminal_local_map, 10740 Voverriding_terminal_local_map,
10747 "Per-terminal keymap that overrides all other local keymaps.\n\ 10741 doc: /* Per-terminal keymap that overrides all other local keymaps.
10748If this variable is non-nil, it is used as a keymap instead of the\n\ 10742If this variable is non-nil, it is used as a keymap instead of the
10749buffer's local map, and the minor mode keymaps and text property keymaps.\n\ 10743buffer's local map, and the minor mode keymaps and text property keymaps.
10750This variable is intended to let commands such as `universal-argument'\n\ 10744This variable is intended to let commands such as `universal-argument'
10751set up a different keymap for reading the next command."); 10745set up a different keymap for reading the next command. */);
10752 10746
10753 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map, 10747 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
10754 "Keymap that overrides all other local keymaps.\n\ 10748 doc: /* Keymap that overrides all other local keymaps.
10755If this variable is non-nil, it is used as a keymap instead of the\n\ 10749If this variable is non-nil, it is used as a keymap instead of the
10756buffer's local map, and the minor mode keymaps and text property keymaps."); 10750buffer's local map, and the minor mode keymaps and text property keymaps. */);
10757 Voverriding_local_map = Qnil; 10751 Voverriding_local_map = Qnil;
10758 10752
10759 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag, 10753 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag,
10760 "Non-nil means `overriding-local-map' applies to the menu bar.\n\ 10754 doc: /* Non-nil means `overriding-local-map' applies to the menu bar.
10761Otherwise, the menu bar continues to reflect the buffer's local map\n\ 10755Otherwise, the menu bar continues to reflect the buffer's local map
10762and the minor mode maps regardless of `overriding-local-map'."); 10756and the minor mode maps regardless of `overriding-local-map'. */);
10763 Voverriding_local_map_menu_flag = Qnil; 10757 Voverriding_local_map_menu_flag = Qnil;
10764 10758
10765 DEFVAR_LISP ("special-event-map", &Vspecial_event_map, 10759 DEFVAR_LISP ("special-event-map", &Vspecial_event_map,
10766 "Keymap defining bindings for special events to execute at low level."); 10760 doc: /* Keymap defining bindings for special events to execute at low level. */);
10767 Vspecial_event_map = Fcons (intern ("keymap"), Qnil); 10761 Vspecial_event_map = Fcons (intern ("keymap"), Qnil);
10768 10762
10769 DEFVAR_LISP ("track-mouse", &do_mouse_tracking, 10763 DEFVAR_LISP ("track-mouse", &do_mouse_tracking,
10770 "*Non-nil means generate motion events for mouse motion."); 10764 doc: /* *Non-nil means generate motion events for mouse motion. */);
10771 10765
10772 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist, 10766 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
10773 "Alist of system-specific X windows key symbols.\n\ 10767 doc: /* Alist of system-specific X windows key symbols.
10774Each element should have the form (N . SYMBOL) where N is the\n\ 10768Each element should have the form (N . SYMBOL) where N is the
10775numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\ 10769numeric keysym code (sans the \"system-specific\" bit 1<<28)
10776and SYMBOL is its name."); 10770and SYMBOL is its name. */);
10777 10771
10778 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list, 10772 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list,
10779 "List of deferred actions to be performed at a later time.\n\ 10773 doc: /* List of deferred actions to be performed at a later time.
10780The precise format isn't relevant here; we just check whether it is nil."); 10774The precise format isn't relevant here; we just check whether it is nil. */);
10781 Vdeferred_action_list = Qnil; 10775 Vdeferred_action_list = Qnil;
10782 10776
10783 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function, 10777 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function,
10784 "Function to call to handle deferred actions, after each command.\n\ 10778 doc: /* Function to call to handle deferred actions, after each command.
10785This function is called with no arguments after each command\n\ 10779This function is called with no arguments after each command
10786whenever `deferred-action-list' is non-nil."); 10780whenever `deferred-action-list' is non-nil. */);
10787 Vdeferred_action_function = Qnil; 10781 Vdeferred_action_function = Qnil;
10788 10782
10789 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings, 10783 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings,
10790 "*Non-nil means show the equivalent key-binding when M-x command has one.\n\ 10784 doc: /* *Non-nil means show the equivalent key-binding when M-x command has one.
10791The value can be a length of time to show the message for.\n\ 10785The value can be a length of time to show the message for.
10792If the value is non-nil and not a number, we wait 2 seconds."); 10786If the value is non-nil and not a number, we wait 2 seconds. */);
10793 Vsuggest_key_bindings = Qt; 10787 Vsuggest_key_bindings = Qt;
10794 10788
10795 DEFVAR_LISP ("timer-list", &Vtimer_list, 10789 DEFVAR_LISP ("timer-list", &Vtimer_list,
10796 "List of active absolute time timers in order of increasing time"); 10790 doc: /* List of active absolute time timers in order of increasing time. */);
10797 Vtimer_list = Qnil; 10791 Vtimer_list = Qnil;
10798 10792
10799 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list, 10793 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list,
10800 "List of active idle-time timers in order of increasing time"); 10794 doc: /* List of active idle-time timers in order of increasing time. */);
10801 Vtimer_idle_list = Qnil; 10795 Vtimer_idle_list = Qnil;
10802 10796
10803 DEFVAR_LISP ("input-method-function", &Vinput_method_function, 10797 DEFVAR_LISP ("input-method-function", &Vinput_method_function,
10804 "If non-nil, the function that implements the current input method.\n\ 10798 doc: /* If non-nil, the function that implements the current input method.
10805It's called with one argument, a printing character that was just read.\n\ 10799It's called with one argument, a printing character that was just read.
10806\(That means a character with code 040...0176.)\n\ 10800\(That means a character with code 040...0176.)
10807Typically this function uses `read-event' to read additional events.\n\ 10801Typically this function uses `read-event' to read additional events.
10808When it does so, it should first bind `input-method-function' to nil\n\ 10802When it does so, it should first bind `input-method-function' to nil
10809so it will not be called recursively.\n\ 10803so it will not be called recursively.
10810\n\ 10804
10811The function should return a list of zero or more events\n\ 10805The function should return a list of zero or more events
10812to be used as input. If it wants to put back some events\n\ 10806to be used as input. If it wants to put back some events
10813to be reconsidered, separately, by the input method,\n\ 10807to be reconsidered, separately, by the input method,
10814it can add them to the beginning of `unread-command-events'.\n\ 10808it can add them to the beginning of `unread-command-events'.
10815\n\ 10809
10816The input method function can find in `input-method-previous-method'\n\ 10810The input method function can find in `input-method-previous-method'
10817the previous echo area message.\n\ 10811the previous echo area message.
10818\n\ 10812
10819The input method function should refer to the variables\n\ 10813The input method function should refer to the variables
10820`input-method-use-echo-area' and `input-method-exit-on-first-char'\n\ 10814`input-method-use-echo-area' and `input-method-exit-on-first-char'
10821for guidance on what to do."); 10815for guidance on what to do. */);
10822 Vinput_method_function = Qnil; 10816 Vinput_method_function = Qnil;
10823 10817
10824 DEFVAR_LISP ("input-method-previous-message", 10818 DEFVAR_LISP ("input-method-previous-message",
10825 &Vinput_method_previous_message, 10819 &Vinput_method_previous_message,
10826 "When `input-method-function' is called, hold the previous echo area message.\n\ 10820 doc: /* When `input-method-function' is called, hold the previous echo area message.
10827This variable exists because `read-event' clears the echo area\n\ 10821This variable exists because `read-event' clears the echo area
10828before running the input method. It is nil if there was no message."); 10822before running the input method. It is nil if there was no message. */);
10829 Vinput_method_previous_message = Qnil; 10823 Vinput_method_previous_message = Qnil;
10830 10824
10831 DEFVAR_LISP ("show-help-function", &Vshow_help_function, 10825 DEFVAR_LISP ("show-help-function", &Vshow_help_function,
10832 "If non-nil, the function that implements the display of help.\n\ 10826 doc: /* If non-nil, the function that implements the display of help.
10833It's called with one argument, the help string to display."); 10827It's called with one argument, the help string to display. */);
10834 Vshow_help_function = Qnil; 10828 Vshow_help_function = Qnil;
10835 10829
10836 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment, 10830 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment,
10837 "If non-nil, suppress point adjustment after executing a command.\n\ 10831 doc: /* If non-nil, suppress point adjustment after executing a command.
10838\n\ 10832
10839After a command is executed, if point is moved into a region that has\n\ 10833After a command is executed, if point is moved into a region that has
10840special properties (e.g. composition, display), we adjust point to\n\ 10834special properties (e.g. composition, display), we adjust point to
10841the boundary of the region. But, several special commands sets this\n\ 10835the boundary of the region. But, several special commands sets this
10842variable to non-nil, then we suppress the point adjustment.\n\ 10836variable to non-nil, then we suppress the point adjustment.
10843\n\ 10837
10844This variable is set to nil before reading a command, and is checked\n\ 10838This variable is set to nil before reading a command, and is checked
10845just after executing the command"); 10839just after executing the command. */);
10846 Vdisable_point_adjustment = Qnil; 10840 Vdisable_point_adjustment = Qnil;
10847 10841
10848 DEFVAR_LISP ("global-disable-point-adjustment", 10842 DEFVAR_LISP ("global-disable-point-adjustment",
10849 &Vglobal_disable_point_adjustment, 10843 &Vglobal_disable_point_adjustment,
10850 "*If non-nil, always suppress point adjustment.\n\ 10844 doc: /* *If non-nil, always suppress point adjustment.
10851\n\ 10845
10852The default value is nil, in which case, point adjustment are\n\ 10846The default value is nil, in which case, point adjustment are
10853suppressed only after special commands that set\n\ 10847suppressed only after special commands that set
10854`disable-point-adjustment' (which see) to non-nil."); 10848`disable-point-adjustment' (which see) to non-nil. */);
10855 Vglobal_disable_point_adjustment = Qnil; 10849 Vglobal_disable_point_adjustment = Qnil;
10856 10850
10857 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings, 10851 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings,
10858 "Non-nil means updating menu bindings is allowed.\n\ 10852 doc: /* Non-nil means updating menu bindings is allowed.
10859A value of nil means menu bindings should not be updated.\n\ 10853A value of nil means menu bindings should not be updated.
10860Used during Emacs' startup."); 10854Used during Emacs' startup. */);
10861 update_menu_bindings = 1; 10855 update_menu_bindings = 1;
10862 10856
10863 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout, 10857 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout,
10864 "*How long to display an echo-area message when the minibuffer is active.\n\ 10858 doc: /* *How long to display an echo-area message when the minibuffer is active.
10865If the value is not a number, such messages don't time out."); 10859If the value is not a number, such messages don't time out. */);
10866 Vminibuffer_message_timeout = make_number (2); 10860 Vminibuffer_message_timeout = make_number (2);
10867} 10861}
10868 10862