1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
10 \renewenvironment{description}{\list{}{%
11 \setlength{\itemsep}{-2pt}
12 \advance\leftmargini6\p@ \itemindent-12\p@
13 \labelwidth\z@ \let\makelabel\descriptionlabel}%
18 \use_default_options false
19 \maintain_unincluded_children no
27 \language_package default
28 \inputencoding auto-legacy
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
39 \font_typewriter_osf false
40 \font_sf_scale 100 100
41 \font_tt_scale 100 100
43 \use_dash_ligatures true
45 \default_output_format default
47 \bibtex_command default
48 \index_command default
49 \paperfontsize default
54 \use_package amsmath 1
55 \use_package amssymb 1
58 \use_package mathdots 0
59 \use_package mathtools 0
61 \use_package stackrel 0
62 \use_package stmaryrd 0
63 \use_package undertilde 0
65 \cite_engine_type default
69 \paperorientation portrait
85 \paragraph_separation indent
86 \paragraph_indentation default
88 \math_numbering_side default
93 \paperpagestyle default
95 \tracking_changes false
98 \postpone_fragile_content false
101 \html_be_strict false
102 \docbook_table_output 0
103 \docbook_mathml_prefix 1
118 \begin_layout Section*
122 \begin_layout Standard
123 This manual documents the
124 \begin_inset Quotes eld
128 \begin_inset Quotes erd
132 These are commands that are used to make \SpecialChar LyX
133 perform specific actions.
135 itself uses these functions internally,
136 and every internal action is bound to an LFUN.
139 \begin_layout Standard
140 LFUNs are also used in the files that define keyboard shortcuts,
141 menu or toolbar items.
142 So if you want to change\SpecialChar breakableslash
143 customize the user interface,
144 you need to deal with LFUNs.
146 external programs can use LFUNs to communicate with and
147 \begin_inset Quotes eld
151 \begin_inset Quotes erd
157 you can also issue LFUNs directly via the so called mini-buffer which can be opened via
160 arg "command-execute"
166 \begin_layout Standard
168 all LFUNs are listed,
169 categorized by function.
172 \begin_layout Section
173 Layout Functions (Font,
174 Layout and Textclass related)
177 \begin_layout Subsection*
181 \begin_layout Description
182 Action Displays list of layout choices.
185 \begin_layout Description
186 Notion This LFUN opens the dropbox allowing for choice of layout.
189 \begin_layout Description
190 Syntax drop-layouts-choice
193 \begin_layout Subsection*
197 \begin_layout Description
198 Action Splits the current environment with a Separator.
201 \begin_layout Description
202 Syntax environment-split [before|outer|previous]
205 \begin_layout Description
208 LyX will split the outermost environment in the current nesting hierarchy.
209 \begin_inset Newline newline
214 LyX will split the environment in the previous paragraph (if there is one).
215 \begin_inset Newline newline
220 the new environment will be appended rather than prepended.
223 \begin_layout Description
228 \begin_layout Subsection*
232 \begin_layout Description
233 Action Toggles the bold font (selection-wise) using mathbf in math.
236 \begin_layout Description
240 \begin_layout Subsection*
244 \begin_layout Description
245 Action Toggles the bold font (selection-wise) using boldsymbol in math.
248 \begin_layout Description
249 Syntax font-boldsymbol
252 \begin_layout Subsection*
256 \begin_layout Description
257 Action Toggles xout (cross-through) in the font (selection-wise).
260 \begin_layout Description
264 \begin_layout Description
269 \begin_layout Subsection*
273 \begin_layout Description
274 Action Reverts the settings of the font to the default values (selection-wise).
277 \begin_layout Description
281 \begin_layout Subsection*
285 \begin_layout Description
286 Action Toggles the emphasis font style (selection-wise).
289 \begin_layout Description
293 \begin_layout Subsection*
297 \begin_layout Description
298 Action Toggles Fraktur family font (math-mode,
302 \begin_layout Description
306 \begin_layout Description
311 \begin_layout Subsection*
315 \begin_layout Description
316 Action Toggles Italics font shape (math-mode,
320 \begin_layout Description
324 \begin_layout Description
329 \begin_layout Subsection*
333 \begin_layout Description
334 Action Toggles nospellcheck status in the font (selection-wise).
337 \begin_layout Description
338 Syntax font-nospellcheck
341 \begin_layout Description
346 \begin_layout Subsection*
350 \begin_layout Description
351 Action Toggles Noun text style font (selection-wise).
354 \begin_layout Description
358 \begin_layout Subsection*
362 \begin_layout Description
363 Action Toggles Roman family font (selection-wise).
366 \begin_layout Description
370 \begin_layout Subsection*
374 \begin_layout Description
375 Action Toggles Sans Serif family font (selection-wise).
378 \begin_layout Description
382 \begin_layout Subsection*
386 \begin_layout Description
387 Action Sets font size according to lyx format string.
390 \begin_layout Description
391 Syntax font-size <SIZE>
394 \begin_layout Description
396 tiny|scriptsize|footnotesize|small|normal|large|larger|
397 \begin_inset Newline newline
400 largest|huge|giant|increase|decrease|default
403 \begin_layout Subsection*
407 \begin_layout Description
408 Action Returns the info about the current font.
411 \begin_layout Description
415 \begin_layout Subsection*
419 \begin_layout Description
420 Action Toggles strikeout (strike-through) in the font (selection-wise).
423 \begin_layout Description
424 Syntax font-strikeout
427 \begin_layout Description
432 \begin_layout Subsection*
436 \begin_layout Description
437 Action Toggles the typewriter family font (selection-wise).
440 \begin_layout Description
441 Syntax font-typewriter
444 \begin_layout Subsection*
448 \begin_layout Description
449 Action Toggles underline in the font (selection-wise).
452 \begin_layout Description
453 Syntax font-underline
456 \begin_layout Subsection*
460 \begin_layout Description
461 Action Toggles double underline in the font (selection-wise).
464 \begin_layout Description
465 Syntax font-underunderline
468 \begin_layout Description
473 \begin_layout Subsection*
477 \begin_layout Description
478 Action Toggles wavy underline in the font (selection-wise).
481 \begin_layout Description
482 Syntax font-underwave
485 \begin_layout Description
490 \begin_layout Subsection*
494 \begin_layout Description
495 Action Sets the layout (that is,
496 environment) for the current paragraph.
499 \begin_layout Description
500 Syntax layout <LAYOUT> [ignoreautonests]
503 \begin_layout Description
506 \begin_inset Newline newline
511 nesting advices will be ignored.
514 \begin_layout Subsection*
518 \begin_layout Description
519 Action Adds a module.
522 \begin_layout Description
523 Notion Adds a module to the list of included modules for the current buffer.
526 \begin_layout Description
527 Syntax layout-module-add <MODULE>
530 \begin_layout Description
532 the module to be added
535 \begin_layout Description
540 \begin_layout Subsection*
544 \begin_layout Description
545 Action Clears the module list.
548 \begin_layout Description
549 Notion Clears the list of included modules for the current buffer.
552 \begin_layout Description
553 Syntax layout-modules-clear
556 \begin_layout Description
561 \begin_layout Subsection*
565 \begin_layout Description
566 Action Launches the paragraph settings dialog.
569 \begin_layout Description
570 Syntax layout-paragraph
573 \begin_layout Subsection*
577 \begin_layout Description
578 Action Reloads layout information.
581 \begin_layout Description
582 Notion Reloads all layout information for the current buffer from disk,
583 thus recognizing any changes that have been made to layout files on the fly.
584 This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
587 \begin_layout Description
591 \begin_layout Description
596 \begin_layout Subsection*
600 \begin_layout Description
601 Action Launches the tabular settings dialog.
604 \begin_layout Description
605 Syntax layout-tabular
608 \begin_layout Description
613 \begin_layout Subsection*
617 \begin_layout Description
618 Action Toggles the layout (that is,
619 environment) for the current paragraph.
622 \begin_layout Description
623 Notion Contrary to `layout',
624 this function resets the current (or selection) layout to the standard layout it already has the correct layout.
625 Useful for toolbar icons.
628 \begin_layout Description
629 Syntax layout-toggle <LAYOUT> [ignoreautonests]
632 \begin_layout Description
635 \begin_inset Newline newline
640 nesting advices will be ignored.
643 \begin_layout Description
648 \begin_layout Subsection*
652 \begin_layout Description
653 Action Update fonts and its metrics.
656 \begin_layout Description
657 Notion Automatically called after zoom,
663 \begin_layout Description
664 Syntax screen-font-update
667 \begin_layout Description
672 \begin_layout Subsection*
676 \begin_layout Description
677 Action Sets the text class for the current buffer.
680 \begin_layout Description
681 Syntax textclass-apply <TEXTCLASS>
684 \begin_layout Description
686 the textclass to set.
687 Note that this must be the filename,
688 minus the ".layout" extension.
691 \begin_layout Subsection*
695 \begin_layout Description
696 Action Loads information for a textclass from disk.
699 \begin_layout Description
700 Syntax textclass-load <TEXTCLASS>
703 \begin_layout Description
705 the textclass to load.
706 Note that this must be the filename,
707 minus the ".layout" extension.
710 \begin_layout Subsection*
714 \begin_layout Description
715 Action Apply last used text properties.
718 \begin_layout Description
719 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE,
720 which is automatically triggered when using Text Style dialog.
723 \begin_layout Description
724 Syntax textstyle-apply [<NUM>]textstyle-apply
727 \begin_layout Description
729 number of the selection in the internal freefonts stack to be applied.
732 \begin_layout Description
737 \begin_layout Subsection*
741 \begin_layout Description
742 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
745 \begin_layout Description
746 Syntax textstyle-update <FONT_INFO>
749 \begin_layout Description
751 specifies font attributes,
764 \begin_inset Newline newline
767 Use lyx -dbg action for exact syntax of text-style dialog parameters.
770 \begin_layout Description
775 \begin_layout Section
776 Editing Functions (Cursor and Mouse Movement,
780 \begin_layout Subsection*
784 \begin_layout Description
785 Action Adds an acute accent to the next character typed.
788 \begin_layout Description
792 \begin_layout Subsection*
796 \begin_layout Description
797 Action Adds a breve accent to the next character typed.
800 \begin_layout Description
804 \begin_layout Subsection*
808 \begin_layout Description
809 Action Adds a caron to the next character typed.
812 \begin_layout Description
816 \begin_layout Subsection*
820 \begin_layout Description
821 Action Adds a cedilla to the next character typed.
824 \begin_layout Description
825 Syntax accent-cedilla
828 \begin_layout Subsection*
832 \begin_layout Description
833 Action Adds a circle accent to the next character typed.
836 \begin_layout Description
840 \begin_layout Subsection*
844 \begin_layout Description
845 Action Adds a circumflex to the next character typed.
848 \begin_layout Description
849 Syntax accent-circumflex
852 \begin_layout Subsection*
856 \begin_layout Description
857 Action Adds a dot accent to the next character typed.
860 \begin_layout Description
864 \begin_layout Subsection*
868 \begin_layout Description
869 Action Adds a grave accent to the next character typed.
872 \begin_layout Description
876 \begin_layout Subsection*
877 accent-hungarian-umlaut
880 \begin_layout Description
881 Action Adds a Hungarian umlaut to the next character typed.
884 \begin_layout Description
888 \begin_layout Subsection*
892 \begin_layout Description
893 Action Adds a macron to the next character typed.
896 \begin_layout Description
900 \begin_layout Subsection*
904 \begin_layout Description
905 Action Adds an ogonek accent to the next character typed.
908 \begin_layout Description
912 \begin_layout Subsection*
916 \begin_layout Description
917 Action Adds a perispomeni (Greek circumflex) over the next character typed.
920 \begin_layout Description
921 Syntax accent-perispomeni
924 \begin_layout Subsection*
928 \begin_layout Description
929 Action Adds a tie over the next two character typed.
932 \begin_layout Description
933 Notion The following char will finish the tie.
936 \begin_layout Description
940 \begin_layout Subsection*
944 \begin_layout Description
945 Action Adds a tilde over the next character typed.
948 \begin_layout Description
952 \begin_layout Subsection*
956 \begin_layout Description
957 Action Adds an umlaut over the next character typed.
960 \begin_layout Description
964 \begin_layout Subsection*
968 \begin_layout Description
969 Action Adds a bar under the next character typed.
972 \begin_layout Description
973 Syntax accent-underbar
976 \begin_layout Subsection*
980 \begin_layout Description
981 Action Adds a dot under the next character typed.
984 \begin_layout Description
985 Syntax accent-underdot
988 \begin_layout Subsection*
992 \begin_layout Description
993 Action Accepts all tracked changes in the document.
996 \begin_layout Description
997 Syntax all-changes-accept
1000 \begin_layout Description
1005 \begin_layout Subsection*
1009 \begin_layout Description
1010 Action Rejects all tracked changes in the document.
1013 \begin_layout Description
1014 Notion Reject does not work recursively;
1015 the user may have to repeat the operation.
1018 \begin_layout Description
1019 Syntax all-changes-reject
1022 \begin_layout Description
1027 \begin_layout Subsection*
1031 \begin_layout Description
1032 Action Start (or remove) Appendix on the given cursor position.
1035 \begin_layout Description
1039 \begin_layout Description
1044 \begin_layout Subsection*
1048 \begin_layout Description
1049 Action Inserts an argument (short title) inset.
1052 \begin_layout Description
1053 Syntax argument-insert <argument nr>
1056 \begin_layout Description
1057 Params <argument nr>:
1058 see layout declarations
1061 \begin_layout Description
1066 \begin_layout Subsection*
1070 \begin_layout Description
1071 Action Adds database,
1072 which will be used for bibtex citations.
1075 \begin_layout Description
1076 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1079 \begin_layout Description
1080 Syntax bibtex-database-add <DATABASE-NAME>
1083 \begin_layout Description
1088 \begin_layout Subsection*
1092 \begin_layout Description
1093 Action Adds database,
1094 which will be used for bibtex citations.
1097 \begin_layout Description
1098 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1101 \begin_layout Description
1102 Syntax bibtex-database-del <DATABASE-NAME>
1105 \begin_layout Description
1110 \begin_layout Subsection*
1114 \begin_layout Description
1115 Action Clears the list of saved bookmarks.
1118 \begin_layout Description
1119 Syntax bookmark-clear
1122 \begin_layout Description
1127 \begin_layout Subsection*
1131 \begin_layout Description
1132 Action Moves the cursor to the numbered bookmark,
1133 opening the file if necessary.
1134 Note that bookmarks are saved per-session,
1138 \begin_layout Description
1139 Notion Bookmark 0 has a special purpose.
1140 It is automatically set
1141 \begin_inset Newline newline
1145 to the paragraph you are currently editing
1146 \begin_inset Newline newline
1150 to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1151 \begin_inset Newline newline
1155 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1158 \begin_layout Description
1159 Syntax bookmark-goto <NUMBER>
1162 \begin_layout Description
1164 the number of the bookmark to restore.
1167 \begin_layout Description
1172 \begin_layout Subsection*
1176 \begin_layout Description
1177 Action Save a bookmark.
1180 \begin_layout Description
1181 Notion Saves a numbered bookmark to the sessions file.
1182 The number must be between 1 and 9,
1184 Note that bookmarks are saved per-session,
1188 \begin_layout Description
1189 Syntax bookmark-save <NUMBER>
1192 \begin_layout Description
1194 the number of the bookmark to save.
1197 \begin_layout Description
1202 \begin_layout Subsection*
1206 \begin_layout Description
1207 Action Inserts Box inset.
1210 \begin_layout Description
1211 Syntax box-insert [<TYPE>]
1214 \begin_layout Description
1216 Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1217 \begin_inset Newline newline
1220 Framed is the default one.
1223 \begin_layout Description
1228 \begin_layout Subsection*
1232 \begin_layout Description
1233 Action Inserts branch inset.
1236 \begin_layout Description
1237 Syntax branch-insert <BRANCH-NAME>
1240 \begin_layout Description
1245 \begin_layout Subsection*
1249 \begin_layout Description
1250 Action For debug purposes only.
1251 Convert all [a-zA-Z0-1] characters to single character.
1252 Useful when submitting docs to list or bugzilla.
1255 \begin_layout Description
1256 Syntax buffer-anonymize
1259 \begin_layout Description
1264 \begin_layout Subsection*
1268 \begin_layout Description
1269 Action Move the cursor to the beginning of the document.
1272 \begin_layout Description
1276 \begin_layout Subsection*
1280 \begin_layout Description
1281 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1284 \begin_layout Description
1285 Syntax buffer-begin-select
1288 \begin_layout Subsection*
1292 \begin_layout Description
1293 Action Move the cursor to the end of the document.
1296 \begin_layout Description
1300 \begin_layout Subsection*
1304 \begin_layout Description
1305 Action Move the cursor to the end of the document adding the traversed text to the selection.
1308 \begin_layout Description
1309 Syntax buffer-end-select
1312 \begin_layout Subsection*
1316 \begin_layout Description
1317 Action Inserts a caption inset.
1320 \begin_layout Description
1321 Syntax caption-insert
1324 \begin_layout Description
1329 \begin_layout Subsection*
1333 \begin_layout Description
1334 Action Moves the cursor to the previous cell inside the table.
1337 \begin_layout Description
1338 Syntax cell-backward
1341 \begin_layout Description
1346 \begin_layout Subsection*
1350 \begin_layout Description
1351 Action Moves the cursor to the next cell inside the table.
1354 \begin_layout Description
1358 \begin_layout Subsection*
1362 \begin_layout Description
1363 Action Splits cell and shifts right part to the next cell (inside the math grid).
1366 \begin_layout Description
1370 \begin_layout Description
1375 \begin_layout Subsection*
1379 \begin_layout Description
1380 Action Accepts tracked change inside the selection.
1383 \begin_layout Description
1384 Syntax change-accept
1387 \begin_layout Description
1392 \begin_layout Subsection*
1396 \begin_layout Description
1397 Action Moves the cursor to the position of the next change of the change tracking records.
1400 \begin_layout Description
1404 \begin_layout Description
1409 \begin_layout Subsection*
1413 \begin_layout Description
1414 Action Moves the cursor to the position of the previous change of the change tracking records.
1417 \begin_layout Description
1418 Syntax change-previous
1421 \begin_layout Description
1426 \begin_layout Subsection*
1430 \begin_layout Description
1431 Action Rejects tracked change inside the selection.
1434 \begin_layout Description
1435 Syntax change-reject
1438 \begin_layout Description
1443 \begin_layout Subsection*
1447 \begin_layout Description
1448 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1451 \begin_layout Description
1452 Syntax changes-merge
1455 \begin_layout Description
1460 \begin_layout Subsection*
1464 \begin_layout Description
1465 Action Toggles showing of change tracking in typeset output.
1468 \begin_layout Description
1469 Syntax changes-output
1472 \begin_layout Description
1477 \begin_layout Subsection*
1481 \begin_layout Description
1482 Action Toggles change tracking to on/off.
1485 \begin_layout Description
1486 Syntax changes-track
1489 \begin_layout Description
1494 \begin_layout Subsection*
1498 \begin_layout Description
1499 Action Moves the cursor one position logically backwards.
1502 \begin_layout Description
1503 Notion This is not the action which should be bound to the arrow keys,
1504 because backwards may be left or right,
1505 depending on the language.
1506 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1507 which in turn may employ this one.
1510 \begin_layout Description
1511 Syntax char-backward
1514 \begin_layout Subsection*
1515 char-backward-select
1518 \begin_layout Description
1519 Action Moves the cursor one position logically backwards,
1520 adding traversed position to the selection.
1523 \begin_layout Description
1524 Notion See also LFUN_CHAR_BACKWARD.
1527 \begin_layout Description
1528 Syntax char-backward-select
1531 \begin_layout Subsection*
1532 char-delete-backward
1535 \begin_layout Description
1536 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1539 \begin_layout Description
1540 Syntax char-delete-backward [confirm]
1543 \begin_layout Description
1546 do not directly delete them.
1549 \begin_layout Subsection*
1553 \begin_layout Description
1554 Action Deletes one character in the backward direction (usually the "Delete" key).
1557 \begin_layout Description
1558 Syntax char-delete-forward [confirm]
1561 \begin_layout Description
1564 do not directly delete them.
1567 \begin_layout Subsection*
1571 \begin_layout Description
1572 Action Moves the cursor one position logically forward.
1575 \begin_layout Description
1576 Notion This is not the action which should be bound to the arrow keys,
1577 because forward may be left or right,
1578 depending on the language.
1579 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1580 which in turn may employ this one.
1583 \begin_layout Description
1587 \begin_layout Subsection*
1591 \begin_layout Description
1592 Action Moves the cursor one position logically forward,
1593 adding traversed position to the selection.
1596 \begin_layout Description
1597 Notion See also LFUN_CHAR_FORWARD.
1600 \begin_layout Description
1601 Syntax char-forward-select
1604 \begin_layout Subsection*
1608 \begin_layout Description
1609 Action Moves the cursor one position "to the left".
1612 \begin_layout Description
1613 Notion This is the action which should be taken when the "left" key is pressed.
1615 it moves the cursor one position to the left.
1617 in Bidi text this become slightly more complicated,
1618 and there are different modes of cursor movement.
1623 movement is logically forward in RTL paragraphs,
1624 and logically backwards in LTR paragraphs.
1627 \begin_layout Description
1631 \begin_layout Subsection*
1635 \begin_layout Description
1636 Action Moves the cursor one position "to the left",
1637 adding traversed position to the selection.
1640 \begin_layout Description
1641 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1644 \begin_layout Description
1645 Syntax char-left-select
1648 \begin_layout Subsection*
1652 \begin_layout Description
1653 Action Moves the cursor one position "to the right".
1656 \begin_layout Description
1657 Notion This is the action which should be taken when the "right" key is pressed.
1659 it moves the cursor one position to the right.
1661 in Bidi text this become slightly more complicated,
1662 and there are different modes of cursor movement.
1667 movement is logically forward in LTR paragraphs,
1668 and logically backwards in RTL paragraphs.
1671 \begin_layout Description
1675 \begin_layout Subsection*
1679 \begin_layout Description
1680 Action Moves the cursor one position "to the right",
1681 adding traversed position to the selection.
1684 \begin_layout Description
1685 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1688 \begin_layout Description
1689 Syntax char-right-select
1692 \begin_layout Subsection*
1696 \begin_layout Description
1697 Action Transposes the character at the cursor with the one before it.
1700 \begin_layout Description
1701 Syntax chars-transpose
1704 \begin_layout Description
1709 \begin_layout Subsection*
1713 \begin_layout Description
1714 Action Inserts citation from loaded citation database.
1717 \begin_layout Description
1718 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1721 \begin_layout Description
1723 Citation (shortcut listed in available citations).
1724 \begin_inset Newline newline
1728 text which should appear before citation.
1731 \begin_layout Description
1736 \begin_layout Subsection*
1740 \begin_layout Description
1741 Action Opens the corresponding pdf/url for a given citation inset.
1744 \begin_layout Description
1745 Syntax citation-open [EXTERNAL] TARGET
1748 \begin_layout Description
1750 URL (https:,file:) of the document.
1751 \begin_inset Newline newline
1755 Use external executable script for finding target
1756 \begin_inset Newline newline
1759 and launching viewer.
1760 In this case TARGET consists of author and year
1761 \begin_inset Newline newline
1764 and will be passed as an input argument to the script.
1767 \begin_layout Description
1772 \begin_layout Subsection*
1776 \begin_layout Description
1777 Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text).
1778 Pastes plain text if plain text is on the clipboard,
1779 but tries to interpret it in special ways for certain insets,
1781 converting csv data to rows and columns if the paste happens in a tabular inset.
1784 \begin_layout Description
1785 Notion Historically,
1786 LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE:
1787 It behaved exactly the same,
1788 but the source is the clipboard,
1792 \begin_layout Description
1793 Syntax clipboard-paste [<ARG>]
1796 \begin_layout Description
1798 "paragraph" will cause pasting as one paragraph,
1803 \begin_layout Description
1808 \begin_layout Subsection*
1809 clipboard-paste-simple
1812 \begin_layout Description
1813 Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard.
1814 Pastes plain text if plain text is on the clipboard,
1815 without trying to interpret it in special ways for certain insets,
1817 converting csv data to rows and columns if the paste happens in a tabular inset.
1820 \begin_layout Description
1821 Syntax clipboard-paste-simple [<ARG>]
1824 \begin_layout Description
1826 "paragraph" will cause pasting as one paragraph,
1831 \begin_layout Subsection*
1835 \begin_layout Description
1836 Action Switches the focus to the minibuffer so that the user can type in there.
1838 it opens the minibuffer toolbar.
1841 \begin_layout Description
1842 Notion Usually bound to M-x shortcut.
1845 \begin_layout Description
1846 Syntax command-execute
1849 \begin_layout Subsection*
1853 \begin_layout Description
1854 Action Try to complete the word or command at the cursor position.
1857 \begin_layout Description
1861 \begin_layout Description
1866 \begin_layout Subsection*
1870 \begin_layout Description
1871 Action Accept suggested completion.
1874 \begin_layout Description
1875 Syntax completion-accept
1878 \begin_layout Description
1883 \begin_layout Subsection*
1887 \begin_layout Description
1888 Action Try to cancel completion,
1889 either the popup or the inline completion.
1892 \begin_layout Description
1893 Syntax completion-cancel
1896 \begin_layout Description
1901 \begin_layout Subsection*
1905 \begin_layout Description
1906 Action Show the inline completion at the cursor position.
1909 \begin_layout Description
1910 Syntax completion-inline
1913 \begin_layout Description
1918 \begin_layout Subsection*
1922 \begin_layout Description
1923 Action Show the completion popup at the cursor position.
1926 \begin_layout Description
1927 Syntax completion-popup
1930 \begin_layout Description
1935 \begin_layout Subsection*
1939 \begin_layout Description
1940 Action Copies the current selection to the clipboard.
1943 \begin_layout Description
1947 \begin_layout Subsection*
1951 \begin_layout Description
1952 Action Cuts to the clipboard.
1955 \begin_layout Description
1959 \begin_layout Subsection*
1963 \begin_layout Description
1964 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1967 \begin_layout Description
1968 Syntax depth-decrement
1971 \begin_layout Subsection*
1975 \begin_layout Description
1976 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1979 \begin_layout Description
1980 Syntax depth-increment
1983 \begin_layout Subsection*
1984 dialog-disconnect-inset
1987 \begin_layout Description
1988 Action Closes opened connection to opened inset.
1991 \begin_layout Description
1992 Notion Connection is used for apply functions.
1995 \begin_layout Description
1996 Syntax dialog-disconnect-inset <INSET-NAME>
1999 \begin_layout Description
2004 \begin_layout Subsection*
2008 \begin_layout Description
2009 Action Hides showed dialog.
2010 Counterpart to LFUN_DIALOG_SHOW .
2013 \begin_layout Description
2014 Syntax dialog-hide <NAME>
2017 \begin_layout Description
2018 Params See LFUN_DIALOG_SHOW .
2021 \begin_layout Description
2026 \begin_layout Subsection*
2030 \begin_layout Description
2031 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
2034 \begin_layout Description
2035 Syntax dialog-show <NAME> [<DATA>]
2038 \begin_layout Description
2040 aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
2041 \begin_inset Newline newline
2044 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
2045 \begin_inset Newline newline
2048 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
2049 \begin_inset Newline newline
2052 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
2053 \begin_inset Newline newline
2056 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
2057 \begin_inset Newline newline
2060 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
2061 \begin_inset Newline newline
2066 \begin_inset Newline newline
2071 usually settings for the given dialog.
2072 Use debug mode for the details.
2075 \begin_layout Description
2080 \begin_layout Subsection*
2081 dialog-show-new-inset
2084 \begin_layout Description
2085 Action Shows hidden dialog or create new one for a given inset settings etc.
2088 \begin_layout Description
2089 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
2092 \begin_layout Description
2093 Syntax dialog-show-new-inset <NAME> [<DATA>]
2096 \begin_layout Description
2097 Params See LFUN_DIALOG_SHOW .
2100 \begin_layout Description
2105 \begin_layout Subsection*
2109 \begin_layout Description
2110 Action Toggles dialog between showed/hidden state.
2113 \begin_layout Description
2114 Notion Internally uses LFUN_DIALOG_SHOW ,
2118 \begin_layout Description
2119 Syntax dialog-toggle <NAME> [<DATA>]
2122 \begin_layout Description
2123 Params See LFUN_DIALOG_SHOW .
2126 \begin_layout Description
2131 \begin_layout Subsection*
2135 \begin_layout Description
2136 Action Updates the dialog values from the inset/paragraph/document.
2139 \begin_layout Description
2140 Syntax dialog-update <NAME>
2143 \begin_layout Description
2145 paragraph|prefs|<INSET>
2146 \begin_inset Newline newline
2153 \begin_layout Description
2158 \begin_layout Subsection*
2162 \begin_layout Description
2163 Action Moves the cursor one line in downward direction.
2166 \begin_layout Description
2170 \begin_layout Subsection*
2174 \begin_layout Description
2175 Action Moves the cursor one line in downward direction adding the current position to the selection.
2178 \begin_layout Description
2182 \begin_layout Subsection*
2186 \begin_layout Description
2187 Action Inserts an ERT inset.
2190 \begin_layout Description
2194 \begin_layout Description
2199 \begin_layout Subsection*
2203 \begin_layout Description
2204 Action Clears the selection.
2205 If no text is selected call LFUN_FINISHED_FORWARD.
2206 Inside math mode jumps out of the math inset.
2209 \begin_layout Description
2213 \begin_layout Description
2218 \begin_layout Subsection*
2222 \begin_layout Description
2223 Action Cancel background export process.
2226 \begin_layout Description
2227 Syntax export-cancel
2230 \begin_layout Description
2235 \begin_layout Subsection*
2239 \begin_layout Description
2240 Action Inserts another LyX file.
2243 \begin_layout Description
2244 Syntax file-insert [<FILE>] [ignorelang]
2247 \begin_layout Description
2249 Filename to be inserted.
2252 the (main) language of the inserted file is ignored (the context language is used).
2255 \begin_layout Subsection*
2256 file-insert-plaintext
2259 \begin_layout Description
2260 Action Inserts plain text file.
2263 \begin_layout Description
2264 Syntax file-insert-plaintext [<FILE>]
2267 \begin_layout Description
2269 Filename to be inserted.
2272 \begin_layout Description
2277 \begin_layout Subsection*
2278 file-insert-plaintext-para
2281 \begin_layout Description
2282 Action Inserts plain text file as paragraph (i.e.
2286 \begin_layout Description
2287 Syntax file-insert-plaintext-para [<FILE>]
2290 \begin_layout Description
2292 Filename to be inserted.
2295 \begin_layout Description
2300 \begin_layout Subsection*
2304 \begin_layout Description
2305 Action Inserts CharStyle,
2306 Custom inset or XML short element.
2309 \begin_layout Description
2310 Notion Look into the Customization manual for more information about these elements.
2311 \begin_inset Newline newline
2314 To make this command enabled the layout file for the document class you're using has to load the character styles.
2315 There are a few contained in the Logical Markup module.
2316 You can also of course create some yourself.
2317 \begin_inset Newline newline
2320 For dissolving the element see LFUN_INSET_DISSOLVE.
2323 \begin_layout Description
2324 Syntax flex-insert Name
2327 \begin_layout Description
2329 This name must be defined either in your layout file or imported by some module.
2330 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
2335 \begin_layout Description
2336 Sample flex-insert Code
2339 \begin_layout Subsection*
2343 \begin_layout Description
2344 Action Inserts a float inset.
2347 \begin_layout Description
2348 Syntax float-insert <TYPE>
2351 \begin_layout Description
2353 type of float depends on the used textclass.
2354 Usually "algorithm",
2356 "figure" parameters can be given.
2359 \begin_layout Description
2364 \begin_layout Subsection*
2368 \begin_layout Description
2369 Action Inserts the list of floats in the document.
2372 \begin_layout Description
2373 Syntax float-list-insert <TYPE>
2376 \begin_layout Description
2378 type of float depends on the used textclass.
2379 Usually "algorithm",
2381 "figure" parameters can be given.
2384 \begin_layout Description
2389 \begin_layout Subsection*
2393 \begin_layout Description
2394 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2397 \begin_layout Description
2398 Notion Corresponds to the starred floats (figure*,
2403 \begin_layout Description
2404 Syntax float-wide-insert <TYPE>
2407 \begin_layout Description
2409 type of float depends on the used textclass.
2410 Usually "algorithm",
2412 "figure" parameters can be given.
2415 \begin_layout Description
2420 \begin_layout Subsection*
2424 \begin_layout Description
2425 Action Inserts a footnote inset.
2428 \begin_layout Description
2429 Syntax footnote-insert
2432 \begin_layout Description
2437 \begin_layout Subsection*
2441 \begin_layout Description
2442 Action Reloads the image if necessary.
2445 \begin_layout Description
2446 Syntax graphics-reload
2449 \begin_layout Description
2454 \begin_layout Subsection*
2458 \begin_layout Description
2459 Action Set the group for the graphics inset on the cursor position.
2462 \begin_layout Description
2463 Syntax graphics-set-group [<GROUP>]
2466 \begin_layout Description
2468 Id for an existing group.
2469 In case the Id is an empty string,
2470 the graphics inset is removed from the current group.
2473 \begin_layout Description
2478 \begin_layout Subsection*
2482 \begin_layout Description
2483 Action Set the same group for all graphics insets in the marked block.
2486 \begin_layout Description
2487 Syntax graphics-unify [<GROUP>]
2490 \begin_layout Description
2492 Id for an existing group.
2493 In case the Id is an empty string,
2494 the group Id from the first graphics inset will be used.
2497 \begin_layout Description
2502 \begin_layout Subsection*
2506 \begin_layout Description
2507 Action Inserts hyperlinks into the document (clickable in pdf output).
2510 \begin_layout Description
2511 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2514 \begin_layout Description
2515 Syntax href-insert [<TARGET>]
2518 \begin_layout Description
2523 \begin_layout Subsection*
2527 \begin_layout Description
2528 Action Only active in IPA inset.
2531 \begin_layout Description
2532 Notion Dummy function which is only active in a IPA inset.
2533 It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2536 \begin_layout Description
2540 \begin_layout Description
2545 \begin_layout Subsection*
2549 \begin_layout Description
2550 Action Inserts Index entry.
2553 \begin_layout Description
2554 Notion It automatically takes the word on the cursor position.
2557 \begin_layout Description
2558 Syntax index-insert [<TYPE:Name>]
2561 \begin_layout Description
2564 if multiple indices are defined.
2565 With an empty argument,
2566 the default index is selected.
2569 \begin_layout Description
2574 \begin_layout Subsection*
2578 \begin_layout Description
2579 Action Inserts list of Index entries on a new page.
2582 \begin_layout Description
2583 Syntax index-print [<TYPE:Name>]
2586 \begin_layout Description
2589 if multiple indices are defined.
2590 With an empty argument,
2591 the default index is selected.
2594 \begin_layout Description
2599 \begin_layout Subsection*
2603 \begin_layout Description
2604 Action Tags all occurrences of the word before the cursor with the index inset at cursor.
2607 \begin_layout Description
2608 Notion It automatically takes the word on the cursor position.
2611 \begin_layout Description
2612 Syntax index-tag-all
2615 \begin_layout Description
2620 \begin_layout Subsection*
2624 \begin_layout Description
2625 Action Inserts special Index macros into the document.
2628 \begin_layout Description
2629 Syntax indexmacro-insert <type>
2632 \begin_layout Description
2640 \begin_layout Description
2645 \begin_layout Subsection*
2649 \begin_layout Description
2650 Action Displays shortcuts,
2652 package and textclass availability and menu information in a non-editable boxed InsetText.
2655 \begin_layout Description
2656 Notion Apart from lfun arguments you can use the following method:
2657 \begin_inset Newline newline
2661 input the type and argument of this inset,
2665 \begin_inset Newline newline
2669 select the text and run info-insert lfun.
2672 \begin_layout Description
2673 Syntax info-insert <TYPE> <ARG>
2676 \begin_layout Description
2678 date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2679 \begin_inset Newline newline
2683 argument for a given type.
2684 Look into InsetInfo.h for detailed description.
2685 \begin_inset Newline newline
2689 current date (formatted and localized)
2690 \begin_inset Newline newline
2694 date of last modification (saving) (formatted and localized)
2695 \begin_inset Newline newline
2699 a static date (formatted and localized)
2700 \begin_inset Newline newline
2704 current time (formatted and localized)
2705 \begin_inset Newline newline
2709 time of last modification (saving) (formatted and localized)
2710 \begin_inset Newline newline
2714 a static time (formatted and localized)
2715 \begin_inset Newline newline
2719 name of lfun (e.g math-insert
2722 \begin_inset Newline newline
2726 name of rc_entry (e.g.
2728 \begin_inset Newline newline
2732 "version" - used version of LyX
2733 \begin_inset Newline newline
2737 name of latex package (e.g.
2739 \begin_inset Newline newline
2743 name of textclass (e.g.
2745 \begin_inset Newline newline
2749 name of lfun used in menu
2750 \begin_inset Newline newline
2755 \begin_inset Newline newline
2759 icon of lfun used in toolbar or direct icon name
2760 \begin_inset Newline newline
2764 "name"|"name-noext"|"path"|"class" vcs:
2765 "tree-revision"|"revision"|"author"|"date"|"time"
2768 \begin_layout Description
2769 Sample command-sequence info-insert buffer path;
2770 info-insert buffer name
2773 \begin_layout Description
2778 \begin_layout Subsection*
2782 \begin_layout Description
2783 Action Apply data for an inset.
2786 \begin_layout Description
2787 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied.
2788 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called.
2791 \begin_layout Description
2792 Syntax inset-apply <ARGS>
2795 \begin_layout Description
2796 Params See LFUN_INSET_INSERT .
2799 \begin_layout Subsection*
2803 \begin_layout Description
2804 Action Move the cursor to the beginning of the current inset if it is not already there.
2805 If the cursor is already at the beginning of the current inset,
2806 move it to the beginning of the enclosing inset or the main work area,
2808 if there is no enclosing inset.
2811 \begin_layout Description
2815 \begin_layout Description
2820 \begin_layout Subsection*
2824 \begin_layout Description
2825 Action Move the cursor to the beginning of the current inset if it is not already there.
2826 If the cursor is already at the beginning of the current inset,
2827 move it to the beginning of the enclosing inset or the main work area,
2829 if there is no enclosing inset (adding the traversed text to the selection).
2832 \begin_layout Description
2833 Syntax inset-begin-select
2836 \begin_layout Description
2841 \begin_layout Subsection*
2845 \begin_layout Description
2846 Action Copies the inset to the clipboard as a certain type.
2849 \begin_layout Description
2850 Notion Currently used only for InsetInfo where its content is copied as a text.
2853 \begin_layout Description
2854 Syntax inset-copy-as
2857 \begin_layout Description
2862 \begin_layout Subsection*
2866 \begin_layout Description
2867 Action Dissolve the current inset into text.
2870 \begin_layout Description
2871 Syntax inset-dissolve [<INSET>]
2874 \begin_layout Description
2876 this can be used to make sure the right kind of inset is dissolved.
2877 For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset,
2878 even if the cursor is inside several nested insets of different type.
2879 \begin_inset Newline newline
2882 For values see lyx::InsetLayout::lyxtype_ .
2885 \begin_layout Description
2890 \begin_layout Subsection*
2894 \begin_layout Description
2895 Action Edit the inset at cursor with an external application,
2896 if one is attributed.
2897 If the inset is file based,
2898 the referenced file is edited.
2900 the inset contents is written to a temporary file,
2901 the inset is locked,
2902 and the temporary file is edited.
2904 LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished.
2907 \begin_layout Description
2908 Syntax inset-edit [<INSET_PARAMS>]
2911 \begin_layout Description
2912 Params <INSET_PARAMS>:
2913 Parameters for the inset.
2914 \begin_inset Newline newline
2917 Currently only the filename will be considered.
2920 \begin_layout Description
2925 \begin_layout Subsection*
2929 \begin_layout Description
2930 Action Move the cursor to the end of the current inset if it is not already there.
2931 If the cursor is already at the end of the current inset,
2932 move it to the end of the enclosing inset or the main work area,
2934 if there is no enclosing inset.
2937 \begin_layout Description
2941 \begin_layout Description
2946 \begin_layout Subsection*
2950 \begin_layout Description
2951 Action End editing the inset at cursor with an external application.
2952 This replaces the inset contents with the contents of the temporary file,
2953 deletes the file and unlocks the inset.
2956 \begin_layout Description
2957 Syntax inset-end-edit
2960 \begin_layout Description
2965 \begin_layout Subsection*
2969 \begin_layout Description
2970 Action Move the cursor to the end of the current inset if it is not already there.
2971 If the cursor is already at the end of the current inset,
2972 move it to the end of the enclosing inset or the main work area,
2974 if there is no enclosing inset (adding the traversed text to the selection).
2977 \begin_layout Description
2978 Syntax inset-end-select
2981 \begin_layout Description
2986 \begin_layout Subsection*
2990 \begin_layout Description
2991 Action Apply the given commands on insets of a given name.
2994 \begin_layout Description
2996 use at your own risks;
2997 this function gives you too many ways of shooting yourself in the foot.
2998 A typical example is inset-forall Note note-insert which starts an infinite loop.
2999 This is mitigated by the fact that the number of actions is arbitrarily limited to 100000.
3000 Note also that inset-forall does not update metrics between iterations,
3001 which can lead to bugs.
3002 This has to be eventually fixed.
3005 \begin_layout Description
3006 Syntax inset-forall <NAME> <LFUN-COMMAND>
3007 \begin_inset Newline newline
3013 all insets are matched.
3014 The name is used like for InsetLayout in layout files:
3015 "Note" matches all note insets,
3016 while "Note:Note" only matches LyX yellow note insets.
3019 \begin_layout Description
3020 Sample Remove all index insets:
3021 \begin_inset Newline newline
3024 inset-forall Index char-delete-forward
3025 \begin_inset Newline newline
3029 \begin_inset Newline newline
3032 inset-forall Note inset-toggle close
3033 \begin_inset Newline newline
3036 Open all branch insets of branch "myBranch":
3037 \begin_inset Newline newline
3040 inset-forall Branch:myBranch inset-toggle open
3041 \begin_inset Newline newline
3044 Transform all yellow notes to comments
3045 \begin_inset Newline newline
3048 inset-forall Note:Note inset-modify note Note Comment
3049 \begin_inset Newline newline
3052 Try to put LyX in an infinite loop if there is at least a Note:
3053 \begin_inset Newline newline
3056 inset-forall Note char-backward
3059 \begin_layout Description
3064 \begin_layout Subsection*
3068 \begin_layout Description
3069 Action Insert new inset (type given by the parameters).
3072 \begin_layout Description
3073 Syntax inset-insert <INSET> <ARGS>
3076 \begin_layout Description
3078 <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
3079 \begin_inset Newline newline
3082 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
3083 \begin_inset Newline newline
3087 depends on the given inset.
3088 Use "lyx -dbg action" to explore.
3091 \begin_layout Description
3092 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3095 \begin_inset Newline newline
3098 where <label name> is the name of the referenced label and <Format> is one of the following:
3099 \begin_inset Newline newline
3103 \begin_inset Newline newline
3106 eqref -- (<reference>)
3107 \begin_inset Newline newline
3111 \begin_inset Newline newline
3114 vpageref -- on <page>
3115 \begin_inset Newline newline
3118 vref -- <reference> on <page>
3119 \begin_inset Newline newline
3122 formatted -- Formatted reference
3125 \begin_layout Subsection*
3129 \begin_layout Description
3130 Action Inserts the inset's content (in ToC pane) at the position of the cursor.
3133 \begin_layout Description
3134 Syntax inset-insert-copy
3137 \begin_layout Description
3142 \begin_layout Subsection*
3146 \begin_layout Description
3147 Action Modify some properties of an inset.
3150 \begin_layout Description
3151 Notion Used for argument,
3180 vspace and wrap insets.
3183 \begin_layout Description
3184 Syntax inset-modify <INSET> <ARGS>
3185 \begin_inset Newline newline
3188 inset-modify changetype <TYPE>
3191 \begin_layout Description
3192 Sample Change a Note inset into a Comment inset:
3193 \begin_inset Newline newline
3196 inset-modify note Note Comment
3197 \begin_inset Newline newline
3200 Change a Box into an Ovalbox:
3201 \begin_inset Newline newline
3204 inset-modify changetype Ovalbox
3205 \begin_inset Newline newline
3208 Change a quotation mark to e[nglish style],
3209 l[eft side = opening],
3212 \begin_inset Newline newline
3215 inset-modify changetype els
3216 \begin_inset Newline newline
3219 Change only the style of a quotation mark,
3220 maintaining the other aspects (.
3222 \begin_inset Newline newline
3225 inset-modify changetype e..
3226 \begin_inset Newline newline
3232 \begin_layout Subsection*
3236 \begin_layout Description
3237 Action Select all contents of an inset.
3240 \begin_layout Description
3241 Notion There are 3 successive levels:
3242 select current cell,
3243 select all cells of inset,
3244 select the inset from outside (in the enclosing inset).
3247 \begin_layout Description
3248 Syntax inset-select-all
3251 \begin_layout Description
3254 lasgouttes 1 Nov 2014
3257 \begin_layout Subsection*
3261 \begin_layout Description
3262 Action Open the inset's properties dialog.
3265 \begin_layout Description
3266 Notion Used for bibitem,
3291 \begin_layout Description
3292 Syntax inset-settings <INSET>
3295 \begin_layout Description
3297 <bibitem|bibtex|box|branch|citation|ert|external|float|
3298 \begin_inset Newline newline
3301 graphics|href|include|index|index_print|label|line|
3302 \begin_inset Newline newline
3305 listings|note|phantom|ref|space|tabular|vspace|wrap>.
3308 \begin_layout Subsection*
3312 \begin_layout Description
3313 Action Splits the current inset into two at current position.
3316 \begin_layout Description
3317 Syntax inset-split [<INSET>]
3320 \begin_layout Description
3322 this can be used to make sure the right kind of inset is dissolved.
3323 For example "split" entry in the charstyles sub-menu should only dissolve the charstyle inset,
3324 even if the cursor is inside several nested insets of different type.
3325 \begin_inset Newline newline
3328 For values see lyx::InsetLayout::lyxtype_ .
3331 \begin_layout Description
3336 \begin_layout Subsection*
3340 \begin_layout Description
3341 Action Toggles the collapsible inset at cursor position,
3342 or the inset we are currently in.
3345 \begin_layout Description
3346 Syntax inset-toggle [<ARG>]
3349 \begin_layout Description
3351 <open|close|toggle|assign>.
3352 \begin_inset Newline newline
3355 open/close/toggle are for collapsible insets.
3356 toggle is used when no argument is given.
3357 \begin_inset Newline newline
3360 assign synchronize the branch-inset with activation status of the branch.
3361 Used for global toggling when changed activation.
3364 \begin_layout Description
3369 \begin_layout Subsection*
3373 \begin_layout Description
3374 Action Inserts an IPA inset.
3377 \begin_layout Description
3381 \begin_layout Description
3386 \begin_layout Subsection*
3390 \begin_layout Description
3391 Action Inserts special IPA macros into the document.
3394 \begin_layout Description
3395 Syntax ipamacro-insert <CHAR>
3398 \begin_layout Description
3404 tone-high-rising-falling,
3409 \begin_layout Description
3414 \begin_layout Subsection*
3418 \begin_layout Description
3419 Action Turn off the loaded keyboard map.
3422 \begin_layout Description
3426 \begin_layout Subsection*
3430 \begin_layout Description
3431 Action Turn on the primary keyboard map.
3434 \begin_layout Description
3435 Notion Maps were widely used in past,
3436 when X-windows didn't have nowadays keyboard support.
3437 They can be still used to maintain uniform keyboard layout across the various platforms.
3438 \begin_inset Newline newline
3441 The language is to be set in the Preferences dialog.
3444 \begin_layout Description
3445 Syntax keymap-primary
3448 \begin_layout Subsection*
3452 \begin_layout Description
3453 Action Turn on the secondary keyboard map.
3456 \begin_layout Description
3457 Syntax keymap-secondary
3460 \begin_layout Subsection*
3464 \begin_layout Description
3465 Action Toggles keyboard maps (first/second/off).
3468 \begin_layout Description
3469 Syntax keymap-toggle
3472 \begin_layout Description
3477 \begin_layout Subsection*
3478 label-copy-as-reference
3481 \begin_layout Description
3482 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3485 \begin_layout Description
3486 Syntax copy-label-as-reference <LABEL>
3489 \begin_layout Description
3491 The label to copy (for multi-line math)
3494 \begin_layout Description
3499 \begin_layout Subsection*
3503 \begin_layout Description
3504 Action Goto a label.
3507 \begin_layout Description
3508 Syntax label-goto [<LABEL>]
3511 \begin_layout Description
3514 If no label is given and reference is on cursor position,
3515 Bookmark 0 is saved and cursor moves to the position of referenced label.
3518 \begin_layout Description
3523 \begin_layout Subsection*
3527 \begin_layout Description
3528 Action Inserts label to text or displayed formula.
3531 \begin_layout Description
3532 Syntax label-insert [<LABEL>]
3535 \begin_layout Description
3538 If no label is given dialog requesting name will be opened.
3541 \begin_layout Subsection*
3542 label-insert-as-reference
3545 \begin_layout Description
3546 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3549 \begin_layout Description
3550 Syntax label-insert-as-reference
3553 \begin_layout Description
3558 \begin_layout Subsection*
3562 \begin_layout Description
3563 Action Set language from the current cursor position.
3566 \begin_layout Description
3567 Syntax language <LANG> [set]
3570 \begin_layout Description
3573 Look in lib/languages for the list.
3574 "language reset" or "language" (without param) reset to the document language.
3577 the language will be set to the specified language.
3579 the language will be toggled (i.e.,
3580 if the current language is LANG,
3581 switch to the document language or the default language,
3582 if LANG is the document language).
3585 \begin_layout Description
3590 \begin_layout Subsection*
3594 \begin_layout Description
3595 Action Move the cursor to the beginning of the (screen) line.
3598 \begin_layout Description
3602 \begin_layout Subsection*
3606 \begin_layout Description
3607 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3610 \begin_layout Description
3611 Syntax line-begin-select
3614 \begin_layout Subsection*
3618 \begin_layout Description
3619 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3622 \begin_layout Description
3623 Syntax line-delete-forward
3626 \begin_layout Subsection*
3630 \begin_layout Description
3631 Action Move the cursor to the end of the (screen) line.
3634 \begin_layout Description
3638 \begin_layout Subsection*
3642 \begin_layout Description
3643 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3646 \begin_layout Description
3647 Syntax line-end-select
3650 \begin_layout Subsection*
3654 \begin_layout Description
3655 Action Inserts a new listings inset.
3658 \begin_layout Description
3659 Syntax listing-insert
3662 \begin_layout Description
3669 \begin_layout Subsection*
3673 \begin_layout Description
3674 Action Inserts a marginal note.
3677 \begin_layout Description
3678 Syntax marginalnote-insert
3681 \begin_layout Description
3686 \begin_layout Subsection*
3690 \begin_layout Description
3691 Action Disable selecting of text-region.
3694 \begin_layout Description
3698 \begin_layout Subsection*
3702 \begin_layout Description
3703 Action Enable selecting of text-region.
3706 \begin_layout Description
3707 Notion After enabling you can simply move arrow keys to get selected region.
3710 \begin_layout Description
3714 \begin_layout Subsection*
3718 \begin_layout Description
3719 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3722 \begin_layout Description
3726 \begin_layout Description
3731 \begin_layout Subsection*
3735 \begin_layout Description
3736 Action Inserts a line break or new line.
3739 \begin_layout Description
3740 Syntax newline-insert [<ARG>]
3743 \begin_layout Description
3745 <newline|linebreak> default:
3749 \begin_layout Description
3754 \begin_layout Subsection*
3758 \begin_layout Description
3759 Action Inserts a new page.
3762 \begin_layout Description
3763 Syntax newpage-insert <ARG>
3766 \begin_layout Description
3768 <newpage|pagebreak|clearpage|cleardoublepage> default:
3772 \begin_layout Description
3777 \begin_layout Subsection*
3781 \begin_layout Description
3782 Action Inserts Nomenclature entry.
3785 \begin_layout Description
3786 Notion It automatically takes the word on the cursor position if no symbol is given.
3789 \begin_layout Description
3790 Syntax nomencl-insert [<SYMBOL>]
3793 \begin_layout Description
3798 \begin_layout Subsection*
3802 \begin_layout Description
3803 Action Inserts list of Nomenclature entries.
3806 \begin_layout Description
3807 Syntax nomenclature-print
3810 \begin_layout Description
3815 \begin_layout Subsection*
3819 \begin_layout Description
3820 Action Inserts Note on the current cursor position,
3821 move selection inside the inset.
3824 \begin_layout Description
3825 Syntax note-insert [<TYPE>]
3828 \begin_layout Description
3830 <Note|Greyedout|Comment> default:
3834 \begin_layout Subsection*
3838 \begin_layout Description
3839 Action Moves the cursor to the beginning of next Note inset.
3842 \begin_layout Description
3846 \begin_layout Subsection*
3850 \begin_layout Description
3851 Action Move the current group in the downward direction in the structure of the document.
3854 \begin_layout Description
3855 Notion The "group" can be Part/Chapter/Section/etc.
3856 It moves the whole substructure of the group.
3859 \begin_layout Description
3863 \begin_layout Description
3868 \begin_layout Subsection*
3872 \begin_layout Description
3873 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3876 \begin_layout Description
3877 Notion Part -> Chapter -> Section -> etc.
3880 \begin_layout Description
3884 \begin_layout Description
3889 \begin_layout Subsection*
3893 \begin_layout Description
3894 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3897 \begin_layout Description
3898 Notion Part <- Chapter <- Section <- etc.
3901 \begin_layout Description
3905 \begin_layout Description
3910 \begin_layout Subsection*
3914 \begin_layout Description
3915 Action Move the current group in the upward direction in the structure of the document.
3918 \begin_layout Description
3919 Notion The "group" can be Part/Chapter/Section/etc.
3920 It moves the whole substructure of the group.
3923 \begin_layout Description
3927 \begin_layout Description
3932 \begin_layout Subsection*
3936 \begin_layout Description
3937 Action Breaks the current paragraph at the current location.
3940 \begin_layout Description
3941 Notion Removes the selection.
3944 \begin_layout Description
3945 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3948 \begin_layout Description
3950 "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3951 \begin_inset Newline newline
3955 Do not account for paragraph separators while breaking.
3958 \begin_layout Subsection*
3962 \begin_layout Description
3963 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3966 \begin_layout Description
3967 Syntax paragraph-down
3970 \begin_layout Description
3975 \begin_layout Subsection*
3976 paragraph-down-select
3979 \begin_layout Description
3980 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3983 \begin_layout Description
3984 Syntax paragraph-down-select
3987 \begin_layout Description
3992 \begin_layout Subsection*
3996 \begin_layout Description
3997 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
3998 If given four arguments id_start,
4002 perform a selection from start to end.
4005 \begin_layout Description
4006 Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen.
4007 Moreover the id is unique for all opened buffers (documents).
4008 Both ids must belong to the same buffer.
4011 \begin_layout Description
4012 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
4015 \begin_layout Description
4018 \begin_inset Newline newline
4022 desired position within the paragraph
4025 \begin_layout Description
4031 \begin_layout Subsection*
4035 \begin_layout Description
4036 Action Moves the current paragraph downwards in the document.
4039 \begin_layout Description
4040 Syntax paragraph-move-down
4043 \begin_layout Description
4048 \begin_layout Subsection*
4052 \begin_layout Description
4053 Action Moves the current paragraph upwards in the document.
4056 \begin_layout Description
4057 Notion Movement through the document will possibly break the paragraph-depth (e.g.
4061 \begin_layout Description
4062 Syntax paragraph-move-up
4065 \begin_layout Description
4070 \begin_layout Subsection*
4074 \begin_layout Description
4075 Action Change paragraph settings.
4078 \begin_layout Description
4079 Notion Modifies the current paragraph,
4080 or currently selected paragraphs.
4081 This function only modifies,
4082 and does not override,
4084 Note that the "leftindent" indent setting is deprecated.
4087 \begin_layout Description
4088 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
4091 \begin_layout Description
4102 \begin_inset Newline newline
4108 paragraph_spacing default|single|onehalf|double|other SIZE
4109 \begin_inset Newline newline
4115 align block|left|right|center|default
4116 \begin_inset Newline newline
4122 labelwidthstring WIDTH|
4127 \begin_layout Description
4132 \begin_layout Subsection*
4133 paragraph-params-apply
4136 \begin_layout Description
4137 Action Change paragraph settings.
4140 \begin_layout Description
4141 Notion Overwrite all nonspecified settings to the default ones.
4142 Use paragraph-params lfun if you don't want to overwrite others settings.
4145 \begin_layout Description
4146 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
4149 \begin_layout Description
4150 Params For parameters see LFUN_PARAGRAPH_PARAMS
4153 \begin_layout Description
4158 \begin_layout Subsection*
4162 \begin_layout Description
4163 Action Move cursor to beginning of current paragraph and select to the end in downward direction
4166 \begin_layout Description
4167 Notion This function is by default bound to triple mouse click
4170 \begin_layout Description
4171 Syntax paragraph-select
4174 \begin_layout Description
4179 \begin_layout Subsection*
4183 \begin_layout Description
4184 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
4187 \begin_layout Description
4191 \begin_layout Description
4196 \begin_layout Subsection*
4200 \begin_layout Description
4201 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
4204 \begin_layout Description
4205 Syntax paragraph-up-select
4208 \begin_layout Description
4213 \begin_layout Subsection*
4217 \begin_layout Description
4218 Action Pastes material (text or picture) from the active clipboard.
4221 \begin_layout Description
4222 Syntax paste [<TYPE>|<NUM>]
4225 \begin_layout Description
4227 emf|pdf|png|jpeg|linkback|wmf|latex|html
4228 \begin_inset Newline newline
4232 number of the selection in the internal clipboard stack to be pasted.
4235 \begin_layout Subsection*
4239 \begin_layout Description
4240 Action Inserts phantom on the current cursor position,
4241 move selection inside the inset.
4244 \begin_layout Description
4245 Syntax phantom-insert [<TYPE>]
4248 \begin_layout Description
4250 <Phantom|HPhantom|VPhantom> default:
4254 \begin_layout Description
4259 \begin_layout Subsection*
4263 \begin_layout Description
4264 Action Inserts a new preview inset.
4267 \begin_layout Description
4268 Syntax preview-insert
4271 \begin_layout Description
4276 \begin_layout Subsection*
4277 primary-selection-paste
4280 \begin_layout Description
4281 Action Pastes the currently selected text.
4284 \begin_layout Description
4285 Notion Primary selection mechanism is X11/Wayland-only thing.
4288 \begin_layout Description
4289 Syntax primary-selection-paste [<ARG>]
4292 \begin_layout Description
4294 "paragraph" will cause pasting as one paragraph,
4299 \begin_layout Subsection*
4303 \begin_layout Description
4304 Action Inserts quotes according to the type and quote-language preference.
4307 \begin_layout Description
4308 Notion Currently 15 different quote styles are distinguished (see params).
4311 \begin_layout Description
4312 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
4315 \begin_layout Description
4319 usually single) quotes,
4320 otherwise outer (i.e.,
4322 usually double) quotes will be used.
4323 \begin_inset Newline newline
4327 'opening' for opening quotes,
4328 'closing' for closing quotes,
4329 otherwise the side will be guessed from the context.
4330 \begin_inset Newline newline
4334 'british' for `British' quote style (with ``inner quotation'')
4335 \begin_inset Newline newline
4338 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
4339 \begin_inset Newline newline
4342 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
4343 \begin_inset Newline newline
4346 'danish' for >>Danish<< quote style (with >inner quotation<)
4347 \begin_inset Newline newline
4350 'english' for ``English'' quote style (with `inner quotation')
4351 \begin_inset Newline newline
4354 'french' for <<french>> quote style (with ``inner quotation'')
4355 \begin_inset Newline newline
4358 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
4359 \begin_inset Newline newline
4362 'german' for ,,German`` quote style (with ,inner quotation`)
4363 \begin_inset Newline newline
4366 'plain' for "Plain" quote style (with 'inner quotation')
4367 \begin_inset Newline newline
4370 'polish' for ,,Polish'' quote style (with ,inner quotation')
4371 \begin_inset Newline newline
4374 'swedish' for ''Swedish'' quote style (with 'inner quotation')
4375 \begin_inset Newline newline
4378 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
4379 \begin_inset Newline newline
4382 'swiss' for <<Swiss>> quote style (with <inner quotation>)
4383 \begin_inset Newline newline
4386 'russian' for <<Russian>> quote style (with ,,inner quotation``)
4387 \begin_inset Newline newline
4390 'dynamic' for Dynamic quotation marks which inherit the global document style
4391 \begin_inset Newline newline
4394 If no quote style is specified,
4395 the document-wide will be used.
4398 \begin_layout Subsection*
4402 \begin_layout Description
4403 Action Redoes the last thing undone.
4406 \begin_layout Description
4410 \begin_layout Subsection*
4414 \begin_layout Description
4415 Action Go to the next label or cross-reference.
4418 \begin_layout Description
4419 Syntax reference-next
4422 \begin_layout Description
4427 \begin_layout Subsection*
4431 \begin_layout Description
4432 Action Repeat the given command.
4435 \begin_layout Description
4436 Notion fails when the repeat count is greater than 10000.
4439 \begin_layout Description
4440 Syntax repeat <COUNT> <LFUN-COMMAND>
4443 \begin_layout Description
4448 \begin_layout Subsection*
4452 \begin_layout Description
4453 Action Moves the cursor one page in downward direction.
4456 \begin_layout Description
4460 \begin_layout Subsection*
4464 \begin_layout Description
4465 Action Moves the cursor one screen in downward direction adding the current position to the selection.
4468 \begin_layout Description
4469 Syntax screen-down-select
4472 \begin_layout Subsection*
4476 \begin_layout Description
4477 Action Recenters the screen on the current cursor position.
4480 \begin_layout Description
4481 Syntax screen-recenter
4484 \begin_layout Subsection*
4488 \begin_layout Description
4489 Action Repositions the screen such that the cursor is visible.
4492 \begin_layout Description
4493 Syntax screen-show-cursor
4496 \begin_layout Description
4501 \begin_layout Subsection*
4505 \begin_layout Description
4506 Action Moves the cursor one page in upward direction.
4509 \begin_layout Description
4513 \begin_layout Subsection*
4517 \begin_layout Description
4518 Action Moves the cursor one page in upward direction adding the current position to the selection.
4521 \begin_layout Description
4522 Syntax screen-up-select
4525 \begin_layout Subsection*
4529 \begin_layout Description
4530 Action Inserts a subscript or superscript inset.
4533 \begin_layout Description
4534 Syntax script-insert <TYPE>
4537 \begin_layout Description
4539 subscript|superscript
4542 \begin_layout Description
4547 \begin_layout Subsection*
4551 \begin_layout Description
4552 Action Scroll the buffer view.
4555 \begin_layout Description
4556 Notion Only scrolls the screen up or down;
4557 does not move the cursor.
4560 \begin_layout Description
4561 Syntax scroll <TYPE> <QUANTITY>
4564 \begin_layout Description
4567 \begin_inset Newline newline
4574 \begin_layout Description
4579 \begin_layout Subsection*
4583 \begin_layout Description
4584 Action Set search string buffer.
4587 \begin_layout Description
4588 Syntax search-string-set [<DATA>]
4591 \begin_layout Description
4593 string to search for.
4594 If no parameter is given,
4595 use (word under) selection.
4598 \begin_layout Description
4604 \begin_layout Subsection*
4608 \begin_layout Description
4609 Action Select the whole section.
4612 \begin_layout Description
4613 Notion The cursor should be in a section heading before calling this lfun.
4616 \begin_layout Description
4617 Syntax section-select
4620 \begin_layout Description
4625 \begin_layout Subsection*
4629 \begin_layout Description
4630 Action Pastes the internal selection text in permanent selection.
4633 \begin_layout Description
4634 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ;
4635 primary-selection-paste paragraph).
4638 \begin_layout Description
4639 Syntax selection-paste
4642 \begin_layout Description
4647 \begin_layout Subsection*
4651 \begin_layout Description
4652 Action Inserts an environment separator or latex paragraph break.
4655 \begin_layout Description
4656 Syntax separator-insert [<ARG>]
4659 \begin_layout Description
4661 <plain|parbreak|latexpar> default:
4665 \begin_layout Description
4670 \begin_layout Subsection*
4674 \begin_layout Description
4675 Action Inserts one of horizontal space insets.
4678 \begin_layout Description
4679 Syntax space-insert <NAME> [<LEN>]
4682 \begin_layout Description
4701 \begin_inset Newline newline
4706 \begin_inset Newline newline
4710 length for custom spaces (hspace,
4711 hspace* for protected)
4714 \begin_layout Description
4720 \begin_layout Subsection*
4724 \begin_layout Description
4725 Action Inserts various characters into the document.
4728 \begin_layout Description
4729 Syntax specialchar-insert <CHAR>
4732 \begin_layout Description
4748 \begin_layout Description
4753 \begin_layout Subsection*
4757 \begin_layout Description
4758 Action Add the word under the cursor to the respective spell checker dictionary.
4759 The default for the language is retrieved from the cursor position.
4762 \begin_layout Description
4763 Syntax spelling-add [<STRING>] [<LANG>]
4766 \begin_layout Description
4769 language name (see file languages)
4772 \begin_layout Description
4777 \begin_layout Subsection*
4781 \begin_layout Description
4782 Action Add the word under the cursor to the document's local spell checker dictionary.
4783 The default for the language is retrieved from the cursor position.
4786 \begin_layout Description
4787 Syntax spelling-add-local [<STRING>] [<LANG>]
4790 \begin_layout Description
4793 language name (see file languages)
4796 \begin_layout Description
4801 \begin_layout Subsection*
4802 spelling-continuously
4805 \begin_layout Description
4806 Action Toggle continuous spell checking.
4809 \begin_layout Description
4810 Syntax spelling-continuously
4813 \begin_layout Description
4818 \begin_layout Subsection*
4822 \begin_layout Description
4823 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
4824 The default for the language is retrieved from the cursor position.
4827 \begin_layout Description
4828 Syntax spelling-ignore [<WORD>] [<LANG>]
4831 \begin_layout Description
4833 word to ignore <LANG>:
4834 language name (see file languages)
4837 \begin_layout Description
4842 \begin_layout Subsection*
4846 \begin_layout Description
4847 Action Remove the word under the cursor from the respective spell checker dictionary.
4848 The default for the language is retrieved from the cursor position.
4851 \begin_layout Description
4852 Syntax spelling-remove [<STRING>] [<LANG>]
4855 \begin_layout Description
4857 word to remove <LANG>:
4858 language name (see file languages)
4861 \begin_layout Description
4866 \begin_layout Subsection*
4867 spelling-remove-local
4870 \begin_layout Description
4871 Action Remove the word under the cursor from the document's local spell checker dictionary.
4872 The default for the language is retrieved from the cursor position.
4875 \begin_layout Description
4876 Syntax spelling-remove-local [<STRING>] [<LANG>]
4879 \begin_layout Description
4881 word to remove <LANG>:
4882 language name (see file languages)
4885 \begin_layout Description
4890 \begin_layout Subsection*
4894 \begin_layout Description
4895 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4898 \begin_layout Description
4899 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection.
4900 This is useful if you want to indent/unindent multiple lines in one action.
4903 \begin_layout Description
4907 \begin_layout Description
4912 \begin_layout Subsection*
4916 \begin_layout Description
4917 Action Insert a tab into a listings inset.
4920 \begin_layout Description
4921 Notion It also works on a selection.
4924 \begin_layout Description
4928 \begin_layout Description
4933 \begin_layout Subsection*
4937 \begin_layout Description
4938 Action Modify properties of tabulars and table-like math environments.
4941 \begin_layout Description
4942 Syntax tabular-feature <FEATURE> [<ARG>]
4945 \begin_layout Description
4946 Params Generally see LFUN_INSET_INSERT for further details.
4947 \begin_inset Newline newline
4951 append-row|append-column|delete-row|delete-column|copy-row|
4952 \begin_inset Newline newline
4955 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4956 \begin_inset Newline newline
4959 set-line-top|set-line-bottom|set-line-left|set-line-right|
4960 \begin_inset Newline newline
4963 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4964 \begin_inset Newline newline
4967 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
4968 \begin_inset Newline newline
4971 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
4972 \begin_inset Newline newline
4975 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4976 \begin_inset Newline newline
4979 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4980 \begin_inset Newline newline
4983 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4984 \begin_inset Newline newline
4987 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4988 \begin_inset Newline newline
4991 reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|
4992 \begin_inset Newline newline
4995 toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
4996 \begin_inset Newline newline
4999 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
5000 \begin_inset Newline newline
5003 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
5004 \begin_inset Newline newline
5007 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
5008 \begin_inset Newline newline
5011 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
5012 \begin_inset Newline newline
5015 set-special-column|set-special-multicolumn|set-special-multirow|
5016 \begin_inset Newline newline
5019 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
5020 \begin_inset Newline newline
5023 set-interline-space|tabular-valign-top|tabular-valign-middle|
5024 \begin_inset Newline newline
5027 tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|
5028 \begin_inset Newline newline
5031 set-border-lines|toggle-border-lines|set-inner-lines|toggle-inner-lines Various math-environment features are handled as well,
5033 add-vline-left/right for
5034 \begin_inset Newline newline
5037 the Grid/Array environment.
5038 \begin_inset Newline newline
5042 additional argument for some commands,
5043 use debug mode to explore its values.
5046 \begin_layout Description
5051 \begin_layout Subsection*
5055 \begin_layout Description
5056 Action Inserts table into the document.
5059 \begin_layout Description
5060 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
5063 \begin_layout Description
5064 Syntax tabular-insert [<ROWS> <COLUMNS>]
5067 \begin_layout Description
5068 Params In case no arguments are given show insert dialog.
5071 \begin_layout Description
5076 \begin_layout Subsection*
5077 tabular-style-insert
5080 \begin_layout Description
5081 Action Inserts table of a given style into the document.
5084 \begin_layout Description
5085 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
5088 \begin_layout Description
5089 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
5092 \begin_layout Description
5093 Params Valid styles are the names of the files in lib/tabletemplates,
5094 minus _1x<n> and .lyx suffix.
5097 \begin_layout Description
5102 \begin_layout Subsection*
5106 \begin_layout Description
5107 Action Look up thesaurus entries with respect to the word under the cursor.
5110 \begin_layout Description
5111 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
5114 \begin_layout Description
5116 word to look up <LANG>:
5117 language (see file languages)
5120 \begin_layout Description
5125 \begin_layout Subsection*
5129 \begin_layout Description
5130 Action Undoes the last edit.
5133 \begin_layout Description
5137 \begin_layout Subsection*
5141 \begin_layout Description
5142 Action Inserts a single unicode character.
5145 \begin_layout Description
5146 Syntax unicode-insert <CHAR1> <CHAR2> ...
5149 \begin_layout Description
5151 The character to insert,
5152 given as its code point,
5156 \begin_layout Description
5157 Sample unicode-insert 0x0100 0x0259
5160 \begin_layout Description
5165 \begin_layout Subsection*
5169 \begin_layout Description
5170 Action Moves the cursor one line in upward direction.
5173 \begin_layout Description
5177 \begin_layout Subsection*
5181 \begin_layout Description
5182 Action Moves the cursor one line in upward direction adding the current position to the selection.
5185 \begin_layout Description
5189 \begin_layout Subsection*
5193 \begin_layout Description
5194 Action Moves the cursor to the logically previous beginning of a word.
5197 \begin_layout Description
5198 Notion This is not the action which should be bound to the arrow keys,
5199 because backwards may be left or right,
5200 depending on the language.
5201 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
5202 which in turn may employ this one.
5205 \begin_layout Description
5206 Syntax word-backward
5209 \begin_layout Subsection*
5210 word-backward-select
5213 \begin_layout Description
5214 Action Moves the cursor to the logically previous beginning of a word,
5215 adding the logically traversed text to the selection.
5218 \begin_layout Description
5219 Notion See also LFUN_WORD_BACKWARD.
5222 \begin_layout Description
5223 Syntax word-backward-select
5226 \begin_layout Subsection*
5230 \begin_layout Description
5231 Action Capitalizes the words in the selection (i.e.
5232 the first letters) or the first letter of word at cursor position.
5235 \begin_layout Description
5236 Syntax word-capitalize [<SEL_TYPE>]
5239 \begin_layout Description
5241 if this is equal to "partial",
5242 then the default word starts at cursor position (emacs-style).
5244 the whole word is considered.
5247 \begin_layout Subsection*
5248 word-delete-backward
5251 \begin_layout Description
5252 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
5255 \begin_layout Description
5256 Syntax word-delete-backward [confirm]
5259 \begin_layout Description
5262 do not directly delete them.
5265 \begin_layout Subsection*
5269 \begin_layout Description
5270 Action Deletes characters to the end of the word (usually the "C+Delete" key).
5273 \begin_layout Description
5274 Syntax word-delete-forward [confirm]
5277 \begin_layout Description
5280 do not directly delete them.
5283 \begin_layout Subsection*
5287 \begin_layout Description
5288 Action Search for next occurrence of a string.
5291 \begin_layout Description
5292 Syntax word-find [<DATA>]
5295 \begin_layout Description
5297 data encoded from Find dialog (see lyx::find2string()).
5298 If no parameter is given,
5299 search with last find-dialog data is used for search (i.e.
5303 \begin_layout Description
5308 \begin_layout Subsection*
5312 \begin_layout Description
5313 Action Search for a given string in backward direction.
5316 \begin_layout Description
5317 Notion Case sensitive,
5319 If no argument given,
5320 last search repeated.
5323 \begin_layout Description
5324 Syntax word-find-backward [<STRING>]
5327 \begin_layout Description
5332 \begin_layout Subsection*
5336 \begin_layout Description
5337 Action Search for a given string in forward direction.
5340 \begin_layout Description
5341 Notion Case sensitive,
5343 If no argument given,
5344 last search repeated.
5347 \begin_layout Description
5348 Syntax word-find-forward [<STRING>]
5351 \begin_layout Description
5356 \begin_layout Subsection*
5360 \begin_layout Description
5361 Action Search for next occurrence of a pattern.
5364 \begin_layout Description
5365 Syntax word-findadv [<DATA>]
5368 \begin_layout Description
5370 data encoded from FindAdv dialog (see lyx::findadv2string()).
5371 If no parameter is given,
5372 search with last find-dialog data is used for search (i.e.
5376 \begin_layout Description
5381 \begin_layout Subsection*
5385 \begin_layout Description
5386 Action Moves the cursor to the logically next beginning of a word.
5389 \begin_layout Description
5390 Notion This is not the action which should be bound to the arrow keys,
5391 because forward may be left or right,
5392 depending on the language.
5393 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
5394 which in turn may employ this one.
5397 \begin_layout Description
5401 \begin_layout Subsection*
5405 \begin_layout Description
5406 Action Moves the cursor to the logically next beginning of a word,
5407 adding the logically traversed text to the selection.
5410 \begin_layout Description
5411 Notion See also LFUN_WORD_FORWARD.
5414 \begin_layout Description
5415 Syntax word-forward-select
5418 \begin_layout Subsection*
5422 \begin_layout Description
5423 Action Moves the cursor to the next beginning of a word "on the left".
5426 \begin_layout Description
5427 Notion This is the action which should be taken when the (e.g.,
5428 ctrl-) "left" key is pressed.
5430 it moves the cursor to the next beginning of a word on the left.
5432 in Bidi text this become slightly more complicated,
5433 and there are different modes of cursor movement.
5438 movement is logically forward in RTL paragraphs,
5439 and logically backwards in LTR paragraphs.
5442 \begin_layout Description
5446 \begin_layout Description
5451 \begin_layout Subsection*
5455 \begin_layout Description
5456 Action Moves the cursor to the next beginning of a word "on the left",
5457 adding *logically* traversed text to the selection.
5460 \begin_layout Description
5461 Notion See also LFUN_WORD_LEFT for exact details of the movement.
5464 \begin_layout Description
5465 Syntax word-left-select
5468 \begin_layout Description
5473 \begin_layout Subsection*
5477 \begin_layout Description
5478 Action Change the words in the selection or word at cursor position to lower case.
5481 \begin_layout Description
5482 Syntax word-lowcase [<SEL_TYPE>]
5485 \begin_layout Description
5487 if this is equal to "partial",
5488 then the default word starts at cursor position (emacs-style).
5490 the whole word is considered.
5493 \begin_layout Subsection*
5497 \begin_layout Description
5498 Action Replace a string in the document.
5501 \begin_layout Description
5502 Syntax word-replace [<DATA>]
5505 \begin_layout Description
5507 data is of the form "<replacestring>
5508 \begin_inset Newline newline
5512 \begin_inset Newline newline
5515 <casesensitive> <matchword> <all> <forward> <findnext>"
5518 \begin_layout Description
5523 \begin_layout Subsection*
5527 \begin_layout Description
5528 Action Moves the cursor to the next beginning of a word "on the right".
5531 \begin_layout Description
5532 Notion This is the action which should be taken when the (e.g.,
5533 ctrl-) "right" key is pressed.
5535 it moves the cursor to the next beginning of a word on the right.
5537 in Bidi text this become slightly more complicated,
5538 and there are different modes of cursor movement.
5543 movement is logically forward in LTR paragraphs,
5544 and logically backwards in RTL paragraphs.
5547 \begin_layout Description
5551 \begin_layout Description
5556 \begin_layout Subsection*
5560 \begin_layout Description
5561 Action Moves the cursor to the next beginning of a word "on the right",
5562 adding *logically* traversed text to the selection.
5565 \begin_layout Description
5566 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
5569 \begin_layout Description
5570 Syntax word-right-select
5573 \begin_layout Description
5578 \begin_layout Subsection*
5582 \begin_layout Description
5583 Action Puts the word where the cursor stands into the selection.
5586 \begin_layout Description
5590 \begin_layout Description
5595 \begin_layout Subsection*
5599 \begin_layout Description
5600 Action Change the words in the selection or word at cursor position to upper case.
5603 \begin_layout Description
5604 Syntax word-upcase [<SEL_TYPE>]
5607 \begin_layout Description
5609 if this is equal to "partial",
5610 then the default word starts at cursor position (emacs-style).
5612 the whole word is considered.
5615 \begin_layout Subsection*
5619 \begin_layout Description
5620 Action Inserts floats wrapped by the text around.
5623 \begin_layout Description
5624 Syntax wrap-insert <TYPE>
5627 \begin_layout Description
5632 \begin_layout Description
5637 \begin_layout Section
5638 Math Editor Functions
5641 \begin_layout Subsection*
5642 in-mathmacrotemplate
5645 \begin_layout Description
5646 Action Only active in Math Macro definition.
5649 \begin_layout Description
5650 Notion Dummy function which is only active in a Math Macro definition.
5651 It's used to toggle the Math Macro toolbar if the cursor moves into a Math Macro definition.
5654 \begin_layout Description
5655 Syntax in-mathmacrotemplate
5658 \begin_layout Description
5663 \begin_layout Subsection*
5667 \begin_layout Description
5668 Action Inserts an extended matrix as provided by the amsmath package.
5671 \begin_layout Description
5672 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
5675 \begin_layout Description
5676 Params <DECORATION>:
5677 Decoration determines the LaTeX name of the matrix that should be created.
5678 Possible values include pmatrix,
5685 The default is 'matrix'.
5688 \begin_layout Description
5689 Sample math-ams-matrix 3 3 bmatrix
5692 \begin_layout Subsection*
5696 \begin_layout Description
5697 Action Inserts math fixed size delimiters (e.g.
5699 brackets) enclosing expression.
5702 \begin_layout Description
5703 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
5706 \begin_layout Description
5708 bigl/r|Bigl/r|biggl/r|Biggl/r
5709 \begin_inset Newline newline
5713 TeX code for delimiter.
5714 See Delimiter dialog for delimiters to be used.
5717 \begin_layout Description
5718 Sample math-bigdelim "Bigl" "
5725 \begin_layout Description
5726 Origin Enrico & Georg,
5730 \begin_layout Subsection*
5734 \begin_layout Description
5735 Action Inserts math delimiters (e.g.
5737 brackets) enclosing expression.
5740 \begin_layout Description
5741 Syntax math-delim [<LEFT>] [<RIGHT>]
5744 \begin_layout Description
5745 Params <LEFT/RIGHT>:
5746 Delimiters to be used.
5747 Each delimiter can be specified by either a LaTeX name or a valid character.
5748 ( is the default letter.
5751 \begin_layout Description
5752 Sample math-delim { rangle
5755 \begin_layout Description
5760 \begin_layout Subsection*
5764 \begin_layout Description
5765 Action Creates a new displayed equation in text mode.
5766 Toggles inlined/display formula in math mode.
5769 \begin_layout Description
5770 Syntax math-display [<ARG>]
5773 \begin_layout Description
5775 this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
5778 \begin_layout Description
5783 \begin_layout Subsection*
5787 \begin_layout Description
5788 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
5791 \begin_layout Description
5792 Notion Selection can be used to determine the input for the external program.
5795 \begin_layout Description
5796 Syntax math-extern <LANG> [<COMMAND>]
5799 \begin_layout Description
5801 octave|maxima|maple|mathematica|script
5802 \begin_inset Newline newline
5805 where "script" stands for the external script (normalized expression will be passed)
5808 \begin_layout Description
5809 Sample math-extern maple simplify
5812 \begin_layout Description
5817 \begin_layout Subsection*
5821 \begin_layout Description
5822 Action Changes the text style used in math.
5825 \begin_layout Description
5826 Syntax math-font-style <STYLE>
5829 \begin_layout Description
5831 mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
5832 \begin_inset Newline newline
5835 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
5838 \begin_layout Description
5843 \begin_layout Subsection*
5847 \begin_layout Description
5848 Action Inserts math objects and symbols.
5851 \begin_layout Description
5852 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
5855 the content of cell(0) is replaced by the current selection (only works if the selection is in mathed).
5857 if "abc" is selected in mathed,
5860 frac{x}{y}" replaces "abc" with "
5863 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
5864 If nothing is selected (or the selection is not in mathed),
5865 math-insert works as expected.
5868 \begin_layout Description
5869 Syntax math-insert <ARG>
5872 \begin_layout Description
5874 Symbol or LaTeX code to be inserted.
5877 \begin_layout Subsection*
5881 \begin_layout Description
5882 Action Toggles the position of the limits from above/below to the right side an vice versa in integral symbol,
5888 \begin_layout Description
5889 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
5892 \begin_layout Description
5893 Syntax math-limits [<STATE>]
5896 \begin_layout Description
5901 \begin_layout Subsection*
5905 \begin_layout Description
5906 Action Inserts a math macro definition at the cursor position in the text.
5909 \begin_layout Description
5910 Syntax math-macro <NAME> [<NARGS>] [def]
5913 \begin_layout Description
5915 The name of the macro,
5918 \begin_inset Newline newline
5922 The number of parameters of the macro.
5925 Has no effect anymore,
5926 just for compatibility with former LyX versions.
5929 \begin_layout Description
5936 \begin_layout Subsection*
5937 math-macro-add-greedy-optional-param
5940 \begin_layout Description
5941 Action Add a greedy optional parameter.
5944 \begin_layout Description
5945 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
5948 \begin_layout Description
5949 Syntax math-macro-add-greedy-optional-param
5952 \begin_layout Description
5957 \begin_layout Subsection*
5958 math-macro-add-optional-param
5961 \begin_layout Description
5962 Action Add an optional parameter.
5965 \begin_layout Description
5966 Notion Insert an optional parameter just behind the already existing optional parameters.
5969 \begin_layout Description
5970 Syntax math-macro-add-optional-param
5973 \begin_layout Description
5978 \begin_layout Subsection*
5979 math-macro-add-param
5982 \begin_layout Description
5983 Action Add a parameter.
5986 \begin_layout Description
5987 Notion Add a parameter to a Math Macro.
5990 \begin_layout Description
5991 Syntax math-macro-add-param <NUM>
5994 \begin_layout Description
5996 The number of the parameter behind which the new one will be added (1 for the first,
5998 use 0 for add a parameter at the left),
5999 defaults to the last one.
6002 \begin_layout Description
6007 \begin_layout Subsection*
6008 math-macro-append-greedy-param
6011 \begin_layout Description
6012 Action Append a greedy parameter.
6015 \begin_layout Description
6016 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
6019 \begin_layout Description
6020 Syntax math-macro-append-greedy-param
6023 \begin_layout Description
6028 \begin_layout Subsection*
6032 \begin_layout Description
6033 Action Fold a Math Macro.
6036 \begin_layout Description
6037 Notion Fold the Math Macro the cursor is in if it was unfolded,
6044 \begin_layout Description
6045 Syntax math-macro-fold
6048 \begin_layout Description
6053 \begin_layout Subsection*
6054 math-macro-make-nonoptional
6057 \begin_layout Description
6058 Action Make a parameter non-optional.
6061 \begin_layout Description
6062 Notion Turn the last optional parameter of a Math Macro into a non-optional parameter.
6063 The default value is remembered to be reused later if the user changes his mind.
6066 \begin_layout Description
6067 Syntax math-macro-make-nonoptional
6070 \begin_layout Description
6075 \begin_layout Subsection*
6076 math-macro-make-optional
6079 \begin_layout Description
6080 Action Make a parameter optional.
6083 \begin_layout Description
6084 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
6087 \begin_layout Description
6088 Syntax math-macro-make-optional
6091 \begin_layout Description
6096 \begin_layout Subsection*
6097 math-macro-remove-greedy-param
6100 \begin_layout Description
6101 Action Remove a greedy parameter.
6104 \begin_layout Description
6105 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.
6106 If it is an optional parameter the [valud] format is used.
6109 \begin_layout Description
6110 Syntax math-macro-remove-greedy-param
6113 \begin_layout Description
6118 \begin_layout Subsection*
6119 math-macro-remove-optional-param
6122 \begin_layout Description
6123 Action Remove the last optional parameter.
6126 \begin_layout Description
6127 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
6130 \begin_layout Description
6131 Syntax math-macro-remove-optional-param
6134 \begin_layout Description
6139 \begin_layout Subsection*
6140 math-macro-remove-param
6143 \begin_layout Description
6144 Action Remove the last parameter.
6147 \begin_layout Description
6148 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
6151 \begin_layout Description
6152 Syntax math-macro-remove-param <NUM>
6155 \begin_layout Description
6157 The number of the parameter to be deleted (1 for the first),
6158 defaults to the last one.
6161 \begin_layout Description
6166 \begin_layout Subsection*
6170 \begin_layout Description
6171 Action Unfold a Math Macro.
6174 \begin_layout Description
6175 Notion Unfold the Math Macro the cursor is in,
6182 \begin_layout Description
6183 Syntax math-macro-unfold
6186 \begin_layout Description
6191 \begin_layout Subsection*
6195 \begin_layout Description
6196 Action Inserts a matrix.
6199 \begin_layout Description
6200 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
6203 \begin_layout Description
6205 Alignment is a word composed of the vertical alignment (b,
6207 1 char) and the horizontal alignments (l,
6212 \begin_layout Description
6213 Sample math-matrix 3 3 bccc
6216 \begin_layout Subsection*
6220 \begin_layout Description
6221 Action In text mode enters math mode (i.e.
6222 puts math insets on the current cursor position),
6223 in math mode enters text mode inside math expression.
6226 \begin_layout Description
6227 Notion If there is some selected text,
6228 it puts the text inside created math box.
6231 \begin_layout Description
6232 Syntax math-mode [on|<ARG>]
6235 \begin_layout Description
6237 eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
6238 \begin_inset Newline newline
6242 allow only entering of math mode from text mode.
6245 \begin_layout Description
6250 \begin_layout Subsection*
6254 \begin_layout Description
6255 Action Mutates the type of math inset to the newly selected one.
6258 \begin_layout Description
6259 Syntax math-mutate <TYPE>
6262 \begin_layout Description
6264 none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
6267 \begin_layout Description
6272 \begin_layout Subsection*
6273 math-number-line-toggle
6276 \begin_layout Description
6277 Action Toggles numbering of the current formula line.
6280 \begin_layout Description
6281 Notion Must be in display formula mode.
6284 \begin_layout Description
6285 Syntax math-number-line-toggle
6288 \begin_layout Description
6293 \begin_layout Subsection*
6297 \begin_layout Description
6298 Action Toggles numbering/labeling of the current formula.
6301 \begin_layout Description
6302 Notion Must be in display formula mode.
6305 \begin_layout Description
6306 Syntax math-number-toggle
6309 \begin_layout Description
6314 \begin_layout Subsection*
6318 \begin_layout Description
6319 Action Changes arbitrarily the size used by math fonts inside a context.
6322 \begin_layout Description
6323 Notion Provides an interface to the LaTeX math mode font size commands.
6326 \begin_layout Description
6327 Syntax math-size <STYLE>
6330 \begin_layout Description
6343 \begin_layout Description
6350 \begin_layout Subsection*
6354 \begin_layout Description
6355 Action Inserts space into math expression.
6358 \begin_layout Description
6359 Notion Use spacebar after entering this space to change type of space.
6362 \begin_layout Description
6363 Syntax math-space [<TYPE>] [<LEN>]
6366 \begin_layout Description
6369 !|negthinspace|negmedspace|negthickspace
6370 \begin_inset Newline newline
6374 ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
6375 \begin_inset Newline newline
6380 \begin_inset Newline newline
6383 "," used by default.
6384 \begin_inset Newline newline
6388 is equivalent to negthinspace,
6395 \begin_inset Newline newline
6399 length for custom spaces (hspace)
6402 \begin_layout Description
6409 \begin_layout Subsection*
6413 \begin_layout Description
6414 Action Enters subscript expression in math expression.
6417 \begin_layout Description
6418 Syntax math-subscript
6421 \begin_layout Description
6426 \begin_layout Subsection*
6430 \begin_layout Description
6431 Action Enters superscript expression in math expression.
6434 \begin_layout Description
6435 Syntax math-superscript
6438 \begin_layout Description
6443 \begin_layout Subsection*
6447 \begin_layout Description
6448 Action Enters regexp mode (i.e.,
6449 puts regexp insets on the current cursor position).
6450 Used by the advanced search dialog.
6453 \begin_layout Description
6454 Notion If there is any selected text,
6455 then it is moved inside the created regexp inset.
6458 \begin_layout Description
6459 Syntax regexp-mode [<ARG>]
6462 \begin_layout Description
6464 eventual argument (regular expression).
6467 \begin_layout Description
6472 \begin_layout Section
6473 Buffer Fuctions (File and Window related)
6476 \begin_layout Subsection*
6480 \begin_layout Description
6481 Action Activate the branch.
6484 \begin_layout Description
6485 Syntax branch-activate <BRANCH>
6488 \begin_layout Description
6490 The branch to activate
6493 \begin_layout Description
6494 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6495 \begin_inset Newline newline
6498 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
6501 \begin_layout Description
6506 \begin_layout Subsection*
6510 \begin_layout Description
6511 Action Add a branch to the buffer's BranchList.
6514 \begin_layout Description
6515 Syntax branch-add <BRANCH>
6518 \begin_layout Description
6520 Name of the branch to add
6523 \begin_layout Description
6528 \begin_layout Subsection*
6532 \begin_layout Description
6533 Action Create new branch and directly put the branch inset into the document.
6536 \begin_layout Description
6537 Syntax branch-add-insert [<NAME>]
6540 \begin_layout Description
6543 If it is not specified,
6547 \begin_layout Description
6552 \begin_layout Subsection*
6556 \begin_layout Description
6557 Action De-activate the branch.
6560 \begin_layout Description
6561 Syntax branch-deactivate <BRANCH>
6564 \begin_layout Description
6566 The branch to deactivate
6569 \begin_layout Description
6574 \begin_layout Subsection*
6578 \begin_layout Description
6579 Action Toggles inversion status of branch inset.
6582 \begin_layout Description
6583 Syntax branch-invert
6586 \begin_layout Description
6591 \begin_layout Subsection*
6592 branch-master-activate
6595 \begin_layout Description
6596 Action Activate the branch in the master buffer.
6599 \begin_layout Description
6600 Syntax branch-master-activate <BRANCH>
6603 \begin_layout Description
6605 The branch to activate
6608 \begin_layout Description
6609 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6610 \begin_inset Newline newline
6613 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
6616 \begin_layout Description
6621 \begin_layout Subsection*
6622 branch-master-deactivate
6625 \begin_layout Description
6626 Action De-activate the branch in the master buffer.
6629 \begin_layout Description
6630 Syntax branch-master-deactivate <BRANCH>
6633 \begin_layout Description
6635 The branch to deactivate
6638 \begin_layout Description
6643 \begin_layout Subsection*
6647 \begin_layout Description
6648 Action Open/close all insets of selected branch (depending on its activation status).
6651 \begin_layout Description
6652 Syntax branch-sync-all
6655 \begin_layout Description
6660 \begin_layout Subsection*
6664 \begin_layout Description
6665 Action Rename all branches of a given name in a document.
6668 \begin_layout Description
6669 Syntax branches-rename <OLDNAME> <NEWNAME>
6672 \begin_layout Description
6674 Current name of the branch to be renamed <NEWNAME>:
6675 New name of the branch
6678 \begin_layout Description
6683 \begin_layout Subsection*
6687 \begin_layout Description
6688 Action Saves the current buffer to a temporary file.
6691 \begin_layout Description
6692 Notion Saves the current buffer to a file named "#filename#".
6693 This LFUN is called automatically by LyX,
6694 to "autosave" the current buffer.
6697 \begin_layout Description
6698 Syntax buffer-auto-save
6701 \begin_layout Subsection*
6705 \begin_layout Description
6706 Action Loads the given child document.
6709 \begin_layout Description
6710 Notion The current document is treated as a parent.
6713 \begin_layout Description
6714 Syntax buffer-child-open <FILE>
6717 \begin_layout Description
6719 Filename of the child.
6720 The directory of the parent is assumed by default.
6723 \begin_layout Description
6728 \begin_layout Subsection*
6732 \begin_layout Description
6733 Action Runs chktex for the current document.
6736 \begin_layout Description
6737 Syntax buffer-chktex
6740 \begin_layout Description
6745 \begin_layout Subsection*
6749 \begin_layout Description
6750 Action Closes the current buffer.
6753 \begin_layout Description
6754 Notion Closes the current buffer,
6755 asking whether to save it,
6757 if the buffer has been modified.
6760 \begin_layout Description
6764 \begin_layout Subsection*
6768 \begin_layout Description
6769 Action Closes all buffers.
6772 \begin_layout Description
6773 Notion Closes all buffers,
6774 asking whether to save it,
6776 if a buffer has been modified.
6779 \begin_layout Description
6780 Syntax buffer-close-all
6783 \begin_layout Subsection*
6787 \begin_layout Description
6788 Action Exports the current buffer (document) to the given format.
6791 \begin_layout Description
6792 Syntax buffer-export [<FORMAT>] [<DEST>]
6795 \begin_layout Description
6796 Params <FORMAT> is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format.
6797 Usual format you will enter is "pdf2" (pdflatex),
6798 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
6799 \begin_inset Newline newline
6802 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.
6803 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
6804 \begin_inset Newline newline
6807 If absent or "default",
6808 then the default output format of the document is used.
6809 \begin_inset Newline newline
6813 this argument provides the export destination filename.
6814 Its containing folder will also be the destination folder,
6815 where all the needed external files will be copied.
6818 \begin_layout Description
6823 \begin_layout Subsection*
6827 \begin_layout Description
6828 Action Opens a dialog for exporting the current buffer.
6831 \begin_layout Description
6832 Syntax buffer-export-as [<FORMAT>]
6835 \begin_layout Description
6836 Params <FORMAT> is the export format initially selected in the dialog.
6837 You can pass any of the formats which you can find in Tools->Preferences->File formats->Format,
6838 provided it has the "document" flag set.
6839 If no format is specified the dialog will start with the default output format of the current document.
6842 \begin_layout Description
6843 Sample buffer-export-as pdf2
6846 \begin_layout Description
6851 \begin_layout Subsection*
6852 buffer-export-custom
6855 \begin_layout Description
6856 Action Exports the current buffer (document) from the given format using the given command on it.
6859 \begin_layout Description
6860 Syntax buffer-export-custom <FORMAT> <COMMAND>
6863 \begin_layout Description
6864 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
6865 \begin_inset Newline newline
6868 <COMMAND> this command will be launched on the file.
6869 Note that you can use "$$FName" string to qualify the intermediate file.
6872 \begin_layout Description
6873 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6876 \begin_layout Description
6881 \begin_layout Subsection*
6882 buffer-external-modification-clear
6885 \begin_layout Description
6886 Action Clear the external modification flag on the current buffer.
6889 \begin_layout Description
6890 Syntax buffer-external-modification-clear
6893 \begin_layout Description
6898 \begin_layout Subsection*
6902 \begin_layout Description
6903 Action Applies a command to all non-hidden buffers.
6906 \begin_layout Description
6907 Notion a buffer is `hidden' if it is internally open in LyX,
6908 but not visible in any window.
6911 \begin_layout Description
6912 Syntax buffer-forall <LFUN-COMMAND>
6915 \begin_layout Description
6916 Params <LFUN-COMMAND>:
6917 The command to be applied to the buffers.
6920 \begin_layout Description
6921 Sample Close all Notes in all buffers:
6922 \begin_inset Newline newline
6925 buffer-forall inset-forall Note inset-toggle close
6926 \begin_inset Newline newline
6929 Toggle change tracking on buffers:
6930 \begin_inset Newline newline
6933 buffer-forall changes-track
6934 \begin_inset Newline newline
6937 Toggle read-only for buffers:
6938 \begin_inset Newline newline
6941 buffer-forall buffer-toggle-read-only
6942 \begin_inset Newline newline
6945 Show statistics for individual buffers:
6946 \begin_inset Newline newline
6949 buffer-forall statistics
6950 \begin_inset Newline newline
6953 Activate the branch named "Solutions" in buffers:
6954 \begin_inset Newline newline
6957 buffer-forall branch-activate Solutions
6958 \begin_inset Newline newline
6961 Export buffers to PDF (pdflatex):
6962 \begin_inset Newline newline
6965 buffer-forall buffer-export pdf2
6966 \begin_inset Newline newline
6972 \begin_layout Description
6977 \begin_layout Subsection*
6981 \begin_layout Description
6982 Action Import a given file as a lyx document.
6985 \begin_layout Description
6986 Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences.
6987 Look in the File->Import menu to get an idea of the currently active import formats.
6990 \begin_layout Description
6991 Syntax buffer-import <FORMAT> [<FILE>]
6994 \begin_layout Description
6999 \begin_layout Subsection*
7003 \begin_layout Description
7004 Action Set language of the current document.
7007 \begin_layout Description
7008 Syntax buffer-language <LANG>
7011 \begin_layout Description
7014 See lib/languages for list.
7017 \begin_layout Description
7022 \begin_layout Subsection*
7026 \begin_layout Description
7027 Action Moves the current tab one spot to the right.
7030 \begin_layout Description
7031 Syntax buffer-move-next
7034 \begin_layout Description
7039 \begin_layout Subsection*
7040 buffer-move-previous
7043 \begin_layout Description
7044 Action Moves the current tab one spot to the left.
7047 \begin_layout Description
7048 Syntax buffer-move-previous
7051 \begin_layout Description
7056 \begin_layout Subsection*
7060 \begin_layout Description
7061 Action Creates a new buffer (that is,
7062 document) and switches to it.
7065 \begin_layout Description
7066 Notion Implicit path can be set in Preferences dialog.
7069 \begin_layout Description
7070 Syntax buffer-new [<FILE>]
7073 \begin_layout Description
7075 filename of created file with absolute path.
7078 \begin_layout Subsection*
7082 \begin_layout Description
7083 Action Creates a new buffer (that is,
7084 document) from a template.
7087 \begin_layout Description
7088 Notion Path for new files and templates can be set in Preferences dialog.
7089 Template will be asked for via Open-dialog.
7092 \begin_layout Description
7093 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
7096 \begin_layout Description
7098 filename of created file with absolute path.
7099 If empty or "newfile",
7100 a file with appropriate name is generated.
7102 filename of template with absolute path.
7104 a dialog is opened to select the new file.
7107 \begin_layout Subsection*
7111 \begin_layout Description
7112 Action Switch to the next opened document.
7115 \begin_layout Description
7116 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
7119 \begin_layout Description
7123 \begin_layout Subsection*
7127 \begin_layout Description
7128 Action Apply the given settings to the current document.
7131 \begin_layout Description
7132 Syntax buffer-params-apply [<ARGS>]
7135 \begin_layout Description
7137 contains the particular settings to be saved.
7138 They obey the syntax you can find in document header of usual .lyx file.
7141 \begin_layout Description
7146 \begin_layout Subsection*
7150 \begin_layout Description
7151 Action Switch to the previous opened document.
7154 \begin_layout Description
7155 Syntax buffer-previous
7158 \begin_layout Subsection*
7162 \begin_layout Description
7163 Action Reverts opened document.
7166 \begin_layout Description
7167 Syntax buffer-reload [dump]
7170 \begin_layout Description
7172 do not ask for any confirmation,
7174 All changes will be lost.
7177 \begin_layout Description
7182 \begin_layout Subsection*
7186 \begin_layout Description
7187 Action Removes the auxiliary file before next export to assure export is done afresh.
7190 \begin_layout Description
7191 Syntax buffer-reset-export
7194 \begin_layout Description
7199 \begin_layout Subsection*
7200 buffer-save-as-default
7203 \begin_layout Description
7204 Action Save the current document settings as default.
7207 \begin_layout Description
7208 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
7211 \begin_layout Description
7212 Syntax buffer-save-as-default [<ARGS>]
7215 \begin_layout Description
7217 contains the particular settings to be saved.
7218 They obey the syntax you can find in document header of usual .lyx file.
7221 \begin_layout Description
7226 \begin_layout Subsection*
7230 \begin_layout Description
7231 Action Display and switch to the given buffer.
7234 \begin_layout Description
7235 Syntax buffer-switch <BUFFER>
7238 \begin_layout Description
7240 path and filename of already opened (but possibly hidden) document which is to be shown.
7243 \begin_layout Subsection*
7244 buffer-toggle-compression
7247 \begin_layout Description
7248 Action Toggles compression of the current document on/off.
7251 \begin_layout Description
7252 Syntax buffer-toggle-compression
7255 \begin_layout Description
7260 \begin_layout Subsection*
7261 buffer-toggle-read-only
7264 \begin_layout Description
7265 Action Toggle editing mode of the current document between read/write and read-only.
7268 \begin_layout Description
7269 Notion This function is not allowed if the file is under version control,
7270 since read-only flag is often used in version control file locking.
7273 \begin_layout Description
7274 Syntax buffer-toggle-read-only
7277 \begin_layout Description
7282 \begin_layout Subsection*
7286 \begin_layout Description
7287 Action Exports the current document and put the result into the temporary directory.
7290 \begin_layout Description
7291 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated.
7292 This is useful in case your viewer is able to detect such changes (e.g.
7293 ghostview for postscript).
7296 \begin_layout Description
7297 Syntax buffer-update [<FORMAT>]
7300 \begin_layout Description
7302 The format to display,
7303 where this is one of the formats defined in the Tools>Preferences>File Formats dialog,
7304 use the "Short name" field.
7305 If no format is given,
7306 the default format as specified in the same dialog is used.
7309 \begin_layout Description
7314 \begin_layout Subsection*
7318 \begin_layout Description
7319 Action Displays current buffer in chosen format.
7322 \begin_layout Description
7323 Notion Displays the contents of the current buffer in the chosen format,
7326 This runs the necessary converter,
7327 calls the defined viewer,
7331 \begin_layout Description
7332 Syntax buffer-view [<FORMAT>]
7335 \begin_layout Description
7337 The format to display,
7338 where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7339 If no format is given,
7340 the default format as specified in the same dialog is used.
7343 \begin_layout Subsection*
7347 \begin_layout Description
7348 Action Opens the file that was created from last preview of this buffer.
7351 \begin_layout Description
7352 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog.
7353 It can also be called by the user,
7354 which is useful if the document takes a long time to compile,
7355 and you just want to see the last previewed version.
7358 \begin_layout Description
7359 Syntax buffer-view-cache
7362 \begin_layout Subsection*
7366 \begin_layout Description
7367 Action Saves the current buffer.
7370 \begin_layout Description
7371 Notion Saves the current buffer to disk,
7372 using the filename that is already associated with the buffer,
7373 asking for one if none is yet assigned.
7376 \begin_layout Description
7377 Syntax buffer-write [force]
7380 \begin_layout Description
7382 write even if buffer is clean.
7385 \begin_layout Subsection*
7389 \begin_layout Description
7390 Action Save all changed documents.
7393 \begin_layout Description
7394 Syntax buffer-write-all
7397 \begin_layout Description
7402 \begin_layout Subsection*
7406 \begin_layout Description
7407 Action Rename and save current buffer.
7410 \begin_layout Description
7411 Syntax buffer-write-as <FILENAME>
7414 \begin_layout Description
7416 New name of the buffer/file.
7417 A relative path is with respect to the original location of the buffer/file.
7420 \begin_layout Subsection*
7421 buffer-write-as-template
7424 \begin_layout Description
7425 Action Rename and save current buffer in the local templates directory.
7428 \begin_layout Description
7429 Syntax buffer-write-as-template <FILENAME>
7432 \begin_layout Description
7434 New name of the buffer/file.
7435 A relative path is with respect to the original location of the buffer/file.
7438 \begin_layout Subsection*
7442 \begin_layout Description
7443 Action Sets the zoom of the screen fonts.
7446 \begin_layout Description
7447 Syntax buffer-zoom [<ZOOM>]
7450 \begin_layout Description
7452 The target zoom value in %;
7453 the default is the default zoom as saved in preferences.
7456 \begin_layout Description
7461 \begin_layout Subsection*
7465 \begin_layout Description
7466 Action Increases the zoom of the screen fonts.
7469 \begin_layout Description
7470 Syntax buffer-zoom-in [<ZOOM>]
7473 \begin_layout Description
7475 The zoom value addition in % (neg.
7477 the default is 10% of the default zoom as saved in preferences.
7480 \begin_layout Description
7485 \begin_layout Subsection*
7489 \begin_layout Description
7490 Action Decreases the zoom of the screen fonts.
7493 \begin_layout Description
7494 Syntax buffer-zoom-out [<ZOOM>]
7497 \begin_layout Description
7499 The zoom value abstraction in % (neg.
7501 the default is 10% of the default zoom as saved in preferences.
7504 \begin_layout Description
7509 \begin_layout Subsection*
7513 \begin_layout Description
7514 Action Generates the code (literate programming).
7517 \begin_layout Description
7518 Notion Latex file with extension
7520 literate_extension is generated.
7523 build_command (with a default of ``make'') to generate the code and
7525 build_error_filter to process the compilation error messages.
7526 \begin_inset Newline newline
7529 In case you want to process your literate file with a script,
7530 or some other program,
7531 just insert in your lyxrc file an entry with:
7532 \begin_inset Newline newline
7537 build_command "my_script my_arguments"
7538 \begin_inset Newline newline
7543 build_error_filter differs from the
7545 literate_error_filter only in that the former will identify error messages from your compiler.
7548 \begin_layout Description
7549 Syntax build-program
7552 \begin_layout Subsection*
7556 \begin_layout Description
7557 Action Open LyX document.
7560 \begin_layout Description
7561 Syntax file-open [<FILE>]
7564 \begin_layout Description
7566 Filename to be opened.
7569 \begin_layout Subsection*
7573 \begin_layout Description
7574 Action Open the given help file according to the language setting.
7577 \begin_layout Description
7578 Syntax help-open <FILE>[.lyx]
7581 \begin_layout Description
7583 any document from (/usr/share/)doc directory.
7586 \begin_layout Description
7591 \begin_layout Subsection*
7595 \begin_layout Description
7596 Action Sets icon size of toolbars.
7599 \begin_layout Description
7600 Syntax icon-size [<SIZE>]
7603 \begin_layout Description
7605 the icon size in px or one of the logical settings small|normal|big|huge|giant,
7606 the default is normal (whose size in px is icon set dependent).
7609 \begin_layout Description
7613 \begin_layout Subsection*
7617 \begin_layout Description
7618 Action Helper function for master-related actions
7621 \begin_layout Description
7623 the function will be disabled if the buffer has no master or children.
7624 It thus allows to enable actions only in documents with master/children
7627 \begin_layout Description
7628 Syntax ifrelatives <ACTION>
7631 \begin_layout Description
7636 \begin_layout Subsection*
7640 \begin_layout Description
7641 Action Terminates the current LyX instance.
7644 \begin_layout Description
7645 Notion Terminates the current LyX instance,
7646 asking whether to save modified documents,
7650 \begin_layout Description
7654 \begin_layout Subsection*
7658 \begin_layout Description
7659 Action Open lyxfiles (templates/examples).
7660 Create a view if he have none.
7663 \begin_layout Description
7664 Syntax lyxfiles-open [<TYPE>]
7667 \begin_layout Description
7669 templates or examples.
7670 Default is templates.
7673 \begin_layout Description
7678 \begin_layout Subsection*
7679 master-buffer-export
7682 \begin_layout Description
7683 Action Exports the master buffer (document) to the given format.
7686 \begin_layout Description
7687 Syntax master-buffer-export [<FORMAT>] [<DEST>]
7690 \begin_layout Description
7691 Params <FORMAT> is one of the formats which you can find in Tools->Preferences->File formats->Format.
7692 Usual format you will enter is "pdf2" (pdflatex),
7693 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
7694 \begin_inset Newline newline
7697 Note that "custom" is not allowed in this case.
7698 \begin_inset Newline newline
7701 If absent or "default",
7702 then the default output format of the document is used.
7703 \begin_inset Newline newline
7707 this argument provides the export destination filename.
7708 Its containing folder will also be the destination folder,
7709 where all the needed external files will be copied.
7712 \begin_layout Description
7717 \begin_layout Subsection*
7718 master-buffer-forall
7721 \begin_layout Description
7722 Action Applies a command to a buffer and all it children,
7723 starting from the master.
7726 \begin_layout Description
7727 Syntax master-buffer-forall <LFUN-COMMAND>
7730 \begin_layout Description
7731 Params <LFUN-COMMAND>:
7732 The command to be applied to the buffers.
7735 \begin_layout Description
7736 Sample Close all Notes in buffers:
7737 \begin_inset Newline newline
7740 master-buffer-forall inset-forall Note inset-toggle close
7741 \begin_inset Newline newline
7744 Toggle change tracking on buffers:
7745 \begin_inset Newline newline
7748 master-buffer-forall changes-track
7749 \begin_inset Newline newline
7752 Toggle read-only for buffers:
7753 \begin_inset Newline newline
7756 master-buffer-forall buffer-toggle-read-only
7757 \begin_inset Newline newline
7760 Show statistics for individual buffers:
7761 \begin_inset Newline newline
7764 master-buffer-forall statistics
7765 \begin_inset Newline newline
7768 Activate the branch named "Solutions" in buffers:
7769 \begin_inset Newline newline
7772 master-buffer-forall branch-activate Solutions
7773 \begin_inset Newline newline
7779 \begin_layout Description
7784 \begin_layout Subsection*
7785 master-buffer-update
7788 \begin_layout Description
7789 Action Update (export) the document built from the master buffer,
7790 if the current buffer is part of a master/child document.
7793 \begin_layout Description
7794 Syntax master-buffer-update [<FORMAT>]
7797 \begin_layout Description
7799 The format to display,
7800 where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7801 If no format is given,
7802 the default format as specified in the same dialog is used.
7805 \begin_layout Description
7810 \begin_layout Subsection*
7814 \begin_layout Description
7815 Action Show a preview built from the master buffer,
7817 if the current buffer is part of a master/child document.
7820 \begin_layout Description
7821 Syntax master-buffer-view [<FORMAT>]
7824 \begin_layout Description
7826 The format to display,
7827 where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7828 If no format is given,
7829 the default format as specified in the same dialog is used.
7832 \begin_layout Description
7837 \begin_layout Subsection*
7841 \begin_layout Description
7842 Action Opens the menu given by its name.
7845 \begin_layout Description
7846 Syntax menu-open <NAME>
7849 \begin_layout Description
7852 See various .inc files in lib/ui for candidates.
7855 \begin_layout Subsection*
7859 \begin_layout Description
7860 Action Close the current tab group.
7863 \begin_layout Description
7864 Notion This only closes the work areas,
7865 not the buffers themselves.
7866 The still opened buffers can be visualized in another tab group.
7869 \begin_layout Description
7870 Syntax tab-group-close
7873 \begin_layout Description
7878 \begin_layout Subsection*
7882 \begin_layout Description
7883 Action Switch to the next tab group in split view.
7886 \begin_layout Description
7887 Syntax tab-group-next
7890 \begin_layout Subsection*
7894 \begin_layout Description
7895 Action Switch to the previous tab group in split view.
7898 \begin_layout Description
7899 Syntax tab-group-previous
7902 \begin_layout Subsection*
7906 \begin_layout Description
7907 Action Toggles movability of a given toolbar between true/false.
7910 \begin_layout Description
7911 Syntax toolbar-movable <NAME>
7914 \begin_layout Description
7916 *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
7919 \begin_layout Description
7924 \begin_layout Subsection*
7928 \begin_layout Description
7929 Action Sets visibility of a given toolbar to on,
7934 \begin_layout Description
7935 Notion Skipping "auto" when allowauto is false.
7938 \begin_layout Description
7939 Syntax toolbar-set <NAME> [on|off|auto]
7942 \begin_layout Description
7944 standard|extra|table|math|mathmacrotemplate|
7945 \begin_inset Newline newline
7948 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
7951 \begin_layout Description
7956 \begin_layout Subsection*
7960 \begin_layout Description
7961 Action Toggles visibility of a given toolbar between on/off/auto.
7964 \begin_layout Description
7965 Notion Skipping "auto" when allowauto is false.
7968 \begin_layout Description
7969 Syntax toolbar-toggle <NAME> [allowauto]
7972 \begin_layout Description
7974 standard|extra|table|math|mathmacrotemplate|
7975 \begin_inset Newline newline
7978 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
7981 \begin_layout Description
7986 \begin_layout Subsection*
7990 \begin_layout Description
7991 Action Various UI visibility-toggling actions.
7994 \begin_layout Description
7995 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
7998 \begin_layout Description
8000 Toggle visibility of the statusbar.
8001 \begin_inset Newline newline
8005 Toggle visibility of the menubar.
8006 \begin_inset Newline newline
8010 Toggle visibility of the scrollbar.
8011 \begin_inset Newline newline
8015 Toggle visibility of the frames around editing window.
8016 \begin_inset Newline newline
8020 Toggle visibility of the zoom slider in statusbar.
8021 \begin_inset Newline newline
8025 Toggle visibility of the zoom level display in statusbar.
8026 \begin_inset Newline newline
8030 Toggle visibility of the document word count in statusbar.
8031 \begin_inset Newline newline
8035 Toggle visibility of the document character count (incl.
8036 blanks) in statusbar.
8037 \begin_inset Newline newline
8041 Toggle visibility of the document character count (excl.
8042 blanks) in statusbar.
8043 \begin_inset Newline newline
8047 Toggle fullscreen mode.
8048 This also covers calling the previous functions.
8049 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
8052 \begin_layout Description
8057 \begin_layout Subsection*
8061 \begin_layout Description
8062 Action Close the current document work area.
8065 \begin_layout Description
8066 Notion Close the current work area.
8067 If no other work areas are showing the buffer,
8068 then close the associated buffer as well.
8071 \begin_layout Description
8075 \begin_layout Description
8080 \begin_layout Subsection*
8084 \begin_layout Description
8085 Action Creates another split view of current buffer.
8088 \begin_layout Description
8089 Notion All split views act in the same way independently.
8092 \begin_layout Description
8093 Syntax view-split <vertical|horizontal>
8096 \begin_layout Description
8098 The work areas are laid out side by side.
8099 \begin_inset Newline newline
8103 The work areas laid out vertically.
8106 \begin_layout Description
8111 \begin_layout Subsection*
8115 \begin_layout Description
8116 Action Closes the current LyX window.
8119 \begin_layout Description
8123 \begin_layout Description
8128 \begin_layout Subsection*
8132 \begin_layout Description
8133 Action Creates new empty LyX window.
8136 \begin_layout Description
8137 Notion Already opened documents from the previous window can be found under View menu.
8140 \begin_layout Description
8141 Syntax window-new [<GEOMETRY>]
8144 \begin_layout Description
8146 pass the geometry of the window.
8147 This parameter is currently accepted only on Windows platform.
8150 \begin_layout Description
8155 \begin_layout Section
8156 System Functions (Preferences,
8160 \begin_layout Subsection*
8161 buffer-toggle-output-sync
8164 \begin_layout Description
8165 Action Toggles including of resources for forward/reverse search of the given document.
8168 \begin_layout Description
8169 Notion When toggled on,
8170 SyncTeX is invoked for PDF,
8171 while srcltx package is used for DVI.
8172 Custom LaTeX macro can be defined in preferences.
8175 \begin_layout Description
8176 Syntax buffer-toggle-output-sync
8179 \begin_layout Description
8184 \begin_layout Subsection*
8188 \begin_layout Description
8189 Action Executes a command defined in a .def file.
8192 \begin_layout Description
8193 Notion The definitions are by default read from lib/commands/default.def.
8194 \begin_inset Newline newline
8197 A .def file allows to define a command with
8199 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and <LFUN> is the lfun code to be executed (see e.g.
8200 LFUN_COMMAND_SEQUENCE).
8203 def_file "FileName" allows to include another .def file.
8204 \begin_inset Newline newline
8207 This is particularly useful in connection with toolbar buttons:
8208 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.
8211 \begin_layout Description
8215 \begin_layout Description
8217 Name of the command that must be called.
8220 \begin_layout Description
8225 \begin_layout Subsection*
8229 \begin_layout Description
8230 Action Cancels sequence prepared by LFUN_META_PREFIX .
8233 \begin_layout Description
8237 \begin_layout Subsection*
8238 command-alternatives
8241 \begin_layout Description
8242 Action Runs the first listed command that is enabled.
8245 \begin_layout Description
8246 Notion This can be used to bind multiple functions to a single key,
8247 and then which one is used will depend upon the context.
8250 \begin_layout Description
8251 Syntax command-alternatives <CMDS>
8254 \begin_layout Description
8256 Sequence of commands separated by semicolons.
8259 \begin_layout Description
8260 Sample command-alternatives completion-accept;cell-forward
8263 \begin_layout Description
8268 \begin_layout Subsection*
8272 \begin_layout Description
8273 Action Run more commands (LFUN and its parameters) in a sequence.
8276 \begin_layout Description
8277 Syntax command-sequence <CMDS>
8280 \begin_layout Description
8282 Sequence of commands separated by semicolons.
8285 \begin_layout Description
8286 Sample command-sequence cut;
8296 \begin_layout Description
8301 \begin_layout Subsection*
8302 cursor-follows-scrollbar-toggle
8305 \begin_layout Description
8306 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
8309 \begin_layout Description
8310 Syntax toggle-cursor-follows-scrollbar
8313 \begin_layout Description
8318 \begin_layout Subsection*
8322 \begin_layout Description
8323 Action Set debug output level.
8326 \begin_layout Description
8327 Syntax debug-level-set <LEVEL>
8330 \begin_layout Description
8332 comma separated list of levels or the correspondent number of their combination.
8333 0 is equivalent to disabling all debug events.
8334 See lyx -dbg for the current list of debug levels and their numbers.
8337 \begin_layout Description
8342 \begin_layout Subsection*
8346 \begin_layout Description
8347 Action toggle a mode where more information is given in UI
8350 \begin_layout Description
8351 Notion in so called "devel" mode,
8352 the information given in the status bar is more precise,
8353 and the help documents are open in editing mode.
8356 \begin_layout Description
8357 Syntax devel-mode-toggle
8360 \begin_layout Description
8365 \begin_layout Subsection*
8369 \begin_layout Description
8370 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
8373 \begin_layout Description
8374 Notion The external program used for forward search call can be specified in LyX Output preferences.
8375 See Additional manual for details of these settings.
8378 \begin_layout Description
8379 Syntax forward-search
8382 \begin_layout Description
8387 \begin_layout Subsection*
8391 \begin_layout Description
8392 Action Apply the given settings to user preferences.
8395 \begin_layout Description
8396 Syntax lyxrc-apply <SETTINGS>
8399 \begin_layout Description
8401 settings which are to be set.
8402 Take a look into ~/.lyx/preferences to get an idea which commands to use and their syntax.
8403 lyx::LyXRC::LyXRCTags has the list of possible commands.
8406 \begin_layout Subsection*
8410 \begin_layout Description
8411 Action Shows message in statusbar (for script purposes).
8414 \begin_layout Description
8415 Syntax message <STRING>
8418 \begin_layout Description
8423 \begin_layout Subsection*
8427 \begin_layout Description
8428 Action Simulate halting Meta key (Alt key on PCs).
8431 \begin_layout Description
8432 Notion Used for buffer edition not for GUI control.
8435 \begin_layout Description
8439 \begin_layout Subsection*
8443 \begin_layout Description
8444 Action Save user preferences.
8447 \begin_layout Description
8448 Syntax preferences-save
8451 \begin_layout Description
8456 \begin_layout Subsection*
8460 \begin_layout Description
8461 Action Reconfigure the automatic settings.
8464 \begin_layout Description
8468 \begin_layout Description
8473 \begin_layout Subsection*
8477 \begin_layout Description
8478 Action Enables/disables searching for features in findadv
8481 \begin_layout Description
8482 Syntax search-ignore <type> <value>
8485 \begin_layout Description
8487 language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content
8488 \begin_inset Newline newline
8495 \begin_layout Subsection*
8499 \begin_layout Description
8500 Action Returns path and file name of the currently edited document.
8503 \begin_layout Description
8504 Syntax server-get-filename
8507 \begin_layout Subsection*
8511 \begin_layout Description
8512 Action Returns the current layout (that is environment) name on the cursor position.
8515 \begin_layout Description
8516 Syntax server-get-layout
8519 \begin_layout Subsection*
8520 server-get-statistics
8523 \begin_layout Description
8524 Action Returns the statistics (number of words and characters) in the document or in the given selection.
8527 \begin_layout Description
8528 Notion Note that this function gives the number of words/chars written,
8529 not the number of characters which will be typeset.
8532 \begin_layout Description
8533 Syntax server-get-statistics [<TYPE>]
8536 \begin_layout Description
8538 <words|chars|chars-space> The requested count;
8540 the three values are returned,
8541 separated by a space.
8542 \begin_inset Newline newline
8547 \begin_inset Newline newline
8552 \begin_inset Newline newline
8556 count characters and spaces.
8559 \begin_layout Description
8564 \begin_layout Subsection*
8568 \begin_layout Description
8569 Action Returns the coordinates of cursor position in the editing area.
8572 \begin_layout Description
8573 Syntax server-get-xy
8576 \begin_layout Subsection*
8577 server-goto-file-row
8580 \begin_layout Description
8581 Action Sets the cursor position in LyX based on the row number of generated TeX file.
8584 \begin_layout Description
8585 Notion This can be useful for DVI inverse-search or detection of the problematic line from LaTeX compilation.
8586 Note that before this function can be used export to LaTeX output must occur (in order to map the row numbers).
8589 \begin_layout Description
8590 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
8593 \begin_layout Description
8595 the path and filename.
8596 Environment variables are expanded in the path.
8597 In case this LFUN does not work make sure you are giving correct path to the file.
8598 \begin_inset Newline newline
8601 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g.
8602 for the case of generated .tex file).
8603 \begin_inset Newline newline
8607 extensions will be automatically replaced by .lyx.
8608 \begin_inset Newline newline
8611 <ROW_NUMBER> The row number of the LaTeX file to which to go.
8614 \begin_layout Description
8615 Sample server-goto-file-row /home/user/example.lyx 41
8616 \begin_inset Newline newline
8619 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
8622 \begin_layout Description
8627 \begin_layout Subsection*
8631 \begin_layout Description
8632 Action Sends notify message about the last key-sequence to client.
8635 \begin_layout Description
8636 Notion This can be used to grab last key-sequence used inside the LyX window.
8637 See also Debug extensions section in Additional features manual.
8640 \begin_layout Description
8641 Syntax server-notify
8644 \begin_layout Subsection*
8648 \begin_layout Description
8649 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
8652 \begin_layout Description
8653 Syntax server-set-xy <X> <Y>
8656 \begin_layout Subsection*
8660 \begin_layout Description
8661 Action Set the given LyX color to the color defined by the X11 name given,
8662 and optionally a specific color for dark mode.
8665 \begin_layout Description
8666 Notion A new color entry is created if the color is unknown.
8667 Color names can be stored as a part of user settings.
8670 \begin_layout Description
8671 Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
8674 \begin_layout Description
8679 \begin_layout Subsection*
8683 \begin_layout Description
8684 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
8687 \begin_layout Description
8688 Notion Note that this function gives the number of words/chars written,
8689 not the number of characters which will be typeset.
8692 \begin_layout Description
8696 \begin_layout Description
8703 \begin_layout Subsection*
8707 \begin_layout Description
8708 Action Checks-in/commits the changes of the registered file to the repository.
8711 \begin_layout Description
8712 Notion In RCS case this also unlocks the file.
8715 \begin_layout Description
8719 \begin_layout Description
8724 \begin_layout Subsection*
8728 \begin_layout Description
8729 Action Checks-out the document for edit (and locks it in some cases).
8732 \begin_layout Description
8736 \begin_layout Description
8741 \begin_layout Subsection*
8745 \begin_layout Description
8746 Action Executes external command.
8747 This command is intended to support additional VCS commands.
8750 \begin_layout Description
8751 Syntax vc-command <FLAG> <PATH> <COMMAND>
8754 \begin_layout Description
8756 Flags for the command can be combined together.
8757 \begin_inset Newline newline
8760 U - dUmmy - no flags
8761 \begin_inset Newline newline
8764 D - Doc - need document loaded to proceed
8765 \begin_inset Newline newline
8768 I - dIrty - mark document dirty
8769 \begin_inset Newline newline
8772 R - Reload - ensure that the document is saved and reload it after command execution
8773 \begin_inset Newline newline
8776 M - Message - ask for input string (commit message)
8777 \begin_inset Newline newline
8781 path where to start.
8782 $$p will be replaced by the current document path.
8783 \begin_inset Newline newline
8788 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
8791 \begin_layout Description
8792 Sample vc-command DR $$p "svn up"
8795 \begin_layout Description
8800 \begin_layout Subsection*
8804 \begin_layout Description
8805 Action Compares two revisions of the same file under version control.
8808 \begin_layout Description
8809 Syntax vc-compare [<REV1>] [<REV2>]
8812 \begin_layout Description
8813 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
8814 \begin_inset Newline newline
8817 In RCS we subtract only in the last number of revision specification.
8818 Special case "0" is reserved for the last committed revision.
8819 \begin_inset Newline newline
8824 \begin_inset Newline newline
8829 Used only if REV1 > 0.
8830 \begin_inset Newline newline
8833 If no parameter is given,
8834 interactive dialog will be shown.
8837 \begin_layout Description
8838 Sample Compare current document against last commit
8839 \begin_inset Newline newline
8843 \begin_inset Newline newline
8846 Compare current document against current revision - 5 commits
8847 \begin_inset Newline newline
8851 \begin_inset Newline newline
8854 Compare revisions 120 and 155
8855 \begin_inset Newline newline
8861 \begin_layout Description
8866 \begin_layout Subsection*
8870 \begin_layout Description
8871 Action Copies the document to another name.
8874 \begin_layout Description
8875 Notion Copying with revision history is only supported by SVN.
8876 For RCS and CVS it is simulated by adding the document under a new name.
8877 Disabled if uncommitted changes exist.
8880 \begin_layout Description
8881 Syntax vc-copy <FILENAME>
8884 \begin_layout Description
8886 New name of the document.
8887 \begin_inset Newline newline
8890 A file dialog is opened if no filename is given.
8893 \begin_layout Description
8898 \begin_layout Subsection*
8902 \begin_layout Description
8903 Action Toggles the locking property of the edited file.
8906 \begin_layout Description
8907 Notion This is currently implemented only for SVN.
8910 \begin_layout Description
8911 Syntax vc-locking-toggle
8914 \begin_layout Description
8919 \begin_layout Subsection*
8923 \begin_layout Description
8924 Action Register the document as an file inside version control system.
8927 \begin_layout Description
8928 Notion File is registered inside cvs,
8929 svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
8930 \begin_inset Newline newline
8933 See LyX Additional Features Manual (Version Control Chapter) for additional information.
8936 \begin_layout Description
8940 \begin_layout Description
8945 \begin_layout Subsection*
8949 \begin_layout Description
8950 Action Renames the document to another name.
8953 \begin_layout Description
8954 Notion Renaming with revision history is only supported by SVN.
8955 For CVS it is simulated by adding the document under a new name and deleting the old one.
8956 For RCS it is not supported.
8957 Disabled if uncommitted changes exist.
8960 \begin_layout Description
8961 Syntax vc-rename <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 Update the local archive directory in which resides the current document with the remote repository.
8986 \begin_layout Description
8987 Syntax vc-repo-update
8990 \begin_layout Description
8995 \begin_layout Subsection*
8999 \begin_layout Description
9000 Action Reverts the document to the last check-in/commit in VCS.
9003 \begin_layout Description
9007 \begin_layout Description
9012 \begin_layout Subsection*
9016 \begin_layout Description
9017 Action Undo last check-in.
9020 \begin_layout Description
9021 Notion This is currently implemented only for RCS.
9024 \begin_layout Description
9028 \begin_layout Description
9033 \begin_layout Section
9034 Hidden Functions (not listed for configuration)
9037 \begin_layout Subsection*
9041 \begin_layout Description
9042 Action Return the current key sequence and available options as a string.
9045 \begin_layout Description
9046 Notion No options are added if no current map exists.
9047 \begin_inset Newline newline
9050 This is probably usable only with connection to lyxserver.
9053 \begin_layout Description
9054 Syntax command-prefix
9057 \begin_layout Subsection*
9061 \begin_layout Description
9062 Action Activates the LyX window.
9065 \begin_layout Description
9066 Notion On Linux and Mac OS,
9067 this action brings the LyX window into focus.
9068 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.
9069 This action is useful in combination with reverse search.
9072 \begin_layout Description
9076 \begin_layout Description
9081 \begin_layout Subsection*
9085 \begin_layout Description
9086 Action Inserts the given string (accordingly to the correct keymap).
9089 \begin_layout Description
9090 Notion Automatically replace the currently selected text.
9091 Depends on lyxrc settings "auto_region_delete".
9094 \begin_layout Description
9095 Syntax self-insert <STRING>
9098 \begin_layout Subsection*
9102 \begin_layout Description
9103 Action Raises the LyX window.
9106 \begin_layout Description
9107 Notion Brings the LyX window to the front.
9108 Such behavior is allowed on Windows only when no other application has focus.
9109 This action is used when LyX is in single instance mode.
9112 \begin_layout Description
9116 \begin_layout Description