| 1 |
.Dd 08/30/2022 \" DATE |
| 2 |
.Dt synctex 1 \" Program name and manual section number |
| 3 |
.Sh NAME |
| 4 |
.Nm synctex |
| 5 |
.Nd command line client tool to support the Synchronize TeXnology available in most TeX engines. |
| 6 |
.Sh SYNOPSIS |
| 7 |
.Nm |
| 8 |
\fIcommand\fP [\fIoptions\fP] [\fIargs\fP] |
| 9 |
.Sh OVERVIEW |
| 10 |
The Synchronization TeXnology is a feature of recent TeX engines. |
| 11 |
It allows one to synchronize between input and output, |
| 12 |
which means to navigate from the source document to the typeset material |
| 13 |
and vice versa. |
| 14 |
.Pp |
| 15 |
Run `synctex help' to access the built-in tool documentation. |
| 16 |
.Sh TEX ENGINE OPTION -synctex=NUMBER |
| 17 |
.Bl -bullet |
| 18 |
.It |
| 19 |
If NUMBER=0 or no option is given, no synctex file is created. |
| 20 |
.It |
| 21 |
If NUMBER<0, synctex files are text files. |
| 22 |
.It |
| 23 |
If NUMBER>0, synctex files are compressed with gz. |
| 24 |
.It |
| 25 |
If NUMBER&2, no .gz extension is used. |
| 26 |
.It |
| 27 |
If NUMBER&4, activate form support, useful for pdftex. |
| 28 |
.It |
| 29 |
If NUMBER&8, better file compression. |
| 30 |
.El |
| 31 |
.Pp |
| 32 |
Use for example `pdftex -synctex=15 foo.tex' to activate all the options. |
| 33 |
.Pp |
| 34 |
Notice that LuaTeX option is `--synctex=NUMBER' with two dashes. |
| 35 |
.Sh SEE ALSO |
| 36 |
.\" List links in ascending order by section, alphabetically within a section. |
| 37 |
.\" Please do not reference files that do not exist without filing a bug report |
| 38 |
.Xr synctex 5 |
| 39 |
.Xr tex 1 |
| 40 |
.Sh AUTHOR |
| 41 |
The Synchronize TeXnology is essentially due to Jerome Laurens, |
| 42 |
with useful suggestions by some well known actors of the TeX world. |
| 43 |
.\" .Sh BUGS \" Document known, unremedied bugs |
| 44 |
SyncTeX is maintained as part of TeX Live. |
| 45 |
.Sh HISTORY \" Document history if command behaves in a unique manner |
| 46 |
Revised on Sun Apr 23 09:54:20 UTC 2017. |
| 47 |
.\" nroff -man synctex.1 | less |
| 48 |
.\"groff -man -Tascii synctex.1 | less |
| 49 |
.\"To convert a man page to plain pre-formatted text (e.g for spell checking) use: |
| 50 |
.\"nroff -man synctex.1 | col -b > synctex.1.txt |
| 51 |
.\"To convert it to Postscript (for printing or further conversion to pdf) use: |
| 52 |
.\"groff -man -Tps synctex.1 > synctex.1.ps |
| 53 |
.\"To convert the man page to html use: |
| 54 |
.\"man2html synctex.1 |