From aa73dc47395f96e2e308281b4e04c0d674841d52 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 12 Aug 2008 23:46:59 +0000 Subject: install synctex man pages git-svn-id: svn://tug.org/texlive/trunk@10296 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf/doc/man/man1/synctex.1 | 27 ++++ Master/texmf/doc/man/man5/synctex.5 | 310 ++++++++++++++++++++++++++++++++++++ 2 files changed, 337 insertions(+) create mode 100644 Master/texmf/doc/man/man1/synctex.1 create mode 100644 Master/texmf/doc/man/man5/synctex.5 (limited to 'Master/texmf/doc') diff --git a/Master/texmf/doc/man/man1/synctex.1 b/Master/texmf/doc/man/man1/synctex.1 new file mode 100644 index 00000000000..57a9a432f16 --- /dev/null +++ b/Master/texmf/doc/man/man1/synctex.1 @@ -0,0 +1,27 @@ +.Dd 27/03/08 \" DATE +.Dt synctex 1 \" Program name and manual section number +.Th synctex 1 +.Sh NAME +.Nm synctex +.Nd command line client tool to support the Synchronize TeXnology available in recent TeX engines. +.Sh SYNOPSIS +.TP +.Nm +\fIcommand\fP [\fIoptions\fP] [\fIargs\fP] +.Sh OVERVIEW +The Synchronization TeXnology is a new feature of recent TeX engines. +It allows to synchronize between input and output, +which means to navigate from the source document to the typeset material +and vice versa. +.Pp +Run `synctex help' to access the built-in tool documentation. +.Sh SEE ALSO +.\" List links in ascending order by section, alphabetically within a section. +.\" Please do not reference files that do not exist without filing a bug report +.Xr synctex 5 +.Xr tex 1 +.Sh AUTHOR +The Synchronize TeXnology is essentially due to Jerome Laurens, +with useful suggestions by some well known actors of the TeX world. +.\" .Sh BUGS \" Document known, unremedied bugs +.\" .Sh HISTORY \" Document history if command behaves in a unique manner \ No newline at end of file diff --git a/Master/texmf/doc/man/man5/synctex.5 b/Master/texmf/doc/man/man5/synctex.5 new file mode 100644 index 00000000000..128bdce3509 --- /dev/null +++ b/Master/texmf/doc/man/man5/synctex.5 @@ -0,0 +1,310 @@ +.Dd May 11, 2008 +.Dt SYNCTEX 5 +.Os "Independant" +.\" +.\" +.Sh NAME +.Nm synctex +.Nd Synchronize TeXnology help file +.\" +.\" +.Sh DESCRIPTION +Synchronize TeXnology help file +.Pq synctexs +are text files that help input/output synchronization during document preparation with the TeX typesetting system. +.Sh BASICS +The structure of this file should not be considered public, in the sense that no one should need to parse its contents, except the synctex command line utility, and the synctex_parser library. +Unless it is absolutely not avoidable, access to the contents of the synctex file should only be made through requests made to the synctex command line utility. +.\" +.Sh STRUCTURE +The element structure of a synctex file is a list of text line records as follows. +.Sq \&* , +.Sq \&+ , +and +.Sq \&? +have their usual EBNF meanings: +.Sq \&* +means zero or more, +.Sq \&+ +means one or more, and +.Sq \&? +means zero or one +.Pq i.e., optional . +.Pp +.Bl -item -offset indent +.\" +.It +.Li ::= +.Pq The whole contents in 4 sections +.Bl -item -offset indent +.It +.Li +.It +.Li +.It +.Li +.It +.Li +.El +.\" +.El +.Pp +Each section starts with the first occurrence of a sectioning line, and ends with the next section, if any. +In the following definitions, we do not mention the section ending condition. +.Sh The preamble +.Bl -item -offset indent +.\" +.It +.Li ::= +.Bl -item -offset indent +.It +.Li Qq SyncTeX Version: + +.It +.Li * +.It +.Li Qq Magnification: + +.It +.Li Qq Unit: + +.It +.Li Qq X Offset: + +.It +.Li Qq Y Offset: + +.El +.It +.Li ::= +.Qq Input: + +.Qq \&: + +.\" +.El +.Sh The content +.Bl -item -offset indent +.It +.Li ::= +.Bl -item -offset indent +.It +.Li +.It +.Li Qq Content: + +.It +.Li +.It +.Li * +.It +.Li +.It +.Li * +.It +.Li ... +.It +.Li +.It +.Li * +.El +.It +.Li ::= +.Qq \&! + +.Pp +.El +.Pp +.Bl -item -offset indent +.It +.Li ::= +.Bl -item -offset indent +.It +.Li +.It +.Li Qq \&{ + / +.It +.Li * +.It +.Li +.It +.Li Qq \&} + +.El +.El +.Pp +The describes what is inside a box. +It is either a vertical or horizontal box, +with some records related to glue, kern or math nodes. +.Bl -item -offset indent +.It +.Li ::= +.Bl -item -offset indent +.It +.Li | +.It +.Li || +.It +.Li |||| +.El +.It +.Li ::= +.Bl -item -offset indent +.It +.Li Qq \&[ + +.Qq \&: + +.Qq \&: + +.It +.Li * +.It +.Li Qq \&] + +.El +.It +.Li ::= +.Bl -item -offset indent +.It +.Li Qq \&( + +.Qq \&: + +.Qq \&: + +.It +.Li * +.It +.Li Qq \&) + +.El +.El +.Pp +Void boxes: +.Bl -item -offset indent +.It +.Li ::= +.Qq v + +.Qq \&: + +.Qq \&: + +.It +.Li ::= +.Qq h + +.Qq \&: + +.Qq \&: + +.It +.Li ::= +.Qq \&, + +.Qq \&, + +.It +.Li ::= +.It +.Li ::= +.It +.Li ::= +.It +.Li ::= +.Qq \&, +( +.Qq \&, +)? +.It +.Li ::= +.It +.Li ::= +.El +.Pp +The forthcoming records are basic one liners. +.Bl -item -offset indent +.It +.Li ::= +.Qq x + +.Qq \&: + +.It +.Li ::= +.Qq k + +.Qq \&: + +.Qq \&: + +.It +.Li ::= +.Qq g + +.Qq \&: + +.It +.Li ::= +.Qq $ + +.Qq \&: + +.El +.Pp +.\" .Sx underline, .Dq double quotes, .Pq enclosed in parenthesis +.Sh The postamble +The postamble closes the file +If there is no postamble, it means that the typesetting process did not end correctly. +.Bl -item -offset indent +.\" +.It +.Li ::= +.Bl -item -offset indent +.It +.Li +.It +.Li Qq Count: + +.El +.Sh The post scriptum +The post scriptum contains material possibly added by 3rd parties. +It allows to append some transformation (shift and magnify). +Typically, one applies a dvi to pdf filter with offset options and magnification, +then he appends the same options to the synctex file, for example +.Bd -offset indent + synctex update -o foo.pdf -m 0.486 -x 9472573sp -y 13.3dd source.dvi +.Ed +.Bl -item -offset indent +.\" +.It +.Li ::= +.\" +.Bl -item -offset indent +.It +.Li +.It +.Li Qq Post Scriptum: + +.It +.Li Qq Magnification: + +.Pq Set additional magnification +.It +.Li Qq X Offset: + +.Pq Set horizontal offset +.It +.Li Qq Y Offset: + +.Pq Set vertical offset +.El +This second information will override the offset and magnification previously available in the preamble section. +All the numbers are encoded using the decimal representation with "C" locale. +.Sh USAGE +.Pp +The is used to compute the visible size of hbox's. +The byte offset is an implicit anchor to navigate the synctex file from sheet to sheet. +. -- cgit v1.2.3