##// END OF EJS Templates
Add note about libedit on OS X. Closes gh-150.
Fernando Perez -
Show More
@@ -187,14 +187,22 b" common situations where you won't have a working :mod:`readline` module:"
187
187
188 * If you are running Windows, which doesn't have a :mod:`readline` module.
188 * If you are running Windows, which doesn't have a :mod:`readline` module.
189
189
190
190 On OS X, the built-in Python doesn't not have :mod:`readline` because of
191 On OS X, the built-in Python doesn't not have :mod:`readline` because of
191 license issues. Starting with OS X 10.5 (Leopard), Apple's built-in Python has
192 license issues. Starting with OS X 10.5 (Leopard), Apple's built-in Python has
192 a BSD-licensed not-quite-compatible readline replacement. As of IPython 0.9,
193 a BSD-licensed not-quite-compatible readline replacement. As of IPython 0.9,
193 many of the issues related to the differences between readline and libedit have
194 many of the issues related to the differences between readline and libedit seem
194 been resolved. For many users, libedit may be sufficient.
195 to have been resolved. While you may find libedit sufficient, we have
196 occasional reports of bugs with it and several developers who use OS X as their
197 main environment consider libedit unacceptable for productive, regular use with
198 IPython.
199
200 Therefore, we *strongly* recommend that on OS X you get the full
201 :mod:`readline` module. We will *not* consider completion/history problems to
202 be bugs for IPython if you are using libedit.
195
203
196 Most users on OS X will want to get the full :mod:`readline` module. To get a
204 To get a working :mod:`readline` module, just do (with :mod:`setuptools`
197 working :mod:`readline` module, just do (with :mod:`setuptools` installed):
205 installed):
198
206
199 .. code-block:: bash
207 .. code-block:: bash
200
208
@@ -202,9 +210,9 b' working :mod:`readline` module, just do (with :mod:`setuptools` installed):'
202
210
203 .. note::
211 .. note::
204
212
205 Other Python distributions on OS X (such as fink, MacPorts and the
213 Other Python distributions on OS X (such as fink, MacPorts and the official
206 official python.org binaries) already have readline installed so
214 python.org binaries) already have readline installed so you likely don't
207 you don't have to do this step.
215 have to do this step.
208
216
209 If needed, the readline egg can be build and installed from source (see the
217 If needed, the readline egg can be build and installed from source (see the
210 wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard).
218 wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard).
General Comments 0
You need to be logged in to leave comments. Login now