1 #LyX 2.4 created this file. For more info see https://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 no
27 \language_package default
28 \inputencoding auto-legacy
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
39 \font_typewriter_osf false
40 \font_sf_scale 100 100
41 \font_tt_scale 100 100
43 \use_dash_ligatures true
45 \default_output_format default
47 \bibtex_command default
48 \index_command default
49 \paperfontsize default
54 \use_package amsmath 1
55 \use_package amssymb 1
58 \use_package mathdots 0
59 \use_package mathtools 0
61 \use_package stackrel 0
62 \use_package stmaryrd 0
63 \use_package undertilde 0
65 \cite_engine_type default
69 \paperorientation portrait
85 \paragraph_separation indent
86 \paragraph_indentation default
88 \math_numbering_side default
93 \paperpagestyle default
95 \tracking_changes false
98 \postpone_fragile_content false
101 \html_be_strict false
102 \docbook_table_output 0
103 \docbook_mathml_prefix 1
118 \begin_layout Section*
122 \begin_layout Standard
123 This manual documents the
124 \begin_inset Quotes eld
128 \begin_inset Quotes erd
132 These are commands that are used to make \SpecialChar LyX
133 perform specific actions.
135 itself uses these functions internally, and every internal action is bound
139 \begin_layout Standard
140 LFUNs are also used in the files that define keyboard shortcuts, menu or
142 So if you want to change\SpecialChar breakableslash
143 customize the user interface, you need to deal
145 Furthermore, external programs can use LFUNs to communicate with and
146 \begin_inset Quotes eld
150 \begin_inset Quotes erd
155 Finally, you can also issue LFUNs directly via the so called mini-buffer
156 which can be opened via
159 arg "command-execute"
165 \begin_layout Standard
166 In the following, all LFUNs are listed, categorized by function.
169 \begin_layout Section
170 Layout Functions (Font, Layout and Textclass related)
173 \begin_layout Subsection*
177 \begin_layout Description
178 Action Displays list of layout choices.
181 \begin_layout Description
182 Notion This LFUN opens the dropbox allowing for choice of layout.
185 \begin_layout Description
186 Syntax drop-layouts-choice
189 \begin_layout Subsection*
193 \begin_layout Description
194 Action Splits the current environment with a Separator.
197 \begin_layout Description
198 Syntax environment-split [before|outer|previous]
201 \begin_layout Description
202 Params outer: If this is given, LyX will split the outermost environment
203 in the current nesting hierarchy.
204 \begin_inset Newline newline
207 previous: If this is given, LyX will split the environment in the previous
208 paragraph (if there is one).
209 \begin_inset Newline newline
212 before: If this is given, the new environment will be appended rather
216 \begin_layout Description
217 Origin spitz, 23 Dec 2012
220 \begin_layout Subsection*
224 \begin_layout Description
225 Action Toggles the bold font (selection-wise) using mathbf in math.
228 \begin_layout Description
232 \begin_layout Subsection*
236 \begin_layout Description
237 Action Toggles the bold font (selection-wise) using boldsymbol in math.
240 \begin_layout Description
241 Syntax font-boldsymbol
244 \begin_layout Subsection*
248 \begin_layout Description
249 Action Toggles xout (cross-through) in the font (selection-wise).
252 \begin_layout Description
256 \begin_layout Description
257 Origin uwestoehr, 4 April 2017
260 \begin_layout Subsection*
264 \begin_layout Description
265 Action Reverts the settings of the font to the default values (selection-wise).
268 \begin_layout Description
272 \begin_layout Subsection*
276 \begin_layout Description
277 Action Toggles the emphasis font style (selection-wise).
280 \begin_layout Description
284 \begin_layout Subsection*
288 \begin_layout Description
289 Action Toggles Fraktur family font (math-mode, selection-wise).
292 \begin_layout Description
296 \begin_layout Description
297 Origin vermeer, 10 Jan 2002
300 \begin_layout Subsection*
304 \begin_layout Description
305 Action Toggles Italics font shape (math-mode, selection-wise).
308 \begin_layout Description
312 \begin_layout Description
313 Origin vermeer, 10 Jan 2002
316 \begin_layout Subsection*
320 \begin_layout Description
321 Action Toggles nospellcheck status in the font (selection-wise).
324 \begin_layout Description
325 Syntax font-nospellcheck
328 \begin_layout Description
329 Origin spitz, 5 March 2021
332 \begin_layout Subsection*
336 \begin_layout Description
337 Action Toggles Noun text style font (selection-wise).
340 \begin_layout Description
344 \begin_layout Subsection*
348 \begin_layout Description
349 Action Toggles Roman family font (selection-wise).
352 \begin_layout Description
356 \begin_layout Subsection*
360 \begin_layout Description
361 Action Toggles Sans Serif family font (selection-wise).
364 \begin_layout Description
368 \begin_layout Subsection*
372 \begin_layout Description
373 Action Sets font size according to lyx format string.
376 \begin_layout Description
377 Syntax font-size <SIZE>
380 \begin_layout Description
381 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
382 \begin_inset Newline newline
385 largest|huge|giant|increase|decrease|default
388 \begin_layout Subsection*
392 \begin_layout Description
393 Action Returns the info about the current font.
396 \begin_layout Description
400 \begin_layout Subsection*
404 \begin_layout Description
405 Action Toggles strikeout (strike-through) in the font (selection-wise).
408 \begin_layout Description
409 Syntax font-strikeout
412 \begin_layout Description
413 Origin sanda, 3 May 2009
416 \begin_layout Subsection*
420 \begin_layout Description
421 Action Toggles the typewriter family font (selection-wise).
424 \begin_layout Description
425 Syntax font-typewriter
428 \begin_layout Subsection*
432 \begin_layout Description
433 Action Toggles underline in the font (selection-wise).
436 \begin_layout Description
437 Syntax font-underline
440 \begin_layout Subsection*
444 \begin_layout Description
445 Action Toggles double underline in the font (selection-wise).
448 \begin_layout Description
449 Syntax font-underunderline
452 \begin_layout Description
453 Origin sanda, 5 May 2009
456 \begin_layout Subsection*
460 \begin_layout Description
461 Action Toggles wavy underline in the font (selection-wise).
464 \begin_layout Description
465 Syntax font-underwave
468 \begin_layout Description
469 Origin sanda, 5 May 2009
472 \begin_layout Subsection*
476 \begin_layout Description
477 Action Sets the layout (that is, environment) for the current paragraph.
480 \begin_layout Description
481 Syntax layout <LAYOUT> [ignoreautonests]
484 \begin_layout Description
485 Params <LAYOUT>: the layout to use
486 \begin_inset Newline newline
489 ignoreautonests: If specified, nesting advices will be ignored.
492 \begin_layout Subsection*
496 \begin_layout Description
497 Action Adds a module.
500 \begin_layout Description
501 Notion Adds a module to the list of included modules for the current buffer.
504 \begin_layout Description
505 Syntax layout-module-add <MODULE>
508 \begin_layout Description
509 Params <MODULE>: the module to be added
512 \begin_layout Description
513 Origin rgh, 25 August 2007
516 \begin_layout Subsection*
520 \begin_layout Description
521 Action Clears the module list.
524 \begin_layout Description
525 Notion Clears the list of included modules for the current buffer.
528 \begin_layout Description
529 Syntax layout-modules-clear
532 \begin_layout Description
533 Origin rgh, 25 August 2007
536 \begin_layout Subsection*
540 \begin_layout Description
541 Action Launches the paragraph settings dialog.
544 \begin_layout Description
545 Syntax layout-paragraph
548 \begin_layout Subsection*
552 \begin_layout Description
553 Action Reloads layout information.
556 \begin_layout Description
557 Notion Reloads all layout information for the current buffer from disk,
558 thus recognizing any changes that have been made to layout files on the
560 This is intended to be used only by layout developers and should not be
561 used when one is trying to do actual work.
564 \begin_layout Description
568 \begin_layout Description
569 Origin rgh, 3 September 2007
572 \begin_layout Subsection*
576 \begin_layout Description
577 Action Launches the tabular settings dialog.
580 \begin_layout Description
581 Syntax layout-tabular
584 \begin_layout Description
585 Origin Jug, 31 Jul 2000
588 \begin_layout Subsection*
592 \begin_layout Description
593 Action Toggles the layout (that is, environment) for the current paragraph.
596 \begin_layout Description
597 Notion Contrary to `layout', this function resets the current (or selection)
598 layout to the standard layout it already has the correct layout.
599 Useful for toolbar icons.
602 \begin_layout Description
603 Syntax layout-toggle <LAYOUT> [ignoreautonests]
606 \begin_layout Description
607 Params <LAYOUT>: the layout to toggle
608 \begin_inset Newline newline
611 ignoreautonests: If specified, nesting advices will be ignored.
614 \begin_layout Description
615 Origin lasgouttes, 14 May 2018
618 \begin_layout Subsection*
622 \begin_layout Description
623 Action Update fonts and its metrics.
626 \begin_layout Description
627 Notion Automatically called after zoom, dpi, font names, or norm change.
630 \begin_layout Description
631 Syntax screen-font-update
634 \begin_layout Description
635 Origin ARRae, 13 Aug 2000
638 \begin_layout Subsection*
642 \begin_layout Description
643 Action Sets the text class for the current buffer.
646 \begin_layout Description
647 Syntax textclass-apply <TEXTCLASS>
650 \begin_layout Description
651 Params <TEXTCLASS>: the textclass to set.
652 Note that this must be the filename, minus the ".layout" extension.
655 \begin_layout Subsection*
659 \begin_layout Description
660 Action Loads information for a textclass from disk.
663 \begin_layout Description
664 Syntax textclass-load <TEXTCLASS>
667 \begin_layout Description
668 Params <TEXTCLASS>: the textclass to load.
669 Note that this must be the filename, minus the ".layout" extension.
672 \begin_layout Subsection*
676 \begin_layout Description
677 Action Apply last used text properties.
680 \begin_layout Description
681 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE, which is automatic
682 ally triggered when using Text Style dialog.
685 \begin_layout Description
686 Syntax textstyle-apply [<NUM>]textstyle-apply
689 \begin_layout Description
690 Params <NUM>: number of the selection in the internal freefonts stack to
694 \begin_layout Description
695 Origin leeming, 12 Mar 2003
698 \begin_layout Subsection*
702 \begin_layout Description
703 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
707 \begin_layout Description
708 Syntax textstyle-update <FONT_INFO>
711 \begin_layout Description
712 Params <FONT_INFO>: specifies font attributes, e.g.
713 family, series, shape, size, emph, noun, underbar, number, color, language,
715 \begin_inset Newline newline
718 Use lyx -dbg action for exact syntax of text-style dialog parameters.
721 \begin_layout Description
722 Origin leeming, 12 Mar 2003
725 \begin_layout Section
726 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
729 \begin_layout Subsection*
733 \begin_layout Description
734 Action Adds an acute accent to the next character typed.
737 \begin_layout Description
741 \begin_layout Subsection*
745 \begin_layout Description
746 Action Adds a breve accent to the next character typed.
749 \begin_layout Description
753 \begin_layout Subsection*
757 \begin_layout Description
758 Action Adds a caron to the next character typed.
761 \begin_layout Description
765 \begin_layout Subsection*
769 \begin_layout Description
770 Action Adds a cedilla to the next character typed.
773 \begin_layout Description
774 Syntax accent-cedilla
777 \begin_layout Subsection*
781 \begin_layout Description
782 Action Adds a circle accent to the next character typed.
785 \begin_layout Description
789 \begin_layout Subsection*
793 \begin_layout Description
794 Action Adds a circumflex to the next character typed.
797 \begin_layout Description
798 Syntax accent-circumflex
801 \begin_layout Subsection*
805 \begin_layout Description
806 Action Adds a dot accent to the next character typed.
809 \begin_layout Description
813 \begin_layout Subsection*
817 \begin_layout Description
818 Action Adds a grave accent to the next character typed.
821 \begin_layout Description
825 \begin_layout Subsection*
826 accent-hungarian-umlaut
829 \begin_layout Description
830 Action Adds a Hungarian umlaut to the next character typed.
833 \begin_layout Description
837 \begin_layout Subsection*
841 \begin_layout Description
842 Action Adds a macron to the next character typed.
845 \begin_layout Description
849 \begin_layout Subsection*
853 \begin_layout Description
854 Action Adds an ogonek accent to the next character typed.
857 \begin_layout Description
861 \begin_layout Subsection*
865 \begin_layout Description
866 Action Adds a perispomeni (Greek circumflex) over the next character typed.
869 \begin_layout Description
870 Syntax accent-perispomeni
873 \begin_layout Subsection*
877 \begin_layout Description
878 Action Adds a tie over the next two character typed.
881 \begin_layout Description
882 Notion The following char will finish the tie.
885 \begin_layout Description
889 \begin_layout Subsection*
893 \begin_layout Description
894 Action Adds a tilde over the next character typed.
897 \begin_layout Description
901 \begin_layout Subsection*
905 \begin_layout Description
906 Action Adds an umlaut over the next character typed.
909 \begin_layout Description
913 \begin_layout Subsection*
917 \begin_layout Description
918 Action Adds a bar under the next character typed.
921 \begin_layout Description
922 Syntax accent-underbar
925 \begin_layout Subsection*
929 \begin_layout Description
930 Action Adds a dot under the next character typed.
933 \begin_layout Description
934 Syntax accent-underdot
937 \begin_layout Subsection*
941 \begin_layout Description
942 Action Accepts all tracked changes in the document.
945 \begin_layout Description
946 Syntax all-changes-accept
949 \begin_layout Description
950 Origin Levon, 16 Oct 2002
953 \begin_layout Subsection*
957 \begin_layout Description
958 Action Rejects all tracked changes in the document.
961 \begin_layout Description
962 Notion Reject does not work recursively; the user may have to repeat the
966 \begin_layout Description
967 Syntax all-changes-reject
970 \begin_layout Description
971 Origin Levon, 16 Oct 2002
974 \begin_layout Subsection*
978 \begin_layout Description
979 Action Start (or remove) Appendix on the given cursor position.
982 \begin_layout Description
986 \begin_layout Description
987 Origin ettrich, 5 May 1998
990 \begin_layout Subsection*
994 \begin_layout Description
995 Action Inserts an argument (short title) inset.
998 \begin_layout Description
999 Syntax argument-insert <argument nr>
1002 \begin_layout Description
1003 Params <argument nr>: see layout declarations
1006 \begin_layout Description
1007 Origin vermeer, 12 Aug 2002
1010 \begin_layout Subsection*
1014 \begin_layout Description
1015 Action Adds database, which will be used for bibtex citations.
1018 \begin_layout Description
1019 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
1020 bibliography) found from the cursor position.
1023 \begin_layout Description
1024 Syntax bibtex-database-add <DATABASE-NAME>
1027 \begin_layout Description
1028 Origin Ale, 30 May 1997
1031 \begin_layout Subsection*
1035 \begin_layout Description
1036 Action Adds database, which will be used for bibtex citations.
1039 \begin_layout Description
1040 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
1041 X bibliography) found from the cursor position.
1044 \begin_layout Description
1045 Syntax bibtex-database-del <DATABASE-NAME>
1048 \begin_layout Description
1049 Origin Ale, 30 May 1997
1052 \begin_layout Subsection*
1056 \begin_layout Description
1057 Action Clears the list of saved bookmarks.
1060 \begin_layout Description
1061 Syntax bookmark-clear
1064 \begin_layout Description
1065 Origin bpeng, 31 October 2006
1068 \begin_layout Subsection*
1072 \begin_layout Description
1073 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
1074 Note that bookmarks are saved per-session, not per file.
1077 \begin_layout Description
1078 Notion Bookmark 0 has a special purpose.
1079 It is automatically set
1080 \begin_inset Newline newline
1084 to the paragraph you are currently editing
1085 \begin_inset Newline newline
1089 to the paragraph from where you are jumping to the last-edited position
1091 \begin_inset Newline newline
1095 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1098 \begin_layout Description
1099 Syntax bookmark-goto <NUMBER>
1102 \begin_layout Description
1103 Params <NUMBER>: the number of the bookmark to restore.
1106 \begin_layout Description
1107 Origin Dekel, 27 January 2001
1110 \begin_layout Subsection*
1114 \begin_layout Description
1115 Action Save a bookmark.
1118 \begin_layout Description
1119 Notion Saves a numbered bookmark to the sessions file.
1120 The number must be between 1 and 9, inclusive.
1121 Note that bookmarks are saved per-session, not per file.
1124 \begin_layout Description
1125 Syntax bookmark-save <NUMBER>
1128 \begin_layout Description
1129 Params <NUMBER>: the number of the bookmark to save.
1132 \begin_layout Description
1133 Origin Dekel, 27 January 2001
1136 \begin_layout Subsection*
1140 \begin_layout Description
1141 Action Inserts Box inset.
1144 \begin_layout Description
1145 Syntax box-insert [<TYPE>]
1148 \begin_layout Description
1149 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1150 \begin_inset Newline newline
1153 Framed is the default one.
1156 \begin_layout Description
1157 Origin vermeer, 7 Oct 2003
1160 \begin_layout Subsection*
1164 \begin_layout Description
1165 Action Inserts branch inset.
1168 \begin_layout Description
1169 Syntax branch-insert <BRANCH-NAME>
1172 \begin_layout Description
1173 Origin vermeer, 17 Aug 2003
1176 \begin_layout Subsection*
1180 \begin_layout Description
1181 Action For debug purposes only.
1182 Convert all [a-zA-Z0-1] characters to single character.
1183 Useful when submitting docs to list or bugzilla.
1186 \begin_layout Description
1187 Syntax buffer-anonymize
1190 \begin_layout Description
1191 Origin sanda, Feb 1 2018
1194 \begin_layout Subsection*
1198 \begin_layout Description
1199 Action Move the cursor to the beginning of the document.
1202 \begin_layout Description
1206 \begin_layout Subsection*
1210 \begin_layout Description
1211 Action Move the cursor to the beginning of the document adding the traversed
1212 text to the selection.
1215 \begin_layout Description
1216 Syntax buffer-begin-select
1219 \begin_layout Subsection*
1223 \begin_layout Description
1224 Action Move the cursor to the end of the document.
1227 \begin_layout Description
1231 \begin_layout Subsection*
1235 \begin_layout Description
1236 Action Move the cursor to the end of the document adding the traversed text
1240 \begin_layout Description
1241 Syntax buffer-end-select
1244 \begin_layout Subsection*
1248 \begin_layout Description
1249 Action Inserts a caption inset.
1252 \begin_layout Description
1253 Syntax caption-insert
1256 \begin_layout Description
1257 Origin Lgb, 18 Jul 2000
1260 \begin_layout Subsection*
1264 \begin_layout Description
1265 Action Moves the cursor to the previous cell inside the table.
1268 \begin_layout Description
1269 Syntax cell-backward
1272 \begin_layout Description
1273 Origin Jug, 22 May 2000
1276 \begin_layout Subsection*
1280 \begin_layout Description
1281 Action Moves the cursor to the next cell inside the table.
1284 \begin_layout Description
1288 \begin_layout Subsection*
1292 \begin_layout Description
1293 Action Splits cell and shifts right part to the next cell (inside the math
1297 \begin_layout Description
1301 \begin_layout Description
1302 Origin Ale, 15 May 1997
1305 \begin_layout Subsection*
1309 \begin_layout Description
1310 Action Accepts tracked change inside the selection.
1313 \begin_layout Description
1314 Syntax change-accept
1317 \begin_layout Description
1318 Origin Levon, 16 Oct 2002
1321 \begin_layout Subsection*
1325 \begin_layout Description
1326 Action Moves the cursor to the position of the next change of the change
1330 \begin_layout Description
1334 \begin_layout Description
1335 Origin schmitt, 4 Oct 2006
1338 \begin_layout Subsection*
1342 \begin_layout Description
1343 Action Moves the cursor to the position of the previous change of the change
1347 \begin_layout Description
1348 Syntax change-previous
1351 \begin_layout Description
1352 Origin vfr, 4 Apr 2009
1355 \begin_layout Subsection*
1359 \begin_layout Description
1360 Action Rejects tracked change inside the selection.
1363 \begin_layout Description
1364 Syntax change-reject
1367 \begin_layout Description
1368 Origin Levon, 16 Oct 2002
1371 \begin_layout Subsection*
1375 \begin_layout Description
1376 Action Open change tracking dialog for merging and moves the cursor to the
1377 position of the next change.
1380 \begin_layout Description
1381 Syntax changes-merge
1384 \begin_layout Description
1385 Origin Levon, 16 Oct 2002
1388 \begin_layout Subsection*
1392 \begin_layout Description
1393 Action Toggles showing of change tracking in typeset output.
1396 \begin_layout Description
1397 Syntax changes-output
1400 \begin_layout Description
1401 Origin spitz, 21 Jan 2005
1404 \begin_layout Subsection*
1408 \begin_layout Description
1409 Action Toggles change tracking to on/off.
1412 \begin_layout Description
1413 Syntax changes-track
1416 \begin_layout Description
1417 Origin levon, 1 Oct 2002
1420 \begin_layout Subsection*
1424 \begin_layout Description
1425 Action Moves the cursor one position logically backwards.
1428 \begin_layout Description
1429 Notion This is not the action which should be bound to the arrow keys, because
1430 backwards may be left or right, depending on the language.
1431 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1432 which in turn may employ this one.
1435 \begin_layout Description
1436 Syntax char-backward
1439 \begin_layout Subsection*
1440 char-backward-select
1443 \begin_layout Description
1444 Action Moves the cursor one position logically backwards, adding traversed
1445 position to the selection.
1448 \begin_layout Description
1449 Notion See also LFUN_CHAR_BACKWARD.
1452 \begin_layout Description
1453 Syntax char-backward-select
1456 \begin_layout Subsection*
1457 char-delete-backward
1460 \begin_layout Description
1461 Action Deletes one character in the backward direction (usually the "BackSpace"
1465 \begin_layout Description
1466 Syntax char-delete-backward [force]
1469 \begin_layout Description
1470 Params force: Delete big insets, do not only select them.
1473 \begin_layout Subsection*
1477 \begin_layout Description
1478 Action Deletes one character in the backward direction (usually the "Delete"
1482 \begin_layout Description
1483 Syntax char-delete-forward [force]
1486 \begin_layout Description
1487 Params force: Delete big insets, do not only select them.
1490 \begin_layout Subsection*
1494 \begin_layout Description
1495 Action Moves the cursor one position logically forward.
1498 \begin_layout Description
1499 Notion This is not the action which should be bound to the arrow keys, because
1500 forward may be left or right, depending on the language.
1501 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1502 which in turn may employ this one.
1505 \begin_layout Description
1509 \begin_layout Subsection*
1513 \begin_layout Description
1514 Action Moves the cursor one position logically forward, adding traversed
1515 position to the selection.
1518 \begin_layout Description
1519 Notion See also LFUN_CHAR_FORWARD.
1522 \begin_layout Description
1523 Syntax char-forward-select
1526 \begin_layout Subsection*
1530 \begin_layout Description
1531 Action Moves the cursor one position "to the left".
1534 \begin_layout Description
1535 Notion This is the action which should be taken when the "left" key is pressed.
1536 Generally, it moves the cursor one position to the left.
1537 However, in Bidi text this become slightly more complicated, and there
1538 are different modes of cursor movement.
1539 In "visual mode", this moves left, plain and simple.
1540 In "logical mode", movement is logically forward in RTL paragraphs, and
1541 logically backwards in LTR paragraphs.
1544 \begin_layout Description
1548 \begin_layout Subsection*
1552 \begin_layout Description
1553 Action Moves the cursor one position "to the left", adding traversed position
1557 \begin_layout Description
1558 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1561 \begin_layout Description
1562 Syntax char-left-select
1565 \begin_layout Subsection*
1569 \begin_layout Description
1570 Action Moves the cursor one position "to the right".
1573 \begin_layout Description
1574 Notion This is the action which should be taken when the "right" key is
1576 Generally, it moves the cursor one position to the right.
1577 However, in Bidi text this become slightly more complicated, and there
1578 are different modes of cursor movement.
1579 In "visual mode", this moves right, plain and simple.
1580 In "logical mode", movement is logically forward in LTR paragraphs, and
1581 logically backwards in RTL paragraphs.
1584 \begin_layout Description
1588 \begin_layout Subsection*
1592 \begin_layout Description
1593 Action Moves the cursor one position "to the right", adding traversed position
1597 \begin_layout Description
1598 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1601 \begin_layout Description
1602 Syntax char-right-select
1605 \begin_layout Subsection*
1609 \begin_layout Description
1610 Action Transposes the character at the cursor with the one before it.
1613 \begin_layout Description
1614 Syntax chars-transpose
1617 \begin_layout Description
1618 Origin Lgb, 25 Apr 2001
1621 \begin_layout Subsection*
1625 \begin_layout Description
1626 Action Inserts citation from loaded citation database.
1629 \begin_layout Description
1630 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1633 \begin_layout Description
1634 Params <KEY>: Citation (shortcut listed in available citations).
1635 \begin_inset Newline newline
1638 <TEXT_BEFORE>: text which should appear before citation.
1641 \begin_layout Description
1642 Origin AAS, 97-02-23
1645 \begin_layout Subsection*
1649 \begin_layout Description
1650 Action Opens the corresponding pdf/url for a given citation inset.
1653 \begin_layout Description
1654 Syntax citation-open [EXTERNAL] TARGET
1657 \begin_layout Description
1658 Params <TARGET>: URL (https:,file:) of the document.
1659 \begin_inset Newline newline
1662 <EXTERNAL>: Use external executable script for finding target
1663 \begin_inset Newline newline
1666 and launching viewer.
1667 In this case TARGET consists of author and year
1668 \begin_inset Newline newline
1671 and will be passed as an input argument to the script.
1674 \begin_layout Description
1675 Origin Sanda, 16 Aug 2020
1678 \begin_layout Subsection*
1682 \begin_layout Description
1683 Action Pastes text from the active clipboard (retains formatting if the
1684 clipboard contains formatted text).
1685 Pastes plain text if plain text is on the clipboard, but tries to interpret
1686 it in special ways for certain insets, e.g.
1687 converting csv data to rows and columns if the paste happens in a tabular
1691 \begin_layout Description
1692 Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart
1693 of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source
1694 is the clipboard, not the selection.
1697 \begin_layout Description
1698 Syntax clipboard-paste [<ARG>]
1701 \begin_layout Description
1702 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1706 \begin_layout Description
1707 Origin Georg, 10 Jul 2006
1710 \begin_layout Subsection*
1711 clipboard-paste-simple
1714 \begin_layout Description
1715 Action Pastes plain text from the active clipboard even if formatted LyX
1716 content is in the clipboard.
1717 Pastes plain text if plain text is on the clipboard, without trying to
1718 interpret it in special ways for certain insets, e.g.
1719 converting csv data to rows and columns if the paste happens in a tabular
1723 \begin_layout Description
1724 Syntax clipboard-paste-simple [<ARG>]
1727 \begin_layout Description
1728 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1732 \begin_layout Subsection*
1736 \begin_layout Description
1737 Action Switches the focus to the minibuffer so that the user can type in
1739 If necessary, it opens the minibuffer toolbar.
1742 \begin_layout Description
1743 Notion Usually bound to M-x shortcut.
1746 \begin_layout Description
1747 Syntax command-execute
1750 \begin_layout Subsection*
1754 \begin_layout Description
1755 Action Try to complete the word or command at the cursor position.
1758 \begin_layout Description
1762 \begin_layout Description
1763 Origin sts, Feb 19 2008
1766 \begin_layout Subsection*
1770 \begin_layout Description
1771 Action Accept suggested completion.
1774 \begin_layout Description
1775 Syntax completion-accept
1778 \begin_layout Description
1779 Origin sanda, Sep 08 2008
1782 \begin_layout Subsection*
1786 \begin_layout Description
1787 Action Try to cancel completion, either the popup or the inline completion.
1790 \begin_layout Description
1791 Syntax completion-cancel
1794 \begin_layout Description
1795 Origin sts, Sep 07 2008
1798 \begin_layout Subsection*
1802 \begin_layout Description
1803 Action Show the inline completion at the cursor position.
1806 \begin_layout Description
1807 Syntax completion-inline
1810 \begin_layout Description
1811 Origin sts, Feb 19 2008
1814 \begin_layout Subsection*
1818 \begin_layout Description
1819 Action Show the completion popup at the cursor position.
1822 \begin_layout Description
1823 Syntax completion-popup
1826 \begin_layout Description
1827 Origin sts, Feb 19 2008
1830 \begin_layout Subsection*
1834 \begin_layout Description
1835 Action Copies the current selection to the clipboard.
1838 \begin_layout Description
1842 \begin_layout Subsection*
1846 \begin_layout Description
1847 Action Cuts to the clipboard.
1850 \begin_layout Description
1854 \begin_layout Subsection*
1858 \begin_layout Description
1859 Action Decrease the nesting depth of the (selected) paragraph(s) inside
1863 \begin_layout Description
1864 Syntax depth-decrement
1867 \begin_layout Subsection*
1871 \begin_layout Description
1872 Action Increase the nesting depth of the (selected) paragraph(s) inside
1876 \begin_layout Description
1877 Syntax depth-increment
1880 \begin_layout Subsection*
1881 dialog-disconnect-inset
1884 \begin_layout Description
1885 Action Closes opened connection to opened inset.
1888 \begin_layout Description
1889 Notion Connection is used for apply functions.
1892 \begin_layout Description
1893 Syntax dialog-disconnect-inset <INSET-NAME>
1896 \begin_layout Description
1897 Origin leeming, 25 Feb 2003
1900 \begin_layout Subsection*
1904 \begin_layout Description
1905 Action Hides showed dialog.
1906 Counterpart to LFUN_DIALOG_SHOW .
1909 \begin_layout Description
1910 Syntax dialog-hide <NAME>
1913 \begin_layout Description
1914 Params See LFUN_DIALOG_SHOW .
1917 \begin_layout Description
1918 Origin leeming, 25 Feb 2003
1921 \begin_layout Subsection*
1925 \begin_layout Description
1926 Action Shows hidden dialog or creates new one for a given function/inset
1930 \begin_layout Description
1931 Syntax dialog-show <NAME> [<DATA>]
1934 \begin_layout Description
1935 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1936 \begin_inset Newline newline
1939 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|
1941 \begin_inset Newline newline
1944 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
1946 \begin_inset Newline newline
1949 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1950 \begin_inset Newline newline
1953 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1954 \begin_inset Newline newline
1957 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1958 \begin_inset Newline newline
1961 <SPECIAL>: latexlog|vclog
1962 \begin_inset Newline newline
1965 <DATA>: data, usually settings for the given dialog.
1966 Use debug mode for the details.
1969 \begin_layout Description
1970 Origin leeming, 17 Jun 2003
1973 \begin_layout Subsection*
1974 dialog-show-new-inset
1977 \begin_layout Description
1978 Action Shows hidden dialog or create new one for a given inset settings
1982 \begin_layout Description
1983 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
1987 \begin_layout Description
1988 Syntax dialog-show-new-inset <NAME> [<DATA>]
1991 \begin_layout Description
1992 Params See LFUN_DIALOG_SHOW .
1995 \begin_layout Description
1996 Origin leeming, 25 Feb 2003
1999 \begin_layout Subsection*
2003 \begin_layout Description
2004 Action Toggles dialog between showed/hidden state.
2007 \begin_layout Description
2008 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
2011 \begin_layout Description
2012 Syntax dialog-toggle <NAME> [<DATA>]
2015 \begin_layout Description
2016 Params See LFUN_DIALOG_SHOW .
2019 \begin_layout Description
2020 Origin spitz, 30 Apr 2007
2023 \begin_layout Subsection*
2027 \begin_layout Description
2028 Action Updates the dialog values from the inset/paragraph/document.
2031 \begin_layout Description
2032 Syntax dialog-update <NAME>
2035 \begin_layout Description
2036 Params <NAME>: paragraph|prefs|<INSET>
2037 \begin_inset Newline newline
2043 \begin_layout Description
2044 Origin leeming, 25 Feb 2003
2047 \begin_layout Subsection*
2051 \begin_layout Description
2052 Action Moves the cursor one line in downward direction.
2055 \begin_layout Description
2059 \begin_layout Subsection*
2063 \begin_layout Description
2064 Action Moves the cursor one line in downward direction adding the current
2065 position to the selection.
2068 \begin_layout Description
2072 \begin_layout Subsection*
2076 \begin_layout Description
2077 Action Inserts an ERT inset.
2080 \begin_layout Description
2084 \begin_layout Description
2085 Origin Jug, 18 Feb 2000
2088 \begin_layout Subsection*
2092 \begin_layout Description
2093 Action Clears the selection.
2094 If no text is selected call LFUN_FINISHED_FORWARD.
2095 Inside math mode jumps out of the math inset.
2098 \begin_layout Description
2102 \begin_layout Description
2103 Origin Lgb, 17 May 2001
2106 \begin_layout Subsection*
2110 \begin_layout Description
2111 Action Cancel background export process.
2114 \begin_layout Description
2115 Syntax export-cancel
2118 \begin_layout Description
2119 Origin rgh, 10 December 2017
2122 \begin_layout Subsection*
2126 \begin_layout Description
2127 Action Inserts another LyX file.
2130 \begin_layout Description
2131 Syntax file-insert [<FILE>] [ignorelang]
2134 \begin_layout Description
2135 Params <FILE>: Filename to be inserted.
2136 ignorelang: If given, the (main) language of the inserted file is ignored
2137 (the context language is used).
2140 \begin_layout Subsection*
2141 file-insert-plaintext
2144 \begin_layout Description
2145 Action Inserts plain text file.
2148 \begin_layout Description
2149 Syntax file-insert-plaintext [<FILE>]
2152 \begin_layout Description
2153 Params <FILE>: Filename to be inserted.
2156 \begin_layout Description
2157 Origin CFO-G, 19 Nov 1997
2160 \begin_layout Subsection*
2161 file-insert-plaintext-para
2164 \begin_layout Description
2165 Action Inserts plain text file as paragraph (i.e.
2169 \begin_layout Description
2170 Syntax file-insert-plaintext-para [<FILE>]
2173 \begin_layout Description
2174 Params <FILE>: Filename to be inserted.
2177 \begin_layout Description
2178 Origin Levon, 14 Feb 2001
2181 \begin_layout Subsection*
2185 \begin_layout Description
2186 Action Inserts CharStyle, Custom inset or XML short element.
2189 \begin_layout Description
2190 Notion Look into the Customization manual for more information about these
2192 \begin_inset Newline newline
2195 To make this command enabled the layout file for the document class you're
2196 using has to load the character styles.
2197 There are a few contained in the Logical Markup module.
2198 You can also of course create some yourself.
2199 \begin_inset Newline newline
2202 For dissolving the element see LFUN_INSET_DISSOLVE.
2205 \begin_layout Description
2206 Syntax flex-insert Name
2209 \begin_layout Description
2210 Params Name: This name must be defined either in your layout file or imported
2212 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
2213 The Flex: prefix is optional.
2216 \begin_layout Description
2217 Sample flex-insert Code
2220 \begin_layout Subsection*
2224 \begin_layout Description
2225 Action Inserts a float inset.
2228 \begin_layout Description
2229 Syntax float-insert <TYPE>
2232 \begin_layout Description
2233 Params <TYPE>: type of float depends on the used textclass.
2234 Usually "algorithm", "table", "figure" parameters can be given.
2237 \begin_layout Description
2238 Origin Lgb, 27 Jun 2000
2241 \begin_layout Subsection*
2245 \begin_layout Description
2246 Action Inserts the list of floats in the document.
2249 \begin_layout Description
2250 Syntax float-list-insert <TYPE>
2253 \begin_layout Description
2254 Params <TYPE>: type of float depends on the used textclass.
2255 Usually "algorithm", "table", "figure" parameters can be given.
2258 \begin_layout Description
2259 Origin Lgb, 3 May 2001
2262 \begin_layout Subsection*
2266 \begin_layout Description
2267 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2270 \begin_layout Description
2271 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2274 \begin_layout Description
2275 Syntax float-wide-insert <TYPE>
2278 \begin_layout Description
2279 Params <TYPE>: type of float depends on the used textclass.
2280 Usually "algorithm", "table", "figure" parameters can be given.
2283 \begin_layout Description
2284 Origin Lgb, 31 Oct 2001
2287 \begin_layout Subsection*
2291 \begin_layout Description
2292 Action Inserts a footnote inset.
2295 \begin_layout Description
2296 Syntax footnote-insert
2299 \begin_layout Description
2300 Origin Jug, 7 Mar 2000
2303 \begin_layout Subsection*
2307 \begin_layout Description
2308 Action Reloads the image if necessary.
2311 \begin_layout Description
2312 Syntax graphics-reload
2315 \begin_layout Description
2316 Origin vfr, 10 Aug 2009
2319 \begin_layout Subsection*
2323 \begin_layout Description
2324 Action Set the group for the graphics inset on the cursor position.
2327 \begin_layout Description
2328 Syntax graphics-set-group [<GROUP>]
2331 \begin_layout Description
2332 Params <GROUP>: Id for an existing group.
2333 In case the Id is an empty string, the graphics inset is removed from the
2337 \begin_layout Description
2338 Origin sanda, 6 May 2008
2341 \begin_layout Subsection*
2345 \begin_layout Description
2346 Action Set the same group for all graphics insets in the marked block.
2349 \begin_layout Description
2350 Syntax graphics-unify [<GROUP>]
2353 \begin_layout Description
2354 Params <GROUP>: Id for an existing group.
2355 In case the Id is an empty string, the group Id from the first graphics
2359 \begin_layout Description
2360 Origin sanda, 7 Feb 2018
2363 \begin_layout Subsection*
2367 \begin_layout Description
2368 Action Inserts hyperlinks into the document (clickable in pdf output).
2371 \begin_layout Description
2372 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2375 \begin_layout Description
2376 Syntax href-insert [<TARGET>]
2379 \begin_layout Description
2380 Origin CFO-G, 21 Nov 1997
2383 \begin_layout Subsection*
2387 \begin_layout Description
2388 Action Only active in IPA inset.
2391 \begin_layout Description
2392 Notion Dummy function which is only active in a IPA inset.
2393 It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2396 \begin_layout Description
2400 \begin_layout Description
2401 Origin spitz, 20 May 2012
2404 \begin_layout Subsection*
2408 \begin_layout Description
2409 Action Inserts Index entry.
2412 \begin_layout Description
2413 Notion It automatically takes the word on the cursor position.
2416 \begin_layout Description
2417 Syntax index-insert [<TYPE:Name>]
2420 \begin_layout Description
2421 Params <TYPE:Name>: name of the index, if multiple indices are defined.
2422 With an empty argument, the default index is selected.
2425 \begin_layout Description
2426 Origin leeming, 3 Aug 2000
2429 \begin_layout Subsection*
2433 \begin_layout Description
2434 Action Inserts list of Index entries on a new page.
2437 \begin_layout Description
2438 Syntax index-print [<TYPE:Name>]
2441 \begin_layout Description
2442 Params <TYPE:Name>: name of the index, if multiple indices are defined.
2443 With an empty argument, the default index is selected.
2446 \begin_layout Description
2447 Origin Lgb, 27 Feb 1997
2450 \begin_layout Subsection*
2454 \begin_layout Description
2455 Action Displays shortcuts, lyxrc, package and textclass availability and
2456 menu information in a non-editable boxed InsetText.
2459 \begin_layout Description
2460 Notion Apart from lfun arguments you can use the following method:
2461 \begin_inset Newline newline
2465 input the type and argument of this inset, e.g.
2466 "menu paste", in the work area.
2467 \begin_inset Newline newline
2471 select the text and run info-insert lfun.
2474 \begin_layout Description
2475 Syntax info-insert <TYPE> <ARG>
2478 \begin_layout Description
2479 Params <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxr
2480 c| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2481 \begin_inset Newline newline
2484 <ARG>: argument for a given type.
2485 Look into InsetInfo.h for detailed description.
2486 \begin_inset Newline newline
2489 date: current date (formatted and localized)
2490 \begin_inset Newline newline
2493 moddate: date of last modification (saving) (formatted and localized)
2494 \begin_inset Newline newline
2497 fixdate: a static date (formatted and localized)
2498 \begin_inset Newline newline
2501 time: current time (formatted and localized)
2502 \begin_inset Newline newline
2505 modtime: time of last modification (saving) (formatted and localized)
2506 \begin_inset Newline newline
2509 fixtime: a static time (formatted and localized)
2510 \begin_inset Newline newline
2513 shortcut[s]: name of lfun (e.g math-insert
2516 \begin_inset Newline newline
2519 lyxrc: name of rc_entry (e.g.
2521 \begin_inset Newline newline
2524 lyxinfo: "version" - used version of LyX
2525 \begin_inset Newline newline
2528 package: name of latex package (e.g.
2530 \begin_inset Newline newline
2533 textclass: name of textclass (e.g.
2535 \begin_inset Newline newline
2538 menu: name of lfun used in menu
2539 \begin_inset Newline newline
2542 l7n: localizable string.
2543 \begin_inset Newline newline
2546 icon: icon of lfun used in toolbar or direct icon name
2547 \begin_inset Newline newline
2550 buffer: "name"|"name-noext"|"path"|"class" vcs: "tree-revision"|"revision"|"auth
2554 \begin_layout Description
2555 Sample command-sequence info-insert buffer path; info-insert buffer name
2558 \begin_layout Description
2559 Origin bpeng, 7 Oct 2007
2562 \begin_layout Subsection*
2566 \begin_layout Description
2567 Action Apply data for an inset.
2570 \begin_layout Description
2571 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
2573 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
2574 on the context where it is called.
2577 \begin_layout Description
2578 Syntax inset-apply <ARGS>
2581 \begin_layout Description
2582 Params See LFUN_INSET_INSERT .
2585 \begin_layout Subsection*
2589 \begin_layout Description
2590 Action Move the cursor to the beginning of the current inset if it is not
2592 If the cursor is already at the beginning of the current inset, move it
2593 to the beginning of the enclosing inset or the main work area, respectively,
2594 if there is no enclosing inset.
2597 \begin_layout Description
2601 \begin_layout Description
2602 Origin lasgouttes, 16 Mar 2009
2605 \begin_layout Subsection*
2609 \begin_layout Description
2610 Action Move the cursor to the beginning of the current inset if it is not
2612 If the cursor is already at the beginning of the current inset, move it
2613 to the beginning of the enclosing inset or the main work area, respectively,
2614 if there is no enclosing inset (adding the traversed text to the selection).
2617 \begin_layout Description
2618 Syntax inset-begin-select
2621 \begin_layout Description
2622 Origin lasgouttes, 16 Mar 2009
2625 \begin_layout Subsection*
2629 \begin_layout Description
2630 Action Copies the inset to the clipboard as a certain type.
2633 \begin_layout Description
2634 Notion Currently used only for InsetInfo where its content is copied as
2638 \begin_layout Description
2639 Syntax inset-copy-as
2642 \begin_layout Description
2643 Origin vfr, 18 Apr 2010
2646 \begin_layout Subsection*
2650 \begin_layout Description
2651 Action Dissolve the current inset into text.
2654 \begin_layout Description
2655 Syntax inset-dissolve [<INSET>]
2658 \begin_layout Description
2659 Params <INSET>: this can be used to make sure the right kind of inset is
2661 For example "dissolve" entry in the charstyles sub-menu should only dissolve
2662 the charstyle inset, even if the cursor is inside several nested insets
2664 \begin_inset Newline newline
2667 For values see lyx::InsetLayout::lyxtype_ .
2670 \begin_layout Description
2671 Origin JSpitz, 7 Aug 2006
2674 \begin_layout Subsection*
2678 \begin_layout Description
2679 Action Edit the inset at cursor with an external application, if one is
2681 If the inset is file based, the referenced file is edited.
2682 Otherwise, the inset contents is written to a temporary file, the inset
2683 is locked, and the temporary file is edited.
2684 In this case, LFUN_INSET_END_EDIT must be called to overtake the changes
2685 and unlock the inset after editing is finished.
2688 \begin_layout Description
2689 Syntax inset-edit [<INSET_PARAMS>]
2692 \begin_layout Description
2693 Params <INSET_PARAMS>: Parameters for the inset.
2694 \begin_inset Newline newline
2697 Currently only the filename will be considered.
2700 \begin_layout Description
2701 Origin spitz, 27 Apr 2006
2704 \begin_layout Subsection*
2708 \begin_layout Description
2709 Action Move the cursor to the end of the current inset if it is not already
2711 If the cursor is already at the end of the current inset, move it to the
2712 end of the enclosing inset or the main work area, respectively, if there
2713 is no enclosing inset.
2716 \begin_layout Description
2720 \begin_layout Description
2721 Origin lasgouttes, 16 Mar 2009
2724 \begin_layout Subsection*
2728 \begin_layout Description
2729 Action End editing the inset at cursor with an external application.
2730 This replaces the inset contents with the contents of the temporary file,
2731 deletes the file and unlocks the inset.
2734 \begin_layout Description
2735 Syntax inset-end-edit
2738 \begin_layout Description
2739 Origin gb, 11 Oct 2015
2742 \begin_layout Subsection*
2746 \begin_layout Description
2747 Action Move the cursor to the end of the current inset if it is not already
2749 If the cursor is already at the end of the current inset, move it to the
2750 end of the enclosing inset or the main work area, respectively, if there
2751 is no enclosing inset (adding the traversed text to the selection).
2754 \begin_layout Description
2755 Syntax inset-end-select
2758 \begin_layout Description
2759 Origin lasgouttes, 16 Mar 2009
2762 \begin_layout Subsection*
2766 \begin_layout Description
2767 Action Apply the given commands on insets of a given name.
2770 \begin_layout Description
2771 Notion WARNING: use at your own risks; this function gives you too many
2772 ways of shooting yourself in the foot.
2773 A typical example is inset-forall Note note-insert which starts an infinite
2775 This is mitigated by the fact that the number of actions is arbitrarily
2777 Note also that inset-forall does not update metrics between iterations,
2778 which can lead to bugs.
2779 This has to be eventually fixed.
2782 \begin_layout Description
2783 Syntax inset-forall <NAME> <LFUN-COMMAND>
2784 \begin_inset Newline newline
2787 <NAME>: Type of Inset.
2788 If <NAME> is *, all insets are matched.
2789 The name is used like for InsetLayout in layout files: "Note" matches all
2790 note insets, while "Note:Note" only matches LyX yellow note insets.
2793 \begin_layout Description
2794 Sample Remove all index insets:
2795 \begin_inset Newline newline
2798 inset-forall Index char-delete-forward force
2799 \begin_inset Newline newline
2802 Close all Notes (also works for a particular branch, for example):
2803 \begin_inset Newline newline
2806 inset-forall Note inset-toggle close
2807 \begin_inset Newline newline
2810 Transform all yellow notes to comments
2811 \begin_inset Newline newline
2814 inset-forall Note:Note inset-modify note Note Comment
2815 \begin_inset Newline newline
2818 Try to put LyX in an infinite loop if there is at least a Note:
2819 \begin_inset Newline newline
2822 inset-forall Note char-backward
2825 \begin_layout Description
2826 Origin lasgouttes, 27 Nov 2009
2829 \begin_layout Subsection*
2833 \begin_layout Description
2834 Action Insert new inset (type given by the parameters).
2837 \begin_layout Description
2838 Syntax inset-insert <INSET> <ARGS>
2841 \begin_layout Description
2842 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2843 \begin_inset Newline newline
2846 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2847 \begin_inset Newline newline
2850 <ARGS>: depends on the given inset.
2851 Use "lyx -dbg action" to explore.
2854 \begin_layout Description
2855 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2858 \begin_inset Newline newline
2861 where <label name> is the name of the referenced label and <Format> is one
2863 \begin_inset Newline newline
2867 \begin_inset Newline newline
2870 eqref -- (<reference>)
2871 \begin_inset Newline newline
2875 \begin_inset Newline newline
2878 vpageref -- on <page>
2879 \begin_inset Newline newline
2882 vref -- <reference> on <page>
2883 \begin_inset Newline newline
2886 formatted -- Formatted reference
2889 \begin_layout Subsection*
2893 \begin_layout Description
2894 Action Modify some properties of an inset.
2897 \begin_layout Description
2898 Notion Used for argument, bibitem, bibtex, box, branch, caption, citation,
2899 command, ert, external, float, graphics, include, index, info, label, line,
2900 listings, newline, newpage, nomencl, note, phantom, quotes, ref, script,
2901 separator, space, tabular, vspace and wrap insets.
2904 \begin_layout Description
2905 Syntax inset-modify <INSET> <ARGS>
2906 \begin_inset Newline newline
2909 inset-modify changetype <TYPE>
2912 \begin_layout Description
2913 Sample Change a Note inset into a Comment inset:
2914 \begin_inset Newline newline
2917 inset-modify note Note Comment
2918 \begin_inset Newline newline
2921 Change a Box into an Ovalbox:
2922 \begin_inset Newline newline
2925 inset-modify changetype Ovalbox
2926 \begin_inset Newline newline
2929 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle
2931 \begin_inset Newline newline
2934 inset-modify changetype els
2935 \begin_inset Newline newline
2938 Change only the style of a quotation mark, maintaining the other aspects
2941 \begin_inset Newline newline
2944 inset-modify changetype e..
2945 \begin_inset Newline newline
2951 \begin_layout Subsection*
2955 \begin_layout Description
2956 Action Select all contents of an inset.
2959 \begin_layout Description
2960 Notion There are 3 successive levels: select current cell, select all cells
2961 of inset, select the inset from outside (in the enclosing inset).
2964 \begin_layout Description
2965 Syntax inset-select-all
2968 \begin_layout Description
2969 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2972 \begin_layout Subsection*
2976 \begin_layout Description
2977 Action Open the inset's properties dialog.
2980 \begin_layout Description
2981 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
2982 graphics, href, include, index, index_print, label, line, listings, note,
2983 phantom, ref, space, tabular, vspace, wrap insets.
2986 \begin_layout Description
2987 Syntax inset-settings <INSET>
2990 \begin_layout Description
2991 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2992 \begin_inset Newline newline
2995 graphics|href|include|index|index_print|label|line|
2996 \begin_inset Newline newline
2999 listings|note|phantom|ref|space|tabular|vspace|wrap>.
3002 \begin_layout Subsection*
3006 \begin_layout Description
3007 Action Splits the current inset into two at current position.
3010 \begin_layout Description
3011 Syntax inset-split [<INSET>]
3014 \begin_layout Description
3015 Params <INSET>: this can be used to make sure the right kind of inset is
3017 For example "split" entry in the charstyles sub-menu should only dissolve
3018 the charstyle inset, even if the cursor is inside several nested insets
3020 \begin_inset Newline newline
3023 For values see lyx::InsetLayout::lyxtype_ .
3026 \begin_layout Description
3027 Origin spitz, 22 Dec 2020
3030 \begin_layout Subsection*
3034 \begin_layout Description
3035 Action Toggles the collapsible inset at cursor position, or the inset we
3039 \begin_layout Description
3040 Syntax inset-toggle [<ARG>]
3043 \begin_layout Description
3044 Params <ARG>: <open|close|toggle|assign>.
3045 \begin_inset Newline newline
3048 open/close/toggle are for collapsible insets.
3049 toggle is used when no argument is given.
3050 \begin_inset Newline newline
3053 assign synchronize the branch-inset with activation status of the branch.
3054 Used for global toggling when changed activation.
3057 \begin_layout Description
3058 Origin lasgouttes, 19 Jul 2001
3061 \begin_layout Subsection*
3065 \begin_layout Description
3066 Action Inserts an IPA inset.
3069 \begin_layout Description
3073 \begin_layout Description
3074 Origin spitz, 05 Mar 2012
3077 \begin_layout Subsection*
3081 \begin_layout Description
3082 Action Inserts special IPA macros into the document.
3085 \begin_layout Description
3086 Syntax ipamacro-insert <CHAR>
3089 \begin_layout Description
3090 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
3091 tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
3094 \begin_layout Description
3095 Origin spitz, 22 Aug 2012
3098 \begin_layout Subsection*
3102 \begin_layout Description
3103 Action Turn off the loaded keyboard map.
3106 \begin_layout Description
3110 \begin_layout Subsection*
3114 \begin_layout Description
3115 Action Turn on the primary keyboard map.
3118 \begin_layout Description
3119 Notion Maps were widely used in past, when X-windows didn't have nowadays
3121 They can be still used to maintain uniform keyboard layout across the various
3123 \begin_inset Newline newline
3126 The language is to be set in the Preferences dialog.
3129 \begin_layout Description
3130 Syntax keymap-primary
3133 \begin_layout Subsection*
3137 \begin_layout Description
3138 Action Turn on the secondary keyboard map.
3141 \begin_layout Description
3142 Syntax keymap-secondary
3145 \begin_layout Subsection*
3149 \begin_layout Description
3150 Action Toggles keyboard maps (first/second/off).
3153 \begin_layout Description
3154 Syntax keymap-toggle
3157 \begin_layout Description
3158 Origin leeming, 30 Mar 2004
3161 \begin_layout Subsection*
3162 label-copy-as-reference
3165 \begin_layout Description
3166 Action Copies the label at the cursor as a cross-reference to be pasted
3170 \begin_layout Description
3171 Syntax copy-label-as-reference <LABEL>
3174 \begin_layout Description
3175 Params <LABEL>: The label to copy (for multi-line math)
3178 \begin_layout Description
3179 Origin sts, 16 Nov 2008
3182 \begin_layout Subsection*
3186 \begin_layout Description
3187 Action Goto a label.
3190 \begin_layout Description
3191 Syntax label-goto [<LABEL>]
3194 \begin_layout Description
3195 Params <LABEL>: Requested label.
3196 If no label is given and reference is on cursor position, Bookmark 0 is
3197 saved and cursor moves to the position of referenced label.
3200 \begin_layout Description
3201 Origin Ale, 6 Aug 1997
3204 \begin_layout Subsection*
3208 \begin_layout Description
3209 Action Inserts label to text or displayed formula.
3212 \begin_layout Description
3213 Syntax label-insert [<LABEL>]
3216 \begin_layout Description
3217 Params <LABEL>: Requested label.
3218 If no label is given dialog requesting name will be opened.
3221 \begin_layout Subsection*
3222 label-insert-as-reference
3225 \begin_layout Description
3226 Action Inserts the label (in ToC pane) as a cross-reference at the position
3230 \begin_layout Description
3231 Syntax label-insert-as-reference
3234 \begin_layout Description
3235 Origin vfr, 7 Apr 2009
3238 \begin_layout Subsection*
3242 \begin_layout Description
3243 Action Set language from the current cursor position.
3246 \begin_layout Description
3247 Syntax language <LANG> [set]
3250 \begin_layout Description
3251 Params <LANG>: Requested language.
3252 Look in lib/languages for the list.
3253 "language reset" or "language" (without param) reset to the document language.
3254 set: If used, the language will be set to the specified language.
3255 Otherwise, the language will be toggled (i.e., if the current language is
3256 LANG, switch to the document language or the default language, if LANG
3257 is the document language).
3260 \begin_layout Description
3261 Origin Dekel, 2 Mar 2000
3264 \begin_layout Subsection*
3268 \begin_layout Description
3269 Action Move the cursor to the beginning of the (screen) line.
3272 \begin_layout Description
3276 \begin_layout Subsection*
3280 \begin_layout Description
3281 Action Move the cursor to the beginning of the (screen) line adding the
3282 traversed text to the selection.
3285 \begin_layout Description
3286 Syntax line-begin-select
3289 \begin_layout Subsection*
3293 \begin_layout Description
3294 Action Deletes the letters to the end of the (screen) line or deletes the
3298 \begin_layout Description
3299 Syntax line-delete-forward
3302 \begin_layout Subsection*
3306 \begin_layout Description
3307 Action Move the cursor to the end of the (screen) line.
3310 \begin_layout Description
3314 \begin_layout Subsection*
3318 \begin_layout Description
3319 Action Move the cursor to the end of the (screen) line adding the traversed
3320 text to the selection.
3323 \begin_layout Description
3324 Syntax line-end-select
3327 \begin_layout Subsection*
3331 \begin_layout Description
3332 Action Inserts a new listings inset.
3335 \begin_layout Description
3336 Syntax listing-insert
3339 \begin_layout Description
3340 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
3343 \begin_layout Subsection*
3347 \begin_layout Description
3348 Action Inserts a marginal note.
3351 \begin_layout Description
3352 Syntax marginalnote-insert
3355 \begin_layout Description
3356 Origin Lgb, 26 Jun 2000
3359 \begin_layout Subsection*
3363 \begin_layout Description
3364 Action Disable selecting of text-region.
3367 \begin_layout Description
3371 \begin_layout Subsection*
3375 \begin_layout Description
3376 Action Enable selecting of text-region.
3379 \begin_layout Description
3380 Notion After enabling you can simply move arrow keys to get selected region.
3383 \begin_layout Description
3387 \begin_layout Subsection*
3391 \begin_layout Description
3392 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3395 \begin_layout Description
3399 \begin_layout Description
3400 Origin Andre, May 5 2006
3403 \begin_layout Subsection*
3407 \begin_layout Description
3408 Action Inserts a line break or new line.
3411 \begin_layout Description
3412 Syntax newline-insert [<ARG>]
3415 \begin_layout Description
3416 Params <ARG>: <newline|linebreak> default: newline
3419 \begin_layout Description
3420 Origin spitz, 25 Mar 2008
3423 \begin_layout Subsection*
3427 \begin_layout Description
3428 Action Inserts a new page.
3431 \begin_layout Description
3432 Syntax newpage-insert <ARG>
3435 \begin_layout Description
3436 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3439 \begin_layout Description
3440 Origin uwestoehr, 24 Nov 2007
3443 \begin_layout Subsection*
3447 \begin_layout Description
3448 Action Inserts Nomenclature entry.
3451 \begin_layout Description
3452 Notion It automatically takes the word on the cursor position if no symbol
3456 \begin_layout Description
3457 Syntax nomencl-insert [<SYMBOL>]
3460 \begin_layout Description
3461 Origin Ugras, 4 Nov 2006
3464 \begin_layout Subsection*
3468 \begin_layout Description
3469 Action Inserts list of Nomenclature entries.
3472 \begin_layout Description
3473 Syntax nomenclature-print
3476 \begin_layout Description
3477 Origin Ugras, 4 Nov 2006
3480 \begin_layout Subsection*
3484 \begin_layout Description
3485 Action Inserts Note on the current cursor position, move selection inside
3489 \begin_layout Description
3490 Syntax note-insert [<TYPE>]
3493 \begin_layout Description
3494 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3497 \begin_layout Subsection*
3501 \begin_layout Description
3502 Action Moves the cursor to the beginning of next Note inset.
3505 \begin_layout Description
3509 \begin_layout Subsection*
3513 \begin_layout Description
3514 Action Move the current group in the downward direction in the structure
3518 \begin_layout Description
3519 Notion The "group" can be Part/Chapter/Section/etc.
3520 It moves the whole substructure of the group.
3523 \begin_layout Description
3527 \begin_layout Description
3528 Origin Vermeer, 23 Mar 2006
3531 \begin_layout Subsection*
3535 \begin_layout Description
3536 Action Moves the current group in the downward direction in the hierarchy
3537 of the document structure.
3540 \begin_layout Description
3541 Notion Part -> Chapter -> Section -> etc.
3544 \begin_layout Description
3548 \begin_layout Description
3549 Origin Vermeer, 23 Mar 2006
3552 \begin_layout Subsection*
3556 \begin_layout Description
3557 Action Moves the current group in the upward direction in the hierarchy
3558 of the document structure.
3561 \begin_layout Description
3562 Notion Part <- Chapter <- Section <- etc.
3565 \begin_layout Description
3569 \begin_layout Description
3570 Origin Vermeer, 23 Mar 2006
3573 \begin_layout Subsection*
3577 \begin_layout Description
3578 Action Move the current group in the upward direction in the structure of
3582 \begin_layout Description
3583 Notion The "group" can be Part/Chapter/Section/etc.
3584 It moves the whole substructure of the group.
3587 \begin_layout Description
3591 \begin_layout Description
3592 Origin Vermeer, 23 Mar 2006
3595 \begin_layout Subsection*
3599 \begin_layout Description
3600 Action Breaks the current paragraph at the current location.
3603 \begin_layout Description
3604 Notion Removes the selection.
3607 \begin_layout Description
3608 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3611 \begin_layout Description
3612 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3613 default layout) when the cursor is at the end of the line.
3614 \begin_inset Newline newline
3617 ignoresep: Do not account for paragraph separators while breaking.
3620 \begin_layout Subsection*
3624 \begin_layout Description
3625 Action Move the cursor to the next paragraph (or beginning of the current
3626 one) in downward direction.
3629 \begin_layout Description
3630 Syntax paragraph-down
3633 \begin_layout Description
3634 Origin Asger, 1 Oct 1996
3637 \begin_layout Subsection*
3638 paragraph-down-select
3641 \begin_layout Description
3642 Action Move the cursor and select the text to the next paragraph (or beginning
3643 of the current one) in downward direction.
3646 \begin_layout Description
3647 Syntax paragraph-down-select
3650 \begin_layout Description
3651 Origin Asger, 1 Oct 1996
3654 \begin_layout Subsection*
3658 \begin_layout Description
3659 Action Jump to a paragraph given by its id number and optionally the desired
3660 position within the paragraph.
3661 If given four arguments id_start, pos_start, id_end, pos_end, perform a
3662 selection from start to end.
3665 \begin_layout Description
3666 Notion Note that id number of paragraph is not the sequential number of
3667 paragraph seen on the screen.
3668 Moreover the id is unique for all opened buffers (documents).
3669 Both ids must belong to the same buffer.
3672 \begin_layout Description
3673 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3676 \begin_layout Description
3677 Params <PAR_ID>: paragraph id
3678 \begin_inset Newline newline
3681 <POS_IN_PAR>: desired position within the paragraph
3684 \begin_layout Description
3685 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3688 \begin_layout Subsection*
3692 \begin_layout Description
3693 Action Moves the current paragraph downwards in the document.
3696 \begin_layout Description
3697 Syntax paragraph-move-down
3700 \begin_layout Description
3701 Origin Edwin, 8 Apr 2006
3704 \begin_layout Subsection*
3708 \begin_layout Description
3709 Action Moves the current paragraph upwards in the document.
3712 \begin_layout Description
3713 Notion Movement through the document will possibly break the paragraph-depth
3718 \begin_layout Description
3719 Syntax paragraph-move-up
3722 \begin_layout Description
3723 Origin Edwin, 8 Apr 2006
3726 \begin_layout Subsection*
3730 \begin_layout Description
3731 Action Change paragraph settings.
3734 \begin_layout Description
3735 Notion Modifies the current paragraph, or currently selected paragraphs.
3736 This function only modifies, and does not override, existing settings.
3737 Note that the "leftindent" indent setting is deprecated.
3740 \begin_layout Description
3741 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3744 \begin_layout Description
3754 \begin_inset Newline newline
3759 paragraph_spacing default|single|onehalf|double|other SIZE
3760 \begin_inset Newline newline
3765 align block|left|right|center|default
3766 \begin_inset Newline newline
3771 labelwidthstring WIDTH|
3776 \begin_layout Description
3777 Origin rgh, Aug 15 2007
3780 \begin_layout Subsection*
3781 paragraph-params-apply
3784 \begin_layout Description
3785 Action Change paragraph settings.
3788 \begin_layout Description
3789 Notion Overwrite all nonspecified settings to the default ones.
3790 Use paragraph-params lfun if you don't want to overwrite others settings.
3793 \begin_layout Description
3794 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3797 \begin_layout Description
3798 Params For parameters see LFUN_PARAGRAPH_PARAMS
3801 \begin_layout Description
3802 Origin leeming, 30 Mar 2004
3805 \begin_layout Subsection*
3809 \begin_layout Description
3810 Action Move cursor to beginning of current paragraph and select to the end
3811 in downward direction
3814 \begin_layout Description
3815 Notion This function is by default bound to triple mouse click
3818 \begin_layout Description
3819 Syntax paragraph-select
3822 \begin_layout Description
3823 Origin Kornel, 16 Apr 2019
3826 \begin_layout Subsection*
3830 \begin_layout Description
3831 Action Move the cursor to the next paragraph (or beginning of the current
3832 one) in upward direction.
3835 \begin_layout Description
3839 \begin_layout Description
3840 Origin Asger, 1 Oct 1996
3843 \begin_layout Subsection*
3847 \begin_layout Description
3848 Action Move the cursor and select the text to the next paragraph (or beginning
3849 of the current one) in upward direction.
3852 \begin_layout Description
3853 Syntax paragraph-up-select
3856 \begin_layout Description
3857 Origin Asger, 1 Oct 1996
3860 \begin_layout Subsection*
3864 \begin_layout Description
3865 Action Pastes material (text or picture) from the active clipboard.
3868 \begin_layout Description
3869 Syntax paste [<TYPE>|<NUM>]
3872 \begin_layout Description
3873 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3874 \begin_inset Newline newline
3877 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3880 \begin_layout Subsection*
3884 \begin_layout Description
3885 Action Inserts phantom on the current cursor position, move selection inside
3889 \begin_layout Description
3890 Syntax phantom-insert [<TYPE>]
3893 \begin_layout Description
3894 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3897 \begin_layout Description
3898 Origin uwestoehr, 30 Jan 2009
3901 \begin_layout Subsection*
3905 \begin_layout Description
3906 Action Inserts a new preview inset.
3909 \begin_layout Description
3910 Syntax preview-insert
3913 \begin_layout Description
3914 Origin vfr, 28 Mar 2010
3917 \begin_layout Subsection*
3918 primary-selection-paste
3921 \begin_layout Description
3922 Action Pastes the currently selected text.
3925 \begin_layout Description
3926 Notion Primary selection mechanism is linux-only thing.
3929 \begin_layout Description
3930 Syntax primary-selection-paste [<ARG>]
3933 \begin_layout Description
3934 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
3938 \begin_layout Subsection*
3942 \begin_layout Description
3943 Action Inserts quotes according to the type and quote-language preference.
3946 \begin_layout Description
3947 Notion Currently 15 different quote styles are distinguished (see params).
3950 \begin_layout Description
3951 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3954 \begin_layout Description
3955 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
3956 outer (i.e., primary, usually double) quotes will be used.
3957 \begin_inset Newline newline
3960 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise
3961 the side will be guessed from the context.
3962 \begin_inset Newline newline
3965 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3966 \begin_inset Newline newline
3969 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3970 \begin_inset Newline newline
3973 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3974 \begin_inset Newline newline
3977 'danish' for >>Danish<< quote style (with >inner quotation<)
3978 \begin_inset Newline newline
3981 'english' for ``English'' quote style (with `inner quotation')
3982 \begin_inset Newline newline
3985 'french' for <<french>> quote style (with ``inner quotation'')
3986 \begin_inset Newline newline
3989 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in"
3990 = Imprimerie Nationale]
3991 \begin_inset Newline newline
3994 'german' for ,,German`` quote style (with ,inner quotation`)
3995 \begin_inset Newline newline
3998 'plain' for "Plain" quote style (with 'inner quotation')
3999 \begin_inset Newline newline
4002 'polish' for ,,Polish'' quote style (with ,inner quotation')
4003 \begin_inset Newline newline
4006 'swedish' for ''Swedish'' quote style (with 'inner quotation')
4007 \begin_inset Newline newline
4010 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" =
4012 \begin_inset Newline newline
4015 'swiss' for <<Swiss>> quote style (with <inner quotation>)
4016 \begin_inset Newline newline
4019 'russian' for <<Russian>> quote style (with ,,inner quotation``)
4020 \begin_inset Newline newline
4023 'dynamic' for Dynamic quotation marks which inherit the global document
4025 \begin_inset Newline newline
4028 If no quote style is specified, the document-wide will be used.
4031 \begin_layout Subsection*
4035 \begin_layout Description
4036 Action Redoes the last thing undone.
4039 \begin_layout Description
4043 \begin_layout Subsection*
4047 \begin_layout Description
4048 Action Go to the next label or cross-reference.
4051 \begin_layout Description
4052 Syntax reference-next
4055 \begin_layout Description
4056 Origin Dekel, 14 Jan 2001
4059 \begin_layout Subsection*
4063 \begin_layout Description
4064 Action Repeat the given command.
4067 \begin_layout Description
4068 Notion fails when the repeat count is greater than 10000.
4071 \begin_layout Description
4072 Syntax repeat <COUNT> <LFUN-COMMAND>
4075 \begin_layout Description
4076 Origin Andre, 27 Oct 2003
4079 \begin_layout Subsection*
4083 \begin_layout Description
4084 Action Moves the cursor one page in downward direction.
4087 \begin_layout Description
4091 \begin_layout Subsection*
4095 \begin_layout Description
4096 Action Moves the cursor one screen in downward direction adding the current
4097 position to the selection.
4100 \begin_layout Description
4101 Syntax screen-down-select
4104 \begin_layout Subsection*
4108 \begin_layout Description
4109 Action Recenters the screen on the current cursor position.
4112 \begin_layout Description
4113 Syntax screen-recenter
4116 \begin_layout Subsection*
4120 \begin_layout Description
4121 Action Repositions the screen such that the cursor is visible.
4124 \begin_layout Description
4125 Syntax screen-show-cursor
4128 \begin_layout Description
4129 Origin vfr, 25 Mar 2009
4132 \begin_layout Subsection*
4136 \begin_layout Description
4137 Action Moves the cursor one page in upward direction.
4140 \begin_layout Description
4144 \begin_layout Subsection*
4148 \begin_layout Description
4149 Action Moves the cursor one page in upward direction adding the current
4150 position to the selection.
4153 \begin_layout Description
4154 Syntax screen-up-select
4157 \begin_layout Subsection*
4161 \begin_layout Description
4162 Action Inserts a subscript or superscript inset.
4165 \begin_layout Description
4166 Syntax script-insert <TYPE>
4169 \begin_layout Description
4170 Params <TYPE>: subscript|superscript
4173 \begin_layout Description
4174 Origin Georg, 23 Nov 2010
4177 \begin_layout Subsection*
4181 \begin_layout Description
4182 Action Scroll the buffer view.
4185 \begin_layout Description
4186 Notion Only scrolls the screen up or down; does not move the cursor.
4189 \begin_layout Description
4190 Syntax scroll <TYPE> <QUANTITY>
4193 \begin_layout Description
4194 Params <TYPE>: line|page
4195 \begin_inset Newline newline
4198 <QUANTITY>: up|down|<number>
4201 \begin_layout Description
4202 Origin Abdel, Dec 27 2007
4205 \begin_layout Subsection*
4209 \begin_layout Description
4210 Action Set search string buffer.
4213 \begin_layout Description
4214 Syntax search-string-set [<DATA>]
4217 \begin_layout Description
4218 Params <DATA>: string to search for.
4219 If no parameter is given, use (word under) selection.
4222 \begin_layout Description
4223 Origin stwitt, spitz, Feb 12 2021
4226 \begin_layout Subsection*
4230 \begin_layout Description
4231 Action Select the whole section.
4234 \begin_layout Description
4235 Notion The cursor should be in a section heading before calling this lfun.
4238 \begin_layout Description
4239 Syntax section-select
4242 \begin_layout Description
4243 Origin vfr, 05 May 2009
4246 \begin_layout Subsection*
4250 \begin_layout Description
4251 Action Pastes the internal selection text in permanent selection.
4254 \begin_layout Description
4255 Notion Created in order to have middle mouse button pasting correct (bound
4256 to command-alternatives selection-paste ; primary-selection-paste paragraph).
4259 \begin_layout Description
4260 Syntax selection-paste
4263 \begin_layout Description
4264 Origin lasgouttes, 14 Jan 2009
4267 \begin_layout Subsection*
4271 \begin_layout Description
4272 Action Inserts an environment separator or latex paragraph break.
4275 \begin_layout Description
4276 Syntax separator-insert [<ARG>]
4279 \begin_layout Description
4280 Params <ARG>: <plain|parbreak|latexpar> default: plain
4283 \begin_layout Description
4284 Origin ef, 2 May 2014
4287 \begin_layout Subsection*
4291 \begin_layout Description
4292 Action Inserts one of horizontal space insets.
4295 \begin_layout Description
4296 Syntax space-insert <NAME> [<LEN>]
4299 \begin_layout Description
4300 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip,
4301 negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill,
4303 \begin_inset Newline newline
4306 Only in math mode: med and thick.
4307 \begin_inset Newline newline
4310 <LEN>: length for custom spaces (hspace, hspace* for protected)
4313 \begin_layout Description
4314 Origin spitz, 20 May 2003, Mar 17 2008
4317 \begin_layout Subsection*
4321 \begin_layout Description
4322 Action Inserts various characters into the document.
4325 \begin_layout Description
4326 Syntax specialchar-insert <CHAR>
4329 \begin_layout Description
4330 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash,
4331 dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
4334 \begin_layout Description
4335 Origin spitz, 6 Dec 2007
4338 \begin_layout Subsection*
4342 \begin_layout Description
4343 Action Add the word under the cursor to the respective spell checker dictionary.
4344 The default for the language is retrieved from the cursor position.
4347 \begin_layout Description
4348 Syntax spelling-add [<STRING>] [<LANG>]
4351 \begin_layout Description
4352 Params <WORD>: word to add <LANG>: language name (see file languages)
4355 \begin_layout Description
4356 Origin spitz, 18 Jan 2010
4359 \begin_layout Subsection*
4363 \begin_layout Description
4364 Action Add the word under the cursor to the document's local spell checker
4366 The default for the language is retrieved from the cursor position.
4369 \begin_layout Description
4370 Syntax spelling-add-local [<STRING>] [<LANG>]
4373 \begin_layout Description
4374 Params <WORD>: word to add <LANG>: language name (see file languages)
4377 \begin_layout Description
4378 Origin spitz, 6 Mar 2021
4381 \begin_layout Subsection*
4382 spelling-continuously
4385 \begin_layout Description
4386 Action Toggle continuous spell checking.
4389 \begin_layout Description
4390 Syntax spelling-continuously
4393 \begin_layout Description
4394 Origin vfr, 24 March 2013
4397 \begin_layout Subsection*
4401 \begin_layout Description
4402 Action Let the spell checker ignore the word under the cursor in the current
4403 session for the given language.
4404 The default for the language is retrieved from the cursor position.
4407 \begin_layout Description
4408 Syntax spelling-ignore [<WORD>] [<LANG>]
4411 \begin_layout Description
4412 Params <WORD>: word to ignore <LANG>: language name (see file languages)
4415 \begin_layout Description
4416 Origin spitz, 18 Jan 2010
4419 \begin_layout Subsection*
4423 \begin_layout Description
4424 Action Remove the word under the cursor from the respective spell checker
4426 The default for the language is retrieved from the cursor position.
4429 \begin_layout Description
4430 Syntax spelling-remove [<STRING>] [<LANG>]
4433 \begin_layout Description
4434 Params <WORD>: word to remove <LANG>: language name (see file languages)
4437 \begin_layout Description
4438 Origin SWitt, 28 July 2010
4441 \begin_layout Subsection*
4442 spelling-remove-local
4445 \begin_layout Description
4446 Action Remove the word under the cursor from the document's local spell
4448 The default for the language is retrieved from the cursor position.
4451 \begin_layout Description
4452 Syntax spelling-remove-local [<STRING>] [<LANG>]
4455 \begin_layout Description
4456 Params <WORD>: word to remove <LANG>: language name (see file languages)
4459 \begin_layout Description
4460 Origin spitz, 7 Mar 2021
4463 \begin_layout Subsection*
4467 \begin_layout Description
4468 Action Delete a tab or up to an equivalent amount of spaces from a listings
4472 \begin_layout Description
4473 Notion It also works on a selection - it removes a tab or spaces from the
4474 beginning of each line spanned by the selection.
4475 This is useful if you want to indent/unindent multiple lines in one action.
4478 \begin_layout Description
4482 \begin_layout Description
4483 Origin vfr, Sep 30 2008
4486 \begin_layout Subsection*
4490 \begin_layout Description
4491 Action Insert a tab into a listings inset.
4494 \begin_layout Description
4495 Notion It also works on a selection.
4498 \begin_layout Description
4502 \begin_layout Description
4503 Origin vfr, Sep 30 2008
4506 \begin_layout Subsection*
4510 \begin_layout Description
4511 Action Modify properties of tabulars and table-like math environments.
4514 \begin_layout Description
4515 Syntax tabular-feature <FEATURE> [<ARG>]
4518 \begin_layout Description
4519 Params Generally see LFUN_INSET_INSERT for further details.
4520 \begin_inset Newline newline
4523 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4524 \begin_inset Newline newline
4527 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4528 \begin_inset Newline newline
4531 set-line-top|set-line-bottom|set-line-left|set-line-right|
4532 \begin_inset Newline newline
4535 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4536 \begin_inset Newline newline
4539 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
4540 \begin_inset Newline newline
4543 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
4544 \begin_inset Newline newline
4547 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4548 \begin_inset Newline newline
4551 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4552 \begin_inset Newline newline
4555 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4556 \begin_inset Newline newline
4559 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4560 \begin_inset Newline newline
4563 reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|
4564 \begin_inset Newline newline
4567 set-longtabular|unset-longtabular|set-pwidth|
4568 \begin_inset Newline newline
4571 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4572 \begin_inset Newline newline
4575 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4576 \begin_inset Newline newline
4579 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4580 \begin_inset Newline newline
4583 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4584 \begin_inset Newline newline
4587 set-special-column|set-special-multicolumn|set-special-multirow|
4588 \begin_inset Newline newline
4591 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4592 \begin_inset Newline newline
4595 set-interline-space|set-border-lines|tabular-valign-top|
4596 \begin_inset Newline newline
4599 tabular-valign-middle|tabular-valign-bottom|set-tabular-width|
4600 \begin_inset Newline newline
4603 toggle-varwidth-column Various math-environment features are handled as
4605 add-vline-left/right for
4606 \begin_inset Newline newline
4609 the Grid/Array environment.
4610 \begin_inset Newline newline
4613 <ARG>: additional argument for some commands, use debug mode to explore
4617 \begin_layout Description
4618 Origin gm, 10 Dec 2015
4621 \begin_layout Subsection*
4625 \begin_layout Description
4626 Action Inserts table into the document.
4629 \begin_layout Description
4630 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modification
4634 \begin_layout Description
4635 Syntax tabular-insert [<ROWS> <COLUMNS>]
4638 \begin_layout Description
4639 Params In case no arguments are given show insert dialog.
4642 \begin_layout Description
4643 Origin Jug, 12 Apr 2000
4646 \begin_layout Subsection*
4647 tabular-style-insert
4650 \begin_layout Description
4651 Action Inserts table of a given style into the document.
4654 \begin_layout Description
4655 Notion See LFUN_TABULAR_FEATURE for some more details about tabular
4659 \begin_layout Description
4660 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
4663 \begin_layout Description
4664 Params Valid styles are the names of the files in lib/tabletemplates, minus
4665 _1x<n> and .lyx suffix.
4668 \begin_layout Description
4669 Origin spitz, 25 Mar 2019
4672 \begin_layout Subsection*
4676 \begin_layout Description
4677 Action Look up thesaurus entries with respect to the word under the cursor.
4680 \begin_layout Description
4681 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4684 \begin_layout Description
4685 Params <STRING>: word to look up <LANG>: language (see file languages)
4688 \begin_layout Description
4689 Origin Levon, 20 Jul 2001
4692 \begin_layout Subsection*
4696 \begin_layout Description
4697 Action Undoes the last edit.
4700 \begin_layout Description
4704 \begin_layout Subsection*
4708 \begin_layout Description
4709 Action Inserts a single unicode character.
4712 \begin_layout Description
4713 Syntax unicode-insert <CHAR1> <CHAR2> ...
4716 \begin_layout Description
4717 Params <CHARn>: The character to insert, given as its code point, in hexadecimal.
4720 \begin_layout Description
4721 Sample unicode-insert 0x0100 0x0259
4724 \begin_layout Description
4725 Origin Lgb, 22 Oct 2006
4728 \begin_layout Subsection*
4732 \begin_layout Description
4733 Action Moves the cursor one line in upward direction.
4736 \begin_layout Description
4740 \begin_layout Subsection*
4744 \begin_layout Description
4745 Action Moves the cursor one line in upward direction adding the current
4746 position to the selection.
4749 \begin_layout Description
4753 \begin_layout Subsection*
4757 \begin_layout Description
4758 Action Moves the cursor to the logically previous beginning of a word.
4761 \begin_layout Description
4762 Notion This is not the action which should be bound to the arrow keys, because
4763 backwards may be left or right, depending on the language.
4764 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
4765 which in turn may employ this one.
4768 \begin_layout Description
4769 Syntax word-backward
4772 \begin_layout Subsection*
4773 word-backward-select
4776 \begin_layout Description
4777 Action Moves the cursor to the logically previous beginning of a word, adding
4778 the logically traversed text to the selection.
4781 \begin_layout Description
4782 Notion See also LFUN_WORD_BACKWARD.
4785 \begin_layout Description
4786 Syntax word-backward-select
4789 \begin_layout Subsection*
4793 \begin_layout Description
4794 Action Capitalizes the words in the selection (i.e.
4795 the first letters) or the first letter of word at cursor position.
4798 \begin_layout Description
4799 Syntax word-capitalize [<SEL_TYPE>]
4802 \begin_layout Description
4803 Params <SEL_TYPE>: if this is equal to "partial", then the default word
4804 starts at cursor position (emacs-style).
4805 Otherwise, the whole word is considered.
4808 \begin_layout Subsection*
4809 word-delete-backward
4812 \begin_layout Description
4813 Action Deletes characters to the beginning of the word (usually the "C+BackSpace
4817 \begin_layout Description
4818 Syntax word-delete-backward [force]
4821 \begin_layout Description
4822 Params force: Delete big insets, do not only select them.
4825 \begin_layout Subsection*
4829 \begin_layout Description
4830 Action Deletes characters to the end of the word (usually the "C+Delete"
4834 \begin_layout Description
4835 Syntax word-delete-forward [force]
4838 \begin_layout Description
4839 Params force: Delete big insets, do not only select them.
4842 \begin_layout Subsection*
4846 \begin_layout Description
4847 Action Search for next occurrence of a string.
4850 \begin_layout Description
4851 Syntax word-find [<DATA>]
4854 \begin_layout Description
4855 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
4856 If no parameter is given, search with last find-dialog data is used for
4861 \begin_layout Description
4862 Origin Andre, Jan 7 2004
4865 \begin_layout Subsection*
4869 \begin_layout Description
4870 Action Search for a given string in backward direction.
4873 \begin_layout Description
4874 Notion Case sensitive, match words.
4875 If no argument given, last search repeated.
4878 \begin_layout Description
4879 Syntax word-find-backward [<STRING>]
4882 \begin_layout Description
4883 Origin Etienne, 20 Feb 1998
4886 \begin_layout Subsection*
4890 \begin_layout Description
4891 Action Search for a given string in forward direction.
4894 \begin_layout Description
4895 Notion Case sensitive, match words.
4896 If no argument given, last search repeated.
4899 \begin_layout Description
4900 Syntax word-find-forward [<STRING>]
4903 \begin_layout Description
4904 Origin Etienne, 16 Feb 1998
4907 \begin_layout Subsection*
4911 \begin_layout Description
4912 Action Search for next occurrence of a pattern.
4915 \begin_layout Description
4916 Syntax word-findadv [<DATA>]
4919 \begin_layout Description
4920 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
4921 If no parameter is given, search with last find-dialog data is used for
4926 \begin_layout Description
4927 Origin Tommaso, Nov 15 2007
4930 \begin_layout Subsection*
4934 \begin_layout Description
4935 Action Moves the cursor to the logically next beginning of a word.
4938 \begin_layout Description
4939 Notion This is not the action which should be bound to the arrow keys, because
4940 forward may be left or right, depending on the language.
4941 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
4942 which in turn may employ this one.
4945 \begin_layout Description
4949 \begin_layout Subsection*
4953 \begin_layout Description
4954 Action Moves the cursor to the logically next beginning of a word, adding
4955 the logically traversed text to the selection.
4958 \begin_layout Description
4959 Notion See also LFUN_WORD_FORWARD.
4962 \begin_layout Description
4963 Syntax word-forward-select
4966 \begin_layout Subsection*
4970 \begin_layout Description
4971 Action Moves the cursor to the next beginning of a word "on the left".
4974 \begin_layout Description
4975 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
4977 Generally, it moves the cursor to the next beginning of a word on the left.
4978 However, in Bidi text this become slightly more complicated, and there
4979 are different modes of cursor movement.
4980 In "visual mode", this moves left, plain and simple.
4981 In "logical mode", movement is logically forward in RTL paragraphs, and
4982 logically backwards in LTR paragraphs.
4985 \begin_layout Description
4989 \begin_layout Description
4990 Origin dov, 28 Oct 2007
4993 \begin_layout Subsection*
4997 \begin_layout Description
4998 Action Moves the cursor to the next beginning of a word "on the left", adding
4999 *logically* traversed text to the selection.
5002 \begin_layout Description
5003 Notion See also LFUN_WORD_LEFT for exact details of the movement.
5006 \begin_layout Description
5007 Syntax word-left-select
5010 \begin_layout Description
5011 Origin dov, 28 Oct 2007
5014 \begin_layout Subsection*
5018 \begin_layout Description
5019 Action Change the words in the selection or word at cursor position to lower
5023 \begin_layout Description
5024 Syntax word-lowcase [<SEL_TYPE>]
5027 \begin_layout Description
5028 Params <SEL_TYPE>: if this is equal to "partial", then the default word
5029 starts at cursor position (emacs-style).
5030 Otherwise, the whole word is considered.
5033 \begin_layout Subsection*
5037 \begin_layout Description
5038 Action Replace a string in the document.
5041 \begin_layout Description
5042 Syntax word-replace [<DATA>]
5045 \begin_layout Description
5046 Params <DATA>: data is of the form "<replacestring>
5047 \begin_inset Newline newline
5051 \begin_inset Newline newline
5054 <casesensitive> <matchword> <all> <forward> <findnext>"
5057 \begin_layout Description
5058 Origin Andre, Jan 7 2004
5061 \begin_layout Subsection*
5065 \begin_layout Description
5066 Action Moves the cursor to the next beginning of a word "on the right".
5069 \begin_layout Description
5070 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
5072 Generally, it moves the cursor to the next beginning of a word on the right.
5073 However, in Bidi text this become slightly more complicated, and there
5074 are different modes of cursor movement.
5075 In "visual mode", this moves right, plain and simple.
5076 In "logical mode", movement is logically forward in LTR paragraphs, and
5077 logically backwards in RTL paragraphs.
5080 \begin_layout Description
5084 \begin_layout Description
5085 Origin dov, 28 Oct 2007
5088 \begin_layout Subsection*
5092 \begin_layout Description
5093 Action Moves the cursor to the next beginning of a word "on the right",
5094 adding *logically* traversed text to the selection.
5097 \begin_layout Description
5098 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
5101 \begin_layout Description
5102 Syntax word-right-select
5105 \begin_layout Description
5106 Origin dov, 28 Oct 2007
5109 \begin_layout Subsection*
5113 \begin_layout Description
5114 Action Puts the word where the cursor stands into the selection.
5117 \begin_layout Description
5121 \begin_layout Description
5122 Origin Andre, 11 Sep 2002
5125 \begin_layout Subsection*
5129 \begin_layout Description
5130 Action Change the words in the selection or word at cursor position to upper
5134 \begin_layout Description
5135 Syntax word-upcase [<SEL_TYPE>]
5138 \begin_layout Description
5139 Params <SEL_TYPE>: if this is equal to "partial", then the default word
5140 starts at cursor position (emacs-style).
5141 Otherwise, the whole word is considered.
5144 \begin_layout Subsection*
5148 \begin_layout Description
5149 Action Inserts floats wrapped by the text around.
5152 \begin_layout Description
5153 Syntax wrap-insert <TYPE>
5156 \begin_layout Description
5157 Params <TYPE>: table|figure
5160 \begin_layout Description
5161 Origin Dekel, 7 Apr 2002
5164 \begin_layout Section
5165 Math Editor Functions
5168 \begin_layout Subsection*
5169 in-mathmacrotemplate
5172 \begin_layout Description
5173 Action Only active in Math Macro definition.
5176 \begin_layout Description
5177 Notion Dummy function which is only active in a Math Macro definition.
5178 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
5182 \begin_layout Description
5183 Syntax in-mathmacrotemplate
5186 \begin_layout Description
5187 Origin sts, 06 January 2008
5190 \begin_layout Subsection*
5194 \begin_layout Description
5195 Action Inserts an extended matrix as provided by the amsmath package.
5198 \begin_layout Description
5199 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
5202 \begin_layout Description
5203 Params <DECORATION>: Decoration determines the LaTeX name of the matrix
5204 that should be created.
5205 Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix, smallmatri
5207 The default is 'matrix'.
5210 \begin_layout Description
5211 Sample math-ams-matrix 3 3 bmatrix
5214 \begin_layout Subsection*
5218 \begin_layout Description
5219 Action Inserts math fixed size delimiters (e.g.
5220 parentheses, brackets) enclosing expression.
5223 \begin_layout Description
5224 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
5227 \begin_layout Description
5228 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
5229 \begin_inset Newline newline
5232 <L/RDELIM>: TeX code for delimiter.
5233 See Delimiter dialog for delimiters to be used.
5236 \begin_layout Description
5237 Sample math-bigdelim "Bigl" "
5244 \begin_layout Description
5245 Origin Enrico & Georg, 7 May 2006
5248 \begin_layout Subsection*
5252 \begin_layout Description
5253 Action Inserts math delimiters (e.g.
5254 parentheses, brackets) enclosing expression.
5257 \begin_layout Description
5258 Syntax math-delim [<LEFT>] [<RIGHT>]
5261 \begin_layout Description
5262 Params <LEFT/RIGHT>: Delimiters to be used.
5263 Each delimiter can be specified by either a LaTeX name or a valid character.
5264 ( is the default letter.
5267 \begin_layout Description
5268 Sample math-delim { rangle
5271 \begin_layout Description
5272 Origin Alejandro, 18 Jun 1996
5275 \begin_layout Subsection*
5279 \begin_layout Description
5280 Action Creates a new displayed equation in text mode.
5281 Toggles inlined/display formula in math mode.
5284 \begin_layout Description
5285 Syntax math-display [<ARG>]
5288 \begin_layout Description
5289 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
5290 new equation from the text mode.
5293 \begin_layout Description
5294 Origin Alejandro, 18 Jun 1996
5297 \begin_layout Subsection*
5301 \begin_layout Description
5302 Action Calls external program and passes the current expression/equation
5303 as an argument for the calculation in the format appropriate to the given
5307 \begin_layout Description
5308 Notion Selection can be used to determine the input for the external program.
5311 \begin_layout Description
5312 Syntax math-extern <LANG> [<COMMAND>]
5315 \begin_layout Description
5316 Params <LANG>: octave|maxima|maple|mathematica|script
5317 \begin_inset Newline newline
5320 where "script" stands for the external script (normalized expression will
5324 \begin_layout Description
5325 Sample math-extern maple simplify
5328 \begin_layout Description
5329 Origin Andre, 24 Apr 2001
5332 \begin_layout Subsection*
5336 \begin_layout Description
5337 Action Changes the text style used in math.
5340 \begin_layout Description
5341 Syntax math-font-style <STYLE>
5344 \begin_layout Description
5345 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
5346 \begin_inset Newline newline
5349 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
5352 \begin_layout Description
5353 Origin vfr, 9 jan 2009
5356 \begin_layout Subsection*
5360 \begin_layout Description
5361 Action Inserts math objects and symbols.
5364 \begin_layout Description
5365 Notion When <ARG> is a _single_ math inset with more than one cell (such
5368 frac{x}{y}"), the content of cell(0) is replaced by the current selection
5369 (only works if the selection is in mathed).
5370 As an example, if "abc" is selected in mathed, "math-insert
5372 frac{x}{y}" replaces "abc" with "
5374 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
5375 If nothing is selected (or the selection is not in mathed), math-insert
5379 \begin_layout Description
5380 Syntax math-insert <ARG>
5383 \begin_layout Description
5384 Params <ARG>: Symbol or LaTeX code to be inserted.
5387 \begin_layout Subsection*
5391 \begin_layout Description
5392 Action Toggles the position of the limits from above/below to the right
5393 side an vice versa in integral symbol, a limit, a summation, etc.
5396 \begin_layout Description
5397 Notion Put the cursor before the symbol with the limits and then invoke
5401 \begin_layout Description
5402 Syntax math-limits [<STATE>]
5405 \begin_layout Description
5406 Params <STATE>: limits|nolimits
5409 \begin_layout Subsection*
5413 \begin_layout Description
5414 Action Inserts a math macro definition at the cursor position in the text.
5417 \begin_layout Description
5418 Syntax math-macro <NAME> [<NARGS>] [def]
5421 \begin_layout Description
5422 Params <NAME>: The name of the macro, e.g.
5424 \begin_inset Newline newline
5427 <NARGS>: The number of parameters of the macro.
5429 "def": Has no effect anymore, just for compatibility with former LyX versions.
5432 \begin_layout Description
5433 Origin ale, 10 May 1997; sts, 21 Dec 2007
5436 \begin_layout Subsection*
5437 math-macro-add-greedy-optional-param
5440 \begin_layout Description
5441 Action Add a greedy optional parameter.
5444 \begin_layout Description
5445 Notion Add a greedy optional parameter which eats the value from the following
5446 cells in mathed which are in the [value] format.
5449 \begin_layout Description
5450 Syntax math-macro-add-greedy-optional-param
5453 \begin_layout Description
5454 Origin sts, 06 January 2008
5457 \begin_layout Subsection*
5458 math-macro-add-optional-param
5461 \begin_layout Description
5462 Action Add an optional parameter.
5465 \begin_layout Description
5466 Notion Insert an optional parameter just behind the already existing optional
5470 \begin_layout Description
5471 Syntax math-macro-add-optional-param
5474 \begin_layout Description
5475 Origin sts, 06 January 2008
5478 \begin_layout Subsection*
5479 math-macro-add-param
5482 \begin_layout Description
5483 Action Add a parameter.
5486 \begin_layout Description
5487 Notion Add a parameter to a Math Macro.
5490 \begin_layout Description
5491 Syntax math-macro-add-param <NUM>
5494 \begin_layout Description
5495 Params <NUM>: The number of the parameter behind which the new one will
5496 be added (1 for the first, i.e.
5497 use 0 for add a parameter at the left), defaults to the last one.
5500 \begin_layout Description
5501 Origin sts, 06 January 2008
5504 \begin_layout Subsection*
5505 math-macro-append-greedy-param
5508 \begin_layout Description
5509 Action Append a greedy parameter.
5512 \begin_layout Description
5513 Notion Append a greedy parameter to a Math Macro which eats the following
5514 mathed cell in every instance of the macro in the buffer.
5517 \begin_layout Description
5518 Syntax math-macro-append-greedy-param
5521 \begin_layout Description
5522 Origin sts, 06 January 2008
5525 \begin_layout Subsection*
5529 \begin_layout Description
5530 Action Fold a Math Macro.
5533 \begin_layout Description
5534 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
5540 \begin_layout Description
5541 Syntax math-macro-fold
5544 \begin_layout Description
5545 Origin sts, 06 January 2008
5548 \begin_layout Subsection*
5549 math-macro-make-nonoptional
5552 \begin_layout Description
5553 Action Make a parameter non-optional.
5556 \begin_layout Description
5557 Notion Turn the last optional parameter of a Math Macro into a non-optional
5559 The default value is remembered to be reused later if the user changes
5563 \begin_layout Description
5564 Syntax math-macro-make-nonoptional
5567 \begin_layout Description
5568 Origin sts, 06 January 2008
5571 \begin_layout Subsection*
5572 math-macro-make-optional
5575 \begin_layout Description
5576 Action Make a parameter optional.
5579 \begin_layout Description
5580 Notion Turn the first non-optional parameter of a Math Macro into an optional
5581 parameter with a default value.
5584 \begin_layout Description
5585 Syntax math-macro-make-optional
5588 \begin_layout Description
5589 Origin sts, 06 January 2008
5592 \begin_layout Subsection*
5593 math-macro-remove-greedy-param
5596 \begin_layout Description
5597 Action Remove a greedy parameter.
5600 \begin_layout Description
5601 Notion Remove a greedy parameter of a Math Macro and spit out the values
5602 of it in every instance of the macro in the buffer.
5603 If it is an optional parameter the [valud] format is used.
5606 \begin_layout Description
5607 Syntax math-macro-remove-greedy-param
5610 \begin_layout Description
5611 Origin sts, 06 January 2008
5614 \begin_layout Subsection*
5615 math-macro-remove-optional-param
5618 \begin_layout Description
5619 Action Remove the last optional parameter.
5622 \begin_layout Description
5623 Notion Remove the last optional parameter of a Math Macro and remove it
5624 in all the instances of the macro in the buffer.
5627 \begin_layout Description
5628 Syntax math-macro-remove-optional-param
5631 \begin_layout Description
5632 Origin sts, 06 January 2008
5635 \begin_layout Subsection*
5636 math-macro-remove-param
5639 \begin_layout Description
5640 Action Remove the last parameter.
5643 \begin_layout Description
5644 Notion Remove the last parameter of a Math Macro and remove its value in
5645 all instances of the macro in the buffer.
5648 \begin_layout Description
5649 Syntax math-macro-remove-param <NUM>
5652 \begin_layout Description
5653 Params <NUM>: The number of the parameter to be deleted (1 for the first),
5654 defaults to the last one.
5657 \begin_layout Description
5658 Origin sts, 06 January 2008
5661 \begin_layout Subsection*
5665 \begin_layout Description
5666 Action Unfold a Math Macro.
5669 \begin_layout Description
5670 Notion Unfold the Math Macro the cursor is in, i.e.
5676 \begin_layout Description
5677 Syntax math-macro-unfold
5680 \begin_layout Description
5681 Origin sts, 06 January 2008
5684 \begin_layout Subsection*
5688 \begin_layout Description
5689 Action Inserts a matrix.
5692 \begin_layout Description
5693 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5696 \begin_layout Description
5697 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
5699 1 char) and the horizontal alignments (l, c or r) (i.e.
5703 \begin_layout Description
5704 Sample math-matrix 3 3 bccc
5707 \begin_layout Subsection*
5711 \begin_layout Description
5712 Action In text mode enters math mode (i.e.
5713 puts math insets on the current cursor position), in math mode enters text
5714 mode inside math expression.
5717 \begin_layout Description
5718 Notion If there is some selected text, it puts the text inside created math
5722 \begin_layout Description
5723 Syntax math-mode [on|<ARG>]
5726 \begin_layout Description
5727 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
5729 \begin_inset Newline newline
5732 "on": allow only entering of math mode from text mode.
5735 \begin_layout Description
5736 Origin Alejandro, 4 Jun 1996
5739 \begin_layout Subsection*
5743 \begin_layout Description
5744 Action Mutates the type of math inset to the newly selected one.
5747 \begin_layout Description
5748 Syntax math-mutate <TYPE>
5751 \begin_layout Description
5752 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
5753 multline|gather|flalign
5756 \begin_layout Description
5757 Origin Andre, 23 May 2001
5760 \begin_layout Subsection*
5761 math-number-line-toggle
5764 \begin_layout Description
5765 Action Toggles numbering of the current formula line.
5768 \begin_layout Description
5769 Notion Must be in display formula mode.
5772 \begin_layout Description
5773 Syntax math-number-line-toggle
5776 \begin_layout Description
5777 Origin Alejandro, 18 Jun 1996
5780 \begin_layout Subsection*
5784 \begin_layout Description
5785 Action Toggles numbering/labeling of the current formula.
5788 \begin_layout Description
5789 Notion Must be in display formula mode.
5792 \begin_layout Description
5793 Syntax math-number-toggle
5796 \begin_layout Description
5797 Origin Alejandro, 4 Jun 1996
5800 \begin_layout Subsection*
5804 \begin_layout Description
5805 Action Changes arbitrarily the size used by math fonts inside a context.
5808 \begin_layout Description
5809 Notion Provides an interface to the LaTeX math mode font size commands.
5812 \begin_layout Description
5813 Syntax math-size <STYLE>
5816 \begin_layout Description
5828 \begin_layout Description
5829 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5832 \begin_layout Subsection*
5836 \begin_layout Description
5837 Action Inserts space into math expression.
5840 \begin_layout Description
5841 Notion Use spacebar after entering this space to change type of space.
5844 \begin_layout Description
5845 Syntax math-space [<TYPE>] [<LEN>]
5848 \begin_layout Description
5849 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5850 \begin_inset Newline newline
5853 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5854 \begin_inset Newline newline
5857 custom space: hspace
5858 \begin_inset Newline newline
5861 "," used by default.
5862 \begin_inset Newline newline
5865 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
5867 \begin_inset Newline newline
5870 <LEN>: length for custom spaces (hspace)
5873 \begin_layout Description
5874 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5877 \begin_layout Subsection*
5881 \begin_layout Description
5882 Action Enters subscript expression in math expression.
5885 \begin_layout Description
5886 Syntax math-subscript
5889 \begin_layout Description
5890 Origin vermeer, 12 Dec 2001
5893 \begin_layout Subsection*
5897 \begin_layout Description
5898 Action Enters superscript expression in math expression.
5901 \begin_layout Description
5902 Syntax math-superscript
5905 \begin_layout Description
5906 Origin vermeer, 12 Dec 2001
5909 \begin_layout Subsection*
5913 \begin_layout Description
5914 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
5916 Used by the advanced search dialog.
5919 \begin_layout Description
5920 Notion If there is any selected text, then it is moved inside the created
5924 \begin_layout Description
5925 Syntax regexp-mode [<ARG>]
5928 \begin_layout Description
5929 Params <ARG>: eventual argument (regular expression).
5932 \begin_layout Description
5933 Origin Tommaso, 4 Oct 2008
5936 \begin_layout Section
5937 Buffer Fuctions (File and Window related)
5940 \begin_layout Subsection*
5944 \begin_layout Description
5945 Action Activate the branch.
5948 \begin_layout Description
5949 Syntax branch-activate <BRANCH>
5952 \begin_layout Description
5953 Params <BRANCH>: The branch to activate
5956 \begin_layout Description
5957 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5958 \begin_inset Newline newline
5961 could be used to export a pdf with the answers branch included without one's
5962 having to open LyX and activate the branch manually.
5965 \begin_layout Description
5966 Origin rgh, 27 May 2008
5969 \begin_layout Subsection*
5973 \begin_layout Description
5974 Action Add a branch to the buffer's BranchList.
5977 \begin_layout Description
5978 Syntax branch-add <BRANCH>
5981 \begin_layout Description
5982 Params <BRANCH>: Name of the branch to add
5985 \begin_layout Description
5986 Origin spitz, 7 Jul 2009
5989 \begin_layout Subsection*
5993 \begin_layout Description
5994 Action Create new branch and directly put the branch inset into the document.
5997 \begin_layout Description
5998 Syntax branch-add-insert [<NAME>]
6001 \begin_layout Description
6002 Params <NAME>: Branch name.
6003 If it is not specified, you will be asked.
6006 \begin_layout Description
6007 Origin sanda, 10 Jul 2009
6010 \begin_layout Subsection*
6014 \begin_layout Description
6015 Action De-activate the branch.
6018 \begin_layout Description
6019 Syntax branch-deactivate <BRANCH>
6022 \begin_layout Description
6023 Params <BRANCH>: The branch to deactivate
6026 \begin_layout Description
6027 Origin rgh, 27 May 2008
6030 \begin_layout Subsection*
6034 \begin_layout Description
6035 Action Toggles inversion status of branch inset.
6038 \begin_layout Description
6039 Syntax branch-invert
6042 \begin_layout Description
6043 Origin rgheck, 12 July 2016
6046 \begin_layout Subsection*
6047 branch-master-activate
6050 \begin_layout Description
6051 Action Activate the branch in the master buffer.
6054 \begin_layout Description
6055 Syntax branch-master-activate <BRANCH>
6058 \begin_layout Description
6059 Params <BRANCH>: The branch to activate
6062 \begin_layout Description
6063 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6064 \begin_inset Newline newline
6067 could be used to export a pdf with the answers branch included without one's
6068 having to open LyX and activate the branch manually.
6071 \begin_layout Description
6072 Origin spitz, 30 Sep 2012
6075 \begin_layout Subsection*
6076 branch-master-deactivate
6079 \begin_layout Description
6080 Action De-activate the branch in the master buffer.
6083 \begin_layout Description
6084 Syntax branch-master-deactivate <BRANCH>
6087 \begin_layout Description
6088 Params <BRANCH>: The branch to deactivate
6091 \begin_layout Description
6092 Origin spitz, 30 Sep 2012
6095 \begin_layout Subsection*
6099 \begin_layout Description
6100 Action Rename all branches of a given name in a document.
6103 \begin_layout Description
6104 Syntax branches-rename <OLDNAME> <NEWNAME>
6107 \begin_layout Description
6108 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
6112 \begin_layout Description
6113 Origin spitz, 9 Jul 2009
6116 \begin_layout Subsection*
6120 \begin_layout Description
6121 Action Saves the current buffer to a temporary file.
6124 \begin_layout Description
6125 Notion Saves the current buffer to a file named "#filename#".
6126 This LFUN is called automatically by LyX, to "autosave" the current buffer.
6129 \begin_layout Description
6130 Syntax buffer-auto-save
6133 \begin_layout Subsection*
6137 \begin_layout Description
6138 Action Loads the given child document.
6141 \begin_layout Description
6142 Notion The current document is treated as a parent.
6145 \begin_layout Description
6146 Syntax buffer-child-open <FILE>
6149 \begin_layout Description
6150 Params <FILE>: Filename of the child.
6151 The directory of the parent is assumed by default.
6154 \begin_layout Description
6155 Origin Ale, 28 May 1997
6158 \begin_layout Subsection*
6162 \begin_layout Description
6163 Action Runs chktex for the current document.
6166 \begin_layout Description
6167 Syntax buffer-chktex
6170 \begin_layout Description
6171 Origin Asger, 30 Oct 1997
6174 \begin_layout Subsection*
6178 \begin_layout Description
6179 Action Closes the current buffer.
6182 \begin_layout Description
6183 Notion Closes the current buffer, asking whether to save it, etc, if the
6184 buffer has been modified.
6187 \begin_layout Description
6191 \begin_layout Subsection*
6195 \begin_layout Description
6196 Action Closes all buffers.
6199 \begin_layout Description
6200 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
6204 \begin_layout Description
6205 Syntax buffer-close-all
6208 \begin_layout Subsection*
6212 \begin_layout Description
6213 Action Exports the current buffer (document) to the given format.
6216 \begin_layout Description
6217 Syntax buffer-export [<FORMAT>] [<DEST>]
6220 \begin_layout Description
6221 Params <FORMAT> is either "custom" or one of the formats which you can find
6222 in Tools->Preferences->File formats->Format.
6223 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
6224 for pdflatex) or "ps" for postscript.
6225 \begin_inset Newline newline
6228 In case of "custom" you will be asked for a format you want to start from
6229 and for the command that you want to apply to this format.
6230 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
6231 \begin_inset Newline newline
6234 If absent or "default", then the default output format of the document is
6236 \begin_inset Newline newline
6239 <DEST> If present, this argument provides the export destination filename.
6240 Its containing folder will also be the destination folder, where all the
6241 needed external files will be copied.
6244 \begin_layout Description
6245 Origin Lgb, 29 Jul 1997
6248 \begin_layout Subsection*
6252 \begin_layout Description
6253 Action Opens a dialog for exporting the current buffer.
6256 \begin_layout Description
6257 Syntax buffer-export-as [<FORMAT>]
6260 \begin_layout Description
6261 Params <FORMAT> is the export format initially selected in the dialog.
6262 You can pass any of the formats which you can find in Tools->Preferences->File
6263 formats->Format, provided it has the "document" flag set.
6264 If no format is specified the dialog will start with the default output
6265 format of the current document.
6268 \begin_layout Description
6269 Sample buffer-export-as pdf2
6272 \begin_layout Description
6273 Origin tommaso, 6 Oct 2011
6276 \begin_layout Subsection*
6277 buffer-export-custom
6280 \begin_layout Description
6281 Action Exports the current buffer (document) from the given format using
6282 the given command on it.
6285 \begin_layout Description
6286 Syntax buffer-export-custom <FORMAT> <COMMAND>
6289 \begin_layout Description
6290 Params <FORMAT> format to start from (LyX will care to produce such intermediate
6292 \begin_inset Newline newline
6295 <COMMAND> this command will be launched on the file.
6296 Note that you can use "$$FName" string to qualify the intermediate file.
6299 \begin_layout Description
6300 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6303 \begin_layout Description
6304 Origin leeming, 27 Mar 2004
6307 \begin_layout Subsection*
6308 buffer-external-modification-clear
6311 \begin_layout Description
6312 Action Clear the external modification flag on the current buffer.
6315 \begin_layout Description
6316 Syntax buffer-external-modification-clear
6319 \begin_layout Description
6320 Origin gm, 2 March 2017
6323 \begin_layout Subsection*
6327 \begin_layout Description
6328 Action Applies a command to all non-hidden buffers.
6331 \begin_layout Description
6332 Notion a buffer is `hidden' if it is internally open in LyX, but not visible
6336 \begin_layout Description
6337 Syntax buffer-forall <LFUN-COMMAND>
6340 \begin_layout Description
6341 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6344 \begin_layout Description
6345 Sample Close all Notes in buffers:
6346 \begin_inset Newline newline
6349 buffer-forall inset-forall Note inset-toggle close
6350 \begin_inset Newline newline
6353 Toggle change tracking on buffers:
6354 \begin_inset Newline newline
6357 buffer-forall changes-track
6358 \begin_inset Newline newline
6361 Toggle read-only for buffers:
6362 \begin_inset Newline newline
6365 buffer-forall buffer-toggle-read-only
6366 \begin_inset Newline newline
6369 Show statistics for individual buffers:
6370 \begin_inset Newline newline
6373 buffer-forall statistics
6374 \begin_inset Newline newline
6377 Activate the branch named "Solutions" in buffers:
6378 \begin_inset Newline newline
6381 buffer-forall branch-activate Solutions
6382 \begin_inset Newline newline
6385 Export buffers to PDF (pdflatex):
6386 \begin_inset Newline newline
6389 buffer-forall buffer-export pdf2
6390 \begin_inset Newline newline
6396 \begin_layout Description
6397 Origin skostysh, 20 Jul 2012
6400 \begin_layout Subsection*
6404 \begin_layout Description
6405 Action Import a given file as a lyx document.
6408 \begin_layout Description
6409 Notion File can be imported iff lyx file format is (transitively) reachable
6410 via defined converters in preferences.
6411 Look in the File->Import menu to get an idea of the currently active import
6415 \begin_layout Description
6416 Syntax buffer-import <FORMAT> [<FILE>]
6419 \begin_layout Description
6420 Origin Asger, 24 Jul 1998
6423 \begin_layout Subsection*
6427 \begin_layout Description
6428 Action Set language of the current document.
6431 \begin_layout Description
6432 Syntax buffer-language <LANG>
6435 \begin_layout Description
6436 Params <LANG>: language name.
6437 See lib/languages for list.
6440 \begin_layout Description
6441 Origin leeming, 30 Mar 2004
6444 \begin_layout Subsection*
6448 \begin_layout Description
6449 Action Moves the current tab one spot to the right.
6452 \begin_layout Description
6453 Syntax buffer-move-next
6456 \begin_layout Description
6457 Origin skostysh, 7 Apr 2015
6460 \begin_layout Subsection*
6461 buffer-move-previous
6464 \begin_layout Description
6465 Action Moves the current tab one spot to the left.
6468 \begin_layout Description
6469 Syntax buffer-move-previous
6472 \begin_layout Description
6473 Origin skostysh, 7 Apr 2015
6476 \begin_layout Subsection*
6480 \begin_layout Description
6481 Action Creates a new buffer (that is, document) and switches to it.
6484 \begin_layout Description
6485 Notion Implicit path can be set in Preferences dialog.
6488 \begin_layout Description
6489 Syntax buffer-new [<FILE>]
6492 \begin_layout Description
6493 Params <FILE>: filename of created file with absolute path.
6496 \begin_layout Subsection*
6500 \begin_layout Description
6501 Action Creates a new buffer (that is, document) from a template.
6504 \begin_layout Description
6505 Notion Path for new files and templates can be set in Preferences dialog.
6506 Template will be asked for via Open-dialog.
6509 \begin_layout Description
6510 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
6513 \begin_layout Description
6514 Params <FILE>: filename of created file with absolute path.
6515 If empty or "newfile", a file with appropriate name is generated.
6516 <TEMPLATE FILE>: filename of template with absolute path.
6517 If empty, a dialog is opened to select the new file.
6520 \begin_layout Subsection*
6524 \begin_layout Description
6525 Action Switch to the next opened document.
6528 \begin_layout Description
6529 Notion Note that this does not necessarily mean next in tabbar (for full
6530 list see View menu).
6533 \begin_layout Description
6537 \begin_layout Subsection*
6541 \begin_layout Description
6542 Action Apply the given settings to the current document.
6545 \begin_layout Description
6546 Syntax buffer-params-apply [<ARGS>]
6549 \begin_layout Description
6550 Params <ARGS>: contains the particular settings to be saved.
6551 They obey the syntax you can find in document header of usual .lyx file.
6554 \begin_layout Description
6555 Origin leeming, 30 Mar 2004
6558 \begin_layout Subsection*
6562 \begin_layout Description
6563 Action Switch to the previous opened document.
6566 \begin_layout Description
6567 Syntax buffer-previous
6570 \begin_layout Subsection*
6574 \begin_layout Description
6575 Action Reverts opened document.
6578 \begin_layout Description
6579 Syntax buffer-reload [dump]
6582 \begin_layout Description
6583 Params dump: do not ask for any confirmation, just reload.
6584 All changes will be lost.
6587 \begin_layout Description
6588 Origin Asger, 2 Feb 1997
6591 \begin_layout Subsection*
6595 \begin_layout Description
6596 Action Removes the auxiliary file before next export to assure export is
6600 \begin_layout Description
6601 Syntax buffer-reset-export
6604 \begin_layout Description
6605 Origin spitz, 27 Dec 2019
6608 \begin_layout Subsection*
6609 buffer-save-as-default
6612 \begin_layout Description
6613 Action Save the current document settings as default.
6616 \begin_layout Description
6617 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6620 \begin_layout Description
6621 Syntax buffer-save-as-default [<ARGS>]
6624 \begin_layout Description
6625 Params <ARGS>: contains the particular settings to be saved.
6626 They obey the syntax you can find in document header of usual .lyx file.
6629 \begin_layout Description
6630 Origin leeming, 30 Mar 2004
6633 \begin_layout Subsection*
6637 \begin_layout Description
6638 Action Display and switch to the given buffer.
6641 \begin_layout Description
6642 Syntax buffer-switch <BUFFER>
6645 \begin_layout Description
6646 Params <BUFFER>: path and filename of already opened (but possibly hidden)
6647 document which is to be shown.
6650 \begin_layout Subsection*
6651 buffer-toggle-compression
6654 \begin_layout Description
6655 Action Toggles compression of the current document on/off.
6658 \begin_layout Description
6659 Syntax buffer-toggle-compression
6662 \begin_layout Description
6663 Origin bpeng, 27 Apr 2006
6666 \begin_layout Subsection*
6667 buffer-toggle-read-only
6670 \begin_layout Description
6671 Action Toggle editing mode of the current document between read/write and
6675 \begin_layout Description
6676 Notion This function is not allowed if the file is under version control,
6677 since read-only flag is often used in version control file locking.
6680 \begin_layout Description
6681 Syntax buffer-toggle-read-only
6684 \begin_layout Description
6685 Origin Lgb, 27 May 1997
6688 \begin_layout Subsection*
6692 \begin_layout Description
6693 Action Exports the current document and put the result into the temporary
6697 \begin_layout Description
6698 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6699 EW) the output will be rewritten - updated.
6700 This is useful in case your viewer is able to detect such changes (e.g.
6701 ghostview for postscript).
6704 \begin_layout Description
6705 Syntax buffer-update [<FORMAT>]
6708 \begin_layout Description
6709 Params <FORMAT>: The format to display, where this is one of the formats
6710 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6711 If no format is given, the default format as specified in the same dialog
6715 \begin_layout Description
6716 Origin Dekel, 5 Aug 2000
6719 \begin_layout Subsection*
6723 \begin_layout Description
6724 Action Displays current buffer in chosen format.
6727 \begin_layout Description
6728 Notion Displays the contents of the current buffer in the chosen format,
6729 for example, PDF or DVI.
6730 This runs the necessary converter, calls the defined viewer, and so forth.
6733 \begin_layout Description
6734 Syntax buffer-view [<FORMAT>]
6737 \begin_layout Description
6738 Params <FORMAT>: The format to display, where this is one of the formats
6739 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6740 If no format is given, the default format as specified in the same dialog
6744 \begin_layout Subsection*
6748 \begin_layout Description
6749 Action Opens the file that was created from last preview of this buffer.
6752 \begin_layout Description
6753 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX
6755 It can also be called by the user, which is useful if the document takes
6756 a long time to compile, and you just want to see the last previewed version.
6759 \begin_layout Description
6760 Syntax buffer-view-cache
6763 \begin_layout Subsection*
6767 \begin_layout Description
6768 Action Saves the current buffer.
6771 \begin_layout Description
6772 Notion Saves the current buffer to disk, using the filename that is already
6773 associated with the buffer, asking for one if none is yet assigned.
6776 \begin_layout Description
6777 Syntax buffer-write [force]
6780 \begin_layout Description
6781 Params force: write even if buffer is clean.
6784 \begin_layout Subsection*
6788 \begin_layout Description
6789 Action Save all changed documents.
6792 \begin_layout Description
6793 Syntax buffer-write-all
6796 \begin_layout Description
6797 Origin rgh, gpothier 6 Aug 2007
6800 \begin_layout Subsection*
6804 \begin_layout Description
6805 Action Rename and save current buffer.
6808 \begin_layout Description
6809 Syntax buffer-write-as <FILENAME>
6812 \begin_layout Description
6813 Params <FILENAME>: New name of the buffer/file.
6814 A relative path is with respect to the original location of the buffer/file.
6817 \begin_layout Subsection*
6818 buffer-write-as-template
6821 \begin_layout Description
6822 Action Rename and save current buffer in the local templates directory.
6825 \begin_layout Description
6826 Syntax buffer-write-as-template <FILENAME>
6829 \begin_layout Description
6830 Params <FILENAME>: New name of the buffer/file.
6831 A relative path is with respect to the original location of the
6835 \begin_layout Subsection*
6839 \begin_layout Description
6840 Action Sets the zoom of the screen fonts.
6843 \begin_layout Description
6844 Syntax buffer-zoom [<ZOOM>]
6847 \begin_layout Description
6848 Params <ZOOM>: The target zoom value in %; the default is the default zoom
6849 as saved in preferences.
6852 \begin_layout Description
6853 Origin daniel, 28 Oct 2016
6856 \begin_layout Subsection*
6860 \begin_layout Description
6861 Action Increases the zoom of the screen fonts.
6864 \begin_layout Description
6865 Syntax buffer-zoom-in [<ZOOM>]
6868 \begin_layout Description
6869 Params <ZOOM>: The zoom value addition in % (neg.
6870 or pos.); the default is 10% of the default zoom as saved in preferences.
6873 \begin_layout Description
6874 Origin vfr, 30 Mar 2009
6877 \begin_layout Subsection*
6881 \begin_layout Description
6882 Action Decreases the zoom of the screen fonts.
6885 \begin_layout Description
6886 Syntax buffer-zoom-out [<ZOOM>]
6889 \begin_layout Description
6890 Params <ZOOM>: The zoom value abstraction in % (neg.
6891 or pos.); the default is 10% of the default zoom as saved in preferences.
6894 \begin_layout Description
6895 Origin vfr, 30 Mar 2009
6898 \begin_layout Subsection*
6902 \begin_layout Description
6903 Action Generates the code (literate programming).
6906 \begin_layout Description
6907 Notion Latex file with extension
6909 literate_extension is generated.
6912 build_command (with a default of ``make'') to generate the code and
6914 build_error_filter to process the compilation error messages.
6915 \begin_inset Newline newline
6918 In case you want to process your literate file with a script, or some other
6919 program, just insert in your lyxrc file an entry with:
6920 \begin_inset Newline newline
6925 build_command "my_script my_arguments"
6926 \begin_inset Newline newline
6931 build_error_filter differs from the
6933 literate_error_filter only in that the former will identify error messages
6937 \begin_layout Description
6938 Syntax build-program
6941 \begin_layout Subsection*
6945 \begin_layout Description
6946 Action Open LyX document.
6949 \begin_layout Description
6950 Syntax file-open [<FILE>]
6953 \begin_layout Description
6954 Params <FILE>: Filename to be opened.
6957 \begin_layout Subsection*
6961 \begin_layout Description
6962 Action Open the given help file according to the language setting.
6965 \begin_layout Description
6966 Syntax help-open <FILE>[.lyx]
6969 \begin_layout Description
6970 Params <FILE>: any document from (/usr/share/)doc directory.
6973 \begin_layout Description
6974 Origin Jug, 27 Jun 1999
6977 \begin_layout Subsection*
6981 \begin_layout Description
6982 Action Sets icon size of toolbars.
6985 \begin_layout Description
6986 Syntax icon-size [<SIZE>]
6989 \begin_layout Description
6990 Params <SIZE> : the icon size in px or one of the logical settings small|normal|
6991 big|huge|giant, the default is normal (whose size in px is icon set dependent).
6994 \begin_layout Description
6998 \begin_layout Subsection*
7002 \begin_layout Description
7003 Action Helper function for master-related actions
7006 \begin_layout Description
7007 Notion In a buffer, the function will be disabled if the buffer has no master
7009 It thus allows to enable actions only in documents with master/children
7012 \begin_layout Description
7013 Syntax ifrelatives <ACTION>
7016 \begin_layout Description
7017 Origin spitz, 2 January 2020
7020 \begin_layout Subsection*
7024 \begin_layout Description
7025 Action Terminates the current LyX instance.
7028 \begin_layout Description
7029 Notion Terminates the current LyX instance, asking whether to save modified
7033 \begin_layout Description
7037 \begin_layout Subsection*
7041 \begin_layout Description
7042 Action Open lyxfiles (templates/examples).
7043 Create a view if he have none.
7046 \begin_layout Description
7047 Syntax lyxfiles-open [<TYPE>]
7050 \begin_layout Description
7051 Params <TYPE>: templates or examples.
7052 Default is templates.
7055 \begin_layout Description
7056 Origin spitz, 10 Feb 2021
7059 \begin_layout Subsection*
7060 master-buffer-export
7063 \begin_layout Description
7064 Action Exports the master buffer (document) to the given format.
7067 \begin_layout Description
7068 Syntax master-buffer-export [<FORMAT>] [<DEST>]
7071 \begin_layout Description
7072 Params <FORMAT> is one of the formats which you can find in Tools->Preferences->
7073 File formats->Format.
7074 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
7075 for pdflatex) or "ps" for postscript.
7076 \begin_inset Newline newline
7079 Note that "custom" is not allowed in this case.
7080 \begin_inset Newline newline
7083 If absent or "default", then the default output format of the document is
7085 \begin_inset Newline newline
7088 <DEST> If present, this argument provides the export destination filename.
7089 Its containing folder will also be the destination folder, where all the
7090 needed external files will be copied.
7093 \begin_layout Description
7094 Origin rkh, 18 April 2018
7097 \begin_layout Subsection*
7098 master-buffer-forall
7101 \begin_layout Description
7102 Action Applies a command to a buffer and all it children, starting from
7106 \begin_layout Description
7107 Syntax master-buffer-forall <LFUN-COMMAND>
7110 \begin_layout Description
7111 Params <LFUN-COMMAND>: The command to be applied to the buffers.
7114 \begin_layout Description
7115 Sample Close all Notes in buffers:
7116 \begin_inset Newline newline
7119 master-buffer-forall inset-forall Note inset-toggle close
7120 \begin_inset Newline newline
7123 Toggle change tracking on buffers:
7124 \begin_inset Newline newline
7127 master-buffer-forall changes-track
7128 \begin_inset Newline newline
7131 Toggle read-only for buffers:
7132 \begin_inset Newline newline
7135 master-buffer-forall buffer-toggle-read-only
7136 \begin_inset Newline newline
7139 Show statistics for individual buffers:
7140 \begin_inset Newline newline
7143 master-buffer-forall statistics
7144 \begin_inset Newline newline
7147 Activate the branch named "Solutions" in buffers:
7148 \begin_inset Newline newline
7151 master-buffer-forall branch-activate Solutions
7152 \begin_inset Newline newline
7158 \begin_layout Description
7159 Origin spitz, 31 Dec 2019
7162 \begin_layout Subsection*
7163 master-buffer-update
7166 \begin_layout Description
7167 Action Update (export) the document built from the master buffer, if the
7168 current buffer is part of a master/child document.
7171 \begin_layout Description
7172 Syntax master-buffer-update [<FORMAT>]
7175 \begin_layout Description
7176 Params <FORMAT>: The format to display, where this is one of the formats
7177 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7178 If no format is given, the default format as specified in the same dialog
7182 \begin_layout Description
7183 Origin Tommaso, 20 Sep 2007
7186 \begin_layout Subsection*
7190 \begin_layout Description
7191 Action Show a preview built from the master buffer, if available.
7192 if the current buffer is part of a master/child document.
7195 \begin_layout Description
7196 Syntax master-buffer-view [<FORMAT>]
7199 \begin_layout Description
7200 Params <FORMAT>: The format to display, where this is one of the formats
7201 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7202 If no format is given, the default format as specified in the same dialog
7206 \begin_layout Description
7207 Origin Tommaso, 20 Sep 2007
7210 \begin_layout Subsection*
7214 \begin_layout Description
7215 Action Opens the menu given by its name.
7218 \begin_layout Description
7219 Syntax menu-open <NAME>
7222 \begin_layout Description
7223 Params <NAME>: menu name.
7224 See various .inc files in lib/ui for candidates.
7227 \begin_layout Subsection*
7231 \begin_layout Description
7232 Action Close the current tab group.
7235 \begin_layout Description
7236 Notion This only closes the work areas, not the buffers themselves.
7237 The still opened buffers can be visualized in another tab group.
7240 \begin_layout Description
7241 Syntax tab-group-close
7244 \begin_layout Description
7245 Origin Abdel, 21 Feb 2008
7248 \begin_layout Subsection*
7252 \begin_layout Description
7253 Action Toggles movability of a given toolbar between true/false.
7256 \begin_layout Description
7257 Syntax toolbar-movable <NAME>
7260 \begin_layout Description
7261 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|
7262 view/update|math_panels|vcs| view-others|update-others
7265 \begin_layout Description
7266 Origin daniel, 12 July 2016
7269 \begin_layout Subsection*
7273 \begin_layout Description
7274 Action Sets visibility of a given toolbar to on, off, or auto.
7277 \begin_layout Description
7278 Notion Skipping "auto" when allowauto is false.
7281 \begin_layout Description
7282 Syntax toolbar-set <NAME> [on|off|auto]
7285 \begin_layout Description
7286 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
7287 \begin_inset Newline newline
7290 minibuffer|review|view/update|math_panels|vcs| view-others|upd
7294 \begin_layout Description
7295 Origin spitz, 17 Dec 2020
7298 \begin_layout Subsection*
7302 \begin_layout Description
7303 Action Toggles visibility of a given toolbar between on/off/auto.
7306 \begin_layout Description
7307 Notion Skipping "auto" when allowauto is false.
7310 \begin_layout Description
7311 Syntax toolbar-toggle <NAME> [allowauto]
7314 \begin_layout Description
7315 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
7316 \begin_inset Newline newline
7319 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
7322 \begin_layout Description
7323 Origin Edwin, 21 May 2007
7326 \begin_layout Subsection*
7330 \begin_layout Description
7331 Action Various UI visibility-toggling actions.
7334 \begin_layout Description
7335 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
7338 \begin_layout Description
7339 Params statusbar : Toggle visibility of the statusbar.
7340 \begin_inset Newline newline
7343 menubar : Toggle visibility of the menubar.
7344 \begin_inset Newline newline
7347 scrollbar : Toggle visibility of the scrollbar.
7348 \begin_inset Newline newline
7351 frame : Toggle visibility of the frames around editing window.
7352 \begin_inset Newline newline
7355 fullscreen : Toggle fullscreen mode.
7356 This also covers calling the previous functions.
7357 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
7361 \begin_layout Description
7362 Origin sanda, 9 Feb 2007
7365 \begin_layout Subsection*
7369 \begin_layout Description
7370 Action Close the current document work area.
7373 \begin_layout Description
7374 Notion Close the current work area.
7375 If no other work areas are showing the buffer, then close the associated
7379 \begin_layout Description
7383 \begin_layout Description
7384 Origin Tommaso, 15 Sep 2012
7387 \begin_layout Subsection*
7391 \begin_layout Description
7392 Action Creates another split view of current buffer.
7395 \begin_layout Description
7396 Notion All split views act in the same way independently.
7399 \begin_layout Description
7400 Syntax view-split <vertical|horizontal>
7403 \begin_layout Description
7404 Params horizontal : The work areas are laid out side by side.
7405 \begin_inset Newline newline
7408 vertical : The work areas laid out vertically.
7411 \begin_layout Description
7412 Origin Abdel, 20 Feb 2008
7415 \begin_layout Subsection*
7419 \begin_layout Description
7420 Action Closes the current LyX window.
7423 \begin_layout Description
7427 \begin_layout Description
7428 Origin Abdel, 23 Oct 2006
7431 \begin_layout Subsection*
7435 \begin_layout Description
7436 Action Creates new empty LyX window.
7439 \begin_layout Description
7440 Notion Already opened documents from the previous window can be found under
7444 \begin_layout Description
7445 Syntax window-new [<GEOMETRY>]
7448 \begin_layout Description
7449 Params <GEOMETRY>: pass the geometry of the window.
7450 This parameter is currently accepted only on Windows platform.
7453 \begin_layout Description
7454 Origin Abdel, 21 Oct 2006
7457 \begin_layout Section
7458 System Functions (Preferences, LyX Server etc.)
7461 \begin_layout Subsection*
7462 buffer-toggle-output-sync
7465 \begin_layout Description
7466 Action Toggles including of resources for forward/reverse search of the
7470 \begin_layout Description
7471 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
7473 Custom LaTeX macro can be defined in preferences.
7476 \begin_layout Description
7477 Syntax buffer-toggle-output-sync
7480 \begin_layout Description
7481 Origin sanda, 25 May 2010
7484 \begin_layout Subsection*
7488 \begin_layout Description
7489 Action Executes a command defined in a .def file.
7492 \begin_layout Description
7493 Notion The definitions are by default read from lib/commands/default.def.
7494 \begin_inset Newline newline
7497 A .def file allows to define a command with
7499 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
7500 <LFUN> is the lfun code to be executed (see e.g.
7501 LFUN_COMMAND_SEQUENCE).
7504 def_file "FileName" allows to include another .def file.
7505 \begin_inset Newline newline
7508 This is particularly useful in connection with toolbar buttons: Since the
7509 name of the button image for this lfun is lib/images/commands/<NAME>.png
7510 this is the way to assign an image to a complex command-sequence.
7513 \begin_layout Description
7517 \begin_layout Description
7518 Params <NAME>: Name of the command that must be called.
7521 \begin_layout Description
7522 Origin broider, 2 Oct 2007
7525 \begin_layout Subsection*
7529 \begin_layout Description
7530 Action Cancels sequence prepared by LFUN_META_PREFIX .
7533 \begin_layout Description
7537 \begin_layout Subsection*
7538 command-alternatives
7541 \begin_layout Description
7542 Action Runs the first listed command that is enabled.
7545 \begin_layout Description
7546 Notion This can be used to bind multiple functions to a single key, and
7547 then which one is used will depend upon the context.
7550 \begin_layout Description
7551 Syntax command-alternatives <CMDS>
7554 \begin_layout Description
7555 Params <CMDS>: Sequence of commands separated by semicolons.
7558 \begin_layout Description
7559 Sample command-alternatives completion-accept;cell-forward
7562 \begin_layout Description
7563 Origin rgh, 24 September 2008
7566 \begin_layout Subsection*
7570 \begin_layout Description
7571 Action Run more commands (LFUN and its parameters) in a sequence.
7574 \begin_layout Description
7575 Syntax command-sequence <CMDS>
7578 \begin_layout Description
7579 Params <CMDS>: Sequence of commands separated by semicolons.
7582 \begin_layout Description
7583 Sample command-sequence cut; ert-insert; self-insert
7585 ; paste; self-insert {}; inset-toggle;
7588 \begin_layout Description
7589 Origin Andre, 11 Nov 1999
7592 \begin_layout Subsection*
7593 cursor-follows-scrollbar-toggle
7596 \begin_layout Description
7597 Action Determine whether to keep cursor inside the editing window regardless
7598 of the scrollbar movement.
7601 \begin_layout Description
7602 Syntax toggle-cursor-follows-scrollbar
7605 \begin_layout Description
7606 Origin ARRae, 2 Dec 1997
7609 \begin_layout Subsection*
7613 \begin_layout Description
7614 Action Set debug output level.
7617 \begin_layout Description
7618 Syntax debug-level-set <LEVEL>
7621 \begin_layout Description
7622 Params <LEVEL>: comma separated list of levels or the correspondent number
7623 of their combination.
7624 0 is equivalent to disabling all debug events.
7625 See lyx -dbg for the current list of debug levels and their numbers.
7628 \begin_layout Description
7629 Origin sanda, 28 Dec 2009
7632 \begin_layout Subsection*
7636 \begin_layout Description
7637 Action toggle a mode where more information is given in UI
7640 \begin_layout Description
7641 Notion in so called "devel" mode, the information given in the status bar
7642 is more precise, and the help documents are open in editing mode.
7645 \begin_layout Description
7646 Syntax devel-mode-toggle
7649 \begin_layout Description
7650 Origin lasgouttes, 23 Jul 2017
7653 \begin_layout Subsection*
7657 \begin_layout Description
7658 Action Sets the cursor position in the previewed (dvi/pdf) file based on
7659 the row number in LyX window.
7662 \begin_layout Description
7663 Notion The external program used for forward search call can be specified
7664 in LyX Output preferences.
7665 See Additional manual for details of these settings.
7668 \begin_layout Description
7669 Syntax forward-search
7672 \begin_layout Description
7673 Origin sanda, 14 Apr 2010
7676 \begin_layout Subsection*
7680 \begin_layout Description
7681 Action Apply the given settings to user preferences.
7684 \begin_layout Description
7685 Syntax lyxrc-apply <SETTINGS>
7688 \begin_layout Description
7689 Params <SETTINGS>: settings which are to be set.
7690 Take a look into ~/.lyx/preferences to get an idea which commands to use
7692 lyx::LyXRC::LyXRCTags has the list of possible commands.
7695 \begin_layout Subsection*
7699 \begin_layout Description
7700 Action Shows message in statusbar (for script purposes).
7703 \begin_layout Description
7704 Syntax message <STRING>
7707 \begin_layout Description
7708 Origin Lgb, 8 Apr 2001
7711 \begin_layout Subsection*
7715 \begin_layout Description
7716 Action Simulate halting Meta key (Alt key on PCs).
7719 \begin_layout Description
7720 Notion Used for buffer edition not for GUI control.
7723 \begin_layout Description
7727 \begin_layout Subsection*
7731 \begin_layout Description
7732 Action Save user preferences.
7735 \begin_layout Description
7736 Syntax preferences-save
7739 \begin_layout Description
7740 Origin Lgb, 27 Nov 1999
7743 \begin_layout Subsection*
7747 \begin_layout Description
7748 Action Reconfigure the automatic settings.
7751 \begin_layout Description
7755 \begin_layout Description
7756 Origin Asger, 14 Feb 1997
7759 \begin_layout Subsection*
7763 \begin_layout Description
7764 Action Enables/disables searching for features in findadv
7767 \begin_layout Description
7768 Syntax search-ignore <type> <value>
7771 \begin_layout Description
7772 Params <type>: language|color|sectioning|font|series|shape|family|markup|underli
7774 \begin_inset Newline newline
7780 \begin_layout Subsection*
7784 \begin_layout Description
7785 Action Returns path and file name of the currently edited document.
7788 \begin_layout Description
7789 Syntax server-get-filename
7792 \begin_layout Subsection*
7796 \begin_layout Description
7797 Action Returns the current layout (that is environment) name on the cursor
7801 \begin_layout Description
7802 Syntax server-get-layout
7805 \begin_layout Subsection*
7806 server-get-statistics
7809 \begin_layout Description
7810 Action Returns the statistics (number of words and characters) in the document
7811 or in the given selection.
7814 \begin_layout Description
7815 Notion Note that this function gives the number of words/chars written,
7816 not the number of characters which will be typeset.
7819 \begin_layout Description
7820 Syntax server-get-statistics [<TYPE>]
7823 \begin_layout Description
7824 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified,
7825 the three values are returned, separated by a space.
7826 \begin_inset Newline newline
7830 \begin_inset Newline newline
7833 chars: count characters.
7834 \begin_inset Newline newline
7837 chars-space: count characters and spaces.
7840 \begin_layout Description
7841 Origin brokenclock, Oct 10 2014
7844 \begin_layout Subsection*
7848 \begin_layout Description
7849 Action Returns the coordinates of cursor position in the editing area.
7852 \begin_layout Description
7853 Syntax server-get-xy
7856 \begin_layout Subsection*
7857 server-goto-file-row
7860 \begin_layout Description
7861 Action Sets the cursor position in LyX based on the row number of generated
7865 \begin_layout Description
7866 Notion This can be useful for DVI inverse-search or detection of the problematic
7867 line from LaTeX compilation.
7868 Note that before this function can be used export to LaTeX output must
7869 occur (in order to map the row numbers).
7872 \begin_layout Description
7873 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
7876 \begin_layout Description
7877 Params <FILE>: the path and filename.
7878 Environment variables are expanded in the path.
7879 In case this LFUN does not work make sure you are giving correct path to
7881 \begin_inset Newline newline
7884 If the file is located inside LyX temporary directory it will be mapped
7885 back into the appropriate opened buffer (e.g.
7886 for the case of generated .tex file).
7887 \begin_inset Newline newline
7890 .ext: extensions will be automatically replaced by .lyx.
7891 \begin_inset Newline newline
7894 <ROW_NUMBER> The row number of the LaTeX file to which to go.
7897 \begin_layout Description
7898 Sample server-goto-file-row /home/user/example.lyx 41
7899 \begin_inset Newline newline
7902 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
7905 \begin_layout Description
7906 Origin Edmar, 23 Dec 1998
7909 \begin_layout Subsection*
7913 \begin_layout Description
7914 Action Sends notify message about the last key-sequence to client.
7917 \begin_layout Description
7918 Notion This can be used to grab last key-sequence used inside the LyX window.
7919 See also Debug extensions section in Additional features manual.
7922 \begin_layout Description
7923 Syntax server-notify
7926 \begin_layout Subsection*
7930 \begin_layout Description
7931 Action Sets the cursor position based on the editing area coordinates (similar
7932 to clicking on that point with left mouse button).
7935 \begin_layout Description
7936 Syntax server-set-xy <X> <Y>
7939 \begin_layout Subsection*
7943 \begin_layout Description
7944 Action Set the given LyX color to the color defined by the X11 name given,
7945 and optionally a specific color for dark mode.
7948 \begin_layout Description
7949 Notion A new color entry is created if the color is unknown.
7950 Color names can be stored as a part of user settings.
7953 \begin_layout Description
7954 Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
7957 \begin_layout Description
7958 Origin SLior, 11 Jun 2000
7961 \begin_layout Subsection*
7965 \begin_layout Description
7966 Action Count the statistics (number of words and characters) in the document
7967 or in the given selection and display it in a dialog box.
7970 \begin_layout Description
7971 Notion Note that this function gives the number of words/chars written,
7972 not the number of characters which will be typeset.
7975 \begin_layout Description
7979 \begin_layout Description
7980 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7983 \begin_layout Subsection*
7987 \begin_layout Description
7988 Action Checks-in/commits the changes of the registered file to the repository.
7991 \begin_layout Description
7992 Notion In RCS case this also unlocks the file.
7995 \begin_layout Description
7999 \begin_layout Description
8000 Origin Lgb, 1 Jul 1997
8003 \begin_layout Subsection*
8007 \begin_layout Description
8008 Action Checks-out the document for edit (and locks it in some cases).
8011 \begin_layout Description
8015 \begin_layout Description
8016 Origin Lgb, 1 Jul 1997
8019 \begin_layout Subsection*
8023 \begin_layout Description
8024 Action Executes external command.
8025 This command is intended to support additional VCS commands.
8028 \begin_layout Description
8029 Syntax vc-command <FLAG> <PATH> <COMMAND>
8032 \begin_layout Description
8033 Params <FLAG>: Flags for the command can be combined together.
8034 \begin_inset Newline newline
8037 U - dUmmy - no flags
8038 \begin_inset Newline newline
8041 D - Doc - need document loaded to proceed
8042 \begin_inset Newline newline
8045 I - dIrty - mark document dirty
8046 \begin_inset Newline newline
8049 R - Reload - ensure that the document is saved and reload it after command
8051 \begin_inset Newline newline
8054 M - Message - ask for input string (commit message)
8055 \begin_inset Newline newline
8058 <PATH>: path where to start.
8059 $$p will be replaced by the current document path.
8060 \begin_inset Newline newline
8063 <COMMAND>: command to execute.
8064 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
8068 \begin_layout Description
8069 Sample vc-command DR $$p "svn up"
8072 \begin_layout Description
8073 Origin sanda, 13 Jan 2009
8076 \begin_layout Subsection*
8080 \begin_layout Description
8081 Action Compares two revisions of the same file under version control.
8084 \begin_layout Description
8085 Syntax vc-compare [<REV1>] [<REV2>]
8088 \begin_layout Description
8089 Params Revision number either points directly to commit in history or if
8090 negative number -x it points to (last commit - x).
8091 \begin_inset Newline newline
8094 In RCS we subtract only in the last number of revision specification.
8095 Special case "0" is reserved for the last committed revision.
8096 \begin_inset Newline newline
8100 \begin_inset Newline newline
8104 Used only if REV1 > 0.
8105 \begin_inset Newline newline
8108 If no parameter is given, interactive dialog will be shown.
8111 \begin_layout Description
8112 Sample Compare current document against last commit
8113 \begin_inset Newline newline
8117 \begin_inset Newline newline
8120 Compare current document against current revision - 5 commits
8121 \begin_inset Newline newline
8125 \begin_inset Newline newline
8128 Compare revisions 120 and 155
8129 \begin_inset Newline newline
8135 \begin_layout Description
8136 Origin sanda, 12 Feb 2010
8139 \begin_layout Subsection*
8143 \begin_layout Description
8144 Action Copies the document to another name.
8147 \begin_layout Description
8148 Notion Copying with revision history is only supported by SVN.
8149 For RCS and CVS it is simulated by adding the document under a new name.
8150 Disabled if uncommitted changes exist.
8153 \begin_layout Description
8154 Syntax vc-copy <FILENAME>
8157 \begin_layout Description
8158 Params <FILENAME>: New name of the document.
8159 \begin_inset Newline newline
8162 A file dialog is opened if no filename is given.
8165 \begin_layout Description
8166 Origin gb, 05 Feb 2013
8169 \begin_layout Subsection*
8173 \begin_layout Description
8174 Action Toggles the locking property of the edited file.
8177 \begin_layout Description
8178 Notion This is currently implemented only for SVN.
8181 \begin_layout Description
8182 Syntax vc-locking-toggle
8185 \begin_layout Description
8186 Origin sanda, 25 Jun 2009
8189 \begin_layout Subsection*
8193 \begin_layout Description
8194 Action Register the document as an file inside version control system.
8197 \begin_layout Description
8198 Notion File is registered inside cvs, svn or rcs repository acording to
8199 the existence of cvs/svn/rcs entries in the document's directory.
8200 \begin_inset Newline newline
8203 See LyX Additional Features Manual (Version Control Chapter) for additional
8207 \begin_layout Description
8211 \begin_layout Description
8212 Origin Lgb, 1 Jul 1997
8215 \begin_layout Subsection*
8219 \begin_layout Description
8220 Action Renames the document to another name.
8223 \begin_layout Description
8224 Notion Renaming with revision history is only supported by SVN.
8225 For CVS it is simulated by adding the document under a new name and deleting
8227 For RCS it is not supported.
8228 Disabled if uncommitted changes exist.
8231 \begin_layout Description
8232 Syntax vc-rename <FILENAME>
8235 \begin_layout Description
8236 Params <FILENAME>: New name of the document.
8237 \begin_inset Newline newline
8240 A file dialog is opened if no filename is given.
8243 \begin_layout Description
8244 Origin gb, 05 Feb 2013
8247 \begin_layout Subsection*
8251 \begin_layout Description
8252 Action Update the local archive directory in which resides the current document
8253 with the remote repository.
8256 \begin_layout Description
8257 Syntax vc-repo-update
8260 \begin_layout Description
8261 Origin sanda, 16 Oct 2009
8264 \begin_layout Subsection*
8268 \begin_layout Description
8269 Action Reverts the document to the last check-in/commit in VCS.
8272 \begin_layout Description
8276 \begin_layout Description
8277 Origin Lgb, 1 Jul 1997
8280 \begin_layout Subsection*
8284 \begin_layout Description
8285 Action Undo last check-in.
8288 \begin_layout Description
8289 Notion This is currently implemented only for RCS.
8292 \begin_layout Description
8296 \begin_layout Description
8297 Origin Lgb, 1 Jul 1997
8300 \begin_layout Section
8301 Hidden Functions (not listed for configuration)
8304 \begin_layout Subsection*
8308 \begin_layout Description
8309 Action Return the current key sequence and available options as a string.
8312 \begin_layout Description
8313 Notion No options are added if no current map exists.
8314 \begin_inset Newline newline
8317 This is probably usable only with connection to lyxserver.
8320 \begin_layout Description
8321 Syntax command-prefix
8324 \begin_layout Subsection*
8328 \begin_layout Description
8329 Action Activates the LyX window.
8332 \begin_layout Description
8333 Notion On Linux and Mac OS, this action brings the LyX window into focus.
8334 Such behavior is not allowed by Windows OS so instead the color of the
8335 taskbar entry is changed to indicate that the window has changed in some
8337 This action is useful in combination with reverse search.
8340 \begin_layout Description
8344 \begin_layout Description
8345 Origin skostysh, 4 Aug 2016
8348 \begin_layout Subsection*
8352 \begin_layout Description
8353 Action Inserts the given string (accordingly to the correct keymap).
8356 \begin_layout Description
8357 Notion Automatically replace the currently selected text.
8358 Depends on lyxrc settings "auto_region_delete".
8361 \begin_layout Description
8362 Syntax self-insert <STRING>
8365 \begin_layout Subsection*
8369 \begin_layout Description
8370 Action Raises the LyX window.
8373 \begin_layout Description
8374 Notion Brings the LyX window to the front.
8375 Such behavior is allowed on Windows only when no other application has
8377 This action is used when LyX is in single instance mode.
8380 \begin_layout Description
8384 \begin_layout Description
8385 Origin forenr, 21 Apr 2020