tests: mark main()'s "argc" as unused
[miniexpect.git] / README
1 Miniexpect is a very simple expect-like library
2
3 Expect (https://core.tcl-lang.org/expect/index) is a venerable Tcl
4 program for automating interactive services, often for automating
5 logins over telnet, ftp, ssh, etc.
6
7 Miniexpect is a C library which has a saner interface than libexpect,
8 and doesn't depend on Tcl.  It is also thread safe, const-correct and
9 uses modern C standards.
10
11 Miniexpect is standalone, except that it requires the PCRE2 (Perl
12 Compatible Regular Expressions) library from http://www.pcre.org/.
13 The PCRE2 dependency is fundamental because we want to offer the most
14 powerful regular expression syntax to match on, but more importantly
15 because PCRE2 has a convenient way to detect partial matches which
16 made miniexpect very simple to implement.
17
18 License
19 -------
20
21 The library was written by Richard W.M. Jones <rjones@redhat.com>
22 and is licensed under the Library GPL (LGPL) version 2 or above.
23
24 Source is available from: http://git.annexia.org/?p=miniexpect.git;a=summary
25
26 Using the library
27 -----------------
28
29 If you wanted to copy the library into your own code (instead of
30 linking to it as a dependency), you only need to copy the two files:
31 miniexpect.h, miniexpect.c.
32
33 The API is documented in the manual page (miniexpect.pod / miniexpect.3).
34
35 For examples of how to use the API in reality, see the examples and
36 tests in the source directory.