comparison doc/lispref/buffers.texi @ 99036:26ffccc14770

(Killing Buffers): Update documentation of kill-buffer.
author Martin Rudalics <rudalics@gmx.at>
date Wed, 22 Oct 2008 16:07:55 +0000
parents 5acd30038b76
children 1dcf806b4a8d
comparison
equal deleted inserted replaced
99035:90d78f7a7eba 99036:26ffccc14770
994 "Return t if BUFFER is killed." 994 "Return t if BUFFER is killed."
995 (not (buffer-name buffer))) 995 (not (buffer-name buffer)))
996 @end group 996 @end group
997 @end example 997 @end example
998 998
999 @deffn Command kill-buffer buffer-or-name 999 @deffn Command kill-buffer &optional buffer-or-name
1000 This function kills the buffer @var{buffer-or-name}, freeing all its 1000 This function kills the buffer @var{buffer-or-name}, freeing all its
1001 memory for other uses or to be returned to the operating system. If 1001 memory for other uses or to be returned to the operating system. If
1002 @var{buffer-or-name} is @code{nil}, it kills the current buffer. 1002 @var{buffer-or-name} is @code{nil} or omitted, it kills the current
1003 buffer.
1003 1004
1004 Any processes that have this buffer as the @code{process-buffer} are 1005 Any processes that have this buffer as the @code{process-buffer} are
1005 sent the @code{SIGHUP} signal, which normally causes them to terminate. 1006 sent the @code{SIGHUP} signal, which normally causes them to terminate.
1006 (The basic meaning of @code{SIGHUP} is that a dialup line has been 1007 (The basic meaning of @code{SIGHUP} is that a dialup line has been
1007 disconnected.) @xref{Signals to Processes}. 1008 disconnected.) @xref{Signals to Processes}.
1009 If the buffer is visiting a file and contains unsaved changes, 1010 If the buffer is visiting a file and contains unsaved changes,
1010 @code{kill-buffer} asks the user to confirm before the buffer is killed. 1011 @code{kill-buffer} asks the user to confirm before the buffer is killed.
1011 It does this even if not called interactively. To prevent the request 1012 It does this even if not called interactively. To prevent the request
1012 for confirmation, clear the modified flag before calling 1013 for confirmation, clear the modified flag before calling
1013 @code{kill-buffer}. @xref{Buffer Modification}. 1014 @code{kill-buffer}. @xref{Buffer Modification}.
1015
1016 This function calls `replace-buffer-in-windows' for cleaning up all
1017 windows currently displaying the buffer to be killed.
1014 1018
1015 Killing a buffer that is already dead has no effect. 1019 Killing a buffer that is already dead has no effect.
1016 1020
1017 This function returns @code{t} if it actually killed the buffer. It 1021 This function returns @code{t} if it actually killed the buffer. It
1018 returns @code{nil} if the user refuses to confirm or if 1022 returns @code{nil} if the user refuses to confirm or if