1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
10 \renewenvironment{description}{\list{}{%
11 \setlength{\itemsep}{-2pt}
12 \advance\leftmargini6\p@ \itemindent-12\p@
13 \labelwidth\z@ \let\makelabel\descriptionlabel}%
18 \use_default_options false
19 \maintain_unincluded_children false
27 \language_package default
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
38 \font_sf_scale 100 100
39 \font_tt_scale 100 100
41 \default_output_format default
43 \bibtex_command default
44 \index_command default
45 \paperfontsize default
50 \use_package amsmath 1
51 \use_package amssymb 1
54 \use_package mathdots 0
55 \use_package mathtools 0
57 \use_package stackrel 0
58 \use_package stmaryrd 0
59 \use_package undertilde 0
61 \cite_engine_type default
65 \paperorientation portrait
79 \paragraph_separation indent
80 \paragraph_indentation default
81 \quotes_language english
84 \paperpagestyle default
85 \tracking_changes false
104 \begin_layout Section*
108 \begin_layout Standard
109 This manual documents the
110 \begin_inset Quotes eld
114 \begin_inset Quotes erd
118 These are commands that are used to make \SpecialChar LyX
119 perform specific actions.
121 itself uses these functions internally, and every internal action is
125 \begin_layout Standard
126 LFUNs are also used in the files that define keyboard shortcuts, menu or
128 So if you want to change\SpecialChar breakableslash
129 customize the user interface, you need to deal
131 Furthermore, external programs can use LFUNs to communicate with and
132 \begin_inset Quotes eld
136 \begin_inset Quotes erd
141 Finally, you can also issue LFUNs directly via the so called mini-buffer
142 which can be opened via
145 arg "command-execute"
151 \begin_layout Standard
152 In the following, all LFUNs are listed, categorized by function.
155 \begin_layout Section
156 Layout Functions (Font, Layout and Textclass related)
159 \begin_layout Subsection*
163 \begin_layout Description
164 Action Displays list of layout choices.
167 \begin_layout Description
168 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
171 \begin_layout Description
172 Syntax drop-layouts-choice
175 \begin_layout Subsection*
179 \begin_layout Description
180 Action Splits the current environment with a Separator.
183 \begin_layout Description
184 Syntax environment-split [outer]
187 \begin_layout Description
188 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
191 \begin_layout Description
192 Origin spitz, 23 Dec 2012
195 \begin_layout Subsection*
199 \begin_layout Description
200 Action Toggles the bold font (selection-wise) using mathbf in math.
203 \begin_layout Description
207 \begin_layout Subsection*
211 \begin_layout Description
212 Action Toggles the bold font (selection-wise) using boldsymbol in math.
215 \begin_layout Description
216 Syntax font-boldsymbol
219 \begin_layout Subsection*
223 \begin_layout Description
224 Action Reverts the settings of the font to the default values (selection-wise).
227 \begin_layout Description
231 \begin_layout Subsection*
235 \begin_layout Description
236 Action Toggles the emphasis font style (selection-wise).
239 \begin_layout Description
243 \begin_layout Subsection*
247 \begin_layout Description
248 Action Toggles Fraktur family font (math-mode, selection-wise).
251 \begin_layout Description
255 \begin_layout Description
256 Origin vermeer, 10 Jan 2002
259 \begin_layout Subsection*
263 \begin_layout Description
264 Action Toggles Italics font shape (math-mode, selection-wise).
267 \begin_layout Description
271 \begin_layout Description
272 Origin vermeer, 10 Jan 2002
275 \begin_layout Subsection*
279 \begin_layout Description
280 Action Toggles Noun text style font (selection-wise).
283 \begin_layout Description
287 \begin_layout Subsection*
291 \begin_layout Description
292 Action Toggles Roman family font (selection-wise).
295 \begin_layout Description
299 \begin_layout Subsection*
303 \begin_layout Description
304 Action Toggles Sans Serif family font (selection-wise).
307 \begin_layout Description
311 \begin_layout Subsection*
315 \begin_layout Description
316 Action Sets font size according to lyx format string.
319 \begin_layout Description
320 Syntax font-size <SIZE>
323 \begin_layout Description
324 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
325 \begin_inset Newline newline
328 largest|huge|giant|increase|decrease|default
331 \begin_layout Subsection*
335 \begin_layout Description
336 Action Returns the info about the current font.
339 \begin_layout Description
343 \begin_layout Subsection*
347 \begin_layout Description
348 Action Toggles strikeout (strike-through) in the font (selection-wise).
351 \begin_layout Description
352 Syntax font-strikeout
355 \begin_layout Description
356 Origin sanda, 3 May 2009
359 \begin_layout Subsection*
363 \begin_layout Description
364 Action Toggles the typewriter family font (selection-wise).
367 \begin_layout Description
368 Syntax font-typewriter
371 \begin_layout Subsection*
375 \begin_layout Description
376 Action Toggles underline in the font (selection-wise).
379 \begin_layout Description
380 Syntax font-underline
383 \begin_layout Subsection*
387 \begin_layout Description
388 Action Toggles double underline in the font (selection-wise).
391 \begin_layout Description
392 Syntax font-underunderline
395 \begin_layout Description
396 Origin sanda, 5 May 2009
399 \begin_layout Subsection*
403 \begin_layout Description
404 Action Toggles wavy underline in the font (selection-wise).
407 \begin_layout Description
408 Syntax font-underwave
411 \begin_layout Description
412 Origin sanda, 5 May 2009
415 \begin_layout Subsection*
419 \begin_layout Description
420 Action Sets the layout (that is, environment) for the current paragraph.
423 \begin_layout Description
424 Syntax layout <LAYOUT>
427 \begin_layout Description
428 Params <LAYOUT>: the layout to use
431 \begin_layout Subsection*
435 \begin_layout Description
436 Action Adds a module.
439 \begin_layout Description
440 Notion Adds a module to the list of included modules for the current buffer.
443 \begin_layout Description
444 Syntax layout-module-add <MODULE>
447 \begin_layout Description
448 Params <MODULE>: the module to be added
451 \begin_layout Description
452 Origin rgh, 25 August 2007
455 \begin_layout Subsection*
459 \begin_layout Description
460 Action Clears the module list.
463 \begin_layout Description
464 Notion Clears the list of included modules for the current buffer.
467 \begin_layout Description
468 Syntax layout-modules-clear
471 \begin_layout Description
472 Origin rgh, 25 August 2007
475 \begin_layout Subsection*
479 \begin_layout Description
480 Action Launches the paragraph settings dialog.
483 \begin_layout Description
484 Syntax layout-paragraph
487 \begin_layout Subsection*
491 \begin_layout Description
492 Action Reloads layout information.
495 \begin_layout Description
496 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.
499 \begin_layout Description
503 \begin_layout Description
504 Origin rgh, 3 September 2007
507 \begin_layout Subsection*
511 \begin_layout Description
512 Action Launches the tabular settings dialog.
515 \begin_layout Description
516 Syntax layout-tabular
519 \begin_layout Description
520 Origin Jug, 31 Jul 2000
523 \begin_layout Subsection*
527 \begin_layout Description
528 Action Update fonts and its metrics.
531 \begin_layout Description
532 Notion Automatically called after zoom, dpi, font names, or norm change.
535 \begin_layout Description
536 Syntax screen-font-update
539 \begin_layout Description
540 Origin ARRae, 13 Aug 2000
543 \begin_layout Subsection*
547 \begin_layout Description
548 Action Sets the text class for the current buffer.
551 \begin_layout Description
552 Syntax textclass-apply <TEXTCLASS>
555 \begin_layout Description
556 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
559 \begin_layout Subsection*
563 \begin_layout Description
564 Action Loads information for a textclass from disk.
567 \begin_layout Description
568 Syntax textclass-load <TEXTCLASS>
571 \begin_layout Description
572 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
575 \begin_layout Subsection*
579 \begin_layout Description
580 Action Toggle user-defined (=last-time used) text style.
583 \begin_layout Description
584 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
587 \begin_layout Description
588 Syntax textstyle-apply
591 \begin_layout Description
592 Origin leeming, 12 Mar 2003
595 \begin_layout Subsection*
599 \begin_layout Description
600 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
603 \begin_layout Description
604 Syntax textstyle-update <FONT_INFO>
607 \begin_layout Description
608 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
609 \begin_inset Newline newline
612 Use lyx -dbg action for exact syntax of text-style dialog parameters.
615 \begin_layout Description
616 Origin leeming, 12 Mar 2003
619 \begin_layout Section
620 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
623 \begin_layout Subsection*
627 \begin_layout Description
628 Action Adds an acute accent to the next character typed.
631 \begin_layout Description
635 \begin_layout Subsection*
639 \begin_layout Description
640 Action Adds a breve accent to the next character typed.
643 \begin_layout Description
647 \begin_layout Subsection*
651 \begin_layout Description
652 Action Adds a caron to the next character typed.
655 \begin_layout Description
659 \begin_layout Subsection*
663 \begin_layout Description
664 Action Adds a cedilla to the next character typed.
667 \begin_layout Description
668 Syntax accent-cedilla
671 \begin_layout Subsection*
675 \begin_layout Description
676 Action Adds a circle accent to the next character typed.
679 \begin_layout Description
683 \begin_layout Subsection*
687 \begin_layout Description
688 Action Adds a circumflex to the next character typed.
691 \begin_layout Description
692 Syntax accent-circumflex
695 \begin_layout Subsection*
699 \begin_layout Description
700 Action Adds a dot accent to the next character typed.
703 \begin_layout Description
707 \begin_layout Subsection*
711 \begin_layout Description
712 Action Adds a grave accent to the next character typed.
715 \begin_layout Description
719 \begin_layout Subsection*
720 accent-hungarian-umlaut
723 \begin_layout Description
724 Action Adds a Hungarian umlaut to the next character typed.
727 \begin_layout Description
731 \begin_layout Subsection*
735 \begin_layout Description
736 Action Adds a macron to the next character typed.
739 \begin_layout Description
743 \begin_layout Subsection*
747 \begin_layout Description
748 Action Adds an ogonek accent to the next character typed.
751 \begin_layout Description
755 \begin_layout Subsection*
759 \begin_layout Description
760 Action Adds a perispomeni (Greek circumflex) over the next character typed.
763 \begin_layout Description
764 Syntax accent-perispomeni
767 \begin_layout Subsection*
771 \begin_layout Description
772 Action Adds a tie over the next two character typed.
775 \begin_layout Description
776 Notion The following char will finish the tie.
779 \begin_layout Description
783 \begin_layout Subsection*
787 \begin_layout Description
788 Action Adds a tilde over the next character typed.
791 \begin_layout Description
795 \begin_layout Subsection*
799 \begin_layout Description
800 Action Adds an umlaut over the next character typed.
803 \begin_layout Description
807 \begin_layout Subsection*
811 \begin_layout Description
812 Action Adds a bar under the next character typed.
815 \begin_layout Description
816 Syntax accent-underbar
819 \begin_layout Subsection*
823 \begin_layout Description
824 Action Adds a dot under the next character typed.
827 \begin_layout Description
828 Syntax accent-underdot
831 \begin_layout Subsection*
835 \begin_layout Description
836 Action Accepts all tracked changes in the document.
839 \begin_layout Description
840 Syntax all-changes-accept
843 \begin_layout Description
844 Origin Levon, 16 Oct 2002
847 \begin_layout Subsection*
851 \begin_layout Description
852 Action Rejects all tracked changes in the document.
855 \begin_layout Description
856 Notion Reject does not work recursively; the user may have to repeat the operation.
859 \begin_layout Description
860 Syntax all-changes-reject
863 \begin_layout Description
864 Origin Levon, 16 Oct 2002
867 \begin_layout Subsection*
871 \begin_layout Description
872 Action Start (or remove) Appendix on the given cursor position.
875 \begin_layout Description
879 \begin_layout Description
880 Origin ettrich, 5 May 1998
883 \begin_layout Subsection*
887 \begin_layout Description
888 Action Inserts an argument (short title) inset.
891 \begin_layout Description
892 Syntax argument-insert <argument nr>
895 \begin_layout Description
896 Params <argument nr>: see layout declarations
899 \begin_layout Description
900 Origin vermeer, 12 Aug 2002
903 \begin_layout Subsection*
907 \begin_layout Description
908 Action Adds database, which will be used for bibtex citations.
911 \begin_layout Description
912 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
915 \begin_layout Description
916 Syntax bibtex-database-add <DATABASE-NAME>
919 \begin_layout Description
920 Origin Ale, 30 May 1997
923 \begin_layout Subsection*
927 \begin_layout Description
928 Action Adds database, which will be used for bibtex citations.
931 \begin_layout Description
932 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
935 \begin_layout Description
936 Syntax bibtex-database-del <DATABASE-NAME>
939 \begin_layout Description
940 Origin Ale, 30 May 1997
943 \begin_layout Subsection*
947 \begin_layout Description
948 Action Clears the list of saved bookmarks.
951 \begin_layout Description
952 Syntax bookmark-clear
955 \begin_layout Description
956 Origin bpeng, 31 October 2006
959 \begin_layout Subsection*
963 \begin_layout Description
964 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
967 \begin_layout Description
968 Notion Bookmark 0 has a special purpose. It is automatically set
969 \begin_inset Newline newline
972 1. to the paragraph you are currently editing
973 \begin_inset Newline newline
976 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
977 \begin_inset Newline newline
980 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
983 \begin_layout Description
984 Syntax bookmark-goto <NUMBER>
987 \begin_layout Description
988 Params <NUMBER>: the number of the bookmark to restore.
991 \begin_layout Description
992 Origin Dekel, 27 January 2001
995 \begin_layout Subsection*
999 \begin_layout Description
1000 Action Save a bookmark.
1003 \begin_layout Description
1004 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.
1007 \begin_layout Description
1008 Syntax bookmark-save <NUMBER>
1011 \begin_layout Description
1012 Params <NUMBER>: the number of the bookmark to save.
1015 \begin_layout Description
1016 Origin Dekel, 27 January 2001
1019 \begin_layout Subsection*
1023 \begin_layout Description
1024 Action Inserts Box inset.
1027 \begin_layout Description
1028 Syntax box-insert [<TYPE>]
1031 \begin_layout Description
1032 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1033 \begin_inset Newline newline
1036 Framed is the default one.
1039 \begin_layout Description
1040 Origin vermeer, 7 Oct 2003
1043 \begin_layout Subsection*
1047 \begin_layout Description
1048 Action Inserts branch inset.
1051 \begin_layout Description
1052 Syntax branch-insert <BRANCH-NAME>
1055 \begin_layout Description
1056 Origin vermeer, 17 Aug 2003
1059 \begin_layout Subsection*
1063 \begin_layout Description
1064 Action Move the cursor to the beginning of the document.
1067 \begin_layout Description
1071 \begin_layout Subsection*
1075 \begin_layout Description
1076 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1079 \begin_layout Description
1080 Syntax buffer-begin-select
1083 \begin_layout Subsection*
1087 \begin_layout Description
1088 Action Move the cursor to the end of the document.
1091 \begin_layout Description
1095 \begin_layout Subsection*
1099 \begin_layout Description
1100 Action Move the cursor to the end of the document adding the traversed text to the selection.
1103 \begin_layout Description
1104 Syntax buffer-end-select
1107 \begin_layout Subsection*
1111 \begin_layout Description
1112 Action Inserts a caption inset.
1115 \begin_layout Description
1116 Syntax caption-insert
1119 \begin_layout Description
1120 Origin Lgb, 18 Jul 2000
1123 \begin_layout Subsection*
1127 \begin_layout Description
1128 Action Moves the cursor to the previous cell inside the table.
1131 \begin_layout Description
1132 Syntax cell-backward
1135 \begin_layout Description
1136 Origin Jug, 22 May 2000
1139 \begin_layout Subsection*
1143 \begin_layout Description
1144 Action Moves the cursor to the next cell inside the table.
1147 \begin_layout Description
1151 \begin_layout Subsection*
1155 \begin_layout Description
1156 Action Splits cell and shifts right part to the next cell (inside the math grid).
1159 \begin_layout Description
1163 \begin_layout Description
1164 Origin Ale, 15 May 1997
1167 \begin_layout Subsection*
1171 \begin_layout Description
1172 Action Accepts tracked change inside the selection.
1175 \begin_layout Description
1176 Syntax change-accept
1179 \begin_layout Description
1180 Origin Levon, 16 Oct 2002
1183 \begin_layout Subsection*
1187 \begin_layout Description
1188 Action Moves the cursor to the position of the next change of the change tracking records.
1191 \begin_layout Description
1195 \begin_layout Description
1196 Origin schmitt, 4 Oct 2006
1199 \begin_layout Subsection*
1203 \begin_layout Description
1204 Action Moves the cursor to the position of the previous change of the change tracking records.
1207 \begin_layout Description
1208 Syntax change-previous
1211 \begin_layout Description
1212 Origin vfr, 4 Apr 2009
1215 \begin_layout Subsection*
1219 \begin_layout Description
1220 Action Rejects tracked change inside the selection.
1223 \begin_layout Description
1224 Syntax change-reject
1227 \begin_layout Description
1228 Origin Levon, 16 Oct 2002
1231 \begin_layout Subsection*
1235 \begin_layout Description
1236 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1239 \begin_layout Description
1240 Syntax changes-merge
1243 \begin_layout Description
1244 Origin Levon, 16 Oct 2002
1247 \begin_layout Subsection*
1251 \begin_layout Description
1252 Action Toggles showing of change tracking in typeset output.
1255 \begin_layout Description
1256 Syntax changes-output
1259 \begin_layout Description
1260 Origin jspitzm, 21 Jan 2005
1263 \begin_layout Subsection*
1267 \begin_layout Description
1268 Action Toggles change tracking to on/off.
1271 \begin_layout Description
1272 Syntax changes-track
1275 \begin_layout Description
1276 Origin levon, 1 Oct 2002
1279 \begin_layout Subsection*
1283 \begin_layout Description
1284 Action Moves the cursor one position logically backwards.
1287 \begin_layout Description
1288 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_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1291 \begin_layout Description
1292 Syntax char-backward
1295 \begin_layout Subsection*
1296 char-backward-select
1299 \begin_layout Description
1300 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1303 \begin_layout Description
1304 Notion See also LFUN_CHAR_BACKWARD.
1307 \begin_layout Description
1308 Syntax char-backward-select
1311 \begin_layout Subsection*
1312 char-delete-backward
1315 \begin_layout Description
1316 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1319 \begin_layout Description
1320 Syntax char-delete-backward
1323 \begin_layout Subsection*
1327 \begin_layout Description
1328 Action Deletes one character in the backward direction (usually the "Delete" key).
1331 \begin_layout Description
1332 Syntax char-delete-forward
1335 \begin_layout Subsection*
1339 \begin_layout Description
1340 Action Moves the cursor one position logically forward.
1343 \begin_layout Description
1344 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_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1347 \begin_layout Description
1351 \begin_layout Subsection*
1355 \begin_layout Description
1356 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1359 \begin_layout Description
1360 Notion See also LFUN_CHAR_FORWARD.
1363 \begin_layout Description
1364 Syntax char-forward-select
1367 \begin_layout Subsection*
1371 \begin_layout Description
1372 Action Moves the cursor one position "to the left".
1375 \begin_layout Description
1376 Notion This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to 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.
1379 \begin_layout Description
1383 \begin_layout Subsection*
1387 \begin_layout Description
1388 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1391 \begin_layout Description
1392 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1395 \begin_layout Description
1396 Syntax char-left-select
1399 \begin_layout Subsection*
1403 \begin_layout Description
1404 Action Moves the cursor one position "to the right".
1407 \begin_layout Description
1408 Notion This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to 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.
1411 \begin_layout Description
1415 \begin_layout Subsection*
1419 \begin_layout Description
1420 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1423 \begin_layout Description
1424 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1427 \begin_layout Description
1428 Syntax char-right-select
1431 \begin_layout Subsection*
1435 \begin_layout Description
1436 Action Transposes the character at the cursor with the one before it.
1439 \begin_layout Description
1440 Syntax chars-transpose
1443 \begin_layout Description
1444 Origin Lgb, 25 Apr 2001
1447 \begin_layout Subsection*
1451 \begin_layout Description
1452 Action Inserts citation from loaded citation database.
1455 \begin_layout Description
1456 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1459 \begin_layout Description
1460 Params <KEY>: Citation (shortcut listed in available citations).
1461 \begin_inset Newline newline
1464 <TEXT_BEFORE>: text which should appear before citation.
1467 \begin_layout Description
1468 Origin AAS, 97-02-23
1471 \begin_layout Subsection*
1475 \begin_layout Description
1476 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.
1479 \begin_layout Description
1480 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.
1483 \begin_layout Description
1484 Syntax clipboard-paste [<ARG>]
1487 \begin_layout Description
1488 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1491 \begin_layout Description
1492 Origin Georg, 10 Jul 2006
1495 \begin_layout Subsection*
1496 clipboard-paste-simple
1499 \begin_layout Description
1500 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.
1503 \begin_layout Description
1504 Syntax clipboard-paste-simple [<ARG>]
1507 \begin_layout Description
1508 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1511 \begin_layout Subsection*
1515 \begin_layout Description
1516 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1519 \begin_layout Description
1520 Notion Usually bound to M-x shortcut.
1523 \begin_layout Description
1524 Syntax command-execute
1527 \begin_layout Subsection*
1531 \begin_layout Description
1532 Action Try to complete the word or command at the cursor position.
1535 \begin_layout Description
1539 \begin_layout Description
1540 Origin sts, Feb 19 2008
1543 \begin_layout Subsection*
1547 \begin_layout Description
1548 Action Accept suggested completion.
1551 \begin_layout Description
1552 Syntax completion-accept
1555 \begin_layout Description
1556 Origin sanda, Sep 08 2008
1559 \begin_layout Subsection*
1563 \begin_layout Description
1564 Action Try to cancel completion, either the popup or the inline completion.
1567 \begin_layout Description
1568 Syntax completion-cancel
1571 \begin_layout Description
1572 Origin sts, Sep 07 2008
1575 \begin_layout Subsection*
1579 \begin_layout Description
1580 Action Show the inline completion at the cursor position.
1583 \begin_layout Description
1584 Syntax completion-inline
1587 \begin_layout Description
1588 Origin sts, Feb 19 2008
1591 \begin_layout Subsection*
1595 \begin_layout Description
1596 Action Show the completion popup at the cursor position.
1599 \begin_layout Description
1600 Syntax completion-popup
1603 \begin_layout Description
1604 Origin sts, Feb 19 2008
1607 \begin_layout Subsection*
1611 \begin_layout Description
1612 Action Copies the current selection to the clipboard.
1615 \begin_layout Description
1619 \begin_layout Subsection*
1623 \begin_layout Description
1624 Action Cuts to the clipboard.
1627 \begin_layout Description
1631 \begin_layout Subsection*
1635 \begin_layout Description
1636 Action Inserts the current date.
1639 \begin_layout Description
1640 Syntax date-insert [<ARG>]
1643 \begin_layout Description
1644 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.
1647 \begin_layout Description
1648 Origin jdblair, 31 Jan 2000
1651 \begin_layout Subsection*
1655 \begin_layout Description
1656 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1659 \begin_layout Description
1660 Syntax depth-decrement
1663 \begin_layout Subsection*
1667 \begin_layout Description
1668 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1671 \begin_layout Description
1672 Syntax depth-increment
1675 \begin_layout Subsection*
1676 dialog-disconnect-inset
1679 \begin_layout Description
1680 Action Closes opened connection to opened inset.
1683 \begin_layout Description
1684 Notion Connection is used for apply functions.
1687 \begin_layout Description
1688 Syntax dialog-disconnect-inset <INSET-NAME>
1691 \begin_layout Description
1692 Origin leeming, 25 Feb 2003
1695 \begin_layout Subsection*
1699 \begin_layout Description
1700 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1703 \begin_layout Description
1704 Syntax dialog-hide <NAME>
1707 \begin_layout Description
1708 Params See LFUN_DIALOG_SHOW .
1711 \begin_layout Description
1712 Origin leeming, 25 Feb 2003
1715 \begin_layout Subsection*
1719 \begin_layout Description
1720 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1723 \begin_layout Description
1724 Syntax dialog-show <NAME> [<DATA>]
1727 \begin_layout Description
1728 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1729 \begin_inset Newline newline
1732 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1733 \begin_inset Newline newline
1736 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1737 \begin_inset Newline newline
1740 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1741 \begin_inset Newline newline
1744 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1745 \begin_inset Newline newline
1748 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1749 \begin_inset Newline newline
1752 <SPECIAL>: latexlog|vclog
1753 \begin_inset Newline newline
1756 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1759 \begin_layout Description
1760 Origin leeming, 17 Jun 2003
1763 \begin_layout Subsection*
1764 dialog-show-new-inset
1767 \begin_layout Description
1768 Action Shows hidden dialog or create new one for a given inset settings etc.
1771 \begin_layout Description
1772 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1775 \begin_layout Description
1776 Syntax dialog-show-new-inset <NAME> [<DATA>]
1779 \begin_layout Description
1780 Params See LFUN_DIALOG_SHOW .
1783 \begin_layout Description
1784 Origin leeming, 25 Feb 2003
1787 \begin_layout Subsection*
1791 \begin_layout Description
1792 Action Toggles dialog between showed/hidden state.
1795 \begin_layout Description
1796 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1799 \begin_layout Description
1800 Syntax dialog-toggle <NAME> [<DATA>]
1803 \begin_layout Description
1804 Params See LFUN_DIALOG_SHOW .
1807 \begin_layout Description
1808 Origin JSpitzm, 30 Apr 2007
1811 \begin_layout Subsection*
1815 \begin_layout Description
1816 Action Updates the dialog values from the inset/paragraph/document.
1819 \begin_layout Description
1820 Syntax dialog-update <NAME>
1823 \begin_layout Description
1824 Params <NAME>: paragraph|prefs|<INSET>
1825 \begin_inset Newline newline
1831 \begin_layout Description
1832 Origin leeming, 25 Feb 2003
1835 \begin_layout Subsection*
1839 \begin_layout Description
1840 Action Moves the cursor one line in downward direction.
1843 \begin_layout Description
1847 \begin_layout Subsection*
1851 \begin_layout Description
1852 Action Moves the cursor one line in downward direction adding the current position to the selection.
1855 \begin_layout Description
1859 \begin_layout Subsection*
1863 \begin_layout Description
1864 Action Inserts an ERT inset.
1867 \begin_layout Description
1871 \begin_layout Description
1872 Origin Jug, 18 Feb 2000
1875 \begin_layout Subsection*
1879 \begin_layout Description
1880 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1883 \begin_layout Description
1887 \begin_layout Description
1888 Origin Lgb, 17 May 2001
1891 \begin_layout Subsection*
1895 \begin_layout Description
1896 Action Inserts another LyX file.
1899 \begin_layout Description
1900 Syntax file-insert [<FILE>]
1903 \begin_layout Description
1904 Params <FILE>: Filename to be inserted.
1907 \begin_layout Subsection*
1908 file-insert-plaintext
1911 \begin_layout Description
1912 Action Inserts plain text file.
1915 \begin_layout Description
1916 Syntax file-insert-plaintext [<FILE>]
1919 \begin_layout Description
1920 Params <FILE>: Filename to be inserted.
1923 \begin_layout Description
1924 Origin CFO-G, 19 Nov 1997
1927 \begin_layout Subsection*
1928 file-insert-plaintext-para
1931 \begin_layout Description
1932 Action Inserts plain text file as paragraph (i.e. join lines).
1935 \begin_layout Description
1936 Syntax file-insert-plaintext-para [<FILE>]
1939 \begin_layout Description
1940 Params <FILE>: Filename to be inserted.
1943 \begin_layout Description
1944 Origin Levon, 14 Feb 2001
1947 \begin_layout Subsection*
1951 \begin_layout Description
1952 Action Inserts CharStyle, Custom inset or XML short element.
1955 \begin_layout Description
1956 Notion Look into the Customization manual for more information about these elements.
1957 \begin_inset Newline newline
1960 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.
1961 \begin_inset Newline newline
1964 For dissolving the element see LFUN_INSET_DISSOLVE.
1967 \begin_layout Description
1968 Syntax flex-insert Name
1971 \begin_layout Description
1972 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.
1975 \begin_layout Description
1976 Sample flex-insert Code
1979 \begin_layout Subsection*
1983 \begin_layout Description
1984 Action Inserts a float inset.
1987 \begin_layout Description
1988 Syntax float-insert <TYPE>
1991 \begin_layout Description
1992 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1995 \begin_layout Description
1996 Origin Lgb, 27 Jun 2000
1999 \begin_layout Subsection*
2003 \begin_layout Description
2004 Action Inserts the list of floats in the document.
2007 \begin_layout Description
2008 Syntax float-list-insert <TYPE>
2011 \begin_layout Description
2012 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2015 \begin_layout Description
2016 Origin Lgb, 3 May 2001
2019 \begin_layout Subsection*
2023 \begin_layout Description
2024 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2027 \begin_layout Description
2028 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2031 \begin_layout Description
2032 Syntax float-wide-insert <TYPE>
2035 \begin_layout Description
2036 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2039 \begin_layout Description
2040 Origin Lgb, 31 Oct 2001
2043 \begin_layout Subsection*
2047 \begin_layout Description
2048 Action Inserts a footnote inset.
2051 \begin_layout Description
2052 Syntax footnote-insert
2055 \begin_layout Description
2056 Origin Jug, 7 Mar 2000
2059 \begin_layout Subsection*
2063 \begin_layout Description
2064 Action Reloads the image if necessary.
2067 \begin_layout Description
2068 Syntax graphics-reload
2071 \begin_layout Description
2072 Origin vfr, 10 Aug 2009
2075 \begin_layout Subsection*
2079 \begin_layout Description
2080 Action Inserts hyperlinks into the document (clickable in pdf output).
2083 \begin_layout Description
2084 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2087 \begin_layout Description
2088 Syntax href-insert [<TARGET>]
2091 \begin_layout Description
2092 Origin CFO-G, 21 Nov 1997
2095 \begin_layout Subsection*
2099 \begin_layout Description
2100 Action Only active in IPA inset.
2103 \begin_layout Description
2104 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.
2107 \begin_layout Description
2111 \begin_layout Description
2112 Origin spitz, 20 May 2012
2115 \begin_layout Subsection*
2119 \begin_layout Description
2120 Action Inserts Index entry.
2123 \begin_layout Description
2124 Notion It automatically takes the word on the cursor position.
2127 \begin_layout Description
2128 Syntax index-insert [<TYPE:Name>]
2131 \begin_layout Description
2132 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2135 \begin_layout Description
2136 Origin leeming, 3 Aug 2000
2139 \begin_layout Subsection*
2143 \begin_layout Description
2144 Action Inserts list of Index entries on a new page.
2147 \begin_layout Description
2148 Syntax index-print [<TYPE:Name>]
2151 \begin_layout Description
2152 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2155 \begin_layout Description
2156 Origin Lgb, 27 Feb 1997
2159 \begin_layout Subsection*
2163 \begin_layout Description
2164 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2167 \begin_layout Description
2168 Notion Apart from lfun arguments you can use the following method:
2169 \begin_inset Newline newline
2172 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2173 \begin_inset Newline newline
2176 2. select the text and run info-insert lfun.
2179 \begin_layout Description
2180 Syntax info-insert <TYPE> <ARG>
2183 \begin_layout Description
2184 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
2185 \begin_inset Newline newline
2188 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2189 \begin_inset Newline newline
2192 shortcut[s]: name of lfun (e.g math-insert
2195 \begin_inset Newline newline
2198 lyxrc: name of rc_entry (e.g. bind_file)
2199 \begin_inset Newline newline
2202 lyxinfo: "version" - used version of LyX
2203 \begin_inset Newline newline
2206 package: name of latex package (e.g. listings)
2207 \begin_inset Newline newline
2210 textclass: name of textclass (e.g. article)
2211 \begin_inset Newline newline
2214 menu: name of lfun used in menu
2215 \begin_inset Newline newline
2218 icon: icon of lfun used in toolbar or direct icon name
2219 \begin_inset Newline newline
2222 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
2225 \begin_layout Description
2226 Sample command-sequence info-insert buffer path; info-insert buffer name
2229 \begin_layout Description
2230 Origin bpeng, 7 Oct 2007
2233 \begin_layout Subsection*
2237 \begin_layout Description
2238 Action Apply data for an inset.
2241 \begin_layout Description
2242 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.
2245 \begin_layout Description
2246 Syntax inset-apply <ARGS>
2249 \begin_layout Description
2250 Params See LFUN_INSET_INSERT .
2253 \begin_layout Subsection*
2257 \begin_layout Description
2258 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
2261 \begin_layout Description
2265 \begin_layout Description
2266 Origin lasgouttes, 16 Mar 2009
2269 \begin_layout Subsection*
2273 \begin_layout Description
2274 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).
2277 \begin_layout Description
2278 Syntax inset-begin-select
2281 \begin_layout Description
2282 Origin lasgouttes, 16 Mar 2009
2285 \begin_layout Subsection*
2289 \begin_layout Description
2290 Action Copies the inset to the clipboard as a certain type.
2293 \begin_layout Description
2294 Notion Currently used only for InsetInfo where its content is copied as a text.
2297 \begin_layout Description
2298 Syntax inset-copy-as
2301 \begin_layout Description
2302 Origin vfr, 18 Apr 2010
2305 \begin_layout Subsection*
2309 \begin_layout Description
2310 Action Dissolve the current inset into text.
2313 \begin_layout Description
2314 Syntax inset-dissolve [<INSET>]
2317 \begin_layout Description
2318 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.
2319 \begin_inset Newline newline
2322 For values see lyx::InsetLayout::lyxtype_ .
2325 \begin_layout Description
2326 Origin JSpitz, 7 Aug 2006
2329 \begin_layout Subsection*
2333 \begin_layout Description
2334 Action Edit the inset at cursor with an external application, if one is attributed.
2337 \begin_layout Description
2338 Syntax inset-edit [<INSET_PARAMS>]
2341 \begin_layout Description
2342 Params <INSET_PARAMS>: Parameters for the inset.
2343 \begin_inset Newline newline
2346 Currently only the filename will be considered.
2349 \begin_layout Description
2350 Origin JSpitzm, 27 Apr 2006
2353 \begin_layout Subsection*
2357 \begin_layout Description
2358 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
2361 \begin_layout Description
2365 \begin_layout Description
2366 Origin lasgouttes, 16 Mar 2009
2369 \begin_layout Subsection*
2373 \begin_layout Description
2374 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).
2377 \begin_layout Description
2378 Syntax inset-end-select
2381 \begin_layout Description
2382 Origin lasgouttes, 16 Mar 2009
2385 \begin_layout Subsection*
2389 \begin_layout Description
2390 Action Apply the given commands on insets of a given name.
2393 \begin_layout Description
2394 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.
2397 \begin_layout Description
2398 Syntax inset-forall <NAME> <LFUN-COMMAND>
2399 \begin_inset Newline newline
2402 <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.
2405 \begin_layout Description
2406 Sample Remove all index insets:
2407 \begin_inset Newline newline
2410 inset-forall Index char-delete-forward
2411 \begin_inset Newline newline
2414 Close all Notes (also works for a particular branch, for example):
2415 \begin_inset Newline newline
2418 inset-forall Note inset-toggle close
2419 \begin_inset Newline newline
2422 Transform all yellow notes to comments
2423 \begin_inset Newline newline
2426 inset-forall Note:Note inset-modify note Note Comment
2427 \begin_inset Newline newline
2430 Try to put LyX in an infinite loop if there is at least a Note:
2431 \begin_inset Newline newline
2434 inset-forall Note char-backward
2437 \begin_layout Description
2438 Origin lasgouttes, 27 Nov 2009
2441 \begin_layout Subsection*
2445 \begin_layout Description
2446 Action Insert new inset (type given by the parameters).
2449 \begin_layout Description
2450 Syntax inset-insert <INSET> <ARGS>
2453 \begin_layout Description
2454 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2455 \begin_inset Newline newline
2458 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2459 \begin_inset Newline newline
2462 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2465 \begin_layout Description
2466 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2469 \begin_inset Newline newline
2472 where <label name> is the name of the referenced label and <Format> is one of the following:
2473 \begin_inset Newline newline
2477 \begin_inset Newline newline
2480 eqref -- (<reference>)
2481 \begin_inset Newline newline
2485 \begin_inset Newline newline
2488 vpageref -- on <page>
2489 \begin_inset Newline newline
2492 vref -- <reference> on <page>
2493 \begin_inset Newline newline
2496 formatted -- Formatted reference
2499 \begin_layout Subsection*
2503 \begin_layout Description
2504 Action Modify some properties of an inset.
2507 \begin_layout Description
2508 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.
2511 \begin_layout Description
2512 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>
2515 \begin_layout Description
2516 Sample inset-modify note Note Comment
2517 \begin_inset Newline newline
2520 inset-modify changetype Ovalbox
2523 \begin_layout Subsection*
2527 \begin_layout Description
2528 Action Select all contents of an inset.
2531 \begin_layout Description
2532 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2535 \begin_layout Description
2536 Syntax inset-select-all
2539 \begin_layout Description
2540 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2543 \begin_layout Subsection*
2547 \begin_layout Description
2548 Action Open the inset's properties dialog.
2551 \begin_layout Description
2552 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.
2555 \begin_layout Description
2556 Syntax inset-settings <INSET>
2559 \begin_layout Description
2560 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2561 \begin_inset Newline newline
2564 graphics|href|include|index|index_print|label|line|
2565 \begin_inset Newline newline
2568 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2571 \begin_layout Subsection*
2575 \begin_layout Description
2576 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2579 \begin_layout Description
2580 Syntax inset-toggle [<ARG>]
2583 \begin_layout Description
2584 Params <ARG>: <open|close|toggle|assign>.
2585 \begin_inset Newline newline
2588 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2589 \begin_inset Newline newline
2592 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2595 \begin_layout Description
2596 Origin lasgouttes, 19 Jul 2001
2599 \begin_layout Subsection*
2603 \begin_layout Description
2604 Action Inserts an IPA inset.
2607 \begin_layout Description
2611 \begin_layout Description
2612 Origin spitz, 05 Mar 2012
2615 \begin_layout Subsection*
2619 \begin_layout Description
2620 Action Inserts special IPA macros into the document.
2623 \begin_layout Description
2624 Syntax ipamacro-insert <CHAR>
2627 \begin_layout Description
2628 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2631 \begin_layout Description
2632 Origin JSpitzm, 22 Aug 2012
2635 \begin_layout Subsection*
2639 \begin_layout Description
2640 Action Turn off the loaded keyboard map.
2643 \begin_layout Description
2647 \begin_layout Subsection*
2651 \begin_layout Description
2652 Action Turn on the primary keyboard map.
2655 \begin_layout Description
2656 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.
2657 \begin_inset Newline newline
2660 The language is to be set in the Preferences dialog.
2663 \begin_layout Description
2664 Syntax keymap-primary
2667 \begin_layout Subsection*
2671 \begin_layout Description
2672 Action Turn on the secondary keyboard map.
2675 \begin_layout Description
2676 Syntax keymap-secondary
2679 \begin_layout Subsection*
2683 \begin_layout Description
2684 Action Toggles keyboard maps (first/second/off).
2687 \begin_layout Description
2688 Syntax keymap-toggle
2691 \begin_layout Description
2692 Origin leeming, 30 Mar 2004
2695 \begin_layout Subsection*
2696 label-copy-as-reference
2699 \begin_layout Description
2700 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2703 \begin_layout Description
2704 Syntax copy-label-as-reference <LABEL>
2707 \begin_layout Description
2708 Params <LABEL>: The label to copy (for multi-line math)
2711 \begin_layout Description
2712 Origin sts, 16 Nov 2008
2715 \begin_layout Subsection*
2719 \begin_layout Description
2720 Action Goto a label.
2723 \begin_layout Description
2724 Syntax label-goto [<LABEL>]
2727 \begin_layout Description
2728 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.
2731 \begin_layout Description
2732 Origin Ale, 6 Aug 1997
2735 \begin_layout Subsection*
2739 \begin_layout Description
2740 Action Inserts label to text or displayed formula.
2743 \begin_layout Description
2744 Syntax label-insert [<LABEL>]
2747 \begin_layout Description
2748 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2751 \begin_layout Subsection*
2752 label-insert-as-reference
2755 \begin_layout Description
2756 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2759 \begin_layout Description
2760 Syntax label-insert-as-reference
2763 \begin_layout Description
2764 Origin vfr, 7 Apr 2009
2767 \begin_layout Subsection*
2771 \begin_layout Description
2772 Action Set language from the current cursor position.
2775 \begin_layout Description
2776 Syntax language <LANG> [set]
2779 \begin_layout Description
2780 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).
2783 \begin_layout Description
2784 Origin Dekel, 2 Mar 2000
2787 \begin_layout Subsection*
2791 \begin_layout Description
2792 Action Move the cursor to the beginning of the (screen) line.
2795 \begin_layout Description
2799 \begin_layout Subsection*
2803 \begin_layout Description
2804 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2807 \begin_layout Description
2808 Syntax line-begin-select
2811 \begin_layout Subsection*
2815 \begin_layout Description
2816 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2819 \begin_layout Description
2820 Syntax line-delete-forward
2823 \begin_layout Subsection*
2827 \begin_layout Description
2828 Action Move the cursor to the end of the (screen) line.
2831 \begin_layout Description
2835 \begin_layout Subsection*
2839 \begin_layout Description
2840 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2843 \begin_layout Description
2844 Syntax line-end-select
2847 \begin_layout Subsection*
2851 \begin_layout Description
2852 Action Inserts a new listings inset.
2855 \begin_layout Description
2856 Syntax listing-insert
2859 \begin_layout Description
2860 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2863 \begin_layout Subsection*
2867 \begin_layout Description
2868 Action Inserts a marginal note.
2871 \begin_layout Description
2872 Syntax marginalnote-insert
2875 \begin_layout Description
2876 Origin Lgb, 26 Jun 2000
2879 \begin_layout Subsection*
2883 \begin_layout Description
2884 Action Disable selecting of text-region.
2887 \begin_layout Description
2891 \begin_layout Subsection*
2895 \begin_layout Description
2896 Action Enable selecting of text-region.
2899 \begin_layout Description
2900 Notion After enabling you can simply move arrow keys to get selected region.
2903 \begin_layout Description
2907 \begin_layout Subsection*
2911 \begin_layout Description
2912 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2915 \begin_layout Description
2919 \begin_layout Description
2920 Origin Andre, May 5 2006
2923 \begin_layout Subsection*
2927 \begin_layout Description
2928 Action Inserts a line break or new line.
2931 \begin_layout Description
2932 Syntax newline-insert [<ARG>]
2935 \begin_layout Description
2936 Params <ARG>: <newline|linebreak> default: newline
2939 \begin_layout Description
2940 Origin JSpitzm, 25 Mar 2008
2943 \begin_layout Subsection*
2947 \begin_layout Description
2948 Action Inserts a new page.
2951 \begin_layout Description
2952 Syntax newpage-insert <ARG>
2955 \begin_layout Description
2956 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2959 \begin_layout Description
2960 Origin uwestoehr, 24 Nov 2007
2963 \begin_layout Subsection*
2967 \begin_layout Description
2968 Action Inserts Nomenclature entry.
2971 \begin_layout Description
2972 Notion It automatically takes the word on the cursor position if no symbol is given.
2975 \begin_layout Description
2976 Syntax nomencl-insert [<SYMBOL>]
2979 \begin_layout Description
2980 Origin Ugras, 4 Nov 2006
2983 \begin_layout Subsection*
2987 \begin_layout Description
2988 Action Inserts list of Nomenclature entries.
2991 \begin_layout Description
2992 Syntax nomenclature-print
2995 \begin_layout Description
2996 Origin Ugras, 4 Nov 2006
2999 \begin_layout Subsection*
3003 \begin_layout Description
3004 Action Inserts Note on the current cursor position, move selection inside the inset.
3007 \begin_layout Description
3008 Syntax note-insert [<TYPE>]
3011 \begin_layout Description
3012 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3015 \begin_layout Subsection*
3019 \begin_layout Description
3020 Action Moves the cursor to the beginning of next Note inset.
3023 \begin_layout Description
3027 \begin_layout Subsection*
3031 \begin_layout Description
3032 Action Move the current group in the downward direction in the structure of the document.
3035 \begin_layout Description
3036 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3039 \begin_layout Description
3043 \begin_layout Description
3044 Origin Vermeer, 23 Mar 2006
3047 \begin_layout Subsection*
3051 \begin_layout Description
3052 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3055 \begin_layout Description
3056 Notion Part -> Chapter -> Section -> etc.
3059 \begin_layout Description
3063 \begin_layout Description
3064 Origin Vermeer, 23 Mar 2006
3067 \begin_layout Subsection*
3071 \begin_layout Description
3072 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3075 \begin_layout Description
3076 Notion Part <- Chapter <- Section <- etc.
3079 \begin_layout Description
3083 \begin_layout Description
3084 Origin Vermeer, 23 Mar 2006
3087 \begin_layout Subsection*
3091 \begin_layout Description
3092 Action Move the current group in the upward direction in the structure of the document.
3095 \begin_layout Description
3096 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3099 \begin_layout Description
3103 \begin_layout Description
3104 Origin Vermeer, 23 Mar 2006
3107 \begin_layout Subsection*
3111 \begin_layout Description
3112 Action Breaks the current paragraph at the current location.
3115 \begin_layout Description
3116 Notion Removes the selection.
3119 \begin_layout Description
3120 Syntax paragraph-break [<LAYOUT>]
3123 \begin_layout Description
3124 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3127 \begin_layout Subsection*
3131 \begin_layout Description
3132 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3135 \begin_layout Description
3136 Syntax paragraph-down
3139 \begin_layout Description
3140 Origin Asger, 1 Oct 1996
3143 \begin_layout Subsection*
3144 paragraph-down-select
3147 \begin_layout Description
3148 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3151 \begin_layout Description
3152 Syntax paragraph-down-select
3155 \begin_layout Description
3156 Origin Asger, 1 Oct 1996
3159 \begin_layout Subsection*
3163 \begin_layout Description
3164 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
3167 \begin_layout Description
3168 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).
3171 \begin_layout Description
3172 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3175 \begin_layout Description
3176 Params <PAR_ID_NUMBER>: paragraph id
3177 \begin_inset Newline newline
3180 <POSITION_IN_PAR>: desired position within the paragraph
3183 \begin_layout Description
3184 Origin Dekel, 26 Aug 2000
3187 \begin_layout Subsection*
3191 \begin_layout Description
3192 Action Moves the current paragraph downwards in the document.
3195 \begin_layout Description
3196 Syntax paragraph-move-down
3199 \begin_layout Description
3200 Origin Edwin, 8 Apr 2006
3203 \begin_layout Subsection*
3207 \begin_layout Description
3208 Action Moves the current paragraph upwards in the document.
3211 \begin_layout Description
3212 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3215 \begin_layout Description
3216 Syntax paragraph-move-up
3219 \begin_layout Description
3220 Origin Edwin, 8 Apr 2006
3223 \begin_layout Subsection*
3227 \begin_layout Description
3228 Action Change paragraph settings.
3231 \begin_layout Description
3232 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.
3235 \begin_layout Description
3236 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3239 \begin_layout Description
3249 \begin_inset Newline newline
3254 paragraph_spacing default|single|onehalf|double|other SIZE
3255 \begin_inset Newline newline
3260 align block|left|right|center|default
3261 \begin_inset Newline newline
3266 labelwidthstring WIDTH|
3271 \begin_layout Description
3272 Origin rgh, Aug 15 2007
3275 \begin_layout Subsection*
3276 paragraph-params-apply
3279 \begin_layout Description
3280 Action Change paragraph settings.
3283 \begin_layout Description
3284 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3287 \begin_layout Description
3288 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3291 \begin_layout Description
3292 Params For parameters see LFUN_PARAGRAPH_PARAMS
3295 \begin_layout Description
3296 Origin leeming, 30 Mar 2004
3299 \begin_layout Subsection*
3303 \begin_layout Description
3304 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3307 \begin_layout Description
3311 \begin_layout Description
3312 Origin Asger, 1 Oct 1996
3315 \begin_layout Subsection*
3319 \begin_layout Description
3320 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3323 \begin_layout Description
3324 Syntax paragraph-up-select
3327 \begin_layout Description
3328 Origin Asger, 1 Oct 1996
3331 \begin_layout Subsection*
3335 \begin_layout Description
3336 Action Pastes material (text or picture) from the active clipboard.
3339 \begin_layout Description
3340 Syntax paste [<TYPE>|<NUM>]
3343 \begin_layout Description
3344 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3345 \begin_inset Newline newline
3348 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3351 \begin_layout Subsection*
3355 \begin_layout Description
3356 Action Inserts phantom on the current cursor position, move selection inside the inset.
3359 \begin_layout Description
3360 Syntax phantom-insert [<TYPE>]
3363 \begin_layout Description
3364 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3367 \begin_layout Description
3368 Origin uwestoehr, 30 Jan 2009
3371 \begin_layout Subsection*
3375 \begin_layout Description
3376 Action Inserts a new preview inset.
3379 \begin_layout Description
3380 Syntax preview-insert
3383 \begin_layout Description
3384 Origin vfr, 28 Mar 2010
3387 \begin_layout Subsection*
3388 primary-selection-paste
3391 \begin_layout Description
3392 Action Pastes the currently selected text.
3395 \begin_layout Description
3396 Notion Primary selection mechanism is linux-only thing.
3399 \begin_layout Description
3400 Syntax primary-selection-paste [<ARG>]
3403 \begin_layout Description
3404 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3407 \begin_layout Subsection*
3411 \begin_layout Description
3412 Action Inserts quotes according to the type and quote-language preference.
3415 \begin_layout Description
3416 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
3419 \begin_layout Description
3420 Syntax quote-insert [<TYPE>]
3423 \begin_layout Description
3424 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
3427 \begin_layout Subsection*
3431 \begin_layout Description
3432 Action Redoes the last thing undone.
3435 \begin_layout Description
3439 \begin_layout Subsection*
3443 \begin_layout Description
3444 Action Go to the next label or cross-reference.
3447 \begin_layout Description
3448 Syntax reference-next
3451 \begin_layout Description
3452 Origin Dekel, 14 Jan 2001
3455 \begin_layout Subsection*
3459 \begin_layout Description
3460 Action Repeat the given command.
3463 \begin_layout Description
3464 Syntax repeat <COUNT> <LFUN-COMMAND>
3467 \begin_layout Description
3468 Origin Andre, 27 Oct 2003
3471 \begin_layout Subsection*
3475 \begin_layout Description
3476 Action Moves the cursor one page in downward direction.
3479 \begin_layout Description
3483 \begin_layout Subsection*
3487 \begin_layout Description
3488 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3491 \begin_layout Description
3492 Syntax screen-down-select
3495 \begin_layout Subsection*
3499 \begin_layout Description
3500 Action Recenters the screen on the current cursor position.
3503 \begin_layout Description
3504 Syntax screen-recenter
3507 \begin_layout Subsection*
3511 \begin_layout Description
3512 Action Repositions the screen such that the cursor is visible.
3515 \begin_layout Description
3516 Syntax screen-show-cursor
3519 \begin_layout Description
3520 Origin vfr, 25 Mar 2009
3523 \begin_layout Subsection*
3527 \begin_layout Description
3528 Action Moves the cursor one page in upward direction.
3531 \begin_layout Description
3535 \begin_layout Subsection*
3539 \begin_layout Description
3540 Action Moves the cursor one page in upward direction adding the current position to the selection.
3543 \begin_layout Description
3544 Syntax screen-up-select
3547 \begin_layout Subsection*
3551 \begin_layout Description
3552 Action Inserts a subscript or superscript inset.
3555 \begin_layout Description
3556 Syntax script-insert <TYPE>
3559 \begin_layout Description
3560 Params <TYPE>: subscript|superscript
3563 \begin_layout Description
3564 Origin Georg, 23 Nov 2010
3567 \begin_layout Subsection*
3571 \begin_layout Description
3572 Action Scroll the buffer view.
3575 \begin_layout Description
3576 Notion Only scrolls the screen up or down; does not move the cursor.
3579 \begin_layout Description
3580 Syntax scroll <TYPE> <QUANTITY>
3583 \begin_layout Description
3584 Params <TYPE>: line|page
3585 \begin_inset Newline newline
3588 <QUANTITY>: up|down|<number>
3591 \begin_layout Description
3592 Origin Abdel, Dec 27 2007
3595 \begin_layout Subsection*
3599 \begin_layout Description
3600 Action Select the whole section.
3603 \begin_layout Description
3604 Notion The cursor should be in a section heading before calling this lfun.
3607 \begin_layout Description
3608 Syntax section-select
3611 \begin_layout Description
3612 Origin vfr, 05 May 2009
3615 \begin_layout Subsection*
3619 \begin_layout Description
3620 Action Pastes the internal selection text in permanent selection.
3623 \begin_layout Description
3624 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3627 \begin_layout Description
3628 Syntax selection-paste
3631 \begin_layout Description
3632 Origin lasgouttes, 14 Jan 2009
3635 \begin_layout Subsection*
3639 \begin_layout Description
3640 Action Inserts an environment separator or latex paragraph break.
3643 \begin_layout Description
3644 Syntax separator-insert [<ARG>]
3647 \begin_layout Description
3648 Params <ARG>: <plain|parbreak|latexpar> default: plain
3651 \begin_layout Description
3652 Origin ef, 2 May 2014
3655 \begin_layout Subsection*
3659 \begin_layout Description
3660 Action Set the group for the graphics inset on the cursor position.
3663 \begin_layout Description
3664 Syntax set-graphics-group [<GROUP>]
3667 \begin_layout Description
3668 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3671 \begin_layout Description
3672 Origin sanda, 6 May 2008
3675 \begin_layout Subsection*
3679 \begin_layout Description
3680 Action Inserts one of horizontal space insets.
3683 \begin_layout Description
3684 Syntax space-insert <NAME> [<LEN>]
3687 \begin_layout Description
3688 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3689 \begin_inset Newline newline
3692 Only in math mode: med and thick.
3693 \begin_inset Newline newline
3696 <LEN>: length for custom spaces (hspace, hspace* for protected)
3699 \begin_layout Description
3700 Origin JSpitzm, 20 May 2003, Mar 17 2008
3703 \begin_layout Subsection*
3707 \begin_layout Description
3708 Action Inserts various characters into the document.
3711 \begin_layout Description
3712 Syntax specialchar-insert <CHAR>
3715 \begin_layout Description
3716 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3719 \begin_layout Description
3720 Origin JSpitzm, 6 Dec 2007
3723 \begin_layout Subsection*
3727 \begin_layout Description
3728 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3731 \begin_layout Description
3732 Syntax spelling-add [<STRING>] [<LANG>]
3735 \begin_layout Description
3736 Params <WORD>: word to add <LANG>: language name (see file languages)
3739 \begin_layout Description
3740 Origin JSpitzm, 18 Jan 2010
3743 \begin_layout Subsection*
3744 spelling-continuously
3747 \begin_layout Description
3748 Action Toggle continuous spell checking.
3751 \begin_layout Description
3752 Syntax spelling-continuously
3755 \begin_layout Description
3756 Origin vfr, 24 March 2013
3759 \begin_layout Subsection*
3763 \begin_layout Description
3764 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.
3767 \begin_layout Description
3768 Syntax spelling-ignore [<WORD>] [<LANG>]
3771 \begin_layout Description
3772 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3775 \begin_layout Description
3776 Origin JSpitzm, 18 Jan 2010
3779 \begin_layout Subsection*
3783 \begin_layout Description
3784 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3787 \begin_layout Description
3788 Syntax spelling-remove [<STRING>] [<LANG>]
3791 \begin_layout Description
3792 Params <WORD>: word to remove <LANG>: language name (see file languages)
3795 \begin_layout Description
3796 Origin SWitt, 28 July 2010
3799 \begin_layout Subsection*
3803 \begin_layout Description
3804 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3807 \begin_layout Description
3808 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.
3811 \begin_layout Description
3815 \begin_layout Description
3816 Origin vfr, Sep 30 2008
3819 \begin_layout Subsection*
3823 \begin_layout Description
3824 Action Insert a tab into a listings inset.
3827 \begin_layout Description
3828 Notion It also works on a selection.
3831 \begin_layout Description
3835 \begin_layout Description
3836 Origin vfr, Sep 30 2008
3839 \begin_layout Subsection*
3843 \begin_layout Description
3844 Action Modify properties of tabulars and table-like math environments.
3847 \begin_layout Description
3848 Syntax tabular-feature <FEATURE> [<ARG>]
3851 \begin_layout Description
3852 Params Generally see LFUN_INSET_INSERT for further details.
3853 \begin_inset Newline newline
3856 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
3857 \begin_inset Newline newline
3860 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
3861 \begin_inset Newline newline
3864 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3865 \begin_inset Newline newline
3868 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
3869 \begin_inset Newline newline
3872 valign-top|valign-bottom|valign-middle|longtabular-align-left|
3873 \begin_inset Newline newline
3876 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
3877 \begin_inset Newline newline
3880 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
3881 \begin_inset Newline newline
3884 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
3885 \begin_inset Newline newline
3888 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
3889 \begin_inset Newline newline
3892 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
3893 \begin_inset Newline newline
3896 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
3897 \begin_inset Newline newline
3900 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3901 \begin_inset Newline newline
3904 set-special-column|set-special-multicolumn|set-special-multirow|
3905 \begin_inset Newline newline
3908 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
3909 \begin_inset Newline newline
3912 set-interline-space|set-border-lines|tabular-valign-top|
3913 \begin_inset Newline newline
3916 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
3917 \begin_inset Newline newline
3920 Various math-environment features are handled as well, e.g. add-vline-left/right for
3921 \begin_inset Newline newline
3924 the Grid/Array environment.
3925 \begin_inset Newline newline
3928 <ARG>: additional argument for some commands, use debug mode to explore its values.
3931 \begin_layout Description
3932 Origin gm, 10 Dec 2015
3935 \begin_layout Subsection*
3939 \begin_layout Description
3940 Action Inserts table into the document.
3943 \begin_layout Description
3944 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
3947 \begin_layout Description
3948 Syntax tabular-insert [<ROWS> <COLUMNS>]
3951 \begin_layout Description
3952 Params In case no arguments are given show insert dialog.
3955 \begin_layout Description
3956 Origin Jug, 12 Apr 2000
3959 \begin_layout Subsection*
3963 \begin_layout Description
3964 Action Look up thesaurus entries with respect to the word under the cursor.
3967 \begin_layout Description
3968 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
3971 \begin_layout Description
3972 Params <STRING>: word to look up <LANG>: language (see file languages)
3975 \begin_layout Description
3976 Origin Levon, 20 Jul 2001
3979 \begin_layout Subsection*
3983 \begin_layout Description
3984 Action Undoes the last edit.
3987 \begin_layout Description
3991 \begin_layout Subsection*
3995 \begin_layout Description
3996 Action Inserts a single unicode character.
3999 \begin_layout Description
4000 Syntax unicode-insert <CHAR>
4003 \begin_layout Description
4004 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
4007 \begin_layout Description
4008 Sample unicode-insert 0x0100
4011 \begin_layout Description
4012 Origin Lgb, 22 Oct 2006
4015 \begin_layout Subsection*
4019 \begin_layout Description
4020 Action Moves the cursor one line in upward direction.
4023 \begin_layout Description
4027 \begin_layout Subsection*
4031 \begin_layout Description
4032 Action Moves the cursor one line in upward direction adding the current position to the selection.
4035 \begin_layout Description
4039 \begin_layout Subsection*
4043 \begin_layout Description
4044 Action Moves the cursor to the logically previous beginning of a word.
4047 \begin_layout Description
4048 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.
4051 \begin_layout Description
4052 Syntax word-backward
4055 \begin_layout Subsection*
4056 word-backward-select
4059 \begin_layout Description
4060 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4063 \begin_layout Description
4064 Notion See also LFUN_WORD_BACKWARD.
4067 \begin_layout Description
4068 Syntax word-backward-select
4071 \begin_layout Subsection*
4075 \begin_layout Description
4076 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4079 \begin_layout Description
4080 Syntax word-capitalize [<SEL_TYPE>]
4083 \begin_layout Description
4084 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.
4087 \begin_layout Subsection*
4088 word-delete-backward
4091 \begin_layout Description
4092 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4095 \begin_layout Description
4096 Syntax word-delete-backward
4099 \begin_layout Subsection*
4103 \begin_layout Description
4104 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4107 \begin_layout Description
4108 Syntax word-delete-forward
4111 \begin_layout Subsection*
4115 \begin_layout Description
4116 Action Search for next occurrence of a string.
4119 \begin_layout Description
4120 Syntax word-find [<DATA>]
4123 \begin_layout Description
4124 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).
4127 \begin_layout Description
4128 Origin Andre, Jan 7 2004
4131 \begin_layout Subsection*
4135 \begin_layout Description
4136 Action Search for a given string in backward direction.
4139 \begin_layout Description
4140 Notion Case sensitive, match words. If no argument given, last search repeated.
4143 \begin_layout Description
4144 Syntax word-find-backward [<STRING>]
4147 \begin_layout Description
4148 Origin Etienne, 20 Feb 1998
4151 \begin_layout Subsection*
4155 \begin_layout Description
4156 Action Search for a given string in forward direction.
4159 \begin_layout Description
4160 Notion Case sensitive, match words. If no argument given, last search repeated.
4163 \begin_layout Description
4164 Syntax word-find-forward [<STRING>]
4167 \begin_layout Description
4168 Origin Etienne, 16 Feb 1998
4171 \begin_layout Subsection*
4175 \begin_layout Description
4176 Action Search for next occurrence of a pattern.
4179 \begin_layout Description
4180 Syntax word-findadv [<DATA>]
4183 \begin_layout Description
4184 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).
4187 \begin_layout Description
4188 Origin Tommaso, Nov 15 2007
4191 \begin_layout Subsection*
4195 \begin_layout Description
4196 Action Moves the cursor to the logically next beginning of a word.
4199 \begin_layout Description
4200 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.
4203 \begin_layout Description
4207 \begin_layout Subsection*
4211 \begin_layout Description
4212 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4215 \begin_layout Description
4216 Notion See also LFUN_WORD_FORWARD.
4219 \begin_layout Description
4220 Syntax word-forward-select
4223 \begin_layout Subsection*
4227 \begin_layout Description
4228 Action Moves the cursor to the next beginning of a word "on the left".
4231 \begin_layout Description
4232 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.
4235 \begin_layout Description
4239 \begin_layout Description
4240 Origin dov, 28 Oct 2007
4243 \begin_layout Subsection*
4247 \begin_layout Description
4248 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4251 \begin_layout Description
4252 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4255 \begin_layout Description
4256 Syntax word-left-select
4259 \begin_layout Description
4260 Origin dov, 28 Oct 2007
4263 \begin_layout Subsection*
4267 \begin_layout Description
4268 Action Change the words in the selection or word at cursor position to lower case.
4271 \begin_layout Description
4272 Syntax word-lowcase [<SEL_TYPE>]
4275 \begin_layout Description
4276 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.
4279 \begin_layout Subsection*
4283 \begin_layout Description
4284 Action Replace a string in the document.
4287 \begin_layout Description
4288 Syntax word-replace [<DATA>]
4291 \begin_layout Description
4292 Params <DATA>: data is of the form "<replace>
4293 \begin_inset Newline newline
4297 \begin_inset Newline newline
4300 <casesensitive> <matchword> <all> <forward> <findnext>"
4303 \begin_layout Description
4304 Origin Andre, Jan 7 2004
4307 \begin_layout Subsection*
4311 \begin_layout Description
4312 Action Moves the cursor to the next beginning of a word "on the right".
4315 \begin_layout Description
4316 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.
4319 \begin_layout Description
4323 \begin_layout Description
4324 Origin dov, 28 Oct 2007
4327 \begin_layout Subsection*
4331 \begin_layout Description
4332 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4335 \begin_layout Description
4336 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4339 \begin_layout Description
4340 Syntax word-right-select
4343 \begin_layout Description
4344 Origin dov, 28 Oct 2007
4347 \begin_layout Subsection*
4351 \begin_layout Description
4352 Action Puts the word where the cursor stands into the selection.
4355 \begin_layout Description
4359 \begin_layout Description
4360 Origin Andre, 11 Sep 2002
4363 \begin_layout Subsection*
4367 \begin_layout Description
4368 Action Change the words in the selection or word at cursor position to upper case.
4371 \begin_layout Description
4372 Syntax word-upcase [<SEL_TYPE>]
4375 \begin_layout Description
4376 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.
4379 \begin_layout Subsection*
4383 \begin_layout Description
4384 Action Inserts floats wrapped by the text around.
4387 \begin_layout Description
4388 Syntax wrap-insert <TYPE>
4391 \begin_layout Description
4392 Params <TYPE>: table|figure
4395 \begin_layout Description
4396 Origin Dekel, 7 Apr 2002
4399 \begin_layout Section
4400 Math Editor Functions
4403 \begin_layout Subsection*
4404 in-mathmacrotemplate
4407 \begin_layout Description
4408 Action Only active in Math Macro definition.
4411 \begin_layout Description
4412 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.
4415 \begin_layout Description
4416 Syntax in-mathmacrotemplate
4419 \begin_layout Description
4420 Origin sts, 06 January 2008
4423 \begin_layout Subsection*
4427 \begin_layout Description
4428 Action Inserts an extended matrix as provided by the amsmath package.
4431 \begin_layout Description
4432 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4435 \begin_layout Description
4436 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'.
4439 \begin_layout Description
4440 Sample math-ams-matrix 3 3 bmatrix
4443 \begin_layout Subsection*
4447 \begin_layout Description
4448 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4451 \begin_layout Description
4452 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4455 \begin_layout Description
4456 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4457 \begin_inset Newline newline
4460 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4463 \begin_layout Description
4464 Sample math-bigdelim "Bigl" "
4471 \begin_layout Description
4472 Origin Enrico & Georg, 7 May 2006
4475 \begin_layout Subsection*
4479 \begin_layout Description
4480 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4483 \begin_layout Description
4484 Syntax math-delim [<LEFT>] [<RIGHT>]
4487 \begin_layout Description
4488 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.
4491 \begin_layout Description
4492 Sample math-delim { rangle
4495 \begin_layout Description
4496 Origin Alejandro, 18 Jun 1996
4499 \begin_layout Subsection*
4503 \begin_layout Description
4504 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4507 \begin_layout Description
4508 Syntax math-display [<ARG>]
4511 \begin_layout Description
4512 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4515 \begin_layout Description
4516 Origin Alejandro, 18 Jun 1996
4519 \begin_layout Subsection*
4523 \begin_layout Description
4524 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4527 \begin_layout Description
4528 Notion Selection can be used to determine the input for the external program.
4531 \begin_layout Description
4532 Syntax math-extern <LANG> [<COMMAND>]
4535 \begin_layout Description
4536 Params <LANG>: octave|maxima|maple|mathematica|script
4537 \begin_inset Newline newline
4540 where "script" stands for the external script (normalized expression will be passed)
4543 \begin_layout Description
4544 Sample math-extern maple simplify
4547 \begin_layout Description
4548 Origin Andre, 24 Apr 2001
4551 \begin_layout Subsection*
4555 \begin_layout Description
4556 Action Changes the text style used in math.
4559 \begin_layout Description
4560 Syntax math-font-style <STYLE>
4563 \begin_layout Description
4564 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4565 \begin_inset Newline newline
4568 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4571 \begin_layout Description
4572 Origin vfr, 9 jan 2009
4575 \begin_layout Subsection*
4579 \begin_layout Description
4580 Action Inserts math objects and symbols.
4583 \begin_layout Description
4584 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4586 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
4588 frac{x}{y}" replaces "abc" with "
4590 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.
4593 \begin_layout Description
4594 Syntax math-insert <ARG>
4597 \begin_layout Description
4598 Params <ARG>: Symbol or LaTeX code to be inserted.
4601 \begin_layout Subsection*
4605 \begin_layout Description
4606 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.
4609 \begin_layout Description
4610 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4613 \begin_layout Description
4614 Syntax math-limits [<STATE>]
4617 \begin_layout Description
4618 Params <STATE>: limits|nolimits
4621 \begin_layout Subsection*
4625 \begin_layout Description
4626 Action Inserts a math macro definition at the cursor position in the text.
4629 \begin_layout Description
4630 Syntax math-macro <NAME> [<NARGS>] [def]
4633 \begin_layout Description
4634 Params <NAME>: The name of the macro, e.g. "mymacro".
4635 \begin_inset Newline newline
4638 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4641 \begin_layout Description
4642 Origin ale, 10 May 1997; sts, 21 Dec 2007
4645 \begin_layout Subsection*
4646 math-macro-add-greedy-optional-param
4649 \begin_layout Description
4650 Action Add a greedy optional parameter.
4653 \begin_layout Description
4654 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4657 \begin_layout Description
4658 Syntax math-macro-add-greedy-optional-param
4661 \begin_layout Description
4662 Origin sts, 06 January 2008
4665 \begin_layout Subsection*
4666 math-macro-add-optional-param
4669 \begin_layout Description
4670 Action Add an optional parameter.
4673 \begin_layout Description
4674 Notion Insert an optional parameter just behind the already existing optional parameters.
4677 \begin_layout Description
4678 Syntax math-macro-add-optional-param
4681 \begin_layout Description
4682 Origin sts, 06 January 2008
4685 \begin_layout Subsection*
4686 math-macro-add-param
4689 \begin_layout Description
4690 Action Add a parameter.
4693 \begin_layout Description
4694 Notion Add a parameter to a Math Macro.
4697 \begin_layout Description
4698 Syntax math-macro-add-param <NUM>
4701 \begin_layout Description
4702 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.
4705 \begin_layout Description
4706 Origin sts, 06 January 2008
4709 \begin_layout Subsection*
4710 math-macro-append-greedy-param
4713 \begin_layout Description
4714 Action Append a greedy parameter.
4717 \begin_layout Description
4718 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
4721 \begin_layout Description
4722 Syntax math-macro-append-greedy-param
4725 \begin_layout Description
4726 Origin sts, 06 January 2008
4729 \begin_layout Subsection*
4733 \begin_layout Description
4734 Action Fold a Math Macro.
4737 \begin_layout Description
4738 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
4743 \begin_layout Description
4744 Syntax math-macro-fold
4747 \begin_layout Description
4748 Origin sts, 06 January 2008
4751 \begin_layout Subsection*
4752 math-macro-make-nonoptional
4755 \begin_layout Description
4756 Action Make a parameter non-optional.
4759 \begin_layout Description
4760 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.
4763 \begin_layout Description
4764 Syntax math-macro-make-nonoptional
4767 \begin_layout Description
4768 Origin sts, 06 January 2008
4771 \begin_layout Subsection*
4772 math-macro-make-optional
4775 \begin_layout Description
4776 Action Make a parameter optional.
4779 \begin_layout Description
4780 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
4783 \begin_layout Description
4784 Syntax math-macro-make-optional
4787 \begin_layout Description
4788 Origin sts, 06 January 2008
4791 \begin_layout Subsection*
4792 math-macro-remove-greedy-param
4795 \begin_layout Description
4796 Action Remove a greedy parameter.
4799 \begin_layout Description
4800 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.
4803 \begin_layout Description
4804 Syntax math-macro-remove-greedy-param
4807 \begin_layout Description
4808 Origin sts, 06 January 2008
4811 \begin_layout Subsection*
4812 math-macro-remove-optional-param
4815 \begin_layout Description
4816 Action Remove the last optional parameter.
4819 \begin_layout Description
4820 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
4823 \begin_layout Description
4824 Syntax math-macro-remove-optional-param
4827 \begin_layout Description
4828 Origin sts, 06 January 2008
4831 \begin_layout Subsection*
4832 math-macro-remove-param
4835 \begin_layout Description
4836 Action Remove the last parameter.
4839 \begin_layout Description
4840 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
4843 \begin_layout Description
4844 Syntax math-macro-remove-param <NUM>
4847 \begin_layout Description
4848 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
4851 \begin_layout Description
4852 Origin sts, 06 January 2008
4855 \begin_layout Subsection*
4859 \begin_layout Description
4860 Action Unfold a Math Macro.
4863 \begin_layout Description
4864 Notion Unfold the Math Macro the cursor is in, i.e. display it as
4869 \begin_layout Description
4870 Syntax math-macro-unfold
4873 \begin_layout Description
4874 Origin sts, 06 January 2008
4877 \begin_layout Subsection*
4881 \begin_layout Description
4882 Action Inserts a matrix.
4885 \begin_layout Description
4886 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
4889 \begin_layout Description
4890 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).
4893 \begin_layout Description
4894 Sample math-matrix 3 3 bccc
4897 \begin_layout Subsection*
4901 \begin_layout Description
4902 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.
4905 \begin_layout Description
4906 Notion If there is some selected text, it puts the text inside created math box.
4909 \begin_layout Description
4910 Syntax math-mode [on|<ARG>]
4913 \begin_layout Description
4914 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
4915 \begin_inset Newline newline
4918 "on": allow only entering of math mode from text mode.
4921 \begin_layout Description
4922 Origin Alejandro, 4 Jun 1996
4925 \begin_layout Subsection*
4929 \begin_layout Description
4930 Action Mutates the type of math inset to the newly selected one.
4933 \begin_layout Description
4934 Syntax math-mutate <TYPE>
4937 \begin_layout Description
4938 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
4941 \begin_layout Description
4942 Origin Andre, 23 May 2001
4945 \begin_layout Subsection*
4946 math-number-line-toggle
4949 \begin_layout Description
4950 Action Toggles numbering of the current formula line.
4953 \begin_layout Description
4954 Notion Must be in display formula mode.
4957 \begin_layout Description
4958 Syntax math-number-line-toggle
4961 \begin_layout Description
4962 Origin Alejandro, 18 Jun 1996
4965 \begin_layout Subsection*
4969 \begin_layout Description
4970 Action Toggles numbering/labeling of the current formula.
4973 \begin_layout Description
4974 Notion Must be in display formula mode.
4977 \begin_layout Description
4978 Syntax math-number-toggle
4981 \begin_layout Description
4982 Origin Alejandro, 4 Jun 1996
4985 \begin_layout Subsection*
4989 \begin_layout Description
4990 Action Changes arbitrarily the size used by math fonts inside a context.
4993 \begin_layout Description
4994 Notion Provides an interface to the LaTeX math mode font size commands.
4997 \begin_layout Description
4998 Syntax math-size <STYLE>
5001 \begin_layout Description
5013 \begin_layout Description
5014 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5017 \begin_layout Subsection*
5021 \begin_layout Description
5022 Action Inserts space into math expression.
5025 \begin_layout Description
5026 Notion Use spacebar after entering this space to change type of space.
5029 \begin_layout Description
5030 Syntax math-space [<TYPE>] [<LEN>]
5033 \begin_layout Description
5034 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5035 \begin_inset Newline newline
5038 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5039 \begin_inset Newline newline
5042 custom space: hspace
5043 \begin_inset Newline newline
5046 "," used by default.
5047 \begin_inset Newline newline
5050 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5051 \begin_inset Newline newline
5054 <LEN>: length for custom spaces (hspace)
5057 \begin_layout Description
5058 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5061 \begin_layout Subsection*
5065 \begin_layout Description
5066 Action Enters subscript expression in math expression.
5069 \begin_layout Description
5070 Syntax math-subscript
5073 \begin_layout Description
5074 Origin vermeer, 12 Dec 2001
5077 \begin_layout Subsection*
5081 \begin_layout Description
5082 Action Enters superscript expression in math expression.
5085 \begin_layout Description
5086 Syntax math-superscript
5089 \begin_layout Description
5090 Origin vermeer, 12 Dec 2001
5093 \begin_layout Subsection*
5097 \begin_layout Description
5098 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5101 \begin_layout Description
5102 Notion If there is any selected text, then it is moved inside the created regexp inset.
5105 \begin_layout Description
5106 Syntax regexp-mode [<ARG>]
5109 \begin_layout Description
5110 Params <ARG>: eventual argument (regular expression).
5113 \begin_layout Description
5114 Origin Tommaso, 4 Oct 2008
5117 \begin_layout Section
5118 Buffer Fuctions (File and Window related)
5121 \begin_layout Subsection*
5125 \begin_layout Description
5126 Action Activate the branch.
5129 \begin_layout Description
5130 Syntax branch-activate <BRANCH>
5133 \begin_layout Description
5134 Params <BRANCH>: The branch to activate
5137 \begin_layout Description
5138 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5139 \begin_inset Newline newline
5142 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5145 \begin_layout Description
5146 Origin rgh, 27 May 2008
5149 \begin_layout Subsection*
5153 \begin_layout Description
5154 Action Add a branch to the buffer's BranchList.
5157 \begin_layout Description
5158 Syntax branch-add <BRANCH>
5161 \begin_layout Description
5162 Params <BRANCH>: Name of the branch to add
5165 \begin_layout Description
5166 Origin spitz, 7 Jul 2009
5169 \begin_layout Subsection*
5173 \begin_layout Description
5174 Action Create new branch and directly put the branch inset into the document.
5177 \begin_layout Description
5178 Syntax branch-add-insert [<NAME>]
5181 \begin_layout Description
5182 Params <NAME>: Branch name. If it is not specified, you will be asked.
5185 \begin_layout Description
5186 Origin sanda, 10 Jul 2009
5189 \begin_layout Subsection*
5193 \begin_layout Description
5194 Action De-activate the branch.
5197 \begin_layout Description
5198 Syntax branch-deactivate <BRANCH>
5201 \begin_layout Description
5202 Params <BRANCH>: The branch to deactivate
5205 \begin_layout Description
5206 Origin rgh, 27 May 2008
5209 \begin_layout Subsection*
5210 branch-master-activate
5213 \begin_layout Description
5214 Action Activate the branch in the master buffer.
5217 \begin_layout Description
5218 Syntax branch-master-activate <BRANCH>
5221 \begin_layout Description
5222 Params <BRANCH>: The branch to activate
5225 \begin_layout Description
5226 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5227 \begin_inset Newline newline
5230 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5233 \begin_layout Description
5234 Origin spitz, 30 Sep 2012
5237 \begin_layout Subsection*
5238 branch-master-deactivate
5241 \begin_layout Description
5242 Action De-activate the branch in the master buffer.
5245 \begin_layout Description
5246 Syntax branch-master-deactivate <BRANCH>
5249 \begin_layout Description
5250 Params <BRANCH>: The branch to deactivate
5253 \begin_layout Description
5254 Origin spitz, 30 Sep 2012
5257 \begin_layout Subsection*
5261 \begin_layout Description
5262 Action Rename all branches of a given name in a document.
5265 \begin_layout Description
5266 Syntax branches-rename <OLDNAME> <NEWNAME>
5269 \begin_layout Description
5270 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5273 \begin_layout Description
5274 Origin spitz, 9 Jul 2009
5277 \begin_layout Subsection*
5281 \begin_layout Description
5282 Action Saves the current buffer to a temporary file.
5285 \begin_layout Description
5286 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5289 \begin_layout Description
5290 Syntax buffer-auto-save
5293 \begin_layout Subsection*
5297 \begin_layout Description
5298 Action Loads the given child document.
5301 \begin_layout Description
5302 Notion The current document is treated as a parent.
5305 \begin_layout Description
5306 Syntax buffer-child-open <FILE>
5309 \begin_layout Description
5310 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5313 \begin_layout Description
5314 Origin Ale, 28 May 1997
5317 \begin_layout Subsection*
5321 \begin_layout Description
5322 Action Runs chktex for the current document.
5325 \begin_layout Description
5326 Syntax buffer-chktex
5329 \begin_layout Description
5330 Origin Asger, 30 Oct 1997
5333 \begin_layout Subsection*
5337 \begin_layout Description
5338 Action Closes the current buffer.
5341 \begin_layout Description
5342 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5345 \begin_layout Description
5349 \begin_layout Subsection*
5353 \begin_layout Description
5354 Action Closes all buffers.
5357 \begin_layout Description
5358 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5361 \begin_layout Description
5362 Syntax buffer-close-all
5365 \begin_layout Subsection*
5369 \begin_layout Description
5370 Action Exports the current buffer (document) to the given format.
5373 \begin_layout Description
5374 Syntax buffer-export <FORMAT> [<DEST>]
5377 \begin_layout Description
5378 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.
5379 \begin_inset Newline newline
5382 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. <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.
5385 \begin_layout Description
5386 Origin Lgb, 29 Jul 1997
5389 \begin_layout Subsection*
5393 \begin_layout Description
5394 Action Opens a dialog for exporting the current buffer.
5397 \begin_layout Description
5398 Syntax buffer-export-as [<FORMAT>]
5401 \begin_layout Description
5402 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.
5405 \begin_layout Description
5406 Sample buffer-export-as pdf2
5409 \begin_layout Description
5410 Origin tommaso, 6 Oct 2011
5413 \begin_layout Subsection*
5414 buffer-export-custom
5417 \begin_layout Description
5418 Action Exports the current buffer (document) from the given format using the given command on it.
5421 \begin_layout Description
5422 Syntax buffer-export-custom <FORMAT> <COMMAND>
5425 \begin_layout Description
5426 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5427 \begin_inset Newline newline
5430 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5433 \begin_layout Description
5434 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5437 \begin_layout Description
5438 Origin leeming, 27 Mar 2004
5441 \begin_layout Subsection*
5445 \begin_layout Description
5446 Action Applies a command to all non-hidden buffers.
5449 \begin_layout Description
5450 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5453 \begin_layout Description
5454 Syntax buffer-forall <LFUN-COMMAND>
5457 \begin_layout Description
5458 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5461 \begin_layout Description
5462 Sample Close all Notes in buffers:
5463 \begin_inset Newline newline
5466 buffer-forall inset-forall Note inset-toggle close
5467 \begin_inset Newline newline
5470 Toggle change tracking on buffers:
5471 \begin_inset Newline newline
5474 buffer-forall changes-track
5475 \begin_inset Newline newline
5478 Toggle read-only for buffers:
5479 \begin_inset Newline newline
5482 buffer-forall buffer-toggle-read-only
5483 \begin_inset Newline newline
5486 Show statistics for individual buffers:
5487 \begin_inset Newline newline
5490 buffer-forall statistics
5491 \begin_inset Newline newline
5494 Activate the branch named "Solutions" in buffers:
5495 \begin_inset Newline newline
5498 buffer-forall branch-activate Solutions
5499 \begin_inset Newline newline
5502 Export buffers to PDF (pdflatex):
5503 \begin_inset Newline newline
5506 buffer-forall buffer-export pdf2
5507 \begin_inset Newline newline
5513 \begin_layout Description
5514 Origin skostysh, 20 Jul 2012
5517 \begin_layout Subsection*
5521 \begin_layout Description
5522 Action Import a given file as a lyx document.
5525 \begin_layout Description
5526 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.
5529 \begin_layout Description
5530 Syntax buffer-import <FORMAT> [<FILE>]
5533 \begin_layout Description
5534 Origin Asger, 24 Jul 1998
5537 \begin_layout Subsection*
5541 \begin_layout Description
5542 Action Set language of the current document.
5545 \begin_layout Description
5546 Syntax buffer-language <LANG>
5549 \begin_layout Description
5550 Params <LANG>: language name. See lib/languages for list.
5553 \begin_layout Description
5554 Origin leeming, 30 Mar 2004
5557 \begin_layout Subsection*
5561 \begin_layout Description
5562 Action Moves the current tab one spot to the right.
5565 \begin_layout Description
5566 Syntax buffer-move-next
5569 \begin_layout Description
5570 Origin skostysh, 7 Apr 2015
5573 \begin_layout Subsection*
5574 buffer-move-previous
5577 \begin_layout Description
5578 Action Moves the current tab one spot to the left.
5581 \begin_layout Description
5582 Syntax buffer-move-previous
5585 \begin_layout Description
5586 Origin skostysh, 7 Apr 2015
5589 \begin_layout Subsection*
5593 \begin_layout Description
5594 Action Creates a new buffer (that is, document) and switches to it.
5597 \begin_layout Description
5598 Notion Implicit path can be set in Preferences dialog.
5601 \begin_layout Description
5602 Syntax buffer-new [<FILE>]
5605 \begin_layout Description
5606 Params <FILE>: filename of created file with absolute path.
5609 \begin_layout Subsection*
5613 \begin_layout Description
5614 Action Creates a new buffer (that is, document) from a template.
5617 \begin_layout Description
5618 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5621 \begin_layout Description
5622 Syntax buffer-new-template [<FILE>]
5625 \begin_layout Description
5626 Params <FILE>: filename of created file with absolute path.
5629 \begin_layout Subsection*
5633 \begin_layout Description
5634 Action Switch to the next opened document.
5637 \begin_layout Description
5638 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
5641 \begin_layout Description
5645 \begin_layout Subsection*
5649 \begin_layout Description
5650 Action Apply the given settings to the current document.
5653 \begin_layout Description
5654 Syntax buffer-params-apply [<ARGS>]
5657 \begin_layout Description
5658 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5661 \begin_layout Description
5662 Origin leeming, 30 Mar 2004
5665 \begin_layout Subsection*
5669 \begin_layout Description
5670 Action Switch to the previous opened document.
5673 \begin_layout Description
5674 Syntax buffer-previous
5677 \begin_layout Subsection*
5681 \begin_layout Description
5682 Action Reverts opened document.
5685 \begin_layout Description
5686 Syntax buffer-reload
5689 \begin_layout Description
5690 Origin Asger, 2 Feb 1997
5693 \begin_layout Subsection*
5694 buffer-save-as-default
5697 \begin_layout Description
5698 Action Save the current document settings as default.
5701 \begin_layout Description
5702 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5705 \begin_layout Description
5706 Syntax buffer-save-as-default [<ARGS>]
5709 \begin_layout Description
5710 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5713 \begin_layout Description
5714 Origin leeming, 30 Mar 2004
5717 \begin_layout Subsection*
5721 \begin_layout Description
5722 Action Display and switch to the given buffer.
5725 \begin_layout Description
5726 Syntax buffer-switch <BUFFER>
5729 \begin_layout Description
5730 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
5733 \begin_layout Subsection*
5734 buffer-toggle-compression
5737 \begin_layout Description
5738 Action Toggles compression of the current document on/off.
5741 \begin_layout Description
5742 Syntax buffer-toggle-compression
5745 \begin_layout Description
5746 Origin bpeng, 27 Apr 2006
5749 \begin_layout Subsection*
5750 buffer-toggle-read-only
5753 \begin_layout Description
5754 Action Toggle editing mode of the current document between read/write and read-only.
5757 \begin_layout Description
5758 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.
5761 \begin_layout Description
5762 Syntax buffer-toggle-read-only
5765 \begin_layout Description
5766 Origin Lgb, 27 May 1997
5769 \begin_layout Subsection*
5773 \begin_layout Description
5774 Action Exports the current document and put the result into the temporary directory.
5777 \begin_layout Description
5778 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript).
5781 \begin_layout Description
5782 Syntax buffer-update [<FORMAT>]
5785 \begin_layout Description
5786 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.
5789 \begin_layout Description
5790 Origin Dekel, 5 Aug 2000
5793 \begin_layout Subsection*
5797 \begin_layout Description
5798 Action Displays current buffer in chosen format.
5801 \begin_layout Description
5802 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.
5805 \begin_layout Description
5806 Syntax buffer-view [<FORMAT>]
5809 \begin_layout Description
5810 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.
5813 \begin_layout Subsection*
5817 \begin_layout Description
5818 Action Opens the file that was created from last preview of this buffer.
5821 \begin_layout Description
5822 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.
5825 \begin_layout Description
5826 Syntax buffer-view-cache
5829 \begin_layout Subsection*
5833 \begin_layout Description
5834 Action Saves the current buffer.
5837 \begin_layout Description
5838 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.
5841 \begin_layout Description
5845 \begin_layout Subsection*
5849 \begin_layout Description
5850 Action Save all changed documents.
5853 \begin_layout Description
5854 Syntax buffer-write-all
5857 \begin_layout Description
5858 Origin rgh, gpothier 6 Aug 2007
5861 \begin_layout Subsection*
5865 \begin_layout Description
5866 Action Rename and save current buffer.
5869 \begin_layout Description
5870 Syntax buffer-write-as <FILENAME>
5873 \begin_layout Description
5874 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
5877 \begin_layout Subsection*
5881 \begin_layout Description
5882 Action Increases the zoom of the screen fonts.
5885 \begin_layout Description
5886 Syntax buffer-zoom-in [<ZOOM>]
5889 \begin_layout Description
5890 Params <ZOOM>: The zoom in %, the default is 20.
5893 \begin_layout Description
5894 Origin vfr, 30 Mar 2009
5897 \begin_layout Subsection*
5901 \begin_layout Description
5902 Action Decreases the zoom of the screen fonts.
5905 \begin_layout Description
5906 Syntax buffer-zoom-out [<ZOOM>]
5909 \begin_layout Description
5910 Params <ZOOM>: The zoom in %, the default is 20.
5913 \begin_layout Description
5914 Origin vfr, 30 Mar 2009
5917 \begin_layout Subsection*
5921 \begin_layout Description
5922 Action Generates the code (literate programming).
5925 \begin_layout Description
5926 Notion Latex file with extension
5928 literate_extension is generated. Then LyX invokes
5930 build_command (with a default of ``make'') to generate the code and
5932 build_error_filter to process the compilation error messages.
5933 \begin_inset Newline newline
5936 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:
5937 \begin_inset Newline newline
5942 build_command "my_script my_arguments"
5943 \begin_inset Newline newline
5948 build_error_filter differs from the
5950 literate_error_filter only in that the former will identify error messages from your compiler.
5953 \begin_layout Description
5954 Syntax build-program
5957 \begin_layout Subsection*
5961 \begin_layout Description
5962 Action Open LyX document.
5965 \begin_layout Description
5966 Syntax file-open [<FILE>]
5969 \begin_layout Description
5970 Params <FILE>: Filename to be opened.
5973 \begin_layout Subsection*
5977 \begin_layout Description
5978 Action Open the given help file according to the language setting.
5981 \begin_layout Description
5982 Syntax help-open <FILE>[.lyx]
5985 \begin_layout Description
5986 Params <FILE>: any document from (/usr/share/)doc directory.
5989 \begin_layout Description
5990 Origin Jug, 27 Jun 1999
5993 \begin_layout Subsection*
5997 \begin_layout Description
5998 Action Terminates the current LyX instance.
6001 \begin_layout Description
6002 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6005 \begin_layout Description
6009 \begin_layout Subsection*
6010 master-buffer-update
6013 \begin_layout Description
6014 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6017 \begin_layout Description
6018 Syntax master-buffer-update [<FORMAT>]
6021 \begin_layout Description
6022 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.
6025 \begin_layout Description
6026 Origin Tommaso, 20 Sep 2007
6029 \begin_layout Subsection*
6033 \begin_layout Description
6034 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6037 \begin_layout Description
6038 Syntax master-buffer-view [<FORMAT>]
6041 \begin_layout Description
6042 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.
6045 \begin_layout Description
6046 Origin Tommaso, 20 Sep 2007
6049 \begin_layout Subsection*
6053 \begin_layout Description
6054 Action Opens the menu given by its name.
6057 \begin_layout Description
6058 Syntax menu-open <NAME>
6061 \begin_layout Description
6062 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6065 \begin_layout Subsection*
6069 \begin_layout Description
6070 Action Close the current tab group.
6073 \begin_layout Description
6074 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6077 \begin_layout Description
6078 Syntax tab-group-close
6081 \begin_layout Description
6082 Origin Abdel, 21 Feb 2008
6085 \begin_layout Subsection*
6089 \begin_layout Description
6090 Action Toggles visibility of a given toolbar between on/off/auto.
6093 \begin_layout Description
6094 Notion Skipping "auto" when allowauto is false.
6097 \begin_layout Description
6098 Syntax toolbar-toggle <NAME> [allowauto]
6101 \begin_layout Description
6102 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6103 \begin_inset Newline newline
6106 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6109 \begin_layout Description
6110 Origin Edwin, 21 May 2007
6113 \begin_layout Subsection*
6117 \begin_layout Description
6118 Action Various UI visibility-toggling actions.
6121 \begin_layout Description
6122 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6125 \begin_layout Description
6126 Params statusbar : Toggle visibility of the statusbar.
6127 \begin_inset Newline newline
6130 menubar : Toggle visibility of the menubar.
6131 \begin_inset Newline newline
6134 scrollbar : Toggle visibility of the scrollbar.
6135 \begin_inset Newline newline
6138 frame : Toggle visibility of the frames around editing window.
6139 \begin_inset Newline newline
6142 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.
6145 \begin_layout Description
6146 Origin sanda, 9 Feb 2007
6149 \begin_layout Subsection*
6153 \begin_layout Description
6154 Action Close the current document work area.
6157 \begin_layout Description
6158 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6161 \begin_layout Description
6165 \begin_layout Description
6166 Origin Tommaso, 15 Sep 2012
6169 \begin_layout Subsection*
6173 \begin_layout Description
6174 Action Creates another split view of current buffer.
6177 \begin_layout Description
6178 Notion All split views act in the same way independently.
6181 \begin_layout Description
6182 Syntax view-split <vertical|horizontal>
6185 \begin_layout Description
6186 Params horizontal : The work areas are laid out side by side.
6187 \begin_inset Newline newline
6190 vertical : The work areas laid out vertically.
6193 \begin_layout Description
6194 Origin Abdel, 20 Feb 2008
6197 \begin_layout Subsection*
6201 \begin_layout Description
6202 Action Closes the current LyX window.
6205 \begin_layout Description
6209 \begin_layout Description
6210 Origin Abdel, 23 Oct 2006
6213 \begin_layout Subsection*
6217 \begin_layout Description
6218 Action Creates new empty LyX window.
6221 \begin_layout Description
6222 Notion Already opened documents from the previous window can be found under View menu.
6225 \begin_layout Description
6226 Syntax window-new [<GEOMETRY>]
6229 \begin_layout Description
6230 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6233 \begin_layout Description
6234 Origin Abdel, 21 Oct 2006
6237 \begin_layout Section
6238 System Functions (Preferences, LyX Server etc.)
6241 \begin_layout Subsection*
6242 buffer-toggle-output-sync
6245 \begin_layout Description
6246 Action Toggles including of resources for forward/reverse search of the given document.
6249 \begin_layout Description
6250 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6253 \begin_layout Description
6254 Syntax buffer-toggle-output-sync
6257 \begin_layout Description
6258 Origin sanda, 25 May 2010
6261 \begin_layout Subsection*
6265 \begin_layout Description
6266 Action Executes a command defined in a .def file.
6269 \begin_layout Description
6270 Notion The definitions are by default read from lib/commands/default.def.
6271 \begin_inset Newline newline
6274 A .def file allows to define a command with
6276 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).
6278 def_file "FileName" allows to include another .def file.
6279 \begin_inset Newline newline
6282 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.
6285 \begin_layout Description
6289 \begin_layout Description
6290 Params <NAME>: Name of the command that must be called.
6293 \begin_layout Description
6294 Origin broider, 2 Oct 2007
6297 \begin_layout Subsection*
6301 \begin_layout Description
6302 Action Cancels sequence prepared by LFUN_META_PREFIX .
6305 \begin_layout Description
6309 \begin_layout Subsection*
6310 command-alternatives
6313 \begin_layout Description
6314 Action Runs the first listed command that is enabled.
6317 \begin_layout Description
6318 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6321 \begin_layout Description
6322 Syntax command-alternatives <CMDS>
6325 \begin_layout Description
6326 Params <CMDS>: Sequence of commands separated by semicolons.
6329 \begin_layout Description
6330 Sample command-alternatives completion-accept;cell-forward
6333 \begin_layout Description
6334 Origin rgh, 24 September 2008
6337 \begin_layout Subsection*
6341 \begin_layout Description
6342 Action Run more commands (LFUN and its parameters) in a sequence.
6345 \begin_layout Description
6346 Syntax command-sequence <CMDS>
6349 \begin_layout Description
6350 Params <CMDS>: Sequence of commands separated by semicolons.
6353 \begin_layout Description
6354 Sample command-sequence cut; ert-insert; self-insert
6356 ; paste; self-insert {}; inset-toggle;
6359 \begin_layout Description
6360 Origin Andre, 11 Nov 1999
6363 \begin_layout Subsection*
6364 cursor-follows-scrollbar-toggle
6367 \begin_layout Description
6368 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6371 \begin_layout Description
6372 Syntax toggle-cursor-follows-scrollbar
6375 \begin_layout Description
6376 Origin ARRae, 2 Dec 1997
6379 \begin_layout Subsection*
6383 \begin_layout Description
6384 Action Set debug output level.
6387 \begin_layout Description
6388 Syntax debug-level-set <LEVEL>
6391 \begin_layout Description
6392 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.
6395 \begin_layout Description
6396 Origin sanda, 28 Dec 2009
6399 \begin_layout Subsection*
6403 \begin_layout Description
6404 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6407 \begin_layout Description
6408 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6411 \begin_layout Description
6412 Syntax forward-search
6415 \begin_layout Description
6416 Origin sanda, 14 Apr 2010
6419 \begin_layout Subsection*
6423 \begin_layout Description
6424 Action Apply the given settings to user preferences.
6427 \begin_layout Description
6428 Syntax lyxrc-apply <SETTINGS>
6431 \begin_layout Description
6432 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.
6435 \begin_layout Subsection*
6439 \begin_layout Description
6440 Action Shows message in statusbar (for script purposes).
6443 \begin_layout Description
6444 Syntax message <STRING>
6447 \begin_layout Description
6448 Origin Lgb, 8 Apr 2001
6451 \begin_layout Subsection*
6455 \begin_layout Description
6456 Action Simulate halting Meta key (Alt key on PCs).
6459 \begin_layout Description
6460 Notion Used for buffer edition not for GUI control.
6463 \begin_layout Description
6467 \begin_layout Subsection*
6471 \begin_layout Description
6472 Action Save user preferences.
6475 \begin_layout Description
6476 Syntax preferences-save
6479 \begin_layout Description
6480 Origin Lgb, 27 Nov 1999
6483 \begin_layout Subsection*
6487 \begin_layout Description
6488 Action Reconfigure the automatic settings.
6491 \begin_layout Description
6495 \begin_layout Description
6496 Origin Asger, 14 Feb 1997
6499 \begin_layout Subsection*
6503 \begin_layout Description
6504 Action Returns path and file name of the currently edited document.
6507 \begin_layout Description
6508 Syntax server-get-filename
6511 \begin_layout Subsection*
6515 \begin_layout Description
6516 Action Returns the current layout (that is environment) name on the cursor position.
6519 \begin_layout Description
6520 Syntax server-get-layout
6523 \begin_layout Subsection*
6524 server-get-statistics
6527 \begin_layout Description
6528 Action Returns the statistics (number of words and characters) in the document or in the given selection.
6531 \begin_layout Description
6532 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6535 \begin_layout Description
6536 Syntax server-get-statistics [<TYPE>]
6539 \begin_layout Description
6540 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
6541 \begin_inset Newline newline
6545 \begin_inset Newline newline
6548 chars: count characters.
6549 \begin_inset Newline newline
6552 chars-space: count characters and spaces.
6555 \begin_layout Description
6556 Origin brokenclock, Oct 10 2014
6559 \begin_layout Subsection*
6563 \begin_layout Description
6564 Action Returns the coordinates of cursor position in the editing area.
6567 \begin_layout Description
6568 Syntax server-get-xy
6571 \begin_layout Subsection*
6572 server-goto-file-row
6575 \begin_layout Description
6576 Action Sets the cursor position in LyX based on the row number of generated TeX file.
6579 \begin_layout Description
6580 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).
6583 \begin_layout Description
6584 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
6587 \begin_layout Description
6588 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.
6589 \begin_inset Newline newline
6592 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).
6593 \begin_inset Newline newline
6596 .ext: extensions will be automatically replaced by .lyx.
6597 \begin_inset Newline newline
6600 <ROW_NUMBER> The row number of the LaTeX file to which to go.
6603 \begin_layout Description
6604 Sample server-goto-file-row /home/user/example.lyx 41
6605 \begin_inset Newline newline
6608 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
6611 \begin_layout Description
6612 Origin Edmar, 23 Dec 1998
6615 \begin_layout Subsection*
6619 \begin_layout Description
6620 Action Sends notify message about the last key-sequence to client.
6623 \begin_layout Description
6624 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
6627 \begin_layout Description
6628 Syntax server-notify
6631 \begin_layout Subsection*
6635 \begin_layout Description
6636 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
6639 \begin_layout Description
6640 Syntax server-set-xy <X> <Y>
6643 \begin_layout Subsection*
6647 \begin_layout Description
6648 Action Set the given LyX color to the color defined by the X11 name given.
6651 \begin_layout Description
6652 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
6655 \begin_layout Description
6656 Syntax set-color <LYX_NAME> <X11_NAME>
6659 \begin_layout Description
6660 Origin SLior, 11 Jun 2000
6663 \begin_layout Subsection*
6667 \begin_layout Description
6668 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
6671 \begin_layout Description
6672 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6675 \begin_layout Description
6679 \begin_layout Description
6680 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6683 \begin_layout Subsection*
6687 \begin_layout Description
6688 Action Checks-in/commits the changes of the registered file to the repository.
6691 \begin_layout Description
6692 Notion In RCS case this also unlocks the file.
6695 \begin_layout Description
6699 \begin_layout Description
6700 Origin Lgb, 1 Jul 1997
6703 \begin_layout Subsection*
6707 \begin_layout Description
6708 Action Checks-out the document for edit (and locks it in some cases).
6711 \begin_layout Description
6715 \begin_layout Description
6716 Origin Lgb, 1 Jul 1997
6719 \begin_layout Subsection*
6723 \begin_layout Description
6724 Action Executes external command. This command is intended to support additional VCS commands.
6727 \begin_layout Description
6728 Syntax vc-command <FLAG> <PATH> <COMMAND>
6731 \begin_layout Description
6732 Params <FLAG>: Flags for the command can be combined together.
6733 \begin_inset Newline newline
6736 U - dUmmy - no flags
6737 \begin_inset Newline newline
6740 D - Doc - need document loaded to proceed
6741 \begin_inset Newline newline
6744 I - dIrty - mark document dirty
6745 \begin_inset Newline newline
6748 R - Reload - ensure that the document is saved and reload it after command execution
6749 \begin_inset Newline newline
6752 M - Message - ask for input string (commit message)
6753 \begin_inset Newline newline
6756 <PATH>: path where to start. $$p will be replaced by the current document path.
6757 \begin_inset Newline newline
6760 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
6763 \begin_layout Description
6764 Sample vc-command DR $$p "svn up"
6767 \begin_layout Description
6768 Origin sanda, 13 Jan 2009
6771 \begin_layout Subsection*
6775 \begin_layout Description
6776 Action Compares two revisions of the same file under version control.
6779 \begin_layout Description
6780 Syntax vc-compare [<REV1>] [<REV2>]
6783 \begin_layout Description
6784 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
6785 \begin_inset Newline newline
6788 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
6789 \begin_inset Newline newline
6793 \begin_inset Newline newline
6796 <REV2>: Newer file. Used only if REV1 > 0.
6797 \begin_inset Newline newline
6800 If no parameter is given, interactive dialog will be shown.
6803 \begin_layout Description
6804 Sample Compare current document against last commit
6805 \begin_inset Newline newline
6809 \begin_inset Newline newline
6812 Compare current document against current revision - 5 commits
6813 \begin_inset Newline newline
6817 \begin_inset Newline newline
6820 Compare revisions 120 and 155
6821 \begin_inset Newline newline
6827 \begin_layout Description
6828 Origin sanda, 12 Feb 2010
6831 \begin_layout Subsection*
6835 \begin_layout Description
6836 Action Copies the document to another name.
6839 \begin_layout Description
6840 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.
6843 \begin_layout Description
6844 Syntax vc-copy <FILENAME>
6847 \begin_layout Description
6848 Params <FILENAME>: New name of the document.
6849 \begin_inset Newline newline
6852 A file dialog is opened if no filename is given.
6855 \begin_layout Description
6856 Origin gb, 05 Feb 2013
6859 \begin_layout Subsection*
6863 \begin_layout Description
6864 Action Toggles the locking property of the edited file.
6867 \begin_layout Description
6868 Notion This is currently implemented only for SVN.
6871 \begin_layout Description
6872 Syntax vc-locking-toggle
6875 \begin_layout Description
6876 Origin sanda, 25 Jun 2009
6879 \begin_layout Subsection*
6883 \begin_layout Description
6884 Action Register the document as an file inside version control system.
6887 \begin_layout Description
6888 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
6889 \begin_inset Newline newline
6892 See LyX Additional Features Manual (Version Control Chapter) for additional information.
6895 \begin_layout Description
6899 \begin_layout Description
6900 Origin Lgb, 1 Jul 1997
6903 \begin_layout Subsection*
6907 \begin_layout Description
6908 Action Renames the document to another name.
6911 \begin_layout Description
6912 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.
6915 \begin_layout Description
6916 Syntax vc-rename <FILENAME>
6919 \begin_layout Description
6920 Params <FILENAME>: New name of the document.
6921 \begin_inset Newline newline
6924 A file dialog is opened if no filename is given.
6927 \begin_layout Description
6928 Origin gb, 05 Feb 2013
6931 \begin_layout Subsection*
6935 \begin_layout Description
6936 Action Update the local archive directory in which resides the current document with the remote repository.
6939 \begin_layout Description
6940 Syntax vc-repo-update
6943 \begin_layout Description
6944 Origin sanda, 16 Oct 2009
6947 \begin_layout Subsection*
6951 \begin_layout Description
6952 Action Reverts the document to the last check-in/commit in VCS.
6955 \begin_layout Description
6959 \begin_layout Description
6960 Origin Lgb, 1 Jul 1997
6963 \begin_layout Subsection*
6967 \begin_layout Description
6968 Action Undo last check-in.
6971 \begin_layout Description
6972 Notion This is currently implemented only for RCS.
6975 \begin_layout Description
6979 \begin_layout Description
6980 Origin Lgb, 1 Jul 1997
6983 \begin_layout Section
6984 Hidden Functions (not listed for configuration)
6987 \begin_layout Subsection*
6991 \begin_layout Description
6992 Action Return the current key sequence and available options as a string.
6995 \begin_layout Description
6996 Notion No options are added if no current map exists.
6997 \begin_inset Newline newline
7000 This is probably usable only with connection to lyxserver.
7003 \begin_layout Description
7004 Syntax command-prefix
7007 \begin_layout Subsection*
7011 \begin_layout Description
7012 Action Inserts the given string (accordingly to the correct keymap).
7015 \begin_layout Description
7016 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7019 \begin_layout Description
7020 Syntax self-insert <STRING>