<TeXmacs|1.0.3.7>

<style|tmdoc>

<\body>
  <tmdoc-title|Summary of the configuration options for plug-ins>

  As explained before, the <value|scheme> configuration file
  <verbatim|<em|myplugin>/progs/init-<em|myplugin>.scm> of a plug-in with
  name <verbatim|<em|plugin>> should contain an instruction of the type

  <\scheme-fragment>
    (plugin-configure <em|myplugin>

    \ \ <em|configuration-options>)
  </scheme-fragment>

  Here follows a list of the available <verbatim|<em|configuration-options>>:

  <\description-dash>
    <item*|<verbatim|<with|font-series|medium|(:require
    <em|condition>)>>>This option specifies a sanity
    <verbatim|<em|condition>> which needs to be satisfied by the plug-in.
    Usually, it is checked that certain binaries or libraries are present on
    your system. If the condition fails, then <TeXmacs> will continue as
    whether your plug-in did not exist. In that case, further configuration
    is aborted. The <verbatim|:require> option usually occurs first in the
    list of configuration options.

    <item*|<verbatim|<with|font-series|medium|(:version
    <em|version-cmd>)>>>This option specifies a <value|scheme> expression
    <verbatim|<em|version-cmd>> which evaluates to the version of the
    plug-in.

    <item*|<verbatim|<with|font-series|medium|(:setup <em|cmd>)>>>This
    command is only executed when the version of the plug-in changed from one
    execution of <TeXmacs> to another one. This occurs mainly when installing
    new versions of <TeXmacs> or helper applications.

    <item*|<verbatim|<with|font-series|medium|(:initialize <em|cmd>)>>>This
    option executes the <value|scheme> expression <verbatim|<em|cmd>>. It
    usually occurs just after the <verbatim|:require> option, so that the
    plug-in will only be configured if the plug-in really exists. For large
    plug-ins, it is important to keep the file
    <verbatim|<em|myplugin>/progs/init-<em|myplugin>.scm> small, because it
    will be rerun each time you start <TeXmacs>. In order to reduce the boot
    time, most <value|scheme> commands of the plug-in therefore occur in
    separate modules, some of which may be loaded by the initialization
    command.

    <item*|<verbatim|<with|font-series|medium|(:launch <em|shell-cmd>)>>>This
    option specifies that the plug-in is able to evaluate expressions over a
    pipe, using a helper application which is launched using the
    shell-command <verbatim|<em|shell-cmd>>.

    <item*|<verbatim|<with|font-series|medium|(:link <em|lib-name>
    <em|export-struct> <em|options>)>>>This option is similar to
    <verbatim|:launch>, except that the extern application is now linked
    dynamically. For more information, see the section about
    <hyper-link|dynamic linking|../interface/interface-dynlibs.en.tm>.

    <item*|<verbatim|<with|font-series|medium|(:session
    <em|menu-name>)>>>This option indicates that the plug-in supports an
    evaluator for interactive shell sessions. An item
    <verbatim|<em|menu-item>> will be inserted to the <menu|Insert|Session>
    menu in order to launch such sessions.

    <item*|<verbatim|<with|font-series|medium|(:serializer
    ,<em|fun-name>)>>>If the plug-in can be used as an evaluator, then this
    option specifies the <value|scheme> function <verbatim|<em|fun-name>>
    which is used in order to transform <TeXmacs> trees to strings.

    <item*|<verbatim|<with|font-series|medium|(:commander
    ,<em|fun-name>)>>>This command is similar to the <verbatim|:serializer>
    option except that it is used to transform special commands to strings.

    <item*|<verbatim|<with|font-series|medium|(:tab-completion #t)>>>This
    command indicates that the plug-in supports tab-completion.

    <item*|<verbatim|<with|font-series|medium|(:test-input-done #t)>>>This
    command indicates that the plug-in provides a routine for testing whether
    the input is complete.
  </description-dash>

  <tmdoc-copyright|1998--2002|Joris van der Hoeven>

  <tmdoc-license|Permission is granted to copy, distribute and/or modify this
  document under the terms of the GNU Free Documentation License, Version 1.1
  or any later version published by the Free Software Foundation; with no
  Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  Texts. A copy of the license is included in the section entitled "GNU Free
  Documentation License".>

<\initial>
  <\collection>
    <associate|language|english>
    <associate|page-bot|30mm>
    <associate|page-even|30mm>
    <associate|page-odd|30mm>
    <associate|page-reduce-bot|15mm>
    <associate|page-reduce-left|25mm>
    <associate|page-reduce-right|25mm>
    <associate|page-reduce-top|15mm>
    <associate|page-right|30mm>
    <associate|page-top|30mm>
    <associate|page-type|a4>
    <associate|par-width|150mm>
    <associate|sfactor|4>
  </collection>
</initial>