1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
6 \use_default_options false
14 \font_typewriter default
15 \font_default_family default
22 \paperfontsize default
30 \paperorientation portrait
37 \paragraph_separation indent
39 \quotes_language english
42 \paperpagestyle default
43 \tracking_changes false
51 \begin_layout Section*
52 LFUNs documentation automatically generated 2009-06-12
55 \begin_layout Standard
59 \begin_layout Plain Layout
69 \begin_inset VSpace 1cm
74 \begin_layout Subsection*
77 \begin_layout Description
78 Action Adds an acute accent to the next character typed.
80 \begin_layout Description
84 \begin_layout Subsection*
87 \begin_layout Description
88 Action Adds a breve accent to the next character typed.
90 \begin_layout Description
94 \begin_layout Subsection*
97 \begin_layout Description
98 Action Adds a caron to the next character typed.
100 \begin_layout Description
104 \begin_layout Subsection*
107 \begin_layout Description
108 Action Adds a cedilla to the next character typed.
110 \begin_layout Description
111 Syntax accent-cedilla
114 \begin_layout Subsection*
117 \begin_layout Description
118 Action Adds a circle accent to the next character typed.
120 \begin_layout Description
124 \begin_layout Subsection*
125 LFUN_ACCENT_CIRCUMFLEX
127 \begin_layout Description
128 Action Adds a circumflex to the next character typed.
130 \begin_layout Description
131 Syntax accent-circumflex
134 \begin_layout Subsection*
137 \begin_layout Description
138 Action Adds a dot accent to the next character typed.
140 \begin_layout Description
144 \begin_layout Subsection*
147 \begin_layout Description
148 Action Adds a grave accent to the next character typed.
150 \begin_layout Description
154 \begin_layout Subsection*
155 LFUN_ACCENT_HUNGARIAN_UMLAUT
157 \begin_layout Description
158 Action Adds a Hungarian umlaut to the next character typed.
160 \begin_layout Description
164 \begin_layout Subsection*
167 \begin_layout Description
168 Action Adds a macron to the next character typed.
170 \begin_layout Description
174 \begin_layout Subsection*
177 \begin_layout Description
178 Action Adds an ogonek accent to the next character typed.
180 \begin_layout Description
184 \begin_layout Subsection*
187 \begin_layout Description
188 Action Adds a tie over the next two character typed.
190 \begin_layout Description
191 Notion The following char will finish the tie.
193 \begin_layout Description
197 \begin_layout Subsection*
200 \begin_layout Description
201 Action Adds a tilde over the next character typed.
203 \begin_layout Description
207 \begin_layout Subsection*
210 \begin_layout Description
211 Action Adds an umlaut over the next character typed.
213 \begin_layout Description
217 \begin_layout Subsection*
220 \begin_layout Description
221 Action Adds a bar under the next character typed.
223 \begin_layout Description
224 Syntax accent-underbar
227 \begin_layout Subsection*
230 \begin_layout Description
231 Action Adds a dot under the next character typed.
233 \begin_layout Description
234 Syntax accent-underdot
237 \begin_layout Subsection*
240 \begin_layout Description
241 Action Inserts a caption inset.
243 \begin_layout Description
244 Syntax caption-insert
246 \begin_layout Description
247 Origin Lgb, 18 Jul 2000
250 \begin_layout Subsection*
253 \begin_layout Description
254 Action Inserts the current date.
256 \begin_layout Description
257 Syntax date-insert [<ARG>]
259 \begin_layout Description
260 Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
262 \begin_layout Description
263 Origin jdblair, 31 Jan 2000
266 \begin_layout Subsection*
269 \begin_layout Description
270 Action Inserts a footnote inset.
272 \begin_layout Description
273 Syntax footnote-insert
275 \begin_layout Description
276 Origin Jug, 7 Mar 2000
279 \begin_layout Subsection*
282 \begin_layout Description
283 Action Inserts an ERT inset.
285 \begin_layout Description
288 \begin_layout Description
289 Origin Jug, 18 Feb 2000
292 \begin_layout Subsection*
295 \begin_layout Description
296 Action Inserts a float inset.
298 \begin_layout Description
299 Syntax float-insert <TYPE>
301 \begin_layout Description
302 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
304 \begin_layout Description
305 Origin Lgb, 27 Jun 2000
308 \begin_layout Subsection*
309 LFUN_FLOAT_WIDE_INSERT
311 \begin_layout Description
312 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
314 \begin_layout Description
315 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
317 \begin_layout Description
318 Syntax float-wide-insert <TYPE>
320 \begin_layout Description
321 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
323 \begin_layout Description
324 Origin Lgb, 31 Oct 2001
327 \begin_layout Subsection*
328 LFUN_FLOAT_LIST_INSERT
330 \begin_layout Description
331 Action Inserts the list of floats in the document.
333 \begin_layout Description
334 Syntax float-list-insert <TYPE>
336 \begin_layout Description
337 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
339 \begin_layout Description
340 Origin Lgb, 3 May 2001
343 \begin_layout Subsection*
346 \begin_layout Description
347 Action Inserts floats wrapped by the text around.
349 \begin_layout Description
350 Syntax wrap-insert <TYPE>
352 \begin_layout Description
353 Params <TYPE>: table|figure
355 \begin_layout Description
356 Origin Dekel, 7 Apr 2002
359 \begin_layout Subsection*
362 \begin_layout Description
363 Action Inserts an optional-argument (short title) inset.
365 \begin_layout Description
366 Syntax optional-insert
368 \begin_layout Description
369 Origin vermeer, 12 Aug 2002
372 \begin_layout Subsection*
375 \begin_layout Description
376 Action Inserts a horizontal line.
378 \begin_layout Description
381 \begin_layout Description
382 Origin Andre, Oct 27 2003
385 \begin_layout Subsection*
388 \begin_layout Description
389 Action Inserts a new page.
391 \begin_layout Description
392 Syntax newpage-insert <ARG>
394 \begin_layout Description
395 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
397 \begin_layout Description
398 Origin uwestoehr, 24 Nov 2007
401 \begin_layout Subsection*
402 LFUN_MARGINALNOTE_INSERT
404 \begin_layout Description
405 Action Inserts a marginal note.
407 \begin_layout Description
408 Syntax marginalnote-insert
410 \begin_layout Description
411 Origin Lgb, 26 Jun 2000
414 \begin_layout Subsection*
417 \begin_layout Description
418 Action Inserts a single unicode character.
420 \begin_layout Description
421 Syntax unicode-insert <CHAR>
423 \begin_layout Description
424 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
426 \begin_layout Description
427 Sample unicode-insert 0x0100
429 \begin_layout Description
430 Origin Lgb, 22 Oct 2006
433 \begin_layout Subsection*
436 \begin_layout Description
437 Action Inserts a new listings inset.
439 \begin_layout Description
440 Syntax listing-insert
442 \begin_layout Description
443 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
446 \begin_layout Subsection*
449 \begin_layout Description
450 Action Insert a tab into a listings inset.
452 \begin_layout Description
453 Notion It also works on a selection.
455 \begin_layout Description
458 \begin_layout Description
459 Origin vfr, Sep 30 2008
462 \begin_layout Subsection*
465 \begin_layout Description
466 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
468 \begin_layout Description
469 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action.
471 \begin_layout Description
474 \begin_layout Description
475 Origin vfr, Sep 30 2008
478 \begin_layout Subsection*
481 \begin_layout Description
482 Action Inserts quotes according to the type and quote-language preference.
484 \begin_layout Description
485 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
487 \begin_layout Description
488 Syntax quote-insert [<TYPE>]
490 \begin_layout Description
491 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
494 \begin_layout Subsection*
497 \begin_layout Description
498 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
500 \begin_layout Description
501 Notion Apart from lfun arguments you can use the following method:
502 \begin_inset Newline newline
505 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
506 \begin_inset Newline newline
509 2. select the text and run info-insert lfun.
511 \begin_layout Description
512 Syntax info-insert <TYPE> <ARG>
514 \begin_layout Description
515 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
516 \begin_inset Newline newline
519 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
521 \begin_layout Description
522 Sample command-sequence info-insert buffer path; info-insert buffer name
524 \begin_layout Description
525 Origin bpeng, 7 Oct 2007
528 \begin_layout Subsection*
531 \begin_layout Description
532 Action Inserts branch inset.
534 \begin_layout Description
535 Syntax branch-insert <BRANCH-NAME>
537 \begin_layout Description
538 Origin vermeer, 17 Aug 2003
541 \begin_layout Subsection*
544 \begin_layout Description
545 Action Inserts Box inset.
547 \begin_layout Description
548 Syntax box-insert [<TYPE>]
550 \begin_layout Description
551 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
552 \begin_inset Newline newline
555 Framed is the default one.
557 \begin_layout Description
558 Origin vermeer, 7 Oct 2003
561 \begin_layout Subsection*
564 \begin_layout Description
565 Action Inserts CharStyle, Custom inset or XML short element.
567 \begin_layout Description
568 Notion Look into the Customization manual for more information about these elements.
569 \begin_inset Newline newline
572 To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself.
573 \begin_inset Newline newline
576 For dissolving the element see LFUN_INSET_DISSOLVE.
578 \begin_layout Description
579 Syntax flex-insert <TYPE:Name>
581 \begin_layout Description
582 Params TYPE: CharStyle|Custom|Element|Standard
583 \begin_inset Newline newline
586 Identifies whether this is a Character Style, a Custom Inset or an XML Element, and which dynamical sub-menu this flex inset is in on the LyX menu tree. If Standard (currently unused): none of these.
587 \begin_inset Newline newline
590 Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
592 \begin_layout Description
593 Sample flex-insert CharStyle:Code
596 \begin_layout Subsection*
599 \begin_layout Description
600 Action Inserts the given string (accordingly to the correct keymap).
602 \begin_layout Description
603 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
605 \begin_layout Description
606 Syntax self-insert <STRING>
609 \begin_layout Subsection*
612 \begin_layout Description
613 Action Inserts one of horizontal space insets.
615 \begin_layout Description
616 Syntax space-insert <NAME> [<LEN>]
618 \begin_layout Description
619 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
620 \begin_inset Newline newline
623 <LEN>: length for custom spaces (hspace, hspace* for protected)
625 \begin_layout Description
626 Origin JSpitzm, 20 May 2003, Mar 17 2008
629 \begin_layout Subsection*
630 LFUN_HYPERLINK_INSERT
632 \begin_layout Description
633 Action Inserts hyperlinks into the document (clickable in pdf output).
635 \begin_layout Description
636 Notion Hyperlink target can be set via selection + hyperlink-insert function.
638 \begin_layout Description
639 Syntax href-insert [<TARGET>]
641 \begin_layout Description
642 Origin CFO-G, 21 Nov 1997
645 \begin_layout Subsection*
646 LFUN_SPECIALCHAR_INSERT
648 \begin_layout Description
649 Action Inserts various characters into the document.
651 \begin_layout Description
652 Syntax specialchar-insert <CHAR>
654 \begin_layout Description
655 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
657 \begin_layout Description
658 Origin JSpitzm, 6 Dec 2007
661 \begin_layout Subsection*
664 \begin_layout Description
665 Action Inserts table of contents.
667 \begin_layout Description
670 \begin_layout Description
671 Origin Lgb, 27 May 97
674 \begin_layout Subsection*
677 \begin_layout Description
678 Action Start (or remove) Appendix on the given cursor position.
680 \begin_layout Description
683 \begin_layout Description
684 Origin ettrich, 5 May 1998
687 \begin_layout Subsection*
690 \begin_layout Description
691 Action Inserts Index entry.
693 \begin_layout Description
694 Notion It automatically takes the word on the cursor position.
696 \begin_layout Description
697 Syntax index-insert [<TYPE:Name>]
699 \begin_layout Description
700 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
702 \begin_layout Description
703 Origin leeming, 3 Aug 2000
706 \begin_layout Subsection*
709 \begin_layout Description
710 Action Inserts list of Index entries on a new page.
712 \begin_layout Description
713 Syntax index-print [<TYPE:Name>]
715 \begin_layout Description
716 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
718 \begin_layout Description
719 Origin Lgb, 27 Feb 1997
722 \begin_layout Subsection*
725 \begin_layout Description
726 Action Inserts Nomenclature entry.
728 \begin_layout Description
729 Notion It automatically takes the word on the cursor position if no symbol is given.
731 \begin_layout Description
732 Syntax nomencl-insert [<SYMBOL>]
734 \begin_layout Description
735 Origin Ugras, 4 Nov 2006
738 \begin_layout Subsection*
739 LFUN_NOMENCLATURE_PRINT
741 \begin_layout Description
742 Action Inserts list of Nomenclature entries.
744 \begin_layout Description
745 Syntax nomenclature-print
747 \begin_layout Description
748 Origin Ugras, 4 Nov 2006
751 \begin_layout Subsection*
754 \begin_layout Description
755 Action Inserts Note on the current cursor postion, move selection inside the inset.
757 \begin_layout Description
758 Syntax note-insert [<TYPE>]
760 \begin_layout Description
761 Params <TYPE>: <Note|Greyedout|Comment> default: Note
764 \begin_layout Subsection*
767 \begin_layout Description
768 Action Moves the cursor to the begining of next Note inset.
770 \begin_layout Description
774 \begin_layout Subsection*
777 \begin_layout Description
778 Action Changes all Note insets of a particular type (source) to a different type (target) fot the current document.
780 \begin_layout Description
781 Syntax notes-mutate <SOURCE> <TARGET>
783 \begin_layout Description
784 Params <SOURCE/TARGET>: Note|Comment|Greyedout
786 \begin_layout Description
787 Origin sanda, 18 Jun 2008
790 \begin_layout Subsection*
793 \begin_layout Description
794 Action Inserts phantom on the current cursor postion, move selection inside the inset.
796 \begin_layout Description
797 Syntax phantom-insert [<TYPE>]
799 \begin_layout Description
800 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
802 \begin_layout Description
803 Origin uwestoehr, 30 Jan 2009
806 \begin_layout Subsection*
809 \begin_layout Description
810 Action Inserts a line break or new line.
812 \begin_layout Description
813 Syntax newline-insert [<ARG>]
815 \begin_layout Description
816 Params <ARG>: <newline|linebreak> default: newline
818 \begin_layout Description
819 Origin JSpitzm, 25 Mar 2008
822 \begin_layout Subsection*
825 \begin_layout Description
826 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD.
828 \begin_layout Description
831 \begin_layout Description
832 Origin Lgb, 17 May 2001
835 \begin_layout Subsection*
838 \begin_layout Description
839 Action Moves the cursor one line in downward direction.
841 \begin_layout Description
845 \begin_layout Subsection*
848 \begin_layout Description
849 Action Moves the cursor one line in upward direction.
851 \begin_layout Description
855 \begin_layout Subsection*
858 \begin_layout Description
859 Action Moves the cursor one line in downward direction adding the current position to the selection.
861 \begin_layout Description
865 \begin_layout Subsection*
868 \begin_layout Description
869 Action Moves the cursor one line in upward direction adding the current position to the selection.
871 \begin_layout Description
875 \begin_layout Subsection*
878 \begin_layout Description
879 Action Moves the cursor one page in downward direction.
881 \begin_layout Description
885 \begin_layout Subsection*
888 \begin_layout Description
889 Action Moves the cursor one page in upward direction.
891 \begin_layout Description
895 \begin_layout Subsection*
896 LFUN_SCREEN_DOWN_SELECT
898 \begin_layout Description
899 Action Moves the cursor one screen in downward direction adding the current position to the selection.
901 \begin_layout Description
902 Syntax screen-down-select
905 \begin_layout Subsection*
906 LFUN_SCREEN_UP_SELECT
908 \begin_layout Description
909 Action Moves the cursor one page in upward direction adding the current position to the selection.
911 \begin_layout Description
912 Syntax screen-up-select
915 \begin_layout Subsection*
918 \begin_layout Description
919 Action Scroll the buffer view.
921 \begin_layout Description
922 Notion Only scrolls the screen up or down; does not move the cursor.
924 \begin_layout Description
925 Syntax scroll <TYPE> <QUANTITY>
927 \begin_layout Description
928 Params <TYPE>: line|page
929 \begin_inset Newline newline
932 <QUANTITY>: up|down|<number>
934 \begin_layout Description
935 Origin Abdel, Dec 27 2007
938 \begin_layout Subsection*
941 \begin_layout Description
942 Action Recenters the screen on the current cursor position.
944 \begin_layout Description
945 Syntax screen-recenter
948 \begin_layout Subsection*
949 LFUN_SCREEN_SHOW_CURSOR
951 \begin_layout Description
952 Action Repositions the screen such that the cursor is visible.
954 \begin_layout Description
955 Syntax screen-show-cursor
957 \begin_layout Description
958 Origin vfr, 25 Mar 2009
961 \begin_layout Subsection*
964 \begin_layout Description
965 Action Moves the cursor one position logically backwards.
967 \begin_layout Description
968 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
970 \begin_layout Description
974 \begin_layout Subsection*
975 LFUN_CHAR_BACKWARD_SELECT
977 \begin_layout Description
978 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
980 \begin_layout Description
981 Notion See also LFUN_CHAR_BACKWARD.
983 \begin_layout Description
984 Syntax char-backward-select
987 \begin_layout Subsection*
988 LFUN_CHAR_DELETE_BACKWARD
990 \begin_layout Description
991 Action Deletes one character in the backward direction (usually the "BackSpace" key).
993 \begin_layout Description
994 Syntax char-delete-backward
997 \begin_layout Subsection*
998 LFUN_CHAR_DELETE_FORWARD
1000 \begin_layout Description
1001 Action Deletes one character in the backward direction (usually the "Delete" key).
1003 \begin_layout Description
1004 Syntax char-delete-forward
1007 \begin_layout Subsection*
1010 \begin_layout Description
1011 Action Moves the cursor one position logically forward.
1013 \begin_layout Description
1014 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1016 \begin_layout Description
1020 \begin_layout Subsection*
1021 LFUN_CHAR_FORWARD_SELECT
1023 \begin_layout Description
1024 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1026 \begin_layout Description
1027 Notion See also LFUN_CHAR_FORWARD.
1029 \begin_layout Description
1030 Syntax char-forward-select
1033 \begin_layout Subsection*
1036 \begin_layout Description
1037 Action Moves the cursor one position "to the left".
1039 \begin_layout Description
1040 Notion This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
1042 \begin_layout Description
1046 \begin_layout Subsection*
1047 LFUN_CHAR_LEFT_SELECT
1049 \begin_layout Description
1050 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1052 \begin_layout Description
1053 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1055 \begin_layout Description
1056 Syntax char-left-select
1059 \begin_layout Subsection*
1062 \begin_layout Description
1063 Action Moves the cursor one position "to the right".
1065 \begin_layout Description
1066 Notion This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
1068 \begin_layout Description
1072 \begin_layout Subsection*
1073 LFUN_CHAR_RIGHT_SELECT
1075 \begin_layout Description
1076 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1078 \begin_layout Description
1079 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1081 \begin_layout Description
1082 Syntax char-right-select
1085 \begin_layout Subsection*
1088 \begin_layout Description
1089 Action Moves the cursor to the logically previous beginning of a word.
1091 \begin_layout Description
1092 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
1094 \begin_layout Description
1095 Syntax word-backward
1098 \begin_layout Subsection*
1099 LFUN_WORD_BACKWARD_SELECT
1101 \begin_layout Description
1102 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1104 \begin_layout Description
1105 Notion See also LFUN_WORD_BACKWARD.
1107 \begin_layout Description
1108 Syntax word-backward-select
1111 \begin_layout Subsection*
1112 LFUN_WORD_DELETE_BACKWARD
1114 \begin_layout Description
1115 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1117 \begin_layout Description
1118 Syntax word-delete-backward
1121 \begin_layout Subsection*
1122 LFUN_WORD_DELETE_FORWARD
1124 \begin_layout Description
1125 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1127 \begin_layout Description
1128 Syntax word-delete-forward
1131 \begin_layout Subsection*
1132 LFUN_WORD_FIND_FORWARD
1134 \begin_layout Description
1135 Action Search for a given string in forward direction.
1137 \begin_layout Description
1138 Notion Case sensitive, match words. If no argument given, last search repeated.
1140 \begin_layout Description
1141 Syntax word-find-forward [<STRING>]
1143 \begin_layout Description
1144 Origin Etienne, 16 Feb 1998
1147 \begin_layout Subsection*
1148 LFUN_WORD_FIND_BACKWARD
1150 \begin_layout Description
1151 Action Search for a given string in backward direction.
1153 \begin_layout Description
1154 Notion Case sensitive, match words. If no argument given, last search repeated.
1156 \begin_layout Description
1157 Syntax word-find-backward [<STRING>]
1159 \begin_layout Description
1160 Origin Etienne, 20 Feb 1998
1163 \begin_layout Subsection*
1166 \begin_layout Description
1167 Action Search for next occurence of a string.
1169 \begin_layout Description
1170 Syntax word-find [<DATA>]
1172 \begin_layout Description
1173 Params <DATA>: data encoded from Find dialog (see lyx::find2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
1175 \begin_layout Description
1176 Origin Andre, Jan 7 2004
1179 \begin_layout Subsection*
1182 \begin_layout Description
1183 Action Replace a string in the document.
1185 \begin_layout Description
1186 Syntax word-replace [<DATA>]
1188 \begin_layout Description
1189 Params <DATA>: data is of the form "<search>
1190 \begin_inset Newline newline
1194 \begin_inset Newline newline
1197 <casesensitive> <matchword> <all> <forward>"
1199 \begin_layout Description
1200 Origin Andre, Jan 7 2004
1203 \begin_layout Subsection*
1206 \begin_layout Description
1207 Action Search for next occurence of a pattern.
1209 \begin_layout Description
1210 Syntax word-findadv [<DATA>]
1212 \begin_layout Description
1213 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
1215 \begin_layout Description
1216 Origin Tommaso, Nov 15 2007
1219 \begin_layout Subsection*
1222 \begin_layout Description
1223 Action Moves the cursor to the logically next beginning of a word.
1225 \begin_layout Description
1226 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
1228 \begin_layout Description
1232 \begin_layout Subsection*
1233 LFUN_WORD_FORWARD_SELECT
1235 \begin_layout Description
1236 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1238 \begin_layout Description
1239 Notion See also LFUN_WORD_FORWARD.
1241 \begin_layout Description
1242 Syntax word-forward-select
1245 \begin_layout Subsection*
1248 \begin_layout Description
1249 Action Moves the cursor to the next beginning of a word "on the left".
1251 \begin_layout Description
1252 Notion This is the action which should be taken when the (e.g., ctrl-) "left" key is pressed. Generally, it moves the cursor to the next beginning of a word on the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
1254 \begin_layout Description
1257 \begin_layout Description
1258 Origin dov, 28 Oct 2007
1261 \begin_layout Subsection*
1262 LFUN_WORD_LEFT_SELECT
1264 \begin_layout Description
1265 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1267 \begin_layout Description
1268 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1270 \begin_layout Description
1271 Syntax word-left-select
1273 \begin_layout Description
1274 Origin dov, 28 Oct 2007
1277 \begin_layout Subsection*
1280 \begin_layout Description
1281 Action Moves the cursor to the next beginning of a word "on the right".
1283 \begin_layout Description
1284 Notion This is the action which should be taken when the (e.g., ctrl-) "right" key is pressed. Generally, it moves the cursor to the next beginning of a word on the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
1286 \begin_layout Description
1289 \begin_layout Description
1290 Origin dov, 28 Oct 2007
1293 \begin_layout Subsection*
1294 LFUN_WORD_RIGHT_SELECT
1296 \begin_layout Description
1297 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1299 \begin_layout Description
1300 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1302 \begin_layout Description
1303 Syntax word-right-select
1305 \begin_layout Description
1306 Origin dov, 28 Oct 2007
1309 \begin_layout Subsection*
1312 \begin_layout Description
1313 Action Puts the word where the cursor stands into the selection.
1315 \begin_layout Description
1318 \begin_layout Description
1319 Origin Andre, 11 Sep 2002
1322 \begin_layout Subsection*
1323 LFUN_WORD_CAPITALIZE
1325 \begin_layout Description
1326 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1328 \begin_layout Description
1329 Syntax word-capitalize
1332 \begin_layout Subsection*
1335 \begin_layout Description
1336 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1338 \begin_layout Description
1342 \begin_layout Subsection*
1345 \begin_layout Description
1346 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1348 \begin_layout Description
1352 \begin_layout Subsection*
1353 LFUN_THESAURUS_ENTRY
1355 \begin_layout Description
1356 Action Look up thesaurus entries with respect to the word under the cursor.
1358 \begin_layout Description
1359 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1361 \begin_layout Description
1362 Params <STRING>: word to look up <LANG>: language (see file languages)
1364 \begin_layout Description
1365 Origin Levon, 20 Jul 2001
1368 \begin_layout Subsection*
1371 \begin_layout Description
1372 Action Move the cursor to the beginning of the document.
1374 \begin_layout Description
1378 \begin_layout Subsection*
1379 LFUN_BUFFER_BEGIN_SELECT
1381 \begin_layout Description
1382 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1384 \begin_layout Description
1385 Syntax buffer-begin-select
1388 \begin_layout Subsection*
1391 \begin_layout Description
1392 Action Move the cursor to the end of the document.
1394 \begin_layout Description
1398 \begin_layout Subsection*
1399 LFUN_BUFFER_END_SELECT
1401 \begin_layout Description
1402 Action Move the cursor to the end of the document adding the traversed text to the selection.
1404 \begin_layout Description
1405 Syntax buffer-end-select
1408 \begin_layout Subsection*
1411 \begin_layout Description
1412 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise
1414 \begin_layout Description
1417 \begin_layout Description
1418 Origin lasgouttes, 16 Mar 2009
1421 \begin_layout Subsection*
1422 LFUN_INSET_BEGIN_SELECT
1424 \begin_layout Description
1425 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection).
1427 \begin_layout Description
1428 Syntax inset-begin-select
1430 \begin_layout Description
1431 Origin lasgouttes, 16 Mar 2009
1434 \begin_layout Subsection*
1437 \begin_layout Description
1438 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise
1440 \begin_layout Description
1443 \begin_layout Description
1444 Origin lasgouttes, 16 Mar 2009
1447 \begin_layout Subsection*
1448 LFUN_INSET_END_SELECT
1450 \begin_layout Description
1451 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection).
1453 \begin_layout Description
1454 Syntax inset-end-select
1456 \begin_layout Description
1457 Origin lasgouttes, 16 Mar 2009
1460 \begin_layout Subsection*
1463 \begin_layout Description
1464 Action Move the cursor to the begining of the (screen) line.
1466 \begin_layout Description
1470 \begin_layout Subsection*
1471 LFUN_LINE_BEGIN_SELECT
1473 \begin_layout Description
1474 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1476 \begin_layout Description
1477 Syntax line-begin-select
1480 \begin_layout Subsection*
1483 \begin_layout Description
1484 Action Move the cursor to the end of the (screen) line.
1486 \begin_layout Description
1490 \begin_layout Subsection*
1491 LFUN_LINE_END_SELECT
1493 \begin_layout Description
1494 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1496 \begin_layout Description
1497 Syntax line-end-select
1500 \begin_layout Subsection*
1503 \begin_layout Description
1504 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1506 \begin_layout Description
1507 Syntax line-delete-forward
1510 \begin_layout Subsection*
1513 \begin_layout Description
1514 Action Copies to the clipboard the last edit.
1516 \begin_layout Description
1520 \begin_layout Subsection*
1523 \begin_layout Description
1524 Action Cuts to the clipboard.
1526 \begin_layout Description
1530 \begin_layout Subsection*
1533 \begin_layout Description
1534 Action Pastes material (text or picture) from the active clipboard.
1536 \begin_layout Description
1537 Syntax paste [<TYPE>|<NUM>]
1539 \begin_layout Description
1540 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1541 \begin_inset Newline newline
1544 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1547 \begin_layout Subsection*
1548 LFUN_CLIPBOARD_PASTE
1550 \begin_layout Description
1551 Action Pastes text from the active clipboard.
1553 \begin_layout Description
1554 Syntax clipboard-paste [<ARG>]
1556 \begin_layout Description
1557 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1559 \begin_layout Description
1560 Origin baum, 10 Jul 2006
1563 \begin_layout Subsection*
1564 LFUN_PRIMARY_SELECTION_PASTE
1566 \begin_layout Description
1567 Action Pastes the currently text selected text.
1569 \begin_layout Description
1570 Notion Primary selection mechanism is linux-only thing.
1572 \begin_layout Description
1573 Syntax primary-selection-paste [<ARG>]
1575 \begin_layout Description
1576 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1579 \begin_layout Subsection*
1580 LFUN_SELECTION_PASTE
1582 \begin_layout Description
1583 Action Pastes the text in permanent selection.
1585 \begin_layout Description
1586 Syntax selection-paste
1589 \begin_layout Subsection*
1592 \begin_layout Description
1593 Action Undoes the last edit.
1595 \begin_layout Description
1599 \begin_layout Subsection*
1602 \begin_layout Description
1603 Action Redoes the last thing undone.
1605 \begin_layout Description
1609 \begin_layout Subsection*
1612 \begin_layout Description
1613 Action Repeat the given command.
1615 \begin_layout Description
1616 Syntax repeat <COUNT> <LFUN-COMMAND>
1618 \begin_layout Description
1619 Origin Andre, 27 Oct 2003
1622 \begin_layout Subsection*
1623 LFUN_CHARS_TRANSPOSE
1625 \begin_layout Description
1626 Action Transposes the character at the cursor with the one before it.
1628 \begin_layout Description
1629 Syntax chars-transpose
1631 \begin_layout Description
1632 Origin Lgb, 25 Apr 2001
1635 \begin_layout Subsection*
1636 LFUN_DEPTH_DECREMENT
1638 \begin_layout Description
1639 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1641 \begin_layout Description
1642 Syntax depth-decrement
1645 \begin_layout Subsection*
1646 LFUN_DEPTH_INCREMENT
1648 \begin_layout Description
1649 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1651 \begin_layout Description
1652 Syntax depth-increment
1655 \begin_layout Subsection*
1658 \begin_layout Description
1659 Action Toggles the bold font (selection-wise) using mathbf in math.
1661 \begin_layout Description
1665 \begin_layout Subsection*
1666 LFUN_FONT_BOLDSYMBOL
1668 \begin_layout Description
1669 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1671 \begin_layout Description
1672 Syntax font-boldsymbol
1675 \begin_layout Subsection*
1676 LFUN_FONT_TYPEWRITER
1678 \begin_layout Description
1679 Action Toggles the typewriter family font (selection-wise).
1681 \begin_layout Description
1682 Syntax font-typewriter
1685 \begin_layout Subsection*
1688 \begin_layout Description
1689 Action Toggles underline in the font (selection-wise).
1691 \begin_layout Description
1692 Syntax font-underline
1695 \begin_layout Subsection*
1698 \begin_layout Description
1699 Action Toggles double underline in the font (selection-wise).
1701 \begin_layout Description
1702 Syntax font-underunderline
1704 \begin_layout Description
1705 Origin sanda, 5 May 2009
1708 \begin_layout Subsection*
1711 \begin_layout Description
1712 Action Toggles wavy underline in the font (selection-wise).
1714 \begin_layout Description
1715 Syntax font-underwave
1717 \begin_layout Description
1718 Origin sanda, 5 May 2009
1721 \begin_layout Subsection*
1724 \begin_layout Description
1725 Action Toggles strikeout (strike-through) in the font (selection-wise).
1727 \begin_layout Description
1728 Syntax font-strikeout
1730 \begin_layout Description
1731 Origin sanda, 3 May 2009
1734 \begin_layout Subsection*
1737 \begin_layout Description
1738 Action Toggles the emphasis font style (selection-wise).
1740 \begin_layout Description
1744 \begin_layout Subsection*
1747 \begin_layout Description
1748 Action Toggles Noun text style font (selection-wise).
1750 \begin_layout Description
1754 \begin_layout Subsection*
1757 \begin_layout Description
1758 Action Toggles Roman family font (selection-wise).
1760 \begin_layout Description
1764 \begin_layout Subsection*
1767 \begin_layout Description
1768 Action Toggles Sans Serif family font (selection-wise).
1770 \begin_layout Description
1774 \begin_layout Subsection*
1777 \begin_layout Description
1778 Action Toggles Fraktur family font (math-mode, selection-wise).
1780 \begin_layout Description
1783 \begin_layout Description
1784 Origin vermeer, 10 Jan 2002
1787 \begin_layout Subsection*
1790 \begin_layout Description
1791 Action Toggles Italics font shape (math-mode, selection-wise).
1793 \begin_layout Description
1796 \begin_layout Description
1797 Origin vermeer, 10 Jan 2002
1800 \begin_layout Subsection*
1803 \begin_layout Description
1804 Action Reverts the settings of the font to the default values (selection-wise).
1806 \begin_layout Description
1810 \begin_layout Subsection*
1813 \begin_layout Description
1814 Action Sets font size according to lyx format string.
1816 \begin_layout Description
1817 Syntax font-size <SIZE>
1819 \begin_layout Description
1820 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1821 \begin_inset Newline newline
1824 largest|huge|giant|increase|decrease|default
1827 \begin_layout Subsection*
1828 LFUN_TEXTSTYLE_APPLY
1830 \begin_layout Description
1831 Action Toggle user-defined (=last-time used) text style.
1833 \begin_layout Description
1834 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1836 \begin_layout Description
1837 Syntax textstyle-apply
1839 \begin_layout Description
1840 Origin leeming, 12 Mar 2003
1843 \begin_layout Subsection*
1844 LFUN_TEXTSTYLE_UPDATE
1846 \begin_layout Description
1847 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1849 \begin_layout Description
1850 Syntax textstyle-update <FONT_INFO>
1852 \begin_layout Description
1853 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1854 \begin_inset Newline newline
1857 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1859 \begin_layout Description
1860 Origin leeming, 12 Mar 2003
1863 \begin_layout Subsection*
1864 LFUN_SCREEN_FONT_UPDATE
1866 \begin_layout Description
1867 Action Update fonts and its metrics.
1869 \begin_layout Description
1870 Notion Automatically called after zoom, dpi, font names, or norm change.
1872 \begin_layout Description
1873 Syntax screen-font-update
1875 \begin_layout Description
1876 Origin ARRae, 13 Aug 2000
1879 \begin_layout Subsection*
1882 \begin_layout Description
1883 Action Returns the info about the current font.
1885 \begin_layout Description
1889 \begin_layout Subsection*
1890 LFUN_CITATION_INSERT
1892 \begin_layout Description
1893 Action Inserts citation from loaded citation database.
1895 \begin_layout Description
1896 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1898 \begin_layout Description
1899 Params <KEY>: Citation (shortcut listed in available citations).
1900 \begin_inset Newline newline
1903 <TEXT_BEFORE>: text which should appear before citation.
1905 \begin_layout Description
1906 Origin AAS, 97-02-23
1909 \begin_layout Subsection*
1910 LFUN_BIBTEX_DATABASE_ADD
1912 \begin_layout Description
1913 Action Adds database, which will be used for bibtex citations.
1915 \begin_layout Description
1916 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1918 \begin_layout Description
1919 Syntax bibtex-database-add <DATABASE-NAME>
1921 \begin_layout Description
1922 Origin Ale, 30 May 1997
1925 \begin_layout Subsection*
1926 LFUN_BIBTEX_DATABASE_DEL
1928 \begin_layout Description
1929 Action Adds database, which will be used for bibtex citations.
1931 \begin_layout Description
1932 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1934 \begin_layout Description
1935 Syntax bibtex-database-del <DATABASE-NAME>
1937 \begin_layout Description
1938 Origin Ale, 30 May 1997
1941 \begin_layout Subsection*
1944 \begin_layout Description
1945 Action Sets the layout (that is, environment) for the current paragraph.
1947 \begin_layout Description
1948 Syntax layout <LAYOUT>
1950 \begin_layout Description
1951 Params <LAYOUT>: the layout to use
1954 \begin_layout Subsection*
1955 LFUN_LAYOUT_PARAGRAPH
1957 \begin_layout Description
1958 Action Launches the paragraph settings dialog.
1960 \begin_layout Description
1961 Syntax layout-paragraph
1964 \begin_layout Subsection*
1967 \begin_layout Description
1968 Action Launches the tabular settings dialog.
1970 \begin_layout Description
1971 Syntax layout-tabular
1973 \begin_layout Description
1974 Origin Jug, 31 Jul 2000
1977 \begin_layout Subsection*
1978 LFUN_DROP_LAYOUTS_CHOICE
1980 \begin_layout Description
1981 Action Displays list of layout choices.
1983 \begin_layout Description
1984 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
1986 \begin_layout Description
1987 Syntax drop-layouts-choice
1990 \begin_layout Subsection*
1991 LFUN_LAYOUT_MODULES_CLEAR
1993 \begin_layout Description
1994 Action Clears the module list.
1996 \begin_layout Description
1997 Notion Clears the list of included modules for the current buffer.
1999 \begin_layout Description
2000 Syntax layout-modules-clear
2002 \begin_layout Description
2003 Origin rgh, 25 August 2007
2006 \begin_layout Subsection*
2007 LFUN_LAYOUT_MODULE_ADD
2009 \begin_layout Description
2010 Action Adds a module.
2012 \begin_layout Description
2013 Notion Adds a module to the list of included modules for the current buffer.
2015 \begin_layout Description
2016 Syntax layout-module-add <MODULE>
2018 \begin_layout Description
2019 Params <MODULE>: the module to be added
2021 \begin_layout Description
2022 Origin rgh, 25 August 2007
2025 \begin_layout Subsection*
2028 \begin_layout Description
2029 Action Reloads layout information.
2031 \begin_layout Description
2032 Notion Reloads all layout information for the current buffer from disk, thus recognizing any changes that have been made to layout files on the fly. This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
2034 \begin_layout Description
2035 Syntax layout-reload
2037 \begin_layout Description
2038 Origin rgh, 3 September 2007
2041 \begin_layout Subsection*
2042 LFUN_TEXTCLASS_APPLY
2044 \begin_layout Description
2045 Action Sets the text class for the current buffer.
2047 \begin_layout Description
2048 Syntax textclass-apply <TEXTCLASS>
2050 \begin_layout Description
2051 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2054 \begin_layout Subsection*
2057 \begin_layout Description
2058 Action Loads information for a textclass from disk.
2060 \begin_layout Description
2061 Syntax textclass-load <TEXTCLASS>
2063 \begin_layout Description
2064 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2067 \begin_layout Subsection*
2070 \begin_layout Description
2071 Action Disable selecting of text-region.
2073 \begin_layout Description
2077 \begin_layout Subsection*
2080 \begin_layout Description
2081 Action Enable selecting of text-region.
2083 \begin_layout Description
2084 Notion After enabling you can simply move arrow keys to get selected region.
2086 \begin_layout Description
2090 \begin_layout Subsection*
2093 \begin_layout Description
2094 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2096 \begin_layout Description
2099 \begin_layout Description
2100 Origin Andre, May 5 2006
2103 \begin_layout Subsection*
2106 \begin_layout Description
2107 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2109 \begin_layout Description
2110 Syntax math-delim [<LEFT>] [<RIGHT>]
2112 \begin_layout Description
2113 Params <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by either a LaTeX name or a valid character. ( is the default letter.
2115 \begin_layout Description
2116 Sample math-delim { rangle
2118 \begin_layout Description
2119 Origin Alejandro, 18 Jun 1996
2122 \begin_layout Subsection*
2125 \begin_layout Description
2126 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2128 \begin_layout Description
2129 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2131 \begin_layout Description
2132 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2133 \begin_inset Newline newline
2136 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2138 \begin_layout Description
2139 Sample math-bigdelim "Bigl" "
2145 \begin_layout Description
2146 Origin Enrico & Georg, 7 May 2006
2149 \begin_layout Subsection*
2152 \begin_layout Description
2153 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2155 \begin_layout Description
2156 Syntax math-display [<ARG>]
2158 \begin_layout Description
2159 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2161 \begin_layout Description
2162 Origin Alejandro, 18 Jun 1996
2165 \begin_layout Subsection*
2168 \begin_layout Description
2169 Action Inserts math objects and symbols.
2171 \begin_layout Description
2172 Syntax math-insert <ARG>
2174 \begin_layout Description
2175 Params <ARG>: Symbol or LaTeX code to be inserted.
2178 \begin_layout Subsection*
2181 \begin_layout Description
2182 Action Enters subscript expression in math expression.
2184 \begin_layout Description
2185 Syntax math-subscript
2187 \begin_layout Description
2188 Origin vermeer, 12 Dec 2001
2191 \begin_layout Subsection*
2192 LFUN_MATH_SUPERSCRIPT
2194 \begin_layout Description
2195 Action Enters subscript expression in math expression.
2197 \begin_layout Description
2198 Syntax math-superscript
2200 \begin_layout Description
2201 Origin vermeer, 12 Dec 2001
2204 \begin_layout Subsection*
2207 \begin_layout Description
2208 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.
2210 \begin_layout Description
2211 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2213 \begin_layout Description
2214 Syntax math-limits [<STATE>]
2216 \begin_layout Description
2217 Params <STATE>: limits|nolimits
2220 \begin_layout Subsection*
2223 \begin_layout Description
2224 Action Inserts a math macro definition at the cursor position in the text.
2226 \begin_layout Description
2227 Syntax math-macro <NAME> [<NARGS>] [def]
2229 \begin_layout Description
2230 Params <NAME>: The name of the macro, e.g. "mymacro".
2231 \begin_inset Newline newline
2234 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2236 \begin_layout Description
2237 Origin ale, 10 May 1997; sts, 21 Dec 2007
2240 \begin_layout Subsection*
2243 \begin_layout Description
2244 Action Mutates the type of math inset to the newly selected one.
2246 \begin_layout Description
2247 Syntax math-mutate <TYPE>
2249 \begin_layout Description
2250 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2252 \begin_layout Description
2253 Origin Andre, 23 May 2001
2256 \begin_layout Subsection*
2259 \begin_layout Description
2260 Action Inserts space into math expression.
2262 \begin_layout Description
2263 Notion Use spacebar after entering this space to change type of space.
2265 \begin_layout Description
2266 Syntax math-space [<TYPE>] [<LEN>]
2268 \begin_layout Description
2269 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2270 \begin_inset Newline newline
2273 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2274 \begin_inset Newline newline
2277 custom space: hspace
2278 \begin_inset Newline newline
2281 "," used by default.
2282 \begin_inset Newline newline
2285 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2286 \begin_inset Newline newline
2289 <LEN>: length for custom spaces (hspace)
2291 \begin_layout Description
2292 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2295 \begin_layout Subsection*
2298 \begin_layout Description
2299 Action Inserts a matrix.
2301 \begin_layout Description
2302 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2304 \begin_layout Description
2305 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).
2307 \begin_layout Description
2308 Sample math-matrix 3 3 bccc
2311 \begin_layout Subsection*
2314 \begin_layout Description
2315 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.
2317 \begin_layout Description
2318 Notion If there is some selected text, it puts the text inside created math box.
2320 \begin_layout Description
2321 Syntax math-mode [on|<ARG>]
2323 \begin_layout Description
2324 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2325 \begin_inset Newline newline
2328 "on": allow only entering of math mode from text mode.
2330 \begin_layout Description
2331 Origin Alejandro, 4 Jun 1996
2334 \begin_layout Subsection*
2337 \begin_layout Description
2338 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2340 \begin_layout Description
2341 Notion If there is any selected text, then it is moved inside the created regexp inset.
2343 \begin_layout Description
2344 Syntax regexp-mode [<ARG>]
2346 \begin_layout Description
2347 Params <ARG>: eventual argument (regular expression).
2349 \begin_layout Description
2350 Origin Tommaso, 4 Oct 2008
2353 \begin_layout Subsection*
2354 LFUN_MATH_NUMBER_LINE_TOGGLE
2356 \begin_layout Description
2357 Action Toggles numbering of the current formula line.
2359 \begin_layout Description
2360 Notion Must be in display formula mode.
2362 \begin_layout Description
2363 Syntax math-number-line-toggle
2365 \begin_layout Description
2366 Origin Alejandro, 18 Jun 1996
2369 \begin_layout Subsection*
2370 LFUN_MATH_NUMBER_TOGGLE
2372 \begin_layout Description
2373 Action Toggles numbering/labeling of the current formula.
2375 \begin_layout Description
2376 Notion Must be in display formula mode.
2378 \begin_layout Description
2379 Syntax math-number-toggle
2381 \begin_layout Description
2382 Origin Alejandro, 4 Jun 1996
2385 \begin_layout Subsection*
2388 \begin_layout Description
2389 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2391 \begin_layout Description
2392 Notion Selection can be used to determine the input for the external program.
2394 \begin_layout Description
2395 Syntax math-extern <LANG> [<COMMAND>]
2397 \begin_layout Description
2398 Params <LANG>: octave|maxima|maple|mathematica|script
2399 \begin_inset Newline newline
2402 where "script" stands fot the external script (normalized expression will be passed)
2404 \begin_layout Description
2405 Sample math-extern maple simplify
2407 \begin_layout Description
2408 Origin Andre, 24 Apr 2001
2411 \begin_layout Subsection*
2414 \begin_layout Description
2415 Action Changes arbitrarily the size used by math fonts inside a context.
2417 \begin_layout Description
2418 Notion Provides an interface to the LaTeX math mode font size commands.
2420 \begin_layout Description
2421 Syntax math-size <STYLE>
2423 \begin_layout Description
2434 \begin_layout Description
2435 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2438 \begin_layout Subsection*
2439 LFUN_MATH_FONT_STYLE
2441 \begin_layout Description
2442 Action Changes the text style used in math.
2444 \begin_layout Description
2445 Syntax math-font-style <STYLE>
2447 \begin_layout Description
2448 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2450 \begin_layout Description
2451 Origin vfr, 9 jan 2009
2454 \begin_layout Subsection*
2455 LFUN_MATH_MACRO_UNFOLD
2457 \begin_layout Description
2458 Action Unfold a Math Macro.
2460 \begin_layout Description
2461 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2465 \begin_layout Description
2466 Syntax math-macro-unfold
2468 \begin_layout Description
2469 Origin sts, 06 January 2008
2472 \begin_layout Subsection*
2473 LFUN_MATH_MACRO_FOLD
2475 \begin_layout Description
2476 Action Fold a Math Macro.
2478 \begin_layout Description
2479 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2483 \begin_layout Description
2484 Syntax math-macro-fold
2486 \begin_layout Description
2487 Origin sts, 06 January 2008
2490 \begin_layout Subsection*
2491 LFUN_MATH_MACRO_ADD_PARAM
2493 \begin_layout Description
2494 Action Add a parameter.
2496 \begin_layout Description
2497 Notion Add a parameter to a Math Macro.
2499 \begin_layout Description
2500 Syntax math-macro-add-param <NUM>
2502 \begin_layout Description
2503 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.
2505 \begin_layout Description
2506 Origin sts, 06 January 2008
2509 \begin_layout Subsection*
2510 LFUN_MATH_MACRO_REMOVE_PARAM
2512 \begin_layout Description
2513 Action Remove the last parameter.
2515 \begin_layout Description
2516 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2518 \begin_layout Description
2519 Syntax math-macro-remove-param <NUM>
2521 \begin_layout Description
2522 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2524 \begin_layout Description
2525 Origin sts, 06 January 2008
2528 \begin_layout Subsection*
2529 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2531 \begin_layout Description
2532 Action Append a greedy parameter.
2534 \begin_layout Description
2535 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2537 \begin_layout Description
2538 Syntax math-macro-append-greedy-param
2540 \begin_layout Description
2541 Origin sts, 06 January 2008
2544 \begin_layout Subsection*
2545 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2547 \begin_layout Description
2548 Action Remove a greedy parameter.
2550 \begin_layout Description
2551 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.
2553 \begin_layout Description
2554 Syntax math-macro-remove-greedy-param
2556 \begin_layout Description
2557 Origin sts, 06 January 2008
2560 \begin_layout Subsection*
2561 LFUN_MATH_MACRO_MAKE_OPTIONAL
2563 \begin_layout Description
2564 Action Make a parameter optional.
2566 \begin_layout Description
2567 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2569 \begin_layout Description
2570 Syntax math-macro-make-optional
2572 \begin_layout Description
2573 Origin sts, 06 January 2008
2576 \begin_layout Subsection*
2577 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2579 \begin_layout Description
2580 Action Make a parameter non-optional.
2582 \begin_layout Description
2583 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.
2585 \begin_layout Description
2586 Syntax math-macro-make-nonoptional
2588 \begin_layout Description
2589 Origin sts, 06 January 2008
2592 \begin_layout Subsection*
2593 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2595 \begin_layout Description
2596 Action Add an optional parameter.
2598 \begin_layout Description
2599 Notion Insert an optional parameter just behind the already existing optional parameters.
2601 \begin_layout Description
2602 Syntax math-macro-add-optional-param
2604 \begin_layout Description
2605 Origin sts, 06 January 2008
2608 \begin_layout Subsection*
2609 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2611 \begin_layout Description
2612 Action Remove the last optional parameter.
2614 \begin_layout Description
2615 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2617 \begin_layout Description
2618 Syntax math-macro-remove-optional-param
2620 \begin_layout Description
2621 Origin sts, 06 January 2008
2624 \begin_layout Subsection*
2625 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2627 \begin_layout Description
2628 Action Add a greedy optional parameter.
2630 \begin_layout Description
2631 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2633 \begin_layout Description
2634 Syntax math-macro-add-greedy-optional-param
2636 \begin_layout Description
2637 Origin sts, 06 January 2008
2640 \begin_layout Subsection*
2641 LFUN_IN_MATHMACROTEMPLATE
2643 \begin_layout Description
2644 Action Only active in Math Macro definition.
2646 \begin_layout Description
2647 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.
2649 \begin_layout Description
2650 Syntax in-mathmacrotemplate
2652 \begin_layout Description
2653 Origin sts, 06 January 2008
2656 \begin_layout Subsection*
2657 LFUN_PARAGRAPH_MOVE_DOWN
2659 \begin_layout Description
2660 Action Moves the current paragraph downwards in the document.
2662 \begin_layout Description
2663 Syntax paragraph-move-down
2665 \begin_layout Description
2666 Origin Edwin, 8 Apr 2006
2669 \begin_layout Subsection*
2670 LFUN_PARAGRAPH_MOVE_UP
2672 \begin_layout Description
2673 Action Moves the current paragraph upwards in the document.
2675 \begin_layout Description
2676 Syntax paragraph-move-up
2678 \begin_layout Description
2679 Origin Edwin, 8 Apr 2006
2682 \begin_layout Subsection*
2685 \begin_layout Description
2686 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2688 \begin_layout Description
2691 \begin_layout Description
2692 Origin Asger, 1 Oct 1996
2695 \begin_layout Subsection*
2696 LFUN_PARAGRAPH_UP_SELECT
2698 \begin_layout Description
2699 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2701 \begin_layout Description
2702 Syntax paragraph-up-select
2704 \begin_layout Description
2705 Origin Asger, 1 Oct 1996
2708 \begin_layout Subsection*
2711 \begin_layout Description
2712 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2714 \begin_layout Description
2715 Syntax paragraph-down
2717 \begin_layout Description
2718 Origin Asger, 1 Oct 1996
2721 \begin_layout Subsection*
2722 LFUN_PARAGRAPH_DOWN_SELECT
2724 \begin_layout Description
2725 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2727 \begin_layout Description
2728 Syntax paragraph-down-select
2730 \begin_layout Description
2731 Origin Asger, 1 Oct 1996
2734 \begin_layout Subsection*
2737 \begin_layout Description
2738 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2740 \begin_layout Description
2741 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).
2743 \begin_layout Description
2744 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2746 \begin_layout Description
2747 Params <PAR_ID_NUMBER>: paragraph id
2748 \begin_inset Newline newline
2751 <POSITION_IN_PAR>: desired position within the paragraph
2753 \begin_layout Description
2754 Origin Dekel, 26 Aug 2000
2757 \begin_layout Subsection*
2758 LFUN_BREAK_PARAGRAPH
2760 \begin_layout Description
2761 Action Breaks the current paragraph at the current location.
2763 \begin_layout Description
2764 Syntax break-paragraph
2767 \begin_layout Subsection*
2768 LFUN_BREAK_PARAGRAPH
2770 \begin_layout Description
2771 Action Breaks the current paragraph at the current location.
2773 \begin_layout Description
2774 Notion Removes the selection.
2776 \begin_layout Description
2777 Syntax break-paragraph [<LAYOUT>]
2779 \begin_layout Description
2780 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2783 \begin_layout Subsection*
2784 LFUN_PARAGRAPH_PARAMS
2786 \begin_layout Description
2787 Action Change paragraph settings.
2789 \begin_layout Description
2790 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.
2792 \begin_layout Description
2793 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2795 \begin_layout Description
2805 \begin_inset Newline newline
2810 paragraph_spacing default|single|onehalf|double|other
2811 \begin_inset Newline newline
2816 align block|left|right|center|default
2817 \begin_inset Newline newline
2822 labelwidthstring WIDTH|
2826 \begin_layout Description
2827 Origin rgh, Aug 15 2007
2830 \begin_layout Subsection*
2831 LFUN_PARAGRAPH_PARAMS_APPLY
2833 \begin_layout Description
2834 Action Change paragraph settings.
2836 \begin_layout Description
2837 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2839 \begin_layout Description
2840 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2842 \begin_layout Description
2843 Params For parameters see LFUN_PARAGRAPH_PARAMS
2845 \begin_layout Description
2846 Origin leeming, 30 Mar 2004
2849 \begin_layout Subsection*
2850 LFUN_PARAGRAPH_UPDATE
2852 \begin_layout Description
2853 Action Updates the values inside the paragraph dialog from the paragraph.
2855 \begin_layout Description
2856 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2858 \begin_layout Description
2859 Origin leeming, 13 Mar 2003
2862 \begin_layout Subsection*
2865 \begin_layout Description
2866 Action Move the current group in the upward direction in the structure of the document.
2868 \begin_layout Description
2869 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2871 \begin_layout Description
2874 \begin_layout Description
2875 Origin Vermeer, 23 Mar 2006
2878 \begin_layout Subsection*
2881 \begin_layout Description
2882 Action Move the current group in the downward direction in the structure of the document.
2884 \begin_layout Description
2885 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2887 \begin_layout Description
2890 \begin_layout Description
2891 Origin Vermeer, 23 Mar 2006
2894 \begin_layout Subsection*
2897 \begin_layout Description
2898 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2900 \begin_layout Description
2901 Notion Part -> Chapter -> Section -> etc.
2903 \begin_layout Description
2906 \begin_layout Description
2907 Origin Vermeer, 23 Mar 2006
2910 \begin_layout Subsection*
2913 \begin_layout Description
2914 Action Moves the current group in the upward direction in the hierarchy of the document structure.
2916 \begin_layout Description
2917 Notion Part <- Chapter <- Section <- etc.
2919 \begin_layout Description
2922 \begin_layout Description
2923 Origin Vermeer, 23 Mar 2006
2926 \begin_layout Subsection*
2929 \begin_layout Description
2930 Action Edit the inset at cursor with an external application, if one is attributed.
2932 \begin_layout Description
2933 Syntax inset-edit [<INSET_PARAMS>]
2935 \begin_layout Description
2936 Params <INSET_PARAMS>: Parameters for the inset.
2937 \begin_inset Newline newline
2940 Currently only the filename will be considered.
2942 \begin_layout Description
2943 Origin JSpitzm, 27 Apr 2006
2946 \begin_layout Subsection*
2949 \begin_layout Description
2950 Action Inserts table into the document.
2952 \begin_layout Description
2953 Syntax tabular-insert [<ROWS> <COLUMNS>]
2955 \begin_layout Description
2956 Params In case no arguments are given show insert dialog.
2958 \begin_layout Description
2959 Origin Jug, 12 Apr 2000
2962 \begin_layout Subsection*
2963 LFUN_TABULAR_FEATURE
2965 \begin_layout Description
2966 Action Sets various features to the table/cell on the current cursor position.
2968 \begin_layout Description
2969 Notion Various math-environment features are handled here as well, e.g. add-vline-left/right for the Grid/Array environment
2971 \begin_layout Description
2972 Syntax tabular-feature <FEATURE> [<ARG>]
2974 \begin_layout Description
2975 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
2976 \begin_inset Newline newline
2979 <ARG>: additional argument for some commands, use debug mode to explore its values.
2981 \begin_layout Description
2982 Origin Jug, 28 Jul 2000
2985 \begin_layout Subsection*
2988 \begin_layout Description
2989 Action Moves the cursor to the previous cell inside the table.
2991 \begin_layout Description
2992 Syntax cell-backward
2994 \begin_layout Description
2995 Origin Jug, 22 May 2000
2998 \begin_layout Subsection*
3001 \begin_layout Description
3002 Action Moves the cursor to the next cell inside the table.
3004 \begin_layout Description
3008 \begin_layout Subsection*
3011 \begin_layout Description
3012 Action Splits cell and shifts right part to the next cell (inside the math grid).
3014 \begin_layout Description
3017 \begin_layout Description
3018 Origin Ale, 15 May 1997
3021 \begin_layout Subsection*
3024 \begin_layout Description
3025 Action Register the document as an file inside version control system (RCS, CVS).
3027 \begin_layout Description
3028 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3029 \begin_inset Newline newline
3032 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3034 \begin_layout Description
3037 \begin_layout Description
3038 Origin Lgb, 1 Jul 1997
3041 \begin_layout Subsection*
3044 \begin_layout Description
3045 Action Checks-in/commits the changes of the registered file to the repository.
3047 \begin_layout Description
3048 Notion In RCS case this also unlocks the file.
3050 \begin_layout Description
3053 \begin_layout Description
3054 Origin Lgb, 1 Jul 1997
3057 \begin_layout Subsection*
3060 \begin_layout Description
3061 Action Checks-out the document for edit (and locks it for RCS).
3063 \begin_layout Description
3064 Notion This is implemented only for RCS and SVN, not CVS.
3066 \begin_layout Description
3069 \begin_layout Description
3070 Origin Lgb, 1 Jul 1997
3073 \begin_layout Subsection*
3076 \begin_layout Description
3077 Action Reverts the document to the last check-in/commit in VCS.
3079 \begin_layout Description
3082 \begin_layout Description
3083 Origin Lgb, 1 Jul 1997
3086 \begin_layout Subsection*
3089 \begin_layout Description
3090 Action Undo last check-in.
3092 \begin_layout Description
3093 Notion This is currently implemented only for RCS.
3095 \begin_layout Description
3098 \begin_layout Description
3099 Origin Lgb, 1 Jul 1997
3102 \begin_layout Subsection*
3105 \begin_layout Description
3106 Action Executes external command. This command is intended to support additional VCS commands.
3108 \begin_layout Description
3109 Syntax vc-command <FLAG> <PATH> <COMMAND>
3111 \begin_layout Description
3112 Params <FLAG>: Flags for the command can be combined together.
3113 \begin_inset Newline newline
3116 U - dUmmy - no flags
3117 \begin_inset Newline newline
3120 D - Doc - need document loaded to proceed
3121 \begin_inset Newline newline
3124 I - dIrty - mark document dirty
3125 \begin_inset Newline newline
3128 R - Reload - ensure that the document is saved and reload it after command execution
3129 \begin_inset Newline newline
3132 M - Message - ask for input string (commit message)
3133 \begin_inset Newline newline
3136 <PATH>: path where to start. $$p will be replaced by the current document path.
3137 \begin_inset Newline newline
3140 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
3142 \begin_layout Description
3143 Sample vc-command DR $$p "svn up"
3145 \begin_layout Description
3146 Origin sanda, 13 Jan 2009
3149 \begin_layout Subsection*
3152 \begin_layout Description
3153 Action Toggles change tracking to on/off.
3155 \begin_layout Description
3156 Syntax changes-track
3158 \begin_layout Description
3159 Origin levon, 1 Oct 2002
3162 \begin_layout Subsection*
3165 \begin_layout Description
3166 Action Toggles showing of change tracking in typesetted output.
3168 \begin_layout Description
3169 Syntax changes-output
3171 \begin_layout Description
3172 Origin jspitzm, 21 Jan 2005
3175 \begin_layout Subsection*
3178 \begin_layout Description
3179 Action Moves the cursor to the position of the next change of the change tracking records.
3181 \begin_layout Description
3184 \begin_layout Description
3185 Origin schmitt, 4 Oct 2006
3188 \begin_layout Subsection*
3189 LFUN_CHANGE_PREVIOUS
3191 \begin_layout Description
3192 Action Moves the cursor to the position of the previous change of the change tracking records.
3194 \begin_layout Description
3195 Syntax change-previous
3197 \begin_layout Description
3198 Origin vfr, 4 Apr 2009
3201 \begin_layout Subsection*
3204 \begin_layout Description
3205 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3207 \begin_layout Description
3208 Syntax changes-merge
3210 \begin_layout Description
3211 Origin Levon, 16 Oct 2002
3214 \begin_layout Subsection*
3217 \begin_layout Description
3218 Action Accepts tracked change inside the selection.
3220 \begin_layout Description
3221 Syntax change-accept
3223 \begin_layout Description
3224 Origin Levon, 16 Oct 2002
3227 \begin_layout Subsection*
3230 \begin_layout Description
3231 Action Rejects tracked change inside the selection.
3233 \begin_layout Description
3234 Syntax change-accept
3236 \begin_layout Description
3237 Origin Levon, 16 Oct 2002
3240 \begin_layout Subsection*
3241 LFUN_ALL_CHANGES_ACCEPT
3243 \begin_layout Description
3244 Action Accepts all tracked changes in the document.
3246 \begin_layout Description
3247 Syntax all-changes-accept
3249 \begin_layout Description
3250 Origin Levon, 16 Oct 2002
3253 \begin_layout Subsection*
3254 LFUN_ALL_CHANGES_REJECT
3256 \begin_layout Description
3257 Action Rejects all tracked changes in the document.
3259 \begin_layout Description
3260 Notion Reject does not work recursively; the user may have to repeat the operation.
3262 \begin_layout Description
3263 Syntax all-changes-reject
3265 \begin_layout Description
3266 Origin Levon, 16 Oct 2002
3269 \begin_layout Subsection*
3272 \begin_layout Description
3273 Action Apply data for an inset.
3275 \begin_layout Description
3276 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.
3278 \begin_layout Description
3279 Syntax inset-apply <ARGS>
3281 \begin_layout Description
3282 Params See LFUN_INSET_INSERT .
3285 \begin_layout Subsection*
3288 \begin_layout Description
3289 Action Dissolve the current inset into text.
3291 \begin_layout Description
3292 Syntax inset-dissolve [<INSET>]
3294 \begin_layout Description
3295 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.
3296 \begin_inset Newline newline
3299 For values see lyx::InsetLayout::lyxtype_ .
3301 \begin_layout Description
3302 Origin JSpitz, 7 Aug 2006
3305 \begin_layout Subsection*
3308 \begin_layout Description
3309 Action Insert new inset (type given by the parameters).
3311 \begin_layout Description
3312 Syntax inset-insert <INSET> <ARGS>
3314 \begin_layout Description
3315 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|include|index|label|nomencl|vspace|ref|toc>
3316 \begin_inset Newline newline
3319 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3321 \begin_layout Description
3322 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3325 \begin_inset Newline newline
3328 where <label name> is the name of the referenced label and <Format> is one of the following:
3329 \begin_inset Newline newline
3333 \begin_inset Newline newline
3336 eqref -- (<reference>)
3337 \begin_inset Newline newline
3341 \begin_inset Newline newline
3344 vpageref -- on <page>
3345 \begin_inset Newline newline
3348 vref -- <reference> on <page>
3349 \begin_inset Newline newline
3352 prettyref -- Formatted reference
3355 \begin_layout Subsection*
3358 \begin_layout Description
3359 Action Modify existing inset.
3361 \begin_layout Description
3362 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3364 \begin_layout Description
3365 Syntax inset-modify <INSET> <ARGS>
3367 \begin_layout Description
3368 Params See LFUN_INSET_INSERT for further details.
3371 \begin_layout Subsection*
3372 LFUN_NEXT_INSET_MODIFY
3374 \begin_layout Description
3375 Action Modify the inset at cursor position, if there is one.
3377 \begin_layout Description
3378 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3380 \begin_layout Description
3381 Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
3383 \begin_layout Description
3384 Params See LFUN_INSET_INSERT for further details.
3386 \begin_layout Description
3387 Origin JSpitzm, 23 Mar 2008
3390 \begin_layout Subsection*
3391 LFUN_INSET_DIALOG_UPDATE
3393 \begin_layout Description
3394 Action Updates the values inside the dialog from the inset.
3396 \begin_layout Description
3397 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3399 \begin_layout Description
3400 Params <DIALOG-NAME>
3402 \begin_layout Description
3403 Origin leeming, 25 Feb 2003
3406 \begin_layout Subsection*
3409 \begin_layout Description
3410 Action Open the inset's properties dialog.
3412 \begin_layout Description
3413 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.
3415 \begin_layout Description
3416 Syntax inset-settings <INSET>
3418 \begin_layout Description
3419 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>.
3422 \begin_layout Subsection*
3425 \begin_layout Description
3426 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3428 \begin_layout Description
3429 Syntax inset-toggle [<ARG>]
3431 \begin_layout Description
3432 Params <ARG>: <open|close|toggle|assign>.
3433 \begin_inset Newline newline
3436 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3437 \begin_inset Newline newline
3440 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3442 \begin_layout Description
3443 Origin lasgouttes, 19 Jul 2001
3446 \begin_layout Subsection*
3447 LFUN_ALL_INSETS_TOGGLE
3449 \begin_layout Description
3450 Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
3452 \begin_layout Description
3453 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
3455 \begin_layout Description
3456 Syntax all-insets-toggle [<STATE>] [<INSET>]
3458 \begin_layout Description
3459 Params <STATE>: <toggle|open|close|assign> default: toggle
3460 \begin_inset Newline newline
3463 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
3465 \begin_layout Description
3466 Origin leeming, 30 Mar 2004
3469 \begin_layout Subsection*
3470 LFUN_SET_GRAPHICS_GROUP
3472 \begin_layout Description
3473 Action Set the group for the graphics inset on the cursor position.
3475 \begin_layout Description
3476 Syntax set-graphics-group [<GROUP>]
3478 \begin_layout Description
3479 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3481 \begin_layout Description
3482 Origin sanda, 6 May 2008
3485 \begin_layout Subsection*
3486 LFUN_FINISHED_FORWARD
3488 \begin_layout Description
3489 Action Moves the cursor out of the current slice, going forward.
3491 \begin_layout Description
3492 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.
3495 \begin_layout Subsection*
3496 LFUN_FINISHED_BACKWARD
3498 \begin_layout Description
3499 Action Moves the cursor out of the current slice, going backwards.
3501 \begin_layout Description
3502 Notion See also LFUN_FINISHED_FORWARD.
3505 \begin_layout Subsection*
3508 \begin_layout Description
3509 Action Moves the cursor out of the current slice, going right.
3511 \begin_layout Description
3512 Notion See also LFUN_FINISHED_FORWARD
3515 \begin_layout Subsection*
3518 \begin_layout Description
3519 Action Moves the cursor out of the current slice, going left.
3521 \begin_layout Description
3522 Notion See also LFUN_FINISHED_FORWARD.
3525 \begin_layout Subsection*
3528 \begin_layout Description
3529 Action Set language from the current cursor position.
3531 \begin_layout Description
3532 Syntax language <LANG>
3534 \begin_layout Description
3535 Params <LANG>: Requested language. Look in lib/languages for the list.
3537 \begin_layout Description
3538 Origin Dekel, 2 Mar 2000
3541 \begin_layout Subsection*
3544 \begin_layout Description
3545 Action Goto a label.
3547 \begin_layout Description
3548 Syntax label-goto [<LABEL>]
3550 \begin_layout Description
3551 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.
3553 \begin_layout Description
3554 Origin Ale, 6 Aug 1997
3557 \begin_layout Subsection*
3560 \begin_layout Description
3561 Action Inserts label to text or displayed formula.
3563 \begin_layout Description
3564 Syntax label-insert [<LABEL>]
3566 \begin_layout Description
3567 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3570 \begin_layout Subsection*
3573 \begin_layout Description
3574 Action Go to the next label or cross-reference.
3576 \begin_layout Description
3577 Syntax reference-next
3579 \begin_layout Description
3580 Origin Dekel, 14 Jan 2001
3583 \begin_layout Subsection*
3586 \begin_layout Description
3587 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3589 \begin_layout Description
3590 Notion Bookmark 0 has a special purpose. It is automatically set
3591 \begin_inset Newline newline
3594 1. to the paragraph you are currently editing
3595 \begin_inset Newline newline
3598 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3599 \begin_inset Newline newline
3602 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3604 \begin_layout Description
3605 Syntax bookmark-goto <NUMBER>
3607 \begin_layout Description
3608 Params <NUMBER>: the number of the bookmark to restore.
3610 \begin_layout Description
3611 Origin Dekel, 27 January 2001
3614 \begin_layout Subsection*
3617 \begin_layout Description
3618 Action Save a bookmark.
3620 \begin_layout Description
3621 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.
3623 \begin_layout Description
3624 Syntax bookmark-save <NUMBER>
3626 \begin_layout Description
3627 Params <NUMBER>: the number of the bookmark to save.
3629 \begin_layout Description
3630 Origin Dekel, 27 January 2001
3633 \begin_layout Subsection*
3636 \begin_layout Description
3637 Action Clears the list of saved bookmarks.
3639 \begin_layout Description
3640 Syntax bookmark-clear
3642 \begin_layout Description
3643 Origin bpeng, 31 October 2006
3646 \begin_layout Subsection*
3649 \begin_layout Description
3650 Action Open the given help file according to the language setting.
3652 \begin_layout Description
3653 Syntax help-open <FILE>[.lyx]
3655 \begin_layout Description
3656 Params <FILE>: any document from (/usr/share/)doc directory.
3658 \begin_layout Description
3659 Origin Jug, 27 Jun 1999
3662 \begin_layout Subsection*
3665 \begin_layout Description
3666 Action Terminates the current LyX instance.
3668 \begin_layout Description
3669 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3671 \begin_layout Description
3675 \begin_layout Subsection*
3678 \begin_layout Description
3679 Action Toggles visibility of a given toolbar between on/off/auto.
3681 \begin_layout Description
3682 Notion Skiping "auto" when allowauto is false.
3684 \begin_layout Description
3685 Syntax toolbar-toggle <NAME> [allowauto]
3687 \begin_layout Description
3688 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
3690 \begin_layout Description
3691 Origin Edwin, 21 May 2007
3694 \begin_layout Subsection*
3697 \begin_layout Description
3698 Action Opens the menu given by its name.
3700 \begin_layout Description
3701 Syntax menu-open <NAME>
3703 \begin_layout Description
3704 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3707 \begin_layout Subsection*
3710 \begin_layout Description
3711 Action Various UI visibility-toggling actions.
3713 \begin_layout Description
3714 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3716 \begin_layout Description
3717 Params statusbar : Toggle visibility of the statusbar.
3718 \begin_inset Newline newline
3721 menubar : Toggle visibility of the menubar.
3722 \begin_inset Newline newline
3725 scrollbar : Toggle visibility of the scrollbar.
3726 \begin_inset Newline newline
3729 frame : Toggle visibility of the frames around editing window.
3730 \begin_inset Newline newline
3733 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.
3735 \begin_layout Description
3736 Origin sanda, 9 Feb 2007
3739 \begin_layout Subsection*
3742 \begin_layout Description
3743 Action Creates new empty LyX window.
3745 \begin_layout Description
3746 Notion Already opened documents from the previous window can be found under View menu.
3748 \begin_layout Description
3749 Syntax window-new [<GEOMETRY>]
3751 \begin_layout Description
3752 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3754 \begin_layout Description
3755 Origin Abdel, 21 Oct 2006
3758 \begin_layout Subsection*
3761 \begin_layout Description
3762 Action Closes the current LyX window.
3764 \begin_layout Description
3767 \begin_layout Description
3768 Origin Abdel, 23 Oct 2006
3771 \begin_layout Subsection*
3774 \begin_layout Description
3775 Action Creates another split view of current buffer.
3777 \begin_layout Description
3778 Notion All split views act in the same way indpendently.
3780 \begin_layout Description
3781 Syntax split-view <vertical|horizontal>
3783 \begin_layout Description
3784 Params horizontal : The work areas are laid out side by side.
3785 \begin_inset Newline newline
3788 vertical : The work areas laid out vertically.
3790 \begin_layout Description
3791 Origin Abdel, 20 Feb 2008
3794 \begin_layout Subsection*
3795 LFUN_CLOSE_TAB_GROUP
3797 \begin_layout Description
3798 Action Close the current tab group.
3800 \begin_layout Description
3801 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
3803 \begin_layout Description
3804 Syntax close-tab-group
3806 \begin_layout Description
3807 Origin Abdel, 21 Feb 2008
3810 \begin_layout Subsection*
3813 \begin_layout Description
3814 Action Shows hidden dialog or create new one for a given function/inset settings etc.
3816 \begin_layout Description
3817 Syntax dialog-show <NAME> [<DATA>]
3819 \begin_layout Description
3820 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
3821 \begin_inset Newline newline
3824 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
3825 \begin_inset Newline newline
3828 href|include|index|index_print|info|label|listings|log|mathdelimiter|
3829 \begin_inset Newline newline
3832 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
3833 \begin_inset Newline newline
3836 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
3837 \begin_inset Newline newline
3840 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
3841 \begin_inset Newline newline
3844 <SPECIAL>: latexlog|vclog
3845 \begin_inset Newline newline
3848 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
3850 \begin_layout Description
3851 Origin leeming, 17 Jun 2003
3854 \begin_layout Subsection*
3855 LFUN_DIALOG_SHOW_NEW_INSET
3857 \begin_layout Description
3858 Action Shows hidden dialog or create new one for a given inset settings etc.
3860 \begin_layout Description
3861 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
3863 \begin_layout Description
3864 Syntax dialog-show-new-inset <NAME> [<DATA>]
3866 \begin_layout Description
3867 Params See LFUN_DIALOG_SHOW .
3869 \begin_layout Description
3870 Origin leeming, 25 Feb 2003
3873 \begin_layout Subsection*
3876 \begin_layout Description
3877 Action Updates the dialog values from the inset/paragraph/document.
3879 \begin_layout Description
3880 Syntax dialog-update <NAME>
3882 \begin_layout Description
3883 Params <NAME>: paragraph|prefs|<INSET>
3884 \begin_inset Newline newline
3889 \begin_layout Description
3890 Origin leeming, 25 Feb 2003
3893 \begin_layout Subsection*
3896 \begin_layout Description
3897 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
3899 \begin_layout Description
3900 Syntax dialog-hide <NAME>
3902 \begin_layout Description
3903 Params See LFUN_DIALOG_SHOW .
3905 \begin_layout Description
3906 Origin leeming, 25 Feb 2003
3909 \begin_layout Subsection*
3912 \begin_layout Description
3913 Action Toggles dialog between showed/hidden state.
3915 \begin_layout Description
3916 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
3918 \begin_layout Description
3919 Syntax dialog-toggle <NAME> [<DATA>]
3921 \begin_layout Description
3922 Params See LFUN_DIALOG_SHOW .
3924 \begin_layout Description
3925 Origin JSpitzm, 30 Apr 2007
3928 \begin_layout Subsection*
3929 LFUN_DIALOG_DISCONNECT_INSET
3931 \begin_layout Description
3932 Action Closes opened connection to opened inset.
3934 \begin_layout Description
3935 Notion Connection is used for apply functions.
3937 \begin_layout Description
3938 Syntax dialog-disconnect-inset <INSET-NAME>
3940 \begin_layout Description
3941 Origin leeming, 25 Feb 2003
3944 \begin_layout Subsection*
3947 \begin_layout Description
3948 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
3950 \begin_layout Description
3951 Notion This is internal LFUN, not to be used by users.
3953 \begin_layout Description
3954 Origin Andre, 9 Aug 2002
3957 \begin_layout Subsection*
3960 \begin_layout Description
3961 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
3963 \begin_layout Description
3964 Notion This is internal LFUN, not to be used by users.
3966 \begin_layout Description
3967 Origin Andre, 9 Aug 2002
3970 \begin_layout Subsection*
3973 \begin_layout Description
3974 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
3976 \begin_layout Description
3977 Notion This is internal LFUN, not to be used by users.
3979 \begin_layout Description
3980 Origin Andre, 9 Aug 2002
3983 \begin_layout Subsection*
3986 \begin_layout Description
3987 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
3989 \begin_layout Description
3990 Notion This is internal LFUN, not to be used by users.
3992 \begin_layout Description
3993 Origin Andre, 9 Aug 2002
3996 \begin_layout Subsection*
3999 \begin_layout Description
4000 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4002 \begin_layout Description
4003 Notion This is internal LFUN, not to be used by users.
4005 \begin_layout Description
4006 Origin Andre, 9 Aug 2002
4009 \begin_layout Subsection*
4012 \begin_layout Description
4013 Action Turn off the loaded keyboard map.
4015 \begin_layout Description
4019 \begin_layout Subsection*
4022 \begin_layout Description
4023 Action Turn on the primary keyboard map.
4025 \begin_layout Description
4026 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.
4027 \begin_inset Newline newline
4030 The language is to be set in the Preferences dialog.
4032 \begin_layout Description
4033 Syntax keymap-primary
4036 \begin_layout Subsection*
4037 LFUN_KEYMAP_SECONDARY
4039 \begin_layout Description
4040 Action Turn on the secondary keyboard map.
4042 \begin_layout Description
4043 Syntax keymap-secondary
4046 \begin_layout Subsection*
4049 \begin_layout Description
4050 Action Toggles keyboard maps (first/second/off).
4052 \begin_layout Description
4053 Syntax keymap-toggle
4055 \begin_layout Description
4056 Origin leeming, 30 Mar 2004
4059 \begin_layout Subsection*
4060 LFUN_SERVER_GET_LAYOUT
4062 \begin_layout Description
4063 Action Returns the current layout (that is environment) name on the cursor position.
4065 \begin_layout Description
4066 Syntax server-get-layout
4069 \begin_layout Subsection*
4070 LFUN_SERVER_GET_FILENAME
4072 \begin_layout Description
4073 Action Returns path and file name of the currently edited document.
4075 \begin_layout Description
4076 Syntax server-get-filename
4079 \begin_layout Subsection*
4080 LFUN_SERVER_GOTO_FILE_ROW
4082 \begin_layout Description
4083 Action Sets the cursor position based on the row number of generated TeX file.
4085 \begin_layout Description
4086 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).
4088 \begin_layout Description
4089 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4091 \begin_layout Description
4092 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.
4093 \begin_inset Newline newline
4096 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.
4098 \begin_layout Description
4099 Origin Edmar, 23 Dec 1998
4102 \begin_layout Subsection*
4105 \begin_layout Description
4106 Action Sends notify message about the last key-sequence to client.
4108 \begin_layout Description
4109 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4111 \begin_layout Description
4112 Syntax server-notify
4115 \begin_layout Subsection*
4118 \begin_layout Description
4119 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4121 \begin_layout Description
4122 Syntax server-set-xy <X> <Y>
4125 \begin_layout Subsection*
4128 \begin_layout Description
4129 Action Returns the coordinates of cursor position in the editing area.
4131 \begin_layout Description
4132 Syntax server-get-xy
4135 \begin_layout Subsection*
4138 \begin_layout Description
4139 Action Generates the code (literate programming).
4141 \begin_layout Description
4142 Notion Latex file with extension
4144 literate_extension is generated. Then LyX invokes
4146 build_command (with a default of``make'') to generate the code and
4148 build_error_filter to process the compilation error messages.
4149 \begin_inset Newline newline
4152 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:
4153 \begin_inset Newline newline
4158 build_command "my_script my_arguments"
4159 \begin_inset Newline newline
4164 build_error_filter differs from the
4166 literate_error_filter only in that the former will identify error messages from your compiler.
4168 \begin_layout Description
4169 Syntax build-program
4172 \begin_layout Subsection*
4173 LFUN_BUFFER_AUTO_SAVE
4175 \begin_layout Description
4176 Action Saves the current buffer to a temporary file.
4178 \begin_layout Description
4179 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4181 \begin_layout Description
4182 Syntax buffer-auto-save
4185 \begin_layout Subsection*
4186 LFUN_BUFFER_CHILD_OPEN
4188 \begin_layout Description
4189 Action Loads the given child document.
4191 \begin_layout Description
4192 Notion The current document is treated as a parent.
4194 \begin_layout Description
4195 Syntax buffer-child-open <FILE>
4197 \begin_layout Description
4198 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4200 \begin_layout Description
4201 Origin Ale, 28 May 1997
4204 \begin_layout Subsection*
4207 \begin_layout Description
4208 Action Runs chktex for the current document.
4210 \begin_layout Description
4211 Syntax buffer-chktex
4213 \begin_layout Description
4214 Origin Asger, 30 Oct 1997
4217 \begin_layout Subsection*
4218 LFUN_BUFFER_TOGGLE_COMPRESSION
4220 \begin_layout Description
4221 Action Toggles compression of the current document on/off.
4223 \begin_layout Description
4224 Syntax buffer-toggle-compression
4226 \begin_layout Description
4227 Origin bpeng, 27 Apr 2006
4230 \begin_layout Subsection*
4233 \begin_layout Description
4234 Action Closes the current buffer.
4236 \begin_layout Description
4237 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4239 \begin_layout Description
4243 \begin_layout Subsection*
4246 \begin_layout Description
4247 Action Exports the current buffer (document) to the given format.
4249 \begin_layout Description
4250 Syntax buffer-export <FORMAT>
4252 \begin_layout Description
4253 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.
4254 \begin_inset Newline newline
4257 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.
4259 \begin_layout Description
4260 Origin Lgb, 29 Jul 1997
4263 \begin_layout Subsection*
4264 LFUN_BUFFER_EXPORT_CUSTOM
4266 \begin_layout Description
4267 Action Exports the current buffer (document) from the given format using the given command on it.
4269 \begin_layout Description
4270 Syntax buffer-export-custom <FORMAT> <COMMAND>
4272 \begin_layout Description
4273 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4274 \begin_inset Newline newline
4277 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4279 \begin_layout Description
4280 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4282 \begin_layout Description
4283 Origin leeming, 27 Mar 2004
4286 \begin_layout Subsection*
4289 \begin_layout Description
4290 Action Prints the current document.
4292 \begin_layout Description
4293 Notion Many settings can be given via the preferences dialog.
4295 \begin_layout Description
4296 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4298 \begin_layout Description
4299 Params <TARGET> is either "printer" or "file".
4300 \begin_inset Newline newline
4303 <TARGER-NAME> is either "default" or file name or printer name.
4304 \begin_inset Newline newline
4307 <COMMAND> command ensuring the printing job.
4309 \begin_layout Description
4310 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4312 \begin_layout Description
4313 Origin leeming, 28 Mar 2004
4316 \begin_layout Subsection*
4319 \begin_layout Description
4320 Action Import a given file as a lyx document.
4322 \begin_layout Description
4323 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.
4325 \begin_layout Description
4326 Syntax buffer-import <FORMAT> [<FILE>]
4328 \begin_layout Description
4329 Origin Asger, 24 Jul 1998
4332 \begin_layout Subsection*
4335 \begin_layout Description
4336 Action Creates a new buffer (that is, document).
4338 \begin_layout Description
4339 Notion Implicit path can be set in Preferences dialog.
4341 \begin_layout Description
4342 Syntax buffer-new [<FILE>]
4344 \begin_layout Description
4345 Params <FILE>: filename of created file with absolute path.
4348 \begin_layout Subsection*
4349 LFUN_BUFFER_NEW_TEMPLATE
4351 \begin_layout Description
4352 Action Creates a new buffer (that is, document) from a template.
4354 \begin_layout Description
4355 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4357 \begin_layout Description
4358 Syntax buffer-new-template [<FILE>]
4360 \begin_layout Description
4361 Params <FILE>: filename of created file with absolute path.
4364 \begin_layout Subsection*
4367 \begin_layout Description
4368 Action Reverts opened document.
4370 \begin_layout Description
4371 Syntax buffer-reload
4373 \begin_layout Description
4374 Origin Asger, 2 Feb 1997
4377 \begin_layout Subsection*
4380 \begin_layout Description
4381 Action Switch to the given buffer.
4383 \begin_layout Description
4384 Notion This is useful also in case you need simultaneously more views of the edited document in different LyX windows.
4386 \begin_layout Description
4387 Syntax buffer-new-template <BUFFER>
4389 \begin_layout Description
4390 Params <BUFFER>: already opened document which is to be shown.
4393 \begin_layout Subsection*
4394 LFUN_BUFFER_TOGGLE_READ_ONLY
4396 \begin_layout Description
4397 Action Toggle editing mode of the current document between read/write and read-only.
4399 \begin_layout Description
4400 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.
4401 \begin_inset Newline newline
4404 If these operations fail, buffer won't be toggled.
4406 \begin_layout Description
4407 Syntax buffer-toggle-read-only
4409 \begin_layout Description
4410 Origin Lgb, 27 May 1997
4413 \begin_layout Subsection*
4416 \begin_layout Description
4417 Action Displays current buffer in chosen format.
4419 \begin_layout Description
4420 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.
4422 \begin_layout Description
4423 Syntax buffer-view [<FORMAT>]
4425 \begin_layout Description
4426 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.
4429 \begin_layout Subsection*
4432 \begin_layout Description
4433 Action Exports the current document and put the result into the temporary directory.
4435 \begin_layout Description
4436 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).
4438 \begin_layout Description
4439 Syntax buffer-update [<FORMAT>]
4441 \begin_layout Description
4442 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.
4444 \begin_layout Description
4445 Origin Dekel, 5 Aug 2000
4448 \begin_layout Subsection*
4451 \begin_layout Description
4452 Action Saves the current buffer.
4454 \begin_layout Description
4455 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.
4457 \begin_layout Description
4461 \begin_layout Subsection*
4462 LFUN_BUFFER_WRITE_AS
4464 \begin_layout Description
4465 Action Rename and save current buffer.
4467 \begin_layout Description
4468 Syntax buffer-write-as <FILENAME>
4470 \begin_layout Description
4471 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4474 \begin_layout Subsection*
4475 LFUN_BUFFER_WRITE_ALL
4477 \begin_layout Description
4478 Action Save all changed documents.
4480 \begin_layout Description
4481 Syntax buffer-write-all
4483 \begin_layout Description
4484 Origin rgh, gpothier 6 Aug 2007
4487 \begin_layout Subsection*
4490 \begin_layout Description
4491 Action Switch to the next opened document.
4493 \begin_layout Description
4494 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4496 \begin_layout Description
4500 \begin_layout Subsection*
4501 LFUN_BUFFER_PREVIOUS
4503 \begin_layout Description
4504 Action Switch to the previous opened document.
4506 \begin_layout Description
4507 Syntax buffer-previous
4510 \begin_layout Subsection*
4511 LFUN_MASTER_BUFFER_UPDATE
4513 \begin_layout Description
4514 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4516 \begin_layout Description
4517 Syntax master-buffer-update [<FORMAT>]
4519 \begin_layout Description
4520 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.
4522 \begin_layout Description
4523 Origin Tommaso, 20 Sep 2007
4526 \begin_layout Subsection*
4527 LFUN_MASTER_BUFFER_VIEW
4529 \begin_layout Description
4530 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4532 \begin_layout Description
4533 Syntax master-buffer-view [<FORMAT>]
4535 \begin_layout Description
4536 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.
4538 \begin_layout Description
4539 Origin Tommaso, 20 Sep 2007
4542 \begin_layout Subsection*
4543 LFUN_BUFFER_LANGUAGE
4545 \begin_layout Description
4546 Action Set language of the current document.
4548 \begin_layout Description
4549 Syntax buffer-language <LANG>
4551 \begin_layout Description
4552 Params <LANG>: language name. See lib/languages for list.
4554 \begin_layout Description
4555 Origin leeming, 30 Mar 2004
4558 \begin_layout Subsection*
4559 LFUN_BUFFER_SAVE_AS_DEFAULT
4561 \begin_layout Description
4562 Action Save the current document settings as default.
4564 \begin_layout Description
4565 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4567 \begin_layout Description
4568 Syntax buffer-save-as-default [<ARGS>]
4570 \begin_layout Description
4571 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4573 \begin_layout Description
4574 Origin leeming, 30 Mar 2004
4577 \begin_layout Subsection*
4578 LFUN_BUFFER_PARAMS_APPLY
4580 \begin_layout Description
4581 Action Apply the given settings to the current document.
4583 \begin_layout Description
4584 Syntax buffer-params-apply [<ARGS>]
4586 \begin_layout Description
4587 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4589 \begin_layout Description
4590 Origin leeming, 30 Mar 2004
4593 \begin_layout Subsection*
4596 \begin_layout Description
4597 Action Inserts another LyX file.
4599 \begin_layout Description
4600 Syntax file-insert [<FILE>]
4602 \begin_layout Description
4603 Params <FILE>: Filename to be inserted.
4606 \begin_layout Subsection*
4607 LFUN_FILE_INSERT_PLAINTEXT
4609 \begin_layout Description
4610 Action Inserts plain text file.
4612 \begin_layout Description
4613 Syntax file-insert-plaintext [<FILE>]
4615 \begin_layout Description
4616 Params <FILE>: Filename to be inserted.
4618 \begin_layout Description
4619 Origin CFO-G, 19 Nov 1997
4622 \begin_layout Subsection*
4623 LFUN_FILE_INSERT_PLAINTEXT_PARA
4625 \begin_layout Description
4626 Action Inserts plain text file as paragraph (i.e. join lines).
4628 \begin_layout Description
4629 Syntax file-insert-plaintext-para [<FILE>]
4631 \begin_layout Description
4632 Params <FILE>: Filename to be inserted.
4634 \begin_layout Description
4635 Origin Levon, 14 Feb 2001
4638 \begin_layout Subsection*
4641 \begin_layout Description
4642 Action Open LyX document.
4644 \begin_layout Description
4645 Syntax file-open [<FILE>]
4647 \begin_layout Description
4648 Params <FILE>: Filename to be opened.
4651 \begin_layout Subsection*
4654 \begin_layout Description
4655 Action Executes a command defined in a .def file.
4657 \begin_layout Description
4658 Notion The definitions are by default read from lib/commands/default.def.
4659 \begin_inset Newline newline
4662 A .def file allows to define a command with
4664 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).
4666 def_file "FileName" allows to include another .def file.
4667 \begin_inset Newline newline
4670 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.
4672 \begin_layout Description
4675 \begin_layout Description
4676 Params <NAME>: Name of the command that must be called.
4678 \begin_layout Description
4679 Origin broider, 2 Oct 2007
4682 \begin_layout Subsection*
4685 \begin_layout Description
4686 Action Simulate halting Meta key (Alt key on PCs).
4688 \begin_layout Description
4689 Notion Used for buffer editation not for GUI control.
4691 \begin_layout Description
4695 \begin_layout Subsection*
4698 \begin_layout Description
4699 Action Cancels sequence prepared by LFUN_META_PREFIX .
4701 \begin_layout Description
4705 \begin_layout Subsection*
4706 LFUN_COMMAND_EXECUTE
4708 \begin_layout Description
4709 Action Opens the minibuffer toolbar so that the user can type in there.
4711 \begin_layout Description
4712 Notion Usually bound to M-x shortcut.
4714 \begin_layout Description
4715 Syntax command-execute
4718 \begin_layout Subsection*
4721 \begin_layout Description
4722 Action Return the current key sequence and available options as a string.
4724 \begin_layout Description
4725 Notion No options are added if no current map exists.
4726 \begin_inset Newline newline
4729 This is probably usable only with connection to lyxserver.
4731 \begin_layout Description
4732 Syntax command-prefix
4735 \begin_layout Subsection*
4736 LFUN_COMMAND_SEQUENCE
4738 \begin_layout Description
4739 Action Run more commands (LFUN and its parameters) in a sequence.
4741 \begin_layout Description
4742 Syntax command-sequence <CMDS>
4744 \begin_layout Description
4745 Params <CMDS>: Sequence of commands separated by semicolons.
4747 \begin_layout Description
4748 Sample command-sequence cut; ert-insert; self-insert
4750 ; paste; self-insert {}; inset-toggle;
4752 \begin_layout Description
4753 Origin Andre, 11 Nov 1999
4756 \begin_layout Subsection*
4757 LFUN_COMMAND_ALTERNATIVES
4759 \begin_layout Description
4760 Action Runs the first listed command that is enabled.
4762 \begin_layout Description
4763 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
4765 \begin_layout Description
4766 Syntax command-alternatives <CMDS>
4768 \begin_layout Description
4769 Params <CMDS>: Sequence of commands separated by semicolons.
4771 \begin_layout Description
4772 Sample command-alternatives completion-accept;cell-forward
4774 \begin_layout Description
4775 Origin rgh, 24 September 2008
4778 \begin_layout Subsection*
4781 \begin_layout Description
4782 Action Shows message in statusbar (for script purposes).
4784 \begin_layout Description
4785 Syntax message <STRING>
4787 \begin_layout Description
4788 Origin Lgb, 8 Apr 2001
4791 \begin_layout Subsection*
4792 LFUN_PREFERENCES_SAVE
4794 \begin_layout Description
4795 Action Save user preferences.
4797 \begin_layout Description
4798 Syntax preferences-save
4800 \begin_layout Description
4801 Origin Lgb, 27 Nov 1999
4804 \begin_layout Subsection*
4807 \begin_layout Description
4808 Action Reconfigure the automatic settings.
4810 \begin_layout Description
4813 \begin_layout Description
4814 Origin Asger, 14 Feb 1997
4817 \begin_layout Subsection*
4820 \begin_layout Description
4821 Action Apply the given settings to user preferences.
4823 \begin_layout Description
4824 Syntax lyxrc-apply <SETTINGS>
4826 \begin_layout Description
4827 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.
4830 \begin_layout Subsection*
4831 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
4833 \begin_layout Description
4834 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
4836 \begin_layout Description
4837 Syntax toggle-cursor-follows-scrollbar
4839 \begin_layout Description
4840 Origin ARRae, 2 Dec 1997
4843 \begin_layout Subsection*
4846 \begin_layout Description
4847 Action Set the given LyX color to the color defined by the X11 name given.
4849 \begin_layout Description
4850 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
4852 \begin_layout Description
4853 Syntax set-color <LYX_NAME> <X11_NAME>
4855 \begin_layout Description
4856 Origin SLior, 11 Jun 2000
4859 \begin_layout Subsection*
4862 \begin_layout Description
4863 Action Count the statistics (number of words and characters) in the document or in the given selection.
4865 \begin_layout Description
4866 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
4868 \begin_layout Description
4871 \begin_layout Description
4872 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
4875 \begin_layout Subsection*
4876 LFUN_COMPLETION_INLINE
4878 \begin_layout Description
4879 Action Show the inline completion at the cursor position.
4881 \begin_layout Description
4882 Syntax completion-inline
4884 \begin_layout Description
4885 Origin sts, Feb 19 2008
4888 \begin_layout Subsection*
4889 LFUN_COMPLETION_POPUP
4891 \begin_layout Description
4892 Action Show the completion popup at the cursor position.
4894 \begin_layout Description
4895 Syntax completion-popup
4897 \begin_layout Description
4898 Origin sts, Feb 19 2008
4901 \begin_layout Subsection*
4902 LFUN_COMPLETION_COMPLETE
4904 \begin_layout Description
4905 Action Try to complete the word or command at the cursor position.
4907 \begin_layout Description
4910 \begin_layout Description
4911 Origin sts, Feb 19 2008
4914 \begin_layout Subsection*
4915 LFUN_COMPLETION_CANCEL
4917 \begin_layout Description
4918 Action Try to cancel completion, either the popup or the inline completion
4920 \begin_layout Description
4921 Syntax completion-cancel
4923 \begin_layout Description
4924 Origin sts, Sep 07 2008
4927 \begin_layout Subsection*
4928 LFUN_COMPLETION_ACCEPT
4930 \begin_layout Description
4931 Action Accept suggested completion.
4933 \begin_layout Description
4934 Syntax completion-accept
4936 \begin_layout Description
4937 Origin sanda, Sep 08 2008
4940 \begin_layout Subsection*
4941 LFUN_BRANCH_ACTIVATE
4943 \begin_layout Description
4944 Action Activate the branch
4946 \begin_layout Description
4947 Syntax branch-activate <BRANCH>
4949 \begin_layout Description
4950 Params <BRANCH>: The branch to activate
4952 \begin_layout Description
4953 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
4954 \begin_inset Newline newline
4957 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
4959 \begin_layout Description
4960 Origin rgh, 27 May 2008
4963 \begin_layout Subsection*
4964 LFUN_BRANCH_DEACTIVATE
4966 \begin_layout Description
4967 Action De-activate the branch
4969 \begin_layout Description
4970 Syntax branch-deactivate <BRANCH>
4972 \begin_layout Description
4973 Params <BRANCH>: The branch to deactivate
4975 \begin_layout Description
4976 Origin rgh, 27 May 2008
4979 \begin_layout Subsection*
4980 LFUN_LABEL_COPY_AS_REF
4982 \begin_layout Description
4983 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
4985 \begin_layout Description
4986 Syntax copy-label-as-reference <LABEL>
4988 \begin_layout Description
4989 Params <LABEL>: The label to copy (for multi-line math)
4991 \begin_layout Description
4992 Origin sts, 16 Nov 2008
4995 \begin_layout Subsection*
4996 LFUN_LABEL_INSERT_AS_REF
4998 \begin_layout Description
4999 Action Inserts the label as a cross-reference at the position of the cursor.
5001 \begin_layout Description
5002 Syntax label-insert-as-reference
5004 \begin_layout Description
5005 Origin vfr, 7 Apr 2009
5008 \begin_layout Subsection*
5011 \begin_layout Description
5012 Action Increases the zoom of the screen fonts.
5014 \begin_layout Description
5015 Syntax buffer-zoom-in [<ZOOM>]
5017 \begin_layout Description
5018 Params <ZOOM>: The zoom in %, the default is 20.
5020 \begin_layout Description
5021 Origin vfr, 30 Mar 2009
5024 \begin_layout Subsection*
5025 LFUN_BUFFER_ZOOM_OUT
5027 \begin_layout Description
5028 Action Decreases the zoom of the screen fonts.
5030 \begin_layout Description
5031 Syntax buffer-zoom-out [<ZOOM>]
5033 \begin_layout Description
5034 Params <ZOOM>: The zoom in %, the default is 20.
5036 \begin_layout Description
5037 Origin vfr, 30 Mar 2009
5040 \begin_layout Subsection*
5043 \begin_layout Description
5044 Action Selects the whole section.
5046 \begin_layout Description
5047 Notion The cursor should be in a section heading before calling this lfun.
5049 \begin_layout Description
5050 Syntax section-select
5052 \begin_layout Description
5053 Origin vfr, 05 May 2009