summaryrefslogtreecommitdiff
path: root/macros/plain/contrib/xintsession/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/plain/contrib/xintsession/README.md')
-rw-r--r--macros/plain/contrib/xintsession/README.md74
1 files changed, 74 insertions, 0 deletions
diff --git a/macros/plain/contrib/xintsession/README.md b/macros/plain/contrib/xintsession/README.md
new file mode 100644
index 0000000000..9821fcd2e7
--- /dev/null
+++ b/macros/plain/contrib/xintsession/README.md
@@ -0,0 +1,74 @@
+# xintsession README #
+
+## Usage ##
+
+xintsession.tex is to be used with etex (or pdftex or the other engines
+with Plain as preloaded format) *interactively on the command line*.
+
+It will load [xintexpr](http://www.ctan.org/pkg/xint) and
+[polexpr](http://www.ctan.org/pkg/polexpr)
+(its version `0.8` or later is needed).
+
+The following explanations have been tested on a Unixen (Mac OS),
+please adapt to your shell environment.
+
+You need 3 small steps to start a session:
+
+1. execute `etex`, or better, `rlwrap etex` to benefit from arrow keys
+ navigation and other improvements such as parentheses highlighting in
+ the input (and optionally, use the `-jobname` option here)
+2. at the `**` prompt, enter `xintsession` and hit `RET`,
+3. a welcome message is printed, hit the `RET` key at the `*` prompt.
+
+You are now ready to make computations!
+Here is an example session (spaces do not matter):
+
+ (Please type a command or say `\end')
+ * 1+1/2+1/3+1/4+1/5;
+ (@_1) 137/60
+ * @_^3 ;
+ (@_2) 2571353/216000
+ * add(1/i, i=1..50);
+ (@_3) 13943237577224054960759/3099044504245996706400
+ *&fp
+ fp mode (16 digits)
+ * @_;
+ (@_4) 4.499205338329425
+ * add(1/i, i=1..1000);
+ (@_5) 7.485470860550346
+ *&bye
+ Did I say something wrong?
+ Session transcript written on xintsession-210413_20h24.tex
+ No pages of output.
+ Transcript written on xintsession.log.
+
+As this example shows, the computational engine can work in various
+modes: exact, fp, fp16, fp24, fp32, int, and pol. One can define
+variables and functions using `:=` syntax.
+
+If ill-formed input drops you into TeX error interaction mode, try
+hitting `S` it may work to bring you back to normal session.
+
+For important explanations, enter `&help` at the prompt.
+
+## License ##
+
+Copyright (c) 2021 Jean-François Burnol
+
+See documentation of package [xintexpr](http://www.ctan.org/pkg/xint) for
+contact information.
+
+This Work may be distributed and/or modified under the conditions of the
+LaTeX Project Public License version 1.3c. This version of this license
+is in
+
+> <http://www.latex-project.org/lppl/lppl-1-3c.txt>
+
+and version 1.3 or later is part of all distributions of LaTeX version
+2005/12/01 or later.
+
+This Work has the LPPL maintenance status author-maintained.
+
+The Author of this Work is Jean-François Burnol.
+
+This Work consists of the package files xintsession.tex and README.md