diff options
Diffstat (limited to 'Master/texmf-dist/doc/generic/xint/README')
-rw-r--r-- | Master/texmf-dist/doc/generic/xint/README | 307 |
1 files changed, 162 insertions, 145 deletions
diff --git a/Master/texmf-dist/doc/generic/xint/README b/Master/texmf-dist/doc/generic/xint/README index 6d5fc644c85..8cc40dd45c9 100644 --- a/Master/texmf-dist/doc/generic/xint/README +++ b/Master/texmf-dist/doc/generic/xint/README @@ -1,158 +1,175 @@ -The xint bundle -Release 1.09n (2014/04/01). Documentation date: 2014/04/01 + 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 -Copyright (C) 2013-2014 by Jean-Francois Burnol -License: LaTeX Project Public License 1.3c or later. +This README is also available as README.pdf and README.html. -Contents: Abstract, Installation, License. +Change log is in CHANGES.pdf and CHANGES.html. -Abstract -======== -xinttools is loaded by xint (hence by all other packages of the -bundle, too): it provides utilities of independent interest such as -expandable and non-expandable loops. -xint implements with expandable TEX macros additions, subtractions, -multiplications, divisions and powers with arbitrarily long numbers. +USAGE -xintfrac extends the scope of xint to decimal numbers, to numbers in -scientific notation and also to fractions with arbitrarily long such -numerators and denominators separated by a forward slash. -xintexpr extends xintfrac with an expandable parser - \xintexpr . . . \relax -of expressions involving arithmetic operations in infix notation on -decimal numbers, fractions, numbers in scientific notation, with -parentheses, factorial symbol, function names, comparison operators, -logic operators, twofold and threefold way conditionals, -sub-expressions, macros expanding to the previous items. +With LaTeX -Further modules: + \usepackage{xint} % expandable arithmetic with big integers + \usepackage{xintfrac} % decimal numbers, fractions, floats + \usepackage{xintexpr} % expressions with infix operators -xintbinhex is for conversions to and from binary and hexadecimal -bases. +Further packages: xintbinhex, xintgcd, xintseries and xintcfrac. All +dependencies are handled automatically. For example xintexpr +automatically loads xintfrac which itself loads xint. Package xintcore +is the subset of xint providing only the five operations on big +integers: \xintiiAdd, \xintiiMul, ... There is also xinttools which is a +separate package providing, among others, expandable and non-expandable +loops such as \xintFor. -xintseries provides some basic functionality for computing in an -expandable manner partial sums of series and power series with -fractional coefficients. -xintgcd implements the Euclidean algorithm and its typesetting. +With TeX -xintcfrac deals with the computation of continued fractions. +One does for example: + + \input xintexpr.sty\relax + +Again, all dependencies are handled automatically. The packages may be +loaded in any catcode context such that letters, digits, \ and % have +their standard catcodes. + +xintcore.sty and xinttools.sty both import xintkernel.sty which has the +catcode handler and package identifier and defines a few utilities such +as \oodef or \xint_dothis/\xint_orthat. + + + +INSTALLATION + + +Method A: using the package manager of your TeX distribution + +xint is included in TeXLive (hence also MacTeX) and MikTeX. + +There can be a few days of delay between apparition of a new version on +CTAN and availability via the distribution package manager. + + +Method B: manual installation using xint.tds.zip and unzip + +Assumes a GNU/Linux-like system (or Mac OS X). + +1. obtain xint.tds.zip from CTAN: + http://mirror.ctan.org/install/macros/generic/xint.tds.zip + +2. cd to the download repertory and issue: + + unzip xint.tds.zip -d <TEXMF> + + where <TEXMF> is a suitable TDS-compliant destination repertory. For + example, with TeXLive: + + - Linux, standard access rights, hence sudo is needed, + installation into the "local" tree: + + sudo unzip xint.tds.zip -d /usr/local/texlive/texmf-local + sudo texhash /usr/local/texlive/texmf-local + + - 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): + + unzip xint.tds.zip -d ~/Library/texmf + + +Method C: manual installation using Makefile and xint.dtx + +The Makefile automatizes rebuilding from xint.dtx all documentation +files as well as xint.tds.zip. It is for GNU/Linux-like (inc. Mac OS X) +systems, with a teTeX like installation such as TeXLive. Furthermore the +Pandoc software is required. + +1. obtain xint.dtx and Makefile from http://www.ctan.org/pkg/xint. + +2. put them in an otherwise empty working repertory, run make or + equivalently make help for further instructions. + + +Method D: installation starting with only xint.dtx + +Run "tex xint.dtx" or "etex xint.dtx" to extract from xint.dtx all +packages as well as these files: + +README.md + the current README with Markdown formatting. + +CHANGES.md + the changes across successive releases. + +xint.tex + + used to generate xint.pdf via "latex xint.tex" (thrice) then + "dvipdfmx xint.dvi". For successful compilation, packages newtxtt, + newtxmath, etoc, mathastext are needed. Inclusion of the source code + is off by default, but the toggle can be set in xint.tex. + + It is also possible to compile xint.tex with pdflatex. + + A third option is to generate xint.pdf via pdflatex xint.dtx. Source + code is then included by default. + +Makefile.mk + this is for UNIX-like systems. Note: this file is only produced with + "etex xint.dtx", not with "tex xint.dtx". Rename it to Makefile and + run make on the command line for further help. + +doHTMLs.sh and doPDFs.sh + these are scripts (for UNIX-like systems) which can be used to + convert the README.md and CHANGES.md to HTML and PDF formats. They + require Pandoc. + +pandoctpl.latex + a Pandoc template used by doPDFs.sh. + +Finishing the installation in a TDS hierarchy: + +- move the style files to TDS:tex/generic/xint/ + +- xint.dtx goes to TDS:source/generic/xint/ + +- the documentation (xint.pdf, README.md,...) goes to + TDS:doc/generic/xint/ + +Depending on the destination, it may then be necessary to refresh a +filename database. + + + +LICENSE + + +Copyright (C) 2014 by Jean-Francois Burnol + +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 + + http://www.latex-project.org/lppl/lppl-1-3c.txt + +and the latest version of this license is in + + http://www.latex-project.org/lppl.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-Francois Burnol. + +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. -Most macros, and all of those doing computations, work purely by -expansion without assignments, and may thus be used almost everywhere -in TeX. The packages may be used with any flavor of TeX supporting the -e-TeX extensions. LaTeX users will use \usepackage and others \input -to load the package components. - -Installation -============ - -A. Installation using xint.tds.zip: ------------------------------------ - -obtain xint.tds.zip from CTAN: - http://mirror.ctan.org/install/macros/generic/xint.tds.zip - -cd to the download repertory and issue - unzip xint.tds.zip -d <TEXMF> -for example: (assuming standard access rights, so sudo needed) - sudo unzip xint.tds.zip -d /usr/local/texlive/texmf-local - sudo mktexlsr - -On Mac OS X, installation into user home folder: - unzip xint.tds.zip -d ~/Library/texmf - -B. Installation after file extractions: ---------------------------------------- - -obtain xint.dtx, xint.ins and the README from CTAN: - http://www.ctan.org/pkg/xint - -- "tex xint.ins" generates the style files -(pre-existing files in the same repertory will be overwritten). - -- without xint.ins: "tex or latex or pdflatex or xelatex xint.dtx" -will also generate the style files (and xint.ins). - -xint.tex is also extracted, use it for the documentation: - -- with latex+dvipdfmx: latex xint.tex thrice then dvipdfmx xint.dvi -Ignore dvipdfmx warnings, but if the pdf file has problems with fonts -(possibly from an old dvipdfmx), use then rather pdflatex or xelatex. - -- with pdflatex or xelatex: run it directly thrice on xint.dtx, or run -it on xint.tex after having edited the suitable toggle therein. - -Whether compiling xint.tex or xint.dtx, the documentation is by default -produced without inclusion of the source code. See instructions in the -file xint.tex for changing this default. - -Finishing the installation: (on first installation the destination -repertories may need to be created) - - xinttools.sty | - xint.sty | - xintfrac.sty | - xintexpr.sty | --> TDS:tex/generic/xint/ - xintbinhex.sty | - xintgcd.sty | - xintseries.sty | - xintcfrac.sty | - - xint.dtx --> TDS:source/generic/xint/ - xint.ins --> TDS:source/generic/xint/ - xint.tex --> TDS:source/generic/xint/ - - xint.pdf --> TDS:doc/generic/xint/ - README --> TDS:doc/generic/xint/ - -Depending on the TDS destination and the TeX installation, it may be -necessary to refresh the TeX installation filename database (mktexlsr) - -C. Usage: ---------- - -Usage with LaTeX: \usepackage{xinttools} - \usepackage{xint} % (loads xinttools) - \usepackage{xintfrac} % (loads xint) - \usepackage{xintexpr} % (loads xintfrac) - - \usepackage{xintbinhex} % (loads xint) - \usepackage{xintgcd} % (loads xint) - \usepackage{xintseries} % (loads xintfrac) - \usepackage{xintcfrac} % (loads xintfrac) - -Usage with TeX: \input xinttools.sty\relax - \input xint.sty\relax % (loads xinttools) - \input xintfrac.sty\relax % (loads xint) - \input xintexpr.sty\relax % (loads xintfrac) - - \input xintbinhex.sty\relax % (loads xint) - \input xintgcd.sty\relax % (loads xint) - \input xintseries.sty\relax % (loads xintfrac) - \input xintcfrac.sty\relax % (loads xintfrac) - -License -======= - - 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 - http://www.latex-project.org/lppl/lppl-1-3c.txt - and the latest version of this license is in - http://www.latex-project.org/lppl.txt - and version 1.3 or later is part of all distributions of - LaTeX version 2005/12/01 or later. - -This work consists of the source file xint.dtx and of its derived files: -xinttools.sty, xint.sty, xintfrac.sty, xintexpr.sty, xintbinhex.sty, -xintgcd.sty, xintseries.sty, xintcfrac.sty, as well as xint.ins, xint.tex -and the documentation xint.pdf (or xint.dvi). - -The author of this work is Jean-Francois Burnol <jfbu at free dot fr>. -This work has the LPPL maintenance status `author-maintained'. - |