summaryrefslogtreecommitdiff
path: root/doc/index.rst
diff options
context:
space:
mode:
authorThomas Kluyver <takowl@gmail.com>2013-09-17 12:06:14 -0700
committerThomas Kluyver <takowl@gmail.com>2013-09-17 12:06:14 -0700
commit6b39dd5920a982a52ce3ca8f2b45094ec471acd6 (patch)
treeade9dd990ee6024e7dc2cbe561dd2cd2fa68e8bf /doc/index.rst
parenta25c48ceb5379c7000874500a1a0a8d660686f67 (diff)
downloadpexpect-6b39dd5920a982a52ce3ca8f2b45094ec471acd6.tar.gz
Start moving docs to reST
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..bc6f4ff
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,42 @@
+Pexpected version |version|
+===========================
+
+Pexpected is a Unicode-aware, Python 3 compatible fork of Pexpect, a pure Python
+Expect-like module.
+
+Pexpect makes Python a better tool for controlling other
+applications.
+
+Pexpect is a pure Python module for spawning child applications;
+controlling them; and responding to expected patterns in their output.
+Pexpect works like Don Libes' Expect. Pexpect allows your script to
+spawn a child application and control it as if a human were typing
+commands.
+
+Pexpect can be used for automating interactive applications such as
+ssh, ftp, passwd, telnet, etc. It can be used to a automate setup
+scripts for duplicating software package installations on different
+servers. It can be used for automated software testing. Pexpect is in
+the spirit of Don Libes' Expect, but Pexpect is pure Python. Unlike
+other Expect-like modules for Python, Pexpect does not require TCL or
+Expect nor does it require C extensions to be compiled. It should work
+on any platform that supports the standard Python pty module. The
+Pexpect interface was designed to be easy to use.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ install
+ overview
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+