aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAidan Gauland2014-01-02 22:32:20 +1300
committerAidan Gauland2014-01-02 22:32:20 +1300
commitf2299e89bc4dbc51dc093b9ea4245d836de480bb (patch)
treea12f1134f49b522321b4b48a49035e7ff4c86317
parent94ee87197f4fb33272972231f41d5db603d73afe (diff)
downloademacs-f2299e89bc4dbc51dc093b9ea4245d836de480bb.tar.gz
emacs-f2299e89bc4dbc51dc093b9ea4245d836de480bb.zip
* eshell.text (Command Basics): Removed `Command basics' chapter.
-rw-r--r--doc/misc/ChangeLog4
-rw-r--r--doc/misc/eshell.texi93
2 files changed, 4 insertions, 93 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 0612580dd62..2a6d5b11b15 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,5 +1,9 @@
12014-01-02 Aidan Gauland <aidalgol@amuri.net> 12014-01-02 Aidan Gauland <aidalgol@amuri.net>
2 2
3 * eshell.text (Command Basics): Removed `Command basics' chapter.
4
52014-01-02 Aidan Gauland <aidalgol@amuri.net>
6
3 * eshell.text (What is Eshell?): Add section about what not to use 7 * eshell.text (What is Eshell?): Add section about what not to use
4 Eshell for. 8 Eshell for.
5 9
diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi
index 37ec9a54b6e..47644a8743c 100644
--- a/doc/misc/eshell.texi
+++ b/doc/misc/eshell.texi
@@ -74,7 +74,6 @@ Emacs @emph{and} with an interface similar to command shells such as
74 74
75@menu 75@menu
76* Introduction:: A brief introduction to the Emacs Shell. 76* Introduction:: A brief introduction to the Emacs Shell.
77* Command basics:: The basics of command usage.
78* Commands:: 77* Commands::
79* Expansion:: 78* Expansion::
80* Input/Output:: 79* Input/Output::
@@ -202,98 +201,6 @@ Apart from these, a lot of people have sent suggestions, ideas,
202requests, bug reports and encouragement. Thanks a lot! Without you 201requests, bug reports and encouragement. Thanks a lot! Without you
203there would be no new releases of Eshell. 202there would be no new releases of Eshell.
204 203
205@node Command basics
206@chapter Basic overview
207
208A command shell is a means of entering verbally-formed commands. This
209is really all that it does, and every feature described in this manual
210is a means to that end. Therefore, it's important to take firm hold on
211exactly what a command is, and how it fits in the overall picture of
212things.
213
214@menu
215* Commands verbs:: Commands always begin with a verb.
216* Command arguments:: Some verbs require arguments.
217@end menu
218
219@node Commands verbs
220@section Commands verbs
221
222Commands are expressed using @dfn{script}, a special shorthand language
223computers can understand with no trouble. Script is an extremely simple
224language; oddly enough, this is what makes it look so complicated!
225Whereas normal languages use a variety of embellishments, the form of a
226script command is always:
227
228@example
229@var{verb} [@var{arguments}]
230@end example
231
232The verb expresses what you want your computer to do. There are a fixed
233number of verbs, although this number is usually quite large. On the
234author's computer, it reaches almost 1400 in number. But of course,
235only a handful of these are really necessary.
236
237Sometimes, the verb is all that's written. A verb is always a single
238word, usually related to the task it performs. @command{reboot} is a
239good example. Entering that on GNU/Linux will reboot the
240computer---assuming you have sufficient privileges.
241
242Other verbs require more information. These are usually very capable
243verbs, and must be told specifically what to do. The extra information
244is given in the form of @dfn{arguments}. For example, the
245@command{echo} verb prints back whatever arguments you type. It
246requires these arguments to know what to echo. A proper use of
247@command{echo} looks like this:
248
249@example
250echo This is an example of using echo!
251@end example
252
253This script command causes the computer to echo back: ``This is an
254example of using echo!''
255
256Although command verbs are always simple words, like @command{reboot} or
257@command{echo}, arguments may have a wide variety of forms. There are
258textual arguments, numerical arguments---even Lisp arguments.
259Distinguishing these different types of arguments requires special
260typing, for the computer to know exactly what you mean.
261
262@node Command arguments
263@section Command arguments
264
265Eshell recognizes several different kinds of command arguments:
266
267@enumerate
268@item Strings (also called textual arguments)
269@item Numbers (floating point or integer)
270@item Lisp lists
271@item Lisp symbols
272@item Emacs buffers
273@item Emacs process handles
274@end enumerate
275
276Most users need to worry only about the first two. The third, Lisp lists,
277occur very frequently, but almost always behind the scenes.
278
279Strings are the most common type of argument, and consist of nearly any
280character. Special characters---those used by Eshell
281specifically---must be preceded by a backslash (@samp{\}). When in doubt, it
282is safe to add backslashes anywhere and everywhere.
283
284Here is a more complicated @command{echo} example:
285
286@example
287echo A\ Multi-word\ Argument\ With\ A\ \$\ dollar
288@end example
289
290Beyond this, things get a bit more complicated. While not beyond the
291reach of someone wishing to learn, it is definitely beyond the scope of
292this manual to present it all in a simplistic manner. Get comfortable
293with Eshell as a basic command invocation tool, and learn more about the
294commands on your system; then come back when it all sits more familiarly
295on your mind. Have fun!
296
297@node Commands 204@node Commands
298@chapter Commands 205@chapter Commands
299 206