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 [outer]
194 \begin_layout Description
195 Params outer: If this is given, LyX will split the outermost environment
196 in the current nesting hierarchy.
199 \begin_layout Description
200 Origin spitz, 23 Dec 2012
203 \begin_layout Subsection*
207 \begin_layout Description
208 Action Toggles the bold font (selection-wise) using mathbf in math.
211 \begin_layout Description
215 \begin_layout Subsection*
219 \begin_layout Description
220 Action Toggles the bold font (selection-wise) using boldsymbol in math.
223 \begin_layout Description
224 Syntax font-boldsymbol
227 \begin_layout Subsection*
231 \begin_layout Description
232 Action Toggles xout (cross-through) in the font (selection-wise).
235 \begin_layout Description
239 \begin_layout Description
240 Origin uwestoehr, 4 April 2017
243 \begin_layout Subsection*
247 \begin_layout Description
248 Action Reverts the settings of the font to the default values (selection-wise).
251 \begin_layout Description
255 \begin_layout Subsection*
259 \begin_layout Description
260 Action Toggles the emphasis font style (selection-wise).
263 \begin_layout Description
267 \begin_layout Subsection*
271 \begin_layout Description
272 Action Toggles Fraktur family font (math-mode, selection-wise).
275 \begin_layout Description
279 \begin_layout Description
280 Origin vermeer, 10 Jan 2002
283 \begin_layout Subsection*
287 \begin_layout Description
288 Action Toggles Italics font shape (math-mode, selection-wise).
291 \begin_layout Description
295 \begin_layout Description
296 Origin vermeer, 10 Jan 2002
299 \begin_layout Subsection*
303 \begin_layout Description
304 Action Toggles Noun text style font (selection-wise).
307 \begin_layout Description
311 \begin_layout Subsection*
315 \begin_layout Description
316 Action Toggles Roman family font (selection-wise).
319 \begin_layout Description
323 \begin_layout Subsection*
327 \begin_layout Description
328 Action Toggles Sans Serif family font (selection-wise).
331 \begin_layout Description
335 \begin_layout Subsection*
339 \begin_layout Description
340 Action Sets font size according to lyx format string.
343 \begin_layout Description
344 Syntax font-size <SIZE>
347 \begin_layout Description
348 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
349 \begin_inset Newline newline
352 largest|huge|giant|increase|decrease|default
355 \begin_layout Subsection*
359 \begin_layout Description
360 Action Returns the info about the current font.
363 \begin_layout Description
367 \begin_layout Subsection*
371 \begin_layout Description
372 Action Toggles strikeout (strike-through) in the font (selection-wise).
375 \begin_layout Description
376 Syntax font-strikeout
379 \begin_layout Description
380 Origin sanda, 3 May 2009
383 \begin_layout Subsection*
387 \begin_layout Description
388 Action Toggles the typewriter family font (selection-wise).
391 \begin_layout Description
392 Syntax font-typewriter
395 \begin_layout Subsection*
399 \begin_layout Description
400 Action Toggles underline in the font (selection-wise).
403 \begin_layout Description
404 Syntax font-underline
407 \begin_layout Subsection*
411 \begin_layout Description
412 Action Toggles double underline in the font (selection-wise).
415 \begin_layout Description
416 Syntax font-underunderline
419 \begin_layout Description
420 Origin sanda, 5 May 2009
423 \begin_layout Subsection*
427 \begin_layout Description
428 Action Toggles wavy underline in the font (selection-wise).
431 \begin_layout Description
432 Syntax font-underwave
435 \begin_layout Description
436 Origin sanda, 5 May 2009
439 \begin_layout Subsection*
443 \begin_layout Description
444 Action Sets the layout (that is, environment) for the current paragraph.
447 \begin_layout Description
448 Syntax layout <LAYOUT>
451 \begin_layout Description
452 Params <LAYOUT>: the layout to use
455 \begin_layout Subsection*
459 \begin_layout Description
460 Action Adds a module.
463 \begin_layout Description
464 Notion Adds a module to the list of included modules for the current buffer.
467 \begin_layout Description
468 Syntax layout-module-add <MODULE>
471 \begin_layout Description
472 Params <MODULE>: the module to be added
475 \begin_layout Description
476 Origin rgh, 25 August 2007
479 \begin_layout Subsection*
483 \begin_layout Description
484 Action Clears the module list.
487 \begin_layout Description
488 Notion Clears the list of included modules for the current buffer.
491 \begin_layout Description
492 Syntax layout-modules-clear
495 \begin_layout Description
496 Origin rgh, 25 August 2007
499 \begin_layout Subsection*
503 \begin_layout Description
504 Action Launches the paragraph settings dialog.
507 \begin_layout Description
508 Syntax layout-paragraph
511 \begin_layout Subsection*
515 \begin_layout Description
516 Action Reloads layout information.
519 \begin_layout Description
520 Notion Reloads all layout information for the current buffer from disk,
521 thus recognizing any changes that have been made to layout files on the
523 This is intended to be used only by layout developers and should not be
524 used when one is trying to do actual work.
527 \begin_layout Description
531 \begin_layout Description
532 Origin rgh, 3 September 2007
535 \begin_layout Subsection*
539 \begin_layout Description
540 Action Launches the tabular settings dialog.
543 \begin_layout Description
544 Syntax layout-tabular
547 \begin_layout Description
548 Origin Jug, 31 Jul 2000
551 \begin_layout Subsection*
555 \begin_layout Description
556 Action Update fonts and its metrics.
559 \begin_layout Description
560 Notion Automatically called after zoom, dpi, font names, or norm change.
563 \begin_layout Description
564 Syntax screen-font-update
567 \begin_layout Description
568 Origin ARRae, 13 Aug 2000
571 \begin_layout Subsection*
575 \begin_layout Description
576 Action Sets the text class for the current buffer.
579 \begin_layout Description
580 Syntax textclass-apply <TEXTCLASS>
583 \begin_layout Description
584 Params <TEXTCLASS>: the textclass to set.
585 Note that this must be the filename, minus the ".layout" extension.
588 \begin_layout Subsection*
592 \begin_layout Description
593 Action Loads information for a textclass from disk.
596 \begin_layout Description
597 Syntax textclass-load <TEXTCLASS>
600 \begin_layout Description
601 Params <TEXTCLASS>: the textclass to load.
602 Note that this must be the filename, minus the ".layout" extension.
605 \begin_layout Subsection*
609 \begin_layout Description
610 Action Toggle user-defined (=last-time used) text style.
613 \begin_layout Description
614 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
615 triggered when using Text Style dialog.
618 \begin_layout Description
619 Syntax textstyle-apply
622 \begin_layout Description
623 Origin leeming, 12 Mar 2003
626 \begin_layout Subsection*
630 \begin_layout Description
631 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
635 \begin_layout Description
636 Syntax textstyle-update <FONT_INFO>
639 \begin_layout Description
640 Params <FONT_INFO>: specifies font atributes, e.g.
641 family, series, shape, size, emph, noun, underbar, number, color, language,
643 \begin_inset Newline newline
646 Use lyx -dbg action for exact syntax of text-style dialog parameters.
649 \begin_layout Description
650 Origin leeming, 12 Mar 2003
653 \begin_layout Section
654 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
657 \begin_layout Subsection*
661 \begin_layout Description
662 Action Adds an acute accent to the next character typed.
665 \begin_layout Description
669 \begin_layout Subsection*
673 \begin_layout Description
674 Action Adds a breve accent to the next character typed.
677 \begin_layout Description
681 \begin_layout Subsection*
685 \begin_layout Description
686 Action Adds a caron to the next character typed.
689 \begin_layout Description
693 \begin_layout Subsection*
697 \begin_layout Description
698 Action Adds a cedilla to the next character typed.
701 \begin_layout Description
702 Syntax accent-cedilla
705 \begin_layout Subsection*
709 \begin_layout Description
710 Action Adds a circle accent to the next character typed.
713 \begin_layout Description
717 \begin_layout Subsection*
721 \begin_layout Description
722 Action Adds a circumflex to the next character typed.
725 \begin_layout Description
726 Syntax accent-circumflex
729 \begin_layout Subsection*
733 \begin_layout Description
734 Action Adds a dot accent to the next character typed.
737 \begin_layout Description
741 \begin_layout Subsection*
745 \begin_layout Description
746 Action Adds a grave accent to the next character typed.
749 \begin_layout Description
753 \begin_layout Subsection*
754 accent-hungarian-umlaut
757 \begin_layout Description
758 Action Adds a Hungarian umlaut to the next character typed.
761 \begin_layout Description
765 \begin_layout Subsection*
769 \begin_layout Description
770 Action Adds a macron to the next character typed.
773 \begin_layout Description
777 \begin_layout Subsection*
781 \begin_layout Description
782 Action Adds an ogonek accent to the next character typed.
785 \begin_layout Description
789 \begin_layout Subsection*
793 \begin_layout Description
794 Action Adds a perispomeni (Greek circumflex) over the next character typed.
797 \begin_layout Description
798 Syntax accent-perispomeni
801 \begin_layout Subsection*
805 \begin_layout Description
806 Action Adds a tie over the next two character typed.
809 \begin_layout Description
810 Notion The following char will finish the tie.
813 \begin_layout Description
817 \begin_layout Subsection*
821 \begin_layout Description
822 Action Adds a tilde over the next character typed.
825 \begin_layout Description
829 \begin_layout Subsection*
833 \begin_layout Description
834 Action Adds an umlaut over the next character typed.
837 \begin_layout Description
841 \begin_layout Subsection*
845 \begin_layout Description
846 Action Adds a bar under the next character typed.
849 \begin_layout Description
850 Syntax accent-underbar
853 \begin_layout Subsection*
857 \begin_layout Description
858 Action Adds a dot under the next character typed.
861 \begin_layout Description
862 Syntax accent-underdot
865 \begin_layout Subsection*
869 \begin_layout Description
870 Action Accepts all tracked changes in the document.
873 \begin_layout Description
874 Syntax all-changes-accept
877 \begin_layout Description
878 Origin Levon, 16 Oct 2002
881 \begin_layout Subsection*
885 \begin_layout Description
886 Action Rejects all tracked changes in the document.
889 \begin_layout Description
890 Notion Reject does not work recursively; the user may have to repeat the
894 \begin_layout Description
895 Syntax all-changes-reject
898 \begin_layout Description
899 Origin Levon, 16 Oct 2002
902 \begin_layout Subsection*
906 \begin_layout Description
907 Action Start (or remove) Appendix on the given cursor position.
910 \begin_layout Description
914 \begin_layout Description
915 Origin ettrich, 5 May 1998
918 \begin_layout Subsection*
922 \begin_layout Description
923 Action Inserts an argument (short title) inset.
926 \begin_layout Description
927 Syntax argument-insert <argument nr>
930 \begin_layout Description
931 Params <argument nr>: see layout declarations
934 \begin_layout Description
935 Origin vermeer, 12 Aug 2002
938 \begin_layout Subsection*
942 \begin_layout Description
943 Action Adds database, which will be used for bibtex citations.
946 \begin_layout Description
947 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
948 bibliography) found from the cursor position.
951 \begin_layout Description
952 Syntax bibtex-database-add <DATABASE-NAME>
955 \begin_layout Description
956 Origin Ale, 30 May 1997
959 \begin_layout Subsection*
963 \begin_layout Description
964 Action Adds database, which will be used for bibtex citations.
967 \begin_layout Description
968 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
969 X bibliography) found from the cursor position.
972 \begin_layout Description
973 Syntax bibtex-database-del <DATABASE-NAME>
976 \begin_layout Description
977 Origin Ale, 30 May 1997
980 \begin_layout Subsection*
984 \begin_layout Description
985 Action Clears the list of saved bookmarks.
988 \begin_layout Description
989 Syntax bookmark-clear
992 \begin_layout Description
993 Origin bpeng, 31 October 2006
996 \begin_layout Subsection*
1000 \begin_layout Description
1001 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
1002 Note that bookmarks are saved per-session, not per file.
1005 \begin_layout Description
1006 Notion Bookmark 0 has a special purpose.
1007 It is automatically set
1008 \begin_inset Newline newline
1012 to the paragraph you are currently editing
1013 \begin_inset Newline newline
1017 to the paragraph from where you are jumping to the last-edited position
1019 \begin_inset Newline newline
1023 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1026 \begin_layout Description
1027 Syntax bookmark-goto <NUMBER>
1030 \begin_layout Description
1031 Params <NUMBER>: the number of the bookmark to restore.
1034 \begin_layout Description
1035 Origin Dekel, 27 January 2001
1038 \begin_layout Subsection*
1042 \begin_layout Description
1043 Action Save a bookmark.
1046 \begin_layout Description
1047 Notion Saves a numbered bookmark to the sessions file.
1048 The number must be between 1 and 9, inclusive.
1049 Note that bookmarks are saved per-session, not per file.
1052 \begin_layout Description
1053 Syntax bookmark-save <NUMBER>
1056 \begin_layout Description
1057 Params <NUMBER>: the number of the bookmark to save.
1060 \begin_layout Description
1061 Origin Dekel, 27 January 2001
1064 \begin_layout Subsection*
1068 \begin_layout Description
1069 Action Inserts Box inset.
1072 \begin_layout Description
1073 Syntax box-insert [<TYPE>]
1076 \begin_layout Description
1077 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1078 \begin_inset Newline newline
1081 Framed is the default one.
1084 \begin_layout Description
1085 Origin vermeer, 7 Oct 2003
1088 \begin_layout Subsection*
1092 \begin_layout Description
1093 Action Inserts branch inset.
1096 \begin_layout Description
1097 Syntax branch-insert <BRANCH-NAME>
1100 \begin_layout Description
1101 Origin vermeer, 17 Aug 2003
1104 \begin_layout Subsection*
1108 \begin_layout Description
1109 Action Move the cursor to the beginning of the document.
1112 \begin_layout Description
1116 \begin_layout Subsection*
1120 \begin_layout Description
1121 Action Move the cursor to the beginning of the document adding the traversed
1122 text to the selection.
1125 \begin_layout Description
1126 Syntax buffer-begin-select
1129 \begin_layout Subsection*
1133 \begin_layout Description
1134 Action Move the cursor to the end of the document.
1137 \begin_layout Description
1141 \begin_layout Subsection*
1145 \begin_layout Description
1146 Action Move the cursor to the end of the document adding the traversed text
1150 \begin_layout Description
1151 Syntax buffer-end-select
1154 \begin_layout Subsection*
1158 \begin_layout Description
1159 Action Inserts a caption inset.
1162 \begin_layout Description
1163 Syntax caption-insert
1166 \begin_layout Description
1167 Origin Lgb, 18 Jul 2000
1170 \begin_layout Subsection*
1174 \begin_layout Description
1175 Action Moves the cursor to the previous cell inside the table.
1178 \begin_layout Description
1179 Syntax cell-backward
1182 \begin_layout Description
1183 Origin Jug, 22 May 2000
1186 \begin_layout Subsection*
1190 \begin_layout Description
1191 Action Moves the cursor to the next cell inside the table.
1194 \begin_layout Description
1198 \begin_layout Subsection*
1202 \begin_layout Description
1203 Action Splits cell and shifts right part to the next cell (inside the math
1207 \begin_layout Description
1211 \begin_layout Description
1212 Origin Ale, 15 May 1997
1215 \begin_layout Subsection*
1219 \begin_layout Description
1220 Action Accepts tracked change inside the selection.
1223 \begin_layout Description
1224 Syntax change-accept
1227 \begin_layout Description
1228 Origin Levon, 16 Oct 2002
1231 \begin_layout Subsection*
1235 \begin_layout Description
1236 Action Moves the cursor to the position of the next change of the change
1240 \begin_layout Description
1244 \begin_layout Description
1245 Origin schmitt, 4 Oct 2006
1248 \begin_layout Subsection*
1252 \begin_layout Description
1253 Action Moves the cursor to the position of the previous change of the change
1257 \begin_layout Description
1258 Syntax change-previous
1261 \begin_layout Description
1262 Origin vfr, 4 Apr 2009
1265 \begin_layout Subsection*
1269 \begin_layout Description
1270 Action Rejects tracked change inside the selection.
1273 \begin_layout Description
1274 Syntax change-reject
1277 \begin_layout Description
1278 Origin Levon, 16 Oct 2002
1281 \begin_layout Subsection*
1285 \begin_layout Description
1286 Action Open change tracking dialog for merging and moves the cursor to the
1287 position of the next change.
1290 \begin_layout Description
1291 Syntax changes-merge
1294 \begin_layout Description
1295 Origin Levon, 16 Oct 2002
1298 \begin_layout Subsection*
1302 \begin_layout Description
1303 Action Toggles showing of change tracking in typeset output.
1306 \begin_layout Description
1307 Syntax changes-output
1310 \begin_layout Description
1311 Origin jspitzm, 21 Jan 2005
1314 \begin_layout Subsection*
1318 \begin_layout Description
1319 Action Toggles change tracking to on/off.
1322 \begin_layout Description
1323 Syntax changes-track
1326 \begin_layout Description
1327 Origin levon, 1 Oct 2002
1330 \begin_layout Subsection*
1334 \begin_layout Description
1335 Action Moves the cursor one position logically backwards.
1338 \begin_layout Description
1339 Notion This is not the action which should be bound to the arrow keys, because
1340 backwards may be left or right, depending on the language.
1341 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1342 which in turn may employ this one.
1345 \begin_layout Description
1346 Syntax char-backward
1349 \begin_layout Subsection*
1350 char-backward-select
1353 \begin_layout Description
1354 Action Moves the cursor one position logically backwards, adding traversed
1355 position to the selection.
1358 \begin_layout Description
1359 Notion See also LFUN_CHAR_BACKWARD.
1362 \begin_layout Description
1363 Syntax char-backward-select
1366 \begin_layout Subsection*
1367 char-delete-backward
1370 \begin_layout Description
1371 Action Deletes one character in the backward direction (usually the "BackSpace"
1375 \begin_layout Description
1376 Syntax char-delete-backward [force]
1379 \begin_layout Description
1380 Params force: Delete big insets, do not only select them.
1383 \begin_layout Subsection*
1387 \begin_layout Description
1388 Action Deletes one character in the backward direction (usually the "Delete"
1392 \begin_layout Description
1393 Syntax char-delete-forward [force]
1396 \begin_layout Description
1397 Params force: Delete big insets, do not only select them.
1400 \begin_layout Subsection*
1404 \begin_layout Description
1405 Action Moves the cursor one position logically forward.
1408 \begin_layout Description
1409 Notion This is not the action which should be bound to the arrow keys, because
1410 forward may be left or right, depending on the language.
1411 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1412 which in turn may employ this one.
1415 \begin_layout Description
1419 \begin_layout Subsection*
1423 \begin_layout Description
1424 Action Moves the cursor one position logically forward, adding traversed
1425 position to the selection.
1428 \begin_layout Description
1429 Notion See also LFUN_CHAR_FORWARD.
1432 \begin_layout Description
1433 Syntax char-forward-select
1436 \begin_layout Subsection*
1440 \begin_layout Description
1441 Action Moves the cursor one position "to the left".
1444 \begin_layout Description
1445 Notion This is the action which should be taken when the "left" key is pressed.
1446 Generally, it moves the cursor one position to the left.
1447 However, in Bidi text this become slightly more complicated, and there
1448 are different modes of cursor movement.
1449 In "visual mode", this moves left, plain and simple.
1450 In "logical mode", movement is logically forward in RTL paragraphs, and
1451 logically backwards in LTR paragraphs.
1454 \begin_layout Description
1458 \begin_layout Subsection*
1462 \begin_layout Description
1463 Action Moves the cursor one position "to the left", adding traversed position
1467 \begin_layout Description
1468 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1471 \begin_layout Description
1472 Syntax char-left-select
1475 \begin_layout Subsection*
1479 \begin_layout Description
1480 Action Moves the cursor one position "to the right".
1483 \begin_layout Description
1484 Notion This is the action which should be taken when the "right" key is
1486 Generally, it moves the cursor one position to the right.
1487 However, in Bidi text this become slightly more complicated, and there
1488 are different modes of cursor movement.
1489 In "visual mode", this moves right, plain and simple.
1490 In "logical mode", movement is logically forward in LTR paragraphs, and
1491 logically backwards in RTL paragraphs.
1494 \begin_layout Description
1498 \begin_layout Subsection*
1502 \begin_layout Description
1503 Action Moves the cursor one position "to the right", adding traversed position
1507 \begin_layout Description
1508 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1511 \begin_layout Description
1512 Syntax char-right-select
1515 \begin_layout Subsection*
1519 \begin_layout Description
1520 Action Transposes the character at the cursor with the one before it.
1523 \begin_layout Description
1524 Syntax chars-transpose
1527 \begin_layout Description
1528 Origin Lgb, 25 Apr 2001
1531 \begin_layout Subsection*
1535 \begin_layout Description
1536 Action Inserts citation from loaded citation database.
1539 \begin_layout Description
1540 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1543 \begin_layout Description
1544 Params <KEY>: Citation (shortcut listed in available citations).
1545 \begin_inset Newline newline
1548 <TEXT_BEFORE>: text which should appear before citation.
1551 \begin_layout Description
1552 Origin AAS, 97-02-23
1555 \begin_layout Subsection*
1559 \begin_layout Description
1560 Action Pastes text from the active clipboard (retains formatting if the
1561 clipboard contains formatted text).
1562 Pastes plain text if plain text is on the clipboard, but tries to interpret
1563 it in special ways for certain insets, e.g.
1564 converting csv data to rows and columns if the paste happens in a tabular
1568 \begin_layout Description
1569 Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart
1570 of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1571 is the clipboard, not the selection.
1574 \begin_layout Description
1575 Syntax clipboard-paste [<ARG>]
1578 \begin_layout Description
1579 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1583 \begin_layout Description
1584 Origin Georg, 10 Jul 2006
1587 \begin_layout Subsection*
1588 clipboard-paste-simple
1591 \begin_layout Description
1592 Action Pastes plain text from the active clipboard even if formatted LyX
1593 content is in the clipboard.
1594 Pastes plain text if plain text is on the clipboard, without trying to
1595 interpret it in special ways for certain insets, e.g.
1596 converting csv data to rows and columns if the paste happens in a tabular
1600 \begin_layout Description
1601 Syntax clipboard-paste-simple [<ARG>]
1604 \begin_layout Description
1605 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1609 \begin_layout Subsection*
1613 \begin_layout Description
1614 Action Switches the focus to the minibuffer so that the user can type in
1616 If necessary, it opens the minibuffer toolbar.
1619 \begin_layout Description
1620 Notion Usually bound to M-x shortcut.
1623 \begin_layout Description
1624 Syntax command-execute
1627 \begin_layout Subsection*
1631 \begin_layout Description
1632 Action Try to complete the word or command at the cursor position.
1635 \begin_layout Description
1639 \begin_layout Description
1640 Origin sts, Feb 19 2008
1643 \begin_layout Subsection*
1647 \begin_layout Description
1648 Action Accept suggested completion.
1651 \begin_layout Description
1652 Syntax completion-accept
1655 \begin_layout Description
1656 Origin sanda, Sep 08 2008
1659 \begin_layout Subsection*
1663 \begin_layout Description
1664 Action Try to cancel completion, either the popup or the inline completion.
1667 \begin_layout Description
1668 Syntax completion-cancel
1671 \begin_layout Description
1672 Origin sts, Sep 07 2008
1675 \begin_layout Subsection*
1679 \begin_layout Description
1680 Action Show the inline completion at the cursor position.
1683 \begin_layout Description
1684 Syntax completion-inline
1687 \begin_layout Description
1688 Origin sts, Feb 19 2008
1691 \begin_layout Subsection*
1695 \begin_layout Description
1696 Action Show the completion popup at the cursor position.
1699 \begin_layout Description
1700 Syntax completion-popup
1703 \begin_layout Description
1704 Origin sts, Feb 19 2008
1707 \begin_layout Subsection*
1711 \begin_layout Description
1712 Action Copies the current selection to the clipboard.
1715 \begin_layout Description
1719 \begin_layout Subsection*
1723 \begin_layout Description
1724 Action Cuts to the clipboard.
1727 \begin_layout Description
1731 \begin_layout Subsection*
1735 \begin_layout Description
1736 Action Inserts the current date.
1739 \begin_layout Description
1740 Syntax date-insert [<ARG>]
1743 \begin_layout Description
1744 Params <ARG>: Format of date.
1745 The default value (%x) can be set in Preferences->Date format.
1746 For possible formats see manual page of strftime function.
1749 \begin_layout Description
1750 Origin jdblair, 31 Jan 2000
1753 \begin_layout Subsection*
1757 \begin_layout Description
1758 Action Decrease the nesting depth of the (selected) paragraph(s) inside
1762 \begin_layout Description
1763 Syntax depth-decrement
1766 \begin_layout Subsection*
1770 \begin_layout Description
1771 Action Increase the nesting depth of the (selected) paragraph(s) inside
1775 \begin_layout Description
1776 Syntax depth-increment
1779 \begin_layout Subsection*
1780 dialog-disconnect-inset
1783 \begin_layout Description
1784 Action Closes opened connection to opened inset.
1787 \begin_layout Description
1788 Notion Connection is used for apply functions.
1791 \begin_layout Description
1792 Syntax dialog-disconnect-inset <INSET-NAME>
1795 \begin_layout Description
1796 Origin leeming, 25 Feb 2003
1799 \begin_layout Subsection*
1803 \begin_layout Description
1804 Action Hides showed dialog.
1805 Counterpart to LFUN_DIALOG_SHOW .
1808 \begin_layout Description
1809 Syntax dialog-hide <NAME>
1812 \begin_layout Description
1813 Params See LFUN_DIALOG_SHOW .
1816 \begin_layout Description
1817 Origin leeming, 25 Feb 2003
1820 \begin_layout Subsection*
1824 \begin_layout Description
1825 Action Shows hidden dialog or creates new one for a given function/inset
1829 \begin_layout Description
1830 Syntax dialog-show <NAME> [<DATA>]
1833 \begin_layout Description
1834 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1835 \begin_inset Newline newline
1838 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1839 \begin_inset Newline newline
1842 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
1844 \begin_inset Newline newline
1847 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1848 \begin_inset Newline newline
1851 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1852 \begin_inset Newline newline
1855 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1856 \begin_inset Newline newline
1859 <SPECIAL>: latexlog|vclog
1860 \begin_inset Newline newline
1863 <DATA>: data, usually settings for the given dialog.
1864 Use debug mode for the details.
1867 \begin_layout Description
1868 Origin leeming, 17 Jun 2003
1871 \begin_layout Subsection*
1872 dialog-show-new-inset
1875 \begin_layout Description
1876 Action Shows hidden dialog or create new one for a given inset settings
1880 \begin_layout Description
1881 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
1885 \begin_layout Description
1886 Syntax dialog-show-new-inset <NAME> [<DATA>]
1889 \begin_layout Description
1890 Params See LFUN_DIALOG_SHOW .
1893 \begin_layout Description
1894 Origin leeming, 25 Feb 2003
1897 \begin_layout Subsection*
1901 \begin_layout Description
1902 Action Toggles dialog between showed/hidden state.
1905 \begin_layout Description
1906 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1909 \begin_layout Description
1910 Syntax dialog-toggle <NAME> [<DATA>]
1913 \begin_layout Description
1914 Params See LFUN_DIALOG_SHOW .
1917 \begin_layout Description
1918 Origin JSpitzm, 30 Apr 2007
1921 \begin_layout Subsection*
1925 \begin_layout Description
1926 Action Updates the dialog values from the inset/paragraph/document.
1929 \begin_layout Description
1930 Syntax dialog-update <NAME>
1933 \begin_layout Description
1934 Params <NAME>: paragraph|prefs|<INSET>
1935 \begin_inset Newline newline
1941 \begin_layout Description
1942 Origin leeming, 25 Feb 2003
1945 \begin_layout Subsection*
1949 \begin_layout Description
1950 Action Moves the cursor one line in downward direction.
1953 \begin_layout Description
1957 \begin_layout Subsection*
1961 \begin_layout Description
1962 Action Moves the cursor one line in downward direction adding the current
1963 position to the selection.
1966 \begin_layout Description
1970 \begin_layout Subsection*
1974 \begin_layout Description
1975 Action Inserts an ERT inset.
1978 \begin_layout Description
1982 \begin_layout Description
1983 Origin Jug, 18 Feb 2000
1986 \begin_layout Subsection*
1990 \begin_layout Description
1991 Action Clears the selection.
1992 If no text is selected call LFUN_FINISHED_FORWARD.
1993 Inside math mode jumps out of the math inset.
1996 \begin_layout Description
2000 \begin_layout Description
2001 Origin Lgb, 17 May 2001
2004 \begin_layout Subsection*
2008 \begin_layout Description
2009 Action Inserts another LyX file.
2012 \begin_layout Description
2013 Syntax file-insert [<FILE>]
2016 \begin_layout Description
2017 Params <FILE>: Filename to be inserted.
2020 \begin_layout Subsection*
2021 file-insert-plaintext
2024 \begin_layout Description
2025 Action Inserts plain text file.
2028 \begin_layout Description
2029 Syntax file-insert-plaintext [<FILE>]
2032 \begin_layout Description
2033 Params <FILE>: Filename to be inserted.
2036 \begin_layout Description
2037 Origin CFO-G, 19 Nov 1997
2040 \begin_layout Subsection*
2041 file-insert-plaintext-para
2044 \begin_layout Description
2045 Action Inserts plain text file as paragraph (i.e.
2049 \begin_layout Description
2050 Syntax file-insert-plaintext-para [<FILE>]
2053 \begin_layout Description
2054 Params <FILE>: Filename to be inserted.
2057 \begin_layout Description
2058 Origin Levon, 14 Feb 2001
2061 \begin_layout Subsection*
2065 \begin_layout Description
2066 Action Inserts CharStyle, Custom inset or XML short element.
2069 \begin_layout Description
2070 Notion Look into the Customization manual for more information about these
2072 \begin_inset Newline newline
2075 To make this command enabled the layout file for the document class you're
2076 using has to load the character styles.
2077 There are a few contained in the Logical Markup module.
2078 You can also of course create some yourself.
2079 \begin_inset Newline newline
2082 For dissolving the element see LFUN_INSET_DISSOLVE.
2085 \begin_layout Description
2086 Syntax flex-insert Name
2089 \begin_layout Description
2090 Params Name: This name must be defined either in your layout file or imported
2092 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
2093 The Flex: prefix is optional.
2096 \begin_layout Description
2097 Sample flex-insert Code
2100 \begin_layout Subsection*
2104 \begin_layout Description
2105 Action Inserts a float inset.
2108 \begin_layout Description
2109 Syntax float-insert <TYPE>
2112 \begin_layout Description
2113 Params <TYPE>: type of float depends on the used textclass.
2114 Usually "algorithm", "table", "figure" parameters can be given.
2117 \begin_layout Description
2118 Origin Lgb, 27 Jun 2000
2121 \begin_layout Subsection*
2125 \begin_layout Description
2126 Action Inserts the list of floats in the document.
2129 \begin_layout Description
2130 Syntax float-list-insert <TYPE>
2133 \begin_layout Description
2134 Params <TYPE>: type of float depends on the used textclass.
2135 Usually "algorithm", "table", "figure" parameters can be given.
2138 \begin_layout Description
2139 Origin Lgb, 3 May 2001
2142 \begin_layout Subsection*
2146 \begin_layout Description
2147 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2150 \begin_layout Description
2151 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2154 \begin_layout Description
2155 Syntax float-wide-insert <TYPE>
2158 \begin_layout Description
2159 Params <TYPE>: type of float depends on the used textclass.
2160 Usually "algorithm", "table", "figure" parameters can be given.
2163 \begin_layout Description
2164 Origin Lgb, 31 Oct 2001
2167 \begin_layout Subsection*
2171 \begin_layout Description
2172 Action Inserts a footnote inset.
2175 \begin_layout Description
2176 Syntax footnote-insert
2179 \begin_layout Description
2180 Origin Jug, 7 Mar 2000
2183 \begin_layout Subsection*
2187 \begin_layout Description
2188 Action Reloads the image if necessary.
2191 \begin_layout Description
2192 Syntax graphics-reload
2195 \begin_layout Description
2196 Origin vfr, 10 Aug 2009
2199 \begin_layout Subsection*
2203 \begin_layout Description
2204 Action Inserts hyperlinks into the document (clickable in pdf output).
2207 \begin_layout Description
2208 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2211 \begin_layout Description
2212 Syntax href-insert [<TARGET>]
2215 \begin_layout Description
2216 Origin CFO-G, 21 Nov 1997
2219 \begin_layout Subsection*
2223 \begin_layout Description
2224 Action Only active in IPA inset.
2227 \begin_layout Description
2228 Notion Dummy function which is only active in a IPA inset.
2229 It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2232 \begin_layout Description
2236 \begin_layout Description
2237 Origin spitz, 20 May 2012
2240 \begin_layout Subsection*
2244 \begin_layout Description
2245 Action Inserts Index entry.
2248 \begin_layout Description
2249 Notion It automatically takes the word on the cursor position.
2252 \begin_layout Description
2253 Syntax index-insert [<TYPE:Name>]
2256 \begin_layout Description
2257 Params <TYPE:Name>: name of the index, if multiple indices are defined.
2258 With an empty argument, the default index is selected.
2261 \begin_layout Description
2262 Origin leeming, 3 Aug 2000
2265 \begin_layout Subsection*
2269 \begin_layout Description
2270 Action Inserts list of Index entries on a new page.
2273 \begin_layout Description
2274 Syntax index-print [<TYPE:Name>]
2277 \begin_layout Description
2278 Params <TYPE:Name>: name of the index, if multiple indices are defined.
2279 With an empty argument, the default index is selected.
2282 \begin_layout Description
2283 Origin Lgb, 27 Feb 1997
2286 \begin_layout Subsection*
2290 \begin_layout Description
2291 Action Displays shortcuts, lyxrc, package and textclass availability and
2292 menu information in a non-editable boxed InsetText.
2295 \begin_layout Description
2296 Notion Apart from lfun arguments you can use the following method:
2297 \begin_inset Newline newline
2301 input the type and argument of this inset, e.g.
2302 "menu paste", in the work area.
2303 \begin_inset Newline newline
2307 select the text and run info-insert lfun.
2310 \begin_layout Description
2311 Syntax info-insert <TYPE> <ARG>
2314 \begin_layout Description
2315 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
2316 \begin_inset Newline newline
2319 <ARG>: argument for a given type.
2320 Look into InsetInfo.h for detailed description.
2321 \begin_inset Newline newline
2324 shortcut[s]: name of lfun (e.g math-insert
2327 \begin_inset Newline newline
2330 lyxrc: name of rc_entry (e.g.
2332 \begin_inset Newline newline
2335 lyxinfo: "version" - used version of LyX
2336 \begin_inset Newline newline
2339 package: name of latex package (e.g.
2341 \begin_inset Newline newline
2344 textclass: name of textclass (e.g.
2346 \begin_inset Newline newline
2349 menu: name of lfun used in menu
2350 \begin_inset Newline newline
2353 icon: icon of lfun used in toolbar or direct icon name
2354 \begin_inset Newline newline
2357 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-a
2358 uthor"|"vcs-date"|"vcs-time"
2361 \begin_layout Description
2362 Sample command-sequence info-insert buffer path; info-insert buffer name
2365 \begin_layout Description
2366 Origin bpeng, 7 Oct 2007
2369 \begin_layout Subsection*
2373 \begin_layout Description
2374 Action Apply data for an inset.
2377 \begin_layout Description
2378 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
2380 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
2381 on the context where it is called.
2384 \begin_layout Description
2385 Syntax inset-apply <ARGS>
2388 \begin_layout Description
2389 Params See LFUN_INSET_INSERT .
2392 \begin_layout Subsection*
2396 \begin_layout Description
2397 Action Move the cursor to the beginning of the current inset if it is not
2398 already there, or at the beginning of the enclosing inset otherwise
2401 \begin_layout Description
2405 \begin_layout Description
2406 Origin lasgouttes, 16 Mar 2009
2409 \begin_layout Subsection*
2413 \begin_layout Description
2414 Action Move the cursor to the beginning of the current inset if it is not
2415 already there, or at the beginning of the enclosing inset otherwise (adding
2416 the traversed text to the selection).
2419 \begin_layout Description
2420 Syntax inset-begin-select
2423 \begin_layout Description
2424 Origin lasgouttes, 16 Mar 2009
2427 \begin_layout Subsection*
2431 \begin_layout Description
2432 Action Copies the inset to the clipboard as a certain type.
2435 \begin_layout Description
2436 Notion Currently used only for InsetInfo where its content is copied as
2440 \begin_layout Description
2441 Syntax inset-copy-as
2444 \begin_layout Description
2445 Origin vfr, 18 Apr 2010
2448 \begin_layout Subsection*
2452 \begin_layout Description
2453 Action Dissolve the current inset into text.
2456 \begin_layout Description
2457 Syntax inset-dissolve [<INSET>]
2460 \begin_layout Description
2461 Params <INSET>: this can be used to make sure the right kind of inset is
2463 For example "dissolve" entry in the charstyles sub-menu should only dissolve
2464 the charstyle inset, even if the cursor is inside several nested insets
2466 \begin_inset Newline newline
2469 For values see lyx::InsetLayout::lyxtype_ .
2472 \begin_layout Description
2473 Origin JSpitz, 7 Aug 2006
2476 \begin_layout Subsection*
2480 \begin_layout Description
2481 Action Edit the inset at cursor with an external application, if one is
2485 \begin_layout Description
2486 Syntax inset-edit [<INSET_PARAMS>]
2489 \begin_layout Description
2490 Params <INSET_PARAMS>: Parameters for the inset.
2491 \begin_inset Newline newline
2494 Currently only the filename will be considered.
2497 \begin_layout Description
2498 Origin JSpitzm, 27 Apr 2006
2501 \begin_layout Subsection*
2505 \begin_layout Description
2506 Action Move the cursor to the end of the current inset if it is not already
2507 there, or at the end of the enclosing inset otherwise
2510 \begin_layout Description
2514 \begin_layout Description
2515 Origin lasgouttes, 16 Mar 2009
2518 \begin_layout Subsection*
2522 \begin_layout Description
2523 Action Move the cursor to the end of the current inset if it is not already
2524 there, or at the end of the enclosing inset otherwise (adding the traversed
2525 text to the selection).
2528 \begin_layout Description
2529 Syntax inset-end-select
2532 \begin_layout Description
2533 Origin lasgouttes, 16 Mar 2009
2536 \begin_layout Subsection*
2540 \begin_layout Description
2541 Action Apply the given commands on insets of a given name.
2544 \begin_layout Description
2545 Notion WARNING: use at your own risks; this function gives you too many
2546 ways of shooting yourself in the foot.
2547 A typical example is inset-forall Note note-insert which starts an infinite
2549 This is mitigated by the fact that the number of actions is arbitrarily
2551 Note also that inset-forall does not update metrics between iterations,
2552 which can lead to bugs.
2553 This has to be eventually fixed.
2556 \begin_layout Description
2557 Syntax inset-forall <NAME> <LFUN-COMMAND>
2558 \begin_inset Newline newline
2561 <NAME>: Type of Inset.
2562 If <NAME> is *, all insets are matched.
2563 The name is used like for InsetLayout in layout files: "Note" matches all
2564 note insets, while "Note:Note" only matches LyX yellow note insets.
2567 \begin_layout Description
2568 Sample Remove all index insets:
2569 \begin_inset Newline newline
2572 inset-forall Index char-delete-forward force
2573 \begin_inset Newline newline
2576 Close all Notes (also works for a particular branch, for example):
2577 \begin_inset Newline newline
2580 inset-forall Note inset-toggle close
2581 \begin_inset Newline newline
2584 Transform all yellow notes to comments
2585 \begin_inset Newline newline
2588 inset-forall Note:Note inset-modify note Note Comment
2589 \begin_inset Newline newline
2592 Try to put LyX in an infinite loop if there is at least a Note:
2593 \begin_inset Newline newline
2596 inset-forall Note char-backward
2599 \begin_layout Description
2600 Origin lasgouttes, 27 Nov 2009
2603 \begin_layout Subsection*
2607 \begin_layout Description
2608 Action Insert new inset (type given by the parameters).
2611 \begin_layout Description
2612 Syntax inset-insert <INSET> <ARGS>
2615 \begin_layout Description
2616 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2617 \begin_inset Newline newline
2620 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|scri
2622 \begin_inset Newline newline
2625 <ARGS>: depends on the given inset.
2626 Use "lyx -dbg action" to explore.
2629 \begin_layout Description
2630 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2633 \begin_inset Newline newline
2636 where <label name> is the name of the referenced label and <Format> is one
2638 \begin_inset Newline newline
2642 \begin_inset Newline newline
2645 eqref -- (<reference>)
2646 \begin_inset Newline newline
2650 \begin_inset Newline newline
2653 vpageref -- on <page>
2654 \begin_inset Newline newline
2657 vref -- <reference> on <page>
2658 \begin_inset Newline newline
2661 formatted -- Formatted reference
2664 \begin_layout Subsection*
2668 \begin_layout Description
2669 Action Modify some properties of an inset.
2672 \begin_layout Description
2673 Notion Used for argument, bibitem, bibtex, box, branch, caption, citation,
2674 command, ert, external, float, graphics, include, index, info, label, line,
2675 listings, newline, newpage, nomencl, note, phantom, quotes, ref, script,
2676 separator, space, tabular, vspace and wrap insets.
2679 \begin_layout Description
2680 Syntax inset-modify <INSET> <ARGS>
2681 \begin_inset Newline newline
2684 inset-modify changetype <TYPE>
2687 \begin_layout Description
2688 Sample Change a Note inset into a Comment inset:
2689 \begin_inset Newline newline
2692 inset-modify note Note Comment
2693 \begin_inset Newline newline
2696 Change a Box into an Ovalbox:
2697 \begin_inset Newline newline
2700 inset-modify changetype Ovalbox
2701 \begin_inset Newline newline
2704 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle
2706 \begin_inset Newline newline
2709 inset-modify changetype els
2710 \begin_inset Newline newline
2713 Change only the style of a quotation mark, maintaining the other aspects
2716 \begin_inset Newline newline
2719 inset-modify changetype e..
2720 \begin_inset Newline newline
2726 \begin_layout Subsection*
2730 \begin_layout Description
2731 Action Select all contents of an inset.
2734 \begin_layout Description
2735 Notion There are 3 successive levels: select current cell, select all cells
2736 of inset, select the inset from outside (in the enclosing inset).
2739 \begin_layout Description
2740 Syntax inset-select-all
2743 \begin_layout Description
2744 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2747 \begin_layout Subsection*
2751 \begin_layout Description
2752 Action Open the inset's properties dialog.
2755 \begin_layout Description
2756 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
2757 graphics, href, include, index, index_print, label, line, listings, note,
2758 phantom, ref, space, tabular, vspace, wrap insets.
2761 \begin_layout Description
2762 Syntax inset-settings <INSET>
2765 \begin_layout Description
2766 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2767 \begin_inset Newline newline
2770 graphics|href|include|index|index_print|label|line|
2771 \begin_inset Newline newline
2774 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2777 \begin_layout Subsection*
2781 \begin_layout Description
2782 Action Toggles the collapsible inset at cursor position, or the inset we
2786 \begin_layout Description
2787 Syntax inset-toggle [<ARG>]
2790 \begin_layout Description
2791 Params <ARG>: <open|close|toggle|assign>.
2792 \begin_inset Newline newline
2795 open/close/toggle are for collapsible insets.
2796 toggle is used when no argument is given.
2797 \begin_inset Newline newline
2800 assign synchronize the branch-inset with activation status of the branch.
2801 Used for global toggling when changed activation.
2804 \begin_layout Description
2805 Origin lasgouttes, 19 Jul 2001
2808 \begin_layout Subsection*
2812 \begin_layout Description
2813 Action Inserts an IPA inset.
2816 \begin_layout Description
2820 \begin_layout Description
2821 Origin spitz, 05 Mar 2012
2824 \begin_layout Subsection*
2828 \begin_layout Description
2829 Action Inserts special IPA macros into the document.
2832 \begin_layout Description
2833 Syntax ipamacro-insert <CHAR>
2836 \begin_layout Description
2837 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
2838 tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2841 \begin_layout Description
2842 Origin JSpitzm, 22 Aug 2012
2845 \begin_layout Subsection*
2849 \begin_layout Description
2850 Action Turn off the loaded keyboard map.
2853 \begin_layout Description
2857 \begin_layout Subsection*
2861 \begin_layout Description
2862 Action Turn on the primary keyboard map.
2865 \begin_layout Description
2866 Notion Maps were widely used in past, when X-windows didn't have nowadays
2868 They can be still used to maintain uniform keyboard layout across the various
2870 \begin_inset Newline newline
2873 The language is to be set in the Preferences dialog.
2876 \begin_layout Description
2877 Syntax keymap-primary
2880 \begin_layout Subsection*
2884 \begin_layout Description
2885 Action Turn on the secondary keyboard map.
2888 \begin_layout Description
2889 Syntax keymap-secondary
2892 \begin_layout Subsection*
2896 \begin_layout Description
2897 Action Toggles keyboard maps (first/second/off).
2900 \begin_layout Description
2901 Syntax keymap-toggle
2904 \begin_layout Description
2905 Origin leeming, 30 Mar 2004
2908 \begin_layout Subsection*
2909 label-copy-as-reference
2912 \begin_layout Description
2913 Action Copies the label at the cursor as a cross-reference to be pasted
2917 \begin_layout Description
2918 Syntax copy-label-as-reference <LABEL>
2921 \begin_layout Description
2922 Params <LABEL>: The label to copy (for multi-line math)
2925 \begin_layout Description
2926 Origin sts, 16 Nov 2008
2929 \begin_layout Subsection*
2933 \begin_layout Description
2934 Action Goto a label.
2937 \begin_layout Description
2938 Syntax label-goto [<LABEL>]
2941 \begin_layout Description
2942 Params <LABEL>: Requested label.
2943 If no label is given and reference is on cursor position, Bookmark 0 is
2944 saved and cursor moves to the position of referenced label.
2947 \begin_layout Description
2948 Origin Ale, 6 Aug 1997
2951 \begin_layout Subsection*
2955 \begin_layout Description
2956 Action Inserts label to text or displayed formula.
2959 \begin_layout Description
2960 Syntax label-insert [<LABEL>]
2963 \begin_layout Description
2964 Params <LABEL>: Requested label.
2965 If no label is given dialog requesting name will be opened.
2968 \begin_layout Subsection*
2969 label-insert-as-reference
2972 \begin_layout Description
2973 Action Inserts the label (in ToC pane) as a cross-reference at the position
2977 \begin_layout Description
2978 Syntax label-insert-as-reference
2981 \begin_layout Description
2982 Origin vfr, 7 Apr 2009
2985 \begin_layout Subsection*
2989 \begin_layout Description
2990 Action Set language from the current cursor position.
2993 \begin_layout Description
2994 Syntax language <LANG> [set]
2997 \begin_layout Description
2998 Params <LANG>: Requested language.
2999 Look in lib/languages for the list.
3000 "language reset" or "language" (without param) reset to the document language.
3001 set: If used, the language will be set to the specified language.
3002 Otherwise, the language will be toggled (i.e., if the current language is
3003 LANG, switch to the document language or the default language, if LANG
3004 is the document language).
3007 \begin_layout Description
3008 Origin Dekel, 2 Mar 2000
3011 \begin_layout Subsection*
3015 \begin_layout Description
3016 Action Move the cursor to the beginning of the (screen) line.
3019 \begin_layout Description
3023 \begin_layout Subsection*
3027 \begin_layout Description
3028 Action Move the cursor to the beginning of the (screen) line adding the
3029 traversed text to the selection.
3032 \begin_layout Description
3033 Syntax line-begin-select
3036 \begin_layout Subsection*
3040 \begin_layout Description
3041 Action Deletes the letters to the end of the (screen) line or deletes the
3045 \begin_layout Description
3046 Syntax line-delete-forward
3049 \begin_layout Subsection*
3053 \begin_layout Description
3054 Action Move the cursor to the end of the (screen) line.
3057 \begin_layout Description
3061 \begin_layout Subsection*
3065 \begin_layout Description
3066 Action Move the cursor to the end of the (screen) line adding the traversed
3067 text to the selection.
3070 \begin_layout Description
3071 Syntax line-end-select
3074 \begin_layout Subsection*
3078 \begin_layout Description
3079 Action Inserts a new listings inset.
3082 \begin_layout Description
3083 Syntax listing-insert
3086 \begin_layout Description
3087 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
3090 \begin_layout Subsection*
3094 \begin_layout Description
3095 Action Inserts a marginal note.
3098 \begin_layout Description
3099 Syntax marginalnote-insert
3102 \begin_layout Description
3103 Origin Lgb, 26 Jun 2000
3106 \begin_layout Subsection*
3110 \begin_layout Description
3111 Action Disable selecting of text-region.
3114 \begin_layout Description
3118 \begin_layout Subsection*
3122 \begin_layout Description
3123 Action Enable selecting of text-region.
3126 \begin_layout Description
3127 Notion After enabling you can simply move arrow keys to get selected region.
3130 \begin_layout Description
3134 \begin_layout Subsection*
3138 \begin_layout Description
3139 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3142 \begin_layout Description
3146 \begin_layout Description
3147 Origin Andre, May 5 2006
3150 \begin_layout Subsection*
3154 \begin_layout Description
3155 Action Inserts a line break or new line.
3158 \begin_layout Description
3159 Syntax newline-insert [<ARG>]
3162 \begin_layout Description
3163 Params <ARG>: <newline|linebreak> default: newline
3166 \begin_layout Description
3167 Origin JSpitzm, 25 Mar 2008
3170 \begin_layout Subsection*
3174 \begin_layout Description
3175 Action Inserts a new page.
3178 \begin_layout Description
3179 Syntax newpage-insert <ARG>
3182 \begin_layout Description
3183 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3186 \begin_layout Description
3187 Origin uwestoehr, 24 Nov 2007
3190 \begin_layout Subsection*
3194 \begin_layout Description
3195 Action Inserts Nomenclature entry.
3198 \begin_layout Description
3199 Notion It automatically takes the word on the cursor position if no symbol
3203 \begin_layout Description
3204 Syntax nomencl-insert [<SYMBOL>]
3207 \begin_layout Description
3208 Origin Ugras, 4 Nov 2006
3211 \begin_layout Subsection*
3215 \begin_layout Description
3216 Action Inserts list of Nomenclature entries.
3219 \begin_layout Description
3220 Syntax nomenclature-print
3223 \begin_layout Description
3224 Origin Ugras, 4 Nov 2006
3227 \begin_layout Subsection*
3231 \begin_layout Description
3232 Action Inserts Note on the current cursor position, move selection inside
3236 \begin_layout Description
3237 Syntax note-insert [<TYPE>]
3240 \begin_layout Description
3241 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3244 \begin_layout Subsection*
3248 \begin_layout Description
3249 Action Moves the cursor to the beginning of next Note inset.
3252 \begin_layout Description
3256 \begin_layout Subsection*
3260 \begin_layout Description
3261 Action Move the current group in the downward direction in the structure
3265 \begin_layout Description
3266 Notion The "group" can be Part/Chapter/Section/etc.
3267 It moves the whole substructure of the group.
3270 \begin_layout Description
3274 \begin_layout Description
3275 Origin Vermeer, 23 Mar 2006
3278 \begin_layout Subsection*
3282 \begin_layout Description
3283 Action Moves the current group in the downward direction in the hierarchy
3284 of the document structure.
3287 \begin_layout Description
3288 Notion Part -> Chapter -> Section -> etc.
3291 \begin_layout Description
3295 \begin_layout Description
3296 Origin Vermeer, 23 Mar 2006
3299 \begin_layout Subsection*
3303 \begin_layout Description
3304 Action Moves the current group in the upward direction in the hierarchy
3305 of the document structure.
3308 \begin_layout Description
3309 Notion Part <- Chapter <- Section <- etc.
3312 \begin_layout Description
3316 \begin_layout Description
3317 Origin Vermeer, 23 Mar 2006
3320 \begin_layout Subsection*
3324 \begin_layout Description
3325 Action Move the current group in the upward direction in the structure of
3329 \begin_layout Description
3330 Notion The "group" can be Part/Chapter/Section/etc.
3331 It moves the whole substructure of the group.
3334 \begin_layout Description
3338 \begin_layout Description
3339 Origin Vermeer, 23 Mar 2006
3342 \begin_layout Subsection*
3346 \begin_layout Description
3347 Action Breaks the current paragraph at the current location.
3350 \begin_layout Description
3351 Notion Removes the selection.
3354 \begin_layout Description
3355 Syntax paragraph-break [<LAYOUT>]
3358 \begin_layout Description
3359 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3360 default layout) when the cursor is at the end of the line.
3363 \begin_layout Subsection*
3367 \begin_layout Description
3368 Action Move the cursor to the next paragraph (or beginning of the current
3369 one) in downward direction.
3372 \begin_layout Description
3373 Syntax paragraph-down
3376 \begin_layout Description
3377 Origin Asger, 1 Oct 1996
3380 \begin_layout Subsection*
3381 paragraph-down-select
3384 \begin_layout Description
3385 Action Move the cursor and select the text to the next paragraph (or beginning
3386 of the current one) in downward direction.
3389 \begin_layout Description
3390 Syntax paragraph-down-select
3393 \begin_layout Description
3394 Origin Asger, 1 Oct 1996
3397 \begin_layout Subsection*
3401 \begin_layout Description
3402 Action Jump to a paragraph given by its id number and optionally the desired
3403 position within the paragraph.
3404 If given four arguments id_start, pos_start, id_end, pos_end, perform a
3405 selection from start to end.
3408 \begin_layout Description
3409 Notion Note that id number of paragraph is not the sequential number of
3410 paragraph seen on the screen.
3411 Moreover the id is unique for all opened buffers (documents).
3412 Both ids must belong to the same buffer.
3415 \begin_layout Description
3416 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3419 \begin_layout Description
3420 Params <PAR_ID>: paragraph id
3421 \begin_inset Newline newline
3424 <POS_IN_PAR>: desired position within the paragraph
3427 \begin_layout Description
3428 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3431 \begin_layout Subsection*
3435 \begin_layout Description
3436 Action Moves the current paragraph downwards in the document.
3439 \begin_layout Description
3440 Syntax paragraph-move-down
3443 \begin_layout Description
3444 Origin Edwin, 8 Apr 2006
3447 \begin_layout Subsection*
3451 \begin_layout Description
3452 Action Moves the current paragraph upwards in the document.
3455 \begin_layout Description
3456 Notion Movement through the document will possibly break the paragraph-depth
3461 \begin_layout Description
3462 Syntax paragraph-move-up
3465 \begin_layout Description
3466 Origin Edwin, 8 Apr 2006
3469 \begin_layout Subsection*
3473 \begin_layout Description
3474 Action Change paragraph settings.
3477 \begin_layout Description
3478 Notion Modifies the current paragraph, or currently selected paragraphs.
3479 This function only modifies, and does not override, existing settings.
3480 Note that the "leftindent" indent setting is deprecated.
3483 \begin_layout Description
3484 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3487 \begin_layout Description
3497 \begin_inset Newline newline
3502 paragraph_spacing default|single|onehalf|double|other SIZE
3503 \begin_inset Newline newline
3508 align block|left|right|center|default
3509 \begin_inset Newline newline
3514 labelwidthstring WIDTH|
3519 \begin_layout Description
3520 Origin rgh, Aug 15 2007
3523 \begin_layout Subsection*
3524 paragraph-params-apply
3527 \begin_layout Description
3528 Action Change paragraph settings.
3531 \begin_layout Description
3532 Notion Overwrite all nonspecified settings to the default ones.
3533 Use paragraph-params lfun if you don't want to overwrite others settings.
3536 \begin_layout Description
3537 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3540 \begin_layout Description
3541 Params For parameters see LFUN_PARAGRAPH_PARAMS
3544 \begin_layout Description
3545 Origin leeming, 30 Mar 2004
3548 \begin_layout Subsection*
3552 \begin_layout Description
3553 Action Move the cursor to the next paragraph (or beginning of the current
3554 one) in upward direction.
3557 \begin_layout Description
3561 \begin_layout Description
3562 Origin Asger, 1 Oct 1996
3565 \begin_layout Subsection*
3569 \begin_layout Description
3570 Action Move the cursor and select the text to the next paragraph (or beginning
3571 of the current one) in upward direction.
3574 \begin_layout Description
3575 Syntax paragraph-up-select
3578 \begin_layout Description
3579 Origin Asger, 1 Oct 1996
3582 \begin_layout Subsection*
3586 \begin_layout Description
3587 Action Pastes material (text or picture) from the active clipboard.
3590 \begin_layout Description
3591 Syntax paste [<TYPE>|<NUM>]
3594 \begin_layout Description
3595 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3596 \begin_inset Newline newline
3599 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3602 \begin_layout Subsection*
3606 \begin_layout Description
3607 Action Inserts phantom on the current cursor position, move selection inside
3611 \begin_layout Description
3612 Syntax phantom-insert [<TYPE>]
3615 \begin_layout Description
3616 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3619 \begin_layout Description
3620 Origin uwestoehr, 30 Jan 2009
3623 \begin_layout Subsection*
3627 \begin_layout Description
3628 Action Inserts a new preview inset.
3631 \begin_layout Description
3632 Syntax preview-insert
3635 \begin_layout Description
3636 Origin vfr, 28 Mar 2010
3639 \begin_layout Subsection*
3640 primary-selection-paste
3643 \begin_layout Description
3644 Action Pastes the currently selected text.
3647 \begin_layout Description
3648 Notion Primary selection mechanism is linux-only thing.
3651 \begin_layout Description
3652 Syntax primary-selection-paste [<ARG>]
3655 \begin_layout Description
3656 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
3660 \begin_layout Subsection*
3664 \begin_layout Description
3665 Action Inserts quotes according to the type and quote-language preference.
3668 \begin_layout Description
3669 Notion Currently 15 different quote styles are distinguished (see params).
3672 \begin_layout Description
3673 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3676 \begin_layout Description
3677 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3678 outer (i.e., primary, usually double) quotes will be used.
3679 \begin_inset Newline newline
3682 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise
3683 the side will be guessed from the context.
3684 \begin_inset Newline newline
3687 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3688 \begin_inset Newline newline
3691 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3692 \begin_inset Newline newline
3695 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3696 \begin_inset Newline newline
3699 'danish' for >>Danish<< quote style (with >inner quotation<)
3700 \begin_inset Newline newline
3703 'english' for ``English'' quote style (with `inner quotation')
3704 \begin_inset Newline newline
3707 'french' for <<french>> quote style (with ``inner quotation'')
3708 \begin_inset Newline newline
3711 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in"
3712 = Imprimerie Nationale]
3713 \begin_inset Newline newline
3716 'german' for ,,German`` quote style (with ,inner quotation`)
3717 \begin_inset Newline newline
3720 'plain' for "Plain" quote style (with 'inner quotation')
3721 \begin_inset Newline newline
3724 'polish' for ,,Polish'' quote style (with ,inner quotation')
3725 \begin_inset Newline newline
3728 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3729 \begin_inset Newline newline
3732 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" =
3734 \begin_inset Newline newline
3737 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3738 \begin_inset Newline newline
3741 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3742 \begin_inset Newline newline
3745 'dynamic' for Dynamic quotation marks which inherit the global document
3747 \begin_inset Newline newline
3750 If no quote style is specified, the document-wide will be used.
3753 \begin_layout Subsection*
3757 \begin_layout Description
3758 Action Redoes the last thing undone.
3761 \begin_layout Description
3765 \begin_layout Subsection*
3769 \begin_layout Description
3770 Action Go to the next label or cross-reference.
3773 \begin_layout Description
3774 Syntax reference-next
3777 \begin_layout Description
3778 Origin Dekel, 14 Jan 2001
3781 \begin_layout Subsection*
3785 \begin_layout Description
3786 Action Repeat the given command.
3789 \begin_layout Description
3790 Notion fails when the repeat count is greater than 10000.
3793 \begin_layout Description
3794 Syntax repeat <COUNT> <LFUN-COMMAND>
3797 \begin_layout Description
3798 Origin Andre, 27 Oct 2003
3801 \begin_layout Subsection*
3805 \begin_layout Description
3806 Action Moves the cursor one page in downward direction.
3809 \begin_layout Description
3813 \begin_layout Subsection*
3817 \begin_layout Description
3818 Action Moves the cursor one screen in downward direction adding the current
3819 position to the selection.
3822 \begin_layout Description
3823 Syntax screen-down-select
3826 \begin_layout Subsection*
3830 \begin_layout Description
3831 Action Recenters the screen on the current cursor position.
3834 \begin_layout Description
3835 Syntax screen-recenter
3838 \begin_layout Subsection*
3842 \begin_layout Description
3843 Action Repositions the screen such that the cursor is visible.
3846 \begin_layout Description
3847 Syntax screen-show-cursor
3850 \begin_layout Description
3851 Origin vfr, 25 Mar 2009
3854 \begin_layout Subsection*
3858 \begin_layout Description
3859 Action Moves the cursor one page in upward direction.
3862 \begin_layout Description
3866 \begin_layout Subsection*
3870 \begin_layout Description
3871 Action Moves the cursor one page in upward direction adding the current
3872 position to the selection.
3875 \begin_layout Description
3876 Syntax screen-up-select
3879 \begin_layout Subsection*
3883 \begin_layout Description
3884 Action Inserts a subscript or superscript inset.
3887 \begin_layout Description
3888 Syntax script-insert <TYPE>
3891 \begin_layout Description
3892 Params <TYPE>: subscript|superscript
3895 \begin_layout Description
3896 Origin Georg, 23 Nov 2010
3899 \begin_layout Subsection*
3903 \begin_layout Description
3904 Action Scroll the buffer view.
3907 \begin_layout Description
3908 Notion Only scrolls the screen up or down; does not move the cursor.
3911 \begin_layout Description
3912 Syntax scroll <TYPE> <QUANTITY>
3915 \begin_layout Description
3916 Params <TYPE>: line|page
3917 \begin_inset Newline newline
3920 <QUANTITY>: up|down|<number>
3923 \begin_layout Description
3924 Origin Abdel, Dec 27 2007
3927 \begin_layout Subsection*
3931 \begin_layout Description
3932 Action Select the whole section.
3935 \begin_layout Description
3936 Notion The cursor should be in a section heading before calling this lfun.
3939 \begin_layout Description
3940 Syntax section-select
3943 \begin_layout Description
3944 Origin vfr, 05 May 2009
3947 \begin_layout Subsection*
3951 \begin_layout Description
3952 Action Pastes the internal selection text in permanent selection.
3955 \begin_layout Description
3956 Notion Created in order to have middle mouse button pasting correct (bound
3957 to command-alternatives selection-paste ; primary-selection-paste paragraph).
3960 \begin_layout Description
3961 Syntax selection-paste
3964 \begin_layout Description
3965 Origin lasgouttes, 14 Jan 2009
3968 \begin_layout Subsection*
3972 \begin_layout Description
3973 Action Inserts an environment separator or latex paragraph break.
3976 \begin_layout Description
3977 Syntax separator-insert [<ARG>]
3980 \begin_layout Description
3981 Params <ARG>: <plain|parbreak|latexpar> default: plain
3984 \begin_layout Description
3985 Origin ef, 2 May 2014
3988 \begin_layout Subsection*
3992 \begin_layout Description
3993 Action Set the group for the graphics inset on the cursor position.
3996 \begin_layout Description
3997 Syntax set-graphics-group [<GROUP>]
4000 \begin_layout Description
4001 Params <GROUP>: Id for an existing group.
4002 In case the Id is an empty string, the graphics inset is removed from the
4006 \begin_layout Description
4007 Origin sanda, 6 May 2008
4010 \begin_layout Subsection*
4014 \begin_layout Description
4015 Action Inserts one of horizontal space insets.
4018 \begin_layout Description
4019 Syntax space-insert <NAME> [<LEN>]
4022 \begin_layout Description
4023 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip,
4024 negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill,
4026 \begin_inset Newline newline
4029 Only in math mode: med and thick.
4030 \begin_inset Newline newline
4033 <LEN>: length for custom spaces (hspace, hspace* for protected)
4036 \begin_layout Description
4037 Origin JSpitzm, 20 May 2003, Mar 17 2008
4040 \begin_layout Subsection*
4044 \begin_layout Description
4045 Action Inserts various characters into the document.
4048 \begin_layout Description
4049 Syntax specialchar-insert <CHAR>
4052 \begin_layout Description
4053 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash,
4054 nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex,
4058 \begin_layout Description
4059 Origin JSpitzm, 6 Dec 2007
4062 \begin_layout Subsection*
4066 \begin_layout Description
4067 Action Add the word under the cursor to the respective spell checker dictionary.
4068 The default for the language is retrieved from the cursor position.
4071 \begin_layout Description
4072 Syntax spelling-add [<STRING>] [<LANG>]
4075 \begin_layout Description
4076 Params <WORD>: word to add <LANG>: language name (see file languages)
4079 \begin_layout Description
4080 Origin JSpitzm, 18 Jan 2010
4083 \begin_layout Subsection*
4084 spelling-continuously
4087 \begin_layout Description
4088 Action Toggle continuous spell checking.
4091 \begin_layout Description
4092 Syntax spelling-continuously
4095 \begin_layout Description
4096 Origin vfr, 24 March 2013
4099 \begin_layout Subsection*
4103 \begin_layout Description
4104 Action Let the spell checker ignore the word under the cursor in the current
4105 session for the given language.
4106 The default for the language is retrieved from the cursor position.
4109 \begin_layout Description
4110 Syntax spelling-ignore [<WORD>] [<LANG>]
4113 \begin_layout Description
4114 Params <WORD>: word to ignore <LANG>: language name (see file languages)
4117 \begin_layout Description
4118 Origin JSpitzm, 18 Jan 2010
4121 \begin_layout Subsection*
4125 \begin_layout Description
4126 Action Remove the word under the cursor from the respective spell checker
4128 The default for the language is retrieved from the cursor position.
4131 \begin_layout Description
4132 Syntax spelling-remove [<STRING>] [<LANG>]
4135 \begin_layout Description
4136 Params <WORD>: word to remove <LANG>: language name (see file languages)
4139 \begin_layout Description
4140 Origin SWitt, 28 July 2010
4143 \begin_layout Subsection*
4147 \begin_layout Description
4148 Action Delete a tab or up to an equivalent amount of spaces from a listings
4152 \begin_layout Description
4153 Notion It also works on a selection - it removes a tab or spaces from the
4154 beginning of each line spanned by the selection.
4155 This is useful if you want to indent/unindent multiple lines in one action.
4158 \begin_layout Description
4162 \begin_layout Description
4163 Origin vfr, Sep 30 2008
4166 \begin_layout Subsection*
4170 \begin_layout Description
4171 Action Insert a tab into a listings inset.
4174 \begin_layout Description
4175 Notion It also works on a selection.
4178 \begin_layout Description
4182 \begin_layout Description
4183 Origin vfr, Sep 30 2008
4186 \begin_layout Subsection*
4190 \begin_layout Description
4191 Action Modify properties of tabulars and table-like math environments.
4194 \begin_layout Description
4195 Syntax tabular-feature <FEATURE> [<ARG>]
4198 \begin_layout Description
4199 Params Generally see LFUN_INSET_INSERT for further details.
4200 \begin_inset Newline newline
4203 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4204 \begin_inset Newline newline
4207 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4208 \begin_inset Newline newline
4211 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4212 \begin_inset Newline newline
4215 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4216 \begin_inset Newline newline
4219 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4220 \begin_inset Newline newline
4223 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4224 \begin_inset Newline newline
4227 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4228 \begin_inset Newline newline
4231 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabul
4233 \begin_inset Newline newline
4236 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4237 \begin_inset Newline newline
4240 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4241 \begin_inset Newline newline
4244 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4245 \begin_inset Newline newline
4248 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4249 \begin_inset Newline newline
4252 set-special-column|set-special-multicolumn|set-special-multirow|
4253 \begin_inset Newline newline
4256 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4257 \begin_inset Newline newline
4260 set-interline-space|set-border-lines|tabular-valign-top|
4261 \begin_inset Newline newline
4264 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
4265 \begin_inset Newline newline
4268 Various math-environment features are handled as well, e.g.
4269 add-vline-left/right for
4270 \begin_inset Newline newline
4273 the Grid/Array environment.
4274 \begin_inset Newline newline
4277 <ARG>: additional argument for some commands, use debug mode to explore
4281 \begin_layout Description
4282 Origin gm, 10 Dec 2015
4285 \begin_layout Subsection*
4289 \begin_layout Description
4290 Action Inserts table into the document.
4293 \begin_layout Description
4294 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modification
4298 \begin_layout Description
4299 Syntax tabular-insert [<ROWS> <COLUMNS>]
4302 \begin_layout Description
4303 Params In case no arguments are given show insert dialog.
4306 \begin_layout Description
4307 Origin Jug, 12 Apr 2000
4310 \begin_layout Subsection*
4314 \begin_layout Description
4315 Action Look up thesaurus entries with respect to the word under the cursor.
4318 \begin_layout Description
4319 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4322 \begin_layout Description
4323 Params <STRING>: word to look up <LANG>: language (see file languages)
4326 \begin_layout Description
4327 Origin Levon, 20 Jul 2001
4330 \begin_layout Subsection*
4334 \begin_layout Description
4335 Action Undoes the last edit.
4338 \begin_layout Description
4342 \begin_layout Subsection*
4346 \begin_layout Description
4347 Action Inserts a single unicode character.
4350 \begin_layout Description
4351 Syntax unicode-insert <CHAR>
4354 \begin_layout Description
4355 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
4358 \begin_layout Description
4359 Sample unicode-insert 0x0100
4362 \begin_layout Description
4363 Origin Lgb, 22 Oct 2006
4366 \begin_layout Subsection*
4370 \begin_layout Description
4371 Action Moves the cursor one line in upward direction.
4374 \begin_layout Description
4378 \begin_layout Subsection*
4382 \begin_layout Description
4383 Action Moves the cursor one line in upward direction adding the current
4384 position to the selection.
4387 \begin_layout Description
4391 \begin_layout Subsection*
4395 \begin_layout Description
4396 Action Moves the cursor to the logically previous beginning of a word.
4399 \begin_layout Description
4400 Notion This is not the action which should be bound to the arrow keys, because
4401 backwards may be left or right, depending on the language.
4402 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
4403 which in turn may employ this one.
4406 \begin_layout Description
4407 Syntax word-backward
4410 \begin_layout Subsection*
4411 word-backward-select
4414 \begin_layout Description
4415 Action Moves the cursor to the logically previous beginning of a word, adding
4416 the logically traversed text to the selection.
4419 \begin_layout Description
4420 Notion See also LFUN_WORD_BACKWARD.
4423 \begin_layout Description
4424 Syntax word-backward-select
4427 \begin_layout Subsection*
4431 \begin_layout Description
4432 Action Capitalizes the words in the selection (i.e.
4433 the first letters) or the first letter of word at cursor position.
4436 \begin_layout Description
4437 Syntax word-capitalize [<SEL_TYPE>]
4440 \begin_layout Description
4441 Params <SEL_TYPE>: if this is equal to "partial", then the default word
4442 starts at cursor position (emacs-style).
4443 Otherwise, the whole word is considered.
4446 \begin_layout Subsection*
4447 word-delete-backward
4450 \begin_layout Description
4451 Action Deletes characters to the beginning of the word (usually the "C+BackSpace
4455 \begin_layout Description
4456 Syntax word-delete-backward [force]
4459 \begin_layout Description
4460 Params force: Delete big insets, do not only select them.
4463 \begin_layout Subsection*
4467 \begin_layout Description
4468 Action Deletes characters to the end of the word (usually the "C+Delete"
4472 \begin_layout Description
4473 Syntax word-delete-forward [force]
4476 \begin_layout Description
4477 Params force: Delete big insets, do not only select them.
4480 \begin_layout Subsection*
4484 \begin_layout Description
4485 Action Search for next occurrence of a string.
4488 \begin_layout Description
4489 Syntax word-find [<DATA>]
4492 \begin_layout Description
4493 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
4494 If no parameter is given, search with last find-dialog data is used for
4499 \begin_layout Description
4500 Origin Andre, Jan 7 2004
4503 \begin_layout Subsection*
4507 \begin_layout Description
4508 Action Search for a given string in backward direction.
4511 \begin_layout Description
4512 Notion Case sensitive, match words.
4513 If no argument given, last search repeated.
4516 \begin_layout Description
4517 Syntax word-find-backward [<STRING>]
4520 \begin_layout Description
4521 Origin Etienne, 20 Feb 1998
4524 \begin_layout Subsection*
4528 \begin_layout Description
4529 Action Search for a given string in forward direction.
4532 \begin_layout Description
4533 Notion Case sensitive, match words.
4534 If no argument given, last search repeated.
4537 \begin_layout Description
4538 Syntax word-find-forward [<STRING>]
4541 \begin_layout Description
4542 Origin Etienne, 16 Feb 1998
4545 \begin_layout Subsection*
4549 \begin_layout Description
4550 Action Search for next occurrence of a pattern.
4553 \begin_layout Description
4554 Syntax word-findadv [<DATA>]
4557 \begin_layout Description
4558 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
4559 If no parameter is given, search with last find-dialog data is used for
4564 \begin_layout Description
4565 Origin Tommaso, Nov 15 2007
4568 \begin_layout Subsection*
4572 \begin_layout Description
4573 Action Moves the cursor to the logically next beginning of a word.
4576 \begin_layout Description
4577 Notion This is not the action which should be bound to the arrow keys, because
4578 forward may be left or right, depending on the language.
4579 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
4580 which in turn may employ this one.
4583 \begin_layout Description
4587 \begin_layout Subsection*
4591 \begin_layout Description
4592 Action Moves the cursor to the logically next beginning of a word, adding
4593 the logically traversed text to the selection.
4596 \begin_layout Description
4597 Notion See also LFUN_WORD_FORWARD.
4600 \begin_layout Description
4601 Syntax word-forward-select
4604 \begin_layout Subsection*
4608 \begin_layout Description
4609 Action Moves the cursor to the next beginning of a word "on the left".
4612 \begin_layout Description
4613 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
4615 Generally, it moves the cursor to the next beginning of a word on the left.
4616 However, in Bidi text this become slightly more complicated, and there
4617 are different modes of cursor movement.
4618 In "visual mode", this moves left, plain and simple.
4619 In "logical mode", movement is logically forward in RTL paragraphs, and
4620 logically backwards in LTR paragraphs.
4623 \begin_layout Description
4627 \begin_layout Description
4628 Origin dov, 28 Oct 2007
4631 \begin_layout Subsection*
4635 \begin_layout Description
4636 Action Moves the cursor to the next beginning of a word "on the left", adding
4637 *logically* traversed text to the selection.
4640 \begin_layout Description
4641 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4644 \begin_layout Description
4645 Syntax word-left-select
4648 \begin_layout Description
4649 Origin dov, 28 Oct 2007
4652 \begin_layout Subsection*
4656 \begin_layout Description
4657 Action Change the words in the selection or word at cursor position to lower
4661 \begin_layout Description
4662 Syntax word-lowcase [<SEL_TYPE>]
4665 \begin_layout Description
4666 Params <SEL_TYPE>: if this is equal to "partial", then the default word
4667 starts at cursor position (emacs-style).
4668 Otherwise, the whole word is considered.
4671 \begin_layout Subsection*
4675 \begin_layout Description
4676 Action Replace a string in the document.
4679 \begin_layout Description
4680 Syntax word-replace [<DATA>]
4683 \begin_layout Description
4684 Params <DATA>: data is of the form "<replace>
4685 \begin_inset Newline newline
4689 \begin_inset Newline newline
4692 <casesensitive> <matchword> <all> <forward> <findnext>"
4695 \begin_layout Description
4696 Origin Andre, Jan 7 2004
4699 \begin_layout Subsection*
4703 \begin_layout Description
4704 Action Moves the cursor to the next beginning of a word "on the right".
4707 \begin_layout Description
4708 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
4710 Generally, it moves the cursor to the next beginning of a word on the right.
4711 However, in Bidi text this become slightly more complicated, and there
4712 are different modes of cursor movement.
4713 In "visual mode", this moves right, plain and simple.
4714 In "logical mode", movement is logically forward in LTR paragraphs, and
4715 logically backwards in RTL paragraphs.
4718 \begin_layout Description
4722 \begin_layout Description
4723 Origin dov, 28 Oct 2007
4726 \begin_layout Subsection*
4730 \begin_layout Description
4731 Action Moves the cursor to the next beginning of a word "on the right",
4732 adding *logically* traversed text to the selection.
4735 \begin_layout Description
4736 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4739 \begin_layout Description
4740 Syntax word-right-select
4743 \begin_layout Description
4744 Origin dov, 28 Oct 2007
4747 \begin_layout Subsection*
4751 \begin_layout Description
4752 Action Puts the word where the cursor stands into the selection.
4755 \begin_layout Description
4759 \begin_layout Description
4760 Origin Andre, 11 Sep 2002
4763 \begin_layout Subsection*
4767 \begin_layout Description
4768 Action Change the words in the selection or word at cursor position to upper
4772 \begin_layout Description
4773 Syntax word-upcase [<SEL_TYPE>]
4776 \begin_layout Description
4777 Params <SEL_TYPE>: if this is equal to "partial", then the default word
4778 starts at cursor position (emacs-style).
4779 Otherwise, the whole word is considered.
4782 \begin_layout Subsection*
4786 \begin_layout Description
4787 Action Inserts floats wrapped by the text around.
4790 \begin_layout Description
4791 Syntax wrap-insert <TYPE>
4794 \begin_layout Description
4795 Params <TYPE>: table|figure
4798 \begin_layout Description
4799 Origin Dekel, 7 Apr 2002
4802 \begin_layout Section
4803 Math Editor Functions
4806 \begin_layout Subsection*
4807 in-mathmacrotemplate
4810 \begin_layout Description
4811 Action Only active in Math Macro definition.
4814 \begin_layout Description
4815 Notion Dummy function which is only active in a Math Macro definition.
4816 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
4820 \begin_layout Description
4821 Syntax in-mathmacrotemplate
4824 \begin_layout Description
4825 Origin sts, 06 January 2008
4828 \begin_layout Subsection*
4832 \begin_layout Description
4833 Action Inserts an extended matrix as provided by the amsmath package.
4836 \begin_layout Description
4837 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4840 \begin_layout Description
4841 Params <DECORATION>: Decoration determines the LaTeX name of the matrix
4842 that should be created.
4843 Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and
4845 The default is 'matrix'.
4848 \begin_layout Description
4849 Sample math-ams-matrix 3 3 bmatrix
4852 \begin_layout Subsection*
4856 \begin_layout Description
4857 Action Inserts math fixed size delimiters (e.g.
4858 parentheses, brackets) enclosing expression.
4861 \begin_layout Description
4862 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4865 \begin_layout Description
4866 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4867 \begin_inset Newline newline
4870 <L/RDELIM>: TeX code for delimiter.
4871 See Delimiter dialog for delimiters to be used.
4874 \begin_layout Description
4875 Sample math-bigdelim "Bigl" "
4882 \begin_layout Description
4883 Origin Enrico & Georg, 7 May 2006
4886 \begin_layout Subsection*
4890 \begin_layout Description
4891 Action Inserts math delimiters (e.g.
4892 parentheses, brackets) enclosing expression.
4895 \begin_layout Description
4896 Syntax math-delim [<LEFT>] [<RIGHT>]
4899 \begin_layout Description
4900 Params <LEFT/RIGHT>: Delimiters to be used.
4901 Each delimiter can be specified by either a LaTeX name or a valid character.
4902 ( is the default letter.
4905 \begin_layout Description
4906 Sample math-delim { rangle
4909 \begin_layout Description
4910 Origin Alejandro, 18 Jun 1996
4913 \begin_layout Subsection*
4917 \begin_layout Description
4918 Action Creates a new displayed equation in text mode.
4919 Toggles inlined/display formula in math mode.
4922 \begin_layout Description
4923 Syntax math-display [<ARG>]
4926 \begin_layout Description
4927 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
4928 new equation from the text mode.
4931 \begin_layout Description
4932 Origin Alejandro, 18 Jun 1996
4935 \begin_layout Subsection*
4939 \begin_layout Description
4940 Action Calls external program and passes the current expression/equation
4941 as an argument for the calculation in the format appropriate to the given
4945 \begin_layout Description
4946 Notion Selection can be used to determine the input for the external program.
4949 \begin_layout Description
4950 Syntax math-extern <LANG> [<COMMAND>]
4953 \begin_layout Description
4954 Params <LANG>: octave|maxima|maple|mathematica|script
4955 \begin_inset Newline newline
4958 where "script" stands for the external script (normalized expression will
4962 \begin_layout Description
4963 Sample math-extern maple simplify
4966 \begin_layout Description
4967 Origin Andre, 24 Apr 2001
4970 \begin_layout Subsection*
4974 \begin_layout Description
4975 Action Changes the text style used in math.
4978 \begin_layout Description
4979 Syntax math-font-style <STYLE>
4982 \begin_layout Description
4983 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4984 \begin_inset Newline newline
4987 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4990 \begin_layout Description
4991 Origin vfr, 9 jan 2009
4994 \begin_layout Subsection*
4998 \begin_layout Description
4999 Action Inserts math objects and symbols.
5002 \begin_layout Description
5003 Notion When <ARG> is a _single_ math inset with more than one cell (such
5006 frac{x}{y}"), the content of cell(0) is replaced by the current selection
5007 (only works if the selection is in mathed).
5008 As an example, if "abc" is selected in mathed, "math-insert
5010 frac{x}{y}" replaces "abc" with "
5012 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
5013 If nothing is selected (or the selection is not in mathed), math-insert
5017 \begin_layout Description
5018 Syntax math-insert <ARG>
5021 \begin_layout Description
5022 Params <ARG>: Symbol or LaTeX code to be inserted.
5025 \begin_layout Subsection*
5029 \begin_layout Description
5030 Action Toggles the position of the limits from above/below to the right
5031 side an vice versa in integral symbol, a limit, a summation, etc.
5034 \begin_layout Description
5035 Notion Put the cursor before the symbol with the limits and then invoke
5039 \begin_layout Description
5040 Syntax math-limits [<STATE>]
5043 \begin_layout Description
5044 Params <STATE>: limits|nolimits
5047 \begin_layout Subsection*
5051 \begin_layout Description
5052 Action Inserts a math macro definition at the cursor position in the text.
5055 \begin_layout Description
5056 Syntax math-macro <NAME> [<NARGS>] [def]
5059 \begin_layout Description
5060 Params <NAME>: The name of the macro, e.g.
5062 \begin_inset Newline newline
5065 <NARGS>: The number of parameters of the macro.
5067 "def": Has no effect anymore, just for compatibility with former LyX versions.
5070 \begin_layout Description
5071 Origin ale, 10 May 1997; sts, 21 Dec 2007
5074 \begin_layout Subsection*
5075 math-macro-add-greedy-optional-param
5078 \begin_layout Description
5079 Action Add a greedy optional parameter.
5082 \begin_layout Description
5083 Notion Add a greedy optional parameter which eats the value from the following
5084 cells in mathed which are in the [value] format.
5087 \begin_layout Description
5088 Syntax math-macro-add-greedy-optional-param
5091 \begin_layout Description
5092 Origin sts, 06 January 2008
5095 \begin_layout Subsection*
5096 math-macro-add-optional-param
5099 \begin_layout Description
5100 Action Add an optional parameter.
5103 \begin_layout Description
5104 Notion Insert an optional parameter just behind the already existing optional
5108 \begin_layout Description
5109 Syntax math-macro-add-optional-param
5112 \begin_layout Description
5113 Origin sts, 06 January 2008
5116 \begin_layout Subsection*
5117 math-macro-add-param
5120 \begin_layout Description
5121 Action Add a parameter.
5124 \begin_layout Description
5125 Notion Add a parameter to a Math Macro.
5128 \begin_layout Description
5129 Syntax math-macro-add-param <NUM>
5132 \begin_layout Description
5133 Params <NUM>: The number of the parameter behind which the new one will
5134 be added (1 for the first, i.e.
5135 use 0 for add a parameter at the left), defaults to the last one.
5138 \begin_layout Description
5139 Origin sts, 06 January 2008
5142 \begin_layout Subsection*
5143 math-macro-append-greedy-param
5146 \begin_layout Description
5147 Action Append a greedy parameter.
5150 \begin_layout Description
5151 Notion Append a greedy parameter to a Math Macro which eats the following
5152 mathed cell in every instance of the macro in the buffer.
5155 \begin_layout Description
5156 Syntax math-macro-append-greedy-param
5159 \begin_layout Description
5160 Origin sts, 06 January 2008
5163 \begin_layout Subsection*
5167 \begin_layout Description
5168 Action Fold a Math Macro.
5171 \begin_layout Description
5172 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
5178 \begin_layout Description
5179 Syntax math-macro-fold
5182 \begin_layout Description
5183 Origin sts, 06 January 2008
5186 \begin_layout Subsection*
5187 math-macro-make-nonoptional
5190 \begin_layout Description
5191 Action Make a parameter non-optional.
5194 \begin_layout Description
5195 Notion Turn the last optional parameter of a Math Macro into a non-optional
5197 The default value is remembered to be reused later if the user changes
5201 \begin_layout Description
5202 Syntax math-macro-make-nonoptional
5205 \begin_layout Description
5206 Origin sts, 06 January 2008
5209 \begin_layout Subsection*
5210 math-macro-make-optional
5213 \begin_layout Description
5214 Action Make a parameter optional.
5217 \begin_layout Description
5218 Notion Turn the first non-optional parameter of a Math Macro into an optional
5219 parameter with a default value.
5222 \begin_layout Description
5223 Syntax math-macro-make-optional
5226 \begin_layout Description
5227 Origin sts, 06 January 2008
5230 \begin_layout Subsection*
5231 math-macro-remove-greedy-param
5234 \begin_layout Description
5235 Action Remove a greedy parameter.
5238 \begin_layout Description
5239 Notion Remove a greedy parameter of a Math Macro and spit out the values
5240 of it in every instance of the macro in the buffer.
5241 If it is an optional parameter the [valud] format is used.
5244 \begin_layout Description
5245 Syntax math-macro-remove-greedy-param
5248 \begin_layout Description
5249 Origin sts, 06 January 2008
5252 \begin_layout Subsection*
5253 math-macro-remove-optional-param
5256 \begin_layout Description
5257 Action Remove the last optional parameter.
5260 \begin_layout Description
5261 Notion Remove the last optional parameter of a Math Macro and remove it
5262 in all the instances of the macro in the buffer.
5265 \begin_layout Description
5266 Syntax math-macro-remove-optional-param
5269 \begin_layout Description
5270 Origin sts, 06 January 2008
5273 \begin_layout Subsection*
5274 math-macro-remove-param
5277 \begin_layout Description
5278 Action Remove the last parameter.
5281 \begin_layout Description
5282 Notion Remove the last parameter of a Math Macro and remove its value in
5283 all instances of the macro in the buffer.
5286 \begin_layout Description
5287 Syntax math-macro-remove-param <NUM>
5290 \begin_layout Description
5291 Params <NUM>: The number of the parameter to be deleted (1 for the first),
5292 defaults to the last one.
5295 \begin_layout Description
5296 Origin sts, 06 January 2008
5299 \begin_layout Subsection*
5303 \begin_layout Description
5304 Action Unfold a Math Macro.
5307 \begin_layout Description
5308 Notion Unfold the Math Macro the cursor is in, i.e.
5314 \begin_layout Description
5315 Syntax math-macro-unfold
5318 \begin_layout Description
5319 Origin sts, 06 January 2008
5322 \begin_layout Subsection*
5326 \begin_layout Description
5327 Action Inserts a matrix.
5330 \begin_layout Description
5331 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5334 \begin_layout Description
5335 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
5337 1 char) and the horizontal alignments (l, c or r) (i.e.
5341 \begin_layout Description
5342 Sample math-matrix 3 3 bccc
5345 \begin_layout Subsection*
5349 \begin_layout Description
5350 Action In text mode enters math mode (i.e.
5351 puts math insets on the current cursor position), in math mode enters text
5352 mode inside math expression.
5355 \begin_layout Description
5356 Notion If there is some selected text, it puts the text inside created math
5360 \begin_layout Description
5361 Syntax math-mode [on|<ARG>]
5364 \begin_layout Description
5365 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
5367 \begin_inset Newline newline
5370 "on": allow only entering of math mode from text mode.
5373 \begin_layout Description
5374 Origin Alejandro, 4 Jun 1996
5377 \begin_layout Subsection*
5381 \begin_layout Description
5382 Action Mutates the type of math inset to the newly selected one.
5385 \begin_layout Description
5386 Syntax math-mutate <TYPE>
5389 \begin_layout Description
5390 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
5391 multline|gather|flalign
5394 \begin_layout Description
5395 Origin Andre, 23 May 2001
5398 \begin_layout Subsection*
5399 math-number-line-toggle
5402 \begin_layout Description
5403 Action Toggles numbering of the current formula line.
5406 \begin_layout Description
5407 Notion Must be in display formula mode.
5410 \begin_layout Description
5411 Syntax math-number-line-toggle
5414 \begin_layout Description
5415 Origin Alejandro, 18 Jun 1996
5418 \begin_layout Subsection*
5422 \begin_layout Description
5423 Action Toggles numbering/labeling of the current formula.
5426 \begin_layout Description
5427 Notion Must be in display formula mode.
5430 \begin_layout Description
5431 Syntax math-number-toggle
5434 \begin_layout Description
5435 Origin Alejandro, 4 Jun 1996
5438 \begin_layout Subsection*
5442 \begin_layout Description
5443 Action Changes arbitrarily the size used by math fonts inside a context.
5446 \begin_layout Description
5447 Notion Provides an interface to the LaTeX math mode font size commands.
5450 \begin_layout Description
5451 Syntax math-size <STYLE>
5454 \begin_layout Description
5466 \begin_layout Description
5467 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5470 \begin_layout Subsection*
5474 \begin_layout Description
5475 Action Inserts space into math expression.
5478 \begin_layout Description
5479 Notion Use spacebar after entering this space to change type of space.
5482 \begin_layout Description
5483 Syntax math-space [<TYPE>] [<LEN>]
5486 \begin_layout Description
5487 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5488 \begin_inset Newline newline
5491 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5492 \begin_inset Newline newline
5495 custom space: hspace
5496 \begin_inset Newline newline
5499 "," used by default.
5500 \begin_inset Newline newline
5503 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
5505 \begin_inset Newline newline
5508 <LEN>: length for custom spaces (hspace)
5511 \begin_layout Description
5512 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5515 \begin_layout Subsection*
5519 \begin_layout Description
5520 Action Enters subscript expression in math expression.
5523 \begin_layout Description
5524 Syntax math-subscript
5527 \begin_layout Description
5528 Origin vermeer, 12 Dec 2001
5531 \begin_layout Subsection*
5535 \begin_layout Description
5536 Action Enters superscript expression in math expression.
5539 \begin_layout Description
5540 Syntax math-superscript
5543 \begin_layout Description
5544 Origin vermeer, 12 Dec 2001
5547 \begin_layout Subsection*
5551 \begin_layout Description
5552 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
5554 Used by the advanced search dialog.
5557 \begin_layout Description
5558 Notion If there is any selected text, then it is moved inside the created
5562 \begin_layout Description
5563 Syntax regexp-mode [<ARG>]
5566 \begin_layout Description
5567 Params <ARG>: eventual argument (regular expression).
5570 \begin_layout Description
5571 Origin Tommaso, 4 Oct 2008
5574 \begin_layout Section
5575 Buffer Fuctions (File and Window related)
5578 \begin_layout Subsection*
5582 \begin_layout Description
5583 Action Activate the branch.
5586 \begin_layout Description
5587 Syntax branch-activate <BRANCH>
5590 \begin_layout Description
5591 Params <BRANCH>: The branch to activate
5594 \begin_layout Description
5595 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5596 \begin_inset Newline newline
5599 could be used to export a pdf with the answers branch included without one's
5600 having to open LyX and activate the branch manually.
5603 \begin_layout Description
5604 Origin rgh, 27 May 2008
5607 \begin_layout Subsection*
5611 \begin_layout Description
5612 Action Add a branch to the buffer's BranchList.
5615 \begin_layout Description
5616 Syntax branch-add <BRANCH>
5619 \begin_layout Description
5620 Params <BRANCH>: Name of the branch to add
5623 \begin_layout Description
5624 Origin spitz, 7 Jul 2009
5627 \begin_layout Subsection*
5631 \begin_layout Description
5632 Action Create new branch and directly put the branch inset into the document.
5635 \begin_layout Description
5636 Syntax branch-add-insert [<NAME>]
5639 \begin_layout Description
5640 Params <NAME>: Branch name.
5641 If it is not specified, you will be asked.
5644 \begin_layout Description
5645 Origin sanda, 10 Jul 2009
5648 \begin_layout Subsection*
5652 \begin_layout Description
5653 Action De-activate the branch.
5656 \begin_layout Description
5657 Syntax branch-deactivate <BRANCH>
5660 \begin_layout Description
5661 Params <BRANCH>: The branch to deactivate
5664 \begin_layout Description
5665 Origin rgh, 27 May 2008
5668 \begin_layout Subsection*
5672 \begin_layout Description
5673 Action Toggles inversion status of branch inset.
5676 \begin_layout Description
5677 Syntax branch-invert
5680 \begin_layout Description
5681 Origin rgheck, 12 July 2016
5684 \begin_layout Subsection*
5685 branch-master-activate
5688 \begin_layout Description
5689 Action Activate the branch in the master buffer.
5692 \begin_layout Description
5693 Syntax branch-master-activate <BRANCH>
5696 \begin_layout Description
5697 Params <BRANCH>: The branch to activate
5700 \begin_layout Description
5701 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5702 \begin_inset Newline newline
5705 could be used to export a pdf with the answers branch included without one's
5706 having to open LyX and activate the branch manually.
5709 \begin_layout Description
5710 Origin spitz, 30 Sep 2012
5713 \begin_layout Subsection*
5714 branch-master-deactivate
5717 \begin_layout Description
5718 Action De-activate the branch in the master buffer.
5721 \begin_layout Description
5722 Syntax branch-master-deactivate <BRANCH>
5725 \begin_layout Description
5726 Params <BRANCH>: The branch to deactivate
5729 \begin_layout Description
5730 Origin spitz, 30 Sep 2012
5733 \begin_layout Subsection*
5737 \begin_layout Description
5738 Action Rename all branches of a given name in a document.
5741 \begin_layout Description
5742 Syntax branches-rename <OLDNAME> <NEWNAME>
5745 \begin_layout Description
5746 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
5750 \begin_layout Description
5751 Origin spitz, 9 Jul 2009
5754 \begin_layout Subsection*
5758 \begin_layout Description
5759 Action Saves the current buffer to a temporary file.
5762 \begin_layout Description
5763 Notion Saves the current buffer to a file named "#filename#".
5764 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5767 \begin_layout Description
5768 Syntax buffer-auto-save
5771 \begin_layout Subsection*
5775 \begin_layout Description
5776 Action Loads the given child document.
5779 \begin_layout Description
5780 Notion The current document is treated as a parent.
5783 \begin_layout Description
5784 Syntax buffer-child-open <FILE>
5787 \begin_layout Description
5788 Params <FILE>: Filename of the child.
5789 The directory of the parent is assumed by default.
5792 \begin_layout Description
5793 Origin Ale, 28 May 1997
5796 \begin_layout Subsection*
5800 \begin_layout Description
5801 Action Runs chktex for the current document.
5804 \begin_layout Description
5805 Syntax buffer-chktex
5808 \begin_layout Description
5809 Origin Asger, 30 Oct 1997
5812 \begin_layout Subsection*
5816 \begin_layout Description
5817 Action Closes the current buffer.
5820 \begin_layout Description
5821 Notion Closes the current buffer, asking whether to save it, etc, if the
5822 buffer has been modified.
5825 \begin_layout Description
5829 \begin_layout Subsection*
5833 \begin_layout Description
5834 Action Closes all buffers.
5837 \begin_layout Description
5838 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
5842 \begin_layout Description
5843 Syntax buffer-close-all
5846 \begin_layout Subsection*
5850 \begin_layout Description
5851 Action Exports the current buffer (document) to the given format.
5854 \begin_layout Description
5855 Syntax buffer-export [<FORMAT>] [<DEST>]
5858 \begin_layout Description
5859 Params <FORMAT> is either "custom" or one of the formats which you can find
5860 in Tools->Preferences->File formats->Format.
5861 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5862 for pdflatex) or "ps" for postscript.
5863 \begin_inset Newline newline
5866 In case of "custom" you will be asked for a format you want to start from
5867 and for the command that you want to apply to this format.
5868 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5869 \begin_inset Newline newline
5872 If absent or "default", then the default output format of the document is
5874 <DEST> If present, this argument provides the export destination filename.
5875 Its containing folder will also be the destination folder, where all
5876 the needed external files will be copied.
5879 \begin_layout Description
5880 Origin Lgb, 29 Jul 1997
5883 \begin_layout Subsection*
5887 \begin_layout Description
5888 Action Opens a dialog for exporting the current buffer.
5891 \begin_layout Description
5892 Syntax buffer-export-as [<FORMAT>]
5895 \begin_layout Description
5896 Params <FORMAT> is the export format initially selected in the dialog.
5897 You can pass any of the formats which you can find in Tools->Preferences->File
5898 formats->Format, provided it has the "document" flag set.
5899 If no format is specified the dialog will start with the default output
5900 format of the current document.
5903 \begin_layout Description
5904 Sample buffer-export-as pdf2
5907 \begin_layout Description
5908 Origin tommaso, 6 Oct 2011
5911 \begin_layout Subsection*
5912 buffer-export-custom
5915 \begin_layout Description
5916 Action Exports the current buffer (document) from the given format using
5917 the given command on it.
5920 \begin_layout Description
5921 Syntax buffer-export-custom <FORMAT> <COMMAND>
5924 \begin_layout Description
5925 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5927 \begin_inset Newline newline
5930 <COMMAND> this command will be launched on the file.
5931 Note that you can use "$$FName" string to qualify the intermediate file.
5934 \begin_layout Description
5935 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5938 \begin_layout Description
5939 Origin leeming, 27 Mar 2004
5942 \begin_layout Subsection*
5943 buffer-external-modification-clear
5946 \begin_layout Description
5947 Action Clear the external modification flag on the current buffer.
5950 \begin_layout Description
5951 Syntax buffer-external-modification-clear
5954 \begin_layout Description
5955 Origin gm, 2 March 2017
5958 \begin_layout Subsection*
5962 \begin_layout Description
5963 Action Applies a command to all non-hidden buffers.
5966 \begin_layout Description
5967 Notion a buffer is `hidden' if it is internally open in LyX, but not visible
5971 \begin_layout Description
5972 Syntax buffer-forall <LFUN-COMMAND>
5975 \begin_layout Description
5976 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5979 \begin_layout Description
5980 Sample Close all Notes in buffers:
5981 \begin_inset Newline newline
5984 buffer-forall inset-forall Note inset-toggle close
5985 \begin_inset Newline newline
5988 Toggle change tracking on buffers:
5989 \begin_inset Newline newline
5992 buffer-forall changes-track
5993 \begin_inset Newline newline
5996 Toggle read-only for buffers:
5997 \begin_inset Newline newline
6000 buffer-forall buffer-toggle-read-only
6001 \begin_inset Newline newline
6004 Show statistics for individual buffers:
6005 \begin_inset Newline newline
6008 buffer-forall statistics
6009 \begin_inset Newline newline
6012 Activate the branch named "Solutions" in buffers:
6013 \begin_inset Newline newline
6016 buffer-forall branch-activate Solutions
6017 \begin_inset Newline newline
6020 Export buffers to PDF (pdflatex):
6021 \begin_inset Newline newline
6024 buffer-forall buffer-export pdf2
6025 \begin_inset Newline newline
6031 \begin_layout Description
6032 Origin skostysh, 20 Jul 2012
6035 \begin_layout Subsection*
6039 \begin_layout Description
6040 Action Import a given file as a lyx document.
6043 \begin_layout Description
6044 Notion File can be imported iff lyx file format is (transitively) reachable
6045 via defined converters in preferences.
6046 Look in the File->Import menu to get an idea of the currently active import
6050 \begin_layout Description
6051 Syntax buffer-import <FORMAT> [<FILE>]
6054 \begin_layout Description
6055 Origin Asger, 24 Jul 1998
6058 \begin_layout Subsection*
6062 \begin_layout Description
6063 Action Set language of the current document.
6066 \begin_layout Description
6067 Syntax buffer-language <LANG>
6070 \begin_layout Description
6071 Params <LANG>: language name.
6072 See lib/languages for list.
6075 \begin_layout Description
6076 Origin leeming, 30 Mar 2004
6079 \begin_layout Subsection*
6083 \begin_layout Description
6084 Action Moves the current tab one spot to the right.
6087 \begin_layout Description
6088 Syntax buffer-move-next
6091 \begin_layout Description
6092 Origin skostysh, 7 Apr 2015
6095 \begin_layout Subsection*
6096 buffer-move-previous
6099 \begin_layout Description
6100 Action Moves the current tab one spot to the left.
6103 \begin_layout Description
6104 Syntax buffer-move-previous
6107 \begin_layout Description
6108 Origin skostysh, 7 Apr 2015
6111 \begin_layout Subsection*
6115 \begin_layout Description
6116 Action Creates a new buffer (that is, document) and switches to it.
6119 \begin_layout Description
6120 Notion Implicit path can be set in Preferences dialog.
6123 \begin_layout Description
6124 Syntax buffer-new [<FILE>]
6127 \begin_layout Description
6128 Params <FILE>: filename of created file with absolute path.
6131 \begin_layout Subsection*
6135 \begin_layout Description
6136 Action Creates a new buffer (that is, document) from a template.
6139 \begin_layout Description
6140 Notion Path for new files and templates can be set in Preferences dialog.
6141 Template will be asked for via Open-dialog.
6144 \begin_layout Description
6145 Syntax buffer-new-template [<FILE>]
6148 \begin_layout Description
6149 Params <FILE>: filename of created file with absolute path.
6152 \begin_layout Subsection*
6156 \begin_layout Description
6157 Action Switch to the next opened document.
6160 \begin_layout Description
6161 Notion Note that this does not necessarily mean next in tabbar (for full
6162 list see View menu).
6165 \begin_layout Description
6169 \begin_layout Subsection*
6173 \begin_layout Description
6174 Action Apply the given settings to the current document.
6177 \begin_layout Description
6178 Syntax buffer-params-apply [<ARGS>]
6181 \begin_layout Description
6182 Params <ARGS>: contains the particular settings to be saved.
6183 They obey the syntax you can find in document header of usual .lyx file.
6186 \begin_layout Description
6187 Origin leeming, 30 Mar 2004
6190 \begin_layout Subsection*
6194 \begin_layout Description
6195 Action Switch to the previous opened document.
6198 \begin_layout Description
6199 Syntax buffer-previous
6202 \begin_layout Subsection*
6206 \begin_layout Description
6207 Action Reverts opened document.
6210 \begin_layout Description
6211 Syntax buffer-reload
6214 \begin_layout Description
6215 Origin Asger, 2 Feb 1997
6218 \begin_layout Subsection*
6219 buffer-save-as-default
6222 \begin_layout Description
6223 Action Save the current document settings as default.
6226 \begin_layout Description
6227 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6230 \begin_layout Description
6231 Syntax buffer-save-as-default [<ARGS>]
6234 \begin_layout Description
6235 Params <ARGS>: contains the particular settings to be saved.
6236 They obey the syntax you can find in document header of usual .lyx file.
6239 \begin_layout Description
6240 Origin leeming, 30 Mar 2004
6243 \begin_layout Subsection*
6247 \begin_layout Description
6248 Action Display and switch to the given buffer.
6251 \begin_layout Description
6252 Syntax buffer-switch <BUFFER>
6255 \begin_layout Description
6256 Params <BUFFER>: path and filename of already opened (but possibly hidden)
6257 document which is to be shown.
6260 \begin_layout Subsection*
6261 buffer-toggle-compression
6264 \begin_layout Description
6265 Action Toggles compression of the current document on/off.
6268 \begin_layout Description
6269 Syntax buffer-toggle-compression
6272 \begin_layout Description
6273 Origin bpeng, 27 Apr 2006
6276 \begin_layout Subsection*
6277 buffer-toggle-read-only
6280 \begin_layout Description
6281 Action Toggle editing mode of the current document between read/write and
6285 \begin_layout Description
6286 Notion This function is not allowed if the file is under version control,
6287 since read-only flag is often used in version control file locking.
6290 \begin_layout Description
6291 Syntax buffer-toggle-read-only
6294 \begin_layout Description
6295 Origin Lgb, 27 May 1997
6298 \begin_layout Subsection*
6302 \begin_layout Description
6303 Action Exports the current document and put the result into the temporary
6307 \begin_layout Description
6308 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6309 EW) the output will be rewritten - updated.
6310 This is useful in case your viewer is able to detect such changes (e.g.
6311 ghostview for postscript).
6314 \begin_layout Description
6315 Syntax buffer-update [<FORMAT>]
6318 \begin_layout Description
6319 Params <FORMAT>: The format to display, where this is one of the formats
6320 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6321 If no format is given, the default format as specified in the same dialog
6325 \begin_layout Description
6326 Origin Dekel, 5 Aug 2000
6329 \begin_layout Subsection*
6333 \begin_layout Description
6334 Action Displays current buffer in chosen format.
6337 \begin_layout Description
6338 Notion Displays the contents of the current buffer in the chosen format,
6339 for example, PDF or DVI.
6340 This runs the necessary converter, calls the defined viewer, and so forth.
6343 \begin_layout Description
6344 Syntax buffer-view [<FORMAT>]
6347 \begin_layout Description
6348 Params <FORMAT>: The format to display, where this is one of the formats
6349 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6350 If no format is given, the default format as specified in the same dialog
6354 \begin_layout Subsection*
6358 \begin_layout Description
6359 Action Opens the file that was created from last preview of this buffer.
6362 \begin_layout Description
6363 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX
6365 It can also be called by the user, which is useful if the document takes
6366 a long time to compile, and you just want to see the last previewed version.
6369 \begin_layout Description
6370 Syntax buffer-view-cache
6373 \begin_layout Subsection*
6377 \begin_layout Description
6378 Action Saves the current buffer.
6381 \begin_layout Description
6382 Notion Saves the current buffer to disk, using the filename that is already
6383 associated with the buffer, asking for one if none is yet assigned.
6386 \begin_layout Description
6390 \begin_layout Subsection*
6394 \begin_layout Description
6395 Action Save all changed documents.
6398 \begin_layout Description
6399 Syntax buffer-write-all
6402 \begin_layout Description
6403 Origin rgh, gpothier 6 Aug 2007
6406 \begin_layout Subsection*
6410 \begin_layout Description
6411 Action Rename and save current buffer.
6414 \begin_layout Description
6415 Syntax buffer-write-as <FILENAME>
6418 \begin_layout Description
6419 Params <FILENAME>: New name of the buffer/file.
6420 A relative path is with respect to the original location of the buffer/file.
6423 \begin_layout Subsection*
6427 \begin_layout Description
6428 Action Sets the zoom of the screen fonts.
6431 \begin_layout Description
6432 Syntax buffer-zoom [<ZOOM>]
6435 \begin_layout Description
6436 Params <ZOOM>: The target zoom value in %; the default is the default zoom
6437 as saved in preferences.
6440 \begin_layout Description
6441 Origin daniel, 28 Oct 2016
6444 \begin_layout Subsection*
6448 \begin_layout Description
6449 Action Increases the zoom of the screen fonts.
6452 \begin_layout Description
6453 Syntax buffer-zoom-in [<ZOOM>]
6456 \begin_layout Description
6457 Params <ZOOM>: The zoom value addition in % (neg.
6458 or pos.); the default is 10% of the default zoom as saved in preferences.
6461 \begin_layout Description
6462 Origin vfr, 30 Mar 2009
6465 \begin_layout Subsection*
6469 \begin_layout Description
6470 Action Decreases the zoom of the screen fonts.
6473 \begin_layout Description
6474 Syntax buffer-zoom-out [<ZOOM>]
6477 \begin_layout Description
6478 Params <ZOOM>: The zoom value abstraction in % (neg.
6479 or pos.); the default is 10% of the default zoom as saved in preferences.
6482 \begin_layout Description
6483 Origin vfr, 30 Mar 2009
6486 \begin_layout Subsection*
6490 \begin_layout Description
6491 Action Generates the code (literate programming).
6494 \begin_layout Description
6495 Notion Latex file with extension
6497 literate_extension is generated.
6500 build_command (with a default of ``make'') to generate the code and
6502 build_error_filter to process the compilation error messages.
6503 \begin_inset Newline newline
6506 In case you want to process your literate file with a script, or some other
6507 program, just insert in your lyxrc file an entry with:
6508 \begin_inset Newline newline
6513 build_command "my_script my_arguments"
6514 \begin_inset Newline newline
6519 build_error_filter differs from the
6521 literate_error_filter only in that the former will identify error messages
6525 \begin_layout Description
6526 Syntax build-program
6529 \begin_layout Subsection*
6533 \begin_layout Description
6534 Action Open LyX document.
6537 \begin_layout Description
6538 Syntax file-open [<FILE>]
6541 \begin_layout Description
6542 Params <FILE>: Filename to be opened.
6545 \begin_layout Subsection*
6549 \begin_layout Description
6550 Action Open the given help file according to the language setting.
6553 \begin_layout Description
6554 Syntax help-open <FILE>[.lyx]
6557 \begin_layout Description
6558 Params <FILE>: any document from (/usr/share/)doc directory.
6561 \begin_layout Description
6562 Origin Jug, 27 Jun 1999
6565 \begin_layout Subsection*
6569 \begin_layout Description
6570 Action Sets icon size of toolbars.
6573 \begin_layout Description
6574 Syntax icon-size [<SIZE>]
6577 \begin_layout Description
6578 Params <SIZE> : the icon size in px or one of the logical settings small|normal|
6579 big|huge|giant, the default is normal (whose size in px is icon set dependent).
6582 \begin_layout Description
6586 \begin_layout Subsection*
6590 \begin_layout Description
6591 Action Terminates the current LyX instance.
6594 \begin_layout Description
6595 Notion Terminates the current LyX instance, asking whether to save modified
6599 \begin_layout Description
6603 \begin_layout Subsection*
6604 master-buffer-update
6607 \begin_layout Description
6608 Action Update (export) the document built from the master buffer, if the
6609 current buffer is part of a master/child document.
6612 \begin_layout Description
6613 Syntax master-buffer-update [<FORMAT>]
6616 \begin_layout Description
6617 Params <FORMAT>: The format to display, where this is one of the formats
6618 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6619 If no format is given, the default format as specified in the same dialog
6623 \begin_layout Description
6624 Origin Tommaso, 20 Sep 2007
6627 \begin_layout Subsection*
6631 \begin_layout Description
6632 Action Show a preview built from the master buffer, if available.
6633 if the current buffer is part of a master/child document.
6636 \begin_layout Description
6637 Syntax master-buffer-view [<FORMAT>]
6640 \begin_layout Description
6641 Params <FORMAT>: The format to display, where this is one of the formats
6642 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6643 If no format is given, the default format as specified in the same dialog
6647 \begin_layout Description
6648 Origin Tommaso, 20 Sep 2007
6651 \begin_layout Subsection*
6655 \begin_layout Description
6656 Action Opens the menu given by its name.
6659 \begin_layout Description
6660 Syntax menu-open <NAME>
6663 \begin_layout Description
6664 Params <NAME>: menu name.
6665 See various .inc files in lib/ui for candidates.
6668 \begin_layout Subsection*
6672 \begin_layout Description
6673 Action Close the current tab group.
6676 \begin_layout Description
6677 Notion This only closes the work areas, not the buffers themselves.
6678 The still opened buffers can be visualized in another tab group.
6681 \begin_layout Description
6682 Syntax tab-group-close
6685 \begin_layout Description
6686 Origin Abdel, 21 Feb 2008
6689 \begin_layout Subsection*
6693 \begin_layout Description
6694 Action Toggles movability of a given toolbar between true/false.
6697 \begin_layout Description
6698 Syntax toolbar-movable <NAME>
6701 \begin_layout Description
6702 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate|
6703 \begin_inset Newline newline
6706 minibuffer|review|view/update|math_panels|vcs| view-others|updat
6710 \begin_layout Description
6711 Origin daniel, 12 July 2016
6714 \begin_layout Subsection*
6718 \begin_layout Description
6719 Action Toggles visibility of a given toolbar between on/off/auto.
6722 \begin_layout Description
6723 Notion Skipping "auto" when allowauto is false.
6726 \begin_layout Description
6727 Syntax toolbar-toggle <NAME> [allowauto]
6730 \begin_layout Description
6731 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6732 \begin_inset Newline newline
6735 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6738 \begin_layout Description
6739 Origin Edwin, 21 May 2007
6742 \begin_layout Subsection*
6746 \begin_layout Description
6747 Action Various UI visibility-toggling actions.
6750 \begin_layout Description
6751 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6754 \begin_layout Description
6755 Params statusbar : Toggle visibility of the statusbar.
6756 \begin_inset Newline newline
6759 menubar : Toggle visibility of the menubar.
6760 \begin_inset Newline newline
6763 scrollbar : Toggle visibility of the scrollbar.
6764 \begin_inset Newline newline
6767 frame : Toggle visibility of the frames around editing window.
6768 \begin_inset Newline newline
6771 fullscreen : Toggle fullscreen mode.
6772 This also covers calling the previous functions.
6773 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
6777 \begin_layout Description
6778 Origin sanda, 9 Feb 2007
6781 \begin_layout Subsection*
6785 \begin_layout Description
6786 Action Close the current document work area.
6789 \begin_layout Description
6790 Notion Close the current work area.
6791 If no other work areas are showing the buffer, then close the associated
6795 \begin_layout Description
6799 \begin_layout Description
6800 Origin Tommaso, 15 Sep 2012
6803 \begin_layout Subsection*
6807 \begin_layout Description
6808 Action Creates another split view of current buffer.
6811 \begin_layout Description
6812 Notion All split views act in the same way independently.
6815 \begin_layout Description
6816 Syntax view-split <vertical|horizontal>
6819 \begin_layout Description
6820 Params horizontal : The work areas are laid out side by side.
6821 \begin_inset Newline newline
6824 vertical : The work areas laid out vertically.
6827 \begin_layout Description
6828 Origin Abdel, 20 Feb 2008
6831 \begin_layout Subsection*
6835 \begin_layout Description
6836 Action Closes the current LyX window.
6839 \begin_layout Description
6843 \begin_layout Description
6844 Origin Abdel, 23 Oct 2006
6847 \begin_layout Subsection*
6851 \begin_layout Description
6852 Action Creates new empty LyX window.
6855 \begin_layout Description
6856 Notion Already opened documents from the previous window can be found under
6860 \begin_layout Description
6861 Syntax window-new [<GEOMETRY>]
6864 \begin_layout Description
6865 Params <GEOMETRY>: pass the geometry of the window.
6866 This parameter is currently accepted only on Windows platform.
6869 \begin_layout Description
6870 Origin Abdel, 21 Oct 2006
6873 \begin_layout Section
6874 System Functions (Preferences, LyX Server etc.)
6877 \begin_layout Subsection*
6878 buffer-toggle-output-sync
6881 \begin_layout Description
6882 Action Toggles including of resources for forward/reverse search of the
6886 \begin_layout Description
6887 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
6889 Custom LaTeX macro can be defined in preferences.
6892 \begin_layout Description
6893 Syntax buffer-toggle-output-sync
6896 \begin_layout Description
6897 Origin sanda, 25 May 2010
6900 \begin_layout Subsection*
6904 \begin_layout Description
6905 Action Executes a command defined in a .def file.
6908 \begin_layout Description
6909 Notion The definitions are by default read from lib/commands/default.def.
6910 \begin_inset Newline newline
6913 A .def file allows to define a command with
6915 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6916 <LFUN> is the lfun code to be executed (see e.g.
6917 LFUN_COMMAND_SEQUENCE).
6920 def_file "FileName" allows to include another .def file.
6921 \begin_inset Newline newline
6924 This is particularly useful in connection with toolbar buttons: Since the
6925 name of the button image for this lfun is lib/images/commands/<NAME>.png
6926 this is the way to assign an image to a complex command-sequence.
6929 \begin_layout Description
6933 \begin_layout Description
6934 Params <NAME>: Name of the command that must be called.
6937 \begin_layout Description
6938 Origin broider, 2 Oct 2007
6941 \begin_layout Subsection*
6945 \begin_layout Description
6946 Action Cancels sequence prepared by LFUN_META_PREFIX .
6949 \begin_layout Description
6953 \begin_layout Subsection*
6954 command-alternatives
6957 \begin_layout Description
6958 Action Runs the first listed command that is enabled.
6961 \begin_layout Description
6962 Notion This can be used to bind multiple functions to a single key, and
6963 then which one is used will depend upon the context.
6966 \begin_layout Description
6967 Syntax command-alternatives <CMDS>
6970 \begin_layout Description
6971 Params <CMDS>: Sequence of commands separated by semicolons.
6974 \begin_layout Description
6975 Sample command-alternatives completion-accept;cell-forward
6978 \begin_layout Description
6979 Origin rgh, 24 September 2008
6982 \begin_layout Subsection*
6986 \begin_layout Description
6987 Action Run more commands (LFUN and its parameters) in a sequence.
6990 \begin_layout Description
6991 Syntax command-sequence <CMDS>
6994 \begin_layout Description
6995 Params <CMDS>: Sequence of commands separated by semicolons.
6998 \begin_layout Description
6999 Sample command-sequence cut; ert-insert; self-insert
7001 ; paste; self-insert {}; inset-toggle;
7004 \begin_layout Description
7005 Origin Andre, 11 Nov 1999
7008 \begin_layout Subsection*
7009 cursor-follows-scrollbar-toggle
7012 \begin_layout Description
7013 Action Determine whether to keep cursor inside the editing window regardless
7014 of the scrollbar movement.
7017 \begin_layout Description
7018 Syntax toggle-cursor-follows-scrollbar
7021 \begin_layout Description
7022 Origin ARRae, 2 Dec 1997
7025 \begin_layout Subsection*
7029 \begin_layout Description
7030 Action Set debug output level.
7033 \begin_layout Description
7034 Syntax debug-level-set <LEVEL>
7037 \begin_layout Description
7038 Params <LEVEL>: comma separated list of levels or the correspondent number
7039 of their combination.
7040 0 is equivalent to disabling all debug events.
7041 See lyx -dbg for the current list of debug levels and their numbers.
7044 \begin_layout Description
7045 Origin sanda, 28 Dec 2009
7048 \begin_layout Subsection*
7052 \begin_layout Description
7053 Action toggle a mode where more information is given in UI
7056 \begin_layout Description
7057 Notion in so called "devel" mode, the information given in the status bar
7058 is more precise, and the help documents are open in editing mode.
7061 \begin_layout Description
7062 Syntax devel-mode-toggle
7065 \begin_layout Description
7066 Origin lasgouttes, 23 Jul 2017
7069 \begin_layout Subsection*
7073 \begin_layout Description
7074 Action Sets the cursor position in the previewed (dvi/pdf) file based on
7075 the row number in LyX window.
7078 \begin_layout Description
7079 Notion The external program used for forward search call can be specified
7080 in LyX Output preferences.
7081 See Additional manual for details of these settings.
7084 \begin_layout Description
7085 Syntax forward-search
7088 \begin_layout Description
7089 Origin sanda, 14 Apr 2010
7092 \begin_layout Subsection*
7096 \begin_layout Description
7097 Action Apply the given settings to user preferences.
7100 \begin_layout Description
7101 Syntax lyxrc-apply <SETTINGS>
7104 \begin_layout Description
7105 Params <SETTINGS>: settings which are to be set.
7106 Take a look into ~/.lyx/preferences to get an idea which commands to use
7108 lyx::LyXRC::LyXRCTags has the list of possible commands.
7111 \begin_layout Subsection*
7115 \begin_layout Description
7116 Action Shows message in statusbar (for script purposes).
7119 \begin_layout Description
7120 Syntax message <STRING>
7123 \begin_layout Description
7124 Origin Lgb, 8 Apr 2001
7127 \begin_layout Subsection*
7131 \begin_layout Description
7132 Action Simulate halting Meta key (Alt key on PCs).
7135 \begin_layout Description
7136 Notion Used for buffer edition not for GUI control.
7139 \begin_layout Description
7143 \begin_layout Subsection*
7147 \begin_layout Description
7148 Action Save user preferences.
7151 \begin_layout Description
7152 Syntax preferences-save
7155 \begin_layout Description
7156 Origin Lgb, 27 Nov 1999
7159 \begin_layout Subsection*
7163 \begin_layout Description
7164 Action Reconfigure the automatic settings.
7167 \begin_layout Description
7171 \begin_layout Description
7172 Origin Asger, 14 Feb 1997
7175 \begin_layout Subsection*
7179 \begin_layout Description
7180 Action Returns path and file name of the currently edited document.
7183 \begin_layout Description
7184 Syntax server-get-filename
7187 \begin_layout Subsection*
7191 \begin_layout Description
7192 Action Returns the current layout (that is environment) name on the cursor
7196 \begin_layout Description
7197 Syntax server-get-layout
7200 \begin_layout Subsection*
7201 server-get-statistics
7204 \begin_layout Description
7205 Action Returns the statistics (number of words and characters) in the document
7206 or in the given selection.
7209 \begin_layout Description
7210 Notion Note that this function gives the number of words/chars written,
7211 not the number of characters which will be typeset.
7214 \begin_layout Description
7215 Syntax server-get-statistics [<TYPE>]
7218 \begin_layout Description
7219 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified,
7220 the three values are returned, separated by a space.
7221 \begin_inset Newline newline
7225 \begin_inset Newline newline
7228 chars: count characters.
7229 \begin_inset Newline newline
7232 chars-space: count characters and spaces.
7235 \begin_layout Description
7236 Origin brokenclock, Oct 10 2014
7239 \begin_layout Subsection*
7243 \begin_layout Description
7244 Action Returns the coordinates of cursor position in the editing area.
7247 \begin_layout Description
7248 Syntax server-get-xy
7251 \begin_layout Subsection*
7252 server-goto-file-row
7255 \begin_layout Description
7256 Action Sets the cursor position in LyX based on the row number of generated
7260 \begin_layout Description
7261 Notion This can be useful for DVI inverse-search or detection of the problematic
7262 line from LaTeX compilation.
7263 Note that before this function can be used export to LaTeX output must
7264 occur (in order to map the row numbers).
7267 \begin_layout Description
7268 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
7271 \begin_layout Description
7272 Params <FILE>: the path and filename.
7273 Environment variables are expanded in the path.
7274 In case this LFUN does not work make sure you are giving correct path to
7276 \begin_inset Newline newline
7279 If the file is located inside LyX temporary directory it will be mapped
7280 back into the appropriate opened buffer (e.g.
7281 for the case of generated .tex file).
7282 \begin_inset Newline newline
7285 .ext: extensions will be automatically replaced by .lyx.
7286 \begin_inset Newline newline
7289 <ROW_NUMBER> The row number of the LaTeX file to which to go.
7292 \begin_layout Description
7293 Sample server-goto-file-row /home/user/example.lyx 41
7294 \begin_inset Newline newline
7297 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
7300 \begin_layout Description
7301 Origin Edmar, 23 Dec 1998
7304 \begin_layout Subsection*
7308 \begin_layout Description
7309 Action Sends notify message about the last key-sequence to client.
7312 \begin_layout Description
7313 Notion This can be used to grab last key-sequence used inside the LyX window.
7314 See also Debug extensions section in Additional features manual.
7317 \begin_layout Description
7318 Syntax server-notify
7321 \begin_layout Subsection*
7325 \begin_layout Description
7326 Action Sets the cursor position based on the editing area coordinates (similar
7327 to clicking on that point with left mouse button).
7330 \begin_layout Description
7331 Syntax server-set-xy <X> <Y>
7334 \begin_layout Subsection*
7338 \begin_layout Description
7339 Action Set the given LyX color to the color defined by the X11 name given.
7342 \begin_layout Description
7343 Notion A new color entry is created if the color is unknown.
7344 Color names can be stored as a part of user settings.
7347 \begin_layout Description
7348 Syntax set-color <LYX_NAME> <X11_NAME>
7351 \begin_layout Description
7352 Origin SLior, 11 Jun 2000
7355 \begin_layout Subsection*
7359 \begin_layout Description
7360 Action Count the statistics (number of words and characters) in the document
7361 or in the given selection and display it in a dialog box.
7364 \begin_layout Description
7365 Notion Note that this function gives the number of words/chars written,
7366 not the number of characters which will be typeset.
7369 \begin_layout Description
7373 \begin_layout Description
7374 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7377 \begin_layout Subsection*
7381 \begin_layout Description
7382 Action Checks-in/commits the changes of the registered file to the repository.
7385 \begin_layout Description
7386 Notion In RCS case this also unlocks the file.
7389 \begin_layout Description
7393 \begin_layout Description
7394 Origin Lgb, 1 Jul 1997
7397 \begin_layout Subsection*
7401 \begin_layout Description
7402 Action Checks-out the document for edit (and locks it in some cases).
7405 \begin_layout Description
7409 \begin_layout Description
7410 Origin Lgb, 1 Jul 1997
7413 \begin_layout Subsection*
7417 \begin_layout Description
7418 Action Executes external command.
7419 This command is intended to support additional VCS commands.
7422 \begin_layout Description
7423 Syntax vc-command <FLAG> <PATH> <COMMAND>
7426 \begin_layout Description
7427 Params <FLAG>: Flags for the command can be combined together.
7428 \begin_inset Newline newline
7431 U - dUmmy - no flags
7432 \begin_inset Newline newline
7435 D - Doc - need document loaded to proceed
7436 \begin_inset Newline newline
7439 I - dIrty - mark document dirty
7440 \begin_inset Newline newline
7443 R - Reload - ensure that the document is saved and reload it after command
7445 \begin_inset Newline newline
7448 M - Message - ask for input string (commit message)
7449 \begin_inset Newline newline
7452 <PATH>: path where to start.
7453 $$p will be replaced by the current document path.
7454 \begin_inset Newline newline
7457 <COMMAND>: command to execute.
7458 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
7462 \begin_layout Description
7463 Sample vc-command DR $$p "svn up"
7466 \begin_layout Description
7467 Origin sanda, 13 Jan 2009
7470 \begin_layout Subsection*
7474 \begin_layout Description
7475 Action Compares two revisions of the same file under version control.
7478 \begin_layout Description
7479 Syntax vc-compare [<REV1>] [<REV2>]
7482 \begin_layout Description
7483 Params Revision number either points directly to commit in history or if
7484 negative number -x it points to (last commit - x).
7485 \begin_inset Newline newline
7488 In RCS we subtract only in the last number of revision specification.
7489 Special case "0" is reserved for the last committed revision.
7490 \begin_inset Newline newline
7494 \begin_inset Newline newline
7498 Used only if REV1 > 0.
7499 \begin_inset Newline newline
7502 If no parameter is given, interactive dialog will be shown.
7505 \begin_layout Description
7506 Sample Compare current document against last commit
7507 \begin_inset Newline newline
7511 \begin_inset Newline newline
7514 Compare current document against current revision - 5 commits
7515 \begin_inset Newline newline
7519 \begin_inset Newline newline
7522 Compare revisions 120 and 155
7523 \begin_inset Newline newline
7529 \begin_layout Description
7530 Origin sanda, 12 Feb 2010
7533 \begin_layout Subsection*
7537 \begin_layout Description
7538 Action Copies the document to another name.
7541 \begin_layout Description
7542 Notion Copying with revision history is only supported by SVN.
7543 For RCS and CVS it is simulated by adding the document under a new name.
7544 Disabled if uncommitted changes exist.
7547 \begin_layout Description
7548 Syntax vc-copy <FILENAME>
7551 \begin_layout Description
7552 Params <FILENAME>: New name of the document.
7553 \begin_inset Newline newline
7556 A file dialog is opened if no filename is given.
7559 \begin_layout Description
7560 Origin gb, 05 Feb 2013
7563 \begin_layout Subsection*
7567 \begin_layout Description
7568 Action Toggles the locking property of the edited file.
7571 \begin_layout Description
7572 Notion This is currently implemented only for SVN.
7575 \begin_layout Description
7576 Syntax vc-locking-toggle
7579 \begin_layout Description
7580 Origin sanda, 25 Jun 2009
7583 \begin_layout Subsection*
7587 \begin_layout Description
7588 Action Register the document as an file inside version control system.
7591 \begin_layout Description
7592 Notion File is registered inside cvs, svn or rcs repository acording to
7593 the existence of cvs/svn/rcs entries in the document's directory.
7594 \begin_inset Newline newline
7597 See LyX Additional Features Manual (Version Control Chapter) for additional
7601 \begin_layout Description
7605 \begin_layout Description
7606 Origin Lgb, 1 Jul 1997
7609 \begin_layout Subsection*
7613 \begin_layout Description
7614 Action Renames the document to another name.
7617 \begin_layout Description
7618 Notion Renaming with revision history is only supported by SVN.
7619 For CVS it is simulated by adding the document under a new name and deleting
7621 For RCS it is not supported.
7622 Disabled if uncommitted changes exist.
7625 \begin_layout Description
7626 Syntax vc-rename <FILENAME>
7629 \begin_layout Description
7630 Params <FILENAME>: New name of the document.
7631 \begin_inset Newline newline
7634 A file dialog is opened if no filename is given.
7637 \begin_layout Description
7638 Origin gb, 05 Feb 2013
7641 \begin_layout Subsection*
7645 \begin_layout Description
7646 Action Update the local archive directory in which resides the current document
7647 with the remote repository.
7650 \begin_layout Description
7651 Syntax vc-repo-update
7654 \begin_layout Description
7655 Origin sanda, 16 Oct 2009
7658 \begin_layout Subsection*
7662 \begin_layout Description
7663 Action Reverts the document to the last check-in/commit in VCS.
7666 \begin_layout Description
7670 \begin_layout Description
7671 Origin Lgb, 1 Jul 1997
7674 \begin_layout Subsection*
7678 \begin_layout Description
7679 Action Undo last check-in.
7682 \begin_layout Description
7683 Notion This is currently implemented only for RCS.
7686 \begin_layout Description
7690 \begin_layout Description
7691 Origin Lgb, 1 Jul 1997
7694 \begin_layout Section
7695 Hidden Functions (not listed for configuration)
7698 \begin_layout Subsection*
7702 \begin_layout Description
7703 Action Return the current key sequence and available options as a string.
7706 \begin_layout Description
7707 Notion No options are added if no current map exists.
7708 \begin_inset Newline newline
7711 This is probably usable only with connection to lyxserver.
7714 \begin_layout Description
7715 Syntax command-prefix
7718 \begin_layout Subsection*
7722 \begin_layout Description
7723 Action Activates the LyX window.
7726 \begin_layout Description
7727 Notion On Linux and Mac OS, this action brings the LyX window into focus.
7728 Such behavior is not allowed by Windows OS so instead the color of the
7729 taskbar entry is changed to indicate that the window has changed in some
7731 This action is useful in combination with reverse search.
7734 \begin_layout Description
7738 \begin_layout Description
7739 Origin skostysh, 4 Aug 2016
7742 \begin_layout Subsection*
7746 \begin_layout Description
7747 Action Inserts the given string (accordingly to the correct keymap).
7750 \begin_layout Description
7751 Notion Automatically replace the currently selected text.
7752 Depends on lyxrc settings "auto_region_delete".
7755 \begin_layout Description
7756 Syntax self-insert <STRING>