##// END OF EJS Templates
Fixes to guiref after more careful proofreading.
Fernando Perez -
Show More
@@ -283,13 +283,13 b' The following magic functions are currently available:'
283
283
284 gui_reference = """\
284 gui_reference = """\
285 ===============================
285 ===============================
286 The IPython graphical console
286 The graphical IPython console
287 ===============================
287 ===============================
288
288
289 This console is designed to emulate in many aspects the look, feel and workflow
289 This console is designed to emulate the look, feel and workflow of a terminal
290 typical of a terminal environment, but it adds support for a number of
290 environment, while adding a number of enhancements that are simply not possible
291 enhancements that are simply not possible in a real terminal, such as inline
291 in a real terminal, such as inline syntax highlighting, true multiline editing,
292 syntax highlighting, true multiline editing, inline graphics and much more.
292 inline graphics and much more.
293
293
294 This quick reference document contains the basic information you'll need to
294 This quick reference document contains the basic information you'll need to
295 know to make the most efficient use of it. For the various command line
295 know to make the most efficient use of it. For the various command line
@@ -332,7 +332,7 b' accepting arbitrarily many lines until either you enter an extra blank line or'
332 you hit ``Shift-Enter`` (the key binding that forces execution). When a
332 you hit ``Shift-Enter`` (the key binding that forces execution). When a
333 multiline cell is entered, IPython analyzes it and executes its code producing
333 multiline cell is entered, IPython analyzes it and executes its code producing
334 an ``Out[n]`` prompt only for the last expression in it, while the rest of the
334 an ``Out[n]`` prompt only for the last expression in it, while the rest of the
335 cell is executed as if it was a script. A few examples should clarify this::
335 cell is executed as if it was a script. An example should clarify this::
336
336
337 In [3]: x=1 # Hit C-Enter here
337 In [3]: x=1 # Hit C-Enter here
338 ...: y=2 # from now on, regular Enter is sufficient
338 ...: y=2 # from now on, regular Enter is sufficient
@@ -346,15 +346,15 b' The behavior where an extra blank line forces execution is only active if you'
346 are actually typing at the keyboard each line, and is meant to make it mimic
346 are actually typing at the keyboard each line, and is meant to make it mimic
347 the IPython terminal behavior. If you paste a long chunk of input (for example
347 the IPython terminal behavior. If you paste a long chunk of input (for example
348 a long script copied form an editor or web browser), it can contain arbitrarily
348 a long script copied form an editor or web browser), it can contain arbitrarily
349 many intermediate blank lines and they won't cause any problems. You can then
349 many intermediate blank lines and they won't cause any problems. As always,
350 make it execute by appending a blank line *at the end* or hitting
350 you can then make it execute by appending a blank line *at the end* or hitting
351 ``Shift-Enter`` anywhere within the cell.
351 ``Shift-Enter`` anywhere within the cell.
352
352
353 With the up arrow key, you can retrieve previous blocks of input that contain
353 With the up arrow key, you can retrieve previous blocks of input that contain
354 multiple lines. You can move inside of it like you would in any text editor.
354 multiple lines. You can move inside of a multiline cell like you would in any
355 When you want it executed, the simplest thing to do is to hit the force
355 text editor. When you want it executed, the simplest thing to do is to hit the
356 execution key, ``Shift-Enter`` (though you can also navigate to the end and
356 force execution key, ``Shift-Enter`` (though you can also navigate to the end
357 append a blank line by using ``Enter`` twice).
357 and append a blank line by using ``Enter`` twice).
358
358
359 If you've edited a multiline cell and accidentally navigate out of it with the
359 If you've edited a multiline cell and accidentally navigate out of it with the
360 up or down arrow keys, IPython will clear the cell and replace it with the
360 up or down arrow keys, IPython will clear the cell and replace it with the
@@ -366,41 +366,41 b' keybinding, ``Control-z``.'
366 Key bindings
366 Key bindings
367 ============
367 ============
368
368
369 The IPython console supports most of the basic Emacs line-oriented
369 The IPython console supports most of the basic Emacs line-oriented keybindings,
370 keybindings, in addition to some of its own.
370 in addition to some of its own.
371
371
372 The keybinding prefixes mean:
372 The keybinding prefixes mean:
373
373
374 - C : Control
374 - ``C``: Control
375 - S : Shift
375 - ``S``: Shift
376 - M : Meta (typically the Alt key)
376 - ``M``: Meta (typically the Alt key)
377
377
378 The keybindings themselves are:
378 The keybindings themselves are:
379
379
380 - Enter : insert new line (may cause execution, see above).
380 - ``Enter``: insert new line (may cause execution, see above).
381 - C-Enter : force new line, *never* causes execution.
381 - ``C-Enter``: force new line, *never* causes execution.
382 - S-Enter : *force* execution regardless of where cursor is, no newline added.
382 - ``S-Enter``: *force* execution regardless of where cursor is, no newline added.
383 - C-c : copy highlighted text to clipboard (prompts are automatically stripped).
383 - ``C-c``: copy highlighted text to clipboard (prompts are automatically stripped).
384 - C-S-c: copy highlighted text to clipboard (prompts are not stripped).
384 - ``C-S-c``: copy highlighted text to clipboard (prompts are not stripped).
385 - C-v : paste text from clipboard.
385 - ``C-v``: paste text from clipboard.
386 - C-z : undo (retrieves lost text if you move out of a cell with the arrows).
386 - ``C-z``: undo (retrieves lost text if you move out of a cell with the arrows).
387 - C-S-z : redo.
387 - ``C-S-z``: redo.
388 - C-o : move to 'other' area, between pager and terminal.
388 - ``C-o``: move to 'other' area, between pager and terminal.
389 - C-l : clear terminal.
389 - ``C-l``: clear terminal.
390 - C-a : go to beginning of line.
390 - ``C-a``: go to beginning of line.
391 - C-e : go to end of line.
391 - ``C-e``: go to end of line.
392 - C-k : kill from cursor to the end of the line.
392 - ``C-k``: kill from cursor to the end of the line.
393 - C-y : yank (paste)
393 - ``C-y``: yank (paste)
394 - C-p : previous line (like up arrow)
394 - ``C-p``: previous line (like up arrow)
395 - C-n : next line (like down arrow)
395 - ``C-n``: next line (like down arrow)
396 - C-f : forward (like right arrow)
396 - ``C-f``: forward (like right arrow)
397 - C-b : back (like left arrow)
397 - ``C-b``: back (like left arrow)
398 - C-d : delete next character.
398 - ``C-d``: delete next character.
399 - M-< : move to the beginning of the input region.
399 - ``M-<``: move to the beginning of the input region.
400 - M-> : move to the end of the input region.
400 - ``M->``: move to the end of the input region.
401 - M-d : delete next word.
401 - ``M-d``: delete next word.
402 - M-Backspace : delete previous word.
402 - ``M-Backspace``: delete previous word.
403 - C-. : forced restart of the kernel (a confirmation dialog appears).
403 - ``C-.``: force a kernel restart (a confirmation dialog appears).
404
404
405
405
406 The IPython pager
406 The IPython pager
@@ -411,8 +411,8 b' You can control where this pager appears with the ``--paging`` command-line'
411 flag:
411 flag:
412
412
413 - default: it is overlaid on top of the main terminal. You must quit the pager
413 - default: it is overlaid on top of the main terminal. You must quit the pager
414 to get back to the terminal (similar to how a kkk pager such as ``less``
414 to get back to the terminal (similar to how a pager such as ``less`` or
415 works).
415 ``more`` works).
416
416
417 - vertical: the console is made double-tall, and the pager appears on the
417 - vertical: the console is made double-tall, and the pager appears on the
418 bottom area when needed. You can view its contents while using the terminal.
418 bottom area when needed. You can view its contents while using the terminal.
@@ -427,7 +427,8 b' terminal and pager as follows:'
427 - Control-o: goes from one to another always.
427 - Control-o: goes from one to another always.
428 - Mouse: click on either.
428 - Mouse: click on either.
429
429
430 In all cases, the ``q`` or ``Escape`` keys quit the pager.
430 In all cases, the ``q`` or ``Escape`` keys quit the pager (when used with the
431 focus on the pager area).
431
432
432
433
433 Running subprocesses
434 Running subprocesses
@@ -436,15 +437,15 b' Running subprocesses'
436 The graphical IPython console uses the ``pexpect`` module to run subprocesses
437 The graphical IPython console uses the ``pexpect`` module to run subprocesses
437 when you type ``!command``. This has a number of advantages (true asynchronous
438 when you type ``!command``. This has a number of advantages (true asynchronous
438 output from subprocesses as well as very robust termination of rogue
439 output from subprocesses as well as very robust termination of rogue
439 subprocesses with Control-C), as well as some limitations. The main limitation
440 subprocesses with ``Control-C``), as well as some limitations. The main
440 is that you can *not* interact back with the subprocess, so anything that
441 limitation is that you can *not* interact back with the subprocess, so anything
441 invokes a pager or expects you to type input into it will block and hang (you
442 that invokes a pager or expects you to type input into it will block and hang
442 can kill it with Control-C).
443 (you can kill it with ``Control-C``).
443
444
444 We have provided as magics ``%less`` (aliased to ``%more``), ``%clear`` to
445 We have provided as magics ``%less`` to page files (aliased to ``%more``),
445 clear the terminal, and ``%man`` on Linux/OSX to cover the most common commands
446 ``%clear`` to clear the terminal, and ``%man`` on Linux/OSX. These cover the
446 you'd want to call in your subshell, but you need to be aware of this
447 most common commands you'd want to call in your subshell and that would cause
447 limitation.
448 problems if invoked via ``!cmd``, but you need to be aware of this limitation.
448
449
449
450
450 Inline matplotlib graphics
451 Inline matplotlib graphics
General Comments 0
You need to be logged in to leave comments. Login now