summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMorgan Deters <mdeters@gmail.com>2012-09-14 15:13:37 +0000
committerMorgan Deters <mdeters@gmail.com>2012-09-14 15:13:37 +0000
commit080fc73c61ca11a539fd5239146a828e86b9e29a (patch)
treee85086eafa39013a06b04f7704a17e8a5d977b57 /doc
parent01dfa806851502267e1032483fec48e8b4373634 (diff)
Fix a few minor issues in options processing, improving usability, consistency, error-reporting, and documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/cvc4.1_template.in5
-rw-r--r--doc/libcvc4.3.in15
-rw-r--r--doc/libcvc4.3_template.in80
3 files changed, 85 insertions, 15 deletions
diff --git a/doc/cvc4.1_template.in b/doc/cvc4.1_template.in
index 23eff6110..ad8226261 100644
--- a/doc/cvc4.1_template.in
+++ b/doc/cvc4.1_template.in
@@ -45,10 +45,15 @@ is unspecified and
is connected to a terminal, interactive mode is assumed.
.SH COMMON OPTIONS
+
+.IP "Each option marked with [*] has a --no-OPTIONNAME variant, which reverses the sense of the option."
+
${common_manpage_documentation}
${remaining_manpage_documentation}
+.IP "Each option marked with [*] has a --no-OPTIONNAME variant, which reverses the sense of the option."
+
.\".SH FILES
.\".SH ENVIRONMENT
.SH DIAGNOSTICS
diff --git a/doc/libcvc4.3.in b/doc/libcvc4.3.in
deleted file mode 100644
index 245db524e..000000000
--- a/doc/libcvc4.3.in
+++ /dev/null
@@ -1,15 +0,0 @@
-.\" Process this file with
-.\" groff -man -Tascii libcvc4.3
-.\"
-.TH LIBCVC4 3 "@MAN_DATE@" "CVC4 release @VERSION@" "CVC4 Library Interfaces"
-.SH NAME
-libcvc4 \- a library interface for the CVC4 theorem prover
-.SH DESCRIPTION
-.SH "SEE ALSO"
-.BR cvc4 (1),
-.BR libcvc4parser (3),
-.BR libcvc4compat (3)
-
-Additionally, the CVC4 wiki contains useful information about the
-design and internals of CVC4. It is maintained at
-.BR http://goedel.cs.nyu.edu/wiki/ .
diff --git a/doc/libcvc4.3_template.in b/doc/libcvc4.3_template.in
new file mode 100644
index 000000000..5483099c3
--- /dev/null
+++ b/doc/libcvc4.3_template.in
@@ -0,0 +1,80 @@
+.\" Process this file with
+.\" groff -man -Tascii libcvc4.3
+.\"
+.TH LIBCVC4 3 "@MAN_DATE@" "CVC4 release @VERSION@" "CVC4 Library Interfaces"
+.SH NAME
+libcvc4 \- a library interface for the CVC4 theorem prover
+.SH SYNOPSIS
+
+A small program like:
+
+.RS
+.nf
+#include <iostream>
+#include "expr/expr_manager.h"
+#include "smt/smt_engine.h"
+
+using namespace CVC4;
+
+int main() {
+ ExprManager em;
+ SmtEngine smt(&em);
+ Expr onePlusTwo = em.mkExpr(kind::PLUS,
+ em.mkConst(Rational(1)),
+ em.mkConst(Rational(2)));
+ std::cout << Expr::setlanguage(language::output::LANG_CVC4)
+ << smt.getInfo("name")
+ << " says that 1 + 2 = "
+ << smt.simplify(onePlusTwo)
+ << std::endl;
+
+ return 0;
+}
+.fi
+.RE
+
+gives the output:
+
+.RS
+"cvc4" says that 1 + 2 = 3
+.RE
+
+.SH DESCRIPTION
+
+The main classes of interest in CVC4's API are
+.I ExprManager,
+.I SmtEngine,
+and a few related ones like
+.I Expr
+and
+.I Type.
+
+The
+.I ExprManager
+is used to build up expressions and types, and the
+.I SmtEngine
+is used primarily to make assertions, check satisfiability/validity, and extract models and proofs.
+
+The SmtEngine is also in charge of setting and getting information and options.
+.I SmtEngine::setOption()
+and
+.I SmtEngine::getOption()
+use the following option keys.
+
+.RS
+.TP 10
+.I "COMMON OPTIONS"
+${common_manpage_smt_documentation}
+
+${remaining_manpage_smt_documentation}
+.PD
+.RE
+
+.SH "SEE ALSO"
+.BR cvc4 (1),
+.BR libcvc4parser (3),
+.BR libcvc4compat (3)
+
+Additionally, the CVC4 wiki contains useful information about the
+design and internals of CVC4. It is maintained at
+.BR http://goedel.cs.nyu.edu/wiki/ .
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback