Merging doc changes from 1.6 r96..97

doc/source/index.rst

@@ -13,8 +13,9 @@ Contents:
    introduction
    installation
    usage
-   known_issues
    bindable_commands
+   known_issues
+   changelog
    
 Indices and tables
 ==================

doc/source/introduction.rst

@@ -11,6 +11,8 @@ like python library can also be useful when implementing commandline like
 interfaces in GUIs. The use of pyreadline for anything but the windows 
 console is still under development.
 
+The pyreadline module does not yet support Python 3.x this will be targeted for the 2.0 version.
+
 
 Dependencies
 ------------
@@ -25,3 +27,7 @@ Unfortunately the module rlcompleter, the module that provides tab completion, i
 
 .. literalinclude:: ../../readline.py
 
+
+History
+-------
+The pyreadline package is based on the ctypes based UNC readline package by Gary Bishop. 

doc/source/known_issues.rst

@@ -2,9 +2,14 @@
 Known issues
 ============
 
-    * If you do not want pyreadline at the standard windows prompt. Delete readline.py
-      from the install directory. This will not interfere with ipython usage, but you will
-      not be able to use the rlcompleter module which requires the readline.py module.
+ * If you do not want pyreadline at the standard windows prompt. Delete readline.py
+   from the install directory. This will not interfere with ipython usage, but you will
+   not be able to use the rlcompleter module which requires the readline.py module.
 
+ * reverse search does not work
 
+ * #488177 exceptions occur when using pyreadline on windows 2008 r2
 
+ * #526850 pyreadline causes conhost.exe to crash on windows 7. When pasting long text (>230 characters)
+   python crashes. Has been observed on Windows 7 with pyreadline 1.5, not a confirmed problem with pyreadline 1.6 series.
+   Workaround is to use the pyreadline paste instead i.e. ctrl-v.

doc/source/usage.rst

@@ -41,6 +41,25 @@ a python syntax is used instead. The available commands are:
     debug_output
       Turn on debug output (on|off). Not implemented yet.
 
+    disable_readline
+      Disable pyreadline completely (True|False).
+
+    allow_ctrl_c
+      Allows use of ctrl-c as copy key, still propagate keyboardinterrupt when not waiting for input.
+
+    ctrl_c_tap_time_interval
+      Set the ctrl-c double tap time interval to be used before issuing a KeyboadInterupt. Used
+      to be able to have ctrl-c bound to copy.
+
+    history_filename
+      Set name of history file. Default is %USERPROFILE%/.pythonhistory
+
+    history_length
+      Set max length of history file default 200
+      
+      
+    
+
 Here is the example config file shipped with pyreadline:
 
 .. literalinclude:: ../../pyreadline/configuration/pyreadlineconfig.ini

pyreadline/configuration/pyreadlineconfig.ini

@@ -1,4 +1,5 @@
 #Bind keys for exit (keys only work on empty lines
+#disable_readline(True)		#Disable pyreadline completely.
 debug_output("off")             #"on" saves log info to./pyreadline_debug_log.txt
                                 #"on_nologfile" only enables print warning messages
 bind_exit_key("Control-d")

pyreadline/release.py

@@ -42,7 +42,7 @@ Features:
     where x is your preferred tap time window, default 0.3 s.
  *  paste pastes first line of content on clipboard. 
  *  ipython_paste, pastes tab-separated data as list of lists or numpy array if all data is numeric
- *  paste_mulitline_code  pastes multi line code, removing any empty lines.
+ *  paste_mulitline_code pastes multi line code, removing any empty lines.
  
  
  The latest development version is always available at the IPython subversion
@@ -76,7 +76,6 @@ classifiers = [u'Development Status :: 5 - Production/Stable',
                u'Programming Language :: Python :: 2.5',
                u'Programming Language :: Python :: 2.6',
                u'Programming Language :: Python :: 2.7',
-
                ]