summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRed_M <pooatyou.com@gmail.com>2018-05-20 19:16:30 +1000
committerRed_M <pooatyou.com@gmail.com>2018-05-20 19:16:30 +1000
commitf353c713aa00e41059ae989da4039f6f07e36718 (patch)
tree460b1862c4d142f42ae5570951d575340a8d32c2
parent7fbc45e4e4399085873f6495ce357278cadf9671 (diff)
downloadpexpect-f353c713aa00e41059ae989da4039f6f07e36718.tar.gz
Add docstring for SSH config as per #429.
-rw-r--r--pexpect/pxssh.py9
1 files changed, 7 insertions, 2 deletions
diff --git a/pexpect/pxssh.py b/pexpect/pxssh.py
index 2f22ace..44e4c60 100644
--- a/pexpect/pxssh.py
+++ b/pexpect/pxssh.py
@@ -294,10 +294,15 @@ class pxssh (spawn):
session to do so. Setting this option to `False` and not having an active session
will trigger an error.
- Set ``ssh_key`` to a string that is a file path to an SSH private key. Doing so
- will use that SSH key for the session authentication.
+ Setting ``ssh_key`` to a file path to an SSH private key will use that SSH key
+ for the session authentication.
Set ``ssh_key`` to `True` to force passing the current SSH authentication socket
to the desired ``hostname``.
+
+ Setting ``ssh_config`` to a file path of an SSH client config file will pass that
+ file to the client to handle itself. You may set any options you wish in here, however
+ doing so will require you to post extra information that you may not want to if you
+ run into issues.
'''
session_regex_array = ["(?i)are you sure you want to continue connecting", original_prompt, password_regex, "(?i)permission denied", "(?i)terminal type", TIMEOUT]