comparison src/buffer.c @ 74680:a331aebfdf6a

(Fkill_buffer): Doc fix. (syms_of_buffer) <kill-buffer-query-functions>: Doc fix.
author Juanma Barranquero <lekktu@gmail.com>
date Sun, 17 Dec 2006 11:52:40 +0000
parents 42f97e1a6081
children cdf24e3ef426
comparison
equal deleted inserted replaced
74679:829062b6492b 74680:a331aebfdf6a
1329 The buffer being killed will be current while the hook is running.\n\ 1329 The buffer being killed will be current while the hook is running.\n\
1330 See `kill-buffer'." 1330 See `kill-buffer'."
1331 */ 1331 */
1332 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ", 1332 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1333 doc: /* Kill the buffer BUFFER. 1333 doc: /* Kill the buffer BUFFER.
1334 The argument may be a buffer or may be the name of a buffer. 1334 The argument may be a buffer or the name of a buffer.
1335 An argument of nil means kill the current buffer. 1335 With a nil argument, kill the current buffer.
1336 1336
1337 Value is t if the buffer is actually killed, nil if user says no. 1337 Value is t if the buffer is actually killed, nil otherwise.
1338 1338
1339 The value of `kill-buffer-hook' (which may be local to that buffer), 1339 The functions in `kill-buffer-query-functions' are called with BUFFER as
1340 if not void, is a list of functions to be called, with no arguments, 1340 the current buffer. If any of them returns nil, the buffer is not killed.
1341 before the buffer is actually killed. The buffer to be killed is current 1341
1342 when the hook functions are called. 1342 The hook `kill-buffer-hook' is run before the buffer is actually killed.
1343 The buffer being killed will be current while the hook is running.
1343 1344
1344 Any processes that have this buffer as the `process-buffer' are killed 1345 Any processes that have this buffer as the `process-buffer' are killed
1345 with SIGHUP. */) 1346 with SIGHUP. */)
1346 (buffer) 1347 (buffer)
1347 Lisp_Object buffer; 1348 Lisp_Object buffer;
6013 and disregard a `read-only' text property if the property value 6014 and disregard a `read-only' text property if the property value
6014 is a member of the list. */); 6015 is a member of the list. */);
6015 Vinhibit_read_only = Qnil; 6016 Vinhibit_read_only = Qnil;
6016 6017
6017 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil, 6018 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
6018 doc: /* Cursor to use when this buffer is in the selected window. 6019 doc: /* Cursor to use when this buffer is in the selected window.
6019 Values are interpreted as follows: 6020 Values are interpreted as follows:
6020 6021
6021 t use the cursor specified for the frame 6022 t use the cursor specified for the frame
6022 nil don't display a cursor 6023 nil don't display a cursor
6023 box display a filled box cursor 6024 box display a filled box cursor
6038 If value is a floating point number, it specifies the spacing relative 6039 If value is a floating point number, it specifies the spacing relative
6039 to the default frame line height. A value of nil means add no extra space. */); 6040 to the default frame line height. A value of nil means add no extra space. */);
6040 6041
6041 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows", 6042 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6042 &current_buffer->cursor_in_non_selected_windows, Qnil, 6043 &current_buffer->cursor_in_non_selected_windows, Qnil,
6043 doc: /* *Cursor type to display in non-selected windows. 6044 doc: /* *Cursor type to display in non-selected windows.
6044 The value t means to use hollow box cursor. See `cursor-type' for other values. */); 6045 The value t means to use hollow box cursor. See `cursor-type' for other values. */);
6045 6046
6046 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions, 6047 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
6047 doc: /* List of functions called with no args to query before killing a buffer. */); 6048 doc: /* List of functions called with no args to query before killing a buffer.
6049 The buffer being killed will be current while the functions are running.
6050 If any of them returns nil, the buffer is not killed. */);
6048 Vkill_buffer_query_functions = Qnil; 6051 Vkill_buffer_query_functions = Qnil;
6049 6052
6050 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook, 6053 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook,
6051 doc: /* Normal hook run before changing the major mode of a buffer. 6054 doc: /* Normal hook run before changing the major mode of a buffer.
6052 The function `kill-all-local-variables' runs this before doing anything else. */); 6055 The function `kill-all-local-variables' runs this before doing anything else. */);