From: Richard M. Stallman <rms@gnu.org>
Date: Mon, 9 Sep 2002 19:17:00 +0000 (+0000)
Subject: Document --script.
X-Git-Tag: ttn-vms-21-2-B4~13313
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=0a41ca77ba2cc8fe5f09c409852d35ad2353e857;p=emacs.git

Document --script.
---

diff --git a/man/cmdargs.texi b/man/cmdargs.texi
index d6580f66b46..964e943433d 100644
--- a/man/cmdargs.texi
+++ b/man/cmdargs.texi
@@ -195,11 +195,28 @@ shell scripts, makefiles, and so on.  Normally the @samp{-l} option
 or @samp{-f} option will be used as well, to invoke a Lisp program
 to do the batch processing.
 
-@samp{-batch} implies @samp{-q} (do not load an init file).  It also
+@samp{--batch} implies @samp{-q} (do not load an init file).  It also
 causes Emacs to exit after processing all the command options.  In
 addition, it disables auto-saving except in buffers for which it has
 been explicitly requested.
 
+@item --script @var{file}
+@opindex --script
+Run Emacs in batch mode, like @samp{--batch}, and then read and
+execute the Lisp code in @var{file}.
+
+The normal use of this option is in executable script files that run
+Emacs.  They can start with this text on the first line
+
+@example
+#!/usr/bin/emacs --script
+@end example
+
+@noindent
+which will invoke Emacs with @samp{--script} and supply the name of
+the script file as @var{file}.  Emacs Lisp then treats @samp{#!}  as a
+comment delimiter.
+
 @item -q
 @opindex -q
 @itemx --no-init-file