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
82 \paragraph_separation indent
83 \paragraph_indentation default
85 \math_numbering_side default
90 \paperpagestyle default
91 \tracking_changes false
110 \begin_layout Section*
114 \begin_layout Standard
115 This manual documents the
116 \begin_inset Quotes eld
120 \begin_inset Quotes erd
124 These are commands that are used to make \SpecialChar LyX
125 perform specific actions.
127 itself uses these functions internally, and every internal action is bound
131 \begin_layout Standard
132 LFUNs are also used in the files that define keyboard shortcuts, menu or
134 So if you want to change\SpecialChar breakableslash
135 customize the user interface, you need to deal
137 Furthermore, external programs can use LFUNs to communicate with and
138 \begin_inset Quotes eld
142 \begin_inset Quotes erd
147 Finally, you can also issue LFUNs directly via the so called mini-buffer
148 which can be opened via
151 arg "command-execute"
157 \begin_layout Standard
158 In the following, all LFUNs are listed, categorized by function.
161 \begin_layout Section
162 Layout Functions (Font, Layout and Textclass related)
165 \begin_layout Subsection*
169 \begin_layout Description
170 Action Displays list of layout choices.
173 \begin_layout Description
174 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
175 allowing for choice of layout.
178 \begin_layout Description
179 Syntax drop-layouts-choice
182 \begin_layout Subsection*
186 \begin_layout Description
187 Action Splits the current environment with a Separator.
190 \begin_layout Description
191 Syntax environment-split [before|outer|previous]
194 \begin_layout Description
195 Params outer: If this is given, LyX will split the outermost environment
196 in the current nesting hierarchy.
197 \begin_inset Newline newline
200 previous: If this is given, LyX will split the environment in the previous
201 paragraph (is there is one).
202 \begin_inset Newline newline
205 before: If this is given, the new environment will be appended rather
209 \begin_layout Description
210 Origin spitz, 23 Dec 2012
213 \begin_layout Subsection*
217 \begin_layout Description
218 Action Toggles the bold font (selection-wise) using mathbf in math.
221 \begin_layout Description
225 \begin_layout Subsection*
229 \begin_layout Description
230 Action Toggles the bold font (selection-wise) using boldsymbol in math.
233 \begin_layout Description
234 Syntax font-boldsymbol
237 \begin_layout Subsection*
241 \begin_layout Description
242 Action Toggles xout (cross-through) in the font (selection-wise).
245 \begin_layout Description
249 \begin_layout Description
250 Origin uwestoehr, 4 April 2017
253 \begin_layout Subsection*
257 \begin_layout Description
258 Action Reverts the settings of the font to the default values (selection-wise).
261 \begin_layout Description
265 \begin_layout Subsection*
269 \begin_layout Description
270 Action Toggles the emphasis font style (selection-wise).
273 \begin_layout Description
277 \begin_layout Subsection*
281 \begin_layout Description
282 Action Toggles Fraktur family font (math-mode, selection-wise).
285 \begin_layout Description
289 \begin_layout Description
290 Origin vermeer, 10 Jan 2002
293 \begin_layout Subsection*
297 \begin_layout Description
298 Action Toggles Italics font shape (math-mode, selection-wise).
301 \begin_layout Description
305 \begin_layout Description
306 Origin vermeer, 10 Jan 2002
309 \begin_layout Subsection*
313 \begin_layout Description
314 Action Toggles Noun text style font (selection-wise).
317 \begin_layout Description
321 \begin_layout Subsection*
325 \begin_layout Description
326 Action Toggles Roman family font (selection-wise).
329 \begin_layout Description
333 \begin_layout Subsection*
337 \begin_layout Description
338 Action Toggles Sans Serif family font (selection-wise).
341 \begin_layout Description
345 \begin_layout Subsection*
349 \begin_layout Description
350 Action Sets font size according to lyx format string.
353 \begin_layout Description
354 Syntax font-size <SIZE>
357 \begin_layout Description
358 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
359 \begin_inset Newline newline
362 largest|huge|giant|increase|decrease|default
365 \begin_layout Subsection*
369 \begin_layout Description
370 Action Returns the info about the current font.
373 \begin_layout Description
377 \begin_layout Subsection*
381 \begin_layout Description
382 Action Toggles strikeout (strike-through) in the font (selection-wise).
385 \begin_layout Description
386 Syntax font-strikeout
389 \begin_layout Description
390 Origin sanda, 3 May 2009
393 \begin_layout Subsection*
397 \begin_layout Description
398 Action Toggles the typewriter family font (selection-wise).
401 \begin_layout Description
402 Syntax font-typewriter
405 \begin_layout Subsection*
409 \begin_layout Description
410 Action Toggles underline in the font (selection-wise).
413 \begin_layout Description
414 Syntax font-underline
417 \begin_layout Subsection*
421 \begin_layout Description
422 Action Toggles double underline in the font (selection-wise).
425 \begin_layout Description
426 Syntax font-underunderline
429 \begin_layout Description
430 Origin sanda, 5 May 2009
433 \begin_layout Subsection*
437 \begin_layout Description
438 Action Toggles wavy underline in the font (selection-wise).
441 \begin_layout Description
442 Syntax font-underwave
445 \begin_layout Description
446 Origin sanda, 5 May 2009
449 \begin_layout Subsection*
453 \begin_layout Description
454 Action Sets the layout (that is, environment) for the current paragraph.
457 \begin_layout Description
458 Syntax layout <LAYOUT> [ignorenests]
461 \begin_layout Description
462 Params <LAYOUT>: the layout to use
463 \begin_inset Newline newline
466 ignorenests: If specified, nesting advices will be ignored.
469 \begin_layout Subsection*
473 \begin_layout Description
474 Action Adds a module.
477 \begin_layout Description
478 Notion Adds a module to the list of included modules for the current buffer.
481 \begin_layout Description
482 Syntax layout-module-add <MODULE>
485 \begin_layout Description
486 Params <MODULE>: the module to be added
489 \begin_layout Description
490 Origin rgh, 25 August 2007
493 \begin_layout Subsection*
497 \begin_layout Description
498 Action Clears the module list.
501 \begin_layout Description
502 Notion Clears the list of included modules for the current buffer.
505 \begin_layout Description
506 Syntax layout-modules-clear
509 \begin_layout Description
510 Origin rgh, 25 August 2007
513 \begin_layout Subsection*
517 \begin_layout Description
518 Action Launches the paragraph settings dialog.
521 \begin_layout Description
522 Syntax layout-paragraph
525 \begin_layout Subsection*
529 \begin_layout Description
530 Action Reloads layout information.
533 \begin_layout Description
534 Notion Reloads all layout information for the current buffer from disk,
535 thus recognizing any changes that have been made to layout files on the
537 This is intended to be used only by layout developers and should not be
538 used when one is trying to do actual work.
541 \begin_layout Description
545 \begin_layout Description
546 Origin rgh, 3 September 2007
549 \begin_layout Subsection*
553 \begin_layout Description
554 Action Launches the tabular settings dialog.
557 \begin_layout Description
558 Syntax layout-tabular
561 \begin_layout Description
562 Origin Jug, 31 Jul 2000
565 \begin_layout Subsection*
569 \begin_layout Description
570 Action Update fonts and its metrics.
573 \begin_layout Description
574 Notion Automatically called after zoom, dpi, font names, or norm change.
577 \begin_layout Description
578 Syntax screen-font-update
581 \begin_layout Description
582 Origin ARRae, 13 Aug 2000
585 \begin_layout Subsection*
589 \begin_layout Description
590 Action Sets the text class for the current buffer.
593 \begin_layout Description
594 Syntax textclass-apply <TEXTCLASS>
597 \begin_layout Description
598 Params <TEXTCLASS>: the textclass to set.
599 Note that this must be the filename, minus the ".layout" extension.
602 \begin_layout Subsection*
606 \begin_layout Description
607 Action Loads information for a textclass from disk.
610 \begin_layout Description
611 Syntax textclass-load <TEXTCLASS>
614 \begin_layout Description
615 Params <TEXTCLASS>: the textclass to load.
616 Note that this must be the filename, minus the ".layout" extension.
619 \begin_layout Subsection*
623 \begin_layout Description
624 Action Toggle user-defined (=last-time used) text style.
627 \begin_layout Description
628 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
629 triggered when using Text Style dialog.
632 \begin_layout Description
633 Syntax textstyle-apply
636 \begin_layout Description
637 Origin leeming, 12 Mar 2003
640 \begin_layout Subsection*
644 \begin_layout Description
645 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
649 \begin_layout Description
650 Syntax textstyle-update <FONT_INFO>
653 \begin_layout Description
654 Params <FONT_INFO>: specifies font atributes, e.g.
655 family, series, shape, size, emph, noun, underbar, number, color, language,
657 \begin_inset Newline newline
660 Use lyx -dbg action for exact syntax of text-style dialog parameters.
663 \begin_layout Description
664 Origin leeming, 12 Mar 2003
667 \begin_layout Section
668 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
671 \begin_layout Subsection*
675 \begin_layout Description
676 Action Adds an acute accent to the next character typed.
679 \begin_layout Description
683 \begin_layout Subsection*
687 \begin_layout Description
688 Action Adds a breve accent to the next character typed.
691 \begin_layout Description
695 \begin_layout Subsection*
699 \begin_layout Description
700 Action Adds a caron to the next character typed.
703 \begin_layout Description
707 \begin_layout Subsection*
711 \begin_layout Description
712 Action Adds a cedilla to the next character typed.
715 \begin_layout Description
716 Syntax accent-cedilla
719 \begin_layout Subsection*
723 \begin_layout Description
724 Action Adds a circle accent to the next character typed.
727 \begin_layout Description
731 \begin_layout Subsection*
735 \begin_layout Description
736 Action Adds a circumflex to the next character typed.
739 \begin_layout Description
740 Syntax accent-circumflex
743 \begin_layout Subsection*
747 \begin_layout Description
748 Action Adds a dot accent to the next character typed.
751 \begin_layout Description
755 \begin_layout Subsection*
759 \begin_layout Description
760 Action Adds a grave accent to the next character typed.
763 \begin_layout Description
767 \begin_layout Subsection*
768 accent-hungarian-umlaut
771 \begin_layout Description
772 Action Adds a Hungarian umlaut to the next character typed.
775 \begin_layout Description
779 \begin_layout Subsection*
783 \begin_layout Description
784 Action Adds a macron to the next character typed.
787 \begin_layout Description
791 \begin_layout Subsection*
795 \begin_layout Description
796 Action Adds an ogonek accent to the next character typed.
799 \begin_layout Description
803 \begin_layout Subsection*
807 \begin_layout Description
808 Action Adds a perispomeni (Greek circumflex) over the next character typed.
811 \begin_layout Description
812 Syntax accent-perispomeni
815 \begin_layout Subsection*
819 \begin_layout Description
820 Action Adds a tie over the next two character typed.
823 \begin_layout Description
824 Notion The following char will finish the tie.
827 \begin_layout Description
831 \begin_layout Subsection*
835 \begin_layout Description
836 Action Adds a tilde over the next character typed.
839 \begin_layout Description
843 \begin_layout Subsection*
847 \begin_layout Description
848 Action Adds an umlaut over the next character typed.
851 \begin_layout Description
855 \begin_layout Subsection*
859 \begin_layout Description
860 Action Adds a bar under the next character typed.
863 \begin_layout Description
864 Syntax accent-underbar
867 \begin_layout Subsection*
871 \begin_layout Description
872 Action Adds a dot under the next character typed.
875 \begin_layout Description
876 Syntax accent-underdot
879 \begin_layout Subsection*
883 \begin_layout Description
884 Action Accepts all tracked changes in the document.
887 \begin_layout Description
888 Syntax all-changes-accept
891 \begin_layout Description
892 Origin Levon, 16 Oct 2002
895 \begin_layout Subsection*
899 \begin_layout Description
900 Action Rejects all tracked changes in the document.
903 \begin_layout Description
904 Notion Reject does not work recursively; the user may have to repeat the
908 \begin_layout Description
909 Syntax all-changes-reject
912 \begin_layout Description
913 Origin Levon, 16 Oct 2002
916 \begin_layout Subsection*
920 \begin_layout Description
921 Action Start (or remove) Appendix on the given cursor position.
924 \begin_layout Description
928 \begin_layout Description
929 Origin ettrich, 5 May 1998
932 \begin_layout Subsection*
936 \begin_layout Description
937 Action Inserts an argument (short title) inset.
940 \begin_layout Description
941 Syntax argument-insert <argument nr>
944 \begin_layout Description
945 Params <argument nr>: see layout declarations
948 \begin_layout Description
949 Origin vermeer, 12 Aug 2002
952 \begin_layout Subsection*
956 \begin_layout Description
957 Action Adds database, which will be used for bibtex citations.
960 \begin_layout Description
961 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
962 bibliography) found from the cursor position.
965 \begin_layout Description
966 Syntax bibtex-database-add <DATABASE-NAME>
969 \begin_layout Description
970 Origin Ale, 30 May 1997
973 \begin_layout Subsection*
977 \begin_layout Description
978 Action Adds database, which will be used for bibtex citations.
981 \begin_layout Description
982 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
983 X bibliography) found from the cursor position.
986 \begin_layout Description
987 Syntax bibtex-database-del <DATABASE-NAME>
990 \begin_layout Description
991 Origin Ale, 30 May 1997
994 \begin_layout Subsection*
998 \begin_layout Description
999 Action Clears the list of saved bookmarks.
1002 \begin_layout Description
1003 Syntax bookmark-clear
1006 \begin_layout Description
1007 Origin bpeng, 31 October 2006
1010 \begin_layout Subsection*
1014 \begin_layout Description
1015 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
1016 Note that bookmarks are saved per-session, not per file.
1019 \begin_layout Description
1020 Notion Bookmark 0 has a special purpose.
1021 It is automatically set
1022 \begin_inset Newline newline
1026 to the paragraph you are currently editing
1027 \begin_inset Newline newline
1031 to the paragraph from where you are jumping to the last-edited position
1033 \begin_inset Newline newline
1037 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1040 \begin_layout Description
1041 Syntax bookmark-goto <NUMBER>
1044 \begin_layout Description
1045 Params <NUMBER>: the number of the bookmark to restore.
1048 \begin_layout Description
1049 Origin Dekel, 27 January 2001
1052 \begin_layout Subsection*
1056 \begin_layout Description
1057 Action Save a bookmark.
1060 \begin_layout Description
1061 Notion Saves a numbered bookmark to the sessions file.
1062 The number must be between 1 and 9, inclusive.
1063 Note that bookmarks are saved per-session, not per file.
1066 \begin_layout Description
1067 Syntax bookmark-save <NUMBER>
1070 \begin_layout Description
1071 Params <NUMBER>: the number of the bookmark to save.
1074 \begin_layout Description
1075 Origin Dekel, 27 January 2001
1078 \begin_layout Subsection*
1082 \begin_layout Description
1083 Action Inserts Box inset.
1086 \begin_layout Description
1087 Syntax box-insert [<TYPE>]
1090 \begin_layout Description
1091 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1092 \begin_inset Newline newline
1095 Framed is the default one.
1098 \begin_layout Description
1099 Origin vermeer, 7 Oct 2003
1102 \begin_layout Subsection*
1106 \begin_layout Description
1107 Action Inserts branch inset.
1110 \begin_layout Description
1111 Syntax branch-insert <BRANCH-NAME>
1114 \begin_layout Description
1115 Origin vermeer, 17 Aug 2003
1118 \begin_layout Subsection*
1122 \begin_layout Description
1123 Action Move the cursor to the beginning of the document.
1126 \begin_layout Description
1130 \begin_layout Subsection*
1134 \begin_layout Description
1135 Action Move the cursor to the beginning of the document adding the traversed
1136 text to the selection.
1139 \begin_layout Description
1140 Syntax buffer-begin-select
1143 \begin_layout Subsection*
1147 \begin_layout Description
1148 Action Move the cursor to the end of the document.
1151 \begin_layout Description
1155 \begin_layout Subsection*
1159 \begin_layout Description
1160 Action Move the cursor to the end of the document adding the traversed text
1164 \begin_layout Description
1165 Syntax buffer-end-select
1168 \begin_layout Subsection*
1172 \begin_layout Description
1173 Action Inserts a caption inset.
1176 \begin_layout Description
1177 Syntax caption-insert
1180 \begin_layout Description
1181 Origin Lgb, 18 Jul 2000
1184 \begin_layout Subsection*
1188 \begin_layout Description
1189 Action Moves the cursor to the previous cell inside the table.
1192 \begin_layout Description
1193 Syntax cell-backward
1196 \begin_layout Description
1197 Origin Jug, 22 May 2000
1200 \begin_layout Subsection*
1204 \begin_layout Description
1205 Action Moves the cursor to the next cell inside the table.
1208 \begin_layout Description
1212 \begin_layout Subsection*
1216 \begin_layout Description
1217 Action Splits cell and shifts right part to the next cell (inside the math
1221 \begin_layout Description
1225 \begin_layout Description
1226 Origin Ale, 15 May 1997
1229 \begin_layout Subsection*
1233 \begin_layout Description
1234 Action Accepts tracked change inside the selection.
1237 \begin_layout Description
1238 Syntax change-accept
1241 \begin_layout Description
1242 Origin Levon, 16 Oct 2002
1245 \begin_layout Subsection*
1249 \begin_layout Description
1250 Action Moves the cursor to the position of the next change of the change
1254 \begin_layout Description
1258 \begin_layout Description
1259 Origin schmitt, 4 Oct 2006
1262 \begin_layout Subsection*
1266 \begin_layout Description
1267 Action Moves the cursor to the position of the previous change of the change
1271 \begin_layout Description
1272 Syntax change-previous
1275 \begin_layout Description
1276 Origin vfr, 4 Apr 2009
1279 \begin_layout Subsection*
1283 \begin_layout Description
1284 Action Rejects tracked change inside the selection.
1287 \begin_layout Description
1288 Syntax change-reject
1291 \begin_layout Description
1292 Origin Levon, 16 Oct 2002
1295 \begin_layout Subsection*
1299 \begin_layout Description
1300 Action Open change tracking dialog for merging and moves the cursor to the
1301 position of the next change.
1304 \begin_layout Description
1305 Syntax changes-merge
1308 \begin_layout Description
1309 Origin Levon, 16 Oct 2002
1312 \begin_layout Subsection*
1316 \begin_layout Description
1317 Action Toggles showing of change tracking in typeset output.
1320 \begin_layout Description
1321 Syntax changes-output
1324 \begin_layout Description
1325 Origin spitz, 21 Jan 2005
1328 \begin_layout Subsection*
1332 \begin_layout Description
1333 Action Toggles change tracking to on/off.
1336 \begin_layout Description
1337 Syntax changes-track
1340 \begin_layout Description
1341 Origin levon, 1 Oct 2002
1344 \begin_layout Subsection*
1348 \begin_layout Description
1349 Action Moves the cursor one position logically backwards.
1352 \begin_layout Description
1353 Notion This is not the action which should be bound to the arrow keys, because
1354 backwards may be left or right, depending on the language.
1355 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1356 which in turn may employ this one.
1359 \begin_layout Description
1360 Syntax char-backward
1363 \begin_layout Subsection*
1364 char-backward-select
1367 \begin_layout Description
1368 Action Moves the cursor one position logically backwards, adding traversed
1369 position to the selection.
1372 \begin_layout Description
1373 Notion See also LFUN_CHAR_BACKWARD.
1376 \begin_layout Description
1377 Syntax char-backward-select
1380 \begin_layout Subsection*
1381 char-delete-backward
1384 \begin_layout Description
1385 Action Deletes one character in the backward direction (usually the "BackSpace"
1389 \begin_layout Description
1390 Syntax char-delete-backward [force]
1393 \begin_layout Description
1394 Params force: Delete big insets, do not only select them.
1397 \begin_layout Subsection*
1401 \begin_layout Description
1402 Action Deletes one character in the backward direction (usually the "Delete"
1406 \begin_layout Description
1407 Syntax char-delete-forward [force]
1410 \begin_layout Description
1411 Params force: Delete big insets, do not only select them.
1414 \begin_layout Subsection*
1418 \begin_layout Description
1419 Action Moves the cursor one position logically forward.
1422 \begin_layout Description
1423 Notion This is not the action which should be bound to the arrow keys, because
1424 forward may be left or right, depending on the language.
1425 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1426 which in turn may employ this one.
1429 \begin_layout Description
1433 \begin_layout Subsection*
1437 \begin_layout Description
1438 Action Moves the cursor one position logically forward, adding traversed
1439 position to the selection.
1442 \begin_layout Description
1443 Notion See also LFUN_CHAR_FORWARD.
1446 \begin_layout Description
1447 Syntax char-forward-select
1450 \begin_layout Subsection*
1454 \begin_layout Description
1455 Action Moves the cursor one position "to the left".
1458 \begin_layout Description
1459 Notion This is the action which should be taken when the "left" key is pressed.
1460 Generally, it moves the cursor one position to the left.
1461 However, in Bidi text this become slightly more complicated, and there
1462 are different modes of cursor movement.
1463 In "visual mode", this moves left, plain and simple.
1464 In "logical mode", movement is logically forward in RTL paragraphs, and
1465 logically backwards in LTR paragraphs.
1468 \begin_layout Description
1472 \begin_layout Subsection*
1476 \begin_layout Description
1477 Action Moves the cursor one position "to the left", adding traversed position
1481 \begin_layout Description
1482 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1485 \begin_layout Description
1486 Syntax char-left-select
1489 \begin_layout Subsection*
1493 \begin_layout Description
1494 Action Moves the cursor one position "to the right".
1497 \begin_layout Description
1498 Notion This is the action which should be taken when the "right" key is
1500 Generally, it moves the cursor one position to the right.
1501 However, in Bidi text this become slightly more complicated, and there
1502 are different modes of cursor movement.
1503 In "visual mode", this moves right, plain and simple.
1504 In "logical mode", movement is logically forward in LTR paragraphs, and
1505 logically backwards in RTL paragraphs.
1508 \begin_layout Description
1512 \begin_layout Subsection*
1516 \begin_layout Description
1517 Action Moves the cursor one position "to the right", adding traversed position
1521 \begin_layout Description
1522 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1525 \begin_layout Description
1526 Syntax char-right-select
1529 \begin_layout Subsection*
1533 \begin_layout Description
1534 Action Transposes the character at the cursor with the one before it.
1537 \begin_layout Description
1538 Syntax chars-transpose
1541 \begin_layout Description
1542 Origin Lgb, 25 Apr 2001
1545 \begin_layout Subsection*
1549 \begin_layout Description
1550 Action Inserts citation from loaded citation database.
1553 \begin_layout Description
1554 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1557 \begin_layout Description
1558 Params <KEY>: Citation (shortcut listed in available citations).
1559 \begin_inset Newline newline
1562 <TEXT_BEFORE>: text which should appear before citation.
1565 \begin_layout Description
1566 Origin AAS, 97-02-23
1569 \begin_layout Subsection*
1573 \begin_layout Description
1574 Action Pastes text from the active clipboard (retains formatting if the
1575 clipboard contains formatted text).
1576 Pastes plain text if plain text is on the clipboard, but tries to interpret
1577 it in special ways for certain insets, e.g.
1578 converting csv data to rows and columns if the paste happens in a tabular
1582 \begin_layout Description
1583 Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart
1584 of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1585 is the clipboard, not the selection.
1588 \begin_layout Description
1589 Syntax clipboard-paste [<ARG>]
1592 \begin_layout Description
1593 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1597 \begin_layout Description
1598 Origin Georg, 10 Jul 2006
1601 \begin_layout Subsection*
1602 clipboard-paste-simple
1605 \begin_layout Description
1606 Action Pastes plain text from the active clipboard even if formatted LyX
1607 content is in the clipboard.
1608 Pastes plain text if plain text is on the clipboard, without trying to
1609 interpret it in special ways for certain insets, e.g.
1610 converting csv data to rows and columns if the paste happens in a tabular
1614 \begin_layout Description
1615 Syntax clipboard-paste-simple [<ARG>]
1618 \begin_layout Description
1619 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1623 \begin_layout Subsection*
1627 \begin_layout Description
1628 Action Switches the focus to the minibuffer so that the user can type in
1630 If necessary, it opens the minibuffer toolbar.
1633 \begin_layout Description
1634 Notion Usually bound to M-x shortcut.
1637 \begin_layout Description
1638 Syntax command-execute
1641 \begin_layout Subsection*
1645 \begin_layout Description
1646 Action Try to complete the word or command at the cursor position.
1649 \begin_layout Description
1653 \begin_layout Description
1654 Origin sts, Feb 19 2008
1657 \begin_layout Subsection*
1661 \begin_layout Description
1662 Action Accept suggested completion.
1665 \begin_layout Description
1666 Syntax completion-accept
1669 \begin_layout Description
1670 Origin sanda, Sep 08 2008
1673 \begin_layout Subsection*
1677 \begin_layout Description
1678 Action Try to cancel completion, either the popup or the inline completion.
1681 \begin_layout Description
1682 Syntax completion-cancel
1685 \begin_layout Description
1686 Origin sts, Sep 07 2008
1689 \begin_layout Subsection*
1693 \begin_layout Description
1694 Action Show the inline completion at the cursor position.
1697 \begin_layout Description
1698 Syntax completion-inline
1701 \begin_layout Description
1702 Origin sts, Feb 19 2008
1705 \begin_layout Subsection*
1709 \begin_layout Description
1710 Action Show the completion popup at the cursor position.
1713 \begin_layout Description
1714 Syntax completion-popup
1717 \begin_layout Description
1718 Origin sts, Feb 19 2008
1721 \begin_layout Subsection*
1725 \begin_layout Description
1726 Action Copies the current selection to the clipboard.
1729 \begin_layout Description
1733 \begin_layout Subsection*
1737 \begin_layout Description
1738 Action Cuts to the clipboard.
1741 \begin_layout Description
1745 \begin_layout Subsection*
1749 \begin_layout Description
1750 Action Inserts the current date.
1753 \begin_layout Description
1754 Syntax date-insert [<ARG>]
1757 \begin_layout Description
1758 Params <ARG>: Format of date.
1759 The default value (%x) can be set in Preferences->Date format.
1760 For possible formats see manual page of strftime function.
1763 \begin_layout Description
1764 Origin jdblair, 31 Jan 2000
1767 \begin_layout Subsection*
1771 \begin_layout Description
1772 Action Decrease the nesting depth of the (selected) paragraph(s) inside
1776 \begin_layout Description
1777 Syntax depth-decrement
1780 \begin_layout Subsection*
1784 \begin_layout Description
1785 Action Increase the nesting depth of the (selected) paragraph(s) inside
1789 \begin_layout Description
1790 Syntax depth-increment
1793 \begin_layout Subsection*
1794 dialog-disconnect-inset
1797 \begin_layout Description
1798 Action Closes opened connection to opened inset.
1801 \begin_layout Description
1802 Notion Connection is used for apply functions.
1805 \begin_layout Description
1806 Syntax dialog-disconnect-inset <INSET-NAME>
1809 \begin_layout Description
1810 Origin leeming, 25 Feb 2003
1813 \begin_layout Subsection*
1817 \begin_layout Description
1818 Action Hides showed dialog.
1819 Counterpart to LFUN_DIALOG_SHOW .
1822 \begin_layout Description
1823 Syntax dialog-hide <NAME>
1826 \begin_layout Description
1827 Params See LFUN_DIALOG_SHOW .
1830 \begin_layout Description
1831 Origin leeming, 25 Feb 2003
1834 \begin_layout Subsection*
1838 \begin_layout Description
1839 Action Shows hidden dialog or creates new one for a given function/inset
1843 \begin_layout Description
1844 Syntax dialog-show <NAME> [<DATA>]
1847 \begin_layout Description
1848 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1849 \begin_inset Newline newline
1852 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1853 \begin_inset Newline newline
1856 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
1858 \begin_inset Newline newline
1861 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1862 \begin_inset Newline newline
1865 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1866 \begin_inset Newline newline
1869 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1870 \begin_inset Newline newline
1873 <SPECIAL>: latexlog|vclog
1874 \begin_inset Newline newline
1877 <DATA>: data, usually settings for the given dialog.
1878 Use debug mode for the details.
1881 \begin_layout Description
1882 Origin leeming, 17 Jun 2003
1885 \begin_layout Subsection*
1886 dialog-show-new-inset
1889 \begin_layout Description
1890 Action Shows hidden dialog or create new one for a given inset settings
1894 \begin_layout Description
1895 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
1899 \begin_layout Description
1900 Syntax dialog-show-new-inset <NAME> [<DATA>]
1903 \begin_layout Description
1904 Params See LFUN_DIALOG_SHOW .
1907 \begin_layout Description
1908 Origin leeming, 25 Feb 2003
1911 \begin_layout Subsection*
1915 \begin_layout Description
1916 Action Toggles dialog between showed/hidden state.
1919 \begin_layout Description
1920 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1923 \begin_layout Description
1924 Syntax dialog-toggle <NAME> [<DATA>]
1927 \begin_layout Description
1928 Params See LFUN_DIALOG_SHOW .
1931 \begin_layout Description
1932 Origin spitz, 30 Apr 2007
1935 \begin_layout Subsection*
1939 \begin_layout Description
1940 Action Updates the dialog values from the inset/paragraph/document.
1943 \begin_layout Description
1944 Syntax dialog-update <NAME>
1947 \begin_layout Description
1948 Params <NAME>: paragraph|prefs|<INSET>
1949 \begin_inset Newline newline
1955 \begin_layout Description
1956 Origin leeming, 25 Feb 2003
1959 \begin_layout Subsection*
1963 \begin_layout Description
1964 Action Moves the cursor one line in downward direction.
1967 \begin_layout Description
1971 \begin_layout Subsection*
1975 \begin_layout Description
1976 Action Moves the cursor one line in downward direction adding the current
1977 position to the selection.
1980 \begin_layout Description
1984 \begin_layout Subsection*
1988 \begin_layout Description
1989 Action Inserts an ERT inset.
1992 \begin_layout Description
1996 \begin_layout Description
1997 Origin Jug, 18 Feb 2000
2000 \begin_layout Subsection*
2004 \begin_layout Description
2005 Action Clears the selection.
2006 If no text is selected call LFUN_FINISHED_FORWARD.
2007 Inside math mode jumps out of the math inset.
2010 \begin_layout Description
2014 \begin_layout Description
2015 Origin Lgb, 17 May 2001
2018 \begin_layout Subsection*
2022 \begin_layout Description
2023 Action Cancel background export process.
2026 \begin_layout Description
2027 Syntax export-cancel
2030 \begin_layout Description
2031 Origin rgh, 10 December 2017
2034 \begin_layout Subsection*
2038 \begin_layout Description
2039 Action Inserts another LyX file.
2042 \begin_layout Description
2043 Syntax file-insert [<FILE>]
2046 \begin_layout Description
2047 Params <FILE>: Filename to be inserted.
2050 \begin_layout Subsection*
2051 file-insert-plaintext
2054 \begin_layout Description
2055 Action Inserts plain text file.
2058 \begin_layout Description
2059 Syntax file-insert-plaintext [<FILE>]
2062 \begin_layout Description
2063 Params <FILE>: Filename to be inserted.
2066 \begin_layout Description
2067 Origin CFO-G, 19 Nov 1997
2070 \begin_layout Subsection*
2071 file-insert-plaintext-para
2074 \begin_layout Description
2075 Action Inserts plain text file as paragraph (i.e.
2079 \begin_layout Description
2080 Syntax file-insert-plaintext-para [<FILE>]
2083 \begin_layout Description
2084 Params <FILE>: Filename to be inserted.
2087 \begin_layout Description
2088 Origin Levon, 14 Feb 2001
2091 \begin_layout Subsection*
2095 \begin_layout Description
2096 Action Inserts CharStyle, Custom inset or XML short element.
2099 \begin_layout Description
2100 Notion Look into the Customization manual for more information about these
2102 \begin_inset Newline newline
2105 To make this command enabled the layout file for the document class you're
2106 using has to load the character styles.
2107 There are a few contained in the Logical Markup module.
2108 You can also of course create some yourself.
2109 \begin_inset Newline newline
2112 For dissolving the element see LFUN_INSET_DISSOLVE.
2115 \begin_layout Description
2116 Syntax flex-insert Name
2119 \begin_layout Description
2120 Params Name: This name must be defined either in your layout file or imported
2122 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
2123 The Flex: prefix is optional.
2126 \begin_layout Description
2127 Sample flex-insert Code
2130 \begin_layout Subsection*
2134 \begin_layout Description
2135 Action Inserts a float inset.
2138 \begin_layout Description
2139 Syntax float-insert <TYPE>
2142 \begin_layout Description
2143 Params <TYPE>: type of float depends on the used textclass.
2144 Usually "algorithm", "table", "figure" parameters can be given.
2147 \begin_layout Description
2148 Origin Lgb, 27 Jun 2000
2151 \begin_layout Subsection*
2155 \begin_layout Description
2156 Action Inserts the list of floats in the document.
2159 \begin_layout Description
2160 Syntax float-list-insert <TYPE>
2163 \begin_layout Description
2164 Params <TYPE>: type of float depends on the used textclass.
2165 Usually "algorithm", "table", "figure" parameters can be given.
2168 \begin_layout Description
2169 Origin Lgb, 3 May 2001
2172 \begin_layout Subsection*
2176 \begin_layout Description
2177 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2180 \begin_layout Description
2181 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2184 \begin_layout Description
2185 Syntax float-wide-insert <TYPE>
2188 \begin_layout Description
2189 Params <TYPE>: type of float depends on the used textclass.
2190 Usually "algorithm", "table", "figure" parameters can be given.
2193 \begin_layout Description
2194 Origin Lgb, 31 Oct 2001
2197 \begin_layout Subsection*
2201 \begin_layout Description
2202 Action Inserts a footnote inset.
2205 \begin_layout Description
2206 Syntax footnote-insert
2209 \begin_layout Description
2210 Origin Jug, 7 Mar 2000
2213 \begin_layout Subsection*
2217 \begin_layout Description
2218 Action Reloads the image if necessary.
2221 \begin_layout Description
2222 Syntax graphics-reload
2225 \begin_layout Description
2226 Origin vfr, 10 Aug 2009
2229 \begin_layout Subsection*
2233 \begin_layout Description
2234 Action Inserts hyperlinks into the document (clickable in pdf output).
2237 \begin_layout Description
2238 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2241 \begin_layout Description
2242 Syntax href-insert [<TARGET>]
2245 \begin_layout Description
2246 Origin CFO-G, 21 Nov 1997
2249 \begin_layout Subsection*
2253 \begin_layout Description
2254 Action Only active in IPA inset.
2257 \begin_layout Description
2258 Notion Dummy function which is only active in a IPA inset.
2259 It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2262 \begin_layout Description
2266 \begin_layout Description
2267 Origin spitz, 20 May 2012
2270 \begin_layout Subsection*
2274 \begin_layout Description
2275 Action Inserts Index entry.
2278 \begin_layout Description
2279 Notion It automatically takes the word on the cursor position.
2282 \begin_layout Description
2283 Syntax index-insert [<TYPE:Name>]
2286 \begin_layout Description
2287 Params <TYPE:Name>: name of the index, if multiple indices are defined.
2288 With an empty argument, the default index is selected.
2291 \begin_layout Description
2292 Origin leeming, 3 Aug 2000
2295 \begin_layout Subsection*
2299 \begin_layout Description
2300 Action Inserts list of Index entries on a new page.
2303 \begin_layout Description
2304 Syntax index-print [<TYPE:Name>]
2307 \begin_layout Description
2308 Params <TYPE:Name>: name of the index, if multiple indices are defined.
2309 With an empty argument, the default index is selected.
2312 \begin_layout Description
2313 Origin Lgb, 27 Feb 1997
2316 \begin_layout Subsection*
2320 \begin_layout Description
2321 Action Displays shortcuts, lyxrc, package and textclass availability and
2322 menu information in a non-editable boxed InsetText.
2325 \begin_layout Description
2326 Notion Apart from lfun arguments you can use the following method:
2327 \begin_inset Newline newline
2331 input the type and argument of this inset, e.g.
2332 "menu paste", in the work area.
2333 \begin_inset Newline newline
2337 select the text and run info-insert lfun.
2340 \begin_layout Description
2341 Syntax info-insert <TYPE> <ARG>
2344 \begin_layout Description
2345 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|buffer
2346 \begin_inset Newline newline
2349 <ARG>: argument for a given type.
2350 Look into InsetInfo.h for detailed description.
2351 \begin_inset Newline newline
2354 shortcut[s]: name of lfun (e.g math-insert
2357 \begin_inset Newline newline
2360 lyxrc: name of rc_entry (e.g.
2362 \begin_inset Newline newline
2365 lyxinfo: "version" - used version of LyX
2366 \begin_inset Newline newline
2369 package: name of latex package (e.g.
2371 \begin_inset Newline newline
2374 textclass: name of textclass (e.g.
2376 \begin_inset Newline newline
2379 menu: name of lfun used in menu
2380 \begin_inset Newline newline
2383 icon: icon of lfun used in toolbar or direct icon name
2384 \begin_inset Newline newline
2387 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"
2388 vcs-date"|"vcs-time"
2391 \begin_layout Description
2392 Sample command-sequence info-insert buffer path; info-insert buffer name
2395 \begin_layout Description
2396 Origin bpeng, 7 Oct 2007
2399 \begin_layout Subsection*
2403 \begin_layout Description
2404 Action Apply data for an inset.
2407 \begin_layout Description
2408 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
2410 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
2411 on the context where it is called.
2414 \begin_layout Description
2415 Syntax inset-apply <ARGS>
2418 \begin_layout Description
2419 Params See LFUN_INSET_INSERT .
2422 \begin_layout Subsection*
2426 \begin_layout Description
2427 Action Move the cursor to the beginning of the current inset if it is not
2428 already there, or at the beginning of the enclosing inset otherwise
2431 \begin_layout Description
2435 \begin_layout Description
2436 Origin lasgouttes, 16 Mar 2009
2439 \begin_layout Subsection*
2443 \begin_layout Description
2444 Action Move the cursor to the beginning of the current inset if it is not
2445 already there, or at the beginning of the enclosing inset otherwise (adding
2446 the traversed text to the selection).
2449 \begin_layout Description
2450 Syntax inset-begin-select
2453 \begin_layout Description
2454 Origin lasgouttes, 16 Mar 2009
2457 \begin_layout Subsection*
2461 \begin_layout Description
2462 Action Copies the inset to the clipboard as a certain type.
2465 \begin_layout Description
2466 Notion Currently used only for InsetInfo where its content is copied as
2470 \begin_layout Description
2471 Syntax inset-copy-as
2474 \begin_layout Description
2475 Origin vfr, 18 Apr 2010
2478 \begin_layout Subsection*
2482 \begin_layout Description
2483 Action Dissolve the current inset into text.
2486 \begin_layout Description
2487 Syntax inset-dissolve [<INSET>]
2490 \begin_layout Description
2491 Params <INSET>: this can be used to make sure the right kind of inset is
2493 For example "dissolve" entry in the charstyles sub-menu should only dissolve
2494 the charstyle inset, even if the cursor is inside several nested insets
2496 \begin_inset Newline newline
2499 For values see lyx::InsetLayout::lyxtype_ .
2502 \begin_layout Description
2503 Origin JSpitz, 7 Aug 2006
2506 \begin_layout Subsection*
2510 \begin_layout Description
2511 Action Edit the inset at cursor with an external application, if one is
2515 \begin_layout Description
2516 Syntax inset-edit [<INSET_PARAMS>]
2519 \begin_layout Description
2520 Params <INSET_PARAMS>: Parameters for the inset.
2521 \begin_inset Newline newline
2524 Currently only the filename will be considered.
2527 \begin_layout Description
2528 Origin spitz, 27 Apr 2006
2531 \begin_layout Subsection*
2535 \begin_layout Description
2536 Action Move the cursor to the end of the current inset if it is not already
2537 there, or at the end of the enclosing inset otherwise
2540 \begin_layout Description
2544 \begin_layout Description
2545 Origin lasgouttes, 16 Mar 2009
2548 \begin_layout Subsection*
2552 \begin_layout Description
2553 Action Move the cursor to the end of the current inset if it is not already
2554 there, or at the end of the enclosing inset otherwise (adding the traversed
2555 text to the selection).
2558 \begin_layout Description
2559 Syntax inset-end-select
2562 \begin_layout Description
2563 Origin lasgouttes, 16 Mar 2009
2566 \begin_layout Subsection*
2570 \begin_layout Description
2571 Action Apply the given commands on insets of a given name.
2574 \begin_layout Description
2575 Notion WARNING: use at your own risks; this function gives you too many
2576 ways of shooting yourself in the foot.
2577 A typical example is inset-forall Note note-insert which starts an infinite
2579 This is mitigated by the fact that the number of actions is arbitrarily
2581 Note also that inset-forall does not update metrics between iterations,
2582 which can lead to bugs.
2583 This has to be eventually fixed.
2586 \begin_layout Description
2587 Syntax inset-forall <NAME> <LFUN-COMMAND>
2588 \begin_inset Newline newline
2591 <NAME>: Type of Inset.
2592 If <NAME> is *, all insets are matched.
2593 The name is used like for InsetLayout in layout files: "Note" matches all
2594 note insets, while "Note:Note" only matches LyX yellow note insets.
2597 \begin_layout Description
2598 Sample Remove all index insets:
2599 \begin_inset Newline newline
2602 inset-forall Index char-delete-forward force
2603 \begin_inset Newline newline
2606 Close all Notes (also works for a particular branch, for example):
2607 \begin_inset Newline newline
2610 inset-forall Note inset-toggle close
2611 \begin_inset Newline newline
2614 Transform all yellow notes to comments
2615 \begin_inset Newline newline
2618 inset-forall Note:Note inset-modify note Note Comment
2619 \begin_inset Newline newline
2622 Try to put LyX in an infinite loop if there is at least a Note:
2623 \begin_inset Newline newline
2626 inset-forall Note char-backward
2629 \begin_layout Description
2630 Origin lasgouttes, 27 Nov 2009
2633 \begin_layout Subsection*
2637 \begin_layout Description
2638 Action Insert new inset (type given by the parameters).
2641 \begin_layout Description
2642 Syntax inset-insert <INSET> <ARGS>
2645 \begin_layout Description
2646 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2647 \begin_inset Newline newline
2650 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2651 \begin_inset Newline newline
2654 <ARGS>: depends on the given inset.
2655 Use "lyx -dbg action" to explore.
2658 \begin_layout Description
2659 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2662 \begin_inset Newline newline
2665 where <label name> is the name of the referenced label and <Format> is one
2667 \begin_inset Newline newline
2671 \begin_inset Newline newline
2674 eqref -- (<reference>)
2675 \begin_inset Newline newline
2679 \begin_inset Newline newline
2682 vpageref -- on <page>
2683 \begin_inset Newline newline
2686 vref -- <reference> on <page>
2687 \begin_inset Newline newline
2690 formatted -- Formatted reference
2693 \begin_layout Subsection*
2697 \begin_layout Description
2698 Action Modify some properties of an inset.
2701 \begin_layout Description
2702 Notion Used for argument, bibitem, bibtex, box, branch, caption, citation,
2703 command, ert, external, float, graphics, include, index, info, label, line,
2704 listings, newline, newpage, nomencl, note, phantom, quotes, ref, script,
2705 separator, space, tabular, vspace and wrap insets.
2708 \begin_layout Description
2709 Syntax inset-modify <INSET> <ARGS>
2710 \begin_inset Newline newline
2713 inset-modify changetype <TYPE>
2716 \begin_layout Description
2717 Sample Change a Note inset into a Comment inset:
2718 \begin_inset Newline newline
2721 inset-modify note Note Comment
2722 \begin_inset Newline newline
2725 Change a Box into an Ovalbox:
2726 \begin_inset Newline newline
2729 inset-modify changetype Ovalbox
2730 \begin_inset Newline newline
2733 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle
2735 \begin_inset Newline newline
2738 inset-modify changetype els
2739 \begin_inset Newline newline
2742 Change only the style of a quotation mark, maintaining the other aspects
2745 \begin_inset Newline newline
2748 inset-modify changetype e..
2749 \begin_inset Newline newline
2755 \begin_layout Subsection*
2759 \begin_layout Description
2760 Action Select all contents of an inset.
2763 \begin_layout Description
2764 Notion There are 3 successive levels: select current cell, select all cells
2765 of inset, select the inset from outside (in the enclosing inset).
2768 \begin_layout Description
2769 Syntax inset-select-all
2772 \begin_layout Description
2773 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2776 \begin_layout Subsection*
2780 \begin_layout Description
2781 Action Open the inset's properties dialog.
2784 \begin_layout Description
2785 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
2786 graphics, href, include, index, index_print, label, line, listings, note,
2787 phantom, ref, space, tabular, vspace, wrap insets.
2790 \begin_layout Description
2791 Syntax inset-settings <INSET>
2794 \begin_layout Description
2795 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2796 \begin_inset Newline newline
2799 graphics|href|include|index|index_print|label|line|
2800 \begin_inset Newline newline
2803 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2806 \begin_layout Subsection*
2810 \begin_layout Description
2811 Action Toggles the collapsible inset at cursor position, or the inset we
2815 \begin_layout Description
2816 Syntax inset-toggle [<ARG>]
2819 \begin_layout Description
2820 Params <ARG>: <open|close|toggle|assign>.
2821 \begin_inset Newline newline
2824 open/close/toggle are for collapsible insets.
2825 toggle is used when no argument is given.
2826 \begin_inset Newline newline
2829 assign synchronize the branch-inset with activation status of the branch.
2830 Used for global toggling when changed activation.
2833 \begin_layout Description
2834 Origin lasgouttes, 19 Jul 2001
2837 \begin_layout Subsection*
2841 \begin_layout Description
2842 Action Inserts an IPA inset.
2845 \begin_layout Description
2849 \begin_layout Description
2850 Origin spitz, 05 Mar 2012
2853 \begin_layout Subsection*
2857 \begin_layout Description
2858 Action Inserts special IPA macros into the document.
2861 \begin_layout Description
2862 Syntax ipamacro-insert <CHAR>
2865 \begin_layout Description
2866 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2867 tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2870 \begin_layout Description
2871 Origin spitz, 22 Aug 2012
2874 \begin_layout Subsection*
2878 \begin_layout Description
2879 Action Turn off the loaded keyboard map.
2882 \begin_layout Description
2886 \begin_layout Subsection*
2890 \begin_layout Description
2891 Action Turn on the primary keyboard map.
2894 \begin_layout Description
2895 Notion Maps were widely used in past, when X-windows didn't have nowadays
2897 They can be still used to maintain uniform keyboard layout across the various
2899 \begin_inset Newline newline
2902 The language is to be set in the Preferences dialog.
2905 \begin_layout Description
2906 Syntax keymap-primary
2909 \begin_layout Subsection*
2913 \begin_layout Description
2914 Action Turn on the secondary keyboard map.
2917 \begin_layout Description
2918 Syntax keymap-secondary
2921 \begin_layout Subsection*
2925 \begin_layout Description
2926 Action Toggles keyboard maps (first/second/off).
2929 \begin_layout Description
2930 Syntax keymap-toggle
2933 \begin_layout Description
2934 Origin leeming, 30 Mar 2004
2937 \begin_layout Subsection*
2938 label-copy-as-reference
2941 \begin_layout Description
2942 Action Copies the label at the cursor as a cross-reference to be pasted
2946 \begin_layout Description
2947 Syntax copy-label-as-reference <LABEL>
2950 \begin_layout Description
2951 Params <LABEL>: The label to copy (for multi-line math)
2954 \begin_layout Description
2955 Origin sts, 16 Nov 2008
2958 \begin_layout Subsection*
2962 \begin_layout Description
2963 Action Goto a label.
2966 \begin_layout Description
2967 Syntax label-goto [<LABEL>]
2970 \begin_layout Description
2971 Params <LABEL>: Requested label.
2972 If no label is given and reference is on cursor position, Bookmark 0 is
2973 saved and cursor moves to the position of referenced label.
2976 \begin_layout Description
2977 Origin Ale, 6 Aug 1997
2980 \begin_layout Subsection*
2984 \begin_layout Description
2985 Action Inserts label to text or displayed formula.
2988 \begin_layout Description
2989 Syntax label-insert [<LABEL>]
2992 \begin_layout Description
2993 Params <LABEL>: Requested label.
2994 If no label is given dialog requesting name will be opened.
2997 \begin_layout Subsection*
2998 label-insert-as-reference
3001 \begin_layout Description
3002 Action Inserts the label (in ToC pane) as a cross-reference at the position
3006 \begin_layout Description
3007 Syntax label-insert-as-reference
3010 \begin_layout Description
3011 Origin vfr, 7 Apr 2009
3014 \begin_layout Subsection*
3018 \begin_layout Description
3019 Action Set language from the current cursor position.
3022 \begin_layout Description
3023 Syntax language <LANG> [set]
3026 \begin_layout Description
3027 Params <LANG>: Requested language.
3028 Look in lib/languages for the list.
3029 "language reset" or "language" (without param) reset to the document language.
3030 set: If used, the language will be set to the specified language.
3031 Otherwise, the language will be toggled (i.e., if the current language is
3032 LANG, switch to the document language or the default language, if LANG
3033 is the document language).
3036 \begin_layout Description
3037 Origin Dekel, 2 Mar 2000
3040 \begin_layout Subsection*
3044 \begin_layout Description
3045 Action Move the cursor to the beginning of the (screen) line.
3048 \begin_layout Description
3052 \begin_layout Subsection*
3056 \begin_layout Description
3057 Action Move the cursor to the beginning of the (screen) line adding the
3058 traversed text to the selection.
3061 \begin_layout Description
3062 Syntax line-begin-select
3065 \begin_layout Subsection*
3069 \begin_layout Description
3070 Action Deletes the letters to the end of the (screen) line or deletes the
3074 \begin_layout Description
3075 Syntax line-delete-forward
3078 \begin_layout Subsection*
3082 \begin_layout Description
3083 Action Move the cursor to the end of the (screen) line.
3086 \begin_layout Description
3090 \begin_layout Subsection*
3094 \begin_layout Description
3095 Action Move the cursor to the end of the (screen) line adding the traversed
3096 text to the selection.
3099 \begin_layout Description
3100 Syntax line-end-select
3103 \begin_layout Subsection*
3107 \begin_layout Description
3108 Action Inserts a new listings inset.
3111 \begin_layout Description
3112 Syntax listing-insert
3115 \begin_layout Description
3116 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
3119 \begin_layout Subsection*
3123 \begin_layout Description
3124 Action Inserts a marginal note.
3127 \begin_layout Description
3128 Syntax marginalnote-insert
3131 \begin_layout Description
3132 Origin Lgb, 26 Jun 2000
3135 \begin_layout Subsection*
3139 \begin_layout Description
3140 Action Disable selecting of text-region.
3143 \begin_layout Description
3147 \begin_layout Subsection*
3151 \begin_layout Description
3152 Action Enable selecting of text-region.
3155 \begin_layout Description
3156 Notion After enabling you can simply move arrow keys to get selected region.
3159 \begin_layout Description
3163 \begin_layout Subsection*
3167 \begin_layout Description
3168 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3171 \begin_layout Description
3175 \begin_layout Description
3176 Origin Andre, May 5 2006
3179 \begin_layout Subsection*
3183 \begin_layout Description
3184 Action Inserts a line break or new line.
3187 \begin_layout Description
3188 Syntax newline-insert [<ARG>]
3191 \begin_layout Description
3192 Params <ARG>: <newline|linebreak> default: newline
3195 \begin_layout Description
3196 Origin spitz, 25 Mar 2008
3199 \begin_layout Subsection*
3203 \begin_layout Description
3204 Action Inserts a new page.
3207 \begin_layout Description
3208 Syntax newpage-insert <ARG>
3211 \begin_layout Description
3212 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3215 \begin_layout Description
3216 Origin uwestoehr, 24 Nov 2007
3219 \begin_layout Subsection*
3223 \begin_layout Description
3224 Action Inserts Nomenclature entry.
3227 \begin_layout Description
3228 Notion It automatically takes the word on the cursor position if no symbol
3232 \begin_layout Description
3233 Syntax nomencl-insert [<SYMBOL>]
3236 \begin_layout Description
3237 Origin Ugras, 4 Nov 2006
3240 \begin_layout Subsection*
3244 \begin_layout Description
3245 Action Inserts list of Nomenclature entries.
3248 \begin_layout Description
3249 Syntax nomenclature-print
3252 \begin_layout Description
3253 Origin Ugras, 4 Nov 2006
3256 \begin_layout Subsection*
3260 \begin_layout Description
3261 Action Inserts Note on the current cursor position, move selection inside
3265 \begin_layout Description
3266 Syntax note-insert [<TYPE>]
3269 \begin_layout Description
3270 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3273 \begin_layout Subsection*
3277 \begin_layout Description
3278 Action Moves the cursor to the beginning of next Note inset.
3281 \begin_layout Description
3285 \begin_layout Subsection*
3289 \begin_layout Description
3290 Action Move the current group in the downward direction in the structure
3294 \begin_layout Description
3295 Notion The "group" can be Part/Chapter/Section/etc.
3296 It moves the whole substructure of the group.
3299 \begin_layout Description
3303 \begin_layout Description
3304 Origin Vermeer, 23 Mar 2006
3307 \begin_layout Subsection*
3311 \begin_layout Description
3312 Action Moves the current group in the downward direction in the hierarchy
3313 of the document structure.
3316 \begin_layout Description
3317 Notion Part -> Chapter -> Section -> etc.
3320 \begin_layout Description
3324 \begin_layout Description
3325 Origin Vermeer, 23 Mar 2006
3328 \begin_layout Subsection*
3332 \begin_layout Description
3333 Action Moves the current group in the upward direction in the hierarchy
3334 of the document structure.
3337 \begin_layout Description
3338 Notion Part <- Chapter <- Section <- etc.
3341 \begin_layout Description
3345 \begin_layout Description
3346 Origin Vermeer, 23 Mar 2006
3349 \begin_layout Subsection*
3353 \begin_layout Description
3354 Action Move the current group in the upward direction in the structure of
3358 \begin_layout Description
3359 Notion The "group" can be Part/Chapter/Section/etc.
3360 It moves the whole substructure of the group.
3363 \begin_layout Description
3367 \begin_layout Description
3368 Origin Vermeer, 23 Mar 2006
3371 \begin_layout Subsection*
3375 \begin_layout Description
3376 Action Breaks the current paragraph at the current location.
3379 \begin_layout Description
3380 Notion Removes the selection.
3383 \begin_layout Description
3384 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3387 \begin_layout Description
3388 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3389 default layout) when the cursor is at the end of the line.
3390 \begin_inset Newline newline
3393 ignoresep: Do not account for paragraph separators while breaking.
3396 \begin_layout Subsection*
3400 \begin_layout Description
3401 Action Move the cursor to the next paragraph (or beginning of the current
3402 one) in downward direction.
3405 \begin_layout Description
3406 Syntax paragraph-down
3409 \begin_layout Description
3410 Origin Asger, 1 Oct 1996
3413 \begin_layout Subsection*
3414 paragraph-down-select
3417 \begin_layout Description
3418 Action Move the cursor and select the text to the next paragraph (or beginning
3419 of the current one) in downward direction.
3422 \begin_layout Description
3423 Syntax paragraph-down-select
3426 \begin_layout Description
3427 Origin Asger, 1 Oct 1996
3430 \begin_layout Subsection*
3434 \begin_layout Description
3435 Action Jump to a paragraph given by its id number and optionally the desired
3436 position within the paragraph.
3437 If given four arguments id_start, pos_start, id_end, pos_end, perform a
3438 selection from start to end.
3441 \begin_layout Description
3442 Notion Note that id number of paragraph is not the sequential number of
3443 paragraph seen on the screen.
3444 Moreover the id is unique for all opened buffers (documents).
3445 Both ids must belong to the same buffer.
3448 \begin_layout Description
3449 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3452 \begin_layout Description
3453 Params <PAR_ID>: paragraph id
3454 \begin_inset Newline newline
3457 <POS_IN_PAR>: desired position within the paragraph
3460 \begin_layout Description
3461 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3464 \begin_layout Subsection*
3468 \begin_layout Description
3469 Action Moves the current paragraph downwards in the document.
3472 \begin_layout Description
3473 Syntax paragraph-move-down
3476 \begin_layout Description
3477 Origin Edwin, 8 Apr 2006
3480 \begin_layout Subsection*
3484 \begin_layout Description
3485 Action Moves the current paragraph upwards in the document.
3488 \begin_layout Description
3489 Notion Movement through the document will possibly break the paragraph-depth
3494 \begin_layout Description
3495 Syntax paragraph-move-up
3498 \begin_layout Description
3499 Origin Edwin, 8 Apr 2006
3502 \begin_layout Subsection*
3506 \begin_layout Description
3507 Action Change paragraph settings.
3510 \begin_layout Description
3511 Notion Modifies the current paragraph, or currently selected paragraphs.
3512 This function only modifies, and does not override, existing settings.
3513 Note that the "leftindent" indent setting is deprecated.
3516 \begin_layout Description
3517 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3520 \begin_layout Description
3530 \begin_inset Newline newline
3535 paragraph_spacing default|single|onehalf|double|other SIZE
3536 \begin_inset Newline newline
3541 align block|left|right|center|default
3542 \begin_inset Newline newline
3547 labelwidthstring WIDTH|
3552 \begin_layout Description
3553 Origin rgh, Aug 15 2007
3556 \begin_layout Subsection*
3557 paragraph-params-apply
3560 \begin_layout Description
3561 Action Change paragraph settings.
3564 \begin_layout Description
3565 Notion Overwrite all nonspecified settings to the default ones.
3566 Use paragraph-params lfun if you don't want to overwrite others settings.
3569 \begin_layout Description
3570 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3573 \begin_layout Description
3574 Params For parameters see LFUN_PARAGRAPH_PARAMS
3577 \begin_layout Description
3578 Origin leeming, 30 Mar 2004
3581 \begin_layout Subsection*
3585 \begin_layout Description
3586 Action Move the cursor to the next paragraph (or beginning of the current
3587 one) in upward direction.
3590 \begin_layout Description
3594 \begin_layout Description
3595 Origin Asger, 1 Oct 1996
3598 \begin_layout Subsection*
3602 \begin_layout Description
3603 Action Move the cursor and select the text to the next paragraph (or beginning
3604 of the current one) in upward direction.
3607 \begin_layout Description
3608 Syntax paragraph-up-select
3611 \begin_layout Description
3612 Origin Asger, 1 Oct 1996
3615 \begin_layout Subsection*
3619 \begin_layout Description
3620 Action Pastes material (text or picture) from the active clipboard.
3623 \begin_layout Description
3624 Syntax paste [<TYPE>|<NUM>]
3627 \begin_layout Description
3628 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3629 \begin_inset Newline newline
3632 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3635 \begin_layout Subsection*
3639 \begin_layout Description
3640 Action Inserts phantom on the current cursor position, move selection inside
3644 \begin_layout Description
3645 Syntax phantom-insert [<TYPE>]
3648 \begin_layout Description
3649 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3652 \begin_layout Description
3653 Origin uwestoehr, 30 Jan 2009
3656 \begin_layout Subsection*
3660 \begin_layout Description
3661 Action Inserts a new preview inset.
3664 \begin_layout Description
3665 Syntax preview-insert
3668 \begin_layout Description
3669 Origin vfr, 28 Mar 2010
3672 \begin_layout Subsection*
3673 primary-selection-paste
3676 \begin_layout Description
3677 Action Pastes the currently selected text.
3680 \begin_layout Description
3681 Notion Primary selection mechanism is linux-only thing.
3684 \begin_layout Description
3685 Syntax primary-selection-paste [<ARG>]
3688 \begin_layout Description
3689 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
3693 \begin_layout Subsection*
3697 \begin_layout Description
3698 Action Inserts quotes according to the type and quote-language preference.
3701 \begin_layout Description
3702 Notion Currently 15 different quote styles are distinguished (see params).
3705 \begin_layout Description
3706 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3709 \begin_layout Description
3710 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3711 outer (i.e., primary, usually double) quotes will be used.
3712 \begin_inset Newline newline
3715 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise
3716 the side will be guessed from the context.
3717 \begin_inset Newline newline
3720 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3721 \begin_inset Newline newline
3724 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3725 \begin_inset Newline newline
3728 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3729 \begin_inset Newline newline
3732 'danish' for >>Danish<< quote style (with >inner quotation<)
3733 \begin_inset Newline newline
3736 'english' for ``English'' quote style (with `inner quotation')
3737 \begin_inset Newline newline
3740 'french' for <<french>> quote style (with ``inner quotation'')
3741 \begin_inset Newline newline
3744 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in"
3745 = Imprimerie Nationale]
3746 \begin_inset Newline newline
3749 'german' for ,,German`` quote style (with ,inner quotation`)
3750 \begin_inset Newline newline
3753 'plain' for "Plain" quote style (with 'inner quotation')
3754 \begin_inset Newline newline
3757 'polish' for ,,Polish'' quote style (with ,inner quotation')
3758 \begin_inset Newline newline
3761 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3762 \begin_inset Newline newline
3765 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" =
3767 \begin_inset Newline newline
3770 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3771 \begin_inset Newline newline
3774 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3775 \begin_inset Newline newline
3778 'dynamic' for Dynamic quotation marks which inherit the global document
3780 \begin_inset Newline newline
3783 If no quote style is specified, the document-wide will be used.
3786 \begin_layout Subsection*
3790 \begin_layout Description
3791 Action Redoes the last thing undone.
3794 \begin_layout Description
3798 \begin_layout Subsection*
3802 \begin_layout Description
3803 Action Go to the next label or cross-reference.
3806 \begin_layout Description
3807 Syntax reference-next
3810 \begin_layout Description
3811 Origin Dekel, 14 Jan 2001
3814 \begin_layout Subsection*
3818 \begin_layout Description
3819 Action Repeat the given command.
3822 \begin_layout Description
3823 Notion fails when the repeat count is greater than 10000.
3826 \begin_layout Description
3827 Syntax repeat <COUNT> <LFUN-COMMAND>
3830 \begin_layout Description
3831 Origin Andre, 27 Oct 2003
3834 \begin_layout Subsection*
3838 \begin_layout Description
3839 Action Moves the cursor one page in downward direction.
3842 \begin_layout Description
3846 \begin_layout Subsection*
3850 \begin_layout Description
3851 Action Moves the cursor one screen in downward direction adding the current
3852 position to the selection.
3855 \begin_layout Description
3856 Syntax screen-down-select
3859 \begin_layout Subsection*
3863 \begin_layout Description
3864 Action Recenters the screen on the current cursor position.
3867 \begin_layout Description
3868 Syntax screen-recenter
3871 \begin_layout Subsection*
3875 \begin_layout Description
3876 Action Repositions the screen such that the cursor is visible.
3879 \begin_layout Description
3880 Syntax screen-show-cursor
3883 \begin_layout Description
3884 Origin vfr, 25 Mar 2009
3887 \begin_layout Subsection*
3891 \begin_layout Description
3892 Action Moves the cursor one page in upward direction.
3895 \begin_layout Description
3899 \begin_layout Subsection*
3903 \begin_layout Description
3904 Action Moves the cursor one page in upward direction adding the current
3905 position to the selection.
3908 \begin_layout Description
3909 Syntax screen-up-select
3912 \begin_layout Subsection*
3916 \begin_layout Description
3917 Action Inserts a subscript or superscript inset.
3920 \begin_layout Description
3921 Syntax script-insert <TYPE>
3924 \begin_layout Description
3925 Params <TYPE>: subscript|superscript
3928 \begin_layout Description
3929 Origin Georg, 23 Nov 2010
3932 \begin_layout Subsection*
3936 \begin_layout Description
3937 Action Scroll the buffer view.
3940 \begin_layout Description
3941 Notion Only scrolls the screen up or down; does not move the cursor.
3944 \begin_layout Description
3945 Syntax scroll <TYPE> <QUANTITY>
3948 \begin_layout Description
3949 Params <TYPE>: line|page
3950 \begin_inset Newline newline
3953 <QUANTITY>: up|down|<number>
3956 \begin_layout Description
3957 Origin Abdel, Dec 27 2007
3960 \begin_layout Subsection*
3964 \begin_layout Description
3965 Action Select the whole section.
3968 \begin_layout Description
3969 Notion The cursor should be in a section heading before calling this lfun.
3972 \begin_layout Description
3973 Syntax section-select
3976 \begin_layout Description
3977 Origin vfr, 05 May 2009
3980 \begin_layout Subsection*
3984 \begin_layout Description
3985 Action Pastes the internal selection text in permanent selection.
3988 \begin_layout Description
3989 Notion Created in order to have middle mouse button pasting correct (bound
3990 to command-alternatives selection-paste ; primary-selection-paste paragraph).
3993 \begin_layout Description
3994 Syntax selection-paste
3997 \begin_layout Description
3998 Origin lasgouttes, 14 Jan 2009
4001 \begin_layout Subsection*
4005 \begin_layout Description
4006 Action Inserts an environment separator or latex paragraph break.
4009 \begin_layout Description
4010 Syntax separator-insert [<ARG>]
4013 \begin_layout Description
4014 Params <ARG>: <plain|parbreak|latexpar> default: plain
4017 \begin_layout Description
4018 Origin ef, 2 May 2014
4021 \begin_layout Subsection*
4025 \begin_layout Description
4026 Action Set the group for the graphics inset on the cursor position.
4029 \begin_layout Description
4030 Syntax set-graphics-group [<GROUP>]
4033 \begin_layout Description
4034 Params <GROUP>: Id for an existing group.
4035 In case the Id is an empty string, the graphics inset is removed from the
4039 \begin_layout Description
4040 Origin sanda, 6 May 2008
4043 \begin_layout Subsection*
4047 \begin_layout Description
4048 Action Inserts one of horizontal space insets.
4051 \begin_layout Description
4052 Syntax space-insert <NAME> [<LEN>]
4055 \begin_layout Description
4056 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip,
4057 negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill,
4059 \begin_inset Newline newline
4062 Only in math mode: med and thick.
4063 \begin_inset Newline newline
4066 <LEN>: length for custom spaces (hspace, hspace* for protected)
4069 \begin_layout Description
4070 Origin spitz, 20 May 2003, Mar 17 2008
4073 \begin_layout Subsection*
4077 \begin_layout Description
4078 Action Inserts various characters into the document.
4081 \begin_layout Description
4082 Syntax specialchar-insert <CHAR>
4085 \begin_layout Description
4086 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash,
4087 dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
4090 \begin_layout Description
4091 Origin spitz, 6 Dec 2007
4094 \begin_layout Subsection*
4098 \begin_layout Description
4099 Action Add the word under the cursor to the respective spell checker dictionary.
4100 The default for the language is retrieved from the cursor position.
4103 \begin_layout Description
4104 Syntax spelling-add [<STRING>] [<LANG>]
4107 \begin_layout Description
4108 Params <WORD>: word to add <LANG>: language name (see file languages)
4111 \begin_layout Description
4112 Origin spitz, 18 Jan 2010
4115 \begin_layout Subsection*
4116 spelling-continuously
4119 \begin_layout Description
4120 Action Toggle continuous spell checking.
4123 \begin_layout Description
4124 Syntax spelling-continuously
4127 \begin_layout Description
4128 Origin vfr, 24 March 2013
4131 \begin_layout Subsection*
4135 \begin_layout Description
4136 Action Let the spell checker ignore the word under the cursor in the current
4137 session for the given language.
4138 The default for the language is retrieved from the cursor position.
4141 \begin_layout Description
4142 Syntax spelling-ignore [<WORD>] [<LANG>]
4145 \begin_layout Description
4146 Params <WORD>: word to ignore <LANG>: language name (see file languages)
4149 \begin_layout Description
4150 Origin spitz, 18 Jan 2010
4153 \begin_layout Subsection*
4157 \begin_layout Description
4158 Action Remove the word under the cursor from the respective spell checker
4160 The default for the language is retrieved from the cursor position.
4163 \begin_layout Description
4164 Syntax spelling-remove [<STRING>] [<LANG>]
4167 \begin_layout Description
4168 Params <WORD>: word to remove <LANG>: language name (see file languages)
4171 \begin_layout Description
4172 Origin SWitt, 28 July 2010
4175 \begin_layout Subsection*
4179 \begin_layout Description
4180 Action Delete a tab or up to an equivalent amount of spaces from a listings
4184 \begin_layout Description
4185 Notion It also works on a selection - it removes a tab or spaces from the
4186 beginning of each line spanned by the selection.
4187 This is useful if you want to indent/unindent multiple lines in one action.
4190 \begin_layout Description
4194 \begin_layout Description
4195 Origin vfr, Sep 30 2008
4198 \begin_layout Subsection*
4202 \begin_layout Description
4203 Action Insert a tab into a listings inset.
4206 \begin_layout Description
4207 Notion It also works on a selection.
4210 \begin_layout Description
4214 \begin_layout Description
4215 Origin vfr, Sep 30 2008
4218 \begin_layout Subsection*
4222 \begin_layout Description
4223 Action Modify properties of tabulars and table-like math environments.
4226 \begin_layout Description
4227 Syntax tabular-feature <FEATURE> [<ARG>]
4230 \begin_layout Description
4231 Params Generally see LFUN_INSET_INSERT for further details.
4232 \begin_inset Newline newline
4235 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4236 \begin_inset Newline newline
4239 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4240 \begin_inset Newline newline
4243 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4244 \begin_inset Newline newline
4247 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4248 \begin_inset Newline newline
4251 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4252 \begin_inset Newline newline
4255 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4256 \begin_inset Newline newline
4259 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4260 \begin_inset Newline newline
4263 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabul
4265 \begin_inset Newline newline
4268 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4269 \begin_inset Newline newline
4272 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4273 \begin_inset Newline newline
4276 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4277 \begin_inset Newline newline
4280 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4281 \begin_inset Newline newline
4284 set-special-column|set-special-multicolumn|set-special-multirow|
4285 \begin_inset Newline newline
4288 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4289 \begin_inset Newline newline
4292 set-interline-space|set-border-lines|tabular-valign-top|
4293 \begin_inset Newline newline
4296 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
4297 \begin_inset Newline newline
4300 Various math-environment features are handled as well, e.g.
4301 add-vline-left/right for
4302 \begin_inset Newline newline
4305 the Grid/Array environment.
4306 \begin_inset Newline newline
4309 <ARG>: additional argument for some commands, use debug mode to explore
4313 \begin_layout Description
4314 Origin gm, 10 Dec 2015
4317 \begin_layout Subsection*
4321 \begin_layout Description
4322 Action Inserts table into the document.
4325 \begin_layout Description
4326 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modification
4330 \begin_layout Description
4331 Syntax tabular-insert [<ROWS> <COLUMNS>]
4334 \begin_layout Description
4335 Params In case no arguments are given show insert dialog.
4338 \begin_layout Description
4339 Origin Jug, 12 Apr 2000
4342 \begin_layout Subsection*
4346 \begin_layout Description
4347 Action Look up thesaurus entries with respect to the word under the cursor.
4350 \begin_layout Description
4351 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4354 \begin_layout Description
4355 Params <STRING>: word to look up <LANG>: language (see file languages)
4358 \begin_layout Description
4359 Origin Levon, 20 Jul 2001
4362 \begin_layout Subsection*
4366 \begin_layout Description
4367 Action Undoes the last edit.
4370 \begin_layout Description
4374 \begin_layout Subsection*
4378 \begin_layout Description
4379 Action Inserts a single unicode character.
4382 \begin_layout Description
4383 Syntax unicode-insert <CHAR>
4386 \begin_layout Description
4387 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
4390 \begin_layout Description
4391 Sample unicode-insert 0x0100
4394 \begin_layout Description
4395 Origin Lgb, 22 Oct 2006
4398 \begin_layout Subsection*
4402 \begin_layout Description
4403 Action Moves the cursor one line in upward direction.
4406 \begin_layout Description
4410 \begin_layout Subsection*
4414 \begin_layout Description
4415 Action Moves the cursor one line in upward direction adding the current
4416 position to the selection.
4419 \begin_layout Description
4423 \begin_layout Subsection*
4427 \begin_layout Description
4428 Action Moves the cursor to the logically previous beginning of a word.
4431 \begin_layout Description
4432 Notion This is not the action which should be bound to the arrow keys, because
4433 backwards may be left or right, depending on the language.
4434 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
4435 which in turn may employ this one.
4438 \begin_layout Description
4439 Syntax word-backward
4442 \begin_layout Subsection*
4443 word-backward-select
4446 \begin_layout Description
4447 Action Moves the cursor to the logically previous beginning of a word, adding
4448 the logically traversed text to the selection.
4451 \begin_layout Description
4452 Notion See also LFUN_WORD_BACKWARD.
4455 \begin_layout Description
4456 Syntax word-backward-select
4459 \begin_layout Subsection*
4463 \begin_layout Description
4464 Action Capitalizes the words in the selection (i.e.
4465 the first letters) or the first letter of word at cursor position.
4468 \begin_layout Description
4469 Syntax word-capitalize [<SEL_TYPE>]
4472 \begin_layout Description
4473 Params <SEL_TYPE>: if this is equal to "partial", then the default word
4474 starts at cursor position (emacs-style).
4475 Otherwise, the whole word is considered.
4478 \begin_layout Subsection*
4479 word-delete-backward
4482 \begin_layout Description
4483 Action Deletes characters to the beginning of the word (usually the "C+BackSpace
4487 \begin_layout Description
4488 Syntax word-delete-backward [force]
4491 \begin_layout Description
4492 Params force: Delete big insets, do not only select them.
4495 \begin_layout Subsection*
4499 \begin_layout Description
4500 Action Deletes characters to the end of the word (usually the "C+Delete"
4504 \begin_layout Description
4505 Syntax word-delete-forward [force]
4508 \begin_layout Description
4509 Params force: Delete big insets, do not only select them.
4512 \begin_layout Subsection*
4516 \begin_layout Description
4517 Action Search for next occurrence of a string.
4520 \begin_layout Description
4521 Syntax word-find [<DATA>]
4524 \begin_layout Description
4525 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
4526 If no parameter is given, search with last find-dialog data is used for
4531 \begin_layout Description
4532 Origin Andre, Jan 7 2004
4535 \begin_layout Subsection*
4539 \begin_layout Description
4540 Action Search for a given string in backward direction.
4543 \begin_layout Description
4544 Notion Case sensitive, match words.
4545 If no argument given, last search repeated.
4548 \begin_layout Description
4549 Syntax word-find-backward [<STRING>]
4552 \begin_layout Description
4553 Origin Etienne, 20 Feb 1998
4556 \begin_layout Subsection*
4560 \begin_layout Description
4561 Action Search for a given string in forward direction.
4564 \begin_layout Description
4565 Notion Case sensitive, match words.
4566 If no argument given, last search repeated.
4569 \begin_layout Description
4570 Syntax word-find-forward [<STRING>]
4573 \begin_layout Description
4574 Origin Etienne, 16 Feb 1998
4577 \begin_layout Subsection*
4581 \begin_layout Description
4582 Action Search for next occurrence of a pattern.
4585 \begin_layout Description
4586 Syntax word-findadv [<DATA>]
4589 \begin_layout Description
4590 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
4591 If no parameter is given, search with last find-dialog data is used for
4596 \begin_layout Description
4597 Origin Tommaso, Nov 15 2007
4600 \begin_layout Subsection*
4604 \begin_layout Description
4605 Action Moves the cursor to the logically next beginning of a word.
4608 \begin_layout Description
4609 Notion This is not the action which should be bound to the arrow keys, because
4610 forward may be left or right, depending on the language.
4611 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
4612 which in turn may employ this one.
4615 \begin_layout Description
4619 \begin_layout Subsection*
4623 \begin_layout Description
4624 Action Moves the cursor to the logically next beginning of a word, adding
4625 the logically traversed text to the selection.
4628 \begin_layout Description
4629 Notion See also LFUN_WORD_FORWARD.
4632 \begin_layout Description
4633 Syntax word-forward-select
4636 \begin_layout Subsection*
4640 \begin_layout Description
4641 Action Moves the cursor to the next beginning of a word "on the left".
4644 \begin_layout Description
4645 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
4647 Generally, it moves the cursor to the next beginning of a word on the left.
4648 However, in Bidi text this become slightly more complicated, and there
4649 are different modes of cursor movement.
4650 In "visual mode", this moves left, plain and simple.
4651 In "logical mode", movement is logically forward in RTL paragraphs, and
4652 logically backwards in LTR paragraphs.
4655 \begin_layout Description
4659 \begin_layout Description
4660 Origin dov, 28 Oct 2007
4663 \begin_layout Subsection*
4667 \begin_layout Description
4668 Action Moves the cursor to the next beginning of a word "on the left", adding
4669 *logically* traversed text to the selection.
4672 \begin_layout Description
4673 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4676 \begin_layout Description
4677 Syntax word-left-select
4680 \begin_layout Description
4681 Origin dov, 28 Oct 2007
4684 \begin_layout Subsection*
4688 \begin_layout Description
4689 Action Change the words in the selection or word at cursor position to lower
4693 \begin_layout Description
4694 Syntax word-lowcase [<SEL_TYPE>]
4697 \begin_layout Description
4698 Params <SEL_TYPE>: if this is equal to "partial", then the default word
4699 starts at cursor position (emacs-style).
4700 Otherwise, the whole word is considered.
4703 \begin_layout Subsection*
4707 \begin_layout Description
4708 Action Replace a string in the document.
4711 \begin_layout Description
4712 Syntax word-replace [<DATA>]
4715 \begin_layout Description
4716 Params <DATA>: data is of the form "<replace>
4717 \begin_inset Newline newline
4721 \begin_inset Newline newline
4724 <casesensitive> <matchword> <all> <forward> <findnext>"
4727 \begin_layout Description
4728 Origin Andre, Jan 7 2004
4731 \begin_layout Subsection*
4735 \begin_layout Description
4736 Action Moves the cursor to the next beginning of a word "on the right".
4739 \begin_layout Description
4740 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
4742 Generally, it moves the cursor to the next beginning of a word on the right.
4743 However, in Bidi text this become slightly more complicated, and there
4744 are different modes of cursor movement.
4745 In "visual mode", this moves right, plain and simple.
4746 In "logical mode", movement is logically forward in LTR paragraphs, and
4747 logically backwards in RTL paragraphs.
4750 \begin_layout Description
4754 \begin_layout Description
4755 Origin dov, 28 Oct 2007
4758 \begin_layout Subsection*
4762 \begin_layout Description
4763 Action Moves the cursor to the next beginning of a word "on the right",
4764 adding *logically* traversed text to the selection.
4767 \begin_layout Description
4768 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4771 \begin_layout Description
4772 Syntax word-right-select
4775 \begin_layout Description
4776 Origin dov, 28 Oct 2007
4779 \begin_layout Subsection*
4783 \begin_layout Description
4784 Action Puts the word where the cursor stands into the selection.
4787 \begin_layout Description
4791 \begin_layout Description
4792 Origin Andre, 11 Sep 2002
4795 \begin_layout Subsection*
4799 \begin_layout Description
4800 Action Change the words in the selection or word at cursor position to upper
4804 \begin_layout Description
4805 Syntax word-upcase [<SEL_TYPE>]
4808 \begin_layout Description
4809 Params <SEL_TYPE>: if this is equal to "partial", then the default word
4810 starts at cursor position (emacs-style).
4811 Otherwise, the whole word is considered.
4814 \begin_layout Subsection*
4818 \begin_layout Description
4819 Action Inserts floats wrapped by the text around.
4822 \begin_layout Description
4823 Syntax wrap-insert <TYPE>
4826 \begin_layout Description
4827 Params <TYPE>: table|figure
4830 \begin_layout Description
4831 Origin Dekel, 7 Apr 2002
4834 \begin_layout Section
4835 Math Editor Functions
4838 \begin_layout Subsection*
4839 in-mathmacrotemplate
4842 \begin_layout Description
4843 Action Only active in Math Macro definition.
4846 \begin_layout Description
4847 Notion Dummy function which is only active in a Math Macro definition.
4848 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
4852 \begin_layout Description
4853 Syntax in-mathmacrotemplate
4856 \begin_layout Description
4857 Origin sts, 06 January 2008
4860 \begin_layout Subsection*
4864 \begin_layout Description
4865 Action Inserts an extended matrix as provided by the amsmath package.
4868 \begin_layout Description
4869 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4872 \begin_layout Description
4873 Params <DECORATION>: Decoration determines the LaTeX name of the matrix
4874 that should be created.
4875 Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
4877 The default is 'matrix'.
4880 \begin_layout Description
4881 Sample math-ams-matrix 3 3 bmatrix
4884 \begin_layout Subsection*
4888 \begin_layout Description
4889 Action Inserts math fixed size delimiters (e.g.
4890 parentheses, brackets) enclosing expression.
4893 \begin_layout Description
4894 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4897 \begin_layout Description
4898 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4899 \begin_inset Newline newline
4902 <L/RDELIM>: TeX code for delimiter.
4903 See Delimiter dialog for delimiters to be used.
4906 \begin_layout Description
4907 Sample math-bigdelim "Bigl" "
4914 \begin_layout Description
4915 Origin Enrico & Georg, 7 May 2006
4918 \begin_layout Subsection*
4922 \begin_layout Description
4923 Action Inserts math delimiters (e.g.
4924 parentheses, brackets) enclosing expression.
4927 \begin_layout Description
4928 Syntax math-delim [<LEFT>] [<RIGHT>]
4931 \begin_layout Description
4932 Params <LEFT/RIGHT>: Delimiters to be used.
4933 Each delimiter can be specified by either a LaTeX name or a valid character.
4934 ( is the default letter.
4937 \begin_layout Description
4938 Sample math-delim { rangle
4941 \begin_layout Description
4942 Origin Alejandro, 18 Jun 1996
4945 \begin_layout Subsection*
4949 \begin_layout Description
4950 Action Creates a new displayed equation in text mode.
4951 Toggles inlined/display formula in math mode.
4954 \begin_layout Description
4955 Syntax math-display [<ARG>]
4958 \begin_layout Description
4959 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
4960 new equation from the text mode.
4963 \begin_layout Description
4964 Origin Alejandro, 18 Jun 1996
4967 \begin_layout Subsection*
4971 \begin_layout Description
4972 Action Calls external program and passes the current expression/equation
4973 as an argument for the calculation in the format appropriate to the given
4977 \begin_layout Description
4978 Notion Selection can be used to determine the input for the external program.
4981 \begin_layout Description
4982 Syntax math-extern <LANG> [<COMMAND>]
4985 \begin_layout Description
4986 Params <LANG>: octave|maxima|maple|mathematica|script
4987 \begin_inset Newline newline
4990 where "script" stands for the external script (normalized expression will
4994 \begin_layout Description
4995 Sample math-extern maple simplify
4998 \begin_layout Description
4999 Origin Andre, 24 Apr 2001
5002 \begin_layout Subsection*
5006 \begin_layout Description
5007 Action Changes the text style used in math.
5010 \begin_layout Description
5011 Syntax math-font-style <STYLE>
5014 \begin_layout Description
5015 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
5016 \begin_inset Newline newline
5019 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
5022 \begin_layout Description
5023 Origin vfr, 9 jan 2009
5026 \begin_layout Subsection*
5030 \begin_layout Description
5031 Action Inserts math objects and symbols.
5034 \begin_layout Description
5035 Notion When <ARG> is a _single_ math inset with more than one cell (such
5038 frac{x}{y}"), the content of cell(0) is replaced by the current selection
5039 (only works if the selection is in mathed).
5040 As an example, if "abc" is selected in mathed, "math-insert
5042 frac{x}{y}" replaces "abc" with "
5044 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
5045 If nothing is selected (or the selection is not in mathed), math-insert
5049 \begin_layout Description
5050 Syntax math-insert <ARG>
5053 \begin_layout Description
5054 Params <ARG>: Symbol or LaTeX code to be inserted.
5057 \begin_layout Subsection*
5061 \begin_layout Description
5062 Action Toggles the position of the limits from above/below to the right
5063 side an vice versa in integral symbol, a limit, a summation, etc.
5066 \begin_layout Description
5067 Notion Put the cursor before the symbol with the limits and then invoke
5071 \begin_layout Description
5072 Syntax math-limits [<STATE>]
5075 \begin_layout Description
5076 Params <STATE>: limits|nolimits
5079 \begin_layout Subsection*
5083 \begin_layout Description
5084 Action Inserts a math macro definition at the cursor position in the text.
5087 \begin_layout Description
5088 Syntax math-macro <NAME> [<NARGS>] [def]
5091 \begin_layout Description
5092 Params <NAME>: The name of the macro, e.g.
5094 \begin_inset Newline newline
5097 <NARGS>: The number of parameters of the macro.
5099 "def": Has no effect anymore, just for compatibility with former LyX versions.
5102 \begin_layout Description
5103 Origin ale, 10 May 1997; sts, 21 Dec 2007
5106 \begin_layout Subsection*
5107 math-macro-add-greedy-optional-param
5110 \begin_layout Description
5111 Action Add a greedy optional parameter.
5114 \begin_layout Description
5115 Notion Add a greedy optional parameter which eats the value from the following
5116 cells in mathed which are in the [value] format.
5119 \begin_layout Description
5120 Syntax math-macro-add-greedy-optional-param
5123 \begin_layout Description
5124 Origin sts, 06 January 2008
5127 \begin_layout Subsection*
5128 math-macro-add-optional-param
5131 \begin_layout Description
5132 Action Add an optional parameter.
5135 \begin_layout Description
5136 Notion Insert an optional parameter just behind the already existing optional
5140 \begin_layout Description
5141 Syntax math-macro-add-optional-param
5144 \begin_layout Description
5145 Origin sts, 06 January 2008
5148 \begin_layout Subsection*
5149 math-macro-add-param
5152 \begin_layout Description
5153 Action Add a parameter.
5156 \begin_layout Description
5157 Notion Add a parameter to a Math Macro.
5160 \begin_layout Description
5161 Syntax math-macro-add-param <NUM>
5164 \begin_layout Description
5165 Params <NUM>: The number of the parameter behind which the new one will
5166 be added (1 for the first, i.e.
5167 use 0 for add a parameter at the left), defaults to the last one.
5170 \begin_layout Description
5171 Origin sts, 06 January 2008
5174 \begin_layout Subsection*
5175 math-macro-append-greedy-param
5178 \begin_layout Description
5179 Action Append a greedy parameter.
5182 \begin_layout Description
5183 Notion Append a greedy parameter to a Math Macro which eats the following
5184 mathed cell in every instance of the macro in the buffer.
5187 \begin_layout Description
5188 Syntax math-macro-append-greedy-param
5191 \begin_layout Description
5192 Origin sts, 06 January 2008
5195 \begin_layout Subsection*
5199 \begin_layout Description
5200 Action Fold a Math Macro.
5203 \begin_layout Description
5204 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
5210 \begin_layout Description
5211 Syntax math-macro-fold
5214 \begin_layout Description
5215 Origin sts, 06 January 2008
5218 \begin_layout Subsection*
5219 math-macro-make-nonoptional
5222 \begin_layout Description
5223 Action Make a parameter non-optional.
5226 \begin_layout Description
5227 Notion Turn the last optional parameter of a Math Macro into a non-optional
5229 The default value is remembered to be reused later if the user changes
5233 \begin_layout Description
5234 Syntax math-macro-make-nonoptional
5237 \begin_layout Description
5238 Origin sts, 06 January 2008
5241 \begin_layout Subsection*
5242 math-macro-make-optional
5245 \begin_layout Description
5246 Action Make a parameter optional.
5249 \begin_layout Description
5250 Notion Turn the first non-optional parameter of a Math Macro into an optional
5251 parameter with a default value.
5254 \begin_layout Description
5255 Syntax math-macro-make-optional
5258 \begin_layout Description
5259 Origin sts, 06 January 2008
5262 \begin_layout Subsection*
5263 math-macro-remove-greedy-param
5266 \begin_layout Description
5267 Action Remove a greedy parameter.
5270 \begin_layout Description
5271 Notion Remove a greedy parameter of a Math Macro and spit out the values
5272 of it in every instance of the macro in the buffer.
5273 If it is an optional parameter the [valud] format is used.
5276 \begin_layout Description
5277 Syntax math-macro-remove-greedy-param
5280 \begin_layout Description
5281 Origin sts, 06 January 2008
5284 \begin_layout Subsection*
5285 math-macro-remove-optional-param
5288 \begin_layout Description
5289 Action Remove the last optional parameter.
5292 \begin_layout Description
5293 Notion Remove the last optional parameter of a Math Macro and remove it
5294 in all the instances of the macro in the buffer.
5297 \begin_layout Description
5298 Syntax math-macro-remove-optional-param
5301 \begin_layout Description
5302 Origin sts, 06 January 2008
5305 \begin_layout Subsection*
5306 math-macro-remove-param
5309 \begin_layout Description
5310 Action Remove the last parameter.
5313 \begin_layout Description
5314 Notion Remove the last parameter of a Math Macro and remove its value in
5315 all instances of the macro in the buffer.
5318 \begin_layout Description
5319 Syntax math-macro-remove-param <NUM>
5322 \begin_layout Description
5323 Params <NUM>: The number of the parameter to be deleted (1 for the first),
5324 defaults to the last one.
5327 \begin_layout Description
5328 Origin sts, 06 January 2008
5331 \begin_layout Subsection*
5335 \begin_layout Description
5336 Action Unfold a Math Macro.
5339 \begin_layout Description
5340 Notion Unfold the Math Macro the cursor is in, i.e.
5346 \begin_layout Description
5347 Syntax math-macro-unfold
5350 \begin_layout Description
5351 Origin sts, 06 January 2008
5354 \begin_layout Subsection*
5358 \begin_layout Description
5359 Action Inserts a matrix.
5362 \begin_layout Description
5363 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5366 \begin_layout Description
5367 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
5369 1 char) and the horizontal alignments (l, c or r) (i.e.
5373 \begin_layout Description
5374 Sample math-matrix 3 3 bccc
5377 \begin_layout Subsection*
5381 \begin_layout Description
5382 Action In text mode enters math mode (i.e.
5383 puts math insets on the current cursor position), in math mode enters text
5384 mode inside math expression.
5387 \begin_layout Description
5388 Notion If there is some selected text, it puts the text inside created math
5392 \begin_layout Description
5393 Syntax math-mode [on|<ARG>]
5396 \begin_layout Description
5397 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
5399 \begin_inset Newline newline
5402 "on": allow only entering of math mode from text mode.
5405 \begin_layout Description
5406 Origin Alejandro, 4 Jun 1996
5409 \begin_layout Subsection*
5413 \begin_layout Description
5414 Action Mutates the type of math inset to the newly selected one.
5417 \begin_layout Description
5418 Syntax math-mutate <TYPE>
5421 \begin_layout Description
5422 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
5423 multline|gather|flalign
5426 \begin_layout Description
5427 Origin Andre, 23 May 2001
5430 \begin_layout Subsection*
5431 math-number-line-toggle
5434 \begin_layout Description
5435 Action Toggles numbering of the current formula line.
5438 \begin_layout Description
5439 Notion Must be in display formula mode.
5442 \begin_layout Description
5443 Syntax math-number-line-toggle
5446 \begin_layout Description
5447 Origin Alejandro, 18 Jun 1996
5450 \begin_layout Subsection*
5454 \begin_layout Description
5455 Action Toggles numbering/labeling of the current formula.
5458 \begin_layout Description
5459 Notion Must be in display formula mode.
5462 \begin_layout Description
5463 Syntax math-number-toggle
5466 \begin_layout Description
5467 Origin Alejandro, 4 Jun 1996
5470 \begin_layout Subsection*
5474 \begin_layout Description
5475 Action Changes arbitrarily the size used by math fonts inside a context.
5478 \begin_layout Description
5479 Notion Provides an interface to the LaTeX math mode font size commands.
5482 \begin_layout Description
5483 Syntax math-size <STYLE>
5486 \begin_layout Description
5498 \begin_layout Description
5499 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5502 \begin_layout Subsection*
5506 \begin_layout Description
5507 Action Inserts space into math expression.
5510 \begin_layout Description
5511 Notion Use spacebar after entering this space to change type of space.
5514 \begin_layout Description
5515 Syntax math-space [<TYPE>] [<LEN>]
5518 \begin_layout Description
5519 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5520 \begin_inset Newline newline
5523 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5524 \begin_inset Newline newline
5527 custom space: hspace
5528 \begin_inset Newline newline
5531 "," used by default.
5532 \begin_inset Newline newline
5535 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
5537 \begin_inset Newline newline
5540 <LEN>: length for custom spaces (hspace)
5543 \begin_layout Description
5544 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5547 \begin_layout Subsection*
5551 \begin_layout Description
5552 Action Enters subscript expression in math expression.
5555 \begin_layout Description
5556 Syntax math-subscript
5559 \begin_layout Description
5560 Origin vermeer, 12 Dec 2001
5563 \begin_layout Subsection*
5567 \begin_layout Description
5568 Action Enters superscript expression in math expression.
5571 \begin_layout Description
5572 Syntax math-superscript
5575 \begin_layout Description
5576 Origin vermeer, 12 Dec 2001
5579 \begin_layout Subsection*
5583 \begin_layout Description
5584 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
5586 Used by the advanced search dialog.
5589 \begin_layout Description
5590 Notion If there is any selected text, then it is moved inside the created
5594 \begin_layout Description
5595 Syntax regexp-mode [<ARG>]
5598 \begin_layout Description
5599 Params <ARG>: eventual argument (regular expression).
5602 \begin_layout Description
5603 Origin Tommaso, 4 Oct 2008
5606 \begin_layout Section
5607 Buffer Fuctions (File and Window related)
5610 \begin_layout Subsection*
5614 \begin_layout Description
5615 Action Activate the branch.
5618 \begin_layout Description
5619 Syntax branch-activate <BRANCH>
5622 \begin_layout Description
5623 Params <BRANCH>: The branch to activate
5626 \begin_layout Description
5627 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5628 \begin_inset Newline newline
5631 could be used to export a pdf with the answers branch included without one's
5632 having to open LyX and activate the branch manually.
5635 \begin_layout Description
5636 Origin rgh, 27 May 2008
5639 \begin_layout Subsection*
5643 \begin_layout Description
5644 Action Add a branch to the buffer's BranchList.
5647 \begin_layout Description
5648 Syntax branch-add <BRANCH>
5651 \begin_layout Description
5652 Params <BRANCH>: Name of the branch to add
5655 \begin_layout Description
5656 Origin spitz, 7 Jul 2009
5659 \begin_layout Subsection*
5663 \begin_layout Description
5664 Action Create new branch and directly put the branch inset into the document.
5667 \begin_layout Description
5668 Syntax branch-add-insert [<NAME>]
5671 \begin_layout Description
5672 Params <NAME>: Branch name.
5673 If it is not specified, you will be asked.
5676 \begin_layout Description
5677 Origin sanda, 10 Jul 2009
5680 \begin_layout Subsection*
5684 \begin_layout Description
5685 Action De-activate the branch.
5688 \begin_layout Description
5689 Syntax branch-deactivate <BRANCH>
5692 \begin_layout Description
5693 Params <BRANCH>: The branch to deactivate
5696 \begin_layout Description
5697 Origin rgh, 27 May 2008
5700 \begin_layout Subsection*
5704 \begin_layout Description
5705 Action Toggles inversion status of branch inset.
5708 \begin_layout Description
5709 Syntax branch-invert
5712 \begin_layout Description
5713 Origin rgheck, 12 July 2016
5716 \begin_layout Subsection*
5717 branch-master-activate
5720 \begin_layout Description
5721 Action Activate the branch in the master buffer.
5724 \begin_layout Description
5725 Syntax branch-master-activate <BRANCH>
5728 \begin_layout Description
5729 Params <BRANCH>: The branch to activate
5732 \begin_layout Description
5733 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5734 \begin_inset Newline newline
5737 could be used to export a pdf with the answers branch included without one's
5738 having to open LyX and activate the branch manually.
5741 \begin_layout Description
5742 Origin spitz, 30 Sep 2012
5745 \begin_layout Subsection*
5746 branch-master-deactivate
5749 \begin_layout Description
5750 Action De-activate the branch in the master buffer.
5753 \begin_layout Description
5754 Syntax branch-master-deactivate <BRANCH>
5757 \begin_layout Description
5758 Params <BRANCH>: The branch to deactivate
5761 \begin_layout Description
5762 Origin spitz, 30 Sep 2012
5765 \begin_layout Subsection*
5769 \begin_layout Description
5770 Action Rename all branches of a given name in a document.
5773 \begin_layout Description
5774 Syntax branches-rename <OLDNAME> <NEWNAME>
5777 \begin_layout Description
5778 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
5782 \begin_layout Description
5783 Origin spitz, 9 Jul 2009
5786 \begin_layout Subsection*
5790 \begin_layout Description
5791 Action Saves the current buffer to a temporary file.
5794 \begin_layout Description
5795 Notion Saves the current buffer to a file named "#filename#".
5796 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5799 \begin_layout Description
5800 Syntax buffer-auto-save
5803 \begin_layout Subsection*
5807 \begin_layout Description
5808 Action Loads the given child document.
5811 \begin_layout Description
5812 Notion The current document is treated as a parent.
5815 \begin_layout Description
5816 Syntax buffer-child-open <FILE>
5819 \begin_layout Description
5820 Params <FILE>: Filename of the child.
5821 The directory of the parent is assumed by default.
5824 \begin_layout Description
5825 Origin Ale, 28 May 1997
5828 \begin_layout Subsection*
5832 \begin_layout Description
5833 Action Runs chktex for the current document.
5836 \begin_layout Description
5837 Syntax buffer-chktex
5840 \begin_layout Description
5841 Origin Asger, 30 Oct 1997
5844 \begin_layout Subsection*
5848 \begin_layout Description
5849 Action Closes the current buffer.
5852 \begin_layout Description
5853 Notion Closes the current buffer, asking whether to save it, etc, if the
5854 buffer has been modified.
5857 \begin_layout Description
5861 \begin_layout Subsection*
5865 \begin_layout Description
5866 Action Closes all buffers.
5869 \begin_layout Description
5870 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
5874 \begin_layout Description
5875 Syntax buffer-close-all
5878 \begin_layout Subsection*
5882 \begin_layout Description
5883 Action Exports the current buffer (document) to the given format.
5886 \begin_layout Description
5887 Syntax buffer-export [<FORMAT>] [<DEST>]
5890 \begin_layout Description
5891 Params <FORMAT> is either "custom" or one of the formats which you can find
5892 in Tools->Preferences->File formats->Format.
5893 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5894 for pdflatex) or "ps" for postscript.
5895 \begin_inset Newline newline
5898 In case of "custom" you will be asked for a format you want to start from
5899 and for the command that you want to apply to this format.
5900 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5901 \begin_inset Newline newline
5904 If absent or "default", then the default output format of the document is
5906 \begin_inset Newline newline
5909 <DEST> If present, this argument provides the export destination filename.
5910 Its containing folder will also be the destination folder, where all the
5911 needed external files will be copied.
5914 \begin_layout Description
5915 Origin Lgb, 29 Jul 1997
5918 \begin_layout Subsection*
5922 \begin_layout Description
5923 Action Opens a dialog for exporting the current buffer.
5926 \begin_layout Description
5927 Syntax buffer-export-as [<FORMAT>]
5930 \begin_layout Description
5931 Params <FORMAT> is the export format initially selected in the dialog.
5932 You can pass any of the formats which you can find in Tools->Preferences->File
5933 formats->Format, provided it has the "document" flag set.
5934 If no format is specified the dialog will start with the default output
5935 format of the current document.
5938 \begin_layout Description
5939 Sample buffer-export-as pdf2
5942 \begin_layout Description
5943 Origin tommaso, 6 Oct 2011
5946 \begin_layout Subsection*
5947 buffer-export-custom
5950 \begin_layout Description
5951 Action Exports the current buffer (document) from the given format using
5952 the given command on it.
5955 \begin_layout Description
5956 Syntax buffer-export-custom <FORMAT> <COMMAND>
5959 \begin_layout Description
5960 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5962 \begin_inset Newline newline
5965 <COMMAND> this command will be launched on the file.
5966 Note that you can use "$$FName" string to qualify the intermediate file.
5969 \begin_layout Description
5970 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5973 \begin_layout Description
5974 Origin leeming, 27 Mar 2004
5977 \begin_layout Subsection*
5978 buffer-external-modification-clear
5981 \begin_layout Description
5982 Action Clear the external modification flag on the current buffer.
5985 \begin_layout Description
5986 Syntax buffer-external-modification-clear
5989 \begin_layout Description
5990 Origin gm, 2 March 2017
5993 \begin_layout Subsection*
5997 \begin_layout Description
5998 Action Applies a command to all non-hidden buffers.
6001 \begin_layout Description
6002 Notion a buffer is `hidden' if it is internally open in LyX, but not visible
6006 \begin_layout Description
6007 Syntax buffer-forall <LFUN-COMMAND>
6010 \begin_layout Description
6011 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6014 \begin_layout Description
6015 Sample Close all Notes in buffers:
6016 \begin_inset Newline newline
6019 buffer-forall inset-forall Note inset-toggle close
6020 \begin_inset Newline newline
6023 Toggle change tracking on buffers:
6024 \begin_inset Newline newline
6027 buffer-forall changes-track
6028 \begin_inset Newline newline
6031 Toggle read-only for buffers:
6032 \begin_inset Newline newline
6035 buffer-forall buffer-toggle-read-only
6036 \begin_inset Newline newline
6039 Show statistics for individual buffers:
6040 \begin_inset Newline newline
6043 buffer-forall statistics
6044 \begin_inset Newline newline
6047 Activate the branch named "Solutions" in buffers:
6048 \begin_inset Newline newline
6051 buffer-forall branch-activate Solutions
6052 \begin_inset Newline newline
6055 Export buffers to PDF (pdflatex):
6056 \begin_inset Newline newline
6059 buffer-forall buffer-export pdf2
6060 \begin_inset Newline newline
6066 \begin_layout Description
6067 Origin skostysh, 20 Jul 2012
6070 \begin_layout Subsection*
6074 \begin_layout Description
6075 Action Import a given file as a lyx document.
6078 \begin_layout Description
6079 Notion File can be imported iff lyx file format is (transitively) reachable
6080 via defined converters in preferences.
6081 Look in the File->Import menu to get an idea of the currently active import
6085 \begin_layout Description
6086 Syntax buffer-import <FORMAT> [<FILE>]
6089 \begin_layout Description
6090 Origin Asger, 24 Jul 1998
6093 \begin_layout Subsection*
6097 \begin_layout Description
6098 Action Set language of the current document.
6101 \begin_layout Description
6102 Syntax buffer-language <LANG>
6105 \begin_layout Description
6106 Params <LANG>: language name.
6107 See lib/languages for list.
6110 \begin_layout Description
6111 Origin leeming, 30 Mar 2004
6114 \begin_layout Subsection*
6118 \begin_layout Description
6119 Action Moves the current tab one spot to the right.
6122 \begin_layout Description
6123 Syntax buffer-move-next
6126 \begin_layout Description
6127 Origin skostysh, 7 Apr 2015
6130 \begin_layout Subsection*
6131 buffer-move-previous
6134 \begin_layout Description
6135 Action Moves the current tab one spot to the left.
6138 \begin_layout Description
6139 Syntax buffer-move-previous
6142 \begin_layout Description
6143 Origin skostysh, 7 Apr 2015
6146 \begin_layout Subsection*
6150 \begin_layout Description
6151 Action Creates a new buffer (that is, document) and switches to it.
6154 \begin_layout Description
6155 Notion Implicit path can be set in Preferences dialog.
6158 \begin_layout Description
6159 Syntax buffer-new [<FILE>]
6162 \begin_layout Description
6163 Params <FILE>: filename of created file with absolute path.
6166 \begin_layout Subsection*
6170 \begin_layout Description
6171 Action Creates a new buffer (that is, document) from a template.
6174 \begin_layout Description
6175 Notion Path for new files and templates can be set in Preferences dialog.
6176 Template will be asked for via Open-dialog.
6179 \begin_layout Description
6180 Syntax buffer-new-template [<FILE>]
6183 \begin_layout Description
6184 Params <FILE>: filename of created file with absolute path.
6187 \begin_layout Subsection*
6191 \begin_layout Description
6192 Action Switch to the next opened document.
6195 \begin_layout Description
6196 Notion Note that this does not necessarily mean next in tabbar (for full
6197 list see View menu).
6200 \begin_layout Description
6204 \begin_layout Subsection*
6208 \begin_layout Description
6209 Action Apply the given settings to the current document.
6212 \begin_layout Description
6213 Syntax buffer-params-apply [<ARGS>]
6216 \begin_layout Description
6217 Params <ARGS>: contains the particular settings to be saved.
6218 They obey the syntax you can find in document header of usual .lyx file.
6221 \begin_layout Description
6222 Origin leeming, 30 Mar 2004
6225 \begin_layout Subsection*
6229 \begin_layout Description
6230 Action Switch to the previous opened document.
6233 \begin_layout Description
6234 Syntax buffer-previous
6237 \begin_layout Subsection*
6241 \begin_layout Description
6242 Action Reverts opened document.
6245 \begin_layout Description
6246 Syntax buffer-reload
6249 \begin_layout Description
6250 Origin Asger, 2 Feb 1997
6253 \begin_layout Subsection*
6254 buffer-save-as-default
6257 \begin_layout Description
6258 Action Save the current document settings as default.
6261 \begin_layout Description
6262 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6265 \begin_layout Description
6266 Syntax buffer-save-as-default [<ARGS>]
6269 \begin_layout Description
6270 Params <ARGS>: contains the particular settings to be saved.
6271 They obey the syntax you can find in document header of usual .lyx file.
6274 \begin_layout Description
6275 Origin leeming, 30 Mar 2004
6278 \begin_layout Subsection*
6282 \begin_layout Description
6283 Action Display and switch to the given buffer.
6286 \begin_layout Description
6287 Syntax buffer-switch <BUFFER>
6290 \begin_layout Description
6291 Params <BUFFER>: path and filename of already opened (but possibly hidden)
6292 document which is to be shown.
6295 \begin_layout Subsection*
6296 buffer-toggle-compression
6299 \begin_layout Description
6300 Action Toggles compression of the current document on/off.
6303 \begin_layout Description
6304 Syntax buffer-toggle-compression
6307 \begin_layout Description
6308 Origin bpeng, 27 Apr 2006
6311 \begin_layout Subsection*
6312 buffer-toggle-read-only
6315 \begin_layout Description
6316 Action Toggle editing mode of the current document between read/write and
6320 \begin_layout Description
6321 Notion This function is not allowed if the file is under version control,
6322 since read-only flag is often used in version control file locking.
6325 \begin_layout Description
6326 Syntax buffer-toggle-read-only
6329 \begin_layout Description
6330 Origin Lgb, 27 May 1997
6333 \begin_layout Subsection*
6337 \begin_layout Description
6338 Action Exports the current document and put the result into the temporary
6342 \begin_layout Description
6343 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6344 EW) the output will be rewritten - updated.
6345 This is useful in case your viewer is able to detect such changes (e.g.
6346 ghostview for postscript).
6349 \begin_layout Description
6350 Syntax buffer-update [<FORMAT>]
6353 \begin_layout Description
6354 Params <FORMAT>: The format to display, where this is one of the formats
6355 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6356 If no format is given, the default format as specified in the same dialog
6360 \begin_layout Description
6361 Origin Dekel, 5 Aug 2000
6364 \begin_layout Subsection*
6368 \begin_layout Description
6369 Action Displays current buffer in chosen format.
6372 \begin_layout Description
6373 Notion Displays the contents of the current buffer in the chosen format,
6374 for example, PDF or DVI.
6375 This runs the necessary converter, calls the defined viewer, and so forth.
6378 \begin_layout Description
6379 Syntax buffer-view [<FORMAT>]
6382 \begin_layout Description
6383 Params <FORMAT>: The format to display, where this is one of the formats
6384 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6385 If no format is given, the default format as specified in the same dialog
6389 \begin_layout Subsection*
6393 \begin_layout Description
6394 Action Opens the file that was created from last preview of this buffer.
6397 \begin_layout Description
6398 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX
6400 It can also be called by the user, which is useful if the document takes
6401 a long time to compile, and you just want to see the last previewed version.
6404 \begin_layout Description
6405 Syntax buffer-view-cache
6408 \begin_layout Subsection*
6412 \begin_layout Description
6413 Action Saves the current buffer.
6416 \begin_layout Description
6417 Notion Saves the current buffer to disk, using the filename that is already
6418 associated with the buffer, asking for one if none is yet assigned.
6421 \begin_layout Description
6425 \begin_layout Subsection*
6429 \begin_layout Description
6430 Action Save all changed documents.
6433 \begin_layout Description
6434 Syntax buffer-write-all
6437 \begin_layout Description
6438 Origin rgh, gpothier 6 Aug 2007
6441 \begin_layout Subsection*
6445 \begin_layout Description
6446 Action Rename and save current buffer.
6449 \begin_layout Description
6450 Syntax buffer-write-as <FILENAME>
6453 \begin_layout Description
6454 Params <FILENAME>: New name of the buffer/file.
6455 A relative path is with respect to the original location of the buffer/file.
6458 \begin_layout Subsection*
6462 \begin_layout Description
6463 Action Sets the zoom of the screen fonts.
6466 \begin_layout Description
6467 Syntax buffer-zoom [<ZOOM>]
6470 \begin_layout Description
6471 Params <ZOOM>: The target zoom value in %; the default is the default zoom
6472 as saved in preferences.
6475 \begin_layout Description
6476 Origin daniel, 28 Oct 2016
6479 \begin_layout Subsection*
6483 \begin_layout Description
6484 Action Increases the zoom of the screen fonts.
6487 \begin_layout Description
6488 Syntax buffer-zoom-in [<ZOOM>]
6491 \begin_layout Description
6492 Params <ZOOM>: The zoom value addition in % (neg.
6493 or pos.); the default is 10% of the default zoom as saved in preferences.
6496 \begin_layout Description
6497 Origin vfr, 30 Mar 2009
6500 \begin_layout Subsection*
6504 \begin_layout Description
6505 Action Decreases the zoom of the screen fonts.
6508 \begin_layout Description
6509 Syntax buffer-zoom-out [<ZOOM>]
6512 \begin_layout Description
6513 Params <ZOOM>: The zoom value abstraction in % (neg.
6514 or pos.); the default is 10% of the default zoom as saved in preferences.
6517 \begin_layout Description
6518 Origin vfr, 30 Mar 2009
6521 \begin_layout Subsection*
6525 \begin_layout Description
6526 Action Generates the code (literate programming).
6529 \begin_layout Description
6530 Notion Latex file with extension
6532 literate_extension is generated.
6535 build_command (with a default of ``make'') to generate the code and
6537 build_error_filter to process the compilation error messages.
6538 \begin_inset Newline newline
6541 In case you want to process your literate file with a script, or some other
6542 program, just insert in your lyxrc file an entry with:
6543 \begin_inset Newline newline
6548 build_command "my_script my_arguments"
6549 \begin_inset Newline newline
6554 build_error_filter differs from the
6556 literate_error_filter only in that the former will identify error messages
6560 \begin_layout Description
6561 Syntax build-program
6564 \begin_layout Subsection*
6568 \begin_layout Description
6569 Action Open LyX document.
6572 \begin_layout Description
6573 Syntax file-open [<FILE>]
6576 \begin_layout Description
6577 Params <FILE>: Filename to be opened.
6580 \begin_layout Subsection*
6584 \begin_layout Description
6585 Action Open the given help file according to the language setting.
6588 \begin_layout Description
6589 Syntax help-open <FILE>[.lyx]
6592 \begin_layout Description
6593 Params <FILE>: any document from (/usr/share/)doc directory.
6596 \begin_layout Description
6597 Origin Jug, 27 Jun 1999
6600 \begin_layout Subsection*
6604 \begin_layout Description
6605 Action Sets icon size of toolbars.
6608 \begin_layout Description
6609 Syntax icon-size [<SIZE>]
6612 \begin_layout Description
6613 Params <SIZE> : the icon size in px or one of the logical settings small|normal|
6614 big|huge|giant, the default is normal (whose size in px is icon set dependent).
6617 \begin_layout Description
6621 \begin_layout Subsection*
6625 \begin_layout Description
6626 Action Terminates the current LyX instance.
6629 \begin_layout Description
6630 Notion Terminates the current LyX instance, asking whether to save modified
6634 \begin_layout Description
6638 \begin_layout Subsection*
6639 master-buffer-update
6642 \begin_layout Description
6643 Action Update (export) the document built from the master buffer, if the
6644 current buffer is part of a master/child document.
6647 \begin_layout Description
6648 Syntax master-buffer-update [<FORMAT>]
6651 \begin_layout Description
6652 Params <FORMAT>: The format to display, where this is one of the formats
6653 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6654 If no format is given, the default format as specified in the same dialog
6658 \begin_layout Description
6659 Origin Tommaso, 20 Sep 2007
6662 \begin_layout Subsection*
6666 \begin_layout Description
6667 Action Show a preview built from the master buffer, if available.
6668 if the current buffer is part of a master/child document.
6671 \begin_layout Description
6672 Syntax master-buffer-view [<FORMAT>]
6675 \begin_layout Description
6676 Params <FORMAT>: The format to display, where this is one of the formats
6677 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6678 If no format is given, the default format as specified in the same dialog
6682 \begin_layout Description
6683 Origin Tommaso, 20 Sep 2007
6686 \begin_layout Subsection*
6690 \begin_layout Description
6691 Action Opens the menu given by its name.
6694 \begin_layout Description
6695 Syntax menu-open <NAME>
6698 \begin_layout Description
6699 Params <NAME>: menu name.
6700 See various .inc files in lib/ui for candidates.
6703 \begin_layout Subsection*
6707 \begin_layout Description
6708 Action Close the current tab group.
6711 \begin_layout Description
6712 Notion This only closes the work areas, not the buffers themselves.
6713 The still opened buffers can be visualized in another tab group.
6716 \begin_layout Description
6717 Syntax tab-group-close
6720 \begin_layout Description
6721 Origin Abdel, 21 Feb 2008
6724 \begin_layout Subsection*
6728 \begin_layout Description
6729 Action Toggles movability of a given toolbar between true/false.
6732 \begin_layout Description
6733 Syntax toolbar-movable <NAME>
6736 \begin_layout Description
6737 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|
6738 view/update|math_panels|vcs| view-others|update-others
6741 \begin_layout Description
6742 Origin daniel, 12 July 2016
6745 \begin_layout Subsection*
6749 \begin_layout Description
6750 Action Toggles visibility of a given toolbar between on/off/auto.
6753 \begin_layout Description
6754 Notion Skipping "auto" when allowauto is false.
6757 \begin_layout Description
6758 Syntax toolbar-toggle <NAME> [allowauto]
6761 \begin_layout Description
6762 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6763 \begin_inset Newline newline
6766 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6769 \begin_layout Description
6770 Origin Edwin, 21 May 2007
6773 \begin_layout Subsection*
6777 \begin_layout Description
6778 Action Various UI visibility-toggling actions.
6781 \begin_layout Description
6782 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6785 \begin_layout Description
6786 Params statusbar : Toggle visibility of the statusbar.
6787 \begin_inset Newline newline
6790 menubar : Toggle visibility of the menubar.
6791 \begin_inset Newline newline
6794 scrollbar : Toggle visibility of the scrollbar.
6795 \begin_inset Newline newline
6798 frame : Toggle visibility of the frames around editing window.
6799 \begin_inset Newline newline
6802 fullscreen : Toggle fullscreen mode.
6803 This also covers calling the previous functions.
6804 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
6808 \begin_layout Description
6809 Origin sanda, 9 Feb 2007
6812 \begin_layout Subsection*
6816 \begin_layout Description
6817 Action Close the current document work area.
6820 \begin_layout Description
6821 Notion Close the current work area.
6822 If no other work areas are showing the buffer, then close the associated
6826 \begin_layout Description
6830 \begin_layout Description
6831 Origin Tommaso, 15 Sep 2012
6834 \begin_layout Subsection*
6838 \begin_layout Description
6839 Action Creates another split view of current buffer.
6842 \begin_layout Description
6843 Notion All split views act in the same way independently.
6846 \begin_layout Description
6847 Syntax view-split <vertical|horizontal>
6850 \begin_layout Description
6851 Params horizontal : The work areas are laid out side by side.
6852 \begin_inset Newline newline
6855 vertical : The work areas laid out vertically.
6858 \begin_layout Description
6859 Origin Abdel, 20 Feb 2008
6862 \begin_layout Subsection*
6866 \begin_layout Description
6867 Action Closes the current LyX window.
6870 \begin_layout Description
6874 \begin_layout Description
6875 Origin Abdel, 23 Oct 2006
6878 \begin_layout Subsection*
6882 \begin_layout Description
6883 Action Creates new empty LyX window.
6886 \begin_layout Description
6887 Notion Already opened documents from the previous window can be found under
6891 \begin_layout Description
6892 Syntax window-new [<GEOMETRY>]
6895 \begin_layout Description
6896 Params <GEOMETRY>: pass the geometry of the window.
6897 This parameter is currently accepted only on Windows platform.
6900 \begin_layout Description
6901 Origin Abdel, 21 Oct 2006
6904 \begin_layout Section
6905 System Functions (Preferences, LyX Server etc.)
6908 \begin_layout Subsection*
6909 buffer-toggle-output-sync
6912 \begin_layout Description
6913 Action Toggles including of resources for forward/reverse search of the
6917 \begin_layout Description
6918 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
6920 Custom LaTeX macro can be defined in preferences.
6923 \begin_layout Description
6924 Syntax buffer-toggle-output-sync
6927 \begin_layout Description
6928 Origin sanda, 25 May 2010
6931 \begin_layout Subsection*
6935 \begin_layout Description
6936 Action Executes a command defined in a .def file.
6939 \begin_layout Description
6940 Notion The definitions are by default read from lib/commands/default.def.
6941 \begin_inset Newline newline
6944 A .def file allows to define a command with
6946 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6947 <LFUN> is the lfun code to be executed (see e.g.
6948 LFUN_COMMAND_SEQUENCE).
6951 def_file "FileName" allows to include another .def file.
6952 \begin_inset Newline newline
6955 This is particularly useful in connection with toolbar buttons: Since the
6956 name of the button image for this lfun is lib/images/commands/<NAME>.png
6957 this is the way to assign an image to a complex command-sequence.
6960 \begin_layout Description
6964 \begin_layout Description
6965 Params <NAME>: Name of the command that must be called.
6968 \begin_layout Description
6969 Origin broider, 2 Oct 2007
6972 \begin_layout Subsection*
6976 \begin_layout Description
6977 Action Cancels sequence prepared by LFUN_META_PREFIX .
6980 \begin_layout Description
6984 \begin_layout Subsection*
6985 command-alternatives
6988 \begin_layout Description
6989 Action Runs the first listed command that is enabled.
6992 \begin_layout Description
6993 Notion This can be used to bind multiple functions to a single key, and
6994 then which one is used will depend upon the context.
6997 \begin_layout Description
6998 Syntax command-alternatives <CMDS>
7001 \begin_layout Description
7002 Params <CMDS>: Sequence of commands separated by semicolons.
7005 \begin_layout Description
7006 Sample command-alternatives completion-accept;cell-forward
7009 \begin_layout Description
7010 Origin rgh, 24 September 2008
7013 \begin_layout Subsection*
7017 \begin_layout Description
7018 Action Run more commands (LFUN and its parameters) in a sequence.
7021 \begin_layout Description
7022 Syntax command-sequence <CMDS>
7025 \begin_layout Description
7026 Params <CMDS>: Sequence of commands separated by semicolons.
7029 \begin_layout Description
7030 Sample command-sequence cut; ert-insert; self-insert
7032 ; paste; self-insert {}; inset-toggle;
7035 \begin_layout Description
7036 Origin Andre, 11 Nov 1999
7039 \begin_layout Subsection*
7040 cursor-follows-scrollbar-toggle
7043 \begin_layout Description
7044 Action Determine whether to keep cursor inside the editing window regardless
7045 of the scrollbar movement.
7048 \begin_layout Description
7049 Syntax toggle-cursor-follows-scrollbar
7052 \begin_layout Description
7053 Origin ARRae, 2 Dec 1997
7056 \begin_layout Subsection*
7060 \begin_layout Description
7061 Action Set debug output level.
7064 \begin_layout Description
7065 Syntax debug-level-set <LEVEL>
7068 \begin_layout Description
7069 Params <LEVEL>: comma separated list of levels or the correspondent number
7070 of their combination.
7071 0 is equivalent to disabling all debug events.
7072 See lyx -dbg for the current list of debug levels and their numbers.
7075 \begin_layout Description
7076 Origin sanda, 28 Dec 2009
7079 \begin_layout Subsection*
7083 \begin_layout Description
7084 Action toggle a mode where more information is given in UI
7087 \begin_layout Description
7088 Notion in so called "devel" mode, the information given in the status bar
7089 is more precise, and the help documents are open in editing mode.
7092 \begin_layout Description
7093 Syntax devel-mode-toggle
7096 \begin_layout Description
7097 Origin lasgouttes, 23 Jul 2017
7100 \begin_layout Subsection*
7104 \begin_layout Description
7105 Action Sets the cursor position in the previewed (dvi/pdf) file based on
7106 the row number in LyX window.
7109 \begin_layout Description
7110 Notion The external program used for forward search call can be specified
7111 in LyX Output preferences.
7112 See Additional manual for details of these settings.
7115 \begin_layout Description
7116 Syntax forward-search
7119 \begin_layout Description
7120 Origin sanda, 14 Apr 2010
7123 \begin_layout Subsection*
7127 \begin_layout Description
7128 Action Apply the given settings to user preferences.
7131 \begin_layout Description
7132 Syntax lyxrc-apply <SETTINGS>
7135 \begin_layout Description
7136 Params <SETTINGS>: settings which are to be set.
7137 Take a look into ~/.lyx/preferences to get an idea which commands to use
7139 lyx::LyXRC::LyXRCTags has the list of possible commands.
7142 \begin_layout Subsection*
7146 \begin_layout Description
7147 Action Shows message in statusbar (for script purposes).
7150 \begin_layout Description
7151 Syntax message <STRING>
7154 \begin_layout Description
7155 Origin Lgb, 8 Apr 2001
7158 \begin_layout Subsection*
7162 \begin_layout Description
7163 Action Simulate halting Meta key (Alt key on PCs).
7166 \begin_layout Description
7167 Notion Used for buffer edition not for GUI control.
7170 \begin_layout Description
7174 \begin_layout Subsection*
7178 \begin_layout Description
7179 Action Save user preferences.
7182 \begin_layout Description
7183 Syntax preferences-save
7186 \begin_layout Description
7187 Origin Lgb, 27 Nov 1999
7190 \begin_layout Subsection*
7194 \begin_layout Description
7195 Action Reconfigure the automatic settings.
7198 \begin_layout Description
7202 \begin_layout Description
7203 Origin Asger, 14 Feb 1997
7206 \begin_layout Subsection*
7210 \begin_layout Description
7211 Action Returns path and file name of the currently edited document.
7214 \begin_layout Description
7215 Syntax server-get-filename
7218 \begin_layout Subsection*
7222 \begin_layout Description
7223 Action Returns the current layout (that is environment) name on the cursor
7227 \begin_layout Description
7228 Syntax server-get-layout
7231 \begin_layout Subsection*
7232 server-get-statistics
7235 \begin_layout Description
7236 Action Returns the statistics (number of words and characters) in the document
7237 or in the given selection.
7240 \begin_layout Description
7241 Notion Note that this function gives the number of words/chars written,
7242 not the number of characters which will be typeset.
7245 \begin_layout Description
7246 Syntax server-get-statistics [<TYPE>]
7249 \begin_layout Description
7250 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified,
7251 the three values are returned, separated by a space.
7252 \begin_inset Newline newline
7256 \begin_inset Newline newline
7259 chars: count characters.
7260 \begin_inset Newline newline
7263 chars-space: count characters and spaces.
7266 \begin_layout Description
7267 Origin brokenclock, Oct 10 2014
7270 \begin_layout Subsection*
7274 \begin_layout Description
7275 Action Returns the coordinates of cursor position in the editing area.
7278 \begin_layout Description
7279 Syntax server-get-xy
7282 \begin_layout Subsection*
7283 server-goto-file-row
7286 \begin_layout Description
7287 Action Sets the cursor position in LyX based on the row number of generated
7291 \begin_layout Description
7292 Notion This can be useful for DVI inverse-search or detection of the problematic
7293 line from LaTeX compilation.
7294 Note that before this function can be used export to LaTeX output must
7295 occur (in order to map the row numbers).
7298 \begin_layout Description
7299 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
7302 \begin_layout Description
7303 Params <FILE>: the path and filename.
7304 Environment variables are expanded in the path.
7305 In case this LFUN does not work make sure you are giving correct path to
7307 \begin_inset Newline newline
7310 If the file is located inside LyX temporary directory it will be mapped
7311 back into the appropriate opened buffer (e.g.
7312 for the case of generated .tex file).
7313 \begin_inset Newline newline
7316 .ext: extensions will be automatically replaced by .lyx.
7317 \begin_inset Newline newline
7320 <ROW_NUMBER> The row number of the LaTeX file to which to go.
7323 \begin_layout Description
7324 Sample server-goto-file-row /home/user/example.lyx 41
7325 \begin_inset Newline newline
7328 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
7331 \begin_layout Description
7332 Origin Edmar, 23 Dec 1998
7335 \begin_layout Subsection*
7339 \begin_layout Description
7340 Action Sends notify message about the last key-sequence to client.
7343 \begin_layout Description
7344 Notion This can be used to grab last key-sequence used inside the LyX window.
7345 See also Debug extensions section in Additional features manual.
7348 \begin_layout Description
7349 Syntax server-notify
7352 \begin_layout Subsection*
7356 \begin_layout Description
7357 Action Sets the cursor position based on the editing area coordinates (similar
7358 to clicking on that point with left mouse button).
7361 \begin_layout Description
7362 Syntax server-set-xy <X> <Y>
7365 \begin_layout Subsection*
7369 \begin_layout Description
7370 Action Set the given LyX color to the color defined by the X11 name given.
7373 \begin_layout Description
7374 Notion A new color entry is created if the color is unknown.
7375 Color names can be stored as a part of user settings.
7378 \begin_layout Description
7379 Syntax set-color <LYX_NAME> <X11_NAME>
7382 \begin_layout Description
7383 Origin SLior, 11 Jun 2000
7386 \begin_layout Subsection*
7390 \begin_layout Description
7391 Action Count the statistics (number of words and characters) in the document
7392 or in the given selection and display it in a dialog box.
7395 \begin_layout Description
7396 Notion Note that this function gives the number of words/chars written,
7397 not the number of characters which will be typeset.
7400 \begin_layout Description
7404 \begin_layout Description
7405 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7408 \begin_layout Subsection*
7412 \begin_layout Description
7413 Action Checks-in/commits the changes of the registered file to the repository.
7416 \begin_layout Description
7417 Notion In RCS case this also unlocks the file.
7420 \begin_layout Description
7424 \begin_layout Description
7425 Origin Lgb, 1 Jul 1997
7428 \begin_layout Subsection*
7432 \begin_layout Description
7433 Action Checks-out the document for edit (and locks it in some cases).
7436 \begin_layout Description
7440 \begin_layout Description
7441 Origin Lgb, 1 Jul 1997
7444 \begin_layout Subsection*
7448 \begin_layout Description
7449 Action Executes external command.
7450 This command is intended to support additional VCS commands.
7453 \begin_layout Description
7454 Syntax vc-command <FLAG> <PATH> <COMMAND>
7457 \begin_layout Description
7458 Params <FLAG>: Flags for the command can be combined together.
7459 \begin_inset Newline newline
7462 U - dUmmy - no flags
7463 \begin_inset Newline newline
7466 D - Doc - need document loaded to proceed
7467 \begin_inset Newline newline
7470 I - dIrty - mark document dirty
7471 \begin_inset Newline newline
7474 R - Reload - ensure that the document is saved and reload it after command
7476 \begin_inset Newline newline
7479 M - Message - ask for input string (commit message)
7480 \begin_inset Newline newline
7483 <PATH>: path where to start.
7484 $$p will be replaced by the current document path.
7485 \begin_inset Newline newline
7488 <COMMAND>: command to execute.
7489 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
7493 \begin_layout Description
7494 Sample vc-command DR $$p "svn up"
7497 \begin_layout Description
7498 Origin sanda, 13 Jan 2009
7501 \begin_layout Subsection*
7505 \begin_layout Description
7506 Action Compares two revisions of the same file under version control.
7509 \begin_layout Description
7510 Syntax vc-compare [<REV1>] [<REV2>]
7513 \begin_layout Description
7514 Params Revision number either points directly to commit in history or if
7515 negative number -x it points to (last commit - x).
7516 \begin_inset Newline newline
7519 In RCS we subtract only in the last number of revision specification.
7520 Special case "0" is reserved for the last committed revision.
7521 \begin_inset Newline newline
7525 \begin_inset Newline newline
7529 Used only if REV1 > 0.
7530 \begin_inset Newline newline
7533 If no parameter is given, interactive dialog will be shown.
7536 \begin_layout Description
7537 Sample Compare current document against last commit
7538 \begin_inset Newline newline
7542 \begin_inset Newline newline
7545 Compare current document against current revision - 5 commits
7546 \begin_inset Newline newline
7550 \begin_inset Newline newline
7553 Compare revisions 120 and 155
7554 \begin_inset Newline newline
7560 \begin_layout Description
7561 Origin sanda, 12 Feb 2010
7564 \begin_layout Subsection*
7568 \begin_layout Description
7569 Action Copies the document to another name.
7572 \begin_layout Description
7573 Notion Copying with revision history is only supported by SVN.
7574 For RCS and CVS it is simulated by adding the document under a new name.
7575 Disabled if uncommitted changes exist.
7578 \begin_layout Description
7579 Syntax vc-copy <FILENAME>
7582 \begin_layout Description
7583 Params <FILENAME>: New name of the document.
7584 \begin_inset Newline newline
7587 A file dialog is opened if no filename is given.
7590 \begin_layout Description
7591 Origin gb, 05 Feb 2013
7594 \begin_layout Subsection*
7598 \begin_layout Description
7599 Action Toggles the locking property of the edited file.
7602 \begin_layout Description
7603 Notion This is currently implemented only for SVN.
7606 \begin_layout Description
7607 Syntax vc-locking-toggle
7610 \begin_layout Description
7611 Origin sanda, 25 Jun 2009
7614 \begin_layout Subsection*
7618 \begin_layout Description
7619 Action Register the document as an file inside version control system.
7622 \begin_layout Description
7623 Notion File is registered inside cvs, svn or rcs repository acording to
7624 the existence of cvs/svn/rcs entries in the document's directory.
7625 \begin_inset Newline newline
7628 See LyX Additional Features Manual (Version Control Chapter) for additional
7632 \begin_layout Description
7636 \begin_layout Description
7637 Origin Lgb, 1 Jul 1997
7640 \begin_layout Subsection*
7644 \begin_layout Description
7645 Action Renames the document to another name.
7648 \begin_layout Description
7649 Notion Renaming with revision history is only supported by SVN.
7650 For CVS it is simulated by adding the document under a new name and deleting
7652 For RCS it is not supported.
7653 Disabled if uncommitted changes exist.
7656 \begin_layout Description
7657 Syntax vc-rename <FILENAME>
7660 \begin_layout Description
7661 Params <FILENAME>: New name of the document.
7662 \begin_inset Newline newline
7665 A file dialog is opened if no filename is given.
7668 \begin_layout Description
7669 Origin gb, 05 Feb 2013
7672 \begin_layout Subsection*
7676 \begin_layout Description
7677 Action Update the local archive directory in which resides the current document
7678 with the remote repository.
7681 \begin_layout Description
7682 Syntax vc-repo-update
7685 \begin_layout Description
7686 Origin sanda, 16 Oct 2009
7689 \begin_layout Subsection*
7693 \begin_layout Description
7694 Action Reverts the document to the last check-in/commit in VCS.
7697 \begin_layout Description
7701 \begin_layout Description
7702 Origin Lgb, 1 Jul 1997
7705 \begin_layout Subsection*
7709 \begin_layout Description
7710 Action Undo last check-in.
7713 \begin_layout Description
7714 Notion This is currently implemented only for RCS.
7717 \begin_layout Description
7721 \begin_layout Description
7722 Origin Lgb, 1 Jul 1997
7725 \begin_layout Section
7726 Hidden Functions (not listed for configuration)
7729 \begin_layout Subsection*
7733 \begin_layout Description
7734 Action Return the current key sequence and available options as a string.
7737 \begin_layout Description
7738 Notion No options are added if no current map exists.
7739 \begin_inset Newline newline
7742 This is probably usable only with connection to lyxserver.
7745 \begin_layout Description
7746 Syntax command-prefix
7749 \begin_layout Subsection*
7753 \begin_layout Description
7754 Action Activates the LyX window.
7757 \begin_layout Description
7758 Notion On Linux and Mac OS, this action brings the LyX window into focus.
7759 Such behavior is not allowed by Windows OS so instead the color of the
7760 taskbar entry is changed to indicate that the window has changed in some
7762 This action is useful in combination with reverse search.
7765 \begin_layout Description
7769 \begin_layout Description
7770 Origin skostysh, 4 Aug 2016
7773 \begin_layout Subsection*
7777 \begin_layout Description
7778 Action Inserts the given string (accordingly to the correct keymap).
7781 \begin_layout Description
7782 Notion Automatically replace the currently selected text.
7783 Depends on lyxrc settings "auto_region_delete".
7786 \begin_layout Description
7787 Syntax self-insert <STRING>