summaryrefslogtreecommitdiff
path: root/doc/api/pxssh.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/pxssh.rst')
-rw-r--r--doc/api/pxssh.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/api/pxssh.rst b/doc/api/pxssh.rst
index b947f4b..c9c80c6 100644
--- a/doc/api/pxssh.rst
+++ b/doc/api/pxssh.rst
@@ -1,6 +1,14 @@
pxssh - control an SSH session
==============================
+.. note::
+
+ *pxssh* is a screen-scraping wrapper around the SSH command on your system.
+ In many cases, you should consider using
+ `Paramiko <https://github.com/paramiko/paramiko>`_ instead.
+ Paramiko is a Python module which speaks the SSH protocol directly, so it
+ doesn't have the extra complexity of running a local subprocess.
+
.. automodule:: pexpect.pxssh
.. autoclass:: ExceptionPxssh