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 Noun text style font (selection-wise).
315 \begin_layout Description
319 \begin_layout Subsection*
323 \begin_layout Description
324 Action Toggles Roman family font (selection-wise).
327 \begin_layout Description
331 \begin_layout Subsection*
335 \begin_layout Description
336 Action Toggles Sans Serif family font (selection-wise).
339 \begin_layout Description
343 \begin_layout Subsection*
347 \begin_layout Description
348 Action Sets font size according to lyx format string.
351 \begin_layout Description
352 Syntax font-size <SIZE>
355 \begin_layout Description
356 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
357 \begin_inset Newline newline
360 largest|huge|giant|increase|decrease|default
363 \begin_layout Subsection*
367 \begin_layout Description
368 Action Returns the info about the current font.
371 \begin_layout Description
375 \begin_layout Subsection*
379 \begin_layout Description
380 Action Toggles strikeout (strike-through) in the font (selection-wise).
383 \begin_layout Description
384 Syntax font-strikeout
387 \begin_layout Description
388 Origin sanda, 3 May 2009
391 \begin_layout Subsection*
395 \begin_layout Description
396 Action Toggles the typewriter family font (selection-wise).
399 \begin_layout Description
400 Syntax font-typewriter
403 \begin_layout Subsection*
407 \begin_layout Description
408 Action Toggles underline in the font (selection-wise).
411 \begin_layout Description
412 Syntax font-underline
415 \begin_layout Subsection*
419 \begin_layout Description
420 Action Toggles double underline in the font (selection-wise).
423 \begin_layout Description
424 Syntax font-underunderline
427 \begin_layout Description
428 Origin sanda, 5 May 2009
431 \begin_layout Subsection*
435 \begin_layout Description
436 Action Toggles wavy underline in the font (selection-wise).
439 \begin_layout Description
440 Syntax font-underwave
443 \begin_layout Description
444 Origin sanda, 5 May 2009
447 \begin_layout Subsection*
451 \begin_layout Description
452 Action Sets the layout (that is, environment) for the current paragraph.
455 \begin_layout Description
456 Syntax layout <LAYOUT> [ignoreautonests]
459 \begin_layout Description
460 Params <LAYOUT>: the layout to use
461 \begin_inset Newline newline
464 ignoreautonests: If specified, nesting advices will be ignored.
467 \begin_layout Subsection*
471 \begin_layout Description
472 Action Adds a module.
475 \begin_layout Description
476 Notion Adds a module to the list of included modules for the current buffer.
479 \begin_layout Description
480 Syntax layout-module-add <MODULE>
483 \begin_layout Description
484 Params <MODULE>: the module to be added
487 \begin_layout Description
488 Origin rgh, 25 August 2007
491 \begin_layout Subsection*
495 \begin_layout Description
496 Action Clears the module list.
499 \begin_layout Description
500 Notion Clears the list of included modules for the current buffer.
503 \begin_layout Description
504 Syntax layout-modules-clear
507 \begin_layout Description
508 Origin rgh, 25 August 2007
511 \begin_layout Subsection*
515 \begin_layout Description
516 Action Launches the paragraph settings dialog.
519 \begin_layout Description
520 Syntax layout-paragraph
523 \begin_layout Subsection*
527 \begin_layout Description
528 Action Reloads layout information.
531 \begin_layout Description
532 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.
535 \begin_layout Description
539 \begin_layout Description
540 Origin rgh, 3 September 2007
543 \begin_layout Subsection*
547 \begin_layout Description
548 Action Launches the tabular settings dialog.
551 \begin_layout Description
552 Syntax layout-tabular
555 \begin_layout Description
556 Origin Jug, 31 Jul 2000
559 \begin_layout Subsection*
563 \begin_layout Description
564 Action Toggles the layout (that is, environment) for the current paragraph.
567 \begin_layout Description
568 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.
571 \begin_layout Description
572 Syntax layout-toggle <LAYOUT> [ignoreautonests]
575 \begin_layout Description
576 Params <LAYOUT>: the layout to toggle
577 \begin_inset Newline newline
580 ignoreautonests: If specified, nesting advices will be ignored.
583 \begin_layout Description
584 Origin lasgouttes, 14 May 2018
587 \begin_layout Subsection*
591 \begin_layout Description
592 Action Update fonts and its metrics.
595 \begin_layout Description
596 Notion Automatically called after zoom, dpi, font names, or norm change.
599 \begin_layout Description
600 Syntax screen-font-update
603 \begin_layout Description
604 Origin ARRae, 13 Aug 2000
607 \begin_layout Subsection*
611 \begin_layout Description
612 Action Sets the text class for the current buffer.
615 \begin_layout Description
616 Syntax textclass-apply <TEXTCLASS>
619 \begin_layout Description
620 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
623 \begin_layout Subsection*
627 \begin_layout Description
628 Action Loads information for a textclass from disk.
631 \begin_layout Description
632 Syntax textclass-load <TEXTCLASS>
635 \begin_layout Description
636 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
639 \begin_layout Subsection*
643 \begin_layout Description
644 Action Apply last used text properties.
647 \begin_layout Description
648 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
651 \begin_layout Description
652 Syntax textstyle-apply [<NUM>]textstyle-apply
655 \begin_layout Description
656 Params <NUM>: number of the selection in the internal freefonts stack to be applied.
659 \begin_layout Description
660 Origin leeming, 12 Mar 2003
663 \begin_layout Subsection*
667 \begin_layout Description
668 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
671 \begin_layout Description
672 Syntax textstyle-update <FONT_INFO>
675 \begin_layout Description
676 Params <FONT_INFO>: specifies font attributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
677 \begin_inset Newline newline
680 Use lyx -dbg action for exact syntax of text-style dialog parameters.
683 \begin_layout Description
684 Origin leeming, 12 Mar 2003
687 \begin_layout Section
688 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
691 \begin_layout Subsection*
695 \begin_layout Description
696 Action Adds an acute accent to the next character typed.
699 \begin_layout Description
703 \begin_layout Subsection*
707 \begin_layout Description
708 Action Adds a breve accent to the next character typed.
711 \begin_layout Description
715 \begin_layout Subsection*
719 \begin_layout Description
720 Action Adds a caron to the next character typed.
723 \begin_layout Description
727 \begin_layout Subsection*
731 \begin_layout Description
732 Action Adds a cedilla to the next character typed.
735 \begin_layout Description
736 Syntax accent-cedilla
739 \begin_layout Subsection*
743 \begin_layout Description
744 Action Adds a circle accent to the next character typed.
747 \begin_layout Description
751 \begin_layout Subsection*
755 \begin_layout Description
756 Action Adds a circumflex to the next character typed.
759 \begin_layout Description
760 Syntax accent-circumflex
763 \begin_layout Subsection*
767 \begin_layout Description
768 Action Adds a dot accent to the next character typed.
771 \begin_layout Description
775 \begin_layout Subsection*
779 \begin_layout Description
780 Action Adds a grave accent to the next character typed.
783 \begin_layout Description
787 \begin_layout Subsection*
788 accent-hungarian-umlaut
791 \begin_layout Description
792 Action Adds a Hungarian umlaut to the next character typed.
795 \begin_layout Description
799 \begin_layout Subsection*
803 \begin_layout Description
804 Action Adds a macron to the next character typed.
807 \begin_layout Description
811 \begin_layout Subsection*
815 \begin_layout Description
816 Action Adds an ogonek accent to the next character typed.
819 \begin_layout Description
823 \begin_layout Subsection*
827 \begin_layout Description
828 Action Adds a perispomeni (Greek circumflex) over the next character typed.
831 \begin_layout Description
832 Syntax accent-perispomeni
835 \begin_layout Subsection*
839 \begin_layout Description
840 Action Adds a tie over the next two character typed.
843 \begin_layout Description
844 Notion The following char will finish the tie.
847 \begin_layout Description
851 \begin_layout Subsection*
855 \begin_layout Description
856 Action Adds a tilde over the next character typed.
859 \begin_layout Description
863 \begin_layout Subsection*
867 \begin_layout Description
868 Action Adds an umlaut over the next character typed.
871 \begin_layout Description
875 \begin_layout Subsection*
879 \begin_layout Description
880 Action Adds a bar under the next character typed.
883 \begin_layout Description
884 Syntax accent-underbar
887 \begin_layout Subsection*
891 \begin_layout Description
892 Action Adds a dot under the next character typed.
895 \begin_layout Description
896 Syntax accent-underdot
899 \begin_layout Subsection*
903 \begin_layout Description
904 Action Accepts all tracked changes in the document.
907 \begin_layout Description
908 Syntax all-changes-accept
911 \begin_layout Description
912 Origin Levon, 16 Oct 2002
915 \begin_layout Subsection*
919 \begin_layout Description
920 Action Rejects all tracked changes in the document.
923 \begin_layout Description
924 Notion Reject does not work recursively; the user may have to repeat the operation.
927 \begin_layout Description
928 Syntax all-changes-reject
931 \begin_layout Description
932 Origin Levon, 16 Oct 2002
935 \begin_layout Subsection*
939 \begin_layout Description
940 Action Start (or remove) Appendix on the given cursor position.
943 \begin_layout Description
947 \begin_layout Description
948 Origin ettrich, 5 May 1998
951 \begin_layout Subsection*
955 \begin_layout Description
956 Action Inserts an argument (short title) inset.
959 \begin_layout Description
960 Syntax argument-insert <argument nr>
963 \begin_layout Description
964 Params <argument nr>: see layout declarations
967 \begin_layout Description
968 Origin vermeer, 12 Aug 2002
971 \begin_layout Subsection*
975 \begin_layout Description
976 Action Adds database, which will be used for bibtex citations.
979 \begin_layout Description
980 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
983 \begin_layout Description
984 Syntax bibtex-database-add <DATABASE-NAME>
987 \begin_layout Description
988 Origin Ale, 30 May 1997
991 \begin_layout Subsection*
995 \begin_layout Description
996 Action Adds database, which will be used for bibtex citations.
999 \begin_layout Description
1000 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1003 \begin_layout Description
1004 Syntax bibtex-database-del <DATABASE-NAME>
1007 \begin_layout Description
1008 Origin Ale, 30 May 1997
1011 \begin_layout Subsection*
1015 \begin_layout Description
1016 Action Clears the list of saved bookmarks.
1019 \begin_layout Description
1020 Syntax bookmark-clear
1023 \begin_layout Description
1024 Origin bpeng, 31 October 2006
1027 \begin_layout Subsection*
1031 \begin_layout Description
1032 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
1035 \begin_layout Description
1036 Notion Bookmark 0 has a special purpose. It is automatically set
1037 \begin_inset Newline newline
1040 1. to the paragraph you are currently editing
1041 \begin_inset Newline newline
1044 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1045 \begin_inset Newline newline
1048 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1051 \begin_layout Description
1052 Syntax bookmark-goto <NUMBER>
1055 \begin_layout Description
1056 Params <NUMBER>: the number of the bookmark to restore.
1059 \begin_layout Description
1060 Origin Dekel, 27 January 2001
1063 \begin_layout Subsection*
1067 \begin_layout Description
1068 Action Save a bookmark.
1071 \begin_layout Description
1072 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.
1075 \begin_layout Description
1076 Syntax bookmark-save <NUMBER>
1079 \begin_layout Description
1080 Params <NUMBER>: the number of the bookmark to save.
1083 \begin_layout Description
1084 Origin Dekel, 27 January 2001
1087 \begin_layout Subsection*
1091 \begin_layout Description
1092 Action Inserts Box inset.
1095 \begin_layout Description
1096 Syntax box-insert [<TYPE>]
1099 \begin_layout Description
1100 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1101 \begin_inset Newline newline
1104 Framed is the default one.
1107 \begin_layout Description
1108 Origin vermeer, 7 Oct 2003
1111 \begin_layout Subsection*
1115 \begin_layout Description
1116 Action Inserts branch inset.
1119 \begin_layout Description
1120 Syntax branch-insert <BRANCH-NAME>
1123 \begin_layout Description
1124 Origin vermeer, 17 Aug 2003
1127 \begin_layout Subsection*
1131 \begin_layout Description
1132 Action For debug purposes only. Convert all [a-zA-Z0-1] characters to single character. Useful when submitting docs to list or bugzilla.
1135 \begin_layout Description
1136 Syntax buffer-anonymize
1139 \begin_layout Description
1140 Origin sanda, Feb 1 2018
1143 \begin_layout Subsection*
1147 \begin_layout Description
1148 Action Move the cursor to the beginning of the document.
1151 \begin_layout Description
1155 \begin_layout Subsection*
1159 \begin_layout Description
1160 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1163 \begin_layout Description
1164 Syntax buffer-begin-select
1167 \begin_layout Subsection*
1171 \begin_layout Description
1172 Action Move the cursor to the end of the document.
1175 \begin_layout Description
1179 \begin_layout Subsection*
1183 \begin_layout Description
1184 Action Move the cursor to the end of the document adding the traversed text to the selection.
1187 \begin_layout Description
1188 Syntax buffer-end-select
1191 \begin_layout Subsection*
1195 \begin_layout Description
1196 Action Inserts a caption inset.
1199 \begin_layout Description
1200 Syntax caption-insert
1203 \begin_layout Description
1204 Origin Lgb, 18 Jul 2000
1207 \begin_layout Subsection*
1211 \begin_layout Description
1212 Action Moves the cursor to the previous cell inside the table.
1215 \begin_layout Description
1216 Syntax cell-backward
1219 \begin_layout Description
1220 Origin Jug, 22 May 2000
1223 \begin_layout Subsection*
1227 \begin_layout Description
1228 Action Moves the cursor to the next cell inside the table.
1231 \begin_layout Description
1235 \begin_layout Subsection*
1239 \begin_layout Description
1240 Action Splits cell and shifts right part to the next cell (inside the math grid).
1243 \begin_layout Description
1247 \begin_layout Description
1248 Origin Ale, 15 May 1997
1251 \begin_layout Subsection*
1255 \begin_layout Description
1256 Action Accepts tracked change inside the selection.
1259 \begin_layout Description
1260 Syntax change-accept
1263 \begin_layout Description
1264 Origin Levon, 16 Oct 2002
1267 \begin_layout Subsection*
1271 \begin_layout Description
1272 Action Moves the cursor to the position of the next change of the change tracking records.
1275 \begin_layout Description
1279 \begin_layout Description
1280 Origin schmitt, 4 Oct 2006
1283 \begin_layout Subsection*
1287 \begin_layout Description
1288 Action Moves the cursor to the position of the previous change of the change tracking records.
1291 \begin_layout Description
1292 Syntax change-previous
1295 \begin_layout Description
1296 Origin vfr, 4 Apr 2009
1299 \begin_layout Subsection*
1303 \begin_layout Description
1304 Action Rejects tracked change inside the selection.
1307 \begin_layout Description
1308 Syntax change-reject
1311 \begin_layout Description
1312 Origin Levon, 16 Oct 2002
1315 \begin_layout Subsection*
1319 \begin_layout Description
1320 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1323 \begin_layout Description
1324 Syntax changes-merge
1327 \begin_layout Description
1328 Origin Levon, 16 Oct 2002
1331 \begin_layout Subsection*
1335 \begin_layout Description
1336 Action Toggles showing of change tracking in typeset output.
1339 \begin_layout Description
1340 Syntax changes-output
1343 \begin_layout Description
1344 Origin spitz, 21 Jan 2005
1347 \begin_layout Subsection*
1351 \begin_layout Description
1352 Action Toggles change tracking to on/off.
1355 \begin_layout Description
1356 Syntax changes-track
1359 \begin_layout Description
1360 Origin levon, 1 Oct 2002
1363 \begin_layout Subsection*
1367 \begin_layout Description
1368 Action Moves the cursor one position logically backwards.
1371 \begin_layout Description
1372 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.
1375 \begin_layout Description
1376 Syntax char-backward
1379 \begin_layout Subsection*
1380 char-backward-select
1383 \begin_layout Description
1384 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1387 \begin_layout Description
1388 Notion See also LFUN_CHAR_BACKWARD.
1391 \begin_layout Description
1392 Syntax char-backward-select
1395 \begin_layout Subsection*
1396 char-delete-backward
1399 \begin_layout Description
1400 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1403 \begin_layout Description
1404 Syntax char-delete-backward [force]
1407 \begin_layout Description
1408 Params force: Delete big insets, do not only select them.
1411 \begin_layout Subsection*
1415 \begin_layout Description
1416 Action Deletes one character in the backward direction (usually the "Delete" key).
1419 \begin_layout Description
1420 Syntax char-delete-forward [force]
1423 \begin_layout Description
1424 Params force: Delete big insets, do not only select them.
1427 \begin_layout Subsection*
1431 \begin_layout Description
1432 Action Moves the cursor one position logically forward.
1435 \begin_layout Description
1436 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.
1439 \begin_layout Description
1443 \begin_layout Subsection*
1447 \begin_layout Description
1448 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1451 \begin_layout Description
1452 Notion See also LFUN_CHAR_FORWARD.
1455 \begin_layout Description
1456 Syntax char-forward-select
1459 \begin_layout Subsection*
1463 \begin_layout Description
1464 Action Moves the cursor one position "to the left".
1467 \begin_layout Description
1468 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.
1471 \begin_layout Description
1475 \begin_layout Subsection*
1479 \begin_layout Description
1480 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1483 \begin_layout Description
1484 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1487 \begin_layout Description
1488 Syntax char-left-select
1491 \begin_layout Subsection*
1495 \begin_layout Description
1496 Action Moves the cursor one position "to the right".
1499 \begin_layout Description
1500 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.
1503 \begin_layout Description
1507 \begin_layout Subsection*
1511 \begin_layout Description
1512 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1515 \begin_layout Description
1516 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1519 \begin_layout Description
1520 Syntax char-right-select
1523 \begin_layout Subsection*
1527 \begin_layout Description
1528 Action Transposes the character at the cursor with the one before it.
1531 \begin_layout Description
1532 Syntax chars-transpose
1535 \begin_layout Description
1536 Origin Lgb, 25 Apr 2001
1539 \begin_layout Subsection*
1543 \begin_layout Description
1544 Action Inserts citation from loaded citation database.
1547 \begin_layout Description
1548 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1551 \begin_layout Description
1552 Params <KEY>: Citation (shortcut listed in available citations).
1553 \begin_inset Newline newline
1556 <TEXT_BEFORE>: text which should appear before citation.
1559 \begin_layout Description
1560 Origin AAS, 97-02-23
1563 \begin_layout Subsection*
1567 \begin_layout Description
1568 Action Opens the corresponding pdf/url for a given citation inset.
1571 \begin_layout Description
1572 Syntax citation-open [EXTERNAL] TARGET
1575 \begin_layout Description
1576 Params <TARGET>: URL (https:,file:) of the document.
1577 \begin_inset Newline newline
1580 <EXTERNAL>: Use external executable script for finding target
1581 \begin_inset Newline newline
1584 and launching viewer. In this case TARGET consists of author and year
1585 \begin_inset Newline newline
1588 and will be passed as an input argument to the script.
1591 \begin_layout Description
1592 Origin Sanda, 16 Aug 2020
1595 \begin_layout Subsection*
1599 \begin_layout Description
1600 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.
1603 \begin_layout Description
1604 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.
1607 \begin_layout Description
1608 Syntax clipboard-paste [<ARG>]
1611 \begin_layout Description
1612 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1615 \begin_layout Description
1616 Origin Georg, 10 Jul 2006
1619 \begin_layout Subsection*
1620 clipboard-paste-simple
1623 \begin_layout Description
1624 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.
1627 \begin_layout Description
1628 Syntax clipboard-paste-simple [<ARG>]
1631 \begin_layout Description
1632 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1635 \begin_layout Subsection*
1639 \begin_layout Description
1640 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1643 \begin_layout Description
1644 Notion Usually bound to M-x shortcut.
1647 \begin_layout Description
1648 Syntax command-execute
1651 \begin_layout Subsection*
1655 \begin_layout Description
1656 Action Try to complete the word or command at the cursor position.
1659 \begin_layout Description
1663 \begin_layout Description
1664 Origin sts, Feb 19 2008
1667 \begin_layout Subsection*
1671 \begin_layout Description
1672 Action Accept suggested completion.
1675 \begin_layout Description
1676 Syntax completion-accept
1679 \begin_layout Description
1680 Origin sanda, Sep 08 2008
1683 \begin_layout Subsection*
1687 \begin_layout Description
1688 Action Try to cancel completion, either the popup or the inline completion.
1691 \begin_layout Description
1692 Syntax completion-cancel
1695 \begin_layout Description
1696 Origin sts, Sep 07 2008
1699 \begin_layout Subsection*
1703 \begin_layout Description
1704 Action Show the inline completion at the cursor position.
1707 \begin_layout Description
1708 Syntax completion-inline
1711 \begin_layout Description
1712 Origin sts, Feb 19 2008
1715 \begin_layout Subsection*
1719 \begin_layout Description
1720 Action Show the completion popup at the cursor position.
1723 \begin_layout Description
1724 Syntax completion-popup
1727 \begin_layout Description
1728 Origin sts, Feb 19 2008
1731 \begin_layout Subsection*
1735 \begin_layout Description
1736 Action Copies the current selection to the clipboard.
1739 \begin_layout Description
1743 \begin_layout Subsection*
1747 \begin_layout Description
1748 Action Cuts to the clipboard.
1751 \begin_layout Description
1755 \begin_layout Subsection*
1759 \begin_layout Description
1760 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1763 \begin_layout Description
1764 Syntax depth-decrement
1767 \begin_layout Subsection*
1771 \begin_layout Description
1772 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1775 \begin_layout Description
1776 Syntax depth-increment
1779 \begin_layout Subsection*
1780 dialog-disconnect-inset
1783 \begin_layout Description
1784 Action Closes opened connection to opened inset.
1787 \begin_layout Description
1788 Notion Connection is used for apply functions.
1791 \begin_layout Description
1792 Syntax dialog-disconnect-inset <INSET-NAME>
1795 \begin_layout Description
1796 Origin leeming, 25 Feb 2003
1799 \begin_layout Subsection*
1803 \begin_layout Description
1804 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1807 \begin_layout Description
1808 Syntax dialog-hide <NAME>
1811 \begin_layout Description
1812 Params See LFUN_DIALOG_SHOW .
1815 \begin_layout Description
1816 Origin leeming, 25 Feb 2003
1819 \begin_layout Subsection*
1823 \begin_layout Description
1824 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1827 \begin_layout Description
1828 Syntax dialog-show <NAME> [<DATA>]
1831 \begin_layout Description
1832 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1833 \begin_inset Newline newline
1836 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1837 \begin_inset Newline newline
1840 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1841 \begin_inset Newline newline
1844 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1845 \begin_inset Newline newline
1848 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1849 \begin_inset Newline newline
1852 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1853 \begin_inset Newline newline
1856 <SPECIAL>: latexlog|vclog
1857 \begin_inset Newline newline
1860 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1863 \begin_layout Description
1864 Origin leeming, 17 Jun 2003
1867 \begin_layout Subsection*
1868 dialog-show-new-inset
1871 \begin_layout Description
1872 Action Shows hidden dialog or create new one for a given inset settings etc.
1875 \begin_layout Description
1876 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1879 \begin_layout Description
1880 Syntax dialog-show-new-inset <NAME> [<DATA>]
1883 \begin_layout Description
1884 Params See LFUN_DIALOG_SHOW .
1887 \begin_layout Description
1888 Origin leeming, 25 Feb 2003
1891 \begin_layout Subsection*
1895 \begin_layout Description
1896 Action Toggles dialog between showed/hidden state.
1899 \begin_layout Description
1900 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1903 \begin_layout Description
1904 Syntax dialog-toggle <NAME> [<DATA>]
1907 \begin_layout Description
1908 Params See LFUN_DIALOG_SHOW .
1911 \begin_layout Description
1912 Origin spitz, 30 Apr 2007
1915 \begin_layout Subsection*
1919 \begin_layout Description
1920 Action Updates the dialog values from the inset/paragraph/document.
1923 \begin_layout Description
1924 Syntax dialog-update <NAME>
1927 \begin_layout Description
1928 Params <NAME>: paragraph|prefs|<INSET>
1929 \begin_inset Newline newline
1935 \begin_layout Description
1936 Origin leeming, 25 Feb 2003
1939 \begin_layout Subsection*
1943 \begin_layout Description
1944 Action Moves the cursor one line in downward direction.
1947 \begin_layout Description
1951 \begin_layout Subsection*
1955 \begin_layout Description
1956 Action Moves the cursor one line in downward direction adding the current position to the selection.
1959 \begin_layout Description
1963 \begin_layout Subsection*
1967 \begin_layout Description
1968 Action Inserts an ERT inset.
1971 \begin_layout Description
1975 \begin_layout Description
1976 Origin Jug, 18 Feb 2000
1979 \begin_layout Subsection*
1983 \begin_layout Description
1984 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1987 \begin_layout Description
1991 \begin_layout Description
1992 Origin Lgb, 17 May 2001
1995 \begin_layout Subsection*
1999 \begin_layout Description
2000 Action Cancel background export process.
2003 \begin_layout Description
2004 Syntax export-cancel
2007 \begin_layout Description
2008 Origin rgh, 10 December 2017
2011 \begin_layout Subsection*
2015 \begin_layout Description
2016 Action Inserts another LyX file.
2019 \begin_layout Description
2020 Syntax file-insert [<FILE>] [ignorelang]
2023 \begin_layout Description
2024 Params <FILE>: Filename to be inserted. ignorelang: If given, the (main) language of the inserted file is ignored (the context language is used).
2027 \begin_layout Subsection*
2028 file-insert-plaintext
2031 \begin_layout Description
2032 Action Inserts plain text file.
2035 \begin_layout Description
2036 Syntax file-insert-plaintext [<FILE>]
2039 \begin_layout Description
2040 Params <FILE>: Filename to be inserted.
2043 \begin_layout Description
2044 Origin CFO-G, 19 Nov 1997
2047 \begin_layout Subsection*
2048 file-insert-plaintext-para
2051 \begin_layout Description
2052 Action Inserts plain text file as paragraph (i.e. join lines).
2055 \begin_layout Description
2056 Syntax file-insert-plaintext-para [<FILE>]
2059 \begin_layout Description
2060 Params <FILE>: Filename to be inserted.
2063 \begin_layout Description
2064 Origin Levon, 14 Feb 2001
2067 \begin_layout Subsection*
2071 \begin_layout Description
2072 Action Inserts CharStyle, Custom inset or XML short element.
2075 \begin_layout Description
2076 Notion Look into the Customization manual for more information about these elements.
2077 \begin_inset Newline newline
2080 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.
2081 \begin_inset Newline newline
2084 For dissolving the element see LFUN_INSET_DISSOLVE.
2087 \begin_layout Description
2088 Syntax flex-insert Name
2091 \begin_layout Description
2092 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.
2095 \begin_layout Description
2096 Sample flex-insert Code
2099 \begin_layout Subsection*
2103 \begin_layout Description
2104 Action Inserts a float inset.
2107 \begin_layout Description
2108 Syntax float-insert <TYPE>
2111 \begin_layout Description
2112 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2115 \begin_layout Description
2116 Origin Lgb, 27 Jun 2000
2119 \begin_layout Subsection*
2123 \begin_layout Description
2124 Action Inserts the list of floats in the document.
2127 \begin_layout Description
2128 Syntax float-list-insert <TYPE>
2131 \begin_layout Description
2132 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2135 \begin_layout Description
2136 Origin Lgb, 3 May 2001
2139 \begin_layout Subsection*
2143 \begin_layout Description
2144 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2147 \begin_layout Description
2148 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2151 \begin_layout Description
2152 Syntax float-wide-insert <TYPE>
2155 \begin_layout Description
2156 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2159 \begin_layout Description
2160 Origin Lgb, 31 Oct 2001
2163 \begin_layout Subsection*
2167 \begin_layout Description
2168 Action Inserts a footnote inset.
2171 \begin_layout Description
2172 Syntax footnote-insert
2175 \begin_layout Description
2176 Origin Jug, 7 Mar 2000
2179 \begin_layout Subsection*
2183 \begin_layout Description
2184 Action Reloads the image if necessary.
2187 \begin_layout Description
2188 Syntax graphics-reload
2191 \begin_layout Description
2192 Origin vfr, 10 Aug 2009
2195 \begin_layout Subsection*
2199 \begin_layout Description
2200 Action Set the group for the graphics inset on the cursor position.
2203 \begin_layout Description
2204 Syntax graphics-set-group [<GROUP>]
2207 \begin_layout Description
2208 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
2211 \begin_layout Description
2212 Origin sanda, 6 May 2008
2215 \begin_layout Subsection*
2219 \begin_layout Description
2220 Action Set the same group for all graphics insets in the marked block.
2223 \begin_layout Description
2224 Syntax graphics-unify [<GROUP>]
2227 \begin_layout Description
2228 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.
2231 \begin_layout Description
2232 Origin sanda, 7 Feb 2018
2235 \begin_layout Subsection*
2239 \begin_layout Description
2240 Action Inserts hyperlinks into the document (clickable in pdf output).
2243 \begin_layout Description
2244 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2247 \begin_layout Description
2248 Syntax href-insert [<TARGET>]
2251 \begin_layout Description
2252 Origin CFO-G, 21 Nov 1997
2255 \begin_layout Subsection*
2259 \begin_layout Description
2260 Action Only active in IPA inset.
2263 \begin_layout Description
2264 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.
2267 \begin_layout Description
2271 \begin_layout Description
2272 Origin spitz, 20 May 2012
2275 \begin_layout Subsection*
2279 \begin_layout Description
2280 Action Inserts Index entry.
2283 \begin_layout Description
2284 Notion It automatically takes the word on the cursor position.
2287 \begin_layout Description
2288 Syntax index-insert [<TYPE:Name>]
2291 \begin_layout Description
2292 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2295 \begin_layout Description
2296 Origin leeming, 3 Aug 2000
2299 \begin_layout Subsection*
2303 \begin_layout Description
2304 Action Inserts list of Index entries on a new page.
2307 \begin_layout Description
2308 Syntax index-print [<TYPE:Name>]
2311 \begin_layout Description
2312 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2315 \begin_layout Description
2316 Origin Lgb, 27 Feb 1997
2319 \begin_layout Subsection*
2323 \begin_layout Description
2324 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2327 \begin_layout Description
2328 Notion Apart from lfun arguments you can use the following method:
2329 \begin_inset Newline newline
2332 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2333 \begin_inset Newline newline
2336 2. select the text and run info-insert lfun.
2339 \begin_layout Description
2340 Syntax info-insert <TYPE> <ARG>
2343 \begin_layout Description
2344 Params <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2345 \begin_inset Newline newline
2348 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2349 \begin_inset Newline newline
2352 date: current date (formatted and localized)
2353 \begin_inset Newline newline
2356 moddate: date of last modification (saving) (formatted and localized)
2357 \begin_inset Newline newline
2360 fixdate: a static date (formatted and localized)
2361 \begin_inset Newline newline
2364 time: current time (formatted and localized)
2365 \begin_inset Newline newline
2368 modtime: time of last modification (saving) (formatted and localized)
2369 \begin_inset Newline newline
2372 fixtime: a static time (formatted and localized)
2373 \begin_inset Newline newline
2376 shortcut[s]: name of lfun (e.g math-insert
2379 \begin_inset Newline newline
2382 lyxrc: name of rc_entry (e.g. bind_file)
2383 \begin_inset Newline newline
2386 lyxinfo: "version" - used version of LyX
2387 \begin_inset Newline newline
2390 package: name of latex package (e.g. listings)
2391 \begin_inset Newline newline
2394 textclass: name of textclass (e.g. article)
2395 \begin_inset Newline newline
2398 menu: name of lfun used in menu
2399 \begin_inset Newline newline
2402 l7n: localizable string.
2403 \begin_inset Newline newline
2406 icon: icon of lfun used in toolbar or direct icon name
2407 \begin_inset Newline newline
2410 buffer: "name"|"name-noext"|"path"|"class" vcs: "tree-revision"|"revision"|"author"|"date"|"time"
2413 \begin_layout Description
2414 Sample command-sequence info-insert buffer path; info-insert buffer name
2417 \begin_layout Description
2418 Origin bpeng, 7 Oct 2007
2421 \begin_layout Subsection*
2425 \begin_layout Description
2426 Action Apply data for an inset.
2429 \begin_layout Description
2430 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.
2433 \begin_layout Description
2434 Syntax inset-apply <ARGS>
2437 \begin_layout Description
2438 Params See LFUN_INSET_INSERT .
2441 \begin_layout Subsection*
2445 \begin_layout Description
2446 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.
2449 \begin_layout Description
2453 \begin_layout Description
2454 Origin lasgouttes, 16 Mar 2009
2457 \begin_layout Subsection*
2461 \begin_layout Description
2462 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).
2465 \begin_layout Description
2466 Syntax inset-begin-select
2469 \begin_layout Description
2470 Origin lasgouttes, 16 Mar 2009
2473 \begin_layout Subsection*
2477 \begin_layout Description
2478 Action Copies the inset to the clipboard as a certain type.
2481 \begin_layout Description
2482 Notion Currently used only for InsetInfo where its content is copied as a text.
2485 \begin_layout Description
2486 Syntax inset-copy-as
2489 \begin_layout Description
2490 Origin vfr, 18 Apr 2010
2493 \begin_layout Subsection*
2497 \begin_layout Description
2498 Action Dissolve the current inset into text.
2501 \begin_layout Description
2502 Syntax inset-dissolve [<INSET>]
2505 \begin_layout Description
2506 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.
2507 \begin_inset Newline newline
2510 For values see lyx::InsetLayout::lyxtype_ .
2513 \begin_layout Description
2514 Origin JSpitz, 7 Aug 2006
2517 \begin_layout Subsection*
2521 \begin_layout Description
2522 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.
2525 \begin_layout Description
2526 Syntax inset-edit [<INSET_PARAMS>]
2529 \begin_layout Description
2530 Params <INSET_PARAMS>: Parameters for the inset.
2531 \begin_inset Newline newline
2534 Currently only the filename will be considered.
2537 \begin_layout Description
2538 Origin spitz, 27 Apr 2006
2541 \begin_layout Subsection*
2545 \begin_layout Description
2546 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.
2549 \begin_layout Description
2553 \begin_layout Description
2554 Origin lasgouttes, 16 Mar 2009
2557 \begin_layout Subsection*
2561 \begin_layout Description
2562 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.
2565 \begin_layout Description
2566 Syntax inset-end-edit
2569 \begin_layout Description
2570 Origin gb, 11 Oct 2015
2573 \begin_layout Subsection*
2577 \begin_layout Description
2578 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).
2581 \begin_layout Description
2582 Syntax inset-end-select
2585 \begin_layout Description
2586 Origin lasgouttes, 16 Mar 2009
2589 \begin_layout Subsection*
2593 \begin_layout Description
2594 Action Apply the given commands on insets of a given name.
2597 \begin_layout Description
2598 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.
2601 \begin_layout Description
2602 Syntax inset-forall <NAME> <LFUN-COMMAND>
2603 \begin_inset Newline newline
2606 <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.
2609 \begin_layout Description
2610 Sample Remove all index insets:
2611 \begin_inset Newline newline
2614 inset-forall Index char-delete-forward force
2615 \begin_inset Newline newline
2618 Close all Notes (also works for a particular branch, for example):
2619 \begin_inset Newline newline
2622 inset-forall Note inset-toggle close
2623 \begin_inset Newline newline
2626 Transform all yellow notes to comments
2627 \begin_inset Newline newline
2630 inset-forall Note:Note inset-modify note Note Comment
2631 \begin_inset Newline newline
2634 Try to put LyX in an infinite loop if there is at least a Note:
2635 \begin_inset Newline newline
2638 inset-forall Note char-backward
2641 \begin_layout Description
2642 Origin lasgouttes, 27 Nov 2009
2645 \begin_layout Subsection*
2649 \begin_layout Description
2650 Action Insert new inset (type given by the parameters).
2653 \begin_layout Description
2654 Syntax inset-insert <INSET> <ARGS>
2657 \begin_layout Description
2658 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2659 \begin_inset Newline newline
2662 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2663 \begin_inset Newline newline
2666 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2669 \begin_layout Description
2670 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2673 \begin_inset Newline newline
2676 where <label name> is the name of the referenced label and <Format> is one of the following:
2677 \begin_inset Newline newline
2681 \begin_inset Newline newline
2684 eqref -- (<reference>)
2685 \begin_inset Newline newline
2689 \begin_inset Newline newline
2692 vpageref -- on <page>
2693 \begin_inset Newline newline
2696 vref -- <reference> on <page>
2697 \begin_inset Newline newline
2700 formatted -- Formatted reference
2703 \begin_layout Subsection*
2707 \begin_layout Description
2708 Action Modify some properties of an inset.
2711 \begin_layout Description
2712 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.
2715 \begin_layout Description
2716 Syntax inset-modify <INSET> <ARGS>
2717 \begin_inset Newline newline
2720 inset-modify changetype <TYPE>
2723 \begin_layout Description
2724 Sample Change a Note inset into a Comment inset:
2725 \begin_inset Newline newline
2728 inset-modify note Note Comment
2729 \begin_inset Newline newline
2732 Change a Box into an Ovalbox:
2733 \begin_inset Newline newline
2736 inset-modify changetype Ovalbox
2737 \begin_inset Newline newline
2740 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
2741 \begin_inset Newline newline
2744 inset-modify changetype els
2745 \begin_inset Newline newline
2748 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
2749 \begin_inset Newline newline
2752 inset-modify changetype e..
2753 \begin_inset Newline newline
2759 \begin_layout Subsection*
2763 \begin_layout Description
2764 Action Select all contents of an inset.
2767 \begin_layout Description
2768 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2771 \begin_layout Description
2772 Syntax inset-select-all
2775 \begin_layout Description
2776 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2779 \begin_layout Subsection*
2783 \begin_layout Description
2784 Action Open the inset's properties dialog.
2787 \begin_layout Description
2788 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.
2791 \begin_layout Description
2792 Syntax inset-settings <INSET>
2795 \begin_layout Description
2796 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2797 \begin_inset Newline newline
2800 graphics|href|include|index|index_print|label|line|
2801 \begin_inset Newline newline
2804 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2807 \begin_layout Subsection*
2811 \begin_layout Description
2812 Action Splits the current inset into two at current position.
2815 \begin_layout Description
2816 Syntax inset-split [<INSET>]
2819 \begin_layout Description
2820 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.
2821 \begin_inset Newline newline
2824 For values see lyx::InsetLayout::lyxtype_ .
2827 \begin_layout Description
2828 Origin spitz, 22 Dec 2020
2831 \begin_layout Subsection*
2835 \begin_layout Description
2836 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2839 \begin_layout Description
2840 Syntax inset-toggle [<ARG>]
2843 \begin_layout Description
2844 Params <ARG>: <open|close|toggle|assign>.
2845 \begin_inset Newline newline
2848 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2849 \begin_inset Newline newline
2852 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2855 \begin_layout Description
2856 Origin lasgouttes, 19 Jul 2001
2859 \begin_layout Subsection*
2863 \begin_layout Description
2864 Action Inserts an IPA inset.
2867 \begin_layout Description
2871 \begin_layout Description
2872 Origin spitz, 05 Mar 2012
2875 \begin_layout Subsection*
2879 \begin_layout Description
2880 Action Inserts special IPA macros into the document.
2883 \begin_layout Description
2884 Syntax ipamacro-insert <CHAR>
2887 \begin_layout Description
2888 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2891 \begin_layout Description
2892 Origin spitz, 22 Aug 2012
2895 \begin_layout Subsection*
2899 \begin_layout Description
2900 Action Turn off the loaded keyboard map.
2903 \begin_layout Description
2907 \begin_layout Subsection*
2911 \begin_layout Description
2912 Action Turn on the primary keyboard map.
2915 \begin_layout Description
2916 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.
2917 \begin_inset Newline newline
2920 The language is to be set in the Preferences dialog.
2923 \begin_layout Description
2924 Syntax keymap-primary
2927 \begin_layout Subsection*
2931 \begin_layout Description
2932 Action Turn on the secondary keyboard map.
2935 \begin_layout Description
2936 Syntax keymap-secondary
2939 \begin_layout Subsection*
2943 \begin_layout Description
2944 Action Toggles keyboard maps (first/second/off).
2947 \begin_layout Description
2948 Syntax keymap-toggle
2951 \begin_layout Description
2952 Origin leeming, 30 Mar 2004
2955 \begin_layout Subsection*
2956 label-copy-as-reference
2959 \begin_layout Description
2960 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2963 \begin_layout Description
2964 Syntax copy-label-as-reference <LABEL>
2967 \begin_layout Description
2968 Params <LABEL>: The label to copy (for multi-line math)
2971 \begin_layout Description
2972 Origin sts, 16 Nov 2008
2975 \begin_layout Subsection*
2979 \begin_layout Description
2980 Action Goto a label.
2983 \begin_layout Description
2984 Syntax label-goto [<LABEL>]
2987 \begin_layout Description
2988 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.
2991 \begin_layout Description
2992 Origin Ale, 6 Aug 1997
2995 \begin_layout Subsection*
2999 \begin_layout Description
3000 Action Inserts label to text or displayed formula.
3003 \begin_layout Description
3004 Syntax label-insert [<LABEL>]
3007 \begin_layout Description
3008 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3011 \begin_layout Subsection*
3012 label-insert-as-reference
3015 \begin_layout Description
3016 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3019 \begin_layout Description
3020 Syntax label-insert-as-reference
3023 \begin_layout Description
3024 Origin vfr, 7 Apr 2009
3027 \begin_layout Subsection*
3031 \begin_layout Description
3032 Action Set language from the current cursor position.
3035 \begin_layout Description
3036 Syntax language <LANG> [set]
3039 \begin_layout Description
3040 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).
3043 \begin_layout Description
3044 Origin Dekel, 2 Mar 2000
3047 \begin_layout Subsection*
3051 \begin_layout Description
3052 Action Move the cursor to the beginning of the (screen) line.
3055 \begin_layout Description
3059 \begin_layout Subsection*
3063 \begin_layout Description
3064 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3067 \begin_layout Description
3068 Syntax line-begin-select
3071 \begin_layout Subsection*
3075 \begin_layout Description
3076 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3079 \begin_layout Description
3080 Syntax line-delete-forward
3083 \begin_layout Subsection*
3087 \begin_layout Description
3088 Action Move the cursor to the end of the (screen) line.
3091 \begin_layout Description
3095 \begin_layout Subsection*
3099 \begin_layout Description
3100 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3103 \begin_layout Description
3104 Syntax line-end-select
3107 \begin_layout Subsection*
3111 \begin_layout Description
3112 Action Inserts a new listings inset.
3115 \begin_layout Description
3116 Syntax listing-insert
3119 \begin_layout Description
3120 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
3123 \begin_layout Subsection*
3127 \begin_layout Description
3128 Action Inserts a marginal note.
3131 \begin_layout Description
3132 Syntax marginalnote-insert
3135 \begin_layout Description
3136 Origin Lgb, 26 Jun 2000
3139 \begin_layout Subsection*
3143 \begin_layout Description
3144 Action Disable selecting of text-region.
3147 \begin_layout Description
3151 \begin_layout Subsection*
3155 \begin_layout Description
3156 Action Enable selecting of text-region.
3159 \begin_layout Description
3160 Notion After enabling you can simply move arrow keys to get selected region.
3163 \begin_layout Description
3167 \begin_layout Subsection*
3171 \begin_layout Description
3172 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3175 \begin_layout Description
3179 \begin_layout Description
3180 Origin Andre, May 5 2006
3183 \begin_layout Subsection*
3187 \begin_layout Description
3188 Action Inserts a line break or new line.
3191 \begin_layout Description
3192 Syntax newline-insert [<ARG>]
3195 \begin_layout Description
3196 Params <ARG>: <newline|linebreak> default: newline
3199 \begin_layout Description
3200 Origin spitz, 25 Mar 2008
3203 \begin_layout Subsection*
3207 \begin_layout Description
3208 Action Inserts a new page.
3211 \begin_layout Description
3212 Syntax newpage-insert <ARG>
3215 \begin_layout Description
3216 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3219 \begin_layout Description
3220 Origin uwestoehr, 24 Nov 2007
3223 \begin_layout Subsection*
3227 \begin_layout Description
3228 Action Inserts Nomenclature entry.
3231 \begin_layout Description
3232 Notion It automatically takes the word on the cursor position if no symbol is given.
3235 \begin_layout Description
3236 Syntax nomencl-insert [<SYMBOL>]
3239 \begin_layout Description
3240 Origin Ugras, 4 Nov 2006
3243 \begin_layout Subsection*
3247 \begin_layout Description
3248 Action Inserts list of Nomenclature entries.
3251 \begin_layout Description
3252 Syntax nomenclature-print
3255 \begin_layout Description
3256 Origin Ugras, 4 Nov 2006
3259 \begin_layout Subsection*
3263 \begin_layout Description
3264 Action Inserts Note on the current cursor position, move selection inside the inset.
3267 \begin_layout Description
3268 Syntax note-insert [<TYPE>]
3271 \begin_layout Description
3272 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3275 \begin_layout Subsection*
3279 \begin_layout Description
3280 Action Moves the cursor to the beginning of next Note inset.
3283 \begin_layout Description
3287 \begin_layout Subsection*
3291 \begin_layout Description
3292 Action Move the current group in the downward direction in the structure of the document.
3295 \begin_layout Description
3296 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3299 \begin_layout Description
3303 \begin_layout Description
3304 Origin Vermeer, 23 Mar 2006
3307 \begin_layout Subsection*
3311 \begin_layout Description
3312 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3315 \begin_layout Description
3316 Notion Part -> Chapter -> Section -> etc.
3319 \begin_layout Description
3323 \begin_layout Description
3324 Origin Vermeer, 23 Mar 2006
3327 \begin_layout Subsection*
3331 \begin_layout Description
3332 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3335 \begin_layout Description
3336 Notion Part <- Chapter <- Section <- etc.
3339 \begin_layout Description
3343 \begin_layout Description
3344 Origin Vermeer, 23 Mar 2006
3347 \begin_layout Subsection*
3351 \begin_layout Description
3352 Action Move the current group in the upward direction in the structure of the document.
3355 \begin_layout Description
3356 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3359 \begin_layout Description
3363 \begin_layout Description
3364 Origin Vermeer, 23 Mar 2006
3367 \begin_layout Subsection*
3371 \begin_layout Description
3372 Action Breaks the current paragraph at the current location.
3375 \begin_layout Description
3376 Notion Removes the selection.
3379 \begin_layout Description
3380 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3383 \begin_layout Description
3384 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3385 \begin_inset Newline newline
3388 ignoresep: Do not account for paragraph separators while breaking.
3391 \begin_layout Subsection*
3395 \begin_layout Description
3396 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3399 \begin_layout Description
3400 Syntax paragraph-down
3403 \begin_layout Description
3404 Origin Asger, 1 Oct 1996
3407 \begin_layout Subsection*
3408 paragraph-down-select
3411 \begin_layout Description
3412 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3415 \begin_layout Description
3416 Syntax paragraph-down-select
3419 \begin_layout Description
3420 Origin Asger, 1 Oct 1996
3423 \begin_layout Subsection*
3427 \begin_layout Description
3428 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.
3431 \begin_layout Description
3432 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.
3435 \begin_layout Description
3436 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3439 \begin_layout Description
3440 Params <PAR_ID>: paragraph id
3441 \begin_inset Newline newline
3444 <POS_IN_PAR>: desired position within the paragraph
3447 \begin_layout Description
3448 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3451 \begin_layout Subsection*
3455 \begin_layout Description
3456 Action Moves the current paragraph downwards in the document.
3459 \begin_layout Description
3460 Syntax paragraph-move-down
3463 \begin_layout Description
3464 Origin Edwin, 8 Apr 2006
3467 \begin_layout Subsection*
3471 \begin_layout Description
3472 Action Moves the current paragraph upwards in the document.
3475 \begin_layout Description
3476 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3479 \begin_layout Description
3480 Syntax paragraph-move-up
3483 \begin_layout Description
3484 Origin Edwin, 8 Apr 2006
3487 \begin_layout Subsection*
3491 \begin_layout Description
3492 Action Change paragraph settings.
3495 \begin_layout Description
3496 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.
3499 \begin_layout Description
3500 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3503 \begin_layout Description
3513 \begin_inset Newline newline
3518 paragraph_spacing default|single|onehalf|double|other SIZE
3519 \begin_inset Newline newline
3524 align block|left|right|center|default
3525 \begin_inset Newline newline
3530 labelwidthstring WIDTH|
3535 \begin_layout Description
3536 Origin rgh, Aug 15 2007
3539 \begin_layout Subsection*
3540 paragraph-params-apply
3543 \begin_layout Description
3544 Action Change paragraph settings.
3547 \begin_layout Description
3548 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3551 \begin_layout Description
3552 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3555 \begin_layout Description
3556 Params For parameters see LFUN_PARAGRAPH_PARAMS
3559 \begin_layout Description
3560 Origin leeming, 30 Mar 2004
3563 \begin_layout Subsection*
3567 \begin_layout Description
3568 Action Move cursor to beginning of current paragraph and select to the end in downward direction
3571 \begin_layout Description
3572 Notion This function is by default bound to triple mouse click
3575 \begin_layout Description
3576 Syntax paragraph-select
3579 \begin_layout Description
3580 Origin Kornel, 16 Apr 2019
3583 \begin_layout Subsection*
3587 \begin_layout Description
3588 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3591 \begin_layout Description
3595 \begin_layout Description
3596 Origin Asger, 1 Oct 1996
3599 \begin_layout Subsection*
3603 \begin_layout Description
3604 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3607 \begin_layout Description
3608 Syntax paragraph-up-select
3611 \begin_layout Description
3612 Origin Asger, 1 Oct 1996
3615 \begin_layout Subsection*
3619 \begin_layout Description
3620 Action Pastes material (text or picture) from the active clipboard.
3623 \begin_layout Description
3624 Syntax paste [<TYPE>|<NUM>]
3627 \begin_layout Description
3628 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3629 \begin_inset Newline newline
3632 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3635 \begin_layout Subsection*
3639 \begin_layout Description
3640 Action Inserts phantom on the current cursor position, move selection inside the inset.
3643 \begin_layout Description
3644 Syntax phantom-insert [<TYPE>]
3647 \begin_layout Description
3648 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3651 \begin_layout Description
3652 Origin uwestoehr, 30 Jan 2009
3655 \begin_layout Subsection*
3659 \begin_layout Description
3660 Action Inserts a new preview inset.
3663 \begin_layout Description
3664 Syntax preview-insert
3667 \begin_layout Description
3668 Origin vfr, 28 Mar 2010
3671 \begin_layout Subsection*
3672 primary-selection-paste
3675 \begin_layout Description
3676 Action Pastes the currently selected text.
3679 \begin_layout Description
3680 Notion Primary selection mechanism is linux-only thing.
3683 \begin_layout Description
3684 Syntax primary-selection-paste [<ARG>]
3687 \begin_layout Description
3688 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3691 \begin_layout Subsection*
3695 \begin_layout Description
3696 Action Inserts quotes according to the type and quote-language preference.
3699 \begin_layout Description
3700 Notion Currently 15 different quote styles are distinguished (see params).
3703 \begin_layout Description
3704 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3707 \begin_layout Description
3708 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
3709 \begin_inset Newline newline
3712 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
3713 \begin_inset Newline newline
3716 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3717 \begin_inset Newline newline
3720 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3721 \begin_inset Newline newline
3724 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3725 \begin_inset Newline newline
3728 'danish' for >>Danish<< quote style (with >inner quotation<)
3729 \begin_inset Newline newline
3732 'english' for ``English'' quote style (with `inner quotation')
3733 \begin_inset Newline newline
3736 'french' for <<french>> quote style (with ``inner quotation'')
3737 \begin_inset Newline newline
3740 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
3741 \begin_inset Newline newline
3744 'german' for ,,German`` quote style (with ,inner quotation`)
3745 \begin_inset Newline newline
3748 'plain' for "Plain" quote style (with 'inner quotation')
3749 \begin_inset Newline newline
3752 'polish' for ,,Polish'' quote style (with ,inner quotation')
3753 \begin_inset Newline newline
3756 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3757 \begin_inset Newline newline
3760 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
3761 \begin_inset Newline newline
3764 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3765 \begin_inset Newline newline
3768 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3769 \begin_inset Newline newline
3772 'dynamic' for Dynamic quotation marks which inherit the global document style
3773 \begin_inset Newline newline
3776 If no quote style is specified, the document-wide will be used.
3779 \begin_layout Subsection*
3783 \begin_layout Description
3784 Action Redoes the last thing undone.
3787 \begin_layout Description
3791 \begin_layout Subsection*
3795 \begin_layout Description
3796 Action Go to the next label or cross-reference.
3799 \begin_layout Description
3800 Syntax reference-next
3803 \begin_layout Description
3804 Origin Dekel, 14 Jan 2001
3807 \begin_layout Subsection*
3811 \begin_layout Description
3812 Action Repeat the given command.
3815 \begin_layout Description
3816 Notion fails when the repeat count is greater than 10000.
3819 \begin_layout Description
3820 Syntax repeat <COUNT> <LFUN-COMMAND>
3823 \begin_layout Description
3824 Origin Andre, 27 Oct 2003
3827 \begin_layout Subsection*
3831 \begin_layout Description
3832 Action Moves the cursor one page in downward direction.
3835 \begin_layout Description
3839 \begin_layout Subsection*
3843 \begin_layout Description
3844 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3847 \begin_layout Description
3848 Syntax screen-down-select
3851 \begin_layout Subsection*
3855 \begin_layout Description
3856 Action Recenters the screen on the current cursor position.
3859 \begin_layout Description
3860 Syntax screen-recenter
3863 \begin_layout Subsection*
3867 \begin_layout Description
3868 Action Repositions the screen such that the cursor is visible.
3871 \begin_layout Description
3872 Syntax screen-show-cursor
3875 \begin_layout Description
3876 Origin vfr, 25 Mar 2009
3879 \begin_layout Subsection*
3883 \begin_layout Description
3884 Action Moves the cursor one page in upward direction.
3887 \begin_layout Description
3891 \begin_layout Subsection*
3895 \begin_layout Description
3896 Action Moves the cursor one page in upward direction adding the current position to the selection.
3899 \begin_layout Description
3900 Syntax screen-up-select
3903 \begin_layout Subsection*
3907 \begin_layout Description
3908 Action Inserts a subscript or superscript inset.
3911 \begin_layout Description
3912 Syntax script-insert <TYPE>
3915 \begin_layout Description
3916 Params <TYPE>: subscript|superscript
3919 \begin_layout Description
3920 Origin Georg, 23 Nov 2010
3923 \begin_layout Subsection*
3927 \begin_layout Description
3928 Action Scroll the buffer view.
3931 \begin_layout Description
3932 Notion Only scrolls the screen up or down; does not move the cursor.
3935 \begin_layout Description
3936 Syntax scroll <TYPE> <QUANTITY>
3939 \begin_layout Description
3940 Params <TYPE>: line|page
3941 \begin_inset Newline newline
3944 <QUANTITY>: up|down|<number>
3947 \begin_layout Description
3948 Origin Abdel, Dec 27 2007
3951 \begin_layout Subsection*
3955 \begin_layout Description
3956 Action Select the whole section.
3959 \begin_layout Description
3960 Notion The cursor should be in a section heading before calling this lfun.
3963 \begin_layout Description
3964 Syntax section-select
3967 \begin_layout Description
3968 Origin vfr, 05 May 2009
3971 \begin_layout Subsection*
3975 \begin_layout Description
3976 Action Pastes the internal selection text in permanent selection.
3979 \begin_layout Description
3980 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3983 \begin_layout Description
3984 Syntax selection-paste
3987 \begin_layout Description
3988 Origin lasgouttes, 14 Jan 2009
3991 \begin_layout Subsection*
3995 \begin_layout Description
3996 Action Inserts an environment separator or latex paragraph break.
3999 \begin_layout Description
4000 Syntax separator-insert [<ARG>]
4003 \begin_layout Description
4004 Params <ARG>: <plain|parbreak|latexpar> default: plain
4007 \begin_layout Description
4008 Origin ef, 2 May 2014
4011 \begin_layout Subsection*
4015 \begin_layout Description
4016 Action Inserts one of horizontal space insets.
4019 \begin_layout Description
4020 Syntax space-insert <NAME> [<LEN>]
4023 \begin_layout Description
4024 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
4025 \begin_inset Newline newline
4028 Only in math mode: med and thick.
4029 \begin_inset Newline newline
4032 <LEN>: length for custom spaces (hspace, hspace* for protected)
4035 \begin_layout Description
4036 Origin spitz, 20 May 2003, Mar 17 2008
4039 \begin_layout Subsection*
4043 \begin_layout Description
4044 Action Inserts various characters into the document.
4047 \begin_layout Description
4048 Syntax specialchar-insert <CHAR>
4051 \begin_layout Description
4052 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
4055 \begin_layout Description
4056 Origin spitz, 6 Dec 2007
4059 \begin_layout Subsection*
4063 \begin_layout Description
4064 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4067 \begin_layout Description
4068 Syntax spelling-add [<STRING>] [<LANG>]
4071 \begin_layout Description
4072 Params <WORD>: word to add <LANG>: language name (see file languages)
4075 \begin_layout Description
4076 Origin spitz, 18 Jan 2010
4079 \begin_layout Subsection*
4080 spelling-continuously
4083 \begin_layout Description
4084 Action Toggle continuous spell checking.
4087 \begin_layout Description
4088 Syntax spelling-continuously
4091 \begin_layout Description
4092 Origin vfr, 24 March 2013
4095 \begin_layout Subsection*
4099 \begin_layout Description
4100 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.
4103 \begin_layout Description
4104 Syntax spelling-ignore [<WORD>] [<LANG>]
4107 \begin_layout Description
4108 Params <WORD>: word to ignore <LANG>: language name (see file languages)
4111 \begin_layout Description
4112 Origin spitz, 18 Jan 2010
4115 \begin_layout Subsection*
4119 \begin_layout Description
4120 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4123 \begin_layout Description
4124 Syntax spelling-remove [<STRING>] [<LANG>]
4127 \begin_layout Description
4128 Params <WORD>: word to remove <LANG>: language name (see file languages)
4131 \begin_layout Description
4132 Origin SWitt, 28 July 2010
4135 \begin_layout Subsection*
4139 \begin_layout Description
4140 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4143 \begin_layout Description
4144 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.
4147 \begin_layout Description
4151 \begin_layout Description
4152 Origin vfr, Sep 30 2008
4155 \begin_layout Subsection*
4159 \begin_layout Description
4160 Action Insert a tab into a listings inset.
4163 \begin_layout Description
4164 Notion It also works on a selection.
4167 \begin_layout Description
4171 \begin_layout Description
4172 Origin vfr, Sep 30 2008
4175 \begin_layout Subsection*
4179 \begin_layout Description
4180 Action Modify properties of tabulars and table-like math environments.
4183 \begin_layout Description
4184 Syntax tabular-feature <FEATURE> [<ARG>]
4187 \begin_layout Description
4188 Params Generally see LFUN_INSET_INSERT for further details.
4189 \begin_inset Newline newline
4192 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4193 \begin_inset Newline newline
4196 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4197 \begin_inset Newline newline
4200 set-line-top|set-line-bottom|set-line-left|set-line-right|
4201 \begin_inset Newline newline
4204 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4205 \begin_inset Newline newline
4208 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
4209 \begin_inset Newline newline
4212 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
4213 \begin_inset Newline newline
4216 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4217 \begin_inset Newline newline
4220 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4221 \begin_inset Newline newline
4224 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4225 \begin_inset Newline newline
4228 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4229 \begin_inset Newline newline
4232 reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|
4233 \begin_inset Newline newline
4236 set-longtabular|unset-longtabular|set-pwidth|
4237 \begin_inset Newline newline
4240 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4241 \begin_inset Newline newline
4244 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4245 \begin_inset Newline newline
4248 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4249 \begin_inset Newline newline
4252 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4253 \begin_inset Newline newline
4256 set-special-column|set-special-multicolumn|set-special-multirow|
4257 \begin_inset Newline newline
4260 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4261 \begin_inset Newline newline
4264 set-interline-space|set-border-lines|tabular-valign-top|
4265 \begin_inset Newline newline
4268 tabular-valign-middle|tabular-valign-bottom|set-tabular-width|
4269 \begin_inset Newline newline
4272 toggle-varwidth-column Various math-environment features are handled as well, e.g. add-vline-left/right for
4273 \begin_inset Newline newline
4276 the Grid/Array environment.
4277 \begin_inset Newline newline
4280 <ARG>: additional argument for some commands, use debug mode to explore its values.
4283 \begin_layout Description
4284 Origin gm, 10 Dec 2015
4287 \begin_layout Subsection*
4291 \begin_layout Description
4292 Action Inserts table into the document.
4295 \begin_layout Description
4296 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4299 \begin_layout Description
4300 Syntax tabular-insert [<ROWS> <COLUMNS>]
4303 \begin_layout Description
4304 Params In case no arguments are given show insert dialog.
4307 \begin_layout Description
4308 Origin Jug, 12 Apr 2000
4311 \begin_layout Subsection*
4312 tabular-style-insert
4315 \begin_layout Description
4316 Action Inserts table of a given style into the document.
4319 \begin_layout Description
4320 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4323 \begin_layout Description
4324 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
4327 \begin_layout Description
4328 Params Valid styles are the names of the files in lib/tabletemplates, minus _1x<n> and .lyx suffix.
4331 \begin_layout Description
4332 Origin spitz, 25 Mar 2019
4335 \begin_layout Subsection*
4339 \begin_layout Description
4340 Action Look up thesaurus entries with respect to the word under the cursor.
4343 \begin_layout Description
4344 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4347 \begin_layout Description
4348 Params <STRING>: word to look up <LANG>: language (see file languages)
4351 \begin_layout Description
4352 Origin Levon, 20 Jul 2001
4355 \begin_layout Subsection*
4359 \begin_layout Description
4360 Action Undoes the last edit.
4363 \begin_layout Description
4367 \begin_layout Subsection*
4371 \begin_layout Description
4372 Action Inserts a single unicode character.
4375 \begin_layout Description
4376 Syntax unicode-insert <CHAR1> <CHAR2> ...
4379 \begin_layout Description
4380 Params <CHARn>: The character to insert, given as its code point, in hexadecimal.
4383 \begin_layout Description
4384 Sample unicode-insert 0x0100 0x0259
4387 \begin_layout Description
4388 Origin Lgb, 22 Oct 2006
4391 \begin_layout Subsection*
4395 \begin_layout Description
4396 Action Moves the cursor one line in upward direction.
4399 \begin_layout Description
4403 \begin_layout Subsection*
4407 \begin_layout Description
4408 Action Moves the cursor one line in upward direction adding the current position to the selection.
4411 \begin_layout Description
4415 \begin_layout Subsection*
4419 \begin_layout Description
4420 Action Moves the cursor to the logically previous beginning of a word.
4423 \begin_layout Description
4424 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.
4427 \begin_layout Description
4428 Syntax word-backward
4431 \begin_layout Subsection*
4432 word-backward-select
4435 \begin_layout Description
4436 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4439 \begin_layout Description
4440 Notion See also LFUN_WORD_BACKWARD.
4443 \begin_layout Description
4444 Syntax word-backward-select
4447 \begin_layout Subsection*
4451 \begin_layout Description
4452 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4455 \begin_layout Description
4456 Syntax word-capitalize [<SEL_TYPE>]
4459 \begin_layout Description
4460 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.
4463 \begin_layout Subsection*
4464 word-delete-backward
4467 \begin_layout Description
4468 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4471 \begin_layout Description
4472 Syntax word-delete-backward [force]
4475 \begin_layout Description
4476 Params force: Delete big insets, do not only select them.
4479 \begin_layout Subsection*
4483 \begin_layout Description
4484 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4487 \begin_layout Description
4488 Syntax word-delete-forward [force]
4491 \begin_layout Description
4492 Params force: Delete big insets, do not only select them.
4495 \begin_layout Subsection*
4499 \begin_layout Description
4500 Action Search for next occurrence of a string.
4503 \begin_layout Description
4504 Syntax word-find [<DATA>]
4507 \begin_layout Description
4508 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).
4511 \begin_layout Description
4512 Origin Andre, Jan 7 2004
4515 \begin_layout Subsection*
4519 \begin_layout Description
4520 Action Search for a given string in backward direction.
4523 \begin_layout Description
4524 Notion Case sensitive, match words. If no argument given, last search repeated.
4527 \begin_layout Description
4528 Syntax word-find-backward [<STRING>]
4531 \begin_layout Description
4532 Origin Etienne, 20 Feb 1998
4535 \begin_layout Subsection*
4539 \begin_layout Description
4540 Action Search for a given string in forward direction.
4543 \begin_layout Description
4544 Notion Case sensitive, match words. If no argument given, last search repeated.
4547 \begin_layout Description
4548 Syntax word-find-forward [<STRING>]
4551 \begin_layout Description
4552 Origin Etienne, 16 Feb 1998
4555 \begin_layout Subsection*
4559 \begin_layout Description
4560 Action Search for next occurrence of a pattern.
4563 \begin_layout Description
4564 Syntax word-findadv [<DATA>]
4567 \begin_layout Description
4568 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).
4571 \begin_layout Description
4572 Origin Tommaso, Nov 15 2007
4575 \begin_layout Subsection*
4579 \begin_layout Description
4580 Action Moves the cursor to the logically next beginning of a word.
4583 \begin_layout Description
4584 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.
4587 \begin_layout Description
4591 \begin_layout Subsection*
4595 \begin_layout Description
4596 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4599 \begin_layout Description
4600 Notion See also LFUN_WORD_FORWARD.
4603 \begin_layout Description
4604 Syntax word-forward-select
4607 \begin_layout Subsection*
4611 \begin_layout Description
4612 Action Moves the cursor to the next beginning of a word "on the left".
4615 \begin_layout Description
4616 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.
4619 \begin_layout Description
4623 \begin_layout Description
4624 Origin dov, 28 Oct 2007
4627 \begin_layout Subsection*
4631 \begin_layout Description
4632 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4635 \begin_layout Description
4636 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4639 \begin_layout Description
4640 Syntax word-left-select
4643 \begin_layout Description
4644 Origin dov, 28 Oct 2007
4647 \begin_layout Subsection*
4651 \begin_layout Description
4652 Action Change the words in the selection or word at cursor position to lower case.
4655 \begin_layout Description
4656 Syntax word-lowcase [<SEL_TYPE>]
4659 \begin_layout Description
4660 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.
4663 \begin_layout Subsection*
4667 \begin_layout Description
4668 Action Replace a string in the document.
4671 \begin_layout Description
4672 Syntax word-replace [<DATA>]
4675 \begin_layout Description
4676 Params <DATA>: data is of the form "<replacestring>
4677 \begin_inset Newline newline
4681 \begin_inset Newline newline
4684 <casesensitive> <matchword> <all> <forward> <findnext>"
4687 \begin_layout Description
4688 Origin Andre, Jan 7 2004
4691 \begin_layout Subsection*
4695 \begin_layout Description
4696 Action Moves the cursor to the next beginning of a word "on the right".
4699 \begin_layout Description
4700 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.
4703 \begin_layout Description
4707 \begin_layout Description
4708 Origin dov, 28 Oct 2007
4711 \begin_layout Subsection*
4715 \begin_layout Description
4716 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4719 \begin_layout Description
4720 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4723 \begin_layout Description
4724 Syntax word-right-select
4727 \begin_layout Description
4728 Origin dov, 28 Oct 2007
4731 \begin_layout Subsection*
4735 \begin_layout Description
4736 Action Puts the word where the cursor stands into the selection.
4739 \begin_layout Description
4743 \begin_layout Description
4744 Origin Andre, 11 Sep 2002
4747 \begin_layout Subsection*
4751 \begin_layout Description
4752 Action Change the words in the selection or word at cursor position to upper case.
4755 \begin_layout Description
4756 Syntax word-upcase [<SEL_TYPE>]
4759 \begin_layout Description
4760 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.
4763 \begin_layout Subsection*
4767 \begin_layout Description
4768 Action Inserts floats wrapped by the text around.
4771 \begin_layout Description
4772 Syntax wrap-insert <TYPE>
4775 \begin_layout Description
4776 Params <TYPE>: table|figure
4779 \begin_layout Description
4780 Origin Dekel, 7 Apr 2002
4783 \begin_layout Section
4784 Math Editor Functions
4787 \begin_layout Subsection*
4788 in-mathmacrotemplate
4791 \begin_layout Description
4792 Action Only active in Math Macro definition.
4795 \begin_layout Description
4796 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.
4799 \begin_layout Description
4800 Syntax in-mathmacrotemplate
4803 \begin_layout Description
4804 Origin sts, 06 January 2008
4807 \begin_layout Subsection*
4811 \begin_layout Description
4812 Action Inserts an extended matrix as provided by the amsmath package.
4815 \begin_layout Description
4816 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4819 \begin_layout Description
4820 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'.
4823 \begin_layout Description
4824 Sample math-ams-matrix 3 3 bmatrix
4827 \begin_layout Subsection*
4831 \begin_layout Description
4832 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4835 \begin_layout Description
4836 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4839 \begin_layout Description
4840 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4841 \begin_inset Newline newline
4844 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4847 \begin_layout Description
4848 Sample math-bigdelim "Bigl" "
4855 \begin_layout Description
4856 Origin Enrico & Georg, 7 May 2006
4859 \begin_layout Subsection*
4863 \begin_layout Description
4864 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4867 \begin_layout Description
4868 Syntax math-delim [<LEFT>] [<RIGHT>]
4871 \begin_layout Description
4872 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.
4875 \begin_layout Description
4876 Sample math-delim { rangle
4879 \begin_layout Description
4880 Origin Alejandro, 18 Jun 1996
4883 \begin_layout Subsection*
4887 \begin_layout Description
4888 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4891 \begin_layout Description
4892 Syntax math-display [<ARG>]
4895 \begin_layout Description
4896 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4899 \begin_layout Description
4900 Origin Alejandro, 18 Jun 1996
4903 \begin_layout Subsection*
4907 \begin_layout Description
4908 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4911 \begin_layout Description
4912 Notion Selection can be used to determine the input for the external program.
4915 \begin_layout Description
4916 Syntax math-extern <LANG> [<COMMAND>]
4919 \begin_layout Description
4920 Params <LANG>: octave|maxima|maple|mathematica|script
4921 \begin_inset Newline newline
4924 where "script" stands for the external script (normalized expression will be passed)
4927 \begin_layout Description
4928 Sample math-extern maple simplify
4931 \begin_layout Description
4932 Origin Andre, 24 Apr 2001
4935 \begin_layout Subsection*
4939 \begin_layout Description
4940 Action Changes the text style used in math.
4943 \begin_layout Description
4944 Syntax math-font-style <STYLE>
4947 \begin_layout Description
4948 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4949 \begin_inset Newline newline
4952 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4955 \begin_layout Description
4956 Origin vfr, 9 jan 2009
4959 \begin_layout Subsection*
4963 \begin_layout Description
4964 Action Inserts math objects and symbols.
4967 \begin_layout Description
4968 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4970 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
4972 frac{x}{y}" replaces "abc" with "
4974 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.
4977 \begin_layout Description
4978 Syntax math-insert <ARG>
4981 \begin_layout Description
4982 Params <ARG>: Symbol or LaTeX code to be inserted.
4985 \begin_layout Subsection*
4989 \begin_layout Description
4990 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.
4993 \begin_layout Description
4994 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4997 \begin_layout Description
4998 Syntax math-limits [<STATE>]
5001 \begin_layout Description
5002 Params <STATE>: limits|nolimits
5005 \begin_layout Subsection*
5009 \begin_layout Description
5010 Action Inserts a math macro definition at the cursor position in the text.
5013 \begin_layout Description
5014 Syntax math-macro <NAME> [<NARGS>] [def]
5017 \begin_layout Description
5018 Params <NAME>: The name of the macro, e.g. "mymacro".
5019 \begin_inset Newline newline
5022 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
5025 \begin_layout Description
5026 Origin ale, 10 May 1997; sts, 21 Dec 2007
5029 \begin_layout Subsection*
5030 math-macro-add-greedy-optional-param
5033 \begin_layout Description
5034 Action Add a greedy optional parameter.
5037 \begin_layout Description
5038 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
5041 \begin_layout Description
5042 Syntax math-macro-add-greedy-optional-param
5045 \begin_layout Description
5046 Origin sts, 06 January 2008
5049 \begin_layout Subsection*
5050 math-macro-add-optional-param
5053 \begin_layout Description
5054 Action Add an optional parameter.
5057 \begin_layout Description
5058 Notion Insert an optional parameter just behind the already existing optional parameters.
5061 \begin_layout Description
5062 Syntax math-macro-add-optional-param
5065 \begin_layout Description
5066 Origin sts, 06 January 2008
5069 \begin_layout Subsection*
5070 math-macro-add-param
5073 \begin_layout Description
5074 Action Add a parameter.
5077 \begin_layout Description
5078 Notion Add a parameter to a Math Macro.
5081 \begin_layout Description
5082 Syntax math-macro-add-param <NUM>
5085 \begin_layout Description
5086 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.
5089 \begin_layout Description
5090 Origin sts, 06 January 2008
5093 \begin_layout Subsection*
5094 math-macro-append-greedy-param
5097 \begin_layout Description
5098 Action Append a greedy parameter.
5101 \begin_layout Description
5102 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
5105 \begin_layout Description
5106 Syntax math-macro-append-greedy-param
5109 \begin_layout Description
5110 Origin sts, 06 January 2008
5113 \begin_layout Subsection*
5117 \begin_layout Description
5118 Action Fold a Math Macro.
5121 \begin_layout Description
5122 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
5127 \begin_layout Description
5128 Syntax math-macro-fold
5131 \begin_layout Description
5132 Origin sts, 06 January 2008
5135 \begin_layout Subsection*
5136 math-macro-make-nonoptional
5139 \begin_layout Description
5140 Action Make a parameter non-optional.
5143 \begin_layout Description
5144 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.
5147 \begin_layout Description
5148 Syntax math-macro-make-nonoptional
5151 \begin_layout Description
5152 Origin sts, 06 January 2008
5155 \begin_layout Subsection*
5156 math-macro-make-optional
5159 \begin_layout Description
5160 Action Make a parameter optional.
5163 \begin_layout Description
5164 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
5167 \begin_layout Description
5168 Syntax math-macro-make-optional
5171 \begin_layout Description
5172 Origin sts, 06 January 2008
5175 \begin_layout Subsection*
5176 math-macro-remove-greedy-param
5179 \begin_layout Description
5180 Action Remove a greedy parameter.
5183 \begin_layout Description
5184 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.
5187 \begin_layout Description
5188 Syntax math-macro-remove-greedy-param
5191 \begin_layout Description
5192 Origin sts, 06 January 2008
5195 \begin_layout Subsection*
5196 math-macro-remove-optional-param
5199 \begin_layout Description
5200 Action Remove the last optional parameter.
5203 \begin_layout Description
5204 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
5207 \begin_layout Description
5208 Syntax math-macro-remove-optional-param
5211 \begin_layout Description
5212 Origin sts, 06 January 2008
5215 \begin_layout Subsection*
5216 math-macro-remove-param
5219 \begin_layout Description
5220 Action Remove the last parameter.
5223 \begin_layout Description
5224 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
5227 \begin_layout Description
5228 Syntax math-macro-remove-param <NUM>
5231 \begin_layout Description
5232 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
5235 \begin_layout Description
5236 Origin sts, 06 January 2008
5239 \begin_layout Subsection*
5243 \begin_layout Description
5244 Action Unfold a Math Macro.
5247 \begin_layout Description
5248 Notion Unfold the Math Macro the cursor is in, i.e. display it as
5253 \begin_layout Description
5254 Syntax math-macro-unfold
5257 \begin_layout Description
5258 Origin sts, 06 January 2008
5261 \begin_layout Subsection*
5265 \begin_layout Description
5266 Action Inserts a matrix.
5269 \begin_layout Description
5270 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5273 \begin_layout Description
5274 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).
5277 \begin_layout Description
5278 Sample math-matrix 3 3 bccc
5281 \begin_layout Subsection*
5285 \begin_layout Description
5286 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.
5289 \begin_layout Description
5290 Notion If there is some selected text, it puts the text inside created math box.
5293 \begin_layout Description
5294 Syntax math-mode [on|<ARG>]
5297 \begin_layout Description
5298 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
5299 \begin_inset Newline newline
5302 "on": allow only entering of math mode from text mode.
5305 \begin_layout Description
5306 Origin Alejandro, 4 Jun 1996
5309 \begin_layout Subsection*
5313 \begin_layout Description
5314 Action Mutates the type of math inset to the newly selected one.
5317 \begin_layout Description
5318 Syntax math-mutate <TYPE>
5321 \begin_layout Description
5322 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
5325 \begin_layout Description
5326 Origin Andre, 23 May 2001
5329 \begin_layout Subsection*
5330 math-number-line-toggle
5333 \begin_layout Description
5334 Action Toggles numbering of the current formula line.
5337 \begin_layout Description
5338 Notion Must be in display formula mode.
5341 \begin_layout Description
5342 Syntax math-number-line-toggle
5345 \begin_layout Description
5346 Origin Alejandro, 18 Jun 1996
5349 \begin_layout Subsection*
5353 \begin_layout Description
5354 Action Toggles numbering/labeling of the current formula.
5357 \begin_layout Description
5358 Notion Must be in display formula mode.
5361 \begin_layout Description
5362 Syntax math-number-toggle
5365 \begin_layout Description
5366 Origin Alejandro, 4 Jun 1996
5369 \begin_layout Subsection*
5373 \begin_layout Description
5374 Action Changes arbitrarily the size used by math fonts inside a context.
5377 \begin_layout Description
5378 Notion Provides an interface to the LaTeX math mode font size commands.
5381 \begin_layout Description
5382 Syntax math-size <STYLE>
5385 \begin_layout Description
5397 \begin_layout Description
5398 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5401 \begin_layout Subsection*
5405 \begin_layout Description
5406 Action Inserts space into math expression.
5409 \begin_layout Description
5410 Notion Use spacebar after entering this space to change type of space.
5413 \begin_layout Description
5414 Syntax math-space [<TYPE>] [<LEN>]
5417 \begin_layout Description
5418 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5419 \begin_inset Newline newline
5422 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5423 \begin_inset Newline newline
5426 custom space: hspace
5427 \begin_inset Newline newline
5430 "," used by default.
5431 \begin_inset Newline newline
5434 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5435 \begin_inset Newline newline
5438 <LEN>: length for custom spaces (hspace)
5441 \begin_layout Description
5442 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5445 \begin_layout Subsection*
5449 \begin_layout Description
5450 Action Enters subscript expression in math expression.
5453 \begin_layout Description
5454 Syntax math-subscript
5457 \begin_layout Description
5458 Origin vermeer, 12 Dec 2001
5461 \begin_layout Subsection*
5465 \begin_layout Description
5466 Action Enters superscript expression in math expression.
5469 \begin_layout Description
5470 Syntax math-superscript
5473 \begin_layout Description
5474 Origin vermeer, 12 Dec 2001
5477 \begin_layout Subsection*
5481 \begin_layout Description
5482 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5485 \begin_layout Description
5486 Notion If there is any selected text, then it is moved inside the created regexp inset.
5489 \begin_layout Description
5490 Syntax regexp-mode [<ARG>]
5493 \begin_layout Description
5494 Params <ARG>: eventual argument (regular expression).
5497 \begin_layout Description
5498 Origin Tommaso, 4 Oct 2008
5501 \begin_layout Section
5502 Buffer Fuctions (File and Window related)
5505 \begin_layout Subsection*
5509 \begin_layout Description
5510 Action Activate the branch.
5513 \begin_layout Description
5514 Syntax branch-activate <BRANCH>
5517 \begin_layout Description
5518 Params <BRANCH>: The branch to activate
5521 \begin_layout Description
5522 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5523 \begin_inset Newline newline
5526 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5529 \begin_layout Description
5530 Origin rgh, 27 May 2008
5533 \begin_layout Subsection*
5537 \begin_layout Description
5538 Action Add a branch to the buffer's BranchList.
5541 \begin_layout Description
5542 Syntax branch-add <BRANCH>
5545 \begin_layout Description
5546 Params <BRANCH>: Name of the branch to add
5549 \begin_layout Description
5550 Origin spitz, 7 Jul 2009
5553 \begin_layout Subsection*
5557 \begin_layout Description
5558 Action Create new branch and directly put the branch inset into the document.
5561 \begin_layout Description
5562 Syntax branch-add-insert [<NAME>]
5565 \begin_layout Description
5566 Params <NAME>: Branch name. If it is not specified, you will be asked.
5569 \begin_layout Description
5570 Origin sanda, 10 Jul 2009
5573 \begin_layout Subsection*
5577 \begin_layout Description
5578 Action De-activate the branch.
5581 \begin_layout Description
5582 Syntax branch-deactivate <BRANCH>
5585 \begin_layout Description
5586 Params <BRANCH>: The branch to deactivate
5589 \begin_layout Description
5590 Origin rgh, 27 May 2008
5593 \begin_layout Subsection*
5597 \begin_layout Description
5598 Action Toggles inversion status of branch inset.
5601 \begin_layout Description
5602 Syntax branch-invert
5605 \begin_layout Description
5606 Origin rgheck, 12 July 2016
5609 \begin_layout Subsection*
5610 branch-master-activate
5613 \begin_layout Description
5614 Action Activate the branch in the master buffer.
5617 \begin_layout Description
5618 Syntax branch-master-activate <BRANCH>
5621 \begin_layout Description
5622 Params <BRANCH>: The branch to activate
5625 \begin_layout Description
5626 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5627 \begin_inset Newline newline
5630 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5633 \begin_layout Description
5634 Origin spitz, 30 Sep 2012
5637 \begin_layout Subsection*
5638 branch-master-deactivate
5641 \begin_layout Description
5642 Action De-activate the branch in the master buffer.
5645 \begin_layout Description
5646 Syntax branch-master-deactivate <BRANCH>
5649 \begin_layout Description
5650 Params <BRANCH>: The branch to deactivate
5653 \begin_layout Description
5654 Origin spitz, 30 Sep 2012
5657 \begin_layout Subsection*
5661 \begin_layout Description
5662 Action Rename all branches of a given name in a document.
5665 \begin_layout Description
5666 Syntax branches-rename <OLDNAME> <NEWNAME>
5669 \begin_layout Description
5670 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5673 \begin_layout Description
5674 Origin spitz, 9 Jul 2009
5677 \begin_layout Subsection*
5681 \begin_layout Description
5682 Action Saves the current buffer to a temporary file.
5685 \begin_layout Description
5686 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5689 \begin_layout Description
5690 Syntax buffer-auto-save
5693 \begin_layout Subsection*
5697 \begin_layout Description
5698 Action Loads the given child document.
5701 \begin_layout Description
5702 Notion The current document is treated as a parent.
5705 \begin_layout Description
5706 Syntax buffer-child-open <FILE>
5709 \begin_layout Description
5710 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5713 \begin_layout Description
5714 Origin Ale, 28 May 1997
5717 \begin_layout Subsection*
5721 \begin_layout Description
5722 Action Runs chktex for the current document.
5725 \begin_layout Description
5726 Syntax buffer-chktex
5729 \begin_layout Description
5730 Origin Asger, 30 Oct 1997
5733 \begin_layout Subsection*
5737 \begin_layout Description
5738 Action Closes the current buffer.
5741 \begin_layout Description
5742 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5745 \begin_layout Description
5749 \begin_layout Subsection*
5753 \begin_layout Description
5754 Action Closes all buffers.
5757 \begin_layout Description
5758 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5761 \begin_layout Description
5762 Syntax buffer-close-all
5765 \begin_layout Subsection*
5769 \begin_layout Description
5770 Action Exports the current buffer (document) to the given format.
5773 \begin_layout Description
5774 Syntax buffer-export [<FORMAT>] [<DEST>]
5777 \begin_layout Description
5778 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.
5779 \begin_inset Newline newline
5782 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.
5783 \begin_inset Newline newline
5786 If absent or "default", then the default output format of the document is used.
5787 \begin_inset Newline newline
5790 <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.
5793 \begin_layout Description
5794 Origin Lgb, 29 Jul 1997
5797 \begin_layout Subsection*
5801 \begin_layout Description
5802 Action Opens a dialog for exporting the current buffer.
5805 \begin_layout Description
5806 Syntax buffer-export-as [<FORMAT>]
5809 \begin_layout Description
5810 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.
5813 \begin_layout Description
5814 Sample buffer-export-as pdf2
5817 \begin_layout Description
5818 Origin tommaso, 6 Oct 2011
5821 \begin_layout Subsection*
5822 buffer-export-custom
5825 \begin_layout Description
5826 Action Exports the current buffer (document) from the given format using the given command on it.
5829 \begin_layout Description
5830 Syntax buffer-export-custom <FORMAT> <COMMAND>
5833 \begin_layout Description
5834 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5835 \begin_inset Newline newline
5838 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5841 \begin_layout Description
5842 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5845 \begin_layout Description
5846 Origin leeming, 27 Mar 2004
5849 \begin_layout Subsection*
5850 buffer-external-modification-clear
5853 \begin_layout Description
5854 Action Clear the external modification flag on the current buffer.
5857 \begin_layout Description
5858 Syntax buffer-external-modification-clear
5861 \begin_layout Description
5862 Origin gm, 2 March 2017
5865 \begin_layout Subsection*
5869 \begin_layout Description
5870 Action Applies a command to all non-hidden buffers.
5873 \begin_layout Description
5874 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5877 \begin_layout Description
5878 Syntax buffer-forall <LFUN-COMMAND>
5881 \begin_layout Description
5882 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5885 \begin_layout Description
5886 Sample Close all Notes in buffers:
5887 \begin_inset Newline newline
5890 buffer-forall inset-forall Note inset-toggle close
5891 \begin_inset Newline newline
5894 Toggle change tracking on buffers:
5895 \begin_inset Newline newline
5898 buffer-forall changes-track
5899 \begin_inset Newline newline
5902 Toggle read-only for buffers:
5903 \begin_inset Newline newline
5906 buffer-forall buffer-toggle-read-only
5907 \begin_inset Newline newline
5910 Show statistics for individual buffers:
5911 \begin_inset Newline newline
5914 buffer-forall statistics
5915 \begin_inset Newline newline
5918 Activate the branch named "Solutions" in buffers:
5919 \begin_inset Newline newline
5922 buffer-forall branch-activate Solutions
5923 \begin_inset Newline newline
5926 Export buffers to PDF (pdflatex):
5927 \begin_inset Newline newline
5930 buffer-forall buffer-export pdf2
5931 \begin_inset Newline newline
5937 \begin_layout Description
5938 Origin skostysh, 20 Jul 2012
5941 \begin_layout Subsection*
5945 \begin_layout Description
5946 Action Import a given file as a lyx document.
5949 \begin_layout Description
5950 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.
5953 \begin_layout Description
5954 Syntax buffer-import <FORMAT> [<FILE>]
5957 \begin_layout Description
5958 Origin Asger, 24 Jul 1998
5961 \begin_layout Subsection*
5965 \begin_layout Description
5966 Action Set language of the current document.
5969 \begin_layout Description
5970 Syntax buffer-language <LANG>
5973 \begin_layout Description
5974 Params <LANG>: language name. See lib/languages for list.
5977 \begin_layout Description
5978 Origin leeming, 30 Mar 2004
5981 \begin_layout Subsection*
5985 \begin_layout Description
5986 Action Moves the current tab one spot to the right.
5989 \begin_layout Description
5990 Syntax buffer-move-next
5993 \begin_layout Description
5994 Origin skostysh, 7 Apr 2015
5997 \begin_layout Subsection*
5998 buffer-move-previous
6001 \begin_layout Description
6002 Action Moves the current tab one spot to the left.
6005 \begin_layout Description
6006 Syntax buffer-move-previous
6009 \begin_layout Description
6010 Origin skostysh, 7 Apr 2015
6013 \begin_layout Subsection*
6017 \begin_layout Description
6018 Action Creates a new buffer (that is, document) and switches to it.
6021 \begin_layout Description
6022 Notion Implicit path can be set in Preferences dialog.
6025 \begin_layout Description
6026 Syntax buffer-new [<FILE>]
6029 \begin_layout Description
6030 Params <FILE>: filename of created file with absolute path.
6033 \begin_layout Subsection*
6037 \begin_layout Description
6038 Action Creates a new buffer (that is, document) from a template.
6041 \begin_layout Description
6042 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
6045 \begin_layout Description
6046 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
6049 \begin_layout Description
6050 Params <FILE>: filename of created file with absolute path. If empty or "newfile", a file with appropriate name is generated. <TEMPLATE FILE>: filename of template with absolute path. If empty, a dialog is opened to select the new file.
6053 \begin_layout Subsection*
6057 \begin_layout Description
6058 Action Switch to the next opened document.
6061 \begin_layout Description
6062 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
6065 \begin_layout Description
6069 \begin_layout Subsection*
6073 \begin_layout Description
6074 Action Apply the given settings to the current document.
6077 \begin_layout Description
6078 Syntax buffer-params-apply [<ARGS>]
6081 \begin_layout Description
6082 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6085 \begin_layout Description
6086 Origin leeming, 30 Mar 2004
6089 \begin_layout Subsection*
6093 \begin_layout Description
6094 Action Switch to the previous opened document.
6097 \begin_layout Description
6098 Syntax buffer-previous
6101 \begin_layout Subsection*
6105 \begin_layout Description
6106 Action Reverts opened document.
6109 \begin_layout Description
6110 Syntax buffer-reload [dump]
6113 \begin_layout Description
6114 Params dump: do not ask for any confirmation, just reload. All changes will be lost.
6117 \begin_layout Description
6118 Origin Asger, 2 Feb 1997
6121 \begin_layout Subsection*
6125 \begin_layout Description
6126 Action Removes the auxiliary file before next export to assure export is done afresh.
6129 \begin_layout Description
6130 Syntax buffer-reset-export
6133 \begin_layout Description
6134 Origin spitz, 27 Dec 2019
6137 \begin_layout Subsection*
6138 buffer-save-as-default
6141 \begin_layout Description
6142 Action Save the current document settings as default.
6145 \begin_layout Description
6146 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6149 \begin_layout Description
6150 Syntax buffer-save-as-default [<ARGS>]
6153 \begin_layout Description
6154 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6157 \begin_layout Description
6158 Origin leeming, 30 Mar 2004
6161 \begin_layout Subsection*
6165 \begin_layout Description
6166 Action Display and switch to the given buffer.
6169 \begin_layout Description
6170 Syntax buffer-switch <BUFFER>
6173 \begin_layout Description
6174 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
6177 \begin_layout Subsection*
6178 buffer-toggle-compression
6181 \begin_layout Description
6182 Action Toggles compression of the current document on/off.
6185 \begin_layout Description
6186 Syntax buffer-toggle-compression
6189 \begin_layout Description
6190 Origin bpeng, 27 Apr 2006
6193 \begin_layout Subsection*
6194 buffer-toggle-read-only
6197 \begin_layout Description
6198 Action Toggle editing mode of the current document between read/write and read-only.
6201 \begin_layout Description
6202 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.
6205 \begin_layout Description
6206 Syntax buffer-toggle-read-only
6209 \begin_layout Description
6210 Origin Lgb, 27 May 1997
6213 \begin_layout Subsection*
6217 \begin_layout Description
6218 Action Exports the current document and put the result into the temporary directory.
6221 \begin_layout Description
6222 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).
6225 \begin_layout Description
6226 Syntax buffer-update [<FORMAT>]
6229 \begin_layout Description
6230 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.
6233 \begin_layout Description
6234 Origin Dekel, 5 Aug 2000
6237 \begin_layout Subsection*
6241 \begin_layout Description
6242 Action Displays current buffer in chosen format.
6245 \begin_layout Description
6246 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.
6249 \begin_layout Description
6250 Syntax buffer-view [<FORMAT>]
6253 \begin_layout Description
6254 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.
6257 \begin_layout Subsection*
6261 \begin_layout Description
6262 Action Opens the file that was created from last preview of this buffer.
6265 \begin_layout Description
6266 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.
6269 \begin_layout Description
6270 Syntax buffer-view-cache
6273 \begin_layout Subsection*
6277 \begin_layout Description
6278 Action Saves the current buffer.
6281 \begin_layout Description
6282 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.
6285 \begin_layout Description
6286 Syntax buffer-write [force]
6289 \begin_layout Description
6290 Params force: write even if buffer is clean.
6293 \begin_layout Subsection*
6297 \begin_layout Description
6298 Action Save all changed documents.
6301 \begin_layout Description
6302 Syntax buffer-write-all
6305 \begin_layout Description
6306 Origin rgh, gpothier 6 Aug 2007
6309 \begin_layout Subsection*
6313 \begin_layout Description
6314 Action Rename and save current buffer.
6317 \begin_layout Description
6318 Syntax buffer-write-as <FILENAME>
6321 \begin_layout Description
6322 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6325 \begin_layout Subsection*
6326 buffer-write-as-template
6329 \begin_layout Description
6330 Action Rename and save current buffer in the local templates directory.
6333 \begin_layout Description
6334 Syntax buffer-write-as-template <FILENAME>
6337 \begin_layout Description
6338 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6341 \begin_layout Subsection*
6345 \begin_layout Description
6346 Action Sets the zoom of the screen fonts.
6349 \begin_layout Description
6350 Syntax buffer-zoom [<ZOOM>]
6353 \begin_layout Description
6354 Params <ZOOM>: The target zoom value in %; the default is the default zoom as saved in preferences.
6357 \begin_layout Description
6358 Origin daniel, 28 Oct 2016
6361 \begin_layout Subsection*
6365 \begin_layout Description
6366 Action Increases the zoom of the screen fonts.
6369 \begin_layout Description
6370 Syntax buffer-zoom-in [<ZOOM>]
6373 \begin_layout Description
6374 Params <ZOOM>: The zoom value addition in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6377 \begin_layout Description
6378 Origin vfr, 30 Mar 2009
6381 \begin_layout Subsection*
6385 \begin_layout Description
6386 Action Decreases the zoom of the screen fonts.
6389 \begin_layout Description
6390 Syntax buffer-zoom-out [<ZOOM>]
6393 \begin_layout Description
6394 Params <ZOOM>: The zoom value abstraction in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6397 \begin_layout Description
6398 Origin vfr, 30 Mar 2009
6401 \begin_layout Subsection*
6405 \begin_layout Description
6406 Action Generates the code (literate programming).
6409 \begin_layout Description
6410 Notion Latex file with extension
6412 literate_extension is generated. Then LyX invokes
6414 build_command (with a default of ``make'') to generate the code and
6416 build_error_filter to process the compilation error messages.
6417 \begin_inset Newline newline
6420 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:
6421 \begin_inset Newline newline
6426 build_command "my_script my_arguments"
6427 \begin_inset Newline newline
6432 build_error_filter differs from the
6434 literate_error_filter only in that the former will identify error messages from your compiler.
6437 \begin_layout Description
6438 Syntax build-program
6441 \begin_layout Subsection*
6445 \begin_layout Description
6446 Action Open LyX document.
6449 \begin_layout Description
6450 Syntax file-open [<FILE>]
6453 \begin_layout Description
6454 Params <FILE>: Filename to be opened.
6457 \begin_layout Subsection*
6461 \begin_layout Description
6462 Action Open the given help file according to the language setting.
6465 \begin_layout Description
6466 Syntax help-open <FILE>[.lyx]
6469 \begin_layout Description
6470 Params <FILE>: any document from (/usr/share/)doc directory.
6473 \begin_layout Description
6474 Origin Jug, 27 Jun 1999
6477 \begin_layout Subsection*
6481 \begin_layout Description
6482 Action Sets icon size of toolbars.
6485 \begin_layout Description
6486 Syntax icon-size [<SIZE>]
6489 \begin_layout Description
6490 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).
6493 \begin_layout Description
6497 \begin_layout Subsection*
6501 \begin_layout Description
6502 Action Helper function for master-related actions
6505 \begin_layout Description
6506 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
6509 \begin_layout Description
6510 Syntax ifrelatives <ACTION>
6513 \begin_layout Description
6514 Origin spitz, 2 January 2020
6517 \begin_layout Subsection*
6521 \begin_layout Description
6522 Action Terminates the current LyX instance.
6525 \begin_layout Description
6526 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6529 \begin_layout Description
6533 \begin_layout Subsection*
6534 master-buffer-export
6537 \begin_layout Description
6538 Action Exports the master buffer (document) to the given format.
6541 \begin_layout Description
6542 Syntax master-buffer-export [<FORMAT>] [<DEST>]
6545 \begin_layout Description
6546 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.
6547 \begin_inset Newline newline
6550 Note that "custom" is not allowed in this case.
6551 \begin_inset Newline newline
6554 If absent or "default", then the default output format of the document is used.
6555 \begin_inset Newline newline
6558 <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.
6561 \begin_layout Description
6562 Origin rkh, 18 April 2018
6565 \begin_layout Subsection*
6566 master-buffer-forall
6569 \begin_layout Description
6570 Action Applies a command to a buffer and all it children, starting from the master.
6573 \begin_layout Description
6574 Syntax master-buffer-forall <LFUN-COMMAND>
6577 \begin_layout Description
6578 Params <LFUN-COMMAND>: The command to be applied to the buffers.
6581 \begin_layout Description
6582 Sample Close all Notes in buffers:
6583 \begin_inset Newline newline
6586 master-buffer-forall inset-forall Note inset-toggle close
6587 \begin_inset Newline newline
6590 Toggle change tracking on buffers:
6591 \begin_inset Newline newline
6594 master-buffer-forall changes-track
6595 \begin_inset Newline newline
6598 Toggle read-only for buffers:
6599 \begin_inset Newline newline
6602 master-buffer-forall buffer-toggle-read-only
6603 \begin_inset Newline newline
6606 Show statistics for individual buffers:
6607 \begin_inset Newline newline
6610 master-buffer-forall statistics
6611 \begin_inset Newline newline
6614 Activate the branch named "Solutions" in buffers:
6615 \begin_inset Newline newline
6618 master-buffer-forall branch-activate Solutions
6619 \begin_inset Newline newline
6625 \begin_layout Description
6626 Origin spitz, 31 Dec 2019
6629 \begin_layout Subsection*
6630 master-buffer-update
6633 \begin_layout Description
6634 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6637 \begin_layout Description
6638 Syntax master-buffer-update [<FORMAT>]
6641 \begin_layout Description
6642 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.
6645 \begin_layout Description
6646 Origin Tommaso, 20 Sep 2007
6649 \begin_layout Subsection*
6653 \begin_layout Description
6654 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6657 \begin_layout Description
6658 Syntax master-buffer-view [<FORMAT>]
6661 \begin_layout Description
6662 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.
6665 \begin_layout Description
6666 Origin Tommaso, 20 Sep 2007
6669 \begin_layout Subsection*
6673 \begin_layout Description
6674 Action Opens the menu given by its name.
6677 \begin_layout Description
6678 Syntax menu-open <NAME>
6681 \begin_layout Description
6682 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6685 \begin_layout Subsection*
6689 \begin_layout Description
6690 Action Close the current tab group.
6693 \begin_layout Description
6694 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6697 \begin_layout Description
6698 Syntax tab-group-close
6701 \begin_layout Description
6702 Origin Abdel, 21 Feb 2008
6705 \begin_layout Subsection*
6709 \begin_layout Description
6710 Action Toggles movability of a given toolbar between true/false.
6713 \begin_layout Description
6714 Syntax toolbar-movable <NAME>
6717 \begin_layout Description
6718 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6721 \begin_layout Description
6722 Origin daniel, 12 July 2016
6725 \begin_layout Subsection*
6729 \begin_layout Description
6730 Action Sets visibility of a given toolbar to on, off, or auto.
6733 \begin_layout Description
6734 Notion Skipping "auto" when allowauto is false.
6737 \begin_layout Description
6738 Syntax toolbar-set <NAME> [on|off|auto]
6741 \begin_layout Description
6742 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6743 \begin_inset Newline newline
6746 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6749 \begin_layout Description
6750 Origin spitz, 17 Dec 2020
6753 \begin_layout Subsection*
6757 \begin_layout Description
6758 Action Toggles visibility of a given toolbar between on/off/auto.
6761 \begin_layout Description
6762 Notion Skipping "auto" when allowauto is false.
6765 \begin_layout Description
6766 Syntax toolbar-toggle <NAME> [allowauto]
6769 \begin_layout Description
6770 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6771 \begin_inset Newline newline
6774 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6777 \begin_layout Description
6778 Origin Edwin, 21 May 2007
6781 \begin_layout Subsection*
6785 \begin_layout Description
6786 Action Various UI visibility-toggling actions.
6789 \begin_layout Description
6790 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6793 \begin_layout Description
6794 Params statusbar : Toggle visibility of the statusbar.
6795 \begin_inset Newline newline
6798 menubar : Toggle visibility of the menubar.
6799 \begin_inset Newline newline
6802 scrollbar : Toggle visibility of the scrollbar.
6803 \begin_inset Newline newline
6806 frame : Toggle visibility of the frames around editing window.
6807 \begin_inset Newline newline
6810 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.
6813 \begin_layout Description
6814 Origin sanda, 9 Feb 2007
6817 \begin_layout Subsection*
6821 \begin_layout Description
6822 Action Close the current document work area.
6825 \begin_layout Description
6826 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6829 \begin_layout Description
6833 \begin_layout Description
6834 Origin Tommaso, 15 Sep 2012
6837 \begin_layout Subsection*
6841 \begin_layout Description
6842 Action Creates another split view of current buffer.
6845 \begin_layout Description
6846 Notion All split views act in the same way independently.
6849 \begin_layout Description
6850 Syntax view-split <vertical|horizontal>
6853 \begin_layout Description
6854 Params horizontal : The work areas are laid out side by side.
6855 \begin_inset Newline newline
6858 vertical : The work areas laid out vertically.
6861 \begin_layout Description
6862 Origin Abdel, 20 Feb 2008
6865 \begin_layout Subsection*
6869 \begin_layout Description
6870 Action Closes the current LyX window.
6873 \begin_layout Description
6877 \begin_layout Description
6878 Origin Abdel, 23 Oct 2006
6881 \begin_layout Subsection*
6885 \begin_layout Description
6886 Action Creates new empty LyX window.
6889 \begin_layout Description
6890 Notion Already opened documents from the previous window can be found under View menu.
6893 \begin_layout Description
6894 Syntax window-new [<GEOMETRY>]
6897 \begin_layout Description
6898 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6901 \begin_layout Description
6902 Origin Abdel, 21 Oct 2006
6905 \begin_layout Section
6906 System Functions (Preferences, LyX Server etc.)
6909 \begin_layout Subsection*
6910 buffer-toggle-output-sync
6913 \begin_layout Description
6914 Action Toggles including of resources for forward/reverse search of the given document.
6917 \begin_layout Description
6918 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6921 \begin_layout Description
6922 Syntax buffer-toggle-output-sync
6925 \begin_layout Description
6926 Origin sanda, 25 May 2010
6929 \begin_layout Subsection*
6933 \begin_layout Description
6934 Action Executes a command defined in a .def file.
6937 \begin_layout Description
6938 Notion The definitions are by default read from lib/commands/default.def.
6939 \begin_inset Newline newline
6942 A .def file allows to define a command with
6944 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).
6946 def_file "FileName" allows to include another .def file.
6947 \begin_inset Newline newline
6950 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.
6953 \begin_layout Description
6957 \begin_layout Description
6958 Params <NAME>: Name of the command that must be called.
6961 \begin_layout Description
6962 Origin broider, 2 Oct 2007
6965 \begin_layout Subsection*
6969 \begin_layout Description
6970 Action Cancels sequence prepared by LFUN_META_PREFIX .
6973 \begin_layout Description
6977 \begin_layout Subsection*
6978 command-alternatives
6981 \begin_layout Description
6982 Action Runs the first listed command that is enabled.
6985 \begin_layout Description
6986 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6989 \begin_layout Description
6990 Syntax command-alternatives <CMDS>
6993 \begin_layout Description
6994 Params <CMDS>: Sequence of commands separated by semicolons.
6997 \begin_layout Description
6998 Sample command-alternatives completion-accept;cell-forward
7001 \begin_layout Description
7002 Origin rgh, 24 September 2008
7005 \begin_layout Subsection*
7009 \begin_layout Description
7010 Action Run more commands (LFUN and its parameters) in a sequence.
7013 \begin_layout Description
7014 Syntax command-sequence <CMDS>
7017 \begin_layout Description
7018 Params <CMDS>: Sequence of commands separated by semicolons.
7021 \begin_layout Description
7022 Sample command-sequence cut; ert-insert; self-insert
7024 ; paste; self-insert {}; inset-toggle;
7027 \begin_layout Description
7028 Origin Andre, 11 Nov 1999
7031 \begin_layout Subsection*
7032 cursor-follows-scrollbar-toggle
7035 \begin_layout Description
7036 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
7039 \begin_layout Description
7040 Syntax toggle-cursor-follows-scrollbar
7043 \begin_layout Description
7044 Origin ARRae, 2 Dec 1997
7047 \begin_layout Subsection*
7051 \begin_layout Description
7052 Action Set debug output level.
7055 \begin_layout Description
7056 Syntax debug-level-set <LEVEL>
7059 \begin_layout Description
7060 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.
7063 \begin_layout Description
7064 Origin sanda, 28 Dec 2009
7067 \begin_layout Subsection*
7071 \begin_layout Description
7072 Action toggle a mode where more information is given in UI
7075 \begin_layout Description
7076 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.
7079 \begin_layout Description
7080 Syntax devel-mode-toggle
7083 \begin_layout Description
7084 Origin lasgouttes, 23 Jul 2017
7087 \begin_layout Subsection*
7091 \begin_layout Description
7092 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
7095 \begin_layout Description
7096 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
7099 \begin_layout Description
7100 Syntax forward-search
7103 \begin_layout Description
7104 Origin sanda, 14 Apr 2010
7107 \begin_layout Subsection*
7111 \begin_layout Description
7112 Action Apply the given settings to user preferences.
7115 \begin_layout Description
7116 Syntax lyxrc-apply <SETTINGS>
7119 \begin_layout Description
7120 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.
7123 \begin_layout Subsection*
7127 \begin_layout Description
7128 Action Shows message in statusbar (for script purposes).
7131 \begin_layout Description
7132 Syntax message <STRING>
7135 \begin_layout Description
7136 Origin Lgb, 8 Apr 2001
7139 \begin_layout Subsection*
7143 \begin_layout Description
7144 Action Simulate halting Meta key (Alt key on PCs).
7147 \begin_layout Description
7148 Notion Used for buffer edition not for GUI control.
7151 \begin_layout Description
7155 \begin_layout Subsection*
7159 \begin_layout Description
7160 Action Save user preferences.
7163 \begin_layout Description
7164 Syntax preferences-save
7167 \begin_layout Description
7168 Origin Lgb, 27 Nov 1999
7171 \begin_layout Subsection*
7175 \begin_layout Description
7176 Action Reconfigure the automatic settings.
7179 \begin_layout Description
7183 \begin_layout Description
7184 Origin Asger, 14 Feb 1997
7187 \begin_layout Subsection*
7191 \begin_layout Description
7192 Action Enables/disables searching for features in findadv
7195 \begin_layout Description
7196 Syntax search-ignore <type> <value>
7199 \begin_layout Description
7200 Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike<value>: true|false
7203 \begin_layout Subsection*
7207 \begin_layout Description
7208 Action Returns path and file name of the currently edited document.
7211 \begin_layout Description
7212 Syntax server-get-filename
7215 \begin_layout Subsection*
7219 \begin_layout Description
7220 Action Returns the current layout (that is environment) name on the cursor position.
7223 \begin_layout Description
7224 Syntax server-get-layout
7227 \begin_layout Subsection*
7228 server-get-statistics
7231 \begin_layout Description
7232 Action Returns the statistics (number of words and characters) in the document or in the given selection.
7235 \begin_layout Description
7236 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7239 \begin_layout Description
7240 Syntax server-get-statistics [<TYPE>]
7243 \begin_layout Description
7244 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
7245 \begin_inset Newline newline
7249 \begin_inset Newline newline
7252 chars: count characters.
7253 \begin_inset Newline newline
7256 chars-space: count characters and spaces.
7259 \begin_layout Description
7260 Origin brokenclock, Oct 10 2014
7263 \begin_layout Subsection*
7267 \begin_layout Description
7268 Action Returns the coordinates of cursor position in the editing area.
7271 \begin_layout Description
7272 Syntax server-get-xy
7275 \begin_layout Subsection*
7276 server-goto-file-row
7279 \begin_layout Description
7280 Action Sets the cursor position in LyX based on the row number of generated TeX file.
7283 \begin_layout Description
7284 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).
7287 \begin_layout Description
7288 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
7291 \begin_layout Description
7292 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.
7293 \begin_inset Newline newline
7296 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).
7297 \begin_inset Newline newline
7300 .ext: extensions will be automatically replaced by .lyx.
7301 \begin_inset Newline newline
7304 <ROW_NUMBER> The row number of the LaTeX file to which to go.
7307 \begin_layout Description
7308 Sample server-goto-file-row /home/user/example.lyx 41
7309 \begin_inset Newline newline
7312 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
7315 \begin_layout Description
7316 Origin Edmar, 23 Dec 1998
7319 \begin_layout Subsection*
7323 \begin_layout Description
7324 Action Sends notify message about the last key-sequence to client.
7327 \begin_layout Description
7328 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
7331 \begin_layout Description
7332 Syntax server-notify
7335 \begin_layout Subsection*
7339 \begin_layout Description
7340 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
7343 \begin_layout Description
7344 Syntax server-set-xy <X> <Y>
7347 \begin_layout Subsection*
7351 \begin_layout Description
7352 Action Set the given LyX color to the color defined by the X11 name given, and optionally a specific color for dark mode.
7355 \begin_layout Description
7356 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
7359 \begin_layout Description
7360 Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
7363 \begin_layout Description
7364 Origin SLior, 11 Jun 2000
7367 \begin_layout Subsection*
7371 \begin_layout Description
7372 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
7375 \begin_layout Description
7376 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7379 \begin_layout Description
7383 \begin_layout Description
7384 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7387 \begin_layout Subsection*
7391 \begin_layout Description
7392 Action Checks-in/commits the changes of the registered file to the repository.
7395 \begin_layout Description
7396 Notion In RCS case this also unlocks the file.
7399 \begin_layout Description
7403 \begin_layout Description
7404 Origin Lgb, 1 Jul 1997
7407 \begin_layout Subsection*
7411 \begin_layout Description
7412 Action Checks-out the document for edit (and locks it in some cases).
7415 \begin_layout Description
7419 \begin_layout Description
7420 Origin Lgb, 1 Jul 1997
7423 \begin_layout Subsection*
7427 \begin_layout Description
7428 Action Executes external command. This command is intended to support additional VCS commands.
7431 \begin_layout Description
7432 Syntax vc-command <FLAG> <PATH> <COMMAND>
7435 \begin_layout Description
7436 Params <FLAG>: Flags for the command can be combined together.
7437 \begin_inset Newline newline
7440 U - dUmmy - no flags
7441 \begin_inset Newline newline
7444 D - Doc - need document loaded to proceed
7445 \begin_inset Newline newline
7448 I - dIrty - mark document dirty
7449 \begin_inset Newline newline
7452 R - Reload - ensure that the document is saved and reload it after command execution
7453 \begin_inset Newline newline
7456 M - Message - ask for input string (commit message)
7457 \begin_inset Newline newline
7460 <PATH>: path where to start. $$p will be replaced by the current document path.
7461 \begin_inset Newline newline
7464 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
7467 \begin_layout Description
7468 Sample vc-command DR $$p "svn up"
7471 \begin_layout Description
7472 Origin sanda, 13 Jan 2009
7475 \begin_layout Subsection*
7479 \begin_layout Description
7480 Action Compares two revisions of the same file under version control.
7483 \begin_layout Description
7484 Syntax vc-compare [<REV1>] [<REV2>]
7487 \begin_layout Description
7488 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
7489 \begin_inset Newline newline
7492 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
7493 \begin_inset Newline newline
7497 \begin_inset Newline newline
7500 <REV2>: Newer file. Used only if REV1 > 0.
7501 \begin_inset Newline newline
7504 If no parameter is given, interactive dialog will be shown.
7507 \begin_layout Description
7508 Sample Compare current document against last commit
7509 \begin_inset Newline newline
7513 \begin_inset Newline newline
7516 Compare current document against current revision - 5 commits
7517 \begin_inset Newline newline
7521 \begin_inset Newline newline
7524 Compare revisions 120 and 155
7525 \begin_inset Newline newline
7531 \begin_layout Description
7532 Origin sanda, 12 Feb 2010
7535 \begin_layout Subsection*
7539 \begin_layout Description
7540 Action Copies the document to another name.
7543 \begin_layout Description
7544 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.
7547 \begin_layout Description
7548 Syntax vc-copy <FILENAME>
7551 \begin_layout Description
7552 Params <FILENAME>: New name of the document.
7553 \begin_inset Newline newline
7556 A file dialog is opened if no filename is given.
7559 \begin_layout Description
7560 Origin gb, 05 Feb 2013
7563 \begin_layout Subsection*
7567 \begin_layout Description
7568 Action Toggles the locking property of the edited file.
7571 \begin_layout Description
7572 Notion This is currently implemented only for SVN.
7575 \begin_layout Description
7576 Syntax vc-locking-toggle
7579 \begin_layout Description
7580 Origin sanda, 25 Jun 2009
7583 \begin_layout Subsection*
7587 \begin_layout Description
7588 Action Register the document as an file inside version control system.
7591 \begin_layout Description
7592 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
7593 \begin_inset Newline newline
7596 See LyX Additional Features Manual (Version Control Chapter) for additional information.
7599 \begin_layout Description
7603 \begin_layout Description
7604 Origin Lgb, 1 Jul 1997
7607 \begin_layout Subsection*
7611 \begin_layout Description
7612 Action Renames the document to another name.
7615 \begin_layout Description
7616 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.
7619 \begin_layout Description
7620 Syntax vc-rename <FILENAME>
7623 \begin_layout Description
7624 Params <FILENAME>: New name of the document.
7625 \begin_inset Newline newline
7628 A file dialog is opened if no filename is given.
7631 \begin_layout Description
7632 Origin gb, 05 Feb 2013
7635 \begin_layout Subsection*
7639 \begin_layout Description
7640 Action Update the local archive directory in which resides the current document with the remote repository.
7643 \begin_layout Description
7644 Syntax vc-repo-update
7647 \begin_layout Description
7648 Origin sanda, 16 Oct 2009
7651 \begin_layout Subsection*
7655 \begin_layout Description
7656 Action Reverts the document to the last check-in/commit in VCS.
7659 \begin_layout Description
7663 \begin_layout Description
7664 Origin Lgb, 1 Jul 1997
7667 \begin_layout Subsection*
7671 \begin_layout Description
7672 Action Undo last check-in.
7675 \begin_layout Description
7676 Notion This is currently implemented only for RCS.
7679 \begin_layout Description
7683 \begin_layout Description
7684 Origin Lgb, 1 Jul 1997
7687 \begin_layout Section
7688 Hidden Functions (not listed for configuration)
7691 \begin_layout Subsection*
7695 \begin_layout Description
7696 Action Return the current key sequence and available options as a string.
7699 \begin_layout Description
7700 Notion No options are added if no current map exists.
7701 \begin_inset Newline newline
7704 This is probably usable only with connection to lyxserver.
7707 \begin_layout Description
7708 Syntax command-prefix
7711 \begin_layout Subsection*
7715 \begin_layout Description
7716 Action Activates the LyX window.
7719 \begin_layout Description
7720 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.
7723 \begin_layout Description
7727 \begin_layout Description
7728 Origin skostysh, 4 Aug 2016
7731 \begin_layout Subsection*
7735 \begin_layout Description
7736 Action Inserts the given string (accordingly to the correct keymap).
7739 \begin_layout Description
7740 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7743 \begin_layout Description
7744 Syntax self-insert <STRING>
7747 \begin_layout Subsection*
7751 \begin_layout Description
7752 Action Raises the LyX window.
7755 \begin_layout Description
7756 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.
7759 \begin_layout Description
7763 \begin_layout Description
7764 Origin forenr, 21 Apr 2020