]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/LFUNs.lyx
Clarify instructions on how to set up the thesaurus (#8811)
[lyx.git] / lib / doc / LFUNs.lyx
index be3d43955d05c4ff4cf6eba26e444a86721a4311..ade3fffbd0f6710357e87cb8c2eba8a3bf131039 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 444
+\lyxformat 474
 \begin_document
 \begin_header
 \textclass article
 \use_geometry true
 \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 numerical
+\cite_engine_type default
 \biblio_style plain
 \use_bibtopic false
 \use_indices false
@@ -81,7 +84,7 @@
 \begin_body
 
 \begin_layout Section*
-LFUNs documentation automatically generated 2012-09-29
+LFUNs documentation automatically generated 2013-10-05
 \end_layout
 
 \begin_layout Standard
@@ -466,7 +469,11 @@ Action Inserts an argument (short title) inset.
 \end_layout
 
 \begin_layout Description
-Syntax argument-insert
+Syntax argument-insert <argument nr>
+\end_layout
+
+\begin_layout Description
+Params <argument nr>: see layout declarations
 \end_layout
 
 \begin_layout Description
@@ -1905,6 +1912,22 @@ Params <WORD>: word to remove <LANG>: language name (see file languages)
 Origin SWitt, 28 July 2010
 \end_layout
 
+\begin_layout Subsection*
+LFUN_SPELLING_CONTINUOUSLY
+\end_layout
+
+\begin_layout Description
+Action Toggle continuous spell checking.
+\end_layout
+
+\begin_layout Description
+Syntax spelling-continuously
+\end_layout
+
+\begin_layout Description
+Origin vfr, 24 March 2013
+\end_layout
+
 \begin_layout Subsection*
 LFUN_THESAURUS_ENTRY
 \end_layout
@@ -2181,7 +2204,7 @@ Syntax paste [<TYPE>|<NUM>]
 \end_layout
 
 \begin_layout Description
-Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
+Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
 \begin_inset Newline newline
 \end_inset
 
@@ -4136,6 +4159,68 @@ Syntax vc-register
 Origin Lgb, 1 Jul 1997
 \end_layout
 
+\begin_layout Subsection*
+LFUN_VC_RENAME
+\end_layout
+
+\begin_layout Description
+Action Renames the document to another name.
+\end_layout
+
+\begin_layout Description
+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
+Syntax vc-rename <FILENAME>
+\end_layout
+
+\begin_layout Description
+Params <FILENAME>: New name of the document.
+\begin_inset Newline newline
+\end_inset
+
+A file dialog is opened if no filename is given.
+\end_layout
+
+\begin_layout Description
+Origin gb, 05 Feb 2013
+\end_layout
+
+\begin_layout Subsection*
+LFUN_VC_COPY
+\end_layout
+
+\begin_layout Description
+Action Copies the document to another name.
+\end_layout
+
+\begin_layout Description
+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
+Syntax vc-copy <FILENAME>
+\end_layout
+
+\begin_layout Description
+Params <FILENAME>: New name of the document.
+\begin_inset Newline newline
+\end_inset
+
+A file dialog is opened if no filename is given.
+\end_layout
+
+\begin_layout Description
+Origin gb, 05 Feb 2013
+\end_layout
+
 \begin_layout Subsection*
 LFUN_VC_CHECK_IN
 \end_layout
@@ -4659,25 +4744,68 @@ In case that <INSET> is "tabular" various math-environment features are
 \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
+<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|set-longtabular|unset-longtabular|set-pwidth|
 \begin_inset Newline newline
 \end_inset
 
-<ARG>: additional argument for some commands, use debug mode to explore
- its values.
+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
+
+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 <ARG>: additional
+ argument for some commands, use debug mode to explore its values.
 \end_layout
 
 \begin_layout Description
@@ -4806,7 +4934,7 @@ Sample Remove all index insets:
 \begin_inset Newline newline
 \end_inset
 
-                  inset-forall Index delete-char-forward
+                  inset-forall Index char-delete-forward
 \begin_inset Newline newline
 \end_inset
 
@@ -4937,12 +5065,17 @@ Action Set language from the current cursor position.
 \end_layout
 
 \begin_layout Description
-Syntax language <LANG>
+Syntax language <LANG> [set]
 \end_layout
 
 \begin_layout Description
 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
@@ -6284,21 +6417,24 @@ LFUN_BUFFER_FORALL
 \end_layout
 
 \begin_layout Description
-Action Applies a command to all visible, hidden, or both types of buffers
- in the active window.
+Action Applies a command to all non-hidden buffers.
 \end_layout
 
 \begin_layout Description
-Syntax buffer-forall [<BUFFER-TYPE>] <LFUN-COMMAND>
+Notion a buffer is `hidden' if it is internally open in LyX, but not visible
+ in any window.
 \end_layout
 
 \begin_layout Description
-Params <BUFFER-TYPE>: <visible|hidden|both default:> default: visible <LFUN-COMM
-AND>: The command that is to be applied to the buffers.
+Syntax buffer-forall <LFUN-COMMAND>
 \end_layout
 
 \begin_layout Description
-Sample Close all Notes in all visible documents:
+Params <LFUN-COMMAND>: The command to be applied to the buffers.
+\end_layout
+
+\begin_layout Description
+Sample Close all Notes in buffers:
 \begin_inset Newline newline
 \end_inset
 
@@ -6306,15 +6442,15 @@ Sample Close all Notes in all visible documents:
 \begin_inset Newline newline
 \end_inset
 
-Toggle change tracking on all documents:
+Toggle change tracking on buffers:
 \begin_inset Newline newline
 \end_inset
 
-                  buffer-forall both changes-track
+                  buffer-forall changes-track
 \begin_inset Newline newline
 \end_inset
 
-Toggle read-only for all visible documents:
+Toggle read-only for buffers:
 \begin_inset Newline newline
 \end_inset
 
@@ -6322,15 +6458,15 @@ Toggle read-only for all visible documents:
 \begin_inset Newline newline
 \end_inset
 
-Show statistics for each document:
+Show statistics for individual buffers:
 \begin_inset Newline newline
 \end_inset
 
-                  buffer-forall both statistics
+                  buffer-forall statistics
 \begin_inset Newline newline
 \end_inset
 
-Activate the branch named "Solutions" in all visible documents:
+Activate the branch named "Solutions" in buffers:
 \begin_inset Newline newline
 \end_inset
 
@@ -6338,7 +6474,7 @@ Activate the branch named "Solutions" in all visible documents:
 \begin_inset Newline newline
 \end_inset
 
-Export all visible documents to PDF (pdflatex):
+Export buffers to PDF (pdflatex):
 \begin_inset Newline newline
 \end_inset
 
@@ -6403,8 +6539,8 @@ LFUN_MASTER_BUFFER_UPDATE
 \end_layout
 
 \begin_layout Description
-Action When run from a child document, this updates (exports) document built
from the master buffer, if available.
+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
@@ -6427,8 +6563,8 @@ LFUN_MASTER_BUFFER_VIEW
 \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 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
@@ -7047,6 +7183,55 @@ Params <BRANCH>: The branch to deactivate
 Origin rgh, 27 May 2008
 \end_layout
 
+\begin_layout Subsection*
+LFUN_BRANCH_MASTER_ACTIVATE
+\end_layout
+
+\begin_layout Description
+Action Activate the branch in the master buffer.
+\end_layout
+
+\begin_layout Description
+Syntax branch-master-activate <BRANCH>
+\end_layout
+
+\begin_layout Description
+Params <BRANCH>: The branch to activate
+\end_layout
+
+\begin_layout Description
+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
+Origin spitz, 30 Sep 2012
+\end_layout
+
+\begin_layout Subsection*
+LFUN_BRANCH_MASTER_DEACTIVATE
+\end_layout
+
+\begin_layout Description
+Action De-activate the branch in the master buffer.
+\end_layout
+
+\begin_layout Description
+Syntax branch-master-deactivate <BRANCH>
+\end_layout
+
+\begin_layout Description
+Params <BRANCH>: The branch to deactivate
+\end_layout
+
+\begin_layout Description
+Origin spitz, 30 Sep 2012
+\end_layout
+
 \begin_layout Subsection*
 LFUN_BRANCHES_RENAME
 \end_layout
@@ -7115,7 +7300,8 @@ LFUN_LABEL_INSERT_AS_REF
 \end_layout
 
 \begin_layout Description
-Action Inserts the label as a cross-reference at the position of the cursor.
+Action Inserts the label (in ToC pane) as a cross-reference at the position
+ of the cursor.
 \end_layout
 
 \begin_layout Description
@@ -7187,5 +7373,21 @@ Syntax inset-copy-as
 Origin vfr, 18 Apr 2010
 \end_layout
 
+\begin_layout Subsection*
+LFUN_ENVIRONMENT_SPLIT
+\end_layout
+
+\begin_layout Description
+Action Splits the current environment with a Separator.
+\end_layout
+
+\begin_layout Description
+Syntax environment-split
+\end_layout
+
+\begin_layout Description
+Origin spitz, 23 Dec 2012
+\end_layout
+
 \end_body
 \end_document