]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/LFUNs.lyx
Japanese Tutorial.lyx: update by Koji
[lyx.git] / lib / doc / LFUNs.lyx
index 7100fc8822650f13157a4a4aae71aaa4b80783fd..c3e982a98ec5be063f284d25abca85aa88e637e2 100644 (file)
@@ -1,5 +1,5 @@
-#LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 344
+#LyX 1.6.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 345
 \begin_document
 \begin_header
 \textclass amsart
@@ -20,7 +20,6 @@ theorems-ams
 
 \graphics default
 \paperfontsize default
-\spacing single
 \use_hyperref false
 \papersize default
 \use_geometry true
@@ -50,7 +49,7 @@ theorems-ams
 \begin_body
 
 \begin_layout Section*
-LFUNs documentation automatically generated 25.09.2008.
+LFUNs documentation automatically generated 06.02.2009.
 \end_layout
 
 \begin_layout Standard
@@ -572,6 +571,53 @@ Syntax listing-insert
 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007 
 \end_layout
 
+\begin_layout Subsection*
+LFUN_TAB_INSERT 
+\end_layout
+
+\begin_layout Description
+Action Insert a tab into a listings inset.
+  
+\end_layout
+
+\begin_layout Description
+Notion It also works on a selection.
+  
+\end_layout
+
+\begin_layout Description
+Syntax tab-insert 
+\end_layout
+
+\begin_layout Description
+Origin vfvanravesteijn, Sep 30 2008 
+\end_layout
+
+\begin_layout Subsection*
+LFUN_TAB_DELETE 
+\end_layout
+
+\begin_layout Description
+Action Delete a tab or up to an equivalent amount of spaces from a listings
+ inset.
+  
+\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.
+  
+\end_layout
+
+\begin_layout Description
+Syntax tab-delete 
+\end_layout
+
+\begin_layout Description
+Origin vfvanravesteijn, Sep 30 2008 
+\end_layout
+
 \begin_layout Subsection*
 LFUN_QUOTE_INSERT 
 \end_layout
@@ -638,6 +684,11 @@ Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
   
 \end_layout
 
+\begin_layout Description
+Sample command-sequence info-insert buffer path; info-insert buffer name
+\end_layout
+
 \begin_layout Description
 Origin bpeng, 7 Oct 2007 
 \end_layout
@@ -996,6 +1047,28 @@ Params <SOURCE/TARGET>: Note|Comment|Greyedout
 Origin sanda, 18 Jun 2008 
 \end_layout
 
+\begin_layout Subsection*
+LFUN_PHANTOM_INSERT 
+\end_layout
+
+\begin_layout Description
+Action Inserts phantom on the current cursor postion, move selection inside
+ the inset.
+  
+\end_layout
+
+\begin_layout Description
+Syntax phantom-insert [<TYPE>] 
+\end_layout
+
+\begin_layout Description
+Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom  
+\end_layout
+
+\begin_layout Description
+Origin uwestoehr, 30 Jan 2009 
+\end_layout
+
 \begin_layout Subsection*
 LFUN_NEWLINE_INSERT 
 \end_layout
@@ -1550,7 +1623,28 @@ Origin Andre, Jan 7 2004
 \end_layout
 
 \begin_layout Subsection*
-LFUN_WORD_FORWARD 
+LFUN_WORD_FINDADV 
+\end_layout
+
+\begin_layout Description
+Action Search for next occurence of a pattern.
+  
+\end_layout
+
+\begin_layout Description
+Syntax word-findadv [<DATA>] 
+\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 
 \end_layout
 
 \begin_layout Description
@@ -1762,7 +1856,12 @@ Action Look up thesaurus entries with respect to the word under the cursor.
 \end_layout
 
 \begin_layout Description
-Syntax thesaurus-entry 
+Syntax thesaurus-entry [<STRING>] [lang=<LANG>] 
+\end_layout
+
+\begin_layout Description
+Params <STRING>: word to look up <LANG>: language (see file languages) 
 \end_layout
 
 \begin_layout Description
@@ -1981,6 +2080,19 @@ Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
   
 \end_layout
 
+\begin_layout Subsection*
+LFUN_SELECTION_PASTE 
+\end_layout
+
+\begin_layout Description
+Action Pastes the text in permanent selection.
+  
+\end_layout
+
+\begin_layout Description
+Syntax selection-paste 
+\end_layout
+
 \begin_layout Subsection*
 LFUN_UNDO 
 \end_layout
@@ -2852,20 +2964,28 @@ Notion Use spacebar after entering this space to change type of space.
 \end_layout
 
 \begin_layout Description
-Syntax math-space [<TYPE>] 
+Syntax math-space [<TYPE>] [<LEN>] 
 \end_layout
 
 \begin_layout Description
-Params <TYPE>: negative spaces: !|negmedspace|negthickspace  
+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
 
- positive spaces: ,|:|;|quad|qquad  
+ custom space: hspace  
 \begin_inset Newline newline
 \end_inset
 
  "," used by default.
-  
+ Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
+ and ; = thickspace.
+ <LEN>: length for custom spaces (hspace)  
 \end_layout
 
 \begin_layout Description
@@ -2928,6 +3048,36 @@ Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
 Origin Alejandro, 4 Jun 1996 
 \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.
