| 1 | \input texinfo @c -*-texinfo-*- |
| 2 | @c %**start of header |
| 3 | @setfilename ../info/eshell |
| 4 | @settitle Eshell: The Emacs Shell |
| 5 | @synindex vr fn |
| 6 | @c %**end of header |
| 7 | |
| 8 | @copying |
| 9 | This manual is for Eshell, the Emacs shell. |
| 10 | |
| 11 | Copyright @copyright{} 1999, 2000, 2001, 2002, 2004 Free Software Foundation, Inc. |
| 12 | |
| 13 | @quotation |
| 14 | Permission is granted to copy, distribute and/or modify this document |
| 15 | under the terms of the GNU Free Documentation License, Version 1.1 or |
| 16 | any later version published by the Free Software Foundation; with no |
| 17 | Invariant Sections, with the Front-Cover texts being ``A GNU |
| 18 | Manual'', and with the Back-Cover Texts as in (a) below. A copy of the |
| 19 | license is included in the section entitled ``GNU Free Documentation |
| 20 | License'' in the Emacs manual. |
| 21 | |
| 22 | (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
| 23 | this GNU Manual, like GNU software. Copies published by the Free |
| 24 | Software Foundation raise funds for GNU development.'' |
| 25 | |
| 26 | This document is part of a collection distributed under the GNU Free |
| 27 | Documentation License. If you want to distribute this document |
| 28 | separately from the collection, you can do so by adding a copy of the |
| 29 | license to the document, as described in section 6 of the license. |
| 30 | @end quotation |
| 31 | @end copying |
| 32 | |
| 33 | @dircategory Emacs |
| 34 | @direntry |
| 35 | * Eshell: (eshell). A command shell implemented in Emacs Lisp. |
| 36 | @end direntry |
| 37 | |
| 38 | @setchapternewpage on |
| 39 | |
| 40 | @titlepage |
| 41 | @sp 4 |
| 42 | @c The title is printed in a large font. |
| 43 | @center @titlefont{User's Guide} |
| 44 | @sp |
| 45 | @center @titlefont{to} |
| 46 | @sp |
| 47 | @center @titlefont{Eshell: The Emacs Shell} |
| 48 | @ignore |
| 49 | @sp 2 |
| 50 | @center release 2.4 |
| 51 | @c -release- |
| 52 | @end ignore |
| 53 | @sp 3 |
| 54 | @center John Wiegley |
| 55 | @c -date- |
| 56 | |
| 57 | @page |
| 58 | @vskip 0pt plus 1filll |
| 59 | @insertcopying |
| 60 | @end titlepage |
| 61 | |
| 62 | @contents |
| 63 | |
| 64 | @c ================================================================ |
| 65 | @c The real text starts here |
| 66 | @c ================================================================ |
| 67 | |
| 68 | @ifnottex |
| 69 | @node Top, What is Eshell?, (dir), (dir) |
| 70 | @top Eshell |
| 71 | |
| 72 | This manual documents Eshell, a shell-like command interpretor |
| 73 | implemented in Emacs Lisp. It invokes no external processes except for |
| 74 | those requested by the user. It is intended to be a functional |
| 75 | replacement for command shells such as @command{bash}, @command{zsh}, |
| 76 | @command{rc}, or @command{4dos}; since Emacs itself is capable of |
| 77 | handling the sort of tasks accomplished by those tools. |
| 78 | @c This manual is updated to release 2.4 of Eshell. |
| 79 | @end ifnottex |
| 80 | |
| 81 | @menu |
| 82 | * What is Eshell?:: A brief introduction to the Emacs Shell. |
| 83 | * Installation:: For users of Emacs 20 and XEmacs. |
| 84 | * Command basics:: The basics of command usage. |
| 85 | * Commands:: |
| 86 | * Arguments:: |
| 87 | * Input/Output:: |
| 88 | * Process control:: |
| 89 | * Extension modules:: |
| 90 | * Extras and Goodies:: |
| 91 | * Bugs and ideas:: Known problems, and future ideas. |
| 92 | * Concept Index:: |
| 93 | * Function and Variable Index:: |
| 94 | * Key Index:: |
| 95 | @end menu |
| 96 | |
| 97 | @node What is Eshell? |
| 98 | @chapter What is Eshell? |
| 99 | @cindex what is Eshell? |
| 100 | @cindex Eshell, what it is |
| 101 | |
| 102 | Eshell is a @dfn{command shell} written in Emacs Lisp. Everything it |
| 103 | does, it uses Emacs' facilities to do. This means that Eshell is as |
| 104 | portable as Emacs itself. It also means that cooperation with Lisp code |
| 105 | is natural and seamless. |
| 106 | |
| 107 | What is a command shell? To properly understand the role of a shell, |
| 108 | it's necessary to visualize what a computer does for you. Basically, a |
| 109 | computer is a tool; in order to use that tool, you must tell it what to |
| 110 | do---or give it ``commands.'' These commands take many forms, such as |
| 111 | clicking with a mouse on certain parts of the screen. But that is only |
| 112 | one form of command input. |
| 113 | |
| 114 | By far the most versatile way to express what you want the computer to |
| 115 | do is by using an abbreviated language called @dfn{script}. In |
| 116 | script, instead of telling the computer, ``list my files, please'', |
| 117 | one writes a standard abbreviated command word---@samp{ls}. Typing |
| 118 | @samp{ls} in a command shell is a script way of telling the computer |
| 119 | to list your files.@footnote{This is comparable to viewing the |
| 120 | contents of a folder using a graphical display.} |
| 121 | |
| 122 | The real flexibility of this approach is apparent only when you realize |
| 123 | that there are many, many different ways to list files. Perhaps you |
| 124 | want them sorted by name, sorted by date, in reverse order, or grouped |
| 125 | by type. Most graphical browsers have simple ways to express this. But |
| 126 | what about showing only a few files, or only files that meet a certain |
| 127 | criteria? In very complex and specific situations, the request becomes |
| 128 | too difficult to express using a mouse or pointing device. It is just |
| 129 | these kinds of requests that are easily solved using a command shell. |
| 130 | |
| 131 | For example, what if you want to list every Word file on your hard |
| 132 | drive, larger than 100 kilobytes in size, and which hasn't been looked |
| 133 | at in over six months? That is a good candidate list for deletion, when |
| 134 | you go to clean up your hard drive. But have you ever tried asking your |
| 135 | computer for such a list? There is no way to do it! At least, not |
| 136 | without using a command shell. |
| 137 | |
| 138 | The role of a command shell is to give you more control over what your |
| 139 | computer does for you. Not everyone needs this amount of control, and |
| 140 | it does come at a cost: Learning the necessary script commands to |
| 141 | express what you want done. A complicated query, such as the example |
| 142 | above, takes time to learn. But if you find yourself using your |
| 143 | computer frequently enough, it is more than worthwhile in the long run. |
| 144 | Any tool you use often deserves the time spent learning to master it. |
| 145 | @footnote{For the understandably curious, here is what that command |
| 146 | looks like: But don't let it fool you; once you know what's going on, |
| 147 | it's easier than it looks: @code{ls -lt **/*.doc(Lk+50aM+5)}.} |
| 148 | |
| 149 | As of Emacs 21, Eshell is part of the standard Emacs distribution. |
| 150 | |
| 151 | @menu |
| 152 | * Contributors to Eshell:: People who have helped out! |
| 153 | @end menu |
| 154 | |
| 155 | @node Contributors to Eshell |
| 156 | @section Contributors to Eshell |
| 157 | @cindex contributors |
| 158 | @cindex authors |
| 159 | |
| 160 | Contributions to Eshell are welcome. I have limited time to work on |
| 161 | this project, but I will gladly add any code you contribute to me to |
| 162 | this package. |
| 163 | |
| 164 | The following persons have made contributions to Eshell. |
| 165 | |
| 166 | @itemize @bullet |
| 167 | @item |
| 168 | Eli Zaretskii made it possible for Eshell to run without requiring |
| 169 | asynchronous subprocess support. This is important for MS-DOS, which |
| 170 | does not have such support.@refill |
| 171 | |
| 172 | @item |
| 173 | Miles Bader contributed many fixes during the port to Emacs 21.@refill |
| 174 | |
| 175 | @item |
| 176 | Stefan Monnier fixed the things which bothered him, which of course made |
| 177 | things better for all.@refill |
| 178 | |
| 179 | @item |
| 180 | Gerd Moellmann also helped to contribute bug fixes during the initial |
| 181 | integration with Emacs 21.@refill |
| 182 | |
| 183 | @item |
| 184 | Alex Schroeder contributed code for interactively querying the user |
| 185 | before overwriting files.@refill |
| 186 | |
| 187 | @item |
| 188 | Sudish Joseph helped with some XEmacs compatibility issues.@refill |
| 189 | @end itemize |
| 190 | |
| 191 | Apart from these, a lot of people have sent suggestions, ideas, |
| 192 | requests, bug reports and encouragement. Thanks a lot! Without you |
| 193 | there would be no new releases of Eshell. |
| 194 | |
| 195 | @node Installation |
| 196 | @chapter Installation |
| 197 | @cindex installation |
| 198 | |
| 199 | As mentioned above, Eshell comes preinstalled as of Emacs 21. If you're |
| 200 | using Emacs 20.4 or later, or XEmacs 21, you can download the most |
| 201 | recent version of Eshell from |
| 202 | @url{http://www.gci-net.com/users/j/johnw/Emacs/packages/eshell.tar.gz}. |
| 203 | |
| 204 | However, if you are using Emacs 21, you may skip this section. |
| 205 | |
| 206 | @section Short Form |
| 207 | |
| 208 | Here's exactly what to do, with no explanation why: |
| 209 | |
| 210 | @enumerate |
| 211 | @item |
| 212 | @samp{M-x load-file RET eshell-auto.el RET}. |
| 213 | |
| 214 | @item |
| 215 | @samp{ESC : (add-to-list 'load-path "<path where Eshell resides>") RET}. |
| 216 | |
| 217 | @item |
| 218 | @samp{ESC : (add-to-list 'load-path "<path where Pcomplete resides>") RET}. |
| 219 | |
| 220 | @item |
| 221 | @samp{M-x eshell RET}. |
| 222 | |
| 223 | You should see a version banner displayed. |
| 224 | |
| 225 | @item |
| 226 | @samp{ls RET}. |
| 227 | |
| 228 | Confirm that you see a file listing. |
| 229 | |
| 230 | @item |
| 231 | @samp{eshell-test RET}. |
| 232 | |
| 233 | Confirm that everything runs correctly. Use @kbd{M-x eshell-report-bug} if |
| 234 | not. |
| 235 | |
| 236 | @item |
| 237 | @samp{cd $@{dirname (locate-library "eshell-auto")@} RET}. |
| 238 | |
| 239 | @item |
| 240 | @samp{find-file Makefile RET}. |
| 241 | |
| 242 | @item |
| 243 | Edit the Makefile to reflect your site. |
| 244 | |
| 245 | @item |
| 246 | @samp{M-x eshell RET}. |
| 247 | |
| 248 | @item |
| 249 | @samp{make install RET}. |
| 250 | |
| 251 | @item |
| 252 | @samp{find-file $user-init-file RET}. |
| 253 | |
| 254 | @item |
| 255 | Add the following lines to your @file{.emacs} file: |
| 256 | |
| 257 | @example |
| 258 | (add-to-list 'load-path "<directory where you install Eshell>") |
| 259 | (load "eshell-auto") |
| 260 | @end example |
| 261 | |
| 262 | @item |
| 263 | @samp{M-x eshell RET}. |
| 264 | |
| 265 | @item |
| 266 | @samp{customize-option #'eshell-modules-list RET}. |
| 267 | |
| 268 | @item |
| 269 | Select the extension modules you prefer. |
| 270 | |
| 271 | @item |
| 272 | Restart Emacs! |
| 273 | |
| 274 | @item |
| 275 | @samp{M-x info RET m Eshell RET}. |
| 276 | |
| 277 | Read the manual and enjoy! |
| 278 | @end enumerate |
| 279 | |
| 280 | @section Long Form |
| 281 | |
| 282 | @enumerate |
| 283 | @item |
| 284 | Before building and installing Eshell, it is important to test that it |
| 285 | will work properly on your system. To do this, first load the file |
| 286 | @file{eshell-auto}, which will define certain autoloads required to run |
| 287 | Eshell. This can be done using the command @kbd{M-x load-file}, and |
| 288 | then selecting the file @file{eshell-auto.el}. |
| 289 | |
| 290 | @item |
| 291 | In order for Emacs to find Eshell's files, the Eshell directory must be |
| 292 | added to the @code{load-path} variable. This can be done within Emacs by |
| 293 | typing: |
| 294 | |
| 295 | @example |
| 296 | ESC : (add-to-list 'load-path "<path where Eshell resides>") RET |
| 297 | ESC : (add-to-list 'load-path "<path where Pcomplete resides>") RET |
| 298 | @end example |
| 299 | |
| 300 | @item |
| 301 | Start Eshell from the distributed sources, using default settings, by |
| 302 | typing @kbd{M-x eshell}. |
| 303 | |
| 304 | @item |
| 305 | Verify that Eshell is functional by typing @command{ls} followed by |
| 306 | @key{RET}. You should have already seen a version banner announcing the |
| 307 | version number of this release, followed by a prompt. |
| 308 | |
| 309 | @item |
| 310 | Run the test suite by typing @command{eshell-test} followed by @key{RET} |
| 311 | in the Eshell buffer. It is important that Emacs be left alone while |
| 312 | the tests are running, since extraneous command input may cause some of |
| 313 | the tests to fail (they were never intended to run in the background). |
| 314 | If all of the tests pass, Eshell should work just fine on your system. |
| 315 | If any of the tests fail, please send e-mail to the Eshell maintainer |
| 316 | using the command @kbd{M-x eshell-report-bug}. |
| 317 | |
| 318 | @item |
| 319 | Edit the file @file{Makefile} in the directory containing the Eshell |
| 320 | sources to reflect the location of certain Emacs directories at your |
| 321 | site. The only things you really have to change are the definitions of |
| 322 | @code{lispdir} and @code{infodir}. The elisp files will be copied to |
| 323 | @code{lispdir}, and the info file to @code{infodir}. |
| 324 | |
| 325 | @item |
| 326 | Type @kbd{make install} in the directory containing the Eshell sources. |
| 327 | This will byte-compile all of the @file{*.el} files and copy both the |
| 328 | source and compiled versions to the directories specified in the |
| 329 | previous step. It will also copy the info file, and add a corresponding |
| 330 | entry to your @file{dir} file----if the program @code{install-info} can |
| 331 | be found on your system. |
| 332 | |
| 333 | If you only want to create the compiled elisp files, but don't want to |
| 334 | install them, you can type just @kbd{make} instead. |
| 335 | |
| 336 | @item |
| 337 | Add the directory into which Eshell was installed to your |
| 338 | @code{load-path} variable. This can be done by adding the following |
| 339 | line to your @file{.emacs} file: |
| 340 | |
| 341 | @example |
| 342 | (add-to-list 'load-path "/usr/local/share/emacs/site-lisp/eshell") |
| 343 | @end example |
| 344 | |
| 345 | The actual directory on your system may differ. |
| 346 | |
| 347 | @item |
| 348 | To install Eshell privately, edit your @file{.emacs} file; to install |
| 349 | Eshell site-wide, edit the file @file{site-start.el} in your |
| 350 | @file{site-lisp} directory (usually |
| 351 | @file{/usr/local/share/emacs/site-lisp} or something similar). In |
| 352 | either case enter the following line into the appropriate file: |
| 353 | |
| 354 | @example |
| 355 | (load "eshell-auto") |
| 356 | @end example |
| 357 | |
| 358 | @item |
| 359 | Restart Emacs. After restarting, customize the variable |
| 360 | @code{eshell-modules-list}. This variable selects which Eshell |
| 361 | extension modules you want to use. You will find documentation on each |
| 362 | of those modules in the Info manual. |
| 363 | @end enumerate |
| 364 | |
| 365 | @cindex documentation, printed version |
| 366 | @cindex printed version of documentation |
| 367 | If you have @TeX{} installed at your site, you can make a typeset manual |
| 368 | from @file{eshell.texi}. |
| 369 | |
| 370 | @enumerate |
| 371 | @item |
| 372 | Run @TeX{} by typing @kbd{texi2dvi eshell.texi}. (With Emacs 21.1 or |
| 373 | later, typing @kbd{make eshell.dvi} in the @file{man/} subdirectory of |
| 374 | the Emacs source distribution will do that.) |
| 375 | |
| 376 | @item |
| 377 | Convert the resulting device independent file @file{eshell.dvi} to a |
| 378 | form which your printer can output and print it. If you have a |
| 379 | postscript printer, there is a program, @code{dvi2ps}, which does that; there |
| 380 | is also a program which comes together with @TeX{}, @code{dvips}, which |
| 381 | you can use. For other printers, use a suitable DVI driver, |
| 382 | e.g., @code{dvilj4} for LaserJet-compatible printers. |
| 383 | @end enumerate |
| 384 | |
| 385 | @node Command basics |
| 386 | @chapter Basic overview |
| 387 | |
| 388 | A command shell is a means of entering verbally-formed commands. This |
| 389 | is really all that it does, and every feature described in this manual |
| 390 | is a means to that end. Therefore, it's important to take firm hold on |
| 391 | exactly what a command is, and how it fits in the overall picture of |
| 392 | things. |
| 393 | |
| 394 | @menu |
| 395 | * Commands verbs:: Commands always begin with a verb. |
| 396 | * Command arguments:: Some verbs require arguments. |
| 397 | @end menu |
| 398 | |
| 399 | @node Commands verbs |
| 400 | @section Commands verbs |
| 401 | |
| 402 | Commands are expressed using @dfn{script}, a special shorthand language |
| 403 | computers can understand with no trouble. Script is an extremely simple |
| 404 | language; oddly enough, this is what makes it look so complicated! |
| 405 | Whereas normal languages use a variety of embellishments, the form of a |
| 406 | script command is always: |
| 407 | |
| 408 | @example |
| 409 | @var{verb} [@var{arguments}] |
| 410 | @end example |
| 411 | |
| 412 | The verb expresses what you want your computer to do. There are a fixed |
| 413 | number of verbs, although this number is usually quite large. On the |
| 414 | author's computer, it reaches almost 1400 in number. But of course, |
| 415 | only a handful of these are really necessary. |
| 416 | |
| 417 | Sometimes, the verb is all that's written. A verb is always a single |
| 418 | word, usually related to the task it performs. @command{reboot} is a |
| 419 | good example. Entering that on GNU/Linux will reboot the |
| 420 | computer---assuming you have sufficient privileges. |
| 421 | |
| 422 | Other verbs require more information. These are usually very capable |
| 423 | verbs, and must be told specifically what to do. The extra information |
| 424 | is given in the form of @dfn{arguments}. For example, the |
| 425 | @command{echo} verb prints back whatever arguments you type. It |
| 426 | requires these arguments to know what to echo. A proper use of |
| 427 | @command{echo} looks like this: |
| 428 | |
| 429 | @example |
| 430 | echo This is an example of using echo! |
| 431 | @end example |
| 432 | |
| 433 | This script command causes the computer to echo back: ``This is an |
| 434 | example of using echo!'' |
| 435 | |
| 436 | Although command verbs are always simple words, like @command{reboot} or |
| 437 | @command{echo}, arguments may have a wide variety of forms. There are |
| 438 | textual arguments, numerical arguments---even Lisp arguments. |
| 439 | Distinguishing these different types of arguments requires special |
| 440 | typing, for the computer to know exactly what you mean. |
| 441 | |
| 442 | @node Command arguments |
| 443 | @section Command arguments |
| 444 | |
| 445 | Eshell recognizes several different kinds of command arguments: |
| 446 | |
| 447 | @enumerate |
| 448 | @item Strings (also called textual arguments) |
| 449 | @item Numbers (floating point or integer) |
| 450 | @item Lisp lists |
| 451 | @item Lisp symbols |
| 452 | @item Emacs buffers |
| 453 | @item Emacs process handles |
| 454 | @end enumerate |
| 455 | |
| 456 | Most users need to worry only about the first two. The third, Lisp lists, |
| 457 | occur very frequently, but almost always behind the scenes. |
| 458 | |
| 459 | Strings are the most common type of argument, and consist of nearly any |
| 460 | character. Special characters---those used by Eshell |
| 461 | specifically---must be preceded by a backslash (@samp{\}). When in doubt, it |
| 462 | is safe to add backslashes anywhere and everywhere. |
| 463 | |
| 464 | Here is a more complicated @command{echo} example: |
| 465 | |
| 466 | @example |
| 467 | echo A\ Multi-word\ Argument\ With\ A\ \$\ dollar |
| 468 | @end example |
| 469 | |
| 470 | Beyond this, things get a bit more complicated. While not beyond the |
| 471 | reach of someone wishing to learn, it is definitely beyond the scope of |
| 472 | this manual to present it all in a simplistic manner. Get comfortable |
| 473 | with Eshell as a basic command invocation tool, and learn more about the |
| 474 | commands on your system; then come back when it all sits more familiarly |
| 475 | on your mind. Have fun! |
| 476 | |
| 477 | @node Commands |
| 478 | @chapter Commands |
| 479 | |
| 480 | @menu |
| 481 | * Invocation:: |
| 482 | * Completion:: |
| 483 | * Aliases:: |
| 484 | * History:: |
| 485 | * Scripts:: |
| 486 | * Built-ins:: |
| 487 | @end menu |
| 488 | |
| 489 | Essentially, a command shell is all about invoking commands---and |
| 490 | everything that entails. So understanding how Eshell invokes commands |
| 491 | is the key to comprehending how it all works. |
| 492 | |
| 493 | @node Invocation |
| 494 | @section Invocation |
| 495 | |
| 496 | Unlike regular system shells, Eshell never invokes kernel functions |
| 497 | directly, such as @code{exec(3)}. Instead, it uses the Lisp functions |
| 498 | available in the Emacs Lisp library. It does this by transforming the |
| 499 | command you specify into a callable Lisp form.@footnote{To see the Lisp |
| 500 | form that will be invoked, type: @samp{eshell-parse-command "echo |
| 501 | hello"}} |
| 502 | |
| 503 | This transformation, from the string of text typed at the command |
| 504 | prompt, to the ultimate invocation of either a Lisp function or external |
| 505 | command, follows these steps: |
| 506 | |
| 507 | @enumerate |
| 508 | @item Parse the command string into separate arguments. |
| 509 | @item |
| 510 | @end enumerate |
| 511 | |
| 512 | @node Completion |
| 513 | @section Completion |
| 514 | |
| 515 | @node Aliases |
| 516 | @section Aliases |
| 517 | |
| 518 | @node History |
| 519 | @section History |
| 520 | |
| 521 | Eshell knows a few built-in variables: |
| 522 | |
| 523 | @table @code |
| 524 | |
| 525 | @item $+ |
| 526 | @vindex $+ |
| 527 | This variable always contains the current working directory. |
| 528 | |
| 529 | @item $- |
| 530 | @vindex $- |
| 531 | This variable always contains the previous working directory (the |
| 532 | current working directory from before the last @code{cd} command). |
| 533 | |
| 534 | @end table |
| 535 | |
| 536 | @node Scripts |
| 537 | @section Scripts |
| 538 | |
| 539 | |
| 540 | @node Built-ins |
| 541 | @section Built-in commands |
| 542 | |
| 543 | Here is a list of built-in commands that Eshell knows about: |
| 544 | |
| 545 | @table @code |
| 546 | |
| 547 | @item cd |
| 548 | @findex cd |
| 549 | This command changes the current working directory. Usually, it is |
| 550 | invoked as @samp{cd foo} where @file{foo} is the new working |
| 551 | directory. But @code{cd} knows about a few special arguments: |
| 552 | |
| 553 | When it receives no argument at all, it changes to the home directory. |
| 554 | |
| 555 | Giving the command @samp{cd -} changes back to the previous working |
| 556 | directory (this is the same as @samp{cd $-}). |
| 557 | |
| 558 | The command @samp{cd =} shows the directory stack. Each line is |
| 559 | numbered. |
| 560 | |
| 561 | With @samp{cd =foo}, Eshell searches the directory stack for a |
| 562 | directory matching the regular expression @samp{foo} and changes to |
| 563 | that directory. |
| 564 | |
| 565 | With @samp{cd -42}, you can access the directory stack by number. |
| 566 | |
| 567 | @end table |
| 568 | |
| 569 | |
| 570 | @node Arguments |
| 571 | @chapter Arguments |
| 572 | |
| 573 | @menu |
| 574 | * The Parser:: |
| 575 | * Variables:: |
| 576 | * Substitution:: |
| 577 | * Globbing:: |
| 578 | * Predicates:: |
| 579 | @end menu |
| 580 | |
| 581 | @node The Parser |
| 582 | @section The Parser |
| 583 | |
| 584 | @node Variables |
| 585 | @section Variables |
| 586 | |
| 587 | @node Substitution |
| 588 | @section Substitution |
| 589 | |
| 590 | @node Globbing |
| 591 | @section Globbing |
| 592 | |
| 593 | @node Predicates |
| 594 | @section Predicates |
| 595 | |
| 596 | |
| 597 | @node Input/Output |
| 598 | @chapter Input/Output |
| 599 | |
| 600 | @node Process control |
| 601 | @chapter Process control |
| 602 | |
| 603 | |
| 604 | @node Extension modules |
| 605 | @chapter Extension modules |
| 606 | |
| 607 | @menu |
| 608 | * Writing a module:: |
| 609 | * Module testing:: |
| 610 | * Directory handling:: |
| 611 | * Key rebinding:: |
| 612 | * Smart scrolling:: |
| 613 | * Terminal emulation:: |
| 614 | * Built-in UNIX commands:: |
| 615 | @end menu |
| 616 | |
| 617 | @node Writing a module |
| 618 | @section Writing a module |
| 619 | |
| 620 | @node Module testing |
| 621 | @section Module testing |
| 622 | |
| 623 | @node Directory handling |
| 624 | @section Directory handling |
| 625 | |
| 626 | @node Key rebinding |
| 627 | @section Key rebinding |
| 628 | |
| 629 | @node Smart scrolling |
| 630 | @section Smart scrolling |
| 631 | |
| 632 | @node Terminal emulation |
| 633 | @section Terminal emulation |
| 634 | |
| 635 | @node Built-in UNIX commands |
| 636 | @section Built-in UNIX commands |
| 637 | |
| 638 | |
| 639 | @node Extras and Goodies |
| 640 | @chapter Extras and Goodies |
| 641 | |
| 642 | @node Bugs and ideas |
| 643 | @chapter Bugs and ideas |
| 644 | @cindex reporting bugs and ideas |
| 645 | @cindex bugs, how to report them |
| 646 | @cindex author, how to reach |
| 647 | @cindex email to the author |
| 648 | @cindex FAQ |
| 649 | @cindex problems, list of common |
| 650 | |
| 651 | If you find a bug or misfeature, don't hesitate to let me know! Send |
| 652 | email to @email{johnw@@gnu.org}. Feature requests should also be sent |
| 653 | there. I prefer discussing one thing at a time. If you find several |
| 654 | unrelated bugs, please report them separately. |
| 655 | |
| 656 | If you have ideas for improvements, or if you have written some |
| 657 | extensions to this package, I would like to hear from you. I hope you |
| 658 | find this package useful! |
| 659 | |
| 660 | @menu |
| 661 | * Known problems:: |
| 662 | @end menu |
| 663 | |
| 664 | @node Known problems |
| 665 | @section Known problems |
| 666 | @cindex known bugs |
| 667 | @cindex bugs, known |
| 668 | |
| 669 | Below is complete list of known problems with Eshell version 2.4.1, |
| 670 | which is the version included with Emacs 21.1. |
| 671 | |
| 672 | @table @asis |
| 673 | @item Documentation incomplete |
| 674 | |
| 675 | @item Differentiate between aliases and functions |
| 676 | |
| 677 | Allow for a bash-compatible syntax, such as: |
| 678 | |
| 679 | @example |
| 680 | alias arg=blah |
| 681 | function arg () @{ blah $* @} |
| 682 | @end example |
| 683 | |
| 684 | @item @samp{for i in 1 2 3 @{ grep -q a b && *echo has it @} | wc -l} outputs result after prompt |
| 685 | |
| 686 | In fact, piping to a process from a looping construct doesn't work in |
| 687 | general. If I change the call to @code{eshell-copy-handles} in |
| 688 | @code{eshell-rewrite-for-command} to use @code{eshell-protect}, it seems |
| 689 | to work, but the output occurs after the prompt is displayed. The whole |
| 690 | structured command thing is too complicated at present. |
| 691 | |
| 692 | @item Error with @command{bc} in @code{eshell-test} |
| 693 | |
| 694 | On some XEmacs system, the subprocess interaction test fails |
| 695 | inexplicably, although @command{bc} works fine at the command prompt. |
| 696 | |
| 697 | @item Eshell does not delete @file{*Help*} buffers in XEmacs 21.1.8+ |
| 698 | |
| 699 | In XEmacs 21.1.8, the @file{*Help*} buffer has been renamed such that |
| 700 | multiple instances of the @file{*Help*} buffer can exist. |
| 701 | |
| 702 | @item Pcomplete sometimes gets stuck |
| 703 | |
| 704 | You press @key{TAB}, but no completions appear, even though the |
| 705 | directory has matching files. This behavior is rare. |
| 706 | |
| 707 | @item @samp{grep python $<rpm -qa>} doesn't work, but using @samp{*grep} does |
| 708 | |
| 709 | This happens because the @code{grep} Lisp function returns immediately, |
| 710 | and then the asynchronous @command{grep} process expects to examine the |
| 711 | temporary file, which has since been deleted. |
| 712 | |
| 713 | @item Problem with C-r repeating text |
| 714 | |
| 715 | If the text @emph{before point} reads "./run", and you type @kbd{C-r r u |
| 716 | n}, it will repeat the line for every character typed. |
| 717 | |
| 718 | @item Backspace doesn't scroll back after continuing (in smart mode) |
| 719 | |
| 720 | Hitting space during a process invocation, such as @command{make}, will |
| 721 | cause it to track the bottom of the output; but backspace no longer |
| 722 | scrolls back. |
| 723 | |
| 724 | @item It's not possible to fully @code{unload-feature} Eshell |
| 725 | |
| 726 | @item Menu support was removed, but never put back |
| 727 | |
| 728 | @item Using C-p and C-n with rebind gets into a locked state |
| 729 | |
| 730 | This happened a few times in Emacs 21, but has been unreproducible |
| 731 | since. |
| 732 | |
| 733 | @item If an interactive process is currently running, @kbd{M-!} doesn't work |
| 734 | |
| 735 | @item Use a timer instead of @code{sleep-for} when killing child processes |
| 736 | |
| 737 | @item Piping to a Lisp function is not supported |
| 738 | |
| 739 | Make it so that the Lisp command on the right of the pipe is repeatedly |
| 740 | called with the input strings as arguments. This will require changing |
| 741 | @code{eshell-do-pipeline} to handle non-process targets. |
| 742 | |
| 743 | @item Input redirection is not supported |
| 744 | |
| 745 | See the above entry. |
| 746 | |
| 747 | @item Problem running @command{less} without arguments on Windows |
| 748 | |
| 749 | The result in the Eshell buffer is: |
| 750 | |
| 751 | @example |
| 752 | Spawning child process: invalid argument |
| 753 | @end example |
| 754 | |
| 755 | Also a new @command{less} buffer was created with nothing in it@dots{} |
| 756 | (presumably this holds the output of @command{less}). |
| 757 | |
| 758 | If @command{less.exe} is invoked from the Eshell command line, the |
| 759 | expected output is written to the buffer. |
| 760 | |
| 761 | Note that this happens on NT-Emacs 20.6.1 on Windows 2000. The term.el |
| 762 | package and the supplied shell both use the @command{cmdproxy} program |
| 763 | for running shells. |
| 764 | |
| 765 | @item Implement @samp{-r}, @samp{-n} and @samp{-s} switches for @command{cp} |
| 766 | |
| 767 | @item Make @kbd{M-5 M-x eshell} switch to ``*eshell<5>*'', creating if need be |
| 768 | |
| 769 | @item @samp{mv @var{dir} @var{file}.tar} does not remove directories |
| 770 | |
| 771 | This is because the tar option --remove-files doesn't do so. Should it |
| 772 | be Eshell's job? |
| 773 | |
| 774 | @item Bind @code{standard-output} and @code{standard-error} |
| 775 | |
| 776 | This would be so that if a Lisp function calls @code{print}, everything |
| 777 | will happen as it should (albeit slowly). |
| 778 | |
| 779 | @item When an extension module fails to load, @samp{cd /} gives a Lisp error |
| 780 | |
| 781 | @item If a globbing pattern returns one match, should it be a list? |
| 782 | |
| 783 | @item Make sure syntax table is correct in Eshell mode |
| 784 | |
| 785 | So that @kbd{M-DEL} acts in a predictable manner, etc. |
| 786 | |
| 787 | @item Allow all Eshell buffers to share the same history and list-dir |
| 788 | |
| 789 | @item There is a problem with script commands that output to @file{/dev/null} |
| 790 | |
| 791 | If a script file, somewhere in the middle, uses @samp{> /dev/null}, |
| 792 | output from all subsequent commands is swallowed. |
| 793 | |
| 794 | @item Split up parsing of text after @samp{$} in @file{esh-var.el} |
| 795 | |
| 796 | Make it similar to the way that @file{esh-arg.el} is structured. |
| 797 | Then add parsing of @samp{$[?\n]}. |
| 798 | |
| 799 | @item After pressing @kbd{M-RET}, redisplay before running the next command |
| 800 | |
| 801 | @item Argument predicates and modifiers should work anywhere in a path |
| 802 | |
| 803 | @example |
| 804 | /usr/local/src/editors/vim $ vi **/CVS(/)/Root(.) |
| 805 | Invalid regexp: "Unmatched ( or \\(" |
| 806 | @end example |
| 807 | |
| 808 | With @command{zsh}, the glob above expands to all files named |
| 809 | @file{Root} in directories named @file{CVS}. |
| 810 | |
| 811 | @item Typing @samp{echo $@{locate locate@}/bin<TAB>} results in a Lisp error |
| 812 | |
| 813 | Perhaps it should interpolate all permutations, and make that the |
| 814 | globbing result, since otherwise hitting return here will result in |
| 815 | ``(list of filenames)/bin'', which is never valuable. Thus, one could |
| 816 | @command{cat} only C backup files by using @samp{ls $@{identity *.c@}~}. |
| 817 | In that case, having an alias command name @command{glob} for |
| 818 | @command{identity} would be useful. |
| 819 | |
| 820 | @item Once symbolic mode is supported for @command{umask}, implement @command{chmod} in Lisp |
| 821 | |
| 822 | @item Create @code{eshell-expand-file-name} |
| 823 | |
| 824 | This would use a data table to transform things such as @samp{~+}, |
| 825 | @samp{...}, etc. |
| 826 | |
| 827 | @item Abstract @file{em-smart.el} into @file{smart-scroll.el} |
| 828 | |
| 829 | It only really needs: to be hooked onto the output filter and the |
| 830 | pre-command hook, and to have the input-end and input-start markers. |
| 831 | And to know whether the last output group was ``successful.'' |
| 832 | |
| 833 | @item Allow for fully persisting the state of Eshell |
| 834 | |
| 835 | This would include: variables, history, buffer, input, dir stack, etc. |
| 836 | |
| 837 | @item Implement D as an argument predicate |
| 838 | |
| 839 | It means that files beginning with a dot should be included in the |
| 840 | glob match. |
| 841 | |
| 842 | @item A comma in a predicate list should mean OR |
| 843 | |
| 844 | At the moment, this is not supported. |
| 845 | |
| 846 | @item Error if a glob doesn't expand due to a predicate |
| 847 | |
| 848 | An error should be generated only if @code{eshell-error-if-no-glob} is |
| 849 | non-nil. |
| 850 | |
| 851 | @item @samp{(+ RET SPC TAB} does not cause @code{indent-according-to-mode} to occur |
| 852 | |
| 853 | @item Create @code{eshell-auto-accumulate-list} |
| 854 | |
| 855 | This is a list of commands for which, if the user presses @kbd{RET}, the |
| 856 | text is staged as the next Eshell command, rather than being sent to the |
| 857 | current interactive process. |
| 858 | |
| 859 | @item Display file and line number if an error occurs in a script |
| 860 | |
| 861 | @item @command{wait} doesn't work with process ids at the moment |
| 862 | |
| 863 | @item Enable the direct-to-process input code in @file{em-term.el} |
| 864 | |
| 865 | @item Problem with repeating @samp{echo $@{find /tmp@}} |
| 866 | |
| 867 | With smart display active, if @kbd{RET} is held down, after a while it |
| 868 | can't keep up anymore and starts outputting blank lines. It only |
| 869 | happens if an asynchronous process is involved@dots{} |
| 870 | |
| 871 | I think the problem is that @code{eshell-send-input} is resetting the |
| 872 | input target location, so that if the asynchronous process is not done |
| 873 | by the time the next @kbd{RET} is received, the input processor thinks |
| 874 | that the input is meant for the process; which, when smart display is |
| 875 | enabled, will be the text of the last command line! That is a bug in |
| 876 | itself. |
| 877 | |
| 878 | In holding down @kbd{RET} while an asynchronous process is running, |
| 879 | there will be a point in between termination of the process, and the |
| 880 | running of @code{eshell-post-command-hook}, which would cause |
| 881 | @code{eshell-send-input} to call @code{eshell-copy-old-input}, and then |
| 882 | process that text as a command to be run after the process. Perhaps |
| 883 | there should be a way of killing pending input between the death of the |
| 884 | process, and the @code{post-command-hook}. |
| 885 | |
| 886 | @item Allow for a more aggressive smart display mode |
| 887 | |
| 888 | Perhaps toggled by a command, that makes each output block a smart |
| 889 | display block. |
| 890 | |
| 891 | @item Create more meta variables |
| 892 | |
| 893 | @table @samp |
| 894 | @item $! |
| 895 | The reason for the failure of the last disk command, or the text of the |
| 896 | last Lisp error. |
| 897 | |
| 898 | @item $= |
| 899 | A special associate array, which can take references of the form |
| 900 | @samp{$=[REGEXP]}. It indexes into the directory ring. |
| 901 | @end table |
| 902 | |
| 903 | @item Eshell scripts can't execute in the background |
| 904 | |
| 905 | @item Support zsh's ``Parameter Expansion'' syntax, i.e. @samp{$@{@var{name}:-@var{val}@}} |
| 906 | |
| 907 | @item Write an @command{info} alias that can take arguments |
| 908 | |
| 909 | So that the user can enter @samp{info chmod}, for example. |
| 910 | |
| 911 | @item Create a mode @code{eshell-browse} |
| 912 | |
| 913 | It would treat the Eshell buffer as a outline. Collapsing the outline |
| 914 | hides all of the output text. Collapsing again would show only the |
| 915 | first command run in each directory |
| 916 | |
| 917 | @item Allow other revisions of a file to be referenced using @samp{file@{rev@}} |
| 918 | |
| 919 | This would be expanded by @code{eshell-expand-file-name} (see above). |
| 920 | |
| 921 | @item Print ``You have new mail'' when the ``Mail'' icon is turned on |
| 922 | |
| 923 | @item Implement @kbd{M-|} for Eshell |
| 924 | |
| 925 | @item Implement input redirection |
| 926 | |
| 927 | If it's a Lisp function, input redirection implies @command{xargs} (in a |
| 928 | way@dots{}). If input redirection is added, also update the |
| 929 | @code{file-name-quote-list}, and the delimiter list. |
| 930 | |
| 931 | @item Allow @samp{#<@var{word} @var{arg}>} as a generic syntax |
| 932 | |
| 933 | With the handling of @emph{word} specified by an |
| 934 | @code{eshell-special-alist}. |
| 935 | |
| 936 | @item In @code{eshell-veal-using-options}, allow a @code{:complete} tag |
| 937 | |
| 938 | It would be used to provide completion rules for that command. Then the |
| 939 | macro will automagically define the completion function. |
| 940 | |
| 941 | @item For @code{eshell-command-on-region}, apply redirections to the result |
| 942 | |
| 943 | So that @samp{+ > 'blah} would cause the result of the @code{+} (using |
| 944 | input from the current region) to be inserting into the symbol |
| 945 | @code{blah}. |
| 946 | |
| 947 | If an external command is being invoked, the input is sent as standard |
| 948 | input, as if a @samp{cat <region> |} had been invoked. |
| 949 | |
| 950 | If a Lisp command, or an alias, is invoked, then if the line has no |
| 951 | newline characters, it is divided by whitespace and passed as arguments |
| 952 | to the Lisp function. Otherwise, it is divided at the newline |
| 953 | characters. Thus, invoking @code{+} on a series of numbers will add |
| 954 | them; @code{min} would display the smallest figure, etc. |
| 955 | |
| 956 | @item Write @code{eshell-script-mode} as a minor mode |
| 957 | |
| 958 | It would provide syntax, abbrev, highlighting and indenting support like |
| 959 | @code{emacs-lisp-mode} and @code{shell-mode}. |
| 960 | |
| 961 | @item In the history mechanism, finish the @command{bash}-style support |
| 962 | |
| 963 | This means @samp{!n}, @samp{!#}, @samp{!:%}, and @samp{!:1-} as separate |
| 964 | from @samp{!:1*}. |
| 965 | |
| 966 | @item Support the -n command line option for @command{history} |
| 967 | |
| 968 | @item Implement @command{fc} in Lisp |
| 969 | |
| 970 | @item Specifying a frame as a redirection target should imply the currently active window's buffer |
| 971 | |
| 972 | @item Implement @samp{>@var{func-or-func-list}} |
| 973 | |
| 974 | This would allow for an ``output translators'', that take a function to |
| 975 | modify output with, and a target. Devise a syntax that works well with |
| 976 | pipes, and can accommodate multiple functions (i.e., @samp{>'(upcase |
| 977 | regexp-quote)} or @samp{>'upcase}). |
| 978 | |
| 979 | @item Allow Eshell to read/write to/from standard input and output |
| 980 | |
| 981 | This would be optional, rather than always using the Eshell buffer. |
| 982 | This would allow it to be run from the command line (perhaps). |
| 983 | |
| 984 | @item Write a @command{help} command |
| 985 | |
| 986 | It would call subcommands with @option{--help}, or @option{-h} or |
| 987 | @option{/?}, as appropriate. |
| 988 | |
| 989 | @item Implement @command{stty} in Lisp |
| 990 | |
| 991 | @item Support @command{rc}'s matching operator, e.g. @samp{~ (@var{list}) @var{regexp}} |
| 992 | |
| 993 | @item Implement @command{bg} and @command{fg} as editors of @code{eshell-process-list} |
| 994 | |
| 995 | Using @command{bg} on a process that is already in the background does |
| 996 | nothing. Specifying redirection targets replaces (or adds) to the list |
| 997 | current being used. |
| 998 | |
| 999 | @item Have @command{jobs} print only the processes for the current shell |
| 1000 | |
| 1001 | @item How can Eshell learn if a background process has requested input? |
| 1002 | |
| 1003 | @item Support @samp{2>&1} and @samp{>&} and @samp{2>} and @samp{|&} |
| 1004 | |
| 1005 | The syntax table for parsing these should be customizable, such that the |
| 1006 | user could change it to use rc syntax: @samp{>[2=1]}. |
| 1007 | |
| 1008 | @item Allow @samp{$_[-1]}, which would indicate the last element of the array |
| 1009 | |
| 1010 | @item Make @samp{$x[*]} equal to listing out the full contents of @samp{x} |
| 1011 | |
| 1012 | Return them as a list, so that @samp{$_[*]} is all the arguments of the |
| 1013 | last command. |
| 1014 | |
| 1015 | @item Copy ANSI code handling from @file{term.el} into @file{em-term.el} |
| 1016 | |
| 1017 | Make it possible for the user to send char-by-char to the underlying |
| 1018 | process. Ultimately, I should be able to move away from using term.el |
| 1019 | altogether, since everything but the ANSI code handling is already part |
| 1020 | of Eshell. Then, things would work correctly on MS-Windows as well |
| 1021 | (which doesn't have @file{/bin/sh}, although @file{term.el} tries to use |
| 1022 | it). |
| 1023 | |
| 1024 | @item Make the shell spawning commands be visual |
| 1025 | |
| 1026 | That is, make (@command{su}, @command{bash}, @command{telnet}, |
| 1027 | @command{rlogin}, @command{rsh}, etc.) be part of |
| 1028 | @code{eshell-visual-commands}. The only exception is if the shell is |
| 1029 | being used to invoke a single command. Then, the behavior should be |
| 1030 | based on what that command is. |
| 1031 | |
| 1032 | @item Create a smart viewing command named @command{open} |
| 1033 | |
| 1034 | This would search for some way to open its argument (similar to opening |
| 1035 | a file in the Windows Explorer). |
| 1036 | |
| 1037 | @item Alias @command{read} to be the same as @command{open}, only read-only |
| 1038 | |
| 1039 | @item Write a @command{tail} command which uses @code{view-file} |
| 1040 | |
| 1041 | It would move point to the end of the buffer, and then turns on |
| 1042 | auto-revert mode in that buffer at frequent intervals---and a |
| 1043 | @command{head} alias which assums an upper limit of |
| 1044 | @code{eshell-maximum-line-length} characters per line. |
| 1045 | |
| 1046 | @item Make @command{dgrep} load @code{dired}, mark everything, then invoke @code{dired-do-search} |
| 1047 | |
| 1048 | @item Write mesh.c |
| 1049 | |
| 1050 | This would run Emacs with the appropriate arguments to invoke Eshell |
| 1051 | only. That way, it could be listed as a login shell. |
| 1052 | |
| 1053 | @item Use an intangible @code{PS2} string for multi-line input prompts |
| 1054 | |
| 1055 | @item Auto-detect when a command is visual, by checking @code{TERMCAP} usage |
| 1056 | |
| 1057 | @item The first keypress after @kbd{M-x watson} triggers `eshell-send-input' |
| 1058 | |
| 1059 | @item Make @kbd{/} electric |
| 1060 | |
| 1061 | So that it automatically expands and corrects pathnames. Or make |
| 1062 | pathname completion for Pcomplete auto-expand @samp{/u/i/std<TAB>} to |
| 1063 | @samp{/usr/include/std<TAB>}. |
| 1064 | |
| 1065 | @item Write the @command{pushd} stack to disk along with @code{last-dir-ring} |
| 1066 | |
| 1067 | @item Add options to @code{eshell/cat} which would allow it to sort and uniq |
| 1068 | |
| 1069 | @item Implement @command{wc} in Lisp |
| 1070 | |
| 1071 | Add support for counting sentences, paragraphs, pages, etc. |
| 1072 | |
| 1073 | @item Once piping is added, implement @command{sort} and @command{uniq} in Lisp |
| 1074 | |
| 1075 | @item Implement @command{touch} in Lisp |
| 1076 | |
| 1077 | @item Implement @command{comm} in Lisp |
| 1078 | |
| 1079 | @item Implement an @command{epatch} command in Lisp |
| 1080 | |
| 1081 | This would call @code{ediff-patch-file}, or @code{ediff-patch-buffer}, |
| 1082 | depending on its argument. |
| 1083 | |
| 1084 | @item Have an option such that @samp{ls -l} generates a dired buffer |
| 1085 | |
| 1086 | @item Write a version of @command{xargs} based on command rewriting |
| 1087 | |
| 1088 | That is, @samp{find X | xargs Y} would be indicated using @samp{Y |
| 1089 | $@{find X@}}. Maybe @code{eshell-do-pipelines} could be changed to |
| 1090 | perform this on-thy-fly rewriting. |
| 1091 | |
| 1092 | @item Write an alias for @command{less} that brings up a @code{view-mode} buffer |
| 1093 | |
| 1094 | Such that the user can press @key{SPC} and @key{DEL}, and then @key{q} |
| 1095 | to return to Eshell. It would be equivalent to: |
| 1096 | @samp{X > #<buffer Y>; view-buffer #<buffer Y>}. |
| 1097 | |
| 1098 | @item Make @code{eshell-mode} as much a full citizen as @code{shell-mode} |
| 1099 | |
| 1100 | Everywhere in Emacs where @code{shell-mode} is specially noticed, add |
| 1101 | @code{eshell-mode} there. |
| 1102 | |
| 1103 | @item Permit the umask to be selectively set on a @command{cp} target |
| 1104 | |
| 1105 | @item Problem using @kbd{M-x eshell} after using @code{eshell-command} |
| 1106 | |
| 1107 | If the first thing that I do after entering Emacs is to run |
| 1108 | @code{eshell-command} and invoke @command{ls}, and then use @kbd{M-x |
| 1109 | eshell}, it doesn't display anything. |
| 1110 | |
| 1111 | @item @kbd{M-RET} during a long command (using smart display) doesn't work |
| 1112 | |
| 1113 | Since it keeps the cursor up where the command was invoked. |
| 1114 | |
| 1115 | @end table |
| 1116 | |
| 1117 | @node Concept Index |
| 1118 | @unnumbered Concept Index |
| 1119 | |
| 1120 | @printindex cp |
| 1121 | |
| 1122 | @node Function and Variable Index |
| 1123 | @unnumbered Function and Variable Index |
| 1124 | |
| 1125 | @printindex fn |
| 1126 | |
| 1127 | @node Key Index |
| 1128 | @unnumbered Key Index |
| 1129 | |
| 1130 | @printindex ky |
| 1131 | @bye |
| 1132 | |
| 1133 | @ignore |
| 1134 | arch-tag: 776409ba-cb15-42b9-b2b6-d2bdc7ebad01 |
| 1135 | @end ignore |