1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
10 \renewenvironment{description}{\list{}{%
11 \setlength{\itemsep}{-2pt}
12 \advance\leftmargini6\p@ \itemindent-12\p@
13 \labelwidth\z@ \let\makelabel\descriptionlabel}%
18 \use_default_options false
19 \maintain_unincluded_children false
27 \language_package default
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
38 \font_sf_scale 100 100
39 \font_tt_scale 100 100
42 \default_output_format default
44 \bibtex_command default
45 \index_command default
46 \paperfontsize default
51 \use_package amsmath 1
52 \use_package amssymb 1
55 \use_package mathdots 0
56 \use_package mathtools 0
58 \use_package stackrel 0
59 \use_package stmaryrd 0
60 \use_package undertilde 0
62 \cite_engine_type default
66 \paperorientation portrait
80 \paragraph_separation indent
81 \paragraph_indentation default
82 \quotes_language english
85 \paperpagestyle default
86 \tracking_changes false
105 \begin_layout Section*
109 \begin_layout Standard
110 This manual documents the
111 \begin_inset Quotes eld
115 \begin_inset Quotes erd
119 These are commands that are used to make \SpecialChar LyX
120 perform specific actions.
122 itself uses these functions internally, and every internal action is
126 \begin_layout Standard
127 LFUNs are also used in the files that define keyboard shortcuts, menu or
129 So if you want to change\SpecialChar breakableslash
130 customize the user interface, you need to deal
132 Furthermore, external programs can use LFUNs to communicate with and
133 \begin_inset Quotes eld
137 \begin_inset Quotes erd
142 Finally, you can also issue LFUNs directly via the so called mini-buffer
143 which can be opened via
146 arg "command-execute"
152 \begin_layout Standard
153 In the following, all LFUNs are listed, categorized by function.
156 \begin_layout Section
157 Layout Functions (Font, Layout and Textclass related)
160 \begin_layout Subsection*
164 \begin_layout Description
165 Action Displays list of layout choices.
168 \begin_layout Description
169 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
172 \begin_layout Description
173 Syntax drop-layouts-choice
176 \begin_layout Subsection*
180 \begin_layout Description
181 Action Splits the current environment with a Separator.
184 \begin_layout Description
185 Syntax environment-split [before|outer|previous]
188 \begin_layout Description
189 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
190 \begin_inset Newline newline
193 previous: If this is given, LyX will split the environment in the previous paragraph (if there is one).
194 \begin_inset Newline newline
197 before: If this is given, the new environment will be appended rather than prepended.
200 \begin_layout Description
201 Origin spitz, 23 Dec 2012
204 \begin_layout Subsection*
208 \begin_layout Description
209 Action Toggles the bold font (selection-wise) using mathbf in math.
212 \begin_layout Description
216 \begin_layout Subsection*
220 \begin_layout Description
221 Action Toggles the bold font (selection-wise) using boldsymbol in math.
224 \begin_layout Description
225 Syntax font-boldsymbol
228 \begin_layout Subsection*
232 \begin_layout Description
233 Action Toggles xout (cross-through) in the font (selection-wise).
236 \begin_layout Description
240 \begin_layout Description
241 Origin uwestoehr, 4 April 2017
244 \begin_layout Subsection*
248 \begin_layout Description
249 Action Reverts the settings of the font to the default values (selection-wise).
252 \begin_layout Description
256 \begin_layout Subsection*
260 \begin_layout Description
261 Action Toggles the emphasis font style (selection-wise).
264 \begin_layout Description
268 \begin_layout Subsection*
272 \begin_layout Description
273 Action Toggles Fraktur family font (math-mode, selection-wise).
276 \begin_layout Description
280 \begin_layout Description
281 Origin vermeer, 10 Jan 2002
284 \begin_layout Subsection*
288 \begin_layout Description
289 Action Toggles Italics font shape (math-mode, selection-wise).
292 \begin_layout Description
296 \begin_layout Description
297 Origin vermeer, 10 Jan 2002
300 \begin_layout Subsection*
304 \begin_layout Description
305 Action Toggles Noun text style font (selection-wise).
308 \begin_layout Description
312 \begin_layout Subsection*
316 \begin_layout Description
317 Action Toggles Roman family font (selection-wise).
320 \begin_layout Description
324 \begin_layout Subsection*
328 \begin_layout Description
329 Action Toggles Sans Serif family font (selection-wise).
332 \begin_layout Description
336 \begin_layout Subsection*
340 \begin_layout Description
341 Action Sets font size according to lyx format string.
344 \begin_layout Description
345 Syntax font-size <SIZE>
348 \begin_layout Description
349 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
350 \begin_inset Newline newline
353 largest|huge|giant|increase|decrease|default
356 \begin_layout Subsection*
360 \begin_layout Description
361 Action Returns the info about the current font.
364 \begin_layout Description
368 \begin_layout Subsection*
372 \begin_layout Description
373 Action Toggles strikeout (strike-through) in the font (selection-wise).
376 \begin_layout Description
377 Syntax font-strikeout
380 \begin_layout Description
381 Origin sanda, 3 May 2009
384 \begin_layout Subsection*
388 \begin_layout Description
389 Action Toggles the typewriter family font (selection-wise).
392 \begin_layout Description
393 Syntax font-typewriter
396 \begin_layout Subsection*
400 \begin_layout Description
401 Action Toggles underline in the font (selection-wise).
404 \begin_layout Description
405 Syntax font-underline
408 \begin_layout Subsection*
412 \begin_layout Description
413 Action Toggles double underline in the font (selection-wise).
416 \begin_layout Description
417 Syntax font-underunderline
420 \begin_layout Description
421 Origin sanda, 5 May 2009
424 \begin_layout Subsection*
428 \begin_layout Description
429 Action Toggles wavy underline in the font (selection-wise).
432 \begin_layout Description
433 Syntax font-underwave
436 \begin_layout Description
437 Origin sanda, 5 May 2009
440 \begin_layout Subsection*
444 \begin_layout Description
445 Action Sets the layout (that is, environment) for the current paragraph.
448 \begin_layout Description
449 Syntax layout <LAYOUT> [ignorenests]
452 \begin_layout Description
453 Params <LAYOUT>: the layout to use
454 \begin_inset Newline newline
457 ignorenests: If specified, nesting advices will be ignored.
460 \begin_layout Subsection*
464 \begin_layout Description
465 Action Adds a module.
468 \begin_layout Description
469 Notion Adds a module to the list of included modules for the current buffer.
472 \begin_layout Description
473 Syntax layout-module-add <MODULE>
476 \begin_layout Description
477 Params <MODULE>: the module to be added
480 \begin_layout Description
481 Origin rgh, 25 August 2007
484 \begin_layout Subsection*
488 \begin_layout Description
489 Action Clears the module list.
492 \begin_layout Description
493 Notion Clears the list of included modules for the current buffer.
496 \begin_layout Description
497 Syntax layout-modules-clear
500 \begin_layout Description
501 Origin rgh, 25 August 2007
504 \begin_layout Subsection*
508 \begin_layout Description
509 Action Launches the paragraph settings dialog.
512 \begin_layout Description
513 Syntax layout-paragraph
516 \begin_layout Subsection*
520 \begin_layout Description
521 Action Reloads layout information.
524 \begin_layout Description
525 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.
528 \begin_layout Description
532 \begin_layout Description
533 Origin rgh, 3 September 2007
536 \begin_layout Subsection*
540 \begin_layout Description
541 Action Launches the tabular settings dialog.
544 \begin_layout Description
545 Syntax layout-tabular
548 \begin_layout Description
549 Origin Jug, 31 Jul 2000
552 \begin_layout Subsection*
556 \begin_layout Description
557 Action Update fonts and its metrics.
560 \begin_layout Description
561 Notion Automatically called after zoom, dpi, font names, or norm change.
564 \begin_layout Description
565 Syntax screen-font-update
568 \begin_layout Description
569 Origin ARRae, 13 Aug 2000
572 \begin_layout Subsection*
576 \begin_layout Description
577 Action Sets the text class for the current buffer.
580 \begin_layout Description
581 Syntax textclass-apply <TEXTCLASS>
584 \begin_layout Description
585 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
588 \begin_layout Subsection*
592 \begin_layout Description
593 Action Loads information for a textclass from disk.
596 \begin_layout Description
597 Syntax textclass-load <TEXTCLASS>
600 \begin_layout Description
601 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
604 \begin_layout Subsection*
608 \begin_layout Description
609 Action Toggle user-defined (=last-time used) text style.
612 \begin_layout Description
613 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
616 \begin_layout Description
617 Syntax textstyle-apply
620 \begin_layout Description
621 Origin leeming, 12 Mar 2003
624 \begin_layout Subsection*
628 \begin_layout Description
629 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
632 \begin_layout Description
633 Syntax textstyle-update <FONT_INFO>
636 \begin_layout Description
637 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
638 \begin_inset Newline newline
641 Use lyx -dbg action for exact syntax of text-style dialog parameters.
644 \begin_layout Description
645 Origin leeming, 12 Mar 2003
648 \begin_layout Section
649 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
652 \begin_layout Subsection*
656 \begin_layout Description
657 Action Adds an acute accent to the next character typed.
660 \begin_layout Description
664 \begin_layout Subsection*
668 \begin_layout Description
669 Action Adds a breve accent to the next character typed.
672 \begin_layout Description
676 \begin_layout Subsection*
680 \begin_layout Description
681 Action Adds a caron to the next character typed.
684 \begin_layout Description
688 \begin_layout Subsection*
692 \begin_layout Description
693 Action Adds a cedilla to the next character typed.
696 \begin_layout Description
697 Syntax accent-cedilla
700 \begin_layout Subsection*
704 \begin_layout Description
705 Action Adds a circle accent to the next character typed.
708 \begin_layout Description
712 \begin_layout Subsection*
716 \begin_layout Description
717 Action Adds a circumflex to the next character typed.
720 \begin_layout Description
721 Syntax accent-circumflex
724 \begin_layout Subsection*
728 \begin_layout Description
729 Action Adds a dot accent to the next character typed.
732 \begin_layout Description
736 \begin_layout Subsection*
740 \begin_layout Description
741 Action Adds a grave accent to the next character typed.
744 \begin_layout Description
748 \begin_layout Subsection*
749 accent-hungarian-umlaut
752 \begin_layout Description
753 Action Adds a Hungarian umlaut to the next character typed.
756 \begin_layout Description
760 \begin_layout Subsection*
764 \begin_layout Description
765 Action Adds a macron to the next character typed.
768 \begin_layout Description
772 \begin_layout Subsection*
776 \begin_layout Description
777 Action Adds an ogonek accent to the next character typed.
780 \begin_layout Description
784 \begin_layout Subsection*
788 \begin_layout Description
789 Action Adds a perispomeni (Greek circumflex) over the next character typed.
792 \begin_layout Description
793 Syntax accent-perispomeni
796 \begin_layout Subsection*
800 \begin_layout Description
801 Action Adds a tie over the next two character typed.
804 \begin_layout Description
805 Notion The following char will finish the tie.
808 \begin_layout Description
812 \begin_layout Subsection*
816 \begin_layout Description
817 Action Adds a tilde over the next character typed.
820 \begin_layout Description
824 \begin_layout Subsection*
828 \begin_layout Description
829 Action Adds an umlaut over the next character typed.
832 \begin_layout Description
836 \begin_layout Subsection*
840 \begin_layout Description
841 Action Adds a bar under the next character typed.
844 \begin_layout Description
845 Syntax accent-underbar
848 \begin_layout Subsection*
852 \begin_layout Description
853 Action Adds a dot under the next character typed.
856 \begin_layout Description
857 Syntax accent-underdot
860 \begin_layout Subsection*
864 \begin_layout Description
865 Action Accepts all tracked changes in the document.
868 \begin_layout Description
869 Syntax all-changes-accept
872 \begin_layout Description
873 Origin Levon, 16 Oct 2002
876 \begin_layout Subsection*
880 \begin_layout Description
881 Action Rejects all tracked changes in the document.
884 \begin_layout Description
885 Notion Reject does not work recursively; the user may have to repeat the operation.
888 \begin_layout Description
889 Syntax all-changes-reject
892 \begin_layout Description
893 Origin Levon, 16 Oct 2002
896 \begin_layout Subsection*
900 \begin_layout Description
901 Action Start (or remove) Appendix on the given cursor position.
904 \begin_layout Description
908 \begin_layout Description
909 Origin ettrich, 5 May 1998
912 \begin_layout Subsection*
916 \begin_layout Description
917 Action Inserts an argument (short title) inset.
920 \begin_layout Description
921 Syntax argument-insert <argument nr>
924 \begin_layout Description
925 Params <argument nr>: see layout declarations
928 \begin_layout Description
929 Origin vermeer, 12 Aug 2002
932 \begin_layout Subsection*
936 \begin_layout Description
937 Action Adds database, which will be used for bibtex citations.
940 \begin_layout Description
941 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
944 \begin_layout Description
945 Syntax bibtex-database-add <DATABASE-NAME>
948 \begin_layout Description
949 Origin Ale, 30 May 1997
952 \begin_layout Subsection*
956 \begin_layout Description
957 Action Adds database, which will be used for bibtex citations.
960 \begin_layout Description
961 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
964 \begin_layout Description
965 Syntax bibtex-database-del <DATABASE-NAME>
968 \begin_layout Description
969 Origin Ale, 30 May 1997
972 \begin_layout Subsection*
976 \begin_layout Description
977 Action Clears the list of saved bookmarks.
980 \begin_layout Description
981 Syntax bookmark-clear
984 \begin_layout Description
985 Origin bpeng, 31 October 2006
988 \begin_layout Subsection*
992 \begin_layout Description
993 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
996 \begin_layout Description
997 Notion Bookmark 0 has a special purpose. It is automatically set
998 \begin_inset Newline newline
1001 1. to the paragraph you are currently editing
1002 \begin_inset Newline newline
1005 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1006 \begin_inset Newline newline
1009 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1012 \begin_layout Description
1013 Syntax bookmark-goto <NUMBER>
1016 \begin_layout Description
1017 Params <NUMBER>: the number of the bookmark to restore.
1020 \begin_layout Description
1021 Origin Dekel, 27 January 2001
1024 \begin_layout Subsection*
1028 \begin_layout Description
1029 Action Save a bookmark.
1032 \begin_layout Description
1033 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.
1036 \begin_layout Description
1037 Syntax bookmark-save <NUMBER>
1040 \begin_layout Description
1041 Params <NUMBER>: the number of the bookmark to save.
1044 \begin_layout Description
1045 Origin Dekel, 27 January 2001
1048 \begin_layout Subsection*
1052 \begin_layout Description
1053 Action Inserts Box inset.
1056 \begin_layout Description
1057 Syntax box-insert [<TYPE>]
1060 \begin_layout Description
1061 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1062 \begin_inset Newline newline
1065 Framed is the default one.
1068 \begin_layout Description
1069 Origin vermeer, 7 Oct 2003
1072 \begin_layout Subsection*
1076 \begin_layout Description
1077 Action Inserts branch inset.
1080 \begin_layout Description
1081 Syntax branch-insert <BRANCH-NAME>
1084 \begin_layout Description
1085 Origin vermeer, 17 Aug 2003
1088 \begin_layout Subsection*
1092 \begin_layout Description
1093 Action For debug purposes only. Convert all [a-zA-Z0-1] characters to single character. Useful when submitting docs to list or bugzilla.
1096 \begin_layout Description
1097 Syntax buffer-anonymize
1100 \begin_layout Description
1101 Origin sanda, Feb 1 2018
1104 \begin_layout Subsection*
1108 \begin_layout Description
1109 Action Move the cursor to the beginning of the document.
1112 \begin_layout Description
1116 \begin_layout Subsection*
1120 \begin_layout Description
1121 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1124 \begin_layout Description
1125 Syntax buffer-begin-select
1128 \begin_layout Subsection*
1132 \begin_layout Description
1133 Action Move the cursor to the end of the document.
1136 \begin_layout Description
1140 \begin_layout Subsection*
1144 \begin_layout Description
1145 Action Move the cursor to the end of the document adding the traversed text to the selection.
1148 \begin_layout Description
1149 Syntax buffer-end-select
1152 \begin_layout Subsection*
1156 \begin_layout Description
1157 Action Inserts a caption inset.
1160 \begin_layout Description
1161 Syntax caption-insert
1164 \begin_layout Description
1165 Origin Lgb, 18 Jul 2000
1168 \begin_layout Subsection*
1172 \begin_layout Description
1173 Action Moves the cursor to the previous cell inside the table.
1176 \begin_layout Description
1177 Syntax cell-backward
1180 \begin_layout Description
1181 Origin Jug, 22 May 2000
1184 \begin_layout Subsection*
1188 \begin_layout Description
1189 Action Moves the cursor to the next cell inside the table.
1192 \begin_layout Description
1196 \begin_layout Subsection*
1200 \begin_layout Description
1201 Action Splits cell and shifts right part to the next cell (inside the math grid).
1204 \begin_layout Description
1208 \begin_layout Description
1209 Origin Ale, 15 May 1997
1212 \begin_layout Subsection*
1216 \begin_layout Description
1217 Action Accepts tracked change inside the selection.
1220 \begin_layout Description
1221 Syntax change-accept
1224 \begin_layout Description
1225 Origin Levon, 16 Oct 2002
1228 \begin_layout Subsection*
1232 \begin_layout Description
1233 Action Moves the cursor to the position of the next change of the change tracking records.
1236 \begin_layout Description
1240 \begin_layout Description
1241 Origin schmitt, 4 Oct 2006
1244 \begin_layout Subsection*
1248 \begin_layout Description
1249 Action Moves the cursor to the position of the previous change of the change tracking records.
1252 \begin_layout Description
1253 Syntax change-previous
1256 \begin_layout Description
1257 Origin vfr, 4 Apr 2009
1260 \begin_layout Subsection*
1264 \begin_layout Description
1265 Action Rejects tracked change inside the selection.
1268 \begin_layout Description
1269 Syntax change-reject
1272 \begin_layout Description
1273 Origin Levon, 16 Oct 2002
1276 \begin_layout Subsection*
1280 \begin_layout Description
1281 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1284 \begin_layout Description
1285 Syntax changes-merge
1288 \begin_layout Description
1289 Origin Levon, 16 Oct 2002
1292 \begin_layout Subsection*
1296 \begin_layout Description
1297 Action Toggles showing of change tracking in typeset output.
1300 \begin_layout Description
1301 Syntax changes-output
1304 \begin_layout Description
1305 Origin jspitzm, 21 Jan 2005
1308 \begin_layout Subsection*
1312 \begin_layout Description
1313 Action Toggles change tracking to on/off.
1316 \begin_layout Description
1317 Syntax changes-track
1320 \begin_layout Description
1321 Origin levon, 1 Oct 2002
1324 \begin_layout Subsection*
1328 \begin_layout Description
1329 Action Moves the cursor one position logically backwards.
1332 \begin_layout Description
1333 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.
1336 \begin_layout Description
1337 Syntax char-backward
1340 \begin_layout Subsection*
1341 char-backward-select
1344 \begin_layout Description
1345 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1348 \begin_layout Description
1349 Notion See also LFUN_CHAR_BACKWARD.
1352 \begin_layout Description
1353 Syntax char-backward-select
1356 \begin_layout Subsection*
1357 char-delete-backward
1360 \begin_layout Description
1361 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1364 \begin_layout Description
1365 Syntax char-delete-backward [force]
1368 \begin_layout Description
1369 Params force: Delete big insets, do not only select them.
1372 \begin_layout Subsection*
1376 \begin_layout Description
1377 Action Deletes one character in the backward direction (usually the "Delete" key).
1380 \begin_layout Description
1381 Syntax char-delete-forward [force]
1384 \begin_layout Description
1385 Params force: Delete big insets, do not only select them.
1388 \begin_layout Subsection*
1392 \begin_layout Description
1393 Action Moves the cursor one position logically forward.
1396 \begin_layout Description
1397 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.
1400 \begin_layout Description
1404 \begin_layout Subsection*
1408 \begin_layout Description
1409 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1412 \begin_layout Description
1413 Notion See also LFUN_CHAR_FORWARD.
1416 \begin_layout Description
1417 Syntax char-forward-select
1420 \begin_layout Subsection*
1424 \begin_layout Description
1425 Action Moves the cursor one position "to the left".
1428 \begin_layout Description
1429 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.
1432 \begin_layout Description
1436 \begin_layout Subsection*
1440 \begin_layout Description
1441 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1444 \begin_layout Description
1445 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1448 \begin_layout Description
1449 Syntax char-left-select
1452 \begin_layout Subsection*
1456 \begin_layout Description
1457 Action Moves the cursor one position "to the right".
1460 \begin_layout Description
1461 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.
1464 \begin_layout Description
1468 \begin_layout Subsection*
1472 \begin_layout Description
1473 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1476 \begin_layout Description
1477 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1480 \begin_layout Description
1481 Syntax char-right-select
1484 \begin_layout Subsection*
1488 \begin_layout Description
1489 Action Transposes the character at the cursor with the one before it.
1492 \begin_layout Description
1493 Syntax chars-transpose
1496 \begin_layout Description
1497 Origin Lgb, 25 Apr 2001
1500 \begin_layout Subsection*
1504 \begin_layout Description
1505 Action Inserts citation from loaded citation database.
1508 \begin_layout Description
1509 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1512 \begin_layout Description
1513 Params <KEY>: Citation (shortcut listed in available citations).
1514 \begin_inset Newline newline
1517 <TEXT_BEFORE>: text which should appear before citation.
1520 \begin_layout Description
1521 Origin AAS, 97-02-23
1524 \begin_layout Subsection*
1528 \begin_layout Description
1529 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.
1532 \begin_layout Description
1533 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.
1536 \begin_layout Description
1537 Syntax clipboard-paste [<ARG>]
1540 \begin_layout Description
1541 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1544 \begin_layout Description
1545 Origin Georg, 10 Jul 2006
1548 \begin_layout Subsection*
1549 clipboard-paste-simple
1552 \begin_layout Description
1553 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.
1556 \begin_layout Description
1557 Syntax clipboard-paste-simple [<ARG>]
1560 \begin_layout Description
1561 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1564 \begin_layout Subsection*
1568 \begin_layout Description
1569 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1572 \begin_layout Description
1573 Notion Usually bound to M-x shortcut.
1576 \begin_layout Description
1577 Syntax command-execute
1580 \begin_layout Subsection*
1584 \begin_layout Description
1585 Action Try to complete the word or command at the cursor position.
1588 \begin_layout Description
1592 \begin_layout Description
1593 Origin sts, Feb 19 2008
1596 \begin_layout Subsection*
1600 \begin_layout Description
1601 Action Accept suggested completion.
1604 \begin_layout Description
1605 Syntax completion-accept
1608 \begin_layout Description
1609 Origin sanda, Sep 08 2008
1612 \begin_layout Subsection*
1616 \begin_layout Description
1617 Action Try to cancel completion, either the popup or the inline completion.
1620 \begin_layout Description
1621 Syntax completion-cancel
1624 \begin_layout Description
1625 Origin sts, Sep 07 2008
1628 \begin_layout Subsection*
1632 \begin_layout Description
1633 Action Show the inline completion at the cursor position.
1636 \begin_layout Description
1637 Syntax completion-inline
1640 \begin_layout Description
1641 Origin sts, Feb 19 2008
1644 \begin_layout Subsection*
1648 \begin_layout Description
1649 Action Show the completion popup at the cursor position.
1652 \begin_layout Description
1653 Syntax completion-popup
1656 \begin_layout Description
1657 Origin sts, Feb 19 2008
1660 \begin_layout Subsection*
1664 \begin_layout Description
1665 Action Copies the current selection to the clipboard.
1668 \begin_layout Description
1672 \begin_layout Subsection*
1676 \begin_layout Description
1677 Action Cuts to the clipboard.
1680 \begin_layout Description
1684 \begin_layout Subsection*
1688 \begin_layout Description
1689 Action Inserts the current date.
1692 \begin_layout Description
1693 Syntax date-insert [<ARG>]
1696 \begin_layout Description
1697 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.
1700 \begin_layout Description
1701 Origin jdblair, 31 Jan 2000
1704 \begin_layout Subsection*
1708 \begin_layout Description
1709 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1712 \begin_layout Description
1713 Syntax depth-decrement
1716 \begin_layout Subsection*
1720 \begin_layout Description
1721 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1724 \begin_layout Description
1725 Syntax depth-increment
1728 \begin_layout Subsection*
1729 dialog-disconnect-inset
1732 \begin_layout Description
1733 Action Closes opened connection to opened inset.
1736 \begin_layout Description
1737 Notion Connection is used for apply functions.
1740 \begin_layout Description
1741 Syntax dialog-disconnect-inset <INSET-NAME>
1744 \begin_layout Description
1745 Origin leeming, 25 Feb 2003
1748 \begin_layout Subsection*
1752 \begin_layout Description
1753 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1756 \begin_layout Description
1757 Syntax dialog-hide <NAME>
1760 \begin_layout Description
1761 Params See LFUN_DIALOG_SHOW .
1764 \begin_layout Description
1765 Origin leeming, 25 Feb 2003
1768 \begin_layout Subsection*
1772 \begin_layout Description
1773 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1776 \begin_layout Description
1777 Syntax dialog-show <NAME> [<DATA>]
1780 \begin_layout Description
1781 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1782 \begin_inset Newline newline
1785 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1786 \begin_inset Newline newline
1789 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1790 \begin_inset Newline newline
1793 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1794 \begin_inset Newline newline
1797 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1798 \begin_inset Newline newline
1801 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1802 \begin_inset Newline newline
1805 <SPECIAL>: latexlog|vclog
1806 \begin_inset Newline newline
1809 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1812 \begin_layout Description
1813 Origin leeming, 17 Jun 2003
1816 \begin_layout Subsection*
1817 dialog-show-new-inset
1820 \begin_layout Description
1821 Action Shows hidden dialog or create new one for a given inset settings etc.
1824 \begin_layout Description
1825 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1828 \begin_layout Description
1829 Syntax dialog-show-new-inset <NAME> [<DATA>]
1832 \begin_layout Description
1833 Params See LFUN_DIALOG_SHOW .
1836 \begin_layout Description
1837 Origin leeming, 25 Feb 2003
1840 \begin_layout Subsection*
1844 \begin_layout Description
1845 Action Toggles dialog between showed/hidden state.
1848 \begin_layout Description
1849 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1852 \begin_layout Description
1853 Syntax dialog-toggle <NAME> [<DATA>]
1856 \begin_layout Description
1857 Params See LFUN_DIALOG_SHOW .
1860 \begin_layout Description
1861 Origin JSpitzm, 30 Apr 2007
1864 \begin_layout Subsection*
1868 \begin_layout Description
1869 Action Updates the dialog values from the inset/paragraph/document.
1872 \begin_layout Description
1873 Syntax dialog-update <NAME>
1876 \begin_layout Description
1877 Params <NAME>: paragraph|prefs|<INSET>
1878 \begin_inset Newline newline
1884 \begin_layout Description
1885 Origin leeming, 25 Feb 2003
1888 \begin_layout Subsection*
1892 \begin_layout Description
1893 Action Moves the cursor one line in downward direction.
1896 \begin_layout Description
1900 \begin_layout Subsection*
1904 \begin_layout Description
1905 Action Moves the cursor one line in downward direction adding the current position to the selection.
1908 \begin_layout Description
1912 \begin_layout Subsection*
1916 \begin_layout Description
1917 Action Inserts an ERT inset.
1920 \begin_layout Description
1924 \begin_layout Description
1925 Origin Jug, 18 Feb 2000
1928 \begin_layout Subsection*
1932 \begin_layout Description
1933 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1936 \begin_layout Description
1940 \begin_layout Description
1941 Origin Lgb, 17 May 2001
1944 \begin_layout Subsection*
1948 \begin_layout Description
1949 Action Inserts another LyX file.
1952 \begin_layout Description
1953 Syntax file-insert [<FILE>]
1956 \begin_layout Description
1957 Params <FILE>: Filename to be inserted.
1960 \begin_layout Subsection*
1961 file-insert-plaintext
1964 \begin_layout Description
1965 Action Inserts plain text file.
1968 \begin_layout Description
1969 Syntax file-insert-plaintext [<FILE>]
1972 \begin_layout Description
1973 Params <FILE>: Filename to be inserted.
1976 \begin_layout Description
1977 Origin CFO-G, 19 Nov 1997
1980 \begin_layout Subsection*
1981 file-insert-plaintext-para
1984 \begin_layout Description
1985 Action Inserts plain text file as paragraph (i.e. join lines).
1988 \begin_layout Description
1989 Syntax file-insert-plaintext-para [<FILE>]
1992 \begin_layout Description
1993 Params <FILE>: Filename to be inserted.
1996 \begin_layout Description
1997 Origin Levon, 14 Feb 2001
2000 \begin_layout Subsection*
2004 \begin_layout Description
2005 Action Inserts CharStyle, Custom inset or XML short element.
2008 \begin_layout Description
2009 Notion Look into the Customization manual for more information about these elements.
2010 \begin_inset Newline newline
2013 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.
2014 \begin_inset Newline newline
2017 For dissolving the element see LFUN_INSET_DISSOLVE.
2020 \begin_layout Description
2021 Syntax flex-insert Name
2024 \begin_layout Description
2025 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.
2028 \begin_layout Description
2029 Sample flex-insert Code
2032 \begin_layout Subsection*
2036 \begin_layout Description
2037 Action Inserts a float inset.
2040 \begin_layout Description
2041 Syntax float-insert <TYPE>
2044 \begin_layout Description
2045 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2048 \begin_layout Description
2049 Origin Lgb, 27 Jun 2000
2052 \begin_layout Subsection*
2056 \begin_layout Description
2057 Action Inserts the list of floats in the document.
2060 \begin_layout Description
2061 Syntax float-list-insert <TYPE>
2064 \begin_layout Description
2065 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2068 \begin_layout Description
2069 Origin Lgb, 3 May 2001
2072 \begin_layout Subsection*
2076 \begin_layout Description
2077 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2080 \begin_layout Description
2081 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2084 \begin_layout Description
2085 Syntax float-wide-insert <TYPE>
2088 \begin_layout Description
2089 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2092 \begin_layout Description
2093 Origin Lgb, 31 Oct 2001
2096 \begin_layout Subsection*
2100 \begin_layout Description
2101 Action Inserts a footnote inset.
2104 \begin_layout Description
2105 Syntax footnote-insert
2108 \begin_layout Description
2109 Origin Jug, 7 Mar 2000
2112 \begin_layout Subsection*
2116 \begin_layout Description
2117 Action Reloads the image if necessary.
2120 \begin_layout Description
2121 Syntax graphics-reload
2124 \begin_layout Description
2125 Origin vfr, 10 Aug 2009
2128 \begin_layout Subsection*
2132 \begin_layout Description
2133 Action Set the same group for all graphics insets in the marked block.
2136 \begin_layout Description
2137 Syntax graphics-unify [<GROUP>]
2140 \begin_layout Description
2141 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the group Id from the first graphics inset will be used.
2144 \begin_layout Description
2145 Origin sanda, 7 Feb 2018
2148 \begin_layout Subsection*
2152 \begin_layout Description
2153 Action Inserts hyperlinks into the document (clickable in pdf output).
2156 \begin_layout Description
2157 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2160 \begin_layout Description
2161 Syntax href-insert [<TARGET>]
2164 \begin_layout Description
2165 Origin CFO-G, 21 Nov 1997
2168 \begin_layout Subsection*
2172 \begin_layout Description
2173 Action Only active in IPA inset.
2176 \begin_layout Description
2177 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.
2180 \begin_layout Description
2184 \begin_layout Description
2185 Origin spitz, 20 May 2012
2188 \begin_layout Subsection*
2192 \begin_layout Description
2193 Action Inserts Index entry.
2196 \begin_layout Description
2197 Notion It automatically takes the word on the cursor position.
2200 \begin_layout Description
2201 Syntax index-insert [<TYPE:Name>]
2204 \begin_layout Description
2205 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2208 \begin_layout Description
2209 Origin leeming, 3 Aug 2000
2212 \begin_layout Subsection*
2216 \begin_layout Description
2217 Action Inserts list of Index entries on a new page.
2220 \begin_layout Description
2221 Syntax index-print [<TYPE:Name>]
2224 \begin_layout Description
2225 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2228 \begin_layout Description
2229 Origin Lgb, 27 Feb 1997
2232 \begin_layout Subsection*
2236 \begin_layout Description
2237 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2240 \begin_layout Description
2241 Notion Apart from lfun arguments you can use the following method:
2242 \begin_inset Newline newline
2245 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2246 \begin_inset Newline newline
2249 2. select the text and run info-insert lfun.
2252 \begin_layout Description
2253 Syntax info-insert <TYPE> <ARG>
2256 \begin_layout Description
2257 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|buffer
2258 \begin_inset Newline newline
2261 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2262 \begin_inset Newline newline
2265 shortcut[s]: name of lfun (e.g math-insert
2268 \begin_inset Newline newline
2271 lyxrc: name of rc_entry (e.g. bind_file)
2272 \begin_inset Newline newline
2275 lyxinfo: "version" - used version of LyX
2276 \begin_inset Newline newline
2279 package: name of latex package (e.g. listings)
2280 \begin_inset Newline newline
2283 textclass: name of textclass (e.g. article)
2284 \begin_inset Newline newline
2287 menu: name of lfun used in menu
2288 \begin_inset Newline newline
2291 icon: icon of lfun used in toolbar or direct icon name
2292 \begin_inset Newline newline
2295 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
2298 \begin_layout Description
2299 Sample command-sequence info-insert buffer path; info-insert buffer name
2302 \begin_layout Description
2303 Origin bpeng, 7 Oct 2007
2306 \begin_layout Subsection*
2310 \begin_layout Description
2311 Action Apply data for an inset.
2314 \begin_layout Description
2315 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.
2318 \begin_layout Description
2319 Syntax inset-apply <ARGS>
2322 \begin_layout Description
2323 Params See LFUN_INSET_INSERT .
2326 \begin_layout Subsection*
2330 \begin_layout Description
2331 Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
2334 \begin_layout Description
2338 \begin_layout Description
2339 Origin lasgouttes, 16 Mar 2009
2342 \begin_layout Subsection*
2346 \begin_layout Description
2347 Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
2350 \begin_layout Description
2351 Syntax inset-begin-select
2354 \begin_layout Description
2355 Origin lasgouttes, 16 Mar 2009
2358 \begin_layout Subsection*
2362 \begin_layout Description
2363 Action Copies the inset to the clipboard as a certain type.
2366 \begin_layout Description
2367 Notion Currently used only for InsetInfo where its content is copied as a text.
2370 \begin_layout Description
2371 Syntax inset-copy-as
2374 \begin_layout Description
2375 Origin vfr, 18 Apr 2010
2378 \begin_layout Subsection*
2382 \begin_layout Description
2383 Action Dissolve the current inset into text.
2386 \begin_layout Description
2387 Syntax inset-dissolve [<INSET>]
2390 \begin_layout Description
2391 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.
2392 \begin_inset Newline newline
2395 For values see lyx::InsetLayout::lyxtype_ .
2398 \begin_layout Description
2399 Origin JSpitz, 7 Aug 2006
2402 \begin_layout Subsection*
2406 \begin_layout Description
2407 Action Edit the inset at cursor with an external application, if one is attributed.
2410 \begin_layout Description
2411 Syntax inset-edit [<INSET_PARAMS>]
2414 \begin_layout Description
2415 Params <INSET_PARAMS>: Parameters for the inset.
2416 \begin_inset Newline newline
2419 Currently only the filename will be considered.
2422 \begin_layout Description
2423 Origin JSpitzm, 27 Apr 2006
2426 \begin_layout Subsection*
2430 \begin_layout Description
2431 Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
2434 \begin_layout Description
2438 \begin_layout Description
2439 Origin lasgouttes, 16 Mar 2009
2442 \begin_layout Subsection*
2446 \begin_layout Description
2447 Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
2450 \begin_layout Description
2451 Syntax inset-end-select
2454 \begin_layout Description
2455 Origin lasgouttes, 16 Mar 2009
2458 \begin_layout Subsection*
2462 \begin_layout Description
2463 Action Apply the given commands on insets of a given name.
2466 \begin_layout Description
2467 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.
2470 \begin_layout Description
2471 Syntax inset-forall <NAME> <LFUN-COMMAND>
2472 \begin_inset Newline newline
2475 <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.
2478 \begin_layout Description
2479 Sample Remove all index insets:
2480 \begin_inset Newline newline
2483 inset-forall Index char-delete-forward force
2484 \begin_inset Newline newline
2487 Close all Notes (also works for a particular branch, for example):
2488 \begin_inset Newline newline
2491 inset-forall Note inset-toggle close
2492 \begin_inset Newline newline
2495 Transform all yellow notes to comments
2496 \begin_inset Newline newline
2499 inset-forall Note:Note inset-modify note Note Comment
2500 \begin_inset Newline newline
2503 Try to put LyX in an infinite loop if there is at least a Note:
2504 \begin_inset Newline newline
2507 inset-forall Note char-backward
2510 \begin_layout Description
2511 Origin lasgouttes, 27 Nov 2009
2514 \begin_layout Subsection*
2518 \begin_layout Description
2519 Action Insert new inset (type given by the parameters).
2522 \begin_layout Description
2523 Syntax inset-insert <INSET> <ARGS>
2526 \begin_layout Description
2527 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2528 \begin_inset Newline newline
2531 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2532 \begin_inset Newline newline
2535 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2538 \begin_layout Description
2539 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2542 \begin_inset Newline newline
2545 where <label name> is the name of the referenced label and <Format> is one of the following:
2546 \begin_inset Newline newline
2550 \begin_inset Newline newline
2553 eqref -- (<reference>)
2554 \begin_inset Newline newline
2558 \begin_inset Newline newline
2561 vpageref -- on <page>
2562 \begin_inset Newline newline
2565 vref -- <reference> on <page>
2566 \begin_inset Newline newline
2569 formatted -- Formatted reference
2572 \begin_layout Subsection*
2576 \begin_layout Description
2577 Action Modify some properties of an inset.
2580 \begin_layout Description
2581 Notion Used for argument, bibitem, bibtex, box, branch, caption, citation, command, ert, external, float, graphics, include, index, info, label, line, listings, newline, newpage, nomencl, note, phantom, quotes, ref, script, separator, space, tabular, vspace and wrap insets.
2584 \begin_layout Description
2585 Syntax inset-modify <INSET> <ARGS>
2586 \begin_inset Newline newline
2589 inset-modify changetype <TYPE>
2592 \begin_layout Description
2593 Sample Change a Note inset into a Comment inset:
2594 \begin_inset Newline newline
2597 inset-modify note Note Comment
2598 \begin_inset Newline newline
2601 Change a Box into an Ovalbox:
2602 \begin_inset Newline newline
2605 inset-modify changetype Ovalbox
2606 \begin_inset Newline newline
2609 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
2610 \begin_inset Newline newline
2613 inset-modify changetype els
2614 \begin_inset Newline newline
2617 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
2618 \begin_inset Newline newline
2621 inset-modify changetype e..
2622 \begin_inset Newline newline
2628 \begin_layout Subsection*
2632 \begin_layout Description
2633 Action Select all contents of an inset.
2636 \begin_layout Description
2637 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2640 \begin_layout Description
2641 Syntax inset-select-all
2644 \begin_layout Description
2645 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2648 \begin_layout Subsection*
2652 \begin_layout Description
2653 Action Open the inset's properties dialog.
2656 \begin_layout Description
2657 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.
2660 \begin_layout Description
2661 Syntax inset-settings <INSET>
2664 \begin_layout Description
2665 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2666 \begin_inset Newline newline
2669 graphics|href|include|index|index_print|label|line|
2670 \begin_inset Newline newline
2673 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2676 \begin_layout Subsection*
2680 \begin_layout Description
2681 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2684 \begin_layout Description
2685 Syntax inset-toggle [<ARG>]
2688 \begin_layout Description
2689 Params <ARG>: <open|close|toggle|assign>.
2690 \begin_inset Newline newline
2693 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2694 \begin_inset Newline newline
2697 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2700 \begin_layout Description
2701 Origin lasgouttes, 19 Jul 2001
2704 \begin_layout Subsection*
2708 \begin_layout Description
2709 Action Inserts an IPA inset.
2712 \begin_layout Description
2716 \begin_layout Description
2717 Origin spitz, 05 Mar 2012
2720 \begin_layout Subsection*
2724 \begin_layout Description
2725 Action Inserts special IPA macros into the document.
2728 \begin_layout Description
2729 Syntax ipamacro-insert <CHAR>
2732 \begin_layout Description
2733 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2736 \begin_layout Description
2737 Origin JSpitzm, 22 Aug 2012
2740 \begin_layout Subsection*
2744 \begin_layout Description
2745 Action Turn off the loaded keyboard map.
2748 \begin_layout Description
2752 \begin_layout Subsection*
2756 \begin_layout Description
2757 Action Turn on the primary keyboard map.
2760 \begin_layout Description
2761 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.
2762 \begin_inset Newline newline
2765 The language is to be set in the Preferences dialog.
2768 \begin_layout Description
2769 Syntax keymap-primary
2772 \begin_layout Subsection*
2776 \begin_layout Description
2777 Action Turn on the secondary keyboard map.
2780 \begin_layout Description
2781 Syntax keymap-secondary
2784 \begin_layout Subsection*
2788 \begin_layout Description
2789 Action Toggles keyboard maps (first/second/off).
2792 \begin_layout Description
2793 Syntax keymap-toggle
2796 \begin_layout Description
2797 Origin leeming, 30 Mar 2004
2800 \begin_layout Subsection*
2801 label-copy-as-reference
2804 \begin_layout Description
2805 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2808 \begin_layout Description
2809 Syntax copy-label-as-reference <LABEL>
2812 \begin_layout Description
2813 Params <LABEL>: The label to copy (for multi-line math)
2816 \begin_layout Description
2817 Origin sts, 16 Nov 2008
2820 \begin_layout Subsection*
2824 \begin_layout Description
2825 Action Goto a label.
2828 \begin_layout Description
2829 Syntax label-goto [<LABEL>]
2832 \begin_layout Description
2833 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.
2836 \begin_layout Description
2837 Origin Ale, 6 Aug 1997
2840 \begin_layout Subsection*
2844 \begin_layout Description
2845 Action Inserts label to text or displayed formula.
2848 \begin_layout Description
2849 Syntax label-insert [<LABEL>]
2852 \begin_layout Description
2853 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2856 \begin_layout Subsection*
2857 label-insert-as-reference
2860 \begin_layout Description
2861 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2864 \begin_layout Description
2865 Syntax label-insert-as-reference
2868 \begin_layout Description
2869 Origin vfr, 7 Apr 2009
2872 \begin_layout Subsection*
2876 \begin_layout Description
2877 Action Set language from the current cursor position.
2880 \begin_layout Description
2881 Syntax language <LANG> [set]
2884 \begin_layout Description
2885 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).
2888 \begin_layout Description
2889 Origin Dekel, 2 Mar 2000
2892 \begin_layout Subsection*
2896 \begin_layout Description
2897 Action Move the cursor to the beginning of the (screen) line.
2900 \begin_layout Description
2904 \begin_layout Subsection*
2908 \begin_layout Description
2909 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2912 \begin_layout Description
2913 Syntax line-begin-select
2916 \begin_layout Subsection*
2920 \begin_layout Description
2921 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2924 \begin_layout Description
2925 Syntax line-delete-forward
2928 \begin_layout Subsection*
2932 \begin_layout Description
2933 Action Move the cursor to the end of the (screen) line.
2936 \begin_layout Description
2940 \begin_layout Subsection*
2944 \begin_layout Description
2945 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2948 \begin_layout Description
2949 Syntax line-end-select
2952 \begin_layout Subsection*
2956 \begin_layout Description
2957 Action Inserts a new listings inset.
2960 \begin_layout Description
2961 Syntax listing-insert
2964 \begin_layout Description
2965 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2968 \begin_layout Subsection*
2972 \begin_layout Description
2973 Action Inserts a marginal note.
2976 \begin_layout Description
2977 Syntax marginalnote-insert
2980 \begin_layout Description
2981 Origin Lgb, 26 Jun 2000
2984 \begin_layout Subsection*
2988 \begin_layout Description
2989 Action Disable selecting of text-region.
2992 \begin_layout Description
2996 \begin_layout Subsection*
3000 \begin_layout Description
3001 Action Enable selecting of text-region.
3004 \begin_layout Description
3005 Notion After enabling you can simply move arrow keys to get selected region.
3008 \begin_layout Description
3012 \begin_layout Subsection*
3016 \begin_layout Description
3017 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3020 \begin_layout Description
3024 \begin_layout Description
3025 Origin Andre, May 5 2006
3028 \begin_layout Subsection*
3032 \begin_layout Description
3033 Action Inserts a line break or new line.
3036 \begin_layout Description
3037 Syntax newline-insert [<ARG>]
3040 \begin_layout Description
3041 Params <ARG>: <newline|linebreak> default: newline
3044 \begin_layout Description
3045 Origin JSpitzm, 25 Mar 2008
3048 \begin_layout Subsection*
3052 \begin_layout Description
3053 Action Inserts a new page.
3056 \begin_layout Description
3057 Syntax newpage-insert <ARG>
3060 \begin_layout Description
3061 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3064 \begin_layout Description
3065 Origin uwestoehr, 24 Nov 2007
3068 \begin_layout Subsection*
3072 \begin_layout Description
3073 Action Inserts Nomenclature entry.
3076 \begin_layout Description
3077 Notion It automatically takes the word on the cursor position if no symbol is given.
3080 \begin_layout Description
3081 Syntax nomencl-insert [<SYMBOL>]
3084 \begin_layout Description
3085 Origin Ugras, 4 Nov 2006
3088 \begin_layout Subsection*
3092 \begin_layout Description
3093 Action Inserts list of Nomenclature entries.
3096 \begin_layout Description
3097 Syntax nomenclature-print
3100 \begin_layout Description
3101 Origin Ugras, 4 Nov 2006
3104 \begin_layout Subsection*
3108 \begin_layout Description
3109 Action Inserts Note on the current cursor position, move selection inside the inset.
3112 \begin_layout Description
3113 Syntax note-insert [<TYPE>]
3116 \begin_layout Description
3117 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3120 \begin_layout Subsection*
3124 \begin_layout Description
3125 Action Moves the cursor to the beginning of next Note inset.
3128 \begin_layout Description
3132 \begin_layout Subsection*
3136 \begin_layout Description
3137 Action Move the current group in the downward direction in the structure of the document.
3140 \begin_layout Description
3141 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3144 \begin_layout Description
3148 \begin_layout Description
3149 Origin Vermeer, 23 Mar 2006
3152 \begin_layout Subsection*
3156 \begin_layout Description
3157 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3160 \begin_layout Description
3161 Notion Part -> Chapter -> Section -> etc.
3164 \begin_layout Description
3168 \begin_layout Description
3169 Origin Vermeer, 23 Mar 2006
3172 \begin_layout Subsection*
3176 \begin_layout Description
3177 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3180 \begin_layout Description
3181 Notion Part <- Chapter <- Section <- etc.
3184 \begin_layout Description
3188 \begin_layout Description
3189 Origin Vermeer, 23 Mar 2006
3192 \begin_layout Subsection*
3196 \begin_layout Description
3197 Action Move the current group in the upward direction in the structure of the document.
3200 \begin_layout Description
3201 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3204 \begin_layout Description
3208 \begin_layout Description
3209 Origin Vermeer, 23 Mar 2006
3212 \begin_layout Subsection*
3216 \begin_layout Description
3217 Action Breaks the current paragraph at the current location.
3220 \begin_layout Description
3221 Notion Removes the selection.
3224 \begin_layout Description
3225 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3228 \begin_layout Description
3229 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3230 \begin_inset Newline newline
3233 ignoresep: Do not account for paragraph separators while breaking.
3236 \begin_layout Subsection*
3240 \begin_layout Description
3241 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3244 \begin_layout Description
3245 Syntax paragraph-down
3248 \begin_layout Description
3249 Origin Asger, 1 Oct 1996
3252 \begin_layout Subsection*
3253 paragraph-down-select
3256 \begin_layout Description
3257 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3260 \begin_layout Description
3261 Syntax paragraph-down-select
3264 \begin_layout Description
3265 Origin Asger, 1 Oct 1996
3268 \begin_layout Subsection*
3272 \begin_layout Description
3273 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph. If given four arguments id_start, pos_start, id_end, pos_end, perform a selection from start to end.
3276 \begin_layout Description
3277 Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen. Moreover the id is unique for all opened buffers (documents). Both ids must belong to the same buffer.
3280 \begin_layout Description
3281 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3284 \begin_layout Description
3285 Params <PAR_ID>: paragraph id
3286 \begin_inset Newline newline
3289 <POS_IN_PAR>: desired position within the paragraph
3292 \begin_layout Description
3293 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3296 \begin_layout Subsection*
3300 \begin_layout Description
3301 Action Moves the current paragraph downwards in the document.
3304 \begin_layout Description
3305 Syntax paragraph-move-down
3308 \begin_layout Description
3309 Origin Edwin, 8 Apr 2006
3312 \begin_layout Subsection*
3316 \begin_layout Description
3317 Action Moves the current paragraph upwards in the document.
3320 \begin_layout Description
3321 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3324 \begin_layout Description
3325 Syntax paragraph-move-up
3328 \begin_layout Description
3329 Origin Edwin, 8 Apr 2006
3332 \begin_layout Subsection*
3336 \begin_layout Description
3337 Action Change paragraph settings.
3340 \begin_layout Description
3341 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.
3344 \begin_layout Description
3345 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3348 \begin_layout Description
3358 \begin_inset Newline newline
3363 paragraph_spacing default|single|onehalf|double|other SIZE
3364 \begin_inset Newline newline
3369 align block|left|right|center|default
3370 \begin_inset Newline newline
3375 labelwidthstring WIDTH|
3380 \begin_layout Description
3381 Origin rgh, Aug 15 2007
3384 \begin_layout Subsection*
3385 paragraph-params-apply
3388 \begin_layout Description
3389 Action Change paragraph settings.
3392 \begin_layout Description
3393 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3396 \begin_layout Description
3397 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3400 \begin_layout Description
3401 Params For parameters see LFUN_PARAGRAPH_PARAMS
3404 \begin_layout Description
3405 Origin leeming, 30 Mar 2004
3408 \begin_layout Subsection*
3412 \begin_layout Description
3413 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3416 \begin_layout Description
3420 \begin_layout Description
3421 Origin Asger, 1 Oct 1996
3424 \begin_layout Subsection*
3428 \begin_layout Description
3429 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3432 \begin_layout Description
3433 Syntax paragraph-up-select
3436 \begin_layout Description
3437 Origin Asger, 1 Oct 1996
3440 \begin_layout Subsection*
3444 \begin_layout Description
3445 Action Pastes material (text or picture) from the active clipboard.
3448 \begin_layout Description
3449 Syntax paste [<TYPE>|<NUM>]
3452 \begin_layout Description
3453 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3454 \begin_inset Newline newline
3457 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3460 \begin_layout Subsection*
3464 \begin_layout Description
3465 Action Inserts phantom on the current cursor position, move selection inside the inset.
3468 \begin_layout Description
3469 Syntax phantom-insert [<TYPE>]
3472 \begin_layout Description
3473 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3476 \begin_layout Description
3477 Origin uwestoehr, 30 Jan 2009
3480 \begin_layout Subsection*
3484 \begin_layout Description
3485 Action Inserts a new preview inset.
3488 \begin_layout Description
3489 Syntax preview-insert
3492 \begin_layout Description
3493 Origin vfr, 28 Mar 2010
3496 \begin_layout Subsection*
3497 primary-selection-paste
3500 \begin_layout Description
3501 Action Pastes the currently selected text.
3504 \begin_layout Description
3505 Notion Primary selection mechanism is linux-only thing.
3508 \begin_layout Description
3509 Syntax primary-selection-paste [<ARG>]
3512 \begin_layout Description
3513 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3516 \begin_layout Subsection*
3520 \begin_layout Description
3521 Action Inserts quotes according to the type and quote-language preference.
3524 \begin_layout Description
3525 Notion Currently 15 different quote styles are distinguished (see params).
3528 \begin_layout Description
3529 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3532 \begin_layout Description
3533 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
3534 \begin_inset Newline newline
3537 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
3538 \begin_inset Newline newline
3541 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3542 \begin_inset Newline newline
3545 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3546 \begin_inset Newline newline
3549 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3550 \begin_inset Newline newline
3553 'danish' for >>Danish<< quote style (with >inner quotation<)
3554 \begin_inset Newline newline
3557 'english' for ``English'' quote style (with `inner quotation')
3558 \begin_inset Newline newline
3561 'french' for <<french>> quote style (with ``inner quotation'')
3562 \begin_inset Newline newline
3565 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
3566 \begin_inset Newline newline
3569 'german' for ,,German`` quote style (with ,inner quotation`)
3570 \begin_inset Newline newline
3573 'plain' for "Plain" quote style (with 'inner quotation')
3574 \begin_inset Newline newline
3577 'polish' for ,,Polish'' quote style (with ,inner quotation')
3578 \begin_inset Newline newline
3581 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3582 \begin_inset Newline newline
3585 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
3586 \begin_inset Newline newline
3589 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3590 \begin_inset Newline newline
3593 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3594 \begin_inset Newline newline
3597 'dynamic' for Dynamic quotation marks which inherit the global document style
3598 \begin_inset Newline newline
3601 If no quote style is specified, the document-wide will be used.
3604 \begin_layout Subsection*
3608 \begin_layout Description
3609 Action Redoes the last thing undone.
3612 \begin_layout Description
3616 \begin_layout Subsection*
3620 \begin_layout Description
3621 Action Go to the next label or cross-reference.
3624 \begin_layout Description
3625 Syntax reference-next
3628 \begin_layout Description
3629 Origin Dekel, 14 Jan 2001
3632 \begin_layout Subsection*
3636 \begin_layout Description
3637 Action Repeat the given command.
3640 \begin_layout Description
3641 Notion fails when the repeat count is greater than 10000.
3644 \begin_layout Description
3645 Syntax repeat <COUNT> <LFUN-COMMAND>
3648 \begin_layout Description
3649 Origin Andre, 27 Oct 2003
3652 \begin_layout Subsection*
3656 \begin_layout Description
3657 Action Moves the cursor one page in downward direction.
3660 \begin_layout Description
3664 \begin_layout Subsection*
3668 \begin_layout Description
3669 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3672 \begin_layout Description
3673 Syntax screen-down-select
3676 \begin_layout Subsection*
3680 \begin_layout Description
3681 Action Recenters the screen on the current cursor position.
3684 \begin_layout Description
3685 Syntax screen-recenter
3688 \begin_layout Subsection*
3692 \begin_layout Description
3693 Action Repositions the screen such that the cursor is visible.
3696 \begin_layout Description
3697 Syntax screen-show-cursor
3700 \begin_layout Description
3701 Origin vfr, 25 Mar 2009
3704 \begin_layout Subsection*
3708 \begin_layout Description
3709 Action Moves the cursor one page in upward direction.
3712 \begin_layout Description
3716 \begin_layout Subsection*
3720 \begin_layout Description
3721 Action Moves the cursor one page in upward direction adding the current position to the selection.
3724 \begin_layout Description
3725 Syntax screen-up-select
3728 \begin_layout Subsection*
3732 \begin_layout Description
3733 Action Inserts a subscript or superscript inset.
3736 \begin_layout Description
3737 Syntax script-insert <TYPE>
3740 \begin_layout Description
3741 Params <TYPE>: subscript|superscript
3744 \begin_layout Description
3745 Origin Georg, 23 Nov 2010
3748 \begin_layout Subsection*
3752 \begin_layout Description
3753 Action Scroll the buffer view.
3756 \begin_layout Description
3757 Notion Only scrolls the screen up or down; does not move the cursor.
3760 \begin_layout Description
3761 Syntax scroll <TYPE> <QUANTITY>
3764 \begin_layout Description
3765 Params <TYPE>: line|page
3766 \begin_inset Newline newline
3769 <QUANTITY>: up|down|<number>
3772 \begin_layout Description
3773 Origin Abdel, Dec 27 2007
3776 \begin_layout Subsection*
3780 \begin_layout Description
3781 Action Select the whole section.
3784 \begin_layout Description
3785 Notion The cursor should be in a section heading before calling this lfun.
3788 \begin_layout Description
3789 Syntax section-select
3792 \begin_layout Description
3793 Origin vfr, 05 May 2009
3796 \begin_layout Subsection*
3800 \begin_layout Description
3801 Action Pastes the internal selection text in permanent selection.
3804 \begin_layout Description
3805 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3808 \begin_layout Description
3809 Syntax selection-paste
3812 \begin_layout Description
3813 Origin lasgouttes, 14 Jan 2009
3816 \begin_layout Subsection*
3820 \begin_layout Description
3821 Action Inserts an environment separator or latex paragraph break.
3824 \begin_layout Description
3825 Syntax separator-insert [<ARG>]
3828 \begin_layout Description
3829 Params <ARG>: <plain|parbreak|latexpar> default: plain
3832 \begin_layout Description
3833 Origin ef, 2 May 2014
3836 \begin_layout Subsection*
3840 \begin_layout Description
3841 Action Set the group for the graphics inset on the cursor position.
3844 \begin_layout Description
3845 Syntax set-graphics-group [<GROUP>]
3848 \begin_layout Description
3849 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3852 \begin_layout Description
3853 Origin sanda, 6 May 2008
3856 \begin_layout Subsection*
3860 \begin_layout Description
3861 Action Inserts one of horizontal space insets.
3864 \begin_layout Description
3865 Syntax space-insert <NAME> [<LEN>]
3868 \begin_layout Description
3869 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3870 \begin_inset Newline newline
3873 Only in math mode: med and thick.
3874 \begin_inset Newline newline
3877 <LEN>: length for custom spaces (hspace, hspace* for protected)
3880 \begin_layout Description
3881 Origin JSpitzm, 20 May 2003, Mar 17 2008
3884 \begin_layout Subsection*
3888 \begin_layout Description
3889 Action Inserts various characters into the document.
3892 \begin_layout Description
3893 Syntax specialchar-insert <CHAR>
3896 \begin_layout Description
3897 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3900 \begin_layout Description
3901 Origin JSpitzm, 6 Dec 2007
3904 \begin_layout Subsection*
3908 \begin_layout Description
3909 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3912 \begin_layout Description
3913 Syntax spelling-add [<STRING>] [<LANG>]
3916 \begin_layout Description
3917 Params <WORD>: word to add <LANG>: language name (see file languages)
3920 \begin_layout Description
3921 Origin JSpitzm, 18 Jan 2010
3924 \begin_layout Subsection*
3925 spelling-continuously
3928 \begin_layout Description
3929 Action Toggle continuous spell checking.
3932 \begin_layout Description
3933 Syntax spelling-continuously
3936 \begin_layout Description
3937 Origin vfr, 24 March 2013
3940 \begin_layout Subsection*
3944 \begin_layout Description
3945 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.
3948 \begin_layout Description
3949 Syntax spelling-ignore [<WORD>] [<LANG>]
3952 \begin_layout Description
3953 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3956 \begin_layout Description
3957 Origin JSpitzm, 18 Jan 2010
3960 \begin_layout Subsection*
3964 \begin_layout Description
3965 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3968 \begin_layout Description
3969 Syntax spelling-remove [<STRING>] [<LANG>]
3972 \begin_layout Description
3973 Params <WORD>: word to remove <LANG>: language name (see file languages)
3976 \begin_layout Description
3977 Origin SWitt, 28 July 2010
3980 \begin_layout Subsection*
3984 \begin_layout Description
3985 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3988 \begin_layout Description
3989 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.
3992 \begin_layout Description
3996 \begin_layout Description
3997 Origin vfr, Sep 30 2008
4000 \begin_layout Subsection*
4004 \begin_layout Description
4005 Action Insert a tab into a listings inset.
4008 \begin_layout Description
4009 Notion It also works on a selection.
4012 \begin_layout Description
4016 \begin_layout Description
4017 Origin vfr, Sep 30 2008
4020 \begin_layout Subsection*
4024 \begin_layout Description
4025 Action Modify properties of tabulars and table-like math environments.
4028 \begin_layout Description
4029 Syntax tabular-feature <FEATURE> [<ARG>]
4032 \begin_layout Description
4033 Params Generally see LFUN_INSET_INSERT for further details.
4034 \begin_inset Newline newline
4037 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4038 \begin_inset Newline newline
4041 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4042 \begin_inset Newline newline
4045 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4046 \begin_inset Newline newline
4049 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4050 \begin_inset Newline newline
4053 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4054 \begin_inset Newline newline
4057 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4058 \begin_inset Newline newline
4061 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4062 \begin_inset Newline newline
4065 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
4066 \begin_inset Newline newline
4069 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4070 \begin_inset Newline newline
4073 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4074 \begin_inset Newline newline
4077 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4078 \begin_inset Newline newline
4081 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4082 \begin_inset Newline newline
4085 set-special-column|set-special-multicolumn|set-special-multirow|
4086 \begin_inset Newline newline
4089 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4090 \begin_inset Newline newline
4093 set-interline-space|set-border-lines|tabular-valign-top|
4094 \begin_inset Newline newline
4097 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
4098 \begin_inset Newline newline
4101 Various math-environment features are handled as well, e.g. add-vline-left/right for
4102 \begin_inset Newline newline
4105 the Grid/Array environment.
4106 \begin_inset Newline newline
4109 <ARG>: additional argument for some commands, use debug mode to explore its values.
4112 \begin_layout Description
4113 Origin gm, 10 Dec 2015
4116 \begin_layout Subsection*
4120 \begin_layout Description
4121 Action Inserts table into the document.
4124 \begin_layout Description
4125 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4128 \begin_layout Description
4129 Syntax tabular-insert [<ROWS> <COLUMNS>]
4132 \begin_layout Description
4133 Params In case no arguments are given show insert dialog.
4136 \begin_layout Description
4137 Origin Jug, 12 Apr 2000
4140 \begin_layout Subsection*
4144 \begin_layout Description
4145 Action Look up thesaurus entries with respect to the word under the cursor.
4148 \begin_layout Description
4149 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4152 \begin_layout Description
4153 Params <STRING>: word to look up <LANG>: language (see file languages)
4156 \begin_layout Description
4157 Origin Levon, 20 Jul 2001
4160 \begin_layout Subsection*
4164 \begin_layout Description
4165 Action Undoes the last edit.
4168 \begin_layout Description
4172 \begin_layout Subsection*
4176 \begin_layout Description
4177 Action Inserts a single unicode character.
4180 \begin_layout Description
4181 Syntax unicode-insert <CHAR1> <CHAR2> ...
4184 \begin_layout Description
4185 Params <CHARn>: The character to insert, given as its code point, in hexadecimal.
4188 \begin_layout Description
4189 Sample unicode-insert 0x0100 0x0259
4192 \begin_layout Description
4193 Origin Lgb, 22 Oct 2006
4196 \begin_layout Subsection*
4200 \begin_layout Description
4201 Action Moves the cursor one line in upward direction.
4204 \begin_layout Description
4208 \begin_layout Subsection*
4212 \begin_layout Description
4213 Action Moves the cursor one line in upward direction adding the current position to the selection.
4216 \begin_layout Description
4220 \begin_layout Subsection*
4224 \begin_layout Description
4225 Action Moves the cursor to the logically previous beginning of a word.
4228 \begin_layout Description
4229 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.
4232 \begin_layout Description
4233 Syntax word-backward
4236 \begin_layout Subsection*
4237 word-backward-select
4240 \begin_layout Description
4241 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4244 \begin_layout Description
4245 Notion See also LFUN_WORD_BACKWARD.
4248 \begin_layout Description
4249 Syntax word-backward-select
4252 \begin_layout Subsection*
4256 \begin_layout Description
4257 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4260 \begin_layout Description
4261 Syntax word-capitalize [<SEL_TYPE>]
4264 \begin_layout Description
4265 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.
4268 \begin_layout Subsection*
4269 word-delete-backward
4272 \begin_layout Description
4273 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4276 \begin_layout Description
4277 Syntax word-delete-backward [force]
4280 \begin_layout Description
4281 Params force: Delete big insets, do not only select them.
4284 \begin_layout Subsection*
4288 \begin_layout Description
4289 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4292 \begin_layout Description
4293 Syntax word-delete-forward [force]
4296 \begin_layout Description
4297 Params force: Delete big insets, do not only select them.
4300 \begin_layout Subsection*
4304 \begin_layout Description
4305 Action Search for next occurrence of a string.
4308 \begin_layout Description
4309 Syntax word-find [<DATA>]
4312 \begin_layout Description
4313 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).
4316 \begin_layout Description
4317 Origin Andre, Jan 7 2004
4320 \begin_layout Subsection*
4324 \begin_layout Description
4325 Action Search for a given string in backward direction.
4328 \begin_layout Description
4329 Notion Case sensitive, match words. If no argument given, last search repeated.
4332 \begin_layout Description
4333 Syntax word-find-backward [<STRING>]
4336 \begin_layout Description
4337 Origin Etienne, 20 Feb 1998
4340 \begin_layout Subsection*
4344 \begin_layout Description
4345 Action Search for a given string in forward direction.
4348 \begin_layout Description
4349 Notion Case sensitive, match words. If no argument given, last search repeated.
4352 \begin_layout Description
4353 Syntax word-find-forward [<STRING>]
4356 \begin_layout Description
4357 Origin Etienne, 16 Feb 1998
4360 \begin_layout Subsection*
4364 \begin_layout Description
4365 Action Search for next occurrence of a pattern.
4368 \begin_layout Description
4369 Syntax word-findadv [<DATA>]
4372 \begin_layout Description
4373 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).
4376 \begin_layout Description
4377 Origin Tommaso, Nov 15 2007
4380 \begin_layout Subsection*
4384 \begin_layout Description
4385 Action Moves the cursor to the logically next beginning of a word.
4388 \begin_layout Description
4389 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.
4392 \begin_layout Description
4396 \begin_layout Subsection*
4400 \begin_layout Description
4401 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4404 \begin_layout Description
4405 Notion See also LFUN_WORD_FORWARD.
4408 \begin_layout Description
4409 Syntax word-forward-select
4412 \begin_layout Subsection*
4416 \begin_layout Description
4417 Action Moves the cursor to the next beginning of a word "on the left".
4420 \begin_layout Description
4421 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.
4424 \begin_layout Description
4428 \begin_layout Description
4429 Origin dov, 28 Oct 2007
4432 \begin_layout Subsection*
4436 \begin_layout Description
4437 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4440 \begin_layout Description
4441 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4444 \begin_layout Description
4445 Syntax word-left-select
4448 \begin_layout Description
4449 Origin dov, 28 Oct 2007
4452 \begin_layout Subsection*
4456 \begin_layout Description
4457 Action Change the words in the selection or word at cursor position to lower case.
4460 \begin_layout Description
4461 Syntax word-lowcase [<SEL_TYPE>]
4464 \begin_layout Description
4465 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.
4468 \begin_layout Subsection*
4472 \begin_layout Description
4473 Action Replace a string in the document.
4476 \begin_layout Description
4477 Syntax word-replace [<DATA>]
4480 \begin_layout Description
4481 Params <DATA>: data is of the form "<replace>
4482 \begin_inset Newline newline
4486 \begin_inset Newline newline
4489 <casesensitive> <matchword> <all> <forward> <findnext>"
4492 \begin_layout Description
4493 Origin Andre, Jan 7 2004
4496 \begin_layout Subsection*
4500 \begin_layout Description
4501 Action Moves the cursor to the next beginning of a word "on the right".
4504 \begin_layout Description
4505 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.
4508 \begin_layout Description
4512 \begin_layout Description
4513 Origin dov, 28 Oct 2007
4516 \begin_layout Subsection*
4520 \begin_layout Description
4521 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4524 \begin_layout Description
4525 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4528 \begin_layout Description
4529 Syntax word-right-select
4532 \begin_layout Description
4533 Origin dov, 28 Oct 2007
4536 \begin_layout Subsection*
4540 \begin_layout Description
4541 Action Puts the word where the cursor stands into the selection.
4544 \begin_layout Description
4548 \begin_layout Description
4549 Origin Andre, 11 Sep 2002
4552 \begin_layout Subsection*
4556 \begin_layout Description
4557 Action Change the words in the selection or word at cursor position to upper case.
4560 \begin_layout Description
4561 Syntax word-upcase [<SEL_TYPE>]
4564 \begin_layout Description
4565 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.
4568 \begin_layout Subsection*
4572 \begin_layout Description
4573 Action Inserts floats wrapped by the text around.
4576 \begin_layout Description
4577 Syntax wrap-insert <TYPE>
4580 \begin_layout Description
4581 Params <TYPE>: table|figure
4584 \begin_layout Description
4585 Origin Dekel, 7 Apr 2002
4588 \begin_layout Section
4589 Math Editor Functions
4592 \begin_layout Subsection*
4593 in-mathmacrotemplate
4596 \begin_layout Description
4597 Action Only active in Math Macro definition.
4600 \begin_layout Description
4601 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.
4604 \begin_layout Description
4605 Syntax in-mathmacrotemplate
4608 \begin_layout Description
4609 Origin sts, 06 January 2008
4612 \begin_layout Subsection*
4616 \begin_layout Description
4617 Action Inserts an extended matrix as provided by the amsmath package.
4620 \begin_layout Description
4621 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4624 \begin_layout Description
4625 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'.
4628 \begin_layout Description
4629 Sample math-ams-matrix 3 3 bmatrix
4632 \begin_layout Subsection*
4636 \begin_layout Description
4637 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4640 \begin_layout Description
4641 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4644 \begin_layout Description
4645 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4646 \begin_inset Newline newline
4649 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4652 \begin_layout Description
4653 Sample math-bigdelim "Bigl" "
4660 \begin_layout Description
4661 Origin Enrico & Georg, 7 May 2006
4664 \begin_layout Subsection*
4668 \begin_layout Description
4669 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4672 \begin_layout Description
4673 Syntax math-delim [<LEFT>] [<RIGHT>]
4676 \begin_layout Description
4677 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.
4680 \begin_layout Description
4681 Sample math-delim { rangle
4684 \begin_layout Description
4685 Origin Alejandro, 18 Jun 1996
4688 \begin_layout Subsection*
4692 \begin_layout Description
4693 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4696 \begin_layout Description
4697 Syntax math-display [<ARG>]
4700 \begin_layout Description
4701 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4704 \begin_layout Description
4705 Origin Alejandro, 18 Jun 1996
4708 \begin_layout Subsection*
4712 \begin_layout Description
4713 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4716 \begin_layout Description
4717 Notion Selection can be used to determine the input for the external program.
4720 \begin_layout Description
4721 Syntax math-extern <LANG> [<COMMAND>]
4724 \begin_layout Description
4725 Params <LANG>: octave|maxima|maple|mathematica|script
4726 \begin_inset Newline newline
4729 where "script" stands for the external script (normalized expression will be passed)
4732 \begin_layout Description
4733 Sample math-extern maple simplify
4736 \begin_layout Description
4737 Origin Andre, 24 Apr 2001
4740 \begin_layout Subsection*
4744 \begin_layout Description
4745 Action Changes the text style used in math.
4748 \begin_layout Description
4749 Syntax math-font-style <STYLE>
4752 \begin_layout Description
4753 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4754 \begin_inset Newline newline
4757 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4760 \begin_layout Description
4761 Origin vfr, 9 jan 2009
4764 \begin_layout Subsection*
4768 \begin_layout Description
4769 Action Inserts math objects and symbols.
4772 \begin_layout Description
4773 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4775 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
4777 frac{x}{y}" replaces "abc" with "
4779 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.
4782 \begin_layout Description
4783 Syntax math-insert <ARG>
4786 \begin_layout Description
4787 Params <ARG>: Symbol or LaTeX code to be inserted.
4790 \begin_layout Subsection*
4794 \begin_layout Description
4795 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.
4798 \begin_layout Description
4799 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4802 \begin_layout Description
4803 Syntax math-limits [<STATE>]
4806 \begin_layout Description
4807 Params <STATE>: limits|nolimits
4810 \begin_layout Subsection*
4814 \begin_layout Description
4815 Action Inserts a math macro definition at the cursor position in the text.
4818 \begin_layout Description
4819 Syntax math-macro <NAME> [<NARGS>] [def]
4822 \begin_layout Description
4823 Params <NAME>: The name of the macro, e.g. "mymacro".
4824 \begin_inset Newline newline
4827 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4830 \begin_layout Description
4831 Origin ale, 10 May 1997; sts, 21 Dec 2007
4834 \begin_layout Subsection*
4835 math-macro-add-greedy-optional-param
4838 \begin_layout Description
4839 Action Add a greedy optional parameter.
4842 \begin_layout Description
4843 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4846 \begin_layout Description
4847 Syntax math-macro-add-greedy-optional-param
4850 \begin_layout Description
4851 Origin sts, 06 January 2008
4854 \begin_layout Subsection*
4855 math-macro-add-optional-param
4858 \begin_layout Description
4859 Action Add an optional parameter.
4862 \begin_layout Description
4863 Notion Insert an optional parameter just behind the already existing optional parameters.
4866 \begin_layout Description
4867 Syntax math-macro-add-optional-param
4870 \begin_layout Description
4871 Origin sts, 06 January 2008
4874 \begin_layout Subsection*
4875 math-macro-add-param
4878 \begin_layout Description
4879 Action Add a parameter.
4882 \begin_layout Description
4883 Notion Add a parameter to a Math Macro.
4886 \begin_layout Description
4887 Syntax math-macro-add-param <NUM>
4890 \begin_layout Description
4891 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.
4894 \begin_layout Description
4895 Origin sts, 06 January 2008
4898 \begin_layout Subsection*
4899 math-macro-append-greedy-param
4902 \begin_layout Description
4903 Action Append a greedy parameter.
4906 \begin_layout Description
4907 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
4910 \begin_layout Description
4911 Syntax math-macro-append-greedy-param
4914 \begin_layout Description
4915 Origin sts, 06 January 2008
4918 \begin_layout Subsection*
4922 \begin_layout Description
4923 Action Fold a Math Macro.
4926 \begin_layout Description
4927 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
4932 \begin_layout Description
4933 Syntax math-macro-fold
4936 \begin_layout Description
4937 Origin sts, 06 January 2008
4940 \begin_layout Subsection*
4941 math-macro-make-nonoptional
4944 \begin_layout Description
4945 Action Make a parameter non-optional.
4948 \begin_layout Description
4949 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.
4952 \begin_layout Description
4953 Syntax math-macro-make-nonoptional
4956 \begin_layout Description
4957 Origin sts, 06 January 2008
4960 \begin_layout Subsection*
4961 math-macro-make-optional
4964 \begin_layout Description
4965 Action Make a parameter optional.
4968 \begin_layout Description
4969 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
4972 \begin_layout Description
4973 Syntax math-macro-make-optional
4976 \begin_layout Description
4977 Origin sts, 06 January 2008
4980 \begin_layout Subsection*
4981 math-macro-remove-greedy-param
4984 \begin_layout Description
4985 Action Remove a greedy parameter.
4988 \begin_layout Description
4989 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.
4992 \begin_layout Description
4993 Syntax math-macro-remove-greedy-param
4996 \begin_layout Description
4997 Origin sts, 06 January 2008
5000 \begin_layout Subsection*
5001 math-macro-remove-optional-param
5004 \begin_layout Description
5005 Action Remove the last optional parameter.
5008 \begin_layout Description
5009 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
5012 \begin_layout Description
5013 Syntax math-macro-remove-optional-param
5016 \begin_layout Description
5017 Origin sts, 06 January 2008
5020 \begin_layout Subsection*
5021 math-macro-remove-param
5024 \begin_layout Description
5025 Action Remove the last parameter.
5028 \begin_layout Description
5029 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
5032 \begin_layout Description
5033 Syntax math-macro-remove-param <NUM>
5036 \begin_layout Description
5037 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
5040 \begin_layout Description
5041 Origin sts, 06 January 2008
5044 \begin_layout Subsection*
5048 \begin_layout Description
5049 Action Unfold a Math Macro.
5052 \begin_layout Description
5053 Notion Unfold the Math Macro the cursor is in, i.e. display it as
5058 \begin_layout Description
5059 Syntax math-macro-unfold
5062 \begin_layout Description
5063 Origin sts, 06 January 2008
5066 \begin_layout Subsection*
5070 \begin_layout Description
5071 Action Inserts a matrix.
5074 \begin_layout Description
5075 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5078 \begin_layout Description
5079 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).
5082 \begin_layout Description
5083 Sample math-matrix 3 3 bccc
5086 \begin_layout Subsection*
5090 \begin_layout Description
5091 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.
5094 \begin_layout Description
5095 Notion If there is some selected text, it puts the text inside created math box.
5098 \begin_layout Description
5099 Syntax math-mode [on|<ARG>]
5102 \begin_layout Description
5103 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
5104 \begin_inset Newline newline
5107 "on": allow only entering of math mode from text mode.
5110 \begin_layout Description
5111 Origin Alejandro, 4 Jun 1996
5114 \begin_layout Subsection*
5118 \begin_layout Description
5119 Action Mutates the type of math inset to the newly selected one.
5122 \begin_layout Description
5123 Syntax math-mutate <TYPE>
5126 \begin_layout Description
5127 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
5130 \begin_layout Description
5131 Origin Andre, 23 May 2001
5134 \begin_layout Subsection*
5135 math-number-line-toggle
5138 \begin_layout Description
5139 Action Toggles numbering of the current formula line.
5142 \begin_layout Description
5143 Notion Must be in display formula mode.
5146 \begin_layout Description
5147 Syntax math-number-line-toggle
5150 \begin_layout Description
5151 Origin Alejandro, 18 Jun 1996
5154 \begin_layout Subsection*
5158 \begin_layout Description
5159 Action Toggles numbering/labeling of the current formula.
5162 \begin_layout Description
5163 Notion Must be in display formula mode.
5166 \begin_layout Description
5167 Syntax math-number-toggle
5170 \begin_layout Description
5171 Origin Alejandro, 4 Jun 1996
5174 \begin_layout Subsection*
5178 \begin_layout Description
5179 Action Changes arbitrarily the size used by math fonts inside a context.
5182 \begin_layout Description
5183 Notion Provides an interface to the LaTeX math mode font size commands.
5186 \begin_layout Description
5187 Syntax math-size <STYLE>
5190 \begin_layout Description
5202 \begin_layout Description
5203 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5206 \begin_layout Subsection*
5210 \begin_layout Description
5211 Action Inserts space into math expression.
5214 \begin_layout Description
5215 Notion Use spacebar after entering this space to change type of space.
5218 \begin_layout Description
5219 Syntax math-space [<TYPE>] [<LEN>]
5222 \begin_layout Description
5223 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5224 \begin_inset Newline newline
5227 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5228 \begin_inset Newline newline
5231 custom space: hspace
5232 \begin_inset Newline newline
5235 "," used by default.
5236 \begin_inset Newline newline
5239 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5240 \begin_inset Newline newline
5243 <LEN>: length for custom spaces (hspace)
5246 \begin_layout Description
5247 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5250 \begin_layout Subsection*
5254 \begin_layout Description
5255 Action Enters subscript expression in math expression.
5258 \begin_layout Description
5259 Syntax math-subscript
5262 \begin_layout Description
5263 Origin vermeer, 12 Dec 2001
5266 \begin_layout Subsection*
5270 \begin_layout Description
5271 Action Enters superscript expression in math expression.
5274 \begin_layout Description
5275 Syntax math-superscript
5278 \begin_layout Description
5279 Origin vermeer, 12 Dec 2001
5282 \begin_layout Subsection*
5286 \begin_layout Description
5287 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5290 \begin_layout Description
5291 Notion If there is any selected text, then it is moved inside the created regexp inset.
5294 \begin_layout Description
5295 Syntax regexp-mode [<ARG>]
5298 \begin_layout Description
5299 Params <ARG>: eventual argument (regular expression).
5302 \begin_layout Description
5303 Origin Tommaso, 4 Oct 2008
5306 \begin_layout Section
5307 Buffer Fuctions (File and Window related)
5310 \begin_layout Subsection*
5314 \begin_layout Description
5315 Action Activate the branch.
5318 \begin_layout Description
5319 Syntax branch-activate <BRANCH>
5322 \begin_layout Description
5323 Params <BRANCH>: The branch to activate
5326 \begin_layout Description
5327 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5328 \begin_inset Newline newline
5331 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5334 \begin_layout Description
5335 Origin rgh, 27 May 2008
5338 \begin_layout Subsection*
5342 \begin_layout Description
5343 Action Add a branch to the buffer's BranchList.
5346 \begin_layout Description
5347 Syntax branch-add <BRANCH>
5350 \begin_layout Description
5351 Params <BRANCH>: Name of the branch to add
5354 \begin_layout Description
5355 Origin spitz, 7 Jul 2009
5358 \begin_layout Subsection*
5362 \begin_layout Description
5363 Action Create new branch and directly put the branch inset into the document.
5366 \begin_layout Description
5367 Syntax branch-add-insert [<NAME>]
5370 \begin_layout Description
5371 Params <NAME>: Branch name. If it is not specified, you will be asked.
5374 \begin_layout Description
5375 Origin sanda, 10 Jul 2009
5378 \begin_layout Subsection*
5382 \begin_layout Description
5383 Action De-activate the branch.
5386 \begin_layout Description
5387 Syntax branch-deactivate <BRANCH>
5390 \begin_layout Description
5391 Params <BRANCH>: The branch to deactivate
5394 \begin_layout Description
5395 Origin rgh, 27 May 2008
5398 \begin_layout Subsection*
5402 \begin_layout Description
5403 Action Toggles inversion status of branch inset.
5406 \begin_layout Description
5407 Syntax branch-invert
5410 \begin_layout Description
5411 Origin rgheck, 12 July 2016
5414 \begin_layout Subsection*
5415 branch-master-activate
5418 \begin_layout Description
5419 Action Activate the branch in the master buffer.
5422 \begin_layout Description
5423 Syntax branch-master-activate <BRANCH>
5426 \begin_layout Description
5427 Params <BRANCH>: The branch to activate
5430 \begin_layout Description
5431 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5432 \begin_inset Newline newline
5435 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5438 \begin_layout Description
5439 Origin spitz, 30 Sep 2012
5442 \begin_layout Subsection*
5443 branch-master-deactivate
5446 \begin_layout Description
5447 Action De-activate the branch in the master buffer.
5450 \begin_layout Description
5451 Syntax branch-master-deactivate <BRANCH>
5454 \begin_layout Description
5455 Params <BRANCH>: The branch to deactivate
5458 \begin_layout Description
5459 Origin spitz, 30 Sep 2012
5462 \begin_layout Subsection*
5466 \begin_layout Description
5467 Action Rename all branches of a given name in a document.
5470 \begin_layout Description
5471 Syntax branches-rename <OLDNAME> <NEWNAME>
5474 \begin_layout Description
5475 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5478 \begin_layout Description
5479 Origin spitz, 9 Jul 2009
5482 \begin_layout Subsection*
5486 \begin_layout Description
5487 Action Saves the current buffer to a temporary file.
5490 \begin_layout Description
5491 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5494 \begin_layout Description
5495 Syntax buffer-auto-save
5498 \begin_layout Subsection*
5502 \begin_layout Description
5503 Action Loads the given child document.
5506 \begin_layout Description
5507 Notion The current document is treated as a parent.
5510 \begin_layout Description
5511 Syntax buffer-child-open <FILE>
5514 \begin_layout Description
5515 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5518 \begin_layout Description
5519 Origin Ale, 28 May 1997
5522 \begin_layout Subsection*
5526 \begin_layout Description
5527 Action Runs chktex for the current document.
5530 \begin_layout Description
5531 Syntax buffer-chktex
5534 \begin_layout Description
5535 Origin Asger, 30 Oct 1997
5538 \begin_layout Subsection*
5542 \begin_layout Description
5543 Action Closes the current buffer.
5546 \begin_layout Description
5547 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5550 \begin_layout Description
5554 \begin_layout Subsection*
5558 \begin_layout Description
5559 Action Closes all buffers.
5562 \begin_layout Description
5563 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5566 \begin_layout Description
5567 Syntax buffer-close-all
5570 \begin_layout Subsection*
5574 \begin_layout Description
5575 Action Exports the current buffer (document) to the given format.
5578 \begin_layout Description
5579 Syntax buffer-export [<FORMAT>] [<DEST>]
5582 \begin_layout Description
5583 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.
5584 \begin_inset Newline newline
5587 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.
5588 \begin_inset Newline newline
5591 If absent or "default", then the default output format of the document is used. <DEST> If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
5594 \begin_layout Description
5595 Origin Lgb, 29 Jul 1997
5598 \begin_layout Subsection*
5602 \begin_layout Description
5603 Action Opens a dialog for exporting the current buffer.
5606 \begin_layout Description
5607 Syntax buffer-export-as [<FORMAT>]
5610 \begin_layout Description
5611 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.
5614 \begin_layout Description
5615 Sample buffer-export-as pdf2
5618 \begin_layout Description
5619 Origin tommaso, 6 Oct 2011
5622 \begin_layout Subsection*
5623 buffer-export-custom
5626 \begin_layout Description
5627 Action Exports the current buffer (document) from the given format using the given command on it.
5630 \begin_layout Description
5631 Syntax buffer-export-custom <FORMAT> <COMMAND>
5634 \begin_layout Description
5635 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5636 \begin_inset Newline newline
5639 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5642 \begin_layout Description
5643 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5646 \begin_layout Description
5647 Origin leeming, 27 Mar 2004
5650 \begin_layout Subsection*
5651 buffer-external-modification-clear
5654 \begin_layout Description
5655 Action Clear the external modification flag on the current buffer.
5658 \begin_layout Description
5659 Syntax buffer-external-modification-clear
5662 \begin_layout Description
5663 Origin gm, 2 March 2017
5666 \begin_layout Subsection*
5670 \begin_layout Description
5671 Action Applies a command to all non-hidden buffers.
5674 \begin_layout Description
5675 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5678 \begin_layout Description
5679 Syntax buffer-forall <LFUN-COMMAND>
5682 \begin_layout Description
5683 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5686 \begin_layout Description
5687 Sample Close all Notes in buffers:
5688 \begin_inset Newline newline
5691 buffer-forall inset-forall Note inset-toggle close
5692 \begin_inset Newline newline
5695 Toggle change tracking on buffers:
5696 \begin_inset Newline newline
5699 buffer-forall changes-track
5700 \begin_inset Newline newline
5703 Toggle read-only for buffers:
5704 \begin_inset Newline newline
5707 buffer-forall buffer-toggle-read-only
5708 \begin_inset Newline newline
5711 Show statistics for individual buffers:
5712 \begin_inset Newline newline
5715 buffer-forall statistics
5716 \begin_inset Newline newline
5719 Activate the branch named "Solutions" in buffers:
5720 \begin_inset Newline newline
5723 buffer-forall branch-activate Solutions
5724 \begin_inset Newline newline
5727 Export buffers to PDF (pdflatex):
5728 \begin_inset Newline newline
5731 buffer-forall buffer-export pdf2
5732 \begin_inset Newline newline
5738 \begin_layout Description
5739 Origin skostysh, 20 Jul 2012
5742 \begin_layout Subsection*
5746 \begin_layout Description
5747 Action Import a given file as a lyx document.
5750 \begin_layout Description
5751 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.
5754 \begin_layout Description
5755 Syntax buffer-import <FORMAT> [<FILE>]
5758 \begin_layout Description
5759 Origin Asger, 24 Jul 1998
5762 \begin_layout Subsection*
5766 \begin_layout Description
5767 Action Set language of the current document.
5770 \begin_layout Description
5771 Syntax buffer-language <LANG>
5774 \begin_layout Description
5775 Params <LANG>: language name. See lib/languages for list.
5778 \begin_layout Description
5779 Origin leeming, 30 Mar 2004
5782 \begin_layout Subsection*
5786 \begin_layout Description
5787 Action Moves the current tab one spot to the right.
5790 \begin_layout Description
5791 Syntax buffer-move-next
5794 \begin_layout Description
5795 Origin skostysh, 7 Apr 2015
5798 \begin_layout Subsection*
5799 buffer-move-previous
5802 \begin_layout Description
5803 Action Moves the current tab one spot to the left.
5806 \begin_layout Description
5807 Syntax buffer-move-previous
5810 \begin_layout Description
5811 Origin skostysh, 7 Apr 2015
5814 \begin_layout Subsection*
5818 \begin_layout Description
5819 Action Creates a new buffer (that is, document) and switches to it.
5822 \begin_layout Description
5823 Notion Implicit path can be set in Preferences dialog.
5826 \begin_layout Description
5827 Syntax buffer-new [<FILE>]
5830 \begin_layout Description
5831 Params <FILE>: filename of created file with absolute path.
5834 \begin_layout Subsection*
5838 \begin_layout Description
5839 Action Creates a new buffer (that is, document) from a template.
5842 \begin_layout Description
5843 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5846 \begin_layout Description
5847 Syntax buffer-new-template [<FILE>]
5850 \begin_layout Description
5851 Params <FILE>: filename of created file with absolute path.
5854 \begin_layout Subsection*
5858 \begin_layout Description
5859 Action Switch to the next opened document.
5862 \begin_layout Description
5863 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
5866 \begin_layout Description
5870 \begin_layout Subsection*
5874 \begin_layout Description
5875 Action Apply the given settings to the current document.
5878 \begin_layout Description
5879 Syntax buffer-params-apply [<ARGS>]
5882 \begin_layout Description
5883 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5886 \begin_layout Description
5887 Origin leeming, 30 Mar 2004
5890 \begin_layout Subsection*
5894 \begin_layout Description
5895 Action Switch to the previous opened document.
5898 \begin_layout Description
5899 Syntax buffer-previous
5902 \begin_layout Subsection*
5906 \begin_layout Description
5907 Action Reverts opened document.
5910 \begin_layout Description
5911 Syntax buffer-reload
5914 \begin_layout Description
5915 Origin Asger, 2 Feb 1997
5918 \begin_layout Subsection*
5919 buffer-save-as-default
5922 \begin_layout Description
5923 Action Save the current document settings as default.
5926 \begin_layout Description
5927 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5930 \begin_layout Description
5931 Syntax buffer-save-as-default [<ARGS>]
5934 \begin_layout Description
5935 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5938 \begin_layout Description
5939 Origin leeming, 30 Mar 2004
5942 \begin_layout Subsection*
5946 \begin_layout Description
5947 Action Display and switch to the given buffer.
5950 \begin_layout Description
5951 Syntax buffer-switch <BUFFER>
5954 \begin_layout Description
5955 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
5958 \begin_layout Subsection*
5959 buffer-toggle-compression
5962 \begin_layout Description
5963 Action Toggles compression of the current document on/off.
5966 \begin_layout Description
5967 Syntax buffer-toggle-compression
5970 \begin_layout Description
5971 Origin bpeng, 27 Apr 2006
5974 \begin_layout Subsection*
5975 buffer-toggle-read-only
5978 \begin_layout Description
5979 Action Toggle editing mode of the current document between read/write and read-only.
5982 \begin_layout Description
5983 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.
5986 \begin_layout Description
5987 Syntax buffer-toggle-read-only
5990 \begin_layout Description
5991 Origin Lgb, 27 May 1997
5994 \begin_layout Subsection*
5998 \begin_layout Description
5999 Action Exports the current document and put the result into the temporary directory.
6002 \begin_layout Description
6003 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).
6006 \begin_layout Description
6007 Syntax buffer-update [<FORMAT>]
6010 \begin_layout Description
6011 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.
6014 \begin_layout Description
6015 Origin Dekel, 5 Aug 2000
6018 \begin_layout Subsection*
6022 \begin_layout Description
6023 Action Displays current buffer in chosen format.
6026 \begin_layout Description
6027 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.
6030 \begin_layout Description
6031 Syntax buffer-view [<FORMAT>]
6034 \begin_layout Description
6035 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.
6038 \begin_layout Subsection*
6042 \begin_layout Description
6043 Action Opens the file that was created from last preview of this buffer.
6046 \begin_layout Description
6047 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.
6050 \begin_layout Description
6051 Syntax buffer-view-cache
6054 \begin_layout Subsection*
6058 \begin_layout Description
6059 Action Saves the current buffer.
6062 \begin_layout Description
6063 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.
6066 \begin_layout Description
6070 \begin_layout Subsection*
6074 \begin_layout Description
6075 Action Save all changed documents.
6078 \begin_layout Description
6079 Syntax buffer-write-all
6082 \begin_layout Description
6083 Origin rgh, gpothier 6 Aug 2007
6086 \begin_layout Subsection*
6090 \begin_layout Description
6091 Action Rename and save current buffer.
6094 \begin_layout Description
6095 Syntax buffer-write-as <FILENAME>
6098 \begin_layout Description
6099 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6102 \begin_layout Subsection*
6106 \begin_layout Description
6107 Action Sets the zoom of the screen fonts.
6110 \begin_layout Description
6111 Syntax buffer-zoom [<ZOOM>]
6114 \begin_layout Description
6115 Params <ZOOM>: The target zoom value in %; the default is the default zoom as saved in preferences.
6118 \begin_layout Description
6119 Origin daniel, 28 Oct 2016
6122 \begin_layout Subsection*
6126 \begin_layout Description
6127 Action Increases the zoom of the screen fonts.
6130 \begin_layout Description
6131 Syntax buffer-zoom-in [<ZOOM>]
6134 \begin_layout Description
6135 Params <ZOOM>: The zoom value addition in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6138 \begin_layout Description
6139 Origin vfr, 30 Mar 2009
6142 \begin_layout Subsection*
6146 \begin_layout Description
6147 Action Decreases the zoom of the screen fonts.
6150 \begin_layout Description
6151 Syntax buffer-zoom-out [<ZOOM>]
6154 \begin_layout Description
6155 Params <ZOOM>: The zoom value abstraction in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6158 \begin_layout Description
6159 Origin vfr, 30 Mar 2009
6162 \begin_layout Subsection*
6166 \begin_layout Description
6167 Action Generates the code (literate programming).
6170 \begin_layout Description
6171 Notion Latex file with extension
6173 literate_extension is generated. Then LyX invokes
6175 build_command (with a default of ``make'') to generate the code and
6177 build_error_filter to process the compilation error messages.
6178 \begin_inset Newline newline
6181 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:
6182 \begin_inset Newline newline
6187 build_command "my_script my_arguments"
6188 \begin_inset Newline newline
6193 build_error_filter differs from the
6195 literate_error_filter only in that the former will identify error messages from your compiler.
6198 \begin_layout Description
6199 Syntax build-program
6202 \begin_layout Subsection*
6206 \begin_layout Description
6207 Action Open LyX document.
6210 \begin_layout Description
6211 Syntax file-open [<FILE>]
6214 \begin_layout Description
6215 Params <FILE>: Filename to be opened.
6218 \begin_layout Subsection*
6222 \begin_layout Description
6223 Action Open the given help file according to the language setting.
6226 \begin_layout Description
6227 Syntax help-open <FILE>[.lyx]
6230 \begin_layout Description
6231 Params <FILE>: any document from (/usr/share/)doc directory.
6234 \begin_layout Description
6235 Origin Jug, 27 Jun 1999
6238 \begin_layout Subsection*
6242 \begin_layout Description
6243 Action Sets icon size of toolbars.
6246 \begin_layout Description
6247 Syntax icon-size [<SIZE>]
6250 \begin_layout Description
6251 Params <SIZE> : the icon size in px or one of the logical settings small|normal|big|huge|giant, the default is normal (whose size in px is icon set dependent).
6254 \begin_layout Description
6258 \begin_layout Subsection*
6262 \begin_layout Description
6263 Action Terminates the current LyX instance.
6266 \begin_layout Description
6267 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6270 \begin_layout Description
6274 \begin_layout Subsection*
6275 master-buffer-export
6278 \begin_layout Description
6279 Action Exports the master buffer (document) to the given format.
6282 \begin_layout Description
6283 Syntax master-buffer-export [<FORMAT>] [<DEST>]
6286 \begin_layout Description
6287 Params <FORMAT> is 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.
6288 \begin_inset Newline newline
6291 Note that "custom" is not allowed in this case.
6292 \begin_inset Newline newline
6295 If absent or "default", then the default output format of the document is used.
6296 \begin_inset Newline newline
6299 <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.
6302 \begin_layout Description
6303 Origin rkh, 18 April 2018
6306 \begin_layout Subsection*
6307 master-buffer-update
6310 \begin_layout Description
6311 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6314 \begin_layout Description
6315 Syntax master-buffer-update [<FORMAT>]
6318 \begin_layout Description
6319 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.
6322 \begin_layout Description
6323 Origin Tommaso, 20 Sep 2007
6326 \begin_layout Subsection*
6330 \begin_layout Description
6331 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6334 \begin_layout Description
6335 Syntax master-buffer-view [<FORMAT>]
6338 \begin_layout Description
6339 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.
6342 \begin_layout Description
6343 Origin Tommaso, 20 Sep 2007
6346 \begin_layout Subsection*
6350 \begin_layout Description
6351 Action Opens the menu given by its name.
6354 \begin_layout Description
6355 Syntax menu-open <NAME>
6358 \begin_layout Description
6359 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6362 \begin_layout Subsection*
6366 \begin_layout Description
6367 Action Close the current tab group.
6370 \begin_layout Description
6371 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6374 \begin_layout Description
6375 Syntax tab-group-close
6378 \begin_layout Description
6379 Origin Abdel, 21 Feb 2008
6382 \begin_layout Subsection*
6386 \begin_layout Description
6387 Action Toggles movability of a given toolbar between true/false.
6390 \begin_layout Description
6391 Syntax toolbar-movable <NAME>
6394 \begin_layout Description
6395 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate|
6396 \begin_inset Newline newline
6399 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6402 \begin_layout Description
6403 Origin daniel, 12 July 2016
6406 \begin_layout Subsection*
6410 \begin_layout Description
6411 Action Toggles visibility of a given toolbar between on/off/auto.
6414 \begin_layout Description
6415 Notion Skipping "auto" when allowauto is false.
6418 \begin_layout Description
6419 Syntax toolbar-toggle <NAME> [allowauto]
6422 \begin_layout Description
6423 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6424 \begin_inset Newline newline
6427 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6430 \begin_layout Description
6431 Origin Edwin, 21 May 2007
6434 \begin_layout Subsection*
6438 \begin_layout Description
6439 Action Various UI visibility-toggling actions.
6442 \begin_layout Description
6443 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6446 \begin_layout Description
6447 Params statusbar : Toggle visibility of the statusbar.
6448 \begin_inset Newline newline
6451 menubar : Toggle visibility of the menubar.
6452 \begin_inset Newline newline
6455 scrollbar : Toggle visibility of the scrollbar.
6456 \begin_inset Newline newline
6459 frame : Toggle visibility of the frames around editing window.
6460 \begin_inset Newline newline
6463 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.
6466 \begin_layout Description
6467 Origin sanda, 9 Feb 2007
6470 \begin_layout Subsection*
6474 \begin_layout Description
6475 Action Close the current document work area.
6478 \begin_layout Description
6479 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6482 \begin_layout Description
6486 \begin_layout Description
6487 Origin Tommaso, 15 Sep 2012
6490 \begin_layout Subsection*
6494 \begin_layout Description
6495 Action Creates another split view of current buffer.
6498 \begin_layout Description
6499 Notion All split views act in the same way independently.
6502 \begin_layout Description
6503 Syntax view-split <vertical|horizontal>
6506 \begin_layout Description
6507 Params horizontal : The work areas are laid out side by side.
6508 \begin_inset Newline newline
6511 vertical : The work areas laid out vertically.
6514 \begin_layout Description
6515 Origin Abdel, 20 Feb 2008
6518 \begin_layout Subsection*
6522 \begin_layout Description
6523 Action Closes the current LyX window.
6526 \begin_layout Description
6530 \begin_layout Description
6531 Origin Abdel, 23 Oct 2006
6534 \begin_layout Subsection*
6538 \begin_layout Description
6539 Action Creates new empty LyX window.
6542 \begin_layout Description
6543 Notion Already opened documents from the previous window can be found under View menu.
6546 \begin_layout Description
6547 Syntax window-new [<GEOMETRY>]
6550 \begin_layout Description
6551 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6554 \begin_layout Description
6555 Origin Abdel, 21 Oct 2006
6558 \begin_layout Section
6559 System Functions (Preferences, LyX Server etc.)
6562 \begin_layout Subsection*
6563 buffer-toggle-output-sync
6566 \begin_layout Description
6567 Action Toggles including of resources for forward/reverse search of the given document.
6570 \begin_layout Description
6571 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6574 \begin_layout Description
6575 Syntax buffer-toggle-output-sync
6578 \begin_layout Description
6579 Origin sanda, 25 May 2010
6582 \begin_layout Subsection*
6586 \begin_layout Description
6587 Action Executes a command defined in a .def file.
6590 \begin_layout Description
6591 Notion The definitions are by default read from lib/commands/default.def.
6592 \begin_inset Newline newline
6595 A .def file allows to define a command with
6597 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).
6599 def_file "FileName" allows to include another .def file.
6600 \begin_inset Newline newline
6603 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.
6606 \begin_layout Description
6610 \begin_layout Description
6611 Params <NAME>: Name of the command that must be called.
6614 \begin_layout Description
6615 Origin broider, 2 Oct 2007
6618 \begin_layout Subsection*
6622 \begin_layout Description
6623 Action Cancels sequence prepared by LFUN_META_PREFIX .
6626 \begin_layout Description
6630 \begin_layout Subsection*
6631 command-alternatives
6634 \begin_layout Description
6635 Action Runs the first listed command that is enabled.
6638 \begin_layout Description
6639 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6642 \begin_layout Description
6643 Syntax command-alternatives <CMDS>
6646 \begin_layout Description
6647 Params <CMDS>: Sequence of commands separated by semicolons.
6650 \begin_layout Description
6651 Sample command-alternatives completion-accept;cell-forward
6654 \begin_layout Description
6655 Origin rgh, 24 September 2008
6658 \begin_layout Subsection*
6662 \begin_layout Description
6663 Action Run more commands (LFUN and its parameters) in a sequence.
6666 \begin_layout Description
6667 Syntax command-sequence <CMDS>
6670 \begin_layout Description
6671 Params <CMDS>: Sequence of commands separated by semicolons.
6674 \begin_layout Description
6675 Sample command-sequence cut; ert-insert; self-insert
6677 ; paste; self-insert {}; inset-toggle;
6680 \begin_layout Description
6681 Origin Andre, 11 Nov 1999
6684 \begin_layout Subsection*
6685 cursor-follows-scrollbar-toggle
6688 \begin_layout Description
6689 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6692 \begin_layout Description
6693 Syntax toggle-cursor-follows-scrollbar
6696 \begin_layout Description
6697 Origin ARRae, 2 Dec 1997
6700 \begin_layout Subsection*
6704 \begin_layout Description
6705 Action Set debug output level.
6708 \begin_layout Description
6709 Syntax debug-level-set <LEVEL>
6712 \begin_layout Description
6713 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.
6716 \begin_layout Description
6717 Origin sanda, 28 Dec 2009
6720 \begin_layout Subsection*
6724 \begin_layout Description
6725 Action toggle a mode where more information is given in UI
6728 \begin_layout Description
6729 Notion in so called "devel" mode, the information given in the status bar is more precise, and the help documents are open in editing mode.
6732 \begin_layout Description
6733 Syntax devel-mode-toggle
6736 \begin_layout Description
6737 Origin lasgouttes, 23 Jul 2017
6740 \begin_layout Subsection*
6744 \begin_layout Description
6745 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6748 \begin_layout Description
6749 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6752 \begin_layout Description
6753 Syntax forward-search
6756 \begin_layout Description
6757 Origin sanda, 14 Apr 2010
6760 \begin_layout Subsection*
6764 \begin_layout Description
6765 Action Apply the given settings to user preferences.
6768 \begin_layout Description
6769 Syntax lyxrc-apply <SETTINGS>
6772 \begin_layout Description
6773 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.
6776 \begin_layout Subsection*
6780 \begin_layout Description
6781 Action Shows message in statusbar (for script purposes).
6784 \begin_layout Description
6785 Syntax message <STRING>
6788 \begin_layout Description
6789 Origin Lgb, 8 Apr 2001
6792 \begin_layout Subsection*
6796 \begin_layout Description
6797 Action Simulate halting Meta key (Alt key on PCs).
6800 \begin_layout Description
6801 Notion Used for buffer edition not for GUI control.
6804 \begin_layout Description
6808 \begin_layout Subsection*
6812 \begin_layout Description
6813 Action Save user preferences.
6816 \begin_layout Description
6817 Syntax preferences-save
6820 \begin_layout Description
6821 Origin Lgb, 27 Nov 1999
6824 \begin_layout Subsection*
6828 \begin_layout Description
6829 Action Reconfigure the automatic settings.
6832 \begin_layout Description
6836 \begin_layout Description
6837 Origin Asger, 14 Feb 1997
6840 \begin_layout Subsection*
6844 \begin_layout Description
6845 Action Returns path and file name of the currently edited document.
6848 \begin_layout Description
6849 Syntax server-get-filename
6852 \begin_layout Subsection*
6856 \begin_layout Description
6857 Action Returns the current layout (that is environment) name on the cursor position.
6860 \begin_layout Description
6861 Syntax server-get-layout
6864 \begin_layout Subsection*
6865 server-get-statistics
6868 \begin_layout Description
6869 Action Returns the statistics (number of words and characters) in the document or in the given selection.
6872 \begin_layout Description
6873 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6876 \begin_layout Description
6877 Syntax server-get-statistics [<TYPE>]
6880 \begin_layout Description
6881 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
6882 \begin_inset Newline newline
6886 \begin_inset Newline newline
6889 chars: count characters.
6890 \begin_inset Newline newline
6893 chars-space: count characters and spaces.
6896 \begin_layout Description
6897 Origin brokenclock, Oct 10 2014
6900 \begin_layout Subsection*
6904 \begin_layout Description
6905 Action Returns the coordinates of cursor position in the editing area.
6908 \begin_layout Description
6909 Syntax server-get-xy
6912 \begin_layout Subsection*
6913 server-goto-file-row
6916 \begin_layout Description
6917 Action Sets the cursor position in LyX based on the row number of generated TeX file.
6920 \begin_layout Description
6921 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).
6924 \begin_layout Description
6925 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
6928 \begin_layout Description
6929 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.
6930 \begin_inset Newline newline
6933 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).
6934 \begin_inset Newline newline
6937 .ext: extensions will be automatically replaced by .lyx.
6938 \begin_inset Newline newline
6941 <ROW_NUMBER> The row number of the LaTeX file to which to go.
6944 \begin_layout Description
6945 Sample server-goto-file-row /home/user/example.lyx 41
6946 \begin_inset Newline newline
6949 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
6952 \begin_layout Description
6953 Origin Edmar, 23 Dec 1998
6956 \begin_layout Subsection*
6960 \begin_layout Description
6961 Action Sends notify message about the last key-sequence to client.
6964 \begin_layout Description
6965 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
6968 \begin_layout Description
6969 Syntax server-notify
6972 \begin_layout Subsection*
6976 \begin_layout Description
6977 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
6980 \begin_layout Description
6981 Syntax server-set-xy <X> <Y>
6984 \begin_layout Subsection*
6988 \begin_layout Description
6989 Action Set the given LyX color to the color defined by the X11 name given.
6992 \begin_layout Description
6993 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
6996 \begin_layout Description
6997 Syntax set-color <LYX_NAME> <X11_NAME>
7000 \begin_layout Description
7001 Origin SLior, 11 Jun 2000
7004 \begin_layout Subsection*
7008 \begin_layout Description
7009 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
7012 \begin_layout Description
7013 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7016 \begin_layout Description
7020 \begin_layout Description
7021 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7024 \begin_layout Subsection*
7028 \begin_layout Description
7029 Action Checks-in/commits the changes of the registered file to the repository.
7032 \begin_layout Description
7033 Notion In RCS case this also unlocks the file.
7036 \begin_layout Description
7040 \begin_layout Description
7041 Origin Lgb, 1 Jul 1997
7044 \begin_layout Subsection*
7048 \begin_layout Description
7049 Action Checks-out the document for edit (and locks it in some cases).
7052 \begin_layout Description
7056 \begin_layout Description
7057 Origin Lgb, 1 Jul 1997
7060 \begin_layout Subsection*
7064 \begin_layout Description
7065 Action Executes external command. This command is intended to support additional VCS commands.
7068 \begin_layout Description
7069 Syntax vc-command <FLAG> <PATH> <COMMAND>
7072 \begin_layout Description
7073 Params <FLAG>: Flags for the command can be combined together.
7074 \begin_inset Newline newline
7077 U - dUmmy - no flags
7078 \begin_inset Newline newline
7081 D - Doc - need document loaded to proceed
7082 \begin_inset Newline newline
7085 I - dIrty - mark document dirty
7086 \begin_inset Newline newline
7089 R - Reload - ensure that the document is saved and reload it after command execution
7090 \begin_inset Newline newline
7093 M - Message - ask for input string (commit message)
7094 \begin_inset Newline newline
7097 <PATH>: path where to start. $$p will be replaced by the current document path.
7098 \begin_inset Newline newline
7101 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
7104 \begin_layout Description
7105 Sample vc-command DR $$p "svn up"
7108 \begin_layout Description
7109 Origin sanda, 13 Jan 2009
7112 \begin_layout Subsection*
7116 \begin_layout Description
7117 Action Compares two revisions of the same file under version control.
7120 \begin_layout Description
7121 Syntax vc-compare [<REV1>] [<REV2>]
7124 \begin_layout Description
7125 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
7126 \begin_inset Newline newline
7129 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
7130 \begin_inset Newline newline
7134 \begin_inset Newline newline
7137 <REV2>: Newer file. Used only if REV1 > 0.
7138 \begin_inset Newline newline
7141 If no parameter is given, interactive dialog will be shown.
7144 \begin_layout Description
7145 Sample Compare current document against last commit
7146 \begin_inset Newline newline
7150 \begin_inset Newline newline
7153 Compare current document against current revision - 5 commits
7154 \begin_inset Newline newline
7158 \begin_inset Newline newline
7161 Compare revisions 120 and 155
7162 \begin_inset Newline newline
7168 \begin_layout Description
7169 Origin sanda, 12 Feb 2010
7172 \begin_layout Subsection*
7176 \begin_layout Description
7177 Action Copies the document to another name.
7180 \begin_layout Description
7181 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.
7184 \begin_layout Description
7185 Syntax vc-copy <FILENAME>
7188 \begin_layout Description
7189 Params <FILENAME>: New name of the document.
7190 \begin_inset Newline newline
7193 A file dialog is opened if no filename is given.
7196 \begin_layout Description
7197 Origin gb, 05 Feb 2013
7200 \begin_layout Subsection*
7204 \begin_layout Description
7205 Action Toggles the locking property of the edited file.
7208 \begin_layout Description
7209 Notion This is currently implemented only for SVN.
7212 \begin_layout Description
7213 Syntax vc-locking-toggle
7216 \begin_layout Description
7217 Origin sanda, 25 Jun 2009
7220 \begin_layout Subsection*
7224 \begin_layout Description
7225 Action Register the document as an file inside version control system.
7228 \begin_layout Description
7229 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
7230 \begin_inset Newline newline
7233 See LyX Additional Features Manual (Version Control Chapter) for additional information.
7236 \begin_layout Description
7240 \begin_layout Description
7241 Origin Lgb, 1 Jul 1997
7244 \begin_layout Subsection*
7248 \begin_layout Description
7249 Action Renames the document to another name.
7252 \begin_layout Description
7253 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.
7256 \begin_layout Description
7257 Syntax vc-rename <FILENAME>
7260 \begin_layout Description
7261 Params <FILENAME>: New name of the document.
7262 \begin_inset Newline newline
7265 A file dialog is opened if no filename is given.
7268 \begin_layout Description
7269 Origin gb, 05 Feb 2013
7272 \begin_layout Subsection*
7276 \begin_layout Description
7277 Action Update the local archive directory in which resides the current document with the remote repository.
7280 \begin_layout Description
7281 Syntax vc-repo-update
7284 \begin_layout Description
7285 Origin sanda, 16 Oct 2009
7288 \begin_layout Subsection*
7292 \begin_layout Description
7293 Action Reverts the document to the last check-in/commit in VCS.
7296 \begin_layout Description
7300 \begin_layout Description
7301 Origin Lgb, 1 Jul 1997
7304 \begin_layout Subsection*
7308 \begin_layout Description
7309 Action Undo last check-in.
7312 \begin_layout Description
7313 Notion This is currently implemented only for RCS.
7316 \begin_layout Description
7320 \begin_layout Description
7321 Origin Lgb, 1 Jul 1997
7324 \begin_layout Section
7325 Hidden Functions (not listed for configuration)
7328 \begin_layout Subsection*
7332 \begin_layout Description
7333 Action Return the current key sequence and available options as a string.
7336 \begin_layout Description
7337 Notion No options are added if no current map exists.
7338 \begin_inset Newline newline
7341 This is probably usable only with connection to lyxserver.
7344 \begin_layout Description
7345 Syntax command-prefix
7348 \begin_layout Subsection*
7352 \begin_layout Description
7353 Action Activates the LyX window.
7356 \begin_layout Description
7357 Notion On Linux and Mac OS, this action brings the LyX window into focus. Such behavior is not allowed by Windows OS so instead the color of the taskbar entry is changed to indicate that the window has changed in some way. This action is useful in combination with reverse search.
7360 \begin_layout Description
7364 \begin_layout Description
7365 Origin skostysh, 4 Aug 2016
7368 \begin_layout Subsection*
7372 \begin_layout Description
7373 Action Inserts the given string (accordingly to the correct keymap).
7376 \begin_layout Description
7377 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7380 \begin_layout Description
7381 Syntax self-insert <STRING>