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
108 \begin_layout Section*
112 \begin_layout Standard
113 This manual documents the
114 \begin_inset Quotes eld
118 \begin_inset Quotes erd
122 These are commands that are used to make \SpecialChar LyX
123 perform specific actions.
125 itself uses these functions internally, and every internal action is
129 \begin_layout Standard
130 LFUNs are also used in the files that define keyboard shortcuts, menu or
132 So if you want to change\SpecialChar breakableslash
133 customize the user interface, you need to deal
135 Furthermore, external programs can use LFUNs to communicate with and
136 \begin_inset Quotes eld
140 \begin_inset Quotes erd
145 Finally, you can also issue LFUNs directly via the so called mini-buffer
146 which can be opened via
149 arg "command-execute"
155 \begin_layout Standard
156 In the following, all LFUNs are listed, categorized by function.
159 \begin_layout Section
160 Layout Functions (Font, Layout and Textclass related)
163 \begin_layout Subsection*
167 \begin_layout Description
168 Action Displays list of layout choices.
171 \begin_layout Description
172 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
175 \begin_layout Description
176 Syntax drop-layouts-choice
179 \begin_layout Subsection*
183 \begin_layout Description
184 Action Splits the current environment with a Separator.
187 \begin_layout Description
188 Syntax environment-split [outer]
191 \begin_layout Description
192 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
195 \begin_layout Description
196 Origin spitz, 23 Dec 2012
199 \begin_layout Subsection*
203 \begin_layout Description
204 Action Toggles the bold font (selection-wise) using mathbf in math.
207 \begin_layout Description
211 \begin_layout Subsection*
215 \begin_layout Description
216 Action Toggles the bold font (selection-wise) using boldsymbol in math.
219 \begin_layout Description
220 Syntax font-boldsymbol
223 \begin_layout Subsection*
227 \begin_layout Description
228 Action Reverts the settings of the font to the default values (selection-wise).
231 \begin_layout Description
235 \begin_layout Subsection*
239 \begin_layout Description
240 Action Toggles the emphasis font style (selection-wise).
243 \begin_layout Description
247 \begin_layout Subsection*
251 \begin_layout Description
252 Action Toggles Fraktur family font (math-mode, selection-wise).
255 \begin_layout Description
259 \begin_layout Description
260 Origin vermeer, 10 Jan 2002
263 \begin_layout Subsection*
267 \begin_layout Description
268 Action Toggles Italics font shape (math-mode, selection-wise).
271 \begin_layout Description
275 \begin_layout Description
276 Origin vermeer, 10 Jan 2002
279 \begin_layout Subsection*
283 \begin_layout Description
284 Action Toggles Noun text style font (selection-wise).
287 \begin_layout Description
291 \begin_layout Subsection*
295 \begin_layout Description
296 Action Toggles Roman family font (selection-wise).
299 \begin_layout Description
303 \begin_layout Subsection*
307 \begin_layout Description
308 Action Toggles Sans Serif family font (selection-wise).
311 \begin_layout Description
315 \begin_layout Subsection*
319 \begin_layout Description
320 Action Sets font size according to lyx format string.
323 \begin_layout Description
324 Syntax font-size <SIZE>
327 \begin_layout Description
328 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
329 \begin_inset Newline newline
332 largest|huge|giant|increase|decrease|default
335 \begin_layout Subsection*
339 \begin_layout Description
340 Action Returns the info about the current font.
343 \begin_layout Description
347 \begin_layout Subsection*
351 \begin_layout Description
352 Action Toggles strikeout (strike-through) in the font (selection-wise).
355 \begin_layout Description
356 Syntax font-strikeout
359 \begin_layout Description
360 Origin sanda, 3 May 2009
363 \begin_layout Subsection*
367 \begin_layout Description
368 Action Toggles the typewriter family font (selection-wise).
371 \begin_layout Description
372 Syntax font-typewriter
375 \begin_layout Subsection*
379 \begin_layout Description
380 Action Toggles underline in the font (selection-wise).
383 \begin_layout Description
384 Syntax font-underline
387 \begin_layout Subsection*
391 \begin_layout Description
392 Action Toggles double underline in the font (selection-wise).
395 \begin_layout Description
396 Syntax font-underunderline
399 \begin_layout Description
400 Origin sanda, 5 May 2009
403 \begin_layout Subsection*
407 \begin_layout Description
408 Action Toggles wavy underline in the font (selection-wise).
411 \begin_layout Description
412 Syntax font-underwave
415 \begin_layout Description
416 Origin sanda, 5 May 2009
419 \begin_layout Subsection*
423 \begin_layout Description
424 Action Sets the layout (that is, environment) for the current paragraph.
427 \begin_layout Description
428 Syntax layout <LAYOUT>
431 \begin_layout Description
432 Params <LAYOUT>: the layout to use
435 \begin_layout Subsection*
439 \begin_layout Description
440 Action Adds a module.
443 \begin_layout Description
444 Notion Adds a module to the list of included modules for the current buffer.
447 \begin_layout Description
448 Syntax layout-module-add <MODULE>
451 \begin_layout Description
452 Params <MODULE>: the module to be added
455 \begin_layout Description
456 Origin rgh, 25 August 2007
459 \begin_layout Subsection*
463 \begin_layout Description
464 Action Clears the module list.
467 \begin_layout Description
468 Notion Clears the list of included modules for the current buffer.
471 \begin_layout Description
472 Syntax layout-modules-clear
475 \begin_layout Description
476 Origin rgh, 25 August 2007
479 \begin_layout Subsection*
483 \begin_layout Description
484 Action Launches the paragraph settings dialog.
487 \begin_layout Description
488 Syntax layout-paragraph
491 \begin_layout Subsection*
495 \begin_layout Description
496 Action Reloads layout information.
499 \begin_layout Description
500 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.
503 \begin_layout Description
507 \begin_layout Description
508 Origin rgh, 3 September 2007
511 \begin_layout Subsection*
515 \begin_layout Description
516 Action Launches the tabular settings dialog.
519 \begin_layout Description
520 Syntax layout-tabular
523 \begin_layout Description
524 Origin Jug, 31 Jul 2000
527 \begin_layout Subsection*
531 \begin_layout Description
532 Action Update fonts and its metrics.
535 \begin_layout Description
536 Notion Automatically called after zoom, dpi, font names, or norm change.
539 \begin_layout Description
540 Syntax screen-font-update
543 \begin_layout Description
544 Origin ARRae, 13 Aug 2000
547 \begin_layout Subsection*
551 \begin_layout Description
552 Action Sets the text class for the current buffer.
555 \begin_layout Description
556 Syntax textclass-apply <TEXTCLASS>
559 \begin_layout Description
560 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
563 \begin_layout Subsection*
567 \begin_layout Description
568 Action Loads information for a textclass from disk.
571 \begin_layout Description
572 Syntax textclass-load <TEXTCLASS>
575 \begin_layout Description
576 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
579 \begin_layout Subsection*
583 \begin_layout Description
584 Action Toggle user-defined (=last-time used) text style.
587 \begin_layout Description
588 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
591 \begin_layout Description
592 Syntax textstyle-apply
595 \begin_layout Description
596 Origin leeming, 12 Mar 2003
599 \begin_layout Subsection*
603 \begin_layout Description
604 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
607 \begin_layout Description
608 Syntax textstyle-update <FONT_INFO>
611 \begin_layout Description
612 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
613 \begin_inset Newline newline
616 Use lyx -dbg action for exact syntax of text-style dialog parameters.
619 \begin_layout Description
620 Origin leeming, 12 Mar 2003
623 \begin_layout Section
624 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
627 \begin_layout Subsection*
631 \begin_layout Description
632 Action Adds an acute accent to the next character typed.
635 \begin_layout Description
639 \begin_layout Subsection*
643 \begin_layout Description
644 Action Adds a breve accent to the next character typed.
647 \begin_layout Description
651 \begin_layout Subsection*
655 \begin_layout Description
656 Action Adds a caron to the next character typed.
659 \begin_layout Description
663 \begin_layout Subsection*
667 \begin_layout Description
668 Action Adds a cedilla to the next character typed.
671 \begin_layout Description
672 Syntax accent-cedilla
675 \begin_layout Subsection*
679 \begin_layout Description
680 Action Adds a circle accent to the next character typed.
683 \begin_layout Description
687 \begin_layout Subsection*
691 \begin_layout Description
692 Action Adds a circumflex to the next character typed.
695 \begin_layout Description
696 Syntax accent-circumflex
699 \begin_layout Subsection*
703 \begin_layout Description
704 Action Adds a dot accent to the next character typed.
707 \begin_layout Description
711 \begin_layout Subsection*
715 \begin_layout Description
716 Action Adds a grave accent to the next character typed.
719 \begin_layout Description
723 \begin_layout Subsection*
724 accent-hungarian-umlaut
727 \begin_layout Description
728 Action Adds a Hungarian umlaut to the next character typed.
731 \begin_layout Description
735 \begin_layout Subsection*
739 \begin_layout Description
740 Action Adds a macron to the next character typed.
743 \begin_layout Description
747 \begin_layout Subsection*
751 \begin_layout Description
752 Action Adds an ogonek accent to the next character typed.
755 \begin_layout Description
759 \begin_layout Subsection*
763 \begin_layout Description
764 Action Adds a perispomeni (Greek circumflex) over the next character typed.
767 \begin_layout Description
768 Syntax accent-perispomeni
771 \begin_layout Subsection*
775 \begin_layout Description
776 Action Adds a tie over the next two character typed.
779 \begin_layout Description
780 Notion The following char will finish the tie.
783 \begin_layout Description
787 \begin_layout Subsection*
791 \begin_layout Description
792 Action Adds a tilde over the next character typed.
795 \begin_layout Description
799 \begin_layout Subsection*
803 \begin_layout Description
804 Action Adds an umlaut over the next character typed.
807 \begin_layout Description
811 \begin_layout Subsection*
815 \begin_layout Description
816 Action Adds a bar under the next character typed.
819 \begin_layout Description
820 Syntax accent-underbar
823 \begin_layout Subsection*
827 \begin_layout Description
828 Action Adds a dot under the next character typed.
831 \begin_layout Description
832 Syntax accent-underdot
835 \begin_layout Subsection*
839 \begin_layout Description
840 Action Accepts all tracked changes in the document.
843 \begin_layout Description
844 Syntax all-changes-accept
847 \begin_layout Description
848 Origin Levon, 16 Oct 2002
851 \begin_layout Subsection*
855 \begin_layout Description
856 Action Rejects all tracked changes in the document.
859 \begin_layout Description
860 Notion Reject does not work recursively; the user may have to repeat the operation.
863 \begin_layout Description
864 Syntax all-changes-reject
867 \begin_layout Description
868 Origin Levon, 16 Oct 2002
871 \begin_layout Subsection*
875 \begin_layout Description
876 Action Start (or remove) Appendix on the given cursor position.
879 \begin_layout Description
883 \begin_layout Description
884 Origin ettrich, 5 May 1998
887 \begin_layout Subsection*
891 \begin_layout Description
892 Action Inserts an argument (short title) inset.
895 \begin_layout Description
896 Syntax argument-insert <argument nr>
899 \begin_layout Description
900 Params <argument nr>: see layout declarations
903 \begin_layout Description
904 Origin vermeer, 12 Aug 2002
907 \begin_layout Subsection*
911 \begin_layout Description
912 Action Adds database, which will be used for bibtex citations.
915 \begin_layout Description
916 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
919 \begin_layout Description
920 Syntax bibtex-database-add <DATABASE-NAME>
923 \begin_layout Description
924 Origin Ale, 30 May 1997
927 \begin_layout Subsection*
931 \begin_layout Description
932 Action Adds database, which will be used for bibtex citations.
935 \begin_layout Description
936 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
939 \begin_layout Description
940 Syntax bibtex-database-del <DATABASE-NAME>
943 \begin_layout Description
944 Origin Ale, 30 May 1997
947 \begin_layout Subsection*
951 \begin_layout Description
952 Action Clears the list of saved bookmarks.
955 \begin_layout Description
956 Syntax bookmark-clear
959 \begin_layout Description
960 Origin bpeng, 31 October 2006
963 \begin_layout Subsection*
967 \begin_layout Description
968 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
971 \begin_layout Description
972 Notion Bookmark 0 has a special purpose. It is automatically set
973 \begin_inset Newline newline
976 1. to the paragraph you are currently editing
977 \begin_inset Newline newline
980 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
981 \begin_inset Newline newline
984 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
987 \begin_layout Description
988 Syntax bookmark-goto <NUMBER>
991 \begin_layout Description
992 Params <NUMBER>: the number of the bookmark to restore.
995 \begin_layout Description
996 Origin Dekel, 27 January 2001
999 \begin_layout Subsection*
1003 \begin_layout Description
1004 Action Save a bookmark.
1007 \begin_layout Description
1008 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.
1011 \begin_layout Description
1012 Syntax bookmark-save <NUMBER>
1015 \begin_layout Description
1016 Params <NUMBER>: the number of the bookmark to save.
1019 \begin_layout Description
1020 Origin Dekel, 27 January 2001
1023 \begin_layout Subsection*
1027 \begin_layout Description
1028 Action Inserts Box inset.
1031 \begin_layout Description
1032 Syntax box-insert [<TYPE>]
1035 \begin_layout Description
1036 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1037 \begin_inset Newline newline
1040 Framed is the default one.
1043 \begin_layout Description
1044 Origin vermeer, 7 Oct 2003
1047 \begin_layout Subsection*
1051 \begin_layout Description
1052 Action Inserts branch inset.
1055 \begin_layout Description
1056 Syntax branch-insert <BRANCH-NAME>
1059 \begin_layout Description
1060 Origin vermeer, 17 Aug 2003
1063 \begin_layout Subsection*
1067 \begin_layout Description
1068 Action Move the cursor to the beginning of the document.
1071 \begin_layout Description
1075 \begin_layout Subsection*
1079 \begin_layout Description
1080 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1083 \begin_layout Description
1084 Syntax buffer-begin-select
1087 \begin_layout Subsection*
1091 \begin_layout Description
1092 Action Move the cursor to the end of the document.
1095 \begin_layout Description
1099 \begin_layout Subsection*
1103 \begin_layout Description
1104 Action Move the cursor to the end of the document adding the traversed text to the selection.
1107 \begin_layout Description
1108 Syntax buffer-end-select
1111 \begin_layout Subsection*
1115 \begin_layout Description
1116 Action Inserts a caption inset.
1119 \begin_layout Description
1120 Syntax caption-insert
1123 \begin_layout Description
1124 Origin Lgb, 18 Jul 2000
1127 \begin_layout Subsection*
1131 \begin_layout Description
1132 Action Moves the cursor to the previous cell inside the table.
1135 \begin_layout Description
1136 Syntax cell-backward
1139 \begin_layout Description
1140 Origin Jug, 22 May 2000
1143 \begin_layout Subsection*
1147 \begin_layout Description
1148 Action Moves the cursor to the next cell inside the table.
1151 \begin_layout Description
1155 \begin_layout Subsection*
1159 \begin_layout Description
1160 Action Splits cell and shifts right part to the next cell (inside the math grid).
1163 \begin_layout Description
1167 \begin_layout Description
1168 Origin Ale, 15 May 1997
1171 \begin_layout Subsection*
1175 \begin_layout Description
1176 Action Accepts tracked change inside the selection.
1179 \begin_layout Description
1180 Syntax change-accept
1183 \begin_layout Description
1184 Origin Levon, 16 Oct 2002
1187 \begin_layout Subsection*
1191 \begin_layout Description
1192 Action Moves the cursor to the position of the next change of the change tracking records.
1195 \begin_layout Description
1199 \begin_layout Description
1200 Origin schmitt, 4 Oct 2006
1203 \begin_layout Subsection*
1207 \begin_layout Description
1208 Action Moves the cursor to the position of the previous change of the change tracking records.
1211 \begin_layout Description
1212 Syntax change-previous
1215 \begin_layout Description
1216 Origin vfr, 4 Apr 2009
1219 \begin_layout Subsection*
1223 \begin_layout Description
1224 Action Rejects tracked change inside the selection.
1227 \begin_layout Description
1228 Syntax change-reject
1231 \begin_layout Description
1232 Origin Levon, 16 Oct 2002
1235 \begin_layout Subsection*
1239 \begin_layout Description
1240 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1243 \begin_layout Description
1244 Syntax changes-merge
1247 \begin_layout Description
1248 Origin Levon, 16 Oct 2002
1251 \begin_layout Subsection*
1255 \begin_layout Description
1256 Action Toggles showing of change tracking in typeset output.
1259 \begin_layout Description
1260 Syntax changes-output
1263 \begin_layout Description
1264 Origin jspitzm, 21 Jan 2005
1267 \begin_layout Subsection*
1271 \begin_layout Description
1272 Action Toggles change tracking to on/off.
1275 \begin_layout Description
1276 Syntax changes-track
1279 \begin_layout Description
1280 Origin levon, 1 Oct 2002
1283 \begin_layout Subsection*
1287 \begin_layout Description
1288 Action Moves the cursor one position logically backwards.
1291 \begin_layout Description
1292 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.
1295 \begin_layout Description
1296 Syntax char-backward
1299 \begin_layout Subsection*
1300 char-backward-select
1303 \begin_layout Description
1304 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1307 \begin_layout Description
1308 Notion See also LFUN_CHAR_BACKWARD.
1311 \begin_layout Description
1312 Syntax char-backward-select
1315 \begin_layout Subsection*
1316 char-delete-backward
1319 \begin_layout Description
1320 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1323 \begin_layout Description
1324 Syntax char-delete-backward
1327 \begin_layout Subsection*
1331 \begin_layout Description
1332 Action Deletes one character in the backward direction (usually the "Delete" key).
1335 \begin_layout Description
1336 Syntax char-delete-forward
1339 \begin_layout Subsection*
1343 \begin_layout Description
1344 Action Moves the cursor one position logically forward.
1347 \begin_layout Description
1348 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.
1351 \begin_layout Description
1355 \begin_layout Subsection*
1359 \begin_layout Description
1360 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1363 \begin_layout Description
1364 Notion See also LFUN_CHAR_FORWARD.
1367 \begin_layout Description
1368 Syntax char-forward-select
1371 \begin_layout Subsection*
1375 \begin_layout Description
1376 Action Moves the cursor one position "to the left".
1379 \begin_layout Description
1380 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.
1383 \begin_layout Description
1387 \begin_layout Subsection*
1391 \begin_layout Description
1392 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1395 \begin_layout Description
1396 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1399 \begin_layout Description
1400 Syntax char-left-select
1403 \begin_layout Subsection*
1407 \begin_layout Description
1408 Action Moves the cursor one position "to the right".
1411 \begin_layout Description
1412 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.
1415 \begin_layout Description
1419 \begin_layout Subsection*
1423 \begin_layout Description
1424 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1427 \begin_layout Description
1428 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1431 \begin_layout Description
1432 Syntax char-right-select
1435 \begin_layout Subsection*
1439 \begin_layout Description
1440 Action Transposes the character at the cursor with the one before it.
1443 \begin_layout Description
1444 Syntax chars-transpose
1447 \begin_layout Description
1448 Origin Lgb, 25 Apr 2001
1451 \begin_layout Subsection*
1455 \begin_layout Description
1456 Action Inserts citation from loaded citation database.
1459 \begin_layout Description
1460 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1463 \begin_layout Description
1464 Params <KEY>: Citation (shortcut listed in available citations).
1465 \begin_inset Newline newline
1468 <TEXT_BEFORE>: text which should appear before citation.
1471 \begin_layout Description
1472 Origin AAS, 97-02-23
1475 \begin_layout Subsection*
1479 \begin_layout Description
1480 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.
1483 \begin_layout Description
1484 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.
1487 \begin_layout Description
1488 Syntax clipboard-paste [<ARG>]
1491 \begin_layout Description
1492 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1495 \begin_layout Description
1496 Origin Georg, 10 Jul 2006
1499 \begin_layout Subsection*
1500 clipboard-paste-simple
1503 \begin_layout Description
1504 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.
1507 \begin_layout Description
1508 Syntax clipboard-paste-simple [<ARG>]
1511 \begin_layout Description
1512 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1515 \begin_layout Subsection*
1519 \begin_layout Description
1520 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1523 \begin_layout Description
1524 Notion Usually bound to M-x shortcut.
1527 \begin_layout Description
1528 Syntax command-execute
1531 \begin_layout Subsection*
1535 \begin_layout Description
1536 Action Try to complete the word or command at the cursor position.
1539 \begin_layout Description
1543 \begin_layout Description
1544 Origin sts, Feb 19 2008
1547 \begin_layout Subsection*
1551 \begin_layout Description
1552 Action Accept suggested completion.
1555 \begin_layout Description
1556 Syntax completion-accept
1559 \begin_layout Description
1560 Origin sanda, Sep 08 2008
1563 \begin_layout Subsection*
1567 \begin_layout Description
1568 Action Try to cancel completion, either the popup or the inline completion.
1571 \begin_layout Description
1572 Syntax completion-cancel
1575 \begin_layout Description
1576 Origin sts, Sep 07 2008
1579 \begin_layout Subsection*
1583 \begin_layout Description
1584 Action Show the inline completion at the cursor position.
1587 \begin_layout Description
1588 Syntax completion-inline
1591 \begin_layout Description
1592 Origin sts, Feb 19 2008
1595 \begin_layout Subsection*
1599 \begin_layout Description
1600 Action Show the completion popup at the cursor position.
1603 \begin_layout Description
1604 Syntax completion-popup
1607 \begin_layout Description
1608 Origin sts, Feb 19 2008
1611 \begin_layout Subsection*
1615 \begin_layout Description
1616 Action Copies the current selection to the clipboard.
1619 \begin_layout Description
1623 \begin_layout Subsection*
1627 \begin_layout Description
1628 Action Cuts to the clipboard.
1631 \begin_layout Description
1635 \begin_layout Subsection*
1639 \begin_layout Description
1640 Action Inserts the current date.
1643 \begin_layout Description
1644 Syntax date-insert [<ARG>]
1647 \begin_layout Description
1648 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.
1651 \begin_layout Description
1652 Origin jdblair, 31 Jan 2000
1655 \begin_layout Subsection*
1659 \begin_layout Description
1660 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1663 \begin_layout Description
1664 Syntax depth-decrement
1667 \begin_layout Subsection*
1671 \begin_layout Description
1672 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1675 \begin_layout Description
1676 Syntax depth-increment
1679 \begin_layout Subsection*
1680 dialog-disconnect-inset
1683 \begin_layout Description
1684 Action Closes opened connection to opened inset.
1687 \begin_layout Description
1688 Notion Connection is used for apply functions.
1691 \begin_layout Description
1692 Syntax dialog-disconnect-inset <INSET-NAME>
1695 \begin_layout Description
1696 Origin leeming, 25 Feb 2003
1699 \begin_layout Subsection*
1703 \begin_layout Description
1704 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1707 \begin_layout Description
1708 Syntax dialog-hide <NAME>
1711 \begin_layout Description
1712 Params See LFUN_DIALOG_SHOW .
1715 \begin_layout Description
1716 Origin leeming, 25 Feb 2003
1719 \begin_layout Subsection*
1723 \begin_layout Description
1724 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1727 \begin_layout Description
1728 Syntax dialog-show <NAME> [<DATA>]
1731 \begin_layout Description
1732 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1733 \begin_inset Newline newline
1736 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1737 \begin_inset Newline newline
1740 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1741 \begin_inset Newline newline
1744 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1745 \begin_inset Newline newline
1748 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1749 \begin_inset Newline newline
1752 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1753 \begin_inset Newline newline
1756 <SPECIAL>: latexlog|vclog
1757 \begin_inset Newline newline
1760 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1763 \begin_layout Description
1764 Origin leeming, 17 Jun 2003
1767 \begin_layout Subsection*
1768 dialog-show-new-inset
1771 \begin_layout Description
1772 Action Shows hidden dialog or create new one for a given inset settings etc.
1775 \begin_layout Description
1776 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1779 \begin_layout Description
1780 Syntax dialog-show-new-inset <NAME> [<DATA>]
1783 \begin_layout Description
1784 Params See LFUN_DIALOG_SHOW .
1787 \begin_layout Description
1788 Origin leeming, 25 Feb 2003
1791 \begin_layout Subsection*
1795 \begin_layout Description
1796 Action Toggles dialog between showed/hidden state.
1799 \begin_layout Description
1800 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1803 \begin_layout Description
1804 Syntax dialog-toggle <NAME> [<DATA>]
1807 \begin_layout Description
1808 Params See LFUN_DIALOG_SHOW .
1811 \begin_layout Description
1812 Origin JSpitzm, 30 Apr 2007
1815 \begin_layout Subsection*
1819 \begin_layout Description
1820 Action Updates the dialog values from the inset/paragraph/document.
1823 \begin_layout Description
1824 Syntax dialog-update <NAME>
1827 \begin_layout Description
1828 Params <NAME>: paragraph|prefs|<INSET>
1829 \begin_inset Newline newline
1835 \begin_layout Description
1836 Origin leeming, 25 Feb 2003
1839 \begin_layout Subsection*
1843 \begin_layout Description
1844 Action Moves the cursor one line in downward direction.
1847 \begin_layout Description
1851 \begin_layout Subsection*
1855 \begin_layout Description
1856 Action Moves the cursor one line in downward direction adding the current position to the selection.
1859 \begin_layout Description
1863 \begin_layout Subsection*
1867 \begin_layout Description
1868 Action Inserts an ERT inset.
1871 \begin_layout Description
1875 \begin_layout Description
1876 Origin Jug, 18 Feb 2000
1879 \begin_layout Subsection*
1883 \begin_layout Description
1884 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1887 \begin_layout Description
1891 \begin_layout Description
1892 Origin Lgb, 17 May 2001
1895 \begin_layout Subsection*
1899 \begin_layout Description
1900 Action Inserts another LyX file.
1903 \begin_layout Description
1904 Syntax file-insert [<FILE>]
1907 \begin_layout Description
1908 Params <FILE>: Filename to be inserted.
1911 \begin_layout Subsection*
1912 file-insert-plaintext
1915 \begin_layout Description
1916 Action Inserts plain text file.
1919 \begin_layout Description
1920 Syntax file-insert-plaintext [<FILE>]
1923 \begin_layout Description
1924 Params <FILE>: Filename to be inserted.
1927 \begin_layout Description
1928 Origin CFO-G, 19 Nov 1997
1931 \begin_layout Subsection*
1932 file-insert-plaintext-para
1935 \begin_layout Description
1936 Action Inserts plain text file as paragraph (i.e. join lines).
1939 \begin_layout Description
1940 Syntax file-insert-plaintext-para [<FILE>]
1943 \begin_layout Description
1944 Params <FILE>: Filename to be inserted.
1947 \begin_layout Description
1948 Origin Levon, 14 Feb 2001
1951 \begin_layout Subsection*
1955 \begin_layout Description
1956 Action Inserts CharStyle, Custom inset or XML short element.
1959 \begin_layout Description
1960 Notion Look into the Customization manual for more information about these elements.
1961 \begin_inset Newline newline
1964 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.
1965 \begin_inset Newline newline
1968 For dissolving the element see LFUN_INSET_DISSOLVE.
1971 \begin_layout Description
1972 Syntax flex-insert Name
1975 \begin_layout Description
1976 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.
1979 \begin_layout Description
1980 Sample flex-insert Code
1983 \begin_layout Subsection*
1987 \begin_layout Description
1988 Action Inserts a float inset.
1991 \begin_layout Description
1992 Syntax float-insert <TYPE>
1995 \begin_layout Description
1996 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1999 \begin_layout Description
2000 Origin Lgb, 27 Jun 2000
2003 \begin_layout Subsection*
2007 \begin_layout Description
2008 Action Inserts the list of floats in the document.
2011 \begin_layout Description
2012 Syntax float-list-insert <TYPE>
2015 \begin_layout Description
2016 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2019 \begin_layout Description
2020 Origin Lgb, 3 May 2001
2023 \begin_layout Subsection*
2027 \begin_layout Description
2028 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2031 \begin_layout Description
2032 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2035 \begin_layout Description
2036 Syntax float-wide-insert <TYPE>
2039 \begin_layout Description
2040 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2043 \begin_layout Description
2044 Origin Lgb, 31 Oct 2001
2047 \begin_layout Subsection*
2051 \begin_layout Description
2052 Action Inserts a footnote inset.
2055 \begin_layout Description
2056 Syntax footnote-insert
2059 \begin_layout Description
2060 Origin Jug, 7 Mar 2000
2063 \begin_layout Subsection*
2067 \begin_layout Description
2068 Action Reloads the image if necessary.
2071 \begin_layout Description
2072 Syntax graphics-reload
2075 \begin_layout Description
2076 Origin vfr, 10 Aug 2009
2079 \begin_layout Subsection*
2083 \begin_layout Description
2084 Action Inserts hyperlinks into the document (clickable in pdf output).
2087 \begin_layout Description
2088 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2091 \begin_layout Description
2092 Syntax href-insert [<TARGET>]
2095 \begin_layout Description
2096 Origin CFO-G, 21 Nov 1997
2099 \begin_layout Subsection*
2103 \begin_layout Description
2104 Action Only active in IPA inset.
2107 \begin_layout Description
2108 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.
2111 \begin_layout Description
2115 \begin_layout Description
2116 Origin spitz, 20 May 2012
2119 \begin_layout Subsection*
2123 \begin_layout Description
2124 Action Inserts Index entry.
2127 \begin_layout Description
2128 Notion It automatically takes the word on the cursor position.
2131 \begin_layout Description
2132 Syntax index-insert [<TYPE:Name>]
2135 \begin_layout Description
2136 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2139 \begin_layout Description
2140 Origin leeming, 3 Aug 2000
2143 \begin_layout Subsection*
2147 \begin_layout Description
2148 Action Inserts list of Index entries on a new page.
2151 \begin_layout Description
2152 Syntax index-print [<TYPE:Name>]
2155 \begin_layout Description
2156 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2159 \begin_layout Description
2160 Origin Lgb, 27 Feb 1997
2163 \begin_layout Subsection*
2167 \begin_layout Description
2168 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2171 \begin_layout Description
2172 Notion Apart from lfun arguments you can use the following method:
2173 \begin_inset Newline newline
2176 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2177 \begin_inset Newline newline
2180 2. select the text and run info-insert lfun.
2183 \begin_layout Description
2184 Syntax info-insert <TYPE> <ARG>
2187 \begin_layout Description
2188 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
2189 \begin_inset Newline newline
2192 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2193 \begin_inset Newline newline
2196 shortcut[s]: name of lfun (e.g math-insert
2199 \begin_inset Newline newline
2202 lyxrc: name of rc_entry (e.g. bind_file)
2203 \begin_inset Newline newline
2206 lyxinfo: "version" - used version of LyX
2207 \begin_inset Newline newline
2210 package: name of latex package (e.g. listings)
2211 \begin_inset Newline newline
2214 textclass: name of textclass (e.g. article)
2215 \begin_inset Newline newline
2218 menu: name of lfun used in menu
2219 \begin_inset Newline newline
2222 icon: icon of lfun used in toolbar or direct icon name
2223 \begin_inset Newline newline
2226 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
2229 \begin_layout Description
2230 Sample command-sequence info-insert buffer path; info-insert buffer name
2233 \begin_layout Description
2234 Origin bpeng, 7 Oct 2007
2237 \begin_layout Subsection*
2241 \begin_layout Description
2242 Action Apply data for an inset.
2245 \begin_layout Description
2246 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.
2249 \begin_layout Description
2250 Syntax inset-apply <ARGS>
2253 \begin_layout Description
2254 Params See LFUN_INSET_INSERT .
2257 \begin_layout Subsection*
2261 \begin_layout Description
2262 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
2265 \begin_layout Description
2269 \begin_layout Description
2270 Origin lasgouttes, 16 Mar 2009
2273 \begin_layout Subsection*
2277 \begin_layout Description
2278 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).
2281 \begin_layout Description
2282 Syntax inset-begin-select
2285 \begin_layout Description
2286 Origin lasgouttes, 16 Mar 2009
2289 \begin_layout Subsection*
2293 \begin_layout Description
2294 Action Copies the inset to the clipboard as a certain type.
2297 \begin_layout Description
2298 Notion Currently used only for InsetInfo where its content is copied as a text.
2301 \begin_layout Description
2302 Syntax inset-copy-as
2305 \begin_layout Description
2306 Origin vfr, 18 Apr 2010
2309 \begin_layout Subsection*
2313 \begin_layout Description
2314 Action Dissolve the current inset into text.
2317 \begin_layout Description
2318 Syntax inset-dissolve [<INSET>]
2321 \begin_layout Description
2322 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.
2323 \begin_inset Newline newline
2326 For values see lyx::InsetLayout::lyxtype_ .
2329 \begin_layout Description
2330 Origin JSpitz, 7 Aug 2006
2333 \begin_layout Subsection*
2337 \begin_layout Description
2338 Action Edit the inset at cursor with an external application, if one is attributed.
2341 \begin_layout Description
2342 Syntax inset-edit [<INSET_PARAMS>]
2345 \begin_layout Description
2346 Params <INSET_PARAMS>: Parameters for the inset.
2347 \begin_inset Newline newline
2350 Currently only the filename will be considered.
2353 \begin_layout Description
2354 Origin JSpitzm, 27 Apr 2006
2357 \begin_layout Subsection*
2361 \begin_layout Description
2362 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
2365 \begin_layout Description
2369 \begin_layout Description
2370 Origin lasgouttes, 16 Mar 2009
2373 \begin_layout Subsection*
2377 \begin_layout Description
2378 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).
2381 \begin_layout Description
2382 Syntax inset-end-select
2385 \begin_layout Description
2386 Origin lasgouttes, 16 Mar 2009
2389 \begin_layout Subsection*
2393 \begin_layout Description
2394 Action Apply the given commands on insets of a given name.
2397 \begin_layout Description
2398 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.
2401 \begin_layout Description
2402 Syntax inset-forall <NAME> <LFUN-COMMAND>
2403 \begin_inset Newline newline
2406 <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.
2409 \begin_layout Description
2410 Sample Remove all index insets:
2411 \begin_inset Newline newline
2414 inset-forall Index char-delete-forward
2415 \begin_inset Newline newline
2418 Close all Notes (also works for a particular branch, for example):
2419 \begin_inset Newline newline
2422 inset-forall Note inset-toggle close
2423 \begin_inset Newline newline
2426 Transform all yellow notes to comments
2427 \begin_inset Newline newline
2430 inset-forall Note:Note inset-modify note Note Comment
2431 \begin_inset Newline newline
2434 Try to put LyX in an infinite loop if there is at least a Note:
2435 \begin_inset Newline newline
2438 inset-forall Note char-backward
2441 \begin_layout Description
2442 Origin lasgouttes, 27 Nov 2009
2445 \begin_layout Subsection*
2449 \begin_layout Description
2450 Action Insert new inset (type given by the parameters).
2453 \begin_layout Description
2454 Syntax inset-insert <INSET> <ARGS>
2457 \begin_layout Description
2458 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2459 \begin_inset Newline newline
2462 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2463 \begin_inset Newline newline
2466 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2469 \begin_layout Description
2470 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2473 \begin_inset Newline newline
2476 where <label name> is the name of the referenced label and <Format> is one of the following:
2477 \begin_inset Newline newline
2481 \begin_inset Newline newline
2484 eqref -- (<reference>)
2485 \begin_inset Newline newline
2489 \begin_inset Newline newline
2492 vpageref -- on <page>
2493 \begin_inset Newline newline
2496 vref -- <reference> on <page>
2497 \begin_inset Newline newline
2500 formatted -- Formatted reference
2503 \begin_layout Subsection*
2507 \begin_layout Description
2508 Action Modify some properties of an inset.
2511 \begin_layout Description
2512 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.
2515 \begin_layout Description
2516 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>
2519 \begin_layout Description
2520 Sample inset-modify note Note Comment
2521 \begin_inset Newline newline
2524 inset-modify changetype Ovalbox
2527 \begin_layout Subsection*
2531 \begin_layout Description
2532 Action Select all contents of an inset.
2535 \begin_layout Description
2536 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2539 \begin_layout Description
2540 Syntax inset-select-all
2543 \begin_layout Description
2544 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2547 \begin_layout Subsection*
2551 \begin_layout Description
2552 Action Open the inset's properties dialog.
2555 \begin_layout Description
2556 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.
2559 \begin_layout Description
2560 Syntax inset-settings <INSET>
2563 \begin_layout Description
2564 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2565 \begin_inset Newline newline
2568 graphics|href|include|index|index_print|label|line|
2569 \begin_inset Newline newline
2572 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2575 \begin_layout Subsection*
2579 \begin_layout Description
2580 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2583 \begin_layout Description
2584 Syntax inset-toggle [<ARG>]
2587 \begin_layout Description
2588 Params <ARG>: <open|close|toggle|assign>.
2589 \begin_inset Newline newline
2592 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2593 \begin_inset Newline newline
2596 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2599 \begin_layout Description
2600 Origin lasgouttes, 19 Jul 2001
2603 \begin_layout Subsection*
2607 \begin_layout Description
2608 Action Inserts an IPA inset.
2611 \begin_layout Description
2615 \begin_layout Description
2616 Origin spitz, 05 Mar 2012
2619 \begin_layout Subsection*
2623 \begin_layout Description
2624 Action Inserts special IPA macros into the document.
2627 \begin_layout Description
2628 Syntax ipamacro-insert <CHAR>
2631 \begin_layout Description
2632 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2635 \begin_layout Description
2636 Origin JSpitzm, 22 Aug 2012
2639 \begin_layout Subsection*
2643 \begin_layout Description
2644 Action Turn off the loaded keyboard map.
2647 \begin_layout Description
2651 \begin_layout Subsection*
2655 \begin_layout Description
2656 Action Turn on the primary keyboard map.
2659 \begin_layout Description
2660 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.
2661 \begin_inset Newline newline
2664 The language is to be set in the Preferences dialog.
2667 \begin_layout Description
2668 Syntax keymap-primary
2671 \begin_layout Subsection*
2675 \begin_layout Description
2676 Action Turn on the secondary keyboard map.
2679 \begin_layout Description
2680 Syntax keymap-secondary
2683 \begin_layout Subsection*
2687 \begin_layout Description
2688 Action Toggles keyboard maps (first/second/off).
2691 \begin_layout Description
2692 Syntax keymap-toggle
2695 \begin_layout Description
2696 Origin leeming, 30 Mar 2004
2699 \begin_layout Subsection*
2700 label-copy-as-reference
2703 \begin_layout Description
2704 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2707 \begin_layout Description
2708 Syntax copy-label-as-reference <LABEL>
2711 \begin_layout Description
2712 Params <LABEL>: The label to copy (for multi-line math)
2715 \begin_layout Description
2716 Origin sts, 16 Nov 2008
2719 \begin_layout Subsection*
2723 \begin_layout Description
2724 Action Goto a label.
2727 \begin_layout Description
2728 Syntax label-goto [<LABEL>]
2731 \begin_layout Description
2732 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.
2735 \begin_layout Description
2736 Origin Ale, 6 Aug 1997
2739 \begin_layout Subsection*
2743 \begin_layout Description
2744 Action Inserts label to text or displayed formula.
2747 \begin_layout Description
2748 Syntax label-insert [<LABEL>]
2751 \begin_layout Description
2752 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2755 \begin_layout Subsection*
2756 label-insert-as-reference
2759 \begin_layout Description
2760 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2763 \begin_layout Description
2764 Syntax label-insert-as-reference
2767 \begin_layout Description
2768 Origin vfr, 7 Apr 2009
2771 \begin_layout Subsection*
2775 \begin_layout Description
2776 Action Set language from the current cursor position.
2779 \begin_layout Description
2780 Syntax language <LANG> [set]
2783 \begin_layout Description
2784 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).
2787 \begin_layout Description
2788 Origin Dekel, 2 Mar 2000
2791 \begin_layout Subsection*
2795 \begin_layout Description
2796 Action Move the cursor to the beginning of the (screen) line.
2799 \begin_layout Description
2803 \begin_layout Subsection*
2807 \begin_layout Description
2808 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2811 \begin_layout Description
2812 Syntax line-begin-select
2815 \begin_layout Subsection*
2819 \begin_layout Description
2820 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2823 \begin_layout Description
2824 Syntax line-delete-forward
2827 \begin_layout Subsection*
2831 \begin_layout Description
2832 Action Move the cursor to the end of the (screen) line.
2835 \begin_layout Description
2839 \begin_layout Subsection*
2843 \begin_layout Description
2844 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2847 \begin_layout Description
2848 Syntax line-end-select
2851 \begin_layout Subsection*
2855 \begin_layout Description
2856 Action Inserts a new listings inset.
2859 \begin_layout Description
2860 Syntax listing-insert
2863 \begin_layout Description
2864 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2867 \begin_layout Subsection*
2871 \begin_layout Description
2872 Action Inserts a marginal note.
2875 \begin_layout Description
2876 Syntax marginalnote-insert
2879 \begin_layout Description
2880 Origin Lgb, 26 Jun 2000
2883 \begin_layout Subsection*
2887 \begin_layout Description
2888 Action Disable selecting of text-region.
2891 \begin_layout Description
2895 \begin_layout Subsection*
2899 \begin_layout Description
2900 Action Enable selecting of text-region.
2903 \begin_layout Description
2904 Notion After enabling you can simply move arrow keys to get selected region.
2907 \begin_layout Description
2911 \begin_layout Subsection*
2915 \begin_layout Description
2916 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2919 \begin_layout Description
2923 \begin_layout Description
2924 Origin Andre, May 5 2006
2927 \begin_layout Subsection*
2931 \begin_layout Description
2932 Action Inserts a line break or new line.
2935 \begin_layout Description
2936 Syntax newline-insert [<ARG>]
2939 \begin_layout Description
2940 Params <ARG>: <newline|linebreak> default: newline
2943 \begin_layout Description
2944 Origin JSpitzm, 25 Mar 2008
2947 \begin_layout Subsection*
2951 \begin_layout Description
2952 Action Inserts a new page.
2955 \begin_layout Description
2956 Syntax newpage-insert <ARG>
2959 \begin_layout Description
2960 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2963 \begin_layout Description
2964 Origin uwestoehr, 24 Nov 2007
2967 \begin_layout Subsection*
2971 \begin_layout Description
2972 Action Inserts Nomenclature entry.
2975 \begin_layout Description
2976 Notion It automatically takes the word on the cursor position if no symbol is given.
2979 \begin_layout Description
2980 Syntax nomencl-insert [<SYMBOL>]
2983 \begin_layout Description
2984 Origin Ugras, 4 Nov 2006
2987 \begin_layout Subsection*
2991 \begin_layout Description
2992 Action Inserts list of Nomenclature entries.
2995 \begin_layout Description
2996 Syntax nomenclature-print
2999 \begin_layout Description
3000 Origin Ugras, 4 Nov 2006
3003 \begin_layout Subsection*
3007 \begin_layout Description
3008 Action Inserts Note on the current cursor position, move selection inside the inset.
3011 \begin_layout Description
3012 Syntax note-insert [<TYPE>]
3015 \begin_layout Description
3016 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3019 \begin_layout Subsection*
3023 \begin_layout Description
3024 Action Moves the cursor to the beginning of next Note inset.
3027 \begin_layout Description
3031 \begin_layout Subsection*
3035 \begin_layout Description
3036 Action Move the current group in the downward direction in the structure of the document.
3039 \begin_layout Description
3040 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3043 \begin_layout Description
3047 \begin_layout Description
3048 Origin Vermeer, 23 Mar 2006
3051 \begin_layout Subsection*
3055 \begin_layout Description
3056 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3059 \begin_layout Description
3060 Notion Part -> Chapter -> Section -> etc.
3063 \begin_layout Description
3067 \begin_layout Description
3068 Origin Vermeer, 23 Mar 2006
3071 \begin_layout Subsection*
3075 \begin_layout Description
3076 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3079 \begin_layout Description
3080 Notion Part <- Chapter <- Section <- etc.
3083 \begin_layout Description
3087 \begin_layout Description
3088 Origin Vermeer, 23 Mar 2006
3091 \begin_layout Subsection*
3095 \begin_layout Description
3096 Action Move the current group in the upward direction in the structure of the document.
3099 \begin_layout Description
3100 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3103 \begin_layout Description
3107 \begin_layout Description
3108 Origin Vermeer, 23 Mar 2006
3111 \begin_layout Subsection*
3115 \begin_layout Description
3116 Action Breaks the current paragraph at the current location.
3119 \begin_layout Description
3120 Notion Removes the selection.
3123 \begin_layout Description
3124 Syntax paragraph-break [<LAYOUT>]
3127 \begin_layout Description
3128 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3131 \begin_layout Subsection*
3135 \begin_layout Description
3136 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3139 \begin_layout Description
3140 Syntax paragraph-down
3143 \begin_layout Description
3144 Origin Asger, 1 Oct 1996
3147 \begin_layout Subsection*
3148 paragraph-down-select
3151 \begin_layout Description
3152 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3155 \begin_layout Description
3156 Syntax paragraph-down-select
3159 \begin_layout Description
3160 Origin Asger, 1 Oct 1996
3163 \begin_layout Subsection*
3167 \begin_layout Description
3168 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
3171 \begin_layout Description
3172 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).
3175 \begin_layout Description
3176 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3179 \begin_layout Description
3180 Params <PAR_ID_NUMBER>: paragraph id
3181 \begin_inset Newline newline
3184 <POSITION_IN_PAR>: desired position within the paragraph
3187 \begin_layout Description
3188 Origin Dekel, 26 Aug 2000
3191 \begin_layout Subsection*
3195 \begin_layout Description
3196 Action Moves the current paragraph downwards in the document.
3199 \begin_layout Description
3200 Syntax paragraph-move-down
3203 \begin_layout Description
3204 Origin Edwin, 8 Apr 2006
3207 \begin_layout Subsection*
3211 \begin_layout Description
3212 Action Moves the current paragraph upwards in the document.
3215 \begin_layout Description
3216 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3219 \begin_layout Description
3220 Syntax paragraph-move-up
3223 \begin_layout Description
3224 Origin Edwin, 8 Apr 2006
3227 \begin_layout Subsection*
3231 \begin_layout Description
3232 Action Change paragraph settings.
3235 \begin_layout Description
3236 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.
3239 \begin_layout Description
3240 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3243 \begin_layout Description
3253 \begin_inset Newline newline
3258 paragraph_spacing default|single|onehalf|double|other SIZE
3259 \begin_inset Newline newline
3264 align block|left|right|center|default
3265 \begin_inset Newline newline
3270 labelwidthstring WIDTH|
3275 \begin_layout Description
3276 Origin rgh, Aug 15 2007
3279 \begin_layout Subsection*
3280 paragraph-params-apply
3283 \begin_layout Description
3284 Action Change paragraph settings.
3287 \begin_layout Description
3288 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3291 \begin_layout Description
3292 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3295 \begin_layout Description
3296 Params For parameters see LFUN_PARAGRAPH_PARAMS
3299 \begin_layout Description
3300 Origin leeming, 30 Mar 2004
3303 \begin_layout Subsection*
3307 \begin_layout Description
3308 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3311 \begin_layout Description
3315 \begin_layout Description
3316 Origin Asger, 1 Oct 1996
3319 \begin_layout Subsection*
3323 \begin_layout Description
3324 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3327 \begin_layout Description
3328 Syntax paragraph-up-select
3331 \begin_layout Description
3332 Origin Asger, 1 Oct 1996
3335 \begin_layout Subsection*
3339 \begin_layout Description
3340 Action Pastes material (text or picture) from the active clipboard.
3343 \begin_layout Description
3344 Syntax paste [<TYPE>|<NUM>]
3347 \begin_layout Description
3348 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3349 \begin_inset Newline newline
3352 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3355 \begin_layout Subsection*
3359 \begin_layout Description
3360 Action Inserts phantom on the current cursor position, move selection inside the inset.
3363 \begin_layout Description
3364 Syntax phantom-insert [<TYPE>]
3367 \begin_layout Description
3368 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3371 \begin_layout Description
3372 Origin uwestoehr, 30 Jan 2009
3375 \begin_layout Subsection*
3379 \begin_layout Description
3380 Action Inserts a new preview inset.
3383 \begin_layout Description
3384 Syntax preview-insert
3387 \begin_layout Description
3388 Origin vfr, 28 Mar 2010
3391 \begin_layout Subsection*
3392 primary-selection-paste
3395 \begin_layout Description
3396 Action Pastes the currently selected text.
3399 \begin_layout Description
3400 Notion Primary selection mechanism is linux-only thing.
3403 \begin_layout Description
3404 Syntax primary-selection-paste [<ARG>]
3407 \begin_layout Description
3408 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3411 \begin_layout Subsection*
3415 \begin_layout Description
3416 Action Inserts quotes according to the type and quote-language preference.
3419 \begin_layout Description
3420 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
3423 \begin_layout Description
3424 Syntax quote-insert [<TYPE>]
3427 \begin_layout Description
3428 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
3431 \begin_layout Subsection*
3435 \begin_layout Description
3436 Action Redoes the last thing undone.
3439 \begin_layout Description
3443 \begin_layout Subsection*
3447 \begin_layout Description
3448 Action Go to the next label or cross-reference.
3451 \begin_layout Description
3452 Syntax reference-next
3455 \begin_layout Description
3456 Origin Dekel, 14 Jan 2001
3459 \begin_layout Subsection*
3463 \begin_layout Description
3464 Action Repeat the given command.
3467 \begin_layout Description
3468 Syntax repeat <COUNT> <LFUN-COMMAND>
3471 \begin_layout Description
3472 Origin Andre, 27 Oct 2003
3475 \begin_layout Subsection*
3479 \begin_layout Description
3480 Action Moves the cursor one page in downward direction.
3483 \begin_layout Description
3487 \begin_layout Subsection*
3491 \begin_layout Description
3492 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3495 \begin_layout Description
3496 Syntax screen-down-select
3499 \begin_layout Subsection*
3503 \begin_layout Description
3504 Action Recenters the screen on the current cursor position.
3507 \begin_layout Description
3508 Syntax screen-recenter
3511 \begin_layout Subsection*
3515 \begin_layout Description
3516 Action Repositions the screen such that the cursor is visible.
3519 \begin_layout Description
3520 Syntax screen-show-cursor
3523 \begin_layout Description
3524 Origin vfr, 25 Mar 2009
3527 \begin_layout Subsection*
3531 \begin_layout Description
3532 Action Moves the cursor one page in upward direction.
3535 \begin_layout Description
3539 \begin_layout Subsection*
3543 \begin_layout Description
3544 Action Moves the cursor one page in upward direction adding the current position to the selection.
3547 \begin_layout Description
3548 Syntax screen-up-select
3551 \begin_layout Subsection*
3555 \begin_layout Description
3556 Action Inserts a subscript or superscript inset.
3559 \begin_layout Description
3560 Syntax script-insert <TYPE>
3563 \begin_layout Description
3564 Params <TYPE>: subscript|superscript
3567 \begin_layout Description
3568 Origin Georg, 23 Nov 2010
3571 \begin_layout Subsection*
3575 \begin_layout Description
3576 Action Scroll the buffer view.
3579 \begin_layout Description
3580 Notion Only scrolls the screen up or down; does not move the cursor.
3583 \begin_layout Description
3584 Syntax scroll <TYPE> <QUANTITY>
3587 \begin_layout Description
3588 Params <TYPE>: line|page
3589 \begin_inset Newline newline
3592 <QUANTITY>: up|down|<number>
3595 \begin_layout Description
3596 Origin Abdel, Dec 27 2007
3599 \begin_layout Subsection*
3603 \begin_layout Description
3604 Action Select the whole section.
3607 \begin_layout Description
3608 Notion The cursor should be in a section heading before calling this lfun.
3611 \begin_layout Description
3612 Syntax section-select
3615 \begin_layout Description
3616 Origin vfr, 05 May 2009
3619 \begin_layout Subsection*
3623 \begin_layout Description
3624 Action Pastes the internal selection text in permanent selection.
3627 \begin_layout Description
3628 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3631 \begin_layout Description
3632 Syntax selection-paste
3635 \begin_layout Description
3636 Origin lasgouttes, 14 Jan 2009
3639 \begin_layout Subsection*
3643 \begin_layout Description
3644 Action Inserts an environment separator or paragraph break.
3647 \begin_layout Description
3648 Syntax separator-insert [<ARG>]
3651 \begin_layout Description
3652 Params <ARG>: <plain|parbreak> default: plain
3655 \begin_layout Description
3656 Origin ef, 2 May 2014
3659 \begin_layout Subsection*
3663 \begin_layout Description
3664 Action Set the group for the graphics inset on the cursor position.
3667 \begin_layout Description
3668 Syntax set-graphics-group [<GROUP>]
3671 \begin_layout Description
3672 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3675 \begin_layout Description
3676 Origin sanda, 6 May 2008
3679 \begin_layout Subsection*
3683 \begin_layout Description
3684 Action Inserts one of horizontal space insets.
3687 \begin_layout Description
3688 Syntax space-insert <NAME> [<LEN>]
3691 \begin_layout Description
3692 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3693 \begin_inset Newline newline
3696 Only in math mode: med and thick.
3697 \begin_inset Newline newline
3700 <LEN>: length for custom spaces (hspace, hspace* for protected)
3703 \begin_layout Description
3704 Origin JSpitzm, 20 May 2003, Mar 17 2008
3707 \begin_layout Subsection*
3711 \begin_layout Description
3712 Action Inserts various characters into the document.
3715 \begin_layout Description
3716 Syntax specialchar-insert <CHAR>
3719 \begin_layout Description
3720 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3723 \begin_layout Description
3724 Origin JSpitzm, 6 Dec 2007
3727 \begin_layout Subsection*
3731 \begin_layout Description
3732 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3735 \begin_layout Description
3736 Syntax spelling-add [<STRING>] [<LANG>]
3739 \begin_layout Description
3740 Params <WORD>: word to add <LANG>: language name (see file languages)
3743 \begin_layout Description
3744 Origin JSpitzm, 18 Jan 2010
3747 \begin_layout Subsection*
3748 spelling-continuously
3751 \begin_layout Description
3752 Action Toggle continuous spell checking.
3755 \begin_layout Description
3756 Syntax spelling-continuously
3759 \begin_layout Description
3760 Origin vfr, 24 March 2013
3763 \begin_layout Subsection*
3767 \begin_layout Description
3768 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.
3771 \begin_layout Description
3772 Syntax spelling-ignore [<WORD>] [<LANG>]
3775 \begin_layout Description
3776 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3779 \begin_layout Description
3780 Origin JSpitzm, 18 Jan 2010
3783 \begin_layout Subsection*
3787 \begin_layout Description
3788 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3791 \begin_layout Description
3792 Syntax spelling-remove [<STRING>] [<LANG>]
3795 \begin_layout Description
3796 Params <WORD>: word to remove <LANG>: language name (see file languages)
3799 \begin_layout Description
3800 Origin SWitt, 28 July 2010
3803 \begin_layout Subsection*
3807 \begin_layout Description
3808 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3811 \begin_layout Description
3812 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.
3815 \begin_layout Description
3819 \begin_layout Description
3820 Origin vfr, Sep 30 2008
3823 \begin_layout Subsection*
3827 \begin_layout Description
3828 Action Insert a tab into a listings inset.
3831 \begin_layout Description
3832 Notion It also works on a selection.
3835 \begin_layout Description
3839 \begin_layout Description
3840 Origin vfr, Sep 30 2008
3843 \begin_layout Subsection*
3847 \begin_layout Description
3848 Action Modify properties of tabulars and table-like math environments.
3851 \begin_layout Description
3852 Syntax tabular-feature <FEATURE> [<ARG>]
3855 \begin_layout Description
3856 Params Generally see LFUN_INSET_INSERT for further details.
3857 \begin_inset Newline newline
3860 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
3861 \begin_inset Newline newline
3864 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
3865 \begin_inset Newline newline
3868 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3869 \begin_inset Newline newline
3872 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
3873 \begin_inset Newline newline
3876 valign-top|valign-bottom|valign-middle|longtabular-align-left|
3877 \begin_inset Newline newline
3880 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
3881 \begin_inset Newline newline
3884 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
3885 \begin_inset Newline newline
3888 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
3889 \begin_inset Newline newline
3892 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
3893 \begin_inset Newline newline
3896 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
3897 \begin_inset Newline newline
3900 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
3901 \begin_inset Newline newline
3904 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3905 \begin_inset Newline newline
3908 set-special-column|set-special-multicolumn|set-special-multirow|
3909 \begin_inset Newline newline
3912 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
3913 \begin_inset Newline newline
3916 set-interline-space|set-border-lines|tabular-valign-top|
3917 \begin_inset Newline newline
3920 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
3921 \begin_inset Newline newline
3924 Various math-environment features are handled as well, e.g. add-vline-left/right for
3925 \begin_inset Newline newline
3928 the Grid/Array environment.
3929 \begin_inset Newline newline
3932 <ARG>: additional argument for some commands, use debug mode to explore its values.
3935 \begin_layout Description
3936 Origin gm, 10 Dec 2015
3939 \begin_layout Subsection*
3943 \begin_layout Description
3944 Action Inserts table into the document.
3947 \begin_layout Description
3948 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
3951 \begin_layout Description
3952 Syntax tabular-insert [<ROWS> <COLUMNS>]
3955 \begin_layout Description
3956 Params In case no arguments are given show insert dialog.
3959 \begin_layout Description
3960 Origin Jug, 12 Apr 2000
3963 \begin_layout Subsection*
3967 \begin_layout Description
3968 Action Look up thesaurus entries with respect to the word under the cursor.
3971 \begin_layout Description
3972 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
3975 \begin_layout Description
3976 Params <STRING>: word to look up <LANG>: language (see file languages)
3979 \begin_layout Description
3980 Origin Levon, 20 Jul 2001
3983 \begin_layout Subsection*
3987 \begin_layout Description
3988 Action Undoes the last edit.
3991 \begin_layout Description
3995 \begin_layout Subsection*
3999 \begin_layout Description
4000 Action Inserts a single unicode character.
4003 \begin_layout Description
4004 Syntax unicode-insert <CHAR>
4007 \begin_layout Description
4008 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
4011 \begin_layout Description
4012 Sample unicode-insert 0x0100
4015 \begin_layout Description
4016 Origin Lgb, 22 Oct 2006
4019 \begin_layout Subsection*
4023 \begin_layout Description
4024 Action Moves the cursor one line in upward direction.
4027 \begin_layout Description
4031 \begin_layout Subsection*
4035 \begin_layout Description
4036 Action Moves the cursor one line in upward direction adding the current position to the selection.
4039 \begin_layout Description
4043 \begin_layout Subsection*
4047 \begin_layout Description
4048 Action Moves the cursor to the logically previous beginning of a word.
4051 \begin_layout Description
4052 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.
4055 \begin_layout Description
4056 Syntax word-backward
4059 \begin_layout Subsection*
4060 word-backward-select
4063 \begin_layout Description
4064 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4067 \begin_layout Description
4068 Notion See also LFUN_WORD_BACKWARD.
4071 \begin_layout Description
4072 Syntax word-backward-select
4075 \begin_layout Subsection*
4079 \begin_layout Description
4080 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4083 \begin_layout Description
4084 Syntax word-capitalize [<SEL_TYPE>]
4087 \begin_layout Description
4088 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.
4091 \begin_layout Subsection*
4092 word-delete-backward
4095 \begin_layout Description
4096 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4099 \begin_layout Description
4100 Syntax word-delete-backward
4103 \begin_layout Subsection*
4107 \begin_layout Description
4108 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4111 \begin_layout Description
4112 Syntax word-delete-forward
4115 \begin_layout Subsection*
4119 \begin_layout Description
4120 Action Search for next occurrence of a string.
4123 \begin_layout Description
4124 Syntax word-find [<DATA>]
4127 \begin_layout Description
4128 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).
4131 \begin_layout Description
4132 Origin Andre, Jan 7 2004
4135 \begin_layout Subsection*
4139 \begin_layout Description
4140 Action Search for a given string in backward direction.
4143 \begin_layout Description
4144 Notion Case sensitive, match words. If no argument given, last search repeated.
4147 \begin_layout Description
4148 Syntax word-find-backward [<STRING>]
4151 \begin_layout Description
4152 Origin Etienne, 20 Feb 1998
4155 \begin_layout Subsection*
4159 \begin_layout Description
4160 Action Search for a given string in forward direction.
4163 \begin_layout Description
4164 Notion Case sensitive, match words. If no argument given, last search repeated.
4167 \begin_layout Description
4168 Syntax word-find-forward [<STRING>]
4171 \begin_layout Description
4172 Origin Etienne, 16 Feb 1998
4175 \begin_layout Subsection*
4179 \begin_layout Description
4180 Action Search for next occurrence of a pattern.
4183 \begin_layout Description
4184 Syntax word-findadv [<DATA>]
4187 \begin_layout Description
4188 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).
4191 \begin_layout Description
4192 Origin Tommaso, Nov 15 2007
4195 \begin_layout Subsection*
4199 \begin_layout Description
4200 Action Moves the cursor to the logically next beginning of a word.
4203 \begin_layout Description
4204 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.
4207 \begin_layout Description
4211 \begin_layout Subsection*
4215 \begin_layout Description
4216 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4219 \begin_layout Description
4220 Notion See also LFUN_WORD_FORWARD.
4223 \begin_layout Description
4224 Syntax word-forward-select
4227 \begin_layout Subsection*
4231 \begin_layout Description
4232 Action Moves the cursor to the next beginning of a word "on the left".
4235 \begin_layout Description
4236 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.
4239 \begin_layout Description
4243 \begin_layout Description
4244 Origin dov, 28 Oct 2007
4247 \begin_layout Subsection*
4251 \begin_layout Description
4252 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4255 \begin_layout Description
4256 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4259 \begin_layout Description
4260 Syntax word-left-select
4263 \begin_layout Description
4264 Origin dov, 28 Oct 2007
4267 \begin_layout Subsection*
4271 \begin_layout Description
4272 Action Change the words in the selection or word at cursor position to lower case.
4275 \begin_layout Description
4276 Syntax word-lowcase [<SEL_TYPE>]
4279 \begin_layout Description
4280 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.
4283 \begin_layout Subsection*
4287 \begin_layout Description
4288 Action Replace a string in the document.
4291 \begin_layout Description
4292 Syntax word-replace [<DATA>]
4295 \begin_layout Description
4296 Params <DATA>: data is of the form "<replace>
4297 \begin_inset Newline newline
4301 \begin_inset Newline newline
4304 <casesensitive> <matchword> <all> <forward> <findnext>"
4307 \begin_layout Description
4308 Origin Andre, Jan 7 2004
4311 \begin_layout Subsection*
4315 \begin_layout Description
4316 Action Moves the cursor to the next beginning of a word "on the right".
4319 \begin_layout Description
4320 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.
4323 \begin_layout Description
4327 \begin_layout Description
4328 Origin dov, 28 Oct 2007
4331 \begin_layout Subsection*
4335 \begin_layout Description
4336 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4339 \begin_layout Description
4340 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4343 \begin_layout Description
4344 Syntax word-right-select
4347 \begin_layout Description
4348 Origin dov, 28 Oct 2007
4351 \begin_layout Subsection*
4355 \begin_layout Description
4356 Action Puts the word where the cursor stands into the selection.
4359 \begin_layout Description
4363 \begin_layout Description
4364 Origin Andre, 11 Sep 2002
4367 \begin_layout Subsection*
4371 \begin_layout Description
4372 Action Change the words in the selection or word at cursor position to upper case.
4375 \begin_layout Description
4376 Syntax word-upcase [<SEL_TYPE>]
4379 \begin_layout Description
4380 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.
4383 \begin_layout Subsection*
4387 \begin_layout Description
4388 Action Inserts floats wrapped by the text around.
4391 \begin_layout Description
4392 Syntax wrap-insert <TYPE>
4395 \begin_layout Description
4396 Params <TYPE>: table|figure
4399 \begin_layout Description
4400 Origin Dekel, 7 Apr 2002
4403 \begin_layout Section
4404 Math Editor Functions
4407 \begin_layout Subsection*
4408 in-mathmacrotemplate
4411 \begin_layout Description
4412 Action Only active in Math Macro definition.
4415 \begin_layout Description
4416 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.
4419 \begin_layout Description
4420 Syntax in-mathmacrotemplate
4423 \begin_layout Description
4424 Origin sts, 06 January 2008
4427 \begin_layout Subsection*
4431 \begin_layout Description
4432 Action Inserts an extended matrix as provided by the amsmath package.
4435 \begin_layout Description
4436 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4439 \begin_layout Description
4440 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'.
4443 \begin_layout Description
4444 Sample math-ams-matrix 3 3 bmatrix
4447 \begin_layout Subsection*
4451 \begin_layout Description
4452 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4455 \begin_layout Description
4456 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4459 \begin_layout Description
4460 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4461 \begin_inset Newline newline
4464 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4467 \begin_layout Description
4468 Sample math-bigdelim "Bigl" "
4475 \begin_layout Description
4476 Origin Enrico & Georg, 7 May 2006
4479 \begin_layout Subsection*
4483 \begin_layout Description
4484 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4487 \begin_layout Description
4488 Syntax math-delim [<LEFT>] [<RIGHT>]
4491 \begin_layout Description
4492 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.
4495 \begin_layout Description
4496 Sample math-delim { rangle
4499 \begin_layout Description
4500 Origin Alejandro, 18 Jun 1996
4503 \begin_layout Subsection*
4507 \begin_layout Description
4508 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4511 \begin_layout Description
4512 Syntax math-display [<ARG>]
4515 \begin_layout Description
4516 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4519 \begin_layout Description
4520 Origin Alejandro, 18 Jun 1996
4523 \begin_layout Subsection*
4527 \begin_layout Description
4528 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4531 \begin_layout Description
4532 Notion Selection can be used to determine the input for the external program.
4535 \begin_layout Description
4536 Syntax math-extern <LANG> [<COMMAND>]
4539 \begin_layout Description
4540 Params <LANG>: octave|maxima|maple|mathematica|script
4541 \begin_inset Newline newline
4544 where "script" stands for the external script (normalized expression will be passed)
4547 \begin_layout Description
4548 Sample math-extern maple simplify
4551 \begin_layout Description
4552 Origin Andre, 24 Apr 2001
4555 \begin_layout Subsection*
4559 \begin_layout Description
4560 Action Changes the text style used in math.
4563 \begin_layout Description
4564 Syntax math-font-style <STYLE>
4567 \begin_layout Description
4568 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4569 \begin_inset Newline newline
4572 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4575 \begin_layout Description
4576 Origin vfr, 9 jan 2009
4579 \begin_layout Subsection*
4583 \begin_layout Description
4584 Action Inserts math objects and symbols.
4587 \begin_layout Description
4588 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4590 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
4592 frac{x}{y}" replaces "abc" with "
4594 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.
4597 \begin_layout Description
4598 Syntax math-insert <ARG>
4601 \begin_layout Description
4602 Params <ARG>: Symbol or LaTeX code to be inserted.
4605 \begin_layout Subsection*
4609 \begin_layout Description
4610 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.
4613 \begin_layout Description
4614 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4617 \begin_layout Description
4618 Syntax math-limits [<STATE>]
4621 \begin_layout Description
4622 Params <STATE>: limits|nolimits
4625 \begin_layout Subsection*
4629 \begin_layout Description
4630 Action Inserts a math macro definition at the cursor position in the text.
4633 \begin_layout Description
4634 Syntax math-macro <NAME> [<NARGS>] [def]
4637 \begin_layout Description
4638 Params <NAME>: The name of the macro, e.g. "mymacro".
4639 \begin_inset Newline newline
4642 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4645 \begin_layout Description
4646 Origin ale, 10 May 1997; sts, 21 Dec 2007
4649 \begin_layout Subsection*
4650 math-macro-add-greedy-optional-param
4653 \begin_layout Description
4654 Action Add a greedy optional parameter.
4657 \begin_layout Description
4658 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4661 \begin_layout Description
4662 Syntax math-macro-add-greedy-optional-param
4665 \begin_layout Description
4666 Origin sts, 06 January 2008
4669 \begin_layout Subsection*
4670 math-macro-add-optional-param
4673 \begin_layout Description
4674 Action Add an optional parameter.
4677 \begin_layout Description
4678 Notion Insert an optional parameter just behind the already existing optional parameters.
4681 \begin_layout Description
4682 Syntax math-macro-add-optional-param
4685 \begin_layout Description
4686 Origin sts, 06 January 2008
4689 \begin_layout Subsection*
4690 math-macro-add-param
4693 \begin_layout Description
4694 Action Add a parameter.
4697 \begin_layout Description
4698 Notion Add a parameter to a Math Macro.
4701 \begin_layout Description
4702 Syntax math-macro-add-param <NUM>
4705 \begin_layout Description
4706 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.
4709 \begin_layout Description
4710 Origin sts, 06 January 2008
4713 \begin_layout Subsection*
4714 math-macro-append-greedy-param
4717 \begin_layout Description
4718 Action Append a greedy parameter.
4721 \begin_layout Description
4722 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
4725 \begin_layout Description
4726 Syntax math-macro-append-greedy-param
4729 \begin_layout Description
4730 Origin sts, 06 January 2008
4733 \begin_layout Subsection*
4737 \begin_layout Description
4738 Action Fold a Math Macro.
4741 \begin_layout Description
4742 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
4747 \begin_layout Description
4748 Syntax math-macro-fold
4751 \begin_layout Description
4752 Origin sts, 06 January 2008
4755 \begin_layout Subsection*
4756 math-macro-make-nonoptional
4759 \begin_layout Description
4760 Action Make a parameter non-optional.
4763 \begin_layout Description
4764 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.
4767 \begin_layout Description
4768 Syntax math-macro-make-nonoptional
4771 \begin_layout Description
4772 Origin sts, 06 January 2008
4775 \begin_layout Subsection*
4776 math-macro-make-optional
4779 \begin_layout Description
4780 Action Make a parameter optional.
4783 \begin_layout Description
4784 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
4787 \begin_layout Description
4788 Syntax math-macro-make-optional
4791 \begin_layout Description
4792 Origin sts, 06 January 2008
4795 \begin_layout Subsection*
4796 math-macro-remove-greedy-param
4799 \begin_layout Description
4800 Action Remove a greedy parameter.
4803 \begin_layout Description
4804 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.
4807 \begin_layout Description
4808 Syntax math-macro-remove-greedy-param
4811 \begin_layout Description
4812 Origin sts, 06 January 2008
4815 \begin_layout Subsection*
4816 math-macro-remove-optional-param
4819 \begin_layout Description
4820 Action Remove the last optional parameter.
4823 \begin_layout Description
4824 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
4827 \begin_layout Description
4828 Syntax math-macro-remove-optional-param
4831 \begin_layout Description
4832 Origin sts, 06 January 2008
4835 \begin_layout Subsection*
4836 math-macro-remove-param
4839 \begin_layout Description
4840 Action Remove the last parameter.
4843 \begin_layout Description
4844 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
4847 \begin_layout Description
4848 Syntax math-macro-remove-param <NUM>
4851 \begin_layout Description
4852 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
4855 \begin_layout Description
4856 Origin sts, 06 January 2008
4859 \begin_layout Subsection*
4863 \begin_layout Description
4864 Action Unfold a Math Macro.
4867 \begin_layout Description
4868 Notion Unfold the Math Macro the cursor is in, i.e. display it as
4873 \begin_layout Description
4874 Syntax math-macro-unfold
4877 \begin_layout Description
4878 Origin sts, 06 January 2008
4881 \begin_layout Subsection*
4885 \begin_layout Description
4886 Action Inserts a matrix.
4889 \begin_layout Description
4890 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
4893 \begin_layout Description
4894 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).
4897 \begin_layout Description
4898 Sample math-matrix 3 3 bccc
4901 \begin_layout Subsection*
4905 \begin_layout Description
4906 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.
4909 \begin_layout Description
4910 Notion If there is some selected text, it puts the text inside created math box.
4913 \begin_layout Description
4914 Syntax math-mode [on|<ARG>]
4917 \begin_layout Description
4918 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
4919 \begin_inset Newline newline
4922 "on": allow only entering of math mode from text mode.
4925 \begin_layout Description
4926 Origin Alejandro, 4 Jun 1996
4929 \begin_layout Subsection*
4933 \begin_layout Description
4934 Action Mutates the type of math inset to the newly selected one.
4937 \begin_layout Description
4938 Syntax math-mutate <TYPE>
4941 \begin_layout Description
4942 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
4945 \begin_layout Description
4946 Origin Andre, 23 May 2001
4949 \begin_layout Subsection*
4950 math-number-line-toggle
4953 \begin_layout Description
4954 Action Toggles numbering of the current formula line.
4957 \begin_layout Description
4958 Notion Must be in display formula mode.
4961 \begin_layout Description
4962 Syntax math-number-line-toggle
4965 \begin_layout Description
4966 Origin Alejandro, 18 Jun 1996
4969 \begin_layout Subsection*
4973 \begin_layout Description
4974 Action Toggles numbering/labeling of the current formula.
4977 \begin_layout Description
4978 Notion Must be in display formula mode.
4981 \begin_layout Description
4982 Syntax math-number-toggle
4985 \begin_layout Description
4986 Origin Alejandro, 4 Jun 1996
4989 \begin_layout Subsection*
4993 \begin_layout Description
4994 Action Changes arbitrarily the size used by math fonts inside a context.
4997 \begin_layout Description
4998 Notion Provides an interface to the LaTeX math mode font size commands.
5001 \begin_layout Description
5002 Syntax math-size <STYLE>
5005 \begin_layout Description
5017 \begin_layout Description
5018 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5021 \begin_layout Subsection*
5025 \begin_layout Description
5026 Action Inserts space into math expression.
5029 \begin_layout Description
5030 Notion Use spacebar after entering this space to change type of space.
5033 \begin_layout Description
5034 Syntax math-space [<TYPE>] [<LEN>]
5037 \begin_layout Description
5038 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5039 \begin_inset Newline newline
5042 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5043 \begin_inset Newline newline
5046 custom space: hspace
5047 \begin_inset Newline newline
5050 "," used by default.
5051 \begin_inset Newline newline
5054 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5055 \begin_inset Newline newline
5058 <LEN>: length for custom spaces (hspace)
5061 \begin_layout Description
5062 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5065 \begin_layout Subsection*
5069 \begin_layout Description
5070 Action Enters subscript expression in math expression.
5073 \begin_layout Description
5074 Syntax math-subscript
5077 \begin_layout Description
5078 Origin vermeer, 12 Dec 2001
5081 \begin_layout Subsection*
5085 \begin_layout Description
5086 Action Enters superscript expression in math expression.
5089 \begin_layout Description
5090 Syntax math-superscript
5093 \begin_layout Description
5094 Origin vermeer, 12 Dec 2001
5097 \begin_layout Subsection*
5101 \begin_layout Description
5102 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5105 \begin_layout Description
5106 Notion If there is any selected text, then it is moved inside the created regexp inset.
5109 \begin_layout Description
5110 Syntax regexp-mode [<ARG>]
5113 \begin_layout Description
5114 Params <ARG>: eventual argument (regular expression).
5117 \begin_layout Description
5118 Origin Tommaso, 4 Oct 2008
5121 \begin_layout Section
5122 Buffer Fuctions (File and Window related)
5125 \begin_layout Subsection*
5129 \begin_layout Description
5130 Action Activate the branch.
5133 \begin_layout Description
5134 Syntax branch-activate <BRANCH>
5137 \begin_layout Description
5138 Params <BRANCH>: The branch to activate
5141 \begin_layout Description
5142 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5143 \begin_inset Newline newline
5146 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5149 \begin_layout Description
5150 Origin rgh, 27 May 2008
5153 \begin_layout Subsection*
5157 \begin_layout Description
5158 Action Add a branch to the buffer's BranchList.
5161 \begin_layout Description
5162 Syntax branch-add <BRANCH>
5165 \begin_layout Description
5166 Params <BRANCH>: Name of the branch to add
5169 \begin_layout Description
5170 Origin spitz, 7 Jul 2009
5173 \begin_layout Subsection*
5177 \begin_layout Description
5178 Action Create new branch and directly put the branch inset into the document.
5181 \begin_layout Description
5182 Syntax branch-add-insert [<NAME>]
5185 \begin_layout Description
5186 Params <NAME>: Branch name. If it is not specified, you will be asked.
5189 \begin_layout Description
5190 Origin sanda, 10 Jul 2009
5193 \begin_layout Subsection*
5197 \begin_layout Description
5198 Action De-activate the branch.
5201 \begin_layout Description
5202 Syntax branch-deactivate <BRANCH>
5205 \begin_layout Description
5206 Params <BRANCH>: The branch to deactivate
5209 \begin_layout Description
5210 Origin rgh, 27 May 2008
5213 \begin_layout Subsection*
5214 branch-master-activate
5217 \begin_layout Description
5218 Action Activate the branch in the master buffer.
5221 \begin_layout Description
5222 Syntax branch-master-activate <BRANCH>
5225 \begin_layout Description
5226 Params <BRANCH>: The branch to activate
5229 \begin_layout Description
5230 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5231 \begin_inset Newline newline
5234 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5237 \begin_layout Description
5238 Origin spitz, 30 Sep 2012
5241 \begin_layout Subsection*
5242 branch-master-deactivate
5245 \begin_layout Description
5246 Action De-activate the branch in the master buffer.
5249 \begin_layout Description
5250 Syntax branch-master-deactivate <BRANCH>
5253 \begin_layout Description
5254 Params <BRANCH>: The branch to deactivate
5257 \begin_layout Description
5258 Origin spitz, 30 Sep 2012
5261 \begin_layout Subsection*
5265 \begin_layout Description
5266 Action Rename all branches of a given name in a document.
5269 \begin_layout Description
5270 Syntax branches-rename <OLDNAME> <NEWNAME>
5273 \begin_layout Description
5274 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5277 \begin_layout Description
5278 Origin spitz, 9 Jul 2009
5281 \begin_layout Subsection*
5285 \begin_layout Description
5286 Action Saves the current buffer to a temporary file.
5289 \begin_layout Description
5290 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5293 \begin_layout Description
5294 Syntax buffer-auto-save
5297 \begin_layout Subsection*
5301 \begin_layout Description
5302 Action Loads the given child document.
5305 \begin_layout Description
5306 Notion The current document is treated as a parent.
5309 \begin_layout Description
5310 Syntax buffer-child-open <FILE>
5313 \begin_layout Description
5314 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5317 \begin_layout Description
5318 Origin Ale, 28 May 1997
5321 \begin_layout Subsection*
5325 \begin_layout Description
5326 Action Runs chktex for the current document.
5329 \begin_layout Description
5330 Syntax buffer-chktex
5333 \begin_layout Description
5334 Origin Asger, 30 Oct 1997
5337 \begin_layout Subsection*
5341 \begin_layout Description
5342 Action Closes the current buffer.
5345 \begin_layout Description
5346 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5349 \begin_layout Description
5353 \begin_layout Subsection*
5357 \begin_layout Description
5358 Action Closes all buffers.
5361 \begin_layout Description
5362 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5365 \begin_layout Description
5366 Syntax buffer-close-all
5369 \begin_layout Subsection*
5373 \begin_layout Description
5374 Action Exports the current buffer (document) to the given format.
5377 \begin_layout Description
5378 Syntax buffer-export <FORMAT> [<DEST>]
5381 \begin_layout Description
5382 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.
5383 \begin_inset Newline newline
5386 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.
5389 \begin_layout Description
5390 Origin Lgb, 29 Jul 1997
5393 \begin_layout Subsection*
5397 \begin_layout Description
5398 Action Opens a dialog for exporting the current buffer.
5401 \begin_layout Description
5402 Syntax buffer-export-as [<FORMAT>]
5405 \begin_layout Description
5406 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.
5409 \begin_layout Description
5410 Sample buffer-export-as pdf2
5413 \begin_layout Description
5414 Origin tommaso, 6 Oct 2011
5417 \begin_layout Subsection*
5418 buffer-export-custom
5421 \begin_layout Description
5422 Action Exports the current buffer (document) from the given format using the given command on it.
5425 \begin_layout Description
5426 Syntax buffer-export-custom <FORMAT> <COMMAND>
5429 \begin_layout Description
5430 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5431 \begin_inset Newline newline
5434 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5437 \begin_layout Description
5438 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5441 \begin_layout Description
5442 Origin leeming, 27 Mar 2004
5445 \begin_layout Subsection*
5449 \begin_layout Description
5450 Action Applies a command to all non-hidden buffers.
5453 \begin_layout Description
5454 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5457 \begin_layout Description
5458 Syntax buffer-forall <LFUN-COMMAND>
5461 \begin_layout Description
5462 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5465 \begin_layout Description
5466 Sample Close all Notes in buffers:
5467 \begin_inset Newline newline
5470 buffer-forall inset-forall Note inset-toggle close
5471 \begin_inset Newline newline
5474 Toggle change tracking on buffers:
5475 \begin_inset Newline newline
5478 buffer-forall changes-track
5479 \begin_inset Newline newline
5482 Toggle read-only for buffers:
5483 \begin_inset Newline newline
5486 buffer-forall buffer-toggle-read-only
5487 \begin_inset Newline newline
5490 Show statistics for individual buffers:
5491 \begin_inset Newline newline
5494 buffer-forall statistics
5495 \begin_inset Newline newline
5498 Activate the branch named "Solutions" in buffers:
5499 \begin_inset Newline newline
5502 buffer-forall branch-activate Solutions
5503 \begin_inset Newline newline
5506 Export buffers to PDF (pdflatex):
5507 \begin_inset Newline newline
5510 buffer-forall buffer-export pdf2
5511 \begin_inset Newline newline
5517 \begin_layout Description
5518 Origin skostysh, 20 Jul 2012
5521 \begin_layout Subsection*
5525 \begin_layout Description
5526 Action Import a given file as a lyx document.
5529 \begin_layout Description
5530 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.
5533 \begin_layout Description
5534 Syntax buffer-import <FORMAT> [<FILE>]
5537 \begin_layout Description
5538 Origin Asger, 24 Jul 1998
5541 \begin_layout Subsection*
5545 \begin_layout Description
5546 Action Set language of the current document.
5549 \begin_layout Description
5550 Syntax buffer-language <LANG>
5553 \begin_layout Description
5554 Params <LANG>: language name. See lib/languages for list.
5557 \begin_layout Description
5558 Origin leeming, 30 Mar 2004
5561 \begin_layout Subsection*
5565 \begin_layout Description
5566 Action Moves the current tab one spot to the right.
5569 \begin_layout Description
5570 Syntax buffer-move-next
5573 \begin_layout Description
5574 Origin skostysh, 7 Apr 2015
5577 \begin_layout Subsection*
5578 buffer-move-previous
5581 \begin_layout Description
5582 Action Moves the current tab one spot to the left.
5585 \begin_layout Description
5586 Syntax buffer-move-previous
5589 \begin_layout Description
5590 Origin skostysh, 7 Apr 2015
5593 \begin_layout Subsection*
5597 \begin_layout Description
5598 Action Creates a new buffer (that is, document) and switches to it.
5601 \begin_layout Description
5602 Notion Implicit path can be set in Preferences dialog.
5605 \begin_layout Description
5606 Syntax buffer-new [<FILE>]
5609 \begin_layout Description
5610 Params <FILE>: filename of created file with absolute path.
5613 \begin_layout Subsection*
5617 \begin_layout Description
5618 Action Creates a new buffer (that is, document) from a template.
5621 \begin_layout Description
5622 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5625 \begin_layout Description
5626 Syntax buffer-new-template [<FILE>]
5629 \begin_layout Description
5630 Params <FILE>: filename of created file with absolute path.
5633 \begin_layout Subsection*
5637 \begin_layout Description
5638 Action Switch to the next opened document.
5641 \begin_layout Description
5642 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
5645 \begin_layout Description
5649 \begin_layout Subsection*
5653 \begin_layout Description
5654 Action Apply the given settings to the current document.
5657 \begin_layout Description
5658 Syntax buffer-params-apply [<ARGS>]
5661 \begin_layout Description
5662 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5665 \begin_layout Description
5666 Origin leeming, 30 Mar 2004
5669 \begin_layout Subsection*
5673 \begin_layout Description
5674 Action Switch to the previous opened document.
5677 \begin_layout Description
5678 Syntax buffer-previous
5681 \begin_layout Subsection*
5685 \begin_layout Description
5686 Action Reverts opened document.
5689 \begin_layout Description
5690 Syntax buffer-reload
5693 \begin_layout Description
5694 Origin Asger, 2 Feb 1997
5697 \begin_layout Subsection*
5698 buffer-save-as-default
5701 \begin_layout Description
5702 Action Save the current document settings as default.
5705 \begin_layout Description
5706 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5709 \begin_layout Description
5710 Syntax buffer-save-as-default [<ARGS>]
5713 \begin_layout Description
5714 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5717 \begin_layout Description
5718 Origin leeming, 30 Mar 2004
5721 \begin_layout Subsection*
5725 \begin_layout Description
5726 Action Display and switch to the given buffer.
5729 \begin_layout Description
5730 Syntax buffer-switch <BUFFER>
5733 \begin_layout Description
5734 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
5737 \begin_layout Subsection*
5738 buffer-toggle-compression
5741 \begin_layout Description
5742 Action Toggles compression of the current document on/off.
5745 \begin_layout Description
5746 Syntax buffer-toggle-compression
5749 \begin_layout Description
5750 Origin bpeng, 27 Apr 2006
5753 \begin_layout Subsection*
5754 buffer-toggle-read-only
5757 \begin_layout Description
5758 Action Toggle editing mode of the current document between read/write and read-only.
5761 \begin_layout Description
5762 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.
5765 \begin_layout Description
5766 Syntax buffer-toggle-read-only
5769 \begin_layout Description
5770 Origin Lgb, 27 May 1997
5773 \begin_layout Subsection*
5777 \begin_layout Description
5778 Action Exports the current document and put the result into the temporary directory.
5781 \begin_layout Description
5782 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).
5785 \begin_layout Description
5786 Syntax buffer-update [<FORMAT>]
5789 \begin_layout Description
5790 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.
5793 \begin_layout Description
5794 Origin Dekel, 5 Aug 2000
5797 \begin_layout Subsection*
5801 \begin_layout Description
5802 Action Displays current buffer in chosen format.
5805 \begin_layout Description
5806 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.
5809 \begin_layout Description
5810 Syntax buffer-view [<FORMAT>]
5813 \begin_layout Description
5814 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.
5817 \begin_layout Subsection*
5821 \begin_layout Description
5822 Action Opens the file that was created from last preview of this buffer.
5825 \begin_layout Description
5826 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.
5829 \begin_layout Description
5830 Syntax buffer-view-cache
5833 \begin_layout Subsection*
5837 \begin_layout Description
5838 Action Saves the current buffer.
5841 \begin_layout Description
5842 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.
5845 \begin_layout Description
5849 \begin_layout Subsection*
5853 \begin_layout Description
5854 Action Save all changed documents.
5857 \begin_layout Description
5858 Syntax buffer-write-all
5861 \begin_layout Description
5862 Origin rgh, gpothier 6 Aug 2007
5865 \begin_layout Subsection*
5869 \begin_layout Description
5870 Action Rename and save current buffer.
5873 \begin_layout Description
5874 Syntax buffer-write-as <FILENAME>
5877 \begin_layout Description
5878 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
5881 \begin_layout Subsection*
5885 \begin_layout Description
5886 Action Increases the zoom of the screen fonts.
5889 \begin_layout Description
5890 Syntax buffer-zoom-in [<ZOOM>]
5893 \begin_layout Description
5894 Params <ZOOM>: The zoom in %, the default is 20.
5897 \begin_layout Description
5898 Origin vfr, 30 Mar 2009
5901 \begin_layout Subsection*
5905 \begin_layout Description
5906 Action Decreases the zoom of the screen fonts.
5909 \begin_layout Description
5910 Syntax buffer-zoom-out [<ZOOM>]
5913 \begin_layout Description
5914 Params <ZOOM>: The zoom in %, the default is 20.
5917 \begin_layout Description
5918 Origin vfr, 30 Mar 2009
5921 \begin_layout Subsection*
5925 \begin_layout Description
5926 Action Generates the code (literate programming).
5929 \begin_layout Description
5930 Notion Latex file with extension
5932 literate_extension is generated. Then LyX invokes
5934 build_command (with a default of ``make'') to generate the code and
5936 build_error_filter to process the compilation error messages.
5937 \begin_inset Newline newline
5940 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:
5941 \begin_inset Newline newline
5946 build_command "my_script my_arguments"
5947 \begin_inset Newline newline
5952 build_error_filter differs from the
5954 literate_error_filter only in that the former will identify error messages from your compiler.
5957 \begin_layout Description
5958 Syntax build-program
5961 \begin_layout Subsection*
5965 \begin_layout Description
5966 Action Open LyX document.
5969 \begin_layout Description
5970 Syntax file-open [<FILE>]
5973 \begin_layout Description
5974 Params <FILE>: Filename to be opened.
5977 \begin_layout Subsection*
5981 \begin_layout Description
5982 Action Open the given help file according to the language setting.
5985 \begin_layout Description
5986 Syntax help-open <FILE>[.lyx]
5989 \begin_layout Description
5990 Params <FILE>: any document from (/usr/share/)doc directory.
5993 \begin_layout Description
5994 Origin Jug, 27 Jun 1999
5997 \begin_layout Subsection*
6001 \begin_layout Description
6002 Action Terminates the current LyX instance.
6005 \begin_layout Description
6006 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6009 \begin_layout Description
6013 \begin_layout Subsection*
6014 master-buffer-update
6017 \begin_layout Description
6018 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6021 \begin_layout Description
6022 Syntax master-buffer-update [<FORMAT>]
6025 \begin_layout Description
6026 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.
6029 \begin_layout Description
6030 Origin Tommaso, 20 Sep 2007
6033 \begin_layout Subsection*
6037 \begin_layout Description
6038 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6041 \begin_layout Description
6042 Syntax master-buffer-view [<FORMAT>]
6045 \begin_layout Description
6046 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.
6049 \begin_layout Description
6050 Origin Tommaso, 20 Sep 2007
6053 \begin_layout Subsection*
6057 \begin_layout Description
6058 Action Opens the menu given by its name.
6061 \begin_layout Description
6062 Syntax menu-open <NAME>
6065 \begin_layout Description
6066 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6069 \begin_layout Subsection*
6073 \begin_layout Description
6074 Action Close the current tab group.
6077 \begin_layout Description
6078 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6081 \begin_layout Description
6082 Syntax tab-group-close
6085 \begin_layout Description
6086 Origin Abdel, 21 Feb 2008
6089 \begin_layout Subsection*
6093 \begin_layout Description
6094 Action Toggles visibility of a given toolbar between on/off/auto.
6097 \begin_layout Description
6098 Notion Skipping "auto" when allowauto is false.
6101 \begin_layout Description
6102 Syntax toolbar-toggle <NAME> [allowauto]
6105 \begin_layout Description
6106 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6107 \begin_inset Newline newline
6110 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6113 \begin_layout Description
6114 Origin Edwin, 21 May 2007
6117 \begin_layout Subsection*
6121 \begin_layout Description
6122 Action Various UI visibility-toggling actions.
6125 \begin_layout Description
6126 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6129 \begin_layout Description
6130 Params statusbar : Toggle visibility of the statusbar.
6131 \begin_inset Newline newline
6134 menubar : Toggle visibility of the menubar.
6135 \begin_inset Newline newline
6138 scrollbar : Toggle visibility of the scrollbar.
6139 \begin_inset Newline newline
6142 frame : Toggle visibility of the frames around editing window.
6143 \begin_inset Newline newline
6146 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.
6149 \begin_layout Description
6150 Origin sanda, 9 Feb 2007
6153 \begin_layout Subsection*
6157 \begin_layout Description
6158 Action Close the current document work area.
6161 \begin_layout Description
6162 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6165 \begin_layout Description
6169 \begin_layout Description
6170 Origin Tommaso, 15 Sep 2012
6173 \begin_layout Subsection*
6177 \begin_layout Description
6178 Action Creates another split view of current buffer.
6181 \begin_layout Description
6182 Notion All split views act in the same way independently.
6185 \begin_layout Description
6186 Syntax view-split <vertical|horizontal>
6189 \begin_layout Description
6190 Params horizontal : The work areas are laid out side by side.
6191 \begin_inset Newline newline
6194 vertical : The work areas laid out vertically.
6197 \begin_layout Description
6198 Origin Abdel, 20 Feb 2008
6201 \begin_layout Subsection*
6205 \begin_layout Description
6206 Action Closes the current LyX window.
6209 \begin_layout Description
6213 \begin_layout Description
6214 Origin Abdel, 23 Oct 2006
6217 \begin_layout Subsection*
6221 \begin_layout Description
6222 Action Creates new empty LyX window.
6225 \begin_layout Description
6226 Notion Already opened documents from the previous window can be found under View menu.
6229 \begin_layout Description
6230 Syntax window-new [<GEOMETRY>]
6233 \begin_layout Description
6234 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6237 \begin_layout Description
6238 Origin Abdel, 21 Oct 2006
6241 \begin_layout Section
6242 System Functions (Preferences, LyX Server etc.)
6245 \begin_layout Subsection*
6246 buffer-toggle-output-sync
6249 \begin_layout Description
6250 Action Toggles including of resources for forward/reverse search of the given document.
6253 \begin_layout Description
6254 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6257 \begin_layout Description
6258 Syntax buffer-toggle-output-sync
6261 \begin_layout Description
6262 Origin sanda, 25 May 2010
6265 \begin_layout Subsection*
6269 \begin_layout Description
6270 Action Executes a command defined in a .def file.
6273 \begin_layout Description
6274 Notion The definitions are by default read from lib/commands/default.def.
6275 \begin_inset Newline newline
6278 A .def file allows to define a command with
6280 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).
6282 def_file "FileName" allows to include another .def file.
6283 \begin_inset Newline newline
6286 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.
6289 \begin_layout Description
6293 \begin_layout Description
6294 Params <NAME>: Name of the command that must be called.
6297 \begin_layout Description
6298 Origin broider, 2 Oct 2007
6301 \begin_layout Subsection*
6305 \begin_layout Description
6306 Action Cancels sequence prepared by LFUN_META_PREFIX .
6309 \begin_layout Description
6313 \begin_layout Subsection*
6314 command-alternatives
6317 \begin_layout Description
6318 Action Runs the first listed command that is enabled.
6321 \begin_layout Description
6322 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6325 \begin_layout Description
6326 Syntax command-alternatives <CMDS>
6329 \begin_layout Description
6330 Params <CMDS>: Sequence of commands separated by semicolons.
6333 \begin_layout Description
6334 Sample command-alternatives completion-accept;cell-forward
6337 \begin_layout Description
6338 Origin rgh, 24 September 2008
6341 \begin_layout Subsection*
6345 \begin_layout Description
6346 Action Run more commands (LFUN and its parameters) in a sequence.
6349 \begin_layout Description
6350 Syntax command-sequence <CMDS>
6353 \begin_layout Description
6354 Params <CMDS>: Sequence of commands separated by semicolons.
6357 \begin_layout Description
6358 Sample command-sequence cut; ert-insert; self-insert
6360 ; paste; self-insert {}; inset-toggle;
6363 \begin_layout Description
6364 Origin Andre, 11 Nov 1999
6367 \begin_layout Subsection*
6368 cursor-follows-scrollbar-toggle
6371 \begin_layout Description
6372 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6375 \begin_layout Description
6376 Syntax toggle-cursor-follows-scrollbar
6379 \begin_layout Description
6380 Origin ARRae, 2 Dec 1997
6383 \begin_layout Subsection*
6387 \begin_layout Description
6388 Action Set debug output level.
6391 \begin_layout Description
6392 Syntax debug-level-set <LEVEL>
6395 \begin_layout Description
6396 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.
6399 \begin_layout Description
6400 Origin sanda, 28 Dec 2009
6403 \begin_layout Subsection*
6407 \begin_layout Description
6408 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6411 \begin_layout Description
6412 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6415 \begin_layout Description
6416 Syntax forward-search
6419 \begin_layout Description
6420 Origin sanda, 14 Apr 2010
6423 \begin_layout Subsection*
6427 \begin_layout Description
6428 Action Apply the given settings to user preferences.
6431 \begin_layout Description
6432 Syntax lyxrc-apply <SETTINGS>
6435 \begin_layout Description
6436 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.
6439 \begin_layout Subsection*
6443 \begin_layout Description
6444 Action Shows message in statusbar (for script purposes).
6447 \begin_layout Description
6448 Syntax message <STRING>
6451 \begin_layout Description
6452 Origin Lgb, 8 Apr 2001
6455 \begin_layout Subsection*
6459 \begin_layout Description
6460 Action Simulate halting Meta key (Alt key on PCs).
6463 \begin_layout Description
6464 Notion Used for buffer edition not for GUI control.
6467 \begin_layout Description
6471 \begin_layout Subsection*
6475 \begin_layout Description
6476 Action Save user preferences.
6479 \begin_layout Description
6480 Syntax preferences-save
6483 \begin_layout Description
6484 Origin Lgb, 27 Nov 1999
6487 \begin_layout Subsection*
6491 \begin_layout Description
6492 Action Reconfigure the automatic settings.
6495 \begin_layout Description
6499 \begin_layout Description
6500 Origin Asger, 14 Feb 1997
6503 \begin_layout Subsection*
6507 \begin_layout Description
6508 Action Returns path and file name of the currently edited document.
6511 \begin_layout Description
6512 Syntax server-get-filename
6515 \begin_layout Subsection*
6519 \begin_layout Description
6520 Action Returns the current layout (that is environment) name on the cursor position.
6523 \begin_layout Description
6524 Syntax server-get-layout
6527 \begin_layout Subsection*
6528 server-get-statistics
6531 \begin_layout Description
6532 Action Returns the statistics (number of words and characters) in the document or in the given selection.
6535 \begin_layout Description
6536 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6539 \begin_layout Description
6540 Syntax server-get-statistics [<TYPE>]
6543 \begin_layout Description
6544 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
6545 \begin_inset Newline newline
6549 \begin_inset Newline newline
6552 chars: count characters.
6553 \begin_inset Newline newline
6556 chars-space: count characters and spaces.
6559 \begin_layout Description
6560 Origin brokenclock, Oct 10 2014
6563 \begin_layout Subsection*
6567 \begin_layout Description
6568 Action Returns the coordinates of cursor position in the editing area.
6571 \begin_layout Description
6572 Syntax server-get-xy
6575 \begin_layout Subsection*
6576 server-goto-file-row
6579 \begin_layout Description
6580 Action Sets the cursor position in LyX based on the row number of generated TeX file.
6583 \begin_layout Description
6584 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).
6587 \begin_layout Description
6588 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
6591 \begin_layout Description
6592 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.
6593 \begin_inset Newline newline
6596 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).
6597 \begin_inset Newline newline
6600 .ext: extensions will be automatically replaced by .lyx.
6601 \begin_inset Newline newline
6604 <ROW_NUMBER> The row number of the LaTeX file to which to go.
6607 \begin_layout Description
6608 Sample server-goto-file-row /home/user/example.lyx 41
6609 \begin_inset Newline newline
6612 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
6615 \begin_layout Description
6616 Origin Edmar, 23 Dec 1998
6619 \begin_layout Subsection*
6623 \begin_layout Description
6624 Action Sends notify message about the last key-sequence to client.
6627 \begin_layout Description
6628 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
6631 \begin_layout Description
6632 Syntax server-notify
6635 \begin_layout Subsection*
6639 \begin_layout Description
6640 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
6643 \begin_layout Description
6644 Syntax server-set-xy <X> <Y>
6647 \begin_layout Subsection*
6651 \begin_layout Description
6652 Action Set the given LyX color to the color defined by the X11 name given.
6655 \begin_layout Description
6656 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
6659 \begin_layout Description
6660 Syntax set-color <LYX_NAME> <X11_NAME>
6663 \begin_layout Description
6664 Origin SLior, 11 Jun 2000
6667 \begin_layout Subsection*
6671 \begin_layout Description
6672 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
6675 \begin_layout Description
6676 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6679 \begin_layout Description
6683 \begin_layout Description
6684 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6687 \begin_layout Subsection*
6691 \begin_layout Description
6692 Action Checks-in/commits the changes of the registered file to the repository.
6695 \begin_layout Description
6696 Notion In RCS case this also unlocks the file.
6699 \begin_layout Description
6703 \begin_layout Description
6704 Origin Lgb, 1 Jul 1997
6707 \begin_layout Subsection*
6711 \begin_layout Description
6712 Action Checks-out the document for edit (and locks it in some cases).
6715 \begin_layout Description
6719 \begin_layout Description
6720 Origin Lgb, 1 Jul 1997
6723 \begin_layout Subsection*
6727 \begin_layout Description
6728 Action Executes external command. This command is intended to support additional VCS commands.
6731 \begin_layout Description
6732 Syntax vc-command <FLAG> <PATH> <COMMAND>
6735 \begin_layout Description
6736 Params <FLAG>: Flags for the command can be combined together.
6737 \begin_inset Newline newline
6740 U - dUmmy - no flags
6741 \begin_inset Newline newline
6744 D - Doc - need document loaded to proceed
6745 \begin_inset Newline newline
6748 I - dIrty - mark document dirty
6749 \begin_inset Newline newline
6752 R - Reload - ensure that the document is saved and reload it after command execution
6753 \begin_inset Newline newline
6756 M - Message - ask for input string (commit message)
6757 \begin_inset Newline newline
6760 <PATH>: path where to start. $$p will be replaced by the current document path.
6761 \begin_inset Newline newline
6764 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
6767 \begin_layout Description
6768 Sample vc-command DR $$p "svn up"
6771 \begin_layout Description
6772 Origin sanda, 13 Jan 2009
6775 \begin_layout Subsection*
6779 \begin_layout Description
6780 Action Compares two revisions of the same file under version control.
6783 \begin_layout Description
6784 Syntax vc-compare [<REV1>] [<REV2>]
6787 \begin_layout Description
6788 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
6789 \begin_inset Newline newline
6792 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
6793 \begin_inset Newline newline
6797 \begin_inset Newline newline
6800 <REV2>: Newer file. Used only if REV1 > 0.
6801 \begin_inset Newline newline
6804 If no parameter is given, interactive dialog will be shown.
6807 \begin_layout Description
6808 Sample Compare current document against last commit
6809 \begin_inset Newline newline
6813 \begin_inset Newline newline
6816 Compare current document against current revision - 5 commits
6817 \begin_inset Newline newline
6821 \begin_inset Newline newline
6824 Compare revisions 120 and 155
6825 \begin_inset Newline newline
6831 \begin_layout Description
6832 Origin sanda, 12 Feb 2010
6835 \begin_layout Subsection*
6839 \begin_layout Description
6840 Action Copies the document to another name.
6843 \begin_layout Description
6844 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.
6847 \begin_layout Description
6848 Syntax vc-copy <FILENAME>
6851 \begin_layout Description
6852 Params <FILENAME>: New name of the document.
6853 \begin_inset Newline newline
6856 A file dialog is opened if no filename is given.
6859 \begin_layout Description
6860 Origin gb, 05 Feb 2013
6863 \begin_layout Subsection*
6867 \begin_layout Description
6868 Action Toggles the locking property of the edited file.
6871 \begin_layout Description
6872 Notion This is currently implemented only for SVN.
6875 \begin_layout Description
6876 Syntax vc-locking-toggle
6879 \begin_layout Description
6880 Origin sanda, 25 Jun 2009
6883 \begin_layout Subsection*
6887 \begin_layout Description
6888 Action Register the document as an file inside version control system.
6891 \begin_layout Description
6892 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
6893 \begin_inset Newline newline
6896 See LyX Additional Features Manual (Version Control Chapter) for additional information.
6899 \begin_layout Description
6903 \begin_layout Description
6904 Origin Lgb, 1 Jul 1997
6907 \begin_layout Subsection*
6911 \begin_layout Description
6912 Action Renames the document to another name.
6915 \begin_layout Description
6916 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.
6919 \begin_layout Description
6920 Syntax vc-rename <FILENAME>
6923 \begin_layout Description
6924 Params <FILENAME>: New name of the document.
6925 \begin_inset Newline newline
6928 A file dialog is opened if no filename is given.
6931 \begin_layout Description
6932 Origin gb, 05 Feb 2013
6935 \begin_layout Subsection*
6939 \begin_layout Description
6940 Action Update the local archive directory in which resides the current document with the remote repository.
6943 \begin_layout Description
6944 Syntax vc-repo-update
6947 \begin_layout Description
6948 Origin sanda, 16 Oct 2009
6951 \begin_layout Subsection*
6955 \begin_layout Description
6956 Action Reverts the document to the last check-in/commit in VCS.
6959 \begin_layout Description
6963 \begin_layout Description
6964 Origin Lgb, 1 Jul 1997
6967 \begin_layout Subsection*
6971 \begin_layout Description
6972 Action Undo last check-in.
6975 \begin_layout Description
6976 Notion This is currently implemented only for RCS.
6979 \begin_layout Description
6983 \begin_layout Description
6984 Origin Lgb, 1 Jul 1997
6987 \begin_layout Section
6988 Hidden Functions (not listed for configuration)
6991 \begin_layout Subsection*
6995 \begin_layout Description
6996 Action Return the current key sequence and available options as a string.
6999 \begin_layout Description
7000 Notion No options are added if no current map exists.
7001 \begin_inset Newline newline
7004 This is probably usable only with connection to lyxserver.
7007 \begin_layout Description
7008 Syntax command-prefix
7011 \begin_layout Subsection*
7015 \begin_layout Description
7016 Action Inserts the given string (accordingly to the correct keymap).
7019 \begin_layout Description
7020 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7023 \begin_layout Description
7024 Syntax self-insert <STRING>