aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2021-12-05 12:12:00 +0200
committerEli Zaretskii2021-12-05 12:12:00 +0200
commitbf869aa698a3c7f09cf9614b80906fcb4d343aba (patch)
treec9c9e61bd64c93233b30abccf961e6fe5032bdb7
parent520a703fa7db07ba82661e68cf4eafe7ba61a8d0 (diff)
downloademacs-bf869aa698a3c7f09cf9614b80906fcb4d343aba.tar.gz
emacs-bf869aa698a3c7f09cf9614b80906fcb4d343aba.zip
; * doc/misc/eshell.texi (Built-ins): Improve markup, fix typos.
-rw-r--r--doc/misc/eshell.texi61
1 files changed, 39 insertions, 22 deletions
diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi
index ef82c889a6e..4e5288ea6d8 100644
--- a/doc/misc/eshell.texi
+++ b/doc/misc/eshell.texi
@@ -317,27 +317,36 @@ command reverts to the system's definition of @command{cat}.
317@item cd 317@item cd
318@cmindex cd 318@cmindex cd
319This command changes the current working directory. Usually, it is 319This command changes the current working directory. Usually, it is
320invoked as @samp{cd foo} where @file{foo} is the new working directory. 320invoked as @kbd{cd @var{dir}} where @file{@var{dir}} is the new
321But @command{cd} knows about a few special arguments: 321working directory. But @command{cd} knows about a few special
322arguments:
322 323
324@itemize @minus{}
325@item
323When it receives no argument at all, it changes to the home directory. 326When it receives no argument at all, it changes to the home directory.
324 327
325Giving the command @samp{cd -} changes back to the previous working 328@item
326directory (this is the same as @samp{cd $-}). 329Giving the command @kbd{cd -} changes back to the previous working
330directory (this is the same as @kbd{cd $-}).
327 331
328The command @samp{cd =} shows the directory stack. Each line is 332@item
333The command @kbd{cd =} shows the directory stack. Each line is
329numbered. 334numbered.
330 335
331With @samp{cd =foo}, Eshell searches the directory stack for a directory 336@item
332matching the regular expression @samp{foo} and changes to that 337With @kbd{cd =foo}, Eshell searches the directory stack for a directory
338matching the regular expression @samp{foo}, and changes to that
333directory. 339directory.
334 340
335With @samp{cd -42}, you can access the directory stack by number. 341@item
342With @kbd{cd -42}, you can access the directory stack slots by number.
336 343
344@item
337If @code{eshell-cd-shows-directory} is non-@code{nil}, @command{cd} 345If @code{eshell-cd-shows-directory} is non-@code{nil}, @command{cd}
338will report the directory it changes to. If 346will report the directory it changes to. If
339@code{eshell-list-files-after-cd} is non-@code{nil}, then @command{ls} 347@code{eshell-list-files-after-cd} is non-@code{nil}, then @command{ls}
340is called with any remaining arguments after changing directories. 348is called with any remaining arguments after changing directories.
349@end itemize
341 350
342@item clear 351@item clear
343@cmindex clear 352@cmindex clear
@@ -398,7 +407,7 @@ Summarize disk usage for each file.
398 407
399@item echo 408@item echo
400@cmindex echo 409@cmindex echo
401Echos its input. If @code{eshell-plain-echo-behavior} is 410Echoes its input. If @code{eshell-plain-echo-behavior} is
402non-@code{nil}, @command{echo} will try to behave more like a plain 411non-@code{nil}, @command{echo} will try to behave more like a plain
403shell's @command{echo}. 412shell's @command{echo}.
404 413
@@ -461,7 +470,8 @@ reader.
461 470
462@item intersection 471@item intersection
463@cmindex intersection 472@cmindex intersection
464A wrapper around the function @code{cl-intersection}. This command 473A wrapper around the function @code{cl-intersection} (@pxref{Lists as
474Sets,,, cl, GNU Emacs Common Lisp Emulation}). This command
465can be used for comparing lists of strings. 475can be used for comparing lists of strings.
466 476
467This command can be loaded as part of the eshell-xtra module, which is 477This command can be loaded as part of the eshell-xtra module, which is
@@ -509,11 +519,12 @@ Lists the contents of directories.
509If @code{eshell-ls-use-colors} is non-@code{nil}, the contents of a 519If @code{eshell-ls-use-colors} is non-@code{nil}, the contents of a
510directory is color-coded according to file type and status. These 520directory is color-coded according to file type and status. These
511colors and the regexps used to identify their corresponding files can 521colors and the regexps used to identify their corresponding files can
512be customized via @samp{M-x customize-group RET eshell-ls RET}. 522be customized via @w{@kbd{M-x customize-group @key{RET} eshell-ls @key{RET}}}.
513 523
514The user option @code{eshell-ls-date-format} determines how the date 524The user option @code{eshell-ls-date-format} determines how the date
515is displayed when using the @option{-l} option. The date is produced 525is displayed when using the @option{-l} option. The date is produced
516using the function @code{format-time-string}. 526using the function @code{format-time-string} (@pxref{Time Parsing,,,
527elisp, GNU Emacs Lisp Reference Manual}).
517 528
518The user option @code{eshell-ls-initial-args} contains a list of 529The user option @code{eshell-ls-initial-args} contains a list of
519arguments to include with any call to @command{ls}. For example, you 530arguments to include with any call to @command{ls}. For example, you
@@ -537,8 +548,9 @@ Display Man pages using the Emacs @code{man} command.
537 548
538@item mismatch 549@item mismatch
539@cmindex mismatch 550@cmindex mismatch
540A wrapper around the function @code{cl-mismatch}. This command can be 551A wrapper around the function @code{cl-mismatch} (@pxref{Searching
541used for comparing lists of strings. 552Sequences,,, cl, GNU Emacs Common Lisp Emulation}). This command can
553be used for comparing lists of strings.
542 554
543This command can be loaded as part of the eshell-xtra module, which is 555This command can be loaded as part of the eshell-xtra module, which is
544disabled by default. 556disabled by default.
@@ -572,8 +584,8 @@ Print the arguments separated by newlines.
572 584
573@item pushd 585@item pushd
574@cmindex pushd 586@cmindex pushd
575Change to a directory and push that directory onto the directory 587Push the current directory onto the directory stack, then change to
576stack. 588another directory.
577 589
578If @code{eshell-pushd-dunique} is non-@code{nil}, then only unique 590If @code{eshell-pushd-dunique} is non-@code{nil}, then only unique
579directories will be added to the stack. If 591directories will be added to the stack. If
@@ -601,7 +613,8 @@ Removes directories if they are empty.
601 613
602@item set-difference 614@item set-difference
603@cmindex set-difference 615@cmindex set-difference
604A wrapper around the function @code{cl-set-difference}. This command 616A wrapper around the function @code{cl-set-difference} (@pxref{Lists as
617Sets,,, cl, GNU Emacs Common Lisp Emulation}). This command
605can be used for comparing lists of strings. 618can be used for comparing lists of strings.
606 619
607This command can be loaded as part of the eshell-xtra module, which is 620This command can be loaded as part of the eshell-xtra module, which is
@@ -609,8 +622,9 @@ disabled by default.
609 622
610@item set-exclusive-or 623@item set-exclusive-or
611@cmindex set-exclusive-or 624@cmindex set-exclusive-or
612A wrapper around the function @code{cl-set-exclusive-or}. This 625A wrapper around the function @code{cl-set-exclusive-or} (@pxref{Lists
613command can be used for comparing lists of strings. 626as Sets,,, cl, GNU Emacs Common Lisp Emulation}). This command can be
627used for comparing lists of strings.
614 628
615This command can be loaded as part of the eshell-xtra module, which is 629This command can be loaded as part of the eshell-xtra module, which is
616disabled by default. 630disabled by default.
@@ -618,6 +632,7 @@ disabled by default.
618@item setq 632@item setq
619@cmindex setq 633@cmindex setq
620Set variable values, using the function @code{setq} like a command. 634Set variable values, using the function @code{setq} like a command.
635@xref{Setting variables,,, elisp, GNU Emacs Lisp Reference Manual}.
621 636
622@item source 637@item source
623@cmindex source 638@cmindex source
@@ -636,7 +651,8 @@ are in the eshell-tramp module, which is disabled by default.
636 651
637@item substitute 652@item substitute
638@cmindex substitute 653@cmindex substitute
639A wrapper around the function @code{cl-substitute}. This command can 654A wrapper around the function @code{cl-substitute} (@pxref{Sequence
655Functions,,, cl, GNU Emacs Common Lisp Emulation}). This command can
640be used for comparing lists of strings. 656be used for comparing lists of strings.
641 657
642This command can be loaded as part of the eshell-xtra module, which is 658This command can be loaded as part of the eshell-xtra module, which is
@@ -653,8 +669,9 @@ directories.
653 669
654@item union 670@item union
655@cmindex union 671@cmindex union
656A wrapper around the function @code{cl-union}. This command can be 672A wrapper around the function @code{cl-union} (@pxref{Lists as Sets,,,
657used for comparing lists of strings. 673cl, GNU Emacs Common Lisp Emulation}). This command can be used for
674comparing lists of strings.
658 675
659This command can be loaded as part of the eshell-xtra module, which is 676This command can be loaded as part of the eshell-xtra module, which is
660disabled by default. 677disabled by default.