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-05-17
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 from the active clipboard.
1536 \begin_layout Description
1537 Syntax paste [<TYPE>]
1539 \begin_layout Description
1540 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1543 \begin_layout Subsection*
1544 LFUN_CLIPBOARD_PASTE
1546 \begin_layout Description
1547 Action Pastes text from the active clipboard.
1549 \begin_layout Description
1550 Syntax clipboard-paste [<ARG>]
1552 \begin_layout Description
1553 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1555 \begin_layout Description
1556 Origin baum, 10 Jul 2006
1559 \begin_layout Subsection*
1560 LFUN_PRIMARY_SELECTION_PASTE
1562 \begin_layout Description
1563 Action Pastes the currently text selected text.
1565 \begin_layout Description
1566 Notion Primary selection mechanism is linux-only thing.
1568 \begin_layout Description
1569 Syntax primary-selection-paste [<ARG>]
1571 \begin_layout Description
1572 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1575 \begin_layout Subsection*
1576 LFUN_SELECTION_PASTE
1578 \begin_layout Description
1579 Action Pastes the text in permanent selection.
1581 \begin_layout Description
1582 Syntax selection-paste
1585 \begin_layout Subsection*
1588 \begin_layout Description
1589 Action Undoes the last edit.
1591 \begin_layout Description
1595 \begin_layout Subsection*
1598 \begin_layout Description
1599 Action Redoes the last thing undone.
1601 \begin_layout Description
1605 \begin_layout Subsection*
1608 \begin_layout Description
1609 Action Repeat the given command.
1611 \begin_layout Description
1612 Syntax repeat <COUNT> <LFUN-COMMAND>
1614 \begin_layout Description
1615 Origin Andre, 27 Oct 2003
1618 \begin_layout Subsection*
1619 LFUN_CHARS_TRANSPOSE
1621 \begin_layout Description
1622 Action Transposes the character at the cursor with the one before it.
1624 \begin_layout Description
1625 Syntax chars-transpose
1627 \begin_layout Description
1628 Origin Lgb, 25 Apr 2001
1631 \begin_layout Subsection*
1632 LFUN_DEPTH_DECREMENT
1634 \begin_layout Description
1635 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1637 \begin_layout Description
1638 Syntax depth-decrement
1641 \begin_layout Subsection*
1642 LFUN_DEPTH_INCREMENT
1644 \begin_layout Description
1645 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1647 \begin_layout Description
1648 Syntax depth-increment
1651 \begin_layout Subsection*
1654 \begin_layout Description
1655 Action Toggles the bold font (selection-wise) using mathbf in math.
1657 \begin_layout Description
1661 \begin_layout Subsection*
1662 LFUN_FONT_BOLDSYMBOL
1664 \begin_layout Description
1665 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1667 \begin_layout Description
1668 Syntax font-boldsymbol
1671 \begin_layout Subsection*
1672 LFUN_FONT_TYPEWRITER
1674 \begin_layout Description
1675 Action Toggles the typewriter family font (selection-wise).
1677 \begin_layout Description
1678 Syntax font-typewriter
1681 \begin_layout Subsection*
1684 \begin_layout Description
1685 Action Toggles underline in the font (selection-wise).
1687 \begin_layout Description
1688 Syntax font-underline
1691 \begin_layout Subsection*
1694 \begin_layout Description
1695 Action Toggles double underline in the font (selection-wise).
1697 \begin_layout Description
1698 Syntax font-underunderline
1700 \begin_layout Description
1701 Origin sanda, 5 May 2009
1704 \begin_layout Subsection*
1707 \begin_layout Description
1708 Action Toggles wavy underline in the font (selection-wise).
1710 \begin_layout Description
1711 Syntax font-underwave
1713 \begin_layout Description
1714 Origin sanda, 5 May 2009
1717 \begin_layout Subsection*
1720 \begin_layout Description
1721 Action Toggles strikeout (strike-through) in the font (selection-wise).
1723 \begin_layout Description
1724 Syntax font-strikeout
1726 \begin_layout Description
1727 Origin sanda, 3 May 2009
1730 \begin_layout Subsection*
1733 \begin_layout Description
1734 Action Toggles the emphasis font style (selection-wise).
1736 \begin_layout Description
1740 \begin_layout Subsection*
1743 \begin_layout Description
1744 Action Toggles Noun text style font (selection-wise).
1746 \begin_layout Description
1750 \begin_layout Subsection*
1753 \begin_layout Description
1754 Action Toggles Roman family font (selection-wise).
1756 \begin_layout Description
1760 \begin_layout Subsection*
1763 \begin_layout Description
1764 Action Toggles Sans Serif family font (selection-wise).
1766 \begin_layout Description
1770 \begin_layout Subsection*
1773 \begin_layout Description
1774 Action Toggles Fraktur family font (math-mode, selection-wise).
1776 \begin_layout Description
1779 \begin_layout Description
1780 Origin vermeer, 10 Jan 2002
1783 \begin_layout Subsection*
1786 \begin_layout Description
1787 Action Toggles Italics font shape (math-mode, selection-wise).
1789 \begin_layout Description
1792 \begin_layout Description
1793 Origin vermeer, 10 Jan 2002
1796 \begin_layout Subsection*
1799 \begin_layout Description
1800 Action Reverts the settings of the font to the default values (selection-wise).
1802 \begin_layout Description
1806 \begin_layout Subsection*
1809 \begin_layout Description
1810 Action Sets font size according to lyx format string.
1812 \begin_layout Description
1813 Syntax font-size <SIZE>
1815 \begin_layout Description
1816 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1817 \begin_inset Newline newline
1820 largest|huge|giant|increase|decrease|default
1823 \begin_layout Subsection*
1824 LFUN_TEXTSTYLE_APPLY
1826 \begin_layout Description
1827 Action Toggle user-defined (=last-time used) text style.
1829 \begin_layout Description
1830 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1832 \begin_layout Description
1833 Syntax textstyle-apply
1835 \begin_layout Description
1836 Origin leeming, 12 Mar 2003
1839 \begin_layout Subsection*
1840 LFUN_TEXTSTYLE_UPDATE
1842 \begin_layout Description
1843 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1845 \begin_layout Description
1846 Syntax textstyle-update <FONT_INFO>
1848 \begin_layout Description
1849 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1850 \begin_inset Newline newline
1853 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1855 \begin_layout Description
1856 Origin leeming, 12 Mar 2003
1859 \begin_layout Subsection*
1860 LFUN_SCREEN_FONT_UPDATE
1862 \begin_layout Description
1863 Action Update fonts and its metrics.
1865 \begin_layout Description
1866 Notion Automatically called after zoom, dpi, font names, or norm change.
1868 \begin_layout Description
1869 Syntax screen-font-update
1871 \begin_layout Description
1872 Origin ARRae, 13 Aug 2000
1875 \begin_layout Subsection*
1878 \begin_layout Description
1879 Action Returns the info about the current font.
1881 \begin_layout Description
1885 \begin_layout Subsection*
1886 LFUN_CITATION_INSERT
1888 \begin_layout Description
1889 Action Inserts citation from loaded citation database.
1891 \begin_layout Description
1892 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1894 \begin_layout Description
1895 Params <KEY>: Citation (shortcut listed in available citations).
1896 \begin_inset Newline newline
1899 <TEXT_BEFORE>: text which should appear before citation.
1901 \begin_layout Description
1902 Origin AAS, 97-02-23
1905 \begin_layout Subsection*
1906 LFUN_BIBTEX_DATABASE_ADD
1908 \begin_layout Description
1909 Action Adds database, which will be used for bibtex citations.
1911 \begin_layout Description
1912 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1914 \begin_layout Description
1915 Syntax bibtex-database-add <DATABASE-NAME>
1917 \begin_layout Description
1918 Origin Ale, 30 May 1997
1921 \begin_layout Subsection*
1922 LFUN_BIBTEX_DATABASE_DEL
1924 \begin_layout Description
1925 Action Adds database, which will be used for bibtex citations.
1927 \begin_layout Description
1928 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1930 \begin_layout Description
1931 Syntax bibtex-database-del <DATABASE-NAME>
1933 \begin_layout Description
1934 Origin Ale, 30 May 1997
1937 \begin_layout Subsection*
1940 \begin_layout Description
1941 Action Sets the layout (that is, environment) for the current paragraph.
1943 \begin_layout Description
1944 Syntax layout <LAYOUT>
1946 \begin_layout Description
1947 Params <LAYOUT>: the layout to use
1950 \begin_layout Subsection*
1951 LFUN_LAYOUT_PARAGRAPH
1953 \begin_layout Description
1954 Action Launches the paragraph settings dialog.
1956 \begin_layout Description
1957 Syntax layout-paragraph
1960 \begin_layout Subsection*
1963 \begin_layout Description
1964 Action Launches the tabular settings dialog.
1966 \begin_layout Description
1967 Syntax layout-tabular
1969 \begin_layout Description
1970 Origin Jug, 31 Jul 2000
1973 \begin_layout Subsection*
1974 LFUN_DROP_LAYOUTS_CHOICE
1976 \begin_layout Description
1977 Action Displays list of layout choices.
1979 \begin_layout Description
1980 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
1982 \begin_layout Description
1983 Syntax drop-layouts-choice
1986 \begin_layout Subsection*
1987 LFUN_LAYOUT_MODULES_CLEAR
1989 \begin_layout Description
1990 Action Clears the module list.
1992 \begin_layout Description
1993 Notion Clears the list of included modules for the current buffer.
1995 \begin_layout Description
1996 Syntax layout-modules-clear
1998 \begin_layout Description
1999 Origin rgh, 25 August 2007
2002 \begin_layout Subsection*
2003 LFUN_LAYOUT_MODULE_ADD
2005 \begin_layout Description
2006 Action Adds a module.
2008 \begin_layout Description
2009 Notion Adds a module to the list of included modules for the current buffer.
2011 \begin_layout Description
2012 Syntax layout-module-add <MODULE>
2014 \begin_layout Description
2015 Params <MODULE>: the module to be added
2017 \begin_layout Description
2018 Origin rgh, 25 August 2007
2021 \begin_layout Subsection*
2024 \begin_layout Description
2025 Action Reloads layout information.
2027 \begin_layout Description
2028 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.
2030 \begin_layout Description
2031 Syntax layout-reload
2033 \begin_layout Description
2034 Origin rgh, 3 September 2007
2037 \begin_layout Subsection*
2038 LFUN_TEXTCLASS_APPLY
2040 \begin_layout Description
2041 Action Sets the text class for the current buffer.
2043 \begin_layout Description
2044 Syntax textclass-apply <TEXTCLASS>
2046 \begin_layout Description
2047 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2050 \begin_layout Subsection*
2053 \begin_layout Description
2054 Action Loads information for a textclass from disk.
2056 \begin_layout Description
2057 Syntax textclass-load <TEXTCLASS>
2059 \begin_layout Description
2060 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2063 \begin_layout Subsection*
2066 \begin_layout Description
2067 Action Disable selecting of text-region.
2069 \begin_layout Description
2073 \begin_layout Subsection*
2076 \begin_layout Description
2077 Action Enable selecting of text-region.
2079 \begin_layout Description
2080 Notion After enabling you can simply move arrow keys to get selected region.
2082 \begin_layout Description
2086 \begin_layout Subsection*
2089 \begin_layout Description
2090 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2092 \begin_layout Description
2095 \begin_layout Description
2096 Origin Andre, May 5 2006
2099 \begin_layout Subsection*
2102 \begin_layout Description
2103 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2105 \begin_layout Description
2106 Syntax math-delim [<LEFT>] [<RIGHT>]
2108 \begin_layout Description
2109 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.
2111 \begin_layout Description
2112 Sample math-delim { rangle
2114 \begin_layout Description
2115 Origin Alejandro, 18 Jun 1996
2118 \begin_layout Subsection*
2121 \begin_layout Description
2122 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2124 \begin_layout Description
2125 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2127 \begin_layout Description
2128 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2129 \begin_inset Newline newline
2132 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2134 \begin_layout Description
2135 Sample math-bigdelim "Bigl" "
2141 \begin_layout Description
2142 Origin Enrico & Georg, 7 May 2006
2145 \begin_layout Subsection*
2148 \begin_layout Description
2149 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2151 \begin_layout Description
2152 Syntax math-display [<ARG>]
2154 \begin_layout Description
2155 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2157 \begin_layout Description
2158 Origin Alejandro, 18 Jun 1996
2161 \begin_layout Subsection*
2164 \begin_layout Description
2165 Action Inserts math objects and symbols.
2167 \begin_layout Description
2168 Syntax math-insert <ARG>
2170 \begin_layout Description
2171 Params <ARG>: Symbol or LaTeX code to be inserted.
2174 \begin_layout Subsection*
2177 \begin_layout Description
2178 Action Enters subscript expression in math expression.
2180 \begin_layout Description
2181 Syntax math-subscript
2183 \begin_layout Description
2184 Origin vermeer, 12 Dec 2001
2187 \begin_layout Subsection*
2188 LFUN_MATH_SUPERSCRIPT
2190 \begin_layout Description
2191 Action Enters subscript expression in math expression.
2193 \begin_layout Description
2194 Syntax math-superscript
2196 \begin_layout Description
2197 Origin vermeer, 12 Dec 2001
2200 \begin_layout Subsection*
2203 \begin_layout Description
2204 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.
2206 \begin_layout Description
2207 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2209 \begin_layout Description
2210 Syntax math-limits [<STATE>]
2212 \begin_layout Description
2213 Params <STATE>: limits|nolimits
2216 \begin_layout Subsection*
2219 \begin_layout Description
2220 Action Inserts a math macro definition at the cursor position in the text.
2222 \begin_layout Description
2223 Syntax math-macro <NAME> [<NARGS>] [def]
2225 \begin_layout Description
2226 Params <NAME>: The name of the macro, e.g. "mymacro".
2227 \begin_inset Newline newline
2230 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2232 \begin_layout Description
2233 Origin ale, 10 May 1997; sts, 21 Dec 2007
2236 \begin_layout Subsection*
2239 \begin_layout Description
2240 Action Mutates the type of math inset to the newly selected one.
2242 \begin_layout Description
2243 Syntax math-mutate <TYPE>
2245 \begin_layout Description
2246 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2248 \begin_layout Description
2249 Origin Andre, 23 May 2001
2252 \begin_layout Subsection*
2255 \begin_layout Description
2256 Action Inserts space into math expression.
2258 \begin_layout Description
2259 Notion Use spacebar after entering this space to change type of space.
2261 \begin_layout Description
2262 Syntax math-space [<TYPE>] [<LEN>]
2264 \begin_layout Description
2265 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2266 \begin_inset Newline newline
2269 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2270 \begin_inset Newline newline
2273 custom space: hspace
2274 \begin_inset Newline newline
2277 "," used by default.
2278 \begin_inset Newline newline
2281 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2282 \begin_inset Newline newline
2285 <LEN>: length for custom spaces (hspace)
2287 \begin_layout Description
2288 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2291 \begin_layout Subsection*
2294 \begin_layout Description
2295 Action Inserts a matrix.
2297 \begin_layout Description
2298 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2300 \begin_layout Description
2301 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).
2303 \begin_layout Description
2304 Sample math-matrix 3 3 bccc
2307 \begin_layout Subsection*
2310 \begin_layout Description
2311 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.
2313 \begin_layout Description
2314 Notion If there is some selected text, it puts the text inside created math box.
2316 \begin_layout Description
2317 Syntax math-mode [<ARG>]
2319 \begin_layout Description
2320 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2322 \begin_layout Description
2323 Origin Alejandro, 4 Jun 1996
2326 \begin_layout Subsection*
2329 \begin_layout Description
2330 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2332 \begin_layout Description
2333 Notion If there is any selected text, then it is moved inside the created regexp inset.
2335 \begin_layout Description
2336 Syntax regexp-mode [<ARG>]
2338 \begin_layout Description
2339 Params <ARG>: eventual argument (regular expression).
2341 \begin_layout Description
2342 Origin Tommaso, 4 Oct 2008
2345 \begin_layout Subsection*
2346 LFUN_MATH_NUMBER_LINE_TOGGLE
2348 \begin_layout Description
2349 Action Toggles numbering of the current formula line.
2351 \begin_layout Description
2352 Notion Must be in display formula mode.
2354 \begin_layout Description
2355 Syntax math-number-line-toggle
2357 \begin_layout Description
2358 Origin Alejandro, 18 Jun 1996
2361 \begin_layout Subsection*
2362 LFUN_MATH_NUMBER_TOGGLE
2364 \begin_layout Description
2365 Action Toggles numbering/labeling of the current formula.
2367 \begin_layout Description
2368 Notion Must be in display formula mode.
2370 \begin_layout Description
2371 Syntax math-number-toggle
2373 \begin_layout Description
2374 Origin Alejandro, 4 Jun 1996
2377 \begin_layout Subsection*
2380 \begin_layout Description
2381 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2383 \begin_layout Description
2384 Notion Selection can be used to determine the input for the external program.
2386 \begin_layout Description
2387 Syntax math-extern <LANG> [<COMMAND>]
2389 \begin_layout Description
2390 Params <LANG>: octave|maxima|maple|mathematica|script
2391 \begin_inset Newline newline
2394 where "script" stands fot the external script (normalized expression will be passed)
2396 \begin_layout Description
2397 Sample math-extern maple simplify
2399 \begin_layout Description
2400 Origin Andre, 24 Apr 2001
2403 \begin_layout Subsection*
2406 \begin_layout Description
2407 Action Changes arbitrarily the size used by math fonts inside a context.
2409 \begin_layout Description
2410 Notion Provides an interface to the LaTeX math mode font size commands.
2412 \begin_layout Description
2413 Syntax math-size <STYLE>
2415 \begin_layout Description
2426 \begin_layout Description
2427 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2430 \begin_layout Subsection*
2431 LFUN_MATH_FONT_STYLE
2433 \begin_layout Description
2434 Action Changes the text style used in math.
2436 \begin_layout Description
2437 Syntax math-font-style <STYLE>
2439 \begin_layout Description
2440 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2442 \begin_layout Description
2443 Origin vfr, 9 jan 2009
2446 \begin_layout Subsection*
2447 LFUN_MATH_MACRO_UNFOLD
2449 \begin_layout Description
2450 Action Unfold a Math Macro.
2452 \begin_layout Description
2453 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2457 \begin_layout Description
2458 Syntax math-macro-unfold
2460 \begin_layout Description
2461 Origin sts, 06 January 2008
2464 \begin_layout Subsection*
2465 LFUN_MATH_MACRO_FOLD
2467 \begin_layout Description
2468 Action Fold a Math Macro.
2470 \begin_layout Description
2471 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2475 \begin_layout Description
2476 Syntax math-macro-fold
2478 \begin_layout Description
2479 Origin sts, 06 January 2008
2482 \begin_layout Subsection*
2483 LFUN_MATH_MACRO_ADD_PARAM
2485 \begin_layout Description
2486 Action Add a parameter.
2488 \begin_layout Description
2489 Notion Add a parameter to a Math Macro.
2491 \begin_layout Description
2492 Syntax math-macro-add-param <NUM>
2494 \begin_layout Description
2495 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.
2497 \begin_layout Description
2498 Origin sts, 06 January 2008
2501 \begin_layout Subsection*
2502 LFUN_MATH_MACRO_REMOVE_PARAM
2504 \begin_layout Description
2505 Action Remove the last parameter.
2507 \begin_layout Description
2508 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2510 \begin_layout Description
2511 Syntax math-macro-remove-param <NUM>
2513 \begin_layout Description
2514 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2516 \begin_layout Description
2517 Origin sts, 06 January 2008
2520 \begin_layout Subsection*
2521 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2523 \begin_layout Description
2524 Action Append a greedy parameter.
2526 \begin_layout Description
2527 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2529 \begin_layout Description
2530 Syntax math-macro-append-greedy-param
2532 \begin_layout Description
2533 Origin sts, 06 January 2008
2536 \begin_layout Subsection*
2537 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2539 \begin_layout Description
2540 Action Remove a greedy parameter.
2542 \begin_layout Description
2543 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.
2545 \begin_layout Description
2546 Syntax math-macro-remove-greedy-param
2548 \begin_layout Description
2549 Origin sts, 06 January 2008
2552 \begin_layout Subsection*
2553 LFUN_MATH_MACRO_MAKE_OPTIONAL
2555 \begin_layout Description
2556 Action Make a parameter optional.
2558 \begin_layout Description
2559 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2561 \begin_layout Description
2562 Syntax math-macro-make-optional
2564 \begin_layout Description
2565 Origin sts, 06 January 2008
2568 \begin_layout Subsection*
2569 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2571 \begin_layout Description
2572 Action Make a parameter non-optional.
2574 \begin_layout Description
2575 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.
2577 \begin_layout Description
2578 Syntax math-macro-make-nonoptional
2580 \begin_layout Description
2581 Origin sts, 06 January 2008
2584 \begin_layout Subsection*
2585 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2587 \begin_layout Description
2588 Action Add an optional parameter.
2590 \begin_layout Description
2591 Notion Insert an optional parameter just behind the already existing optional parameters.
2593 \begin_layout Description
2594 Syntax math-macro-add-optional-param
2596 \begin_layout Description
2597 Origin sts, 06 January 2008
2600 \begin_layout Subsection*
2601 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2603 \begin_layout Description
2604 Action Remove the last optional parameter.
2606 \begin_layout Description
2607 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2609 \begin_layout Description
2610 Syntax math-macro-remove-optional-param
2612 \begin_layout Description
2613 Origin sts, 06 January 2008
2616 \begin_layout Subsection*
2617 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2619 \begin_layout Description
2620 Action Add a greedy optional parameter.
2622 \begin_layout Description
2623 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2625 \begin_layout Description
2626 Syntax math-macro-add-greedy-optional-param
2628 \begin_layout Description
2629 Origin sts, 06 January 2008
2632 \begin_layout Subsection*
2633 LFUN_IN_MATHMACROTEMPLATE
2635 \begin_layout Description
2636 Action Only active in Math Macro definition.
2638 \begin_layout Description
2639 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.
2641 \begin_layout Description
2642 Syntax in-mathmacrotemplate
2644 \begin_layout Description
2645 Origin sts, 06 January 2008
2648 \begin_layout Subsection*
2649 LFUN_PARAGRAPH_MOVE_DOWN
2651 \begin_layout Description
2652 Action Moves the current paragraph downwards in the document.
2654 \begin_layout Description
2655 Syntax paragraph-move-down
2657 \begin_layout Description
2658 Origin Edwin, 8 Apr 2006
2661 \begin_layout Subsection*
2662 LFUN_PARAGRAPH_MOVE_UP
2664 \begin_layout Description
2665 Action Moves the current paragraph upwards in the document.
2667 \begin_layout Description
2668 Syntax paragraph-move-up
2670 \begin_layout Description
2671 Origin Edwin, 8 Apr 2006
2674 \begin_layout Subsection*
2677 \begin_layout Description
2678 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2680 \begin_layout Description
2683 \begin_layout Description
2684 Origin Asger, 1 Oct 1996
2687 \begin_layout Subsection*
2688 LFUN_PARAGRAPH_UP_SELECT
2690 \begin_layout Description
2691 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2693 \begin_layout Description
2694 Syntax paragraph-up-select
2696 \begin_layout Description
2697 Origin Asger, 1 Oct 1996
2700 \begin_layout Subsection*
2703 \begin_layout Description
2704 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2706 \begin_layout Description
2707 Syntax paragraph-down
2709 \begin_layout Description
2710 Origin Asger, 1 Oct 1996
2713 \begin_layout Subsection*
2714 LFUN_PARAGRAPH_DOWN_SELECT
2716 \begin_layout Description
2717 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2719 \begin_layout Description
2720 Syntax paragraph-down-select
2722 \begin_layout Description
2723 Origin Asger, 1 Oct 1996
2726 \begin_layout Subsection*
2729 \begin_layout Description
2730 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2732 \begin_layout Description
2733 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).
2735 \begin_layout Description
2736 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2738 \begin_layout Description
2739 Params <PAR_ID_NUMBER>: paragraph id
2740 \begin_inset Newline newline
2743 <POSITION_IN_PAR>: desired position within the paragraph
2745 \begin_layout Description
2746 Origin Dekel, 26 Aug 2000
2749 \begin_layout Subsection*
2750 LFUN_BREAK_PARAGRAPH
2752 \begin_layout Description
2753 Action Breaks the current paragraph at the current location.
2755 \begin_layout Description
2756 Syntax break-paragraph
2759 \begin_layout Subsection*
2760 LFUN_BREAK_PARAGRAPH
2762 \begin_layout Description
2763 Action Breaks the current paragraph at the current location.
2765 \begin_layout Description
2766 Notion Removes the selection.
2768 \begin_layout Description
2769 Syntax break-paragraph [<LAYOUT>]
2771 \begin_layout Description
2772 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2775 \begin_layout Subsection*
2776 LFUN_PARAGRAPH_PARAMS
2778 \begin_layout Description
2779 Action Change paragraph settings.
2781 \begin_layout Description
2782 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.
2784 \begin_layout Description
2785 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2787 \begin_layout Description
2797 \begin_inset Newline newline
2802 paragraph_spacing default|single|onehalf|double|other
2803 \begin_inset Newline newline
2808 align block|left|right|center|default
2809 \begin_inset Newline newline
2814 labelwidthstring WIDTH|
2818 \begin_layout Description
2819 Origin rgh, Aug 15 2007
2822 \begin_layout Subsection*
2823 LFUN_PARAGRAPH_PARAMS_APPLY
2825 \begin_layout Description
2826 Action Change paragraph settings.
2828 \begin_layout Description
2829 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2831 \begin_layout Description
2832 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2834 \begin_layout Description
2835 Params For parameters see LFUN_PARAGRAPH_PARAMS
2837 \begin_layout Description
2838 Origin leeming, 30 Mar 2004
2841 \begin_layout Subsection*
2842 LFUN_PARAGRAPH_UPDATE
2844 \begin_layout Description
2845 Action Updates the values inside the paragraph dialog from the paragraph.
2847 \begin_layout Description
2848 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2850 \begin_layout Description
2851 Origin leeming, 13 Mar 2003
2854 \begin_layout Subsection*
2857 \begin_layout Description
2858 Action Move the current group in the upward direction in the structure of the document.
2860 \begin_layout Description
2861 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2863 \begin_layout Description
2866 \begin_layout Description
2867 Origin Vermeer, 23 Mar 2006
2870 \begin_layout Subsection*
2873 \begin_layout Description
2874 Action Move the current group in the downward direction in the structure of the document.
2876 \begin_layout Description
2877 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2879 \begin_layout Description
2882 \begin_layout Description
2883 Origin Vermeer, 23 Mar 2006
2886 \begin_layout Subsection*
2889 \begin_layout Description
2890 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2892 \begin_layout Description
2893 Notion Part -> Chapter -> Section -> etc.
2895 \begin_layout Description
2898 \begin_layout Description
2899 Origin Vermeer, 23 Mar 2006
2902 \begin_layout Subsection*
2905 \begin_layout Description
2906 Action Moves the current group in the upward direction in the hierarchy of the document structure.
2908 \begin_layout Description
2909 Notion Part <- Chapter <- Section <- etc.
2911 \begin_layout Description
2914 \begin_layout Description
2915 Origin Vermeer, 23 Mar 2006
2918 \begin_layout Subsection*
2921 \begin_layout Description
2922 Action Edit the inset at cursor with an external application, if one is attributed.
2924 \begin_layout Description
2925 Syntax inset-edit [<INSET_PARAMS>]
2927 \begin_layout Description
2928 Params <INSET_PARAMS>: Parameters for the inset.
2929 \begin_inset Newline newline
2932 Currently only the filename will be considered.
2934 \begin_layout Description
2935 Origin JSpitzm, 27 Apr 2006
2938 \begin_layout Subsection*
2941 \begin_layout Description
2942 Action Inserts table into the document.
2944 \begin_layout Description
2945 Syntax tabular-insert [<ROWS> <COLUMNS>]
2947 \begin_layout Description
2948 Params In case no arguments are given show insert dialog.
2950 \begin_layout Description
2951 Origin Jug, 12 Apr 2000
2954 \begin_layout Subsection*
2955 LFUN_TABULAR_FEATURE
2957 \begin_layout Description
2958 Action Sets various features to the table/cell on the current cursor position.
2960 \begin_layout Description
2961 Notion Various math-environment features are handled here as well, e.g. add-vline-left/right for the Grid/Array environment
2963 \begin_layout Description
2964 Syntax tabular-feature <FEATURE> [<ARG>]
2966 \begin_layout Description
2967 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
2968 \begin_inset Newline newline
2971 <ARG>: additional argument for some commands, use debug mode to explore its values.
2973 \begin_layout Description
2974 Origin Jug, 28 Jul 2000
2977 \begin_layout Subsection*
2980 \begin_layout Description
2981 Action Moves the cursor to the previous cell inside the table.
2983 \begin_layout Description
2984 Syntax cell-backward
2986 \begin_layout Description
2987 Origin Jug, 22 May 2000
2990 \begin_layout Subsection*
2993 \begin_layout Description
2994 Action Moves the cursor to the next cell inside the table.
2996 \begin_layout Description
3000 \begin_layout Subsection*
3003 \begin_layout Description
3004 Action Splits cell and shifts right part to the next cell (inside the math grid).
3006 \begin_layout Description
3009 \begin_layout Description
3010 Origin Ale, 15 May 1997
3013 \begin_layout Subsection*
3016 \begin_layout Description
3017 Action Register the document as an file inside version control system (RCS, CVS).
3019 \begin_layout Description
3020 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3021 \begin_inset Newline newline
3024 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3026 \begin_layout Description
3029 \begin_layout Description
3030 Origin Lgb, 1 Jul 1997
3033 \begin_layout Subsection*
3036 \begin_layout Description
3037 Action Checks-in/commits the changes of the registered file to the repository.
3039 \begin_layout Description
3040 Notion In RCS case this also unlocks the file.
3042 \begin_layout Description
3045 \begin_layout Description
3046 Origin Lgb, 1 Jul 1997
3049 \begin_layout Subsection*
3052 \begin_layout Description
3053 Action Checks-out the document for edit (and locks it for RCS).
3055 \begin_layout Description
3056 Notion This is implemented only for RCS and SVN, not CVS.
3058 \begin_layout Description
3061 \begin_layout Description
3062 Origin Lgb, 1 Jul 1997
3065 \begin_layout Subsection*
3068 \begin_layout Description
3069 Action Reverts the document to the last check-in/commit in VCS.
3071 \begin_layout Description
3074 \begin_layout Description
3075 Origin Lgb, 1 Jul 1997
3078 \begin_layout Subsection*
3081 \begin_layout Description
3082 Action Undo last check-in.
3084 \begin_layout Description
3085 Notion This is currently implemented only for RCS.
3087 \begin_layout Description
3090 \begin_layout Description
3091 Origin Lgb, 1 Jul 1997
3094 \begin_layout Subsection*
3097 \begin_layout Description
3098 Action Executes external command. This command is intended to support additional VCS commands.
3100 \begin_layout Description
3101 Syntax vc-command <FLAG> <PATH> <COMMAND>
3103 \begin_layout Description
3104 Params <FLAG>: Flags for the command can be combined together.
3105 \begin_inset Newline newline
3108 U - dUmmy - no flags
3109 \begin_inset Newline newline
3112 D - Doc - need document loaded to proceed
3113 \begin_inset Newline newline
3116 I - dIrty - mark document dirty
3117 \begin_inset Newline newline
3120 R - Reload - ensure that the document is saved and reload it after command execution
3121 \begin_inset Newline newline
3124 M - Message - ask for input string (commit message)
3125 \begin_inset Newline newline
3128 <PATH>: path where to start. $$p will be replaced by the current document path.
3129 \begin_inset Newline newline
3132 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
3134 \begin_layout Description
3135 Sample vc-command DR $$p "svn up"
3137 \begin_layout Description
3138 Origin sanda, 13 Jan 2009
3141 \begin_layout Subsection*
3144 \begin_layout Description
3145 Action Toggles change tracking to on/off.
3147 \begin_layout Description
3148 Syntax changes-track
3150 \begin_layout Description
3151 Origin levon, 1 Oct 2002
3154 \begin_layout Subsection*
3157 \begin_layout Description
3158 Action Toggles showing of change tracking in typesetted output.
3160 \begin_layout Description
3161 Syntax changes-output
3163 \begin_layout Description
3164 Origin jspitzm, 21 Jan 2005
3167 \begin_layout Subsection*
3170 \begin_layout Description
3171 Action Moves the cursor to the position of the next change of the change tracking records.
3173 \begin_layout Description
3176 \begin_layout Description
3177 Origin schmitt, 4 Oct 2006
3180 \begin_layout Subsection*
3181 LFUN_CHANGE_PREVIOUS
3183 \begin_layout Description
3184 Action Moves the cursor to the position of the previous change of the change tracking records.
3186 \begin_layout Description
3187 Syntax change-previous
3189 \begin_layout Description
3190 Origin vfr, 4 Apr 2009
3193 \begin_layout Subsection*
3196 \begin_layout Description
3197 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3199 \begin_layout Description
3200 Syntax changes-merge
3202 \begin_layout Description
3203 Origin Levon, 16 Oct 2002
3206 \begin_layout Subsection*
3209 \begin_layout Description
3210 Action Accepts tracked change inside the selection.
3212 \begin_layout Description
3213 Syntax change-accept
3215 \begin_layout Description
3216 Origin Levon, 16 Oct 2002
3219 \begin_layout Subsection*
3222 \begin_layout Description
3223 Action Rejects tracked change inside the selection.
3225 \begin_layout Description
3226 Syntax change-accept
3228 \begin_layout Description
3229 Origin Levon, 16 Oct 2002
3232 \begin_layout Subsection*
3233 LFUN_ALL_CHANGES_ACCEPT
3235 \begin_layout Description
3236 Action Accepts all tracked changes in the document.
3238 \begin_layout Description
3239 Syntax all-changes-accept
3241 \begin_layout Description
3242 Origin Levon, 16 Oct 2002
3245 \begin_layout Subsection*
3246 LFUN_ALL_CHANGES_REJECT
3248 \begin_layout Description
3249 Action Rejects all tracked changes in the document.
3251 \begin_layout Description
3252 Notion Reject does not work recursively; the user may have to repeat the operation.
3254 \begin_layout Description
3255 Syntax all-changes-reject
3257 \begin_layout Description
3258 Origin Levon, 16 Oct 2002
3261 \begin_layout Subsection*
3264 \begin_layout Description
3265 Action Apply data for an inset.
3267 \begin_layout Description
3268 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.
3270 \begin_layout Description
3271 Syntax inset-apply <ARGS>
3273 \begin_layout Description
3274 Params See LFUN_INSET_INSERT .
3277 \begin_layout Subsection*
3280 \begin_layout Description
3281 Action Dissolve the current inset into text.
3283 \begin_layout Description
3284 Syntax inset-dissolve [<INSET>]
3286 \begin_layout Description
3287 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.
3288 \begin_inset Newline newline
3291 For values see lyx::InsetLayout::lyxtype_ .
3293 \begin_layout Description
3294 Origin JSpitz, 7 Aug 2006
3297 \begin_layout Subsection*
3300 \begin_layout Description
3301 Action Insert new inset (type given by the parameters).
3303 \begin_layout Description
3304 Syntax inset-insert <INSET> <ARGS>
3306 \begin_layout Description
3307 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|include|index|label|nomencl|vspace|ref|toc>
3308 \begin_inset Newline newline
3311 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3313 \begin_layout Description
3314 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3317 \begin_inset Newline newline
3320 where <label name> is the name of the referenced label and <Format> is one of the following:
3321 \begin_inset Newline newline
3325 \begin_inset Newline newline
3328 eqref -- (<reference>)
3329 \begin_inset Newline newline
3333 \begin_inset Newline newline
3336 vpageref -- on <page>
3337 \begin_inset Newline newline
3340 vref -- <reference> on <page>
3341 \begin_inset Newline newline
3344 prettyref -- Formatted reference
3347 \begin_layout Subsection*
3350 \begin_layout Description
3351 Action Modify existing inset.
3353 \begin_layout Description
3354 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3356 \begin_layout Description
3357 Syntax inset-modify <INSET> <ARGS>
3359 \begin_layout Description
3360 Params See LFUN_INSET_INSERT for further details.
3363 \begin_layout Subsection*
3364 LFUN_NEXT_INSET_MODIFY
3366 \begin_layout Description
3367 Action Modify the inset at cursor position, if there is one.
3369 \begin_layout Description
3370 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3372 \begin_layout Description
3373 Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
3375 \begin_layout Description
3376 Params See LFUN_INSET_INSERT for further details.
3378 \begin_layout Description
3379 Origin JSpitzm, 23 Mar 2008
3382 \begin_layout Subsection*
3383 LFUN_INSET_DIALOG_UPDATE
3385 \begin_layout Description
3386 Action Updates the values inside the dialog from the inset.
3388 \begin_layout Description
3389 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3391 \begin_layout Description
3392 Params <DIALOG-NAME>
3394 \begin_layout Description
3395 Origin leeming, 25 Feb 2003
3398 \begin_layout Subsection*
3401 \begin_layout Description
3402 Action Open the inset's properties dialog.
3404 \begin_layout Description
3405 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.
3407 \begin_layout Description
3408 Syntax inset-settings <INSET>
3410 \begin_layout Description
3411 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>.
3414 \begin_layout Subsection*
3417 \begin_layout Description
3418 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3420 \begin_layout Description
3421 Syntax inset-toggle [<ARG>]
3423 \begin_layout Description
3424 Params <ARG>: <open|close|toggle|assign>.
3425 \begin_inset Newline newline
3428 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3429 \begin_inset Newline newline
3432 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3434 \begin_layout Description
3435 Origin lasgouttes, 19 Jul 2001
3438 \begin_layout Subsection*
3439 LFUN_ALL_INSETS_TOGGLE
3441 \begin_layout Description
3442 Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
3444 \begin_layout Description
3445 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
3447 \begin_layout Description
3448 Syntax all-insets-toggle [<STATE>] [<INSET>]
3450 \begin_layout Description
3451 Params <STATE>: <toggle|open|close|assign> default: toggle
3452 \begin_inset Newline newline
3455 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
3457 \begin_layout Description
3458 Origin leeming, 30 Mar 2004
3461 \begin_layout Subsection*
3462 LFUN_SET_GRAPHICS_GROUP
3464 \begin_layout Description
3465 Action Set the group for the graphics inset on the cursor position.
3467 \begin_layout Description
3468 Syntax set-graphics-group [<GROUP>]
3470 \begin_layout Description
3471 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3473 \begin_layout Description
3474 Origin sanda, 6 May 2008
3477 \begin_layout Subsection*
3478 LFUN_FINISHED_FORWARD
3480 \begin_layout Description
3481 Action Moves the cursor out of the current slice, going forward.
3483 \begin_layout Description
3484 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.
3487 \begin_layout Subsection*
3488 LFUN_FINISHED_BACKWARD
3490 \begin_layout Description
3491 Action Moves the cursor out of the current slice, going backwards.
3493 \begin_layout Description
3494 Notion See also LFUN_FINISHED_FORWARD.
3497 \begin_layout Subsection*
3500 \begin_layout Description
3501 Action Moves the cursor out of the current slice, going right.
3503 \begin_layout Description
3504 Notion See also LFUN_FINISHED_FORWARD
3507 \begin_layout Subsection*
3510 \begin_layout Description
3511 Action Moves the cursor out of the current slice, going left.
3513 \begin_layout Description
3514 Notion See also LFUN_FINISHED_FORWARD.
3517 \begin_layout Subsection*
3520 \begin_layout Description
3521 Action Set language from the current cursor position.
3523 \begin_layout Description
3524 Syntax language <LANG>
3526 \begin_layout Description
3527 Params <LANG>: Requested language. Look in lib/languages for the list.
3529 \begin_layout Description
3530 Origin Dekel, 2 Mar 2000
3533 \begin_layout Subsection*
3536 \begin_layout Description
3537 Action Goto a label.
3539 \begin_layout Description
3540 Syntax label-goto [<LABEL>]
3542 \begin_layout Description
3543 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.
3545 \begin_layout Description
3546 Origin Ale, 6 Aug 1997
3549 \begin_layout Subsection*
3552 \begin_layout Description
3553 Action Inserts label to text or displayed formula.
3555 \begin_layout Description
3556 Syntax label-insert [<LABEL>]
3558 \begin_layout Description
3559 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3562 \begin_layout Subsection*
3565 \begin_layout Description
3566 Action Go to the next label or cross-reference.
3568 \begin_layout Description
3569 Syntax reference-next
3571 \begin_layout Description
3572 Origin Dekel, 14 Jan 2001
3575 \begin_layout Subsection*
3578 \begin_layout Description
3579 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3581 \begin_layout Description
3582 Notion Bookmark 0 has a special purpose. It is automatically set
3583 \begin_inset Newline newline
3586 1. to the paragraph you are currently editing
3587 \begin_inset Newline newline
3590 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3591 \begin_inset Newline newline
3594 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3596 \begin_layout Description
3597 Syntax bookmark-goto <NUMBER>
3599 \begin_layout Description
3600 Params <NUMBER>: the number of the bookmark to restore.
3602 \begin_layout Description
3603 Origin Dekel, 27 January 2001
3606 \begin_layout Subsection*
3609 \begin_layout Description
3610 Action Save a bookmark.
3612 \begin_layout Description
3613 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.
3615 \begin_layout Description
3616 Syntax bookmark-save <NUMBER>
3618 \begin_layout Description
3619 Params <NUMBER>: the number of the bookmark to save.
3621 \begin_layout Description
3622 Origin Dekel, 27 January 2001
3625 \begin_layout Subsection*
3628 \begin_layout Description
3629 Action Clears the list of saved bookmarks.
3631 \begin_layout Description
3632 Syntax bookmark-clear
3634 \begin_layout Description
3635 Origin bpeng, 31 October 2006
3638 \begin_layout Subsection*
3641 \begin_layout Description
3642 Action Open the given help file according to the language setting.
3644 \begin_layout Description
3645 Syntax help-open <FILE>[.lyx]
3647 \begin_layout Description
3648 Params <FILE>: any document from (/usr/share/)doc directory.
3650 \begin_layout Description
3651 Origin Jug, 27 Jun 1999
3654 \begin_layout Subsection*
3657 \begin_layout Description
3658 Action Terminates the current LyX instance.
3660 \begin_layout Description
3661 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3663 \begin_layout Description
3667 \begin_layout Subsection*
3670 \begin_layout Description
3671 Action Toggles visibility of a given toolbar between on/off/auto.
3673 \begin_layout Description
3674 Notion Skiping "auto" when allowauto is false.
3676 \begin_layout Description
3677 Syntax toolbar-toggle <NAME> [allowauto]
3679 \begin_layout Description
3680 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
3682 \begin_layout Description
3683 Origin Edwin, 21 May 2007
3686 \begin_layout Subsection*
3689 \begin_layout Description
3690 Action Opens the menu given by its name.
3692 \begin_layout Description
3693 Syntax menu-open <NAME>
3695 \begin_layout Description
3696 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3699 \begin_layout Subsection*
3702 \begin_layout Description
3703 Action Various UI visibility-toggling actions.
3705 \begin_layout Description
3706 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3708 \begin_layout Description
3709 Params statusbar : Toggle visibility of the statusbar.
3710 \begin_inset Newline newline
3713 menubar : Toggle visibility of the menubar.
3714 \begin_inset Newline newline
3717 scrollbar : Toggle visibility of the scrollbar.
3718 \begin_inset Newline newline
3721 frame : Toggle visibility of the frames around editing window.
3722 \begin_inset Newline newline
3725 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.
3727 \begin_layout Description
3728 Origin sanda, 9 Feb 2007
3731 \begin_layout Subsection*
3734 \begin_layout Description
3735 Action Creates new empty LyX window.
3737 \begin_layout Description
3738 Notion Already opened documents from the previous window can be found under View menu.
3740 \begin_layout Description
3741 Syntax window-new [<GEOMETRY>]
3743 \begin_layout Description
3744 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3746 \begin_layout Description
3747 Origin Abdel, 21 Oct 2006
3750 \begin_layout Subsection*
3753 \begin_layout Description
3754 Action Closes the current LyX window.
3756 \begin_layout Description
3759 \begin_layout Description
3760 Origin Abdel, 23 Oct 2006
3763 \begin_layout Subsection*
3766 \begin_layout Description
3767 Action Creates another split view of current buffer.
3769 \begin_layout Description
3770 Notion All split views act in the same way indpendently.
3772 \begin_layout Description
3773 Syntax split-view <vertical|horizontal>
3775 \begin_layout Description
3776 Params horizontal : The work areas are laid out side by side.
3777 \begin_inset Newline newline
3780 vertical : The work areas laid out vertically.
3782 \begin_layout Description
3783 Origin Abdel, 20 Feb 2008
3786 \begin_layout Subsection*
3787 LFUN_CLOSE_TAB_GROUP
3789 \begin_layout Description
3790 Action Close the current tab group.
3792 \begin_layout Description
3793 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
3795 \begin_layout Description
3796 Syntax close-tab-group
3798 \begin_layout Description
3799 Origin Abdel, 21 Feb 2008
3802 \begin_layout Subsection*
3805 \begin_layout Description
3806 Action Shows hidden dialog or create new one for a given function/inset settings etc.
3808 \begin_layout Description
3809 Syntax dialog-show <NAME> [<DATA>]
3811 \begin_layout Description
3812 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
3813 \begin_inset Newline newline
3816 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
3817 \begin_inset Newline newline
3820 href|include|index|index_print|info|nomenclature|label|listings|log|mathdelimiter|
3821 \begin_inset Newline newline
3824 mathmatrix|mathspace|note|paragraph|phantom|prefs|print|ref|sendto|space|
3825 \begin_inset Newline newline
3828 spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|
3829 \begin_inset Newline newline
3832 view-source|vspace|wrap|<SPECIAL>
3833 \begin_inset Newline newline
3836 <SPECIAL>: latexlog|vclog
3837 \begin_inset Newline newline
3840 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
3842 \begin_layout Description
3843 Origin leeming, 17 Jun 2003
3846 \begin_layout Subsection*
3847 LFUN_DIALOG_SHOW_NEW_INSET
3849 \begin_layout Description
3850 Action Shows hidden dialog or create new one for a given inset settings etc.
3852 \begin_layout Description
3853 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
3855 \begin_layout Description
3856 Syntax dialog-show-new-inset <NAME> [<DATA>]
3858 \begin_layout Description
3859 Params See LFUN_DIALOG_SHOW .
3861 \begin_layout Description
3862 Origin leeming, 25 Feb 2003
3865 \begin_layout Subsection*
3868 \begin_layout Description
3869 Action Updates the dialog values from the inset/paragraph/document.
3871 \begin_layout Description
3872 Syntax dialog-update <NAME>
3874 \begin_layout Description
3875 Params <NAME>: paragraph|prefs|<INSET>
3876 \begin_inset Newline newline
3881 \begin_layout Description
3882 Origin leeming, 25 Feb 2003
3885 \begin_layout Subsection*
3888 \begin_layout Description
3889 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
3891 \begin_layout Description
3892 Syntax dialog-hide <NAME>
3894 \begin_layout Description
3895 Params See LFUN_DIALOG_SHOW .
3897 \begin_layout Description
3898 Origin leeming, 25 Feb 2003
3901 \begin_layout Subsection*
3904 \begin_layout Description
3905 Action Toggles dialog between showed/hidden state.
3907 \begin_layout Description
3908 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
3910 \begin_layout Description
3911 Syntax dialog-toggle <NAME> [<DATA>]
3913 \begin_layout Description
3914 Params See LFUN_DIALOG_SHOW .
3916 \begin_layout Description
3917 Origin JSpitzm, 30 Apr 2007
3920 \begin_layout Subsection*
3921 LFUN_DIALOG_DISCONNECT_INSET
3923 \begin_layout Description
3924 Action Closes opened connection to opened inset.
3926 \begin_layout Description
3927 Notion Connection is used for apply functions.
3929 \begin_layout Description
3930 Syntax dialog-disconnect-inset <INSET-NAME>
3932 \begin_layout Description
3933 Origin leeming, 25 Feb 2003
3936 \begin_layout Subsection*
3939 \begin_layout Description
3940 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
3942 \begin_layout Description
3943 Notion This is internal LFUN, not to be used by users.
3945 \begin_layout Description
3946 Origin Andre, 9 Aug 2002
3949 \begin_layout Subsection*
3952 \begin_layout Description
3953 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
3955 \begin_layout Description
3956 Notion This is internal LFUN, not to be used by users.
3958 \begin_layout Description
3959 Origin Andre, 9 Aug 2002
3962 \begin_layout Subsection*
3965 \begin_layout Description
3966 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
3968 \begin_layout Description
3969 Notion This is internal LFUN, not to be used by users.
3971 \begin_layout Description
3972 Origin Andre, 9 Aug 2002
3975 \begin_layout Subsection*
3978 \begin_layout Description
3979 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
3981 \begin_layout Description
3982 Notion This is internal LFUN, not to be used by users.
3984 \begin_layout Description
3985 Origin Andre, 9 Aug 2002
3988 \begin_layout Subsection*
3991 \begin_layout Description
3992 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
3994 \begin_layout Description
3995 Notion This is internal LFUN, not to be used by users.
3997 \begin_layout Description
3998 Origin Andre, 9 Aug 2002
4001 \begin_layout Subsection*
4004 \begin_layout Description
4005 Action Turn off the loaded keyboard map.
4007 \begin_layout Description
4011 \begin_layout Subsection*
4014 \begin_layout Description
4015 Action Turn on the primary keyboard map.
4017 \begin_layout Description
4018 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.
4019 \begin_inset Newline newline
4022 The language is to be set in the Preferences dialog.
4024 \begin_layout Description
4025 Syntax keymap-primary
4028 \begin_layout Subsection*
4029 LFUN_KEYMAP_SECONDARY
4031 \begin_layout Description
4032 Action Turn on the secondary keyboard map.
4034 \begin_layout Description
4035 Syntax keymap-secondary
4038 \begin_layout Subsection*
4041 \begin_layout Description
4042 Action Toggles keyboard maps (first/second/off).
4044 \begin_layout Description
4045 Syntax keymap-toggle
4047 \begin_layout Description
4048 Origin leeming, 30 Mar 2004
4051 \begin_layout Subsection*
4052 LFUN_SERVER_GET_LAYOUT
4054 \begin_layout Description
4055 Action Returns the current layout (that is environment) name on the cursor position.
4057 \begin_layout Description
4058 Syntax server-get-layout
4061 \begin_layout Subsection*
4062 LFUN_SERVER_GET_FILENAME
4064 \begin_layout Description
4065 Action Returns path and file name of the currently edited document.
4067 \begin_layout Description
4068 Syntax server-get-filename
4071 \begin_layout Subsection*
4072 LFUN_SERVER_GOTO_FILE_ROW
4074 \begin_layout Description
4075 Action Sets the cursor position based on the row number of generated TeX file.
4077 \begin_layout Description
4078 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).
4080 \begin_layout Description
4081 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4083 \begin_layout Description
4084 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.
4085 \begin_inset Newline newline
4088 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.
4090 \begin_layout Description
4091 Origin Edmar, 23 Dec 1998
4094 \begin_layout Subsection*
4097 \begin_layout Description
4098 Action Sends notify message about the last key-sequence to client.
4100 \begin_layout Description
4101 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4103 \begin_layout Description
4104 Syntax server-notify
4107 \begin_layout Subsection*
4110 \begin_layout Description
4111 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4113 \begin_layout Description
4114 Syntax server-set-xy <X> <Y>
4117 \begin_layout Subsection*
4120 \begin_layout Description
4121 Action Returns the coordinates of cursor position in the editing area.
4123 \begin_layout Description
4124 Syntax server-get-xy
4127 \begin_layout Subsection*
4130 \begin_layout Description
4131 Action Generates the code (literate programming).
4133 \begin_layout Description
4134 Notion Latex file with extension
4136 literate_extension is generated. Then LyX invokes
4138 build_command (with a default of``make'') to generate the code and
4140 build_error_filter to process the compilation error messages.
4141 \begin_inset Newline newline
4144 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:
4145 \begin_inset Newline newline
4150 build_command "my_script my_arguments"
4151 \begin_inset Newline newline
4156 build_error_filter differs from the
4158 literate_error_filter only in that the former will identify error messages from your compiler.
4160 \begin_layout Description
4161 Syntax build-program
4164 \begin_layout Subsection*
4165 LFUN_BUFFER_AUTO_SAVE
4167 \begin_layout Description
4168 Action Saves the current buffer to a temporary file.
4170 \begin_layout Description
4171 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4173 \begin_layout Description
4174 Syntax buffer-auto-save
4177 \begin_layout Subsection*
4178 LFUN_BUFFER_CHILD_OPEN
4180 \begin_layout Description
4181 Action Loads the given child document.
4183 \begin_layout Description
4184 Notion The current document is treated as a parent.
4186 \begin_layout Description
4187 Syntax buffer-child-open <FILE>
4189 \begin_layout Description
4190 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4192 \begin_layout Description
4193 Origin Ale, 28 May 1997
4196 \begin_layout Subsection*
4199 \begin_layout Description
4200 Action Runs chktex for the current document.
4202 \begin_layout Description
4203 Syntax buffer-chktex
4205 \begin_layout Description
4206 Origin Asger, 30 Oct 1997
4209 \begin_layout Subsection*
4210 LFUN_BUFFER_TOGGLE_COMPRESSION
4212 \begin_layout Description
4213 Action Toggles compression of the current document on/off.
4215 \begin_layout Description
4216 Syntax buffer-toggle-compression
4218 \begin_layout Description
4219 Origin bpeng, 27 Apr 2006
4222 \begin_layout Subsection*
4225 \begin_layout Description
4226 Action Closes the current buffer.
4228 \begin_layout Description
4229 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4231 \begin_layout Description
4235 \begin_layout Subsection*
4238 \begin_layout Description
4239 Action Exports the current buffer (document) to the given format.
4241 \begin_layout Description
4242 Syntax buffer-export <FORMAT>
4244 \begin_layout Description
4245 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.
4246 \begin_inset Newline newline
4249 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.
4251 \begin_layout Description
4252 Origin Lgb, 29 Jul 1997
4255 \begin_layout Subsection*
4256 LFUN_BUFFER_EXPORT_CUSTOM
4258 \begin_layout Description
4259 Action Exports the current buffer (document) from the given format using the given command on it.
4261 \begin_layout Description
4262 Syntax buffer-export-custom <FORMAT> <COMMAND>
4264 \begin_layout Description
4265 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4266 \begin_inset Newline newline
4269 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4271 \begin_layout Description
4272 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4274 \begin_layout Description
4275 Origin leeming, 27 Mar 2004
4278 \begin_layout Subsection*
4281 \begin_layout Description
4282 Action Prints the current document.
4284 \begin_layout Description
4285 Notion Many settings can be given via the preferences dialog.
4287 \begin_layout Description
4288 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4290 \begin_layout Description
4291 Params <TARGET> is either "printer" or "file".
4292 \begin_inset Newline newline
4295 <TARGER-NAME> is either "default" or file name or printer name.
4296 \begin_inset Newline newline
4299 <COMMAND> command ensuring the printing job.
4301 \begin_layout Description
4302 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4304 \begin_layout Description
4305 Origin leeming, 28 Mar 2004
4308 \begin_layout Subsection*
4311 \begin_layout Description
4312 Action Import a given file as a lyx document.
4314 \begin_layout Description
4315 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.
4317 \begin_layout Description
4318 Syntax buffer-import <FORMAT> [<FILE>]
4320 \begin_layout Description
4321 Origin Asger, 24 Jul 1998
4324 \begin_layout Subsection*
4327 \begin_layout Description
4328 Action Creates a new buffer (that is, document).
4330 \begin_layout Description
4331 Notion Implicit path can be set in Preferences dialog.
4333 \begin_layout Description
4334 Syntax buffer-new [<FILE>]
4336 \begin_layout Description
4337 Params <FILE>: filename of created file with absolute path.
4340 \begin_layout Subsection*
4341 LFUN_BUFFER_NEW_TEMPLATE
4343 \begin_layout Description
4344 Action Creates a new buffer (that is, document) from a template.
4346 \begin_layout Description
4347 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4349 \begin_layout Description
4350 Syntax buffer-new-template [<FILE>]
4352 \begin_layout Description
4353 Params <FILE>: filename of created file with absolute path.
4356 \begin_layout Subsection*
4359 \begin_layout Description
4360 Action Reverts opened document.
4362 \begin_layout Description
4363 Syntax buffer-reload
4365 \begin_layout Description
4366 Origin Asger, 2 Feb 1997
4369 \begin_layout Subsection*
4372 \begin_layout Description
4373 Action Switch to the given buffer.
4375 \begin_layout Description
4376 Notion This is useful also in case you need simultaneously more views of the edited document in different LyX windows.
4378 \begin_layout Description
4379 Syntax buffer-new-template <BUFFER>
4381 \begin_layout Description
4382 Params <BUFFER>: already opened document which is to be shown.
4385 \begin_layout Subsection*
4386 LFUN_BUFFER_TOGGLE_READ_ONLY
4388 \begin_layout Description
4389 Action Toggle editing mode of the current document between read/write and read-only.
4391 \begin_layout Description
4392 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.
4393 \begin_inset Newline newline
4396 If these operations fail, buffer won't be toggled.
4398 \begin_layout Description
4399 Syntax buffer-toggle-read-only
4401 \begin_layout Description
4402 Origin Lgb, 27 May 1997
4405 \begin_layout Subsection*
4408 \begin_layout Description
4409 Action Displays current buffer in chosen format.
4411 \begin_layout Description
4412 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.
4414 \begin_layout Description
4415 Syntax buffer-view [<FORMAT>]
4417 \begin_layout Description
4418 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.
4421 \begin_layout Subsection*
4424 \begin_layout Description
4425 Action Exports the current document and put the result into the temporary directory.
4427 \begin_layout Description
4428 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).
4430 \begin_layout Description
4431 Syntax buffer-update [<FORMAT>]
4433 \begin_layout Description
4434 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.
4436 \begin_layout Description
4437 Origin Dekel, 5 Aug 2000
4440 \begin_layout Subsection*
4443 \begin_layout Description
4444 Action Saves the current buffer.
4446 \begin_layout Description
4447 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.
4449 \begin_layout Description
4453 \begin_layout Subsection*
4454 LFUN_BUFFER_WRITE_AS
4456 \begin_layout Description
4457 Action Rename and save current buffer.
4459 \begin_layout Description
4460 Syntax buffer-write-as <FILENAME>
4462 \begin_layout Description
4463 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4466 \begin_layout Subsection*
4467 LFUN_BUFFER_WRITE_ALL
4469 \begin_layout Description
4470 Action Save all changed documents.
4472 \begin_layout Description
4473 Syntax buffer-write-all
4475 \begin_layout Description
4476 Origin rgh, gpothier 6 Aug 2007
4479 \begin_layout Subsection*
4482 \begin_layout Description
4483 Action Switch to the next opened document.
4485 \begin_layout Description
4486 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4488 \begin_layout Description
4492 \begin_layout Subsection*
4493 LFUN_BUFFER_PREVIOUS
4495 \begin_layout Description
4496 Action Switch to the previous opened document.
4498 \begin_layout Description
4499 Syntax buffer-previous
4502 \begin_layout Subsection*
4503 LFUN_MASTER_BUFFER_UPDATE
4505 \begin_layout Description
4506 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4508 \begin_layout Description
4509 Syntax master-buffer-update [<FORMAT>]
4511 \begin_layout Description
4512 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.
4514 \begin_layout Description
4515 Origin Tommaso, 20 Sep 2007
4518 \begin_layout Subsection*
4519 LFUN_MASTER_BUFFER_VIEW
4521 \begin_layout Description
4522 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4524 \begin_layout Description
4525 Syntax master-buffer-view [<FORMAT>]
4527 \begin_layout Description
4528 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.
4530 \begin_layout Description
4531 Origin Tommaso, 20 Sep 2007
4534 \begin_layout Subsection*
4535 LFUN_BUFFER_LANGUAGE
4537 \begin_layout Description
4538 Action Set language of the current document.
4540 \begin_layout Description
4541 Syntax buffer-language <LANG>
4543 \begin_layout Description
4544 Params <LANG>: language name. See lib/languages for list.
4546 \begin_layout Description
4547 Origin leeming, 30 Mar 2004
4550 \begin_layout Subsection*
4551 LFUN_BUFFER_SAVE_AS_DEFAULT
4553 \begin_layout Description
4554 Action Save the current document settings as default.
4556 \begin_layout Description
4557 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4559 \begin_layout Description
4560 Syntax buffer-save-as-default [<ARGS>]
4562 \begin_layout Description
4563 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4565 \begin_layout Description
4566 Origin leeming, 30 Mar 2004
4569 \begin_layout Subsection*
4570 LFUN_BUFFER_PARAMS_APPLY
4572 \begin_layout Description
4573 Action Apply the given settings to the current document.
4575 \begin_layout Description
4576 Syntax buffer-params-apply [<ARGS>]
4578 \begin_layout Description
4579 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4581 \begin_layout Description
4582 Origin leeming, 30 Mar 2004
4585 \begin_layout Subsection*
4588 \begin_layout Description
4589 Action Inserts another LyX file.
4591 \begin_layout Description
4592 Syntax file-insert [<FILE>]
4594 \begin_layout Description
4595 Params <FILE>: Filename to be inserted.
4598 \begin_layout Subsection*
4599 LFUN_FILE_INSERT_PLAINTEXT
4601 \begin_layout Description
4602 Action Inserts plain text file.
4604 \begin_layout Description
4605 Syntax file-insert-plaintext [<FILE>]
4607 \begin_layout Description
4608 Params <FILE>: Filename to be inserted.
4610 \begin_layout Description
4611 Origin CFO-G, 19 Nov 1997
4614 \begin_layout Subsection*
4615 LFUN_FILE_INSERT_PLAINTEXT_PARA
4617 \begin_layout Description
4618 Action Inserts plain text file as paragraph (i.e. join lines).
4620 \begin_layout Description
4621 Syntax file-insert-plaintext-para [<FILE>]
4623 \begin_layout Description
4624 Params <FILE>: Filename to be inserted.
4626 \begin_layout Description
4627 Origin Levon, 14 Feb 2001
4630 \begin_layout Subsection*
4633 \begin_layout Description
4634 Action Open LyX document.
4636 \begin_layout Description
4637 Syntax file-open [<FILE>]
4639 \begin_layout Description
4640 Params <FILE>: Filename to be opened.
4643 \begin_layout Subsection*
4646 \begin_layout Description
4647 Action Executes a command defined in a .def file.
4649 \begin_layout Description
4650 Notion The definitions are by default read from lib/commands/default.def.
4651 \begin_inset Newline newline
4654 A .def file allows to define a command with
4656 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).
4658 def_file "FileName" allows to include another .def file.
4659 \begin_inset Newline newline
4662 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.
4664 \begin_layout Description
4667 \begin_layout Description
4668 Params <NAME>: Name of the command that must be called.
4670 \begin_layout Description
4671 Origin broider, 2 Oct 2007
4674 \begin_layout Subsection*
4677 \begin_layout Description
4678 Action Simulate halting Meta key (Alt key on PCs).
4680 \begin_layout Description
4681 Notion Used for buffer editation not for GUI control.
4683 \begin_layout Description
4687 \begin_layout Subsection*
4690 \begin_layout Description
4691 Action Cancels sequence prepared by LFUN_META_PREFIX .
4693 \begin_layout Description
4697 \begin_layout Subsection*
4698 LFUN_COMMAND_EXECUTE
4700 \begin_layout Description
4701 Action Opens the minibuffer toolbar so that the user can type in there.
4703 \begin_layout Description
4704 Notion Usually bound to M-x shortcut.
4706 \begin_layout Description
4707 Syntax command-execute
4710 \begin_layout Subsection*
4713 \begin_layout Description
4714 Action Return the current key sequence and available options as a string.
4716 \begin_layout Description
4717 Notion No options are added if no current map exists.
4718 \begin_inset Newline newline
4721 This is probably usable only with connection to lyxserver.
4723 \begin_layout Description
4724 Syntax command-prefix
4727 \begin_layout Subsection*
4728 LFUN_COMMAND_SEQUENCE
4730 \begin_layout Description
4731 Action Run more commands (LFUN and its parameters) in a sequence.
4733 \begin_layout Description
4734 Syntax command-sequence <CMDS>
4736 \begin_layout Description
4737 Params <CMDS>: Sequence of commands separated by semicolons.
4739 \begin_layout Description
4740 Sample command-sequence cut; ert-insert; self-insert
4742 ; paste; self-insert {}; inset-toggle;
4744 \begin_layout Description
4745 Origin Andre, 11 Nov 1999
4748 \begin_layout Subsection*
4749 LFUN_COMMAND_ALTERNATIVES
4751 \begin_layout Description
4752 Action Runs the first listed command that is enabled.
4754 \begin_layout Description
4755 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
4757 \begin_layout Description
4758 Syntax command-alternatives <CMDS>
4760 \begin_layout Description
4761 Params <CMDS>: Sequence of commands separated by semicolons.
4763 \begin_layout Description
4764 Sample command-alternatives completion-accept;cell-forward
4766 \begin_layout Description
4767 Origin rgh, 24 September 2008
4770 \begin_layout Subsection*
4773 \begin_layout Description
4774 Action Shows message in statusbar (for script purposes).
4776 \begin_layout Description
4777 Syntax message <STRING>
4779 \begin_layout Description
4780 Origin Lgb, 8 Apr 2001
4783 \begin_layout Subsection*
4784 LFUN_PREFERENCES_SAVE
4786 \begin_layout Description
4787 Action Save user preferences.
4789 \begin_layout Description
4790 Syntax preferences-save
4792 \begin_layout Description
4793 Origin Lgb, 27 Nov 1999
4796 \begin_layout Subsection*
4799 \begin_layout Description
4800 Action Reconfigure the automatic settings.
4802 \begin_layout Description
4805 \begin_layout Description
4806 Origin Asger, 14 Feb 1997
4809 \begin_layout Subsection*
4812 \begin_layout Description
4813 Action Apply the given settings to user preferences.
4815 \begin_layout Description
4816 Syntax lyxrc-apply <SETTINGS>
4818 \begin_layout Description
4819 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.
4822 \begin_layout Subsection*
4823 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
4825 \begin_layout Description
4826 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
4828 \begin_layout Description
4829 Syntax toggle-cursor-follows-scrollbar
4831 \begin_layout Description
4832 Origin ARRae, 2 Dec 1997
4835 \begin_layout Subsection*
4838 \begin_layout Description
4839 Action Set the given LyX color to the color defined by the X11 name given.
4841 \begin_layout Description
4842 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
4844 \begin_layout Description
4845 Syntax set-color <LYX_NAME> <X11_NAME>
4847 \begin_layout Description
4848 Origin SLior, 11 Jun 2000
4851 \begin_layout Subsection*
4854 \begin_layout Description
4855 Action Count the statistics (number of words and characters) in the document or in the given selection.
4857 \begin_layout Description
4858 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
4860 \begin_layout Description
4863 \begin_layout Description
4864 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
4867 \begin_layout Subsection*
4868 LFUN_COMPLETION_INLINE
4870 \begin_layout Description
4871 Action Show the inline completion at the cursor position.
4873 \begin_layout Description
4874 Syntax completion-inline
4876 \begin_layout Description
4877 Origin sts, Feb 19 2008
4880 \begin_layout Subsection*
4881 LFUN_COMPLETION_POPUP
4883 \begin_layout Description
4884 Action Show the completion popup at the cursor position.
4886 \begin_layout Description
4887 Syntax completion-popup
4889 \begin_layout Description
4890 Origin sts, Feb 19 2008
4893 \begin_layout Subsection*
4894 LFUN_COMPLETION_COMPLETE
4896 \begin_layout Description
4897 Action Try to complete the word or command at the cursor position.
4899 \begin_layout Description
4902 \begin_layout Description
4903 Origin sts, Feb 19 2008
4906 \begin_layout Subsection*
4907 LFUN_COMPLETION_CANCEL
4909 \begin_layout Description
4910 Action Try to cancel completion, either the popup or the inline completion
4912 \begin_layout Description
4913 Syntax completion-cancel
4915 \begin_layout Description
4916 Origin sts, Sep 07 2008
4919 \begin_layout Subsection*
4920 LFUN_COMPLETION_ACCEPT
4922 \begin_layout Description
4923 Action Accept suggested completion.
4925 \begin_layout Description
4926 Syntax completion-accept
4928 \begin_layout Description
4929 Origin sanda, Sep 08 2008
4932 \begin_layout Subsection*
4933 LFUN_BRANCH_ACTIVATE
4935 \begin_layout Description
4936 Action Activate the branch
4938 \begin_layout Description
4939 Syntax branch-activate <BRANCH>
4941 \begin_layout Description
4942 Params <BRANCH>: The branch to activate
4944 \begin_layout Description
4945 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
4946 \begin_inset Newline newline
4949 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
4951 \begin_layout Description
4952 Origin rgh, 27 May 2008
4955 \begin_layout Subsection*
4956 LFUN_BRANCH_DEACTIVATE
4958 \begin_layout Description
4959 Action De-activate the branch
4961 \begin_layout Description
4962 Syntax branch-deactivate <BRANCH>
4964 \begin_layout Description
4965 Params <BRANCH>: The branch to deactivate
4967 \begin_layout Description
4968 Origin rgh, 27 May 2008
4971 \begin_layout Subsection*
4972 LFUN_LABEL_COPY_AS_REF
4974 \begin_layout Description
4975 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
4977 \begin_layout Description
4978 Syntax copy-label-as-reference
4980 \begin_layout Description
4981 Origin sts, 16 Nov 2008
4984 \begin_layout Subsection*
4985 LFUN_LABEL_INSERT_AS_REF
4987 \begin_layout Description
4988 Action Inserts the label as a cross-reference at the position of the cursor.
4990 \begin_layout Description
4991 Syntax label-insert-as-reference
4993 \begin_layout Description
4994 Origin vfr, 7 Apr 2009
4997 \begin_layout Subsection*
5000 \begin_layout Description
5001 Action Increases the zoom of the screen fonts.
5003 \begin_layout Description
5004 Syntax buffer-zoom-in [<ZOOM>]
5006 \begin_layout Description
5007 Params <ZOOM>: The zoom in %, the default is 20.
5009 \begin_layout Description
5010 Origin vfr, 30 Mar 2009
5013 \begin_layout Subsection*
5014 LFUN_BUFFER_ZOOM_OUT
5016 \begin_layout Description
5017 Action Decreases the zoom of the screen fonts.
5019 \begin_layout Description
5020 Syntax buffer-zoom-out [<ZOOM>]
5022 \begin_layout Description
5023 Params <ZOOM>: The zoom in %, the default is 20.
5025 \begin_layout Description
5026 Origin vfr, 30 Mar 2009
5029 \begin_layout Subsection*
5032 \begin_layout Description
5033 Action Selects the whole section.
5035 \begin_layout Description
5036 Notion The cursor should be in a section heading before calling this lfun.
5038 \begin_layout Description
5039 Syntax section-select
5041 \begin_layout Description
5042 Origin vfr, 05 May 2009