Commit ec60da52 authored by Glenn Morris's avatar Glenn Morris
Browse files

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.
parent 4c964351
2010-09-25 Glenn Morris <rgm@gnu.org>
* 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.
2010-09-25 Ulrich Mueller <ulm@gentoo.org>
 
* eshell/em-ls.el (eshell-ls-archive-regexp):
......
......@@ -103,7 +103,7 @@
:group 'eshell-module)
(defcustom eshell-aliases-file (expand-file-name "alias" eshell-directory-name)
"*The file in which aliases are kept.
"The file in which aliases are kept.
Whenever an alias is defined by the user, using the `alias' command,
it will be written to this file. Thus, alias definitions (and
deletions) are always permanent. This approach was chosen for the
......@@ -113,13 +113,13 @@ gained by using this module."
:group 'eshell-alias)
(defcustom eshell-bad-command-tolerance 3
"*The number of failed commands to ignore before creating an alias."
"The number of failed commands to ignore before creating an alias."
:type 'integer
;; :link '(custom-manual "(eshell)Auto-correction of bad commands")
:group 'eshell-alias)
(defcustom eshell-alias-load-hook '(eshell-alias-initialize)
"*A hook that gets run when `eshell-alias' is loaded."
"A hook that gets run when `eshell-alias' is loaded."
:type 'hook
:group 'eshell-alias)
......
......@@ -58,7 +58,7 @@ modules may have a simple template to begin with."
;;; User Variables:
(defcustom eshell-banner-message "Welcome to the Emacs shell\n\n"
"*The banner message to be displayed when Eshell is loaded.
"The banner message to be displayed when Eshell is loaded.
This can be any sexp, and should end with at least two newlines."
:type 'sexp
:group 'eshell-banner)
......@@ -66,7 +66,7 @@ This can be any sexp, and should end with at least two newlines."
(put 'eshell-banner-message 'risky-local-variable t)
(defcustom eshell-banner-load-hook '(eshell-banner-initialize)
"*A list of functions to run when `eshell-banner' is loaded."
"A list of functions to run when `eshell-banner' is loaded."
:type 'hook
:group 'eshell-banner)
......
......@@ -77,7 +77,7 @@ same thing."
:group 'eshell-module)
(defcustom eshell-plain-echo-behavior nil
"*If non-nil, `echo' tries to behave like an ordinary shell echo.
"If non-nil, `echo' tries to behave like an ordinary shell echo.
This comes at some detriment to Lisp functionality. However, the Lisp
equivalent of `echo' can always be achieved by using `identity'."
:type 'boolean
......
......@@ -86,26 +86,26 @@ variable names, arguments, etc."
;;; User Variables:
(defcustom eshell-cmpl-load-hook '(eshell-cmpl-initialize)
"*A list of functions to run when `eshell-cmpl' is loaded."
"A list of functions to run when `eshell-cmpl' is loaded."
:type 'hook
:group 'eshell-cmpl)
(defcustom eshell-show-lisp-completions nil
"*If non-nil, include Lisp functions in the command completion list.
"If non-nil, include Lisp functions in the command completion list.
If this variable is nil, Lisp completion can still be done in command
position by using M-TAB instead of TAB."
:type 'boolean
:group 'eshell-cmpl)
(defcustom eshell-show-lisp-alternatives t
"*If non-nil, and no other completions found, show Lisp functions.
"If non-nil, and no other completions found, show Lisp functions.
Setting this variable means nothing if `eshell-show-lisp-completions'
is non-nil."
:type 'boolean
:group 'eshell-cmpl)
(defcustom eshell-no-completion-during-jobs t
"*If non-nil, don't allow completion while a process is running."
"If non-nil, don't allow completion while a process is running."
:type 'boolean
:group 'eshell-cmpl)
......@@ -126,7 +126,7 @@ is non-nil."
("dbx" . "\\`\\([^.]*\\|a\\.out\\)\\'")
("sdb" . "\\`\\([^.]*\\|a\\.out\\)\\'")
("adb" . "\\`\\([^.]*\\|a\\.out\\)\\'"))
"*An alist that defines simple argument type correlations.
"An alist that defines simple argument type correlations.
This is provided for common commands, as a simplistic alternative
to writing a completion function."
:type '(repeat (cons string regexp))
......
......@@ -60,14 +60,14 @@ they lack somewhat in feel from the typical shell equivalents."
;;; User Variables:
(defcustom eshell-dirs-load-hook '(eshell-dirs-initialize)
"*A hook that gets run when `eshell-dirs' is loaded."
"A hook that gets run when `eshell-dirs' is loaded."
:type 'hook
:group 'eshell-dirs)
(defcustom eshell-pwd-convert-function (if (eshell-under-windows-p)
'expand-file-name
'identity)
"*The function used to normalize the value of Eshell's `pwd'.
"The function used to normalize the value of Eshell's `pwd'.
The value returned by `pwd' is also used when recording the
last-visited directory in the last-dir-ring, so it will affect the
form of the list used by 'cd ='."
......@@ -78,7 +78,7 @@ form of the list used by 'cd ='."
:group 'eshell-dirs)
(defcustom eshell-ask-to-save-last-dir 'always
"*Determine if the last-dir-ring should be automatically saved.
"Determine if the last-dir-ring should be automatically saved.
The last-dir-ring is always preserved when exiting an Eshell buffer.
However, when Emacs is being shut down, this variable determines
whether to prompt the user, or just save the ring.
......@@ -91,22 +91,22 @@ If set to `always', the list-dir-ring will always be saved, silently."
:group 'eshell-dirs)
(defcustom eshell-cd-shows-directory nil
"*If non-nil, using `cd' will report the directory it changes to."
"If non-nil, using `cd' will report the directory it changes to."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-cd-on-directory t
"*If non-nil, do a cd if a directory is in command position."
"If non-nil, do a cd if a directory is in command position."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-directory-change-hook nil
"*A hook to run when the current directory changes."
"A hook to run when the current directory changes."
:type 'hook
:group 'eshell-dirs)
(defcustom eshell-list-files-after-cd nil
"*If non-nil, call \"ls\" with any remaining args after doing a cd.
"If non-nil, call \"ls\" with any remaining args after doing a cd.
This is provided for convenience, since the same effect is easily
achieved by adding a function to `eshell-directory-change-hook' that
calls \"ls\" and references `eshell-last-arguments'."
......@@ -114,39 +114,39 @@ calls \"ls\" and references `eshell-last-arguments'."
:group 'eshell-dirs)
(defcustom eshell-pushd-tohome nil
"*If non-nil, make pushd with no arg behave as 'pushd ~' (like `cd').
"If non-nil, make pushd with no arg behave as 'pushd ~' (like `cd').
This mirrors the optional behavior of tcsh."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-pushd-dextract nil
"*If non-nil, make \"pushd +n\" pop the nth dir to the stack top.
"If non-nil, make \"pushd +n\" pop the nth dir to the stack top.
This mirrors the optional behavior of tcsh."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-pushd-dunique nil
"*If non-nil, make pushd only add unique directories to the stack.
"If non-nil, make pushd only add unique directories to the stack.
This mirrors the optional behavior of tcsh."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-dirtrack-verbose t
"*If non-nil, show the directory stack following directory change.
"If non-nil, show the directory stack following directory change.
This is effective only if directory tracking is enabled."
:type 'boolean
:group 'eshell-dirs)
(defcustom eshell-last-dir-ring-file-name
(expand-file-name "lastdir" eshell-directory-name)
"*If non-nil, name of the file to read/write the last-dir-ring.
"If non-nil, name of the file to read/write the last-dir-ring.
See also `eshell-read-last-dir-ring' and `eshell-write-last-dir-ring'.
If it is nil, the last-dir-ring will not be written to disk."
:type 'file
:group 'eshell-dirs)
(defcustom eshell-last-dir-ring-size 32
"*If non-nil, the size of the directory history ring.
"If non-nil, the size of the directory history ring.
This ring is added to every time `cd' or `pushd' is used. It simply
stores the most recent directory locations Eshell has been in. To
return to the most recent entry, use 'cd -' (equivalent to 'cd -0').
......@@ -167,7 +167,7 @@ thing again."
:group 'eshell-dirs)
(defcustom eshell-last-dir-unique t
"*If non-nil, `eshell-last-dir-ring' contains only unique entries."
"If non-nil, `eshell-last-dir-ring' contains only unique entries."
:type 'boolean
:group 'eshell-dirs)
......
......@@ -63,39 +63,39 @@ by zsh for filename generation."
;;; User Variables:
(defcustom eshell-glob-load-hook '(eshell-glob-initialize)
"*A list of functions to run when `eshell-glob' is loaded."
"A list of functions to run when `eshell-glob' is loaded."
:type 'hook
:group 'eshell-glob)
(defcustom eshell-glob-include-dot-files nil
"*If non-nil, glob patterns will match files beginning with a dot."
"If non-nil, glob patterns will match files beginning with a dot."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-glob-include-dot-dot t
"*If non-nil, glob patterns that match dots will match . and .."
"If non-nil, glob patterns that match dots will match . and .."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-glob-case-insensitive (eshell-under-windows-p)
"*If non-nil, glob pattern matching will ignore case."
"If non-nil, glob pattern matching will ignore case."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-glob-show-progress nil
"*If non-nil, display progress messages during a recursive glob.
"If non-nil, display progress messages during a recursive glob.
This option slows down recursive glob processing by quite a bit."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-error-if-no-glob nil
"*If non-nil, it is an error for a glob pattern not to match.
"If non-nil, it is an error for a glob pattern not to match.
This mimcs the behavior of zsh if non-nil, but bash if nil."
:type 'boolean
:group 'eshell-glob)
(defcustom eshell-glob-chars-list '(?\] ?\[ ?* ?? ?~ ?\( ?\) ?| ?# ?^)
"*List of additional characters used in extended globbing."
"List of additional characters used in extended globbing."
:type '(repeat character)
:group 'eshell-glob)
......@@ -117,7 +117,7 @@ This option slows down recursive glob processing by quite a bit."
(if (eq (aref str (1+ pos)) ?*)
"*" "+")) (+ pos 2))
(cons "*" (1+ pos))))))
"*An alist for translation of extended globbing characters."
"An alist for translation of extended globbing characters."
:type '(repeat (cons character (choice regexp function)))
:group 'eshell-glob)
......
......@@ -72,7 +72,7 @@
;;; User Variables:
(defcustom eshell-hist-load-hook '(eshell-hist-initialize)
"*A list of functions to call when loading `eshell-hist'."
"A list of functions to call when loading `eshell-hist'."
:type 'hook
:group 'eshell-hist)
......@@ -81,31 +81,31 @@
(function
(lambda ()
(remove-hook 'kill-emacs-hook 'eshell-save-some-history))))
"*A hook that gets run when `eshell-hist' is unloaded."
"A hook that gets run when `eshell-hist' is unloaded."
:type 'hook
:group 'eshell-hist)
(defcustom eshell-history-file-name
(expand-file-name "history" eshell-directory-name)
"*If non-nil, name of the file to read/write input history.
"If non-nil, name of the file to read/write input history.
See also `eshell-read-history' and `eshell-write-history'.
If it is nil, Eshell will use the value of HISTFILE."
:type 'file
:group 'eshell-hist)
(defcustom eshell-history-size 128
"*Size of the input history ring. If nil, use envvar HISTSIZE."
"Size of the input history ring. If nil, use envvar HISTSIZE."
:type 'integer
:group 'eshell-hist)
(defcustom eshell-hist-ignoredups nil
"*If non-nil, don't add input matching the last on the input ring.
"If non-nil, don't add input matching the last on the input ring.
This mirrors the optional behavior of bash."
:type 'boolean
:group 'eshell-hist)
(defcustom eshell-save-history-on-exit t
"*Determine if history should be automatically saved.
"Determine if history should be automatically saved.
History is always preserved after sanely exiting an Eshell buffer.
However, when Emacs is being shut down, this variable determines
whether to prompt the user.
......@@ -121,7 +121,7 @@ If set to t, history will always be saved, silently."
(function
(lambda (str)
(not (string-match "\\`\\s-*\\'" str))))
"*Predicate for filtering additions to input history.
"Predicate for filtering additions to input history.
Takes one argument, the input. If non-nil, the input may be saved on
the input history list. Default is to save anything that isn't all
whitespace."
......@@ -131,7 +131,7 @@ whitespace."
(put 'eshell-input-filter 'risky-local-variable t)
(defcustom eshell-hist-match-partial t
"*If non-nil, movement through history is constrained by current input.
"If non-nil, movement through history is constrained by current input.
Otherwise, typing <M-p> and <M-n> will always go to the next history
element, regardless of any text on the command line. In that case,
<C-c M-r> and <C-c M-s> still offer that functionality."
......@@ -139,25 +139,25 @@ element, regardless of any text on the command line. In that case,
:group 'eshell-hist)
(defcustom eshell-hist-move-to-end t
"*If non-nil, move to the end of the buffer before cycling history."
"If non-nil, move to the end of the buffer before cycling history."
:type 'boolean
:group 'eshell-hist)
(defcustom eshell-hist-event-designator
"^!\\(!\\|-?[0-9]+\\|\\??[^:^$%*?]+\\??\\|#\\)"
"*The regexp used to identifier history event designators."
"The regexp used to identifier history event designators."
:type 'regexp
:group 'eshell-hist)
(defcustom eshell-hist-word-designator
"^:?\\([0-9]+\\|[$^%*]\\)?\\(\\*\\|-[0-9]*\\|[$^%*]\\)?"
"*The regexp used to identify history word designators."
"The regexp used to identify history word designators."
:type 'regexp
:group 'eshell-hist)
(defcustom eshell-hist-modifier
"^\\(:\\([hretpqx&g]\\|s/\\([^/]*\\)/\\([^/]*\\)/\\)\\)*"
"*The regexp used to identity history modifiers."
"The regexp used to identity history modifiers."
:type 'regexp
:group 'eshell-hist)
......@@ -174,7 +174,7 @@ element, regardless of any text on the command line. In that case,
([(meta ?n)] . eshell-next-matching-input-from-input)
([up] . eshell-previous-matching-input-from-input)
([down] . eshell-next-matching-input-from-input))
"*History keys to bind differently if point is in input text."
"History keys to bind differently if point is in input text."
:type '(repeat (cons (vector :tag "Keys to bind"
(repeat :inline t sexp))
(function :tag "Command")))
......
......@@ -54,24 +54,24 @@ properties to colorize its output based on the setting of
(function
(lambda ()
(fset 'insert-directory eshell-ls-orig-insert-directory))))
"*When unloading `eshell-ls', restore the definition of `insert-directory'."
"When unloading `eshell-ls', restore the definition of `insert-directory'."
:type 'hook
:group 'eshell-ls)
(defcustom eshell-ls-initial-args nil
"*If non-nil, this list of args is included before any call to `ls'.
"If non-nil, this list of args is included before any call to `ls'.
This is useful for enabling human-readable format (-h), for example."
:type '(repeat :tag "Arguments" string)
:group 'eshell-ls)
(defcustom eshell-ls-dired-initial-args nil
"*If non-nil, args is included before any call to `ls' in Dired.
"If non-nil, args is included before any call to `ls' in Dired.
This is useful for enabling human-readable format (-h), for example."
:type '(repeat :tag "Arguments" string)
:group 'eshell-ls)
(defcustom eshell-ls-use-in-dired nil
"*If non-nil, use `eshell-ls' to read directories in Dired."
"If non-nil, use `eshell-ls' to read directories in Dired."
:set (lambda (symbol value)
(if value
(unless (and (boundp 'eshell-ls-use-in-dired)
......@@ -86,24 +86,24 @@ This is useful for enabling human-readable format (-h), for example."
:group 'eshell-ls)
(defcustom eshell-ls-default-blocksize 1024
"*The default blocksize to use when display file sizes with -s."
"The default blocksize to use when display file sizes with -s."
:type 'integer
:group 'eshell-ls)
(defcustom eshell-ls-exclude-regexp nil
"*Unless -a is specified, files matching this regexp will not be shown."
"Unless -a is specified, files matching this regexp will not be shown."
:type '(choice regexp (const nil))
:group 'eshell-ls)
(defcustom eshell-ls-exclude-hidden t
"*Unless -a is specified, files beginning with . will not be shown.
"Unless -a is specified, files beginning with . will not be shown.
Using this boolean, instead of `eshell-ls-exclude-regexp', is both
faster and conserves more memory."
:type 'boolean
:group 'eshell-ls)
(defcustom eshell-ls-use-colors t
"*If non-nil, use colors in file listings."
"If non-nil, use colors in file listings."
:type 'boolean
:group 'eshell-ls)
......@@ -111,7 +111,7 @@ faster and conserves more memory."
'((((class color) (background light)) (:foreground "Blue" :weight bold))
(((class color) (background dark)) (:foreground "SkyBlue" :weight bold))
(t (:weight bold)))
"*The face used for highlight directories."
"The face used for highlight directories."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-directory-face
'eshell-ls-directory "22.1")
......@@ -119,14 +119,14 @@ faster and conserves more memory."
(defface eshell-ls-symlink
'((((class color) (background light)) (:foreground "Dark Cyan" :weight bold))
(((class color) (background dark)) (:foreground "Cyan" :weight bold)))
"*The face used for highlight symbolic links."
"The face used for highlight symbolic links."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-symlink-face 'eshell-ls-symlink "22.1")
(defface eshell-ls-executable
'((((class color) (background light)) (:foreground "ForestGreen" :weight bold))
(((class color) (background dark)) (:foreground "Green" :weight bold)))
"*The face used for highlighting executables (not directories, though)."
"The face used for highlighting executables (not directories, though)."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-executable-face
'eshell-ls-executable "22.1")
......@@ -134,14 +134,14 @@ faster and conserves more memory."
(defface eshell-ls-readonly
'((((class color) (background light)) (:foreground "Brown"))
(((class color) (background dark)) (:foreground "Pink")))
"*The face used for highlighting read-only files."
"The face used for highlighting read-only files."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-readonly-face 'eshell-ls-readonly "22.1")
(defface eshell-ls-unreadable
'((((class color) (background light)) (:foreground "Grey30"))
(((class color) (background dark)) (:foreground "DarkGrey")))
"*The face used for highlighting unreadable files."
"The face used for highlighting unreadable files."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-unreadable-face
'eshell-ls-unreadable "22.1")
......@@ -149,21 +149,21 @@ faster and conserves more memory."
(defface eshell-ls-special
'((((class color) (background light)) (:foreground "Magenta" :weight bold))
(((class color) (background dark)) (:foreground "Magenta" :weight bold)))
"*The face used for highlighting non-regular files."
"The face used for highlighting non-regular files."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-special-face 'eshell-ls-special "22.1")
(defface eshell-ls-missing
'((((class color) (background light)) (:foreground "Red" :weight bold))
(((class color) (background dark)) (:foreground "Red" :weight bold)))
"*The face used for highlighting non-existent file names."
"The face used for highlighting non-existent file names."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-missing-face 'eshell-ls-missing "22.1")
(defcustom eshell-ls-archive-regexp
(concat "\\.\\(t\\(a[rz]\\|gz\\)\\|arj\\|lzh\\|"
"zip\\|[zZ]\\|gz\\|bz2\\|xz\\|deb\\|rpm\\)\\'")
"*A regular expression that matches names of file archives.
"A regular expression that matches names of file archives.
This typically includes both traditional archives and compressed
files."
:version "24.1" ; added xz
......@@ -173,26 +173,26 @@ files."
(defface eshell-ls-archive
'((((class color) (background light)) (:foreground "Orchid" :weight bold))
(((class color) (background dark)) (:foreground "Orchid" :weight bold)))
"*The face used for highlighting archived and compressed file names."
"The face used for highlighting archived and compressed file names."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-archive-face 'eshell-ls-archive "22.1")
(defcustom eshell-ls-backup-regexp
"\\(\\`\\.?#\\|\\(\\.bak\\|~\\)\\'\\)"
"*A regular expression that matches names of backup files."
"A regular expression that matches names of backup files."
:type 'regexp
:group 'eshell-ls)
(defface eshell-ls-backup
'((((class color) (background light)) (:foreground "OrangeRed"))
(((class color) (background dark)) (:foreground "LightSalmon")))
"*The face used for highlighting backup file names."
"The face used for highlighting backup file names."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-backup-face 'eshell-ls-backup "22.1")
(defcustom eshell-ls-product-regexp
"\\.\\(elc\\|o\\(bj\\)?\\|a\\|lib\\|res\\)\\'"
"*A regular expression that matches names of product files.
"A regular expression that matches names of product files.
Products are files that get generated from a source file, and hence
ought to be recreatable if they are deleted."
:type 'regexp
......@@ -201,13 +201,13 @@ ought to be recreatable if they are deleted."
(defface eshell-ls-product
'((((class color) (background light)) (:foreground "OrangeRed"))
(((class color) (background dark)) (:foreground "LightSalmon")))
"*The face used for highlighting files that are build products."
"The face used for highlighting files that are build products."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-product-face 'eshell-ls-product "22.1")
(defcustom eshell-ls-clutter-regexp
"\\(^texput\\.log\\|^core\\)\\'"
"*A regular expression that matches names of junk files.
"A regular expression that matches names of junk files.
These are mainly files that get created for various reasons, but don't
really need to stick around for very long."
:type 'regexp
......@@ -216,7 +216,7 @@ really need to stick around for very long."
(defface eshell-ls-clutter
'((((class color) (background light)) (:foreground "OrangeRed" :weight bold))
(((class color) (background dark)) (:foreground "OrangeRed" :weight bold)))
"*The face used for highlighting junk file names."
"The face used for highlighting junk file names."
:group 'eshell-ls)
(define-obsolete-face-alias 'eshell-ls-clutter-face 'eshell-ls-clutter "22.1")
......@@ -250,7 +250,7 @@ calling FUNC with FILE as an argument."
(,(eval func) ,file)))))
(defcustom eshell-ls-highlight-alist nil
"*This alist correlates test functions to color.
"This alist correlates test functions to color.
The format of the members of this alist is
(TEST-SEXP . FACE)
......
......@@ -61,7 +61,7 @@ ordinary strings."
;;; User Variables:
(defcustom eshell-pred-load-hook '(eshell-pred-initialize)
"*A list of functions to run when `eshell-pred' is loaded."
"A list of functions to run when `eshell-pred' is loaded."
:type 'hook
:group 'eshell-pred)
......@@ -101,7 +101,7 @@ ordinary strings."
(?m . (eshell-pred-file-time ?m "modification" 5))
(?c . (eshell-pred-file-time ?c "change" 6))
(?L . (eshell-pred-file-size)))
"*A list of predicates than can be applied to a globbing pattern.
"A list of predicates than can be applied to a globbing pattern.
The format of each entry is
(CHAR . PREDICATE-FUNC-SEXP)"
......@@ -150,7 +150,7 @@ The format of each entry is
(eshell-pred-substitute t)
(error "`g' modifier cannot be used alone"))))
(?s . (eshell-pred-substitute)))
"*A list of modifiers than can be applied to an argument expansion.
"A list of modifiers than can be applied to an argument expansion.
The format of each entry is
(CHAR ENTRYWISE-P MODIFIER-FUNC-SEXP)"
......
......@@ -39,7 +39,7 @@ as is common with most shells."
;;; User Variables:
(defcustom eshell-prompt-load-hook '(eshell-prompt-initialize)
"*A list of functions to call when loading `eshell-prompt'."
"A list of functions to call when loading `eshell-prompt'."
:type 'hook
:group 'eshell-prompt)
......@@ -55,7 +55,7 @@ prompt."
:group 'eshell-prompt)
(defcustom eshell-prompt-regexp "^[^#$\n]* [#$] "
"*A regexp which fully matches your eshell prompt.
"A regexp which fully matches your eshell prompt.
This setting is important, since it affects how eshell will interpret
the lines that are passed to it.
If this variable is changed, all Eshell buffers must be exited and
......@@ -64,7 +64,7 @@ re-entered for it to take effect."
:group 'eshell-prompt)
(defcustom eshell-highlight-prompt t
"*If non-nil, Eshell should highlight the prompt."
"If non-nil, Eshell should highlight the prompt."
:type 'boolean
:group 'eshell-prompt)
......@@ -72,20 +72,20 @@ re-entered for it to take effect."
'((((class color) (background light)) (:foreground "Red" :bold t))
(((class color) (background dark)) (:foreground "Pink" :bold t))
(t (:bold t)))
"*The face used to highlight prompt strings.
"The face used to highlight prompt strings.
For highlighting other kinds of strings -- similar to shell mode's
behavior -- simply use an output filer which changes text properties."
:group 'eshell-prompt)
(define-obsolete-face-alias 'eshell-prompt-face 'eshell-prompt "22.1")
(defcustom eshell-before-prompt-hook nil
"*A list of functions to call before outputting the prompt."
"A list of functions to call before outputting the prompt."
:type 'hook
:options '(eshell-begin-on-new-line)
:group 'eshell-prompt)
(defcustom eshell-after-prompt-hook nil
"*A list of functions to call after outputting the prompt.
"A list of functions to call after outputting the prompt.