1 # gen_lfuns.py generated 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>inset-modify tabular <FEATURE> [<ARG>]
2519 \begin_layout Description
2520 Params Generally see LFUN_INSET_INSERT for further details.
2521 \begin_inset Newline newline
2524 In case that <INSET> is "tabular" various math-environment features are handled as well, e.g. add-vline-left/right for the Grid/Array environment.
2525 \begin_inset Newline newline
2528 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
2529 \begin_inset Newline newline
2532 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
2533 \begin_inset Newline newline
2536 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2537 \begin_inset Newline newline
2540 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2541 \begin_inset Newline newline
2544 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2545 \begin_inset Newline newline
2548 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2549 \begin_inset Newline newline
2552 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2553 \begin_inset Newline newline
2556 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
2557 \begin_inset Newline newline
2560 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2561 \begin_inset Newline newline
2564 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2565 \begin_inset Newline newline
2568 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2569 \begin_inset Newline newline
2572 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2573 \begin_inset Newline newline
2576 set-special-column|set-special-multicolumn|set-special-multirow|
2577 \begin_inset Newline newline
2580 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2581 \begin_inset Newline newline
2584 set-interline-space|set-border-lines|tabular-valign-top|
2585 \begin_inset Newline newline
2588 tabular-valign-middle|tabular-valign-bottom|set-tabular-width <ARG>: additional argument for some commands, use debug mode to explore its values.
2591 \begin_layout Description
2592 Sample inset-modify note Note Comment
2593 \begin_inset Newline newline
2596 inset-modify changetype Ovalbox
2599 \begin_layout Subsection*
2603 \begin_layout Description
2604 Action Select all contents of an inset.
2607 \begin_layout Description
2608 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2611 \begin_layout Description
2612 Syntax inset-select-all
2615 \begin_layout Description
2616 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2619 \begin_layout Subsection*
2623 \begin_layout Description
2624 Action Open the inset's properties dialog.
2627 \begin_layout Description
2628 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.
2631 \begin_layout Description
2632 Syntax inset-settings <INSET>
2635 \begin_layout Description
2636 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2637 \begin_inset Newline newline
2640 graphics|href|include|index|index_print|label|line|
2641 \begin_inset Newline newline
2644 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2647 \begin_layout Subsection*
2651 \begin_layout Description
2652 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2655 \begin_layout Description
2656 Syntax inset-toggle [<ARG>]
2659 \begin_layout Description
2660 Params <ARG>: <open|close|toggle|assign>.
2661 \begin_inset Newline newline
2664 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2665 \begin_inset Newline newline
2668 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2671 \begin_layout Description
2672 Origin lasgouttes, 19 Jul 2001
2675 \begin_layout Subsection*
2679 \begin_layout Description
2680 Action Inserts an IPA inset.
2683 \begin_layout Description
2687 \begin_layout Description
2688 Origin spitz, 05 Mar 2012
2691 \begin_layout Subsection*
2695 \begin_layout Description
2696 Action Inserts special IPA macros into the document.
2699 \begin_layout Description
2700 Syntax ipamacro-insert <CHAR>
2703 \begin_layout Description
2704 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2707 \begin_layout Description
2708 Origin JSpitzm, 22 Aug 2012
2711 \begin_layout Subsection*
2715 \begin_layout Description
2716 Action Turn off the loaded keyboard map.
2719 \begin_layout Description
2723 \begin_layout Subsection*
2727 \begin_layout Description
2728 Action Turn on the primary keyboard map.
2731 \begin_layout Description
2732 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.
2733 \begin_inset Newline newline
2736 The language is to be set in the Preferences dialog.
2739 \begin_layout Description
2740 Syntax keymap-primary
2743 \begin_layout Subsection*
2747 \begin_layout Description
2748 Action Turn on the secondary keyboard map.
2751 \begin_layout Description
2752 Syntax keymap-secondary
2755 \begin_layout Subsection*
2759 \begin_layout Description
2760 Action Toggles keyboard maps (first/second/off).
2763 \begin_layout Description
2764 Syntax keymap-toggle
2767 \begin_layout Description
2768 Origin leeming, 30 Mar 2004
2771 \begin_layout Subsection*
2772 label-copy-as-reference
2775 \begin_layout Description
2776 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2779 \begin_layout Description
2780 Syntax copy-label-as-reference <LABEL>
2783 \begin_layout Description
2784 Params <LABEL>: The label to copy (for multi-line math)
2787 \begin_layout Description
2788 Origin sts, 16 Nov 2008
2791 \begin_layout Subsection*
2795 \begin_layout Description
2796 Action Goto a label.
2799 \begin_layout Description
2800 Syntax label-goto [<LABEL>]
2803 \begin_layout Description
2804 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.
2807 \begin_layout Description
2808 Origin Ale, 6 Aug 1997
2811 \begin_layout Subsection*
2815 \begin_layout Description
2816 Action Inserts label to text or displayed formula.
2819 \begin_layout Description
2820 Syntax label-insert [<LABEL>]
2823 \begin_layout Description
2824 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2827 \begin_layout Subsection*
2828 label-insert-as-reference
2831 \begin_layout Description
2832 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2835 \begin_layout Description
2836 Syntax label-insert-as-reference
2839 \begin_layout Description
2840 Origin vfr, 7 Apr 2009
2843 \begin_layout Subsection*
2847 \begin_layout Description
2848 Action Set language from the current cursor position.
2851 \begin_layout Description
2852 Syntax language <LANG> [set]
2855 \begin_layout Description
2856 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).
2859 \begin_layout Description
2860 Origin Dekel, 2 Mar 2000
2863 \begin_layout Subsection*
2867 \begin_layout Description
2868 Action Move the cursor to the beginning of the (screen) line.
2871 \begin_layout Description
2875 \begin_layout Subsection*
2879 \begin_layout Description
2880 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2883 \begin_layout Description
2884 Syntax line-begin-select
2887 \begin_layout Subsection*
2891 \begin_layout Description
2892 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2895 \begin_layout Description
2896 Syntax line-delete-forward
2899 \begin_layout Subsection*
2903 \begin_layout Description
2904 Action Move the cursor to the end of the (screen) line.
2907 \begin_layout Description
2911 \begin_layout Subsection*
2915 \begin_layout Description
2916 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2919 \begin_layout Description
2920 Syntax line-end-select
2923 \begin_layout Subsection*
2927 \begin_layout Description
2928 Action Inserts a new listings inset.
2931 \begin_layout Description
2932 Syntax listing-insert
2935 \begin_layout Description
2936 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2939 \begin_layout Subsection*
2943 \begin_layout Description
2944 Action Inserts a marginal note.
2947 \begin_layout Description
2948 Syntax marginalnote-insert
2951 \begin_layout Description
2952 Origin Lgb, 26 Jun 2000
2955 \begin_layout Subsection*
2959 \begin_layout Description
2960 Action Disable selecting of text-region.
2963 \begin_layout Description
2967 \begin_layout Subsection*
2971 \begin_layout Description
2972 Action Enable selecting of text-region.
2975 \begin_layout Description
2976 Notion After enabling you can simply move arrow keys to get selected region.
2979 \begin_layout Description
2983 \begin_layout Subsection*
2987 \begin_layout Description
2988 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2991 \begin_layout Description
2995 \begin_layout Description
2996 Origin Andre, May 5 2006
2999 \begin_layout Subsection*
3003 \begin_layout Description
3004 Action Inserts a line break or new line.
3007 \begin_layout Description
3008 Syntax newline-insert [<ARG>]
3011 \begin_layout Description
3012 Params <ARG>: <newline|linebreak> default: newline
3015 \begin_layout Description
3016 Origin JSpitzm, 25 Mar 2008
3019 \begin_layout Subsection*
3023 \begin_layout Description
3024 Action Inserts a new page.
3027 \begin_layout Description
3028 Syntax newpage-insert <ARG>
3031 \begin_layout Description
3032 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3035 \begin_layout Description
3036 Origin uwestoehr, 24 Nov 2007
3039 \begin_layout Subsection*
3043 \begin_layout Description
3044 Action Inserts Nomenclature entry.
3047 \begin_layout Description
3048 Notion It automatically takes the word on the cursor position if no symbol is given.
3051 \begin_layout Description
3052 Syntax nomencl-insert [<SYMBOL>]
3055 \begin_layout Description
3056 Origin Ugras, 4 Nov 2006
3059 \begin_layout Subsection*
3063 \begin_layout Description
3064 Action Inserts list of Nomenclature entries.
3067 \begin_layout Description
3068 Syntax nomenclature-print
3071 \begin_layout Description
3072 Origin Ugras, 4 Nov 2006
3075 \begin_layout Subsection*
3079 \begin_layout Description
3080 Action Inserts Note on the current cursor position, move selection inside the inset.
3083 \begin_layout Description
3084 Syntax note-insert [<TYPE>]
3087 \begin_layout Description
3088 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3091 \begin_layout Subsection*
3095 \begin_layout Description
3096 Action Moves the cursor to the beginning of next Note inset.
3099 \begin_layout Description
3103 \begin_layout Subsection*
3107 \begin_layout Description
3108 Action Move the current group in the downward direction in the structure of the document.
3111 \begin_layout Description
3112 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3115 \begin_layout Description
3119 \begin_layout Description
3120 Origin Vermeer, 23 Mar 2006
3123 \begin_layout Subsection*
3127 \begin_layout Description
3128 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3131 \begin_layout Description
3132 Notion Part -> Chapter -> Section -> etc.
3135 \begin_layout Description
3139 \begin_layout Description
3140 Origin Vermeer, 23 Mar 2006
3143 \begin_layout Subsection*
3147 \begin_layout Description
3148 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3151 \begin_layout Description
3152 Notion Part <- Chapter <- Section <- etc.
3155 \begin_layout Description
3159 \begin_layout Description
3160 Origin Vermeer, 23 Mar 2006
3163 \begin_layout Subsection*
3167 \begin_layout Description
3168 Action Move the current group in the upward direction in the structure of the document.
3171 \begin_layout Description
3172 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3175 \begin_layout Description
3179 \begin_layout Description
3180 Origin Vermeer, 23 Mar 2006
3183 \begin_layout Subsection*
3187 \begin_layout Description
3188 Action Breaks the current paragraph at the current location.
3191 \begin_layout Description
3192 Notion Removes the selection.
3195 \begin_layout Description
3196 Syntax paragraph-break [<LAYOUT>]
3199 \begin_layout Description
3200 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3203 \begin_layout Subsection*
3207 \begin_layout Description
3208 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3211 \begin_layout Description
3212 Syntax paragraph-down
3215 \begin_layout Description
3216 Origin Asger, 1 Oct 1996
3219 \begin_layout Subsection*
3220 paragraph-down-select
3223 \begin_layout Description
3224 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3227 \begin_layout Description
3228 Syntax paragraph-down-select
3231 \begin_layout Description
3232 Origin Asger, 1 Oct 1996
3235 \begin_layout Subsection*
3239 \begin_layout Description
3240 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
3243 \begin_layout Description
3244 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).
3247 \begin_layout Description
3248 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3251 \begin_layout Description
3252 Params <PAR_ID_NUMBER>: paragraph id
3253 \begin_inset Newline newline
3256 <POSITION_IN_PAR>: desired position within the paragraph
3259 \begin_layout Description
3260 Origin Dekel, 26 Aug 2000
3263 \begin_layout Subsection*
3267 \begin_layout Description
3268 Action Moves the current paragraph downwards in the document.
3271 \begin_layout Description
3272 Syntax paragraph-move-down
3275 \begin_layout Description
3276 Origin Edwin, 8 Apr 2006
3279 \begin_layout Subsection*
3283 \begin_layout Description
3284 Action Moves the current paragraph upwards in the document.
3287 \begin_layout Description
3288 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3291 \begin_layout Description
3292 Syntax paragraph-move-up
3295 \begin_layout Description
3296 Origin Edwin, 8 Apr 2006
3299 \begin_layout Subsection*
3303 \begin_layout Description
3304 Action Change paragraph settings.
3307 \begin_layout Description
3308 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.
3311 \begin_layout Description
3312 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3315 \begin_layout Description
3325 \begin_inset Newline newline
3330 paragraph_spacing default|single|onehalf|double|other SIZE
3331 \begin_inset Newline newline
3336 align block|left|right|center|default
3337 \begin_inset Newline newline
3342 labelwidthstring WIDTH|
3347 \begin_layout Description
3348 Origin rgh, Aug 15 2007
3351 \begin_layout Subsection*
3352 paragraph-params-apply
3355 \begin_layout Description
3356 Action Change paragraph settings.
3359 \begin_layout Description
3360 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3363 \begin_layout Description
3364 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3367 \begin_layout Description
3368 Params For parameters see LFUN_PARAGRAPH_PARAMS
3371 \begin_layout Description
3372 Origin leeming, 30 Mar 2004
3375 \begin_layout Subsection*
3379 \begin_layout Description
3380 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3383 \begin_layout Description
3387 \begin_layout Description
3388 Origin Asger, 1 Oct 1996
3391 \begin_layout Subsection*
3395 \begin_layout Description
3396 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3399 \begin_layout Description
3400 Syntax paragraph-up-select
3403 \begin_layout Description
3404 Origin Asger, 1 Oct 1996
3407 \begin_layout Subsection*
3411 \begin_layout Description
3412 Action Pastes material (text or picture) from the active clipboard.
3415 \begin_layout Description
3416 Syntax paste [<TYPE>|<NUM>]
3419 \begin_layout Description
3420 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3421 \begin_inset Newline newline
3424 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3427 \begin_layout Subsection*
3431 \begin_layout Description
3432 Action Inserts phantom on the current cursor position, move selection inside the inset.
3435 \begin_layout Description
3436 Syntax phantom-insert [<TYPE>]
3439 \begin_layout Description
3440 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3443 \begin_layout Description
3444 Origin uwestoehr, 30 Jan 2009
3447 \begin_layout Subsection*
3451 \begin_layout Description
3452 Action Inserts a new preview inset.
3455 \begin_layout Description
3456 Syntax preview-insert
3459 \begin_layout Description
3460 Origin vfr, 28 Mar 2010
3463 \begin_layout Subsection*
3464 primary-selection-paste
3467 \begin_layout Description
3468 Action Pastes the currently selected text.
3471 \begin_layout Description
3472 Notion Primary selection mechanism is linux-only thing.
3475 \begin_layout Description
3476 Syntax primary-selection-paste [<ARG>]
3479 \begin_layout Description
3480 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3483 \begin_layout Subsection*
3487 \begin_layout Description
3488 Action Inserts quotes according to the type and quote-language preference.
3491 \begin_layout Description
3492 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
3495 \begin_layout Description
3496 Syntax quote-insert [<TYPE>]
3499 \begin_layout Description
3500 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
3503 \begin_layout Subsection*
3507 \begin_layout Description
3508 Action Redoes the last thing undone.
3511 \begin_layout Description
3515 \begin_layout Subsection*
3519 \begin_layout Description
3520 Action Go to the next label or cross-reference.
3523 \begin_layout Description
3524 Syntax reference-next
3527 \begin_layout Description
3528 Origin Dekel, 14 Jan 2001
3531 \begin_layout Subsection*
3535 \begin_layout Description
3536 Action Repeat the given command.
3539 \begin_layout Description
3540 Syntax repeat <COUNT> <LFUN-COMMAND>
3543 \begin_layout Description
3544 Origin Andre, 27 Oct 2003
3547 \begin_layout Subsection*
3551 \begin_layout Description
3552 Action Moves the cursor one page in downward direction.
3555 \begin_layout Description
3559 \begin_layout Subsection*
3563 \begin_layout Description
3564 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3567 \begin_layout Description
3568 Syntax screen-down-select
3571 \begin_layout Subsection*
3575 \begin_layout Description
3576 Action Recenters the screen on the current cursor position.
3579 \begin_layout Description
3580 Syntax screen-recenter
3583 \begin_layout Subsection*
3587 \begin_layout Description
3588 Action Repositions the screen such that the cursor is visible.
3591 \begin_layout Description
3592 Syntax screen-show-cursor
3595 \begin_layout Description
3596 Origin vfr, 25 Mar 2009
3599 \begin_layout Subsection*
3603 \begin_layout Description
3604 Action Moves the cursor one page in upward direction.
3607 \begin_layout Description
3611 \begin_layout Subsection*
3615 \begin_layout Description
3616 Action Moves the cursor one page in upward direction adding the current position to the selection.
3619 \begin_layout Description
3620 Syntax screen-up-select
3623 \begin_layout Subsection*
3627 \begin_layout Description
3628 Action Inserts a subscript or superscript inset.
3631 \begin_layout Description
3632 Syntax script-insert <TYPE>
3635 \begin_layout Description
3636 Params <TYPE>: subscript|superscript
3639 \begin_layout Description
3640 Origin Georg, 23 Nov 2010
3643 \begin_layout Subsection*
3647 \begin_layout Description
3648 Action Scroll the buffer view.
3651 \begin_layout Description
3652 Notion Only scrolls the screen up or down; does not move the cursor.
3655 \begin_layout Description
3656 Syntax scroll <TYPE> <QUANTITY>
3659 \begin_layout Description
3660 Params <TYPE>: line|page
3661 \begin_inset Newline newline
3664 <QUANTITY>: up|down|<number>
3667 \begin_layout Description
3668 Origin Abdel, Dec 27 2007
3671 \begin_layout Subsection*
3675 \begin_layout Description
3676 Action Select the whole section.
3679 \begin_layout Description
3680 Notion The cursor should be in a section heading before calling this lfun.
3683 \begin_layout Description
3684 Syntax section-select
3687 \begin_layout Description
3688 Origin vfr, 05 May 2009
3691 \begin_layout Subsection*
3695 \begin_layout Description
3696 Action Pastes the internal selection text in permanent selection.
3699 \begin_layout Description
3700 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3703 \begin_layout Description
3704 Syntax selection-paste
3707 \begin_layout Description
3708 Origin lasgouttes, 14 Jan 2009
3711 \begin_layout Subsection*
3715 \begin_layout Description
3716 Action Inserts an environment separator or paragraph break.
3719 \begin_layout Description
3720 Syntax separator-insert [<ARG>]
3723 \begin_layout Description
3724 Params <ARG>: <plain|parbreak> default: plain
3727 \begin_layout Description
3728 Origin ef, 2 May 2014
3731 \begin_layout Subsection*
3735 \begin_layout Description
3736 Action Set the group for the graphics inset on the cursor position.
3739 \begin_layout Description
3740 Syntax set-graphics-group [<GROUP>]
3743 \begin_layout Description
3744 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3747 \begin_layout Description
3748 Origin sanda, 6 May 2008
3751 \begin_layout Subsection*
3755 \begin_layout Description
3756 Action Inserts one of horizontal space insets.
3759 \begin_layout Description
3760 Syntax space-insert <NAME> [<LEN>]
3763 \begin_layout Description
3764 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3765 \begin_inset Newline newline
3768 Only in math mode: med and thick.
3769 \begin_inset Newline newline
3772 <LEN>: length for custom spaces (hspace, hspace* for protected)
3775 \begin_layout Description
3776 Origin JSpitzm, 20 May 2003, Mar 17 2008
3779 \begin_layout Subsection*
3783 \begin_layout Description
3784 Action Inserts various characters into the document.
3787 \begin_layout Description
3788 Syntax specialchar-insert <CHAR>
3791 \begin_layout Description
3792 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3795 \begin_layout Description
3796 Origin JSpitzm, 6 Dec 2007
3799 \begin_layout Subsection*
3803 \begin_layout Description
3804 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3807 \begin_layout Description
3808 Syntax spelling-add [<STRING>] [<LANG>]
3811 \begin_layout Description
3812 Params <WORD>: word to add <LANG>: language name (see file languages)
3815 \begin_layout Description
3816 Origin JSpitzm, 18 Jan 2010
3819 \begin_layout Subsection*
3820 spelling-continuously
3823 \begin_layout Description
3824 Action Toggle continuous spell checking.
3827 \begin_layout Description
3828 Syntax spelling-continuously
3831 \begin_layout Description
3832 Origin vfr, 24 March 2013
3835 \begin_layout Subsection*
3839 \begin_layout Description
3840 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.
3843 \begin_layout Description
3844 Syntax spelling-ignore [<WORD>] [<LANG>]
3847 \begin_layout Description
3848 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3851 \begin_layout Description
3852 Origin JSpitzm, 18 Jan 2010
3855 \begin_layout Subsection*
3859 \begin_layout Description
3860 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3863 \begin_layout Description
3864 Syntax spelling-remove [<STRING>] [<LANG>]
3867 \begin_layout Description
3868 Params <WORD>: word to remove <LANG>: language name (see file languages)
3871 \begin_layout Description
3872 Origin SWitt, 28 July 2010
3875 \begin_layout Subsection*
3879 \begin_layout Description
3880 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3883 \begin_layout Description
3884 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.
3887 \begin_layout Description
3891 \begin_layout Description
3892 Origin vfr, Sep 30 2008
3895 \begin_layout Subsection*
3899 \begin_layout Description
3900 Action Insert a tab into a listings inset.
3903 \begin_layout Description
3904 Notion It also works on a selection.
3907 \begin_layout Description
3911 \begin_layout Description
3912 Origin vfr, Sep 30 2008
3915 \begin_layout Subsection*
3919 \begin_layout Description
3920 Action Inserts table into the document.
3923 \begin_layout Description
3924 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3927 \begin_layout Description
3928 Syntax tabular-insert [<ROWS> <COLUMNS>]
3931 \begin_layout Description
3932 Params In case no arguments are given show insert dialog.
3935 \begin_layout Description
3936 Origin Jug, 12 Apr 2000
3939 \begin_layout Subsection*
3943 \begin_layout Description
3944 Action Look up thesaurus entries with respect to the word under the cursor.
3947 \begin_layout Description
3948 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
3951 \begin_layout Description
3952 Params <STRING>: word to look up <LANG>: language (see file languages)
3955 \begin_layout Description
3956 Origin Levon, 20 Jul 2001
3959 \begin_layout Subsection*
3963 \begin_layout Description
3964 Action Undoes the last edit.
3967 \begin_layout Description
3971 \begin_layout Subsection*
3975 \begin_layout Description
3976 Action Inserts a single unicode character.
3979 \begin_layout Description
3980 Syntax unicode-insert <CHAR>
3983 \begin_layout Description
3984 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
3987 \begin_layout Description
3988 Sample unicode-insert 0x0100
3991 \begin_layout Description
3992 Origin Lgb, 22 Oct 2006
3995 \begin_layout Subsection*
3999 \begin_layout Description
4000 Action Moves the cursor one line in upward direction.
4003 \begin_layout Description
4007 \begin_layout Subsection*
4011 \begin_layout Description
4012 Action Moves the cursor one line in upward direction adding the current position to the selection.
4015 \begin_layout Description
4019 \begin_layout Subsection*
4023 \begin_layout Description
4024 Action Moves the cursor to the logically previous beginning of a word.
4027 \begin_layout Description
4028 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.
4031 \begin_layout Description
4032 Syntax word-backward
4035 \begin_layout Subsection*
4036 word-backward-select
4039 \begin_layout Description
4040 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4043 \begin_layout Description
4044 Notion See also LFUN_WORD_BACKWARD.
4047 \begin_layout Description
4048 Syntax word-backward-select
4051 \begin_layout Subsection*
4055 \begin_layout Description
4056 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4059 \begin_layout Description
4060 Syntax word-capitalize [<SEL_TYPE>]
4063 \begin_layout Description
4064 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.
4067 \begin_layout Subsection*
4068 word-delete-backward
4071 \begin_layout Description
4072 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4075 \begin_layout Description
4076 Syntax word-delete-backward
4079 \begin_layout Subsection*
4083 \begin_layout Description
4084 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4087 \begin_layout Description
4088 Syntax word-delete-forward
4091 \begin_layout Subsection*
4095 \begin_layout Description
4096 Action Search for next occurrence of a string.
4099 \begin_layout Description
4100 Syntax word-find [<DATA>]
4103 \begin_layout Description
4104 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).
4107 \begin_layout Description
4108 Origin Andre, Jan 7 2004
4111 \begin_layout Subsection*
4115 \begin_layout Description
4116 Action Search for a given string in backward direction.
4119 \begin_layout Description
4120 Notion Case sensitive, match words. If no argument given, last search repeated.
4123 \begin_layout Description
4124 Syntax word-find-backward [<STRING>]
4127 \begin_layout Description
4128 Origin Etienne, 20 Feb 1998
4131 \begin_layout Subsection*
4135 \begin_layout Description
4136 Action Search for a given string in forward direction.
4139 \begin_layout Description
4140 Notion Case sensitive, match words. If no argument given, last search repeated.
4143 \begin_layout Description
4144 Syntax word-find-forward [<STRING>]
4147 \begin_layout Description
4148 Origin Etienne, 16 Feb 1998
4151 \begin_layout Subsection*
4155 \begin_layout Description
4156 Action Search for next occurrence of a pattern.
4159 \begin_layout Description
4160 Syntax word-findadv [<DATA>]
4163 \begin_layout Description
4164 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).
4167 \begin_layout Description
4168 Origin Tommaso, Nov 15 2007
4171 \begin_layout Subsection*
4175 \begin_layout Description
4176 Action Moves the cursor to the logically next beginning of a word.
4179 \begin_layout Description
4180 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.
4183 \begin_layout Description
4187 \begin_layout Subsection*
4191 \begin_layout Description
4192 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4195 \begin_layout Description
4196 Notion See also LFUN_WORD_FORWARD.
4199 \begin_layout Description
4200 Syntax word-forward-select
4203 \begin_layout Subsection*
4207 \begin_layout Description
4208 Action Moves the cursor to the next beginning of a word "on the left".
4211 \begin_layout Description
4212 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.
4215 \begin_layout Description
4219 \begin_layout Description
4220 Origin dov, 28 Oct 2007
4223 \begin_layout Subsection*
4227 \begin_layout Description
4228 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4231 \begin_layout Description
4232 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4235 \begin_layout Description
4236 Syntax word-left-select
4239 \begin_layout Description
4240 Origin dov, 28 Oct 2007
4243 \begin_layout Subsection*
4247 \begin_layout Description
4248 Action Change the words in the selection or word at cursor position to lower case.
4251 \begin_layout Description
4252 Syntax word-lowcase [<SEL_TYPE>]
4255 \begin_layout Description
4256 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.
4259 \begin_layout Subsection*
4263 \begin_layout Description
4264 Action Replace a string in the document.
4267 \begin_layout Description
4268 Syntax word-replace [<DATA>]
4271 \begin_layout Description
4272 Params <DATA>: data is of the form "<replace>
4273 \begin_inset Newline newline
4277 \begin_inset Newline newline
4280 <casesensitive> <matchword> <all> <forward> <findnext>"
4283 \begin_layout Description
4284 Origin Andre, Jan 7 2004
4287 \begin_layout Subsection*
4291 \begin_layout Description
4292 Action Moves the cursor to the next beginning of a word "on the right".
4295 \begin_layout Description
4296 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.
4299 \begin_layout Description
4303 \begin_layout Description
4304 Origin dov, 28 Oct 2007
4307 \begin_layout Subsection*
4311 \begin_layout Description
4312 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4315 \begin_layout Description
4316 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4319 \begin_layout Description
4320 Syntax word-right-select
4323 \begin_layout Description
4324 Origin dov, 28 Oct 2007
4327 \begin_layout Subsection*
4331 \begin_layout Description
4332 Action Puts the word where the cursor stands into the selection.
4335 \begin_layout Description
4339 \begin_layout Description
4340 Origin Andre, 11 Sep 2002
4343 \begin_layout Subsection*
4347 \begin_layout Description
4348 Action Change the words in the selection or word at cursor position to upper case.
4351 \begin_layout Description
4352 Syntax word-upcase [<SEL_TYPE>]
4355 \begin_layout Description
4356 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.
4359 \begin_layout Subsection*
4363 \begin_layout Description
4364 Action Inserts floats wrapped by the text around.
4367 \begin_layout Description
4368 Syntax wrap-insert <TYPE>
4371 \begin_layout Description
4372 Params <TYPE>: table|figure
4375 \begin_layout Description
4376 Origin Dekel, 7 Apr 2002
4379 \begin_layout Section
4380 Math Editor Functions
4383 \begin_layout Subsection*
4384 in-mathmacrotemplate
4387 \begin_layout Description
4388 Action Only active in Math Macro definition.
4391 \begin_layout Description
4392 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.
4395 \begin_layout Description
4396 Syntax in-mathmacrotemplate
4399 \begin_layout Description
4400 Origin sts, 06 January 2008
4403 \begin_layout Subsection*
4407 \begin_layout Description
4408 Action Inserts an extended matrix as provided by the amsmath package.
4411 \begin_layout Description
4412 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4415 \begin_layout Description
4416 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'.
4419 \begin_layout Description
4420 Sample math-ams-matrix 3 3 bmatrix
4423 \begin_layout Subsection*
4427 \begin_layout Description
4428 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4431 \begin_layout Description
4432 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4435 \begin_layout Description
4436 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4437 \begin_inset Newline newline
4440 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4443 \begin_layout Description
4444 Sample math-bigdelim "Bigl" "
4451 \begin_layout Description
4452 Origin Enrico & Georg, 7 May 2006
4455 \begin_layout Subsection*
4459 \begin_layout Description
4460 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4463 \begin_layout Description
4464 Syntax math-delim [<LEFT>] [<RIGHT>]
4467 \begin_layout Description
4468 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.
4471 \begin_layout Description
4472 Sample math-delim { rangle
4475 \begin_layout Description
4476 Origin Alejandro, 18 Jun 1996
4479 \begin_layout Subsection*
4483 \begin_layout Description
4484 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4487 \begin_layout Description
4488 Syntax math-display [<ARG>]
4491 \begin_layout Description
4492 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4495 \begin_layout Description
4496 Origin Alejandro, 18 Jun 1996
4499 \begin_layout Subsection*
4503 \begin_layout Description
4504 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4507 \begin_layout Description
4508 Notion Selection can be used to determine the input for the external program.
4511 \begin_layout Description
4512 Syntax math-extern <LANG> [<COMMAND>]
4515 \begin_layout Description
4516 Params <LANG>: octave|maxima|maple|mathematica|script
4517 \begin_inset Newline newline
4520 where "script" stands for the external script (normalized expression will be passed)
4523 \begin_layout Description
4524 Sample math-extern maple simplify
4527 \begin_layout Description
4528 Origin Andre, 24 Apr 2001
4531 \begin_layout Subsection*
4535 \begin_layout Description
4536 Action Changes the text style used in math.
4539 \begin_layout Description
4540 Syntax math-font-style <STYLE>
4543 \begin_layout Description
4544 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4545 \begin_inset Newline newline
4548 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4551 \begin_layout Description
4552 Origin vfr, 9 jan 2009
4555 \begin_layout Subsection*
4559 \begin_layout Description
4560 Action Inserts math objects and symbols.
4563 \begin_layout Description
4564 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4566 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
4568 frac{x}{y}" replaces "abc" with "
4570 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.
4573 \begin_layout Description
4574 Syntax math-insert <ARG>
4577 \begin_layout Description
4578 Params <ARG>: Symbol or LaTeX code to be inserted.
4581 \begin_layout Subsection*
4585 \begin_layout Description
4586 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.
4589 \begin_layout Description
4590 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4593 \begin_layout Description
4594 Syntax math-limits [<STATE>]
4597 \begin_layout Description
4598 Params <STATE>: limits|nolimits
4601 \begin_layout Subsection*
4605 \begin_layout Description
4606 Action Inserts a math macro definition at the cursor position in the text.
4609 \begin_layout Description
4610 Syntax math-macro <NAME> [<NARGS>] [def]
4613 \begin_layout Description
4614 Params <NAME>: The name of the macro, e.g. "mymacro".
4615 \begin_inset Newline newline
4618 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4621 \begin_layout Description
4622 Origin ale, 10 May 1997; sts, 21 Dec 2007
4625 \begin_layout Subsection*
4626 math-macro-add-greedy-optional-param
4629 \begin_layout Description
4630 Action Add a greedy optional parameter.
4633 \begin_layout Description
4634 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4637 \begin_layout Description
4638 Syntax math-macro-add-greedy-optional-param
4641 \begin_layout Description
4642 Origin sts, 06 January 2008
4645 \begin_layout Subsection*
4646 math-macro-add-optional-param
4649 \begin_layout Description
4650 Action Add an optional parameter.
4653 \begin_layout Description
4654 Notion Insert an optional parameter just behind the already existing optional parameters.
4657 \begin_layout Description
4658 Syntax math-macro-add-optional-param
4661 \begin_layout Description
4662 Origin sts, 06 January 2008
4665 \begin_layout Subsection*
4666 math-macro-add-param
4669 \begin_layout Description
4670 Action Add a parameter.
4673 \begin_layout Description
4674 Notion Add a parameter to a Math Macro.
4677 \begin_layout Description
4678 Syntax math-macro-add-param <NUM>
4681 \begin_layout Description
4682 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.
4685 \begin_layout Description
4686 Origin sts, 06 January 2008
4689 \begin_layout Subsection*
4690 math-macro-append-greedy-param
4693 \begin_layout Description
4694 Action Append a greedy parameter.
4697 \begin_layout Description
4698 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
4701 \begin_layout Description
4702 Syntax math-macro-append-greedy-param
4705 \begin_layout Description
4706 Origin sts, 06 January 2008
4709 \begin_layout Subsection*
4713 \begin_layout Description
4714 Action Fold a Math Macro.
4717 \begin_layout Description
4718 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
4723 \begin_layout Description
4724 Syntax math-macro-fold
4727 \begin_layout Description
4728 Origin sts, 06 January 2008
4731 \begin_layout Subsection*
4732 math-macro-make-nonoptional
4735 \begin_layout Description
4736 Action Make a parameter non-optional.
4739 \begin_layout Description
4740 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.
4743 \begin_layout Description
4744 Syntax math-macro-make-nonoptional
4747 \begin_layout Description
4748 Origin sts, 06 January 2008
4751 \begin_layout Subsection*
4752 math-macro-make-optional
4755 \begin_layout Description
4756 Action Make a parameter optional.
4759 \begin_layout Description
4760 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
4763 \begin_layout Description
4764 Syntax math-macro-make-optional
4767 \begin_layout Description
4768 Origin sts, 06 January 2008
4771 \begin_layout Subsection*
4772 math-macro-remove-greedy-param
4775 \begin_layout Description
4776 Action Remove a greedy parameter.
4779 \begin_layout Description
4780 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.
4783 \begin_layout Description
4784 Syntax math-macro-remove-greedy-param
4787 \begin_layout Description
4788 Origin sts, 06 January 2008
4791 \begin_layout Subsection*
4792 math-macro-remove-optional-param
4795 \begin_layout Description
4796 Action Remove the last optional parameter.
4799 \begin_layout Description
4800 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
4803 \begin_layout Description
4804 Syntax math-macro-remove-optional-param
4807 \begin_layout Description
4808 Origin sts, 06 January 2008
4811 \begin_layout Subsection*
4812 math-macro-remove-param
4815 \begin_layout Description
4816 Action Remove the last parameter.
4819 \begin_layout Description
4820 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
4823 \begin_layout Description
4824 Syntax math-macro-remove-param <NUM>
4827 \begin_layout Description
4828 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
4831 \begin_layout Description
4832 Origin sts, 06 January 2008
4835 \begin_layout Subsection*
4839 \begin_layout Description
4840 Action Unfold a Math Macro.
4843 \begin_layout Description
4844 Notion Unfold the Math Macro the cursor is in, i.e. display it as
4849 \begin_layout Description
4850 Syntax math-macro-unfold
4853 \begin_layout Description
4854 Origin sts, 06 January 2008
4857 \begin_layout Subsection*
4861 \begin_layout Description
4862 Action Inserts a matrix.
4865 \begin_layout Description
4866 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
4869 \begin_layout Description
4870 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).
4873 \begin_layout Description
4874 Sample math-matrix 3 3 bccc
4877 \begin_layout Subsection*
4881 \begin_layout Description
4882 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.
4885 \begin_layout Description
4886 Notion If there is some selected text, it puts the text inside created math box.
4889 \begin_layout Description
4890 Syntax math-mode [on|<ARG>]
4893 \begin_layout Description
4894 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
4895 \begin_inset Newline newline
4898 "on": allow only entering of math mode from text mode.
4901 \begin_layout Description
4902 Origin Alejandro, 4 Jun 1996
4905 \begin_layout Subsection*
4909 \begin_layout Description
4910 Action Mutates the type of math inset to the newly selected one.
4913 \begin_layout Description
4914 Syntax math-mutate <TYPE>
4917 \begin_layout Description
4918 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
4921 \begin_layout Description
4922 Origin Andre, 23 May 2001
4925 \begin_layout Subsection*
4926 math-number-line-toggle
4929 \begin_layout Description
4930 Action Toggles numbering of the current formula line.
4933 \begin_layout Description
4934 Notion Must be in display formula mode.
4937 \begin_layout Description
4938 Syntax math-number-line-toggle
4941 \begin_layout Description
4942 Origin Alejandro, 18 Jun 1996
4945 \begin_layout Subsection*
4949 \begin_layout Description
4950 Action Toggles numbering/labeling of the current formula.
4953 \begin_layout Description
4954 Notion Must be in display formula mode.
4957 \begin_layout Description
4958 Syntax math-number-toggle
4961 \begin_layout Description
4962 Origin Alejandro, 4 Jun 1996
4965 \begin_layout Subsection*
4969 \begin_layout Description
4970 Action Changes arbitrarily the size used by math fonts inside a context.
4973 \begin_layout Description
4974 Notion Provides an interface to the LaTeX math mode font size commands.
4977 \begin_layout Description
4978 Syntax math-size <STYLE>
4981 \begin_layout Description
4993 \begin_layout Description
4994 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
4997 \begin_layout Subsection*
5001 \begin_layout Description
5002 Action Inserts space into math expression.
5005 \begin_layout Description
5006 Notion Use spacebar after entering this space to change type of space.
5009 \begin_layout Description
5010 Syntax math-space [<TYPE>] [<LEN>]
5013 \begin_layout Description
5014 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5015 \begin_inset Newline newline
5018 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5019 \begin_inset Newline newline
5022 custom space: hspace
5023 \begin_inset Newline newline
5026 "," used by default.
5027 \begin_inset Newline newline
5030 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5031 \begin_inset Newline newline
5034 <LEN>: length for custom spaces (hspace)
5037 \begin_layout Description
5038 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5041 \begin_layout Subsection*
5045 \begin_layout Description
5046 Action Enters subscript expression in math expression.
5049 \begin_layout Description
5050 Syntax math-subscript
5053 \begin_layout Description
5054 Origin vermeer, 12 Dec 2001
5057 \begin_layout Subsection*
5061 \begin_layout Description
5062 Action Enters superscript expression in math expression.
5065 \begin_layout Description
5066 Syntax math-superscript
5069 \begin_layout Description
5070 Origin vermeer, 12 Dec 2001
5073 \begin_layout Subsection*
5077 \begin_layout Description
5078 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5081 \begin_layout Description
5082 Notion If there is any selected text, then it is moved inside the created regexp inset.
5085 \begin_layout Description
5086 Syntax regexp-mode [<ARG>]
5089 \begin_layout Description
5090 Params <ARG>: eventual argument (regular expression).
5093 \begin_layout Description
5094 Origin Tommaso, 4 Oct 2008
5097 \begin_layout Section
5098 Buffer Fuctions (File and Window related)
5101 \begin_layout Subsection*
5105 \begin_layout Description
5106 Action Activate the branch.
5109 \begin_layout Description
5110 Syntax branch-activate <BRANCH>
5113 \begin_layout Description
5114 Params <BRANCH>: The branch to activate
5117 \begin_layout Description
5118 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5119 \begin_inset Newline newline
5122 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5125 \begin_layout Description
5126 Origin rgh, 27 May 2008
5129 \begin_layout Subsection*
5133 \begin_layout Description
5134 Action Add a branch to the buffer's BranchList.
5137 \begin_layout Description
5138 Syntax branch-add <BRANCH>
5141 \begin_layout Description
5142 Params <BRANCH>: Name of the branch to add
5145 \begin_layout Description
5146 Origin spitz, 7 Jul 2009
5149 \begin_layout Subsection*
5153 \begin_layout Description
5154 Action Create new branch and directly put the branch inset into the document.
5157 \begin_layout Description
5158 Syntax branch-add-insert [<NAME>]
5161 \begin_layout Description
5162 Params <NAME>: Branch name. If it is not specified, you will be asked.
5165 \begin_layout Description
5166 Origin sanda, 10 Jul 2009
5169 \begin_layout Subsection*
5173 \begin_layout Description
5174 Action De-activate the branch.
5177 \begin_layout Description
5178 Syntax branch-deactivate <BRANCH>
5181 \begin_layout Description
5182 Params <BRANCH>: The branch to deactivate
5185 \begin_layout Description
5186 Origin rgh, 27 May 2008
5189 \begin_layout Subsection*
5190 branch-master-activate
5193 \begin_layout Description
5194 Action Activate the branch in the master buffer.
5197 \begin_layout Description
5198 Syntax branch-master-activate <BRANCH>
5201 \begin_layout Description
5202 Params <BRANCH>: The branch to activate
5205 \begin_layout Description
5206 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5207 \begin_inset Newline newline
5210 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5213 \begin_layout Description
5214 Origin spitz, 30 Sep 2012
5217 \begin_layout Subsection*
5218 branch-master-deactivate
5221 \begin_layout Description
5222 Action De-activate the branch in the master buffer.
5225 \begin_layout Description
5226 Syntax branch-master-deactivate <BRANCH>
5229 \begin_layout Description
5230 Params <BRANCH>: The branch to deactivate
5233 \begin_layout Description
5234 Origin spitz, 30 Sep 2012
5237 \begin_layout Subsection*
5241 \begin_layout Description
5242 Action Rename all branches of a given name in a document.
5245 \begin_layout Description
5246 Syntax branches-rename <OLDNAME> <NEWNAME>
5249 \begin_layout Description
5250 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5253 \begin_layout Description
5254 Origin spitz, 9 Jul 2009
5257 \begin_layout Subsection*
5261 \begin_layout Description
5262 Action Saves the current buffer to a temporary file.
5265 \begin_layout Description
5266 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5269 \begin_layout Description
5270 Syntax buffer-auto-save
5273 \begin_layout Subsection*
5277 \begin_layout Description
5278 Action Loads the given child document.
5281 \begin_layout Description
5282 Notion The current document is treated as a parent.
5285 \begin_layout Description
5286 Syntax buffer-child-open <FILE>
5289 \begin_layout Description
5290 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5293 \begin_layout Description
5294 Origin Ale, 28 May 1997
5297 \begin_layout Subsection*
5301 \begin_layout Description
5302 Action Runs chktex for the current document.
5305 \begin_layout Description
5306 Syntax buffer-chktex
5309 \begin_layout Description
5310 Origin Asger, 30 Oct 1997
5313 \begin_layout Subsection*
5317 \begin_layout Description
5318 Action Closes the current buffer.
5321 \begin_layout Description
5322 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5325 \begin_layout Description
5329 \begin_layout Subsection*
5333 \begin_layout Description
5334 Action Closes all buffers.
5337 \begin_layout Description
5338 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5341 \begin_layout Description
5342 Syntax buffer-close-all
5345 \begin_layout Subsection*
5349 \begin_layout Description
5350 Action Exports the current buffer (document) to the given format.
5353 \begin_layout Description
5354 Syntax buffer-export <FORMAT> [<DEST>]
5357 \begin_layout Description
5358 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.
5359 \begin_inset Newline newline
5362 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.
5365 \begin_layout Description
5366 Origin Lgb, 29 Jul 1997
5369 \begin_layout Subsection*
5373 \begin_layout Description
5374 Action Opens a dialog for exporting the current buffer.
5377 \begin_layout Description
5378 Syntax buffer-export-as [<FORMAT>]
5381 \begin_layout Description
5382 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.
5385 \begin_layout Description
5386 Sample buffer-export-as pdf2
5389 \begin_layout Description
5390 Origin tommaso, 6 Oct 2011
5393 \begin_layout Subsection*
5394 buffer-export-custom
5397 \begin_layout Description
5398 Action Exports the current buffer (document) from the given format using the given command on it.
5401 \begin_layout Description
5402 Syntax buffer-export-custom <FORMAT> <COMMAND>
5405 \begin_layout Description
5406 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5407 \begin_inset Newline newline
5410 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5413 \begin_layout Description
5414 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5417 \begin_layout Description
5418 Origin leeming, 27 Mar 2004
5421 \begin_layout Subsection*
5425 \begin_layout Description
5426 Action Applies a command to all non-hidden buffers.
5429 \begin_layout Description
5430 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5433 \begin_layout Description
5434 Syntax buffer-forall <LFUN-COMMAND>
5437 \begin_layout Description
5438 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5441 \begin_layout Description
5442 Sample Close all Notes in buffers:
5443 \begin_inset Newline newline
5446 buffer-forall inset-forall Note inset-toggle close
5447 \begin_inset Newline newline
5450 Toggle change tracking on buffers:
5451 \begin_inset Newline newline
5454 buffer-forall changes-track
5455 \begin_inset Newline newline
5458 Toggle read-only for buffers:
5459 \begin_inset Newline newline
5462 buffer-forall buffer-toggle-read-only
5463 \begin_inset Newline newline
5466 Show statistics for individual buffers:
5467 \begin_inset Newline newline
5470 buffer-forall statistics
5471 \begin_inset Newline newline
5474 Activate the branch named "Solutions" in buffers:
5475 \begin_inset Newline newline
5478 buffer-forall branch-activate Solutions
5479 \begin_inset Newline newline
5482 Export buffers to PDF (pdflatex):
5483 \begin_inset Newline newline
5486 buffer-forall buffer-export pdf2
5487 \begin_inset Newline newline
5493 \begin_layout Description
5494 Origin skostysh, 20 Jul 2012
5497 \begin_layout Subsection*
5501 \begin_layout Description
5502 Action Import a given file as a lyx document.
5505 \begin_layout Description
5506 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.
5509 \begin_layout Description
5510 Syntax buffer-import <FORMAT> [<FILE>]
5513 \begin_layout Description
5514 Origin Asger, 24 Jul 1998
5517 \begin_layout Subsection*
5521 \begin_layout Description
5522 Action Set language of the current document.
5525 \begin_layout Description
5526 Syntax buffer-language <LANG>
5529 \begin_layout Description
5530 Params <LANG>: language name. See lib/languages for list.
5533 \begin_layout Description
5534 Origin leeming, 30 Mar 2004
5537 \begin_layout Subsection*
5541 \begin_layout Description
5542 Action Moves the current tab one spot to the right.
5545 \begin_layout Description
5546 Syntax buffer-move-next
5549 \begin_layout Description
5550 Origin skostysh, 7 Apr 2015
5553 \begin_layout Subsection*
5554 buffer-move-previous
5557 \begin_layout Description
5558 Action Moves the current tab one spot to the left.
5561 \begin_layout Description
5562 Syntax buffer-move-previous
5565 \begin_layout Description
5566 Origin skostysh, 7 Apr 2015
5569 \begin_layout Subsection*
5573 \begin_layout Description
5574 Action Creates a new buffer (that is, document) and switches to it.
5577 \begin_layout Description
5578 Notion Implicit path can be set in Preferences dialog.
5581 \begin_layout Description
5582 Syntax buffer-new [<FILE>]
5585 \begin_layout Description
5586 Params <FILE>: filename of created file with absolute path.
5589 \begin_layout Subsection*
5593 \begin_layout Description
5594 Action Creates a new buffer (that is, document) from a template.
5597 \begin_layout Description
5598 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5601 \begin_layout Description
5602 Syntax buffer-new-template [<FILE>]
5605 \begin_layout Description
5606 Params <FILE>: filename of created file with absolute path.
5609 \begin_layout Subsection*
5613 \begin_layout Description
5614 Action Switch to the next opened document.
5617 \begin_layout Description
5618 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
5621 \begin_layout Description
5625 \begin_layout Subsection*
5629 \begin_layout Description
5630 Action Apply the given settings to the current document.
5633 \begin_layout Description
5634 Syntax buffer-params-apply [<ARGS>]
5637 \begin_layout Description
5638 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5641 \begin_layout Description
5642 Origin leeming, 30 Mar 2004
5645 \begin_layout Subsection*
5649 \begin_layout Description
5650 Action Switch to the previous opened document.
5653 \begin_layout Description
5654 Syntax buffer-previous
5657 \begin_layout Subsection*
5661 \begin_layout Description
5662 Action Reverts opened document.
5665 \begin_layout Description
5666 Syntax buffer-reload
5669 \begin_layout Description
5670 Origin Asger, 2 Feb 1997
5673 \begin_layout Subsection*
5674 buffer-save-as-default
5677 \begin_layout Description
5678 Action Save the current document settings as default.
5681 \begin_layout Description
5682 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5685 \begin_layout Description
5686 Syntax buffer-save-as-default [<ARGS>]
5689 \begin_layout Description
5690 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5693 \begin_layout Description
5694 Origin leeming, 30 Mar 2004
5697 \begin_layout Subsection*
5701 \begin_layout Description
5702 Action Display and switch to the given buffer.
5705 \begin_layout Description
5706 Syntax buffer-switch <BUFFER>
5709 \begin_layout Description
5710 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
5713 \begin_layout Subsection*
5714 buffer-toggle-compression
5717 \begin_layout Description
5718 Action Toggles compression of the current document on/off.
5721 \begin_layout Description
5722 Syntax buffer-toggle-compression
5725 \begin_layout Description
5726 Origin bpeng, 27 Apr 2006
5729 \begin_layout Subsection*
5730 buffer-toggle-read-only
5733 \begin_layout Description
5734 Action Toggle editing mode of the current document between read/write and read-only.
5737 \begin_layout Description
5738 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.
5741 \begin_layout Description
5742 Syntax buffer-toggle-read-only
5745 \begin_layout Description
5746 Origin Lgb, 27 May 1997
5749 \begin_layout Subsection*
5753 \begin_layout Description
5754 Action Exports the current document and put the result into the temporary directory.
5757 \begin_layout Description
5758 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).
5761 \begin_layout Description
5762 Syntax buffer-update [<FORMAT>]
5765 \begin_layout Description
5766 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.
5769 \begin_layout Description
5770 Origin Dekel, 5 Aug 2000
5773 \begin_layout Subsection*
5777 \begin_layout Description
5778 Action Displays current buffer in chosen format.
5781 \begin_layout Description
5782 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.
5785 \begin_layout Description
5786 Syntax buffer-view [<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 Subsection*
5797 \begin_layout Description
5798 Action Opens the file that was created from last preview of this buffer.
5801 \begin_layout Description
5802 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.
5805 \begin_layout Description
5806 Syntax buffer-view-cache
5809 \begin_layout Subsection*
5813 \begin_layout Description
5814 Action Saves the current buffer.
5817 \begin_layout Description
5818 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.
5821 \begin_layout Description
5825 \begin_layout Subsection*
5829 \begin_layout Description
5830 Action Save all changed documents.
5833 \begin_layout Description
5834 Syntax buffer-write-all
5837 \begin_layout Description
5838 Origin rgh, gpothier 6 Aug 2007
5841 \begin_layout Subsection*
5845 \begin_layout Description
5846 Action Rename and save current buffer.
5849 \begin_layout Description
5850 Syntax buffer-write-as <FILENAME>
5853 \begin_layout Description
5854 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
5857 \begin_layout Subsection*
5861 \begin_layout Description
5862 Action Increases the zoom of the screen fonts.
5865 \begin_layout Description
5866 Syntax buffer-zoom-in [<ZOOM>]
5869 \begin_layout Description
5870 Params <ZOOM>: The zoom in %, the default is 20.
5873 \begin_layout Description
5874 Origin vfr, 30 Mar 2009
5877 \begin_layout Subsection*
5881 \begin_layout Description
5882 Action Decreases the zoom of the screen fonts.
5885 \begin_layout Description
5886 Syntax buffer-zoom-out [<ZOOM>]
5889 \begin_layout Description
5890 Params <ZOOM>: The zoom in %, the default is 20.
5893 \begin_layout Description
5894 Origin vfr, 30 Mar 2009
5897 \begin_layout Subsection*
5901 \begin_layout Description
5902 Action Generates the code (literate programming).
5905 \begin_layout Description
5906 Notion Latex file with extension
5908 literate_extension is generated. Then LyX invokes
5910 build_command (with a default of ``make'') to generate the code and
5912 build_error_filter to process the compilation error messages.
5913 \begin_inset Newline newline
5916 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:
5917 \begin_inset Newline newline
5922 build_command "my_script my_arguments"
5923 \begin_inset Newline newline
5928 build_error_filter differs from the
5930 literate_error_filter only in that the former will identify error messages from your compiler.
5933 \begin_layout Description
5934 Syntax build-program
5937 \begin_layout Subsection*
5941 \begin_layout Description
5942 Action Open LyX document.
5945 \begin_layout Description
5946 Syntax file-open [<FILE>]
5949 \begin_layout Description
5950 Params <FILE>: Filename to be opened.
5953 \begin_layout Subsection*
5957 \begin_layout Description
5958 Action Open the given help file according to the language setting.
5961 \begin_layout Description
5962 Syntax help-open <FILE>[.lyx]
5965 \begin_layout Description
5966 Params <FILE>: any document from (/usr/share/)doc directory.
5969 \begin_layout Description
5970 Origin Jug, 27 Jun 1999
5973 \begin_layout Subsection*
5977 \begin_layout Description
5978 Action Terminates the current LyX instance.
5981 \begin_layout Description
5982 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
5985 \begin_layout Description
5989 \begin_layout Subsection*
5990 master-buffer-update
5993 \begin_layout Description
5994 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
5997 \begin_layout Description
5998 Syntax master-buffer-update [<FORMAT>]
6001 \begin_layout Description
6002 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.
6005 \begin_layout Description
6006 Origin Tommaso, 20 Sep 2007
6009 \begin_layout Subsection*
6013 \begin_layout Description
6014 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6017 \begin_layout Description
6018 Syntax master-buffer-view [<FORMAT>]
6021 \begin_layout Description
6022 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
6025 \begin_layout Description
6026 Origin Tommaso, 20 Sep 2007
6029 \begin_layout Subsection*
6033 \begin_layout Description
6034 Action Opens the menu given by its name.
6037 \begin_layout Description
6038 Syntax menu-open <NAME>
6041 \begin_layout Description
6042 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6045 \begin_layout Subsection*
6049 \begin_layout Description
6050 Action Close the current tab group.
6053 \begin_layout Description
6054 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6057 \begin_layout Description
6058 Syntax tab-group-close
6061 \begin_layout Description
6062 Origin Abdel, 21 Feb 2008
6065 \begin_layout Subsection*
6069 \begin_layout Description
6070 Action Toggles visibility of a given toolbar between on/off/auto.
6073 \begin_layout Description
6074 Notion Skipping "auto" when allowauto is false.
6077 \begin_layout Description
6078 Syntax toolbar-toggle <NAME> [allowauto]
6081 \begin_layout Description
6082 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6083 \begin_inset Newline newline
6086 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6089 \begin_layout Description
6090 Origin Edwin, 21 May 2007
6093 \begin_layout Subsection*
6097 \begin_layout Description
6098 Action Various UI visibility-toggling actions.
6101 \begin_layout Description
6102 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6105 \begin_layout Description
6106 Params statusbar : Toggle visibility of the statusbar.
6107 \begin_inset Newline newline
6110 menubar : Toggle visibility of the menubar.
6111 \begin_inset Newline newline
6114 scrollbar : Toggle visibility of the scrollbar.
6115 \begin_inset Newline newline
6118 frame : Toggle visibility of the frames around editing window.
6119 \begin_inset Newline newline
6122 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.
6125 \begin_layout Description
6126 Origin sanda, 9 Feb 2007
6129 \begin_layout Subsection*
6133 \begin_layout Description
6134 Action Close the current document work area.
6137 \begin_layout Description
6138 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6141 \begin_layout Description
6145 \begin_layout Description
6146 Origin Tommaso, 15 Sep 2012
6149 \begin_layout Subsection*
6153 \begin_layout Description
6154 Action Creates another split view of current buffer.
6157 \begin_layout Description
6158 Notion All split views act in the same way independently.
6161 \begin_layout Description
6162 Syntax view-split <vertical|horizontal>
6165 \begin_layout Description
6166 Params horizontal : The work areas are laid out side by side.
6167 \begin_inset Newline newline
6170 vertical : The work areas laid out vertically.
6173 \begin_layout Description
6174 Origin Abdel, 20 Feb 2008
6177 \begin_layout Subsection*
6181 \begin_layout Description
6182 Action Closes the current LyX window.
6185 \begin_layout Description
6189 \begin_layout Description
6190 Origin Abdel, 23 Oct 2006
6193 \begin_layout Subsection*
6197 \begin_layout Description
6198 Action Creates new empty LyX window.
6201 \begin_layout Description
6202 Notion Already opened documents from the previous window can be found under View menu.
6205 \begin_layout Description
6206 Syntax window-new [<GEOMETRY>]
6209 \begin_layout Description
6210 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6213 \begin_layout Description
6214 Origin Abdel, 21 Oct 2006
6217 \begin_layout Section
6218 System Functions (Preferences, LyX Server etc.)
6221 \begin_layout Subsection*
6222 buffer-toggle-output-sync
6225 \begin_layout Description
6226 Action Toggles including of resources for forward/reverse search of the given document.
6229 \begin_layout Description
6230 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6233 \begin_layout Description
6234 Syntax buffer-toggle-output-sync
6237 \begin_layout Description
6238 Origin sanda, 25 May 2010
6241 \begin_layout Subsection*
6245 \begin_layout Description
6246 Action Executes a command defined in a .def file.
6249 \begin_layout Description
6250 Notion The definitions are by default read from lib/commands/default.def.
6251 \begin_inset Newline newline
6254 A .def file allows to define a command with
6256 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).
6258 def_file "FileName" allows to include another .def file.
6259 \begin_inset Newline newline
6262 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.
6265 \begin_layout Description
6269 \begin_layout Description
6270 Params <NAME>: Name of the command that must be called.
6273 \begin_layout Description
6274 Origin broider, 2 Oct 2007
6277 \begin_layout Subsection*
6281 \begin_layout Description
6282 Action Cancels sequence prepared by LFUN_META_PREFIX .
6285 \begin_layout Description
6289 \begin_layout Subsection*
6290 command-alternatives
6293 \begin_layout Description
6294 Action Runs the first listed command that is enabled.
6297 \begin_layout Description
6298 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6301 \begin_layout Description
6302 Syntax command-alternatives <CMDS>
6305 \begin_layout Description
6306 Params <CMDS>: Sequence of commands separated by semicolons.
6309 \begin_layout Description
6310 Sample command-alternatives completion-accept;cell-forward
6313 \begin_layout Description
6314 Origin rgh, 24 September 2008
6317 \begin_layout Subsection*
6321 \begin_layout Description
6322 Action Run more commands (LFUN and its parameters) in a sequence.
6325 \begin_layout Description
6326 Syntax command-sequence <CMDS>
6329 \begin_layout Description
6330 Params <CMDS>: Sequence of commands separated by semicolons.
6333 \begin_layout Description
6334 Sample command-sequence cut; ert-insert; self-insert
6336 ; paste; self-insert {}; inset-toggle;
6339 \begin_layout Description
6340 Origin Andre, 11 Nov 1999
6343 \begin_layout Subsection*
6344 cursor-follows-scrollbar-toggle
6347 \begin_layout Description
6348 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6351 \begin_layout Description
6352 Syntax toggle-cursor-follows-scrollbar
6355 \begin_layout Description
6356 Origin ARRae, 2 Dec 1997
6359 \begin_layout Subsection*
6363 \begin_layout Description
6364 Action Set debug output level.
6367 \begin_layout Description
6368 Syntax debug-level-set <LEVEL>
6371 \begin_layout Description
6372 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.
6375 \begin_layout Description
6376 Origin sanda, 28 Dec 2009
6379 \begin_layout Subsection*
6383 \begin_layout Description
6384 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6387 \begin_layout Description
6388 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6391 \begin_layout Description
6392 Syntax forward-search
6395 \begin_layout Description
6396 Origin sanda, 14 Apr 2010
6399 \begin_layout Subsection*
6403 \begin_layout Description
6404 Action Apply the given settings to user preferences.
6407 \begin_layout Description
6408 Syntax lyxrc-apply <SETTINGS>
6411 \begin_layout Description
6412 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.
6415 \begin_layout Subsection*
6419 \begin_layout Description
6420 Action Shows message in statusbar (for script purposes).
6423 \begin_layout Description
6424 Syntax message <STRING>
6427 \begin_layout Description
6428 Origin Lgb, 8 Apr 2001
6431 \begin_layout Subsection*
6435 \begin_layout Description
6436 Action Simulate halting Meta key (Alt key on PCs).
6439 \begin_layout Description
6440 Notion Used for buffer edition not for GUI control.
6443 \begin_layout Description
6447 \begin_layout Subsection*
6451 \begin_layout Description
6452 Action Save user preferences.
6455 \begin_layout Description
6456 Syntax preferences-save
6459 \begin_layout Description
6460 Origin Lgb, 27 Nov 1999
6463 \begin_layout Subsection*
6467 \begin_layout Description
6468 Action Reconfigure the automatic settings.
6471 \begin_layout Description
6475 \begin_layout Description
6476 Origin Asger, 14 Feb 1997
6479 \begin_layout Subsection*
6483 \begin_layout Description
6484 Action Returns path and file name of the currently edited document.
6487 \begin_layout Description
6488 Syntax server-get-filename
6491 \begin_layout Subsection*
6495 \begin_layout Description
6496 Action Returns the current layout (that is environment) name on the cursor position.
6499 \begin_layout Description
6500 Syntax server-get-layout
6503 \begin_layout Subsection*
6504 server-get-statistics
6507 \begin_layout Description
6508 Action Returns the statistics (number of words and characters) in the document or in the given selection.
6511 \begin_layout Description
6512 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6515 \begin_layout Description
6516 Syntax server-get-statistics [<TYPE>]
6519 \begin_layout Description
6520 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
6521 \begin_inset Newline newline
6525 \begin_inset Newline newline
6528 chars: count characters.
6529 \begin_inset Newline newline
6532 chars-space: count characters and spaces.
6535 \begin_layout Description
6536 Origin brokenclock, Oct 10 2014
6539 \begin_layout Subsection*
6543 \begin_layout Description
6544 Action Returns the coordinates of cursor position in the editing area.
6547 \begin_layout Description
6548 Syntax server-get-xy
6551 \begin_layout Subsection*
6552 server-goto-file-row
6555 \begin_layout Description
6556 Action Sets the cursor position in LyX based on the row number of generated TeX file.
6559 \begin_layout Description
6560 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).
6563 \begin_layout Description
6564 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
6567 \begin_layout Description
6568 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.
6569 \begin_inset Newline newline
6572 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).
6573 \begin_inset Newline newline
6576 .ext: extensions will be automatically replaced by .lyx.
6577 \begin_inset Newline newline
6580 <ROW_NUMBER> The row number of the LaTeX file to which to go.
6583 \begin_layout Description
6584 Sample server-goto-file-row /home/user/example.lyx 41
6585 \begin_inset Newline newline
6588 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
6591 \begin_layout Description
6592 Origin Edmar, 23 Dec 1998
6595 \begin_layout Subsection*
6599 \begin_layout Description
6600 Action Sends notify message about the last key-sequence to client.
6603 \begin_layout Description
6604 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
6607 \begin_layout Description
6608 Syntax server-notify
6611 \begin_layout Subsection*
6615 \begin_layout Description
6616 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
6619 \begin_layout Description
6620 Syntax server-set-xy <X> <Y>
6623 \begin_layout Subsection*
6627 \begin_layout Description
6628 Action Set the given LyX color to the color defined by the X11 name given.
6631 \begin_layout Description
6632 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
6635 \begin_layout Description
6636 Syntax set-color <LYX_NAME> <X11_NAME>
6639 \begin_layout Description
6640 Origin SLior, 11 Jun 2000
6643 \begin_layout Subsection*
6647 \begin_layout Description
6648 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
6651 \begin_layout Description
6652 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6655 \begin_layout Description
6659 \begin_layout Description
6660 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6663 \begin_layout Subsection*
6667 \begin_layout Description
6668 Action Checks-in/commits the changes of the registered file to the repository.
6671 \begin_layout Description
6672 Notion In RCS case this also unlocks the file.
6675 \begin_layout Description
6679 \begin_layout Description
6680 Origin Lgb, 1 Jul 1997
6683 \begin_layout Subsection*
6687 \begin_layout Description
6688 Action Checks-out the document for edit (and locks it in some cases).
6691 \begin_layout Description
6695 \begin_layout Description
6696 Origin Lgb, 1 Jul 1997
6699 \begin_layout Subsection*
6703 \begin_layout Description
6704 Action Executes external command. This command is intended to support additional VCS commands.
6707 \begin_layout Description
6708 Syntax vc-command <FLAG> <PATH> <COMMAND>
6711 \begin_layout Description
6712 Params <FLAG>: Flags for the command can be combined together.
6713 \begin_inset Newline newline
6716 U - dUmmy - no flags
6717 \begin_inset Newline newline
6720 D - Doc - need document loaded to proceed
6721 \begin_inset Newline newline
6724 I - dIrty - mark document dirty
6725 \begin_inset Newline newline
6728 R - Reload - ensure that the document is saved and reload it after command execution
6729 \begin_inset Newline newline
6732 M - Message - ask for input string (commit message)
6733 \begin_inset Newline newline
6736 <PATH>: path where to start. $$p will be replaced by the current document path.
6737 \begin_inset Newline newline
6740 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
6743 \begin_layout Description
6744 Sample vc-command DR $$p "svn up"
6747 \begin_layout Description
6748 Origin sanda, 13 Jan 2009
6751 \begin_layout Subsection*
6755 \begin_layout Description
6756 Action Compares two revisions of the same file under version control.
6759 \begin_layout Description
6760 Syntax vc-compare [<REV1>] [<REV2>]
6763 \begin_layout Description
6764 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
6765 \begin_inset Newline newline
6768 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
6769 \begin_inset Newline newline
6773 \begin_inset Newline newline
6776 <REV2>: Newer file. Used only if REV1 > 0.
6777 \begin_inset Newline newline
6780 If no parameter is given, interactive dialog will be shown.
6783 \begin_layout Description
6784 Sample Compare current document against last commit
6785 \begin_inset Newline newline
6789 \begin_inset Newline newline
6792 Compare current document against current revision - 5 commits
6793 \begin_inset Newline newline
6797 \begin_inset Newline newline
6800 Compare revisions 120 and 155
6801 \begin_inset Newline newline
6807 \begin_layout Description
6808 Origin sanda, 12 Feb 2010
6811 \begin_layout Subsection*
6815 \begin_layout Description
6816 Action Copies the document to another name.
6819 \begin_layout Description
6820 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.
6823 \begin_layout Description
6824 Syntax vc-copy <FILENAME>
6827 \begin_layout Description
6828 Params <FILENAME>: New name of the document.
6829 \begin_inset Newline newline
6832 A file dialog is opened if no filename is given.
6835 \begin_layout Description
6836 Origin gb, 05 Feb 2013
6839 \begin_layout Subsection*
6843 \begin_layout Description
6844 Action Toggles the locking property of the edited file.
6847 \begin_layout Description
6848 Notion This is currently implemented only for SVN.
6851 \begin_layout Description
6852 Syntax vc-locking-toggle
6855 \begin_layout Description
6856 Origin sanda, 25 Jun 2009
6859 \begin_layout Subsection*
6863 \begin_layout Description
6864 Action Register the document as an file inside version control system.
6867 \begin_layout Description
6868 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
6869 \begin_inset Newline newline
6872 See LyX Additional Features Manual (Version Control Chapter) for additional information.
6875 \begin_layout Description
6879 \begin_layout Description
6880 Origin Lgb, 1 Jul 1997
6883 \begin_layout Subsection*
6887 \begin_layout Description
6888 Action Renames the document to another name.
6891 \begin_layout Description
6892 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.
6895 \begin_layout Description
6896 Syntax vc-rename <FILENAME>
6899 \begin_layout Description
6900 Params <FILENAME>: New name of the document.
6901 \begin_inset Newline newline
6904 A file dialog is opened if no filename is given.
6907 \begin_layout Description
6908 Origin gb, 05 Feb 2013
6911 \begin_layout Subsection*
6915 \begin_layout Description
6916 Action Update the local archive directory in which resides the current document with the remote repository.
6919 \begin_layout Description
6920 Syntax vc-repo-update
6923 \begin_layout Description
6924 Origin sanda, 16 Oct 2009
6927 \begin_layout Subsection*
6931 \begin_layout Description
6932 Action Reverts the document to the last check-in/commit in VCS.
6935 \begin_layout Description
6939 \begin_layout Description
6940 Origin Lgb, 1 Jul 1997
6943 \begin_layout Subsection*
6947 \begin_layout Description
6948 Action Undo last check-in.
6951 \begin_layout Description
6952 Notion This is currently implemented only for RCS.
6955 \begin_layout Description
6959 \begin_layout Description
6960 Origin Lgb, 1 Jul 1997
6963 \begin_layout Section
6964 Hidden Functions (not listed for configuration)
6967 \begin_layout Subsection*
6971 \begin_layout Description
6972 Action Return the current key sequence and available options as a string.
6975 \begin_layout Description
6976 Notion No options are added if no current map exists.
6977 \begin_inset Newline newline
6980 This is probably usable only with connection to lyxserver.
6983 \begin_layout Description
6984 Syntax command-prefix
6987 \begin_layout Subsection*
6991 \begin_layout Description
6992 Action Inserts the given string (accordingly to the correct keymap).
6995 \begin_layout Description
6996 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
6999 \begin_layout Description
7000 Syntax self-insert <STRING>