1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
7 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
8 \renewenvironment{description}{\list{}{%
9 \setlength{\itemsep}{-2pt}
10 \advance\leftmargini6\p@ \itemindent-12\p@
11 \labelwidth\z@ \let\makelabel\descriptionlabel}%
16 \use_default_options false
21 \font_typewriter default
22 \font_default_family default
29 \paperfontsize default
38 \paperorientation portrait
45 \paragraph_separation indent
47 \quotes_language english
50 \paperpagestyle default
51 \tracking_changes false
59 \begin_layout Section*
60 LFUNs documentation automatically generated 2010-09-12
63 \begin_layout Standard
67 \begin_layout Plain Layout
77 \begin_inset VSpace 1cm
82 \begin_layout Subsection*
85 \begin_layout Description
86 Action Adds an acute accent to the next character typed.
88 \begin_layout Description
92 \begin_layout Subsection*
95 \begin_layout Description
96 Action Adds a breve accent to the next character typed.
98 \begin_layout Description
102 \begin_layout Subsection*
105 \begin_layout Description
106 Action Adds a caron to the next character typed.
108 \begin_layout Description
112 \begin_layout Subsection*
115 \begin_layout Description
116 Action Adds a cedilla to the next character typed.
118 \begin_layout Description
119 Syntax accent-cedilla
122 \begin_layout Subsection*
125 \begin_layout Description
126 Action Adds a circle accent to the next character typed.
128 \begin_layout Description
132 \begin_layout Subsection*
133 LFUN_ACCENT_CIRCUMFLEX
135 \begin_layout Description
136 Action Adds a circumflex to the next character typed.
138 \begin_layout Description
139 Syntax accent-circumflex
142 \begin_layout Subsection*
145 \begin_layout Description
146 Action Adds a dot accent to the next character typed.
148 \begin_layout Description
152 \begin_layout Subsection*
155 \begin_layout Description
156 Action Adds a grave accent to the next character typed.
158 \begin_layout Description
162 \begin_layout Subsection*
163 LFUN_ACCENT_HUNGARIAN_UMLAUT
165 \begin_layout Description
166 Action Adds a Hungarian umlaut to the next character typed.
168 \begin_layout Description
172 \begin_layout Subsection*
175 \begin_layout Description
176 Action Adds a macron to the next character typed.
178 \begin_layout Description
182 \begin_layout Subsection*
185 \begin_layout Description
186 Action Adds an ogonek accent to the next character typed.
188 \begin_layout Description
192 \begin_layout Subsection*
195 \begin_layout Description
196 Action Adds a tie over the next two character typed.
198 \begin_layout Description
199 Notion The following char will finish the tie.
201 \begin_layout Description
205 \begin_layout Subsection*
208 \begin_layout Description
209 Action Adds a tilde over the next character typed.
211 \begin_layout Description
215 \begin_layout Subsection*
218 \begin_layout Description
219 Action Adds an umlaut over the next character typed.
221 \begin_layout Description
225 \begin_layout Subsection*
228 \begin_layout Description
229 Action Adds a bar under the next character typed.
231 \begin_layout Description
232 Syntax accent-underbar
235 \begin_layout Subsection*
238 \begin_layout Description
239 Action Adds a dot under the next character typed.
241 \begin_layout Description
242 Syntax accent-underdot
245 \begin_layout Subsection*
248 \begin_layout Description
249 Action Inserts a caption inset.
251 \begin_layout Description
252 Syntax caption-insert
254 \begin_layout Description
255 Origin Lgb, 18 Jul 2000
258 \begin_layout Subsection*
261 \begin_layout Description
262 Action Inserts the current date.
264 \begin_layout Description
265 Syntax date-insert [<ARG>]
267 \begin_layout Description
268 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.
270 \begin_layout Description
271 Origin jdblair, 31 Jan 2000
274 \begin_layout Subsection*
277 \begin_layout Description
278 Action Inserts a footnote inset.
280 \begin_layout Description
281 Syntax footnote-insert
283 \begin_layout Description
284 Origin Jug, 7 Mar 2000
287 \begin_layout Subsection*
290 \begin_layout Description
291 Action Inserts an ERT inset.
293 \begin_layout Description
296 \begin_layout Description
297 Origin Jug, 18 Feb 2000
300 \begin_layout Subsection*
303 \begin_layout Description
304 Action Inserts a float inset.
306 \begin_layout Description
307 Syntax float-insert <TYPE>
309 \begin_layout Description
310 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
312 \begin_layout Description
313 Origin Lgb, 27 Jun 2000
316 \begin_layout Subsection*
317 LFUN_FLOAT_WIDE_INSERT
319 \begin_layout Description
320 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
322 \begin_layout Description
323 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
325 \begin_layout Description
326 Syntax float-wide-insert <TYPE>
328 \begin_layout Description
329 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
331 \begin_layout Description
332 Origin Lgb, 31 Oct 2001
335 \begin_layout Subsection*
336 LFUN_FLOAT_LIST_INSERT
338 \begin_layout Description
339 Action Inserts the list of floats in the document.
341 \begin_layout Description
342 Syntax float-list-insert <TYPE>
344 \begin_layout Description
345 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
347 \begin_layout Description
348 Origin Lgb, 3 May 2001
351 \begin_layout Subsection*
354 \begin_layout Description
355 Action Inserts floats wrapped by the text around.
357 \begin_layout Description
358 Syntax wrap-insert <TYPE>
360 \begin_layout Description
361 Params <TYPE>: table|figure
363 \begin_layout Description
364 Origin Dekel, 7 Apr 2002
367 \begin_layout Subsection*
370 \begin_layout Description
371 Action Inserts an argument (short title) inset.
373 \begin_layout Description
374 Syntax argument-insert
376 \begin_layout Description
377 Origin vermeer, 12 Aug 2002
380 \begin_layout Subsection*
383 \begin_layout Description
384 Action Inserts a new page.
386 \begin_layout Description
387 Syntax newpage-insert <ARG>
389 \begin_layout Description
390 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
392 \begin_layout Description
393 Origin uwestoehr, 24 Nov 2007
396 \begin_layout Subsection*
397 LFUN_MARGINALNOTE_INSERT
399 \begin_layout Description
400 Action Inserts a marginal note.
402 \begin_layout Description
403 Syntax marginalnote-insert
405 \begin_layout Description
406 Origin Lgb, 26 Jun 2000
409 \begin_layout Subsection*
412 \begin_layout Description
413 Action Inserts a single unicode character.
415 \begin_layout Description
416 Syntax unicode-insert <CHAR>
418 \begin_layout Description
419 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
421 \begin_layout Description
422 Sample unicode-insert 0x0100
424 \begin_layout Description
425 Origin Lgb, 22 Oct 2006
428 \begin_layout Subsection*
431 \begin_layout Description
432 Action Inserts a new listings inset.
434 \begin_layout Description
435 Syntax listing-insert
437 \begin_layout Description
438 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
441 \begin_layout Subsection*
444 \begin_layout Description
445 Action Inserts a new preview inset.
447 \begin_layout Description
448 Syntax preview-insert
450 \begin_layout Description
451 Origin vfr, 28 Mar 2010
454 \begin_layout Subsection*
457 \begin_layout Description
458 Action Insert a tab into a listings inset.
460 \begin_layout Description
461 Notion It also works on a selection.
463 \begin_layout Description
466 \begin_layout Description
467 Origin vfr, Sep 30 2008
470 \begin_layout Subsection*
473 \begin_layout Description
474 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
476 \begin_layout Description
477 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.
479 \begin_layout Description
482 \begin_layout Description
483 Origin vfr, Sep 30 2008
486 \begin_layout Subsection*
489 \begin_layout Description
490 Action Inserts quotes according to the type and quote-language preference.
492 \begin_layout Description
493 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
495 \begin_layout Description
496 Syntax quote-insert [<TYPE>]
498 \begin_layout Description
499 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
502 \begin_layout Subsection*
505 \begin_layout Description
506 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
508 \begin_layout Description
509 Notion Apart from lfun arguments you can use the following method:
510 \begin_inset Newline newline
513 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
514 \begin_inset Newline newline
517 2. select the text and run info-insert lfun.
519 \begin_layout Description
520 Syntax info-insert <TYPE> <ARG>
522 \begin_layout Description
523 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
524 \begin_inset Newline newline
527 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
528 \begin_inset Newline newline
531 shortcut[s]: name of lfun (e.g math-insert
534 \begin_inset Newline newline
537 lyxrc: name of rc_entry (e.g. bind_file)
538 \begin_inset Newline newline
541 lyxinfo: "version" - used version of LyX
542 \begin_inset Newline newline
545 package: name of latex package (e.g. listings)
546 \begin_inset Newline newline
549 textclass: name of textclass (e.g. article)
550 \begin_inset Newline newline
553 menu: name of lfun used in menu
554 \begin_inset Newline newline
557 icon: name of lfun used in toolbar
558 \begin_inset Newline newline
561 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
563 \begin_layout Description
564 Sample command-sequence info-insert buffer path; info-insert buffer name
566 \begin_layout Description
567 Origin bpeng, 7 Oct 2007
570 \begin_layout Subsection*
573 \begin_layout Description
574 Action Inserts branch inset.
576 \begin_layout Description
577 Syntax branch-insert <BRANCH-NAME>
579 \begin_layout Description
580 Origin vermeer, 17 Aug 2003
583 \begin_layout Subsection*
586 \begin_layout Description
587 Action Inserts Box inset.
589 \begin_layout Description
590 Syntax box-insert [<TYPE>]
592 \begin_layout Description
593 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
594 \begin_inset Newline newline
597 Framed is the default one.
599 \begin_layout Description
600 Origin vermeer, 7 Oct 2003
603 \begin_layout Subsection*
606 \begin_layout Description
607 Action Inserts CharStyle, Custom inset or XML short element.
609 \begin_layout Description
610 Notion Look into the Customization manual for more information about these elements.
611 \begin_inset Newline newline
614 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.
615 \begin_inset Newline newline
618 For dissolving the element see LFUN_INSET_DISSOLVE.
620 \begin_layout Description
621 Syntax flex-insert <TYPE:Name>
623 \begin_layout Description
624 Params TYPE: CharStyle|Custom|Element|Standard
625 \begin_inset Newline newline
628 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.
629 \begin_inset Newline newline
632 Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
634 \begin_layout Description
635 Sample flex-insert CharStyle:Code
638 \begin_layout Subsection*
641 \begin_layout Description
642 Action Inserts the given string (accordingly to the correct keymap).
644 \begin_layout Description
645 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
647 \begin_layout Description
648 Syntax self-insert <STRING>
651 \begin_layout Subsection*
654 \begin_layout Description
655 Action Inserts one of horizontal space insets.
657 \begin_layout Description
658 Syntax space-insert <NAME> [<LEN>]
660 \begin_layout Description
661 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
662 \begin_inset Newline newline
665 <LEN>: length for custom spaces (hspace, hspace* for protected)
667 \begin_layout Description
668 Origin JSpitzm, 20 May 2003, Mar 17 2008
671 \begin_layout Subsection*
672 LFUN_HYPERLINK_INSERT
674 \begin_layout Description
675 Action Inserts hyperlinks into the document (clickable in pdf output).
677 \begin_layout Description
678 Notion Hyperlink target can be set via selection + hyperlink-insert function.
680 \begin_layout Description
681 Syntax href-insert [<TARGET>]
683 \begin_layout Description
684 Origin CFO-G, 21 Nov 1997
687 \begin_layout Subsection*
688 LFUN_SPECIALCHAR_INSERT
690 \begin_layout Description
691 Action Inserts various characters into the document.
693 \begin_layout Description
694 Syntax specialchar-insert <CHAR>
696 \begin_layout Description
697 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
699 \begin_layout Description
700 Origin JSpitzm, 6 Dec 2007
703 \begin_layout Subsection*
706 \begin_layout Description
707 Action Start (or remove) Appendix on the given cursor position.
709 \begin_layout Description
712 \begin_layout Description
713 Origin ettrich, 5 May 1998
716 \begin_layout Subsection*
719 \begin_layout Description
720 Action Inserts Index entry.
722 \begin_layout Description
723 Notion It automatically takes the word on the cursor position.
725 \begin_layout Description
726 Syntax index-insert [<TYPE:Name>]
728 \begin_layout Description
729 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
731 \begin_layout Description
732 Origin leeming, 3 Aug 2000
735 \begin_layout Subsection*
738 \begin_layout Description
739 Action Inserts list of Index entries on a new page.
741 \begin_layout Description
742 Syntax index-print [<TYPE:Name>]
744 \begin_layout Description
745 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
747 \begin_layout Description
748 Origin Lgb, 27 Feb 1997
751 \begin_layout Subsection*
754 \begin_layout Description
755 Action Inserts Nomenclature entry.
757 \begin_layout Description
758 Notion It automatically takes the word on the cursor position if no symbol is given.
760 \begin_layout Description
761 Syntax nomencl-insert [<SYMBOL>]
763 \begin_layout Description
764 Origin Ugras, 4 Nov 2006
767 \begin_layout Subsection*
768 LFUN_NOMENCLATURE_PRINT
770 \begin_layout Description
771 Action Inserts list of Nomenclature entries.
773 \begin_layout Description
774 Syntax nomenclature-print
776 \begin_layout Description
777 Origin Ugras, 4 Nov 2006
780 \begin_layout Subsection*
783 \begin_layout Description
784 Action Inserts Note on the current cursor postion, move selection inside the inset.
786 \begin_layout Description
787 Syntax note-insert [<TYPE>]
789 \begin_layout Description
790 Params <TYPE>: <Note|Greyedout|Comment> default: Note
793 \begin_layout Subsection*
796 \begin_layout Description
797 Action Moves the cursor to the begining of next Note inset.
799 \begin_layout Description
803 \begin_layout Subsection*
806 \begin_layout Description
807 Action Inserts phantom on the current cursor postion, move selection inside the inset.
809 \begin_layout Description
810 Syntax phantom-insert [<TYPE>]
812 \begin_layout Description
813 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
815 \begin_layout Description
816 Origin uwestoehr, 30 Jan 2009
819 \begin_layout Subsection*
822 \begin_layout Description
823 Action Inserts a line break or new line.
825 \begin_layout Description
826 Syntax newline-insert [<ARG>]
828 \begin_layout Description
829 Params <ARG>: <newline|linebreak> default: newline
831 \begin_layout Description
832 Origin JSpitzm, 25 Mar 2008
835 \begin_layout Subsection*
838 \begin_layout Description
839 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
841 \begin_layout Description
844 \begin_layout Description
845 Origin Lgb, 17 May 2001
848 \begin_layout Subsection*
851 \begin_layout Description
852 Action Moves the cursor one line in downward direction.
854 \begin_layout Description
858 \begin_layout Subsection*
861 \begin_layout Description
862 Action Moves the cursor one line in upward direction.
864 \begin_layout Description
868 \begin_layout Subsection*
871 \begin_layout Description
872 Action Moves the cursor one line in downward direction adding the current position to the selection.
874 \begin_layout Description
878 \begin_layout Subsection*
881 \begin_layout Description
882 Action Moves the cursor one line in upward direction adding the current position to the selection.
884 \begin_layout Description
888 \begin_layout Subsection*
891 \begin_layout Description
892 Action Moves the cursor one page in downward direction.
894 \begin_layout Description
898 \begin_layout Subsection*
901 \begin_layout Description
902 Action Moves the cursor one page in upward direction.
904 \begin_layout Description
908 \begin_layout Subsection*
909 LFUN_SCREEN_DOWN_SELECT
911 \begin_layout Description
912 Action Moves the cursor one screen in downward direction adding the current position to the selection.
914 \begin_layout Description
915 Syntax screen-down-select
918 \begin_layout Subsection*
919 LFUN_SCREEN_UP_SELECT
921 \begin_layout Description
922 Action Moves the cursor one page in upward direction adding the current position to the selection.
924 \begin_layout Description
925 Syntax screen-up-select
928 \begin_layout Subsection*
931 \begin_layout Description
932 Action Scroll the buffer view.
934 \begin_layout Description
935 Notion Only scrolls the screen up or down; does not move the cursor.
937 \begin_layout Description
938 Syntax scroll <TYPE> <QUANTITY>
940 \begin_layout Description
941 Params <TYPE>: line|page
942 \begin_inset Newline newline
945 <QUANTITY>: up|down|<number>
947 \begin_layout Description
948 Origin Abdel, Dec 27 2007
951 \begin_layout Subsection*
954 \begin_layout Description
955 Action Recenters the screen on the current cursor position.
957 \begin_layout Description
958 Syntax screen-recenter
961 \begin_layout Subsection*
962 LFUN_SCREEN_SHOW_CURSOR
964 \begin_layout Description
965 Action Repositions the screen such that the cursor is visible.
967 \begin_layout Description
968 Syntax screen-show-cursor
970 \begin_layout Description
971 Origin vfr, 25 Mar 2009
974 \begin_layout Subsection*
977 \begin_layout Description
978 Action Moves the cursor one position logically backwards.
980 \begin_layout Description
981 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.
983 \begin_layout Description
987 \begin_layout Subsection*
988 LFUN_CHAR_BACKWARD_SELECT
990 \begin_layout Description
991 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
993 \begin_layout Description
994 Notion See also LFUN_CHAR_BACKWARD.
996 \begin_layout Description
997 Syntax char-backward-select
1000 \begin_layout Subsection*
1001 LFUN_CHAR_DELETE_BACKWARD
1003 \begin_layout Description
1004 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1006 \begin_layout Description
1007 Syntax char-delete-backward
1010 \begin_layout Subsection*
1011 LFUN_CHAR_DELETE_FORWARD
1013 \begin_layout Description
1014 Action Deletes one character in the backward direction (usually the "Delete" key).
1016 \begin_layout Description
1017 Syntax char-delete-forward
1020 \begin_layout Subsection*
1023 \begin_layout Description
1024 Action Moves the cursor one position logically forward.
1026 \begin_layout Description
1027 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.
1029 \begin_layout Description
1033 \begin_layout Subsection*
1034 LFUN_CHAR_FORWARD_SELECT
1036 \begin_layout Description
1037 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1039 \begin_layout Description
1040 Notion See also LFUN_CHAR_FORWARD.
1042 \begin_layout Description
1043 Syntax char-forward-select
1046 \begin_layout Subsection*
1049 \begin_layout Description
1050 Action Moves the cursor one position "to the left".
1052 \begin_layout Description
1053 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.
1055 \begin_layout Description
1059 \begin_layout Subsection*
1060 LFUN_CHAR_LEFT_SELECT
1062 \begin_layout Description
1063 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1065 \begin_layout Description
1066 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1068 \begin_layout Description
1069 Syntax char-left-select
1072 \begin_layout Subsection*
1075 \begin_layout Description
1076 Action Moves the cursor one position "to the right".
1078 \begin_layout Description
1079 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.
1081 \begin_layout Description
1085 \begin_layout Subsection*
1086 LFUN_CHAR_RIGHT_SELECT
1088 \begin_layout Description
1089 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1091 \begin_layout Description
1092 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1094 \begin_layout Description
1095 Syntax char-right-select
1098 \begin_layout Subsection*
1101 \begin_layout Description
1102 Action Moves the cursor to the logically previous beginning of a word.
1104 \begin_layout Description
1105 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.
1107 \begin_layout Description
1108 Syntax word-backward
1111 \begin_layout Subsection*
1112 LFUN_WORD_BACKWARD_SELECT
1114 \begin_layout Description
1115 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1117 \begin_layout Description
1118 Notion See also LFUN_WORD_BACKWARD.
1120 \begin_layout Description
1121 Syntax word-backward-select
1124 \begin_layout Subsection*
1125 LFUN_WORD_DELETE_BACKWARD
1127 \begin_layout Description
1128 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1130 \begin_layout Description
1131 Syntax word-delete-backward
1134 \begin_layout Subsection*
1135 LFUN_WORD_DELETE_FORWARD
1137 \begin_layout Description
1138 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1140 \begin_layout Description
1141 Syntax word-delete-forward
1144 \begin_layout Subsection*
1145 LFUN_WORD_FIND_FORWARD
1147 \begin_layout Description
1148 Action Search for a given string in forward direction.
1150 \begin_layout Description
1151 Notion Case sensitive, match words. If no argument given, last search repeated.
1153 \begin_layout Description
1154 Syntax word-find-forward [<STRING>]
1156 \begin_layout Description
1157 Origin Etienne, 16 Feb 1998
1160 \begin_layout Subsection*
1161 LFUN_WORD_FIND_BACKWARD
1163 \begin_layout Description
1164 Action Search for a given string in backward direction.
1166 \begin_layout Description
1167 Notion Case sensitive, match words. If no argument given, last search repeated.
1169 \begin_layout Description
1170 Syntax word-find-backward [<STRING>]
1172 \begin_layout Description
1173 Origin Etienne, 20 Feb 1998
1176 \begin_layout Subsection*
1179 \begin_layout Description
1180 Action Search for next occurence of a string.
1182 \begin_layout Description
1183 Syntax word-find [<DATA>]
1185 \begin_layout Description
1186 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).
1188 \begin_layout Description
1189 Origin Andre, Jan 7 2004
1192 \begin_layout Subsection*
1195 \begin_layout Description
1196 Action Replace a string in the document.
1198 \begin_layout Description
1199 Syntax word-replace [<DATA>]
1201 \begin_layout Description
1202 Params <DATA>: data is of the form "<replace>
1203 \begin_inset Newline newline
1207 \begin_inset Newline newline
1210 <casesensitive> <matchword> <all> <forward>"
1212 \begin_layout Description
1213 Origin Andre, Jan 7 2004
1216 \begin_layout Subsection*
1219 \begin_layout Description
1220 Action Search for next occurence of a pattern.
1222 \begin_layout Description
1223 Syntax word-findadv [<DATA>]
1225 \begin_layout Description
1226 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).
1228 \begin_layout Description
1229 Origin Tommaso, Nov 15 2007
1232 \begin_layout Subsection*
1235 \begin_layout Description
1236 Action Moves the cursor to the logically next beginning of a word.
1238 \begin_layout Description
1239 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.
1241 \begin_layout Description
1245 \begin_layout Subsection*
1246 LFUN_WORD_FORWARD_SELECT
1248 \begin_layout Description
1249 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1251 \begin_layout Description
1252 Notion See also LFUN_WORD_FORWARD.
1254 \begin_layout Description
1255 Syntax word-forward-select
1258 \begin_layout Subsection*
1261 \begin_layout Description
1262 Action Moves the cursor to the next beginning of a word "on the left".
1264 \begin_layout Description
1265 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.
1267 \begin_layout Description
1270 \begin_layout Description
1271 Origin dov, 28 Oct 2007
1274 \begin_layout Subsection*
1275 LFUN_WORD_LEFT_SELECT
1277 \begin_layout Description
1278 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1280 \begin_layout Description
1281 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1283 \begin_layout Description
1284 Syntax word-left-select
1286 \begin_layout Description
1287 Origin dov, 28 Oct 2007
1290 \begin_layout Subsection*
1293 \begin_layout Description
1294 Action Moves the cursor to the next beginning of a word "on the right".
1296 \begin_layout Description
1297 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.
1299 \begin_layout Description
1302 \begin_layout Description
1303 Origin dov, 28 Oct 2007
1306 \begin_layout Subsection*
1307 LFUN_WORD_RIGHT_SELECT
1309 \begin_layout Description
1310 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1312 \begin_layout Description
1313 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1315 \begin_layout Description
1316 Syntax word-right-select
1318 \begin_layout Description
1319 Origin dov, 28 Oct 2007
1322 \begin_layout Subsection*
1325 \begin_layout Description
1326 Action Puts the word where the cursor stands into the selection.
1328 \begin_layout Description
1331 \begin_layout Description
1332 Origin Andre, 11 Sep 2002
1335 \begin_layout Subsection*
1336 LFUN_WORD_CAPITALIZE
1338 \begin_layout Description
1339 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1341 \begin_layout Description
1342 Syntax word-capitalize
1345 \begin_layout Subsection*
1348 \begin_layout Description
1349 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1351 \begin_layout Description
1355 \begin_layout Subsection*
1358 \begin_layout Description
1359 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1361 \begin_layout Description
1365 \begin_layout Subsection*
1368 \begin_layout Description
1369 Action Add the word under the cursor to the respective spell checker dictionary.
1371 \begin_layout Description
1372 Syntax spelling-add [<STRING>] [<LANG>]
1374 \begin_layout Description
1375 Params <WORD>: word to add <LANG>: language name (see file languages)
1377 \begin_layout Description
1378 Origin JSpitzm, 18 Jan 2010
1381 \begin_layout Subsection*
1382 LFUN_SPELLING_IGNORE
1384 \begin_layout Description
1385 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
1387 \begin_layout Description
1388 Syntax spelling-ignore [<WORD>] [<LANG>]
1390 \begin_layout Description
1391 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1393 \begin_layout Description
1394 Origin JSpitzm, 18 Jan 2010
1397 \begin_layout Subsection*
1398 LFUN_SPELLING_REMOVE
1400 \begin_layout Description
1401 Action Remove the word under the cursor from the respective spell checker dictionary.
1403 \begin_layout Description
1404 Syntax spelling-remove [<STRING>] [<LANG>]
1406 \begin_layout Description
1407 Params <WORD>: word to remove <LANG>: language name (see file languages)
1409 \begin_layout Description
1410 Origin SWitt, 28 July 2010
1413 \begin_layout Subsection*
1414 LFUN_THESAURUS_ENTRY
1416 \begin_layout Description
1417 Action Look up thesaurus entries with respect to the word under the cursor.
1419 \begin_layout Description
1420 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1422 \begin_layout Description
1423 Params <STRING>: word to look up <LANG>: language (see file languages)
1425 \begin_layout Description
1426 Origin Levon, 20 Jul 2001
1429 \begin_layout Subsection*
1432 \begin_layout Description
1433 Action Move the cursor to the beginning of the document.
1435 \begin_layout Description
1439 \begin_layout Subsection*
1440 LFUN_BUFFER_BEGIN_SELECT
1442 \begin_layout Description
1443 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1445 \begin_layout Description
1446 Syntax buffer-begin-select
1449 \begin_layout Subsection*
1452 \begin_layout Description
1453 Action Move the cursor to the end of the document.
1455 \begin_layout Description
1459 \begin_layout Subsection*
1460 LFUN_BUFFER_END_SELECT
1462 \begin_layout Description
1463 Action Move the cursor to the end of the document adding the traversed text to the selection.
1465 \begin_layout Description
1466 Syntax buffer-end-select
1469 \begin_layout Subsection*
1472 \begin_layout Description
1473 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
1475 \begin_layout Description
1478 \begin_layout Description
1479 Origin lasgouttes, 16 Mar 2009
1482 \begin_layout Subsection*
1483 LFUN_INSET_BEGIN_SELECT
1485 \begin_layout Description
1486 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).
1488 \begin_layout Description
1489 Syntax inset-begin-select
1491 \begin_layout Description
1492 Origin lasgouttes, 16 Mar 2009
1495 \begin_layout Subsection*
1498 \begin_layout Description
1499 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
1501 \begin_layout Description
1504 \begin_layout Description
1505 Origin lasgouttes, 16 Mar 2009
1508 \begin_layout Subsection*
1509 LFUN_INSET_END_SELECT
1511 \begin_layout Description
1512 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).
1514 \begin_layout Description
1515 Syntax inset-end-select
1517 \begin_layout Description
1518 Origin lasgouttes, 16 Mar 2009
1521 \begin_layout Subsection*
1522 LFUN_INSET_SELECT_ALL
1524 \begin_layout Description
1525 Action Selects all contents of an inset.
1527 \begin_layout Description
1528 Syntax inset-select-all
1530 \begin_layout Description
1531 Origin vfr, 22 Aug 2009
1534 \begin_layout Subsection*
1537 \begin_layout Description
1538 Action Selects the whole section.
1540 \begin_layout Description
1541 Notion The cursor should be in a section heading before calling this lfun.
1543 \begin_layout Description
1544 Syntax section-select
1546 \begin_layout Description
1547 Origin vfr, 05 May 2009
1550 \begin_layout Subsection*
1553 \begin_layout Description
1554 Action Move the cursor to the begining of the (screen) line.
1556 \begin_layout Description
1560 \begin_layout Subsection*
1561 LFUN_LINE_BEGIN_SELECT
1563 \begin_layout Description
1564 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1566 \begin_layout Description
1567 Syntax line-begin-select
1570 \begin_layout Subsection*
1573 \begin_layout Description
1574 Action Move the cursor to the end of the (screen) line.
1576 \begin_layout Description
1580 \begin_layout Subsection*
1581 LFUN_LINE_END_SELECT
1583 \begin_layout Description
1584 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1586 \begin_layout Description
1587 Syntax line-end-select
1590 \begin_layout Subsection*
1593 \begin_layout Description
1594 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1596 \begin_layout Description
1597 Syntax line-delete-forward
1600 \begin_layout Subsection*
1603 \begin_layout Description
1604 Action Copies to the clipboard the last edit.
1606 \begin_layout Description
1610 \begin_layout Subsection*
1613 \begin_layout Description
1614 Action Cuts to the clipboard.
1616 \begin_layout Description
1620 \begin_layout Subsection*
1623 \begin_layout Description
1624 Action Pastes material (text or picture) from the active clipboard.
1626 \begin_layout Description
1627 Syntax paste [<TYPE>|<NUM>]
1629 \begin_layout Description
1630 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1631 \begin_inset Newline newline
1634 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1637 \begin_layout Subsection*
1638 LFUN_CLIPBOARD_PASTE
1640 \begin_layout Description
1641 Action Pastes text from the active clipboard.
1643 \begin_layout Description
1644 Syntax clipboard-paste [<ARG>]
1646 \begin_layout Description
1647 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1649 \begin_layout Description
1650 Origin baum, 10 Jul 2006
1653 \begin_layout Subsection*
1654 LFUN_PRIMARY_SELECTION_PASTE
1656 \begin_layout Description
1657 Action Pastes the currently text selected text.
1659 \begin_layout Description
1660 Notion Primary selection mechanism is linux-only thing.
1662 \begin_layout Description
1663 Syntax primary-selection-paste [<ARG>]
1665 \begin_layout Description
1666 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1669 \begin_layout Subsection*
1670 LFUN_SELECTION_PASTE
1672 \begin_layout Description
1673 Action Pastes the text in permanent selection.
1675 \begin_layout Description
1676 Syntax selection-paste
1679 \begin_layout Subsection*
1682 \begin_layout Description
1683 Action Undoes the last edit.
1685 \begin_layout Description
1689 \begin_layout Subsection*
1692 \begin_layout Description
1693 Action Redoes the last thing undone.
1695 \begin_layout Description
1699 \begin_layout Subsection*
1702 \begin_layout Description
1703 Action Repeat the given command.
1705 \begin_layout Description
1706 Syntax repeat <COUNT> <LFUN-COMMAND>
1708 \begin_layout Description
1709 Origin Andre, 27 Oct 2003
1712 \begin_layout Subsection*
1713 LFUN_CHARS_TRANSPOSE
1715 \begin_layout Description
1716 Action Transposes the character at the cursor with the one before it.
1718 \begin_layout Description
1719 Syntax chars-transpose
1721 \begin_layout Description
1722 Origin Lgb, 25 Apr 2001
1725 \begin_layout Subsection*
1726 LFUN_DEPTH_DECREMENT
1728 \begin_layout Description
1729 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1731 \begin_layout Description
1732 Syntax depth-decrement
1735 \begin_layout Subsection*
1736 LFUN_DEPTH_INCREMENT
1738 \begin_layout Description
1739 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1741 \begin_layout Description
1742 Syntax depth-increment
1745 \begin_layout Subsection*
1748 \begin_layout Description
1749 Action Toggles the bold font (selection-wise) using mathbf in math.
1751 \begin_layout Description
1755 \begin_layout Subsection*
1756 LFUN_FONT_BOLDSYMBOL
1758 \begin_layout Description
1759 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1761 \begin_layout Description
1762 Syntax font-boldsymbol
1765 \begin_layout Subsection*
1766 LFUN_FONT_TYPEWRITER
1768 \begin_layout Description
1769 Action Toggles the typewriter family font (selection-wise).
1771 \begin_layout Description
1772 Syntax font-typewriter
1775 \begin_layout Subsection*
1778 \begin_layout Description
1779 Action Toggles underline in the font (selection-wise).
1781 \begin_layout Description
1782 Syntax font-underline
1785 \begin_layout Subsection*
1788 \begin_layout Description
1789 Action Toggles double underline in the font (selection-wise).
1791 \begin_layout Description
1792 Syntax font-underunderline
1794 \begin_layout Description
1795 Origin sanda, 5 May 2009
1798 \begin_layout Subsection*
1801 \begin_layout Description
1802 Action Toggles wavy underline in the font (selection-wise).
1804 \begin_layout Description
1805 Syntax font-underwave
1807 \begin_layout Description
1808 Origin sanda, 5 May 2009
1811 \begin_layout Subsection*
1814 \begin_layout Description
1815 Action Toggles strikeout (strike-through) in the font (selection-wise).
1817 \begin_layout Description
1818 Syntax font-strikeout
1820 \begin_layout Description
1821 Origin sanda, 3 May 2009
1824 \begin_layout Subsection*
1827 \begin_layout Description
1828 Action Toggles the emphasis font style (selection-wise).
1830 \begin_layout Description
1834 \begin_layout Subsection*
1837 \begin_layout Description
1838 Action Toggles Noun text style font (selection-wise).
1840 \begin_layout Description
1844 \begin_layout Subsection*
1847 \begin_layout Description
1848 Action Toggles Roman family font (selection-wise).
1850 \begin_layout Description
1854 \begin_layout Subsection*
1857 \begin_layout Description
1858 Action Toggles Sans Serif family font (selection-wise).
1860 \begin_layout Description
1864 \begin_layout Subsection*
1867 \begin_layout Description
1868 Action Toggles Fraktur family font (math-mode, selection-wise).
1870 \begin_layout Description
1873 \begin_layout Description
1874 Origin vermeer, 10 Jan 2002
1877 \begin_layout Subsection*
1880 \begin_layout Description
1881 Action Toggles Italics font shape (math-mode, selection-wise).
1883 \begin_layout Description
1886 \begin_layout Description
1887 Origin vermeer, 10 Jan 2002
1890 \begin_layout Subsection*
1893 \begin_layout Description
1894 Action Reverts the settings of the font to the default values (selection-wise).
1896 \begin_layout Description
1900 \begin_layout Subsection*
1903 \begin_layout Description
1904 Action Sets font size according to lyx format string.
1906 \begin_layout Description
1907 Syntax font-size <SIZE>
1909 \begin_layout Description
1910 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1911 \begin_inset Newline newline
1914 largest|huge|giant|increase|decrease|default
1917 \begin_layout Subsection*
1918 LFUN_TEXTSTYLE_APPLY
1920 \begin_layout Description
1921 Action Toggle user-defined (=last-time used) text style.
1923 \begin_layout Description
1924 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1926 \begin_layout Description
1927 Syntax textstyle-apply
1929 \begin_layout Description
1930 Origin leeming, 12 Mar 2003
1933 \begin_layout Subsection*
1934 LFUN_TEXTSTYLE_UPDATE
1936 \begin_layout Description
1937 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1939 \begin_layout Description
1940 Syntax textstyle-update <FONT_INFO>
1942 \begin_layout Description
1943 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1944 \begin_inset Newline newline
1947 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1949 \begin_layout Description
1950 Origin leeming, 12 Mar 2003
1953 \begin_layout Subsection*
1954 LFUN_SCREEN_FONT_UPDATE
1956 \begin_layout Description
1957 Action Update fonts and its metrics.
1959 \begin_layout Description
1960 Notion Automatically called after zoom, dpi, font names, or norm change.
1962 \begin_layout Description
1963 Syntax screen-font-update
1965 \begin_layout Description
1966 Origin ARRae, 13 Aug 2000
1969 \begin_layout Subsection*
1972 \begin_layout Description
1973 Action Returns the info about the current font.
1975 \begin_layout Description
1979 \begin_layout Subsection*
1980 LFUN_CITATION_INSERT
1982 \begin_layout Description
1983 Action Inserts citation from loaded citation database.
1985 \begin_layout Description
1986 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1988 \begin_layout Description
1989 Params <KEY>: Citation (shortcut listed in available citations).
1990 \begin_inset Newline newline
1993 <TEXT_BEFORE>: text which should appear before citation.
1995 \begin_layout Description
1996 Origin AAS, 97-02-23
1999 \begin_layout Subsection*
2000 LFUN_BIBTEX_DATABASE_ADD
2002 \begin_layout Description
2003 Action Adds database, which will be used for bibtex citations.
2005 \begin_layout Description
2006 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2008 \begin_layout Description
2009 Syntax bibtex-database-add <DATABASE-NAME>
2011 \begin_layout Description
2012 Origin Ale, 30 May 1997
2015 \begin_layout Subsection*
2016 LFUN_BIBTEX_DATABASE_DEL
2018 \begin_layout Description
2019 Action Adds database, which will be used for bibtex citations.
2021 \begin_layout Description
2022 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2024 \begin_layout Description
2025 Syntax bibtex-database-del <DATABASE-NAME>
2027 \begin_layout Description
2028 Origin Ale, 30 May 1997
2031 \begin_layout Subsection*
2034 \begin_layout Description
2035 Action Sets the layout (that is, environment) for the current paragraph.
2037 \begin_layout Description
2038 Syntax layout <LAYOUT>
2040 \begin_layout Description
2041 Params <LAYOUT>: the layout to use
2044 \begin_layout Subsection*
2045 LFUN_LAYOUT_PARAGRAPH
2047 \begin_layout Description
2048 Action Launches the paragraph settings dialog.
2050 \begin_layout Description
2051 Syntax layout-paragraph
2054 \begin_layout Subsection*
2057 \begin_layout Description
2058 Action Launches the tabular settings dialog.
2060 \begin_layout Description
2061 Syntax layout-tabular
2063 \begin_layout Description
2064 Origin Jug, 31 Jul 2000
2067 \begin_layout Subsection*
2068 LFUN_DROP_LAYOUTS_CHOICE
2070 \begin_layout Description
2071 Action Displays list of layout choices.
2073 \begin_layout Description
2074 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
2076 \begin_layout Description
2077 Syntax drop-layouts-choice
2080 \begin_layout Subsection*
2081 LFUN_LAYOUT_MODULES_CLEAR
2083 \begin_layout Description
2084 Action Clears the module list.
2086 \begin_layout Description
2087 Notion Clears the list of included modules for the current buffer.
2089 \begin_layout Description
2090 Syntax layout-modules-clear
2092 \begin_layout Description
2093 Origin rgh, 25 August 2007
2096 \begin_layout Subsection*
2097 LFUN_LAYOUT_MODULE_ADD
2099 \begin_layout Description
2100 Action Adds a module.
2102 \begin_layout Description
2103 Notion Adds a module to the list of included modules for the current buffer.
2105 \begin_layout Description
2106 Syntax layout-module-add <MODULE>
2108 \begin_layout Description
2109 Params <MODULE>: the module to be added
2111 \begin_layout Description
2112 Origin rgh, 25 August 2007
2115 \begin_layout Subsection*
2118 \begin_layout Description
2119 Action Reloads layout information.
2121 \begin_layout Description
2122 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.
2124 \begin_layout Description
2125 Syntax layout-reload
2127 \begin_layout Description
2128 Origin rgh, 3 September 2007
2131 \begin_layout Subsection*
2132 LFUN_TEXTCLASS_APPLY
2134 \begin_layout Description
2135 Action Sets the text class for the current buffer.
2137 \begin_layout Description
2138 Syntax textclass-apply <TEXTCLASS>
2140 \begin_layout Description
2141 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2144 \begin_layout Subsection*
2147 \begin_layout Description
2148 Action Loads information for a textclass from disk.
2150 \begin_layout Description
2151 Syntax textclass-load <TEXTCLASS>
2153 \begin_layout Description
2154 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2157 \begin_layout Subsection*
2160 \begin_layout Description
2161 Action Disable selecting of text-region.
2163 \begin_layout Description
2167 \begin_layout Subsection*
2170 \begin_layout Description
2171 Action Enable selecting of text-region.
2173 \begin_layout Description
2174 Notion After enabling you can simply move arrow keys to get selected region.
2176 \begin_layout Description
2180 \begin_layout Subsection*
2183 \begin_layout Description
2184 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2186 \begin_layout Description
2189 \begin_layout Description
2190 Origin Andre, May 5 2006
2193 \begin_layout Subsection*
2196 \begin_layout Description
2197 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2199 \begin_layout Description
2200 Syntax math-delim [<LEFT>] [<RIGHT>]
2202 \begin_layout Description
2203 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.
2205 \begin_layout Description
2206 Sample math-delim { rangle
2208 \begin_layout Description
2209 Origin Alejandro, 18 Jun 1996
2212 \begin_layout Subsection*
2215 \begin_layout Description
2216 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2218 \begin_layout Description
2219 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2221 \begin_layout Description
2222 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2223 \begin_inset Newline newline
2226 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2228 \begin_layout Description
2229 Sample math-bigdelim "Bigl" "
2235 \begin_layout Description
2236 Origin Enrico & Georg, 7 May 2006
2239 \begin_layout Subsection*
2242 \begin_layout Description
2243 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2245 \begin_layout Description
2246 Syntax math-display [<ARG>]
2248 \begin_layout Description
2249 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2251 \begin_layout Description
2252 Origin Alejandro, 18 Jun 1996
2255 \begin_layout Subsection*
2258 \begin_layout Description
2259 Action Inserts math objects and symbols.
2261 \begin_layout Description
2262 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
2264 frac{x}{y}"), the content of cell(0) is replaced by the current selection (only works if the selection is in mathed). As an example, if "abc" is selected in mathed, "math-insert
2266 frac{x}{y}" replaces "abc" with "
2268 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z". If nothing is selected (or the selection is not in mathed), math-insert works as expected.
2270 \begin_layout Description
2271 Syntax math-insert <ARG>
2273 \begin_layout Description
2274 Params <ARG>: Symbol or LaTeX code to be inserted.
2277 \begin_layout Subsection*
2280 \begin_layout Description
2281 Action Enters subscript expression in math expression.
2283 \begin_layout Description
2284 Syntax math-subscript
2286 \begin_layout Description
2287 Origin vermeer, 12 Dec 2001
2290 \begin_layout Subsection*
2291 LFUN_MATH_SUPERSCRIPT
2293 \begin_layout Description
2294 Action Enters subscript expression in math expression.
2296 \begin_layout Description
2297 Syntax math-superscript
2299 \begin_layout Description
2300 Origin vermeer, 12 Dec 2001
2303 \begin_layout Subsection*
2306 \begin_layout Description
2307 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.
2309 \begin_layout Description
2310 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2312 \begin_layout Description
2313 Syntax math-limits [<STATE>]
2315 \begin_layout Description
2316 Params <STATE>: limits|nolimits
2319 \begin_layout Subsection*
2322 \begin_layout Description
2323 Action Inserts a math macro definition at the cursor position in the text.
2325 \begin_layout Description
2326 Syntax math-macro <NAME> [<NARGS>] [def]
2328 \begin_layout Description
2329 Params <NAME>: The name of the macro, e.g. "mymacro".
2330 \begin_inset Newline newline
2333 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2335 \begin_layout Description
2336 Origin ale, 10 May 1997; sts, 21 Dec 2007
2339 \begin_layout Subsection*
2342 \begin_layout Description
2343 Action Mutates the type of math inset to the newly selected one.
2345 \begin_layout Description
2346 Syntax math-mutate <TYPE>
2348 \begin_layout Description
2349 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2351 \begin_layout Description
2352 Origin Andre, 23 May 2001
2355 \begin_layout Subsection*
2358 \begin_layout Description
2359 Action Inserts space into math expression.
2361 \begin_layout Description
2362 Notion Use spacebar after entering this space to change type of space.
2364 \begin_layout Description
2365 Syntax math-space [<TYPE>] [<LEN>]
2367 \begin_layout Description
2368 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2369 \begin_inset Newline newline
2372 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2373 \begin_inset Newline newline
2376 custom space: hspace
2377 \begin_inset Newline newline
2380 "," used by default.
2381 \begin_inset Newline newline
2384 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2385 \begin_inset Newline newline
2388 <LEN>: length for custom spaces (hspace)
2390 \begin_layout Description
2391 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2394 \begin_layout Subsection*
2397 \begin_layout Description
2398 Action Inserts a matrix.
2400 \begin_layout Description
2401 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2403 \begin_layout Description
2404 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).
2406 \begin_layout Description
2407 Sample math-matrix 3 3 bccc
2410 \begin_layout Subsection*
2411 LFUN_MATH_AMS_MATRIX
2413 \begin_layout Description
2414 Action Inserts a matrix.
2416 \begin_layout Description
2417 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
2419 \begin_layout Description
2420 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
2422 \begin_layout Description
2423 Sample math-ams-matrix 3 3 bmatrix
2426 \begin_layout Subsection*
2429 \begin_layout Description
2430 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.
2432 \begin_layout Description
2433 Notion If there is some selected text, it puts the text inside created math box.
2435 \begin_layout Description
2436 Syntax math-mode [on|<ARG>]
2438 \begin_layout Description
2439 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2440 \begin_inset Newline newline
2443 "on": allow only entering of math mode from text mode.
2445 \begin_layout Description
2446 Origin Alejandro, 4 Jun 1996
2449 \begin_layout Subsection*
2452 \begin_layout Description
2453 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2455 \begin_layout Description
2456 Notion If there is any selected text, then it is moved inside the created regexp inset.
2458 \begin_layout Description
2459 Syntax regexp-mode [<ARG>]
2461 \begin_layout Description
2462 Params <ARG>: eventual argument (regular expression).
2464 \begin_layout Description
2465 Origin Tommaso, 4 Oct 2008
2468 \begin_layout Subsection*
2469 LFUN_MATH_NUMBER_LINE_TOGGLE
2471 \begin_layout Description
2472 Action Toggles numbering of the current formula line.
2474 \begin_layout Description
2475 Notion Must be in display formula mode.
2477 \begin_layout Description
2478 Syntax math-number-line-toggle
2480 \begin_layout Description
2481 Origin Alejandro, 18 Jun 1996
2484 \begin_layout Subsection*
2485 LFUN_MATH_NUMBER_TOGGLE
2487 \begin_layout Description
2488 Action Toggles numbering/labeling of the current formula.
2490 \begin_layout Description
2491 Notion Must be in display formula mode.
2493 \begin_layout Description
2494 Syntax math-number-toggle
2496 \begin_layout Description
2497 Origin Alejandro, 4 Jun 1996
2500 \begin_layout Subsection*
2503 \begin_layout Description
2504 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2506 \begin_layout Description
2507 Notion Selection can be used to determine the input for the external program.
2509 \begin_layout Description
2510 Syntax math-extern <LANG> [<COMMAND>]
2512 \begin_layout Description
2513 Params <LANG>: octave|maxima|maple|mathematica|script
2514 \begin_inset Newline newline
2517 where "script" stands fot the external script (normalized expression will be passed)
2519 \begin_layout Description
2520 Sample math-extern maple simplify
2522 \begin_layout Description
2523 Origin Andre, 24 Apr 2001
2526 \begin_layout Subsection*
2529 \begin_layout Description
2530 Action Changes arbitrarily the size used by math fonts inside a context.
2532 \begin_layout Description
2533 Notion Provides an interface to the LaTeX math mode font size commands.
2535 \begin_layout Description
2536 Syntax math-size <STYLE>
2538 \begin_layout Description
2549 \begin_layout Description
2550 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2553 \begin_layout Subsection*
2554 LFUN_MATH_FONT_STYLE
2556 \begin_layout Description
2557 Action Changes the text style used in math.
2559 \begin_layout Description
2560 Syntax math-font-style <STYLE>
2562 \begin_layout Description
2563 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2565 \begin_layout Description
2566 Origin vfr, 9 jan 2009
2569 \begin_layout Subsection*
2570 LFUN_MATH_MACRO_UNFOLD
2572 \begin_layout Description
2573 Action Unfold a Math Macro.
2575 \begin_layout Description
2576 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2580 \begin_layout Description
2581 Syntax math-macro-unfold
2583 \begin_layout Description
2584 Origin sts, 06 January 2008
2587 \begin_layout Subsection*
2588 LFUN_MATH_MACRO_FOLD
2590 \begin_layout Description
2591 Action Fold a Math Macro.
2593 \begin_layout Description
2594 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2598 \begin_layout Description
2599 Syntax math-macro-fold
2601 \begin_layout Description
2602 Origin sts, 06 January 2008
2605 \begin_layout Subsection*
2606 LFUN_MATH_MACRO_ADD_PARAM
2608 \begin_layout Description
2609 Action Add a parameter.
2611 \begin_layout Description
2612 Notion Add a parameter to a Math Macro.
2614 \begin_layout Description
2615 Syntax math-macro-add-param <NUM>
2617 \begin_layout Description
2618 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.
2620 \begin_layout Description
2621 Origin sts, 06 January 2008
2624 \begin_layout Subsection*
2625 LFUN_MATH_MACRO_REMOVE_PARAM
2627 \begin_layout Description
2628 Action Remove the last parameter.
2630 \begin_layout Description
2631 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2633 \begin_layout Description
2634 Syntax math-macro-remove-param <NUM>
2636 \begin_layout Description
2637 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2639 \begin_layout Description
2640 Origin sts, 06 January 2008
2643 \begin_layout Subsection*
2644 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2646 \begin_layout Description
2647 Action Append a greedy parameter.
2649 \begin_layout Description
2650 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2652 \begin_layout Description
2653 Syntax math-macro-append-greedy-param
2655 \begin_layout Description
2656 Origin sts, 06 January 2008
2659 \begin_layout Subsection*
2660 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2662 \begin_layout Description
2663 Action Remove a greedy parameter.
2665 \begin_layout Description
2666 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.
2668 \begin_layout Description
2669 Syntax math-macro-remove-greedy-param
2671 \begin_layout Description
2672 Origin sts, 06 January 2008
2675 \begin_layout Subsection*
2676 LFUN_MATH_MACRO_MAKE_OPTIONAL
2678 \begin_layout Description
2679 Action Make a parameter optional.
2681 \begin_layout Description
2682 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2684 \begin_layout Description
2685 Syntax math-macro-make-optional
2687 \begin_layout Description
2688 Origin sts, 06 January 2008
2691 \begin_layout Subsection*
2692 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2694 \begin_layout Description
2695 Action Make a parameter non-optional.
2697 \begin_layout Description
2698 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.
2700 \begin_layout Description
2701 Syntax math-macro-make-nonoptional
2703 \begin_layout Description
2704 Origin sts, 06 January 2008
2707 \begin_layout Subsection*
2708 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2710 \begin_layout Description
2711 Action Add an optional parameter.
2713 \begin_layout Description
2714 Notion Insert an optional parameter just behind the already existing optional parameters.
2716 \begin_layout Description
2717 Syntax math-macro-add-optional-param
2719 \begin_layout Description
2720 Origin sts, 06 January 2008
2723 \begin_layout Subsection*
2724 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2726 \begin_layout Description
2727 Action Remove the last optional parameter.
2729 \begin_layout Description
2730 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2732 \begin_layout Description
2733 Syntax math-macro-remove-optional-param
2735 \begin_layout Description
2736 Origin sts, 06 January 2008
2739 \begin_layout Subsection*
2740 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2742 \begin_layout Description
2743 Action Add a greedy optional parameter.
2745 \begin_layout Description
2746 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2748 \begin_layout Description
2749 Syntax math-macro-add-greedy-optional-param
2751 \begin_layout Description
2752 Origin sts, 06 January 2008
2755 \begin_layout Subsection*
2756 LFUN_IN_MATHMACROTEMPLATE
2758 \begin_layout Description
2759 Action Only active in Math Macro definition.
2761 \begin_layout Description
2762 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.
2764 \begin_layout Description
2765 Syntax in-mathmacrotemplate
2767 \begin_layout Description
2768 Origin sts, 06 January 2008
2771 \begin_layout Subsection*
2772 LFUN_PARAGRAPH_MOVE_DOWN
2774 \begin_layout Description
2775 Action Moves the current paragraph downwards in the document.
2777 \begin_layout Description
2778 Syntax paragraph-move-down
2780 \begin_layout Description
2781 Origin Edwin, 8 Apr 2006
2784 \begin_layout Subsection*
2785 LFUN_PARAGRAPH_MOVE_UP
2787 \begin_layout Description
2788 Action Moves the current paragraph upwards in the document.
2790 \begin_layout Description
2791 Syntax paragraph-move-up
2793 \begin_layout Description
2794 Origin Edwin, 8 Apr 2006
2797 \begin_layout Subsection*
2800 \begin_layout Description
2801 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2803 \begin_layout Description
2806 \begin_layout Description
2807 Origin Asger, 1 Oct 1996
2810 \begin_layout Subsection*
2811 LFUN_PARAGRAPH_UP_SELECT
2813 \begin_layout Description
2814 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2816 \begin_layout Description
2817 Syntax paragraph-up-select
2819 \begin_layout Description
2820 Origin Asger, 1 Oct 1996
2823 \begin_layout Subsection*
2826 \begin_layout Description
2827 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2829 \begin_layout Description
2830 Syntax paragraph-down
2832 \begin_layout Description
2833 Origin Asger, 1 Oct 1996
2836 \begin_layout Subsection*
2837 LFUN_PARAGRAPH_DOWN_SELECT
2839 \begin_layout Description
2840 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2842 \begin_layout Description
2843 Syntax paragraph-down-select
2845 \begin_layout Description
2846 Origin Asger, 1 Oct 1996
2849 \begin_layout Subsection*
2852 \begin_layout Description
2853 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2855 \begin_layout Description
2856 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).
2858 \begin_layout Description
2859 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2861 \begin_layout Description
2862 Params <PAR_ID_NUMBER>: paragraph id
2863 \begin_inset Newline newline
2866 <POSITION_IN_PAR>: desired position within the paragraph
2868 \begin_layout Description
2869 Origin Dekel, 26 Aug 2000
2872 \begin_layout Subsection*
2873 LFUN_BREAK_PARAGRAPH
2875 \begin_layout Description
2876 Action Breaks the current paragraph at the current location.
2878 \begin_layout Description
2879 Notion Removes the selection.
2881 \begin_layout Description
2882 Syntax break-paragraph [<LAYOUT>]
2884 \begin_layout Description
2885 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2888 \begin_layout Subsection*
2889 LFUN_PARAGRAPH_PARAMS
2891 \begin_layout Description
2892 Action Change paragraph settings.
2894 \begin_layout Description
2895 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.
2897 \begin_layout Description
2898 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2900 \begin_layout Description
2910 \begin_inset Newline newline
2915 paragraph_spacing default|single|onehalf|double|other SIZE
2916 \begin_inset Newline newline
2921 align block|left|right|center|default
2922 \begin_inset Newline newline
2927 labelwidthstring WIDTH|
2931 \begin_layout Description
2932 Origin rgh, Aug 15 2007
2935 \begin_layout Subsection*
2936 LFUN_PARAGRAPH_PARAMS_APPLY
2938 \begin_layout Description
2939 Action Change paragraph settings.
2941 \begin_layout Description
2942 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2944 \begin_layout Description
2945 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2947 \begin_layout Description
2948 Params For parameters see LFUN_PARAGRAPH_PARAMS
2950 \begin_layout Description
2951 Origin leeming, 30 Mar 2004
2954 \begin_layout Subsection*
2955 LFUN_PARAGRAPH_UPDATE
2957 \begin_layout Description
2958 Action Updates the values inside the paragraph dialog from the paragraph.
2960 \begin_layout Description
2961 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2963 \begin_layout Description
2964 Origin leeming, 13 Mar 2003
2967 \begin_layout Subsection*
2970 \begin_layout Description
2971 Action Move the current group in the upward direction in the structure of the document.
2973 \begin_layout Description
2974 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2976 \begin_layout Description
2979 \begin_layout Description
2980 Origin Vermeer, 23 Mar 2006
2983 \begin_layout Subsection*
2986 \begin_layout Description
2987 Action Move the current group in the downward direction in the structure of the document.
2989 \begin_layout Description
2990 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2992 \begin_layout Description
2995 \begin_layout Description
2996 Origin Vermeer, 23 Mar 2006
2999 \begin_layout Subsection*
3002 \begin_layout Description
3003 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3005 \begin_layout Description
3006 Notion Part -> Chapter -> Section -> etc.
3008 \begin_layout Description
3011 \begin_layout Description
3012 Origin Vermeer, 23 Mar 2006
3015 \begin_layout Subsection*
3018 \begin_layout Description
3019 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3021 \begin_layout Description
3022 Notion Part <- Chapter <- Section <- etc.
3024 \begin_layout Description
3027 \begin_layout Description
3028 Origin Vermeer, 23 Mar 2006
3031 \begin_layout Subsection*
3034 \begin_layout Description
3035 Action Edit the inset at cursor with an external application, if one is attributed.
3037 \begin_layout Description
3038 Syntax inset-edit [<INSET_PARAMS>]
3040 \begin_layout Description
3041 Params <INSET_PARAMS>: Parameters for the inset.
3042 \begin_inset Newline newline
3045 Currently only the filename will be considered.
3047 \begin_layout Description
3048 Origin JSpitzm, 27 Apr 2006
3051 \begin_layout Subsection*
3054 \begin_layout Description
3055 Action Inserts table into the document.
3057 \begin_layout Description
3058 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3060 \begin_layout Description
3061 Syntax tabular-insert [<ROWS> <COLUMNS>]
3063 \begin_layout Description
3064 Params In case no arguments are given show insert dialog.
3066 \begin_layout Description
3067 Origin Jug, 12 Apr 2000
3070 \begin_layout Subsection*
3073 \begin_layout Description
3074 Action Moves the cursor to the previous cell inside the table.
3076 \begin_layout Description
3077 Syntax cell-backward
3079 \begin_layout Description
3080 Origin Jug, 22 May 2000
3083 \begin_layout Subsection*
3086 \begin_layout Description
3087 Action Moves the cursor to the next cell inside the table.
3089 \begin_layout Description
3093 \begin_layout Subsection*
3096 \begin_layout Description
3097 Action Splits cell and shifts right part to the next cell (inside the math grid).
3099 \begin_layout Description
3102 \begin_layout Description
3103 Origin Ale, 15 May 1997
3106 \begin_layout Subsection*
3109 \begin_layout Description
3110 Action Register the document as an file inside version control system (RCS, CVS).
3112 \begin_layout Description
3113 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3114 \begin_inset Newline newline
3117 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3119 \begin_layout Description
3122 \begin_layout Description
3123 Origin Lgb, 1 Jul 1997
3126 \begin_layout Subsection*
3129 \begin_layout Description
3130 Action Checks-in/commits the changes of the registered file to the repository.
3132 \begin_layout Description
3133 Notion In RCS case this also unlocks the file.
3135 \begin_layout Description
3138 \begin_layout Description
3139 Origin Lgb, 1 Jul 1997
3142 \begin_layout Subsection*
3145 \begin_layout Description
3146 Action Checks-out the document for edit (and locks it for RCS).
3148 \begin_layout Description
3149 Notion This is implemented only for RCS and SVN, not CVS.
3151 \begin_layout Description
3154 \begin_layout Description
3155 Origin Lgb, 1 Jul 1997
3158 \begin_layout Subsection*
3161 \begin_layout Description
3162 Action Reverts the document to the last check-in/commit in VCS.
3164 \begin_layout Description
3167 \begin_layout Description
3168 Origin Lgb, 1 Jul 1997
3171 \begin_layout Subsection*
3174 \begin_layout Description
3175 Action Undo last check-in.
3177 \begin_layout Description
3178 Notion This is currently implemented only for RCS.
3180 \begin_layout Description
3183 \begin_layout Description
3184 Origin Lgb, 1 Jul 1997
3187 \begin_layout Subsection*
3190 \begin_layout Description
3191 Action Executes external command. This command is intended to support additional VCS commands.
3193 \begin_layout Description
3194 Syntax vc-command <FLAG> <PATH> <COMMAND>
3196 \begin_layout Description
3197 Params <FLAG>: Flags for the command can be combined together.
3198 \begin_inset Newline newline
3201 U - dUmmy - no flags
3202 \begin_inset Newline newline
3205 D - Doc - need document loaded to proceed
3206 \begin_inset Newline newline
3209 I - dIrty - mark document dirty
3210 \begin_inset Newline newline
3213 R - Reload - ensure that the document is saved and reload it after command execution
3214 \begin_inset Newline newline
3217 M - Message - ask for input string (commit message)
3218 \begin_inset Newline newline
3221 <PATH>: path where to start. $$p will be replaced by the current document path.
3222 \begin_inset Newline newline
3225 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
3227 \begin_layout Description
3228 Sample vc-command DR $$p "svn up"
3230 \begin_layout Description
3231 Origin sanda, 13 Jan 2009
3234 \begin_layout Subsection*
3235 LFUN_VC_LOCKING_TOGGLE
3237 \begin_layout Description
3238 Action Toggles the locking property of the edited file.
3240 \begin_layout Description
3241 Notion This is currently implemented only for SVN.
3243 \begin_layout Description
3244 Syntax vc-locking-toggle
3246 \begin_layout Description
3247 Origin sanda, 25 Jun 2009
3250 \begin_layout Subsection*
3253 \begin_layout Description
3254 Action Update the local archive directory in which resides the current document with the remote repository.
3256 \begin_layout Description
3257 Notion This is currently implemented only for SVN.
3259 \begin_layout Description
3260 Syntax vc-repo-update
3262 \begin_layout Description
3263 Origin sanda, 16 Oct 2009
3266 \begin_layout Subsection*
3269 \begin_layout Description
3270 Action Compares two revisions of the same file under version control.
3272 \begin_layout Description
3273 Notion This is currently implemented only for SVN and RCS.
3275 \begin_layout Description
3276 Syntax vc-compare [<REV1>] [<REV2>]
3278 \begin_layout Description
3279 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
3280 \begin_inset Newline newline
3283 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
3284 \begin_inset Newline newline
3288 \begin_inset Newline newline
3291 <REV2>: Newer file. Used only if REV1 > 0.
3292 \begin_inset Newline newline
3295 If no parameter is given, interactive dialog will be shown.
3297 \begin_layout Description
3298 Sample Compare current document against last commit
3299 \begin_inset Newline newline
3302 vc-compare 0Compare current document against current revision - 5 commits
3303 \begin_inset Newline newline
3306 vc-compare -5Compare revisions 120 and 155
3307 \begin_inset Newline newline
3312 \begin_layout Description
3313 Origin sanda, 12 Feb 2010
3316 \begin_layout Subsection*
3319 \begin_layout Description
3320 Action Toggles change tracking to on/off.
3322 \begin_layout Description
3323 Syntax changes-track
3325 \begin_layout Description
3326 Origin levon, 1 Oct 2002
3329 \begin_layout Subsection*
3332 \begin_layout Description
3333 Action Toggles showing of change tracking in typesetted output.
3335 \begin_layout Description
3336 Syntax changes-output
3338 \begin_layout Description
3339 Origin jspitzm, 21 Jan 2005
3342 \begin_layout Subsection*
3345 \begin_layout Description
3346 Action Moves the cursor to the position of the next change of the change tracking records.
3348 \begin_layout Description
3351 \begin_layout Description
3352 Origin schmitt, 4 Oct 2006
3355 \begin_layout Subsection*
3356 LFUN_CHANGE_PREVIOUS
3358 \begin_layout Description
3359 Action Moves the cursor to the position of the previous change of the change tracking records.
3361 \begin_layout Description
3362 Syntax change-previous
3364 \begin_layout Description
3365 Origin vfr, 4 Apr 2009
3368 \begin_layout Subsection*
3371 \begin_layout Description
3372 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3374 \begin_layout Description
3375 Syntax changes-merge
3377 \begin_layout Description
3378 Origin Levon, 16 Oct 2002
3381 \begin_layout Subsection*
3384 \begin_layout Description
3385 Action Accepts tracked change inside the selection.
3387 \begin_layout Description
3388 Syntax change-accept
3390 \begin_layout Description
3391 Origin Levon, 16 Oct 2002
3394 \begin_layout Subsection*
3397 \begin_layout Description
3398 Action Rejects tracked change inside the selection.
3400 \begin_layout Description
3401 Syntax change-accept
3403 \begin_layout Description
3404 Origin Levon, 16 Oct 2002
3407 \begin_layout Subsection*
3408 LFUN_ALL_CHANGES_ACCEPT
3410 \begin_layout Description
3411 Action Accepts all tracked changes in the document.
3413 \begin_layout Description
3414 Syntax all-changes-accept
3416 \begin_layout Description
3417 Origin Levon, 16 Oct 2002
3420 \begin_layout Subsection*
3421 LFUN_ALL_CHANGES_REJECT
3423 \begin_layout Description
3424 Action Rejects all tracked changes in the document.
3426 \begin_layout Description
3427 Notion Reject does not work recursively; the user may have to repeat the operation.
3429 \begin_layout Description
3430 Syntax all-changes-reject
3432 \begin_layout Description
3433 Origin Levon, 16 Oct 2002
3436 \begin_layout Subsection*
3439 \begin_layout Description
3440 Action Apply data for an inset.
3442 \begin_layout Description
3443 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.
3445 \begin_layout Description
3446 Syntax inset-apply <ARGS>
3448 \begin_layout Description
3449 Params See LFUN_INSET_INSERT .
3452 \begin_layout Subsection*
3455 \begin_layout Description
3456 Action Dissolve the current inset into text.
3458 \begin_layout Description
3459 Syntax inset-dissolve [<INSET>]
3461 \begin_layout Description
3462 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.
3463 \begin_inset Newline newline
3466 For values see lyx::InsetLayout::lyxtype_ .
3468 \begin_layout Description
3469 Origin JSpitz, 7 Aug 2006
3472 \begin_layout Subsection*
3475 \begin_layout Description
3476 Action Insert new inset (type given by the parameters).
3478 \begin_layout Description
3479 Syntax inset-insert <INSET> <ARGS>
3481 \begin_layout Description
3482 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular hyperlink|include|index|label|nomencl|line|vspace|ref|toc>
3483 \begin_inset Newline newline
3486 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3488 \begin_layout Description
3489 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3492 \begin_inset Newline newline
3495 where <label name> is the name of the referenced label and <Format> is one of the following:
3496 \begin_inset Newline newline
3500 \begin_inset Newline newline
3503 eqref -- (<reference>)
3504 \begin_inset Newline newline
3508 \begin_inset Newline newline
3511 vpageref -- on <page>
3512 \begin_inset Newline newline
3515 vref -- <reference> on <page>
3516 \begin_inset Newline newline
3519 prettyref -- Formatted reference
3522 \begin_layout Subsection*
3525 \begin_layout Description
3526 Action Modify some properties of an inset.
3528 \begin_layout Description
3529 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, index, info, label, listings, newline, newpage, nomencl, note, phantom, ref, space, tabular, vspace, wrap insets.
3531 \begin_layout Description
3532 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
3534 \begin_layout Description
3535 Params Generally see LFUN_INSET_INSERT for further details.
3536 \begin_inset Newline newline
3539 In case that <INSET> is "tabular" various math-environment features are handled as well, e.g. add-vline-left/right for the Grid/Array environment.
3540 \begin_inset Newline newline
3543 <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|align-decimal|set-decimal-point| valign-top|valign-bottom|valign-middle|longtabular-align-left| longtabular-align-center|longtabular-align-right|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-multicolumn|set-special-multirow| 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
3544 \begin_inset Newline newline
3547 <ARG>: additional argument for some commands, use debug mode to explore its values.
3549 \begin_layout Description
3550 Sample inset-modify note Note Commentinset-modify changetype Ovalbox
3553 \begin_layout Subsection*
3554 LFUN_INSET_DIALOG_UPDATE
3556 \begin_layout Description
3557 Action Updates the values inside the dialog from the inset.
3559 \begin_layout Description
3560 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3562 \begin_layout Description
3563 Params <DIALOG-NAME>
3565 \begin_layout Description
3566 Origin leeming, 25 Feb 2003
3569 \begin_layout Subsection*
3572 \begin_layout Description
3573 Action Open the inset's properties dialog.
3575 \begin_layout Description
3576 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, line, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3578 \begin_layout Description
3579 Syntax inset-settings <INSET>
3581 \begin_layout Description
3582 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float| graphics|href|include|index|index_print|label|line| listings|note|phantom|ref|space|tabular|vspace|wrap>.
3585 \begin_layout Subsection*
3588 \begin_layout Description
3589 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3591 \begin_layout Description
3592 Syntax inset-toggle [<ARG>]
3594 \begin_layout Description
3595 Params <ARG>: <open|close|toggle|assign>.
3596 \begin_inset Newline newline
3599 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3600 \begin_inset Newline newline
3603 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3605 \begin_layout Description
3606 Origin lasgouttes, 19 Jul 2001
3609 \begin_layout Subsection*
3612 \begin_layout Description
3613 Action Apply the given commands on insets of a given name.
3615 \begin_layout Description
3616 Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 10000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed.
3618 \begin_layout Description
3619 Syntax inset-forall <NAME> <LFUN-COMMAND>
3620 \begin_inset Newline newline
3623 <NAME>: Type of Inset. If <NAME> is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets.
3625 \begin_layout Description
3626 Sample Remove all index insets:
3627 \begin_inset Newline newline
3630 inset-forall Index delete-char-forward
3631 \begin_inset Newline newline
3634 Close all Notes (also works for a particular branch, for example):
3635 \begin_inset Newline newline
3638 inset-forall Note inset-toggle close
3639 \begin_inset Newline newline
3642 Transform all yellow notes to comments
3643 \begin_inset Newline newline
3646 inset-forall Note:Note inset-modify note Note Comment
3647 \begin_inset Newline newline
3650 Try to put LyX in an infinite loop if there is at least a Note:
3651 \begin_inset Newline newline
3654 inset-forall Note char-backward
3656 \begin_layout Description
3657 Origin lasgouttes, 27 Nov 2009
3660 \begin_layout Subsection*
3661 LFUN_GRAPHICS_RELOAD
3663 \begin_layout Description
3664 Action Reloads the image if necessary.
3666 \begin_layout Description
3667 Syntax graphics-reload
3669 \begin_layout Description
3670 Origin vfr, 10 Aug 2009
3673 \begin_layout Subsection*
3674 LFUN_SET_GRAPHICS_GROUP
3676 \begin_layout Description
3677 Action Set the group for the graphics inset on the cursor position.
3679 \begin_layout Description
3680 Syntax set-graphics-group [<GROUP>]
3682 \begin_layout Description
3683 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3685 \begin_layout Description
3686 Origin sanda, 6 May 2008
3689 \begin_layout Subsection*
3690 LFUN_FINISHED_FORWARD
3692 \begin_layout Description
3693 Action Moves the cursor out of the current slice, going forward.
3695 \begin_layout Description
3696 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.
3699 \begin_layout Subsection*
3700 LFUN_FINISHED_BACKWARD
3702 \begin_layout Description
3703 Action Moves the cursor out of the current slice, going backwards.
3705 \begin_layout Description
3706 Notion See also LFUN_FINISHED_FORWARD.
3709 \begin_layout Subsection*
3712 \begin_layout Description
3713 Action Moves the cursor out of the current slice, going right.
3715 \begin_layout Description
3716 Notion See also LFUN_FINISHED_FORWARD
3719 \begin_layout Subsection*
3722 \begin_layout Description
3723 Action Moves the cursor out of the current slice, going left.
3725 \begin_layout Description
3726 Notion See also LFUN_FINISHED_FORWARD.
3729 \begin_layout Subsection*
3732 \begin_layout Description
3733 Action Set language from the current cursor position.
3735 \begin_layout Description
3736 Syntax language <LANG>
3738 \begin_layout Description
3739 Params <LANG>: Requested language. Look in lib/languages for the list.
3741 \begin_layout Description
3742 Origin Dekel, 2 Mar 2000
3745 \begin_layout Subsection*
3748 \begin_layout Description
3749 Action Goto a label.
3751 \begin_layout Description
3752 Syntax label-goto [<LABEL>]
3754 \begin_layout Description
3755 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.
3757 \begin_layout Description
3758 Origin Ale, 6 Aug 1997
3761 \begin_layout Subsection*
3764 \begin_layout Description
3765 Action Inserts label to text or displayed formula.
3767 \begin_layout Description
3768 Syntax label-insert [<LABEL>]
3770 \begin_layout Description
3771 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3774 \begin_layout Subsection*
3777 \begin_layout Description
3778 Action Go to the next label or cross-reference.
3780 \begin_layout Description
3781 Syntax reference-next
3783 \begin_layout Description
3784 Origin Dekel, 14 Jan 2001
3787 \begin_layout Subsection*
3790 \begin_layout Description
3791 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3793 \begin_layout Description
3794 Notion Bookmark 0 has a special purpose. It is automatically set
3795 \begin_inset Newline newline
3798 1. to the paragraph you are currently editing
3799 \begin_inset Newline newline
3802 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3803 \begin_inset Newline newline
3806 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3808 \begin_layout Description
3809 Syntax bookmark-goto <NUMBER>
3811 \begin_layout Description
3812 Params <NUMBER>: the number of the bookmark to restore.
3814 \begin_layout Description
3815 Origin Dekel, 27 January 2001
3818 \begin_layout Subsection*
3821 \begin_layout Description
3822 Action Save a bookmark.
3824 \begin_layout Description
3825 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.
3827 \begin_layout Description
3828 Syntax bookmark-save <NUMBER>
3830 \begin_layout Description
3831 Params <NUMBER>: the number of the bookmark to save.
3833 \begin_layout Description
3834 Origin Dekel, 27 January 2001
3837 \begin_layout Subsection*
3840 \begin_layout Description
3841 Action Clears the list of saved bookmarks.
3843 \begin_layout Description
3844 Syntax bookmark-clear
3846 \begin_layout Description
3847 Origin bpeng, 31 October 2006
3850 \begin_layout Subsection*
3853 \begin_layout Description
3854 Action Open the given help file according to the language setting.
3856 \begin_layout Description
3857 Syntax help-open <FILE>[.lyx]
3859 \begin_layout Description
3860 Params <FILE>: any document from (/usr/share/)doc directory.
3862 \begin_layout Description
3863 Origin Jug, 27 Jun 1999
3866 \begin_layout Subsection*
3869 \begin_layout Description
3870 Action Terminates the current LyX instance.
3872 \begin_layout Description
3873 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3875 \begin_layout Description
3879 \begin_layout Subsection*
3882 \begin_layout Description
3883 Action Toggles visibility of a given toolbar between on/off/auto.
3885 \begin_layout Description
3886 Notion Skipping "auto" when allowauto is false.
3888 \begin_layout Description
3889 Syntax toolbar-toggle <NAME> [allowauto]
3891 \begin_layout Description
3892 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
3894 \begin_layout Description
3895 Origin Edwin, 21 May 2007
3898 \begin_layout Subsection*
3901 \begin_layout Description
3902 Action Opens the menu given by its name.
3904 \begin_layout Description
3905 Syntax menu-open <NAME>
3907 \begin_layout Description
3908 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3911 \begin_layout Subsection*
3914 \begin_layout Description
3915 Action Various UI visibility-toggling actions.
3917 \begin_layout Description
3918 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3920 \begin_layout Description
3921 Params statusbar : Toggle visibility of the statusbar.
3922 \begin_inset Newline newline
3925 menubar : Toggle visibility of the menubar.
3926 \begin_inset Newline newline
3929 scrollbar : Toggle visibility of the scrollbar.
3930 \begin_inset Newline newline
3933 frame : Toggle visibility of the frames around editing window.
3934 \begin_inset Newline newline
3937 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.
3939 \begin_layout Description
3940 Origin sanda, 9 Feb 2007
3943 \begin_layout Subsection*
3946 \begin_layout Description
3947 Action Creates new empty LyX window.
3949 \begin_layout Description
3950 Notion Already opened documents from the previous window can be found under View menu.
3952 \begin_layout Description
3953 Syntax window-new [<GEOMETRY>]
3955 \begin_layout Description
3956 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3958 \begin_layout Description
3959 Origin Abdel, 21 Oct 2006
3962 \begin_layout Subsection*
3965 \begin_layout Description
3966 Action Closes the current LyX window.
3968 \begin_layout Description
3971 \begin_layout Description
3972 Origin Abdel, 23 Oct 2006
3975 \begin_layout Subsection*
3978 \begin_layout Description
3979 Action Creates another split view of current buffer.
3981 \begin_layout Description
3982 Notion All split views act in the same way indpendently.
3984 \begin_layout Description
3985 Syntax split-view <vertical|horizontal>
3987 \begin_layout Description
3988 Params horizontal : The work areas are laid out side by side.
3989 \begin_inset Newline newline
3992 vertical : The work areas laid out vertically.
3994 \begin_layout Description
3995 Origin Abdel, 20 Feb 2008
3998 \begin_layout Subsection*
3999 LFUN_CLOSE_TAB_GROUP
4001 \begin_layout Description
4002 Action Close the current tab group.
4004 \begin_layout Description
4005 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
4007 \begin_layout Description
4008 Syntax close-tab-group
4010 \begin_layout Description
4011 Origin Abdel, 21 Feb 2008
4014 \begin_layout Subsection*
4017 \begin_layout Description
4018 Action Shows hidden dialog or create new one for a given function/inset settings etc.
4020 \begin_layout Description
4021 Syntax dialog-show <NAME> [<DATA>]
4023 \begin_layout Description
4024 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4025 \begin_inset Newline newline
4028 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
4029 \begin_inset Newline newline
4032 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
4033 \begin_inset Newline newline
4036 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
4037 \begin_inset Newline newline
4040 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
4041 \begin_inset Newline newline
4044 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
4045 \begin_inset Newline newline
4048 <SPECIAL>: latexlog|vclog
4049 \begin_inset Newline newline
4052 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
4054 \begin_layout Description
4055 Origin leeming, 17 Jun 2003
4058 \begin_layout Subsection*
4059 LFUN_DIALOG_SHOW_NEW_INSET
4061 \begin_layout Description
4062 Action Shows hidden dialog or create new one for a given inset settings etc.
4064 \begin_layout Description
4065 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
4067 \begin_layout Description
4068 Syntax dialog-show-new-inset <NAME> [<DATA>]
4070 \begin_layout Description
4071 Params See LFUN_DIALOG_SHOW .
4073 \begin_layout Description
4074 Origin leeming, 25 Feb 2003
4077 \begin_layout Subsection*
4080 \begin_layout Description
4081 Action Updates the dialog values from the inset/paragraph/document.
4083 \begin_layout Description
4084 Syntax dialog-update <NAME>
4086 \begin_layout Description
4087 Params <NAME>: paragraph|prefs|<INSET>
4088 \begin_inset Newline newline
4093 \begin_layout Description
4094 Origin leeming, 25 Feb 2003
4097 \begin_layout Subsection*
4100 \begin_layout Description
4101 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
4103 \begin_layout Description
4104 Syntax dialog-hide <NAME>
4106 \begin_layout Description
4107 Params See LFUN_DIALOG_SHOW .
4109 \begin_layout Description
4110 Origin leeming, 25 Feb 2003
4113 \begin_layout Subsection*
4116 \begin_layout Description
4117 Action Toggles dialog between showed/hidden state.
4119 \begin_layout Description
4120 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4122 \begin_layout Description
4123 Syntax dialog-toggle <NAME> [<DATA>]
4125 \begin_layout Description
4126 Params See LFUN_DIALOG_SHOW .
4128 \begin_layout Description
4129 Origin JSpitzm, 30 Apr 2007
4132 \begin_layout Subsection*
4133 LFUN_DIALOG_DISCONNECT_INSET
4135 \begin_layout Description
4136 Action Closes opened connection to opened inset.
4138 \begin_layout Description
4139 Notion Connection is used for apply functions.
4141 \begin_layout Description
4142 Syntax dialog-disconnect-inset <INSET-NAME>
4144 \begin_layout Description
4145 Origin leeming, 25 Feb 2003
4148 \begin_layout Subsection*
4151 \begin_layout Description
4152 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
4154 \begin_layout Description
4155 Notion This is internal LFUN, not to be used by users.
4157 \begin_layout Description
4158 Origin Andre, 9 Aug 2002
4161 \begin_layout Subsection*
4164 \begin_layout Description
4165 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
4167 \begin_layout Description
4168 Notion This is internal LFUN, not to be used by users.
4170 \begin_layout Description
4171 Origin Andre, 9 Aug 2002
4174 \begin_layout Subsection*
4177 \begin_layout Description
4178 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4180 \begin_layout Description
4181 Notion This is internal LFUN, not to be used by users.
4183 \begin_layout Description
4184 Origin Andre, 9 Aug 2002
4187 \begin_layout Subsection*
4190 \begin_layout Description
4191 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4193 \begin_layout Description
4194 Notion This is internal LFUN, not to be used by users.
4196 \begin_layout Description
4197 Origin Andre, 9 Aug 2002
4200 \begin_layout Subsection*
4203 \begin_layout Description
4204 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4206 \begin_layout Description
4207 Notion This is internal LFUN, not to be used by users.
4209 \begin_layout Description
4210 Origin Andre, 9 Aug 2002
4213 \begin_layout Subsection*
4216 \begin_layout Description
4217 Action Turn off the loaded keyboard map.
4219 \begin_layout Description
4223 \begin_layout Subsection*
4226 \begin_layout Description
4227 Action Turn on the primary keyboard map.
4229 \begin_layout Description
4230 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.
4231 \begin_inset Newline newline
4234 The language is to be set in the Preferences dialog.
4236 \begin_layout Description
4237 Syntax keymap-primary
4240 \begin_layout Subsection*
4241 LFUN_KEYMAP_SECONDARY
4243 \begin_layout Description
4244 Action Turn on the secondary keyboard map.
4246 \begin_layout Description
4247 Syntax keymap-secondary
4250 \begin_layout Subsection*
4253 \begin_layout Description
4254 Action Toggles keyboard maps (first/second/off).
4256 \begin_layout Description
4257 Syntax keymap-toggle
4259 \begin_layout Description
4260 Origin leeming, 30 Mar 2004
4263 \begin_layout Subsection*
4264 LFUN_SERVER_GET_LAYOUT
4266 \begin_layout Description
4267 Action Returns the current layout (that is environment) name on the cursor position.
4269 \begin_layout Description
4270 Syntax server-get-layout
4273 \begin_layout Subsection*
4274 LFUN_SERVER_GET_FILENAME
4276 \begin_layout Description
4277 Action Returns path and file name of the currently edited document.
4279 \begin_layout Description
4280 Syntax server-get-filename
4283 \begin_layout Subsection*
4284 LFUN_SERVER_GOTO_FILE_ROW
4286 \begin_layout Description
4287 Action Sets the cursor position based on the row number of generated TeX file.
4289 \begin_layout Description
4290 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).
4292 \begin_layout Description
4293 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4295 \begin_layout Description
4296 Params <FILE>: the filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
4297 \begin_inset Newline newline
4300 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. <ROW_NUMBER> The row number of the LaTeX file to which to go.
4302 \begin_layout Description
4303 Origin Edmar, 23 Dec 1998
4306 \begin_layout Subsection*
4309 \begin_layout Description
4310 Action Sets the cursor position in the previewed (e.g. dvi) file based on the row number in LyX window.
4312 \begin_layout Description
4313 Notion The external program used for forward search call can be specified in
4315 forward_search_dvi and
4317 forward_search_pdf RC settings. By default, the value for pdf is empty, while for dvi it is
4318 \begin_inset Newline newline
4321 "xdvi -sourceposition $$n:$$t $$o"
4322 \begin_inset Newline newline
4325 The values replaced in the call: $$n for row number, $$t for exported temporary .tex file, $$o exported output file, either dvi or pdf, depending on which one exists in the temp dir (preferred is dvi).
4327 \begin_layout Description
4328 Syntax forward-search
4330 \begin_layout Description
4331 Origin sanda, 14 Apr 2010
4334 \begin_layout Subsection*
4337 \begin_layout Description
4338 Action Sends notify message about the last key-sequence to client.
4340 \begin_layout Description
4341 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4343 \begin_layout Description
4344 Syntax server-notify
4347 \begin_layout Subsection*
4350 \begin_layout Description
4351 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4353 \begin_layout Description
4354 Syntax server-set-xy <X> <Y>
4357 \begin_layout Subsection*
4360 \begin_layout Description
4361 Action Returns the coordinates of cursor position in the editing area.
4363 \begin_layout Description
4364 Syntax server-get-xy
4367 \begin_layout Subsection*
4370 \begin_layout Description
4371 Action Generates the code (literate programming).
4373 \begin_layout Description
4374 Notion Latex file with extension
4376 literate_extension is generated. Then LyX invokes
4378 build_command (with a default of``make'') to generate the code and
4380 build_error_filter to process the compilation error messages.
4381 \begin_inset Newline newline
4384 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:
4385 \begin_inset Newline newline
4390 build_command "my_script my_arguments"
4391 \begin_inset Newline newline
4396 build_error_filter differs from the
4398 literate_error_filter only in that the former will identify error messages from your compiler.
4400 \begin_layout Description
4401 Syntax build-program
4404 \begin_layout Subsection*
4405 LFUN_BUFFER_AUTO_SAVE
4407 \begin_layout Description
4408 Action Saves the current buffer to a temporary file.
4410 \begin_layout Description
4411 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4413 \begin_layout Description
4414 Syntax buffer-auto-save
4417 \begin_layout Subsection*
4418 LFUN_BUFFER_CHILD_OPEN
4420 \begin_layout Description
4421 Action Loads the given child document.
4423 \begin_layout Description
4424 Notion The current document is treated as a parent.
4426 \begin_layout Description
4427 Syntax buffer-child-open <FILE>
4429 \begin_layout Description
4430 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4432 \begin_layout Description
4433 Origin Ale, 28 May 1997
4436 \begin_layout Subsection*
4439 \begin_layout Description
4440 Action Runs chktex for the current document.
4442 \begin_layout Description
4443 Syntax buffer-chktex
4445 \begin_layout Description
4446 Origin Asger, 30 Oct 1997
4449 \begin_layout Subsection*
4450 LFUN_BUFFER_TOGGLE_COMPRESSION
4452 \begin_layout Description
4453 Action Toggles compression of the current document on/off.
4455 \begin_layout Description
4456 Syntax buffer-toggle-compression
4458 \begin_layout Description
4459 Origin bpeng, 27 Apr 2006
4462 \begin_layout Subsection*
4463 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
4465 \begin_layout Description
4466 Action Toggles including of resources for forward/reverse search of the given document.
4468 \begin_layout Description
4469 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
4471 \begin_layout Description
4472 Syntax buffer-toggle-output-sync
4474 \begin_layout Description
4475 Origin sanda, 25 May 2010
4478 \begin_layout Subsection*
4481 \begin_layout Description
4482 Action Closes the current buffer.
4484 \begin_layout Description
4485 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4487 \begin_layout Description
4491 \begin_layout Subsection*
4492 LFUN_BUFFER_CLOSE_ALL
4494 \begin_layout Description
4495 Action Closes all buffers.
4497 \begin_layout Description
4498 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4500 \begin_layout Description
4501 Syntax buffer-close-all
4504 \begin_layout Subsection*
4507 \begin_layout Description
4508 Action Exports the current buffer (document) to the given format.
4510 \begin_layout Description
4511 Syntax buffer-export <FORMAT>
4513 \begin_layout Description
4514 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.
4515 \begin_inset Newline newline
4518 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.
4520 \begin_layout Description
4521 Origin Lgb, 29 Jul 1997
4524 \begin_layout Subsection*
4525 LFUN_BUFFER_EXPORT_CUSTOM
4527 \begin_layout Description
4528 Action Exports the current buffer (document) from the given format using the given command on it.
4530 \begin_layout Description
4531 Syntax buffer-export-custom <FORMAT> <COMMAND>
4533 \begin_layout Description
4534 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4535 \begin_inset Newline newline
4538 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4540 \begin_layout Description
4541 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4543 \begin_layout Description
4544 Origin leeming, 27 Mar 2004
4547 \begin_layout Subsection*
4550 \begin_layout Description
4551 Action Prints the current document.
4553 \begin_layout Description
4554 Notion Many settings can be given via the preferences dialog.
4556 \begin_layout Description
4557 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4559 \begin_layout Description
4560 Params <TARGET> is either "printer" or "file".
4561 \begin_inset Newline newline
4564 <TARGER-NAME> is either "default" or file name or printer name.
4565 \begin_inset Newline newline
4568 <COMMAND> command ensuring the printing job.
4570 \begin_layout Description
4571 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4573 \begin_layout Description
4574 Origin leeming, 28 Mar 2004
4577 \begin_layout Subsection*
4580 \begin_layout Description
4581 Action Import a given file as a lyx document.
4583 \begin_layout Description
4584 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.
4586 \begin_layout Description
4587 Syntax buffer-import <FORMAT> [<FILE>]
4589 \begin_layout Description
4590 Origin Asger, 24 Jul 1998
4593 \begin_layout Subsection*
4596 \begin_layout Description
4597 Action Creates a new buffer (that is, document).
4599 \begin_layout Description
4600 Notion Implicit path can be set in Preferences dialog.
4602 \begin_layout Description
4603 Syntax buffer-new [<FILE>]
4605 \begin_layout Description
4606 Params <FILE>: filename of created file with absolute path.
4609 \begin_layout Subsection*
4610 LFUN_BUFFER_NEW_TEMPLATE
4612 \begin_layout Description
4613 Action Creates a new buffer (that is, document) from a template.
4615 \begin_layout Description
4616 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4618 \begin_layout Description
4619 Syntax buffer-new-template [<FILE>]
4621 \begin_layout Description
4622 Params <FILE>: filename of created file with absolute path.
4625 \begin_layout Subsection*
4628 \begin_layout Description
4629 Action Reverts opened document.
4631 \begin_layout Description
4632 Syntax buffer-reload
4634 \begin_layout Description
4635 Origin Asger, 2 Feb 1997
4638 \begin_layout Subsection*
4641 \begin_layout Description
4642 Action Display/switch to the given buffer.
4644 \begin_layout Description
4645 Syntax buffer-switch <BUFFER>
4647 \begin_layout Description
4648 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
4651 \begin_layout Subsection*
4652 LFUN_BUFFER_TOGGLE_READ_ONLY
4654 \begin_layout Description
4655 Action Toggle editing mode of the current document between read/write and read-only.
4657 \begin_layout Description
4658 Notion This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking.
4660 \begin_layout Description
4661 Syntax buffer-toggle-read-only
4663 \begin_layout Description
4664 Origin Lgb, 27 May 1997
4667 \begin_layout Subsection*
4670 \begin_layout Description
4671 Action Displays current buffer in chosen format.
4673 \begin_layout Description
4674 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.
4676 \begin_layout Description
4677 Syntax buffer-view [<FORMAT>]
4679 \begin_layout Description
4680 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.
4683 \begin_layout Subsection*
4686 \begin_layout Description
4687 Action Exports the current document and put the result into the temporary directory.
4689 \begin_layout Description
4690 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).
4692 \begin_layout Description
4693 Syntax buffer-update [<FORMAT>]
4695 \begin_layout Description
4696 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.
4698 \begin_layout Description
4699 Origin Dekel, 5 Aug 2000
4702 \begin_layout Subsection*
4705 \begin_layout Description
4706 Action Saves the current buffer.
4708 \begin_layout Description
4709 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.
4711 \begin_layout Description
4715 \begin_layout Subsection*
4716 LFUN_BUFFER_WRITE_AS
4718 \begin_layout Description
4719 Action Rename and save current buffer.
4721 \begin_layout Description
4722 Syntax buffer-write-as <FILENAME>
4724 \begin_layout Description
4725 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4728 \begin_layout Subsection*
4729 LFUN_BUFFER_WRITE_ALL
4731 \begin_layout Description
4732 Action Save all changed documents.
4734 \begin_layout Description
4735 Syntax buffer-write-all
4737 \begin_layout Description
4738 Origin rgh, gpothier 6 Aug 2007
4741 \begin_layout Subsection*
4744 \begin_layout Description
4745 Action Switch to the next opened document.
4747 \begin_layout Description
4748 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4750 \begin_layout Description
4754 \begin_layout Subsection*
4755 LFUN_BUFFER_PREVIOUS
4757 \begin_layout Description
4758 Action Switch to the previous opened document.
4760 \begin_layout Description
4761 Syntax buffer-previous
4764 \begin_layout Subsection*
4765 LFUN_MASTER_BUFFER_UPDATE
4767 \begin_layout Description
4768 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4770 \begin_layout Description
4771 Syntax master-buffer-update [<FORMAT>]
4773 \begin_layout Description
4774 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.
4776 \begin_layout Description
4777 Origin Tommaso, 20 Sep 2007
4780 \begin_layout Subsection*
4781 LFUN_MASTER_BUFFER_VIEW
4783 \begin_layout Description
4784 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4786 \begin_layout Description
4787 Syntax master-buffer-view [<FORMAT>]
4789 \begin_layout Description
4790 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.
4792 \begin_layout Description
4793 Origin Tommaso, 20 Sep 2007
4796 \begin_layout Subsection*
4797 LFUN_BUFFER_LANGUAGE
4799 \begin_layout Description
4800 Action Set language of the current document.
4802 \begin_layout Description
4803 Syntax buffer-language <LANG>
4805 \begin_layout Description
4806 Params <LANG>: language name. See lib/languages for list.
4808 \begin_layout Description
4809 Origin leeming, 30 Mar 2004
4812 \begin_layout Subsection*
4813 LFUN_BUFFER_SAVE_AS_DEFAULT
4815 \begin_layout Description
4816 Action Save the current document settings as default.
4818 \begin_layout Description
4819 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4821 \begin_layout Description
4822 Syntax buffer-save-as-default [<ARGS>]
4824 \begin_layout Description
4825 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4827 \begin_layout Description
4828 Origin leeming, 30 Mar 2004
4831 \begin_layout Subsection*
4832 LFUN_BUFFER_PARAMS_APPLY
4834 \begin_layout Description
4835 Action Apply the given settings to the current document.
4837 \begin_layout Description
4838 Syntax buffer-params-apply [<ARGS>]
4840 \begin_layout Description
4841 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4843 \begin_layout Description
4844 Origin leeming, 30 Mar 2004
4847 \begin_layout Subsection*
4850 \begin_layout Description
4851 Action Inserts another LyX file.
4853 \begin_layout Description
4854 Syntax file-insert [<FILE>]
4856 \begin_layout Description
4857 Params <FILE>: Filename to be inserted.
4860 \begin_layout Subsection*
4861 LFUN_FILE_INSERT_PLAINTEXT
4863 \begin_layout Description
4864 Action Inserts plain text file.
4866 \begin_layout Description
4867 Syntax file-insert-plaintext [<FILE>]
4869 \begin_layout Description
4870 Params <FILE>: Filename to be inserted.
4872 \begin_layout Description
4873 Origin CFO-G, 19 Nov 1997
4876 \begin_layout Subsection*
4877 LFUN_FILE_INSERT_PLAINTEXT_PARA
4879 \begin_layout Description
4880 Action Inserts plain text file as paragraph (i.e. join lines).
4882 \begin_layout Description
4883 Syntax file-insert-plaintext-para [<FILE>]
4885 \begin_layout Description
4886 Params <FILE>: Filename to be inserted.
4888 \begin_layout Description
4889 Origin Levon, 14 Feb 2001
4892 \begin_layout Subsection*
4895 \begin_layout Description
4896 Action Open LyX document.
4898 \begin_layout Description
4899 Syntax file-open [<FILE>]
4901 \begin_layout Description
4902 Params <FILE>: Filename to be opened.
4905 \begin_layout Subsection*
4908 \begin_layout Description
4909 Action Executes a command defined in a .def file.
4911 \begin_layout Description
4912 Notion The definitions are by default read from lib/commands/default.def.
4913 \begin_inset Newline newline
4916 A .def file allows to define a command with
4918 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).
4920 def_file "FileName" allows to include another .def file.
4921 \begin_inset Newline newline
4924 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.
4926 \begin_layout Description
4929 \begin_layout Description
4930 Params <NAME>: Name of the command that must be called.
4932 \begin_layout Description
4933 Origin broider, 2 Oct 2007
4936 \begin_layout Subsection*
4939 \begin_layout Description
4940 Action Simulate halting Meta key (Alt key on PCs).
4942 \begin_layout Description
4943 Notion Used for buffer editation not for GUI control.
4945 \begin_layout Description
4949 \begin_layout Subsection*
4952 \begin_layout Description
4953 Action Cancels sequence prepared by LFUN_META_PREFIX .
4955 \begin_layout Description
4959 \begin_layout Subsection*
4960 LFUN_COMMAND_EXECUTE
4962 \begin_layout Description
4963 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
4965 \begin_layout Description
4966 Notion Usually bound to M-x shortcut.
4968 \begin_layout Description
4969 Syntax command-execute
4972 \begin_layout Subsection*
4975 \begin_layout Description
4976 Action Return the current key sequence and available options as a string.
4978 \begin_layout Description
4979 Notion No options are added if no current map exists.
4980 \begin_inset Newline newline
4983 This is probably usable only with connection to lyxserver.
4985 \begin_layout Description
4986 Syntax command-prefix
4989 \begin_layout Subsection*
4990 LFUN_COMMAND_SEQUENCE
4992 \begin_layout Description
4993 Action Run more commands (LFUN and its parameters) in a sequence.
4995 \begin_layout Description
4996 Syntax command-sequence <CMDS>
4998 \begin_layout Description
4999 Params <CMDS>: Sequence of commands separated by semicolons.
5001 \begin_layout Description
5002 Sample command-sequence cut; ert-insert; self-insert
5004 ; paste; self-insert {}; inset-toggle;
5006 \begin_layout Description
5007 Origin Andre, 11 Nov 1999
5010 \begin_layout Subsection*
5011 LFUN_COMMAND_ALTERNATIVES
5013 \begin_layout Description
5014 Action Runs the first listed command that is enabled.
5016 \begin_layout Description
5017 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
5019 \begin_layout Description
5020 Syntax command-alternatives <CMDS>
5022 \begin_layout Description
5023 Params <CMDS>: Sequence of commands separated by semicolons.
5025 \begin_layout Description
5026 Sample command-alternatives completion-accept;cell-forward
5028 \begin_layout Description
5029 Origin rgh, 24 September 2008
5032 \begin_layout Subsection*
5035 \begin_layout Description
5036 Action Shows message in statusbar (for script purposes).
5038 \begin_layout Description
5039 Syntax message <STRING>
5041 \begin_layout Description
5042 Origin Lgb, 8 Apr 2001
5045 \begin_layout Subsection*
5046 LFUN_DEBUG_LEVEL_SET
5048 \begin_layout Description
5049 Action Set debug output level.
5051 \begin_layout Description
5052 Syntax debug-level-set <LEVEL>
5054 \begin_layout Description
5055 Params <LEVEL>: comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers.
5057 \begin_layout Description
5058 Origin sanda, 28 Dec 2009
5061 \begin_layout Subsection*
5062 LFUN_PREFERENCES_SAVE
5064 \begin_layout Description
5065 Action Save user preferences.
5067 \begin_layout Description
5068 Syntax preferences-save
5070 \begin_layout Description
5071 Origin Lgb, 27 Nov 1999
5074 \begin_layout Subsection*
5077 \begin_layout Description
5078 Action Reconfigure the automatic settings.
5080 \begin_layout Description
5083 \begin_layout Description
5084 Origin Asger, 14 Feb 1997
5087 \begin_layout Subsection*
5090 \begin_layout Description
5091 Action Apply the given settings to user preferences.
5093 \begin_layout Description
5094 Syntax lyxrc-apply <SETTINGS>
5096 \begin_layout Description
5097 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.
5100 \begin_layout Subsection*
5101 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
5103 \begin_layout Description
5104 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
5106 \begin_layout Description
5107 Syntax toggle-cursor-follows-scrollbar
5109 \begin_layout Description
5110 Origin ARRae, 2 Dec 1997
5113 \begin_layout Subsection*
5116 \begin_layout Description
5117 Action Set the given LyX color to the color defined by the X11 name given.
5119 \begin_layout Description
5120 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5122 \begin_layout Description
5123 Syntax set-color <LYX_NAME> <X11_NAME>
5125 \begin_layout Description
5126 Origin SLior, 11 Jun 2000
5129 \begin_layout Subsection*
5132 \begin_layout Description
5133 Action Count the statistics (number of words and characters) in the document or in the given selection.
5135 \begin_layout Description
5136 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5138 \begin_layout Description
5141 \begin_layout Description
5142 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5145 \begin_layout Subsection*
5146 LFUN_COMPLETION_INLINE
5148 \begin_layout Description
5149 Action Show the inline completion at the cursor position.
5151 \begin_layout Description
5152 Syntax completion-inline
5154 \begin_layout Description
5155 Origin sts, Feb 19 2008
5158 \begin_layout Subsection*
5159 LFUN_COMPLETION_POPUP
5161 \begin_layout Description
5162 Action Show the completion popup at the cursor position.
5164 \begin_layout Description
5165 Syntax completion-popup
5167 \begin_layout Description
5168 Origin sts, Feb 19 2008
5171 \begin_layout Subsection*
5172 LFUN_COMPLETION_COMPLETE
5174 \begin_layout Description
5175 Action Try to complete the word or command at the cursor position.
5177 \begin_layout Description
5180 \begin_layout Description
5181 Origin sts, Feb 19 2008
5184 \begin_layout Subsection*
5185 LFUN_COMPLETION_CANCEL
5187 \begin_layout Description
5188 Action Try to cancel completion, either the popup or the inline completion.
5190 \begin_layout Description
5191 Syntax completion-cancel
5193 \begin_layout Description
5194 Origin sts, Sep 07 2008
5197 \begin_layout Subsection*
5198 LFUN_COMPLETION_ACCEPT
5200 \begin_layout Description
5201 Action Accept suggested completion.
5203 \begin_layout Description
5204 Syntax completion-accept
5206 \begin_layout Description
5207 Origin sanda, Sep 08 2008
5210 \begin_layout Subsection*
5213 \begin_layout Description
5214 Action Add a branch to the buffer's BranchList.
5216 \begin_layout Description
5217 Syntax branch-add <BRANCH>
5219 \begin_layout Description
5220 Params <BRANCH>: Name of the branch to add
5222 \begin_layout Description
5223 Origin spitz, 7 Jul 2009
5226 \begin_layout Subsection*
5227 LFUN_BRANCH_ACTIVATE
5229 \begin_layout Description
5230 Action Activate the branch.
5232 \begin_layout Description
5233 Syntax branch-activate <BRANCH>
5235 \begin_layout Description
5236 Params <BRANCH>: The branch to activate
5238 \begin_layout Description
5239 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5240 \begin_inset Newline newline
5243 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5245 \begin_layout Description
5246 Origin rgh, 27 May 2008
5249 \begin_layout Subsection*
5250 LFUN_BRANCH_DEACTIVATE
5252 \begin_layout Description
5253 Action De-activate the branch.
5255 \begin_layout Description
5256 Syntax branch-deactivate <BRANCH>
5258 \begin_layout Description
5259 Params <BRANCH>: The branch to deactivate
5261 \begin_layout Description
5262 Origin rgh, 27 May 2008
5265 \begin_layout Subsection*
5266 LFUN_BRANCHES_RENAME
5268 \begin_layout Description
5269 Action Rename all branches of a given name in a document.
5271 \begin_layout Description
5272 Syntax branches-rename <OLDNAME> <NEWNAME>
5274 \begin_layout Description
5275 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5277 \begin_layout Description
5278 Origin spitz, 9 Jul 2009
5281 \begin_layout Subsection*
5282 LFUN_BRANCH_ADD_INSERT
5284 \begin_layout Description
5285 Action Create new branch and directly put the branch inset into the document.
5287 \begin_layout Description
5288 Syntax branch-add-insert [<NAME>]
5290 \begin_layout Description
5291 Params <NAME>: Branch name. If it is not specified, you will be asked.
5293 \begin_layout Description
5294 Origin sanda, 10 Jul 2009
5297 \begin_layout Subsection*
5298 LFUN_LABEL_COPY_AS_REF
5300 \begin_layout Description
5301 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5303 \begin_layout Description
5304 Syntax copy-label-as-reference <LABEL>
5306 \begin_layout Description
5307 Params <LABEL>: The label to copy (for multi-line math)
5309 \begin_layout Description
5310 Origin sts, 16 Nov 2008
5313 \begin_layout Subsection*
5314 LFUN_LABEL_INSERT_AS_REF
5316 \begin_layout Description
5317 Action Inserts the label as a cross-reference at the position of the cursor.
5319 \begin_layout Description
5320 Syntax label-insert-as-reference
5322 \begin_layout Description
5323 Origin vfr, 7 Apr 2009
5326 \begin_layout Subsection*
5329 \begin_layout Description
5330 Action Increases the zoom of the screen fonts.
5332 \begin_layout Description
5333 Syntax buffer-zoom-in [<ZOOM>]
5335 \begin_layout Description
5336 Params <ZOOM>: The zoom in %, the default is 20.
5338 \begin_layout Description
5339 Origin vfr, 30 Mar 2009
5342 \begin_layout Subsection*
5343 LFUN_BUFFER_ZOOM_OUT
5345 \begin_layout Description
5346 Action Decreases the zoom of the screen fonts.
5348 \begin_layout Description
5349 Syntax buffer-zoom-out [<ZOOM>]
5351 \begin_layout Description
5352 Params <ZOOM>: The zoom in %, the default is 20.
5354 \begin_layout Description
5355 Origin vfr, 30 Mar 2009
5358 \begin_layout Subsection*
5361 \begin_layout Description
5362 Action Copies the inset to the clipboard as a certain type
5364 \begin_layout Description
5365 Syntax inset-copy-as [<TYPE>]
5367 \begin_layout Description
5368 Params <TYPE>: The type as which the inset is copied. This can vary from inset to inset.
5370 \begin_layout Description
5371 Sample InsetInfo is copied as text
5373 \begin_layout Description
5374 Origin vfr, 18 Apr 2010