1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
10 \renewenvironment{description}{\list{}{%
11 \setlength{\itemsep}{-2pt}
12 \advance\leftmargini6\p@ \itemindent-12\p@
13 \labelwidth\z@ \let\makelabel\descriptionlabel}%
18 \use_default_options false
19 \maintain_unincluded_children no
27 \language_package default
28 \inputencoding auto-legacy
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
38 \font_typewriter_osf false
40 \font_sf_scale 100 100
41 \font_tt_scale 100 100
44 \default_output_format default
46 \bibtex_command default
47 \index_command default
48 \paperfontsize default
53 \use_package amsmath 1
54 \use_package amssymb 1
57 \use_package mathdots 0
58 \use_package mathtools 0
60 \use_package stackrel 0
61 \use_package stmaryrd 0
62 \use_package undertilde 0
64 \cite_engine_type default
68 \paperorientation portrait
84 \paragraph_separation indent
85 \paragraph_indentation default
87 \math_numbering_side default
91 \paperpagestyle default
92 \tracking_changes false
93 \postpone_fragile_content false
112 \begin_layout Section*
116 \begin_layout Standard
117 This manual documents the
118 \begin_inset Quotes eld
122 \begin_inset Quotes erd
126 These are commands that are used to make \SpecialChar LyX
127 perform specific actions.
129 itself uses these functions internally, and every internal action is
133 \begin_layout Standard
134 LFUNs are also used in the files that define keyboard shortcuts, menu or
136 So if you want to change\SpecialChar breakableslash
137 customize the user interface, you need to deal
139 Furthermore, external programs can use LFUNs to communicate with and
140 \begin_inset Quotes eld
144 \begin_inset Quotes erd
149 Finally, you can also issue LFUNs directly via the so called mini-buffer
150 which can be opened via
153 arg "command-execute"
159 \begin_layout Standard
160 In the following, all LFUNs are listed, categorized by function.
163 \begin_layout Section
164 Layout Functions (Font, Layout and Textclass related)
167 \begin_layout Subsection*
171 \begin_layout Description
172 Action Displays list of layout choices.
175 \begin_layout Description
176 Notion This LFUN opens the dropbox allowing for choice of layout.
179 \begin_layout Description
180 Syntax drop-layouts-choice
183 \begin_layout Subsection*
187 \begin_layout Description
188 Action Splits the current environment with a Separator.
191 \begin_layout Description
192 Syntax environment-split [before|outer|previous]
195 \begin_layout Description
196 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
197 \begin_inset Newline newline
200 previous: If this is given, LyX will split the environment in the previous paragraph (if there is one).
201 \begin_inset Newline newline
204 before: If this is given, the new environment will be appended rather than prepended.
207 \begin_layout Description
208 Origin spitz, 23 Dec 2012
211 \begin_layout Subsection*
215 \begin_layout Description
216 Action Toggles the bold font (selection-wise) using mathbf in math.
219 \begin_layout Description
223 \begin_layout Subsection*
227 \begin_layout Description
228 Action Toggles the bold font (selection-wise) using boldsymbol in math.
231 \begin_layout Description
232 Syntax font-boldsymbol
235 \begin_layout Subsection*
239 \begin_layout Description
240 Action Toggles xout (cross-through) in the font (selection-wise).
243 \begin_layout Description
247 \begin_layout Description
248 Origin uwestoehr, 4 April 2017
251 \begin_layout Subsection*
255 \begin_layout Description
256 Action Reverts the settings of the font to the default values (selection-wise).
259 \begin_layout Description
263 \begin_layout Subsection*
267 \begin_layout Description
268 Action Toggles the emphasis font style (selection-wise).
271 \begin_layout Description
275 \begin_layout Subsection*
279 \begin_layout Description
280 Action Toggles Fraktur family font (math-mode, selection-wise).
283 \begin_layout Description
287 \begin_layout Description
288 Origin vermeer, 10 Jan 2002
291 \begin_layout Subsection*
295 \begin_layout Description
296 Action Toggles Italics font shape (math-mode, selection-wise).
299 \begin_layout Description
303 \begin_layout Description
304 Origin vermeer, 10 Jan 2002
307 \begin_layout Subsection*
311 \begin_layout Description
312 Action Toggles nospellcheck status in the font (selection-wise).
315 \begin_layout Description
316 Syntax font-nospellcheck
319 \begin_layout Description
320 Origin spitz, 5 March 2021
323 \begin_layout Subsection*
327 \begin_layout Description
328 Action Toggles Noun text style font (selection-wise).
331 \begin_layout Description
335 \begin_layout Subsection*
339 \begin_layout Description
340 Action Toggles Roman family font (selection-wise).
343 \begin_layout Description
347 \begin_layout Subsection*
351 \begin_layout Description
352 Action Toggles Sans Serif family font (selection-wise).
355 \begin_layout Description
359 \begin_layout Subsection*
363 \begin_layout Description
364 Action Sets font size according to lyx format string.
367 \begin_layout Description
368 Syntax font-size <SIZE>
371 \begin_layout Description
372 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
373 \begin_inset Newline newline
376 largest|huge|giant|increase|decrease|default
379 \begin_layout Subsection*
383 \begin_layout Description
384 Action Returns the info about the current font.
387 \begin_layout Description
391 \begin_layout Subsection*
395 \begin_layout Description
396 Action Toggles strikeout (strike-through) in the font (selection-wise).
399 \begin_layout Description
400 Syntax font-strikeout
403 \begin_layout Description
404 Origin sanda, 3 May 2009
407 \begin_layout Subsection*
411 \begin_layout Description
412 Action Toggles the typewriter family font (selection-wise).
415 \begin_layout Description
416 Syntax font-typewriter
419 \begin_layout Subsection*
423 \begin_layout Description
424 Action Toggles underline in the font (selection-wise).
427 \begin_layout Description
428 Syntax font-underline
431 \begin_layout Subsection*
435 \begin_layout Description
436 Action Toggles double underline in the font (selection-wise).
439 \begin_layout Description
440 Syntax font-underunderline
443 \begin_layout Description
444 Origin sanda, 5 May 2009
447 \begin_layout Subsection*
451 \begin_layout Description
452 Action Toggles wavy underline in the font (selection-wise).
455 \begin_layout Description
456 Syntax font-underwave
459 \begin_layout Description
460 Origin sanda, 5 May 2009
463 \begin_layout Subsection*
467 \begin_layout Description
468 Action Sets the layout (that is, environment) for the current paragraph.
471 \begin_layout Description
472 Syntax layout <LAYOUT> [ignoreautonests]
475 \begin_layout Description
476 Params <LAYOUT>: the layout to use
477 \begin_inset Newline newline
480 ignoreautonests: If specified, nesting advices will be ignored.
483 \begin_layout Subsection*
487 \begin_layout Description
488 Action Adds a module.
491 \begin_layout Description
492 Notion Adds a module to the list of included modules for the current buffer.
495 \begin_layout Description
496 Syntax layout-module-add <MODULE>
499 \begin_layout Description
500 Params <MODULE>: the module to be added
503 \begin_layout Description
504 Origin rgh, 25 August 2007
507 \begin_layout Subsection*
511 \begin_layout Description
512 Action Clears the module list.
515 \begin_layout Description
516 Notion Clears the list of included modules for the current buffer.
519 \begin_layout Description
520 Syntax layout-modules-clear
523 \begin_layout Description
524 Origin rgh, 25 August 2007
527 \begin_layout Subsection*
531 \begin_layout Description
532 Action Launches the paragraph settings dialog.
535 \begin_layout Description
536 Syntax layout-paragraph
539 \begin_layout Subsection*
543 \begin_layout Description
544 Action Reloads layout information.
547 \begin_layout Description
548 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.
551 \begin_layout Description
555 \begin_layout Description
556 Origin rgh, 3 September 2007
559 \begin_layout Subsection*
563 \begin_layout Description
564 Action Launches the tabular settings dialog.
567 \begin_layout Description
568 Syntax layout-tabular
571 \begin_layout Description
572 Origin Jug, 31 Jul 2000
575 \begin_layout Subsection*
579 \begin_layout Description
580 Action Toggles the layout (that is, environment) for the current paragraph.
583 \begin_layout Description
584 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.
587 \begin_layout Description
588 Syntax layout-toggle <LAYOUT> [ignoreautonests]
591 \begin_layout Description
592 Params <LAYOUT>: the layout to toggle
593 \begin_inset Newline newline
596 ignoreautonests: If specified, nesting advices will be ignored.
599 \begin_layout Description
600 Origin lasgouttes, 14 May 2018
603 \begin_layout Subsection*
607 \begin_layout Description
608 Action Update fonts and its metrics.
611 \begin_layout Description
612 Notion Automatically called after zoom, dpi, font names, or norm change.
615 \begin_layout Description
616 Syntax screen-font-update
619 \begin_layout Description
620 Origin ARRae, 13 Aug 2000
623 \begin_layout Subsection*
627 \begin_layout Description
628 Action Sets the text class for the current buffer.
631 \begin_layout Description
632 Syntax textclass-apply <TEXTCLASS>
635 \begin_layout Description
636 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
639 \begin_layout Subsection*
643 \begin_layout Description
644 Action Loads information for a textclass from disk.
647 \begin_layout Description
648 Syntax textclass-load <TEXTCLASS>
651 \begin_layout Description
652 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
655 \begin_layout Subsection*
659 \begin_layout Description
660 Action Apply last used text properties.
663 \begin_layout Description
664 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
667 \begin_layout Description
668 Syntax textstyle-apply [<NUM>]textstyle-apply
671 \begin_layout Description
672 Params <NUM>: number of the selection in the internal freefonts stack to be applied.
675 \begin_layout Description
676 Origin leeming, 12 Mar 2003
679 \begin_layout Subsection*
683 \begin_layout Description
684 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
687 \begin_layout Description
688 Syntax textstyle-update <FONT_INFO>
691 \begin_layout Description
692 Params <FONT_INFO>: specifies font attributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
693 \begin_inset Newline newline
696 Use lyx -dbg action for exact syntax of text-style dialog parameters.
699 \begin_layout Description
700 Origin leeming, 12 Mar 2003
703 \begin_layout Section
704 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
707 \begin_layout Subsection*
711 \begin_layout Description
712 Action Adds an acute accent to the next character typed.
715 \begin_layout Description
719 \begin_layout Subsection*
723 \begin_layout Description
724 Action Adds a breve accent to the next character typed.
727 \begin_layout Description
731 \begin_layout Subsection*
735 \begin_layout Description
736 Action Adds a caron to the next character typed.
739 \begin_layout Description
743 \begin_layout Subsection*
747 \begin_layout Description
748 Action Adds a cedilla to the next character typed.
751 \begin_layout Description
752 Syntax accent-cedilla
755 \begin_layout Subsection*
759 \begin_layout Description
760 Action Adds a circle accent to the next character typed.
763 \begin_layout Description
767 \begin_layout Subsection*
771 \begin_layout Description
772 Action Adds a circumflex to the next character typed.
775 \begin_layout Description
776 Syntax accent-circumflex
779 \begin_layout Subsection*
783 \begin_layout Description
784 Action Adds a dot accent to the next character typed.
787 \begin_layout Description
791 \begin_layout Subsection*
795 \begin_layout Description
796 Action Adds a grave accent to the next character typed.
799 \begin_layout Description
803 \begin_layout Subsection*
804 accent-hungarian-umlaut
807 \begin_layout Description
808 Action Adds a Hungarian umlaut to the next character typed.
811 \begin_layout Description
815 \begin_layout Subsection*
819 \begin_layout Description
820 Action Adds a macron to the next character typed.
823 \begin_layout Description
827 \begin_layout Subsection*
831 \begin_layout Description
832 Action Adds an ogonek accent to the next character typed.
835 \begin_layout Description
839 \begin_layout Subsection*
843 \begin_layout Description
844 Action Adds a perispomeni (Greek circumflex) over the next character typed.
847 \begin_layout Description
848 Syntax accent-perispomeni
851 \begin_layout Subsection*
855 \begin_layout Description
856 Action Adds a tie over the next two character typed.
859 \begin_layout Description
860 Notion The following char will finish the tie.
863 \begin_layout Description
867 \begin_layout Subsection*
871 \begin_layout Description
872 Action Adds a tilde over the next character typed.
875 \begin_layout Description
879 \begin_layout Subsection*
883 \begin_layout Description
884 Action Adds an umlaut over the next character typed.
887 \begin_layout Description
891 \begin_layout Subsection*
895 \begin_layout Description
896 Action Adds a bar under the next character typed.
899 \begin_layout Description
900 Syntax accent-underbar
903 \begin_layout Subsection*
907 \begin_layout Description
908 Action Adds a dot under the next character typed.
911 \begin_layout Description
912 Syntax accent-underdot
915 \begin_layout Subsection*
919 \begin_layout Description
920 Action Accepts all tracked changes in the document.
923 \begin_layout Description
924 Syntax all-changes-accept
927 \begin_layout Description
928 Origin Levon, 16 Oct 2002
931 \begin_layout Subsection*
935 \begin_layout Description
936 Action Rejects all tracked changes in the document.
939 \begin_layout Description
940 Notion Reject does not work recursively; the user may have to repeat the operation.
943 \begin_layout Description
944 Syntax all-changes-reject
947 \begin_layout Description
948 Origin Levon, 16 Oct 2002
951 \begin_layout Subsection*
955 \begin_layout Description
956 Action Start (or remove) Appendix on the given cursor position.
959 \begin_layout Description
963 \begin_layout Description
964 Origin ettrich, 5 May 1998
967 \begin_layout Subsection*
971 \begin_layout Description
972 Action Inserts an argument (short title) inset.
975 \begin_layout Description
976 Syntax argument-insert <argument nr>
979 \begin_layout Description
980 Params <argument nr>: see layout declarations
983 \begin_layout Description
984 Origin vermeer, 12 Aug 2002
987 \begin_layout Subsection*
991 \begin_layout Description
992 Action Adds database, which will be used for bibtex citations.
995 \begin_layout Description
996 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
999 \begin_layout Description
1000 Syntax bibtex-database-add <DATABASE-NAME>
1003 \begin_layout Description
1004 Origin Ale, 30 May 1997
1007 \begin_layout Subsection*
1011 \begin_layout Description
1012 Action Adds database, which will be used for bibtex citations.
1015 \begin_layout Description
1016 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1019 \begin_layout Description
1020 Syntax bibtex-database-del <DATABASE-NAME>
1023 \begin_layout Description
1024 Origin Ale, 30 May 1997
1027 \begin_layout Subsection*
1031 \begin_layout Description
1032 Action Clears the list of saved bookmarks.
1035 \begin_layout Description
1036 Syntax bookmark-clear
1039 \begin_layout Description
1040 Origin bpeng, 31 October 2006
1043 \begin_layout Subsection*
1047 \begin_layout Description
1048 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
1051 \begin_layout Description
1052 Notion Bookmark 0 has a special purpose. It is automatically set
1053 \begin_inset Newline newline
1056 1. to the paragraph you are currently editing
1057 \begin_inset Newline newline
1060 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1061 \begin_inset Newline newline
1064 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1067 \begin_layout Description
1068 Syntax bookmark-goto <NUMBER>
1071 \begin_layout Description
1072 Params <NUMBER>: the number of the bookmark to restore.
1075 \begin_layout Description
1076 Origin Dekel, 27 January 2001
1079 \begin_layout Subsection*
1083 \begin_layout Description
1084 Action Save a bookmark.
1087 \begin_layout Description
1088 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.
1091 \begin_layout Description
1092 Syntax bookmark-save <NUMBER>
1095 \begin_layout Description
1096 Params <NUMBER>: the number of the bookmark to save.
1099 \begin_layout Description
1100 Origin Dekel, 27 January 2001
1103 \begin_layout Subsection*
1107 \begin_layout Description
1108 Action Inserts Box inset.
1111 \begin_layout Description
1112 Syntax box-insert [<TYPE>]
1115 \begin_layout Description
1116 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1117 \begin_inset Newline newline
1120 Framed is the default one.
1123 \begin_layout Description
1124 Origin vermeer, 7 Oct 2003
1127 \begin_layout Subsection*
1131 \begin_layout Description
1132 Action Inserts branch inset.
1135 \begin_layout Description
1136 Syntax branch-insert <BRANCH-NAME>
1139 \begin_layout Description
1140 Origin vermeer, 17 Aug 2003
1143 \begin_layout Subsection*
1147 \begin_layout Description
1148 Action For debug purposes only. Convert all [a-zA-Z0-1] characters to single character. Useful when submitting docs to list or bugzilla.
1151 \begin_layout Description
1152 Syntax buffer-anonymize
1155 \begin_layout Description
1156 Origin sanda, Feb 1 2018
1159 \begin_layout Subsection*
1163 \begin_layout Description
1164 Action Move the cursor to the beginning of the document.
1167 \begin_layout Description
1171 \begin_layout Subsection*
1175 \begin_layout Description
1176 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1179 \begin_layout Description
1180 Syntax buffer-begin-select
1183 \begin_layout Subsection*
1187 \begin_layout Description
1188 Action Move the cursor to the end of the document.
1191 \begin_layout Description
1195 \begin_layout Subsection*
1199 \begin_layout Description
1200 Action Move the cursor to the end of the document adding the traversed text to the selection.
1203 \begin_layout Description
1204 Syntax buffer-end-select
1207 \begin_layout Subsection*
1211 \begin_layout Description
1212 Action Inserts a caption inset.
1215 \begin_layout Description
1216 Syntax caption-insert
1219 \begin_layout Description
1220 Origin Lgb, 18 Jul 2000
1223 \begin_layout Subsection*
1227 \begin_layout Description
1228 Action Moves the cursor to the previous cell inside the table.
1231 \begin_layout Description
1232 Syntax cell-backward
1235 \begin_layout Description
1236 Origin Jug, 22 May 2000
1239 \begin_layout Subsection*
1243 \begin_layout Description
1244 Action Moves the cursor to the next cell inside the table.
1247 \begin_layout Description
1251 \begin_layout Subsection*
1255 \begin_layout Description
1256 Action Splits cell and shifts right part to the next cell (inside the math grid).
1259 \begin_layout Description
1263 \begin_layout Description
1264 Origin Ale, 15 May 1997
1267 \begin_layout Subsection*
1271 \begin_layout Description
1272 Action Accepts tracked change inside the selection.
1275 \begin_layout Description
1276 Syntax change-accept
1279 \begin_layout Description
1280 Origin Levon, 16 Oct 2002
1283 \begin_layout Subsection*
1287 \begin_layout Description
1288 Action Moves the cursor to the position of the next change of the change tracking records.
1291 \begin_layout Description
1295 \begin_layout Description
1296 Origin schmitt, 4 Oct 2006
1299 \begin_layout Subsection*
1303 \begin_layout Description
1304 Action Moves the cursor to the position of the previous change of the change tracking records.
1307 \begin_layout Description
1308 Syntax change-previous
1311 \begin_layout Description
1312 Origin vfr, 4 Apr 2009
1315 \begin_layout Subsection*
1319 \begin_layout Description
1320 Action Rejects tracked change inside the selection.
1323 \begin_layout Description
1324 Syntax change-reject
1327 \begin_layout Description
1328 Origin Levon, 16 Oct 2002
1331 \begin_layout Subsection*
1335 \begin_layout Description
1336 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1339 \begin_layout Description
1340 Syntax changes-merge
1343 \begin_layout Description
1344 Origin Levon, 16 Oct 2002
1347 \begin_layout Subsection*
1351 \begin_layout Description
1352 Action Toggles showing of change tracking in typeset output.
1355 \begin_layout Description
1356 Syntax changes-output
1359 \begin_layout Description
1360 Origin spitz, 21 Jan 2005
1363 \begin_layout Subsection*
1367 \begin_layout Description
1368 Action Toggles change tracking to on/off.
1371 \begin_layout Description
1372 Syntax changes-track
1375 \begin_layout Description
1376 Origin levon, 1 Oct 2002
1379 \begin_layout Subsection*
1383 \begin_layout Description
1384 Action Moves the cursor one position logically backwards.
1387 \begin_layout Description
1388 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.
1391 \begin_layout Description
1392 Syntax char-backward
1395 \begin_layout Subsection*
1396 char-backward-select
1399 \begin_layout Description
1400 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1403 \begin_layout Description
1404 Notion See also LFUN_CHAR_BACKWARD.
1407 \begin_layout Description
1408 Syntax char-backward-select
1411 \begin_layout Subsection*
1412 char-delete-backward
1415 \begin_layout Description
1416 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1419 \begin_layout Description
1420 Syntax char-delete-backward [confirm]
1423 \begin_layout Description
1424 Params confirm: Select big insets, do not directly delete them.
1427 \begin_layout Subsection*
1431 \begin_layout Description
1432 Action Deletes one character in the backward direction (usually the "Delete" key).
1435 \begin_layout Description
1436 Syntax char-delete-forward [confirm]
1439 \begin_layout Description
1440 Params confirm: Select big insets, do not directly delete them.
1443 \begin_layout Subsection*
1447 \begin_layout Description
1448 Action Moves the cursor one position logically forward.
1451 \begin_layout Description
1452 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.
1455 \begin_layout Description
1459 \begin_layout Subsection*
1463 \begin_layout Description
1464 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1467 \begin_layout Description
1468 Notion See also LFUN_CHAR_FORWARD.
1471 \begin_layout Description
1472 Syntax char-forward-select
1475 \begin_layout Subsection*
1479 \begin_layout Description
1480 Action Moves the cursor one position "to the left".
1483 \begin_layout Description
1484 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.
1487 \begin_layout Description
1491 \begin_layout Subsection*
1495 \begin_layout Description
1496 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1499 \begin_layout Description
1500 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1503 \begin_layout Description
1504 Syntax char-left-select
1507 \begin_layout Subsection*
1511 \begin_layout Description
1512 Action Moves the cursor one position "to the right".
1515 \begin_layout Description
1516 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.
1519 \begin_layout Description
1523 \begin_layout Subsection*
1527 \begin_layout Description
1528 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1531 \begin_layout Description
1532 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1535 \begin_layout Description
1536 Syntax char-right-select
1539 \begin_layout Subsection*
1543 \begin_layout Description
1544 Action Transposes the character at the cursor with the one before it.
1547 \begin_layout Description
1548 Syntax chars-transpose
1551 \begin_layout Description
1552 Origin Lgb, 25 Apr 2001
1555 \begin_layout Subsection*
1559 \begin_layout Description
1560 Action Inserts citation from loaded citation database.
1563 \begin_layout Description
1564 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1567 \begin_layout Description
1568 Params <KEY>: Citation (shortcut listed in available citations).
1569 \begin_inset Newline newline
1572 <TEXT_BEFORE>: text which should appear before citation.
1575 \begin_layout Description
1576 Origin AAS, 97-02-23
1579 \begin_layout Subsection*
1583 \begin_layout Description
1584 Action Opens the corresponding pdf/url for a given citation inset.
1587 \begin_layout Description
1588 Syntax citation-open [EXTERNAL] TARGET
1591 \begin_layout Description
1592 Params <TARGET>: URL (https:,file:) of the document.
1593 \begin_inset Newline newline
1596 <EXTERNAL>: Use external executable script for finding target
1597 \begin_inset Newline newline
1600 and launching viewer. In this case TARGET consists of author and year
1601 \begin_inset Newline newline
1604 and will be passed as an input argument to the script.
1607 \begin_layout Description
1608 Origin Sanda, 16 Aug 2020
1611 \begin_layout Subsection*
1615 \begin_layout Description
1616 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.
1619 \begin_layout Description
1620 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.
1623 \begin_layout Description
1624 Syntax clipboard-paste [<ARG>]
1627 \begin_layout Description
1628 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1631 \begin_layout Description
1632 Origin Georg, 10 Jul 2006
1635 \begin_layout Subsection*
1636 clipboard-paste-simple
1639 \begin_layout Description
1640 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.
1643 \begin_layout Description
1644 Syntax clipboard-paste-simple [<ARG>]
1647 \begin_layout Description
1648 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1651 \begin_layout Subsection*
1655 \begin_layout Description
1656 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1659 \begin_layout Description
1660 Notion Usually bound to M-x shortcut.
1663 \begin_layout Description
1664 Syntax command-execute
1667 \begin_layout Subsection*
1671 \begin_layout Description
1672 Action Try to complete the word or command at the cursor position.
1675 \begin_layout Description
1679 \begin_layout Description
1680 Origin sts, Feb 19 2008
1683 \begin_layout Subsection*
1687 \begin_layout Description
1688 Action Accept suggested completion.
1691 \begin_layout Description
1692 Syntax completion-accept
1695 \begin_layout Description
1696 Origin sanda, Sep 08 2008
1699 \begin_layout Subsection*
1703 \begin_layout Description
1704 Action Try to cancel completion, either the popup or the inline completion.
1707 \begin_layout Description
1708 Syntax completion-cancel
1711 \begin_layout Description
1712 Origin sts, Sep 07 2008
1715 \begin_layout Subsection*
1719 \begin_layout Description
1720 Action Show the inline completion at the cursor position.
1723 \begin_layout Description
1724 Syntax completion-inline
1727 \begin_layout Description
1728 Origin sts, Feb 19 2008
1731 \begin_layout Subsection*
1735 \begin_layout Description
1736 Action Show the completion popup at the cursor position.
1739 \begin_layout Description
1740 Syntax completion-popup
1743 \begin_layout Description
1744 Origin sts, Feb 19 2008
1747 \begin_layout Subsection*
1751 \begin_layout Description
1752 Action Copies the current selection to the clipboard.
1755 \begin_layout Description
1759 \begin_layout Subsection*
1763 \begin_layout Description
1764 Action Cuts to the clipboard.
1767 \begin_layout Description
1771 \begin_layout Subsection*
1775 \begin_layout Description
1776 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1779 \begin_layout Description
1780 Syntax depth-decrement
1783 \begin_layout Subsection*
1787 \begin_layout Description
1788 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1791 \begin_layout Description
1792 Syntax depth-increment
1795 \begin_layout Subsection*
1796 dialog-disconnect-inset
1799 \begin_layout Description
1800 Action Closes opened connection to opened inset.
1803 \begin_layout Description
1804 Notion Connection is used for apply functions.
1807 \begin_layout Description
1808 Syntax dialog-disconnect-inset <INSET-NAME>
1811 \begin_layout Description
1812 Origin leeming, 25 Feb 2003
1815 \begin_layout Subsection*
1819 \begin_layout Description
1820 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1823 \begin_layout Description
1824 Syntax dialog-hide <NAME>
1827 \begin_layout Description
1828 Params See LFUN_DIALOG_SHOW .
1831 \begin_layout Description
1832 Origin leeming, 25 Feb 2003
1835 \begin_layout Subsection*
1839 \begin_layout Description
1840 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1843 \begin_layout Description
1844 Syntax dialog-show <NAME> [<DATA>]
1847 \begin_layout Description
1848 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1849 \begin_inset Newline newline
1852 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1853 \begin_inset Newline newline
1856 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1857 \begin_inset Newline newline
1860 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1861 \begin_inset Newline newline
1864 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1865 \begin_inset Newline newline
1868 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1869 \begin_inset Newline newline
1872 <SPECIAL>: latexlog|vclog
1873 \begin_inset Newline newline
1876 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1879 \begin_layout Description
1880 Origin leeming, 17 Jun 2003
1883 \begin_layout Subsection*
1884 dialog-show-new-inset
1887 \begin_layout Description
1888 Action Shows hidden dialog or create new one for a given inset settings etc.
1891 \begin_layout Description
1892 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1895 \begin_layout Description
1896 Syntax dialog-show-new-inset <NAME> [<DATA>]
1899 \begin_layout Description
1900 Params See LFUN_DIALOG_SHOW .
1903 \begin_layout Description
1904 Origin leeming, 25 Feb 2003
1907 \begin_layout Subsection*
1911 \begin_layout Description
1912 Action Toggles dialog between showed/hidden state.
1915 \begin_layout Description
1916 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1919 \begin_layout Description
1920 Syntax dialog-toggle <NAME> [<DATA>]
1923 \begin_layout Description
1924 Params See LFUN_DIALOG_SHOW .
1927 \begin_layout Description
1928 Origin spitz, 30 Apr 2007
1931 \begin_layout Subsection*
1935 \begin_layout Description
1936 Action Updates the dialog values from the inset/paragraph/document.
1939 \begin_layout Description
1940 Syntax dialog-update <NAME>
1943 \begin_layout Description
1944 Params <NAME>: paragraph|prefs|<INSET>
1945 \begin_inset Newline newline
1951 \begin_layout Description
1952 Origin leeming, 25 Feb 2003
1955 \begin_layout Subsection*
1959 \begin_layout Description
1960 Action Moves the cursor one line in downward direction.
1963 \begin_layout Description
1967 \begin_layout Subsection*
1971 \begin_layout Description
1972 Action Moves the cursor one line in downward direction adding the current position to the selection.
1975 \begin_layout Description
1979 \begin_layout Subsection*
1983 \begin_layout Description
1984 Action Inserts an ERT inset.
1987 \begin_layout Description
1991 \begin_layout Description
1992 Origin Jug, 18 Feb 2000
1995 \begin_layout Subsection*
1999 \begin_layout Description
2000 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
2003 \begin_layout Description
2007 \begin_layout Description
2008 Origin Lgb, 17 May 2001
2011 \begin_layout Subsection*
2015 \begin_layout Description
2016 Action Cancel background export process.
2019 \begin_layout Description
2020 Syntax export-cancel
2023 \begin_layout Description
2024 Origin rgh, 10 December 2017
2027 \begin_layout Subsection*
2031 \begin_layout Description
2032 Action Inserts another LyX file.
2035 \begin_layout Description
2036 Syntax file-insert [<FILE>] [ignorelang]
2039 \begin_layout Description
2040 Params <FILE>: Filename to be inserted. ignorelang: If given, the (main) language of the inserted file is ignored (the context language is used).
2043 \begin_layout Subsection*
2044 file-insert-plaintext
2047 \begin_layout Description
2048 Action Inserts plain text file.
2051 \begin_layout Description
2052 Syntax file-insert-plaintext [<FILE>]
2055 \begin_layout Description
2056 Params <FILE>: Filename to be inserted.
2059 \begin_layout Description
2060 Origin CFO-G, 19 Nov 1997
2063 \begin_layout Subsection*
2064 file-insert-plaintext-para
2067 \begin_layout Description
2068 Action Inserts plain text file as paragraph (i.e. join lines).
2071 \begin_layout Description
2072 Syntax file-insert-plaintext-para [<FILE>]
2075 \begin_layout Description
2076 Params <FILE>: Filename to be inserted.
2079 \begin_layout Description
2080 Origin Levon, 14 Feb 2001
2083 \begin_layout Subsection*
2087 \begin_layout Description
2088 Action Inserts CharStyle, Custom inset or XML short element.
2091 \begin_layout Description
2092 Notion Look into the Customization manual for more information about these elements.
2093 \begin_inset Newline newline
2096 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.
2097 \begin_inset Newline newline
2100 For dissolving the element see LFUN_INSET_DISSOLVE.
2103 \begin_layout Description
2104 Syntax flex-insert Name
2107 \begin_layout Description
2108 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.
2111 \begin_layout Description
2112 Sample flex-insert Code
2115 \begin_layout Subsection*
2119 \begin_layout Description
2120 Action Inserts a float inset.
2123 \begin_layout Description
2124 Syntax float-insert <TYPE>
2127 \begin_layout Description
2128 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2131 \begin_layout Description
2132 Origin Lgb, 27 Jun 2000
2135 \begin_layout Subsection*
2139 \begin_layout Description
2140 Action Inserts the list of floats in the document.
2143 \begin_layout Description
2144 Syntax float-list-insert <TYPE>
2147 \begin_layout Description
2148 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2151 \begin_layout Description
2152 Origin Lgb, 3 May 2001
2155 \begin_layout Subsection*
2159 \begin_layout Description
2160 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2163 \begin_layout Description
2164 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2167 \begin_layout Description
2168 Syntax float-wide-insert <TYPE>
2171 \begin_layout Description
2172 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2175 \begin_layout Description
2176 Origin Lgb, 31 Oct 2001
2179 \begin_layout Subsection*
2183 \begin_layout Description
2184 Action Inserts a footnote inset.
2187 \begin_layout Description
2188 Syntax footnote-insert
2191 \begin_layout Description
2192 Origin Jug, 7 Mar 2000
2195 \begin_layout Subsection*
2199 \begin_layout Description
2200 Action Reloads the image if necessary.
2203 \begin_layout Description
2204 Syntax graphics-reload
2207 \begin_layout Description
2208 Origin vfr, 10 Aug 2009
2211 \begin_layout Subsection*
2215 \begin_layout Description
2216 Action Set the group for the graphics inset on the cursor position.
2219 \begin_layout Description
2220 Syntax graphics-set-group [<GROUP>]
2223 \begin_layout Description
2224 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
2227 \begin_layout Description
2228 Origin sanda, 6 May 2008
2231 \begin_layout Subsection*
2235 \begin_layout Description
2236 Action Set the same group for all graphics insets in the marked block.
2239 \begin_layout Description
2240 Syntax graphics-unify [<GROUP>]
2243 \begin_layout Description
2244 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.
2247 \begin_layout Description
2248 Origin sanda, 7 Feb 2018
2251 \begin_layout Subsection*
2255 \begin_layout Description
2256 Action Inserts hyperlinks into the document (clickable in pdf output).
2259 \begin_layout Description
2260 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2263 \begin_layout Description
2264 Syntax href-insert [<TARGET>]
2267 \begin_layout Description
2268 Origin CFO-G, 21 Nov 1997
2271 \begin_layout Subsection*
2275 \begin_layout Description
2276 Action Only active in IPA inset.
2279 \begin_layout Description
2280 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.
2283 \begin_layout Description
2287 \begin_layout Description
2288 Origin spitz, 20 May 2012
2291 \begin_layout Subsection*
2295 \begin_layout Description
2296 Action Inserts Index entry.
2299 \begin_layout Description
2300 Notion It automatically takes the word on the cursor position.
2303 \begin_layout Description
2304 Syntax index-insert [<TYPE:Name>]
2307 \begin_layout Description
2308 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2311 \begin_layout Description
2312 Origin leeming, 3 Aug 2000
2315 \begin_layout Subsection*
2319 \begin_layout Description
2320 Action Inserts list of Index entries on a new page.
2323 \begin_layout Description
2324 Syntax index-print [<TYPE:Name>]
2327 \begin_layout Description
2328 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2331 \begin_layout Description
2332 Origin Lgb, 27 Feb 1997
2335 \begin_layout Subsection*
2339 \begin_layout Description
2340 Action Tags all occurrences of the word before the cursor with the index inset at cursor.
2343 \begin_layout Description
2344 Notion It automatically takes the word on the cursor position.
2347 \begin_layout Description
2348 Syntax index-tag-all
2351 \begin_layout Description
2352 Origin spitz, 5 Nov 2022
2355 \begin_layout Subsection*
2359 \begin_layout Description
2360 Action Inserts special Index macros into the document.
2363 \begin_layout Description
2364 Syntax indexmacro-insert <type>
2367 \begin_layout Description
2368 Params <type>: see, seealso, subentry, sortkey.
2371 \begin_layout Description
2372 Origin spitz, 20 Feb 2022
2375 \begin_layout Subsection*
2379 \begin_layout Description
2380 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2383 \begin_layout Description
2384 Notion Apart from lfun arguments you can use the following method:
2385 \begin_inset Newline newline
2388 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2389 \begin_inset Newline newline
2392 2. select the text and run info-insert lfun.
2395 \begin_layout Description
2396 Syntax info-insert <TYPE> <ARG>
2399 \begin_layout Description
2400 Params <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2401 \begin_inset Newline newline
2404 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2405 \begin_inset Newline newline
2408 date: current date (formatted and localized)
2409 \begin_inset Newline newline
2412 moddate: date of last modification (saving) (formatted and localized)
2413 \begin_inset Newline newline
2416 fixdate: a static date (formatted and localized)
2417 \begin_inset Newline newline
2420 time: current time (formatted and localized)
2421 \begin_inset Newline newline
2424 modtime: time of last modification (saving) (formatted and localized)
2425 \begin_inset Newline newline
2428 fixtime: a static time (formatted and localized)
2429 \begin_inset Newline newline
2432 shortcut[s]: name of lfun (e.g math-insert
2435 \begin_inset Newline newline
2438 lyxrc: name of rc_entry (e.g. bind_file)
2439 \begin_inset Newline newline
2442 lyxinfo: "version" - used version of LyX
2443 \begin_inset Newline newline
2446 package: name of latex package (e.g. listings)
2447 \begin_inset Newline newline
2450 textclass: name of textclass (e.g. article)
2451 \begin_inset Newline newline
2454 menu: name of lfun used in menu
2455 \begin_inset Newline newline
2458 l7n: localizable string.
2459 \begin_inset Newline newline
2462 icon: icon of lfun used in toolbar or direct icon name
2463 \begin_inset Newline newline
2466 buffer: "name"|"name-noext"|"path"|"class" vcs: "tree-revision"|"revision"|"author"|"date"|"time"
2469 \begin_layout Description
2470 Sample command-sequence info-insert buffer path; info-insert buffer name
2473 \begin_layout Description
2474 Origin bpeng, 7 Oct 2007
2477 \begin_layout Subsection*
2481 \begin_layout Description
2482 Action Apply data for an inset.
2485 \begin_layout Description
2486 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.
2489 \begin_layout Description
2490 Syntax inset-apply <ARGS>
2493 \begin_layout Description
2494 Params See LFUN_INSET_INSERT .
2497 \begin_layout Subsection*
2501 \begin_layout Description
2502 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.
2505 \begin_layout Description
2509 \begin_layout Description
2510 Origin lasgouttes, 16 Mar 2009
2513 \begin_layout Subsection*
2517 \begin_layout Description
2518 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).
2521 \begin_layout Description
2522 Syntax inset-begin-select
2525 \begin_layout Description
2526 Origin lasgouttes, 16 Mar 2009
2529 \begin_layout Subsection*
2533 \begin_layout Description
2534 Action Copies the inset to the clipboard as a certain type.
2537 \begin_layout Description
2538 Notion Currently used only for InsetInfo where its content is copied as a text.
2541 \begin_layout Description
2542 Syntax inset-copy-as
2545 \begin_layout Description
2546 Origin vfr, 18 Apr 2010
2549 \begin_layout Subsection*
2553 \begin_layout Description
2554 Action Dissolve the current inset into text.
2557 \begin_layout Description
2558 Syntax inset-dissolve [<INSET>]
2561 \begin_layout Description
2562 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.
2563 \begin_inset Newline newline
2566 For values see lyx::InsetLayout::lyxtype_ .
2569 \begin_layout Description
2570 Origin JSpitz, 7 Aug 2006
2573 \begin_layout Subsection*
2577 \begin_layout Description
2578 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.
2581 \begin_layout Description
2582 Syntax inset-edit [nogui] [<INSET_PARAMS>]
2585 \begin_layout Description
2586 Params <INSET_PARAMS>: Parameters for the inset.
2587 \begin_inset Newline newline
2590 Currently only the filename will be considered.
2591 \begin_inset Newline newline
2594 nogui: does not launch external editor, only returns filename to be processed.
2597 \begin_layout Description
2598 Origin spitz, 27 Apr 2006
2601 \begin_layout Subsection*
2605 \begin_layout Description
2606 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.
2609 \begin_layout Description
2613 \begin_layout Description
2614 Origin lasgouttes, 16 Mar 2009
2617 \begin_layout Subsection*
2621 \begin_layout Description
2622 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.
2625 \begin_layout Description
2626 Syntax inset-end-edit
2629 \begin_layout Description
2630 Origin gb, 11 Oct 2015
2633 \begin_layout Subsection*
2637 \begin_layout Description
2638 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).
2641 \begin_layout Description
2642 Syntax inset-end-select
2645 \begin_layout Description
2646 Origin lasgouttes, 16 Mar 2009
2649 \begin_layout Subsection*
2653 \begin_layout Description
2654 Action Apply the given commands on insets of a given name.
2657 \begin_layout Description
2658 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.
2661 \begin_layout Description
2662 Syntax inset-forall <NAME> <LFUN-COMMAND>
2663 \begin_inset Newline newline
2666 <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.
2669 \begin_layout Description
2670 Sample Remove all index insets:
2671 \begin_inset Newline newline
2674 inset-forall Index char-delete-forward
2675 \begin_inset Newline newline
2679 \begin_inset Newline newline
2682 inset-forall Note inset-toggle close
2683 \begin_inset Newline newline
2686 Open all branch insets of branch "myBranch":
2687 \begin_inset Newline newline
2690 inset-forall Branch:myBranch inset-toggle open
2691 \begin_inset Newline newline
2694 Transform all yellow notes to comments
2695 \begin_inset Newline newline
2698 inset-forall Note:Note inset-modify note Note Comment
2699 \begin_inset Newline newline
2702 Try to put LyX in an infinite loop if there is at least a Note:
2703 \begin_inset Newline newline
2706 inset-forall Note char-backward
2709 \begin_layout Description
2710 Origin lasgouttes, 27 Nov 2009
2713 \begin_layout Subsection*
2717 \begin_layout Description
2718 Action Insert new inset (type given by the parameters).
2721 \begin_layout Description
2722 Syntax inset-insert <INSET> <ARGS>
2725 \begin_layout Description
2726 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2727 \begin_inset Newline newline
2730 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2731 \begin_inset Newline newline
2734 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2737 \begin_layout Description
2738 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2741 \begin_inset Newline newline
2744 where <label name> is the name of the referenced label and <Format> is one of the following:
2745 \begin_inset Newline newline
2749 \begin_inset Newline newline
2752 eqref -- (<reference>)
2753 \begin_inset Newline newline
2757 \begin_inset Newline newline
2760 vpageref -- on <page>
2761 \begin_inset Newline newline
2764 vref -- <reference> on <page>
2765 \begin_inset Newline newline
2768 formatted -- Formatted reference
2771 \begin_layout Subsection*
2775 \begin_layout Description
2776 Action Inserts the inset's content (in ToC pane) at the position of the cursor.
2779 \begin_layout Description
2780 Syntax inset-insert-copy
2783 \begin_layout Description
2784 Origin spitz, 1 Nov 2022
2787 \begin_layout Subsection*
2791 \begin_layout Description
2792 Action Modify some properties of an inset.
2795 \begin_layout Description
2796 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.
2799 \begin_layout Description
2800 Syntax inset-modify <INSET> <ARGS>
2801 \begin_inset Newline newline
2804 inset-modify changetype <TYPE>
2807 \begin_layout Description
2808 Sample Change a Note inset into a Comment inset:
2809 \begin_inset Newline newline
2812 inset-modify note Note Comment
2813 \begin_inset Newline newline
2816 Change a Box into an Ovalbox:
2817 \begin_inset Newline newline
2820 inset-modify changetype Ovalbox
2821 \begin_inset Newline newline
2824 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
2825 \begin_inset Newline newline
2828 inset-modify changetype els
2829 \begin_inset Newline newline
2832 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
2833 \begin_inset Newline newline
2836 inset-modify changetype e..
2837 \begin_inset Newline newline
2843 \begin_layout Subsection*
2847 \begin_layout Description
2848 Action Select all contents of an inset.
2851 \begin_layout Description
2852 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2855 \begin_layout Description
2856 Syntax inset-select-all
2859 \begin_layout Description
2860 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2863 \begin_layout Subsection*
2867 \begin_layout Description
2868 Action Open the inset's properties dialog.
2871 \begin_layout Description
2872 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.
2875 \begin_layout Description
2876 Syntax inset-settings <INSET>
2879 \begin_layout Description
2880 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2881 \begin_inset Newline newline
2884 graphics|href|include|index|index_print|label|line|
2885 \begin_inset Newline newline
2888 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2891 \begin_layout Subsection*
2895 \begin_layout Description
2896 Action Splits the current inset into two at current position.
2899 \begin_layout Description
2900 Syntax inset-split [<INSET>]
2903 \begin_layout Description
2904 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.
2905 \begin_inset Newline newline
2908 For values see lyx::InsetLayout::lyxtype_ .
2911 \begin_layout Description
2912 Origin spitz, 22 Dec 2020
2915 \begin_layout Subsection*
2919 \begin_layout Description
2920 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2923 \begin_layout Description
2924 Syntax inset-toggle [<ARG>]
2927 \begin_layout Description
2928 Params <ARG>: <open|close|toggle|assign>.
2929 \begin_inset Newline newline
2932 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2933 \begin_inset Newline newline
2936 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2939 \begin_layout Description
2940 Origin lasgouttes, 19 Jul 2001
2943 \begin_layout Subsection*
2947 \begin_layout Description
2948 Action Inserts an IPA inset.
2951 \begin_layout Description
2955 \begin_layout Description
2956 Origin spitz, 05 Mar 2012
2959 \begin_layout Subsection*
2963 \begin_layout Description
2964 Action Inserts special IPA macros into the document.
2967 \begin_layout Description
2968 Syntax ipamacro-insert <CHAR>
2971 \begin_layout Description
2972 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2975 \begin_layout Description
2976 Origin spitz, 22 Aug 2012
2979 \begin_layout Subsection*
2983 \begin_layout Description
2984 Action Turn off the loaded keyboard map.
2987 \begin_layout Description
2991 \begin_layout Subsection*
2995 \begin_layout Description
2996 Action Turn on the primary keyboard map.
2999 \begin_layout Description
3000 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.
3001 \begin_inset Newline newline
3004 The language is to be set in the Preferences dialog.
3007 \begin_layout Description
3008 Syntax keymap-primary
3011 \begin_layout Subsection*
3015 \begin_layout Description
3016 Action Turn on the secondary keyboard map.
3019 \begin_layout Description
3020 Syntax keymap-secondary
3023 \begin_layout Subsection*
3027 \begin_layout Description
3028 Action Toggles keyboard maps (first/second/off).
3031 \begin_layout Description
3032 Syntax keymap-toggle
3035 \begin_layout Description
3036 Origin leeming, 30 Mar 2004
3039 \begin_layout Subsection*
3040 label-copy-as-reference
3043 \begin_layout Description
3044 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3047 \begin_layout Description
3048 Syntax copy-label-as-reference <LABEL>
3051 \begin_layout Description
3052 Params <LABEL>: The label to copy (for multi-line math)
3055 \begin_layout Description
3056 Origin sts, 16 Nov 2008
3059 \begin_layout Subsection*
3063 \begin_layout Description
3064 Action Goto a label.
3067 \begin_layout Description
3068 Syntax label-goto [<LABEL>]
3071 \begin_layout Description
3072 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.
3075 \begin_layout Description
3076 Origin Ale, 6 Aug 1997
3079 \begin_layout Subsection*
3083 \begin_layout Description
3084 Action Inserts label to text or displayed formula.
3087 \begin_layout Description
3088 Syntax label-insert [<LABEL>]
3091 \begin_layout Description
3092 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3095 \begin_layout Subsection*
3096 label-insert-as-reference
3099 \begin_layout Description
3100 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3103 \begin_layout Description
3104 Syntax label-insert-as-reference
3107 \begin_layout Description
3108 Origin vfr, 7 Apr 2009
3111 \begin_layout Subsection*
3115 \begin_layout Description
3116 Action Set language from the current cursor position.
3119 \begin_layout Description
3120 Syntax language <LANG> [set]
3123 \begin_layout Description
3124 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).
3127 \begin_layout Description
3128 Origin Dekel, 2 Mar 2000
3131 \begin_layout Subsection*
3135 \begin_layout Description
3136 Action Move the cursor to the beginning of the (screen) line.
3139 \begin_layout Description
3143 \begin_layout Subsection*
3147 \begin_layout Description
3148 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3151 \begin_layout Description
3152 Syntax line-begin-select
3155 \begin_layout Subsection*
3159 \begin_layout Description
3160 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3163 \begin_layout Description
3164 Syntax line-delete-forward
3167 \begin_layout Subsection*
3171 \begin_layout Description
3172 Action Move the cursor to the end of the (screen) line.
3175 \begin_layout Description
3179 \begin_layout Subsection*
3183 \begin_layout Description
3184 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3187 \begin_layout Description
3188 Syntax line-end-select
3191 \begin_layout Subsection*
3195 \begin_layout Description
3196 Action Inserts a new listings inset.
3199 \begin_layout Description
3200 Syntax listing-insert
3203 \begin_layout Description
3204 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
3207 \begin_layout Subsection*
3211 \begin_layout Description
3212 Action Inserts a marginal note.
3215 \begin_layout Description
3216 Syntax marginalnote-insert
3219 \begin_layout Description
3220 Origin Lgb, 26 Jun 2000
3223 \begin_layout Subsection*
3227 \begin_layout Description
3228 Action Disable selecting of text-region.
3231 \begin_layout Description
3235 \begin_layout Subsection*
3239 \begin_layout Description
3240 Action Enable selecting of text-region.
3243 \begin_layout Description
3244 Notion After enabling you can simply move arrow keys to get selected region.
3247 \begin_layout Description
3251 \begin_layout Subsection*
3255 \begin_layout Description
3256 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3259 \begin_layout Description
3263 \begin_layout Description
3264 Origin Andre, May 5 2006
3267 \begin_layout Subsection*
3271 \begin_layout Description
3272 Action Inserts a line break or new line.
3275 \begin_layout Description
3276 Syntax newline-insert [<ARG>]
3279 \begin_layout Description
3280 Params <ARG>: <newline|linebreak> default: newline
3283 \begin_layout Description
3284 Origin spitz, 25 Mar 2008
3287 \begin_layout Subsection*
3291 \begin_layout Description
3292 Action Inserts a new page.
3295 \begin_layout Description
3296 Syntax newpage-insert <ARG>
3299 \begin_layout Description
3300 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3303 \begin_layout Description
3304 Origin uwestoehr, 24 Nov 2007
3307 \begin_layout Subsection*
3311 \begin_layout Description
3312 Action Inserts Nomenclature entry.
3315 \begin_layout Description
3316 Notion It automatically takes the word on the cursor position if no symbol is given.
3319 \begin_layout Description
3320 Syntax nomencl-insert [<SYMBOL>]
3323 \begin_layout Description
3324 Origin Ugras, 4 Nov 2006
3327 \begin_layout Subsection*
3331 \begin_layout Description
3332 Action Inserts list of Nomenclature entries.
3335 \begin_layout Description
3336 Syntax nomenclature-print
3339 \begin_layout Description
3340 Origin Ugras, 4 Nov 2006
3343 \begin_layout Subsection*
3347 \begin_layout Description
3348 Action Inserts Note on the current cursor position, move selection inside the inset.
3351 \begin_layout Description
3352 Syntax note-insert [<TYPE>]
3355 \begin_layout Description
3356 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3359 \begin_layout Subsection*
3363 \begin_layout Description
3364 Action Moves the cursor to the beginning of next Note inset.
3367 \begin_layout Description
3371 \begin_layout Subsection*
3375 \begin_layout Description
3376 Action Move the current group in the downward direction in the structure of the document.
3379 \begin_layout Description
3380 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3383 \begin_layout Description
3387 \begin_layout Description
3388 Origin Vermeer, 23 Mar 2006
3391 \begin_layout Subsection*
3395 \begin_layout Description
3396 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3399 \begin_layout Description
3400 Notion Part -> Chapter -> Section -> etc.
3403 \begin_layout Description
3404 Syntax outline-in [local]
3407 \begin_layout Description
3408 Params local: if given, only the current paragraph will be affected.
3411 \begin_layout Description
3412 Origin Vermeer, 23 Mar 2006
3415 \begin_layout Subsection*
3419 \begin_layout Description
3420 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3423 \begin_layout Description
3424 Notion Part <- Chapter <- Section <- etc.
3427 \begin_layout Description
3428 Syntax outline-out [local]
3431 \begin_layout Description
3432 Params local: if given, only the current paragraph will be affected.
3435 \begin_layout Description
3436 Origin Vermeer, 23 Mar 2006
3439 \begin_layout Subsection*
3443 \begin_layout Description
3444 Action Move the current group in the upward direction in the structure of the document.
3447 \begin_layout Description
3448 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3451 \begin_layout Description
3455 \begin_layout Description
3456 Origin Vermeer, 23 Mar 2006
3459 \begin_layout Subsection*
3463 \begin_layout Description
3464 Action Breaks the current paragraph at the current location.
3467 \begin_layout Description
3468 Notion Removes the selection.
3471 \begin_layout Description
3472 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3475 \begin_layout Description
3476 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3477 \begin_inset Newline newline
3480 ignoresep: Do not account for paragraph separators while breaking.
3483 \begin_layout Subsection*
3487 \begin_layout Description
3488 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3491 \begin_layout Description
3492 Syntax paragraph-down
3495 \begin_layout Description
3496 Origin Asger, 1 Oct 1996
3499 \begin_layout Subsection*
3500 paragraph-down-select
3503 \begin_layout Description
3504 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3507 \begin_layout Description
3508 Syntax paragraph-down-select
3511 \begin_layout Description
3512 Origin Asger, 1 Oct 1996
3515 \begin_layout Subsection*
3519 \begin_layout Description
3520 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.
3523 \begin_layout Description
3524 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.
3527 \begin_layout Description
3528 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3531 \begin_layout Description
3532 Params <PAR_ID>: paragraph id
3533 \begin_inset Newline newline
3536 <POS_IN_PAR>: desired position within the paragraph
3539 \begin_layout Description
3540 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3543 \begin_layout Subsection*
3547 \begin_layout Description
3548 Action Moves the current paragraph downwards in the document.
3551 \begin_layout Description
3552 Syntax paragraph-move-down
3555 \begin_layout Description
3556 Origin Edwin, 8 Apr 2006
3559 \begin_layout Subsection*
3563 \begin_layout Description
3564 Action Moves the current paragraph upwards in the document.
3567 \begin_layout Description
3568 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3571 \begin_layout Description
3572 Syntax paragraph-move-up
3575 \begin_layout Description
3576 Origin Edwin, 8 Apr 2006
3579 \begin_layout Subsection*
3583 \begin_layout Description
3584 Action Change paragraph settings.
3587 \begin_layout Description
3588 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.
3591 \begin_layout Description
3592 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3595 \begin_layout Description
3605 \begin_inset Newline newline
3610 paragraph_spacing default|single|onehalf|double|other SIZE
3611 \begin_inset Newline newline
3616 align block|left|right|center|default
3617 \begin_inset Newline newline
3622 labelwidthstring WIDTH|
3627 \begin_layout Description
3628 Origin rgh, Aug 15 2007
3631 \begin_layout Subsection*
3632 paragraph-params-apply
3635 \begin_layout Description
3636 Action Change paragraph settings.
3639 \begin_layout Description
3640 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3643 \begin_layout Description
3644 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3647 \begin_layout Description
3648 Params For parameters see LFUN_PARAGRAPH_PARAMS
3651 \begin_layout Description
3652 Origin leeming, 30 Mar 2004
3655 \begin_layout Subsection*
3659 \begin_layout Description
3660 Action Move cursor to beginning of current paragraph and select to the end in downward direction
3663 \begin_layout Description
3664 Notion This function is by default bound to triple mouse click
3667 \begin_layout Description
3668 Syntax paragraph-select
3671 \begin_layout Description
3672 Origin Kornel, 16 Apr 2019
3675 \begin_layout Subsection*
3679 \begin_layout Description
3680 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3683 \begin_layout Description
3687 \begin_layout Description
3688 Origin Asger, 1 Oct 1996
3691 \begin_layout Subsection*
3695 \begin_layout Description
3696 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3699 \begin_layout Description
3700 Syntax paragraph-up-select
3703 \begin_layout Description
3704 Origin Asger, 1 Oct 1996
3707 \begin_layout Subsection*
3711 \begin_layout Description
3712 Action Pastes material (text or picture) from the active clipboard.
3715 \begin_layout Description
3716 Syntax paste [<TYPE>|<NUM>]
3719 \begin_layout Description
3720 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3721 \begin_inset Newline newline
3724 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3727 \begin_layout Subsection*
3731 \begin_layout Description
3732 Action Inserts phantom on the current cursor position, move selection inside the inset.
3735 \begin_layout Description
3736 Syntax phantom-insert [<TYPE>]
3739 \begin_layout Description
3740 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3743 \begin_layout Description
3744 Origin uwestoehr, 30 Jan 2009
3747 \begin_layout Subsection*
3751 \begin_layout Description
3752 Action Inserts a new preview inset.
3755 \begin_layout Description
3756 Syntax preview-insert
3759 \begin_layout Description
3760 Origin vfr, 28 Mar 2010
3763 \begin_layout Subsection*
3764 primary-selection-paste
3767 \begin_layout Description
3768 Action Pastes the currently selected text.
3771 \begin_layout Description
3772 Notion Primary selection mechanism is X11/Wayland-only thing.
3775 \begin_layout Description
3776 Syntax primary-selection-paste [<ARG>]
3779 \begin_layout Description
3780 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3783 \begin_layout Subsection*
3787 \begin_layout Description
3788 Action Inserts quotes according to the type and quote-language preference.
3791 \begin_layout Description
3792 Notion Currently 15 different quote styles are distinguished (see params).
3795 \begin_layout Description
3796 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3799 \begin_layout Description
3800 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
3801 \begin_inset Newline newline
3804 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
3805 \begin_inset Newline newline
3808 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3809 \begin_inset Newline newline
3812 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3813 \begin_inset Newline newline
3816 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3817 \begin_inset Newline newline
3820 'danish' for >>Danish<< quote style (with >inner quotation<)
3821 \begin_inset Newline newline
3824 'english' for ``English'' quote style (with `inner quotation')
3825 \begin_inset Newline newline
3828 'french' for <<french>> quote style (with ``inner quotation'')
3829 \begin_inset Newline newline
3832 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
3833 \begin_inset Newline newline
3836 'german' for ,,German`` quote style (with ,inner quotation`)
3837 \begin_inset Newline newline
3840 'hebrew' for ''hebrew,, quote style (with 'inner quotation,)
3841 \begin_inset Newline newline
3844 'plain' for "Plain" quote style (with 'inner quotation')
3845 \begin_inset Newline newline
3848 'polish' for ,,Polish'' quote style (with ,inner quotation')
3849 \begin_inset Newline newline
3852 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3853 \begin_inset Newline newline
3856 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
3857 \begin_inset Newline newline
3860 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3861 \begin_inset Newline newline
3864 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3865 \begin_inset Newline newline
3868 'dynamic' for Dynamic quotation marks which inherit the global document style
3869 \begin_inset Newline newline
3872 If no quote style is specified, the document-wide will be used.
3875 \begin_layout Subsection*
3879 \begin_layout Description
3880 Action Redoes the last thing undone.
3883 \begin_layout Description
3887 \begin_layout Subsection*
3891 \begin_layout Description
3892 Action Go to the next label or cross-reference.
3895 \begin_layout Description
3896 Syntax reference-next
3899 \begin_layout Description
3900 Origin Dekel, 14 Jan 2001
3903 \begin_layout Subsection*
3907 \begin_layout Description
3908 Action Repeat the given command.
3911 \begin_layout Description
3912 Notion fails when the repeat count is greater than 10000.
3915 \begin_layout Description
3916 Syntax repeat <COUNT> <LFUN-COMMAND>
3919 \begin_layout Description
3920 Origin Andre, 27 Oct 2003
3923 \begin_layout Subsection*
3927 \begin_layout Description
3928 Action Moves the cursor one page in downward direction.
3931 \begin_layout Description
3935 \begin_layout Subsection*
3939 \begin_layout Description
3940 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3943 \begin_layout Description
3944 Syntax screen-down-select
3947 \begin_layout Subsection*
3951 \begin_layout Description
3952 Action Recenters the screen on the current cursor position.
3955 \begin_layout Description
3956 Syntax screen-recenter
3959 \begin_layout Subsection*
3963 \begin_layout Description
3964 Action Repositions the screen such that the cursor is visible.
3967 \begin_layout Description
3968 Syntax screen-show-cursor
3971 \begin_layout Description
3972 Origin vfr, 25 Mar 2009
3975 \begin_layout Subsection*
3979 \begin_layout Description
3980 Action Moves the cursor one page in upward direction.
3983 \begin_layout Description
3987 \begin_layout Subsection*
3991 \begin_layout Description
3992 Action Moves the cursor one page in upward direction adding the current position to the selection.
3995 \begin_layout Description
3996 Syntax screen-up-select
3999 \begin_layout Subsection*
4003 \begin_layout Description
4004 Action Inserts a subscript or superscript inset.
4007 \begin_layout Description
4008 Syntax script-insert <TYPE>
4011 \begin_layout Description
4012 Params <TYPE>: subscript|superscript
4015 \begin_layout Description
4016 Origin Georg, 23 Nov 2010
4019 \begin_layout Subsection*
4023 \begin_layout Description
4024 Action Scroll the buffer view.
4027 \begin_layout Description
4028 Notion Only scrolls the screen up or down; does not move the cursor.
4031 \begin_layout Description
4032 Syntax scroll <TYPE> <QUANTITY>
4035 \begin_layout Description
4036 Params <TYPE>: line|page
4037 \begin_inset Newline newline
4040 <QUANTITY>: up|down|<number>
4043 \begin_layout Description
4044 Origin Abdel, Dec 27 2007
4047 \begin_layout Subsection*
4051 \begin_layout Description
4052 Action Set search string buffer.
4055 \begin_layout Description
4056 Syntax search-string-set [<DATA>]
4059 \begin_layout Description
4060 Params <DATA>: string to search for. If no parameter is given, use (word under) selection.
4063 \begin_layout Description
4064 Origin stwitt, spitz, Feb 12 2021
4067 \begin_layout Subsection*
4071 \begin_layout Description
4072 Action Select the whole section.
4075 \begin_layout Description
4076 Notion The cursor should be in a section heading before calling this lfun.
4079 \begin_layout Description
4080 Syntax section-select
4083 \begin_layout Description
4084 Origin vfr, 05 May 2009
4087 \begin_layout Subsection*
4091 \begin_layout Description
4092 Action Pastes the internal selection text in permanent selection.
4095 \begin_layout Description
4096 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
4099 \begin_layout Description
4100 Syntax selection-paste
4103 \begin_layout Description
4104 Origin lasgouttes, 14 Jan 2009
4107 \begin_layout Subsection*
4111 \begin_layout Description
4112 Action Inserts an environment separator or latex paragraph break.
4115 \begin_layout Description
4116 Syntax separator-insert [<ARG>]
4119 \begin_layout Description
4120 Params <ARG>: <plain|parbreak|latexpar> default: plain
4123 \begin_layout Description
4124 Origin ef, 2 May 2014
4127 \begin_layout Subsection*
4131 \begin_layout Description
4132 Action Inserts one of horizontal space insets.
4135 \begin_layout Description
4136 Syntax space-insert <NAME> [<LEN>]
4139 \begin_layout Description
4140 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
4141 \begin_inset Newline newline
4144 Only in math mode: med and thick.
4145 \begin_inset Newline newline
4148 <LEN>: length for custom spaces (hspace, hspace* for protected)
4151 \begin_layout Description
4152 Origin spitz, 20 May 2003, Mar 17 2008
4155 \begin_layout Subsection*
4159 \begin_layout Description
4160 Action Inserts various characters into the document.
4163 \begin_layout Description
4164 Syntax specialchar-insert <CHAR>
4167 \begin_layout Description
4168 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
4171 \begin_layout Description
4172 Origin spitz, 6 Dec 2007
4175 \begin_layout Subsection*
4179 \begin_layout Description
4180 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4183 \begin_layout Description
4184 Syntax spelling-add [<STRING>] [<LANG>]
4187 \begin_layout Description
4188 Params <WORD>: word to add
4189 \begin_inset Newline newline
4192 <LANG>: language name (see file languages)
4195 \begin_layout Description
4196 Origin spitz, 18 Jan 2010
4199 \begin_layout Subsection*
4203 \begin_layout Description
4204 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.
4207 \begin_layout Description
4208 Syntax spelling-add-local [<STRING>] [<LANG>]
4211 \begin_layout Description
4212 Params <WORD>: word to add
4213 \begin_inset Newline newline
4216 <LANG>: language name (see file languages)
4219 \begin_layout Description
4220 Origin spitz, 6 Mar 2021
4223 \begin_layout Subsection*
4224 spelling-continuously
4227 \begin_layout Description
4228 Action Toggle continuous spell checking.
4231 \begin_layout Description
4232 Syntax spelling-continuously
4235 \begin_layout Description
4236 Origin vfr, 24 March 2013
4239 \begin_layout Subsection*
4243 \begin_layout Description
4244 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.
4247 \begin_layout Description
4248 Syntax spelling-ignore [<WORD>] [<LANG>]
4251 \begin_layout Description
4252 Params <WORD>: word to ignore
4253 \begin_inset Newline newline
4256 <LANG>: language name (see file languages)
4259 \begin_layout Description
4260 Origin spitz, 18 Jan 2010
4263 \begin_layout Subsection*
4267 \begin_layout Description
4268 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4271 \begin_layout Description
4272 Syntax spelling-remove [<STRING>] [<LANG>]
4275 \begin_layout Description
4276 Params <WORD>: word to remove
4277 \begin_inset Newline newline
4280 <LANG>: language name (see file languages)
4283 \begin_layout Description
4284 Origin SWitt, 28 July 2010
4287 \begin_layout Subsection*
4288 spelling-remove-local
4291 \begin_layout Description
4292 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.
4295 \begin_layout Description
4296 Syntax spelling-remove-local [<STRING>] [<LANG>]
4299 \begin_layout Description
4300 Params <WORD>: word to remove
4301 \begin_inset Newline newline
4304 <LANG>: language name (see file languages)
4307 \begin_layout Description
4308 Origin spitz, 7 Mar 2021
4311 \begin_layout Subsection*
4315 \begin_layout Description
4316 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4319 \begin_layout Description
4320 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.
4323 \begin_layout Description
4327 \begin_layout Description
4328 Origin vfr, Sep 30 2008
4331 \begin_layout Subsection*
4335 \begin_layout Description
4336 Action Insert a tab into a listings inset.
4339 \begin_layout Description
4340 Notion It also works on a selection.
4343 \begin_layout Description
4347 \begin_layout Description
4348 Origin vfr, Sep 30 2008
4351 \begin_layout Subsection*
4355 \begin_layout Description
4356 Action Modify properties of tabulars and table-like math environments.
4359 \begin_layout Description
4360 Syntax tabular-feature <FEATURE> [<ARG>]
4363 \begin_layout Description
4364 Params Generally see LFUN_INSET_INSERT for further details.
4365 \begin_inset Newline newline
4368 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4369 \begin_inset Newline newline
4372 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4373 \begin_inset Newline newline
4376 set-line-top|set-line-bottom|set-line-left|set-line-right|
4377 \begin_inset Newline newline
4380 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4381 \begin_inset Newline newline
4384 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
4385 \begin_inset Newline newline
4388 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
4389 \begin_inset Newline newline
4392 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4393 \begin_inset Newline newline
4396 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4397 \begin_inset Newline newline
4400 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4401 \begin_inset Newline newline
4404 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4405 \begin_inset Newline newline
4408 reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|
4409 \begin_inset Newline newline
4412 toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
4413 \begin_inset Newline newline
4416 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4417 \begin_inset Newline newline
4420 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4421 \begin_inset Newline newline
4424 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4425 \begin_inset Newline newline
4428 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4429 \begin_inset Newline newline
4432 set-special-column|set-special-multicolumn|set-special-multirow|
4433 \begin_inset Newline newline
4436 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4437 \begin_inset Newline newline
4440 set-interline-space|tabular-valign-top|tabular-valign-middle|
4441 \begin_inset Newline newline
4444 tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|
4445 \begin_inset Newline newline
4448 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
4449 \begin_inset Newline newline
4452 the Grid/Array environment.
4453 \begin_inset Newline newline
4456 <ARG>: additional argument for some commands, use debug mode to explore its values.
4459 \begin_layout Description
4460 Origin gm, 10 Dec 2015
4463 \begin_layout Subsection*
4467 \begin_layout Description
4468 Action Inserts table into the document.
4471 \begin_layout Description
4472 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4475 \begin_layout Description
4476 Syntax tabular-insert [<ROWS> <COLUMNS>]
4479 \begin_layout Description
4480 Params In case no arguments are given show insert dialog.
4483 \begin_layout Description
4484 Origin Jug, 12 Apr 2000
4487 \begin_layout Subsection*
4488 tabular-style-insert
4491 \begin_layout Description
4492 Action Inserts table of a given style into the document.
4495 \begin_layout Description
4496 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4499 \begin_layout Description
4500 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
4503 \begin_layout Description
4504 Params Valid styles are the names of the files in lib/tabletemplates, minus _1x<n> and .lyx suffix.
4507 \begin_layout Description
4508 Origin spitz, 25 Mar 2019
4511 \begin_layout Subsection*
4515 \begin_layout Description
4516 Action Look up thesaurus entries with respect to the word under the cursor.
4519 \begin_layout Description
4520 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4523 \begin_layout Description
4524 Params <STRING>: word to look up
4525 \begin_inset Newline newline
4528 <LANG>: language (see file languages)
4531 \begin_layout Description
4532 Origin Levon, 20 Jul 2001
4535 \begin_layout Subsection*
4539 \begin_layout Description
4540 Action Undoes the last edit.
4543 \begin_layout Description
4547 \begin_layout Subsection*
4551 \begin_layout Description
4552 Action Inserts a single unicode character.
4555 \begin_layout Description
4556 Syntax unicode-insert <CHAR1> <CHAR2> ...
4559 \begin_layout Description
4560 Params <CHARn>: The character to insert, given as its code point, in hexadecimal.
4563 \begin_layout Description
4564 Sample unicode-insert 0x0100 0x0259
4567 \begin_layout Description
4568 Origin Lgb, 22 Oct 2006
4571 \begin_layout Subsection*
4575 \begin_layout Description
4576 Action Moves the cursor one line in upward direction.
4579 \begin_layout Description
4583 \begin_layout Subsection*
4587 \begin_layout Description
4588 Action Moves the cursor one line in upward direction adding the current position to the selection.
4591 \begin_layout Description
4595 \begin_layout Subsection*
4599 \begin_layout Description
4600 Action Moves the cursor to the logically previous beginning of a word.
4603 \begin_layout Description
4604 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.
4607 \begin_layout Description
4608 Syntax word-backward
4611 \begin_layout Subsection*
4612 word-backward-select
4615 \begin_layout Description
4616 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4619 \begin_layout Description
4620 Notion See also LFUN_WORD_BACKWARD.
4623 \begin_layout Description
4624 Syntax word-backward-select
4627 \begin_layout Subsection*
4631 \begin_layout Description
4632 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4635 \begin_layout Description
4636 Syntax word-capitalize [<SEL_TYPE>]
4639 \begin_layout Description
4640 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.
4643 \begin_layout Subsection*
4644 word-delete-backward
4647 \begin_layout Description
4648 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4651 \begin_layout Description
4652 Syntax word-delete-backward [confirm]
4655 \begin_layout Description
4656 Params confirm: Select big insets, do not directly delete them.
4659 \begin_layout Subsection*
4663 \begin_layout Description
4664 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4667 \begin_layout Description
4668 Syntax word-delete-forward [confirm]
4671 \begin_layout Description
4672 Params confirm: Select big insets, do not directly delete them.
4675 \begin_layout Subsection*
4679 \begin_layout Description
4680 Action Search for next occurrence of a string.
4683 \begin_layout Description
4684 Syntax word-find [<DATA>]
4687 \begin_layout Description
4688 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).
4691 \begin_layout Description
4692 Origin Andre, Jan 7 2004
4695 \begin_layout Subsection*
4699 \begin_layout Description
4700 Action Search for a given string in backward direction.
4703 \begin_layout Description
4704 Notion Case sensitive, match words. If no argument given, last search repeated.
4707 \begin_layout Description
4708 Syntax word-find-backward [<STRING>]
4711 \begin_layout Description
4712 Origin Etienne, 20 Feb 1998
4715 \begin_layout Subsection*
4719 \begin_layout Description
4720 Action Search for a given string in forward direction.
4723 \begin_layout Description
4724 Notion Case sensitive, match words. If no argument given, last search repeated.
4727 \begin_layout Description
4728 Syntax word-find-forward [<STRING>]
4731 \begin_layout Description
4732 Origin Etienne, 16 Feb 1998
4735 \begin_layout Subsection*
4739 \begin_layout Description
4740 Action Search for next occurrence of a pattern.
4743 \begin_layout Description
4744 Syntax word-findadv [<DATA>]
4747 \begin_layout Description
4748 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).
4751 \begin_layout Description
4752 Origin Tommaso, Nov 15 2007
4755 \begin_layout Subsection*
4759 \begin_layout Description
4760 Action Moves the cursor to the logically next beginning of a word.
4763 \begin_layout Description
4764 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.
4767 \begin_layout Description
4771 \begin_layout Subsection*
4775 \begin_layout Description
4776 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4779 \begin_layout Description
4780 Notion See also LFUN_WORD_FORWARD.
4783 \begin_layout Description
4784 Syntax word-forward-select
4787 \begin_layout Subsection*
4791 \begin_layout Description
4792 Action Moves the cursor to the next beginning of a word "on the left".
4795 \begin_layout Description
4796 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.
4799 \begin_layout Description
4803 \begin_layout Description
4804 Origin dov, 28 Oct 2007
4807 \begin_layout Subsection*
4811 \begin_layout Description
4812 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4815 \begin_layout Description
4816 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4819 \begin_layout Description
4820 Syntax word-left-select
4823 \begin_layout Description
4824 Origin dov, 28 Oct 2007
4827 \begin_layout Subsection*
4831 \begin_layout Description
4832 Action Change the words in the selection or word at cursor position to lower case.
4835 \begin_layout Description
4836 Syntax word-lowcase [<SEL_TYPE>]
4839 \begin_layout Description
4840 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.
4843 \begin_layout Subsection*
4847 \begin_layout Description
4848 Action Replace a string in the document.
4851 \begin_layout Description
4852 Syntax word-replace [<DATA>]
4855 \begin_layout Description
4856 Params <DATA>: data is of the form "<replacestring>
4857 \begin_inset Newline newline
4861 \begin_inset Newline newline
4864 <casesensitive> <matchword> <all> <forward> <findnext>"
4867 \begin_layout Description
4868 Origin Andre, Jan 7 2004
4871 \begin_layout Subsection*
4875 \begin_layout Description
4876 Action Moves the cursor to the next beginning of a word "on the right".
4879 \begin_layout Description
4880 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.
4883 \begin_layout Description
4887 \begin_layout Description
4888 Origin dov, 28 Oct 2007
4891 \begin_layout Subsection*
4895 \begin_layout Description
4896 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4899 \begin_layout Description
4900 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4903 \begin_layout Description
4904 Syntax word-right-select
4907 \begin_layout Description
4908 Origin dov, 28 Oct 2007
4911 \begin_layout Subsection*
4915 \begin_layout Description
4916 Action Puts the word where the cursor stands into the selection.
4919 \begin_layout Description
4923 \begin_layout Description
4924 Origin Andre, 11 Sep 2002
4927 \begin_layout Subsection*
4931 \begin_layout Description
4932 Action Change the words in the selection or word at cursor position to upper case.
4935 \begin_layout Description
4936 Syntax word-upcase [<SEL_TYPE>]
4939 \begin_layout Description
4940 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.
4943 \begin_layout Subsection*
4947 \begin_layout Description
4948 Action Inserts floats wrapped by the text around.
4951 \begin_layout Description
4952 Syntax wrap-insert <TYPE>
4955 \begin_layout Description
4956 Params <TYPE>: table|figure
4959 \begin_layout Description
4960 Origin Dekel, 7 Apr 2002
4963 \begin_layout Section
4964 Math Editor Functions
4967 \begin_layout Subsection*
4968 in-mathmacrotemplate
4971 \begin_layout Description
4972 Action Only active in Math Macro definition.
4975 \begin_layout Description
4976 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.
4979 \begin_layout Description
4980 Syntax in-mathmacrotemplate
4983 \begin_layout Description
4984 Origin sts, 06 January 2008
4987 \begin_layout Subsection*
4991 \begin_layout Description
4992 Action Inserts an extended matrix as provided by the amsmath package.
4995 \begin_layout Description
4996 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4999 \begin_layout Description
5000 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'.
5003 \begin_layout Description
5004 Sample math-ams-matrix 3 3 bmatrix
5007 \begin_layout Subsection*
5011 \begin_layout Description
5012 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
5015 \begin_layout Description
5016 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
5019 \begin_layout Description
5020 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
5021 \begin_inset Newline newline
5024 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
5027 \begin_layout Description
5028 Sample math-bigdelim "Bigl" "
5035 \begin_layout Description
5036 Origin Enrico & Georg, 7 May 2006
5039 \begin_layout Subsection*
5043 \begin_layout Description
5044 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
5047 \begin_layout Description
5048 Syntax math-delim [<LEFT>] [<RIGHT>]
5051 \begin_layout Description
5052 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.
5055 \begin_layout Description
5056 Sample math-delim { rangle
5059 \begin_layout Description
5060 Origin Alejandro, 18 Jun 1996
5063 \begin_layout Subsection*
5067 \begin_layout Description
5068 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
5071 \begin_layout Description
5072 Syntax math-display [<ARG>]
5075 \begin_layout Description
5076 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
5079 \begin_layout Description
5080 Origin Alejandro, 18 Jun 1996
5083 \begin_layout Subsection*
5087 \begin_layout Description
5088 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
5091 \begin_layout Description
5092 Notion Selection can be used to determine the input for the external program.
5095 \begin_layout Description
5096 Syntax math-extern <LANG> [<COMMAND>]
5099 \begin_layout Description
5100 Params <LANG>: octave|maxima|maple|mathematica|script
5101 \begin_inset Newline newline
5104 where "script" stands for the external script (normalized expression will be passed)
5107 \begin_layout Description
5108 Sample math-extern maple simplify
5111 \begin_layout Description
5112 Origin Andre, 24 Apr 2001
5115 \begin_layout Subsection*
5119 \begin_layout Description
5120 Action Changes the text style used in math.
5123 \begin_layout Description
5124 Syntax math-font-style <STYLE>
5127 \begin_layout Description
5128 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
5129 \begin_inset Newline newline
5132 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
5135 \begin_layout Description
5136 Origin vfr, 9 jan 2009
5139 \begin_layout Subsection*
5143 \begin_layout Description
5144 Action Inserts math objects and symbols.
5147 \begin_layout Description
5148 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
5150 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
5152 frac{x}{y}" replaces "abc" with "
5154 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.
5157 \begin_layout Description
5158 Syntax math-insert <ARG>
5161 \begin_layout Description
5162 Params <ARG>: Symbol or LaTeX code to be inserted.
5165 \begin_layout Subsection*
5169 \begin_layout Description
5170 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.
5173 \begin_layout Description
5174 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
5177 \begin_layout Description
5178 Syntax math-limits [<STATE>]
5181 \begin_layout Description
5182 Params <STATE>: limits|nolimits
5185 \begin_layout Subsection*
5189 \begin_layout Description
5190 Action Inserts a math macro definition at the cursor position in the text.
5193 \begin_layout Description
5194 Syntax math-macro <NAME> [<NARGS>] [def]
5197 \begin_layout Description
5198 Params <NAME>: The name of the macro, e.g. "mymacro".
5199 \begin_inset Newline newline
5202 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
5205 \begin_layout Description
5206 Origin ale, 10 May 1997; sts, 21 Dec 2007
5209 \begin_layout Subsection*
5210 math-macro-add-greedy-optional-param
5213 \begin_layout Description
5214 Action Add a greedy optional parameter.
5217 \begin_layout Description
5218 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
5221 \begin_layout Description
5222 Syntax math-macro-add-greedy-optional-param
5225 \begin_layout Description
5226 Origin sts, 06 January 2008
5229 \begin_layout Subsection*
5230 math-macro-add-optional-param
5233 \begin_layout Description
5234 Action Add an optional parameter.
5237 \begin_layout Description
5238 Notion Insert an optional parameter just behind the already existing optional parameters.
5241 \begin_layout Description
5242 Syntax math-macro-add-optional-param
5245 \begin_layout Description
5246 Origin sts, 06 January 2008
5249 \begin_layout Subsection*
5250 math-macro-add-param
5253 \begin_layout Description
5254 Action Add a parameter.
5257 \begin_layout Description
5258 Notion Add a parameter to a Math Macro.
5261 \begin_layout Description
5262 Syntax math-macro-add-param <NUM>
5265 \begin_layout Description
5266 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.
5269 \begin_layout Description
5270 Origin sts, 06 January 2008
5273 \begin_layout Subsection*
5274 math-macro-append-greedy-param
5277 \begin_layout Description
5278 Action Append a greedy parameter.
5281 \begin_layout Description
5282 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
5285 \begin_layout Description
5286 Syntax math-macro-append-greedy-param
5289 \begin_layout Description
5290 Origin sts, 06 January 2008
5293 \begin_layout Subsection*
5297 \begin_layout Description
5298 Action Fold a Math Macro.
5301 \begin_layout Description
5302 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
5307 \begin_layout Description
5308 Syntax math-macro-fold
5311 \begin_layout Description
5312 Origin sts, 06 January 2008
5315 \begin_layout Subsection*
5316 math-macro-make-nonoptional
5319 \begin_layout Description
5320 Action Make a parameter non-optional.
5323 \begin_layout Description
5324 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.
5327 \begin_layout Description
5328 Syntax math-macro-make-nonoptional
5331 \begin_layout Description
5332 Origin sts, 06 January 2008
5335 \begin_layout Subsection*
5336 math-macro-make-optional
5339 \begin_layout Description
5340 Action Make a parameter optional.
5343 \begin_layout Description
5344 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
5347 \begin_layout Description
5348 Syntax math-macro-make-optional
5351 \begin_layout Description
5352 Origin sts, 06 January 2008
5355 \begin_layout Subsection*
5356 math-macro-remove-greedy-param
5359 \begin_layout Description
5360 Action Remove a greedy parameter.
5363 \begin_layout Description
5364 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.
5367 \begin_layout Description
5368 Syntax math-macro-remove-greedy-param
5371 \begin_layout Description
5372 Origin sts, 06 January 2008
5375 \begin_layout Subsection*
5376 math-macro-remove-optional-param
5379 \begin_layout Description
5380 Action Remove the last optional parameter.
5383 \begin_layout Description
5384 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
5387 \begin_layout Description
5388 Syntax math-macro-remove-optional-param
5391 \begin_layout Description
5392 Origin sts, 06 January 2008
5395 \begin_layout Subsection*
5396 math-macro-remove-param
5399 \begin_layout Description
5400 Action Remove the last parameter.
5403 \begin_layout Description
5404 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
5407 \begin_layout Description
5408 Syntax math-macro-remove-param <NUM>
5411 \begin_layout Description
5412 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
5415 \begin_layout Description
5416 Origin sts, 06 January 2008
5419 \begin_layout Subsection*
5423 \begin_layout Description
5424 Action Unfold a Math Macro.
5427 \begin_layout Description
5428 Notion Unfold the Math Macro the cursor is in, i.e. display it as
5433 \begin_layout Description
5434 Syntax math-macro-unfold
5437 \begin_layout Description
5438 Origin sts, 06 January 2008
5441 \begin_layout Subsection*
5445 \begin_layout Description
5446 Action Inserts a matrix.
5449 \begin_layout Description
5450 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5453 \begin_layout Description
5454 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).
5457 \begin_layout Description
5458 Sample math-matrix 3 3 bccc
5461 \begin_layout Subsection*
5465 \begin_layout Description
5466 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.
5469 \begin_layout Description
5470 Notion If there is some selected text, it puts the text inside created math box.
5473 \begin_layout Description
5474 Syntax math-mode [on|<ARG>]
5477 \begin_layout Description
5478 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
5479 \begin_inset Newline newline
5482 "on": allow only entering of math mode from text mode.
5485 \begin_layout Description
5486 Origin Alejandro, 4 Jun 1996
5489 \begin_layout Subsection*
5493 \begin_layout Description
5494 Action Mutates the type of math inset to the newly selected one.
5497 \begin_layout Description
5498 Syntax math-mutate <TYPE>
5501 \begin_layout Description
5502 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
5505 \begin_layout Description
5506 Origin Andre, 23 May 2001
5509 \begin_layout Subsection*
5510 math-number-line-toggle
5513 \begin_layout Description
5514 Action Toggles numbering of the current formula line.
5517 \begin_layout Description
5518 Notion Must be in display formula mode.
5521 \begin_layout Description
5522 Syntax math-number-line-toggle
5525 \begin_layout Description
5526 Origin Alejandro, 18 Jun 1996
5529 \begin_layout Subsection*
5533 \begin_layout Description
5534 Action Toggles numbering/labeling of the current formula.
5537 \begin_layout Description
5538 Notion Must be in display formula mode.
5541 \begin_layout Description
5542 Syntax math-number-toggle
5545 \begin_layout Description
5546 Origin Alejandro, 4 Jun 1996
5549 \begin_layout Subsection*
5553 \begin_layout Description
5554 Action Changes arbitrarily the size used by math fonts inside a context.
5557 \begin_layout Description
5558 Notion Provides an interface to the LaTeX math mode font size commands.
5561 \begin_layout Description
5562 Syntax math-size <STYLE>
5565 \begin_layout Description
5577 \begin_layout Description
5578 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5581 \begin_layout Subsection*
5585 \begin_layout Description
5586 Action Inserts space into math expression.
5589 \begin_layout Description
5590 Notion Use spacebar after entering this space to change type of space.
5593 \begin_layout Description
5594 Syntax math-space [<TYPE>] [<LEN>]
5597 \begin_layout Description
5598 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5599 \begin_inset Newline newline
5602 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5603 \begin_inset Newline newline
5606 custom space: hspace
5607 \begin_inset Newline newline
5610 "," used by default.
5611 \begin_inset Newline newline
5614 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5615 \begin_inset Newline newline
5618 <LEN>: length for custom spaces (hspace)
5621 \begin_layout Description
5622 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5625 \begin_layout Subsection*
5629 \begin_layout Description
5630 Action Enters subscript expression in math expression.
5633 \begin_layout Description
5634 Syntax math-subscript
5637 \begin_layout Description
5638 Origin vermeer, 12 Dec 2001
5641 \begin_layout Subsection*
5645 \begin_layout Description
5646 Action Enters superscript expression in math expression.
5649 \begin_layout Description
5650 Syntax math-superscript
5653 \begin_layout Description
5654 Origin vermeer, 12 Dec 2001
5657 \begin_layout Subsection*
5661 \begin_layout Description
5662 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5665 \begin_layout Description
5666 Notion If there is any selected text, then it is moved inside the created regexp inset.
5669 \begin_layout Description
5670 Syntax regexp-mode [<ARG>]
5673 \begin_layout Description
5674 Params <ARG>: eventual argument (regular expression).
5677 \begin_layout Description
5678 Origin Tommaso, 4 Oct 2008
5681 \begin_layout Section
5682 Buffer Fuctions (File and Window related)
5685 \begin_layout Subsection*
5689 \begin_layout Description
5690 Action Activate the branch.
5693 \begin_layout Description
5694 Syntax branch-activate <BRANCH>
5697 \begin_layout Description
5698 Params <BRANCH>: The branch to activate
5701 \begin_layout Description
5702 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5703 \begin_inset Newline newline
5706 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5709 \begin_layout Description
5710 Origin rgh, 27 May 2008
5713 \begin_layout Subsection*
5717 \begin_layout Description
5718 Action Add a branch to the buffer's BranchList.
5721 \begin_layout Description
5722 Syntax branch-add <BRANCH>
5725 \begin_layout Description
5726 Params <BRANCH>: Name of the branch to add
5729 \begin_layout Description
5730 Origin spitz, 7 Jul 2009
5733 \begin_layout Subsection*
5737 \begin_layout Description
5738 Action Create new branch and directly put the branch inset into the document.
5741 \begin_layout Description
5742 Syntax branch-add-insert [<NAME>]
5745 \begin_layout Description
5746 Params <NAME>: Branch name. If it is not specified, you will be asked.
5749 \begin_layout Description
5750 Origin sanda, 10 Jul 2009
5753 \begin_layout Subsection*
5757 \begin_layout Description
5758 Action De-activate the branch.
5761 \begin_layout Description
5762 Syntax branch-deactivate <BRANCH>
5765 \begin_layout Description
5766 Params <BRANCH>: The branch to deactivate
5769 \begin_layout Description
5770 Origin rgh, 27 May 2008
5773 \begin_layout Subsection*
5777 \begin_layout Description
5778 Action Toggles inversion status of branch inset.
5781 \begin_layout Description
5782 Syntax branch-invert
5785 \begin_layout Description
5786 Origin rgheck, 12 July 2016
5789 \begin_layout Subsection*
5790 branch-master-activate
5793 \begin_layout Description
5794 Action Activate the branch in the master buffer.
5797 \begin_layout Description
5798 Syntax branch-master-activate <BRANCH>
5801 \begin_layout Description
5802 Params <BRANCH>: The branch to activate
5805 \begin_layout Description
5806 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5807 \begin_inset Newline newline
5810 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5813 \begin_layout Description
5814 Origin spitz, 30 Sep 2012
5817 \begin_layout Subsection*
5818 branch-master-deactivate
5821 \begin_layout Description
5822 Action De-activate the branch in the master buffer.
5825 \begin_layout Description
5826 Syntax branch-master-deactivate <BRANCH>
5829 \begin_layout Description
5830 Params <BRANCH>: The branch to deactivate
5833 \begin_layout Description
5834 Origin spitz, 30 Sep 2012
5837 \begin_layout Subsection*
5841 \begin_layout Description
5842 Action Open/close all insets of selected branch (depending on its activation status).
5845 \begin_layout Description
5846 Syntax branch-sync-all
5849 \begin_layout Description
5850 Origin sanda, 15 April 2022
5853 \begin_layout Subsection*
5857 \begin_layout Description
5858 Action Rename all branches of a given name in a document.
5861 \begin_layout Description
5862 Syntax branches-rename <OLDNAME> <NEWNAME>
5865 \begin_layout Description
5866 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5869 \begin_layout Description
5870 Origin spitz, 9 Jul 2009
5873 \begin_layout Subsection*
5877 \begin_layout Description
5878 Action Saves the current buffer to a temporary file.
5881 \begin_layout Description
5882 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5885 \begin_layout Description
5886 Syntax buffer-auto-save
5889 \begin_layout Subsection*
5893 \begin_layout Description
5894 Action Loads the given child document.
5897 \begin_layout Description
5898 Notion The current document is treated as a parent.
5901 \begin_layout Description
5902 Syntax buffer-child-open <FILE>
5905 \begin_layout Description
5906 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5909 \begin_layout Description
5910 Origin Ale, 28 May 1997
5913 \begin_layout Subsection*
5917 \begin_layout Description
5918 Action Runs chktex for the current document.
5921 \begin_layout Description
5922 Syntax buffer-chktex
5925 \begin_layout Description
5926 Origin Asger, 30 Oct 1997
5929 \begin_layout Subsection*
5933 \begin_layout Description
5934 Action Closes the current buffer.
5937 \begin_layout Description
5938 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5941 \begin_layout Description
5945 \begin_layout Subsection*
5949 \begin_layout Description
5950 Action Closes all buffers.
5953 \begin_layout Description
5954 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5957 \begin_layout Description
5958 Syntax buffer-close-all
5961 \begin_layout Subsection*
5965 \begin_layout Description
5966 Action Exports the current buffer (document) to the given format.
5969 \begin_layout Description
5970 Syntax buffer-export [<FORMAT>] [<DEST>]
5973 \begin_layout Description
5974 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.
5975 \begin_inset Newline newline
5978 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.
5979 \begin_inset Newline newline
5982 If absent or "default", then the default output format of the document is used.
5983 \begin_inset Newline newline
5986 <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.
5989 \begin_layout Description
5990 Origin Lgb, 29 Jul 1997
5993 \begin_layout Subsection*
5997 \begin_layout Description
5998 Action Opens a dialog for exporting the current buffer.
6001 \begin_layout Description
6002 Syntax buffer-export-as [<FORMAT>]
6005 \begin_layout Description
6006 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.
6009 \begin_layout Description
6010 Sample buffer-export-as pdf2
6013 \begin_layout Description
6014 Origin tommaso, 6 Oct 2011
6017 \begin_layout Subsection*
6018 buffer-export-custom
6021 \begin_layout Description
6022 Action Exports the current buffer (document) from the given format using the given command on it.
6025 \begin_layout Description
6026 Syntax buffer-export-custom <FORMAT> <COMMAND>
6029 \begin_layout Description
6030 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
6031 \begin_inset Newline newline
6034 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
6037 \begin_layout Description
6038 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6041 \begin_layout Description
6042 Origin leeming, 27 Mar 2004
6045 \begin_layout Subsection*
6046 buffer-external-modification-clear
6049 \begin_layout Description
6050 Action Clear the external modification flag on the current buffer.
6053 \begin_layout Description
6054 Syntax buffer-external-modification-clear
6057 \begin_layout Description
6058 Origin gm, 2 March 2017
6061 \begin_layout Subsection*
6065 \begin_layout Description
6066 Action Applies a command to all non-hidden buffers.
6069 \begin_layout Description
6070 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
6073 \begin_layout Description
6074 Syntax buffer-forall <LFUN-COMMAND>
6077 \begin_layout Description
6078 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6081 \begin_layout Description
6082 Sample Close all Notes in all buffers:
6083 \begin_inset Newline newline
6086 buffer-forall inset-forall Note inset-toggle close
6087 \begin_inset Newline newline
6090 Toggle change tracking on buffers:
6091 \begin_inset Newline newline
6094 buffer-forall changes-track
6095 \begin_inset Newline newline
6098 Toggle read-only for buffers:
6099 \begin_inset Newline newline
6102 buffer-forall buffer-toggle-read-only
6103 \begin_inset Newline newline
6106 Show statistics for individual buffers:
6107 \begin_inset Newline newline
6110 buffer-forall statistics
6111 \begin_inset Newline newline
6114 Activate the branch named "Solutions" in buffers:
6115 \begin_inset Newline newline
6118 buffer-forall branch-activate Solutions
6119 \begin_inset Newline newline
6122 Export buffers to PDF (pdflatex):
6123 \begin_inset Newline newline
6126 buffer-forall buffer-export pdf2
6127 \begin_inset Newline newline
6133 \begin_layout Description
6134 Origin skostysh, 20 Jul 2012
6137 \begin_layout Subsection*
6141 \begin_layout Description
6142 Action Import a given file as a lyx document.
6145 \begin_layout Description
6146 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.
6149 \begin_layout Description
6150 Syntax buffer-import <FORMAT> [<FILE>]
6153 \begin_layout Description
6154 Origin Asger, 24 Jul 1998
6157 \begin_layout Subsection*
6161 \begin_layout Description
6162 Action Set language of the current document.
6165 \begin_layout Description
6166 Syntax buffer-language <LANG>
6169 \begin_layout Description
6170 Params <LANG>: language name. See lib/languages for list.
6173 \begin_layout Description
6174 Origin leeming, 30 Mar 2004
6177 \begin_layout Subsection*
6181 \begin_layout Description
6182 Action Moves the current tab one spot to the right.
6185 \begin_layout Description
6186 Syntax buffer-move-next
6189 \begin_layout Description
6190 Origin skostysh, 7 Apr 2015
6193 \begin_layout Subsection*
6194 buffer-move-previous
6197 \begin_layout Description
6198 Action Moves the current tab one spot to the left.
6201 \begin_layout Description
6202 Syntax buffer-move-previous
6205 \begin_layout Description
6206 Origin skostysh, 7 Apr 2015
6209 \begin_layout Subsection*
6213 \begin_layout Description
6214 Action Creates a new buffer (that is, document) and switches to it.
6217 \begin_layout Description
6218 Notion Implicit path can be set in Preferences dialog.
6221 \begin_layout Description
6222 Syntax buffer-new [<FILE>]
6225 \begin_layout Description
6226 Params <FILE>: filename of created file with absolute path.
6229 \begin_layout Subsection*
6233 \begin_layout Description
6234 Action Creates a new buffer (that is, document) from a template.
6237 \begin_layout Description
6238 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
6241 \begin_layout Description
6242 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
6245 \begin_layout Description
6246 Params <FILE>: filename of created file with absolute path. If empty or "newfile", a file with appropriate name is generated.
6247 \begin_inset Newline newline
6250 <TEMPLATE FILE>: filename of template with absolute path. If empty, a dialog is opened to select the new file.
6253 \begin_layout Subsection*
6257 \begin_layout Description
6258 Action Switch to the next opened document.
6261 \begin_layout Description
6262 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
6265 \begin_layout Description
6269 \begin_layout Subsection*
6273 \begin_layout Description
6274 Action Apply the given settings to the current document.
6277 \begin_layout Description
6278 Syntax buffer-params-apply [<ARGS>]
6281 \begin_layout Description
6282 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6285 \begin_layout Description
6286 Origin leeming, 30 Mar 2004
6289 \begin_layout Subsection*
6293 \begin_layout Description
6294 Action Switch to the previous opened document.
6297 \begin_layout Description
6298 Syntax buffer-previous
6301 \begin_layout Subsection*
6305 \begin_layout Description
6306 Action Reverts opened document.
6309 \begin_layout Description
6310 Syntax buffer-reload [dump]
6313 \begin_layout Description
6314 Params dump: do not ask for any confirmation, just reload. All changes will be lost.
6317 \begin_layout Description
6318 Origin Asger, 2 Feb 1997
6321 \begin_layout Subsection*
6325 \begin_layout Description
6326 Action Removes the auxiliary file before next export to assure export is done afresh.
6329 \begin_layout Description
6330 Syntax buffer-reset-export
6333 \begin_layout Description
6334 Origin spitz, 27 Dec 2019
6337 \begin_layout Subsection*
6338 buffer-save-as-default
6341 \begin_layout Description
6342 Action Save the current document settings as default.
6345 \begin_layout Description
6346 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6349 \begin_layout Description
6350 Syntax buffer-save-as-default [<ARGS>]
6353 \begin_layout Description
6354 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6357 \begin_layout Description
6358 Origin leeming, 30 Mar 2004
6361 \begin_layout Subsection*
6365 \begin_layout Description
6366 Action Display and switch to the given buffer.
6369 \begin_layout Description
6370 Syntax buffer-switch <BUFFER>
6373 \begin_layout Description
6374 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
6377 \begin_layout Subsection*
6378 buffer-toggle-compression
6381 \begin_layout Description
6382 Action Toggles compression of the current document on/off.
6385 \begin_layout Description
6386 Syntax buffer-toggle-compression
6389 \begin_layout Description
6390 Origin bpeng, 27 Apr 2006
6393 \begin_layout Subsection*
6394 buffer-toggle-read-only
6397 \begin_layout Description
6398 Action Toggle editing mode of the current document between read/write and read-only.
6401 \begin_layout Description
6402 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.
6405 \begin_layout Description
6406 Syntax buffer-toggle-read-only
6409 \begin_layout Description
6410 Origin Lgb, 27 May 1997
6413 \begin_layout Subsection*
6417 \begin_layout Description
6418 Action Exports the current document and put the result into the temporary directory.
6421 \begin_layout Description
6422 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).
6425 \begin_layout Description
6426 Syntax buffer-update [<FORMAT>]
6429 \begin_layout Description
6430 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.
6433 \begin_layout Description
6434 Origin Dekel, 5 Aug 2000
6437 \begin_layout Subsection*
6441 \begin_layout Description
6442 Action Displays current buffer in chosen format.
6445 \begin_layout Description
6446 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.
6449 \begin_layout Description
6450 Syntax buffer-view [<FORMAT>]
6453 \begin_layout Description
6454 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.
6457 \begin_layout Subsection*
6461 \begin_layout Description
6462 Action Opens the file that was created from last preview of this buffer.
6465 \begin_layout Description
6466 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.
6469 \begin_layout Description
6470 Syntax buffer-view-cache
6473 \begin_layout Subsection*
6477 \begin_layout Description
6478 Action Saves the current buffer.
6481 \begin_layout Description
6482 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.
6485 \begin_layout Description
6486 Syntax buffer-write [force]
6489 \begin_layout Description
6490 Params force: write even if buffer is not marked as modified.
6493 \begin_layout Subsection*
6497 \begin_layout Description
6498 Action Save all changed documents.
6501 \begin_layout Description
6502 Syntax buffer-write-all
6505 \begin_layout Description
6506 Origin rgh, gpothier 6 Aug 2007
6509 \begin_layout Subsection*
6513 \begin_layout Description
6514 Action Rename and save current buffer.
6517 \begin_layout Description
6518 Syntax buffer-write-as <FILENAME>
6521 \begin_layout Description
6522 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6525 \begin_layout Subsection*
6526 buffer-write-as-template
6529 \begin_layout Description
6530 Action Rename and save current buffer in the local templates directory.
6533 \begin_layout Description
6534 Syntax buffer-write-as-template <FILENAME>
6537 \begin_layout Description
6538 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6541 \begin_layout Subsection*
6545 \begin_layout Description
6546 Action Sets the zoom of the screen fonts.
6549 \begin_layout Description
6550 Syntax buffer-zoom [<ZOOM>]
6553 \begin_layout Description
6554 Params <ZOOM>: The target zoom value in %; the default is the default zoom as saved in preferences.
6557 \begin_layout Description
6558 Origin daniel, 28 Oct 2016
6561 \begin_layout Subsection*
6565 \begin_layout Description
6566 Action Increases the zoom of the screen fonts.
6569 \begin_layout Description
6570 Syntax buffer-zoom-in [<ZOOM>]
6573 \begin_layout Description
6574 Params <ZOOM>: The zoom value addition in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6577 \begin_layout Description
6578 Origin vfr, 30 Mar 2009
6581 \begin_layout Subsection*
6585 \begin_layout Description
6586 Action Decreases the zoom of the screen fonts.
6589 \begin_layout Description
6590 Syntax buffer-zoom-out [<ZOOM>]
6593 \begin_layout Description
6594 Params <ZOOM>: The zoom value abstraction in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6597 \begin_layout Description
6598 Origin vfr, 30 Mar 2009
6601 \begin_layout Subsection*
6605 \begin_layout Description
6606 Action Generates the code (literate programming).
6609 \begin_layout Description
6610 Notion Latex file with extension
6612 literate_extension is generated. Then LyX invokes
6614 build_command (with a default of ``make'') to generate the code and
6616 build_error_filter to process the compilation error messages.
6617 \begin_inset Newline newline
6620 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:
6621 \begin_inset Newline newline
6626 build_command "my_script my_arguments"
6627 \begin_inset Newline newline
6632 build_error_filter differs from the
6634 literate_error_filter only in that the former will identify error messages from your compiler.
6637 \begin_layout Description
6638 Syntax build-program
6641 \begin_layout Subsection*
6645 \begin_layout Description
6646 Action Open LyX document.
6649 \begin_layout Description
6650 Syntax file-open [<FILE>]
6653 \begin_layout Description
6654 Params <FILE>: Filename to be opened.
6657 \begin_layout Subsection*
6661 \begin_layout Description
6662 Action Open the given help file according to the language setting.
6665 \begin_layout Description
6666 Syntax help-open <FILE>[.lyx]
6669 \begin_layout Description
6670 Params <FILE>: any document from (/usr/share/)doc directory.
6673 \begin_layout Description
6674 Origin Jug, 27 Jun 1999
6677 \begin_layout Subsection*
6681 \begin_layout Description
6682 Action Sets icon size of toolbars.
6685 \begin_layout Description
6686 Syntax icon-size [<SIZE>]
6689 \begin_layout Description
6690 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).
6693 \begin_layout Description
6697 \begin_layout Subsection*
6701 \begin_layout Description
6702 Action Helper function for master-related actions
6705 \begin_layout Description
6706 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
6709 \begin_layout Description
6710 Syntax ifrelatives <ACTION>
6713 \begin_layout Description
6714 Origin spitz, 2 January 2020
6717 \begin_layout Subsection*
6721 \begin_layout Description
6722 Action Terminates the current LyX instance.
6725 \begin_layout Description
6726 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6729 \begin_layout Description
6733 \begin_layout Subsection*
6737 \begin_layout Description
6738 Action Open lyxfiles (templates/examples). Create a view if he have none.
6741 \begin_layout Description
6742 Syntax lyxfiles-open [<TYPE>]
6745 \begin_layout Description
6746 Params <TYPE>: templates or examples. Default is templates.
6749 \begin_layout Description
6750 Origin spitz, 10 Feb 2021
6753 \begin_layout Subsection*
6754 master-buffer-export
6757 \begin_layout Description
6758 Action Exports the master buffer (document) to the given format.
6761 \begin_layout Description
6762 Syntax master-buffer-export [<FORMAT>] [<DEST>]
6765 \begin_layout Description
6766 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.
6767 \begin_inset Newline newline
6770 Note that "custom" is not allowed in this case.
6771 \begin_inset Newline newline
6774 If absent or "default", then the default output format of the document is used.
6775 \begin_inset Newline newline
6778 <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.
6781 \begin_layout Description
6782 Origin rkh, 18 April 2018
6785 \begin_layout Subsection*
6786 master-buffer-forall
6789 \begin_layout Description
6790 Action Applies a command to a buffer and all it children, starting from the master.
6793 \begin_layout Description
6794 Syntax master-buffer-forall <LFUN-COMMAND>
6797 \begin_layout Description
6798 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6801 \begin_layout Description
6802 Sample Close all Notes in buffers:
6803 \begin_inset Newline newline
6806 master-buffer-forall inset-forall Note inset-toggle close
6807 \begin_inset Newline newline
6810 Toggle change tracking on buffers:
6811 \begin_inset Newline newline
6814 master-buffer-forall changes-track
6815 \begin_inset Newline newline
6818 Toggle read-only for buffers:
6819 \begin_inset Newline newline
6822 master-buffer-forall buffer-toggle-read-only
6823 \begin_inset Newline newline
6826 Show statistics for individual buffers:
6827 \begin_inset Newline newline
6830 master-buffer-forall statistics
6831 \begin_inset Newline newline
6834 Activate the branch named "Solutions" in buffers:
6835 \begin_inset Newline newline
6838 master-buffer-forall branch-activate Solutions
6839 \begin_inset Newline newline
6845 \begin_layout Description
6846 Origin spitz, 31 Dec 2019
6849 \begin_layout Subsection*
6850 master-buffer-update
6853 \begin_layout Description
6854 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6857 \begin_layout Description
6858 Syntax master-buffer-update [<FORMAT>]
6861 \begin_layout Description
6862 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.
6865 \begin_layout Description
6866 Origin Tommaso, 20 Sep 2007
6869 \begin_layout Subsection*
6873 \begin_layout Description
6874 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6877 \begin_layout Description
6878 Syntax master-buffer-view [<FORMAT>]
6881 \begin_layout Description
6882 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.
6885 \begin_layout Description
6886 Origin Tommaso, 20 Sep 2007
6889 \begin_layout Subsection*
6893 \begin_layout Description
6894 Action Opens the menu given by its name.
6897 \begin_layout Description
6898 Syntax menu-open <NAME>
6901 \begin_layout Description
6902 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6905 \begin_layout Subsection*
6909 \begin_layout Description
6910 Action Close the current tab group.
6913 \begin_layout Description
6914 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6917 \begin_layout Description
6918 Syntax tab-group-close
6921 \begin_layout Description
6922 Origin Abdel, 21 Feb 2008
6925 \begin_layout Subsection*
6929 \begin_layout Description
6930 Action Switch to the next tab group in split view.
6933 \begin_layout Description
6934 Syntax tab-group-next
6937 \begin_layout Subsection*
6941 \begin_layout Description
6942 Action Switch to the previous tab group in split view.
6945 \begin_layout Description
6946 Syntax tab-group-previous
6949 \begin_layout Subsection*
6953 \begin_layout Description
6954 Action Toggles movability of a given toolbar between true/false.
6957 \begin_layout Description
6958 Syntax toolbar-movable <NAME>
6961 \begin_layout Description
6962 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6965 \begin_layout Description
6966 Origin daniel, 12 July 2016
6969 \begin_layout Subsection*
6973 \begin_layout Description
6974 Action Sets visibility of a given toolbar to on, off, or auto.
6977 \begin_layout Description
6978 Notion Skipping "auto" when allowauto is false.
6981 \begin_layout Description
6982 Syntax toolbar-set <NAME> [on|off|auto]
6985 \begin_layout Description
6986 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6987 \begin_inset Newline newline
6990 minibuffer|review|view/update|math_panels|vcs|
6991 \begin_inset Newline newline
6994 view-others|update-others
6997 \begin_layout Description
6998 Origin spitz, 17 Dec 2020
7001 \begin_layout Subsection*
7005 \begin_layout Description
7006 Action Toggles visibility of a given toolbar between on/off/auto.
7009 \begin_layout Description
7010 Notion Skipping "auto" when allowauto is false.
7013 \begin_layout Description
7014 Syntax toolbar-toggle <NAME> [allowauto]
7017 \begin_layout Description
7018 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
7019 \begin_inset Newline newline
7022 minibuffer|review|view/update|math_panels|vcs|
7023 \begin_inset Newline newline
7026 view-others|update-others
7029 \begin_layout Description
7030 Origin Edwin, 21 May 2007
7033 \begin_layout Subsection*
7037 \begin_layout Description
7038 Action Various UI visibility-toggling actions.
7041 \begin_layout Description
7042 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
7045 \begin_layout Description
7046 Params statusbar : Toggle visibility of the statusbar.
7047 \begin_inset Newline newline
7050 menubar : Toggle visibility of the menubar.
7051 \begin_inset Newline newline
7054 scrollbar : Toggle visibility of the scrollbar.
7055 \begin_inset Newline newline
7058 frame : Toggle visibility of the frames around editing window.
7059 \begin_inset Newline newline
7062 zoomslider : Toggle visibility of the zoom slider in statusbar.
7063 \begin_inset Newline newline
7066 zoomlevel : Toggle visibility of the zoom level display in statusbar.
7067 \begin_inset Newline newline
7070 statistics-w : Toggle visibility of the document word count in statusbar.
7071 \begin_inset Newline newline
7074 statistics-cb : Toggle visibility of the document character count (incl. blanks) in statusbar.
7075 \begin_inset Newline newline
7078 statistics-c : Toggle visibility of the document character count (excl. blanks) in statusbar.
7079 \begin_inset Newline newline
7082 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.
7085 \begin_layout Description
7086 Origin sanda, 9 Feb 2007
7089 \begin_layout Subsection*
7093 \begin_layout Description
7094 Action Close the current document work area.
7097 \begin_layout Description
7098 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
7101 \begin_layout Description
7105 \begin_layout Description
7106 Origin Tommaso, 15 Sep 2012
7109 \begin_layout Subsection*
7113 \begin_layout Description
7114 Action Creates another split view of current buffer.
7117 \begin_layout Description
7118 Notion All split views act in the same way independently.
7121 \begin_layout Description
7122 Syntax view-split <vertical|horizontal>
7125 \begin_layout Description
7126 Params horizontal : The work areas are laid out side by side.
7127 \begin_inset Newline newline
7130 vertical : The work areas laid out vertically.
7133 \begin_layout Description
7134 Origin Abdel, 20 Feb 2008
7137 \begin_layout Subsection*
7141 \begin_layout Description
7142 Action Closes the current LyX window.
7145 \begin_layout Description
7149 \begin_layout Description
7150 Origin Abdel, 23 Oct 2006
7153 \begin_layout Subsection*
7157 \begin_layout Description
7158 Action Creates new empty LyX window.
7161 \begin_layout Description
7162 Notion Already opened documents from the previous window can be found under View menu.
7165 \begin_layout Description
7166 Syntax window-new [<GEOMETRY>]
7169 \begin_layout Description
7170 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
7173 \begin_layout Description
7174 Origin Abdel, 21 Oct 2006
7177 \begin_layout Section
7178 System Functions (Preferences, LyX Server etc.)
7181 \begin_layout Subsection*
7182 bibtex-database-list
7185 \begin_layout Description
7186 Action Lists the available databases (separated by path separator common on the used OS).
7189 \begin_layout Description
7190 Notion Used by bibliographic managers
7193 \begin_layout Description
7194 Syntax bibtex-database-list
7197 \begin_layout Description
7198 Origin bpiwowar, 18 December 2022
7201 \begin_layout Subsection*
7202 buffer-toggle-output-sync
7205 \begin_layout Description
7206 Action Toggles including of resources for forward/reverse search of the given document.
7209 \begin_layout Description
7210 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
7213 \begin_layout Description
7214 Syntax buffer-toggle-output-sync
7217 \begin_layout Description
7218 Origin sanda, 25 May 2010
7221 \begin_layout Subsection*
7225 \begin_layout Description
7226 Action Executes a command defined in a .def file.
7229 \begin_layout Description
7230 Notion The definitions are by default read from lib/commands/default.def.
7231 \begin_inset Newline newline
7234 A .def file allows to define a command with
7236 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).
7238 def_file "FileName" allows to include another .def file.
7239 \begin_inset Newline newline
7242 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.
7245 \begin_layout Description
7249 \begin_layout Description
7250 Params <NAME>: Name of the command that must be called.
7253 \begin_layout Description
7254 Origin broider, 2 Oct 2007
7257 \begin_layout Subsection*
7261 \begin_layout Description
7262 Action Cancels sequence prepared by LFUN_META_PREFIX .
7265 \begin_layout Description
7269 \begin_layout Subsection*
7270 command-alternatives
7273 \begin_layout Description
7274 Action Runs the first listed command that is enabled.
7277 \begin_layout Description
7278 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
7281 \begin_layout Description
7282 Syntax command-alternatives <CMDS>
7285 \begin_layout Description
7286 Params <CMDS>: Sequence of commands separated by semicolons.
7289 \begin_layout Description
7290 Sample command-alternatives completion-accept;cell-forward
7293 \begin_layout Description
7294 Origin rgh, 24 September 2008
7297 \begin_layout Subsection*
7301 \begin_layout Description
7302 Action Run more commands (LFUN and its parameters) in a sequence.
7305 \begin_layout Description
7306 Syntax command-sequence <CMDS>
7309 \begin_layout Description
7310 Params <CMDS>: Sequence of commands separated by semicolons.
7313 \begin_layout Description
7314 Sample command-sequence cut; ert-insert; self-insert
7316 ; paste; self-insert {}; inset-toggle;
7319 \begin_layout Description
7320 Origin Andre, 11 Nov 1999
7323 \begin_layout Subsection*
7324 cursor-follows-scrollbar-toggle
7327 \begin_layout Description
7328 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
7331 \begin_layout Description
7332 Syntax toggle-cursor-follows-scrollbar
7335 \begin_layout Description
7336 Origin ARRae, 2 Dec 1997
7339 \begin_layout Subsection*
7343 \begin_layout Description
7344 Action Set debug output level.
7347 \begin_layout Description
7348 Syntax debug-level-set <LEVEL>
7351 \begin_layout Description
7352 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.
7355 \begin_layout Description
7356 Origin sanda, 28 Dec 2009
7359 \begin_layout Subsection*
7363 \begin_layout Description
7364 Action toggle a mode where more information is given in UI
7367 \begin_layout Description
7368 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.
7371 \begin_layout Description
7372 Syntax devel-mode-toggle
7375 \begin_layout Description
7376 Origin lasgouttes, 23 Jul 2017
7379 \begin_layout Subsection*
7383 \begin_layout Description
7384 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
7387 \begin_layout Description
7388 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
7391 \begin_layout Description
7392 Syntax forward-search
7395 \begin_layout Description
7396 Origin sanda, 14 Apr 2010
7399 \begin_layout Subsection*
7403 \begin_layout Description
7404 Action Apply the given settings to user preferences.
7407 \begin_layout Description
7408 Syntax lyxrc-apply <SETTINGS>
7411 \begin_layout Description
7412 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.
7415 \begin_layout Subsection*
7419 \begin_layout Description
7420 Action Shows message in statusbar (for script purposes).
7423 \begin_layout Description
7424 Syntax message <STRING>
7427 \begin_layout Description
7428 Origin Lgb, 8 Apr 2001
7431 \begin_layout Subsection*
7435 \begin_layout Description
7436 Action Simulate halting Meta key (Alt key on PCs).
7439 \begin_layout Description
7440 Notion Used for buffer edition not for GUI control.
7443 \begin_layout Description
7447 \begin_layout Subsection*
7451 \begin_layout Description
7452 Action Save user preferences.
7455 \begin_layout Description
7456 Syntax preferences-save
7459 \begin_layout Description
7460 Origin Lgb, 27 Nov 1999
7463 \begin_layout Subsection*
7467 \begin_layout Description
7468 Action Reconfigure the automatic settings.
7471 \begin_layout Description
7475 \begin_layout Description
7476 Origin Asger, 14 Feb 1997
7479 \begin_layout Subsection*
7483 \begin_layout Description
7484 Action Enables/disables searching for features in findadv
7487 \begin_layout Description
7488 Syntax search-ignore <type> <value>
7491 \begin_layout Description
7492 Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content
7493 \begin_inset Newline newline
7499 \begin_layout Subsection*
7503 \begin_layout Description
7504 Action Returns path and file name of the currently edited document.
7507 \begin_layout Description
7508 Syntax server-get-filename
7511 \begin_layout Subsection*
7515 \begin_layout Description
7516 Action Returns the current layout (that is environment) name on the cursor position.
7519 \begin_layout Description
7520 Syntax server-get-layout
7523 \begin_layout Subsection*
7524 server-get-statistics
7527 \begin_layout Description
7528 Action Returns the statistics (number of words and characters) in the document or in the given selection.
7531 \begin_layout Description
7532 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7535 \begin_layout Description
7536 Syntax server-get-statistics [<TYPE>]
7539 \begin_layout Description
7540 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
7541 \begin_inset Newline newline
7545 \begin_inset Newline newline
7548 chars: count characters.
7549 \begin_inset Newline newline
7552 chars-space: count characters and spaces.
7555 \begin_layout Description
7556 Origin brokenclock, Oct 10 2014
7559 \begin_layout Subsection*
7563 \begin_layout Description
7564 Action Returns the coordinates of cursor position in the editing area.
7567 \begin_layout Description
7568 Syntax server-get-xy
7571 \begin_layout Subsection*
7572 server-goto-file-row
7575 \begin_layout Description
7576 Action Sets the cursor position in LyX based on the row number of generated TeX file.
7579 \begin_layout Description
7580 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).
7583 \begin_layout Description
7584 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
7587 \begin_layout Description
7588 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.
7589 \begin_inset Newline newline
7592 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).
7593 \begin_inset Newline newline
7596 .ext: extensions will be automatically replaced by .lyx.
7597 \begin_inset Newline newline
7600 <ROW_NUMBER> The row number of the LaTeX file to which to go.
7603 \begin_layout Description
7604 Sample server-goto-file-row /home/user/example.lyx 41
7605 \begin_inset Newline newline
7608 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
7611 \begin_layout Description
7612 Origin Edmar, 23 Dec 1998
7615 \begin_layout Subsection*
7619 \begin_layout Description
7620 Action Sends notify message about the last key-sequence to client.
7623 \begin_layout Description
7624 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
7627 \begin_layout Description
7628 Syntax server-notify
7631 \begin_layout Subsection*
7635 \begin_layout Description
7636 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
7639 \begin_layout Description
7640 Syntax server-set-xy <X> <Y>
7643 \begin_layout Subsection*
7647 \begin_layout Description
7648 Action Set the given LyX color to the color defined by the X11 name given, and optionally a specific color for dark mode.
7651 \begin_layout Description
7652 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
7655 \begin_layout Description
7656 Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
7659 \begin_layout Description
7660 Origin SLior, 11 Jun 2000
7663 \begin_layout Subsection*
7667 \begin_layout Description
7668 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
7671 \begin_layout Description
7672 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7675 \begin_layout Description
7679 \begin_layout Description
7680 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7683 \begin_layout Subsection*
7687 \begin_layout Description
7688 Action Checks-in/commits the changes of the registered file to the repository.
7691 \begin_layout Description
7692 Notion In RCS case this also unlocks the file.
7695 \begin_layout Description
7699 \begin_layout Description
7700 Origin Lgb, 1 Jul 1997
7703 \begin_layout Subsection*
7707 \begin_layout Description
7708 Action Checks-out the document for edit (and locks it in some cases).
7711 \begin_layout Description
7715 \begin_layout Description
7716 Origin Lgb, 1 Jul 1997
7719 \begin_layout Subsection*
7723 \begin_layout Description
7724 Action Executes external command. This command is intended to support additional VCS commands.
7727 \begin_layout Description
7728 Syntax vc-command <FLAG> <PATH> <COMMAND>
7731 \begin_layout Description
7732 Params <FLAG>: Flags for the command can be combined together.
7733 \begin_inset Newline newline
7736 U - dUmmy - no flags
7737 \begin_inset Newline newline
7740 D - Doc - need document loaded to proceed
7741 \begin_inset Newline newline
7744 I - dIrty - mark document dirty
7745 \begin_inset Newline newline
7748 R - Reload - ensure that the document is saved and reload it after command execution
7749 \begin_inset Newline newline
7752 M - Message - ask for input string (commit message)
7753 \begin_inset Newline newline
7756 <PATH>: path where to start. $$p will be replaced by the current document path.
7757 \begin_inset Newline newline
7760 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
7763 \begin_layout Description
7764 Sample vc-command DR $$p "svn up"
7767 \begin_layout Description
7768 Origin sanda, 13 Jan 2009
7771 \begin_layout Subsection*
7775 \begin_layout Description
7776 Action Compares two revisions of the same file under version control.
7779 \begin_layout Description
7780 Syntax vc-compare [<REV1>] [<REV2>]
7783 \begin_layout Description
7784 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
7785 \begin_inset Newline newline
7788 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
7789 \begin_inset Newline newline
7793 \begin_inset Newline newline
7796 <REV2>: Newer file. Used only if REV1 > 0.
7797 \begin_inset Newline newline
7800 If no parameter is given, interactive dialog will be shown.
7803 \begin_layout Description
7804 Sample Compare current document against last commit
7805 \begin_inset Newline newline
7809 \begin_inset Newline newline
7812 Compare current document against current revision - 5 commits
7813 \begin_inset Newline newline
7817 \begin_inset Newline newline
7820 Compare revisions 120 and 155
7821 \begin_inset Newline newline
7827 \begin_layout Description
7828 Origin sanda, 12 Feb 2010
7831 \begin_layout Subsection*
7835 \begin_layout Description
7836 Action Copies the document to another name.
7839 \begin_layout Description
7840 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.
7843 \begin_layout Description
7844 Syntax vc-copy <FILENAME>
7847 \begin_layout Description
7848 Params <FILENAME>: New name of the document.
7849 \begin_inset Newline newline
7852 A file dialog is opened if no filename is given.
7855 \begin_layout Description
7856 Origin gb, 05 Feb 2013
7859 \begin_layout Subsection*
7863 \begin_layout Description
7864 Action Toggles the locking property of the edited file.
7867 \begin_layout Description
7868 Notion This is currently implemented only for SVN.
7871 \begin_layout Description
7872 Syntax vc-locking-toggle
7875 \begin_layout Description
7876 Origin sanda, 25 Jun 2009
7879 \begin_layout Subsection*
7883 \begin_layout Description
7884 Action Register the document as an file inside version control system.
7887 \begin_layout Description
7888 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
7889 \begin_inset Newline newline
7892 See LyX Additional Features Manual (Version Control Chapter) for additional information.
7895 \begin_layout Description
7899 \begin_layout Description
7900 Origin Lgb, 1 Jul 1997
7903 \begin_layout Subsection*
7907 \begin_layout Description
7908 Action Renames the document to another name.
7911 \begin_layout Description
7912 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.
7915 \begin_layout Description
7916 Syntax vc-rename <FILENAME>
7919 \begin_layout Description
7920 Params <FILENAME>: New name of the document.
7921 \begin_inset Newline newline
7924 A file dialog is opened if no filename is given.
7927 \begin_layout Description
7928 Origin gb, 05 Feb 2013
7931 \begin_layout Subsection*
7935 \begin_layout Description
7936 Action Update the local archive directory in which resides the current document with the remote repository.
7939 \begin_layout Description
7940 Syntax vc-repo-update
7943 \begin_layout Description
7944 Origin sanda, 16 Oct 2009
7947 \begin_layout Subsection*
7951 \begin_layout Description
7952 Action Reverts the document to the last check-in/commit in VCS.
7955 \begin_layout Description
7959 \begin_layout Description
7960 Origin Lgb, 1 Jul 1997
7963 \begin_layout Subsection*
7967 \begin_layout Description
7968 Action Undo last check-in.
7971 \begin_layout Description
7972 Notion This is currently implemented only for RCS.
7975 \begin_layout Description
7979 \begin_layout Description
7980 Origin Lgb, 1 Jul 1997
7983 \begin_layout Section
7984 Hidden Functions (not listed for configuration)
7987 \begin_layout Subsection*
7991 \begin_layout Description
7992 Action Return the current key sequence and available options as a string.
7995 \begin_layout Description
7996 Notion No options are added if no current map exists.
7997 \begin_inset Newline newline
8000 This is probably usable only with connection to lyxserver.
8003 \begin_layout Description
8004 Syntax command-prefix
8007 \begin_layout Subsection*
8011 \begin_layout Description
8012 Action Activates the LyX window.
8015 \begin_layout Description
8016 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.
8019 \begin_layout Description
8023 \begin_layout Description
8024 Origin skostysh, 4 Aug 2016
8027 \begin_layout Subsection*
8031 \begin_layout Description
8032 Action Inserts the given string (accordingly to the correct keymap).
8035 \begin_layout Description
8036 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
8039 \begin_layout Description
8040 Syntax self-insert <STRING>
8043 \begin_layout Subsection*
8047 \begin_layout Description
8048 Action Raises the LyX window.
8051 \begin_layout Description
8052 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.
8055 \begin_layout Description
8059 \begin_layout Description
8060 Origin forenr, 21 Apr 2020
projects / lyx.git / blob