1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
10 \renewenvironment{description}{\list{}{%
11 \setlength{\itemsep}{-2pt}
12 \advance\leftmargini6\p@ \itemindent-12\p@
13 \labelwidth\z@ \let\makelabel\descriptionlabel}%
18 \use_default_options false
19 \maintain_unincluded_children false
27 \language_package default
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
38 \font_sf_scale 100 100
39 \font_tt_scale 100 100
41 \use_dash_ligatures true
43 \default_output_format default
45 \bibtex_command default
46 \index_command default
47 \paperfontsize default
52 \use_package amsmath 1
53 \use_package amssymb 1
56 \use_package mathdots 0
57 \use_package mathtools 0
59 \use_package stackrel 0
60 \use_package stmaryrd 0
61 \use_package undertilde 0
63 \cite_engine_type default
67 \paperorientation portrait
81 \paragraph_separation indent
82 \paragraph_indentation default
87 \paperpagestyle default
88 \tracking_changes false
107 \begin_layout Section*
111 \begin_layout Standard
112 This manual documents the
113 \begin_inset Quotes eld
117 \begin_inset Quotes erd
121 These are commands that are used to make \SpecialChar LyX
122 perform specific actions.
124 itself uses these functions internally, and every internal action is
128 \begin_layout Standard
129 LFUNs are also used in the files that define keyboard shortcuts, menu or
131 So if you want to change\SpecialChar breakableslash
132 customize the user interface, you need to deal
134 Furthermore, external programs can use LFUNs to communicate with and
135 \begin_inset Quotes eld
139 \begin_inset Quotes erd
144 Finally, you can also issue LFUNs directly via the so called mini-buffer
145 which can be opened via
148 arg "command-execute"
154 \begin_layout Standard
155 In the following, all LFUNs are listed, categorized by function.
158 \begin_layout Section
159 Layout Functions (Font, Layout and Textclass related)
162 \begin_layout Subsection*
166 \begin_layout Description
167 Action Displays list of layout choices.
170 \begin_layout Description
171 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
174 \begin_layout Description
175 Syntax drop-layouts-choice
178 \begin_layout Subsection*
182 \begin_layout Description
183 Action Splits the current environment with a Separator.
186 \begin_layout Description
187 Syntax environment-split [outer]
190 \begin_layout Description
191 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
194 \begin_layout Description
195 Origin spitz, 23 Dec 2012
198 \begin_layout Subsection*
202 \begin_layout Description
203 Action Toggles the bold font (selection-wise) using mathbf in math.
206 \begin_layout Description
210 \begin_layout Subsection*
214 \begin_layout Description
215 Action Toggles the bold font (selection-wise) using boldsymbol in math.
218 \begin_layout Description
219 Syntax font-boldsymbol
222 \begin_layout Subsection*
226 \begin_layout Description
227 Action Toggles xout (cross-through) in the font (selection-wise).
230 \begin_layout Description
234 \begin_layout Description
235 Origin uwestoehr, 4 April 2017
238 \begin_layout Subsection*
242 \begin_layout Description
243 Action Reverts the settings of the font to the default values (selection-wise).
246 \begin_layout Description
250 \begin_layout Subsection*
254 \begin_layout Description
255 Action Toggles the emphasis font style (selection-wise).
258 \begin_layout Description
262 \begin_layout Subsection*
266 \begin_layout Description
267 Action Toggles Fraktur family font (math-mode, selection-wise).
270 \begin_layout Description
274 \begin_layout Description
275 Origin vermeer, 10 Jan 2002
278 \begin_layout Subsection*
282 \begin_layout Description
283 Action Toggles Italics font shape (math-mode, selection-wise).
286 \begin_layout Description
290 \begin_layout Description
291 Origin vermeer, 10 Jan 2002
294 \begin_layout Subsection*
298 \begin_layout Description
299 Action Toggles Noun text style font (selection-wise).
302 \begin_layout Description
306 \begin_layout Subsection*
310 \begin_layout Description
311 Action Toggles Roman family font (selection-wise).
314 \begin_layout Description
318 \begin_layout Subsection*
322 \begin_layout Description
323 Action Toggles Sans Serif family font (selection-wise).
326 \begin_layout Description
330 \begin_layout Subsection*
334 \begin_layout Description
335 Action Sets font size according to lyx format string.
338 \begin_layout Description
339 Syntax font-size <SIZE>
342 \begin_layout Description
343 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
344 \begin_inset Newline newline
347 largest|huge|giant|increase|decrease|default
350 \begin_layout Subsection*
354 \begin_layout Description
355 Action Returns the info about the current font.
358 \begin_layout Description
362 \begin_layout Subsection*
366 \begin_layout Description
367 Action Toggles strikeout (strike-through) in the font (selection-wise).
370 \begin_layout Description
371 Syntax font-strikeout
374 \begin_layout Description
375 Origin sanda, 3 May 2009
378 \begin_layout Subsection*
382 \begin_layout Description
383 Action Toggles the typewriter family font (selection-wise).
386 \begin_layout Description
387 Syntax font-typewriter
390 \begin_layout Subsection*
394 \begin_layout Description
395 Action Toggles underline in the font (selection-wise).
398 \begin_layout Description
399 Syntax font-underline
402 \begin_layout Subsection*
406 \begin_layout Description
407 Action Toggles double underline in the font (selection-wise).
410 \begin_layout Description
411 Syntax font-underunderline
414 \begin_layout Description
415 Origin sanda, 5 May 2009
418 \begin_layout Subsection*
422 \begin_layout Description
423 Action Toggles wavy underline in the font (selection-wise).
426 \begin_layout Description
427 Syntax font-underwave
430 \begin_layout Description
431 Origin sanda, 5 May 2009
434 \begin_layout Subsection*
438 \begin_layout Description
439 Action Sets the layout (that is, environment) for the current paragraph.
442 \begin_layout Description
443 Syntax layout <LAYOUT>
446 \begin_layout Description
447 Params <LAYOUT>: the layout to use
450 \begin_layout Subsection*
454 \begin_layout Description
455 Action Adds a module.
458 \begin_layout Description
459 Notion Adds a module to the list of included modules for the current buffer.
462 \begin_layout Description
463 Syntax layout-module-add <MODULE>
466 \begin_layout Description
467 Params <MODULE>: the module to be added
470 \begin_layout Description
471 Origin rgh, 25 August 2007
474 \begin_layout Subsection*
478 \begin_layout Description
479 Action Clears the module list.
482 \begin_layout Description
483 Notion Clears the list of included modules for the current buffer.
486 \begin_layout Description
487 Syntax layout-modules-clear
490 \begin_layout Description
491 Origin rgh, 25 August 2007
494 \begin_layout Subsection*
498 \begin_layout Description
499 Action Launches the paragraph settings dialog.
502 \begin_layout Description
503 Syntax layout-paragraph
506 \begin_layout Subsection*
510 \begin_layout Description
511 Action Reloads layout information.
514 \begin_layout Description
515 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.
518 \begin_layout Description
522 \begin_layout Description
523 Origin rgh, 3 September 2007
526 \begin_layout Subsection*
530 \begin_layout Description
531 Action Launches the tabular settings dialog.
534 \begin_layout Description
535 Syntax layout-tabular
538 \begin_layout Description
539 Origin Jug, 31 Jul 2000
542 \begin_layout Subsection*
546 \begin_layout Description
547 Action Update fonts and its metrics.
550 \begin_layout Description
551 Notion Automatically called after zoom, dpi, font names, or norm change.
554 \begin_layout Description
555 Syntax screen-font-update
558 \begin_layout Description
559 Origin ARRae, 13 Aug 2000
562 \begin_layout Subsection*
566 \begin_layout Description
567 Action Sets the text class for the current buffer.
570 \begin_layout Description
571 Syntax textclass-apply <TEXTCLASS>
574 \begin_layout Description
575 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
578 \begin_layout Subsection*
582 \begin_layout Description
583 Action Loads information for a textclass from disk.
586 \begin_layout Description
587 Syntax textclass-load <TEXTCLASS>
590 \begin_layout Description
591 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
594 \begin_layout Subsection*
598 \begin_layout Description
599 Action Toggle user-defined (=last-time used) text style.
602 \begin_layout Description
603 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
606 \begin_layout Description
607 Syntax textstyle-apply
610 \begin_layout Description
611 Origin leeming, 12 Mar 2003
614 \begin_layout Subsection*
618 \begin_layout Description
619 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
622 \begin_layout Description
623 Syntax textstyle-update <FONT_INFO>
626 \begin_layout Description
627 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
628 \begin_inset Newline newline
631 Use lyx -dbg action for exact syntax of text-style dialog parameters.
634 \begin_layout Description
635 Origin leeming, 12 Mar 2003
638 \begin_layout Section
639 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
642 \begin_layout Subsection*
646 \begin_layout Description
647 Action Adds an acute accent to the next character typed.
650 \begin_layout Description
654 \begin_layout Subsection*
658 \begin_layout Description
659 Action Adds a breve accent to the next character typed.
662 \begin_layout Description
666 \begin_layout Subsection*
670 \begin_layout Description
671 Action Adds a caron to the next character typed.
674 \begin_layout Description
678 \begin_layout Subsection*
682 \begin_layout Description
683 Action Adds a cedilla to the next character typed.
686 \begin_layout Description
687 Syntax accent-cedilla
690 \begin_layout Subsection*
694 \begin_layout Description
695 Action Adds a circle accent to the next character typed.
698 \begin_layout Description
702 \begin_layout Subsection*
706 \begin_layout Description
707 Action Adds a circumflex to the next character typed.
710 \begin_layout Description
711 Syntax accent-circumflex
714 \begin_layout Subsection*
718 \begin_layout Description
719 Action Adds a dot accent to the next character typed.
722 \begin_layout Description
726 \begin_layout Subsection*
730 \begin_layout Description
731 Action Adds a grave accent to the next character typed.
734 \begin_layout Description
738 \begin_layout Subsection*
739 accent-hungarian-umlaut
742 \begin_layout Description
743 Action Adds a Hungarian umlaut to the next character typed.
746 \begin_layout Description
750 \begin_layout Subsection*
754 \begin_layout Description
755 Action Adds a macron to the next character typed.
758 \begin_layout Description
762 \begin_layout Subsection*
766 \begin_layout Description
767 Action Adds an ogonek accent to the next character typed.
770 \begin_layout Description
774 \begin_layout Subsection*
778 \begin_layout Description
779 Action Adds a perispomeni (Greek circumflex) over the next character typed.
782 \begin_layout Description
783 Syntax accent-perispomeni
786 \begin_layout Subsection*
790 \begin_layout Description
791 Action Adds a tie over the next two character typed.
794 \begin_layout Description
795 Notion The following char will finish the tie.
798 \begin_layout Description
802 \begin_layout Subsection*
806 \begin_layout Description
807 Action Adds a tilde over the next character typed.
810 \begin_layout Description
814 \begin_layout Subsection*
818 \begin_layout Description
819 Action Adds an umlaut over the next character typed.
822 \begin_layout Description
826 \begin_layout Subsection*
830 \begin_layout Description
831 Action Adds a bar under the next character typed.
834 \begin_layout Description
835 Syntax accent-underbar
838 \begin_layout Subsection*
842 \begin_layout Description
843 Action Adds a dot under the next character typed.
846 \begin_layout Description
847 Syntax accent-underdot
850 \begin_layout Subsection*
854 \begin_layout Description
855 Action Accepts all tracked changes in the document.
858 \begin_layout Description
859 Syntax all-changes-accept
862 \begin_layout Description
863 Origin Levon, 16 Oct 2002
866 \begin_layout Subsection*
870 \begin_layout Description
871 Action Rejects all tracked changes in the document.
874 \begin_layout Description
875 Notion Reject does not work recursively; the user may have to repeat the operation.
878 \begin_layout Description
879 Syntax all-changes-reject
882 \begin_layout Description
883 Origin Levon, 16 Oct 2002
886 \begin_layout Subsection*
890 \begin_layout Description
891 Action Start (or remove) Appendix on the given cursor position.
894 \begin_layout Description
898 \begin_layout Description
899 Origin ettrich, 5 May 1998
902 \begin_layout Subsection*
906 \begin_layout Description
907 Action Inserts an argument (short title) inset.
910 \begin_layout Description
911 Syntax argument-insert <argument nr>
914 \begin_layout Description
915 Params <argument nr>: see layout declarations
918 \begin_layout Description
919 Origin vermeer, 12 Aug 2002
922 \begin_layout Subsection*
926 \begin_layout Description
927 Action Adds database, which will be used for bibtex citations.
930 \begin_layout Description
931 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
934 \begin_layout Description
935 Syntax bibtex-database-add <DATABASE-NAME>
938 \begin_layout Description
939 Origin Ale, 30 May 1997
942 \begin_layout Subsection*
946 \begin_layout Description
947 Action Adds database, which will be used for bibtex citations.
950 \begin_layout Description
951 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
954 \begin_layout Description
955 Syntax bibtex-database-del <DATABASE-NAME>
958 \begin_layout Description
959 Origin Ale, 30 May 1997
962 \begin_layout Subsection*
966 \begin_layout Description
967 Action Clears the list of saved bookmarks.
970 \begin_layout Description
971 Syntax bookmark-clear
974 \begin_layout Description
975 Origin bpeng, 31 October 2006
978 \begin_layout Subsection*
982 \begin_layout Description
983 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
986 \begin_layout Description
987 Notion Bookmark 0 has a special purpose. It is automatically set
988 \begin_inset Newline newline
991 1. to the paragraph you are currently editing
992 \begin_inset Newline newline
995 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
996 \begin_inset Newline newline
999 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1002 \begin_layout Description
1003 Syntax bookmark-goto <NUMBER>
1006 \begin_layout Description
1007 Params <NUMBER>: the number of the bookmark to restore.
1010 \begin_layout Description
1011 Origin Dekel, 27 January 2001
1014 \begin_layout Subsection*
1018 \begin_layout Description
1019 Action Save a bookmark.
1022 \begin_layout Description
1023 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.
1026 \begin_layout Description
1027 Syntax bookmark-save <NUMBER>
1030 \begin_layout Description
1031 Params <NUMBER>: the number of the bookmark to save.
1034 \begin_layout Description
1035 Origin Dekel, 27 January 2001
1038 \begin_layout Subsection*
1042 \begin_layout Description
1043 Action Inserts Box inset.
1046 \begin_layout Description
1047 Syntax box-insert [<TYPE>]
1050 \begin_layout Description
1051 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1052 \begin_inset Newline newline
1055 Framed is the default one.
1058 \begin_layout Description
1059 Origin vermeer, 7 Oct 2003
1062 \begin_layout Subsection*
1066 \begin_layout Description
1067 Action Inserts branch inset.
1070 \begin_layout Description
1071 Syntax branch-insert <BRANCH-NAME>
1074 \begin_layout Description
1075 Origin vermeer, 17 Aug 2003
1078 \begin_layout Subsection*
1082 \begin_layout Description
1083 Action Move the cursor to the beginning of the document.
1086 \begin_layout Description
1090 \begin_layout Subsection*
1094 \begin_layout Description
1095 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1098 \begin_layout Description
1099 Syntax buffer-begin-select
1102 \begin_layout Subsection*
1106 \begin_layout Description
1107 Action Move the cursor to the end of the document.
1110 \begin_layout Description
1114 \begin_layout Subsection*
1118 \begin_layout Description
1119 Action Move the cursor to the end of the document adding the traversed text to the selection.
1122 \begin_layout Description
1123 Syntax buffer-end-select
1126 \begin_layout Subsection*
1130 \begin_layout Description
1131 Action Inserts a caption inset.
1134 \begin_layout Description
1135 Syntax caption-insert
1138 \begin_layout Description
1139 Origin Lgb, 18 Jul 2000
1142 \begin_layout Subsection*
1146 \begin_layout Description
1147 Action Moves the cursor to the previous cell inside the table.
1150 \begin_layout Description
1151 Syntax cell-backward
1154 \begin_layout Description
1155 Origin Jug, 22 May 2000
1158 \begin_layout Subsection*
1162 \begin_layout Description
1163 Action Moves the cursor to the next cell inside the table.
1166 \begin_layout Description
1170 \begin_layout Subsection*
1174 \begin_layout Description
1175 Action Splits cell and shifts right part to the next cell (inside the math grid).
1178 \begin_layout Description
1182 \begin_layout Description
1183 Origin Ale, 15 May 1997
1186 \begin_layout Subsection*
1190 \begin_layout Description
1191 Action Accepts tracked change inside the selection.
1194 \begin_layout Description
1195 Syntax change-accept
1198 \begin_layout Description
1199 Origin Levon, 16 Oct 2002
1202 \begin_layout Subsection*
1206 \begin_layout Description
1207 Action Moves the cursor to the position of the next change of the change tracking records.
1210 \begin_layout Description
1214 \begin_layout Description
1215 Origin schmitt, 4 Oct 2006
1218 \begin_layout Subsection*
1222 \begin_layout Description
1223 Action Moves the cursor to the position of the previous change of the change tracking records.
1226 \begin_layout Description
1227 Syntax change-previous
1230 \begin_layout Description
1231 Origin vfr, 4 Apr 2009
1234 \begin_layout Subsection*
1238 \begin_layout Description
1239 Action Rejects tracked change inside the selection.
1242 \begin_layout Description
1243 Syntax change-reject
1246 \begin_layout Description
1247 Origin Levon, 16 Oct 2002
1250 \begin_layout Subsection*
1254 \begin_layout Description
1255 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1258 \begin_layout Description
1259 Syntax changes-merge
1262 \begin_layout Description
1263 Origin Levon, 16 Oct 2002
1266 \begin_layout Subsection*
1270 \begin_layout Description
1271 Action Toggles showing of change tracking in typeset output.
1274 \begin_layout Description
1275 Syntax changes-output
1278 \begin_layout Description
1279 Origin jspitzm, 21 Jan 2005
1282 \begin_layout Subsection*
1286 \begin_layout Description
1287 Action Toggles change tracking to on/off.
1290 \begin_layout Description
1291 Syntax changes-track
1294 \begin_layout Description
1295 Origin levon, 1 Oct 2002
1298 \begin_layout Subsection*
1302 \begin_layout Description
1303 Action Moves the cursor one position logically backwards.
1306 \begin_layout Description
1307 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.
1310 \begin_layout Description
1311 Syntax char-backward
1314 \begin_layout Subsection*
1315 char-backward-select
1318 \begin_layout Description
1319 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1322 \begin_layout Description
1323 Notion See also LFUN_CHAR_BACKWARD.
1326 \begin_layout Description
1327 Syntax char-backward-select
1330 \begin_layout Subsection*
1331 char-delete-backward
1334 \begin_layout Description
1335 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1338 \begin_layout Description
1339 Syntax char-delete-backward [force]
1342 \begin_layout Description
1343 Params force: Delete big insets, do not only select them.
1346 \begin_layout Subsection*
1350 \begin_layout Description
1351 Action Deletes one character in the backward direction (usually the "Delete" key).
1354 \begin_layout Description
1355 Syntax char-delete-forward [force]
1358 \begin_layout Description
1359 Params force: Delete big insets, do not only select them.
1362 \begin_layout Subsection*
1366 \begin_layout Description
1367 Action Moves the cursor one position logically forward.
1370 \begin_layout Description
1371 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.
1374 \begin_layout Description
1378 \begin_layout Subsection*
1382 \begin_layout Description
1383 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1386 \begin_layout Description
1387 Notion See also LFUN_CHAR_FORWARD.
1390 \begin_layout Description
1391 Syntax char-forward-select
1394 \begin_layout Subsection*
1398 \begin_layout Description
1399 Action Moves the cursor one position "to the left".
1402 \begin_layout Description
1403 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.
1406 \begin_layout Description
1410 \begin_layout Subsection*
1414 \begin_layout Description
1415 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1418 \begin_layout Description
1419 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1422 \begin_layout Description
1423 Syntax char-left-select
1426 \begin_layout Subsection*
1430 \begin_layout Description
1431 Action Moves the cursor one position "to the right".
1434 \begin_layout Description
1435 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.
1438 \begin_layout Description
1442 \begin_layout Subsection*
1446 \begin_layout Description
1447 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1450 \begin_layout Description
1451 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1454 \begin_layout Description
1455 Syntax char-right-select
1458 \begin_layout Subsection*
1462 \begin_layout Description
1463 Action Transposes the character at the cursor with the one before it.
1466 \begin_layout Description
1467 Syntax chars-transpose
1470 \begin_layout Description
1471 Origin Lgb, 25 Apr 2001
1474 \begin_layout Subsection*
1478 \begin_layout Description
1479 Action Inserts citation from loaded citation database.
1482 \begin_layout Description
1483 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1486 \begin_layout Description
1487 Params <KEY>: Citation (shortcut listed in available citations).
1488 \begin_inset Newline newline
1491 <TEXT_BEFORE>: text which should appear before citation.
1494 \begin_layout Description
1495 Origin AAS, 97-02-23
1498 \begin_layout Subsection*
1502 \begin_layout Description
1503 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.
1506 \begin_layout Description
1507 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.
1510 \begin_layout Description
1511 Syntax clipboard-paste [<ARG>]
1514 \begin_layout Description
1515 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1518 \begin_layout Description
1519 Origin Georg, 10 Jul 2006
1522 \begin_layout Subsection*
1523 clipboard-paste-simple
1526 \begin_layout Description
1527 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.
1530 \begin_layout Description
1531 Syntax clipboard-paste-simple [<ARG>]
1534 \begin_layout Description
1535 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1538 \begin_layout Subsection*
1542 \begin_layout Description
1543 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1546 \begin_layout Description
1547 Notion Usually bound to M-x shortcut.
1550 \begin_layout Description
1551 Syntax command-execute
1554 \begin_layout Subsection*
1558 \begin_layout Description
1559 Action Try to complete the word or command at the cursor position.
1562 \begin_layout Description
1566 \begin_layout Description
1567 Origin sts, Feb 19 2008
1570 \begin_layout Subsection*
1574 \begin_layout Description
1575 Action Accept suggested completion.
1578 \begin_layout Description
1579 Syntax completion-accept
1582 \begin_layout Description
1583 Origin sanda, Sep 08 2008
1586 \begin_layout Subsection*
1590 \begin_layout Description
1591 Action Try to cancel completion, either the popup or the inline completion.
1594 \begin_layout Description
1595 Syntax completion-cancel
1598 \begin_layout Description
1599 Origin sts, Sep 07 2008
1602 \begin_layout Subsection*
1606 \begin_layout Description
1607 Action Show the inline completion at the cursor position.
1610 \begin_layout Description
1611 Syntax completion-inline
1614 \begin_layout Description
1615 Origin sts, Feb 19 2008
1618 \begin_layout Subsection*
1622 \begin_layout Description
1623 Action Show the completion popup at the cursor position.
1626 \begin_layout Description
1627 Syntax completion-popup
1630 \begin_layout Description
1631 Origin sts, Feb 19 2008
1634 \begin_layout Subsection*
1638 \begin_layout Description
1639 Action Copies the current selection to the clipboard.
1642 \begin_layout Description
1646 \begin_layout Subsection*
1650 \begin_layout Description
1651 Action Cuts to the clipboard.
1654 \begin_layout Description
1658 \begin_layout Subsection*
1662 \begin_layout Description
1663 Action Inserts the current date.
1666 \begin_layout Description
1667 Syntax date-insert [<ARG>]
1670 \begin_layout Description
1671 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.
1674 \begin_layout Description
1675 Origin jdblair, 31 Jan 2000
1678 \begin_layout Subsection*
1682 \begin_layout Description
1683 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1686 \begin_layout Description
1687 Syntax depth-decrement
1690 \begin_layout Subsection*
1694 \begin_layout Description
1695 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1698 \begin_layout Description
1699 Syntax depth-increment
1702 \begin_layout Subsection*
1703 dialog-disconnect-inset
1706 \begin_layout Description
1707 Action Closes opened connection to opened inset.
1710 \begin_layout Description
1711 Notion Connection is used for apply functions.
1714 \begin_layout Description
1715 Syntax dialog-disconnect-inset <INSET-NAME>
1718 \begin_layout Description
1719 Origin leeming, 25 Feb 2003
1722 \begin_layout Subsection*
1726 \begin_layout Description
1727 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1730 \begin_layout Description
1731 Syntax dialog-hide <NAME>
1734 \begin_layout Description
1735 Params See LFUN_DIALOG_SHOW .
1738 \begin_layout Description
1739 Origin leeming, 25 Feb 2003
1742 \begin_layout Subsection*
1746 \begin_layout Description
1747 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1750 \begin_layout Description
1751 Syntax dialog-show <NAME> [<DATA>]
1754 \begin_layout Description
1755 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1756 \begin_inset Newline newline
1759 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1760 \begin_inset Newline newline
1763 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1764 \begin_inset Newline newline
1767 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1768 \begin_inset Newline newline
1771 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1772 \begin_inset Newline newline
1775 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1776 \begin_inset Newline newline
1779 <SPECIAL>: latexlog|vclog
1780 \begin_inset Newline newline
1783 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1786 \begin_layout Description
1787 Origin leeming, 17 Jun 2003
1790 \begin_layout Subsection*
1791 dialog-show-new-inset
1794 \begin_layout Description
1795 Action Shows hidden dialog or create new one for a given inset settings etc.
1798 \begin_layout Description
1799 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1802 \begin_layout Description
1803 Syntax dialog-show-new-inset <NAME> [<DATA>]
1806 \begin_layout Description
1807 Params See LFUN_DIALOG_SHOW .
1810 \begin_layout Description
1811 Origin leeming, 25 Feb 2003
1814 \begin_layout Subsection*
1818 \begin_layout Description
1819 Action Toggles dialog between showed/hidden state.
1822 \begin_layout Description
1823 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1826 \begin_layout Description
1827 Syntax dialog-toggle <NAME> [<DATA>]
1830 \begin_layout Description
1831 Params See LFUN_DIALOG_SHOW .
1834 \begin_layout Description
1835 Origin JSpitzm, 30 Apr 2007
1838 \begin_layout Subsection*
1842 \begin_layout Description
1843 Action Updates the dialog values from the inset/paragraph/document.
1846 \begin_layout Description
1847 Syntax dialog-update <NAME>
1850 \begin_layout Description
1851 Params <NAME>: paragraph|prefs|<INSET>
1852 \begin_inset Newline newline
1858 \begin_layout Description
1859 Origin leeming, 25 Feb 2003
1862 \begin_layout Subsection*
1866 \begin_layout Description
1867 Action Moves the cursor one line in downward direction.
1870 \begin_layout Description
1874 \begin_layout Subsection*
1878 \begin_layout Description
1879 Action Moves the cursor one line in downward direction adding the current position to the selection.
1882 \begin_layout Description
1886 \begin_layout Subsection*
1890 \begin_layout Description
1891 Action Inserts an ERT inset.
1894 \begin_layout Description
1898 \begin_layout Description
1899 Origin Jug, 18 Feb 2000
1902 \begin_layout Subsection*
1906 \begin_layout Description
1907 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1910 \begin_layout Description
1914 \begin_layout Description
1915 Origin Lgb, 17 May 2001
1918 \begin_layout Subsection*
1922 \begin_layout Description
1923 Action Inserts another LyX file.
1926 \begin_layout Description
1927 Syntax file-insert [<FILE>]
1930 \begin_layout Description
1931 Params <FILE>: Filename to be inserted.
1934 \begin_layout Subsection*
1935 file-insert-plaintext
1938 \begin_layout Description
1939 Action Inserts plain text file.
1942 \begin_layout Description
1943 Syntax file-insert-plaintext [<FILE>]
1946 \begin_layout Description
1947 Params <FILE>: Filename to be inserted.
1950 \begin_layout Description
1951 Origin CFO-G, 19 Nov 1997
1954 \begin_layout Subsection*
1955 file-insert-plaintext-para
1958 \begin_layout Description
1959 Action Inserts plain text file as paragraph (i.e. join lines).
1962 \begin_layout Description
1963 Syntax file-insert-plaintext-para [<FILE>]
1966 \begin_layout Description
1967 Params <FILE>: Filename to be inserted.
1970 \begin_layout Description
1971 Origin Levon, 14 Feb 2001
1974 \begin_layout Subsection*
1978 \begin_layout Description
1979 Action Inserts CharStyle, Custom inset or XML short element.
1982 \begin_layout Description
1983 Notion Look into the Customization manual for more information about these elements.
1984 \begin_inset Newline newline
1987 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.
1988 \begin_inset Newline newline
1991 For dissolving the element see LFUN_INSET_DISSOLVE.
1994 \begin_layout Description
1995 Syntax flex-insert Name
1998 \begin_layout Description
1999 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.
2002 \begin_layout Description
2003 Sample flex-insert Code
2006 \begin_layout Subsection*
2010 \begin_layout Description
2011 Action Inserts a float inset.
2014 \begin_layout Description
2015 Syntax float-insert <TYPE>
2018 \begin_layout Description
2019 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2022 \begin_layout Description
2023 Origin Lgb, 27 Jun 2000
2026 \begin_layout Subsection*
2030 \begin_layout Description
2031 Action Inserts the list of floats in the document.
2034 \begin_layout Description
2035 Syntax float-list-insert <TYPE>
2038 \begin_layout Description
2039 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2042 \begin_layout Description
2043 Origin Lgb, 3 May 2001
2046 \begin_layout Subsection*
2050 \begin_layout Description
2051 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2054 \begin_layout Description
2055 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2058 \begin_layout Description
2059 Syntax float-wide-insert <TYPE>
2062 \begin_layout Description
2063 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2066 \begin_layout Description
2067 Origin Lgb, 31 Oct 2001
2070 \begin_layout Subsection*
2074 \begin_layout Description
2075 Action Inserts a footnote inset.
2078 \begin_layout Description
2079 Syntax footnote-insert
2082 \begin_layout Description
2083 Origin Jug, 7 Mar 2000
2086 \begin_layout Subsection*
2090 \begin_layout Description
2091 Action Reloads the image if necessary.
2094 \begin_layout Description
2095 Syntax graphics-reload
2098 \begin_layout Description
2099 Origin vfr, 10 Aug 2009
2102 \begin_layout Subsection*
2106 \begin_layout Description
2107 Action Inserts hyperlinks into the document (clickable in pdf output).
2110 \begin_layout Description
2111 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2114 \begin_layout Description
2115 Syntax href-insert [<TARGET>]
2118 \begin_layout Description
2119 Origin CFO-G, 21 Nov 1997
2122 \begin_layout Subsection*
2126 \begin_layout Description
2127 Action Only active in IPA inset.
2130 \begin_layout Description
2131 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.
2134 \begin_layout Description
2138 \begin_layout Description
2139 Origin spitz, 20 May 2012
2142 \begin_layout Subsection*
2146 \begin_layout Description
2147 Action Inserts Index entry.
2150 \begin_layout Description
2151 Notion It automatically takes the word on the cursor position.
2154 \begin_layout Description
2155 Syntax index-insert [<TYPE:Name>]
2158 \begin_layout Description
2159 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2162 \begin_layout Description
2163 Origin leeming, 3 Aug 2000
2166 \begin_layout Subsection*
2170 \begin_layout Description
2171 Action Inserts list of Index entries on a new page.
2174 \begin_layout Description
2175 Syntax index-print [<TYPE:Name>]
2178 \begin_layout Description
2179 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2182 \begin_layout Description
2183 Origin Lgb, 27 Feb 1997
2186 \begin_layout Subsection*
2190 \begin_layout Description
2191 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2194 \begin_layout Description
2195 Notion Apart from lfun arguments you can use the following method:
2196 \begin_inset Newline newline
2199 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2200 \begin_inset Newline newline
2203 2. select the text and run info-insert lfun.
2206 \begin_layout Description
2207 Syntax info-insert <TYPE> <ARG>
2210 \begin_layout Description
2211 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
2212 \begin_inset Newline newline
2215 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2216 \begin_inset Newline newline
2219 shortcut[s]: name of lfun (e.g math-insert
2222 \begin_inset Newline newline
2225 lyxrc: name of rc_entry (e.g. bind_file)
2226 \begin_inset Newline newline
2229 lyxinfo: "version" - used version of LyX
2230 \begin_inset Newline newline
2233 package: name of latex package (e.g. listings)
2234 \begin_inset Newline newline
2237 textclass: name of textclass (e.g. article)
2238 \begin_inset Newline newline
2241 menu: name of lfun used in menu
2242 \begin_inset Newline newline
2245 icon: icon of lfun used in toolbar or direct icon name
2246 \begin_inset Newline newline
2249 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
2252 \begin_layout Description
2253 Sample command-sequence info-insert buffer path; info-insert buffer name
2256 \begin_layout Description
2257 Origin bpeng, 7 Oct 2007
2260 \begin_layout Subsection*
2264 \begin_layout Description
2265 Action Apply data for an inset.
2268 \begin_layout Description
2269 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.
2272 \begin_layout Description
2273 Syntax inset-apply <ARGS>
2276 \begin_layout Description
2277 Params See LFUN_INSET_INSERT .
2280 \begin_layout Subsection*
2284 \begin_layout Description
2285 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
2288 \begin_layout Description
2292 \begin_layout Description
2293 Origin lasgouttes, 16 Mar 2009
2296 \begin_layout Subsection*
2300 \begin_layout Description
2301 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).
2304 \begin_layout Description
2305 Syntax inset-begin-select
2308 \begin_layout Description
2309 Origin lasgouttes, 16 Mar 2009
2312 \begin_layout Subsection*
2316 \begin_layout Description
2317 Action Copies the inset to the clipboard as a certain type.
2320 \begin_layout Description
2321 Notion Currently used only for InsetInfo where its content is copied as a text.
2324 \begin_layout Description
2325 Syntax inset-copy-as
2328 \begin_layout Description
2329 Origin vfr, 18 Apr 2010
2332 \begin_layout Subsection*
2336 \begin_layout Description
2337 Action Dissolve the current inset into text.
2340 \begin_layout Description
2341 Syntax inset-dissolve [<INSET>]
2344 \begin_layout Description
2345 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.
2346 \begin_inset Newline newline
2349 For values see lyx::InsetLayout::lyxtype_ .
2352 \begin_layout Description
2353 Origin JSpitz, 7 Aug 2006
2356 \begin_layout Subsection*
2360 \begin_layout Description
2361 Action Edit the inset at cursor with an external application, if one is attributed.
2364 \begin_layout Description
2365 Syntax inset-edit [<INSET_PARAMS>]
2368 \begin_layout Description
2369 Params <INSET_PARAMS>: Parameters for the inset.
2370 \begin_inset Newline newline
2373 Currently only the filename will be considered.
2376 \begin_layout Description
2377 Origin JSpitzm, 27 Apr 2006
2380 \begin_layout Subsection*
2384 \begin_layout Description
2385 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
2388 \begin_layout Description
2392 \begin_layout Description
2393 Origin lasgouttes, 16 Mar 2009
2396 \begin_layout Subsection*
2400 \begin_layout Description
2401 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).
2404 \begin_layout Description
2405 Syntax inset-end-select
2408 \begin_layout Description
2409 Origin lasgouttes, 16 Mar 2009
2412 \begin_layout Subsection*
2416 \begin_layout Description
2417 Action Apply the given commands on insets of a given name.
2420 \begin_layout Description
2421 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.
2424 \begin_layout Description
2425 Syntax inset-forall <NAME> <LFUN-COMMAND>
2426 \begin_inset Newline newline
2429 <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.
2432 \begin_layout Description
2433 Sample Remove all index insets:
2434 \begin_inset Newline newline
2437 inset-forall Index char-delete-forward force
2438 \begin_inset Newline newline
2441 Close all Notes (also works for a particular branch, for example):
2442 \begin_inset Newline newline
2445 inset-forall Note inset-toggle close
2446 \begin_inset Newline newline
2449 Transform all yellow notes to comments
2450 \begin_inset Newline newline
2453 inset-forall Note:Note inset-modify note Note Comment
2454 \begin_inset Newline newline
2457 Try to put LyX in an infinite loop if there is at least a Note:
2458 \begin_inset Newline newline
2461 inset-forall Note char-backward
2464 \begin_layout Description
2465 Origin lasgouttes, 27 Nov 2009
2468 \begin_layout Subsection*
2472 \begin_layout Description
2473 Action Insert new inset (type given by the parameters).
2476 \begin_layout Description
2477 Syntax inset-insert <INSET> <ARGS>
2480 \begin_layout Description
2481 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2482 \begin_inset Newline newline
2485 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2486 \begin_inset Newline newline
2489 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2492 \begin_layout Description
2493 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2496 \begin_inset Newline newline
2499 where <label name> is the name of the referenced label and <Format> is one of the following:
2500 \begin_inset Newline newline
2504 \begin_inset Newline newline
2507 eqref -- (<reference>)
2508 \begin_inset Newline newline
2512 \begin_inset Newline newline
2515 vpageref -- on <page>
2516 \begin_inset Newline newline
2519 vref -- <reference> on <page>
2520 \begin_inset Newline newline
2523 formatted -- Formatted reference
2526 \begin_layout Subsection*
2530 \begin_layout Description
2531 Action Modify some properties of an inset.
2534 \begin_layout Description
2535 Notion Used for argument, bibitem, bibtex, box, branch, caption, citation, command, ert, external, float, graphics, include, index, info, label, line, listings, newline, newpage, nomencl, note, phantom, quotes, ref, script, separator, space, tabular, vspace and wrap insets.
2538 \begin_layout Description
2539 Syntax inset-modify <INSET> <ARGS>
2540 \begin_inset Newline newline
2543 inset-modify changetype <TYPE>
2546 \begin_layout Description
2547 Sample Change a Note inset into a Comment inset:
2548 \begin_inset Newline newline
2551 inset-modify note Note Comment
2552 \begin_inset Newline newline
2555 Change a Box into an Ovalbox:
2556 \begin_inset Newline newline
2559 inset-modify changetype Ovalbox
2560 \begin_inset Newline newline
2563 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
2564 \begin_inset Newline newline
2567 inset-modify changetype els
2568 \begin_inset Newline newline
2571 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
2572 \begin_inset Newline newline
2575 inset-modify changetype e..
2576 \begin_inset Newline newline
2582 \begin_layout Subsection*
2586 \begin_layout Description
2587 Action Select all contents of an inset.
2590 \begin_layout Description
2591 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2594 \begin_layout Description
2595 Syntax inset-select-all
2598 \begin_layout Description
2599 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2602 \begin_layout Subsection*
2606 \begin_layout Description
2607 Action Open the inset's properties dialog.
2610 \begin_layout Description
2611 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.
2614 \begin_layout Description
2615 Syntax inset-settings <INSET>
2618 \begin_layout Description
2619 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2620 \begin_inset Newline newline
2623 graphics|href|include|index|index_print|label|line|
2624 \begin_inset Newline newline
2627 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2630 \begin_layout Subsection*
2634 \begin_layout Description
2635 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2638 \begin_layout Description
2639 Syntax inset-toggle [<ARG>]
2642 \begin_layout Description
2643 Params <ARG>: <open|close|toggle|assign>.
2644 \begin_inset Newline newline
2647 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2648 \begin_inset Newline newline
2651 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2654 \begin_layout Description
2655 Origin lasgouttes, 19 Jul 2001
2658 \begin_layout Subsection*
2662 \begin_layout Description
2663 Action Inserts an IPA inset.
2666 \begin_layout Description
2670 \begin_layout Description
2671 Origin spitz, 05 Mar 2012
2674 \begin_layout Subsection*
2678 \begin_layout Description
2679 Action Inserts special IPA macros into the document.
2682 \begin_layout Description
2683 Syntax ipamacro-insert <CHAR>
2686 \begin_layout Description
2687 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2690 \begin_layout Description
2691 Origin JSpitzm, 22 Aug 2012
2694 \begin_layout Subsection*
2698 \begin_layout Description
2699 Action Turn off the loaded keyboard map.
2702 \begin_layout Description
2706 \begin_layout Subsection*
2710 \begin_layout Description
2711 Action Turn on the primary keyboard map.
2714 \begin_layout Description
2715 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.
2716 \begin_inset Newline newline
2719 The language is to be set in the Preferences dialog.
2722 \begin_layout Description
2723 Syntax keymap-primary
2726 \begin_layout Subsection*
2730 \begin_layout Description
2731 Action Turn on the secondary keyboard map.
2734 \begin_layout Description
2735 Syntax keymap-secondary
2738 \begin_layout Subsection*
2742 \begin_layout Description
2743 Action Toggles keyboard maps (first/second/off).
2746 \begin_layout Description
2747 Syntax keymap-toggle
2750 \begin_layout Description
2751 Origin leeming, 30 Mar 2004
2754 \begin_layout Subsection*
2755 label-copy-as-reference
2758 \begin_layout Description
2759 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2762 \begin_layout Description
2763 Syntax copy-label-as-reference <LABEL>
2766 \begin_layout Description
2767 Params <LABEL>: The label to copy (for multi-line math)
2770 \begin_layout Description
2771 Origin sts, 16 Nov 2008
2774 \begin_layout Subsection*
2778 \begin_layout Description
2779 Action Goto a label.
2782 \begin_layout Description
2783 Syntax label-goto [<LABEL>]
2786 \begin_layout Description
2787 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.
2790 \begin_layout Description
2791 Origin Ale, 6 Aug 1997
2794 \begin_layout Subsection*
2798 \begin_layout Description
2799 Action Inserts label to text or displayed formula.
2802 \begin_layout Description
2803 Syntax label-insert [<LABEL>]
2806 \begin_layout Description
2807 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2810 \begin_layout Subsection*
2811 label-insert-as-reference
2814 \begin_layout Description
2815 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2818 \begin_layout Description
2819 Syntax label-insert-as-reference
2822 \begin_layout Description
2823 Origin vfr, 7 Apr 2009
2826 \begin_layout Subsection*
2830 \begin_layout Description
2831 Action Set language from the current cursor position.
2834 \begin_layout Description
2835 Syntax language <LANG> [set]
2838 \begin_layout Description
2839 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).
2842 \begin_layout Description
2843 Origin Dekel, 2 Mar 2000
2846 \begin_layout Subsection*
2850 \begin_layout Description
2851 Action Move the cursor to the beginning of the (screen) line.
2854 \begin_layout Description
2858 \begin_layout Subsection*
2862 \begin_layout Description
2863 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2866 \begin_layout Description
2867 Syntax line-begin-select
2870 \begin_layout Subsection*
2874 \begin_layout Description
2875 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2878 \begin_layout Description
2879 Syntax line-delete-forward
2882 \begin_layout Subsection*
2886 \begin_layout Description
2887 Action Move the cursor to the end of the (screen) line.
2890 \begin_layout Description
2894 \begin_layout Subsection*
2898 \begin_layout Description
2899 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2902 \begin_layout Description
2903 Syntax line-end-select
2906 \begin_layout Subsection*
2910 \begin_layout Description
2911 Action Inserts a new listings inset.
2914 \begin_layout Description
2915 Syntax listing-insert
2918 \begin_layout Description
2919 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2922 \begin_layout Subsection*
2926 \begin_layout Description
2927 Action Inserts a marginal note.
2930 \begin_layout Description
2931 Syntax marginalnote-insert
2934 \begin_layout Description
2935 Origin Lgb, 26 Jun 2000
2938 \begin_layout Subsection*
2942 \begin_layout Description
2943 Action Disable selecting of text-region.
2946 \begin_layout Description
2950 \begin_layout Subsection*
2954 \begin_layout Description
2955 Action Enable selecting of text-region.
2958 \begin_layout Description
2959 Notion After enabling you can simply move arrow keys to get selected region.
2962 \begin_layout Description
2966 \begin_layout Subsection*
2970 \begin_layout Description
2971 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2974 \begin_layout Description
2978 \begin_layout Description
2979 Origin Andre, May 5 2006
2982 \begin_layout Subsection*
2986 \begin_layout Description
2987 Action Inserts a line break or new line.
2990 \begin_layout Description
2991 Syntax newline-insert [<ARG>]
2994 \begin_layout Description
2995 Params <ARG>: <newline|linebreak> default: newline
2998 \begin_layout Description
2999 Origin JSpitzm, 25 Mar 2008
3002 \begin_layout Subsection*
3006 \begin_layout Description
3007 Action Inserts a new page.
3010 \begin_layout Description
3011 Syntax newpage-insert <ARG>
3014 \begin_layout Description
3015 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3018 \begin_layout Description
3019 Origin uwestoehr, 24 Nov 2007
3022 \begin_layout Subsection*
3026 \begin_layout Description
3027 Action Inserts Nomenclature entry.
3030 \begin_layout Description
3031 Notion It automatically takes the word on the cursor position if no symbol is given.
3034 \begin_layout Description
3035 Syntax nomencl-insert [<SYMBOL>]
3038 \begin_layout Description
3039 Origin Ugras, 4 Nov 2006
3042 \begin_layout Subsection*
3046 \begin_layout Description
3047 Action Inserts list of Nomenclature entries.
3050 \begin_layout Description
3051 Syntax nomenclature-print
3054 \begin_layout Description
3055 Origin Ugras, 4 Nov 2006
3058 \begin_layout Subsection*
3062 \begin_layout Description
3063 Action Inserts Note on the current cursor position, move selection inside the inset.
3066 \begin_layout Description
3067 Syntax note-insert [<TYPE>]
3070 \begin_layout Description
3071 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3074 \begin_layout Subsection*
3078 \begin_layout Description
3079 Action Moves the cursor to the beginning of next Note inset.
3082 \begin_layout Description
3086 \begin_layout Subsection*
3090 \begin_layout Description
3091 Action Move the current group in the downward direction in the structure of the document.
3094 \begin_layout Description
3095 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3098 \begin_layout Description
3102 \begin_layout Description
3103 Origin Vermeer, 23 Mar 2006
3106 \begin_layout Subsection*
3110 \begin_layout Description
3111 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3114 \begin_layout Description
3115 Notion Part -> Chapter -> Section -> etc.
3118 \begin_layout Description
3122 \begin_layout Description
3123 Origin Vermeer, 23 Mar 2006
3126 \begin_layout Subsection*
3130 \begin_layout Description
3131 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3134 \begin_layout Description
3135 Notion Part <- Chapter <- Section <- etc.
3138 \begin_layout Description
3142 \begin_layout Description
3143 Origin Vermeer, 23 Mar 2006
3146 \begin_layout Subsection*
3150 \begin_layout Description
3151 Action Move the current group in the upward direction in the structure of the document.
3154 \begin_layout Description
3155 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3158 \begin_layout Description
3162 \begin_layout Description
3163 Origin Vermeer, 23 Mar 2006
3166 \begin_layout Subsection*
3170 \begin_layout Description
3171 Action Breaks the current paragraph at the current location.
3174 \begin_layout Description
3175 Notion Removes the selection.
3178 \begin_layout Description
3179 Syntax paragraph-break [<LAYOUT>]
3182 \begin_layout Description
3183 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3186 \begin_layout Subsection*
3190 \begin_layout Description
3191 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3194 \begin_layout Description
3195 Syntax paragraph-down
3198 \begin_layout Description
3199 Origin Asger, 1 Oct 1996
3202 \begin_layout Subsection*
3203 paragraph-down-select
3206 \begin_layout Description
3207 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3210 \begin_layout Description
3211 Syntax paragraph-down-select
3214 \begin_layout Description
3215 Origin Asger, 1 Oct 1996
3218 \begin_layout Subsection*
3222 \begin_layout Description
3223 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph. If given four arguments id_start, pos_start, id_end, pos_end, perform a selection from start to end.
3226 \begin_layout Description
3227 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). Both ids must belong to the same buffer.
3230 \begin_layout Description
3231 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3234 \begin_layout Description
3235 Params <PAR_ID>: paragraph id
3236 \begin_inset Newline newline
3239 <POS_IN_PAR>: desired position within the paragraph
3242 \begin_layout Description
3243 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3246 \begin_layout Subsection*
3250 \begin_layout Description
3251 Action Moves the current paragraph downwards in the document.
3254 \begin_layout Description
3255 Syntax paragraph-move-down
3258 \begin_layout Description
3259 Origin Edwin, 8 Apr 2006
3262 \begin_layout Subsection*
3266 \begin_layout Description
3267 Action Moves the current paragraph upwards in the document.
3270 \begin_layout Description
3271 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3274 \begin_layout Description
3275 Syntax paragraph-move-up
3278 \begin_layout Description
3279 Origin Edwin, 8 Apr 2006
3282 \begin_layout Subsection*
3286 \begin_layout Description
3287 Action Change paragraph settings.
3290 \begin_layout Description
3291 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.
3294 \begin_layout Description
3295 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3298 \begin_layout Description
3308 \begin_inset Newline newline
3313 paragraph_spacing default|single|onehalf|double|other SIZE
3314 \begin_inset Newline newline
3319 align block|left|right|center|default
3320 \begin_inset Newline newline
3325 labelwidthstring WIDTH|
3330 \begin_layout Description
3331 Origin rgh, Aug 15 2007
3334 \begin_layout Subsection*
3335 paragraph-params-apply
3338 \begin_layout Description
3339 Action Change paragraph settings.
3342 \begin_layout Description
3343 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3346 \begin_layout Description
3347 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3350 \begin_layout Description
3351 Params For parameters see LFUN_PARAGRAPH_PARAMS
3354 \begin_layout Description
3355 Origin leeming, 30 Mar 2004
3358 \begin_layout Subsection*
3362 \begin_layout Description
3363 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3366 \begin_layout Description
3370 \begin_layout Description
3371 Origin Asger, 1 Oct 1996
3374 \begin_layout Subsection*
3378 \begin_layout Description
3379 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3382 \begin_layout Description
3383 Syntax paragraph-up-select
3386 \begin_layout Description
3387 Origin Asger, 1 Oct 1996
3390 \begin_layout Subsection*
3394 \begin_layout Description
3395 Action Pastes material (text or picture) from the active clipboard.
3398 \begin_layout Description
3399 Syntax paste [<TYPE>|<NUM>]
3402 \begin_layout Description
3403 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3404 \begin_inset Newline newline
3407 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3410 \begin_layout Subsection*
3414 \begin_layout Description
3415 Action Inserts phantom on the current cursor position, move selection inside the inset.
3418 \begin_layout Description
3419 Syntax phantom-insert [<TYPE>]
3422 \begin_layout Description
3423 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3426 \begin_layout Description
3427 Origin uwestoehr, 30 Jan 2009
3430 \begin_layout Subsection*
3434 \begin_layout Description
3435 Action Inserts a new preview inset.
3438 \begin_layout Description
3439 Syntax preview-insert
3442 \begin_layout Description
3443 Origin vfr, 28 Mar 2010
3446 \begin_layout Subsection*
3447 primary-selection-paste
3450 \begin_layout Description
3451 Action Pastes the currently selected text.
3454 \begin_layout Description
3455 Notion Primary selection mechanism is linux-only thing.
3458 \begin_layout Description
3459 Syntax primary-selection-paste [<ARG>]
3462 \begin_layout Description
3463 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3466 \begin_layout Subsection*
3470 \begin_layout Description
3471 Action Inserts quotes according to the type and quote-language preference.
3474 \begin_layout Description
3475 Notion Currently 15 different quote styles are distinguished (see params).
3478 \begin_layout Description
3479 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3482 \begin_layout Description
3483 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
3484 \begin_inset Newline newline
3487 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
3488 \begin_inset Newline newline
3491 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3492 \begin_inset Newline newline
3495 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3496 \begin_inset Newline newline
3499 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3500 \begin_inset Newline newline
3503 'danish' for >>Danish<< quote style (with >inner quotation<)
3504 \begin_inset Newline newline
3507 'english' for ``English'' quote style (with `inner quotation')
3508 \begin_inset Newline newline
3511 'french' for <<french>> quote style (with ``inner quotation'')
3512 \begin_inset Newline newline
3515 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
3516 \begin_inset Newline newline
3519 'german' for ,,German`` quote style (with ,inner quotation`)
3520 \begin_inset Newline newline
3523 'plain' for "Plain" quote style (with 'inner quotation')
3524 \begin_inset Newline newline
3527 'polish' for ,,Polish'' quote style (with ,inner quotation')
3528 \begin_inset Newline newline
3531 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3532 \begin_inset Newline newline
3535 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
3536 \begin_inset Newline newline
3539 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3540 \begin_inset Newline newline
3543 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3544 \begin_inset Newline newline
3547 'dynamic' for Dynamic quotation marks which inherit the global document style
3548 \begin_inset Newline newline
3551 If no quote style is specified, the document-wide will be used.
3554 \begin_layout Subsection*
3558 \begin_layout Description
3559 Action Redoes the last thing undone.
3562 \begin_layout Description
3566 \begin_layout Subsection*
3570 \begin_layout Description
3571 Action Go to the next label or cross-reference.
3574 \begin_layout Description
3575 Syntax reference-next
3578 \begin_layout Description
3579 Origin Dekel, 14 Jan 2001
3582 \begin_layout Subsection*
3586 \begin_layout Description
3587 Action Repeat the given command.
3590 \begin_layout Description
3591 Notion fails when the repeat count is greater than 10000.
3594 \begin_layout Description
3595 Syntax repeat <COUNT> <LFUN-COMMAND>
3598 \begin_layout Description
3599 Origin Andre, 27 Oct 2003
3602 \begin_layout Subsection*
3606 \begin_layout Description
3607 Action Moves the cursor one page in downward direction.
3610 \begin_layout Description
3614 \begin_layout Subsection*
3618 \begin_layout Description
3619 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3622 \begin_layout Description
3623 Syntax screen-down-select
3626 \begin_layout Subsection*
3630 \begin_layout Description
3631 Action Recenters the screen on the current cursor position.
3634 \begin_layout Description
3635 Syntax screen-recenter
3638 \begin_layout Subsection*
3642 \begin_layout Description
3643 Action Repositions the screen such that the cursor is visible.
3646 \begin_layout Description
3647 Syntax screen-show-cursor
3650 \begin_layout Description
3651 Origin vfr, 25 Mar 2009
3654 \begin_layout Subsection*
3658 \begin_layout Description
3659 Action Moves the cursor one page in upward direction.
3662 \begin_layout Description
3666 \begin_layout Subsection*
3670 \begin_layout Description
3671 Action Moves the cursor one page in upward direction adding the current position to the selection.
3674 \begin_layout Description
3675 Syntax screen-up-select
3678 \begin_layout Subsection*
3682 \begin_layout Description
3683 Action Inserts a subscript or superscript inset.
3686 \begin_layout Description
3687 Syntax script-insert <TYPE>
3690 \begin_layout Description
3691 Params <TYPE>: subscript|superscript
3694 \begin_layout Description
3695 Origin Georg, 23 Nov 2010
3698 \begin_layout Subsection*
3702 \begin_layout Description
3703 Action Scroll the buffer view.
3706 \begin_layout Description
3707 Notion Only scrolls the screen up or down; does not move the cursor.
3710 \begin_layout Description
3711 Syntax scroll <TYPE> <QUANTITY>
3714 \begin_layout Description
3715 Params <TYPE>: line|page
3716 \begin_inset Newline newline
3719 <QUANTITY>: up|down|<number>
3722 \begin_layout Description
3723 Origin Abdel, Dec 27 2007
3726 \begin_layout Subsection*
3730 \begin_layout Description
3731 Action Select the whole section.
3734 \begin_layout Description
3735 Notion The cursor should be in a section heading before calling this lfun.
3738 \begin_layout Description
3739 Syntax section-select
3742 \begin_layout Description
3743 Origin vfr, 05 May 2009
3746 \begin_layout Subsection*
3750 \begin_layout Description
3751 Action Pastes the internal selection text in permanent selection.
3754 \begin_layout Description
3755 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3758 \begin_layout Description
3759 Syntax selection-paste
3762 \begin_layout Description
3763 Origin lasgouttes, 14 Jan 2009
3766 \begin_layout Subsection*
3770 \begin_layout Description
3771 Action Inserts an environment separator or latex paragraph break.
3774 \begin_layout Description
3775 Syntax separator-insert [<ARG>]
3778 \begin_layout Description
3779 Params <ARG>: <plain|parbreak|latexpar> default: plain
3782 \begin_layout Description
3783 Origin ef, 2 May 2014
3786 \begin_layout Subsection*
3790 \begin_layout Description
3791 Action Set the group for the graphics inset on the cursor position.
3794 \begin_layout Description
3795 Syntax set-graphics-group [<GROUP>]
3798 \begin_layout Description
3799 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3802 \begin_layout Description
3803 Origin sanda, 6 May 2008
3806 \begin_layout Subsection*
3810 \begin_layout Description
3811 Action Inserts one of horizontal space insets.
3814 \begin_layout Description
3815 Syntax space-insert <NAME> [<LEN>]
3818 \begin_layout Description
3819 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3820 \begin_inset Newline newline
3823 Only in math mode: med and thick.
3824 \begin_inset Newline newline
3827 <LEN>: length for custom spaces (hspace, hspace* for protected)
3830 \begin_layout Description
3831 Origin JSpitzm, 20 May 2003, Mar 17 2008
3834 \begin_layout Subsection*
3838 \begin_layout Description
3839 Action Inserts various characters into the document.
3842 \begin_layout Description
3843 Syntax specialchar-insert <CHAR>
3846 \begin_layout Description
3847 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3850 \begin_layout Description
3851 Origin JSpitzm, 6 Dec 2007
3854 \begin_layout Subsection*
3858 \begin_layout Description
3859 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3862 \begin_layout Description
3863 Syntax spelling-add [<STRING>] [<LANG>]
3866 \begin_layout Description
3867 Params <WORD>: word to add <LANG>: language name (see file languages)
3870 \begin_layout Description
3871 Origin JSpitzm, 18 Jan 2010
3874 \begin_layout Subsection*
3875 spelling-continuously
3878 \begin_layout Description
3879 Action Toggle continuous spell checking.
3882 \begin_layout Description
3883 Syntax spelling-continuously
3886 \begin_layout Description
3887 Origin vfr, 24 March 2013
3890 \begin_layout Subsection*
3894 \begin_layout Description
3895 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.
3898 \begin_layout Description
3899 Syntax spelling-ignore [<WORD>] [<LANG>]
3902 \begin_layout Description
3903 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3906 \begin_layout Description
3907 Origin JSpitzm, 18 Jan 2010
3910 \begin_layout Subsection*
3914 \begin_layout Description
3915 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3918 \begin_layout Description
3919 Syntax spelling-remove [<STRING>] [<LANG>]
3922 \begin_layout Description
3923 Params <WORD>: word to remove <LANG>: language name (see file languages)
3926 \begin_layout Description
3927 Origin SWitt, 28 July 2010
3930 \begin_layout Subsection*
3934 \begin_layout Description
3935 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3938 \begin_layout Description
3939 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.
3942 \begin_layout Description
3946 \begin_layout Description
3947 Origin vfr, Sep 30 2008
3950 \begin_layout Subsection*
3954 \begin_layout Description
3955 Action Insert a tab into a listings inset.
3958 \begin_layout Description
3959 Notion It also works on a selection.
3962 \begin_layout Description
3966 \begin_layout Description
3967 Origin vfr, Sep 30 2008
3970 \begin_layout Subsection*
3974 \begin_layout Description
3975 Action Modify properties of tabulars and table-like math environments.
3978 \begin_layout Description
3979 Syntax tabular-feature <FEATURE> [<ARG>]
3982 \begin_layout Description
3983 Params Generally see LFUN_INSET_INSERT for further details.
3984 \begin_inset Newline newline
3987 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
3988 \begin_inset Newline newline
3991 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
3992 \begin_inset Newline newline
3995 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3996 \begin_inset Newline newline
3999 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4000 \begin_inset Newline newline
4003 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4004 \begin_inset Newline newline
4007 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4008 \begin_inset Newline newline
4011 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4012 \begin_inset Newline newline
4015 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
4016 \begin_inset Newline newline
4019 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4020 \begin_inset Newline newline
4023 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4024 \begin_inset Newline newline
4027 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4028 \begin_inset Newline newline
4031 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4032 \begin_inset Newline newline
4035 set-special-column|set-special-multicolumn|set-special-multirow|
4036 \begin_inset Newline newline
4039 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4040 \begin_inset Newline newline
4043 set-interline-space|set-border-lines|tabular-valign-top|
4044 \begin_inset Newline newline
4047 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
4048 \begin_inset Newline newline
4051 Various math-environment features are handled as well, e.g. add-vline-left/right for
4052 \begin_inset Newline newline
4055 the Grid/Array environment.
4056 \begin_inset Newline newline
4059 <ARG>: additional argument for some commands, use debug mode to explore its values.
4062 \begin_layout Description
4063 Origin gm, 10 Dec 2015
4066 \begin_layout Subsection*
4070 \begin_layout Description
4071 Action Inserts table into the document.
4074 \begin_layout Description
4075 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4078 \begin_layout Description
4079 Syntax tabular-insert [<ROWS> <COLUMNS>]
4082 \begin_layout Description
4083 Params In case no arguments are given show insert dialog.
4086 \begin_layout Description
4087 Origin Jug, 12 Apr 2000
4090 \begin_layout Subsection*
4094 \begin_layout Description
4095 Action Look up thesaurus entries with respect to the word under the cursor.
4098 \begin_layout Description
4099 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4102 \begin_layout Description
4103 Params <STRING>: word to look up <LANG>: language (see file languages)
4106 \begin_layout Description
4107 Origin Levon, 20 Jul 2001
4110 \begin_layout Subsection*
4114 \begin_layout Description
4115 Action Undoes the last edit.
4118 \begin_layout Description
4122 \begin_layout Subsection*
4126 \begin_layout Description
4127 Action Inserts a single unicode character.
4130 \begin_layout Description
4131 Syntax unicode-insert <CHAR>
4134 \begin_layout Description
4135 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
4138 \begin_layout Description
4139 Sample unicode-insert 0x0100
4142 \begin_layout Description
4143 Origin Lgb, 22 Oct 2006
4146 \begin_layout Subsection*
4150 \begin_layout Description
4151 Action Moves the cursor one line in upward direction.
4154 \begin_layout Description
4158 \begin_layout Subsection*
4162 \begin_layout Description
4163 Action Moves the cursor one line in upward direction adding the current position to the selection.
4166 \begin_layout Description
4170 \begin_layout Subsection*
4174 \begin_layout Description
4175 Action Moves the cursor to the logically previous beginning of a word.
4178 \begin_layout Description
4179 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.
4182 \begin_layout Description
4183 Syntax word-backward
4186 \begin_layout Subsection*
4187 word-backward-select
4190 \begin_layout Description
4191 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4194 \begin_layout Description
4195 Notion See also LFUN_WORD_BACKWARD.
4198 \begin_layout Description
4199 Syntax word-backward-select
4202 \begin_layout Subsection*
4206 \begin_layout Description
4207 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4210 \begin_layout Description
4211 Syntax word-capitalize [<SEL_TYPE>]
4214 \begin_layout Description
4215 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.
4218 \begin_layout Subsection*
4219 word-delete-backward
4222 \begin_layout Description
4223 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4226 \begin_layout Description
4227 Syntax word-delete-backward [force]
4230 \begin_layout Description
4231 Params force: Delete big insets, do not only select them.
4234 \begin_layout Subsection*
4238 \begin_layout Description
4239 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4242 \begin_layout Description
4243 Syntax word-delete-forward [force]
4246 \begin_layout Description
4247 Params force: Delete big insets, do not only select them.
4250 \begin_layout Subsection*
4254 \begin_layout Description
4255 Action Search for next occurrence of a string.
4258 \begin_layout Description
4259 Syntax word-find [<DATA>]
4262 \begin_layout Description
4263 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).
4266 \begin_layout Description
4267 Origin Andre, Jan 7 2004
4270 \begin_layout Subsection*
4274 \begin_layout Description
4275 Action Search for a given string in backward direction.
4278 \begin_layout Description
4279 Notion Case sensitive, match words. If no argument given, last search repeated.
4282 \begin_layout Description
4283 Syntax word-find-backward [<STRING>]
4286 \begin_layout Description
4287 Origin Etienne, 20 Feb 1998
4290 \begin_layout Subsection*
4294 \begin_layout Description
4295 Action Search for a given string in forward direction.
4298 \begin_layout Description
4299 Notion Case sensitive, match words. If no argument given, last search repeated.
4302 \begin_layout Description
4303 Syntax word-find-forward [<STRING>]
4306 \begin_layout Description
4307 Origin Etienne, 16 Feb 1998
4310 \begin_layout Subsection*
4314 \begin_layout Description
4315 Action Search for next occurrence of a pattern.
4318 \begin_layout Description
4319 Syntax word-findadv [<DATA>]
4322 \begin_layout Description
4323 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).
4326 \begin_layout Description
4327 Origin Tommaso, Nov 15 2007
4330 \begin_layout Subsection*
4334 \begin_layout Description
4335 Action Moves the cursor to the logically next beginning of a word.
4338 \begin_layout Description
4339 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.
4342 \begin_layout Description
4346 \begin_layout Subsection*
4350 \begin_layout Description
4351 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4354 \begin_layout Description
4355 Notion See also LFUN_WORD_FORWARD.
4358 \begin_layout Description
4359 Syntax word-forward-select
4362 \begin_layout Subsection*
4366 \begin_layout Description
4367 Action Moves the cursor to the next beginning of a word "on the left".
4370 \begin_layout Description
4371 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.
4374 \begin_layout Description
4378 \begin_layout Description
4379 Origin dov, 28 Oct 2007
4382 \begin_layout Subsection*
4386 \begin_layout Description
4387 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4390 \begin_layout Description
4391 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4394 \begin_layout Description
4395 Syntax word-left-select
4398 \begin_layout Description
4399 Origin dov, 28 Oct 2007
4402 \begin_layout Subsection*
4406 \begin_layout Description
4407 Action Change the words in the selection or word at cursor position to lower case.
4410 \begin_layout Description
4411 Syntax word-lowcase [<SEL_TYPE>]
4414 \begin_layout Description
4415 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.
4418 \begin_layout Subsection*
4422 \begin_layout Description
4423 Action Replace a string in the document.
4426 \begin_layout Description
4427 Syntax word-replace [<DATA>]
4430 \begin_layout Description
4431 Params <DATA>: data is of the form "<replace>
4432 \begin_inset Newline newline
4436 \begin_inset Newline newline
4439 <casesensitive> <matchword> <all> <forward> <findnext>"
4442 \begin_layout Description
4443 Origin Andre, Jan 7 2004
4446 \begin_layout Subsection*
4450 \begin_layout Description
4451 Action Moves the cursor to the next beginning of a word "on the right".
4454 \begin_layout Description
4455 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.
4458 \begin_layout Description
4462 \begin_layout Description
4463 Origin dov, 28 Oct 2007
4466 \begin_layout Subsection*
4470 \begin_layout Description
4471 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4474 \begin_layout Description
4475 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4478 \begin_layout Description
4479 Syntax word-right-select
4482 \begin_layout Description
4483 Origin dov, 28 Oct 2007
4486 \begin_layout Subsection*
4490 \begin_layout Description
4491 Action Puts the word where the cursor stands into the selection.
4494 \begin_layout Description
4498 \begin_layout Description
4499 Origin Andre, 11 Sep 2002
4502 \begin_layout Subsection*
4506 \begin_layout Description
4507 Action Change the words in the selection or word at cursor position to upper case.
4510 \begin_layout Description
4511 Syntax word-upcase [<SEL_TYPE>]
4514 \begin_layout Description
4515 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.
4518 \begin_layout Subsection*
4522 \begin_layout Description
4523 Action Inserts floats wrapped by the text around.
4526 \begin_layout Description
4527 Syntax wrap-insert <TYPE>
4530 \begin_layout Description
4531 Params <TYPE>: table|figure
4534 \begin_layout Description
4535 Origin Dekel, 7 Apr 2002
4538 \begin_layout Section
4539 Math Editor Functions
4542 \begin_layout Subsection*
4543 in-mathmacrotemplate
4546 \begin_layout Description
4547 Action Only active in Math Macro definition.
4550 \begin_layout Description
4551 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.
4554 \begin_layout Description
4555 Syntax in-mathmacrotemplate
4558 \begin_layout Description
4559 Origin sts, 06 January 2008
4562 \begin_layout Subsection*
4566 \begin_layout Description
4567 Action Inserts an extended matrix as provided by the amsmath package.
4570 \begin_layout Description
4571 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4574 \begin_layout Description
4575 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'.
4578 \begin_layout Description
4579 Sample math-ams-matrix 3 3 bmatrix
4582 \begin_layout Subsection*
4586 \begin_layout Description
4587 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4590 \begin_layout Description
4591 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4594 \begin_layout Description
4595 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4596 \begin_inset Newline newline
4599 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4602 \begin_layout Description
4603 Sample math-bigdelim "Bigl" "
4610 \begin_layout Description
4611 Origin Enrico & Georg, 7 May 2006
4614 \begin_layout Subsection*
4618 \begin_layout Description
4619 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4622 \begin_layout Description
4623 Syntax math-delim [<LEFT>] [<RIGHT>]
4626 \begin_layout Description
4627 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.
4630 \begin_layout Description
4631 Sample math-delim { rangle
4634 \begin_layout Description
4635 Origin Alejandro, 18 Jun 1996
4638 \begin_layout Subsection*
4642 \begin_layout Description
4643 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4646 \begin_layout Description
4647 Syntax math-display [<ARG>]
4650 \begin_layout Description
4651 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4654 \begin_layout Description
4655 Origin Alejandro, 18 Jun 1996
4658 \begin_layout Subsection*
4662 \begin_layout Description
4663 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4666 \begin_layout Description
4667 Notion Selection can be used to determine the input for the external program.
4670 \begin_layout Description
4671 Syntax math-extern <LANG> [<COMMAND>]
4674 \begin_layout Description
4675 Params <LANG>: octave|maxima|maple|mathematica|script
4676 \begin_inset Newline newline
4679 where "script" stands for the external script (normalized expression will be passed)
4682 \begin_layout Description
4683 Sample math-extern maple simplify
4686 \begin_layout Description
4687 Origin Andre, 24 Apr 2001
4690 \begin_layout Subsection*
4694 \begin_layout Description
4695 Action Changes the text style used in math.
4698 \begin_layout Description
4699 Syntax math-font-style <STYLE>
4702 \begin_layout Description
4703 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4704 \begin_inset Newline newline
4707 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4710 \begin_layout Description
4711 Origin vfr, 9 jan 2009
4714 \begin_layout Subsection*
4718 \begin_layout Description
4719 Action Inserts math objects and symbols.
4722 \begin_layout Description
4723 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4725 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
4727 frac{x}{y}" replaces "abc" with "
4729 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.
4732 \begin_layout Description
4733 Syntax math-insert <ARG>
4736 \begin_layout Description
4737 Params <ARG>: Symbol or LaTeX code to be inserted.
4740 \begin_layout Subsection*
4744 \begin_layout Description
4745 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.
4748 \begin_layout Description
4749 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4752 \begin_layout Description
4753 Syntax math-limits [<STATE>]
4756 \begin_layout Description
4757 Params <STATE>: limits|nolimits
4760 \begin_layout Subsection*
4764 \begin_layout Description
4765 Action Inserts a math macro definition at the cursor position in the text.
4768 \begin_layout Description
4769 Syntax math-macro <NAME> [<NARGS>] [def]
4772 \begin_layout Description
4773 Params <NAME>: The name of the macro, e.g. "mymacro".
4774 \begin_inset Newline newline
4777 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4780 \begin_layout Description
4781 Origin ale, 10 May 1997; sts, 21 Dec 2007
4784 \begin_layout Subsection*
4785 math-macro-add-greedy-optional-param
4788 \begin_layout Description
4789 Action Add a greedy optional parameter.
4792 \begin_layout Description
4793 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4796 \begin_layout Description
4797 Syntax math-macro-add-greedy-optional-param
4800 \begin_layout Description
4801 Origin sts, 06 January 2008
4804 \begin_layout Subsection*
4805 math-macro-add-optional-param
4808 \begin_layout Description
4809 Action Add an optional parameter.
4812 \begin_layout Description
4813 Notion Insert an optional parameter just behind the already existing optional parameters.
4816 \begin_layout Description
4817 Syntax math-macro-add-optional-param
4820 \begin_layout Description
4821 Origin sts, 06 January 2008
4824 \begin_layout Subsection*
4825 math-macro-add-param
4828 \begin_layout Description
4829 Action Add a parameter.
4832 \begin_layout Description
4833 Notion Add a parameter to a Math Macro.
4836 \begin_layout Description
4837 Syntax math-macro-add-param <NUM>
4840 \begin_layout Description
4841 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.
4844 \begin_layout Description
4845 Origin sts, 06 January 2008
4848 \begin_layout Subsection*
4849 math-macro-append-greedy-param
4852 \begin_layout Description
4853 Action Append a greedy parameter.
4856 \begin_layout Description
4857 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
4860 \begin_layout Description
4861 Syntax math-macro-append-greedy-param
4864 \begin_layout Description
4865 Origin sts, 06 January 2008
4868 \begin_layout Subsection*
4872 \begin_layout Description
4873 Action Fold a Math Macro.
4876 \begin_layout Description
4877 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
4882 \begin_layout Description
4883 Syntax math-macro-fold
4886 \begin_layout Description
4887 Origin sts, 06 January 2008
4890 \begin_layout Subsection*
4891 math-macro-make-nonoptional
4894 \begin_layout Description
4895 Action Make a parameter non-optional.
4898 \begin_layout Description
4899 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.
4902 \begin_layout Description
4903 Syntax math-macro-make-nonoptional
4906 \begin_layout Description
4907 Origin sts, 06 January 2008
4910 \begin_layout Subsection*
4911 math-macro-make-optional
4914 \begin_layout Description
4915 Action Make a parameter optional.
4918 \begin_layout Description
4919 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
4922 \begin_layout Description
4923 Syntax math-macro-make-optional
4926 \begin_layout Description
4927 Origin sts, 06 January 2008
4930 \begin_layout Subsection*
4931 math-macro-remove-greedy-param
4934 \begin_layout Description
4935 Action Remove a greedy parameter.
4938 \begin_layout Description
4939 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.
4942 \begin_layout Description
4943 Syntax math-macro-remove-greedy-param
4946 \begin_layout Description
4947 Origin sts, 06 January 2008
4950 \begin_layout Subsection*
4951 math-macro-remove-optional-param
4954 \begin_layout Description
4955 Action Remove the last optional parameter.
4958 \begin_layout Description
4959 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
4962 \begin_layout Description
4963 Syntax math-macro-remove-optional-param
4966 \begin_layout Description
4967 Origin sts, 06 January 2008
4970 \begin_layout Subsection*
4971 math-macro-remove-param
4974 \begin_layout Description
4975 Action Remove the last parameter.
4978 \begin_layout Description
4979 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
4982 \begin_layout Description
4983 Syntax math-macro-remove-param <NUM>
4986 \begin_layout Description
4987 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
4990 \begin_layout Description
4991 Origin sts, 06 January 2008
4994 \begin_layout Subsection*
4998 \begin_layout Description
4999 Action Unfold a Math Macro.
5002 \begin_layout Description
5003 Notion Unfold the Math Macro the cursor is in, i.e. display it as
5008 \begin_layout Description
5009 Syntax math-macro-unfold
5012 \begin_layout Description
5013 Origin sts, 06 January 2008
5016 \begin_layout Subsection*
5020 \begin_layout Description
5021 Action Inserts a matrix.
5024 \begin_layout Description
5025 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5028 \begin_layout Description
5029 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).
5032 \begin_layout Description
5033 Sample math-matrix 3 3 bccc
5036 \begin_layout Subsection*
5040 \begin_layout Description
5041 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.
5044 \begin_layout Description
5045 Notion If there is some selected text, it puts the text inside created math box.
5048 \begin_layout Description
5049 Syntax math-mode [on|<ARG>]
5052 \begin_layout Description
5053 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
5054 \begin_inset Newline newline
5057 "on": allow only entering of math mode from text mode.
5060 \begin_layout Description
5061 Origin Alejandro, 4 Jun 1996
5064 \begin_layout Subsection*
5068 \begin_layout Description
5069 Action Mutates the type of math inset to the newly selected one.
5072 \begin_layout Description
5073 Syntax math-mutate <TYPE>
5076 \begin_layout Description
5077 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
5080 \begin_layout Description
5081 Origin Andre, 23 May 2001
5084 \begin_layout Subsection*
5085 math-number-line-toggle
5088 \begin_layout Description
5089 Action Toggles numbering of the current formula line.
5092 \begin_layout Description
5093 Notion Must be in display formula mode.
5096 \begin_layout Description
5097 Syntax math-number-line-toggle
5100 \begin_layout Description
5101 Origin Alejandro, 18 Jun 1996
5104 \begin_layout Subsection*
5108 \begin_layout Description
5109 Action Toggles numbering/labeling of the current formula.
5112 \begin_layout Description
5113 Notion Must be in display formula mode.
5116 \begin_layout Description
5117 Syntax math-number-toggle
5120 \begin_layout Description
5121 Origin Alejandro, 4 Jun 1996
5124 \begin_layout Subsection*
5128 \begin_layout Description
5129 Action Changes arbitrarily the size used by math fonts inside a context.
5132 \begin_layout Description
5133 Notion Provides an interface to the LaTeX math mode font size commands.
5136 \begin_layout Description
5137 Syntax math-size <STYLE>
5140 \begin_layout Description
5152 \begin_layout Description
5153 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5156 \begin_layout Subsection*
5160 \begin_layout Description
5161 Action Inserts space into math expression.
5164 \begin_layout Description
5165 Notion Use spacebar after entering this space to change type of space.
5168 \begin_layout Description
5169 Syntax math-space [<TYPE>] [<LEN>]
5172 \begin_layout Description
5173 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5174 \begin_inset Newline newline
5177 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5178 \begin_inset Newline newline
5181 custom space: hspace
5182 \begin_inset Newline newline
5185 "," used by default.
5186 \begin_inset Newline newline
5189 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5190 \begin_inset Newline newline
5193 <LEN>: length for custom spaces (hspace)
5196 \begin_layout Description
5197 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5200 \begin_layout Subsection*
5204 \begin_layout Description
5205 Action Enters subscript expression in math expression.
5208 \begin_layout Description
5209 Syntax math-subscript
5212 \begin_layout Description
5213 Origin vermeer, 12 Dec 2001
5216 \begin_layout Subsection*
5220 \begin_layout Description
5221 Action Enters superscript expression in math expression.
5224 \begin_layout Description
5225 Syntax math-superscript
5228 \begin_layout Description
5229 Origin vermeer, 12 Dec 2001
5232 \begin_layout Subsection*
5236 \begin_layout Description
5237 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5240 \begin_layout Description
5241 Notion If there is any selected text, then it is moved inside the created regexp inset.
5244 \begin_layout Description
5245 Syntax regexp-mode [<ARG>]
5248 \begin_layout Description
5249 Params <ARG>: eventual argument (regular expression).
5252 \begin_layout Description
5253 Origin Tommaso, 4 Oct 2008
5256 \begin_layout Section
5257 Buffer Fuctions (File and Window related)
5260 \begin_layout Subsection*
5264 \begin_layout Description
5265 Action Activate the branch.
5268 \begin_layout Description
5269 Syntax branch-activate <BRANCH>
5272 \begin_layout Description
5273 Params <BRANCH>: The branch to activate
5276 \begin_layout Description
5277 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5278 \begin_inset Newline newline
5281 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5284 \begin_layout Description
5285 Origin rgh, 27 May 2008
5288 \begin_layout Subsection*
5292 \begin_layout Description
5293 Action Add a branch to the buffer's BranchList.
5296 \begin_layout Description
5297 Syntax branch-add <BRANCH>
5300 \begin_layout Description
5301 Params <BRANCH>: Name of the branch to add
5304 \begin_layout Description
5305 Origin spitz, 7 Jul 2009
5308 \begin_layout Subsection*
5312 \begin_layout Description
5313 Action Create new branch and directly put the branch inset into the document.
5316 \begin_layout Description
5317 Syntax branch-add-insert [<NAME>]
5320 \begin_layout Description
5321 Params <NAME>: Branch name. If it is not specified, you will be asked.
5324 \begin_layout Description
5325 Origin sanda, 10 Jul 2009
5328 \begin_layout Subsection*
5332 \begin_layout Description
5333 Action De-activate the branch.
5336 \begin_layout Description
5337 Syntax branch-deactivate <BRANCH>
5340 \begin_layout Description
5341 Params <BRANCH>: The branch to deactivate
5344 \begin_layout Description
5345 Origin rgh, 27 May 2008
5348 \begin_layout Subsection*
5352 \begin_layout Description
5353 Action Toggles inversion status of branch inset.
5356 \begin_layout Description
5357 Syntax branch-invert
5360 \begin_layout Description
5361 Origin rgheck, 12 July 2016
5364 \begin_layout Subsection*
5365 branch-master-activate
5368 \begin_layout Description
5369 Action Activate the branch in the master buffer.
5372 \begin_layout Description
5373 Syntax branch-master-activate <BRANCH>
5376 \begin_layout Description
5377 Params <BRANCH>: The branch to activate
5380 \begin_layout Description
5381 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5382 \begin_inset Newline newline
5385 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5388 \begin_layout Description
5389 Origin spitz, 30 Sep 2012
5392 \begin_layout Subsection*
5393 branch-master-deactivate
5396 \begin_layout Description
5397 Action De-activate the branch in the master buffer.
5400 \begin_layout Description
5401 Syntax branch-master-deactivate <BRANCH>
5404 \begin_layout Description
5405 Params <BRANCH>: The branch to deactivate
5408 \begin_layout Description
5409 Origin spitz, 30 Sep 2012
5412 \begin_layout Subsection*
5416 \begin_layout Description
5417 Action Rename all branches of a given name in a document.
5420 \begin_layout Description
5421 Syntax branches-rename <OLDNAME> <NEWNAME>
5424 \begin_layout Description
5425 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5428 \begin_layout Description
5429 Origin spitz, 9 Jul 2009
5432 \begin_layout Subsection*
5436 \begin_layout Description
5437 Action Saves the current buffer to a temporary file.
5440 \begin_layout Description
5441 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5444 \begin_layout Description
5445 Syntax buffer-auto-save
5448 \begin_layout Subsection*
5452 \begin_layout Description
5453 Action Loads the given child document.
5456 \begin_layout Description
5457 Notion The current document is treated as a parent.
5460 \begin_layout Description
5461 Syntax buffer-child-open <FILE>
5464 \begin_layout Description
5465 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5468 \begin_layout Description
5469 Origin Ale, 28 May 1997
5472 \begin_layout Subsection*
5476 \begin_layout Description
5477 Action Runs chktex for the current document.
5480 \begin_layout Description
5481 Syntax buffer-chktex
5484 \begin_layout Description
5485 Origin Asger, 30 Oct 1997
5488 \begin_layout Subsection*
5492 \begin_layout Description
5493 Action Closes the current buffer.
5496 \begin_layout Description
5497 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5500 \begin_layout Description
5504 \begin_layout Subsection*
5508 \begin_layout Description
5509 Action Closes all buffers.
5512 \begin_layout Description
5513 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5516 \begin_layout Description
5517 Syntax buffer-close-all
5520 \begin_layout Subsection*
5524 \begin_layout Description
5525 Action Exports the current buffer (document) to the given format.
5528 \begin_layout Description
5529 Syntax buffer-export [<FORMAT>] [<DEST>]
5532 \begin_layout Description
5533 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.
5534 \begin_inset Newline newline
5537 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.
5538 \begin_inset Newline newline
5541 If absent or "default", then the default output format of the document is used. <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.
5544 \begin_layout Description
5545 Origin Lgb, 29 Jul 1997
5548 \begin_layout Subsection*
5552 \begin_layout Description
5553 Action Opens a dialog for exporting the current buffer.
5556 \begin_layout Description
5557 Syntax buffer-export-as [<FORMAT>]
5560 \begin_layout Description
5561 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.
5564 \begin_layout Description
5565 Sample buffer-export-as pdf2
5568 \begin_layout Description
5569 Origin tommaso, 6 Oct 2011
5572 \begin_layout Subsection*
5573 buffer-export-custom
5576 \begin_layout Description
5577 Action Exports the current buffer (document) from the given format using the given command on it.
5580 \begin_layout Description
5581 Syntax buffer-export-custom <FORMAT> <COMMAND>
5584 \begin_layout Description
5585 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5586 \begin_inset Newline newline
5589 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5592 \begin_layout Description
5593 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5596 \begin_layout Description
5597 Origin leeming, 27 Mar 2004
5600 \begin_layout Subsection*
5601 buffer-external-modification-clear
5604 \begin_layout Description
5605 Action Clear the external modification flag on the current buffer.
5608 \begin_layout Description
5609 Syntax buffer-external-modification-clear
5612 \begin_layout Description
5613 Origin gm, 2 March 2017
5616 \begin_layout Subsection*
5620 \begin_layout Description
5621 Action Applies a command to all non-hidden buffers.
5624 \begin_layout Description
5625 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5628 \begin_layout Description
5629 Syntax buffer-forall <LFUN-COMMAND>
5632 \begin_layout Description
5633 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5636 \begin_layout Description
5637 Sample Close all Notes in buffers:
5638 \begin_inset Newline newline
5641 buffer-forall inset-forall Note inset-toggle close
5642 \begin_inset Newline newline
5645 Toggle change tracking on buffers:
5646 \begin_inset Newline newline
5649 buffer-forall changes-track
5650 \begin_inset Newline newline
5653 Toggle read-only for buffers:
5654 \begin_inset Newline newline
5657 buffer-forall buffer-toggle-read-only
5658 \begin_inset Newline newline
5661 Show statistics for individual buffers:
5662 \begin_inset Newline newline
5665 buffer-forall statistics
5666 \begin_inset Newline newline
5669 Activate the branch named "Solutions" in buffers:
5670 \begin_inset Newline newline
5673 buffer-forall branch-activate Solutions
5674 \begin_inset Newline newline
5677 Export buffers to PDF (pdflatex):
5678 \begin_inset Newline newline
5681 buffer-forall buffer-export pdf2
5682 \begin_inset Newline newline
5688 \begin_layout Description
5689 Origin skostysh, 20 Jul 2012
5692 \begin_layout Subsection*
5696 \begin_layout Description
5697 Action Import a given file as a lyx document.
5700 \begin_layout Description
5701 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.
5704 \begin_layout Description
5705 Syntax buffer-import <FORMAT> [<FILE>]
5708 \begin_layout Description
5709 Origin Asger, 24 Jul 1998
5712 \begin_layout Subsection*
5716 \begin_layout Description
5717 Action Set language of the current document.
5720 \begin_layout Description
5721 Syntax buffer-language <LANG>
5724 \begin_layout Description
5725 Params <LANG>: language name. See lib/languages for list.
5728 \begin_layout Description
5729 Origin leeming, 30 Mar 2004
5732 \begin_layout Subsection*
5736 \begin_layout Description
5737 Action Moves the current tab one spot to the right.
5740 \begin_layout Description
5741 Syntax buffer-move-next
5744 \begin_layout Description
5745 Origin skostysh, 7 Apr 2015
5748 \begin_layout Subsection*
5749 buffer-move-previous
5752 \begin_layout Description
5753 Action Moves the current tab one spot to the left.
5756 \begin_layout Description
5757 Syntax buffer-move-previous
5760 \begin_layout Description
5761 Origin skostysh, 7 Apr 2015
5764 \begin_layout Subsection*
5768 \begin_layout Description
5769 Action Creates a new buffer (that is, document) and switches to it.
5772 \begin_layout Description
5773 Notion Implicit path can be set in Preferences dialog.
5776 \begin_layout Description
5777 Syntax buffer-new [<FILE>]
5780 \begin_layout Description
5781 Params <FILE>: filename of created file with absolute path.
5784 \begin_layout Subsection*
5788 \begin_layout Description
5789 Action Creates a new buffer (that is, document) from a template.
5792 \begin_layout Description
5793 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5796 \begin_layout Description
5797 Syntax buffer-new-template [<FILE>]
5800 \begin_layout Description
5801 Params <FILE>: filename of created file with absolute path.
5804 \begin_layout Subsection*
5808 \begin_layout Description
5809 Action Switch to the next opened document.
5812 \begin_layout Description
5813 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
5816 \begin_layout Description
5820 \begin_layout Subsection*
5824 \begin_layout Description
5825 Action Apply the given settings to the current document.
5828 \begin_layout Description
5829 Syntax buffer-params-apply [<ARGS>]
5832 \begin_layout Description
5833 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5836 \begin_layout Description
5837 Origin leeming, 30 Mar 2004
5840 \begin_layout Subsection*
5844 \begin_layout Description
5845 Action Switch to the previous opened document.
5848 \begin_layout Description
5849 Syntax buffer-previous
5852 \begin_layout Subsection*
5856 \begin_layout Description
5857 Action Reverts opened document.
5860 \begin_layout Description
5861 Syntax buffer-reload
5864 \begin_layout Description
5865 Origin Asger, 2 Feb 1997
5868 \begin_layout Subsection*
5869 buffer-save-as-default
5872 \begin_layout Description
5873 Action Save the current document settings as default.
5876 \begin_layout Description
5877 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5880 \begin_layout Description
5881 Syntax buffer-save-as-default [<ARGS>]
5884 \begin_layout Description
5885 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5888 \begin_layout Description
5889 Origin leeming, 30 Mar 2004
5892 \begin_layout Subsection*
5896 \begin_layout Description
5897 Action Display and switch to the given buffer.
5900 \begin_layout Description
5901 Syntax buffer-switch <BUFFER>
5904 \begin_layout Description
5905 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
5908 \begin_layout Subsection*
5909 buffer-toggle-compression
5912 \begin_layout Description
5913 Action Toggles compression of the current document on/off.
5916 \begin_layout Description
5917 Syntax buffer-toggle-compression
5920 \begin_layout Description
5921 Origin bpeng, 27 Apr 2006
5924 \begin_layout Subsection*
5925 buffer-toggle-read-only
5928 \begin_layout Description
5929 Action Toggle editing mode of the current document between read/write and read-only.
5932 \begin_layout Description
5933 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.
5936 \begin_layout Description
5937 Syntax buffer-toggle-read-only
5940 \begin_layout Description
5941 Origin Lgb, 27 May 1997
5944 \begin_layout Subsection*
5948 \begin_layout Description
5949 Action Exports the current document and put the result into the temporary directory.
5952 \begin_layout Description
5953 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).
5956 \begin_layout Description
5957 Syntax buffer-update [<FORMAT>]
5960 \begin_layout Description
5961 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.
5964 \begin_layout Description
5965 Origin Dekel, 5 Aug 2000
5968 \begin_layout Subsection*
5972 \begin_layout Description
5973 Action Displays current buffer in chosen format.
5976 \begin_layout Description
5977 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.
5980 \begin_layout Description
5981 Syntax buffer-view [<FORMAT>]
5984 \begin_layout Description
5985 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.
5988 \begin_layout Subsection*
5992 \begin_layout Description
5993 Action Opens the file that was created from last preview of this buffer.
5996 \begin_layout Description
5997 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.
6000 \begin_layout Description
6001 Syntax buffer-view-cache
6004 \begin_layout Subsection*
6008 \begin_layout Description
6009 Action Saves the current buffer.
6012 \begin_layout Description
6013 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.
6016 \begin_layout Description
6020 \begin_layout Subsection*
6024 \begin_layout Description
6025 Action Save all changed documents.
6028 \begin_layout Description
6029 Syntax buffer-write-all
6032 \begin_layout Description
6033 Origin rgh, gpothier 6 Aug 2007
6036 \begin_layout Subsection*
6040 \begin_layout Description
6041 Action Rename and save current buffer.
6044 \begin_layout Description
6045 Syntax buffer-write-as <FILENAME>
6048 \begin_layout Description
6049 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6052 \begin_layout Subsection*
6056 \begin_layout Description
6057 Action Increases the zoom of the screen fonts.
6060 \begin_layout Description
6061 Syntax buffer-zoom-in [<ZOOM>]
6064 \begin_layout Description
6065 Params <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
6068 \begin_layout Description
6069 Origin vfr, 30 Mar 2009
6072 \begin_layout Subsection*
6076 \begin_layout Description
6077 Action Decreases the zoom of the screen fonts.
6080 \begin_layout Description
6081 Syntax buffer-zoom-out [<ZOOM>]
6084 \begin_layout Description
6085 Params <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
6088 \begin_layout Description
6089 Origin vfr, 30 Mar 2009
6092 \begin_layout Subsection*
6096 \begin_layout Description
6097 Action Generates the code (literate programming).
6100 \begin_layout Description
6101 Notion Latex file with extension
6103 literate_extension is generated. Then LyX invokes
6105 build_command (with a default of ``make'') to generate the code and
6107 build_error_filter to process the compilation error messages.
6108 \begin_inset Newline newline
6111 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:
6112 \begin_inset Newline newline
6117 build_command "my_script my_arguments"
6118 \begin_inset Newline newline
6123 build_error_filter differs from the
6125 literate_error_filter only in that the former will identify error messages from your compiler.
6128 \begin_layout Description
6129 Syntax build-program
6132 \begin_layout Subsection*
6136 \begin_layout Description
6137 Action Open LyX document.
6140 \begin_layout Description
6141 Syntax file-open [<FILE>]
6144 \begin_layout Description
6145 Params <FILE>: Filename to be opened.
6148 \begin_layout Subsection*
6152 \begin_layout Description
6153 Action Open the given help file according to the language setting.
6156 \begin_layout Description
6157 Syntax help-open <FILE>[.lyx]
6160 \begin_layout Description
6161 Params <FILE>: any document from (/usr/share/)doc directory.
6164 \begin_layout Description
6165 Origin Jug, 27 Jun 1999
6168 \begin_layout Subsection*
6172 \begin_layout Description
6173 Action Sets icon size of toolbars.
6176 \begin_layout Description
6177 Syntax icon-size [<SIZE>]
6180 \begin_layout Description
6181 Params <SIZE> : the icon size in px or one of the logical settings small|normal|big|huge|giant, the default is normal (whose size in px is icon set dependent).
6184 \begin_layout Description
6188 \begin_layout Subsection*
6192 \begin_layout Description
6193 Action Terminates the current LyX instance.
6196 \begin_layout Description
6197 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6200 \begin_layout Description
6204 \begin_layout Subsection*
6205 master-buffer-update
6208 \begin_layout Description
6209 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6212 \begin_layout Description
6213 Syntax master-buffer-update [<FORMAT>]
6216 \begin_layout Description
6217 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.
6220 \begin_layout Description
6221 Origin Tommaso, 20 Sep 2007
6224 \begin_layout Subsection*
6228 \begin_layout Description
6229 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6232 \begin_layout Description
6233 Syntax master-buffer-view [<FORMAT>]
6236 \begin_layout Description
6237 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.
6240 \begin_layout Description
6241 Origin Tommaso, 20 Sep 2007
6244 \begin_layout Subsection*
6248 \begin_layout Description
6249 Action Opens the menu given by its name.
6252 \begin_layout Description
6253 Syntax menu-open <NAME>
6256 \begin_layout Description
6257 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6260 \begin_layout Subsection*
6264 \begin_layout Description
6265 Action Close the current tab group.
6268 \begin_layout Description
6269 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6272 \begin_layout Description
6273 Syntax tab-group-close
6276 \begin_layout Description
6277 Origin Abdel, 21 Feb 2008
6280 \begin_layout Subsection*
6284 \begin_layout Description
6285 Action Toggles visibility of a given toolbar between on/off/auto.
6288 \begin_layout Description
6289 Notion Skipping "auto" when allowauto is false.
6292 \begin_layout Description
6293 Syntax toolbar-toggle <NAME> [allowauto]
6296 \begin_layout Description
6297 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6298 \begin_inset Newline newline
6301 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6304 \begin_layout Description
6305 Origin Edwin, 21 May 2007
6308 \begin_layout Subsection*
6312 \begin_layout Description
6313 Action Various UI visibility-toggling actions.
6316 \begin_layout Description
6317 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6320 \begin_layout Description
6321 Params statusbar : Toggle visibility of the statusbar.
6322 \begin_inset Newline newline
6325 menubar : Toggle visibility of the menubar.
6326 \begin_inset Newline newline
6329 scrollbar : Toggle visibility of the scrollbar.
6330 \begin_inset Newline newline
6333 frame : Toggle visibility of the frames around editing window.
6334 \begin_inset Newline newline
6337 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.
6340 \begin_layout Description
6341 Origin sanda, 9 Feb 2007
6344 \begin_layout Subsection*
6348 \begin_layout Description
6349 Action Close the current document work area.
6352 \begin_layout Description
6353 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6356 \begin_layout Description
6360 \begin_layout Description
6361 Origin Tommaso, 15 Sep 2012
6364 \begin_layout Subsection*
6368 \begin_layout Description
6369 Action Creates another split view of current buffer.
6372 \begin_layout Description
6373 Notion All split views act in the same way independently.
6376 \begin_layout Description
6377 Syntax view-split <vertical|horizontal>
6380 \begin_layout Description
6381 Params horizontal : The work areas are laid out side by side.
6382 \begin_inset Newline newline
6385 vertical : The work areas laid out vertically.
6388 \begin_layout Description
6389 Origin Abdel, 20 Feb 2008
6392 \begin_layout Subsection*
6396 \begin_layout Description
6397 Action Closes the current LyX window.
6400 \begin_layout Description
6404 \begin_layout Description
6405 Origin Abdel, 23 Oct 2006
6408 \begin_layout Subsection*
6412 \begin_layout Description
6413 Action Creates new empty LyX window.
6416 \begin_layout Description
6417 Notion Already opened documents from the previous window can be found under View menu.
6420 \begin_layout Description
6421 Syntax window-new [<GEOMETRY>]
6424 \begin_layout Description
6425 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6428 \begin_layout Description
6429 Origin Abdel, 21 Oct 2006
6432 \begin_layout Section
6433 System Functions (Preferences, LyX Server etc.)
6436 \begin_layout Subsection*
6437 buffer-toggle-output-sync
6440 \begin_layout Description
6441 Action Toggles including of resources for forward/reverse search of the given document.
6444 \begin_layout Description
6445 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6448 \begin_layout Description
6449 Syntax buffer-toggle-output-sync
6452 \begin_layout Description
6453 Origin sanda, 25 May 2010
6456 \begin_layout Subsection*
6460 \begin_layout Description
6461 Action Executes a command defined in a .def file.
6464 \begin_layout Description
6465 Notion The definitions are by default read from lib/commands/default.def.
6466 \begin_inset Newline newline
6469 A .def file allows to define a command with
6471 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).
6473 def_file "FileName" allows to include another .def file.
6474 \begin_inset Newline newline
6477 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.
6480 \begin_layout Description
6484 \begin_layout Description
6485 Params <NAME>: Name of the command that must be called.
6488 \begin_layout Description
6489 Origin broider, 2 Oct 2007
6492 \begin_layout Subsection*
6496 \begin_layout Description
6497 Action Cancels sequence prepared by LFUN_META_PREFIX .
6500 \begin_layout Description
6504 \begin_layout Subsection*
6505 command-alternatives
6508 \begin_layout Description
6509 Action Runs the first listed command that is enabled.
6512 \begin_layout Description
6513 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6516 \begin_layout Description
6517 Syntax command-alternatives <CMDS>
6520 \begin_layout Description
6521 Params <CMDS>: Sequence of commands separated by semicolons.
6524 \begin_layout Description
6525 Sample command-alternatives completion-accept;cell-forward
6528 \begin_layout Description
6529 Origin rgh, 24 September 2008
6532 \begin_layout Subsection*
6536 \begin_layout Description
6537 Action Run more commands (LFUN and its parameters) in a sequence.
6540 \begin_layout Description
6541 Syntax command-sequence <CMDS>
6544 \begin_layout Description
6545 Params <CMDS>: Sequence of commands separated by semicolons.
6548 \begin_layout Description
6549 Sample command-sequence cut; ert-insert; self-insert
6551 ; paste; self-insert {}; inset-toggle;
6554 \begin_layout Description
6555 Origin Andre, 11 Nov 1999
6558 \begin_layout Subsection*
6559 cursor-follows-scrollbar-toggle
6562 \begin_layout Description
6563 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6566 \begin_layout Description
6567 Syntax toggle-cursor-follows-scrollbar
6570 \begin_layout Description
6571 Origin ARRae, 2 Dec 1997
6574 \begin_layout Subsection*
6578 \begin_layout Description
6579 Action Set debug output level.
6582 \begin_layout Description
6583 Syntax debug-level-set <LEVEL>
6586 \begin_layout Description
6587 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.
6590 \begin_layout Description
6591 Origin sanda, 28 Dec 2009
6594 \begin_layout Subsection*
6598 \begin_layout Description
6599 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6602 \begin_layout Description
6603 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6606 \begin_layout Description
6607 Syntax forward-search
6610 \begin_layout Description
6611 Origin sanda, 14 Apr 2010
6614 \begin_layout Subsection*
6618 \begin_layout Description
6619 Action Apply the given settings to user preferences.
6622 \begin_layout Description
6623 Syntax lyxrc-apply <SETTINGS>
6626 \begin_layout Description
6627 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.
6630 \begin_layout Subsection*
6634 \begin_layout Description
6635 Action Shows message in statusbar (for script purposes).
6638 \begin_layout Description
6639 Syntax message <STRING>
6642 \begin_layout Description
6643 Origin Lgb, 8 Apr 2001
6646 \begin_layout Subsection*
6650 \begin_layout Description
6651 Action Simulate halting Meta key (Alt key on PCs).
6654 \begin_layout Description
6655 Notion Used for buffer edition not for GUI control.
6658 \begin_layout Description
6662 \begin_layout Subsection*
6666 \begin_layout Description
6667 Action Save user preferences.
6670 \begin_layout Description
6671 Syntax preferences-save
6674 \begin_layout Description
6675 Origin Lgb, 27 Nov 1999
6678 \begin_layout Subsection*
6682 \begin_layout Description
6683 Action Reconfigure the automatic settings.
6686 \begin_layout Description
6690 \begin_layout Description
6691 Origin Asger, 14 Feb 1997
6694 \begin_layout Subsection*
6698 \begin_layout Description
6699 Action Returns path and file name of the currently edited document.
6702 \begin_layout Description
6703 Syntax server-get-filename
6706 \begin_layout Subsection*
6710 \begin_layout Description
6711 Action Returns the current layout (that is environment) name on the cursor position.
6714 \begin_layout Description
6715 Syntax server-get-layout
6718 \begin_layout Subsection*
6719 server-get-statistics
6722 \begin_layout Description
6723 Action Returns the statistics (number of words and characters) in the document or in the given selection.
6726 \begin_layout Description
6727 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6730 \begin_layout Description
6731 Syntax server-get-statistics [<TYPE>]
6734 \begin_layout Description
6735 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
6736 \begin_inset Newline newline
6740 \begin_inset Newline newline
6743 chars: count characters.
6744 \begin_inset Newline newline
6747 chars-space: count characters and spaces.
6750 \begin_layout Description
6751 Origin brokenclock, Oct 10 2014
6754 \begin_layout Subsection*
6758 \begin_layout Description
6759 Action Returns the coordinates of cursor position in the editing area.
6762 \begin_layout Description
6763 Syntax server-get-xy
6766 \begin_layout Subsection*
6767 server-goto-file-row
6770 \begin_layout Description
6771 Action Sets the cursor position in LyX based on the row number of generated TeX file.
6774 \begin_layout Description
6775 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).
6778 \begin_layout Description
6779 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
6782 \begin_layout Description
6783 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.
6784 \begin_inset Newline newline
6787 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).
6788 \begin_inset Newline newline
6791 .ext: extensions will be automatically replaced by .lyx.
6792 \begin_inset Newline newline
6795 <ROW_NUMBER> The row number of the LaTeX file to which to go.
6798 \begin_layout Description
6799 Sample server-goto-file-row /home/user/example.lyx 41
6800 \begin_inset Newline newline
6803 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
6806 \begin_layout Description
6807 Origin Edmar, 23 Dec 1998
6810 \begin_layout Subsection*
6814 \begin_layout Description
6815 Action Sends notify message about the last key-sequence to client.
6818 \begin_layout Description
6819 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
6822 \begin_layout Description
6823 Syntax server-notify
6826 \begin_layout Subsection*
6830 \begin_layout Description
6831 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
6834 \begin_layout Description
6835 Syntax server-set-xy <X> <Y>
6838 \begin_layout Subsection*
6842 \begin_layout Description
6843 Action Set the given LyX color to the color defined by the X11 name given.
6846 \begin_layout Description
6847 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
6850 \begin_layout Description
6851 Syntax set-color <LYX_NAME> <X11_NAME>
6854 \begin_layout Description
6855 Origin SLior, 11 Jun 2000
6858 \begin_layout Subsection*
6862 \begin_layout Description
6863 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
6866 \begin_layout Description
6867 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6870 \begin_layout Description
6874 \begin_layout Description
6875 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6878 \begin_layout Subsection*
6882 \begin_layout Description
6883 Action Checks-in/commits the changes of the registered file to the repository.
6886 \begin_layout Description
6887 Notion In RCS case this also unlocks the file.
6890 \begin_layout Description
6894 \begin_layout Description
6895 Origin Lgb, 1 Jul 1997
6898 \begin_layout Subsection*
6902 \begin_layout Description
6903 Action Checks-out the document for edit (and locks it in some cases).
6906 \begin_layout Description
6910 \begin_layout Description
6911 Origin Lgb, 1 Jul 1997
6914 \begin_layout Subsection*
6918 \begin_layout Description
6919 Action Executes external command. This command is intended to support additional VCS commands.
6922 \begin_layout Description
6923 Syntax vc-command <FLAG> <PATH> <COMMAND>
6926 \begin_layout Description
6927 Params <FLAG>: Flags for the command can be combined together.
6928 \begin_inset Newline newline
6931 U - dUmmy - no flags
6932 \begin_inset Newline newline
6935 D - Doc - need document loaded to proceed
6936 \begin_inset Newline newline
6939 I - dIrty - mark document dirty
6940 \begin_inset Newline newline
6943 R - Reload - ensure that the document is saved and reload it after command execution
6944 \begin_inset Newline newline
6947 M - Message - ask for input string (commit message)
6948 \begin_inset Newline newline
6951 <PATH>: path where to start. $$p will be replaced by the current document path.
6952 \begin_inset Newline newline
6955 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
6958 \begin_layout Description
6959 Sample vc-command DR $$p "svn up"
6962 \begin_layout Description
6963 Origin sanda, 13 Jan 2009
6966 \begin_layout Subsection*
6970 \begin_layout Description
6971 Action Compares two revisions of the same file under version control.
6974 \begin_layout Description
6975 Syntax vc-compare [<REV1>] [<REV2>]
6978 \begin_layout Description
6979 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
6980 \begin_inset Newline newline
6983 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
6984 \begin_inset Newline newline
6988 \begin_inset Newline newline
6991 <REV2>: Newer file. Used only if REV1 > 0.
6992 \begin_inset Newline newline
6995 If no parameter is given, interactive dialog will be shown.
6998 \begin_layout Description
6999 Sample Compare current document against last commit
7000 \begin_inset Newline newline
7004 \begin_inset Newline newline
7007 Compare current document against current revision - 5 commits
7008 \begin_inset Newline newline
7012 \begin_inset Newline newline
7015 Compare revisions 120 and 155
7016 \begin_inset Newline newline
7022 \begin_layout Description
7023 Origin sanda, 12 Feb 2010
7026 \begin_layout Subsection*
7030 \begin_layout Description
7031 Action Copies the document to another name.
7034 \begin_layout Description
7035 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.
7038 \begin_layout Description
7039 Syntax vc-copy <FILENAME>
7042 \begin_layout Description
7043 Params <FILENAME>: New name of the document.
7044 \begin_inset Newline newline
7047 A file dialog is opened if no filename is given.
7050 \begin_layout Description
7051 Origin gb, 05 Feb 2013
7054 \begin_layout Subsection*
7058 \begin_layout Description
7059 Action Toggles the locking property of the edited file.
7062 \begin_layout Description
7063 Notion This is currently implemented only for SVN.
7066 \begin_layout Description
7067 Syntax vc-locking-toggle
7070 \begin_layout Description
7071 Origin sanda, 25 Jun 2009
7074 \begin_layout Subsection*
7078 \begin_layout Description
7079 Action Register the document as an file inside version control system.
7082 \begin_layout Description
7083 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
7084 \begin_inset Newline newline
7087 See LyX Additional Features Manual (Version Control Chapter) for additional information.
7090 \begin_layout Description
7094 \begin_layout Description
7095 Origin Lgb, 1 Jul 1997
7098 \begin_layout Subsection*
7102 \begin_layout Description
7103 Action Renames the document to another name.
7106 \begin_layout Description
7107 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.
7110 \begin_layout Description
7111 Syntax vc-rename <FILENAME>
7114 \begin_layout Description
7115 Params <FILENAME>: New name of the document.
7116 \begin_inset Newline newline
7119 A file dialog is opened if no filename is given.
7122 \begin_layout Description
7123 Origin gb, 05 Feb 2013
7126 \begin_layout Subsection*
7130 \begin_layout Description
7131 Action Update the local archive directory in which resides the current document with the remote repository.
7134 \begin_layout Description
7135 Syntax vc-repo-update
7138 \begin_layout Description
7139 Origin sanda, 16 Oct 2009
7142 \begin_layout Subsection*
7146 \begin_layout Description
7147 Action Reverts the document to the last check-in/commit in VCS.
7150 \begin_layout Description
7154 \begin_layout Description
7155 Origin Lgb, 1 Jul 1997
7158 \begin_layout Subsection*
7162 \begin_layout Description
7163 Action Undo last check-in.
7166 \begin_layout Description
7167 Notion This is currently implemented only for RCS.
7170 \begin_layout Description
7174 \begin_layout Description
7175 Origin Lgb, 1 Jul 1997
7178 \begin_layout Section
7179 Hidden Functions (not listed for configuration)
7182 \begin_layout Subsection*
7186 \begin_layout Description
7187 Action Return the current key sequence and available options as a string.
7190 \begin_layout Description
7191 Notion No options are added if no current map exists.
7192 \begin_inset Newline newline
7195 This is probably usable only with connection to lyxserver.
7198 \begin_layout Description
7199 Syntax command-prefix
7202 \begin_layout Subsection*
7206 \begin_layout Description
7207 Action Activates the LyX window.
7210 \begin_layout Description
7211 Notion On Linux and Mac OS, this action brings the LyX window into focus. Such behavior is not allowed by Windows OS so instead the color of the taskbar entry is changed to indicate that the window has changed in some way. This action is useful in combination with reverse search.
7214 \begin_layout Description
7218 \begin_layout Description
7219 Origin skostysh, 4 Aug 2016
7222 \begin_layout Subsection*
7226 \begin_layout Description
7227 Action Inserts the given string (accordingly to the correct keymap).
7230 \begin_layout Description
7231 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7234 \begin_layout Description
7235 Syntax self-insert <STRING>