summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJeff Quast <jquast@io.com>2014-12-18 17:36:05 -0800
committerJeff Quast <jquast@io.com>2014-12-18 17:36:22 -0800
commitad7c35dce59db55f9d3dd5fea8b925abc81211ca (patch)
tree4b27b6eccfe88e656f0d69b0edf27a461fa3fe47 /doc
parent01ea0ff440facd47894c076747488c28291a47cc (diff)
parent77357d107b1ebb38287695149d7cf1e66df4addd (diff)
downloadpexpect-git-ad7c35dce59db55f9d3dd5fea8b925abc81211ca.tar.gz
Merge remote-tracking branch 'origin/master' into issue-104-cannot-exec-setuids
Conflicts: pexpect/__init__.py
Diffstat (limited to 'doc')
-rw-r--r--doc/api/pxssh.rst4
-rw-r--r--doc/commonissues.rst12
-rw-r--r--doc/overview.rst2
-rw-r--r--doc/requirements.txt1
4 files changed, 18 insertions, 1 deletions
diff --git a/doc/api/pxssh.rst b/doc/api/pxssh.rst
index 0b67839..b947f4b 100644
--- a/doc/api/pxssh.rst
+++ b/doc/api/pxssh.rst
@@ -23,6 +23,10 @@ pxssh class
server to ask for a password. Note that the sysadmin can disable password
logins, in which case this won't work.
+ .. attribute:: options
+
+ The dictionary of user specified SSH options, eg, ``options = dict(StrictHostKeyChecking="no", UserKnownHostsFile="/dev/null")``
+
.. automethod:: login
.. automethod:: logout
.. automethod:: prompt
diff --git a/doc/commonissues.rst b/doc/commonissues.rst
index c4fc58d..26d0e2b 100644
--- a/doc/commonissues.rst
+++ b/doc/commonissues.rst
@@ -101,3 +101,15 @@ The only solution I have found is to use public key authentication with SSH.
This bypasses the need for a password. I'm not happy with this solution. The
problem is due to poor support for Solaris Pseudo TTYs in the Python Standard
Library.
+
+child does not receive full input, emits BEL
+--------------------------------------------
+
+You may notice when running for example cat(1) or base64(1), when sending a
+very long input line, that it is not fully received, and the BEL ('\a') may
+be found in output.
+
+By default the child terminal matches the parent, which is often in "canonical
+mode processing". You may wish to disable this mode. The exact limit of a line
+varies by operating system, and details of disabling canonical mode may be
+found in the docstring of :meth:`~pexpect.spawn.send`.
diff --git a/doc/overview.rst b/doc/overview.rst
index 133767f..a04e389 100644
--- a/doc/overview.rst
+++ b/doc/overview.rst
@@ -17,7 +17,7 @@ Here is an example of Pexpect in action::
child.expect('ftp> ')
child.sendline('lcd /tmp')
child.expect('ftp> ')
- child.sendline('cd pub')
+ child.sendline('cd pub/OpenBSD')
child.expect('ftp> ')
child.sendline('get README')
child.expect('ftp> ')
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..57ebb2d
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1 @@
+ptyprocess