procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Small doc updates re initial-buffer-choice

Browse source 
* doc/emacs/entering.texi (Entering Emacs): Small fix re initial-buffer-choice.

* doc/emacs/misc.texi (emacsclient Options): Copyedit.

* doc/lispref/os.texi (Startup Summary): Small fix for initial-buffer-choice.

* lisp/startup.el (initial-buffer-choice): Doc fix.
Reset :version (adding an option does not merit a :version bump).
This commit is contained in:
Glenn Morris 2014-06-08 10:46:51 -07:00
parent 99d8aedf0d
commit 6d069b1b3a
7 changed files with 40 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/emacs/ChangeLog
View file

@ -1,5 +1,8 @@
2014-06-08 Glenn Morris <rgm@gnu.org>
* entering.texi (Entering Emacs): Small fix re initial-buffer-choice.
* misc.texi (emacsclient Options): Copyedit.
* buffers.texi (Uniquify): Copyedits.
* files.texi (Visiting): Update for uniquify changes.

17
doc/emacs/entering.texi
View file

@ -76,12 +76,17 @@ information about @file{site-start.el}.}
You can also force Emacs to display a file or directory at startup
by setting the variable @code{initial-buffer-choice} to a string
naming that file or directory. The value of
@code{initial-buffer-choice} may also be a function which should
return a buffer which is then displayed. @code{initial-buffer-choice}
may also be @code{t} in which case the @file{*scratch*} buffer will be
shown. In any case, even if you specify one or more files on the
command line, Emacs opens but does not display them if
@code{initial-buffer-choice} is non-nil.
@code{initial-buffer-choice} may also be a function (of no arguments)
that should return a buffer which is then displayed.
@ignore
@c I do not think this should be mentioned. AFAICS it is just a dodge
@c around inhibit-startup-screen not being settable on a site-wide basis.
@code{initial-buffer-choice} may also be @code{t} in which case the
@file{*scratch*} buffer will be shown.
@end ignore
If @code{initial-buffer-choice} is non-@code{nil}, then if you specify
any files on the command line, Emacs still visits them, but does not
display them initially.
@node Exiting
@section Exiting Emacs

6
doc/emacs/misc.texi
View file

@ -1560,9 +1560,9 @@ option, like the @samp{-t} option, creates a new frame in the server's
current text terminal. @xref{Windows Startup}.
If you omit a filename argument while supplying the @samp{-c} option,
the new frame displays the @file{*scratch*} buffer by default. This
behavior can be customized using the variable
@code{initial-buffer-choice} (@pxref{Entering Emacs}).
the new frame displays the @file{*scratch*} buffer by default. You
can customize this behavior with the variable @code{initial-buffer-choice}
(@pxref{Entering Emacs}).
@item -F @var{alist}
@itemx --frame-parameters=@var{alist}

2
doc/lispref/ChangeLog
View file

@ -1,5 +1,7 @@
2014-06-08 Glenn Morris <rgm@gnu.org>
* os.texi (Startup Summary): Small fix for initial-buffer-choice.
* files.texi (Subroutines of Visiting): Mention uniquify.
* numbers.texi (Comparison of Numbers): Copyedits.

15
doc/lispref/os.texi
View file

@ -194,11 +194,16 @@ It processes any command-line options that were not handled earlier.
It now exits if the option @code{--batch} was specified.
@item
If @code{initial-buffer-choice} is a string, it visits the file with
that name. If it is a function, it calls the function and selects the
buffer returned by the function. It it is @code{t}, it selects the
@file{*scratch*} buffer. If the @file{*scratch*} buffer exists and is
empty, it inserts @code{initial-scratch-message} into that buffer.
If @code{initial-buffer-choice} is a string, it visits the file (or
directory) with that name. If it is a function, it calls the function
with no arguments and selects the buffer that it returns.
@ignore
@c I do not think this should be mentioned. AFAICS it is just a dodge
@c around inhibit-startup-screen not being settable on a site-wide basis.
If it is @code{t}, it selects the @file{*scratch*} buffer.
@end ignore
If the @file{*scratch*} buffer exists and is empty, it inserts
@code{initial-scratch-message} into that buffer.
@c To make things nice and confusing, the next three items can be
@c called from two places. If displaying a startup screen, they are

3
lisp/ChangeLog
View file

@ -1,5 +1,8 @@
2014-06-08 Glenn Morris <rgm@gnu.org>
* startup.el (initial-buffer-choice): Doc fix.
Reset :version (adding an option does not merit a :version bump).
* bookmark.el (bookmark-load):
* uniquify.el (uniquify-buffer-name-style): Doc fixes.

15
lisp/startup.el
View file

@ -42,20 +42,21 @@
"Buffer to show after starting Emacs.
If the value is nil and `inhibit-startup-screen' is nil, show the
startup screen. If the value is a string, switch to a buffer
visiting the file or directory specified by that string. If the
value is a function, switch to the buffer returned by that
function. If t, open the `*scratch*' buffer.
visiting the file or directory that the string specifies. If the
value is a function, call it with no arguments and switch to the buffer
that it returns. If t, open the `*scratch*' buffer.
A string value also causes emacsclient to open the specified file
or directory when no target file is specified."
If you use `emacsclient' with no target file, then it obeys any
string or function value that this variable has."
:type '(choice
(const :tag "Startup screen" nil)
(directory :tag "Directory" :value "~/")
(file :tag "File" :value "~/.emacs")
(const :tag "Notes buffer" remember-notes)
;; Note sure about hard-coding this as an option...
(const :tag "Remember Mode notes buffer" remember-notes)
(function :tag "Function")
(const :tag "Lisp scratch buffer" t))
:version "24.4"
:version "23.1"
:group 'initialization)
(defcustom inhibit-startup-screen nil