diff options
| author | Jim Porter | 2023-08-15 18:51:20 -0700 |
|---|---|---|
| committer | Jim Porter | 2024-02-04 21:12:42 -0800 |
| commit | 5c43ef86bf169a79b87bd082d2f884757f7c2efc (patch) | |
| tree | 67af86528581973610588dee645dbc395bf5ded8 /lisp/eshell | |
| parent | be6de56906f0d1c09a0fad4f5165d864dddbc3ee (diff) | |
| download | emacs-5c43ef86bf169a79b87bd082d2f884757f7c2efc.tar.gz emacs-5c43ef86bf169a79b87bd082d2f884757f7c2efc.zip | |
Document arguments to Eshell's built-in commands
* lisp/eshell/em-unix.el (eshell/ln): LINK_NAME is required.
* lisp/eshell/esh-ext.el (eshell/addpath):
* lisp/eshell/esh-var.el (eshell/env): Improve help strings slightly.
* doc/misc/eshell.texi (Scripts): Explain $0, $1, etc.
(Dollars Expansion): Use "@dots{}" instead of "...".
(Built-ins, Tramp extensions, Extra built-in commands): Document
command-line arguments.
Diffstat (limited to 'lisp/eshell')
| -rw-r--r-- | lisp/eshell/em-unix.el | 8 | ||||
| -rw-r--r-- | lisp/eshell/esh-ext.el | 6 | ||||
| -rw-r--r-- | lisp/eshell/esh-var.el | 2 |
3 files changed, 8 insertions, 8 deletions
diff --git a/lisp/eshell/em-unix.el b/lisp/eshell/em-unix.el index 78dfd0654e2..23028576f45 100644 --- a/lisp/eshell/em-unix.el +++ b/lisp/eshell/em-unix.el | |||
| @@ -618,11 +618,11 @@ Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.") | |||
| 618 | :preserve-args | 618 | :preserve-args |
| 619 | :external "ln" | 619 | :external "ln" |
| 620 | :show-usage | 620 | :show-usage |
| 621 | :usage "[OPTION]... TARGET [LINK_NAME] | 621 | :usage "[OPTION]... TARGET LINK_NAME |
| 622 | or: ln [OPTION]... TARGET... DIRECTORY | 622 | or: ln [OPTION]... TARGET... DIRECTORY |
| 623 | Create a link to the specified TARGET with optional LINK_NAME. If there is | 623 | Create a link to the specified TARGET with LINK_NAME. If there is more |
| 624 | more than one TARGET, the last argument must be a directory; create links | 624 | than one TARGET, the last argument must be a directory; create links in |
| 625 | in DIRECTORY to each TARGET. Create hard links by default, symbolic links | 625 | DIRECTORY to each TARGET. Create hard links by default, symbolic links |
| 626 | with `--symbolic'. When creating hard links, each TARGET must exist.") | 626 | with `--symbolic'. When creating hard links, each TARGET must exist.") |
| 627 | (let ((no-dereference t)) | 627 | (let ((no-dereference t)) |
| 628 | (eshell-mvcpln-template "ln" "linking" | 628 | (eshell-mvcpln-template "ln" "linking" |
diff --git a/lisp/eshell/esh-ext.el b/lisp/eshell/esh-ext.el index dc2b93e574b..44861c222b8 100644 --- a/lisp/eshell/esh-ext.el +++ b/lisp/eshell/esh-ext.el | |||
| @@ -253,10 +253,10 @@ An external command simply means external to Emacs." | |||
| 253 | "Add a set of paths to PATH." | 253 | "Add a set of paths to PATH." |
| 254 | (eshell-eval-using-options | 254 | (eshell-eval-using-options |
| 255 | "addpath" args | 255 | "addpath" args |
| 256 | '((?b "begin" nil prepend "add path element at beginning") | 256 | '((?b "begin" nil prepend "add to beginning of $PATH") |
| 257 | (?h "help" nil nil "display this usage message") | 257 | (?h "help" nil nil "display this usage message") |
| 258 | :usage "[-b] PATH | 258 | :usage "[-b] DIR... |
| 259 | Adds the given PATH to $PATH.") | 259 | Adds the given DIR to $PATH.") |
| 260 | (let ((path (eshell-get-path t))) | 260 | (let ((path (eshell-get-path t))) |
| 261 | (if args | 261 | (if args |
| 262 | (progn | 262 | (progn |
diff --git a/lisp/eshell/esh-var.el b/lisp/eshell/esh-var.el index 537bc4b0641..02b5c785625 100644 --- a/lisp/eshell/esh-var.el +++ b/lisp/eshell/esh-var.el | |||
| @@ -433,7 +433,7 @@ the values of nil for each." | |||
| 433 | (?h "help" nil nil "show this usage screen") | 433 | (?h "help" nil nil "show this usage screen") |
| 434 | :external "env" | 434 | :external "env" |
| 435 | :parse-leading-options-only | 435 | :parse-leading-options-only |
| 436 | :usage "[NAME=VALUE]... [COMMAND [ARG]...]") | 436 | :usage "[NAME=VALUE]... [COMMAND]...") |
| 437 | (if args | 437 | (if args |
| 438 | (or (eshell-parse-local-variables args) | 438 | (or (eshell-parse-local-variables args) |
| 439 | (eshell-named-command (car args) (cdr args))) | 439 | (eshell-named-command (car args) (cdr args))) |