1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
10 \renewenvironment{description}{\list{}{%
11 \setlength{\itemsep}{-2pt}
12 \advance\leftmargini6\p@ \itemindent-12\p@
13 \labelwidth\z@ \let\makelabel\descriptionlabel}%
18 \use_default_options false
19 \maintain_unincluded_children no
27 \language_package default
28 \inputencoding auto-legacy
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
39 \font_typewriter_osf false
40 \font_sf_scale 100 100
41 \font_tt_scale 100 100
43 \use_dash_ligatures true
45 \default_output_format default
47 \bibtex_command default
48 \index_command default
49 \paperfontsize default
54 \use_package amsmath 1
55 \use_package amssymb 1
58 \use_package mathdots 0
59 \use_package mathtools 0
61 \use_package stackrel 0
62 \use_package stmaryrd 0
63 \use_package undertilde 0
65 \cite_engine_type default
69 \paperorientation portrait
86 \paragraph_separation indent
87 \paragraph_indentation default
89 \math_numbering_side default
94 \paperpagestyle default
96 \tracking_changes false
99 \postpone_fragile_content false
102 \html_be_strict false
103 \docbook_table_output 0
104 \docbook_mathml_prefix 1
119 \begin_layout Section*
123 \begin_layout Standard
124 This manual documents the
125 \begin_inset Quotes eld
129 \begin_inset Quotes erd
133 These are commands that are used to make \SpecialChar LyX
134 perform specific actions.
136 itself uses these functions internally,
137 and every internal action is bound to an LFUN.
140 \begin_layout Standard
141 LFUNs are also used in the files that define keyboard shortcuts,
142 menu or toolbar items.
143 So if you want to change\SpecialChar breakableslash
144 customize the user interface,
145 you need to deal with LFUNs.
147 external programs can use LFUNs to communicate with and
148 \begin_inset Quotes eld
152 \begin_inset Quotes erd
158 you can also issue LFUNs directly via the so called mini-buffer which can be opened via
161 arg "command-execute"
167 \begin_layout Standard
169 all LFUNs are listed,
170 categorized by function.
173 \begin_layout Section
174 Layout Functions (Font,
175 Layout and Textclass related)
178 \begin_layout Subsection*
182 \begin_layout Description
183 Action Displays list of layout choices.
186 \begin_layout Description
187 Notion This LFUN opens the dropbox allowing for choice of layout.
190 \begin_layout Description
191 Syntax drop-layouts-choice
194 \begin_layout Subsection*
198 \begin_layout Description
199 Action Splits the current environment with a Separator.
202 \begin_layout Description
203 Syntax environment-split [before|outer|previous]
206 \begin_layout Description
209 LyX will split the outermost environment in the current nesting hierarchy.
210 \begin_inset Newline newline
215 LyX will split the environment in the previous paragraph (if there is one).
216 \begin_inset Newline newline
221 the new environment will be appended rather than prepended.
224 \begin_layout Description
229 \begin_layout Subsection*
233 \begin_layout Description
234 Action Toggles the bold font (selection-wise) using mathbf in math.
237 \begin_layout Description
241 \begin_layout Subsection*
245 \begin_layout Description
246 Action Toggles the bold font (selection-wise) using boldsymbol in math.
249 \begin_layout Description
250 Syntax font-boldsymbol
253 \begin_layout Subsection*
257 \begin_layout Description
258 Action Toggles xout (cross-through) in the font (selection-wise).
261 \begin_layout Description
265 \begin_layout Description
270 \begin_layout Subsection*
274 \begin_layout Description
275 Action Reverts the settings of the font to the default values (selection-wise).
278 \begin_layout Description
282 \begin_layout Subsection*
286 \begin_layout Description
287 Action Toggles the emphasis font style (selection-wise).
290 \begin_layout Description
294 \begin_layout Subsection*
298 \begin_layout Description
299 Action Toggles Fraktur family font (math-mode,
303 \begin_layout Description
307 \begin_layout Description
312 \begin_layout Subsection*
316 \begin_layout Description
317 Action Toggles Italics font shape (math-mode,
321 \begin_layout Description
325 \begin_layout Description
330 \begin_layout Subsection*
334 \begin_layout Description
335 Action Toggles nospellcheck status in the font (selection-wise).
338 \begin_layout Description
339 Syntax font-nospellcheck
342 \begin_layout Description
347 \begin_layout Subsection*
351 \begin_layout Description
352 Action Toggles Noun text style font (selection-wise).
355 \begin_layout Description
359 \begin_layout Subsection*
363 \begin_layout Description
364 Action Toggles Roman family font (selection-wise).
367 \begin_layout Description
371 \begin_layout Subsection*
375 \begin_layout Description
376 Action Toggles Sans Serif family font (selection-wise).
379 \begin_layout Description
383 \begin_layout Subsection*
387 \begin_layout Description
388 Action Sets font size according to lyx format string.
391 \begin_layout Description
392 Syntax font-size <SIZE>
395 \begin_layout Description
397 tiny|scriptsize|footnotesize|small|normal|large|larger|
398 \begin_inset Newline newline
401 largest|huge|giant|increase|decrease|default
404 \begin_layout Subsection*
408 \begin_layout Description
409 Action Returns the info about the current font.
412 \begin_layout Description
416 \begin_layout Subsection*
420 \begin_layout Description
421 Action Toggles strikeout (strike-through) in the font (selection-wise).
424 \begin_layout Description
425 Syntax font-strikeout
428 \begin_layout Description
433 \begin_layout Subsection*
437 \begin_layout Description
438 Action Toggles the typewriter family font (selection-wise).
441 \begin_layout Description
442 Syntax font-typewriter
445 \begin_layout Subsection*
449 \begin_layout Description
450 Action Toggles underline in the font (selection-wise).
453 \begin_layout Description
454 Syntax font-underline
457 \begin_layout Subsection*
461 \begin_layout Description
462 Action Toggles double underline in the font (selection-wise).
465 \begin_layout Description
466 Syntax font-underunderline
469 \begin_layout Description
474 \begin_layout Subsection*
478 \begin_layout Description
479 Action Toggles wavy underline in the font (selection-wise).
482 \begin_layout Description
483 Syntax font-underwave
486 \begin_layout Description
491 \begin_layout Subsection*
495 \begin_layout Description
496 Action Sets the layout (that is,
497 environment) for the current paragraph.
500 \begin_layout Description
501 Syntax layout <LAYOUT> [ignoreautonests]
504 \begin_layout Description
507 \begin_inset Newline newline
512 nesting advices will be ignored.
515 \begin_layout Subsection*
519 \begin_layout Description
520 Action Adds a module.
523 \begin_layout Description
524 Notion Adds a module to the list of included modules for the current buffer.
527 \begin_layout Description
528 Syntax layout-module-add <MODULE>
531 \begin_layout Description
533 the module to be added
536 \begin_layout Description
541 \begin_layout Subsection*
545 \begin_layout Description
546 Action Clears the module list.
549 \begin_layout Description
550 Notion Clears the list of included modules for the current buffer.
553 \begin_layout Description
554 Syntax layout-modules-clear
557 \begin_layout Description
562 \begin_layout Subsection*
566 \begin_layout Description
567 Action Launches the paragraph settings dialog.
570 \begin_layout Description
571 Syntax layout-paragraph
574 \begin_layout Subsection*
578 \begin_layout Description
579 Action Reloads layout information.
582 \begin_layout Description
583 Notion Reloads all layout information for the current buffer from disk,
584 thus recognizing any changes that have been made to layout files on the fly.
585 This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
588 \begin_layout Description
592 \begin_layout Description
597 \begin_layout Subsection*
601 \begin_layout Description
602 Action Launches the tabular settings dialog.
605 \begin_layout Description
606 Syntax layout-tabular
609 \begin_layout Description
614 \begin_layout Subsection*
618 \begin_layout Description
619 Action Toggles the layout (that is,
620 environment) for the current paragraph.
623 \begin_layout Description
624 Notion Contrary to `layout',
625 this function resets the current (or selection) layout to the standard layout it already has the correct layout.
626 Useful for toolbar icons.
629 \begin_layout Description
630 Syntax layout-toggle <LAYOUT> [ignoreautonests]
633 \begin_layout Description
636 \begin_inset Newline newline
641 nesting advices will be ignored.
644 \begin_layout Description
649 \begin_layout Subsection*
653 \begin_layout Description
654 Action Update fonts and its metrics.
657 \begin_layout Description
658 Notion Automatically called after zoom,
664 \begin_layout Description
665 Syntax screen-font-update
668 \begin_layout Description
673 \begin_layout Subsection*
677 \begin_layout Description
678 Action Sets the text class for the current buffer.
681 \begin_layout Description
682 Syntax textclass-apply <TEXTCLASS>
685 \begin_layout Description
687 the textclass to set.
688 Note that this must be the filename,
689 minus the ".layout" extension.
692 \begin_layout Subsection*
696 \begin_layout Description
697 Action Loads information for a textclass from disk.
700 \begin_layout Description
701 Syntax textclass-load <TEXTCLASS>
704 \begin_layout Description
706 the textclass to load.
707 Note that this must be the filename,
708 minus the ".layout" extension.
711 \begin_layout Subsection*
715 \begin_layout Description
716 Action Apply last used text properties.
719 \begin_layout Description
720 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE,
721 which is automatically triggered when using Text Style dialog.
724 \begin_layout Description
725 Syntax textstyle-apply [<NUM>]textstyle-apply
728 \begin_layout Description
730 number of the selection in the internal freefonts stack to be applied.
733 \begin_layout Description
738 \begin_layout Subsection*
742 \begin_layout Description
743 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
746 \begin_layout Description
747 Syntax textstyle-update <FONT_INFO>
750 \begin_layout Description
752 specifies font attributes,
765 \begin_inset Newline newline
768 Use lyx -dbg action for exact syntax of text-style dialog parameters.
771 \begin_layout Description
776 \begin_layout Section
777 Editing Functions (Cursor and Mouse Movement,
781 \begin_layout Subsection*
785 \begin_layout Description
786 Action Adds an acute accent to the next character typed.
789 \begin_layout Description
793 \begin_layout Subsection*
797 \begin_layout Description
798 Action Adds a breve accent to the next character typed.
801 \begin_layout Description
805 \begin_layout Subsection*
809 \begin_layout Description
810 Action Adds a caron to the next character typed.
813 \begin_layout Description
817 \begin_layout Subsection*
821 \begin_layout Description
822 Action Adds a cedilla to the next character typed.
825 \begin_layout Description
826 Syntax accent-cedilla
829 \begin_layout Subsection*
833 \begin_layout Description
834 Action Adds a circle accent to the next character typed.
837 \begin_layout Description
841 \begin_layout Subsection*
845 \begin_layout Description
846 Action Adds a circumflex to the next character typed.
849 \begin_layout Description
850 Syntax accent-circumflex
853 \begin_layout Subsection*
857 \begin_layout Description
858 Action Adds a dot accent to the next character typed.
861 \begin_layout Description
865 \begin_layout Subsection*
869 \begin_layout Description
870 Action Adds a grave accent to the next character typed.
873 \begin_layout Description
877 \begin_layout Subsection*
878 accent-hungarian-umlaut
881 \begin_layout Description
882 Action Adds a Hungarian umlaut to the next character typed.
885 \begin_layout Description
889 \begin_layout Subsection*
893 \begin_layout Description
894 Action Adds a macron to the next character typed.
897 \begin_layout Description
901 \begin_layout Subsection*
905 \begin_layout Description
906 Action Adds an ogonek accent to the next character typed.
909 \begin_layout Description
913 \begin_layout Subsection*
917 \begin_layout Description
918 Action Adds a perispomeni (Greek circumflex) over the next character typed.
921 \begin_layout Description
922 Syntax accent-perispomeni
925 \begin_layout Subsection*
929 \begin_layout Description
930 Action Adds a tie over the next two character typed.
933 \begin_layout Description
934 Notion The following char will finish the tie.
937 \begin_layout Description
941 \begin_layout Subsection*
945 \begin_layout Description
946 Action Adds a tilde over the next character typed.
949 \begin_layout Description
953 \begin_layout Subsection*
957 \begin_layout Description
958 Action Adds an umlaut over the next character typed.
961 \begin_layout Description
965 \begin_layout Subsection*
969 \begin_layout Description
970 Action Adds a bar under the next character typed.
973 \begin_layout Description
974 Syntax accent-underbar
977 \begin_layout Subsection*
981 \begin_layout Description
982 Action Adds a dot under the next character typed.
985 \begin_layout Description
986 Syntax accent-underdot
989 \begin_layout Subsection*
993 \begin_layout Description
994 Action Accepts all tracked changes in the document.
997 \begin_layout Description
998 Syntax all-changes-accept
1001 \begin_layout Description
1006 \begin_layout Subsection*
1010 \begin_layout Description
1011 Action Rejects all tracked changes in the document.
1014 \begin_layout Description
1015 Notion Reject does not work recursively;
1016 the user may have to repeat the operation.
1019 \begin_layout Description
1020 Syntax all-changes-reject
1023 \begin_layout Description
1028 \begin_layout Subsection*
1032 \begin_layout Description
1033 Action Start (or remove) Appendix on the given cursor position.
1036 \begin_layout Description
1040 \begin_layout Description
1045 \begin_layout Subsection*
1049 \begin_layout Description
1050 Action Inserts an argument (short title) inset.
1053 \begin_layout Description
1054 Syntax argument-insert <argument nr>
1057 \begin_layout Description
1058 Params <argument nr>:
1059 see layout declarations
1062 \begin_layout Description
1067 \begin_layout Subsection*
1071 \begin_layout Description
1072 Action Adds database,
1073 which will be used for bibtex citations.
1076 \begin_layout Description
1077 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1080 \begin_layout Description
1081 Syntax bibtex-database-add <DATABASE-NAME>
1084 \begin_layout Description
1089 \begin_layout Subsection*
1093 \begin_layout Description
1094 Action Adds database,
1095 which will be used for bibtex citations.
1098 \begin_layout Description
1099 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1102 \begin_layout Description
1103 Syntax bibtex-database-del <DATABASE-NAME>
1106 \begin_layout Description
1111 \begin_layout Subsection*
1115 \begin_layout Description
1116 Action Clears the list of saved bookmarks.
1119 \begin_layout Description
1120 Syntax bookmark-clear
1123 \begin_layout Description
1128 \begin_layout Subsection*
1132 \begin_layout Description
1133 Action Moves the cursor to the numbered bookmark,
1134 opening the file if necessary.
1135 Note that bookmarks are saved per-session,
1139 \begin_layout Description
1140 Notion Bookmark 0 has a special purpose.
1141 It is automatically set
1142 \begin_inset Newline newline
1146 to the paragraph you are currently editing
1147 \begin_inset Newline newline
1151 to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1152 \begin_inset Newline newline
1156 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1159 \begin_layout Description
1160 Syntax bookmark-goto <NUMBER>
1163 \begin_layout Description
1165 the number of the bookmark to restore.
1168 \begin_layout Description
1173 \begin_layout Subsection*
1177 \begin_layout Description
1178 Action Save a bookmark.
1181 \begin_layout Description
1182 Notion Saves a numbered bookmark to the sessions file.
1183 The number must be between 1 and 9,
1185 Note that bookmarks are saved per-session,
1189 \begin_layout Description
1190 Syntax bookmark-save <NUMBER>
1193 \begin_layout Description
1195 the number of the bookmark to save.
1198 \begin_layout Description
1203 \begin_layout Subsection*
1207 \begin_layout Description
1208 Action Inserts Box inset.
1211 \begin_layout Description
1212 Syntax box-insert [<TYPE>]
1215 \begin_layout Description
1217 Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1218 \begin_inset Newline newline
1221 Framed is the default one.
1224 \begin_layout Description
1229 \begin_layout Subsection*
1233 \begin_layout Description
1234 Action Inserts branch inset.
1237 \begin_layout Description
1238 Syntax branch-insert <BRANCH-NAME>
1241 \begin_layout Description
1246 \begin_layout Subsection*
1250 \begin_layout Description
1251 Action For debug purposes only.
1252 Convert all [a-zA-Z0-1] characters to single character.
1253 Useful when submitting docs to list or bugzilla.
1256 \begin_layout Description
1257 Syntax buffer-anonymize
1260 \begin_layout Description
1265 \begin_layout Subsection*
1269 \begin_layout Description
1270 Action Move the cursor to the beginning of the document.
1273 \begin_layout Description
1277 \begin_layout Subsection*
1281 \begin_layout Description
1282 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1285 \begin_layout Description
1286 Syntax buffer-begin-select
1289 \begin_layout Subsection*
1293 \begin_layout Description
1294 Action Move the cursor to the end of the document.
1297 \begin_layout Description
1301 \begin_layout Subsection*
1305 \begin_layout Description
1306 Action Move the cursor to the end of the document adding the traversed text to the selection.
1309 \begin_layout Description
1310 Syntax buffer-end-select
1313 \begin_layout Subsection*
1317 \begin_layout Description
1318 Action Inserts a caption inset.
1321 \begin_layout Description
1322 Syntax caption-insert
1325 \begin_layout Description
1330 \begin_layout Subsection*
1334 \begin_layout Description
1335 Action Moves the cursor to the previous cell inside the table.
1338 \begin_layout Description
1339 Syntax cell-backward
1342 \begin_layout Description
1347 \begin_layout Subsection*
1351 \begin_layout Description
1352 Action Moves the cursor to the next cell inside the table.
1355 \begin_layout Description
1359 \begin_layout Subsection*
1363 \begin_layout Description
1364 Action Splits cell and shifts right part to the next cell (inside the math grid).
1367 \begin_layout Description
1371 \begin_layout Description
1376 \begin_layout Subsection*
1380 \begin_layout Description
1381 Action Accepts tracked change inside the selection.
1384 \begin_layout Description
1385 Syntax change-accept
1388 \begin_layout Description
1393 \begin_layout Subsection*
1397 \begin_layout Description
1398 Action Moves the cursor to the position of the next change of the change tracking records.
1401 \begin_layout Description
1405 \begin_layout Description
1410 \begin_layout Subsection*
1414 \begin_layout Description
1415 Action Moves the cursor to the position of the previous change of the change tracking records.
1418 \begin_layout Description
1419 Syntax change-previous
1422 \begin_layout Description
1427 \begin_layout Subsection*
1431 \begin_layout Description
1432 Action Rejects tracked change inside the selection.
1435 \begin_layout Description
1436 Syntax change-reject
1439 \begin_layout Description
1444 \begin_layout Subsection*
1448 \begin_layout Description
1449 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1452 \begin_layout Description
1453 Syntax changes-merge
1456 \begin_layout Description
1461 \begin_layout Subsection*
1465 \begin_layout Description
1466 Action Toggles showing of change tracking in typeset output.
1469 \begin_layout Description
1470 Syntax changes-output
1473 \begin_layout Description
1478 \begin_layout Subsection*
1482 \begin_layout Description
1483 Action Toggles change tracking to on/off.
1486 \begin_layout Description
1487 Syntax changes-track
1490 \begin_layout Description
1495 \begin_layout Subsection*
1499 \begin_layout Description
1500 Action Moves the cursor one position logically backwards.
1503 \begin_layout Description
1504 Notion This is not the action which should be bound to the arrow keys,
1505 because backwards may be left or right,
1506 depending on the language.
1507 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1508 which in turn may employ this one.
1511 \begin_layout Description
1512 Syntax char-backward
1515 \begin_layout Subsection*
1516 char-backward-select
1519 \begin_layout Description
1520 Action Moves the cursor one position logically backwards,
1521 adding traversed position to the selection.
1524 \begin_layout Description
1525 Notion See also LFUN_CHAR_BACKWARD.
1528 \begin_layout Description
1529 Syntax char-backward-select
1532 \begin_layout Subsection*
1533 char-delete-backward
1536 \begin_layout Description
1537 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1540 \begin_layout Description
1541 Syntax char-delete-backward [confirm]
1544 \begin_layout Description
1547 do not directly delete them.
1550 \begin_layout Subsection*
1554 \begin_layout Description
1555 Action Deletes one character in the backward direction (usually the "Delete" key).
1558 \begin_layout Description
1559 Syntax char-delete-forward [confirm]
1562 \begin_layout Description
1565 do not directly delete them.
1568 \begin_layout Subsection*
1572 \begin_layout Description
1573 Action Moves the cursor one position logically forward.
1576 \begin_layout Description
1577 Notion This is not the action which should be bound to the arrow keys,
1578 because forward may be left or right,
1579 depending on the language.
1580 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1581 which in turn may employ this one.
1584 \begin_layout Description
1588 \begin_layout Subsection*
1592 \begin_layout Description
1593 Action Moves the cursor one position logically forward,
1594 adding traversed position to the selection.
1597 \begin_layout Description
1598 Notion See also LFUN_CHAR_FORWARD.
1601 \begin_layout Description
1602 Syntax char-forward-select
1605 \begin_layout Subsection*
1609 \begin_layout Description
1610 Action Moves the cursor one position "to the left".
1613 \begin_layout Description
1614 Notion This is the action which should be taken when the "left" key is pressed.
1616 it moves the cursor one position to the left.
1618 in Bidi text this become slightly more complicated,
1619 and there are different modes of cursor movement.
1624 movement is logically forward in RTL paragraphs,
1625 and logically backwards in LTR paragraphs.
1628 \begin_layout Description
1632 \begin_layout Subsection*
1636 \begin_layout Description
1637 Action Moves the cursor one position "to the left",
1638 adding traversed position to the selection.
1641 \begin_layout Description
1642 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1645 \begin_layout Description
1646 Syntax char-left-select
1649 \begin_layout Subsection*
1653 \begin_layout Description
1654 Action Moves the cursor one position "to the right".
1657 \begin_layout Description
1658 Notion This is the action which should be taken when the "right" key is pressed.
1660 it moves the cursor one position to the right.
1662 in Bidi text this become slightly more complicated,
1663 and there are different modes of cursor movement.
1668 movement is logically forward in LTR paragraphs,
1669 and logically backwards in RTL paragraphs.
1672 \begin_layout Description
1676 \begin_layout Subsection*
1680 \begin_layout Description
1681 Action Moves the cursor one position "to the right",
1682 adding traversed position to the selection.
1685 \begin_layout Description
1686 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1689 \begin_layout Description
1690 Syntax char-right-select
1693 \begin_layout Subsection*
1697 \begin_layout Description
1698 Action Transposes the character at the cursor with the one before it.
1701 \begin_layout Description
1702 Syntax chars-transpose
1705 \begin_layout Description
1710 \begin_layout Subsection*
1714 \begin_layout Description
1715 Action Inserts citation from loaded citation database.
1718 \begin_layout Description
1719 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1722 \begin_layout Description
1724 Citation (shortcut listed in available citations).
1725 \begin_inset Newline newline
1729 text which should appear before citation.
1732 \begin_layout Description
1737 \begin_layout Subsection*
1741 \begin_layout Description
1742 Action Opens the corresponding pdf/url for a given citation inset.
1745 \begin_layout Description
1746 Syntax citation-open [EXTERNAL] TARGET
1749 \begin_layout Description
1751 URL (https:,file:) of the document.
1752 \begin_inset Newline newline
1756 Use external executable script for finding target
1757 \begin_inset Newline newline
1760 and launching viewer.
1761 In this case TARGET consists of author and year
1762 \begin_inset Newline newline
1765 and will be passed as an input argument to the script.
1768 \begin_layout Description
1773 \begin_layout Subsection*
1777 \begin_layout Description
1778 Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text).
1779 Pastes plain text if plain text is on the clipboard,
1780 but tries to interpret it in special ways for certain insets,
1782 converting csv data to rows and columns if the paste happens in a tabular inset.
1785 \begin_layout Description
1786 Notion Historically,
1787 LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE:
1788 It behaved exactly the same,
1789 but the source is the clipboard,
1793 \begin_layout Description
1794 Syntax clipboard-paste [<ARG>]
1797 \begin_layout Description
1799 "paragraph" will cause pasting as one paragraph,
1804 \begin_layout Description
1809 \begin_layout Subsection*
1810 clipboard-paste-simple
1813 \begin_layout Description
1814 Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard.
1815 Pastes plain text if plain text is on the clipboard,
1816 without trying to interpret it in special ways for certain insets,
1818 converting csv data to rows and columns if the paste happens in a tabular inset.
1821 \begin_layout Description
1822 Syntax clipboard-paste-simple [<ARG>]
1825 \begin_layout Description
1827 "paragraph" will cause pasting as one paragraph,
1832 \begin_layout Subsection*
1836 \begin_layout Description
1837 Action Switches the focus to the minibuffer so that the user can type in there.
1839 it opens the minibuffer toolbar.
1842 \begin_layout Description
1843 Notion Usually bound to M-x shortcut.
1846 \begin_layout Description
1847 Syntax command-execute
1850 \begin_layout Subsection*
1854 \begin_layout Description
1855 Action Try to complete the word or command at the cursor position.
1858 \begin_layout Description
1862 \begin_layout Description
1867 \begin_layout Subsection*
1871 \begin_layout Description
1872 Action Accept suggested completion.
1875 \begin_layout Description
1876 Syntax completion-accept
1879 \begin_layout Description
1884 \begin_layout Subsection*
1888 \begin_layout Description
1889 Action Try to cancel completion,
1890 either the popup or the inline completion.
1893 \begin_layout Description
1894 Syntax completion-cancel
1897 \begin_layout Description
1902 \begin_layout Subsection*
1906 \begin_layout Description
1907 Action Show the inline completion at the cursor position.
1910 \begin_layout Description
1911 Syntax completion-inline
1914 \begin_layout Description
1919 \begin_layout Subsection*
1923 \begin_layout Description
1924 Action Show the completion popup at the cursor position.
1927 \begin_layout Description
1928 Syntax completion-popup
1931 \begin_layout Description
1936 \begin_layout Subsection*
1940 \begin_layout Description
1941 Action Copies the current selection to the clipboard.
1944 \begin_layout Description
1948 \begin_layout Subsection*
1952 \begin_layout Description
1953 Action Cuts to the clipboard.
1956 \begin_layout Description
1960 \begin_layout Subsection*
1964 \begin_layout Description
1965 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1968 \begin_layout Description
1969 Syntax depth-decrement
1972 \begin_layout Subsection*
1976 \begin_layout Description
1977 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1980 \begin_layout Description
1981 Syntax depth-increment
1984 \begin_layout Subsection*
1985 dialog-disconnect-inset
1988 \begin_layout Description
1989 Action Closes opened connection to opened inset.
1992 \begin_layout Description
1993 Notion Connection is used for apply functions.
1996 \begin_layout Description
1997 Syntax dialog-disconnect-inset <INSET-NAME>
2000 \begin_layout Description
2005 \begin_layout Subsection*
2009 \begin_layout Description
2010 Action Hides showed dialog.
2011 Counterpart to LFUN_DIALOG_SHOW .
2014 \begin_layout Description
2015 Syntax dialog-hide <NAME>
2018 \begin_layout Description
2019 Params See LFUN_DIALOG_SHOW .
2022 \begin_layout Description
2027 \begin_layout Subsection*
2031 \begin_layout Description
2032 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
2035 \begin_layout Description
2036 Syntax dialog-show <NAME> [<DATA>]
2039 \begin_layout Description
2041 aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
2042 \begin_inset Newline newline
2045 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
2046 \begin_inset Newline newline
2049 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
2050 \begin_inset Newline newline
2053 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
2054 \begin_inset Newline newline
2057 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
2058 \begin_inset Newline newline
2061 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
2062 \begin_inset Newline newline
2067 \begin_inset Newline newline
2072 usually settings for the given dialog.
2073 Use debug mode for the details.
2076 \begin_layout Description
2081 \begin_layout Subsection*
2082 dialog-show-new-inset
2085 \begin_layout Description
2086 Action Shows hidden dialog or create new one for a given inset settings etc.
2089 \begin_layout Description
2090 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
2093 \begin_layout Description
2094 Syntax dialog-show-new-inset <NAME> [<DATA>]
2097 \begin_layout Description
2098 Params See LFUN_DIALOG_SHOW .
2101 \begin_layout Description
2106 \begin_layout Subsection*
2110 \begin_layout Description
2111 Action Toggles dialog between showed/hidden state.
2114 \begin_layout Description
2115 Notion Internally uses LFUN_DIALOG_SHOW ,
2119 \begin_layout Description
2120 Syntax dialog-toggle <NAME> [<DATA>]
2123 \begin_layout Description
2124 Params See LFUN_DIALOG_SHOW .
2127 \begin_layout Description
2132 \begin_layout Subsection*
2136 \begin_layout Description
2137 Action Updates the dialog values from the inset/paragraph/document.
2140 \begin_layout Description
2141 Syntax dialog-update <NAME>
2144 \begin_layout Description
2146 paragraph|prefs|<INSET>
2147 \begin_inset Newline newline
2154 \begin_layout Description
2159 \begin_layout Subsection*
2163 \begin_layout Description
2164 Action Moves the cursor one line in downward direction.
2167 \begin_layout Description
2171 \begin_layout Subsection*
2175 \begin_layout Description
2176 Action Moves the cursor one line in downward direction adding the current position to the selection.
2179 \begin_layout Description
2183 \begin_layout Subsection*
2187 \begin_layout Description
2188 Action Inserts an ERT inset.
2191 \begin_layout Description
2195 \begin_layout Description
2200 \begin_layout Subsection*
2204 \begin_layout Description
2205 Action Clears the selection.
2206 If no text is selected call LFUN_FINISHED_FORWARD.
2207 Inside math mode jumps out of the math inset.
2210 \begin_layout Description
2214 \begin_layout Description
2219 \begin_layout Subsection*
2223 \begin_layout Description
2224 Action Cancel background export process.
2227 \begin_layout Description
2228 Syntax export-cancel
2231 \begin_layout Description
2236 \begin_layout Subsection*
2240 \begin_layout Description
2241 Action Inserts another LyX file.
2244 \begin_layout Description
2245 Syntax file-insert [<FILE>] [ignorelang]
2248 \begin_layout Description
2250 Filename to be inserted.
2253 the (main) language of the inserted file is ignored (the context language is used).
2256 \begin_layout Subsection*
2257 file-insert-plaintext
2260 \begin_layout Description
2261 Action Inserts plain text file.
2264 \begin_layout Description
2265 Syntax file-insert-plaintext [<FILE>]
2268 \begin_layout Description
2270 Filename to be inserted.
2273 \begin_layout Description
2278 \begin_layout Subsection*
2279 file-insert-plaintext-para
2282 \begin_layout Description
2283 Action Inserts plain text file as paragraph (i.e.
2287 \begin_layout Description
2288 Syntax file-insert-plaintext-para [<FILE>]
2291 \begin_layout Description
2293 Filename to be inserted.
2296 \begin_layout Description
2301 \begin_layout Subsection*
2305 \begin_layout Description
2306 Action Inserts CharStyle,
2307 Custom inset or XML short element.
2310 \begin_layout Description
2311 Notion Look into the Customization manual for more information about these elements.
2312 \begin_inset Newline newline
2315 To make this command enabled the layout file for the document class you're using has to load the character styles.
2316 There are a few contained in the Logical Markup module.
2317 You can also of course create some yourself.
2318 \begin_inset Newline newline
2321 For dissolving the element see LFUN_INSET_DISSOLVE.
2324 \begin_layout Description
2325 Syntax flex-insert Name
2328 \begin_layout Description
2330 This name must be defined either in your layout file or imported by some module.
2331 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
2336 \begin_layout Description
2337 Sample flex-insert Code
2340 \begin_layout Subsection*
2344 \begin_layout Description
2345 Action Inserts a float inset.
2348 \begin_layout Description
2349 Syntax float-insert <TYPE>
2352 \begin_layout Description
2354 type of float depends on the used textclass.
2355 Usually "algorithm",
2357 "figure" parameters can be given.
2360 \begin_layout Description
2365 \begin_layout Subsection*
2369 \begin_layout Description
2370 Action Inserts the list of floats in the document.
2373 \begin_layout Description
2374 Syntax float-list-insert <TYPE>
2377 \begin_layout Description
2379 type of float depends on the used textclass.
2380 Usually "algorithm",
2382 "figure" parameters can be given.
2385 \begin_layout Description
2390 \begin_layout Subsection*
2394 \begin_layout Description
2395 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2398 \begin_layout Description
2399 Notion Corresponds to the starred floats (figure*,
2404 \begin_layout Description
2405 Syntax float-wide-insert <TYPE>
2408 \begin_layout Description
2410 type of float depends on the used textclass.
2411 Usually "algorithm",
2413 "figure" parameters can be given.
2416 \begin_layout Description
2421 \begin_layout Subsection*
2425 \begin_layout Description
2426 Action Inserts a footnote inset.
2429 \begin_layout Description
2430 Syntax footnote-insert
2433 \begin_layout Description
2438 \begin_layout Subsection*
2442 \begin_layout Description
2443 Action Reloads the image if necessary.
2446 \begin_layout Description
2447 Syntax graphics-reload
2450 \begin_layout Description
2455 \begin_layout Subsection*
2459 \begin_layout Description
2460 Action Set the group for the graphics inset on the cursor position.
2463 \begin_layout Description
2464 Syntax graphics-set-group [<GROUP>]
2467 \begin_layout Description
2469 Id for an existing group.
2470 In case the Id is an empty string,
2471 the graphics inset is removed from the current group.
2474 \begin_layout Description
2479 \begin_layout Subsection*
2483 \begin_layout Description
2484 Action Set the same group for all graphics insets in the marked block.
2487 \begin_layout Description
2488 Syntax graphics-unify [<GROUP>]
2491 \begin_layout Description
2493 Id for an existing group.
2494 In case the Id is an empty string,
2495 the group Id from the first graphics inset will be used.
2498 \begin_layout Description
2503 \begin_layout Subsection*
2507 \begin_layout Description
2508 Action Inserts hyperlinks into the document (clickable in pdf output).
2511 \begin_layout Description
2512 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2515 \begin_layout Description
2516 Syntax href-insert [<TARGET>]
2519 \begin_layout Description
2524 \begin_layout Subsection*
2528 \begin_layout Description
2529 Action Only active in IPA inset.
2532 \begin_layout Description
2533 Notion Dummy function which is only active in a IPA inset.
2534 It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2537 \begin_layout Description
2541 \begin_layout Description
2546 \begin_layout Subsection*
2550 \begin_layout Description
2551 Action Inserts Index entry.
2554 \begin_layout Description
2555 Notion It automatically takes the word on the cursor position.
2558 \begin_layout Description
2559 Syntax index-insert [<TYPE:Name>]
2562 \begin_layout Description
2565 if multiple indices are defined.
2566 With an empty argument,
2567 the default index is selected.
2570 \begin_layout Description
2575 \begin_layout Subsection*
2579 \begin_layout Description
2580 Action Inserts list of Index entries on a new page.
2583 \begin_layout Description
2584 Syntax index-print [<TYPE:Name>]
2587 \begin_layout Description
2590 if multiple indices are defined.
2591 With an empty argument,
2592 the default index is selected.
2595 \begin_layout Description
2600 \begin_layout Subsection*
2604 \begin_layout Description
2605 Action Tags all occurrences of the word before the cursor with the index inset at cursor.
2608 \begin_layout Description
2609 Notion It automatically takes the word on the cursor position.
2612 \begin_layout Description
2613 Syntax index-tag-all
2616 \begin_layout Description
2621 \begin_layout Subsection*
2625 \begin_layout Description
2626 Action Inserts special Index macros into the document.
2629 \begin_layout Description
2630 Syntax indexmacro-insert <type>
2633 \begin_layout Description
2641 \begin_layout Description
2646 \begin_layout Subsection*
2650 \begin_layout Description
2651 Action Displays shortcuts,
2653 package and textclass availability and menu information in a non-editable boxed InsetText.
2656 \begin_layout Description
2657 Notion Apart from lfun arguments you can use the following method:
2658 \begin_inset Newline newline
2662 input the type and argument of this inset,
2666 \begin_inset Newline newline
2670 select the text and run info-insert lfun.
2673 \begin_layout Description
2674 Syntax info-insert <TYPE> <ARG>
2677 \begin_layout Description
2679 date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2680 \begin_inset Newline newline
2684 argument for a given type.
2685 Look into InsetInfo.h for detailed description.
2686 \begin_inset Newline newline
2690 current date (formatted and localized)
2691 \begin_inset Newline newline
2695 date of last modification (saving) (formatted and localized)
2696 \begin_inset Newline newline
2700 a static date (formatted and localized)
2701 \begin_inset Newline newline
2705 current time (formatted and localized)
2706 \begin_inset Newline newline
2710 time of last modification (saving) (formatted and localized)
2711 \begin_inset Newline newline
2715 a static time (formatted and localized)
2716 \begin_inset Newline newline
2720 name of lfun (e.g math-insert
2723 \begin_inset Newline newline
2727 name of rc_entry (e.g.
2729 \begin_inset Newline newline
2733 "version" - used version of LyX
2734 \begin_inset Newline newline
2738 name of latex package (e.g.
2740 \begin_inset Newline newline
2744 name of textclass (e.g.
2746 \begin_inset Newline newline
2750 name of lfun used in menu
2751 \begin_inset Newline newline
2756 \begin_inset Newline newline
2760 icon of lfun used in toolbar or direct icon name
2761 \begin_inset Newline newline
2765 "name"|"name-noext"|"path"|"class" vcs:
2766 "tree-revision"|"revision"|"author"|"date"|"time"
2769 \begin_layout Description
2770 Sample command-sequence info-insert buffer path;
2771 info-insert buffer name
2774 \begin_layout Description
2779 \begin_layout Subsection*
2783 \begin_layout Description
2784 Action Apply data for an inset.
2787 \begin_layout Description
2788 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied.
2789 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called.
2792 \begin_layout Description
2793 Syntax inset-apply <ARGS>
2796 \begin_layout Description
2797 Params See LFUN_INSET_INSERT .
2800 \begin_layout Subsection*
2804 \begin_layout Description
2805 Action Move the cursor to the beginning of the current inset if it is not already there.
2806 If the cursor is already at the beginning of the current inset,
2807 move it to the beginning of the enclosing inset or the main work area,
2809 if there is no enclosing inset.
2812 \begin_layout Description
2816 \begin_layout Description
2821 \begin_layout Subsection*
2825 \begin_layout Description
2826 Action Move the cursor to the beginning of the current inset if it is not already there.
2827 If the cursor is already at the beginning of the current inset,
2828 move it to the beginning of the enclosing inset or the main work area,
2830 if there is no enclosing inset (adding the traversed text to the selection).
2833 \begin_layout Description
2834 Syntax inset-begin-select
2837 \begin_layout Description
2842 \begin_layout Subsection*
2846 \begin_layout Description
2847 Action Copies the inset to the clipboard as a certain type.
2850 \begin_layout Description
2851 Notion Currently used only for InsetInfo where its content is copied as a text.
2854 \begin_layout Description
2855 Syntax inset-copy-as
2858 \begin_layout Description
2863 \begin_layout Subsection*
2867 \begin_layout Description
2868 Action Dissolve the current inset into text.
2871 \begin_layout Description
2872 Syntax inset-dissolve [<INSET>]
2875 \begin_layout Description
2877 this can be used to make sure the right kind of inset is dissolved.
2878 For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset,
2879 even if the cursor is inside several nested insets of different type.
2880 \begin_inset Newline newline
2883 For values see lyx::InsetLayout::lyxtype_ .
2886 \begin_layout Description
2891 \begin_layout Subsection*
2895 \begin_layout Description
2896 Action Edit the inset at cursor with an external application,
2897 if one is attributed.
2898 If the inset is file based,
2899 the referenced file is edited.
2901 the inset contents is written to a temporary file,
2902 the inset is locked,
2903 and the temporary file is edited.
2905 LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished.
2908 \begin_layout Description
2909 Syntax inset-edit [nogui] [<INSET_PARAMS>]
2912 \begin_layout Description
2913 Params <INSET_PARAMS>:
2914 Parameters for the inset.
2915 \begin_inset Newline newline
2918 Currently only the filename will be considered.
2919 \begin_inset Newline newline
2923 does not launch external editor,
2924 only returns filename to be processed.
2927 \begin_layout Description
2932 \begin_layout Subsection*
2936 \begin_layout Description
2937 Action Move the cursor to the end of the current inset if it is not already there.
2938 If the cursor is already at the end of the current inset,
2939 move it to the end of the enclosing inset or the main work area,
2941 if there is no enclosing inset.
2944 \begin_layout Description
2948 \begin_layout Description
2953 \begin_layout Subsection*
2957 \begin_layout Description
2958 Action End editing the inset at cursor with an external application.
2959 This replaces the inset contents with the contents of the temporary file,
2960 deletes the file and unlocks the inset.
2963 \begin_layout Description
2964 Syntax inset-end-edit
2967 \begin_layout Description
2972 \begin_layout Subsection*
2976 \begin_layout Description
2977 Action Move the cursor to the end of the current inset if it is not already there.
2978 If the cursor is already at the end of the current inset,
2979 move it to the end of the enclosing inset or the main work area,
2981 if there is no enclosing inset (adding the traversed text to the selection).
2984 \begin_layout Description
2985 Syntax inset-end-select
2988 \begin_layout Description
2993 \begin_layout Subsection*
2997 \begin_layout Description
2998 Action Apply the given commands on insets of a given name.
3001 \begin_layout Description
3003 use at your own risks;
3004 this function gives you too many ways of shooting yourself in the foot.
3005 A typical example is inset-forall Note note-insert which starts an infinite loop.
3006 This is mitigated by the fact that the number of actions is arbitrarily limited to 100000.
3007 Note also that inset-forall does not update metrics between iterations,
3008 which can lead to bugs.
3009 This has to be eventually fixed.
3012 \begin_layout Description
3013 Syntax inset-forall <NAME> <LFUN-COMMAND>
3014 \begin_inset Newline newline
3020 all insets are matched.
3021 The name is used like for InsetLayout in layout files:
3022 "Note" matches all note insets,
3023 while "Note:Note" only matches LyX yellow note insets.
3026 \begin_layout Description
3027 Sample Remove all index insets:
3028 \begin_inset Newline newline
3031 inset-forall Index char-delete-forward
3032 \begin_inset Newline newline
3036 \begin_inset Newline newline
3039 inset-forall Note inset-toggle close
3040 \begin_inset Newline newline
3043 Open all branch insets of branch "myBranch":
3044 \begin_inset Newline newline
3047 inset-forall Branch:myBranch inset-toggle open
3048 \begin_inset Newline newline
3051 Transform all yellow notes to comments
3052 \begin_inset Newline newline
3055 inset-forall Note:Note inset-modify note Note Comment
3056 \begin_inset Newline newline
3059 Try to put LyX in an infinite loop if there is at least a Note:
3060 \begin_inset Newline newline
3063 inset-forall Note char-backward
3066 \begin_layout Description
3071 \begin_layout Subsection*
3075 \begin_layout Description
3076 Action Insert new inset (type given by the parameters).
3079 \begin_layout Description
3080 Syntax inset-insert <INSET> <ARGS>
3083 \begin_layout Description
3085 <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
3086 \begin_inset Newline newline
3089 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
3090 \begin_inset Newline newline
3094 depends on the given inset.
3095 Use "lyx -dbg action" to explore.
3098 \begin_layout Description
3099 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3102 \begin_inset Newline newline
3105 where <label name> is the name of the referenced label and <Format> is one of the following:
3106 \begin_inset Newline newline
3110 \begin_inset Newline newline
3113 eqref -- (<reference>)
3114 \begin_inset Newline newline
3118 \begin_inset Newline newline
3121 vpageref -- on <page>
3122 \begin_inset Newline newline
3125 vref -- <reference> on <page>
3126 \begin_inset Newline newline
3129 formatted -- Formatted reference
3132 \begin_layout Subsection*
3136 \begin_layout Description
3137 Action Inserts the inset's content (in ToC pane) at the position of the cursor.
3140 \begin_layout Description
3141 Syntax inset-insert-copy
3144 \begin_layout Description
3149 \begin_layout Subsection*
3153 \begin_layout Description
3154 Action Modify some properties of an inset.
3157 \begin_layout Description
3158 Notion Used for argument,
3187 vspace and wrap insets.
3190 \begin_layout Description
3191 Syntax inset-modify <INSET> <ARGS>
3192 \begin_inset Newline newline
3195 inset-modify changetype <TYPE>
3198 \begin_layout Description
3199 Sample Change a Note inset into a Comment inset:
3200 \begin_inset Newline newline
3203 inset-modify note Note Comment
3204 \begin_inset Newline newline
3207 Change a Box into an Ovalbox:
3208 \begin_inset Newline newline
3211 inset-modify changetype Ovalbox
3212 \begin_inset Newline newline
3215 Change a quotation mark to e[nglish style],
3216 l[eft side = opening],
3219 \begin_inset Newline newline
3222 inset-modify changetype els
3223 \begin_inset Newline newline
3226 Change only the style of a quotation mark,
3227 maintaining the other aspects (.
3229 \begin_inset Newline newline
3232 inset-modify changetype e..
3233 \begin_inset Newline newline
3239 \begin_layout Subsection*
3243 \begin_layout Description
3244 Action Select all contents of an inset.
3247 \begin_layout Description
3248 Notion There are 3 successive levels:
3249 select current cell,
3250 select all cells of inset,
3251 select the inset from outside (in the enclosing inset).
3254 \begin_layout Description
3255 Syntax inset-select-all
3258 \begin_layout Description
3261 lasgouttes 1 Nov 2014
3264 \begin_layout Subsection*
3268 \begin_layout Description
3269 Action Open the inset's properties dialog.
3272 \begin_layout Description
3273 Notion Used for bibitem,
3298 \begin_layout Description
3299 Syntax inset-settings <INSET>
3302 \begin_layout Description
3304 <bibitem|bibtex|box|branch|citation|ert|external|float|
3305 \begin_inset Newline newline
3308 graphics|href|include|index|index_print|label|line|
3309 \begin_inset Newline newline
3312 listings|note|phantom|ref|space|tabular|vspace|wrap>.
3315 \begin_layout Subsection*
3319 \begin_layout Description
3320 Action Splits the current inset into two at current position.
3323 \begin_layout Description
3324 Syntax inset-split [<INSET>]
3327 \begin_layout Description
3329 this can be used to make sure the right kind of inset is dissolved.
3330 For example "split" entry in the charstyles sub-menu should only dissolve the charstyle inset,
3331 even if the cursor is inside several nested insets of different type.
3332 \begin_inset Newline newline
3335 For values see lyx::InsetLayout::lyxtype_ .
3338 \begin_layout Description
3343 \begin_layout Subsection*
3347 \begin_layout Description
3348 Action Toggles the collapsible inset at cursor position,
3349 or the inset we are currently in.
3352 \begin_layout Description
3353 Syntax inset-toggle [<ARG>]
3356 \begin_layout Description
3358 <open|close|toggle|assign>.
3359 \begin_inset Newline newline
3362 open/close/toggle are for collapsible insets.
3363 toggle is used when no argument is given.
3364 \begin_inset Newline newline
3367 assign synchronize the branch-inset with activation status of the branch.
3368 Used for global toggling when changed activation.
3371 \begin_layout Description
3376 \begin_layout Subsection*
3380 \begin_layout Description
3381 Action Inserts an IPA inset.
3384 \begin_layout Description
3388 \begin_layout Description
3393 \begin_layout Subsection*
3397 \begin_layout Description
3398 Action Inserts special IPA macros into the document.
3401 \begin_layout Description
3402 Syntax ipamacro-insert <CHAR>
3405 \begin_layout Description
3411 tone-high-rising-falling,
3416 \begin_layout Description
3421 \begin_layout Subsection*
3425 \begin_layout Description
3426 Action Turn off the loaded keyboard map.
3429 \begin_layout Description
3433 \begin_layout Subsection*
3437 \begin_layout Description
3438 Action Turn on the primary keyboard map.
3441 \begin_layout Description
3442 Notion Maps were widely used in past,
3443 when X-windows didn't have nowadays keyboard support.
3444 They can be still used to maintain uniform keyboard layout across the various platforms.
3445 \begin_inset Newline newline
3448 The language is to be set in the Preferences dialog.
3451 \begin_layout Description
3452 Syntax keymap-primary
3455 \begin_layout Subsection*
3459 \begin_layout Description
3460 Action Turn on the secondary keyboard map.
3463 \begin_layout Description
3464 Syntax keymap-secondary
3467 \begin_layout Subsection*
3471 \begin_layout Description
3472 Action Toggles keyboard maps (first/second/off).
3475 \begin_layout Description
3476 Syntax keymap-toggle
3479 \begin_layout Description
3484 \begin_layout Subsection*
3485 label-copy-as-reference
3488 \begin_layout Description
3489 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3492 \begin_layout Description
3493 Syntax copy-label-as-reference <LABEL>
3496 \begin_layout Description
3498 The label to copy (for multi-line math)
3501 \begin_layout Description
3506 \begin_layout Subsection*
3510 \begin_layout Description
3511 Action Goto a label.
3514 \begin_layout Description
3515 Syntax label-goto [<LABEL>]
3518 \begin_layout Description
3521 If no label is given and reference is on cursor position,
3522 Bookmark 0 is saved and cursor moves to the position of referenced label.
3525 \begin_layout Description
3530 \begin_layout Subsection*
3534 \begin_layout Description
3535 Action Inserts label to text or displayed formula.
3538 \begin_layout Description
3539 Syntax label-insert [<LABEL>]
3542 \begin_layout Description
3545 If no label is given dialog requesting name will be opened.
3548 \begin_layout Subsection*
3549 label-insert-as-reference
3552 \begin_layout Description
3553 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3556 \begin_layout Description
3557 Syntax label-insert-as-reference
3560 \begin_layout Description
3565 \begin_layout Subsection*
3569 \begin_layout Description
3570 Action Set language from the current cursor position.
3573 \begin_layout Description
3574 Syntax language <LANG> [set]
3577 \begin_layout Description
3580 Look in lib/languages for the list.
3581 "language reset" or "language" (without param) reset to the document language.
3584 the language will be set to the specified language.
3586 the language will be toggled (i.e.,
3587 if the current language is LANG,
3588 switch to the document language or the default language,
3589 if LANG is the document language).
3592 \begin_layout Description
3597 \begin_layout Subsection*
3601 \begin_layout Description
3602 Action Move the cursor to the beginning of the (screen) line.
3605 \begin_layout Description
3609 \begin_layout Subsection*
3613 \begin_layout Description
3614 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3617 \begin_layout Description
3618 Syntax line-begin-select
3621 \begin_layout Subsection*
3625 \begin_layout Description
3626 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3629 \begin_layout Description
3630 Syntax line-delete-forward
3633 \begin_layout Subsection*
3637 \begin_layout Description
3638 Action Move the cursor to the end of the (screen) line.
3641 \begin_layout Description
3645 \begin_layout Subsection*
3649 \begin_layout Description
3650 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3653 \begin_layout Description
3654 Syntax line-end-select
3657 \begin_layout Subsection*
3661 \begin_layout Description
3662 Action Inserts a new listings inset.
3665 \begin_layout Description
3666 Syntax listing-insert
3669 \begin_layout Description
3676 \begin_layout Subsection*
3680 \begin_layout Description
3681 Action Inserts a marginal note.
3684 \begin_layout Description
3685 Syntax marginalnote-insert
3688 \begin_layout Description
3693 \begin_layout Subsection*
3697 \begin_layout Description
3698 Action Disable selecting of text-region.
3701 \begin_layout Description
3705 \begin_layout Subsection*
3709 \begin_layout Description
3710 Action Enable selecting of text-region.
3713 \begin_layout Description
3714 Notion After enabling you can simply move arrow keys to get selected region.
3717 \begin_layout Description
3721 \begin_layout Subsection*
3725 \begin_layout Description
3726 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3729 \begin_layout Description
3733 \begin_layout Description
3738 \begin_layout Subsection*
3742 \begin_layout Description
3743 Action Inserts a line break or new line.
3746 \begin_layout Description
3747 Syntax newline-insert [<ARG>]
3750 \begin_layout Description
3752 <newline|linebreak> default:
3756 \begin_layout Description
3761 \begin_layout Subsection*
3765 \begin_layout Description
3766 Action Inserts a new page.
3769 \begin_layout Description
3770 Syntax newpage-insert <ARG>
3773 \begin_layout Description
3775 <newpage|pagebreak|clearpage|cleardoublepage> default:
3779 \begin_layout Description
3784 \begin_layout Subsection*
3788 \begin_layout Description
3789 Action Inserts Nomenclature entry.
3792 \begin_layout Description
3793 Notion It automatically takes the word on the cursor position if no symbol is given.
3796 \begin_layout Description
3797 Syntax nomencl-insert [<SYMBOL>]
3800 \begin_layout Description
3805 \begin_layout Subsection*
3809 \begin_layout Description
3810 Action Inserts list of Nomenclature entries.
3813 \begin_layout Description
3814 Syntax nomenclature-print
3817 \begin_layout Description
3822 \begin_layout Subsection*
3826 \begin_layout Description
3827 Action Inserts Note on the current cursor position,
3828 move selection inside the inset.
3831 \begin_layout Description
3832 Syntax note-insert [<TYPE>]
3835 \begin_layout Description
3837 <Note|Greyedout|Comment> default:
3841 \begin_layout Subsection*
3845 \begin_layout Description
3846 Action Moves the cursor to the beginning of next Note inset.
3849 \begin_layout Description
3853 \begin_layout Subsection*
3857 \begin_layout Description
3858 Action Move the current group in the downward direction in the structure of the document.
3861 \begin_layout Description
3862 Notion The "group" can be Part/Chapter/Section/etc.
3863 It moves the whole substructure of the group.
3866 \begin_layout Description
3870 \begin_layout Description
3875 \begin_layout Subsection*
3879 \begin_layout Description
3880 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3883 \begin_layout Description
3884 Notion Part -> Chapter -> Section -> etc.
3887 \begin_layout Description
3888 Syntax outline-in [local]
3891 \begin_layout Description
3894 only the current paragraph will be affected.
3897 \begin_layout Description
3902 \begin_layout Subsection*
3906 \begin_layout Description
3907 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3910 \begin_layout Description
3911 Notion Part <- Chapter <- Section <- etc.
3914 \begin_layout Description
3915 Syntax outline-out [local]
3918 \begin_layout Description
3921 only the current paragraph will be affected.
3924 \begin_layout Description
3929 \begin_layout Subsection*
3933 \begin_layout Description
3934 Action Move the current group in the upward direction in the structure of the document.
3937 \begin_layout Description
3938 Notion The "group" can be Part/Chapter/Section/etc.
3939 It moves the whole substructure of the group.
3942 \begin_layout Description
3946 \begin_layout Description
3951 \begin_layout Subsection*
3955 \begin_layout Description
3956 Action Breaks the current paragraph at the current location.
3959 \begin_layout Description
3960 Notion Removes the selection.
3963 \begin_layout Description
3964 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3967 \begin_layout Description
3969 "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3970 \begin_inset Newline newline
3974 Do not account for paragraph separators while breaking.
3977 \begin_layout Subsection*
3981 \begin_layout Description
3982 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3985 \begin_layout Description
3986 Syntax paragraph-down
3989 \begin_layout Description
3994 \begin_layout Subsection*
3995 paragraph-down-select
3998 \begin_layout Description
3999 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
4002 \begin_layout Description
4003 Syntax paragraph-down-select
4006 \begin_layout Description
4011 \begin_layout Subsection*
4015 \begin_layout Description
4016 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
4017 If given four arguments id_start,
4021 perform a selection from start to end.
4024 \begin_layout Description
4025 Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen.
4026 Moreover the id is unique for all opened buffers (documents).
4027 Both ids must belong to the same buffer.
4030 \begin_layout Description
4031 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
4034 \begin_layout Description
4037 \begin_inset Newline newline
4041 desired position within the paragraph
4044 \begin_layout Description
4050 \begin_layout Subsection*
4054 \begin_layout Description
4055 Action Moves the current paragraph downwards in the document.
4058 \begin_layout Description
4059 Syntax paragraph-move-down
4062 \begin_layout Description
4067 \begin_layout Subsection*
4071 \begin_layout Description
4072 Action Moves the current paragraph upwards in the document.
4075 \begin_layout Description
4076 Notion Movement through the document will possibly break the paragraph-depth (e.g.
4080 \begin_layout Description
4081 Syntax paragraph-move-up
4084 \begin_layout Description
4089 \begin_layout Subsection*
4093 \begin_layout Description
4094 Action Change paragraph settings.
4097 \begin_layout Description
4098 Notion Modifies the current paragraph,
4099 or currently selected paragraphs.
4100 This function only modifies,
4101 and does not override,
4103 Note that the "leftindent" indent setting is deprecated.
4106 \begin_layout Description
4107 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
4110 \begin_layout Description
4121 \begin_inset Newline newline
4127 paragraph_spacing default|single|onehalf|double|other SIZE
4128 \begin_inset Newline newline
4134 align block|left|right|center|default
4135 \begin_inset Newline newline
4141 labelwidthstring WIDTH|
4146 \begin_layout Description
4151 \begin_layout Subsection*
4152 paragraph-params-apply
4155 \begin_layout Description
4156 Action Change paragraph settings.
4159 \begin_layout Description
4160 Notion Overwrite all nonspecified settings to the default ones.
4161 Use paragraph-params lfun if you don't want to overwrite others settings.
4164 \begin_layout Description
4165 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
4168 \begin_layout Description
4169 Params For parameters see LFUN_PARAGRAPH_PARAMS
4172 \begin_layout Description
4177 \begin_layout Subsection*
4181 \begin_layout Description
4182 Action Move cursor to beginning of current paragraph and select to the end in downward direction
4185 \begin_layout Description
4186 Notion This function is by default bound to triple mouse click
4189 \begin_layout Description
4190 Syntax paragraph-select
4193 \begin_layout Description
4198 \begin_layout Subsection*
4202 \begin_layout Description
4203 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
4206 \begin_layout Description
4210 \begin_layout Description
4215 \begin_layout Subsection*
4219 \begin_layout Description
4220 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
4223 \begin_layout Description
4224 Syntax paragraph-up-select
4227 \begin_layout Description
4232 \begin_layout Subsection*
4236 \begin_layout Description
4237 Action Pastes material (text or picture) from the active clipboard.
4240 \begin_layout Description
4241 Syntax paste [<TYPE>|<NUM>]
4244 \begin_layout Description
4246 emf|pdf|png|jpeg|linkback|wmf|latex|html
4247 \begin_inset Newline newline
4251 number of the selection in the internal clipboard stack to be pasted.
4254 \begin_layout Subsection*
4258 \begin_layout Description
4259 Action Inserts phantom on the current cursor position,
4260 move selection inside the inset.
4263 \begin_layout Description
4264 Syntax phantom-insert [<TYPE>]
4267 \begin_layout Description
4269 <Phantom|HPhantom|VPhantom> default:
4273 \begin_layout Description
4278 \begin_layout Subsection*
4282 \begin_layout Description
4283 Action Inserts a new preview inset.
4286 \begin_layout Description
4287 Syntax preview-insert
4290 \begin_layout Description
4295 \begin_layout Subsection*
4296 primary-selection-paste
4299 \begin_layout Description
4300 Action Pastes the currently selected text.
4303 \begin_layout Description
4304 Notion Primary selection mechanism is X11/Wayland-only thing.
4307 \begin_layout Description
4308 Syntax primary-selection-paste [<ARG>]
4311 \begin_layout Description
4313 "paragraph" will cause pasting as one paragraph,
4318 \begin_layout Subsection*
4322 \begin_layout Description
4323 Action Inserts quotes according to the type and quote-language preference.
4326 \begin_layout Description
4327 Notion Currently 15 different quote styles are distinguished (see params).
4330 \begin_layout Description
4331 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
4334 \begin_layout Description
4338 usually single) quotes,
4339 otherwise outer (i.e.,
4341 usually double) quotes will be used.
4342 \begin_inset Newline newline
4346 'opening' for opening quotes,
4347 'closing' for closing quotes,
4348 otherwise the side will be guessed from the context.
4349 \begin_inset Newline newline
4353 'british' for `British' quote style (with ``inner quotation'')
4354 \begin_inset Newline newline
4357 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
4358 \begin_inset Newline newline
4361 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
4362 \begin_inset Newline newline
4365 'danish' for >>Danish<< quote style (with >inner quotation<)
4366 \begin_inset Newline newline
4369 'english' for ``English'' quote style (with `inner quotation')
4370 \begin_inset Newline newline
4373 'french' for <<french>> quote style (with ``inner quotation'')
4374 \begin_inset Newline newline
4377 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
4378 \begin_inset Newline newline
4381 'german' for ,,German`` quote style (with ,inner quotation`)
4382 \begin_inset Newline newline
4385 'hebrew' for ''hebrew,,
4386 quote style (with 'inner quotation,)
4387 \begin_inset Newline newline
4390 'plain' for "Plain" quote style (with 'inner quotation')
4391 \begin_inset Newline newline
4394 'polish' for ,,Polish'' quote style (with ,inner quotation')
4395 \begin_inset Newline newline
4398 'swedish' for ''Swedish'' quote style (with 'inner quotation')
4399 \begin_inset Newline newline
4402 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
4403 \begin_inset Newline newline
4406 'swiss' for <<Swiss>> quote style (with <inner quotation>)
4407 \begin_inset Newline newline
4410 'russian' for <<Russian>> quote style (with ,,inner quotation``)
4411 \begin_inset Newline newline
4414 'dynamic' for Dynamic quotation marks which inherit the global document style
4415 \begin_inset Newline newline
4418 If no quote style is specified,
4419 the document-wide will be used.
4422 \begin_layout Subsection*
4426 \begin_layout Description
4427 Action Redoes the last thing undone.
4430 \begin_layout Description
4434 \begin_layout Subsection*
4438 \begin_layout Description
4439 Action Go to the next label or cross-reference.
4442 \begin_layout Description
4443 Syntax reference-next
4446 \begin_layout Description
4451 \begin_layout Subsection*
4455 \begin_layout Description
4456 Action Repeat the given command.
4459 \begin_layout Description
4460 Notion fails when the repeat count is greater than 10000.
4463 \begin_layout Description
4464 Syntax repeat <COUNT> <LFUN-COMMAND>
4467 \begin_layout Description
4472 \begin_layout Subsection*
4476 \begin_layout Description
4477 Action Moves the cursor one page in downward direction.
4480 \begin_layout Description
4484 \begin_layout Subsection*
4488 \begin_layout Description
4489 Action Moves the cursor one screen in downward direction adding the current position to the selection.
4492 \begin_layout Description
4493 Syntax screen-down-select
4496 \begin_layout Subsection*
4500 \begin_layout Description
4501 Action Recenters the screen on the current cursor position.
4504 \begin_layout Description
4505 Syntax screen-recenter
4508 \begin_layout Subsection*
4512 \begin_layout Description
4513 Action Repositions the screen such that the cursor is visible.
4516 \begin_layout Description
4517 Syntax screen-show-cursor
4520 \begin_layout Description
4525 \begin_layout Subsection*
4529 \begin_layout Description
4530 Action Moves the cursor one page in upward direction.
4533 \begin_layout Description
4537 \begin_layout Subsection*
4541 \begin_layout Description
4542 Action Moves the cursor one page in upward direction adding the current position to the selection.
4545 \begin_layout Description
4546 Syntax screen-up-select
4549 \begin_layout Subsection*
4553 \begin_layout Description
4554 Action Inserts a subscript or superscript inset.
4557 \begin_layout Description
4558 Syntax script-insert <TYPE>
4561 \begin_layout Description
4563 subscript|superscript
4566 \begin_layout Description
4571 \begin_layout Subsection*
4575 \begin_layout Description
4576 Action Scroll the buffer view.
4579 \begin_layout Description
4580 Notion Only scrolls the screen up or down;
4581 does not move the cursor.
4584 \begin_layout Description
4585 Syntax scroll <TYPE> <QUANTITY>
4588 \begin_layout Description
4591 \begin_inset Newline newline
4598 \begin_layout Description
4603 \begin_layout Subsection*
4607 \begin_layout Description
4608 Action Set search string buffer.
4611 \begin_layout Description
4612 Syntax search-string-set [<DATA>]
4615 \begin_layout Description
4617 string to search for.
4618 If no parameter is given,
4619 use (word under) selection.
4622 \begin_layout Description
4628 \begin_layout Subsection*
4632 \begin_layout Description
4633 Action Select the whole section.
4636 \begin_layout Description
4637 Notion The cursor should be in a section heading before calling this lfun.
4640 \begin_layout Description
4641 Syntax section-select
4644 \begin_layout Description
4649 \begin_layout Subsection*
4653 \begin_layout Description
4654 Action Pastes the internal selection text in permanent selection.
4657 \begin_layout Description
4658 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ;
4659 primary-selection-paste paragraph).
4662 \begin_layout Description
4663 Syntax selection-paste
4666 \begin_layout Description
4671 \begin_layout Subsection*
4675 \begin_layout Description
4676 Action Inserts an environment separator or latex paragraph break.
4679 \begin_layout Description
4680 Syntax separator-insert [<ARG>]
4683 \begin_layout Description
4685 <plain|parbreak|latexpar> default:
4689 \begin_layout Description
4694 \begin_layout Subsection*
4698 \begin_layout Description
4699 Action Inserts one of horizontal space insets.
4702 \begin_layout Description
4703 Syntax space-insert <NAME> [<LEN>]
4706 \begin_layout Description
4725 \begin_inset Newline newline
4730 \begin_inset Newline newline
4734 length for custom spaces (hspace,
4735 hspace* for protected)
4738 \begin_layout Description
4744 \begin_layout Subsection*
4748 \begin_layout Description
4749 Action Inserts various characters into the document.
4752 \begin_layout Description
4753 Syntax specialchar-insert <CHAR>
4756 \begin_layout Description
4772 \begin_layout Description
4777 \begin_layout Subsection*
4781 \begin_layout Description
4782 Action Add the word under the cursor to the respective spell checker dictionary.
4783 The default for the language is retrieved from the cursor position.
4786 \begin_layout Description
4787 Syntax spelling-add [<STRING>] [<LANG>]
4790 \begin_layout Description
4793 \begin_inset Newline newline
4797 language name (see file languages)
4800 \begin_layout Description
4805 \begin_layout Subsection*
4809 \begin_layout Description
4810 Action Add the word under the cursor to the document's local spell checker dictionary.
4811 The default for the language is retrieved from the cursor position.
4814 \begin_layout Description
4815 Syntax spelling-add-local [<STRING>] [<LANG>]
4818 \begin_layout Description
4821 \begin_inset Newline newline
4825 language name (see file languages)
4828 \begin_layout Description
4833 \begin_layout Subsection*
4834 spelling-continuously
4837 \begin_layout Description
4838 Action Toggle continuous spell checking.
4841 \begin_layout Description
4842 Syntax spelling-continuously
4845 \begin_layout Description
4850 \begin_layout Subsection*
4854 \begin_layout Description
4855 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
4856 The default for the language is retrieved from the cursor position.
4859 \begin_layout Description
4860 Syntax spelling-ignore [<WORD>] [<LANG>]
4863 \begin_layout Description
4866 \begin_inset Newline newline
4870 language name (see file languages)
4873 \begin_layout Description
4878 \begin_layout Subsection*
4882 \begin_layout Description
4883 Action Remove the word under the cursor from the respective spell checker dictionary.
4884 The default for the language is retrieved from the cursor position.
4887 \begin_layout Description
4888 Syntax spelling-remove [<STRING>] [<LANG>]
4891 \begin_layout Description
4894 \begin_inset Newline newline
4898 language name (see file languages)
4901 \begin_layout Description
4906 \begin_layout Subsection*
4907 spelling-remove-local
4910 \begin_layout Description
4911 Action Remove the word under the cursor from the document's local spell checker dictionary.
4912 The default for the language is retrieved from the cursor position.
4915 \begin_layout Description
4916 Syntax spelling-remove-local [<STRING>] [<LANG>]
4919 \begin_layout Description
4922 \begin_inset Newline newline
4926 language name (see file languages)
4929 \begin_layout Description
4934 \begin_layout Subsection*
4938 \begin_layout Description
4939 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4942 \begin_layout Description
4943 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection.
4944 This is useful if you want to indent/unindent multiple lines in one action.
4947 \begin_layout Description
4951 \begin_layout Description
4956 \begin_layout Subsection*
4960 \begin_layout Description
4961 Action Insert a tab into a listings inset.
4964 \begin_layout Description
4965 Notion It also works on a selection.
4968 \begin_layout Description
4972 \begin_layout Description
4977 \begin_layout Subsection*
4981 \begin_layout Description
4982 Action Modify properties of tabulars and table-like math environments.
4985 \begin_layout Description
4986 Syntax tabular-feature <FEATURE> [<ARG>]
4989 \begin_layout Description
4990 Params Generally see LFUN_INSET_INSERT for further details.
4991 \begin_inset Newline newline
4995 append-row|append-column|delete-row|delete-column|copy-row|
4996 \begin_inset Newline newline
4999 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
5000 \begin_inset Newline newline
5003 set-line-top|set-line-bottom|set-line-left|set-line-right|
5004 \begin_inset Newline newline
5007 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
5008 \begin_inset Newline newline
5011 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
5012 \begin_inset Newline newline
5015 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
5016 \begin_inset Newline newline
5019 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
5020 \begin_inset Newline newline
5023 valign-top|valign-bottom|valign-middle|longtabular-align-left|
5024 \begin_inset Newline newline
5027 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
5028 \begin_inset Newline newline
5031 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
5032 \begin_inset Newline newline
5035 reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|
5036 \begin_inset Newline newline
5039 toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
5040 \begin_inset Newline newline
5043 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
5044 \begin_inset Newline newline
5047 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
5048 \begin_inset Newline newline
5051 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
5052 \begin_inset Newline newline
5055 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
5056 \begin_inset Newline newline
5059 set-special-column|set-special-multicolumn|set-special-multirow|
5060 \begin_inset Newline newline
5063 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
5064 \begin_inset Newline newline
5067 set-interline-space|tabular-valign-top|tabular-valign-middle|
5068 \begin_inset Newline newline
5071 tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|
5072 \begin_inset Newline newline
5075 set-border-lines|toggle-border-lines|set-inner-lines|toggle-inner-lines Various math-environment features are handled as well,
5077 add-vline-left/right for
5078 \begin_inset Newline newline
5081 the Grid/Array environment.
5082 \begin_inset Newline newline
5086 additional argument for some commands,
5087 use debug mode to explore its values.
5090 \begin_layout Description
5095 \begin_layout Subsection*
5099 \begin_layout Description
5100 Action Inserts table into the document.
5103 \begin_layout Description
5104 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
5107 \begin_layout Description
5108 Syntax tabular-insert [<ROWS> <COLUMNS>]
5111 \begin_layout Description
5112 Params In case no arguments are given show insert dialog.
5115 \begin_layout Description
5120 \begin_layout Subsection*
5121 tabular-style-insert
5124 \begin_layout Description
5125 Action Inserts table of a given style into the document.
5128 \begin_layout Description
5129 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
5132 \begin_layout Description
5133 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
5136 \begin_layout Description
5137 Params Valid styles are the names of the files in lib/tabletemplates,
5138 minus _1x<n> and .lyx suffix.
5141 \begin_layout Description
5146 \begin_layout Subsection*
5150 \begin_layout Description
5151 Action Look up thesaurus entries with respect to the word under the cursor.
5154 \begin_layout Description
5155 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
5158 \begin_layout Description
5161 \begin_inset Newline newline
5165 language (see file languages)
5168 \begin_layout Description
5173 \begin_layout Subsection*
5177 \begin_layout Description
5178 Action Undoes the last edit.
5181 \begin_layout Description
5185 \begin_layout Subsection*
5189 \begin_layout Description
5190 Action Inserts a single unicode character.
5193 \begin_layout Description
5194 Syntax unicode-insert <CHAR1> <CHAR2> ...
5197 \begin_layout Description
5199 The character to insert,
5200 given as its code point,
5204 \begin_layout Description
5205 Sample unicode-insert 0x0100 0x0259
5208 \begin_layout Description
5213 \begin_layout Subsection*
5217 \begin_layout Description
5218 Action Moves the cursor one line in upward direction.
5221 \begin_layout Description
5225 \begin_layout Subsection*
5229 \begin_layout Description
5230 Action Moves the cursor one line in upward direction adding the current position to the selection.
5233 \begin_layout Description
5237 \begin_layout Subsection*
5241 \begin_layout Description
5242 Action Moves the cursor to the logically previous beginning of a word.
5245 \begin_layout Description
5246 Notion This is not the action which should be bound to the arrow keys,
5247 because backwards may be left or right,
5248 depending on the language.
5249 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
5250 which in turn may employ this one.
5253 \begin_layout Description
5254 Syntax word-backward
5257 \begin_layout Subsection*
5258 word-backward-select
5261 \begin_layout Description
5262 Action Moves the cursor to the logically previous beginning of a word,
5263 adding the logically traversed text to the selection.
5266 \begin_layout Description
5267 Notion See also LFUN_WORD_BACKWARD.
5270 \begin_layout Description
5271 Syntax word-backward-select
5274 \begin_layout Subsection*
5278 \begin_layout Description
5279 Action Capitalizes the words in the selection (i.e.
5280 the first letters) or the first letter of word at cursor position.
5283 \begin_layout Description
5284 Syntax word-capitalize [<SEL_TYPE>]
5287 \begin_layout Description
5289 if this is equal to "partial",
5290 then the default word starts at cursor position (emacs-style).
5292 the whole word is considered.
5295 \begin_layout Subsection*
5296 word-delete-backward
5299 \begin_layout Description
5300 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
5303 \begin_layout Description
5304 Syntax word-delete-backward [confirm]
5307 \begin_layout Description
5310 do not directly delete them.
5313 \begin_layout Subsection*
5317 \begin_layout Description
5318 Action Deletes characters to the end of the word (usually the "C+Delete" key).
5321 \begin_layout Description
5322 Syntax word-delete-forward [confirm]
5325 \begin_layout Description
5328 do not directly delete them.
5331 \begin_layout Subsection*
5335 \begin_layout Description
5336 Action Search for next occurrence of a string.
5339 \begin_layout Description
5340 Syntax word-find [<DATA>]
5343 \begin_layout Description
5345 data encoded from Find dialog (see lyx::find2string()).
5346 If no parameter is given,
5347 search with last find-dialog data is used for search (i.e.
5351 \begin_layout Description
5356 \begin_layout Subsection*
5360 \begin_layout Description
5361 Action Search for a given string in backward direction.
5364 \begin_layout Description
5365 Notion Case sensitive,
5367 If no argument given,
5368 last search repeated.
5371 \begin_layout Description
5372 Syntax word-find-backward [<STRING>]
5375 \begin_layout Description
5380 \begin_layout Subsection*
5384 \begin_layout Description
5385 Action Search for a given string in forward direction.
5388 \begin_layout Description
5389 Notion Case sensitive,
5391 If no argument given,
5392 last search repeated.
5395 \begin_layout Description
5396 Syntax word-find-forward [<STRING>]
5399 \begin_layout Description
5404 \begin_layout Subsection*
5408 \begin_layout Description
5409 Action Search for next occurrence of a pattern.
5412 \begin_layout Description
5413 Syntax word-findadv [<DATA>]
5416 \begin_layout Description
5418 data encoded from FindAdv dialog (see lyx::findadv2string()).
5419 If no parameter is given,
5420 search with last find-dialog data is used for search (i.e.
5424 \begin_layout Description
5429 \begin_layout Subsection*
5433 \begin_layout Description
5434 Action Moves the cursor to the logically next beginning of a word.
5437 \begin_layout Description
5438 Notion This is not the action which should be bound to the arrow keys,
5439 because forward may be left or right,
5440 depending on the language.
5441 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
5442 which in turn may employ this one.
5445 \begin_layout Description
5449 \begin_layout Subsection*
5453 \begin_layout Description
5454 Action Moves the cursor to the logically next beginning of a word,
5455 adding the logically traversed text to the selection.
5458 \begin_layout Description
5459 Notion See also LFUN_WORD_FORWARD.
5462 \begin_layout Description
5463 Syntax word-forward-select
5466 \begin_layout Subsection*
5470 \begin_layout Description
5471 Action Moves the cursor to the next beginning of a word "on the left".
5474 \begin_layout Description
5475 Notion This is the action which should be taken when the (e.g.,
5476 ctrl-) "left" key is pressed.
5478 it moves the cursor to the next beginning of a word on the left.
5480 in Bidi text this become slightly more complicated,
5481 and there are different modes of cursor movement.
5486 movement is logically forward in RTL paragraphs,
5487 and logically backwards in LTR paragraphs.
5490 \begin_layout Description
5494 \begin_layout Description
5499 \begin_layout Subsection*
5503 \begin_layout Description
5504 Action Moves the cursor to the next beginning of a word "on the left",
5505 adding *logically* traversed text to the selection.
5508 \begin_layout Description
5509 Notion See also LFUN_WORD_LEFT for exact details of the movement.
5512 \begin_layout Description
5513 Syntax word-left-select
5516 \begin_layout Description
5521 \begin_layout Subsection*
5525 \begin_layout Description
5526 Action Change the words in the selection or word at cursor position to lower case.
5529 \begin_layout Description
5530 Syntax word-lowcase [<SEL_TYPE>]
5533 \begin_layout Description
5535 if this is equal to "partial",
5536 then the default word starts at cursor position (emacs-style).
5538 the whole word is considered.
5541 \begin_layout Subsection*
5545 \begin_layout Description
5546 Action Replace a string in the document.
5549 \begin_layout Description
5550 Syntax word-replace [<DATA>]
5553 \begin_layout Description
5555 data is of the form "<replacestring>
5556 \begin_inset Newline newline
5560 \begin_inset Newline newline
5563 <casesensitive> <matchword> <all> <forward> <findnext>"
5566 \begin_layout Description
5571 \begin_layout Subsection*
5575 \begin_layout Description
5576 Action Moves the cursor to the next beginning of a word "on the right".
5579 \begin_layout Description
5580 Notion This is the action which should be taken when the (e.g.,
5581 ctrl-) "right" key is pressed.
5583 it moves the cursor to the next beginning of a word on the right.
5585 in Bidi text this become slightly more complicated,
5586 and there are different modes of cursor movement.
5591 movement is logically forward in LTR paragraphs,
5592 and logically backwards in RTL paragraphs.
5595 \begin_layout Description
5599 \begin_layout Description
5604 \begin_layout Subsection*
5608 \begin_layout Description
5609 Action Moves the cursor to the next beginning of a word "on the right",
5610 adding *logically* traversed text to the selection.
5613 \begin_layout Description
5614 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
5617 \begin_layout Description
5618 Syntax word-right-select
5621 \begin_layout Description
5626 \begin_layout Subsection*
5630 \begin_layout Description
5631 Action Puts the word where the cursor stands into the selection.
5634 \begin_layout Description
5638 \begin_layout Description
5643 \begin_layout Subsection*
5647 \begin_layout Description
5648 Action Change the words in the selection or word at cursor position to upper case.
5651 \begin_layout Description
5652 Syntax word-upcase [<SEL_TYPE>]
5655 \begin_layout Description
5657 if this is equal to "partial",
5658 then the default word starts at cursor position (emacs-style).
5660 the whole word is considered.
5663 \begin_layout Subsection*
5667 \begin_layout Description
5668 Action Inserts floats wrapped by the text around.
5671 \begin_layout Description
5672 Syntax wrap-insert <TYPE>
5675 \begin_layout Description
5680 \begin_layout Description
5685 \begin_layout Section
5686 Math Editor Functions
5689 \begin_layout Subsection*
5690 in-mathmacrotemplate
5693 \begin_layout Description
5694 Action Only active in Math Macro definition.
5697 \begin_layout Description
5698 Notion Dummy function which is only active in a Math Macro definition.
5699 It's used to toggle the Math Macro toolbar if the cursor moves into a Math Macro definition.
5702 \begin_layout Description
5703 Syntax in-mathmacrotemplate
5706 \begin_layout Description
5711 \begin_layout Subsection*
5715 \begin_layout Description
5716 Action Inserts an extended matrix as provided by the amsmath package.
5719 \begin_layout Description
5720 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
5723 \begin_layout Description
5724 Params <DECORATION>:
5725 Decoration determines the LaTeX name of the matrix that should be created.
5726 Possible values include pmatrix,
5733 The default is 'matrix'.
5736 \begin_layout Description
5737 Sample math-ams-matrix 3 3 bmatrix
5740 \begin_layout Subsection*
5744 \begin_layout Description
5745 Action Inserts math fixed size delimiters (e.g.
5747 brackets) enclosing expression.
5750 \begin_layout Description
5751 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
5754 \begin_layout Description
5756 bigl/r|Bigl/r|biggl/r|Biggl/r
5757 \begin_inset Newline newline
5761 TeX code for delimiter.
5762 See Delimiter dialog for delimiters to be used.
5765 \begin_layout Description
5766 Sample math-bigdelim "Bigl" "
5773 \begin_layout Description
5774 Origin Enrico & Georg,
5778 \begin_layout Subsection*
5782 \begin_layout Description
5783 Action Inserts math delimiters (e.g.
5785 brackets) enclosing expression.
5788 \begin_layout Description
5789 Syntax math-delim [<LEFT>] [<RIGHT>]
5792 \begin_layout Description
5793 Params <LEFT/RIGHT>:
5794 Delimiters to be used.
5795 Each delimiter can be specified by either a LaTeX name or a valid character.
5796 ( is the default letter.
5799 \begin_layout Description
5800 Sample math-delim { rangle
5803 \begin_layout Description
5808 \begin_layout Subsection*
5812 \begin_layout Description
5813 Action Creates a new displayed equation in text mode.
5814 Toggles inlined/display formula in math mode.
5817 \begin_layout Description
5818 Syntax math-display [<ARG>]
5821 \begin_layout Description
5823 this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
5826 \begin_layout Description
5831 \begin_layout Subsection*
5835 \begin_layout Description
5836 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
5839 \begin_layout Description
5840 Notion Selection can be used to determine the input for the external program.
5843 \begin_layout Description
5844 Syntax math-extern <LANG> [<COMMAND>]
5847 \begin_layout Description
5849 octave|maxima|maple|mathematica|script
5850 \begin_inset Newline newline
5853 where "script" stands for the external script (normalized expression will be passed)
5856 \begin_layout Description
5857 Sample math-extern maple simplify
5860 \begin_layout Description
5865 \begin_layout Subsection*
5869 \begin_layout Description
5870 Action Changes the text style used in math.
5873 \begin_layout Description
5874 Syntax math-font-style <STYLE>
5877 \begin_layout Description
5879 mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
5880 \begin_inset Newline newline
5883 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
5886 \begin_layout Description
5891 \begin_layout Subsection*
5895 \begin_layout Description
5896 Action Inserts math objects and symbols.
5899 \begin_layout Description
5900 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
5903 the content of cell(0) is replaced by the current selection (only works if the selection is in mathed).
5905 if "abc" is selected in mathed,
5908 frac{x}{y}" replaces "abc" with "
5911 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
5912 If nothing is selected (or the selection is not in mathed),
5913 math-insert works as expected.
5916 \begin_layout Description
5917 Syntax math-insert <ARG>
5920 \begin_layout Description
5922 Symbol or LaTeX code to be inserted.
5925 \begin_layout Subsection*
5929 \begin_layout Description
5930 Action Toggles the position of the limits from above/below to the right side an vice versa in integral symbol,
5936 \begin_layout Description
5937 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
5940 \begin_layout Description
5941 Syntax math-limits [<STATE>]
5944 \begin_layout Description
5949 \begin_layout Subsection*
5953 \begin_layout Description
5954 Action Inserts a math macro definition at the cursor position in the text.
5957 \begin_layout Description
5958 Syntax math-macro <NAME> [<NARGS>] [def]
5961 \begin_layout Description
5963 The name of the macro,
5966 \begin_inset Newline newline
5970 The number of parameters of the macro.
5973 Has no effect anymore,
5974 just for compatibility with former LyX versions.
5977 \begin_layout Description
5984 \begin_layout Subsection*
5985 math-macro-add-greedy-optional-param
5988 \begin_layout Description
5989 Action Add a greedy optional parameter.
5992 \begin_layout Description
5993 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
5996 \begin_layout Description
5997 Syntax math-macro-add-greedy-optional-param
6000 \begin_layout Description
6005 \begin_layout Subsection*
6006 math-macro-add-optional-param
6009 \begin_layout Description
6010 Action Add an optional parameter.
6013 \begin_layout Description
6014 Notion Insert an optional parameter just behind the already existing optional parameters.
6017 \begin_layout Description
6018 Syntax math-macro-add-optional-param
6021 \begin_layout Description
6026 \begin_layout Subsection*
6027 math-macro-add-param
6030 \begin_layout Description
6031 Action Add a parameter.
6034 \begin_layout Description
6035 Notion Add a parameter to a Math Macro.
6038 \begin_layout Description
6039 Syntax math-macro-add-param <NUM>
6042 \begin_layout Description
6044 The number of the parameter behind which the new one will be added (1 for the first,
6046 use 0 for add a parameter at the left),
6047 defaults to the last one.
6050 \begin_layout Description
6055 \begin_layout Subsection*
6056 math-macro-append-greedy-param
6059 \begin_layout Description
6060 Action Append a greedy parameter.
6063 \begin_layout Description
6064 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
6067 \begin_layout Description
6068 Syntax math-macro-append-greedy-param
6071 \begin_layout Description
6076 \begin_layout Subsection*
6080 \begin_layout Description
6081 Action Fold a Math Macro.
6084 \begin_layout Description
6085 Notion Fold the Math Macro the cursor is in if it was unfolded,
6092 \begin_layout Description
6093 Syntax math-macro-fold
6096 \begin_layout Description
6101 \begin_layout Subsection*
6102 math-macro-make-nonoptional
6105 \begin_layout Description
6106 Action Make a parameter non-optional.
6109 \begin_layout Description
6110 Notion Turn the last optional parameter of a Math Macro into a non-optional parameter.
6111 The default value is remembered to be reused later if the user changes his mind.
6114 \begin_layout Description
6115 Syntax math-macro-make-nonoptional
6118 \begin_layout Description
6123 \begin_layout Subsection*
6124 math-macro-make-optional
6127 \begin_layout Description
6128 Action Make a parameter optional.
6131 \begin_layout Description
6132 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
6135 \begin_layout Description
6136 Syntax math-macro-make-optional
6139 \begin_layout Description
6144 \begin_layout Subsection*
6145 math-macro-remove-greedy-param
6148 \begin_layout Description
6149 Action Remove a greedy parameter.
6152 \begin_layout Description
6153 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.
6154 If it is an optional parameter the [valud] format is used.
6157 \begin_layout Description
6158 Syntax math-macro-remove-greedy-param
6161 \begin_layout Description
6166 \begin_layout Subsection*
6167 math-macro-remove-optional-param
6170 \begin_layout Description
6171 Action Remove the last optional parameter.
6174 \begin_layout Description
6175 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
6178 \begin_layout Description
6179 Syntax math-macro-remove-optional-param
6182 \begin_layout Description
6187 \begin_layout Subsection*
6188 math-macro-remove-param
6191 \begin_layout Description
6192 Action Remove the last parameter.
6195 \begin_layout Description
6196 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
6199 \begin_layout Description
6200 Syntax math-macro-remove-param <NUM>
6203 \begin_layout Description
6205 The number of the parameter to be deleted (1 for the first),
6206 defaults to the last one.
6209 \begin_layout Description
6214 \begin_layout Subsection*
6218 \begin_layout Description
6219 Action Unfold a Math Macro.
6222 \begin_layout Description
6223 Notion Unfold the Math Macro the cursor is in,
6230 \begin_layout Description
6231 Syntax math-macro-unfold
6234 \begin_layout Description
6239 \begin_layout Subsection*
6243 \begin_layout Description
6244 Action Inserts a matrix.
6247 \begin_layout Description
6248 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
6251 \begin_layout Description
6253 Alignment is a word composed of the vertical alignment (b,
6255 1 char) and the horizontal alignments (l,
6260 \begin_layout Description
6261 Sample math-matrix 3 3 bccc
6264 \begin_layout Subsection*
6268 \begin_layout Description
6269 Action In text mode enters math mode (i.e.
6270 puts math insets on the current cursor position),
6271 in math mode enters text mode inside math expression.
6274 \begin_layout Description
6275 Notion If there is some selected text,
6276 it puts the text inside created math box.
6279 \begin_layout Description
6280 Syntax math-mode [on|<ARG>]
6283 \begin_layout Description
6285 eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
6286 \begin_inset Newline newline
6290 allow only entering of math mode from text mode.
6293 \begin_layout Description
6298 \begin_layout Subsection*
6302 \begin_layout Description
6303 Action Mutates the type of math inset to the newly selected one.
6306 \begin_layout Description
6307 Syntax math-mutate <TYPE>
6310 \begin_layout Description
6312 none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
6315 \begin_layout Description
6320 \begin_layout Subsection*
6321 math-number-line-toggle
6324 \begin_layout Description
6325 Action Toggles numbering of the current formula line.
6328 \begin_layout Description
6329 Notion Must be in display formula mode.
6332 \begin_layout Description
6333 Syntax math-number-line-toggle
6336 \begin_layout Description
6341 \begin_layout Subsection*
6345 \begin_layout Description
6346 Action Toggles numbering/labeling of the current formula.
6349 \begin_layout Description
6350 Notion Must be in display formula mode.
6353 \begin_layout Description
6354 Syntax math-number-toggle
6357 \begin_layout Description
6362 \begin_layout Subsection*
6366 \begin_layout Description
6367 Action Changes arbitrarily the size used by math fonts inside a context.
6370 \begin_layout Description
6371 Notion Provides an interface to the LaTeX math mode font size commands.
6374 \begin_layout Description
6375 Syntax math-size <STYLE>
6378 \begin_layout Description
6391 \begin_layout Description
6398 \begin_layout Subsection*
6402 \begin_layout Description
6403 Action Inserts space into math expression.
6406 \begin_layout Description
6407 Notion Use spacebar after entering this space to change type of space.
6410 \begin_layout Description
6411 Syntax math-space [<TYPE>] [<LEN>]
6414 \begin_layout Description
6417 !|negthinspace|negmedspace|negthickspace
6418 \begin_inset Newline newline
6422 ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
6423 \begin_inset Newline newline
6428 \begin_inset Newline newline
6431 "," used by default.
6432 \begin_inset Newline newline
6436 is equivalent to negthinspace,
6443 \begin_inset Newline newline
6447 length for custom spaces (hspace)
6450 \begin_layout Description
6457 \begin_layout Subsection*
6461 \begin_layout Description
6462 Action Enters subscript expression in math expression.
6465 \begin_layout Description
6466 Syntax math-subscript
6469 \begin_layout Description
6474 \begin_layout Subsection*
6478 \begin_layout Description
6479 Action Enters superscript expression in math expression.
6482 \begin_layout Description
6483 Syntax math-superscript
6486 \begin_layout Description
6491 \begin_layout Subsection*
6495 \begin_layout Description
6496 Action Enters regexp mode (i.e.,
6497 puts regexp insets on the current cursor position).
6498 Used by the advanced search dialog.
6501 \begin_layout Description
6502 Notion If there is any selected text,
6503 then it is moved inside the created regexp inset.
6506 \begin_layout Description
6507 Syntax regexp-mode [<ARG>]
6510 \begin_layout Description
6512 eventual argument (regular expression).
6515 \begin_layout Description
6520 \begin_layout Section
6521 Buffer Fuctions (File and Window related)
6524 \begin_layout Subsection*
6528 \begin_layout Description
6529 Action Activate the branch.
6532 \begin_layout Description
6533 Syntax branch-activate <BRANCH>
6536 \begin_layout Description
6538 The branch to activate
6541 \begin_layout Description
6542 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6543 \begin_inset Newline newline
6546 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
6549 \begin_layout Description
6554 \begin_layout Subsection*
6558 \begin_layout Description
6559 Action Add a branch to the buffer's BranchList.
6562 \begin_layout Description
6563 Syntax branch-add <BRANCH>
6566 \begin_layout Description
6568 Name of the branch to add
6571 \begin_layout Description
6576 \begin_layout Subsection*
6580 \begin_layout Description
6581 Action Create new branch and directly put the branch inset into the document.
6584 \begin_layout Description
6585 Syntax branch-add-insert [<NAME>]
6588 \begin_layout Description
6591 If it is not specified,
6595 \begin_layout Description
6600 \begin_layout Subsection*
6604 \begin_layout Description
6605 Action De-activate the branch.
6608 \begin_layout Description
6609 Syntax branch-deactivate <BRANCH>
6612 \begin_layout Description
6614 The branch to deactivate
6617 \begin_layout Description
6622 \begin_layout Subsection*
6626 \begin_layout Description
6627 Action Toggles inversion status of branch inset.
6630 \begin_layout Description
6631 Syntax branch-invert
6634 \begin_layout Description
6639 \begin_layout Subsection*
6640 branch-master-activate
6643 \begin_layout Description
6644 Action Activate the branch in the master buffer.
6647 \begin_layout Description
6648 Syntax branch-master-activate <BRANCH>
6651 \begin_layout Description
6653 The branch to activate
6656 \begin_layout Description
6657 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6658 \begin_inset Newline newline
6661 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
6664 \begin_layout Description
6669 \begin_layout Subsection*
6670 branch-master-deactivate
6673 \begin_layout Description
6674 Action De-activate the branch in the master buffer.
6677 \begin_layout Description
6678 Syntax branch-master-deactivate <BRANCH>
6681 \begin_layout Description
6683 The branch to deactivate
6686 \begin_layout Description
6691 \begin_layout Subsection*
6695 \begin_layout Description
6696 Action Open/close all insets of selected branch (depending on its activation status).
6699 \begin_layout Description
6700 Syntax branch-sync-all
6703 \begin_layout Description
6708 \begin_layout Subsection*
6712 \begin_layout Description
6713 Action Rename all branches of a given name in a document.
6716 \begin_layout Description
6717 Syntax branches-rename <OLDNAME> <NEWNAME>
6720 \begin_layout Description
6722 Current name of the branch to be renamed <NEWNAME>:
6723 New name of the branch
6726 \begin_layout Description
6731 \begin_layout Subsection*
6735 \begin_layout Description
6736 Action Saves the current buffer to a temporary file.
6739 \begin_layout Description
6740 Notion Saves the current buffer to a file named "#filename#".
6741 This LFUN is called automatically by LyX,
6742 to "autosave" the current buffer.
6745 \begin_layout Description
6746 Syntax buffer-auto-save
6749 \begin_layout Subsection*
6753 \begin_layout Description
6754 Action Loads the given child document.
6757 \begin_layout Description
6758 Notion The current document is treated as a parent.
6761 \begin_layout Description
6762 Syntax buffer-child-open <FILE>
6765 \begin_layout Description
6767 Filename of the child.
6768 The directory of the parent is assumed by default.
6771 \begin_layout Description
6776 \begin_layout Subsection*
6780 \begin_layout Description
6781 Action Runs chktex for the current document.
6784 \begin_layout Description
6785 Syntax buffer-chktex
6788 \begin_layout Description
6793 \begin_layout Subsection*
6797 \begin_layout Description
6798 Action Closes the current buffer.
6801 \begin_layout Description
6802 Notion Closes the current buffer,
6803 asking whether to save it,
6805 if the buffer has been modified.
6808 \begin_layout Description
6812 \begin_layout Subsection*
6816 \begin_layout Description
6817 Action Closes all buffers.
6820 \begin_layout Description
6821 Notion Closes all buffers,
6822 asking whether to save it,
6824 if a buffer has been modified.
6827 \begin_layout Description
6828 Syntax buffer-close-all
6831 \begin_layout Subsection*
6835 \begin_layout Description
6836 Action Exports the current buffer (document) to the given format.
6839 \begin_layout Description
6840 Syntax buffer-export [<FORMAT>] [<DEST>]
6843 \begin_layout Description
6844 Params <FORMAT> is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format.
6845 Usual format you will enter is "pdf2" (pdflatex),
6846 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
6847 \begin_inset Newline newline
6850 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.
6851 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
6852 \begin_inset Newline newline
6855 If absent or "default",
6856 then the default output format of the document is used.
6857 \begin_inset Newline newline
6861 this argument provides the export destination filename.
6862 Its containing folder will also be the destination folder,
6863 where all the needed external files will be copied.
6866 \begin_layout Description
6871 \begin_layout Subsection*
6875 \begin_layout Description
6876 Action Opens a dialog for exporting the current buffer.
6879 \begin_layout Description
6880 Syntax buffer-export-as [<FORMAT>]
6883 \begin_layout Description
6884 Params <FORMAT> is the export format initially selected in the dialog.
6885 You can pass any of the formats which you can find in Tools->Preferences->File formats->Format,
6886 provided it has the "document" flag set.
6887 If no format is specified the dialog will start with the default output format of the current document.
6890 \begin_layout Description
6891 Sample buffer-export-as pdf2
6894 \begin_layout Description
6899 \begin_layout Subsection*
6900 buffer-export-custom
6903 \begin_layout Description
6904 Action Exports the current buffer (document) from the given format using the given command on it.
6907 \begin_layout Description
6908 Syntax buffer-export-custom <FORMAT> <COMMAND>
6911 \begin_layout Description
6912 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
6913 \begin_inset Newline newline
6916 <COMMAND> this command will be launched on the file.
6917 Note that you can use "$$FName" string to qualify the intermediate file.
6920 \begin_layout Description
6921 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6924 \begin_layout Description
6929 \begin_layout Subsection*
6930 buffer-external-modification-clear
6933 \begin_layout Description
6934 Action Clear the external modification flag on the current buffer.
6937 \begin_layout Description
6938 Syntax buffer-external-modification-clear
6941 \begin_layout Description
6946 \begin_layout Subsection*
6950 \begin_layout Description
6951 Action Applies a command to all non-hidden buffers.
6954 \begin_layout Description
6955 Notion a buffer is `hidden' if it is internally open in LyX,
6956 but not visible in any window.
6959 \begin_layout Description
6960 Syntax buffer-forall <LFUN-COMMAND>
6963 \begin_layout Description
6964 Params <LFUN-COMMAND>:
6965 The command to be applied to the buffers.
6968 \begin_layout Description
6969 Sample Close all Notes in all buffers:
6970 \begin_inset Newline newline
6973 buffer-forall inset-forall Note inset-toggle close
6974 \begin_inset Newline newline
6977 Toggle change tracking on buffers:
6978 \begin_inset Newline newline
6981 buffer-forall changes-track
6982 \begin_inset Newline newline
6985 Toggle read-only for buffers:
6986 \begin_inset Newline newline
6989 buffer-forall buffer-toggle-read-only
6990 \begin_inset Newline newline
6993 Show statistics for individual buffers:
6994 \begin_inset Newline newline
6997 buffer-forall statistics
6998 \begin_inset Newline newline
7001 Activate the branch named "Solutions" in buffers:
7002 \begin_inset Newline newline
7005 buffer-forall branch-activate Solutions
7006 \begin_inset Newline newline
7009 Export buffers to PDF (pdflatex):
7010 \begin_inset Newline newline
7013 buffer-forall buffer-export pdf2
7014 \begin_inset Newline newline
7020 \begin_layout Description
7025 \begin_layout Subsection*
7029 \begin_layout Description
7030 Action Import a given file as a lyx document.
7033 \begin_layout Description
7034 Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences.
7035 Look in the File->Import menu to get an idea of the currently active import formats.
7038 \begin_layout Description
7039 Syntax buffer-import <FORMAT> [<FILE>]
7042 \begin_layout Description
7047 \begin_layout Subsection*
7051 \begin_layout Description
7052 Action Set language of the current document.
7055 \begin_layout Description
7056 Syntax buffer-language <LANG>
7059 \begin_layout Description
7062 See lib/languages for list.
7065 \begin_layout Description
7070 \begin_layout Subsection*
7074 \begin_layout Description
7075 Action Moves the current tab one spot to the right.
7078 \begin_layout Description
7079 Syntax buffer-move-next
7082 \begin_layout Description
7087 \begin_layout Subsection*
7088 buffer-move-previous
7091 \begin_layout Description
7092 Action Moves the current tab one spot to the left.
7095 \begin_layout Description
7096 Syntax buffer-move-previous
7099 \begin_layout Description
7104 \begin_layout Subsection*
7108 \begin_layout Description
7109 Action Creates a new buffer (that is,
7110 document) and switches to it.
7113 \begin_layout Description
7114 Notion Implicit path can be set in Preferences dialog.
7117 \begin_layout Description
7118 Syntax buffer-new [<FILE>]
7121 \begin_layout Description
7123 filename of created file with absolute path.
7126 \begin_layout Subsection*
7130 \begin_layout Description
7131 Action Creates a new buffer (that is,
7132 document) from a template.
7135 \begin_layout Description
7136 Notion Path for new files and templates can be set in Preferences dialog.
7137 Template will be asked for via Open-dialog.
7140 \begin_layout Description
7141 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
7144 \begin_layout Description
7146 filename of created file with absolute path.
7147 If empty or "newfile",
7148 a file with appropriate name is generated.
7149 \begin_inset Newline newline
7153 filename of template with absolute path.
7155 a dialog is opened to select the new file.
7158 \begin_layout Subsection*
7162 \begin_layout Description
7163 Action Switch to the next opened document.
7166 \begin_layout Description
7167 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
7170 \begin_layout Description
7174 \begin_layout Subsection*
7178 \begin_layout Description
7179 Action Apply the given settings to the current document.
7182 \begin_layout Description
7183 Syntax buffer-params-apply [<ARGS>]
7186 \begin_layout Description
7188 contains the particular settings to be saved.
7189 They obey the syntax you can find in document header of usual .lyx file.
7192 \begin_layout Description
7197 \begin_layout Subsection*
7201 \begin_layout Description
7202 Action Switch to the previous opened document.
7205 \begin_layout Description
7206 Syntax buffer-previous
7209 \begin_layout Subsection*
7213 \begin_layout Description
7214 Action Reverts opened document.
7217 \begin_layout Description
7218 Syntax buffer-reload [dump]
7221 \begin_layout Description
7223 do not ask for any confirmation,
7225 All changes will be lost.
7228 \begin_layout Description
7233 \begin_layout Subsection*
7237 \begin_layout Description
7238 Action Removes the auxiliary file before next export to assure export is done afresh.
7241 \begin_layout Description
7242 Syntax buffer-reset-export
7245 \begin_layout Description
7250 \begin_layout Subsection*
7251 buffer-save-as-default
7254 \begin_layout Description
7255 Action Save the current document settings as default.
7258 \begin_layout Description
7259 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
7262 \begin_layout Description
7263 Syntax buffer-save-as-default [<ARGS>]
7266 \begin_layout Description
7268 contains the particular settings to be saved.
7269 They obey the syntax you can find in document header of usual .lyx file.
7272 \begin_layout Description
7277 \begin_layout Subsection*
7281 \begin_layout Description
7282 Action Display and switch to the given buffer.
7285 \begin_layout Description
7286 Syntax buffer-switch <BUFFER>
7289 \begin_layout Description
7291 path and filename of already opened (but possibly hidden) document which is to be shown.
7294 \begin_layout Subsection*
7295 buffer-toggle-compression
7298 \begin_layout Description
7299 Action Toggles compression of the current document on/off.
7302 \begin_layout Description
7303 Syntax buffer-toggle-compression
7306 \begin_layout Description
7311 \begin_layout Subsection*
7312 buffer-toggle-read-only
7315 \begin_layout Description
7316 Action Toggle editing mode of the current document between read/write and read-only.
7319 \begin_layout Description
7320 Notion This function is not allowed if the file is under version control,
7321 since read-only flag is often used in version control file locking.
7324 \begin_layout Description
7325 Syntax buffer-toggle-read-only
7328 \begin_layout Description
7333 \begin_layout Subsection*
7337 \begin_layout Description
7338 Action Exports the current document and put the result into the temporary directory.
7341 \begin_layout Description
7342 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated.
7343 This is useful in case your viewer is able to detect such changes (e.g.
7344 ghostview for postscript).
7347 \begin_layout Description
7348 Syntax buffer-update [<FORMAT>]
7351 \begin_layout Description
7353 The format to display,
7354 where this is one of the formats defined in the Tools>Preferences>File Formats dialog,
7355 use the "Short name" field.
7356 If no format is given,
7357 the default format as specified in the same dialog is used.
7360 \begin_layout Description
7365 \begin_layout Subsection*
7369 \begin_layout Description
7370 Action Displays current buffer in chosen format.
7373 \begin_layout Description
7374 Notion Displays the contents of the current buffer in the chosen format,
7377 This runs the necessary converter,
7378 calls the defined viewer,
7382 \begin_layout Description
7383 Syntax buffer-view [<FORMAT>]
7386 \begin_layout Description
7388 The format to display,
7389 where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7390 If no format is given,
7391 the default format as specified in the same dialog is used.
7394 \begin_layout Subsection*
7398 \begin_layout Description
7399 Action Opens the file that was created from last preview of this buffer.
7402 \begin_layout Description
7403 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog.
7404 It can also be called by the user,
7405 which is useful if the document takes a long time to compile,
7406 and you just want to see the last previewed version.
7409 \begin_layout Description
7410 Syntax buffer-view-cache
7413 \begin_layout Subsection*
7417 \begin_layout Description
7418 Action Saves the current buffer.
7421 \begin_layout Description
7422 Notion Saves the current buffer to disk,
7423 using the filename that is already associated with the buffer,
7424 asking for one if none is yet assigned.
7427 \begin_layout Description
7428 Syntax buffer-write [force]
7431 \begin_layout Description
7433 write even if buffer is not marked as modified.
7436 \begin_layout Subsection*
7440 \begin_layout Description
7441 Action Save all changed documents.
7444 \begin_layout Description
7445 Syntax buffer-write-all
7448 \begin_layout Description
7453 \begin_layout Subsection*
7457 \begin_layout Description
7458 Action Rename and save current buffer.
7461 \begin_layout Description
7462 Syntax buffer-write-as <FILENAME>
7465 \begin_layout Description
7467 New name of the buffer/file.
7468 A relative path is with respect to the original location of the buffer/file.
7471 \begin_layout Subsection*
7472 buffer-write-as-template
7475 \begin_layout Description
7476 Action Rename and save current buffer in the local templates directory.
7479 \begin_layout Description
7480 Syntax buffer-write-as-template <FILENAME>
7483 \begin_layout Description
7485 New name of the buffer/file.
7486 A relative path is with respect to the original location of the buffer/file.
7489 \begin_layout Subsection*
7493 \begin_layout Description
7494 Action Sets the zoom of the screen fonts.
7497 \begin_layout Description
7498 Syntax buffer-zoom [<ZOOM>]
7501 \begin_layout Description
7503 The target zoom value in %;
7504 the default is the default zoom as saved in preferences.
7507 \begin_layout Description
7512 \begin_layout Subsection*
7516 \begin_layout Description
7517 Action Increases the zoom of the screen fonts.
7520 \begin_layout Description
7521 Syntax buffer-zoom-in [<ZOOM>]
7524 \begin_layout Description
7526 The zoom value addition in % (neg.
7528 the default is 10% of the default zoom as saved in preferences.
7531 \begin_layout Description
7536 \begin_layout Subsection*
7540 \begin_layout Description
7541 Action Decreases the zoom of the screen fonts.
7544 \begin_layout Description
7545 Syntax buffer-zoom-out [<ZOOM>]
7548 \begin_layout Description
7550 The zoom value abstraction in % (neg.
7552 the default is 10% of the default zoom as saved in preferences.
7555 \begin_layout Description
7560 \begin_layout Subsection*
7564 \begin_layout Description
7565 Action Generates the code (literate programming).
7568 \begin_layout Description
7569 Notion Latex file with extension
7571 literate_extension is generated.
7574 build_command (with a default of ``make'') to generate the code and
7576 build_error_filter to process the compilation error messages.
7577 \begin_inset Newline newline
7580 In case you want to process your literate file with a script,
7581 or some other program,
7582 just insert in your lyxrc file an entry with:
7583 \begin_inset Newline newline
7588 build_command "my_script my_arguments"
7589 \begin_inset Newline newline
7594 build_error_filter differs from the
7596 literate_error_filter only in that the former will identify error messages from your compiler.
7599 \begin_layout Description
7600 Syntax build-program
7603 \begin_layout Subsection*
7607 \begin_layout Description
7608 Action Open LyX document.
7611 \begin_layout Description
7612 Syntax file-open [<FILE>]
7615 \begin_layout Description
7617 Filename to be opened.
7620 \begin_layout Subsection*
7624 \begin_layout Description
7625 Action Open the given help file according to the language setting.
7628 \begin_layout Description
7629 Syntax help-open <FILE>[.lyx]
7632 \begin_layout Description
7634 any document from (/usr/share/)doc directory.
7637 \begin_layout Description
7642 \begin_layout Subsection*
7646 \begin_layout Description
7647 Action Sets icon size of toolbars.
7650 \begin_layout Description
7651 Syntax icon-size [<SIZE>]
7654 \begin_layout Description
7656 the icon size in px or one of the logical settings small|normal|big|huge|giant,
7657 the default is normal (whose size in px is icon set dependent).
7660 \begin_layout Description
7664 \begin_layout Subsection*
7668 \begin_layout Description
7669 Action Helper function for master-related actions
7672 \begin_layout Description
7674 the function will be disabled if the buffer has no master or children.
7675 It thus allows to enable actions only in documents with master/children
7678 \begin_layout Description
7679 Syntax ifrelatives <ACTION>
7682 \begin_layout Description
7687 \begin_layout Subsection*
7691 \begin_layout Description
7692 Action Terminates the current LyX instance.
7695 \begin_layout Description
7696 Notion Terminates the current LyX instance,
7697 asking whether to save modified documents,
7701 \begin_layout Description
7705 \begin_layout Subsection*
7709 \begin_layout Description
7710 Action Open lyxfiles (templates/examples).
7711 Create a view if he have none.
7714 \begin_layout Description
7715 Syntax lyxfiles-open [<TYPE>]
7718 \begin_layout Description
7720 templates or examples.
7721 Default is templates.
7724 \begin_layout Description
7729 \begin_layout Subsection*
7730 master-buffer-export
7733 \begin_layout Description
7734 Action Exports the master buffer (document) to the given format.
7737 \begin_layout Description
7738 Syntax master-buffer-export [<FORMAT>] [<DEST>]
7741 \begin_layout Description
7742 Params <FORMAT> is one of the formats which you can find in Tools->Preferences->File formats->Format.
7743 Usual format you will enter is "pdf2" (pdflatex),
7744 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
7745 \begin_inset Newline newline
7748 Note that "custom" is not allowed in this case.
7749 \begin_inset Newline newline
7752 If absent or "default",
7753 then the default output format of the document is used.
7754 \begin_inset Newline newline
7758 this argument provides the export destination filename.
7759 Its containing folder will also be the destination folder,
7760 where all the needed external files will be copied.
7763 \begin_layout Description
7768 \begin_layout Subsection*
7769 master-buffer-forall
7772 \begin_layout Description
7773 Action Applies a command to a buffer and all it children,
7774 starting from the master.
7777 \begin_layout Description
7778 Syntax master-buffer-forall <LFUN-COMMAND>
7781 \begin_layout Description
7782 Params <LFUN-COMMAND>:
7783 The command to be applied to the buffers.
7786 \begin_layout Description
7787 Sample Close all Notes in buffers:
7788 \begin_inset Newline newline
7791 master-buffer-forall inset-forall Note inset-toggle close
7792 \begin_inset Newline newline
7795 Toggle change tracking on buffers:
7796 \begin_inset Newline newline
7799 master-buffer-forall changes-track
7800 \begin_inset Newline newline
7803 Toggle read-only for buffers:
7804 \begin_inset Newline newline
7807 master-buffer-forall buffer-toggle-read-only
7808 \begin_inset Newline newline
7811 Show statistics for individual buffers:
7812 \begin_inset Newline newline
7815 master-buffer-forall statistics
7816 \begin_inset Newline newline
7819 Activate the branch named "Solutions" in buffers:
7820 \begin_inset Newline newline
7823 master-buffer-forall branch-activate Solutions
7824 \begin_inset Newline newline
7830 \begin_layout Description
7835 \begin_layout Subsection*
7836 master-buffer-update
7839 \begin_layout Description
7840 Action Update (export) the document built from the master buffer,
7841 if the current buffer is part of a master/child document.
7844 \begin_layout Description
7845 Syntax master-buffer-update [<FORMAT>]
7848 \begin_layout Description
7850 The format to display,
7851 where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7852 If no format is given,
7853 the default format as specified in the same dialog is used.
7856 \begin_layout Description
7861 \begin_layout Subsection*
7865 \begin_layout Description
7866 Action Show a preview built from the master buffer,
7868 if the current buffer is part of a master/child document.
7871 \begin_layout Description
7872 Syntax master-buffer-view [<FORMAT>]
7875 \begin_layout Description
7877 The format to display,
7878 where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7879 If no format is given,
7880 the default format as specified in the same dialog is used.
7883 \begin_layout Description
7888 \begin_layout Subsection*
7892 \begin_layout Description
7893 Action Opens the menu given by its name.
7896 \begin_layout Description
7897 Syntax menu-open <NAME>
7900 \begin_layout Description
7903 See various .inc files in lib/ui for candidates.
7906 \begin_layout Subsection*
7910 \begin_layout Description
7911 Action Close the current tab group.
7914 \begin_layout Description
7915 Notion This only closes the work areas,
7916 not the buffers themselves.
7917 The still opened buffers can be visualized in another tab group.
7920 \begin_layout Description
7921 Syntax tab-group-close
7924 \begin_layout Description
7929 \begin_layout Subsection*
7933 \begin_layout Description
7934 Action Switch to the next tab group in split view.
7937 \begin_layout Description
7938 Syntax tab-group-next
7941 \begin_layout Subsection*
7945 \begin_layout Description
7946 Action Switch to the previous tab group in split view.
7949 \begin_layout Description
7950 Syntax tab-group-previous
7953 \begin_layout Subsection*
7957 \begin_layout Description
7958 Action Toggles movability of a given toolbar between true/false.
7961 \begin_layout Description
7962 Syntax toolbar-movable <NAME>
7965 \begin_layout Description
7967 *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
7970 \begin_layout Description
7975 \begin_layout Subsection*
7979 \begin_layout Description
7980 Action Sets visibility of a given toolbar to on,
7985 \begin_layout Description
7986 Notion Skipping "auto" when allowauto is false.
7989 \begin_layout Description
7990 Syntax toolbar-set <NAME> [on|off|auto]
7993 \begin_layout Description
7995 standard|extra|table|math|mathmacrotemplate|
7996 \begin_inset Newline newline
7999 minibuffer|review|view/update|math_panels|vcs|
8000 \begin_inset Newline newline
8003 view-others|update-others
8006 \begin_layout Description
8011 \begin_layout Subsection*
8015 \begin_layout Description
8016 Action Toggles visibility of a given toolbar between on/off/auto.
8019 \begin_layout Description
8020 Notion Skipping "auto" when allowauto is false.
8023 \begin_layout Description
8024 Syntax toolbar-toggle <NAME> [allowauto]
8027 \begin_layout Description
8029 standard|extra|table|math|mathmacrotemplate|
8030 \begin_inset Newline newline
8033 minibuffer|review|view/update|math_panels|vcs|
8034 \begin_inset Newline newline
8037 view-others|update-others
8040 \begin_layout Description
8045 \begin_layout Subsection*
8049 \begin_layout Description
8050 Action Various UI visibility-toggling actions.
8053 \begin_layout Description
8054 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
8057 \begin_layout Description
8059 Toggle visibility of the statusbar.
8060 \begin_inset Newline newline
8064 Toggle visibility of the menubar.
8065 \begin_inset Newline newline
8069 Toggle visibility of the scrollbar.
8070 \begin_inset Newline newline
8074 Toggle visibility of the frames around editing window.
8075 \begin_inset Newline newline
8079 Toggle visibility of the zoom slider in statusbar.
8080 \begin_inset Newline newline
8084 Toggle visibility of the zoom level display in statusbar.
8085 \begin_inset Newline newline
8089 Toggle visibility of the document word count in statusbar.
8090 \begin_inset Newline newline
8094 Toggle visibility of the document character count (incl.
8095 blanks) in statusbar.
8096 \begin_inset Newline newline
8100 Toggle visibility of the document character count (excl.
8101 blanks) in statusbar.
8102 \begin_inset Newline newline
8106 Toggle fullscreen mode.
8107 This also covers calling the previous functions.
8108 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
8111 \begin_layout Description
8116 \begin_layout Subsection*
8120 \begin_layout Description
8121 Action Close the current document work area.
8124 \begin_layout Description
8125 Notion Close the current work area.
8126 If no other work areas are showing the buffer,
8127 then close the associated buffer as well.
8130 \begin_layout Description
8134 \begin_layout Description
8139 \begin_layout Subsection*
8143 \begin_layout Description
8144 Action Creates another split view of current buffer.
8147 \begin_layout Description
8148 Notion All split views act in the same way independently.
8151 \begin_layout Description
8152 Syntax view-split <vertical|horizontal>
8155 \begin_layout Description
8157 The work areas are laid out side by side.
8158 \begin_inset Newline newline
8162 The work areas laid out vertically.
8165 \begin_layout Description
8170 \begin_layout Subsection*
8174 \begin_layout Description
8175 Action Closes the current LyX window.
8178 \begin_layout Description
8182 \begin_layout Description
8187 \begin_layout Subsection*
8191 \begin_layout Description
8192 Action Creates new empty LyX window.
8195 \begin_layout Description
8196 Notion Already opened documents from the previous window can be found under View menu.
8199 \begin_layout Description
8200 Syntax window-new [<GEOMETRY>]
8203 \begin_layout Description
8205 pass the geometry of the window.
8206 This parameter is currently accepted only on Windows platform.
8209 \begin_layout Description
8214 \begin_layout Section
8215 System Functions (Preferences,
8219 \begin_layout Subsection*
8220 bibtex-database-list
8223 \begin_layout Description
8224 Action Lists the available databases (separated by path separator common on the used OS).
8227 \begin_layout Description
8228 Notion Used by bibliographic managers
8231 \begin_layout Description
8232 Syntax bibtex-database-list
8235 \begin_layout Description
8240 \begin_layout Subsection*
8241 buffer-toggle-output-sync
8244 \begin_layout Description
8245 Action Toggles including of resources for forward/reverse search of the given document.
8248 \begin_layout Description
8249 Notion When toggled on,
8250 SyncTeX is invoked for PDF,
8251 while srcltx package is used for DVI.
8252 Custom LaTeX macro can be defined in preferences.
8255 \begin_layout Description
8256 Syntax buffer-toggle-output-sync
8259 \begin_layout Description
8264 \begin_layout Subsection*
8268 \begin_layout Description
8269 Action Executes a command defined in a .def file.
8272 \begin_layout Description
8273 Notion The definitions are by default read from lib/commands/default.def.
8274 \begin_inset Newline newline
8277 A .def file allows to define a command with
8279 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and <LFUN> is the lfun code to be executed (see e.g.
8280 LFUN_COMMAND_SEQUENCE).
8283 def_file "FileName" allows to include another .def file.
8284 \begin_inset Newline newline
8287 This is particularly useful in connection with toolbar buttons:
8288 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.
8291 \begin_layout Description
8295 \begin_layout Description
8297 Name of the command that must be called.
8300 \begin_layout Description
8305 \begin_layout Subsection*
8309 \begin_layout Description
8310 Action Cancels sequence prepared by LFUN_META_PREFIX .
8313 \begin_layout Description
8317 \begin_layout Subsection*
8318 command-alternatives
8321 \begin_layout Description
8322 Action Runs the first listed command that is enabled.
8325 \begin_layout Description
8326 Notion This can be used to bind multiple functions to a single key,
8327 and then which one is used will depend upon the context.
8330 \begin_layout Description
8331 Syntax command-alternatives <CMDS>
8334 \begin_layout Description
8336 Sequence of commands separated by semicolons.
8339 \begin_layout Description
8340 Sample command-alternatives completion-accept;cell-forward
8343 \begin_layout Description
8348 \begin_layout Subsection*
8352 \begin_layout Description
8353 Action Run more commands (LFUN and its parameters) in a sequence.
8356 \begin_layout Description
8357 Syntax command-sequence <CMDS>
8360 \begin_layout Description
8362 Sequence of commands separated by semicolons.
8365 \begin_layout Description
8366 Sample command-sequence cut;
8376 \begin_layout Description
8381 \begin_layout Subsection*
8382 cursor-follows-scrollbar-toggle
8385 \begin_layout Description
8386 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
8389 \begin_layout Description
8390 Syntax toggle-cursor-follows-scrollbar
8393 \begin_layout Description
8398 \begin_layout Subsection*
8402 \begin_layout Description
8403 Action Set debug output level.
8406 \begin_layout Description
8407 Syntax debug-level-set <LEVEL>
8410 \begin_layout Description
8412 comma separated list of levels or the correspondent number of their combination.
8413 0 is equivalent to disabling all debug events.
8414 See lyx -dbg for the current list of debug levels and their numbers.
8417 \begin_layout Description
8422 \begin_layout Subsection*
8426 \begin_layout Description
8427 Action toggle a mode where more information is given in UI
8430 \begin_layout Description
8431 Notion in so called "devel" mode,
8432 the information given in the status bar is more precise,
8433 and the help documents are open in editing mode.
8436 \begin_layout Description
8437 Syntax devel-mode-toggle
8440 \begin_layout Description
8445 \begin_layout Subsection*
8449 \begin_layout Description
8450 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
8453 \begin_layout Description
8454 Notion The external program used for forward search call can be specified in LyX Output preferences.
8455 See Additional manual for details of these settings.
8458 \begin_layout Description
8459 Syntax forward-search
8462 \begin_layout Description
8467 \begin_layout Subsection*
8471 \begin_layout Description
8472 Action Apply the given settings to user preferences.
8475 \begin_layout Description
8476 Syntax lyxrc-apply <SETTINGS>
8479 \begin_layout Description
8481 settings which are to be set.
8482 Take a look into ~/.lyx/preferences to get an idea which commands to use and their syntax.
8483 lyx::LyXRC::LyXRCTags has the list of possible commands.
8486 \begin_layout Subsection*
8490 \begin_layout Description
8491 Action Shows message in statusbar (for script purposes).
8494 \begin_layout Description
8495 Syntax message <STRING>
8498 \begin_layout Description
8503 \begin_layout Subsection*
8507 \begin_layout Description
8508 Action Simulate halting Meta key (Alt key on PCs).
8511 \begin_layout Description
8512 Notion Used for buffer edition not for GUI control.
8515 \begin_layout Description
8519 \begin_layout Subsection*
8523 \begin_layout Description
8524 Action Save user preferences.
8527 \begin_layout Description
8528 Syntax preferences-save
8531 \begin_layout Description
8536 \begin_layout Subsection*
8540 \begin_layout Description
8541 Action Reconfigure the automatic settings.
8544 \begin_layout Description
8548 \begin_layout Description
8553 \begin_layout Subsection*
8557 \begin_layout Description
8558 Action Enables/disables searching for features in findadv
8561 \begin_layout Description
8562 Syntax search-ignore <type> <value>
8565 \begin_layout Description
8567 language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content
8568 \begin_inset Newline newline
8575 \begin_layout Subsection*
8579 \begin_layout Description
8580 Action Returns path and file name of the currently edited document.
8583 \begin_layout Description
8584 Syntax server-get-filename
8587 \begin_layout Subsection*
8591 \begin_layout Description
8592 Action Returns the current layout (that is environment) name on the cursor position.
8595 \begin_layout Description
8596 Syntax server-get-layout
8599 \begin_layout Subsection*
8600 server-get-statistics
8603 \begin_layout Description
8604 Action Returns the statistics (number of words and characters) in the document or in the given selection.
8607 \begin_layout Description
8608 Notion Note that this function gives the number of words/chars written,
8609 not the number of characters which will be typeset.
8612 \begin_layout Description
8613 Syntax server-get-statistics [<TYPE>]
8616 \begin_layout Description
8618 <words|chars|chars-space> The requested count;
8620 the three values are returned,
8621 separated by a space.
8622 \begin_inset Newline newline
8627 \begin_inset Newline newline
8632 \begin_inset Newline newline
8636 count characters and spaces.
8639 \begin_layout Description
8644 \begin_layout Subsection*
8648 \begin_layout Description
8649 Action Returns the coordinates of cursor position in the editing area.
8652 \begin_layout Description
8653 Syntax server-get-xy
8656 \begin_layout Subsection*
8657 server-goto-file-row
8660 \begin_layout Description
8661 Action Sets the cursor position in LyX based on the row number of generated TeX file.
8664 \begin_layout Description
8665 Notion This can be useful for DVI inverse-search or detection of the problematic line from LaTeX compilation.
8666 Note that before this function can be used export to LaTeX output must occur (in order to map the row numbers).
8669 \begin_layout Description
8670 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
8673 \begin_layout Description
8675 the path and filename.
8676 Environment variables are expanded in the path.
8677 In case this LFUN does not work make sure you are giving correct path to the file.
8678 \begin_inset Newline newline
8681 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g.
8682 for the case of generated .tex file).
8683 \begin_inset Newline newline
8687 extensions will be automatically replaced by .lyx.
8688 \begin_inset Newline newline
8691 <ROW_NUMBER> The row number of the LaTeX file to which to go.
8694 \begin_layout Description
8695 Sample server-goto-file-row /home/user/example.lyx 41
8696 \begin_inset Newline newline
8699 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
8702 \begin_layout Description
8707 \begin_layout Subsection*
8711 \begin_layout Description
8712 Action Sends notify message about the last key-sequence to client.
8715 \begin_layout Description
8716 Notion This can be used to grab last key-sequence used inside the LyX window.
8717 See also Debug extensions section in Additional features manual.
8720 \begin_layout Description
8721 Syntax server-notify
8724 \begin_layout Subsection*
8728 \begin_layout Description
8729 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
8732 \begin_layout Description
8733 Syntax server-set-xy <X> <Y>
8736 \begin_layout Subsection*
8740 \begin_layout Description
8741 Action Set the given LyX color to the color defined by the X11 name given,
8742 and optionally a specific color for dark mode.
8745 \begin_layout Description
8746 Notion A new color entry is created if the color is unknown.
8747 Color names can be stored as a part of user settings.
8750 \begin_layout Description
8751 Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
8754 \begin_layout Description
8759 \begin_layout Subsection*
8763 \begin_layout Description
8764 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
8767 \begin_layout Description
8768 Notion Note that this function gives the number of words/chars written,
8769 not the number of characters which will be typeset.
8772 \begin_layout Description
8776 \begin_layout Description
8783 \begin_layout Subsection*
8787 \begin_layout Description
8788 Action Checks-in/commits the changes of the registered file to the repository.
8791 \begin_layout Description
8792 Notion In RCS case this also unlocks the file.
8795 \begin_layout Description
8799 \begin_layout Description
8804 \begin_layout Subsection*
8808 \begin_layout Description
8809 Action Checks-out the document for edit (and locks it in some cases).
8812 \begin_layout Description
8816 \begin_layout Description
8821 \begin_layout Subsection*
8825 \begin_layout Description
8826 Action Executes external command.
8827 This command is intended to support additional VCS commands.
8830 \begin_layout Description
8831 Syntax vc-command <FLAG> <PATH> <COMMAND>
8834 \begin_layout Description
8836 Flags for the command can be combined together.
8837 \begin_inset Newline newline
8840 U - dUmmy - no flags
8841 \begin_inset Newline newline
8844 D - Doc - need document loaded to proceed
8845 \begin_inset Newline newline
8848 I - dIrty - mark document dirty
8849 \begin_inset Newline newline
8852 R - Reload - ensure that the document is saved and reload it after command execution
8853 \begin_inset Newline newline
8856 M - Message - ask for input string (commit message)
8857 \begin_inset Newline newline
8861 path where to start.
8862 $$p will be replaced by the current document path.
8863 \begin_inset Newline newline
8868 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
8871 \begin_layout Description
8872 Sample vc-command DR $$p "svn up"
8875 \begin_layout Description
8880 \begin_layout Subsection*
8884 \begin_layout Description
8885 Action Compares two revisions of the same file under version control.
8888 \begin_layout Description
8889 Syntax vc-compare [<REV1>] [<REV2>]
8892 \begin_layout Description
8893 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
8894 \begin_inset Newline newline
8897 In RCS we subtract only in the last number of revision specification.
8898 Special case "0" is reserved for the last committed revision.
8899 \begin_inset Newline newline
8904 \begin_inset Newline newline
8909 Used only if REV1 > 0.
8910 \begin_inset Newline newline
8913 If no parameter is given,
8914 interactive dialog will be shown.
8917 \begin_layout Description
8918 Sample Compare current document against last commit
8919 \begin_inset Newline newline
8923 \begin_inset Newline newline
8926 Compare current document against current revision - 5 commits
8927 \begin_inset Newline newline
8931 \begin_inset Newline newline
8934 Compare revisions 120 and 155
8935 \begin_inset Newline newline
8941 \begin_layout Description
8946 \begin_layout Subsection*
8950 \begin_layout Description
8951 Action Copies the document to another name.
8954 \begin_layout Description
8955 Notion Copying with revision history is only supported by SVN.
8956 For RCS and CVS it is simulated by adding the document under a new name.
8957 Disabled if uncommitted changes exist.
8960 \begin_layout Description
8961 Syntax vc-copy <FILENAME>
8964 \begin_layout Description
8966 New name of the document.
8967 \begin_inset Newline newline
8970 A file dialog is opened if no filename is given.
8973 \begin_layout Description
8978 \begin_layout Subsection*
8982 \begin_layout Description
8983 Action Toggles the locking property of the edited file.
8986 \begin_layout Description
8987 Notion This is currently implemented only for SVN.
8990 \begin_layout Description
8991 Syntax vc-locking-toggle
8994 \begin_layout Description
8999 \begin_layout Subsection*
9003 \begin_layout Description
9004 Action Register the document as an file inside version control system.
9007 \begin_layout Description
9008 Notion File is registered inside cvs,
9009 svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
9010 \begin_inset Newline newline
9013 See LyX Additional Features Manual (Version Control Chapter) for additional information.
9016 \begin_layout Description
9020 \begin_layout Description
9025 \begin_layout Subsection*
9029 \begin_layout Description
9030 Action Renames the document to another name.
9033 \begin_layout Description
9034 Notion Renaming with revision history is only supported by SVN.
9035 For CVS it is simulated by adding the document under a new name and deleting the old one.
9036 For RCS it is not supported.
9037 Disabled if uncommitted changes exist.
9040 \begin_layout Description
9041 Syntax vc-rename <FILENAME>
9044 \begin_layout Description
9046 New name of the document.
9047 \begin_inset Newline newline
9050 A file dialog is opened if no filename is given.
9053 \begin_layout Description
9058 \begin_layout Subsection*
9062 \begin_layout Description
9063 Action Update the local archive directory in which resides the current document with the remote repository.
9066 \begin_layout Description
9067 Syntax vc-repo-update
9070 \begin_layout Description
9075 \begin_layout Subsection*
9079 \begin_layout Description
9080 Action Reverts the document to the last check-in/commit in VCS.
9083 \begin_layout Description
9087 \begin_layout Description
9092 \begin_layout Subsection*
9096 \begin_layout Description
9097 Action Undo last check-in.
9100 \begin_layout Description
9101 Notion This is currently implemented only for RCS.
9104 \begin_layout Description
9108 \begin_layout Description
9113 \begin_layout Section
9114 Hidden Functions (not listed for configuration)
9117 \begin_layout Subsection*
9121 \begin_layout Description
9122 Action Return the current key sequence and available options as a string.
9125 \begin_layout Description
9126 Notion No options are added if no current map exists.
9127 \begin_inset Newline newline
9130 This is probably usable only with connection to lyxserver.
9133 \begin_layout Description
9134 Syntax command-prefix
9137 \begin_layout Subsection*
9141 \begin_layout Description
9142 Action Activates the LyX window.
9145 \begin_layout Description
9146 Notion On Linux and Mac OS,
9147 this action brings the LyX window into focus.
9148 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.
9149 This action is useful in combination with reverse search.
9152 \begin_layout Description
9156 \begin_layout Description
9161 \begin_layout Subsection*
9165 \begin_layout Description
9166 Action Inserts the given string (accordingly to the correct keymap).
9169 \begin_layout Description
9170 Notion Automatically replace the currently selected text.
9171 Depends on lyxrc settings "auto_region_delete".
9174 \begin_layout Description
9175 Syntax self-insert <STRING>
9178 \begin_layout Subsection*
9182 \begin_layout Description
9183 Action Raises the LyX window.
9186 \begin_layout Description
9187 Notion Brings the LyX window to the front.
9188 Such behavior is allowed on Windows only when no other application has focus.
9189 This action is used when LyX is in single instance mode.
9192 \begin_layout Description
9196 \begin_layout Description