1 #LyX 2.3 created this file. For more info see http://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 false
27 \language_package default
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
38 \font_sf_scale 100 100
39 \font_tt_scale 100 100
41 \use_dash_ligatures true
43 \default_output_format default
45 \bibtex_command default
46 \index_command default
47 \paperfontsize default
52 \use_package amsmath 1
53 \use_package amssymb 1
56 \use_package mathdots 0
57 \use_package mathtools 0
59 \use_package stackrel 0
60 \use_package stmaryrd 0
61 \use_package undertilde 0
63 \cite_engine_type default
67 \paperorientation portrait
81 \paragraph_separation indent
82 \paragraph_indentation default
84 \math_numbering_side default
88 \paperpagestyle default
89 \tracking_changes false
109 \begin_layout Section*
113 \begin_layout Standard
114 This manual documents the
115 \begin_inset Quotes eld
119 \begin_inset Quotes erd
123 These are commands that are used to make \SpecialChar LyX
124 perform specific actions.
126 itself uses these functions internally, and every internal action is
130 \begin_layout Standard
131 LFUNs are also used in the files that define keyboard shortcuts, menu or
133 So if you want to change\SpecialChar breakableslash
134 customize the user interface, you need to deal
136 Furthermore, external programs can use LFUNs to communicate with and
137 \begin_inset Quotes eld
141 \begin_inset Quotes erd
146 Finally, you can also issue LFUNs directly via the so called mini-buffer
147 which can be opened via
150 arg "command-execute"
156 \begin_layout Standard
157 In the following, all LFUNs are listed, categorized by function.
160 \begin_layout Section
161 Layout Functions (Font, Layout and Textclass related)
164 \begin_layout Subsection*
168 \begin_layout Description
169 Action Displays list of layout choices.
172 \begin_layout Description
173 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
176 \begin_layout Description
177 Syntax drop-layouts-choice
180 \begin_layout Subsection*
184 \begin_layout Description
185 Action Splits the current environment with a Separator.
188 \begin_layout Description
189 Syntax environment-split [outer]
192 \begin_layout Description
193 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
196 \begin_layout Description
197 Origin spitz, 23 Dec 2012
200 \begin_layout Subsection*
204 \begin_layout Description
205 Action Toggles the bold font (selection-wise) using mathbf in math.
208 \begin_layout Description
212 \begin_layout Subsection*
216 \begin_layout Description
217 Action Toggles the bold font (selection-wise) using boldsymbol in math.
220 \begin_layout Description
221 Syntax font-boldsymbol
224 \begin_layout Subsection*
228 \begin_layout Description
229 Action Toggles xout (cross-through) in the font (selection-wise).
232 \begin_layout Description
236 \begin_layout Description
237 Origin uwestoehr, 4 April 2017
240 \begin_layout Subsection*
244 \begin_layout Description
245 Action Reverts the settings of the font to the default values (selection-wise).
248 \begin_layout Description
252 \begin_layout Subsection*
256 \begin_layout Description
257 Action Toggles the emphasis font style (selection-wise).
260 \begin_layout Description
264 \begin_layout Subsection*
268 \begin_layout Description
269 Action Toggles Fraktur family font (math-mode, selection-wise).
272 \begin_layout Description
276 \begin_layout Description
277 Origin vermeer, 10 Jan 2002
280 \begin_layout Subsection*
284 \begin_layout Description
285 Action Toggles Italics font shape (math-mode, selection-wise).
288 \begin_layout Description
292 \begin_layout Description
293 Origin vermeer, 10 Jan 2002
296 \begin_layout Subsection*
300 \begin_layout Description
301 Action Toggles Noun text style font (selection-wise).
304 \begin_layout Description
308 \begin_layout Subsection*
312 \begin_layout Description
313 Action Toggles Roman family font (selection-wise).
316 \begin_layout Description
320 \begin_layout Subsection*
324 \begin_layout Description
325 Action Toggles Sans Serif family font (selection-wise).
328 \begin_layout Description
332 \begin_layout Subsection*
336 \begin_layout Description
337 Action Sets font size according to lyx format string.
340 \begin_layout Description
341 Syntax font-size <SIZE>
344 \begin_layout Description
345 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
346 \begin_inset Newline newline
349 largest|huge|giant|increase|decrease|default
352 \begin_layout Subsection*
356 \begin_layout Description
357 Action Returns the info about the current font.
360 \begin_layout Description
364 \begin_layout Subsection*
368 \begin_layout Description
369 Action Toggles strikeout (strike-through) in the font (selection-wise).
372 \begin_layout Description
373 Syntax font-strikeout
376 \begin_layout Description
377 Origin sanda, 3 May 2009
380 \begin_layout Subsection*
384 \begin_layout Description
385 Action Toggles the typewriter family font (selection-wise).
388 \begin_layout Description
389 Syntax font-typewriter
392 \begin_layout Subsection*
396 \begin_layout Description
397 Action Toggles underline in the font (selection-wise).
400 \begin_layout Description
401 Syntax font-underline
404 \begin_layout Subsection*
408 \begin_layout Description
409 Action Toggles double underline in the font (selection-wise).
412 \begin_layout Description
413 Syntax font-underunderline
416 \begin_layout Description
417 Origin sanda, 5 May 2009
420 \begin_layout Subsection*
424 \begin_layout Description
425 Action Toggles wavy underline in the font (selection-wise).
428 \begin_layout Description
429 Syntax font-underwave
432 \begin_layout Description
433 Origin sanda, 5 May 2009
436 \begin_layout Subsection*
440 \begin_layout Description
441 Action Sets the layout (that is, environment) for the current paragraph.
444 \begin_layout Description
445 Syntax layout <LAYOUT>
448 \begin_layout Description
449 Params <LAYOUT>: the layout to use
452 \begin_layout Subsection*
456 \begin_layout Description
457 Action Adds a module.
460 \begin_layout Description
461 Notion Adds a module to the list of included modules for the current buffer.
464 \begin_layout Description
465 Syntax layout-module-add <MODULE>
468 \begin_layout Description
469 Params <MODULE>: the module to be added
472 \begin_layout Description
473 Origin rgh, 25 August 2007
476 \begin_layout Subsection*
480 \begin_layout Description
481 Action Clears the module list.
484 \begin_layout Description
485 Notion Clears the list of included modules for the current buffer.
488 \begin_layout Description
489 Syntax layout-modules-clear
492 \begin_layout Description
493 Origin rgh, 25 August 2007
496 \begin_layout Subsection*
500 \begin_layout Description
501 Action Launches the paragraph settings dialog.
504 \begin_layout Description
505 Syntax layout-paragraph
508 \begin_layout Subsection*
512 \begin_layout Description
513 Action Reloads layout information.
516 \begin_layout Description
517 Notion Reloads all layout information for the current buffer from disk, thus recognizing any changes that have been made to layout files on the fly. This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
520 \begin_layout Description
524 \begin_layout Description
525 Origin rgh, 3 September 2007
528 \begin_layout Subsection*
532 \begin_layout Description
533 Action Launches the tabular settings dialog.
536 \begin_layout Description
537 Syntax layout-tabular
540 \begin_layout Description
541 Origin Jug, 31 Jul 2000
544 \begin_layout Subsection*
548 \begin_layout Description
549 Action Update fonts and its metrics.
552 \begin_layout Description
553 Notion Automatically called after zoom, dpi, font names, or norm change.
556 \begin_layout Description
557 Syntax screen-font-update
560 \begin_layout Description
561 Origin ARRae, 13 Aug 2000
564 \begin_layout Subsection*
568 \begin_layout Description
569 Action Sets the text class for the current buffer.
572 \begin_layout Description
573 Syntax textclass-apply <TEXTCLASS>
576 \begin_layout Description
577 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
580 \begin_layout Subsection*
584 \begin_layout Description
585 Action Loads information for a textclass from disk.
588 \begin_layout Description
589 Syntax textclass-load <TEXTCLASS>
592 \begin_layout Description
593 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
596 \begin_layout Subsection*
600 \begin_layout Description
601 Action Toggle user-defined (=last-time used) text style.
604 \begin_layout Description
605 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
608 \begin_layout Description
609 Syntax textstyle-apply
612 \begin_layout Description
613 Origin leeming, 12 Mar 2003
616 \begin_layout Subsection*
620 \begin_layout Description
621 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
624 \begin_layout Description
625 Syntax textstyle-update <FONT_INFO>
628 \begin_layout Description
629 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
630 \begin_inset Newline newline
633 Use lyx -dbg action for exact syntax of text-style dialog parameters.
636 \begin_layout Description
637 Origin leeming, 12 Mar 2003
640 \begin_layout Section
641 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
644 \begin_layout Subsection*
648 \begin_layout Description
649 Action Adds an acute accent to the next character typed.
652 \begin_layout Description
656 \begin_layout Subsection*
660 \begin_layout Description
661 Action Adds a breve accent to the next character typed.
664 \begin_layout Description
668 \begin_layout Subsection*
672 \begin_layout Description
673 Action Adds a caron to the next character typed.
676 \begin_layout Description
680 \begin_layout Subsection*
684 \begin_layout Description
685 Action Adds a cedilla to the next character typed.
688 \begin_layout Description
689 Syntax accent-cedilla
692 \begin_layout Subsection*
696 \begin_layout Description
697 Action Adds a circle accent to the next character typed.
700 \begin_layout Description
704 \begin_layout Subsection*
708 \begin_layout Description
709 Action Adds a circumflex to the next character typed.
712 \begin_layout Description
713 Syntax accent-circumflex
716 \begin_layout Subsection*
720 \begin_layout Description
721 Action Adds a dot accent to the next character typed.
724 \begin_layout Description
728 \begin_layout Subsection*
732 \begin_layout Description
733 Action Adds a grave accent to the next character typed.
736 \begin_layout Description
740 \begin_layout Subsection*
741 accent-hungarian-umlaut
744 \begin_layout Description
745 Action Adds a Hungarian umlaut to the next character typed.
748 \begin_layout Description
752 \begin_layout Subsection*
756 \begin_layout Description
757 Action Adds a macron to the next character typed.
760 \begin_layout Description
764 \begin_layout Subsection*
768 \begin_layout Description
769 Action Adds an ogonek accent to the next character typed.
772 \begin_layout Description
776 \begin_layout Subsection*
780 \begin_layout Description
781 Action Adds a perispomeni (Greek circumflex) over the next character typed.
784 \begin_layout Description
785 Syntax accent-perispomeni
788 \begin_layout Subsection*
792 \begin_layout Description
793 Action Adds a tie over the next two character typed.
796 \begin_layout Description
797 Notion The following char will finish the tie.
800 \begin_layout Description
804 \begin_layout Subsection*
808 \begin_layout Description
809 Action Adds a tilde over the next character typed.
812 \begin_layout Description
816 \begin_layout Subsection*
820 \begin_layout Description
821 Action Adds an umlaut over the next character typed.
824 \begin_layout Description
828 \begin_layout Subsection*
832 \begin_layout Description
833 Action Adds a bar under the next character typed.
836 \begin_layout Description
837 Syntax accent-underbar
840 \begin_layout Subsection*
844 \begin_layout Description
845 Action Adds a dot under the next character typed.
848 \begin_layout Description
849 Syntax accent-underdot
852 \begin_layout Subsection*
856 \begin_layout Description
857 Action Accepts all tracked changes in the document.
860 \begin_layout Description
861 Syntax all-changes-accept
864 \begin_layout Description
865 Origin Levon, 16 Oct 2002
868 \begin_layout Subsection*
872 \begin_layout Description
873 Action Rejects all tracked changes in the document.
876 \begin_layout Description
877 Notion Reject does not work recursively; the user may have to repeat the operation.
880 \begin_layout Description
881 Syntax all-changes-reject
884 \begin_layout Description
885 Origin Levon, 16 Oct 2002
888 \begin_layout Subsection*
892 \begin_layout Description
893 Action Start (or remove) Appendix on the given cursor position.
896 \begin_layout Description
900 \begin_layout Description
901 Origin ettrich, 5 May 1998
904 \begin_layout Subsection*
908 \begin_layout Description
909 Action Inserts an argument (short title) inset.
912 \begin_layout Description
913 Syntax argument-insert <argument nr>
916 \begin_layout Description
917 Params <argument nr>: see layout declarations
920 \begin_layout Description
921 Origin vermeer, 12 Aug 2002
924 \begin_layout Subsection*
928 \begin_layout Description
929 Action Adds database, which will be used for bibtex citations.
932 \begin_layout Description
933 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
936 \begin_layout Description
937 Syntax bibtex-database-add <DATABASE-NAME>
940 \begin_layout Description
941 Origin Ale, 30 May 1997
944 \begin_layout Subsection*
948 \begin_layout Description
949 Action Adds database, which will be used for bibtex citations.
952 \begin_layout Description
953 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
956 \begin_layout Description
957 Syntax bibtex-database-del <DATABASE-NAME>
960 \begin_layout Description
961 Origin Ale, 30 May 1997
964 \begin_layout Subsection*
968 \begin_layout Description
969 Action Clears the list of saved bookmarks.
972 \begin_layout Description
973 Syntax bookmark-clear
976 \begin_layout Description
977 Origin bpeng, 31 October 2006
980 \begin_layout Subsection*
984 \begin_layout Description
985 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
988 \begin_layout Description
989 Notion Bookmark 0 has a special purpose. It is automatically set
990 \begin_inset Newline newline
993 1. to the paragraph you are currently editing
994 \begin_inset Newline newline
997 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
998 \begin_inset Newline newline
1001 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1004 \begin_layout Description
1005 Syntax bookmark-goto <NUMBER>
1008 \begin_layout Description
1009 Params <NUMBER>: the number of the bookmark to restore.
1012 \begin_layout Description
1013 Origin Dekel, 27 January 2001
1016 \begin_layout Subsection*
1020 \begin_layout Description
1021 Action Save a bookmark.
1024 \begin_layout Description
1025 Notion Saves a numbered bookmark to the sessions file. The number must be between 1 and 9, inclusive. Note that bookmarks are saved per-session, not per file.
1028 \begin_layout Description
1029 Syntax bookmark-save <NUMBER>
1032 \begin_layout Description
1033 Params <NUMBER>: the number of the bookmark to save.
1036 \begin_layout Description
1037 Origin Dekel, 27 January 2001
1040 \begin_layout Subsection*
1044 \begin_layout Description
1045 Action Inserts Box inset.
1048 \begin_layout Description
1049 Syntax box-insert [<TYPE>]
1052 \begin_layout Description
1053 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1054 \begin_inset Newline newline
1057 Framed is the default one.
1060 \begin_layout Description
1061 Origin vermeer, 7 Oct 2003
1064 \begin_layout Subsection*
1068 \begin_layout Description
1069 Action Inserts branch inset.
1072 \begin_layout Description
1073 Syntax branch-insert <BRANCH-NAME>
1076 \begin_layout Description
1077 Origin vermeer, 17 Aug 2003
1080 \begin_layout Subsection*
1084 \begin_layout Description
1085 Action Move the cursor to the beginning of the document.
1088 \begin_layout Description
1092 \begin_layout Subsection*
1096 \begin_layout Description
1097 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1100 \begin_layout Description
1101 Syntax buffer-begin-select
1104 \begin_layout Subsection*
1108 \begin_layout Description
1109 Action Move the cursor to the end of the document.
1112 \begin_layout Description
1116 \begin_layout Subsection*
1120 \begin_layout Description
1121 Action Move the cursor to the end of the document adding the traversed text to the selection.
1124 \begin_layout Description
1125 Syntax buffer-end-select
1128 \begin_layout Subsection*
1132 \begin_layout Description
1133 Action Inserts a caption inset.
1136 \begin_layout Description
1137 Syntax caption-insert
1140 \begin_layout Description
1141 Origin Lgb, 18 Jul 2000
1144 \begin_layout Subsection*
1148 \begin_layout Description
1149 Action Moves the cursor to the previous cell inside the table.
1152 \begin_layout Description
1153 Syntax cell-backward
1156 \begin_layout Description
1157 Origin Jug, 22 May 2000
1160 \begin_layout Subsection*
1164 \begin_layout Description
1165 Action Moves the cursor to the next cell inside the table.
1168 \begin_layout Description
1172 \begin_layout Subsection*
1176 \begin_layout Description
1177 Action Splits cell and shifts right part to the next cell (inside the math grid).
1180 \begin_layout Description
1184 \begin_layout Description
1185 Origin Ale, 15 May 1997
1188 \begin_layout Subsection*
1192 \begin_layout Description
1193 Action Accepts tracked change inside the selection.
1196 \begin_layout Description
1197 Syntax change-accept
1200 \begin_layout Description
1201 Origin Levon, 16 Oct 2002
1204 \begin_layout Subsection*
1208 \begin_layout Description
1209 Action Moves the cursor to the position of the next change of the change tracking records.
1212 \begin_layout Description
1216 \begin_layout Description
1217 Origin schmitt, 4 Oct 2006
1220 \begin_layout Subsection*
1224 \begin_layout Description
1225 Action Moves the cursor to the position of the previous change of the change tracking records.
1228 \begin_layout Description
1229 Syntax change-previous
1232 \begin_layout Description
1233 Origin vfr, 4 Apr 2009
1236 \begin_layout Subsection*
1240 \begin_layout Description
1241 Action Rejects tracked change inside the selection.
1244 \begin_layout Description
1245 Syntax change-reject
1248 \begin_layout Description
1249 Origin Levon, 16 Oct 2002
1252 \begin_layout Subsection*
1256 \begin_layout Description
1257 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1260 \begin_layout Description
1261 Syntax changes-merge
1264 \begin_layout Description
1265 Origin Levon, 16 Oct 2002
1268 \begin_layout Subsection*
1272 \begin_layout Description
1273 Action Toggles showing of change tracking in typeset output.
1276 \begin_layout Description
1277 Syntax changes-output
1280 \begin_layout Description
1281 Origin jspitzm, 21 Jan 2005
1284 \begin_layout Subsection*
1288 \begin_layout Description
1289 Action Toggles change tracking to on/off.
1292 \begin_layout Description
1293 Syntax changes-track
1296 \begin_layout Description
1297 Origin levon, 1 Oct 2002
1300 \begin_layout Subsection*
1304 \begin_layout Description
1305 Action Moves the cursor one position logically backwards.
1308 \begin_layout Description
1309 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1312 \begin_layout Description
1313 Syntax char-backward
1316 \begin_layout Subsection*
1317 char-backward-select
1320 \begin_layout Description
1321 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1324 \begin_layout Description
1325 Notion See also LFUN_CHAR_BACKWARD.
1328 \begin_layout Description
1329 Syntax char-backward-select
1332 \begin_layout Subsection*
1333 char-delete-backward
1336 \begin_layout Description
1337 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1340 \begin_layout Description
1341 Syntax char-delete-backward [force]
1344 \begin_layout Description
1345 Params force: Delete big insets, do not only select them.
1348 \begin_layout Subsection*
1352 \begin_layout Description
1353 Action Deletes one character in the backward direction (usually the "Delete" key).
1356 \begin_layout Description
1357 Syntax char-delete-forward [force]
1360 \begin_layout Description
1361 Params force: Delete big insets, do not only select them.
1364 \begin_layout Subsection*
1368 \begin_layout Description
1369 Action Moves the cursor one position logically forward.
1372 \begin_layout Description
1373 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1376 \begin_layout Description
1380 \begin_layout Subsection*
1384 \begin_layout Description
1385 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1388 \begin_layout Description
1389 Notion See also LFUN_CHAR_FORWARD.
1392 \begin_layout Description
1393 Syntax char-forward-select
1396 \begin_layout Subsection*
1400 \begin_layout Description
1401 Action Moves the cursor one position "to the left".
1404 \begin_layout Description
1405 Notion This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
1408 \begin_layout Description
1412 \begin_layout Subsection*
1416 \begin_layout Description
1417 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1420 \begin_layout Description
1421 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1424 \begin_layout Description
1425 Syntax char-left-select
1428 \begin_layout Subsection*
1432 \begin_layout Description
1433 Action Moves the cursor one position "to the right".
1436 \begin_layout Description
1437 Notion This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
1440 \begin_layout Description
1444 \begin_layout Subsection*
1448 \begin_layout Description
1449 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1452 \begin_layout Description
1453 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1456 \begin_layout Description
1457 Syntax char-right-select
1460 \begin_layout Subsection*
1464 \begin_layout Description
1465 Action Transposes the character at the cursor with the one before it.
1468 \begin_layout Description
1469 Syntax chars-transpose
1472 \begin_layout Description
1473 Origin Lgb, 25 Apr 2001
1476 \begin_layout Subsection*
1480 \begin_layout Description
1481 Action Inserts citation from loaded citation database.
1484 \begin_layout Description
1485 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1488 \begin_layout Description
1489 Params <KEY>: Citation (shortcut listed in available citations).
1490 \begin_inset Newline newline
1493 <TEXT_BEFORE>: text which should appear before citation.
1496 \begin_layout Description
1497 Origin AAS, 97-02-23
1500 \begin_layout Subsection*
1504 \begin_layout Description
1505 Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text). Pastes plain text if plain text is on the clipboard, but tries to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1508 \begin_layout Description
1509 Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source is the clipboard, not the selection.
1512 \begin_layout Description
1513 Syntax clipboard-paste [<ARG>]
1516 \begin_layout Description
1517 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1520 \begin_layout Description
1521 Origin Georg, 10 Jul 2006
1524 \begin_layout Subsection*
1525 clipboard-paste-simple
1528 \begin_layout Description
1529 Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard. Pastes plain text if plain text is on the clipboard, without trying to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1532 \begin_layout Description
1533 Syntax clipboard-paste-simple [<ARG>]
1536 \begin_layout Description
1537 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1540 \begin_layout Subsection*
1544 \begin_layout Description
1545 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1548 \begin_layout Description
1549 Notion Usually bound to M-x shortcut.
1552 \begin_layout Description
1553 Syntax command-execute
1556 \begin_layout Subsection*
1560 \begin_layout Description
1561 Action Try to complete the word or command at the cursor position.
1564 \begin_layout Description
1568 \begin_layout Description
1569 Origin sts, Feb 19 2008
1572 \begin_layout Subsection*
1576 \begin_layout Description
1577 Action Accept suggested completion.
1580 \begin_layout Description
1581 Syntax completion-accept
1584 \begin_layout Description
1585 Origin sanda, Sep 08 2008
1588 \begin_layout Subsection*
1592 \begin_layout Description
1593 Action Try to cancel completion, either the popup or the inline completion.
1596 \begin_layout Description
1597 Syntax completion-cancel
1600 \begin_layout Description
1601 Origin sts, Sep 07 2008
1604 \begin_layout Subsection*
1608 \begin_layout Description
1609 Action Show the inline completion at the cursor position.
1612 \begin_layout Description
1613 Syntax completion-inline
1616 \begin_layout Description
1617 Origin sts, Feb 19 2008
1620 \begin_layout Subsection*
1624 \begin_layout Description
1625 Action Show the completion popup at the cursor position.
1628 \begin_layout Description
1629 Syntax completion-popup
1632 \begin_layout Description
1633 Origin sts, Feb 19 2008
1636 \begin_layout Subsection*
1640 \begin_layout Description
1641 Action Copies the current selection to the clipboard.
1644 \begin_layout Description
1648 \begin_layout Subsection*
1652 \begin_layout Description
1653 Action Cuts to the clipboard.
1656 \begin_layout Description
1660 \begin_layout Subsection*
1664 \begin_layout Description
1665 Action Inserts the current date.
1668 \begin_layout Description
1669 Syntax date-insert [<ARG>]
1672 \begin_layout Description
1673 Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
1676 \begin_layout Description
1677 Origin jdblair, 31 Jan 2000
1680 \begin_layout Subsection*
1684 \begin_layout Description
1685 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1688 \begin_layout Description
1689 Syntax depth-decrement
1692 \begin_layout Subsection*
1696 \begin_layout Description
1697 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1700 \begin_layout Description
1701 Syntax depth-increment
1704 \begin_layout Subsection*
1705 dialog-disconnect-inset
1708 \begin_layout Description
1709 Action Closes opened connection to opened inset.
1712 \begin_layout Description
1713 Notion Connection is used for apply functions.
1716 \begin_layout Description
1717 Syntax dialog-disconnect-inset <INSET-NAME>
1720 \begin_layout Description
1721 Origin leeming, 25 Feb 2003
1724 \begin_layout Subsection*
1728 \begin_layout Description
1729 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1732 \begin_layout Description
1733 Syntax dialog-hide <NAME>
1736 \begin_layout Description
1737 Params See LFUN_DIALOG_SHOW .
1740 \begin_layout Description
1741 Origin leeming, 25 Feb 2003
1744 \begin_layout Subsection*
1748 \begin_layout Description
1749 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1752 \begin_layout Description
1753 Syntax dialog-show <NAME> [<DATA>]
1756 \begin_layout Description
1757 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1758 \begin_inset Newline newline
1761 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1762 \begin_inset Newline newline
1765 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1766 \begin_inset Newline newline
1769 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1770 \begin_inset Newline newline
1773 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1774 \begin_inset Newline newline
1777 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1778 \begin_inset Newline newline
1781 <SPECIAL>: latexlog|vclog
1782 \begin_inset Newline newline
1785 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1788 \begin_layout Description
1789 Origin leeming, 17 Jun 2003
1792 \begin_layout Subsection*
1793 dialog-show-new-inset
1796 \begin_layout Description
1797 Action Shows hidden dialog or create new one for a given inset settings etc.
1800 \begin_layout Description
1801 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1804 \begin_layout Description
1805 Syntax dialog-show-new-inset <NAME> [<DATA>]
1808 \begin_layout Description
1809 Params See LFUN_DIALOG_SHOW .
1812 \begin_layout Description
1813 Origin leeming, 25 Feb 2003
1816 \begin_layout Subsection*
1820 \begin_layout Description
1821 Action Toggles dialog between showed/hidden state.
1824 \begin_layout Description
1825 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1828 \begin_layout Description
1829 Syntax dialog-toggle <NAME> [<DATA>]
1832 \begin_layout Description
1833 Params See LFUN_DIALOG_SHOW .
1836 \begin_layout Description
1837 Origin JSpitzm, 30 Apr 2007
1840 \begin_layout Subsection*
1844 \begin_layout Description
1845 Action Updates the dialog values from the inset/paragraph/document.
1848 \begin_layout Description
1849 Syntax dialog-update <NAME>
1852 \begin_layout Description
1853 Params <NAME>: paragraph|prefs|<INSET>
1854 \begin_inset Newline newline
1860 \begin_layout Description
1861 Origin leeming, 25 Feb 2003
1864 \begin_layout Subsection*
1868 \begin_layout Description
1869 Action Moves the cursor one line in downward direction.
1872 \begin_layout Description
1876 \begin_layout Subsection*
1880 \begin_layout Description
1881 Action Moves the cursor one line in downward direction adding the current position to the selection.
1884 \begin_layout Description
1888 \begin_layout Subsection*
1892 \begin_layout Description
1893 Action Inserts an ERT inset.
1896 \begin_layout Description
1900 \begin_layout Description
1901 Origin Jug, 18 Feb 2000
1904 \begin_layout Subsection*
1908 \begin_layout Description
1909 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1912 \begin_layout Description
1916 \begin_layout Description
1917 Origin Lgb, 17 May 2001
1920 \begin_layout Subsection*
1924 \begin_layout Description
1925 Action Inserts another LyX file.
1928 \begin_layout Description
1929 Syntax file-insert [<FILE>]
1932 \begin_layout Description
1933 Params <FILE>: Filename to be inserted.
1936 \begin_layout Subsection*
1937 file-insert-plaintext
1940 \begin_layout Description
1941 Action Inserts plain text file.
1944 \begin_layout Description
1945 Syntax file-insert-plaintext [<FILE>]
1948 \begin_layout Description
1949 Params <FILE>: Filename to be inserted.
1952 \begin_layout Description
1953 Origin CFO-G, 19 Nov 1997
1956 \begin_layout Subsection*
1957 file-insert-plaintext-para
1960 \begin_layout Description
1961 Action Inserts plain text file as paragraph (i.e. join lines).
1964 \begin_layout Description
1965 Syntax file-insert-plaintext-para [<FILE>]
1968 \begin_layout Description
1969 Params <FILE>: Filename to be inserted.
1972 \begin_layout Description
1973 Origin Levon, 14 Feb 2001
1976 \begin_layout Subsection*
1980 \begin_layout Description
1981 Action Inserts CharStyle, Custom inset or XML short element.
1984 \begin_layout Description
1985 Notion Look into the Customization manual for more information about these elements.
1986 \begin_inset Newline newline
1989 To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself.
1990 \begin_inset Newline newline
1993 For dissolving the element see LFUN_INSET_DISSOLVE.
1996 \begin_layout Description
1997 Syntax flex-insert Name
2000 \begin_layout Description
2001 Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout <Flex:Name>. The Flex: prefix is optional.
2004 \begin_layout Description
2005 Sample flex-insert Code
2008 \begin_layout Subsection*
2012 \begin_layout Description
2013 Action Inserts a float inset.
2016 \begin_layout Description
2017 Syntax float-insert <TYPE>
2020 \begin_layout Description
2021 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2024 \begin_layout Description
2025 Origin Lgb, 27 Jun 2000
2028 \begin_layout Subsection*
2032 \begin_layout Description
2033 Action Inserts the list of floats in the document.
2036 \begin_layout Description
2037 Syntax float-list-insert <TYPE>
2040 \begin_layout Description
2041 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2044 \begin_layout Description
2045 Origin Lgb, 3 May 2001
2048 \begin_layout Subsection*
2052 \begin_layout Description
2053 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2056 \begin_layout Description
2057 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2060 \begin_layout Description
2061 Syntax float-wide-insert <TYPE>
2064 \begin_layout Description
2065 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2068 \begin_layout Description
2069 Origin Lgb, 31 Oct 2001
2072 \begin_layout Subsection*
2076 \begin_layout Description
2077 Action Inserts a footnote inset.
2080 \begin_layout Description
2081 Syntax footnote-insert
2084 \begin_layout Description
2085 Origin Jug, 7 Mar 2000
2088 \begin_layout Subsection*
2092 \begin_layout Description
2093 Action Reloads the image if necessary.
2096 \begin_layout Description
2097 Syntax graphics-reload
2100 \begin_layout Description
2101 Origin vfr, 10 Aug 2009
2104 \begin_layout Subsection*
2108 \begin_layout Description
2109 Action Inserts hyperlinks into the document (clickable in pdf output).
2112 \begin_layout Description
2113 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2116 \begin_layout Description
2117 Syntax href-insert [<TARGET>]
2120 \begin_layout Description
2121 Origin CFO-G, 21 Nov 1997
2124 \begin_layout Subsection*
2128 \begin_layout Description
2129 Action Only active in IPA inset.
2132 \begin_layout Description
2133 Notion Dummy function which is only active in a IPA inset. It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2136 \begin_layout Description
2140 \begin_layout Description
2141 Origin spitz, 20 May 2012
2144 \begin_layout Subsection*
2148 \begin_layout Description
2149 Action Inserts Index entry.
2152 \begin_layout Description
2153 Notion It automatically takes the word on the cursor position.
2156 \begin_layout Description
2157 Syntax index-insert [<TYPE:Name>]
2160 \begin_layout Description
2161 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2164 \begin_layout Description
2165 Origin leeming, 3 Aug 2000
2168 \begin_layout Subsection*
2172 \begin_layout Description
2173 Action Inserts list of Index entries on a new page.
2176 \begin_layout Description
2177 Syntax index-print [<TYPE:Name>]
2180 \begin_layout Description
2181 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2184 \begin_layout Description
2185 Origin Lgb, 27 Feb 1997
2188 \begin_layout Subsection*
2192 \begin_layout Description
2193 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2196 \begin_layout Description
2197 Notion Apart from lfun arguments you can use the following method:
2198 \begin_inset Newline newline
2201 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2202 \begin_inset Newline newline
2205 2. select the text and run info-insert lfun.
2208 \begin_layout Description
2209 Syntax info-insert <TYPE> <ARG>
2212 \begin_layout Description
2213 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
2214 \begin_inset Newline newline
2217 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2218 \begin_inset Newline newline
2221 shortcut[s]: name of lfun (e.g math-insert
2224 \begin_inset Newline newline
2227 lyxrc: name of rc_entry (e.g. bind_file)
2228 \begin_inset Newline newline
2231 lyxinfo: "version" - used version of LyX
2232 \begin_inset Newline newline
2235 package: name of latex package (e.g. listings)
2236 \begin_inset Newline newline
2239 textclass: name of textclass (e.g. article)
2240 \begin_inset Newline newline
2243 menu: name of lfun used in menu
2244 \begin_inset Newline newline
2247 icon: icon of lfun used in toolbar or direct icon name
2248 \begin_inset Newline newline
2251 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
2254 \begin_layout Description
2255 Sample command-sequence info-insert buffer path; info-insert buffer name
2258 \begin_layout Description
2259 Origin bpeng, 7 Oct 2007
2262 \begin_layout Subsection*
2266 \begin_layout Description
2267 Action Apply data for an inset.
2270 \begin_layout Description
2271 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied. This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called.
2274 \begin_layout Description
2275 Syntax inset-apply <ARGS>
2278 \begin_layout Description
2279 Params See LFUN_INSET_INSERT .
2282 \begin_layout Subsection*
2286 \begin_layout Description
2287 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise
2290 \begin_layout Description
2294 \begin_layout Description
2295 Origin lasgouttes, 16 Mar 2009
2298 \begin_layout Subsection*
2302 \begin_layout Description
2303 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection).
2306 \begin_layout Description
2307 Syntax inset-begin-select
2310 \begin_layout Description
2311 Origin lasgouttes, 16 Mar 2009
2314 \begin_layout Subsection*
2318 \begin_layout Description
2319 Action Copies the inset to the clipboard as a certain type.
2322 \begin_layout Description
2323 Notion Currently used only for InsetInfo where its content is copied as a text.
2326 \begin_layout Description
2327 Syntax inset-copy-as
2330 \begin_layout Description
2331 Origin vfr, 18 Apr 2010
2334 \begin_layout Subsection*
2338 \begin_layout Description
2339 Action Dissolve the current inset into text.
2342 \begin_layout Description
2343 Syntax inset-dissolve [<INSET>]
2346 \begin_layout Description
2347 Params <INSET>: this can be used to make sure the right kind of inset is dissolved. For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type.
2348 \begin_inset Newline newline
2351 For values see lyx::InsetLayout::lyxtype_ .
2354 \begin_layout Description
2355 Origin JSpitz, 7 Aug 2006
2358 \begin_layout Subsection*
2362 \begin_layout Description
2363 Action Edit the inset at cursor with an external application, if one is attributed.
2366 \begin_layout Description
2367 Syntax inset-edit [<INSET_PARAMS>]
2370 \begin_layout Description
2371 Params <INSET_PARAMS>: Parameters for the inset.
2372 \begin_inset Newline newline
2375 Currently only the filename will be considered.
2378 \begin_layout Description
2379 Origin JSpitzm, 27 Apr 2006
2382 \begin_layout Subsection*
2386 \begin_layout Description
2387 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise
2390 \begin_layout Description
2394 \begin_layout Description
2395 Origin lasgouttes, 16 Mar 2009
2398 \begin_layout Subsection*
2402 \begin_layout Description
2403 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection).
2406 \begin_layout Description
2407 Syntax inset-end-select
2410 \begin_layout Description
2411 Origin lasgouttes, 16 Mar 2009
2414 \begin_layout Subsection*
2418 \begin_layout Description
2419 Action Apply the given commands on insets of a given name.
2422 \begin_layout Description
2423 Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 100000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed.
2426 \begin_layout Description
2427 Syntax inset-forall <NAME> <LFUN-COMMAND>
2428 \begin_inset Newline newline
2431 <NAME>: Type of Inset. If <NAME> is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets.
2434 \begin_layout Description
2435 Sample Remove all index insets:
2436 \begin_inset Newline newline
2439 inset-forall Index char-delete-forward force
2440 \begin_inset Newline newline
2443 Close all Notes (also works for a particular branch, for example):
2444 \begin_inset Newline newline
2447 inset-forall Note inset-toggle close
2448 \begin_inset Newline newline
2451 Transform all yellow notes to comments
2452 \begin_inset Newline newline
2455 inset-forall Note:Note inset-modify note Note Comment
2456 \begin_inset Newline newline
2459 Try to put LyX in an infinite loop if there is at least a Note:
2460 \begin_inset Newline newline
2463 inset-forall Note char-backward
2466 \begin_layout Description
2467 Origin lasgouttes, 27 Nov 2009
2470 \begin_layout Subsection*
2474 \begin_layout Description
2475 Action Insert new inset (type given by the parameters).
2478 \begin_layout Description
2479 Syntax inset-insert <INSET> <ARGS>
2482 \begin_layout Description
2483 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2484 \begin_inset Newline newline
2487 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2488 \begin_inset Newline newline
2491 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2494 \begin_layout Description
2495 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2498 \begin_inset Newline newline
2501 where <label name> is the name of the referenced label and <Format> is one of the following:
2502 \begin_inset Newline newline
2506 \begin_inset Newline newline
2509 eqref -- (<reference>)
2510 \begin_inset Newline newline
2514 \begin_inset Newline newline
2517 vpageref -- on <page>
2518 \begin_inset Newline newline
2521 vref -- <reference> on <page>
2522 \begin_inset Newline newline
2525 formatted -- Formatted reference
2528 \begin_layout Subsection*
2532 \begin_layout Description
2533 Action Modify some properties of an inset.
2536 \begin_layout Description
2537 Notion Used for argument, bibitem, bibtex, box, branch, caption, citation, command, ert, external, float, graphics, include, index, info, label, line, listings, newline, newpage, nomencl, note, phantom, quotes, ref, script, separator, space, tabular, vspace and wrap insets.
2540 \begin_layout Description
2541 Syntax inset-modify <INSET> <ARGS>
2542 \begin_inset Newline newline
2545 inset-modify changetype <TYPE>
2548 \begin_layout Description
2549 Sample Change a Note inset into a Comment inset:
2550 \begin_inset Newline newline
2553 inset-modify note Note Comment
2554 \begin_inset Newline newline
2557 Change a Box into an Ovalbox:
2558 \begin_inset Newline newline
2561 inset-modify changetype Ovalbox
2562 \begin_inset Newline newline
2565 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
2566 \begin_inset Newline newline
2569 inset-modify changetype els
2570 \begin_inset Newline newline
2573 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
2574 \begin_inset Newline newline
2577 inset-modify changetype e..
2578 \begin_inset Newline newline
2584 \begin_layout Subsection*
2588 \begin_layout Description
2589 Action Select all contents of an inset.
2592 \begin_layout Description
2593 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2596 \begin_layout Description
2597 Syntax inset-select-all
2600 \begin_layout Description
2601 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2604 \begin_layout Subsection*
2608 \begin_layout Description
2609 Action Open the inset's properties dialog.
2612 \begin_layout Description
2613 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, line, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2616 \begin_layout Description
2617 Syntax inset-settings <INSET>
2620 \begin_layout Description
2621 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2622 \begin_inset Newline newline
2625 graphics|href|include|index|index_print|label|line|
2626 \begin_inset Newline newline
2629 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2632 \begin_layout Subsection*
2636 \begin_layout Description
2637 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2640 \begin_layout Description
2641 Syntax inset-toggle [<ARG>]
2644 \begin_layout Description
2645 Params <ARG>: <open|close|toggle|assign>.
2646 \begin_inset Newline newline
2649 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2650 \begin_inset Newline newline
2653 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2656 \begin_layout Description
2657 Origin lasgouttes, 19 Jul 2001
2660 \begin_layout Subsection*
2664 \begin_layout Description
2665 Action Inserts an IPA inset.
2668 \begin_layout Description
2672 \begin_layout Description
2673 Origin spitz, 05 Mar 2012
2676 \begin_layout Subsection*
2680 \begin_layout Description
2681 Action Inserts special IPA macros into the document.
2684 \begin_layout Description
2685 Syntax ipamacro-insert <CHAR>
2688 \begin_layout Description
2689 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2692 \begin_layout Description
2693 Origin JSpitzm, 22 Aug 2012
2696 \begin_layout Subsection*
2700 \begin_layout Description
2701 Action Turn off the loaded keyboard map.
2704 \begin_layout Description
2708 \begin_layout Subsection*
2712 \begin_layout Description
2713 Action Turn on the primary keyboard map.
2716 \begin_layout Description
2717 Notion Maps were widely used in past, when X-windows didn't have nowadays keyboard support. They can be still used to maintain uniform keyboard layout across the various platforms.
2718 \begin_inset Newline newline
2721 The language is to be set in the Preferences dialog.
2724 \begin_layout Description
2725 Syntax keymap-primary
2728 \begin_layout Subsection*
2732 \begin_layout Description
2733 Action Turn on the secondary keyboard map.
2736 \begin_layout Description
2737 Syntax keymap-secondary
2740 \begin_layout Subsection*
2744 \begin_layout Description
2745 Action Toggles keyboard maps (first/second/off).
2748 \begin_layout Description
2749 Syntax keymap-toggle
2752 \begin_layout Description
2753 Origin leeming, 30 Mar 2004
2756 \begin_layout Subsection*
2757 label-copy-as-reference
2760 \begin_layout Description
2761 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2764 \begin_layout Description
2765 Syntax copy-label-as-reference <LABEL>
2768 \begin_layout Description
2769 Params <LABEL>: The label to copy (for multi-line math)
2772 \begin_layout Description
2773 Origin sts, 16 Nov 2008
2776 \begin_layout Subsection*
2780 \begin_layout Description
2781 Action Goto a label.
2784 \begin_layout Description
2785 Syntax label-goto [<LABEL>]
2788 \begin_layout Description
2789 Params <LABEL>: Requested label. If no label is given and reference is on cursor position, Bookmark 0 is saved and cursor moves to the position of referenced label.
2792 \begin_layout Description
2793 Origin Ale, 6 Aug 1997
2796 \begin_layout Subsection*
2800 \begin_layout Description
2801 Action Inserts label to text or displayed formula.
2804 \begin_layout Description
2805 Syntax label-insert [<LABEL>]
2808 \begin_layout Description
2809 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2812 \begin_layout Subsection*
2813 label-insert-as-reference
2816 \begin_layout Description
2817 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2820 \begin_layout Description
2821 Syntax label-insert-as-reference
2824 \begin_layout Description
2825 Origin vfr, 7 Apr 2009
2828 \begin_layout Subsection*
2832 \begin_layout Description
2833 Action Set language from the current cursor position.
2836 \begin_layout Description
2837 Syntax language <LANG> [set]
2840 \begin_layout Description
2841 Params <LANG>: Requested language. Look in lib/languages for the list. "language reset" or "language" (without param) reset to the document language. set: If used, the language will be set to the specified language. Otherwise, the language will be toggled (i.e., if the current language is LANG, switch to the document language or the default language, if LANG is the document language).
2844 \begin_layout Description
2845 Origin Dekel, 2 Mar 2000
2848 \begin_layout Subsection*
2852 \begin_layout Description
2853 Action Move the cursor to the beginning of the (screen) line.
2856 \begin_layout Description
2860 \begin_layout Subsection*
2864 \begin_layout Description
2865 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2868 \begin_layout Description
2869 Syntax line-begin-select
2872 \begin_layout Subsection*
2876 \begin_layout Description
2877 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2880 \begin_layout Description
2881 Syntax line-delete-forward
2884 \begin_layout Subsection*
2888 \begin_layout Description
2889 Action Move the cursor to the end of the (screen) line.
2892 \begin_layout Description
2896 \begin_layout Subsection*
2900 \begin_layout Description
2901 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2904 \begin_layout Description
2905 Syntax line-end-select
2908 \begin_layout Subsection*
2912 \begin_layout Description
2913 Action Inserts a new listings inset.
2916 \begin_layout Description
2917 Syntax listing-insert
2920 \begin_layout Description
2921 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2924 \begin_layout Subsection*
2928 \begin_layout Description
2929 Action Inserts a marginal note.
2932 \begin_layout Description
2933 Syntax marginalnote-insert
2936 \begin_layout Description
2937 Origin Lgb, 26 Jun 2000
2940 \begin_layout Subsection*
2944 \begin_layout Description
2945 Action Disable selecting of text-region.
2948 \begin_layout Description
2952 \begin_layout Subsection*
2956 \begin_layout Description
2957 Action Enable selecting of text-region.
2960 \begin_layout Description
2961 Notion After enabling you can simply move arrow keys to get selected region.
2964 \begin_layout Description
2968 \begin_layout Subsection*
2972 \begin_layout Description
2973 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2976 \begin_layout Description
2980 \begin_layout Description
2981 Origin Andre, May 5 2006
2984 \begin_layout Subsection*
2988 \begin_layout Description
2989 Action Inserts a line break or new line.
2992 \begin_layout Description
2993 Syntax newline-insert [<ARG>]
2996 \begin_layout Description
2997 Params <ARG>: <newline|linebreak> default: newline
3000 \begin_layout Description
3001 Origin JSpitzm, 25 Mar 2008
3004 \begin_layout Subsection*
3008 \begin_layout Description
3009 Action Inserts a new page.
3012 \begin_layout Description
3013 Syntax newpage-insert <ARG>
3016 \begin_layout Description
3017 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3020 \begin_layout Description
3021 Origin uwestoehr, 24 Nov 2007
3024 \begin_layout Subsection*
3028 \begin_layout Description
3029 Action Inserts Nomenclature entry.
3032 \begin_layout Description
3033 Notion It automatically takes the word on the cursor position if no symbol is given.
3036 \begin_layout Description
3037 Syntax nomencl-insert [<SYMBOL>]
3040 \begin_layout Description
3041 Origin Ugras, 4 Nov 2006
3044 \begin_layout Subsection*
3048 \begin_layout Description
3049 Action Inserts list of Nomenclature entries.
3052 \begin_layout Description
3053 Syntax nomenclature-print
3056 \begin_layout Description
3057 Origin Ugras, 4 Nov 2006
3060 \begin_layout Subsection*
3064 \begin_layout Description
3065 Action Inserts Note on the current cursor position, move selection inside the inset.
3068 \begin_layout Description
3069 Syntax note-insert [<TYPE>]
3072 \begin_layout Description
3073 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3076 \begin_layout Subsection*
3080 \begin_layout Description
3081 Action Moves the cursor to the beginning of next Note inset.
3084 \begin_layout Description
3088 \begin_layout Subsection*
3092 \begin_layout Description
3093 Action Move the current group in the downward direction in the structure of the document.
3096 \begin_layout Description
3097 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3100 \begin_layout Description
3104 \begin_layout Description
3105 Origin Vermeer, 23 Mar 2006
3108 \begin_layout Subsection*
3112 \begin_layout Description
3113 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3116 \begin_layout Description
3117 Notion Part -> Chapter -> Section -> etc.
3120 \begin_layout Description
3124 \begin_layout Description
3125 Origin Vermeer, 23 Mar 2006
3128 \begin_layout Subsection*
3132 \begin_layout Description
3133 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3136 \begin_layout Description
3137 Notion Part <- Chapter <- Section <- etc.
3140 \begin_layout Description
3144 \begin_layout Description
3145 Origin Vermeer, 23 Mar 2006
3148 \begin_layout Subsection*
3152 \begin_layout Description
3153 Action Move the current group in the upward direction in the structure of the document.
3156 \begin_layout Description
3157 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3160 \begin_layout Description
3164 \begin_layout Description
3165 Origin Vermeer, 23 Mar 2006
3168 \begin_layout Subsection*
3172 \begin_layout Description
3173 Action Breaks the current paragraph at the current location.
3176 \begin_layout Description
3177 Notion Removes the selection.
3180 \begin_layout Description
3181 Syntax paragraph-break [<LAYOUT>]
3184 \begin_layout Description
3185 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3188 \begin_layout Subsection*
3192 \begin_layout Description
3193 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3196 \begin_layout Description
3197 Syntax paragraph-down
3200 \begin_layout Description
3201 Origin Asger, 1 Oct 1996
3204 \begin_layout Subsection*
3205 paragraph-down-select
3208 \begin_layout Description
3209 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3212 \begin_layout Description
3213 Syntax paragraph-down-select
3216 \begin_layout Description
3217 Origin Asger, 1 Oct 1996
3220 \begin_layout Subsection*
3224 \begin_layout Description
3225 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph. If given four arguments id_start, pos_start, id_end, pos_end, perform a selection from start to end.
3228 \begin_layout Description
3229 Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen. Moreover the id is unique for all opened buffers (documents). Both ids must belong to the same buffer.
3232 \begin_layout Description
3233 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3236 \begin_layout Description
3237 Params <PAR_ID>: paragraph id
3238 \begin_inset Newline newline
3241 <POS_IN_PAR>: desired position within the paragraph
3244 \begin_layout Description
3245 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3248 \begin_layout Subsection*
3252 \begin_layout Description
3253 Action Moves the current paragraph downwards in the document.
3256 \begin_layout Description
3257 Syntax paragraph-move-down
3260 \begin_layout Description
3261 Origin Edwin, 8 Apr 2006
3264 \begin_layout Subsection*
3268 \begin_layout Description
3269 Action Moves the current paragraph upwards in the document.
3272 \begin_layout Description
3273 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3276 \begin_layout Description
3277 Syntax paragraph-move-up
3280 \begin_layout Description
3281 Origin Edwin, 8 Apr 2006
3284 \begin_layout Subsection*
3288 \begin_layout Description
3289 Action Change paragraph settings.
3292 \begin_layout Description
3293 Notion Modifies the current paragraph, or currently selected paragraphs. This function only modifies, and does not override, existing settings. Note that the "leftindent" indent setting is deprecated.
3296 \begin_layout Description
3297 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3300 \begin_layout Description
3310 \begin_inset Newline newline
3315 paragraph_spacing default|single|onehalf|double|other SIZE
3316 \begin_inset Newline newline
3321 align block|left|right|center|default
3322 \begin_inset Newline newline
3327 labelwidthstring WIDTH|
3332 \begin_layout Description
3333 Origin rgh, Aug 15 2007
3336 \begin_layout Subsection*
3337 paragraph-params-apply
3340 \begin_layout Description
3341 Action Change paragraph settings.
3344 \begin_layout Description
3345 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3348 \begin_layout Description
3349 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3352 \begin_layout Description
3353 Params For parameters see LFUN_PARAGRAPH_PARAMS
3356 \begin_layout Description
3357 Origin leeming, 30 Mar 2004
3360 \begin_layout Subsection*
3364 \begin_layout Description
3365 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3368 \begin_layout Description
3372 \begin_layout Description
3373 Origin Asger, 1 Oct 1996
3376 \begin_layout Subsection*
3380 \begin_layout Description
3381 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3384 \begin_layout Description
3385 Syntax paragraph-up-select
3388 \begin_layout Description
3389 Origin Asger, 1 Oct 1996
3392 \begin_layout Subsection*
3396 \begin_layout Description
3397 Action Pastes material (text or picture) from the active clipboard.
3400 \begin_layout Description
3401 Syntax paste [<TYPE>|<NUM>]
3404 \begin_layout Description
3405 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3406 \begin_inset Newline newline
3409 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3412 \begin_layout Subsection*
3416 \begin_layout Description
3417 Action Inserts phantom on the current cursor position, move selection inside the inset.
3420 \begin_layout Description
3421 Syntax phantom-insert [<TYPE>]
3424 \begin_layout Description
3425 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3428 \begin_layout Description
3429 Origin uwestoehr, 30 Jan 2009
3432 \begin_layout Subsection*
3436 \begin_layout Description
3437 Action Inserts a new preview inset.
3440 \begin_layout Description
3441 Syntax preview-insert
3444 \begin_layout Description
3445 Origin vfr, 28 Mar 2010
3448 \begin_layout Subsection*
3449 primary-selection-paste
3452 \begin_layout Description
3453 Action Pastes the currently selected text.
3456 \begin_layout Description
3457 Notion Primary selection mechanism is linux-only thing.
3460 \begin_layout Description
3461 Syntax primary-selection-paste [<ARG>]
3464 \begin_layout Description
3465 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3468 \begin_layout Subsection*
3472 \begin_layout Description
3473 Action Inserts quotes according to the type and quote-language preference.
3476 \begin_layout Description
3477 Notion Currently 15 different quote styles are distinguished (see params).
3480 \begin_layout Description
3481 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3484 \begin_layout Description
3485 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
3486 \begin_inset Newline newline
3489 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
3490 \begin_inset Newline newline
3493 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3494 \begin_inset Newline newline
3497 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3498 \begin_inset Newline newline
3501 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3502 \begin_inset Newline newline
3505 'danish' for >>Danish<< quote style (with >inner quotation<)
3506 \begin_inset Newline newline
3509 'english' for ``English'' quote style (with `inner quotation')
3510 \begin_inset Newline newline
3513 'french' for <<french>> quote style (with ``inner quotation'')
3514 \begin_inset Newline newline
3517 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
3518 \begin_inset Newline newline
3521 'german' for ,,German`` quote style (with ,inner quotation`)
3522 \begin_inset Newline newline
3525 'plain' for "Plain" quote style (with 'inner quotation')
3526 \begin_inset Newline newline
3529 'polish' for ,,Polish'' quote style (with ,inner quotation')
3530 \begin_inset Newline newline
3533 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3534 \begin_inset Newline newline
3537 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
3538 \begin_inset Newline newline
3541 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3542 \begin_inset Newline newline
3545 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3546 \begin_inset Newline newline
3549 'dynamic' for Dynamic quotation marks which inherit the global document style
3550 \begin_inset Newline newline
3553 If no quote style is specified, the document-wide will be used.
3556 \begin_layout Subsection*
3560 \begin_layout Description
3561 Action Redoes the last thing undone.
3564 \begin_layout Description
3568 \begin_layout Subsection*
3572 \begin_layout Description
3573 Action Go to the next label or cross-reference.
3576 \begin_layout Description
3577 Syntax reference-next
3580 \begin_layout Description
3581 Origin Dekel, 14 Jan 2001
3584 \begin_layout Subsection*
3588 \begin_layout Description
3589 Action Repeat the given command.
3592 \begin_layout Description
3593 Notion fails when the repeat count is greater than 10000.
3596 \begin_layout Description
3597 Syntax repeat <COUNT> <LFUN-COMMAND>
3600 \begin_layout Description
3601 Origin Andre, 27 Oct 2003
3604 \begin_layout Subsection*
3608 \begin_layout Description
3609 Action Moves the cursor one page in downward direction.
3612 \begin_layout Description
3616 \begin_layout Subsection*
3620 \begin_layout Description
3621 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3624 \begin_layout Description
3625 Syntax screen-down-select
3628 \begin_layout Subsection*
3632 \begin_layout Description
3633 Action Recenters the screen on the current cursor position.
3636 \begin_layout Description
3637 Syntax screen-recenter
3640 \begin_layout Subsection*
3644 \begin_layout Description
3645 Action Repositions the screen such that the cursor is visible.
3648 \begin_layout Description
3649 Syntax screen-show-cursor
3652 \begin_layout Description
3653 Origin vfr, 25 Mar 2009
3656 \begin_layout Subsection*
3660 \begin_layout Description
3661 Action Moves the cursor one page in upward direction.
3664 \begin_layout Description
3668 \begin_layout Subsection*
3672 \begin_layout Description
3673 Action Moves the cursor one page in upward direction adding the current position to the selection.
3676 \begin_layout Description
3677 Syntax screen-up-select
3680 \begin_layout Subsection*
3684 \begin_layout Description
3685 Action Inserts a subscript or superscript inset.
3688 \begin_layout Description
3689 Syntax script-insert <TYPE>
3692 \begin_layout Description
3693 Params <TYPE>: subscript|superscript
3696 \begin_layout Description
3697 Origin Georg, 23 Nov 2010
3700 \begin_layout Subsection*
3704 \begin_layout Description
3705 Action Scroll the buffer view.
3708 \begin_layout Description
3709 Notion Only scrolls the screen up or down; does not move the cursor.
3712 \begin_layout Description
3713 Syntax scroll <TYPE> <QUANTITY>
3716 \begin_layout Description
3717 Params <TYPE>: line|page
3718 \begin_inset Newline newline
3721 <QUANTITY>: up|down|<number>
3724 \begin_layout Description
3725 Origin Abdel, Dec 27 2007
3728 \begin_layout Subsection*
3732 \begin_layout Description
3733 Action Select the whole section.
3736 \begin_layout Description
3737 Notion The cursor should be in a section heading before calling this lfun.
3740 \begin_layout Description
3741 Syntax section-select
3744 \begin_layout Description
3745 Origin vfr, 05 May 2009
3748 \begin_layout Subsection*
3752 \begin_layout Description
3753 Action Pastes the internal selection text in permanent selection.
3756 \begin_layout Description
3757 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3760 \begin_layout Description
3761 Syntax selection-paste
3764 \begin_layout Description
3765 Origin lasgouttes, 14 Jan 2009
3768 \begin_layout Subsection*
3772 \begin_layout Description
3773 Action Inserts an environment separator or latex paragraph break.
3776 \begin_layout Description
3777 Syntax separator-insert [<ARG>]
3780 \begin_layout Description
3781 Params <ARG>: <plain|parbreak|latexpar> default: plain
3784 \begin_layout Description
3785 Origin ef, 2 May 2014
3788 \begin_layout Subsection*
3792 \begin_layout Description
3793 Action Set the group for the graphics inset on the cursor position.
3796 \begin_layout Description
3797 Syntax set-graphics-group [<GROUP>]
3800 \begin_layout Description
3801 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3804 \begin_layout Description
3805 Origin sanda, 6 May 2008
3808 \begin_layout Subsection*
3812 \begin_layout Description
3813 Action Inserts one of horizontal space insets.
3816 \begin_layout Description
3817 Syntax space-insert <NAME> [<LEN>]
3820 \begin_layout Description
3821 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3822 \begin_inset Newline newline
3825 Only in math mode: med and thick.
3826 \begin_inset Newline newline
3829 <LEN>: length for custom spaces (hspace, hspace* for protected)
3832 \begin_layout Description
3833 Origin JSpitzm, 20 May 2003, Mar 17 2008
3836 \begin_layout Subsection*
3840 \begin_layout Description
3841 Action Inserts various characters into the document.
3844 \begin_layout Description
3845 Syntax specialchar-insert <CHAR>
3848 \begin_layout Description
3849 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3852 \begin_layout Description
3853 Origin JSpitzm, 6 Dec 2007
3856 \begin_layout Subsection*
3860 \begin_layout Description
3861 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3864 \begin_layout Description
3865 Syntax spelling-add [<STRING>] [<LANG>]
3868 \begin_layout Description
3869 Params <WORD>: word to add <LANG>: language name (see file languages)
3872 \begin_layout Description
3873 Origin JSpitzm, 18 Jan 2010
3876 \begin_layout Subsection*
3877 spelling-continuously
3880 \begin_layout Description
3881 Action Toggle continuous spell checking.
3884 \begin_layout Description
3885 Syntax spelling-continuously
3888 \begin_layout Description
3889 Origin vfr, 24 March 2013
3892 \begin_layout Subsection*
3896 \begin_layout Description
3897 Action Let the spell checker ignore the word under the cursor in the current session for the given language. The default for the language is retrieved from the cursor position.
3900 \begin_layout Description
3901 Syntax spelling-ignore [<WORD>] [<LANG>]
3904 \begin_layout Description
3905 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3908 \begin_layout Description
3909 Origin JSpitzm, 18 Jan 2010
3912 \begin_layout Subsection*
3916 \begin_layout Description
3917 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3920 \begin_layout Description
3921 Syntax spelling-remove [<STRING>] [<LANG>]
3924 \begin_layout Description
3925 Params <WORD>: word to remove <LANG>: language name (see file languages)
3928 \begin_layout Description
3929 Origin SWitt, 28 July 2010
3932 \begin_layout Subsection*
3936 \begin_layout Description
3937 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3940 \begin_layout Description
3941 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action.
3944 \begin_layout Description
3948 \begin_layout Description
3949 Origin vfr, Sep 30 2008
3952 \begin_layout Subsection*
3956 \begin_layout Description
3957 Action Insert a tab into a listings inset.
3960 \begin_layout Description
3961 Notion It also works on a selection.
3964 \begin_layout Description
3968 \begin_layout Description
3969 Origin vfr, Sep 30 2008
3972 \begin_layout Subsection*
3976 \begin_layout Description
3977 Action Modify properties of tabulars and table-like math environments.
3980 \begin_layout Description
3981 Syntax tabular-feature <FEATURE> [<ARG>]
3984 \begin_layout Description
3985 Params Generally see LFUN_INSET_INSERT for further details.
3986 \begin_inset Newline newline
3989 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
3990 \begin_inset Newline newline
3993 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
3994 \begin_inset Newline newline
3997 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3998 \begin_inset Newline newline
4001 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4002 \begin_inset Newline newline
4005 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4006 \begin_inset Newline newline
4009 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4010 \begin_inset Newline newline
4013 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4014 \begin_inset Newline newline
4017 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
4018 \begin_inset Newline newline
4021 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4022 \begin_inset Newline newline
4025 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4026 \begin_inset Newline newline
4029 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4030 \begin_inset Newline newline
4033 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4034 \begin_inset Newline newline
4037 set-special-column|set-special-multicolumn|set-special-multirow|
4038 \begin_inset Newline newline
4041 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4042 \begin_inset Newline newline
4045 set-interline-space|set-border-lines|tabular-valign-top|
4046 \begin_inset Newline newline
4049 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
4050 \begin_inset Newline newline
4053 Various math-environment features are handled as well, e.g. add-vline-left/right for
4054 \begin_inset Newline newline
4057 the Grid/Array environment.
4058 \begin_inset Newline newline
4061 <ARG>: additional argument for some commands, use debug mode to explore its values.
4064 \begin_layout Description
4065 Origin gm, 10 Dec 2015
4068 \begin_layout Subsection*
4072 \begin_layout Description
4073 Action Inserts table into the document.
4076 \begin_layout Description
4077 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4080 \begin_layout Description
4081 Syntax tabular-insert [<ROWS> <COLUMNS>]
4084 \begin_layout Description
4085 Params In case no arguments are given show insert dialog.
4088 \begin_layout Description
4089 Origin Jug, 12 Apr 2000
4092 \begin_layout Subsection*
4096 \begin_layout Description
4097 Action Look up thesaurus entries with respect to the word under the cursor.
4100 \begin_layout Description
4101 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4104 \begin_layout Description
4105 Params <STRING>: word to look up <LANG>: language (see file languages)
4108 \begin_layout Description
4109 Origin Levon, 20 Jul 2001
4112 \begin_layout Subsection*
4116 \begin_layout Description
4117 Action Undoes the last edit.
4120 \begin_layout Description
4124 \begin_layout Subsection*
4128 \begin_layout Description
4129 Action Inserts a single unicode character.
4132 \begin_layout Description
4133 Syntax unicode-insert <CHAR>
4136 \begin_layout Description
4137 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
4140 \begin_layout Description
4141 Sample unicode-insert 0x0100
4144 \begin_layout Description
4145 Origin Lgb, 22 Oct 2006
4148 \begin_layout Subsection*
4152 \begin_layout Description
4153 Action Moves the cursor one line in upward direction.
4156 \begin_layout Description
4160 \begin_layout Subsection*
4164 \begin_layout Description
4165 Action Moves the cursor one line in upward direction adding the current position to the selection.
4168 \begin_layout Description
4172 \begin_layout Subsection*
4176 \begin_layout Description
4177 Action Moves the cursor to the logically previous beginning of a word.
4180 \begin_layout Description
4181 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
4184 \begin_layout Description
4185 Syntax word-backward
4188 \begin_layout Subsection*
4189 word-backward-select
4192 \begin_layout Description
4193 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4196 \begin_layout Description
4197 Notion See also LFUN_WORD_BACKWARD.
4200 \begin_layout Description
4201 Syntax word-backward-select
4204 \begin_layout Subsection*
4208 \begin_layout Description
4209 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4212 \begin_layout Description
4213 Syntax word-capitalize [<SEL_TYPE>]
4216 \begin_layout Description
4217 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
4220 \begin_layout Subsection*
4221 word-delete-backward
4224 \begin_layout Description
4225 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4228 \begin_layout Description
4229 Syntax word-delete-backward [force]
4232 \begin_layout Description
4233 Params force: Delete big insets, do not only select them.
4236 \begin_layout Subsection*
4240 \begin_layout Description
4241 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4244 \begin_layout Description
4245 Syntax word-delete-forward [force]
4248 \begin_layout Description
4249 Params force: Delete big insets, do not only select them.
4252 \begin_layout Subsection*
4256 \begin_layout Description
4257 Action Search for next occurrence of a string.
4260 \begin_layout Description
4261 Syntax word-find [<DATA>]
4264 \begin_layout Description
4265 Params <DATA>: data encoded from Find dialog (see lyx::find2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
4268 \begin_layout Description
4269 Origin Andre, Jan 7 2004
4272 \begin_layout Subsection*
4276 \begin_layout Description
4277 Action Search for a given string in backward direction.
4280 \begin_layout Description
4281 Notion Case sensitive, match words. If no argument given, last search repeated.
4284 \begin_layout Description
4285 Syntax word-find-backward [<STRING>]
4288 \begin_layout Description
4289 Origin Etienne, 20 Feb 1998
4292 \begin_layout Subsection*
4296 \begin_layout Description
4297 Action Search for a given string in forward direction.
4300 \begin_layout Description
4301 Notion Case sensitive, match words. If no argument given, last search repeated.
4304 \begin_layout Description
4305 Syntax word-find-forward [<STRING>]
4308 \begin_layout Description
4309 Origin Etienne, 16 Feb 1998
4312 \begin_layout Subsection*
4316 \begin_layout Description
4317 Action Search for next occurrence of a pattern.
4320 \begin_layout Description
4321 Syntax word-findadv [<DATA>]
4324 \begin_layout Description
4325 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
4328 \begin_layout Description
4329 Origin Tommaso, Nov 15 2007
4332 \begin_layout Subsection*
4336 \begin_layout Description
4337 Action Moves the cursor to the logically next beginning of a word.
4340 \begin_layout Description
4341 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
4344 \begin_layout Description
4348 \begin_layout Subsection*
4352 \begin_layout Description
4353 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4356 \begin_layout Description
4357 Notion See also LFUN_WORD_FORWARD.
4360 \begin_layout Description
4361 Syntax word-forward-select
4364 \begin_layout Subsection*
4368 \begin_layout Description
4369 Action Moves the cursor to the next beginning of a word "on the left".
4372 \begin_layout Description
4373 Notion This is the action which should be taken when the (e.g., ctrl-) "left" key is pressed. Generally, it moves the cursor to the next beginning of a word on the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
4376 \begin_layout Description
4380 \begin_layout Description
4381 Origin dov, 28 Oct 2007
4384 \begin_layout Subsection*
4388 \begin_layout Description
4389 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4392 \begin_layout Description
4393 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4396 \begin_layout Description
4397 Syntax word-left-select
4400 \begin_layout Description
4401 Origin dov, 28 Oct 2007
4404 \begin_layout Subsection*
4408 \begin_layout Description
4409 Action Change the words in the selection or word at cursor position to lower case.
4412 \begin_layout Description
4413 Syntax word-lowcase [<SEL_TYPE>]
4416 \begin_layout Description
4417 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
4420 \begin_layout Subsection*
4424 \begin_layout Description
4425 Action Replace a string in the document.
4428 \begin_layout Description
4429 Syntax word-replace [<DATA>]
4432 \begin_layout Description
4433 Params <DATA>: data is of the form "<replace>
4434 \begin_inset Newline newline
4438 \begin_inset Newline newline
4441 <casesensitive> <matchword> <all> <forward> <findnext>"
4444 \begin_layout Description
4445 Origin Andre, Jan 7 2004
4448 \begin_layout Subsection*
4452 \begin_layout Description
4453 Action Moves the cursor to the next beginning of a word "on the right".
4456 \begin_layout Description
4457 Notion This is the action which should be taken when the (e.g., ctrl-) "right" key is pressed. Generally, it moves the cursor to the next beginning of a word on the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
4460 \begin_layout Description
4464 \begin_layout Description
4465 Origin dov, 28 Oct 2007
4468 \begin_layout Subsection*
4472 \begin_layout Description
4473 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4476 \begin_layout Description
4477 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4480 \begin_layout Description
4481 Syntax word-right-select
4484 \begin_layout Description
4485 Origin dov, 28 Oct 2007
4488 \begin_layout Subsection*
4492 \begin_layout Description
4493 Action Puts the word where the cursor stands into the selection.
4496 \begin_layout Description
4500 \begin_layout Description
4501 Origin Andre, 11 Sep 2002
4504 \begin_layout Subsection*
4508 \begin_layout Description
4509 Action Change the words in the selection or word at cursor position to upper case.
4512 \begin_layout Description
4513 Syntax word-upcase [<SEL_TYPE>]
4516 \begin_layout Description
4517 Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
4520 \begin_layout Subsection*
4524 \begin_layout Description
4525 Action Inserts floats wrapped by the text around.
4528 \begin_layout Description
4529 Syntax wrap-insert <TYPE>
4532 \begin_layout Description
4533 Params <TYPE>: table|figure
4536 \begin_layout Description
4537 Origin Dekel, 7 Apr 2002
4540 \begin_layout Section
4541 Math Editor Functions
4544 \begin_layout Subsection*
4545 in-mathmacrotemplate
4548 \begin_layout Description
4549 Action Only active in Math Macro definition.
4552 \begin_layout Description
4553 Notion Dummy function which is only active in a Math Macro definition. It's used to toggle the Math Macro toolbar if the cursor moves into a Math Macro definition.
4556 \begin_layout Description
4557 Syntax in-mathmacrotemplate
4560 \begin_layout Description
4561 Origin sts, 06 January 2008
4564 \begin_layout Subsection*
4568 \begin_layout Description
4569 Action Inserts an extended matrix as provided by the amsmath package.
4572 \begin_layout Description
4573 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4576 \begin_layout Description
4577 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created. Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and matrix. The default is 'matrix'.
4580 \begin_layout Description
4581 Sample math-ams-matrix 3 3 bmatrix
4584 \begin_layout Subsection*
4588 \begin_layout Description
4589 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4592 \begin_layout Description
4593 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4596 \begin_layout Description
4597 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4598 \begin_inset Newline newline
4601 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4604 \begin_layout Description
4605 Sample math-bigdelim "Bigl" "
4612 \begin_layout Description
4613 Origin Enrico & Georg, 7 May 2006
4616 \begin_layout Subsection*
4620 \begin_layout Description
4621 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4624 \begin_layout Description
4625 Syntax math-delim [<LEFT>] [<RIGHT>]
4628 \begin_layout Description
4629 Params <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by either a LaTeX name or a valid character. ( is the default letter.
4632 \begin_layout Description
4633 Sample math-delim { rangle
4636 \begin_layout Description
4637 Origin Alejandro, 18 Jun 1996
4640 \begin_layout Subsection*
4644 \begin_layout Description
4645 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4648 \begin_layout Description
4649 Syntax math-display [<ARG>]
4652 \begin_layout Description
4653 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4656 \begin_layout Description
4657 Origin Alejandro, 18 Jun 1996
4660 \begin_layout Subsection*
4664 \begin_layout Description
4665 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4668 \begin_layout Description
4669 Notion Selection can be used to determine the input for the external program.
4672 \begin_layout Description
4673 Syntax math-extern <LANG> [<COMMAND>]
4676 \begin_layout Description
4677 Params <LANG>: octave|maxima|maple|mathematica|script
4678 \begin_inset Newline newline
4681 where "script" stands for the external script (normalized expression will be passed)
4684 \begin_layout Description
4685 Sample math-extern maple simplify
4688 \begin_layout Description
4689 Origin Andre, 24 Apr 2001
4692 \begin_layout Subsection*
4696 \begin_layout Description
4697 Action Changes the text style used in math.
4700 \begin_layout Description
4701 Syntax math-font-style <STYLE>
4704 \begin_layout Description
4705 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4706 \begin_inset Newline newline
4709 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4712 \begin_layout Description
4713 Origin vfr, 9 jan 2009
4716 \begin_layout Subsection*
4720 \begin_layout Description
4721 Action Inserts math objects and symbols.
4724 \begin_layout Description
4725 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4727 frac{x}{y}"), the content of cell(0) is replaced by the current selection (only works if the selection is in mathed). As an example, if "abc" is selected in mathed, "math-insert
4729 frac{x}{y}" replaces "abc" with "
4731 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z". If nothing is selected (or the selection is not in mathed), math-insert works as expected.
4734 \begin_layout Description
4735 Syntax math-insert <ARG>
4738 \begin_layout Description
4739 Params <ARG>: Symbol or LaTeX code to be inserted.
4742 \begin_layout Subsection*
4746 \begin_layout Description
4747 Action Toggles the position of the limits from above/below to the right side an vice versa in integral symbol, a limit, a summation, etc.
4750 \begin_layout Description
4751 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4754 \begin_layout Description
4755 Syntax math-limits [<STATE>]
4758 \begin_layout Description
4759 Params <STATE>: limits|nolimits
4762 \begin_layout Subsection*
4766 \begin_layout Description
4767 Action Inserts a math macro definition at the cursor position in the text.
4770 \begin_layout Description
4771 Syntax math-macro <NAME> [<NARGS>] [def]
4774 \begin_layout Description
4775 Params <NAME>: The name of the macro, e.g. "mymacro".
4776 \begin_inset Newline newline
4779 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4782 \begin_layout Description
4783 Origin ale, 10 May 1997; sts, 21 Dec 2007
4786 \begin_layout Subsection*
4787 math-macro-add-greedy-optional-param
4790 \begin_layout Description
4791 Action Add a greedy optional parameter.
4794 \begin_layout Description
4795 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4798 \begin_layout Description
4799 Syntax math-macro-add-greedy-optional-param
4802 \begin_layout Description
4803 Origin sts, 06 January 2008
4806 \begin_layout Subsection*
4807 math-macro-add-optional-param
4810 \begin_layout Description
4811 Action Add an optional parameter.
4814 \begin_layout Description
4815 Notion Insert an optional parameter just behind the already existing optional parameters.
4818 \begin_layout Description
4819 Syntax math-macro-add-optional-param
4822 \begin_layout Description
4823 Origin sts, 06 January 2008
4826 \begin_layout Subsection*
4827 math-macro-add-param
4830 \begin_layout Description
4831 Action Add a parameter.
4834 \begin_layout Description
4835 Notion Add a parameter to a Math Macro.
4838 \begin_layout Description
4839 Syntax math-macro-add-param <NUM>
4842 \begin_layout Description
4843 Params <NUM>: The number of the parameter behind which the new one will be added (1 for the first, i.e. use 0 for add a parameter at the left), defaults to the last one.
4846 \begin_layout Description
4847 Origin sts, 06 January 2008
4850 \begin_layout Subsection*
4851 math-macro-append-greedy-param
4854 \begin_layout Description
4855 Action Append a greedy parameter.
4858 \begin_layout Description
4859 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
4862 \begin_layout Description
4863 Syntax math-macro-append-greedy-param
4866 \begin_layout Description
4867 Origin sts, 06 January 2008
4870 \begin_layout Subsection*
4874 \begin_layout Description
4875 Action Fold a Math Macro.
4878 \begin_layout Description
4879 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
4884 \begin_layout Description
4885 Syntax math-macro-fold
4888 \begin_layout Description
4889 Origin sts, 06 January 2008
4892 \begin_layout Subsection*
4893 math-macro-make-nonoptional
4896 \begin_layout Description
4897 Action Make a parameter non-optional.
4900 \begin_layout Description
4901 Notion Turn the last optional parameter of a Math Macro into a non-optional parameter. The default value is remembered to be reused later if the user changes his mind.
4904 \begin_layout Description
4905 Syntax math-macro-make-nonoptional
4908 \begin_layout Description
4909 Origin sts, 06 January 2008
4912 \begin_layout Subsection*
4913 math-macro-make-optional
4916 \begin_layout Description
4917 Action Make a parameter optional.
4920 \begin_layout Description
4921 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
4924 \begin_layout Description
4925 Syntax math-macro-make-optional
4928 \begin_layout Description
4929 Origin sts, 06 January 2008
4932 \begin_layout Subsection*
4933 math-macro-remove-greedy-param
4936 \begin_layout Description
4937 Action Remove a greedy parameter.
4940 \begin_layout Description
4941 Notion Remove a greedy parameter of a Math Macro and spit out the values of it in every instance of the macro in the buffer. If it is an optional parameter the [valud] format is used.
4944 \begin_layout Description
4945 Syntax math-macro-remove-greedy-param
4948 \begin_layout Description
4949 Origin sts, 06 January 2008
4952 \begin_layout Subsection*
4953 math-macro-remove-optional-param
4956 \begin_layout Description
4957 Action Remove the last optional parameter.
4960 \begin_layout Description
4961 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
4964 \begin_layout Description
4965 Syntax math-macro-remove-optional-param
4968 \begin_layout Description
4969 Origin sts, 06 January 2008
4972 \begin_layout Subsection*
4973 math-macro-remove-param
4976 \begin_layout Description
4977 Action Remove the last parameter.
4980 \begin_layout Description
4981 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
4984 \begin_layout Description
4985 Syntax math-macro-remove-param <NUM>
4988 \begin_layout Description
4989 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
4992 \begin_layout Description
4993 Origin sts, 06 January 2008
4996 \begin_layout Subsection*
5000 \begin_layout Description
5001 Action Unfold a Math Macro.
5004 \begin_layout Description
5005 Notion Unfold the Math Macro the cursor is in, i.e. display it as
5010 \begin_layout Description
5011 Syntax math-macro-unfold
5014 \begin_layout Description
5015 Origin sts, 06 January 2008
5018 \begin_layout Subsection*
5022 \begin_layout Description
5023 Action Inserts a matrix.
5026 \begin_layout Description
5027 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5030 \begin_layout Description
5031 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b, c or t) (i.e. 1 char) and the horizontal alignments (l, c or r) (i.e. <COL> chars).
5034 \begin_layout Description
5035 Sample math-matrix 3 3 bccc
5038 \begin_layout Subsection*
5042 \begin_layout Description
5043 Action In text mode enters math mode (i.e. puts math insets on the current cursor position), in math mode enters text mode inside math expression.
5046 \begin_layout Description
5047 Notion If there is some selected text, it puts the text inside created math box.
5050 \begin_layout Description
5051 Syntax math-mode [on|<ARG>]
5054 \begin_layout Description
5055 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
5056 \begin_inset Newline newline
5059 "on": allow only entering of math mode from text mode.
5062 \begin_layout Description
5063 Origin Alejandro, 4 Jun 1996
5066 \begin_layout Subsection*
5070 \begin_layout Description
5071 Action Mutates the type of math inset to the newly selected one.
5074 \begin_layout Description
5075 Syntax math-mutate <TYPE>
5078 \begin_layout Description
5079 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
5082 \begin_layout Description
5083 Origin Andre, 23 May 2001
5086 \begin_layout Subsection*
5087 math-number-line-toggle
5090 \begin_layout Description
5091 Action Toggles numbering of the current formula line.
5094 \begin_layout Description
5095 Notion Must be in display formula mode.
5098 \begin_layout Description
5099 Syntax math-number-line-toggle
5102 \begin_layout Description
5103 Origin Alejandro, 18 Jun 1996
5106 \begin_layout Subsection*
5110 \begin_layout Description
5111 Action Toggles numbering/labeling of the current formula.
5114 \begin_layout Description
5115 Notion Must be in display formula mode.
5118 \begin_layout Description
5119 Syntax math-number-toggle
5122 \begin_layout Description
5123 Origin Alejandro, 4 Jun 1996
5126 \begin_layout Subsection*
5130 \begin_layout Description
5131 Action Changes arbitrarily the size used by math fonts inside a context.
5134 \begin_layout Description
5135 Notion Provides an interface to the LaTeX math mode font size commands.
5138 \begin_layout Description
5139 Syntax math-size <STYLE>
5142 \begin_layout Description
5154 \begin_layout Description
5155 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5158 \begin_layout Subsection*
5162 \begin_layout Description
5163 Action Inserts space into math expression.
5166 \begin_layout Description
5167 Notion Use spacebar after entering this space to change type of space.
5170 \begin_layout Description
5171 Syntax math-space [<TYPE>] [<LEN>]
5174 \begin_layout Description
5175 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5176 \begin_inset Newline newline
5179 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5180 \begin_inset Newline newline
5183 custom space: hspace
5184 \begin_inset Newline newline
5187 "," used by default.
5188 \begin_inset Newline newline
5191 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5192 \begin_inset Newline newline
5195 <LEN>: length for custom spaces (hspace)
5198 \begin_layout Description
5199 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5202 \begin_layout Subsection*
5206 \begin_layout Description
5207 Action Enters subscript expression in math expression.
5210 \begin_layout Description
5211 Syntax math-subscript
5214 \begin_layout Description
5215 Origin vermeer, 12 Dec 2001
5218 \begin_layout Subsection*
5222 \begin_layout Description
5223 Action Enters superscript expression in math expression.
5226 \begin_layout Description
5227 Syntax math-superscript
5230 \begin_layout Description
5231 Origin vermeer, 12 Dec 2001
5234 \begin_layout Subsection*
5238 \begin_layout Description
5239 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5242 \begin_layout Description
5243 Notion If there is any selected text, then it is moved inside the created regexp inset.
5246 \begin_layout Description
5247 Syntax regexp-mode [<ARG>]
5250 \begin_layout Description
5251 Params <ARG>: eventual argument (regular expression).
5254 \begin_layout Description
5255 Origin Tommaso, 4 Oct 2008
5258 \begin_layout Section
5259 Buffer Fuctions (File and Window related)
5262 \begin_layout Subsection*
5266 \begin_layout Description
5267 Action Activate the branch.
5270 \begin_layout Description
5271 Syntax branch-activate <BRANCH>
5274 \begin_layout Description
5275 Params <BRANCH>: The branch to activate
5278 \begin_layout Description
5279 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5280 \begin_inset Newline newline
5283 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5286 \begin_layout Description
5287 Origin rgh, 27 May 2008
5290 \begin_layout Subsection*
5294 \begin_layout Description
5295 Action Add a branch to the buffer's BranchList.
5298 \begin_layout Description
5299 Syntax branch-add <BRANCH>
5302 \begin_layout Description
5303 Params <BRANCH>: Name of the branch to add
5306 \begin_layout Description
5307 Origin spitz, 7 Jul 2009
5310 \begin_layout Subsection*
5314 \begin_layout Description
5315 Action Create new branch and directly put the branch inset into the document.
5318 \begin_layout Description
5319 Syntax branch-add-insert [<NAME>]
5322 \begin_layout Description
5323 Params <NAME>: Branch name. If it is not specified, you will be asked.
5326 \begin_layout Description
5327 Origin sanda, 10 Jul 2009
5330 \begin_layout Subsection*
5334 \begin_layout Description
5335 Action De-activate the branch.
5338 \begin_layout Description
5339 Syntax branch-deactivate <BRANCH>
5342 \begin_layout Description
5343 Params <BRANCH>: The branch to deactivate
5346 \begin_layout Description
5347 Origin rgh, 27 May 2008
5350 \begin_layout Subsection*
5354 \begin_layout Description
5355 Action Toggles inversion status of branch inset.
5358 \begin_layout Description
5359 Syntax branch-invert
5362 \begin_layout Description
5363 Origin rgheck, 12 July 2016
5366 \begin_layout Subsection*
5367 branch-master-activate
5370 \begin_layout Description
5371 Action Activate the branch in the master buffer.
5374 \begin_layout Description
5375 Syntax branch-master-activate <BRANCH>
5378 \begin_layout Description
5379 Params <BRANCH>: The branch to activate
5382 \begin_layout Description
5383 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5384 \begin_inset Newline newline
5387 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5390 \begin_layout Description
5391 Origin spitz, 30 Sep 2012
5394 \begin_layout Subsection*
5395 branch-master-deactivate
5398 \begin_layout Description
5399 Action De-activate the branch in the master buffer.
5402 \begin_layout Description
5403 Syntax branch-master-deactivate <BRANCH>
5406 \begin_layout Description
5407 Params <BRANCH>: The branch to deactivate
5410 \begin_layout Description
5411 Origin spitz, 30 Sep 2012
5414 \begin_layout Subsection*
5418 \begin_layout Description
5419 Action Rename all branches of a given name in a document.
5422 \begin_layout Description
5423 Syntax branches-rename <OLDNAME> <NEWNAME>
5426 \begin_layout Description
5427 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5430 \begin_layout Description
5431 Origin spitz, 9 Jul 2009
5434 \begin_layout Subsection*
5438 \begin_layout Description
5439 Action Saves the current buffer to a temporary file.
5442 \begin_layout Description
5443 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5446 \begin_layout Description
5447 Syntax buffer-auto-save
5450 \begin_layout Subsection*
5454 \begin_layout Description
5455 Action Loads the given child document.
5458 \begin_layout Description
5459 Notion The current document is treated as a parent.
5462 \begin_layout Description
5463 Syntax buffer-child-open <FILE>
5466 \begin_layout Description
5467 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5470 \begin_layout Description
5471 Origin Ale, 28 May 1997
5474 \begin_layout Subsection*
5478 \begin_layout Description
5479 Action Runs chktex for the current document.
5482 \begin_layout Description
5483 Syntax buffer-chktex
5486 \begin_layout Description
5487 Origin Asger, 30 Oct 1997
5490 \begin_layout Subsection*
5494 \begin_layout Description
5495 Action Closes the current buffer.
5498 \begin_layout Description
5499 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5502 \begin_layout Description
5506 \begin_layout Subsection*
5510 \begin_layout Description
5511 Action Closes all buffers.
5514 \begin_layout Description
5515 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5518 \begin_layout Description
5519 Syntax buffer-close-all
5522 \begin_layout Subsection*
5526 \begin_layout Description
5527 Action Exports the current buffer (document) to the given format.
5530 \begin_layout Description
5531 Syntax buffer-export [<FORMAT>] [<DEST>]
5534 \begin_layout Description
5535 Params <FORMAT> is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format. Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
5536 \begin_inset Newline newline
5539 In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5540 \begin_inset Newline newline
5543 If absent or "default", then the default output format of the document is used. <DEST> If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
5546 \begin_layout Description
5547 Origin Lgb, 29 Jul 1997
5550 \begin_layout Subsection*
5554 \begin_layout Description
5555 Action Opens a dialog for exporting the current buffer.
5558 \begin_layout Description
5559 Syntax buffer-export-as [<FORMAT>]
5562 \begin_layout Description
5563 Params <FORMAT> is the export format initially selected in the dialog. You can pass any of the formats which you can find in Tools->Preferences->File formats->Format, provided it has the "document" flag set. If no format is specified the dialog will start with the default output format of the current document.
5566 \begin_layout Description
5567 Sample buffer-export-as pdf2
5570 \begin_layout Description
5571 Origin tommaso, 6 Oct 2011
5574 \begin_layout Subsection*
5575 buffer-export-custom
5578 \begin_layout Description
5579 Action Exports the current buffer (document) from the given format using the given command on it.
5582 \begin_layout Description
5583 Syntax buffer-export-custom <FORMAT> <COMMAND>
5586 \begin_layout Description
5587 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5588 \begin_inset Newline newline
5591 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5594 \begin_layout Description
5595 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5598 \begin_layout Description
5599 Origin leeming, 27 Mar 2004
5602 \begin_layout Subsection*
5603 buffer-external-modification-clear
5606 \begin_layout Description
5607 Action Clear the external modification flag on the current buffer.
5610 \begin_layout Description
5611 Syntax buffer-external-modification-clear
5614 \begin_layout Description
5615 Origin gm, 2 March 2017
5618 \begin_layout Subsection*
5622 \begin_layout Description
5623 Action Applies a command to all non-hidden buffers.
5626 \begin_layout Description
5627 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5630 \begin_layout Description
5631 Syntax buffer-forall <LFUN-COMMAND>
5634 \begin_layout Description
5635 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5638 \begin_layout Description
5639 Sample Close all Notes in buffers:
5640 \begin_inset Newline newline
5643 buffer-forall inset-forall Note inset-toggle close
5644 \begin_inset Newline newline
5647 Toggle change tracking on buffers:
5648 \begin_inset Newline newline
5651 buffer-forall changes-track
5652 \begin_inset Newline newline
5655 Toggle read-only for buffers:
5656 \begin_inset Newline newline
5659 buffer-forall buffer-toggle-read-only
5660 \begin_inset Newline newline
5663 Show statistics for individual buffers:
5664 \begin_inset Newline newline
5667 buffer-forall statistics
5668 \begin_inset Newline newline
5671 Activate the branch named "Solutions" in buffers:
5672 \begin_inset Newline newline
5675 buffer-forall branch-activate Solutions
5676 \begin_inset Newline newline
5679 Export buffers to PDF (pdflatex):
5680 \begin_inset Newline newline
5683 buffer-forall buffer-export pdf2
5684 \begin_inset Newline newline
5690 \begin_layout Description
5691 Origin skostysh, 20 Jul 2012
5694 \begin_layout Subsection*
5698 \begin_layout Description
5699 Action Import a given file as a lyx document.
5702 \begin_layout Description
5703 Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences. Look in the File->Import menu to get an idea of the currently active import formats.
5706 \begin_layout Description
5707 Syntax buffer-import <FORMAT> [<FILE>]
5710 \begin_layout Description
5711 Origin Asger, 24 Jul 1998
5714 \begin_layout Subsection*
5718 \begin_layout Description
5719 Action Set language of the current document.
5722 \begin_layout Description
5723 Syntax buffer-language <LANG>
5726 \begin_layout Description
5727 Params <LANG>: language name. See lib/languages for list.
5730 \begin_layout Description
5731 Origin leeming, 30 Mar 2004
5734 \begin_layout Subsection*
5738 \begin_layout Description
5739 Action Moves the current tab one spot to the right.
5742 \begin_layout Description
5743 Syntax buffer-move-next
5746 \begin_layout Description
5747 Origin skostysh, 7 Apr 2015
5750 \begin_layout Subsection*
5751 buffer-move-previous
5754 \begin_layout Description
5755 Action Moves the current tab one spot to the left.
5758 \begin_layout Description
5759 Syntax buffer-move-previous
5762 \begin_layout Description
5763 Origin skostysh, 7 Apr 2015
5766 \begin_layout Subsection*
5770 \begin_layout Description
5771 Action Creates a new buffer (that is, document) and switches to it.
5774 \begin_layout Description
5775 Notion Implicit path can be set in Preferences dialog.
5778 \begin_layout Description
5779 Syntax buffer-new [<FILE>]
5782 \begin_layout Description
5783 Params <FILE>: filename of created file with absolute path.
5786 \begin_layout Subsection*
5790 \begin_layout Description
5791 Action Creates a new buffer (that is, document) from a template.
5794 \begin_layout Description
5795 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5798 \begin_layout Description
5799 Syntax buffer-new-template [<FILE>]
5802 \begin_layout Description
5803 Params <FILE>: filename of created file with absolute path.
5806 \begin_layout Subsection*
5810 \begin_layout Description
5811 Action Switch to the next opened document.
5814 \begin_layout Description
5815 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
5818 \begin_layout Description
5822 \begin_layout Subsection*
5826 \begin_layout Description
5827 Action Apply the given settings to the current document.
5830 \begin_layout Description
5831 Syntax buffer-params-apply [<ARGS>]
5834 \begin_layout Description
5835 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5838 \begin_layout Description
5839 Origin leeming, 30 Mar 2004
5842 \begin_layout Subsection*
5846 \begin_layout Description
5847 Action Switch to the previous opened document.
5850 \begin_layout Description
5851 Syntax buffer-previous
5854 \begin_layout Subsection*
5858 \begin_layout Description
5859 Action Reverts opened document.
5862 \begin_layout Description
5863 Syntax buffer-reload
5866 \begin_layout Description
5867 Origin Asger, 2 Feb 1997
5870 \begin_layout Subsection*
5871 buffer-save-as-default
5874 \begin_layout Description
5875 Action Save the current document settings as default.
5878 \begin_layout Description
5879 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5882 \begin_layout Description
5883 Syntax buffer-save-as-default [<ARGS>]
5886 \begin_layout Description
5887 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5890 \begin_layout Description
5891 Origin leeming, 30 Mar 2004
5894 \begin_layout Subsection*
5898 \begin_layout Description
5899 Action Display and switch to the given buffer.
5902 \begin_layout Description
5903 Syntax buffer-switch <BUFFER>
5906 \begin_layout Description
5907 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
5910 \begin_layout Subsection*
5911 buffer-toggle-compression
5914 \begin_layout Description
5915 Action Toggles compression of the current document on/off.
5918 \begin_layout Description
5919 Syntax buffer-toggle-compression
5922 \begin_layout Description
5923 Origin bpeng, 27 Apr 2006
5926 \begin_layout Subsection*
5927 buffer-toggle-read-only
5930 \begin_layout Description
5931 Action Toggle editing mode of the current document between read/write and read-only.
5934 \begin_layout Description
5935 Notion This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking.
5938 \begin_layout Description
5939 Syntax buffer-toggle-read-only
5942 \begin_layout Description
5943 Origin Lgb, 27 May 1997
5946 \begin_layout Subsection*
5950 \begin_layout Description
5951 Action Exports the current document and put the result into the temporary directory.
5954 \begin_layout Description
5955 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript).
5958 \begin_layout Description
5959 Syntax buffer-update [<FORMAT>]
5962 \begin_layout Description
5963 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
5966 \begin_layout Description
5967 Origin Dekel, 5 Aug 2000
5970 \begin_layout Subsection*
5974 \begin_layout Description
5975 Action Displays current buffer in chosen format.
5978 \begin_layout Description
5979 Notion Displays the contents of the current buffer in the chosen format, for example, PDF or DVI. This runs the necessary converter, calls the defined viewer, and so forth.
5982 \begin_layout Description
5983 Syntax buffer-view [<FORMAT>]
5986 \begin_layout Description
5987 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
5990 \begin_layout Subsection*
5994 \begin_layout Description
5995 Action Opens the file that was created from last preview of this buffer.
5998 \begin_layout Description
5999 Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog. It can also be called by the user, which is useful if the document takes a long time to compile, and you just want to see the last previewed version.
6002 \begin_layout Description
6003 Syntax buffer-view-cache
6006 \begin_layout Subsection*
6010 \begin_layout Description
6011 Action Saves the current buffer.
6014 \begin_layout Description
6015 Notion Saves the current buffer to disk, using the filename that is already associated with the buffer, asking for one if none is yet assigned.
6018 \begin_layout Description
6022 \begin_layout Subsection*
6026 \begin_layout Description
6027 Action Save all changed documents.
6030 \begin_layout Description
6031 Syntax buffer-write-all
6034 \begin_layout Description
6035 Origin rgh, gpothier 6 Aug 2007
6038 \begin_layout Subsection*
6042 \begin_layout Description
6043 Action Rename and save current buffer.
6046 \begin_layout Description
6047 Syntax buffer-write-as <FILENAME>
6050 \begin_layout Description
6051 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6054 \begin_layout Subsection*
6058 \begin_layout Description
6059 Action Sets the zoom of the screen fonts.
6062 \begin_layout Description
6063 Syntax buffer-zoom [<ZOOM>]
6066 \begin_layout Description
6067 Params <ZOOM>: The target zoom value in %; the default is the default zoom as saved in preferences.
6070 \begin_layout Description
6071 Origin daniel, 28 Oct 2016
6074 \begin_layout Subsection*
6078 \begin_layout Description
6079 Action Increases the zoom of the screen fonts.
6082 \begin_layout Description
6083 Syntax buffer-zoom-in [<ZOOM>]
6086 \begin_layout Description
6087 Params <ZOOM>: The zoom value addition in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6090 \begin_layout Description
6091 Origin vfr, 30 Mar 2009
6094 \begin_layout Subsection*
6098 \begin_layout Description
6099 Action Decreases the zoom of the screen fonts.
6102 \begin_layout Description
6103 Syntax buffer-zoom-out [<ZOOM>]
6106 \begin_layout Description
6107 Params <ZOOM>: The zoom value abstraction in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6110 \begin_layout Description
6111 Origin vfr, 30 Mar 2009
6114 \begin_layout Subsection*
6118 \begin_layout Description
6119 Action Generates the code (literate programming).
6122 \begin_layout Description
6123 Notion Latex file with extension
6125 literate_extension is generated. Then LyX invokes
6127 build_command (with a default of ``make'') to generate the code and
6129 build_error_filter to process the compilation error messages.
6130 \begin_inset Newline newline
6133 In case you want to process your literate file with a script, or some other program, just insert in your lyxrc file an entry with:
6134 \begin_inset Newline newline
6139 build_command "my_script my_arguments"
6140 \begin_inset Newline newline
6145 build_error_filter differs from the
6147 literate_error_filter only in that the former will identify error messages from your compiler.
6150 \begin_layout Description
6151 Syntax build-program
6154 \begin_layout Subsection*
6158 \begin_layout Description
6159 Action Open LyX document.
6162 \begin_layout Description
6163 Syntax file-open [<FILE>]
6166 \begin_layout Description
6167 Params <FILE>: Filename to be opened.
6170 \begin_layout Subsection*
6174 \begin_layout Description
6175 Action Open the given help file according to the language setting.
6178 \begin_layout Description
6179 Syntax help-open <FILE>[.lyx]
6182 \begin_layout Description
6183 Params <FILE>: any document from (/usr/share/)doc directory.
6186 \begin_layout Description
6187 Origin Jug, 27 Jun 1999
6190 \begin_layout Subsection*
6194 \begin_layout Description
6195 Action Sets icon size of toolbars.
6198 \begin_layout Description
6199 Syntax icon-size [<SIZE>]
6202 \begin_layout Description
6203 Params <SIZE> : the icon size in px or one of the logical settings small|normal|big|huge|giant, the default is normal (whose size in px is icon set dependent).
6206 \begin_layout Description
6210 \begin_layout Subsection*
6214 \begin_layout Description
6215 Action Terminates the current LyX instance.
6218 \begin_layout Description
6219 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6222 \begin_layout Description
6226 \begin_layout Subsection*
6227 master-buffer-update
6230 \begin_layout Description
6231 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6234 \begin_layout Description
6235 Syntax master-buffer-update [<FORMAT>]
6238 \begin_layout Description
6239 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
6242 \begin_layout Description
6243 Origin Tommaso, 20 Sep 2007
6246 \begin_layout Subsection*
6250 \begin_layout Description
6251 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6254 \begin_layout Description
6255 Syntax master-buffer-view [<FORMAT>]
6258 \begin_layout Description
6259 Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
6262 \begin_layout Description
6263 Origin Tommaso, 20 Sep 2007
6266 \begin_layout Subsection*
6270 \begin_layout Description
6271 Action Opens the menu given by its name.
6274 \begin_layout Description
6275 Syntax menu-open <NAME>
6278 \begin_layout Description
6279 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6282 \begin_layout Subsection*
6286 \begin_layout Description
6287 Action Close the current tab group.
6290 \begin_layout Description
6291 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6294 \begin_layout Description
6295 Syntax tab-group-close
6298 \begin_layout Description
6299 Origin Abdel, 21 Feb 2008
6302 \begin_layout Subsection*
6306 \begin_layout Description
6307 Action Toggles movability of a given toolbar between true/false.
6310 \begin_layout Description
6311 Syntax toolbar-movable <NAME>
6314 \begin_layout Description
6315 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate|
6316 \begin_inset Newline newline
6319 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6322 \begin_layout Description
6323 Origin daniel, 12 July 2016
6326 \begin_layout Subsection*
6330 \begin_layout Description
6331 Action Toggles visibility of a given toolbar between on/off/auto.
6334 \begin_layout Description
6335 Notion Skipping "auto" when allowauto is false.
6338 \begin_layout Description
6339 Syntax toolbar-toggle <NAME> [allowauto]
6342 \begin_layout Description
6343 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6344 \begin_inset Newline newline
6347 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6350 \begin_layout Description
6351 Origin Edwin, 21 May 2007
6354 \begin_layout Subsection*
6358 \begin_layout Description
6359 Action Various UI visibility-toggling actions.
6362 \begin_layout Description
6363 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6366 \begin_layout Description
6367 Params statusbar : Toggle visibility of the statusbar.
6368 \begin_inset Newline newline
6371 menubar : Toggle visibility of the menubar.
6372 \begin_inset Newline newline
6375 scrollbar : Toggle visibility of the scrollbar.
6376 \begin_inset Newline newline
6379 frame : Toggle visibility of the frames around editing window.
6380 \begin_inset Newline newline
6383 fullscreen : Toggle fullscreen mode. This also covers calling the previous functions. However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
6386 \begin_layout Description
6387 Origin sanda, 9 Feb 2007
6390 \begin_layout Subsection*
6394 \begin_layout Description
6395 Action Close the current document work area.
6398 \begin_layout Description
6399 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6402 \begin_layout Description
6406 \begin_layout Description
6407 Origin Tommaso, 15 Sep 2012
6410 \begin_layout Subsection*
6414 \begin_layout Description
6415 Action Creates another split view of current buffer.
6418 \begin_layout Description
6419 Notion All split views act in the same way independently.
6422 \begin_layout Description
6423 Syntax view-split <vertical|horizontal>
6426 \begin_layout Description
6427 Params horizontal : The work areas are laid out side by side.
6428 \begin_inset Newline newline
6431 vertical : The work areas laid out vertically.
6434 \begin_layout Description
6435 Origin Abdel, 20 Feb 2008
6438 \begin_layout Subsection*
6442 \begin_layout Description
6443 Action Closes the current LyX window.
6446 \begin_layout Description
6450 \begin_layout Description
6451 Origin Abdel, 23 Oct 2006
6454 \begin_layout Subsection*
6458 \begin_layout Description
6459 Action Creates new empty LyX window.
6462 \begin_layout Description
6463 Notion Already opened documents from the previous window can be found under View menu.
6466 \begin_layout Description
6467 Syntax window-new [<GEOMETRY>]
6470 \begin_layout Description
6471 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6474 \begin_layout Description
6475 Origin Abdel, 21 Oct 2006
6478 \begin_layout Section
6479 System Functions (Preferences, LyX Server etc.)
6482 \begin_layout Subsection*
6483 buffer-toggle-output-sync
6486 \begin_layout Description
6487 Action Toggles including of resources for forward/reverse search of the given document.
6490 \begin_layout Description
6491 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6494 \begin_layout Description
6495 Syntax buffer-toggle-output-sync
6498 \begin_layout Description
6499 Origin sanda, 25 May 2010
6502 \begin_layout Subsection*
6506 \begin_layout Description
6507 Action Executes a command defined in a .def file.
6510 \begin_layout Description
6511 Notion The definitions are by default read from lib/commands/default.def.
6512 \begin_inset Newline newline
6515 A .def file allows to define a command with
6517 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and <LFUN> is the lfun code to be executed (see e.g. LFUN_COMMAND_SEQUENCE).
6519 def_file "FileName" allows to include another .def file.
6520 \begin_inset Newline newline
6523 This is particularly useful in connection with toolbar buttons: Since the name of the button image for this lfun is lib/images/commands/<NAME>.png this is the way to assign an image to a complex command-sequence.
6526 \begin_layout Description
6530 \begin_layout Description
6531 Params <NAME>: Name of the command that must be called.
6534 \begin_layout Description
6535 Origin broider, 2 Oct 2007
6538 \begin_layout Subsection*
6542 \begin_layout Description
6543 Action Cancels sequence prepared by LFUN_META_PREFIX .
6546 \begin_layout Description
6550 \begin_layout Subsection*
6551 command-alternatives
6554 \begin_layout Description
6555 Action Runs the first listed command that is enabled.
6558 \begin_layout Description
6559 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6562 \begin_layout Description
6563 Syntax command-alternatives <CMDS>
6566 \begin_layout Description
6567 Params <CMDS>: Sequence of commands separated by semicolons.
6570 \begin_layout Description
6571 Sample command-alternatives completion-accept;cell-forward
6574 \begin_layout Description
6575 Origin rgh, 24 September 2008
6578 \begin_layout Subsection*
6582 \begin_layout Description
6583 Action Run more commands (LFUN and its parameters) in a sequence.
6586 \begin_layout Description
6587 Syntax command-sequence <CMDS>
6590 \begin_layout Description
6591 Params <CMDS>: Sequence of commands separated by semicolons.
6594 \begin_layout Description
6595 Sample command-sequence cut; ert-insert; self-insert
6597 ; paste; self-insert {}; inset-toggle;
6600 \begin_layout Description
6601 Origin Andre, 11 Nov 1999
6604 \begin_layout Subsection*
6605 cursor-follows-scrollbar-toggle
6608 \begin_layout Description
6609 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6612 \begin_layout Description
6613 Syntax toggle-cursor-follows-scrollbar
6616 \begin_layout Description
6617 Origin ARRae, 2 Dec 1997
6620 \begin_layout Subsection*
6624 \begin_layout Description
6625 Action Set debug output level.
6628 \begin_layout Description
6629 Syntax debug-level-set <LEVEL>
6632 \begin_layout Description
6633 Params <LEVEL>: comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers.
6636 \begin_layout Description
6637 Origin sanda, 28 Dec 2009
6640 \begin_layout Subsection*
6644 \begin_layout Description
6645 Action toggle a mode where more information is given in UI
6648 \begin_layout Description
6649 Notion in so called "devel" mode, the information given in the status bar is more precise, and the help documents are open in editing mode.
6652 \begin_layout Description
6653 Syntax devel-mode-toggle
6656 \begin_layout Description
6657 Origin lasgouttes, 23 Jul 2017
6660 \begin_layout Subsection*
6664 \begin_layout Description
6665 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6668 \begin_layout Description
6669 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6672 \begin_layout Description
6673 Syntax forward-search
6676 \begin_layout Description
6677 Origin sanda, 14 Apr 2010
6680 \begin_layout Subsection*
6684 \begin_layout Description
6685 Action Apply the given settings to user preferences.
6688 \begin_layout Description
6689 Syntax lyxrc-apply <SETTINGS>
6692 \begin_layout Description
6693 Params <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences to get an idea which commands to use and their syntax. lyx::LyXRC::LyXRCTags has the list of possible commands.
6696 \begin_layout Subsection*
6700 \begin_layout Description
6701 Action Shows message in statusbar (for script purposes).
6704 \begin_layout Description
6705 Syntax message <STRING>
6708 \begin_layout Description
6709 Origin Lgb, 8 Apr 2001
6712 \begin_layout Subsection*
6716 \begin_layout Description
6717 Action Simulate halting Meta key (Alt key on PCs).
6720 \begin_layout Description
6721 Notion Used for buffer edition not for GUI control.
6724 \begin_layout Description
6728 \begin_layout Subsection*
6732 \begin_layout Description
6733 Action Save user preferences.
6736 \begin_layout Description
6737 Syntax preferences-save
6740 \begin_layout Description
6741 Origin Lgb, 27 Nov 1999
6744 \begin_layout Subsection*
6748 \begin_layout Description
6749 Action Reconfigure the automatic settings.
6752 \begin_layout Description
6756 \begin_layout Description
6757 Origin Asger, 14 Feb 1997
6760 \begin_layout Subsection*
6764 \begin_layout Description
6765 Action Returns path and file name of the currently edited document.
6768 \begin_layout Description
6769 Syntax server-get-filename
6772 \begin_layout Subsection*
6776 \begin_layout Description
6777 Action Returns the current layout (that is environment) name on the cursor position.
6780 \begin_layout Description
6781 Syntax server-get-layout
6784 \begin_layout Subsection*
6785 server-get-statistics
6788 \begin_layout Description
6789 Action Returns the statistics (number of words and characters) in the document or in the given selection.
6792 \begin_layout Description
6793 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6796 \begin_layout Description
6797 Syntax server-get-statistics [<TYPE>]
6800 \begin_layout Description
6801 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
6802 \begin_inset Newline newline
6806 \begin_inset Newline newline
6809 chars: count characters.
6810 \begin_inset Newline newline
6813 chars-space: count characters and spaces.
6816 \begin_layout Description
6817 Origin brokenclock, Oct 10 2014
6820 \begin_layout Subsection*
6824 \begin_layout Description
6825 Action Returns the coordinates of cursor position in the editing area.
6828 \begin_layout Description
6829 Syntax server-get-xy
6832 \begin_layout Subsection*
6833 server-goto-file-row
6836 \begin_layout Description
6837 Action Sets the cursor position in LyX based on the row number of generated TeX file.
6840 \begin_layout Description
6841 Notion This can be useful for DVI inverse-search or detection of the problematic line from LaTeX compilation. Note that before this function can be used export to LaTeX output must occur (in order to map the row numbers).
6844 \begin_layout Description
6845 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
6848 \begin_layout Description
6849 Params <FILE>: the path and filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
6850 \begin_inset Newline newline
6853 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g. for the case of generated .tex file).
6854 \begin_inset Newline newline
6857 .ext: extensions will be automatically replaced by .lyx.
6858 \begin_inset Newline newline
6861 <ROW_NUMBER> The row number of the LaTeX file to which to go.
6864 \begin_layout Description
6865 Sample server-goto-file-row /home/user/example.lyx 41
6866 \begin_inset Newline newline
6869 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
6872 \begin_layout Description
6873 Origin Edmar, 23 Dec 1998
6876 \begin_layout Subsection*
6880 \begin_layout Description
6881 Action Sends notify message about the last key-sequence to client.
6884 \begin_layout Description
6885 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
6888 \begin_layout Description
6889 Syntax server-notify
6892 \begin_layout Subsection*
6896 \begin_layout Description
6897 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
6900 \begin_layout Description
6901 Syntax server-set-xy <X> <Y>
6904 \begin_layout Subsection*
6908 \begin_layout Description
6909 Action Set the given LyX color to the color defined by the X11 name given.
6912 \begin_layout Description
6913 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
6916 \begin_layout Description
6917 Syntax set-color <LYX_NAME> <X11_NAME>
6920 \begin_layout Description
6921 Origin SLior, 11 Jun 2000
6924 \begin_layout Subsection*
6928 \begin_layout Description
6929 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
6932 \begin_layout Description
6933 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6936 \begin_layout Description
6940 \begin_layout Description
6941 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6944 \begin_layout Subsection*
6948 \begin_layout Description
6949 Action Checks-in/commits the changes of the registered file to the repository.
6952 \begin_layout Description
6953 Notion In RCS case this also unlocks the file.
6956 \begin_layout Description
6960 \begin_layout Description
6961 Origin Lgb, 1 Jul 1997
6964 \begin_layout Subsection*
6968 \begin_layout Description
6969 Action Checks-out the document for edit (and locks it in some cases).
6972 \begin_layout Description
6976 \begin_layout Description
6977 Origin Lgb, 1 Jul 1997
6980 \begin_layout Subsection*
6984 \begin_layout Description
6985 Action Executes external command. This command is intended to support additional VCS commands.
6988 \begin_layout Description
6989 Syntax vc-command <FLAG> <PATH> <COMMAND>
6992 \begin_layout Description
6993 Params <FLAG>: Flags for the command can be combined together.
6994 \begin_inset Newline newline
6997 U - dUmmy - no flags
6998 \begin_inset Newline newline
7001 D - Doc - need document loaded to proceed
7002 \begin_inset Newline newline
7005 I - dIrty - mark document dirty
7006 \begin_inset Newline newline
7009 R - Reload - ensure that the document is saved and reload it after command execution
7010 \begin_inset Newline newline
7013 M - Message - ask for input string (commit message)
7014 \begin_inset Newline newline
7017 <PATH>: path where to start. $$p will be replaced by the current document path.
7018 \begin_inset Newline newline
7021 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
7024 \begin_layout Description
7025 Sample vc-command DR $$p "svn up"
7028 \begin_layout Description
7029 Origin sanda, 13 Jan 2009
7032 \begin_layout Subsection*
7036 \begin_layout Description
7037 Action Compares two revisions of the same file under version control.
7040 \begin_layout Description
7041 Syntax vc-compare [<REV1>] [<REV2>]
7044 \begin_layout Description
7045 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
7046 \begin_inset Newline newline
7049 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
7050 \begin_inset Newline newline
7054 \begin_inset Newline newline
7057 <REV2>: Newer file. Used only if REV1 > 0.
7058 \begin_inset Newline newline
7061 If no parameter is given, interactive dialog will be shown.
7064 \begin_layout Description
7065 Sample Compare current document against last commit
7066 \begin_inset Newline newline
7070 \begin_inset Newline newline
7073 Compare current document against current revision - 5 commits
7074 \begin_inset Newline newline
7078 \begin_inset Newline newline
7081 Compare revisions 120 and 155
7082 \begin_inset Newline newline
7088 \begin_layout Description
7089 Origin sanda, 12 Feb 2010
7092 \begin_layout Subsection*
7096 \begin_layout Description
7097 Action Copies the document to another name.
7100 \begin_layout Description
7101 Notion Copying with revision history is only supported by SVN. For RCS and CVS it is simulated by adding the document under a new name. Disabled if uncommitted changes exist.
7104 \begin_layout Description
7105 Syntax vc-copy <FILENAME>
7108 \begin_layout Description
7109 Params <FILENAME>: New name of the document.
7110 \begin_inset Newline newline
7113 A file dialog is opened if no filename is given.
7116 \begin_layout Description
7117 Origin gb, 05 Feb 2013
7120 \begin_layout Subsection*
7124 \begin_layout Description
7125 Action Toggles the locking property of the edited file.
7128 \begin_layout Description
7129 Notion This is currently implemented only for SVN.
7132 \begin_layout Description
7133 Syntax vc-locking-toggle
7136 \begin_layout Description
7137 Origin sanda, 25 Jun 2009
7140 \begin_layout Subsection*
7144 \begin_layout Description
7145 Action Register the document as an file inside version control system.
7148 \begin_layout Description
7149 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
7150 \begin_inset Newline newline
7153 See LyX Additional Features Manual (Version Control Chapter) for additional information.
7156 \begin_layout Description
7160 \begin_layout Description
7161 Origin Lgb, 1 Jul 1997
7164 \begin_layout Subsection*
7168 \begin_layout Description
7169 Action Renames the document to another name.
7172 \begin_layout Description
7173 Notion Renaming with revision history is only supported by SVN. For CVS it is simulated by adding the document under a new name and deleting the old one. For RCS it is not supported. Disabled if uncommitted changes exist.
7176 \begin_layout Description
7177 Syntax vc-rename <FILENAME>
7180 \begin_layout Description
7181 Params <FILENAME>: New name of the document.
7182 \begin_inset Newline newline
7185 A file dialog is opened if no filename is given.
7188 \begin_layout Description
7189 Origin gb, 05 Feb 2013
7192 \begin_layout Subsection*
7196 \begin_layout Description
7197 Action Update the local archive directory in which resides the current document with the remote repository.
7200 \begin_layout Description
7201 Syntax vc-repo-update
7204 \begin_layout Description
7205 Origin sanda, 16 Oct 2009
7208 \begin_layout Subsection*
7212 \begin_layout Description
7213 Action Reverts the document to the last check-in/commit in VCS.
7216 \begin_layout Description
7220 \begin_layout Description
7221 Origin Lgb, 1 Jul 1997
7224 \begin_layout Subsection*
7228 \begin_layout Description
7229 Action Undo last check-in.
7232 \begin_layout Description
7233 Notion This is currently implemented only for RCS.
7236 \begin_layout Description
7240 \begin_layout Description
7241 Origin Lgb, 1 Jul 1997
7244 \begin_layout Section
7245 Hidden Functions (not listed for configuration)
7248 \begin_layout Subsection*
7252 \begin_layout Description
7253 Action Return the current key sequence and available options as a string.
7256 \begin_layout Description
7257 Notion No options are added if no current map exists.
7258 \begin_inset Newline newline
7261 This is probably usable only with connection to lyxserver.
7264 \begin_layout Description
7265 Syntax command-prefix
7268 \begin_layout Subsection*
7272 \begin_layout Description
7273 Action Activates the LyX window.
7276 \begin_layout Description
7277 Notion On Linux and Mac OS, this action brings the LyX window into focus. Such behavior is not allowed by Windows OS so instead the color of the taskbar entry is changed to indicate that the window has changed in some way. This action is useful in combination with reverse search.
7280 \begin_layout Description
7284 \begin_layout Description
7285 Origin skostysh, 4 Aug 2016
7288 \begin_layout Subsection*
7292 \begin_layout Description
7293 Action Inserts the given string (accordingly to the correct keymap).
7296 \begin_layout Description
7297 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7300 \begin_layout Description
7301 Syntax self-insert <STRING>