-#LyX 2.0 created this file. For more info see http://www.lyx.org/
-\lyxformat 413
+#LyX 2.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 544
\begin_document
\begin_header
+\save_transient_properties true
+\origin /systemlyxdir/doc/
\textclass article
\begin_preamble
\renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
\end_preamble
\use_default_options false
\maintain_unincluded_children false
+\begin_local_layout
+Style Description
+LabelIndent MM
+LeftMargin MMMMMxx
+End
+\end_local_layout
\language english
\language_package default
\inputencoding auto
\fontencoding global
-\font_roman default
-\font_sans default
-\font_typewriter default
+\font_roman "default" "default"
+\font_sans "default" "default"
+\font_typewriter "default" "default"
+\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
-\font_sf_scale 100
-\font_tt_scale 100
-
+\font_sf_scale 100 100
+\font_tt_scale 100 100
+\use_microtype false
+\use_dash_ligatures true
\graphics default
\default_output_format default
\output_sync 0
\use_hyperref false
\papersize default
\use_geometry true
-\use_amsmath 1
-\use_esint 1
-\use_mhchem 1
-\use_mathdots 1
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package cancel 0
+\use_package esint 1
+\use_package mathdots 0
+\use_package mathtools 0
+\use_package mhchem 1
+\use_package stackrel 0
+\use_package stmaryrd 0
+\use_package undertilde 0
\cite_engine basic
+\cite_engine_type default
+\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
+\justification true
\use_refstyle 0
+\use_minted 0
\index Index
\shortcut idx
\color #008000
\leftmargin 2.5cm
\topmargin 2cm
\rightmargin 3cm
-\bottommargin 1cm
+\bottommargin 2.5cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
-\quotes_language english
+\is_math_indent 0
+\math_numbering_side default
+\quotes_style english
+\dynamic_quotes 0
\papercolumns 1
\papersides 1
\paperpagestyle default
\begin_body
+\begin_layout Title
+\SpecialChar LyX
+ Functions (LFUNs)
+\end_layout
+
+\begin_layout Author
+The \SpecialChar LyX
+ Team
+\end_layout
+
\begin_layout Section*
-LFUNs documentation automatically generated 2011-12-15
+About this manual
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+This manual documents the
+\begin_inset Quotes eld
+\end_inset
+LyX Functions
+\begin_inset Quotes erd
+\end_inset
-\backslash
-thispagestyle{empty}
+ (abbreviated LFUNs).
+ These are commands that are used to make \SpecialChar LyX
+ perform specific actions.
+ \SpecialChar LyX
+ itself uses these functions internally, and every internal action is bound
+ to an LFUN.
\end_layout
+\begin_layout Standard
+LFUNs are also used in the files that define keyboard shortcuts, menu or
+ toolbar items.
+ So if you want to change\SpecialChar breakableslash
+customize the user interface, you need to deal
+ with LFUNs.
+ Furthermore, external programs can use LFUNs to communicate with and
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset VSpace 1cm
+remote-control
+\begin_inset Quotes erd
\end_inset
+ \SpecialChar LyX
+ .
+ Finally, you can also issue LFUNs directly via the so called mini-buffer
+ which can be opened via
+\begin_inset Info
+type "shortcuts"
+arg "command-execute"
+\end_inset
+.
\end_layout
-\begin_layout Subsection*
-LFUN_ACCENT_ACUTE
+\begin_layout Standard
+In the following, all LFUNs are listed, categorized by function.
\end_layout
-\begin_layout Description
-Action Adds an acute accent to the next character typed.
+\begin_layout Section
+Layout Functions (Font, Layout and Textclass related)
\end_layout
-\begin_layout Description
-Syntax accent-acute
+\begin_layout Subsection*
+drop-layouts-choice
\end_layout
-\begin_layout Subsection*
-LFUN_ACCENT_BREVE
+\begin_layout Description
+Action Displays list of layout choices.
\end_layout
\begin_layout Description
-Action Adds a breve accent to the next character typed.
+Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
+ allowing for choice of layout.
\end_layout
\begin_layout Description
-Syntax accent-breve
+Syntax drop-layouts-choice
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_CARON
+environment-split
\end_layout
\begin_layout Description
-Action Adds a caron to the next character typed.
+Action Splits the current environment with a Separator.
\end_layout
\begin_layout Description
-Syntax accent-caron
-\end_layout
-
-\begin_layout Subsection*
-LFUN_ACCENT_CEDILLA
+Syntax environment-split [outer]
\end_layout
\begin_layout Description
-Action Adds a cedilla to the next character typed.
+Params outer: If this is given, LyX will split the outermost environment
+ in the current nesting hierarchy.
\end_layout
\begin_layout Description
-Syntax accent-cedilla
+Origin spitz, 23 Dec 2012
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_CIRCLE
+font-bold
\end_layout
\begin_layout Description
-Action Adds a circle accent to the next character typed.
+Action Toggles the bold font (selection-wise) using mathbf in math.
\end_layout
\begin_layout Description
-Syntax accent-circle
+Syntax font-bold
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_CIRCUMFLEX
+font-boldsymbol
\end_layout
\begin_layout Description
-Action Adds a circumflex to the next character typed.
+Action Toggles the bold font (selection-wise) using boldsymbol in math.
\end_layout
\begin_layout Description
-Syntax accent-circumflex
+Syntax font-boldsymbol
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_DOT
-\end_layout
-
-\begin_layout Description
-Action Adds a dot accent to the next character typed.
+font-crossout
\end_layout
\begin_layout Description
-Syntax accent-dot
-\end_layout
-
-\begin_layout Subsection*
-LFUN_ACCENT_GRAVE
+Action Toggles xout (cross-through) in the font (selection-wise).
\end_layout
\begin_layout Description
-Action Adds a grave accent to the next character typed.
+Syntax font-crossout
\end_layout
\begin_layout Description
-Syntax accent-grave
+Origin uwestoehr, 4 April 2017
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_HUNGARIAN_UMLAUT
+font-default
\end_layout
\begin_layout Description
-Action Adds a Hungarian umlaut to the next character typed.
+Action Reverts the settings of the font to the default values (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-grave
+Syntax font-default
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_MACRON
+font-emph
\end_layout
\begin_layout Description
-Action Adds a macron to the next character typed.
+Action Toggles the emphasis font style (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-macron
+Syntax font-emph
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_OGONEK
+font-frak
\end_layout
\begin_layout Description
-Action Adds an ogonek accent to the next character typed.
+Action Toggles Fraktur family font (math-mode, selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-ogonek
+Syntax font-frak
+\end_layout
+
+\begin_layout Description
+Origin vermeer, 10 Jan 2002
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_TIE
+font-ital
\end_layout
\begin_layout Description
-Action Adds a tie over the next two character typed.
+Action Toggles Italics font shape (math-mode, selection-wise).
\end_layout
\begin_layout Description
-Notion The following char will finish the tie.
+Syntax font-ital
\end_layout
\begin_layout Description
-Syntax accent-tie
+Origin vermeer, 10 Jan 2002
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_TILDE
+font-noun
\end_layout
\begin_layout Description
-Action Adds a tilde over the next character typed.
+Action Toggles Noun text style font (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-tilde
+Syntax font-noun
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_UMLAUT
+font-roman
\end_layout
\begin_layout Description
-Action Adds an umlaut over the next character typed.
+Action Toggles Roman family font (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-umlaut
+Syntax font-roman
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_UNDERBAR
+font-sans
\end_layout
\begin_layout Description
-Action Adds a bar under the next character typed.
+Action Toggles Sans Serif family font (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-underbar
+Syntax font-sans
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_UNDERDOT
+font-size
\end_layout
\begin_layout Description
-Action Adds a dot under the next character typed.
+Action Sets font size according to lyx format string.
\end_layout
\begin_layout Description
-Syntax accent-underdot
+Syntax font-size <SIZE>
\end_layout
-\begin_layout Subsection*
-LFUN_CAPTION_INSERT
+\begin_layout Description
+Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
+\begin_inset Newline newline
+\end_inset
+
+largest|huge|giant|increase|decrease|default
\end_layout
-\begin_layout Description
-Action Inserts a caption inset.
+\begin_layout Subsection*
+font-state
\end_layout
\begin_layout Description
-Syntax caption-insert
+Action Returns the info about the current font.
\end_layout
\begin_layout Description
-Origin Lgb, 18 Jul 2000
+Syntax font-state
\end_layout
\begin_layout Subsection*
-LFUN_DATE_INSERT
+font-strikeout
\end_layout
\begin_layout Description
-Action Inserts the current date.
+Action Toggles strikeout (strike-through) in the font (selection-wise).
\end_layout
\begin_layout Description
-Syntax date-insert [<ARG>]
+Syntax font-strikeout
\end_layout
\begin_layout Description
-Params <ARG>: Format of date.
- The default value (%x) can be set in Preferences->Date format.
- For possible formats see manual page of strftime function.
+Origin sanda, 3 May 2009
\end_layout
-\begin_layout Description
-Origin jdblair, 31 Jan 2000
+\begin_layout Subsection*
+font-typewriter
\end_layout
-\begin_layout Subsection*
-LFUN_FOOTNOTE_INSERT
+\begin_layout Description
+Action Toggles the typewriter family font (selection-wise).
\end_layout
\begin_layout Description
-Action Inserts a footnote inset.
+Syntax font-typewriter
+\end_layout
+
+\begin_layout Subsection*
+font-underline
\end_layout
\begin_layout Description
-Syntax footnote-insert
+Action Toggles underline in the font (selection-wise).
\end_layout
\begin_layout Description
-Origin Jug, 7 Mar 2000
+Syntax font-underline
\end_layout
\begin_layout Subsection*
-LFUN_ERT_INSERT
+font-underunderline
\end_layout
\begin_layout Description
-Action Inserts an ERT inset.
+Action Toggles double underline in the font (selection-wise).
\end_layout
\begin_layout Description
-Syntax ert-insert
+Syntax font-underunderline
\end_layout
\begin_layout Description
-Origin Jug, 18 Feb 2000
+Origin sanda, 5 May 2009
\end_layout
\begin_layout Subsection*
-LFUN_FLOAT_INSERT
-\end_layout
-
-\begin_layout Description
-Action Inserts a float inset.
+font-underwave
\end_layout
\begin_layout Description
-Syntax float-insert <TYPE>
+Action Toggles wavy underline in the font (selection-wise).
\end_layout
\begin_layout Description
-Params <TYPE>: type of float depends on the used textclass.
- Usually "algorithm", "table", "figure" parameters can be given.
+Syntax font-underwave
\end_layout
\begin_layout Description
-Origin Lgb, 27 Jun 2000
+Origin sanda, 5 May 2009
\end_layout
\begin_layout Subsection*
-LFUN_FLOAT_WIDE_INSERT
+layout
\end_layout
\begin_layout Description
-Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
+Action Sets the layout (that is, environment) for the current paragraph.
\end_layout
\begin_layout Description
-Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
+Syntax layout <LAYOUT>
\end_layout
\begin_layout Description
-Syntax float-wide-insert <TYPE>
+Params <LAYOUT>: the layout to use
\end_layout
-\begin_layout Description
-Params <TYPE>: type of float depends on the used textclass.
- Usually "algorithm", "table", "figure" parameters can be given.
+\begin_layout Subsection*
+layout-module-add
\end_layout
\begin_layout Description
-Origin Lgb, 31 Oct 2001
-\end_layout
-
-\begin_layout Subsection*
-LFUN_FLOAT_LIST_INSERT
+Action Adds a module.
\end_layout
\begin_layout Description
-Action Inserts the list of floats in the document.
+Notion Adds a module to the list of included modules for the current buffer.
\end_layout
\begin_layout Description
-Syntax float-list-insert <TYPE>
+Syntax layout-module-add <MODULE>
\end_layout
\begin_layout Description
-Params <TYPE>: type of float depends on the used textclass.
- Usually "algorithm", "table", "figure" parameters can be given.
+Params <MODULE>: the module to be added
\end_layout
\begin_layout Description
-Origin Lgb, 3 May 2001
+Origin rgh, 25 August 2007
\end_layout
\begin_layout Subsection*
-LFUN_WRAP_INSERT
+layout-modules-clear
\end_layout
\begin_layout Description
-Action Inserts floats wrapped by the text around.
+Action Clears the module list.
\end_layout
\begin_layout Description
-Syntax wrap-insert <TYPE>
+Notion Clears the list of included modules for the current buffer.
\end_layout
\begin_layout Description
-Params <TYPE>: table|figure
+Syntax layout-modules-clear
\end_layout
\begin_layout Description
-Origin Dekel, 7 Apr 2002
+Origin rgh, 25 August 2007
\end_layout
\begin_layout Subsection*
-LFUN_ARGUMENT_INSERT
-\end_layout
-
-\begin_layout Description
-Action Inserts an argument (short title) inset.
+layout-paragraph
\end_layout
\begin_layout Description
-Syntax argument-insert
+Action Launches the paragraph settings dialog.
\end_layout
\begin_layout Description
-Origin vermeer, 12 Aug 2002
+Syntax layout-paragraph
\end_layout
\begin_layout Subsection*
-LFUN_NEWPAGE_INSERT
+layout-reload
\end_layout
\begin_layout Description
-Action Inserts a new page.
+Action Reloads layout information.
\end_layout
\begin_layout Description
-Syntax newpage-insert <ARG>
+Notion Reloads all layout information for the current buffer from disk,
+ thus recognizing any changes that have been made to layout files on the
+ fly.
+ This is intended to be used only by layout developers and should not be
+ used when one is trying to do actual work.
\end_layout
\begin_layout Description
-Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
+Syntax layout-reload
\end_layout
\begin_layout Description
-Origin uwestoehr, 24 Nov 2007
+Origin rgh, 3 September 2007
\end_layout
\begin_layout Subsection*
-LFUN_MARGINALNOTE_INSERT
+layout-tabular
\end_layout
\begin_layout Description
-Action Inserts a marginal note.
+Action Launches the tabular settings dialog.
\end_layout
\begin_layout Description
-Syntax marginalnote-insert
+Syntax layout-tabular
\end_layout
\begin_layout Description
-Origin Lgb, 26 Jun 2000
+Origin Jug, 31 Jul 2000
\end_layout
\begin_layout Subsection*
-LFUN_UNICODE_INSERT
-\end_layout
-
-\begin_layout Description
-Action Inserts a single unicode character.
+screen-font-update
\end_layout
\begin_layout Description
-Syntax unicode-insert <CHAR>
+Action Update fonts and its metrics.
\end_layout
\begin_layout Description
-Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
+Notion Automatically called after zoom, dpi, font names, or norm change.
\end_layout
\begin_layout Description
-Sample unicode-insert 0x0100
+Syntax screen-font-update
\end_layout
\begin_layout Description
-Origin Lgb, 22 Oct 2006
+Origin ARRae, 13 Aug 2000
\end_layout
\begin_layout Subsection*
-LFUN_LISTING_INSERT
+textclass-apply
\end_layout
\begin_layout Description
-Action Inserts a new listings inset.
+Action Sets the text class for the current buffer.
\end_layout
\begin_layout Description
-Syntax listing-insert
+Syntax textclass-apply <TEXTCLASS>
\end_layout
\begin_layout Description
-Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
+Params <TEXTCLASS>: the textclass to set.
+ Note that this must be the filename, minus the ".layout" extension.
\end_layout
\begin_layout Subsection*
-LFUN_PREVIEW_INSERT
+textclass-load
\end_layout
\begin_layout Description
-Action Inserts a new preview inset.
+Action Loads information for a textclass from disk.
\end_layout
\begin_layout Description
-Syntax preview-insert
+Syntax textclass-load <TEXTCLASS>
\end_layout
\begin_layout Description
-Origin vfr, 28 Mar 2010
+Params <TEXTCLASS>: the textclass to load.
+ Note that this must be the filename, minus the ".layout" extension.
\end_layout
\begin_layout Subsection*
-LFUN_TAB_INSERT
+textstyle-apply
\end_layout
\begin_layout Description
-Action Insert a tab into a listings inset.
+Action Toggle user-defined (=last-time used) text style.
\end_layout
\begin_layout Description
-Notion It also works on a selection.
+Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
+ triggered when using Text Style dialog.
\end_layout
\begin_layout Description
-Syntax tab-insert
+Syntax textstyle-apply
\end_layout
\begin_layout Description
-Origin vfr, Sep 30 2008
+Origin leeming, 12 Mar 2003
\end_layout
\begin_layout Subsection*
-LFUN_TAB_DELETE
+textstyle-update
\end_layout
\begin_layout Description
-Action Delete a tab or up to an equivalent amount of spaces from a listings
- inset.
+Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
+LY.
\end_layout
\begin_layout Description
-Notion It also works on a selection - it removes a tab or spaces from the
- beginning of each line spanned by the selection.
- This is useful if you want to indent/unindent multiple lines in one action.
+Syntax textstyle-update <FONT_INFO>
\end_layout
\begin_layout Description
-Syntax tab-delete
+Params <FONT_INFO>: specifies font atributes, e.g.
+ family, series, shape, size, emph, noun, underbar, number, color, language,
+ toggleall.
+\begin_inset Newline newline
+\end_inset
+
+Use lyx -dbg action for exact syntax of text-style dialog parameters.
\end_layout
\begin_layout Description
-Origin vfr, Sep 30 2008
+Origin leeming, 12 Mar 2003
+\end_layout
+
+\begin_layout Section
+Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
\end_layout
\begin_layout Subsection*
-LFUN_QUOTE_INSERT
+accent-acute
\end_layout
\begin_layout Description
-Action Inserts quotes according to the type and quote-language preference.
+Action Adds an acute accent to the next character typed.
\end_layout
\begin_layout Description
-Notion Currently English, Swedish, German, Polish, French, Danish quotes
- are distinguished.
+Syntax accent-acute
+\end_layout
+
+\begin_layout Subsection*
+accent-breve
\end_layout
\begin_layout Description
-Syntax quote-insert [<TYPE>]
+Action Adds a breve accent to the next character typed.
\end_layout
\begin_layout Description
-Params <TYPE>: 'single' for single quotes, otherwise double quotes will
- be used.
+Syntax accent-breve
\end_layout
\begin_layout Subsection*
-LFUN_INFO_INSERT
+accent-caron
\end_layout
\begin_layout Description
-Action Displays shortcuts, lyxrc, package and textclass availability and
- menu information in a non-editable boxed InsetText.
+Action Adds a caron to the next character typed.
\end_layout
\begin_layout Description
-Notion Apart from lfun arguments you can use the following method:
-\begin_inset Newline newline
-\end_inset
-
-1.
- input the type and argument of this inset, e.g.
- "menu paste", in the work area.
-\begin_inset Newline newline
-\end_inset
+Syntax accent-caron
+\end_layout
-2.
- select the text and run info-insert lfun.
+\begin_layout Subsection*
+accent-cedilla
\end_layout
\begin_layout Description
-Syntax info-insert <TYPE> <ARG>
+Action Adds a cedilla to the next character typed.
\end_layout
\begin_layout Description
-Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
-\begin_inset Newline newline
-\end_inset
-
-<ARG>: argument for a given type.
- Look into InsetInfo.h for detailed description.
-\begin_inset Newline newline
-\end_inset
-
- shortcut[s]: name of lfun (e.g math-insert
-\backslash
-alpha)
-\begin_inset Newline newline
-\end_inset
-
- lyxrc: name of rc_entry (e.g.
- bind_file)
-\begin_inset Newline newline
-\end_inset
-
- lyxinfo: "version" - used version of LyX
-\begin_inset Newline newline
-\end_inset
-
- package: name of latex package (e.g.
- listings)
-\begin_inset Newline newline
-\end_inset
-
- textclass: name of textclass (e.g.
- article)
-\begin_inset Newline newline
-\end_inset
-
- menu: name of lfun used in menu
-\begin_inset Newline newline
-\end_inset
-
- icon: icon of lfun used in toolbar
-\begin_inset Newline newline
-\end_inset
+Syntax accent-cedilla
+\end_layout
- buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-a
-uthor"|"vcs-date"|"vcs-time"
+\begin_layout Subsection*
+accent-circle
\end_layout
\begin_layout Description
-Sample command-sequence info-insert buffer path; info-insert buffer name
+Action Adds a circle accent to the next character typed.
\end_layout
\begin_layout Description
-Origin bpeng, 7 Oct 2007
+Syntax accent-circle
\end_layout
\begin_layout Subsection*
-LFUN_BRANCH_INSERT
+accent-circumflex
\end_layout
\begin_layout Description
-Action Inserts branch inset.
+Action Adds a circumflex to the next character typed.
\end_layout
\begin_layout Description
-Syntax branch-insert <BRANCH-NAME>
+Syntax accent-circumflex
+\end_layout
+
+\begin_layout Subsection*
+accent-dot
\end_layout
\begin_layout Description
-Origin vermeer, 17 Aug 2003
+Action Adds a dot accent to the next character typed.
+\end_layout
+
+\begin_layout Description
+Syntax accent-dot
\end_layout
\begin_layout Subsection*
-LFUN_BOX_INSERT
+accent-grave
\end_layout
\begin_layout Description
-Action Inserts Box inset.
+Action Adds a grave accent to the next character typed.
\end_layout
\begin_layout Description
-Syntax box-insert [<TYPE>]
+Syntax accent-grave
\end_layout
-\begin_layout Description
-Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsection*
+accent-hungarian-umlaut
+\end_layout
-Framed is the default one.
+\begin_layout Description
+Action Adds a Hungarian umlaut to the next character typed.
\end_layout
\begin_layout Description
-Origin vermeer, 7 Oct 2003
+Syntax accent-grave
\end_layout
\begin_layout Subsection*
-LFUN_FLEX_INSERT
+accent-macron
\end_layout
\begin_layout Description
-Action Inserts CharStyle, Custom inset or XML short element.
+Action Adds a macron to the next character typed.
\end_layout
\begin_layout Description
-Notion Look into the Customization manual for more information about these
- elements.
-\begin_inset Newline newline
-\end_inset
+Syntax accent-macron
+\end_layout
-To make this command enabled the layout file for the document class you're
- using has to load the character styles.
- There are a few contained in the Logical Markup module.
- You can also of course create some yourself.
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsection*
+accent-ogonek
+\end_layout
-For dissolving the element see LFUN_INSET_DISSOLVE.
+\begin_layout Description
+Action Adds an ogonek accent to the next character typed.
\end_layout
\begin_layout Description
-Syntax flex-insert Name
+Syntax accent-ogonek
+\end_layout
+
+\begin_layout Subsection*
+accent-perispomeni
\end_layout
\begin_layout Description
-Params Name: This name must be defined either in your layout file or imported
- by some module.
- The definition is InsetLayout Name or InsetLayout <Flex:Name>.
- The Flex: prefix is optional.
+Action Adds a perispomeni (Greek circumflex) over the next character typed.
\end_layout
\begin_layout Description
-Sample flex-insert Code
+Syntax accent-perispomeni
\end_layout
\begin_layout Subsection*
-LFUN_SELF_INSERT
+accent-tie
\end_layout
\begin_layout Description
-Action Inserts the given string (accordingly to the correct keymap).
+Action Adds a tie over the next two character typed.
\end_layout
\begin_layout Description
-Notion Automatically replace the currently selected text.
- Depends on lyxrc settings "auto_region_delete".
+Notion The following char will finish the tie.
\end_layout
\begin_layout Description
-Syntax self-insert <STRING>
+Syntax accent-tie
\end_layout
\begin_layout Subsection*
-LFUN_SPACE_INSERT
+accent-tilde
\end_layout
\begin_layout Description
-Action Inserts one of horizontal space insets.
+Action Adds a tilde over the next character typed.
\end_layout
\begin_layout Description
-Syntax space-insert <NAME> [<LEN>]
+Syntax accent-tilde
\end_layout
-\begin_layout Description
-Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
-ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsection*
+accent-umlaut
+\end_layout
-<LEN>: length for custom spaces (hspace, hspace* for protected)
+\begin_layout Description
+Action Adds an umlaut over the next character typed.
\end_layout
\begin_layout Description
-Origin JSpitzm, 20 May 2003, Mar 17 2008
+Syntax accent-umlaut
\end_layout
\begin_layout Subsection*
-LFUN_HYPERLINK_INSERT
+accent-underbar
\end_layout
\begin_layout Description
-Action Inserts hyperlinks into the document (clickable in pdf output).
+Action Adds a bar under the next character typed.
\end_layout
\begin_layout Description
-Notion Hyperlink target can be set via selection + hyperlink-insert function.
+Syntax accent-underbar
\end_layout
-\begin_layout Description
-Syntax href-insert [<TARGET>]
+\begin_layout Subsection*
+accent-underdot
\end_layout
\begin_layout Description
-Origin CFO-G, 21 Nov 1997
+Action Adds a dot under the next character typed.
\end_layout
-\begin_layout Subsection*
-LFUN_SPECIALCHAR_INSERT
+\begin_layout Description
+Syntax accent-underdot
\end_layout
-\begin_layout Description
-Action Inserts various characters into the document.
+\begin_layout Subsection*
+all-changes-accept
\end_layout
\begin_layout Description
-Syntax specialchar-insert <CHAR>
+Action Accepts all tracked changes in the document.
\end_layout
\begin_layout Description
-Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
-tence, menu-separator.
+Syntax all-changes-accept
\end_layout
\begin_layout Description
-Origin JSpitzm, 6 Dec 2007
+Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
-LFUN_SCRIPT_INSERT
+all-changes-reject
\end_layout
\begin_layout Description
-Action Inserts a subscript or superscript inset.
+Action Rejects all tracked changes in the document.
\end_layout
\begin_layout Description
-Syntax script-insert <TYPE>
+Notion Reject does not work recursively; the user may have to repeat the
+ operation.
\end_layout
\begin_layout Description
-Params <TYPE>: subscript|superscript
+Syntax all-changes-reject
\end_layout
\begin_layout Description
-Origin Georg, 23 Nov 2010
+Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
-LFUN_APPENDIX
+appendix
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_INDEX_INSERT
-\end_layout
-
-\begin_layout Description
-Action Inserts Index entry.
+argument-insert
\end_layout
\begin_layout Description
-Notion It automatically takes the word on the cursor position.
+Action Inserts an argument (short title) inset.
\end_layout
\begin_layout Description
-Syntax index-insert [<TYPE:Name>]
+Syntax argument-insert <argument nr>
\end_layout
\begin_layout Description
-Params <TYPE:Name>: name of the index, if multiple indices are defined.
- with an empty argument, the default index is selected.
+Params <argument nr>: see layout declarations
\end_layout
\begin_layout Description
-Origin leeming, 3 Aug 2000
+Origin vermeer, 12 Aug 2002
\end_layout
\begin_layout Subsection*
-LFUN_INDEX_PRINT
+bibtex-database-add
\end_layout
\begin_layout Description
-Action Inserts list of Index entries on a new page.
+Action Adds database, which will be used for bibtex citations.
\end_layout
\begin_layout Description
-Syntax index-print [<TYPE:Name>]
+Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
+ bibliography) found from the cursor position.
\end_layout
\begin_layout Description
-Params <TYPE:Name>: name of the index, if multiple indices are defined.
- with an empty argument, the default index is selected.
+Syntax bibtex-database-add <DATABASE-NAME>
\end_layout
\begin_layout Description
-Origin Lgb, 27 Feb 1997
+Origin Ale, 30 May 1997
\end_layout
\begin_layout Subsection*
-LFUN_NOMENCL_INSERT
+bibtex-database-del
\end_layout
\begin_layout Description
-Action Inserts Nomenclature entry.
+Action Adds database, which will be used for bibtex citations.
\end_layout
\begin_layout Description
-Notion It automatically takes the word on the cursor position if no symbol
- is given.
+Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
+X bibliography) found from the cursor position.
\end_layout
\begin_layout Description
-Syntax nomencl-insert [<SYMBOL>]
+Syntax bibtex-database-del <DATABASE-NAME>
\end_layout
\begin_layout Description
-Origin Ugras, 4 Nov 2006
+Origin Ale, 30 May 1997
\end_layout
\begin_layout Subsection*
-LFUN_NOMENCLATURE_PRINT
+bookmark-clear
\end_layout
\begin_layout Description
-Action Inserts list of Nomenclature entries.
+Action Clears the list of saved bookmarks.
\end_layout
\begin_layout Description
-Syntax nomenclature-print
+Syntax bookmark-clear
\end_layout
\begin_layout Description
-Origin Ugras, 4 Nov 2006
+Origin bpeng, 31 October 2006
\end_layout
\begin_layout Subsection*
-LFUN_NOTE_INSERT
+bookmark-goto
\end_layout
\begin_layout Description
-Action Inserts Note on the current cursor postion, move selection inside
- the inset.
+Action Moves the cursor to the numbered bookmark, opening the file if necessary.
+ Note that bookmarks are saved per-session, not per file.
\end_layout
\begin_layout Description
-Syntax note-insert [<TYPE>]
-\end_layout
+Notion Bookmark 0 has a special purpose.
+ It is automatically set
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Params <TYPE>: <Note|Greyedout|Comment> default: Note
+1.
+ to the paragraph you are currently editing
+\begin_inset Newline newline
+\end_inset
+
+2.
+ to the paragraph from where you are jumping to the last-edited position
+ (jump-back feature)
+\begin_inset Newline newline
+\end_inset
+
+3.
+ when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
\end_layout
-\begin_layout Subsection*
-LFUN_NOTE_NEXT
+\begin_layout Description
+Syntax bookmark-goto <NUMBER>
\end_layout
\begin_layout Description
-Action Moves the cursor to the begining of next Note inset.
+Params <NUMBER>: the number of the bookmark to restore.
\end_layout
\begin_layout Description
-Syntax note-next
+Origin Dekel, 27 January 2001
\end_layout
\begin_layout Subsection*
-LFUN_PHANTOM_INSERT
+bookmark-save
\end_layout
\begin_layout Description
-Action Inserts phantom on the current cursor postion, move selection inside
- the inset.
+Action Save a bookmark.
\end_layout
\begin_layout Description
-Syntax phantom-insert [<TYPE>]
+Notion Saves a numbered bookmark to the sessions file.
+ The number must be between 1 and 9, inclusive.
+ Note that bookmarks are saved per-session, not per file.
\end_layout
\begin_layout Description
-Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
+Syntax bookmark-save <NUMBER>
\end_layout
\begin_layout Description
-Origin uwestoehr, 30 Jan 2009
+Params <NUMBER>: the number of the bookmark to save.
+\end_layout
+
+\begin_layout Description
+Origin Dekel, 27 January 2001
\end_layout
\begin_layout Subsection*
-LFUN_NEWLINE_INSERT
+box-insert
\end_layout
\begin_layout Description
-Action Inserts a line break or new line.
+Action Inserts Box inset.
\end_layout
\begin_layout Description
-Syntax newline-insert [<ARG>]
+Syntax box-insert [<TYPE>]
\end_layout
\begin_layout Description
-Params <ARG>: <newline|linebreak> default: newline
+Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
+\begin_inset Newline newline
+\end_inset
+
+Framed is the default one.
\end_layout
\begin_layout Description
-Origin JSpitzm, 25 Mar 2008
+Origin vermeer, 7 Oct 2003
\end_layout
\begin_layout Subsection*
-LFUN_ESCAPE
+branch-insert
\end_layout
\begin_layout Description
-Action Clears the selection.
- If no text is selected call LFUN_FINISHED_FORWARD.
- Inside math mode jumps out of the math inset.
+Action Inserts branch inset.
\end_layout
\begin_layout Description
-Syntax escape
+Syntax branch-insert <BRANCH-NAME>
\end_layout
\begin_layout Description
-Origin Lgb, 17 May 2001
+Origin vermeer, 17 Aug 2003
\end_layout
\begin_layout Subsection*
-LFUN_DOWN
+buffer-begin
\end_layout
\begin_layout Description
-Action Moves the cursor one line in downward direction.
+Action Move the cursor to the beginning of the document.
\end_layout
\begin_layout Description
-Syntax down
+Syntax buffer-begin
\end_layout
\begin_layout Subsection*
-LFUN_UP
+buffer-begin-select
\end_layout
\begin_layout Description
-Action Moves the cursor one line in upward direction.
+Action Move the cursor to the beginning of the document adding the traversed
+ text to the selection.
\end_layout
\begin_layout Description
-Syntax up
+Syntax buffer-begin-select
\end_layout
\begin_layout Subsection*
-LFUN_DOWN_SELECT
+buffer-end
\end_layout
\begin_layout Description
-Action Moves the cursor one line in downward direction adding the current
- position to the selection.
+Action Move the cursor to the end of the document.
\end_layout
\begin_layout Description
-Syntax down-select
+Syntax buffer-end
\end_layout
\begin_layout Subsection*
-LFUN_UP_SELECT
+buffer-end-select
\end_layout
\begin_layout Description
-Action Moves the cursor one line in upward direction adding the current
- position to the selection.
+Action Move the cursor to the end of the document adding the traversed text
+ to the selection.
\end_layout
\begin_layout Description
-Syntax up-select
+Syntax buffer-end-select
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_DOWN
+caption-insert
\end_layout
\begin_layout Description
-Action Moves the cursor one page in downward direction.
+Action Inserts a caption inset.
\end_layout
\begin_layout Description
-Syntax screen-down
+Syntax caption-insert
+\end_layout
+
+\begin_layout Description
+Origin Lgb, 18 Jul 2000
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_UP
+cell-backward
\end_layout
\begin_layout Description
-Action Moves the cursor one page in upward direction.
+Action Moves the cursor to the previous cell inside the table.
\end_layout
\begin_layout Description
-Syntax screen-up
+Syntax cell-backward
+\end_layout
+
+\begin_layout Description
+Origin Jug, 22 May 2000
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_DOWN_SELECT
+cell-forward
\end_layout
\begin_layout Description
-Action Moves the cursor one screen in downward direction adding the current
- position to the selection.
+Action Moves the cursor to the next cell inside the table.
\end_layout
\begin_layout Description
-Syntax screen-down-select
+Syntax cell-forward
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_UP_SELECT
+cell-split
\end_layout
\begin_layout Description
-Action Moves the cursor one page in upward direction adding the current
- position to the selection.
+Action Splits cell and shifts right part to the next cell (inside the math
+ grid).
\end_layout
\begin_layout Description
-Syntax screen-up-select
+Syntax cell-split
+\end_layout
+
+\begin_layout Description
+Origin Ale, 15 May 1997
\end_layout
\begin_layout Subsection*
-LFUN_SCROLL
+change-accept
\end_layout
\begin_layout Description
-Action Scroll the buffer view.
+Action Accepts tracked change inside the selection.
\end_layout
\begin_layout Description
-Notion Only scrolls the screen up or down; does not move the cursor.
+Syntax change-accept
\end_layout
\begin_layout Description
-Syntax scroll <TYPE> <QUANTITY>
+Origin Levon, 16 Oct 2002
+\end_layout
+
+\begin_layout Subsection*
+change-next
\end_layout
\begin_layout Description
-Params <TYPE>: line|page
-\begin_inset Newline newline
-\end_inset
+Action Moves the cursor to the position of the next change of the change
+ tracking records.
+\end_layout
-<QUANTITY>: up|down|<number>
+\begin_layout Description
+Syntax change-next
\end_layout
\begin_layout Description
-Origin Abdel, Dec 27 2007
+Origin schmitt, 4 Oct 2006
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_RECENTER
+change-previous
\end_layout
\begin_layout Description
-Action Recenters the screen on the current cursor position.
+Action Moves the cursor to the position of the previous change of the change
+ tracking records.
\end_layout
\begin_layout Description
-Syntax screen-recenter
+Syntax change-previous
+\end_layout
+
+\begin_layout Description
+Origin vfr, 4 Apr 2009
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_SHOW_CURSOR
+change-reject
\end_layout
\begin_layout Description
-Action Repositions the screen such that the cursor is visible.
+Action Rejects tracked change inside the selection.
\end_layout
\begin_layout Description
-Syntax screen-show-cursor
+Syntax change-reject
\end_layout
\begin_layout Description
-Origin vfr, 25 Mar 2009
+Origin Levon, 16 Oct 2002
+\end_layout
+
+\begin_layout Subsection*
+changes-merge
+\end_layout
+
+\begin_layout Description
+Action Open change tracking dialog for merging and moves the cursor to the
+ position of the next change.
+\end_layout
+
+\begin_layout Description
+Syntax changes-merge
+\end_layout
+
+\begin_layout Description
+Origin Levon, 16 Oct 2002
+\end_layout
+
+\begin_layout Subsection*
+changes-output
+\end_layout
+
+\begin_layout Description
+Action Toggles showing of change tracking in typeset output.
+\end_layout
+
+\begin_layout Description
+Syntax changes-output
+\end_layout
+
+\begin_layout Description
+Origin jspitzm, 21 Jan 2005
+\end_layout
+
+\begin_layout Subsection*
+changes-track
+\end_layout
+
+\begin_layout Description
+Action Toggles change tracking to on/off.
+\end_layout
+
+\begin_layout Description
+Syntax changes-track
+\end_layout
+
+\begin_layout Description
+Origin levon, 1 Oct 2002
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_BACKWARD
+char-backward
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_BACKWARD_SELECT
+char-backward-select
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_DELETE_BACKWARD
+char-delete-backward
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Syntax char-delete-backward
+Syntax char-delete-backward [force]
+\end_layout
+
+\begin_layout Description
+Params force: Delete big insets, do not only select them.
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_DELETE_FORWARD
+char-delete-forward
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Syntax char-delete-forward
+Syntax char-delete-forward [force]
+\end_layout
+
+\begin_layout Description
+Params force: Delete big insets, do not only select them.
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_FORWARD
+char-forward
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_FORWARD_SELECT
+char-forward-select
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_LEFT
+char-left
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_LEFT_SELECT
+char-left-select
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_RIGHT
+char-right
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_RIGHT_SELECT
+char-right-select
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_WORD_BACKWARD
+chars-transpose
\end_layout
\begin_layout Description
-Action Moves the cursor to the logically previous beginning of a word.
+Action Transposes the character at the cursor with the one before it.
\end_layout
\begin_layout Description
-Notion This is not the action which should be bound to the arrow keys, because
- backwards may be left or right, depending on the language.
- The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
- which in turn may employ this one.
+Syntax chars-transpose
\end_layout
\begin_layout Description
-Syntax word-backward
+Origin Lgb, 25 Apr 2001
\end_layout
\begin_layout Subsection*
-LFUN_WORD_BACKWARD_SELECT
+citation-insert
\end_layout
\begin_layout Description
-Action Moves the cursor to the logically previous beginning of a word, adding
- the logically traversed text to the selection.
+Action Inserts citation from loaded citation database.
\end_layout
\begin_layout Description
-Notion See also LFUN_WORD_BACKWARD.
+Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
\end_layout
\begin_layout Description
-Syntax word-backward-select
+Params <KEY>: Citation (shortcut listed in available citations).
+\begin_inset Newline newline
+\end_inset
+
+<TEXT_BEFORE>: text which should appear before citation.
+\end_layout
+
+\begin_layout Description
+Origin AAS, 97-02-23
\end_layout
\begin_layout Subsection*
-LFUN_WORD_DELETE_BACKWARD
+clipboard-paste
\end_layout
\begin_layout Description
-Action Deletes characters to the begining of the word (usually the "C+BackSpace"
- key).
+Action Pastes text from the active clipboard (retains formatting if the
+ clipboard contains formatted text).
+ Pastes plain text if plain text is on the clipboard, but tries to interpret
+ it in special ways for certain insets, e.g.
+ converting csv data to rows and columns if the paste happens in a tabular
+ inset.
\end_layout
\begin_layout Description
-Syntax word-delete-backward
+Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart
+ of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
+ is the clipboard, not the selection.
\end_layout
-\begin_layout Subsection*
-LFUN_WORD_DELETE_FORWARD
+\begin_layout Description
+Syntax clipboard-paste [<ARG>]
\end_layout
\begin_layout Description
-Action Deletes characters to the end of the word (usually the "C+Delete"
- key).
+Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
+ "Join lines".
\end_layout
\begin_layout Description
-Syntax word-delete-forward
+Origin Georg, 10 Jul 2006
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FIND_FORWARD
-\end_layout
-
-\begin_layout Description
-Action Search for a given string in forward direction.
+clipboard-paste-simple
\end_layout
\begin_layout Description
-Notion Case sensitive, match words.
- If no argument given, last search repeated.
+Action Pastes plain text from the active clipboard even if formatted LyX
+ content is in the clipboard.
+ Pastes plain text if plain text is on the clipboard, without trying to
+ interpret it in special ways for certain insets, e.g.
+ converting csv data to rows and columns if the paste happens in a tabular
+ inset.
\end_layout
\begin_layout Description
-Syntax word-find-forward [<STRING>]
+Syntax clipboard-paste-simple [<ARG>]
\end_layout
\begin_layout Description
-Origin Etienne, 16 Feb 1998
+Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
+ "Join lines".
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FIND_BACKWARD
-\end_layout
-
-\begin_layout Description
-Action Search for a given string in backward direction.
+command-execute
\end_layout
\begin_layout Description
-Notion Case sensitive, match words.
- If no argument given, last search repeated.
+Action Switches the focus to the minibuffer so that the user can type in
+ there.
+ If necessary, it opens the minibuffer toolbar.
\end_layout
\begin_layout Description
-Syntax word-find-backward [<STRING>]
+Notion Usually bound to M-x shortcut.
\end_layout
\begin_layout Description
-Origin Etienne, 20 Feb 1998
+Syntax command-execute
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FIND
-\end_layout
-
-\begin_layout Description
-Action Search for next occurence of a string.
+complete
\end_layout
\begin_layout Description
-Syntax word-find [<DATA>]
+Action Try to complete the word or command at the cursor position.
\end_layout
\begin_layout Description
-Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
- If no parameter is given, search with last find-dialog data is used for
- search (i.e.
- find-next).
+Syntax complete
\end_layout
\begin_layout Description
-Origin Andre, Jan 7 2004
+Origin sts, Feb 19 2008
\end_layout
\begin_layout Subsection*
-LFUN_WORD_REPLACE
+completion-accept
\end_layout
\begin_layout Description
-Action Replace a string in the document.
+Action Accept suggested completion.
\end_layout
\begin_layout Description
-Syntax word-replace [<DATA>]
+Syntax completion-accept
\end_layout
\begin_layout Description
-Params <DATA>: data is of the form "<replace>
-\begin_inset Newline newline
-\end_inset
+Origin sanda, Sep 08 2008
+\end_layout
-<search>
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsection*
+completion-cancel
+\end_layout
-<casesensitive> <matchword> <all> <forward>"
+\begin_layout Description
+Action Try to cancel completion, either the popup or the inline completion.
\end_layout
\begin_layout Description
-Origin Andre, Jan 7 2004
+Syntax completion-cancel
+\end_layout
+
+\begin_layout Description
+Origin sts, Sep 07 2008
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FINDADV
+completion-inline
\end_layout
\begin_layout Description
-Action Search for next occurence of a pattern.
+Action Show the inline completion at the cursor position.
\end_layout
\begin_layout Description
-Syntax word-findadv [<DATA>]
+Syntax completion-inline
\end_layout
\begin_layout Description
-Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
- If no parameter is given, search with last find-dialog data is used for
- search (i.e.
- find-next).
-\end_layout
-
-\begin_layout Description
-Origin Tommaso, Nov 15 2007
+Origin sts, Feb 19 2008
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FORWARD
+completion-popup
\end_layout
\begin_layout Description
-Action Moves the cursor to the logically next beginning of a word.
+Action Show the completion popup at the cursor position.
\end_layout
\begin_layout Description
-Notion This is not the action which should be bound to the arrow keys, because
- forward may be left or right, depending on the language.
- The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
- which in turn may employ this one.
+Syntax completion-popup
\end_layout
\begin_layout Description
-Syntax word-forward
+Origin sts, Feb 19 2008
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FORWARD_SELECT
+copy
\end_layout
\begin_layout Description
-Action Moves the cursor to the logically next beginning of a word, adding
- the logically traversed text to the selection.
+Action Copies the current selection to the clipboard.
\end_layout
\begin_layout Description
-Notion See also LFUN_WORD_FORWARD.
+Syntax copy
+\end_layout
+
+\begin_layout Subsection*
+cut
\end_layout
\begin_layout Description
-Syntax word-forward-select
+Action Cuts to the clipboard.
+\end_layout
+
+\begin_layout Description
+Syntax cut
\end_layout
\begin_layout Subsection*
-LFUN_WORD_LEFT
+date-insert
\end_layout
\begin_layout Description
-Action Moves the cursor to the next beginning of a word "on the left".
+Action Inserts the current date.
\end_layout
\begin_layout Description
-Notion This is the action which should be taken when the (e.g., ctrl-) "left"
- key is pressed.
- Generally, it moves the cursor to the next beginning of a word on the left.
- However, in Bidi text this become slightly more complicated, and there
- are different modes of cursor movement.
- In "visual mode", this moves left, plain and simple.
- In "logical mode", movement is logically forward in RTL paragraphs, and
- logically backwards in LTR paragraphs.
+Syntax date-insert [<ARG>]
\end_layout
\begin_layout Description
-Syntax word-left
+Params <ARG>: Format of date.
+ The default value (%x) can be set in Preferences->Date format.
+ For possible formats see manual page of strftime function.
\end_layout
\begin_layout Description
-Origin dov, 28 Oct 2007
+Origin jdblair, 31 Jan 2000
\end_layout
\begin_layout Subsection*
-LFUN_WORD_LEFT_SELECT
+depth-decrement
\end_layout
\begin_layout Description
-Action Moves the cursor to the next beginning of a word "on the left", adding
- *logically* traversed text to the selection.
+Action Decrease the nesting depth of the (selected) paragraph(s) inside
+ lists.
\end_layout
\begin_layout Description
-Notion See also LFUN_WORD_LEFT for exact details of the movement.
+Syntax depth-decrement
+\end_layout
+
+\begin_layout Subsection*
+depth-increment
\end_layout
\begin_layout Description
-Syntax word-left-select
+Action Increase the nesting depth of the (selected) paragraph(s) inside
+ lists.
\end_layout
\begin_layout Description
-Origin dov, 28 Oct 2007
+Syntax depth-increment
\end_layout
\begin_layout Subsection*
-LFUN_WORD_RIGHT
+dialog-disconnect-inset
\end_layout
\begin_layout Description
-Action Moves the cursor to the next beginning of a word "on the right".
+Action Closes opened connection to opened inset.
\end_layout
\begin_layout Description
-Notion This is the action which should be taken when the (e.g., ctrl-) "right"
- key is pressed.
- Generally, it moves the cursor to the next beginning of a word on the right.
- However, in Bidi text this become slightly more complicated, and there
- are different modes of cursor movement.
- In "visual mode", this moves right, plain and simple.
- In "logical mode", movement is logically forward in LTR paragraphs, and
- logically backwards in RTL paragraphs.
+Notion Connection is used for apply functions.
\end_layout
\begin_layout Description
-Syntax word-right
+Syntax dialog-disconnect-inset <INSET-NAME>
\end_layout
\begin_layout Description
-Origin dov, 28 Oct 2007
+Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
-LFUN_WORD_RIGHT_SELECT
+dialog-hide
\end_layout
\begin_layout Description
-Action Moves the cursor to the next beginning of a word "on the right",
- adding *logically* traversed text to the selection.
+Action Hides showed dialog.
+ Counterpart to LFUN_DIALOG_SHOW .
\end_layout
\begin_layout Description
-Notion See also LFUN_WORD_RIGHT for exact details of the movement.
+Syntax dialog-hide <NAME>
\end_layout
\begin_layout Description
-Syntax word-right-select
+Params See LFUN_DIALOG_SHOW .
\end_layout
\begin_layout Description
-Origin dov, 28 Oct 2007
+Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
-LFUN_WORD_SELECT
+dialog-show
\end_layout
\begin_layout Description
-Action Puts the word where the cursor stands into the selection.
+Action Shows hidden dialog or creates new one for a given function/inset
+ settings etc.
\end_layout
\begin_layout Description
-Syntax word-select
+Syntax dialog-show <NAME> [<DATA>]
\end_layout
\begin_layout Description
-Origin Andre, 11 Sep 2002
-\end_layout
-
-\begin_layout Subsection*
-LFUN_WORD_CAPITALIZE
-\end_layout
+Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Capitalizes the words in the selection (i.e.
- the first letters) or the letter on the cursor position.
-\end_layout
+compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax word-capitalize
-\end_layout
+graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
+er|
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_WORD_UPCASE
-\end_layout
+mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Change the words in the selection or from the cursor position to
- the end of word to the upper case.
-\end_layout
+print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax word-upcase
-\end_layout
+thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_WORD_LOWCASE
-\end_layout
+<SPECIAL>: latexlog|vclog
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Change the words in the selection or from the cursor position to
- the end of word to the lower case.
+<DATA>: data, usually settings for the given dialog.
+ Use debug mode for the details.
\end_layout
\begin_layout Description
-Syntax word-lowcase
+Origin leeming, 17 Jun 2003
\end_layout
\begin_layout Subsection*
-LFUN_SPELLING_ADD
-\end_layout
-
-\begin_layout Description
-Action Add the word under the cursor to the respective spell checker dictionary.
+dialog-show-new-inset
\end_layout
\begin_layout Description
-Syntax spelling-add [<STRING>] [<LANG>]
+Action Shows hidden dialog or create new one for a given inset settings
+ etc.
\end_layout
\begin_layout Description
-Params <WORD>: word to add <LANG>: language name (see file languages)
+Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
+ inset.
\end_layout
\begin_layout Description
-Origin JSpitzm, 18 Jan 2010
-\end_layout
-
-\begin_layout Subsection*
-LFUN_SPELLING_IGNORE
+Syntax dialog-show-new-inset <NAME> [<DATA>]
\end_layout
\begin_layout Description
-Action Let the spell checker ignore the word under the cursor in the current
- session for the given language.
+Params See LFUN_DIALOG_SHOW .
\end_layout
\begin_layout Description
-Syntax spelling-ignore [<WORD>] [<LANG>]
+Origin leeming, 25 Feb 2003
\end_layout
-\begin_layout Description
-Params <WORD>: word to ignore <LANG>: language name (see file languages)
+\begin_layout Subsection*
+dialog-toggle
\end_layout
\begin_layout Description
-Origin JSpitzm, 18 Jan 2010
-\end_layout
-
-\begin_layout Subsection*
-LFUN_SPELLING_REMOVE
+Action Toggles dialog between showed/hidden state.
\end_layout
\begin_layout Description
-Action Remove the word under the cursor from the respective spell checker
- dictionary.
+Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
\end_layout
\begin_layout Description
-Syntax spelling-remove [<STRING>] [<LANG>]
+Syntax dialog-toggle <NAME> [<DATA>]
\end_layout
\begin_layout Description
-Params <WORD>: word to remove <LANG>: language name (see file languages)
+Params See LFUN_DIALOG_SHOW .
\end_layout
\begin_layout Description
-Origin SWitt, 28 July 2010
+Origin JSpitzm, 30 Apr 2007
\end_layout
\begin_layout Subsection*
-LFUN_THESAURUS_ENTRY
+dialog-update
\end_layout
\begin_layout Description
-Action Look up thesaurus entries with respect to the word under the cursor.
+Action Updates the dialog values from the inset/paragraph/document.
\end_layout
\begin_layout Description
-Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
+Syntax dialog-update <NAME>
\end_layout
\begin_layout Description
-Params <STRING>: word to look up <LANG>: language (see file languages)
+Params <NAME>: paragraph|prefs|<INSET>
+\begin_inset Newline newline
+\end_inset
+
+<INSET>: inset name
\end_layout
\begin_layout Description
-Origin Levon, 20 Jul 2001
+Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_BEGIN
+down
\end_layout
\begin_layout Description
-Action Move the cursor to the beginning of the document.
+Action Moves the cursor one line in downward direction.
\end_layout
\begin_layout Description
-Syntax buffer-begin
+Syntax down
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_BEGIN_SELECT
+down-select
\end_layout
\begin_layout Description
-Action Move the cursor to the beginning of the document adding the traversed
- text to the selection.
+Action Moves the cursor one line in downward direction adding the current
+ position to the selection.
\end_layout
\begin_layout Description
-Syntax buffer-begin-select
+Syntax down-select
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_END
-\end_layout
-
-\begin_layout Description
-Action Move the cursor to the end of the document.
+ert-insert
\end_layout
\begin_layout Description
-Syntax buffer-end
-\end_layout
-
-\begin_layout Subsection*
-LFUN_BUFFER_END_SELECT
+Action Inserts an ERT inset.
\end_layout
\begin_layout Description
-Action Move the cursor to the end of the document adding the traversed text
- to the selection.
+Syntax ert-insert
\end_layout
\begin_layout Description
-Syntax buffer-end-select
+Origin Jug, 18 Feb 2000
\end_layout
\begin_layout Subsection*
-LFUN_INSET_BEGIN
+escape
\end_layout
\begin_layout Description
-Action Move the cursor to the beginning of the current inset if it is not
- already there, or at the beginning of the enclosing inset otherwise
+Action Clears the selection.
+ If no text is selected call LFUN_FINISHED_FORWARD.
+ Inside math mode jumps out of the math inset.
\end_layout
\begin_layout Description
-Syntax inset-begin
+Syntax escape
\end_layout
\begin_layout Description
-Origin lasgouttes, 16 Mar 2009
+Origin Lgb, 17 May 2001
\end_layout
\begin_layout Subsection*
-LFUN_INSET_BEGIN_SELECT
+file-insert
\end_layout
\begin_layout Description
-Action Move the cursor to the beginning of the current inset if it is not
- already there, or at the beginning of the enclosing inset otherwise (adding
- the traversed text to the selection).
+Action Inserts another LyX file.
\end_layout
\begin_layout Description
-Syntax inset-begin-select
+Syntax file-insert [<FILE>]
\end_layout
\begin_layout Description
-Origin lasgouttes, 16 Mar 2009
+Params <FILE>: Filename to be inserted.
\end_layout
\begin_layout Subsection*
-LFUN_INSET_END
+file-insert-plaintext
\end_layout
\begin_layout Description
-Action Move the cursor to the end of the current inset if it is not already
- there, or at the end of the enclosing inset otherwise
+Action Inserts plain text file.
\end_layout
\begin_layout Description
-Syntax inset-end
+Syntax file-insert-plaintext [<FILE>]
\end_layout
\begin_layout Description
-Origin lasgouttes, 16 Mar 2009
-\end_layout
-
-\begin_layout Subsection*
-LFUN_INSET_END_SELECT
+Params <FILE>: Filename to be inserted.
\end_layout
\begin_layout Description
-Action Move the cursor to the end of the current inset if it is not already
- there, or at the end of the enclosing inset otherwise (adding the traversed
- text to the selection).
+Origin CFO-G, 19 Nov 1997
\end_layout
-\begin_layout Description
-Syntax inset-end-select
+\begin_layout Subsection*
+file-insert-plaintext-para
\end_layout
\begin_layout Description
-Origin lasgouttes, 16 Mar 2009
-\end_layout
-
-\begin_layout Subsection*
-LFUN_INSET_SELECT_ALL
+Action Inserts plain text file as paragraph (i.e.
+ join lines).
\end_layout
\begin_layout Description
-Action Selects all contents of an inset.
+Syntax file-insert-plaintext-para [<FILE>]
\end_layout
\begin_layout Description
-Syntax inset-select-all
+Params <FILE>: Filename to be inserted.
\end_layout
\begin_layout Description
-Origin vfr, 22 Aug 2009
+Origin Levon, 14 Feb 2001
\end_layout
\begin_layout Subsection*
-LFUN_SECTION_SELECT
+flex-insert
\end_layout
\begin_layout Description
-Action Selects the whole section.
+Action Inserts CharStyle, Custom inset or XML short element.
\end_layout
\begin_layout Description
-Notion The cursor should be in a section heading before calling this lfun.
-\end_layout
-
-\begin_layout Description
-Syntax section-select
-\end_layout
+Notion Look into the Customization manual for more information about these
+ elements.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Origin vfr, 05 May 2009
+To make this command enabled the layout file for the document class you're
+ using has to load the character styles.
+ There are a few contained in the Logical Markup module.
+ You can also of course create some yourself.
+\begin_inset Newline newline
+\end_inset
+
+For dissolving the element see LFUN_INSET_DISSOLVE.
\end_layout
-\begin_layout Subsection*
-LFUN_LINE_BEGIN
+\begin_layout Description
+Syntax flex-insert Name
\end_layout
\begin_layout Description
-Action Move the cursor to the begining of the (screen) line.
+Params Name: This name must be defined either in your layout file or imported
+ by some module.
+ The definition is InsetLayout Name or InsetLayout <Flex:Name>.
+ The Flex: prefix is optional.
\end_layout
\begin_layout Description
-Syntax line-begin
+Sample flex-insert Code
\end_layout
\begin_layout Subsection*
-LFUN_LINE_BEGIN_SELECT
+float-insert
\end_layout
\begin_layout Description
-Action Move the cursor to the beginning of the (screen) line adding the
- traversed text to the selection.
+Action Inserts a float inset.
\end_layout
\begin_layout Description
-Syntax line-begin-select
-\end_layout
-
-\begin_layout Subsection*
-LFUN_LINE_END
+Syntax float-insert <TYPE>
\end_layout
\begin_layout Description
-Action Move the cursor to the end of the (screen) line.
+Params <TYPE>: type of float depends on the used textclass.
+ Usually "algorithm", "table", "figure" parameters can be given.
\end_layout
\begin_layout Description
-Syntax line-end
+Origin Lgb, 27 Jun 2000
\end_layout
\begin_layout Subsection*
-LFUN_LINE_END_SELECT
+float-list-insert
\end_layout
\begin_layout Description
-Action Move the cursor to the end of the (screen) line adding the traversed
- text to the selection.
+Action Inserts the list of floats in the document.
\end_layout
\begin_layout Description
-Syntax line-end-select
-\end_layout
-
-\begin_layout Subsection*
-LFUN_LINE_DELETE
+Syntax float-list-insert <TYPE>
\end_layout
\begin_layout Description
-Action Deletes the letters to the end of the (screen) line or deletes the
- selection.
+Params <TYPE>: type of float depends on the used textclass.
+ Usually "algorithm", "table", "figure" parameters can be given.
\end_layout
\begin_layout Description
-Syntax line-delete-forward
+Origin Lgb, 3 May 2001
\end_layout
\begin_layout Subsection*
-LFUN_COPY
+float-wide-insert
\end_layout
\begin_layout Description
-Action Copies to the clipboard the last edit.
+Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
\end_layout
\begin_layout Description
-Syntax copy
+Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
\end_layout
-\begin_layout Subsection*
-LFUN_CUT
+\begin_layout Description
+Syntax float-wide-insert <TYPE>
\end_layout
\begin_layout Description
-Action Cuts to the clipboard.
+Params <TYPE>: type of float depends on the used textclass.
+ Usually "algorithm", "table", "figure" parameters can be given.
\end_layout
\begin_layout Description
-Syntax cut
+Origin Lgb, 31 Oct 2001
\end_layout
\begin_layout Subsection*
-LFUN_PASTE
+footnote-insert
\end_layout
\begin_layout Description
-Action Pastes material (text or picture) from the active clipboard.
+Action Inserts a footnote inset.
\end_layout
\begin_layout Description
-Syntax paste [<TYPE>|<NUM>]
+Syntax footnote-insert
\end_layout
\begin_layout Description
-Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
-\begin_inset Newline newline
-\end_inset
-
-<NUM>: number of the selection in the internal clipboard stack to be pasted.
+Origin Jug, 7 Mar 2000
\end_layout
\begin_layout Subsection*
-LFUN_CLIPBOARD_PASTE
-\end_layout
-
-\begin_layout Description
-Action Pastes text from the active clipboard.
+graphics-reload
\end_layout
\begin_layout Description
-Syntax clipboard-paste [<ARG>]
+Action Reloads the image if necessary.
\end_layout
\begin_layout Description
-Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
- "Join lines".
+Syntax graphics-reload
\end_layout
\begin_layout Description
-Origin Georg, 10 Jul 2006
+Origin vfr, 10 Aug 2009
\end_layout
\begin_layout Subsection*
-LFUN_PRIMARY_SELECTION_PASTE
+href-insert
\end_layout
\begin_layout Description
-Action Pastes the currently selected text.
+Action Inserts hyperlinks into the document (clickable in pdf output).
\end_layout
\begin_layout Description
-Notion Primary selection mechanism is linux-only thing.
+Notion Hyperlink target can be set via selection + hyperlink-insert function.
\end_layout
\begin_layout Description
-Syntax primary-selection-paste [<ARG>]
+Syntax href-insert [<TARGET>]
\end_layout
\begin_layout Description
-Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
- "Join lines".
+Origin CFO-G, 21 Nov 1997
\end_layout
\begin_layout Subsection*
-LFUN_SELECTION_PASTE
+in-ipa
\end_layout
\begin_layout Description
-Action Pastes the the internal selection text in permanent selection.
+Action Only active in IPA inset.
\end_layout
\begin_layout Description
-Notion Created in order to have middle mouse button pasting correct (bound
- to command-alternatives selection-paste ; primary-selection-paste paragraph).
+Notion Dummy function which is only active in a IPA inset.
+ It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
\end_layout
\begin_layout Description
-Syntax selection-paste
+Syntax in-ipa
\end_layout
\begin_layout Description
-Origin lasgouttes, 14 Jan 2009
+Origin spitz, 20 May 2012
\end_layout
\begin_layout Subsection*
-LFUN_UNDO
+index-insert
\end_layout
\begin_layout Description
-Action Undoes the last edit.
+Action Inserts Index entry.
\end_layout
\begin_layout Description
-Syntax undo
-\end_layout
-
-\begin_layout Subsection*
-LFUN_REDO
+Notion It automatically takes the word on the cursor position.
\end_layout
\begin_layout Description
-Action Redoes the last thing undone.
+Syntax index-insert [<TYPE:Name>]
\end_layout
\begin_layout Description
-Syntax redo
-\end_layout
-
-\begin_layout Subsection*
-LFUN_REPEAT
+Params <TYPE:Name>: name of the index, if multiple indices are defined.
+ With an empty argument, the default index is selected.
\end_layout
\begin_layout Description
-Action Repeat the given command.
+Origin leeming, 3 Aug 2000
\end_layout
-\begin_layout Description
-Syntax repeat <COUNT> <LFUN-COMMAND>
+\begin_layout Subsection*
+index-print
\end_layout
\begin_layout Description
-Origin Andre, 27 Oct 2003
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CHARS_TRANSPOSE
+Action Inserts list of Index entries on a new page.
\end_layout
\begin_layout Description
-Action Transposes the character at the cursor with the one before it.
+Syntax index-print [<TYPE:Name>]
\end_layout
\begin_layout Description
-Syntax chars-transpose
+Params <TYPE:Name>: name of the index, if multiple indices are defined.
+ With an empty argument, the default index is selected.
\end_layout
\begin_layout Description
-Origin Lgb, 25 Apr 2001
+Origin Lgb, 27 Feb 1997
\end_layout
\begin_layout Subsection*
-LFUN_DEPTH_DECREMENT
+info-insert
\end_layout
\begin_layout Description
-Action Decrease the nesting depth of the (selected) paragraph(s) inside
- lists.
+Action Displays shortcuts, lyxrc, package and textclass availability and
+ menu information in a non-editable boxed InsetText.
\end_layout
\begin_layout Description
-Syntax depth-decrement
-\end_layout
+Notion Apart from lfun arguments you can use the following method:
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_DEPTH_INCREMENT
+1.
+ input the type and argument of this inset, e.g.
+ "menu paste", in the work area.
+\begin_inset Newline newline
+\end_inset
+
+2.
+ select the text and run info-insert lfun.
\end_layout
\begin_layout Description
-Action Increase the nesting depth of the (selected) paragraph(s) inside
- lists.
+Syntax info-insert <TYPE> <ARG>
\end_layout
\begin_layout Description
-Syntax depth-increment
-\end_layout
+Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|buffer
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_FONT_BOLD
-\end_layout
+<ARG>: argument for a given type.
+ Look into InsetInfo.h for detailed description.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Toggles the bold font (selection-wise) using mathbf in math.
-\end_layout
+ shortcut[s]: name of lfun (e.g math-insert
+\backslash
+alpha)
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax font-bold
-\end_layout
+ lyxrc: name of rc_entry (e.g.
+ bind_file)
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_FONT_BOLDSYMBOL
-\end_layout
+ lyxinfo: "version" - used version of LyX
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Toggles the bold font (selection-wise) using boldsymbol in math.
-\end_layout
+ package: name of latex package (e.g.
+ listings)
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax font-boldsymbol
-\end_layout
+ textclass: name of textclass (e.g.
+ article)
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_FONT_TYPEWRITER
+ menu: name of lfun used in menu
+\begin_inset Newline newline
+\end_inset
+
+ icon: icon of lfun used in toolbar or direct icon name
+\begin_inset Newline newline
+\end_inset
+
+ buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-a
+uthor"|"vcs-date"|"vcs-time"
\end_layout
\begin_layout Description
-Action Toggles the typewriter family font (selection-wise).
+Sample command-sequence info-insert buffer path; info-insert buffer name
\end_layout
\begin_layout Description
-Syntax font-typewriter
+Origin bpeng, 7 Oct 2007
\end_layout
\begin_layout Subsection*
-LFUN_FONT_UNDERLINE
-\end_layout
-
-\begin_layout Description
-Action Toggles underline in the font (selection-wise).
+inset-apply
\end_layout
\begin_layout Description
-Syntax font-underline
-\end_layout
-
-\begin_layout Subsection*
-LFUN_FONT_UULINE
+Action Apply data for an inset.
\end_layout
\begin_layout Description
-Action Toggles double underline in the font (selection-wise).
+Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
+ applied.
+ This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
+ on the context where it is called.
\end_layout
\begin_layout Description
-Syntax font-underunderline
+Syntax inset-apply <ARGS>
\end_layout
\begin_layout Description
-Origin sanda, 5 May 2009
+Params See LFUN_INSET_INSERT .
\end_layout
\begin_layout Subsection*
-LFUN_FONT_UWAVE
+inset-begin
\end_layout
\begin_layout Description
-Action Toggles wavy underline in the font (selection-wise).
+Action Move the cursor to the beginning of the current inset if it is not
+ already there, or at the beginning of the enclosing inset otherwise
\end_layout
\begin_layout Description
-Syntax font-underwave
+Syntax inset-begin
\end_layout
\begin_layout Description
-Origin sanda, 5 May 2009
+Origin lasgouttes, 16 Mar 2009
\end_layout
\begin_layout Subsection*
-LFUN_FONT_STRIKEOUT
+inset-begin-select
\end_layout
\begin_layout Description
-Action Toggles strikeout (strike-through) in the font (selection-wise).
+Action Move the cursor to the beginning of the current inset if it is not
+ already there, or at the beginning of the enclosing inset otherwise (adding
+ the traversed text to the selection).
\end_layout
\begin_layout Description
-Syntax font-strikeout
+Syntax inset-begin-select
\end_layout
\begin_layout Description
-Origin sanda, 3 May 2009
+Origin lasgouttes, 16 Mar 2009
\end_layout
\begin_layout Subsection*
-LFUN_FONT_EMPH
+inset-copy-as
\end_layout
\begin_layout Description
-Action Toggles the emphasis font style (selection-wise).
+Action Copies the inset to the clipboard as a certain type.
\end_layout
\begin_layout Description
-Syntax font-emph
-\end_layout
-
-\begin_layout Subsection*
-LFUN_FONT_NOUN
+Notion Currently used only for InsetInfo where its content is copied as
+ a text.
\end_layout
\begin_layout Description
-Action Toggles Noun text style font (selection-wise).
+Syntax inset-copy-as
\end_layout
\begin_layout Description
-Syntax font-noun
+Origin vfr, 18 Apr 2010
\end_layout
\begin_layout Subsection*
-LFUN_FONT_ROMAN
+inset-dissolve
\end_layout
\begin_layout Description
-Action Toggles Roman family font (selection-wise).
+Action Dissolve the current inset into text.
\end_layout
\begin_layout Description
-Syntax font-roman
+Syntax inset-dissolve [<INSET>]
\end_layout
-\begin_layout Subsection*
-LFUN_FONT_SANS
-\end_layout
+\begin_layout Description
+Params <INSET>: this can be used to make sure the right kind of inset is
+ dissolved.
+ For example "dissolve" entry in the charstyles sub-menu should only dissolve
+ the charstyle inset, even if the cursor is inside several nested insets
+ of different type.
+\begin_inset Newline newline
+\end_inset
+
+For values see lyx::InsetLayout::lyxtype_ .
+\end_layout
+
+\begin_layout Description
+Origin JSpitz, 7 Aug 2006
+\end_layout
+
+\begin_layout Subsection*
+inset-edit
+\end_layout
+
+\begin_layout Description
+Action Edit the inset at cursor with an external application, if one is
+ attributed.
+\end_layout
+
+\begin_layout Description
+Syntax inset-edit [<INSET_PARAMS>]
+\end_layout
+
+\begin_layout Description
+Params <INSET_PARAMS>: Parameters for the inset.
+\begin_inset Newline newline
+\end_inset
+
+Currently only the filename will be considered.
+\end_layout
+
+\begin_layout Description
+Origin JSpitzm, 27 Apr 2006
+\end_layout
+
+\begin_layout Subsection*
+inset-end
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the end of the current inset if it is not already
+ there, or at the end of the enclosing inset otherwise
+\end_layout
+
+\begin_layout Description
+Syntax inset-end
+\end_layout
+
+\begin_layout Description
+Origin lasgouttes, 16 Mar 2009
+\end_layout
+
+\begin_layout Subsection*
+inset-end-select
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the end of the current inset if it is not already
+ there, or at the end of the enclosing inset otherwise (adding the traversed
+ text to the selection).
+\end_layout
+
+\begin_layout Description
+Syntax inset-end-select
+\end_layout
+
+\begin_layout Description
+Origin lasgouttes, 16 Mar 2009
+\end_layout
+
+\begin_layout Subsection*
+inset-forall
+\end_layout
+
+\begin_layout Description
+Action Apply the given commands on insets of a given name.
+\end_layout
+
+\begin_layout Description
+Notion WARNING: use at your own risks; this function gives you too many
+ ways of shooting yourself in the foot.
+ A typical example is inset-forall Note note-insert which starts an infinite
+ loop.
+ This is mitigated by the fact that the number of actions is arbitrarily
+ limited to 100000.
+ Note also that inset-forall does not update metrics between iterations,
+ which can lead to bugs.
+ This has to be eventually fixed.
+\end_layout
+
+\begin_layout Description
+Syntax inset-forall <NAME> <LFUN-COMMAND>
+\begin_inset Newline newline
+\end_inset
+
+<NAME>: Type of Inset.
+ If <NAME> is *, all insets are matched.
+ The name is used like for InsetLayout in layout files: "Note" matches all
+ note insets, while "Note:Note" only matches LyX yellow note insets.
+\end_layout
+
+\begin_layout Description
+Sample Remove all index insets:
+\begin_inset Newline newline
+\end_inset
+
+ inset-forall Index char-delete-forward force
+\begin_inset Newline newline
+\end_inset
+
+Close all Notes (also works for a particular branch, for example):
+\begin_inset Newline newline
+\end_inset
+
+ inset-forall Note inset-toggle close
+\begin_inset Newline newline
+\end_inset
+
+Transform all yellow notes to comments
+\begin_inset Newline newline
+\end_inset
+
+ inset-forall Note:Note inset-modify note Note Comment
+\begin_inset Newline newline
+\end_inset
+
+Try to put LyX in an infinite loop if there is at least a Note:
+\begin_inset Newline newline
+\end_inset
+
+ inset-forall Note char-backward
+\end_layout
+
+\begin_layout Description
+Origin lasgouttes, 27 Nov 2009
+\end_layout
+
+\begin_layout Subsection*
+inset-insert
+\end_layout
+
+\begin_layout Description
+Action Insert new inset (type given by the parameters).
+\end_layout
+
+\begin_layout Description
+Syntax inset-insert <INSET> <ARGS>
+\end_layout
+
+\begin_layout Description
+Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
+\begin_inset Newline newline
+\end_inset
+
+ hyperlink|include|index|label|line|nomencl|vspace|ref|toc|scri
+pt>
+\begin_inset Newline newline
+\end_inset
+
+<ARGS>: depends on the given inset.
+ Use "lyx -dbg action" to explore.
+\end_layout
+
+\begin_layout Description
+Sample inset-insert ref LatexCommand <Format> reference "<label name>"
+\backslash
+end_inset
+\begin_inset Newline newline
+\end_inset
+
+where <label name> is the name of the referenced label and <Format> is one
+ of the following:
+\begin_inset Newline newline
+\end_inset
+
+ref -- <reference>
+\begin_inset Newline newline
+\end_inset
+
+eqref -- (<reference>)
+\begin_inset Newline newline
+\end_inset
+
+pageref -- <page>
+\begin_inset Newline newline
+\end_inset
+
+vpageref -- on <page>
+\begin_inset Newline newline
+\end_inset
+
+vref -- <reference> on <page>
+\begin_inset Newline newline
+\end_inset
+
+formatted -- Formatted reference
+\end_layout
+
+\begin_layout Subsection*
+inset-modify
+\end_layout
+
+\begin_layout Description
+Action Modify some properties of an inset.
+\end_layout
+
+\begin_layout Description
+Notion Used for argument, bibitem, bibtex, box, branch, caption, citation,
+ command, ert, external, float, graphics, include, index, info, label, line,
+ listings, newline, newpage, nomencl, note, phantom, quotes, ref, script,
+ separator, space, tabular, vspace and wrap insets.
+\end_layout
+
+\begin_layout Description
+Syntax inset-modify <INSET> <ARGS>
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype <TYPE>
+\end_layout
+
+\begin_layout Description
+Sample Change a Note inset into a Comment inset:
+\begin_inset Newline newline
+\end_inset
+
+inset-modify note Note Comment
+\begin_inset Newline newline
+\end_inset
+
+Change a Box into an Ovalbox:
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype Ovalbox
+\begin_inset Newline newline
+\end_inset
+
+Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle
+ = inner, secondary]
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype els
+\begin_inset Newline newline
+\end_inset
+
+Change only the style of a quotation mark, maintaining the other aspects
+ (.
+ = wildcard)
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype e..
+\begin_inset Newline newline
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection*
+inset-select-all
+\end_layout
+
+\begin_layout Description
+Action Select all contents of an inset.
+\end_layout
+
+\begin_layout Description
+Notion There are 3 successive levels: select current cell, select all cells
+ of inset, select the inset from outside (in the enclosing inset).
+\end_layout
+
+\begin_layout Description
+Syntax inset-select-all
+\end_layout
+
+\begin_layout Description
+Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
+\end_layout
+
+\begin_layout Subsection*
+inset-settings
+\end_layout
+
+\begin_layout Description
+Action Open the inset's properties dialog.
+\end_layout
+
+\begin_layout Description
+Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
+ graphics, href, include, index, index_print, label, line, listings, note,
+ phantom, ref, space, tabular, vspace, wrap insets.
+\end_layout
+
+\begin_layout Description
+Syntax inset-settings <INSET>
+\end_layout
+
+\begin_layout Description
+Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
+\begin_inset Newline newline
+\end_inset
+
+graphics|href|include|index|index_print|label|line|
+\begin_inset Newline newline
+\end_inset
+
+listings|note|phantom|ref|space|tabular|vspace|wrap>.
+\end_layout
+
+\begin_layout Subsection*
+inset-toggle
+\end_layout
+
+\begin_layout Description
+Action Toggles the collapsible inset at cursor position, or the inset we
+ are currently in.
+\end_layout
+
+\begin_layout Description
+Syntax inset-toggle [<ARG>]
+\end_layout
+
+\begin_layout Description
+Params <ARG>: <open|close|toggle|assign>.
+\begin_inset Newline newline
+\end_inset
+
+open/close/toggle are for collapsible insets.
+ toggle is used when no argument is given.
+\begin_inset Newline newline
+\end_inset
+
+assign synchronize the branch-inset with activation status of the branch.
+ Used for global toggling when changed activation.
+\end_layout
+
+\begin_layout Description
+Origin lasgouttes, 19 Jul 2001
+\end_layout
+
+\begin_layout Subsection*
+ipa-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts an IPA inset.
+\end_layout
+
+\begin_layout Description
+Syntax ipa-insert
+\end_layout
+
+\begin_layout Description
+Origin spitz, 05 Mar 2012
+\end_layout
+
+\begin_layout Subsection*
+ipamacro-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts special IPA macros into the document.
+\end_layout
+
+\begin_layout Description
+Syntax ipamacro-insert <CHAR>
+\end_layout
+
+\begin_layout Description
+Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
+ tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
+\end_layout
+
+\begin_layout Description
+Origin JSpitzm, 22 Aug 2012
+\end_layout
+
+\begin_layout Subsection*
+keymap-off
+\end_layout
+
+\begin_layout Description
+Action Turn off the loaded keyboard map.
+\end_layout
+
+\begin_layout Description
+Syntax keymap-off
+\end_layout
+
+\begin_layout Subsection*
+keymap-primary
+\end_layout
+
+\begin_layout Description
+Action Turn on the primary keyboard map.
+\end_layout
+
+\begin_layout Description
+Notion Maps were widely used in past, when X-windows didn't have nowadays
+ keyboard support.
+ They can be still used to maintain uniform keyboard layout across the various
+ platforms.
+\begin_inset Newline newline
+\end_inset
+
+The language is to be set in the Preferences dialog.
+\end_layout
+
+\begin_layout Description
+Syntax keymap-primary
+\end_layout
+
+\begin_layout Subsection*
+keymap-secondary
+\end_layout
+
+\begin_layout Description
+Action Turn on the secondary keyboard map.
+\end_layout
+
+\begin_layout Description
+Syntax keymap-secondary
+\end_layout
+
+\begin_layout Subsection*
+keymap-toggle
+\end_layout
+
+\begin_layout Description
+Action Toggles keyboard maps (first/second/off).
+\end_layout
+
+\begin_layout Description
+Syntax keymap-toggle
+\end_layout
+
+\begin_layout Description
+Origin leeming, 30 Mar 2004
+\end_layout
+
+\begin_layout Subsection*
+label-copy-as-reference
+\end_layout
+
+\begin_layout Description
+Action Copies the label at the cursor as a cross-reference to be pasted
+ elsewhere.
+\end_layout
+
+\begin_layout Description
+Syntax copy-label-as-reference <LABEL>
+\end_layout
+
+\begin_layout Description
+Params <LABEL>: The label to copy (for multi-line math)
+\end_layout
+
+\begin_layout Description
+Origin sts, 16 Nov 2008
+\end_layout
+
+\begin_layout Subsection*
+label-goto
+\end_layout
+
+\begin_layout Description
+Action Goto a label.
+\end_layout
+
+\begin_layout Description
+Syntax label-goto [<LABEL>]
+\end_layout
+
+\begin_layout Description
+Params <LABEL>: Requested label.
+ If no label is given and reference is on cursor position, Bookmark 0 is
+ saved and cursor moves to the position of referenced label.
+\end_layout
+
+\begin_layout Description
+Origin Ale, 6 Aug 1997
+\end_layout
+
+\begin_layout Subsection*
+label-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts label to text or displayed formula.
+\end_layout
+
+\begin_layout Description
+Syntax label-insert [<LABEL>]
+\end_layout
+
+\begin_layout Description
+Params <LABEL>: Requested label.
+ If no label is given dialog requesting name will be opened.
+\end_layout
+
+\begin_layout Subsection*
+label-insert-as-reference
+\end_layout
+
+\begin_layout Description
+Action Inserts the label (in ToC pane) as a cross-reference at the position
+ of the cursor.
+\end_layout
+
+\begin_layout Description
+Syntax label-insert-as-reference
+\end_layout
+
+\begin_layout Description
+Origin vfr, 7 Apr 2009
+\end_layout
+
+\begin_layout Subsection*
+language
+\end_layout
+
+\begin_layout Description
+Action Set language from the current cursor position.
+\end_layout
\begin_layout Description
-Action Toggles Sans Serif family font (selection-wise).
+Syntax language <LANG> [set]
\end_layout
\begin_layout Description
-Syntax font-sans
+Params <LANG>: Requested language.
+ Look in lib/languages for the list.
+ "language reset" or "language" (without param) reset to the document language.
+ set: If used, the language will be set to the specified language.
+ Otherwise, the language will be toggled (i.e., if the current language is
+ LANG, switch to the document language or the default language, if LANG
+ is the document language).
+\end_layout
+
+\begin_layout Description
+Origin Dekel, 2 Mar 2000
\end_layout
\begin_layout Subsection*
-LFUN_FONT_FRAK
+line-begin
\end_layout
\begin_layout Description
-Action Toggles Fraktur family font (math-mode, selection-wise).
+Action Move the cursor to the beginning of the (screen) line.
\end_layout
\begin_layout Description
-Syntax font-frak
+Syntax line-begin
+\end_layout
+
+\begin_layout Subsection*
+line-begin-select
\end_layout
\begin_layout Description
-Origin vermeer, 10 Jan 2002
+Action Move the cursor to the beginning of the (screen) line adding the
+ traversed text to the selection.
+\end_layout
+
+\begin_layout Description
+Syntax line-begin-select
\end_layout
\begin_layout Subsection*
-LFUN_FONT_ITAL
+line-delete-forward
\end_layout
\begin_layout Description
-Action Toggles Italics font shape (math-mode, selection-wise).
+Action Deletes the letters to the end of the (screen) line or deletes the
+ selection.
\end_layout
\begin_layout Description
-Syntax font-ital
+Syntax line-delete-forward
+\end_layout
+
+\begin_layout Subsection*
+line-end
\end_layout
\begin_layout Description
-Origin vermeer, 10 Jan 2002
+Action Move the cursor to the end of the (screen) line.
+\end_layout
+
+\begin_layout Description
+Syntax line-end
\end_layout
\begin_layout Subsection*
-LFUN_FONT_DEFAULT
+line-end-select
\end_layout
\begin_layout Description
-Action Reverts the settings of the font to the default values (selection-wise).
+Action Move the cursor to the end of the (screen) line adding the traversed
+ text to the selection.
\end_layout
\begin_layout Description
-Syntax font-default
+Syntax line-end-select
\end_layout
\begin_layout Subsection*
-LFUN_FONT_SIZE
+listing-insert
\end_layout
\begin_layout Description
-Action Sets font size according to lyx format string.
+Action Inserts a new listings inset.
+\end_layout
+
+\begin_layout Description
+Syntax listing-insert
+\end_layout
+
+\begin_layout Description
+Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
+\end_layout
+
+\begin_layout Subsection*
+marginalnote-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts a marginal note.
+\end_layout
+
+\begin_layout Description
+Syntax marginalnote-insert
+\end_layout
+
+\begin_layout Description
+Origin Lgb, 26 Jun 2000
+\end_layout
+
+\begin_layout Subsection*
+mark-off
+\end_layout
+
+\begin_layout Description
+Action Disable selecting of text-region.
+\end_layout
+
+\begin_layout Description
+Syntax mark-off
+\end_layout
+
+\begin_layout Subsection*
+mark-on
+\end_layout
+
+\begin_layout Description
+Action Enable selecting of text-region.
+\end_layout
+
+\begin_layout Description
+Notion After enabling you can simply move arrow keys to get selected region.
+\end_layout
+
+\begin_layout Description
+Syntax mark-on
+\end_layout
+
+\begin_layout Subsection*
+mark-toggle
+\end_layout
+
+\begin_layout Description
+Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
+\end_layout
+
+\begin_layout Description
+Syntax mark-toggle
+\end_layout
+
+\begin_layout Description
+Origin Andre, May 5 2006
+\end_layout
+
+\begin_layout Subsection*
+newline-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts a line break or new line.
+\end_layout
+
+\begin_layout Description
+Syntax newline-insert [<ARG>]
+\end_layout
+
+\begin_layout Description
+Params <ARG>: <newline|linebreak> default: newline
+\end_layout
+
+\begin_layout Description
+Origin JSpitzm, 25 Mar 2008
+\end_layout
+
+\begin_layout Subsection*
+newpage-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts a new page.
+\end_layout
+
+\begin_layout Description
+Syntax newpage-insert <ARG>
+\end_layout
+
+\begin_layout Description
+Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
+\end_layout
+
+\begin_layout Description
+Origin uwestoehr, 24 Nov 2007
+\end_layout
+
+\begin_layout Subsection*
+nomencl-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts Nomenclature entry.
+\end_layout
+
+\begin_layout Description
+Notion It automatically takes the word on the cursor position if no symbol
+ is given.
+\end_layout
+
+\begin_layout Description
+Syntax nomencl-insert [<SYMBOL>]
+\end_layout
+
+\begin_layout Description
+Origin Ugras, 4 Nov 2006
+\end_layout
+
+\begin_layout Subsection*
+nomencl-print
+\end_layout
+
+\begin_layout Description
+Action Inserts list of Nomenclature entries.
+\end_layout
+
+\begin_layout Description
+Syntax nomenclature-print
+\end_layout
+
+\begin_layout Description
+Origin Ugras, 4 Nov 2006
+\end_layout
+
+\begin_layout Subsection*
+note-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts Note on the current cursor position, move selection inside
+ the inset.
+\end_layout
+
+\begin_layout Description
+Syntax note-insert [<TYPE>]
+\end_layout
+
+\begin_layout Description
+Params <TYPE>: <Note|Greyedout|Comment> default: Note
+\end_layout
+
+\begin_layout Subsection*
+note-next
+\end_layout
+
+\begin_layout Description
+Action Moves the cursor to the beginning of next Note inset.
+\end_layout
+
+\begin_layout Description
+Syntax note-next
+\end_layout
+
+\begin_layout Subsection*
+outline-down
+\end_layout
+
+\begin_layout Description
+Action Move the current group in the downward direction in the structure
+ of the document.
+\end_layout
+
+\begin_layout Description
+Notion The "group" can be Part/Chapter/Section/etc.
+ It moves the whole substructure of the group.
+\end_layout
+
+\begin_layout Description
+Syntax outline-down
+\end_layout
+
+\begin_layout Description
+Origin Vermeer, 23 Mar 2006
+\end_layout
+
+\begin_layout Subsection*
+outline-in
+\end_layout
+
+\begin_layout Description
+Action Moves the current group in the downward direction in the hierarchy
+ of the document structure.
+\end_layout
+
+\begin_layout Description
+Notion Part -> Chapter -> Section -> etc.
+\end_layout
+
+\begin_layout Description
+Syntax outline-in
+\end_layout
+
+\begin_layout Description
+Origin Vermeer, 23 Mar 2006
+\end_layout
+
+\begin_layout Subsection*
+outline-out
+\end_layout
+
+\begin_layout Description
+Action Moves the current group in the upward direction in the hierarchy
+ of the document structure.
+\end_layout
+
+\begin_layout Description
+Notion Part <- Chapter <- Section <- etc.
\end_layout
\begin_layout Description
-Syntax font-size <SIZE>
+Syntax outline-out
\end_layout
\begin_layout Description
-Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
-\begin_inset Newline newline
-\end_inset
-
-largest|huge|giant|increase|decrease|default
+Origin Vermeer, 23 Mar 2006
\end_layout
\begin_layout Subsection*
-LFUN_TEXTSTYLE_APPLY
+outline-up
\end_layout
\begin_layout Description
-Action Toggle user-defined (=last-time used) text style.
+Action Move the current group in the upward direction in the structure of
+ the document.
\end_layout
\begin_layout Description
-Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
- trigerred when using Text Style dialog.
+Notion The "group" can be Part/Chapter/Section/etc.
+ It moves the whole substructure of the group.
\end_layout
\begin_layout Description
-Syntax textstyle-apply
+Syntax outline-up
\end_layout
\begin_layout Description
-Origin leeming, 12 Mar 2003
+Origin Vermeer, 23 Mar 2006
\end_layout
\begin_layout Subsection*
-LFUN_TEXTSTYLE_UPDATE
+paragraph-break
\end_layout
\begin_layout Description
-Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
-LY.
+Action Breaks the current paragraph at the current location.
\end_layout
\begin_layout Description
-Syntax textstyle-update <FONT_INFO>
+Notion Removes the selection.
\end_layout
\begin_layout Description
-Params <FONT_INFO>: specifies font atributes, e.g.
- family, series, shape, size, emph, noun, underbar, number, color, language,
- toggleall.
-\begin_inset Newline newline
-\end_inset
-
-Use lyx -dbg action for exact syntax of text-style dialog parameters.
+Syntax paragraph-break [<LAYOUT>]
\end_layout
\begin_layout Description
-Origin leeming, 12 Mar 2003
+Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
+ default layout) when the cursor is at the end of the line.
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_FONT_UPDATE
+paragraph-down
\end_layout
\begin_layout Description
-Action Update fonts and its metrics.
+Action Move the cursor to the next paragraph (or beginning of the current
+ one) in downward direction.
\end_layout
\begin_layout Description
-Notion Automatically called after zoom, dpi, font names, or norm change.
+Syntax paragraph-down
\end_layout
\begin_layout Description
-Syntax screen-font-update
+Origin Asger, 1 Oct 1996
\end_layout
-\begin_layout Description
-Origin ARRae, 13 Aug 2000
+\begin_layout Subsection*
+paragraph-down-select
\end_layout
-\begin_layout Subsection*
-LFUN_FONT_STATE
+\begin_layout Description
+Action Move the cursor and select the text to the next paragraph (or beginning
+ of the current one) in downward direction.
\end_layout
\begin_layout Description
-Action Returns the info about the current font.
+Syntax paragraph-down-select
\end_layout
\begin_layout Description
-Syntax font-state
+Origin Asger, 1 Oct 1996
\end_layout
\begin_layout Subsection*
-LFUN_CITATION_INSERT
+paragraph-goto
\end_layout
\begin_layout Description
-Action Inserts citation from loaded citation database.
+Action Jump to a paragraph given by its id number and optionally the desired
+ position within the paragraph.
+ If given four arguments id_start, pos_start, id_end, pos_end, perform a
+ selection from start to end.
\end_layout
\begin_layout Description
-Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
+Notion Note that id number of paragraph is not the sequential number of
+ paragraph seen on the screen.
+ Moreover the id is unique for all opened buffers (documents).
+ Both ids must belong to the same buffer.
\end_layout
\begin_layout Description
-Params <KEY>: Citation (shortcut listed in available citations).
+Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
+\end_layout
+
+\begin_layout Description
+Params <PAR_ID>: paragraph id
\begin_inset Newline newline
\end_inset
-<TEXT_BEFORE>: text which should appear before citation.
+<POS_IN_PAR>: desired position within the paragraph
\end_layout
\begin_layout Description
-Origin AAS, 97-02-23
+Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
\end_layout
\begin_layout Subsection*
-LFUN_BIBTEX_DATABASE_ADD
-\end_layout
-
-\begin_layout Description
-Action Adds database, which will be used for bibtex citations.
+paragraph-move-down
\end_layout
\begin_layout Description
-Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
- bibliography) found from the cursor postion.
+Action Moves the current paragraph downwards in the document.
\end_layout
\begin_layout Description
-Syntax bibtex-database-add <DATABASE-NAME>
+Syntax paragraph-move-down
\end_layout
\begin_layout Description
-Origin Ale, 30 May 1997
+Origin Edwin, 8 Apr 2006
\end_layout
\begin_layout Subsection*
-LFUN_BIBTEX_DATABASE_DEL
+paragraph-move-up
\end_layout
\begin_layout Description
-Action Adds database, which will be used for bibtex citations.
+Action Moves the current paragraph upwards in the document.
\end_layout
\begin_layout Description
-Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
-X bibliography) found from the cursor postion.
+Notion Movement through the document will possibly break the paragraph-depth
+ (e.g.
+ itemize structure).
\end_layout
\begin_layout Description
-Syntax bibtex-database-del <DATABASE-NAME>
+Syntax paragraph-move-up
\end_layout
\begin_layout Description
-Origin Ale, 30 May 1997
+Origin Edwin, 8 Apr 2006
\end_layout
\begin_layout Subsection*
-LFUN_LAYOUT
+paragraph-params
\end_layout
\begin_layout Description
-Action Sets the layout (that is, environment) for the current paragraph.
+Action Change paragraph settings.
\end_layout
\begin_layout Description
-Syntax layout <LAYOUT>
+Notion Modifies the current paragraph, or currently selected paragraphs.
+ This function only modifies, and does not override, existing settings.
+ Note that the "leftindent" indent setting is deprecated.
\end_layout
\begin_layout Description
-Params <LAYOUT>: the layout to use
+Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
\end_layout
-\begin_layout Subsection*
-LFUN_LAYOUT_PARAGRAPH
+\begin_layout Description
+Params <INDENT>:
+\backslash
+noindent|
+\backslash
+indent|
+\backslash
+indent-toggle|
+\backslash
+leftindent LENGTH
+\begin_inset Newline newline
+\end_inset
+
+<SPACING>:
+\backslash
+paragraph_spacing default|single|onehalf|double|other SIZE
+\begin_inset Newline newline
+\end_inset
+
+<ALIGN>:
+\backslash
+align block|left|right|center|default
+\begin_inset Newline newline
+\end_inset
+
+<OTHERS>:
+\backslash
+labelwidthstring WIDTH|
+\backslash
+start_of_appendix
\end_layout
\begin_layout Description
-Action Launches the paragraph settings dialog.
+Origin rgh, Aug 15 2007
+\end_layout
+
+\begin_layout Subsection*
+paragraph-params-apply
\end_layout
\begin_layout Description
-Syntax layout-paragraph
+Action Change paragraph settings.
\end_layout
-\begin_layout Subsection*
-LFUN_LAYOUT_TABULAR
+\begin_layout Description
+Notion Overwrite all nonspecified settings to the default ones.
+ Use paragraph-params lfun if you don't want to overwrite others settings.
\end_layout
\begin_layout Description
-Action Launches the tabular settings dialog.
+Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
\end_layout
\begin_layout Description
-Syntax layout-tabular
+Params For parameters see LFUN_PARAGRAPH_PARAMS
\end_layout
\begin_layout Description
-Origin Jug, 31 Jul 2000
+Origin leeming, 30 Mar 2004
\end_layout
\begin_layout Subsection*
-LFUN_DROP_LAYOUTS_CHOICE
+paragraph-up
\end_layout
\begin_layout Description
-Action Displays list of layout choices.
+Action Move the cursor to the next paragraph (or beginning of the current
+ one) in upward direction.
\end_layout
\begin_layout Description
-Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
- allowing for choice of layout.
+Syntax paragraph-up
\end_layout
\begin_layout Description
-Syntax drop-layouts-choice
+Origin Asger, 1 Oct 1996
\end_layout
\begin_layout Subsection*
-LFUN_LAYOUT_MODULES_CLEAR
-\end_layout
-
-\begin_layout Description
-Action Clears the module list.
+paragraph-up-select
\end_layout
\begin_layout Description
-Notion Clears the list of included modules for the current buffer.
+Action Move the cursor and select the text to the next paragraph (or beginning
+ of the current one) in upward direction.
\end_layout
\begin_layout Description
-Syntax layout-modules-clear
+Syntax paragraph-up-select
\end_layout
\begin_layout Description
-Origin rgh, 25 August 2007
+Origin Asger, 1 Oct 1996
\end_layout
\begin_layout Subsection*
-LFUN_LAYOUT_MODULE_ADD
-\end_layout
-
-\begin_layout Description
-Action Adds a module.
+paste
\end_layout
\begin_layout Description
-Notion Adds a module to the list of included modules for the current buffer.
+Action Pastes material (text or picture) from the active clipboard.
\end_layout
\begin_layout Description
-Syntax layout-module-add <MODULE>
+Syntax paste [<TYPE>|<NUM>]
\end_layout
\begin_layout Description
-Params <MODULE>: the module to be added
-\end_layout
+Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Origin rgh, 25 August 2007
+<NUM>: number of the selection in the internal clipboard stack to be pasted.
\end_layout
\begin_layout Subsection*
-LFUN_LAYOUT_RELOAD
+phantom-insert
\end_layout
\begin_layout Description
-Action Reloads layout information.
+Action Inserts phantom on the current cursor position, move selection inside
+ the inset.
\end_layout
\begin_layout Description
-Notion Reloads all layout information for the current buffer from disk,
- thus recognizing any changes that have been made to layout files on the
- fly.
- This is intended to be used only by layout developers and should not be
- used when one is trying to do actual work.
+Syntax phantom-insert [<TYPE>]
\end_layout
\begin_layout Description
-Syntax layout-reload
+Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
\end_layout
\begin_layout Description
-Origin rgh, 3 September 2007
+Origin uwestoehr, 30 Jan 2009
\end_layout
\begin_layout Subsection*
-LFUN_TEXTCLASS_APPLY
+preview-insert
\end_layout
\begin_layout Description
-Action Sets the text class for the current buffer.
+Action Inserts a new preview inset.
\end_layout
\begin_layout Description
-Syntax textclass-apply <TEXTCLASS>
+Syntax preview-insert
\end_layout
\begin_layout Description
-Params <TEXTCLASS>: the textclass to set.
- Note that this must be the filename, minus the ".layout" extension.
+Origin vfr, 28 Mar 2010
\end_layout
\begin_layout Subsection*
-LFUN_TEXTCLASS_LOAD
-\end_layout
-
-\begin_layout Description
-Action Loads information for a textclass from disk.
+primary-selection-paste
\end_layout
\begin_layout Description
-Syntax textclass-load <TEXTCLASS>
+Action Pastes the currently selected text.
\end_layout
\begin_layout Description
-Params <TEXTCLASS>: the textclass to load.
- Note that this must be the filename, minus the ".layout" extension.
-\end_layout
-
-\begin_layout Subsection*
-LFUN_MARK_OFF
+Notion Primary selection mechanism is linux-only thing.
\end_layout
\begin_layout Description
-Action Disable selecting of text-region.
+Syntax primary-selection-paste [<ARG>]
\end_layout
\begin_layout Description
-Syntax mark-off
+Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
+ "Join lines".
\end_layout
\begin_layout Subsection*
-LFUN_MARK_ON
+quote-insert
\end_layout
\begin_layout Description
-Action Enable selecting of text-region.
+Action Inserts quotes according to the type and quote-language preference.
\end_layout
\begin_layout Description
-Notion After enabling you can simply move arrow keys to get selected region.
+Notion Currently 15 different quote styles are distinguished (see params).
\end_layout
\begin_layout Description
-Syntax mark-on
-\end_layout
-
-\begin_layout Subsection*
-LFUN_MARK_TOGGLE
+Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
\end_layout
\begin_layout Description
-Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
-\end_layout
+Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
+ outer (i.e., primary, usually double) quotes will be used.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax mark-toggle
-\end_layout
+<SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise
+ the side will be guessed from the context.
+\begin_inset Newline newline
+\end_inset
+
+<STYLE>: 'british' for `British' quote style (with ``inner quotation'')
+\begin_inset Newline newline
+\end_inset
+
+'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
+\begin_inset Newline newline
+\end_inset
+
+'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
+\begin_inset Newline newline
+\end_inset
+
+'danish' for >>Danish<< quote style (with >inner quotation<)
+\begin_inset Newline newline
+\end_inset
+
+'english' for ``English'' quote style (with `inner quotation')
+\begin_inset Newline newline
+\end_inset
+
+'french' for <<french>> quote style (with ``inner quotation'')
+\begin_inset Newline newline
+\end_inset
+
+'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in"
+ = Imprimerie Nationale]
+\begin_inset Newline newline
+\end_inset
+
+'german' for ,,German`` quote style (with ,inner quotation`)
+\begin_inset Newline newline
+\end_inset
+
+'plain' for "Plain" quote style (with 'inner quotation')
+\begin_inset Newline newline
+\end_inset
+
+'polish' for ,,Polish'' quote style (with ,inner quotation')
+\begin_inset Newline newline
+\end_inset
+
+'swedish' for ''Swedish'' quote style (with 'inner quotation')
+\begin_inset Newline newline
+\end_inset
+
+'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" =
+ Guillemets]
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Origin Andre, May 5 2006
-\end_layout
+'swiss' for <<Swiss>> quote style (with <inner quotation>)
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_MATH_DELIM
-\end_layout
+'russian' for <<Russian>> quote style (with ,,inner quotation``)
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Inserts math delimiters (e.g.
- parentheses, brackets) enclosing expression.
-\end_layout
+'dynamic' for Dynamic quotation marks which inherit the global document
+ style
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax math-delim [<LEFT>] [<RIGHT>]
+If no quote style is specified, the document-wide will be used.
\end_layout
-\begin_layout Description
-Params <LEFT/RIGHT>: Delimiters to be used.
- Each delimiter can be specified by either a LaTeX name or a valid character.
- ( is the default letter.
+\begin_layout Subsection*
+redo
\end_layout
\begin_layout Description
-Sample math-delim { rangle
+Action Redoes the last thing undone.
\end_layout
\begin_layout Description
-Origin Alejandro, 18 Jun 1996
+Syntax redo
\end_layout
\begin_layout Subsection*
-LFUN_MATH_BIGDELIM
-\end_layout
-
-\begin_layout Description
-Action Inserts math fixed size delimiters (e.g.
- parentheses, brackets) enclosing expression.
-\end_layout
-
-\begin_layout Description
-Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
+reference-next
\end_layout
\begin_layout Description
-Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
-\begin_inset Newline newline
-\end_inset
-
-<L/RDELIM>: TeX code for delimiter.
- See Delimiter dialog for delimiters to be used.
+Action Go to the next label or cross-reference.
\end_layout
\begin_layout Description
-Sample math-bigdelim "Bigl" "
-\backslash
-Downarrow" "Bigr" "
-\backslash
-}"
+Syntax reference-next
\end_layout
\begin_layout Description
-Origin Enrico & Georg, 7 May 2006
+Origin Dekel, 14 Jan 2001
\end_layout
\begin_layout Subsection*
-LFUN_MATH_DISPLAY
+repeat
\end_layout
\begin_layout Description
-Action Creates a new displayed equation in text mode.
- Toggles inlined/display formula in math mode.
+Action Repeat the given command.
\end_layout
\begin_layout Description
-Syntax math-display [<ARG>]
+Notion fails when the repeat count is greater than 10000.
\end_layout
\begin_layout Description
-Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
- new equation from the text mode.
+Syntax repeat <COUNT> <LFUN-COMMAND>
\end_layout
\begin_layout Description
-Origin Alejandro, 18 Jun 1996
+Origin Andre, 27 Oct 2003
\end_layout
\begin_layout Subsection*
-LFUN_MATH_INSERT
-\end_layout
-
-\begin_layout Description
-Action Inserts math objects and symbols.
-\end_layout
-
-\begin_layout Description
-Notion When <ARG> is a _single_ math inset with more than one cell (such
- as "x_y^z" or "
-\backslash
-frac{x}{y}"), the content of cell(0) is replaced by the current selection
- (only works if the selection is in mathed).
- As an example, if "abc" is selected in mathed, "math-insert
-\backslash
-frac{x}{y}" replaces "abc" with "
-\backslash
-frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
- If nothing is selected (or the selection is not in mathed), math-insert
- works as expected.
+screen-down
\end_layout
\begin_layout Description
-Syntax math-insert <ARG>
+Action Moves the cursor one page in downward direction.
\end_layout
\begin_layout Description
-Params <ARG>: Symbol or LaTeX code to be inserted.
+Syntax screen-down
\end_layout
\begin_layout Subsection*
-LFUN_MATH_SUBSCRIPT
-\end_layout
-
-\begin_layout Description
-Action Enters subscript expression in math expression.
+screen-down-select
\end_layout
\begin_layout Description
-Syntax math-subscript
+Action Moves the cursor one screen in downward direction adding the current
+ position to the selection.
\end_layout
\begin_layout Description
-Origin vermeer, 12 Dec 2001
+Syntax screen-down-select
\end_layout
\begin_layout Subsection*
-LFUN_MATH_SUPERSCRIPT
-\end_layout
-
-\begin_layout Description
-Action Enters superscript expression in math expression.
+screen-recenter
\end_layout
\begin_layout Description
-Syntax math-superscript
+Action Recenters the screen on the current cursor position.
\end_layout
\begin_layout Description
-Origin vermeer, 12 Dec 2001
+Syntax screen-recenter
\end_layout
\begin_layout Subsection*
-LFUN_MATH_LIMITS
-\end_layout
-
-\begin_layout Description
-Action Toggles the position of the limits from above/below to the right
- side an vice versa in integral symbol, a limit, a summation, etc.
+screen-show-cursor
\end_layout
\begin_layout Description
-Notion Put the cursor before the symbol with the limits and then invoke
- math-limits.
+Action Repositions the screen such that the cursor is visible.
\end_layout
\begin_layout Description
-Syntax math-limits [<STATE>]
+Syntax screen-show-cursor
\end_layout
\begin_layout Description
-Params <STATE>: limits|nolimits
+Origin vfr, 25 Mar 2009
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO
+screen-up
\end_layout
\begin_layout Description
-Action Inserts a math macro definition at the cursor position in the text.
+Action Moves the cursor one page in upward direction.
\end_layout
\begin_layout Description
-Syntax math-macro <NAME> [<NARGS>] [def]
+Syntax screen-up
\end_layout
-\begin_layout Description
-Params <NAME>: The name of the macro, e.g.
- "mymacro".
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsection*
+screen-up-select
+\end_layout
-<NARGS>: The number of parameters of the macro.
- Default is 0.
- "def": Has no effect anymore, just for compatibility with former LyX versions.
+\begin_layout Description
+Action Moves the cursor one page in upward direction adding the current
+ position to the selection.
\end_layout
\begin_layout Description
-Origin ale, 10 May 1997; sts, 21 Dec 2007
+Syntax screen-up-select
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MUTATE
+script-insert
\end_layout
\begin_layout Description
-Action Mutates the type of math inset to the newly selected one.
+Action Inserts a subscript or superscript inset.
\end_layout
\begin_layout Description
-Syntax math-mutate <TYPE>
+Syntax script-insert <TYPE>
\end_layout
\begin_layout Description
-Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
- multline|gather|flalign
+Params <TYPE>: subscript|superscript
\end_layout
\begin_layout Description
-Origin Andre, 23 May 2001
+Origin Georg, 23 Nov 2010
\end_layout
\begin_layout Subsection*
-LFUN_MATH_SPACE
+scroll
\end_layout
\begin_layout Description
-Action Inserts space into math expression.
+Action Scroll the buffer view.
\end_layout
\begin_layout Description
-Notion Use spacebar after entering this space to change type of space.
+Notion Only scrolls the screen up or down; does not move the cursor.
\end_layout
\begin_layout Description
-Syntax math-space [<TYPE>] [<LEN>]
+Syntax scroll <TYPE> <QUANTITY>
\end_layout
\begin_layout Description
-Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
-\begin_inset Newline newline
-\end_inset
-
-positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
-\begin_inset Newline newline
-\end_inset
-
-custom space: hspace
-\begin_inset Newline newline
-\end_inset
-
-"," used by default.
-\begin_inset Newline newline
-\end_inset
-
-Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
- and ; = thickspace.
+Params <TYPE>: line|page
\begin_inset Newline newline
\end_inset
-<LEN>: length for custom spaces (hspace)
+<QUANTITY>: up|down|<number>
\end_layout
\begin_layout Description
-Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
+Origin Abdel, Dec 27 2007
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MATRIX
+section-select
\end_layout
\begin_layout Description
-Action Inserts a matrix.
+Action Select the whole section.
\end_layout
\begin_layout Description
-Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
+Notion The cursor should be in a section heading before calling this lfun.
\end_layout
\begin_layout Description
-Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
- c or t) (i.e.
- 1 char) and the horizontal alignments (l, c or r) (i.e.
- <COL> chars).
+Syntax section-select
\end_layout
\begin_layout Description
-Sample math-matrix 3 3 bccc
+Origin vfr, 05 May 2009
\end_layout
\begin_layout Subsection*
-LFUN_MATH_AMS_MATRIX
+selection-paste
\end_layout
\begin_layout Description
-Action Inserts a matrix.
+Action Pastes the internal selection text in permanent selection.
\end_layout
\begin_layout Description
-Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
+Notion Created in order to have middle mouse button pasting correct (bound
+ to command-alternatives selection-paste ; primary-selection-paste paragraph).
\end_layout
\begin_layout Description
-Params <DECORATION>: Decoration determines the LaTeX name of the matrix
- that should be created.
+Syntax selection-paste
\end_layout
\begin_layout Description
-Sample math-ams-matrix 3 3 bmatrix
+Origin lasgouttes, 14 Jan 2009
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MODE
-\end_layout
-
-\begin_layout Description
-Action In text mode enters math mode (i.e.
- puts math insets on the current cursor position), in math mode enters text
- mode inside math expression.
+separator-insert
\end_layout
\begin_layout Description
-Notion If there is some selected text, it puts the text inside created math
- box.
+Action Inserts an environment separator or latex paragraph break.
\end_layout
\begin_layout Description
-Syntax
math-mode [on|<ARG>]
+Syntax
separator-insert [<ARG>]
\end_layout
\begin_layout Description
-Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
- .
-\begin_inset Newline newline
-\end_inset
-
-"on": allow only entering of math mode from text mode.
+Params <ARG>: <plain|parbreak|latexpar> default: plain
\end_layout
\begin_layout Description
-Origin Alejandro, 4 Jun 1996
+Origin ef, 2 May 2014
\end_layout
\begin_layout Subsection*
-LFUN_REGEXP_MODE
-\end_layout
-
-\begin_layout Description
-Action Enters regexp mode (i.e., puts regexp insets on the current cursor
- position).
- Used by the advanced search dialog.
+set-graphics-group
\end_layout
\begin_layout Description
-Notion If there is any selected text, then it is moved inside the created
- regexp inset.
+Action Set the group for the graphics inset on the cursor position.
\end_layout
\begin_layout Description
-Syntax regexp-mode [<ARG>]
+Syntax set-graphics-group [<GROUP>]
\end_layout
\begin_layout Description
-Params <ARG>: eventual argument (regular expression).
+Params <GROUP>: Id for an existing group.
+ In case the Id is an empty string, the graphics inset is removed from the
+ current group.
\end_layout
\begin_layout Description
-Origin Tommaso, 4 Oct 2008
+Origin sanda, 6 May 2008
\end_layout
\begin_layout Subsection*
-LFUN_MATH_NUMBER_LINE_TOGGLE
+space-insert
\end_layout
\begin_layout Description
-Action Toggles numbering of the current formula line.
+Action Inserts one of horizontal space insets.
\end_layout
\begin_layout Description
-Notion Must be in display formula mode.
+Syntax space-insert <NAME> [<LEN>]
\end_layout
\begin_layout Description
-Syntax math-number-line-toggle
+Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip,
+ negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill,
+ hspace, hspace*
+\begin_inset Newline newline
+\end_inset
+
+Only in math mode: med and thick.
+\begin_inset Newline newline
+\end_inset
+
+<LEN>: length for custom spaces (hspace, hspace* for protected)
\end_layout
\begin_layout Description
-Origin Alejandro, 18 Jun 1996
+Origin JSpitzm, 20 May 2003, Mar 17 2008
\end_layout
\begin_layout Subsection*
-LFUN_MATH_NUMBER_TOGGLE
+specialchar-insert
\end_layout
\begin_layout Description
-Action Toggles numbering/labeling of the current formula.
+Action Inserts various characters into the document.
\end_layout
\begin_layout Description
-Notion Must be in display formula mode.
+Syntax specialchar-insert <CHAR>
\end_layout
\begin_layout Description
-Syntax math-number-toggle
+Params <CHAR>: hyphenation, allowbreak, ligature-break, slash,
+ nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex,
+ latex, latex2e.
\end_layout
\begin_layout Description
-Origin Alejandro, 4 Jun 1996
+Origin JSpitzm, 6 Dec 2007
\end_layout
\begin_layout Subsection*
-LFUN_MATH_EXTERN
+spelling-add
\end_layout
\begin_layout Description
-Action Calls external program and passes the current expression/equation
- as an argument for the calculation in the format appropriate to the given
- language.
+Action Add the word under the cursor to the respective spell checker dictionary.
+ The default for the language is retrieved from the cursor position.
\end_layout
\begin_layout Description
-Notion Selection can be used to determine the input for the external program.
+Syntax spelling-add [<STRING>] [<LANG>]
\end_layout
\begin_layout Description
-Syntax math-extern <LANG> [<COMMAND>]
+Params <WORD>: word to add <LANG>: language name (see file languages)
\end_layout
\begin_layout Description
-Params <LANG>: octave|maxima|maple|mathematica|script
-\begin_inset Newline newline
-\end_inset
+Origin JSpitzm, 18 Jan 2010
+\end_layout
-where "script" stands fot the external script (normalized expression will
- be passed)
+\begin_layout Subsection*
+spelling-continuously
\end_layout
\begin_layout Description
-Sample math-extern maple simplify
+Action Toggle continuous spell checking.
\end_layout
\begin_layout Description
-Origin Andre, 24 Apr 2001
+Syntax spelling-continuously
\end_layout
-\begin_layout Subsection*
-LFUN_MATH_SIZE
+\begin_layout Description
+Origin vfr, 24 March 2013
\end_layout
-\begin_layout Description
-Action Changes arbitrarily the size used by math fonts inside a context.
+\begin_layout Subsection*
+spelling-ignore
\end_layout
\begin_layout Description
-Notion Provides an interface to the LaTeX math mode font size commands.
+Action Let the spell checker ignore the word under the cursor in the current
+ session for the given language.
+ The default for the language is retrieved from the cursor position.
\end_layout
\begin_layout Description
-Syntax math-size <STYLE>
+Syntax spelling-ignore [<WORD>] [<LANG>]
\end_layout
\begin_layout Description
-Params <STYLE>:
-\backslash
-displaystyle|
-\backslash
-textstyle|
-\backslash
-scriptstyle|
-\backslash
-scriptscriptstyle
+Params <WORD>: word to ignore <LANG>: language name (see file languages)
\end_layout
\begin_layout Description
-Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
+Origin JSpitzm, 18 Jan 2010
\end_layout
\begin_layout Subsection*
-LFUN_MATH_FONT_STYLE
+spelling-remove
\end_layout
\begin_layout Description
-Action Changes the text style used in math.
+Action Remove the word under the cursor from the respective spell checker
+ dictionary.
+ The default for the language is retrieved from the cursor position.
\end_layout
\begin_layout Description
-Syntax math-font-style <STYLE>
+Syntax spelling-remove [<STRING>] [<LANG>]
\end_layout
\begin_layout Description
-Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
-\begin_inset Newline newline
-\end_inset
-
-|textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
+Params <WORD>: word to remove <LANG>: language name (see file languages)
\end_layout
\begin_layout Description
-Origin vfr, 9 jan 2009
+Origin SWitt, 28 July 2010
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_UNFOLD
+tab-delete
\end_layout
\begin_layout Description
-Action Unfold a Math Macro.
+Action Delete a tab or up to an equivalent amount of spaces from a listings
+ inset.
\end_layout
\begin_layout Description
-Notion Unfold the Math Macro the cursor is in, i.e.
- display it as
-\backslash
-foo.
+Notion It also works on a selection - it removes a tab or spaces from the
+ beginning of each line spanned by the selection.
+ This is useful if you want to indent/unindent multiple lines in one action.
\end_layout
\begin_layout Description
-Syntax math-macro-unfold
+Syntax tab-delete
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin vfr, Sep 30 2008
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_FOLD
+tab-insert
\end_layout
\begin_layout Description
-Action Fold a Math Macro.
+Action Insert a tab into a listings inset.
\end_layout
\begin_layout Description
-Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
- displayed as
-\backslash
-foo before.
+Notion It also works on a selection.
\end_layout
\begin_layout Description
-Syntax math-macro-fold
+Syntax tab-insert
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin vfr, Sep 30 2008
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_ADD_PARAM
+tabular-feature
\end_layout
\begin_layout Description
-Action Add a parameter.
+Action Modify properties of tabulars and table-like math environments.
\end_layout
\begin_layout Description
-Notion Add a parameter to a Math Macro.
+Syntax tabular-feature <FEATURE> [<ARG>]
\end_layout
\begin_layout Description
-Syntax math-macro-add-param <NUM>
-\end_layout
+Params Generally see LFUN_INSET_INSERT for further details.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Params <NUM>: The number of the parameter behind which the new one will
- be added (1 for the first, i.e.
- use 0 for add a parameter at the left), defaults to the last one.
+<FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
+\begin_inset Newline newline
+\end_inset
+
+copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
+\begin_inset Newline newline
+\end_inset
+
+toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
+\begin_inset Newline newline
+\end_inset
+
+align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
+\begin_inset Newline newline
+\end_inset
+
+valign-top|valign-bottom|valign-middle|longtabular-align-left|
+\begin_inset Newline newline
+\end_inset
+
+longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
+\begin_inset Newline newline
+\end_inset
+
+m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
+\begin_inset Newline newline
+\end_inset
+
+set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabul
+ar|set-pwidth|
+\begin_inset Newline newline
+\end_inset
+
+set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
+\begin_inset Newline newline
+\end_inset
+
+set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
+\begin_inset Newline newline
+\end_inset
+
+unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
+\begin_inset Newline newline
+\end_inset
+
+set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
+\begin_inset Newline newline
+\end_inset
+
+set-special-column|set-special-multicolumn|set-special-multirow|
+\begin_inset Newline newline
+\end_inset
+
+toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
+\begin_inset Newline newline
+\end_inset
+
+set-interline-space|set-border-lines|tabular-valign-top|
+\begin_inset Newline newline
+\end_inset
+
+tabular-valign-middle|tabular-valign-bottom|set-tabular-width
+\begin_inset Newline newline
+\end_inset
+
+Various math-environment features are handled as well, e.g.
+ add-vline-left/right for
+\begin_inset Newline newline
+\end_inset
+
+the Grid/Array environment.
+\begin_inset Newline newline
+\end_inset
+
+<ARG>: additional argument for some commands, use debug mode to explore
+ its values.
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin gm, 10 Dec 2015
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_REMOVE_PARAM
+tabular-insert
\end_layout
\begin_layout Description
-Action Remove the last parameter.
+Action Inserts table into the document.
\end_layout
\begin_layout Description
-Notion Remove the last parameter of a Math Macro and remove its value in
- all instances of the macro in the buffer.
+Notion See LFUN_TABULAR_FEATURE for some more details about tabular modification
+s.
\end_layout
\begin_layout Description
-Syntax math-macro-remove-param <NUM>
+Syntax tabular-insert [<ROWS> <COLUMNS>]
\end_layout
\begin_layout Description
-Params <NUM>: The number of the parameter to be deleted (1 for the first),
- defaults to the last one.
+Params In case no arguments are given show insert dialog.
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin Jug, 12 Apr 2000
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
+thesaurus-entry
\end_layout
\begin_layout Description
-Action Append a greedy parameter.
+Action Look up thesaurus entries with respect to the word under the cursor.
\end_layout
\begin_layout Description
-Notion Append a greedy parameter to a Math Macro which eats the following
- mathed cell in every instance of the macro in the buffer.
+Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
\end_layout
\begin_layout Description
-Syntax math-macro-append-greedy-param
+Params <STRING>: word to look up <LANG>: language (see file languages)
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin Levon, 20 Jul 2001
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
+undo
\end_layout
\begin_layout Description
-Action Remove a greedy parameter.
+Action Undoes the last edit.
\end_layout
\begin_layout Description
-Notion Remove a greedy parameter of a Math Macro and spit out the values
- of it in every instance of the macro in the buffer.
- If it is an optional parameter the [valud] format is used.
+Syntax undo
+\end_layout
+
+\begin_layout Subsection*
+unicode-insert
\end_layout
\begin_layout Description
-Syntax math-macro-remove-greedy-param
+Action Inserts a single unicode character.
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Syntax unicode-insert <CHAR>
\end_layout
-\begin_layout Subsection*
-LFUN_MATH_MACRO_MAKE_OPTIONAL
+\begin_layout Description
+Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
\end_layout
\begin_layout Description
-Action Make a parameter optional.
+Sample unicode-insert 0x0100
\end_layout
\begin_layout Description
-Notion Turn the first non-optional parameter of a Math Macro into an optional
- parameter with a default value.
+Origin Lgb, 22 Oct 2006
+\end_layout
+
+\begin_layout Subsection*
+up
\end_layout
\begin_layout Description
-Syntax math-macro-make-optional
+Action Moves the cursor one line in upward direction.
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Syntax up
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_MAKE_NONOPTIONAL
+up-select
\end_layout
\begin_layout Description
-Action Make a parameter non-optional.
+Action Moves the cursor one line in upward direction adding the current
+ position to the selection.
\end_layout
\begin_layout Description
-Notion Turn the last optional parameter of a Math Macro into a non-optional
- parameter.
- The default value is remembered to be reused later if the user changes
- his mind.
+Syntax up-select
\end_layout
-\begin_layout Description
-Syntax math-macro-make-nonoptional
+\begin_layout Subsection*
+word-backward
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Action Moves the cursor to the logically previous beginning of a word.
\end_layout
-\begin_layout Subsection*
-LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
+\begin_layout Description
+Notion This is not the action which should be bound to the arrow keys, because
+ backwards may be left or right, depending on the language.
+ The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
+ which in turn may employ this one.
\end_layout
\begin_layout Description
-Action Add an optional parameter.
+Syntax word-backward
+\end_layout
+
+\begin_layout Subsection*
+word-backward-select
\end_layout
\begin_layout Description
-Notion Insert an optional parameter just behind the already existing optional
- parameters.
+Action Moves the cursor to the logically previous beginning of a word, adding
+ the logically traversed text to the selection.
\end_layout
\begin_layout Description
-Syntax math-macro-add-optional-param
+Notion See also LFUN_WORD_BACKWARD.
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Syntax word-backward-select
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
+word-capitalize
\end_layout
\begin_layout Description
-Action Remove the last optional parameter.
+Action Capitalizes the words in the selection (i.e.
+ the first letters) or the first letter of word at cursor position.
\end_layout
\begin_layout Description
-Notion Remove the last optional parameter of a Math Macro and remove it
- in all the instances of the macro in the buffer.
+Syntax word-capitalize [<SEL_TYPE>]
\end_layout
\begin_layout Description
-Syntax math-macro-remove-optional-param
+Params <SEL_TYPE>: if this is equal to "partial", then the default word
+ starts at cursor position (emacs-style).
+ Otherwise, the whole word is considered.
+\end_layout
+
+\begin_layout Subsection*
+word-delete-backward
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Action Deletes characters to the beginning of the word (usually the "C+BackSpace
+" key).
\end_layout
-\begin_layout Subsection*
-LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
+\begin_layout Description
+Syntax word-delete-backward [force]
\end_layout
\begin_layout Description
-Action Add a greedy optional parameter.
+Params force: Delete big insets, do not only select them.
+\end_layout
+
+\begin_layout Subsection*
+word-delete-forward
\end_layout
\begin_layout Description
-Notion Add a greedy optional parameter which eats the value from the following
- cells in mathed which are in the [value] format.
+Action Deletes characters to the end of the word (usually the "C+Delete"
+ key).
\end_layout
\begin_layout Description
-Syntax math-macro-add-greedy-optional-param
+Syntax word-delete-forward [force]
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Params force: Delete big insets, do not only select them.
\end_layout
\begin_layout Subsection*
-LFUN_IN_MATHMACROTEMPLATE
+word-find
\end_layout
\begin_layout Description
-Action Only active in Math Macro definition.
+Action Search for next occurrence of a string.
\end_layout
\begin_layout Description
-Notion Dummy function which is only active in a Math Macro definition.
- It's used to toggle the Math Macro toolbar if the cursor moves into a Math
- Macro definition.
+Syntax word-find [<DATA>]
\end_layout
\begin_layout Description
-Syntax in-mathmacrotemplate
+Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
+ If no parameter is given, search with last find-dialog data is used for
+ search (i.e.
+ find-next).
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin Andre, Jan 7 2004
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_MOVE_DOWN
+word-find-backward
\end_layout
\begin_layout Description
-Action Moves the current paragraph downwards in the document.
+Action Search for a given string in backward direction.
\end_layout
\begin_layout Description
-Syntax paragraph-move-down
+Notion Case sensitive, match words.
+ If no argument given, last search repeated.
\end_layout
\begin_layout Description
-Origin Edwin, 8 Apr 2006
+Syntax word-find-backward [<STRING>]
+\end_layout
+
+\begin_layout Description
+Origin Etienne, 20 Feb 1998
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_MOVE_UP
+word-find-forward
+\end_layout
+
+\begin_layout Description
+Action Search for a given string in forward direction.
\end_layout
\begin_layout Description
-Action Moves the current paragraph upwards in the document.
+Notion Case sensitive, match words.
+ If no argument given, last search repeated.
\end_layout
\begin_layout Description
-Syntax paragraph-move-up
+Syntax word-find-forward [<STRING>]
\end_layout
\begin_layout Description
-Origin Edwin, 8 Apr 2006
+Origin Etienne, 16 Feb 1998
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_UP
+word-findadv
\end_layout
\begin_layout Description
-Action Move the cursor to the next paragraph (or begining of the current
- one) in upward direction.
+Action Search for next occurrence of a pattern.
\end_layout
\begin_layout Description
-Syntax paragraph-up
+Syntax word-findadv [<DATA>]
\end_layout
\begin_layout Description
-Origin Asger, 1 Oct 1996
+Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
+ If no parameter is given, search with last find-dialog data is used for
+ search (i.e.
+ find-next).
+\end_layout
+
+\begin_layout Description
+Origin Tommaso, Nov 15 2007
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_UP_SELECT
+word-forward
\end_layout
\begin_layout Description
-Action Move the cursor and select the text to the next paragraph (or begining
- of the current one) in upward direction.
+Action Moves the cursor to the logically next beginning of a word.
\end_layout
\begin_layout Description
-Syntax paragraph-up-select
+Notion This is not the action which should be bound to the arrow keys, because
+ forward may be left or right, depending on the language.
+ The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
+ which in turn may employ this one.
\end_layout
\begin_layout Description
-Origin Asger, 1 Oct 1996
+Syntax word-forward
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_DOWN
+word-forward-select
\end_layout
\begin_layout Description
-Action Move the cursor to the next paragraph (or begining of the current
- one) in downward direction.
+Action Moves the cursor to the logically next beginning of a word, adding
+ the logically traversed text to the selection.
\end_layout
\begin_layout Description
-Syntax paragraph-down
+Notion See also LFUN_WORD_FORWARD.
\end_layout
\begin_layout Description
-Origin Asger, 1 Oct 1996
+Syntax word-forward-select
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_DOWN_SELECT
+word-left
\end_layout
\begin_layout Description
-Action Move the cursor and select the text to the next paragraph (or begining
- of the current one) in downward direction.
+Action Moves the cursor to the next beginning of a word "on the left".
\end_layout
\begin_layout Description
-Syntax paragraph-down-select
+Notion This is the action which should be taken when the (e.g., ctrl-) "left"
+ key is pressed.
+ Generally, it moves the cursor to the next beginning of a word on the left.
+ However, in Bidi text this become slightly more complicated, and there
+ are different modes of cursor movement.
+ In "visual mode", this moves left, plain and simple.
+ In "logical mode", movement is logically forward in RTL paragraphs, and
+ logically backwards in LTR paragraphs.
\end_layout
\begin_layout Description
-Origin Asger, 1 Oct 1996
+Syntax word-left
\end_layout
-\begin_layout Subsection*
-LFUN_PARAGRAPH_GOTO
+\begin_layout Description
+Origin dov, 28 Oct 2007
\end_layout
-\begin_layout Description
-Action Jump to a paragraph given by its id number and optionally the desired
- position within the paragraph.
+\begin_layout Subsection*
+word-left-select
\end_layout
\begin_layout Description
-Notion Note that id number of paragraph is not the sequential number of
- paragraph seen on the screen.
- Moreover the id is unique for all opened buffers (documents).
+Action Moves the cursor to the next beginning of a word "on the left", adding
+ *logically* traversed text to the selection.
\end_layout
\begin_layout Description
-Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
+Notion See also LFUN_WORD_LEFT for exact details of the movement.
\end_layout
\begin_layout Description
-Params <PAR_ID_NUMBER>: paragraph id
-\begin_inset Newline newline
-\end_inset
-
-<POSITION_IN_PAR>: desired position within the paragraph
+Syntax word-left-select
\end_layout
\begin_layout Description
-Origin Dekel, 26 Aug 2000
+Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
-LFUN_BREAK_PARAGRAPH
-\end_layout
-
-\begin_layout Description
-Action Breaks the current paragraph at the current location.
+word-lowcase
\end_layout
\begin_layout Description
-Notion Removes the selection.
+Action Change the words in the selection or word at cursor position to lower
+ case.
\end_layout
\begin_layout Description
-Syntax break-paragraph [<LAYOUT>]
+Syntax word-lowcase [<SEL_TYPE>]
\end_layout
\begin_layout Description
-Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
- default layout) when the cursor is at the end of the line.
+Params <SEL_TYPE>: if this is equal to "partial", then the default word
+ starts at cursor position (emacs-style).
+ Otherwise, the whole word is considered.
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_PARAMS
-\end_layout
-
-\begin_layout Description
-Action Change paragraph settings.
+word-replace
\end_layout
\begin_layout Description
-Notion Modifies the current paragraph, or currently selected paragraphs.
- This function only modifies, and does not override, existing settings.
- Note that the "leftindent" indent setting is deprecated.
+Action Replace a string in the document.
\end_layout
\begin_layout Description
-Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
+Syntax word-replace [<DATA>]
\end_layout
\begin_layout Description
-Params <INDENT>:
-\backslash
-noindent|
-\backslash
-indent|
-\backslash
-indent-toggle|
-\backslash
-leftindent LENGTH
-\begin_inset Newline newline
-\end_inset
-
-<SPACING>:
-\backslash
-paragraph_spacing default|single|onehalf|double|other SIZE
+Params <DATA>: data is of the form "<replace>
\begin_inset Newline newline
\end_inset
-<ALIGN>:
-\backslash
-align block|left|right|center|default
+<search>
\begin_inset Newline newline
\end_inset
-<OTHERS>:
-\backslash
-labelwidthstring WIDTH|
-\backslash
-start_of_appendix
+<casesensitive> <matchword> <all> <forward> <findnext>"
\end_layout
\begin_layout Description
-Origin rgh, Aug 15 2007
+Origin Andre, Jan 7 2004
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_PARAMS_APPLY
+word-right
\end_layout
\begin_layout Description
-Action Change paragraph settings.
-\end_layout
-
-\begin_layout Description
-Notion Overwrite all nonspecified settings to the default ones.
- Use paragraph-params lfun if you don't want to overwrite others settings.
+Action Moves the cursor to the next beginning of a word "on the right".
\end_layout
\begin_layout Description
-Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
+Notion This is the action which should be taken when the (e.g., ctrl-) "right"
+ key is pressed.
+ Generally, it moves the cursor to the next beginning of a word on the right.
+ However, in Bidi text this become slightly more complicated, and there
+ are different modes of cursor movement.
+ In "visual mode", this moves right, plain and simple.
+ In "logical mode", movement is logically forward in LTR paragraphs, and
+ logically backwards in RTL paragraphs.
\end_layout
\begin_layout Description
-Params For parameters see LFUN_PARAGRAPH_PARAMS
+Syntax word-right
\end_layout
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_UPDATE
+word-right-select
\end_layout
\begin_layout Description
-Action Updates the values inside the paragraph dialog from the paragraph.
+Action Moves the cursor to the next beginning of a word "on the right",
+ adding *logically* traversed text to the selection.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
- Called internally by LFUN_DIALOG_UPDATE.
+Notion See also LFUN_WORD_RIGHT for exact details of the movement.
\end_layout
\begin_layout Description
-Origin leeming, 13 Mar 2003
+Syntax word-right-select
\end_layout
-\begin_layout Subsection*
-LFUN_OUTLINE_UP
+\begin_layout Description
+Origin dov, 28 Oct 2007
\end_layout
-\begin_layout Description
-Action Move the current group in the upward direction in the structure of
- the document.
+\begin_layout Subsection*
+word-select
\end_layout
\begin_layout Description
-Notion The "group" can be Part/Chapter/Section/etc.
- It moves the whole substructure of the group.
+Action Puts the word where the cursor stands into the selection.
\end_layout
\begin_layout Description
-Syntax outline-up
+Syntax word-select
\end_layout
\begin_layout Description
-Origin Vermeer, 23 Mar 2006
+Origin Andre, 11 Sep 2002
\end_layout
\begin_layout Subsection*
-LFUN_OUTLINE_DOWN
-\end_layout
-
-\begin_layout Description
-Action Move the current group in the downward direction in the structure
- of the document.
+word-upcase
\end_layout
\begin_layout Description
-Notion The "group" can be Part/Chapter/Section/etc.
- It moves the whole substructure of the group.
+Action Change the words in the selection or word at cursor position to upper
+ case.
\end_layout
\begin_layout Description
-Syntax outline-down
+Syntax word-upcase [<SEL_TYPE>]
\end_layout
\begin_layout Description
-Origin Vermeer, 23 Mar 2006
+Params <SEL_TYPE>: if this is equal to "partial", then the default word
+ starts at cursor position (emacs-style).
+ Otherwise, the whole word is considered.
\end_layout
\begin_layout Subsection*
-LFUN_OUTLINE_IN
+wrap-insert
\end_layout
\begin_layout Description
-Action Moves the current group in the downward direction in the hierarchy
- of the document structure.
+Action Inserts floats wrapped by the text around.
\end_layout
\begin_layout Description
-Notion Part -> Chapter -> Section -> etc.
+Syntax wrap-insert <TYPE>
\end_layout
\begin_layout Description
-Syntax outline-in
+Params <TYPE>: table|figure
\end_layout
\begin_layout Description
-Origin Vermeer, 23 Mar 2006
+Origin Dekel, 7 Apr 2002
+\end_layout
+
+\begin_layout Section
+Math Editor Functions
\end_layout
\begin_layout Subsection*
-LFUN_OUTLINE_OUT
+in-mathmacrotemplate
\end_layout
\begin_layout Description
-Action Moves the current group in the upward direction in the hierarchy
- of the document structure.
+Action Only active in Math Macro definition.
\end_layout
\begin_layout Description
-Notion Part <- Chapter <- Section <- etc.
+Notion Dummy function which is only active in a Math Macro definition.
+ It's used to toggle the Math Macro toolbar if the cursor moves into a Math
+ Macro definition.
\end_layout
\begin_layout Description
-Syntax outline-out
+Syntax in-mathmacrotemplate
\end_layout
\begin_layout Description
-Origin Vermeer, 23 Mar 2006
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_INSET_EDIT
+math-ams-matrix
\end_layout
\begin_layout Description
-Action Edit the inset at cursor with an external application, if one is
- attributed.
+Action Inserts an extended matrix as provided by the amsmath package.
\end_layout
\begin_layout Description
-Syntax inset-edit [<INSET_PARAMS>]
+Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
\end_layout
\begin_layout Description
-Params <INSET_PARAMS>: Parameters for the inset.
-\begin_inset Newline newline
-\end_inset
-
-Currently only the filename will be considered.
+Params <DECORATION>: Decoration determines the LaTeX name of the matrix
+ that should be created.
+ Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
+ matrix.
+ The default is 'matrix'.
\end_layout
\begin_layout Description
-Origin JSpitzm, 27 Apr 2006
+Sample math-ams-matrix 3 3 bmatrix
\end_layout
\begin_layout Subsection*
-LFUN_TABULAR_INSERT
+math-bigdelim
\end_layout
\begin_layout Description
-Action Inserts table into the document.
+Action Inserts math fixed size delimiters (e.g.
+ parentheses, brackets) enclosing expression.
\end_layout
\begin_layout Description
-Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
+Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
\end_layout
\begin_layout Description
-Syntax tabular-insert [<ROWS> <COLUMNS>]
+Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
+\begin_inset Newline newline
+\end_inset
+
+<L/RDELIM>: TeX code for delimiter.
+ See Delimiter dialog for delimiters to be used.
\end_layout
\begin_layout Description
-Params In case no arguments are given show insert dialog.
+Sample math-bigdelim "Bigl" "
+\backslash
+Downarrow" "Bigr" "
+\backslash
+}"
\end_layout
\begin_layout Description
-Origin Jug, 12 Apr 2000
+Origin Enrico & Georg, 7 May 2006
\end_layout
\begin_layout Subsection*
-LFUN_CELL_BACKWARD
+math-delim
\end_layout
\begin_layout Description
-Action Moves the cursor to the previous cell inside the table.
+Action Inserts math delimiters (e.g.
+ parentheses, brackets) enclosing expression.
\end_layout
\begin_layout Description
-Syntax cell-backward
+Syntax math-delim [<LEFT>] [<RIGHT>]
\end_layout
\begin_layout Description
-Origin Jug, 22 May 2000
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CELL_FORWARD
+Params <LEFT/RIGHT>: Delimiters to be used.
+ Each delimiter can be specified by either a LaTeX name or a valid character.
+ ( is the default letter.
\end_layout
\begin_layout Description
-Action Moves the cursor to the next cell inside the table.
+Sample math-delim { rangle
\end_layout
\begin_layout Description
-Syntax cell-forward
+Origin Alejandro, 18 Jun 1996
\end_layout
\begin_layout Subsection*
-LFUN_CELL_SPLIT
+math-display
\end_layout
\begin_layout Description
-Action Splits cell and shifts right part to the next cell (inside the math
- grid).
+Action Creates a new displayed equation in text mode.
+ Toggles inlined/display formula in math mode.
\end_layout
\begin_layout Description
-Syntax cell-split
+Syntax math-display [<ARG>]
\end_layout
\begin_layout Description
-Origin Ale, 15 May 1997
+Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
+ new equation from the text mode.
+\end_layout
+
+\begin_layout Description
+Origin Alejandro, 18 Jun 1996
\end_layout
\begin_layout Subsection*
-LFUN_VC_REGISTER
+math-extern
\end_layout
\begin_layout Description
-Action Register the document as an file inside version control system.
+Action Calls external program and passes the current expression/equation
+ as an argument for the calculation in the format appropriate to the given
+ language.
\end_layout
\begin_layout Description
-Notion File is registered inside cvs, svn or rcs repository acording to
- the existence of cvs/svn/rcs entries in the document's directory.
+Notion Selection can be used to determine the input for the external program.
+\end_layout
+
+\begin_layout Description
+Syntax math-extern <LANG> [<COMMAND>]
+\end_layout
+
+\begin_layout Description
+Params <LANG>: octave|maxima|maple|mathematica|script
\begin_inset Newline newline
\end_inset
-See LyX Additional Features Manual (Version Control Chapter) for additional
- information.
+where "script" stands for the external script (normalized expression will
+ be passed)
\end_layout
\begin_layout Description
-Syntax vc-register
+Sample math-extern maple simplify
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
+Origin Andre, 24 Apr 2001
\end_layout
\begin_layout Subsection*
-LFUN_VC_CHECK_IN
+math-font-style
\end_layout
\begin_layout Description
-Action Checks-in/commits the changes of the registered file to the repository.
-\end_layout
-
-\begin_layout Description
-Notion In RCS case this also unlocks the file.
+Action Changes the text style used in math.
\end_layout
\begin_layout Description
-Syntax vc-check-in
+Syntax math-font-style <STYLE>
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
-\end_layout
+Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_VC_CHECK_OUT
+|textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
\end_layout
\begin_layout Description
-Action Checks-out the document for edit (and locks it in some cases).
+Origin vfr, 9 jan 2009
\end_layout
-\begin_layout Description
-Syntax vc-check-out
+\begin_layout Subsection*
+math-insert
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
-\end_layout
-
-\begin_layout Subsection*
-LFUN_VC_REVERT
+Action Inserts math objects and symbols.
\end_layout
\begin_layout Description
-Action Reverts the document to the last check-in/commit in VCS.
+Notion When <ARG> is a _single_ math inset with more than one cell (such
+ as "x_y^z" or "
+\backslash
+frac{x}{y}"), the content of cell(0) is replaced by the current selection
+ (only works if the selection is in mathed).
+ As an example, if "abc" is selected in mathed, "math-insert
+\backslash
+frac{x}{y}" replaces "abc" with "
+\backslash
+frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
+ If nothing is selected (or the selection is not in mathed), math-insert
+ works as expected.
\end_layout
\begin_layout Description
-Syntax vc-revert
+Syntax math-insert <ARG>
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
+Params <ARG>: Symbol or LaTeX code to be inserted.
\end_layout
\begin_layout Subsection*
-LFUN_VC_UNDO_LAST
+math-limits
\end_layout
\begin_layout Description
-Action Undo last check-in.
+Action Toggles the position of the limits from above/below to the right
+ side an vice versa in integral symbol, a limit, a summation, etc.
\end_layout
\begin_layout Description
-Notion This is currently implemented only for RCS.
+Notion Put the cursor before the symbol with the limits and then invoke
+ math-limits.
\end_layout
\begin_layout Description
-Syntax vc-check-out
+Syntax math-limits [<STATE>]
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
+Params <STATE>: limits|nolimits
\end_layout
\begin_layout Subsection*
-LFUN_VC_COMMAND
+math-macro
\end_layout
\begin_layout Description
-Action Executes external command.
- This command is intended to support additional VCS commands.
+Action Inserts a math macro definition at the cursor position in the text.
\end_layout
\begin_layout Description
-Syntax vc-command <FLAG> <PATH> <COMMAND>
+Syntax math-macro <NAME> [<NARGS>] [def]
\end_layout
\begin_layout Description
-Params <FLAG>: Flags for the command can be combined together.
-\begin_inset Newline newline
-\end_inset
-
-U - dUmmy - no flags
-\begin_inset Newline newline
-\end_inset
-
-D - Doc - need document loaded to proceed
-\begin_inset Newline newline
-\end_inset
-
-I - dIrty - mark document dirty
-\begin_inset Newline newline
-\end_inset
-
-R - Reload - ensure that the document is saved and reload it after command
- execution
-\begin_inset Newline newline
-\end_inset
-
-M - Message - ask for input string (commit message)
-\begin_inset Newline newline
-\end_inset
-
-<PATH>: path where to start.
- $$p will be replaced by the current document path.
+Params <NAME>: The name of the macro, e.g.
+ "mymacro".
\begin_inset Newline newline
\end_inset
-<COMMAND>: command to execute.
- $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
-essage.
-\end_layout
-
-\begin_layout Description
-Sample vc-command DR $$p "svn up"
+<NARGS>: The number of parameters of the macro.
+ Default is 0.
+ "def": Has no effect anymore, just for compatibility with former LyX versions.
\end_layout
\begin_layout Description
-Origin sanda, 13 Jan 2009
+Origin ale, 10 May 1997; sts, 21 Dec 2007
\end_layout
\begin_layout Subsection*
-LFUN_VC_LOCKING_TOGGLE
+math-macro-add-greedy-optional-param
\end_layout
\begin_layout Description
-Action Toggles the locking property of the edited file.
+Action Add a greedy optional parameter.
\end_layout
\begin_layout Description
-Notion This is currently implemented only for SVN.
+Notion Add a greedy optional parameter which eats the value from the following
+ cells in mathed which are in the [value] format.
\end_layout
\begin_layout Description
-Syntax vc-locking-toggle
+Syntax math-macro-add-greedy-optional-param
\end_layout
\begin_layout Description
-Origin sanda, 25 Jun 2009
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_VC_REPO_UPDATE
+math-macro-add-optional-param
\end_layout
\begin_layout Description
-Action Update the local archive directory in which resides the current document
- with the remote repository.
+Action Add an optional parameter.
\end_layout
\begin_layout Description
-Syntax vc-repo-update
+Notion Insert an optional parameter just behind the already existing optional
+ parameters.
\end_layout
\begin_layout Description
-Origin sanda, 16 Oct 2009
+Syntax math-macro-add-optional-param
+\end_layout
+
+\begin_layout Description
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_VC_COMPARE
+math-macro-add-param
\end_layout
\begin_layout Description
-Action Compares two revisions of the same file under version control.
+Action Add a parameter.
\end_layout
\begin_layout Description
-Syntax vc-compare [<REV1>] [<REV2>]
+Notion Add a parameter to a Math Macro.
\end_layout
\begin_layout Description
-Params Revision number either points directly to commit in history or if
- negative number -x it points to (last commit - x).
-\begin_inset Newline newline
-\end_inset
-
- In RCS we subtract only in the last number of revision specification.
- Special case "0" is reserved for the last committed revision.
-\begin_inset Newline newline
-\end_inset
-
-<REV1>: Older file.
-\begin_inset Newline newline
-\end_inset
-
- <REV2>: Newer file.
- Used only if REV1 > 0.
-\begin_inset Newline newline
-\end_inset
-
-If no parameter is given, interactive dialog will be shown.
+Syntax math-macro-add-param <NUM>
\end_layout
\begin_layout Description
-Sample Compare current document against last commit
-\begin_inset Newline newline
-\end_inset
-
- vc-compare 0
-\begin_inset Newline newline
-\end_inset
-
-Compare current document against current revision - 5 commits
-\begin_inset Newline newline
-\end_inset
-
- vc-compare -5
-\begin_inset Newline newline
-\end_inset
-
-Compare revisions 120 and 155
-\begin_inset Newline newline
-\end_inset
-
- vc-compare 120 155
+Params <NUM>: The number of the parameter behind which the new one will
+ be added (1 for the first, i.e.
+ use 0 for add a parameter at the left), defaults to the last one.
\end_layout
\begin_layout Description
-Origin sanda, 12 Feb 2010
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_CHANGES_TRACK
+math-macro-append-greedy-param
\end_layout
\begin_layout Description
-Action Toggles change tracking to on/off.
+Action Append a greedy parameter.
\end_layout
\begin_layout Description
-Syntax changes-track
+Notion Append a greedy parameter to a Math Macro which eats the following
+ mathed cell in every instance of the macro in the buffer.
\end_layout
\begin_layout Description
-Origin levon, 1 Oct 2002
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CHANGES_OUTPUT
+Syntax math-macro-append-greedy-param
\end_layout
\begin_layout Description
-Action Toggles showing of change tracking in typesetted output.
+Origin sts, 06 January 2008
\end_layout
-\begin_layout Description
-Syntax changes-output
+\begin_layout Subsection*
+math-macro-fold
\end_layout
\begin_layout Description
-Origin jspitzm, 21 Jan 2005
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CHANGE_NEXT
+Action Fold a Math Macro.
\end_layout
\begin_layout Description
-Action Moves the cursor to the position of the next change of the change
- tracking records.
+Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
+ displayed as
+\backslash
+foo before.
\end_layout
\begin_layout Description
-Syntax change-next
+Syntax math-macro-fold
\end_layout
\begin_layout Description
-Origin schmitt, 4 Oct 2006
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_CHANGE_PREVIOUS
+math-macro-make-nonoptional
\end_layout
\begin_layout Description
-Action Moves the cursor to the position of the previous change of the change
- tracking records.
+Action Make a parameter non-optional.
\end_layout
\begin_layout Description
-Syntax change-previous
+Notion Turn the last optional parameter of a Math Macro into a non-optional
+ parameter.
+ The default value is remembered to be reused later if the user changes
+ his mind.
\end_layout
\begin_layout Description
-Origin vfr, 4 Apr 2009
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CHANGES_MERGE
+Syntax math-macro-make-nonoptional
\end_layout
\begin_layout Description
-Action Open change tracking dialog for merging and moves the cursor to the
- position of the next change.
+Origin sts, 06 January 2008
\end_layout
-\begin_layout Description
-Syntax changes-merge
+\begin_layout Subsection*
+math-macro-make-optional
\end_layout
\begin_layout Description
-Origin Levon, 16 Oct 2002
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CHANGE_ACCEPT
+Action Make a parameter optional.
\end_layout
\begin_layout Description
-Action Accepts tracked change inside the selection.
+Notion Turn the first non-optional parameter of a Math Macro into an optional
+ parameter with a default value.
\end_layout
\begin_layout Description
-Syntax change-accept
+Syntax math-macro-make-optional
\end_layout
\begin_layout Description
-Origin Levon, 16 Oct 2002
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_CHANGE_REJECT
+math-macro-remove-greedy-param
\end_layout
\begin_layout Description
-Action Rejects tracked change inside the selection.
+Action Remove a greedy parameter.
\end_layout
\begin_layout Description
-Syntax change-reject
+Notion Remove a greedy parameter of a Math Macro and spit out the values
+ of it in every instance of the macro in the buffer.
+ If it is an optional parameter the [valud] format is used.
\end_layout
\begin_layout Description
-Origin Levon, 16 Oct 2002
+Syntax math-macro-remove-greedy-param
+\end_layout
+
+\begin_layout Description
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_ALL_CHANGES_ACCEPT
+math-macro-remove-optional-param
\end_layout
\begin_layout Description
-Action Accepts all tracked changes in the document.
+Action Remove the last optional parameter.
+\end_layout
+
+\begin_layout Description
+Notion Remove the last optional parameter of a Math Macro and remove it
+ in all the instances of the macro in the buffer.
\end_layout
\begin_layout Description
-Syntax all-changes-accept
+Syntax math-macro-remove-optional-param
\end_layout
\begin_layout Description
-Origin Levon, 16 Oct 2002
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_ALL_CHANGES_REJECT
+math-macro-remove-param
\end_layout
\begin_layout Description
-Action Rejects all tracked changes in the document.
+Action Remove the last parameter.
\end_layout
\begin_layout Description
-Notion Reject does not work recursively; the user may have to repeat the
- operation.
+Notion Remove the last parameter of a Math Macro and remove its value in
+ all instances of the macro in the buffer.
\end_layout
\begin_layout Description
-Syntax all-changes-reject
+Syntax math-macro-remove-param <NUM>
\end_layout
\begin_layout Description
-Origin Levon, 16 Oct 2002
+Params <NUM>: The number of the parameter to be deleted (1 for the first),
+ defaults to the last one.
+\end_layout
+
+\begin_layout Description
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_INSET_APPLY
+math-macro-unfold
\end_layout
\begin_layout Description
-Action Apply data for an inset.
+Action Unfold a Math Macro.
\end_layout
\begin_layout Description
-Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
- applied.
- This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
- on the context where it is called.
+Notion Unfold the Math Macro the cursor is in, i.e.
+ display it as
+\backslash
+foo.
\end_layout
\begin_layout Description
-Syntax inset-apply <ARGS>
+Syntax math-macro-unfold
\end_layout
\begin_layout Description
-Params See LFUN_INSET_INSERT .
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_INSET_DISSOLVE
+math-matrix
\end_layout
\begin_layout Description
-Action Dissolve the current inset into text.
+Action Inserts a matrix.
\end_layout
\begin_layout Description
-Syntax inset-dissolve [<INSET>]
+Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
\end_layout
\begin_layout Description
-Params <INSET>: this can be used to make sure the right kind of inset is
- dissolved.
- For example "dissolve" entry in the charstyles sub-menu should only dissolve
- the charstyle inset, even if the cursor is inside several nested insets
- of different type.
-\begin_inset Newline newline
-\end_inset
-
-For values see lyx::InsetLayout::lyxtype_ .
+Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
+ c or t) (i.e.
+ 1 char) and the horizontal alignments (l, c or r) (i.e.
+ <COL> chars).
\end_layout
\begin_layout Description
-Origin JSpitz, 7 Aug 2006
+Sample math-matrix 3 3 bccc
\end_layout
\begin_layout Subsection*
-LFUN_INSET_INSERT
+math-mode
\end_layout
\begin_layout Description
-Action Insert new inset (type given by the parameters).
+Action In text mode enters math mode (i.e.
+ puts math insets on the current cursor position), in math mode enters text
+ mode inside math expression.
\end_layout
\begin_layout Description
-Syntax inset-insert <INSET> <ARGS>
+Notion If there is some selected text, it puts the text inside created math
+ box.
\end_layout
\begin_layout Description
-Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular|
-\begin_inset Newline newline
-\end_inset
-
- hyperlink|include|index|label|line|nomencl|vspace|ref|toc|scri
-pt>
-\begin_inset Newline newline
-\end_inset
-
-<ARGS>: depends on the given inset.
- Use "lyx -dbg action" to explore.
+Syntax math-mode [on|<ARG>]
\end_layout
\begin_layout Description
-Sample inset-insert ref LatexCommand <Format> reference "<label name>"
-\backslash
-end_inset
-\begin_inset Newline newline
-\end_inset
-
-where <label name> is the name of the referenced label and <Format> is one
- of the following:
-\begin_inset Newline newline
-\end_inset
-
-ref -- <reference>
-\begin_inset Newline newline
-\end_inset
-
-eqref -- (<reference>)
-\begin_inset Newline newline
-\end_inset
-
-pageref -- <page>
-\begin_inset Newline newline
-\end_inset
-
-vpageref -- on <page>
-\begin_inset Newline newline
-\end_inset
-
-vref -- <reference> on <page>
+Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
+ .
\begin_inset Newline newline
\end_inset
-formatted -- Formatted reference
+"on": allow only entering of math mode from text mode.
\end_layout
-\begin_layout Subsection*
-LFUN_INSET_MODIFY
+\begin_layout Description
+Origin Alejandro, 4 Jun 1996
\end_layout
-\begin_layout Description
-Action Modify some properties of an inset.
+\begin_layout Subsection*
+math-mutate
\end_layout
\begin_layout Description
-Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
- graphics, include, index, info, label, listings, newline, newpage, nomencl,
- note, phantom, ref, space, tabular, vspace, wrap insets.
+Action Mutates the type of math inset to the newly selected one.
\end_layout
\begin_layout Description
-Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify
- tabular <FEATURE> [<ARG>]
+Syntax math-mutate <TYPE>
\end_layout
\begin_layout Description
-Params Generally see LFUN_INSET_INSERT for further details.
-\begin_inset Newline newline
-\end_inset
-
-In case that <INSET> is "tabular" various math-environment features are
- handled as well, e.g.
- add-vline-left/right for the Grid/Array environment.
-\begin_inset Newline newline
-\end_inset
-
-<FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-colum
-n| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
- align-left|align-right|align-center|align-block|align-decimal|set-decimal-point
-| valign-top|valign-bottom|valign-middle|longtabular-align-left| longtabular-ali
-gn-center|longtabular-align-right|m-align-left|m-align-right| m-align-center|m-v
-align-top|m-valign-bottom|m-valign-middle|multicolumn| set-all-lines|unset-all-l
-ines|set-longtabular|unset-longtabular|set-pwidth| set-mpwidth|set-rotate-tabula
-r|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|
-toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltf
-irsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|
-toggle-ltcaption| set-special-column|set-special-multicolumn|set-special-multiro
-w| set-booktabs|unset-booktabs|set-top-space|set-bottom-space| set-interline-spa
-ce|set-border-lines|tabular-valign-top| tabular-valign-middle|tabular-valign-bot
-tom|set-tabular-width
-\begin_inset Newline newline
-\end_inset
-
-<ARG>: additional argument for some commands, use debug mode to explore
- its values.
+Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
+ multline|gather|flalign
\end_layout
\begin_layout Description
-Sample inset-modify note Note Comment
-\begin_inset Newline newline
-\end_inset
-
- inset-modify changetype Ovalbox
+Origin Andre, 23 May 2001
\end_layout
\begin_layout Subsection*
-LFUN_INSET_DIALOG_UPDATE
+math-number-line-toggle
\end_layout
\begin_layout Description
-Action Updates the values inside the dialog from the inset.
+Action Toggles numbering of the current formula line.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
- Called internally by LFUN_DIALOG_UPDATE
+Notion Must be in display formula mode.
\end_layout
\begin_layout Description
-Params <DIALOG-NAME>
+Syntax math-number-line-toggle
\end_layout
\begin_layout Description
-Origin leeming, 25 Feb 2003
+Origin Alejandro, 18 Jun 1996
\end_layout
\begin_layout Subsection*
-LFUN_INSET_SETTINGS
+math-number-toggle
\end_layout
\begin_layout Description
-Action Open the inset's properties dialog.
+Action Toggles numbering/labeling of the current formula.
\end_layout
\begin_layout Description
-Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
- graphics, href, include, index, index_print, label, line, listings, note,
- phantom, ref, space, tabular, vspace, wrap insets.
+Notion Must be in display formula mode.
\end_layout
\begin_layout Description
-Syntax inset-settings <INSET>
+Syntax math-number-toggle
\end_layout
\begin_layout Description
-Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
-\begin_inset Newline newline
-\end_inset
-
-graphics|href|include|index|index_print|label|line| listings|note|phantom|ref|sp
-ace|tabular|vspace|wrap>.
+Origin Alejandro, 4 Jun 1996
\end_layout
\begin_layout Subsection*
-LFUN_INSET_TOGGLE
+math-size
\end_layout
\begin_layout Description
-Action Toggles the collapsable inset at cursor position, or the inset we
- are currently in.
+Action Changes arbitrarily the size used by math fonts inside a context.
\end_layout
\begin_layout Description
-Syntax inset-toggle [<ARG>]
+Notion Provides an interface to the LaTeX math mode font size commands.
\end_layout
\begin_layout Description
-Params <ARG>: <open|close|toggle|assign>.
-\begin_inset Newline newline
-\end_inset
-
-open/close/toggle are for collapsable insets.
- toggle is used when no argument is given.
-\begin_inset Newline newline
-\end_inset
+Syntax math-size <STYLE>
+\end_layout
-assign synchronize the branch-inset with activation status of the branch.
- Used for global toggling when changed activation.
+\begin_layout Description
+Params <STYLE>:
+\backslash
+displaystyle|
+\backslash
+textstyle|
+\backslash
+scriptstyle|
+\backslash
+scriptscriptstyle
\end_layout
\begin_layout Description
-Origin lasgouttes, 19 Jul 2001
+Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
\end_layout
\begin_layout Subsection*
-LFUN_INSET_FORALL
+math-space
\end_layout
\begin_layout Description
-Action Apply the given commands on insets of a given name.
+Action Inserts space into math expression.
\end_layout
\begin_layout Description
-Notion WARNING: use at your own risks; this function gives you too many
- ways of shooting yourself in the foot.
- A typical example is inset-forall Note note-insert which starts an infinite
- loop.
- This is mitigated by the fact that the number of actions is arbitrarily
- limited to 100000.
- Note also that inset-forall does not update metrics between iterations,
- which can lead to bugs.
- This has to be eventually fixed.
+Notion Use spacebar after entering this space to change type of space.
\end_layout
\begin_layout Description
-Syntax inset-forall <NAME> <LFUN-COMMAND>
-\begin_inset Newline newline
-\end_inset
-
-<NAME>: Type of Inset.
- If <NAME> is *, all insets are matched.
- The name is used like for InsetLayout in layout files: "Note" matches all
- note insets, while "Note:Note" only matches LyX yellow note insets.
+Syntax math-space [<TYPE>] [<LEN>]
\end_layout
\begin_layout Description
-Sample Remove all index insets:
+Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
\begin_inset Newline newline
\end_inset
- inset-forall Index delete-char-forward
+positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
\begin_inset Newline newline
\end_inset
-Close all Notes (also works for a particular branch, for example):
+custom space: hspace
\begin_inset Newline newline
\end_inset
- inset-forall Note inset-toggle close
+"," used by default.
\begin_inset Newline newline
\end_inset
-Transform all yellow notes to comments
+Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
+ and ; = thickspace.
\begin_inset Newline newline
\end_inset
- inset-forall Note:Note inset-modify note Note Comment
-\begin_inset Newline newline
-\end_inset
+<LEN>: length for custom spaces (hspace)
+\end_layout
-Try to put LyX in an infinite loop if there is at least a Note:
-\begin_inset Newline newline
-\end_inset
+\begin_layout Description
+Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
+\end_layout
- inset-forall Note char-backward
+\begin_layout Subsection*
+math-subscript
\end_layout
\begin_layout Description
-Origin lasgouttes, 27 Nov 2009
+Action Enters subscript expression in math expression.
+\end_layout
+
+\begin_layout Description
+Syntax math-subscript
+\end_layout
+
+\begin_layout Description
+Origin vermeer, 12 Dec 2001
\end_layout
\begin_layout Subsection*
-LFUN_GRAPHICS_RELOAD
+math-superscript
\end_layout
\begin_layout Description
-Action Reloads the image if necessary.
+Action Enters superscript expression in math expression.
\end_layout
\begin_layout Description
-Syntax graphics-reload
+Syntax math-superscript
\end_layout
\begin_layout Description
-Origin vfr, 10 Aug 2009
+Origin vermeer, 12 Dec 2001
\end_layout
\begin_layout Subsection*
-LFUN_SET_GRAPHICS_GROUP
+regexp-mode
\end_layout
\begin_layout Description
-Action Set the group for the graphics inset on the cursor position.
+Action Enters regexp mode (i.e., puts regexp insets on the current cursor
+ position).
+ Used by the advanced search dialog.
\end_layout
\begin_layout Description
-Syntax set-graphics-group [<GROUP>]
+Notion If there is any selected text, then it is moved inside the created
+ regexp inset.
\end_layout
\begin_layout Description
-Params <GROUP>: Id for an existing group.
- In case the Id is an empty string, the graphics inset is removed from the
- current group.
+Syntax regexp-mode [<ARG>]
\end_layout
\begin_layout Description
-Origin sanda, 6 May 2008
+Params <ARG>: eventual argument (regular expression).
+\end_layout
+
+\begin_layout Description
+Origin Tommaso, 4 Oct 2008
+\end_layout
+
+\begin_layout Section
+Buffer Fuctions (File and Window related)
\end_layout
\begin_layout Subsection*
-LFUN_FINISHED_FORWARD
+branch-activate
\end_layout
\begin_layout Description
-Action Moves the cursor out of the current slice, going forward.
+Action Activate the branch.
\end_layout
\begin_layout Description
-Notion Cursor movement within an inset may be different than cursor movement
- in the surrounding text.
- This action should be called automatically by the cursor movement within
- the inset, when movement within the inset has ceased (reached the end of
- the last paragraph, for example), in order to move correctly back into
- the surrounding text.
+Syntax branch-activate <BRANCH>
\end_layout
-\begin_layout Subsection*
-LFUN_FINISHED_BACKWARD
+\begin_layout Description
+Params <BRANCH>: The branch to activate
\end_layout
\begin_layout Description
-Action Moves the cursor out of the current slice, going backwards.
+Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
+\begin_inset Newline newline
+\end_inset
+
+could be used to export a pdf with the answers branch included without one's
+ having to open LyX and activate the branch manually.
\end_layout
\begin_layout Description
-Notion See also LFUN_FINISHED_FORWARD.
+Origin rgh, 27 May 2008
\end_layout
\begin_layout Subsection*
-LFUN_FINISHED_RIGHT
+branch-add
\end_layout
\begin_layout Description
-Action Moves the cursor out of the current slice, going right.
+Action Add a branch to the buffer's BranchList.
\end_layout
\begin_layout Description
-Notion See also LFUN_FINISHED_FORWARD
-\end_layout
-
-\begin_layout Subsection*
-LFUN_FINISHED_LEFT
+Syntax branch-add <BRANCH>
\end_layout
\begin_layout Description
-Action Moves the cursor out of the current slice, going left.
+Params <BRANCH>: Name of the branch to add
\end_layout
\begin_layout Description
-Notion See also LFUN_FINISHED_FORWARD.
+Origin spitz, 7 Jul 2009
\end_layout
\begin_layout Subsection*
-LFUN_LANGUAGE
+branch-add-insert
\end_layout
\begin_layout Description
-Action Set language from the current cursor position.
+Action Create new branch and directly put the branch inset into the document.
\end_layout
\begin_layout Description
-Syntax language <LANG>
+Syntax branch-add-insert [<NAME>]
\end_layout
\begin_layout Description
-Params <LANG>: Requested language.
- Look in lib/languages for the list.
+Params <NAME>: Branch name.
+ If it is not specified, you will be asked.
\end_layout
\begin_layout Description
-Origin Dekel, 2 Mar 2000
+Origin sanda, 10 Jul 2009
\end_layout
\begin_layout Subsection*
-LFUN_LABEL_GOTO
+branch-deactivate
\end_layout
\begin_layout Description
-Action Goto a label.
+Action De-activate the branch.
\end_layout
\begin_layout Description
-Syntax label-goto [<LABEL>]
+Syntax branch-deactivate <BRANCH>
\end_layout
\begin_layout Description
-Params <LABEL>: Requested label.
- If no label is given and reference is on cursor position, Bookmark 0 is
- saved and cursor moves to the position of referenced label.
+Params <BRANCH>: The branch to deactivate
\end_layout
\begin_layout Description
-Origin Ale, 6 Aug 1997
+Origin rgh, 27 May 2008
\end_layout
\begin_layout Subsection*
-LFUN_LABEL_INSERT
+branch-invert
\end_layout
\begin_layout Description
-Action Inserts label to text or displayed formula.
+Action Toggles inversion status of branch inset.
\end_layout
\begin_layout Description
-Syntax label-insert [<LABEL>]
+Syntax branch-invert
\end_layout
\begin_layout Description
-Params <LABEL>: Requested label.
- If no label is given dialog requesting name will be opened.
+Origin rgheck, 12 July 2016
\end_layout
\begin_layout Subsection*
-LFUN_REFERENCE_NEXT
-\end_layout
-
-\begin_layout Description
-Action Go to the next label or cross-reference.
+branch-master-activate
\end_layout
\begin_layout Description
-Syntax reference-next
+Action Activate the branch in the master buffer.
\end_layout
\begin_layout Description
-Origin Dekel, 14 Jan 2001
-\end_layout
-
-\begin_layout Subsection*
-LFUN_BOOKMARK_GOTO
+Syntax branch-master-activate <BRANCH>
\end_layout
\begin_layout Description
-Action Moves the cursor to the numbered bookmark, opening the file if necessary.
- Note that bookmarsk are saved per-session, not per file.
+Params <BRANCH>: The branch to activate
\end_layout
\begin_layout Description
-Notion Bookmark 0 has a special purpose.
- It is automatically set
+Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
\begin_inset Newline newline
\end_inset
-1.
- to the paragraph you are currently editing
-\begin_inset Newline newline
-\end_inset
+could be used to export a pdf with the answers branch included without one's
+ having to open LyX and activate the branch manually.
+\end_layout
-2.
- to the paragraph from where you are jumping to the last-edited position
- (jump-back feature)
-\begin_inset Newline newline
-\end_inset
+\begin_layout Description
+Origin spitz, 30 Sep 2012
+\end_layout
-3.
- when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
+\begin_layout Subsection*
+branch-master-deactivate
\end_layout
\begin_layout Description
-Syntax bookmark-goto <NUMBER>
+Action De-activate the branch in the master buffer.
\end_layout
\begin_layout Description
-Params <NUMBER>: the number of the bookmark to restore.
+Syntax branch-master-deactivate <BRANCH>
\end_layout
\begin_layout Description
-Origin Dekel, 27 January 2001
+Params <BRANCH>: The branch to deactivate
\end_layout
-\begin_layout Subsection*
-LFUN_BOOKMARK_SAVE
+\begin_layout Description
+Origin spitz, 30 Sep 2012
\end_layout
-\begin_layout Description
-Action Save a bookmark.
+\begin_layout Subsection*
+branches-rename
\end_layout
\begin_layout Description
-Notion Saves a numbered bookmark to the sessions file.
- The number must be between 1 and 9, inclusive.
- Note that bookmarks are saved per-session, not per file.
+Action Rename all branches of a given name in a document.
\end_layout
\begin_layout Description
-Syntax bookmark-save <NUMBER>
+Syntax branches-rename <OLDNAME> <NEWNAME>
\end_layout
\begin_layout Description
-Params <NUMBER>: the number of the bookmark to save.
+Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
+ name of the branch
\end_layout
\begin_layout Description
-Origin Dekel, 27 January 2001
+Origin spitz, 9 Jul 2009
\end_layout
\begin_layout Subsection*
-LFUN_BOOKMARK_CLEAR
+buffer-auto-save
\end_layout
\begin_layout Description
-Action Clears the list of saved bookmarks.
+Action Saves the current buffer to a temporary file.
\end_layout
\begin_layout Description
-Syntax bookmark-clear
+Notion Saves the current buffer to a file named "#filename#".
+ This LFUN is called automatically by LyX, to "autosave" the current buffer.
\end_layout
\begin_layout Description
-Origin bpeng, 31 October 2006
+Syntax buffer-auto-save
\end_layout
\begin_layout Subsection*
-LFUN_HELP_OPEN
+buffer-child-open
\end_layout
\begin_layout Description
-Action Open the given help file according to the language setting.
+Action Loads the given child document.
\end_layout
\begin_layout Description
-Syntax help-open <FILE>[.lyx]
+Notion The current document is treated as a parent.
\end_layout
\begin_layout Description
-Params <FILE>: any document from (/usr/share/)doc directory.
+Syntax buffer-child-open <FILE>
\end_layout
\begin_layout Description
-Origin Jug, 27 Jun 1999
-\end_layout
-
-\begin_layout Subsection*
-LFUN_LYX_QUIT
+Params <FILE>: Filename of the child.
+ The directory of the parent is assumed by default.
\end_layout
\begin_layout Description
-Action Terminates the current LyX instance.
+Origin Ale, 28 May 1997
\end_layout
-\begin_layout Description
-Notion Terminates the current LyX instance, asking whether to save modified
- documents, etc.
+\begin_layout Subsection*
+buffer-chktex
\end_layout
\begin_layout Description
-Syntax lyx-quit
+Action Runs chktex for the current document.
\end_layout
-\begin_layout Subsection*
-LFUN_TOOLBAR_TOGGLE
+\begin_layout Description
+Syntax buffer-chktex
\end_layout
\begin_layout Description
-Action Toggles visibility of a given toolbar between on/off/auto.
+Origin Asger, 30 Oct 1997
\end_layout
-\begin_layout Description
-Notion Skipping "auto" when allowauto is false.
+\begin_layout Subsection*
+buffer-close
\end_layout
\begin_layout Description
-Syntax toolbar-toggle <NAME> [allowauto]
+Action Closes the current buffer.
\end_layout
\begin_layout Description
-Params <NAME>: standard|extra|table|math|mathmacrotemplate|
-\begin_inset Newline newline
-\end_inset
-
-minibuffer|review|view/update|math_panels|vcs| view-others|update-others
+Notion Closes the current buffer, asking whether to save it, etc, if the
+ buffer has been modified.
\end_layout
\begin_layout Description
-Origin Edwin, 21 May 2007
+Syntax buffer-close
\end_layout
\begin_layout Subsection*
-LFUN_MENU_OPEN
+buffer-close-all
\end_layout
\begin_layout Description
-Action Opens the menu given by its name.
+Action Closes all buffers.
\end_layout
\begin_layout Description
-Syntax menu-open <NAME>
+Notion Closes all buffers, asking whether to save it, etc, if a buffer has
+ been modified.
\end_layout
\begin_layout Description
-Params <NAME>: menu name.
- See various .inc files in lib/ui for candidates.
+Syntax buffer-close-all
\end_layout
\begin_layout Subsection*
-LFUN_UI_TOGGLE
+buffer-export
\end_layout
\begin_layout Description
-Action Various UI visibility-toggling actions.
+Action Exports the current buffer (document) to the given format.
\end_layout
\begin_layout Description
-Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
+Syntax buffer-export [<FORMAT>] [<DEST>]
\end_layout
\begin_layout Description
-Params statusbar : Toggle visibility of the statusbar.
-\begin_inset Newline newline
-\end_inset
-
-menubar : Toggle visibility of the menubar.
-\begin_inset Newline newline
-\end_inset
-
-scrollbar : Toggle visibility of the scrollbar.
+Params <FORMAT> is either "custom" or one of the formats which you can find
+ in Tools->Preferences->File formats->Format.
+ Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
+ for pdflatex) or "ps" for postscript.
\begin_inset Newline newline
\end_inset
-frame : Toggle visibility of the frames around editing window.
+In case of "custom" you will be asked for a format you want to start from
+ and for the command that you want to apply to this format.
+ Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
\begin_inset Newline newline
\end_inset
-fullscreen : Toggle fullscreen mode.
- This also covers calling the previous functions.
- However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
- be used.
+If absent or "default", then the default output format of the document is
+ used.
+ <DEST> If present, this argument provides the export destination filename.
+ Its containing folder will also be the destination folder, where all
+ the needed external files will be copied.
\end_layout
\begin_layout Description
-Origin sanda, 9 Feb 2007
+Origin Lgb, 29 Jul 1997
\end_layout
\begin_layout Subsection*
-LFUN_WINDOW_NEW
+buffer-export-as
\end_layout
\begin_layout Description
-Action Creates new empty LyX window.
+Action Opens a dialog for exporting the current buffer.
\end_layout
\begin_layout Description
-Notion Already opened documents from the previous window can be found under
- View menu.
+Syntax buffer-export-as [<FORMAT>]
\end_layout
\begin_layout Description
-Syntax window-new [<GEOMETRY>]
+Params <FORMAT> is the export format initially selected in the dialog.
+ You can pass any of the formats which you can find in Tools->Preferences->File
+ formats->Format, provided it has the "document" flag set.
+ If no format is specified the dialog will start with the default output
+ format of the current document.
\end_layout
\begin_layout Description
-Params <GEOMETRY>: pass the geometry of the window.
- This parameter is currently accepted only on Windows platform.
+Sample buffer-export-as pdf2
\end_layout
\begin_layout Description
-Origin Abdel, 21 Oct 2006
+Origin tommaso, 6 Oct 2011
\end_layout
\begin_layout Subsection*
-LFUN_WINDOW_CLOSE
+buffer-export-custom
\end_layout
\begin_layout Description
-Action Closes the current LyX window.
+Action Exports the current buffer (document) from the given format using
+ the given command on it.
\end_layout
\begin_layout Description
-Syntax window-close
+Syntax buffer-export-custom <FORMAT> <COMMAND>
\end_layout
\begin_layout Description
-Origin Abdel, 23 Oct 2006
-\end_layout
+Params <FORMAT> format to start from (LyX will care to produce such intermediate
+ file).
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_SPLIT_VIEW
+<COMMAND> this command will be launched on the file.
+ Note that you can use "$$FName" string to qualify the intermediate file.
\end_layout
\begin_layout Description
-Action Creates another split view of current buffer.
+Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
\end_layout
\begin_layout Description
-Notion All split views act in the same way indpendently.
+Origin leeming, 27 Mar 2004
\end_layout
-\begin_layout Description
-Syntax split-view <vertical|horizontal>
+\begin_layout Subsection*
+buffer-external-modification-clear
\end_layout
\begin_layout Description
-Params horizontal : The work areas are laid out side by side.
-\begin_inset Newline newline
-\end_inset
-
-vertical : The work areas laid out vertically.
+Action Clear the external modification flag on the current buffer.
\end_layout
\begin_layout Description
-Origin Abdel, 20 Feb 2008
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CLOSE_TAB_GROUP
+Syntax buffer-external-modification-clear
\end_layout
\begin_layout Description
-Action Close the current tab group.
+Origin gm, 2 March 2017
\end_layout
-\begin_layout Description
-Notion This only closes the work areas, not the buffer themselves.
- The still opened buffers can be visualized in another tab group.
+\begin_layout Subsection*
+buffer-forall
\end_layout
\begin_layout Description
-Syntax close-tab-group
+Action Applies a command to all non-hidden buffers.
\end_layout
\begin_layout Description
-Origin Abdel, 21 Feb 2008
-\end_layout
-
-\begin_layout Subsection*
-LFUN_DIALOG_SHOW
+Notion a buffer is `hidden' if it is internally open in LyX, but not visible
+ in any window.
\end_layout
\begin_layout Description
-Action Shows hidden dialog or create new one for a given function/inset
- settings etc.
+Syntax buffer-forall <LFUN-COMMAND>
\end_layout
\begin_layout Description
-Syntax dialog-show <NAME> [<DATA>]
+Params <LFUN-COMMAND>: The command to be applied to the buffers.
\end_layout
\begin_layout Description
-Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
+Sample Close all Notes in buffers:
\begin_inset Newline newline
\end_inset
-compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
+ buffer-forall inset-forall Note inset-toggle close
\begin_inset Newline newline
\end_inset
-graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
-er|
+Toggle change tracking on buffers:
\begin_inset Newline newline
\end_inset
-mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
+ buffer-forall changes-track
\begin_inset Newline newline
\end_inset
-print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
+Toggle read-only for buffers:
\begin_inset Newline newline
\end_inset
-thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
+ buffer-forall buffer-toggle-read-only
\begin_inset Newline newline
\end_inset
-<SPECIAL>: latexlog|vclog
+Show statistics for individual buffers:
\begin_inset Newline newline
\end_inset
-<DATA>: data, usually settings for the given dialog.
- Use debug mode for the details.
-\end_layout
-
-\begin_layout Description
-Origin leeming, 17 Jun 2003
-\end_layout
-
-\begin_layout Subsection*
-LFUN_DIALOG_SHOW_NEW_INSET
-\end_layout
-
-\begin_layout Description
-Action Shows hidden dialog or create new one for a given inset settings
- etc.
-\end_layout
-
-\begin_layout Description
-Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
- inset.
-\end_layout
-
-\begin_layout Description
-Syntax dialog-show-new-inset <NAME> [<DATA>]
-\end_layout
-
-\begin_layout Description
-Params See LFUN_DIALOG_SHOW .
-\end_layout
-
-\begin_layout Description
-Origin leeming, 25 Feb 2003
-\end_layout
-
-\begin_layout Subsection*
-LFUN_DIALOG_UPDATE
-\end_layout
+ buffer-forall statistics
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Updates the dialog values from the inset/paragraph/document.
-\end_layout
+Activate the branch named "Solutions" in buffers:
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax dialog-update <NAME>
-\end_layout
+ buffer-forall branch-activate Solutions
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Params <NAME>: paragraph|prefs|<INSET>
+Export buffers to PDF (pdflatex):
\begin_inset Newline newline
\end_inset
-<INSET>: inset name
+ buffer-forall buffer-export pdf2
+\begin_inset Newline newline
+\end_inset
+
+
\end_layout
\begin_layout Description
-Origin leeming, 25 Feb 2003
+Origin skostysh, 20 Jul 2012
\end_layout
\begin_layout Subsection*
-LFUN_DIALOG_HIDE
+buffer-import
\end_layout
\begin_layout Description
-Action Hides showed dialog.
- Counterpart to LFUN_DIALOG_SHOW .
+Action Import a given file as a lyx document.
\end_layout
\begin_layout Description
-Syntax dialog-hide <NAME>
+Notion File can be imported iff lyx file format is (transitively) reachable
+ via defined converters in preferences.
+ Look in the File->Import menu to get an idea of the currently active import
+ formats.
\end_layout
\begin_layout Description
-Params See LFUN_DIALOG_SHOW .
+Syntax buffer-import <FORMAT> [<FILE>]
\end_layout
\begin_layout Description
-Origin leeming, 25 Feb 2003
+Origin Asger, 24 Jul 1998
\end_layout
\begin_layout Subsection*
-LFUN_DIALOG_TOGGLE
+buffer-language
\end_layout
\begin_layout Description
-Action Toggles dialog between showed/hidden state.
-\end_layout
-
-\begin_layout Description
-Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
+Action Set language of the current document.
\end_layout
\begin_layout Description
-Syntax dialog-toggle <NAME> [<DATA>]
+Syntax buffer-language <LANG>
\end_layout
\begin_layout Description
-Params See LFUN_DIALOG_SHOW .
+Params <LANG>: language name.
+ See lib/languages for list.
\end_layout
\begin_layout Description
-Origin JSpitzm, 30 Apr 2007
+Origin leeming, 30 Mar 2004
\end_layout
\begin_layout Subsection*
-LFUN_DIALOG_DISCONNECT_INSET
-\end_layout
-
-\begin_layout Description
-Action Closes opened connection to opened inset.
+buffer-move-next
\end_layout
\begin_layout Description
-Notion Connection is used for apply functions.
+Action Moves the current tab one spot to the right.
\end_layout
\begin_layout Description
-Syntax dialog-disconnect-inset <INSET-NAME>
+Syntax buffer-move-next
\end_layout
\begin_layout Description
-Origin leeming, 25 Feb 2003
+Origin skostysh, 7 Apr 2015
\end_layout
\begin_layout Subsection*
-LFUN_MOUSE_PRESS
+buffer-move-previous
\end_layout
\begin_layout Description
-Action This function is called when mouse button is pressed (inside workarea).
- Action depends on the context.
+Action Moves the current tab one spot to the left.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Syntax buffer-move-previous
\end_layout
\begin_layout Description
-Origin Andre, 9 Aug 2002
+Origin skostysh, 7 Apr 2015
\end_layout
\begin_layout Subsection*
-LFUN_MOUSE_DOUBLE
+buffer-new
\end_layout
\begin_layout Description
-Action This function is called when double click on mouse button is pressed
- (inside workarea).
- Action depends on the context.
+Action Creates a new buffer (that is, document) and switches to it.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Notion Implicit path can be set in Preferences dialog.
\end_layout
\begin_layout Description
-Origin Andre, 9 Aug 2002
-\end_layout
-
-\begin_layout Subsection*
-LFUN_MOUSE_TRIPLE
+Syntax buffer-new [<FILE>]
\end_layout
\begin_layout Description
-Action This function is called when triple click on mouse button is pressed
- (inside workarea).
- Action depends on the context.
+Params <FILE>: filename of created file with absolute path.
\end_layout
-\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+\begin_layout Subsection*
+buffer-new-template
\end_layout
\begin_layout Description
-Origin Andre, 9 Aug 2002
-\end_layout
-
-\begin_layout Subsection*
-LFUN_MOUSE_MOTION
+Action Creates a new buffer (that is, document) from a template.
\end_layout
\begin_layout Description
-Action This function is called when mouse cursor is moving over the text.
- Action depends on the context.
+Notion Path for new files and templates can be set in Preferences dialog.
+ Template will be asked for via Open-dialog.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Syntax buffer-new-template [<FILE>]
\end_layout
\begin_layout Description
-Origin Andre, 9 Aug 2002
+Params <FILE>: filename of created file with absolute path.
\end_layout
\begin_layout Subsection*
-LFUN_MOUSE_RELEASE
+buffer-next
\end_layout
\begin_layout Description
-Action This function is called when mouse button is released (inside workarea).
- Action depends on the context.
+Action Switch to the next opened document.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Notion Note that this does not necessarily mean next in tabbar (for full
+ list see View menu).
\end_layout
\begin_layout Description
-Origin Andre, 9 Aug 2002
+Syntax buffer-next
\end_layout
\begin_layout Subsection*
-LFUN_KEYMAP_OFF
+buffer-params-apply
\end_layout
\begin_layout Description
-Action Turn off the loaded keyboard map.
-\end_layout
-
-\begin_layout Description
-Syntax keymap-off
-\end_layout
-
-\begin_layout Subsection*
-LFUN_KEYMAP_PRIMARY
+Action Apply the given settings to the current document.
\end_layout
\begin_layout Description
-Action Turn on the primary keyboard map.
+Syntax buffer-params-apply [<ARGS>]
\end_layout
\begin_layout Description
-Notion Maps were widely used in past, when X-windows didn't have nowadays
- keyboard support.
- They can be still used to maintain uniform keyboard layout across the various
- plaforms.
-\begin_inset Newline newline
-\end_inset
-
-The language is to be set in the Preferences dialog.
+Params <ARGS>: contains the particular settings to be saved.
+ They obey the syntax you can find in document header of usual .lyx file.
\end_layout
\begin_layout Description
-Syntax keymap-primary
+Origin leeming, 30 Mar 2004
\end_layout
\begin_layout Subsection*
-LFUN_KEYMAP_SECONDARY
+buffer-previous
\end_layout
\begin_layout Description
-Action Turn on the secondary keyboard map.
+Action Switch to the previous opened document.
\end_layout
\begin_layout Description
-Syntax keymap-secondary
+Syntax buffer-previous
\end_layout
\begin_layout Subsection*
-LFUN_KEYMAP_TOGGLE
+buffer-reload
\end_layout
\begin_layout Description
-Action Toggles keyboard maps (first/second/off).
+Action Reverts opened document.
\end_layout
\begin_layout Description
-Syntax keymap-toggle
+Syntax buffer-reload
\end_layout
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Origin Asger, 2 Feb 1997
\end_layout
\begin_layout Subsection*
-LFUN_SERVER_GET_LAYOUT
+buffer-save-as-default
\end_layout
\begin_layout Description
-Action Returns the current layout (that is environment) name on the cursor
- position.
+Action Save the current document settings as default.
\end_layout
\begin_layout Description
-Syntax server-get-layout
+Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
\end_layout
-\begin_layout Subsection*
-LFUN_SERVER_GET_FILENAME
+\begin_layout Description
+Syntax buffer-save-as-default [<ARGS>]
\end_layout
\begin_layout Description
-Action Returns path and file name of the currently edited document.
+Params <ARGS>: contains the particular settings to be saved.
+ They obey the syntax you can find in document header of usual .lyx file.
\end_layout
\begin_layout Description
-Syntax server-get-filename
+Origin leeming, 30 Mar 2004
\end_layout
\begin_layout Subsection*
-LFUN_SERVER_GOTO_FILE_ROW
+buffer-switch
\end_layout
\begin_layout Description
-Action Sets the cursor position in LyX based on the row number of generated
- TeX file.
+Action Display and switch to the given buffer.
\end_layout
\begin_layout Description
-Notion This can be useful for DVI inverse-search or detection of the problematic
- line from LaTeX compilation.
- Note that before this function can be used export to LaTeX output must
- occur (in order to map the row numbers).
+Syntax buffer-switch <BUFFER>
\end_layout
\begin_layout Description
-Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
+Params <BUFFER>: path and filename of already opened (but possibly hidden)
+ document which is to be shown.
\end_layout
-\begin_layout Description
-Params <FILE>: the path and filename.
- Environment variables are expanded in the path.
- In case this LFUN does not work make sure you are giving correct path to
- the file.
-\begin_inset Newline newline
-\end_inset
-
-If the file is located inside LyX temporary directory it will be mapped
- back into the appropriate opened buffer (e.g.
- for the case of generated .tex file).
-\begin_inset Newline newline
-\end_inset
-
-.ext: extensions will be automatically replaced by .lyx.
-\begin_inset Newline newline
-\end_inset
-
-<ROW_NUMBER> The row number of the LaTeX file to which to go.
+\begin_layout Subsection*
+buffer-toggle-compression
\end_layout
\begin_layout Description
-Sample server-goto-file-row /home/user/example.lyx 41
-\begin_inset Newline newline
-\end_inset
+Action Toggles compression of the current document on/off.
+\end_layout
-server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
+\begin_layout Description
+Syntax buffer-toggle-compression
\end_layout
\begin_layout Description
-Origin Edmar, 23 Dec 1998
+Origin bpeng, 27 Apr 2006
\end_layout
\begin_layout Subsection*
-LFUN_FORWARD_SEARCH
+buffer-toggle-read-only
\end_layout
\begin_layout Description
-Action Sets the cursor position in the previewed (dvi/pdf) file based on
- the row number in LyX window.
+Action Toggle editing mode of the current document between read/write and
+ read-only.
\end_layout
\begin_layout Description
-Notion The external program used for forward search call can be specified
- in LyX Output preferences.
- See Additional manual for details of these settings.
+Notion This function is not allowed if the file is under version control,
+ since read-only flag is often used in version control file locking.
\end_layout
\begin_layout Description
-Syntax forward-search
+Syntax buffer-toggle-read-only
\end_layout
\begin_layout Description
-Origin sanda, 14 Apr 2010
+Origin Lgb, 27 May 1997
\end_layout
\begin_layout Subsection*
-LFUN_SERVER_NOTIFY
+buffer-update
\end_layout
\begin_layout Description
-Action Sends notify message about the last key-sequence to client.
+Action Exports the current document and put the result into the temporary
+ directory.
\end_layout
\begin_layout Description
-Notion This can be used to grab last key-sequence used inside the LyX window.
- See also Debug extensions section in Additional features manual.
+Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
+EW) the output will be rewritten - updated.
+ This is useful in case your viewer is able to detect such changes (e.g.
+ ghostview for postscript).
\end_layout
\begin_layout Description
-Syntax server-notify
-\end_layout
-
-\begin_layout Subsection*
-LFUN_SERVER_SET_XY
+Syntax buffer-update [<FORMAT>]
\end_layout
\begin_layout Description
-Action Sets the cursor position based on the editing area coordinates (similar
- as clicking on that point with left mouse button).
+Params <FORMAT>: The format to display, where this is one of the formats
+ defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
+ If no format is given, the default format as specified in the same dialog
+ is used.
\end_layout
\begin_layout Description
-Syntax server-set-xy <X> <Y>
+Origin Dekel, 5 Aug 2000
\end_layout
\begin_layout Subsection*
-LFUN_SERVER_GET_XY
-\end_layout
-
-\begin_layout Description
-Action Returns the coordinates of cursor position in the editing area.
+buffer-view
\end_layout
\begin_layout Description
-Syntax server-get-xy
-\end_layout
-
-\begin_layout Subsection*
-LFUN_BUILD_PROGRAM
+Action Displays current buffer in chosen format.
\end_layout
\begin_layout Description
-Action Generates the code (literate programming).
+Notion Displays the contents of the current buffer in the chosen format,
+ for example, PDF or DVI.
+ This runs the necessary converter, calls the defined viewer, and so forth.
\end_layout
\begin_layout Description
-Notion Latex file with extension
-\backslash
-literate_extension is generated.
- Then LyX invokes
-\backslash
-build_command (with a default of``make'') to generate the code and
-\backslash
-build_error_filter to process the compilation error messages.
-\begin_inset Newline newline
-\end_inset
-
-In case you want to process your literate file with a script, or some other
- program, just insert in your lyxrc file an entry with:
-\begin_inset Newline newline
-\end_inset
-
-
-\backslash
-build_command "my_script my_arguments"
-\begin_inset Newline newline
-\end_inset
-
-The
-\backslash
-build_error_filter differs from the
-\backslash
-literate_error_filter only in that the former will identify error messages
- from your compiler.
+Syntax buffer-view [<FORMAT>]
\end_layout
\begin_layout Description
-Syntax build-program
+Params <FORMAT>: The format to display, where this is one of the formats
+ defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
+ If no format is given, the default format as specified in the same dialog
+ is used.
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_AUTO_SAVE
+buffer-view-cache
\end_layout
\begin_layout Description
-Action Saves the current buffer to a temporary file.
+Action Opens the file that was created from last preview of this buffer.
\end_layout
\begin_layout Description
-Notion Saves the current buffer to a file named "#filename#".
- This LFUN is called automatically by LyX, to "autosave" the current buffer.
+Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX
+ Errors dialog.
+ It can also be called by the user, which is useful if the document takes
+ a long time to compile, and you just want to see the last previewed version.
\end_layout
\begin_layout Description
-Syntax buffer-auto-save
+Syntax buffer-view-cache
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_CHILD_OPEN
+buffer-write
\end_layout
\begin_layout Description
-Action Loads the given child document.
-\end_layout
-
-\begin_layout Description
-Notion The current document is treated as a parent.
-\end_layout
-
-\begin_layout Description
-Syntax buffer-child-open <FILE>
+Action Saves the current buffer.
\end_layout
\begin_layout Description
-Params <FILE>: Filename of the child.
- The directory of the parent is assumed by default.
+Notion Saves the current buffer to disk, using the filename that is already
+ associated with the buffer, asking for one if none is yet assigned.
\end_layout
\begin_layout Description
-Origin Ale, 28 May 1997
+Syntax buffer-write
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_CHKTEX
+buffer-write-all
\end_layout
\begin_layout Description
-Action Runs chktex for the current document.
+Action Save all changed documents.
\end_layout
\begin_layout Description
-Syntax buffer-chktex
+Syntax buffer-write-all
\end_layout
\begin_layout Description
-Origin Asger, 30 Oct 1997
+Origin rgh, gpothier 6 Aug 2007
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_TOGGLE_COMPRESSION
+buffer-write-as
\end_layout
\begin_layout Description
-Action Toggles compression of the current document on/off.
+Action Rename and save current buffer.
\end_layout
\begin_layout Description
-Syntax buffer-toggle-compression
+Syntax buffer-write-as <FILENAME>
\end_layout
\begin_layout Description
-Origin bpeng, 27 Apr 2006
+Params <FILENAME>: New name of the buffer/file.
+ A relative path is with respect to the original location of the buffer/file.
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
+buffer-zoom
\end_layout
\begin_layout Description
-Action Toggles including of resources for forward/reverse search of the
- given document.
+Action Sets the zoom of the screen fonts.
\end_layout
\begin_layout Description
-Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
- is used for DVI.
- Custom LaTeX macro can be defined in preferences.
+Syntax buffer-zoom [<ZOOM>]
\end_layout
\begin_layout Description
-Syntax buffer-toggle-output-sync
+Params <ZOOM>: The target zoom value in %; the default is the default zoom
+ as saved in preferences.
\end_layout
\begin_layout Description
-Origin sanda, 25 May 2010
+Origin daniel, 28 Oct 2016
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_CLOSE
+buffer-zoom-in
\end_layout
\begin_layout Description
-Action Closes the current buffer.
+Action Increases the zoom of the screen fonts.
\end_layout
\begin_layout Description
-Notion Closes the current buffer, asking whether to save it, etc, if the
- buffer has been modified.
+Syntax buffer-zoom-in [<ZOOM>]
\end_layout
\begin_layout Description
-Syntax buffer-close
+Params <ZOOM>: The zoom value addition in % (neg.
+ or pos.); the default is 10% of the default zoom as saved in preferences.
+\end_layout
+
+\begin_layout Description
+Origin vfr, 30 Mar 2009
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_CLOSE_ALL
+buffer-zoom-out
\end_layout
\begin_layout Description
-Action Closes all buffers.
+Action Decreases the zoom of the screen fonts.
\end_layout
\begin_layout Description
-Notion Closes all buffers, asking whether to save it, etc, if a buffer has
- been modified.
+Syntax buffer-zoom-out [<ZOOM>]
\end_layout
\begin_layout Description
-Syntax buffer-close-all
+Params <ZOOM>: The zoom value abstraction in % (neg.
+ or pos.); the default is 10% of the default zoom as saved in preferences.
\end_layout
-\begin_layout Subsection*
-LFUN_BUFFER_EXPORT
+\begin_layout Description
+Origin vfr, 30 Mar 2009
\end_layout
-\begin_layout Description
-Action Exports the current buffer (document) to the given format.
+\begin_layout Subsection*
+build-program
\end_layout
\begin_layout Description
-Syntax buffer-export <FORMAT>
+Action Generates the code (literate programming).
\end_layout
\begin_layout Description
-Params <FORMAT> is either "custom" or one of the formats which you can find
- in Tools->Preferences->File formats->Format.
- Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
- for pdflatex) or "ps" for postscript.
+Notion Latex file with extension
+\backslash
+literate_extension is generated.
+ Then LyX invokes
+\backslash
+build_command (with a default of ``make'') to generate the code and
+\backslash
+build_error_filter to process the compilation error messages.
\begin_inset Newline newline
\end_inset
-In case of "custom" you will be asked for a format you want to start from
- and for the command that you want to apply to this format.
- Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
+In case you want to process your literate file with a script, or some other
+ program, just insert in your lyxrc file an entry with:
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+build_command "my_script my_arguments"
+\begin_inset Newline newline
+\end_inset
+
+The
+\backslash
+build_error_filter differs from the
+\backslash
+literate_error_filter only in that the former will identify error messages
+ from your compiler.
\end_layout
\begin_layout Description
-Origin Lgb, 29 Jul 1997
+Syntax build-program
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_EXPORT_CUSTOM
+file-open
\end_layout
\begin_layout Description
-Action Exports the current buffer (document) from the given format using
- the given command on it.
+Action Open LyX document.
\end_layout
\begin_layout Description
-Syntax buffer-export-custom <FORMAT> <COMMAND>
+Syntax file-open [<FILE>]
\end_layout
\begin_layout Description
-Params <FORMAT> format to start from (LyX will care to produce such intermediate
- file).
-\begin_inset Newline newline
-\end_inset
+Params <FILE>: Filename to be opened.
+\end_layout
-<COMMAND> this command will be launched on the file.
- Note that you can use "$$FName" string to qualify the intermediate file.
+\begin_layout Subsection*
+help-open
\end_layout
\begin_layout Description
-Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
+Action Open the given help file according to the language setting.
\end_layout
\begin_layout Description
-Origin leeming, 27 Mar 2004
+Syntax help-open <FILE>[.lyx]
\end_layout
-\begin_layout Subsection*
-LFUN_BUFFER_PRINT
+\begin_layout Description
+Params <FILE>: any document from (/usr/share/)doc directory.
\end_layout
\begin_layout Description
-Action Prints the current document.
+Origin Jug, 27 Jun 1999
\end_layout
-\begin_layout Description
-Notion Many settings can be given via the preferences dialog.
+\begin_layout Subsection*
+icon-size
\end_layout
\begin_layout Description
-Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
+Action Sets icon size of toolbars.
\end_layout
\begin_layout Description
-Params <TARGET> is either "printer" or "file".
-\begin_inset Newline newline
-\end_inset
-
-<TARGER-NAME> is either "default" or file name or printer name.
-\begin_inset Newline newline
-\end_inset
-
-<COMMAND> command ensuring the printing job.
+Syntax icon-size [<SIZE>]
\end_layout
\begin_layout Description
-Sample buffer-print file "/trash/newfile1.ps" "dvips"
+Params <SIZE> : the icon size in px or one of the logical settings small|normal|
+big|huge|giant, the default is normal (whose size in px is icon set dependent).
\end_layout
\begin_layout Description
-Origin leeming, 28 Mar 2004
+Origin 11 July 2016
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_IMPORT
-\end_layout
-
-\begin_layout Description
-Action Import a given file as a lyx document.
+lyx-quit
\end_layout
\begin_layout Description
-Notion File can be imported iff lyx file format is (transitively) reachable
- via defined convertors in preferences.
- Look into File->Import menu to get an idea of the currently active import
- formats.
+Action Terminates the current LyX instance.
\end_layout
\begin_layout Description
-Syntax buffer-import <FORMAT> [<FILE>]
+Notion Terminates the current LyX instance, asking whether to save modified
+ documents, etc.
\end_layout
\begin_layout Description
-Origin Asger, 24 Jul 1998
+Syntax lyx-quit
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_NEW
+master-buffer-update
\end_layout
\begin_layout Description
-Action Creates a new buffer (that is, document).
+Action Update (export) the document built from the master buffer, if the
+ current buffer is part of a master/child document.
\end_layout
\begin_layout Description
-Notion Implicit path can be set in Preferences dialog.
+Syntax master-buffer-update [<FORMAT>]
\end_layout
\begin_layout Description
-Syntax buffer-new [<FILE>]
+Params <FORMAT>: The format to display, where this is one of the formats
+ defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
+ If no format is given, the default format as specified in the same dialog
+ is used.
\end_layout
\begin_layout Description
-Params <FILE>: filename of created file with absolute path.
+Origin Tommaso, 20 Sep 2007
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_NEW_TEMPLATE
+master-buffer-view
\end_layout
\begin_layout Description
-Action Creates a new buffer (that is, document) from a template.
+Action Show a preview built from the master buffer, if available.
+ if the current buffer is part of a master/child document.
\end_layout
\begin_layout Description
-Notion Path for new files and templates can be set in Preferences dialog.
- Template will be asked for via Open-dialog.
+Syntax master-buffer-view [<FORMAT>]
\end_layout
\begin_layout Description
-Syntax buffer-new-template [<FILE>]
+Params <FORMAT>: The format to display, where this is one of the formats
+ defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
+ If no format is given, the default format as specified in the same dialog
+ is used.
\end_layout
\begin_layout Description
-Params <FILE>: filename of created file with absolute path.
+Origin Tommaso, 20 Sep 2007
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_RELOAD
+menu-open
\end_layout
\begin_layout Description
-Action Reverts opened document.
+Action Opens the menu given by its name.
\end_layout
\begin_layout Description
-Syntax buffer-reload
+Syntax menu-open <NAME>
\end_layout
\begin_layout Description
-Origin Asger, 2 Feb 1997
+Params <NAME>: menu name.
+ See various .inc files in lib/ui for candidates.
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_SWITCH
+tab-group-close
\end_layout
\begin_layout Description
-Action Display/switch to the given buffer.
+Action Close the current tab group.
\end_layout
\begin_layout Description
-Syntax buffer-switch <BUFFER>
+Notion This only closes the work areas, not the buffers themselves.
+ The still opened buffers can be visualized in another tab group.
\end_layout
\begin_layout Description
-Params <BUFFER>: path and filename of already opened (but possibly hidden)
- document which is to be shown.
+Syntax tab-group-close
+\end_layout
+
+\begin_layout Description
+Origin Abdel, 21 Feb 2008
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_TOGGLE_READ_ONLY
+toolbar-movable
\end_layout
\begin_layout Description
-Action Toggle editing mode of the current document between read/write and
- read-only.
+Action Toggles movability of a given toolbar between true/false.
\end_layout
\begin_layout Description
-Notion This function is not allowed if the file is under version control,
- since read-only flag is often used in version control file locking.
+Syntax toolbar-movable <NAME>
\end_layout
\begin_layout Description
-Syntax buffer-toggle-read-only
+Params <NAME>: *|standard|extra|table|math|mathmacrotemplate|
+\begin_inset Newline newline
+\end_inset
+
+ minibuffer|review|view/update|math_panels|vcs| view-others|updat
+e-others
\end_layout
\begin_layout Description
-Origin Lgb, 27 May 1997
+Origin daniel, 12 July 2016
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_VIEW
+toolbar-toggle
\end_layout
\begin_layout Description
-Action Displays current buffer in chosen format.
+Action Toggles visibility of a given toolbar between on/off/auto.
\end_layout
\begin_layout Description
-Notion Displays the contents of the current buffer in the chosen format,
- for example, PDF or DVI.
- This runs the necessary converter, calls the defined viewer, and so forth.
+Notion Skipping "auto" when allowauto is false.
\end_layout
\begin_layout Description
-Syntax buffer-view [<FORMAT>]
+Syntax toolbar-toggle <NAME> [allowauto]
\end_layout
\begin_layout Description
-Params <FORMAT>: The format to display, where this is one of the formats
- defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
- If no format is given, the default format as specified in the same dialog
- is used.
-\end_layout
+Params <NAME>: standard|extra|table|math|mathmacrotemplate|
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_BUFFER_UPDATE
+minibuffer|review|view/update|math_panels|vcs| view-others|update-others
\end_layout
\begin_layout Description
-Action Exports the current document and put the result into the temporary
- directory.
+Origin Edwin, 21 May 2007
+\end_layout
+
+\begin_layout Subsection*
+ui-toggle
\end_layout
\begin_layout Description
-Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
-EW) the output will be rewriten - updated.
- This is useful in case your viewer is able to detect such changes (e.g.
- ghostview for postscript).
+Action Various UI visibility-toggling actions.
\end_layout
\begin_layout Description
-Syntax buffer-update [<FORMAT>]
+Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
\end_layout
\begin_layout Description
-Params <FORMAT>: The format to display, where this is one of the formats
- defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
- If no format is given, the default format as specified in the same dialog
- is used.
+Params statusbar : Toggle visibility of the statusbar.
+\begin_inset Newline newline
+\end_inset
+
+menubar : Toggle visibility of the menubar.
+\begin_inset Newline newline
+\end_inset
+
+scrollbar : Toggle visibility of the scrollbar.
+\begin_inset Newline newline
+\end_inset
+
+frame : Toggle visibility of the frames around editing window.
+\begin_inset Newline newline
+\end_inset
+
+fullscreen : Toggle fullscreen mode.
+ This also covers calling the previous functions.
+ However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
+ be used.
\end_layout
\begin_layout Description
-Origin Dekel, 5 Aug 2000
+Origin sanda, 9 Feb 2007
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_WRITE
+view-close
\end_layout
\begin_layout Description
-Action Saves the current buffer.
+Action Close the current document work area.
\end_layout
\begin_layout Description
-Notion Saves the current buffer to disk, using the filename that is already
- associated with the buffer, asking for one if none is yet assigned.
+Notion Close the current work area.
+ If no other work areas are showing the buffer, then close the associated
+ buffer as well.
\end_layout
\begin_layout Description
-Syntax buffer-write
+Syntax view-close
+\end_layout
+
+\begin_layout Description
+Origin Tommaso, 15 Sep 2012
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_WRITE_AS
+view-split
\end_layout
\begin_layout Description
-Action Rename and save current buffer.
+Action Creates another split view of current buffer.
\end_layout
\begin_layout Description
-Syntax buffer-write-as <FILENAME>
+Notion All split views act in the same way independently.
\end_layout
\begin_layout Description
-Params <FILENAME>: New name of the buffer/file.
- A relative path is with respect to the original location of the buffer/file.
+Syntax view-split <vertical|horizontal>
+\end_layout
+
+\begin_layout Description
+Params horizontal : The work areas are laid out side by side.
+\begin_inset Newline newline
+\end_inset
+
+vertical : The work areas laid out vertically.
+\end_layout
+
+\begin_layout Description
+Origin Abdel, 20 Feb 2008
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_WRITE_ALL
+window-close
\end_layout
\begin_layout Description
-Action Save all changed documents.
+Action Closes the current LyX window.
\end_layout
\begin_layout Description
-Syntax buffer-write-all
+Syntax window-close
\end_layout
\begin_layout Description
-Origin rgh, gpothier 6 Aug 2007
+Origin Abdel, 23 Oct 2006
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_NEXT
+window-new
\end_layout
\begin_layout Description
-Action Switch to the next opened document.
+Action Creates new empty LyX window.
\end_layout
\begin_layout Description
-Notion Note that this does not necessarily mean next in tabbar (for full
- list see View menu).
+Notion Already opened documents from the previous window can be found under
+ View menu.
\end_layout
\begin_layout Description
-Syntax buffer-next
+Syntax window-new [<GEOMETRY>]
\end_layout
-\begin_layout Subsection*
-LFUN_BUFFER_PREVIOUS
+\begin_layout Description
+Params <GEOMETRY>: pass the geometry of the window.
+ This parameter is currently accepted only on Windows platform.
\end_layout
\begin_layout Description
-Action Switch to the previous opened document.
+Origin Abdel, 21 Oct 2006
\end_layout
-\begin_layout Description
-Syntax buffer-previous
+\begin_layout Section
+System Functions (Preferences, LyX Server etc.)
\end_layout
\begin_layout Subsection*
-LFUN_MASTER_BUFFER_UPDATE
+buffer-toggle-output-sync
\end_layout
\begin_layout Description
-Action When run from a child document, this updates (exports) document built
- from the master buffer, if available.
+Action Toggles including of resources for forward/reverse search of the
+ given document.
\end_layout
\begin_layout Description
-Syntax master-buffer-update [<FORMAT>]
+Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
+ is used for DVI.
+ Custom LaTeX macro can be defined in preferences.
\end_layout
\begin_layout Description
-Params <FORMAT>: The format to display, where this is one of the formats
- defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
- If no format is given, the default format as specified in the same dialog
- is used.
+Syntax buffer-toggle-output-sync
\end_layout
\begin_layout Description
-Origin Tommaso, 20 Sep 2007
+Origin sanda, 25 May 2010
\end_layout
\begin_layout Subsection*
-LFUN_MASTER_BUFFER_VIEW
+call
\end_layout
\begin_layout Description
-Action When run from a child document, this command shows a preview built
- from the master buffer, if available.
+Action Executes a command defined in a .def file.
\end_layout
\begin_layout Description
-Syntax master-buffer-view [<FORMAT>]
-\end_layout
+Notion The definitions are by default read from lib/commands/default.def.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Params <FORMAT>: The format to display, where this is one of the formats
- defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
- If no format is given, the default format as specified in the same dialog
- is used.
+A .def file allows to define a command with
+\backslash
+define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
+ <LFUN> is the lfun code to be executed (see e.g.
+ LFUN_COMMAND_SEQUENCE).
+
+\backslash
+def_file "FileName" allows to include another .def file.
+\begin_inset Newline newline
+\end_inset
+
+This is particularly useful in connection with toolbar buttons: Since the
+ name of the button image for this lfun is lib/images/commands/<NAME>.png
+ this is the way to assign an image to a complex command-sequence.
\end_layout
\begin_layout Description
-Origin Tommaso, 20 Sep 2007
+Syntax call <NAME>
\end_layout
-\begin_layout Subsection*
-LFUN_BUFFER_LANGUAGE
+\begin_layout Description
+Params <NAME>: Name of the command that must be called.
\end_layout
\begin_layout Description
-Action Set language of the current document.
+Origin broider, 2 Oct 2007
\end_layout
-\begin_layout Description
-Syntax buffer-language <LANG>
+\begin_layout Subsection*
+cancel
\end_layout
\begin_layout Description
-Params <LANG>: language name.
- See lib/languages for list.
+Action Cancels sequence prepared by LFUN_META_PREFIX .
\end_layout
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Syntax cancel
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_SAVE_AS_DEFAULT
+command-alternatives
\end_layout
\begin_layout Description
-Action Save the current document settings as default.
+Action Runs the first listed command that is enabled.
\end_layout
\begin_layout Description
-Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
+Notion This can be used to bind multiple functions to a single key, and
+ then which one is used will depend upon the context.
\end_layout
\begin_layout Description
-Syntax buffer-save-as-default [<ARGS>]
+Syntax command-alternatives <CMDS>
\end_layout
\begin_layout Description
-Params <ARGS>: contains the particular settings to be saved.
- They obey the syntax you can find in document header of usual .lyx file.
+Params <CMDS>: Sequence of commands separated by semicolons.
\end_layout
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Sample command-alternatives completion-accept;cell-forward
+\end_layout
+
+\begin_layout Description
+Origin rgh, 24 September 2008
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_PARAMS_APPLY
+command-sequence
\end_layout
\begin_layout Description
-Action Apply the given settings to the current document.
+Action Run more commands (LFUN and its parameters) in a sequence.
\end_layout
\begin_layout Description
-Syntax buffer-params-apply [<ARGS>]
+Syntax command-sequence <CMDS>
\end_layout
\begin_layout Description
-Params <ARGS>: contains the particular settings to be saved.
- They obey the syntax you can find in document header of usual .lyx file.
+Params <CMDS>: Sequence of commands separated by semicolons.
\end_layout
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Sample command-sequence cut; ert-insert; self-insert
+\backslash
+; paste; self-insert {}; inset-toggle;
+\end_layout
+
+\begin_layout Description
+Origin Andre, 11 Nov 1999
\end_layout
\begin_layout Subsection*
-LFUN_FILE_INSERT
+cursor-follows-scrollbar-toggle
\end_layout
\begin_layout Description
-Action Inserts another LyX file.
+Action Determine whether to keep cursor inside the editing window regardless
+ of the scrollbar movement.
\end_layout
\begin_layout Description
-Syntax file-insert [<FILE>]
+Syntax toggle-cursor-follows-scrollbar
\end_layout
\begin_layout Description
-Params <FILE>: Filename to be inserted.
+Origin ARRae, 2 Dec 1997
\end_layout
\begin_layout Subsection*
-LFUN_FILE_INSERT_PLAINTEXT
+debug-level-set
\end_layout
\begin_layout Description
-Action Inserts plain text file.
+Action Set debug output level.
\end_layout
\begin_layout Description
-Syntax file-insert-plaintext [<FILE>]
+Syntax debug-level-set <LEVEL>
\end_layout
\begin_layout Description
-Params <FILE>: Filename to be inserted.
+Params <LEVEL>: comma separated list of levels or the correspondent number
+ of their combination.
+ 0 is equivalent to disabling all debug events.
+ See lyx -dbg for the current list of debug levels and their numbers.
\end_layout
\begin_layout Description
-Origin CFO-G, 19 Nov 1997
+Origin sanda, 28 Dec 2009
\end_layout
\begin_layout Subsection*
-LFUN_FILE_INSERT_PLAINTEXT_PARA
+devel-mode-toggle
\end_layout
\begin_layout Description
-Action Inserts plain text file as paragraph (i.e.
- join lines).
+Action toggle a mode where more information is given in UI
\end_layout
\begin_layout Description
-Syntax file-insert-plaintext-para [<FILE>]
+Notion in so called "devel" mode, the information given in the status bar
+ is more precise, and the help documents are open in editing mode.
\end_layout
\begin_layout Description
-Params <FILE>: Filename to be inserted.
+Syntax devel-mode-toggle
\end_layout
\begin_layout Description
-Origin Levon, 14 Feb 2001
+Origin lasgouttes, 23 Jul 2017
\end_layout
\begin_layout Subsection*
-LFUN_FILE_OPEN
+forward-search
\end_layout
\begin_layout Description
-Action Open LyX document.
+Action Sets the cursor position in the previewed (dvi/pdf) file based on
+ the row number in LyX window.
\end_layout
\begin_layout Description
-Syntax file-open [<FILE>]
+Notion The external program used for forward search call can be specified
+ in LyX Output preferences.
+ See Additional manual for details of these settings.
\end_layout
\begin_layout Description
-Params <FILE>: Filename to be opened.
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CALL
+Syntax forward-search
\end_layout
\begin_layout Description
-Action Executes a command defined in a .def file.
+Origin sanda, 14 Apr 2010
\end_layout
-\begin_layout Description
-Notion The definitions are by default read from lib/commands/default.def.
-\begin_inset Newline newline
-\end_inset
-
-A .def file allows to define a command with
-\backslash
-define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
- <LFUN> is the lfun code to be executed (see e.g.
- LFUN_COMMAND_SEQUENCE).
-
-\backslash
-def_file "FileName" allows to include another .def file.
-\begin_inset Newline newline
-\end_inset
-
-This is particularly useful in connection with toolbar buttons: Since the
- name of the button image for this lfun is lib/images/commands/<NAME>.png
- this is the way to assign an image to a complex command-sequence.
+\begin_layout Subsection*
+lyxrc-apply
\end_layout
\begin_layout Description
-Syntax call <NAME>
+Action Apply the given settings to user preferences.
\end_layout
\begin_layout Description
-Params <NAME>: Name of the command that must be called.
+Syntax lyxrc-apply <SETTINGS>
\end_layout
\begin_layout Description
-Origin broider, 2 Oct 2007
+Params <SETTINGS>: settings which are to be set.
+ Take a look into ~/.lyx/preferences to get an idea which commands to use
+ and their syntax.
+ lyx::LyXRC::LyXRCTags has the list of possible commands.
\end_layout
\begin_layout Subsection*
-LFUN_META_PREFIX
+message
\end_layout
\begin_layout Description
-Action Simulate halting Meta key (Alt key on PCs).
+Action Shows message in statusbar (for script purposes).
\end_layout
\begin_layout Description
-Notion Used for buffer editation not for GUI control.
+Syntax message <STRING>
\end_layout
\begin_layout Description
-Syntax meta-prefix
+Origin Lgb, 8 Apr 2001
\end_layout
\begin_layout Subsection*
-LFUN_CANCEL
+meta-prefix
\end_layout
\begin_layout Description
-Action Cancels sequence prepared by LFUN_META_PREFIX .
+Action Simulate halting Meta key (Alt key on PCs).
\end_layout
\begin_layout Description
-Syntax cancel
+Notion Used for buffer edition not for GUI control.
+\end_layout
+
+\begin_layout Description
+Syntax meta-prefix
\end_layout
\begin_layout Subsection*
-LFUN_COMMAND_EXECUTE
+preferences-save
\end_layout
\begin_layout Description
-Action Switches the focus to the minibuffer so that the user can type in
- there.
- If necessary, it opens the minibuffer toolbar.
+Action Save user preferences.
\end_layout
\begin_layout Description
-Notion Usually bound to M-x shortcut.
+Syntax preferences-save
\end_layout
\begin_layout Description
-Syntax command-execute
+Origin Lgb, 27 Nov 1999
\end_layout
\begin_layout Subsection*
-LFUN_COMMAND_PREFIX
+reconfigure
\end_layout
\begin_layout Description
-Action Return the current key sequence and available options as a string.
+Action Reconfigure the automatic settings.
\end_layout
\begin_layout Description
-Notion No options are added if no current map exists.
-\begin_inset Newline newline
-\end_inset
-
-This is probably usable only with connection to lyxserver.
+Syntax reconfigure
\end_layout
\begin_layout Description
-Syntax command-prefix
+Origin Asger, 14 Feb 1997
\end_layout
\begin_layout Subsection*
-LFUN_COMMAND_SEQUENCE
+server-get-filename
\end_layout
\begin_layout Description
-Action Run more commands (LFUN and its parameters) in a sequence.
+Action Returns path and file name of the currently edited document.
\end_layout
\begin_layout Description
-Syntax command-sequence <CMDS>
+Syntax server-get-filename
\end_layout
-\begin_layout Description
-Params <CMDS>: Sequence of commands separated by semicolons.
+\begin_layout Subsection*
+server-get-layout
\end_layout
\begin_layout Description
-Sample command-sequence cut; ert-insert; self-insert
-\backslash
-; paste; self-insert {}; inset-toggle;
+Action Returns the current layout (that is environment) name on the cursor
+ position.
\end_layout
\begin_layout Description
-Origin Andre, 11 Nov 1999
+Syntax server-get-layout
\end_layout
\begin_layout Subsection*
-LFUN_COMMAND_ALTERNATIVES
+server-get-statistics
\end_layout
\begin_layout Description
-Action Runs the first listed command that is enabled.
+Action Returns the statistics (number of words and characters) in the document
+ or in the given selection.
\end_layout
\begin_layout Description
-Notion This can be used to bind multiple functions to a single key, and
- then which one is used will depend upon the context.
+Notion Note that this function gives the number of words/chars written,
+ not the number of characters which will be typeset.
\end_layout
\begin_layout Description
-Syntax command-alternatives <CMDS>
+Syntax server-get-statistics [<TYPE>]
\end_layout
\begin_layout Description
-Params <CMDS>: Sequence of commands separated by semicolons.
-\end_layout
+Params <TYPE>: <words|chars|chars-space> The requested count; if not specified,
+ the three values are returned, separated by a space.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Sample command-alternatives completion-accept;cell-forward
+words: count words.
+\begin_inset Newline newline
+\end_inset
+
+chars: count characters.
+\begin_inset Newline newline
+\end_inset
+
+chars-space: count characters and spaces.
\end_layout
\begin_layout Description
-Origin rgh, 24 September 2008
+Origin brokenclock, Oct 10 2014
\end_layout
\begin_layout Subsection*
-LFUN_MESSAGE
-\end_layout
-
-\begin_layout Description
-Action Shows message in statusbar (for script purposes).
+server-get-xy
\end_layout
\begin_layout Description
-Syntax message <STRING>
+Action Returns the coordinates of cursor position in the editing area.
\end_layout
\begin_layout Description
-Origin Lgb, 8 Apr 2001
+Syntax server-get-xy
\end_layout
\begin_layout Subsection*
-LFUN_DEBUG_LEVEL_SET
-\end_layout
-
-\begin_layout Description
-Action Set debug output level.
+server-goto-file-row
\end_layout
\begin_layout Description
-Syntax debug-level-set <LEVEL>
+Action Sets the cursor position in LyX based on the row number of generated
+ TeX file.
\end_layout
\begin_layout Description
-Params <LEVEL>: comma separated list of levels or the correspondent number
- of their combination.
- 0 is equivalent to disabling all debug events.
- See lyx -dbg for the current list of debug levels and their numbers.
+Notion This can be useful for DVI inverse-search or detection of the problematic
+ line from LaTeX compilation.
+ Note that before this function can be used export to LaTeX output must
+ occur (in order to map the row numbers).
\end_layout
\begin_layout Description
-Origin sanda, 28 Dec 2009
-\end_layout
-
-\begin_layout Subsection*
-LFUN_PREFERENCES_SAVE
+Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
\end_layout
\begin_layout Description
-Action Save user preferences.
-\end_layout
+Params <FILE>: the path and filename.
+ Environment variables are expanded in the path.
+ In case this LFUN does not work make sure you are giving correct path to
+ the file.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax preferences-save
-\end_layout
+If the file is located inside LyX temporary directory it will be mapped
+ back into the appropriate opened buffer (e.g.
+ for the case of generated .tex file).
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Origin Lgb, 27 Nov 1999
-\end_layout
+.ext: extensions will be automatically replaced by .lyx.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_RECONFIGURE
+<ROW_NUMBER> The row number of the LaTeX file to which to go.
\end_layout
\begin_layout Description
-Action Reconfigure the automatic settings.
-\end_layout
+Sample server-goto-file-row /home/user/example.lyx 41
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax reconfigure
+server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
\end_layout
\begin_layout Description
-Origin Asger, 14 Feb 1997
+Origin Edmar, 23 Dec 1998
\end_layout
\begin_layout Subsection*
-LFUN_LYXRC_APPLY
+server-notify
\end_layout
\begin_layout Description
-Action Apply the given settings to user preferences.
+Action Sends notify message about the last key-sequence to client.
\end_layout
\begin_layout Description
-Syntax lyxrc-apply <SETTINGS>
+Notion This can be used to grab last key-sequence used inside the LyX window.
+ See also Debug extensions section in Additional features manual.
\end_layout
\begin_layout Description
-Params <SETTINGS>: settings which are to be set.
- Take a look into ~/.lyx/preferences to get an idea which commands to use
- and their syntax.
- lyx::LyXRC::LyXRCTags has the list of possible commands.
+Syntax server-notify
\end_layout
\begin_layout Subsection*
-LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
-\end_layout
-
-\begin_layout Description
-Action Determine whether keep cursor inside the editing window regardless
- the scrollbar movement.
+server-set-xy
\end_layout
\begin_layout Description
-Syntax toggle-cursor-follows-scrollbar
+Action Sets the cursor position based on the editing area coordinates (similar
+ to clicking on that point with left mouse button).
\end_layout
\begin_layout Description
-Origin ARRae, 2 Dec 1997
+Syntax server-set-xy <X> <Y>
\end_layout
\begin_layout Subsection*
-LFUN_SET_COLOR
+set-color
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_STATISTICS
+statistics
\end_layout
\begin_layout Description
Action Count the statistics (number of words and characters) in the document
- or in the given selection.
+ or in the given selection and display it in a dialog box.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_COMPLETION_INLINE
+vc-check-in
\end_layout
\begin_layout Description
-Action Show the inline completion at the cursor position.
+Action Checks-in/commits the changes of the registered file to the repository.
\end_layout
\begin_layout Description
-Syntax completion-inline
+Notion In RCS case this also unlocks the file.
\end_layout
\begin_layout Description
-Origin sts, Feb 19 2008
+Syntax vc-check-in
+\end_layout
+
+\begin_layout Description
+Origin Lgb, 1 Jul 1997
\end_layout
\begin_layout Subsection*
-LFUN_COMPLETION_POPUP
+vc-check-out
\end_layout
\begin_layout Description
-Action Show the completion popup at the cursor position.
+Action Checks-out the document for edit (and locks it in some cases).
\end_layout
\begin_layout Description
-Syntax completion-popup
+Syntax vc-check-out
\end_layout
\begin_layout Description
-Origin sts, Feb 19 2008
+Origin Lgb, 1 Jul 1997
\end_layout
\begin_layout Subsection*
-LFUN_COMPLETION_COMPLETE
+vc-command
\end_layout
\begin_layout Description
-Action Try to complete the word or command at the cursor position.
+Action Executes external command.
+ This command is intended to support additional VCS commands.
\end_layout
\begin_layout Description
-Syntax complete
+Syntax vc-command <FLAG> <PATH> <COMMAND>
\end_layout
\begin_layout Description
-Origin sts, Feb 19 2008
-\end_layout
+Params <FLAG>: Flags for the command can be combined together.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_COMPLETION_CANCEL
-\end_layout
+U - dUmmy - no flags
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Try to cancel completion, either the popup or the inline completion.
+D - Doc - need document loaded to proceed
+\begin_inset Newline newline
+\end_inset
+
+I - dIrty - mark document dirty
+\begin_inset Newline newline
+\end_inset
+
+R - Reload - ensure that the document is saved and reload it after command
+ execution
+\begin_inset Newline newline
+\end_inset
+
+M - Message - ask for input string (commit message)
+\begin_inset Newline newline
+\end_inset
+
+<PATH>: path where to start.
+ $$p will be replaced by the current document path.
+\begin_inset Newline newline
+\end_inset
+
+<COMMAND>: command to execute.
+ $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
+essage.
\end_layout
\begin_layout Description
-Syntax completion-cancel
+Sample vc-command DR $$p "svn up"
\end_layout
\begin_layout Description
-Origin sts, Sep 07 2008
+Origin sanda, 13 Jan 2009
\end_layout
\begin_layout Subsection*
-LFUN_COMPLETION_ACCEPT
+vc-compare
\end_layout
\begin_layout Description
-Action Accept suggested completion.
+Action Compares two revisions of the same file under version control.
\end_layout
\begin_layout Description
-Syntax completion-accept
+Syntax vc-compare [<REV1>] [<REV2>]
\end_layout
\begin_layout Description
-Origin sanda, Sep 08 2008
-\end_layout
+Params Revision number either points directly to commit in history or if
+ negative number -x it points to (last commit - x).
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_BRANCH_ADD
-\end_layout
+ In RCS we subtract only in the last number of revision specification.
+ Special case "0" is reserved for the last committed revision.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Add a branch to the buffer's BranchList.
-\end_layout
+<REV1>: Older file.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax branch-add <BRANCH>
+ <REV2>: Newer file.
+ Used only if REV1 > 0.
+\begin_inset Newline newline
+\end_inset
+
+If no parameter is given, interactive dialog will be shown.
\end_layout
\begin_layout Description
-Params <BRANCH>: Name of the branch to add
+Sample Compare current document against last commit
+\begin_inset Newline newline
+\end_inset
+
+ vc-compare 0
+\begin_inset Newline newline
+\end_inset
+
+Compare current document against current revision - 5 commits
+\begin_inset Newline newline
+\end_inset
+
+ vc-compare -5
+\begin_inset Newline newline
+\end_inset
+
+Compare revisions 120 and 155
+\begin_inset Newline newline
+\end_inset
+
+ vc-compare 120 155
\end_layout
\begin_layout Description
-Origin spitz, 7 Jul 2009
+Origin sanda, 12 Feb 2010
\end_layout
\begin_layout Subsection*
-LFUN_BRANCH_ACTIVATE
+vc-copy
\end_layout
\begin_layout Description
-Action Activate the branch.
+Action Copies the document to another name.
\end_layout
\begin_layout Description
-Syntax branch-activate <BRANCH>
+Notion Copying with revision history is only supported by SVN.
+ For RCS and CVS it is simulated by adding the document under a new name.
+ Disabled if uncommitted changes exist.
\end_layout
\begin_layout Description
-Params <BRANCH>: The branch to activate
+Syntax vc-copy <FILENAME>
\end_layout
\begin_layout Description
-Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
+Params <FILENAME>: New name of the document.
\begin_inset Newline newline
\end_inset
-could be used to export a pdf with the answers branch included without one's
- having to open LyX and activate the branch manually.
+A file dialog is opened if no filename is given.
\end_layout
\begin_layout Description
-Origin rgh, 27 May 2008
+Origin gb, 05 Feb 2013
\end_layout
\begin_layout Subsection*
-LFUN_BRANCH_DEACTIVATE
+vc-locking-toggle
\end_layout
\begin_layout Description
-Action De-activate the branch.
+Action Toggles the locking property of the edited file.
\end_layout
\begin_layout Description
-Syntax branch-deactivate <BRANCH>
+Notion This is currently implemented only for SVN.
\end_layout
\begin_layout Description
-Params <BRANCH>: The branch to deactivate
+Syntax vc-locking-toggle
\end_layout
\begin_layout Description
-Origin rgh, 27 May 2008
+Origin sanda, 25 Jun 2009
\end_layout
\begin_layout Subsection*
-LFUN_BRANCHES_RENAME
+vc-register
\end_layout
\begin_layout Description
-Action Rename all branches of a given name in a document.
+Action Register the document as an file inside version control system.
\end_layout
\begin_layout Description
-Syntax branches-rename <OLDNAME> <NEWNAME>
+Notion File is registered inside cvs, svn or rcs repository acording to
+ the existence of cvs/svn/rcs entries in the document's directory.
+\begin_inset Newline newline
+\end_inset
+
+See LyX Additional Features Manual (Version Control Chapter) for additional
+ information.
\end_layout
\begin_layout Description
-Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
- name of the branch
+Syntax vc-register
\end_layout
\begin_layout Description
-Origin spitz, 9 Jul 2009
+Origin Lgb, 1 Jul 1997
\end_layout
\begin_layout Subsection*
-LFUN_BRANCH_ADD_INSERT
+vc-rename
\end_layout
\begin_layout Description
-Action Create new branch and directly put the branch inset into the document.
+Action Renames the document to another name.
\end_layout
\begin_layout Description
-Syntax branch-add-insert [<NAME>]
+Notion Renaming with revision history is only supported by SVN.
+ For CVS it is simulated by adding the document under a new name and deleting
+ the old one.
+ For RCS it is not supported.
+ Disabled if uncommitted changes exist.
\end_layout
\begin_layout Description
-Params <NAME>: Branch name.
- If it is not specified, you will be asked.
+Syntax vc-rename <FILENAME>
\end_layout
\begin_layout Description
-Origin sanda, 10 Jul 2009
-\end_layout
+Params <FILENAME>: New name of the document.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_LABEL_COPY_AS_REF
+A file dialog is opened if no filename is given.
\end_layout
\begin_layout Description
-Action Copies the label at the cursor as a cross-reference to be pasted
- elsewhere.
+Origin gb, 05 Feb 2013
+\end_layout
+
+\begin_layout Subsection*
+vc-repo-update
\end_layout
\begin_layout Description
-Syntax copy-label-as-reference <LABEL>
+Action Update the local archive directory in which resides the current document
+ with the remote repository.
\end_layout
\begin_layout Description
-Params <LABEL>: The label to copy (for multi-line math)
+Syntax vc-repo-update
\end_layout
\begin_layout Description
-Origin sts, 16 Nov 2008
+Origin sanda, 16 Oct 2009
\end_layout
\begin_layout Subsection*
-LFUN_LABEL_INSERT_AS_REF
+vc-revert
\end_layout
\begin_layout Description
-Action Inserts the label as a cross-reference at the position of the cursor.
+Action Reverts the document to the last check-in/commit in VCS.
\end_layout
\begin_layout Description
-Syntax label-insert-as-reference
+Syntax vc-revert
\end_layout
\begin_layout Description
-Origin vfr, 7 Apr 2009
+Origin Lgb, 1 Jul 1997
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_ZOOM_IN
+vc-undo-last
\end_layout
\begin_layout Description
-Action Increases the zoom of the screen fonts.
+Action Undo last check-in.
\end_layout
\begin_layout Description
-Syntax buffer-zoom-in [<ZOOM>]
+Notion This is currently implemented only for RCS.
\end_layout
\begin_layout Description
-Params <ZOOM>: The zoom in %, the default is 20.
+Syntax vc-check-out
\end_layout
\begin_layout Description
-Origin vfr, 30 Mar 2009
+Origin Lgb, 1 Jul 1997
+\end_layout
+
+\begin_layout Section
+Hidden Functions (not listed for configuration)
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_ZOOM_OUT
+command-prefix
\end_layout
\begin_layout Description
-Action Decreases the zoom of the screen fonts.
+Action Return the current key sequence and available options as a string.
\end_layout
\begin_layout Description
-Syntax buffer-zoom-out [<ZOOM>]
+Notion No options are added if no current map exists.
+\begin_inset Newline newline
+\end_inset
+
+This is probably usable only with connection to lyxserver.
\end_layout
\begin_layout Description
-Params <ZOOM>: The zoom in %, the default is 20.
+Syntax command-prefix
+\end_layout
+
+\begin_layout Subsection*
+lyx-activate
\end_layout
\begin_layout Description
-Origin vfr, 30 Mar 2009
+Action Activates the LyX window.
\end_layout
-\begin_layout Subsection*
-LFUN_INSET_COPY_AS
+\begin_layout Description
+Notion On Linux and Mac OS, this action brings the LyX window into focus.
+ Such behavior is not allowed by Windows OS so instead the color of the
+ taskbar entry is changed to indicate that the window has changed in some
+ way.
+ This action is useful in combination with reverse search.
\end_layout
\begin_layout Description
-Action Copies the inset to the clipboard as a certain type.
+Syntax lyx-activate
\end_layout
\begin_layout Description
-Notion Currently used only for InsetInfo where its content is copied as
- a text.
+Origin skostysh, 4 Aug 2016
+\end_layout
+
+\begin_layout Subsection*
+self-insert
\end_layout
\begin_layout Description
-Syntax inset-copy-as
+Action Inserts the given string (accordingly to the correct keymap).
\end_layout
\begin_layout Description
-Origin vfr, 18 Apr 2010
+Notion Automatically replace the currently selected text.
+ Depends on lyxrc settings "auto_region_delete".
+\end_layout
+
+\begin_layout Description
+Syntax self-insert <STRING>
\end_layout
\end_body
projects / lyx.git / blobdiff