From: Lars Ingebrigtsen Date: Mon, 15 Jul 2019 17:55:20 +0000 (+0200) Subject: open-dribble-file doc string clarification X-Git-Tag: emacs-27.0.90~1891 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b7946afe25c718822cb95fb15719ac002d9341f0;p=emacs.git open-dribble-file doc string clarification * src/keyboard.c (Fopen_dribble_file): Clarify when the file is closed, and when events are written to the file (bug#27996). --- diff --git a/src/keyboard.c b/src/keyboard.c index c47eecab9fb..b86ad03851f 100644 --- a/src/keyboard.c +++ b/src/keyboard.c @@ -10131,11 +10131,14 @@ DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0, DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1, "FOpen dribble file: ", doc: /* Start writing input events to a dribble file called FILE. -If FILE is nil, close any open dribble file. -The file will be closed when Emacs exits. +Any previously open dribble file will be closed first. If FILE is +nil, just close the dribble file, if any. + +If the file is still open when Emacs exits, it will be closed then. The events written to the file include keyboard and mouse input -events, but not events from executing keyboard macros. +events, but not events from executing keyboard macros. The events are +written to the dribble file immediately without line buffering. Be aware that this records ALL characters you type! This may include sensitive information such as passwords. */)