aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Großjohann2002-06-17 11:50:12 +0000
committerKai Großjohann2002-06-17 11:50:12 +0000
commit7d97fbf4e00873e71601d60226ddc85097a6888b (patch)
treef8fafd6f01fe811efc91a5f8b8fc491762a3d443
parentfb7933a38932ce8832a40507e8e10bd61e27eaee (diff)
downloademacs-7d97fbf4e00873e71601d60226ddc85097a6888b.tar.gz
emacs-7d97fbf4e00873e71601d60226ddc85097a6888b.zip
Remove unnecessary prev/next/up pointers in @node
commands. (Top): Don't include it in DVI output. (History): Explain $- and $+. (Built-ins): New node. Document `cd'.
-rw-r--r--man/ChangeLog6
-rw-r--r--man/eshell.texi115
2 files changed, 85 insertions, 36 deletions
diff --git a/man/ChangeLog b/man/ChangeLog
index 23672841559..a43ac1f0ebf 100644
--- a/man/ChangeLog
+++ b/man/ChangeLog
@@ -1,5 +1,11 @@
12002-06-17 Kai Gro,b_(Bjohann <Kai.Grossjohann@CS.Uni-Dortmund.DE> 12002-06-17 Kai Gro,b_(Bjohann <Kai.Grossjohann@CS.Uni-Dortmund.DE>
2 2
3 * eshell.texi: Remove unnecessary prev/next/up pointers in @node
4 commands.
5 (Top): Don't include it in DVI output.
6 (History): Explain $- and $+.
7 (Built-ins): New node. Document `cd'.
8
3 * Makefile.in (INFO_TARGETS, DVI_TARGETS): Add Tramp. 9 * Makefile.in (INFO_TARGETS, DVI_TARGETS): Add Tramp.
4 (../info/tramp, tramp.dvi): New targets. 10 (../info/tramp, tramp.dvi): New targets.
5 11
diff --git a/man/eshell.texi b/man/eshell.texi
index 38c63131375..da5179f0899 100644
--- a/man/eshell.texi
+++ b/man/eshell.texi
@@ -1,6 +1,6 @@
1\input texinfo @c -*-texinfo-*- 1\input texinfo @c -*-texinfo-*-
2 2
3@c "@(#)$Name: $:$Id: eshell.texi,v 1.11 2001/04/19 15:07:55 gerd Exp $" 3@c "@(#)$Name: $:$Id: eshell.texi,v 1.12 2001/04/19 15:10:31 gerd Exp $"
4 4
5@c Documentation for Eshell: The Emacs Shell. 5@c Documentation for Eshell: The Emacs Shell.
6@c Copyright (C) 1999, 2000 Free Software Foundation, Inc. 6@c Copyright (C) 1999, 2000 Free Software Foundation, Inc.
@@ -102,8 +102,8 @@ license to the document, as described in section 6 of the license.
102@c The real text starts here 102@c The real text starts here
103@c ================================================================ 103@c ================================================================
104 104
105@node Top, What is Eshell?, (dir), (dir)
106@ifinfo 105@ifinfo
106@node Top, What is Eshell?, (dir), (dir)
107@top Eshell 107@top Eshell
108 108
109This manual documents Eshell, a shell-like command interpretor 109This manual documents Eshell, a shell-like command interpretor
@@ -131,7 +131,7 @@ handling the sort of tasks accomplished by those tools.
131* Key Index:: 131* Key Index::
132@end menu 132@end menu
133 133
134@node What is Eshell?, Installation, Top, Top 134@node What is Eshell?
135@chapter What is Eshell? 135@chapter What is Eshell?
136@cindex what is Eshell? 136@cindex what is Eshell?
137@cindex Eshell, what it is 137@cindex Eshell, what it is
@@ -189,7 +189,7 @@ As of Emacs 21, Eshell is part of the standard Emacs distribution.
189* Contributors to Eshell:: People who have helped out! 189* Contributors to Eshell:: People who have helped out!
190@end menu 190@end menu
191 191
192@node Contributors to Eshell, , What is Eshell?, What is Eshell? 192@node Contributors to Eshell
193@section Contributors to Eshell 193@section Contributors to Eshell
194@cindex contributors 194@cindex contributors
195@cindex authors 195@cindex authors
@@ -229,7 +229,7 @@ Apart from these, a lot of people have sent suggestions, ideas,
229requests, bug reports and encouragement. Thanks a lot! Without you 229requests, bug reports and encouragement. Thanks a lot! Without you
230there would be no new releases of Eshell. 230there would be no new releases of Eshell.
231 231
232@node Installation, Command basics, What is Eshell?, Top 232@node Installation
233@chapter Installation 233@chapter Installation
234@cindex installation 234@cindex installation
235 235
@@ -419,7 +419,7 @@ you can use. For other printers, use a suitable DVI driver,
419e.g., @code{dvilj4} for LaserJet-compatible printers. 419e.g., @code{dvilj4} for LaserJet-compatible printers.
420@end enumerate 420@end enumerate
421 421
422@node Command basics, Commands, Installation, Top 422@node Command basics
423@chapter Basic overview 423@chapter Basic overview
424 424
425A command shell is a means of entering verbally-formed commands. This 425A command shell is a means of entering verbally-formed commands. This
@@ -433,7 +433,7 @@ things.
433* Command arguments:: Some verbs require arguments. 433* Command arguments:: Some verbs require arguments.
434@end menu 434@end menu
435 435
436@node Commands verbs, Command arguments, Command basics, Command basics 436@node Commands verbs
437@section Commands verbs 437@section Commands verbs
438 438
439Commands are expressed using @dfn{script}, a special shorthand language 439Commands are expressed using @dfn{script}, a special shorthand language
@@ -476,7 +476,7 @@ textual arguments, numerical arguments---even Lisp arguments.
476Distinguishing these different types of arguments requires special 476Distinguishing these different types of arguments requires special
477typing, for the computer to know exactly what you mean. 477typing, for the computer to know exactly what you mean.
478 478
479@node Command arguments, , Commands verbs, Command basics 479@node Command arguments
480@section Command arguments 480@section Command arguments
481 481
482Eshell recognizes several different kinds of command arguments: 482Eshell recognizes several different kinds of command arguments:
@@ -511,7 +511,7 @@ with Eshell as a basic command invocation tool, and learn more about the
511commands on your system; then come back when it all sits more familiarly 511commands on your system; then come back when it all sits more familiarly
512on your mind. Have fun! 512on your mind. Have fun!
513 513
514@node Commands, Arguments, Command basics, Top 514@node Commands
515@chapter Commands 515@chapter Commands
516 516
517@menu 517@menu
@@ -520,13 +520,14 @@ on your mind. Have fun!
520* Aliases:: 520* Aliases::
521* History:: 521* History::
522* Scripts:: 522* Scripts::
523* Built-ins::
523@end menu 524@end menu
524 525
525Essentially, a command shell is all about invoking commands---and 526Essentially, a command shell is all about invoking commands---and
526everything that entails. So understanding how Eshell invokes commands 527everything that entails. So understanding how Eshell invokes commands
527is the key to comprehending how it all works. 528is the key to comprehending how it all works.
528 529
529@node Invocation, Completion, Commands, Commands 530@node Invocation
530@section Invocation 531@section Invocation
531 532
532Unlike regular system shells, Eshell never invokes kernel functions 533Unlike regular system shells, Eshell never invokes kernel functions
@@ -545,20 +546,62 @@ command, follows these steps:
545@item 546@item
546@end enumerate 547@end enumerate
547 548
548@node Completion, Aliases, Invocation, Commands 549@node Completion
549@section Completion 550@section Completion
550 551
551@node Aliases, History, Completion, Commands 552@node Aliases
552@section Aliases 553@section Aliases
553 554
554@node History, Scripts, Aliases, Commands 555@node History
555@section History 556@section History
556 557
557@node Scripts, , History, Commands 558Eshell knows a few built-in variables:
559
560@table @code
561
562@item $+
563@vindex $+
564This variable always contains the current working directory.
565
566@item $-
567@vindex $-
568This variable always contains the previous working directory (the
569current working directory from before the last @code{cd} command).
570
571@end table
572
573@node Scripts
558@section Scripts 574@section Scripts
559 575
560 576
561@node Arguments, Input/Output, Commands, Top 577@node Built-ins
578@section Built-in commands
579
580Here is a list of built-in commands that Eshell knows about:
581
582@table @code
583
584@item cd
585@findex cd
586This command changes the current working directory. Usually, it is
587invoked as @samp{cd foo} where @file{foo} is the new working
588directory. But @code{cd} knows about a few special arguments:
589
590When it receives no argument at all, it changes to the home directory.
591
592Giving the command @samp{cd -} changes back to the previous working
593directory (this is the same as @samp{cd $-}).
594
595The command @samp{cd =} shows the directory stack.
596
597With @samp{cd =foo}, Eshell searches the directory stack for a
598directory matching the regular expression @samp{foo} and changes to
599that directory.
600
601@end table
602
603
604@node Arguments
562@chapter Arguments 605@chapter Arguments
563 606
564@menu 607@menu
@@ -569,30 +612,30 @@ command, follows these steps:
569* Predicates:: 612* Predicates::
570@end menu 613@end menu
571 614
572@node The Parser, Variables, Arguments, Arguments 615@node The Parser
573@section The Parser 616@section The Parser
574 617
575@node Variables, Substitution, The Parser, Arguments 618@node Variables
576@section Variables 619@section Variables
577 620
578@node Substitution, Globbing, Variables, Arguments 621@node Substitution
579@section Substitution 622@section Substitution
580 623
581@node Globbing, Predicates, Substitution, Arguments 624@node Globbing
582@section Globbing 625@section Globbing
583 626
584@node Predicates, , Globbing, Arguments 627@node Predicates
585@section Predicates 628@section Predicates
586 629
587 630
588@node Input/Output, Process control, Arguments, Top 631@node Input/Output
589@chapter Input/Output 632@chapter Input/Output
590 633
591@node Process control, Extension modules, Input/Output, Top 634@node Process control
592@chapter Process control 635@chapter Process control
593 636
594 637
595@node Extension modules, Extras and Goodies, Process control, Top 638@node Extension modules
596@chapter Extension modules 639@chapter Extension modules
597 640
598@menu 641@menu
@@ -605,32 +648,32 @@ command, follows these steps:
605* Built-in UNIX commands:: 648* Built-in UNIX commands::
606@end menu 649@end menu
607 650
608@node Writing a module, Module testing, Extension modules, Extension modules 651@node Writing a module
609@section Writing a module 652@section Writing a module
610 653
611@node Module testing, Directory handling, Writing a module, Extension modules 654@node Module testing
612@section Module testing 655@section Module testing
613 656
614@node Directory handling, Key rebinding, Module testing, Extension modules 657@node Directory handling
615@section Directory handling 658@section Directory handling
616 659
617@node Key rebinding, Smart scrolling, Directory handling, Extension modules 660@node Key rebinding
618@section Key rebinding 661@section Key rebinding
619 662
620@node Smart scrolling, Terminal emulation, Key rebinding, Extension modules 663@node Smart scrolling
621@section Smart scrolling 664@section Smart scrolling
622 665
623@node Terminal emulation, Built-in UNIX commands, Smart scrolling, Extension modules 666@node Terminal emulation
624@section Terminal emulation 667@section Terminal emulation
625 668
626@node Built-in UNIX commands, , Terminal emulation, Extension modules 669@node Built-in UNIX commands
627@section Built-in UNIX commands 670@section Built-in UNIX commands
628 671
629 672
630@node Extras and Goodies, Bugs and ideas, Extension modules, Top 673@node Extras and Goodies
631@chapter Extras and Goodies 674@chapter Extras and Goodies
632 675
633@node Bugs and ideas, Concept Index, Extras and Goodies, Top 676@node Bugs and ideas
634@chapter Bugs and ideas 677@chapter Bugs and ideas
635@cindex reporting bugs and ideas 678@cindex reporting bugs and ideas
636@cindex bugs, how to report them 679@cindex bugs, how to report them
@@ -652,7 +695,7 @@ find this package useful!
652* Known problems:: 695* Known problems::
653@end menu 696@end menu
654 697
655@node Known problems, , Bugs and ideas, Bugs and ideas 698@node Known problems
656@section Known problems 699@section Known problems
657@cindex known bugs 700@cindex known bugs
658@cindex bugs, known 701@cindex bugs, known
@@ -1103,17 +1146,17 @@ Since it keeps the cursor up where the command was invoked.
1103 1146
1104@end table 1147@end table
1105 1148
1106@node Concept Index, Function and Variable Index, Bugs and ideas, Top 1149@node Concept Index
1107@unnumbered Concept Index 1150@unnumbered Concept Index
1108 1151
1109@printindex cp 1152@printindex cp
1110 1153
1111@node Function and Variable Index, Key Index, Concept Index, Top 1154@node Function and Variable Index
1112@unnumbered Function and Variable Index 1155@unnumbered Function and Variable Index
1113 1156
1114@printindex fn 1157@printindex fn
1115 1158
1116@node Key Index, , Function and Variable Index, Top 1159@node Key Index
1117@unnumbered Key Index 1160@unnumbered Key Index
1118 1161
1119@printindex ky 1162@printindex ky