3rdparty/evince_sync/README

   1 ===============================================
   2 FORWARD AND BACKWARD SEARCH WITH LYX AND EVINCE
   3 ===============================================
   4
   5 For the forward and backwards (reverse) search feature in general, please refer to
   6 Help > Additional Features, sec. 5.6 and 5.7 in LyX.
   7
   8
   9 SETUP
  10 =====
  11
  12 * Install the files evince_sync_lyx, evince_forward_search and evince_backward_search
  13   in your binary directory (e.g., ~/bin).
  14
  15 * Assure all three files are executable.
  16
  17 * In LyX, go to Tools > Preferences ... > File Handling > File Formats > Format, select
  18   the appropriate output format [e.g., PDF (pdflatex)], set "Viewer" to "Custom" and
  19   enter evince_sync_lyx as custom viewer (in the field right to the combo box).
  20   Hit "Apply" and "Save".
  21
  22 * Go to Tools > Preferences ... > Output > General and enter the following PDF command
  23   to Forward Search: evince_forward_search "$$o" $$n "$$f"
  24   Again, hit "Apply" and "Save".
  25
  26 Forward and Backward search should work now (backward search from within evince is triggered
  27 by <Shift> + <Left Click>).
  28
  29
  30 HISTORY
  31 =======
  32
  33 The scripts have been initially developed by Benjamin Kellermann (2011) as a derivation
  34 of gedit-synctex-plugin by José Aliste (https://github.com/jaliste/gedit-synctex-plugin,
  35 2010) and published on https://ubuntuforums.org/showthread.php?t=1716268.
  36
  37 The work is based on a further derivation of this work for Sublime Text LaTeX Tools
  38 (https://github.com/SublimeText/LaTeXTools/tree/master/evince).
  39
  40 Adaptations for the use with LyX have been done by Jürgen Spitzmüller <spitz@lyx.org>
  41 in 2017.
  42
  43
  44 CONTACT
  45 =======
  46
  47 Please send bug reports and suggestions (related to LyX-evince synchronization) to
  48 lyx-devel@lists.lyx.org.
  49 Usage questions should be addressed at lyx-users@lists.lyx.org.