1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
7 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
8 \renewenvironment{description}{\list{}{%
9 \setlength{\itemsep}{-2pt}
10 \advance\leftmargini6\p@ \itemindent-12\p@
11 \labelwidth\z@ \let\makelabel\descriptionlabel}%
16 \use_default_options false
17 \maintain_unincluded_children false
25 \language_package default
30 \font_typewriter default
32 \font_default_family default
33 \use_non_tex_fonts false
39 \default_output_format default
41 \bibtex_command default
42 \index_command default
43 \paperfontsize default
48 \use_package amsmath 1
49 \use_package amssymb 1
52 \use_package mathdots 0
53 \use_package mathtools 0
55 \use_package stackrel 0
56 \use_package stmaryrd 0
57 \use_package undertilde 0
59 \cite_engine_type default
63 \paperorientation portrait
77 \paragraph_separation indent
78 \paragraph_indentation default
79 \quotes_language english
82 \paperpagestyle default
83 \tracking_changes false
104 \begin_layout Section*
108 \begin_layout Standard
109 This manual documents the
110 \begin_inset Quotes eld
114 \begin_inset Quotes erd
118 These are commands that are used to make LyX perform specific actions.
119 LyX itself uses these functions internally, and every internal action is
123 \begin_layout Standard
124 LFUNs are also used in the files that define keyboard shortcuts, menu or
126 So if you want to change\SpecialChar \slash{}
127 customize the user interface, you need to deal
129 Furthermore, external programs can use LFUNs to communicate with and
130 \begin_inset Quotes eld
134 \begin_inset Quotes erd
138 Finally, you can also issue LFUNs directly via the so called mini-buffer
139 which can be opened via
142 arg "command-execute"
148 \begin_layout Standard
149 In the following, all LFUNs are listed, categorized by function.
152 \begin_layout Section
153 Layout Functions (Font, Layout and Textclass related)
155 \begin_layout Subsection*
158 \begin_layout Description
159 Action Displays list of layout choices.
161 \begin_layout Description
162 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
164 \begin_layout Description
165 Syntax drop-layouts-choice
168 \begin_layout Subsection*
171 \begin_layout Description
172 Action Splits the current environment with a Separator.
174 \begin_layout Description
175 Syntax environment-split [outer]
177 \begin_layout Description
178 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
180 \begin_layout Description
181 Origin spitz, 23 Dec 2012
184 \begin_layout Subsection*
187 \begin_layout Description
188 Action Toggles the bold font (selection-wise) using mathbf in math.
190 \begin_layout Description
194 \begin_layout Subsection*
197 \begin_layout Description
198 Action Toggles the bold font (selection-wise) using boldsymbol in math.
200 \begin_layout Description
201 Syntax font-boldsymbol
204 \begin_layout Subsection*
207 \begin_layout Description
208 Action Reverts the settings of the font to the default values (selection-wise).
210 \begin_layout Description
214 \begin_layout Subsection*
217 \begin_layout Description
218 Action Toggles the emphasis font style (selection-wise).
220 \begin_layout Description
224 \begin_layout Subsection*
227 \begin_layout Description
228 Action Toggles Fraktur family font (math-mode, selection-wise).
230 \begin_layout Description
233 \begin_layout Description
234 Origin vermeer, 10 Jan 2002
237 \begin_layout Subsection*
240 \begin_layout Description
241 Action Toggles Italics font shape (math-mode, selection-wise).
243 \begin_layout Description
246 \begin_layout Description
247 Origin vermeer, 10 Jan 2002
250 \begin_layout Subsection*
253 \begin_layout Description
254 Action Toggles Noun text style font (selection-wise).
256 \begin_layout Description
260 \begin_layout Subsection*
263 \begin_layout Description
264 Action Toggles Roman family font (selection-wise).
266 \begin_layout Description
270 \begin_layout Subsection*
273 \begin_layout Description
274 Action Toggles Sans Serif family font (selection-wise).
276 \begin_layout Description
280 \begin_layout Subsection*
283 \begin_layout Description
284 Action Sets font size according to lyx format string.
286 \begin_layout Description
287 Syntax font-size <SIZE>
289 \begin_layout Description
290 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
291 \begin_inset Newline newline
294 largest|huge|giant|increase|decrease|default
297 \begin_layout Subsection*
300 \begin_layout Description
301 Action Returns the info about the current font.
303 \begin_layout Description
307 \begin_layout Subsection*
310 \begin_layout Description
311 Action Toggles strikeout (strike-through) in the font (selection-wise).
313 \begin_layout Description
314 Syntax font-strikeout
316 \begin_layout Description
317 Origin sanda, 3 May 2009
320 \begin_layout Subsection*
323 \begin_layout Description
324 Action Toggles the typewriter family font (selection-wise).
326 \begin_layout Description
327 Syntax font-typewriter
330 \begin_layout Subsection*
333 \begin_layout Description
334 Action Toggles underline in the font (selection-wise).
336 \begin_layout Description
337 Syntax font-underline
340 \begin_layout Subsection*
343 \begin_layout Description
344 Action Toggles double underline in the font (selection-wise).
346 \begin_layout Description
347 Syntax font-underunderline
349 \begin_layout Description
350 Origin sanda, 5 May 2009
353 \begin_layout Subsection*
356 \begin_layout Description
357 Action Toggles wavy underline in the font (selection-wise).
359 \begin_layout Description
360 Syntax font-underwave
362 \begin_layout Description
363 Origin sanda, 5 May 2009
366 \begin_layout Subsection*
369 \begin_layout Description
370 Action Sets the layout (that is, environment) for the current paragraph.
372 \begin_layout Description
373 Syntax layout <LAYOUT>
375 \begin_layout Description
376 Params <LAYOUT>: the layout to use
379 \begin_layout Subsection*
382 \begin_layout Description
383 Action Adds a module.
385 \begin_layout Description
386 Notion Adds a module to the list of included modules for the current buffer.
388 \begin_layout Description
389 Syntax layout-module-add <MODULE>
391 \begin_layout Description
392 Params <MODULE>: the module to be added
394 \begin_layout Description
395 Origin rgh, 25 August 2007
398 \begin_layout Subsection*
401 \begin_layout Description
402 Action Clears the module list.
404 \begin_layout Description
405 Notion Clears the list of included modules for the current buffer.
407 \begin_layout Description
408 Syntax layout-modules-clear
410 \begin_layout Description
411 Origin rgh, 25 August 2007
414 \begin_layout Subsection*
417 \begin_layout Description
418 Action Launches the paragraph settings dialog.
420 \begin_layout Description
421 Syntax layout-paragraph
424 \begin_layout Subsection*
427 \begin_layout Description
428 Action Reloads layout information.
430 \begin_layout Description
431 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.
433 \begin_layout Description
436 \begin_layout Description
437 Origin rgh, 3 September 2007
440 \begin_layout Subsection*
443 \begin_layout Description
444 Action Launches the tabular settings dialog.
446 \begin_layout Description
447 Syntax layout-tabular
449 \begin_layout Description
450 Origin Jug, 31 Jul 2000
453 \begin_layout Subsection*
456 \begin_layout Description
457 Action Update fonts and its metrics.
459 \begin_layout Description
460 Notion Automatically called after zoom, dpi, font names, or norm change.
462 \begin_layout Description
463 Syntax screen-font-update
465 \begin_layout Description
466 Origin ARRae, 13 Aug 2000
469 \begin_layout Subsection*
472 \begin_layout Description
473 Action Sets the text class for the current buffer.
475 \begin_layout Description
476 Syntax textclass-apply <TEXTCLASS>
478 \begin_layout Description
479 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
482 \begin_layout Subsection*
485 \begin_layout Description
486 Action Loads information for a textclass from disk.
488 \begin_layout Description
489 Syntax textclass-load <TEXTCLASS>
491 \begin_layout Description
492 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
495 \begin_layout Subsection*
498 \begin_layout Description
499 Action Toggle user-defined (=last-time used) text style.
501 \begin_layout Description
502 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
504 \begin_layout Description
505 Syntax textstyle-apply
507 \begin_layout Description
508 Origin leeming, 12 Mar 2003
511 \begin_layout Subsection*
514 \begin_layout Description
515 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
517 \begin_layout Description
518 Syntax textstyle-update <FONT_INFO>
520 \begin_layout Description
521 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
522 \begin_inset Newline newline
525 Use lyx -dbg action for exact syntax of text-style dialog parameters.
527 \begin_layout Description
528 Origin leeming, 12 Mar 2003
531 \begin_layout Section
532 Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
534 \begin_layout Subsection*
537 \begin_layout Description
538 Action Adds an acute accent to the next character typed.
540 \begin_layout Description
544 \begin_layout Subsection*
547 \begin_layout Description
548 Action Adds a breve accent to the next character typed.
550 \begin_layout Description
554 \begin_layout Subsection*
557 \begin_layout Description
558 Action Adds a caron to the next character typed.
560 \begin_layout Description
564 \begin_layout Subsection*
567 \begin_layout Description
568 Action Adds a cedilla to the next character typed.
570 \begin_layout Description
571 Syntax accent-cedilla
574 \begin_layout Subsection*
577 \begin_layout Description
578 Action Adds a circle accent to the next character typed.
580 \begin_layout Description
584 \begin_layout Subsection*
587 \begin_layout Description
588 Action Adds a circumflex to the next character typed.
590 \begin_layout Description
591 Syntax accent-circumflex
594 \begin_layout Subsection*
597 \begin_layout Description
598 Action Adds a dot accent to the next character typed.
600 \begin_layout Description
604 \begin_layout Subsection*
607 \begin_layout Description
608 Action Adds a grave accent to the next character typed.
610 \begin_layout Description
614 \begin_layout Subsection*
615 accent-hungarian-umlaut
617 \begin_layout Description
618 Action Adds a Hungarian umlaut to the next character typed.
620 \begin_layout Description
624 \begin_layout Subsection*
627 \begin_layout Description
628 Action Adds a macron to the next character typed.
630 \begin_layout Description
634 \begin_layout Subsection*
637 \begin_layout Description
638 Action Adds an ogonek accent to the next character typed.
640 \begin_layout Description
644 \begin_layout Subsection*
647 \begin_layout Description
648 Action Adds a tie over the next two character typed.
650 \begin_layout Description
651 Notion The following char will finish the tie.
653 \begin_layout Description
657 \begin_layout Subsection*
660 \begin_layout Description
661 Action Adds a tilde over the next character typed.
663 \begin_layout Description
667 \begin_layout Subsection*
670 \begin_layout Description
671 Action Adds an umlaut over the next character typed.
673 \begin_layout Description
677 \begin_layout Subsection*
680 \begin_layout Description
681 Action Adds a bar under the next character typed.
683 \begin_layout Description
684 Syntax accent-underbar
687 \begin_layout Subsection*
690 \begin_layout Description
691 Action Adds a dot under the next character typed.
693 \begin_layout Description
694 Syntax accent-underdot
697 \begin_layout Subsection*
700 \begin_layout Description
701 Action Accepts all tracked changes in the document.
703 \begin_layout Description
704 Syntax all-changes-accept
706 \begin_layout Description
707 Origin Levon, 16 Oct 2002
710 \begin_layout Subsection*
713 \begin_layout Description
714 Action Rejects all tracked changes in the document.
716 \begin_layout Description
717 Notion Reject does not work recursively; the user may have to repeat the operation.
719 \begin_layout Description
720 Syntax all-changes-reject
722 \begin_layout Description
723 Origin Levon, 16 Oct 2002
726 \begin_layout Subsection*
729 \begin_layout Description
730 Action Start (or remove) Appendix on the given cursor position.
732 \begin_layout Description
735 \begin_layout Description
736 Origin ettrich, 5 May 1998
739 \begin_layout Subsection*
742 \begin_layout Description
743 Action Inserts an argument (short title) inset.
745 \begin_layout Description
746 Syntax argument-insert <argument nr>
748 \begin_layout Description
749 Params <argument nr>: see layout declarations
751 \begin_layout Description
752 Origin vermeer, 12 Aug 2002
755 \begin_layout Subsection*
758 \begin_layout Description
759 Action Adds database, which will be used for bibtex citations.
761 \begin_layout Description
762 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
764 \begin_layout Description
765 Syntax bibtex-database-add <DATABASE-NAME>
767 \begin_layout Description
768 Origin Ale, 30 May 1997
771 \begin_layout Subsection*
774 \begin_layout Description
775 Action Adds database, which will be used for bibtex citations.
777 \begin_layout Description
778 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
780 \begin_layout Description
781 Syntax bibtex-database-del <DATABASE-NAME>
783 \begin_layout Description
784 Origin Ale, 30 May 1997
787 \begin_layout Subsection*
790 \begin_layout Description
791 Action Clears the list of saved bookmarks.
793 \begin_layout Description
794 Syntax bookmark-clear
796 \begin_layout Description
797 Origin bpeng, 31 October 2006
800 \begin_layout Subsection*
803 \begin_layout Description
804 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
806 \begin_layout Description
807 Notion Bookmark 0 has a special purpose. It is automatically set
808 \begin_inset Newline newline
811 1. to the paragraph you are currently editing
812 \begin_inset Newline newline
815 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
816 \begin_inset Newline newline
819 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
821 \begin_layout Description
822 Syntax bookmark-goto <NUMBER>
824 \begin_layout Description
825 Params <NUMBER>: the number of the bookmark to restore.
827 \begin_layout Description
828 Origin Dekel, 27 January 2001
831 \begin_layout Subsection*
834 \begin_layout Description
835 Action Save a bookmark.
837 \begin_layout Description
838 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.
840 \begin_layout Description
841 Syntax bookmark-save <NUMBER>
843 \begin_layout Description
844 Params <NUMBER>: the number of the bookmark to save.
846 \begin_layout Description
847 Origin Dekel, 27 January 2001
850 \begin_layout Subsection*
853 \begin_layout Description
854 Action Inserts Box inset.
856 \begin_layout Description
857 Syntax box-insert [<TYPE>]
859 \begin_layout Description
860 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
861 \begin_inset Newline newline
864 Framed is the default one.
866 \begin_layout Description
867 Origin vermeer, 7 Oct 2003
870 \begin_layout Subsection*
873 \begin_layout Description
874 Action Inserts branch inset.
876 \begin_layout Description
877 Syntax branch-insert <BRANCH-NAME>
879 \begin_layout Description
880 Origin vermeer, 17 Aug 2003
883 \begin_layout Subsection*
886 \begin_layout Description
887 Action Move the cursor to the beginning of the document.
889 \begin_layout Description
893 \begin_layout Subsection*
896 \begin_layout Description
897 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
899 \begin_layout Description
900 Syntax buffer-begin-select
903 \begin_layout Subsection*
906 \begin_layout Description
907 Action Move the cursor to the end of the document.
909 \begin_layout Description
913 \begin_layout Subsection*
916 \begin_layout Description
917 Action Move the cursor to the end of the document adding the traversed text to the selection.
919 \begin_layout Description
920 Syntax buffer-end-select
923 \begin_layout Subsection*
926 \begin_layout Description
927 Action Inserts a caption inset.
929 \begin_layout Description
930 Syntax caption-insert
932 \begin_layout Description
933 Origin Lgb, 18 Jul 2000
936 \begin_layout Subsection*
939 \begin_layout Description
940 Action Moves the cursor to the previous cell inside the table.
942 \begin_layout Description
945 \begin_layout Description
946 Origin Jug, 22 May 2000
949 \begin_layout Subsection*
952 \begin_layout Description
953 Action Moves the cursor to the next cell inside the table.
955 \begin_layout Description
959 \begin_layout Subsection*
962 \begin_layout Description
963 Action Splits cell and shifts right part to the next cell (inside the math grid).
965 \begin_layout Description
968 \begin_layout Description
969 Origin Ale, 15 May 1997
972 \begin_layout Subsection*
975 \begin_layout Description
976 Action Accepts tracked change inside the selection.
978 \begin_layout Description
981 \begin_layout Description
982 Origin Levon, 16 Oct 2002
985 \begin_layout Subsection*
988 \begin_layout Description
989 Action Moves the cursor to the position of the next change of the change tracking records.
991 \begin_layout Description
994 \begin_layout Description
995 Origin schmitt, 4 Oct 2006
998 \begin_layout Subsection*
1001 \begin_layout Description
1002 Action Moves the cursor to the position of the previous change of the change tracking records.
1004 \begin_layout Description
1005 Syntax change-previous
1007 \begin_layout Description
1008 Origin vfr, 4 Apr 2009
1011 \begin_layout Subsection*
1014 \begin_layout Description
1015 Action Rejects tracked change inside the selection.
1017 \begin_layout Description
1018 Syntax change-reject
1020 \begin_layout Description
1021 Origin Levon, 16 Oct 2002
1024 \begin_layout Subsection*
1027 \begin_layout Description
1028 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1030 \begin_layout Description
1031 Syntax changes-merge
1033 \begin_layout Description
1034 Origin Levon, 16 Oct 2002
1037 \begin_layout Subsection*
1040 \begin_layout Description
1041 Action Toggles showing of change tracking in typeset output.
1043 \begin_layout Description
1044 Syntax changes-output
1046 \begin_layout Description
1047 Origin jspitzm, 21 Jan 2005
1050 \begin_layout Subsection*
1053 \begin_layout Description
1054 Action Toggles change tracking to on/off.
1056 \begin_layout Description
1057 Syntax changes-track
1059 \begin_layout Description
1060 Origin levon, 1 Oct 2002
1063 \begin_layout Subsection*
1066 \begin_layout Description
1067 Action Moves the cursor one position logically backwards.
1069 \begin_layout Description
1070 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.
1072 \begin_layout Description
1073 Syntax char-backward
1076 \begin_layout Subsection*
1077 char-backward-select
1079 \begin_layout Description
1080 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1082 \begin_layout Description
1083 Notion See also LFUN_CHAR_BACKWARD.
1085 \begin_layout Description
1086 Syntax char-backward-select
1089 \begin_layout Subsection*
1090 char-delete-backward
1092 \begin_layout Description
1093 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1095 \begin_layout Description
1096 Syntax char-delete-backward
1099 \begin_layout Subsection*
1102 \begin_layout Description
1103 Action Deletes one character in the backward direction (usually the "Delete" key).
1105 \begin_layout Description
1106 Syntax char-delete-forward
1109 \begin_layout Subsection*
1112 \begin_layout Description
1113 Action Moves the cursor one position logically forward.
1115 \begin_layout Description
1116 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.
1118 \begin_layout Description
1122 \begin_layout Subsection*
1125 \begin_layout Description
1126 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1128 \begin_layout Description
1129 Notion See also LFUN_CHAR_FORWARD.
1131 \begin_layout Description
1132 Syntax char-forward-select
1135 \begin_layout Subsection*
1138 \begin_layout Description
1139 Action Moves the cursor one position "to the left".
1141 \begin_layout Description
1142 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.
1144 \begin_layout Description
1148 \begin_layout Subsection*
1151 \begin_layout Description
1152 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1154 \begin_layout Description
1155 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1157 \begin_layout Description
1158 Syntax char-left-select
1161 \begin_layout Subsection*
1164 \begin_layout Description
1165 Action Moves the cursor one position "to the right".
1167 \begin_layout Description
1168 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.
1170 \begin_layout Description
1174 \begin_layout Subsection*
1177 \begin_layout Description
1178 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1180 \begin_layout Description
1181 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1183 \begin_layout Description
1184 Syntax char-right-select
1187 \begin_layout Subsection*
1190 \begin_layout Description
1191 Action Transposes the character at the cursor with the one before it.
1193 \begin_layout Description
1194 Syntax chars-transpose
1196 \begin_layout Description
1197 Origin Lgb, 25 Apr 2001
1200 \begin_layout Subsection*
1203 \begin_layout Description
1204 Action Inserts citation from loaded citation database.
1206 \begin_layout Description
1207 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1209 \begin_layout Description
1210 Params <KEY>: Citation (shortcut listed in available citations).
1211 \begin_inset Newline newline
1214 <TEXT_BEFORE>: text which should appear before citation.
1216 \begin_layout Description
1217 Origin AAS, 97-02-23
1220 \begin_layout Subsection*
1223 \begin_layout Description
1224 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.
1226 \begin_layout Description
1227 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.
1229 \begin_layout Description
1230 Syntax clipboard-paste [<ARG>]
1232 \begin_layout Description
1233 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1235 \begin_layout Description
1236 Origin Georg, 10 Jul 2006
1239 \begin_layout Subsection*
1240 clipboard-paste-simple
1242 \begin_layout Description
1243 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.
1245 \begin_layout Description
1246 Syntax clipboard-paste-simple [<ARG>]
1248 \begin_layout Description
1249 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1252 \begin_layout Subsection*
1255 \begin_layout Description
1256 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1258 \begin_layout Description
1259 Notion Usually bound to M-x shortcut.
1261 \begin_layout Description
1262 Syntax command-execute
1265 \begin_layout Subsection*
1268 \begin_layout Description
1269 Action Try to complete the word or command at the cursor position.
1271 \begin_layout Description
1274 \begin_layout Description
1275 Origin sts, Feb 19 2008
1278 \begin_layout Subsection*
1281 \begin_layout Description
1282 Action Accept suggested completion.
1284 \begin_layout Description
1285 Syntax completion-accept
1287 \begin_layout Description
1288 Origin sanda, Sep 08 2008
1291 \begin_layout Subsection*
1294 \begin_layout Description
1295 Action Try to cancel completion, either the popup or the inline completion.
1297 \begin_layout Description
1298 Syntax completion-cancel
1300 \begin_layout Description
1301 Origin sts, Sep 07 2008
1304 \begin_layout Subsection*
1307 \begin_layout Description
1308 Action Show the inline completion at the cursor position.
1310 \begin_layout Description
1311 Syntax completion-inline
1313 \begin_layout Description
1314 Origin sts, Feb 19 2008
1317 \begin_layout Subsection*
1320 \begin_layout Description
1321 Action Show the completion popup at the cursor position.
1323 \begin_layout Description
1324 Syntax completion-popup
1326 \begin_layout Description
1327 Origin sts, Feb 19 2008
1330 \begin_layout Subsection*
1333 \begin_layout Description
1334 Action Copies the current selection to the clipboard.
1336 \begin_layout Description
1340 \begin_layout Subsection*
1343 \begin_layout Description
1344 Action Cuts to the clipboard.
1346 \begin_layout Description
1350 \begin_layout Subsection*
1353 \begin_layout Description
1354 Action Inserts the current date.
1356 \begin_layout Description
1357 Syntax date-insert [<ARG>]
1359 \begin_layout Description
1360 Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
1362 \begin_layout Description
1363 Origin jdblair, 31 Jan 2000
1366 \begin_layout Subsection*
1369 \begin_layout Description
1370 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1372 \begin_layout Description
1373 Syntax depth-decrement
1376 \begin_layout Subsection*
1379 \begin_layout Description
1380 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1382 \begin_layout Description
1383 Syntax depth-increment
1386 \begin_layout Subsection*
1387 dialog-disconnect-inset
1389 \begin_layout Description
1390 Action Closes opened connection to opened inset.
1392 \begin_layout Description
1393 Notion Connection is used for apply functions.
1395 \begin_layout Description
1396 Syntax dialog-disconnect-inset <INSET-NAME>
1398 \begin_layout Description
1399 Origin leeming, 25 Feb 2003
1402 \begin_layout Subsection*
1405 \begin_layout Description
1406 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1408 \begin_layout Description
1409 Syntax dialog-hide <NAME>
1411 \begin_layout Description
1412 Params See LFUN_DIALOG_SHOW .
1414 \begin_layout Description
1415 Origin leeming, 25 Feb 2003
1418 \begin_layout Subsection*
1421 \begin_layout Description
1422 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1424 \begin_layout Description
1425 Syntax dialog-show <NAME> [<DATA>]
1427 \begin_layout Description
1428 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1429 \begin_inset Newline newline
1432 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1433 \begin_inset Newline newline
1436 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1437 \begin_inset Newline newline
1440 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1441 \begin_inset Newline newline
1444 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1445 \begin_inset Newline newline
1448 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1449 \begin_inset Newline newline
1452 <SPECIAL>: latexlog|vclog
1453 \begin_inset Newline newline
1456 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1458 \begin_layout Description
1459 Origin leeming, 17 Jun 2003
1462 \begin_layout Subsection*
1463 dialog-show-new-inset
1465 \begin_layout Description
1466 Action Shows hidden dialog or create new one for a given inset settings etc.
1468 \begin_layout Description
1469 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1471 \begin_layout Description
1472 Syntax dialog-show-new-inset <NAME> [<DATA>]
1474 \begin_layout Description
1475 Params See LFUN_DIALOG_SHOW .
1477 \begin_layout Description
1478 Origin leeming, 25 Feb 2003
1481 \begin_layout Subsection*
1484 \begin_layout Description
1485 Action Toggles dialog between showed/hidden state.
1487 \begin_layout Description
1488 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1490 \begin_layout Description
1491 Syntax dialog-toggle <NAME> [<DATA>]
1493 \begin_layout Description
1494 Params See LFUN_DIALOG_SHOW .
1496 \begin_layout Description
1497 Origin JSpitzm, 30 Apr 2007
1500 \begin_layout Subsection*
1503 \begin_layout Description
1504 Action Updates the dialog values from the inset/paragraph/document.
1506 \begin_layout Description
1507 Syntax dialog-update <NAME>
1509 \begin_layout Description
1510 Params <NAME>: paragraph|prefs|<INSET>
1511 \begin_inset Newline newline
1516 \begin_layout Description
1517 Origin leeming, 25 Feb 2003
1520 \begin_layout Subsection*
1523 \begin_layout Description
1524 Action Moves the cursor one line in downward direction.
1526 \begin_layout Description
1530 \begin_layout Subsection*
1533 \begin_layout Description
1534 Action Moves the cursor one line in downward direction adding the current position to the selection.
1536 \begin_layout Description
1540 \begin_layout Subsection*
1543 \begin_layout Description
1544 Action Inserts an ERT inset.
1546 \begin_layout Description
1549 \begin_layout Description
1550 Origin Jug, 18 Feb 2000
1553 \begin_layout Subsection*
1556 \begin_layout Description
1557 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1559 \begin_layout Description
1562 \begin_layout Description
1563 Origin Lgb, 17 May 2001
1566 \begin_layout Subsection*
1569 \begin_layout Description
1570 Action Inserts another LyX file.
1572 \begin_layout Description
1573 Syntax file-insert [<FILE>]
1575 \begin_layout Description
1576 Params <FILE>: Filename to be inserted.
1579 \begin_layout Subsection*
1580 file-insert-plaintext
1582 \begin_layout Description
1583 Action Inserts plain text file.
1585 \begin_layout Description
1586 Syntax file-insert-plaintext [<FILE>]
1588 \begin_layout Description
1589 Params <FILE>: Filename to be inserted.
1591 \begin_layout Description
1592 Origin CFO-G, 19 Nov 1997
1595 \begin_layout Subsection*
1596 file-insert-plaintext-para
1598 \begin_layout Description
1599 Action Inserts plain text file as paragraph (i.e. join lines).
1601 \begin_layout Description
1602 Syntax file-insert-plaintext-para [<FILE>]
1604 \begin_layout Description
1605 Params <FILE>: Filename to be inserted.
1607 \begin_layout Description
1608 Origin Levon, 14 Feb 2001
1611 \begin_layout Subsection*
1614 \begin_layout Description
1615 Action Inserts CharStyle, Custom inset or XML short element.
1617 \begin_layout Description
1618 Notion Look into the Customization manual for more information about these elements.
1619 \begin_inset Newline newline
1622 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.
1623 \begin_inset Newline newline
1626 For dissolving the element see LFUN_INSET_DISSOLVE.
1628 \begin_layout Description
1629 Syntax flex-insert Name
1631 \begin_layout Description
1632 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.
1634 \begin_layout Description
1635 Sample flex-insert Code
1638 \begin_layout Subsection*
1641 \begin_layout Description
1642 Action Inserts a float inset.
1644 \begin_layout Description
1645 Syntax float-insert <TYPE>
1647 \begin_layout Description
1648 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1650 \begin_layout Description
1651 Origin Lgb, 27 Jun 2000
1654 \begin_layout Subsection*
1657 \begin_layout Description
1658 Action Inserts the list of floats in the document.
1660 \begin_layout Description
1661 Syntax float-list-insert <TYPE>
1663 \begin_layout Description
1664 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1666 \begin_layout Description
1667 Origin Lgb, 3 May 2001
1670 \begin_layout Subsection*
1673 \begin_layout Description
1674 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
1676 \begin_layout Description
1677 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
1679 \begin_layout Description
1680 Syntax float-wide-insert <TYPE>
1682 \begin_layout Description
1683 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
1685 \begin_layout Description
1686 Origin Lgb, 31 Oct 2001
1689 \begin_layout Subsection*
1692 \begin_layout Description
1693 Action Inserts a footnote inset.
1695 \begin_layout Description
1696 Syntax footnote-insert
1698 \begin_layout Description
1699 Origin Jug, 7 Mar 2000
1702 \begin_layout Subsection*
1705 \begin_layout Description
1706 Action Reloads the image if necessary.
1708 \begin_layout Description
1709 Syntax graphics-reload
1711 \begin_layout Description
1712 Origin vfr, 10 Aug 2009
1715 \begin_layout Subsection*
1718 \begin_layout Description
1719 Action Inserts hyperlinks into the document (clickable in pdf output).
1721 \begin_layout Description
1722 Notion Hyperlink target can be set via selection + hyperlink-insert function.
1724 \begin_layout Description
1725 Syntax href-insert [<TARGET>]
1727 \begin_layout Description
1728 Origin CFO-G, 21 Nov 1997
1731 \begin_layout Subsection*
1734 \begin_layout Description
1735 Action Only active in IPA inset.
1737 \begin_layout Description
1738 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.
1740 \begin_layout Description
1743 \begin_layout Description
1744 Origin spitz, 20 May 2012
1747 \begin_layout Subsection*
1750 \begin_layout Description
1751 Action Inserts Index entry.
1753 \begin_layout Description
1754 Notion It automatically takes the word on the cursor position.
1756 \begin_layout Description
1757 Syntax index-insert [<TYPE:Name>]
1759 \begin_layout Description
1760 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
1762 \begin_layout Description
1763 Origin leeming, 3 Aug 2000
1766 \begin_layout Subsection*
1769 \begin_layout Description
1770 Action Inserts list of Index entries on a new page.
1772 \begin_layout Description
1773 Syntax index-print [<TYPE:Name>]
1775 \begin_layout Description
1776 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
1778 \begin_layout Description
1779 Origin Lgb, 27 Feb 1997
1782 \begin_layout Subsection*
1785 \begin_layout Description
1786 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
1788 \begin_layout Description
1789 Notion Apart from lfun arguments you can use the following method:
1790 \begin_inset Newline newline
1793 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
1794 \begin_inset Newline newline
1797 2. select the text and run info-insert lfun.
1799 \begin_layout Description
1800 Syntax info-insert <TYPE> <ARG>
1802 \begin_layout Description
1803 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
1804 \begin_inset Newline newline
1807 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
1808 \begin_inset Newline newline
1811 shortcut[s]: name of lfun (e.g math-insert
1814 \begin_inset Newline newline
1817 lyxrc: name of rc_entry (e.g. bind_file)
1818 \begin_inset Newline newline
1821 lyxinfo: "version" - used version of LyX
1822 \begin_inset Newline newline
1825 package: name of latex package (e.g. listings)
1826 \begin_inset Newline newline
1829 textclass: name of textclass (e.g. article)
1830 \begin_inset Newline newline
1833 menu: name of lfun used in menu
1834 \begin_inset Newline newline
1837 icon: icon of lfun used in toolbar
1838 \begin_inset Newline newline
1841 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
1843 \begin_layout Description
1844 Sample command-sequence info-insert buffer path; info-insert buffer name
1846 \begin_layout Description
1847 Origin bpeng, 7 Oct 2007
1850 \begin_layout Subsection*
1853 \begin_layout Description
1854 Action Apply data for an inset.
1856 \begin_layout Description
1857 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.
1859 \begin_layout Description
1860 Syntax inset-apply <ARGS>
1862 \begin_layout Description
1863 Params See LFUN_INSET_INSERT .
1866 \begin_layout Subsection*
1869 \begin_layout Description
1870 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise
1872 \begin_layout Description
1875 \begin_layout Description
1876 Origin lasgouttes, 16 Mar 2009
1879 \begin_layout Subsection*
1882 \begin_layout Description
1883 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection).
1885 \begin_layout Description
1886 Syntax inset-begin-select
1888 \begin_layout Description
1889 Origin lasgouttes, 16 Mar 2009
1892 \begin_layout Subsection*
1895 \begin_layout Description
1896 Action Copies the inset to the clipboard as a certain type.
1898 \begin_layout Description
1899 Notion Currently used only for InsetInfo where its content is copied as a text.
1901 \begin_layout Description
1902 Syntax inset-copy-as
1904 \begin_layout Description
1905 Origin vfr, 18 Apr 2010
1908 \begin_layout Subsection*
1911 \begin_layout Description
1912 Action Dissolve the current inset into text.
1914 \begin_layout Description
1915 Syntax inset-dissolve [<INSET>]
1917 \begin_layout Description
1918 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.
1919 \begin_inset Newline newline
1922 For values see lyx::InsetLayout::lyxtype_ .
1924 \begin_layout Description
1925 Origin JSpitz, 7 Aug 2006
1928 \begin_layout Subsection*
1931 \begin_layout Description
1932 Action Edit the inset at cursor with an external application, if one is attributed.
1934 \begin_layout Description
1935 Syntax inset-edit [<INSET_PARAMS>]
1937 \begin_layout Description
1938 Params <INSET_PARAMS>: Parameters for the inset.
1939 \begin_inset Newline newline
1942 Currently only the filename will be considered.
1944 \begin_layout Description
1945 Origin JSpitzm, 27 Apr 2006
1948 \begin_layout Subsection*
1951 \begin_layout Description
1952 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise
1954 \begin_layout Description
1957 \begin_layout Description
1958 Origin lasgouttes, 16 Mar 2009
1961 \begin_layout Subsection*
1964 \begin_layout Description
1965 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection).
1967 \begin_layout Description
1968 Syntax inset-end-select
1970 \begin_layout Description
1971 Origin lasgouttes, 16 Mar 2009
1974 \begin_layout Subsection*
1977 \begin_layout Description
1978 Action Apply the given commands on insets of a given name.
1980 \begin_layout Description
1981 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.
1983 \begin_layout Description
1984 Syntax inset-forall <NAME> <LFUN-COMMAND>
1985 \begin_inset Newline newline
1988 <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.
1990 \begin_layout Description
1991 Sample Remove all index insets:
1992 \begin_inset Newline newline
1995 inset-forall Index char-delete-forward
1996 \begin_inset Newline newline
1999 Close all Notes (also works for a particular branch, for example):
2000 \begin_inset Newline newline
2003 inset-forall Note inset-toggle close
2004 \begin_inset Newline newline
2007 Transform all yellow notes to comments
2008 \begin_inset Newline newline
2011 inset-forall Note:Note inset-modify note Note Comment
2012 \begin_inset Newline newline
2015 Try to put LyX in an infinite loop if there is at least a Note:
2016 \begin_inset Newline newline
2019 inset-forall Note char-backward
2021 \begin_layout Description
2022 Origin lasgouttes, 27 Nov 2009
2025 \begin_layout Subsection*
2028 \begin_layout Description
2029 Action Insert new inset (type given by the parameters).
2031 \begin_layout Description
2032 Syntax inset-insert <INSET> <ARGS>
2034 \begin_layout Description
2035 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2036 \begin_inset Newline newline
2039 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2040 \begin_inset Newline newline
2043 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2045 \begin_layout Description
2046 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2049 \begin_inset Newline newline
2052 where <label name> is the name of the referenced label and <Format> is one of the following:
2053 \begin_inset Newline newline
2057 \begin_inset Newline newline
2060 eqref -- (<reference>)
2061 \begin_inset Newline newline
2065 \begin_inset Newline newline
2068 vpageref -- on <page>
2069 \begin_inset Newline newline
2072 vref -- <reference> on <page>
2073 \begin_inset Newline newline
2076 formatted -- Formatted reference
2079 \begin_layout Subsection*
2082 \begin_layout Description
2083 Action Modify some properties of an inset.
2085 \begin_layout Description
2086 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, index, info, label, listings, newline, newpage, nomencl, note, phantom, ref, space, tabular, vspace, wrap insets.
2088 \begin_layout Description
2089 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
2091 \begin_layout Description
2092 Params Generally see LFUN_INSET_INSERT for further details.
2093 \begin_inset Newline newline
2096 In case that <INSET> is "tabular" various math-environment features are handled as well, e.g. add-vline-left/right for the Grid/Array environment.
2097 \begin_inset Newline newline
2100 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
2101 \begin_inset Newline newline
2104 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
2105 \begin_inset Newline newline
2108 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2109 \begin_inset Newline newline
2112 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2113 \begin_inset Newline newline
2116 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2117 \begin_inset Newline newline
2120 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2121 \begin_inset Newline newline
2124 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2125 \begin_inset Newline newline
2128 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2129 \begin_inset Newline newline
2132 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2133 \begin_inset Newline newline
2136 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2137 \begin_inset Newline newline
2140 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2141 \begin_inset Newline newline
2144 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2145 \begin_inset Newline newline
2148 set-special-column|set-special-multicolumn|set-special-multirow|
2149 \begin_inset Newline newline
2152 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2153 \begin_inset Newline newline
2156 set-interline-space|set-border-lines|tabular-valign-top|
2157 \begin_inset Newline newline
2160 tabular-valign-middle|tabular-valign-bottom|set-tabular-width <ARG>: additional argument for some commands, use debug mode to explore its values.
2162 \begin_layout Description
2163 Sample inset-modify note Note Comment
2164 \begin_inset Newline newline
2167 inset-modify changetype Ovalbox
2170 \begin_layout Subsection*
2173 \begin_layout Description
2174 Action Selects all contents of an inset.
2176 \begin_layout Description
2177 Syntax inset-select-all
2179 \begin_layout Description
2180 Origin vfr, 22 Aug 2009
2183 \begin_layout Subsection*
2186 \begin_layout Description
2187 Action Open the inset's properties dialog.
2189 \begin_layout Description
2190 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.
2192 \begin_layout Description
2193 Syntax inset-settings <INSET>
2195 \begin_layout Description
2196 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2197 \begin_inset Newline newline
2200 graphics|href|include|index|index_print|label|line|
2201 \begin_inset Newline newline
2204 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2207 \begin_layout Subsection*
2210 \begin_layout Description
2211 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2213 \begin_layout Description
2214 Syntax inset-toggle [<ARG>]
2216 \begin_layout Description
2217 Params <ARG>: <open|close|toggle|assign>.
2218 \begin_inset Newline newline
2221 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2222 \begin_inset Newline newline
2225 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2227 \begin_layout Description
2228 Origin lasgouttes, 19 Jul 2001
2231 \begin_layout Subsection*
2234 \begin_layout Description
2235 Action Inserts an IPA inset.
2237 \begin_layout Description
2240 \begin_layout Description
2241 Origin spitz, 05 Mar 2012
2244 \begin_layout Subsection*
2247 \begin_layout Description
2248 Action Inserts special IPA macros into the document.
2250 \begin_layout Description
2251 Syntax ipamacro-insert <CHAR>
2253 \begin_layout Description
2254 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2256 \begin_layout Description
2257 Origin JSpitzm, 22 Aug 2012
2260 \begin_layout Subsection*
2263 \begin_layout Description
2264 Action Turn off the loaded keyboard map.
2266 \begin_layout Description
2270 \begin_layout Subsection*
2273 \begin_layout Description
2274 Action Turn on the primary keyboard map.
2276 \begin_layout Description
2277 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.
2278 \begin_inset Newline newline
2281 The language is to be set in the Preferences dialog.
2283 \begin_layout Description
2284 Syntax keymap-primary
2287 \begin_layout Subsection*
2290 \begin_layout Description
2291 Action Turn on the secondary keyboard map.
2293 \begin_layout Description
2294 Syntax keymap-secondary
2297 \begin_layout Subsection*
2300 \begin_layout Description
2301 Action Toggles keyboard maps (first/second/off).
2303 \begin_layout Description
2304 Syntax keymap-toggle
2306 \begin_layout Description
2307 Origin leeming, 30 Mar 2004
2310 \begin_layout Subsection*
2311 label-copy-as-reference
2313 \begin_layout Description
2314 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
2316 \begin_layout Description
2317 Syntax copy-label-as-reference <LABEL>
2319 \begin_layout Description
2320 Params <LABEL>: The label to copy (for multi-line math)
2322 \begin_layout Description
2323 Origin sts, 16 Nov 2008
2326 \begin_layout Subsection*
2329 \begin_layout Description
2330 Action Goto a label.
2332 \begin_layout Description
2333 Syntax label-goto [<LABEL>]
2335 \begin_layout Description
2336 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.
2338 \begin_layout Description
2339 Origin Ale, 6 Aug 1997
2342 \begin_layout Subsection*
2345 \begin_layout Description
2346 Action Inserts label to text or displayed formula.
2348 \begin_layout Description
2349 Syntax label-insert [<LABEL>]
2351 \begin_layout Description
2352 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
2355 \begin_layout Subsection*
2356 label-insert-as-reference
2358 \begin_layout Description
2359 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
2361 \begin_layout Description
2362 Syntax label-insert-as-reference
2364 \begin_layout Description
2365 Origin vfr, 7 Apr 2009
2368 \begin_layout Subsection*
2371 \begin_layout Description
2372 Action Set language from the current cursor position.
2374 \begin_layout Description
2375 Syntax language <LANG> [set]
2377 \begin_layout Description
2378 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).
2380 \begin_layout Description
2381 Origin Dekel, 2 Mar 2000
2384 \begin_layout Subsection*
2387 \begin_layout Description
2388 Action Move the cursor to the beginning of the (screen) line.
2390 \begin_layout Description
2394 \begin_layout Subsection*
2397 \begin_layout Description
2398 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
2400 \begin_layout Description
2401 Syntax line-begin-select
2404 \begin_layout Subsection*
2407 \begin_layout Description
2408 Action Deletes the letters to the end of the (screen) line or deletes the selection.
2410 \begin_layout Description
2411 Syntax line-delete-forward
2414 \begin_layout Subsection*
2417 \begin_layout Description
2418 Action Move the cursor to the end of the (screen) line.
2420 \begin_layout Description
2424 \begin_layout Subsection*
2427 \begin_layout Description
2428 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
2430 \begin_layout Description
2431 Syntax line-end-select
2434 \begin_layout Subsection*
2437 \begin_layout Description
2438 Action Inserts a new listings inset.
2440 \begin_layout Description
2441 Syntax listing-insert
2443 \begin_layout Description
2444 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
2447 \begin_layout Subsection*
2450 \begin_layout Description
2451 Action Inserts a marginal note.
2453 \begin_layout Description
2454 Syntax marginalnote-insert
2456 \begin_layout Description
2457 Origin Lgb, 26 Jun 2000
2460 \begin_layout Subsection*
2463 \begin_layout Description
2464 Action Disable selecting of text-region.
2466 \begin_layout Description
2470 \begin_layout Subsection*
2473 \begin_layout Description
2474 Action Enable selecting of text-region.
2476 \begin_layout Description
2477 Notion After enabling you can simply move arrow keys to get selected region.
2479 \begin_layout Description
2483 \begin_layout Subsection*
2486 \begin_layout Description
2487 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2489 \begin_layout Description
2492 \begin_layout Description
2493 Origin Andre, May 5 2006
2496 \begin_layout Subsection*
2499 \begin_layout Description
2500 Action Inserts a line break or new line.
2502 \begin_layout Description
2503 Syntax newline-insert [<ARG>]
2505 \begin_layout Description
2506 Params <ARG>: <newline|linebreak> default: newline
2508 \begin_layout Description
2509 Origin JSpitzm, 25 Mar 2008
2512 \begin_layout Subsection*
2515 \begin_layout Description
2516 Action Inserts a new page.
2518 \begin_layout Description
2519 Syntax newpage-insert <ARG>
2521 \begin_layout Description
2522 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
2524 \begin_layout Description
2525 Origin uwestoehr, 24 Nov 2007
2528 \begin_layout Subsection*
2531 \begin_layout Description
2532 Action Inserts Nomenclature entry.
2534 \begin_layout Description
2535 Notion It automatically takes the word on the cursor position if no symbol is given.
2537 \begin_layout Description
2538 Syntax nomencl-insert [<SYMBOL>]
2540 \begin_layout Description
2541 Origin Ugras, 4 Nov 2006
2544 \begin_layout Subsection*
2547 \begin_layout Description
2548 Action Inserts list of Nomenclature entries.
2550 \begin_layout Description
2551 Syntax nomenclature-print
2553 \begin_layout Description
2554 Origin Ugras, 4 Nov 2006
2557 \begin_layout Subsection*
2560 \begin_layout Description
2561 Action Inserts Note on the current cursor position, move selection inside the inset.
2563 \begin_layout Description
2564 Syntax note-insert [<TYPE>]
2566 \begin_layout Description
2567 Params <TYPE>: <Note|Greyedout|Comment> default: Note
2570 \begin_layout Subsection*
2573 \begin_layout Description
2574 Action Moves the cursor to the beginning of next Note inset.
2576 \begin_layout Description
2580 \begin_layout Subsection*
2583 \begin_layout Description
2584 Action Move the current group in the downward direction in the structure of the document.
2586 \begin_layout Description
2587 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2589 \begin_layout Description
2592 \begin_layout Description
2593 Origin Vermeer, 23 Mar 2006
2596 \begin_layout Subsection*
2599 \begin_layout Description
2600 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2602 \begin_layout Description
2603 Notion Part -> Chapter -> Section -> etc.
2605 \begin_layout Description
2608 \begin_layout Description
2609 Origin Vermeer, 23 Mar 2006
2612 \begin_layout Subsection*
2615 \begin_layout Description
2616 Action Moves the current group in the upward direction in the hierarchy of the document structure.
2618 \begin_layout Description
2619 Notion Part <- Chapter <- Section <- etc.
2621 \begin_layout Description
2624 \begin_layout Description
2625 Origin Vermeer, 23 Mar 2006
2628 \begin_layout Subsection*
2631 \begin_layout Description
2632 Action Move the current group in the upward direction in the structure of the document.
2634 \begin_layout Description
2635 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2637 \begin_layout Description
2640 \begin_layout Description
2641 Origin Vermeer, 23 Mar 2006
2644 \begin_layout Subsection*
2647 \begin_layout Description
2648 Action Breaks the current paragraph at the current location.
2650 \begin_layout Description
2651 Notion Removes the selection.
2653 \begin_layout Description
2654 Syntax paragraph-break [<LAYOUT>]
2656 \begin_layout Description
2657 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2660 \begin_layout Subsection*
2663 \begin_layout Description
2664 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
2666 \begin_layout Description
2667 Syntax paragraph-down
2669 \begin_layout Description
2670 Origin Asger, 1 Oct 1996
2673 \begin_layout Subsection*
2674 paragraph-down-select
2676 \begin_layout Description
2677 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
2679 \begin_layout Description
2680 Syntax paragraph-down-select
2682 \begin_layout Description
2683 Origin Asger, 1 Oct 1996
2686 \begin_layout Subsection*
2689 \begin_layout Description
2690 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2692 \begin_layout Description
2693 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).
2695 \begin_layout Description
2696 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2698 \begin_layout Description
2699 Params <PAR_ID_NUMBER>: paragraph id
2700 \begin_inset Newline newline
2703 <POSITION_IN_PAR>: desired position within the paragraph
2705 \begin_layout Description
2706 Origin Dekel, 26 Aug 2000
2709 \begin_layout Subsection*
2712 \begin_layout Description
2713 Action Moves the current paragraph downwards in the document.
2715 \begin_layout Description
2716 Syntax paragraph-move-down
2718 \begin_layout Description
2719 Origin Edwin, 8 Apr 2006
2722 \begin_layout Subsection*
2725 \begin_layout Description
2726 Action Moves the current paragraph upwards in the document.
2728 \begin_layout Description
2729 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
2731 \begin_layout Description
2732 Syntax paragraph-move-up
2734 \begin_layout Description
2735 Origin Edwin, 8 Apr 2006
2738 \begin_layout Subsection*
2741 \begin_layout Description
2742 Action Change paragraph settings.
2744 \begin_layout Description
2745 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.
2747 \begin_layout Description
2748 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2750 \begin_layout Description
2760 \begin_inset Newline newline
2765 paragraph_spacing default|single|onehalf|double|other SIZE
2766 \begin_inset Newline newline
2771 align block|left|right|center|default
2772 \begin_inset Newline newline
2777 labelwidthstring WIDTH|
2781 \begin_layout Description
2782 Origin rgh, Aug 15 2007
2785 \begin_layout Subsection*
2786 paragraph-params-apply
2788 \begin_layout Description
2789 Action Change paragraph settings.
2791 \begin_layout Description
2792 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2794 \begin_layout Description
2795 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2797 \begin_layout Description
2798 Params For parameters see LFUN_PARAGRAPH_PARAMS
2800 \begin_layout Description
2801 Origin leeming, 30 Mar 2004
2804 \begin_layout Subsection*
2807 \begin_layout Description
2808 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
2810 \begin_layout Description
2813 \begin_layout Description
2814 Origin Asger, 1 Oct 1996
2817 \begin_layout Subsection*
2820 \begin_layout Description
2821 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
2823 \begin_layout Description
2824 Syntax paragraph-up-select
2826 \begin_layout Description
2827 Origin Asger, 1 Oct 1996
2830 \begin_layout Subsection*
2833 \begin_layout Description
2834 Action Pastes material (text or picture) from the active clipboard.
2836 \begin_layout Description
2837 Syntax paste [<TYPE>|<NUM>]
2839 \begin_layout Description
2840 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
2841 \begin_inset Newline newline
2844 <NUM>: number of the selection in the internal clipboard stack to be pasted.
2847 \begin_layout Subsection*
2850 \begin_layout Description
2851 Action Inserts phantom on the current cursor position, move selection inside the inset.
2853 \begin_layout Description
2854 Syntax phantom-insert [<TYPE>]
2856 \begin_layout Description
2857 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
2859 \begin_layout Description
2860 Origin uwestoehr, 30 Jan 2009
2863 \begin_layout Subsection*
2866 \begin_layout Description
2867 Action Inserts a new preview inset.
2869 \begin_layout Description
2870 Syntax preview-insert
2872 \begin_layout Description
2873 Origin vfr, 28 Mar 2010
2876 \begin_layout Subsection*
2877 primary-selection-paste
2879 \begin_layout Description
2880 Action Pastes the currently selected text.
2882 \begin_layout Description
2883 Notion Primary selection mechanism is linux-only thing.
2885 \begin_layout Description
2886 Syntax primary-selection-paste [<ARG>]
2888 \begin_layout Description
2889 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
2892 \begin_layout Subsection*
2895 \begin_layout Description
2896 Action Inserts quotes according to the type and quote-language preference.
2898 \begin_layout Description
2899 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
2901 \begin_layout Description
2902 Syntax quote-insert [<TYPE>]
2904 \begin_layout Description
2905 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
2908 \begin_layout Subsection*
2911 \begin_layout Description
2912 Action Redoes the last thing undone.
2914 \begin_layout Description
2918 \begin_layout Subsection*
2921 \begin_layout Description
2922 Action Go to the next label or cross-reference.
2924 \begin_layout Description
2925 Syntax reference-next
2927 \begin_layout Description
2928 Origin Dekel, 14 Jan 2001
2931 \begin_layout Subsection*
2934 \begin_layout Description
2935 Action Repeat the given command.
2937 \begin_layout Description
2938 Syntax repeat <COUNT> <LFUN-COMMAND>
2940 \begin_layout Description
2941 Origin Andre, 27 Oct 2003
2944 \begin_layout Subsection*
2947 \begin_layout Description
2948 Action Moves the cursor one page in downward direction.
2950 \begin_layout Description
2954 \begin_layout Subsection*
2957 \begin_layout Description
2958 Action Moves the cursor one screen in downward direction adding the current position to the selection.
2960 \begin_layout Description
2961 Syntax screen-down-select
2964 \begin_layout Subsection*
2967 \begin_layout Description
2968 Action Recenters the screen on the current cursor position.
2970 \begin_layout Description
2971 Syntax screen-recenter
2974 \begin_layout Subsection*
2977 \begin_layout Description
2978 Action Repositions the screen such that the cursor is visible.
2980 \begin_layout Description
2981 Syntax screen-show-cursor
2983 \begin_layout Description
2984 Origin vfr, 25 Mar 2009
2987 \begin_layout Subsection*
2990 \begin_layout Description
2991 Action Moves the cursor one page in upward direction.
2993 \begin_layout Description
2997 \begin_layout Subsection*
3000 \begin_layout Description
3001 Action Moves the cursor one page in upward direction adding the current position to the selection.
3003 \begin_layout Description
3004 Syntax screen-up-select
3007 \begin_layout Subsection*
3010 \begin_layout Description
3011 Action Inserts a subscript or superscript inset.
3013 \begin_layout Description
3014 Syntax script-insert <TYPE>
3016 \begin_layout Description
3017 Params <TYPE>: subscript|superscript
3019 \begin_layout Description
3020 Origin Georg, 23 Nov 2010
3023 \begin_layout Subsection*
3026 \begin_layout Description
3027 Action Scroll the buffer view.
3029 \begin_layout Description
3030 Notion Only scrolls the screen up or down; does not move the cursor.
3032 \begin_layout Description
3033 Syntax scroll <TYPE> <QUANTITY>
3035 \begin_layout Description
3036 Params <TYPE>: line|page
3037 \begin_inset Newline newline
3040 <QUANTITY>: up|down|<number>
3042 \begin_layout Description
3043 Origin Abdel, Dec 27 2007
3046 \begin_layout Subsection*
3049 \begin_layout Description
3050 Action Selects the whole section.
3052 \begin_layout Description
3053 Notion The cursor should be in a section heading before calling this lfun.
3055 \begin_layout Description
3056 Syntax section-select
3058 \begin_layout Description
3059 Origin vfr, 05 May 2009
3062 \begin_layout Subsection*
3065 \begin_layout Description
3066 Action Pastes the internal selection text in permanent selection.
3068 \begin_layout Description
3069 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
3071 \begin_layout Description
3072 Syntax selection-paste
3074 \begin_layout Description
3075 Origin lasgouttes, 14 Jan 2009
3078 \begin_layout Subsection*
3081 \begin_layout Description
3082 Action Set the group for the graphics inset on the cursor position.
3084 \begin_layout Description
3085 Syntax set-graphics-group [<GROUP>]
3087 \begin_layout Description
3088 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3090 \begin_layout Description
3091 Origin sanda, 6 May 2008
3094 \begin_layout Subsection*
3097 \begin_layout Description
3098 Action Inserts one of horizontal space insets.
3100 \begin_layout Description
3101 Syntax space-insert <NAME> [<LEN>]
3103 \begin_layout Description
3104 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
3105 \begin_inset Newline newline
3108 Only in math mode: med and thick.
3109 \begin_inset Newline newline
3112 <LEN>: length for custom spaces (hspace, hspace* for protected)
3114 \begin_layout Description
3115 Origin JSpitzm, 20 May 2003, Mar 17 2008
3118 \begin_layout Subsection*
3121 \begin_layout Description
3122 Action Inserts various characters into the document.
3124 \begin_layout Description
3125 Syntax specialchar-insert <CHAR>
3127 \begin_layout Description
3128 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
3130 \begin_layout Description
3131 Origin JSpitzm, 6 Dec 2007
3134 \begin_layout Subsection*
3137 \begin_layout Description
3138 Action Add the word under the cursor to the respective spell checker dictionary.
3140 \begin_layout Description
3141 Syntax spelling-add [<STRING>] [<LANG>]
3143 \begin_layout Description
3144 Params <WORD>: word to add <LANG>: language name (see file languages)
3146 \begin_layout Description
3147 Origin JSpitzm, 18 Jan 2010
3150 \begin_layout Subsection*
3151 spelling-continuously
3153 \begin_layout Description
3154 Action Toggle continuous spell checking.
3156 \begin_layout Description
3157 Syntax spelling-continuously
3159 \begin_layout Description
3160 Origin vfr, 24 March 2013
3163 \begin_layout Subsection*
3166 \begin_layout Description
3167 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
3169 \begin_layout Description
3170 Syntax spelling-ignore [<WORD>] [<LANG>]
3172 \begin_layout Description
3173 Params <WORD>: word to ignore <LANG>: language name (see file languages)
3175 \begin_layout Description
3176 Origin JSpitzm, 18 Jan 2010
3179 \begin_layout Subsection*
3182 \begin_layout Description
3183 Action Remove the word under the cursor from the respective spell checker dictionary.
3185 \begin_layout Description
3186 Syntax spelling-remove [<STRING>] [<LANG>]
3188 \begin_layout Description
3189 Params <WORD>: word to remove <LANG>: language name (see file languages)
3191 \begin_layout Description
3192 Origin SWitt, 28 July 2010
3195 \begin_layout Subsection*
3198 \begin_layout Description
3199 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
3201 \begin_layout Description
3202 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.
3204 \begin_layout Description
3207 \begin_layout Description
3208 Origin vfr, Sep 30 2008
3211 \begin_layout Subsection*
3214 \begin_layout Description
3215 Action Insert a tab into a listings inset.
3217 \begin_layout Description
3218 Notion It also works on a selection.
3220 \begin_layout Description
3223 \begin_layout Description
3224 Origin vfr, Sep 30 2008
3227 \begin_layout Subsection*
3230 \begin_layout Description
3231 Action Inserts table into the document.
3233 \begin_layout Description
3234 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3236 \begin_layout Description
3237 Syntax tabular-insert [<ROWS> <COLUMNS>]
3239 \begin_layout Description
3240 Params In case no arguments are given show insert dialog.
3242 \begin_layout Description
3243 Origin Jug, 12 Apr 2000
3246 \begin_layout Subsection*
3249 \begin_layout Description
3250 Action Look up thesaurus entries with respect to the word under the cursor.
3252 \begin_layout Description
3253 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
3255 \begin_layout Description
3256 Params <STRING>: word to look up <LANG>: language (see file languages)
3258 \begin_layout Description
3259 Origin Levon, 20 Jul 2001
3262 \begin_layout Subsection*
3265 \begin_layout Description
3266 Action Undoes the last edit.
3268 \begin_layout Description
3272 \begin_layout Subsection*
3275 \begin_layout Description
3276 Action Inserts a single unicode character.
3278 \begin_layout Description
3279 Syntax unicode-insert <CHAR>
3281 \begin_layout Description
3282 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
3284 \begin_layout Description
3285 Sample unicode-insert 0x0100
3287 \begin_layout Description
3288 Origin Lgb, 22 Oct 2006
3291 \begin_layout Subsection*
3294 \begin_layout Description
3295 Action Moves the cursor one line in upward direction.
3297 \begin_layout Description
3301 \begin_layout Subsection*
3304 \begin_layout Description
3305 Action Moves the cursor one line in upward direction adding the current position to the selection.
3307 \begin_layout Description
3311 \begin_layout Subsection*
3314 \begin_layout Description
3315 Action Moves the cursor to the logically previous beginning of a word.
3317 \begin_layout Description
3318 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.
3320 \begin_layout Description
3321 Syntax word-backward
3324 \begin_layout Subsection*
3325 word-backward-select
3327 \begin_layout Description
3328 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
3330 \begin_layout Description
3331 Notion See also LFUN_WORD_BACKWARD.
3333 \begin_layout Description
3334 Syntax word-backward-select
3337 \begin_layout Subsection*
3340 \begin_layout Description
3341 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
3343 \begin_layout Description
3344 Syntax word-capitalize
3347 \begin_layout Subsection*
3348 word-delete-backward
3350 \begin_layout Description
3351 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
3353 \begin_layout Description
3354 Syntax word-delete-backward
3357 \begin_layout Subsection*
3360 \begin_layout Description
3361 Action Deletes characters to the end of the word (usually the "C+Delete" key).
3363 \begin_layout Description
3364 Syntax word-delete-forward
3367 \begin_layout Subsection*
3370 \begin_layout Description
3371 Action Search for next occurrence of a string.
3373 \begin_layout Description
3374 Syntax word-find [<DATA>]
3376 \begin_layout Description
3377 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).
3379 \begin_layout Description
3380 Origin Andre, Jan 7 2004
3383 \begin_layout Subsection*
3386 \begin_layout Description
3387 Action Search for a given string in backward direction.
3389 \begin_layout Description
3390 Notion Case sensitive, match words. If no argument given, last search repeated.
3392 \begin_layout Description
3393 Syntax word-find-backward [<STRING>]
3395 \begin_layout Description
3396 Origin Etienne, 20 Feb 1998
3399 \begin_layout Subsection*
3402 \begin_layout Description
3403 Action Search for a given string in forward direction.
3405 \begin_layout Description
3406 Notion Case sensitive, match words. If no argument given, last search repeated.
3408 \begin_layout Description
3409 Syntax word-find-forward [<STRING>]
3411 \begin_layout Description
3412 Origin Etienne, 16 Feb 1998
3415 \begin_layout Subsection*
3418 \begin_layout Description
3419 Action Search for next occurrence of a pattern.
3421 \begin_layout Description
3422 Syntax word-findadv [<DATA>]
3424 \begin_layout Description
3425 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).
3427 \begin_layout Description
3428 Origin Tommaso, Nov 15 2007
3431 \begin_layout Subsection*
3434 \begin_layout Description
3435 Action Moves the cursor to the logically next beginning of a word.
3437 \begin_layout Description
3438 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.
3440 \begin_layout Description
3444 \begin_layout Subsection*
3447 \begin_layout Description
3448 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
3450 \begin_layout Description
3451 Notion See also LFUN_WORD_FORWARD.
3453 \begin_layout Description
3454 Syntax word-forward-select
3457 \begin_layout Subsection*
3460 \begin_layout Description
3461 Action Moves the cursor to the next beginning of a word "on the left".
3463 \begin_layout Description
3464 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.
3466 \begin_layout Description
3469 \begin_layout Description
3470 Origin dov, 28 Oct 2007
3473 \begin_layout Subsection*
3476 \begin_layout Description
3477 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
3479 \begin_layout Description
3480 Notion See also LFUN_WORD_LEFT for exact details of the movement.
3482 \begin_layout Description
3483 Syntax word-left-select
3485 \begin_layout Description
3486 Origin dov, 28 Oct 2007
3489 \begin_layout Subsection*
3492 \begin_layout Description
3493 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
3495 \begin_layout Description
3499 \begin_layout Subsection*
3502 \begin_layout Description
3503 Action Replace a string in the document.
3505 \begin_layout Description
3506 Syntax word-replace [<DATA>]
3508 \begin_layout Description
3509 Params <DATA>: data is of the form "<replace>
3510 \begin_inset Newline newline
3514 \begin_inset Newline newline
3517 <casesensitive> <matchword> <all> <forward> <findnext>"
3519 \begin_layout Description
3520 Origin Andre, Jan 7 2004
3523 \begin_layout Subsection*
3526 \begin_layout Description
3527 Action Moves the cursor to the next beginning of a word "on the right".
3529 \begin_layout Description
3530 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.
3532 \begin_layout Description
3535 \begin_layout Description
3536 Origin dov, 28 Oct 2007
3539 \begin_layout Subsection*
3542 \begin_layout Description
3543 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
3545 \begin_layout Description
3546 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
3548 \begin_layout Description
3549 Syntax word-right-select
3551 \begin_layout Description
3552 Origin dov, 28 Oct 2007
3555 \begin_layout Subsection*
3558 \begin_layout Description
3559 Action Puts the word where the cursor stands into the selection.
3561 \begin_layout Description
3564 \begin_layout Description
3565 Origin Andre, 11 Sep 2002
3568 \begin_layout Subsection*
3571 \begin_layout Description
3572 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
3574 \begin_layout Description
3578 \begin_layout Subsection*
3581 \begin_layout Description
3582 Action Inserts floats wrapped by the text around.
3584 \begin_layout Description
3585 Syntax wrap-insert <TYPE>
3587 \begin_layout Description
3588 Params <TYPE>: table|figure
3590 \begin_layout Description
3591 Origin Dekel, 7 Apr 2002
3594 \begin_layout Section
3595 Math Editor Functions
3597 \begin_layout Subsection*
3598 in-mathmacrotemplate
3600 \begin_layout Description
3601 Action Only active in Math Macro definition.
3603 \begin_layout Description
3604 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.
3606 \begin_layout Description
3607 Syntax in-mathmacrotemplate
3609 \begin_layout Description
3610 Origin sts, 06 January 2008
3613 \begin_layout Subsection*
3616 \begin_layout Description
3617 Action Inserts an extended matrix as provided by the amsmath package.
3619 \begin_layout Description
3620 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
3622 \begin_layout Description
3623 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created. Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and matrix. The default is 'matrix'.
3625 \begin_layout Description
3626 Sample math-ams-matrix 3 3 bmatrix
3629 \begin_layout Subsection*
3632 \begin_layout Description
3633 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
3635 \begin_layout Description
3636 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
3638 \begin_layout Description
3639 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
3640 \begin_inset Newline newline
3643 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
3645 \begin_layout Description
3646 Sample math-bigdelim "Bigl" "
3652 \begin_layout Description
3653 Origin Enrico & Georg, 7 May 2006
3656 \begin_layout Subsection*
3659 \begin_layout Description
3660 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
3662 \begin_layout Description
3663 Syntax math-delim [<LEFT>] [<RIGHT>]
3665 \begin_layout Description
3666 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.
3668 \begin_layout Description
3669 Sample math-delim { rangle
3671 \begin_layout Description
3672 Origin Alejandro, 18 Jun 1996
3675 \begin_layout Subsection*
3678 \begin_layout Description
3679 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
3681 \begin_layout Description
3682 Syntax math-display [<ARG>]
3684 \begin_layout Description
3685 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
3687 \begin_layout Description
3688 Origin Alejandro, 18 Jun 1996
3691 \begin_layout Subsection*
3694 \begin_layout Description
3695 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
3697 \begin_layout Description
3698 Notion Selection can be used to determine the input for the external program.
3700 \begin_layout Description
3701 Syntax math-extern <LANG> [<COMMAND>]
3703 \begin_layout Description
3704 Params <LANG>: octave|maxima|maple|mathematica|script
3705 \begin_inset Newline newline
3708 where "script" stands for the external script (normalized expression will be passed)
3710 \begin_layout Description
3711 Sample math-extern maple simplify
3713 \begin_layout Description
3714 Origin Andre, 24 Apr 2001
3717 \begin_layout Subsection*
3720 \begin_layout Description
3721 Action Changes the text style used in math.
3723 \begin_layout Description
3724 Syntax math-font-style <STYLE>
3726 \begin_layout Description
3727 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
3728 \begin_inset Newline newline
3731 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
3733 \begin_layout Description
3734 Origin vfr, 9 jan 2009
3737 \begin_layout Subsection*
3740 \begin_layout Description
3741 Action Inserts math objects and symbols.
3743 \begin_layout Description
3744 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
3746 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
3748 frac{x}{y}" replaces "abc" with "
3750 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.
3752 \begin_layout Description
3753 Syntax math-insert <ARG>
3755 \begin_layout Description
3756 Params <ARG>: Symbol or LaTeX code to be inserted.
3759 \begin_layout Subsection*
3762 \begin_layout Description
3763 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.
3765 \begin_layout Description
3766 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
3768 \begin_layout Description
3769 Syntax math-limits [<STATE>]
3771 \begin_layout Description
3772 Params <STATE>: limits|nolimits
3775 \begin_layout Subsection*
3778 \begin_layout Description
3779 Action Inserts a math macro definition at the cursor position in the text.
3781 \begin_layout Description
3782 Syntax math-macro <NAME> [<NARGS>] [def]
3784 \begin_layout Description
3785 Params <NAME>: The name of the macro, e.g. "mymacro".
3786 \begin_inset Newline newline
3789 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
3791 \begin_layout Description
3792 Origin ale, 10 May 1997; sts, 21 Dec 2007
3795 \begin_layout Subsection*
3796 math-macro-add-greedy-optional-param
3798 \begin_layout Description
3799 Action Add a greedy optional parameter.
3801 \begin_layout Description
3802 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
3804 \begin_layout Description
3805 Syntax math-macro-add-greedy-optional-param
3807 \begin_layout Description
3808 Origin sts, 06 January 2008
3811 \begin_layout Subsection*
3812 math-macro-add-optional-param
3814 \begin_layout Description
3815 Action Add an optional parameter.
3817 \begin_layout Description
3818 Notion Insert an optional parameter just behind the already existing optional parameters.
3820 \begin_layout Description
3821 Syntax math-macro-add-optional-param
3823 \begin_layout Description
3824 Origin sts, 06 January 2008
3827 \begin_layout Subsection*
3828 math-macro-add-param
3830 \begin_layout Description
3831 Action Add a parameter.
3833 \begin_layout Description
3834 Notion Add a parameter to a Math Macro.
3836 \begin_layout Description
3837 Syntax math-macro-add-param <NUM>
3839 \begin_layout Description
3840 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.
3842 \begin_layout Description
3843 Origin sts, 06 January 2008
3846 \begin_layout Subsection*
3847 math-macro-append-greedy-param
3849 \begin_layout Description
3850 Action Append a greedy parameter.
3852 \begin_layout Description
3853 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
3855 \begin_layout Description
3856 Syntax math-macro-append-greedy-param
3858 \begin_layout Description
3859 Origin sts, 06 January 2008
3862 \begin_layout Subsection*
3865 \begin_layout Description
3866 Action Fold a Math Macro.
3868 \begin_layout Description
3869 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
3873 \begin_layout Description
3874 Syntax math-macro-fold
3876 \begin_layout Description
3877 Origin sts, 06 January 2008
3880 \begin_layout Subsection*
3881 math-macro-make-nonoptional
3883 \begin_layout Description
3884 Action Make a parameter non-optional.
3886 \begin_layout Description
3887 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.
3889 \begin_layout Description
3890 Syntax math-macro-make-nonoptional
3892 \begin_layout Description
3893 Origin sts, 06 January 2008
3896 \begin_layout Subsection*
3897 math-macro-make-optional
3899 \begin_layout Description
3900 Action Make a parameter optional.
3902 \begin_layout Description
3903 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
3905 \begin_layout Description
3906 Syntax math-macro-make-optional
3908 \begin_layout Description
3909 Origin sts, 06 January 2008
3912 \begin_layout Subsection*
3913 math-macro-remove-greedy-param
3915 \begin_layout Description
3916 Action Remove a greedy parameter.
3918 \begin_layout Description
3919 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.
3921 \begin_layout Description
3922 Syntax math-macro-remove-greedy-param
3924 \begin_layout Description
3925 Origin sts, 06 January 2008
3928 \begin_layout Subsection*
3929 math-macro-remove-optional-param
3931 \begin_layout Description
3932 Action Remove the last optional parameter.
3934 \begin_layout Description
3935 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
3937 \begin_layout Description
3938 Syntax math-macro-remove-optional-param
3940 \begin_layout Description
3941 Origin sts, 06 January 2008
3944 \begin_layout Subsection*
3945 math-macro-remove-param
3947 \begin_layout Description
3948 Action Remove the last parameter.
3950 \begin_layout Description
3951 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
3953 \begin_layout Description
3954 Syntax math-macro-remove-param <NUM>
3956 \begin_layout Description
3957 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
3959 \begin_layout Description
3960 Origin sts, 06 January 2008
3963 \begin_layout Subsection*
3966 \begin_layout Description
3967 Action Unfold a Math Macro.
3969 \begin_layout Description
3970 Notion Unfold the Math Macro the cursor is in, i.e. display it as
3974 \begin_layout Description
3975 Syntax math-macro-unfold
3977 \begin_layout Description
3978 Origin sts, 06 January 2008
3981 \begin_layout Subsection*
3984 \begin_layout Description
3985 Action Inserts a matrix.
3987 \begin_layout Description
3988 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3990 \begin_layout Description
3991 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).
3993 \begin_layout Description
3994 Sample math-matrix 3 3 bccc
3997 \begin_layout Subsection*
4000 \begin_layout Description
4001 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.
4003 \begin_layout Description
4004 Notion If there is some selected text, it puts the text inside created math box.
4006 \begin_layout Description
4007 Syntax math-mode [on|<ARG>]
4009 \begin_layout Description
4010 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
4011 \begin_inset Newline newline
4014 "on": allow only entering of math mode from text mode.
4016 \begin_layout Description
4017 Origin Alejandro, 4 Jun 1996
4020 \begin_layout Subsection*
4023 \begin_layout Description
4024 Action Mutates the type of math inset to the newly selected one.
4026 \begin_layout Description
4027 Syntax math-mutate <TYPE>
4029 \begin_layout Description
4030 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
4032 \begin_layout Description
4033 Origin Andre, 23 May 2001
4036 \begin_layout Subsection*
4037 math-number-line-toggle
4039 \begin_layout Description
4040 Action Toggles numbering of the current formula line.
4042 \begin_layout Description
4043 Notion Must be in display formula mode.
4045 \begin_layout Description
4046 Syntax math-number-line-toggle
4048 \begin_layout Description
4049 Origin Alejandro, 18 Jun 1996
4052 \begin_layout Subsection*
4055 \begin_layout Description
4056 Action Toggles numbering/labeling of the current formula.
4058 \begin_layout Description
4059 Notion Must be in display formula mode.
4061 \begin_layout Description
4062 Syntax math-number-toggle
4064 \begin_layout Description
4065 Origin Alejandro, 4 Jun 1996
4068 \begin_layout Subsection*
4071 \begin_layout Description
4072 Action Changes arbitrarily the size used by math fonts inside a context.
4074 \begin_layout Description
4075 Notion Provides an interface to the LaTeX math mode font size commands.
4077 \begin_layout Description
4078 Syntax math-size <STYLE>
4080 \begin_layout Description
4091 \begin_layout Description
4092 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
4095 \begin_layout Subsection*
4098 \begin_layout Description
4099 Action Inserts space into math expression.
4101 \begin_layout Description
4102 Notion Use spacebar after entering this space to change type of space.
4104 \begin_layout Description
4105 Syntax math-space [<TYPE>] [<LEN>]
4107 \begin_layout Description
4108 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
4109 \begin_inset Newline newline
4112 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
4113 \begin_inset Newline newline
4116 custom space: hspace
4117 \begin_inset Newline newline
4120 "," used by default.
4121 \begin_inset Newline newline
4124 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
4125 \begin_inset Newline newline
4128 <LEN>: length for custom spaces (hspace)
4130 \begin_layout Description
4131 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
4134 \begin_layout Subsection*
4137 \begin_layout Description
4138 Action Enters subscript expression in math expression.
4140 \begin_layout Description
4141 Syntax math-subscript
4143 \begin_layout Description
4144 Origin vermeer, 12 Dec 2001
4147 \begin_layout Subsection*
4150 \begin_layout Description
4151 Action Enters superscript expression in math expression.
4153 \begin_layout Description
4154 Syntax math-superscript
4156 \begin_layout Description
4157 Origin vermeer, 12 Dec 2001
4160 \begin_layout Subsection*
4163 \begin_layout Description
4164 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
4166 \begin_layout Description
4167 Notion If there is any selected text, then it is moved inside the created regexp inset.
4169 \begin_layout Description
4170 Syntax regexp-mode [<ARG>]
4172 \begin_layout Description
4173 Params <ARG>: eventual argument (regular expression).
4175 \begin_layout Description
4176 Origin Tommaso, 4 Oct 2008
4179 \begin_layout Section
4180 Buffer Fuctions (File and Window related)
4182 \begin_layout Subsection*
4185 \begin_layout Description
4186 Action Activate the branch.
4188 \begin_layout Description
4189 Syntax branch-activate <BRANCH>
4191 \begin_layout Description
4192 Params <BRANCH>: The branch to activate
4194 \begin_layout Description
4195 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
4196 \begin_inset Newline newline
4199 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
4201 \begin_layout Description
4202 Origin rgh, 27 May 2008
4205 \begin_layout Subsection*
4208 \begin_layout Description
4209 Action Add a branch to the buffer's BranchList.
4211 \begin_layout Description
4212 Syntax branch-add <BRANCH>
4214 \begin_layout Description
4215 Params <BRANCH>: Name of the branch to add
4217 \begin_layout Description
4218 Origin spitz, 7 Jul 2009
4221 \begin_layout Subsection*
4224 \begin_layout Description
4225 Action Create new branch and directly put the branch inset into the document.
4227 \begin_layout Description
4228 Syntax branch-add-insert [<NAME>]
4230 \begin_layout Description
4231 Params <NAME>: Branch name. If it is not specified, you will be asked.
4233 \begin_layout Description
4234 Origin sanda, 10 Jul 2009
4237 \begin_layout Subsection*
4240 \begin_layout Description
4241 Action De-activate the branch.
4243 \begin_layout Description
4244 Syntax branch-deactivate <BRANCH>
4246 \begin_layout Description
4247 Params <BRANCH>: The branch to deactivate
4249 \begin_layout Description
4250 Origin rgh, 27 May 2008
4253 \begin_layout Subsection*
4254 branch-master-activate
4256 \begin_layout Description
4257 Action Activate the branch in the master buffer.
4259 \begin_layout Description
4260 Syntax branch-master-activate <BRANCH>
4262 \begin_layout Description
4263 Params <BRANCH>: The branch to activate
4265 \begin_layout Description
4266 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
4267 \begin_inset Newline newline
4270 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
4272 \begin_layout Description
4273 Origin spitz, 30 Sep 2012
4276 \begin_layout Subsection*
4277 branch-master-deactivate
4279 \begin_layout Description
4280 Action De-activate the branch in the master buffer.
4282 \begin_layout Description
4283 Syntax branch-master-deactivate <BRANCH>
4285 \begin_layout Description
4286 Params <BRANCH>: The branch to deactivate
4288 \begin_layout Description
4289 Origin spitz, 30 Sep 2012
4292 \begin_layout Subsection*
4295 \begin_layout Description
4296 Action Rename all branches of a given name in a document.
4298 \begin_layout Description
4299 Syntax branches-rename <OLDNAME> <NEWNAME>
4301 \begin_layout Description
4302 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
4304 \begin_layout Description
4305 Origin spitz, 9 Jul 2009
4308 \begin_layout Subsection*
4311 \begin_layout Description
4312 Action Saves the current buffer to a temporary file.
4314 \begin_layout Description
4315 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4317 \begin_layout Description
4318 Syntax buffer-auto-save
4321 \begin_layout Subsection*
4324 \begin_layout Description
4325 Action Loads the given child document.
4327 \begin_layout Description
4328 Notion The current document is treated as a parent.
4330 \begin_layout Description
4331 Syntax buffer-child-open <FILE>
4333 \begin_layout Description
4334 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4336 \begin_layout Description
4337 Origin Ale, 28 May 1997
4340 \begin_layout Subsection*
4343 \begin_layout Description
4344 Action Runs chktex for the current document.
4346 \begin_layout Description
4347 Syntax buffer-chktex
4349 \begin_layout Description
4350 Origin Asger, 30 Oct 1997
4353 \begin_layout Subsection*
4356 \begin_layout Description
4357 Action Closes the current buffer.
4359 \begin_layout Description
4360 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4362 \begin_layout Description
4366 \begin_layout Subsection*
4369 \begin_layout Description
4370 Action Closes all buffers.
4372 \begin_layout Description
4373 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4375 \begin_layout Description
4376 Syntax buffer-close-all
4379 \begin_layout Subsection*
4382 \begin_layout Description
4383 Action Exports the current buffer (document) to the given format.
4385 \begin_layout Description
4386 Syntax buffer-export <FORMAT> [<DEST>]
4388 \begin_layout Description
4389 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.
4390 \begin_inset Newline newline
4393 In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM. <DEST> If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
4395 \begin_layout Description
4396 Origin Lgb, 29 Jul 1997
4399 \begin_layout Subsection*
4402 \begin_layout Description
4403 Action Opens a dialog for exporting the current buffer.
4405 \begin_layout Description
4406 Syntax buffer-export-as [<FORMAT>]
4408 \begin_layout Description
4409 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.
4411 \begin_layout Description
4412 Sample buffer-export-as pdf2
4414 \begin_layout Description
4415 Origin tommaso, 6 Oct 2011
4418 \begin_layout Subsection*
4419 buffer-export-custom
4421 \begin_layout Description
4422 Action Exports the current buffer (document) from the given format using the given command on it.
4424 \begin_layout Description
4425 Syntax buffer-export-custom <FORMAT> <COMMAND>
4427 \begin_layout Description
4428 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4429 \begin_inset Newline newline
4432 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4434 \begin_layout Description
4435 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4437 \begin_layout Description
4438 Origin leeming, 27 Mar 2004
4441 \begin_layout Subsection*
4444 \begin_layout Description
4445 Action Applies a command to all non-hidden buffers.
4447 \begin_layout Description
4448 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
4450 \begin_layout Description
4451 Syntax buffer-forall <LFUN-COMMAND>
4453 \begin_layout Description
4454 Params <LFUN-COMMAND>: The command to be applied to the buffers.
4456 \begin_layout Description
4457 Sample Close all Notes in buffers:
4458 \begin_inset Newline newline
4461 buffer-forall inset-forall Note inset-toggle close
4462 \begin_inset Newline newline
4465 Toggle change tracking on buffers:
4466 \begin_inset Newline newline
4469 buffer-forall changes-track
4470 \begin_inset Newline newline
4473 Toggle read-only for buffers:
4474 \begin_inset Newline newline
4477 buffer-forall buffer-toggle-read-only
4478 \begin_inset Newline newline
4481 Show statistics for individual buffers:
4482 \begin_inset Newline newline
4485 buffer-forall statistics
4486 \begin_inset Newline newline
4489 Activate the branch named "Solutions" in buffers:
4490 \begin_inset Newline newline
4493 buffer-forall branch-activate Solutions
4494 \begin_inset Newline newline
4497 Export buffers to PDF (pdflatex):
4498 \begin_inset Newline newline
4501 buffer-forall buffer-export pdf2
4502 \begin_inset Newline newline
4507 \begin_layout Description
4508 Origin scottkostyshak, 20 Jul 2012
4511 \begin_layout Subsection*
4514 \begin_layout Description
4515 Action Import a given file as a lyx document.
4517 \begin_layout Description
4518 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.
4520 \begin_layout Description
4521 Syntax buffer-import <FORMAT> [<FILE>]
4523 \begin_layout Description
4524 Origin Asger, 24 Jul 1998
4527 \begin_layout Subsection*
4530 \begin_layout Description
4531 Action Set language of the current document.
4533 \begin_layout Description
4534 Syntax buffer-language <LANG>
4536 \begin_layout Description
4537 Params <LANG>: language name. See lib/languages for list.
4539 \begin_layout Description
4540 Origin leeming, 30 Mar 2004
4543 \begin_layout Subsection*
4546 \begin_layout Description
4547 Action Creates a new buffer (that is, document) and switches to it.
4549 \begin_layout Description
4550 Notion Implicit path can be set in Preferences dialog.
4552 \begin_layout Description
4553 Syntax buffer-new [<FILE>]
4555 \begin_layout Description
4556 Params <FILE>: filename of created file with absolute path.
4559 \begin_layout Subsection*
4562 \begin_layout Description
4563 Action Creates a new buffer (that is, document) from a template.
4565 \begin_layout Description
4566 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4568 \begin_layout Description
4569 Syntax buffer-new-template [<FILE>]
4571 \begin_layout Description
4572 Params <FILE>: filename of created file with absolute path.
4575 \begin_layout Subsection*
4578 \begin_layout Description
4579 Action Switch to the next opened document.
4581 \begin_layout Description
4582 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4584 \begin_layout Description
4588 \begin_layout Subsection*
4591 \begin_layout Description
4592 Action Apply the given settings to the current document.
4594 \begin_layout Description
4595 Syntax buffer-params-apply [<ARGS>]
4597 \begin_layout Description
4598 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4600 \begin_layout Description
4601 Origin leeming, 30 Mar 2004
4604 \begin_layout Subsection*
4607 \begin_layout Description
4608 Action Switch to the previous opened document.
4610 \begin_layout Description
4611 Syntax buffer-previous
4614 \begin_layout Subsection*
4617 \begin_layout Description
4618 Action Prints the current document.
4620 \begin_layout Description
4621 Notion Many settings can be given via the preferences dialog.
4623 \begin_layout Description
4624 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4626 \begin_layout Description
4627 Params <TARGET> is either "printer" or "file".
4628 \begin_inset Newline newline
4631 <TARGER-NAME> is either "default" or file name or printer name.
4632 \begin_inset Newline newline
4635 <COMMAND> command ensuring the printing job.
4637 \begin_layout Description
4638 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4640 \begin_layout Description
4641 Origin leeming, 28 Mar 2004
4644 \begin_layout Subsection*
4647 \begin_layout Description
4648 Action Reverts opened document.
4650 \begin_layout Description
4651 Syntax buffer-reload
4653 \begin_layout Description
4654 Origin Asger, 2 Feb 1997
4657 \begin_layout Subsection*
4658 buffer-save-as-default
4660 \begin_layout Description
4661 Action Save the current document settings as default.
4663 \begin_layout Description
4664 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4666 \begin_layout Description
4667 Syntax buffer-save-as-default [<ARGS>]
4669 \begin_layout Description
4670 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4672 \begin_layout Description
4673 Origin leeming, 30 Mar 2004
4676 \begin_layout Subsection*
4679 \begin_layout Description
4680 Action Display and switch to the given buffer.
4682 \begin_layout Description
4683 Syntax buffer-switch <BUFFER>
4685 \begin_layout Description
4686 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
4689 \begin_layout Subsection*
4690 buffer-toggle-compression
4692 \begin_layout Description
4693 Action Toggles compression of the current document on/off.
4695 \begin_layout Description
4696 Syntax buffer-toggle-compression
4698 \begin_layout Description
4699 Origin bpeng, 27 Apr 2006
4702 \begin_layout Subsection*
4703 buffer-toggle-read-only
4705 \begin_layout Description
4706 Action Toggle editing mode of the current document between read/write and read-only.
4708 \begin_layout Description
4709 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.
4711 \begin_layout Description
4712 Syntax buffer-toggle-read-only
4714 \begin_layout Description
4715 Origin Lgb, 27 May 1997
4718 \begin_layout Subsection*
4721 \begin_layout Description
4722 Action Exports the current document and put the result into the temporary directory.
4724 \begin_layout Description
4725 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).
4727 \begin_layout Description
4728 Syntax buffer-update [<FORMAT>]
4730 \begin_layout Description
4731 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.
4733 \begin_layout Description
4734 Origin Dekel, 5 Aug 2000
4737 \begin_layout Subsection*
4740 \begin_layout Description
4741 Action Displays current buffer in chosen format.
4743 \begin_layout Description
4744 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.
4746 \begin_layout Description
4747 Syntax buffer-view [<FORMAT>]
4749 \begin_layout Description
4750 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.
4753 \begin_layout Subsection*
4756 \begin_layout Description
4757 Action Saves the current buffer.
4759 \begin_layout Description
4760 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.
4762 \begin_layout Description
4766 \begin_layout Subsection*
4769 \begin_layout Description
4770 Action Save all changed documents.
4772 \begin_layout Description
4773 Syntax buffer-write-all
4775 \begin_layout Description
4776 Origin rgh, gpothier 6 Aug 2007
4779 \begin_layout Subsection*
4782 \begin_layout Description
4783 Action Rename and save current buffer.
4785 \begin_layout Description
4786 Syntax buffer-write-as <FILENAME>
4788 \begin_layout Description
4789 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4792 \begin_layout Subsection*
4795 \begin_layout Description
4796 Action Increases the zoom of the screen fonts.
4798 \begin_layout Description
4799 Syntax buffer-zoom-in [<ZOOM>]
4801 \begin_layout Description
4802 Params <ZOOM>: The zoom in %, the default is 20.
4804 \begin_layout Description
4805 Origin vfr, 30 Mar 2009
4808 \begin_layout Subsection*
4811 \begin_layout Description
4812 Action Decreases the zoom of the screen fonts.
4814 \begin_layout Description
4815 Syntax buffer-zoom-out [<ZOOM>]
4817 \begin_layout Description
4818 Params <ZOOM>: The zoom in %, the default is 20.
4820 \begin_layout Description
4821 Origin vfr, 30 Mar 2009
4824 \begin_layout Subsection*
4827 \begin_layout Description
4828 Action Generates the code (literate programming).
4830 \begin_layout Description
4831 Notion Latex file with extension
4833 literate_extension is generated. Then LyX invokes
4835 build_command (with a default of ``make'') to generate the code and
4837 build_error_filter to process the compilation error messages.
4838 \begin_inset Newline newline
4841 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:
4842 \begin_inset Newline newline
4847 build_command "my_script my_arguments"
4848 \begin_inset Newline newline
4853 build_error_filter differs from the
4855 literate_error_filter only in that the former will identify error messages from your compiler.
4857 \begin_layout Description
4858 Syntax build-program
4861 \begin_layout Subsection*
4864 \begin_layout Description
4865 Action Open LyX document.
4867 \begin_layout Description
4868 Syntax file-open [<FILE>]
4870 \begin_layout Description
4871 Params <FILE>: Filename to be opened.
4874 \begin_layout Subsection*
4877 \begin_layout Description
4878 Action Open the given help file according to the language setting.
4880 \begin_layout Description
4881 Syntax help-open <FILE>[.lyx]
4883 \begin_layout Description
4884 Params <FILE>: any document from (/usr/share/)doc directory.
4886 \begin_layout Description
4887 Origin Jug, 27 Jun 1999
4890 \begin_layout Subsection*
4893 \begin_layout Description
4894 Action Terminates the current LyX instance.
4896 \begin_layout Description
4897 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
4899 \begin_layout Description
4903 \begin_layout Subsection*
4904 master-buffer-update
4906 \begin_layout Description
4907 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
4909 \begin_layout Description
4910 Syntax master-buffer-update [<FORMAT>]
4912 \begin_layout Description
4913 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.
4915 \begin_layout Description
4916 Origin Tommaso, 20 Sep 2007
4919 \begin_layout Subsection*
4922 \begin_layout Description
4923 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
4925 \begin_layout Description
4926 Syntax master-buffer-view [<FORMAT>]
4928 \begin_layout Description
4929 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.
4931 \begin_layout Description
4932 Origin Tommaso, 20 Sep 2007
4935 \begin_layout Subsection*
4938 \begin_layout Description
4939 Action Opens the menu given by its name.
4941 \begin_layout Description
4942 Syntax menu-open <NAME>
4944 \begin_layout Description
4945 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
4948 \begin_layout Subsection*
4951 \begin_layout Description
4952 Action Close the current tab group.
4954 \begin_layout Description
4955 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
4957 \begin_layout Description
4958 Syntax tab-group-close
4960 \begin_layout Description
4961 Origin Abdel, 21 Feb 2008
4964 \begin_layout Subsection*
4967 \begin_layout Description
4968 Action Toggles visibility of a given toolbar between on/off/auto.
4970 \begin_layout Description
4971 Notion Skipping "auto" when allowauto is false.
4973 \begin_layout Description
4974 Syntax toolbar-toggle <NAME> [allowauto]
4976 \begin_layout Description
4977 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
4978 \begin_inset Newline newline
4981 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
4983 \begin_layout Description
4984 Origin Edwin, 21 May 2007
4987 \begin_layout Subsection*
4990 \begin_layout Description
4991 Action Various UI visibility-toggling actions.
4993 \begin_layout Description
4994 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
4996 \begin_layout Description
4997 Params statusbar : Toggle visibility of the statusbar.
4998 \begin_inset Newline newline
5001 menubar : Toggle visibility of the menubar.
5002 \begin_inset Newline newline
5005 scrollbar : Toggle visibility of the scrollbar.
5006 \begin_inset Newline newline
5009 frame : Toggle visibility of the frames around editing window.
5010 \begin_inset Newline newline
5013 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.
5015 \begin_layout Description
5016 Origin sanda, 9 Feb 2007
5019 \begin_layout Subsection*
5022 \begin_layout Description
5023 Action Close the current document work area.
5025 \begin_layout Description
5026 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
5028 \begin_layout Description
5031 \begin_layout Description
5032 Origin Tommaso, 15 Sep 2012
5035 \begin_layout Subsection*
5038 \begin_layout Description
5039 Action Creates another split view of current buffer.
5041 \begin_layout Description
5042 Notion All split views act in the same way independently.
5044 \begin_layout Description
5045 Syntax view-split <vertical|horizontal>
5047 \begin_layout Description
5048 Params horizontal : The work areas are laid out side by side.
5049 \begin_inset Newline newline
5052 vertical : The work areas laid out vertically.
5054 \begin_layout Description
5055 Origin Abdel, 20 Feb 2008
5058 \begin_layout Subsection*
5061 \begin_layout Description
5062 Action Closes the current LyX window.
5064 \begin_layout Description
5067 \begin_layout Description
5068 Origin Abdel, 23 Oct 2006
5071 \begin_layout Subsection*
5074 \begin_layout Description
5075 Action Creates new empty LyX window.
5077 \begin_layout Description
5078 Notion Already opened documents from the previous window can be found under View menu.
5080 \begin_layout Description
5081 Syntax window-new [<GEOMETRY>]
5083 \begin_layout Description
5084 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
5086 \begin_layout Description
5087 Origin Abdel, 21 Oct 2006
5090 \begin_layout Section
5091 System Functions (Preferences, LyX Server etc.)
5093 \begin_layout Subsection*
5094 buffer-toggle-output-sync
5096 \begin_layout Description
5097 Action Toggles including of resources for forward/reverse search of the given document.
5099 \begin_layout Description
5100 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
5102 \begin_layout Description
5103 Syntax buffer-toggle-output-sync
5105 \begin_layout Description
5106 Origin sanda, 25 May 2010
5109 \begin_layout Subsection*
5112 \begin_layout Description
5113 Action Executes a command defined in a .def file.
5115 \begin_layout Description
5116 Notion The definitions are by default read from lib/commands/default.def.
5117 \begin_inset Newline newline
5120 A .def file allows to define a command with
5122 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).
5124 def_file "FileName" allows to include another .def file.
5125 \begin_inset Newline newline
5128 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.
5130 \begin_layout Description
5133 \begin_layout Description
5134 Params <NAME>: Name of the command that must be called.
5136 \begin_layout Description
5137 Origin broider, 2 Oct 2007
5140 \begin_layout Subsection*
5143 \begin_layout Description
5144 Action Cancels sequence prepared by LFUN_META_PREFIX .
5146 \begin_layout Description
5150 \begin_layout Subsection*
5151 command-alternatives
5153 \begin_layout Description
5154 Action Runs the first listed command that is enabled.
5156 \begin_layout Description
5157 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
5159 \begin_layout Description
5160 Syntax command-alternatives <CMDS>
5162 \begin_layout Description
5163 Params <CMDS>: Sequence of commands separated by semicolons.
5165 \begin_layout Description
5166 Sample command-alternatives completion-accept;cell-forward
5168 \begin_layout Description
5169 Origin rgh, 24 September 2008
5172 \begin_layout Subsection*
5175 \begin_layout Description
5176 Action Run more commands (LFUN and its parameters) in a sequence.
5178 \begin_layout Description
5179 Syntax command-sequence <CMDS>
5181 \begin_layout Description
5182 Params <CMDS>: Sequence of commands separated by semicolons.
5184 \begin_layout Description
5185 Sample command-sequence cut; ert-insert; self-insert
5187 ; paste; self-insert {}; inset-toggle;
5189 \begin_layout Description
5190 Origin Andre, 11 Nov 1999
5193 \begin_layout Subsection*
5194 cursor-follows-scrollbar-toggle
5196 \begin_layout Description
5197 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
5199 \begin_layout Description
5200 Syntax toggle-cursor-follows-scrollbar
5202 \begin_layout Description
5203 Origin ARRae, 2 Dec 1997
5206 \begin_layout Subsection*
5209 \begin_layout Description
5210 Action Set debug output level.
5212 \begin_layout Description
5213 Syntax debug-level-set <LEVEL>
5215 \begin_layout Description
5216 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.
5218 \begin_layout Description
5219 Origin sanda, 28 Dec 2009
5222 \begin_layout Subsection*
5225 \begin_layout Description
5226 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
5228 \begin_layout Description
5229 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
5231 \begin_layout Description
5232 Syntax forward-search
5234 \begin_layout Description
5235 Origin sanda, 14 Apr 2010
5238 \begin_layout Subsection*
5241 \begin_layout Description
5242 Action Apply the given settings to user preferences.
5244 \begin_layout Description
5245 Syntax lyxrc-apply <SETTINGS>
5247 \begin_layout Description
5248 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.
5251 \begin_layout Subsection*
5254 \begin_layout Description
5255 Action Shows message in statusbar (for script purposes).
5257 \begin_layout Description
5258 Syntax message <STRING>
5260 \begin_layout Description
5261 Origin Lgb, 8 Apr 2001
5264 \begin_layout Subsection*
5267 \begin_layout Description
5268 Action Simulate halting Meta key (Alt key on PCs).
5270 \begin_layout Description
5271 Notion Used for buffer edition not for GUI control.
5273 \begin_layout Description
5277 \begin_layout Subsection*
5280 \begin_layout Description
5281 Action Save user preferences.
5283 \begin_layout Description
5284 Syntax preferences-save
5286 \begin_layout Description
5287 Origin Lgb, 27 Nov 1999
5290 \begin_layout Subsection*
5293 \begin_layout Description
5294 Action Reconfigure the automatic settings.
5296 \begin_layout Description
5299 \begin_layout Description
5300 Origin Asger, 14 Feb 1997
5303 \begin_layout Subsection*
5306 \begin_layout Description
5307 Action Returns path and file name of the currently edited document.
5309 \begin_layout Description
5310 Syntax server-get-filename
5313 \begin_layout Subsection*
5316 \begin_layout Description
5317 Action Returns the current layout (that is environment) name on the cursor position.
5319 \begin_layout Description
5320 Syntax server-get-layout
5323 \begin_layout Subsection*
5326 \begin_layout Description
5327 Action Returns the coordinates of cursor position in the editing area.
5329 \begin_layout Description
5330 Syntax server-get-xy
5333 \begin_layout Subsection*
5334 server-goto-file-row
5336 \begin_layout Description
5337 Action Sets the cursor position in LyX based on the row number of generated TeX file.
5339 \begin_layout Description
5340 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).
5342 \begin_layout Description
5343 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5345 \begin_layout Description
5346 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.
5347 \begin_inset Newline newline
5350 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).
5351 \begin_inset Newline newline
5354 .ext: extensions will be automatically replaced by .lyx.
5355 \begin_inset Newline newline
5358 <ROW_NUMBER> The row number of the LaTeX file to which to go.
5360 \begin_layout Description
5361 Sample server-goto-file-row /home/user/example.lyx 41
5362 \begin_inset Newline newline
5365 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
5367 \begin_layout Description
5368 Origin Edmar, 23 Dec 1998
5371 \begin_layout Subsection*
5374 \begin_layout Description
5375 Action Sends notify message about the last key-sequence to client.
5377 \begin_layout Description
5378 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
5380 \begin_layout Description
5381 Syntax server-notify
5384 \begin_layout Subsection*
5387 \begin_layout Description
5388 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
5390 \begin_layout Description
5391 Syntax server-set-xy <X> <Y>
5394 \begin_layout Subsection*
5397 \begin_layout Description
5398 Action Set the given LyX color to the color defined by the X11 name given.
5400 \begin_layout Description
5401 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5403 \begin_layout Description
5404 Syntax set-color <LYX_NAME> <X11_NAME>
5406 \begin_layout Description
5407 Origin SLior, 11 Jun 2000
5410 \begin_layout Subsection*
5413 \begin_layout Description
5414 Action Count the statistics (number of words and characters) in the document or in the given selection.
5416 \begin_layout Description
5417 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5419 \begin_layout Description
5422 \begin_layout Description
5423 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5426 \begin_layout Subsection*
5429 \begin_layout Description
5430 Action Checks-in/commits the changes of the registered file to the repository.
5432 \begin_layout Description
5433 Notion In RCS case this also unlocks the file.
5435 \begin_layout Description
5438 \begin_layout Description
5439 Origin Lgb, 1 Jul 1997
5442 \begin_layout Subsection*
5445 \begin_layout Description
5446 Action Checks-out the document for edit (and locks it in some cases).
5448 \begin_layout Description
5451 \begin_layout Description
5452 Origin Lgb, 1 Jul 1997
5455 \begin_layout Subsection*
5458 \begin_layout Description
5459 Action Executes external command. This command is intended to support additional VCS commands.
5461 \begin_layout Description
5462 Syntax vc-command <FLAG> <PATH> <COMMAND>
5464 \begin_layout Description
5465 Params <FLAG>: Flags for the command can be combined together.
5466 \begin_inset Newline newline
5469 U - dUmmy - no flags
5470 \begin_inset Newline newline
5473 D - Doc - need document loaded to proceed
5474 \begin_inset Newline newline
5477 I - dIrty - mark document dirty
5478 \begin_inset Newline newline
5481 R - Reload - ensure that the document is saved and reload it after command execution
5482 \begin_inset Newline newline
5485 M - Message - ask for input string (commit message)
5486 \begin_inset Newline newline
5489 <PATH>: path where to start. $$p will be replaced by the current document path.
5490 \begin_inset Newline newline
5493 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
5495 \begin_layout Description
5496 Sample vc-command DR $$p "svn up"
5498 \begin_layout Description
5499 Origin sanda, 13 Jan 2009
5502 \begin_layout Subsection*
5505 \begin_layout Description
5506 Action Compares two revisions of the same file under version control.
5508 \begin_layout Description
5509 Syntax vc-compare [<REV1>] [<REV2>]
5511 \begin_layout Description
5512 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
5513 \begin_inset Newline newline
5516 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
5517 \begin_inset Newline newline
5521 \begin_inset Newline newline
5524 <REV2>: Newer file. Used only if REV1 > 0.
5525 \begin_inset Newline newline
5528 If no parameter is given, interactive dialog will be shown.
5530 \begin_layout Description
5531 Sample Compare current document against last commit
5532 \begin_inset Newline newline
5536 \begin_inset Newline newline
5539 Compare current document against current revision - 5 commits
5540 \begin_inset Newline newline
5544 \begin_inset Newline newline
5547 Compare revisions 120 and 155
5548 \begin_inset Newline newline
5553 \begin_layout Description
5554 Origin sanda, 12 Feb 2010
5557 \begin_layout Subsection*
5560 \begin_layout Description
5561 Action Copies the document to another name.
5563 \begin_layout Description
5564 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.
5566 \begin_layout Description
5567 Syntax vc-copy <FILENAME>
5569 \begin_layout Description
5570 Params <FILENAME>: New name of the document.
5571 \begin_inset Newline newline
5574 A file dialog is opened if no filename is given.
5576 \begin_layout Description
5577 Origin gb, 05 Feb 2013
5580 \begin_layout Subsection*
5583 \begin_layout Description
5584 Action Toggles the locking property of the edited file.
5586 \begin_layout Description
5587 Notion This is currently implemented only for SVN.
5589 \begin_layout Description
5590 Syntax vc-locking-toggle
5592 \begin_layout Description
5593 Origin sanda, 25 Jun 2009
5596 \begin_layout Subsection*
5599 \begin_layout Description
5600 Action Register the document as an file inside version control system.
5602 \begin_layout Description
5603 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
5604 \begin_inset Newline newline
5607 See LyX Additional Features Manual (Version Control Chapter) for additional information.
5609 \begin_layout Description
5612 \begin_layout Description
5613 Origin Lgb, 1 Jul 1997
5616 \begin_layout Subsection*
5619 \begin_layout Description
5620 Action Renames the document to another name.
5622 \begin_layout Description
5623 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.
5625 \begin_layout Description
5626 Syntax vc-rename <FILENAME>
5628 \begin_layout Description
5629 Params <FILENAME>: New name of the document.
5630 \begin_inset Newline newline
5633 A file dialog is opened if no filename is given.
5635 \begin_layout Description
5636 Origin gb, 05 Feb 2013
5639 \begin_layout Subsection*
5642 \begin_layout Description
5643 Action Update the local archive directory in which resides the current document with the remote repository.
5645 \begin_layout Description
5646 Syntax vc-repo-update
5648 \begin_layout Description
5649 Origin sanda, 16 Oct 2009
5652 \begin_layout Subsection*
5655 \begin_layout Description
5656 Action Reverts the document to the last check-in/commit in VCS.
5658 \begin_layout Description
5661 \begin_layout Description
5662 Origin Lgb, 1 Jul 1997
5665 \begin_layout Subsection*
5668 \begin_layout Description
5669 Action Undo last check-in.
5671 \begin_layout Description
5672 Notion This is currently implemented only for RCS.
5674 \begin_layout Description
5677 \begin_layout Description
5678 Origin Lgb, 1 Jul 1997
5681 \begin_layout Section
5682 Hidden Functions (not listed for configuration)
5684 \begin_layout Subsection*
5687 \begin_layout Description
5688 Action Return the current key sequence and available options as a string.
5690 \begin_layout Description
5691 Notion No options are added if no current map exists.
5692 \begin_inset Newline newline
5695 This is probably usable only with connection to lyxserver.
5697 \begin_layout Description
5698 Syntax command-prefix
5701 \begin_layout Subsection*
5704 \begin_layout Description
5705 Action Inserts the given string (accordingly to the correct keymap).
5707 \begin_layout Description
5708 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
5710 \begin_layout Description
5711 Syntax self-insert <STRING>