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-05-23
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 optional-argument (short title) inset.
373 \begin_layout Description
374 Syntax optional-insert
376 \begin_layout Description
377 Origin vermeer, 12 Aug 2002
380 \begin_layout Subsection*
383 \begin_layout Description
384 Action Inserts a horizontal line.
386 \begin_layout Description
389 \begin_layout Description
390 Origin Andre, Oct 27 2003
393 \begin_layout Subsection*
396 \begin_layout Description
397 Action Inserts a new page.
399 \begin_layout Description
400 Syntax newpage-insert <ARG>
402 \begin_layout Description
403 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
405 \begin_layout Description
406 Origin uwestoehr, 24 Nov 2007
409 \begin_layout Subsection*
410 LFUN_MARGINALNOTE_INSERT
412 \begin_layout Description
413 Action Inserts a marginal note.
415 \begin_layout Description
416 Syntax marginalnote-insert
418 \begin_layout Description
419 Origin Lgb, 26 Jun 2000
422 \begin_layout Subsection*
425 \begin_layout Description
426 Action Inserts a single unicode character.
428 \begin_layout Description
429 Syntax unicode-insert <CHAR>
431 \begin_layout Description
432 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
434 \begin_layout Description
435 Sample unicode-insert 0x0100
437 \begin_layout Description
438 Origin Lgb, 22 Oct 2006
441 \begin_layout Subsection*
444 \begin_layout Description
445 Action Inserts a new listings inset.
447 \begin_layout Description
448 Syntax listing-insert
450 \begin_layout Description
451 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
454 \begin_layout Subsection*
457 \begin_layout Description
458 Action Inserts a new preview inset.
460 \begin_layout Description
461 Syntax preview-insert
463 \begin_layout Description
464 Origin vfr, 28 Mar 2010
467 \begin_layout Subsection*
470 \begin_layout Description
471 Action Insert a tab into a listings inset.
473 \begin_layout Description
474 Notion It also works on a selection.
476 \begin_layout Description
479 \begin_layout Description
480 Origin vfr, Sep 30 2008
483 \begin_layout Subsection*
486 \begin_layout Description
487 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
489 \begin_layout Description
490 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.
492 \begin_layout Description
495 \begin_layout Description
496 Origin vfr, Sep 30 2008
499 \begin_layout Subsection*
502 \begin_layout Description
503 Action Inserts quotes according to the type and quote-language preference.
505 \begin_layout Description
506 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
508 \begin_layout Description
509 Syntax quote-insert [<TYPE>]
511 \begin_layout Description
512 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
515 \begin_layout Subsection*
518 \begin_layout Description
519 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
521 \begin_layout Description
522 Notion Apart from lfun arguments you can use the following method:
523 \begin_inset Newline newline
526 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
527 \begin_inset Newline newline
530 2. select the text and run info-insert lfun.
532 \begin_layout Description
533 Syntax info-insert <TYPE> <ARG>
535 \begin_layout Description
536 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
537 \begin_inset Newline newline
540 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
541 \begin_inset Newline newline
544 shortcut[s]: name of lfun (e.g math-insert
547 \begin_inset Newline newline
550 lyxrc: name of rc_entry (e.g. bind_file)
551 \begin_inset Newline newline
554 lyxinfo: "version" - used version of LyX
555 \begin_inset Newline newline
558 package: name of latex package (e.g. listings)
559 \begin_inset Newline newline
562 textclass: name of textclass (e.g. article)
563 \begin_inset Newline newline
566 menu: name of lfun used in menu
567 \begin_inset Newline newline
570 icon: name of lfun used in toolbar
571 \begin_inset Newline newline
574 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
576 \begin_layout Description
577 Sample command-sequence info-insert buffer path; info-insert buffer name
579 \begin_layout Description
580 Origin bpeng, 7 Oct 2007
583 \begin_layout Subsection*
586 \begin_layout Description
587 Action Inserts branch inset.
589 \begin_layout Description
590 Syntax branch-insert <BRANCH-NAME>
592 \begin_layout Description
593 Origin vermeer, 17 Aug 2003
596 \begin_layout Subsection*
599 \begin_layout Description
600 Action Inserts Box inset.
602 \begin_layout Description
603 Syntax box-insert [<TYPE>]
605 \begin_layout Description
606 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
607 \begin_inset Newline newline
610 Framed is the default one.
612 \begin_layout Description
613 Origin vermeer, 7 Oct 2003
616 \begin_layout Subsection*
619 \begin_layout Description
620 Action Inserts CharStyle, Custom inset or XML short element.
622 \begin_layout Description
623 Notion Look into the Customization manual for more information about these elements.
624 \begin_inset Newline newline
627 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.
628 \begin_inset Newline newline
631 For dissolving the element see LFUN_INSET_DISSOLVE.
633 \begin_layout Description
634 Syntax flex-insert <TYPE:Name>
636 \begin_layout Description
637 Params TYPE: CharStyle|Custom|Element|Standard
638 \begin_inset Newline newline
641 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.
642 \begin_inset Newline newline
645 Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
647 \begin_layout Description
648 Sample flex-insert CharStyle:Code
651 \begin_layout Subsection*
654 \begin_layout Description
655 Action Inserts the given string (accordingly to the correct keymap).
657 \begin_layout Description
658 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
660 \begin_layout Description
661 Syntax self-insert <STRING>
664 \begin_layout Subsection*
667 \begin_layout Description
668 Action Inserts one of horizontal space insets.
670 \begin_layout Description
671 Syntax space-insert <NAME> [<LEN>]
673 \begin_layout Description
674 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
675 \begin_inset Newline newline
678 <LEN>: length for custom spaces (hspace, hspace* for protected)
680 \begin_layout Description
681 Origin JSpitzm, 20 May 2003, Mar 17 2008
684 \begin_layout Subsection*
685 LFUN_HYPERLINK_INSERT
687 \begin_layout Description
688 Action Inserts hyperlinks into the document (clickable in pdf output).
690 \begin_layout Description
691 Notion Hyperlink target can be set via selection + hyperlink-insert function.
693 \begin_layout Description
694 Syntax href-insert [<TARGET>]
696 \begin_layout Description
697 Origin CFO-G, 21 Nov 1997
700 \begin_layout Subsection*
701 LFUN_SPECIALCHAR_INSERT
703 \begin_layout Description
704 Action Inserts various characters into the document.
706 \begin_layout Description
707 Syntax specialchar-insert <CHAR>
709 \begin_layout Description
710 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
712 \begin_layout Description
713 Origin JSpitzm, 6 Dec 2007
716 \begin_layout Subsection*
719 \begin_layout Description
720 Action Inserts table of contents.
722 \begin_layout Description
725 \begin_layout Description
726 Origin Lgb, 27 May 97
729 \begin_layout Subsection*
732 \begin_layout Description
733 Action Start (or remove) Appendix on the given cursor position.
735 \begin_layout Description
738 \begin_layout Description
739 Origin ettrich, 5 May 1998
742 \begin_layout Subsection*
745 \begin_layout Description
746 Action Inserts Index entry.
748 \begin_layout Description
749 Notion It automatically takes the word on the cursor position.
751 \begin_layout Description
752 Syntax index-insert [<TYPE:Name>]
754 \begin_layout Description
755 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
757 \begin_layout Description
758 Origin leeming, 3 Aug 2000
761 \begin_layout Subsection*
764 \begin_layout Description
765 Action Inserts list of Index entries on a new page.
767 \begin_layout Description
768 Syntax index-print [<TYPE:Name>]
770 \begin_layout Description
771 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
773 \begin_layout Description
774 Origin Lgb, 27 Feb 1997
777 \begin_layout Subsection*
780 \begin_layout Description
781 Action Inserts Nomenclature entry.
783 \begin_layout Description
784 Notion It automatically takes the word on the cursor position if no symbol is given.
786 \begin_layout Description
787 Syntax nomencl-insert [<SYMBOL>]
789 \begin_layout Description
790 Origin Ugras, 4 Nov 2006
793 \begin_layout Subsection*
794 LFUN_NOMENCLATURE_PRINT
796 \begin_layout Description
797 Action Inserts list of Nomenclature entries.
799 \begin_layout Description
800 Syntax nomenclature-print
802 \begin_layout Description
803 Origin Ugras, 4 Nov 2006
806 \begin_layout Subsection*
809 \begin_layout Description
810 Action Inserts Note on the current cursor postion, move selection inside the inset.
812 \begin_layout Description
813 Syntax note-insert [<TYPE>]
815 \begin_layout Description
816 Params <TYPE>: <Note|Greyedout|Comment> default: Note
819 \begin_layout Subsection*
822 \begin_layout Description
823 Action Moves the cursor to the begining of next Note inset.
825 \begin_layout Description
829 \begin_layout Subsection*
832 \begin_layout Description
833 Action Inserts phantom on the current cursor postion, move selection inside the inset.
835 \begin_layout Description
836 Syntax phantom-insert [<TYPE>]
838 \begin_layout Description
839 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
841 \begin_layout Description
842 Origin uwestoehr, 30 Jan 2009
845 \begin_layout Subsection*
848 \begin_layout Description
849 Action Inserts a line break or new line.
851 \begin_layout Description
852 Syntax newline-insert [<ARG>]
854 \begin_layout Description
855 Params <ARG>: <newline|linebreak> default: newline
857 \begin_layout Description
858 Origin JSpitzm, 25 Mar 2008
861 \begin_layout Subsection*
864 \begin_layout Description
865 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
867 \begin_layout Description
870 \begin_layout Description
871 Origin Lgb, 17 May 2001
874 \begin_layout Subsection*
877 \begin_layout Description
878 Action Moves the cursor one line in downward direction.
880 \begin_layout Description
884 \begin_layout Subsection*
887 \begin_layout Description
888 Action Moves the cursor one line in upward direction.
890 \begin_layout Description
894 \begin_layout Subsection*
897 \begin_layout Description
898 Action Moves the cursor one line in downward direction adding the current position to the selection.
900 \begin_layout Description
904 \begin_layout Subsection*
907 \begin_layout Description
908 Action Moves the cursor one line in upward direction adding the current position to the selection.
910 \begin_layout Description
914 \begin_layout Subsection*
917 \begin_layout Description
918 Action Moves the cursor one page in downward direction.
920 \begin_layout Description
924 \begin_layout Subsection*
927 \begin_layout Description
928 Action Moves the cursor one page in upward direction.
930 \begin_layout Description
934 \begin_layout Subsection*
935 LFUN_SCREEN_DOWN_SELECT
937 \begin_layout Description
938 Action Moves the cursor one screen in downward direction adding the current position to the selection.
940 \begin_layout Description
941 Syntax screen-down-select
944 \begin_layout Subsection*
945 LFUN_SCREEN_UP_SELECT
947 \begin_layout Description
948 Action Moves the cursor one page in upward direction adding the current position to the selection.
950 \begin_layout Description
951 Syntax screen-up-select
954 \begin_layout Subsection*
957 \begin_layout Description
958 Action Scroll the buffer view.
960 \begin_layout Description
961 Notion Only scrolls the screen up or down; does not move the cursor.
963 \begin_layout Description
964 Syntax scroll <TYPE> <QUANTITY>
966 \begin_layout Description
967 Params <TYPE>: line|page
968 \begin_inset Newline newline
971 <QUANTITY>: up|down|<number>
973 \begin_layout Description
974 Origin Abdel, Dec 27 2007
977 \begin_layout Subsection*
980 \begin_layout Description
981 Action Recenters the screen on the current cursor position.
983 \begin_layout Description
984 Syntax screen-recenter
987 \begin_layout Subsection*
988 LFUN_SCREEN_SHOW_CURSOR
990 \begin_layout Description
991 Action Repositions the screen such that the cursor is visible.
993 \begin_layout Description
994 Syntax screen-show-cursor
996 \begin_layout Description
997 Origin vfr, 25 Mar 2009
1000 \begin_layout Subsection*
1003 \begin_layout Description
1004 Action Moves the cursor one position logically backwards.
1006 \begin_layout Description
1007 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.
1009 \begin_layout Description
1010 Syntax char-backward
1013 \begin_layout Subsection*
1014 LFUN_CHAR_BACKWARD_SELECT
1016 \begin_layout Description
1017 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1019 \begin_layout Description
1020 Notion See also LFUN_CHAR_BACKWARD.
1022 \begin_layout Description
1023 Syntax char-backward-select
1026 \begin_layout Subsection*
1027 LFUN_CHAR_DELETE_BACKWARD
1029 \begin_layout Description
1030 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1032 \begin_layout Description
1033 Syntax char-delete-backward
1036 \begin_layout Subsection*
1037 LFUN_CHAR_DELETE_FORWARD
1039 \begin_layout Description
1040 Action Deletes one character in the backward direction (usually the "Delete" key).
1042 \begin_layout Description
1043 Syntax char-delete-forward
1046 \begin_layout Subsection*
1049 \begin_layout Description
1050 Action Moves the cursor one position logically forward.
1052 \begin_layout Description
1053 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.
1055 \begin_layout Description
1059 \begin_layout Subsection*
1060 LFUN_CHAR_FORWARD_SELECT
1062 \begin_layout Description
1063 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1065 \begin_layout Description
1066 Notion See also LFUN_CHAR_FORWARD.
1068 \begin_layout Description
1069 Syntax char-forward-select
1072 \begin_layout Subsection*
1075 \begin_layout Description
1076 Action Moves the cursor one position "to the left".
1078 \begin_layout Description
1079 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.
1081 \begin_layout Description
1085 \begin_layout Subsection*
1086 LFUN_CHAR_LEFT_SELECT
1088 \begin_layout Description
1089 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1091 \begin_layout Description
1092 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1094 \begin_layout Description
1095 Syntax char-left-select
1098 \begin_layout Subsection*
1101 \begin_layout Description
1102 Action Moves the cursor one position "to the right".
1104 \begin_layout Description
1105 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.
1107 \begin_layout Description
1111 \begin_layout Subsection*
1112 LFUN_CHAR_RIGHT_SELECT
1114 \begin_layout Description
1115 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1117 \begin_layout Description
1118 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1120 \begin_layout Description
1121 Syntax char-right-select
1124 \begin_layout Subsection*
1127 \begin_layout Description
1128 Action Moves the cursor to the logically previous beginning of a word.
1130 \begin_layout Description
1131 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.
1133 \begin_layout Description
1134 Syntax word-backward
1137 \begin_layout Subsection*
1138 LFUN_WORD_BACKWARD_SELECT
1140 \begin_layout Description
1141 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1143 \begin_layout Description
1144 Notion See also LFUN_WORD_BACKWARD.
1146 \begin_layout Description
1147 Syntax word-backward-select
1150 \begin_layout Subsection*
1151 LFUN_WORD_DELETE_BACKWARD
1153 \begin_layout Description
1154 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1156 \begin_layout Description
1157 Syntax word-delete-backward
1160 \begin_layout Subsection*
1161 LFUN_WORD_DELETE_FORWARD
1163 \begin_layout Description
1164 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1166 \begin_layout Description
1167 Syntax word-delete-forward
1170 \begin_layout Subsection*
1171 LFUN_WORD_FIND_FORWARD
1173 \begin_layout Description
1174 Action Search for a given string in forward direction.
1176 \begin_layout Description
1177 Notion Case sensitive, match words. If no argument given, last search repeated.
1179 \begin_layout Description
1180 Syntax word-find-forward [<STRING>]
1182 \begin_layout Description
1183 Origin Etienne, 16 Feb 1998
1186 \begin_layout Subsection*
1187 LFUN_WORD_FIND_BACKWARD
1189 \begin_layout Description
1190 Action Search for a given string in backward direction.
1192 \begin_layout Description
1193 Notion Case sensitive, match words. If no argument given, last search repeated.
1195 \begin_layout Description
1196 Syntax word-find-backward [<STRING>]
1198 \begin_layout Description
1199 Origin Etienne, 20 Feb 1998
1202 \begin_layout Subsection*
1205 \begin_layout Description
1206 Action Search for next occurence of a string.
1208 \begin_layout Description
1209 Syntax word-find [<DATA>]
1211 \begin_layout Description
1212 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).
1214 \begin_layout Description
1215 Origin Andre, Jan 7 2004
1218 \begin_layout Subsection*
1221 \begin_layout Description
1222 Action Replace a string in the document.
1224 \begin_layout Description
1225 Syntax word-replace [<DATA>]
1227 \begin_layout Description
1228 Params <DATA>: data is of the form "<replace>
1229 \begin_inset Newline newline
1233 \begin_inset Newline newline
1236 <casesensitive> <matchword> <all> <forward>"
1238 \begin_layout Description
1239 Origin Andre, Jan 7 2004
1242 \begin_layout Subsection*
1245 \begin_layout Description
1246 Action Search for next occurence of a pattern.
1248 \begin_layout Description
1249 Syntax word-findadv [<DATA>]
1251 \begin_layout Description
1252 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).
1254 \begin_layout Description
1255 Origin Tommaso, Nov 15 2007
1258 \begin_layout Subsection*
1261 \begin_layout Description
1262 Action Moves the cursor to the logically next beginning of a word.
1264 \begin_layout Description
1265 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.
1267 \begin_layout Description
1271 \begin_layout Subsection*
1272 LFUN_WORD_FORWARD_SELECT
1274 \begin_layout Description
1275 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1277 \begin_layout Description
1278 Notion See also LFUN_WORD_FORWARD.
1280 \begin_layout Description
1281 Syntax word-forward-select
1284 \begin_layout Subsection*
1287 \begin_layout Description
1288 Action Moves the cursor to the next beginning of a word "on the left".
1290 \begin_layout Description
1291 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.
1293 \begin_layout Description
1296 \begin_layout Description
1297 Origin dov, 28 Oct 2007
1300 \begin_layout Subsection*
1301 LFUN_WORD_LEFT_SELECT
1303 \begin_layout Description
1304 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1306 \begin_layout Description
1307 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1309 \begin_layout Description
1310 Syntax word-left-select
1312 \begin_layout Description
1313 Origin dov, 28 Oct 2007
1316 \begin_layout Subsection*
1319 \begin_layout Description
1320 Action Moves the cursor to the next beginning of a word "on the right".
1322 \begin_layout Description
1323 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.
1325 \begin_layout Description
1328 \begin_layout Description
1329 Origin dov, 28 Oct 2007
1332 \begin_layout Subsection*
1333 LFUN_WORD_RIGHT_SELECT
1335 \begin_layout Description
1336 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1338 \begin_layout Description
1339 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1341 \begin_layout Description
1342 Syntax word-right-select
1344 \begin_layout Description
1345 Origin dov, 28 Oct 2007
1348 \begin_layout Subsection*
1351 \begin_layout Description
1352 Action Puts the word where the cursor stands into the selection.
1354 \begin_layout Description
1357 \begin_layout Description
1358 Origin Andre, 11 Sep 2002
1361 \begin_layout Subsection*
1362 LFUN_WORD_CAPITALIZE
1364 \begin_layout Description
1365 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1367 \begin_layout Description
1368 Syntax word-capitalize
1371 \begin_layout Subsection*
1374 \begin_layout Description
1375 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1377 \begin_layout Description
1381 \begin_layout Subsection*
1384 \begin_layout Description
1385 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1387 \begin_layout Description
1391 \begin_layout Subsection*
1394 \begin_layout Description
1395 Action Add the word under the cursor to the respective spell checker dictionary.
1397 \begin_layout Description
1398 Syntax spelling-add [<STRING>] [<LANG>]
1400 \begin_layout Description
1401 Params <WORD>: word to add <LANG>: language name (see file languages)
1403 \begin_layout Description
1404 Origin JSpitzm, 18 Jan 2010
1407 \begin_layout Subsection*
1408 LFUN_SPELLING_IGNORE
1410 \begin_layout Description
1411 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
1413 \begin_layout Description
1414 Syntax spelling-ignore [<WORD>] [<LANG>]
1416 \begin_layout Description
1417 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1419 \begin_layout Description
1420 Origin JSpitzm, 18 Jan 2010
1423 \begin_layout Subsection*
1424 LFUN_THESAURUS_ENTRY
1426 \begin_layout Description
1427 Action Look up thesaurus entries with respect to the word under the cursor.
1429 \begin_layout Description
1430 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1432 \begin_layout Description
1433 Params <STRING>: word to look up <LANG>: language (see file languages)
1435 \begin_layout Description
1436 Origin Levon, 20 Jul 2001
1439 \begin_layout Subsection*
1442 \begin_layout Description
1443 Action Move the cursor to the beginning of the document.
1445 \begin_layout Description
1449 \begin_layout Subsection*
1450 LFUN_BUFFER_BEGIN_SELECT
1452 \begin_layout Description
1453 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1455 \begin_layout Description
1456 Syntax buffer-begin-select
1459 \begin_layout Subsection*
1462 \begin_layout Description
1463 Action Move the cursor to the end of the document.
1465 \begin_layout Description
1469 \begin_layout Subsection*
1470 LFUN_BUFFER_END_SELECT
1472 \begin_layout Description
1473 Action Move the cursor to the end of the document adding the traversed text to the selection.
1475 \begin_layout Description
1476 Syntax buffer-end-select
1479 \begin_layout Subsection*
1482 \begin_layout Description
1483 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
1485 \begin_layout Description
1488 \begin_layout Description
1489 Origin lasgouttes, 16 Mar 2009
1492 \begin_layout Subsection*
1493 LFUN_INSET_BEGIN_SELECT
1495 \begin_layout Description
1496 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).
1498 \begin_layout Description
1499 Syntax inset-begin-select
1501 \begin_layout Description
1502 Origin lasgouttes, 16 Mar 2009
1505 \begin_layout Subsection*
1508 \begin_layout Description
1509 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
1511 \begin_layout Description
1514 \begin_layout Description
1515 Origin lasgouttes, 16 Mar 2009
1518 \begin_layout Subsection*
1519 LFUN_INSET_END_SELECT
1521 \begin_layout Description
1522 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).
1524 \begin_layout Description
1525 Syntax inset-end-select
1527 \begin_layout Description
1528 Origin lasgouttes, 16 Mar 2009
1531 \begin_layout Subsection*
1532 LFUN_INSET_SELECT_ALL
1534 \begin_layout Description
1535 Action Selects all contents of an inset.
1537 \begin_layout Description
1538 Syntax inset-select-all
1540 \begin_layout Description
1541 Origin vfr, 22 Aug 2009
1544 \begin_layout Subsection*
1547 \begin_layout Description
1548 Action Selects the whole section.
1550 \begin_layout Description
1551 Notion The cursor should be in a section heading before calling this lfun.
1553 \begin_layout Description
1554 Syntax section-select
1556 \begin_layout Description
1557 Origin vfr, 05 May 2009
1560 \begin_layout Subsection*
1563 \begin_layout Description
1564 Action Move the cursor to the begining of the (screen) line.
1566 \begin_layout Description
1570 \begin_layout Subsection*
1571 LFUN_LINE_BEGIN_SELECT
1573 \begin_layout Description
1574 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1576 \begin_layout Description
1577 Syntax line-begin-select
1580 \begin_layout Subsection*
1583 \begin_layout Description
1584 Action Move the cursor to the end of the (screen) line.
1586 \begin_layout Description
1590 \begin_layout Subsection*
1591 LFUN_LINE_END_SELECT
1593 \begin_layout Description
1594 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1596 \begin_layout Description
1597 Syntax line-end-select
1600 \begin_layout Subsection*
1603 \begin_layout Description
1604 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1606 \begin_layout Description
1607 Syntax line-delete-forward
1610 \begin_layout Subsection*
1613 \begin_layout Description
1614 Action Copies to the clipboard the last edit.
1616 \begin_layout Description
1620 \begin_layout Subsection*
1623 \begin_layout Description
1624 Action Cuts to the clipboard.
1626 \begin_layout Description
1630 \begin_layout Subsection*
1633 \begin_layout Description
1634 Action Pastes material (text or picture) from the active clipboard.
1636 \begin_layout Description
1637 Syntax paste [<TYPE>|<NUM>]
1639 \begin_layout Description
1640 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1641 \begin_inset Newline newline
1644 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1647 \begin_layout Subsection*
1648 LFUN_CLIPBOARD_PASTE
1650 \begin_layout Description
1651 Action Pastes text from the active clipboard.
1653 \begin_layout Description
1654 Syntax clipboard-paste [<ARG>]
1656 \begin_layout Description
1657 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1659 \begin_layout Description
1660 Origin baum, 10 Jul 2006
1663 \begin_layout Subsection*
1664 LFUN_PRIMARY_SELECTION_PASTE
1666 \begin_layout Description
1667 Action Pastes the currently text selected text.
1669 \begin_layout Description
1670 Notion Primary selection mechanism is linux-only thing.
1672 \begin_layout Description
1673 Syntax primary-selection-paste [<ARG>]
1675 \begin_layout Description
1676 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1679 \begin_layout Subsection*
1680 LFUN_SELECTION_PASTE
1682 \begin_layout Description
1683 Action Pastes the text in permanent selection.
1685 \begin_layout Description
1686 Syntax selection-paste
1689 \begin_layout Subsection*
1692 \begin_layout Description
1693 Action Undoes the last edit.
1695 \begin_layout Description
1699 \begin_layout Subsection*
1702 \begin_layout Description
1703 Action Redoes the last thing undone.
1705 \begin_layout Description
1709 \begin_layout Subsection*
1712 \begin_layout Description
1713 Action Repeat the given command.
1715 \begin_layout Description
1716 Syntax repeat <COUNT> <LFUN-COMMAND>
1718 \begin_layout Description
1719 Origin Andre, 27 Oct 2003
1722 \begin_layout Subsection*
1723 LFUN_CHARS_TRANSPOSE
1725 \begin_layout Description
1726 Action Transposes the character at the cursor with the one before it.
1728 \begin_layout Description
1729 Syntax chars-transpose
1731 \begin_layout Description
1732 Origin Lgb, 25 Apr 2001
1735 \begin_layout Subsection*
1736 LFUN_DEPTH_DECREMENT
1738 \begin_layout Description
1739 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1741 \begin_layout Description
1742 Syntax depth-decrement
1745 \begin_layout Subsection*
1746 LFUN_DEPTH_INCREMENT
1748 \begin_layout Description
1749 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1751 \begin_layout Description
1752 Syntax depth-increment
1755 \begin_layout Subsection*
1758 \begin_layout Description
1759 Action Toggles the bold font (selection-wise) using mathbf in math.
1761 \begin_layout Description
1765 \begin_layout Subsection*
1766 LFUN_FONT_BOLDSYMBOL
1768 \begin_layout Description
1769 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1771 \begin_layout Description
1772 Syntax font-boldsymbol
1775 \begin_layout Subsection*
1776 LFUN_FONT_TYPEWRITER
1778 \begin_layout Description
1779 Action Toggles the typewriter family font (selection-wise).
1781 \begin_layout Description
1782 Syntax font-typewriter
1785 \begin_layout Subsection*
1788 \begin_layout Description
1789 Action Toggles underline in the font (selection-wise).
1791 \begin_layout Description
1792 Syntax font-underline
1795 \begin_layout Subsection*
1798 \begin_layout Description
1799 Action Toggles double underline in the font (selection-wise).
1801 \begin_layout Description
1802 Syntax font-underunderline
1804 \begin_layout Description
1805 Origin sanda, 5 May 2009
1808 \begin_layout Subsection*
1811 \begin_layout Description
1812 Action Toggles wavy underline in the font (selection-wise).
1814 \begin_layout Description
1815 Syntax font-underwave
1817 \begin_layout Description
1818 Origin sanda, 5 May 2009
1821 \begin_layout Subsection*
1824 \begin_layout Description
1825 Action Toggles strikeout (strike-through) in the font (selection-wise).
1827 \begin_layout Description
1828 Syntax font-strikeout
1830 \begin_layout Description
1831 Origin sanda, 3 May 2009
1834 \begin_layout Subsection*
1837 \begin_layout Description
1838 Action Toggles the emphasis font style (selection-wise).
1840 \begin_layout Description
1844 \begin_layout Subsection*
1847 \begin_layout Description
1848 Action Toggles Noun text style font (selection-wise).
1850 \begin_layout Description
1854 \begin_layout Subsection*
1857 \begin_layout Description
1858 Action Toggles Roman family font (selection-wise).
1860 \begin_layout Description
1864 \begin_layout Subsection*
1867 \begin_layout Description
1868 Action Toggles Sans Serif family font (selection-wise).
1870 \begin_layout Description
1874 \begin_layout Subsection*
1877 \begin_layout Description
1878 Action Toggles Fraktur family font (math-mode, selection-wise).
1880 \begin_layout Description
1883 \begin_layout Description
1884 Origin vermeer, 10 Jan 2002
1887 \begin_layout Subsection*
1890 \begin_layout Description
1891 Action Toggles Italics font shape (math-mode, selection-wise).
1893 \begin_layout Description
1896 \begin_layout Description
1897 Origin vermeer, 10 Jan 2002
1900 \begin_layout Subsection*
1903 \begin_layout Description
1904 Action Reverts the settings of the font to the default values (selection-wise).
1906 \begin_layout Description
1910 \begin_layout Subsection*
1913 \begin_layout Description
1914 Action Sets font size according to lyx format string.
1916 \begin_layout Description
1917 Syntax font-size <SIZE>
1919 \begin_layout Description
1920 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1921 \begin_inset Newline newline
1924 largest|huge|giant|increase|decrease|default
1927 \begin_layout Subsection*
1928 LFUN_TEXTSTYLE_APPLY
1930 \begin_layout Description
1931 Action Toggle user-defined (=last-time used) text style.
1933 \begin_layout Description
1934 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1936 \begin_layout Description
1937 Syntax textstyle-apply
1939 \begin_layout Description
1940 Origin leeming, 12 Mar 2003
1943 \begin_layout Subsection*
1944 LFUN_TEXTSTYLE_UPDATE
1946 \begin_layout Description
1947 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1949 \begin_layout Description
1950 Syntax textstyle-update <FONT_INFO>
1952 \begin_layout Description
1953 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1954 \begin_inset Newline newline
1957 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1959 \begin_layout Description
1960 Origin leeming, 12 Mar 2003
1963 \begin_layout Subsection*
1964 LFUN_SCREEN_FONT_UPDATE
1966 \begin_layout Description
1967 Action Update fonts and its metrics.
1969 \begin_layout Description
1970 Notion Automatically called after zoom, dpi, font names, or norm change.
1972 \begin_layout Description
1973 Syntax screen-font-update
1975 \begin_layout Description
1976 Origin ARRae, 13 Aug 2000
1979 \begin_layout Subsection*
1982 \begin_layout Description
1983 Action Returns the info about the current font.
1985 \begin_layout Description
1989 \begin_layout Subsection*
1990 LFUN_CITATION_INSERT
1992 \begin_layout Description
1993 Action Inserts citation from loaded citation database.
1995 \begin_layout Description
1996 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1998 \begin_layout Description
1999 Params <KEY>: Citation (shortcut listed in available citations).
2000 \begin_inset Newline newline
2003 <TEXT_BEFORE>: text which should appear before citation.
2005 \begin_layout Description
2006 Origin AAS, 97-02-23
2009 \begin_layout Subsection*
2010 LFUN_BIBTEX_DATABASE_ADD
2012 \begin_layout Description
2013 Action Adds database, which will be used for bibtex citations.
2015 \begin_layout Description
2016 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2018 \begin_layout Description
2019 Syntax bibtex-database-add <DATABASE-NAME>
2021 \begin_layout Description
2022 Origin Ale, 30 May 1997
2025 \begin_layout Subsection*
2026 LFUN_BIBTEX_DATABASE_DEL
2028 \begin_layout Description
2029 Action Adds database, which will be used for bibtex citations.
2031 \begin_layout Description
2032 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2034 \begin_layout Description
2035 Syntax bibtex-database-del <DATABASE-NAME>
2037 \begin_layout Description
2038 Origin Ale, 30 May 1997
2041 \begin_layout Subsection*
2044 \begin_layout Description
2045 Action Sets the layout (that is, environment) for the current paragraph.
2047 \begin_layout Description
2048 Syntax layout <LAYOUT>
2050 \begin_layout Description
2051 Params <LAYOUT>: the layout to use
2054 \begin_layout Subsection*
2055 LFUN_LAYOUT_PARAGRAPH
2057 \begin_layout Description
2058 Action Launches the paragraph settings dialog.
2060 \begin_layout Description
2061 Syntax layout-paragraph
2064 \begin_layout Subsection*
2067 \begin_layout Description
2068 Action Launches the tabular settings dialog.
2070 \begin_layout Description
2071 Syntax layout-tabular
2073 \begin_layout Description
2074 Origin Jug, 31 Jul 2000
2077 \begin_layout Subsection*
2078 LFUN_DROP_LAYOUTS_CHOICE
2080 \begin_layout Description
2081 Action Displays list of layout choices.
2083 \begin_layout Description
2084 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
2086 \begin_layout Description
2087 Syntax drop-layouts-choice
2090 \begin_layout Subsection*
2091 LFUN_LAYOUT_MODULES_CLEAR
2093 \begin_layout Description
2094 Action Clears the module list.
2096 \begin_layout Description
2097 Notion Clears the list of included modules for the current buffer.
2099 \begin_layout Description
2100 Syntax layout-modules-clear
2102 \begin_layout Description
2103 Origin rgh, 25 August 2007
2106 \begin_layout Subsection*
2107 LFUN_LAYOUT_MODULE_ADD
2109 \begin_layout Description
2110 Action Adds a module.
2112 \begin_layout Description
2113 Notion Adds a module to the list of included modules for the current buffer.
2115 \begin_layout Description
2116 Syntax layout-module-add <MODULE>
2118 \begin_layout Description
2119 Params <MODULE>: the module to be added
2121 \begin_layout Description
2122 Origin rgh, 25 August 2007
2125 \begin_layout Subsection*
2128 \begin_layout Description
2129 Action Reloads layout information.
2131 \begin_layout Description
2132 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.
2134 \begin_layout Description
2135 Syntax layout-reload
2137 \begin_layout Description
2138 Origin rgh, 3 September 2007
2141 \begin_layout Subsection*
2142 LFUN_TEXTCLASS_APPLY
2144 \begin_layout Description
2145 Action Sets the text class for the current buffer.
2147 \begin_layout Description
2148 Syntax textclass-apply <TEXTCLASS>
2150 \begin_layout Description
2151 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2154 \begin_layout Subsection*
2157 \begin_layout Description
2158 Action Loads information for a textclass from disk.
2160 \begin_layout Description
2161 Syntax textclass-load <TEXTCLASS>
2163 \begin_layout Description
2164 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2167 \begin_layout Subsection*
2170 \begin_layout Description
2171 Action Disable selecting of text-region.
2173 \begin_layout Description
2177 \begin_layout Subsection*
2180 \begin_layout Description
2181 Action Enable selecting of text-region.
2183 \begin_layout Description
2184 Notion After enabling you can simply move arrow keys to get selected region.
2186 \begin_layout Description
2190 \begin_layout Subsection*
2193 \begin_layout Description
2194 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2196 \begin_layout Description
2199 \begin_layout Description
2200 Origin Andre, May 5 2006
2203 \begin_layout Subsection*
2206 \begin_layout Description
2207 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2209 \begin_layout Description
2210 Syntax math-delim [<LEFT>] [<RIGHT>]
2212 \begin_layout Description
2213 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.
2215 \begin_layout Description
2216 Sample math-delim { rangle
2218 \begin_layout Description
2219 Origin Alejandro, 18 Jun 1996
2222 \begin_layout Subsection*
2225 \begin_layout Description
2226 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2228 \begin_layout Description
2229 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2231 \begin_layout Description
2232 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2233 \begin_inset Newline newline
2236 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2238 \begin_layout Description
2239 Sample math-bigdelim "Bigl" "
2245 \begin_layout Description
2246 Origin Enrico & Georg, 7 May 2006
2249 \begin_layout Subsection*
2252 \begin_layout Description
2253 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2255 \begin_layout Description
2256 Syntax math-display [<ARG>]
2258 \begin_layout Description
2259 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2261 \begin_layout Description
2262 Origin Alejandro, 18 Jun 1996
2265 \begin_layout Subsection*
2268 \begin_layout Description
2269 Action Inserts math objects and symbols.
2271 \begin_layout Description
2272 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
2274 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
2276 frac{x}{y}" replaces "abc" with "
2278 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.
2280 \begin_layout Description
2281 Syntax math-insert <ARG>
2283 \begin_layout Description
2284 Params <ARG>: Symbol or LaTeX code to be inserted.
2287 \begin_layout Subsection*
2290 \begin_layout Description
2291 Action Enters subscript expression in math expression.
2293 \begin_layout Description
2294 Syntax math-subscript
2296 \begin_layout Description
2297 Origin vermeer, 12 Dec 2001
2300 \begin_layout Subsection*
2301 LFUN_MATH_SUPERSCRIPT
2303 \begin_layout Description
2304 Action Enters subscript expression in math expression.
2306 \begin_layout Description
2307 Syntax math-superscript
2309 \begin_layout Description
2310 Origin vermeer, 12 Dec 2001
2313 \begin_layout Subsection*
2316 \begin_layout Description
2317 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.
2319 \begin_layout Description
2320 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2322 \begin_layout Description
2323 Syntax math-limits [<STATE>]
2325 \begin_layout Description
2326 Params <STATE>: limits|nolimits
2329 \begin_layout Subsection*
2332 \begin_layout Description
2333 Action Inserts a math macro definition at the cursor position in the text.
2335 \begin_layout Description
2336 Syntax math-macro <NAME> [<NARGS>] [def]
2338 \begin_layout Description
2339 Params <NAME>: The name of the macro, e.g. "mymacro".
2340 \begin_inset Newline newline
2343 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2345 \begin_layout Description
2346 Origin ale, 10 May 1997; sts, 21 Dec 2007
2349 \begin_layout Subsection*
2352 \begin_layout Description
2353 Action Mutates the type of math inset to the newly selected one.
2355 \begin_layout Description
2356 Syntax math-mutate <TYPE>
2358 \begin_layout Description
2359 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2361 \begin_layout Description
2362 Origin Andre, 23 May 2001
2365 \begin_layout Subsection*
2368 \begin_layout Description
2369 Action Inserts space into math expression.
2371 \begin_layout Description
2372 Notion Use spacebar after entering this space to change type of space.
2374 \begin_layout Description
2375 Syntax math-space [<TYPE>] [<LEN>]
2377 \begin_layout Description
2378 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2379 \begin_inset Newline newline
2382 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2383 \begin_inset Newline newline
2386 custom space: hspace
2387 \begin_inset Newline newline
2390 "," used by default.
2391 \begin_inset Newline newline
2394 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2395 \begin_inset Newline newline
2398 <LEN>: length for custom spaces (hspace)
2400 \begin_layout Description
2401 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2404 \begin_layout Subsection*
2407 \begin_layout Description
2408 Action Inserts a matrix.
2410 \begin_layout Description
2411 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2413 \begin_layout Description
2414 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).
2416 \begin_layout Description
2417 Sample math-matrix 3 3 bccc
2420 \begin_layout Subsection*
2421 LFUN_MATH_AMS_MATRIX
2423 \begin_layout Description
2424 Action Inserts a matrix.
2426 \begin_layout Description
2427 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
2429 \begin_layout Description
2430 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
2432 \begin_layout Description
2433 Sample math-ams-matrix 3 3 bmatrix
2436 \begin_layout Subsection*
2439 \begin_layout Description
2440 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.
2442 \begin_layout Description
2443 Notion If there is some selected text, it puts the text inside created math box.
2445 \begin_layout Description
2446 Syntax math-mode [on|<ARG>]
2448 \begin_layout Description
2449 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2450 \begin_inset Newline newline
2453 "on": allow only entering of math mode from text mode.
2455 \begin_layout Description
2456 Origin Alejandro, 4 Jun 1996
2459 \begin_layout Subsection*
2462 \begin_layout Description
2463 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2465 \begin_layout Description
2466 Notion If there is any selected text, then it is moved inside the created regexp inset.
2468 \begin_layout Description
2469 Syntax regexp-mode [<ARG>]
2471 \begin_layout Description
2472 Params <ARG>: eventual argument (regular expression).
2474 \begin_layout Description
2475 Origin Tommaso, 4 Oct 2008
2478 \begin_layout Subsection*
2479 LFUN_MATH_NUMBER_LINE_TOGGLE
2481 \begin_layout Description
2482 Action Toggles numbering of the current formula line.
2484 \begin_layout Description
2485 Notion Must be in display formula mode.
2487 \begin_layout Description
2488 Syntax math-number-line-toggle
2490 \begin_layout Description
2491 Origin Alejandro, 18 Jun 1996
2494 \begin_layout Subsection*
2495 LFUN_MATH_NUMBER_TOGGLE
2497 \begin_layout Description
2498 Action Toggles numbering/labeling of the current formula.
2500 \begin_layout Description
2501 Notion Must be in display formula mode.
2503 \begin_layout Description
2504 Syntax math-number-toggle
2506 \begin_layout Description
2507 Origin Alejandro, 4 Jun 1996
2510 \begin_layout Subsection*
2513 \begin_layout Description
2514 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2516 \begin_layout Description
2517 Notion Selection can be used to determine the input for the external program.
2519 \begin_layout Description
2520 Syntax math-extern <LANG> [<COMMAND>]
2522 \begin_layout Description
2523 Params <LANG>: octave|maxima|maple|mathematica|script
2524 \begin_inset Newline newline
2527 where "script" stands fot the external script (normalized expression will be passed)
2529 \begin_layout Description
2530 Sample math-extern maple simplify
2532 \begin_layout Description
2533 Origin Andre, 24 Apr 2001
2536 \begin_layout Subsection*
2539 \begin_layout Description
2540 Action Changes arbitrarily the size used by math fonts inside a context.
2542 \begin_layout Description
2543 Notion Provides an interface to the LaTeX math mode font size commands.
2545 \begin_layout Description
2546 Syntax math-size <STYLE>
2548 \begin_layout Description
2559 \begin_layout Description
2560 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2563 \begin_layout Subsection*
2564 LFUN_MATH_FONT_STYLE
2566 \begin_layout Description
2567 Action Changes the text style used in math.
2569 \begin_layout Description
2570 Syntax math-font-style <STYLE>
2572 \begin_layout Description
2573 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2575 \begin_layout Description
2576 Origin vfr, 9 jan 2009
2579 \begin_layout Subsection*
2580 LFUN_MATH_MACRO_UNFOLD
2582 \begin_layout Description
2583 Action Unfold a Math Macro.
2585 \begin_layout Description
2586 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2590 \begin_layout Description
2591 Syntax math-macro-unfold
2593 \begin_layout Description
2594 Origin sts, 06 January 2008
2597 \begin_layout Subsection*
2598 LFUN_MATH_MACRO_FOLD
2600 \begin_layout Description
2601 Action Fold a Math Macro.
2603 \begin_layout Description
2604 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2608 \begin_layout Description
2609 Syntax math-macro-fold
2611 \begin_layout Description
2612 Origin sts, 06 January 2008
2615 \begin_layout Subsection*
2616 LFUN_MATH_MACRO_ADD_PARAM
2618 \begin_layout Description
2619 Action Add a parameter.
2621 \begin_layout Description
2622 Notion Add a parameter to a Math Macro.
2624 \begin_layout Description
2625 Syntax math-macro-add-param <NUM>
2627 \begin_layout Description
2628 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.
2630 \begin_layout Description
2631 Origin sts, 06 January 2008
2634 \begin_layout Subsection*
2635 LFUN_MATH_MACRO_REMOVE_PARAM
2637 \begin_layout Description
2638 Action Remove the last parameter.
2640 \begin_layout Description
2641 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2643 \begin_layout Description
2644 Syntax math-macro-remove-param <NUM>
2646 \begin_layout Description
2647 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2649 \begin_layout Description
2650 Origin sts, 06 January 2008
2653 \begin_layout Subsection*
2654 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2656 \begin_layout Description
2657 Action Append a greedy parameter.
2659 \begin_layout Description
2660 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2662 \begin_layout Description
2663 Syntax math-macro-append-greedy-param
2665 \begin_layout Description
2666 Origin sts, 06 January 2008
2669 \begin_layout Subsection*
2670 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2672 \begin_layout Description
2673 Action Remove a greedy parameter.
2675 \begin_layout Description
2676 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.
2678 \begin_layout Description
2679 Syntax math-macro-remove-greedy-param
2681 \begin_layout Description
2682 Origin sts, 06 January 2008
2685 \begin_layout Subsection*
2686 LFUN_MATH_MACRO_MAKE_OPTIONAL
2688 \begin_layout Description
2689 Action Make a parameter optional.
2691 \begin_layout Description
2692 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2694 \begin_layout Description
2695 Syntax math-macro-make-optional
2697 \begin_layout Description
2698 Origin sts, 06 January 2008
2701 \begin_layout Subsection*
2702 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2704 \begin_layout Description
2705 Action Make a parameter non-optional.
2707 \begin_layout Description
2708 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.
2710 \begin_layout Description
2711 Syntax math-macro-make-nonoptional
2713 \begin_layout Description
2714 Origin sts, 06 January 2008
2717 \begin_layout Subsection*
2718 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2720 \begin_layout Description
2721 Action Add an optional parameter.
2723 \begin_layout Description
2724 Notion Insert an optional parameter just behind the already existing optional parameters.
2726 \begin_layout Description
2727 Syntax math-macro-add-optional-param
2729 \begin_layout Description
2730 Origin sts, 06 January 2008
2733 \begin_layout Subsection*
2734 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2736 \begin_layout Description
2737 Action Remove the last optional parameter.
2739 \begin_layout Description
2740 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2742 \begin_layout Description
2743 Syntax math-macro-remove-optional-param
2745 \begin_layout Description
2746 Origin sts, 06 January 2008
2749 \begin_layout Subsection*
2750 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2752 \begin_layout Description
2753 Action Add a greedy optional parameter.
2755 \begin_layout Description
2756 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2758 \begin_layout Description
2759 Syntax math-macro-add-greedy-optional-param
2761 \begin_layout Description
2762 Origin sts, 06 January 2008
2765 \begin_layout Subsection*
2766 LFUN_IN_MATHMACROTEMPLATE
2768 \begin_layout Description
2769 Action Only active in Math Macro definition.
2771 \begin_layout Description
2772 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.
2774 \begin_layout Description
2775 Syntax in-mathmacrotemplate
2777 \begin_layout Description
2778 Origin sts, 06 January 2008
2781 \begin_layout Subsection*
2782 LFUN_PARAGRAPH_MOVE_DOWN
2784 \begin_layout Description
2785 Action Moves the current paragraph downwards in the document.
2787 \begin_layout Description
2788 Syntax paragraph-move-down
2790 \begin_layout Description
2791 Origin Edwin, 8 Apr 2006
2794 \begin_layout Subsection*
2795 LFUN_PARAGRAPH_MOVE_UP
2797 \begin_layout Description
2798 Action Moves the current paragraph upwards in the document.
2800 \begin_layout Description
2801 Syntax paragraph-move-up
2803 \begin_layout Description
2804 Origin Edwin, 8 Apr 2006
2807 \begin_layout Subsection*
2810 \begin_layout Description
2811 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2813 \begin_layout Description
2816 \begin_layout Description
2817 Origin Asger, 1 Oct 1996
2820 \begin_layout Subsection*
2821 LFUN_PARAGRAPH_UP_SELECT
2823 \begin_layout Description
2824 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2826 \begin_layout Description
2827 Syntax paragraph-up-select
2829 \begin_layout Description
2830 Origin Asger, 1 Oct 1996
2833 \begin_layout Subsection*
2836 \begin_layout Description
2837 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2839 \begin_layout Description
2840 Syntax paragraph-down
2842 \begin_layout Description
2843 Origin Asger, 1 Oct 1996
2846 \begin_layout Subsection*
2847 LFUN_PARAGRAPH_DOWN_SELECT
2849 \begin_layout Description
2850 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2852 \begin_layout Description
2853 Syntax paragraph-down-select
2855 \begin_layout Description
2856 Origin Asger, 1 Oct 1996
2859 \begin_layout Subsection*
2862 \begin_layout Description
2863 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2865 \begin_layout Description
2866 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).
2868 \begin_layout Description
2869 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2871 \begin_layout Description
2872 Params <PAR_ID_NUMBER>: paragraph id
2873 \begin_inset Newline newline
2876 <POSITION_IN_PAR>: desired position within the paragraph
2878 \begin_layout Description
2879 Origin Dekel, 26 Aug 2000
2882 \begin_layout Subsection*
2883 LFUN_BREAK_PARAGRAPH
2885 \begin_layout Description
2886 Action Breaks the current paragraph at the current location.
2888 \begin_layout Description
2889 Notion Removes the selection.
2891 \begin_layout Description
2892 Syntax break-paragraph [<LAYOUT>]
2894 \begin_layout Description
2895 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2898 \begin_layout Subsection*
2899 LFUN_PARAGRAPH_PARAMS
2901 \begin_layout Description
2902 Action Change paragraph settings.
2904 \begin_layout Description
2905 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.
2907 \begin_layout Description
2908 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2910 \begin_layout Description
2920 \begin_inset Newline newline
2925 paragraph_spacing default|single|onehalf|double|other SIZE
2926 \begin_inset Newline newline
2931 align block|left|right|center|default
2932 \begin_inset Newline newline
2937 labelwidthstring WIDTH|
2941 \begin_layout Description
2942 Origin rgh, Aug 15 2007
2945 \begin_layout Subsection*
2946 LFUN_PARAGRAPH_PARAMS_APPLY
2948 \begin_layout Description
2949 Action Change paragraph settings.
2951 \begin_layout Description
2952 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2954 \begin_layout Description
2955 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2957 \begin_layout Description
2958 Params For parameters see LFUN_PARAGRAPH_PARAMS
2960 \begin_layout Description
2961 Origin leeming, 30 Mar 2004
2964 \begin_layout Subsection*
2965 LFUN_PARAGRAPH_UPDATE
2967 \begin_layout Description
2968 Action Updates the values inside the paragraph dialog from the paragraph.
2970 \begin_layout Description
2971 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2973 \begin_layout Description
2974 Origin leeming, 13 Mar 2003
2977 \begin_layout Subsection*
2980 \begin_layout Description
2981 Action Move the current group in the upward direction in the structure of the document.
2983 \begin_layout Description
2984 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2986 \begin_layout Description
2989 \begin_layout Description
2990 Origin Vermeer, 23 Mar 2006
2993 \begin_layout Subsection*
2996 \begin_layout Description
2997 Action Move the current group in the downward direction in the structure of the document.
2999 \begin_layout Description
3000 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3002 \begin_layout Description
3005 \begin_layout Description
3006 Origin Vermeer, 23 Mar 2006
3009 \begin_layout Subsection*
3012 \begin_layout Description
3013 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3015 \begin_layout Description
3016 Notion Part -> Chapter -> Section -> etc.
3018 \begin_layout Description
3021 \begin_layout Description
3022 Origin Vermeer, 23 Mar 2006
3025 \begin_layout Subsection*
3028 \begin_layout Description
3029 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3031 \begin_layout Description
3032 Notion Part <- Chapter <- Section <- etc.
3034 \begin_layout Description
3037 \begin_layout Description
3038 Origin Vermeer, 23 Mar 2006
3041 \begin_layout Subsection*
3044 \begin_layout Description
3045 Action Edit the inset at cursor with an external application, if one is attributed.
3047 \begin_layout Description
3048 Syntax inset-edit [<INSET_PARAMS>]
3050 \begin_layout Description
3051 Params <INSET_PARAMS>: Parameters for the inset.
3052 \begin_inset Newline newline
3055 Currently only the filename will be considered.
3057 \begin_layout Description
3058 Origin JSpitzm, 27 Apr 2006
3061 \begin_layout Subsection*
3064 \begin_layout Description
3065 Action Inserts table into the document.
3067 \begin_layout Description
3068 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3070 \begin_layout Description
3071 Syntax tabular-insert [<ROWS> <COLUMNS>]
3073 \begin_layout Description
3074 Params In case no arguments are given show insert dialog.
3076 \begin_layout Description
3077 Origin Jug, 12 Apr 2000
3080 \begin_layout Subsection*
3083 \begin_layout Description
3084 Action Moves the cursor to the previous cell inside the table.
3086 \begin_layout Description
3087 Syntax cell-backward
3089 \begin_layout Description
3090 Origin Jug, 22 May 2000
3093 \begin_layout Subsection*
3096 \begin_layout Description
3097 Action Moves the cursor to the next cell inside the table.
3099 \begin_layout Description
3103 \begin_layout Subsection*
3106 \begin_layout Description
3107 Action Splits cell and shifts right part to the next cell (inside the math grid).
3109 \begin_layout Description
3112 \begin_layout Description
3113 Origin Ale, 15 May 1997
3116 \begin_layout Subsection*
3119 \begin_layout Description
3120 Action Register the document as an file inside version control system (RCS, CVS).
3122 \begin_layout Description
3123 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3124 \begin_inset Newline newline
3127 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3129 \begin_layout Description
3132 \begin_layout Description
3133 Origin Lgb, 1 Jul 1997
3136 \begin_layout Subsection*
3139 \begin_layout Description
3140 Action Checks-in/commits the changes of the registered file to the repository.
3142 \begin_layout Description
3143 Notion In RCS case this also unlocks the file.
3145 \begin_layout Description
3148 \begin_layout Description
3149 Origin Lgb, 1 Jul 1997
3152 \begin_layout Subsection*
3155 \begin_layout Description
3156 Action Checks-out the document for edit (and locks it for RCS).
3158 \begin_layout Description
3159 Notion This is implemented only for RCS and SVN, not CVS.
3161 \begin_layout Description
3164 \begin_layout Description
3165 Origin Lgb, 1 Jul 1997
3168 \begin_layout Subsection*
3171 \begin_layout Description
3172 Action Reverts the document to the last check-in/commit in VCS.
3174 \begin_layout Description
3177 \begin_layout Description
3178 Origin Lgb, 1 Jul 1997
3181 \begin_layout Subsection*
3184 \begin_layout Description
3185 Action Undo last check-in.
3187 \begin_layout Description
3188 Notion This is currently implemented only for RCS.
3190 \begin_layout Description
3193 \begin_layout Description
3194 Origin Lgb, 1 Jul 1997
3197 \begin_layout Subsection*
3200 \begin_layout Description
3201 Action Executes external command. This command is intended to support additional VCS commands.
3203 \begin_layout Description
3204 Syntax vc-command <FLAG> <PATH> <COMMAND>
3206 \begin_layout Description
3207 Params <FLAG>: Flags for the command can be combined together.
3208 \begin_inset Newline newline
3211 U - dUmmy - no flags
3212 \begin_inset Newline newline
3215 D - Doc - need document loaded to proceed
3216 \begin_inset Newline newline
3219 I - dIrty - mark document dirty
3220 \begin_inset Newline newline
3223 R - Reload - ensure that the document is saved and reload it after command execution
3224 \begin_inset Newline newline
3227 M - Message - ask for input string (commit message)
3228 \begin_inset Newline newline
3231 <PATH>: path where to start. $$p will be replaced by the current document path.
3232 \begin_inset Newline newline
3235 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
3237 \begin_layout Description
3238 Sample vc-command DR $$p "svn up"
3240 \begin_layout Description
3241 Origin sanda, 13 Jan 2009
3244 \begin_layout Subsection*
3245 LFUN_VC_LOCKING_TOGGLE
3247 \begin_layout Description
3248 Action Toggles the locking property of the edited file.
3250 \begin_layout Description
3251 Notion This is currently implemented only for SVN.
3253 \begin_layout Description
3254 Syntax vc-locking-toggle
3256 \begin_layout Description
3257 Origin sanda, 25 Jun 2009
3260 \begin_layout Subsection*
3263 \begin_layout Description
3264 Action Update the local archive directory in which resides the current document with the remote repository.
3266 \begin_layout Description
3267 Notion This is currently implemented only for SVN.
3269 \begin_layout Description
3270 Syntax vc-repo-update
3272 \begin_layout Description
3273 Origin sanda, 16 Oct 2009
3276 \begin_layout Subsection*
3279 \begin_layout Description
3280 Action Compares two revisions of the same file under version control.
3282 \begin_layout Description
3283 Notion This is currently implemented only for SVN and RCS.
3285 \begin_layout Description
3286 Syntax vc-compare <REV1> [<REV2>]
3288 \begin_layout Description
3289 Params Revision number either points directly to commit in history or if negative number -x it points to last commit - x.
3290 \begin_inset Newline newline
3293 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
3294 \begin_inset Newline newline
3298 \begin_inset Newline newline
3301 <REV2>: Newer file. Used only if REV1 > 0.
3303 \begin_layout Description
3304 Sample Compare current document against last commit
3305 \begin_inset Newline newline
3308 vc-compare 0Compare current document against current revision - 5 commits
3309 \begin_inset Newline newline
3312 vc-compare -5Compare revisions 120 and 155
3313 \begin_inset Newline newline
3318 \begin_layout Description
3319 Origin sanda, 12 Feb 2010
3322 \begin_layout Subsection*
3325 \begin_layout Description
3326 Action Toggles change tracking to on/off.
3328 \begin_layout Description
3329 Syntax changes-track
3331 \begin_layout Description
3332 Origin levon, 1 Oct 2002
3335 \begin_layout Subsection*
3338 \begin_layout Description
3339 Action Toggles showing of change tracking in typesetted output.
3341 \begin_layout Description
3342 Syntax changes-output
3344 \begin_layout Description
3345 Origin jspitzm, 21 Jan 2005
3348 \begin_layout Subsection*
3351 \begin_layout Description
3352 Action Moves the cursor to the position of the next change of the change tracking records.
3354 \begin_layout Description
3357 \begin_layout Description
3358 Origin schmitt, 4 Oct 2006
3361 \begin_layout Subsection*
3362 LFUN_CHANGE_PREVIOUS
3364 \begin_layout Description
3365 Action Moves the cursor to the position of the previous change of the change tracking records.
3367 \begin_layout Description
3368 Syntax change-previous
3370 \begin_layout Description
3371 Origin vfr, 4 Apr 2009
3374 \begin_layout Subsection*
3377 \begin_layout Description
3378 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3380 \begin_layout Description
3381 Syntax changes-merge
3383 \begin_layout Description
3384 Origin Levon, 16 Oct 2002
3387 \begin_layout Subsection*
3390 \begin_layout Description
3391 Action Accepts tracked change inside the selection.
3393 \begin_layout Description
3394 Syntax change-accept
3396 \begin_layout Description
3397 Origin Levon, 16 Oct 2002
3400 \begin_layout Subsection*
3403 \begin_layout Description
3404 Action Rejects tracked change inside the selection.
3406 \begin_layout Description
3407 Syntax change-accept
3409 \begin_layout Description
3410 Origin Levon, 16 Oct 2002
3413 \begin_layout Subsection*
3414 LFUN_ALL_CHANGES_ACCEPT
3416 \begin_layout Description
3417 Action Accepts all tracked changes in the document.
3419 \begin_layout Description
3420 Syntax all-changes-accept
3422 \begin_layout Description
3423 Origin Levon, 16 Oct 2002
3426 \begin_layout Subsection*
3427 LFUN_ALL_CHANGES_REJECT
3429 \begin_layout Description
3430 Action Rejects all tracked changes in the document.
3432 \begin_layout Description
3433 Notion Reject does not work recursively; the user may have to repeat the operation.
3435 \begin_layout Description
3436 Syntax all-changes-reject
3438 \begin_layout Description
3439 Origin Levon, 16 Oct 2002
3442 \begin_layout Subsection*
3445 \begin_layout Description
3446 Action Apply data for an inset.
3448 \begin_layout Description
3449 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.
3451 \begin_layout Description
3452 Syntax inset-apply <ARGS>
3454 \begin_layout Description
3455 Params See LFUN_INSET_INSERT .
3458 \begin_layout Subsection*
3461 \begin_layout Description
3462 Action Dissolve the current inset into text.
3464 \begin_layout Description
3465 Syntax inset-dissolve [<INSET>]
3467 \begin_layout Description
3468 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.
3469 \begin_inset Newline newline
3472 For values see lyx::InsetLayout::lyxtype_ .
3474 \begin_layout Description
3475 Origin JSpitz, 7 Aug 2006
3478 \begin_layout Subsection*
3481 \begin_layout Description
3482 Action Insert new inset (type given by the parameters).
3484 \begin_layout Description
3485 Syntax inset-insert <INSET> <ARGS>
3487 \begin_layout Description
3488 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular hyperlink|include|index|label|nomencl|vspace|ref|toc>
3489 \begin_inset Newline newline
3492 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3494 \begin_layout Description
3495 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3498 \begin_inset Newline newline
3501 where <label name> is the name of the referenced label and <Format> is one of the following:
3502 \begin_inset Newline newline
3506 \begin_inset Newline newline
3509 eqref -- (<reference>)
3510 \begin_inset Newline newline
3514 \begin_inset Newline newline
3517 vpageref -- on <page>
3518 \begin_inset Newline newline
3521 vref -- <reference> on <page>
3522 \begin_inset Newline newline
3525 prettyref -- Formatted reference
3528 \begin_layout Subsection*
3531 \begin_layout Description
3532 Action Modify some properties of an inset.
3534 \begin_layout Description
3535 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.
3537 \begin_layout Description
3538 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
3540 \begin_layout Description
3541 Params Generally see LFUN_INSET_INSERT for further details.
3542 \begin_inset Newline newline
3545 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.
3546 \begin_inset Newline newline
3549 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| align-left|align-right|align-center|align-block|valign-top|valign-bottom| valign-middle|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
3550 \begin_inset Newline newline
3553 <ARG>: additional argument for some commands, use debug mode to explore its values.
3555 \begin_layout Description
3556 Sample inset-modify note Note Commentinset-modify changetype Ovalbox
3559 \begin_layout Subsection*
3560 LFUN_INSET_DIALOG_UPDATE
3562 \begin_layout Description
3563 Action Updates the values inside the dialog from the inset.
3565 \begin_layout Description
3566 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3568 \begin_layout Description
3569 Params <DIALOG-NAME>
3571 \begin_layout Description
3572 Origin leeming, 25 Feb 2003
3575 \begin_layout Subsection*
3578 \begin_layout Description
3579 Action Open the inset's properties dialog.
3581 \begin_layout Description
3582 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3584 \begin_layout Description
3585 Syntax inset-settings <INSET>
3587 \begin_layout Description
3588 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float| graphics|href|include|index|index_print|label|listings| note|phantom|ref|space|tabular|vspace|wrap>.
3591 \begin_layout Subsection*
3594 \begin_layout Description
3595 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3597 \begin_layout Description
3598 Syntax inset-toggle [<ARG>]
3600 \begin_layout Description
3601 Params <ARG>: <open|close|toggle|assign>.
3602 \begin_inset Newline newline
3605 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3606 \begin_inset Newline newline
3609 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3611 \begin_layout Description
3612 Origin lasgouttes, 19 Jul 2001
3615 \begin_layout Subsection*
3618 \begin_layout Description
3619 Action Apply the given commands on insets of a given name.
3621 \begin_layout Description
3622 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.
3624 \begin_layout Description
3625 Syntax inset-forall <NAME> <LFUN-COMMAND>
3626 \begin_inset Newline newline
3629 <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.
3631 \begin_layout Description
3632 Sample Remove all index insets:
3633 \begin_inset Newline newline
3636 inset-forall Index delete-char-forward
3637 \begin_inset Newline newline
3640 Close all Notes (also works for a particular branch, for example):
3641 \begin_inset Newline newline
3644 inset-forall Note inset-toggle close
3645 \begin_inset Newline newline
3648 Transform all yellow notes to comments
3649 \begin_inset Newline newline
3652 inset-forall Note:Note inset-modify note Note Comment
3653 \begin_inset Newline newline
3656 Try to put LyX in an infinite loop if there is at least a Note:
3657 \begin_inset Newline newline
3660 inset-forall Note char-backward
3662 \begin_layout Description
3663 Origin lasgouttes, 27 Nov 2009
3666 \begin_layout Subsection*
3667 LFUN_GRAPHICS_RELOAD
3669 \begin_layout Description
3670 Action Reloads the image if necessary.
3672 \begin_layout Description
3673 Syntax graphics-reload
3675 \begin_layout Description
3676 Origin vfr, 10 Aug 2009
3679 \begin_layout Subsection*
3680 LFUN_SET_GRAPHICS_GROUP
3682 \begin_layout Description
3683 Action Set the group for the graphics inset on the cursor position.
3685 \begin_layout Description
3686 Syntax set-graphics-group [<GROUP>]
3688 \begin_layout Description
3689 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3691 \begin_layout Description
3692 Origin sanda, 6 May 2008
3695 \begin_layout Subsection*
3696 LFUN_FINISHED_FORWARD
3698 \begin_layout Description
3699 Action Moves the cursor out of the current slice, going forward.
3701 \begin_layout Description
3702 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.
3705 \begin_layout Subsection*
3706 LFUN_FINISHED_BACKWARD
3708 \begin_layout Description
3709 Action Moves the cursor out of the current slice, going backwards.
3711 \begin_layout Description
3712 Notion See also LFUN_FINISHED_FORWARD.
3715 \begin_layout Subsection*
3718 \begin_layout Description
3719 Action Moves the cursor out of the current slice, going right.
3721 \begin_layout Description
3722 Notion See also LFUN_FINISHED_FORWARD
3725 \begin_layout Subsection*
3728 \begin_layout Description
3729 Action Moves the cursor out of the current slice, going left.
3731 \begin_layout Description
3732 Notion See also LFUN_FINISHED_FORWARD.
3735 \begin_layout Subsection*
3738 \begin_layout Description
3739 Action Set language from the current cursor position.
3741 \begin_layout Description
3742 Syntax language <LANG>
3744 \begin_layout Description
3745 Params <LANG>: Requested language. Look in lib/languages for the list.
3747 \begin_layout Description
3748 Origin Dekel, 2 Mar 2000
3751 \begin_layout Subsection*
3754 \begin_layout Description
3755 Action Goto a label.
3757 \begin_layout Description
3758 Syntax label-goto [<LABEL>]
3760 \begin_layout Description
3761 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.
3763 \begin_layout Description
3764 Origin Ale, 6 Aug 1997
3767 \begin_layout Subsection*
3770 \begin_layout Description
3771 Action Inserts label to text or displayed formula.
3773 \begin_layout Description
3774 Syntax label-insert [<LABEL>]
3776 \begin_layout Description
3777 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3780 \begin_layout Subsection*
3783 \begin_layout Description
3784 Action Go to the next label or cross-reference.
3786 \begin_layout Description
3787 Syntax reference-next
3789 \begin_layout Description
3790 Origin Dekel, 14 Jan 2001
3793 \begin_layout Subsection*
3796 \begin_layout Description
3797 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3799 \begin_layout Description
3800 Notion Bookmark 0 has a special purpose. It is automatically set
3801 \begin_inset Newline newline
3804 1. to the paragraph you are currently editing
3805 \begin_inset Newline newline
3808 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3809 \begin_inset Newline newline
3812 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3814 \begin_layout Description
3815 Syntax bookmark-goto <NUMBER>
3817 \begin_layout Description
3818 Params <NUMBER>: the number of the bookmark to restore.
3820 \begin_layout Description
3821 Origin Dekel, 27 January 2001
3824 \begin_layout Subsection*
3827 \begin_layout Description
3828 Action Save a bookmark.
3830 \begin_layout Description
3831 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.
3833 \begin_layout Description
3834 Syntax bookmark-save <NUMBER>
3836 \begin_layout Description
3837 Params <NUMBER>: the number of the bookmark to save.
3839 \begin_layout Description
3840 Origin Dekel, 27 January 2001
3843 \begin_layout Subsection*
3846 \begin_layout Description
3847 Action Clears the list of saved bookmarks.
3849 \begin_layout Description
3850 Syntax bookmark-clear
3852 \begin_layout Description
3853 Origin bpeng, 31 October 2006
3856 \begin_layout Subsection*
3859 \begin_layout Description
3860 Action Open the given help file according to the language setting.
3862 \begin_layout Description
3863 Syntax help-open <FILE>[.lyx]
3865 \begin_layout Description
3866 Params <FILE>: any document from (/usr/share/)doc directory.
3868 \begin_layout Description
3869 Origin Jug, 27 Jun 1999
3872 \begin_layout Subsection*
3875 \begin_layout Description
3876 Action Terminates the current LyX instance.
3878 \begin_layout Description
3879 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3881 \begin_layout Description
3885 \begin_layout Subsection*
3888 \begin_layout Description
3889 Action Toggles visibility of a given toolbar between on/off/auto.
3891 \begin_layout Description
3892 Notion Skipping "auto" when allowauto is false.
3894 \begin_layout Description
3895 Syntax toolbar-toggle <NAME> [allowauto]
3897 \begin_layout Description
3898 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
3900 \begin_layout Description
3901 Origin Edwin, 21 May 2007
3904 \begin_layout Subsection*
3907 \begin_layout Description
3908 Action Opens the menu given by its name.
3910 \begin_layout Description
3911 Syntax menu-open <NAME>
3913 \begin_layout Description
3914 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3917 \begin_layout Subsection*
3920 \begin_layout Description
3921 Action Various UI visibility-toggling actions.
3923 \begin_layout Description
3924 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3926 \begin_layout Description
3927 Params statusbar : Toggle visibility of the statusbar.
3928 \begin_inset Newline newline
3931 menubar : Toggle visibility of the menubar.
3932 \begin_inset Newline newline
3935 scrollbar : Toggle visibility of the scrollbar.
3936 \begin_inset Newline newline
3939 frame : Toggle visibility of the frames around editing window.
3940 \begin_inset Newline newline
3943 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.
3945 \begin_layout Description
3946 Origin sanda, 9 Feb 2007
3949 \begin_layout Subsection*
3952 \begin_layout Description
3953 Action Creates new empty LyX window.
3955 \begin_layout Description
3956 Notion Already opened documents from the previous window can be found under View menu.
3958 \begin_layout Description
3959 Syntax window-new [<GEOMETRY>]
3961 \begin_layout Description
3962 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3964 \begin_layout Description
3965 Origin Abdel, 21 Oct 2006
3968 \begin_layout Subsection*
3971 \begin_layout Description
3972 Action Closes the current LyX window.
3974 \begin_layout Description
3977 \begin_layout Description
3978 Origin Abdel, 23 Oct 2006
3981 \begin_layout Subsection*
3984 \begin_layout Description
3985 Action Creates another split view of current buffer.
3987 \begin_layout Description
3988 Notion All split views act in the same way indpendently.
3990 \begin_layout Description
3991 Syntax split-view <vertical|horizontal>
3993 \begin_layout Description
3994 Params horizontal : The work areas are laid out side by side.
3995 \begin_inset Newline newline
3998 vertical : The work areas laid out vertically.
4000 \begin_layout Description
4001 Origin Abdel, 20 Feb 2008
4004 \begin_layout Subsection*
4005 LFUN_CLOSE_TAB_GROUP
4007 \begin_layout Description
4008 Action Close the current tab group.
4010 \begin_layout Description
4011 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
4013 \begin_layout Description
4014 Syntax close-tab-group
4016 \begin_layout Description
4017 Origin Abdel, 21 Feb 2008
4020 \begin_layout Subsection*
4023 \begin_layout Description
4024 Action Shows hidden dialog or create new one for a given function/inset settings etc.
4026 \begin_layout Description
4027 Syntax dialog-show <NAME> [<DATA>]
4029 \begin_layout Description
4030 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4031 \begin_inset Newline newline
4034 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
4035 \begin_inset Newline newline
4038 graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|
4039 \begin_inset Newline newline
4042 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
4043 \begin_inset Newline newline
4046 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
4047 \begin_inset Newline newline
4050 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
4051 \begin_inset Newline newline
4054 <SPECIAL>: latexlog|vclog
4055 \begin_inset Newline newline
4058 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
4060 \begin_layout Description
4061 Origin leeming, 17 Jun 2003
4064 \begin_layout Subsection*
4065 LFUN_DIALOG_SHOW_NEW_INSET
4067 \begin_layout Description
4068 Action Shows hidden dialog or create new one for a given inset settings etc.
4070 \begin_layout Description
4071 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
4073 \begin_layout Description
4074 Syntax dialog-show-new-inset <NAME> [<DATA>]
4076 \begin_layout Description
4077 Params See LFUN_DIALOG_SHOW .
4079 \begin_layout Description
4080 Origin leeming, 25 Feb 2003
4083 \begin_layout Subsection*
4086 \begin_layout Description
4087 Action Updates the dialog values from the inset/paragraph/document.
4089 \begin_layout Description
4090 Syntax dialog-update <NAME>
4092 \begin_layout Description
4093 Params <NAME>: paragraph|prefs|<INSET>
4094 \begin_inset Newline newline
4099 \begin_layout Description
4100 Origin leeming, 25 Feb 2003
4103 \begin_layout Subsection*
4106 \begin_layout Description
4107 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
4109 \begin_layout Description
4110 Syntax dialog-hide <NAME>
4112 \begin_layout Description
4113 Params See LFUN_DIALOG_SHOW .
4115 \begin_layout Description
4116 Origin leeming, 25 Feb 2003
4119 \begin_layout Subsection*
4122 \begin_layout Description
4123 Action Toggles dialog between showed/hidden state.
4125 \begin_layout Description
4126 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4128 \begin_layout Description
4129 Syntax dialog-toggle <NAME> [<DATA>]
4131 \begin_layout Description
4132 Params See LFUN_DIALOG_SHOW .
4134 \begin_layout Description
4135 Origin JSpitzm, 30 Apr 2007
4138 \begin_layout Subsection*
4139 LFUN_DIALOG_DISCONNECT_INSET
4141 \begin_layout Description
4142 Action Closes opened connection to opened inset.
4144 \begin_layout Description
4145 Notion Connection is used for apply functions.
4147 \begin_layout Description
4148 Syntax dialog-disconnect-inset <INSET-NAME>
4150 \begin_layout Description
4151 Origin leeming, 25 Feb 2003
4154 \begin_layout Subsection*
4157 \begin_layout Description
4158 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
4160 \begin_layout Description
4161 Notion This is internal LFUN, not to be used by users.
4163 \begin_layout Description
4164 Origin Andre, 9 Aug 2002
4167 \begin_layout Subsection*
4170 \begin_layout Description
4171 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
4173 \begin_layout Description
4174 Notion This is internal LFUN, not to be used by users.
4176 \begin_layout Description
4177 Origin Andre, 9 Aug 2002
4180 \begin_layout Subsection*
4183 \begin_layout Description
4184 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4186 \begin_layout Description
4187 Notion This is internal LFUN, not to be used by users.
4189 \begin_layout Description
4190 Origin Andre, 9 Aug 2002
4193 \begin_layout Subsection*
4196 \begin_layout Description
4197 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4199 \begin_layout Description
4200 Notion This is internal LFUN, not to be used by users.
4202 \begin_layout Description
4203 Origin Andre, 9 Aug 2002
4206 \begin_layout Subsection*
4209 \begin_layout Description
4210 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4212 \begin_layout Description
4213 Notion This is internal LFUN, not to be used by users.
4215 \begin_layout Description
4216 Origin Andre, 9 Aug 2002
4219 \begin_layout Subsection*
4222 \begin_layout Description
4223 Action Turn off the loaded keyboard map.
4225 \begin_layout Description
4229 \begin_layout Subsection*
4232 \begin_layout Description
4233 Action Turn on the primary keyboard map.
4235 \begin_layout Description
4236 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.
4237 \begin_inset Newline newline
4240 The language is to be set in the Preferences dialog.
4242 \begin_layout Description
4243 Syntax keymap-primary
4246 \begin_layout Subsection*
4247 LFUN_KEYMAP_SECONDARY
4249 \begin_layout Description
4250 Action Turn on the secondary keyboard map.
4252 \begin_layout Description
4253 Syntax keymap-secondary
4256 \begin_layout Subsection*
4259 \begin_layout Description
4260 Action Toggles keyboard maps (first/second/off).
4262 \begin_layout Description
4263 Syntax keymap-toggle
4265 \begin_layout Description
4266 Origin leeming, 30 Mar 2004
4269 \begin_layout Subsection*
4270 LFUN_SERVER_GET_LAYOUT
4272 \begin_layout Description
4273 Action Returns the current layout (that is environment) name on the cursor position.
4275 \begin_layout Description
4276 Syntax server-get-layout
4279 \begin_layout Subsection*
4280 LFUN_SERVER_GET_FILENAME
4282 \begin_layout Description
4283 Action Returns path and file name of the currently edited document.
4285 \begin_layout Description
4286 Syntax server-get-filename
4289 \begin_layout Subsection*
4290 LFUN_SERVER_GOTO_FILE_ROW
4292 \begin_layout Description
4293 Action Sets the cursor position based on the row number of generated TeX file.
4295 \begin_layout Description
4296 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).
4298 \begin_layout Description
4299 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4301 \begin_layout Description
4302 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.
4303 \begin_inset Newline newline
4306 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.
4308 \begin_layout Description
4309 Origin Edmar, 23 Dec 1998
4312 \begin_layout Subsection*
4315 \begin_layout Description
4316 Action Sets the cursor position in the previewed (e.g. dvi) file based on the row number in LyX window.
4318 \begin_layout Description
4319 Notion The external program used for forward search call can be specified in
4321 forward_search_dvi and
4323 forward_search_pdf RC settings. By default, the value for pdf is empty, while for dvi it is
4324 \begin_inset Newline newline
4327 "xdvi -sourceposition $$n:$$t $$o"
4328 \begin_inset Newline newline
4331 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).
4333 \begin_layout Description
4334 Syntax forward-search
4336 \begin_layout Description
4337 Origin sanda, 14 Apr 2010
4340 \begin_layout Subsection*
4343 \begin_layout Description
4344 Action Sends notify message about the last key-sequence to client.
4346 \begin_layout Description
4347 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4349 \begin_layout Description
4350 Syntax server-notify
4353 \begin_layout Subsection*
4356 \begin_layout Description
4357 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4359 \begin_layout Description
4360 Syntax server-set-xy <X> <Y>
4363 \begin_layout Subsection*
4366 \begin_layout Description
4367 Action Returns the coordinates of cursor position in the editing area.
4369 \begin_layout Description
4370 Syntax server-get-xy
4373 \begin_layout Subsection*
4376 \begin_layout Description
4377 Action Generates the code (literate programming).
4379 \begin_layout Description
4380 Notion Latex file with extension
4382 literate_extension is generated. Then LyX invokes
4384 build_command (with a default of``make'') to generate the code and
4386 build_error_filter to process the compilation error messages.
4387 \begin_inset Newline newline
4390 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:
4391 \begin_inset Newline newline
4396 build_command "my_script my_arguments"
4397 \begin_inset Newline newline
4402 build_error_filter differs from the
4404 literate_error_filter only in that the former will identify error messages from your compiler.
4406 \begin_layout Description
4407 Syntax build-program
4410 \begin_layout Subsection*
4411 LFUN_BUFFER_AUTO_SAVE
4413 \begin_layout Description
4414 Action Saves the current buffer to a temporary file.
4416 \begin_layout Description
4417 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4419 \begin_layout Description
4420 Syntax buffer-auto-save
4423 \begin_layout Subsection*
4424 LFUN_BUFFER_CHILD_OPEN
4426 \begin_layout Description
4427 Action Loads the given child document.
4429 \begin_layout Description
4430 Notion The current document is treated as a parent.
4432 \begin_layout Description
4433 Syntax buffer-child-open <FILE>
4435 \begin_layout Description
4436 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4438 \begin_layout Description
4439 Origin Ale, 28 May 1997
4442 \begin_layout Subsection*
4445 \begin_layout Description
4446 Action Runs chktex for the current document.
4448 \begin_layout Description
4449 Syntax buffer-chktex
4451 \begin_layout Description
4452 Origin Asger, 30 Oct 1997
4455 \begin_layout Subsection*
4456 LFUN_BUFFER_TOGGLE_COMPRESSION
4458 \begin_layout Description
4459 Action Toggles compression of the current document on/off.
4461 \begin_layout Description
4462 Syntax buffer-toggle-compression
4464 \begin_layout Description
4465 Origin bpeng, 27 Apr 2006
4468 \begin_layout Subsection*
4471 \begin_layout Description
4472 Action Closes the current buffer.
4474 \begin_layout Description
4475 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4477 \begin_layout Description
4481 \begin_layout Subsection*
4482 LFUN_BUFFER_CLOSE_ALL
4484 \begin_layout Description
4485 Action Closes all buffers.
4487 \begin_layout Description
4488 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4490 \begin_layout Description
4491 Syntax buffer-close-all
4494 \begin_layout Subsection*
4497 \begin_layout Description
4498 Action Exports the current buffer (document) to the given format.
4500 \begin_layout Description
4501 Syntax buffer-export <FORMAT>
4503 \begin_layout Description
4504 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.
4505 \begin_inset Newline newline
4508 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.
4510 \begin_layout Description
4511 Origin Lgb, 29 Jul 1997
4514 \begin_layout Subsection*
4515 LFUN_BUFFER_EXPORT_CUSTOM
4517 \begin_layout Description
4518 Action Exports the current buffer (document) from the given format using the given command on it.
4520 \begin_layout Description
4521 Syntax buffer-export-custom <FORMAT> <COMMAND>
4523 \begin_layout Description
4524 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4525 \begin_inset Newline newline
4528 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4530 \begin_layout Description
4531 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4533 \begin_layout Description
4534 Origin leeming, 27 Mar 2004
4537 \begin_layout Subsection*
4540 \begin_layout Description
4541 Action Prints the current document.
4543 \begin_layout Description
4544 Notion Many settings can be given via the preferences dialog.
4546 \begin_layout Description
4547 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4549 \begin_layout Description
4550 Params <TARGET> is either "printer" or "file".
4551 \begin_inset Newline newline
4554 <TARGER-NAME> is either "default" or file name or printer name.
4555 \begin_inset Newline newline
4558 <COMMAND> command ensuring the printing job.
4560 \begin_layout Description
4561 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4563 \begin_layout Description
4564 Origin leeming, 28 Mar 2004
4567 \begin_layout Subsection*
4570 \begin_layout Description
4571 Action Import a given file as a lyx document.
4573 \begin_layout Description
4574 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.
4576 \begin_layout Description
4577 Syntax buffer-import <FORMAT> [<FILE>]
4579 \begin_layout Description
4580 Origin Asger, 24 Jul 1998
4583 \begin_layout Subsection*
4586 \begin_layout Description
4587 Action Creates a new buffer (that is, document).
4589 \begin_layout Description
4590 Notion Implicit path can be set in Preferences dialog.
4592 \begin_layout Description
4593 Syntax buffer-new [<FILE>]
4595 \begin_layout Description
4596 Params <FILE>: filename of created file with absolute path.
4599 \begin_layout Subsection*
4600 LFUN_BUFFER_NEW_TEMPLATE
4602 \begin_layout Description
4603 Action Creates a new buffer (that is, document) from a template.
4605 \begin_layout Description
4606 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4608 \begin_layout Description
4609 Syntax buffer-new-template [<FILE>]
4611 \begin_layout Description
4612 Params <FILE>: filename of created file with absolute path.
4615 \begin_layout Subsection*
4618 \begin_layout Description
4619 Action Reverts opened document.
4621 \begin_layout Description
4622 Syntax buffer-reload
4624 \begin_layout Description
4625 Origin Asger, 2 Feb 1997
4628 \begin_layout Subsection*
4631 \begin_layout Description
4632 Action Display/switch to the given buffer.
4634 \begin_layout Description
4635 Syntax buffer-switch <BUFFER>
4637 \begin_layout Description
4638 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
4641 \begin_layout Subsection*
4642 LFUN_BUFFER_TOGGLE_READ_ONLY
4644 \begin_layout Description
4645 Action Toggle editing mode of the current document between read/write and read-only.
4647 \begin_layout Description
4648 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.
4650 \begin_layout Description
4651 Syntax buffer-toggle-read-only
4653 \begin_layout Description
4654 Origin Lgb, 27 May 1997
4657 \begin_layout Subsection*
4660 \begin_layout Description
4661 Action Displays current buffer in chosen format.
4663 \begin_layout Description
4664 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.
4666 \begin_layout Description
4667 Syntax buffer-view [<FORMAT>]
4669 \begin_layout Description
4670 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.
4673 \begin_layout Subsection*
4676 \begin_layout Description
4677 Action Exports the current document and put the result into the temporary directory.
4679 \begin_layout Description
4680 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).
4682 \begin_layout Description
4683 Syntax buffer-update [<FORMAT>]
4685 \begin_layout Description
4686 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.
4688 \begin_layout Description
4689 Origin Dekel, 5 Aug 2000
4692 \begin_layout Subsection*
4695 \begin_layout Description
4696 Action Saves the current buffer.
4698 \begin_layout Description
4699 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.
4701 \begin_layout Description
4705 \begin_layout Subsection*
4706 LFUN_BUFFER_WRITE_AS
4708 \begin_layout Description
4709 Action Rename and save current buffer.
4711 \begin_layout Description
4712 Syntax buffer-write-as <FILENAME>
4714 \begin_layout Description
4715 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4718 \begin_layout Subsection*
4719 LFUN_BUFFER_WRITE_ALL
4721 \begin_layout Description
4722 Action Save all changed documents.
4724 \begin_layout Description
4725 Syntax buffer-write-all
4727 \begin_layout Description
4728 Origin rgh, gpothier 6 Aug 2007
4731 \begin_layout Subsection*
4734 \begin_layout Description
4735 Action Switch to the next opened document.
4737 \begin_layout Description
4738 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4740 \begin_layout Description
4744 \begin_layout Subsection*
4745 LFUN_BUFFER_PREVIOUS
4747 \begin_layout Description
4748 Action Switch to the previous opened document.
4750 \begin_layout Description
4751 Syntax buffer-previous
4754 \begin_layout Subsection*
4755 LFUN_MASTER_BUFFER_UPDATE
4757 \begin_layout Description
4758 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4760 \begin_layout Description
4761 Syntax master-buffer-update [<FORMAT>]
4763 \begin_layout Description
4764 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.
4766 \begin_layout Description
4767 Origin Tommaso, 20 Sep 2007
4770 \begin_layout Subsection*
4771 LFUN_MASTER_BUFFER_VIEW
4773 \begin_layout Description
4774 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4776 \begin_layout Description
4777 Syntax master-buffer-view [<FORMAT>]
4779 \begin_layout Description
4780 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.
4782 \begin_layout Description
4783 Origin Tommaso, 20 Sep 2007
4786 \begin_layout Subsection*
4787 LFUN_BUFFER_LANGUAGE
4789 \begin_layout Description
4790 Action Set language of the current document.
4792 \begin_layout Description
4793 Syntax buffer-language <LANG>
4795 \begin_layout Description
4796 Params <LANG>: language name. See lib/languages for list.
4798 \begin_layout Description
4799 Origin leeming, 30 Mar 2004
4802 \begin_layout Subsection*
4803 LFUN_BUFFER_SAVE_AS_DEFAULT
4805 \begin_layout Description
4806 Action Save the current document settings as default.
4808 \begin_layout Description
4809 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4811 \begin_layout Description
4812 Syntax buffer-save-as-default [<ARGS>]
4814 \begin_layout Description
4815 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4817 \begin_layout Description
4818 Origin leeming, 30 Mar 2004
4821 \begin_layout Subsection*
4822 LFUN_BUFFER_PARAMS_APPLY
4824 \begin_layout Description
4825 Action Apply the given settings to the current document.
4827 \begin_layout Description
4828 Syntax buffer-params-apply [<ARGS>]
4830 \begin_layout Description
4831 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4833 \begin_layout Description
4834 Origin leeming, 30 Mar 2004
4837 \begin_layout Subsection*
4840 \begin_layout Description
4841 Action Inserts another LyX file.
4843 \begin_layout Description
4844 Syntax file-insert [<FILE>]
4846 \begin_layout Description
4847 Params <FILE>: Filename to be inserted.
4850 \begin_layout Subsection*
4851 LFUN_FILE_INSERT_PLAINTEXT
4853 \begin_layout Description
4854 Action Inserts plain text file.
4856 \begin_layout Description
4857 Syntax file-insert-plaintext [<FILE>]
4859 \begin_layout Description
4860 Params <FILE>: Filename to be inserted.
4862 \begin_layout Description
4863 Origin CFO-G, 19 Nov 1997
4866 \begin_layout Subsection*
4867 LFUN_FILE_INSERT_PLAINTEXT_PARA
4869 \begin_layout Description
4870 Action Inserts plain text file as paragraph (i.e. join lines).
4872 \begin_layout Description
4873 Syntax file-insert-plaintext-para [<FILE>]
4875 \begin_layout Description
4876 Params <FILE>: Filename to be inserted.
4878 \begin_layout Description
4879 Origin Levon, 14 Feb 2001
4882 \begin_layout Subsection*
4885 \begin_layout Description
4886 Action Open LyX document.
4888 \begin_layout Description
4889 Syntax file-open [<FILE>]
4891 \begin_layout Description
4892 Params <FILE>: Filename to be opened.
4895 \begin_layout Subsection*
4898 \begin_layout Description
4899 Action Executes a command defined in a .def file.
4901 \begin_layout Description
4902 Notion The definitions are by default read from lib/commands/default.def.
4903 \begin_inset Newline newline
4906 A .def file allows to define a command with
4908 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).
4910 def_file "FileName" allows to include another .def file.
4911 \begin_inset Newline newline
4914 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.
4916 \begin_layout Description
4919 \begin_layout Description
4920 Params <NAME>: Name of the command that must be called.
4922 \begin_layout Description
4923 Origin broider, 2 Oct 2007
4926 \begin_layout Subsection*
4929 \begin_layout Description
4930 Action Simulate halting Meta key (Alt key on PCs).
4932 \begin_layout Description
4933 Notion Used for buffer editation not for GUI control.
4935 \begin_layout Description
4939 \begin_layout Subsection*
4942 \begin_layout Description
4943 Action Cancels sequence prepared by LFUN_META_PREFIX .
4945 \begin_layout Description
4949 \begin_layout Subsection*
4950 LFUN_COMMAND_EXECUTE
4952 \begin_layout Description
4953 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
4955 \begin_layout Description
4956 Notion Usually bound to M-x shortcut.
4958 \begin_layout Description
4959 Syntax command-execute
4962 \begin_layout Subsection*
4965 \begin_layout Description
4966 Action Return the current key sequence and available options as a string.
4968 \begin_layout Description
4969 Notion No options are added if no current map exists.
4970 \begin_inset Newline newline
4973 This is probably usable only with connection to lyxserver.
4975 \begin_layout Description
4976 Syntax command-prefix
4979 \begin_layout Subsection*
4980 LFUN_COMMAND_SEQUENCE
4982 \begin_layout Description
4983 Action Run more commands (LFUN and its parameters) in a sequence.
4985 \begin_layout Description
4986 Syntax command-sequence <CMDS>
4988 \begin_layout Description
4989 Params <CMDS>: Sequence of commands separated by semicolons.
4991 \begin_layout Description
4992 Sample command-sequence cut; ert-insert; self-insert
4994 ; paste; self-insert {}; inset-toggle;
4996 \begin_layout Description
4997 Origin Andre, 11 Nov 1999
5000 \begin_layout Subsection*
5001 LFUN_COMMAND_ALTERNATIVES
5003 \begin_layout Description
5004 Action Runs the first listed command that is enabled.
5006 \begin_layout Description
5007 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
5009 \begin_layout Description
5010 Syntax command-alternatives <CMDS>
5012 \begin_layout Description
5013 Params <CMDS>: Sequence of commands separated by semicolons.
5015 \begin_layout Description
5016 Sample command-alternatives completion-accept;cell-forward
5018 \begin_layout Description
5019 Origin rgh, 24 September 2008
5022 \begin_layout Subsection*
5025 \begin_layout Description
5026 Action Shows message in statusbar (for script purposes).
5028 \begin_layout Description
5029 Syntax message <STRING>
5031 \begin_layout Description
5032 Origin Lgb, 8 Apr 2001
5035 \begin_layout Subsection*
5036 LFUN_DEBUG_LEVEL_SET
5038 \begin_layout Description
5039 Action Set debug output level.
5041 \begin_layout Description
5042 Syntax debug-level-set <LEVEL>
5044 \begin_layout Description
5045 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.
5047 \begin_layout Description
5048 Origin sanda, 28 Dec 2009
5051 \begin_layout Subsection*
5052 LFUN_PREFERENCES_SAVE
5054 \begin_layout Description
5055 Action Save user preferences.
5057 \begin_layout Description
5058 Syntax preferences-save
5060 \begin_layout Description
5061 Origin Lgb, 27 Nov 1999
5064 \begin_layout Subsection*
5067 \begin_layout Description
5068 Action Reconfigure the automatic settings.
5070 \begin_layout Description
5073 \begin_layout Description
5074 Origin Asger, 14 Feb 1997
5077 \begin_layout Subsection*
5080 \begin_layout Description
5081 Action Apply the given settings to user preferences.
5083 \begin_layout Description
5084 Syntax lyxrc-apply <SETTINGS>
5086 \begin_layout Description
5087 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.
5090 \begin_layout Subsection*
5091 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
5093 \begin_layout Description
5094 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
5096 \begin_layout Description
5097 Syntax toggle-cursor-follows-scrollbar
5099 \begin_layout Description
5100 Origin ARRae, 2 Dec 1997
5103 \begin_layout Subsection*
5106 \begin_layout Description
5107 Action Set the given LyX color to the color defined by the X11 name given.
5109 \begin_layout Description
5110 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5112 \begin_layout Description
5113 Syntax set-color <LYX_NAME> <X11_NAME>
5115 \begin_layout Description
5116 Origin SLior, 11 Jun 2000
5119 \begin_layout Subsection*
5122 \begin_layout Description
5123 Action Count the statistics (number of words and characters) in the document or in the given selection.
5125 \begin_layout Description
5126 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5128 \begin_layout Description
5131 \begin_layout Description
5132 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5135 \begin_layout Subsection*
5136 LFUN_COMPLETION_INLINE
5138 \begin_layout Description
5139 Action Show the inline completion at the cursor position.
5141 \begin_layout Description
5142 Syntax completion-inline
5144 \begin_layout Description
5145 Origin sts, Feb 19 2008
5148 \begin_layout Subsection*
5149 LFUN_COMPLETION_POPUP
5151 \begin_layout Description
5152 Action Show the completion popup at the cursor position.
5154 \begin_layout Description
5155 Syntax completion-popup
5157 \begin_layout Description
5158 Origin sts, Feb 19 2008
5161 \begin_layout Subsection*
5162 LFUN_COMPLETION_COMPLETE
5164 \begin_layout Description
5165 Action Try to complete the word or command at the cursor position.
5167 \begin_layout Description
5170 \begin_layout Description
5171 Origin sts, Feb 19 2008
5174 \begin_layout Subsection*
5175 LFUN_COMPLETION_CANCEL
5177 \begin_layout Description
5178 Action Try to cancel completion, either the popup or the inline completion.
5180 \begin_layout Description
5181 Syntax completion-cancel
5183 \begin_layout Description
5184 Origin sts, Sep 07 2008
5187 \begin_layout Subsection*
5188 LFUN_COMPLETION_ACCEPT
5190 \begin_layout Description
5191 Action Accept suggested completion.
5193 \begin_layout Description
5194 Syntax completion-accept
5196 \begin_layout Description
5197 Origin sanda, Sep 08 2008
5200 \begin_layout Subsection*
5203 \begin_layout Description
5204 Action Add a branch to the buffer's BranchList.
5206 \begin_layout Description
5207 Syntax branch-add <BRANCH>
5209 \begin_layout Description
5210 Params <BRANCH>: Name of the branch to add
5212 \begin_layout Description
5213 Origin spitz, 7 Jul 2009
5216 \begin_layout Subsection*
5217 LFUN_BRANCH_ACTIVATE
5219 \begin_layout Description
5220 Action Activate the branch.
5222 \begin_layout Description
5223 Syntax branch-activate <BRANCH>
5225 \begin_layout Description
5226 Params <BRANCH>: The branch to activate
5228 \begin_layout Description
5229 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5230 \begin_inset Newline newline
5233 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5235 \begin_layout Description
5236 Origin rgh, 27 May 2008
5239 \begin_layout Subsection*
5240 LFUN_BRANCH_DEACTIVATE
5242 \begin_layout Description
5243 Action De-activate the branch.
5245 \begin_layout Description
5246 Syntax branch-deactivate <BRANCH>
5248 \begin_layout Description
5249 Params <BRANCH>: The branch to deactivate
5251 \begin_layout Description
5252 Origin rgh, 27 May 2008
5255 \begin_layout Subsection*
5256 LFUN_BRANCHES_RENAME
5258 \begin_layout Description
5259 Action Rename all branches of a given name in a document.
5261 \begin_layout Description
5262 Syntax branches-rename <OLDNAME> <NEWNAME>
5264 \begin_layout Description
5265 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5267 \begin_layout Description
5268 Origin spitz, 9 Jul 2009
5271 \begin_layout Subsection*
5272 LFUN_BRANCH_ADD_INSERT
5274 \begin_layout Description
5275 Action Create new branch and directly put the branch inset into the document.
5277 \begin_layout Description
5278 Syntax branch-add-insert [<NAME>]
5280 \begin_layout Description
5281 Params <NAME>: Branch name. If it is not specified, you will be asked.
5283 \begin_layout Description
5284 Origin sanda, 10 Jul 2009
5287 \begin_layout Subsection*
5288 LFUN_LABEL_COPY_AS_REF
5290 \begin_layout Description
5291 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5293 \begin_layout Description
5294 Syntax copy-label-as-reference <LABEL>
5296 \begin_layout Description
5297 Params <LABEL>: The label to copy (for multi-line math)
5299 \begin_layout Description
5300 Origin sts, 16 Nov 2008
5303 \begin_layout Subsection*
5304 LFUN_LABEL_INSERT_AS_REF
5306 \begin_layout Description
5307 Action Inserts the label as a cross-reference at the position of the cursor.
5309 \begin_layout Description
5310 Syntax label-insert-as-reference
5312 \begin_layout Description
5313 Origin vfr, 7 Apr 2009
5316 \begin_layout Subsection*
5319 \begin_layout Description
5320 Action Increases the zoom of the screen fonts.
5322 \begin_layout Description
5323 Syntax buffer-zoom-in [<ZOOM>]
5325 \begin_layout Description
5326 Params <ZOOM>: The zoom in %, the default is 20.
5328 \begin_layout Description
5329 Origin vfr, 30 Mar 2009
5332 \begin_layout Subsection*
5333 LFUN_BUFFER_ZOOM_OUT
5335 \begin_layout Description
5336 Action Decreases the zoom of the screen fonts.
5338 \begin_layout Description
5339 Syntax buffer-zoom-out [<ZOOM>]
5341 \begin_layout Description
5342 Params <ZOOM>: The zoom in %, the default is 20.
5344 \begin_layout Description
5345 Origin vfr, 30 Mar 2009
5348 \begin_layout Subsection*
5351 \begin_layout Description
5352 Action Copies the inset to the clipboard as a certain type
5354 \begin_layout Description
5355 Syntax inset-copy-as [<TYPE>]
5357 \begin_layout Description
5358 Params <TYPE>: The type as which the inset is copied. This can vary from inset to inset.
5360 \begin_layout Description
5361 Sample InsetInfo is copied as text
5363 \begin_layout Description
5364 Origin vfr, 18 Apr 2010