\lyxformat 345
\begin_document
\begin_header
-\textclass amsart
+\textclass article
+\begin_preamble
+\renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
+\renewenvironment{description}{\list{}{%
+ \setlength{\itemsep}{-2pt}
+ \advance\leftmargini6\p@ \itemindent-12\p@
+ \labelwidth\z@ \let\makelabel\descriptionlabel}%
+}{
+ \endlist
+}
+\end_preamble
\use_default_options false
-\begin_modules
-theorems-ams
-\end_modules
\language english
\inputencoding auto
\font_roman default
\graphics default
\paperfontsize default
+\spacing single
\use_hyperref false
\papersize default
\use_geometry true
\begin_body
\begin_layout Section*
-LFUNs documentation automatically generated 2009-06-12
+LFUNs documentation automatically generated 2011-03-04
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Subsection*
-LFUN_OPTIONAL_INSERT
+LFUN_ARGUMENT_INSERT
\end_layout
\begin_layout Description
-Action Inserts an optional-argument (short title) inset.
+Action Inserts an argument (short title) inset.
\end_layout
\begin_layout Description
-Syntax optional-insert
+Syntax argument-insert
\end_layout
\begin_layout Description
Origin vermeer, 12 Aug 2002
\end_layout
-\begin_layout Subsection*
-LFUN_LINE_INSERT
-\end_layout
-\begin_layout Description
-Action Inserts a horizontal line.
-\end_layout
-\begin_layout Description
-Syntax line-insert
-\end_layout
-\begin_layout Description
-Origin Andre, Oct 27 2003
-\end_layout
-
\begin_layout Subsection*
LFUN_NEWPAGE_INSERT
\end_layout
Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
\end_layout
+\begin_layout Subsection*
+LFUN_PREVIEW_INSERT
+\end_layout
+\begin_layout Description
+Action Inserts a new preview inset.
+\end_layout
+\begin_layout Description
+Syntax preview-insert
+\end_layout
+\begin_layout Description
+Origin vfr, 28 Mar 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_TAB_INSERT
\end_layout
Syntax info-insert <TYPE> <ARG>
\end_layout
\begin_layout Description
-Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
+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: name of lfun used in toolbar
+\begin_inset Newline newline
+\end_inset
+
+ buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
\end_layout
\begin_layout Description
Sample command-sequence info-insert buffer path; info-insert buffer name
For dissolving the element see LFUN_INSET_DISSOLVE.
\end_layout
\begin_layout Description
-Syntax flex-insert <TYPE:Name>
+Syntax flex-insert Name
\end_layout
\begin_layout Description
-Params TYPE: CharStyle|Custom|Element|Standard
-\begin_inset Newline newline
-\end_inset
-
-Identifies whether this is a Character Style, a Custom Inset or an XML Element, and which dynamical sub-menu this flex inset is in on the LyX menu tree. If Standard (currently unused): none of these.
-\begin_inset Newline newline
-\end_inset
-
-Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
+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
-Sample flex-insert CharStyle:Code
+Sample flex-insert Code
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Subsection*
-LFUN_TOC_INSERT
+LFUN_SCRIPT_INSERT
\end_layout
\begin_layout Description
-Action Inserts table of contents.
+Action Inserts a subscript or superscript inset.
\end_layout
\begin_layout Description
-Syntax toc-insert
+Syntax script-insert <TYPE>
\end_layout
\begin_layout Description
-Origin Lgb, 27 May 97
+Params <TYPE>: subscript|superscript
+\end_layout
+\begin_layout Description
+Origin Georg, 23 Nov 2010
\end_layout
\begin_layout Subsection*
Syntax note-next
\end_layout
-\begin_layout Subsection*
-LFUN_NOTES_MUTATE
-\end_layout
-\begin_layout Description
-Action Changes all Note insets of a particular type (source) to a different type (target) fot the current document.
-\end_layout
-\begin_layout Description
-Syntax notes-mutate <SOURCE> <TARGET>
-\end_layout
-\begin_layout Description
-Params <SOURCE/TARGET>: Note|Comment|Greyedout
-\end_layout
-\begin_layout Description
-Origin sanda, 18 Jun 2008
-\end_layout
-
\begin_layout Subsection*
LFUN_PHANTOM_INSERT
\end_layout
LFUN_ESCAPE
\end_layout
\begin_layout Description
-Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD.
+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 escape
Syntax word-replace [<DATA>]
\end_layout
\begin_layout Description
-Params <DATA>: data is of the form "<search>
+Params <DATA>: data is of the form "<replace>
\begin_inset Newline newline
\end_inset
-<replace>
+<search>
\begin_inset Newline newline
\end_inset
Syntax word-lowcase
\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.
+\end_layout
+\begin_layout Description
+Syntax spelling-add [<STRING>] [<LANG>]
+\end_layout
+\begin_layout Description
+Params <WORD>: word to add <LANG>: language name (see file languages)
+\end_layout
+\begin_layout Description
+Origin JSpitzm, 18 Jan 2010
+\end_layout
+
+\begin_layout Subsection*
+LFUN_SPELLING_IGNORE
+\end_layout
+\begin_layout Description
+Action Let the spell checker ignore the word under the cursor in the current session for the given language.
+\end_layout
+\begin_layout Description
+Syntax spelling-ignore [<WORD>] [<LANG>]
+\end_layout
+\begin_layout Description
+Params <WORD>: word to ignore <LANG>: language name (see file languages)
+\end_layout
+\begin_layout Description
+Origin JSpitzm, 18 Jan 2010
+\end_layout
+
+\begin_layout Subsection*
+LFUN_SPELLING_REMOVE
+\end_layout
+\begin_layout Description
+Action Remove the word under the cursor from the respective spell checker dictionary.
+\end_layout
+\begin_layout Description
+Syntax spelling-remove [<STRING>] [<LANG>]
+\end_layout
+\begin_layout Description
+Params <WORD>: word to remove <LANG>: language name (see file languages)
+\end_layout
+\begin_layout Description
+Origin SWitt, 28 July 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_THESAURUS_ENTRY
\end_layout
Origin lasgouttes, 16 Mar 2009
\end_layout
+\begin_layout Subsection*
+LFUN_INSET_SELECT_ALL
+\end_layout
+\begin_layout Description
+Action Selects all contents of an inset.
+\end_layout
+\begin_layout Description
+Syntax inset-select-all
+\end_layout
+\begin_layout Description
+Origin vfr, 22 Aug 2009
+\end_layout
+
+\begin_layout Subsection*
+LFUN_SECTION_SELECT
+\end_layout
+\begin_layout Description
+Action Selects the whole section.
+\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
+\begin_layout Description
+Origin vfr, 05 May 2009
+\end_layout
+
\begin_layout Subsection*
LFUN_LINE_BEGIN
\end_layout
Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
\end_layout
\begin_layout Description
-Origin baum, 10 Jul 2006
+Origin Georg, 10 Jul 2006
\end_layout
\begin_layout Subsection*
LFUN_PRIMARY_SELECTION_PASTE
\end_layout
\begin_layout Description
-Action Pastes the currently text selected text.
+Action Pastes the currently selected text.
\end_layout
\begin_layout Description
Notion Primary selection mechanism is linux-only thing.
LFUN_SELECTION_PASTE
\end_layout
\begin_layout Description
-Action Pastes the text in permanent selection.
+Action Pastes the the internal selection text in permanent selection.
+\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).
\end_layout
\begin_layout Description
Syntax selection-paste
\end_layout
+\begin_layout Description
+Origin lasgouttes, 14 Jan 2009
+\end_layout
\begin_layout Subsection*
LFUN_UNDO
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.
+\end_layout
+\begin_layout Description
Syntax math-insert <ARG>
\end_layout
\begin_layout Description
LFUN_MATH_SUPERSCRIPT
\end_layout
\begin_layout Description
-Action Enters subscript expression in math expression.
+Action Enters superscript expression in math expression.
\end_layout
\begin_layout Description
Syntax math-superscript
Sample math-matrix 3 3 bccc
\end_layout
+\begin_layout Subsection*
+LFUN_MATH_AMS_MATRIX
+\end_layout
+\begin_layout Description
+Action Inserts a matrix.
+\end_layout
+\begin_layout Description
+Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
+\end_layout
+\begin_layout Description
+Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
+\end_layout
+\begin_layout Description
+Sample math-ams-matrix 3 3 bmatrix
+\end_layout
+
\begin_layout Subsection*
LFUN_MATH_MODE
\end_layout
Syntax math-font-style <STYLE>
\end_layout
\begin_layout Description
-Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
+Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
+\begin_inset Newline newline
+\end_inset
+
+|textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
\end_layout
\begin_layout Description
Origin vfr, 9 jan 2009
Origin Dekel, 26 Aug 2000
\end_layout
-\begin_layout Subsection*
-LFUN_BREAK_PARAGRAPH
-\end_layout
-\begin_layout Description
-Action Breaks the current paragraph at the current location.
-\end_layout
-\begin_layout Description
-Syntax break-paragraph
-\end_layout
-
\begin_layout Subsection*
LFUN_BREAK_PARAGRAPH
\end_layout
<SPACING>:
\backslash
-paragraph_spacing default|single|onehalf|double|other
+paragraph_spacing default|single|onehalf|double|other SIZE
\begin_inset Newline newline
\end_inset
Action Inserts table into the document.
\end_layout
\begin_layout Description
+Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
+\end_layout
+\begin_layout Description
Syntax tabular-insert [<ROWS> <COLUMNS>]
\end_layout
\begin_layout Description
Origin Jug, 12 Apr 2000
\end_layout
-\begin_layout Subsection*
-LFUN_TABULAR_FEATURE
-\end_layout
-\begin_layout Description
-Action Sets various features to the table/cell on the current cursor position.
-\end_layout
-\begin_layout Description
-Notion Various math-environment features are handled here as well, e.g. add-vline-left/right for the Grid/Array environment
-\end_layout
-\begin_layout Description
-Syntax tabular-feature <FEATURE> [<ARG>]
-\end_layout
-\begin_layout Description
-Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| align-left|align-right|align-center|align-block|valign-top|valign-bottom| valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabular|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space|set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabular-valign-middle|tabular-valign-bottom
-\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 Jug, 28 Jul 2000
-\end_layout
-
\begin_layout Subsection*
LFUN_CELL_BACKWARD
\end_layout
LFUN_VC_REGISTER
\end_layout
\begin_layout Description
-Action Register the document as an file inside version control system (RCS, CVS).
+Action Register the document as an file inside version control system.
\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.
LFUN_VC_CHECK_OUT
\end_layout
\begin_layout Description
-Action Checks-out the document for edit (and locks it for RCS).
-\end_layout
-\begin_layout Description
-Notion This is implemented only for RCS and SVN, not CVS.
+Action Checks-out the document for edit (and locks it in some cases).
\end_layout
\begin_layout Description
Syntax vc-check-out
\begin_inset Newline newline
\end_inset
-<COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
+<COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
\end_layout
\begin_layout Description
Sample vc-command DR $$p "svn up"
Origin sanda, 13 Jan 2009
\end_layout
+\begin_layout Subsection*
+LFUN_VC_LOCKING_TOGGLE
+\end_layout
+\begin_layout Description
+Action Toggles the locking property of the edited file.
+\end_layout
+\begin_layout Description
+Notion This is currently implemented only for SVN.
+\end_layout
+\begin_layout Description
+Syntax vc-locking-toggle
+\end_layout
+\begin_layout Description
+Origin sanda, 25 Jun 2009
+\end_layout
+
+\begin_layout Subsection*
+LFUN_VC_REPO_UPDATE
+\end_layout
+\begin_layout Description
+Action Update the local archive directory in which resides the current document with the remote repository.
+\end_layout
+\begin_layout Description
+Syntax vc-repo-update
+\end_layout
+\begin_layout Description
+Origin sanda, 16 Oct 2009
+\end_layout
+
+\begin_layout Subsection*
+LFUN_VC_COMPARE
+\end_layout
+\begin_layout Description
+Action Compares two revisions of the same file under version control.
+\end_layout
+\begin_layout Description
+Syntax vc-compare [<REV1>] [<REV2>]
+\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.
+\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
+\end_layout
+\begin_layout Description
+Origin sanda, 12 Feb 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_CHANGES_TRACK
\end_layout
Action Rejects tracked change inside the selection.
\end_layout
\begin_layout Description
-Syntax change-accept
+Syntax change-reject
\end_layout
\begin_layout Description
Origin Levon, 16 Oct 2002
Syntax inset-insert <INSET> <ARGS>
\end_layout
\begin_layout Description
-Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|include|index|label|nomencl|vspace|ref|toc>
+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|script>
\begin_inset Newline newline
\end_inset
\begin_inset Newline newline
\end_inset
-prettyref -- Formatted reference
+formatted -- Formatted reference
\end_layout
\begin_layout Subsection*
LFUN_INSET_MODIFY
\end_layout
\begin_layout Description
-Action Modify existing inset.
+Action Modify some properties of an inset.
\end_layout
\begin_layout Description
-Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
+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.
\end_layout
\begin_layout Description
-Syntax inset-modify <INSET> <ARGS>
+Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
\end_layout
\begin_layout Description
-Params See LFUN_INSET_INSERT for further details.
-\end_layout
+Params Generally see LFUN_INSET_INSERT for further details.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_NEXT_INSET_MODIFY
-\end_layout
-\begin_layout Description
-Action Modify the inset at cursor position, if there is one.
-\end_layout
-\begin_layout Description
-Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
-\end_layout
-\begin_layout Description
-Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
-\end_layout
-\begin_layout Description
-Params See LFUN_INSET_INSERT for further details.
+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-column| 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-align-center|longtabular-align-right|m-align-left|m-align-right| m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn| set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth| set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| set-special-column|set-special-multicolumn|set-special-multirow| set-booktabs|unset-booktabs|set-top-space|set-bottom-space| set-interline-space|set-border-lines|tabular-valign-top| tabular-valign-middle|tabular-valign-bottom|set-tabular-width
+\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 JSpitzm, 23 Mar 2008
+Sample inset-modify note Note Comment
+\begin_inset Newline newline
+\end_inset
+
+ inset-modify changetype Ovalbox
\end_layout
\begin_layout Subsection*
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, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
+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| graphics|href|include|index|index_print|label|listings| note|phantom|ref|space|tabular|vspace|wrap>.
+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|space|tabular|vspace|wrap>.
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Subsection*
-LFUN_ALL_INSETS_TOGGLE
+LFUN_INSET_FORALL
\end_layout
\begin_layout Description
-Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
+Action Apply the given commands on insets of a given name.
\end_layout
\begin_layout Description
-Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
+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 10000. 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 all-insets-toggle [<STATE>] [<INSET>]
+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
-Params <STATE>: <toggle|open|close|assign> default: toggle
+Sample Remove all index insets:
+\begin_inset Newline newline
+\end_inset
+
+ inset-forall Index delete-char-forward
\begin_inset Newline newline
\end_inset
-<INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
+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 leeming, 30 Mar 2004
+Origin lasgouttes, 27 Nov 2009
+\end_layout
+
+\begin_layout Subsection*
+LFUN_GRAPHICS_RELOAD
+\end_layout
+\begin_layout Description
+Action Reloads the image if necessary.
+\end_layout
+\begin_layout Description
+Syntax graphics-reload
+\end_layout
+\begin_layout Description
+Origin vfr, 10 Aug 2009
\end_layout
\begin_layout Subsection*
Action Toggles visibility of a given toolbar between on/off/auto.
\end_layout
\begin_layout Description
-Notion Skiping "auto" when allowauto is false.
+Notion Skipping "auto" when allowauto is false.
\end_layout
\begin_layout Description
Syntax toolbar-toggle <NAME> [allowauto]
\end_layout
\begin_layout Description
-Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
+Params <NAME>: standard|extra|table|math|mathmacrotemplate|
+\begin_inset Newline newline
+\end_inset
+
+minibuffer|review|view/update|math_panels|vcs| view-others|update-others
\end_layout
\begin_layout Description
Origin Edwin, 21 May 2007
\begin_inset Newline newline
\end_inset
-document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
+compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
\begin_inset Newline newline
\end_inset
-href|include|index|index_print|info|label|listings|log|mathdelimiter|
+graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
\begin_inset Newline newline
\end_inset
LFUN_SERVER_GOTO_FILE_ROW
\end_layout
\begin_layout Description
-Action Sets the cursor position based on the row number of generated TeX file.
+Action Sets the cursor position in LyX based on the row number of generated TeX file.
\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 server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
\end_layout
\begin_layout Description
-Params <FILE>: the filename. Environment variables are expaned in the path. In case this LFUN does not work make sure you are giving correct path to the file.
+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.
+\end_layout
+\begin_layout Description
+Sample server-goto-file-row /home/user/example.lyx 41
\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). .ext: extensions will be automatically replaced by .lyx.
+server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
\end_layout
\begin_layout Description
Origin Edmar, 23 Dec 1998
\end_layout
+\begin_layout Subsection*
+LFUN_FORWARD_SEARCH
+\end_layout
+\begin_layout Description
+Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
+\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.
+\end_layout
+\begin_layout Description
+Syntax forward-search
+\end_layout
+\begin_layout Description
+Origin sanda, 14 Apr 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_SERVER_NOTIFY
\end_layout
Origin bpeng, 27 Apr 2006
\end_layout
+\begin_layout Subsection*
+LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
+\end_layout
+\begin_layout Description
+Action Toggles including of resources for forward/reverse search of the given document.
+\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.
+\end_layout
+\begin_layout Description
+Syntax buffer-toggle-output-sync
+\end_layout
+\begin_layout Description
+Origin sanda, 25 May 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_BUFFER_CLOSE
\end_layout
Syntax buffer-close
\end_layout
+\begin_layout Subsection*
+LFUN_BUFFER_CLOSE_ALL
+\end_layout
+\begin_layout Description
+Action Closes all buffers.
+\end_layout
+\begin_layout Description
+Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
+\end_layout
+\begin_layout Description
+Syntax buffer-close-all
+\end_layout
+
\begin_layout Subsection*
LFUN_BUFFER_EXPORT
\end_layout
LFUN_BUFFER_SWITCH
\end_layout
\begin_layout Description
-Action Switch to the given buffer.
-\end_layout
-\begin_layout Description
-Notion This is useful also in case you need simultaneously more views of the edited document in different LyX windows.
+Action Display/switch to the given buffer.
\end_layout
\begin_layout Description
-Syntax buffer-new-template <BUFFER>
+Syntax buffer-switch <BUFFER>
\end_layout
\begin_layout Description
-Params <BUFFER>: already opened document which is to be shown.
+Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
\end_layout
\begin_layout Subsection*
Action Toggle editing mode of the current document between read/write and read-only.
\end_layout
\begin_layout Description
-Notion In the ->Readonly mode checks-in/commits the data if the file is under version control. In the Readonly-> mode checkouts the data from repository.
-\begin_inset Newline newline
-\end_inset
-
-If these operations fail, buffer won't be toggled.
+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 buffer-toggle-read-only
LFUN_COMMAND_EXECUTE
\end_layout
\begin_layout Description
-Action Opens the minibuffer toolbar so that the user can type in there.
+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
Notion Usually bound to M-x shortcut.
Origin Lgb, 8 Apr 2001
\end_layout
+\begin_layout Subsection*
+LFUN_DEBUG_LEVEL_SET
+\end_layout
+\begin_layout Description
+Action Set debug output level.
+\end_layout
+\begin_layout Description
+Syntax debug-level-set <LEVEL>
+\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.
+\end_layout
+\begin_layout Description
+Origin sanda, 28 Dec 2009
+\end_layout
+
\begin_layout Subsection*
LFUN_PREFERENCES_SAVE
\end_layout
LFUN_COMPLETION_CANCEL
\end_layout
\begin_layout Description
-Action Try to cancel completion, either the popup or the inline completion
+Action Try to cancel completion, either the popup or the inline completion.
\end_layout
\begin_layout Description
Syntax completion-cancel
Origin sanda, Sep 08 2008
\end_layout
+\begin_layout Subsection*
+LFUN_BRANCH_ADD
+\end_layout
+\begin_layout Description
+Action Add a branch to the buffer's BranchList.
+\end_layout
+\begin_layout Description
+Syntax branch-add <BRANCH>
+\end_layout
+\begin_layout Description
+Params <BRANCH>: Name of the branch to add
+\end_layout
+\begin_layout Description
+Origin spitz, 7 Jul 2009
+\end_layout
+
\begin_layout Subsection*
LFUN_BRANCH_ACTIVATE
\end_layout
\begin_layout Description
-Action Activate the branch
+Action Activate the branch.
\end_layout
\begin_layout Description
Syntax branch-activate <BRANCH>
LFUN_BRANCH_DEACTIVATE
\end_layout
\begin_layout Description
-Action De-activate the branch
+Action De-activate the branch.
\end_layout
\begin_layout Description
Syntax branch-deactivate <BRANCH>
Origin rgh, 27 May 2008
\end_layout
+\begin_layout Subsection*
+LFUN_BRANCHES_RENAME
+\end_layout
+\begin_layout Description
+Action Rename all branches of a given name in a document.
+\end_layout
+\begin_layout Description
+Syntax branches-rename <OLDNAME> <NEWNAME>
+\end_layout
+\begin_layout Description
+Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
+\end_layout
+\begin_layout Description
+Origin spitz, 9 Jul 2009
+\end_layout
+
+\begin_layout Subsection*
+LFUN_BRANCH_ADD_INSERT
+\end_layout
+\begin_layout Description
+Action Create new branch and directly put the branch inset into the document.
+\end_layout
+\begin_layout Description
+Syntax branch-add-insert [<NAME>]
+\end_layout
+\begin_layout Description
+Params <NAME>: Branch name. If it is not specified, you will be asked.
+\end_layout
+\begin_layout Description
+Origin sanda, 10 Jul 2009
+\end_layout
+
\begin_layout Subsection*
LFUN_LABEL_COPY_AS_REF
\end_layout
\end_layout
\begin_layout Subsection*
-LFUN_SECTION_SELECT
+LFUN_INSET_COPY_AS
\end_layout
\begin_layout Description
-Action Selects the whole section.
+Action Copies the inset to the clipboard as a certain type.
\end_layout
\begin_layout Description
-Notion The cursor should be in a section heading before calling this lfun.
+Notion Currently used only for InsetInfo where its content is copied as a text.
\end_layout
\begin_layout Description
-Syntax section-select
+Syntax inset-copy-as
\end_layout
\begin_layout Description
-Origin vfr, 05 May 2009
+Origin vfr, 18 Apr 2010
\end_layout
\end_body
projects / lyx.git / blobdiff