\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-07-11
+LFUNs documentation automatically generated 2010-02-28
\end_layout
\begin_layout Standard
\begin_inset Newline newline
\end_inset
- buffer: "name"|"path"|"class"
+ 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
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
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_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
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
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
Origin Vermeer, 23 Mar 2006
\end_layout
-\begin_layout Subsection*
-LFUN_OUTLINE_DRAGMOVE
-\end_layout
-\begin_layout Description
-Action Moves the document section associated with the specified heading to a specified location. Both the heading and the target paragraph are specified by the paragraph ID numbers.
-\end_layout
-\begin_layout Description
-Notion The heading is a paragraph with style Part/Chapter/Section/ etc. Id number of the paragraph is not the sequential number seen on the screen, but an internal number that is unique for all opened buffers (documents).
-\end_layout
-\begin_layout Description
-Syntax outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
-\end_layout
-\begin_layout Description
-Params <PAR_ID_SECTION>: paragraph id of the section heading which is to be moved.
-\begin_inset Newline newline
-\end_inset
-
-<PAR_ID_DROP_POSITION>: the paragraph id where the section will be moved to.
-\end_layout
-\begin_layout Description
-Origin Rob Oakes, 22 June 2009
-\end_layout
-
\begin_layout Subsection*
LFUN_INSET_EDIT
\end_layout
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
\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, 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
+Notion This is currently implemented only for SVN.
+\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
+Notion This is currently implemented only for SVN and RCS.
+\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.
+\end_layout
+\begin_layout Description
+Sample Compare current document against last commit
+\begin_inset Newline newline
+\end_inset
+
+vc-compare 0Compare current document against current revision - 5 commits
+\begin_inset Newline newline
+\end_inset
+
+vc-compare -5Compare 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
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 hyperlink|include|index|label|nomencl|vspace|ref|toc>
\begin_inset Newline newline
\end_inset
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|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
+\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 Commentinset-modify changetype Ovalbox
\end_layout
\begin_layout Subsection*
Origin leeming, 30 Mar 2004
\end_layout
+\begin_layout Subsection*
+LFUN_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 10000.
+\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 delete-char-forward
+\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*
+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*
LFUN_SET_GRAPHICS_GROUP
\end_layout
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]
\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|listings|log|mathdelimiter|
\begin_inset Newline newline
\end_inset
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 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). .ext: extensions will be automatically replaced by .lyx.
+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. <ROW_NUMBER> The row number of the LaTeX file to which to go.
\end_layout
\begin_layout Description
Origin Edmar, 23 Dec 1998
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
Origin vfr, 30 Mar 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
-
\end_body
\end_document
projects / lyx.git / blobdiff