1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
6 \use_default_options false
14 \font_typewriter default
15 \font_default_family default
22 \paperfontsize default
30 \paperorientation portrait
37 \paragraph_separation indent
39 \quotes_language english
42 \paperpagestyle default
43 \tracking_changes false
51 \begin_layout Section*
52 LFUNs documentation automatically generated 2009-06-28
55 \begin_layout Standard
59 \begin_layout Plain Layout
69 \begin_inset VSpace 1cm
74 \begin_layout Subsection*
77 \begin_layout Description
78 Action Adds an acute accent to the next character typed.
80 \begin_layout Description
84 \begin_layout Subsection*
87 \begin_layout Description
88 Action Adds a breve accent to the next character typed.
90 \begin_layout Description
94 \begin_layout Subsection*
97 \begin_layout Description
98 Action Adds a caron to the next character typed.
100 \begin_layout Description
104 \begin_layout Subsection*
107 \begin_layout Description
108 Action Adds a cedilla to the next character typed.
110 \begin_layout Description
111 Syntax accent-cedilla
114 \begin_layout Subsection*
117 \begin_layout Description
118 Action Adds a circle accent to the next character typed.
120 \begin_layout Description
124 \begin_layout Subsection*
125 LFUN_ACCENT_CIRCUMFLEX
127 \begin_layout Description
128 Action Adds a circumflex to the next character typed.
130 \begin_layout Description
131 Syntax accent-circumflex
134 \begin_layout Subsection*
137 \begin_layout Description
138 Action Adds a dot accent to the next character typed.
140 \begin_layout Description
144 \begin_layout Subsection*
147 \begin_layout Description
148 Action Adds a grave accent to the next character typed.
150 \begin_layout Description
154 \begin_layout Subsection*
155 LFUN_ACCENT_HUNGARIAN_UMLAUT
157 \begin_layout Description
158 Action Adds a Hungarian umlaut to the next character typed.
160 \begin_layout Description
164 \begin_layout Subsection*
167 \begin_layout Description
168 Action Adds a macron to the next character typed.
170 \begin_layout Description
174 \begin_layout Subsection*
177 \begin_layout Description
178 Action Adds an ogonek accent to the next character typed.
180 \begin_layout Description
184 \begin_layout Subsection*
187 \begin_layout Description
188 Action Adds a tie over the next two character typed.
190 \begin_layout Description
191 Notion The following char will finish the tie.
193 \begin_layout Description
197 \begin_layout Subsection*
200 \begin_layout Description
201 Action Adds a tilde over the next character typed.
203 \begin_layout Description
207 \begin_layout Subsection*
210 \begin_layout Description
211 Action Adds an umlaut over the next character typed.
213 \begin_layout Description
217 \begin_layout Subsection*
220 \begin_layout Description
221 Action Adds a bar under the next character typed.
223 \begin_layout Description
224 Syntax accent-underbar
227 \begin_layout Subsection*
230 \begin_layout Description
231 Action Adds a dot under the next character typed.
233 \begin_layout Description
234 Syntax accent-underdot
237 \begin_layout Subsection*
240 \begin_layout Description
241 Action Inserts a caption inset.
243 \begin_layout Description
244 Syntax caption-insert
246 \begin_layout Description
247 Origin Lgb, 18 Jul 2000
250 \begin_layout Subsection*
253 \begin_layout Description
254 Action Inserts the current date.
256 \begin_layout Description
257 Syntax date-insert [<ARG>]
259 \begin_layout Description
260 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.
262 \begin_layout Description
263 Origin jdblair, 31 Jan 2000
266 \begin_layout Subsection*
269 \begin_layout Description
270 Action Inserts a footnote inset.
272 \begin_layout Description
273 Syntax footnote-insert
275 \begin_layout Description
276 Origin Jug, 7 Mar 2000
279 \begin_layout Subsection*
282 \begin_layout Description
283 Action Inserts an ERT inset.
285 \begin_layout Description
288 \begin_layout Description
289 Origin Jug, 18 Feb 2000
292 \begin_layout Subsection*
295 \begin_layout Description
296 Action Inserts a float inset.
298 \begin_layout Description
299 Syntax float-insert <TYPE>
301 \begin_layout Description
302 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
304 \begin_layout Description
305 Origin Lgb, 27 Jun 2000
308 \begin_layout Subsection*
309 LFUN_FLOAT_WIDE_INSERT
311 \begin_layout Description
312 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
314 \begin_layout Description
315 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
317 \begin_layout Description
318 Syntax float-wide-insert <TYPE>
320 \begin_layout Description
321 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
323 \begin_layout Description
324 Origin Lgb, 31 Oct 2001
327 \begin_layout Subsection*
328 LFUN_FLOAT_LIST_INSERT
330 \begin_layout Description
331 Action Inserts the list of floats in the document.
333 \begin_layout Description
334 Syntax float-list-insert <TYPE>
336 \begin_layout Description
337 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
339 \begin_layout Description
340 Origin Lgb, 3 May 2001
343 \begin_layout Subsection*
346 \begin_layout Description
347 Action Inserts floats wrapped by the text around.
349 \begin_layout Description
350 Syntax wrap-insert <TYPE>
352 \begin_layout Description
353 Params <TYPE>: table|figure
355 \begin_layout Description
356 Origin Dekel, 7 Apr 2002
359 \begin_layout Subsection*
362 \begin_layout Description
363 Action Inserts an optional-argument (short title) inset.
365 \begin_layout Description
366 Syntax optional-insert
368 \begin_layout Description
369 Origin vermeer, 12 Aug 2002
372 \begin_layout Subsection*
375 \begin_layout Description
376 Action Inserts a horizontal line.
378 \begin_layout Description
381 \begin_layout Description
382 Origin Andre, Oct 27 2003
385 \begin_layout Subsection*
388 \begin_layout Description
389 Action Inserts a new page.
391 \begin_layout Description
392 Syntax newpage-insert <ARG>
394 \begin_layout Description
395 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
397 \begin_layout Description
398 Origin uwestoehr, 24 Nov 2007
401 \begin_layout Subsection*
402 LFUN_MARGINALNOTE_INSERT
404 \begin_layout Description
405 Action Inserts a marginal note.
407 \begin_layout Description
408 Syntax marginalnote-insert
410 \begin_layout Description
411 Origin Lgb, 26 Jun 2000
414 \begin_layout Subsection*
417 \begin_layout Description
418 Action Inserts a single unicode character.
420 \begin_layout Description
421 Syntax unicode-insert <CHAR>
423 \begin_layout Description
424 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
426 \begin_layout Description
427 Sample unicode-insert 0x0100
429 \begin_layout Description
430 Origin Lgb, 22 Oct 2006
433 \begin_layout Subsection*
436 \begin_layout Description
437 Action Inserts a new listings inset.
439 \begin_layout Description
440 Syntax listing-insert
442 \begin_layout Description
443 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
446 \begin_layout Subsection*
449 \begin_layout Description
450 Action Insert a tab into a listings inset.
452 \begin_layout Description
453 Notion It also works on a selection.
455 \begin_layout Description
458 \begin_layout Description
459 Origin vfr, Sep 30 2008
462 \begin_layout Subsection*
465 \begin_layout Description
466 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
468 \begin_layout Description
469 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.
471 \begin_layout Description
474 \begin_layout Description
475 Origin vfr, Sep 30 2008
478 \begin_layout Subsection*
481 \begin_layout Description
482 Action Inserts quotes according to the type and quote-language preference.
484 \begin_layout Description
485 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
487 \begin_layout Description
488 Syntax quote-insert [<TYPE>]
490 \begin_layout Description
491 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
494 \begin_layout Subsection*
497 \begin_layout Description
498 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
500 \begin_layout Description
501 Notion Apart from lfun arguments you can use the following method:
502 \begin_inset Newline newline
505 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
506 \begin_inset Newline newline
509 2. select the text and run info-insert lfun.
511 \begin_layout Description
512 Syntax info-insert <TYPE> <ARG>
514 \begin_layout Description
515 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
516 \begin_inset Newline newline
519 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
521 \begin_layout Description
522 Sample command-sequence info-insert buffer path; info-insert buffer name
524 \begin_layout Description
525 Origin bpeng, 7 Oct 2007
528 \begin_layout Subsection*
531 \begin_layout Description
532 Action Inserts branch inset.
534 \begin_layout Description
535 Syntax branch-insert <BRANCH-NAME>
537 \begin_layout Description
538 Origin vermeer, 17 Aug 2003
541 \begin_layout Subsection*
544 \begin_layout Description
545 Action Inserts Box inset.
547 \begin_layout Description
548 Syntax box-insert [<TYPE>]
550 \begin_layout Description
551 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
552 \begin_inset Newline newline
555 Framed is the default one.
557 \begin_layout Description
558 Origin vermeer, 7 Oct 2003
561 \begin_layout Subsection*
564 \begin_layout Description
565 Action Inserts CharStyle, Custom inset or XML short element.
567 \begin_layout Description
568 Notion Look into the Customization manual for more information about these elements.
569 \begin_inset Newline newline
572 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.
573 \begin_inset Newline newline
576 For dissolving the element see LFUN_INSET_DISSOLVE.
578 \begin_layout Description
579 Syntax flex-insert <TYPE:Name>
581 \begin_layout Description
582 Params TYPE: CharStyle|Custom|Element|Standard
583 \begin_inset Newline newline
586 Identifies whether this is a Character Style, a Custom Inset or an XML Element, and which dynamical sub-menu this flex inset is in on the LyX menu tree. If Standard (currently unused): none of these.
587 \begin_inset Newline newline
590 Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
592 \begin_layout Description
593 Sample flex-insert CharStyle:Code
596 \begin_layout Subsection*
599 \begin_layout Description
600 Action Inserts the given string (accordingly to the correct keymap).
602 \begin_layout Description
603 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
605 \begin_layout Description
606 Syntax self-insert <STRING>
609 \begin_layout Subsection*
612 \begin_layout Description
613 Action Inserts one of horizontal space insets.
615 \begin_layout Description
616 Syntax space-insert <NAME> [<LEN>]
618 \begin_layout Description
619 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
620 \begin_inset Newline newline
623 <LEN>: length for custom spaces (hspace, hspace* for protected)
625 \begin_layout Description
626 Origin JSpitzm, 20 May 2003, Mar 17 2008
629 \begin_layout Subsection*
630 LFUN_HYPERLINK_INSERT
632 \begin_layout Description
633 Action Inserts hyperlinks into the document (clickable in pdf output).
635 \begin_layout Description
636 Notion Hyperlink target can be set via selection + hyperlink-insert function.
638 \begin_layout Description
639 Syntax href-insert [<TARGET>]
641 \begin_layout Description
642 Origin CFO-G, 21 Nov 1997
645 \begin_layout Subsection*
646 LFUN_SPECIALCHAR_INSERT
648 \begin_layout Description
649 Action Inserts various characters into the document.
651 \begin_layout Description
652 Syntax specialchar-insert <CHAR>
654 \begin_layout Description
655 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
657 \begin_layout Description
658 Origin JSpitzm, 6 Dec 2007
661 \begin_layout Subsection*
664 \begin_layout Description
665 Action Inserts table of contents.
667 \begin_layout Description
670 \begin_layout Description
671 Origin Lgb, 27 May 97
674 \begin_layout Subsection*
677 \begin_layout Description
678 Action Start (or remove) Appendix on the given cursor position.
680 \begin_layout Description
683 \begin_layout Description
684 Origin ettrich, 5 May 1998
687 \begin_layout Subsection*
690 \begin_layout Description
691 Action Inserts Index entry.
693 \begin_layout Description
694 Notion It automatically takes the word on the cursor position.
696 \begin_layout Description
697 Syntax index-insert [<TYPE:Name>]
699 \begin_layout Description
700 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
702 \begin_layout Description
703 Origin leeming, 3 Aug 2000
706 \begin_layout Subsection*
709 \begin_layout Description
710 Action Inserts list of Index entries on a new page.
712 \begin_layout Description
713 Syntax index-print [<TYPE:Name>]
715 \begin_layout Description
716 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
718 \begin_layout Description
719 Origin Lgb, 27 Feb 1997
722 \begin_layout Subsection*
725 \begin_layout Description
726 Action Inserts Nomenclature entry.
728 \begin_layout Description
729 Notion It automatically takes the word on the cursor position if no symbol is given.
731 \begin_layout Description
732 Syntax nomencl-insert [<SYMBOL>]
734 \begin_layout Description
735 Origin Ugras, 4 Nov 2006
738 \begin_layout Subsection*
739 LFUN_NOMENCLATURE_PRINT
741 \begin_layout Description
742 Action Inserts list of Nomenclature entries.
744 \begin_layout Description
745 Syntax nomenclature-print
747 \begin_layout Description
748 Origin Ugras, 4 Nov 2006
751 \begin_layout Subsection*
754 \begin_layout Description
755 Action Inserts Note on the current cursor postion, move selection inside the inset.
757 \begin_layout Description
758 Syntax note-insert [<TYPE>]
760 \begin_layout Description
761 Params <TYPE>: <Note|Greyedout|Comment> default: Note
764 \begin_layout Subsection*
767 \begin_layout Description
768 Action Moves the cursor to the begining of next Note inset.
770 \begin_layout Description
774 \begin_layout Subsection*
777 \begin_layout Description
778 Action Changes all Note insets of a particular type (source) to a different type (target) fot the current document.
780 \begin_layout Description
781 Syntax notes-mutate <SOURCE> <TARGET>
783 \begin_layout Description
784 Params <SOURCE/TARGET>: Note|Comment|Greyedout
786 \begin_layout Description
787 Origin sanda, 18 Jun 2008
790 \begin_layout Subsection*
793 \begin_layout Description
794 Action Inserts phantom on the current cursor postion, move selection inside the inset.
796 \begin_layout Description
797 Syntax phantom-insert [<TYPE>]
799 \begin_layout Description
800 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
802 \begin_layout Description
803 Origin uwestoehr, 30 Jan 2009
806 \begin_layout Subsection*
809 \begin_layout Description
810 Action Inserts a line break or new line.
812 \begin_layout Description
813 Syntax newline-insert [<ARG>]
815 \begin_layout Description
816 Params <ARG>: <newline|linebreak> default: newline
818 \begin_layout Description
819 Origin JSpitzm, 25 Mar 2008
822 \begin_layout Subsection*
825 \begin_layout Description
826 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD.
828 \begin_layout Description
831 \begin_layout Description
832 Origin Lgb, 17 May 2001
835 \begin_layout Subsection*
838 \begin_layout Description
839 Action Moves the cursor one line in downward direction.
841 \begin_layout Description
845 \begin_layout Subsection*
848 \begin_layout Description
849 Action Moves the cursor one line in upward direction.
851 \begin_layout Description
855 \begin_layout Subsection*
858 \begin_layout Description
859 Action Moves the cursor one line in downward direction adding the current position to the selection.
861 \begin_layout Description
865 \begin_layout Subsection*
868 \begin_layout Description
869 Action Moves the cursor one line in upward direction adding the current position to the selection.
871 \begin_layout Description
875 \begin_layout Subsection*
878 \begin_layout Description
879 Action Moves the cursor one page in downward direction.
881 \begin_layout Description
885 \begin_layout Subsection*
888 \begin_layout Description
889 Action Moves the cursor one page in upward direction.
891 \begin_layout Description
895 \begin_layout Subsection*
896 LFUN_SCREEN_DOWN_SELECT
898 \begin_layout Description
899 Action Moves the cursor one screen in downward direction adding the current position to the selection.
901 \begin_layout Description
902 Syntax screen-down-select
905 \begin_layout Subsection*
906 LFUN_SCREEN_UP_SELECT
908 \begin_layout Description
909 Action Moves the cursor one page in upward direction adding the current position to the selection.
911 \begin_layout Description
912 Syntax screen-up-select
915 \begin_layout Subsection*
918 \begin_layout Description
919 Action Scroll the buffer view.
921 \begin_layout Description
922 Notion Only scrolls the screen up or down; does not move the cursor.
924 \begin_layout Description
925 Syntax scroll <TYPE> <QUANTITY>
927 \begin_layout Description
928 Params <TYPE>: line|page
929 \begin_inset Newline newline
932 <QUANTITY>: up|down|<number>
934 \begin_layout Description
935 Origin Abdel, Dec 27 2007
938 \begin_layout Subsection*
941 \begin_layout Description
942 Action Recenters the screen on the current cursor position.
944 \begin_layout Description
945 Syntax screen-recenter
948 \begin_layout Subsection*
949 LFUN_SCREEN_SHOW_CURSOR
951 \begin_layout Description
952 Action Repositions the screen such that the cursor is visible.
954 \begin_layout Description
955 Syntax screen-show-cursor
957 \begin_layout Description
958 Origin vfr, 25 Mar 2009
961 \begin_layout Subsection*
964 \begin_layout Description
965 Action Moves the cursor one position logically backwards.
967 \begin_layout Description
968 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.
970 \begin_layout Description
974 \begin_layout Subsection*
975 LFUN_CHAR_BACKWARD_SELECT
977 \begin_layout Description
978 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
980 \begin_layout Description
981 Notion See also LFUN_CHAR_BACKWARD.
983 \begin_layout Description
984 Syntax char-backward-select
987 \begin_layout Subsection*
988 LFUN_CHAR_DELETE_BACKWARD
990 \begin_layout Description
991 Action Deletes one character in the backward direction (usually the "BackSpace" key).
993 \begin_layout Description
994 Syntax char-delete-backward
997 \begin_layout Subsection*
998 LFUN_CHAR_DELETE_FORWARD
1000 \begin_layout Description
1001 Action Deletes one character in the backward direction (usually the "Delete" key).
1003 \begin_layout Description
1004 Syntax char-delete-forward
1007 \begin_layout Subsection*
1010 \begin_layout Description
1011 Action Moves the cursor one position logically forward.
1013 \begin_layout Description
1014 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.
1016 \begin_layout Description
1020 \begin_layout Subsection*
1021 LFUN_CHAR_FORWARD_SELECT
1023 \begin_layout Description
1024 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1026 \begin_layout Description
1027 Notion See also LFUN_CHAR_FORWARD.
1029 \begin_layout Description
1030 Syntax char-forward-select
1033 \begin_layout Subsection*
1036 \begin_layout Description
1037 Action Moves the cursor one position "to the left".
1039 \begin_layout Description
1040 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.
1042 \begin_layout Description
1046 \begin_layout Subsection*
1047 LFUN_CHAR_LEFT_SELECT
1049 \begin_layout Description
1050 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1052 \begin_layout Description
1053 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1055 \begin_layout Description
1056 Syntax char-left-select
1059 \begin_layout Subsection*
1062 \begin_layout Description
1063 Action Moves the cursor one position "to the right".
1065 \begin_layout Description
1066 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.
1068 \begin_layout Description
1072 \begin_layout Subsection*
1073 LFUN_CHAR_RIGHT_SELECT
1075 \begin_layout Description
1076 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1078 \begin_layout Description
1079 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1081 \begin_layout Description
1082 Syntax char-right-select
1085 \begin_layout Subsection*
1088 \begin_layout Description
1089 Action Moves the cursor to the logically previous beginning of a word.
1091 \begin_layout Description
1092 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.
1094 \begin_layout Description
1095 Syntax word-backward
1098 \begin_layout Subsection*
1099 LFUN_WORD_BACKWARD_SELECT
1101 \begin_layout Description
1102 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1104 \begin_layout Description
1105 Notion See also LFUN_WORD_BACKWARD.
1107 \begin_layout Description
1108 Syntax word-backward-select
1111 \begin_layout Subsection*
1112 LFUN_WORD_DELETE_BACKWARD
1114 \begin_layout Description
1115 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1117 \begin_layout Description
1118 Syntax word-delete-backward
1121 \begin_layout Subsection*
1122 LFUN_WORD_DELETE_FORWARD
1124 \begin_layout Description
1125 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1127 \begin_layout Description
1128 Syntax word-delete-forward
1131 \begin_layout Subsection*
1132 LFUN_WORD_FIND_FORWARD
1134 \begin_layout Description
1135 Action Search for a given string in forward direction.
1137 \begin_layout Description
1138 Notion Case sensitive, match words. If no argument given, last search repeated.
1140 \begin_layout Description
1141 Syntax word-find-forward [<STRING>]
1143 \begin_layout Description
1144 Origin Etienne, 16 Feb 1998
1147 \begin_layout Subsection*
1148 LFUN_WORD_FIND_BACKWARD
1150 \begin_layout Description
1151 Action Search for a given string in backward direction.
1153 \begin_layout Description
1154 Notion Case sensitive, match words. If no argument given, last search repeated.
1156 \begin_layout Description
1157 Syntax word-find-backward [<STRING>]
1159 \begin_layout Description
1160 Origin Etienne, 20 Feb 1998
1163 \begin_layout Subsection*
1166 \begin_layout Description
1167 Action Search for next occurence of a string.
1169 \begin_layout Description
1170 Syntax word-find [<DATA>]
1172 \begin_layout Description
1173 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).
1175 \begin_layout Description
1176 Origin Andre, Jan 7 2004
1179 \begin_layout Subsection*
1182 \begin_layout Description
1183 Action Replace a string in the document.
1185 \begin_layout Description
1186 Syntax word-replace [<DATA>]
1188 \begin_layout Description
1189 Params <DATA>: data is of the form "<search>
1190 \begin_inset Newline newline
1194 \begin_inset Newline newline
1197 <casesensitive> <matchword> <all> <forward>"
1199 \begin_layout Description
1200 Origin Andre, Jan 7 2004
1203 \begin_layout Subsection*
1206 \begin_layout Description
1207 Action Search for next occurence of a pattern.
1209 \begin_layout Description
1210 Syntax word-findadv [<DATA>]
1212 \begin_layout Description
1213 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).
1215 \begin_layout Description
1216 Origin Tommaso, Nov 15 2007
1219 \begin_layout Subsection*
1222 \begin_layout Description
1223 Action Moves the cursor to the logically next beginning of a word.
1225 \begin_layout Description
1226 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.
1228 \begin_layout Description
1232 \begin_layout Subsection*
1233 LFUN_WORD_FORWARD_SELECT
1235 \begin_layout Description
1236 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1238 \begin_layout Description
1239 Notion See also LFUN_WORD_FORWARD.
1241 \begin_layout Description
1242 Syntax word-forward-select
1245 \begin_layout Subsection*
1248 \begin_layout Description
1249 Action Moves the cursor to the next beginning of a word "on the left".
1251 \begin_layout Description
1252 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.
1254 \begin_layout Description
1257 \begin_layout Description
1258 Origin dov, 28 Oct 2007
1261 \begin_layout Subsection*
1262 LFUN_WORD_LEFT_SELECT
1264 \begin_layout Description
1265 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1267 \begin_layout Description
1268 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1270 \begin_layout Description
1271 Syntax word-left-select
1273 \begin_layout Description
1274 Origin dov, 28 Oct 2007
1277 \begin_layout Subsection*
1280 \begin_layout Description
1281 Action Moves the cursor to the next beginning of a word "on the right".
1283 \begin_layout Description
1284 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.
1286 \begin_layout Description
1289 \begin_layout Description
1290 Origin dov, 28 Oct 2007
1293 \begin_layout Subsection*
1294 LFUN_WORD_RIGHT_SELECT
1296 \begin_layout Description
1297 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1299 \begin_layout Description
1300 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1302 \begin_layout Description
1303 Syntax word-right-select
1305 \begin_layout Description
1306 Origin dov, 28 Oct 2007
1309 \begin_layout Subsection*
1312 \begin_layout Description
1313 Action Puts the word where the cursor stands into the selection.
1315 \begin_layout Description
1318 \begin_layout Description
1319 Origin Andre, 11 Sep 2002
1322 \begin_layout Subsection*
1323 LFUN_WORD_CAPITALIZE
1325 \begin_layout Description
1326 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1328 \begin_layout Description
1329 Syntax word-capitalize
1332 \begin_layout Subsection*
1335 \begin_layout Description
1336 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1338 \begin_layout Description
1342 \begin_layout Subsection*
1345 \begin_layout Description
1346 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1348 \begin_layout Description
1352 \begin_layout Subsection*
1353 LFUN_THESAURUS_ENTRY
1355 \begin_layout Description
1356 Action Look up thesaurus entries with respect to the word under the cursor.
1358 \begin_layout Description
1359 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1361 \begin_layout Description
1362 Params <STRING>: word to look up <LANG>: language (see file languages)
1364 \begin_layout Description
1365 Origin Levon, 20 Jul 2001
1368 \begin_layout Subsection*
1371 \begin_layout Description
1372 Action Move the cursor to the beginning of the document.
1374 \begin_layout Description
1378 \begin_layout Subsection*
1379 LFUN_BUFFER_BEGIN_SELECT
1381 \begin_layout Description
1382 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1384 \begin_layout Description
1385 Syntax buffer-begin-select
1388 \begin_layout Subsection*
1391 \begin_layout Description
1392 Action Move the cursor to the end of the document.
1394 \begin_layout Description
1398 \begin_layout Subsection*
1399 LFUN_BUFFER_END_SELECT
1401 \begin_layout Description
1402 Action Move the cursor to the end of the document adding the traversed text to the selection.
1404 \begin_layout Description
1405 Syntax buffer-end-select
1408 \begin_layout Subsection*
1411 \begin_layout Description
1412 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
1414 \begin_layout Description
1417 \begin_layout Description
1418 Origin lasgouttes, 16 Mar 2009
1421 \begin_layout Subsection*
1422 LFUN_INSET_BEGIN_SELECT
1424 \begin_layout Description
1425 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).
1427 \begin_layout Description
1428 Syntax inset-begin-select
1430 \begin_layout Description
1431 Origin lasgouttes, 16 Mar 2009
1434 \begin_layout Subsection*
1437 \begin_layout Description
1438 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
1440 \begin_layout Description
1443 \begin_layout Description
1444 Origin lasgouttes, 16 Mar 2009
1447 \begin_layout Subsection*
1448 LFUN_INSET_END_SELECT
1450 \begin_layout Description
1451 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).
1453 \begin_layout Description
1454 Syntax inset-end-select
1456 \begin_layout Description
1457 Origin lasgouttes, 16 Mar 2009
1460 \begin_layout Subsection*
1463 \begin_layout Description
1464 Action Move the cursor to the begining of the (screen) line.
1466 \begin_layout Description
1470 \begin_layout Subsection*
1471 LFUN_LINE_BEGIN_SELECT
1473 \begin_layout Description
1474 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1476 \begin_layout Description
1477 Syntax line-begin-select
1480 \begin_layout Subsection*
1483 \begin_layout Description
1484 Action Move the cursor to the end of the (screen) line.
1486 \begin_layout Description
1490 \begin_layout Subsection*
1491 LFUN_LINE_END_SELECT
1493 \begin_layout Description
1494 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1496 \begin_layout Description
1497 Syntax line-end-select
1500 \begin_layout Subsection*
1503 \begin_layout Description
1504 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1506 \begin_layout Description
1507 Syntax line-delete-forward
1510 \begin_layout Subsection*
1513 \begin_layout Description
1514 Action Copies to the clipboard the last edit.
1516 \begin_layout Description
1520 \begin_layout Subsection*
1523 \begin_layout Description
1524 Action Cuts to the clipboard.
1526 \begin_layout Description
1530 \begin_layout Subsection*
1533 \begin_layout Description
1534 Action Pastes material (text or picture) from the active clipboard.
1536 \begin_layout Description
1537 Syntax paste [<TYPE>|<NUM>]
1539 \begin_layout Description
1540 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1541 \begin_inset Newline newline
1544 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1547 \begin_layout Subsection*
1548 LFUN_CLIPBOARD_PASTE
1550 \begin_layout Description
1551 Action Pastes text from the active clipboard.
1553 \begin_layout Description
1554 Syntax clipboard-paste [<ARG>]
1556 \begin_layout Description
1557 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1559 \begin_layout Description
1560 Origin baum, 10 Jul 2006
1563 \begin_layout Subsection*
1564 LFUN_PRIMARY_SELECTION_PASTE
1566 \begin_layout Description
1567 Action Pastes the currently text selected text.
1569 \begin_layout Description
1570 Notion Primary selection mechanism is linux-only thing.
1572 \begin_layout Description
1573 Syntax primary-selection-paste [<ARG>]
1575 \begin_layout Description
1576 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1579 \begin_layout Subsection*
1580 LFUN_SELECTION_PASTE
1582 \begin_layout Description
1583 Action Pastes the text in permanent selection.
1585 \begin_layout Description
1586 Syntax selection-paste
1589 \begin_layout Subsection*
1592 \begin_layout Description
1593 Action Undoes the last edit.
1595 \begin_layout Description
1599 \begin_layout Subsection*
1602 \begin_layout Description
1603 Action Redoes the last thing undone.
1605 \begin_layout Description
1609 \begin_layout Subsection*
1612 \begin_layout Description
1613 Action Repeat the given command.
1615 \begin_layout Description
1616 Syntax repeat <COUNT> <LFUN-COMMAND>
1618 \begin_layout Description
1619 Origin Andre, 27 Oct 2003
1622 \begin_layout Subsection*
1623 LFUN_CHARS_TRANSPOSE
1625 \begin_layout Description
1626 Action Transposes the character at the cursor with the one before it.
1628 \begin_layout Description
1629 Syntax chars-transpose
1631 \begin_layout Description
1632 Origin Lgb, 25 Apr 2001
1635 \begin_layout Subsection*
1636 LFUN_DEPTH_DECREMENT
1638 \begin_layout Description
1639 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1641 \begin_layout Description
1642 Syntax depth-decrement
1645 \begin_layout Subsection*
1646 LFUN_DEPTH_INCREMENT
1648 \begin_layout Description
1649 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1651 \begin_layout Description
1652 Syntax depth-increment
1655 \begin_layout Subsection*
1658 \begin_layout Description
1659 Action Toggles the bold font (selection-wise) using mathbf in math.
1661 \begin_layout Description
1665 \begin_layout Subsection*
1666 LFUN_FONT_BOLDSYMBOL
1668 \begin_layout Description
1669 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1671 \begin_layout Description
1672 Syntax font-boldsymbol
1675 \begin_layout Subsection*
1676 LFUN_FONT_TYPEWRITER
1678 \begin_layout Description
1679 Action Toggles the typewriter family font (selection-wise).
1681 \begin_layout Description
1682 Syntax font-typewriter
1685 \begin_layout Subsection*
1688 \begin_layout Description
1689 Action Toggles underline in the font (selection-wise).
1691 \begin_layout Description
1692 Syntax font-underline
1695 \begin_layout Subsection*
1698 \begin_layout Description
1699 Action Toggles double underline in the font (selection-wise).
1701 \begin_layout Description
1702 Syntax font-underunderline
1704 \begin_layout Description
1705 Origin sanda, 5 May 2009
1708 \begin_layout Subsection*
1711 \begin_layout Description
1712 Action Toggles wavy underline in the font (selection-wise).
1714 \begin_layout Description
1715 Syntax font-underwave
1717 \begin_layout Description
1718 Origin sanda, 5 May 2009
1721 \begin_layout Subsection*
1724 \begin_layout Description
1725 Action Toggles strikeout (strike-through) in the font (selection-wise).
1727 \begin_layout Description
1728 Syntax font-strikeout
1730 \begin_layout Description
1731 Origin sanda, 3 May 2009
1734 \begin_layout Subsection*
1737 \begin_layout Description
1738 Action Toggles the emphasis font style (selection-wise).
1740 \begin_layout Description
1744 \begin_layout Subsection*
1747 \begin_layout Description
1748 Action Toggles Noun text style font (selection-wise).
1750 \begin_layout Description
1754 \begin_layout Subsection*
1757 \begin_layout Description
1758 Action Toggles Roman family font (selection-wise).
1760 \begin_layout Description
1764 \begin_layout Subsection*
1767 \begin_layout Description
1768 Action Toggles Sans Serif family font (selection-wise).
1770 \begin_layout Description
1774 \begin_layout Subsection*
1777 \begin_layout Description
1778 Action Toggles Fraktur family font (math-mode, selection-wise).
1780 \begin_layout Description
1783 \begin_layout Description
1784 Origin vermeer, 10 Jan 2002
1787 \begin_layout Subsection*
1790 \begin_layout Description
1791 Action Toggles Italics font shape (math-mode, selection-wise).
1793 \begin_layout Description
1796 \begin_layout Description
1797 Origin vermeer, 10 Jan 2002
1800 \begin_layout Subsection*
1803 \begin_layout Description
1804 Action Reverts the settings of the font to the default values (selection-wise).
1806 \begin_layout Description
1810 \begin_layout Subsection*
1813 \begin_layout Description
1814 Action Sets font size according to lyx format string.
1816 \begin_layout Description
1817 Syntax font-size <SIZE>
1819 \begin_layout Description
1820 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1821 \begin_inset Newline newline
1824 largest|huge|giant|increase|decrease|default
1827 \begin_layout Subsection*
1828 LFUN_TEXTSTYLE_APPLY
1830 \begin_layout Description
1831 Action Toggle user-defined (=last-time used) text style.
1833 \begin_layout Description
1834 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1836 \begin_layout Description
1837 Syntax textstyle-apply
1839 \begin_layout Description
1840 Origin leeming, 12 Mar 2003
1843 \begin_layout Subsection*
1844 LFUN_TEXTSTYLE_UPDATE
1846 \begin_layout Description
1847 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1849 \begin_layout Description
1850 Syntax textstyle-update <FONT_INFO>
1852 \begin_layout Description
1853 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1854 \begin_inset Newline newline
1857 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1859 \begin_layout Description
1860 Origin leeming, 12 Mar 2003
1863 \begin_layout Subsection*
1864 LFUN_SCREEN_FONT_UPDATE
1866 \begin_layout Description
1867 Action Update fonts and its metrics.
1869 \begin_layout Description
1870 Notion Automatically called after zoom, dpi, font names, or norm change.
1872 \begin_layout Description
1873 Syntax screen-font-update
1875 \begin_layout Description
1876 Origin ARRae, 13 Aug 2000
1879 \begin_layout Subsection*
1882 \begin_layout Description
1883 Action Returns the info about the current font.
1885 \begin_layout Description
1889 \begin_layout Subsection*
1890 LFUN_CITATION_INSERT
1892 \begin_layout Description
1893 Action Inserts citation from loaded citation database.
1895 \begin_layout Description
1896 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1898 \begin_layout Description
1899 Params <KEY>: Citation (shortcut listed in available citations).
1900 \begin_inset Newline newline
1903 <TEXT_BEFORE>: text which should appear before citation.
1905 \begin_layout Description
1906 Origin AAS, 97-02-23
1909 \begin_layout Subsection*
1910 LFUN_BIBTEX_DATABASE_ADD
1912 \begin_layout Description
1913 Action Adds database, which will be used for bibtex citations.
1915 \begin_layout Description
1916 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1918 \begin_layout Description
1919 Syntax bibtex-database-add <DATABASE-NAME>
1921 \begin_layout Description
1922 Origin Ale, 30 May 1997
1925 \begin_layout Subsection*
1926 LFUN_BIBTEX_DATABASE_DEL
1928 \begin_layout Description
1929 Action Adds database, which will be used for bibtex citations.
1931 \begin_layout Description
1932 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1934 \begin_layout Description
1935 Syntax bibtex-database-del <DATABASE-NAME>
1937 \begin_layout Description
1938 Origin Ale, 30 May 1997
1941 \begin_layout Subsection*
1944 \begin_layout Description
1945 Action Sets the layout (that is, environment) for the current paragraph.
1947 \begin_layout Description
1948 Syntax layout <LAYOUT>
1950 \begin_layout Description
1951 Params <LAYOUT>: the layout to use
1954 \begin_layout Subsection*
1955 LFUN_LAYOUT_PARAGRAPH
1957 \begin_layout Description
1958 Action Launches the paragraph settings dialog.
1960 \begin_layout Description
1961 Syntax layout-paragraph
1964 \begin_layout Subsection*
1967 \begin_layout Description
1968 Action Launches the tabular settings dialog.
1970 \begin_layout Description
1971 Syntax layout-tabular
1973 \begin_layout Description
1974 Origin Jug, 31 Jul 2000
1977 \begin_layout Subsection*
1978 LFUN_DROP_LAYOUTS_CHOICE
1980 \begin_layout Description
1981 Action Displays list of layout choices.
1983 \begin_layout Description
1984 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
1986 \begin_layout Description
1987 Syntax drop-layouts-choice
1990 \begin_layout Subsection*
1991 LFUN_LAYOUT_MODULES_CLEAR
1993 \begin_layout Description
1994 Action Clears the module list.
1996 \begin_layout Description
1997 Notion Clears the list of included modules for the current buffer.
1999 \begin_layout Description
2000 Syntax layout-modules-clear
2002 \begin_layout Description
2003 Origin rgh, 25 August 2007
2006 \begin_layout Subsection*
2007 LFUN_LAYOUT_MODULE_ADD
2009 \begin_layout Description
2010 Action Adds a module.
2012 \begin_layout Description
2013 Notion Adds a module to the list of included modules for the current buffer.
2015 \begin_layout Description
2016 Syntax layout-module-add <MODULE>
2018 \begin_layout Description
2019 Params <MODULE>: the module to be added
2021 \begin_layout Description
2022 Origin rgh, 25 August 2007
2025 \begin_layout Subsection*
2028 \begin_layout Description
2029 Action Reloads layout information.
2031 \begin_layout Description
2032 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.
2034 \begin_layout Description
2035 Syntax layout-reload
2037 \begin_layout Description
2038 Origin rgh, 3 September 2007
2041 \begin_layout Subsection*
2042 LFUN_TEXTCLASS_APPLY
2044 \begin_layout Description
2045 Action Sets the text class for the current buffer.
2047 \begin_layout Description
2048 Syntax textclass-apply <TEXTCLASS>
2050 \begin_layout Description
2051 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2054 \begin_layout Subsection*
2057 \begin_layout Description
2058 Action Loads information for a textclass from disk.
2060 \begin_layout Description
2061 Syntax textclass-load <TEXTCLASS>
2063 \begin_layout Description
2064 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2067 \begin_layout Subsection*
2070 \begin_layout Description
2071 Action Disable selecting of text-region.
2073 \begin_layout Description
2077 \begin_layout Subsection*
2080 \begin_layout Description
2081 Action Enable selecting of text-region.
2083 \begin_layout Description
2084 Notion After enabling you can simply move arrow keys to get selected region.
2086 \begin_layout Description
2090 \begin_layout Subsection*
2093 \begin_layout Description
2094 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2096 \begin_layout Description
2099 \begin_layout Description
2100 Origin Andre, May 5 2006
2103 \begin_layout Subsection*
2106 \begin_layout Description
2107 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2109 \begin_layout Description
2110 Syntax math-delim [<LEFT>] [<RIGHT>]
2112 \begin_layout Description
2113 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.
2115 \begin_layout Description
2116 Sample math-delim { rangle
2118 \begin_layout Description
2119 Origin Alejandro, 18 Jun 1996
2122 \begin_layout Subsection*
2125 \begin_layout Description
2126 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2128 \begin_layout Description
2129 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2131 \begin_layout Description
2132 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2133 \begin_inset Newline newline
2136 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2138 \begin_layout Description
2139 Sample math-bigdelim "Bigl" "
2145 \begin_layout Description
2146 Origin Enrico & Georg, 7 May 2006
2149 \begin_layout Subsection*
2152 \begin_layout Description
2153 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2155 \begin_layout Description
2156 Syntax math-display [<ARG>]
2158 \begin_layout Description
2159 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2161 \begin_layout Description
2162 Origin Alejandro, 18 Jun 1996
2165 \begin_layout Subsection*
2168 \begin_layout Description
2169 Action Inserts math objects and symbols.
2171 \begin_layout Description
2172 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
2174 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
2176 frac{x}{y}" replaces "abc" with "
2178 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.
2180 \begin_layout Description
2181 Syntax math-insert <ARG>
2183 \begin_layout Description
2184 Params <ARG>: Symbol or LaTeX code to be inserted.
2187 \begin_layout Subsection*
2190 \begin_layout Description
2191 Action Enters subscript expression in math expression.
2193 \begin_layout Description
2194 Syntax math-subscript
2196 \begin_layout Description
2197 Origin vermeer, 12 Dec 2001
2200 \begin_layout Subsection*
2201 LFUN_MATH_SUPERSCRIPT
2203 \begin_layout Description
2204 Action Enters subscript expression in math expression.
2206 \begin_layout Description
2207 Syntax math-superscript
2209 \begin_layout Description
2210 Origin vermeer, 12 Dec 2001
2213 \begin_layout Subsection*
2216 \begin_layout Description
2217 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.
2219 \begin_layout Description
2220 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2222 \begin_layout Description
2223 Syntax math-limits [<STATE>]
2225 \begin_layout Description
2226 Params <STATE>: limits|nolimits
2229 \begin_layout Subsection*
2232 \begin_layout Description
2233 Action Inserts a math macro definition at the cursor position in the text.
2235 \begin_layout Description
2236 Syntax math-macro <NAME> [<NARGS>] [def]
2238 \begin_layout Description
2239 Params <NAME>: The name of the macro, e.g. "mymacro".
2240 \begin_inset Newline newline
2243 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2245 \begin_layout Description
2246 Origin ale, 10 May 1997; sts, 21 Dec 2007
2249 \begin_layout Subsection*
2252 \begin_layout Description
2253 Action Mutates the type of math inset to the newly selected one.
2255 \begin_layout Description
2256 Syntax math-mutate <TYPE>
2258 \begin_layout Description
2259 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2261 \begin_layout Description
2262 Origin Andre, 23 May 2001
2265 \begin_layout Subsection*
2268 \begin_layout Description
2269 Action Inserts space into math expression.
2271 \begin_layout Description
2272 Notion Use spacebar after entering this space to change type of space.
2274 \begin_layout Description
2275 Syntax math-space [<TYPE>] [<LEN>]
2277 \begin_layout Description
2278 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2279 \begin_inset Newline newline
2282 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2283 \begin_inset Newline newline
2286 custom space: hspace
2287 \begin_inset Newline newline
2290 "," used by default.
2291 \begin_inset Newline newline
2294 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2295 \begin_inset Newline newline
2298 <LEN>: length for custom spaces (hspace)
2300 \begin_layout Description
2301 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2304 \begin_layout Subsection*
2307 \begin_layout Description
2308 Action Inserts a matrix.
2310 \begin_layout Description
2311 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2313 \begin_layout Description
2314 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).
2316 \begin_layout Description
2317 Sample math-matrix 3 3 bccc
2320 \begin_layout Subsection*
2323 \begin_layout Description
2324 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.
2326 \begin_layout Description
2327 Notion If there is some selected text, it puts the text inside created math box.
2329 \begin_layout Description
2330 Syntax math-mode [on|<ARG>]
2332 \begin_layout Description
2333 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2334 \begin_inset Newline newline
2337 "on": allow only entering of math mode from text mode.
2339 \begin_layout Description
2340 Origin Alejandro, 4 Jun 1996
2343 \begin_layout Subsection*
2346 \begin_layout Description
2347 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2349 \begin_layout Description
2350 Notion If there is any selected text, then it is moved inside the created regexp inset.
2352 \begin_layout Description
2353 Syntax regexp-mode [<ARG>]
2355 \begin_layout Description
2356 Params <ARG>: eventual argument (regular expression).
2358 \begin_layout Description
2359 Origin Tommaso, 4 Oct 2008
2362 \begin_layout Subsection*
2363 LFUN_MATH_NUMBER_LINE_TOGGLE
2365 \begin_layout Description
2366 Action Toggles numbering of the current formula line.
2368 \begin_layout Description
2369 Notion Must be in display formula mode.
2371 \begin_layout Description
2372 Syntax math-number-line-toggle
2374 \begin_layout Description
2375 Origin Alejandro, 18 Jun 1996
2378 \begin_layout Subsection*
2379 LFUN_MATH_NUMBER_TOGGLE
2381 \begin_layout Description
2382 Action Toggles numbering/labeling of the current formula.
2384 \begin_layout Description
2385 Notion Must be in display formula mode.
2387 \begin_layout Description
2388 Syntax math-number-toggle
2390 \begin_layout Description
2391 Origin Alejandro, 4 Jun 1996
2394 \begin_layout Subsection*
2397 \begin_layout Description
2398 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2400 \begin_layout Description
2401 Notion Selection can be used to determine the input for the external program.
2403 \begin_layout Description
2404 Syntax math-extern <LANG> [<COMMAND>]
2406 \begin_layout Description
2407 Params <LANG>: octave|maxima|maple|mathematica|script
2408 \begin_inset Newline newline
2411 where "script" stands fot the external script (normalized expression will be passed)
2413 \begin_layout Description
2414 Sample math-extern maple simplify
2416 \begin_layout Description
2417 Origin Andre, 24 Apr 2001
2420 \begin_layout Subsection*
2423 \begin_layout Description
2424 Action Changes arbitrarily the size used by math fonts inside a context.
2426 \begin_layout Description
2427 Notion Provides an interface to the LaTeX math mode font size commands.
2429 \begin_layout Description
2430 Syntax math-size <STYLE>
2432 \begin_layout Description
2443 \begin_layout Description
2444 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2447 \begin_layout Subsection*
2448 LFUN_MATH_FONT_STYLE
2450 \begin_layout Description
2451 Action Changes the text style used in math.
2453 \begin_layout Description
2454 Syntax math-font-style <STYLE>
2456 \begin_layout Description
2457 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2459 \begin_layout Description
2460 Origin vfr, 9 jan 2009
2463 \begin_layout Subsection*
2464 LFUN_MATH_MACRO_UNFOLD
2466 \begin_layout Description
2467 Action Unfold a Math Macro.
2469 \begin_layout Description
2470 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2474 \begin_layout Description
2475 Syntax math-macro-unfold
2477 \begin_layout Description
2478 Origin sts, 06 January 2008
2481 \begin_layout Subsection*
2482 LFUN_MATH_MACRO_FOLD
2484 \begin_layout Description
2485 Action Fold a Math Macro.
2487 \begin_layout Description
2488 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2492 \begin_layout Description
2493 Syntax math-macro-fold
2495 \begin_layout Description
2496 Origin sts, 06 January 2008
2499 \begin_layout Subsection*
2500 LFUN_MATH_MACRO_ADD_PARAM
2502 \begin_layout Description
2503 Action Add a parameter.
2505 \begin_layout Description
2506 Notion Add a parameter to a Math Macro.
2508 \begin_layout Description
2509 Syntax math-macro-add-param <NUM>
2511 \begin_layout Description
2512 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.
2514 \begin_layout Description
2515 Origin sts, 06 January 2008
2518 \begin_layout Subsection*
2519 LFUN_MATH_MACRO_REMOVE_PARAM
2521 \begin_layout Description
2522 Action Remove the last parameter.
2524 \begin_layout Description
2525 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2527 \begin_layout Description
2528 Syntax math-macro-remove-param <NUM>
2530 \begin_layout Description
2531 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2533 \begin_layout Description
2534 Origin sts, 06 January 2008
2537 \begin_layout Subsection*
2538 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2540 \begin_layout Description
2541 Action Append a greedy parameter.
2543 \begin_layout Description
2544 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2546 \begin_layout Description
2547 Syntax math-macro-append-greedy-param
2549 \begin_layout Description
2550 Origin sts, 06 January 2008
2553 \begin_layout Subsection*
2554 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2556 \begin_layout Description
2557 Action Remove a greedy parameter.
2559 \begin_layout Description
2560 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.
2562 \begin_layout Description
2563 Syntax math-macro-remove-greedy-param
2565 \begin_layout Description
2566 Origin sts, 06 January 2008
2569 \begin_layout Subsection*
2570 LFUN_MATH_MACRO_MAKE_OPTIONAL
2572 \begin_layout Description
2573 Action Make a parameter optional.
2575 \begin_layout Description
2576 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2578 \begin_layout Description
2579 Syntax math-macro-make-optional
2581 \begin_layout Description
2582 Origin sts, 06 January 2008
2585 \begin_layout Subsection*
2586 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2588 \begin_layout Description
2589 Action Make a parameter non-optional.
2591 \begin_layout Description
2592 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.
2594 \begin_layout Description
2595 Syntax math-macro-make-nonoptional
2597 \begin_layout Description
2598 Origin sts, 06 January 2008
2601 \begin_layout Subsection*
2602 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2604 \begin_layout Description
2605 Action Add an optional parameter.
2607 \begin_layout Description
2608 Notion Insert an optional parameter just behind the already existing optional parameters.
2610 \begin_layout Description
2611 Syntax math-macro-add-optional-param
2613 \begin_layout Description
2614 Origin sts, 06 January 2008
2617 \begin_layout Subsection*
2618 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2620 \begin_layout Description
2621 Action Remove the last optional parameter.
2623 \begin_layout Description
2624 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2626 \begin_layout Description
2627 Syntax math-macro-remove-optional-param
2629 \begin_layout Description
2630 Origin sts, 06 January 2008
2633 \begin_layout Subsection*
2634 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2636 \begin_layout Description
2637 Action Add a greedy optional parameter.
2639 \begin_layout Description
2640 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2642 \begin_layout Description
2643 Syntax math-macro-add-greedy-optional-param
2645 \begin_layout Description
2646 Origin sts, 06 January 2008
2649 \begin_layout Subsection*
2650 LFUN_IN_MATHMACROTEMPLATE
2652 \begin_layout Description
2653 Action Only active in Math Macro definition.
2655 \begin_layout Description
2656 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.
2658 \begin_layout Description
2659 Syntax in-mathmacrotemplate
2661 \begin_layout Description
2662 Origin sts, 06 January 2008
2665 \begin_layout Subsection*
2666 LFUN_PARAGRAPH_MOVE_DOWN
2668 \begin_layout Description
2669 Action Moves the current paragraph downwards in the document.
2671 \begin_layout Description
2672 Syntax paragraph-move-down
2674 \begin_layout Description
2675 Origin Edwin, 8 Apr 2006
2678 \begin_layout Subsection*
2679 LFUN_PARAGRAPH_MOVE_UP
2681 \begin_layout Description
2682 Action Moves the current paragraph upwards in the document.
2684 \begin_layout Description
2685 Syntax paragraph-move-up
2687 \begin_layout Description
2688 Origin Edwin, 8 Apr 2006
2691 \begin_layout Subsection*
2694 \begin_layout Description
2695 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2697 \begin_layout Description
2700 \begin_layout Description
2701 Origin Asger, 1 Oct 1996
2704 \begin_layout Subsection*
2705 LFUN_PARAGRAPH_UP_SELECT
2707 \begin_layout Description
2708 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2710 \begin_layout Description
2711 Syntax paragraph-up-select
2713 \begin_layout Description
2714 Origin Asger, 1 Oct 1996
2717 \begin_layout Subsection*
2720 \begin_layout Description
2721 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2723 \begin_layout Description
2724 Syntax paragraph-down
2726 \begin_layout Description
2727 Origin Asger, 1 Oct 1996
2730 \begin_layout Subsection*
2731 LFUN_PARAGRAPH_DOWN_SELECT
2733 \begin_layout Description
2734 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2736 \begin_layout Description
2737 Syntax paragraph-down-select
2739 \begin_layout Description
2740 Origin Asger, 1 Oct 1996
2743 \begin_layout Subsection*
2746 \begin_layout Description
2747 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2749 \begin_layout Description
2750 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).
2752 \begin_layout Description
2753 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2755 \begin_layout Description
2756 Params <PAR_ID_NUMBER>: paragraph id
2757 \begin_inset Newline newline
2760 <POSITION_IN_PAR>: desired position within the paragraph
2762 \begin_layout Description
2763 Origin Dekel, 26 Aug 2000
2766 \begin_layout Subsection*
2767 LFUN_BREAK_PARAGRAPH
2769 \begin_layout Description
2770 Action Breaks the current paragraph at the current location.
2772 \begin_layout Description
2773 Syntax break-paragraph
2776 \begin_layout Subsection*
2777 LFUN_BREAK_PARAGRAPH
2779 \begin_layout Description
2780 Action Breaks the current paragraph at the current location.
2782 \begin_layout Description
2783 Notion Removes the selection.
2785 \begin_layout Description
2786 Syntax break-paragraph [<LAYOUT>]
2788 \begin_layout Description
2789 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2792 \begin_layout Subsection*
2793 LFUN_PARAGRAPH_PARAMS
2795 \begin_layout Description
2796 Action Change paragraph settings.
2798 \begin_layout Description
2799 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.
2801 \begin_layout Description
2802 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2804 \begin_layout Description
2814 \begin_inset Newline newline
2819 paragraph_spacing default|single|onehalf|double|other
2820 \begin_inset Newline newline
2825 align block|left|right|center|default
2826 \begin_inset Newline newline
2831 labelwidthstring WIDTH|
2835 \begin_layout Description
2836 Origin rgh, Aug 15 2007
2839 \begin_layout Subsection*
2840 LFUN_PARAGRAPH_PARAMS_APPLY
2842 \begin_layout Description
2843 Action Change paragraph settings.
2845 \begin_layout Description
2846 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2848 \begin_layout Description
2849 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2851 \begin_layout Description
2852 Params For parameters see LFUN_PARAGRAPH_PARAMS
2854 \begin_layout Description
2855 Origin leeming, 30 Mar 2004
2858 \begin_layout Subsection*
2859 LFUN_PARAGRAPH_UPDATE
2861 \begin_layout Description
2862 Action Updates the values inside the paragraph dialog from the paragraph.
2864 \begin_layout Description
2865 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2867 \begin_layout Description
2868 Origin leeming, 13 Mar 2003
2871 \begin_layout Subsection*
2874 \begin_layout Description
2875 Action Move the current group in the upward direction in the structure of the document.
2877 \begin_layout Description
2878 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2880 \begin_layout Description
2883 \begin_layout Description
2884 Origin Vermeer, 23 Mar 2006
2887 \begin_layout Subsection*
2890 \begin_layout Description
2891 Action Move the current group in the downward direction in the structure of the document.
2893 \begin_layout Description
2894 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2896 \begin_layout Description
2899 \begin_layout Description
2900 Origin Vermeer, 23 Mar 2006
2903 \begin_layout Subsection*
2906 \begin_layout Description
2907 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2909 \begin_layout Description
2910 Notion Part -> Chapter -> Section -> etc.
2912 \begin_layout Description
2915 \begin_layout Description
2916 Origin Vermeer, 23 Mar 2006
2919 \begin_layout Subsection*
2922 \begin_layout Description
2923 Action Moves the current group in the upward direction in the hierarchy of the document structure.
2925 \begin_layout Description
2926 Notion Part <- Chapter <- Section <- etc.
2928 \begin_layout Description
2931 \begin_layout Description
2932 Origin Vermeer, 23 Mar 2006
2935 \begin_layout Subsection*
2936 LFUN_OUTLINE_DRAGMOVE
2938 \begin_layout Description
2939 Action Moves the document section associated with the specified heading to a specified location. Both the heading and the target paragraph are specified by the paragraph ID numbers.
2941 \begin_layout Description
2942 Notion The heading is a paragraph with style Part/Chapter/Section/ etc. Id number of the paragraph is not the sequential number seen on the screen, but an internal number that is unique for all opened buffers (documents).
2944 \begin_layout Description
2945 Syntax outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
2947 \begin_layout Description
2948 Params <PAR_ID_SECTION>: paragraph id of the section heading which is to be moved.
2949 \begin_inset Newline newline
2952 <PAR_ID_DROP_POSITION>: the paragraph id where the section will be moved to.
2954 \begin_layout Description
2955 Origin Rob Oakes, 22 June 2009
2958 \begin_layout Subsection*
2961 \begin_layout Description
2962 Action Edit the inset at cursor with an external application, if one is attributed.
2964 \begin_layout Description
2965 Syntax inset-edit [<INSET_PARAMS>]
2967 \begin_layout Description
2968 Params <INSET_PARAMS>: Parameters for the inset.
2969 \begin_inset Newline newline
2972 Currently only the filename will be considered.
2974 \begin_layout Description
2975 Origin JSpitzm, 27 Apr 2006
2978 \begin_layout Subsection*
2981 \begin_layout Description
2982 Action Inserts table into the document.
2984 \begin_layout Description
2985 Syntax tabular-insert [<ROWS> <COLUMNS>]
2987 \begin_layout Description
2988 Params In case no arguments are given show insert dialog.
2990 \begin_layout Description
2991 Origin Jug, 12 Apr 2000
2994 \begin_layout Subsection*
2995 LFUN_TABULAR_FEATURE
2997 \begin_layout Description
2998 Action Sets various features to the table/cell on the current cursor position.
3000 \begin_layout Description
3001 Notion Various math-environment features are handled here as well, e.g. add-vline-left/right for the Grid/Array environment
3003 \begin_layout Description
3004 Syntax tabular-feature <FEATURE> [<ARG>]
3006 \begin_layout Description
3007 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| align-left|align-right|align-center|align-block|valign-top|valign-bottom| valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabular|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space|set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabular-valign-middle|tabular-valign-bottom
3008 \begin_inset Newline newline
3011 <ARG>: additional argument for some commands, use debug mode to explore its values.
3013 \begin_layout Description
3014 Origin Jug, 28 Jul 2000
3017 \begin_layout Subsection*
3020 \begin_layout Description
3021 Action Moves the cursor to the previous cell inside the table.
3023 \begin_layout Description
3024 Syntax cell-backward
3026 \begin_layout Description
3027 Origin Jug, 22 May 2000
3030 \begin_layout Subsection*
3033 \begin_layout Description
3034 Action Moves the cursor to the next cell inside the table.
3036 \begin_layout Description
3040 \begin_layout Subsection*
3043 \begin_layout Description
3044 Action Splits cell and shifts right part to the next cell (inside the math grid).
3046 \begin_layout Description
3049 \begin_layout Description
3050 Origin Ale, 15 May 1997
3053 \begin_layout Subsection*
3056 \begin_layout Description
3057 Action Register the document as an file inside version control system (RCS, CVS).
3059 \begin_layout Description
3060 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3061 \begin_inset Newline newline
3064 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3066 \begin_layout Description
3069 \begin_layout Description
3070 Origin Lgb, 1 Jul 1997
3073 \begin_layout Subsection*
3076 \begin_layout Description
3077 Action Checks-in/commits the changes of the registered file to the repository.
3079 \begin_layout Description
3080 Notion In RCS case this also unlocks the file.
3082 \begin_layout Description
3085 \begin_layout Description
3086 Origin Lgb, 1 Jul 1997
3089 \begin_layout Subsection*
3092 \begin_layout Description
3093 Action Checks-out the document for edit (and locks it for RCS).
3095 \begin_layout Description
3096 Notion This is implemented only for RCS and SVN, not CVS.
3098 \begin_layout Description
3101 \begin_layout Description
3102 Origin Lgb, 1 Jul 1997
3105 \begin_layout Subsection*
3108 \begin_layout Description
3109 Action Reverts the document to the last check-in/commit in VCS.
3111 \begin_layout Description
3114 \begin_layout Description
3115 Origin Lgb, 1 Jul 1997
3118 \begin_layout Subsection*
3121 \begin_layout Description
3122 Action Undo last check-in.
3124 \begin_layout Description
3125 Notion This is currently implemented only for RCS.
3127 \begin_layout Description
3130 \begin_layout Description
3131 Origin Lgb, 1 Jul 1997
3134 \begin_layout Subsection*
3137 \begin_layout Description
3138 Action Executes external command. This command is intended to support additional VCS commands.
3140 \begin_layout Description
3141 Syntax vc-command <FLAG> <PATH> <COMMAND>
3143 \begin_layout Description
3144 Params <FLAG>: Flags for the command can be combined together.
3145 \begin_inset Newline newline
3148 U - dUmmy - no flags
3149 \begin_inset Newline newline
3152 D - Doc - need document loaded to proceed
3153 \begin_inset Newline newline
3156 I - dIrty - mark document dirty
3157 \begin_inset Newline newline
3160 R - Reload - ensure that the document is saved and reload it after command execution
3161 \begin_inset Newline newline
3164 M - Message - ask for input string (commit message)
3165 \begin_inset Newline newline
3168 <PATH>: path where to start. $$p will be replaced by the current document path.
3169 \begin_inset Newline newline
3172 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
3174 \begin_layout Description
3175 Sample vc-command DR $$p "svn up"
3177 \begin_layout Description
3178 Origin sanda, 13 Jan 2009
3181 \begin_layout Subsection*
3182 LFUN_VC_LOCKING_TOGGLE
3184 \begin_layout Description
3185 Action Toggles the locking property of the edited file.
3187 \begin_layout Description
3188 Notion This is currently implemented only for SVN.
3190 \begin_layout Description
3191 Syntax vc-locking-toggle
3193 \begin_layout Description
3194 Origin sanda, 25 Jun 2009
3197 \begin_layout Subsection*
3200 \begin_layout Description
3201 Action Toggles change tracking to on/off.
3203 \begin_layout Description
3204 Syntax changes-track
3206 \begin_layout Description
3207 Origin levon, 1 Oct 2002
3210 \begin_layout Subsection*
3213 \begin_layout Description
3214 Action Toggles showing of change tracking in typesetted output.
3216 \begin_layout Description
3217 Syntax changes-output
3219 \begin_layout Description
3220 Origin jspitzm, 21 Jan 2005
3223 \begin_layout Subsection*
3226 \begin_layout Description
3227 Action Moves the cursor to the position of the next change of the change tracking records.
3229 \begin_layout Description
3232 \begin_layout Description
3233 Origin schmitt, 4 Oct 2006
3236 \begin_layout Subsection*
3237 LFUN_CHANGE_PREVIOUS
3239 \begin_layout Description
3240 Action Moves the cursor to the position of the previous change of the change tracking records.
3242 \begin_layout Description
3243 Syntax change-previous
3245 \begin_layout Description
3246 Origin vfr, 4 Apr 2009
3249 \begin_layout Subsection*
3252 \begin_layout Description
3253 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3255 \begin_layout Description
3256 Syntax changes-merge
3258 \begin_layout Description
3259 Origin Levon, 16 Oct 2002
3262 \begin_layout Subsection*
3265 \begin_layout Description
3266 Action Accepts tracked change inside the selection.
3268 \begin_layout Description
3269 Syntax change-accept
3271 \begin_layout Description
3272 Origin Levon, 16 Oct 2002
3275 \begin_layout Subsection*
3278 \begin_layout Description
3279 Action Rejects tracked change inside the selection.
3281 \begin_layout Description
3282 Syntax change-accept
3284 \begin_layout Description
3285 Origin Levon, 16 Oct 2002
3288 \begin_layout Subsection*
3289 LFUN_ALL_CHANGES_ACCEPT
3291 \begin_layout Description
3292 Action Accepts all tracked changes in the document.
3294 \begin_layout Description
3295 Syntax all-changes-accept
3297 \begin_layout Description
3298 Origin Levon, 16 Oct 2002
3301 \begin_layout Subsection*
3302 LFUN_ALL_CHANGES_REJECT
3304 \begin_layout Description
3305 Action Rejects all tracked changes in the document.
3307 \begin_layout Description
3308 Notion Reject does not work recursively; the user may have to repeat the operation.
3310 \begin_layout Description
3311 Syntax all-changes-reject
3313 \begin_layout Description
3314 Origin Levon, 16 Oct 2002
3317 \begin_layout Subsection*
3320 \begin_layout Description
3321 Action Apply data for an inset.
3323 \begin_layout Description
3324 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.
3326 \begin_layout Description
3327 Syntax inset-apply <ARGS>
3329 \begin_layout Description
3330 Params See LFUN_INSET_INSERT .
3333 \begin_layout Subsection*
3336 \begin_layout Description
3337 Action Dissolve the current inset into text.
3339 \begin_layout Description
3340 Syntax inset-dissolve [<INSET>]
3342 \begin_layout Description
3343 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.
3344 \begin_inset Newline newline
3347 For values see lyx::InsetLayout::lyxtype_ .
3349 \begin_layout Description
3350 Origin JSpitz, 7 Aug 2006
3353 \begin_layout Subsection*
3356 \begin_layout Description
3357 Action Insert new inset (type given by the parameters).
3359 \begin_layout Description
3360 Syntax inset-insert <INSET> <ARGS>
3362 \begin_layout Description
3363 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|include|index|label|nomencl|vspace|ref|toc>
3364 \begin_inset Newline newline
3367 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3369 \begin_layout Description
3370 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3373 \begin_inset Newline newline
3376 where <label name> is the name of the referenced label and <Format> is one of the following:
3377 \begin_inset Newline newline
3381 \begin_inset Newline newline
3384 eqref -- (<reference>)
3385 \begin_inset Newline newline
3389 \begin_inset Newline newline
3392 vpageref -- on <page>
3393 \begin_inset Newline newline
3396 vref -- <reference> on <page>
3397 \begin_inset Newline newline
3400 prettyref -- Formatted reference
3403 \begin_layout Subsection*
3406 \begin_layout Description
3407 Action Modify existing inset.
3409 \begin_layout Description
3410 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3412 \begin_layout Description
3413 Syntax inset-modify <INSET> <ARGS>
3415 \begin_layout Description
3416 Params See LFUN_INSET_INSERT for further details.
3419 \begin_layout Subsection*
3420 LFUN_NEXT_INSET_MODIFY
3422 \begin_layout Description
3423 Action Modify the inset at cursor position, if there is one.
3425 \begin_layout Description
3426 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3428 \begin_layout Description
3429 Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
3431 \begin_layout Description
3432 Params See LFUN_INSET_INSERT for further details.
3434 \begin_layout Description
3435 Origin JSpitzm, 23 Mar 2008
3438 \begin_layout Subsection*
3439 LFUN_INSET_DIALOG_UPDATE
3441 \begin_layout Description
3442 Action Updates the values inside the dialog from the inset.
3444 \begin_layout Description
3445 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3447 \begin_layout Description
3448 Params <DIALOG-NAME>
3450 \begin_layout Description
3451 Origin leeming, 25 Feb 2003
3454 \begin_layout Subsection*
3457 \begin_layout Description
3458 Action Open the inset's properties dialog.
3460 \begin_layout Description
3461 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3463 \begin_layout Description
3464 Syntax inset-settings <INSET>
3466 \begin_layout Description
3467 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float| graphics|href|include|index|index_print|label|listings| note|phantom|ref|space|tabular|vspace|wrap>.
3470 \begin_layout Subsection*
3473 \begin_layout Description
3474 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3476 \begin_layout Description
3477 Syntax inset-toggle [<ARG>]
3479 \begin_layout Description
3480 Params <ARG>: <open|close|toggle|assign>.
3481 \begin_inset Newline newline
3484 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3485 \begin_inset Newline newline
3488 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3490 \begin_layout Description
3491 Origin lasgouttes, 19 Jul 2001
3494 \begin_layout Subsection*
3495 LFUN_ALL_INSETS_TOGGLE
3497 \begin_layout Description
3498 Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
3500 \begin_layout Description
3501 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
3503 \begin_layout Description
3504 Syntax all-insets-toggle [<STATE>] [<INSET>]
3506 \begin_layout Description
3507 Params <STATE>: <toggle|open|close|assign> default: toggle
3508 \begin_inset Newline newline
3511 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
3513 \begin_layout Description
3514 Origin leeming, 30 Mar 2004
3517 \begin_layout Subsection*
3518 LFUN_SET_GRAPHICS_GROUP
3520 \begin_layout Description
3521 Action Set the group for the graphics inset on the cursor position.
3523 \begin_layout Description
3524 Syntax set-graphics-group [<GROUP>]
3526 \begin_layout Description
3527 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3529 \begin_layout Description
3530 Origin sanda, 6 May 2008
3533 \begin_layout Subsection*
3534 LFUN_FINISHED_FORWARD
3536 \begin_layout Description
3537 Action Moves the cursor out of the current slice, going forward.
3539 \begin_layout Description
3540 Notion Cursor movement within an inset may be different than cursor movement in the surrounding text. This action should be called automatically by the cursor movement within the inset, when movement within the inset has ceased (reached the end of the last paragraph, for example), in order to move correctly back into the surrounding text.
3543 \begin_layout Subsection*
3544 LFUN_FINISHED_BACKWARD
3546 \begin_layout Description
3547 Action Moves the cursor out of the current slice, going backwards.
3549 \begin_layout Description
3550 Notion See also LFUN_FINISHED_FORWARD.
3553 \begin_layout Subsection*
3556 \begin_layout Description
3557 Action Moves the cursor out of the current slice, going right.
3559 \begin_layout Description
3560 Notion See also LFUN_FINISHED_FORWARD
3563 \begin_layout Subsection*
3566 \begin_layout Description
3567 Action Moves the cursor out of the current slice, going left.
3569 \begin_layout Description
3570 Notion See also LFUN_FINISHED_FORWARD.
3573 \begin_layout Subsection*
3576 \begin_layout Description
3577 Action Set language from the current cursor position.
3579 \begin_layout Description
3580 Syntax language <LANG>
3582 \begin_layout Description
3583 Params <LANG>: Requested language. Look in lib/languages for the list.
3585 \begin_layout Description
3586 Origin Dekel, 2 Mar 2000
3589 \begin_layout Subsection*
3592 \begin_layout Description
3593 Action Goto a label.
3595 \begin_layout Description
3596 Syntax label-goto [<LABEL>]
3598 \begin_layout Description
3599 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.
3601 \begin_layout Description
3602 Origin Ale, 6 Aug 1997
3605 \begin_layout Subsection*
3608 \begin_layout Description
3609 Action Inserts label to text or displayed formula.
3611 \begin_layout Description
3612 Syntax label-insert [<LABEL>]
3614 \begin_layout Description
3615 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3618 \begin_layout Subsection*
3621 \begin_layout Description
3622 Action Go to the next label or cross-reference.
3624 \begin_layout Description
3625 Syntax reference-next
3627 \begin_layout Description
3628 Origin Dekel, 14 Jan 2001
3631 \begin_layout Subsection*
3634 \begin_layout Description
3635 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3637 \begin_layout Description
3638 Notion Bookmark 0 has a special purpose. It is automatically set
3639 \begin_inset Newline newline
3642 1. to the paragraph you are currently editing
3643 \begin_inset Newline newline
3646 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3647 \begin_inset Newline newline
3650 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3652 \begin_layout Description
3653 Syntax bookmark-goto <NUMBER>
3655 \begin_layout Description
3656 Params <NUMBER>: the number of the bookmark to restore.
3658 \begin_layout Description
3659 Origin Dekel, 27 January 2001
3662 \begin_layout Subsection*
3665 \begin_layout Description
3666 Action Save a bookmark.
3668 \begin_layout Description
3669 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.
3671 \begin_layout Description
3672 Syntax bookmark-save <NUMBER>
3674 \begin_layout Description
3675 Params <NUMBER>: the number of the bookmark to save.
3677 \begin_layout Description
3678 Origin Dekel, 27 January 2001
3681 \begin_layout Subsection*
3684 \begin_layout Description
3685 Action Clears the list of saved bookmarks.
3687 \begin_layout Description
3688 Syntax bookmark-clear
3690 \begin_layout Description
3691 Origin bpeng, 31 October 2006
3694 \begin_layout Subsection*
3697 \begin_layout Description
3698 Action Open the given help file according to the language setting.
3700 \begin_layout Description
3701 Syntax help-open <FILE>[.lyx]
3703 \begin_layout Description
3704 Params <FILE>: any document from (/usr/share/)doc directory.
3706 \begin_layout Description
3707 Origin Jug, 27 Jun 1999
3710 \begin_layout Subsection*
3713 \begin_layout Description
3714 Action Terminates the current LyX instance.
3716 \begin_layout Description
3717 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3719 \begin_layout Description
3723 \begin_layout Subsection*
3726 \begin_layout Description
3727 Action Toggles visibility of a given toolbar between on/off/auto.
3729 \begin_layout Description
3730 Notion Skiping "auto" when allowauto is false.
3732 \begin_layout Description
3733 Syntax toolbar-toggle <NAME> [allowauto]
3735 \begin_layout Description
3736 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
3738 \begin_layout Description
3739 Origin Edwin, 21 May 2007
3742 \begin_layout Subsection*
3745 \begin_layout Description
3746 Action Opens the menu given by its name.
3748 \begin_layout Description
3749 Syntax menu-open <NAME>
3751 \begin_layout Description
3752 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3755 \begin_layout Subsection*
3758 \begin_layout Description
3759 Action Various UI visibility-toggling actions.
3761 \begin_layout Description
3762 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3764 \begin_layout Description
3765 Params statusbar : Toggle visibility of the statusbar.
3766 \begin_inset Newline newline
3769 menubar : Toggle visibility of the menubar.
3770 \begin_inset Newline newline
3773 scrollbar : Toggle visibility of the scrollbar.
3774 \begin_inset Newline newline
3777 frame : Toggle visibility of the frames around editing window.
3778 \begin_inset Newline newline
3781 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.
3783 \begin_layout Description
3784 Origin sanda, 9 Feb 2007
3787 \begin_layout Subsection*
3790 \begin_layout Description
3791 Action Creates new empty LyX window.
3793 \begin_layout Description
3794 Notion Already opened documents from the previous window can be found under View menu.
3796 \begin_layout Description
3797 Syntax window-new [<GEOMETRY>]
3799 \begin_layout Description
3800 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3802 \begin_layout Description
3803 Origin Abdel, 21 Oct 2006
3806 \begin_layout Subsection*
3809 \begin_layout Description
3810 Action Closes the current LyX window.
3812 \begin_layout Description
3815 \begin_layout Description
3816 Origin Abdel, 23 Oct 2006
3819 \begin_layout Subsection*
3822 \begin_layout Description
3823 Action Creates another split view of current buffer.
3825 \begin_layout Description
3826 Notion All split views act in the same way indpendently.
3828 \begin_layout Description
3829 Syntax split-view <vertical|horizontal>
3831 \begin_layout Description
3832 Params horizontal : The work areas are laid out side by side.
3833 \begin_inset Newline newline
3836 vertical : The work areas laid out vertically.
3838 \begin_layout Description
3839 Origin Abdel, 20 Feb 2008
3842 \begin_layout Subsection*
3843 LFUN_CLOSE_TAB_GROUP
3845 \begin_layout Description
3846 Action Close the current tab group.
3848 \begin_layout Description
3849 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
3851 \begin_layout Description
3852 Syntax close-tab-group
3854 \begin_layout Description
3855 Origin Abdel, 21 Feb 2008
3858 \begin_layout Subsection*
3861 \begin_layout Description
3862 Action Shows hidden dialog or create new one for a given function/inset settings etc.
3864 \begin_layout Description
3865 Syntax dialog-show <NAME> [<DATA>]
3867 \begin_layout Description
3868 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
3869 \begin_inset Newline newline
3872 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
3873 \begin_inset Newline newline
3876 href|include|index|index_print|info|label|listings|log|mathdelimiter|
3877 \begin_inset Newline newline
3880 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
3881 \begin_inset Newline newline
3884 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
3885 \begin_inset Newline newline
3888 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
3889 \begin_inset Newline newline
3892 <SPECIAL>: latexlog|vclog
3893 \begin_inset Newline newline
3896 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
3898 \begin_layout Description
3899 Origin leeming, 17 Jun 2003
3902 \begin_layout Subsection*
3903 LFUN_DIALOG_SHOW_NEW_INSET
3905 \begin_layout Description
3906 Action Shows hidden dialog or create new one for a given inset settings etc.
3908 \begin_layout Description
3909 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
3911 \begin_layout Description
3912 Syntax dialog-show-new-inset <NAME> [<DATA>]
3914 \begin_layout Description
3915 Params See LFUN_DIALOG_SHOW .
3917 \begin_layout Description
3918 Origin leeming, 25 Feb 2003
3921 \begin_layout Subsection*
3924 \begin_layout Description
3925 Action Updates the dialog values from the inset/paragraph/document.
3927 \begin_layout Description
3928 Syntax dialog-update <NAME>
3930 \begin_layout Description
3931 Params <NAME>: paragraph|prefs|<INSET>
3932 \begin_inset Newline newline
3937 \begin_layout Description
3938 Origin leeming, 25 Feb 2003
3941 \begin_layout Subsection*
3944 \begin_layout Description
3945 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
3947 \begin_layout Description
3948 Syntax dialog-hide <NAME>
3950 \begin_layout Description
3951 Params See LFUN_DIALOG_SHOW .
3953 \begin_layout Description
3954 Origin leeming, 25 Feb 2003
3957 \begin_layout Subsection*
3960 \begin_layout Description
3961 Action Toggles dialog between showed/hidden state.
3963 \begin_layout Description
3964 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
3966 \begin_layout Description
3967 Syntax dialog-toggle <NAME> [<DATA>]
3969 \begin_layout Description
3970 Params See LFUN_DIALOG_SHOW .
3972 \begin_layout Description
3973 Origin JSpitzm, 30 Apr 2007
3976 \begin_layout Subsection*
3977 LFUN_DIALOG_DISCONNECT_INSET
3979 \begin_layout Description
3980 Action Closes opened connection to opened inset.
3982 \begin_layout Description
3983 Notion Connection is used for apply functions.
3985 \begin_layout Description
3986 Syntax dialog-disconnect-inset <INSET-NAME>
3988 \begin_layout Description
3989 Origin leeming, 25 Feb 2003
3992 \begin_layout Subsection*
3995 \begin_layout Description
3996 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
3998 \begin_layout Description
3999 Notion This is internal LFUN, not to be used by users.
4001 \begin_layout Description
4002 Origin Andre, 9 Aug 2002
4005 \begin_layout Subsection*
4008 \begin_layout Description
4009 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
4011 \begin_layout Description
4012 Notion This is internal LFUN, not to be used by users.
4014 \begin_layout Description
4015 Origin Andre, 9 Aug 2002
4018 \begin_layout Subsection*
4021 \begin_layout Description
4022 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4024 \begin_layout Description
4025 Notion This is internal LFUN, not to be used by users.
4027 \begin_layout Description
4028 Origin Andre, 9 Aug 2002
4031 \begin_layout Subsection*
4034 \begin_layout Description
4035 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4037 \begin_layout Description
4038 Notion This is internal LFUN, not to be used by users.
4040 \begin_layout Description
4041 Origin Andre, 9 Aug 2002
4044 \begin_layout Subsection*
4047 \begin_layout Description
4048 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4050 \begin_layout Description
4051 Notion This is internal LFUN, not to be used by users.
4053 \begin_layout Description
4054 Origin Andre, 9 Aug 2002
4057 \begin_layout Subsection*
4060 \begin_layout Description
4061 Action Turn off the loaded keyboard map.
4063 \begin_layout Description
4067 \begin_layout Subsection*
4070 \begin_layout Description
4071 Action Turn on the primary keyboard map.
4073 \begin_layout Description
4074 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 plaforms.
4075 \begin_inset Newline newline
4078 The language is to be set in the Preferences dialog.
4080 \begin_layout Description
4081 Syntax keymap-primary
4084 \begin_layout Subsection*
4085 LFUN_KEYMAP_SECONDARY
4087 \begin_layout Description
4088 Action Turn on the secondary keyboard map.
4090 \begin_layout Description
4091 Syntax keymap-secondary
4094 \begin_layout Subsection*
4097 \begin_layout Description
4098 Action Toggles keyboard maps (first/second/off).
4100 \begin_layout Description
4101 Syntax keymap-toggle
4103 \begin_layout Description
4104 Origin leeming, 30 Mar 2004
4107 \begin_layout Subsection*
4108 LFUN_SERVER_GET_LAYOUT
4110 \begin_layout Description
4111 Action Returns the current layout (that is environment) name on the cursor position.
4113 \begin_layout Description
4114 Syntax server-get-layout
4117 \begin_layout Subsection*
4118 LFUN_SERVER_GET_FILENAME
4120 \begin_layout Description
4121 Action Returns path and file name of the currently edited document.
4123 \begin_layout Description
4124 Syntax server-get-filename
4127 \begin_layout Subsection*
4128 LFUN_SERVER_GOTO_FILE_ROW
4130 \begin_layout Description
4131 Action Sets the cursor position based on the row number of generated TeX file.
4133 \begin_layout Description
4134 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).
4136 \begin_layout Description
4137 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4139 \begin_layout Description
4140 Params <FILE>: the filename. Environment variables are expaned in the path. In case this LFUN does not work make sure you are giving correct path to the file.
4141 \begin_inset Newline newline
4144 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). .ext: extensions will be automatically replaced by .lyx.
4146 \begin_layout Description
4147 Origin Edmar, 23 Dec 1998
4150 \begin_layout Subsection*
4153 \begin_layout Description
4154 Action Sends notify message about the last key-sequence to client.
4156 \begin_layout Description
4157 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4159 \begin_layout Description
4160 Syntax server-notify
4163 \begin_layout Subsection*
4166 \begin_layout Description
4167 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4169 \begin_layout Description
4170 Syntax server-set-xy <X> <Y>
4173 \begin_layout Subsection*
4176 \begin_layout Description
4177 Action Returns the coordinates of cursor position in the editing area.
4179 \begin_layout Description
4180 Syntax server-get-xy
4183 \begin_layout Subsection*
4186 \begin_layout Description
4187 Action Generates the code (literate programming).
4189 \begin_layout Description
4190 Notion Latex file with extension
4192 literate_extension is generated. Then LyX invokes
4194 build_command (with a default of``make'') to generate the code and
4196 build_error_filter to process the compilation error messages.
4197 \begin_inset Newline newline
4200 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:
4201 \begin_inset Newline newline
4206 build_command "my_script my_arguments"
4207 \begin_inset Newline newline
4212 build_error_filter differs from the
4214 literate_error_filter only in that the former will identify error messages from your compiler.
4216 \begin_layout Description
4217 Syntax build-program
4220 \begin_layout Subsection*
4221 LFUN_BUFFER_AUTO_SAVE
4223 \begin_layout Description
4224 Action Saves the current buffer to a temporary file.
4226 \begin_layout Description
4227 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4229 \begin_layout Description
4230 Syntax buffer-auto-save
4233 \begin_layout Subsection*
4234 LFUN_BUFFER_CHILD_OPEN
4236 \begin_layout Description
4237 Action Loads the given child document.
4239 \begin_layout Description
4240 Notion The current document is treated as a parent.
4242 \begin_layout Description
4243 Syntax buffer-child-open <FILE>
4245 \begin_layout Description
4246 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4248 \begin_layout Description
4249 Origin Ale, 28 May 1997
4252 \begin_layout Subsection*
4255 \begin_layout Description
4256 Action Runs chktex for the current document.
4258 \begin_layout Description
4259 Syntax buffer-chktex
4261 \begin_layout Description
4262 Origin Asger, 30 Oct 1997
4265 \begin_layout Subsection*
4266 LFUN_BUFFER_TOGGLE_COMPRESSION
4268 \begin_layout Description
4269 Action Toggles compression of the current document on/off.
4271 \begin_layout Description
4272 Syntax buffer-toggle-compression
4274 \begin_layout Description
4275 Origin bpeng, 27 Apr 2006
4278 \begin_layout Subsection*
4281 \begin_layout Description
4282 Action Closes the current buffer.
4284 \begin_layout Description
4285 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4287 \begin_layout Description
4291 \begin_layout Subsection*
4294 \begin_layout Description
4295 Action Exports the current buffer (document) to the given format.
4297 \begin_layout Description
4298 Syntax buffer-export <FORMAT>
4300 \begin_layout Description
4301 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.
4302 \begin_inset Newline newline
4305 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.
4307 \begin_layout Description
4308 Origin Lgb, 29 Jul 1997
4311 \begin_layout Subsection*
4312 LFUN_BUFFER_EXPORT_CUSTOM
4314 \begin_layout Description
4315 Action Exports the current buffer (document) from the given format using the given command on it.
4317 \begin_layout Description
4318 Syntax buffer-export-custom <FORMAT> <COMMAND>
4320 \begin_layout Description
4321 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4322 \begin_inset Newline newline
4325 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4327 \begin_layout Description
4328 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4330 \begin_layout Description
4331 Origin leeming, 27 Mar 2004
4334 \begin_layout Subsection*
4337 \begin_layout Description
4338 Action Prints the current document.
4340 \begin_layout Description
4341 Notion Many settings can be given via the preferences dialog.
4343 \begin_layout Description
4344 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4346 \begin_layout Description
4347 Params <TARGET> is either "printer" or "file".
4348 \begin_inset Newline newline
4351 <TARGER-NAME> is either "default" or file name or printer name.
4352 \begin_inset Newline newline
4355 <COMMAND> command ensuring the printing job.
4357 \begin_layout Description
4358 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4360 \begin_layout Description
4361 Origin leeming, 28 Mar 2004
4364 \begin_layout Subsection*
4367 \begin_layout Description
4368 Action Import a given file as a lyx document.
4370 \begin_layout Description
4371 Notion File can be imported iff lyx file format is (transitively) reachable via defined convertors in preferences. Look into File->Import menu to get an idea of the currently active import formats.
4373 \begin_layout Description
4374 Syntax buffer-import <FORMAT> [<FILE>]
4376 \begin_layout Description
4377 Origin Asger, 24 Jul 1998
4380 \begin_layout Subsection*
4383 \begin_layout Description
4384 Action Creates a new buffer (that is, document).
4386 \begin_layout Description
4387 Notion Implicit path can be set in Preferences dialog.
4389 \begin_layout Description
4390 Syntax buffer-new [<FILE>]
4392 \begin_layout Description
4393 Params <FILE>: filename of created file with absolute path.
4396 \begin_layout Subsection*
4397 LFUN_BUFFER_NEW_TEMPLATE
4399 \begin_layout Description
4400 Action Creates a new buffer (that is, document) from a template.
4402 \begin_layout Description
4403 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4405 \begin_layout Description
4406 Syntax buffer-new-template [<FILE>]
4408 \begin_layout Description
4409 Params <FILE>: filename of created file with absolute path.
4412 \begin_layout Subsection*
4415 \begin_layout Description
4416 Action Reverts opened document.
4418 \begin_layout Description
4419 Syntax buffer-reload
4421 \begin_layout Description
4422 Origin Asger, 2 Feb 1997
4425 \begin_layout Subsection*
4428 \begin_layout Description
4429 Action Switch to the given buffer.
4431 \begin_layout Description
4432 Notion This is useful also in case you need simultaneously more views of the edited document in different LyX windows.
4434 \begin_layout Description
4435 Syntax buffer-new-template <BUFFER>
4437 \begin_layout Description
4438 Params <BUFFER>: already opened document which is to be shown.
4441 \begin_layout Subsection*
4442 LFUN_BUFFER_TOGGLE_READ_ONLY
4444 \begin_layout Description
4445 Action Toggle editing mode of the current document between read/write and read-only.
4447 \begin_layout Description
4448 Notion In the ->Readonly mode checks-in/commits the data if the file is under version control. In the Readonly-> mode checkouts the data from repository.
4449 \begin_inset Newline newline
4452 If these operations fail, buffer won't be toggled.
4454 \begin_layout Description
4455 Syntax buffer-toggle-read-only
4457 \begin_layout Description
4458 Origin Lgb, 27 May 1997
4461 \begin_layout Subsection*
4464 \begin_layout Description
4465 Action Displays current buffer in chosen format.
4467 \begin_layout Description
4468 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.
4470 \begin_layout Description
4471 Syntax buffer-view [<FORMAT>]
4473 \begin_layout Description
4474 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.
4477 \begin_layout Subsection*
4480 \begin_layout Description
4481 Action Exports the current document and put the result into the temporary directory.
4483 \begin_layout Description
4484 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewriten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript).
4486 \begin_layout Description
4487 Syntax buffer-update [<FORMAT>]
4489 \begin_layout Description
4490 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.
4492 \begin_layout Description
4493 Origin Dekel, 5 Aug 2000
4496 \begin_layout Subsection*
4499 \begin_layout Description
4500 Action Saves the current buffer.
4502 \begin_layout Description
4503 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.
4505 \begin_layout Description
4509 \begin_layout Subsection*
4510 LFUN_BUFFER_WRITE_AS
4512 \begin_layout Description
4513 Action Rename and save current buffer.
4515 \begin_layout Description
4516 Syntax buffer-write-as <FILENAME>
4518 \begin_layout Description
4519 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4522 \begin_layout Subsection*
4523 LFUN_BUFFER_WRITE_ALL
4525 \begin_layout Description
4526 Action Save all changed documents.
4528 \begin_layout Description
4529 Syntax buffer-write-all
4531 \begin_layout Description
4532 Origin rgh, gpothier 6 Aug 2007
4535 \begin_layout Subsection*
4538 \begin_layout Description
4539 Action Switch to the next opened document.
4541 \begin_layout Description
4542 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4544 \begin_layout Description
4548 \begin_layout Subsection*
4549 LFUN_BUFFER_PREVIOUS
4551 \begin_layout Description
4552 Action Switch to the previous opened document.
4554 \begin_layout Description
4555 Syntax buffer-previous
4558 \begin_layout Subsection*
4559 LFUN_MASTER_BUFFER_UPDATE
4561 \begin_layout Description
4562 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4564 \begin_layout Description
4565 Syntax master-buffer-update [<FORMAT>]
4567 \begin_layout Description
4568 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.
4570 \begin_layout Description
4571 Origin Tommaso, 20 Sep 2007
4574 \begin_layout Subsection*
4575 LFUN_MASTER_BUFFER_VIEW
4577 \begin_layout Description
4578 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4580 \begin_layout Description
4581 Syntax master-buffer-view [<FORMAT>]
4583 \begin_layout Description
4584 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.
4586 \begin_layout Description
4587 Origin Tommaso, 20 Sep 2007
4590 \begin_layout Subsection*
4591 LFUN_BUFFER_LANGUAGE
4593 \begin_layout Description
4594 Action Set language of the current document.
4596 \begin_layout Description
4597 Syntax buffer-language <LANG>
4599 \begin_layout Description
4600 Params <LANG>: language name. See lib/languages for list.
4602 \begin_layout Description
4603 Origin leeming, 30 Mar 2004
4606 \begin_layout Subsection*
4607 LFUN_BUFFER_SAVE_AS_DEFAULT
4609 \begin_layout Description
4610 Action Save the current document settings as default.
4612 \begin_layout Description
4613 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4615 \begin_layout Description
4616 Syntax buffer-save-as-default [<ARGS>]
4618 \begin_layout Description
4619 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4621 \begin_layout Description
4622 Origin leeming, 30 Mar 2004
4625 \begin_layout Subsection*
4626 LFUN_BUFFER_PARAMS_APPLY
4628 \begin_layout Description
4629 Action Apply the given settings to the current document.
4631 \begin_layout Description
4632 Syntax buffer-params-apply [<ARGS>]
4634 \begin_layout Description
4635 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4637 \begin_layout Description
4638 Origin leeming, 30 Mar 2004
4641 \begin_layout Subsection*
4644 \begin_layout Description
4645 Action Inserts another LyX file.
4647 \begin_layout Description
4648 Syntax file-insert [<FILE>]
4650 \begin_layout Description
4651 Params <FILE>: Filename to be inserted.
4654 \begin_layout Subsection*
4655 LFUN_FILE_INSERT_PLAINTEXT
4657 \begin_layout Description
4658 Action Inserts plain text file.
4660 \begin_layout Description
4661 Syntax file-insert-plaintext [<FILE>]
4663 \begin_layout Description
4664 Params <FILE>: Filename to be inserted.
4666 \begin_layout Description
4667 Origin CFO-G, 19 Nov 1997
4670 \begin_layout Subsection*
4671 LFUN_FILE_INSERT_PLAINTEXT_PARA
4673 \begin_layout Description
4674 Action Inserts plain text file as paragraph (i.e. join lines).
4676 \begin_layout Description
4677 Syntax file-insert-plaintext-para [<FILE>]
4679 \begin_layout Description
4680 Params <FILE>: Filename to be inserted.
4682 \begin_layout Description
4683 Origin Levon, 14 Feb 2001
4686 \begin_layout Subsection*
4689 \begin_layout Description
4690 Action Open LyX document.
4692 \begin_layout Description
4693 Syntax file-open [<FILE>]
4695 \begin_layout Description
4696 Params <FILE>: Filename to be opened.
4699 \begin_layout Subsection*
4702 \begin_layout Description
4703 Action Executes a command defined in a .def file.
4705 \begin_layout Description
4706 Notion The definitions are by default read from lib/commands/default.def.
4707 \begin_inset Newline newline
4710 A .def file allows to define a command with
4712 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).
4714 def_file "FileName" allows to include another .def file.
4715 \begin_inset Newline newline
4718 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.
4720 \begin_layout Description
4723 \begin_layout Description
4724 Params <NAME>: Name of the command that must be called.
4726 \begin_layout Description
4727 Origin broider, 2 Oct 2007
4730 \begin_layout Subsection*
4733 \begin_layout Description
4734 Action Simulate halting Meta key (Alt key on PCs).
4736 \begin_layout Description
4737 Notion Used for buffer editation not for GUI control.
4739 \begin_layout Description
4743 \begin_layout Subsection*
4746 \begin_layout Description
4747 Action Cancels sequence prepared by LFUN_META_PREFIX .
4749 \begin_layout Description
4753 \begin_layout Subsection*
4754 LFUN_COMMAND_EXECUTE
4756 \begin_layout Description
4757 Action Opens the minibuffer toolbar so that the user can type in there.
4759 \begin_layout Description
4760 Notion Usually bound to M-x shortcut.
4762 \begin_layout Description
4763 Syntax command-execute
4766 \begin_layout Subsection*
4769 \begin_layout Description
4770 Action Return the current key sequence and available options as a string.
4772 \begin_layout Description
4773 Notion No options are added if no current map exists.
4774 \begin_inset Newline newline
4777 This is probably usable only with connection to lyxserver.
4779 \begin_layout Description
4780 Syntax command-prefix
4783 \begin_layout Subsection*
4784 LFUN_COMMAND_SEQUENCE
4786 \begin_layout Description
4787 Action Run more commands (LFUN and its parameters) in a sequence.
4789 \begin_layout Description
4790 Syntax command-sequence <CMDS>
4792 \begin_layout Description
4793 Params <CMDS>: Sequence of commands separated by semicolons.
4795 \begin_layout Description
4796 Sample command-sequence cut; ert-insert; self-insert
4798 ; paste; self-insert {}; inset-toggle;
4800 \begin_layout Description
4801 Origin Andre, 11 Nov 1999
4804 \begin_layout Subsection*
4805 LFUN_COMMAND_ALTERNATIVES
4807 \begin_layout Description
4808 Action Runs the first listed command that is enabled.
4810 \begin_layout Description
4811 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
4813 \begin_layout Description
4814 Syntax command-alternatives <CMDS>
4816 \begin_layout Description
4817 Params <CMDS>: Sequence of commands separated by semicolons.
4819 \begin_layout Description
4820 Sample command-alternatives completion-accept;cell-forward
4822 \begin_layout Description
4823 Origin rgh, 24 September 2008
4826 \begin_layout Subsection*
4829 \begin_layout Description
4830 Action Shows message in statusbar (for script purposes).
4832 \begin_layout Description
4833 Syntax message <STRING>
4835 \begin_layout Description
4836 Origin Lgb, 8 Apr 2001
4839 \begin_layout Subsection*
4840 LFUN_PREFERENCES_SAVE
4842 \begin_layout Description
4843 Action Save user preferences.
4845 \begin_layout Description
4846 Syntax preferences-save
4848 \begin_layout Description
4849 Origin Lgb, 27 Nov 1999
4852 \begin_layout Subsection*
4855 \begin_layout Description
4856 Action Reconfigure the automatic settings.
4858 \begin_layout Description
4861 \begin_layout Description
4862 Origin Asger, 14 Feb 1997
4865 \begin_layout Subsection*
4868 \begin_layout Description
4869 Action Apply the given settings to user preferences.
4871 \begin_layout Description
4872 Syntax lyxrc-apply <SETTINGS>
4874 \begin_layout Description
4875 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.
4878 \begin_layout Subsection*
4879 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
4881 \begin_layout Description
4882 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
4884 \begin_layout Description
4885 Syntax toggle-cursor-follows-scrollbar
4887 \begin_layout Description
4888 Origin ARRae, 2 Dec 1997
4891 \begin_layout Subsection*
4894 \begin_layout Description
4895 Action Set the given LyX color to the color defined by the X11 name given.
4897 \begin_layout Description
4898 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
4900 \begin_layout Description
4901 Syntax set-color <LYX_NAME> <X11_NAME>
4903 \begin_layout Description
4904 Origin SLior, 11 Jun 2000
4907 \begin_layout Subsection*
4910 \begin_layout Description
4911 Action Count the statistics (number of words and characters) in the document or in the given selection.
4913 \begin_layout Description
4914 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
4916 \begin_layout Description
4919 \begin_layout Description
4920 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
4923 \begin_layout Subsection*
4924 LFUN_COMPLETION_INLINE
4926 \begin_layout Description
4927 Action Show the inline completion at the cursor position.
4929 \begin_layout Description
4930 Syntax completion-inline
4932 \begin_layout Description
4933 Origin sts, Feb 19 2008
4936 \begin_layout Subsection*
4937 LFUN_COMPLETION_POPUP
4939 \begin_layout Description
4940 Action Show the completion popup at the cursor position.
4942 \begin_layout Description
4943 Syntax completion-popup
4945 \begin_layout Description
4946 Origin sts, Feb 19 2008
4949 \begin_layout Subsection*
4950 LFUN_COMPLETION_COMPLETE
4952 \begin_layout Description
4953 Action Try to complete the word or command at the cursor position.
4955 \begin_layout Description
4958 \begin_layout Description
4959 Origin sts, Feb 19 2008
4962 \begin_layout Subsection*
4963 LFUN_COMPLETION_CANCEL
4965 \begin_layout Description
4966 Action Try to cancel completion, either the popup or the inline completion
4968 \begin_layout Description
4969 Syntax completion-cancel
4971 \begin_layout Description
4972 Origin sts, Sep 07 2008
4975 \begin_layout Subsection*
4976 LFUN_COMPLETION_ACCEPT
4978 \begin_layout Description
4979 Action Accept suggested completion.
4981 \begin_layout Description
4982 Syntax completion-accept
4984 \begin_layout Description
4985 Origin sanda, Sep 08 2008
4988 \begin_layout Subsection*
4989 LFUN_BRANCH_ACTIVATE
4991 \begin_layout Description
4992 Action Activate the branch
4994 \begin_layout Description
4995 Syntax branch-activate <BRANCH>
4997 \begin_layout Description
4998 Params <BRANCH>: The branch to activate
5000 \begin_layout Description
5001 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5002 \begin_inset Newline newline
5005 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5007 \begin_layout Description
5008 Origin rgh, 27 May 2008
5011 \begin_layout Subsection*
5012 LFUN_BRANCH_DEACTIVATE
5014 \begin_layout Description
5015 Action De-activate the branch
5017 \begin_layout Description
5018 Syntax branch-deactivate <BRANCH>
5020 \begin_layout Description
5021 Params <BRANCH>: The branch to deactivate
5023 \begin_layout Description
5024 Origin rgh, 27 May 2008
5027 \begin_layout Subsection*
5028 LFUN_LABEL_COPY_AS_REF
5030 \begin_layout Description
5031 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5033 \begin_layout Description
5034 Syntax copy-label-as-reference <LABEL>
5036 \begin_layout Description
5037 Params <LABEL>: The label to copy (for multi-line math)
5039 \begin_layout Description
5040 Origin sts, 16 Nov 2008
5043 \begin_layout Subsection*
5044 LFUN_LABEL_INSERT_AS_REF
5046 \begin_layout Description
5047 Action Inserts the label as a cross-reference at the position of the cursor.
5049 \begin_layout Description
5050 Syntax label-insert-as-reference
5052 \begin_layout Description
5053 Origin vfr, 7 Apr 2009
5056 \begin_layout Subsection*
5059 \begin_layout Description
5060 Action Increases the zoom of the screen fonts.
5062 \begin_layout Description
5063 Syntax buffer-zoom-in [<ZOOM>]
5065 \begin_layout Description
5066 Params <ZOOM>: The zoom in %, the default is 20.
5068 \begin_layout Description
5069 Origin vfr, 30 Mar 2009
5072 \begin_layout Subsection*
5073 LFUN_BUFFER_ZOOM_OUT
5075 \begin_layout Description
5076 Action Decreases the zoom of the screen fonts.
5078 \begin_layout Description
5079 Syntax buffer-zoom-out [<ZOOM>]
5081 \begin_layout Description
5082 Params <ZOOM>: The zoom in %, the default is 20.
5084 \begin_layout Description
5085 Origin vfr, 30 Mar 2009
5088 \begin_layout Subsection*
5091 \begin_layout Description
5092 Action Selects the whole section.
5094 \begin_layout Description
5095 Notion The cursor should be in a section heading before calling this lfun.
5097 \begin_layout Description
5098 Syntax section-select
5100 \begin_layout Description
5101 Origin vfr, 05 May 2009