##// END OF EJS Templates
Add note about libedit on OS X.
Fernando Perez -
Show More
@@ -161,19 +161,26 b" common situations where you won't have a working :mod:`readline` module:"
161 On OS X, the built-in Python doesn't not have :mod:`readline` because of
161 On OS X, the built-in Python doesn't not have :mod:`readline` because of
162 license issues. Starting with OS X 10.5 (Leopard), Apple's built-in Python has
162 license issues. Starting with OS X 10.5 (Leopard), Apple's built-in Python has
163 a BSD-licensed not-quite-compatible readline replacement. As of IPython 0.9,
163 a BSD-licensed not-quite-compatible readline replacement. As of IPython 0.9,
164 many of the issues related to the differences between readline and libedit have
164 many of the issues related to the differences between readline and libedit seem
165 been resolved. For many users, libedit may be sufficient.
165 to have been resolved. While you may find libedit sufficient, we have
166 occasional reports of bugs with it and several developers who use OS X as their
167 main environment consider libedit unacceptable for productive, regular use with
168 IPython.
166
169
167 Most users on OS X will want to get the full :mod:`readline` module. To get a
170 Therefore, we *strongly* recommend that on OS X you get the full
168 working :mod:`readline` module, just do (with :mod:`setuptools` installed)::
171 :mod:`readline` module. We will *not* consider completion/history problems to
172 be bugs for IPython if you are using libedit.
173
174 To get a working :mod:`readline` module, just do (with :mod:`setuptools`
175 installed)::
169
176
170 $ easy_install readline
177 $ easy_install readline
171
178
172 .. note:
179 .. note::
173
180
174 Other Python distributions on OS X (such as fink, MacPorts and the
181 Other Python distributions on OS X (such as fink, MacPorts and the official
175 official python.org binaries) already have readline installed so
182 python.org binaries) already have readline installed so you likely don't
176 you don't have to do this step.
183 have to do this step.
177
184
178 If needed, the readline egg can be build and installed from source (see the
185 If needed, the readline egg can be build and installed from source (see the
179 wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard).
186 wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard).
General Comments 0
You need to be logged in to leave comments. Login now