1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
10 \renewenvironment{description}{\list{}{%
11 \setlength{\itemsep}{-2pt}
12 \advance\leftmargini6\p@ \itemindent-12\p@
13 \labelwidth\z@ \let\makelabel\descriptionlabel}%
18 \use_default_options false
19 \maintain_unincluded_children no
27 \language_package default
28 \inputencoding auto-legacy
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
39 \font_typewriter_osf false
40 \font_sf_scale 100 100
41 \font_tt_scale 100 100
43 \use_dash_ligatures true
45 \default_output_format default
47 \bibtex_command default
48 \index_command default
49 \paperfontsize default
54 \use_package amsmath 1
55 \use_package amssymb 1
58 \use_package mathdots 0
59 \use_package mathtools 0
61 \use_package stackrel 0
62 \use_package stmaryrd 0
63 \use_package undertilde 0
65 \cite_engine_type default
69 \paperorientation portrait
86 \paragraph_separation indent
87 \paragraph_indentation default
89 \math_numbering_side default
94 \paperpagestyle default
96 \tracking_changes true
99 \postpone_fragile_content false
102 \html_be_strict false
103 \docbook_table_output 0
104 \docbook_mathml_prefix 1
105 \author -584632292 "Richard Kimberly Heck"
120 \begin_layout Section*
124 \begin_layout Standard
125 This manual documents the
126 \begin_inset Quotes eld
130 \begin_inset Quotes erd
134 These are commands that are used to make \SpecialChar LyX
135 perform specific actions.
137 itself uses these functions internally,
138 and every internal action is bound to an LFUN.
141 \begin_layout Standard
142 LFUNs are also used in the files that define keyboard shortcuts,
143 menu or toolbar items.
144 So if you want to change\SpecialChar breakableslash
145 customize the user interface,
146 you need to deal with LFUNs.
148 external programs can use LFUNs to communicate with and
149 \begin_inset Quotes eld
153 \begin_inset Quotes erd
159 you can also issue LFUNs directly via the so called mini-buffer which can be opened via
162 arg "command-execute"
166 \change_inserted -584632292 1712005995
170 \begin_layout Standard
172 \change_inserted -584632292 1712006077
174 when multiple optional arguments are shown,
175 the earlier arguments must be given if later ones are to be given.
179 <LEVEL> can be given alone,
180 without <SIDE> and <STYLE>,
181 but it must be given if <SIDE> is given,
182 and all three must be given if <STYLE> is to be given.
187 \begin_layout Standard
189 all LFUNs are listed,
190 categorized by function.
193 \begin_layout Section
194 Layout Functions (Font,
195 Layout and Textclass related)
198 \begin_layout Subsection*
202 \begin_layout Description
203 Action Displays list of layout choices.
206 \begin_layout Description
207 Notion This LFUN opens the dropbox allowing for choice of layout.
210 \begin_layout Description
211 Syntax drop-layouts-choice
214 \begin_layout Subsection*
218 \begin_layout Description
219 Action Splits the current environment with a Separator.
222 \begin_layout Description
223 Syntax environment-split [before|outer|previous]
226 \begin_layout Description
229 LyX will split the outermost environment in the current nesting hierarchy.
230 \begin_inset Newline newline
235 LyX will split the environment in the previous paragraph (if there is one).
236 \begin_inset Newline newline
241 the new environment will be appended rather than prepended.
244 \begin_layout Description
249 \begin_layout Subsection*
253 \begin_layout Description
254 Action Toggles the bold font (selection-wise) using mathbf in math.
257 \begin_layout Description
261 \begin_layout Subsection*
265 \begin_layout Description
266 Action Toggles the bold font (selection-wise) using boldsymbol in math.
269 \begin_layout Description
270 Syntax font-boldsymbol
273 \begin_layout Subsection*
277 \begin_layout Description
278 Action Toggles xout (cross-through) in the font (selection-wise).
281 \begin_layout Description
285 \begin_layout Description
290 \begin_layout Subsection*
294 \begin_layout Description
295 Action Reverts the settings of the font to the default values (selection-wise).
298 \begin_layout Description
302 \begin_layout Subsection*
306 \begin_layout Description
307 Action Toggles the emphasis font style (selection-wise).
310 \begin_layout Description
314 \begin_layout Subsection*
318 \begin_layout Description
319 Action Toggles Fraktur family font (math-mode,
323 \begin_layout Description
327 \begin_layout Description
332 \begin_layout Subsection*
336 \begin_layout Description
337 Action Toggles Italics font shape (math-mode,
341 \begin_layout Description
345 \begin_layout Description
350 \begin_layout Subsection*
354 \begin_layout Description
355 Action Toggles nospellcheck status in the font (selection-wise).
358 \begin_layout Description
359 Syntax font-nospellcheck
362 \begin_layout Description
367 \begin_layout Subsection*
371 \begin_layout Description
372 Action Toggles Noun text style font (selection-wise).
375 \begin_layout Description
379 \begin_layout Subsection*
383 \begin_layout Description
384 Action Toggles Roman family font (selection-wise).
387 \begin_layout Description
391 \begin_layout Subsection*
395 \begin_layout Description
396 Action Toggles Sans Serif family font (selection-wise).
399 \begin_layout Description
403 \begin_layout Subsection*
407 \begin_layout Description
408 Action Sets font size according to lyx format string.
411 \begin_layout Description
412 Syntax font-size <SIZE>
415 \begin_layout Description
417 tiny|scriptsize|footnotesize|small|normal|large|larger|
418 \begin_inset Newline newline
421 largest|huge|giant|increase|decrease|default
424 \begin_layout Subsection*
428 \begin_layout Description
429 Action Returns the info about the current font.
432 \begin_layout Description
436 \begin_layout Subsection*
440 \begin_layout Description
441 Action Toggles strikeout (strike-through) in the font (selection-wise).
444 \begin_layout Description
445 Syntax font-strikeout
448 \begin_layout Description
453 \begin_layout Subsection*
457 \begin_layout Description
458 Action Toggles the typewriter family font (selection-wise).
461 \begin_layout Description
462 Syntax font-typewriter
465 \begin_layout Subsection*
469 \begin_layout Description
470 Action Toggles underline in the font (selection-wise).
473 \begin_layout Description
474 Syntax font-underline
477 \begin_layout Subsection*
481 \begin_layout Description
482 Action Toggles double underline in the font (selection-wise).
485 \begin_layout Description
486 Syntax font-underunderline
489 \begin_layout Description
494 \begin_layout Subsection*
498 \begin_layout Description
499 Action Toggles wavy underline in the font (selection-wise).
502 \begin_layout Description
503 Syntax font-underwave
506 \begin_layout Description
511 \begin_layout Subsection*
515 \begin_layout Description
516 Action Sets the layout (that is,
517 environment) for the current paragraph.
520 \begin_layout Description
521 Syntax layout <LAYOUT> [ignoreautonests]
524 \begin_layout Description
527 \begin_inset Newline newline
532 nesting advices will be ignored.
535 \begin_layout Subsection*
539 \begin_layout Description
540 Action Adds a module.
543 \begin_layout Description
544 Notion Adds a module to the list of included modules for the current buffer.
547 \begin_layout Description
548 Syntax layout-module-add <MODULE>
551 \begin_layout Description
553 the module to be added
556 \begin_layout Description
561 \begin_layout Subsection*
565 \begin_layout Description
566 Action Clears the module list.
569 \begin_layout Description
570 Notion Clears the list of included modules for the current buffer.
573 \begin_layout Description
574 Syntax layout-modules-clear
577 \begin_layout Description
582 \begin_layout Subsection*
586 \begin_layout Description
587 Action Launches the paragraph settings dialog.
590 \begin_layout Description
591 Syntax layout-paragraph
594 \begin_layout Subsection*
598 \begin_layout Description
599 Action Reloads layout information.
602 \begin_layout Description
603 Notion Reloads all layout information for the current buffer from disk,
604 thus recognizing any changes that have been made to layout files on the fly.
605 This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
608 \begin_layout Description
612 \begin_layout Description
617 \begin_layout Subsection*
621 \begin_layout Description
622 Action Launches the tabular settings dialog.
625 \begin_layout Description
626 Syntax layout-tabular
629 \begin_layout Description
634 \begin_layout Subsection*
638 \begin_layout Description
639 Action Toggles the layout (that is,
640 environment) for the current paragraph.
643 \begin_layout Description
644 Notion Contrary to `layout',
645 this function resets the current (or selection) layout to the standard layout it already has the correct layout.
646 Useful for toolbar icons.
649 \begin_layout Description
650 Syntax layout-toggle <LAYOUT> [ignoreautonests]
653 \begin_layout Description
656 \begin_inset Newline newline
661 nesting advices will be ignored.
664 \begin_layout Description
669 \begin_layout Subsection*
673 \begin_layout Description
674 Action Update fonts and its metrics.
677 \begin_layout Description
678 Notion Automatically called after zoom,
684 \begin_layout Description
685 Syntax screen-font-update
688 \begin_layout Description
693 \begin_layout Subsection*
697 \begin_layout Description
698 Action Sets the text class for the current buffer.
701 \begin_layout Description
702 Syntax textclass-apply <TEXTCLASS>
705 \begin_layout Description
707 the textclass to set.
708 Note that this must be the filename,
709 minus the ".layout" extension.
712 \begin_layout Subsection*
716 \begin_layout Description
717 Action Loads information for a textclass from disk.
720 \begin_layout Description
721 Syntax textclass-load <TEXTCLASS>
724 \begin_layout Description
726 the textclass to load.
727 Note that this must be the filename,
728 minus the ".layout" extension.
731 \begin_layout Subsection*
735 \begin_layout Description
736 Action Apply last used text properties.
739 \begin_layout Description
740 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE,
741 which is automatically triggered when using Text Style dialog.
744 \begin_layout Description
745 Syntax textstyle-apply [<NUM>]textstyle-apply
748 \begin_layout Description
750 number of the selection in the internal freefonts stack to be applied.
753 \begin_layout Description
758 \begin_layout Subsection*
762 \begin_layout Description
763 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
766 \begin_layout Description
767 Syntax textstyle-update <FONT_INFO>
770 \begin_layout Description
772 specifies font attributes,
785 \begin_inset Newline newline
788 Use lyx -dbg action for exact syntax of text-style dialog parameters.
791 \begin_layout Description
796 \begin_layout Section
797 Editing Functions (Cursor and Mouse Movement,
801 \begin_layout Subsection*
805 \begin_layout Description
806 Action Adds an acute accent to the next character typed.
809 \begin_layout Description
813 \begin_layout Subsection*
817 \begin_layout Description
818 Action Adds a breve accent to the next character typed.
821 \begin_layout Description
825 \begin_layout Subsection*
829 \begin_layout Description
830 Action Adds a caron to the next character typed.
833 \begin_layout Description
837 \begin_layout Subsection*
841 \begin_layout Description
842 Action Adds a cedilla to the next character typed.
845 \begin_layout Description
846 Syntax accent-cedilla
849 \begin_layout Subsection*
853 \begin_layout Description
854 Action Adds a circle accent to the next character typed.
857 \begin_layout Description
861 \begin_layout Subsection*
865 \begin_layout Description
866 Action Adds a circumflex to the next character typed.
869 \begin_layout Description
870 Syntax accent-circumflex
873 \begin_layout Subsection*
877 \begin_layout Description
878 Action Adds a dot accent to the next character typed.
881 \begin_layout Description
885 \begin_layout Subsection*
889 \begin_layout Description
890 Action Adds a grave accent to the next character typed.
893 \begin_layout Description
897 \begin_layout Subsection*
898 accent-hungarian-umlaut
901 \begin_layout Description
902 Action Adds a Hungarian umlaut to the next character typed.
905 \begin_layout Description
909 \begin_layout Subsection*
913 \begin_layout Description
914 Action Adds a macron to the next character typed.
917 \begin_layout Description
921 \begin_layout Subsection*
925 \begin_layout Description
926 Action Adds an ogonek accent to the next character typed.
929 \begin_layout Description
933 \begin_layout Subsection*
937 \begin_layout Description
938 Action Adds a perispomeni (Greek circumflex) over the next character typed.
941 \begin_layout Description
942 Syntax accent-perispomeni
945 \begin_layout Subsection*
949 \begin_layout Description
950 Action Adds a tie over the next two character typed.
953 \begin_layout Description
954 Notion The following char will finish the tie.
957 \begin_layout Description
961 \begin_layout Subsection*
965 \begin_layout Description
966 Action Adds a tilde over the next character typed.
969 \begin_layout Description
973 \begin_layout Subsection*
977 \begin_layout Description
978 Action Adds an umlaut over the next character typed.
981 \begin_layout Description
985 \begin_layout Subsection*
989 \begin_layout Description
990 Action Adds a bar under the next character typed.
993 \begin_layout Description
994 Syntax accent-underbar
997 \begin_layout Subsection*
1001 \begin_layout Description
1002 Action Adds a dot under the next character typed.
1005 \begin_layout Description
1006 Syntax accent-underdot
1009 \begin_layout Subsection*
1013 \begin_layout Description
1014 Action Accepts all tracked changes in the document.
1017 \begin_layout Description
1018 Syntax all-changes-accept
1021 \begin_layout Description
1026 \begin_layout Subsection*
1030 \begin_layout Description
1031 Action Rejects all tracked changes in the document.
1034 \begin_layout Description
1035 Notion Reject does not work recursively;
1036 the user may have to repeat the operation.
1039 \begin_layout Description
1040 Syntax all-changes-reject
1043 \begin_layout Description
1048 \begin_layout Subsection*
1052 \begin_layout Description
1053 Action Start (or remove) Appendix on the given cursor position.
1056 \begin_layout Description
1060 \begin_layout Description
1065 \begin_layout Subsection*
1069 \begin_layout Description
1070 Action Inserts an argument (short title) inset.
1073 \begin_layout Description
1074 Syntax argument-insert <argument nr>
1077 \begin_layout Description
1078 Params <argument nr>:
1079 see layout declarations
1082 \begin_layout Description
1087 \begin_layout Subsection*
1091 \begin_layout Description
1092 Action Adds database,
1093 which will be used for bibtex citations.
1096 \begin_layout Description
1097 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1100 \begin_layout Description
1101 Syntax bibtex-database-add <DATABASE-NAME>
1104 \begin_layout Description
1109 \begin_layout Subsection*
1113 \begin_layout Description
1114 Action Adds database,
1115 which will be used for bibtex citations.
1118 \begin_layout Description
1119 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
1122 \begin_layout Description
1123 Syntax bibtex-database-del <DATABASE-NAME>
1126 \begin_layout Description
1131 \begin_layout Subsection*
1135 \begin_layout Description
1136 Action Clears the list of saved bookmarks.
1139 \begin_layout Description
1140 Syntax bookmark-clear
1143 \begin_layout Description
1148 \begin_layout Subsection*
1152 \begin_layout Description
1153 Action Moves the cursor to the numbered bookmark,
1154 opening the file if necessary.
1155 Note that bookmarks are saved per-session,
1159 \begin_layout Description
1160 Notion Bookmark 0 has a special purpose.
1161 It is automatically set
1162 \begin_inset Newline newline
1166 to the paragraph you are currently editing
1167 \begin_inset Newline newline
1171 to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1172 \begin_inset Newline newline
1176 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1179 \begin_layout Description
1180 Syntax bookmark-goto <NUMBER>
1183 \begin_layout Description
1185 the number of the bookmark to restore.
1188 \begin_layout Description
1193 \begin_layout Subsection*
1197 \begin_layout Description
1198 Action Save a bookmark.
1201 \begin_layout Description
1202 Notion Saves a numbered bookmark to the sessions file.
1203 The number must be between 1 and 9,
1205 Note that bookmarks are saved per-session,
1209 \begin_layout Description
1210 Syntax bookmark-save <NUMBER>
1213 \begin_layout Description
1215 the number of the bookmark to save.
1218 \begin_layout Description
1223 \begin_layout Subsection*
1227 \begin_layout Description
1228 Action Inserts Box inset.
1231 \begin_layout Description
1232 Syntax box-insert [<TYPE>]
1235 \begin_layout Description
1237 Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1238 \begin_inset Newline newline
1241 Framed is the default one.
1244 \begin_layout Description
1249 \begin_layout Subsection*
1253 \begin_layout Description
1254 Action Inserts branch inset.
1257 \begin_layout Description
1258 Syntax branch-insert <BRANCH-NAME>
1261 \begin_layout Description
1266 \begin_layout Subsection*
1270 \begin_layout Description
1271 Action For debug purposes only.
1272 Convert all [a-zA-Z0-1] characters to single character.
1273 Useful when submitting docs to list or bugzilla.
1276 \begin_layout Description
1277 Syntax buffer-anonymize
1280 \begin_layout Description
1285 \begin_layout Subsection*
1289 \begin_layout Description
1290 Action Move the cursor to the beginning of the document.
1293 \begin_layout Description
1297 \begin_layout Subsection*
1301 \begin_layout Description
1302 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1305 \begin_layout Description
1306 Syntax buffer-begin-select
1309 \begin_layout Subsection*
1313 \begin_layout Description
1314 Action Move the cursor to the end of the document.
1317 \begin_layout Description
1321 \begin_layout Subsection*
1325 \begin_layout Description
1326 Action Move the cursor to the end of the document adding the traversed text to the selection.
1329 \begin_layout Description
1330 Syntax buffer-end-select
1333 \begin_layout Subsection*
1337 \begin_layout Description
1338 Action Inserts a caption inset.
1341 \begin_layout Description
1342 Syntax caption-insert
1345 \begin_layout Description
1350 \begin_layout Subsection*
1354 \begin_layout Description
1355 Action Moves the cursor to the previous cell inside the table.
1358 \begin_layout Description
1359 Syntax cell-backward
1362 \begin_layout Description
1367 \begin_layout Subsection*
1371 \begin_layout Description
1372 Action Moves the cursor to the next cell inside the table.
1375 \begin_layout Description
1379 \begin_layout Subsection*
1383 \begin_layout Description
1384 Action Splits cell and shifts right part to the next cell (inside the math grid).
1387 \begin_layout Description
1391 \begin_layout Description
1396 \begin_layout Subsection*
1400 \begin_layout Description
1401 Action Accepts tracked change inside the selection.
1404 \begin_layout Description
1405 Syntax change-accept
1408 \begin_layout Description
1413 \begin_layout Subsection*
1417 \begin_layout Description
1418 Action Moves the cursor to the position of the next change of the change tracking records.
1421 \begin_layout Description
1425 \begin_layout Description
1430 \begin_layout Subsection*
1434 \begin_layout Description
1435 Action Moves the cursor to the position of the previous change of the change tracking records.
1438 \begin_layout Description
1439 Syntax change-previous
1442 \begin_layout Description
1447 \begin_layout Subsection*
1451 \begin_layout Description
1452 Action Rejects tracked change inside the selection.
1455 \begin_layout Description
1456 Syntax change-reject
1459 \begin_layout Description
1464 \begin_layout Subsection*
1468 \begin_layout Description
1469 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1472 \begin_layout Description
1473 Syntax changes-merge
1476 \begin_layout Description
1481 \begin_layout Subsection*
1485 \begin_layout Description
1486 Action Toggles showing of change tracking in typeset output.
1489 \begin_layout Description
1490 Syntax changes-output
1493 \begin_layout Description
1498 \begin_layout Subsection*
1502 \begin_layout Description
1503 Action Toggles change tracking to on/off.
1506 \begin_layout Description
1507 Syntax changes-track
1510 \begin_layout Description
1515 \begin_layout Subsection*
1519 \begin_layout Description
1520 Action Moves the cursor one position logically backwards.
1523 \begin_layout Description
1524 Notion This is not the action which should be bound to the arrow keys,
1525 because backwards may be left or right,
1526 depending on the language.
1527 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1528 which in turn may employ this one.
1531 \begin_layout Description
1532 Syntax char-backward
1535 \begin_layout Subsection*
1536 char-backward-select
1539 \begin_layout Description
1540 Action Moves the cursor one position logically backwards,
1541 adding traversed position to the selection.
1544 \begin_layout Description
1545 Notion See also LFUN_CHAR_BACKWARD.
1548 \begin_layout Description
1549 Syntax char-backward-select
1552 \begin_layout Subsection*
1553 char-delete-backward
1556 \begin_layout Description
1557 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1560 \begin_layout Description
1561 Syntax char-delete-backward [confirm]
1564 \begin_layout Description
1567 do not directly delete them.
1570 \begin_layout Subsection*
1574 \begin_layout Description
1575 Action Deletes one character in the backward direction (usually the "Delete" key).
1578 \begin_layout Description
1579 Syntax char-delete-forward [confirm]
1582 \begin_layout Description
1585 do not directly delete them.
1588 \begin_layout Subsection*
1592 \begin_layout Description
1593 Action Moves the cursor one position logically forward.
1596 \begin_layout Description
1597 Notion This is not the action which should be bound to the arrow keys,
1598 because forward may be left or right,
1599 depending on the language.
1600 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1601 which in turn may employ this one.
1604 \begin_layout Description
1608 \begin_layout Subsection*
1612 \begin_layout Description
1613 Action Moves the cursor one position logically forward,
1614 adding traversed position to the selection.
1617 \begin_layout Description
1618 Notion See also LFUN_CHAR_FORWARD.
1621 \begin_layout Description
1622 Syntax char-forward-select
1625 \begin_layout Subsection*
1629 \begin_layout Description
1630 Action Moves the cursor one position "to the left".
1633 \begin_layout Description
1634 Notion This is the action which should be taken when the "left" key is pressed.
1636 it moves the cursor one position to the left.
1638 in Bidi text this become slightly more complicated,
1639 and there are different modes of cursor movement.
1644 movement is logically forward in RTL paragraphs,
1645 and logically backwards in LTR paragraphs.
1648 \begin_layout Description
1652 \begin_layout Subsection*
1656 \begin_layout Description
1657 Action Moves the cursor one position "to the left",
1658 adding traversed position to the selection.
1661 \begin_layout Description
1662 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1665 \begin_layout Description
1666 Syntax char-left-select
1669 \begin_layout Subsection*
1673 \begin_layout Description
1674 Action Moves the cursor one position "to the right".
1677 \begin_layout Description
1678 Notion This is the action which should be taken when the "right" key is pressed.
1680 it moves the cursor one position to the right.
1682 in Bidi text this become slightly more complicated,
1683 and there are different modes of cursor movement.
1688 movement is logically forward in LTR paragraphs,
1689 and logically backwards in RTL paragraphs.
1692 \begin_layout Description
1696 \begin_layout Subsection*
1700 \begin_layout Description
1701 Action Moves the cursor one position "to the right",
1702 adding traversed position to the selection.
1705 \begin_layout Description
1706 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1709 \begin_layout Description
1710 Syntax char-right-select
1713 \begin_layout Subsection*
1717 \begin_layout Description
1718 Action Transposes the character at the cursor with the one before it.
1721 \begin_layout Description
1722 Syntax chars-transpose
1725 \begin_layout Description
1730 \begin_layout Subsection*
1734 \begin_layout Description
1735 Action Inserts citation from loaded citation database.
1738 \begin_layout Description
1739 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1742 \begin_layout Description
1744 Citation (shortcut listed in available citations).
1745 \begin_inset Newline newline
1749 text which should appear before citation.
1752 \begin_layout Description
1757 \begin_layout Subsection*
1761 \begin_layout Description
1762 Action Opens the corresponding pdf/url for a given citation inset.
1765 \begin_layout Description
1766 Syntax citation-open [EXTERNAL] TARGET
1769 \begin_layout Description
1771 URL (https:,file:) of the document.
1772 \begin_inset Newline newline
1776 Use external executable script for finding target
1777 \begin_inset Newline newline
1780 and launching viewer.
1781 In this case TARGET consists of author and year
1782 \begin_inset Newline newline
1785 and will be passed as an input argument to the script.
1788 \begin_layout Description
1793 \begin_layout Subsection*
1797 \begin_layout Description
1798 Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text).
1799 Pastes plain text if plain text is on the clipboard,
1800 but tries to interpret it in special ways for certain insets,
1802 converting csv data to rows and columns if the paste happens in a tabular inset.
1805 \begin_layout Description
1806 Notion Historically,
1807 LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE:
1808 It behaved exactly the same,
1809 but the source is the clipboard,
1813 \begin_layout Description
1814 Syntax clipboard-paste [<ARG>]
1817 \begin_layout Description
1819 "paragraph" will cause pasting as one paragraph,
1824 \begin_layout Description
1829 \begin_layout Subsection*
1830 clipboard-paste-simple
1833 \begin_layout Description
1834 Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard.
1835 Pastes plain text if plain text is on the clipboard,
1836 without trying to interpret it in special ways for certain insets,
1838 converting csv data to rows and columns if the paste happens in a tabular inset.
1841 \begin_layout Description
1842 Syntax clipboard-paste-simple [<ARG>]
1845 \begin_layout Description
1847 "paragraph" will cause pasting as one paragraph,
1852 \begin_layout Subsection*
1856 \begin_layout Description
1857 Action Switches the focus to the minibuffer so that the user can type in there.
1859 it opens the minibuffer toolbar.
1862 \begin_layout Description
1863 Notion Usually bound to M-x shortcut.
1866 \begin_layout Description
1867 Syntax command-execute
1870 \begin_layout Subsection*
1874 \begin_layout Description
1875 Action Try to complete the word or command at the cursor position.
1878 \begin_layout Description
1882 \begin_layout Description
1887 \begin_layout Subsection*
1891 \begin_layout Description
1892 Action Accept suggested completion.
1895 \begin_layout Description
1896 Syntax completion-accept
1899 \begin_layout Description
1904 \begin_layout Subsection*
1908 \begin_layout Description
1909 Action Try to cancel completion,
1910 either the popup or the inline completion.
1913 \begin_layout Description
1914 Syntax completion-cancel
1917 \begin_layout Description
1922 \begin_layout Subsection*
1926 \begin_layout Description
1927 Action Show the inline completion at the cursor position.
1930 \begin_layout Description
1931 Syntax completion-inline
1934 \begin_layout Description
1939 \begin_layout Subsection*
1943 \begin_layout Description
1944 Action Show the completion popup at the cursor position.
1947 \begin_layout Description
1948 Syntax completion-popup
1951 \begin_layout Description
1956 \begin_layout Subsection*
1960 \begin_layout Description
1961 Action Copies the current selection to the clipboard.
1964 \begin_layout Description
1968 \begin_layout Subsection*
1972 \begin_layout Description
1973 Action Cuts to the clipboard.
1976 \begin_layout Description
1980 \begin_layout Subsection*
1984 \begin_layout Description
1985 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1988 \begin_layout Description
1989 Syntax depth-decrement
1992 \begin_layout Subsection*
1996 \begin_layout Description
1997 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
2000 \begin_layout Description
2001 Syntax depth-increment
2004 \begin_layout Subsection*
2005 dialog-disconnect-inset
2008 \begin_layout Description
2009 Action Closes opened connection to opened inset.
2012 \begin_layout Description
2013 Notion Connection is used for apply functions.
2016 \begin_layout Description
2017 Syntax dialog-disconnect-inset <INSET-NAME>
2020 \begin_layout Description
2025 \begin_layout Subsection*
2029 \begin_layout Description
2030 Action Hides showed dialog.
2031 Counterpart to LFUN_DIALOG_SHOW .
2034 \begin_layout Description
2035 Syntax dialog-hide <NAME>
2038 \begin_layout Description
2039 Params See LFUN_DIALOG_SHOW .
2042 \begin_layout Description
2047 \begin_layout Subsection*
2051 \begin_layout Description
2052 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
2055 \begin_layout Description
2056 Syntax dialog-show <NAME> [<DATA>]
2059 \begin_layout Description
2061 aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
2062 \begin_inset Newline newline
2065 compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
2066 \begin_inset Newline newline
2069 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
2070 \begin_inset Newline newline
2073 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
2074 \begin_inset Newline newline
2077 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
2078 \begin_inset Newline newline
2081 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
2082 \begin_inset Newline newline
2087 \begin_inset Newline newline
2092 usually settings for the given dialog.
2093 Use debug mode for the details.
2096 \begin_layout Description
2101 \begin_layout Subsection*
2102 dialog-show-new-inset
2105 \begin_layout Description
2106 Action Shows hidden dialog or create new one for a given inset settings etc.
2109 \begin_layout Description
2110 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
2113 \begin_layout Description
2114 Syntax dialog-show-new-inset <NAME> [<DATA>]
2117 \begin_layout Description
2118 Params See LFUN_DIALOG_SHOW .
2121 \begin_layout Description
2126 \begin_layout Subsection*
2130 \begin_layout Description
2131 Action Toggles dialog between showed/hidden state.
2134 \begin_layout Description
2135 Notion Internally uses LFUN_DIALOG_SHOW ,
2139 \begin_layout Description
2140 Syntax dialog-toggle <NAME> [<DATA>]
2143 \begin_layout Description
2144 Params See LFUN_DIALOG_SHOW .
2147 \begin_layout Description
2152 \begin_layout Subsection*
2156 \begin_layout Description
2157 Action Updates the dialog values from the inset/paragraph/document.
2160 \begin_layout Description
2161 Syntax dialog-update <NAME>
2164 \begin_layout Description
2166 paragraph|prefs|<INSET>
2167 \begin_inset Newline newline
2174 \begin_layout Description
2179 \begin_layout Subsection*
2183 \begin_layout Description
2184 Action Moves the cursor one line in downward direction.
2187 \begin_layout Description
2191 \begin_layout Subsection*
2195 \begin_layout Description
2196 Action Moves the cursor one line in downward direction adding the current position to the selection.
2199 \begin_layout Description
2203 \begin_layout Subsection*
2207 \begin_layout Description
2208 Action Inserts an ERT inset.
2211 \begin_layout Description
2215 \begin_layout Description
2220 \begin_layout Subsection*
2224 \begin_layout Description
2225 Action Clears the selection.
2226 If no text is selected call LFUN_FINISHED_FORWARD.
2227 Inside math mode jumps out of the math inset.
2230 \begin_layout Description
2234 \begin_layout Description
2239 \begin_layout Subsection*
2243 \begin_layout Description
2244 Action Cancel background export process.
2247 \begin_layout Description
2248 Syntax export-cancel
2251 \begin_layout Description
2256 \begin_layout Subsection*
2260 \begin_layout Description
2261 Action Inserts another LyX file.
2264 \begin_layout Description
2265 Syntax file-insert [<FILE>] [ignorelang]
2268 \begin_layout Description
2270 Filename to be inserted.
2273 the (main) language of the inserted file is ignored (the context language is used).
2276 \begin_layout Subsection*
2277 file-insert-plaintext
2280 \begin_layout Description
2281 Action Inserts plain text file.
2284 \begin_layout Description
2285 Syntax file-insert-plaintext [<FILE>]
2288 \begin_layout Description
2290 Filename to be inserted.
2293 \begin_layout Description
2298 \begin_layout Subsection*
2299 file-insert-plaintext-para
2302 \begin_layout Description
2303 Action Inserts plain text file as paragraph (i.e.
2307 \begin_layout Description
2308 Syntax file-insert-plaintext-para [<FILE>]
2311 \begin_layout Description
2313 Filename to be inserted.
2316 \begin_layout Description
2321 \begin_layout Subsection*
2325 \begin_layout Description
2326 Action Inserts CharStyle,
2327 Custom inset or XML short element.
2330 \begin_layout Description
2331 Notion Look into the Customization manual for more information about these elements.
2332 \begin_inset Newline newline
2335 To make this command enabled the layout file for the document class you're using has to load the character styles.
2336 There are a few contained in the Logical Markup module.
2337 You can also of course create some yourself.
2338 \begin_inset Newline newline
2341 For dissolving the element see LFUN_INSET_DISSOLVE.
2344 \begin_layout Description
2345 Syntax flex-insert Name
2348 \begin_layout Description
2350 This name must be defined either in your layout file or imported by some module.
2351 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
2356 \begin_layout Description
2357 Sample flex-insert Code
2360 \begin_layout Subsection*
2364 \begin_layout Description
2365 Action Inserts a float inset.
2368 \begin_layout Description
2369 Syntax float-insert <TYPE>
2372 \begin_layout Description
2374 type of float depends on the used textclass.
2375 Usually "algorithm",
2377 "figure" parameters can be given.
2380 \begin_layout Description
2385 \begin_layout Subsection*
2389 \begin_layout Description
2390 Action Inserts the list of floats in the document.
2393 \begin_layout Description
2394 Syntax float-list-insert <TYPE>
2397 \begin_layout Description
2399 type of float depends on the used textclass.
2400 Usually "algorithm",
2402 "figure" parameters can be given.
2405 \begin_layout Description
2410 \begin_layout Subsection*
2414 \begin_layout Description
2415 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2418 \begin_layout Description
2419 Notion Corresponds to the starred floats (figure*,
2424 \begin_layout Description
2425 Syntax float-wide-insert <TYPE>
2428 \begin_layout Description
2430 type of float depends on the used textclass.
2431 Usually "algorithm",
2433 "figure" parameters can be given.
2436 \begin_layout Description
2441 \begin_layout Subsection*
2445 \begin_layout Description
2446 Action Inserts a footnote inset.
2449 \begin_layout Description
2450 Syntax footnote-insert
2453 \begin_layout Description
2458 \begin_layout Subsection*
2462 \begin_layout Description
2463 Action Reloads the image if necessary.
2466 \begin_layout Description
2467 Syntax graphics-reload
2470 \begin_layout Description
2475 \begin_layout Subsection*
2479 \begin_layout Description
2480 Action Set the group for the graphics inset on the cursor position.
2483 \begin_layout Description
2484 Syntax graphics-set-group [<GROUP>]
2487 \begin_layout Description
2489 Id for an existing group.
2490 In case the Id is an empty string,
2491 the graphics inset is removed from the current group.
2494 \begin_layout Description
2499 \begin_layout Subsection*
2503 \begin_layout Description
2504 Action Set the same group for all graphics insets in the marked block.
2507 \begin_layout Description
2508 Syntax graphics-unify [<GROUP>]
2511 \begin_layout Description
2513 Id for an existing group.
2514 In case the Id is an empty string,
2515 the group Id from the first graphics inset will be used.
2518 \begin_layout Description
2523 \begin_layout Subsection*
2527 \begin_layout Description
2528 Action Inserts hyperlinks into the document (clickable in pdf output).
2531 \begin_layout Description
2532 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2535 \begin_layout Description
2536 Syntax href-insert [<TARGET>]
2539 \begin_layout Description
2544 \begin_layout Subsection*
2548 \begin_layout Description
2549 Action Only active in IPA inset.
2552 \begin_layout Description
2553 Notion Dummy function which is only active in a IPA inset.
2554 It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2557 \begin_layout Description
2561 \begin_layout Description
2566 \begin_layout Subsection*
2570 \begin_layout Description
2571 Action Inserts Index entry.
2574 \begin_layout Description
2575 Notion It automatically takes the word on the cursor position.
2578 \begin_layout Description
2579 Syntax index-insert [<TYPE:Name>]
2582 \begin_layout Description
2585 if multiple indices are defined.
2586 With an empty argument,
2587 the default index is selected.
2590 \begin_layout Description
2595 \begin_layout Subsection*
2599 \begin_layout Description
2600 Action Inserts list of Index entries on a new page.
2603 \begin_layout Description
2604 Syntax index-print [<TYPE:Name>]
2607 \begin_layout Description
2610 if multiple indices are defined.
2611 With an empty argument,
2612 the default index is selected.
2615 \begin_layout Description
2620 \begin_layout Subsection*
2624 \begin_layout Description
2625 Action Tags all occurrences of the word before the cursor with the index inset at cursor.
2628 \begin_layout Description
2629 Notion It automatically takes the word on the cursor position.
2632 \begin_layout Description
2633 Syntax index-tag-all
2636 \begin_layout Description
2641 \begin_layout Subsection*
2645 \begin_layout Description
2646 Action Inserts special Index macros into the document.
2649 \begin_layout Description
2650 Syntax indexmacro-insert <type>
2653 \begin_layout Description
2661 \begin_layout Description
2666 \begin_layout Subsection*
2670 \begin_layout Description
2671 Action Displays shortcuts,
2673 package and textclass availability and menu information in a non-editable boxed InsetText.
2676 \begin_layout Description
2677 Notion Apart from lfun arguments you can use the following method:
2678 \begin_inset Newline newline
2682 input the type and argument of this inset,
2686 \begin_inset Newline newline
2690 select the text and run info-insert lfun.
2693 \begin_layout Description
2694 Syntax info-insert <TYPE> <ARG>
2697 \begin_layout Description
2699 date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2700 \begin_inset Newline newline
2704 argument for a given type.
2705 Look into InsetInfo.h for detailed description.
2706 \begin_inset Newline newline
2710 current date (formatted and localized)
2711 \begin_inset Newline newline
2715 date of last modification (saving) (formatted and localized)
2716 \begin_inset Newline newline
2720 a static date (formatted and localized)
2721 \begin_inset Newline newline
2725 current time (formatted and localized)
2726 \begin_inset Newline newline
2730 time of last modification (saving) (formatted and localized)
2731 \begin_inset Newline newline
2735 a static time (formatted and localized)
2736 \begin_inset Newline newline
2740 name of lfun (e.g math-insert
2743 \begin_inset Newline newline
2747 name of rc_entry (e.g.
2749 \begin_inset Newline newline
2753 "version" - used version of LyX
2754 \begin_inset Newline newline
2758 name of latex package (e.g.
2760 \begin_inset Newline newline
2764 name of textclass (e.g.
2766 \begin_inset Newline newline
2770 name of lfun used in menu
2771 \begin_inset Newline newline
2776 \begin_inset Newline newline
2780 icon of lfun used in toolbar or direct icon name
2781 \begin_inset Newline newline
2785 "name"|"name-noext"|"path"|"class" vcs:
2786 "tree-revision"|"revision"|"author"|"date"|"time"
2789 \begin_layout Description
2790 Sample command-sequence info-insert buffer path;
2791 info-insert buffer name
2794 \begin_layout Description
2799 \begin_layout Subsection*
2803 \begin_layout Description
2804 Action Apply data for an inset.
2807 \begin_layout Description
2808 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied.
2809 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called.
2812 \begin_layout Description
2813 Syntax inset-apply <ARGS>
2816 \begin_layout Description
2817 Params See LFUN_INSET_INSERT .
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.
2832 \begin_layout Description
2836 \begin_layout Description
2841 \begin_layout Subsection*
2845 \begin_layout Description
2846 Action Move the cursor to the beginning of the current inset if it is not already there.
2847 If the cursor is already at the beginning of the current inset,
2848 move it to the beginning of the enclosing inset or the main work area,
2850 if there is no enclosing inset (adding the traversed text to the selection).
2853 \begin_layout Description
2854 Syntax inset-begin-select
2857 \begin_layout Description
2862 \begin_layout Subsection*
2866 \begin_layout Description
2867 Action Copies the inset to the clipboard as a certain type.
2870 \begin_layout Description
2871 Notion Currently used only for InsetInfo where its content is copied as a text.
2874 \begin_layout Description
2875 Syntax inset-copy-as
2878 \begin_layout Description
2883 \begin_layout Subsection*
2887 \begin_layout Description
2888 Action Dissolve the current inset into text.
2891 \begin_layout Description
2892 Syntax inset-dissolve [<INSET>]
2895 \begin_layout Description
2897 this can be used to make sure the right kind of inset is dissolved.
2898 For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset,
2899 even if the cursor is inside several nested insets of different type.
2900 \begin_inset Newline newline
2903 For values see lyx::InsetLayout::lyxtype_ .
2906 \begin_layout Description
2911 \begin_layout Subsection*
2915 \begin_layout Description
2916 Action Edit the inset at cursor with an external application,
2917 if one is attributed.
2918 If the inset is file based,
2919 the referenced file is edited.
2921 the inset contents is written to a temporary file,
2922 the inset is locked,
2923 and the temporary file is edited.
2925 LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished.
2928 \begin_layout Description
2929 Syntax inset-edit [nogui] [<INSET_PARAMS>]
2932 \begin_layout Description
2933 Params <INSET_PARAMS>:
2934 Parameters for the inset.
2935 \begin_inset Newline newline
2938 Currently only the filename will be considered.
2939 \begin_inset Newline newline
2943 does not launch external editor,
2944 only returns filename to be processed.
2947 \begin_layout Description
2952 \begin_layout Subsection*
2956 \begin_layout Description
2957 Action Move the cursor to the end of the current inset if it is not already there.
2958 If the cursor is already at the end of the current inset,
2959 move it to the end of the enclosing inset or the main work area,
2961 if there is no enclosing inset.
2964 \begin_layout Description
2968 \begin_layout Description
2973 \begin_layout Subsection*
2977 \begin_layout Description
2978 Action End editing the inset at cursor with an external application.
2979 This replaces the inset contents with the contents of the temporary file,
2980 deletes the file and unlocks the inset.
2983 \begin_layout Description
2984 Syntax inset-end-edit
2987 \begin_layout Description
2992 \begin_layout Subsection*
2996 \begin_layout Description
2997 Action Move the cursor to the end of the current inset if it is not already there.
2998 If the cursor is already at the end of the current inset,
2999 move it to the end of the enclosing inset or the main work area,
3001 if there is no enclosing inset (adding the traversed text to the selection).
3004 \begin_layout Description
3005 Syntax inset-end-select
3008 \begin_layout Description
3013 \begin_layout Subsection*
3017 \begin_layout Description
3018 Action Apply the given commands on insets of a given name.
3021 \begin_layout Description
3023 use at your own risks;
3024 this function gives you too many ways of shooting yourself in the foot.
3025 A typical example is inset-forall Note note-insert which starts an infinite loop.
3026 This is mitigated by the fact that the number of actions is arbitrarily limited to 100000.
3027 Note also that inset-forall does not update metrics between iterations,
3028 which can lead to bugs.
3029 This has to be eventually fixed.
3032 \begin_layout Description
3033 Syntax inset-forall <NAME> <LFUN-COMMAND>
3034 \begin_inset Newline newline
3040 all insets are matched.
3041 The name is used like for InsetLayout in layout files:
3042 "Note" matches all note insets,
3043 while "Note:Note" only matches LyX yellow note insets.
3046 \begin_layout Description
3047 Sample Remove all index insets:
3048 \begin_inset Newline newline
3051 inset-forall Index char-delete-forward
3052 \begin_inset Newline newline
3056 \begin_inset Newline newline
3059 inset-forall Note inset-toggle close
3060 \begin_inset Newline newline
3063 Open all branch insets of branch "myBranch":
3064 \begin_inset Newline newline
3067 inset-forall Branch:myBranch inset-toggle open
3068 \begin_inset Newline newline
3071 Transform all yellow notes to comments
3072 \begin_inset Newline newline
3075 inset-forall Note:Note inset-modify note Note Comment
3076 \begin_inset Newline newline
3079 Try to put LyX in an infinite loop if there is at least a Note:
3080 \begin_inset Newline newline
3083 inset-forall Note char-backward
3086 \begin_layout Description
3091 \begin_layout Subsection*
3095 \begin_layout Description
3096 Action Insert new inset (type given by the parameters).
3099 \begin_layout Description
3100 Syntax inset-insert <INSET> <ARGS>
3103 \begin_layout Description
3105 <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
3106 \begin_inset Newline newline
3109 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
3110 \begin_inset Newline newline
3114 depends on the given inset.
3115 Use "lyx -dbg action" to explore.
3118 \begin_layout Description
3119 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3122 \begin_inset Newline newline
3125 where <label name> is the name of the referenced label and <Format> is one of the following:
3126 \begin_inset Newline newline
3130 \begin_inset Newline newline
3133 eqref -- (<reference>)
3134 \begin_inset Newline newline
3138 \begin_inset Newline newline
3141 vpageref -- on <page>
3142 \begin_inset Newline newline
3145 vref -- <reference> on <page>
3146 \begin_inset Newline newline
3149 formatted -- Formatted reference
3152 \begin_layout Subsection*
3156 \begin_layout Description
3157 Action Inserts the inset's content (in ToC pane) at the position of the cursor.
3160 \begin_layout Description
3161 Syntax inset-insert-copy
3164 \begin_layout Description
3169 \begin_layout Subsection*
3173 \begin_layout Description
3174 Action Modify some properties of an inset.
3177 \begin_layout Description
3178 Notion Used for argument,
3207 vspace and wrap insets.
3210 \begin_layout Description
3211 Syntax inset-modify <INSET> <ARGS>
3212 \begin_inset Newline newline
3215 inset-modify changetype <TYPE>
3218 \begin_layout Description
3219 Sample Change a Note inset into a Comment inset:
3220 \begin_inset Newline newline
3223 inset-modify note Note Comment
3224 \begin_inset Newline newline
3227 Change a Box into an Ovalbox:
3228 \begin_inset Newline newline
3231 inset-modify changetype Ovalbox
3232 \begin_inset Newline newline
3235 Change a quotation mark to e[nglish style],
3236 l[eft side = opening],
3239 \begin_inset Newline newline
3242 inset-modify changetype els
3243 \begin_inset Newline newline
3246 Change only the style of a quotation mark,
3247 maintaining the other aspects (.
3249 \begin_inset Newline newline
3252 inset-modify changetype e..
3253 \begin_inset Newline newline
3259 \begin_layout Subsection*
3263 \begin_layout Description
3264 Action Select all contents of an inset.
3267 \begin_layout Description
3268 Notion There are 3 successive levels:
3269 select current cell,
3270 select all cells of inset,
3271 select the inset from outside (in the enclosing inset).
3274 \begin_layout Description
3275 Syntax inset-select-all
3278 \begin_layout Description
3281 lasgouttes 1 Nov 2014
3284 \begin_layout Subsection*
3288 \begin_layout Description
3289 Action Open the inset's properties dialog.
3292 \begin_layout Description
3293 Notion Used for bibitem,
3318 \begin_layout Description
3319 Syntax inset-settings <INSET>
3322 \begin_layout Description
3324 <bibitem|bibtex|box|branch|citation|ert|external|float|
3325 \begin_inset Newline newline
3328 graphics|href|include|index|index_print|label|line|
3329 \begin_inset Newline newline
3332 listings|note|phantom|ref|space|tabular|vspace|wrap>.
3335 \begin_layout Subsection*
3339 \begin_layout Description
3340 Action Splits the current inset into two at current position.
3343 \begin_layout Description
3344 Syntax inset-split [<INSET>]
3347 \begin_layout Description
3349 this can be used to make sure the right kind of inset is dissolved.
3350 For example "split" entry in the charstyles sub-menu should only dissolve the charstyle inset,
3351 even if the cursor is inside several nested insets of different type.
3352 \begin_inset Newline newline
3355 For values see lyx::InsetLayout::lyxtype_ .
3358 \begin_layout Description
3363 \begin_layout Subsection*
3367 \begin_layout Description
3368 Action Toggles the collapsible inset at cursor position,
3369 or the inset we are currently in.
3372 \begin_layout Description
3373 Syntax inset-toggle [<ARG>]
3376 \begin_layout Description
3378 <open|close|toggle|assign>.
3379 \begin_inset Newline newline
3382 open/close/toggle are for collapsible insets.
3383 toggle is used when no argument is given.
3384 \begin_inset Newline newline
3387 assign synchronize the branch-inset with activation status of the branch.
3388 Used for global toggling when changed activation.
3391 \begin_layout Description
3396 \begin_layout Subsection*
3400 \begin_layout Description
3401 Action Inserts an IPA inset.
3404 \begin_layout Description
3408 \begin_layout Description
3413 \begin_layout Subsection*
3417 \begin_layout Description
3418 Action Inserts special IPA macros into the document.
3421 \begin_layout Description
3422 Syntax ipamacro-insert <CHAR>
3425 \begin_layout Description
3431 tone-high-rising-falling,
3436 \begin_layout Description
3441 \begin_layout Subsection*
3445 \begin_layout Description
3446 Action Turn off the loaded keyboard map.
3449 \begin_layout Description
3453 \begin_layout Subsection*
3457 \begin_layout Description
3458 Action Turn on the primary keyboard map.
3461 \begin_layout Description
3462 Notion Maps were widely used in past,
3463 when X-windows didn't have nowadays keyboard support.
3464 They can be still used to maintain uniform keyboard layout across the various platforms.
3465 \begin_inset Newline newline
3468 The language is to be set in the Preferences dialog.
3471 \begin_layout Description
3472 Syntax keymap-primary
3475 \begin_layout Subsection*
3479 \begin_layout Description
3480 Action Turn on the secondary keyboard map.
3483 \begin_layout Description
3484 Syntax keymap-secondary
3487 \begin_layout Subsection*
3491 \begin_layout Description
3492 Action Toggles keyboard maps (first/second/off).
3495 \begin_layout Description
3496 Syntax keymap-toggle
3499 \begin_layout Description
3504 \begin_layout Subsection*
3505 label-copy-as-reference
3508 \begin_layout Description
3509 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3512 \begin_layout Description
3513 Syntax copy-label-as-reference <LABEL>
3516 \begin_layout Description
3518 The label to copy (for multi-line math)
3521 \begin_layout Description
3526 \begin_layout Subsection*
3530 \begin_layout Description
3531 Action Goto a label.
3534 \begin_layout Description
3535 Syntax label-goto [<LABEL>]
3538 \begin_layout Description
3541 If no label is given and reference is on cursor position,
3542 Bookmark 0 is saved and cursor moves to the position of referenced label.
3545 \begin_layout Description
3550 \begin_layout Subsection*
3554 \begin_layout Description
3555 Action Inserts label to text or displayed formula.
3558 \begin_layout Description
3559 Syntax label-insert [<LABEL>]
3562 \begin_layout Description
3565 If no label is given dialog requesting name will be opened.
3568 \begin_layout Subsection*
3569 label-insert-as-reference
3572 \begin_layout Description
3573 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3576 \begin_layout Description
3577 Syntax label-insert-as-reference
3580 \begin_layout Description
3585 \begin_layout Subsection*
3589 \begin_layout Description
3590 Action Set language from the current cursor position.
3593 \begin_layout Description
3594 Syntax language <LANG> [set]
3597 \begin_layout Description
3600 Look in lib/languages for the list.
3601 "language reset" or "language" (without param) reset to the document language.
3604 the language will be set to the specified language.
3606 the language will be toggled (i.e.,
3607 if the current language is LANG,
3608 switch to the document language or the default language,
3609 if LANG is the document language).
3612 \begin_layout Description
3617 \begin_layout Subsection*
3621 \begin_layout Description
3622 Action Move the cursor to the beginning of the (screen) line.
3625 \begin_layout Description
3629 \begin_layout Subsection*
3633 \begin_layout Description
3634 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3637 \begin_layout Description
3638 Syntax line-begin-select
3641 \begin_layout Subsection*
3645 \begin_layout Description
3646 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3649 \begin_layout Description
3650 Syntax line-delete-forward
3653 \begin_layout Subsection*
3657 \begin_layout Description
3658 Action Move the cursor to the end of the (screen) line.
3661 \begin_layout Description
3665 \begin_layout Subsection*
3669 \begin_layout Description
3670 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3673 \begin_layout Description
3674 Syntax line-end-select
3677 \begin_layout Subsection*
3681 \begin_layout Description
3682 Action Inserts a new listings inset.
3685 \begin_layout Description
3686 Syntax listing-insert
3689 \begin_layout Description
3696 \begin_layout Subsection*
3700 \begin_layout Description
3701 Action Inserts a marginal note.
3704 \begin_layout Description
3705 Syntax marginalnote-insert
3708 \begin_layout Description
3713 \begin_layout Subsection*
3717 \begin_layout Description
3718 Action Disable selecting of text-region.
3721 \begin_layout Description
3725 \begin_layout Subsection*
3729 \begin_layout Description
3730 Action Enable selecting of text-region.
3733 \begin_layout Description
3734 Notion After enabling you can simply move arrow keys to get selected region.
3737 \begin_layout Description
3741 \begin_layout Subsection*
3745 \begin_layout Description
3746 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3749 \begin_layout Description
3753 \begin_layout Description
3758 \begin_layout Subsection*
3762 \begin_layout Description
3763 Action Inserts a line break or new line.
3766 \begin_layout Description
3767 Syntax newline-insert [<ARG>]
3770 \begin_layout Description
3772 <newline|linebreak> default:
3776 \begin_layout Description
3781 \begin_layout Subsection*
3785 \begin_layout Description
3786 Action Inserts a new page.
3789 \begin_layout Description
3790 Syntax newpage-insert <ARG>
3793 \begin_layout Description
3795 <newpage|pagebreak|clearpage|cleardoublepage> default:
3799 \begin_layout Description
3804 \begin_layout Subsection*
3808 \begin_layout Description
3809 Action Inserts Nomenclature entry.
3812 \begin_layout Description
3813 Notion It automatically takes the word on the cursor position if no symbol is given.
3816 \begin_layout Description
3817 Syntax nomencl-insert [<SYMBOL>]
3820 \begin_layout Description
3825 \begin_layout Subsection*
3829 \begin_layout Description
3830 Action Inserts list of Nomenclature entries.
3833 \begin_layout Description
3834 Syntax nomenclature-print
3837 \begin_layout Description
3842 \begin_layout Subsection*
3846 \begin_layout Description
3847 Action Inserts Note on the current cursor position,
3848 move selection inside the inset.
3851 \begin_layout Description
3852 Syntax note-insert [<TYPE>]
3855 \begin_layout Description
3857 <Note|Greyedout|Comment> default:
3861 \begin_layout Subsection*
3865 \begin_layout Description
3866 Action Moves the cursor to the beginning of next Note inset.
3869 \begin_layout Description
3873 \begin_layout Subsection*
3877 \begin_layout Description
3878 Action Move the current group in the downward direction in the structure of the document.
3881 \begin_layout Description
3882 Notion The "group" can be Part/Chapter/Section/etc.
3883 It moves the whole substructure of the group.
3886 \begin_layout Description
3890 \begin_layout Description
3895 \begin_layout Subsection*
3899 \begin_layout Description
3900 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3903 \begin_layout Description
3904 Notion Part -> Chapter -> Section -> etc.
3907 \begin_layout Description
3908 Syntax outline-in [local]
3911 \begin_layout Description
3914 only the current paragraph will be affected.
3917 \begin_layout Description
3922 \begin_layout Subsection*
3926 \begin_layout Description
3927 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3930 \begin_layout Description
3931 Notion Part <- Chapter <- Section <- etc.
3934 \begin_layout Description
3935 Syntax outline-out [local]
3938 \begin_layout Description
3941 only the current paragraph will be affected.
3944 \begin_layout Description
3949 \begin_layout Subsection*
3953 \begin_layout Description
3954 Action Move the current group in the upward direction in the structure of the document.
3957 \begin_layout Description
3958 Notion The "group" can be Part/Chapter/Section/etc.
3959 It moves the whole substructure of the group.
3962 \begin_layout Description
3966 \begin_layout Description
3971 \begin_layout Subsection*
3975 \begin_layout Description
3976 Action Breaks the current paragraph at the current location.
3979 \begin_layout Description
3980 Notion Removes the selection.
3983 \begin_layout Description
3984 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3987 \begin_layout Description
3989 "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3990 \begin_inset Newline newline
3994 Do not account for paragraph separators while breaking.
3997 \begin_layout Subsection*
4001 \begin_layout Description
4002 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
4005 \begin_layout Description
4006 Syntax paragraph-down
4009 \begin_layout Description
4014 \begin_layout Subsection*
4015 paragraph-down-select
4018 \begin_layout Description
4019 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
4022 \begin_layout Description
4023 Syntax paragraph-down-select
4026 \begin_layout Description
4031 \begin_layout Subsection*
4035 \begin_layout Description
4036 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
4037 If given four arguments id_start,
4041 perform a selection from start to end.
4044 \begin_layout Description
4045 Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen.
4046 Moreover the id is unique for all opened buffers (documents).
4047 Both ids must belong to the same buffer.
4050 \begin_layout Description
4051 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
4054 \begin_layout Description
4057 \begin_inset Newline newline
4061 desired position within the paragraph
4064 \begin_layout Description
4070 \begin_layout Subsection*
4074 \begin_layout Description
4075 Action Moves the current paragraph downwards in the document.
4078 \begin_layout Description
4079 Syntax paragraph-move-down
4082 \begin_layout Description
4087 \begin_layout Subsection*
4091 \begin_layout Description
4092 Action Moves the current paragraph upwards in the document.
4095 \begin_layout Description
4096 Notion Movement through the document will possibly break the paragraph-depth (e.g.
4100 \begin_layout Description
4101 Syntax paragraph-move-up
4104 \begin_layout Description
4109 \begin_layout Subsection*
4113 \begin_layout Description
4114 Action Change paragraph settings.
4117 \begin_layout Description
4118 Notion Modifies the current paragraph,
4119 or currently selected paragraphs.
4120 This function only modifies,
4121 and does not override,
4123 Note that the "leftindent" indent setting is deprecated.
4126 \begin_layout Description
4127 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
4130 \begin_layout Description
4141 \begin_inset Newline newline
4147 paragraph_spacing default|single|onehalf|double|other SIZE
4148 \begin_inset Newline newline
4154 align block|left|right|center|default
4155 \begin_inset Newline newline
4161 labelwidthstring WIDTH|
4166 \begin_layout Description
4171 \begin_layout Subsection*
4172 paragraph-params-apply
4175 \begin_layout Description
4176 Action Change paragraph settings.
4179 \begin_layout Description
4180 Notion Overwrite all nonspecified settings to the default ones.
4181 Use paragraph-params lfun if you don't want to overwrite others settings.
4184 \begin_layout Description
4185 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
4188 \begin_layout Description
4189 Params For parameters see LFUN_PARAGRAPH_PARAMS
4192 \begin_layout Description
4197 \begin_layout Subsection*
4201 \begin_layout Description
4202 Action Move cursor to beginning of current paragraph and select to the end in downward direction
4205 \begin_layout Description
4206 Notion This function is by default bound to triple mouse click
4209 \begin_layout Description
4210 Syntax paragraph-select
4213 \begin_layout Description
4218 \begin_layout Subsection*
4222 \begin_layout Description
4223 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
4226 \begin_layout Description
4230 \begin_layout Description
4235 \begin_layout Subsection*
4239 \begin_layout Description
4240 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
4243 \begin_layout Description
4244 Syntax paragraph-up-select
4247 \begin_layout Description
4252 \begin_layout Subsection*
4256 \begin_layout Description
4257 Action Pastes material (text or picture) from the active clipboard.
4260 \begin_layout Description
4261 Syntax paste [<TYPE>|<NUM>]
4264 \begin_layout Description
4266 emf|pdf|png|jpeg|linkback|wmf|latex|html
4267 \begin_inset Newline newline
4271 number of the selection in the internal clipboard stack to be pasted.
4274 \begin_layout Subsection*
4278 \begin_layout Description
4279 Action Inserts phantom on the current cursor position,
4280 move selection inside the inset.
4283 \begin_layout Description
4284 Syntax phantom-insert [<TYPE>]
4287 \begin_layout Description
4289 <Phantom|HPhantom|VPhantom> default:
4293 \begin_layout Description
4298 \begin_layout Subsection*
4302 \begin_layout Description
4303 Action Inserts a new preview inset.
4306 \begin_layout Description
4307 Syntax preview-insert
4310 \begin_layout Description
4315 \begin_layout Subsection*
4316 primary-selection-paste
4319 \begin_layout Description
4320 Action Pastes the currently selected text.
4323 \begin_layout Description
4324 Notion Primary selection mechanism is X11/Wayland-only thing.
4327 \begin_layout Description
4328 Syntax primary-selection-paste [<ARG>]
4331 \begin_layout Description
4333 "paragraph" will cause pasting as one paragraph,
4338 \begin_layout Subsection*
4342 \begin_layout Description
4343 Action Inserts quotes according to the type and quote-language preference.
4346 \begin_layout Description
4347 Notion Currently 15 different quote styles are distinguished (see params).
4350 \begin_layout Description
4351 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
4354 \begin_layout Description
4358 usually single) quotes,
4359 otherwise outer (i.e.,
4361 usually double) quotes will be used.
4362 \begin_inset Newline newline
4366 'opening' for opening quotes,
4367 'closing' for closing quotes,
4368 otherwise the side will be guessed from the context.
4370 \change_inserted -584632292 1712005910
4371 Use `auto' to force this default.
4372 (You will need to give this argument if you also want to give <STYLE>.)
4375 \begin_inset Newline newline
4379 'british' for `British' quote style (with ``inner quotation'')
4380 \begin_inset Newline newline
4383 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
4384 \begin_inset Newline newline
4387 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
4388 \begin_inset Newline newline
4391 'danish' for >>Danish<< quote style (with >inner quotation<)
4392 \begin_inset Newline newline
4395 'english' for ``English'' quote style (with `inner quotation')
4396 \begin_inset Newline newline
4399 'french' for <<french>> quote style (with ``inner quotation'')
4400 \begin_inset Newline newline
4403 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
4404 \begin_inset Newline newline
4407 'german' for ,,German`` quote style (with ,inner quotation`)
4408 \begin_inset Newline newline
4411 'hebrew' for ''hebrew,,
4412 quote style (with 'inner quotation,)
4413 \begin_inset Newline newline
4416 'plain' for "Plain" quote style (with 'inner quotation')
4417 \begin_inset Newline newline
4420 'polish' for ,,Polish'' quote style (with ,inner quotation')
4421 \begin_inset Newline newline
4424 'swedish' for ''Swedish'' quote style (with 'inner quotation')
4425 \begin_inset Newline newline
4428 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
4429 \begin_inset Newline newline
4432 'swiss' for <<Swiss>> quote style (with <inner quotation>)
4433 \begin_inset Newline newline
4436 'russian' for <<Russian>> quote style (with ,,inner quotation``)
4437 \begin_inset Newline newline
4440 'dynamic' for Dynamic quotation marks which inherit the global document style
4441 \begin_inset Newline newline
4444 If no quote style is specified,
4445 the document-wide will be used.
4448 \begin_layout Subsection*
4452 \begin_layout Description
4453 Action Redoes the last thing undone.
4456 \begin_layout Description
4460 \begin_layout Subsection*
4464 \begin_layout Description
4465 Action Go to the next label or cross-reference.
4468 \begin_layout Description
4469 Syntax reference-next
4472 \begin_layout Description
4477 \begin_layout Subsection*
4481 \begin_layout Description
4482 Action Repeat the given command.
4485 \begin_layout Description
4486 Notion fails when the repeat count is greater than 10000.
4489 \begin_layout Description
4490 Syntax repeat <COUNT> <LFUN-COMMAND>
4493 \begin_layout Description
4498 \begin_layout Subsection*
4502 \begin_layout Description
4503 Action Moves the cursor one page in downward direction.
4506 \begin_layout Description
4510 \begin_layout Subsection*
4514 \begin_layout Description
4515 Action Moves the cursor one screen in downward direction adding the current position to the selection.
4518 \begin_layout Description
4519 Syntax screen-down-select
4522 \begin_layout Subsection*
4526 \begin_layout Description
4527 Action Recenters the screen on the current cursor position.
4530 \begin_layout Description
4531 Syntax screen-recenter
4534 \begin_layout Subsection*
4538 \begin_layout Description
4539 Action Repositions the screen such that the cursor is visible.
4542 \begin_layout Description
4543 Syntax screen-show-cursor
4546 \begin_layout Description
4551 \begin_layout Subsection*
4555 \begin_layout Description
4556 Action Moves the cursor one page in upward direction.
4559 \begin_layout Description
4563 \begin_layout Subsection*
4567 \begin_layout Description
4568 Action Moves the cursor one page in upward direction adding the current position to the selection.
4571 \begin_layout Description
4572 Syntax screen-up-select
4575 \begin_layout Subsection*
4579 \begin_layout Description
4580 Action Inserts a subscript or superscript inset.
4583 \begin_layout Description
4584 Syntax script-insert <TYPE>
4587 \begin_layout Description
4589 subscript|superscript
4592 \begin_layout Description
4597 \begin_layout Subsection*
4601 \begin_layout Description
4602 Action Scroll the buffer view.
4605 \begin_layout Description
4606 Notion Only scrolls the screen up or down;
4607 does not move the cursor.
4610 \begin_layout Description
4611 Syntax scroll <TYPE> <QUANTITY>
4614 \begin_layout Description
4617 \begin_inset Newline newline
4624 \begin_layout Description
4629 \begin_layout Subsection*
4633 \begin_layout Description
4634 Action Set search string buffer.
4637 \begin_layout Description
4638 Syntax search-string-set [<DATA>]
4641 \begin_layout Description
4643 string to search for.
4644 If no parameter is given,
4645 use (word under) selection.
4648 \begin_layout Description
4654 \begin_layout Subsection*
4658 \begin_layout Description
4659 Action Select the whole section.
4662 \begin_layout Description
4663 Notion The cursor should be in a section heading before calling this lfun.
4666 \begin_layout Description
4667 Syntax section-select
4670 \begin_layout Description
4675 \begin_layout Subsection*
4679 \begin_layout Description
4680 Action Pastes the internal selection text in permanent selection.
4683 \begin_layout Description
4684 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ;
4685 primary-selection-paste paragraph).
4688 \begin_layout Description
4689 Syntax selection-paste
4692 \begin_layout Description
4697 \begin_layout Subsection*
4701 \begin_layout Description
4702 Action Inserts an environment separator or latex paragraph break.
4705 \begin_layout Description
4706 Syntax separator-insert [<ARG>]
4709 \begin_layout Description
4711 <plain|parbreak|latexpar> default:
4715 \begin_layout Description
4720 \begin_layout Subsection*
4724 \begin_layout Description
4725 Action Inserts one of horizontal space insets.
4728 \begin_layout Description
4729 Syntax space-insert <NAME> [<LEN>]
4732 \begin_layout Description
4751 \begin_inset Newline newline
4756 \begin_inset Newline newline
4760 length for custom spaces (hspace,
4761 hspace* for protected)
4764 \begin_layout Description
4770 \begin_layout Subsection*
4774 \begin_layout Description
4775 Action Inserts various characters into the document.
4778 \begin_layout Description
4779 Syntax specialchar-insert <CHAR>
4782 \begin_layout Description
4798 \begin_layout Description
4803 \begin_layout Subsection*
4807 \begin_layout Description
4808 Action Add the word under the cursor to the respective spell checker dictionary.
4809 The default for the language is retrieved from the cursor position.
4812 \begin_layout Description
4813 Syntax spelling-add [<STRING>] [<LANG>]
4816 \begin_layout Description
4819 \begin_inset Newline newline
4823 language name (see file languages)
4826 \begin_layout Description
4831 \begin_layout Subsection*
4835 \begin_layout Description
4836 Action Add the word under the cursor to the document's local spell checker dictionary.
4837 The default for the language is retrieved from the cursor position.
4840 \begin_layout Description
4841 Syntax spelling-add-local [<STRING>] [<LANG>]
4844 \begin_layout Description
4847 \begin_inset Newline newline
4851 language name (see file languages)
4854 \begin_layout Description
4859 \begin_layout Subsection*
4860 spelling-continuously
4863 \begin_layout Description
4864 Action Toggle continuous spell checking.
4867 \begin_layout Description
4868 Syntax spelling-continuously
4871 \begin_layout Description
4876 \begin_layout Subsection*
4880 \begin_layout Description
4881 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
4882 The default for the language is retrieved from the cursor position.
4885 \begin_layout Description
4886 Syntax spelling-ignore [<WORD>] [<LANG>]
4889 \begin_layout Description
4892 \begin_inset Newline newline
4896 language name (see file languages)
4899 \begin_layout Description
4904 \begin_layout Subsection*
4908 \begin_layout Description
4909 Action Remove the word under the cursor from the respective spell checker dictionary.
4910 The default for the language is retrieved from the cursor position.
4913 \begin_layout Description
4914 Syntax spelling-remove [<STRING>] [<LANG>]
4917 \begin_layout Description
4920 \begin_inset Newline newline
4924 language name (see file languages)
4927 \begin_layout Description
4932 \begin_layout Subsection*
4933 spelling-remove-local
4936 \begin_layout Description
4937 Action Remove the word under the cursor from the document's local spell checker dictionary.
4938 The default for the language is retrieved from the cursor position.
4941 \begin_layout Description
4942 Syntax spelling-remove-local [<STRING>] [<LANG>]
4945 \begin_layout Description
4948 \begin_inset Newline newline
4952 language name (see file languages)
4955 \begin_layout Description
4960 \begin_layout Subsection*
4964 \begin_layout Description
4965 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4968 \begin_layout Description
4969 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection.
4970 This is useful if you want to indent/unindent multiple lines in one action.
4973 \begin_layout Description
4977 \begin_layout Description
4982 \begin_layout Subsection*
4986 \begin_layout Description
4987 Action Insert a tab into a listings inset.
4990 \begin_layout Description
4991 Notion It also works on a selection.
4994 \begin_layout Description
4998 \begin_layout Description
5003 \begin_layout Subsection*
5007 \begin_layout Description
5008 Action Modify properties of tabulars and table-like math environments.
5011 \begin_layout Description
5012 Syntax tabular-feature <FEATURE> [<ARG>]
5015 \begin_layout Description
5016 Params Generally see LFUN_INSET_INSERT for further details.
5017 \begin_inset Newline newline
5021 append-row|append-column|delete-row|delete-column|copy-row|
5022 \begin_inset Newline newline
5025 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
5026 \begin_inset Newline newline
5029 set-line-top|set-line-bottom|set-line-left|set-line-right|
5030 \begin_inset Newline newline
5033 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
5034 \begin_inset Newline newline
5037 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
5038 \begin_inset Newline newline
5041 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
5042 \begin_inset Newline newline
5045 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
5046 \begin_inset Newline newline
5049 valign-top|valign-bottom|valign-middle|longtabular-align-left|
5050 \begin_inset Newline newline
5053 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
5054 \begin_inset Newline newline
5057 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
5058 \begin_inset Newline newline
5061 reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|
5062 \begin_inset Newline newline
5065 toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
5066 \begin_inset Newline newline
5069 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
5070 \begin_inset Newline newline
5073 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
5074 \begin_inset Newline newline
5077 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
5078 \begin_inset Newline newline
5081 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
5082 \begin_inset Newline newline
5085 set-special-column|set-special-multicolumn|set-special-multirow|
5086 \begin_inset Newline newline
5089 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
5090 \begin_inset Newline newline
5093 set-interline-space|tabular-valign-top|tabular-valign-middle|
5094 \begin_inset Newline newline
5097 tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|
5098 \begin_inset Newline newline
5101 set-border-lines|toggle-border-lines|set-inner-lines|toggle-inner-lines Various math-environment features are handled as well,
5103 add-vline-left/right for
5104 \begin_inset Newline newline
5107 the Grid/Array environment.
5108 \begin_inset Newline newline
5112 additional argument for some commands,
5113 use debug mode to explore its values.
5116 \begin_layout Description
5121 \begin_layout Subsection*
5125 \begin_layout Description
5126 Action Inserts table into the document.
5129 \begin_layout Description
5130 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
5133 \begin_layout Description
5134 Syntax tabular-insert [<ROWS> <COLUMNS>]
5137 \begin_layout Description
5138 Params In case no arguments are given show insert dialog.
5141 \begin_layout Description
5146 \begin_layout Subsection*
5147 tabular-style-insert
5150 \begin_layout Description
5151 Action Inserts table of a given style into the document.
5154 \begin_layout Description
5155 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
5158 \begin_layout Description
5159 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
5162 \begin_layout Description
5163 Params Valid styles are the names of the files in lib/tabletemplates,
5164 minus _1x<n> and .lyx suffix.
5167 \begin_layout Description
5172 \begin_layout Subsection*
5176 \begin_layout Description
5177 Action Look up thesaurus entries with respect to the word under the cursor.
5180 \begin_layout Description
5181 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
5184 \begin_layout Description
5187 \begin_inset Newline newline
5191 language (see file languages)
5194 \begin_layout Description
5199 \begin_layout Subsection*
5203 \begin_layout Description
5204 Action Undoes the last edit.
5207 \begin_layout Description
5211 \begin_layout Subsection*
5215 \begin_layout Description
5216 Action Inserts a single unicode character.
5219 \begin_layout Description
5220 Syntax unicode-insert <CHAR1> <CHAR2> ...
5223 \begin_layout Description
5225 The character to insert,
5226 given as its code point,
5230 \begin_layout Description
5231 Sample unicode-insert 0x0100 0x0259
5234 \begin_layout Description
5239 \begin_layout Subsection*
5243 \begin_layout Description
5244 Action Moves the cursor one line in upward direction.
5247 \begin_layout Description
5251 \begin_layout Subsection*
5255 \begin_layout Description
5256 Action Moves the cursor one line in upward direction adding the current position to the selection.
5259 \begin_layout Description
5263 \begin_layout Subsection*
5267 \begin_layout Description
5268 Action Moves the cursor to the logically previous beginning of a word.
5271 \begin_layout Description
5272 Notion This is not the action which should be bound to the arrow keys,
5273 because backwards may be left or right,
5274 depending on the language.
5275 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
5276 which in turn may employ this one.
5279 \begin_layout Description
5280 Syntax word-backward
5283 \begin_layout Subsection*
5284 word-backward-select
5287 \begin_layout Description
5288 Action Moves the cursor to the logically previous beginning of a word,
5289 adding the logically traversed text to the selection.
5292 \begin_layout Description
5293 Notion See also LFUN_WORD_BACKWARD.
5296 \begin_layout Description
5297 Syntax word-backward-select
5300 \begin_layout Subsection*
5304 \begin_layout Description
5305 Action Capitalizes the words in the selection (i.e.
5306 the first letters) or the first letter of word at cursor position.
5309 \begin_layout Description
5310 Syntax word-capitalize [<SEL_TYPE>]
5313 \begin_layout Description
5315 if this is equal to "partial",
5316 then the default word starts at cursor position (emacs-style).
5318 the whole word is considered.
5321 \begin_layout Subsection*
5322 word-delete-backward
5325 \begin_layout Description
5326 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
5329 \begin_layout Description
5330 Syntax word-delete-backward [confirm]
5333 \begin_layout Description
5336 do not directly delete them.
5339 \begin_layout Subsection*
5343 \begin_layout Description
5344 Action Deletes characters to the end of the word (usually the "C+Delete" key).
5347 \begin_layout Description
5348 Syntax word-delete-forward [confirm]
5351 \begin_layout Description
5354 do not directly delete them.
5357 \begin_layout Subsection*
5361 \begin_layout Description
5362 Action Search for next occurrence of a string.
5365 \begin_layout Description
5366 Syntax word-find [<DATA>]
5369 \begin_layout Description
5371 data encoded from Find dialog (see lyx::find2string()).
5372 If no parameter is given,
5373 search with last find-dialog data is used for search (i.e.
5377 \begin_layout Description
5382 \begin_layout Subsection*
5386 \begin_layout Description
5387 Action Search for a given string in backward direction.
5390 \begin_layout Description
5391 Notion Case sensitive,
5393 If no argument given,
5394 last search repeated.
5397 \begin_layout Description
5398 Syntax word-find-backward [<STRING>]
5401 \begin_layout Description
5406 \begin_layout Subsection*
5410 \begin_layout Description
5411 Action Search for a given string in forward direction.
5414 \begin_layout Description
5415 Notion Case sensitive,
5417 If no argument given,
5418 last search repeated.
5421 \begin_layout Description
5422 Syntax word-find-forward [<STRING>]
5425 \begin_layout Description
5430 \begin_layout Subsection*
5434 \begin_layout Description
5435 Action Search for next occurrence of a pattern.
5438 \begin_layout Description
5439 Syntax word-findadv [<DATA>]
5442 \begin_layout Description
5444 data encoded from FindAdv dialog (see lyx::findadv2string()).
5445 If no parameter is given,
5446 search with last find-dialog data is used for search (i.e.
5450 \begin_layout Description
5455 \begin_layout Subsection*
5459 \begin_layout Description
5460 Action Moves the cursor to the logically next beginning of a word.
5463 \begin_layout Description
5464 Notion This is not the action which should be bound to the arrow keys,
5465 because forward may be left or right,
5466 depending on the language.
5467 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
5468 which in turn may employ this one.
5471 \begin_layout Description
5475 \begin_layout Subsection*
5479 \begin_layout Description
5480 Action Moves the cursor to the logically next beginning of a word,
5481 adding the logically traversed text to the selection.
5484 \begin_layout Description
5485 Notion See also LFUN_WORD_FORWARD.
5488 \begin_layout Description
5489 Syntax word-forward-select
5492 \begin_layout Subsection*
5496 \begin_layout Description
5497 Action Moves the cursor to the next beginning of a word "on the left".
5500 \begin_layout Description
5501 Notion This is the action which should be taken when the (e.g.,
5502 ctrl-) "left" key is pressed.
5504 it moves the cursor to the next beginning of a word on the left.
5506 in Bidi text this become slightly more complicated,
5507 and there are different modes of cursor movement.
5512 movement is logically forward in RTL paragraphs,
5513 and logically backwards in LTR paragraphs.
5516 \begin_layout Description
5520 \begin_layout Description
5525 \begin_layout Subsection*
5529 \begin_layout Description
5530 Action Moves the cursor to the next beginning of a word "on the left",
5531 adding *logically* traversed text to the selection.
5534 \begin_layout Description
5535 Notion See also LFUN_WORD_LEFT for exact details of the movement.
5538 \begin_layout Description
5539 Syntax word-left-select
5542 \begin_layout Description
5547 \begin_layout Subsection*
5551 \begin_layout Description
5552 Action Change the words in the selection or word at cursor position to lower case.
5555 \begin_layout Description
5556 Syntax word-lowcase [<SEL_TYPE>]
5559 \begin_layout Description
5561 if this is equal to "partial",
5562 then the default word starts at cursor position (emacs-style).
5564 the whole word is considered.
5567 \begin_layout Subsection*
5571 \begin_layout Description
5572 Action Replace a string in the document.
5575 \begin_layout Description
5576 Syntax word-replace [<DATA>]
5579 \begin_layout Description
5581 data is of the form "<replacestring>
5582 \begin_inset Newline newline
5586 \begin_inset Newline newline
5589 <casesensitive> <matchword> <all> <forward> <findnext>"
5592 \begin_layout Description
5597 \begin_layout Subsection*
5601 \begin_layout Description
5602 Action Moves the cursor to the next beginning of a word "on the right".
5605 \begin_layout Description
5606 Notion This is the action which should be taken when the (e.g.,
5607 ctrl-) "right" key is pressed.
5609 it moves the cursor to the next beginning of a word on the right.
5611 in Bidi text this become slightly more complicated,
5612 and there are different modes of cursor movement.
5617 movement is logically forward in LTR paragraphs,
5618 and logically backwards in RTL paragraphs.
5621 \begin_layout Description
5625 \begin_layout Description
5630 \begin_layout Subsection*
5634 \begin_layout Description
5635 Action Moves the cursor to the next beginning of a word "on the right",
5636 adding *logically* traversed text to the selection.
5639 \begin_layout Description
5640 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
5643 \begin_layout Description
5644 Syntax word-right-select
5647 \begin_layout Description
5652 \begin_layout Subsection*
5656 \begin_layout Description
5657 Action Puts the word where the cursor stands into the selection.
5660 \begin_layout Description
5664 \begin_layout Description
5669 \begin_layout Subsection*
5673 \begin_layout Description
5674 Action Change the words in the selection or word at cursor position to upper case.
5677 \begin_layout Description
5678 Syntax word-upcase [<SEL_TYPE>]
5681 \begin_layout Description
5683 if this is equal to "partial",
5684 then the default word starts at cursor position (emacs-style).
5686 the whole word is considered.
5689 \begin_layout Subsection*
5693 \begin_layout Description
5694 Action Inserts floats wrapped by the text around.
5697 \begin_layout Description
5698 Syntax wrap-insert <TYPE>
5701 \begin_layout Description
5706 \begin_layout Description
5711 \begin_layout Section
5712 Math Editor Functions
5715 \begin_layout Subsection*
5716 in-mathmacrotemplate
5719 \begin_layout Description
5720 Action Only active in Math Macro definition.
5723 \begin_layout Description
5724 Notion Dummy function which is only active in a Math Macro definition.
5725 It's used to toggle the Math Macro toolbar if the cursor moves into a Math Macro definition.
5728 \begin_layout Description
5729 Syntax in-mathmacrotemplate
5732 \begin_layout Description
5737 \begin_layout Subsection*
5741 \begin_layout Description
5742 Action Inserts an extended matrix as provided by the amsmath package.
5745 \begin_layout Description
5746 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
5749 \begin_layout Description
5750 Params <DECORATION>:
5751 Decoration determines the LaTeX name of the matrix that should be created.
5752 Possible values include pmatrix,
5759 The default is 'matrix'.
5762 \begin_layout Description
5763 Sample math-ams-matrix 3 3 bmatrix
5766 \begin_layout Subsection*
5770 \begin_layout Description
5771 Action Inserts math fixed size delimiters (e.g.
5773 brackets) enclosing expression.
5776 \begin_layout Description
5777 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
5780 \begin_layout Description
5782 bigl/r|Bigl/r|biggl/r|Biggl/r
5783 \begin_inset Newline newline
5787 TeX code for delimiter.
5788 See Delimiter dialog for delimiters to be used.
5791 \begin_layout Description
5792 Sample math-bigdelim "Bigl" "
5799 \begin_layout Description
5800 Origin Enrico & Georg,
5804 \begin_layout Subsection*
5808 \begin_layout Description
5809 Action Inserts math delimiters (e.g.
5811 brackets) enclosing expression.
5814 \begin_layout Description
5815 Syntax math-delim [<LEFT>] [<RIGHT>]
5818 \begin_layout Description
5819 Params <LEFT/RIGHT>:
5820 Delimiters to be used.
5821 Each delimiter can be specified by either a LaTeX name or a valid character.
5822 ( is the default letter.
5825 \begin_layout Description
5826 Sample math-delim { rangle
5829 \begin_layout Description
5834 \begin_layout Subsection*
5838 \begin_layout Description
5839 Action Creates a new displayed equation in text mode.
5840 Toggles inlined/display formula in math mode.
5843 \begin_layout Description
5844 Syntax math-display [<ARG>]
5847 \begin_layout Description
5849 this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
5852 \begin_layout Description
5857 \begin_layout Subsection*
5861 \begin_layout Description
5862 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
5865 \begin_layout Description
5866 Notion Selection can be used to determine the input for the external program.
5869 \begin_layout Description
5870 Syntax math-extern <LANG> [<COMMAND>]
5873 \begin_layout Description
5875 octave|maxima|maple|mathematica|script
5876 \begin_inset Newline newline
5879 where "script" stands for the external script (normalized expression will be passed)
5882 \begin_layout Description
5883 Sample math-extern maple simplify
5886 \begin_layout Description
5891 \begin_layout Subsection*
5895 \begin_layout Description
5896 Action Changes the text style used in math.
5899 \begin_layout Description
5900 Syntax math-font-style <STYLE>
5903 \begin_layout Description
5905 mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
5906 \begin_inset Newline newline
5909 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
5912 \begin_layout Description
5917 \begin_layout Subsection*
5921 \begin_layout Description
5922 Action Inserts math objects and symbols.
5925 \begin_layout Description
5926 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
5929 the content of cell(0) is replaced by the current selection (only works if the selection is in mathed).
5931 if "abc" is selected in mathed,
5934 frac{x}{y}" replaces "abc" with "
5937 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
5938 If nothing is selected (or the selection is not in mathed),
5939 math-insert works as expected.
5942 \begin_layout Description
5943 Syntax math-insert <ARG>
5946 \begin_layout Description
5948 Symbol or LaTeX code to be inserted.
5951 \begin_layout Subsection*
5955 \begin_layout Description
5956 Action Toggles the position of the limits from above/below to the right side an vice versa in integral symbol,
5962 \begin_layout Description
5963 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
5966 \begin_layout Description
5967 Syntax math-limits [<STATE>]
5970 \begin_layout Description
5975 \begin_layout Subsection*
5979 \begin_layout Description
5980 Action Inserts a math macro definition at the cursor position in the text.
5983 \begin_layout Description
5984 Syntax math-macro <NAME> [<NARGS>] [def]
5987 \begin_layout Description
5989 The name of the macro,
5992 \begin_inset Newline newline
5996 The number of parameters of the macro.
5999 Has no effect anymore,
6000 just for compatibility with former LyX versions.
6003 \begin_layout Description
6010 \begin_layout Subsection*
6011 math-macro-add-greedy-optional-param
6014 \begin_layout Description
6015 Action Add a greedy optional parameter.
6018 \begin_layout Description
6019 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
6022 \begin_layout Description
6023 Syntax math-macro-add-greedy-optional-param
6026 \begin_layout Description
6031 \begin_layout Subsection*
6032 math-macro-add-optional-param
6035 \begin_layout Description
6036 Action Add an optional parameter.
6039 \begin_layout Description
6040 Notion Insert an optional parameter just behind the already existing optional parameters.
6043 \begin_layout Description
6044 Syntax math-macro-add-optional-param
6047 \begin_layout Description
6052 \begin_layout Subsection*
6053 math-macro-add-param
6056 \begin_layout Description
6057 Action Add a parameter.
6060 \begin_layout Description
6061 Notion Add a parameter to a Math Macro.
6064 \begin_layout Description
6065 Syntax math-macro-add-param <NUM>
6068 \begin_layout Description
6070 The number of the parameter behind which the new one will be added (1 for the first,
6072 use 0 for add a parameter at the left),
6073 defaults to the last one.
6076 \begin_layout Description
6081 \begin_layout Subsection*
6082 math-macro-append-greedy-param
6085 \begin_layout Description
6086 Action Append a greedy parameter.
6089 \begin_layout Description
6090 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
6093 \begin_layout Description
6094 Syntax math-macro-append-greedy-param
6097 \begin_layout Description
6102 \begin_layout Subsection*
6106 \begin_layout Description
6107 Action Fold a Math Macro.
6110 \begin_layout Description
6111 Notion Fold the Math Macro the cursor is in if it was unfolded,
6118 \begin_layout Description
6119 Syntax math-macro-fold
6122 \begin_layout Description
6127 \begin_layout Subsection*
6128 math-macro-make-nonoptional
6131 \begin_layout Description
6132 Action Make a parameter non-optional.
6135 \begin_layout Description
6136 Notion Turn the last optional parameter of a Math Macro into a non-optional parameter.
6137 The default value is remembered to be reused later if the user changes his mind.
6140 \begin_layout Description
6141 Syntax math-macro-make-nonoptional
6144 \begin_layout Description
6149 \begin_layout Subsection*
6150 math-macro-make-optional
6153 \begin_layout Description
6154 Action Make a parameter optional.
6157 \begin_layout Description
6158 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
6161 \begin_layout Description
6162 Syntax math-macro-make-optional
6165 \begin_layout Description
6170 \begin_layout Subsection*
6171 math-macro-remove-greedy-param
6174 \begin_layout Description
6175 Action Remove a greedy parameter.
6178 \begin_layout Description
6179 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.
6180 If it is an optional parameter the [valud] format is used.
6183 \begin_layout Description
6184 Syntax math-macro-remove-greedy-param
6187 \begin_layout Description
6192 \begin_layout Subsection*
6193 math-macro-remove-optional-param
6196 \begin_layout Description
6197 Action Remove the last optional parameter.
6200 \begin_layout Description
6201 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
6204 \begin_layout Description
6205 Syntax math-macro-remove-optional-param
6208 \begin_layout Description
6213 \begin_layout Subsection*
6214 math-macro-remove-param
6217 \begin_layout Description
6218 Action Remove the last parameter.
6221 \begin_layout Description
6222 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
6225 \begin_layout Description
6226 Syntax math-macro-remove-param <NUM>
6229 \begin_layout Description
6231 The number of the parameter to be deleted (1 for the first),
6232 defaults to the last one.
6235 \begin_layout Description
6240 \begin_layout Subsection*
6244 \begin_layout Description
6245 Action Unfold a Math Macro.
6248 \begin_layout Description
6249 Notion Unfold the Math Macro the cursor is in,
6256 \begin_layout Description
6257 Syntax math-macro-unfold
6260 \begin_layout Description
6265 \begin_layout Subsection*
6269 \begin_layout Description
6270 Action Inserts a matrix.
6273 \begin_layout Description
6274 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
6277 \begin_layout Description
6279 Alignment is a word composed of the vertical alignment (b,
6281 1 char) and the horizontal alignments (l,
6286 \begin_layout Description
6287 Sample math-matrix 3 3 bccc
6290 \begin_layout Subsection*
6294 \begin_layout Description
6295 Action In text mode enters math mode (i.e.
6296 puts math insets on the current cursor position),
6297 in math mode enters text mode inside math expression.
6300 \begin_layout Description
6301 Notion If there is some selected text,
6302 it puts the text inside created math box.
6305 \begin_layout Description
6306 Syntax math-mode [on|<ARG>]
6309 \begin_layout Description
6311 eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
6312 \begin_inset Newline newline
6316 allow only entering of math mode from text mode.
6319 \begin_layout Description
6324 \begin_layout Subsection*
6328 \begin_layout Description
6329 Action Mutates the type of math inset to the newly selected one.
6332 \begin_layout Description
6333 Syntax math-mutate <TYPE>
6336 \begin_layout Description
6338 none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
6341 \begin_layout Description
6346 \begin_layout Subsection*
6347 math-number-line-toggle
6350 \begin_layout Description
6351 Action Toggles numbering of the current formula line.
6354 \begin_layout Description
6355 Notion Must be in display formula mode.
6358 \begin_layout Description
6359 Syntax math-number-line-toggle
6362 \begin_layout Description
6367 \begin_layout Subsection*
6371 \begin_layout Description
6372 Action Toggles numbering/labeling of the current formula.
6375 \begin_layout Description
6376 Notion Must be in display formula mode.
6379 \begin_layout Description
6380 Syntax math-number-toggle
6383 \begin_layout Description
6388 \begin_layout Subsection*
6392 \begin_layout Description
6393 Action Changes arbitrarily the size used by math fonts inside a context.
6396 \begin_layout Description
6397 Notion Provides an interface to the LaTeX math mode font size commands.
6400 \begin_layout Description
6401 Syntax math-size <STYLE>
6404 \begin_layout Description
6417 \begin_layout Description
6424 \begin_layout Subsection*
6428 \begin_layout Description
6429 Action Inserts space into math expression.
6432 \begin_layout Description
6433 Notion Use spacebar after entering this space to change type of space.
6436 \begin_layout Description
6437 Syntax math-space [<TYPE>] [<LEN>]
6440 \begin_layout Description
6443 !|negthinspace|negmedspace|negthickspace
6444 \begin_inset Newline newline
6448 ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
6449 \begin_inset Newline newline
6454 \begin_inset Newline newline
6457 "," used by default.
6458 \begin_inset Newline newline
6462 is equivalent to negthinspace,
6469 \begin_inset Newline newline
6473 length for custom spaces (hspace)
6476 \begin_layout Description
6483 \begin_layout Subsection*
6487 \begin_layout Description
6488 Action Enters subscript expression in math expression.
6491 \begin_layout Description
6492 Syntax math-subscript
6495 \begin_layout Description
6500 \begin_layout Subsection*
6504 \begin_layout Description
6505 Action Enters superscript expression in math expression.
6508 \begin_layout Description
6509 Syntax math-superscript
6512 \begin_layout Description
6517 \begin_layout Subsection*
6521 \begin_layout Description
6522 Action Enters regexp mode (i.e.,
6523 puts regexp insets on the current cursor position).
6524 Used by the advanced search dialog.
6527 \begin_layout Description
6528 Notion If there is any selected text,
6529 then it is moved inside the created regexp inset.
6532 \begin_layout Description
6533 Syntax regexp-mode [<ARG>]
6536 \begin_layout Description
6538 eventual argument (regular expression).
6541 \begin_layout Description
6546 \begin_layout Section
6547 Buffer Fuctions (File and Window related)
6550 \begin_layout Subsection*
6554 \begin_layout Description
6555 Action Activate the branch.
6558 \begin_layout Description
6559 Syntax branch-activate <BRANCH>
6562 \begin_layout Description
6564 The branch to activate
6567 \begin_layout Description
6568 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6569 \begin_inset Newline newline
6572 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
6575 \begin_layout Description
6580 \begin_layout Subsection*
6584 \begin_layout Description
6585 Action Add a branch to the buffer's BranchList.
6588 \begin_layout Description
6589 Syntax branch-add <BRANCH>
6592 \begin_layout Description
6594 Name of the branch to add
6597 \begin_layout Description
6602 \begin_layout Subsection*
6606 \begin_layout Description
6607 Action Create new branch and directly put the branch inset into the document.
6610 \begin_layout Description
6611 Syntax branch-add-insert [<NAME>]
6614 \begin_layout Description
6617 If it is not specified,
6621 \begin_layout Description
6626 \begin_layout Subsection*
6630 \begin_layout Description
6631 Action De-activate the branch.
6634 \begin_layout Description
6635 Syntax branch-deactivate <BRANCH>
6638 \begin_layout Description
6640 The branch to deactivate
6643 \begin_layout Description
6648 \begin_layout Subsection*
6652 \begin_layout Description
6653 Action Toggles inversion status of branch inset.
6656 \begin_layout Description
6657 Syntax branch-invert
6660 \begin_layout Description
6665 \begin_layout Subsection*
6666 branch-master-activate
6669 \begin_layout Description
6670 Action Activate the branch in the master buffer.
6673 \begin_layout Description
6674 Syntax branch-master-activate <BRANCH>
6677 \begin_layout Description
6679 The branch to activate
6682 \begin_layout Description
6683 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6684 \begin_inset Newline newline
6687 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
6690 \begin_layout Description
6695 \begin_layout Subsection*
6696 branch-master-deactivate
6699 \begin_layout Description
6700 Action De-activate the branch in the master buffer.
6703 \begin_layout Description
6704 Syntax branch-master-deactivate <BRANCH>
6707 \begin_layout Description
6709 The branch to deactivate
6712 \begin_layout Description
6717 \begin_layout Subsection*
6721 \begin_layout Description
6722 Action Open/close all insets of selected branch (depending on its activation status).
6725 \begin_layout Description
6726 Syntax branch-sync-all
6729 \begin_layout Description
6734 \begin_layout Subsection*
6738 \begin_layout Description
6739 Action Rename all branches of a given name in a document.
6742 \begin_layout Description
6743 Syntax branches-rename <OLDNAME> <NEWNAME>
6746 \begin_layout Description
6748 Current name of the branch to be renamed <NEWNAME>:
6749 New name of the branch
6752 \begin_layout Description
6757 \begin_layout Subsection*
6761 \begin_layout Description
6762 Action Saves the current buffer to a temporary file.
6765 \begin_layout Description
6766 Notion Saves the current buffer to a file named "#filename#".
6767 This LFUN is called automatically by LyX,
6768 to "autosave" the current buffer.
6771 \begin_layout Description
6772 Syntax buffer-auto-save
6775 \begin_layout Subsection*
6779 \begin_layout Description
6780 Action Loads the given child document.
6783 \begin_layout Description
6784 Notion The current document is treated as a parent.
6787 \begin_layout Description
6788 Syntax buffer-child-open <FILE>
6791 \begin_layout Description
6793 Filename of the child.
6794 The directory of the parent is assumed by default.
6797 \begin_layout Description
6802 \begin_layout Subsection*
6806 \begin_layout Description
6807 Action Runs chktex for the current document.
6810 \begin_layout Description
6811 Syntax buffer-chktex
6814 \begin_layout Description
6819 \begin_layout Subsection*
6823 \begin_layout Description
6824 Action Closes the current buffer.
6827 \begin_layout Description
6828 Notion Closes the current buffer,
6829 asking whether to save it,
6831 if the buffer has been modified.
6834 \begin_layout Description
6838 \begin_layout Subsection*
6842 \begin_layout Description
6843 Action Closes all buffers.
6846 \begin_layout Description
6847 Notion Closes all buffers,
6848 asking whether to save it,
6850 if a buffer has been modified.
6853 \begin_layout Description
6854 Syntax buffer-close-all
6857 \begin_layout Subsection*
6861 \begin_layout Description
6862 Action Exports the current buffer (document) to the given format.
6865 \begin_layout Description
6866 Syntax buffer-export [<FORMAT>] [<DEST>]
6869 \begin_layout Description
6870 Params <FORMAT> is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format.
6871 Usual format you will enter is "pdf2" (pdflatex),
6872 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
6873 \begin_inset Newline newline
6876 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.
6877 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
6878 \begin_inset Newline newline
6881 If absent or "default",
6882 then the default output format of the document is used.
6883 \begin_inset Newline newline
6887 this argument provides the export destination filename.
6888 Its containing folder will also be the destination folder,
6889 where all the needed external files will be copied.
6892 \begin_layout Description
6897 \begin_layout Subsection*
6901 \begin_layout Description
6902 Action Opens a dialog for exporting the current buffer.
6905 \begin_layout Description
6906 Syntax buffer-export-as [<FORMAT>]
6909 \begin_layout Description
6910 Params <FORMAT> is the export format initially selected in the dialog.
6911 You can pass any of the formats which you can find in Tools->Preferences->File formats->Format,
6912 provided it has the "document" flag set.
6913 If no format is specified the dialog will start with the default output format of the current document.
6916 \begin_layout Description
6917 Sample buffer-export-as pdf2
6920 \begin_layout Description
6925 \begin_layout Subsection*
6926 buffer-export-custom
6929 \begin_layout Description
6930 Action Exports the current buffer (document) from the given format using the given command on it.
6933 \begin_layout Description
6934 Syntax buffer-export-custom <FORMAT> <COMMAND>
6937 \begin_layout Description
6938 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
6939 \begin_inset Newline newline
6942 <COMMAND> this command will be launched on the file.
6943 Note that you can use "$$FName" string to qualify the intermediate file.
6946 \begin_layout Description
6947 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6950 \begin_layout Description
6955 \begin_layout Subsection*
6956 buffer-external-modification-clear
6959 \begin_layout Description
6960 Action Clear the external modification flag on the current buffer.
6963 \begin_layout Description
6964 Syntax buffer-external-modification-clear
6967 \begin_layout Description
6972 \begin_layout Subsection*
6976 \begin_layout Description
6977 Action Applies a command to all non-hidden buffers.
6980 \begin_layout Description
6981 Notion a buffer is `hidden' if it is internally open in LyX,
6982 but not visible in any window.
6985 \begin_layout Description
6986 Syntax buffer-forall <LFUN-COMMAND>
6989 \begin_layout Description
6990 Params <LFUN-COMMAND>:
6991 The command to be applied to the buffers.
6994 \begin_layout Description
6995 Sample Close all Notes in all buffers:
6996 \begin_inset Newline newline
6999 buffer-forall inset-forall Note inset-toggle close
7000 \begin_inset Newline newline
7003 Toggle change tracking on buffers:
7004 \begin_inset Newline newline
7007 buffer-forall changes-track
7008 \begin_inset Newline newline
7011 Toggle read-only for buffers:
7012 \begin_inset Newline newline
7015 buffer-forall buffer-toggle-read-only
7016 \begin_inset Newline newline
7019 Show statistics for individual buffers:
7020 \begin_inset Newline newline
7023 buffer-forall statistics
7024 \begin_inset Newline newline
7027 Activate the branch named "Solutions" in buffers:
7028 \begin_inset Newline newline
7031 buffer-forall branch-activate Solutions
7032 \begin_inset Newline newline
7035 Export buffers to PDF (pdflatex):
7036 \begin_inset Newline newline
7039 buffer-forall buffer-export pdf2
7040 \begin_inset Newline newline
7046 \begin_layout Description
7051 \begin_layout Subsection*
7055 \begin_layout Description
7056 Action Import a given file as a lyx document.
7059 \begin_layout Description
7060 Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences.
7061 Look in the File->Import menu to get an idea of the currently active import formats.
7064 \begin_layout Description
7065 Syntax buffer-import <FORMAT> [<FILE>]
7068 \begin_layout Description
7073 \begin_layout Subsection*
7077 \begin_layout Description
7078 Action Set language of the current document.
7081 \begin_layout Description
7082 Syntax buffer-language <LANG>
7085 \begin_layout Description
7088 See lib/languages for list.
7091 \begin_layout Description
7096 \begin_layout Subsection*
7100 \begin_layout Description
7101 Action Moves the current tab one spot to the right.
7104 \begin_layout Description
7105 Syntax buffer-move-next
7108 \begin_layout Description
7113 \begin_layout Subsection*
7114 buffer-move-previous
7117 \begin_layout Description
7118 Action Moves the current tab one spot to the left.
7121 \begin_layout Description
7122 Syntax buffer-move-previous
7125 \begin_layout Description
7130 \begin_layout Subsection*
7134 \begin_layout Description
7135 Action Creates a new buffer (that is,
7136 document) and switches to it.
7139 \begin_layout Description
7140 Notion Implicit path can be set in Preferences dialog.
7143 \begin_layout Description
7144 Syntax buffer-new [<FILE>]
7147 \begin_layout Description
7149 filename of created file with absolute path.
7152 \begin_layout Subsection*
7156 \begin_layout Description
7157 Action Creates a new buffer (that is,
7158 document) from a template.
7161 \begin_layout Description
7162 Notion Path for new files and templates can be set in Preferences dialog.
7163 Template will be asked for via Open-dialog.
7166 \begin_layout Description
7167 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
7170 \begin_layout Description
7172 filename of created file with absolute path.
7173 If empty or "newfile",
7174 a file with appropriate name is generated.
7175 \begin_inset Newline newline
7179 filename of template with absolute path.
7181 a dialog is opened to select the new file.
7184 \begin_layout Subsection*
7188 \begin_layout Description
7189 Action Switch to the next opened document.
7192 \begin_layout Description
7193 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
7196 \begin_layout Description
7200 \begin_layout Subsection*
7204 \begin_layout Description
7205 Action Apply the given settings to the current document.
7208 \begin_layout Description
7209 Syntax buffer-params-apply [<ARGS>]
7212 \begin_layout Description
7214 contains the particular settings to be saved.
7215 They obey the syntax you can find in document header of usual .lyx file.
7218 \begin_layout Description
7223 \begin_layout Subsection*
7227 \begin_layout Description
7228 Action Switch to the previous opened document.
7231 \begin_layout Description
7232 Syntax buffer-previous
7235 \begin_layout Subsection*
7239 \begin_layout Description
7240 Action Reverts opened document.
7243 \begin_layout Description
7244 Syntax buffer-reload [dump]
7247 \begin_layout Description
7249 do not ask for any confirmation,
7251 All changes will be lost.
7254 \begin_layout Description
7259 \begin_layout Subsection*
7263 \begin_layout Description
7264 Action Removes the auxiliary file before next export to assure export is done afresh.
7267 \begin_layout Description
7268 Syntax buffer-reset-export
7271 \begin_layout Description
7276 \begin_layout Subsection*
7277 buffer-save-as-default
7280 \begin_layout Description
7281 Action Save the current document settings as default.
7284 \begin_layout Description
7285 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
7288 \begin_layout Description
7289 Syntax buffer-save-as-default [<ARGS>]
7292 \begin_layout Description
7294 contains the particular settings to be saved.
7295 They obey the syntax you can find in document header of usual .lyx file.
7298 \begin_layout Description
7303 \begin_layout Subsection*
7307 \begin_layout Description
7308 Action Display and switch to the given buffer.
7311 \begin_layout Description
7312 Syntax buffer-switch <BUFFER>
7315 \begin_layout Description
7317 path and filename of already opened (but possibly hidden) document which is to be shown.
7320 \begin_layout Subsection*
7321 buffer-toggle-compression
7324 \begin_layout Description
7325 Action Toggles compression of the current document on/off.
7328 \begin_layout Description
7329 Syntax buffer-toggle-compression
7332 \begin_layout Description
7337 \begin_layout Subsection*
7338 buffer-toggle-read-only
7341 \begin_layout Description
7342 Action Toggle editing mode of the current document between read/write and read-only.
7345 \begin_layout Description
7346 Notion This function is not allowed if the file is under version control,
7347 since read-only flag is often used in version control file locking.
7350 \begin_layout Description
7351 Syntax buffer-toggle-read-only
7354 \begin_layout Description
7359 \begin_layout Subsection*
7363 \begin_layout Description
7364 Action Exports the current document and put the result into the temporary directory.
7367 \begin_layout Description
7368 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated.
7369 This is useful in case your viewer is able to detect such changes (e.g.
7370 ghostview for postscript).
7373 \begin_layout Description
7374 Syntax buffer-update [<FORMAT>]
7377 \begin_layout Description
7379 The format to display,
7380 where this is one of the formats defined in the Tools>Preferences>File Formats dialog,
7381 use the "Short name" field.
7382 If no format is given,
7383 the default format as specified in the same dialog is used.
7386 \begin_layout Description
7391 \begin_layout Subsection*
7395 \begin_layout Description
7396 Action Displays current buffer in chosen format.
7399 \begin_layout Description
7400 Notion Displays the contents of the current buffer in the chosen format,
7403 This runs the necessary converter,
7404 calls the defined viewer,
7408 \begin_layout Description
7409 Syntax buffer-view [<FORMAT>]
7412 \begin_layout Description
7414 The format to display,
7415 where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7416 If no format is given,
7417 the default format as specified in the same dialog is used.
7420 \begin_layout Subsection*
7424 \begin_layout Description
7425 Action Opens the file that was created from last preview of this buffer.
7428 \begin_layout Description
7429 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog.
7430 It can also be called by the user,
7431 which is useful if the document takes a long time to compile,
7432 and you just want to see the last previewed version.
7435 \begin_layout Description
7436 Syntax buffer-view-cache
7439 \begin_layout Subsection*
7443 \begin_layout Description
7444 Action Saves the current buffer.
7447 \begin_layout Description
7448 Notion Saves the current buffer to disk,
7449 using the filename that is already associated with the buffer,
7450 asking for one if none is yet assigned.
7453 \begin_layout Description
7454 Syntax buffer-write [force]
7457 \begin_layout Description
7459 write even if buffer is not marked as modified.
7462 \begin_layout Subsection*
7466 \begin_layout Description
7467 Action Save all changed documents.
7470 \begin_layout Description
7471 Syntax buffer-write-all
7474 \begin_layout Description
7479 \begin_layout Subsection*
7483 \begin_layout Description
7484 Action Rename and save current buffer.
7487 \begin_layout Description
7488 Syntax buffer-write-as <FILENAME>
7491 \begin_layout Description
7493 New name of the buffer/file.
7494 A relative path is with respect to the original location of the buffer/file.
7497 \begin_layout Subsection*
7498 buffer-write-as-template
7501 \begin_layout Description
7502 Action Rename and save current buffer in the local templates directory.
7505 \begin_layout Description
7506 Syntax buffer-write-as-template <FILENAME>
7509 \begin_layout Description
7511 New name of the buffer/file.
7512 A relative path is with respect to the original location of the buffer/file.
7515 \begin_layout Subsection*
7519 \begin_layout Description
7520 Action Sets the zoom of the screen fonts.
7523 \begin_layout Description
7524 Syntax buffer-zoom [<ZOOM>]
7527 \begin_layout Description
7529 The target zoom value in %;
7530 the default is the default zoom as saved in preferences.
7533 \begin_layout Description
7538 \begin_layout Subsection*
7542 \begin_layout Description
7543 Action Increases the zoom of the screen fonts.
7546 \begin_layout Description
7547 Syntax buffer-zoom-in [<ZOOM>]
7550 \begin_layout Description
7552 The zoom value addition in % (neg.
7554 the default is 10% of the default zoom as saved in preferences.
7557 \begin_layout Description
7562 \begin_layout Subsection*
7566 \begin_layout Description
7567 Action Decreases the zoom of the screen fonts.
7570 \begin_layout Description
7571 Syntax buffer-zoom-out [<ZOOM>]
7574 \begin_layout Description
7576 The zoom value abstraction in % (neg.
7578 the default is 10% of the default zoom as saved in preferences.
7581 \begin_layout Description
7586 \begin_layout Subsection*
7590 \begin_layout Description
7591 Action Generates the code (literate programming).
7594 \begin_layout Description
7595 Notion Latex file with extension
7597 literate_extension is generated.
7600 build_command (with a default of ``make'') to generate the code and
7602 build_error_filter to process the compilation error messages.
7603 \begin_inset Newline newline
7606 In case you want to process your literate file with a script,
7607 or some other program,
7608 just insert in your lyxrc file an entry with:
7609 \begin_inset Newline newline
7614 build_command "my_script my_arguments"
7615 \begin_inset Newline newline
7620 build_error_filter differs from the
7622 literate_error_filter only in that the former will identify error messages from your compiler.
7625 \begin_layout Description
7626 Syntax build-program
7629 \begin_layout Subsection*
7633 \begin_layout Description
7634 Action Open LyX document.
7637 \begin_layout Description
7638 Syntax file-open [<FILE>]
7641 \begin_layout Description
7643 Filename to be opened.
7646 \begin_layout Subsection*
7650 \begin_layout Description
7651 Action Open the given help file according to the language setting.
7654 \begin_layout Description
7655 Syntax help-open <FILE>[.lyx]
7658 \begin_layout Description
7660 any document from (/usr/share/)doc directory.
7663 \begin_layout Description
7668 \begin_layout Subsection*
7672 \begin_layout Description
7673 Action Sets icon size of toolbars.
7676 \begin_layout Description
7677 Syntax icon-size [<SIZE>]
7680 \begin_layout Description
7682 the icon size in px or one of the logical settings small|normal|big|huge|giant,
7683 the default is normal (whose size in px is icon set dependent).
7686 \begin_layout Description
7690 \begin_layout Subsection*
7694 \begin_layout Description
7695 Action Helper function for master-related actions
7698 \begin_layout Description
7700 the function will be disabled if the buffer has no master or children.
7701 It thus allows to enable actions only in documents with master/children
7704 \begin_layout Description
7705 Syntax ifrelatives <ACTION>
7708 \begin_layout Description
7713 \begin_layout Subsection*
7717 \begin_layout Description
7718 Action Terminates the current LyX instance.
7721 \begin_layout Description
7722 Notion Terminates the current LyX instance,
7723 asking whether to save modified documents,
7727 \begin_layout Description
7731 \begin_layout Subsection*
7735 \begin_layout Description
7736 Action Open lyxfiles (templates/examples).
7737 Create a view if he have none.
7740 \begin_layout Description
7741 Syntax lyxfiles-open [<TYPE>]
7744 \begin_layout Description
7746 templates or examples.
7747 Default is templates.
7750 \begin_layout Description
7755 \begin_layout Subsection*
7756 master-buffer-export
7759 \begin_layout Description
7760 Action Exports the master buffer (document) to the given format.
7763 \begin_layout Description
7764 Syntax master-buffer-export [<FORMAT>] [<DEST>]
7767 \begin_layout Description
7768 Params <FORMAT> is one of the formats which you can find in Tools->Preferences->File formats->Format.
7769 Usual format you will enter is "pdf2" (pdflatex),
7770 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
7771 \begin_inset Newline newline
7774 Note that "custom" is not allowed in this case.
7775 \begin_inset Newline newline
7778 If absent or "default",
7779 then the default output format of the document is used.
7780 \begin_inset Newline newline
7784 this argument provides the export destination filename.
7785 Its containing folder will also be the destination folder,
7786 where all the needed external files will be copied.
7789 \begin_layout Description
7794 \begin_layout Subsection*
7795 master-buffer-forall
7798 \begin_layout Description
7799 Action Applies a command to a buffer and all it children,
7800 starting from the master.
7803 \begin_layout Description
7804 Syntax master-buffer-forall <LFUN-COMMAND>
7807 \begin_layout Description
7808 Params <LFUN-COMMAND>:
7809 The command to be applied to the buffers.
7812 \begin_layout Description
7813 Sample Close all Notes in buffers:
7814 \begin_inset Newline newline
7817 master-buffer-forall inset-forall Note inset-toggle close
7818 \begin_inset Newline newline
7821 Toggle change tracking on buffers:
7822 \begin_inset Newline newline
7825 master-buffer-forall changes-track
7826 \begin_inset Newline newline
7829 Toggle read-only for buffers:
7830 \begin_inset Newline newline
7833 master-buffer-forall buffer-toggle-read-only
7834 \begin_inset Newline newline
7837 Show statistics for individual buffers:
7838 \begin_inset Newline newline
7841 master-buffer-forall statistics
7842 \begin_inset Newline newline
7845 Activate the branch named "Solutions" in buffers:
7846 \begin_inset Newline newline
7849 master-buffer-forall branch-activate Solutions
7850 \begin_inset Newline newline
7856 \begin_layout Description
7861 \begin_layout Subsection*
7862 master-buffer-update
7865 \begin_layout Description
7866 Action Update (export) the document built from the master buffer,
7867 if the current buffer is part of a master/child document.
7870 \begin_layout Description
7871 Syntax master-buffer-update [<FORMAT>]
7874 \begin_layout Description
7876 The format to display,
7877 where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7878 If no format is given,
7879 the default format as specified in the same dialog is used.
7882 \begin_layout Description
7887 \begin_layout Subsection*
7891 \begin_layout Description
7892 Action Show a preview built from the master buffer,
7894 if the current buffer is part of a master/child document.
7897 \begin_layout Description
7898 Syntax master-buffer-view [<FORMAT>]
7901 \begin_layout Description
7903 The format to display,
7904 where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
7905 If no format is given,
7906 the default format as specified in the same dialog is used.
7909 \begin_layout Description
7914 \begin_layout Subsection*
7918 \begin_layout Description
7919 Action Opens the menu given by its name.
7922 \begin_layout Description
7923 Syntax menu-open <NAME>
7926 \begin_layout Description
7929 See various .inc files in lib/ui for candidates.
7932 \begin_layout Subsection*
7936 \begin_layout Description
7937 Action Close the current tab group.
7940 \begin_layout Description
7941 Notion This only closes the work areas,
7942 not the buffers themselves.
7943 The still opened buffers can be visualized in another tab group.
7946 \begin_layout Description
7947 Syntax tab-group-close
7950 \begin_layout Description
7955 \begin_layout Subsection*
7959 \begin_layout Description
7960 Action Switch to the next tab group in split view.
7963 \begin_layout Description
7964 Syntax tab-group-next
7967 \begin_layout Subsection*
7971 \begin_layout Description
7972 Action Switch to the previous tab group in split view.
7975 \begin_layout Description
7976 Syntax tab-group-previous
7979 \begin_layout Subsection*
7983 \begin_layout Description
7984 Action Toggles movability of a given toolbar between true/false.
7987 \begin_layout Description
7988 Syntax toolbar-movable <NAME>
7991 \begin_layout Description
7993 *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
7996 \begin_layout Description
8001 \begin_layout Subsection*
8005 \begin_layout Description
8006 Action Sets visibility of a given toolbar to on,
8011 \begin_layout Description
8012 Notion Skipping "auto" when allowauto is false.
8015 \begin_layout Description
8016 Syntax toolbar-set <NAME> [on|off|auto]
8019 \begin_layout Description
8021 standard|extra|table|math|mathmacrotemplate|
8022 \begin_inset Newline newline
8025 minibuffer|review|view/update|math_panels|vcs|
8026 \begin_inset Newline newline
8029 view-others|update-others
8032 \begin_layout Description
8037 \begin_layout Subsection*
8041 \begin_layout Description
8042 Action Toggles visibility of a given toolbar between on/off/auto.
8045 \begin_layout Description
8046 Notion Skipping "auto" when allowauto is false.
8049 \begin_layout Description
8050 Syntax toolbar-toggle <NAME> [allowauto]
8053 \begin_layout Description
8055 standard|extra|table|math|mathmacrotemplate|
8056 \begin_inset Newline newline
8059 minibuffer|review|view/update|math_panels|vcs|
8060 \begin_inset Newline newline
8063 view-others|update-others
8066 \begin_layout Description
8071 \begin_layout Subsection*
8075 \begin_layout Description
8076 Action Various UI visibility-toggling actions.
8079 \begin_layout Description
8080 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
8083 \begin_layout Description
8085 Toggle visibility of the statusbar.
8086 \begin_inset Newline newline
8090 Toggle visibility of the menubar.
8091 \begin_inset Newline newline
8095 Toggle visibility of the scrollbar.
8096 \begin_inset Newline newline
8100 Toggle visibility of the frames around editing window.
8101 \begin_inset Newline newline
8105 Toggle visibility of the zoom slider in statusbar.
8106 \begin_inset Newline newline
8110 Toggle visibility of the zoom level display in statusbar.
8111 \begin_inset Newline newline
8115 Toggle visibility of the document word count in statusbar.
8116 \begin_inset Newline newline
8120 Toggle visibility of the document character count (incl.
8121 blanks) in statusbar.
8122 \begin_inset Newline newline
8126 Toggle visibility of the document character count (excl.
8127 blanks) in statusbar.
8128 \begin_inset Newline newline
8132 Toggle fullscreen mode.
8133 This also covers calling the previous functions.
8134 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
8137 \begin_layout Description
8142 \begin_layout Subsection*
8146 \begin_layout Description
8147 Action Close the current document work area.
8150 \begin_layout Description
8151 Notion Close the current work area.
8152 If no other work areas are showing the buffer,
8153 then close the associated buffer as well.
8156 \begin_layout Description
8160 \begin_layout Description
8165 \begin_layout Subsection*
8169 \begin_layout Description
8170 Action Creates another split view of current buffer.
8173 \begin_layout Description
8174 Notion All split views act in the same way independently.
8177 \begin_layout Description
8178 Syntax view-split <vertical|horizontal>
8181 \begin_layout Description
8183 The work areas are laid out side by side.
8184 \begin_inset Newline newline
8188 The work areas laid out vertically.
8191 \begin_layout Description
8196 \begin_layout Subsection*
8200 \begin_layout Description
8201 Action Closes the current LyX window.
8204 \begin_layout Description
8208 \begin_layout Description
8213 \begin_layout Subsection*
8217 \begin_layout Description
8218 Action Creates new empty LyX window.
8221 \begin_layout Description
8222 Notion Already opened documents from the previous window can be found under View menu.
8225 \begin_layout Description
8226 Syntax window-new [<GEOMETRY>]
8229 \begin_layout Description
8231 pass the geometry of the window.
8232 This parameter is currently accepted only on Windows platform.
8235 \begin_layout Description
8240 \begin_layout Section
8241 System Functions (Preferences,
8245 \begin_layout Subsection*
8246 bibtex-database-list
8249 \begin_layout Description
8250 Action Lists the available databases (separated by path separator common on the used OS).
8253 \begin_layout Description
8254 Notion Used by bibliographic managers
8257 \begin_layout Description
8258 Syntax bibtex-database-list
8261 \begin_layout Description
8266 \begin_layout Subsection*
8267 buffer-toggle-output-sync
8270 \begin_layout Description
8271 Action Toggles including of resources for forward/reverse search of the given document.
8274 \begin_layout Description
8275 Notion When toggled on,
8276 SyncTeX is invoked for PDF,
8277 while srcltx package is used for DVI.
8278 Custom LaTeX macro can be defined in preferences.
8281 \begin_layout Description
8282 Syntax buffer-toggle-output-sync
8285 \begin_layout Description
8290 \begin_layout Subsection*
8294 \begin_layout Description
8295 Action Executes a command defined in a .def file.
8298 \begin_layout Description
8299 Notion The definitions are by default read from lib/commands/default.def.
8300 \begin_inset Newline newline
8303 A .def file allows to define a command with
8305 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and <LFUN> is the lfun code to be executed (see e.g.
8306 LFUN_COMMAND_SEQUENCE).
8309 def_file "FileName" allows to include another .def file.
8310 \begin_inset Newline newline
8313 This is particularly useful in connection with toolbar buttons:
8314 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.
8317 \begin_layout Description
8321 \begin_layout Description
8323 Name of the command that must be called.
8326 \begin_layout Description
8331 \begin_layout Subsection*
8335 \begin_layout Description
8336 Action Cancels sequence prepared by LFUN_META_PREFIX .
8339 \begin_layout Description
8343 \begin_layout Subsection*
8344 command-alternatives
8347 \begin_layout Description
8348 Action Runs the first listed command that is enabled.
8351 \begin_layout Description
8352 Notion This can be used to bind multiple functions to a single key,
8353 and then which one is used will depend upon the context.
8356 \begin_layout Description
8357 Syntax command-alternatives <CMDS>
8360 \begin_layout Description
8362 Sequence of commands separated by semicolons.
8365 \begin_layout Description
8366 Sample command-alternatives completion-accept;cell-forward
8369 \begin_layout Description
8374 \begin_layout Subsection*
8378 \begin_layout Description
8379 Action Run more commands (LFUN and its parameters) in a sequence.
8382 \begin_layout Description
8383 Syntax command-sequence <CMDS>
8386 \begin_layout Description
8388 Sequence of commands separated by semicolons.
8391 \begin_layout Description
8392 Sample command-sequence cut;
8402 \begin_layout Description
8407 \begin_layout Subsection*
8408 cursor-follows-scrollbar-toggle
8411 \begin_layout Description
8412 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
8415 \begin_layout Description
8416 Syntax toggle-cursor-follows-scrollbar
8419 \begin_layout Description
8424 \begin_layout Subsection*
8428 \begin_layout Description
8429 Action Set debug output level.
8432 \begin_layout Description
8433 Syntax debug-level-set <LEVEL>
8436 \begin_layout Description
8438 comma separated list of levels or the correspondent number of their combination.
8439 0 is equivalent to disabling all debug events.
8440 See lyx -dbg for the current list of debug levels and their numbers.
8443 \begin_layout Description
8448 \begin_layout Subsection*
8452 \begin_layout Description
8453 Action toggle a mode where more information is given in UI
8456 \begin_layout Description
8457 Notion in so called "devel" mode,
8458 the information given in the status bar is more precise,
8459 and the help documents are open in editing mode.
8462 \begin_layout Description
8463 Syntax devel-mode-toggle
8466 \begin_layout Description
8471 \begin_layout Subsection*
8475 \begin_layout Description
8476 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
8479 \begin_layout Description
8480 Notion The external program used for forward search call can be specified in LyX Output preferences.
8481 See Additional manual for details of these settings.
8484 \begin_layout Description
8485 Syntax forward-search
8488 \begin_layout Description
8493 \begin_layout Subsection*
8497 \begin_layout Description
8498 Action Apply the given settings to user preferences.
8501 \begin_layout Description
8502 Syntax lyxrc-apply <SETTINGS>
8505 \begin_layout Description
8507 settings which are to be set.
8508 Take a look into ~/.lyx/preferences to get an idea which commands to use and their syntax.
8509 lyx::LyXRC::LyXRCTags has the list of possible commands.
8512 \begin_layout Subsection*
8516 \begin_layout Description
8517 Action Shows message in statusbar (for script purposes).
8520 \begin_layout Description
8521 Syntax message <STRING>
8524 \begin_layout Description
8529 \begin_layout Subsection*
8533 \begin_layout Description
8534 Action Simulate halting Meta key (Alt key on PCs).
8537 \begin_layout Description
8538 Notion Used for buffer edition not for GUI control.
8541 \begin_layout Description
8545 \begin_layout Subsection*
8549 \begin_layout Description
8550 Action Save user preferences.
8553 \begin_layout Description
8554 Syntax preferences-save
8557 \begin_layout Description
8562 \begin_layout Subsection*
8566 \begin_layout Description
8567 Action Reconfigure the automatic settings.
8570 \begin_layout Description
8574 \begin_layout Description
8579 \begin_layout Subsection*
8583 \begin_layout Description
8584 Action Enables/disables searching for features in findadv
8587 \begin_layout Description
8588 Syntax search-ignore <type> <value>
8591 \begin_layout Description
8593 language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content
8594 \begin_inset Newline newline
8601 \begin_layout Subsection*
8605 \begin_layout Description
8606 Action Returns path and file name of the currently edited document.
8609 \begin_layout Description
8610 Syntax server-get-filename
8613 \begin_layout Subsection*
8617 \begin_layout Description
8618 Action Returns the current layout (that is environment) name on the cursor position.
8621 \begin_layout Description
8622 Syntax server-get-layout
8625 \begin_layout Subsection*
8626 server-get-statistics
8629 \begin_layout Description
8630 Action Returns the statistics (number of words and characters) in the document or in the given selection.
8633 \begin_layout Description
8634 Notion Note that this function gives the number of words/chars written,
8635 not the number of characters which will be typeset.
8638 \begin_layout Description
8639 Syntax server-get-statistics [<TYPE>]
8642 \begin_layout Description
8644 <words|chars|chars-space> The requested count;
8646 the three values are returned,
8647 separated by a space.
8648 \begin_inset Newline newline
8653 \begin_inset Newline newline
8658 \begin_inset Newline newline
8662 count characters and spaces.
8665 \begin_layout Description
8670 \begin_layout Subsection*
8674 \begin_layout Description
8675 Action Returns the coordinates of cursor position in the editing area.
8678 \begin_layout Description
8679 Syntax server-get-xy
8682 \begin_layout Subsection*
8683 server-goto-file-row
8686 \begin_layout Description
8687 Action Sets the cursor position in LyX based on the row number of generated TeX file.
8690 \begin_layout Description
8691 Notion This can be useful for DVI inverse-search or detection of the problematic line from LaTeX compilation.
8692 Note that before this function can be used export to LaTeX output must occur (in order to map the row numbers).
8695 \begin_layout Description
8696 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
8699 \begin_layout Description
8701 the path and filename.
8702 Environment variables are expanded in the path.
8703 In case this LFUN does not work make sure you are giving correct path to the file.
8704 \begin_inset Newline newline
8707 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g.
8708 for the case of generated .tex file).
8709 \begin_inset Newline newline
8713 extensions will be automatically replaced by .lyx.
8714 \begin_inset Newline newline
8717 <ROW_NUMBER> The row number of the LaTeX file to which to go.
8720 \begin_layout Description
8721 Sample server-goto-file-row /home/user/example.lyx 41
8722 \begin_inset Newline newline
8725 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
8728 \begin_layout Description
8733 \begin_layout Subsection*
8737 \begin_layout Description
8738 Action Sends notify message about the last key-sequence to client.
8741 \begin_layout Description
8742 Notion This can be used to grab last key-sequence used inside the LyX window.
8743 See also Debug extensions section in Additional features manual.
8746 \begin_layout Description
8747 Syntax server-notify
8750 \begin_layout Subsection*
8754 \begin_layout Description
8755 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
8758 \begin_layout Description
8759 Syntax server-set-xy <X> <Y>
8762 \begin_layout Subsection*
8766 \begin_layout Description
8767 Action Set the given LyX color to the color defined by the X11 name given,
8768 and optionally a specific color for dark mode.
8771 \begin_layout Description
8772 Notion A new color entry is created if the color is unknown.
8773 Color names can be stored as a part of user settings.
8776 \begin_layout Description
8777 Syntax set-color <LYX_NAME> <X11_NAME> [<X11_DARKNAME>]
8780 \begin_layout Description
8785 \begin_layout Subsection*
8789 \begin_layout Description
8790 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
8793 \begin_layout Description
8794 Notion Note that this function gives the number of words/chars written,
8795 not the number of characters which will be typeset.
8798 \begin_layout Description
8802 \begin_layout Description
8809 \begin_layout Subsection*
8813 \begin_layout Description
8814 Action Checks-in/commits the changes of the registered file to the repository.
8817 \begin_layout Description
8818 Notion In RCS case this also unlocks the file.
8821 \begin_layout Description
8825 \begin_layout Description
8830 \begin_layout Subsection*
8834 \begin_layout Description
8835 Action Checks-out the document for edit (and locks it in some cases).
8838 \begin_layout Description
8842 \begin_layout Description
8847 \begin_layout Subsection*
8851 \begin_layout Description
8852 Action Executes external command.
8853 This command is intended to support additional VCS commands.
8856 \begin_layout Description
8857 Syntax vc-command <FLAG> <PATH> <COMMAND>
8860 \begin_layout Description
8862 Flags for the command can be combined together.
8863 \begin_inset Newline newline
8866 U - dUmmy - no flags
8867 \begin_inset Newline newline
8870 D - Doc - need document loaded to proceed
8871 \begin_inset Newline newline
8874 I - dIrty - mark document dirty
8875 \begin_inset Newline newline
8878 R - Reload - ensure that the document is saved and reload it after command execution
8879 \begin_inset Newline newline
8882 M - Message - ask for input string (commit message)
8883 \begin_inset Newline newline
8887 path where to start.
8888 $$p will be replaced by the current document path.
8889 \begin_inset Newline newline
8894 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
8897 \begin_layout Description
8898 Sample vc-command DR $$p "svn up"
8901 \begin_layout Description
8906 \begin_layout Subsection*
8910 \begin_layout Description
8911 Action Compares two revisions of the same file under version control.
8914 \begin_layout Description
8915 Syntax vc-compare [<REV1>] [<REV2>]
8918 \begin_layout Description
8919 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
8920 \begin_inset Newline newline
8923 In RCS we subtract only in the last number of revision specification.
8924 Special case "0" is reserved for the last committed revision.
8925 \begin_inset Newline newline
8930 \begin_inset Newline newline
8935 Used only if REV1 > 0.
8936 \begin_inset Newline newline
8939 If no parameter is given,
8940 interactive dialog will be shown.
8943 \begin_layout Description
8944 Sample Compare current document against last commit
8945 \begin_inset Newline newline
8949 \begin_inset Newline newline
8952 Compare current document against current revision - 5 commits
8953 \begin_inset Newline newline
8957 \begin_inset Newline newline
8960 Compare revisions 120 and 155
8961 \begin_inset Newline newline
8967 \begin_layout Description
8972 \begin_layout Subsection*
8976 \begin_layout Description
8977 Action Copies the document to another name.
8980 \begin_layout Description
8981 Notion Copying with revision history is only supported by SVN.
8982 For RCS and CVS it is simulated by adding the document under a new name.
8983 Disabled if uncommitted changes exist.
8986 \begin_layout Description
8987 Syntax vc-copy <FILENAME>
8990 \begin_layout Description
8992 New name of the document.
8993 \begin_inset Newline newline
8996 A file dialog is opened if no filename is given.
8999 \begin_layout Description
9004 \begin_layout Subsection*
9008 \begin_layout Description
9009 Action Toggles the locking property of the edited file.
9012 \begin_layout Description
9013 Notion This is currently implemented only for SVN.
9016 \begin_layout Description
9017 Syntax vc-locking-toggle
9020 \begin_layout Description
9025 \begin_layout Subsection*
9029 \begin_layout Description
9030 Action Register the document as an file inside version control system.
9033 \begin_layout Description
9034 Notion File is registered inside cvs,
9035 svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
9036 \begin_inset Newline newline
9039 See LyX Additional Features Manual (Version Control Chapter) for additional information.
9042 \begin_layout Description
9046 \begin_layout Description
9051 \begin_layout Subsection*
9055 \begin_layout Description
9056 Action Renames the document to another name.
9059 \begin_layout Description
9060 Notion Renaming with revision history is only supported by SVN.
9061 For CVS it is simulated by adding the document under a new name and deleting the old one.
9062 For RCS it is not supported.
9063 Disabled if uncommitted changes exist.
9066 \begin_layout Description
9067 Syntax vc-rename <FILENAME>
9070 \begin_layout Description
9072 New name of the document.
9073 \begin_inset Newline newline
9076 A file dialog is opened if no filename is given.
9079 \begin_layout Description
9084 \begin_layout Subsection*
9088 \begin_layout Description
9089 Action Update the local archive directory in which resides the current document with the remote repository.
9092 \begin_layout Description
9093 Syntax vc-repo-update
9096 \begin_layout Description
9101 \begin_layout Subsection*
9105 \begin_layout Description
9106 Action Reverts the document to the last check-in/commit in VCS.
9109 \begin_layout Description
9113 \begin_layout Description
9118 \begin_layout Subsection*
9122 \begin_layout Description
9123 Action Undo last check-in.
9126 \begin_layout Description
9127 Notion This is currently implemented only for RCS.
9130 \begin_layout Description
9134 \begin_layout Description
9139 \begin_layout Section
9140 Hidden Functions (not listed for configuration)
9143 \begin_layout Subsection*
9147 \begin_layout Description
9148 Action Return the current key sequence and available options as a string.
9151 \begin_layout Description
9152 Notion No options are added if no current map exists.
9153 \begin_inset Newline newline
9156 This is probably usable only with connection to lyxserver.
9159 \begin_layout Description
9160 Syntax command-prefix
9163 \begin_layout Subsection*
9167 \begin_layout Description
9168 Action Activates the LyX window.
9171 \begin_layout Description
9172 Notion On Linux and Mac OS,
9173 this action brings the LyX window into focus.
9174 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.
9175 This action is useful in combination with reverse search.
9178 \begin_layout Description
9182 \begin_layout Description
9187 \begin_layout Subsection*
9191 \begin_layout Description
9192 Action Inserts the given string (accordingly to the correct keymap).
9195 \begin_layout Description
9196 Notion Automatically replace the currently selected text.
9197 Depends on lyxrc settings "auto_region_delete".
9200 \begin_layout Description
9201 Syntax self-insert <STRING>
9204 \begin_layout Subsection*
9208 \begin_layout Description
9209 Action Raises the LyX window.
9212 \begin_layout Description
9213 Notion Brings the LyX window to the front.
9214 Such behavior is allowed on Windows only when no other application has focus.
9215 This action is used when LyX is in single instance mode.
9218 \begin_layout Description
9222 \begin_layout Description