1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
10 \renewenvironment{description}{\list{}{%
11 \setlength{\itemsep}{-2pt}
12 \advance\leftmargini6\p@ \itemindent-12\p@
13 \labelwidth\z@ \let\makelabel\descriptionlabel}%
18 \use_default_options false
19 \maintain_unincluded_children false
27 \language_package default
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
38 \font_sf_scale 100 100
39 \font_tt_scale 100 100
42 \default_output_format default
44 \bibtex_command default
45 \index_command default
46 \paperfontsize default
51 \use_package amsmath 1
52 \use_package amssymb 1
55 \use_package mathdots 0
56 \use_package mathtools 0
58 \use_package stackrel 0
59 \use_package stmaryrd 0
60 \use_package undertilde 0
62 \cite_engine_type default
66 \paperorientation portrait
80 \paragraph_separation indent
81 \paragraph_indentation default
82 \quotes_language english
85 \paperpagestyle default
86 \tracking_changes false
105 \begin_layout Section*
109 \begin_layout Standard
110 This manual documents the
111 \begin_inset Quotes eld
115 \begin_inset Quotes erd
119 These are commands that are used to make \SpecialChar LyX
120 perform specific actions.
122 itself uses these functions internally, and every internal action is
126 \begin_layout Standard
127 LFUNs are also used in the files that define keyboard shortcuts, menu or
129 So if you want to change\SpecialChar breakableslash
130 customize the user interface, you need to deal
132 Furthermore, external programs can use LFUNs to communicate with and
133 \begin_inset Quotes eld
137 \begin_inset Quotes erd
142 Finally, you can also issue LFUNs directly via the so called mini-buffer
143 which can be opened via
146 arg "command-execute"
152 \begin_layout Standard
153 In the following, all LFUNs are listed, categorized by function.
156 \begin_layout Section
157 Layout Functions (Font, Layout and Textclass related)
160 \begin_layout Subsection*
164 \begin_layout Description
165 Action Displays list of layout choices.
168 \begin_layout Description
169 Notion This LFUN opens the dropbox allowing for choice of layout.
172 \begin_layout Description
173 Syntax drop-layouts-choice
176 \begin_layout Subsection*
180 \begin_layout Description
181 Action Splits the current environment with a Separator.
184 \begin_layout Description
185 Syntax environment-split [before|outer|previous]
188 \begin_layout Description
189 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
190 \begin_inset Newline newline
193 previous: If this is given, LyX will split the environment in the previous paragraph (if there is one).
194 \begin_inset Newline newline
197 before: If this is given, the new environment will be appended rather than prepended.
200 \begin_layout Description
201 Origin spitz, 23 Dec 2012
204 \begin_layout Subsection*
208 \begin_layout Description
209 Action Toggles the bold font (selection-wise) using mathbf in math.
212 \begin_layout Description
216 \begin_layout Subsection*
220 \begin_layout Description
221 Action Toggles the bold font (selection-wise) using boldsymbol in math.
224 \begin_layout Description
225 Syntax font-boldsymbol
228 \begin_layout Subsection*
232 \begin_layout Description
233 Action Toggles xout (cross-through) in the font (selection-wise).
236 \begin_layout Description
240 \begin_layout Description
241 Origin uwestoehr, 4 April 2017
244 \begin_layout Subsection*
248 \begin_layout Description
249 Action Reverts the settings of the font to the default values (selection-wise).
252 \begin_layout Description
256 \begin_layout Subsection*
260 \begin_layout Description
261 Action Toggles the emphasis font style (selection-wise).
264 \begin_layout Description
268 \begin_layout Subsection*
272 \begin_layout Description
273 Action Toggles Fraktur family font (math-mode, selection-wise).
276 \begin_layout Description
280 \begin_layout Description
281 Origin vermeer, 10 Jan 2002
284 \begin_layout Subsection*
288 \begin_layout Description
289 Action Toggles Italics font shape (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 nospellcheck status in the font (selection-wise).
308 \begin_layout Description
309 Syntax font-nospellcheck
312 \begin_layout Description
313 Origin spitz, 5 March 2021
316 \begin_layout Subsection*
320 \begin_layout Description
321 Action Toggles Noun text style font (selection-wise).
324 \begin_layout Description
328 \begin_layout Subsection*
332 \begin_layout Description
333 Action Toggles Roman family font (selection-wise).
336 \begin_layout Description
340 \begin_layout Subsection*
344 \begin_layout Description
345 Action Toggles Sans Serif family font (selection-wise).
348 \begin_layout Description
352 \begin_layout Subsection*
356 \begin_layout Description
357 Action Sets font size according to lyx format string.
360 \begin_layout Description
361 Syntax font-size <SIZE>
364 \begin_layout Description
365 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
366 \begin_inset Newline newline
369 largest|huge|giant|increase|decrease|default
372 \begin_layout Subsection*
376 \begin_layout Description
377 Action Returns the info about the current font.
380 \begin_layout Description
384 \begin_layout Subsection*
388 \begin_layout Description
389 Action Toggles strikeout (strike-through) in the font (selection-wise).
392 \begin_layout Description
393 Syntax font-strikeout
396 \begin_layout Description
397 Origin sanda, 3 May 2009
400 \begin_layout Subsection*
404 \begin_layout Description
405 Action Toggles the typewriter family font (selection-wise).
408 \begin_layout Description
409 Syntax font-typewriter
412 \begin_layout Subsection*
416 \begin_layout Description
417 Action Toggles underline in the font (selection-wise).
420 \begin_layout Description
421 Syntax font-underline
424 \begin_layout Subsection*
428 \begin_layout Description
429 Action Toggles double underline in the font (selection-wise).
432 \begin_layout Description
433 Syntax font-underunderline
436 \begin_layout Description
437 Origin sanda, 5 May 2009
440 \begin_layout Subsection*
444 \begin_layout Description
445 Action Toggles wavy underline in the font (selection-wise).
448 \begin_layout Description
449 Syntax font-underwave
452 \begin_layout Description
453 Origin sanda, 5 May 2009
456 \begin_layout Subsection*
460 \begin_layout Description
461 Action Sets the layout (that is, environment) for the current paragraph.
464 \begin_layout Description
465 Syntax layout <LAYOUT> [ignoreautonests]
468 \begin_layout Description
469 Params <LAYOUT>: the layout to use
470 \begin_inset Newline newline
473 ignoreautonests: If specified, nesting advices will be ignored.
476 \begin_layout Subsection*
480 \begin_layout Description
481 Action Adds a module.
484 \begin_layout Description
485 Notion Adds a module to the list of included modules for the current buffer.
488 \begin_layout Description
489 Syntax layout-module-add <MODULE>
492 \begin_layout Description
493 Params <MODULE>: the module to be added
496 \begin_layout Description
497 Origin rgh, 25 August 2007
500 \begin_layout Subsection*
504 \begin_layout Description
505 Action Clears the module list.
508 \begin_layout Description
509 Notion Clears the list of included modules for the current buffer.
512 \begin_layout Description
513 Syntax layout-modules-clear
516 \begin_layout Description
517 Origin rgh, 25 August 2007
520 \begin_layout Subsection*
524 \begin_layout Description
525 Action Launches the paragraph settings dialog.
528 \begin_layout Description
529 Syntax layout-paragraph
532 \begin_layout Subsection*
536 \begin_layout Description
537 Action Reloads layout information.
540 \begin_layout Description
541 Notion Reloads all layout information for the current buffer from disk, thus recognizing any changes that have been made to layout files on the fly. This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
544 \begin_layout Description
548 \begin_layout Description
549 Origin rgh, 3 September 2007
552 \begin_layout Subsection*
556 \begin_layout Description
557 Action Launches the tabular settings dialog.
560 \begin_layout Description
561 Syntax layout-tabular
564 \begin_layout Description
565 Origin Jug, 31 Jul 2000
568 \begin_layout Subsection*
572 \begin_layout Description
573 Action Toggles the layout (that is, environment) for the current paragraph.
576 \begin_layout Description
577 Notion Contrary to `layout', this function resets the current (or selection) layout to the standard layout it already has the correct layout. Useful for toolbar icons.
580 \begin_layout Description
581 Syntax layout-toggle <LAYOUT> [ignoreautonests]
584 \begin_layout Description
585 Params <LAYOUT>: the layout to toggle
586 \begin_inset Newline newline
589 ignoreautonests: If specified, nesting advices will be ignored.
592 \begin_layout Description
593 Origin lasgouttes, 14 May 2018
596 \begin_layout Subsection*
600 \begin_layout Description
601 Action Update fonts and its metrics.
604 \begin_layout Description
605 Notion Automatically called after zoom, dpi, font names, or norm change.
608 \begin_layout Description
609 Syntax screen-font-update
612 \begin_layout Description
613 Origin ARRae, 13 Aug 2000
616 \begin_layout Subsection*
620 \begin_layout Description
621 Action Sets the text class for the current buffer.
624 \begin_layout Description
625 Syntax textclass-apply <TEXTCLASS>
628 \begin_layout Description
629 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
632 \begin_layout Subsection*
636 \begin_layout Description
637 Action Loads information for a textclass from disk.
640 \begin_layout Description
641 Syntax textclass-load <TEXTCLASS>
644 \begin_layout Description
645 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
648 \begin_layout Subsection*
652 \begin_layout Description
653 Action Apply last used text properties.
656 \begin_layout Description
657 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
660 \begin_layout Description
661 Syntax textstyle-apply [<NUM>]textstyle-apply
664 \begin_layout Description
665 Params <NUM>: number of the selection in the internal freefonts stack to be applied.
668 \begin_layout Description
669 Origin leeming, 12 Mar 2003
672 \begin_layout Subsection*
676 \begin_layout Description
677 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
680 \begin_layout Description
681 Syntax textstyle-update <FONT_INFO>
684 \begin_layout Description
685 Params <FONT_INFO>: specifies font attributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
686 \begin_inset Newline newline
689 Use lyx -dbg action for exact syntax of text-style dialog parameters.
692 \begin_layout Description
693 Origin leeming, 12 Mar 2003
696 \begin_layout Section
697 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
700 \begin_layout Subsection*
704 \begin_layout Description
705 Action Adds an acute accent to the next character typed.
708 \begin_layout Description
712 \begin_layout Subsection*
716 \begin_layout Description
717 Action Adds a breve accent to the next character typed.
720 \begin_layout Description
724 \begin_layout Subsection*
728 \begin_layout Description
729 Action Adds a caron to the next character typed.
732 \begin_layout Description
736 \begin_layout Subsection*
740 \begin_layout Description
741 Action Adds a cedilla to the next character typed.
744 \begin_layout Description
745 Syntax accent-cedilla
748 \begin_layout Subsection*
752 \begin_layout Description
753 Action Adds a circle accent to the next character typed.
756 \begin_layout Description
760 \begin_layout Subsection*
764 \begin_layout Description
765 Action Adds a circumflex to the next character typed.
768 \begin_layout Description
769 Syntax accent-circumflex
772 \begin_layout Subsection*
776 \begin_layout Description
777 Action Adds a dot accent to the next character typed.
780 \begin_layout Description
784 \begin_layout Subsection*
788 \begin_layout Description
789 Action Adds a grave accent to the next character typed.
792 \begin_layout Description
796 \begin_layout Subsection*
797 accent-hungarian-umlaut
800 \begin_layout Description
801 Action Adds a Hungarian umlaut to the next character typed.
804 \begin_layout Description
808 \begin_layout Subsection*
812 \begin_layout Description
813 Action Adds a macron to the next character typed.
816 \begin_layout Description
820 \begin_layout Subsection*
824 \begin_layout Description
825 Action Adds an ogonek accent to the next character typed.
828 \begin_layout Description
832 \begin_layout Subsection*
836 \begin_layout Description
837 Action Adds a perispomeni (Greek circumflex) over the next character typed.
840 \begin_layout Description
841 Syntax accent-perispomeni
844 \begin_layout Subsection*
848 \begin_layout Description
849 Action Adds a tie over the next two character typed.
852 \begin_layout Description
853 Notion The following char will finish the tie.
856 \begin_layout Description
860 \begin_layout Subsection*
864 \begin_layout Description
865 Action Adds a tilde over the next character typed.
868 \begin_layout Description
872 \begin_layout Subsection*
876 \begin_layout Description
877 Action Adds an umlaut over the next character typed.
880 \begin_layout Description
884 \begin_layout Subsection*
888 \begin_layout Description
889 Action Adds a bar under the next character typed.
892 \begin_layout Description
893 Syntax accent-underbar
896 \begin_layout Subsection*
900 \begin_layout Description
901 Action Adds a dot under the next character typed.
904 \begin_layout Description
905 Syntax accent-underdot
908 \begin_layout Subsection*
912 \begin_layout Description
913 Action Accepts all tracked changes in the document.
916 \begin_layout Description
917 Syntax all-changes-accept
920 \begin_layout Description
921 Origin Levon, 16 Oct 2002
924 \begin_layout Subsection*
928 \begin_layout Description
929 Action Rejects all tracked changes in the document.
932 \begin_layout Description
933 Notion Reject does not work recursively; the user may have to repeat the operation.
936 \begin_layout Description
937 Syntax all-changes-reject
940 \begin_layout Description
941 Origin Levon, 16 Oct 2002
944 \begin_layout Subsection*
948 \begin_layout Description
949 Action Start (or remove) Appendix on the given cursor position.
952 \begin_layout Description
956 \begin_layout Description
957 Origin ettrich, 5 May 1998
960 \begin_layout Subsection*
964 \begin_layout Description
965 Action Inserts an argument (short title) inset.
968 \begin_layout Description
969 Syntax argument-insert <argument nr>
972 \begin_layout Description
973 Params <argument nr>: see layout declarations
976 \begin_layout Description
977 Origin vermeer, 12 Aug 2002
980 \begin_layout Subsection*
984 \begin_layout Description
985 Action Adds database, which will be used for bibtex citations.
988 \begin_layout Description
989 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
992 \begin_layout Description
993 Syntax bibtex-database-add <DATABASE-NAME>
996 \begin_layout Description
997 Origin Ale, 30 May 1997
1000 \begin_layout Subsection*
1004 \begin_layout Description
1005 Action Adds database, which will be used for bibtex citations.
1008 \begin_layout Description
1009 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1012 \begin_layout Description
1013 Syntax bibtex-database-del <DATABASE-NAME>
1016 \begin_layout Description
1017 Origin Ale, 30 May 1997
1020 \begin_layout Subsection*
1024 \begin_layout Description
1025 Action Clears the list of saved bookmarks.
1028 \begin_layout Description
1029 Syntax bookmark-clear
1032 \begin_layout Description
1033 Origin bpeng, 31 October 2006
1036 \begin_layout Subsection*
1040 \begin_layout Description
1041 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
1044 \begin_layout Description
1045 Notion Bookmark 0 has a special purpose. It is automatically set
1046 \begin_inset Newline newline
1049 1. to the paragraph you are currently editing
1050 \begin_inset Newline newline
1053 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1054 \begin_inset Newline newline
1057 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1060 \begin_layout Description
1061 Syntax bookmark-goto <NUMBER>
1064 \begin_layout Description
1065 Params <NUMBER>: the number of the bookmark to restore.
1068 \begin_layout Description
1069 Origin Dekel, 27 January 2001
1072 \begin_layout Subsection*
1076 \begin_layout Description
1077 Action Save a bookmark.
1080 \begin_layout Description
1081 Notion Saves a numbered bookmark to the sessions file. The number must be between 1 and 9, inclusive. Note that bookmarks are saved per-session, not per file.
1084 \begin_layout Description
1085 Syntax bookmark-save <NUMBER>
1088 \begin_layout Description
1089 Params <NUMBER>: the number of the bookmark to save.
1092 \begin_layout Description
1093 Origin Dekel, 27 January 2001
1096 \begin_layout Subsection*
1100 \begin_layout Description
1101 Action Inserts Box inset.
1104 \begin_layout Description
1105 Syntax box-insert [<TYPE>]
1108 \begin_layout Description
1109 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1110 \begin_inset Newline newline
1113 Framed is the default one.
1116 \begin_layout Description
1117 Origin vermeer, 7 Oct 2003
1120 \begin_layout Subsection*
1124 \begin_layout Description
1125 Action Inserts branch inset.
1128 \begin_layout Description
1129 Syntax branch-insert <BRANCH-NAME>
1132 \begin_layout Description
1133 Origin vermeer, 17 Aug 2003
1136 \begin_layout Subsection*
1140 \begin_layout Description
1141 Action For debug purposes only. Convert all [a-zA-Z0-1] characters to single character. Useful when submitting docs to list or bugzilla.
1144 \begin_layout Description
1145 Syntax buffer-anonymize
1148 \begin_layout Description
1149 Origin sanda, Feb 1 2018
1152 \begin_layout Subsection*
1156 \begin_layout Description
1157 Action Move the cursor to the beginning of the document.
1160 \begin_layout Description
1164 \begin_layout Subsection*
1168 \begin_layout Description
1169 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1172 \begin_layout Description
1173 Syntax buffer-begin-select
1176 \begin_layout Subsection*
1180 \begin_layout Description
1181 Action Move the cursor to the end of the document.
1184 \begin_layout Description
1188 \begin_layout Subsection*
1192 \begin_layout Description
1193 Action Move the cursor to the end of the document adding the traversed text to the selection.
1196 \begin_layout Description
1197 Syntax buffer-end-select
1200 \begin_layout Subsection*
1204 \begin_layout Description
1205 Action Inserts a caption inset.
1208 \begin_layout Description
1209 Syntax caption-insert
1212 \begin_layout Description
1213 Origin Lgb, 18 Jul 2000
1216 \begin_layout Subsection*
1220 \begin_layout Description
1221 Action Moves the cursor to the previous cell inside the table.
1224 \begin_layout Description
1225 Syntax cell-backward
1228 \begin_layout Description
1229 Origin Jug, 22 May 2000
1232 \begin_layout Subsection*
1236 \begin_layout Description
1237 Action Moves the cursor to the next cell inside the table.
1240 \begin_layout Description
1244 \begin_layout Subsection*
1248 \begin_layout Description
1249 Action Splits cell and shifts right part to the next cell (inside the math grid).
1252 \begin_layout Description
1256 \begin_layout Description
1257 Origin Ale, 15 May 1997
1260 \begin_layout Subsection*
1264 \begin_layout Description
1265 Action Accepts tracked change inside the selection.
1268 \begin_layout Description
1269 Syntax change-accept
1272 \begin_layout Description
1273 Origin Levon, 16 Oct 2002
1276 \begin_layout Subsection*
1280 \begin_layout Description
1281 Action Moves the cursor to the position of the next change of the change tracking records.
1284 \begin_layout Description
1288 \begin_layout Description
1289 Origin schmitt, 4 Oct 2006
1292 \begin_layout Subsection*
1296 \begin_layout Description
1297 Action Moves the cursor to the position of the previous change of the change tracking records.
1300 \begin_layout Description
1301 Syntax change-previous
1304 \begin_layout Description
1305 Origin vfr, 4 Apr 2009
1308 \begin_layout Subsection*
1312 \begin_layout Description
1313 Action Rejects tracked change inside the selection.
1316 \begin_layout Description
1317 Syntax change-reject
1320 \begin_layout Description
1321 Origin Levon, 16 Oct 2002
1324 \begin_layout Subsection*
1328 \begin_layout Description
1329 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1332 \begin_layout Description
1333 Syntax changes-merge
1336 \begin_layout Description
1337 Origin Levon, 16 Oct 2002
1340 \begin_layout Subsection*
1344 \begin_layout Description
1345 Action Toggles showing of change tracking in typeset output.
1348 \begin_layout Description
1349 Syntax changes-output
1352 \begin_layout Description
1353 Origin spitz, 21 Jan 2005
1356 \begin_layout Subsection*
1360 \begin_layout Description
1361 Action Toggles change tracking to on/off.
1364 \begin_layout Description
1365 Syntax changes-track
1368 \begin_layout Description
1369 Origin levon, 1 Oct 2002
1372 \begin_layout Subsection*
1376 \begin_layout Description
1377 Action Moves the cursor one position logically backwards.
1380 \begin_layout Description
1381 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1384 \begin_layout Description
1385 Syntax char-backward
1388 \begin_layout Subsection*
1389 char-backward-select
1392 \begin_layout Description
1393 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1396 \begin_layout Description
1397 Notion See also LFUN_CHAR_BACKWARD.
1400 \begin_layout Description
1401 Syntax char-backward-select
1404 \begin_layout Subsection*
1405 char-delete-backward
1408 \begin_layout Description
1409 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1412 \begin_layout Description
1413 Syntax char-delete-backward [confirm]
1416 \begin_layout Description
1417 Params confirm: Select big insets, do not directly delete them.
1420 \begin_layout Subsection*
1424 \begin_layout Description
1425 Action Deletes one character in the backward direction (usually the "Delete" key).
1428 \begin_layout Description
1429 Syntax char-delete-forward [confirm]
1432 \begin_layout Description
1433 Params confirm: Select big insets, do not directly delete them.
1436 \begin_layout Subsection*
1440 \begin_layout Description
1441 Action Moves the cursor one position logically forward.
1444 \begin_layout Description
1445 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1448 \begin_layout Description
1452 \begin_layout Subsection*
1456 \begin_layout Description
1457 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1460 \begin_layout Description
1461 Notion See also LFUN_CHAR_FORWARD.
1464 \begin_layout Description
1465 Syntax char-forward-select
1468 \begin_layout Subsection*
1472 \begin_layout Description
1473 Action Moves the cursor one position "to the left".
1476 \begin_layout Description
1477 Notion This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
1480 \begin_layout Description
1484 \begin_layout Subsection*
1488 \begin_layout Description
1489 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1492 \begin_layout Description
1493 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1496 \begin_layout Description
1497 Syntax char-left-select
1500 \begin_layout Subsection*
1504 \begin_layout Description
1505 Action Moves the cursor one position "to the right".
1508 \begin_layout Description
1509 Notion This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
1512 \begin_layout Description
1516 \begin_layout Subsection*
1520 \begin_layout Description
1521 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1524 \begin_layout Description
1525 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1528 \begin_layout Description
1529 Syntax char-right-select
1532 \begin_layout Subsection*
1536 \begin_layout Description
1537 Action Transposes the character at the cursor with the one before it.
1540 \begin_layout Description
1541 Syntax chars-transpose
1544 \begin_layout Description
1545 Origin Lgb, 25 Apr 2001
1548 \begin_layout Subsection*
1552 \begin_layout Description
1553 Action Inserts citation from loaded citation database.
1556 \begin_layout Description
1557 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1560 \begin_layout Description
1561 Params <KEY>: Citation (shortcut listed in available citations).
1562 \begin_inset Newline newline
1565 <TEXT_BEFORE>: text which should appear before citation.
1568 \begin_layout Description
1569 Origin AAS, 97-02-23
1572 \begin_layout Subsection*
1576 \begin_layout Description
1577 Action Opens the corresponding pdf/url for a given citation inset.
1580 \begin_layout Description
1581 Syntax citation-open [EXTERNAL] TARGET
1584 \begin_layout Description
1585 Params <TARGET>: URL (https:,file:) of the document.
1586 \begin_inset Newline newline
1589 <EXTERNAL>: Use external executable script for finding target
1590 \begin_inset Newline newline
1593 and launching viewer. In this case TARGET consists of author and year
1594 \begin_inset Newline newline
1597 and will be passed as an input argument to the script.
1600 \begin_layout Description
1601 Origin Sanda, 16 Aug 2020
1604 \begin_layout Subsection*
1608 \begin_layout Description
1609 Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text). Pastes plain text if plain text is on the clipboard, but tries to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1612 \begin_layout Description
1613 Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source is the clipboard, not the selection.
1616 \begin_layout Description
1617 Syntax clipboard-paste [<ARG>]
1620 \begin_layout Description
1621 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1624 \begin_layout Description
1625 Origin Georg, 10 Jul 2006
1628 \begin_layout Subsection*
1629 clipboard-paste-simple
1632 \begin_layout Description
1633 Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard. Pastes plain text if plain text is on the clipboard, without trying to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1636 \begin_layout Description
1637 Syntax clipboard-paste-simple [<ARG>]
1640 \begin_layout Description
1641 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1644 \begin_layout Subsection*
1648 \begin_layout Description
1649 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1652 \begin_layout Description
1653 Notion Usually bound to M-x shortcut.
1656 \begin_layout Description
1657 Syntax command-execute
1660 \begin_layout Subsection*
1664 \begin_layout Description
1665 Action Try to complete the word or command at the cursor position.
1668 \begin_layout Description
1672 \begin_layout Description
1673 Origin sts, Feb 19 2008
1676 \begin_layout Subsection*
1680 \begin_layout Description
1681 Action Accept suggested completion.
1684 \begin_layout Description
1685 Syntax completion-accept
1688 \begin_layout Description
1689 Origin sanda, Sep 08 2008
1692 \begin_layout Subsection*
1696 \begin_layout Description
1697 Action Try to cancel completion, either the popup or the inline completion.
1700 \begin_layout Description
1701 Syntax completion-cancel
1704 \begin_layout Description
1705 Origin sts, Sep 07 2008
1708 \begin_layout Subsection*
1712 \begin_layout Description
1713 Action Show the inline completion at the cursor position.
1716 \begin_layout Description
1717 Syntax completion-inline
1720 \begin_layout Description
1721 Origin sts, Feb 19 2008
1724 \begin_layout Subsection*
1728 \begin_layout Description
1729 Action Show the completion popup at the cursor position.
1732 \begin_layout Description
1733 Syntax completion-popup
1736 \begin_layout Description
1737 Origin sts, Feb 19 2008
1740 \begin_layout Subsection*
1744 \begin_layout Description
1745 Action Copies the current selection to the clipboard.
1748 \begin_layout Description
1752 \begin_layout Subsection*
1756 \begin_layout Description
1757 Action Cuts to the clipboard.
1760 \begin_layout Description
1764 \begin_layout Subsection*
1768 \begin_layout Description
1769 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1772 \begin_layout Description
1773 Syntax depth-decrement
1776 \begin_layout Subsection*
1780 \begin_layout Description
1781 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1784 \begin_layout Description
1785 Syntax depth-increment
1788 \begin_layout Subsection*
1789 dialog-disconnect-inset
1792 \begin_layout Description
1793 Action Closes opened connection to opened inset.
1796 \begin_layout Description
1797 Notion Connection is used for apply functions.
1800 \begin_layout Description
1801 Syntax dialog-disconnect-inset <INSET-NAME>
1804 \begin_layout Description
1805 Origin leeming, 25 Feb 2003
1808 \begin_layout Subsection*
1812 \begin_layout Description
1813 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1816 \begin_layout Description
1817 Syntax dialog-hide <NAME>
1820 \begin_layout Description
1821 Params See LFUN_DIALOG_SHOW .
1824 \begin_layout Description
1825 Origin leeming, 25 Feb 2003
1828 \begin_layout Subsection*
1832 \begin_layout Description
1833 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1836 \begin_layout Description
1837 Syntax dialog-show <NAME> [<DATA>]
1840 \begin_layout Description
1841 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1842 \begin_inset Newline newline
1845 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1846 \begin_inset Newline newline
1849 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1850 \begin_inset Newline newline
1853 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1854 \begin_inset Newline newline
1857 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1858 \begin_inset Newline newline
1861 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1862 \begin_inset Newline newline
1865 <SPECIAL>: latexlog|vclog
1866 \begin_inset Newline newline
1869 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1872 \begin_layout Description
1873 Origin leeming, 17 Jun 2003
1876 \begin_layout Subsection*
1877 dialog-show-new-inset
1880 \begin_layout Description
1881 Action Shows hidden dialog or create new one for a given inset settings etc.
1884 \begin_layout Description
1885 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1888 \begin_layout Description
1889 Syntax dialog-show-new-inset <NAME> [<DATA>]
1892 \begin_layout Description
1893 Params See LFUN_DIALOG_SHOW .
1896 \begin_layout Description
1897 Origin leeming, 25 Feb 2003
1900 \begin_layout Subsection*
1904 \begin_layout Description
1905 Action Toggles dialog between showed/hidden state.
1908 \begin_layout Description
1909 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1912 \begin_layout Description
1913 Syntax dialog-toggle <NAME> [<DATA>]
1916 \begin_layout Description
1917 Params See LFUN_DIALOG_SHOW .
1920 \begin_layout Description
1921 Origin spitz, 30 Apr 2007
1924 \begin_layout Subsection*
1928 \begin_layout Description
1929 Action Updates the dialog values from the inset/paragraph/document.
1932 \begin_layout Description
1933 Syntax dialog-update <NAME>
1936 \begin_layout Description
1937 Params <NAME>: paragraph|prefs|<INSET>
1938 \begin_inset Newline newline
1944 \begin_layout Description
1945 Origin leeming, 25 Feb 2003
1948 \begin_layout Subsection*
1952 \begin_layout Description
1953 Action Moves the cursor one line in downward direction.
1956 \begin_layout Description
1960 \begin_layout Subsection*
1964 \begin_layout Description
1965 Action Moves the cursor one line in downward direction adding the current position to the selection.
1968 \begin_layout Description
1972 \begin_layout Subsection*
1976 \begin_layout Description
1977 Action Inserts an ERT inset.
1980 \begin_layout Description
1984 \begin_layout Description
1985 Origin Jug, 18 Feb 2000
1988 \begin_layout Subsection*
1992 \begin_layout Description
1993 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1996 \begin_layout Description
2000 \begin_layout Description
2001 Origin Lgb, 17 May 2001
2004 \begin_layout Subsection*
2008 \begin_layout Description
2009 Action Cancel background export process.
2012 \begin_layout Description
2013 Syntax export-cancel
2016 \begin_layout Description
2017 Origin rgh, 10 December 2017
2020 \begin_layout Subsection*
2024 \begin_layout Description
2025 Action Inserts another LyX file.
2028 \begin_layout Description
2029 Syntax file-insert [<FILE>] [ignorelang]
2032 \begin_layout Description
2033 Params <FILE>: Filename to be inserted. ignorelang: If given, the (main) language of the inserted file is ignored (the context language is used).
2036 \begin_layout Subsection*
2037 file-insert-plaintext
2040 \begin_layout Description
2041 Action Inserts plain text file.
2044 \begin_layout Description
2045 Syntax file-insert-plaintext [<FILE>]
2048 \begin_layout Description
2049 Params <FILE>: Filename to be inserted.
2052 \begin_layout Description
2053 Origin CFO-G, 19 Nov 1997
2056 \begin_layout Subsection*
2057 file-insert-plaintext-para
2060 \begin_layout Description
2061 Action Inserts plain text file as paragraph (i.e. join lines).
2064 \begin_layout Description
2065 Syntax file-insert-plaintext-para [<FILE>]
2068 \begin_layout Description
2069 Params <FILE>: Filename to be inserted.
2072 \begin_layout Description
2073 Origin Levon, 14 Feb 2001
2076 \begin_layout Subsection*
2080 \begin_layout Description
2081 Action Inserts CharStyle, Custom inset or XML short element.
2084 \begin_layout Description
2085 Notion Look into the Customization manual for more information about these elements.
2086 \begin_inset Newline newline
2089 To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself.
2090 \begin_inset Newline newline
2093 For dissolving the element see LFUN_INSET_DISSOLVE.
2096 \begin_layout Description
2097 Syntax flex-insert Name
2100 \begin_layout Description
2101 Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout <Flex:Name>. The Flex: prefix is optional.
2104 \begin_layout Description
2105 Sample flex-insert Code
2108 \begin_layout Subsection*
2112 \begin_layout Description
2113 Action Inserts a float inset.
2116 \begin_layout Description
2117 Syntax float-insert <TYPE>
2120 \begin_layout Description
2121 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2124 \begin_layout Description
2125 Origin Lgb, 27 Jun 2000
2128 \begin_layout Subsection*
2132 \begin_layout Description
2133 Action Inserts the list of floats in the document.
2136 \begin_layout Description
2137 Syntax float-list-insert <TYPE>
2140 \begin_layout Description
2141 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2144 \begin_layout Description
2145 Origin Lgb, 3 May 2001
2148 \begin_layout Subsection*
2152 \begin_layout Description
2153 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2156 \begin_layout Description
2157 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2160 \begin_layout Description
2161 Syntax float-wide-insert <TYPE>
2164 \begin_layout Description
2165 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2168 \begin_layout Description
2169 Origin Lgb, 31 Oct 2001
2172 \begin_layout Subsection*
2176 \begin_layout Description
2177 Action Inserts a footnote inset.
2180 \begin_layout Description
2181 Syntax footnote-insert
2184 \begin_layout Description
2185 Origin Jug, 7 Mar 2000
2188 \begin_layout Subsection*
2192 \begin_layout Description
2193 Action Reloads the image if necessary.
2196 \begin_layout Description
2197 Syntax graphics-reload
2200 \begin_layout Description
2201 Origin vfr, 10 Aug 2009
2204 \begin_layout Subsection*
2208 \begin_layout Description
2209 Action Set the group for the graphics inset on the cursor position.
2212 \begin_layout Description
2213 Syntax graphics-set-group [<GROUP>]
2216 \begin_layout Description
2217 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
2220 \begin_layout Description
2221 Origin sanda, 6 May 2008
2224 \begin_layout Subsection*
2228 \begin_layout Description
2229 Action Set the same group for all graphics insets in the marked block.
2232 \begin_layout Description
2233 Syntax graphics-unify [<GROUP>]
2236 \begin_layout Description
2237 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the group Id from the first graphics inset will be used.
2240 \begin_layout Description
2241 Origin sanda, 7 Feb 2018
2244 \begin_layout Subsection*
2248 \begin_layout Description
2249 Action Inserts hyperlinks into the document (clickable in pdf output).
2252 \begin_layout Description
2253 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2256 \begin_layout Description
2257 Syntax href-insert [<TARGET>]
2260 \begin_layout Description
2261 Origin CFO-G, 21 Nov 1997
2264 \begin_layout Subsection*
2268 \begin_layout Description
2269 Action Only active in IPA inset.
2272 \begin_layout Description
2273 Notion Dummy function which is only active in a IPA inset. It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2276 \begin_layout Description
2280 \begin_layout Description
2281 Origin spitz, 20 May 2012
2284 \begin_layout Subsection*
2288 \begin_layout Description
2289 Action Inserts Index entry.
2292 \begin_layout Description
2293 Notion It automatically takes the word on the cursor position.
2296 \begin_layout Description
2297 Syntax index-insert [<TYPE:Name>]
2300 \begin_layout Description
2301 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2304 \begin_layout Description
2305 Origin leeming, 3 Aug 2000
2308 \begin_layout Subsection*
2312 \begin_layout Description
2313 Action Inserts list of Index entries on a new page.
2316 \begin_layout Description
2317 Syntax index-print [<TYPE:Name>]
2320 \begin_layout Description
2321 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2324 \begin_layout Description
2325 Origin Lgb, 27 Feb 1997
2328 \begin_layout Subsection*
2332 \begin_layout Description
2333 Action Tags all occurrences of the word before the cursor with the index inset at cursor.
2336 \begin_layout Description
2337 Notion It automatically takes the word on the cursor position.
2340 \begin_layout Description
2341 Syntax index-tag-all
2344 \begin_layout Description
2345 Origin spitz, 5 Nov 2022
2348 \begin_layout Subsection*
2352 \begin_layout Description
2353 Action Inserts special Index macros into the document.
2356 \begin_layout Description
2357 Syntax indexmacro-insert <type>
2360 \begin_layout Description
2361 Params <type>: see, seealso, subentry, sortkey.
2364 \begin_layout Description
2365 Origin spitz, 20 Feb 2022
2368 \begin_layout Subsection*
2372 \begin_layout Description
2373 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2376 \begin_layout Description
2377 Notion Apart from lfun arguments you can use the following method:
2378 \begin_inset Newline newline
2381 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2382 \begin_inset Newline newline
2385 2. select the text and run info-insert lfun.
2388 \begin_layout Description
2389 Syntax info-insert <TYPE> <ARG>
2392 \begin_layout Description
2393 Params <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2394 \begin_inset Newline newline
2397 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2398 \begin_inset Newline newline
2401 date: current date (formatted and localized)
2402 \begin_inset Newline newline
2405 moddate: date of last modification (saving) (formatted and localized)
2406 \begin_inset Newline newline
2409 fixdate: a static date (formatted and localized)
2410 \begin_inset Newline newline
2413 time: current time (formatted and localized)
2414 \begin_inset Newline newline
2417 modtime: time of last modification (saving) (formatted and localized)
2418 \begin_inset Newline newline
2421 fixtime: a static time (formatted and localized)
2422 \begin_inset Newline newline
2425 shortcut[s]: name of lfun (e.g math-insert
2428 \begin_inset Newline newline
2431 lyxrc: name of rc_entry (e.g. bind_file)
2432 \begin_inset Newline newline
2435 lyxinfo: "version" - used version of LyX
2436 \begin_inset Newline newline
2439 package: name of latex package (e.g. listings)
2440 \begin_inset Newline newline
2443 textclass: name of textclass (e.g. article)
2444 \begin_inset Newline newline
2447 menu: name of lfun used in menu
2448 \begin_inset Newline newline
2451 l7n: localizable string.
2452 \begin_inset Newline newline
2455 icon: icon of lfun used in toolbar or direct icon name
2456 \begin_inset Newline newline
2459 buffer: "name"|"name-noext"|"path"|"class" vcs: "tree-revision"|"revision"|"author"|"date"|"time"
2462 \begin_layout Description
2463 Sample command-sequence info-insert buffer path; info-insert buffer name
2466 \begin_layout Description
2467 Origin bpeng, 7 Oct 2007
2470 \begin_layout Subsection*
2474 \begin_layout Description
2475 Action Apply data for an inset.
2478 \begin_layout Description
2479 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied. This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called.
2482 \begin_layout Description
2483 Syntax inset-apply <ARGS>
2486 \begin_layout Description
2487 Params See LFUN_INSET_INSERT .
2490 \begin_layout Subsection*
2494 \begin_layout Description
2495 Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
2498 \begin_layout Description
2502 \begin_layout Description
2503 Origin lasgouttes, 16 Mar 2009
2506 \begin_layout Subsection*
2510 \begin_layout Description
2511 Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
2514 \begin_layout Description
2515 Syntax inset-begin-select
2518 \begin_layout Description
2519 Origin lasgouttes, 16 Mar 2009
2522 \begin_layout Subsection*
2526 \begin_layout Description
2527 Action Copies the inset to the clipboard as a certain type.
2530 \begin_layout Description
2531 Notion Currently used only for InsetInfo where its content is copied as a text.
2534 \begin_layout Description
2535 Syntax inset-copy-as
2538 \begin_layout Description
2539 Origin vfr, 18 Apr 2010
2542 \begin_layout Subsection*
2546 \begin_layout Description
2547 Action Dissolve the current inset into text.
2550 \begin_layout Description
2551 Syntax inset-dissolve [<INSET>]
2554 \begin_layout Description
2555 Params <INSET>: this can be used to make sure the right kind of inset is dissolved. For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type.
2556 \begin_inset Newline newline
2559 For values see lyx::InsetLayout::lyxtype_ .
2562 \begin_layout Description
2563 Origin JSpitz, 7 Aug 2006
2566 \begin_layout Subsection*
2570 \begin_layout Description
2571 Action Edit the inset at cursor with an external application, if one is attributed. If the inset is file based, the referenced file is edited. Otherwise, the inset contents is written to a temporary file, the inset is locked, and the temporary file is edited. In this case, LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished.
2574 \begin_layout Description
2575 Syntax inset-edit [<INSET_PARAMS>]
2578 \begin_layout Description
2579 Params <INSET_PARAMS>: Parameters for the inset.
2580 \begin_inset Newline newline
2583 Currently only the filename will be considered.
2586 \begin_layout Description
2587 Origin spitz, 27 Apr 2006
2590 \begin_layout Subsection*
2594 \begin_layout Description
2595 Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
2598 \begin_layout Description
2602 \begin_layout Description
2603 Origin lasgouttes, 16 Mar 2009
2606 \begin_layout Subsection*
2610 \begin_layout Description
2611 Action End editing the inset at cursor with an external application. This replaces the inset contents with the contents of the temporary file, deletes the file and unlocks the inset.
2614 \begin_layout Description
2615 Syntax inset-end-edit
2618 \begin_layout Description
2619 Origin gb, 11 Oct 2015
2622 \begin_layout Subsection*
2626 \begin_layout Description
2627 Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
2630 \begin_layout Description
2631 Syntax inset-end-select
2634 \begin_layout Description
2635 Origin lasgouttes, 16 Mar 2009
2638 \begin_layout Subsection*
2642 \begin_layout Description
2643 Action Apply the given commands on insets of a given name.
2646 \begin_layout Description
2647 Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 100000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed.
2650 \begin_layout Description
2651 Syntax inset-forall <NAME> <LFUN-COMMAND>
2652 \begin_inset Newline newline
2655 <NAME>: Type of Inset. If <NAME> is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets.
2658 \begin_layout Description
2659 Sample Remove all index insets:
2660 \begin_inset Newline newline
2663 inset-forall Index char-delete-forward
2664 \begin_inset Newline newline
2668 \begin_inset Newline newline
2671 inset-forall Note inset-toggle close
2672 \begin_inset Newline newline
2675 Open all branch insets of branch "myBranch":
2676 \begin_inset Newline newline
2679 inset-forall Branch:myBranch inset-toggle open
2680 \begin_inset Newline newline
2683 Transform all yellow notes to comments
2684 \begin_inset Newline newline
2687 inset-forall Note:Note inset-modify note Note Comment
2688 \begin_inset Newline newline
2691 Try to put LyX in an infinite loop if there is at least a Note:
2692 \begin_inset Newline newline
2695 inset-forall Note char-backward
2698 \begin_layout Description
2699 Origin lasgouttes, 27 Nov 2009
2702 \begin_layout Subsection*
2706 \begin_layout Description
2707 Action Insert new inset (type given by the parameters).
2710 \begin_layout Description
2711 Syntax inset-insert <INSET> <ARGS>
2714 \begin_layout Description
2715 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2716 \begin_inset Newline newline
2719 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2720 \begin_inset Newline newline
2723 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2726 \begin_layout Description
2727 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2730 \begin_inset Newline newline
2733 where <label name> is the name of the referenced label and <Format> is one of the following:
2734 \begin_inset Newline newline
2738 \begin_inset Newline newline
2741 eqref -- (<reference>)
2742 \begin_inset Newline newline
2746 \begin_inset Newline newline
2749 vpageref -- on <page>
2750 \begin_inset Newline newline
2753 vref -- <reference> on <page>
2754 \begin_inset Newline newline
2757 formatted -- Formatted reference
2760 \begin_layout Subsection*
2764 \begin_layout Description
2765 Action Inserts the inset's content (in ToC pane) at the position of the cursor.
2768 \begin_layout Description
2769 Syntax inset-insert-copy
2772 \begin_layout Description
2773 Origin spitz, 1 Nov 2022
2776 \begin_layout Subsection*
2780 \begin_layout Description
2781 Action Modify some properties of an inset.
2784 \begin_layout Description
2785 Notion Used for argument, bibitem, bibtex, box, branch, caption, citation, command, ert, external, float, graphics, include, index, info, label, line, listings, newline, newpage, nomencl, note, phantom, quotes, ref, script, separator, space, tabular, vspace and wrap insets.
2788 \begin_layout Description
2789 Syntax inset-modify <INSET> <ARGS>
2790 \begin_inset Newline newline
2793 inset-modify changetype <TYPE>
2796 \begin_layout Description
2797 Sample Change a Note inset into a Comment inset:
2798 \begin_inset Newline newline
2801 inset-modify note Note Comment
2802 \begin_inset Newline newline
2805 Change a Box into an Ovalbox:
2806 \begin_inset Newline newline
2809 inset-modify changetype Ovalbox
2810 \begin_inset Newline newline
2813 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
2814 \begin_inset Newline newline
2817 inset-modify changetype els
2818 \begin_inset Newline newline
2821 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
2822 \begin_inset Newline newline
2825 inset-modify changetype e..
2826 \begin_inset Newline newline
2832 \begin_layout Subsection*
2836 \begin_layout Description
2837 Action Select all contents of an inset.
2840 \begin_layout Description
2841 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2844 \begin_layout Description
2845 Syntax inset-select-all
2848 \begin_layout Description
2849 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2852 \begin_layout Subsection*
2856 \begin_layout Description
2857 Action Open the inset's properties dialog.
2860 \begin_layout Description
2861 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, line, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2864 \begin_layout Description
2865 Syntax inset-settings <INSET>
2868 \begin_layout Description
2869 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2870 \begin_inset Newline newline
2873 graphics|href|include|index|index_print|label|line|
2874 \begin_inset Newline newline
2877 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2880 \begin_layout Subsection*
2884 \begin_layout Description
2885 Action Splits the current inset into two at current position.
2888 \begin_layout Description
2889 Syntax inset-split [<INSET>]
2892 \begin_layout Description
2893 Params <INSET>: this can be used to make sure the right kind of inset is dissolved. For example "split" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type.
2894 \begin_inset Newline newline
2897 For values see lyx::InsetLayout::lyxtype_ .
2900 \begin_layout Description
2901 Origin spitz, 22 Dec 2020
2904 \begin_layout Subsection*
2908 \begin_layout Description
2909 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2912 \begin_layout Description
2913 Syntax inset-toggle [<ARG>]
2916 \begin_layout Description
2917 Params <ARG>: <open|close|toggle|assign>.
2918 \begin_inset Newline newline
2921 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2922 \begin_inset Newline newline
2925 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2928 \begin_layout Description
2929 Origin lasgouttes, 19 Jul 2001
2932 \begin_layout Subsection*
2936 \begin_layout Description
2937 Action Inserts an IPA inset.
2940 \begin_layout Description
2944 \begin_layout Description
2945 Origin spitz, 05 Mar 2012
2948 \begin_layout Subsection*
2952 \begin_layout Description
2953 Action Inserts special IPA macros into the document.
2956 \begin_layout Description
2957 Syntax ipamacro-insert <CHAR>
2960 \begin_layout Description
2961 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2964 \begin_layout Description
2965 Origin spitz, 22 Aug 2012
2968 \begin_layout Subsection*
2972 \begin_layout Description
2973 Action Turn off the loaded keyboard map.
2976 \begin_layout Description
2980 \begin_layout Subsection*
2984 \begin_layout Description
2985 Action Turn on the primary keyboard map.
2988 \begin_layout Description
2989 Notion Maps were widely used in past, when X-windows didn't have nowadays keyboard support. They can be still used to maintain uniform keyboard layout across the various platforms.
2990 \begin_inset Newline newline
2993 The language is to be set in the Preferences dialog.
2996 \begin_layout Description
2997 Syntax keymap-primary
3000 \begin_layout Subsection*
3004 \begin_layout Description
3005 Action Turn on the secondary keyboard map.
3008 \begin_layout Description
3009 Syntax keymap-secondary
3012 \begin_layout Subsection*
3016 \begin_layout Description
3017 Action Toggles keyboard maps (first/second/off).
3020 \begin_layout Description
3021 Syntax keymap-toggle
3024 \begin_layout Description
3025 Origin leeming, 30 Mar 2004
3028 \begin_layout Subsection*
3029 label-copy-as-reference
3032 \begin_layout Description
3033 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3036 \begin_layout Description
3037 Syntax copy-label-as-reference <LABEL>
3040 \begin_layout Description
3041 Params <LABEL>: The label to copy (for multi-line math)
3044 \begin_layout Description
3045 Origin sts, 16 Nov 2008
3048 \begin_layout Subsection*
3052 \begin_layout Description
3053 Action Goto a label.
3056 \begin_layout Description
3057 Syntax label-goto [<LABEL>]
3060 \begin_layout Description
3061 Params <LABEL>: Requested label. If no label is given and reference is on cursor position, Bookmark 0 is saved and cursor moves to the position of referenced label.
3064 \begin_layout Description
3065 Origin Ale, 6 Aug 1997
3068 \begin_layout Subsection*
3072 \begin_layout Description
3073 Action Inserts label to text or displayed formula.
3076 \begin_layout Description
3077 Syntax label-insert [<LABEL>]
3080 \begin_layout Description
3081 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3084 \begin_layout Subsection*
3085 label-insert-as-reference
3088 \begin_layout Description
3089 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3092 \begin_layout Description
3093 Syntax label-insert-as-reference
3096 \begin_layout Description
3097 Origin vfr, 7 Apr 2009
3100 \begin_layout Subsection*
3104 \begin_layout Description
3105 Action Set language from the current cursor position.
3108 \begin_layout Description
3109 Syntax language <LANG> [set]
3112 \begin_layout Description
3113 Params <LANG>: Requested language. Look in lib/languages for the list. "language reset" or "language" (without param) reset to the document language. set: If used, the language will be set to the specified language. Otherwise, the language will be toggled (i.e., if the current language is LANG, switch to the document language or the default language, if LANG is the document language).
3116 \begin_layout Description
3117 Origin Dekel, 2 Mar 2000
3120 \begin_layout Subsection*
3124 \begin_layout Description
3125 Action Move the cursor to the beginning of the (screen) line.
3128 \begin_layout Description
3132 \begin_layout Subsection*
3136 \begin_layout Description
3137 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3140 \begin_layout Description
3141 Syntax line-begin-select
3144 \begin_layout Subsection*
3148 \begin_layout Description
3149 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3152 \begin_layout Description
3153 Syntax line-delete-forward
3156 \begin_layout Subsection*
3160 \begin_layout Description
3161 Action Move the cursor to the end of the (screen) line.
3164 \begin_layout Description
3168 \begin_layout Subsection*
3172 \begin_layout Description
3173 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3176 \begin_layout Description
3177 Syntax line-end-select
3180 \begin_layout Subsection*
3184 \begin_layout Description
3185 Action Inserts a new listings inset.
3188 \begin_layout Description
3189 Syntax listing-insert
3192 \begin_layout Description
3193 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
3196 \begin_layout Subsection*
3200 \begin_layout Description
3201 Action Inserts a marginal note.
3204 \begin_layout Description
3205 Syntax marginalnote-insert
3208 \begin_layout Description
3209 Origin Lgb, 26 Jun 2000
3212 \begin_layout Subsection*
3216 \begin_layout Description
3217 Action Disable selecting of text-region.
3220 \begin_layout Description
3224 \begin_layout Subsection*
3228 \begin_layout Description
3229 Action Enable selecting of text-region.
3232 \begin_layout Description
3233 Notion After enabling you can simply move arrow keys to get selected region.
3236 \begin_layout Description
3240 \begin_layout Subsection*
3244 \begin_layout Description
3245 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3248 \begin_layout Description
3252 \begin_layout Description
3253 Origin Andre, May 5 2006
3256 \begin_layout Subsection*
3260 \begin_layout Description
3261 Action Inserts a line break or new line.
3264 \begin_layout Description
3265 Syntax newline-insert [<ARG>]
3268 \begin_layout Description
3269 Params <ARG>: <newline|linebreak> default: newline
3272 \begin_layout Description
3273 Origin spitz, 25 Mar 2008
3276 \begin_layout Subsection*
3280 \begin_layout Description
3281 Action Inserts a new page.
3284 \begin_layout Description
3285 Syntax newpage-insert <ARG>
3288 \begin_layout Description
3289 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3292 \begin_layout Description
3293 Origin uwestoehr, 24 Nov 2007
3296 \begin_layout Subsection*
3300 \begin_layout Description
3301 Action Inserts Nomenclature entry.
3304 \begin_layout Description
3305 Notion It automatically takes the word on the cursor position if no symbol is given.
3308 \begin_layout Description
3309 Syntax nomencl-insert [<SYMBOL>]
3312 \begin_layout Description
3313 Origin Ugras, 4 Nov 2006
3316 \begin_layout Subsection*
3320 \begin_layout Description
3321 Action Inserts list of Nomenclature entries.
3324 \begin_layout Description
3325 Syntax nomenclature-print
3328 \begin_layout Description
3329 Origin Ugras, 4 Nov 2006
3332 \begin_layout Subsection*
3336 \begin_layout Description
3337 Action Inserts Note on the current cursor position, move selection inside the inset.
3340 \begin_layout Description
3341 Syntax note-insert [<TYPE>]
3344 \begin_layout Description
3345 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3348 \begin_layout Subsection*
3352 \begin_layout Description
3353 Action Moves the cursor to the beginning of next Note inset.
3356 \begin_layout Description
3360 \begin_layout Subsection*
3364 \begin_layout Description
3365 Action Move the current group in the downward direction in the structure of the document.
3368 \begin_layout Description
3369 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3372 \begin_layout Description
3376 \begin_layout Description
3377 Origin Vermeer, 23 Mar 2006
3380 \begin_layout Subsection*
3384 \begin_layout Description
3385 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3388 \begin_layout Description
3389 Notion Part -> Chapter -> Section -> etc.
3392 \begin_layout Description
3396 \begin_layout Description
3397 Origin Vermeer, 23 Mar 2006
3400 \begin_layout Subsection*
3404 \begin_layout Description
3405 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3408 \begin_layout Description
3409 Notion Part <- Chapter <- Section <- etc.
3412 \begin_layout Description
3416 \begin_layout Description
3417 Origin Vermeer, 23 Mar 2006
3420 \begin_layout Subsection*
3424 \begin_layout Description
3425 Action Move the current group in the upward direction in the structure of the document.
3428 \begin_layout Description
3429 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3432 \begin_layout Description
3436 \begin_layout Description
3437 Origin Vermeer, 23 Mar 2006
3440 \begin_layout Subsection*
3444 \begin_layout Description
3445 Action Breaks the current paragraph at the current location.
3448 \begin_layout Description
3449 Notion Removes the selection.
3452 \begin_layout Description
3453 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3456 \begin_layout Description
3457 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3458 \begin_inset Newline newline
3461 ignoresep: Do not account for paragraph separators while breaking.
3464 \begin_layout Subsection*
3468 \begin_layout Description
3469 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3472 \begin_layout Description
3473 Syntax paragraph-down
3476 \begin_layout Description
3477 Origin Asger, 1 Oct 1996
3480 \begin_layout Subsection*
3481 paragraph-down-select
3484 \begin_layout Description
3485 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3488 \begin_layout Description
3489 Syntax paragraph-down-select
3492 \begin_layout Description
3493 Origin Asger, 1 Oct 1996
3496 \begin_layout Subsection*
3500 \begin_layout Description
3501 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph. If given four arguments id_start, pos_start, id_end, pos_end, perform a selection from start to end.
3504 \begin_layout Description
3505 Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen. Moreover the id is unique for all opened buffers (documents). Both ids must belong to the same buffer.
3508 \begin_layout Description
3509 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3512 \begin_layout Description
3513 Params <PAR_ID>: paragraph id
3514 \begin_inset Newline newline
3517 <POS_IN_PAR>: desired position within the paragraph
3520 \begin_layout Description
3521 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3524 \begin_layout Subsection*
3528 \begin_layout Description
3529 Action Moves the current paragraph downwards in the document.
3532 \begin_layout Description
3533 Syntax paragraph-move-down
3536 \begin_layout Description
3537 Origin Edwin, 8 Apr 2006
3540 \begin_layout Subsection*
3544 \begin_layout Description
3545 Action Moves the current paragraph upwards in the document.
3548 \begin_layout Description
3549 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3552 \begin_layout Description
3553 Syntax paragraph-move-up
3556 \begin_layout Description
3557 Origin Edwin, 8 Apr 2006
3560 \begin_layout Subsection*
3564 \begin_layout Description
3565 Action Change paragraph settings.
3568 \begin_layout Description
3569 Notion Modifies the current paragraph, or currently selected paragraphs. This function only modifies, and does not override, existing settings. Note that the "leftindent" indent setting is deprecated.
3572 \begin_layout Description
3573 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3576 \begin_layout Description
3586 \begin_inset Newline newline
3591 paragraph_spacing default|single|onehalf|double|other SIZE
3592 \begin_inset Newline newline
3597 align block|left|right|center|default
3598 \begin_inset Newline newline
3603 labelwidthstring WIDTH|
3608 \begin_layout Description
3609 Origin rgh, Aug 15 2007
3612 \begin_layout Subsection*
3613 paragraph-params-apply
3616 \begin_layout Description
3617 Action Change paragraph settings.
3620 \begin_layout Description
3621 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3624 \begin_layout Description
3625 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3628 \begin_layout Description
3629 Params For parameters see LFUN_PARAGRAPH_PARAMS
3632 \begin_layout Description
3633 Origin leeming, 30 Mar 2004
3636 \begin_layout Subsection*
3640 \begin_layout Description
3641 Action Move cursor to beginning of current paragraph and select to the end in downward direction
3644 \begin_layout Description
3645 Notion This function is by default bound to triple mouse click
3648 \begin_layout Description
3649 Syntax paragraph-select
3652 \begin_layout Description
3653 Origin Kornel, 16 Apr 2019
3656 \begin_layout Subsection*
3660 \begin_layout Description
3661 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3664 \begin_layout Description
3668 \begin_layout Description
3669 Origin Asger, 1 Oct 1996
3672 \begin_layout Subsection*
3676 \begin_layout Description
3677 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3680 \begin_layout Description
3681 Syntax paragraph-up-select
3684 \begin_layout Description
3685 Origin Asger, 1 Oct 1996
3688 \begin_layout Subsection*
3692 \begin_layout Description
3693 Action Pastes material (text or picture) from the active clipboard.
3696 \begin_layout Description
3697 Syntax paste [<TYPE>|<NUM>]
3700 \begin_layout Description
3701 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3702 \begin_inset Newline newline
3705 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3708 \begin_layout Subsection*
3712 \begin_layout Description
3713 Action Inserts phantom on the current cursor position, move selection inside the inset.
3716 \begin_layout Description
3717 Syntax phantom-insert [<TYPE>]
3720 \begin_layout Description
3721 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3724 \begin_layout Description
3725 Origin uwestoehr, 30 Jan 2009
3728 \begin_layout Subsection*
3732 \begin_layout Description
3733 Action Inserts a new preview inset.
3736 \begin_layout Description
3737 Syntax preview-insert
3740 \begin_layout Description
3741 Origin vfr, 28 Mar 2010
3744 \begin_layout Subsection*
3745 primary-selection-paste
3748 \begin_layout Description
3749 Action Pastes the currently selected text.
3752 \begin_layout Description
3753 Notion Primary selection mechanism is X11/Wayland-only thing.
3756 \begin_layout Description
3757 Syntax primary-selection-paste [<ARG>]
3760 \begin_layout Description
3761 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3764 \begin_layout Subsection*
3768 \begin_layout Description
3769 Action Inserts quotes according to the type and quote-language preference.
3772 \begin_layout Description
3773 Notion Currently 15 different quote styles are distinguished (see params).
3776 \begin_layout Description
3777 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3780 \begin_layout Description
3781 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
3782 \begin_inset Newline newline
3785 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
3786 \begin_inset Newline newline
3789 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3790 \begin_inset Newline newline
3793 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3794 \begin_inset Newline newline
3797 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3798 \begin_inset Newline newline
3801 'danish' for >>Danish<< quote style (with >inner quotation<)
3802 \begin_inset Newline newline
3805 'english' for ``English'' quote style (with `inner quotation')
3806 \begin_inset Newline newline
3809 'french' for <<french>> quote style (with ``inner quotation'')
3810 \begin_inset Newline newline
3813 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
3814 \begin_inset Newline newline
3817 'german' for ,,German`` quote style (with ,inner quotation`)
3818 \begin_inset Newline newline
3821 'plain' for "Plain" quote style (with 'inner quotation')
3822 \begin_inset Newline newline
3825 'polish' for ,,Polish'' quote style (with ,inner quotation')
3826 \begin_inset Newline newline
3829 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3830 \begin_inset Newline newline
3833 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
3834 \begin_inset Newline newline
3837 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3838 \begin_inset Newline newline
3841 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3842 \begin_inset Newline newline
3845 'dynamic' for Dynamic quotation marks which inherit the global document style
3846 \begin_inset Newline newline
3849 If no quote style is specified, the document-wide will be used.
3852 \begin_layout Subsection*
3856 \begin_layout Description
3857 Action Redoes the last thing undone.
3860 \begin_layout Description
3864 \begin_layout Subsection*
3868 \begin_layout Description
3869 Action Go to the next label or cross-reference.
3872 \begin_layout Description
3873 Syntax reference-next
3876 \begin_layout Description
3877 Origin Dekel, 14 Jan 2001
3880 \begin_layout Subsection*
3884 \begin_layout Description
3885 Action Repeat the given command.
3888 \begin_layout Description
3889 Notion fails when the repeat count is greater than 10000.
3892 \begin_layout Description
3893 Syntax repeat <COUNT> <LFUN-COMMAND>
3896 \begin_layout Description
3897 Origin Andre, 27 Oct 2003
3900 \begin_layout Subsection*
3904 \begin_layout Description
3905 Action Moves the cursor one page in downward direction.
3908 \begin_layout Description
3912 \begin_layout Subsection*
3916 \begin_layout Description
3917 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3920 \begin_layout Description
3921 Syntax screen-down-select
3924 \begin_layout Subsection*
3928 \begin_layout Description
3929 Action Recenters the screen on the current cursor position.
3932 \begin_layout Description
3933 Syntax screen-recenter
3936 \begin_layout Subsection*
3940 \begin_layout Description
3941 Action Repositions the screen such that the cursor is visible.
3944 \begin_layout Description
3945 Syntax screen-show-cursor
3948 \begin_layout Description
3949 Origin vfr, 25 Mar 2009
3952 \begin_layout Subsection*
3956 \begin_layout Description
3957 Action Moves the cursor one page in upward direction.
3960 \begin_layout Description
3964 \begin_layout Subsection*
3968 \begin_layout Description
3969 Action Moves the cursor one page in upward direction adding the current position to the selection.
3972 \begin_layout Description
3973 Syntax screen-up-select
3976 \begin_layout Subsection*
3980 \begin_layout Description
3981 Action Inserts a subscript or superscript inset.
3984 \begin_layout Description
3985 Syntax script-insert <TYPE>
3988 \begin_layout Description
3989 Params <TYPE>: subscript|superscript
3992 \begin_layout Description
3993 Origin Georg, 23 Nov 2010
3996 \begin_layout Subsection*
4000 \begin_layout Description
4001 Action Scroll the buffer view.
4004 \begin_layout Description
4005 Notion Only scrolls the screen up or down; does not move the cursor.
4008 \begin_layout Description
4009 Syntax scroll <TYPE> <QUANTITY>
4012 \begin_layout Description
4013 Params <TYPE>: line|page
4014 \begin_inset Newline newline
4017 <QUANTITY>: up|down|<number>
4020 \begin_layout Description
4021 Origin Abdel, Dec 27 2007
4024 \begin_layout Subsection*
4028 \begin_layout Description
4029 Action Set search string buffer.
4032 \begin_layout Description
4033 Syntax search-string-set [<DATA>]
4036 \begin_layout Description
4037 Params <DATA>: string to search for. If no parameter is given, use (word under) selection.
4040 \begin_layout Description
4041 Origin stwitt, spitz, Feb 12 2021
4044 \begin_layout Subsection*
4048 \begin_layout Description
4049 Action Select the whole section.
4052 \begin_layout Description
4053 Notion The cursor should be in a section heading before calling this lfun.
4056 \begin_layout Description
4057 Syntax section-select
4060 \begin_layout Description
4061 Origin vfr, 05 May 2009
4064 \begin_layout Subsection*
4068 \begin_layout Description
4069 Action Pastes the internal selection text in permanent selection.
4072 \begin_layout Description
4073 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
4076 \begin_layout Description
4077 Syntax selection-paste
4080 \begin_layout Description
4081 Origin lasgouttes, 14 Jan 2009
4084 \begin_layout Subsection*
4088 \begin_layout Description
4089 Action Inserts an environment separator or latex paragraph break.
4092 \begin_layout Description
4093 Syntax separator-insert [<ARG>]
4096 \begin_layout Description
4097 Params <ARG>: <plain|parbreak|latexpar> default: plain
4100 \begin_layout Description
4101 Origin ef, 2 May 2014
4104 \begin_layout Subsection*
4108 \begin_layout Description
4109 Action Inserts one of horizontal space insets.
4112 \begin_layout Description
4113 Syntax space-insert <NAME> [<LEN>]
4116 \begin_layout Description
4117 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
4118 \begin_inset Newline newline
4121 Only in math mode: med and thick.
4122 \begin_inset Newline newline
4125 <LEN>: length for custom spaces (hspace, hspace* for protected)
4128 \begin_layout Description
4129 Origin spitz, 20 May 2003, Mar 17 2008
4132 \begin_layout Subsection*
4136 \begin_layout Description
4137 Action Inserts various characters into the document.
4140 \begin_layout Description
4141 Syntax specialchar-insert <CHAR>
4144 \begin_layout Description
4145 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
4148 \begin_layout Description
4149 Origin spitz, 6 Dec 2007
4152 \begin_layout Subsection*
4156 \begin_layout Description
4157 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4160 \begin_layout Description
4161 Syntax spelling-add [<STRING>] [<LANG>]
4164 \begin_layout Description
4165 Params <WORD>: word to add <LANG>: language name (see file languages)
4168 \begin_layout Description
4169 Origin spitz, 18 Jan 2010
4172 \begin_layout Subsection*
4176 \begin_layout Description
4177 Action Add the word under the cursor to the document's local spell checker dictionary. The default for the language is retrieved from the cursor position.
4180 \begin_layout Description
4181 Syntax spelling-add-local [<STRING>] [<LANG>]
4184 \begin_layout Description
4185 Params <WORD>: word to add <LANG>: language name (see file languages)
4188 \begin_layout Description
4189 Origin spitz, 6 Mar 2021
4192 \begin_layout Subsection*
4193 spelling-continuously
4196 \begin_layout Description
4197 Action Toggle continuous spell checking.
4200 \begin_layout Description
4201 Syntax spelling-continuously
4204 \begin_layout Description
4205 Origin vfr, 24 March 2013
4208 \begin_layout Subsection*
4212 \begin_layout Description
4213 Action Let the spell checker ignore the word under the cursor in the current session for the given language. The default for the language is retrieved from the cursor position.
4216 \begin_layout Description
4217 Syntax spelling-ignore [<WORD>] [<LANG>]
4220 \begin_layout Description
4221 Params <WORD>: word to ignore <LANG>: language name (see file languages)
4224 \begin_layout Description
4225 Origin spitz, 18 Jan 2010
4228 \begin_layout Subsection*
4232 \begin_layout Description
4233 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4236 \begin_layout Description
4237 Syntax spelling-remove [<STRING>] [<LANG>]
4240 \begin_layout Description
4241 Params <WORD>: word to remove <LANG>: language name (see file languages)
4244 \begin_layout Description
4245 Origin SWitt, 28 July 2010
4248 \begin_layout Subsection*
4249 spelling-remove-local
4252 \begin_layout Description
4253 Action Remove the word under the cursor from the document's local spell checker dictionary. The default for the language is retrieved from the cursor position.
4256 \begin_layout Description
4257 Syntax spelling-remove-local [<STRING>] [<LANG>]
4260 \begin_layout Description
4261 Params <WORD>: word to remove <LANG>: language name (see file languages)
4264 \begin_layout Description
4265 Origin spitz, 7 Mar 2021
4268 \begin_layout Subsection*
4272 \begin_layout Description
4273 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4276 \begin_layout Description
4277 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action.
4280 \begin_layout Description
4284 \begin_layout Description
4285 Origin vfr, Sep 30 2008
4288 \begin_layout Subsection*
4292 \begin_layout Description
4293 Action Insert a tab into a listings inset.
4296 \begin_layout Description
4297 Notion It also works on a selection.
4300 \begin_layout Description
4304 \begin_layout Description
4305 Origin vfr, Sep 30 2008
4308 \begin_layout Subsection*
4312 \begin_layout Description
4313 Action Modify properties of tabulars and table-like math environments.
4316 \begin_layout Description
4317 Syntax tabular-feature <FEATURE> [<ARG>]
4320 \begin_layout Description
4321 Params Generally see LFUN_INSET_INSERT for further details.
4322 \begin_inset Newline newline
4325 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4326 \begin_inset Newline newline
4329 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4330 \begin_inset Newline newline
4333 set-line-top|set-line-bottom|set-line-left|set-line-right|
4334 \begin_inset Newline newline
4337 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4338 \begin_inset Newline newline
4341 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
4342 \begin_inset Newline newline
4345 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
4346 \begin_inset Newline newline
4349 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4350 \begin_inset Newline newline
4353 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4354 \begin_inset Newline newline
4357 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4358 \begin_inset Newline newline
4361 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4362 \begin_inset Newline newline
4365 reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|
4366 \begin_inset Newline newline
4369 toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
4370 \begin_inset Newline newline
4373 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4374 \begin_inset Newline newline
4377 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4378 \begin_inset Newline newline
4381 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4382 \begin_inset Newline newline
4385 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4386 \begin_inset Newline newline
4389 set-special-column|set-special-multicolumn|set-special-multirow|
4390 \begin_inset Newline newline
4393 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4394 \begin_inset Newline newline
4397 set-interline-space|tabular-valign-top|tabular-valign-middle|
4398 \begin_inset Newline newline
4401 tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|
4402 \begin_inset Newline newline
4405 set-border-lines|toggle-border-lines|set-inner-lines|toggle-inner-lines Various math-environment features are handled as well, e.g. add-vline-left/right for
4406 \begin_inset Newline newline
4409 the Grid/Array environment.
4410 \begin_inset Newline newline
4413 <ARG>: additional argument for some commands, use debug mode to explore its values.
4416 \begin_layout Description
4417 Origin gm, 10 Dec 2015
4420 \begin_layout Subsection*
4424 \begin_layout Description
4425 Action Inserts table into the document.
4428 \begin_layout Description
4429 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4432 \begin_layout Description
4433 Syntax tabular-insert [<ROWS> <COLUMNS>]
4436 \begin_layout Description
4437 Params In case no arguments are given show insert dialog.
4440 \begin_layout Description
4441 Origin Jug, 12 Apr 2000
4444 \begin_layout Subsection*
4445 tabular-style-insert
4448 \begin_layout Description
4449 Action Inserts table of a given style into the document.
4452 \begin_layout Description
4453 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4456 \begin_layout Description
4457 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
4460 \begin_layout Description
4461 Params Valid styles are the names of the files in lib/tabletemplates, minus _1x<n> and .lyx suffix.
4464 \begin_layout Description
4465 Origin spitz, 25 Mar 2019
4468 \begin_layout Subsection*
4472 \begin_layout Description
4473 Action Look up thesaurus entries with respect to the word under the cursor.
4476 \begin_layout Description
4477 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4480 \begin_layout Description
4481 Params <STRING>: word to look up <LANG>: language (see file languages)
4484 \begin_layout Description
4485 Origin Levon, 20 Jul 2001
4488 \begin_layout Subsection*
4492 \begin_layout Description
4493 Action Undoes the last edit.
4496 \begin_layout Description
4500 \begin_layout Subsection*
4504 \begin_layout Description
4505 Action Inserts a single unicode character.
4508 \begin_layout Description
4509 Syntax unicode-insert <CHAR1> <CHAR2> ...
4512 \begin_layout Description
4513 Params <CHARn>: The character to insert, given as its code point, in hexadecimal.
4516 \begin_layout Description
4517 Sample unicode-insert 0x0100 0x0259
4520 \begin_layout Description
4521 Origin Lgb, 22 Oct 2006
4524 \begin_layout Subsection*
4528 \begin_layout Description
4529 Action Moves the cursor one line in upward direction.
4532 \begin_layout Description
4536 \begin_layout Subsection*
4540 \begin_layout Description
4541 Action Moves the cursor one line in upward direction adding the current position to the selection.
4544 \begin_layout Description
4548 \begin_layout Subsection*
4552 \begin_layout Description
4553 Action Moves the cursor to the logically previous beginning of a word.
4556 \begin_layout Description
4557 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
4560 \begin_layout Description
4561 Syntax word-backward
4564 \begin_layout Subsection*
4565 word-backward-select
4568 \begin_layout Description
4569 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4572 \begin_layout Description
4573 Notion See also LFUN_WORD_BACKWARD.
4576 \begin_layout Description
4577 Syntax word-backward-select
4580 \begin_layout Subsection*
4584 \begin_layout Description
4585 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4588 \begin_layout Description
4589 Syntax word-capitalize [<SEL_TYPE>]
4592 \begin_layout Description
4593 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
4596 \begin_layout Subsection*
4597 word-delete-backward
4600 \begin_layout Description
4601 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4604 \begin_layout Description
4605 Syntax word-delete-backward [confirm]
4608 \begin_layout Description
4609 Params confirm: Select big insets, do not directly delete them.
4612 \begin_layout Subsection*
4616 \begin_layout Description
4617 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4620 \begin_layout Description
4621 Syntax word-delete-forward [confirm]
4624 \begin_layout Description
4625 Params confirm: Select big insets, do not directly delete them.
4628 \begin_layout Subsection*
4632 \begin_layout Description
4633 Action Search for next occurrence of a string.
4636 \begin_layout Description
4637 Syntax word-find [<DATA>]
4640 \begin_layout Description
4641 Params <DATA>: data encoded from Find dialog (see lyx::find2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
4644 \begin_layout Description
4645 Origin Andre, Jan 7 2004
4648 \begin_layout Subsection*
4652 \begin_layout Description
4653 Action Search for a given string in backward direction.
4656 \begin_layout Description
4657 Notion Case sensitive, match words. If no argument given, last search repeated.
4660 \begin_layout Description
4661 Syntax word-find-backward [<STRING>]
4664 \begin_layout Description
4665 Origin Etienne, 20 Feb 1998
4668 \begin_layout Subsection*
4672 \begin_layout Description
4673 Action Search for a given string in forward direction.
4676 \begin_layout Description
4677 Notion Case sensitive, match words. If no argument given, last search repeated.
4680 \begin_layout Description
4681 Syntax word-find-forward [<STRING>]
4684 \begin_layout Description
4685 Origin Etienne, 16 Feb 1998
4688 \begin_layout Subsection*
4692 \begin_layout Description
4693 Action Search for next occurrence of a pattern.
4696 \begin_layout Description
4697 Syntax word-findadv [<DATA>]
4700 \begin_layout Description
4701 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
4704 \begin_layout Description
4705 Origin Tommaso, Nov 15 2007
4708 \begin_layout Subsection*
4712 \begin_layout Description
4713 Action Moves the cursor to the logically next beginning of a word.
4716 \begin_layout Description
4717 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
4720 \begin_layout Description
4724 \begin_layout Subsection*
4728 \begin_layout Description
4729 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4732 \begin_layout Description
4733 Notion See also LFUN_WORD_FORWARD.
4736 \begin_layout Description
4737 Syntax word-forward-select
4740 \begin_layout Subsection*
4744 \begin_layout Description
4745 Action Moves the cursor to the next beginning of a word "on the left".
4748 \begin_layout Description
4749 Notion This is the action which should be taken when the (e.g., ctrl-) "left" key is pressed. Generally, it moves the cursor to the next beginning of a word on the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
4752 \begin_layout Description
4756 \begin_layout Description
4757 Origin dov, 28 Oct 2007
4760 \begin_layout Subsection*
4764 \begin_layout Description
4765 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4768 \begin_layout Description
4769 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4772 \begin_layout Description
4773 Syntax word-left-select
4776 \begin_layout Description
4777 Origin dov, 28 Oct 2007
4780 \begin_layout Subsection*
4784 \begin_layout Description
4785 Action Change the words in the selection or word at cursor position to lower case.
4788 \begin_layout Description
4789 Syntax word-lowcase [<SEL_TYPE>]
4792 \begin_layout Description
4793 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
4796 \begin_layout Subsection*
4800 \begin_layout Description
4801 Action Replace a string in the document.
4804 \begin_layout Description
4805 Syntax word-replace [<DATA>]
4808 \begin_layout Description
4809 Params <DATA>: data is of the form "<replacestring>
4810 \begin_inset Newline newline
4814 \begin_inset Newline newline
4817 <casesensitive> <matchword> <all> <forward> <findnext>"
4820 \begin_layout Description
4821 Origin Andre, Jan 7 2004
4824 \begin_layout Subsection*
4828 \begin_layout Description
4829 Action Moves the cursor to the next beginning of a word "on the right".
4832 \begin_layout Description
4833 Notion This is the action which should be taken when the (e.g., ctrl-) "right" key is pressed. Generally, it moves the cursor to the next beginning of a word on the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
4836 \begin_layout Description
4840 \begin_layout Description
4841 Origin dov, 28 Oct 2007
4844 \begin_layout Subsection*
4848 \begin_layout Description
4849 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4852 \begin_layout Description
4853 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4856 \begin_layout Description
4857 Syntax word-right-select
4860 \begin_layout Description
4861 Origin dov, 28 Oct 2007
4864 \begin_layout Subsection*
4868 \begin_layout Description
4869 Action Puts the word where the cursor stands into the selection.
4872 \begin_layout Description
4876 \begin_layout Description
4877 Origin Andre, 11 Sep 2002
4880 \begin_layout Subsection*
4884 \begin_layout Description
4885 Action Change the words in the selection or word at cursor position to upper case.
4888 \begin_layout Description
4889 Syntax word-upcase [<SEL_TYPE>]
4892 \begin_layout Description
4893 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
4896 \begin_layout Subsection*
4900 \begin_layout Description
4901 Action Inserts floats wrapped by the text around.
4904 \begin_layout Description
4905 Syntax wrap-insert <TYPE>
4908 \begin_layout Description
4909 Params <TYPE>: table|figure
4912 \begin_layout Description
4913 Origin Dekel, 7 Apr 2002
4916 \begin_layout Section
4917 Math Editor Functions
4920 \begin_layout Subsection*
4921 in-mathmacrotemplate
4924 \begin_layout Description
4925 Action Only active in Math Macro definition.
4928 \begin_layout Description
4929 Notion Dummy function which is only active in a Math Macro definition. It's used to toggle the Math Macro toolbar if the cursor moves into a Math Macro definition.
4932 \begin_layout Description
4933 Syntax in-mathmacrotemplate
4936 \begin_layout Description
4937 Origin sts, 06 January 2008
4940 \begin_layout Subsection*
4944 \begin_layout Description
4945 Action Inserts an extended matrix as provided by the amsmath package.
4948 \begin_layout Description
4949 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4952 \begin_layout Description
4953 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created. Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix, smallmatrix, and matrix. The default is 'matrix'.
4956 \begin_layout Description
4957 Sample math-ams-matrix 3 3 bmatrix
4960 \begin_layout Subsection*
4964 \begin_layout Description
4965 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4968 \begin_layout Description
4969 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4972 \begin_layout Description
4973 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4974 \begin_inset Newline newline
4977 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4980 \begin_layout Description
4981 Sample math-bigdelim "Bigl" "
4988 \begin_layout Description
4989 Origin Enrico & Georg, 7 May 2006
4992 \begin_layout Subsection*
4996 \begin_layout Description
4997 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
5000 \begin_layout Description
5001 Syntax math-delim [<LEFT>] [<RIGHT>]
5004 \begin_layout Description
5005 Params <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by either a LaTeX name or a valid character. ( is the default letter.
5008 \begin_layout Description
5009 Sample math-delim { rangle
5012 \begin_layout Description
5013 Origin Alejandro, 18 Jun 1996
5016 \begin_layout Subsection*
5020 \begin_layout Description
5021 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
5024 \begin_layout Description
5025 Syntax math-display [<ARG>]
5028 \begin_layout Description
5029 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
5032 \begin_layout Description
5033 Origin Alejandro, 18 Jun 1996
5036 \begin_layout Subsection*
5040 \begin_layout Description
5041 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
5044 \begin_layout Description
5045 Notion Selection can be used to determine the input for the external program.
5048 \begin_layout Description
5049 Syntax math-extern <LANG> [<COMMAND>]
5052 \begin_layout Description
5053 Params <LANG>: octave|maxima|maple|mathematica|script
5054 \begin_inset Newline newline
5057 where "script" stands for the external script (normalized expression will be passed)
5060 \begin_layout Description
5061 Sample math-extern maple simplify
5064 \begin_layout Description
5065 Origin Andre, 24 Apr 2001
5068 \begin_layout Subsection*
5072 \begin_layout Description
5073 Action Changes the text style used in math.
5076 \begin_layout Description
5077 Syntax math-font-style <STYLE>
5080 \begin_layout Description
5081 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
5082 \begin_inset Newline newline
5085 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
5088 \begin_layout Description
5089 Origin vfr, 9 jan 2009
5092 \begin_layout Subsection*
5096 \begin_layout Description
5097 Action Inserts math objects and symbols.
5100 \begin_layout Description
5101 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
5103 frac{x}{y}"), the content of cell(0) is replaced by the current selection (only works if the selection is in mathed). As an example, if "abc" is selected in mathed, "math-insert
5105 frac{x}{y}" replaces "abc" with "
5107 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z". If nothing is selected (or the selection is not in mathed), math-insert works as expected.
5110 \begin_layout Description
5111 Syntax math-insert <ARG>
5114 \begin_layout Description
5115 Params <ARG>: Symbol or LaTeX code to be inserted.
5118 \begin_layout Subsection*
5122 \begin_layout Description
5123 Action Toggles the position of the limits from above/below to the right side an vice versa in integral symbol, a limit, a summation, etc.
5126 \begin_layout Description
5127 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
5130 \begin_layout Description
5131 Syntax math-limits [<STATE>]
5134 \begin_layout Description
5135 Params <STATE>: limits|nolimits
5138 \begin_layout Subsection*
5142 \begin_layout Description
5143 Action Inserts a math macro definition at the cursor position in the text.
5146 \begin_layout Description
5147 Syntax math-macro <NAME> [<NARGS>] [def]
5150 \begin_layout Description
5151 Params <NAME>: The name of the macro, e.g. "mymacro".
5152 \begin_inset Newline newline
5155 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
5158 \begin_layout Description
5159 Origin ale, 10 May 1997; sts, 21 Dec 2007
5162 \begin_layout Subsection*
5163 math-macro-add-greedy-optional-param
5166 \begin_layout Description
5167 Action Add a greedy optional parameter.
5170 \begin_layout Description
5171 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
5174 \begin_layout Description
5175 Syntax math-macro-add-greedy-optional-param
5178 \begin_layout Description
5179 Origin sts, 06 January 2008
5182 \begin_layout Subsection*
5183 math-macro-add-optional-param
5186 \begin_layout Description
5187 Action Add an optional parameter.
5190 \begin_layout Description
5191 Notion Insert an optional parameter just behind the already existing optional parameters.
5194 \begin_layout Description
5195 Syntax math-macro-add-optional-param
5198 \begin_layout Description
5199 Origin sts, 06 January 2008
5202 \begin_layout Subsection*
5203 math-macro-add-param
5206 \begin_layout Description
5207 Action Add a parameter.
5210 \begin_layout Description
5211 Notion Add a parameter to a Math Macro.
5214 \begin_layout Description
5215 Syntax math-macro-add-param <NUM>
5218 \begin_layout Description
5219 Params <NUM>: The number of the parameter behind which the new one will be added (1 for the first, i.e. use 0 for add a parameter at the left), defaults to the last one.
5222 \begin_layout Description
5223 Origin sts, 06 January 2008
5226 \begin_layout Subsection*
5227 math-macro-append-greedy-param
5230 \begin_layout Description
5231 Action Append a greedy parameter.
5234 \begin_layout Description
5235 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
5238 \begin_layout Description
5239 Syntax math-macro-append-greedy-param
5242 \begin_layout Description
5243 Origin sts, 06 January 2008
5246 \begin_layout Subsection*
5250 \begin_layout Description
5251 Action Fold a Math Macro.
5254 \begin_layout Description
5255 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
5260 \begin_layout Description
5261 Syntax math-macro-fold
5264 \begin_layout Description
5265 Origin sts, 06 January 2008
5268 \begin_layout Subsection*
5269 math-macro-make-nonoptional
5272 \begin_layout Description
5273 Action Make a parameter non-optional.
5276 \begin_layout Description
5277 Notion Turn the last optional parameter of a Math Macro into a non-optional parameter. The default value is remembered to be reused later if the user changes his mind.
5280 \begin_layout Description
5281 Syntax math-macro-make-nonoptional
5284 \begin_layout Description
5285 Origin sts, 06 January 2008
5288 \begin_layout Subsection*
5289 math-macro-make-optional
5292 \begin_layout Description
5293 Action Make a parameter optional.
5296 \begin_layout Description
5297 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
5300 \begin_layout Description
5301 Syntax math-macro-make-optional
5304 \begin_layout Description
5305 Origin sts, 06 January 2008
5308 \begin_layout Subsection*
5309 math-macro-remove-greedy-param
5312 \begin_layout Description
5313 Action Remove a greedy parameter.
5316 \begin_layout Description
5317 Notion Remove a greedy parameter of a Math Macro and spit out the values of it in every instance of the macro in the buffer. If it is an optional parameter the [valud] format is used.
5320 \begin_layout Description
5321 Syntax math-macro-remove-greedy-param
5324 \begin_layout Description
5325 Origin sts, 06 January 2008
5328 \begin_layout Subsection*
5329 math-macro-remove-optional-param
5332 \begin_layout Description
5333 Action Remove the last optional parameter.
5336 \begin_layout Description
5337 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
5340 \begin_layout Description
5341 Syntax math-macro-remove-optional-param
5344 \begin_layout Description
5345 Origin sts, 06 January 2008
5348 \begin_layout Subsection*
5349 math-macro-remove-param
5352 \begin_layout Description
5353 Action Remove the last parameter.
5356 \begin_layout Description
5357 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
5360 \begin_layout Description
5361 Syntax math-macro-remove-param <NUM>
5364 \begin_layout Description
5365 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
5368 \begin_layout Description
5369 Origin sts, 06 January 2008
5372 \begin_layout Subsection*
5376 \begin_layout Description
5377 Action Unfold a Math Macro.
5380 \begin_layout Description
5381 Notion Unfold the Math Macro the cursor is in, i.e. display it as
5386 \begin_layout Description
5387 Syntax math-macro-unfold
5390 \begin_layout Description
5391 Origin sts, 06 January 2008
5394 \begin_layout Subsection*
5398 \begin_layout Description
5399 Action Inserts a matrix.
5402 \begin_layout Description
5403 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5406 \begin_layout Description
5407 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b, c or t) (i.e. 1 char) and the horizontal alignments (l, c or r) (i.e. <COL> chars).
5410 \begin_layout Description
5411 Sample math-matrix 3 3 bccc
5414 \begin_layout Subsection*
5418 \begin_layout Description
5419 Action In text mode enters math mode (i.e. puts math insets on the current cursor position), in math mode enters text mode inside math expression.
5422 \begin_layout Description
5423 Notion If there is some selected text, it puts the text inside created math box.
5426 \begin_layout Description
5427 Syntax math-mode [on|<ARG>]
5430 \begin_layout Description
5431 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
5432 \begin_inset Newline newline
5435 "on": allow only entering of math mode from text mode.
5438 \begin_layout Description
5439 Origin Alejandro, 4 Jun 1996
5442 \begin_layout Subsection*
5446 \begin_layout Description
5447 Action Mutates the type of math inset to the newly selected one.
5450 \begin_layout Description
5451 Syntax math-mutate <TYPE>
5454 \begin_layout Description
5455 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
5458 \begin_layout Description
5459 Origin Andre, 23 May 2001
5462 \begin_layout Subsection*
5463 math-number-line-toggle
5466 \begin_layout Description
5467 Action Toggles numbering of the current formula line.
5470 \begin_layout Description
5471 Notion Must be in display formula mode.
5474 \begin_layout Description
5475 Syntax math-number-line-toggle
5478 \begin_layout Description
5479 Origin Alejandro, 18 Jun 1996
5482 \begin_layout Subsection*
5486 \begin_layout Description
5487 Action Toggles numbering/labeling of the current formula.
5490 \begin_layout Description
5491 Notion Must be in display formula mode.
5494 \begin_layout Description
5495 Syntax math-number-toggle
5498 \begin_layout Description
5499 Origin Alejandro, 4 Jun 1996
5502 \begin_layout Subsection*
5506 \begin_layout Description
5507 Action Changes arbitrarily the size used by math fonts inside a context.
5510 \begin_layout Description
5511 Notion Provides an interface to the LaTeX math mode font size commands.
5514 \begin_layout Description
5515 Syntax math-size <STYLE>
5518 \begin_layout Description
5530 \begin_layout Description
5531 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5534 \begin_layout Subsection*
5538 \begin_layout Description
5539 Action Inserts space into math expression.
5542 \begin_layout Description
5543 Notion Use spacebar after entering this space to change type of space.
5546 \begin_layout Description
5547 Syntax math-space [<TYPE>] [<LEN>]
5550 \begin_layout Description
5551 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5552 \begin_inset Newline newline
5555 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5556 \begin_inset Newline newline
5559 custom space: hspace
5560 \begin_inset Newline newline
5563 "," used by default.
5564 \begin_inset Newline newline
5567 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5568 \begin_inset Newline newline
5571 <LEN>: length for custom spaces (hspace)
5574 \begin_layout Description
5575 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5578 \begin_layout Subsection*
5582 \begin_layout Description
5583 Action Enters subscript expression in math expression.
5586 \begin_layout Description
5587 Syntax math-subscript
5590 \begin_layout Description
5591 Origin vermeer, 12 Dec 2001
5594 \begin_layout Subsection*
5598 \begin_layout Description
5599 Action Enters superscript expression in math expression.
5602 \begin_layout Description
5603 Syntax math-superscript
5606 \begin_layout Description
5607 Origin vermeer, 12 Dec 2001
5610 \begin_layout Subsection*
5614 \begin_layout Description
5615 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5618 \begin_layout Description
5619 Notion If there is any selected text, then it is moved inside the created regexp inset.
5622 \begin_layout Description
5623 Syntax regexp-mode [<ARG>]
5626 \begin_layout Description
5627 Params <ARG>: eventual argument (regular expression).
5630 \begin_layout Description
5631 Origin Tommaso, 4 Oct 2008
5634 \begin_layout Section
5635 Buffer Fuctions (File and Window related)
5638 \begin_layout Subsection*
5642 \begin_layout Description
5643 Action Activate the branch.
5646 \begin_layout Description
5647 Syntax branch-activate <BRANCH>
5650 \begin_layout Description
5651 Params <BRANCH>: The branch to activate
5654 \begin_layout Description
5655 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5656 \begin_inset Newline newline
5659 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5662 \begin_layout Description
5663 Origin rgh, 27 May 2008
5666 \begin_layout Subsection*
5670 \begin_layout Description
5671 Action Add a branch to the buffer's BranchList.
5674 \begin_layout Description
5675 Syntax branch-add <BRANCH>
5678 \begin_layout Description
5679 Params <BRANCH>: Name of the branch to add
5682 \begin_layout Description
5683 Origin spitz, 7 Jul 2009
5686 \begin_layout Subsection*
5690 \begin_layout Description
5691 Action Create new branch and directly put the branch inset into the document.
5694 \begin_layout Description
5695 Syntax branch-add-insert [<NAME>]
5698 \begin_layout Description
5699 Params <NAME>: Branch name. If it is not specified, you will be asked.
5702 \begin_layout Description
5703 Origin sanda, 10 Jul 2009
5706 \begin_layout Subsection*
5710 \begin_layout Description
5711 Action De-activate the branch.
5714 \begin_layout Description
5715 Syntax branch-deactivate <BRANCH>
5718 \begin_layout Description
5719 Params <BRANCH>: The branch to deactivate
5722 \begin_layout Description
5723 Origin rgh, 27 May 2008
5726 \begin_layout Subsection*
5730 \begin_layout Description
5731 Action Toggles inversion status of branch inset.
5734 \begin_layout Description
5735 Syntax branch-invert
5738 \begin_layout Description
5739 Origin rgheck, 12 July 2016
5742 \begin_layout Subsection*
5743 branch-master-activate
5746 \begin_layout Description
5747 Action Activate the branch in the master buffer.
5750 \begin_layout Description
5751 Syntax branch-master-activate <BRANCH>
5754 \begin_layout Description
5755 Params <BRANCH>: The branch to activate
5758 \begin_layout Description
5759 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5760 \begin_inset Newline newline
5763 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5766 \begin_layout Description
5767 Origin spitz, 30 Sep 2012
5770 \begin_layout Subsection*
5771 branch-master-deactivate
5774 \begin_layout Description
5775 Action De-activate the branch in the master buffer.
5778 \begin_layout Description
5779 Syntax branch-master-deactivate <BRANCH>
5782 \begin_layout Description
5783 Params <BRANCH>: The branch to deactivate
5786 \begin_layout Description
5787 Origin spitz, 30 Sep 2012
5790 \begin_layout Subsection*
5794 \begin_layout Description
5795 Action Open/close all insets of selected branch (depending on its activation status).
5798 \begin_layout Description
5799 Syntax branch-sync-all
5802 \begin_layout Description
5803 Origin sanda, 15 April 2022
5806 \begin_layout Subsection*
5810 \begin_layout Description
5811 Action Rename all branches of a given name in a document.
5814 \begin_layout Description
5815 Syntax branches-rename <OLDNAME> <NEWNAME>
5818 \begin_layout Description
5819 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5822 \begin_layout Description
5823 Origin spitz, 9 Jul 2009
5826 \begin_layout Subsection*
5830 \begin_layout Description
5831 Action Saves the current buffer to a temporary file.
5834 \begin_layout Description
5835 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5838 \begin_layout Description
5839 Syntax buffer-auto-save
5842 \begin_layout Subsection*
5846 \begin_layout Description
5847 Action Loads the given child document.
5850 \begin_layout Description
5851 Notion The current document is treated as a parent.
5854 \begin_layout Description
5855 Syntax buffer-child-open <FILE>
5858 \begin_layout Description
5859 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5862 \begin_layout Description
5863 Origin Ale, 28 May 1997
5866 \begin_layout Subsection*
5870 \begin_layout Description
5871 Action Runs chktex for the current document.
5874 \begin_layout Description
5875 Syntax buffer-chktex
5878 \begin_layout Description
5879 Origin Asger, 30 Oct 1997
5882 \begin_layout Subsection*
5886 \begin_layout Description
5887 Action Closes the current buffer.
5890 \begin_layout Description
5891 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5894 \begin_layout Description
5898 \begin_layout Subsection*
5902 \begin_layout Description
5903 Action Closes all buffers.
5906 \begin_layout Description
5907 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5910 \begin_layout Description
5911 Syntax buffer-close-all
5914 \begin_layout Subsection*
5918 \begin_layout Description
5919 Action Exports the current buffer (document) to the given format.
5922 \begin_layout Description
5923 Syntax buffer-export [<FORMAT>] [<DEST>]
5926 \begin_layout Description
5927 Params <FORMAT> is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format. Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
5928 \begin_inset Newline newline
5931 In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5932 \begin_inset Newline newline
5935 If absent or "default", then the default output format of the document is used.
5936 \begin_inset Newline newline
5939 <DEST> If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
5942 \begin_layout Description
5943 Origin Lgb, 29 Jul 1997
5946 \begin_layout Subsection*
5950 \begin_layout Description
5951 Action Opens a dialog for exporting the current buffer.
5954 \begin_layout Description
5955 Syntax buffer-export-as [<FORMAT>]
5958 \begin_layout Description
5959 Params <FORMAT> is the export format initially selected in the dialog. You can pass any of the formats which you can find in Tools->Preferences->File formats->Format, provided it has the "document" flag set. If no format is specified the dialog will start with the default output format of the current document.
5962 \begin_layout Description
5963 Sample buffer-export-as pdf2
5966 \begin_layout Description
5967 Origin tommaso, 6 Oct 2011
5970 \begin_layout Subsection*
5971 buffer-export-custom
5974 \begin_layout Description
5975 Action Exports the current buffer (document) from the given format using the given command on it.
5978 \begin_layout Description
5979 Syntax buffer-export-custom <FORMAT> <COMMAND>
5982 \begin_layout Description
5983 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5984 \begin_inset Newline newline
5987 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5990 \begin_layout Description
5991 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5994 \begin_layout Description
5995 Origin leeming, 27 Mar 2004
5998 \begin_layout Subsection*
5999 buffer-external-modification-clear
6002 \begin_layout Description
6003 Action Clear the external modification flag on the current buffer.
6006 \begin_layout Description
6007 Syntax buffer-external-modification-clear
6010 \begin_layout Description
6011 Origin gm, 2 March 2017
6014 \begin_layout Subsection*
6018 \begin_layout Description
6019 Action Applies a command to all non-hidden buffers.
6022 \begin_layout Description
6023 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
6026 \begin_layout Description
6027 Syntax buffer-forall <LFUN-COMMAND>
6030 \begin_layout Description
6031 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6034 \begin_layout Description
6035 Sample Close all Notes in all buffers:
6036 \begin_inset Newline newline
6039 buffer-forall inset-forall Note inset-toggle close
6040 \begin_inset Newline newline
6043 Toggle change tracking on buffers:
6044 \begin_inset Newline newline
6047 buffer-forall changes-track
6048 \begin_inset Newline newline
6051 Toggle read-only for buffers:
6052 \begin_inset Newline newline
6055 buffer-forall buffer-toggle-read-only
6056 \begin_inset Newline newline
6059 Show statistics for individual buffers:
6060 \begin_inset Newline newline
6063 buffer-forall statistics
6064 \begin_inset Newline newline
6067 Activate the branch named "Solutions" in buffers:
6068 \begin_inset Newline newline
6071 buffer-forall branch-activate Solutions
6072 \begin_inset Newline newline
6075 Export buffers to PDF (pdflatex):
6076 \begin_inset Newline newline
6079 buffer-forall buffer-export pdf2
6080 \begin_inset Newline newline
6086 \begin_layout Description
6087 Origin skostysh, 20 Jul 2012
6090 \begin_layout Subsection*
6094 \begin_layout Description
6095 Action Import a given file as a lyx document.
6098 \begin_layout Description
6099 Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences. Look in the File->Import menu to get an idea of the currently active import formats.
6102 \begin_layout Description
6103 Syntax buffer-import <FORMAT> [<FILE>]
6106 \begin_layout Description
6107 Origin Asger, 24 Jul 1998
6110 \begin_layout Subsection*
6114 \begin_layout Description
6115 Action Set language of the current document.
6118 \begin_layout Description
6119 Syntax buffer-language <LANG>
6122 \begin_layout Description
6123 Params <LANG>: language name. See lib/languages for list.
6126 \begin_layout Description
6127 Origin leeming, 30 Mar 2004
6130 \begin_layout Subsection*
6134 \begin_layout Description
6135 Action Moves the current tab one spot to the right.
6138 \begin_layout Description
6139 Syntax buffer-move-next
6142 \begin_layout Description
6143 Origin skostysh, 7 Apr 2015
6146 \begin_layout Subsection*
6147 buffer-move-previous
6150 \begin_layout Description
6151 Action Moves the current tab one spot to the left.
6154 \begin_layout Description
6155 Syntax buffer-move-previous
6158 \begin_layout Description
6159 Origin skostysh, 7 Apr 2015
6162 \begin_layout Subsection*
6166 \begin_layout Description
6167 Action Creates a new buffer (that is, document) and switches to it.
6170 \begin_layout Description
6171 Notion Implicit path can be set in Preferences dialog.
6174 \begin_layout Description
6175 Syntax buffer-new [<FILE>]
6178 \begin_layout Description
6179 Params <FILE>: filename of created file with absolute path.
6182 \begin_layout Subsection*
6186 \begin_layout Description
6187 Action Creates a new buffer (that is, document) from a template.
6190 \begin_layout Description
6191 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
6194 \begin_layout Description
6195 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
6198 \begin_layout Description
6199 Params <FILE>: filename of created file with absolute path. If empty or "newfile", a file with appropriate name is generated. <TEMPLATE FILE>: filename of template with absolute path. If empty, a dialog is opened to select the new file.
6202 \begin_layout Subsection*
6206 \begin_layout Description
6207 Action Switch to the next opened document.
6210 \begin_layout Description
6211 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
6214 \begin_layout Description
6218 \begin_layout Subsection*
6222 \begin_layout Description
6223 Action Apply the given settings to the current document.
6226 \begin_layout Description
6227 Syntax buffer-params-apply [<ARGS>]
6230 \begin_layout Description
6231 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6234 \begin_layout Description
6235 Origin leeming, 30 Mar 2004
6238 \begin_layout Subsection*
6242 \begin_layout Description
6243 Action Switch to the previous opened document.
6246 \begin_layout Description
6247 Syntax buffer-previous
6250 \begin_layout Subsection*
6254 \begin_layout Description
6255 Action Reverts opened document.
6258 \begin_layout Description
6259 Syntax buffer-reload [dump]
6262 \begin_layout Description
6263 Params dump: do not ask for any confirmation, just reload. All changes will be lost.
6266 \begin_layout Description
6267 Origin Asger, 2 Feb 1997
6270 \begin_layout Subsection*
6274 \begin_layout Description
6275 Action Removes the auxiliary file before next export to assure export is done afresh.
6278 \begin_layout Description
6279 Syntax buffer-reset-export
6282 \begin_layout Description
6283 Origin spitz, 27 Dec 2019
6286 \begin_layout Subsection*
6287 buffer-save-as-default
6290 \begin_layout Description
6291 Action Save the current document settings as default.
6294 \begin_layout Description
6295 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6298 \begin_layout Description
6299 Syntax buffer-save-as-default [<ARGS>]
6302 \begin_layout Description
6303 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6306 \begin_layout Description
6307 Origin leeming, 30 Mar 2004
6310 \begin_layout Subsection*
6314 \begin_layout Description
6315 Action Display and switch to the given buffer.
6318 \begin_layout Description
6319 Syntax buffer-switch <BUFFER>
6322 \begin_layout Description
6323 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
6326 \begin_layout Subsection*
6327 buffer-toggle-compression
6330 \begin_layout Description
6331 Action Toggles compression of the current document on/off.
6334 \begin_layout Description
6335 Syntax buffer-toggle-compression
6338 \begin_layout Description
6339 Origin bpeng, 27 Apr 2006
6342 \begin_layout Subsection*
6343 buffer-toggle-read-only
6346 \begin_layout Description
6347 Action Toggle editing mode of the current document between read/write and read-only.
6350 \begin_layout Description
6351 Notion This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking.
6354 \begin_layout Description
6355 Syntax buffer-toggle-read-only
6358 \begin_layout Description
6359 Origin Lgb, 27 May 1997
6362 \begin_layout Subsection*
6366 \begin_layout Description
6367 Action Exports the current document and put the result into the temporary directory.
6370 \begin_layout Description
6371 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript).
6374 \begin_layout Description
6375 Syntax buffer-update [<FORMAT>]
6378 \begin_layout Description
6379 Params <FORMAT>: The format to display, where this is one of the formats defined in the Tools>Preferences>File Formats dialog, use the "Short name" field. If no format is given, the default format as specified in the same dialog is used.
6382 \begin_layout Description
6383 Origin Dekel, 5 Aug 2000
6386 \begin_layout Subsection*
6390 \begin_layout Description
6391 Action Displays current buffer in chosen format.
6394 \begin_layout Description
6395 Notion Displays the contents of the current buffer in the chosen format, for example, PDF or DVI. This runs the necessary converter, calls the defined viewer, and so forth.
6398 \begin_layout Description
6399 Syntax buffer-view [<FORMAT>]
6402 \begin_layout Description
6403 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
6406 \begin_layout Subsection*
6410 \begin_layout Description
6411 Action Opens the file that was created from last preview of this buffer.
6414 \begin_layout Description
6415 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog. It can also be called by the user, which is useful if the document takes a long time to compile, and you just want to see the last previewed version.
6418 \begin_layout Description
6419 Syntax buffer-view-cache
6422 \begin_layout Subsection*
6426 \begin_layout Description
6427 Action Saves the current buffer.
6430 \begin_layout Description
6431 Notion Saves the current buffer to disk, using the filename that is already associated with the buffer, asking for one if none is yet assigned.
6434 \begin_layout Description
6435 Syntax buffer-write [force]
6438 \begin_layout Description
6439 Params force: write even if buffer is clean.
6442 \begin_layout Subsection*
6446 \begin_layout Description
6447 Action Save all changed documents.
6450 \begin_layout Description
6451 Syntax buffer-write-all
6454 \begin_layout Description
6455 Origin rgh, gpothier 6 Aug 2007
6458 \begin_layout Subsection*
6462 \begin_layout Description
6463 Action Rename and save current buffer.
6466 \begin_layout Description
6467 Syntax buffer-write-as <FILENAME>
6470 \begin_layout Description
6471 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6474 \begin_layout Subsection*
6475 buffer-write-as-template
6478 \begin_layout Description
6479 Action Rename and save current buffer in the local templates directory.
6482 \begin_layout Description
6483 Syntax buffer-write-as-template <FILENAME>
6486 \begin_layout Description
6487 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6490 \begin_layout Subsection*
6494 \begin_layout Description
6495 Action Sets the zoom of the screen fonts.
6498 \begin_layout Description
6499 Syntax buffer-zoom [<ZOOM>]
6502 \begin_layout Description
6503 Params <ZOOM>: The target zoom value in %; the default is the default zoom as saved in preferences.
6506 \begin_layout Description
6507 Origin daniel, 28 Oct 2016
6510 \begin_layout Subsection*
6514 \begin_layout Description
6515 Action Increases the zoom of the screen fonts.
6518 \begin_layout Description
6519 Syntax buffer-zoom-in [<ZOOM>]
6522 \begin_layout Description
6523 Params <ZOOM>: The zoom value addition in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6526 \begin_layout Description
6527 Origin vfr, 30 Mar 2009
6530 \begin_layout Subsection*
6534 \begin_layout Description
6535 Action Decreases the zoom of the screen fonts.
6538 \begin_layout Description
6539 Syntax buffer-zoom-out [<ZOOM>]
6542 \begin_layout Description
6543 Params <ZOOM>: The zoom value abstraction in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6546 \begin_layout Description
6547 Origin vfr, 30 Mar 2009
6550 \begin_layout Subsection*
6554 \begin_layout Description
6555 Action Generates the code (literate programming).
6558 \begin_layout Description
6559 Notion Latex file with extension
6561 literate_extension is generated. Then LyX invokes
6563 build_command (with a default of ``make'') to generate the code and
6565 build_error_filter to process the compilation error messages.
6566 \begin_inset Newline newline
6569 In case you want to process your literate file with a script, or some other program, just insert in your lyxrc file an entry with:
6570 \begin_inset Newline newline
6575 build_command "my_script my_arguments"
6576 \begin_inset Newline newline
6581 build_error_filter differs from the
6583 literate_error_filter only in that the former will identify error messages from your compiler.
6586 \begin_layout Description
6587 Syntax build-program
6590 \begin_layout Subsection*
6594 \begin_layout Description
6595 Action Open LyX document.
6598 \begin_layout Description
6599 Syntax file-open [<FILE>]
6602 \begin_layout Description
6603 Params <FILE>: Filename to be opened.
6606 \begin_layout Subsection*
6610 \begin_layout Description
6611 Action Open the given help file according to the language setting.
6614 \begin_layout Description
6615 Syntax help-open <FILE>[.lyx]
6618 \begin_layout Description
6619 Params <FILE>: any document from (/usr/share/)doc directory.
6622 \begin_layout Description
6623 Origin Jug, 27 Jun 1999
6626 \begin_layout Subsection*
6630 \begin_layout Description
6631 Action Sets icon size of toolbars.
6634 \begin_layout Description
6635 Syntax icon-size [<SIZE>]
6638 \begin_layout Description
6639 Params <SIZE> : the icon size in px or one of the logical settings small|normal|big|huge|giant, the default is normal (whose size in px is icon set dependent).
6642 \begin_layout Description
6646 \begin_layout Subsection*
6650 \begin_layout Description
6651 Action Helper function for master-related actions
6654 \begin_layout Description
6655 Notion In a buffer, the function will be disabled if the buffer has no master or children. It thus allows to enable actions only in documents with master/children
6658 \begin_layout Description
6659 Syntax ifrelatives <ACTION>
6662 \begin_layout Description
6663 Origin spitz, 2 January 2020
6666 \begin_layout Subsection*
6670 \begin_layout Description
6671 Action Terminates the current LyX instance.
6674 \begin_layout Description
6675 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6678 \begin_layout Description
6682 \begin_layout Subsection*
6686 \begin_layout Description
6687 Action Open lyxfiles (templates/examples). Create a view if he have none.
6690 \begin_layout Description
6691 Syntax lyxfiles-open [<TYPE>]
6694 \begin_layout Description
6695 Params <TYPE>: templates or examples. Default is templates.
6698 \begin_layout Description
6699 Origin spitz, 10 Feb 2021
6702 \begin_layout Subsection*
6703 master-buffer-export
6706 \begin_layout Description
6707 Action Exports the master buffer (document) to the given format.
6710 \begin_layout Description
6711 Syntax master-buffer-export [<FORMAT>] [<DEST>]
6714 \begin_layout Description
6715 Params <FORMAT> is one of the formats which you can find in Tools->Preferences->File formats->Format. Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
6716 \begin_inset Newline newline
6719 Note that "custom" is not allowed in this case.
6720 \begin_inset Newline newline
6723 If absent or "default", then the default output format of the document is used.
6724 \begin_inset Newline newline
6727 <DEST> If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
6730 \begin_layout Description
6731 Origin rkh, 18 April 2018
6734 \begin_layout Subsection*
6735 master-buffer-forall
6738 \begin_layout Description
6739 Action Applies a command to a buffer and all it children, starting from the master.
6742 \begin_layout Description
6743 Syntax master-buffer-forall <LFUN-COMMAND>
6746 \begin_layout Description
6747 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6750 \begin_layout Description
6751 Sample Close all Notes in buffers:
6752 \begin_inset Newline newline
6755 master-buffer-forall inset-forall Note inset-toggle close
6756 \begin_inset Newline newline
6759 Toggle change tracking on buffers:
6760 \begin_inset Newline newline
6763 master-buffer-forall changes-track
6764 \begin_inset Newline newline
6767 Toggle read-only for buffers:
6768 \begin_inset Newline newline
6771 master-buffer-forall buffer-toggle-read-only
6772 \begin_inset Newline newline
6775 Show statistics for individual buffers:
6776 \begin_inset Newline newline
6779 master-buffer-forall statistics
6780 \begin_inset Newline newline
6783 Activate the branch named "Solutions" in buffers:
6784 \begin_inset Newline newline
6787 master-buffer-forall branch-activate Solutions
6788 \begin_inset Newline newline
6794 \begin_layout Description
6795 Origin spitz, 31 Dec 2019
6798 \begin_layout Subsection*
6799 master-buffer-update
6802 \begin_layout Description
6803 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6806 \begin_layout Description
6807 Syntax master-buffer-update [<FORMAT>]
6810 \begin_layout Description
6811 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
6814 \begin_layout Description
6815 Origin Tommaso, 20 Sep 2007
6818 \begin_layout Subsection*
6822 \begin_layout Description
6823 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6826 \begin_layout Description
6827 Syntax master-buffer-view [<FORMAT>]
6830 \begin_layout Description
6831 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
6834 \begin_layout Description
6835 Origin Tommaso, 20 Sep 2007
6838 \begin_layout Subsection*
6842 \begin_layout Description
6843 Action Opens the menu given by its name.
6846 \begin_layout Description
6847 Syntax menu-open <NAME>
6850 \begin_layout Description
6851 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6854 \begin_layout Subsection*
6858 \begin_layout Description
6859 Action Close the current tab group.
6862 \begin_layout Description
6863 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6866 \begin_layout Description
6867 Syntax tab-group-close
6870 \begin_layout Description
6871 Origin Abdel, 21 Feb 2008
6874 \begin_layout Subsection*
6878 \begin_layout Description
6879 Action Switch to the next tab group in split view.
6882 \begin_layout Description
6883 Syntax tab-group-next
6886 \begin_layout Subsection*
6890 \begin_layout Description
6891 Action Switch to the previous tab group in split view.
6894 \begin_layout Description
6895 Syntax tab-group-previous
6898 \begin_layout Subsection*
6902 \begin_layout Description
6903 Action Toggles movability of a given toolbar between true/false.
6906 \begin_layout Description
6907 Syntax toolbar-movable <NAME>
6910 \begin_layout Description
6911 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6914 \begin_layout Description
6915 Origin daniel, 12 July 2016
6918 \begin_layout Subsection*
6922 \begin_layout Description
6923 Action Sets visibility of a given toolbar to on, off, or auto.
6926 \begin_layout Description
6927 Notion Skipping "auto" when allowauto is false.
6930 \begin_layout Description
6931 Syntax toolbar-set <NAME> [on|off|auto]
6934 \begin_layout Description
6935 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6936 \begin_inset Newline newline
6939 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6942 \begin_layout Description
6943 Origin spitz, 17 Dec 2020
6946 \begin_layout Subsection*
6950 \begin_layout Description
6951 Action Toggles visibility of a given toolbar between on/off/auto.
6954 \begin_layout Description
6955 Notion Skipping "auto" when allowauto is false.
6958 \begin_layout Description
6959 Syntax toolbar-toggle <NAME> [allowauto]
6962 \begin_layout Description
6963 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6964 \begin_inset Newline newline
6967 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6970 \begin_layout Description
6971 Origin Edwin, 21 May 2007
6974 \begin_layout Subsection*
6978 \begin_layout Description
6979 Action Various UI visibility-toggling actions.
6982 \begin_layout Description
6983 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6986 \begin_layout Description
6987 Params statusbar : Toggle visibility of the statusbar.
6988 \begin_inset Newline newline
6991 menubar : Toggle visibility of the menubar.
6992 \begin_inset Newline newline
6995 scrollbar : Toggle visibility of the scrollbar.
6996 \begin_inset Newline newline
6999 frame : Toggle visibility of the frames around editing window.
7000 \begin_inset Newline newline
7003 zoomslider : Toggle visibility of the zoom slider in statusbar.
7004 \begin_inset Newline newline
7007 zoomlevel : Toggle visibility of the zoom level display in statusbar.
7008 \begin_inset Newline newline
7011 statistics-w : Toggle visibility of the document word count in statusbar.
7012 \begin_inset Newline newline
7015 statistics-cb : Toggle visibility of the document character count (incl. blanks) in statusbar.
7016 \begin_inset Newline newline
7019 statistics-c : Toggle visibility of the document character count (excl. blanks) in statusbar.
7020 \begin_inset Newline newline
7023 fullscreen : Toggle fullscreen mode. This also covers calling the previous functions. However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
7026 \begin_layout Description
7027 Origin sanda, 9 Feb 2007
7030 \begin_layout Subsection*
7034 \begin_layout Description
7035 Action Close the current document work area.
7038 \begin_layout Description
7039 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
7042 \begin_layout Description
7046 \begin_layout Description
7047 Origin Tommaso, 15 Sep 2012
7050 \begin_layout Subsection*
7054 \begin_layout Description
7055 Action Creates another split view of current buffer.
7058 \begin_layout Description
7059 Notion All split views act in the same way independently.
7062 \begin_layout Description
7063 Syntax view-split <vertical|horizontal>
7066 \begin_layout Description
7067 Params horizontal : The work areas are laid out side by side.
7068 \begin_inset Newline newline
7071 vertical : The work areas laid out vertically.
7074 \begin_layout Description
7075 Origin Abdel, 20 Feb 2008
7078 \begin_layout Subsection*
7082 \begin_layout Description
7083 Action Closes the current LyX window.
7086 \begin_layout Description
7090 \begin_layout Description
7091 Origin Abdel, 23 Oct 2006
7094 \begin_layout Subsection*
7098 \begin_layout Description
7099 Action Creates new empty LyX window.
7102 \begin_layout Description
7103 Notion Already opened documents from the previous window can be found under View menu.
7106 \begin_layout Description
7107 Syntax window-new [<GEOMETRY>]
7110 \begin_layout Description
7111 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
7114 \begin_layout Description
7115 Origin Abdel, 21 Oct 2006
7118 \begin_layout Section
7119 System Functions (Preferences, LyX Server etc.)
7122 \begin_layout Subsection*
7123 buffer-toggle-output-sync
7126 \begin_layout Description
7127 Action Toggles including of resources for forward/reverse search of the given document.
7130 \begin_layout Description
7131 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
7134 \begin_layout Description
7135 Syntax buffer-toggle-output-sync
7138 \begin_layout Description
7139 Origin sanda, 25 May 2010
7142 \begin_layout Subsection*
7146 \begin_layout Description
7147 Action Executes a command defined in a .def file.
7150 \begin_layout Description
7151 Notion The definitions are by default read from lib/commands/default.def.
7152 \begin_inset Newline newline
7155 A .def file allows to define a command with
7157 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and <LFUN> is the lfun code to be executed (see e.g. LFUN_COMMAND_SEQUENCE).
7159 def_file "FileName" allows to include another .def file.
7160 \begin_inset Newline newline
7163 This is particularly useful in connection with toolbar buttons: Since the name of the button image for this lfun is lib/images/commands/<NAME>.png this is the way to assign an image to a complex command-sequence.
7166 \begin_layout Description
7170 \begin_layout Description
7171 Params <NAME>: Name of the command that must be called.
7174 \begin_layout Description
7175 Origin broider, 2 Oct 2007
7178 \begin_layout Subsection*
7182 \begin_layout Description
7183 Action Cancels sequence prepared by LFUN_META_PREFIX .
7186 \begin_layout Description
7190 \begin_layout Subsection*
7191 command-alternatives
7194 \begin_layout Description
7195 Action Runs the first listed command that is enabled.
7198 \begin_layout Description
7199 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
7202 \begin_layout Description
7203 Syntax command-alternatives <CMDS>
7206 \begin_layout Description
7207 Params <CMDS>: Sequence of commands separated by semicolons.
7210 \begin_layout Description
7211 Sample command-alternatives completion-accept;cell-forward
7214 \begin_layout Description
7215 Origin rgh, 24 September 2008
7218 \begin_layout Subsection*
7222 \begin_layout Description
7223 Action Run more commands (LFUN and its parameters) in a sequence.
7226 \begin_layout Description
7227 Syntax command-sequence <CMDS>
7230 \begin_layout Description
7231 Params <CMDS>: Sequence of commands separated by semicolons.
7234 \begin_layout Description
7235 Sample command-sequence cut; ert-insert; self-insert
7237 ; paste; self-insert {}; inset-toggle;
7240 \begin_layout Description
7241 Origin Andre, 11 Nov 1999
7244 \begin_layout Subsection*
7245 cursor-follows-scrollbar-toggle
7248 \begin_layout Description
7249 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
7252 \begin_layout Description
7253 Syntax toggle-cursor-follows-scrollbar
7256 \begin_layout Description
7257 Origin ARRae, 2 Dec 1997
7260 \begin_layout Subsection*
7264 \begin_layout Description
7265 Action Set debug output level.
7268 \begin_layout Description
7269 Syntax debug-level-set <LEVEL>
7272 \begin_layout Description
7273 Params <LEVEL>: comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers.
7276 \begin_layout Description
7277 Origin sanda, 28 Dec 2009
7280 \begin_layout Subsection*
7284 \begin_layout Description
7285 Action toggle a mode where more information is given in UI
7288 \begin_layout Description
7289 Notion in so called "devel" mode, the information given in the status bar is more precise, and the help documents are open in editing mode.
7292 \begin_layout Description
7293 Syntax devel-mode-toggle
7296 \begin_layout Description
7297 Origin lasgouttes, 23 Jul 2017
7300 \begin_layout Subsection*
7304 \begin_layout Description
7305 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
7308 \begin_layout Description
7309 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
7312 \begin_layout Description
7313 Syntax forward-search
7316 \begin_layout Description
7317 Origin sanda, 14 Apr 2010
7320 \begin_layout Subsection*
7324 \begin_layout Description
7325 Action Apply the given settings to user preferences.
7328 \begin_layout Description
7329 Syntax lyxrc-apply <SETTINGS>
7332 \begin_layout Description
7333 Params <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences to get an idea which commands to use and their syntax. lyx::LyXRC::LyXRCTags has the list of possible commands.
7336 \begin_layout Subsection*
7340 \begin_layout Description
7341 Action Shows message in statusbar (for script purposes).
7344 \begin_layout Description
7345 Syntax message <STRING>
7348 \begin_layout Description
7349 Origin Lgb, 8 Apr 2001
7352 \begin_layout Subsection*
7356 \begin_layout Description
7357 Action Simulate halting Meta key (Alt key on PCs).
7360 \begin_layout Description
7361 Notion Used for buffer edition not for GUI control.
7364 \begin_layout Description
7368 \begin_layout Subsection*
7372 \begin_layout Description
7373 Action Save user preferences.
7376 \begin_layout Description
7377 Syntax preferences-save
7380 \begin_layout Description
7381 Origin Lgb, 27 Nov 1999
7384 \begin_layout Subsection*
7388 \begin_layout Description
7389 Action Reconfigure the automatic settings.
7392 \begin_layout Description
7396 \begin_layout Description
7397 Origin Asger, 14 Feb 1997
7400 \begin_layout Subsection*
7404 \begin_layout Description
7405 Action Enables/disables searching for features in findadv
7408 \begin_layout Description
7409 Syntax search-ignore <type> <value>
7412 \begin_layout Description
7413 Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content
7414 \begin_inset Newline newline
7420 \begin_layout Subsection*
7424 \begin_layout Description
7425 Action Returns path and file name of the currently edited document.
7428 \begin_layout Description
7429 Syntax server-get-filename
7432 \begin_layout Subsection*
7436 \begin_layout Description
7437 Action Returns the current layout (that is environment) name on the cursor position.
7440 \begin_layout Description
7441 Syntax server-get-layout
7444 \begin_layout Subsection*
7445 server-get-statistics
7448 \begin_layout Description
7449 Action Returns the statistics (number of words and characters) in the document or in the given selection.
7452 \begin_layout Description
7453 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7456 \begin_layout Description
7457 Syntax server-get-statistics [<TYPE>]
7460 \begin_layout Description
7461 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
7462 \begin_inset Newline newline
7466 \begin_inset Newline newline
7469 chars: count characters.
7470 \begin_inset Newline newline
7473 chars-space: count characters and spaces.
7476 \begin_layout Description
7477 Origin brokenclock, Oct 10 2014
7480 \begin_layout Subsection*
7484 \begin_layout Description
7485 Action Returns the coordinates of cursor position in the editing area.
7488 \begin_layout Description
7489 Syntax server-get-xy
7492 \begin_layout Subsection*
7493 server-goto-file-row
7496 \begin_layout Description
7497 Action Sets the cursor position in LyX based on the row number of generated TeX file.
7500 \begin_layout Description
7501 Notion This can be useful for DVI inverse-search or detection of the problematic line from LaTeX compilation. Note that before this function can be used export to LaTeX output must occur (in order to map the row numbers).
7504 \begin_layout Description
7505 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
7508 \begin_layout Description
7509 Params <FILE>: the path and filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
7510 \begin_inset Newline newline
7513 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g. for the case of generated .tex file).
7514 \begin_inset Newline newline
7517 .ext: extensions will be automatically replaced by .lyx.
7518 \begin_inset Newline newline
7521 <ROW_NUMBER> The row number of the LaTeX file to which to go.
7524 \begin_layout Description
7525 Sample server-goto-file-row /home/user/example.lyx 41
7526 \begin_inset Newline newline
7529 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
7532 \begin_layout Description
7533 Origin Edmar, 23 Dec 1998
7536 \begin_layout Subsection*
7540 \begin_layout Description
7541 Action Sends notify message about the last key-sequence to client.
7544 \begin_layout Description
7545 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
7548 \begin_layout Description
7549 Syntax server-notify
7552 \begin_layout Subsection*
7556 \begin_layout Description
7557 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
7560 \begin_layout Description
7561 Syntax server-set-xy <X> <Y>
7564 \begin_layout Subsection*
7568 \begin_layout Description
7569 Action Set the given LyX color to the color defined by the X11 name given, and optionally a specific color for dark mode.
7572 \begin_layout Description
7573 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
7576 \begin_layout Description
7577 Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
7580 \begin_layout Description
7581 Origin SLior, 11 Jun 2000
7584 \begin_layout Subsection*
7588 \begin_layout Description
7589 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
7592 \begin_layout Description
7593 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7596 \begin_layout Description
7600 \begin_layout Description
7601 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7604 \begin_layout Subsection*
7608 \begin_layout Description
7609 Action Checks-in/commits the changes of the registered file to the repository.
7612 \begin_layout Description
7613 Notion In RCS case this also unlocks the file.
7616 \begin_layout Description
7620 \begin_layout Description
7621 Origin Lgb, 1 Jul 1997
7624 \begin_layout Subsection*
7628 \begin_layout Description
7629 Action Checks-out the document for edit (and locks it in some cases).
7632 \begin_layout Description
7636 \begin_layout Description
7637 Origin Lgb, 1 Jul 1997
7640 \begin_layout Subsection*
7644 \begin_layout Description
7645 Action Executes external command. This command is intended to support additional VCS commands.
7648 \begin_layout Description
7649 Syntax vc-command <FLAG> <PATH> <COMMAND>
7652 \begin_layout Description
7653 Params <FLAG>: Flags for the command can be combined together.
7654 \begin_inset Newline newline
7657 U - dUmmy - no flags
7658 \begin_inset Newline newline
7661 D - Doc - need document loaded to proceed
7662 \begin_inset Newline newline
7665 I - dIrty - mark document dirty
7666 \begin_inset Newline newline
7669 R - Reload - ensure that the document is saved and reload it after command execution
7670 \begin_inset Newline newline
7673 M - Message - ask for input string (commit message)
7674 \begin_inset Newline newline
7677 <PATH>: path where to start. $$p will be replaced by the current document path.
7678 \begin_inset Newline newline
7681 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
7684 \begin_layout Description
7685 Sample vc-command DR $$p "svn up"
7688 \begin_layout Description
7689 Origin sanda, 13 Jan 2009
7692 \begin_layout Subsection*
7696 \begin_layout Description
7697 Action Compares two revisions of the same file under version control.
7700 \begin_layout Description
7701 Syntax vc-compare [<REV1>] [<REV2>]
7704 \begin_layout Description
7705 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
7706 \begin_inset Newline newline
7709 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
7710 \begin_inset Newline newline
7714 \begin_inset Newline newline
7717 <REV2>: Newer file. Used only if REV1 > 0.
7718 \begin_inset Newline newline
7721 If no parameter is given, interactive dialog will be shown.
7724 \begin_layout Description
7725 Sample Compare current document against last commit
7726 \begin_inset Newline newline
7730 \begin_inset Newline newline
7733 Compare current document against current revision - 5 commits
7734 \begin_inset Newline newline
7738 \begin_inset Newline newline
7741 Compare revisions 120 and 155
7742 \begin_inset Newline newline
7748 \begin_layout Description
7749 Origin sanda, 12 Feb 2010
7752 \begin_layout Subsection*
7756 \begin_layout Description
7757 Action Copies the document to another name.
7760 \begin_layout Description
7761 Notion Copying with revision history is only supported by SVN. For RCS and CVS it is simulated by adding the document under a new name. Disabled if uncommitted changes exist.
7764 \begin_layout Description
7765 Syntax vc-copy <FILENAME>
7768 \begin_layout Description
7769 Params <FILENAME>: New name of the document.
7770 \begin_inset Newline newline
7773 A file dialog is opened if no filename is given.
7776 \begin_layout Description
7777 Origin gb, 05 Feb 2013
7780 \begin_layout Subsection*
7784 \begin_layout Description
7785 Action Toggles the locking property of the edited file.
7788 \begin_layout Description
7789 Notion This is currently implemented only for SVN.
7792 \begin_layout Description
7793 Syntax vc-locking-toggle
7796 \begin_layout Description
7797 Origin sanda, 25 Jun 2009
7800 \begin_layout Subsection*
7804 \begin_layout Description
7805 Action Register the document as an file inside version control system.
7808 \begin_layout Description
7809 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
7810 \begin_inset Newline newline
7813 See LyX Additional Features Manual (Version Control Chapter) for additional information.
7816 \begin_layout Description
7820 \begin_layout Description
7821 Origin Lgb, 1 Jul 1997
7824 \begin_layout Subsection*
7828 \begin_layout Description
7829 Action Renames the document to another name.
7832 \begin_layout Description
7833 Notion Renaming with revision history is only supported by SVN. For CVS it is simulated by adding the document under a new name and deleting the old one. For RCS it is not supported. Disabled if uncommitted changes exist.
7836 \begin_layout Description
7837 Syntax vc-rename <FILENAME>
7840 \begin_layout Description
7841 Params <FILENAME>: New name of the document.
7842 \begin_inset Newline newline
7845 A file dialog is opened if no filename is given.
7848 \begin_layout Description
7849 Origin gb, 05 Feb 2013
7852 \begin_layout Subsection*
7856 \begin_layout Description
7857 Action Update the local archive directory in which resides the current document with the remote repository.
7860 \begin_layout Description
7861 Syntax vc-repo-update
7864 \begin_layout Description
7865 Origin sanda, 16 Oct 2009
7868 \begin_layout Subsection*
7872 \begin_layout Description
7873 Action Reverts the document to the last check-in/commit in VCS.
7876 \begin_layout Description
7880 \begin_layout Description
7881 Origin Lgb, 1 Jul 1997
7884 \begin_layout Subsection*
7888 \begin_layout Description
7889 Action Undo last check-in.
7892 \begin_layout Description
7893 Notion This is currently implemented only for RCS.
7896 \begin_layout Description
7900 \begin_layout Description
7901 Origin Lgb, 1 Jul 1997
7904 \begin_layout Section
7905 Hidden Functions (not listed for configuration)
7908 \begin_layout Subsection*
7912 \begin_layout Description
7913 Action Return the current key sequence and available options as a string.
7916 \begin_layout Description
7917 Notion No options are added if no current map exists.
7918 \begin_inset Newline newline
7921 This is probably usable only with connection to lyxserver.
7924 \begin_layout Description
7925 Syntax command-prefix
7928 \begin_layout Subsection*
7932 \begin_layout Description
7933 Action Activates the LyX window.
7936 \begin_layout Description
7937 Notion On Linux and Mac OS, this action brings the LyX window into focus. Such behavior is not allowed by Windows OS so instead the color of the taskbar entry is changed to indicate that the window has changed in some way. This action is useful in combination with reverse search.
7940 \begin_layout Description
7944 \begin_layout Description
7945 Origin skostysh, 4 Aug 2016
7948 \begin_layout Subsection*
7952 \begin_layout Description
7953 Action Inserts the given string (accordingly to the correct keymap).
7956 \begin_layout Description
7957 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7960 \begin_layout Description
7961 Syntax self-insert <STRING>
7964 \begin_layout Subsection*
7968 \begin_layout Description
7969 Action Raises the LyX window.
7972 \begin_layout Description
7973 Notion Brings the LyX window to the front. Such behavior is allowed on Windows only when no other application has focus. This action is used when LyX is in single instance mode.
7976 \begin_layout Description
7980 \begin_layout Description
7981 Origin forenr, 21 Apr 2020
projects / lyx.git / blob