+  
+\end_layout
+
+\begin_layout Description
+Notion If there is any selected text, then it is moved inside the created
+ regexp inset.
+  
+\end_layout
+
+\begin_layout Description
+Syntax regexp-mode [<ARG>] 
+\end_layout
+
+\begin_layout Description
+Params <ARG>: eventual argument (regular expression).
+  
+\end_layout
+
+\begin_layout Description
+Origin Tommaso, 4 Oct 2008 
+\end_layout
+
 \begin_layout Subsection*
 LFUN_MATH_NUMBER_LINE_TOGGLE 
 \end_layout
@@ -3041,6 +3191,28 @@ scriptscriptstyle
 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008 
 \end_layout
 
+\begin_layout Subsection*
+LFUN_MATH_FONT_STYLE 
+\end_layout
+
+\begin_layout Description
+Action Changes the text style used in math.
+  
+\end_layout
+
+\begin_layout Description
+Syntax math-font-style <STYLE> 
+\end_layout
+
+\begin_layout Description
+Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
+trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup  
+\end_layout
+
+\begin_layout Description
+Origin vfr, 9 jan 2009 
+\end_layout
+
 \begin_layout Subsection*
 LFUN_MATH_MACRO_UNFOLD 
 \end_layout
@@ -3788,7 +3960,8 @@ lar|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  
+|set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
+ar-valign-middle|tabular-valign-bottom  
 \begin_inset Newline newline
 \end_inset
 
@@ -3866,7 +4039,8 @@ Notion File is registered inside cvs, svn or rcs repository acording to
 \begin_inset Newline newline
 \end_inset
 
- See LyX Extended Manual (Version Control Chapter) for additional information.
+ See LyX Additional Features Manual (Version Control Chapter) for additional
+ information.
   
 \end_layout
 
@@ -3961,6 +4135,66 @@ Syntax vc-check-out
 Origin Lgb, 1 Jul 1997 
 \end_layout
 
+\begin_layout Subsection*
+LFUN_VC_COMMAND 
+\end_layout
+
+\begin_layout Description
+Action Executes external command.
+ This command is intended to support additional VCS commands.
+  
+\end_layout
+
+\begin_layout Description
+Syntax vc-command <FLAG> <PATH> <COMMAND> 
+\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.
+\begin_inset Newline newline
+\end_inset
+
+ <COMMAND>: command to execute.
+ $$i/$$p/$$m will be replaced by the current document/path/message.
+  
+\end_layout
+
+\begin_layout Description
+Sample vc-command DR $$p "svn up" 
+\end_layout
+
+\begin_layout Description
+Origin sanda, 13 Jan 2009 
+\end_layout
+
 \begin_layout Subsection*
 LFUN_CHANGES_TRACK 
 \end_layout
@@ -4176,8 +4410,11 @@ Syntax inset-insert <INSET> <ARGS>
 \end_layout
 
 \begin_layout Description
-Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
-nclude|index|label|nomencl|vspace|ref|toc> 
+Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| 
+\begin_inset Newline newline
+\end_inset
+
+ hyperlink|include|index|label|nomencl|vspace|ref|toc> 
 \begin_inset Newline newline
 \end_inset
 
@@ -4231,9 +4468,9 @@ Action Modify existing inset.
 \end_layout
 
 \begin_layout Description
-Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
ref insets.
+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
 
@@ -4256,9 +4493,9 @@ Action Modify the inset at cursor position, if there is one.
 \end_layout
 
 \begin_layout Description
-Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
ref insets.
+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
 
@@ -4320,7 +4557,8 @@ Syntax inset-settings <INSET>
 \end_layout
 
 \begin_layout Description
-Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>  
+Params <INSET>: <box|branch|ert|float|listings|note|phantom|tabular|wrap>
+  
 \end_layout
 
 \begin_layout Subsection*
@@ -4337,9 +4575,9 @@ Action Toggles the inset at cursor position.
 \end_layout
 
 \begin_layout Description
-Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
ref insets.
+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
 
@@ -4760,7 +4998,7 @@ Action Various UI visibility-toggling actions.
 \end_layout
 
 \begin_layout Description
-Syntax ui-toggle <statusbar|menubar|frame|fullscreen> 
+Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen> 
 \end_layout
 
 \begin_layout Description
@@ -4920,19 +5158,20 @@ Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
 \begin_inset Newline newline
 \end_inset
 
- include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix
+ include|index|info|nomenclature|label|listings|log|mathdelimiter
 \begin_inset Newline newline
 \end_inset
 
note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols
mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space
 \begin_inset Newline newline
 \end_inset
 
- tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace 
+ spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|
 \begin_inset Newline newline
 \end_inset
 
wrap|listings|<SPECIAL>  
view-source|vspace|wrap|<SPECIAL>  
 \begin_inset Newline newline
 \end_inset
 
@@ -5297,6 +5536,7 @@ Action Sends notify message about the last key-sequence to client.
 
 \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.
   
 \end_layout
 
@@ -6502,5 +6742,23 @@ Params <BRANCH>: The branch to deactivate
 Origin rgh, 27 May 2008 
 \end_layout
 
+\begin_layout Subsection*
+LFUN_COPY_LABEL_AS_REF 
+\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 
+\end_layout
+
+\begin_layout Description
+Origin sts, 16 Nov 2008 
+\end_layout
+
 \end_body
 \end_document