summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/xint/README.html
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-10-28 22:36:18 +0000
committerKarl Berry <karl@freefriends.org>2014-10-28 22:36:18 +0000
commit6751ea76abc2df59197ab3c20fe780ecf9de81fb (patch)
treef0ddbcd0525b27fc8755bec4c667f0a4b076b2a0 /Master/texmf-dist/doc/generic/xint/README.html
parent1eff88f8256fc97ff44035cfd29e162947e4fd67 (diff)
xint (28oct14)
git-svn-id: svn://tug.org/texlive/trunk@35458 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/generic/xint/README.html')
-rw-r--r--Master/texmf-dist/doc/generic/xint/README.html128
1 files changed, 128 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/generic/xint/README.html b/Master/texmf-dist/doc/generic/xint/README.html
new file mode 100644
index 00000000000..be17b072a27
--- /dev/null
+++ b/Master/texmf-dist/doc/generic/xint/README.html
@@ -0,0 +1,128 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta name="generator" content="pandoc" />
+ <meta name="author" content="xint v1.1" />
+ <title>README</title>
+ <style type="text/css">code{white-space: pre;}</style>
+ <style type="text/css">
+ body{margin-left : 10%; margin-right : 15%; margin-top: 4ex; font-size: 14pt;}
+ pre {white-space: pre-wrap; }
+ code {white-space: pre-wrap; }
+ .mono {font-family: monospace;}
+ </style>
+</head>
+<body>
+<div id="header">
+<h1 class="title">README</h1>
+<h2 class="author">xint v1.1</h2>
+<h3 class="date">2014/10/28</h3>
+</div>
+<div id="TOC">
+<ul>
+<li><a href="#usage">Usage</a><ul>
+<li><a href="#with-latex">With LaTeX</a></li>
+<li><a href="#with-tex">With TeX</a></li>
+</ul></li>
+<li><a href="#installation">Installation</a><ul>
+<li><a href="#method-a-using-the-package-manager-of-your-tex-distribution">Method A: using the package manager of your TeX distribution</a></li>
+<li><a href="#method-b-manual-installation-using-xint.tds.zip-and-unzip">Method B: manual installation using <code>xint.tds.zip</code> and <code>unzip</code></a></li>
+<li><a href="#method-c-manual-installation-using-makefile-and-xint.dtx">Method C: manual installation using <code>Makefile</code> and <code>xint.dtx</code></a></li>
+<li><a href="#method-d-installation-starting-with-only-xint.dtx">Method D: installation starting with only <code>xint.dtx</code></a></li>
+</ul></li>
+<li><a href="#license">License</a></li>
+</ul>
+</div>
+<pre><code>Source: xint.dtx (v1.1, 2014/10/28)
+Author: Jean-Francois Burnol
+Info: Expandable operations on big integers, decimals, fractions
+License: LPPL 1.3c or later</code></pre>
+<p>This README is also available as README.pdf and README.html.</p>
+<p>Change log is in CHANGES.pdf and CHANGES.html.</p>
+<h1 id="usage">Usage</h1>
+<h2 id="with-latex">With LaTeX</h2>
+<pre><code>\usepackage{xint} % expandable arithmetic with big integers
+\usepackage{xintfrac} % decimal numbers, fractions, floats
+\usepackage{xintexpr} % expressions with infix operators</code></pre>
+<p>Further packages: <code>xintbinhex</code>, <code>xintgcd</code>, <code>xintseries</code> and <code>xintcfrac</code>. All dependencies are handled automatically. For example <code>xintexpr</code> automatically loads <code>xintfrac</code> which itself loads <code>xint</code>. Package <code>xintcore</code> is the subset of <code>xint</code> providing only the five operations on big integers: <code>\xintiiAdd</code>, <code>\xintiiMul</code>, ... There is also <code>xinttools</code> which is a separate package providing, among others, expandable and non-expandable loops such as <code>\xintFor</code>.</p>
+<h2 id="with-tex">With TeX</h2>
+<p>One does for example:</p>
+<pre><code>\input xintexpr.sty\relax</code></pre>
+<p>Again, all dependencies are handled automatically. The packages may be loaded in any catcode context such that letters, digits, <code>\</code> and <code>%</code> have their standard catcodes.</p>
+<p><code>xintcore.sty</code> and <code>xinttools.sty</code> both import <code>xintkernel.sty</code> which has the catcode handler and package identifier and defines a few utilities such as <code>\oodef</code> or <code>\xint_dothis/\xint_orthat</code>.</p>
+<h1 id="installation">Installation</h1>
+<h2 id="method-a-using-the-package-manager-of-your-tex-distribution">Method A: using the package manager of your TeX distribution</h2>
+<p><code>xint</code> is included in <a href="http://tug.org/texlive/">TeXLive</a> (hence also <a href="http://tug.org/mactex/">MacTeX</a>) and <a href="http://www.miktex.org/">MikTeX</a>.</p>
+<p>There can be a few days of delay between apparition of a new version on <a href="http://www.ctan.org/pkg/xint">CTAN</a> and availability via the distribution package manager.</p>
+<h2 id="method-b-manual-installation-using-xint.tds.zip-and-unzip">Method B: manual installation using <code>xint.tds.zip</code> and <code>unzip</code></h2>
+<p>Assumes a GNU/Linux-like system (or Mac OS X).</p>
+<ol style="list-style-type: decimal">
+<li><p>obtain <code>xint.tds.zip</code> from CTAN: <a href="http://mirror.ctan.org/install/macros/generic/xint.tds.zip" class="uri">http://mirror.ctan.org/install/macros/generic/xint.tds.zip</a></p></li>
+<li><p>cd to the download repertory and issue:</p>
+<pre><code>unzip xint.tds.zip -d &lt;TEXMF&gt;</code></pre>
+<p>where <code>&lt;TEXMF&gt;</code> is a suitable TDS-compliant destination repertory. For example, with TeXLive:</p>
+<ul>
+<li><p>Linux, standard access rights, hence sudo is needed, installation into the &quot;local&quot; tree:</p>
+<pre><code>sudo unzip xint.tds.zip -d /usr/local/texlive/texmf-local
+sudo texhash /usr/local/texlive/texmf-local</code></pre></li>
+<li><p>Mac OS X, installation into user home folder (no sudo needed, and it is recommended to not have a ls-R file there, hence no texhash):</p>
+<pre><code>unzip xint.tds.zip -d ~/Library/texmf</code></pre></li>
+</ul></li>
+</ol>
+<h2 id="method-c-manual-installation-using-makefile-and-xint.dtx">Method C: manual installation using <code>Makefile</code> and <code>xint.dtx</code></h2>
+<p>The Makefile automatizes rebuilding from <code>xint.dtx</code> all documentation files as well as <code>xint.tds.zip</code>. It is for GNU/Linux-like (inc. Mac OS X) systems, with a teTeX like installation such as TeXLive. Furthermore the <a href="http://johnmacfarlane.net/pandoc/">Pandoc</a> software is required.</p>
+<ol style="list-style-type: decimal">
+<li><p>obtain <code>xint.dtx</code> and <code>Makefile</code> from <a href="http://www.ctan.org/pkg/xint" class="uri">http://www.ctan.org/pkg/xint</a>.</p></li>
+<li><p>put them in an otherwise empty working repertory, run <code>make</code> or equivalently <code>make help</code> for further instructions.</p></li>
+</ol>
+<h2 id="method-d-installation-starting-with-only-xint.dtx">Method D: installation starting with only <code>xint.dtx</code></h2>
+<p>Run <code>&quot;tex xint.dtx&quot;</code> or <code>&quot;etex xint.dtx&quot;</code> to extract from <code>xint.dtx</code> all packages as well as these files:</p>
+<dl>
+<dt><code>README.md</code></dt>
+<dd>the current README with Markdown formatting.
+</dd>
+<dt><code>CHANGES.md</code></dt>
+<dd>the changes across successive releases.
+</dd>
+<dt><code>xint.tex</code></dt>
+<dd><p>used to generate <code>xint.pdf</code> via <code>&quot;latex xint.tex&quot;</code> (thrice) then <code>&quot;dvipdfmx xint.dvi&quot;</code>. For successful compilation, packages <code>newtxtt</code>, <code>newtxmath</code>, <code>etoc</code>, <code>mathastext</code> are needed. Inclusion of the source code is off by default, but the toggle can be set in <code>xint.tex</code>.</p>
+<p>It is also possible to compile <code>xint.tex</code> with <code>pdflatex</code>.</p>
+<p>A third option is to generate <code>xint.pdf</code> via <code>pdflatex xint.dtx</code>. Source code is then included by default.</p>
+</dd>
+<dt><code>Makefile.mk</code></dt>
+<dd>this is for UNIX-like systems. Note: this file is only produced with <code>&quot;etex xint.dtx&quot;</code>, not with <code>&quot;tex xint.dtx&quot;</code>. Rename it to <code>Makefile</code> and run <code>make</code> on the command line for further help.
+</dd>
+<dt><code>doHTMLs.sh</code> and <code>doPDFs.sh</code></dt>
+<dd>these are scripts (for UNIX-like systems) which can be used to convert the <code>README.md</code> and <code>CHANGES.md</code> to HTML and PDF formats. They require <a href="http://johnmacfarlane.net/pandoc/">Pandoc</a>.
+</dd>
+<dt><code>pandoctpl.latex</code></dt>
+<dd>a Pandoc template used by <code>doPDFs.sh</code>.
+</dd>
+</dl>
+<p>Finishing the installation in a TDS hierarchy:</p>
+<ul>
+<li><p>move the style files to <code>TDS:tex/generic/xint/</code></p></li>
+<li><p><code>xint.dtx</code> goes to <code>TDS:source/generic/xint/</code></p></li>
+<li><p>the documentation (xint.pdf, README.md,...) goes to <code>TDS:doc/generic/xint/</code></p></li>
+</ul>
+<p>Depending on the destination, it may then be necessary to refresh a filename database.</p>
+<h1 id="license">License</h1>
+<div class="mono">
+<p>Copyright (C) 2014 by Jean-Francois Burnol</p>
+<p>This Work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3c of this license or (at your option) any later version. This version of this license is in</p>
+<blockquote>
+<p><a href="http://www.latex-project.org/lppl/lppl-1-3c.txt" class="uri">http://www.latex-project.org/lppl/lppl-1-3c.txt</a></p>
+</blockquote>
+<p>and the latest version of this license is in</p>
+<blockquote>
+<p><a href="http://www.latex-project.org/lppl.txt" class="uri">http://www.latex-project.org/lppl.txt</a></p>
+</blockquote>
+<p>and version 1.3 or later is part of all distributions of LaTeX version 2005/12/01 or later.</p>
+<p>This Work has the LPPL maintenance status <code>author-maintained</code>.</p>
+<p>The Author of this Work is Jean-Francois Burnol.</p>
+This Work consists of the source file xint.dtx and of its derived files: xintkernel.sty, xintcore.sty, xint.sty, xintfrac.sty, xintexpr.sty, xintbinhex.sty, xintgcd.sty, xintseries.sty, xintcfrac.sty, xinttools.sty, xint.ins, xint.tex, README, README.md, README.html, README.pdf, CHANGES.md, CHANGES.html, CHANGES.pdf, pandoctpl.latex, doHTMLs.sh, doPDFs.sh, xint.dvi, xint.pdf, Makefile.mk.
+</div>
+</body>
+</html>