comparison src/buffer.c @ 41027:54f6ee43146e

(syms_of_buffer): Doc fixes.
author Richard M. Stallman <rms@gnu.org>
date Wed, 14 Nov 2001 00:06:50 +0000
parents 2b65fb0dbd2d
children 095a45698793
comparison
equal deleted inserted replaced
41026:6f20449b7e12 41027:54f6ee43146e
5158 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it. 5158 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5159 This is the same as (default-value 'indicate-empty-lines). */); 5159 This is the same as (default-value 'indicate-empty-lines). */);
5160 5160
5161 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively", 5161 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5162 &buffer_defaults.scroll_up_aggressively, 5162 &buffer_defaults.scroll_up_aggressively,
5163 doc: /* Default value of `scroll-up-aggressively' for buffers that 5163 doc: /* Default value of `scroll-up-aggressively'.
5164 don't override it. This is the same as (default-value 5164 This value applies in buffers that don't have their own local values.
5165 'scroll-up-aggressively). */); 5165 This variable is an alias for (default-value 'scroll-up-aggressively). */);
5166 5166
5167 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively", 5167 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5168 &buffer_defaults.scroll_down_aggressively, 5168 &buffer_defaults.scroll_down_aggressively,
5169 doc: /* Default value of `scroll-down-aggressively' for buffers that 5169 doc: /* Default value of `scroll-down-aggressively'.
5170 don't override it. This is the same as (default-value 5170 This value applies in buffers that don't have their own local values.
5171 'scroll-down-aggressively). */); 5171 This variable is an alias for (default-value 'scroll-down-aggressively). */);
5172 5172
5173 DEFVAR_PER_BUFFER ("header-line-format", 5173 DEFVAR_PER_BUFFER ("header-line-format",
5174 &current_buffer->header_line_format, 5174 &current_buffer->header_line_format,
5175 Qnil, 5175 Qnil,
5176 doc: /* Analogous to `mode-line-format', but for the mode line that can be 5176 doc: /* Analogous to `mode-line-format', but controls the header line.
5177 displayed at the top of a window. */); 5177 The header line appears, optionally, at the top of a window;
5178 the mode line appears at the bottom. */);
5178 5179
5179 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format, 5180 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5180 Qnil, 5181 Qnil,
5181 doc: /* Template for displaying mode line for current buffer. 5182 doc: /* Template for displaying mode line for current buffer.
5182 Each buffer has its own value of this variable. 5183 Each buffer has its own value of this variable.
5288 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed, 5289 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5289 Qnil, 5290 Qnil,
5290 doc: /* *Non-nil means lines in the buffer are displayed right to left. */); 5291 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5291 5292
5292 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil, 5293 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5293 doc: /* *Non-nil means do not display continuation lines; 5294 doc: /* *Non-nil means do not display continuation lines.
5294 give each line of text one screen line. 5295 Instead, give each line of text just one screen line.
5295 5296
5296 Note that this is overridden by the variable 5297 Note that this is overridden by the variable
5297 `truncate-partial-width-windows' if that variable is non-nil 5298 `truncate-partial-width-windows' if that variable is non-nil
5298 and this buffer is not full-frame width. */); 5299 and this buffer is not full-frame width. */);
5299 5300
5330 and then abbreviated with `abbreviate-file-name'. */); 5331 and then abbreviated with `abbreviate-file-name'. */);
5331 5332
5332 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name", 5333 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5333 &current_buffer->auto_save_file_name, 5334 &current_buffer->auto_save_file_name,
5334 make_number (Lisp_String), 5335 make_number (Lisp_String),
5335 doc: /* Name of file for auto-saving current buffer, 5336 doc: /* Name of file for auto-saving current buffer.
5336 or nil if buffer should not be auto-saved. */); 5337 If it is nil, that means don't auto-save this buffer. */);
5337 5338
5338 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil, 5339 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5339 doc: /* Non-nil if this buffer is read-only. */); 5340 doc: /* Non-nil if this buffer is read-only. */);
5340 5341
5341 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil, 5342 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5347 doc: /* Length of current buffer when last read in, saved or auto-saved. 5348 doc: /* Length of current buffer when last read in, saved or auto-saved.
5348 0 initially. */); 5349 0 initially. */);
5349 5350
5350 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display, 5351 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5351 Qnil, 5352 Qnil,
5352 doc: /* Non-nil enables selective display: 5353 doc: /* Non-nil enables selective display.
5353 Integer N as value means display only lines 5354 An Integer N as value means display only lines
5354 that start with less than n columns of space. 5355 that start with less than n columns of space.
5355 A value of t means, after a ^M, all the rest of the line is invisible. 5356 A value of t means that the character ^M makes itself and
5356 Then ^M's in the file are written into files as newlines. */); 5357 all the rest of the line invisible; also, when saving the buffer
5358 in a file, save the ^M as a newline. */);
5357 5359
5358 #ifndef old 5360 #ifndef old
5359 DEFVAR_PER_BUFFER ("selective-display-ellipses", 5361 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5360 &current_buffer->selective_display_ellipses, 5362 &current_buffer->selective_display_ellipses,
5361 Qnil, 5363 Qnil,