1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
9 \renewenvironment{description}{\list{}{%
10 \setlength{\itemsep}{-2pt}
11 \advance\leftmargini6\p@ \itemindent-12\p@
12 \labelwidth\z@ \let\makelabel\descriptionlabel}%
17 \use_default_options false
18 \maintain_unincluded_children false
26 \language_package default
29 \font_roman "default" "default"
30 \font_sans "default" "default"
31 \font_typewriter "default" "default"
32 \font_math "auto" "auto"
33 \font_default_family default
34 \use_non_tex_fonts false
37 \font_sf_scale 100 100
38 \font_tt_scale 100 100
40 \default_output_format pdf2
42 \bibtex_command default
43 \index_command default
44 \paperfontsize default
49 \use_package amsmath 1
50 \use_package amssymb 1
53 \use_package mathdots 0
54 \use_package mathtools 0
56 \use_package stackrel 0
57 \use_package stmaryrd 0
58 \use_package undertilde 0
60 \cite_engine_type default
64 \paperorientation portrait
78 \paragraph_separation indent
79 \paragraph_indentation default
80 \quotes_language english
83 \paperpagestyle default
84 \tracking_changes false
107 \begin_layout Section*
111 \begin_layout Standard
112 This manual documents the
113 \begin_inset Quotes eld
117 \begin_inset Quotes erd
121 These are commands that are used to make \SpecialChar LyX
122 perform specific actions.
124 itself uses these functions internally, and every internal action is
128 \begin_layout Standard
129 LFUNs are also used in the files that define keyboard shortcuts, menu or
131 So if you want to change\SpecialChar breakableslash
132 customize the user interface, you need to deal
134 Furthermore, external programs can use LFUNs to communicate with and
135 \begin_inset Quotes eld
139 \begin_inset Quotes erd
144 Finally, you can also issue LFUNs directly via the so called mini-buffer
145 which can be opened via
148 arg "command-execute"
154 \begin_layout Standard
155 In the following, all LFUNs are listed, categorized by function.
158 \begin_layout Section
159 Layout Functions (Font, Layout and Textclass related)
162 \begin_layout Subsection*
166 \begin_layout Description
167 Action Displays list of layout choices.
170 \begin_layout Description
171 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
174 \begin_layout Description
175 Syntax drop-layouts-choice
178 \begin_layout Subsection*
182 \begin_layout Description
183 Action Splits the current environment with a Separator.
186 \begin_layout Description
187 Syntax environment-split [outer]
190 \begin_layout Description
191 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
194 \begin_layout Description
195 Origin spitz, 23 Dec 2012
198 \begin_layout Subsection*
202 \begin_layout Description
203 Action Toggles the bold font (selection-wise) using mathbf in math.
206 \begin_layout Description
210 \begin_layout Subsection*
214 \begin_layout Description
215 Action Toggles the bold font (selection-wise) using boldsymbol in math.
218 \begin_layout Description
219 Syntax font-boldsymbol
222 \begin_layout Subsection*
226 \begin_layout Description
227 Action Reverts the settings of the font to the default values (selection-wise).
230 \begin_layout Description
234 \begin_layout Subsection*
238 \begin_layout Description
239 Action Toggles the emphasis font style (selection-wise).
242 \begin_layout Description
246 \begin_layout Subsection*
250 \begin_layout Description
251 Action Toggles Fraktur family font (math-mode, selection-wise).
254 \begin_layout Description
258 \begin_layout Description
259 Origin vermeer, 10 Jan 2002
262 \begin_layout Subsection*
266 \begin_layout Description
267 Action Toggles Italics font shape (math-mode, selection-wise).
270 \begin_layout Description
274 \begin_layout Description
275 Origin vermeer, 10 Jan 2002
278 \begin_layout Subsection*
282 \begin_layout Description
283 Action Toggles Noun text style font (selection-wise).
286 \begin_layout Description
290 \begin_layout Subsection*
294 \begin_layout Description
295 Action Toggles Roman family font (selection-wise).
298 \begin_layout Description
302 \begin_layout Subsection*
306 \begin_layout Description
307 Action Toggles Sans Serif family font (selection-wise).
310 \begin_layout Description
314 \begin_layout Subsection*
318 \begin_layout Description
319 Action Sets font size according to lyx format string.
322 \begin_layout Description
323 Syntax font-size <SIZE>
326 \begin_layout Description
327 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
328 \begin_inset Newline newline
331 largest|huge|giant|increase|decrease|default
334 \begin_layout Subsection*
338 \begin_layout Description
339 Action Returns the info about the current font.
342 \begin_layout Description
346 \begin_layout Subsection*
350 \begin_layout Description
351 Action Toggles strikeout (strike-through) in the font (selection-wise).
354 \begin_layout Description
355 Syntax font-strikeout
358 \begin_layout Description
359 Origin sanda, 3 May 2009
362 \begin_layout Subsection*
366 \begin_layout Description
367 Action Toggles the typewriter family font (selection-wise).
370 \begin_layout Description
371 Syntax font-typewriter
374 \begin_layout Subsection*
378 \begin_layout Description
379 Action Toggles underline in the font (selection-wise).
382 \begin_layout Description
383 Syntax font-underline
386 \begin_layout Subsection*
390 \begin_layout Description
391 Action Toggles double underline in the font (selection-wise).
394 \begin_layout Description
395 Syntax font-underunderline
398 \begin_layout Description
399 Origin sanda, 5 May 2009
402 \begin_layout Subsection*
406 \begin_layout Description
407 Action Toggles wavy underline in the font (selection-wise).
410 \begin_layout Description
411 Syntax font-underwave
414 \begin_layout Description
415 Origin sanda, 5 May 2009
418 \begin_layout Subsection*
422 \begin_layout Description
423 Action Sets the layout (that is, environment) for the current paragraph.
426 \begin_layout Description
427 Syntax layout <LAYOUT>
430 \begin_layout Description
431 Params <LAYOUT>: the layout to use
434 \begin_layout Subsection*
438 \begin_layout Description
439 Action Adds a module.
442 \begin_layout Description
443 Notion Adds a module to the list of included modules for the current buffer.
446 \begin_layout Description
447 Syntax layout-module-add <MODULE>
450 \begin_layout Description
451 Params <MODULE>: the module to be added
454 \begin_layout Description
455 Origin rgh, 25 August 2007
458 \begin_layout Subsection*
462 \begin_layout Description
463 Action Clears the module list.
466 \begin_layout Description
467 Notion Clears the list of included modules for the current buffer.
470 \begin_layout Description
471 Syntax layout-modules-clear
474 \begin_layout Description
475 Origin rgh, 25 August 2007
478 \begin_layout Subsection*
482 \begin_layout Description
483 Action Launches the paragraph settings dialog.
486 \begin_layout Description
487 Syntax layout-paragraph
490 \begin_layout Subsection*
494 \begin_layout Description
495 Action Reloads layout information.
498 \begin_layout Description
499 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.
502 \begin_layout Description
506 \begin_layout Description
507 Origin rgh, 3 September 2007
510 \begin_layout Subsection*
514 \begin_layout Description
515 Action Launches the tabular settings dialog.
518 \begin_layout Description
519 Syntax layout-tabular
522 \begin_layout Description
523 Origin Jug, 31 Jul 2000
526 \begin_layout Subsection*
530 \begin_layout Description
531 Action Update fonts and its metrics.
534 \begin_layout Description
535 Notion Automatically called after zoom, dpi, font names, or norm change.
538 \begin_layout Description
539 Syntax screen-font-update
542 \begin_layout Description
543 Origin ARRae, 13 Aug 2000
546 \begin_layout Subsection*
550 \begin_layout Description
551 Action Sets the text class for the current buffer.
554 \begin_layout Description
555 Syntax textclass-apply <TEXTCLASS>
558 \begin_layout Description
559 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
562 \begin_layout Subsection*
566 \begin_layout Description
567 Action Loads information for a textclass from disk.
570 \begin_layout Description
571 Syntax textclass-load <TEXTCLASS>
574 \begin_layout Description
575 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
578 \begin_layout Subsection*
582 \begin_layout Description
583 Action Toggle user-defined (=last-time used) text style.
586 \begin_layout Description
587 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
590 \begin_layout Description
591 Syntax textstyle-apply
594 \begin_layout Description
595 Origin leeming, 12 Mar 2003
598 \begin_layout Subsection*
602 \begin_layout Description
603 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
606 \begin_layout Description
607 Syntax textstyle-update <FONT_INFO>
610 \begin_layout Description
611 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
612 \begin_inset Newline newline
615 Use lyx -dbg action for exact syntax of text-style dialog parameters.
618 \begin_layout Description
619 Origin leeming, 12 Mar 2003
622 \begin_layout Section
623 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
626 \begin_layout Subsection*
630 \begin_layout Description
631 Action Adds an acute accent to the next character typed.
634 \begin_layout Description
638 \begin_layout Subsection*
642 \begin_layout Description
643 Action Adds a breve accent to the next character typed.
646 \begin_layout Description
650 \begin_layout Subsection*
654 \begin_layout Description
655 Action Adds a caron to the next character typed.
658 \begin_layout Description
662 \begin_layout Subsection*
666 \begin_layout Description
667 Action Adds a cedilla to the next character typed.
670 \begin_layout Description
671 Syntax accent-cedilla
674 \begin_layout Subsection*
678 \begin_layout Description
679 Action Adds a circle accent to the next character typed.
682 \begin_layout Description
686 \begin_layout Subsection*
690 \begin_layout Description
691 Action Adds a circumflex to the next character typed.
694 \begin_layout Description
695 Syntax accent-circumflex
698 \begin_layout Subsection*
702 \begin_layout Description
703 Action Adds a dot accent to the next character typed.
706 \begin_layout Description
710 \begin_layout Subsection*
714 \begin_layout Description
715 Action Adds a grave accent to the next character typed.
718 \begin_layout Description
722 \begin_layout Subsection*
723 accent-hungarian-umlaut
726 \begin_layout Description
727 Action Adds a Hungarian umlaut to the next character typed.
730 \begin_layout Description
734 \begin_layout Subsection*
738 \begin_layout Description
739 Action Adds a macron to the next character typed.
742 \begin_layout Description
746 \begin_layout Subsection*
750 \begin_layout Description
751 Action Adds an ogonek accent to the next character typed.
754 \begin_layout Description
758 \begin_layout Subsection*
762 \begin_layout Description
763 Action Adds a perispomeni (Greek circumflex) over the next character typed.
766 \begin_layout Description
767 Syntax accent-perispomeni
770 \begin_layout Subsection*
774 \begin_layout Description
775 Action Adds a tie over the next two character typed.
778 \begin_layout Description
779 Notion The following char will finish the tie.
782 \begin_layout Description
786 \begin_layout Subsection*
790 \begin_layout Description
791 Action Adds a tilde over the next character typed.
794 \begin_layout Description
798 \begin_layout Subsection*
802 \begin_layout Description
803 Action Adds an umlaut over the next character typed.
806 \begin_layout Description
810 \begin_layout Subsection*
814 \begin_layout Description
815 Action Adds a bar under the next character typed.
818 \begin_layout Description
819 Syntax accent-underbar
822 \begin_layout Subsection*
826 \begin_layout Description
827 Action Adds a dot under the next character typed.
830 \begin_layout Description
831 Syntax accent-underdot
834 \begin_layout Subsection*
838 \begin_layout Description
839 Action Accepts all tracked changes in the document.
842 \begin_layout Description
843 Syntax all-changes-accept
846 \begin_layout Description
847 Origin Levon, 16 Oct 2002
850 \begin_layout Subsection*
854 \begin_layout Description
855 Action Rejects all tracked changes in the document.
858 \begin_layout Description
859 Notion Reject does not work recursively; the user may have to repeat the operation.
862 \begin_layout Description
863 Syntax all-changes-reject
866 \begin_layout Description
867 Origin Levon, 16 Oct 2002
870 \begin_layout Subsection*
874 \begin_layout Description
875 Action Start (or remove) Appendix on the given cursor position.
878 \begin_layout Description
882 \begin_layout Description
883 Origin ettrich, 5 May 1998
886 \begin_layout Subsection*
890 \begin_layout Description
891 Action Inserts an argument (short title) inset.
894 \begin_layout Description
895 Syntax argument-insert <argument nr>
898 \begin_layout Description
899 Params <argument nr>: see layout declarations
902 \begin_layout Description
903 Origin vermeer, 12 Aug 2002
906 \begin_layout Subsection*
910 \begin_layout Description
911 Action Adds database, which will be used for bibtex citations.
914 \begin_layout Description
915 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
918 \begin_layout Description
919 Syntax bibtex-database-add <DATABASE-NAME>
922 \begin_layout Description
923 Origin Ale, 30 May 1997
926 \begin_layout Subsection*
930 \begin_layout Description
931 Action Adds database, which will be used for bibtex citations.
934 \begin_layout Description
935 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
938 \begin_layout Description
939 Syntax bibtex-database-del <DATABASE-NAME>
942 \begin_layout Description
943 Origin Ale, 30 May 1997
946 \begin_layout Subsection*
950 \begin_layout Description
951 Action Clears the list of saved bookmarks.
954 \begin_layout Description
955 Syntax bookmark-clear
958 \begin_layout Description
959 Origin bpeng, 31 October 2006
962 \begin_layout Subsection*
966 \begin_layout Description
967 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
970 \begin_layout Description
971 Notion Bookmark 0 has a special purpose. It is automatically set
972 \begin_inset Newline newline
975 1. to the paragraph you are currently editing
976 \begin_inset Newline newline
979 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
980 \begin_inset Newline newline
983 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
986 \begin_layout Description
987 Syntax bookmark-goto <NUMBER>
990 \begin_layout Description
991 Params <NUMBER>: the number of the bookmark to restore.
994 \begin_layout Description
995 Origin Dekel, 27 January 2001
998 \begin_layout Subsection*
1002 \begin_layout Description
1003 Action Save a bookmark.
1006 \begin_layout Description
1007 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.
1010 \begin_layout Description
1011 Syntax bookmark-save <NUMBER>
1014 \begin_layout Description
1015 Params <NUMBER>: the number of the bookmark to save.
1018 \begin_layout Description
1019 Origin Dekel, 27 January 2001
1022 \begin_layout Subsection*
1026 \begin_layout Description
1027 Action Inserts Box inset.
1030 \begin_layout Description
1031 Syntax box-insert [<TYPE>]
1034 \begin_layout Description
1035 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1036 \begin_inset Newline newline
1039 Framed is the default one.
1042 \begin_layout Description
1043 Origin vermeer, 7 Oct 2003
1046 \begin_layout Subsection*
1050 \begin_layout Description
1051 Action Inserts branch inset.
1054 \begin_layout Description
1055 Syntax branch-insert <BRANCH-NAME>
1058 \begin_layout Description
1059 Origin vermeer, 17 Aug 2003
1062 \begin_layout Subsection*
1066 \begin_layout Description
1067 Action Move the cursor to the beginning of the document.
1070 \begin_layout Description
1074 \begin_layout Subsection*
1078 \begin_layout Description
1079 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1082 \begin_layout Description
1083 Syntax buffer-begin-select
1086 \begin_layout Subsection*
1090 \begin_layout Description
1091 Action Move the cursor to the end of the document.
1094 \begin_layout Description
1098 \begin_layout Subsection*
1102 \begin_layout Description
1103 Action Move the cursor to the end of the document adding the traversed text to the selection.
1106 \begin_layout Description
1107 Syntax buffer-end-select
1110 \begin_layout Subsection*
1114 \begin_layout Description
1115 Action Inserts a caption inset.
1118 \begin_layout Description
1119 Syntax caption-insert
1122 \begin_layout Description
1123 Origin Lgb, 18 Jul 2000
1126 \begin_layout Subsection*
1130 \begin_layout Description
1131 Action Moves the cursor to the previous cell inside the table.
1134 \begin_layout Description
1135 Syntax cell-backward
1138 \begin_layout Description
1139 Origin Jug, 22 May 2000
1142 \begin_layout Subsection*
1146 \begin_layout Description
1147 Action Moves the cursor to the next cell inside the table.
1150 \begin_layout Description
1154 \begin_layout Subsection*
1158 \begin_layout Description
1159 Action Splits cell and shifts right part to the next cell (inside the math grid).
1162 \begin_layout Description
1166 \begin_layout Description
1167 Origin Ale, 15 May 1997
1170 \begin_layout Subsection*
1174 \begin_layout Description
1175 Action Accepts tracked change inside the selection.
1178 \begin_layout Description
1179 Syntax change-accept
1182 \begin_layout Description
1183 Origin Levon, 16 Oct 2002
1186 \begin_layout Subsection*
1190 \begin_layout Description
1191 Action Moves the cursor to the position of the next change of the change tracking records.
1194 \begin_layout Description
1198 \begin_layout Description
1199 Origin schmitt, 4 Oct 2006
1202 \begin_layout Subsection*
1206 \begin_layout Description
1207 Action Moves the cursor to the position of the previous change of the change tracking records.
1210 \begin_layout Description
1211 Syntax change-previous
1214 \begin_layout Description
1215 Origin vfr, 4 Apr 2009
1218 \begin_layout Subsection*
1222 \begin_layout Description
1223 Action Rejects tracked change inside the selection.
1226 \begin_layout Description
1227 Syntax change-reject
1230 \begin_layout Description
1231 Origin Levon, 16 Oct 2002
1234 \begin_layout Subsection*
1238 \begin_layout Description
1239 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1242 \begin_layout Description
1243 Syntax changes-merge
1246 \begin_layout Description
1247 Origin Levon, 16 Oct 2002
1250 \begin_layout Subsection*
1254 \begin_layout Description
1255 Action Toggles showing of change tracking in typeset output.
1258 \begin_layout Description
1259 Syntax changes-output
1262 \begin_layout Description
1263 Origin jspitzm, 21 Jan 2005
1266 \begin_layout Subsection*
1270 \begin_layout Description
1271 Action Toggles change tracking to on/off.
1274 \begin_layout Description
1275 Syntax changes-track
1278 \begin_layout Description
1279 Origin levon, 1 Oct 2002
1282 \begin_layout Subsection*
1286 \begin_layout Description
1287 Action Moves the cursor one position logically backwards.
1290 \begin_layout Description
1291 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.
1294 \begin_layout Description
1295 Syntax char-backward
1298 \begin_layout Subsection*
1299 char-backward-select
1302 \begin_layout Description
1303 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1306 \begin_layout Description
1307 Notion See also LFUN_CHAR_BACKWARD.
1310 \begin_layout Description
1311 Syntax char-backward-select
1314 \begin_layout Subsection*
1315 char-delete-backward
1318 \begin_layout Description
1319 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1322 \begin_layout Description
1323 Syntax char-delete-backward
1326 \begin_layout Subsection*
1330 \begin_layout Description
1331 Action Deletes one character in the backward direction (usually the "Delete" key).
1334 \begin_layout Description
1335 Syntax char-delete-forward
1338 \begin_layout Subsection*
1342 \begin_layout Description
1343 Action Moves the cursor one position logically forward.
1346 \begin_layout Description
1347 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.
1350 \begin_layout Description
1354 \begin_layout Subsection*
1358 \begin_layout Description
1359 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1362 \begin_layout Description
1363 Notion See also LFUN_CHAR_FORWARD.
1366 \begin_layout Description
1367 Syntax char-forward-select
1370 \begin_layout Subsection*
1374 \begin_layout Description
1375 Action Moves the cursor one position "to the left".
1378 \begin_layout Description
1379 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.
1382 \begin_layout Description
1386 \begin_layout Subsection*
1390 \begin_layout Description
1391 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1394 \begin_layout Description
1395 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1398 \begin_layout Description
1399 Syntax char-left-select
1402 \begin_layout Subsection*
1406 \begin_layout Description
1407 Action Moves the cursor one position "to the right".
1410 \begin_layout Description
1411 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.
1414 \begin_layout Description
1418 \begin_layout Subsection*
1422 \begin_layout Description
1423 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1426 \begin_layout Description
1427 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1430 \begin_layout Description
1431 Syntax char-right-select
1434 \begin_layout Subsection*
1438 \begin_layout Description
1439 Action Transposes the character at the cursor with the one before it.
1442 \begin_layout Description
1443 Syntax chars-transpose
1446 \begin_layout Description
1447 Origin Lgb, 25 Apr 2001
1450 \begin_layout Subsection*
1454 \begin_layout Description
1455 Action Inserts citation from loaded citation database.
1458 \begin_layout Description
1459 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1462 \begin_layout Description
1463 Params <KEY>: Citation (shortcut listed in available citations).
1464 \begin_inset Newline newline
1467 <TEXT_BEFORE>: text which should appear before citation.
1470 \begin_layout Description
1471 Origin AAS, 97-02-23
1474 \begin_layout Subsection*
1478 \begin_layout Description
1479 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.
1482 \begin_layout Description
1483 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.
1486 \begin_layout Description
1487 Syntax clipboard-paste [<ARG>]
1490 \begin_layout Description
1491 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1494 \begin_layout Description
1495 Origin Georg, 10 Jul 2006
1498 \begin_layout Subsection*
1499 clipboard-paste-simple
1502 \begin_layout Description
1503 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.
1506 \begin_layout Description
1507 Syntax clipboard-paste-simple [<ARG>]
1510 \begin_layout Description
1511 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1514 \begin_layout Subsection*
1518 \begin_layout Description
1519 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1522 \begin_layout Description
1523 Notion Usually bound to M-x shortcut.
1526 \begin_layout Description
1527 Syntax command-execute
1530 \begin_layout Subsection*
1534 \begin_layout Description
1535 Action Try to complete the word or command at the cursor position.
1538 \begin_layout Description
1542 \begin_layout Description
1543 Origin sts, Feb 19 2008
1546 \begin_layout Subsection*
1550 \begin_layout Description
1551 Action Accept suggested completion.
1554 \begin_layout Description
1555 Syntax completion-accept
1558 \begin_layout Description
1559 Origin sanda, Sep 08 2008
1562 \begin_layout Subsection*
1566 \begin_layout Description
1567 Action Try to cancel completion, either the popup or the inline completion.
1570 \begin_layout Description
1571 Syntax completion-cancel
1574 \begin_layout Description
1575 Origin sts, Sep 07 2008
1578 \begin_layout Subsection*
1582 \begin_layout Description
1583 Action Show the inline completion at the cursor position.
1586 \begin_layout Description
1587 Syntax completion-inline
1590 \begin_layout Description
1591 Origin sts, Feb 19 2008
1594 \begin_layout Subsection*
1598 \begin_layout Description
1599 Action Show the completion popup at the cursor position.
1602 \begin_layout Description
1603 Syntax completion-popup
1606 \begin_layout Description
1607 Origin sts, Feb 19 2008
1610 \begin_layout Subsection*
1614 \begin_layout Description
1615 Action Copies the current selection to the clipboard.
1618 \begin_layout Description
1622 \begin_layout Subsection*
1626 \begin_layout Description
1627 Action Cuts to the clipboard.
1630 \begin_layout Description
1634 \begin_layout Subsection*
1638 \begin_layout Description
1639 Action Inserts the current date.
1642 \begin_layout Description
1643 Syntax date-insert [<ARG>]
1646 \begin_layout Description
1647 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.
1650 \begin_layout Description
1651 Origin jdblair, 31 Jan 2000
1654 \begin_layout Subsection*
1658 \begin_layout Description
1659 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1662 \begin_layout Description
1663 Syntax depth-decrement
1666 \begin_layout Subsection*
1670 \begin_layout Description
1671 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1674 \begin_layout Description
1675 Syntax depth-increment
1678 \begin_layout Subsection*
1679 dialog-disconnect-inset
1682 \begin_layout Description
1683 Action Closes opened connection to opened inset.
1686 \begin_layout Description
1687 Notion Connection is used for apply functions.
1690 \begin_layout Description
1691 Syntax dialog-disconnect-inset <INSET-NAME>
1694 \begin_layout Description
1695 Origin leeming, 25 Feb 2003
1698 \begin_layout Subsection*
1702 \begin_layout Description
1703 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1706 \begin_layout Description
1707 Syntax dialog-hide <NAME>
1710 \begin_layout Description
1711 Params See LFUN_DIALOG_SHOW .
1714 \begin_layout Description
1715 Origin leeming, 25 Feb 2003
1718 \begin_layout Subsection*
1722 \begin_layout Description
1723 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1726 \begin_layout Description
1727 Syntax dialog-show <NAME> [<DATA>]
1730 \begin_layout Description
1731 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1732 \begin_inset Newline newline
1735 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1736 \begin_inset Newline newline
1739 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1740 \begin_inset Newline newline
1743 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1744 \begin_inset Newline newline
1747 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1748 \begin_inset Newline newline
1751 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1752 \begin_inset Newline newline
1755 <SPECIAL>: latexlog|vclog
1756 \begin_inset Newline newline
1759 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1762 \begin_layout Description
1763 Origin leeming, 17 Jun 2003
1766 \begin_layout Subsection*
1767 dialog-show-new-inset
1770 \begin_layout Description
1771 Action Shows hidden dialog or create new one for a given inset settings etc.
1774 \begin_layout Description
1775 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1778 \begin_layout Description
1779 Syntax dialog-show-new-inset <NAME> [<DATA>]
1782 \begin_layout Description
1783 Params See LFUN_DIALOG_SHOW .
1786 \begin_layout Description
1787 Origin leeming, 25 Feb 2003
1790 \begin_layout Subsection*
1794 \begin_layout Description
1795 Action Toggles dialog between showed/hidden state.
1798 \begin_layout Description
1799 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1802 \begin_layout Description
1803 Syntax dialog-toggle <NAME> [<DATA>]
1806 \begin_layout Description
1807 Params See LFUN_DIALOG_SHOW .
1810 \begin_layout Description
1811 Origin JSpitzm, 30 Apr 2007
1814 \begin_layout Subsection*
1818 \begin_layout Description
1819 Action Updates the dialog values from the inset/paragraph/document.
1822 \begin_layout Description
1823 Syntax dialog-update <NAME>
1826 \begin_layout Description
1827 Params <NAME>: paragraph|prefs|<INSET>
1828 \begin_inset Newline newline
1834 \begin_layout Description
1835 Origin leeming, 25 Feb 2003
1838 \begin_layout Subsection*
1842 \begin_layout Description
1843 Action Moves the cursor one line in downward direction.
1846 \begin_layout Description
1850 \begin_layout Subsection*
1854 \begin_layout Description
1855 Action Moves the cursor one line in downward direction adding the current position to the selection.
1858 \begin_layout Description
1862 \begin_layout Subsection*
1866 \begin_layout Description
1867 Action Inserts an ERT inset.
1870 \begin_layout Description
1874 \begin_layout Description
1875 Origin Jug, 18 Feb 2000
1878 \begin_layout Subsection*
1882 \begin_layout Description
1883 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1886 \begin_layout Description
1890 \begin_layout Description
1891 Origin Lgb, 17 May 2001
1894 \begin_layout Subsection*
1898 \begin_layout Description
1899 Action Inserts another LyX file.
1902 \begin_layout Description
1903 Syntax file-insert [<FILE>]
1906 \begin_layout Description
1907 Params <FILE>: Filename to be inserted.
1910 \begin_layout Subsection*
1911 file-insert-plaintext
1914 \begin_layout Description
1915 Action Inserts plain text file.
1918 \begin_layout Description
1919 Syntax file-insert-plaintext [<FILE>]
1922 \begin_layout Description
1923 Params <FILE>: Filename to be inserted.
1926 \begin_layout Description
1927 Origin CFO-G, 19 Nov 1997
1930 \begin_layout Subsection*
1931 file-insert-plaintext-para
1934 \begin_layout Description
1935 Action Inserts plain text file as paragraph (i.e. join lines).
1938 \begin_layout Description
1939 Syntax file-insert-plaintext-para [<FILE>]
1942 \begin_layout Description
1943 Params <FILE>: Filename to be inserted.
1946 \begin_layout Description
1947 Origin Levon, 14 Feb 2001
1950 \begin_layout Subsection*
1954 \begin_layout Description
1955 Action Inserts CharStyle, Custom inset or XML short element.
1958 \begin_layout Description
1959 Notion Look into the Customization manual for more information about these elements.
1960 \begin_inset Newline newline
1963 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.
1964 \begin_inset Newline newline
1967 For dissolving the element see LFUN_INSET_DISSOLVE.
1970 \begin_layout Description
1971 Syntax flex-insert Name
1974 \begin_layout Description
1975 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.
1978 \begin_layout Description
1979 Sample flex-insert Code
1982 \begin_layout Subsection*
1986 \begin_layout Description
1987 Action Inserts a float inset.
1990 \begin_layout Description
1991 Syntax float-insert <TYPE>
1994 \begin_layout Description
1995 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1998 \begin_layout Description
1999 Origin Lgb, 27 Jun 2000
2002 \begin_layout Subsection*
2006 \begin_layout Description
2007 Action Inserts the list of floats in the document.
2010 \begin_layout Description
2011 Syntax float-list-insert <TYPE>
2014 \begin_layout Description
2015 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2018 \begin_layout Description
2019 Origin Lgb, 3 May 2001
2022 \begin_layout Subsection*
2026 \begin_layout Description
2027 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2030 \begin_layout Description
2031 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2034 \begin_layout Description
2035 Syntax float-wide-insert <TYPE>
2038 \begin_layout Description
2039 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2042 \begin_layout Description
2043 Origin Lgb, 31 Oct 2001
2046 \begin_layout Subsection*
2050 \begin_layout Description
2051 Action Inserts a footnote inset.
2054 \begin_layout Description
2055 Syntax footnote-insert
2058 \begin_layout Description
2059 Origin Jug, 7 Mar 2000
2062 \begin_layout Subsection*
2066 \begin_layout Description
2067 Action Reloads the image if necessary.
2070 \begin_layout Description
2071 Syntax graphics-reload
2074 \begin_layout Description
2075 Origin vfr, 10 Aug 2009
2078 \begin_layout Subsection*
2082 \begin_layout Description
2083 Action Inserts hyperlinks into the document (clickable in pdf output).
2086 \begin_layout Description
2087 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2090 \begin_layout Description
2091 Syntax href-insert [<TARGET>]
2094 \begin_layout Description
2095 Origin CFO-G, 21 Nov 1997
2098 \begin_layout Subsection*
2102 \begin_layout Description
2103 Action Only active in IPA inset.
2106 \begin_layout Description
2107 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.
2110 \begin_layout Description
2114 \begin_layout Description
2115 Origin spitz, 20 May 2012
2118 \begin_layout Subsection*
2122 \begin_layout Description
2123 Action Inserts Index entry.
2126 \begin_layout Description
2127 Notion It automatically takes the word on the cursor position.
2130 \begin_layout Description
2131 Syntax index-insert [<TYPE:Name>]
2134 \begin_layout Description
2135 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2138 \begin_layout Description
2139 Origin leeming, 3 Aug 2000
2142 \begin_layout Subsection*
2146 \begin_layout Description
2147 Action Inserts list of Index entries on a new page.
2150 \begin_layout Description
2151 Syntax index-print [<TYPE:Name>]
2154 \begin_layout Description
2155 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2158 \begin_layout Description
2159 Origin Lgb, 27 Feb 1997
2162 \begin_layout Subsection*
2166 \begin_layout Description
2167 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2170 \begin_layout Description
2171 Notion Apart from lfun arguments you can use the following method:
2172 \begin_inset Newline newline
2175 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2176 \begin_inset Newline newline
2179 2. select the text and run info-insert lfun.
2182 \begin_layout Description
2183 Syntax info-insert <TYPE> <ARG>
2186 \begin_layout Description
2187 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
2188 \begin_inset Newline newline
2191 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2192 \begin_inset Newline newline
2195 shortcut[s]: name of lfun (e.g math-insert
2198 \begin_inset Newline newline
2201 lyxrc: name of rc_entry (e.g. bind_file)
2202 \begin_inset Newline newline
2205 lyxinfo: "version" - used version of LyX
2206 \begin_inset Newline newline
2209 package: name of latex package (e.g. listings)
2210 \begin_inset Newline newline
2213 textclass: name of textclass (e.g. article)
2214 \begin_inset Newline newline
2217 menu: name of lfun used in menu
2218 \begin_inset Newline newline
2221 icon: icon of lfun used in toolbar or direct icon name
2222 \begin_inset Newline newline
2225 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
2228 \begin_layout Description
2229 Sample command-sequence info-insert buffer path; info-insert buffer name
2232 \begin_layout Description
2233 Origin bpeng, 7 Oct 2007
2236 \begin_layout Subsection*
2240 \begin_layout Description
2241 Action Apply data for an inset.
2244 \begin_layout Description
2245 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.
2248 \begin_layout Description
2249 Syntax inset-apply <ARGS>
2252 \begin_layout Description
2253 Params See LFUN_INSET_INSERT .
2256 \begin_layout Subsection*
2260 \begin_layout Description
2261 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
2264 \begin_layout Description
2268 \begin_layout Description
2269 Origin lasgouttes, 16 Mar 2009
2272 \begin_layout Subsection*
2276 \begin_layout Description
2277 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).
2280 \begin_layout Description
2281 Syntax inset-begin-select
2284 \begin_layout Description
2285 Origin lasgouttes, 16 Mar 2009
2288 \begin_layout Subsection*
2292 \begin_layout Description
2293 Action Copies the inset to the clipboard as a certain type.
2296 \begin_layout Description
2297 Notion Currently used only for InsetInfo where its content is copied as a text.
2300 \begin_layout Description
2301 Syntax inset-copy-as
2304 \begin_layout Description
2305 Origin vfr, 18 Apr 2010
2308 \begin_layout Subsection*
2312 \begin_layout Description
2313 Action Dissolve the current inset into text.
2316 \begin_layout Description
2317 Syntax inset-dissolve [<INSET>]
2320 \begin_layout Description
2321 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.
2322 \begin_inset Newline newline
2325 For values see lyx::InsetLayout::lyxtype_ .
2328 \begin_layout Description
2329 Origin JSpitz, 7 Aug 2006
2332 \begin_layout Subsection*
2336 \begin_layout Description
2337 Action Edit the inset at cursor with an external application, if one is attributed.
2340 \begin_layout Description
2341 Syntax inset-edit [<INSET_PARAMS>]
2344 \begin_layout Description
2345 Params <INSET_PARAMS>: Parameters for the inset.
2346 \begin_inset Newline newline
2349 Currently only the filename will be considered.
2352 \begin_layout Description
2353 Origin JSpitzm, 27 Apr 2006
2356 \begin_layout Subsection*
2360 \begin_layout Description
2361 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
2364 \begin_layout Description
2368 \begin_layout Description
2369 Origin lasgouttes, 16 Mar 2009
2372 \begin_layout Subsection*
2376 \begin_layout Description
2377 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).
2380 \begin_layout Description
2381 Syntax inset-end-select
2384 \begin_layout Description
2385 Origin lasgouttes, 16 Mar 2009
2388 \begin_layout Subsection*
2392 \begin_layout Description
2393 Action Apply the given commands on insets of a given name.
2396 \begin_layout Description
2397 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.
2400 \begin_layout Description
2401 Syntax inset-forall <NAME> <LFUN-COMMAND>
2402 \begin_inset Newline newline
2405 <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.
2408 \begin_layout Description
2409 Sample Remove all index insets:
2410 \begin_inset Newline newline
2413 inset-forall Index char-delete-forward
2414 \begin_inset Newline newline
2417 Close all Notes (also works for a particular branch, for example):
2418 \begin_inset Newline newline
2421 inset-forall Note inset-toggle close
2422 \begin_inset Newline newline
2425 Transform all yellow notes to comments
2426 \begin_inset Newline newline
2429 inset-forall Note:Note inset-modify note Note Comment
2430 \begin_inset Newline newline
2433 Try to put LyX in an infinite loop if there is at least a Note:
2434 \begin_inset Newline newline
2437 inset-forall Note char-backward
2440 \begin_layout Description
2441 Origin lasgouttes, 27 Nov 2009
2444 \begin_layout Subsection*
2448 \begin_layout Description
2449 Action Insert new inset (type given by the parameters).
2452 \begin_layout Description
2453 Syntax inset-insert <INSET> <ARGS>
2456 \begin_layout Description
2457 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2458 \begin_inset Newline newline
2461 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2462 \begin_inset Newline newline
2465 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2468 \begin_layout Description
2469 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2472 \begin_inset Newline newline
2475 where <label name> is the name of the referenced label and <Format> is one of the following:
2476 \begin_inset Newline newline
2480 \begin_inset Newline newline
2483 eqref -- (<reference>)
2484 \begin_inset Newline newline
2488 \begin_inset Newline newline
2491 vpageref -- on <page>
2492 \begin_inset Newline newline
2495 vref -- <reference> on <page>
2496 \begin_inset Newline newline
2499 formatted -- Formatted reference
2502 \begin_layout Subsection*
2506 \begin_layout Description
2507 Action Modify some properties of an inset.
2510 \begin_layout Description
2511 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.
2514 \begin_layout Description
2515 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
2518 \begin_layout Description
2519 Params Generally see LFUN_INSET_INSERT for further details.
2520 \begin_inset Newline newline
2523 In case that <INSET> is "tabular" various math-environment features are handled as well, e.g. add-vline-left/right for the Grid/Array environment.
2524 \begin_inset Newline newline
2527 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
2528 \begin_inset Newline newline
2531 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
2532 \begin_inset Newline newline
2535 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2536 \begin_inset Newline newline
2539 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2540 \begin_inset Newline newline
2543 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2544 \begin_inset Newline newline
2547 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2548 \begin_inset Newline newline
2551 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2552 \begin_inset Newline newline
2555 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
2556 \begin_inset Newline newline
2559 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2560 \begin_inset Newline newline
2563 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2564 \begin_inset Newline newline
2567 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2568 \begin_inset Newline newline
2571 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2572 \begin_inset Newline newline
2575 set-special-column|set-special-multicolumn|set-special-multirow|
2576 \begin_inset Newline newline
2579 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2580 \begin_inset Newline newline
2583 set-interline-space|set-border-lines|tabular-valign-top|
2584 \begin_inset Newline newline
2587 tabular-valign-middle|tabular-valign-bottom|set-tabular-width <ARG>: additional argument for some commands, use debug mode to explore its values.
2590 \begin_layout Description
2591 Sample inset-modify note Note Comment
2592 \begin_inset Newline newline
2595 inset-modify changetype Ovalbox
2598 \begin_layout Subsection*
2602 \begin_layout Description
2603 Action Select all contents of an inset.
2606 \begin_layout Description
2607 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2610 \begin_layout Description
2611 Syntax inset-select-all
2614 \begin_layout Description
2615 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2618 \begin_layout Subsection*
2622 \begin_layout Description
2623 Action Open the inset's properties dialog.
2626 \begin_layout Description
2627 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.
2630 \begin_layout Description
2631 Syntax inset-settings <INSET>
2634 \begin_layout Description
2635 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2636 \begin_inset Newline newline
2639 graphics|href|include|index|index_print|label|line|
2640 \begin_inset Newline newline
2643 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2646 \begin_layout Subsection*
2650 \begin_layout Description
2651 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2654 \begin_layout Description
2655 Syntax inset-toggle [<ARG>]
2658 \begin_layout Description
2659 Params <ARG>: <open|close|toggle|assign>.
2660 \begin_inset Newline newline
2663 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2664 \begin_inset Newline newline
2667 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2670 \begin_layout Description
2671 Origin lasgouttes, 19 Jul 2001
2674 \begin_layout Subsection*
2678 \begin_layout Description
2679 Action Inserts an IPA inset.
2682 \begin_layout Description
2686 \begin_layout Description
2687 Origin spitz, 05 Mar 2012
2690 \begin_layout Subsection*
2694 \begin_layout Description
2695 Action Inserts special IPA macros into the document.
2698 \begin_layout Description
2699 Syntax ipamacro-insert <CHAR>
2702 \begin_layout Description
2703 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2706 \begin_layout Description
2707 Origin JSpitzm, 22 Aug 2012
2710 \begin_layout Subsection*
2714 \begin_layout Description
2715 Action Turn off the loaded keyboard map.
2718 \begin_layout Description
2722 \begin_layout Subsection*
2726 \begin_layout Description
2727 Action Turn on the primary keyboard map.
2730 \begin_layout Description
2731 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.
2732 \begin_inset Newline newline
2735 The language is to be set in the Preferences dialog.
2738 \begin_layout Description
2739 Syntax keymap-primary
2742 \begin_layout Subsection*
2746 \begin_layout Description
2747 Action Turn on the secondary keyboard map.
2750 \begin_layout Description
2751 Syntax keymap-secondary
2754 \begin_layout Subsection*
2758 \begin_layout Description
2759 Action Toggles keyboard maps (first/second/off).
2762 \begin_layout Description
2763 Syntax keymap-toggle
2766 \begin_layout Description
2767 Origin leeming, 30 Mar 2004
2770 \begin_layout Subsection*
2771 label-copy-as-reference
2774 \begin_layout Description
2775 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2778 \begin_layout Description
2779 Syntax copy-label-as-reference <LABEL>
2782 \begin_layout Description
2783 Params <LABEL>: The label to copy (for multi-line math)
2786 \begin_layout Description
2787 Origin sts, 16 Nov 2008
2790 \begin_layout Subsection*
2794 \begin_layout Description
2795 Action Goto a label.
2798 \begin_layout Description
2799 Syntax label-goto [<LABEL>]
2802 \begin_layout Description
2803 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.
2806 \begin_layout Description
2807 Origin Ale, 6 Aug 1997
2810 \begin_layout Subsection*
2814 \begin_layout Description
2815 Action Inserts label to text or displayed formula.
2818 \begin_layout Description
2819 Syntax label-insert [<LABEL>]
2822 \begin_layout Description
2823 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2826 \begin_layout Subsection*
2827 label-insert-as-reference
2830 \begin_layout Description
2831 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2834 \begin_layout Description
2835 Syntax label-insert-as-reference
2838 \begin_layout Description
2839 Origin vfr, 7 Apr 2009
2842 \begin_layout Subsection*
2846 \begin_layout Description
2847 Action Set language from the current cursor position.
2850 \begin_layout Description
2851 Syntax language <LANG> [set]
2854 \begin_layout Description
2855 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).
2858 \begin_layout Description
2859 Origin Dekel, 2 Mar 2000
2862 \begin_layout Subsection*
2866 \begin_layout Description
2867 Action Move the cursor to the beginning of the (screen) line.
2870 \begin_layout Description
2874 \begin_layout Subsection*
2878 \begin_layout Description
2879 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2882 \begin_layout Description
2883 Syntax line-begin-select
2886 \begin_layout Subsection*
2890 \begin_layout Description
2891 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2894 \begin_layout Description
2895 Syntax line-delete-forward
2898 \begin_layout Subsection*
2902 \begin_layout Description
2903 Action Move the cursor to the end of the (screen) line.
2906 \begin_layout Description
2910 \begin_layout Subsection*
2914 \begin_layout Description
2915 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2918 \begin_layout Description
2919 Syntax line-end-select
2922 \begin_layout Subsection*
2926 \begin_layout Description
2927 Action Inserts a new listings inset.
2930 \begin_layout Description
2931 Syntax listing-insert
2934 \begin_layout Description
2935 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2938 \begin_layout Subsection*
2942 \begin_layout Description
2943 Action Inserts a marginal note.
2946 \begin_layout Description
2947 Syntax marginalnote-insert
2950 \begin_layout Description
2951 Origin Lgb, 26 Jun 2000
2954 \begin_layout Subsection*
2958 \begin_layout Description
2959 Action Disable selecting of text-region.
2962 \begin_layout Description
2966 \begin_layout Subsection*
2970 \begin_layout Description
2971 Action Enable selecting of text-region.
2974 \begin_layout Description
2975 Notion After enabling you can simply move arrow keys to get selected region.
2978 \begin_layout Description
2982 \begin_layout Subsection*
2986 \begin_layout Description
2987 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2990 \begin_layout Description
2994 \begin_layout Description
2995 Origin Andre, May 5 2006
2998 \begin_layout Subsection*
3002 \begin_layout Description
3003 Action Inserts a line break or new line.
3006 \begin_layout Description
3007 Syntax newline-insert [<ARG>]
3010 \begin_layout Description
3011 Params <ARG>: <newline|linebreak> default: newline
3014 \begin_layout Description
3015 Origin JSpitzm, 25 Mar 2008
3018 \begin_layout Subsection*
3022 \begin_layout Description
3023 Action Inserts a new page.
3026 \begin_layout Description
3027 Syntax newpage-insert <ARG>
3030 \begin_layout Description
3031 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3034 \begin_layout Description
3035 Origin uwestoehr, 24 Nov 2007
3038 \begin_layout Subsection*
3042 \begin_layout Description
3043 Action Inserts Nomenclature entry.
3046 \begin_layout Description
3047 Notion It automatically takes the word on the cursor position if no symbol is given.
3050 \begin_layout Description
3051 Syntax nomencl-insert [<SYMBOL>]
3054 \begin_layout Description
3055 Origin Ugras, 4 Nov 2006
3058 \begin_layout Subsection*
3062 \begin_layout Description
3063 Action Inserts list of Nomenclature entries.
3066 \begin_layout Description
3067 Syntax nomenclature-print
3070 \begin_layout Description
3071 Origin Ugras, 4 Nov 2006
3074 \begin_layout Subsection*
3078 \begin_layout Description
3079 Action Inserts Note on the current cursor position, move selection inside the inset.
3082 \begin_layout Description
3083 Syntax note-insert [<TYPE>]
3086 \begin_layout Description
3087 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3090 \begin_layout Subsection*
3094 \begin_layout Description
3095 Action Moves the cursor to the beginning of next Note inset.
3098 \begin_layout Description
3102 \begin_layout Subsection*
3106 \begin_layout Description
3107 Action Move the current group in the downward direction in the structure of the document.
3110 \begin_layout Description
3111 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3114 \begin_layout Description
3118 \begin_layout Description
3119 Origin Vermeer, 23 Mar 2006
3122 \begin_layout Subsection*
3126 \begin_layout Description
3127 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3130 \begin_layout Description
3131 Notion Part -> Chapter -> Section -> etc.
3134 \begin_layout Description
3138 \begin_layout Description
3139 Origin Vermeer, 23 Mar 2006
3142 \begin_layout Subsection*
3146 \begin_layout Description
3147 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3150 \begin_layout Description
3151 Notion Part <- Chapter <- Section <- etc.
3154 \begin_layout Description
3158 \begin_layout Description
3159 Origin Vermeer, 23 Mar 2006
3162 \begin_layout Subsection*
3166 \begin_layout Description
3167 Action Move the current group in the upward direction in the structure of the document.
3170 \begin_layout Description
3171 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3174 \begin_layout Description
3178 \begin_layout Description
3179 Origin Vermeer, 23 Mar 2006
3182 \begin_layout Subsection*
3186 \begin_layout Description
3187 Action Breaks the current paragraph at the current location.
3190 \begin_layout Description
3191 Notion Removes the selection.
3194 \begin_layout Description
3195 Syntax paragraph-break [<LAYOUT>]
3198 \begin_layout Description
3199 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3202 \begin_layout Subsection*
3206 \begin_layout Description
3207 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3210 \begin_layout Description
3211 Syntax paragraph-down
3214 \begin_layout Description
3215 Origin Asger, 1 Oct 1996
3218 \begin_layout Subsection*
3219 paragraph-down-select
3222 \begin_layout Description
3223 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3226 \begin_layout Description
3227 Syntax paragraph-down-select
3230 \begin_layout Description
3231 Origin Asger, 1 Oct 1996
3234 \begin_layout Subsection*
3238 \begin_layout Description
3239 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
3242 \begin_layout Description
3243 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).
3246 \begin_layout Description
3247 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3250 \begin_layout Description
3251 Params <PAR_ID_NUMBER>: paragraph id
3252 \begin_inset Newline newline
3255 <POSITION_IN_PAR>: desired position within the paragraph
3258 \begin_layout Description
3259 Origin Dekel, 26 Aug 2000
3262 \begin_layout Subsection*
3266 \begin_layout Description
3267 Action Moves the current paragraph downwards in the document.
3270 \begin_layout Description
3271 Syntax paragraph-move-down
3274 \begin_layout Description
3275 Origin Edwin, 8 Apr 2006
3278 \begin_layout Subsection*
3282 \begin_layout Description
3283 Action Moves the current paragraph upwards in the document.
3286 \begin_layout Description
3287 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3290 \begin_layout Description
3291 Syntax paragraph-move-up
3294 \begin_layout Description
3295 Origin Edwin, 8 Apr 2006
3298 \begin_layout Subsection*
3302 \begin_layout Description
3303 Action Change paragraph settings.
3306 \begin_layout Description
3307 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.
3310 \begin_layout Description
3311 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3314 \begin_layout Description
3324 \begin_inset Newline newline
3329 paragraph_spacing default|single|onehalf|double|other SIZE
3330 \begin_inset Newline newline
3335 align block|left|right|center|default
3336 \begin_inset Newline newline
3341 labelwidthstring WIDTH|
3346 \begin_layout Description
3347 Origin rgh, Aug 15 2007
3350 \begin_layout Subsection*
3351 paragraph-params-apply
3354 \begin_layout Description
3355 Action Change paragraph settings.
3358 \begin_layout Description
3359 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3362 \begin_layout Description
3363 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3366 \begin_layout Description
3367 Params For parameters see LFUN_PARAGRAPH_PARAMS
3370 \begin_layout Description
3371 Origin leeming, 30 Mar 2004
3374 \begin_layout Subsection*
3378 \begin_layout Description
3379 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3382 \begin_layout Description
3386 \begin_layout Description
3387 Origin Asger, 1 Oct 1996
3390 \begin_layout Subsection*
3394 \begin_layout Description
3395 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3398 \begin_layout Description
3399 Syntax paragraph-up-select
3402 \begin_layout Description
3403 Origin Asger, 1 Oct 1996
3406 \begin_layout Subsection*
3410 \begin_layout Description
3411 Action Pastes material (text or picture) from the active clipboard.
3414 \begin_layout Description
3415 Syntax paste [<TYPE>|<NUM>]
3418 \begin_layout Description
3419 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3420 \begin_inset Newline newline
3423 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3426 \begin_layout Subsection*
3430 \begin_layout Description
3431 Action Inserts phantom on the current cursor position, move selection inside the inset.
3434 \begin_layout Description
3435 Syntax phantom-insert [<TYPE>]
3438 \begin_layout Description
3439 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3442 \begin_layout Description
3443 Origin uwestoehr, 30 Jan 2009
3446 \begin_layout Subsection*
3450 \begin_layout Description
3451 Action Inserts a new preview inset.
3454 \begin_layout Description
3455 Syntax preview-insert
3458 \begin_layout Description
3459 Origin vfr, 28 Mar 2010
3462 \begin_layout Subsection*
3463 primary-selection-paste
3466 \begin_layout Description
3467 Action Pastes the currently selected text.
3470 \begin_layout Description
3471 Notion Primary selection mechanism is linux-only thing.
3474 \begin_layout Description
3475 Syntax primary-selection-paste [<ARG>]
3478 \begin_layout Description
3479 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3482 \begin_layout Subsection*
3486 \begin_layout Description
3487 Action Inserts quotes according to the type and quote-language preference.
3490 \begin_layout Description
3491 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
3494 \begin_layout Description
3495 Syntax quote-insert [<TYPE>]
3498 \begin_layout Description
3499 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
3502 \begin_layout Subsection*
3506 \begin_layout Description
3507 Action Redoes the last thing undone.
3510 \begin_layout Description
3514 \begin_layout Subsection*
3518 \begin_layout Description
3519 Action Go to the next label or cross-reference.
3522 \begin_layout Description
3523 Syntax reference-next
3526 \begin_layout Description
3527 Origin Dekel, 14 Jan 2001
3530 \begin_layout Subsection*
3534 \begin_layout Description
3535 Action Repeat the given command.
3538 \begin_layout Description
3539 Syntax repeat <COUNT> <LFUN-COMMAND>
3542 \begin_layout Description
3543 Origin Andre, 27 Oct 2003
3546 \begin_layout Subsection*
3550 \begin_layout Description
3551 Action Moves the cursor one page in downward direction.
3554 \begin_layout Description
3558 \begin_layout Subsection*
3562 \begin_layout Description
3563 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3566 \begin_layout Description
3567 Syntax screen-down-select
3570 \begin_layout Subsection*
3574 \begin_layout Description
3575 Action Recenters the screen on the current cursor position.
3578 \begin_layout Description
3579 Syntax screen-recenter
3582 \begin_layout Subsection*
3586 \begin_layout Description
3587 Action Repositions the screen such that the cursor is visible.
3590 \begin_layout Description
3591 Syntax screen-show-cursor
3594 \begin_layout Description
3595 Origin vfr, 25 Mar 2009
3598 \begin_layout Subsection*
3602 \begin_layout Description
3603 Action Moves the cursor one page in upward direction.
3606 \begin_layout Description
3610 \begin_layout Subsection*
3614 \begin_layout Description
3615 Action Moves the cursor one page in upward direction adding the current position to the selection.
3618 \begin_layout Description
3619 Syntax screen-up-select
3622 \begin_layout Subsection*
3626 \begin_layout Description
3627 Action Inserts a subscript or superscript inset.
3630 \begin_layout Description
3631 Syntax script-insert <TYPE>
3634 \begin_layout Description
3635 Params <TYPE>: subscript|superscript
3638 \begin_layout Description
3639 Origin Georg, 23 Nov 2010
3642 \begin_layout Subsection*
3646 \begin_layout Description
3647 Action Scroll the buffer view.
3650 \begin_layout Description
3651 Notion Only scrolls the screen up or down; does not move the cursor.
3654 \begin_layout Description
3655 Syntax scroll <TYPE> <QUANTITY>
3658 \begin_layout Description
3659 Params <TYPE>: line|page
3660 \begin_inset Newline newline
3663 <QUANTITY>: up|down|<number>
3666 \begin_layout Description
3667 Origin Abdel, Dec 27 2007
3670 \begin_layout Subsection*
3674 \begin_layout Description
3675 Action Select the whole section.
3678 \begin_layout Description
3679 Notion The cursor should be in a section heading before calling this lfun.
3682 \begin_layout Description
3683 Syntax section-select
3686 \begin_layout Description
3687 Origin vfr, 05 May 2009
3690 \begin_layout Subsection*
3694 \begin_layout Description
3695 Action Pastes the internal selection text in permanent selection.
3698 \begin_layout Description
3699 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3702 \begin_layout Description
3703 Syntax selection-paste
3706 \begin_layout Description
3707 Origin lasgouttes, 14 Jan 2009
3710 \begin_layout Subsection*
3714 \begin_layout Description
3715 Action Inserts an environment separator or paragraph break.
3718 \begin_layout Description
3719 Syntax separator-insert [<ARG>]
3722 \begin_layout Description
3723 Params <ARG>: <plain|parbreak> default: plain
3726 \begin_layout Description
3727 Origin ef, 2 May 2014
3730 \begin_layout Subsection*
3734 \begin_layout Description
3735 Action Set the group for the graphics inset on the cursor position.
3738 \begin_layout Description
3739 Syntax set-graphics-group [<GROUP>]
3742 \begin_layout Description
3743 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3746 \begin_layout Description
3747 Origin sanda, 6 May 2008
3750 \begin_layout Subsection*
3754 \begin_layout Description
3755 Action Inserts one of horizontal space insets.
3758 \begin_layout Description
3759 Syntax space-insert <NAME> [<LEN>]
3762 \begin_layout Description
3763 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3764 \begin_inset Newline newline
3767 Only in math mode: med and thick.
3768 \begin_inset Newline newline
3771 <LEN>: length for custom spaces (hspace, hspace* for protected)
3774 \begin_layout Description
3775 Origin JSpitzm, 20 May 2003, Mar 17 2008
3778 \begin_layout Subsection*
3782 \begin_layout Description
3783 Action Inserts various characters into the document.
3786 \begin_layout Description
3787 Syntax specialchar-insert <CHAR>
3790 \begin_layout Description
3791 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3794 \begin_layout Description
3795 Origin JSpitzm, 6 Dec 2007
3798 \begin_layout Subsection*
3802 \begin_layout Description
3803 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3806 \begin_layout Description
3807 Syntax spelling-add [<STRING>] [<LANG>]
3810 \begin_layout Description
3811 Params <WORD>: word to add <LANG>: language name (see file languages)
3814 \begin_layout Description
3815 Origin JSpitzm, 18 Jan 2010
3818 \begin_layout Subsection*
3819 spelling-continuously
3822 \begin_layout Description
3823 Action Toggle continuous spell checking.
3826 \begin_layout Description
3827 Syntax spelling-continuously
3830 \begin_layout Description
3831 Origin vfr, 24 March 2013
3834 \begin_layout Subsection*
3838 \begin_layout Description
3839 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.
3842 \begin_layout Description
3843 Syntax spelling-ignore [<WORD>] [<LANG>]
3846 \begin_layout Description
3847 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3850 \begin_layout Description
3851 Origin JSpitzm, 18 Jan 2010
3854 \begin_layout Subsection*
3858 \begin_layout Description
3859 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3862 \begin_layout Description
3863 Syntax spelling-remove [<STRING>] [<LANG>]
3866 \begin_layout Description
3867 Params <WORD>: word to remove <LANG>: language name (see file languages)
3870 \begin_layout Description
3871 Origin SWitt, 28 July 2010
3874 \begin_layout Subsection*
3878 \begin_layout Description
3879 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3882 \begin_layout Description
3883 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.
3886 \begin_layout Description
3890 \begin_layout Description
3891 Origin vfr, Sep 30 2008
3894 \begin_layout Subsection*
3898 \begin_layout Description
3899 Action Insert a tab into a listings inset.
3902 \begin_layout Description
3903 Notion It also works on a selection.
3906 \begin_layout Description
3910 \begin_layout Description
3911 Origin vfr, Sep 30 2008
3914 \begin_layout Subsection*
3918 \begin_layout Description
3919 Action Inserts table into the document.
3922 \begin_layout Description
3923 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3926 \begin_layout Description
3927 Syntax tabular-insert [<ROWS> <COLUMNS>]
3930 \begin_layout Description
3931 Params In case no arguments are given show insert dialog.
3934 \begin_layout Description
3935 Origin Jug, 12 Apr 2000
3938 \begin_layout Subsection*
3942 \begin_layout Description
3943 Action Look up thesaurus entries with respect to the word under the cursor.
3946 \begin_layout Description
3947 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
3950 \begin_layout Description
3951 Params <STRING>: word to look up <LANG>: language (see file languages)
3954 \begin_layout Description
3955 Origin Levon, 20 Jul 2001
3958 \begin_layout Subsection*
3962 \begin_layout Description
3963 Action Undoes the last edit.
3966 \begin_layout Description
3970 \begin_layout Subsection*
3974 \begin_layout Description
3975 Action Inserts a single unicode character.
3978 \begin_layout Description
3979 Syntax unicode-insert <CHAR>
3982 \begin_layout Description
3983 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
3986 \begin_layout Description
3987 Sample unicode-insert 0x0100
3990 \begin_layout Description
3991 Origin Lgb, 22 Oct 2006
3994 \begin_layout Subsection*
3998 \begin_layout Description
3999 Action Moves the cursor one line in upward direction.
4002 \begin_layout Description
4006 \begin_layout Subsection*
4010 \begin_layout Description
4011 Action Moves the cursor one line in upward direction adding the current position to the selection.
4014 \begin_layout Description
4018 \begin_layout Subsection*
4022 \begin_layout Description
4023 Action Moves the cursor to the logically previous beginning of a word.
4026 \begin_layout Description
4027 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.
4030 \begin_layout Description
4031 Syntax word-backward
4034 \begin_layout Subsection*
4035 word-backward-select
4038 \begin_layout Description
4039 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4042 \begin_layout Description
4043 Notion See also LFUN_WORD_BACKWARD.
4046 \begin_layout Description
4047 Syntax word-backward-select
4050 \begin_layout Subsection*
4054 \begin_layout Description
4055 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4058 \begin_layout Description
4059 Syntax word-capitalize [<SEL_TYPE>]
4062 \begin_layout Description
4063 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.
4066 \begin_layout Subsection*
4067 word-delete-backward
4070 \begin_layout Description
4071 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4074 \begin_layout Description
4075 Syntax word-delete-backward
4078 \begin_layout Subsection*
4082 \begin_layout Description
4083 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4086 \begin_layout Description
4087 Syntax word-delete-forward
4090 \begin_layout Subsection*
4094 \begin_layout Description
4095 Action Search for next occurrence of a string.
4098 \begin_layout Description
4099 Syntax word-find [<DATA>]
4102 \begin_layout Description
4103 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).
4106 \begin_layout Description
4107 Origin Andre, Jan 7 2004
4110 \begin_layout Subsection*
4114 \begin_layout Description
4115 Action Search for a given string in backward direction.
4118 \begin_layout Description
4119 Notion Case sensitive, match words. If no argument given, last search repeated.
4122 \begin_layout Description
4123 Syntax word-find-backward [<STRING>]
4126 \begin_layout Description
4127 Origin Etienne, 20 Feb 1998
4130 \begin_layout Subsection*
4134 \begin_layout Description
4135 Action Search for a given string in forward direction.
4138 \begin_layout Description
4139 Notion Case sensitive, match words. If no argument given, last search repeated.
4142 \begin_layout Description
4143 Syntax word-find-forward [<STRING>]
4146 \begin_layout Description
4147 Origin Etienne, 16 Feb 1998
4150 \begin_layout Subsection*
4154 \begin_layout Description
4155 Action Search for next occurrence of a pattern.
4158 \begin_layout Description
4159 Syntax word-findadv [<DATA>]
4162 \begin_layout Description
4163 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).
4166 \begin_layout Description
4167 Origin Tommaso, Nov 15 2007
4170 \begin_layout Subsection*
4174 \begin_layout Description
4175 Action Moves the cursor to the logically next beginning of a word.
4178 \begin_layout Description
4179 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.
4182 \begin_layout Description
4186 \begin_layout Subsection*
4190 \begin_layout Description
4191 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4194 \begin_layout Description
4195 Notion See also LFUN_WORD_FORWARD.
4198 \begin_layout Description
4199 Syntax word-forward-select
4202 \begin_layout Subsection*
4206 \begin_layout Description
4207 Action Moves the cursor to the next beginning of a word "on the left".
4210 \begin_layout Description
4211 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.
4214 \begin_layout Description
4218 \begin_layout Description
4219 Origin dov, 28 Oct 2007
4222 \begin_layout Subsection*
4226 \begin_layout Description
4227 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4230 \begin_layout Description
4231 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4234 \begin_layout Description
4235 Syntax word-left-select
4238 \begin_layout Description
4239 Origin dov, 28 Oct 2007
4242 \begin_layout Subsection*
4246 \begin_layout Description
4247 Action Change the words in the selection or word at cursor position to lower case.
4250 \begin_layout Description
4251 Syntax word-lowcase [<SEL_TYPE>]
4254 \begin_layout Description
4255 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.
4258 \begin_layout Subsection*
4262 \begin_layout Description
4263 Action Replace a string in the document.
4266 \begin_layout Description
4267 Syntax word-replace [<DATA>]
4270 \begin_layout Description
4271 Params <DATA>: data is of the form "<replace>
4272 \begin_inset Newline newline
4276 \begin_inset Newline newline
4279 <casesensitive> <matchword> <all> <forward> <findnext>"
4282 \begin_layout Description
4283 Origin Andre, Jan 7 2004
4286 \begin_layout Subsection*
4290 \begin_layout Description
4291 Action Moves the cursor to the next beginning of a word "on the right".
4294 \begin_layout Description
4295 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.
4298 \begin_layout Description
4302 \begin_layout Description
4303 Origin dov, 28 Oct 2007
4306 \begin_layout Subsection*
4310 \begin_layout Description
4311 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4314 \begin_layout Description
4315 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4318 \begin_layout Description
4319 Syntax word-right-select
4322 \begin_layout Description
4323 Origin dov, 28 Oct 2007
4326 \begin_layout Subsection*
4330 \begin_layout Description
4331 Action Puts the word where the cursor stands into the selection.
4334 \begin_layout Description
4338 \begin_layout Description
4339 Origin Andre, 11 Sep 2002
4342 \begin_layout Subsection*
4346 \begin_layout Description
4347 Action Change the words in the selection or word at cursor position to upper case.
4350 \begin_layout Description
4351 Syntax word-upcase [<SEL_TYPE>]
4354 \begin_layout Description
4355 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.
4358 \begin_layout Subsection*
4362 \begin_layout Description
4363 Action Inserts floats wrapped by the text around.
4366 \begin_layout Description
4367 Syntax wrap-insert <TYPE>
4370 \begin_layout Description
4371 Params <TYPE>: table|figure
4374 \begin_layout Description
4375 Origin Dekel, 7 Apr 2002
4378 \begin_layout Section
4379 Math Editor Functions
4382 \begin_layout Subsection*
4383 in-mathmacrotemplate
4386 \begin_layout Description
4387 Action Only active in Math Macro definition.
4390 \begin_layout Description
4391 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.
4394 \begin_layout Description
4395 Syntax in-mathmacrotemplate
4398 \begin_layout Description
4399 Origin sts, 06 January 2008
4402 \begin_layout Subsection*
4406 \begin_layout Description
4407 Action Inserts an extended matrix as provided by the amsmath package.
4410 \begin_layout Description
4411 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4414 \begin_layout Description
4415 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'.
4418 \begin_layout Description
4419 Sample math-ams-matrix 3 3 bmatrix
4422 \begin_layout Subsection*
4426 \begin_layout Description
4427 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4430 \begin_layout Description
4431 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4434 \begin_layout Description
4435 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4436 \begin_inset Newline newline
4439 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4442 \begin_layout Description
4443 Sample math-bigdelim "Bigl" "
4450 \begin_layout Description
4451 Origin Enrico & Georg, 7 May 2006
4454 \begin_layout Subsection*
4458 \begin_layout Description
4459 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4462 \begin_layout Description
4463 Syntax math-delim [<LEFT>] [<RIGHT>]
4466 \begin_layout Description
4467 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.
4470 \begin_layout Description
4471 Sample math-delim { rangle
4474 \begin_layout Description
4475 Origin Alejandro, 18 Jun 1996
4478 \begin_layout Subsection*
4482 \begin_layout Description
4483 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4486 \begin_layout Description
4487 Syntax math-display [<ARG>]
4490 \begin_layout Description
4491 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4494 \begin_layout Description
4495 Origin Alejandro, 18 Jun 1996
4498 \begin_layout Subsection*
4502 \begin_layout Description
4503 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4506 \begin_layout Description
4507 Notion Selection can be used to determine the input for the external program.
4510 \begin_layout Description
4511 Syntax math-extern <LANG> [<COMMAND>]
4514 \begin_layout Description
4515 Params <LANG>: octave|maxima|maple|mathematica|script
4516 \begin_inset Newline newline
4519 where "script" stands for the external script (normalized expression will be passed)
4522 \begin_layout Description
4523 Sample math-extern maple simplify
4526 \begin_layout Description
4527 Origin Andre, 24 Apr 2001
4530 \begin_layout Subsection*
4534 \begin_layout Description
4535 Action Changes the text style used in math.
4538 \begin_layout Description
4539 Syntax math-font-style <STYLE>
4542 \begin_layout Description
4543 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4544 \begin_inset Newline newline
4547 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4550 \begin_layout Description
4551 Origin vfr, 9 jan 2009
4554 \begin_layout Subsection*
4558 \begin_layout Description
4559 Action Inserts math objects and symbols.
4562 \begin_layout Description
4563 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4565 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
4567 frac{x}{y}" replaces "abc" with "
4569 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.
4572 \begin_layout Description
4573 Syntax math-insert <ARG>
4576 \begin_layout Description
4577 Params <ARG>: Symbol or LaTeX code to be inserted.
4580 \begin_layout Subsection*
4584 \begin_layout Description
4585 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.
4588 \begin_layout Description
4589 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4592 \begin_layout Description
4593 Syntax math-limits [<STATE>]
4596 \begin_layout Description
4597 Params <STATE>: limits|nolimits
4600 \begin_layout Subsection*
4604 \begin_layout Description
4605 Action Inserts a math macro definition at the cursor position in the text.
4608 \begin_layout Description
4609 Syntax math-macro <NAME> [<NARGS>] [def]
4612 \begin_layout Description
4613 Params <NAME>: The name of the macro, e.g. "mymacro".
4614 \begin_inset Newline newline
4617 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4620 \begin_layout Description
4621 Origin ale, 10 May 1997; sts, 21 Dec 2007
4624 \begin_layout Subsection*
4625 math-macro-add-greedy-optional-param
4628 \begin_layout Description
4629 Action Add a greedy optional parameter.
4632 \begin_layout Description
4633 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4636 \begin_layout Description
4637 Syntax math-macro-add-greedy-optional-param
4640 \begin_layout Description
4641 Origin sts, 06 January 2008
4644 \begin_layout Subsection*
4645 math-macro-add-optional-param
4648 \begin_layout Description
4649 Action Add an optional parameter.
4652 \begin_layout Description
4653 Notion Insert an optional parameter just behind the already existing optional parameters.
4656 \begin_layout Description
4657 Syntax math-macro-add-optional-param
4660 \begin_layout Description
4661 Origin sts, 06 January 2008
4664 \begin_layout Subsection*
4665 math-macro-add-param
4668 \begin_layout Description
4669 Action Add a parameter.
4672 \begin_layout Description
4673 Notion Add a parameter to a Math Macro.
4676 \begin_layout Description
4677 Syntax math-macro-add-param <NUM>
4680 \begin_layout Description
4681 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.
4684 \begin_layout Description
4685 Origin sts, 06 January 2008
4688 \begin_layout Subsection*
4689 math-macro-append-greedy-param
4692 \begin_layout Description
4693 Action Append a greedy parameter.
4696 \begin_layout Description
4697 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
4700 \begin_layout Description
4701 Syntax math-macro-append-greedy-param
4704 \begin_layout Description
4705 Origin sts, 06 January 2008
4708 \begin_layout Subsection*
4712 \begin_layout Description
4713 Action Fold a Math Macro.
4716 \begin_layout Description
4717 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
4722 \begin_layout Description
4723 Syntax math-macro-fold
4726 \begin_layout Description
4727 Origin sts, 06 January 2008
4730 \begin_layout Subsection*
4731 math-macro-make-nonoptional
4734 \begin_layout Description
4735 Action Make a parameter non-optional.
4738 \begin_layout Description
4739 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.
4742 \begin_layout Description
4743 Syntax math-macro-make-nonoptional
4746 \begin_layout Description
4747 Origin sts, 06 January 2008
4750 \begin_layout Subsection*
4751 math-macro-make-optional
4754 \begin_layout Description
4755 Action Make a parameter optional.
4758 \begin_layout Description
4759 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
4762 \begin_layout Description
4763 Syntax math-macro-make-optional
4766 \begin_layout Description
4767 Origin sts, 06 January 2008
4770 \begin_layout Subsection*
4771 math-macro-remove-greedy-param
4774 \begin_layout Description
4775 Action Remove a greedy parameter.
4778 \begin_layout Description
4779 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.
4782 \begin_layout Description
4783 Syntax math-macro-remove-greedy-param
4786 \begin_layout Description
4787 Origin sts, 06 January 2008
4790 \begin_layout Subsection*
4791 math-macro-remove-optional-param
4794 \begin_layout Description
4795 Action Remove the last optional parameter.
4798 \begin_layout Description
4799 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
4802 \begin_layout Description
4803 Syntax math-macro-remove-optional-param
4806 \begin_layout Description
4807 Origin sts, 06 January 2008
4810 \begin_layout Subsection*
4811 math-macro-remove-param
4814 \begin_layout Description
4815 Action Remove the last parameter.
4818 \begin_layout Description
4819 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
4822 \begin_layout Description
4823 Syntax math-macro-remove-param <NUM>
4826 \begin_layout Description
4827 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
4830 \begin_layout Description
4831 Origin sts, 06 January 2008
4834 \begin_layout Subsection*
4838 \begin_layout Description
4839 Action Unfold a Math Macro.
4842 \begin_layout Description
4843 Notion Unfold the Math Macro the cursor is in, i.e. display it as
4848 \begin_layout Description
4849 Syntax math-macro-unfold
4852 \begin_layout Description
4853 Origin sts, 06 January 2008
4856 \begin_layout Subsection*
4860 \begin_layout Description
4861 Action Inserts a matrix.
4864 \begin_layout Description
4865 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
4868 \begin_layout Description
4869 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).
4872 \begin_layout Description
4873 Sample math-matrix 3 3 bccc
4876 \begin_layout Subsection*
4880 \begin_layout Description
4881 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.
4884 \begin_layout Description
4885 Notion If there is some selected text, it puts the text inside created math box.
4888 \begin_layout Description
4889 Syntax math-mode [on|<ARG>]
4892 \begin_layout Description
4893 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
4894 \begin_inset Newline newline
4897 "on": allow only entering of math mode from text mode.
4900 \begin_layout Description
4901 Origin Alejandro, 4 Jun 1996
4904 \begin_layout Subsection*
4908 \begin_layout Description
4909 Action Mutates the type of math inset to the newly selected one.
4912 \begin_layout Description
4913 Syntax math-mutate <TYPE>
4916 \begin_layout Description
4917 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
4920 \begin_layout Description
4921 Origin Andre, 23 May 2001
4924 \begin_layout Subsection*
4925 math-number-line-toggle
4928 \begin_layout Description
4929 Action Toggles numbering of the current formula line.
4932 \begin_layout Description
4933 Notion Must be in display formula mode.
4936 \begin_layout Description
4937 Syntax math-number-line-toggle
4940 \begin_layout Description
4941 Origin Alejandro, 18 Jun 1996
4944 \begin_layout Subsection*
4948 \begin_layout Description
4949 Action Toggles numbering/labeling of the current formula.
4952 \begin_layout Description
4953 Notion Must be in display formula mode.
4956 \begin_layout Description
4957 Syntax math-number-toggle
4960 \begin_layout Description
4961 Origin Alejandro, 4 Jun 1996
4964 \begin_layout Subsection*
4968 \begin_layout Description
4969 Action Changes arbitrarily the size used by math fonts inside a context.
4972 \begin_layout Description
4973 Notion Provides an interface to the LaTeX math mode font size commands.
4976 \begin_layout Description
4977 Syntax math-size <STYLE>
4980 \begin_layout Description
4992 \begin_layout Description
4993 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
4996 \begin_layout Subsection*
5000 \begin_layout Description
5001 Action Inserts space into math expression.
5004 \begin_layout Description
5005 Notion Use spacebar after entering this space to change type of space.
5008 \begin_layout Description
5009 Syntax math-space [<TYPE>] [<LEN>]
5012 \begin_layout Description
5013 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5014 \begin_inset Newline newline
5017 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5018 \begin_inset Newline newline
5021 custom space: hspace
5022 \begin_inset Newline newline
5025 "," used by default.
5026 \begin_inset Newline newline
5029 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5030 \begin_inset Newline newline
5033 <LEN>: length for custom spaces (hspace)
5036 \begin_layout Description
5037 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5040 \begin_layout Subsection*
5044 \begin_layout Description
5045 Action Enters subscript expression in math expression.
5048 \begin_layout Description
5049 Syntax math-subscript
5052 \begin_layout Description
5053 Origin vermeer, 12 Dec 2001
5056 \begin_layout Subsection*
5060 \begin_layout Description
5061 Action Enters superscript expression in math expression.
5064 \begin_layout Description
5065 Syntax math-superscript
5068 \begin_layout Description
5069 Origin vermeer, 12 Dec 2001
5072 \begin_layout Subsection*
5076 \begin_layout Description
5077 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5080 \begin_layout Description
5081 Notion If there is any selected text, then it is moved inside the created regexp inset.
5084 \begin_layout Description
5085 Syntax regexp-mode [<ARG>]
5088 \begin_layout Description
5089 Params <ARG>: eventual argument (regular expression).
5092 \begin_layout Description
5093 Origin Tommaso, 4 Oct 2008
5096 \begin_layout Section
5097 Buffer Fuctions (File and Window related)
5100 \begin_layout Subsection*
5104 \begin_layout Description
5105 Action Activate the branch.
5108 \begin_layout Description
5109 Syntax branch-activate <BRANCH>
5112 \begin_layout Description
5113 Params <BRANCH>: The branch to activate
5116 \begin_layout Description
5117 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5118 \begin_inset Newline newline
5121 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5124 \begin_layout Description
5125 Origin rgh, 27 May 2008
5128 \begin_layout Subsection*
5132 \begin_layout Description
5133 Action Add a branch to the buffer's BranchList.
5136 \begin_layout Description
5137 Syntax branch-add <BRANCH>
5140 \begin_layout Description
5141 Params <BRANCH>: Name of the branch to add
5144 \begin_layout Description
5145 Origin spitz, 7 Jul 2009
5148 \begin_layout Subsection*
5152 \begin_layout Description
5153 Action Create new branch and directly put the branch inset into the document.
5156 \begin_layout Description
5157 Syntax branch-add-insert [<NAME>]
5160 \begin_layout Description
5161 Params <NAME>: Branch name. If it is not specified, you will be asked.
5164 \begin_layout Description
5165 Origin sanda, 10 Jul 2009
5168 \begin_layout Subsection*
5172 \begin_layout Description
5173 Action De-activate the branch.
5176 \begin_layout Description
5177 Syntax branch-deactivate <BRANCH>
5180 \begin_layout Description
5181 Params <BRANCH>: The branch to deactivate
5184 \begin_layout Description
5185 Origin rgh, 27 May 2008
5188 \begin_layout Subsection*
5189 branch-master-activate
5192 \begin_layout Description
5193 Action Activate the branch in the master buffer.
5196 \begin_layout Description
5197 Syntax branch-master-activate <BRANCH>
5200 \begin_layout Description
5201 Params <BRANCH>: The branch to activate
5204 \begin_layout Description
5205 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5206 \begin_inset Newline newline
5209 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5212 \begin_layout Description
5213 Origin spitz, 30 Sep 2012
5216 \begin_layout Subsection*
5217 branch-master-deactivate
5220 \begin_layout Description
5221 Action De-activate the branch in the master buffer.
5224 \begin_layout Description
5225 Syntax branch-master-deactivate <BRANCH>
5228 \begin_layout Description
5229 Params <BRANCH>: The branch to deactivate
5232 \begin_layout Description
5233 Origin spitz, 30 Sep 2012
5236 \begin_layout Subsection*
5240 \begin_layout Description
5241 Action Rename all branches of a given name in a document.
5244 \begin_layout Description
5245 Syntax branches-rename <OLDNAME> <NEWNAME>
5248 \begin_layout Description
5249 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5252 \begin_layout Description
5253 Origin spitz, 9 Jul 2009
5256 \begin_layout Subsection*
5260 \begin_layout Description
5261 Action Saves the current buffer to a temporary file.
5264 \begin_layout Description
5265 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5268 \begin_layout Description
5269 Syntax buffer-auto-save
5272 \begin_layout Subsection*
5276 \begin_layout Description
5277 Action Loads the given child document.
5280 \begin_layout Description
5281 Notion The current document is treated as a parent.
5284 \begin_layout Description
5285 Syntax buffer-child-open <FILE>
5288 \begin_layout Description
5289 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5292 \begin_layout Description
5293 Origin Ale, 28 May 1997
5296 \begin_layout Subsection*
5300 \begin_layout Description
5301 Action Runs chktex for the current document.
5304 \begin_layout Description
5305 Syntax buffer-chktex
5308 \begin_layout Description
5309 Origin Asger, 30 Oct 1997
5312 \begin_layout Subsection*
5316 \begin_layout Description
5317 Action Closes the current buffer.
5320 \begin_layout Description
5321 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5324 \begin_layout Description
5328 \begin_layout Subsection*
5332 \begin_layout Description
5333 Action Closes all buffers.
5336 \begin_layout Description
5337 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5340 \begin_layout Description
5341 Syntax buffer-close-all
5344 \begin_layout Subsection*
5348 \begin_layout Description
5349 Action Exports the current buffer (document) to the given format.
5352 \begin_layout Description
5353 Syntax buffer-export <FORMAT> [<DEST>]
5356 \begin_layout Description
5357 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.
5358 \begin_inset Newline newline
5361 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.
5364 \begin_layout Description
5365 Origin Lgb, 29 Jul 1997
5368 \begin_layout Subsection*
5372 \begin_layout Description
5373 Action Opens a dialog for exporting the current buffer.
5376 \begin_layout Description
5377 Syntax buffer-export-as [<FORMAT>]
5380 \begin_layout Description
5381 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.
5384 \begin_layout Description
5385 Sample buffer-export-as pdf2
5388 \begin_layout Description
5389 Origin tommaso, 6 Oct 2011
5392 \begin_layout Subsection*
5393 buffer-export-custom
5396 \begin_layout Description
5397 Action Exports the current buffer (document) from the given format using the given command on it.
5400 \begin_layout Description
5401 Syntax buffer-export-custom <FORMAT> <COMMAND>
5404 \begin_layout Description
5405 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5406 \begin_inset Newline newline
5409 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5412 \begin_layout Description
5413 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5416 \begin_layout Description
5417 Origin leeming, 27 Mar 2004
5420 \begin_layout Subsection*
5424 \begin_layout Description
5425 Action Applies a command to all non-hidden buffers.
5428 \begin_layout Description
5429 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5432 \begin_layout Description
5433 Syntax buffer-forall <LFUN-COMMAND>
5436 \begin_layout Description
5437 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5440 \begin_layout Description
5441 Sample Close all Notes in buffers:
5442 \begin_inset Newline newline
5445 buffer-forall inset-forall Note inset-toggle close
5446 \begin_inset Newline newline
5449 Toggle change tracking on buffers:
5450 \begin_inset Newline newline
5453 buffer-forall changes-track
5454 \begin_inset Newline newline
5457 Toggle read-only for buffers:
5458 \begin_inset Newline newline
5461 buffer-forall buffer-toggle-read-only
5462 \begin_inset Newline newline
5465 Show statistics for individual buffers:
5466 \begin_inset Newline newline
5469 buffer-forall statistics
5470 \begin_inset Newline newline
5473 Activate the branch named "Solutions" in buffers:
5474 \begin_inset Newline newline
5477 buffer-forall branch-activate Solutions
5478 \begin_inset Newline newline
5481 Export buffers to PDF (pdflatex):
5482 \begin_inset Newline newline
5485 buffer-forall buffer-export pdf2
5486 \begin_inset Newline newline
5492 \begin_layout Description
5493 Origin skostysh, 20 Jul 2012
5496 \begin_layout Subsection*
5500 \begin_layout Description
5501 Action Import a given file as a lyx document.
5504 \begin_layout Description
5505 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.
5508 \begin_layout Description
5509 Syntax buffer-import <FORMAT> [<FILE>]
5512 \begin_layout Description
5513 Origin Asger, 24 Jul 1998
5516 \begin_layout Subsection*
5520 \begin_layout Description
5521 Action Set language of the current document.
5524 \begin_layout Description
5525 Syntax buffer-language <LANG>
5528 \begin_layout Description
5529 Params <LANG>: language name. See lib/languages for list.
5532 \begin_layout Description
5533 Origin leeming, 30 Mar 2004
5536 \begin_layout Subsection*
5540 \begin_layout Description
5541 Action Moves the current tab one spot to the right.
5544 \begin_layout Description
5545 Syntax buffer-move-next
5548 \begin_layout Description
5549 Origin skostysh, 7 Apr 2015
5552 \begin_layout Subsection*
5553 buffer-move-previous
5556 \begin_layout Description
5557 Action Moves the current tab one spot to the left.
5560 \begin_layout Description
5561 Syntax buffer-move-previous
5564 \begin_layout Description
5565 Origin skostysh, 7 Apr 2015
5568 \begin_layout Subsection*
5572 \begin_layout Description
5573 Action Creates a new buffer (that is, document) and switches to it.
5576 \begin_layout Description
5577 Notion Implicit path can be set in Preferences dialog.
5580 \begin_layout Description
5581 Syntax buffer-new [<FILE>]
5584 \begin_layout Description
5585 Params <FILE>: filename of created file with absolute path.
5588 \begin_layout Subsection*
5592 \begin_layout Description
5593 Action Creates a new buffer (that is, document) from a template.
5596 \begin_layout Description
5597 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5600 \begin_layout Description
5601 Syntax buffer-new-template [<FILE>]
5604 \begin_layout Description
5605 Params <FILE>: filename of created file with absolute path.
5608 \begin_layout Subsection*
5612 \begin_layout Description
5613 Action Switch to the next opened document.
5616 \begin_layout Description
5617 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
5620 \begin_layout Description
5624 \begin_layout Subsection*
5628 \begin_layout Description
5629 Action Apply the given settings to the current document.
5632 \begin_layout Description
5633 Syntax buffer-params-apply [<ARGS>]
5636 \begin_layout Description
5637 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5640 \begin_layout Description
5641 Origin leeming, 30 Mar 2004
5644 \begin_layout Subsection*
5648 \begin_layout Description
5649 Action Switch to the previous opened document.
5652 \begin_layout Description
5653 Syntax buffer-previous
5656 \begin_layout Subsection*
5660 \begin_layout Description
5661 Action Reverts opened document.
5664 \begin_layout Description
5665 Syntax buffer-reload
5668 \begin_layout Description
5669 Origin Asger, 2 Feb 1997
5672 \begin_layout Subsection*
5673 buffer-save-as-default
5676 \begin_layout Description
5677 Action Save the current document settings as default.
5680 \begin_layout Description
5681 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5684 \begin_layout Description
5685 Syntax buffer-save-as-default [<ARGS>]
5688 \begin_layout Description
5689 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5692 \begin_layout Description
5693 Origin leeming, 30 Mar 2004
5696 \begin_layout Subsection*
5700 \begin_layout Description
5701 Action Display and switch to the given buffer.
5704 \begin_layout Description
5705 Syntax buffer-switch <BUFFER>
5708 \begin_layout Description
5709 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
5712 \begin_layout Subsection*
5713 buffer-toggle-compression
5716 \begin_layout Description
5717 Action Toggles compression of the current document on/off.
5720 \begin_layout Description
5721 Syntax buffer-toggle-compression
5724 \begin_layout Description
5725 Origin bpeng, 27 Apr 2006
5728 \begin_layout Subsection*
5729 buffer-toggle-read-only
5732 \begin_layout Description
5733 Action Toggle editing mode of the current document between read/write and read-only.
5736 \begin_layout Description
5737 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.
5740 \begin_layout Description
5741 Syntax buffer-toggle-read-only
5744 \begin_layout Description
5745 Origin Lgb, 27 May 1997
5748 \begin_layout Subsection*
5752 \begin_layout Description
5753 Action Exports the current document and put the result into the temporary directory.
5756 \begin_layout Description
5757 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).
5760 \begin_layout Description
5761 Syntax buffer-update [<FORMAT>]
5764 \begin_layout Description
5765 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.
5768 \begin_layout Description
5769 Origin Dekel, 5 Aug 2000
5772 \begin_layout Subsection*
5776 \begin_layout Description
5777 Action Displays current buffer in chosen format.
5780 \begin_layout Description
5781 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.
5784 \begin_layout Description
5785 Syntax buffer-view [<FORMAT>]
5788 \begin_layout Description
5789 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.
5792 \begin_layout Subsection*
5796 \begin_layout Description
5797 Action Opens the file that was created from last preview of this buffer.
5800 \begin_layout Description
5801 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.
5804 \begin_layout Description
5805 Syntax buffer-view-cache
5808 \begin_layout Subsection*
5812 \begin_layout Description
5813 Action Saves the current buffer.
5816 \begin_layout Description
5817 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.
5820 \begin_layout Description
5824 \begin_layout Subsection*
5828 \begin_layout Description
5829 Action Save all changed documents.
5832 \begin_layout Description
5833 Syntax buffer-write-all
5836 \begin_layout Description
5837 Origin rgh, gpothier 6 Aug 2007
5840 \begin_layout Subsection*
5844 \begin_layout Description
5845 Action Rename and save current buffer.
5848 \begin_layout Description
5849 Syntax buffer-write-as <FILENAME>
5852 \begin_layout Description
5853 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
5856 \begin_layout Subsection*
5860 \begin_layout Description
5861 Action Increases the zoom of the screen fonts.
5864 \begin_layout Description
5865 Syntax buffer-zoom-in [<ZOOM>]
5868 \begin_layout Description
5869 Params <ZOOM>: The zoom in %, the default is 20.
5872 \begin_layout Description
5873 Origin vfr, 30 Mar 2009
5876 \begin_layout Subsection*
5880 \begin_layout Description
5881 Action Decreases the zoom of the screen fonts.
5884 \begin_layout Description
5885 Syntax buffer-zoom-out [<ZOOM>]
5888 \begin_layout Description
5889 Params <ZOOM>: The zoom in %, the default is 20.
5892 \begin_layout Description
5893 Origin vfr, 30 Mar 2009
5896 \begin_layout Subsection*
5900 \begin_layout Description
5901 Action Generates the code (literate programming).
5904 \begin_layout Description
5905 Notion Latex file with extension
5907 literate_extension is generated. Then LyX invokes
5909 build_command (with a default of ``make'') to generate the code and
5911 build_error_filter to process the compilation error messages.
5912 \begin_inset Newline newline
5915 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:
5916 \begin_inset Newline newline
5921 build_command "my_script my_arguments"
5922 \begin_inset Newline newline
5927 build_error_filter differs from the
5929 literate_error_filter only in that the former will identify error messages from your compiler.
5932 \begin_layout Description
5933 Syntax build-program
5936 \begin_layout Subsection*
5940 \begin_layout Description
5941 Action Open LyX document.
5944 \begin_layout Description
5945 Syntax file-open [<FILE>]
5948 \begin_layout Description
5949 Params <FILE>: Filename to be opened.
5952 \begin_layout Subsection*
5956 \begin_layout Description
5957 Action Open the given help file according to the language setting.
5960 \begin_layout Description
5961 Syntax help-open <FILE>[.lyx]
5964 \begin_layout Description
5965 Params <FILE>: any document from (/usr/share/)doc directory.
5968 \begin_layout Description
5969 Origin Jug, 27 Jun 1999
5972 \begin_layout Subsection*
5976 \begin_layout Description
5977 Action Terminates the current LyX instance.
5980 \begin_layout Description
5981 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
5984 \begin_layout Description
5988 \begin_layout Subsection*
5989 master-buffer-update
5992 \begin_layout Description
5993 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
5996 \begin_layout Description
5997 Syntax master-buffer-update [<FORMAT>]
6000 \begin_layout Description
6001 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.
6004 \begin_layout Description
6005 Origin Tommaso, 20 Sep 2007
6008 \begin_layout Subsection*
6012 \begin_layout Description
6013 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6016 \begin_layout Description
6017 Syntax master-buffer-view [<FORMAT>]
6020 \begin_layout Description
6021 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.
6024 \begin_layout Description
6025 Origin Tommaso, 20 Sep 2007
6028 \begin_layout Subsection*
6032 \begin_layout Description
6033 Action Opens the menu given by its name.
6036 \begin_layout Description
6037 Syntax menu-open <NAME>
6040 \begin_layout Description
6041 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6044 \begin_layout Subsection*
6048 \begin_layout Description
6049 Action Close the current tab group.
6052 \begin_layout Description
6053 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6056 \begin_layout Description
6057 Syntax tab-group-close
6060 \begin_layout Description
6061 Origin Abdel, 21 Feb 2008
6064 \begin_layout Subsection*
6068 \begin_layout Description
6069 Action Toggles visibility of a given toolbar between on/off/auto.
6072 \begin_layout Description
6073 Notion Skipping "auto" when allowauto is false.
6076 \begin_layout Description
6077 Syntax toolbar-toggle <NAME> [allowauto]
6080 \begin_layout Description
6081 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6082 \begin_inset Newline newline
6085 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6088 \begin_layout Description
6089 Origin Edwin, 21 May 2007
6092 \begin_layout Subsection*
6096 \begin_layout Description
6097 Action Various UI visibility-toggling actions.
6100 \begin_layout Description
6101 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6104 \begin_layout Description
6105 Params statusbar : Toggle visibility of the statusbar.
6106 \begin_inset Newline newline
6109 menubar : Toggle visibility of the menubar.
6110 \begin_inset Newline newline
6113 scrollbar : Toggle visibility of the scrollbar.
6114 \begin_inset Newline newline
6117 frame : Toggle visibility of the frames around editing window.
6118 \begin_inset Newline newline
6121 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.
6124 \begin_layout Description
6125 Origin sanda, 9 Feb 2007
6128 \begin_layout Subsection*
6132 \begin_layout Description
6133 Action Close the current document work area.
6136 \begin_layout Description
6137 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6140 \begin_layout Description
6144 \begin_layout Description
6145 Origin Tommaso, 15 Sep 2012
6148 \begin_layout Subsection*
6152 \begin_layout Description
6153 Action Creates another split view of current buffer.
6156 \begin_layout Description
6157 Notion All split views act in the same way independently.
6160 \begin_layout Description
6161 Syntax view-split <vertical|horizontal>
6164 \begin_layout Description
6165 Params horizontal : The work areas are laid out side by side.
6166 \begin_inset Newline newline
6169 vertical : The work areas laid out vertically.
6172 \begin_layout Description
6173 Origin Abdel, 20 Feb 2008
6176 \begin_layout Subsection*
6180 \begin_layout Description
6181 Action Closes the current LyX window.
6184 \begin_layout Description
6188 \begin_layout Description
6189 Origin Abdel, 23 Oct 2006
6192 \begin_layout Subsection*
6196 \begin_layout Description
6197 Action Creates new empty LyX window.
6200 \begin_layout Description
6201 Notion Already opened documents from the previous window can be found under View menu.
6204 \begin_layout Description
6205 Syntax window-new [<GEOMETRY>]
6208 \begin_layout Description
6209 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6212 \begin_layout Description
6213 Origin Abdel, 21 Oct 2006
6216 \begin_layout Section
6217 System Functions (Preferences, LyX Server etc.)
6220 \begin_layout Subsection*
6221 buffer-toggle-output-sync
6224 \begin_layout Description
6225 Action Toggles including of resources for forward/reverse search of the given document.
6228 \begin_layout Description
6229 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6232 \begin_layout Description
6233 Syntax buffer-toggle-output-sync
6236 \begin_layout Description
6237 Origin sanda, 25 May 2010
6240 \begin_layout Subsection*
6244 \begin_layout Description
6245 Action Executes a command defined in a .def file.
6248 \begin_layout Description
6249 Notion The definitions are by default read from lib/commands/default.def.
6250 \begin_inset Newline newline
6253 A .def file allows to define a command with
6255 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).
6257 def_file "FileName" allows to include another .def file.
6258 \begin_inset Newline newline
6261 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.
6264 \begin_layout Description
6268 \begin_layout Description
6269 Params <NAME>: Name of the command that must be called.
6272 \begin_layout Description
6273 Origin broider, 2 Oct 2007
6276 \begin_layout Subsection*
6280 \begin_layout Description
6281 Action Cancels sequence prepared by LFUN_META_PREFIX .
6284 \begin_layout Description
6288 \begin_layout Subsection*
6289 command-alternatives
6292 \begin_layout Description
6293 Action Runs the first listed command that is enabled.
6296 \begin_layout Description
6297 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6300 \begin_layout Description
6301 Syntax command-alternatives <CMDS>
6304 \begin_layout Description
6305 Params <CMDS>: Sequence of commands separated by semicolons.
6308 \begin_layout Description
6309 Sample command-alternatives completion-accept;cell-forward
6312 \begin_layout Description
6313 Origin rgh, 24 September 2008
6316 \begin_layout Subsection*
6320 \begin_layout Description
6321 Action Run more commands (LFUN and its parameters) in a sequence.
6324 \begin_layout Description
6325 Syntax command-sequence <CMDS>
6328 \begin_layout Description
6329 Params <CMDS>: Sequence of commands separated by semicolons.
6332 \begin_layout Description
6333 Sample command-sequence cut; ert-insert; self-insert
6335 ; paste; self-insert {}; inset-toggle;
6338 \begin_layout Description
6339 Origin Andre, 11 Nov 1999
6342 \begin_layout Subsection*
6343 cursor-follows-scrollbar-toggle
6346 \begin_layout Description
6347 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6350 \begin_layout Description
6351 Syntax toggle-cursor-follows-scrollbar
6354 \begin_layout Description
6355 Origin ARRae, 2 Dec 1997
6358 \begin_layout Subsection*
6362 \begin_layout Description
6363 Action Set debug output level.
6366 \begin_layout Description
6367 Syntax debug-level-set <LEVEL>
6370 \begin_layout Description
6371 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.
6374 \begin_layout Description
6375 Origin sanda, 28 Dec 2009
6378 \begin_layout Subsection*
6382 \begin_layout Description
6383 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6386 \begin_layout Description
6387 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6390 \begin_layout Description
6391 Syntax forward-search
6394 \begin_layout Description
6395 Origin sanda, 14 Apr 2010
6398 \begin_layout Subsection*
6402 \begin_layout Description
6403 Action Apply the given settings to user preferences.
6406 \begin_layout Description
6407 Syntax lyxrc-apply <SETTINGS>
6410 \begin_layout Description
6411 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.
6414 \begin_layout Subsection*
6418 \begin_layout Description
6419 Action Shows message in statusbar (for script purposes).
6422 \begin_layout Description
6423 Syntax message <STRING>
6426 \begin_layout Description
6427 Origin Lgb, 8 Apr 2001
6430 \begin_layout Subsection*
6434 \begin_layout Description
6435 Action Simulate halting Meta key (Alt key on PCs).
6438 \begin_layout Description
6439 Notion Used for buffer edition not for GUI control.
6442 \begin_layout Description
6446 \begin_layout Subsection*
6450 \begin_layout Description
6451 Action Save user preferences.
6454 \begin_layout Description
6455 Syntax preferences-save
6458 \begin_layout Description
6459 Origin Lgb, 27 Nov 1999
6462 \begin_layout Subsection*
6466 \begin_layout Description
6467 Action Reconfigure the automatic settings.
6470 \begin_layout Description
6474 \begin_layout Description
6475 Origin Asger, 14 Feb 1997
6478 \begin_layout Subsection*
6482 \begin_layout Description
6483 Action Returns path and file name of the currently edited document.
6486 \begin_layout Description
6487 Syntax server-get-filename
6490 \begin_layout Subsection*
6494 \begin_layout Description
6495 Action Returns the current layout (that is environment) name on the cursor position.
6498 \begin_layout Description
6499 Syntax server-get-layout
6502 \begin_layout Subsection*
6503 server-get-statistics
6506 \begin_layout Description
6507 Action Returns the statistics (number of words and characters) in the document or in the given selection.
6510 \begin_layout Description
6511 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6514 \begin_layout Description
6515 Syntax server-get-statistics [<TYPE>]
6518 \begin_layout Description
6519 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
6520 \begin_inset Newline newline
6524 \begin_inset Newline newline
6527 chars: count characters.
6528 \begin_inset Newline newline
6531 chars-space: count characters and spaces.
6534 \begin_layout Description
6535 Origin brokenclock, Oct 10 2014
6538 \begin_layout Subsection*
6542 \begin_layout Description
6543 Action Returns the coordinates of cursor position in the editing area.
6546 \begin_layout Description
6547 Syntax server-get-xy
6550 \begin_layout Subsection*
6551 server-goto-file-row
6554 \begin_layout Description
6555 Action Sets the cursor position in LyX based on the row number of generated TeX file.
6558 \begin_layout Description
6559 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).
6562 \begin_layout Description
6563 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
6566 \begin_layout Description
6567 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.
6568 \begin_inset Newline newline
6571 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).
6572 \begin_inset Newline newline
6575 .ext: extensions will be automatically replaced by .lyx.
6576 \begin_inset Newline newline
6579 <ROW_NUMBER> The row number of the LaTeX file to which to go.
6582 \begin_layout Description
6583 Sample server-goto-file-row /home/user/example.lyx 41
6584 \begin_inset Newline newline
6587 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
6590 \begin_layout Description
6591 Origin Edmar, 23 Dec 1998
6594 \begin_layout Subsection*
6598 \begin_layout Description
6599 Action Sends notify message about the last key-sequence to client.
6602 \begin_layout Description
6603 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
6606 \begin_layout Description
6607 Syntax server-notify
6610 \begin_layout Subsection*
6614 \begin_layout Description
6615 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
6618 \begin_layout Description
6619 Syntax server-set-xy <X> <Y>
6622 \begin_layout Subsection*
6626 \begin_layout Description
6627 Action Set the given LyX color to the color defined by the X11 name given.
6630 \begin_layout Description
6631 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
6634 \begin_layout Description
6635 Syntax set-color <LYX_NAME> <X11_NAME>
6638 \begin_layout Description
6639 Origin SLior, 11 Jun 2000
6642 \begin_layout Subsection*
6646 \begin_layout Description
6647 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
6650 \begin_layout Description
6651 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6654 \begin_layout Description
6658 \begin_layout Description
6659 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6662 \begin_layout Subsection*
6666 \begin_layout Description
6667 Action Checks-in/commits the changes of the registered file to the repository.
6670 \begin_layout Description
6671 Notion In RCS case this also unlocks the file.
6674 \begin_layout Description
6678 \begin_layout Description
6679 Origin Lgb, 1 Jul 1997
6682 \begin_layout Subsection*
6686 \begin_layout Description
6687 Action Checks-out the document for edit (and locks it in some cases).
6690 \begin_layout Description
6694 \begin_layout Description
6695 Origin Lgb, 1 Jul 1997
6698 \begin_layout Subsection*
6702 \begin_layout Description
6703 Action Executes external command. This command is intended to support additional VCS commands.
6706 \begin_layout Description
6707 Syntax vc-command <FLAG> <PATH> <COMMAND>
6710 \begin_layout Description
6711 Params <FLAG>: Flags for the command can be combined together.
6712 \begin_inset Newline newline
6715 U - dUmmy - no flags
6716 \begin_inset Newline newline
6719 D - Doc - need document loaded to proceed
6720 \begin_inset Newline newline
6723 I - dIrty - mark document dirty
6724 \begin_inset Newline newline
6727 R - Reload - ensure that the document is saved and reload it after command execution
6728 \begin_inset Newline newline
6731 M - Message - ask for input string (commit message)
6732 \begin_inset Newline newline
6735 <PATH>: path where to start. $$p will be replaced by the current document path.
6736 \begin_inset Newline newline
6739 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
6742 \begin_layout Description
6743 Sample vc-command DR $$p "svn up"
6746 \begin_layout Description
6747 Origin sanda, 13 Jan 2009
6750 \begin_layout Subsection*
6754 \begin_layout Description
6755 Action Compares two revisions of the same file under version control.
6758 \begin_layout Description
6759 Syntax vc-compare [<REV1>] [<REV2>]
6762 \begin_layout Description
6763 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
6764 \begin_inset Newline newline
6767 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
6768 \begin_inset Newline newline
6772 \begin_inset Newline newline
6775 <REV2>: Newer file. Used only if REV1 > 0.
6776 \begin_inset Newline newline
6779 If no parameter is given, interactive dialog will be shown.
6782 \begin_layout Description
6783 Sample Compare current document against last commit
6784 \begin_inset Newline newline
6788 \begin_inset Newline newline
6791 Compare current document against current revision - 5 commits
6792 \begin_inset Newline newline
6796 \begin_inset Newline newline
6799 Compare revisions 120 and 155
6800 \begin_inset Newline newline
6806 \begin_layout Description
6807 Origin sanda, 12 Feb 2010
6810 \begin_layout Subsection*
6814 \begin_layout Description
6815 Action Copies the document to another name.
6818 \begin_layout Description
6819 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.
6822 \begin_layout Description
6823 Syntax vc-copy <FILENAME>
6826 \begin_layout Description
6827 Params <FILENAME>: New name of the document.
6828 \begin_inset Newline newline
6831 A file dialog is opened if no filename is given.
6834 \begin_layout Description
6835 Origin gb, 05 Feb 2013
6838 \begin_layout Subsection*
6842 \begin_layout Description
6843 Action Toggles the locking property of the edited file.
6846 \begin_layout Description
6847 Notion This is currently implemented only for SVN.
6850 \begin_layout Description
6851 Syntax vc-locking-toggle
6854 \begin_layout Description
6855 Origin sanda, 25 Jun 2009
6858 \begin_layout Subsection*
6862 \begin_layout Description
6863 Action Register the document as an file inside version control system.
6866 \begin_layout Description
6867 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
6868 \begin_inset Newline newline
6871 See LyX Additional Features Manual (Version Control Chapter) for additional information.
6874 \begin_layout Description
6878 \begin_layout Description
6879 Origin Lgb, 1 Jul 1997
6882 \begin_layout Subsection*
6886 \begin_layout Description
6887 Action Renames the document to another name.
6890 \begin_layout Description
6891 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.
6894 \begin_layout Description
6895 Syntax vc-rename <FILENAME>
6898 \begin_layout Description
6899 Params <FILENAME>: New name of the document.
6900 \begin_inset Newline newline
6903 A file dialog is opened if no filename is given.
6906 \begin_layout Description
6907 Origin gb, 05 Feb 2013
6910 \begin_layout Subsection*
6914 \begin_layout Description
6915 Action Update the local archive directory in which resides the current document with the remote repository.
6918 \begin_layout Description
6919 Syntax vc-repo-update
6922 \begin_layout Description
6923 Origin sanda, 16 Oct 2009
6926 \begin_layout Subsection*
6930 \begin_layout Description
6931 Action Reverts the document to the last check-in/commit in VCS.
6934 \begin_layout Description
6938 \begin_layout Description
6939 Origin Lgb, 1 Jul 1997
6942 \begin_layout Subsection*
6946 \begin_layout Description
6947 Action Undo last check-in.
6950 \begin_layout Description
6951 Notion This is currently implemented only for RCS.
6954 \begin_layout Description
6958 \begin_layout Description
6959 Origin Lgb, 1 Jul 1997
6962 \begin_layout Section
6963 Hidden Functions (not listed for configuration)
6966 \begin_layout Subsection*
6970 \begin_layout Description
6971 Action Return the current key sequence and available options as a string.
6974 \begin_layout Description
6975 Notion No options are added if no current map exists.
6976 \begin_inset Newline newline
6979 This is probably usable only with connection to lyxserver.
6982 \begin_layout Description
6983 Syntax command-prefix
6986 \begin_layout Subsection*
6990 \begin_layout Description
6991 Action Inserts the given string (accordingly to the correct keymap).
6994 \begin_layout Description
6995 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
6998 \begin_layout Description
6999 Syntax self-insert <STRING>