lisp/eshell/esh-groups.el

   1 ;;; do not modify this file; it is auto-generated
   2
   3 (defgroup eshell-alias nil
   4   "Command aliases allow for easy definition of alternate commands."
   5   :tag "Command aliases"
   6   :link '(info-link "(eshell)Command aliases")
   7   :group 'eshell-module)
   8
   9 (defgroup eshell-banner nil
  10   "This sample module displays a welcome banner at login.
  11 It exists so that others wishing to create their own Eshell extension
  12 modules may have a simple template to begin with."
  13   :tag "Login banner"
  14   :link '(info-link "(eshell)Login banner")
  15   :group 'eshell-module)
  16
  17 (defgroup eshell-basic nil
  18   "The \"basic\" code provides a set of convenience functions which
  19 are traditionally considered shell builtins.  Since all of the
  20 functionality provided by them is accessible through Lisp, they are
  21 not really builtins at all, but offer a command-oriented way to do the
  22 same thing."
  23   :tag "Basic shell commands"
  24   :group 'eshell-module)
  25
  26 (defgroup eshell-cmpl nil
  27   "This module provides a programmable completion function bound to
  28 the TAB key, which allows for completing command names, file names,
  29 variable names, arguments, etc."
  30   :tag "Argument completion"
  31   :group 'eshell-module)
  32
  33 (defgroup eshell-dirs nil
  34   "Directory navigation involves changing directories, examining the
  35 current directory, maintaining a directory stack, and also keeping
  36 track of a history of the last directory locations the user was in.
  37 Emacs does provide standard Lisp definitions of `pwd' and `cd', but
  38 they lack somewhat in feel from the typical shell equivalents."
  39   :tag "Directory navigation"
  40   :group 'eshell-module)
  41
  42 (defgroup eshell-glob nil
  43   "This module provides extended globbing syntax, similar what is used
  44 by zsh for filename generation."
  45   :tag "Extended filename globbing"
  46   :group 'eshell-module)
  47
  48 (defgroup eshell-hist nil
  49   "This module provides command history management."
  50   :tag "History list management"
  51   :group 'eshell-module)
  52
  53 (defgroup eshell-ls nil
  54   "This module implements the \"ls\" utility fully in Lisp.  If it is
  55 passed any unrecognized command switches, it will revert to the
  56 operating system's version.  This version of \"ls\" uses text
  57 properties to colorize its output based on the setting of
  58 `eshell-ls-use-colors'."
  59   :tag "Implementation of `ls' in Lisp"
  60   :group 'eshell-module)
  61
  62 (defgroup eshell-pred nil
  63   "This module allows for predicates to be applied to globbing
  64 patterns (similar to zsh), in addition to string modifiers which can
  65 be applied either to globbing results, variable references, or just
  66 ordinary strings."
  67   :tag "Value modifiers and predicates"
  68   :group 'eshell-module)
  69
  70 (defgroup eshell-prompt nil
  71   "This module provides command prompts, and navigation between them,
  72 as is common with most shells."
  73   :tag "Command prompts"
  74   :group 'eshell-module)
  75
  76 (defgroup eshell-rebind nil
  77   "This module allows for special keybindings that only take effect
  78 while the point is in a region of input text.  By default, it binds
  79 C-a to move to the beginning of the input text (rather than just the
  80 beginning of the line), and C-p and C-n to move through the input
  81 history, C-u kills the current input text, etc.  It also, if
  82 `eshell-confine-point-to-input' is non-nil, does not allow certain
  83 commands to cause the point to leave the input area, such as
  84 `backward-word', `previous-line', etc.  This module intends to mimic
  85 the behavior of normal shells while the user editing new input text."
  86   :tag "Rebind keys at input"
  87   :group 'eshell-module)
  88
  89 (defgroup eshell-script nil
  90   "This module allows for the execution of files containing Eshell
  91 commands, as a script file."
  92   :tag "Running script files."
  93   :group 'eshell-module)
  94
  95 (defgroup eshell-smart nil
  96   "This module combines the facility of normal, modern shells with
  97 some of the edit/review concepts inherent in the design of Plan 9's
  98 9term.  See the docs for more details.
  99
 100 Most likely you will have to turn this option on and play around with
 101 it to get a real sense of how it works."
 102   :tag "Smart display of output"
 103   :link '(info-link "(eshell)Smart display of output")
 104   :group 'eshell-module)
 105
 106 (defgroup eshell-term nil
 107   "This module causes visual commands (e.g., 'vi') to be executed by
 108 the `term' package, which comes with Emacs.  This package handles most
 109 of the ANSI control codes, allowing curses-based applications to run
 110 within an Emacs window.  The variable `eshell-visual-commands' defines
 111 which commands are considered visual in nature."
 112   :tag "Running visual commands"
 113   :group 'eshell-module)
 114
 115 (defgroup eshell-unix nil
 116   "This module defines many of the more common UNIX utilities as
 117 aliases implemented in Lisp.  These include mv, ln, cp, rm, etc.  If
 118 the user passes arguments which are too complex, or are unrecognized
 119 by the Lisp variant, the external version will be called (if
 120 available).  The only reason not to use them would be because they are
 121 usually much slower.  But in several cases their tight integration
 122 with Eshell makes them more versatile than their traditional cousins
 123 \(such as being able to use `kill' to kill Eshell background processes
 124 by name)."
 125   :tag "UNIX commands in Lisp"
 126   :group 'eshell-module)
 127
 128 (defgroup eshell-xtra nil
 129   "This module defines some extra alias functions which are entirely
 130 optional.  They can be viewed as samples for how to write Eshell alias
 131 functions, or as aliases which make some of Emacs' behavior more
 132 naturally accessible within Emacs."
 133   :tag "Extra alias functions"
 134   :group 'eshell-module)
 135