diff options
| author | Aidan Gauland | 2014-01-02 22:32:20 +1300 |
|---|---|---|
| committer | Aidan Gauland | 2014-01-02 22:32:20 +1300 |
| commit | f2299e89bc4dbc51dc093b9ea4245d836de480bb (patch) | |
| tree | a12f1134f49b522321b4b48a49035e7ff4c86317 /doc/misc/eshell.texi | |
| parent | 94ee87197f4fb33272972231f41d5db603d73afe (diff) | |
| download | emacs-f2299e89bc4dbc51dc093b9ea4245d836de480bb.tar.gz emacs-f2299e89bc4dbc51dc093b9ea4245d836de480bb.zip | |
* eshell.text (Command Basics): Removed `Command basics' chapter.
Diffstat (limited to 'doc/misc/eshell.texi')
| -rw-r--r-- | doc/misc/eshell.texi | 93 |
1 files changed, 0 insertions, 93 deletions
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, | |||
| 202 | requests, bug reports and encouragement. Thanks a lot! Without you | 201 | requests, bug reports and encouragement. Thanks a lot! Without you |
| 203 | there would be no new releases of Eshell. | 202 | there would be no new releases of Eshell. |
| 204 | 203 | ||
| 205 | @node Command basics | ||
| 206 | @chapter Basic overview | ||
| 207 | |||
| 208 | A command shell is a means of entering verbally-formed commands. This | ||
| 209 | is really all that it does, and every feature described in this manual | ||
| 210 | is a means to that end. Therefore, it's important to take firm hold on | ||
| 211 | exactly what a command is, and how it fits in the overall picture of | ||
| 212 | things. | ||
| 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 | |||
| 222 | Commands are expressed using @dfn{script}, a special shorthand language | ||
| 223 | computers can understand with no trouble. Script is an extremely simple | ||
| 224 | language; oddly enough, this is what makes it look so complicated! | ||
| 225 | Whereas normal languages use a variety of embellishments, the form of a | ||
| 226 | script command is always: | ||
| 227 | |||
| 228 | @example | ||
| 229 | @var{verb} [@var{arguments}] | ||
| 230 | @end example | ||
| 231 | |||
| 232 | The verb expresses what you want your computer to do. There are a fixed | ||
| 233 | number of verbs, although this number is usually quite large. On the | ||
| 234 | author's computer, it reaches almost 1400 in number. But of course, | ||
| 235 | only a handful of these are really necessary. | ||
| 236 | |||
| 237 | Sometimes, the verb is all that's written. A verb is always a single | ||
| 238 | word, usually related to the task it performs. @command{reboot} is a | ||
| 239 | good example. Entering that on GNU/Linux will reboot the | ||
| 240 | computer---assuming you have sufficient privileges. | ||
| 241 | |||
| 242 | Other verbs require more information. These are usually very capable | ||
| 243 | verbs, and must be told specifically what to do. The extra information | ||
| 244 | is given in the form of @dfn{arguments}. For example, the | ||
| 245 | @command{echo} verb prints back whatever arguments you type. It | ||
| 246 | requires these arguments to know what to echo. A proper use of | ||
| 247 | @command{echo} looks like this: | ||
| 248 | |||
| 249 | @example | ||
| 250 | echo This is an example of using echo! | ||
| 251 | @end example | ||
| 252 | |||
| 253 | This script command causes the computer to echo back: ``This is an | ||
| 254 | example of using echo!'' | ||
| 255 | |||
| 256 | Although command verbs are always simple words, like @command{reboot} or | ||
| 257 | @command{echo}, arguments may have a wide variety of forms. There are | ||
| 258 | textual arguments, numerical arguments---even Lisp arguments. | ||
| 259 | Distinguishing these different types of arguments requires special | ||
| 260 | typing, for the computer to know exactly what you mean. | ||
| 261 | |||
| 262 | @node Command arguments | ||
| 263 | @section Command arguments | ||
| 264 | |||
| 265 | Eshell 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 | |||
| 276 | Most users need to worry only about the first two. The third, Lisp lists, | ||
| 277 | occur very frequently, but almost always behind the scenes. | ||
| 278 | |||
| 279 | Strings are the most common type of argument, and consist of nearly any | ||
| 280 | character. Special characters---those used by Eshell | ||
| 281 | specifically---must be preceded by a backslash (@samp{\}). When in doubt, it | ||
| 282 | is safe to add backslashes anywhere and everywhere. | ||
| 283 | |||
| 284 | Here is a more complicated @command{echo} example: | ||
| 285 | |||
| 286 | @example | ||
| 287 | echo A\ Multi-word\ Argument\ With\ A\ \$\ dollar | ||
| 288 | @end example | ||
| 289 | |||
| 290 | Beyond this, things get a bit more complicated. While not beyond the | ||
| 291 | reach of someone wishing to learn, it is definitely beyond the scope of | ||
| 292 | this manual to present it all in a simplistic manner. Get comfortable | ||
| 293 | with Eshell as a basic command invocation tool, and learn more about the | ||
| 294 | commands on your system; then come back when it all sits more familiarly | ||
| 295 | on your mind. Have fun! | ||
| 296 | |||
| 297 | @node Commands | 204 | @node Commands |
| 298 | @chapter Commands | 205 | @chapter Commands |
| 299 | 206 | ||