https://github.com/nilqed/latex2sixel
LaTeX to SIXEL conversion
https://github.com/nilqed/latex2sixel
computer-algebra-system fricas latex maxima pure sixel sixel-graphics
Last synced: 27 days ago
JSON representation
LaTeX to SIXEL conversion
- Host: GitHub
- URL: https://github.com/nilqed/latex2sixel
- Owner: nilqed
- License: bsd-2-clause
- Created: 2018-05-06T15:23:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-04T11:37:46.000Z (10 months ago)
- Last Synced: 2025-01-04T12:37:37.985Z (10 months ago)
- Topics: computer-algebra-system, fricas, latex, maxima, pure, sixel, sixel-graphics
- Language: Shell
- Size: 393 KB
- Stars: 32
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LaTeX to SIXEL
[Sixel](https://en.wikipedia.org/wiki/Sixel) graphics is well suited to display images on terminals (emulation) like [Mintty](https://mintty.github.io/) (Cygwin), [mlterm](http://mlterm.sourceforge.net/) or [Xterm](http://invisible-island.net/xterm/). Thanks to Hayaki Saito's [libsixel](http://saitoha.github.io/libsixel/), we can easily convert almost any format to sixel sequences (e.g. [img2sixel](http://saitoha.github.io/libsixel/#img2sixel)).
## latex2sixel
This simple shell script converts **(La)TeX** chunks to sixel output by the following composition of tools:
![`latex [dvi] --> dvipng [png] --> img2sixel`](img/pipeline.png)
Therefore, the requirements to render LaTex chunks to a sixel graphics capable console/terminal are as follows:
* LaTeX distribution
* dvipng (usually already included)
* libsixel (see [Install](http://saitoha.github.io/libsixel/#install))
* Sixel capable terminal
### Usage
```
This is latex2sixel V 1.0.2 (Mon Apr 11 15:59:19 CEST 2022)
Usage: latex2sixel [OPTION]... TEXSTRING...
Options are chosen to be similar to dvips' options where possible:
-D # Output resolution (default: 150 dpi)
-O c Image offset (default: 1.4cm,0.8cm)
-T c Image size (also accepts '-T bbox' and '-T tight')
-t Remove margins (shorthand for '-T tight')
--preamble s Add string 's' to the preamble before \begin{document}
-bg s Background color (TeX-style color or 'Transparent')
-fg s Foreground color (TeX-style color)
# = number s = string
c = comma-separated dimension pair (e.g., -1.2in,3.4cm)
TEXSTRING is a LaTeX expression betweeen apostrophes (not quotes).
Examples: '$\alpha$' | '\LaTeX' | 'This is math: $x+y$'.
Required applications: latex, dvipng, img2sixel.
Terminals supporting sixel graphics: xterm -ti vt340, mintty, mlterm.
More info @ https://github.com/saitoha/libsixel
```
The script is just a skeleton and may be adjusted to your needs.
#### Installation
Just copy the file(s) in the `script` directory to a folder in the path,
e.g. `/usr/local/bin` or `.local/bin`.
#### TeX-Live (`openout_any=p` issue)
* Edit the file `/usr/share/texlive/texmf-dist/web2c/texmf.cnf` (sudo)
* Search for openout_any=p (p for paranoid mode)
* Replace by openout_any=r (restricted) or openout_any=a (means always).
#### Examples
```
latex2sixel '$-\frac{\hbar^2}{2m}\,\Delta\psi+V\,\psi=E\,\psi$'
latex2sixel \\partial{T}\(\\phi\)=T\(d\\phi\)
latex2sixel '$$\int_{\partial\Omega}\omega=\int_\Omega\,d\omega$$'
latex2sixel '\LaTeX\ is\ cool :)'
latex2sixel '$$\sum_{j=0}^N q^j=\frac{q^{N+1}-1}{q-1}$$'
latex2sixel '$$\forall x\in\mathbb{Z},\exists y\in\mathbb{Z}:x+y=0$$'
```
More complicated latex fragments can be stored in a file and passed to
latex2sixel as stdin. (Example: [protocol.ltx](samples/protocol.ltx).)
```bash
echo '\Large\LaTeX' | latex2sixel
latex2sixel < protocol.ltx
latex2sixel '\Large' < protocol.ltx
latex2sixel -fg Dandelion '\LARGE' < protocol.ltx
```
#### Tips
* Every argument is a separate latex line
```
latex2sixel 'Hello % comment to the end of the line' 'world!'
```
* Put `\usepackage{foo}` in a separate argument
``` bash
latex2sixel '\usepackage{bm}' '$\bm{\mathsf{A}}\bm x = \bm b$'
```
* Colors within equations can be controlled using `\mathcolor{}`
``` bash
latex2sixel '\Huge${\mathcolor{Mulberry}\wp}_\alpha$'
```
* The -D / --resolution setting can be used for quick zooming
```bash
latex2sixel -D 300 -t <<-EOF
\def\bars#1{\hbox to #1{\vrule width0pt height 1mm depth 2mm%
\vrule\morebars\morebars}}
\def\morebars{\hfil\vrule\hfil\vrule\hfil\vrule\hfil\vrule\hfil\vrule}
\def\ruler#1{\vbox{\bars{#1}\hrule}}
\ruler{10in}
Each mark is one inch
EOF
```
* More examples are in the [samples](samples/) directory
```bash
latex2sixel < samples/hdotsfor.ltx
```
In particular, see [ltx0.txt](samples/ltx0.txt) for a range of
useful and interesting tidbits.
```bash
cd samples
sh ltx0.txt
```
## Applications
A lot of mathematical software is able to produce **TeX** output, e.g. computer algebra systems ([CAS](https://en.wikipedia.org/wiki/Computer_algebra_system)) like FriCAS (Axiom), Maxima, Reduce, Sage, Sympy and a lot more. Many OO languages like Python or Pure have the capability to render the objects by a special representation field.
Certain applications, however, need a special treatment, that is for instance a preamble or macro definitions which should be prepended to the input. The script `fricas2sixel` is such an example. When we define the function
```
sixel(x:TexFormat):Void ==
cmd:=concat ["system fricas2sixel -bg Black -D 150 -fg Orange '",tex(x).1,"'"]
systemCommand(cmd)
```
we can render almost any expression as its LaTex representation in the console:
The function can be included into the startup file (`.fricas.input`), then the usage is: `sixel expression`.
Another example is [Pure](https://agraef.github.io/pure-lang/):
For details consult the sample file `sixel.pure` in the `sample`folder.
## GnuPlot
[GnuPlot](http://gnuplot.info/) is a portable command-line driven graphing utility for
Linux, OS/2, MS Windows, OSX, VMS, and many other platforms. It can produce **sixel**
output. It also provides an easy mean to check if your terminal is capable to display
sixel output: `gnuplot> test`
#### Calibration
---
