diff --git a/IPython/frontend/terminal/ipapp.py b/IPython/frontend/terminal/ipapp.py index deea42f..d82a059 100755 --- a/IPython/frontend/terminal/ipapp.py +++ b/IPython/frontend/terminal/ipapp.py @@ -69,6 +69,9 @@ ipython --profile=foo # start with profile foo ipython qtconsole # start the qtconsole GUI application ipython qtconsole -h # show the help string for the qtconsole subcmd +ipython console # start the terminal-based console application +ipython console -h # show the help string for the console subcmd + ipython profile create foo # create profile foo w/ default config files ipython profile -h # show the help string for the profile subcmd """ @@ -209,7 +212,7 @@ class TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp): """Launch the IPython Qt Console.""" ), notebook=('IPython.frontend.html.notebook.notebookapp.NotebookApp', - """Launch the IPython HTML Notebook Server""" + """Launch the IPython HTML Notebook Server.""" ), profile = ("IPython.core.profileapp.ProfileApp", "Create and manage IPython profiles." @@ -217,8 +220,8 @@ class TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp): kernel = ("IPython.zmq.ipkernel.IPKernelApp", "Start a kernel without an attached frontend." ), - zmq=('IPython.frontend.zmqterminal.app.ZMQTerminalIPythonApp', - """Launch two-process Terminal session with 0MQ.""" + console=('IPython.frontend.zmqterminal.app.ZMQTerminalIPythonApp', + """Launch the IPython terminal-based Console.""" ), )) diff --git a/IPython/frontend/zmqterminal/app.py b/IPython/frontend/zmqterminal/app.py index a084545..6a5faf9 100644 --- a/IPython/frontend/zmqterminal/app.py +++ b/IPython/frontend/zmqterminal/app.py @@ -37,7 +37,7 @@ from IPython.frontend.zmqterminal.interactiveshell import ZMQTerminalInteractive _examples = """ ipython console # start the ZMQ-based console -ipython console --pylab # start with pylab plotting mode +ipython console --existing # connect to an existing ipython session """ #----------------------------------------------------------------------------- @@ -63,11 +63,30 @@ aliases.update(frontend_aliases) class ZMQTerminalIPythonApp(TerminalIPythonApp, IPythonMixinConsoleApp): + name = "ipython console" """Start a terminal frontend to the IPython zmq kernel.""" - + + description = """ + The IPython terminal-based Console. + + This launches a Console application inside a terminal. + + The Console supports various extra features beyond the traditional + single-process Terminal IPython shell, such as connecting to an + existing ipython session, via: + + ipython console --existing + + where the previous session could have been created by another ipython + console, an ipython qtconsole, or by opening an ipython notebook. + + """ + examples = _examples + classes = List([IPKernelApp, ZMQTerminalInteractiveShell]) flags = Dict(flags) aliases = Dict(aliases) + subcommands = Dict() def parse_command_line(self, argv=None): super(ZMQTerminalIPythonApp, self).parse_command_line(argv) IPythonMixinConsoleApp.parse_command_line(self,argv)