diff options
author | Glenn Morris <rgm@gnu.org> | 2010-09-25 14:51:55 -0700 |
---|---|---|
committer | Glenn Morris <rgm@gnu.org> | 2010-09-25 14:51:55 -0700 |
commit | ec60da520ebe8cc187ab44e17a3645147b75ec57 (patch) | |
tree | 96f0a8075fe50dfd85d1e3ab721c94a395409e76 /lisp/eshell/esh-ext.el | |
parent | 4c96435152dd2b343057f80f995910ba806774e8 (diff) | |
download | emacs-ec60da520ebe8cc187ab44e17a3645147b75ec57.tar.gz emacs-ec60da520ebe8cc187ab44e17a3645147b75ec57.tar.bz2 emacs-ec60da520ebe8cc187ab44e17a3645147b75ec57.zip |
Cosmetic doc fixes for eshell.
* eshell/em-alias.el, eshell/em-banner.el, eshell/em-basic.el:
* eshell/em-cmpl.el, eshell/em-dirs.el, eshell/em-glob.el:
* eshell/em-hist.el, eshell/em-ls.el, eshell/em-pred.el:
* eshell/em-prompt.el, eshell/em-rebind.el, eshell/em-script.el:
* eshell/em-smart.el, eshell/em-term.el, eshell/em-unix.el:
* eshell/esh-cmd.el, eshell/esh-ext.el, eshell/esh-io.el:
* eshell/esh-mode.el, eshell/esh-proc.el, eshell/esh-test.el:
* eshell/esh-util.el, eshell/esh-var.el:
Remove leading `*' from docs of faces and defcustoms.
Diffstat (limited to 'lisp/eshell/esh-ext.el')
-rw-r--r-- | lisp/eshell/esh-ext.el | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/lisp/eshell/esh-ext.el b/lisp/eshell/esh-ext.el index dba8665d9ae..8a3f86a3997 100644 --- a/lisp/eshell/esh-ext.el +++ b/lisp/eshell/esh-ext.el @@ -1,7 +1,7 @@ ;;; esh-ext.el --- commands external to Eshell -;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, -;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. +;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, +;; 2008, 2009, 2010 Free Software Foundation, Inc. ;; Author: John Wiegley <johnw@gnu.org> @@ -48,17 +48,17 @@ loaded into memory, thus beginning a new process." ;;; User Variables: (defcustom eshell-ext-load-hook '(eshell-ext-initialize) - "*A hook that gets run when `eshell-ext' is loaded." + "A hook that gets run when `eshell-ext' is loaded." :type 'hook :group 'eshell-ext) (defcustom eshell-binary-suffixes exec-suffixes - "*A list of suffixes used when searching for executable files." + "A list of suffixes used when searching for executable files." :type '(repeat string) :group 'eshell-ext) (defcustom eshell-force-execution nil - "*If non-nil, try to execute binary files regardless of permissions. + "If non-nil, try to execute binary files regardless of permissions. This can be useful on systems like Windows, where the operating system doesn't happen to honor the permission bits in certain cases; or in cases where you want to associate an interpreter with a particular @@ -96,7 +96,7 @@ since nothing else but Eshell will be able to understand (or (eshell-search-path "cmd.exe") (eshell-search-path "command.com")) shell-file-name)) - "*The name of the shell command to use for DOS/Windows batch files. + "The name of the shell command to use for DOS/Windows batch files. This defaults to nil on non-Windows systems, where this variable is wholly ignored." :type '(choice file (const nil)) @@ -113,7 +113,7 @@ wholly ignored." (defcustom eshell-interpreter-alist (if (eshell-under-windows-p) '(("\\.\\(bat\\|cmd\\)\\'" . eshell-invoke-batch-file))) - "*An alist defining interpreter substitutions. + "An alist defining interpreter substitutions. Each member is a cons cell of the form: (MATCH . INTERPRETER) @@ -134,7 +134,7 @@ possible return values of `eshell-external-command', which see." :group 'eshell-ext) (defcustom eshell-alternate-command-hook nil - "*A hook run whenever external command lookup fails. + "A hook run whenever external command lookup fails. If a functions wishes to provide an alternate command, they must throw it using the tag `eshell-replace-command'. This is done because the substituted command need not be external at all, and therefore must be @@ -147,12 +147,12 @@ by the user on the command line." :group 'eshell-ext) (defcustom eshell-command-interpreter-max-length 256 - "*The maximum length of any command interpreter string, plus args." + "The maximum length of any command interpreter string, plus args." :type 'integer :group 'eshell-ext) (defcustom eshell-explicit-command-char ?* - "*If this char occurs before a command name, call it externally. + "If this char occurs before a command name, call it externally. That is, although `vi' may be an alias, `\vi' will always call the external version." :type 'character |