diff options
author | Richard M. Stallman <[email protected]> | 1996-03-01 05:26:29 +0000 |
---|---|---|
committer | Richard M. Stallman <[email protected]> | 1996-03-01 05:26:29 +0000 |
commit | 252ed27682194518555191077711f2d66004435b (patch) | |
tree | 4c130327d437d6382b437a1da38ca1f863a114be /lisp/progmodes | |
parent | 4718d52e19c5a07c1fe07a59b9963ac8f61cabde (diff) |
Comment change.
Diffstat (limited to 'lisp/progmodes')
-rw-r--r-- | lisp/progmodes/executable.el | 28 |
1 files changed, 21 insertions, 7 deletions
diff --git a/lisp/progmodes/executable.el b/lisp/progmodes/executable.el index 1706cff0f2..8f1428001e 100644 --- a/lisp/progmodes/executable.el +++ b/lisp/progmodes/executable.el @@ -28,13 +28,27 @@ ;; #! line at the beginning of the file, if the file does not already ;; have one. -;; This is support code for the likes of sh-, awk-, perl-, tcl- or -;; makefile-mode. Those mode-setting commands can call the like of -;; `(executable-set-magic "sh")' or `(executable-set-magic "perl" "-f")'. -;; Unless the file name matches `executable-magicless-file-regexp' this will -;; search $PATH if the given interpreter isn't absolute, and then insert a -;; first line like `#! /bin/sh' or `#! /usr/local/bin/perl -f'. -;; Also it makes the file executable as soon as it's saved, if it wasn't. +;; Unless it has a magic number, a Unix file with executable mode is passed to +;; a new instance of the running shell (or to a Bourne shell if a csh is +;; running and the file starts with `:'). Only a shell can start such a file, +;; exec() cannot, which is why it is important to have a magic number in every +;; executable script. Such a magic number is made up by the characters `#!' +;; the filename of an interpreter (in COFF, ELF or somesuch format) and one +;; optional argument. + +;; This library is for certain major modes like sh-, awk-, perl-, tcl- or +;; makefile-mode to insert or update a suitable #! line at the beginning of +;; the file, if the file does not already have one and the file is not a +;; default file of that interpreter (like .profile or makefile). It also +;; makes the file executable if it wasn't, as soon as it's saved. + +;; It also allows debugging scripts, with an adaptation of compile, as far +;; as interpreters give out meaningful error messages. + +;; Modes that use this should nconc `executable-map' to the end of their own +;; keymap and `executable-font-lock-keywords' to the end of their own font +;; lock keywords. Their mode-setting commands should call +;; `executable-set-magic'. ;;; Code: |