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 This LFUN opens the dropbox allowing for choice of layout.
172 \begin_layout Description
173 Syntax drop-layouts-choice
176 \begin_layout Subsection*
180 \begin_layout Description
181 Action Splits the current environment with a Separator.
184 \begin_layout Description
185 Syntax environment-split [before|outer|previous]
188 \begin_layout Description
189 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
190 \begin_inset Newline newline
193 previous: If this is given, LyX will split the environment in the previous paragraph (if there is one).
194 \begin_inset Newline newline
197 before: If this is given, the new environment will be appended rather than prepended.
200 \begin_layout Description
201 Origin spitz, 23 Dec 2012
204 \begin_layout Subsection*
208 \begin_layout Description
209 Action Toggles the bold font (selection-wise) using mathbf in math.
212 \begin_layout Description
216 \begin_layout Subsection*
220 \begin_layout Description
221 Action Toggles the bold font (selection-wise) using boldsymbol in math.
224 \begin_layout Description
225 Syntax font-boldsymbol
228 \begin_layout Subsection*
232 \begin_layout Description
233 Action Toggles xout (cross-through) in the font (selection-wise).
236 \begin_layout Description
240 \begin_layout Description
241 Origin uwestoehr, 4 April 2017
244 \begin_layout Subsection*
248 \begin_layout Description
249 Action Reverts the settings of the font to the default values (selection-wise).
252 \begin_layout Description
256 \begin_layout Subsection*
260 \begin_layout Description
261 Action Toggles the emphasis font style (selection-wise).
264 \begin_layout Description
268 \begin_layout Subsection*
272 \begin_layout Description
273 Action Toggles Fraktur family font (math-mode, selection-wise).
276 \begin_layout Description
280 \begin_layout Description
281 Origin vermeer, 10 Jan 2002
284 \begin_layout Subsection*
288 \begin_layout Description
289 Action Toggles Italics font shape (math-mode, selection-wise).
292 \begin_layout Description
296 \begin_layout Description
297 Origin vermeer, 10 Jan 2002
300 \begin_layout Subsection*
304 \begin_layout Description
305 Action Toggles Noun text style font (selection-wise).
308 \begin_layout Description
312 \begin_layout Subsection*
316 \begin_layout Description
317 Action Toggles Roman family font (selection-wise).
320 \begin_layout Description
324 \begin_layout Subsection*
328 \begin_layout Description
329 Action Toggles Sans Serif family font (selection-wise).
332 \begin_layout Description
336 \begin_layout Subsection*
340 \begin_layout Description
341 Action Sets font size according to lyx format string.
344 \begin_layout Description
345 Syntax font-size <SIZE>
348 \begin_layout Description
349 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
350 \begin_inset Newline newline
353 largest|huge|giant|increase|decrease|default
356 \begin_layout Subsection*
360 \begin_layout Description
361 Action Returns the info about the current font.
364 \begin_layout Description
368 \begin_layout Subsection*
372 \begin_layout Description
373 Action Toggles strikeout (strike-through) in the font (selection-wise).
376 \begin_layout Description
377 Syntax font-strikeout
380 \begin_layout Description
381 Origin sanda, 3 May 2009
384 \begin_layout Subsection*
388 \begin_layout Description
389 Action Toggles the typewriter family font (selection-wise).
392 \begin_layout Description
393 Syntax font-typewriter
396 \begin_layout Subsection*
400 \begin_layout Description
401 Action Toggles underline in the font (selection-wise).
404 \begin_layout Description
405 Syntax font-underline
408 \begin_layout Subsection*
412 \begin_layout Description
413 Action Toggles double underline in the font (selection-wise).
416 \begin_layout Description
417 Syntax font-underunderline
420 \begin_layout Description
421 Origin sanda, 5 May 2009
424 \begin_layout Subsection*
428 \begin_layout Description
429 Action Toggles wavy underline in the font (selection-wise).
432 \begin_layout Description
433 Syntax font-underwave
436 \begin_layout Description
437 Origin sanda, 5 May 2009
440 \begin_layout Subsection*
444 \begin_layout Description
445 Action Sets the layout (that is, environment) for the current paragraph.
448 \begin_layout Description
449 Syntax layout <LAYOUT> [ignorenests]
452 \begin_layout Description
453 Params <LAYOUT>: the layout to use
454 \begin_inset Newline newline
457 ignorenests: If specified, nesting advices will be ignored.
460 \begin_layout Subsection*
464 \begin_layout Description
465 Action Adds a module.
468 \begin_layout Description
469 Notion Adds a module to the list of included modules for the current buffer.
472 \begin_layout Description
473 Syntax layout-module-add <MODULE>
476 \begin_layout Description
477 Params <MODULE>: the module to be added
480 \begin_layout Description
481 Origin rgh, 25 August 2007
484 \begin_layout Subsection*
488 \begin_layout Description
489 Action Clears the module list.
492 \begin_layout Description
493 Notion Clears the list of included modules for the current buffer.
496 \begin_layout Description
497 Syntax layout-modules-clear
500 \begin_layout Description
501 Origin rgh, 25 August 2007
504 \begin_layout Subsection*
508 \begin_layout Description
509 Action Launches the paragraph settings dialog.
512 \begin_layout Description
513 Syntax layout-paragraph
516 \begin_layout Subsection*
520 \begin_layout Description
521 Action Reloads layout information.
524 \begin_layout Description
525 Notion Reloads all layout information for the current buffer from disk, thus recognizing any changes that have been made to layout files on the fly. This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
528 \begin_layout Description
532 \begin_layout Description
533 Origin rgh, 3 September 2007
536 \begin_layout Subsection*
540 \begin_layout Description
541 Action Launches the tabular settings dialog.
544 \begin_layout Description
545 Syntax layout-tabular
548 \begin_layout Description
549 Origin Jug, 31 Jul 2000
552 \begin_layout Subsection*
556 \begin_layout Description
557 Action Toggles the layout (that is, environment) for the current paragraph.
560 \begin_layout Description
561 Notion Contrary to `layout', this function resets the current (or selection) layout to the standard layout it already has the correct layout. Useful for toolbar icons.
564 \begin_layout Description
565 Syntax layout-toggle <LAYOUT> [ignorenests]
568 \begin_layout Description
569 Params <LAYOUT>: the layout to toggle
570 \begin_inset Newline newline
573 ignorenests: If specified, nesting advices will be ignored.
576 \begin_layout Description
577 Origin lasgouttes, 14 May 2018
580 \begin_layout Subsection*
584 \begin_layout Description
585 Action Update fonts and its metrics.
588 \begin_layout Description
589 Notion Automatically called after zoom, dpi, font names, or norm change.
592 \begin_layout Description
593 Syntax screen-font-update
596 \begin_layout Description
597 Origin ARRae, 13 Aug 2000
600 \begin_layout Subsection*
604 \begin_layout Description
605 Action Sets the text class for the current buffer.
608 \begin_layout Description
609 Syntax textclass-apply <TEXTCLASS>
612 \begin_layout Description
613 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
616 \begin_layout Subsection*
620 \begin_layout Description
621 Action Loads information for a textclass from disk.
624 \begin_layout Description
625 Syntax textclass-load <TEXTCLASS>
628 \begin_layout Description
629 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
632 \begin_layout Subsection*
636 \begin_layout Description
637 Action Apply last used text properties.
640 \begin_layout Description
641 Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
644 \begin_layout Description
645 Syntax textstyle-apply [<NUM>]textstyle-apply
648 \begin_layout Description
649 Params <NUM>: number of the selection in the internal freefonts stack to be applied.
652 \begin_layout Description
653 Origin leeming, 12 Mar 2003
656 \begin_layout Subsection*
660 \begin_layout Description
661 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
664 \begin_layout Description
665 Syntax textstyle-update <FONT_INFO>
668 \begin_layout Description
669 Params <FONT_INFO>: specifies font attributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
670 \begin_inset Newline newline
673 Use lyx -dbg action for exact syntax of text-style dialog parameters.
676 \begin_layout Description
677 Origin leeming, 12 Mar 2003
680 \begin_layout Section
681 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
684 \begin_layout Subsection*
688 \begin_layout Description
689 Action Adds an acute accent to the next character typed.
692 \begin_layout Description
696 \begin_layout Subsection*
700 \begin_layout Description
701 Action Adds a breve accent to the next character typed.
704 \begin_layout Description
708 \begin_layout Subsection*
712 \begin_layout Description
713 Action Adds a caron to the next character typed.
716 \begin_layout Description
720 \begin_layout Subsection*
724 \begin_layout Description
725 Action Adds a cedilla to the next character typed.
728 \begin_layout Description
729 Syntax accent-cedilla
732 \begin_layout Subsection*
736 \begin_layout Description
737 Action Adds a circle accent to the next character typed.
740 \begin_layout Description
744 \begin_layout Subsection*
748 \begin_layout Description
749 Action Adds a circumflex to the next character typed.
752 \begin_layout Description
753 Syntax accent-circumflex
756 \begin_layout Subsection*
760 \begin_layout Description
761 Action Adds a dot accent to the next character typed.
764 \begin_layout Description
768 \begin_layout Subsection*
772 \begin_layout Description
773 Action Adds a grave accent to the next character typed.
776 \begin_layout Description
780 \begin_layout Subsection*
781 accent-hungarian-umlaut
784 \begin_layout Description
785 Action Adds a Hungarian umlaut to the next character typed.
788 \begin_layout Description
792 \begin_layout Subsection*
796 \begin_layout Description
797 Action Adds a macron to the next character typed.
800 \begin_layout Description
804 \begin_layout Subsection*
808 \begin_layout Description
809 Action Adds an ogonek accent to the next character typed.
812 \begin_layout Description
816 \begin_layout Subsection*
820 \begin_layout Description
821 Action Adds a perispomeni (Greek circumflex) over the next character typed.
824 \begin_layout Description
825 Syntax accent-perispomeni
828 \begin_layout Subsection*
832 \begin_layout Description
833 Action Adds a tie over the next two character typed.
836 \begin_layout Description
837 Notion The following char will finish the tie.
840 \begin_layout Description
844 \begin_layout Subsection*
848 \begin_layout Description
849 Action Adds a tilde over the next character typed.
852 \begin_layout Description
856 \begin_layout Subsection*
860 \begin_layout Description
861 Action Adds an umlaut over the next character typed.
864 \begin_layout Description
868 \begin_layout Subsection*
872 \begin_layout Description
873 Action Adds a bar under the next character typed.
876 \begin_layout Description
877 Syntax accent-underbar
880 \begin_layout Subsection*
884 \begin_layout Description
885 Action Adds a dot under the next character typed.
888 \begin_layout Description
889 Syntax accent-underdot
892 \begin_layout Subsection*
896 \begin_layout Description
897 Action Accepts all tracked changes in the document.
900 \begin_layout Description
901 Syntax all-changes-accept
904 \begin_layout Description
905 Origin Levon, 16 Oct 2002
908 \begin_layout Subsection*
912 \begin_layout Description
913 Action Rejects all tracked changes in the document.
916 \begin_layout Description
917 Notion Reject does not work recursively; the user may have to repeat the operation.
920 \begin_layout Description
921 Syntax all-changes-reject
924 \begin_layout Description
925 Origin Levon, 16 Oct 2002
928 \begin_layout Subsection*
932 \begin_layout Description
933 Action Start (or remove) Appendix on the given cursor position.
936 \begin_layout Description
940 \begin_layout Description
941 Origin ettrich, 5 May 1998
944 \begin_layout Subsection*
948 \begin_layout Description
949 Action Inserts an argument (short title) inset.
952 \begin_layout Description
953 Syntax argument-insert <argument nr>
956 \begin_layout Description
957 Params <argument nr>: see layout declarations
960 \begin_layout Description
961 Origin vermeer, 12 Aug 2002
964 \begin_layout Subsection*
968 \begin_layout Description
969 Action Adds database, which will be used for bibtex citations.
972 \begin_layout Description
973 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
976 \begin_layout Description
977 Syntax bibtex-database-add <DATABASE-NAME>
980 \begin_layout Description
981 Origin Ale, 30 May 1997
984 \begin_layout Subsection*
988 \begin_layout Description
989 Action Adds database, which will be used for bibtex citations.
992 \begin_layout Description
993 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
996 \begin_layout Description
997 Syntax bibtex-database-del <DATABASE-NAME>
1000 \begin_layout Description
1001 Origin Ale, 30 May 1997
1004 \begin_layout Subsection*
1008 \begin_layout Description
1009 Action Clears the list of saved bookmarks.
1012 \begin_layout Description
1013 Syntax bookmark-clear
1016 \begin_layout Description
1017 Origin bpeng, 31 October 2006
1020 \begin_layout Subsection*
1024 \begin_layout Description
1025 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
1028 \begin_layout Description
1029 Notion Bookmark 0 has a special purpose. It is automatically set
1030 \begin_inset Newline newline
1033 1. to the paragraph you are currently editing
1034 \begin_inset Newline newline
1037 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
1038 \begin_inset Newline newline
1041 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
1044 \begin_layout Description
1045 Syntax bookmark-goto <NUMBER>
1048 \begin_layout Description
1049 Params <NUMBER>: the number of the bookmark to restore.
1052 \begin_layout Description
1053 Origin Dekel, 27 January 2001
1056 \begin_layout Subsection*
1060 \begin_layout Description
1061 Action Save a bookmark.
1064 \begin_layout Description
1065 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.
1068 \begin_layout Description
1069 Syntax bookmark-save <NUMBER>
1072 \begin_layout Description
1073 Params <NUMBER>: the number of the bookmark to save.
1076 \begin_layout Description
1077 Origin Dekel, 27 January 2001
1080 \begin_layout Subsection*
1084 \begin_layout Description
1085 Action Inserts Box inset.
1088 \begin_layout Description
1089 Syntax box-insert [<TYPE>]
1092 \begin_layout Description
1093 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
1094 \begin_inset Newline newline
1097 Framed is the default one.
1100 \begin_layout Description
1101 Origin vermeer, 7 Oct 2003
1104 \begin_layout Subsection*
1108 \begin_layout Description
1109 Action Inserts branch inset.
1112 \begin_layout Description
1113 Syntax branch-insert <BRANCH-NAME>
1116 \begin_layout Description
1117 Origin vermeer, 17 Aug 2003
1120 \begin_layout Subsection*
1124 \begin_layout Description
1125 Action For debug purposes only. Convert all [a-zA-Z0-1] characters to single character. Useful when submitting docs to list or bugzilla.
1128 \begin_layout Description
1129 Syntax buffer-anonymize
1132 \begin_layout Description
1133 Origin sanda, Feb 1 2018
1136 \begin_layout Subsection*
1140 \begin_layout Description
1141 Action Move the cursor to the beginning of the document.
1144 \begin_layout Description
1148 \begin_layout Subsection*
1152 \begin_layout Description
1153 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1156 \begin_layout Description
1157 Syntax buffer-begin-select
1160 \begin_layout Subsection*
1164 \begin_layout Description
1165 Action Move the cursor to the end of the document.
1168 \begin_layout Description
1172 \begin_layout Subsection*
1176 \begin_layout Description
1177 Action Move the cursor to the end of the document adding the traversed text to the selection.
1180 \begin_layout Description
1181 Syntax buffer-end-select
1184 \begin_layout Subsection*
1188 \begin_layout Description
1189 Action Inserts a caption inset.
1192 \begin_layout Description
1193 Syntax caption-insert
1196 \begin_layout Description
1197 Origin Lgb, 18 Jul 2000
1200 \begin_layout Subsection*
1204 \begin_layout Description
1205 Action Moves the cursor to the previous cell inside the table.
1208 \begin_layout Description
1209 Syntax cell-backward
1212 \begin_layout Description
1213 Origin Jug, 22 May 2000
1216 \begin_layout Subsection*
1220 \begin_layout Description
1221 Action Moves the cursor to the next cell inside the table.
1224 \begin_layout Description
1228 \begin_layout Subsection*
1232 \begin_layout Description
1233 Action Splits cell and shifts right part to the next cell (inside the math grid).
1236 \begin_layout Description
1240 \begin_layout Description
1241 Origin Ale, 15 May 1997
1244 \begin_layout Subsection*
1248 \begin_layout Description
1249 Action Accepts tracked change inside the selection.
1252 \begin_layout Description
1253 Syntax change-accept
1256 \begin_layout Description
1257 Origin Levon, 16 Oct 2002
1260 \begin_layout Subsection*
1264 \begin_layout Description
1265 Action Moves the cursor to the position of the next change of the change tracking records.
1268 \begin_layout Description
1272 \begin_layout Description
1273 Origin schmitt, 4 Oct 2006
1276 \begin_layout Subsection*
1280 \begin_layout Description
1281 Action Moves the cursor to the position of the previous change of the change tracking records.
1284 \begin_layout Description
1285 Syntax change-previous
1288 \begin_layout Description
1289 Origin vfr, 4 Apr 2009
1292 \begin_layout Subsection*
1296 \begin_layout Description
1297 Action Rejects tracked change inside the selection.
1300 \begin_layout Description
1301 Syntax change-reject
1304 \begin_layout Description
1305 Origin Levon, 16 Oct 2002
1308 \begin_layout Subsection*
1312 \begin_layout Description
1313 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1316 \begin_layout Description
1317 Syntax changes-merge
1320 \begin_layout Description
1321 Origin Levon, 16 Oct 2002
1324 \begin_layout Subsection*
1328 \begin_layout Description
1329 Action Toggles showing of change tracking in typeset output.
1332 \begin_layout Description
1333 Syntax changes-output
1336 \begin_layout Description
1337 Origin spitz, 21 Jan 2005
1340 \begin_layout Subsection*
1344 \begin_layout Description
1345 Action Toggles change tracking to on/off.
1348 \begin_layout Description
1349 Syntax changes-track
1352 \begin_layout Description
1353 Origin levon, 1 Oct 2002
1356 \begin_layout Subsection*
1360 \begin_layout Description
1361 Action Moves the cursor one position logically backwards.
1364 \begin_layout Description
1365 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.
1368 \begin_layout Description
1369 Syntax char-backward
1372 \begin_layout Subsection*
1373 char-backward-select
1376 \begin_layout Description
1377 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1380 \begin_layout Description
1381 Notion See also LFUN_CHAR_BACKWARD.
1384 \begin_layout Description
1385 Syntax char-backward-select
1388 \begin_layout Subsection*
1389 char-delete-backward
1392 \begin_layout Description
1393 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1396 \begin_layout Description
1397 Syntax char-delete-backward [force]
1400 \begin_layout Description
1401 Params force: Delete big insets, do not only select them.
1404 \begin_layout Subsection*
1408 \begin_layout Description
1409 Action Deletes one character in the backward direction (usually the "Delete" key).
1412 \begin_layout Description
1413 Syntax char-delete-forward [force]
1416 \begin_layout Description
1417 Params force: Delete big insets, do not only select them.
1420 \begin_layout Subsection*
1424 \begin_layout Description
1425 Action Moves the cursor one position logically forward.
1428 \begin_layout Description
1429 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.
1432 \begin_layout Description
1436 \begin_layout Subsection*
1440 \begin_layout Description
1441 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1444 \begin_layout Description
1445 Notion See also LFUN_CHAR_FORWARD.
1448 \begin_layout Description
1449 Syntax char-forward-select
1452 \begin_layout Subsection*
1456 \begin_layout Description
1457 Action Moves the cursor one position "to the left".
1460 \begin_layout Description
1461 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.
1464 \begin_layout Description
1468 \begin_layout Subsection*
1472 \begin_layout Description
1473 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1476 \begin_layout Description
1477 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1480 \begin_layout Description
1481 Syntax char-left-select
1484 \begin_layout Subsection*
1488 \begin_layout Description
1489 Action Moves the cursor one position "to the right".
1492 \begin_layout Description
1493 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.
1496 \begin_layout Description
1500 \begin_layout Subsection*
1504 \begin_layout Description
1505 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1508 \begin_layout Description
1509 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1512 \begin_layout Description
1513 Syntax char-right-select
1516 \begin_layout Subsection*
1520 \begin_layout Description
1521 Action Transposes the character at the cursor with the one before it.
1524 \begin_layout Description
1525 Syntax chars-transpose
1528 \begin_layout Description
1529 Origin Lgb, 25 Apr 2001
1532 \begin_layout Subsection*
1536 \begin_layout Description
1537 Action Inserts citation from loaded citation database.
1540 \begin_layout Description
1541 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1544 \begin_layout Description
1545 Params <KEY>: Citation (shortcut listed in available citations).
1546 \begin_inset Newline newline
1549 <TEXT_BEFORE>: text which should appear before citation.
1552 \begin_layout Description
1553 Origin AAS, 97-02-23
1556 \begin_layout Subsection*
1560 \begin_layout Description
1561 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.
1564 \begin_layout Description
1565 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.
1568 \begin_layout Description
1569 Syntax clipboard-paste [<ARG>]
1572 \begin_layout Description
1573 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1576 \begin_layout Description
1577 Origin Georg, 10 Jul 2006
1580 \begin_layout Subsection*
1581 clipboard-paste-simple
1584 \begin_layout Description
1585 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.
1588 \begin_layout Description
1589 Syntax clipboard-paste-simple [<ARG>]
1592 \begin_layout Description
1593 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1596 \begin_layout Subsection*
1600 \begin_layout Description
1601 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1604 \begin_layout Description
1605 Notion Usually bound to M-x shortcut.
1608 \begin_layout Description
1609 Syntax command-execute
1612 \begin_layout Subsection*
1616 \begin_layout Description
1617 Action Try to complete the word or command at the cursor position.
1620 \begin_layout Description
1624 \begin_layout Description
1625 Origin sts, Feb 19 2008
1628 \begin_layout Subsection*
1632 \begin_layout Description
1633 Action Accept suggested completion.
1636 \begin_layout Description
1637 Syntax completion-accept
1640 \begin_layout Description
1641 Origin sanda, Sep 08 2008
1644 \begin_layout Subsection*
1648 \begin_layout Description
1649 Action Try to cancel completion, either the popup or the inline completion.
1652 \begin_layout Description
1653 Syntax completion-cancel
1656 \begin_layout Description
1657 Origin sts, Sep 07 2008
1660 \begin_layout Subsection*
1664 \begin_layout Description
1665 Action Show the inline completion at the cursor position.
1668 \begin_layout Description
1669 Syntax completion-inline
1672 \begin_layout Description
1673 Origin sts, Feb 19 2008
1676 \begin_layout Subsection*
1680 \begin_layout Description
1681 Action Show the completion popup at the cursor position.
1684 \begin_layout Description
1685 Syntax completion-popup
1688 \begin_layout Description
1689 Origin sts, Feb 19 2008
1692 \begin_layout Subsection*
1696 \begin_layout Description
1697 Action Copies the current selection to the clipboard.
1700 \begin_layout Description
1704 \begin_layout Subsection*
1708 \begin_layout Description
1709 Action Cuts to the clipboard.
1712 \begin_layout Description
1716 \begin_layout Subsection*
1720 \begin_layout Description
1721 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1724 \begin_layout Description
1725 Syntax depth-decrement
1728 \begin_layout Subsection*
1732 \begin_layout Description
1733 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1736 \begin_layout Description
1737 Syntax depth-increment
1740 \begin_layout Subsection*
1741 dialog-disconnect-inset
1744 \begin_layout Description
1745 Action Closes opened connection to opened inset.
1748 \begin_layout Description
1749 Notion Connection is used for apply functions.
1752 \begin_layout Description
1753 Syntax dialog-disconnect-inset <INSET-NAME>
1756 \begin_layout Description
1757 Origin leeming, 25 Feb 2003
1760 \begin_layout Subsection*
1764 \begin_layout Description
1765 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1768 \begin_layout Description
1769 Syntax dialog-hide <NAME>
1772 \begin_layout Description
1773 Params See LFUN_DIALOG_SHOW .
1776 \begin_layout Description
1777 Origin leeming, 25 Feb 2003
1780 \begin_layout Subsection*
1784 \begin_layout Description
1785 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1788 \begin_layout Description
1789 Syntax dialog-show <NAME> [<DATA>]
1792 \begin_layout Description
1793 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1794 \begin_inset Newline newline
1797 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1798 \begin_inset Newline newline
1801 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1802 \begin_inset Newline newline
1805 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1806 \begin_inset Newline newline
1809 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1810 \begin_inset Newline newline
1813 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1814 \begin_inset Newline newline
1817 <SPECIAL>: latexlog|vclog
1818 \begin_inset Newline newline
1821 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1824 \begin_layout Description
1825 Origin leeming, 17 Jun 2003
1828 \begin_layout Subsection*
1829 dialog-show-new-inset
1832 \begin_layout Description
1833 Action Shows hidden dialog or create new one for a given inset settings etc.
1836 \begin_layout Description
1837 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1840 \begin_layout Description
1841 Syntax dialog-show-new-inset <NAME> [<DATA>]
1844 \begin_layout Description
1845 Params See LFUN_DIALOG_SHOW .
1848 \begin_layout Description
1849 Origin leeming, 25 Feb 2003
1852 \begin_layout Subsection*
1856 \begin_layout Description
1857 Action Toggles dialog between showed/hidden state.
1860 \begin_layout Description
1861 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1864 \begin_layout Description
1865 Syntax dialog-toggle <NAME> [<DATA>]
1868 \begin_layout Description
1869 Params See LFUN_DIALOG_SHOW .
1872 \begin_layout Description
1873 Origin spitz, 30 Apr 2007
1876 \begin_layout Subsection*
1880 \begin_layout Description
1881 Action Updates the dialog values from the inset/paragraph/document.
1884 \begin_layout Description
1885 Syntax dialog-update <NAME>
1888 \begin_layout Description
1889 Params <NAME>: paragraph|prefs|<INSET>
1890 \begin_inset Newline newline
1896 \begin_layout Description
1897 Origin leeming, 25 Feb 2003
1900 \begin_layout Subsection*
1904 \begin_layout Description
1905 Action Moves the cursor one line in downward direction.
1908 \begin_layout Description
1912 \begin_layout Subsection*
1916 \begin_layout Description
1917 Action Moves the cursor one line in downward direction adding the current position to the selection.
1920 \begin_layout Description
1924 \begin_layout Subsection*
1928 \begin_layout Description
1929 Action Inserts an ERT inset.
1932 \begin_layout Description
1936 \begin_layout Description
1937 Origin Jug, 18 Feb 2000
1940 \begin_layout Subsection*
1944 \begin_layout Description
1945 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1948 \begin_layout Description
1952 \begin_layout Description
1953 Origin Lgb, 17 May 2001
1956 \begin_layout Subsection*
1960 \begin_layout Description
1961 Action Cancel background export process.
1964 \begin_layout Description
1965 Syntax export-cancel
1968 \begin_layout Description
1969 Origin rgh, 10 December 2017
1972 \begin_layout Subsection*
1976 \begin_layout Description
1977 Action Inserts another LyX file.
1980 \begin_layout Description
1981 Syntax file-insert [<FILE>] [ignorelang]
1984 \begin_layout Description
1985 Params <FILE>: Filename to be inserted. ignorelang: If given, the (main) language of the inserted file is ignored (the context language is used).
1988 \begin_layout Subsection*
1989 file-insert-plaintext
1992 \begin_layout Description
1993 Action Inserts plain text file.
1996 \begin_layout Description
1997 Syntax file-insert-plaintext [<FILE>]
2000 \begin_layout Description
2001 Params <FILE>: Filename to be inserted.
2004 \begin_layout Description
2005 Origin CFO-G, 19 Nov 1997
2008 \begin_layout Subsection*
2009 file-insert-plaintext-para
2012 \begin_layout Description
2013 Action Inserts plain text file as paragraph (i.e. join lines).
2016 \begin_layout Description
2017 Syntax file-insert-plaintext-para [<FILE>]
2020 \begin_layout Description
2021 Params <FILE>: Filename to be inserted.
2024 \begin_layout Description
2025 Origin Levon, 14 Feb 2001
2028 \begin_layout Subsection*
2032 \begin_layout Description
2033 Action Inserts CharStyle, Custom inset or XML short element.
2036 \begin_layout Description
2037 Notion Look into the Customization manual for more information about these elements.
2038 \begin_inset Newline newline
2041 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.
2042 \begin_inset Newline newline
2045 For dissolving the element see LFUN_INSET_DISSOLVE.
2048 \begin_layout Description
2049 Syntax flex-insert Name
2052 \begin_layout Description
2053 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.
2056 \begin_layout Description
2057 Sample flex-insert Code
2060 \begin_layout Subsection*
2064 \begin_layout Description
2065 Action Inserts a float inset.
2068 \begin_layout Description
2069 Syntax float-insert <TYPE>
2072 \begin_layout Description
2073 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2076 \begin_layout Description
2077 Origin Lgb, 27 Jun 2000
2080 \begin_layout Subsection*
2084 \begin_layout Description
2085 Action Inserts the list of floats in the document.
2088 \begin_layout Description
2089 Syntax float-list-insert <TYPE>
2092 \begin_layout Description
2093 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2096 \begin_layout Description
2097 Origin Lgb, 3 May 2001
2100 \begin_layout Subsection*
2104 \begin_layout Description
2105 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2108 \begin_layout Description
2109 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2112 \begin_layout Description
2113 Syntax float-wide-insert <TYPE>
2116 \begin_layout Description
2117 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2120 \begin_layout Description
2121 Origin Lgb, 31 Oct 2001
2124 \begin_layout Subsection*
2128 \begin_layout Description
2129 Action Inserts a footnote inset.
2132 \begin_layout Description
2133 Syntax footnote-insert
2136 \begin_layout Description
2137 Origin Jug, 7 Mar 2000
2140 \begin_layout Subsection*
2144 \begin_layout Description
2145 Action Reloads the image if necessary.
2148 \begin_layout Description
2149 Syntax graphics-reload
2152 \begin_layout Description
2153 Origin vfr, 10 Aug 2009
2156 \begin_layout Subsection*
2160 \begin_layout Description
2161 Action Set the group for the graphics inset on the cursor position.
2164 \begin_layout Description
2165 Syntax graphics-set-group [<GROUP>]
2168 \begin_layout Description
2169 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
2172 \begin_layout Description
2173 Origin sanda, 6 May 2008
2176 \begin_layout Subsection*
2180 \begin_layout Description
2181 Action Set the same group for all graphics insets in the marked block.
2184 \begin_layout Description
2185 Syntax graphics-unify [<GROUP>]
2188 \begin_layout Description
2189 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the group Id from the first graphics inset will be used.
2192 \begin_layout Description
2193 Origin sanda, 7 Feb 2018
2196 \begin_layout Subsection*
2200 \begin_layout Description
2201 Action Inserts hyperlinks into the document (clickable in pdf output).
2204 \begin_layout Description
2205 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2208 \begin_layout Description
2209 Syntax href-insert [<TARGET>]
2212 \begin_layout Description
2213 Origin CFO-G, 21 Nov 1997
2216 \begin_layout Subsection*
2220 \begin_layout Description
2221 Action Only active in IPA inset.
2224 \begin_layout Description
2225 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.
2228 \begin_layout Description
2232 \begin_layout Description
2233 Origin spitz, 20 May 2012
2236 \begin_layout Subsection*
2240 \begin_layout Description
2241 Action Inserts Index entry.
2244 \begin_layout Description
2245 Notion It automatically takes the word on the cursor position.
2248 \begin_layout Description
2249 Syntax index-insert [<TYPE:Name>]
2252 \begin_layout Description
2253 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2256 \begin_layout Description
2257 Origin leeming, 3 Aug 2000
2260 \begin_layout Subsection*
2264 \begin_layout Description
2265 Action Inserts list of Index entries on a new page.
2268 \begin_layout Description
2269 Syntax index-print [<TYPE:Name>]
2272 \begin_layout Description
2273 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2276 \begin_layout Description
2277 Origin Lgb, 27 Feb 1997
2280 \begin_layout Subsection*
2284 \begin_layout Description
2285 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2288 \begin_layout Description
2289 Notion Apart from lfun arguments you can use the following method:
2290 \begin_inset Newline newline
2293 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2294 \begin_inset Newline newline
2297 2. select the text and run info-insert lfun.
2300 \begin_layout Description
2301 Syntax info-insert <TYPE> <ARG>
2304 \begin_layout Description
2305 Params <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
2306 \begin_inset Newline newline
2309 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2310 \begin_inset Newline newline
2313 date: current date (formatted and localized)
2314 \begin_inset Newline newline
2317 moddate: date of last modification (saving) (formatted and localized)
2318 \begin_inset Newline newline
2321 fixdate: a static date (formatted and localized)
2322 \begin_inset Newline newline
2325 time: current time (formatted and localized)
2326 \begin_inset Newline newline
2329 modtime: time of last modification (saving) (formatted and localized)
2330 \begin_inset Newline newline
2333 fixtime: a static time (formatted and localized)
2334 \begin_inset Newline newline
2337 shortcut[s]: name of lfun (e.g math-insert
2340 \begin_inset Newline newline
2343 lyxrc: name of rc_entry (e.g. bind_file)
2344 \begin_inset Newline newline
2347 lyxinfo: "version" - used version of LyX
2348 \begin_inset Newline newline
2351 package: name of latex package (e.g. listings)
2352 \begin_inset Newline newline
2355 textclass: name of textclass (e.g. article)
2356 \begin_inset Newline newline
2359 menu: name of lfun used in menu
2360 \begin_inset Newline newline
2363 l7n: localizable string.
2364 \begin_inset Newline newline
2367 icon: icon of lfun used in toolbar or direct icon name
2368 \begin_inset Newline newline
2371 buffer: "name"|"name-noext"|"path"|"class" vcs: "tree-revision"|"revision"|"author"|"date"|"time"
2374 \begin_layout Description
2375 Sample command-sequence info-insert buffer path; info-insert buffer name
2378 \begin_layout Description
2379 Origin bpeng, 7 Oct 2007
2382 \begin_layout Subsection*
2386 \begin_layout Description
2387 Action Apply data for an inset.
2390 \begin_layout Description
2391 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.
2394 \begin_layout Description
2395 Syntax inset-apply <ARGS>
2398 \begin_layout Description
2399 Params See LFUN_INSET_INSERT .
2402 \begin_layout Subsection*
2406 \begin_layout Description
2407 Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
2410 \begin_layout Description
2414 \begin_layout Description
2415 Origin lasgouttes, 16 Mar 2009
2418 \begin_layout Subsection*
2422 \begin_layout Description
2423 Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
2426 \begin_layout Description
2427 Syntax inset-begin-select
2430 \begin_layout Description
2431 Origin lasgouttes, 16 Mar 2009
2434 \begin_layout Subsection*
2438 \begin_layout Description
2439 Action Copies the inset to the clipboard as a certain type.
2442 \begin_layout Description
2443 Notion Currently used only for InsetInfo where its content is copied as a text.
2446 \begin_layout Description
2447 Syntax inset-copy-as
2450 \begin_layout Description
2451 Origin vfr, 18 Apr 2010
2454 \begin_layout Subsection*
2458 \begin_layout Description
2459 Action Dissolve the current inset into text.
2462 \begin_layout Description
2463 Syntax inset-dissolve [<INSET>]
2466 \begin_layout Description
2467 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.
2468 \begin_inset Newline newline
2471 For values see lyx::InsetLayout::lyxtype_ .
2474 \begin_layout Description
2475 Origin JSpitz, 7 Aug 2006
2478 \begin_layout Subsection*
2482 \begin_layout Description
2483 Action Edit the inset at cursor with an external application, if one is attributed. If the inset is file based, the referenced file is edited. Otherwise, the inset contents is written to a temporary file, the inset is locked, and the temporary file is edited. In this case, LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished.
2486 \begin_layout Description
2487 Syntax inset-edit [<INSET_PARAMS>]
2490 \begin_layout Description
2491 Params <INSET_PARAMS>: Parameters for the inset.
2492 \begin_inset Newline newline
2495 Currently only the filename will be considered.
2498 \begin_layout Description
2499 Origin spitz, 27 Apr 2006
2502 \begin_layout Subsection*
2506 \begin_layout Description
2507 Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
2510 \begin_layout Description
2514 \begin_layout Description
2515 Origin lasgouttes, 16 Mar 2009
2518 \begin_layout Subsection*
2522 \begin_layout Description
2523 Action End editing the inset at cursor with an external application. This replaces the inset contents with the contents of the temporary file, deletes the file and unlocks the inset.
2526 \begin_layout Description
2527 Syntax inset-end-edit
2530 \begin_layout Description
2531 Origin gb, 11 Oct 2015
2534 \begin_layout Subsection*
2538 \begin_layout Description
2539 Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
2542 \begin_layout Description
2543 Syntax inset-end-select
2546 \begin_layout Description
2547 Origin lasgouttes, 16 Mar 2009
2550 \begin_layout Subsection*
2554 \begin_layout Description
2555 Action Apply the given commands on insets of a given name.
2558 \begin_layout Description
2559 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.
2562 \begin_layout Description
2563 Syntax inset-forall <NAME> <LFUN-COMMAND>
2564 \begin_inset Newline newline
2567 <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.
2570 \begin_layout Description
2571 Sample Remove all index insets:
2572 \begin_inset Newline newline
2575 inset-forall Index char-delete-forward force
2576 \begin_inset Newline newline
2579 Close all Notes (also works for a particular branch, for example):
2580 \begin_inset Newline newline
2583 inset-forall Note inset-toggle close
2584 \begin_inset Newline newline
2587 Transform all yellow notes to comments
2588 \begin_inset Newline newline
2591 inset-forall Note:Note inset-modify note Note Comment
2592 \begin_inset Newline newline
2595 Try to put LyX in an infinite loop if there is at least a Note:
2596 \begin_inset Newline newline
2599 inset-forall Note char-backward
2602 \begin_layout Description
2603 Origin lasgouttes, 27 Nov 2009
2606 \begin_layout Subsection*
2610 \begin_layout Description
2611 Action Insert new inset (type given by the parameters).
2614 \begin_layout Description
2615 Syntax inset-insert <INSET> <ARGS>
2618 \begin_layout Description
2619 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2620 \begin_inset Newline newline
2623 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2624 \begin_inset Newline newline
2627 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2630 \begin_layout Description
2631 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2634 \begin_inset Newline newline
2637 where <label name> is the name of the referenced label and <Format> is one of the following:
2638 \begin_inset Newline newline
2642 \begin_inset Newline newline
2645 eqref -- (<reference>)
2646 \begin_inset Newline newline
2650 \begin_inset Newline newline
2653 vpageref -- on <page>
2654 \begin_inset Newline newline
2657 vref -- <reference> on <page>
2658 \begin_inset Newline newline
2661 formatted -- Formatted reference
2664 \begin_layout Subsection*
2668 \begin_layout Description
2669 Action Modify some properties of an inset.
2672 \begin_layout Description
2673 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.
2676 \begin_layout Description
2677 Syntax inset-modify <INSET> <ARGS>
2678 \begin_inset Newline newline
2681 inset-modify changetype <TYPE>
2684 \begin_layout Description
2685 Sample Change a Note inset into a Comment inset:
2686 \begin_inset Newline newline
2689 inset-modify note Note Comment
2690 \begin_inset Newline newline
2693 Change a Box into an Ovalbox:
2694 \begin_inset Newline newline
2697 inset-modify changetype Ovalbox
2698 \begin_inset Newline newline
2701 Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
2702 \begin_inset Newline newline
2705 inset-modify changetype els
2706 \begin_inset Newline newline
2709 Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
2710 \begin_inset Newline newline
2713 inset-modify changetype e..
2714 \begin_inset Newline newline
2720 \begin_layout Subsection*
2724 \begin_layout Description
2725 Action Select all contents of an inset.
2728 \begin_layout Description
2729 Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2732 \begin_layout Description
2733 Syntax inset-select-all
2736 \begin_layout Description
2737 Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
2740 \begin_layout Subsection*
2744 \begin_layout Description
2745 Action Open the inset's properties dialog.
2748 \begin_layout Description
2749 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.
2752 \begin_layout Description
2753 Syntax inset-settings <INSET>
2756 \begin_layout Description
2757 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2758 \begin_inset Newline newline
2761 graphics|href|include|index|index_print|label|line|
2762 \begin_inset Newline newline
2765 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2768 \begin_layout Subsection*
2772 \begin_layout Description
2773 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2776 \begin_layout Description
2777 Syntax inset-toggle [<ARG>]
2780 \begin_layout Description
2781 Params <ARG>: <open|close|toggle|assign>.
2782 \begin_inset Newline newline
2785 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2786 \begin_inset Newline newline
2789 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2792 \begin_layout Description
2793 Origin lasgouttes, 19 Jul 2001
2796 \begin_layout Subsection*
2800 \begin_layout Description
2801 Action Inserts an IPA inset.
2804 \begin_layout Description
2808 \begin_layout Description
2809 Origin spitz, 05 Mar 2012
2812 \begin_layout Subsection*
2816 \begin_layout Description
2817 Action Inserts special IPA macros into the document.
2820 \begin_layout Description
2821 Syntax ipamacro-insert <CHAR>
2824 \begin_layout Description
2825 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2828 \begin_layout Description
2829 Origin spitz, 22 Aug 2012
2832 \begin_layout Subsection*
2836 \begin_layout Description
2837 Action Turn off the loaded keyboard map.
2840 \begin_layout Description
2844 \begin_layout Subsection*
2848 \begin_layout Description
2849 Action Turn on the primary keyboard map.
2852 \begin_layout Description
2853 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.
2854 \begin_inset Newline newline
2857 The language is to be set in the Preferences dialog.
2860 \begin_layout Description
2861 Syntax keymap-primary
2864 \begin_layout Subsection*
2868 \begin_layout Description
2869 Action Turn on the secondary keyboard map.
2872 \begin_layout Description
2873 Syntax keymap-secondary
2876 \begin_layout Subsection*
2880 \begin_layout Description
2881 Action Toggles keyboard maps (first/second/off).
2884 \begin_layout Description
2885 Syntax keymap-toggle
2888 \begin_layout Description
2889 Origin leeming, 30 Mar 2004
2892 \begin_layout Subsection*
2893 label-copy-as-reference
2896 \begin_layout Description
2897 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2900 \begin_layout Description
2901 Syntax copy-label-as-reference <LABEL>
2904 \begin_layout Description
2905 Params <LABEL>: The label to copy (for multi-line math)
2908 \begin_layout Description
2909 Origin sts, 16 Nov 2008
2912 \begin_layout Subsection*
2916 \begin_layout Description
2917 Action Goto a label.
2920 \begin_layout Description
2921 Syntax label-goto [<LABEL>]
2924 \begin_layout Description
2925 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.
2928 \begin_layout Description
2929 Origin Ale, 6 Aug 1997
2932 \begin_layout Subsection*
2936 \begin_layout Description
2937 Action Inserts label to text or displayed formula.
2940 \begin_layout Description
2941 Syntax label-insert [<LABEL>]
2944 \begin_layout Description
2945 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2948 \begin_layout Subsection*
2949 label-insert-as-reference
2952 \begin_layout Description
2953 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2956 \begin_layout Description
2957 Syntax label-insert-as-reference
2960 \begin_layout Description
2961 Origin vfr, 7 Apr 2009
2964 \begin_layout Subsection*
2968 \begin_layout Description
2969 Action Set language from the current cursor position.
2972 \begin_layout Description
2973 Syntax language <LANG> [set]
2976 \begin_layout Description
2977 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).
2980 \begin_layout Description
2981 Origin Dekel, 2 Mar 2000
2984 \begin_layout Subsection*
2988 \begin_layout Description
2989 Action Move the cursor to the beginning of the (screen) line.
2992 \begin_layout Description
2996 \begin_layout Subsection*
3000 \begin_layout Description
3001 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3004 \begin_layout Description
3005 Syntax line-begin-select
3008 \begin_layout Subsection*
3012 \begin_layout Description
3013 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3016 \begin_layout Description
3017 Syntax line-delete-forward
3020 \begin_layout Subsection*
3024 \begin_layout Description
3025 Action Move the cursor to the end of the (screen) line.
3028 \begin_layout Description
3032 \begin_layout Subsection*
3036 \begin_layout Description
3037 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3040 \begin_layout Description
3041 Syntax line-end-select
3044 \begin_layout Subsection*
3048 \begin_layout Description
3049 Action Inserts a new listings inset.
3052 \begin_layout Description
3053 Syntax listing-insert
3056 \begin_layout Description
3057 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
3060 \begin_layout Subsection*
3064 \begin_layout Description
3065 Action Inserts a marginal note.
3068 \begin_layout Description
3069 Syntax marginalnote-insert
3072 \begin_layout Description
3073 Origin Lgb, 26 Jun 2000
3076 \begin_layout Subsection*
3080 \begin_layout Description
3081 Action Disable selecting of text-region.
3084 \begin_layout Description
3088 \begin_layout Subsection*
3092 \begin_layout Description
3093 Action Enable selecting of text-region.
3096 \begin_layout Description
3097 Notion After enabling you can simply move arrow keys to get selected region.
3100 \begin_layout Description
3104 \begin_layout Subsection*
3108 \begin_layout Description
3109 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3112 \begin_layout Description
3116 \begin_layout Description
3117 Origin Andre, May 5 2006
3120 \begin_layout Subsection*
3124 \begin_layout Description
3125 Action Inserts a line break or new line.
3128 \begin_layout Description
3129 Syntax newline-insert [<ARG>]
3132 \begin_layout Description
3133 Params <ARG>: <newline|linebreak> default: newline
3136 \begin_layout Description
3137 Origin spitz, 25 Mar 2008
3140 \begin_layout Subsection*
3144 \begin_layout Description
3145 Action Inserts a new page.
3148 \begin_layout Description
3149 Syntax newpage-insert <ARG>
3152 \begin_layout Description
3153 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
3156 \begin_layout Description
3157 Origin uwestoehr, 24 Nov 2007
3160 \begin_layout Subsection*
3164 \begin_layout Description
3165 Action Inserts Nomenclature entry.
3168 \begin_layout Description
3169 Notion It automatically takes the word on the cursor position if no symbol is given.
3172 \begin_layout Description
3173 Syntax nomencl-insert [<SYMBOL>]
3176 \begin_layout Description
3177 Origin Ugras, 4 Nov 2006
3180 \begin_layout Subsection*
3184 \begin_layout Description
3185 Action Inserts list of Nomenclature entries.
3188 \begin_layout Description
3189 Syntax nomenclature-print
3192 \begin_layout Description
3193 Origin Ugras, 4 Nov 2006
3196 \begin_layout Subsection*
3200 \begin_layout Description
3201 Action Inserts Note on the current cursor position, move selection inside the inset.
3204 \begin_layout Description
3205 Syntax note-insert [<TYPE>]
3208 \begin_layout Description
3209 Params <TYPE>: <Note|Greyedout|Comment> default: Note
3212 \begin_layout Subsection*
3216 \begin_layout Description
3217 Action Moves the cursor to the beginning of next Note inset.
3220 \begin_layout Description
3224 \begin_layout Subsection*
3228 \begin_layout Description
3229 Action Move the current group in the downward direction in the structure of the document.
3232 \begin_layout Description
3233 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3236 \begin_layout Description
3240 \begin_layout Description
3241 Origin Vermeer, 23 Mar 2006
3244 \begin_layout Subsection*
3248 \begin_layout Description
3249 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3252 \begin_layout Description
3253 Notion Part -> Chapter -> Section -> etc.
3256 \begin_layout Description
3260 \begin_layout Description
3261 Origin Vermeer, 23 Mar 2006
3264 \begin_layout Subsection*
3268 \begin_layout Description
3269 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3272 \begin_layout Description
3273 Notion Part <- Chapter <- Section <- etc.
3276 \begin_layout Description
3280 \begin_layout Description
3281 Origin Vermeer, 23 Mar 2006
3284 \begin_layout Subsection*
3288 \begin_layout Description
3289 Action Move the current group in the upward direction in the structure of the document.
3292 \begin_layout Description
3293 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3296 \begin_layout Description
3300 \begin_layout Description
3301 Origin Vermeer, 23 Mar 2006
3304 \begin_layout Subsection*
3308 \begin_layout Description
3309 Action Breaks the current paragraph at the current location.
3312 \begin_layout Description
3313 Notion Removes the selection.
3316 \begin_layout Description
3317 Syntax paragraph-break [<LAYOUT>] [ignoresep]
3320 \begin_layout Description
3321 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
3322 \begin_inset Newline newline
3325 ignoresep: Do not account for paragraph separators while breaking.
3328 \begin_layout Subsection*
3332 \begin_layout Description
3333 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
3336 \begin_layout Description
3337 Syntax paragraph-down
3340 \begin_layout Description
3341 Origin Asger, 1 Oct 1996
3344 \begin_layout Subsection*
3345 paragraph-down-select
3348 \begin_layout Description
3349 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
3352 \begin_layout Description
3353 Syntax paragraph-down-select
3356 \begin_layout Description
3357 Origin Asger, 1 Oct 1996
3360 \begin_layout Subsection*
3364 \begin_layout Description
3365 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.
3368 \begin_layout Description
3369 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.
3372 \begin_layout Description
3373 Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
3376 \begin_layout Description
3377 Params <PAR_ID>: paragraph id
3378 \begin_inset Newline newline
3381 <POS_IN_PAR>: desired position within the paragraph
3384 \begin_layout Description
3385 Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
3388 \begin_layout Subsection*
3392 \begin_layout Description
3393 Action Moves the current paragraph downwards in the document.
3396 \begin_layout Description
3397 Syntax paragraph-move-down
3400 \begin_layout Description
3401 Origin Edwin, 8 Apr 2006
3404 \begin_layout Subsection*
3408 \begin_layout Description
3409 Action Moves the current paragraph upwards in the document.
3412 \begin_layout Description
3413 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
3416 \begin_layout Description
3417 Syntax paragraph-move-up
3420 \begin_layout Description
3421 Origin Edwin, 8 Apr 2006
3424 \begin_layout Subsection*
3428 \begin_layout Description
3429 Action Change paragraph settings.
3432 \begin_layout Description
3433 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.
3436 \begin_layout Description
3437 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3440 \begin_layout Description
3450 \begin_inset Newline newline
3455 paragraph_spacing default|single|onehalf|double|other SIZE
3456 \begin_inset Newline newline
3461 align block|left|right|center|default
3462 \begin_inset Newline newline
3467 labelwidthstring WIDTH|
3472 \begin_layout Description
3473 Origin rgh, Aug 15 2007
3476 \begin_layout Subsection*
3477 paragraph-params-apply
3480 \begin_layout Description
3481 Action Change paragraph settings.
3484 \begin_layout Description
3485 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
3488 \begin_layout Description
3489 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3492 \begin_layout Description
3493 Params For parameters see LFUN_PARAGRAPH_PARAMS
3496 \begin_layout Description
3497 Origin leeming, 30 Mar 2004
3500 \begin_layout Subsection*
3504 \begin_layout Description
3505 Action Move cursor to beginning of current paragraph and select to the end in downward direction
3508 \begin_layout Description
3509 Notion This function is by default bound to triple mouse click
3512 \begin_layout Description
3513 Syntax paragraph-select
3516 \begin_layout Description
3517 Origin Kornel, 16 Apr 2019
3520 \begin_layout Subsection*
3524 \begin_layout Description
3525 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
3528 \begin_layout Description
3532 \begin_layout Description
3533 Origin Asger, 1 Oct 1996
3536 \begin_layout Subsection*
3540 \begin_layout Description
3541 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
3544 \begin_layout Description
3545 Syntax paragraph-up-select
3548 \begin_layout Description
3549 Origin Asger, 1 Oct 1996
3552 \begin_layout Subsection*
3556 \begin_layout Description
3557 Action Pastes material (text or picture) from the active clipboard.
3560 \begin_layout Description
3561 Syntax paste [<TYPE>|<NUM>]
3564 \begin_layout Description
3565 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
3566 \begin_inset Newline newline
3569 <NUM>: number of the selection in the internal clipboard stack to be pasted.
3572 \begin_layout Subsection*
3576 \begin_layout Description
3577 Action Inserts phantom on the current cursor position, move selection inside the inset.
3580 \begin_layout Description
3581 Syntax phantom-insert [<TYPE>]
3584 \begin_layout Description
3585 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
3588 \begin_layout Description
3589 Origin uwestoehr, 30 Jan 2009
3592 \begin_layout Subsection*
3596 \begin_layout Description
3597 Action Inserts a new preview inset.
3600 \begin_layout Description
3601 Syntax preview-insert
3604 \begin_layout Description
3605 Origin vfr, 28 Mar 2010
3608 \begin_layout Subsection*
3609 primary-selection-paste
3612 \begin_layout Description
3613 Action Pastes the currently selected text.
3616 \begin_layout Description
3617 Notion Primary selection mechanism is linux-only thing.
3620 \begin_layout Description
3621 Syntax primary-selection-paste [<ARG>]
3624 \begin_layout Description
3625 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
3628 \begin_layout Subsection*
3632 \begin_layout Description
3633 Action Inserts quotes according to the type and quote-language preference.
3636 \begin_layout Description
3637 Notion Currently 15 different quote styles are distinguished (see params).
3640 \begin_layout Description
3641 Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
3644 \begin_layout Description
3645 Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
3646 \begin_inset Newline newline
3649 <SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
3650 \begin_inset Newline newline
3653 <STYLE>: 'british' for `British' quote style (with ``inner quotation'')
3654 \begin_inset Newline newline
3657 'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
3658 \begin_inset Newline newline
3661 'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
3662 \begin_inset Newline newline
3665 'danish' for >>Danish<< quote style (with >inner quotation<)
3666 \begin_inset Newline newline
3669 'english' for ``English'' quote style (with `inner quotation')
3670 \begin_inset Newline newline
3673 'french' for <<french>> quote style (with ``inner quotation'')
3674 \begin_inset Newline newline
3677 'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
3678 \begin_inset Newline newline
3681 'german' for ,,German`` quote style (with ,inner quotation`)
3682 \begin_inset Newline newline
3685 'plain' for "Plain" quote style (with 'inner quotation')
3686 \begin_inset Newline newline
3689 'polish' for ,,Polish'' quote style (with ,inner quotation')
3690 \begin_inset Newline newline
3693 'swedish' for ''Swedish'' quote style (with 'inner quotation')
3694 \begin_inset Newline newline
3697 'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
3698 \begin_inset Newline newline
3701 'swiss' for <<Swiss>> quote style (with <inner quotation>)
3702 \begin_inset Newline newline
3705 'russian' for <<Russian>> quote style (with ,,inner quotation``)
3706 \begin_inset Newline newline
3709 'dynamic' for Dynamic quotation marks which inherit the global document style
3710 \begin_inset Newline newline
3713 If no quote style is specified, the document-wide will be used.
3716 \begin_layout Subsection*
3720 \begin_layout Description
3721 Action Redoes the last thing undone.
3724 \begin_layout Description
3728 \begin_layout Subsection*
3732 \begin_layout Description
3733 Action Go to the next label or cross-reference.
3736 \begin_layout Description
3737 Syntax reference-next
3740 \begin_layout Description
3741 Origin Dekel, 14 Jan 2001
3744 \begin_layout Subsection*
3748 \begin_layout Description
3749 Action Repeat the given command.
3752 \begin_layout Description
3753 Notion fails when the repeat count is greater than 10000.
3756 \begin_layout Description
3757 Syntax repeat <COUNT> <LFUN-COMMAND>
3760 \begin_layout Description
3761 Origin Andre, 27 Oct 2003
3764 \begin_layout Subsection*
3768 \begin_layout Description
3769 Action Moves the cursor one page in downward direction.
3772 \begin_layout Description
3776 \begin_layout Subsection*
3780 \begin_layout Description
3781 Action Moves the cursor one screen in downward direction adding the current position to the selection.
3784 \begin_layout Description
3785 Syntax screen-down-select
3788 \begin_layout Subsection*
3792 \begin_layout Description
3793 Action Recenters the screen on the current cursor position.
3796 \begin_layout Description
3797 Syntax screen-recenter
3800 \begin_layout Subsection*
3804 \begin_layout Description
3805 Action Repositions the screen such that the cursor is visible.
3808 \begin_layout Description
3809 Syntax screen-show-cursor
3812 \begin_layout Description
3813 Origin vfr, 25 Mar 2009
3816 \begin_layout Subsection*
3820 \begin_layout Description
3821 Action Moves the cursor one page in upward direction.
3824 \begin_layout Description
3828 \begin_layout Subsection*
3832 \begin_layout Description
3833 Action Moves the cursor one page in upward direction adding the current position to the selection.
3836 \begin_layout Description
3837 Syntax screen-up-select
3840 \begin_layout Subsection*
3844 \begin_layout Description
3845 Action Inserts a subscript or superscript inset.
3848 \begin_layout Description
3849 Syntax script-insert <TYPE>
3852 \begin_layout Description
3853 Params <TYPE>: subscript|superscript
3856 \begin_layout Description
3857 Origin Georg, 23 Nov 2010
3860 \begin_layout Subsection*
3864 \begin_layout Description
3865 Action Scroll the buffer view.
3868 \begin_layout Description
3869 Notion Only scrolls the screen up or down; does not move the cursor.
3872 \begin_layout Description
3873 Syntax scroll <TYPE> <QUANTITY>
3876 \begin_layout Description
3877 Params <TYPE>: line|page
3878 \begin_inset Newline newline
3881 <QUANTITY>: up|down|<number>
3884 \begin_layout Description
3885 Origin Abdel, Dec 27 2007
3888 \begin_layout Subsection*
3892 \begin_layout Description
3893 Action Select the whole section.
3896 \begin_layout Description
3897 Notion The cursor should be in a section heading before calling this lfun.
3900 \begin_layout Description
3901 Syntax section-select
3904 \begin_layout Description
3905 Origin vfr, 05 May 2009
3908 \begin_layout Subsection*
3912 \begin_layout Description
3913 Action Pastes the internal selection text in permanent selection.
3916 \begin_layout Description
3917 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3920 \begin_layout Description
3921 Syntax selection-paste
3924 \begin_layout Description
3925 Origin lasgouttes, 14 Jan 2009
3928 \begin_layout Subsection*
3932 \begin_layout Description
3933 Action Inserts an environment separator or latex paragraph break.
3936 \begin_layout Description
3937 Syntax separator-insert [<ARG>]
3940 \begin_layout Description
3941 Params <ARG>: <plain|parbreak|latexpar> default: plain
3944 \begin_layout Description
3945 Origin ef, 2 May 2014
3948 \begin_layout Subsection*
3952 \begin_layout Description
3953 Action Inserts one of horizontal space insets.
3956 \begin_layout Description
3957 Syntax space-insert <NAME> [<LEN>]
3960 \begin_layout Description
3961 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3962 \begin_inset Newline newline
3965 Only in math mode: med and thick.
3966 \begin_inset Newline newline
3969 <LEN>: length for custom spaces (hspace, hspace* for protected)
3972 \begin_layout Description
3973 Origin spitz, 20 May 2003, Mar 17 2008
3976 \begin_layout Subsection*
3980 \begin_layout Description
3981 Action Inserts various characters into the document.
3984 \begin_layout Description
3985 Syntax specialchar-insert <CHAR>
3988 \begin_layout Description
3989 Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
3992 \begin_layout Description
3993 Origin spitz, 6 Dec 2007
3996 \begin_layout Subsection*
4000 \begin_layout Description
4001 Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4004 \begin_layout Description
4005 Syntax spelling-add [<STRING>] [<LANG>]
4008 \begin_layout Description
4009 Params <WORD>: word to add <LANG>: language name (see file languages)
4012 \begin_layout Description
4013 Origin spitz, 18 Jan 2010
4016 \begin_layout Subsection*
4017 spelling-continuously
4020 \begin_layout Description
4021 Action Toggle continuous spell checking.
4024 \begin_layout Description
4025 Syntax spelling-continuously
4028 \begin_layout Description
4029 Origin vfr, 24 March 2013
4032 \begin_layout Subsection*
4036 \begin_layout Description
4037 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.
4040 \begin_layout Description
4041 Syntax spelling-ignore [<WORD>] [<LANG>]
4044 \begin_layout Description
4045 Params <WORD>: word to ignore <LANG>: language name (see file languages)
4048 \begin_layout Description
4049 Origin spitz, 18 Jan 2010
4052 \begin_layout Subsection*
4056 \begin_layout Description
4057 Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
4060 \begin_layout Description
4061 Syntax spelling-remove [<STRING>] [<LANG>]
4064 \begin_layout Description
4065 Params <WORD>: word to remove <LANG>: language name (see file languages)
4068 \begin_layout Description
4069 Origin SWitt, 28 July 2010
4072 \begin_layout Subsection*
4076 \begin_layout Description
4077 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4080 \begin_layout Description
4081 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.
4084 \begin_layout Description
4088 \begin_layout Description
4089 Origin vfr, Sep 30 2008
4092 \begin_layout Subsection*
4096 \begin_layout Description
4097 Action Insert a tab into a listings inset.
4100 \begin_layout Description
4101 Notion It also works on a selection.
4104 \begin_layout Description
4108 \begin_layout Description
4109 Origin vfr, Sep 30 2008
4112 \begin_layout Subsection*
4116 \begin_layout Description
4117 Action Modify properties of tabulars and table-like math environments.
4120 \begin_layout Description
4121 Syntax tabular-feature <FEATURE> [<ARG>]
4124 \begin_layout Description
4125 Params Generally see LFUN_INSET_INSERT for further details.
4126 \begin_inset Newline newline
4129 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
4130 \begin_inset Newline newline
4133 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
4134 \begin_inset Newline newline
4137 set-line-top|set-line-bottom|set-line-left|set-line-right|
4138 \begin_inset Newline newline
4141 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4142 \begin_inset Newline newline
4145 set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
4146 \begin_inset Newline newline
4149 toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
4150 \begin_inset Newline newline
4153 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
4154 \begin_inset Newline newline
4157 valign-top|valign-bottom|valign-middle|longtabular-align-left|
4158 \begin_inset Newline newline
4161 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
4162 \begin_inset Newline newline
4165 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
4166 \begin_inset Newline newline
4169 reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|
4170 \begin_inset Newline newline
4173 set-longtabular|unset-longtabular|set-pwidth|
4174 \begin_inset Newline newline
4177 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
4178 \begin_inset Newline newline
4181 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
4182 \begin_inset Newline newline
4185 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
4186 \begin_inset Newline newline
4189 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4190 \begin_inset Newline newline
4193 set-special-column|set-special-multicolumn|set-special-multirow|
4194 \begin_inset Newline newline
4197 toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
4198 \begin_inset Newline newline
4201 set-interline-space|set-border-lines|tabular-valign-top|
4202 \begin_inset Newline newline
4205 tabular-valign-middle|tabular-valign-bottom|set-tabular-width|
4206 \begin_inset Newline newline
4209 toggle-varwidth-column Various math-environment features are handled as well, e.g. add-vline-left/right for
4210 \begin_inset Newline newline
4213 the Grid/Array environment.
4214 \begin_inset Newline newline
4217 <ARG>: additional argument for some commands, use debug mode to explore its values.
4220 \begin_layout Description
4221 Origin gm, 10 Dec 2015
4224 \begin_layout Subsection*
4228 \begin_layout Description
4229 Action Inserts table into the document.
4232 \begin_layout Description
4233 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4236 \begin_layout Description
4237 Syntax tabular-insert [<ROWS> <COLUMNS>]
4240 \begin_layout Description
4241 Params In case no arguments are given show insert dialog.
4244 \begin_layout Description
4245 Origin Jug, 12 Apr 2000
4248 \begin_layout Subsection*
4249 tabular-style-insert
4252 \begin_layout Description
4253 Action Inserts table of a given style into the document.
4256 \begin_layout Description
4257 Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
4260 \begin_layout Description
4261 Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
4264 \begin_layout Description
4265 Params Valid styles are the names of the files in lib/tabletemplates, minus _1x<n> and .lyx suffix.
4268 \begin_layout Description
4269 Origin spitz, 25 Mar 2019
4272 \begin_layout Subsection*
4276 \begin_layout Description
4277 Action Look up thesaurus entries with respect to the word under the cursor.
4280 \begin_layout Description
4281 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
4284 \begin_layout Description
4285 Params <STRING>: word to look up <LANG>: language (see file languages)
4288 \begin_layout Description
4289 Origin Levon, 20 Jul 2001
4292 \begin_layout Subsection*
4296 \begin_layout Description
4297 Action Undoes the last edit.
4300 \begin_layout Description
4304 \begin_layout Subsection*
4308 \begin_layout Description
4309 Action Inserts a single unicode character.
4312 \begin_layout Description
4313 Syntax unicode-insert <CHAR1> <CHAR2> ...
4316 \begin_layout Description
4317 Params <CHARn>: The character to insert, given as its code point, in hexadecimal.
4320 \begin_layout Description
4321 Sample unicode-insert 0x0100 0x0259
4324 \begin_layout Description
4325 Origin Lgb, 22 Oct 2006
4328 \begin_layout Subsection*
4332 \begin_layout Description
4333 Action Moves the cursor one line in upward direction.
4336 \begin_layout Description
4340 \begin_layout Subsection*
4344 \begin_layout Description
4345 Action Moves the cursor one line in upward direction adding the current position to the selection.
4348 \begin_layout Description
4352 \begin_layout Subsection*
4356 \begin_layout Description
4357 Action Moves the cursor to the logically previous beginning of a word.
4360 \begin_layout Description
4361 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.
4364 \begin_layout Description
4365 Syntax word-backward
4368 \begin_layout Subsection*
4369 word-backward-select
4372 \begin_layout Description
4373 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
4376 \begin_layout Description
4377 Notion See also LFUN_WORD_BACKWARD.
4380 \begin_layout Description
4381 Syntax word-backward-select
4384 \begin_layout Subsection*
4388 \begin_layout Description
4389 Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
4392 \begin_layout Description
4393 Syntax word-capitalize [<SEL_TYPE>]
4396 \begin_layout Description
4397 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.
4400 \begin_layout Subsection*
4401 word-delete-backward
4404 \begin_layout Description
4405 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
4408 \begin_layout Description
4409 Syntax word-delete-backward [force]
4412 \begin_layout Description
4413 Params force: Delete big insets, do not only select them.
4416 \begin_layout Subsection*
4420 \begin_layout Description
4421 Action Deletes characters to the end of the word (usually the "C+Delete" key).
4424 \begin_layout Description
4425 Syntax word-delete-forward [force]
4428 \begin_layout Description
4429 Params force: Delete big insets, do not only select them.
4432 \begin_layout Subsection*
4436 \begin_layout Description
4437 Action Search for next occurrence of a string.
4440 \begin_layout Description
4441 Syntax word-find [<DATA>]
4444 \begin_layout Description
4445 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).
4448 \begin_layout Description
4449 Origin Andre, Jan 7 2004
4452 \begin_layout Subsection*
4456 \begin_layout Description
4457 Action Search for a given string in backward direction.
4460 \begin_layout Description
4461 Notion Case sensitive, match words. If no argument given, last search repeated.
4464 \begin_layout Description
4465 Syntax word-find-backward [<STRING>]
4468 \begin_layout Description
4469 Origin Etienne, 20 Feb 1998
4472 \begin_layout Subsection*
4476 \begin_layout Description
4477 Action Search for a given string in forward direction.
4480 \begin_layout Description
4481 Notion Case sensitive, match words. If no argument given, last search repeated.
4484 \begin_layout Description
4485 Syntax word-find-forward [<STRING>]
4488 \begin_layout Description
4489 Origin Etienne, 16 Feb 1998
4492 \begin_layout Subsection*
4496 \begin_layout Description
4497 Action Search for next occurrence of a pattern.
4500 \begin_layout Description
4501 Syntax word-findadv [<DATA>]
4504 \begin_layout Description
4505 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).
4508 \begin_layout Description
4509 Origin Tommaso, Nov 15 2007
4512 \begin_layout Subsection*
4516 \begin_layout Description
4517 Action Moves the cursor to the logically next beginning of a word.
4520 \begin_layout Description
4521 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.
4524 \begin_layout Description
4528 \begin_layout Subsection*
4532 \begin_layout Description
4533 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
4536 \begin_layout Description
4537 Notion See also LFUN_WORD_FORWARD.
4540 \begin_layout Description
4541 Syntax word-forward-select
4544 \begin_layout Subsection*
4548 \begin_layout Description
4549 Action Moves the cursor to the next beginning of a word "on the left".
4552 \begin_layout Description
4553 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.
4556 \begin_layout Description
4560 \begin_layout Description
4561 Origin dov, 28 Oct 2007
4564 \begin_layout Subsection*
4568 \begin_layout Description
4569 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
4572 \begin_layout Description
4573 Notion See also LFUN_WORD_LEFT for exact details of the movement.
4576 \begin_layout Description
4577 Syntax word-left-select
4580 \begin_layout Description
4581 Origin dov, 28 Oct 2007
4584 \begin_layout Subsection*
4588 \begin_layout Description
4589 Action Change the words in the selection or word at cursor position to lower case.
4592 \begin_layout Description
4593 Syntax word-lowcase [<SEL_TYPE>]
4596 \begin_layout Description
4597 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.
4600 \begin_layout Subsection*
4604 \begin_layout Description
4605 Action Replace a string in the document.
4608 \begin_layout Description
4609 Syntax word-replace [<DATA>]
4612 \begin_layout Description
4613 Params <DATA>: data is of the form "<replacestring>
4614 \begin_inset Newline newline
4618 \begin_inset Newline newline
4621 <casesensitive> <matchword> <all> <forward> <findnext>"
4624 \begin_layout Description
4625 Origin Andre, Jan 7 2004
4628 \begin_layout Subsection*
4632 \begin_layout Description
4633 Action Moves the cursor to the next beginning of a word "on the right".
4636 \begin_layout Description
4637 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.
4640 \begin_layout Description
4644 \begin_layout Description
4645 Origin dov, 28 Oct 2007
4648 \begin_layout Subsection*
4652 \begin_layout Description
4653 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
4656 \begin_layout Description
4657 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
4660 \begin_layout Description
4661 Syntax word-right-select
4664 \begin_layout Description
4665 Origin dov, 28 Oct 2007
4668 \begin_layout Subsection*
4672 \begin_layout Description
4673 Action Puts the word where the cursor stands into the selection.
4676 \begin_layout Description
4680 \begin_layout Description
4681 Origin Andre, 11 Sep 2002
4684 \begin_layout Subsection*
4688 \begin_layout Description
4689 Action Change the words in the selection or word at cursor position to upper case.
4692 \begin_layout Description
4693 Syntax word-upcase [<SEL_TYPE>]
4696 \begin_layout Description
4697 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.
4700 \begin_layout Subsection*
4704 \begin_layout Description
4705 Action Inserts floats wrapped by the text around.
4708 \begin_layout Description
4709 Syntax wrap-insert <TYPE>
4712 \begin_layout Description
4713 Params <TYPE>: table|figure
4716 \begin_layout Description
4717 Origin Dekel, 7 Apr 2002
4720 \begin_layout Section
4721 Math Editor Functions
4724 \begin_layout Subsection*
4725 in-mathmacrotemplate
4728 \begin_layout Description
4729 Action Only active in Math Macro definition.
4732 \begin_layout Description
4733 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.
4736 \begin_layout Description
4737 Syntax in-mathmacrotemplate
4740 \begin_layout Description
4741 Origin sts, 06 January 2008
4744 \begin_layout Subsection*
4748 \begin_layout Description
4749 Action Inserts an extended matrix as provided by the amsmath package.
4752 \begin_layout Description
4753 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
4756 \begin_layout Description
4757 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created. Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix, smallmatrix, and matrix. The default is 'matrix'.
4760 \begin_layout Description
4761 Sample math-ams-matrix 3 3 bmatrix
4764 \begin_layout Subsection*
4768 \begin_layout Description
4769 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
4772 \begin_layout Description
4773 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
4776 \begin_layout Description
4777 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
4778 \begin_inset Newline newline
4781 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
4784 \begin_layout Description
4785 Sample math-bigdelim "Bigl" "
4792 \begin_layout Description
4793 Origin Enrico & Georg, 7 May 2006
4796 \begin_layout Subsection*
4800 \begin_layout Description
4801 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
4804 \begin_layout Description
4805 Syntax math-delim [<LEFT>] [<RIGHT>]
4808 \begin_layout Description
4809 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.
4812 \begin_layout Description
4813 Sample math-delim { rangle
4816 \begin_layout Description
4817 Origin Alejandro, 18 Jun 1996
4820 \begin_layout Subsection*
4824 \begin_layout Description
4825 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
4828 \begin_layout Description
4829 Syntax math-display [<ARG>]
4832 \begin_layout Description
4833 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
4836 \begin_layout Description
4837 Origin Alejandro, 18 Jun 1996
4840 \begin_layout Subsection*
4844 \begin_layout Description
4845 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
4848 \begin_layout Description
4849 Notion Selection can be used to determine the input for the external program.
4852 \begin_layout Description
4853 Syntax math-extern <LANG> [<COMMAND>]
4856 \begin_layout Description
4857 Params <LANG>: octave|maxima|maple|mathematica|script
4858 \begin_inset Newline newline
4861 where "script" stands for the external script (normalized expression will be passed)
4864 \begin_layout Description
4865 Sample math-extern maple simplify
4868 \begin_layout Description
4869 Origin Andre, 24 Apr 2001
4872 \begin_layout Subsection*
4876 \begin_layout Description
4877 Action Changes the text style used in math.
4880 \begin_layout Description
4881 Syntax math-font-style <STYLE>
4884 \begin_layout Description
4885 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
4886 \begin_inset Newline newline
4889 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
4892 \begin_layout Description
4893 Origin vfr, 9 jan 2009
4896 \begin_layout Subsection*
4900 \begin_layout Description
4901 Action Inserts math objects and symbols.
4904 \begin_layout Description
4905 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
4907 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
4909 frac{x}{y}" replaces "abc" with "
4911 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.
4914 \begin_layout Description
4915 Syntax math-insert <ARG>
4918 \begin_layout Description
4919 Params <ARG>: Symbol or LaTeX code to be inserted.
4922 \begin_layout Subsection*
4926 \begin_layout Description
4927 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.
4930 \begin_layout Description
4931 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
4934 \begin_layout Description
4935 Syntax math-limits [<STATE>]
4938 \begin_layout Description
4939 Params <STATE>: limits|nolimits
4942 \begin_layout Subsection*
4946 \begin_layout Description
4947 Action Inserts a math macro definition at the cursor position in the text.
4950 \begin_layout Description
4951 Syntax math-macro <NAME> [<NARGS>] [def]
4954 \begin_layout Description
4955 Params <NAME>: The name of the macro, e.g. "mymacro".
4956 \begin_inset Newline newline
4959 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
4962 \begin_layout Description
4963 Origin ale, 10 May 1997; sts, 21 Dec 2007
4966 \begin_layout Subsection*
4967 math-macro-add-greedy-optional-param
4970 \begin_layout Description
4971 Action Add a greedy optional parameter.
4974 \begin_layout Description
4975 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
4978 \begin_layout Description
4979 Syntax math-macro-add-greedy-optional-param
4982 \begin_layout Description
4983 Origin sts, 06 January 2008
4986 \begin_layout Subsection*
4987 math-macro-add-optional-param
4990 \begin_layout Description
4991 Action Add an optional parameter.
4994 \begin_layout Description
4995 Notion Insert an optional parameter just behind the already existing optional parameters.
4998 \begin_layout Description
4999 Syntax math-macro-add-optional-param
5002 \begin_layout Description
5003 Origin sts, 06 January 2008
5006 \begin_layout Subsection*
5007 math-macro-add-param
5010 \begin_layout Description
5011 Action Add a parameter.
5014 \begin_layout Description
5015 Notion Add a parameter to a Math Macro.
5018 \begin_layout Description
5019 Syntax math-macro-add-param <NUM>
5022 \begin_layout Description
5023 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.
5026 \begin_layout Description
5027 Origin sts, 06 January 2008
5030 \begin_layout Subsection*
5031 math-macro-append-greedy-param
5034 \begin_layout Description
5035 Action Append a greedy parameter.
5038 \begin_layout Description
5039 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
5042 \begin_layout Description
5043 Syntax math-macro-append-greedy-param
5046 \begin_layout Description
5047 Origin sts, 06 January 2008
5050 \begin_layout Subsection*
5054 \begin_layout Description
5055 Action Fold a Math Macro.
5058 \begin_layout Description
5059 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
5064 \begin_layout Description
5065 Syntax math-macro-fold
5068 \begin_layout Description
5069 Origin sts, 06 January 2008
5072 \begin_layout Subsection*
5073 math-macro-make-nonoptional
5076 \begin_layout Description
5077 Action Make a parameter non-optional.
5080 \begin_layout Description
5081 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.
5084 \begin_layout Description
5085 Syntax math-macro-make-nonoptional
5088 \begin_layout Description
5089 Origin sts, 06 January 2008
5092 \begin_layout Subsection*
5093 math-macro-make-optional
5096 \begin_layout Description
5097 Action Make a parameter optional.
5100 \begin_layout Description
5101 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
5104 \begin_layout Description
5105 Syntax math-macro-make-optional
5108 \begin_layout Description
5109 Origin sts, 06 January 2008
5112 \begin_layout Subsection*
5113 math-macro-remove-greedy-param
5116 \begin_layout Description
5117 Action Remove a greedy parameter.
5120 \begin_layout Description
5121 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.
5124 \begin_layout Description
5125 Syntax math-macro-remove-greedy-param
5128 \begin_layout Description
5129 Origin sts, 06 January 2008
5132 \begin_layout Subsection*
5133 math-macro-remove-optional-param
5136 \begin_layout Description
5137 Action Remove the last optional parameter.
5140 \begin_layout Description
5141 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
5144 \begin_layout Description
5145 Syntax math-macro-remove-optional-param
5148 \begin_layout Description
5149 Origin sts, 06 January 2008
5152 \begin_layout Subsection*
5153 math-macro-remove-param
5156 \begin_layout Description
5157 Action Remove the last parameter.
5160 \begin_layout Description
5161 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
5164 \begin_layout Description
5165 Syntax math-macro-remove-param <NUM>
5168 \begin_layout Description
5169 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
5172 \begin_layout Description
5173 Origin sts, 06 January 2008
5176 \begin_layout Subsection*
5180 \begin_layout Description
5181 Action Unfold a Math Macro.
5184 \begin_layout Description
5185 Notion Unfold the Math Macro the cursor is in, i.e. display it as
5190 \begin_layout Description
5191 Syntax math-macro-unfold
5194 \begin_layout Description
5195 Origin sts, 06 January 2008
5198 \begin_layout Subsection*
5202 \begin_layout Description
5203 Action Inserts a matrix.
5206 \begin_layout Description
5207 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
5210 \begin_layout Description
5211 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).
5214 \begin_layout Description
5215 Sample math-matrix 3 3 bccc
5218 \begin_layout Subsection*
5222 \begin_layout Description
5223 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.
5226 \begin_layout Description
5227 Notion If there is some selected text, it puts the text inside created math box.
5230 \begin_layout Description
5231 Syntax math-mode [on|<ARG>]
5234 \begin_layout Description
5235 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
5236 \begin_inset Newline newline
5239 "on": allow only entering of math mode from text mode.
5242 \begin_layout Description
5243 Origin Alejandro, 4 Jun 1996
5246 \begin_layout Subsection*
5250 \begin_layout Description
5251 Action Mutates the type of math inset to the newly selected one.
5254 \begin_layout Description
5255 Syntax math-mutate <TYPE>
5258 \begin_layout Description
5259 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
5262 \begin_layout Description
5263 Origin Andre, 23 May 2001
5266 \begin_layout Subsection*
5267 math-number-line-toggle
5270 \begin_layout Description
5271 Action Toggles numbering of the current formula line.
5274 \begin_layout Description
5275 Notion Must be in display formula mode.
5278 \begin_layout Description
5279 Syntax math-number-line-toggle
5282 \begin_layout Description
5283 Origin Alejandro, 18 Jun 1996
5286 \begin_layout Subsection*
5290 \begin_layout Description
5291 Action Toggles numbering/labeling of the current formula.
5294 \begin_layout Description
5295 Notion Must be in display formula mode.
5298 \begin_layout Description
5299 Syntax math-number-toggle
5302 \begin_layout Description
5303 Origin Alejandro, 4 Jun 1996
5306 \begin_layout Subsection*
5310 \begin_layout Description
5311 Action Changes arbitrarily the size used by math fonts inside a context.
5314 \begin_layout Description
5315 Notion Provides an interface to the LaTeX math mode font size commands.
5318 \begin_layout Description
5319 Syntax math-size <STYLE>
5322 \begin_layout Description
5334 \begin_layout Description
5335 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
5338 \begin_layout Subsection*
5342 \begin_layout Description
5343 Action Inserts space into math expression.
5346 \begin_layout Description
5347 Notion Use spacebar after entering this space to change type of space.
5350 \begin_layout Description
5351 Syntax math-space [<TYPE>] [<LEN>]
5354 \begin_layout Description
5355 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
5356 \begin_inset Newline newline
5359 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
5360 \begin_inset Newline newline
5363 custom space: hspace
5364 \begin_inset Newline newline
5367 "," used by default.
5368 \begin_inset Newline newline
5371 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
5372 \begin_inset Newline newline
5375 <LEN>: length for custom spaces (hspace)
5378 \begin_layout Description
5379 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
5382 \begin_layout Subsection*
5386 \begin_layout Description
5387 Action Enters subscript expression in math expression.
5390 \begin_layout Description
5391 Syntax math-subscript
5394 \begin_layout Description
5395 Origin vermeer, 12 Dec 2001
5398 \begin_layout Subsection*
5402 \begin_layout Description
5403 Action Enters superscript expression in math expression.
5406 \begin_layout Description
5407 Syntax math-superscript
5410 \begin_layout Description
5411 Origin vermeer, 12 Dec 2001
5414 \begin_layout Subsection*
5418 \begin_layout Description
5419 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
5422 \begin_layout Description
5423 Notion If there is any selected text, then it is moved inside the created regexp inset.
5426 \begin_layout Description
5427 Syntax regexp-mode [<ARG>]
5430 \begin_layout Description
5431 Params <ARG>: eventual argument (regular expression).
5434 \begin_layout Description
5435 Origin Tommaso, 4 Oct 2008
5438 \begin_layout Section
5439 Buffer Fuctions (File and Window related)
5442 \begin_layout Subsection*
5446 \begin_layout Description
5447 Action Activate the branch.
5450 \begin_layout Description
5451 Syntax branch-activate <BRANCH>
5454 \begin_layout Description
5455 Params <BRANCH>: The branch to activate
5458 \begin_layout Description
5459 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5460 \begin_inset Newline newline
5463 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5466 \begin_layout Description
5467 Origin rgh, 27 May 2008
5470 \begin_layout Subsection*
5474 \begin_layout Description
5475 Action Add a branch to the buffer's BranchList.
5478 \begin_layout Description
5479 Syntax branch-add <BRANCH>
5482 \begin_layout Description
5483 Params <BRANCH>: Name of the branch to add
5486 \begin_layout Description
5487 Origin spitz, 7 Jul 2009
5490 \begin_layout Subsection*
5494 \begin_layout Description
5495 Action Create new branch and directly put the branch inset into the document.
5498 \begin_layout Description
5499 Syntax branch-add-insert [<NAME>]
5502 \begin_layout Description
5503 Params <NAME>: Branch name. If it is not specified, you will be asked.
5506 \begin_layout Description
5507 Origin sanda, 10 Jul 2009
5510 \begin_layout Subsection*
5514 \begin_layout Description
5515 Action De-activate the branch.
5518 \begin_layout Description
5519 Syntax branch-deactivate <BRANCH>
5522 \begin_layout Description
5523 Params <BRANCH>: The branch to deactivate
5526 \begin_layout Description
5527 Origin rgh, 27 May 2008
5530 \begin_layout Subsection*
5534 \begin_layout Description
5535 Action Toggles inversion status of branch inset.
5538 \begin_layout Description
5539 Syntax branch-invert
5542 \begin_layout Description
5543 Origin rgheck, 12 July 2016
5546 \begin_layout Subsection*
5547 branch-master-activate
5550 \begin_layout Description
5551 Action Activate the branch in the master buffer.
5554 \begin_layout Description
5555 Syntax branch-master-activate <BRANCH>
5558 \begin_layout Description
5559 Params <BRANCH>: The branch to activate
5562 \begin_layout Description
5563 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5564 \begin_inset Newline newline
5567 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5570 \begin_layout Description
5571 Origin spitz, 30 Sep 2012
5574 \begin_layout Subsection*
5575 branch-master-deactivate
5578 \begin_layout Description
5579 Action De-activate the branch in the master buffer.
5582 \begin_layout Description
5583 Syntax branch-master-deactivate <BRANCH>
5586 \begin_layout Description
5587 Params <BRANCH>: The branch to deactivate
5590 \begin_layout Description
5591 Origin spitz, 30 Sep 2012
5594 \begin_layout Subsection*
5598 \begin_layout Description
5599 Action Rename all branches of a given name in a document.
5602 \begin_layout Description
5603 Syntax branches-rename <OLDNAME> <NEWNAME>
5606 \begin_layout Description
5607 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5610 \begin_layout Description
5611 Origin spitz, 9 Jul 2009
5614 \begin_layout Subsection*
5618 \begin_layout Description
5619 Action Saves the current buffer to a temporary file.
5622 \begin_layout Description
5623 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
5626 \begin_layout Description
5627 Syntax buffer-auto-save
5630 \begin_layout Subsection*
5634 \begin_layout Description
5635 Action Loads the given child document.
5638 \begin_layout Description
5639 Notion The current document is treated as a parent.
5642 \begin_layout Description
5643 Syntax buffer-child-open <FILE>
5646 \begin_layout Description
5647 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
5650 \begin_layout Description
5651 Origin Ale, 28 May 1997
5654 \begin_layout Subsection*
5658 \begin_layout Description
5659 Action Runs chktex for the current document.
5662 \begin_layout Description
5663 Syntax buffer-chktex
5666 \begin_layout Description
5667 Origin Asger, 30 Oct 1997
5670 \begin_layout Subsection*
5674 \begin_layout Description
5675 Action Closes the current buffer.
5678 \begin_layout Description
5679 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
5682 \begin_layout Description
5686 \begin_layout Subsection*
5690 \begin_layout Description
5691 Action Closes all buffers.
5694 \begin_layout Description
5695 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
5698 \begin_layout Description
5699 Syntax buffer-close-all
5702 \begin_layout Subsection*
5706 \begin_layout Description
5707 Action Exports the current buffer (document) to the given format.
5710 \begin_layout Description
5711 Syntax buffer-export [<FORMAT>] [<DEST>]
5714 \begin_layout Description
5715 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.
5716 \begin_inset Newline newline
5719 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.
5720 \begin_inset Newline newline
5723 If absent or "default", then the default output format of the document is used.
5724 \begin_inset Newline newline
5727 <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.
5730 \begin_layout Description
5731 Origin Lgb, 29 Jul 1997
5734 \begin_layout Subsection*
5738 \begin_layout Description
5739 Action Opens a dialog for exporting the current buffer.
5742 \begin_layout Description
5743 Syntax buffer-export-as [<FORMAT>]
5746 \begin_layout Description
5747 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.
5750 \begin_layout Description
5751 Sample buffer-export-as pdf2
5754 \begin_layout Description
5755 Origin tommaso, 6 Oct 2011
5758 \begin_layout Subsection*
5759 buffer-export-custom
5762 \begin_layout Description
5763 Action Exports the current buffer (document) from the given format using the given command on it.
5766 \begin_layout Description
5767 Syntax buffer-export-custom <FORMAT> <COMMAND>
5770 \begin_layout Description
5771 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
5772 \begin_inset Newline newline
5775 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
5778 \begin_layout Description
5779 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5782 \begin_layout Description
5783 Origin leeming, 27 Mar 2004
5786 \begin_layout Subsection*
5787 buffer-external-modification-clear
5790 \begin_layout Description
5791 Action Clear the external modification flag on the current buffer.
5794 \begin_layout Description
5795 Syntax buffer-external-modification-clear
5798 \begin_layout Description
5799 Origin gm, 2 March 2017
5802 \begin_layout Subsection*
5806 \begin_layout Description
5807 Action Applies a command to all non-hidden buffers.
5810 \begin_layout Description
5811 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
5814 \begin_layout Description
5815 Syntax buffer-forall <LFUN-COMMAND>
5818 \begin_layout Description
5819 Params <LFUN-COMMAND>: The command to be applied to the buffers.
5822 \begin_layout Description
5823 Sample Close all Notes in buffers:
5824 \begin_inset Newline newline
5827 buffer-forall inset-forall Note inset-toggle close
5828 \begin_inset Newline newline
5831 Toggle change tracking on buffers:
5832 \begin_inset Newline newline
5835 buffer-forall changes-track
5836 \begin_inset Newline newline
5839 Toggle read-only for buffers:
5840 \begin_inset Newline newline
5843 buffer-forall buffer-toggle-read-only
5844 \begin_inset Newline newline
5847 Show statistics for individual buffers:
5848 \begin_inset Newline newline
5851 buffer-forall statistics
5852 \begin_inset Newline newline
5855 Activate the branch named "Solutions" in buffers:
5856 \begin_inset Newline newline
5859 buffer-forall branch-activate Solutions
5860 \begin_inset Newline newline
5863 Export buffers to PDF (pdflatex):
5864 \begin_inset Newline newline
5867 buffer-forall buffer-export pdf2
5868 \begin_inset Newline newline
5874 \begin_layout Description
5875 Origin skostysh, 20 Jul 2012
5878 \begin_layout Subsection*
5882 \begin_layout Description
5883 Action Import a given file as a lyx document.
5886 \begin_layout Description
5887 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.
5890 \begin_layout Description
5891 Syntax buffer-import <FORMAT> [<FILE>]
5894 \begin_layout Description
5895 Origin Asger, 24 Jul 1998
5898 \begin_layout Subsection*
5902 \begin_layout Description
5903 Action Set language of the current document.
5906 \begin_layout Description
5907 Syntax buffer-language <LANG>
5910 \begin_layout Description
5911 Params <LANG>: language name. See lib/languages for list.
5914 \begin_layout Description
5915 Origin leeming, 30 Mar 2004
5918 \begin_layout Subsection*
5922 \begin_layout Description
5923 Action Moves the current tab one spot to the right.
5926 \begin_layout Description
5927 Syntax buffer-move-next
5930 \begin_layout Description
5931 Origin skostysh, 7 Apr 2015
5934 \begin_layout Subsection*
5935 buffer-move-previous
5938 \begin_layout Description
5939 Action Moves the current tab one spot to the left.
5942 \begin_layout Description
5943 Syntax buffer-move-previous
5946 \begin_layout Description
5947 Origin skostysh, 7 Apr 2015
5950 \begin_layout Subsection*
5954 \begin_layout Description
5955 Action Creates a new buffer (that is, document) and switches to it.
5958 \begin_layout Description
5959 Notion Implicit path can be set in Preferences dialog.
5962 \begin_layout Description
5963 Syntax buffer-new [<FILE>]
5966 \begin_layout Description
5967 Params <FILE>: filename of created file with absolute path.
5970 \begin_layout Subsection*
5974 \begin_layout Description
5975 Action Creates a new buffer (that is, document) from a template.
5978 \begin_layout Description
5979 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
5982 \begin_layout Description
5983 Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
5986 \begin_layout Description
5987 Params <FILE>: filename of created file with absolute path. If empty or "newfile", a file with appropriate name is generated. <TEMPLATE FILE>: filename of template with absolute path. If empty, a dialog is opened to select the new file.
5990 \begin_layout Subsection*
5994 \begin_layout Description
5995 Action Switch to the next opened document.
5998 \begin_layout Description
5999 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
6002 \begin_layout Description
6006 \begin_layout Subsection*
6010 \begin_layout Description
6011 Action Apply the given settings to the current document.
6014 \begin_layout Description
6015 Syntax buffer-params-apply [<ARGS>]
6018 \begin_layout Description
6019 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6022 \begin_layout Description
6023 Origin leeming, 30 Mar 2004
6026 \begin_layout Subsection*
6030 \begin_layout Description
6031 Action Switch to the previous opened document.
6034 \begin_layout Description
6035 Syntax buffer-previous
6038 \begin_layout Subsection*
6042 \begin_layout Description
6043 Action Reverts opened document.
6046 \begin_layout Description
6047 Syntax buffer-reload [dump]
6050 \begin_layout Description
6051 Params dump: do not ask for any confirmation, just reload. All changes will be lost.
6054 \begin_layout Description
6055 Origin Asger, 2 Feb 1997
6058 \begin_layout Subsection*
6059 buffer-save-as-default
6062 \begin_layout Description
6063 Action Save the current document settings as default.
6066 \begin_layout Description
6067 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6070 \begin_layout Description
6071 Syntax buffer-save-as-default [<ARGS>]
6074 \begin_layout Description
6075 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
6078 \begin_layout Description
6079 Origin leeming, 30 Mar 2004
6082 \begin_layout Subsection*
6086 \begin_layout Description
6087 Action Display and switch to the given buffer.
6090 \begin_layout Description
6091 Syntax buffer-switch <BUFFER>
6094 \begin_layout Description
6095 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
6098 \begin_layout Subsection*
6099 buffer-toggle-compression
6102 \begin_layout Description
6103 Action Toggles compression of the current document on/off.
6106 \begin_layout Description
6107 Syntax buffer-toggle-compression
6110 \begin_layout Description
6111 Origin bpeng, 27 Apr 2006
6114 \begin_layout Subsection*
6115 buffer-toggle-read-only
6118 \begin_layout Description
6119 Action Toggle editing mode of the current document between read/write and read-only.
6122 \begin_layout Description
6123 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.
6126 \begin_layout Description
6127 Syntax buffer-toggle-read-only
6130 \begin_layout Description
6131 Origin Lgb, 27 May 1997
6134 \begin_layout Subsection*
6138 \begin_layout Description
6139 Action Exports the current document and put the result into the temporary directory.
6142 \begin_layout Description
6143 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).
6146 \begin_layout Description
6147 Syntax buffer-update [<FORMAT>]
6150 \begin_layout Description
6151 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.
6154 \begin_layout Description
6155 Origin Dekel, 5 Aug 2000
6158 \begin_layout Subsection*
6162 \begin_layout Description
6163 Action Displays current buffer in chosen format.
6166 \begin_layout Description
6167 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.
6170 \begin_layout Description
6171 Syntax buffer-view [<FORMAT>]
6174 \begin_layout Description
6175 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.
6178 \begin_layout Subsection*
6182 \begin_layout Description
6183 Action Opens the file that was created from last preview of this buffer.
6186 \begin_layout Description
6187 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.
6190 \begin_layout Description
6191 Syntax buffer-view-cache
6194 \begin_layout Subsection*
6198 \begin_layout Description
6199 Action Saves the current buffer.
6202 \begin_layout Description
6203 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.
6206 \begin_layout Description
6210 \begin_layout Subsection*
6214 \begin_layout Description
6215 Action Save all changed documents.
6218 \begin_layout Description
6219 Syntax buffer-write-all
6222 \begin_layout Description
6223 Origin rgh, gpothier 6 Aug 2007
6226 \begin_layout Subsection*
6230 \begin_layout Description
6231 Action Rename and save current buffer.
6234 \begin_layout Description
6235 Syntax buffer-write-as <FILENAME>
6238 \begin_layout Description
6239 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6242 \begin_layout Subsection*
6243 buffer-write-as-template
6246 \begin_layout Description
6247 Action Rename and save current buffer in the local templates directory.
6250 \begin_layout Description
6251 Syntax buffer-write-as-template <FILENAME>
6254 \begin_layout Description
6255 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
6258 \begin_layout Subsection*
6262 \begin_layout Description
6263 Action Sets the zoom of the screen fonts.
6266 \begin_layout Description
6267 Syntax buffer-zoom [<ZOOM>]
6270 \begin_layout Description
6271 Params <ZOOM>: The target zoom value in %; the default is the default zoom as saved in preferences.
6274 \begin_layout Description
6275 Origin daniel, 28 Oct 2016
6278 \begin_layout Subsection*
6282 \begin_layout Description
6283 Action Increases the zoom of the screen fonts.
6286 \begin_layout Description
6287 Syntax buffer-zoom-in [<ZOOM>]
6290 \begin_layout Description
6291 Params <ZOOM>: The zoom value addition in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6294 \begin_layout Description
6295 Origin vfr, 30 Mar 2009
6298 \begin_layout Subsection*
6302 \begin_layout Description
6303 Action Decreases the zoom of the screen fonts.
6306 \begin_layout Description
6307 Syntax buffer-zoom-out [<ZOOM>]
6310 \begin_layout Description
6311 Params <ZOOM>: The zoom value abstraction in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
6314 \begin_layout Description
6315 Origin vfr, 30 Mar 2009
6318 \begin_layout Subsection*
6322 \begin_layout Description
6323 Action Generates the code (literate programming).
6326 \begin_layout Description
6327 Notion Latex file with extension
6329 literate_extension is generated. Then LyX invokes
6331 build_command (with a default of ``make'') to generate the code and
6333 build_error_filter to process the compilation error messages.
6334 \begin_inset Newline newline
6337 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:
6338 \begin_inset Newline newline
6343 build_command "my_script my_arguments"
6344 \begin_inset Newline newline
6349 build_error_filter differs from the
6351 literate_error_filter only in that the former will identify error messages from your compiler.
6354 \begin_layout Description
6355 Syntax build-program
6358 \begin_layout Subsection*
6362 \begin_layout Description
6363 Action Open LyX document.
6366 \begin_layout Description
6367 Syntax file-open [<FILE>]
6370 \begin_layout Description
6371 Params <FILE>: Filename to be opened.
6374 \begin_layout Subsection*
6378 \begin_layout Description
6379 Action Open the given help file according to the language setting.
6382 \begin_layout Description
6383 Syntax help-open <FILE>[.lyx]
6386 \begin_layout Description
6387 Params <FILE>: any document from (/usr/share/)doc directory.
6390 \begin_layout Description
6391 Origin Jug, 27 Jun 1999
6394 \begin_layout Subsection*
6398 \begin_layout Description
6399 Action Sets icon size of toolbars.
6402 \begin_layout Description
6403 Syntax icon-size [<SIZE>]
6406 \begin_layout Description
6407 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).
6410 \begin_layout Description
6414 \begin_layout Subsection*
6418 \begin_layout Description
6419 Action Terminates the current LyX instance.
6422 \begin_layout Description
6423 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
6426 \begin_layout Description
6430 \begin_layout Subsection*
6431 master-buffer-export
6434 \begin_layout Description
6435 Action Exports the master buffer (document) to the given format.
6438 \begin_layout Description
6439 Syntax master-buffer-export [<FORMAT>] [<DEST>]
6442 \begin_layout Description
6443 Params <FORMAT> is one of the formats which you can find in Tools->Preferences->File formats->Format. Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
6444 \begin_inset Newline newline
6447 Note that "custom" is not allowed in this case.
6448 \begin_inset Newline newline
6451 If absent or "default", then the default output format of the document is used.
6452 \begin_inset Newline newline
6455 <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.
6458 \begin_layout Description
6459 Origin rkh, 18 April 2018
6462 \begin_layout Subsection*
6463 master-buffer-update
6466 \begin_layout Description
6467 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
6470 \begin_layout Description
6471 Syntax master-buffer-update [<FORMAT>]
6474 \begin_layout Description
6475 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.
6478 \begin_layout Description
6479 Origin Tommaso, 20 Sep 2007
6482 \begin_layout Subsection*
6486 \begin_layout Description
6487 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
6490 \begin_layout Description
6491 Syntax master-buffer-view [<FORMAT>]
6494 \begin_layout Description
6495 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.
6498 \begin_layout Description
6499 Origin Tommaso, 20 Sep 2007
6502 \begin_layout Subsection*
6506 \begin_layout Description
6507 Action Opens the menu given by its name.
6510 \begin_layout Description
6511 Syntax menu-open <NAME>
6514 \begin_layout Description
6515 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
6518 \begin_layout Subsection*
6522 \begin_layout Description
6523 Action Close the current tab group.
6526 \begin_layout Description
6527 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
6530 \begin_layout Description
6531 Syntax tab-group-close
6534 \begin_layout Description
6535 Origin Abdel, 21 Feb 2008
6538 \begin_layout Subsection*
6542 \begin_layout Description
6543 Action Toggles movability of a given toolbar between true/false.
6546 \begin_layout Description
6547 Syntax toolbar-movable <NAME>
6550 \begin_layout Description
6551 Params <NAME>: *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6554 \begin_layout Description
6555 Origin daniel, 12 July 2016
6558 \begin_layout Subsection*
6562 \begin_layout Description
6563 Action Toggles visibility of a given toolbar between on/off/auto.
6566 \begin_layout Description
6567 Notion Skipping "auto" when allowauto is false.
6570 \begin_layout Description
6571 Syntax toolbar-toggle <NAME> [allowauto]
6574 \begin_layout Description
6575 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
6576 \begin_inset Newline newline
6579 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
6582 \begin_layout Description
6583 Origin Edwin, 21 May 2007
6586 \begin_layout Subsection*
6590 \begin_layout Description
6591 Action Various UI visibility-toggling actions.
6594 \begin_layout Description
6595 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
6598 \begin_layout Description
6599 Params statusbar : Toggle visibility of the statusbar.
6600 \begin_inset Newline newline
6603 menubar : Toggle visibility of the menubar.
6604 \begin_inset Newline newline
6607 scrollbar : Toggle visibility of the scrollbar.
6608 \begin_inset Newline newline
6611 frame : Toggle visibility of the frames around editing window.
6612 \begin_inset Newline newline
6615 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.
6618 \begin_layout Description
6619 Origin sanda, 9 Feb 2007
6622 \begin_layout Subsection*
6626 \begin_layout Description
6627 Action Close the current document work area.
6630 \begin_layout Description
6631 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
6634 \begin_layout Description
6638 \begin_layout Description
6639 Origin Tommaso, 15 Sep 2012
6642 \begin_layout Subsection*
6646 \begin_layout Description
6647 Action Creates another split view of current buffer.
6650 \begin_layout Description
6651 Notion All split views act in the same way independently.
6654 \begin_layout Description
6655 Syntax view-split <vertical|horizontal>
6658 \begin_layout Description
6659 Params horizontal : The work areas are laid out side by side.
6660 \begin_inset Newline newline
6663 vertical : The work areas laid out vertically.
6666 \begin_layout Description
6667 Origin Abdel, 20 Feb 2008
6670 \begin_layout Subsection*
6674 \begin_layout Description
6675 Action Closes the current LyX window.
6678 \begin_layout Description
6682 \begin_layout Description
6683 Origin Abdel, 23 Oct 2006
6686 \begin_layout Subsection*
6690 \begin_layout Description
6691 Action Creates new empty LyX window.
6694 \begin_layout Description
6695 Notion Already opened documents from the previous window can be found under View menu.
6698 \begin_layout Description
6699 Syntax window-new [<GEOMETRY>]
6702 \begin_layout Description
6703 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
6706 \begin_layout Description
6707 Origin Abdel, 21 Oct 2006
6710 \begin_layout Section
6711 System Functions (Preferences, LyX Server etc.)
6714 \begin_layout Subsection*
6718 \begin_layout Description
6719 Action Helper function for bidirectional toolbar icons
6722 \begin_layout Description
6723 Notion In a text, the function is marked as `unknown' when the current direction does not correspond to DIRECTION (ltr or rtl). Otherwise the function behaves exactly as ACTION. The result is that ACTION will be associated to a different icon depending on text direction.
6726 \begin_layout Description
6727 Syntax bidi <DIRECTION> <ACTION>
6730 \begin_layout Description
6731 Origin JMarc, 21 July 2019
6734 \begin_layout Subsection*
6735 buffer-toggle-output-sync
6738 \begin_layout Description
6739 Action Toggles including of resources for forward/reverse search of the given document.
6742 \begin_layout Description
6743 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
6746 \begin_layout Description
6747 Syntax buffer-toggle-output-sync
6750 \begin_layout Description
6751 Origin sanda, 25 May 2010
6754 \begin_layout Subsection*
6758 \begin_layout Description
6759 Action Executes a command defined in a .def file.
6762 \begin_layout Description
6763 Notion The definitions are by default read from lib/commands/default.def.
6764 \begin_inset Newline newline
6767 A .def file allows to define a command with
6769 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).
6771 def_file "FileName" allows to include another .def file.
6772 \begin_inset Newline newline
6775 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.
6778 \begin_layout Description
6782 \begin_layout Description
6783 Params <NAME>: Name of the command that must be called.
6786 \begin_layout Description
6787 Origin broider, 2 Oct 2007
6790 \begin_layout Subsection*
6794 \begin_layout Description
6795 Action Cancels sequence prepared by LFUN_META_PREFIX .
6798 \begin_layout Description
6802 \begin_layout Subsection*
6803 command-alternatives
6806 \begin_layout Description
6807 Action Runs the first listed command that is enabled.
6810 \begin_layout Description
6811 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
6814 \begin_layout Description
6815 Syntax command-alternatives <CMDS>
6818 \begin_layout Description
6819 Params <CMDS>: Sequence of commands separated by semicolons.
6822 \begin_layout Description
6823 Sample command-alternatives completion-accept;cell-forward
6826 \begin_layout Description
6827 Origin rgh, 24 September 2008
6830 \begin_layout Subsection*
6834 \begin_layout Description
6835 Action Run more commands (LFUN and its parameters) in a sequence.
6838 \begin_layout Description
6839 Syntax command-sequence <CMDS>
6842 \begin_layout Description
6843 Params <CMDS>: Sequence of commands separated by semicolons.
6846 \begin_layout Description
6847 Sample command-sequence cut; ert-insert; self-insert
6849 ; paste; self-insert {}; inset-toggle;
6852 \begin_layout Description
6853 Origin Andre, 11 Nov 1999
6856 \begin_layout Subsection*
6857 cursor-follows-scrollbar-toggle
6860 \begin_layout Description
6861 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
6864 \begin_layout Description
6865 Syntax toggle-cursor-follows-scrollbar
6868 \begin_layout Description
6869 Origin ARRae, 2 Dec 1997
6872 \begin_layout Subsection*
6876 \begin_layout Description
6877 Action Set debug output level.
6880 \begin_layout Description
6881 Syntax debug-level-set <LEVEL>
6884 \begin_layout Description
6885 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.
6888 \begin_layout Description
6889 Origin sanda, 28 Dec 2009
6892 \begin_layout Subsection*
6896 \begin_layout Description
6897 Action toggle a mode where more information is given in UI
6900 \begin_layout Description
6901 Notion in so called "devel" mode, the information given in the status bar is more precise, and the help documents are open in editing mode.
6904 \begin_layout Description
6905 Syntax devel-mode-toggle
6908 \begin_layout Description
6909 Origin lasgouttes, 23 Jul 2017
6912 \begin_layout Subsection*
6916 \begin_layout Description
6917 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
6920 \begin_layout Description
6921 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
6924 \begin_layout Description
6925 Syntax forward-search
6928 \begin_layout Description
6929 Origin sanda, 14 Apr 2010
6932 \begin_layout Subsection*
6936 \begin_layout Description
6937 Action Apply the given settings to user preferences.
6940 \begin_layout Description
6941 Syntax lyxrc-apply <SETTINGS>
6944 \begin_layout Description
6945 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.
6948 \begin_layout Subsection*
6952 \begin_layout Description
6953 Action Shows message in statusbar (for script purposes).
6956 \begin_layout Description
6957 Syntax message <STRING>
6960 \begin_layout Description
6961 Origin Lgb, 8 Apr 2001
6964 \begin_layout Subsection*
6968 \begin_layout Description
6969 Action Simulate halting Meta key (Alt key on PCs).
6972 \begin_layout Description
6973 Notion Used for buffer edition not for GUI control.
6976 \begin_layout Description
6980 \begin_layout Subsection*
6984 \begin_layout Description
6985 Action Save user preferences.
6988 \begin_layout Description
6989 Syntax preferences-save
6992 \begin_layout Description
6993 Origin Lgb, 27 Nov 1999
6996 \begin_layout Subsection*
7000 \begin_layout Description
7001 Action Reconfigure the automatic settings.
7004 \begin_layout Description
7008 \begin_layout Description
7009 Origin Asger, 14 Feb 1997
7012 \begin_layout Subsection*
7016 \begin_layout Description
7017 Action Enables/disables searching for features in findadv
7020 \begin_layout Description
7021 Syntax search-ignore <type> <value>
7024 \begin_layout Description
7025 Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike<value>: true|false
7028 \begin_layout Subsection*
7032 \begin_layout Description
7033 Action Returns path and file name of the currently edited document.
7036 \begin_layout Description
7037 Syntax server-get-filename
7040 \begin_layout Subsection*
7044 \begin_layout Description
7045 Action Returns the current layout (that is environment) name on the cursor position.
7048 \begin_layout Description
7049 Syntax server-get-layout
7052 \begin_layout Subsection*
7053 server-get-statistics
7056 \begin_layout Description
7057 Action Returns the statistics (number of words and characters) in the document or in the given selection.
7060 \begin_layout Description
7061 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7064 \begin_layout Description
7065 Syntax server-get-statistics [<TYPE>]
7068 \begin_layout Description
7069 Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
7070 \begin_inset Newline newline
7074 \begin_inset Newline newline
7077 chars: count characters.
7078 \begin_inset Newline newline
7081 chars-space: count characters and spaces.
7084 \begin_layout Description
7085 Origin brokenclock, Oct 10 2014
7088 \begin_layout Subsection*
7092 \begin_layout Description
7093 Action Returns the coordinates of cursor position in the editing area.
7096 \begin_layout Description
7097 Syntax server-get-xy
7100 \begin_layout Subsection*
7101 server-goto-file-row
7104 \begin_layout Description
7105 Action Sets the cursor position in LyX based on the row number of generated TeX file.
7108 \begin_layout Description
7109 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).
7112 \begin_layout Description
7113 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
7116 \begin_layout Description
7117 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.
7118 \begin_inset Newline newline
7121 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).
7122 \begin_inset Newline newline
7125 .ext: extensions will be automatically replaced by .lyx.
7126 \begin_inset Newline newline
7129 <ROW_NUMBER> The row number of the LaTeX file to which to go.
7132 \begin_layout Description
7133 Sample server-goto-file-row /home/user/example.lyx 41
7134 \begin_inset Newline newline
7137 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
7140 \begin_layout Description
7141 Origin Edmar, 23 Dec 1998
7144 \begin_layout Subsection*
7148 \begin_layout Description
7149 Action Sends notify message about the last key-sequence to client.
7152 \begin_layout Description
7153 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
7156 \begin_layout Description
7157 Syntax server-notify
7160 \begin_layout Subsection*
7164 \begin_layout Description
7165 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
7168 \begin_layout Description
7169 Syntax server-set-xy <X> <Y>
7172 \begin_layout Subsection*
7176 \begin_layout Description
7177 Action Set the given LyX color to the color defined by the X11 name given.
7180 \begin_layout Description
7181 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
7184 \begin_layout Description
7185 Syntax set-color <LYX_NAME> <X11_NAME>
7188 \begin_layout Description
7189 Origin SLior, 11 Jun 2000
7192 \begin_layout Subsection*
7196 \begin_layout Description
7197 Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
7200 \begin_layout Description
7201 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
7204 \begin_layout Description
7208 \begin_layout Description
7209 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
7212 \begin_layout Subsection*
7216 \begin_layout Description
7217 Action Checks-in/commits the changes of the registered file to the repository.
7220 \begin_layout Description
7221 Notion In RCS case this also unlocks the file.
7224 \begin_layout Description
7228 \begin_layout Description
7229 Origin Lgb, 1 Jul 1997
7232 \begin_layout Subsection*
7236 \begin_layout Description
7237 Action Checks-out the document for edit (and locks it in some cases).
7240 \begin_layout Description
7244 \begin_layout Description
7245 Origin Lgb, 1 Jul 1997
7248 \begin_layout Subsection*
7252 \begin_layout Description
7253 Action Executes external command. This command is intended to support additional VCS commands.
7256 \begin_layout Description
7257 Syntax vc-command <FLAG> <PATH> <COMMAND>
7260 \begin_layout Description
7261 Params <FLAG>: Flags for the command can be combined together.
7262 \begin_inset Newline newline
7265 U - dUmmy - no flags
7266 \begin_inset Newline newline
7269 D - Doc - need document loaded to proceed
7270 \begin_inset Newline newline
7273 I - dIrty - mark document dirty
7274 \begin_inset Newline newline
7277 R - Reload - ensure that the document is saved and reload it after command execution
7278 \begin_inset Newline newline
7281 M - Message - ask for input string (commit message)
7282 \begin_inset Newline newline
7285 <PATH>: path where to start. $$p will be replaced by the current document path.
7286 \begin_inset Newline newline
7289 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
7292 \begin_layout Description
7293 Sample vc-command DR $$p "svn up"
7296 \begin_layout Description
7297 Origin sanda, 13 Jan 2009
7300 \begin_layout Subsection*
7304 \begin_layout Description
7305 Action Compares two revisions of the same file under version control.
7308 \begin_layout Description
7309 Syntax vc-compare [<REV1>] [<REV2>]
7312 \begin_layout Description
7313 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
7314 \begin_inset Newline newline
7317 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
7318 \begin_inset Newline newline
7322 \begin_inset Newline newline
7325 <REV2>: Newer file. Used only if REV1 > 0.
7326 \begin_inset Newline newline
7329 If no parameter is given, interactive dialog will be shown.
7332 \begin_layout Description
7333 Sample Compare current document against last commit
7334 \begin_inset Newline newline
7338 \begin_inset Newline newline
7341 Compare current document against current revision - 5 commits
7342 \begin_inset Newline newline
7346 \begin_inset Newline newline
7349 Compare revisions 120 and 155
7350 \begin_inset Newline newline
7356 \begin_layout Description
7357 Origin sanda, 12 Feb 2010
7360 \begin_layout Subsection*
7364 \begin_layout Description
7365 Action Copies the document to another name.
7368 \begin_layout Description
7369 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.
7372 \begin_layout Description
7373 Syntax vc-copy <FILENAME>
7376 \begin_layout Description
7377 Params <FILENAME>: New name of the document.
7378 \begin_inset Newline newline
7381 A file dialog is opened if no filename is given.
7384 \begin_layout Description
7385 Origin gb, 05 Feb 2013
7388 \begin_layout Subsection*
7392 \begin_layout Description
7393 Action Toggles the locking property of the edited file.
7396 \begin_layout Description
7397 Notion This is currently implemented only for SVN.
7400 \begin_layout Description
7401 Syntax vc-locking-toggle
7404 \begin_layout Description
7405 Origin sanda, 25 Jun 2009
7408 \begin_layout Subsection*
7412 \begin_layout Description
7413 Action Register the document as an file inside version control system.
7416 \begin_layout Description
7417 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
7418 \begin_inset Newline newline
7421 See LyX Additional Features Manual (Version Control Chapter) for additional information.
7424 \begin_layout Description
7428 \begin_layout Description
7429 Origin Lgb, 1 Jul 1997
7432 \begin_layout Subsection*
7436 \begin_layout Description
7437 Action Renames the document to another name.
7440 \begin_layout Description
7441 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.
7444 \begin_layout Description
7445 Syntax vc-rename <FILENAME>
7448 \begin_layout Description
7449 Params <FILENAME>: New name of the document.
7450 \begin_inset Newline newline
7453 A file dialog is opened if no filename is given.
7456 \begin_layout Description
7457 Origin gb, 05 Feb 2013
7460 \begin_layout Subsection*
7464 \begin_layout Description
7465 Action Update the local archive directory in which resides the current document with the remote repository.
7468 \begin_layout Description
7469 Syntax vc-repo-update
7472 \begin_layout Description
7473 Origin sanda, 16 Oct 2009
7476 \begin_layout Subsection*
7480 \begin_layout Description
7481 Action Reverts the document to the last check-in/commit in VCS.
7484 \begin_layout Description
7488 \begin_layout Description
7489 Origin Lgb, 1 Jul 1997
7492 \begin_layout Subsection*
7496 \begin_layout Description
7497 Action Undo last check-in.
7500 \begin_layout Description
7501 Notion This is currently implemented only for RCS.
7504 \begin_layout Description
7508 \begin_layout Description
7509 Origin Lgb, 1 Jul 1997
7512 \begin_layout Section
7513 Hidden Functions (not listed for configuration)
7516 \begin_layout Subsection*
7520 \begin_layout Description
7521 Action Return the current key sequence and available options as a string.
7524 \begin_layout Description
7525 Notion No options are added if no current map exists.
7526 \begin_inset Newline newline
7529 This is probably usable only with connection to lyxserver.
7532 \begin_layout Description
7533 Syntax command-prefix
7536 \begin_layout Subsection*
7540 \begin_layout Description
7541 Action Activates the LyX window.
7544 \begin_layout Description
7545 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.
7548 \begin_layout Description
7552 \begin_layout Description
7553 Origin skostysh, 4 Aug 2016
7556 \begin_layout Subsection*
7560 \begin_layout Description
7561 Action Inserts the given string (accordingly to the correct keymap).
7564 \begin_layout Description
7565 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
7568 \begin_layout Description
7569 Syntax self-insert <STRING>