1 # gen_lfuns.py generated 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
42 \default_output_format default
44 \bibtex_command default
45 \index_command default
46 \paperfontsize default
51 \use_package amsmath 1
52 \use_package amssymb 1
55 \use_package mathdots 0
56 \use_package mathtools 0
58 \use_package stackrel 0
59 \use_package stmaryrd 0
60 \use_package undertilde 0
62 \cite_engine_type default
66 \paperorientation portrait
80 \paragraph_separation indent
81 \paragraph_indentation default
82 \quotes_language english
85 \paperpagestyle default
86 \tracking_changes false
105 \begin_layout Section*
109 \begin_layout Standard
110 This manual documents the
111 \begin_inset Quotes eld
115 \begin_inset Quotes erd
119 These are commands that are used to make \SpecialChar LyX
120 perform specific actions.
122 itself uses these functions internally, and every internal action is
126 \begin_layout Standard
127 LFUNs are also used in the files that define keyboard shortcuts, menu or
129 So if you want to change\SpecialChar breakableslash
130 customize the user interface, you need to deal
132 Furthermore, external programs can use LFUNs to communicate with and
133 \begin_inset Quotes eld
137 \begin_inset Quotes erd
142 Finally, you can also issue LFUNs directly via the so called mini-buffer
143 which can be opened via
146 arg "command-execute"
152 \begin_layout Standard
153 In the following, all LFUNs are listed, categorized by function.
156 \begin_layout Section
157 Layout Functions (Font, Layout and Textclass related)
160 \begin_layout Subsection*
164 \begin_layout Description
165 Action Displays list of layout choices.
168 \begin_layout Description
169 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
172 \begin_layout Description
173 Syntax drop-layouts-choice
176 \begin_layout Subsection*
180 \begin_layout Description
181 Action Splits the current environment with a Separator.
184 \begin_layout Description
185 Syntax environment-split [outer]
188 \begin_layout Description
189 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
192 \begin_layout Description
193 Origin spitz, 23 Dec 2012
196 \begin_layout Subsection*
200 \begin_layout Description
201 Action Toggles the bold font (selection-wise) using mathbf in math.
204 \begin_layout Description
208 \begin_layout Subsection*
212 \begin_layout Description
213 Action Toggles the bold font (selection-wise) using boldsymbol in math.
216 \begin_layout Description
217 Syntax font-boldsymbol
220 \begin_layout Subsection*
224 \begin_layout Description
225 Action Reverts the settings of the font to the default values (selection-wise).
228 \begin_layout Description
232 \begin_layout Subsection*
236 \begin_layout Description
237 Action Toggles the emphasis font style (selection-wise).
240 \begin_layout Description
244 \begin_layout Subsection*
248 \begin_layout Description
249 Action Toggles Fraktur family font (math-mode, selection-wise).
252 \begin_layout Description
256 \begin_layout Description
257 Origin vermeer, 10 Jan 2002
260 \begin_layout Subsection*
264 \begin_layout Description
265 Action Toggles Italics font shape (math-mode, selection-wise).
268 \begin_layout Description
272 \begin_layout Description
273 Origin vermeer, 10 Jan 2002
276 \begin_layout Subsection*
280 \begin_layout Description
281 Action Toggles Noun text style font (selection-wise).
284 \begin_layout Description
288 \begin_layout Subsection*
292 \begin_layout Description
293 Action Toggles Roman family font (selection-wise).
296 \begin_layout Description
300 \begin_layout Subsection*
304 \begin_layout Description
305 Action Toggles Sans Serif family font (selection-wise).
308 \begin_layout Description
312 \begin_layout Subsection*
316 \begin_layout Description
317 Action Sets font size according to lyx format string.
320 \begin_layout Description
321 Syntax font-size <SIZE>
324 \begin_layout Description
325 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
326 \begin_inset Newline newline
329 largest|huge|giant|increase|decrease|default
332 \begin_layout Subsection*
336 \begin_layout Description
337 Action Returns the info about the current font.
340 \begin_layout Description
344 \begin_layout Subsection*
348 \begin_layout Description
349 Action Toggles strikeout (strike-through) in the font (selection-wise).
352 \begin_layout Description
353 Syntax font-strikeout
356 \begin_layout Description
357 Origin sanda, 3 May 2009
360 \begin_layout Subsection*
364 \begin_layout Description
365 Action Toggles the typewriter family font (selection-wise).
368 \begin_layout Description
369 Syntax font-typewriter
372 \begin_layout Subsection*
376 \begin_layout Description
377 Action Toggles underline in the font (selection-wise).
380 \begin_layout Description
381 Syntax font-underline
384 \begin_layout Subsection*
388 \begin_layout Description
389 Action Toggles double underline in the font (selection-wise).
392 \begin_layout Description
393 Syntax font-underunderline
396 \begin_layout Description
397 Origin sanda, 5 May 2009
400 \begin_layout Subsection*
404 \begin_layout Description
405 Action Toggles wavy underline in the font (selection-wise).
408 \begin_layout Description
409 Syntax font-underwave
412 \begin_layout Description
413 Origin sanda, 5 May 2009
416 \begin_layout Subsection*
420 \begin_layout Description
421 Action Sets the layout (that is, environment) for the current paragraph.
424 \begin_layout Description
425 Syntax layout <LAYOUT>
428 \begin_layout Description
429 Params <LAYOUT>: the layout to use
432 \begin_layout Subsection*
436 \begin_layout Description
437 Action Adds a module.
440 \begin_layout Description
441 Notion Adds a module to the list of included modules for the current buffer.
444 \begin_layout Description
445 Syntax layout-module-add <MODULE>
448 \begin_layout Description
449 Params <MODULE>: the module to be added
452 \begin_layout Description
453 Origin rgh, 25 August 2007
456 \begin_layout Subsection*
460 \begin_layout Description
461 Action Clears the module list.
464 \begin_layout Description
465 Notion Clears the list of included modules for the current buffer.
468 \begin_layout Description
469 Syntax layout-modules-clear
472 \begin_layout Description
473 Origin rgh, 25 August 2007
476 \begin_layout Subsection*
480 \begin_layout Description
481 Action Launches the paragraph settings dialog.
484 \begin_layout Description
485 Syntax layout-paragraph
488 \begin_layout Subsection*
492 \begin_layout Description
493 Action Reloads layout information.
496 \begin_layout Description
497 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.
500 \begin_layout Description
504 \begin_layout Description
505 Origin rgh, 3 September 2007
508 \begin_layout Subsection*
512 \begin_layout Description
513 Action Launches the tabular settings dialog.
516 \begin_layout Description
517 Syntax layout-tabular
520 \begin_layout Description
521 Origin Jug, 31 Jul 2000
524 \begin_layout Subsection*
528 \begin_layout Description
529 Action Update fonts and its metrics.
532 \begin_layout Description
533 Notion Automatically called after zoom, dpi, font names, or norm change.
536 \begin_layout Description
537 Syntax screen-font-update
540 \begin_layout Description
541 Origin ARRae, 13 Aug 2000
544 \begin_layout Subsection*
548 \begin_layout Description
549 Action Sets the text class for the current buffer.
552 \begin_layout Description
553 Syntax textclass-apply <TEXTCLASS>
556 \begin_layout Description
557 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
560 \begin_layout Subsection*
564 \begin_layout Description
565 Action Loads information for a textclass from disk.
568 \begin_layout Description
569 Syntax textclass-load <TEXTCLASS>
572 \begin_layout Description
573 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
576 \begin_layout Subsection*
580 \begin_layout Description
581 Action Toggle user-defined (=last-time used) text style.
584 \begin_layout Description
585 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
588 \begin_layout Description
589 Syntax textstyle-apply
592 \begin_layout Description
593 Origin leeming, 12 Mar 2003
596 \begin_layout Subsection*
600 \begin_layout Description
601 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
604 \begin_layout Description
605 Syntax textstyle-update <FONT_INFO>
608 \begin_layout Description
609 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
610 \begin_inset Newline newline
613 Use lyx -dbg action for exact syntax of text-style dialog parameters.
616 \begin_layout Description
617 Origin leeming, 12 Mar 2003
620 \begin_layout Section
621 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
624 \begin_layout Subsection*
628 \begin_layout Description
629 Action Adds an acute accent to the next character typed.
632 \begin_layout Description
636 \begin_layout Subsection*
640 \begin_layout Description
641 Action Adds a breve accent to the next character typed.
644 \begin_layout Description
648 \begin_layout Subsection*
652 \begin_layout Description
653 Action Adds a caron to the next character typed.
656 \begin_layout Description
660 \begin_layout Subsection*
664 \begin_layout Description
665 Action Adds a cedilla to the next character typed.
668 \begin_layout Description
669 Syntax accent-cedilla
672 \begin_layout Subsection*
676 \begin_layout Description
677 Action Adds a circle accent to the next character typed.
680 \begin_layout Description
684 \begin_layout Subsection*
688 \begin_layout Description
689 Action Adds a circumflex to the next character typed.
692 \begin_layout Description
693 Syntax accent-circumflex
696 \begin_layout Subsection*
700 \begin_layout Description
701 Action Adds a dot accent to the next character typed.
704 \begin_layout Description
708 \begin_layout Subsection*
712 \begin_layout Description
713 Action Adds a grave accent to the next character typed.
716 \begin_layout Description
720 \begin_layout Subsection*
721 accent-hungarian-umlaut
724 \begin_layout Description
725 Action Adds a Hungarian umlaut to the next character typed.
728 \begin_layout Description
732 \begin_layout Subsection*
736 \begin_layout Description
737 Action Adds a macron to the next character typed.
740 \begin_layout Description
744 \begin_layout Subsection*
748 \begin_layout Description
749 Action Adds an ogonek accent to the next character typed.
752 \begin_layout Description
756 \begin_layout Subsection*
760 \begin_layout Description
761 Action Adds a perispomeni (Greek circumflex) over the next character typed.
764 \begin_layout Description
765 Syntax accent-perispomeni
768 \begin_layout Subsection*
772 \begin_layout Description
773 Action Adds a tie over the next two character typed.
776 \begin_layout Description
777 Notion The following char will finish the tie.
780 \begin_layout Description
784 \begin_layout Subsection*
788 \begin_layout Description
789 Action Adds a tilde over the next character typed.
792 \begin_layout Description
796 \begin_layout Subsection*
800 \begin_layout Description
801 Action Adds an umlaut over the next character typed.
804 \begin_layout Description
808 \begin_layout Subsection*
812 \begin_layout Description
813 Action Adds a bar under the next character typed.
816 \begin_layout Description
817 Syntax accent-underbar
820 \begin_layout Subsection*
824 \begin_layout Description
825 Action Adds a dot under the next character typed.
828 \begin_layout Description
829 Syntax accent-underdot
832 \begin_layout Subsection*
836 \begin_layout Description
837 Action Accepts all tracked changes in the document.
840 \begin_layout Description
841 Syntax all-changes-accept
844 \begin_layout Description
845 Origin Levon, 16 Oct 2002
848 \begin_layout Subsection*
852 \begin_layout Description
853 Action Rejects all tracked changes in the document.
856 \begin_layout Description
857 Notion Reject does not work recursively; the user may have to repeat the operation.
860 \begin_layout Description
861 Syntax all-changes-reject
864 \begin_layout Description
865 Origin Levon, 16 Oct 2002
868 \begin_layout Subsection*
872 \begin_layout Description
873 Action Start (or remove) Appendix on the given cursor position.
876 \begin_layout Description
880 \begin_layout Description
881 Origin ettrich, 5 May 1998
884 \begin_layout Subsection*
888 \begin_layout Description
889 Action Inserts an argument (short title) inset.
892 \begin_layout Description
893 Syntax argument-insert <argument nr>
896 \begin_layout Description
897 Params <argument nr>: see layout declarations
900 \begin_layout Description
901 Origin vermeer, 12 Aug 2002
904 \begin_layout Subsection*
908 \begin_layout Description
909 Action Adds database, which will be used for bibtex citations.
912 \begin_layout Description
913 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
916 \begin_layout Description
917 Syntax bibtex-database-add <DATABASE-NAME>
920 \begin_layout Description
921 Origin Ale, 30 May 1997
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 deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
936 \begin_layout Description
937 Syntax bibtex-database-del <DATABASE-NAME>
940 \begin_layout Description
941 Origin Ale, 30 May 1997
944 \begin_layout Subsection*
948 \begin_layout Description
949 Action Clears the list of saved bookmarks.
952 \begin_layout Description
953 Syntax bookmark-clear
956 \begin_layout Description
957 Origin bpeng, 31 October 2006
960 \begin_layout Subsection*
964 \begin_layout Description
965 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
968 \begin_layout Description
969 Notion Bookmark 0 has a special purpose. It is automatically set
970 \begin_inset Newline newline
973 1. to the paragraph you are currently editing
974 \begin_inset Newline newline
977 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
978 \begin_inset Newline newline
981 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
984 \begin_layout Description
985 Syntax bookmark-goto <NUMBER>
988 \begin_layout Description
989 Params <NUMBER>: the number of the bookmark to restore.
992 \begin_layout Description
993 Origin Dekel, 27 January 2001
996 \begin_layout Subsection*
1000 \begin_layout Description
1001 Action Save a bookmark.
1004 \begin_layout Description
1005 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.
1008 \begin_layout Description
1009 Syntax bookmark-save <NUMBER>
1012 \begin_layout Description
1013 Params <NUMBER>: the number of the bookmark to save.
1016 \begin_layout Description
1017 Origin Dekel, 27 January 2001
1020 \begin_layout Subsection*
1024 \begin_layout Description
1025 Action Inserts Box inset.
1028 \begin_layout Description
1029 Syntax box-insert [<TYPE>]
1032 \begin_layout Description
1033 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1034 \begin_inset Newline newline
1037 Framed is the default one.
1040 \begin_layout Description
1041 Origin vermeer, 7 Oct 2003
1044 \begin_layout Subsection*
1048 \begin_layout Description
1049 Action Inserts branch inset.
1052 \begin_layout Description
1053 Syntax branch-insert <BRANCH-NAME>
1056 \begin_layout Description
1057 Origin vermeer, 17 Aug 2003
1060 \begin_layout Subsection*
1064 \begin_layout Description
1065 Action Move the cursor to the beginning of the document.
1068 \begin_layout Description
1072 \begin_layout Subsection*
1076 \begin_layout Description
1077 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1080 \begin_layout Description
1081 Syntax buffer-begin-select
1084 \begin_layout Subsection*
1088 \begin_layout Description
1089 Action Move the cursor to the end of the document.
1092 \begin_layout Description
1096 \begin_layout Subsection*
1100 \begin_layout Description
1101 Action Move the cursor to the end of the document adding the traversed text to the selection.
1104 \begin_layout Description
1105 Syntax buffer-end-select
1108 \begin_layout Subsection*
1112 \begin_layout Description
1113 Action Inserts a caption inset.
1116 \begin_layout Description
1117 Syntax caption-insert
1120 \begin_layout Description
1121 Origin Lgb, 18 Jul 2000
1124 \begin_layout Subsection*
1128 \begin_layout Description
1129 Action Moves the cursor to the previous cell inside the table.
1132 \begin_layout Description
1133 Syntax cell-backward
1136 \begin_layout Description
1137 Origin Jug, 22 May 2000
1140 \begin_layout Subsection*
1144 \begin_layout Description
1145 Action Moves the cursor to the next cell inside the table.
1148 \begin_layout Description
1152 \begin_layout Subsection*
1156 \begin_layout Description
1157 Action Splits cell and shifts right part to the next cell (inside the math grid).
1160 \begin_layout Description
1164 \begin_layout Description
1165 Origin Ale, 15 May 1997
1168 \begin_layout Subsection*
1172 \begin_layout Description
1173 Action Accepts tracked change inside the selection.
1176 \begin_layout Description
1177 Syntax change-accept
1180 \begin_layout Description
1181 Origin Levon, 16 Oct 2002
1184 \begin_layout Subsection*
1188 \begin_layout Description
1189 Action Moves the cursor to the position of the next change of the change tracking records.
1192 \begin_layout Description
1196 \begin_layout Description
1197 Origin schmitt, 4 Oct 2006
1200 \begin_layout Subsection*
1204 \begin_layout Description
1205 Action Moves the cursor to the position of the previous change of the change tracking records.
1208 \begin_layout Description
1209 Syntax change-previous
1212 \begin_layout Description
1213 Origin vfr, 4 Apr 2009
1216 \begin_layout Subsection*
1220 \begin_layout Description
1221 Action Rejects tracked change inside the selection.
1224 \begin_layout Description
1225 Syntax change-reject
1228 \begin_layout Description
1229 Origin Levon, 16 Oct 2002
1232 \begin_layout Subsection*
1236 \begin_layout Description
1237 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1240 \begin_layout Description
1241 Syntax changes-merge
1244 \begin_layout Description
1245 Origin Levon, 16 Oct 2002
1248 \begin_layout Subsection*
1252 \begin_layout Description
1253 Action Toggles showing of change tracking in typeset output.
1256 \begin_layout Description
1257 Syntax changes-output
1260 \begin_layout Description
1261 Origin jspitzm, 21 Jan 2005
1264 \begin_layout Subsection*
1268 \begin_layout Description
1269 Action Toggles change tracking to on/off.
1272 \begin_layout Description
1273 Syntax changes-track
1276 \begin_layout Description
1277 Origin levon, 1 Oct 2002
1280 \begin_layout Subsection*
1284 \begin_layout Description
1285 Action Moves the cursor one position logically backwards.
1288 \begin_layout Description
1289 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.
1292 \begin_layout Description
1293 Syntax char-backward
1296 \begin_layout Subsection*
1297 char-backward-select
1300 \begin_layout Description
1301 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1304 \begin_layout Description
1305 Notion See also LFUN_CHAR_BACKWARD.
1308 \begin_layout Description
1309 Syntax char-backward-select
1312 \begin_layout Subsection*
1313 char-delete-backward
1316 \begin_layout Description
1317 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1320 \begin_layout Description
1321 Syntax char-delete-backward
1324 \begin_layout Subsection*
1328 \begin_layout Description
1329 Action Deletes one character in the backward direction (usually the "Delete" key).
1332 \begin_layout Description
1333 Syntax char-delete-forward
1336 \begin_layout Subsection*
1340 \begin_layout Description
1341 Action Moves the cursor one position logically forward.
1344 \begin_layout Description
1345 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.
1348 \begin_layout Description
1352 \begin_layout Subsection*
1356 \begin_layout Description
1357 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1360 \begin_layout Description
1361 Notion See also LFUN_CHAR_FORWARD.
1364 \begin_layout Description
1365 Syntax char-forward-select
1368 \begin_layout Subsection*
1372 \begin_layout Description
1373 Action Moves the cursor one position "to the left".
1376 \begin_layout Description
1377 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.
1380 \begin_layout Description
1384 \begin_layout Subsection*
1388 \begin_layout Description
1389 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1392 \begin_layout Description
1393 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1396 \begin_layout Description
1397 Syntax char-left-select
1400 \begin_layout Subsection*
1404 \begin_layout Description
1405 Action Moves the cursor one position "to the right".
1408 \begin_layout Description
1409 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.
1412 \begin_layout Description
1416 \begin_layout Subsection*
1420 \begin_layout Description
1421 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1424 \begin_layout Description
1425 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1428 \begin_layout Description
1429 Syntax char-right-select
1432 \begin_layout Subsection*
1436 \begin_layout Description
1437 Action Transposes the character at the cursor with the one before it.
1440 \begin_layout Description
1441 Syntax chars-transpose
1444 \begin_layout Description
1445 Origin Lgb, 25 Apr 2001
1448 \begin_layout Subsection*
1452 \begin_layout Description
1453 Action Inserts citation from loaded citation database.
1456 \begin_layout Description
1457 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1460 \begin_layout Description
1461 Params <KEY>: Citation (shortcut listed in available citations).
1462 \begin_inset Newline newline
1465 <TEXT_BEFORE>: text which should appear before citation.
1468 \begin_layout Description
1469 Origin AAS, 97-02-23
1472 \begin_layout Subsection*
1476 \begin_layout Description
1477 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.
1480 \begin_layout Description
1481 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.
1484 \begin_layout Description
1485 Syntax clipboard-paste [<ARG>]
1488 \begin_layout Description
1489 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1492 \begin_layout Description
1493 Origin Georg, 10 Jul 2006
1496 \begin_layout Subsection*
1497 clipboard-paste-simple
1500 \begin_layout Description
1501 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.
1504 \begin_layout Description
1505 Syntax clipboard-paste-simple [<ARG>]
1508 \begin_layout Description
1509 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1512 \begin_layout Subsection*
1516 \begin_layout Description
1517 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1520 \begin_layout Description
1521 Notion Usually bound to M-x shortcut.
1524 \begin_layout Description
1525 Syntax command-execute
1528 \begin_layout Subsection*
1532 \begin_layout Description
1533 Action Try to complete the word or command at the cursor position.
1536 \begin_layout Description
1540 \begin_layout Description
1541 Origin sts, Feb 19 2008
1544 \begin_layout Subsection*
1548 \begin_layout Description
1549 Action Accept suggested completion.
1552 \begin_layout Description
1553 Syntax completion-accept
1556 \begin_layout Description
1557 Origin sanda, Sep 08 2008
1560 \begin_layout Subsection*
1564 \begin_layout Description
1565 Action Try to cancel completion, either the popup or the inline completion.
1568 \begin_layout Description
1569 Syntax completion-cancel
1572 \begin_layout Description
1573 Origin sts, Sep 07 2008
1576 \begin_layout Subsection*
1580 \begin_layout Description
1581 Action Show the inline completion at the cursor position.
1584 \begin_layout Description
1585 Syntax completion-inline
1588 \begin_layout Description
1589 Origin sts, Feb 19 2008
1592 \begin_layout Subsection*
1596 \begin_layout Description
1597 Action Show the completion popup at the cursor position.
1600 \begin_layout Description
1601 Syntax completion-popup
1604 \begin_layout Description
1605 Origin sts, Feb 19 2008
1608 \begin_layout Subsection*
1612 \begin_layout Description
1613 Action Copies the current selection to the clipboard.
1616 \begin_layout Description
1620 \begin_layout Subsection*
1624 \begin_layout Description
1625 Action Cuts to the clipboard.
1628 \begin_layout Description
1632 \begin_layout Subsection*
1636 \begin_layout Description
1637 Action Inserts the current date.
1640 \begin_layout Description
1641 Syntax date-insert [<ARG>]
1644 \begin_layout Description
1645 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.
1648 \begin_layout Description
1649 Origin jdblair, 31 Jan 2000
1652 \begin_layout Subsection*
1656 \begin_layout Description
1657 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1660 \begin_layout Description
1661 Syntax depth-decrement
1664 \begin_layout Subsection*
1668 \begin_layout Description
1669 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1672 \begin_layout Description
1673 Syntax depth-increment
1676 \begin_layout Subsection*
1677 dialog-disconnect-inset
1680 \begin_layout Description
1681 Action Closes opened connection to opened inset.
1684 \begin_layout Description
1685 Notion Connection is used for apply functions.
1688 \begin_layout Description
1689 Syntax dialog-disconnect-inset <INSET-NAME>
1692 \begin_layout Description
1693 Origin leeming, 25 Feb 2003
1696 \begin_layout Subsection*
1700 \begin_layout Description
1701 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1704 \begin_layout Description
1705 Syntax dialog-hide <NAME>
1708 \begin_layout Description
1709 Params See LFUN_DIALOG_SHOW .
1712 \begin_layout Description
1713 Origin leeming, 25 Feb 2003
1716 \begin_layout Subsection*
1720 \begin_layout Description
1721 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1724 \begin_layout Description
1725 Syntax dialog-show <NAME> [<DATA>]
1728 \begin_layout Description
1729 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1730 \begin_inset Newline newline
1733 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1734 \begin_inset Newline newline
1737 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1738 \begin_inset Newline newline
1741 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1742 \begin_inset Newline newline
1745 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1746 \begin_inset Newline newline
1749 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1750 \begin_inset Newline newline
1753 <SPECIAL>: latexlog|vclog
1754 \begin_inset Newline newline
1757 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1760 \begin_layout Description
1761 Origin leeming, 17 Jun 2003
1764 \begin_layout Subsection*
1765 dialog-show-new-inset
1768 \begin_layout Description
1769 Action Shows hidden dialog or create new one for a given inset settings etc.
1772 \begin_layout Description
1773 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1776 \begin_layout Description
1777 Syntax dialog-show-new-inset <NAME> [<DATA>]
1780 \begin_layout Description
1781 Params See LFUN_DIALOG_SHOW .
1784 \begin_layout Description
1785 Origin leeming, 25 Feb 2003
1788 \begin_layout Subsection*
1792 \begin_layout Description
1793 Action Toggles dialog between showed/hidden state.
1796 \begin_layout Description
1797 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1800 \begin_layout Description
1801 Syntax dialog-toggle <NAME> [<DATA>]
1804 \begin_layout Description
1805 Params See LFUN_DIALOG_SHOW .
1808 \begin_layout Description
1809 Origin JSpitzm, 30 Apr 2007
1812 \begin_layout Subsection*
1816 \begin_layout Description
1817 Action Updates the dialog values from the inset/paragraph/document.
1820 \begin_layout Description
1821 Syntax dialog-update <NAME>
1824 \begin_layout Description
1825 Params <NAME>: paragraph|prefs|<INSET>
1826 \begin_inset Newline newline
1832 \begin_layout Description
1833 Origin leeming, 25 Feb 2003
1836 \begin_layout Subsection*
1840 \begin_layout Description
1841 Action Moves the cursor one line in downward direction.
1844 \begin_layout Description
1848 \begin_layout Subsection*
1852 \begin_layout Description
1853 Action Moves the cursor one line in downward direction adding the current position to the selection.
1856 \begin_layout Description
1860 \begin_layout Subsection*
1864 \begin_layout Description
1865 Action Inserts an ERT inset.
1868 \begin_layout Description
1872 \begin_layout Description
1873 Origin Jug, 18 Feb 2000
1876 \begin_layout Subsection*
1880 \begin_layout Description
1881 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1884 \begin_layout Description
1888 \begin_layout Description
1889 Origin Lgb, 17 May 2001
1892 \begin_layout Subsection*
1896 \begin_layout Description
1897 Action Inserts another LyX file.
1900 \begin_layout Description
1901 Syntax file-insert [<FILE>]
1904 \begin_layout Description
1905 Params <FILE>: Filename to be inserted.
1908 \begin_layout Subsection*
1909 file-insert-plaintext
1912 \begin_layout Description
1913 Action Inserts plain text file.
1916 \begin_layout Description
1917 Syntax file-insert-plaintext [<FILE>]
1920 \begin_layout Description
1921 Params <FILE>: Filename to be inserted.
1924 \begin_layout Description
1925 Origin CFO-G, 19 Nov 1997
1928 \begin_layout Subsection*
1929 file-insert-plaintext-para
1932 \begin_layout Description
1933 Action Inserts plain text file as paragraph (i.e. join lines).
1936 \begin_layout Description
1937 Syntax file-insert-plaintext-para [<FILE>]
1940 \begin_layout Description
1941 Params <FILE>: Filename to be inserted.
1944 \begin_layout Description
1945 Origin Levon, 14 Feb 2001
1948 \begin_layout Subsection*
1952 \begin_layout Description
1953 Action Inserts CharStyle, Custom inset or XML short element.
1956 \begin_layout Description
1957 Notion Look into the Customization manual for more information about these elements.
1958 \begin_inset Newline newline
1961 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.
1962 \begin_inset Newline newline
1965 For dissolving the element see LFUN_INSET_DISSOLVE.
1968 \begin_layout Description
1969 Syntax flex-insert Name
1972 \begin_layout Description
1973 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.
1976 \begin_layout Description
1977 Sample flex-insert Code
1980 \begin_layout Subsection*
1984 \begin_layout Description
1985 Action Inserts a float inset.
1988 \begin_layout Description
1989 Syntax float-insert <TYPE>
1992 \begin_layout Description
1993 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1996 \begin_layout Description
1997 Origin Lgb, 27 Jun 2000
2000 \begin_layout Subsection*
2004 \begin_layout Description
2005 Action Inserts the list of floats in the document.
2008 \begin_layout Description
2009 Syntax float-list-insert <TYPE>
2012 \begin_layout Description
2013 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2016 \begin_layout Description
2017 Origin Lgb, 3 May 2001
2020 \begin_layout Subsection*
2024 \begin_layout Description
2025 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2028 \begin_layout Description
2029 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2032 \begin_layout Description
2033 Syntax float-wide-insert <TYPE>
2036 \begin_layout Description
2037 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2040 \begin_layout Description
2041 Origin Lgb, 31 Oct 2001
2044 \begin_layout Subsection*
2048 \begin_layout Description
2049 Action Inserts a footnote inset.
2052 \begin_layout Description
2053 Syntax footnote-insert
2056 \begin_layout Description
2057 Origin Jug, 7 Mar 2000
2060 \begin_layout Subsection*
2064 \begin_layout Description
2065 Action Reloads the image if necessary.
2068 \begin_layout Description
2069 Syntax graphics-reload
2072 \begin_layout Description
2073 Origin vfr, 10 Aug 2009
2076 \begin_layout Subsection*
2080 \begin_layout Description
2081 Action Inserts hyperlinks into the document (clickable in pdf output).
2084 \begin_layout Description
2085 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2088 \begin_layout Description
2089 Syntax href-insert [<TARGET>]
2092 \begin_layout Description
2093 Origin CFO-G, 21 Nov 1997
2096 \begin_layout Subsection*
2100 \begin_layout Description
2101 Action Only active in IPA inset.
2104 \begin_layout Description
2105 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.
2108 \begin_layout Description
2112 \begin_layout Description
2113 Origin spitz, 20 May 2012
2116 \begin_layout Subsection*
2120 \begin_layout Description
2121 Action Inserts Index entry.
2124 \begin_layout Description
2125 Notion It automatically takes the word on the cursor position.
2128 \begin_layout Description
2129 Syntax index-insert [<TYPE:Name>]
2132 \begin_layout Description
2133 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2136 \begin_layout Description
2137 Origin leeming, 3 Aug 2000
2140 \begin_layout Subsection*
2144 \begin_layout Description
2145 Action Inserts list of Index entries on a new page.
2148 \begin_layout Description
2149 Syntax index-print [<TYPE:Name>]
2152 \begin_layout Description
2153 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2156 \begin_layout Description
2157 Origin Lgb, 27 Feb 1997
2160 \begin_layout Subsection*
2164 \begin_layout Description
2165 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2168 \begin_layout Description
2169 Notion Apart from lfun arguments you can use the following method:
2170 \begin_inset Newline newline
2173 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2174 \begin_inset Newline newline
2177 2. select the text and run info-insert lfun.
2180 \begin_layout Description
2181 Syntax info-insert <TYPE> <ARG>
2184 \begin_layout Description
2185 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
2186 \begin_inset Newline newline
2189 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2190 \begin_inset Newline newline
2193 shortcut[s]: name of lfun (e.g math-insert
2196 \begin_inset Newline newline
2199 lyxrc: name of rc_entry (e.g. bind_file)
2200 \begin_inset Newline newline
2203 lyxinfo: "version" - used version of LyX
2204 \begin_inset Newline newline
2207 package: name of latex package (e.g. listings)
2208 \begin_inset Newline newline
2211 textclass: name of textclass (e.g. article)
2212 \begin_inset Newline newline
2215 menu: name of lfun used in menu
2216 \begin_inset Newline newline
2219 icon: icon of lfun used in toolbar or direct icon name
2220 \begin_inset Newline newline
2223 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
2226 \begin_layout Description
2227 Sample command-sequence info-insert buffer path; info-insert buffer name
2230 \begin_layout Description
2231 Origin bpeng, 7 Oct 2007
2234 \begin_layout Subsection*
2238 \begin_layout Description
2239 Action Apply data for an inset.
2242 \begin_layout Description
2243 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.
2246 \begin_layout Description
2247 Syntax inset-apply <ARGS>
2250 \begin_layout Description
2251 Params See LFUN_INSET_INSERT .
2254 \begin_layout Subsection*
2258 \begin_layout Description
2259 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
2262 \begin_layout Description
2266 \begin_layout Description
2267 Origin lasgouttes, 16 Mar 2009
2270 \begin_layout Subsection*
2274 \begin_layout Description
2275 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).
2278 \begin_layout Description
2279 Syntax inset-begin-select
2282 \begin_layout Description
2283 Origin lasgouttes, 16 Mar 2009
2286 \begin_layout Subsection*
2290 \begin_layout Description
2291 Action Copies the inset to the clipboard as a certain type.
2294 \begin_layout Description
2295 Notion Currently used only for InsetInfo where its content is copied as a text.
2298 \begin_layout Description
2299 Syntax inset-copy-as
2302 \begin_layout Description
2303 Origin vfr, 18 Apr 2010
2306 \begin_layout Subsection*
2310 \begin_layout Description
2311 Action Dissolve the current inset into text.
2314 \begin_layout Description
2315 Syntax inset-dissolve [<INSET>]
2318 \begin_layout Description
2319 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.
2320 \begin_inset Newline newline
2323 For values see lyx::InsetLayout::lyxtype_ .
2326 \begin_layout Description
2327 Origin JSpitz, 7 Aug 2006
2330 \begin_layout Subsection*
2334 \begin_layout Description
2335 Action Edit the inset at cursor with an external application, if one is attributed.
2338 \begin_layout Description
2339 Syntax inset-edit [<INSET_PARAMS>]
2342 \begin_layout Description
2343 Params <INSET_PARAMS>: Parameters for the inset.
2344 \begin_inset Newline newline
2347 Currently only the filename will be considered.
2350 \begin_layout Description
2351 Origin JSpitzm, 27 Apr 2006
2354 \begin_layout Subsection*
2358 \begin_layout Description
2359 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
2362 \begin_layout Description
2366 \begin_layout Description
2367 Origin lasgouttes, 16 Mar 2009
2370 \begin_layout Subsection*
2374 \begin_layout Description
2375 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).
2378 \begin_layout Description
2379 Syntax inset-end-select
2382 \begin_layout Description
2383 Origin lasgouttes, 16 Mar 2009
2386 \begin_layout Subsection*
2390 \begin_layout Description
2391 Action Apply the given commands on insets of a given name.
2394 \begin_layout Description
2395 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.
2398 \begin_layout Description
2399 Syntax inset-forall <NAME> <LFUN-COMMAND>
2400 \begin_inset Newline newline
2403 <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.
2406 \begin_layout Description
2407 Sample Remove all index insets:
2408 \begin_inset Newline newline
2411 inset-forall Index char-delete-forward
2412 \begin_inset Newline newline
2415 Close all Notes (also works for a particular branch, for example):
2416 \begin_inset Newline newline
2419 inset-forall Note inset-toggle close
2420 \begin_inset Newline newline
2423 Transform all yellow notes to comments
2424 \begin_inset Newline newline
2427 inset-forall Note:Note inset-modify note Note Comment
2428 \begin_inset Newline newline
2431 Try to put LyX in an infinite loop if there is at least a Note:
2432 \begin_inset Newline newline
2435 inset-forall Note char-backward
2438 \begin_layout Description
2439 Origin lasgouttes, 27 Nov 2009
2442 \begin_layout Subsection*
2446 \begin_layout Description
2447 Action Insert new inset (type given by the parameters).
2450 \begin_layout Description
2451 Syntax inset-insert <INSET> <ARGS>
2454 \begin_layout Description
2455 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2456 \begin_inset Newline newline
2459 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2460 \begin_inset Newline newline
2463 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2466 \begin_layout Description
2467 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2470 \begin_inset Newline newline
2473 where <label name> is the name of the referenced label and <Format> is one of the following:
2474 \begin_inset Newline newline
2478 \begin_inset Newline newline
2481 eqref -- (<reference>)
2482 \begin_inset Newline newline
2486 \begin_inset Newline newline
2489 vpageref -- on <page>
2490 \begin_inset Newline newline
2493 vref -- <reference> on <page>
2494 \begin_inset Newline newline
2497 formatted -- Formatted reference
2500 \begin_layout Subsection*
2504 \begin_layout Description
2505 Action Modify some properties of an inset.
2508 \begin_layout Description
2509 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, index, info, label, listings, newline, newpage, nomencl, note, phantom, ref, space, tabular, vspace, wrap insets.
2512 \begin_layout Description
2513 Syntax inset-modify <INSET> <ARGS>
2514 \begin_inset Newline newline
2517 inset-modify changetype <TYPE>
2520 \begin_layout Description
2521 Sample inset-modify note Note Comment
2522 \begin_inset Newline newline
2525 inset-modify changetype Ovalbox
2528 \begin_layout Subsection*
2532 \begin_layout Description
2533 Action Select all contents of an inset.
2536 \begin_layout Description
2537 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2540 \begin_layout Description
2541 Syntax inset-select-all
2544 \begin_layout Description
2545 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2548 \begin_layout Subsection*
2552 \begin_layout Description
2553 Action Open the inset's properties dialog.
2556 \begin_layout Description
2557 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.
2560 \begin_layout Description
2561 Syntax inset-settings <INSET>
2564 \begin_layout Description
2565 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2566 \begin_inset Newline newline
2569 graphics|href|include|index|index_print|label|line|
2570 \begin_inset Newline newline
2573 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2576 \begin_layout Subsection*
2580 \begin_layout Description
2581 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2584 \begin_layout Description
2585 Syntax inset-toggle [<ARG>]
2588 \begin_layout Description
2589 Params <ARG>: <open|close|toggle|assign>.
2590 \begin_inset Newline newline
2593 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2594 \begin_inset Newline newline
2597 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2600 \begin_layout Description
2601 Origin lasgouttes, 19 Jul 2001
2604 \begin_layout Subsection*
2608 \begin_layout Description
2609 Action Inserts an IPA inset.
2612 \begin_layout Description
2616 \begin_layout Description
2617 Origin spitz, 05 Mar 2012
2620 \begin_layout Subsection*
2624 \begin_layout Description
2625 Action Inserts special IPA macros into the document.
2628 \begin_layout Description
2629 Syntax ipamacro-insert <CHAR>
2632 \begin_layout Description
2633 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2636 \begin_layout Description
2637 Origin JSpitzm, 22 Aug 2012
2640 \begin_layout Subsection*
2644 \begin_layout Description
2645 Action Turn off the loaded keyboard map.
2648 \begin_layout Description
2652 \begin_layout Subsection*
2656 \begin_layout Description
2657 Action Turn on the primary keyboard map.
2660 \begin_layout Description
2661 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.
2662 \begin_inset Newline newline
2665 The language is to be set in the Preferences dialog.
2668 \begin_layout Description
2669 Syntax keymap-primary
2672 \begin_layout Subsection*
2676 \begin_layout Description
2677 Action Turn on the secondary keyboard map.
2680 \begin_layout Description
2681 Syntax keymap-secondary
2684 \begin_layout Subsection*
2688 \begin_layout Description
2689 Action Toggles keyboard maps (first/second/off).
2692 \begin_layout Description
2693 Syntax keymap-toggle
2696 \begin_layout Description
2697 Origin leeming, 30 Mar 2004
2700 \begin_layout Subsection*
2701 label-copy-as-reference
2704 \begin_layout Description
2705 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2708 \begin_layout Description
2709 Syntax copy-label-as-reference <LABEL>
2712 \begin_layout Description
2713 Params <LABEL>: The label to copy (for multi-line math)
2716 \begin_layout Description
2717 Origin sts, 16 Nov 2008
2720 \begin_layout Subsection*
2724 \begin_layout Description
2725 Action Goto a label.
2728 \begin_layout Description
2729 Syntax label-goto [<LABEL>]
2732 \begin_layout Description
2733 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.
2736 \begin_layout Description
2737 Origin Ale, 6 Aug 1997
2740 \begin_layout Subsection*
2744 \begin_layout Description
2745 Action Inserts label to text or displayed formula.
2748 \begin_layout Description
2749 Syntax label-insert [<LABEL>]
2752 \begin_layout Description
2753 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2756 \begin_layout Subsection*
2757 label-insert-as-reference
2760 \begin_layout Description
2761 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2764 \begin_layout Description
2765 Syntax label-insert-as-reference
2768 \begin_layout Description
2769 Origin vfr, 7 Apr 2009
2772 \begin_layout Subsection*
2776 \begin_layout Description
2777 Action Set language from the current cursor position.
2780 \begin_layout Description
2781 Syntax language <LANG> [set]
2784 \begin_layout Description
2785 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).
2788 \begin_layout Description
2789 Origin Dekel, 2 Mar 2000
2792 \begin_layout Subsection*
2796 \begin_layout Description
2797 Action Move the cursor to the beginning of the (screen) line.
2800 \begin_layout Description
2804 \begin_layout Subsection*
2808 \begin_layout Description
2809 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2812 \begin_layout Description
2813 Syntax line-begin-select
2816 \begin_layout Subsection*
2820 \begin_layout Description
2821 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2824 \begin_layout Description
2825 Syntax line-delete-forward
2828 \begin_layout Subsection*
2832 \begin_layout Description
2833 Action Move the cursor to the end of the (screen) line.
2836 \begin_layout Description
2840 \begin_layout Subsection*
2844 \begin_layout Description
2845 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2848 \begin_layout Description
2849 Syntax line-end-select
2852 \begin_layout Subsection*
2856 \begin_layout Description
2857 Action Inserts a new listings inset.
2860 \begin_layout Description
2861 Syntax listing-insert
2864 \begin_layout Description
2865 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2868 \begin_layout Subsection*
2872 \begin_layout Description
2873 Action Inserts a marginal note.
2876 \begin_layout Description
2877 Syntax marginalnote-insert
2880 \begin_layout Description
2881 Origin Lgb, 26 Jun 2000
2884 \begin_layout Subsection*
2888 \begin_layout Description
2889 Action Disable selecting of text-region.
2892 \begin_layout Description
2896 \begin_layout Subsection*
2900 \begin_layout Description
2901 Action Enable selecting of text-region.
2904 \begin_layout Description
2905 Notion After enabling you can simply move arrow keys to get selected region.
2908 \begin_layout Description
2912 \begin_layout Subsection*
2916 \begin_layout Description
2917 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2920 \begin_layout Description
2924 \begin_layout Description
2925 Origin Andre, May 5 2006
2928 \begin_layout Subsection*
2932 \begin_layout Description
2933 Action Inserts a line break or new line.
2936 \begin_layout Description
2937 Syntax newline-insert [<ARG>]
2940 \begin_layout Description
2941 Params <ARG>: <newline|linebreak> default: newline
2944 \begin_layout Description
2945 Origin JSpitzm, 25 Mar 2008
2948 \begin_layout Subsection*
2952 \begin_layout Description
2953 Action Inserts a new page.
2956 \begin_layout Description
2957 Syntax newpage-insert <ARG>
2960 \begin_layout Description
2961 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2964 \begin_layout Description
2965 Origin uwestoehr, 24 Nov 2007
2968 \begin_layout Subsection*
2972 \begin_layout Description
2973 Action Inserts Nomenclature entry.
2976 \begin_layout Description
2977 Notion It automatically takes the word on the cursor position if no symbol is given.
2980 \begin_layout Description
2981 Syntax nomencl-insert [<SYMBOL>]
2984 \begin_layout Description
2985 Origin Ugras, 4 Nov 2006
2988 \begin_layout Subsection*
2992 \begin_layout Description
2993 Action Inserts list of Nomenclature entries.
2996 \begin_layout Description
2997 Syntax nomenclature-print
3000 \begin_layout Description
3001 Origin Ugras, 4 Nov 2006
3004 \begin_layout Subsection*
3008 \begin_layout Description
3009 Action Inserts Note on the current cursor position, move selection inside the inset.
3012 \begin_layout Description
3013 Syntax note-insert [<TYPE>]
3016 \begin_layout Description
3017 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3020 \begin_layout Subsection*
3024 \begin_layout Description
3025 Action Moves the cursor to the beginning of next Note inset.
3028 \begin_layout Description
3032 \begin_layout Subsection*
3036 \begin_layout Description
3037 Action Move the current group in the downward direction in the structure of the document.
3040 \begin_layout Description
3041 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3044 \begin_layout Description
3048 \begin_layout Description
3049 Origin Vermeer, 23 Mar 2006
3052 \begin_layout Subsection*
3056 \begin_layout Description
3057 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3060 \begin_layout Description
3061 Notion Part -> Chapter -> Section -> etc.
3064 \begin_layout Description
3068 \begin_layout Description
3069 Origin Vermeer, 23 Mar 2006
3072 \begin_layout Subsection*
3076 \begin_layout Description
3077 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3080 \begin_layout Description
3081 Notion Part <- Chapter <- Section <- etc.
3084 \begin_layout Description
3088 \begin_layout Description
3089 Origin Vermeer, 23 Mar 2006
3092 \begin_layout Subsection*
3096 \begin_layout Description
3097 Action Move the current group in the upward direction in the structure of the document.
3100 \begin_layout Description
3101 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3104 \begin_layout Description
3108 \begin_layout Description
3109 Origin Vermeer, 23 Mar 2006
3112 \begin_layout Subsection*
3116 \begin_layout Description
3117 Action Breaks the current paragraph at the current location.
3120 \begin_layout Description
3121 Notion Removes the selection.
3124 \begin_layout Description
3125 Syntax paragraph-break [<LAYOUT>]
3128 \begin_layout Description
3129 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3132 \begin_layout Subsection*
3136 \begin_layout Description
3137 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3140 \begin_layout Description
3141 Syntax paragraph-down
3144 \begin_layout Description
3145 Origin Asger, 1 Oct 1996
3148 \begin_layout Subsection*
3149 paragraph-down-select
3152 \begin_layout Description
3153 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3156 \begin_layout Description
3157 Syntax paragraph-down-select
3160 \begin_layout Description
3161 Origin Asger, 1 Oct 1996
3164 \begin_layout Subsection*
3168 \begin_layout Description
3169 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
3172 \begin_layout Description
3173 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).
3176 \begin_layout Description
3177 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3180 \begin_layout Description
3181 Params <PAR_ID_NUMBER>: paragraph id
3182 \begin_inset Newline newline
3185 <POSITION_IN_PAR>: desired position within the paragraph
3188 \begin_layout Description
3189 Origin Dekel, 26 Aug 2000
3192 \begin_layout Subsection*
3196 \begin_layout Description
3197 Action Moves the current paragraph downwards in the document.
3200 \begin_layout Description
3201 Syntax paragraph-move-down
3204 \begin_layout Description
3205 Origin Edwin, 8 Apr 2006
3208 \begin_layout Subsection*
3212 \begin_layout Description
3213 Action Moves the current paragraph upwards in the document.
3216 \begin_layout Description
3217 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3220 \begin_layout Description
3221 Syntax paragraph-move-up
3224 \begin_layout Description
3225 Origin Edwin, 8 Apr 2006
3228 \begin_layout Subsection*
3232 \begin_layout Description
3233 Action Change paragraph settings.
3236 \begin_layout Description
3237 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.
3240 \begin_layout Description
3241 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3244 \begin_layout Description
3254 \begin_inset Newline newline
3259 paragraph_spacing default|single|onehalf|double|other SIZE
3260 \begin_inset Newline newline
3265 align block|left|right|center|default
3266 \begin_inset Newline newline
3271 labelwidthstring WIDTH|
3276 \begin_layout Description
3277 Origin rgh, Aug 15 2007
3280 \begin_layout Subsection*
3281 paragraph-params-apply
3284 \begin_layout Description
3285 Action Change paragraph settings.
3288 \begin_layout Description
3289 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3292 \begin_layout Description
3293 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3296 \begin_layout Description
3297 Params For parameters see LFUN_PARAGRAPH_PARAMS
3300 \begin_layout Description
3301 Origin leeming, 30 Mar 2004
3304 \begin_layout Subsection*
3308 \begin_layout Description
3309 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3312 \begin_layout Description
3316 \begin_layout Description
3317 Origin Asger, 1 Oct 1996
3320 \begin_layout Subsection*
3324 \begin_layout Description
3325 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3328 \begin_layout Description
3329 Syntax paragraph-up-select
3332 \begin_layout Description
3333 Origin Asger, 1 Oct 1996
3336 \begin_layout Subsection*
3340 \begin_layout Description
3341 Action Pastes material (text or picture) from the active clipboard.
3344 \begin_layout Description
3345 Syntax paste [<TYPE>|<NUM>]
3348 \begin_layout Description
3349 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3350 \begin_inset Newline newline
3353 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3356 \begin_layout Subsection*
3360 \begin_layout Description
3361 Action Inserts phantom on the current cursor position, move selection inside the inset.
3364 \begin_layout Description
3365 Syntax phantom-insert [<TYPE>]
3368 \begin_layout Description
3369 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3372 \begin_layout Description
3373 Origin uwestoehr, 30 Jan 2009
3376 \begin_layout Subsection*
3380 \begin_layout Description
3381 Action Inserts a new preview inset.
3384 \begin_layout Description
3385 Syntax preview-insert
3388 \begin_layout Description
3389 Origin vfr, 28 Mar 2010
3392 \begin_layout Subsection*
3393 primary-selection-paste
3396 \begin_layout Description
3397 Action Pastes the currently selected text.
3400 \begin_layout Description
3401 Notion Primary selection mechanism is linux-only thing.
3404 \begin_layout Description
3405 Syntax primary-selection-paste [<ARG>]
3408 \begin_layout Description
3409 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3412 \begin_layout Subsection*
3416 \begin_layout Description
3417 Action Inserts quotes according to the type and quote-language preference.
3420 \begin_layout Description
3421 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
3424 \begin_layout Description
3425 Syntax quote-insert [<TYPE>]
3428 \begin_layout Description
3429 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
3432 \begin_layout Subsection*
3436 \begin_layout Description
3437 Action Redoes the last thing undone.
3440 \begin_layout Description
3444 \begin_layout Subsection*
3448 \begin_layout Description
3449 Action Go to the next label or cross-reference.
3452 \begin_layout Description
3453 Syntax reference-next
3456 \begin_layout Description
3457 Origin Dekel, 14 Jan 2001
3460 \begin_layout Subsection*
3464 \begin_layout Description
3465 Action Repeat the given command.
3468 \begin_layout Description
3469 Syntax repeat <COUNT> <LFUN-COMMAND>
3472 \begin_layout Description
3473 Origin Andre, 27 Oct 2003
3476 \begin_layout Subsection*
3480 \begin_layout Description
3481 Action Moves the cursor one page in downward direction.
3484 \begin_layout Description
3488 \begin_layout Subsection*
3492 \begin_layout Description
3493 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3496 \begin_layout Description
3497 Syntax screen-down-select
3500 \begin_layout Subsection*
3504 \begin_layout Description
3505 Action Recenters the screen on the current cursor position.
3508 \begin_layout Description
3509 Syntax screen-recenter
3512 \begin_layout Subsection*
3516 \begin_layout Description
3517 Action Repositions the screen such that the cursor is visible.
3520 \begin_layout Description
3521 Syntax screen-show-cursor
3524 \begin_layout Description
3525 Origin vfr, 25 Mar 2009
3528 \begin_layout Subsection*
3532 \begin_layout Description
3533 Action Moves the cursor one page in upward direction.
3536 \begin_layout Description
3540 \begin_layout Subsection*
3544 \begin_layout Description
3545 Action Moves the cursor one page in upward direction adding the current position to the selection.
3548 \begin_layout Description
3549 Syntax screen-up-select
3552 \begin_layout Subsection*
3556 \begin_layout Description
3557 Action Inserts a subscript or superscript inset.
3560 \begin_layout Description
3561 Syntax script-insert <TYPE>
3564 \begin_layout Description
3565 Params <TYPE>: subscript|superscript
3568 \begin_layout Description
3569 Origin Georg, 23 Nov 2010
3572 \begin_layout Subsection*
3576 \begin_layout Description
3577 Action Scroll the buffer view.
3580 \begin_layout Description
3581 Notion Only scrolls the screen up or down; does not move the cursor.
3584 \begin_layout Description
3585 Syntax scroll <TYPE> <QUANTITY>
3588 \begin_layout Description
3589 Params <TYPE>: line|page
3590 \begin_inset Newline newline
3593 <QUANTITY>: up|down|<number>
3596 \begin_layout Description
3597 Origin Abdel, Dec 27 2007
3600 \begin_layout Subsection*
3604 \begin_layout Description
3605 Action Select the whole section.
3608 \begin_layout Description
3609 Notion The cursor should be in a section heading before calling this lfun.
3612 \begin_layout Description
3613 Syntax section-select
3616 \begin_layout Description
3617 Origin vfr, 05 May 2009
3620 \begin_layout Subsection*
3624 \begin_layout Description
3625 Action Pastes the internal selection text in permanent selection.
3628 \begin_layout Description
3629 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3632 \begin_layout Description
3633 Syntax selection-paste
3636 \begin_layout Description
3637 Origin lasgouttes, 14 Jan 2009
3640 \begin_layout Subsection*
3644 \begin_layout Description
3645 Action Inserts an environment separator or latex paragraph break.
3648 \begin_layout Description
3649 Syntax separator-insert [<ARG>]
3652 \begin_layout Description
3653 Params <ARG>: <plain|parbreak|latexpar> default: plain
3656 \begin_layout Description
3657 Origin ef, 2 May 2014
3660 \begin_layout Subsection*
3664 \begin_layout Description
3665 Action Set the group for the graphics inset on the cursor position.
3668 \begin_layout Description
3669 Syntax set-graphics-group [<GROUP>]
3672 \begin_layout Description
3673 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3676 \begin_layout Description
3677 Origin sanda, 6 May 2008
3680 \begin_layout Subsection*
3684 \begin_layout Description
3685 Action Inserts one of horizontal space insets.
3688 \begin_layout Description
3689 Syntax space-insert <NAME> [<LEN>]
3692 \begin_layout Description
3693 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3694 \begin_inset Newline newline
3697 Only in math mode: med and thick.
3698 \begin_inset Newline newline
3701 <LEN>: length for custom spaces (hspace, hspace* for protected)
3704 \begin_layout Description
3705 Origin JSpitzm, 20 May 2003, Mar 17 2008
3708 \begin_layout Subsection*
3712 \begin_layout Description
3713 Action Inserts various characters into the document.
3716 \begin_layout Description
3717 Syntax specialchar-insert <CHAR>
3720 \begin_layout Description
3721 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3724 \begin_layout Description
3725 Origin JSpitzm, 6 Dec 2007
3728 \begin_layout Subsection*
3732 \begin_layout Description
3733 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3736 \begin_layout Description
3737 Syntax spelling-add [<STRING>] [<LANG>]
3740 \begin_layout Description
3741 Params <WORD>: word to add <LANG>: language name (see file languages)
3744 \begin_layout Description
3745 Origin JSpitzm, 18 Jan 2010
3748 \begin_layout Subsection*
3749 spelling-continuously
3752 \begin_layout Description
3753 Action Toggle continuous spell checking.
3756 \begin_layout Description
3757 Syntax spelling-continuously
3760 \begin_layout Description
3761 Origin vfr, 24 March 2013
3764 \begin_layout Subsection*
3768 \begin_layout Description
3769 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.
3772 \begin_layout Description
3773 Syntax spelling-ignore [<WORD>] [<LANG>]
3776 \begin_layout Description
3777 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3780 \begin_layout Description
3781 Origin JSpitzm, 18 Jan 2010
3784 \begin_layout Subsection*
3788 \begin_layout Description
3789 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3792 \begin_layout Description
3793 Syntax spelling-remove [<STRING>] [<LANG>]
3796 \begin_layout Description
3797 Params <WORD>: word to remove <LANG>: language name (see file languages)
3800 \begin_layout Description
3801 Origin SWitt, 28 July 2010
3804 \begin_layout Subsection*
3808 \begin_layout Description
3809 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3812 \begin_layout Description
3813 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.
3816 \begin_layout Description
3820 \begin_layout Description
3821 Origin vfr, Sep 30 2008
3824 \begin_layout Subsection*
3828 \begin_layout Description
3829 Action Insert a tab into a listings inset.
3832 \begin_layout Description
3833 Notion It also works on a selection.
3836 \begin_layout Description
3840 \begin_layout Description
3841 Origin vfr, Sep 30 2008
3844 \begin_layout Subsection*
3848 \begin_layout Description
3849 Action Modify properties of tabulars and table-like math environments.
3852 \begin_layout Description
3853 Syntax tabular-feature <FEATURE> [<ARG>]
3856 \begin_layout Description
3857 Params Generally see LFUN_INSET_INSERT for further details.
3858 \begin_inset Newline newline
3861 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
3862 \begin_inset Newline newline
3865 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
3866 \begin_inset Newline newline
3869 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3870 \begin_inset Newline newline
3873 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
3874 \begin_inset Newline newline
3877 valign-top|valign-bottom|valign-middle|longtabular-align-left|
3878 \begin_inset Newline newline
3881 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
3882 \begin_inset Newline newline
3885 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
3886 \begin_inset Newline newline
3889 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
3890 \begin_inset Newline newline
3893 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
3894 \begin_inset Newline newline
3897 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
3898 \begin_inset Newline newline
3901 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
3902 \begin_inset Newline newline
3905 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3906 \begin_inset Newline newline
3909 set-special-column|set-special-multicolumn|set-special-multirow|
3910 \begin_inset Newline newline
3913 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
3914 \begin_inset Newline newline
3917 set-interline-space|set-border-lines|tabular-valign-top|
3918 \begin_inset Newline newline
3921 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
3922 \begin_inset Newline newline
3925 Various math-environment features are handled as well, e.g. add-vline-left/right for
3926 \begin_inset Newline newline
3929 the Grid/Array environment.
3930 \begin_inset Newline newline
3933 <ARG>: additional argument for some commands, use debug mode to explore its values.
3936 \begin_layout Description
3937 Origin gm, 10 Dec 2015
3940 \begin_layout Subsection*
3944 \begin_layout Description
3945 Action Inserts table into the document.
3948 \begin_layout Description
3949 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
3952 \begin_layout Description
3953 Syntax tabular-insert [<ROWS> <COLUMNS>]
3956 \begin_layout Description
3957 Params In case no arguments are given show insert dialog.
3960 \begin_layout Description
3961 Origin Jug, 12 Apr 2000
3964 \begin_layout Subsection*
3968 \begin_layout Description
3969 Action Look up thesaurus entries with respect to the word under the cursor.
3972 \begin_layout Description
3973 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
3976 \begin_layout Description
3977 Params <STRING>: word to look up <LANG>: language (see file languages)
3980 \begin_layout Description
3981 Origin Levon, 20 Jul 2001
3984 \begin_layout Subsection*
3988 \begin_layout Description
3989 Action Undoes the last edit.
3992 \begin_layout Description
3996 \begin_layout Subsection*
4000 \begin_layout Description
4001 Action Inserts a single unicode character.
4004 \begin_layout Description
4005 Syntax unicode-insert <CHAR>
4008 \begin_layout Description
4009 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
4012 \begin_layout Description
4013 Sample unicode-insert 0x0100
4016 \begin_layout Description
4017 Origin Lgb, 22 Oct 2006
4020 \begin_layout Subsection*
4024 \begin_layout Description
4025 Action Moves the cursor one line in upward direction.
4028 \begin_layout Description
4032 \begin_layout Subsection*
4036 \begin_layout Description
4037 Action Moves the cursor one line in upward direction adding the current position to the selection.
4040 \begin_layout Description
4044 \begin_layout Subsection*
4048 \begin_layout Description
4049 Action Moves the cursor to the logically previous beginning of a word.
4052 \begin_layout Description
4053 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.
4056 \begin_layout Description
4057 Syntax word-backward
4060 \begin_layout Subsection*
4061 word-backward-select
4064 \begin_layout Description
4065 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4068 \begin_layout Description
4069 Notion See also LFUN_WORD_BACKWARD.
4072 \begin_layout Description
4073 Syntax word-backward-select
4076 \begin_layout Subsection*
4080 \begin_layout Description
4081 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4084 \begin_layout Description
4085 Syntax word-capitalize [<SEL_TYPE>]
4088 \begin_layout Description
4089 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.
4092 \begin_layout Subsection*
4093 word-delete-backward
4096 \begin_layout Description
4097 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4100 \begin_layout Description
4101 Syntax word-delete-backward
4104 \begin_layout Subsection*
4108 \begin_layout Description
4109 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4112 \begin_layout Description
4113 Syntax word-delete-forward
4116 \begin_layout Subsection*
4120 \begin_layout Description
4121 Action Search for next occurrence of a string.
4124 \begin_layout Description
4125 Syntax word-find [<DATA>]
4128 \begin_layout Description
4129 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).
4132 \begin_layout Description
4133 Origin Andre, Jan 7 2004
4136 \begin_layout Subsection*
4140 \begin_layout Description
4141 Action Search for a given string in backward direction.
4144 \begin_layout Description
4145 Notion Case sensitive, match words. If no argument given, last search repeated.
4148 \begin_layout Description
4149 Syntax word-find-backward [<STRING>]
4152 \begin_layout Description
4153 Origin Etienne, 20 Feb 1998
4156 \begin_layout Subsection*
4160 \begin_layout Description
4161 Action Search for a given string in forward direction.
4164 \begin_layout Description
4165 Notion Case sensitive, match words. If no argument given, last search repeated.
4168 \begin_layout Description
4169 Syntax word-find-forward [<STRING>]
4172 \begin_layout Description
4173 Origin Etienne, 16 Feb 1998
4176 \begin_layout Subsection*
4180 \begin_layout Description
4181 Action Search for next occurrence of a pattern.
4184 \begin_layout Description
4185 Syntax word-findadv [<DATA>]
4188 \begin_layout Description
4189 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).
4192 \begin_layout Description
4193 Origin Tommaso, Nov 15 2007
4196 \begin_layout Subsection*
4200 \begin_layout Description
4201 Action Moves the cursor to the logically next beginning of a word.
4204 \begin_layout Description
4205 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.
4208 \begin_layout Description
4212 \begin_layout Subsection*
4216 \begin_layout Description
4217 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4220 \begin_layout Description
4221 Notion See also LFUN_WORD_FORWARD.
4224 \begin_layout Description
4225 Syntax word-forward-select
4228 \begin_layout Subsection*
4232 \begin_layout Description
4233 Action Moves the cursor to the next beginning of a word "on the left".
4236 \begin_layout Description
4237 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.
4240 \begin_layout Description
4244 \begin_layout Description
4245 Origin dov, 28 Oct 2007
4248 \begin_layout Subsection*
4252 \begin_layout Description
4253 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4256 \begin_layout Description
4257 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4260 \begin_layout Description
4261 Syntax word-left-select
4264 \begin_layout Description
4265 Origin dov, 28 Oct 2007
4268 \begin_layout Subsection*
4272 \begin_layout Description
4273 Action Change the words in the selection or word at cursor position to lower case.
4276 \begin_layout Description
4277 Syntax word-lowcase [<SEL_TYPE>]
4280 \begin_layout Description
4281 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.
4284 \begin_layout Subsection*
4288 \begin_layout Description
4289 Action Replace a string in the document.
4292 \begin_layout Description
4293 Syntax word-replace [<DATA>]
4296 \begin_layout Description
4297 Params <DATA>: data is of the form "<replace>
4298 \begin_inset Newline newline
4302 \begin_inset Newline newline
4305 <casesensitive> <matchword> <all> <forward> <findnext>"
4308 \begin_layout Description
4309 Origin Andre, Jan 7 2004
4312 \begin_layout Subsection*
4316 \begin_layout Description
4317 Action Moves the cursor to the next beginning of a word "on the right".
4320 \begin_layout Description
4321 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.
4324 \begin_layout Description
4328 \begin_layout Description
4329 Origin dov, 28 Oct 2007
4332 \begin_layout Subsection*
4336 \begin_layout Description
4337 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4340 \begin_layout Description
4341 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4344 \begin_layout Description
4345 Syntax word-right-select
4348 \begin_layout Description
4349 Origin dov, 28 Oct 2007
4352 \begin_layout Subsection*
4356 \begin_layout Description
4357 Action Puts the word where the cursor stands into the selection.
4360 \begin_layout Description
4364 \begin_layout Description
4365 Origin Andre, 11 Sep 2002
4368 \begin_layout Subsection*
4372 \begin_layout Description
4373 Action Change the words in the selection or word at cursor position to upper case.
4376 \begin_layout Description
4377 Syntax word-upcase [<SEL_TYPE>]
4380 \begin_layout Description
4381 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.
4384 \begin_layout Subsection*
4388 \begin_layout Description
4389 Action Inserts floats wrapped by the text around.
4392 \begin_layout Description
4393 Syntax wrap-insert <TYPE>
4396 \begin_layout Description
4397 Params <TYPE>: table|figure
4400 \begin_layout Description
4401 Origin Dekel, 7 Apr 2002
4404 \begin_layout Section
4405 Math Editor Functions
4408 \begin_layout Subsection*
4409 in-mathmacrotemplate
4412 \begin_layout Description
4413 Action Only active in Math Macro definition.
4416 \begin_layout Description
4417 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.
4420 \begin_layout Description
4421 Syntax in-mathmacrotemplate
4424 \begin_layout Description
4425 Origin sts, 06 January 2008
4428 \begin_layout Subsection*
4432 \begin_layout Description
4433 Action Inserts an extended matrix as provided by the amsmath package.
4436 \begin_layout Description
4437 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4440 \begin_layout Description
4441 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'.
4444 \begin_layout Description
4445 Sample math-ams-matrix 3 3 bmatrix
4448 \begin_layout Subsection*
4452 \begin_layout Description
4453 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4456 \begin_layout Description
4457 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4460 \begin_layout Description
4461 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4462 \begin_inset Newline newline
4465 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4468 \begin_layout Description
4469 Sample math-bigdelim "Bigl" "
4476 \begin_layout Description
4477 Origin Enrico & Georg, 7 May 2006
4480 \begin_layout Subsection*
4484 \begin_layout Description
4485 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4488 \begin_layout Description
4489 Syntax math-delim [<LEFT>] [<RIGHT>]
4492 \begin_layout Description
4493 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.
4496 \begin_layout Description
4497 Sample math-delim { rangle
4500 \begin_layout Description
4501 Origin Alejandro, 18 Jun 1996
4504 \begin_layout Subsection*
4508 \begin_layout Description
4509 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4512 \begin_layout Description
4513 Syntax math-display [<ARG>]
4516 \begin_layout Description
4517 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4520 \begin_layout Description
4521 Origin Alejandro, 18 Jun 1996
4524 \begin_layout Subsection*
4528 \begin_layout Description
4529 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4532 \begin_layout Description
4533 Notion Selection can be used to determine the input for the external program.
4536 \begin_layout Description
4537 Syntax math-extern <LANG> [<COMMAND>]
4540 \begin_layout Description
4541 Params <LANG>: octave|maxima|maple|mathematica|script
4542 \begin_inset Newline newline
4545 where "script" stands for the external script (normalized expression will be passed)
4548 \begin_layout Description
4549 Sample math-extern maple simplify
4552 \begin_layout Description
4553 Origin Andre, 24 Apr 2001
4556 \begin_layout Subsection*
4560 \begin_layout Description
4561 Action Changes the text style used in math.
4564 \begin_layout Description
4565 Syntax math-font-style <STYLE>
4568 \begin_layout Description
4569 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4570 \begin_inset Newline newline
4573 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4576 \begin_layout Description
4577 Origin vfr, 9 jan 2009
4580 \begin_layout Subsection*
4584 \begin_layout Description
4585 Action Inserts math objects and symbols.
4588 \begin_layout Description
4589 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4591 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
4593 frac{x}{y}" replaces "abc" with "
4595 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.
4598 \begin_layout Description
4599 Syntax math-insert <ARG>
4602 \begin_layout Description
4603 Params <ARG>: Symbol or LaTeX code to be inserted.
4606 \begin_layout Subsection*
4610 \begin_layout Description
4611 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.
4614 \begin_layout Description
4615 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4618 \begin_layout Description
4619 Syntax math-limits [<STATE>]
4622 \begin_layout Description
4623 Params <STATE>: limits|nolimits
4626 \begin_layout Subsection*
4630 \begin_layout Description
4631 Action Inserts a math macro definition at the cursor position in the text.
4634 \begin_layout Description
4635 Syntax math-macro <NAME> [<NARGS>] [def]
4638 \begin_layout Description
4639 Params <NAME>: The name of the macro, e.g. "mymacro".
4640 \begin_inset Newline newline
4643 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4646 \begin_layout Description
4647 Origin ale, 10 May 1997; sts, 21 Dec 2007
4650 \begin_layout Subsection*
4651 math-macro-add-greedy-optional-param
4654 \begin_layout Description
4655 Action Add a greedy optional parameter.
4658 \begin_layout Description
4659 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4662 \begin_layout Description
4663 Syntax math-macro-add-greedy-optional-param
4666 \begin_layout Description
4667 Origin sts, 06 January 2008
4670 \begin_layout Subsection*
4671 math-macro-add-optional-param
4674 \begin_layout Description
4675 Action Add an optional parameter.
4678 \begin_layout Description
4679 Notion Insert an optional parameter just behind the already existing optional parameters.
4682 \begin_layout Description
4683 Syntax math-macro-add-optional-param
4686 \begin_layout Description
4687 Origin sts, 06 January 2008
4690 \begin_layout Subsection*
4691 math-macro-add-param
4694 \begin_layout Description
4695 Action Add a parameter.
4698 \begin_layout Description
4699 Notion Add a parameter to a Math Macro.
4702 \begin_layout Description
4703 Syntax math-macro-add-param <NUM>
4706 \begin_layout Description
4707 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.
4710 \begin_layout Description
4711 Origin sts, 06 January 2008
4714 \begin_layout Subsection*
4715 math-macro-append-greedy-param
4718 \begin_layout Description
4719 Action Append a greedy parameter.
4722 \begin_layout Description
4723 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
4726 \begin_layout Description
4727 Syntax math-macro-append-greedy-param
4730 \begin_layout Description
4731 Origin sts, 06 January 2008
4734 \begin_layout Subsection*
4738 \begin_layout Description
4739 Action Fold a Math Macro.
4742 \begin_layout Description
4743 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
4748 \begin_layout Description
4749 Syntax math-macro-fold
4752 \begin_layout Description
4753 Origin sts, 06 January 2008
4756 \begin_layout Subsection*
4757 math-macro-make-nonoptional
4760 \begin_layout Description
4761 Action Make a parameter non-optional.
4764 \begin_layout Description
4765 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.
4768 \begin_layout Description
4769 Syntax math-macro-make-nonoptional
4772 \begin_layout Description
4773 Origin sts, 06 January 2008
4776 \begin_layout Subsection*
4777 math-macro-make-optional
4780 \begin_layout Description
4781 Action Make a parameter optional.
4784 \begin_layout Description
4785 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
4788 \begin_layout Description
4789 Syntax math-macro-make-optional
4792 \begin_layout Description
4793 Origin sts, 06 January 2008
4796 \begin_layout Subsection*
4797 math-macro-remove-greedy-param
4800 \begin_layout Description
4801 Action Remove a greedy parameter.
4804 \begin_layout Description
4805 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.
4808 \begin_layout Description
4809 Syntax math-macro-remove-greedy-param
4812 \begin_layout Description
4813 Origin sts, 06 January 2008
4816 \begin_layout Subsection*
4817 math-macro-remove-optional-param
4820 \begin_layout Description
4821 Action Remove the last optional parameter.
4824 \begin_layout Description
4825 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
4828 \begin_layout Description
4829 Syntax math-macro-remove-optional-param
4832 \begin_layout Description
4833 Origin sts, 06 January 2008
4836 \begin_layout Subsection*
4837 math-macro-remove-param
4840 \begin_layout Description
4841 Action Remove the last parameter.
4844 \begin_layout Description
4845 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
4848 \begin_layout Description
4849 Syntax math-macro-remove-param <NUM>
4852 \begin_layout Description
4853 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
4856 \begin_layout Description
4857 Origin sts, 06 January 2008
4860 \begin_layout Subsection*
4864 \begin_layout Description
4865 Action Unfold a Math Macro.
4868 \begin_layout Description
4869 Notion Unfold the Math Macro the cursor is in, i.e. display it as
4874 \begin_layout Description
4875 Syntax math-macro-unfold
4878 \begin_layout Description
4879 Origin sts, 06 January 2008
4882 \begin_layout Subsection*
4886 \begin_layout Description
4887 Action Inserts a matrix.
4890 \begin_layout Description
4891 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
4894 \begin_layout Description
4895 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).
4898 \begin_layout Description
4899 Sample math-matrix 3 3 bccc
4902 \begin_layout Subsection*
4906 \begin_layout Description
4907 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.
4910 \begin_layout Description
4911 Notion If there is some selected text, it puts the text inside created math box.
4914 \begin_layout Description
4915 Syntax math-mode [on|<ARG>]
4918 \begin_layout Description
4919 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
4920 \begin_inset Newline newline
4923 "on": allow only entering of math mode from text mode.
4926 \begin_layout Description
4927 Origin Alejandro, 4 Jun 1996
4930 \begin_layout Subsection*
4934 \begin_layout Description
4935 Action Mutates the type of math inset to the newly selected one.
4938 \begin_layout Description
4939 Syntax math-mutate <TYPE>
4942 \begin_layout Description
4943 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
4946 \begin_layout Description
4947 Origin Andre, 23 May 2001
4950 \begin_layout Subsection*
4951 math-number-line-toggle
4954 \begin_layout Description
4955 Action Toggles numbering of the current formula line.
4958 \begin_layout Description
4959 Notion Must be in display formula mode.
4962 \begin_layout Description
4963 Syntax math-number-line-toggle
4966 \begin_layout Description
4967 Origin Alejandro, 18 Jun 1996
4970 \begin_layout Subsection*
4974 \begin_layout Description
4975 Action Toggles numbering/labeling of the current formula.
4978 \begin_layout Description
4979 Notion Must be in display formula mode.
4982 \begin_layout Description
4983 Syntax math-number-toggle
4986 \begin_layout Description
4987 Origin Alejandro, 4 Jun 1996
4990 \begin_layout Subsection*
4994 \begin_layout Description
4995 Action Changes arbitrarily the size used by math fonts inside a context.
4998 \begin_layout Description
4999 Notion Provides an interface to the LaTeX math mode font size commands.
5002 \begin_layout Description
5003 Syntax math-size <STYLE>
5006 \begin_layout Description
5018 \begin_layout Description
5019 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5022 \begin_layout Subsection*
5026 \begin_layout Description
5027 Action Inserts space into math expression.
5030 \begin_layout Description
5031 Notion Use spacebar after entering this space to change type of space.
5034 \begin_layout Description
5035 Syntax math-space [<TYPE>] [<LEN>]
5038 \begin_layout Description
5039 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5040 \begin_inset Newline newline
5043 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5044 \begin_inset Newline newline
5047 custom space: hspace
5048 \begin_inset Newline newline
5051 "," used by default.
5052 \begin_inset Newline newline
5055 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5056 \begin_inset Newline newline
5059 <LEN>: length for custom spaces (hspace)
5062 \begin_layout Description
5063 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5066 \begin_layout Subsection*
5070 \begin_layout Description
5071 Action Enters subscript expression in math expression.
5074 \begin_layout Description
5075 Syntax math-subscript
5078 \begin_layout Description
5079 Origin vermeer, 12 Dec 2001
5082 \begin_layout Subsection*
5086 \begin_layout Description
5087 Action Enters superscript expression in math expression.
5090 \begin_layout Description
5091 Syntax math-superscript
5094 \begin_layout Description
5095 Origin vermeer, 12 Dec 2001
5098 \begin_layout Subsection*
5102 \begin_layout Description
5103 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5106 \begin_layout Description
5107 Notion If there is any selected text, then it is moved inside the created regexp inset.
5110 \begin_layout Description
5111 Syntax regexp-mode [<ARG>]
5114 \begin_layout Description
5115 Params <ARG>: eventual argument (regular expression).
5118 \begin_layout Description
5119 Origin Tommaso, 4 Oct 2008
5122 \begin_layout Section
5123 Buffer Fuctions (File and Window related)
5126 \begin_layout Subsection*
5130 \begin_layout Description
5131 Action Activate the branch.
5134 \begin_layout Description
5135 Syntax branch-activate <BRANCH>
5138 \begin_layout Description
5139 Params <BRANCH>: The branch to activate
5142 \begin_layout Description
5143 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5144 \begin_inset Newline newline
5147 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5150 \begin_layout Description
5151 Origin rgh, 27 May 2008
5154 \begin_layout Subsection*
5158 \begin_layout Description
5159 Action Add a branch to the buffer's BranchList.
5162 \begin_layout Description
5163 Syntax branch-add <BRANCH>
5166 \begin_layout Description
5167 Params <BRANCH>: Name of the branch to add
5170 \begin_layout Description
5171 Origin spitz, 7 Jul 2009
5174 \begin_layout Subsection*
5178 \begin_layout Description
5179 Action Create new branch and directly put the branch inset into the document.
5182 \begin_layout Description
5183 Syntax branch-add-insert [<NAME>]
5186 \begin_layout Description
5187 Params <NAME>: Branch name. If it is not specified, you will be asked.
5190 \begin_layout Description
5191 Origin sanda, 10 Jul 2009
5194 \begin_layout Subsection*
5198 \begin_layout Description
5199 Action De-activate the branch.
5202 \begin_layout Description
5203 Syntax branch-deactivate <BRANCH>
5206 \begin_layout Description
5207 Params <BRANCH>: The branch to deactivate
5210 \begin_layout Description
5211 Origin rgh, 27 May 2008
5214 \begin_layout Subsection*
5218 \begin_layout Description
5219 Action Toggles inversion status of branch inset.
5222 \begin_layout Description
5223 Syntax branch-invert
5226 \begin_layout Description
5227 Origin rgheck, 12 July 2016
5230 \begin_layout Subsection*
5231 branch-master-activate
5234 \begin_layout Description
5235 Action Activate the branch in the master buffer.
5238 \begin_layout Description
5239 Syntax branch-master-activate <BRANCH>
5242 \begin_layout Description
5243 Params <BRANCH>: The branch to activate
5246 \begin_layout Description
5247 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5248 \begin_inset Newline newline
5251 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5254 \begin_layout Description
5255 Origin spitz, 30 Sep 2012
5258 \begin_layout Subsection*
5259 branch-master-deactivate
5262 \begin_layout Description
5263 Action De-activate the branch in the master buffer.
5266 \begin_layout Description
5267 Syntax branch-master-deactivate <BRANCH>
5270 \begin_layout Description
5271 Params <BRANCH>: The branch to deactivate
5274 \begin_layout Description
5275 Origin spitz, 30 Sep 2012
5278 \begin_layout Subsection*
5282 \begin_layout Description
5283 Action Rename all branches of a given name in a document.
5286 \begin_layout Description
5287 Syntax branches-rename <OLDNAME> <NEWNAME>
5290 \begin_layout Description
5291 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5294 \begin_layout Description
5295 Origin spitz, 9 Jul 2009
5298 \begin_layout Subsection*
5302 \begin_layout Description
5303 Action Saves the current buffer to a temporary file.
5306 \begin_layout Description
5307 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5310 \begin_layout Description
5311 Syntax buffer-auto-save
5314 \begin_layout Subsection*
5318 \begin_layout Description
5319 Action Loads the given child document.
5322 \begin_layout Description
5323 Notion The current document is treated as a parent.
5326 \begin_layout Description
5327 Syntax buffer-child-open <FILE>
5330 \begin_layout Description
5331 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5334 \begin_layout Description
5335 Origin Ale, 28 May 1997
5338 \begin_layout Subsection*
5342 \begin_layout Description
5343 Action Runs chktex for the current document.
5346 \begin_layout Description
5347 Syntax buffer-chktex
5350 \begin_layout Description
5351 Origin Asger, 30 Oct 1997
5354 \begin_layout Subsection*
5358 \begin_layout Description
5359 Action Closes the current buffer.
5362 \begin_layout Description
5363 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5366 \begin_layout Description
5370 \begin_layout Subsection*
5374 \begin_layout Description
5375 Action Closes all buffers.
5378 \begin_layout Description
5379 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5382 \begin_layout Description
5383 Syntax buffer-close-all
5386 \begin_layout Subsection*
5390 \begin_layout Description
5391 Action Exports the current buffer (document) to the given format.
5394 \begin_layout Description
5395 Syntax buffer-export <FORMAT> [<DEST>]
5398 \begin_layout Description
5399 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.
5400 \begin_inset Newline newline
5403 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. <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.
5406 \begin_layout Description
5407 Origin Lgb, 29 Jul 1997
5410 \begin_layout Subsection*
5414 \begin_layout Description
5415 Action Opens a dialog for exporting the current buffer.
5418 \begin_layout Description
5419 Syntax buffer-export-as [<FORMAT>]
5422 \begin_layout Description
5423 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.
5426 \begin_layout Description
5427 Sample buffer-export-as pdf2
5430 \begin_layout Description
5431 Origin tommaso, 6 Oct 2011
5434 \begin_layout Subsection*
5435 buffer-export-custom
5438 \begin_layout Description
5439 Action Exports the current buffer (document) from the given format using the given command on it.
5442 \begin_layout Description
5443 Syntax buffer-export-custom <FORMAT> <COMMAND>
5446 \begin_layout Description
5447 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5448 \begin_inset Newline newline
5451 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5454 \begin_layout Description
5455 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5458 \begin_layout Description
5459 Origin leeming, 27 Mar 2004
5462 \begin_layout Subsection*
5466 \begin_layout Description
5467 Action Applies a command to all non-hidden buffers.
5470 \begin_layout Description
5471 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5474 \begin_layout Description
5475 Syntax buffer-forall <LFUN-COMMAND>
5478 \begin_layout Description
5479 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5482 \begin_layout Description
5483 Sample Close all Notes in buffers:
5484 \begin_inset Newline newline
5487 buffer-forall inset-forall Note inset-toggle close
5488 \begin_inset Newline newline
5491 Toggle change tracking on buffers:
5492 \begin_inset Newline newline
5495 buffer-forall changes-track
5496 \begin_inset Newline newline
5499 Toggle read-only for buffers:
5500 \begin_inset Newline newline
5503 buffer-forall buffer-toggle-read-only
5504 \begin_inset Newline newline
5507 Show statistics for individual buffers:
5508 \begin_inset Newline newline
5511 buffer-forall statistics
5512 \begin_inset Newline newline
5515 Activate the branch named "Solutions" in buffers:
5516 \begin_inset Newline newline
5519 buffer-forall branch-activate Solutions
5520 \begin_inset Newline newline
5523 Export buffers to PDF (pdflatex):
5524 \begin_inset Newline newline
5527 buffer-forall buffer-export pdf2
5528 \begin_inset Newline newline
5534 \begin_layout Description
5535 Origin skostysh, 20 Jul 2012
5538 \begin_layout Subsection*
5542 \begin_layout Description
5543 Action Import a given file as a lyx document.
5546 \begin_layout Description
5547 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.
5550 \begin_layout Description
5551 Syntax buffer-import <FORMAT> [<FILE>]
5554 \begin_layout Description
5555 Origin Asger, 24 Jul 1998
5558 \begin_layout Subsection*
5562 \begin_layout Description
5563 Action Set language of the current document.
5566 \begin_layout Description
5567 Syntax buffer-language <LANG>
5570 \begin_layout Description
5571 Params <LANG>: language name. See lib/languages for list.
5574 \begin_layout Description
5575 Origin leeming, 30 Mar 2004
5578 \begin_layout Subsection*
5582 \begin_layout Description
5583 Action Moves the current tab one spot to the right.
5586 \begin_layout Description
5587 Syntax buffer-move-next
5590 \begin_layout Description
5591 Origin skostysh, 7 Apr 2015
5594 \begin_layout Subsection*
5595 buffer-move-previous
5598 \begin_layout Description
5599 Action Moves the current tab one spot to the left.
5602 \begin_layout Description
5603 Syntax buffer-move-previous
5606 \begin_layout Description
5607 Origin skostysh, 7 Apr 2015
5610 \begin_layout Subsection*
5614 \begin_layout Description
5615 Action Creates a new buffer (that is, document) and switches to it.
5618 \begin_layout Description
5619 Notion Implicit path can be set in Preferences dialog.
5622 \begin_layout Description
5623 Syntax buffer-new [<FILE>]
5626 \begin_layout Description
5627 Params <FILE>: filename of created file with absolute path.
5630 \begin_layout Subsection*
5634 \begin_layout Description
5635 Action Creates a new buffer (that is, document) from a template.
5638 \begin_layout Description
5639 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5642 \begin_layout Description
5643 Syntax buffer-new-template [<FILE>]
5646 \begin_layout Description
5647 Params <FILE>: filename of created file with absolute path.
5650 \begin_layout Subsection*
5654 \begin_layout Description
5655 Action Switch to the next opened document.
5658 \begin_layout Description
5659 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
5662 \begin_layout Description
5666 \begin_layout Subsection*
5670 \begin_layout Description
5671 Action Apply the given settings to the current document.
5674 \begin_layout Description
5675 Syntax buffer-params-apply [<ARGS>]
5678 \begin_layout Description
5679 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5682 \begin_layout Description
5683 Origin leeming, 30 Mar 2004
5686 \begin_layout Subsection*
5690 \begin_layout Description
5691 Action Switch to the previous opened document.
5694 \begin_layout Description
5695 Syntax buffer-previous
5698 \begin_layout Subsection*
5702 \begin_layout Description
5703 Action Reverts opened document.
5706 \begin_layout Description
5707 Syntax buffer-reload
5710 \begin_layout Description
5711 Origin Asger, 2 Feb 1997
5714 \begin_layout Subsection*
5715 buffer-save-as-default
5718 \begin_layout Description
5719 Action Save the current document settings as default.
5722 \begin_layout Description
5723 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5726 \begin_layout Description
5727 Syntax buffer-save-as-default [<ARGS>]
5730 \begin_layout Description
5731 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5734 \begin_layout Description
5735 Origin leeming, 30 Mar 2004
5738 \begin_layout Subsection*
5742 \begin_layout Description
5743 Action Display and switch to the given buffer.
5746 \begin_layout Description
5747 Syntax buffer-switch <BUFFER>
5750 \begin_layout Description
5751 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
5754 \begin_layout Subsection*
5755 buffer-toggle-compression
5758 \begin_layout Description
5759 Action Toggles compression of the current document on/off.
5762 \begin_layout Description
5763 Syntax buffer-toggle-compression
5766 \begin_layout Description
5767 Origin bpeng, 27 Apr 2006
5770 \begin_layout Subsection*
5771 buffer-toggle-read-only
5774 \begin_layout Description
5775 Action Toggle editing mode of the current document between read/write and read-only.
5778 \begin_layout Description
5779 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.
5782 \begin_layout Description
5783 Syntax buffer-toggle-read-only
5786 \begin_layout Description
5787 Origin Lgb, 27 May 1997
5790 \begin_layout Subsection*
5794 \begin_layout Description
5795 Action Exports the current document and put the result into the temporary directory.
5798 \begin_layout Description
5799 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).
5802 \begin_layout Description
5803 Syntax buffer-update [<FORMAT>]
5806 \begin_layout Description
5807 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.
5810 \begin_layout Description
5811 Origin Dekel, 5 Aug 2000
5814 \begin_layout Subsection*
5818 \begin_layout Description
5819 Action Displays current buffer in chosen format.
5822 \begin_layout Description
5823 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.
5826 \begin_layout Description
5827 Syntax buffer-view [<FORMAT>]
5830 \begin_layout Description
5831 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.
5834 \begin_layout Subsection*
5838 \begin_layout Description
5839 Action Opens the file that was created from last preview of this buffer.
5842 \begin_layout Description
5843 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.
5846 \begin_layout Description
5847 Syntax buffer-view-cache
5850 \begin_layout Subsection*
5854 \begin_layout Description
5855 Action Saves the current buffer.
5858 \begin_layout Description
5859 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.
5862 \begin_layout Description
5866 \begin_layout Subsection*
5870 \begin_layout Description
5871 Action Save all changed documents.
5874 \begin_layout Description
5875 Syntax buffer-write-all
5878 \begin_layout Description
5879 Origin rgh, gpothier 6 Aug 2007
5882 \begin_layout Subsection*
5886 \begin_layout Description
5887 Action Rename and save current buffer.
5890 \begin_layout Description
5891 Syntax buffer-write-as <FILENAME>
5894 \begin_layout Description
5895 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
5898 \begin_layout Subsection*
5902 \begin_layout Description
5903 Action Increases the zoom of the screen fonts.
5906 \begin_layout Description
5907 Syntax buffer-zoom-in [<ZOOM>]
5910 \begin_layout Description
5911 Params <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
5914 \begin_layout Description
5915 Origin vfr, 30 Mar 2009
5918 \begin_layout Subsection*
5922 \begin_layout Description
5923 Action Decreases the zoom of the screen fonts.
5926 \begin_layout Description
5927 Syntax buffer-zoom-out [<ZOOM>]
5930 \begin_layout Description
5931 Params <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
5934 \begin_layout Description
5935 Origin vfr, 30 Mar 2009
5938 \begin_layout Subsection*
5942 \begin_layout Description
5943 Action Generates the code (literate programming).
5946 \begin_layout Description
5947 Notion Latex file with extension
5949 literate_extension is generated. Then LyX invokes
5951 build_command (with a default of ``make'') to generate the code and
5953 build_error_filter to process the compilation error messages.
5954 \begin_inset Newline newline
5957 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:
5958 \begin_inset Newline newline
5963 build_command "my_script my_arguments"
5964 \begin_inset Newline newline
5969 build_error_filter differs from the
5971 literate_error_filter only in that the former will identify error messages from your compiler.
5974 \begin_layout Description
5975 Syntax build-program
5978 \begin_layout Subsection*
5982 \begin_layout Description
5983 Action Open LyX document.
5986 \begin_layout Description
5987 Syntax file-open [<FILE>]
5990 \begin_layout Description
5991 Params <FILE>: Filename to be opened.
5994 \begin_layout Subsection*
5998 \begin_layout Description
5999 Action Open the given help file according to the language setting.
6002 \begin_layout Description
6003 Syntax help-open <FILE>[.lyx]
6006 \begin_layout Description
6007 Params <FILE>: any document from (/usr/share/)doc directory.
6010 \begin_layout Description
6011 Origin Jug, 27 Jun 1999
6014 \begin_layout Subsection*
6018 \begin_layout Description
6019 Action Terminates the current LyX instance.
6022 \begin_layout Description
6023 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6026 \begin_layout Description
6030 \begin_layout Subsection*
6031 master-buffer-update
6034 \begin_layout Description
6035 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6038 \begin_layout Description
6039 Syntax master-buffer-update [<FORMAT>]
6042 \begin_layout Description
6043 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.
6046 \begin_layout Description
6047 Origin Tommaso, 20 Sep 2007
6050 \begin_layout Subsection*
6054 \begin_layout Description
6055 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6058 \begin_layout Description
6059 Syntax master-buffer-view [<FORMAT>]
6062 \begin_layout Description
6063 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.
6066 \begin_layout Description
6067 Origin Tommaso, 20 Sep 2007
6070 \begin_layout Subsection*
6074 \begin_layout Description
6075 Action Opens the menu given by its name.
6078 \begin_layout Description
6079 Syntax menu-open <NAME>
6082 \begin_layout Description
6083 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6086 \begin_layout Subsection*
6090 \begin_layout Description
6091 Action Close the current tab group.
6094 \begin_layout Description
6095 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6098 \begin_layout Description
6099 Syntax tab-group-close
6102 \begin_layout Description
6103 Origin Abdel, 21 Feb 2008
6106 \begin_layout Subsection*
6110 \begin_layout Description
6111 Action Toggles visibility of a given toolbar between on/off/auto.
6114 \begin_layout Description
6115 Notion Skipping "auto" when allowauto is false.
6118 \begin_layout Description
6119 Syntax toolbar-toggle <NAME> [allowauto]
6122 \begin_layout Description
6123 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6124 \begin_inset Newline newline
6127 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6130 \begin_layout Description
6131 Origin Edwin, 21 May 2007
6134 \begin_layout Subsection*
6138 \begin_layout Description
6139 Action Various UI visibility-toggling actions.
6142 \begin_layout Description
6143 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6146 \begin_layout Description
6147 Params statusbar : Toggle visibility of the statusbar.
6148 \begin_inset Newline newline
6151 menubar : Toggle visibility of the menubar.
6152 \begin_inset Newline newline
6155 scrollbar : Toggle visibility of the scrollbar.
6156 \begin_inset Newline newline
6159 frame : Toggle visibility of the frames around editing window.
6160 \begin_inset Newline newline
6163 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.
6166 \begin_layout Description
6167 Origin sanda, 9 Feb 2007
6170 \begin_layout Subsection*
6174 \begin_layout Description
6175 Action Close the current document work area.
6178 \begin_layout Description
6179 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6182 \begin_layout Description
6186 \begin_layout Description
6187 Origin Tommaso, 15 Sep 2012
6190 \begin_layout Subsection*
6194 \begin_layout Description
6195 Action Creates another split view of current buffer.
6198 \begin_layout Description
6199 Notion All split views act in the same way independently.
6202 \begin_layout Description
6203 Syntax view-split <vertical|horizontal>
6206 \begin_layout Description
6207 Params horizontal : The work areas are laid out side by side.
6208 \begin_inset Newline newline
6211 vertical : The work areas laid out vertically.
6214 \begin_layout Description
6215 Origin Abdel, 20 Feb 2008
6218 \begin_layout Subsection*
6222 \begin_layout Description
6223 Action Closes the current LyX window.
6226 \begin_layout Description
6230 \begin_layout Description
6231 Origin Abdel, 23 Oct 2006
6234 \begin_layout Subsection*
6238 \begin_layout Description
6239 Action Creates new empty LyX window.
6242 \begin_layout Description
6243 Notion Already opened documents from the previous window can be found under View menu.
6246 \begin_layout Description
6247 Syntax window-new [<GEOMETRY>]
6250 \begin_layout Description
6251 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6254 \begin_layout Description
6255 Origin Abdel, 21 Oct 2006
6258 \begin_layout Section
6259 System Functions (Preferences, LyX Server etc.)
6262 \begin_layout Subsection*
6263 buffer-toggle-output-sync
6266 \begin_layout Description
6267 Action Toggles including of resources for forward/reverse search of the given document.
6270 \begin_layout Description
6271 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6274 \begin_layout Description
6275 Syntax buffer-toggle-output-sync
6278 \begin_layout Description
6279 Origin sanda, 25 May 2010
6282 \begin_layout Subsection*
6286 \begin_layout Description
6287 Action Executes a command defined in a .def file.
6290 \begin_layout Description
6291 Notion The definitions are by default read from lib/commands/default.def.
6292 \begin_inset Newline newline
6295 A .def file allows to define a command with
6297 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).
6299 def_file "FileName" allows to include another .def file.
6300 \begin_inset Newline newline
6303 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.
6306 \begin_layout Description
6310 \begin_layout Description
6311 Params <NAME>: Name of the command that must be called.
6314 \begin_layout Description
6315 Origin broider, 2 Oct 2007
6318 \begin_layout Subsection*
6322 \begin_layout Description
6323 Action Cancels sequence prepared by LFUN_META_PREFIX .
6326 \begin_layout Description
6330 \begin_layout Subsection*
6331 command-alternatives
6334 \begin_layout Description
6335 Action Runs the first listed command that is enabled.
6338 \begin_layout Description
6339 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6342 \begin_layout Description
6343 Syntax command-alternatives <CMDS>
6346 \begin_layout Description
6347 Params <CMDS>: Sequence of commands separated by semicolons.
6350 \begin_layout Description
6351 Sample command-alternatives completion-accept;cell-forward
6354 \begin_layout Description
6355 Origin rgh, 24 September 2008
6358 \begin_layout Subsection*
6362 \begin_layout Description
6363 Action Run more commands (LFUN and its parameters) in a sequence.
6366 \begin_layout Description
6367 Syntax command-sequence <CMDS>
6370 \begin_layout Description
6371 Params <CMDS>: Sequence of commands separated by semicolons.
6374 \begin_layout Description
6375 Sample command-sequence cut; ert-insert; self-insert
6377 ; paste; self-insert {}; inset-toggle;
6380 \begin_layout Description
6381 Origin Andre, 11 Nov 1999
6384 \begin_layout Subsection*
6385 cursor-follows-scrollbar-toggle
6388 \begin_layout Description
6389 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6392 \begin_layout Description
6393 Syntax toggle-cursor-follows-scrollbar
6396 \begin_layout Description
6397 Origin ARRae, 2 Dec 1997
6400 \begin_layout Subsection*
6404 \begin_layout Description
6405 Action Set debug output level.
6408 \begin_layout Description
6409 Syntax debug-level-set <LEVEL>
6412 \begin_layout Description
6413 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.
6416 \begin_layout Description
6417 Origin sanda, 28 Dec 2009
6420 \begin_layout Subsection*
6424 \begin_layout Description
6425 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6428 \begin_layout Description
6429 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6432 \begin_layout Description
6433 Syntax forward-search
6436 \begin_layout Description
6437 Origin sanda, 14 Apr 2010
6440 \begin_layout Subsection*
6444 \begin_layout Description
6445 Action Apply the given settings to user preferences.
6448 \begin_layout Description
6449 Syntax lyxrc-apply <SETTINGS>
6452 \begin_layout Description
6453 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.
6456 \begin_layout Subsection*
6460 \begin_layout Description
6461 Action Shows message in statusbar (for script purposes).
6464 \begin_layout Description
6465 Syntax message <STRING>
6468 \begin_layout Description
6469 Origin Lgb, 8 Apr 2001
6472 \begin_layout Subsection*
6476 \begin_layout Description
6477 Action Simulate halting Meta key (Alt key on PCs).
6480 \begin_layout Description
6481 Notion Used for buffer edition not for GUI control.
6484 \begin_layout Description
6488 \begin_layout Subsection*
6492 \begin_layout Description
6493 Action Save user preferences.
6496 \begin_layout Description
6497 Syntax preferences-save
6500 \begin_layout Description
6501 Origin Lgb, 27 Nov 1999
6504 \begin_layout Subsection*
6508 \begin_layout Description
6509 Action Reconfigure the automatic settings.
6512 \begin_layout Description
6516 \begin_layout Description
6517 Origin Asger, 14 Feb 1997
6520 \begin_layout Subsection*
6524 \begin_layout Description
6525 Action Returns path and file name of the currently edited document.
6528 \begin_layout Description
6529 Syntax server-get-filename
6532 \begin_layout Subsection*
6536 \begin_layout Description
6537 Action Returns the current layout (that is environment) name on the cursor position.
6540 \begin_layout Description
6541 Syntax server-get-layout
6544 \begin_layout Subsection*
6545 server-get-statistics
6548 \begin_layout Description
6549 Action Returns the statistics (number of words and characters) in the document or in the given selection.
6552 \begin_layout Description
6553 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6556 \begin_layout Description
6557 Syntax server-get-statistics [<TYPE>]
6560 \begin_layout Description
6561 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
6562 \begin_inset Newline newline
6566 \begin_inset Newline newline
6569 chars: count characters.
6570 \begin_inset Newline newline
6573 chars-space: count characters and spaces.
6576 \begin_layout Description
6577 Origin brokenclock, Oct 10 2014
6580 \begin_layout Subsection*
6584 \begin_layout Description
6585 Action Returns the coordinates of cursor position in the editing area.
6588 \begin_layout Description
6589 Syntax server-get-xy
6592 \begin_layout Subsection*
6593 server-goto-file-row
6596 \begin_layout Description
6597 Action Sets the cursor position in LyX based on the row number of generated TeX file.
6600 \begin_layout Description
6601 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).
6604 \begin_layout Description
6605 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
6608 \begin_layout Description
6609 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.
6610 \begin_inset Newline newline
6613 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).
6614 \begin_inset Newline newline
6617 .ext: extensions will be automatically replaced by .lyx.
6618 \begin_inset Newline newline
6621 <ROW_NUMBER> The row number of the LaTeX file to which to go.
6624 \begin_layout Description
6625 Sample server-goto-file-row /home/user/example.lyx 41
6626 \begin_inset Newline newline
6629 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
6632 \begin_layout Description
6633 Origin Edmar, 23 Dec 1998
6636 \begin_layout Subsection*
6640 \begin_layout Description
6641 Action Sends notify message about the last key-sequence to client.
6644 \begin_layout Description
6645 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
6648 \begin_layout Description
6649 Syntax server-notify
6652 \begin_layout Subsection*
6656 \begin_layout Description
6657 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
6660 \begin_layout Description
6661 Syntax server-set-xy <X> <Y>
6664 \begin_layout Subsection*
6668 \begin_layout Description
6669 Action Set the given LyX color to the color defined by the X11 name given.
6672 \begin_layout Description
6673 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
6676 \begin_layout Description
6677 Syntax set-color <LYX_NAME> <X11_NAME>
6680 \begin_layout Description
6681 Origin SLior, 11 Jun 2000
6684 \begin_layout Subsection*
6688 \begin_layout Description
6689 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
6692 \begin_layout Description
6693 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6696 \begin_layout Description
6700 \begin_layout Description
6701 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6704 \begin_layout Subsection*
6708 \begin_layout Description
6709 Action Checks-in/commits the changes of the registered file to the repository.
6712 \begin_layout Description
6713 Notion In RCS case this also unlocks the file.
6716 \begin_layout Description
6720 \begin_layout Description
6721 Origin Lgb, 1 Jul 1997
6724 \begin_layout Subsection*
6728 \begin_layout Description
6729 Action Checks-out the document for edit (and locks it in some cases).
6732 \begin_layout Description
6736 \begin_layout Description
6737 Origin Lgb, 1 Jul 1997
6740 \begin_layout Subsection*
6744 \begin_layout Description
6745 Action Executes external command. This command is intended to support additional VCS commands.
6748 \begin_layout Description
6749 Syntax vc-command <FLAG> <PATH> <COMMAND>
6752 \begin_layout Description
6753 Params <FLAG>: Flags for the command can be combined together.
6754 \begin_inset Newline newline
6757 U - dUmmy - no flags
6758 \begin_inset Newline newline
6761 D - Doc - need document loaded to proceed
6762 \begin_inset Newline newline
6765 I - dIrty - mark document dirty
6766 \begin_inset Newline newline
6769 R - Reload - ensure that the document is saved and reload it after command execution
6770 \begin_inset Newline newline
6773 M - Message - ask for input string (commit message)
6774 \begin_inset Newline newline
6777 <PATH>: path where to start. $$p will be replaced by the current document path.
6778 \begin_inset Newline newline
6781 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
6784 \begin_layout Description
6785 Sample vc-command DR $$p "svn up"
6788 \begin_layout Description
6789 Origin sanda, 13 Jan 2009
6792 \begin_layout Subsection*
6796 \begin_layout Description
6797 Action Compares two revisions of the same file under version control.
6800 \begin_layout Description
6801 Syntax vc-compare [<REV1>] [<REV2>]
6804 \begin_layout Description
6805 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
6806 \begin_inset Newline newline
6809 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
6810 \begin_inset Newline newline
6814 \begin_inset Newline newline
6817 <REV2>: Newer file. Used only if REV1 > 0.
6818 \begin_inset Newline newline
6821 If no parameter is given, interactive dialog will be shown.
6824 \begin_layout Description
6825 Sample Compare current document against last commit
6826 \begin_inset Newline newline
6830 \begin_inset Newline newline
6833 Compare current document against current revision - 5 commits
6834 \begin_inset Newline newline
6838 \begin_inset Newline newline
6841 Compare revisions 120 and 155
6842 \begin_inset Newline newline
6848 \begin_layout Description
6849 Origin sanda, 12 Feb 2010
6852 \begin_layout Subsection*
6856 \begin_layout Description
6857 Action Copies the document to another name.
6860 \begin_layout Description
6861 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.
6864 \begin_layout Description
6865 Syntax vc-copy <FILENAME>
6868 \begin_layout Description
6869 Params <FILENAME>: New name of the document.
6870 \begin_inset Newline newline
6873 A file dialog is opened if no filename is given.
6876 \begin_layout Description
6877 Origin gb, 05 Feb 2013
6880 \begin_layout Subsection*
6884 \begin_layout Description
6885 Action Toggles the locking property of the edited file.
6888 \begin_layout Description
6889 Notion This is currently implemented only for SVN.
6892 \begin_layout Description
6893 Syntax vc-locking-toggle
6896 \begin_layout Description
6897 Origin sanda, 25 Jun 2009
6900 \begin_layout Subsection*
6904 \begin_layout Description
6905 Action Register the document as an file inside version control system.
6908 \begin_layout Description
6909 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
6910 \begin_inset Newline newline
6913 See LyX Additional Features Manual (Version Control Chapter) for additional information.
6916 \begin_layout Description
6920 \begin_layout Description
6921 Origin Lgb, 1 Jul 1997
6924 \begin_layout Subsection*
6928 \begin_layout Description
6929 Action Renames the document to another name.
6932 \begin_layout Description
6933 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.
6936 \begin_layout Description
6937 Syntax vc-rename <FILENAME>
6940 \begin_layout Description
6941 Params <FILENAME>: New name of the document.
6942 \begin_inset Newline newline
6945 A file dialog is opened if no filename is given.
6948 \begin_layout Description
6949 Origin gb, 05 Feb 2013
6952 \begin_layout Subsection*
6956 \begin_layout Description
6957 Action Update the local archive directory in which resides the current document with the remote repository.
6960 \begin_layout Description
6961 Syntax vc-repo-update
6964 \begin_layout Description
6965 Origin sanda, 16 Oct 2009
6968 \begin_layout Subsection*
6972 \begin_layout Description
6973 Action Reverts the document to the last check-in/commit in VCS.
6976 \begin_layout Description
6980 \begin_layout Description
6981 Origin Lgb, 1 Jul 1997
6984 \begin_layout Subsection*
6988 \begin_layout Description
6989 Action Undo last check-in.
6992 \begin_layout Description
6993 Notion This is currently implemented only for RCS.
6996 \begin_layout Description
7000 \begin_layout Description
7001 Origin Lgb, 1 Jul 1997
7004 \begin_layout Section
7005 Hidden Functions (not listed for configuration)
7008 \begin_layout Subsection*
7012 \begin_layout Description
7013 Action Return the current key sequence and available options as a string.
7016 \begin_layout Description
7017 Notion No options are added if no current map exists.
7018 \begin_inset Newline newline
7021 This is probably usable only with connection to lyxserver.
7024 \begin_layout Description
7025 Syntax command-prefix
7028 \begin_layout Subsection*
7032 \begin_layout Description
7033 Action Inserts the given string (accordingly to the correct keymap).
7036 \begin_layout Description
7037 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7040 \begin_layout Description
7041 Syntax self-insert <STRING>