##// END OF EJS Templates
Update more examples of command line args in the docs, and make a few minor formatting corrections.
Thomas Kluyver -
Show More
@@ -50,7 +50,7 b' to your configuration file::'
50 'myextension'
50 'myextension'
51 ]
51 ]
52
52
53 To load that same extension at runtime, use the ``%load_ext`` magic::
53 To load that same extension at runtime, use the ``%load_ext`` magic:
54
54
55 .. sourcecode:: ipython
55 .. sourcecode:: ipython
56
56
@@ -336,7 +336,7 b" Let's start by showing how a profile is used:"
336
336
337 .. code-block:: bash
337 .. code-block:: bash
338
338
339 $ ipython profile=sympy
339 $ ipython --profile=sympy
340
340
341 This tells the :command:`ipython` command line program to get its configuration
341 This tells the :command:`ipython` command line program to get its configuration
342 from the "sympy" profile. The file names for various profiles do not change. The
342 from the "sympy" profile. The file names for various profiles do not change. The
@@ -350,7 +350,7 b' The general pattern is this: simply create a new profile with:'
350 ipython profile create <name>
350 ipython profile create <name>
351
351
352 which adds a directory called ``profile_<name>`` to your IPython directory. Then
352 which adds a directory called ``profile_<name>`` to your IPython directory. Then
353 you can load this profile by adding ``profile=<name>`` to your command line
353 you can load this profile by adding ``--profile=<name>`` to your command line
354 options. Profiles are supported by all IPython applications.
354 options. Profiles are supported by all IPython applications.
355
355
356 IPython ships with some sample profiles in :file:`IPython/config/profile`. If
356 IPython ships with some sample profiles in :file:`IPython/config/profile`. If
@@ -374,7 +374,7 b' object. Values are assigned in much the same way as in a config file:'
374
374
375 .. code-block:: bash
375 .. code-block:: bash
376
376
377 $> ipython InteractiveShell.use_readline=False BaseIPythonApplication.profile='myprofile'
377 $> ipython --InteractiveShell.use_readline=False --BaseIPythonApplication.profile='myprofile'
378
378
379 Is the same as adding:
379 Is the same as adding:
380
380
@@ -394,9 +394,9 b" used traits, so you don't have to specify the whole class name. For these **alia"
394
394
395 .. code-block:: bash
395 .. code-block:: bash
396
396
397 $> ipython profile='myprofile'
397 $> ipython --profile='myprofile'
398 # is equivalent to
398 # is equivalent to
399 $> ipython BaseIPythonApplication.profile='myprofile'
399 $> ipython --BaseIPythonApplication.profile='myprofile'
400
400
401 Flags
401 Flags
402 -----
402 -----
@@ -411,11 +411,11 b' For instance:'
411
411
412 $> ipcontroller --debug
412 $> ipcontroller --debug
413 # is equivalent to
413 # is equivalent to
414 $> ipcontroller Application.log_level=DEBUG
414 $> ipcontroller --Application.log_level=DEBUG
415 # and
415 # and
416 $> ipython --pylab
416 $> ipython --pylab
417 # is equivalent to
417 # is equivalent to
418 $> ipython pylab=auto
418 $> ipython --pylab=auto
419
419
420 Subcommands
420 Subcommands
421 -----------
421 -----------
@@ -427,14 +427,14 b' Some IPython applications have **subcommands**. Subcommands are modeled after'
427
427
428 .. code-block:: bash
428 .. code-block:: bash
429
429
430 $> ipython qtconsole profile=myprofile
430 $> ipython qtconsole --profile=myprofile
431
431
432 and :command:`ipcluster` is simply a wrapper for its various subcommands (start,
432 and :command:`ipcluster` is simply a wrapper for its various subcommands (start,
433 stop, engines).
433 stop, engines).
434
434
435 .. code-block:: bash
435 .. code-block:: bash
436
436
437 $> ipcluster start profile=myprofile n=4
437 $> ipcluster start --profile=myprofile --n=4
438
438
439
439
440 To see a list of the available aliases, flags, and subcommands for an IPython application, simply pass ``-h`` or ``--help``. And to see the full list of configurable options (*very* long), pass ``--help-all``.
440 To see a list of the available aliases, flags, and subcommands for an IPython application, simply pass ``-h`` or ``--help``. And to see the full list of configurable options (*very* long), pass ``--help-all``.
@@ -349,7 +349,8 b' We basically need to be able to test the following types of code:'
349 Nose will pick them up as long as they conform to the (flexible) conventions
349 Nose will pick them up as long as they conform to the (flexible) conventions
350 used by nose to recognize tests.
350 used by nose to recognize tests.
351
351
352 2. Python files containing doctests. Here, we have two possibilities:
352 2. Python files containing doctests. Here, we have two possibilities:
353
353 - The prompts are the usual ``>>>`` and the input is pure Python.
354 - The prompts are the usual ``>>>`` and the input is pure Python.
354 - The prompts are of the form ``In [1]:`` and the input can contain extended
355 - The prompts are of the form ``In [1]:`` and the input can contain extended
355 IPython expressions.
356 IPython expressions.
@@ -361,6 +362,7 b' We basically need to be able to test the following types of code:'
361
362
362 3. ReStructuredText files that contain code blocks. For this type of file, we
363 3. ReStructuredText files that contain code blocks. For this type of file, we
363 have three distinct possibilities for the code blocks:
364 have three distinct possibilities for the code blocks:
365
364 - They use ``>>>`` prompts.
366 - They use ``>>>`` prompts.
365 - They use ``In [1]:`` prompts.
367 - They use ``In [1]:`` prompts.
366 - They are standalone blocks of pure Python code without any prompts.
368 - They are standalone blocks of pure Python code without any prompts.
General Comments 0
You need to be logged in to leave comments. Login now