1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
10 \renewenvironment{description}{\list{}{%
11 \setlength{\itemsep}{-2pt}
12 \advance\leftmargini6\p@ \itemindent-12\p@
13 \labelwidth\z@ \let\makelabel\descriptionlabel}%
18 \use_default_options false
19 \maintain_unincluded_children false
27 \language_package default
30 \font_roman "default" "default"
31 \font_sans "default" "default"
32 \font_typewriter "default" "default"
33 \font_math "auto" "auto"
34 \font_default_family default
35 \use_non_tex_fonts false
38 \font_sf_scale 100 100
39 \font_tt_scale 100 100
42 \default_output_format default
44 \bibtex_command default
45 \index_command default
46 \paperfontsize default
51 \use_package amsmath 1
52 \use_package amssymb 1
55 \use_package mathdots 0
56 \use_package mathtools 0
58 \use_package stackrel 0
59 \use_package stmaryrd 0
60 \use_package undertilde 0
62 \cite_engine_type default
66 \paperorientation portrait
80 \paragraph_separation indent
81 \paragraph_indentation default
82 \quotes_language english
85 \paperpagestyle default
86 \tracking_changes false
105 \begin_layout Section*
109 \begin_layout Standard
110 This manual documents the
111 \begin_inset Quotes eld
115 \begin_inset Quotes erd
119 These are commands that are used to make \SpecialChar LyX
120 perform specific actions.
122 itself uses these functions internally, and every internal action is
126 \begin_layout Standard
127 LFUNs are also used in the files that define keyboard shortcuts, menu or
129 So if you want to change\SpecialChar breakableslash
130 customize the user interface, you need to deal
132 Furthermore, external programs can use LFUNs to communicate with and
133 \begin_inset Quotes eld
137 \begin_inset Quotes erd
142 Finally, you can also issue LFUNs directly via the so called mini-buffer
143 which can be opened via
146 arg "command-execute"
152 \begin_layout Standard
153 In the following, all LFUNs are listed, categorized by function.
156 \begin_layout Section
157 Layout Functions (Font, Layout and Textclass related)
160 \begin_layout Subsection*
164 \begin_layout Description
165 Action Displays list of layout choices.
168 \begin_layout Description
169 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
172 \begin_layout Description
173 Syntax drop-layouts-choice
176 \begin_layout Subsection*
180 \begin_layout Description
181 Action Splits the current environment with a Separator.
184 \begin_layout Description
185 Syntax environment-split [outer]
188 \begin_layout Description
189 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
192 \begin_layout Description
193 Origin spitz, 23 Dec 2012
196 \begin_layout Subsection*
200 \begin_layout Description
201 Action Toggles the bold font (selection-wise) using mathbf in math.
204 \begin_layout Description
208 \begin_layout Subsection*
212 \begin_layout Description
213 Action Toggles the bold font (selection-wise) using boldsymbol in math.
216 \begin_layout Description
217 Syntax font-boldsymbol
220 \begin_layout Subsection*
224 \begin_layout Description
225 Action Reverts the settings of the font to the default values (selection-wise).
228 \begin_layout Description
232 \begin_layout Subsection*
236 \begin_layout Description
237 Action Toggles the emphasis font style (selection-wise).
240 \begin_layout Description
244 \begin_layout Subsection*
248 \begin_layout Description
249 Action Toggles Fraktur family font (math-mode, selection-wise).
252 \begin_layout Description
256 \begin_layout Description
257 Origin vermeer, 10 Jan 2002
260 \begin_layout Subsection*
264 \begin_layout Description
265 Action Toggles Italics font shape (math-mode, selection-wise).
268 \begin_layout Description
272 \begin_layout Description
273 Origin vermeer, 10 Jan 2002
276 \begin_layout Subsection*
280 \begin_layout Description
281 Action Toggles Noun text style font (selection-wise).
284 \begin_layout Description
288 \begin_layout Subsection*
292 \begin_layout Description
293 Action Toggles Roman family font (selection-wise).
296 \begin_layout Description
300 \begin_layout Subsection*
304 \begin_layout Description
305 Action Toggles Sans Serif family font (selection-wise).
308 \begin_layout Description
312 \begin_layout Subsection*
316 \begin_layout Description
317 Action Sets font size according to lyx format string.
320 \begin_layout Description
321 Syntax font-size <SIZE>
324 \begin_layout Description
325 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
326 \begin_inset Newline newline
329 largest|huge|giant|increase|decrease|default
332 \begin_layout Subsection*
336 \begin_layout Description
337 Action Returns the info about the current font.
340 \begin_layout Description
344 \begin_layout Subsection*
348 \begin_layout Description
349 Action Toggles strikeout (strike-through) in the font (selection-wise).
352 \begin_layout Description
353 Syntax font-strikeout
356 \begin_layout Description
357 Origin sanda, 3 May 2009
360 \begin_layout Subsection*
364 \begin_layout Description
365 Action Toggles the typewriter family font (selection-wise).
368 \begin_layout Description
369 Syntax font-typewriter
372 \begin_layout Subsection*
376 \begin_layout Description
377 Action Toggles underline in the font (selection-wise).
380 \begin_layout Description
381 Syntax font-underline
384 \begin_layout Subsection*
388 \begin_layout Description
389 Action Toggles double underline in the font (selection-wise).
392 \begin_layout Description
393 Syntax font-underunderline
396 \begin_layout Description
397 Origin sanda, 5 May 2009
400 \begin_layout Subsection*
404 \begin_layout Description
405 Action Toggles wavy underline in the font (selection-wise).
408 \begin_layout Description
409 Syntax font-underwave
412 \begin_layout Description
413 Origin sanda, 5 May 2009
416 \begin_layout Subsection*
420 \begin_layout Description
421 Action Sets the layout (that is, environment) for the current paragraph.
424 \begin_layout Description
425 Syntax layout <LAYOUT>
428 \begin_layout Description
429 Params <LAYOUT>: the layout to use
432 \begin_layout Subsection*
436 \begin_layout Description
437 Action Adds a module.
440 \begin_layout Description
441 Notion Adds a module to the list of included modules for the current buffer.
444 \begin_layout Description
445 Syntax layout-module-add <MODULE>
448 \begin_layout Description
449 Params <MODULE>: the module to be added
452 \begin_layout Description
453 Origin rgh, 25 August 2007
456 \begin_layout Subsection*
460 \begin_layout Description
461 Action Clears the module list.
464 \begin_layout Description
465 Notion Clears the list of included modules for the current buffer.
468 \begin_layout Description
469 Syntax layout-modules-clear
472 \begin_layout Description
473 Origin rgh, 25 August 2007
476 \begin_layout Subsection*
480 \begin_layout Description
481 Action Launches the paragraph settings dialog.
484 \begin_layout Description
485 Syntax layout-paragraph
488 \begin_layout Subsection*
492 \begin_layout Description
493 Action Reloads layout information.
496 \begin_layout Description
497 Notion Reloads all layout information for the current buffer from disk, thus recognizing any changes that have been made to layout files on the fly. This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
500 \begin_layout Description
504 \begin_layout Description
505 Origin rgh, 3 September 2007
508 \begin_layout Subsection*
512 \begin_layout Description
513 Action Launches the tabular settings dialog.
516 \begin_layout Description
517 Syntax layout-tabular
520 \begin_layout Description
521 Origin Jug, 31 Jul 2000
524 \begin_layout Subsection*
528 \begin_layout Description
529 Action Update fonts and its metrics.
532 \begin_layout Description
533 Notion Automatically called after zoom, dpi, font names, or norm change.
536 \begin_layout Description
537 Syntax screen-font-update
540 \begin_layout Description
541 Origin ARRae, 13 Aug 2000
544 \begin_layout Subsection*
548 \begin_layout Description
549 Action Sets the text class for the current buffer.
552 \begin_layout Description
553 Syntax textclass-apply <TEXTCLASS>
556 \begin_layout Description
557 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
560 \begin_layout Subsection*
564 \begin_layout Description
565 Action Loads information for a textclass from disk.
568 \begin_layout Description
569 Syntax textclass-load <TEXTCLASS>
572 \begin_layout Description
573 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
576 \begin_layout Subsection*
580 \begin_layout Description
581 Action Toggle user-defined (=last-time used) text style.
584 \begin_layout Description
585 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
588 \begin_layout Description
589 Syntax textstyle-apply
592 \begin_layout Description
593 Origin leeming, 12 Mar 2003
596 \begin_layout Subsection*
600 \begin_layout Description
601 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
604 \begin_layout Description
605 Syntax textstyle-update <FONT_INFO>
608 \begin_layout Description
609 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
610 \begin_inset Newline newline
613 Use lyx -dbg action for exact syntax of text-style dialog parameters.
616 \begin_layout Description
617 Origin leeming, 12 Mar 2003
620 \begin_layout Section
621 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
624 \begin_layout Subsection*
628 \begin_layout Description
629 Action Adds an acute accent to the next character typed.
632 \begin_layout Description
636 \begin_layout Subsection*
640 \begin_layout Description
641 Action Adds a breve accent to the next character typed.
644 \begin_layout Description
648 \begin_layout Subsection*
652 \begin_layout Description
653 Action Adds a caron to the next character typed.
656 \begin_layout Description
660 \begin_layout Subsection*
664 \begin_layout Description
665 Action Adds a cedilla to the next character typed.
668 \begin_layout Description
669 Syntax accent-cedilla
672 \begin_layout Subsection*
676 \begin_layout Description
677 Action Adds a circle accent to the next character typed.
680 \begin_layout Description
684 \begin_layout Subsection*
688 \begin_layout Description
689 Action Adds a circumflex to the next character typed.
692 \begin_layout Description
693 Syntax accent-circumflex
696 \begin_layout Subsection*
700 \begin_layout Description
701 Action Adds a dot accent to the next character typed.
704 \begin_layout Description
708 \begin_layout Subsection*
712 \begin_layout Description
713 Action Adds a grave accent to the next character typed.
716 \begin_layout Description
720 \begin_layout Subsection*
721 accent-hungarian-umlaut
724 \begin_layout Description
725 Action Adds a Hungarian umlaut to the next character typed.
728 \begin_layout Description
732 \begin_layout Subsection*
736 \begin_layout Description
737 Action Adds a macron to the next character typed.
740 \begin_layout Description
744 \begin_layout Subsection*
748 \begin_layout Description
749 Action Adds an ogonek accent to the next character typed.
752 \begin_layout Description
756 \begin_layout Subsection*
760 \begin_layout Description
761 Action Adds a perispomeni (Greek circumflex) over the next character typed.
764 \begin_layout Description
765 Syntax accent-perispomeni
768 \begin_layout Subsection*
772 \begin_layout Description
773 Action Adds a tie over the next two character typed.
776 \begin_layout Description
777 Notion The following char will finish the tie.
780 \begin_layout Description
784 \begin_layout Subsection*
788 \begin_layout Description
789 Action Adds a tilde over the next character typed.
792 \begin_layout Description
796 \begin_layout Subsection*
800 \begin_layout Description
801 Action Adds an umlaut over the next character typed.
804 \begin_layout Description
808 \begin_layout Subsection*
812 \begin_layout Description
813 Action Adds a bar under the next character typed.
816 \begin_layout Description
817 Syntax accent-underbar
820 \begin_layout Subsection*
824 \begin_layout Description
825 Action Adds a dot under the next character typed.
828 \begin_layout Description
829 Syntax accent-underdot
832 \begin_layout Subsection*
836 \begin_layout Description
837 Action Accepts all tracked changes in the document.
840 \begin_layout Description
841 Syntax all-changes-accept
844 \begin_layout Description
845 Origin Levon, 16 Oct 2002
848 \begin_layout Subsection*
852 \begin_layout Description
853 Action Rejects all tracked changes in the document.
856 \begin_layout Description
857 Notion Reject does not work recursively; the user may have to repeat the operation.
860 \begin_layout Description
861 Syntax all-changes-reject
864 \begin_layout Description
865 Origin Levon, 16 Oct 2002
868 \begin_layout Subsection*
872 \begin_layout Description
873 Action Start (or remove) Appendix on the given cursor position.
876 \begin_layout Description
880 \begin_layout Description
881 Origin ettrich, 5 May 1998
884 \begin_layout Subsection*
888 \begin_layout Description
889 Action Inserts an argument (short title) inset.
892 \begin_layout Description
893 Syntax argument-insert <argument nr>
896 \begin_layout Description
897 Params <argument nr>: see layout declarations
900 \begin_layout Description
901 Origin vermeer, 12 Aug 2002
904 \begin_layout Subsection*
908 \begin_layout Description
909 Action Adds database, which will be used for bibtex citations.
912 \begin_layout Description
913 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
916 \begin_layout Description
917 Syntax bibtex-database-add <DATABASE-NAME>
920 \begin_layout Description
921 Origin Ale, 30 May 1997
924 \begin_layout Subsection*
928 \begin_layout Description
929 Action Adds database, which will be used for bibtex citations.
932 \begin_layout Description
933 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
936 \begin_layout Description
937 Syntax bibtex-database-del <DATABASE-NAME>
940 \begin_layout Description
941 Origin Ale, 30 May 1997
944 \begin_layout Subsection*
948 \begin_layout Description
949 Action Clears the list of saved bookmarks.
952 \begin_layout Description
953 Syntax bookmark-clear
956 \begin_layout Description
957 Origin bpeng, 31 October 2006
960 \begin_layout Subsection*
964 \begin_layout Description
965 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
968 \begin_layout Description
969 Notion Bookmark 0 has a special purpose. It is automatically set
970 \begin_inset Newline newline
973 1. to the paragraph you are currently editing
974 \begin_inset Newline newline
977 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
978 \begin_inset Newline newline
981 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
984 \begin_layout Description
985 Syntax bookmark-goto <NUMBER>
988 \begin_layout Description
989 Params <NUMBER>: the number of the bookmark to restore.
992 \begin_layout Description
993 Origin Dekel, 27 January 2001
996 \begin_layout Subsection*
1000 \begin_layout Description
1001 Action Save a bookmark.
1004 \begin_layout Description
1005 Notion Saves a numbered bookmark to the sessions file. The number must be between 1 and 9, inclusive. Note that bookmarks are saved per-session, not per file.
1008 \begin_layout Description
1009 Syntax bookmark-save <NUMBER>
1012 \begin_layout Description
1013 Params <NUMBER>: the number of the bookmark to save.
1016 \begin_layout Description
1017 Origin Dekel, 27 January 2001
1020 \begin_layout Subsection*
1024 \begin_layout Description
1025 Action Inserts Box inset.
1028 \begin_layout Description
1029 Syntax box-insert [<TYPE>]
1032 \begin_layout Description
1033 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1034 \begin_inset Newline newline
1037 Framed is the default one.
1040 \begin_layout Description
1041 Origin vermeer, 7 Oct 2003
1044 \begin_layout Subsection*
1048 \begin_layout Description
1049 Action Inserts branch inset.
1052 \begin_layout Description
1053 Syntax branch-insert <BRANCH-NAME>
1056 \begin_layout Description
1057 Origin vermeer, 17 Aug 2003
1060 \begin_layout Subsection*
1064 \begin_layout Description
1065 Action Move the cursor to the beginning of the document.
1068 \begin_layout Description
1072 \begin_layout Subsection*
1076 \begin_layout Description
1077 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1080 \begin_layout Description
1081 Syntax buffer-begin-select
1084 \begin_layout Subsection*
1088 \begin_layout Description
1089 Action Move the cursor to the end of the document.
1092 \begin_layout Description
1096 \begin_layout Subsection*
1100 \begin_layout Description
1101 Action Move the cursor to the end of the document adding the traversed text to the selection.
1104 \begin_layout Description
1105 Syntax buffer-end-select
1108 \begin_layout Subsection*
1112 \begin_layout Description
1113 Action Inserts a caption inset.
1116 \begin_layout Description
1117 Syntax caption-insert
1120 \begin_layout Description
1121 Origin Lgb, 18 Jul 2000
1124 \begin_layout Subsection*
1128 \begin_layout Description
1129 Action Moves the cursor to the previous cell inside the table.
1132 \begin_layout Description
1133 Syntax cell-backward
1136 \begin_layout Description
1137 Origin Jug, 22 May 2000
1140 \begin_layout Subsection*
1144 \begin_layout Description
1145 Action Moves the cursor to the next cell inside the table.
1148 \begin_layout Description
1152 \begin_layout Subsection*
1156 \begin_layout Description
1157 Action Splits cell and shifts right part to the next cell (inside the math grid).
1160 \begin_layout Description
1164 \begin_layout Description
1165 Origin Ale, 15 May 1997
1168 \begin_layout Subsection*
1172 \begin_layout Description
1173 Action Accepts tracked change inside the selection.
1176 \begin_layout Description
1177 Syntax change-accept
1180 \begin_layout Description
1181 Origin Levon, 16 Oct 2002
1184 \begin_layout Subsection*
1188 \begin_layout Description
1189 Action Moves the cursor to the position of the next change of the change tracking records.
1192 \begin_layout Description
1196 \begin_layout Description
1197 Origin schmitt, 4 Oct 2006
1200 \begin_layout Subsection*
1204 \begin_layout Description
1205 Action Moves the cursor to the position of the previous change of the change tracking records.
1208 \begin_layout Description
1209 Syntax change-previous
1212 \begin_layout Description
1213 Origin vfr, 4 Apr 2009
1216 \begin_layout Subsection*
1220 \begin_layout Description
1221 Action Rejects tracked change inside the selection.
1224 \begin_layout Description
1225 Syntax change-reject
1228 \begin_layout Description
1229 Origin Levon, 16 Oct 2002
1232 \begin_layout Subsection*
1236 \begin_layout Description
1237 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1240 \begin_layout Description
1241 Syntax changes-merge
1244 \begin_layout Description
1245 Origin Levon, 16 Oct 2002
1248 \begin_layout Subsection*
1252 \begin_layout Description
1253 Action Toggles showing of change tracking in typeset output.
1256 \begin_layout Description
1257 Syntax changes-output
1260 \begin_layout Description
1261 Origin jspitzm, 21 Jan 2005
1264 \begin_layout Subsection*
1268 \begin_layout Description
1269 Action Toggles change tracking to on/off.
1272 \begin_layout Description
1273 Syntax changes-track
1276 \begin_layout Description
1277 Origin levon, 1 Oct 2002
1280 \begin_layout Subsection*
1284 \begin_layout Description
1285 Action Moves the cursor one position logically backwards.
1288 \begin_layout Description
1289 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1292 \begin_layout Description
1293 Syntax char-backward
1296 \begin_layout Subsection*
1297 char-backward-select
1300 \begin_layout Description
1301 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1304 \begin_layout Description
1305 Notion See also LFUN_CHAR_BACKWARD.
1308 \begin_layout Description
1309 Syntax char-backward-select
1312 \begin_layout Subsection*
1313 char-delete-backward
1316 \begin_layout Description
1317 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1320 \begin_layout Description
1321 Syntax char-delete-backward
1324 \begin_layout Subsection*
1328 \begin_layout Description
1329 Action Deletes one character in the backward direction (usually the "Delete" key).
1332 \begin_layout Description
1333 Syntax char-delete-forward
1336 \begin_layout Subsection*
1340 \begin_layout Description
1341 Action Moves the cursor one position logically forward.
1344 \begin_layout Description
1345 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1348 \begin_layout Description
1352 \begin_layout Subsection*
1356 \begin_layout Description
1357 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1360 \begin_layout Description
1361 Notion See also LFUN_CHAR_FORWARD.
1364 \begin_layout Description
1365 Syntax char-forward-select
1368 \begin_layout Subsection*
1372 \begin_layout Description
1373 Action Moves the cursor one position "to the left".
1376 \begin_layout Description
1377 Notion This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
1380 \begin_layout Description
1384 \begin_layout Subsection*
1388 \begin_layout Description
1389 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1392 \begin_layout Description
1393 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1396 \begin_layout Description
1397 Syntax char-left-select
1400 \begin_layout Subsection*
1404 \begin_layout Description
1405 Action Moves the cursor one position "to the right".
1408 \begin_layout Description
1409 Notion This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
1412 \begin_layout Description
1416 \begin_layout Subsection*
1420 \begin_layout Description
1421 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1424 \begin_layout Description
1425 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1428 \begin_layout Description
1429 Syntax char-right-select
1432 \begin_layout Subsection*
1436 \begin_layout Description
1437 Action Transposes the character at the cursor with the one before it.
1440 \begin_layout Description
1441 Syntax chars-transpose
1444 \begin_layout Description
1445 Origin Lgb, 25 Apr 2001
1448 \begin_layout Subsection*
1452 \begin_layout Description
1453 Action Inserts citation from loaded citation database.
1456 \begin_layout Description
1457 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1460 \begin_layout Description
1461 Params <KEY>: Citation (shortcut listed in available citations).
1462 \begin_inset Newline newline
1465 <TEXT_BEFORE>: text which should appear before citation.
1468 \begin_layout Description
1469 Origin AAS, 97-02-23
1472 \begin_layout Subsection*
1476 \begin_layout Description
1477 Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text). Pastes plain text if plain text is on the clipboard, but tries to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1480 \begin_layout Description
1481 Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source is the clipboard, not the selection.
1484 \begin_layout Description
1485 Syntax clipboard-paste [<ARG>]
1488 \begin_layout Description
1489 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1492 \begin_layout Description
1493 Origin Georg, 10 Jul 2006
1496 \begin_layout Subsection*
1497 clipboard-paste-simple
1500 \begin_layout Description
1501 Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard. Pastes plain text if plain text is on the clipboard, without trying to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
1504 \begin_layout Description
1505 Syntax clipboard-paste-simple [<ARG>]
1508 \begin_layout Description
1509 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1512 \begin_layout Subsection*
1516 \begin_layout Description
1517 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1520 \begin_layout Description
1521 Notion Usually bound to M-x shortcut.
1524 \begin_layout Description
1525 Syntax command-execute
1528 \begin_layout Subsection*
1532 \begin_layout Description
1533 Action Try to complete the word or command at the cursor position.
1536 \begin_layout Description
1540 \begin_layout Description
1541 Origin sts, Feb 19 2008
1544 \begin_layout Subsection*
1548 \begin_layout Description
1549 Action Accept suggested completion.
1552 \begin_layout Description
1553 Syntax completion-accept
1556 \begin_layout Description
1557 Origin sanda, Sep 08 2008
1560 \begin_layout Subsection*
1564 \begin_layout Description
1565 Action Try to cancel completion, either the popup or the inline completion.
1568 \begin_layout Description
1569 Syntax completion-cancel
1572 \begin_layout Description
1573 Origin sts, Sep 07 2008
1576 \begin_layout Subsection*
1580 \begin_layout Description
1581 Action Show the inline completion at the cursor position.
1584 \begin_layout Description
1585 Syntax completion-inline
1588 \begin_layout Description
1589 Origin sts, Feb 19 2008
1592 \begin_layout Subsection*
1596 \begin_layout Description
1597 Action Show the completion popup at the cursor position.
1600 \begin_layout Description
1601 Syntax completion-popup
1604 \begin_layout Description
1605 Origin sts, Feb 19 2008
1608 \begin_layout Subsection*
1612 \begin_layout Description
1613 Action Copies the current selection to the clipboard.
1616 \begin_layout Description
1620 \begin_layout Subsection*
1624 \begin_layout Description
1625 Action Cuts to the clipboard.
1628 \begin_layout Description
1632 \begin_layout Subsection*
1636 \begin_layout Description
1637 Action Inserts the current date.
1640 \begin_layout Description
1641 Syntax date-insert [<ARG>]
1644 \begin_layout Description
1645 Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
1648 \begin_layout Description
1649 Origin jdblair, 31 Jan 2000
1652 \begin_layout Subsection*
1656 \begin_layout Description
1657 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1660 \begin_layout Description
1661 Syntax depth-decrement
1664 \begin_layout Subsection*
1668 \begin_layout Description
1669 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1672 \begin_layout Description
1673 Syntax depth-increment
1676 \begin_layout Subsection*
1677 dialog-disconnect-inset
1680 \begin_layout Description
1681 Action Closes opened connection to opened inset.
1684 \begin_layout Description
1685 Notion Connection is used for apply functions.
1688 \begin_layout Description
1689 Syntax dialog-disconnect-inset <INSET-NAME>
1692 \begin_layout Description
1693 Origin leeming, 25 Feb 2003
1696 \begin_layout Subsection*
1700 \begin_layout Description
1701 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1704 \begin_layout Description
1705 Syntax dialog-hide <NAME>
1708 \begin_layout Description
1709 Params See LFUN_DIALOG_SHOW .
1712 \begin_layout Description
1713 Origin leeming, 25 Feb 2003
1716 \begin_layout Subsection*
1720 \begin_layout Description
1721 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1724 \begin_layout Description
1725 Syntax dialog-show <NAME> [<DATA>]
1728 \begin_layout Description
1729 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1730 \begin_inset Newline newline
1733 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1734 \begin_inset Newline newline
1737 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1738 \begin_inset Newline newline
1741 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1742 \begin_inset Newline newline
1745 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1746 \begin_inset Newline newline
1749 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1750 \begin_inset Newline newline
1753 <SPECIAL>: latexlog|vclog
1754 \begin_inset Newline newline
1757 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1760 \begin_layout Description
1761 Origin leeming, 17 Jun 2003
1764 \begin_layout Subsection*
1765 dialog-show-new-inset
1768 \begin_layout Description
1769 Action Shows hidden dialog or create new one for a given inset settings etc.
1772 \begin_layout Description
1773 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1776 \begin_layout Description
1777 Syntax dialog-show-new-inset <NAME> [<DATA>]
1780 \begin_layout Description
1781 Params See LFUN_DIALOG_SHOW .
1784 \begin_layout Description
1785 Origin leeming, 25 Feb 2003
1788 \begin_layout Subsection*
1792 \begin_layout Description
1793 Action Toggles dialog between showed/hidden state.
1796 \begin_layout Description
1797 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1800 \begin_layout Description
1801 Syntax dialog-toggle <NAME> [<DATA>]
1804 \begin_layout Description
1805 Params See LFUN_DIALOG_SHOW .
1808 \begin_layout Description
1809 Origin JSpitzm, 30 Apr 2007
1812 \begin_layout Subsection*
1816 \begin_layout Description
1817 Action Updates the dialog values from the inset/paragraph/document.
1820 \begin_layout Description
1821 Syntax dialog-update <NAME>
1824 \begin_layout Description
1825 Params <NAME>: paragraph|prefs|<INSET>
1826 \begin_inset Newline newline
1832 \begin_layout Description
1833 Origin leeming, 25 Feb 2003
1836 \begin_layout Subsection*
1840 \begin_layout Description
1841 Action Moves the cursor one line in downward direction.
1844 \begin_layout Description
1848 \begin_layout Subsection*
1852 \begin_layout Description
1853 Action Moves the cursor one line in downward direction adding the current position to the selection.
1856 \begin_layout Description
1860 \begin_layout Subsection*
1864 \begin_layout Description
1865 Action Inserts an ERT inset.
1868 \begin_layout Description
1872 \begin_layout Description
1873 Origin Jug, 18 Feb 2000
1876 \begin_layout Subsection*
1880 \begin_layout Description
1881 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1884 \begin_layout Description
1888 \begin_layout Description
1889 Origin Lgb, 17 May 2001
1892 \begin_layout Subsection*
1896 \begin_layout Description
1897 Action Inserts another LyX file.
1900 \begin_layout Description
1901 Syntax file-insert [<FILE>]
1904 \begin_layout Description
1905 Params <FILE>: Filename to be inserted.
1908 \begin_layout Subsection*
1909 file-insert-plaintext
1912 \begin_layout Description
1913 Action Inserts plain text file.
1916 \begin_layout Description
1917 Syntax file-insert-plaintext [<FILE>]
1920 \begin_layout Description
1921 Params <FILE>: Filename to be inserted.
1924 \begin_layout Description
1925 Origin CFO-G, 19 Nov 1997
1928 \begin_layout Subsection*
1929 file-insert-plaintext-para
1932 \begin_layout Description
1933 Action Inserts plain text file as paragraph (i.e. join lines).
1936 \begin_layout Description
1937 Syntax file-insert-plaintext-para [<FILE>]
1940 \begin_layout Description
1941 Params <FILE>: Filename to be inserted.
1944 \begin_layout Description
1945 Origin Levon, 14 Feb 2001
1948 \begin_layout Subsection*
1952 \begin_layout Description
1953 Action Inserts CharStyle, Custom inset or XML short element.
1956 \begin_layout Description
1957 Notion Look into the Customization manual for more information about these elements.
1958 \begin_inset Newline newline
1961 To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself.
1962 \begin_inset Newline newline
1965 For dissolving the element see LFUN_INSET_DISSOLVE.
1968 \begin_layout Description
1969 Syntax flex-insert Name
1972 \begin_layout Description
1973 Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout <Flex:Name>. The Flex: prefix is optional.
1976 \begin_layout Description
1977 Sample flex-insert Code
1980 \begin_layout Subsection*
1984 \begin_layout Description
1985 Action Inserts a float inset.
1988 \begin_layout Description
1989 Syntax float-insert <TYPE>
1992 \begin_layout Description
1993 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1996 \begin_layout Description
1997 Origin Lgb, 27 Jun 2000
2000 \begin_layout Subsection*
2004 \begin_layout Description
2005 Action Inserts the list of floats in the document.
2008 \begin_layout Description
2009 Syntax float-list-insert <TYPE>
2012 \begin_layout Description
2013 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2016 \begin_layout Description
2017 Origin Lgb, 3 May 2001
2020 \begin_layout Subsection*
2024 \begin_layout Description
2025 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2028 \begin_layout Description
2029 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2032 \begin_layout Description
2033 Syntax float-wide-insert <TYPE>
2036 \begin_layout Description
2037 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2040 \begin_layout Description
2041 Origin Lgb, 31 Oct 2001
2044 \begin_layout Subsection*
2048 \begin_layout Description
2049 Action Inserts a footnote inset.
2052 \begin_layout Description
2053 Syntax footnote-insert
2056 \begin_layout Description
2057 Origin Jug, 7 Mar 2000
2060 \begin_layout Subsection*
2064 \begin_layout Description
2065 Action Reloads the image if necessary.
2068 \begin_layout Description
2069 Syntax graphics-reload
2072 \begin_layout Description
2073 Origin vfr, 10 Aug 2009
2076 \begin_layout Subsection*
2080 \begin_layout Description
2081 Action Inserts hyperlinks into the document (clickable in pdf output).
2084 \begin_layout Description
2085 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2088 \begin_layout Description
2089 Syntax href-insert [<TARGET>]
2092 \begin_layout Description
2093 Origin CFO-G, 21 Nov 1997
2096 \begin_layout Subsection*
2100 \begin_layout Description
2101 Action Only active in IPA inset.
2104 \begin_layout Description
2105 Notion Dummy function which is only active in a IPA inset. It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
2108 \begin_layout Description
2112 \begin_layout Description
2113 Origin spitz, 20 May 2012
2116 \begin_layout Subsection*
2120 \begin_layout Description
2121 Action Inserts Index entry.
2124 \begin_layout Description
2125 Notion It automatically takes the word on the cursor position.
2128 \begin_layout Description
2129 Syntax index-insert [<TYPE:Name>]
2132 \begin_layout Description
2133 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2136 \begin_layout Description
2137 Origin leeming, 3 Aug 2000
2140 \begin_layout Subsection*
2144 \begin_layout Description
2145 Action Inserts list of Index entries on a new page.
2148 \begin_layout Description
2149 Syntax index-print [<TYPE:Name>]
2152 \begin_layout Description
2153 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2156 \begin_layout Description
2157 Origin Lgb, 27 Feb 1997
2160 \begin_layout Subsection*
2164 \begin_layout Description
2165 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2168 \begin_layout Description
2169 Notion Apart from lfun arguments you can use the following method:
2170 \begin_inset Newline newline
2173 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2174 \begin_inset Newline newline
2177 2. select the text and run info-insert lfun.
2180 \begin_layout Description
2181 Syntax info-insert <TYPE> <ARG>
2184 \begin_layout Description
2185 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
2186 \begin_inset Newline newline
2189 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2190 \begin_inset Newline newline
2193 shortcut[s]: name of lfun (e.g math-insert
2196 \begin_inset Newline newline
2199 lyxrc: name of rc_entry (e.g. bind_file)
2200 \begin_inset Newline newline
2203 lyxinfo: "version" - used version of LyX
2204 \begin_inset Newline newline
2207 package: name of latex package (e.g. listings)
2208 \begin_inset Newline newline
2211 textclass: name of textclass (e.g. article)
2212 \begin_inset Newline newline
2215 menu: name of lfun used in menu
2216 \begin_inset Newline newline
2219 icon: icon of lfun used in toolbar or direct icon name
2220 \begin_inset Newline newline
2223 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
2226 \begin_layout Description
2227 Sample command-sequence info-insert buffer path; info-insert buffer name
2230 \begin_layout Description
2231 Origin bpeng, 7 Oct 2007
2234 \begin_layout Subsection*
2238 \begin_layout Description
2239 Action Apply data for an inset.
2242 \begin_layout Description
2243 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied. This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called.
2246 \begin_layout Description
2247 Syntax inset-apply <ARGS>
2250 \begin_layout Description
2251 Params See LFUN_INSET_INSERT .
2254 \begin_layout Subsection*
2258 \begin_layout Description
2259 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise
2262 \begin_layout Description
2266 \begin_layout Description
2267 Origin lasgouttes, 16 Mar 2009
2270 \begin_layout Subsection*
2274 \begin_layout Description
2275 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection).
2278 \begin_layout Description
2279 Syntax inset-begin-select
2282 \begin_layout Description
2283 Origin lasgouttes, 16 Mar 2009
2286 \begin_layout Subsection*
2290 \begin_layout Description
2291 Action Copies the inset to the clipboard as a certain type.
2294 \begin_layout Description
2295 Notion Currently used only for InsetInfo where its content is copied as a text.
2298 \begin_layout Description
2299 Syntax inset-copy-as
2302 \begin_layout Description
2303 Origin vfr, 18 Apr 2010
2306 \begin_layout Subsection*
2310 \begin_layout Description
2311 Action Dissolve the current inset into text.
2314 \begin_layout Description
2315 Syntax inset-dissolve [<INSET>]
2318 \begin_layout Description
2319 Params <INSET>: this can be used to make sure the right kind of inset is dissolved. For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type.
2320 \begin_inset Newline newline
2323 For values see lyx::InsetLayout::lyxtype_ .
2326 \begin_layout Description
2327 Origin JSpitz, 7 Aug 2006
2330 \begin_layout Subsection*
2334 \begin_layout Description
2335 Action Edit the inset at cursor with an external application, if one is attributed.
2338 \begin_layout Description
2339 Syntax inset-edit [<INSET_PARAMS>]
2342 \begin_layout Description
2343 Params <INSET_PARAMS>: Parameters for the inset.
2344 \begin_inset Newline newline
2347 Currently only the filename will be considered.
2350 \begin_layout Description
2351 Origin JSpitzm, 27 Apr 2006
2354 \begin_layout Subsection*
2358 \begin_layout Description
2359 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise
2362 \begin_layout Description
2366 \begin_layout Description
2367 Origin lasgouttes, 16 Mar 2009
2370 \begin_layout Subsection*
2374 \begin_layout Description
2375 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection).
2378 \begin_layout Description
2379 Syntax inset-end-select
2382 \begin_layout Description
2383 Origin lasgouttes, 16 Mar 2009
2386 \begin_layout Subsection*
2390 \begin_layout Description
2391 Action Apply the given commands on insets of a given name.
2394 \begin_layout Description
2395 Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 100000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed.
2398 \begin_layout Description
2399 Syntax inset-forall <NAME> <LFUN-COMMAND>
2400 \begin_inset Newline newline
2403 <NAME>: Type of Inset. If <NAME> is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets.
2406 \begin_layout Description
2407 Sample Remove all index insets:
2408 \begin_inset Newline newline
2411 inset-forall Index char-delete-forward
2412 \begin_inset Newline newline
2415 Close all Notes (also works for a particular branch, for example):
2416 \begin_inset Newline newline
2419 inset-forall Note inset-toggle close
2420 \begin_inset Newline newline
2423 Transform all yellow notes to comments
2424 \begin_inset Newline newline
2427 inset-forall Note:Note inset-modify note Note Comment
2428 \begin_inset Newline newline
2431 Try to put LyX in an infinite loop if there is at least a Note:
2432 \begin_inset Newline newline
2435 inset-forall Note char-backward
2438 \begin_layout Description
2439 Origin lasgouttes, 27 Nov 2009
2442 \begin_layout Subsection*
2446 \begin_layout Description
2447 Action Insert new inset (type given by the parameters).
2450 \begin_layout Description
2451 Syntax inset-insert <INSET> <ARGS>
2454 \begin_layout Description
2455 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2456 \begin_inset Newline newline
2459 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2460 \begin_inset Newline newline
2463 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2466 \begin_layout Description
2467 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2470 \begin_inset Newline newline
2473 where <label name> is the name of the referenced label and <Format> is one of the following:
2474 \begin_inset Newline newline
2478 \begin_inset Newline newline
2481 eqref -- (<reference>)
2482 \begin_inset Newline newline
2486 \begin_inset Newline newline
2489 vpageref -- on <page>
2490 \begin_inset Newline newline
2493 vref -- <reference> on <page>
2494 \begin_inset Newline newline
2497 formatted -- Formatted reference
2500 \begin_layout Subsection*
2504 \begin_layout Description
2505 Action Modify some properties of an inset.
2508 \begin_layout Description
2509 Notion Used for 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.
2512 \begin_layout Description
2513 Syntax inset-modify <INSET> <ARGS>
2514 \begin_inset Newline newline
2517 inset-modify changetype <TYPE>
2520 \begin_layout Description
2521 Sample Change a Note inset into a Comment inset:
2522 \begin_inset Newline newline
2525 inset-modify note Note Comment
2526 \begin_inset Newline newline
2529 Change a Box into an Ovalbox:
2530 \begin_inset Newline newline
2533 inset-modify changetype Ovalbox
2534 \begin_inset Newline newline
2537 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
2538 \begin_inset Newline newline
2541 inset-modify changetype els
2542 \begin_inset Newline newline
2545 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
2546 \begin_inset Newline newline
2549 inset-modify changetype e..
2550 \begin_inset Newline newline
2556 \begin_layout Subsection*
2560 \begin_layout Description
2561 Action Select all contents of an inset.
2564 \begin_layout Description
2565 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2568 \begin_layout Description
2569 Syntax inset-select-all
2572 \begin_layout Description
2573 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2576 \begin_layout Subsection*
2580 \begin_layout Description
2581 Action Open the inset's properties dialog.
2584 \begin_layout Description
2585 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.
2588 \begin_layout Description
2589 Syntax inset-settings <INSET>
2592 \begin_layout Description
2593 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2594 \begin_inset Newline newline
2597 graphics|href|include|index|index_print|label|line|
2598 \begin_inset Newline newline
2601 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2604 \begin_layout Subsection*
2608 \begin_layout Description
2609 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2612 \begin_layout Description
2613 Syntax inset-toggle [<ARG>]
2616 \begin_layout Description
2617 Params <ARG>: <open|close|toggle|assign>.
2618 \begin_inset Newline newline
2621 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2622 \begin_inset Newline newline
2625 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2628 \begin_layout Description
2629 Origin lasgouttes, 19 Jul 2001
2632 \begin_layout Subsection*
2636 \begin_layout Description
2637 Action Inserts an IPA inset.
2640 \begin_layout Description
2644 \begin_layout Description
2645 Origin spitz, 05 Mar 2012
2648 \begin_layout Subsection*
2652 \begin_layout Description
2653 Action Inserts special IPA macros into the document.
2656 \begin_layout Description
2657 Syntax ipamacro-insert <CHAR>
2660 \begin_layout Description
2661 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2664 \begin_layout Description
2665 Origin JSpitzm, 22 Aug 2012
2668 \begin_layout Subsection*
2672 \begin_layout Description
2673 Action Turn off the loaded keyboard map.
2676 \begin_layout Description
2680 \begin_layout Subsection*
2684 \begin_layout Description
2685 Action Turn on the primary keyboard map.
2688 \begin_layout Description
2689 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.
2690 \begin_inset Newline newline
2693 The language is to be set in the Preferences dialog.
2696 \begin_layout Description
2697 Syntax keymap-primary
2700 \begin_layout Subsection*
2704 \begin_layout Description
2705 Action Turn on the secondary keyboard map.
2708 \begin_layout Description
2709 Syntax keymap-secondary
2712 \begin_layout Subsection*
2716 \begin_layout Description
2717 Action Toggles keyboard maps (first/second/off).
2720 \begin_layout Description
2721 Syntax keymap-toggle
2724 \begin_layout Description
2725 Origin leeming, 30 Mar 2004
2728 \begin_layout Subsection*
2729 label-copy-as-reference
2732 \begin_layout Description
2733 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2736 \begin_layout Description
2737 Syntax copy-label-as-reference <LABEL>
2740 \begin_layout Description
2741 Params <LABEL>: The label to copy (for multi-line math)
2744 \begin_layout Description
2745 Origin sts, 16 Nov 2008
2748 \begin_layout Subsection*
2752 \begin_layout Description
2753 Action Goto a label.
2756 \begin_layout Description
2757 Syntax label-goto [<LABEL>]
2760 \begin_layout Description
2761 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.
2764 \begin_layout Description
2765 Origin Ale, 6 Aug 1997
2768 \begin_layout Subsection*
2772 \begin_layout Description
2773 Action Inserts label to text or displayed formula.
2776 \begin_layout Description
2777 Syntax label-insert [<LABEL>]
2780 \begin_layout Description
2781 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2784 \begin_layout Subsection*
2785 label-insert-as-reference
2788 \begin_layout Description
2789 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2792 \begin_layout Description
2793 Syntax label-insert-as-reference
2796 \begin_layout Description
2797 Origin vfr, 7 Apr 2009
2800 \begin_layout Subsection*
2804 \begin_layout Description
2805 Action Set language from the current cursor position.
2808 \begin_layout Description
2809 Syntax language <LANG> [set]
2812 \begin_layout Description
2813 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).
2816 \begin_layout Description
2817 Origin Dekel, 2 Mar 2000
2820 \begin_layout Subsection*
2824 \begin_layout Description
2825 Action Move the cursor to the beginning of the (screen) line.
2828 \begin_layout Description
2832 \begin_layout Subsection*
2836 \begin_layout Description
2837 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2840 \begin_layout Description
2841 Syntax line-begin-select
2844 \begin_layout Subsection*
2848 \begin_layout Description
2849 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2852 \begin_layout Description
2853 Syntax line-delete-forward
2856 \begin_layout Subsection*
2860 \begin_layout Description
2861 Action Move the cursor to the end of the (screen) line.
2864 \begin_layout Description
2868 \begin_layout Subsection*
2872 \begin_layout Description
2873 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2876 \begin_layout Description
2877 Syntax line-end-select
2880 \begin_layout Subsection*
2884 \begin_layout Description
2885 Action Inserts a new listings inset.
2888 \begin_layout Description
2889 Syntax listing-insert
2892 \begin_layout Description
2893 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2896 \begin_layout Subsection*
2900 \begin_layout Description
2901 Action Inserts a marginal note.
2904 \begin_layout Description
2905 Syntax marginalnote-insert
2908 \begin_layout Description
2909 Origin Lgb, 26 Jun 2000
2912 \begin_layout Subsection*
2916 \begin_layout Description
2917 Action Disable selecting of text-region.
2920 \begin_layout Description
2924 \begin_layout Subsection*
2928 \begin_layout Description
2929 Action Enable selecting of text-region.
2932 \begin_layout Description
2933 Notion After enabling you can simply move arrow keys to get selected region.
2936 \begin_layout Description
2940 \begin_layout Subsection*
2944 \begin_layout Description
2945 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2948 \begin_layout Description
2952 \begin_layout Description
2953 Origin Andre, May 5 2006
2956 \begin_layout Subsection*
2960 \begin_layout Description
2961 Action Inserts a line break or new line.
2964 \begin_layout Description
2965 Syntax newline-insert [<ARG>]
2968 \begin_layout Description
2969 Params <ARG>: <newline|linebreak> default: newline
2972 \begin_layout Description
2973 Origin JSpitzm, 25 Mar 2008
2976 \begin_layout Subsection*
2980 \begin_layout Description
2981 Action Inserts a new page.
2984 \begin_layout Description
2985 Syntax newpage-insert <ARG>
2988 \begin_layout Description
2989 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2992 \begin_layout Description
2993 Origin uwestoehr, 24 Nov 2007
2996 \begin_layout Subsection*
3000 \begin_layout Description
3001 Action Inserts Nomenclature entry.
3004 \begin_layout Description
3005 Notion It automatically takes the word on the cursor position if no symbol is given.
3008 \begin_layout Description
3009 Syntax nomencl-insert [<SYMBOL>]
3012 \begin_layout Description
3013 Origin Ugras, 4 Nov 2006
3016 \begin_layout Subsection*
3020 \begin_layout Description
3021 Action Inserts list of Nomenclature entries.
3024 \begin_layout Description
3025 Syntax nomenclature-print
3028 \begin_layout Description
3029 Origin Ugras, 4 Nov 2006
3032 \begin_layout Subsection*
3036 \begin_layout Description
3037 Action Inserts Note on the current cursor position, move selection inside the inset.
3040 \begin_layout Description
3041 Syntax note-insert [<TYPE>]
3044 \begin_layout Description
3045 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3048 \begin_layout Subsection*
3052 \begin_layout Description
3053 Action Moves the cursor to the beginning of next Note inset.
3056 \begin_layout Description
3060 \begin_layout Subsection*
3064 \begin_layout Description
3065 Action Move the current group in the downward direction in the structure of the document.
3068 \begin_layout Description
3069 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3072 \begin_layout Description
3076 \begin_layout Description
3077 Origin Vermeer, 23 Mar 2006
3080 \begin_layout Subsection*
3084 \begin_layout Description
3085 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3088 \begin_layout Description
3089 Notion Part -> Chapter -> Section -> etc.
3092 \begin_layout Description
3096 \begin_layout Description
3097 Origin Vermeer, 23 Mar 2006
3100 \begin_layout Subsection*
3104 \begin_layout Description
3105 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3108 \begin_layout Description
3109 Notion Part <- Chapter <- Section <- etc.
3112 \begin_layout Description
3116 \begin_layout Description
3117 Origin Vermeer, 23 Mar 2006
3120 \begin_layout Subsection*
3124 \begin_layout Description
3125 Action Move the current group in the upward direction in the structure of the document.
3128 \begin_layout Description
3129 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3132 \begin_layout Description
3136 \begin_layout Description
3137 Origin Vermeer, 23 Mar 2006
3140 \begin_layout Subsection*
3144 \begin_layout Description
3145 Action Breaks the current paragraph at the current location.
3148 \begin_layout Description
3149 Notion Removes the selection.
3152 \begin_layout Description
3153 Syntax paragraph-break [<LAYOUT>]
3156 \begin_layout Description
3157 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3160 \begin_layout Subsection*
3164 \begin_layout Description
3165 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3168 \begin_layout Description
3169 Syntax paragraph-down
3172 \begin_layout Description
3173 Origin Asger, 1 Oct 1996
3176 \begin_layout Subsection*
3177 paragraph-down-select
3180 \begin_layout Description
3181 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3184 \begin_layout Description
3185 Syntax paragraph-down-select
3188 \begin_layout Description
3189 Origin Asger, 1 Oct 1996
3192 \begin_layout Subsection*
3196 \begin_layout Description
3197 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.
3200 \begin_layout Description
3201 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.
3204 \begin_layout Description
3205 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3208 \begin_layout Description
3209 Params <PAR_ID>: paragraph id
3210 \begin_inset Newline newline
3213 <POS_IN_PAR>: desired position within the paragraph
3216 \begin_layout Description
3217 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3220 \begin_layout Subsection*
3224 \begin_layout Description
3225 Action Moves the current paragraph downwards in the document.
3228 \begin_layout Description
3229 Syntax paragraph-move-down
3232 \begin_layout Description
3233 Origin Edwin, 8 Apr 2006
3236 \begin_layout Subsection*
3240 \begin_layout Description
3241 Action Moves the current paragraph upwards in the document.
3244 \begin_layout Description
3245 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3248 \begin_layout Description
3249 Syntax paragraph-move-up
3252 \begin_layout Description
3253 Origin Edwin, 8 Apr 2006
3256 \begin_layout Subsection*
3260 \begin_layout Description
3261 Action Change paragraph settings.
3264 \begin_layout Description
3265 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.
3268 \begin_layout Description
3269 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3272 \begin_layout Description
3282 \begin_inset Newline newline
3287 paragraph_spacing default|single|onehalf|double|other SIZE
3288 \begin_inset Newline newline
3293 align block|left|right|center|default
3294 \begin_inset Newline newline
3299 labelwidthstring WIDTH|
3304 \begin_layout Description
3305 Origin rgh, Aug 15 2007
3308 \begin_layout Subsection*
3309 paragraph-params-apply
3312 \begin_layout Description
3313 Action Change paragraph settings.
3316 \begin_layout Description
3317 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3320 \begin_layout Description
3321 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3324 \begin_layout Description
3325 Params For parameters see LFUN_PARAGRAPH_PARAMS
3328 \begin_layout Description
3329 Origin leeming, 30 Mar 2004
3332 \begin_layout Subsection*
3336 \begin_layout Description
3337 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3340 \begin_layout Description
3344 \begin_layout Description
3345 Origin Asger, 1 Oct 1996
3348 \begin_layout Subsection*
3352 \begin_layout Description
3353 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3356 \begin_layout Description
3357 Syntax paragraph-up-select
3360 \begin_layout Description
3361 Origin Asger, 1 Oct 1996
3364 \begin_layout Subsection*
3368 \begin_layout Description
3369 Action Pastes material (text or picture) from the active clipboard.
3372 \begin_layout Description
3373 Syntax paste [<TYPE>|<NUM>]
3376 \begin_layout Description
3377 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3378 \begin_inset Newline newline
3381 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3384 \begin_layout Subsection*
3388 \begin_layout Description
3389 Action Inserts phantom on the current cursor position, move selection inside the inset.
3392 \begin_layout Description
3393 Syntax phantom-insert [<TYPE>]
3396 \begin_layout Description
3397 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3400 \begin_layout Description
3401 Origin uwestoehr, 30 Jan 2009
3404 \begin_layout Subsection*
3408 \begin_layout Description
3409 Action Inserts a new preview inset.
3412 \begin_layout Description
3413 Syntax preview-insert
3416 \begin_layout Description
3417 Origin vfr, 28 Mar 2010
3420 \begin_layout Subsection*
3421 primary-selection-paste
3424 \begin_layout Description
3425 Action Pastes the currently selected text.
3428 \begin_layout Description
3429 Notion Primary selection mechanism is linux-only thing.
3432 \begin_layout Description
3433 Syntax primary-selection-paste [<ARG>]
3436 \begin_layout Description
3437 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3440 \begin_layout Subsection*
3444 \begin_layout Description
3445 Action Inserts quotes according to the type and quote-language preference.
3448 \begin_layout Description
3449 Notion Currently 15 different quote styles are distinguished (see params).
3452 \begin_layout Description
3453 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3456 \begin_layout Description
3457 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
3458 \begin_inset Newline newline
3461 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
3462 \begin_inset Newline newline
3465 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3466 \begin_inset Newline newline
3469 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3470 \begin_inset Newline newline
3473 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3474 \begin_inset Newline newline
3477 'danish' for >>Danish<< quote style (with >inner quotation<)
3478 \begin_inset Newline newline
3481 'english' for ``English'' quote style (with `inner quotation')
3482 \begin_inset Newline newline
3485 'french' for <<french>> quote style (with ``inner quotation'')
3486 \begin_inset Newline newline
3489 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
3490 \begin_inset Newline newline
3493 'german' for ,,German`` quote style (with ,inner quotation`)
3494 \begin_inset Newline newline
3497 'plain' for "Plain" quote style (with 'inner quotation')
3498 \begin_inset Newline newline
3501 'polish' for ,,Polish'' quote style (with ,inner quotation')
3502 \begin_inset Newline newline
3505 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3506 \begin_inset Newline newline
3509 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
3510 \begin_inset Newline newline
3513 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3514 \begin_inset Newline newline
3517 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3518 \begin_inset Newline newline
3521 'dynamic' for Dynamic quotation marks which inherit the global document style
3522 \begin_inset Newline newline
3525 If no quote style is specified, the document-wide will be used.
3528 \begin_layout Subsection*
3532 \begin_layout Description
3533 Action Redoes the last thing undone.
3536 \begin_layout Description
3540 \begin_layout Subsection*
3544 \begin_layout Description
3545 Action Go to the next label or cross-reference.
3548 \begin_layout Description
3549 Syntax reference-next
3552 \begin_layout Description
3553 Origin Dekel, 14 Jan 2001
3556 \begin_layout Subsection*
3560 \begin_layout Description
3561 Action Repeat the given command.
3564 \begin_layout Description
3565 Syntax repeat <COUNT> <LFUN-COMMAND>
3568 \begin_layout Description
3569 Origin Andre, 27 Oct 2003
3572 \begin_layout Subsection*
3576 \begin_layout Description
3577 Action Moves the cursor one page in downward direction.
3580 \begin_layout Description
3584 \begin_layout Subsection*
3588 \begin_layout Description
3589 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3592 \begin_layout Description
3593 Syntax screen-down-select
3596 \begin_layout Subsection*
3600 \begin_layout Description
3601 Action Recenters the screen on the current cursor position.
3604 \begin_layout Description
3605 Syntax screen-recenter
3608 \begin_layout Subsection*
3612 \begin_layout Description
3613 Action Repositions the screen such that the cursor is visible.
3616 \begin_layout Description
3617 Syntax screen-show-cursor
3620 \begin_layout Description
3621 Origin vfr, 25 Mar 2009
3624 \begin_layout Subsection*
3628 \begin_layout Description
3629 Action Moves the cursor one page in upward direction.
3632 \begin_layout Description
3636 \begin_layout Subsection*
3640 \begin_layout Description
3641 Action Moves the cursor one page in upward direction adding the current position to the selection.
3644 \begin_layout Description
3645 Syntax screen-up-select
3648 \begin_layout Subsection*
3652 \begin_layout Description
3653 Action Inserts a subscript or superscript inset.
3656 \begin_layout Description
3657 Syntax script-insert <TYPE>
3660 \begin_layout Description
3661 Params <TYPE>: subscript|superscript
3664 \begin_layout Description
3665 Origin Georg, 23 Nov 2010
3668 \begin_layout Subsection*
3672 \begin_layout Description
3673 Action Scroll the buffer view.
3676 \begin_layout Description
3677 Notion Only scrolls the screen up or down; does not move the cursor.
3680 \begin_layout Description
3681 Syntax scroll <TYPE> <QUANTITY>
3684 \begin_layout Description
3685 Params <TYPE>: line|page
3686 \begin_inset Newline newline
3689 <QUANTITY>: up|down|<number>
3692 \begin_layout Description
3693 Origin Abdel, Dec 27 2007
3696 \begin_layout Subsection*
3700 \begin_layout Description
3701 Action Select the whole section.
3704 \begin_layout Description
3705 Notion The cursor should be in a section heading before calling this lfun.
3708 \begin_layout Description
3709 Syntax section-select
3712 \begin_layout Description
3713 Origin vfr, 05 May 2009
3716 \begin_layout Subsection*
3720 \begin_layout Description
3721 Action Pastes the internal selection text in permanent selection.
3724 \begin_layout Description
3725 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3728 \begin_layout Description
3729 Syntax selection-paste
3732 \begin_layout Description
3733 Origin lasgouttes, 14 Jan 2009
3736 \begin_layout Subsection*
3740 \begin_layout Description
3741 Action Inserts an environment separator or latex paragraph break.
3744 \begin_layout Description
3745 Syntax separator-insert [<ARG>]
3748 \begin_layout Description
3749 Params <ARG>: <plain|parbreak|latexpar> default: plain
3752 \begin_layout Description
3753 Origin ef, 2 May 2014
3756 \begin_layout Subsection*
3760 \begin_layout Description
3761 Action Set the group for the graphics inset on the cursor position.
3764 \begin_layout Description
3765 Syntax set-graphics-group [<GROUP>]
3768 \begin_layout Description
3769 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3772 \begin_layout Description
3773 Origin sanda, 6 May 2008
3776 \begin_layout Subsection*
3780 \begin_layout Description
3781 Action Inserts one of horizontal space insets.
3784 \begin_layout Description
3785 Syntax space-insert <NAME> [<LEN>]
3788 \begin_layout Description
3789 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3790 \begin_inset Newline newline
3793 Only in math mode: med and thick.
3794 \begin_inset Newline newline
3797 <LEN>: length for custom spaces (hspace, hspace* for protected)
3800 \begin_layout Description
3801 Origin JSpitzm, 20 May 2003, Mar 17 2008
3804 \begin_layout Subsection*
3808 \begin_layout Description
3809 Action Inserts various characters into the document.
3812 \begin_layout Description
3813 Syntax specialchar-insert <CHAR>
3816 \begin_layout Description
3817 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3820 \begin_layout Description
3821 Origin JSpitzm, 6 Dec 2007
3824 \begin_layout Subsection*
3828 \begin_layout Description
3829 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3832 \begin_layout Description
3833 Syntax spelling-add [<STRING>] [<LANG>]
3836 \begin_layout Description
3837 Params <WORD>: word to add <LANG>: language name (see file languages)
3840 \begin_layout Description
3841 Origin JSpitzm, 18 Jan 2010
3844 \begin_layout Subsection*
3845 spelling-continuously
3848 \begin_layout Description
3849 Action Toggle continuous spell checking.
3852 \begin_layout Description
3853 Syntax spelling-continuously
3856 \begin_layout Description
3857 Origin vfr, 24 March 2013
3860 \begin_layout Subsection*
3864 \begin_layout Description
3865 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.
3868 \begin_layout Description
3869 Syntax spelling-ignore [<WORD>] [<LANG>]
3872 \begin_layout Description
3873 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3876 \begin_layout Description
3877 Origin JSpitzm, 18 Jan 2010
3880 \begin_layout Subsection*
3884 \begin_layout Description
3885 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
3888 \begin_layout Description
3889 Syntax spelling-remove [<STRING>] [<LANG>]
3892 \begin_layout Description
3893 Params <WORD>: word to remove <LANG>: language name (see file languages)
3896 \begin_layout Description
3897 Origin SWitt, 28 July 2010
3900 \begin_layout Subsection*
3904 \begin_layout Description
3905 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3908 \begin_layout Description
3909 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.
3912 \begin_layout Description
3916 \begin_layout Description
3917 Origin vfr, Sep 30 2008
3920 \begin_layout Subsection*
3924 \begin_layout Description
3925 Action Insert a tab into a listings inset.
3928 \begin_layout Description
3929 Notion It also works on a selection.
3932 \begin_layout Description
3936 \begin_layout Description
3937 Origin vfr, Sep 30 2008
3940 \begin_layout Subsection*
3944 \begin_layout Description
3945 Action Modify properties of tabulars and table-like math environments.
3948 \begin_layout Description
3949 Syntax tabular-feature <FEATURE> [<ARG>]
3952 \begin_layout Description
3953 Params Generally see LFUN_INSET_INSERT for further details.
3954 \begin_inset Newline newline
3957 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
3958 \begin_inset Newline newline
3961 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
3962 \begin_inset Newline newline
3965 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3966 \begin_inset Newline newline
3969 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
3970 \begin_inset Newline newline
3973 valign-top|valign-bottom|valign-middle|longtabular-align-left|
3974 \begin_inset Newline newline
3977 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
3978 \begin_inset Newline newline
3981 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
3982 \begin_inset Newline newline
3985 set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
3986 \begin_inset Newline newline
3989 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
3990 \begin_inset Newline newline
3993 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
3994 \begin_inset Newline newline
3997 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
3998 \begin_inset Newline newline
4001 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4002 \begin_inset Newline newline
4005 set-special-column|set-special-multicolumn|set-special-multirow|
4006 \begin_inset Newline newline
4009 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4010 \begin_inset Newline newline
4013 set-interline-space|set-border-lines|tabular-valign-top|
4014 \begin_inset Newline newline
4017 tabular-valign-middle|tabular-valign-bottom|set-tabular-width
4018 \begin_inset Newline newline
4021 Various math-environment features are handled as well, e.g. add-vline-left/right for
4022 \begin_inset Newline newline
4025 the Grid/Array environment.
4026 \begin_inset Newline newline
4029 <ARG>: additional argument for some commands, use debug mode to explore its values.
4032 \begin_layout Description
4033 Origin gm, 10 Dec 2015
4036 \begin_layout Subsection*
4040 \begin_layout Description
4041 Action Inserts table into the document.
4044 \begin_layout Description
4045 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4048 \begin_layout Description
4049 Syntax tabular-insert [<ROWS> <COLUMNS>]
4052 \begin_layout Description
4053 Params In case no arguments are given show insert dialog.
4056 \begin_layout Description
4057 Origin Jug, 12 Apr 2000
4060 \begin_layout Subsection*
4064 \begin_layout Description
4065 Action Look up thesaurus entries with respect to the word under the cursor.
4068 \begin_layout Description
4069 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4072 \begin_layout Description
4073 Params <STRING>: word to look up <LANG>: language (see file languages)
4076 \begin_layout Description
4077 Origin Levon, 20 Jul 2001
4080 \begin_layout Subsection*
4084 \begin_layout Description
4085 Action Undoes the last edit.
4088 \begin_layout Description
4092 \begin_layout Subsection*
4096 \begin_layout Description
4097 Action Inserts a single unicode character.
4100 \begin_layout Description
4101 Syntax unicode-insert <CHAR>
4104 \begin_layout Description
4105 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
4108 \begin_layout Description
4109 Sample unicode-insert 0x0100
4112 \begin_layout Description
4113 Origin Lgb, 22 Oct 2006
4116 \begin_layout Subsection*
4120 \begin_layout Description
4121 Action Moves the cursor one line in upward direction.
4124 \begin_layout Description
4128 \begin_layout Subsection*
4132 \begin_layout Description
4133 Action Moves the cursor one line in upward direction adding the current position to the selection.
4136 \begin_layout Description
4140 \begin_layout Subsection*
4144 \begin_layout Description
4145 Action Moves the cursor to the logically previous beginning of a word.
4148 \begin_layout Description
4149 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.
4152 \begin_layout Description
4153 Syntax word-backward
4156 \begin_layout Subsection*
4157 word-backward-select
4160 \begin_layout Description
4161 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4164 \begin_layout Description
4165 Notion See also LFUN_WORD_BACKWARD.
4168 \begin_layout Description
4169 Syntax word-backward-select
4172 \begin_layout Subsection*
4176 \begin_layout Description
4177 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4180 \begin_layout Description
4181 Syntax word-capitalize [<SEL_TYPE>]
4184 \begin_layout Description
4185 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.
4188 \begin_layout Subsection*
4189 word-delete-backward
4192 \begin_layout Description
4193 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4196 \begin_layout Description
4197 Syntax word-delete-backward
4200 \begin_layout Subsection*
4204 \begin_layout Description
4205 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4208 \begin_layout Description
4209 Syntax word-delete-forward
4212 \begin_layout Subsection*
4216 \begin_layout Description
4217 Action Search for next occurrence of a string.
4220 \begin_layout Description
4221 Syntax word-find [<DATA>]
4224 \begin_layout Description
4225 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).
4228 \begin_layout Description
4229 Origin Andre, Jan 7 2004
4232 \begin_layout Subsection*
4236 \begin_layout Description
4237 Action Search for a given string in backward direction.
4240 \begin_layout Description
4241 Notion Case sensitive, match words. If no argument given, last search repeated.
4244 \begin_layout Description
4245 Syntax word-find-backward [<STRING>]
4248 \begin_layout Description
4249 Origin Etienne, 20 Feb 1998
4252 \begin_layout Subsection*
4256 \begin_layout Description
4257 Action Search for a given string in forward direction.
4260 \begin_layout Description
4261 Notion Case sensitive, match words. If no argument given, last search repeated.
4264 \begin_layout Description
4265 Syntax word-find-forward [<STRING>]
4268 \begin_layout Description
4269 Origin Etienne, 16 Feb 1998
4272 \begin_layout Subsection*
4276 \begin_layout Description
4277 Action Search for next occurrence of a pattern.
4280 \begin_layout Description
4281 Syntax word-findadv [<DATA>]
4284 \begin_layout Description
4285 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).
4288 \begin_layout Description
4289 Origin Tommaso, Nov 15 2007
4292 \begin_layout Subsection*
4296 \begin_layout Description
4297 Action Moves the cursor to the logically next beginning of a word.
4300 \begin_layout Description
4301 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.
4304 \begin_layout Description
4308 \begin_layout Subsection*
4312 \begin_layout Description
4313 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4316 \begin_layout Description
4317 Notion See also LFUN_WORD_FORWARD.
4320 \begin_layout Description
4321 Syntax word-forward-select
4324 \begin_layout Subsection*
4328 \begin_layout Description
4329 Action Moves the cursor to the next beginning of a word "on the left".
4332 \begin_layout Description
4333 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.
4336 \begin_layout Description
4340 \begin_layout Description
4341 Origin dov, 28 Oct 2007
4344 \begin_layout Subsection*
4348 \begin_layout Description
4349 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4352 \begin_layout Description
4353 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4356 \begin_layout Description
4357 Syntax word-left-select
4360 \begin_layout Description
4361 Origin dov, 28 Oct 2007
4364 \begin_layout Subsection*
4368 \begin_layout Description
4369 Action Change the words in the selection or word at cursor position to lower case.
4372 \begin_layout Description
4373 Syntax word-lowcase [<SEL_TYPE>]
4376 \begin_layout Description
4377 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.
4380 \begin_layout Subsection*
4384 \begin_layout Description
4385 Action Replace a string in the document.
4388 \begin_layout Description
4389 Syntax word-replace [<DATA>]
4392 \begin_layout Description
4393 Params <DATA>: data is of the form "<replace>
4394 \begin_inset Newline newline
4398 \begin_inset Newline newline
4401 <casesensitive> <matchword> <all> <forward> <findnext>"
4404 \begin_layout Description
4405 Origin Andre, Jan 7 2004
4408 \begin_layout Subsection*
4412 \begin_layout Description
4413 Action Moves the cursor to the next beginning of a word "on the right".
4416 \begin_layout Description
4417 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.
4420 \begin_layout Description
4424 \begin_layout Description
4425 Origin dov, 28 Oct 2007
4428 \begin_layout Subsection*
4432 \begin_layout Description
4433 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4436 \begin_layout Description
4437 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4440 \begin_layout Description
4441 Syntax word-right-select
4444 \begin_layout Description
4445 Origin dov, 28 Oct 2007
4448 \begin_layout Subsection*
4452 \begin_layout Description
4453 Action Puts the word where the cursor stands into the selection.
4456 \begin_layout Description
4460 \begin_layout Description
4461 Origin Andre, 11 Sep 2002
4464 \begin_layout Subsection*
4468 \begin_layout Description
4469 Action Change the words in the selection or word at cursor position to upper case.
4472 \begin_layout Description
4473 Syntax word-upcase [<SEL_TYPE>]
4476 \begin_layout Description
4477 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.
4480 \begin_layout Subsection*
4484 \begin_layout Description
4485 Action Inserts floats wrapped by the text around.
4488 \begin_layout Description
4489 Syntax wrap-insert <TYPE>
4492 \begin_layout Description
4493 Params <TYPE>: table|figure
4496 \begin_layout Description
4497 Origin Dekel, 7 Apr 2002
4500 \begin_layout Section
4501 Math Editor Functions
4504 \begin_layout Subsection*
4505 in-mathmacrotemplate
4508 \begin_layout Description
4509 Action Only active in Math Macro definition.
4512 \begin_layout Description
4513 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.
4516 \begin_layout Description
4517 Syntax in-mathmacrotemplate
4520 \begin_layout Description
4521 Origin sts, 06 January 2008
4524 \begin_layout Subsection*
4528 \begin_layout Description
4529 Action Inserts an extended matrix as provided by the amsmath package.
4532 \begin_layout Description
4533 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4536 \begin_layout Description
4537 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'.
4540 \begin_layout Description
4541 Sample math-ams-matrix 3 3 bmatrix
4544 \begin_layout Subsection*
4548 \begin_layout Description
4549 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4552 \begin_layout Description
4553 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4556 \begin_layout Description
4557 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4558 \begin_inset Newline newline
4561 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4564 \begin_layout Description
4565 Sample math-bigdelim "Bigl" "
4572 \begin_layout Description
4573 Origin Enrico & Georg, 7 May 2006
4576 \begin_layout Subsection*
4580 \begin_layout Description
4581 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4584 \begin_layout Description
4585 Syntax math-delim [<LEFT>] [<RIGHT>]
4588 \begin_layout Description
4589 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.
4592 \begin_layout Description
4593 Sample math-delim { rangle
4596 \begin_layout Description
4597 Origin Alejandro, 18 Jun 1996
4600 \begin_layout Subsection*
4604 \begin_layout Description
4605 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4608 \begin_layout Description
4609 Syntax math-display [<ARG>]
4612 \begin_layout Description
4613 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4616 \begin_layout Description
4617 Origin Alejandro, 18 Jun 1996
4620 \begin_layout Subsection*
4624 \begin_layout Description
4625 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4628 \begin_layout Description
4629 Notion Selection can be used to determine the input for the external program.
4632 \begin_layout Description
4633 Syntax math-extern <LANG> [<COMMAND>]
4636 \begin_layout Description
4637 Params <LANG>: octave|maxima|maple|mathematica|script
4638 \begin_inset Newline newline
4641 where "script" stands for the external script (normalized expression will be passed)
4644 \begin_layout Description
4645 Sample math-extern maple simplify
4648 \begin_layout Description
4649 Origin Andre, 24 Apr 2001
4652 \begin_layout Subsection*
4656 \begin_layout Description
4657 Action Changes the text style used in math.
4660 \begin_layout Description
4661 Syntax math-font-style <STYLE>
4664 \begin_layout Description
4665 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4666 \begin_inset Newline newline
4669 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4672 \begin_layout Description
4673 Origin vfr, 9 jan 2009
4676 \begin_layout Subsection*
4680 \begin_layout Description
4681 Action Inserts math objects and symbols.
4684 \begin_layout Description
4685 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4687 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
4689 frac{x}{y}" replaces "abc" with "
4691 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.
4694 \begin_layout Description
4695 Syntax math-insert <ARG>
4698 \begin_layout Description
4699 Params <ARG>: Symbol or LaTeX code to be inserted.
4702 \begin_layout Subsection*
4706 \begin_layout Description
4707 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.
4710 \begin_layout Description
4711 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4714 \begin_layout Description
4715 Syntax math-limits [<STATE>]
4718 \begin_layout Description
4719 Params <STATE>: limits|nolimits
4722 \begin_layout Subsection*
4726 \begin_layout Description
4727 Action Inserts a math macro definition at the cursor position in the text.
4730 \begin_layout Description
4731 Syntax math-macro <NAME> [<NARGS>] [def]
4734 \begin_layout Description
4735 Params <NAME>: The name of the macro, e.g. "mymacro".
4736 \begin_inset Newline newline
4739 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4742 \begin_layout Description
4743 Origin ale, 10 May 1997; sts, 21 Dec 2007
4746 \begin_layout Subsection*
4747 math-macro-add-greedy-optional-param
4750 \begin_layout Description
4751 Action Add a greedy optional parameter.
4754 \begin_layout Description
4755 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4758 \begin_layout Description
4759 Syntax math-macro-add-greedy-optional-param
4762 \begin_layout Description
4763 Origin sts, 06 January 2008
4766 \begin_layout Subsection*
4767 math-macro-add-optional-param
4770 \begin_layout Description
4771 Action Add an optional parameter.
4774 \begin_layout Description
4775 Notion Insert an optional parameter just behind the already existing optional parameters.
4778 \begin_layout Description
4779 Syntax math-macro-add-optional-param
4782 \begin_layout Description
4783 Origin sts, 06 January 2008
4786 \begin_layout Subsection*
4787 math-macro-add-param
4790 \begin_layout Description
4791 Action Add a parameter.
4794 \begin_layout Description
4795 Notion Add a parameter to a Math Macro.
4798 \begin_layout Description
4799 Syntax math-macro-add-param <NUM>
4802 \begin_layout Description
4803 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.
4806 \begin_layout Description
4807 Origin sts, 06 January 2008
4810 \begin_layout Subsection*
4811 math-macro-append-greedy-param
4814 \begin_layout Description
4815 Action Append a greedy parameter.
4818 \begin_layout Description
4819 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
4822 \begin_layout Description
4823 Syntax math-macro-append-greedy-param
4826 \begin_layout Description
4827 Origin sts, 06 January 2008
4830 \begin_layout Subsection*
4834 \begin_layout Description
4835 Action Fold a Math Macro.
4838 \begin_layout Description
4839 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
4844 \begin_layout Description
4845 Syntax math-macro-fold
4848 \begin_layout Description
4849 Origin sts, 06 January 2008
4852 \begin_layout Subsection*
4853 math-macro-make-nonoptional
4856 \begin_layout Description
4857 Action Make a parameter non-optional.
4860 \begin_layout Description
4861 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.
4864 \begin_layout Description
4865 Syntax math-macro-make-nonoptional
4868 \begin_layout Description
4869 Origin sts, 06 January 2008
4872 \begin_layout Subsection*
4873 math-macro-make-optional
4876 \begin_layout Description
4877 Action Make a parameter optional.
4880 \begin_layout Description
4881 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
4884 \begin_layout Description
4885 Syntax math-macro-make-optional
4888 \begin_layout Description
4889 Origin sts, 06 January 2008
4892 \begin_layout Subsection*
4893 math-macro-remove-greedy-param
4896 \begin_layout Description
4897 Action Remove a greedy parameter.
4900 \begin_layout Description
4901 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.
4904 \begin_layout Description
4905 Syntax math-macro-remove-greedy-param
4908 \begin_layout Description
4909 Origin sts, 06 January 2008
4912 \begin_layout Subsection*
4913 math-macro-remove-optional-param
4916 \begin_layout Description
4917 Action Remove the last optional parameter.
4920 \begin_layout Description
4921 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
4924 \begin_layout Description
4925 Syntax math-macro-remove-optional-param
4928 \begin_layout Description
4929 Origin sts, 06 January 2008
4932 \begin_layout Subsection*
4933 math-macro-remove-param
4936 \begin_layout Description
4937 Action Remove the last parameter.
4940 \begin_layout Description
4941 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
4944 \begin_layout Description
4945 Syntax math-macro-remove-param <NUM>
4948 \begin_layout Description
4949 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
4952 \begin_layout Description
4953 Origin sts, 06 January 2008
4956 \begin_layout Subsection*
4960 \begin_layout Description
4961 Action Unfold a Math Macro.
4964 \begin_layout Description
4965 Notion Unfold the Math Macro the cursor is in, i.e. display it as
4970 \begin_layout Description
4971 Syntax math-macro-unfold
4974 \begin_layout Description
4975 Origin sts, 06 January 2008
4978 \begin_layout Subsection*
4982 \begin_layout Description
4983 Action Inserts a matrix.
4986 \begin_layout Description
4987 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
4990 \begin_layout Description
4991 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).
4994 \begin_layout Description
4995 Sample math-matrix 3 3 bccc
4998 \begin_layout Subsection*
5002 \begin_layout Description
5003 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.
5006 \begin_layout Description
5007 Notion If there is some selected text, it puts the text inside created math box.
5010 \begin_layout Description
5011 Syntax math-mode [on|<ARG>]
5014 \begin_layout Description
5015 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
5016 \begin_inset Newline newline
5019 "on": allow only entering of math mode from text mode.
5022 \begin_layout Description
5023 Origin Alejandro, 4 Jun 1996
5026 \begin_layout Subsection*
5030 \begin_layout Description
5031 Action Mutates the type of math inset to the newly selected one.
5034 \begin_layout Description
5035 Syntax math-mutate <TYPE>
5038 \begin_layout Description
5039 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
5042 \begin_layout Description
5043 Origin Andre, 23 May 2001
5046 \begin_layout Subsection*
5047 math-number-line-toggle
5050 \begin_layout Description
5051 Action Toggles numbering of the current formula line.
5054 \begin_layout Description
5055 Notion Must be in display formula mode.
5058 \begin_layout Description
5059 Syntax math-number-line-toggle
5062 \begin_layout Description
5063 Origin Alejandro, 18 Jun 1996
5066 \begin_layout Subsection*
5070 \begin_layout Description
5071 Action Toggles numbering/labeling of the current formula.
5074 \begin_layout Description
5075 Notion Must be in display formula mode.
5078 \begin_layout Description
5079 Syntax math-number-toggle
5082 \begin_layout Description
5083 Origin Alejandro, 4 Jun 1996
5086 \begin_layout Subsection*
5090 \begin_layout Description
5091 Action Changes arbitrarily the size used by math fonts inside a context.
5094 \begin_layout Description
5095 Notion Provides an interface to the LaTeX math mode font size commands.
5098 \begin_layout Description
5099 Syntax math-size <STYLE>
5102 \begin_layout Description
5114 \begin_layout Description
5115 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5118 \begin_layout Subsection*
5122 \begin_layout Description
5123 Action Inserts space into math expression.
5126 \begin_layout Description
5127 Notion Use spacebar after entering this space to change type of space.
5130 \begin_layout Description
5131 Syntax math-space [<TYPE>] [<LEN>]
5134 \begin_layout Description
5135 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5136 \begin_inset Newline newline
5139 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5140 \begin_inset Newline newline
5143 custom space: hspace
5144 \begin_inset Newline newline
5147 "," used by default.
5148 \begin_inset Newline newline
5151 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5152 \begin_inset Newline newline
5155 <LEN>: length for custom spaces (hspace)
5158 \begin_layout Description
5159 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5162 \begin_layout Subsection*
5166 \begin_layout Description
5167 Action Enters subscript expression in math expression.
5170 \begin_layout Description
5171 Syntax math-subscript
5174 \begin_layout Description
5175 Origin vermeer, 12 Dec 2001
5178 \begin_layout Subsection*
5182 \begin_layout Description
5183 Action Enters superscript expression in math expression.
5186 \begin_layout Description
5187 Syntax math-superscript
5190 \begin_layout Description
5191 Origin vermeer, 12 Dec 2001
5194 \begin_layout Subsection*
5198 \begin_layout Description
5199 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5202 \begin_layout Description
5203 Notion If there is any selected text, then it is moved inside the created regexp inset.
5206 \begin_layout Description
5207 Syntax regexp-mode [<ARG>]
5210 \begin_layout Description
5211 Params <ARG>: eventual argument (regular expression).
5214 \begin_layout Description
5215 Origin Tommaso, 4 Oct 2008
5218 \begin_layout Section
5219 Buffer Fuctions (File and Window related)
5222 \begin_layout Subsection*
5226 \begin_layout Description
5227 Action Activate the branch.
5230 \begin_layout Description
5231 Syntax branch-activate <BRANCH>
5234 \begin_layout Description
5235 Params <BRANCH>: The branch to activate
5238 \begin_layout Description
5239 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5240 \begin_inset Newline newline
5243 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5246 \begin_layout Description
5247 Origin rgh, 27 May 2008
5250 \begin_layout Subsection*
5254 \begin_layout Description
5255 Action Add a branch to the buffer's BranchList.
5258 \begin_layout Description
5259 Syntax branch-add <BRANCH>
5262 \begin_layout Description
5263 Params <BRANCH>: Name of the branch to add
5266 \begin_layout Description
5267 Origin spitz, 7 Jul 2009
5270 \begin_layout Subsection*
5274 \begin_layout Description
5275 Action Create new branch and directly put the branch inset into the document.
5278 \begin_layout Description
5279 Syntax branch-add-insert [<NAME>]
5282 \begin_layout Description
5283 Params <NAME>: Branch name. If it is not specified, you will be asked.
5286 \begin_layout Description
5287 Origin sanda, 10 Jul 2009
5290 \begin_layout Subsection*
5294 \begin_layout Description
5295 Action De-activate the branch.
5298 \begin_layout Description
5299 Syntax branch-deactivate <BRANCH>
5302 \begin_layout Description
5303 Params <BRANCH>: The branch to deactivate
5306 \begin_layout Description
5307 Origin rgh, 27 May 2008
5310 \begin_layout Subsection*
5314 \begin_layout Description
5315 Action Toggles inversion status of branch inset.
5318 \begin_layout Description
5319 Syntax branch-invert
5322 \begin_layout Description
5323 Origin rgheck, 12 July 2016
5326 \begin_layout Subsection*
5327 branch-master-activate
5330 \begin_layout Description
5331 Action Activate the branch in the master buffer.
5334 \begin_layout Description
5335 Syntax branch-master-activate <BRANCH>
5338 \begin_layout Description
5339 Params <BRANCH>: The branch to activate
5342 \begin_layout Description
5343 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5344 \begin_inset Newline newline
5347 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5350 \begin_layout Description
5351 Origin spitz, 30 Sep 2012
5354 \begin_layout Subsection*
5355 branch-master-deactivate
5358 \begin_layout Description
5359 Action De-activate the branch in the master buffer.
5362 \begin_layout Description
5363 Syntax branch-master-deactivate <BRANCH>
5366 \begin_layout Description
5367 Params <BRANCH>: The branch to deactivate
5370 \begin_layout Description
5371 Origin spitz, 30 Sep 2012
5374 \begin_layout Subsection*
5378 \begin_layout Description
5379 Action Rename all branches of a given name in a document.
5382 \begin_layout Description
5383 Syntax branches-rename <OLDNAME> <NEWNAME>
5386 \begin_layout Description
5387 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5390 \begin_layout Description
5391 Origin spitz, 9 Jul 2009
5394 \begin_layout Subsection*
5398 \begin_layout Description
5399 Action Saves the current buffer to a temporary file.
5402 \begin_layout Description
5403 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5406 \begin_layout Description
5407 Syntax buffer-auto-save
5410 \begin_layout Subsection*
5414 \begin_layout Description
5415 Action Loads the given child document.
5418 \begin_layout Description
5419 Notion The current document is treated as a parent.
5422 \begin_layout Description
5423 Syntax buffer-child-open <FILE>
5426 \begin_layout Description
5427 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5430 \begin_layout Description
5431 Origin Ale, 28 May 1997
5434 \begin_layout Subsection*
5438 \begin_layout Description
5439 Action Runs chktex for the current document.
5442 \begin_layout Description
5443 Syntax buffer-chktex
5446 \begin_layout Description
5447 Origin Asger, 30 Oct 1997
5450 \begin_layout Subsection*
5454 \begin_layout Description
5455 Action Closes the current buffer.
5458 \begin_layout Description
5459 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5462 \begin_layout Description
5466 \begin_layout Subsection*
5470 \begin_layout Description
5471 Action Closes all buffers.
5474 \begin_layout Description
5475 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5478 \begin_layout Description
5479 Syntax buffer-close-all
5482 \begin_layout Subsection*
5486 \begin_layout Description
5487 Action Exports the current buffer (document) to the given format.
5490 \begin_layout Description
5491 Syntax buffer-export <FORMAT> [<DEST>]
5494 \begin_layout Description
5495 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.
5496 \begin_inset Newline newline
5499 In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM. <DEST> If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
5502 \begin_layout Description
5503 Origin Lgb, 29 Jul 1997
5506 \begin_layout Subsection*
5510 \begin_layout Description
5511 Action Opens a dialog for exporting the current buffer.
5514 \begin_layout Description
5515 Syntax buffer-export-as [<FORMAT>]
5518 \begin_layout Description
5519 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.
5522 \begin_layout Description
5523 Sample buffer-export-as pdf2
5526 \begin_layout Description
5527 Origin tommaso, 6 Oct 2011
5530 \begin_layout Subsection*
5531 buffer-export-custom
5534 \begin_layout Description
5535 Action Exports the current buffer (document) from the given format using the given command on it.
5538 \begin_layout Description
5539 Syntax buffer-export-custom <FORMAT> <COMMAND>
5542 \begin_layout Description
5543 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5544 \begin_inset Newline newline
5547 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5550 \begin_layout Description
5551 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5554 \begin_layout Description
5555 Origin leeming, 27 Mar 2004
5558 \begin_layout Subsection*
5562 \begin_layout Description
5563 Action Applies a command to all non-hidden buffers.
5566 \begin_layout Description
5567 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5570 \begin_layout Description
5571 Syntax buffer-forall <LFUN-COMMAND>
5574 \begin_layout Description
5575 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5578 \begin_layout Description
5579 Sample Close all Notes in buffers:
5580 \begin_inset Newline newline
5583 buffer-forall inset-forall Note inset-toggle close
5584 \begin_inset Newline newline
5587 Toggle change tracking on buffers:
5588 \begin_inset Newline newline
5591 buffer-forall changes-track
5592 \begin_inset Newline newline
5595 Toggle read-only for buffers:
5596 \begin_inset Newline newline
5599 buffer-forall buffer-toggle-read-only
5600 \begin_inset Newline newline
5603 Show statistics for individual buffers:
5604 \begin_inset Newline newline
5607 buffer-forall statistics
5608 \begin_inset Newline newline
5611 Activate the branch named "Solutions" in buffers:
5612 \begin_inset Newline newline
5615 buffer-forall branch-activate Solutions
5616 \begin_inset Newline newline
5619 Export buffers to PDF (pdflatex):
5620 \begin_inset Newline newline
5623 buffer-forall buffer-export pdf2
5624 \begin_inset Newline newline
5630 \begin_layout Description
5631 Origin skostysh, 20 Jul 2012
5634 \begin_layout Subsection*
5638 \begin_layout Description
5639 Action Import a given file as a lyx document.
5642 \begin_layout Description
5643 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.
5646 \begin_layout Description
5647 Syntax buffer-import <FORMAT> [<FILE>]
5650 \begin_layout Description
5651 Origin Asger, 24 Jul 1998
5654 \begin_layout Subsection*
5658 \begin_layout Description
5659 Action Set language of the current document.
5662 \begin_layout Description
5663 Syntax buffer-language <LANG>
5666 \begin_layout Description
5667 Params <LANG>: language name. See lib/languages for list.
5670 \begin_layout Description
5671 Origin leeming, 30 Mar 2004
5674 \begin_layout Subsection*
5678 \begin_layout Description
5679 Action Moves the current tab one spot to the right.
5682 \begin_layout Description
5683 Syntax buffer-move-next
5686 \begin_layout Description
5687 Origin skostysh, 7 Apr 2015
5690 \begin_layout Subsection*
5691 buffer-move-previous
5694 \begin_layout Description
5695 Action Moves the current tab one spot to the left.
5698 \begin_layout Description
5699 Syntax buffer-move-previous
5702 \begin_layout Description
5703 Origin skostysh, 7 Apr 2015
5706 \begin_layout Subsection*
5710 \begin_layout Description
5711 Action Creates a new buffer (that is, document) and switches to it.
5714 \begin_layout Description
5715 Notion Implicit path can be set in Preferences dialog.
5718 \begin_layout Description
5719 Syntax buffer-new [<FILE>]
5722 \begin_layout Description
5723 Params <FILE>: filename of created file with absolute path.
5726 \begin_layout Subsection*
5730 \begin_layout Description
5731 Action Creates a new buffer (that is, document) from a template.
5734 \begin_layout Description
5735 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5738 \begin_layout Description
5739 Syntax buffer-new-template [<FILE>]
5742 \begin_layout Description
5743 Params <FILE>: filename of created file with absolute path.
5746 \begin_layout Subsection*
5750 \begin_layout Description
5751 Action Switch to the next opened document.
5754 \begin_layout Description
5755 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
5758 \begin_layout Description
5762 \begin_layout Subsection*
5766 \begin_layout Description
5767 Action Apply the given settings to the current document.
5770 \begin_layout Description
5771 Syntax buffer-params-apply [<ARGS>]
5774 \begin_layout Description
5775 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5778 \begin_layout Description
5779 Origin leeming, 30 Mar 2004
5782 \begin_layout Subsection*
5786 \begin_layout Description
5787 Action Switch to the previous opened document.
5790 \begin_layout Description
5791 Syntax buffer-previous
5794 \begin_layout Subsection*
5798 \begin_layout Description
5799 Action Reverts opened document.
5802 \begin_layout Description
5803 Syntax buffer-reload
5806 \begin_layout Description
5807 Origin Asger, 2 Feb 1997
5810 \begin_layout Subsection*
5811 buffer-save-as-default
5814 \begin_layout Description
5815 Action Save the current document settings as default.
5818 \begin_layout Description
5819 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5822 \begin_layout Description
5823 Syntax buffer-save-as-default [<ARGS>]
5826 \begin_layout Description
5827 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
5830 \begin_layout Description
5831 Origin leeming, 30 Mar 2004
5834 \begin_layout Subsection*
5838 \begin_layout Description
5839 Action Display and switch to the given buffer.
5842 \begin_layout Description
5843 Syntax buffer-switch <BUFFER>
5846 \begin_layout Description
5847 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
5850 \begin_layout Subsection*
5851 buffer-toggle-compression
5854 \begin_layout Description
5855 Action Toggles compression of the current document on/off.
5858 \begin_layout Description
5859 Syntax buffer-toggle-compression
5862 \begin_layout Description
5863 Origin bpeng, 27 Apr 2006
5866 \begin_layout Subsection*
5867 buffer-toggle-read-only
5870 \begin_layout Description
5871 Action Toggle editing mode of the current document between read/write and read-only.
5874 \begin_layout Description
5875 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.
5878 \begin_layout Description
5879 Syntax buffer-toggle-read-only
5882 \begin_layout Description
5883 Origin Lgb, 27 May 1997
5886 \begin_layout Subsection*
5890 \begin_layout Description
5891 Action Exports the current document and put the result into the temporary directory.
5894 \begin_layout Description
5895 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).
5898 \begin_layout Description
5899 Syntax buffer-update [<FORMAT>]
5902 \begin_layout Description
5903 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.
5906 \begin_layout Description
5907 Origin Dekel, 5 Aug 2000
5910 \begin_layout Subsection*
5914 \begin_layout Description
5915 Action Displays current buffer in chosen format.
5918 \begin_layout Description
5919 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.
5922 \begin_layout Description
5923 Syntax buffer-view [<FORMAT>]
5926 \begin_layout Description
5927 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.
5930 \begin_layout Subsection*
5934 \begin_layout Description
5935 Action Opens the file that was created from last preview of this buffer.
5938 \begin_layout Description
5939 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.
5942 \begin_layout Description
5943 Syntax buffer-view-cache
5946 \begin_layout Subsection*
5950 \begin_layout Description
5951 Action Saves the current buffer.
5954 \begin_layout Description
5955 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.
5958 \begin_layout Description
5962 \begin_layout Subsection*
5966 \begin_layout Description
5967 Action Save all changed documents.
5970 \begin_layout Description
5971 Syntax buffer-write-all
5974 \begin_layout Description
5975 Origin rgh, gpothier 6 Aug 2007
5978 \begin_layout Subsection*
5982 \begin_layout Description
5983 Action Rename and save current buffer.
5986 \begin_layout Description
5987 Syntax buffer-write-as <FILENAME>
5990 \begin_layout Description
5991 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
5994 \begin_layout Subsection*
5998 \begin_layout Description
5999 Action Increases the zoom of the screen fonts.
6002 \begin_layout Description
6003 Syntax buffer-zoom-in [<ZOOM>]
6006 \begin_layout Description
6007 Params <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
6010 \begin_layout Description
6011 Origin vfr, 30 Mar 2009
6014 \begin_layout Subsection*
6018 \begin_layout Description
6019 Action Decreases the zoom of the screen fonts.
6022 \begin_layout Description
6023 Syntax buffer-zoom-out [<ZOOM>]
6026 \begin_layout Description
6027 Params <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
6030 \begin_layout Description
6031 Origin vfr, 30 Mar 2009
6034 \begin_layout Subsection*
6038 \begin_layout Description
6039 Action Generates the code (literate programming).
6042 \begin_layout Description
6043 Notion Latex file with extension
6045 literate_extension is generated. Then LyX invokes
6047 build_command (with a default of ``make'') to generate the code and
6049 build_error_filter to process the compilation error messages.
6050 \begin_inset Newline newline
6053 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:
6054 \begin_inset Newline newline
6059 build_command "my_script my_arguments"
6060 \begin_inset Newline newline
6065 build_error_filter differs from the
6067 literate_error_filter only in that the former will identify error messages from your compiler.
6070 \begin_layout Description
6071 Syntax build-program
6074 \begin_layout Subsection*
6078 \begin_layout Description
6079 Action Open LyX document.
6082 \begin_layout Description
6083 Syntax file-open [<FILE>]
6086 \begin_layout Description
6087 Params <FILE>: Filename to be opened.
6090 \begin_layout Subsection*
6094 \begin_layout Description
6095 Action Open the given help file according to the language setting.
6098 \begin_layout Description
6099 Syntax help-open <FILE>[.lyx]
6102 \begin_layout Description
6103 Params <FILE>: any document from (/usr/share/)doc directory.
6106 \begin_layout Description
6107 Origin Jug, 27 Jun 1999
6110 \begin_layout Subsection*
6114 \begin_layout Description
6115 Action Sets icon size of toolbars.
6118 \begin_layout Description
6119 Syntax icon-size [<SIZE>]
6122 \begin_layout Description
6123 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).
6126 \begin_layout Description
6130 \begin_layout Subsection*
6134 \begin_layout Description
6135 Action Terminates the current LyX instance.
6138 \begin_layout Description
6139 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6142 \begin_layout Description
6146 \begin_layout Subsection*
6147 master-buffer-update
6150 \begin_layout Description
6151 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6154 \begin_layout Description
6155 Syntax master-buffer-update [<FORMAT>]
6158 \begin_layout Description
6159 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.
6162 \begin_layout Description
6163 Origin Tommaso, 20 Sep 2007
6166 \begin_layout Subsection*
6170 \begin_layout Description
6171 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6174 \begin_layout Description
6175 Syntax master-buffer-view [<FORMAT>]
6178 \begin_layout Description
6179 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.
6182 \begin_layout Description
6183 Origin Tommaso, 20 Sep 2007
6186 \begin_layout Subsection*
6190 \begin_layout Description
6191 Action Opens the menu given by its name.
6194 \begin_layout Description
6195 Syntax menu-open <NAME>
6198 \begin_layout Description
6199 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6202 \begin_layout Subsection*
6206 \begin_layout Description
6207 Action Close the current tab group.
6210 \begin_layout Description
6211 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6214 \begin_layout Description
6215 Syntax tab-group-close
6218 \begin_layout Description
6219 Origin Abdel, 21 Feb 2008
6222 \begin_layout Subsection*
6226 \begin_layout Description
6227 Action Toggles visibility of a given toolbar between on/off/auto.
6230 \begin_layout Description
6231 Notion Skipping "auto" when allowauto is false.
6234 \begin_layout Description
6235 Syntax toolbar-toggle <NAME> [allowauto]
6238 \begin_layout Description
6239 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6240 \begin_inset Newline newline
6243 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6246 \begin_layout Description
6247 Origin Edwin, 21 May 2007
6250 \begin_layout Subsection*
6254 \begin_layout Description
6255 Action Various UI visibility-toggling actions.
6258 \begin_layout Description
6259 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6262 \begin_layout Description
6263 Params statusbar : Toggle visibility of the statusbar.
6264 \begin_inset Newline newline
6267 menubar : Toggle visibility of the menubar.
6268 \begin_inset Newline newline
6271 scrollbar : Toggle visibility of the scrollbar.
6272 \begin_inset Newline newline
6275 frame : Toggle visibility of the frames around editing window.
6276 \begin_inset Newline newline
6279 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.
6282 \begin_layout Description
6283 Origin sanda, 9 Feb 2007
6286 \begin_layout Subsection*
6290 \begin_layout Description
6291 Action Close the current document work area.
6294 \begin_layout Description
6295 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6298 \begin_layout Description
6302 \begin_layout Description
6303 Origin Tommaso, 15 Sep 2012
6306 \begin_layout Subsection*
6310 \begin_layout Description
6311 Action Creates another split view of current buffer.
6314 \begin_layout Description
6315 Notion All split views act in the same way independently.
6318 \begin_layout Description
6319 Syntax view-split <vertical|horizontal>
6322 \begin_layout Description
6323 Params horizontal : The work areas are laid out side by side.
6324 \begin_inset Newline newline
6327 vertical : The work areas laid out vertically.
6330 \begin_layout Description
6331 Origin Abdel, 20 Feb 2008
6334 \begin_layout Subsection*
6338 \begin_layout Description
6339 Action Closes the current LyX window.
6342 \begin_layout Description
6346 \begin_layout Description
6347 Origin Abdel, 23 Oct 2006
6350 \begin_layout Subsection*
6354 \begin_layout Description
6355 Action Creates new empty LyX window.
6358 \begin_layout Description
6359 Notion Already opened documents from the previous window can be found under View menu.
6362 \begin_layout Description
6363 Syntax window-new [<GEOMETRY>]
6366 \begin_layout Description
6367 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6370 \begin_layout Description
6371 Origin Abdel, 21 Oct 2006
6374 \begin_layout Section
6375 System Functions (Preferences, LyX Server etc.)
6378 \begin_layout Subsection*
6379 buffer-toggle-output-sync
6382 \begin_layout Description
6383 Action Toggles including of resources for forward/reverse search of the given document.
6386 \begin_layout Description
6387 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6390 \begin_layout Description
6391 Syntax buffer-toggle-output-sync
6394 \begin_layout Description
6395 Origin sanda, 25 May 2010
6398 \begin_layout Subsection*
6402 \begin_layout Description
6403 Action Executes a command defined in a .def file.
6406 \begin_layout Description
6407 Notion The definitions are by default read from lib/commands/default.def.
6408 \begin_inset Newline newline
6411 A .def file allows to define a command with
6413 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).
6415 def_file "FileName" allows to include another .def file.
6416 \begin_inset Newline newline
6419 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.
6422 \begin_layout Description
6426 \begin_layout Description
6427 Params <NAME>: Name of the command that must be called.
6430 \begin_layout Description
6431 Origin broider, 2 Oct 2007
6434 \begin_layout Subsection*
6438 \begin_layout Description
6439 Action Cancels sequence prepared by LFUN_META_PREFIX .
6442 \begin_layout Description
6446 \begin_layout Subsection*
6447 command-alternatives
6450 \begin_layout Description
6451 Action Runs the first listed command that is enabled.
6454 \begin_layout Description
6455 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6458 \begin_layout Description
6459 Syntax command-alternatives <CMDS>
6462 \begin_layout Description
6463 Params <CMDS>: Sequence of commands separated by semicolons.
6466 \begin_layout Description
6467 Sample command-alternatives completion-accept;cell-forward
6470 \begin_layout Description
6471 Origin rgh, 24 September 2008
6474 \begin_layout Subsection*
6478 \begin_layout Description
6479 Action Run more commands (LFUN and its parameters) in a sequence.
6482 \begin_layout Description
6483 Syntax command-sequence <CMDS>
6486 \begin_layout Description
6487 Params <CMDS>: Sequence of commands separated by semicolons.
6490 \begin_layout Description
6491 Sample command-sequence cut; ert-insert; self-insert
6493 ; paste; self-insert {}; inset-toggle;
6496 \begin_layout Description
6497 Origin Andre, 11 Nov 1999
6500 \begin_layout Subsection*
6501 cursor-follows-scrollbar-toggle
6504 \begin_layout Description
6505 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6508 \begin_layout Description
6509 Syntax toggle-cursor-follows-scrollbar
6512 \begin_layout Description
6513 Origin ARRae, 2 Dec 1997
6516 \begin_layout Subsection*
6520 \begin_layout Description
6521 Action Set debug output level.
6524 \begin_layout Description
6525 Syntax debug-level-set <LEVEL>
6528 \begin_layout Description
6529 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.
6532 \begin_layout Description
6533 Origin sanda, 28 Dec 2009
6536 \begin_layout Subsection*
6540 \begin_layout Description
6541 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6544 \begin_layout Description
6545 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6548 \begin_layout Description
6549 Syntax forward-search
6552 \begin_layout Description
6553 Origin sanda, 14 Apr 2010
6556 \begin_layout Subsection*
6560 \begin_layout Description
6561 Action Apply the given settings to user preferences.
6564 \begin_layout Description
6565 Syntax lyxrc-apply <SETTINGS>
6568 \begin_layout Description
6569 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.
6572 \begin_layout Subsection*
6576 \begin_layout Description
6577 Action Shows message in statusbar (for script purposes).
6580 \begin_layout Description
6581 Syntax message <STRING>
6584 \begin_layout Description
6585 Origin Lgb, 8 Apr 2001
6588 \begin_layout Subsection*
6592 \begin_layout Description
6593 Action Simulate halting Meta key (Alt key on PCs).
6596 \begin_layout Description
6597 Notion Used for buffer edition not for GUI control.
6600 \begin_layout Description
6604 \begin_layout Subsection*
6608 \begin_layout Description
6609 Action Save user preferences.
6612 \begin_layout Description
6613 Syntax preferences-save
6616 \begin_layout Description
6617 Origin Lgb, 27 Nov 1999
6620 \begin_layout Subsection*
6624 \begin_layout Description
6625 Action Reconfigure the automatic settings.
6628 \begin_layout Description
6632 \begin_layout Description
6633 Origin Asger, 14 Feb 1997
6636 \begin_layout Subsection*
6640 \begin_layout Description
6641 Action Returns path and file name of the currently edited document.
6644 \begin_layout Description
6645 Syntax server-get-filename
6648 \begin_layout Subsection*
6652 \begin_layout Description
6653 Action Returns the current layout (that is environment) name on the cursor position.
6656 \begin_layout Description
6657 Syntax server-get-layout
6660 \begin_layout Subsection*
6661 server-get-statistics
6664 \begin_layout Description
6665 Action Returns the statistics (number of words and characters) in the document or in the given selection.
6668 \begin_layout Description
6669 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6672 \begin_layout Description
6673 Syntax server-get-statistics [<TYPE>]
6676 \begin_layout Description
6677 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
6678 \begin_inset Newline newline
6682 \begin_inset Newline newline
6685 chars: count characters.
6686 \begin_inset Newline newline
6689 chars-space: count characters and spaces.
6692 \begin_layout Description
6693 Origin brokenclock, Oct 10 2014
6696 \begin_layout Subsection*
6700 \begin_layout Description
6701 Action Returns the coordinates of cursor position in the editing area.
6704 \begin_layout Description
6705 Syntax server-get-xy
6708 \begin_layout Subsection*
6709 server-goto-file-row
6712 \begin_layout Description
6713 Action Sets the cursor position in LyX based on the row number of generated TeX file.
6716 \begin_layout Description
6717 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).
6720 \begin_layout Description
6721 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
6724 \begin_layout Description
6725 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.
6726 \begin_inset Newline newline
6729 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).
6730 \begin_inset Newline newline
6733 .ext: extensions will be automatically replaced by .lyx.
6734 \begin_inset Newline newline
6737 <ROW_NUMBER> The row number of the LaTeX file to which to go.
6740 \begin_layout Description
6741 Sample server-goto-file-row /home/user/example.lyx 41
6742 \begin_inset Newline newline
6745 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
6748 \begin_layout Description
6749 Origin Edmar, 23 Dec 1998
6752 \begin_layout Subsection*
6756 \begin_layout Description
6757 Action Sends notify message about the last key-sequence to client.
6760 \begin_layout Description
6761 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
6764 \begin_layout Description
6765 Syntax server-notify
6768 \begin_layout Subsection*
6772 \begin_layout Description
6773 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
6776 \begin_layout Description
6777 Syntax server-set-xy <X> <Y>
6780 \begin_layout Subsection*
6784 \begin_layout Description
6785 Action Set the given LyX color to the color defined by the X11 name given.
6788 \begin_layout Description
6789 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
6792 \begin_layout Description
6793 Syntax set-color <LYX_NAME> <X11_NAME>
6796 \begin_layout Description
6797 Origin SLior, 11 Jun 2000
6800 \begin_layout Subsection*
6804 \begin_layout Description
6805 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
6808 \begin_layout Description
6809 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
6812 \begin_layout Description
6816 \begin_layout Description
6817 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6820 \begin_layout Subsection*
6824 \begin_layout Description
6825 Action Checks-in/commits the changes of the registered file to the repository.
6828 \begin_layout Description
6829 Notion In RCS case this also unlocks the file.
6832 \begin_layout Description
6836 \begin_layout Description
6837 Origin Lgb, 1 Jul 1997
6840 \begin_layout Subsection*
6844 \begin_layout Description
6845 Action Checks-out the document for edit (and locks it in some cases).
6848 \begin_layout Description
6852 \begin_layout Description
6853 Origin Lgb, 1 Jul 1997
6856 \begin_layout Subsection*
6860 \begin_layout Description
6861 Action Executes external command. This command is intended to support additional VCS commands.
6864 \begin_layout Description
6865 Syntax vc-command <FLAG> <PATH> <COMMAND>
6868 \begin_layout Description
6869 Params <FLAG>: Flags for the command can be combined together.
6870 \begin_inset Newline newline
6873 U - dUmmy - no flags
6874 \begin_inset Newline newline
6877 D - Doc - need document loaded to proceed
6878 \begin_inset Newline newline
6881 I - dIrty - mark document dirty
6882 \begin_inset Newline newline
6885 R - Reload - ensure that the document is saved and reload it after command execution
6886 \begin_inset Newline newline
6889 M - Message - ask for input string (commit message)
6890 \begin_inset Newline newline
6893 <PATH>: path where to start. $$p will be replaced by the current document path.
6894 \begin_inset Newline newline
6897 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
6900 \begin_layout Description
6901 Sample vc-command DR $$p "svn up"
6904 \begin_layout Description
6905 Origin sanda, 13 Jan 2009
6908 \begin_layout Subsection*
6912 \begin_layout Description
6913 Action Compares two revisions of the same file under version control.
6916 \begin_layout Description
6917 Syntax vc-compare [<REV1>] [<REV2>]
6920 \begin_layout Description
6921 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
6922 \begin_inset Newline newline
6925 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
6926 \begin_inset Newline newline
6930 \begin_inset Newline newline
6933 <REV2>: Newer file. Used only if REV1 > 0.
6934 \begin_inset Newline newline
6937 If no parameter is given, interactive dialog will be shown.
6940 \begin_layout Description
6941 Sample Compare current document against last commit
6942 \begin_inset Newline newline
6946 \begin_inset Newline newline
6949 Compare current document against current revision - 5 commits
6950 \begin_inset Newline newline
6954 \begin_inset Newline newline
6957 Compare revisions 120 and 155
6958 \begin_inset Newline newline
6964 \begin_layout Description
6965 Origin sanda, 12 Feb 2010
6968 \begin_layout Subsection*
6972 \begin_layout Description
6973 Action Copies the document to another name.
6976 \begin_layout Description
6977 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.
6980 \begin_layout Description
6981 Syntax vc-copy <FILENAME>
6984 \begin_layout Description
6985 Params <FILENAME>: New name of the document.
6986 \begin_inset Newline newline
6989 A file dialog is opened if no filename is given.
6992 \begin_layout Description
6993 Origin gb, 05 Feb 2013
6996 \begin_layout Subsection*
7000 \begin_layout Description
7001 Action Toggles the locking property of the edited file.
7004 \begin_layout Description
7005 Notion This is currently implemented only for SVN.
7008 \begin_layout Description
7009 Syntax vc-locking-toggle
7012 \begin_layout Description
7013 Origin sanda, 25 Jun 2009
7016 \begin_layout Subsection*
7020 \begin_layout Description
7021 Action Register the document as an file inside version control system.
7024 \begin_layout Description
7025 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
7026 \begin_inset Newline newline
7029 See LyX Additional Features Manual (Version Control Chapter) for additional information.
7032 \begin_layout Description
7036 \begin_layout Description
7037 Origin Lgb, 1 Jul 1997
7040 \begin_layout Subsection*
7044 \begin_layout Description
7045 Action Renames the document to another name.
7048 \begin_layout Description
7049 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.
7052 \begin_layout Description
7053 Syntax vc-rename <FILENAME>
7056 \begin_layout Description
7057 Params <FILENAME>: New name of the document.
7058 \begin_inset Newline newline
7061 A file dialog is opened if no filename is given.
7064 \begin_layout Description
7065 Origin gb, 05 Feb 2013
7068 \begin_layout Subsection*
7072 \begin_layout Description
7073 Action Update the local archive directory in which resides the current document with the remote repository.
7076 \begin_layout Description
7077 Syntax vc-repo-update
7080 \begin_layout Description
7081 Origin sanda, 16 Oct 2009
7084 \begin_layout Subsection*
7088 \begin_layout Description
7089 Action Reverts the document to the last check-in/commit in VCS.
7092 \begin_layout Description
7096 \begin_layout Description
7097 Origin Lgb, 1 Jul 1997
7100 \begin_layout Subsection*
7104 \begin_layout Description
7105 Action Undo last check-in.
7108 \begin_layout Description
7109 Notion This is currently implemented only for RCS.
7112 \begin_layout Description
7116 \begin_layout Description
7117 Origin Lgb, 1 Jul 1997
7120 \begin_layout Section
7121 Hidden Functions (not listed for configuration)
7124 \begin_layout Subsection*
7128 \begin_layout Description
7129 Action Return the current key sequence and available options as a string.
7132 \begin_layout Description
7133 Notion No options are added if no current map exists.
7134 \begin_inset Newline newline
7137 This is probably usable only with connection to lyxserver.
7140 \begin_layout Description
7141 Syntax command-prefix
7144 \begin_layout Subsection*
7148 \begin_layout Description
7149 Action Activates the LyX window.
7152 \begin_layout Description
7153 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.
7156 \begin_layout Description
7160 \begin_layout Description
7161 Origin skostysh, 4 Aug 2016
7164 \begin_layout Subsection*
7168 \begin_layout Description
7169 Action Inserts the given string (accordingly to the correct keymap).
7172 \begin_layout Description
7173 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7176 \begin_layout Description
7177 Syntax self-insert <STRING>