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 2011-03-28
63 \begin_layout Standard
67 \begin_layout Plain Layout
77 \begin_inset VSpace 1cm
82 \begin_layout Subsection*
85 \begin_layout Description
86 Action Adds an acute accent to the next character typed.
88 \begin_layout Description
92 \begin_layout Subsection*
95 \begin_layout Description
96 Action Adds a breve accent to the next character typed.
98 \begin_layout Description
102 \begin_layout Subsection*
105 \begin_layout Description
106 Action Adds a caron to the next character typed.
108 \begin_layout Description
112 \begin_layout Subsection*
115 \begin_layout Description
116 Action Adds a cedilla to the next character typed.
118 \begin_layout Description
119 Syntax accent-cedilla
122 \begin_layout Subsection*
125 \begin_layout Description
126 Action Adds a circle accent to the next character typed.
128 \begin_layout Description
132 \begin_layout Subsection*
133 LFUN_ACCENT_CIRCUMFLEX
135 \begin_layout Description
136 Action Adds a circumflex to the next character typed.
138 \begin_layout Description
139 Syntax accent-circumflex
142 \begin_layout Subsection*
145 \begin_layout Description
146 Action Adds a dot accent to the next character typed.
148 \begin_layout Description
152 \begin_layout Subsection*
155 \begin_layout Description
156 Action Adds a grave accent to the next character typed.
158 \begin_layout Description
162 \begin_layout Subsection*
163 LFUN_ACCENT_HUNGARIAN_UMLAUT
165 \begin_layout Description
166 Action Adds a Hungarian umlaut to the next character typed.
168 \begin_layout Description
172 \begin_layout Subsection*
175 \begin_layout Description
176 Action Adds a macron to the next character typed.
178 \begin_layout Description
182 \begin_layout Subsection*
185 \begin_layout Description
186 Action Adds an ogonek accent to the next character typed.
188 \begin_layout Description
192 \begin_layout Subsection*
195 \begin_layout Description
196 Action Adds a tie over the next two character typed.
198 \begin_layout Description
199 Notion The following char will finish the tie.
201 \begin_layout Description
205 \begin_layout Subsection*
208 \begin_layout Description
209 Action Adds a tilde over the next character typed.
211 \begin_layout Description
215 \begin_layout Subsection*
218 \begin_layout Description
219 Action Adds an umlaut over the next character typed.
221 \begin_layout Description
225 \begin_layout Subsection*
228 \begin_layout Description
229 Action Adds a bar under the next character typed.
231 \begin_layout Description
232 Syntax accent-underbar
235 \begin_layout Subsection*
238 \begin_layout Description
239 Action Adds a dot under the next character typed.
241 \begin_layout Description
242 Syntax accent-underdot
245 \begin_layout Subsection*
248 \begin_layout Description
249 Action Inserts a caption inset.
251 \begin_layout Description
252 Syntax caption-insert
254 \begin_layout Description
255 Origin Lgb, 18 Jul 2000
258 \begin_layout Subsection*
261 \begin_layout Description
262 Action Inserts the current date.
264 \begin_layout Description
265 Syntax date-insert [<ARG>]
267 \begin_layout Description
268 Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
270 \begin_layout Description
271 Origin jdblair, 31 Jan 2000
274 \begin_layout Subsection*
277 \begin_layout Description
278 Action Inserts a footnote inset.
280 \begin_layout Description
281 Syntax footnote-insert
283 \begin_layout Description
284 Origin Jug, 7 Mar 2000
287 \begin_layout Subsection*
290 \begin_layout Description
291 Action Inserts an ERT inset.
293 \begin_layout Description
296 \begin_layout Description
297 Origin Jug, 18 Feb 2000
300 \begin_layout Subsection*
303 \begin_layout Description
304 Action Inserts a float inset.
306 \begin_layout Description
307 Syntax float-insert <TYPE>
309 \begin_layout Description
310 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
312 \begin_layout Description
313 Origin Lgb, 27 Jun 2000
316 \begin_layout Subsection*
317 LFUN_FLOAT_WIDE_INSERT
319 \begin_layout Description
320 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
322 \begin_layout Description
323 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
325 \begin_layout Description
326 Syntax float-wide-insert <TYPE>
328 \begin_layout Description
329 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
331 \begin_layout Description
332 Origin Lgb, 31 Oct 2001
335 \begin_layout Subsection*
336 LFUN_FLOAT_LIST_INSERT
338 \begin_layout Description
339 Action Inserts the list of floats in the document.
341 \begin_layout Description
342 Syntax float-list-insert <TYPE>
344 \begin_layout Description
345 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
347 \begin_layout Description
348 Origin Lgb, 3 May 2001
351 \begin_layout Subsection*
354 \begin_layout Description
355 Action Inserts floats wrapped by the text around.
357 \begin_layout Description
358 Syntax wrap-insert <TYPE>
360 \begin_layout Description
361 Params <TYPE>: table|figure
363 \begin_layout Description
364 Origin Dekel, 7 Apr 2002
367 \begin_layout Subsection*
370 \begin_layout Description
371 Action Inserts an argument (short title) inset.
373 \begin_layout Description
374 Syntax argument-insert
376 \begin_layout Description
377 Origin vermeer, 12 Aug 2002
380 \begin_layout Subsection*
383 \begin_layout Description
384 Action Inserts a new page.
386 \begin_layout Description
387 Syntax newpage-insert <ARG>
389 \begin_layout Description
390 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
392 \begin_layout Description
393 Origin uwestoehr, 24 Nov 2007
396 \begin_layout Subsection*
397 LFUN_MARGINALNOTE_INSERT
399 \begin_layout Description
400 Action Inserts a marginal note.
402 \begin_layout Description
403 Syntax marginalnote-insert
405 \begin_layout Description
406 Origin Lgb, 26 Jun 2000
409 \begin_layout Subsection*
412 \begin_layout Description
413 Action Inserts a single unicode character.
415 \begin_layout Description
416 Syntax unicode-insert <CHAR>
418 \begin_layout Description
419 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
421 \begin_layout Description
422 Sample unicode-insert 0x0100
424 \begin_layout Description
425 Origin Lgb, 22 Oct 2006
428 \begin_layout Subsection*
431 \begin_layout Description
432 Action Inserts a new listings inset.
434 \begin_layout Description
435 Syntax listing-insert
437 \begin_layout Description
438 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
441 \begin_layout Subsection*
444 \begin_layout Description
445 Action Inserts a new preview inset.
447 \begin_layout Description
448 Syntax preview-insert
450 \begin_layout Description
451 Origin vfr, 28 Mar 2010
454 \begin_layout Subsection*
457 \begin_layout Description
458 Action Insert a tab into a listings inset.
460 \begin_layout Description
461 Notion It also works on a selection.
463 \begin_layout Description
466 \begin_layout Description
467 Origin vfr, Sep 30 2008
470 \begin_layout Subsection*
473 \begin_layout Description
474 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
476 \begin_layout Description
477 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action.
479 \begin_layout Description
482 \begin_layout Description
483 Origin vfr, Sep 30 2008
486 \begin_layout Subsection*
489 \begin_layout Description
490 Action Inserts quotes according to the type and quote-language preference.
492 \begin_layout Description
493 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
495 \begin_layout Description
496 Syntax quote-insert [<TYPE>]
498 \begin_layout Description
499 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
502 \begin_layout Subsection*
505 \begin_layout Description
506 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
508 \begin_layout Description
509 Notion Apart from lfun arguments you can use the following method:
510 \begin_inset Newline newline
513 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
514 \begin_inset Newline newline
517 2. select the text and run info-insert lfun.
519 \begin_layout Description
520 Syntax info-insert <TYPE> <ARG>
522 \begin_layout Description
523 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
524 \begin_inset Newline newline
527 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
528 \begin_inset Newline newline
531 shortcut[s]: name of lfun (e.g math-insert
534 \begin_inset Newline newline
537 lyxrc: name of rc_entry (e.g. bind_file)
538 \begin_inset Newline newline
541 lyxinfo: "version" - used version of LyX
542 \begin_inset Newline newline
545 package: name of latex package (e.g. listings)
546 \begin_inset Newline newline
549 textclass: name of textclass (e.g. article)
550 \begin_inset Newline newline
553 menu: name of lfun used in menu
554 \begin_inset Newline newline
557 icon: icon of lfun used in toolbar
558 \begin_inset Newline newline
561 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
563 \begin_layout Description
564 Sample command-sequence info-insert buffer path; info-insert buffer name
566 \begin_layout Description
567 Origin bpeng, 7 Oct 2007
570 \begin_layout Subsection*
573 \begin_layout Description
574 Action Inserts branch inset.
576 \begin_layout Description
577 Syntax branch-insert <BRANCH-NAME>
579 \begin_layout Description
580 Origin vermeer, 17 Aug 2003
583 \begin_layout Subsection*
586 \begin_layout Description
587 Action Inserts Box inset.
589 \begin_layout Description
590 Syntax box-insert [<TYPE>]
592 \begin_layout Description
593 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
594 \begin_inset Newline newline
597 Framed is the default one.
599 \begin_layout Description
600 Origin vermeer, 7 Oct 2003
603 \begin_layout Subsection*
606 \begin_layout Description
607 Action Inserts CharStyle, Custom inset or XML short element.
609 \begin_layout Description
610 Notion Look into the Customization manual for more information about these elements.
611 \begin_inset Newline newline
614 To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself.
615 \begin_inset Newline newline
618 For dissolving the element see LFUN_INSET_DISSOLVE.
620 \begin_layout Description
621 Syntax flex-insert Name
623 \begin_layout Description
624 Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout <Flex:Name>. The Flex: prefix is optional.
626 \begin_layout Description
627 Sample flex-insert Code
630 \begin_layout Subsection*
633 \begin_layout Description
634 Action Inserts the given string (accordingly to the correct keymap).
636 \begin_layout Description
637 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
639 \begin_layout Description
640 Syntax self-insert <STRING>
643 \begin_layout Subsection*
646 \begin_layout Description
647 Action Inserts one of horizontal space insets.
649 \begin_layout Description
650 Syntax space-insert <NAME> [<LEN>]
652 \begin_layout Description
653 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
654 \begin_inset Newline newline
657 <LEN>: length for custom spaces (hspace, hspace* for protected)
659 \begin_layout Description
660 Origin JSpitzm, 20 May 2003, Mar 17 2008
663 \begin_layout Subsection*
664 LFUN_HYPERLINK_INSERT
666 \begin_layout Description
667 Action Inserts hyperlinks into the document (clickable in pdf output).
669 \begin_layout Description
670 Notion Hyperlink target can be set via selection + hyperlink-insert function.
672 \begin_layout Description
673 Syntax href-insert [<TARGET>]
675 \begin_layout Description
676 Origin CFO-G, 21 Nov 1997
679 \begin_layout Subsection*
680 LFUN_SPECIALCHAR_INSERT
682 \begin_layout Description
683 Action Inserts various characters into the document.
685 \begin_layout Description
686 Syntax specialchar-insert <CHAR>
688 \begin_layout Description
689 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
691 \begin_layout Description
692 Origin JSpitzm, 6 Dec 2007
695 \begin_layout Subsection*
698 \begin_layout Description
699 Action Inserts a subscript or superscript inset.
701 \begin_layout Description
702 Syntax script-insert <TYPE>
704 \begin_layout Description
705 Params <TYPE>: subscript|superscript
707 \begin_layout Description
708 Origin Georg, 23 Nov 2010
711 \begin_layout Subsection*
714 \begin_layout Description
715 Action Start (or remove) Appendix on the given cursor position.
717 \begin_layout Description
720 \begin_layout Description
721 Origin ettrich, 5 May 1998
724 \begin_layout Subsection*
727 \begin_layout Description
728 Action Inserts Index entry.
730 \begin_layout Description
731 Notion It automatically takes the word on the cursor position.
733 \begin_layout Description
734 Syntax index-insert [<TYPE:Name>]
736 \begin_layout Description
737 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
739 \begin_layout Description
740 Origin leeming, 3 Aug 2000
743 \begin_layout Subsection*
746 \begin_layout Description
747 Action Inserts list of Index entries on a new page.
749 \begin_layout Description
750 Syntax index-print [<TYPE:Name>]
752 \begin_layout Description
753 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
755 \begin_layout Description
756 Origin Lgb, 27 Feb 1997
759 \begin_layout Subsection*
762 \begin_layout Description
763 Action Inserts Nomenclature entry.
765 \begin_layout Description
766 Notion It automatically takes the word on the cursor position if no symbol is given.
768 \begin_layout Description
769 Syntax nomencl-insert [<SYMBOL>]
771 \begin_layout Description
772 Origin Ugras, 4 Nov 2006
775 \begin_layout Subsection*
776 LFUN_NOMENCLATURE_PRINT
778 \begin_layout Description
779 Action Inserts list of Nomenclature entries.
781 \begin_layout Description
782 Syntax nomenclature-print
784 \begin_layout Description
785 Origin Ugras, 4 Nov 2006
788 \begin_layout Subsection*
791 \begin_layout Description
792 Action Inserts Note on the current cursor postion, move selection inside the inset.
794 \begin_layout Description
795 Syntax note-insert [<TYPE>]
797 \begin_layout Description
798 Params <TYPE>: <Note|Greyedout|Comment> default: Note
801 \begin_layout Subsection*
804 \begin_layout Description
805 Action Moves the cursor to the begining of next Note inset.
807 \begin_layout Description
811 \begin_layout Subsection*
814 \begin_layout Description
815 Action Inserts phantom on the current cursor postion, move selection inside the inset.
817 \begin_layout Description
818 Syntax phantom-insert [<TYPE>]
820 \begin_layout Description
821 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
823 \begin_layout Description
824 Origin uwestoehr, 30 Jan 2009
827 \begin_layout Subsection*
830 \begin_layout Description
831 Action Inserts a line break or new line.
833 \begin_layout Description
834 Syntax newline-insert [<ARG>]
836 \begin_layout Description
837 Params <ARG>: <newline|linebreak> default: newline
839 \begin_layout Description
840 Origin JSpitzm, 25 Mar 2008
843 \begin_layout Subsection*
846 \begin_layout Description
847 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
849 \begin_layout Description
852 \begin_layout Description
853 Origin Lgb, 17 May 2001
856 \begin_layout Subsection*
859 \begin_layout Description
860 Action Moves the cursor one line in downward direction.
862 \begin_layout Description
866 \begin_layout Subsection*
869 \begin_layout Description
870 Action Moves the cursor one line in upward direction.
872 \begin_layout Description
876 \begin_layout Subsection*
879 \begin_layout Description
880 Action Moves the cursor one line in downward direction adding the current position to the selection.
882 \begin_layout Description
886 \begin_layout Subsection*
889 \begin_layout Description
890 Action Moves the cursor one line in upward direction adding the current position to the selection.
892 \begin_layout Description
896 \begin_layout Subsection*
899 \begin_layout Description
900 Action Moves the cursor one page in downward direction.
902 \begin_layout Description
906 \begin_layout Subsection*
909 \begin_layout Description
910 Action Moves the cursor one page in upward direction.
912 \begin_layout Description
916 \begin_layout Subsection*
917 LFUN_SCREEN_DOWN_SELECT
919 \begin_layout Description
920 Action Moves the cursor one screen in downward direction adding the current position to the selection.
922 \begin_layout Description
923 Syntax screen-down-select
926 \begin_layout Subsection*
927 LFUN_SCREEN_UP_SELECT
929 \begin_layout Description
930 Action Moves the cursor one page in upward direction adding the current position to the selection.
932 \begin_layout Description
933 Syntax screen-up-select
936 \begin_layout Subsection*
939 \begin_layout Description
940 Action Scroll the buffer view.
942 \begin_layout Description
943 Notion Only scrolls the screen up or down; does not move the cursor.
945 \begin_layout Description
946 Syntax scroll <TYPE> <QUANTITY>
948 \begin_layout Description
949 Params <TYPE>: line|page
950 \begin_inset Newline newline
953 <QUANTITY>: up|down|<number>
955 \begin_layout Description
956 Origin Abdel, Dec 27 2007
959 \begin_layout Subsection*
962 \begin_layout Description
963 Action Recenters the screen on the current cursor position.
965 \begin_layout Description
966 Syntax screen-recenter
969 \begin_layout Subsection*
970 LFUN_SCREEN_SHOW_CURSOR
972 \begin_layout Description
973 Action Repositions the screen such that the cursor is visible.
975 \begin_layout Description
976 Syntax screen-show-cursor
978 \begin_layout Description
979 Origin vfr, 25 Mar 2009
982 \begin_layout Subsection*
985 \begin_layout Description
986 Action Moves the cursor one position logically backwards.
988 \begin_layout Description
989 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.
991 \begin_layout Description
995 \begin_layout Subsection*
996 LFUN_CHAR_BACKWARD_SELECT
998 \begin_layout Description
999 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1001 \begin_layout Description
1002 Notion See also LFUN_CHAR_BACKWARD.
1004 \begin_layout Description
1005 Syntax char-backward-select
1008 \begin_layout Subsection*
1009 LFUN_CHAR_DELETE_BACKWARD
1011 \begin_layout Description
1012 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1014 \begin_layout Description
1015 Syntax char-delete-backward
1018 \begin_layout Subsection*
1019 LFUN_CHAR_DELETE_FORWARD
1021 \begin_layout Description
1022 Action Deletes one character in the backward direction (usually the "Delete" key).
1024 \begin_layout Description
1025 Syntax char-delete-forward
1028 \begin_layout Subsection*
1031 \begin_layout Description
1032 Action Moves the cursor one position logically forward.
1034 \begin_layout Description
1035 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.
1037 \begin_layout Description
1041 \begin_layout Subsection*
1042 LFUN_CHAR_FORWARD_SELECT
1044 \begin_layout Description
1045 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1047 \begin_layout Description
1048 Notion See also LFUN_CHAR_FORWARD.
1050 \begin_layout Description
1051 Syntax char-forward-select
1054 \begin_layout Subsection*
1057 \begin_layout Description
1058 Action Moves the cursor one position "to the left".
1060 \begin_layout Description
1061 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.
1063 \begin_layout Description
1067 \begin_layout Subsection*
1068 LFUN_CHAR_LEFT_SELECT
1070 \begin_layout Description
1071 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1073 \begin_layout Description
1074 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1076 \begin_layout Description
1077 Syntax char-left-select
1080 \begin_layout Subsection*
1083 \begin_layout Description
1084 Action Moves the cursor one position "to the right".
1086 \begin_layout Description
1087 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.
1089 \begin_layout Description
1093 \begin_layout Subsection*
1094 LFUN_CHAR_RIGHT_SELECT
1096 \begin_layout Description
1097 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1099 \begin_layout Description
1100 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1102 \begin_layout Description
1103 Syntax char-right-select
1106 \begin_layout Subsection*
1109 \begin_layout Description
1110 Action Moves the cursor to the logically previous beginning of a word.
1112 \begin_layout Description
1113 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.
1115 \begin_layout Description
1116 Syntax word-backward
1119 \begin_layout Subsection*
1120 LFUN_WORD_BACKWARD_SELECT
1122 \begin_layout Description
1123 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1125 \begin_layout Description
1126 Notion See also LFUN_WORD_BACKWARD.
1128 \begin_layout Description
1129 Syntax word-backward-select
1132 \begin_layout Subsection*
1133 LFUN_WORD_DELETE_BACKWARD
1135 \begin_layout Description
1136 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1138 \begin_layout Description
1139 Syntax word-delete-backward
1142 \begin_layout Subsection*
1143 LFUN_WORD_DELETE_FORWARD
1145 \begin_layout Description
1146 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1148 \begin_layout Description
1149 Syntax word-delete-forward
1152 \begin_layout Subsection*
1153 LFUN_WORD_FIND_FORWARD
1155 \begin_layout Description
1156 Action Search for a given string in forward direction.
1158 \begin_layout Description
1159 Notion Case sensitive, match words. If no argument given, last search repeated.
1161 \begin_layout Description
1162 Syntax word-find-forward [<STRING>]
1164 \begin_layout Description
1165 Origin Etienne, 16 Feb 1998
1168 \begin_layout Subsection*
1169 LFUN_WORD_FIND_BACKWARD
1171 \begin_layout Description
1172 Action Search for a given string in backward direction.
1174 \begin_layout Description
1175 Notion Case sensitive, match words. If no argument given, last search repeated.
1177 \begin_layout Description
1178 Syntax word-find-backward [<STRING>]
1180 \begin_layout Description
1181 Origin Etienne, 20 Feb 1998
1184 \begin_layout Subsection*
1187 \begin_layout Description
1188 Action Search for next occurence of a string.
1190 \begin_layout Description
1191 Syntax word-find [<DATA>]
1193 \begin_layout Description
1194 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).
1196 \begin_layout Description
1197 Origin Andre, Jan 7 2004
1200 \begin_layout Subsection*
1203 \begin_layout Description
1204 Action Replace a string in the document.
1206 \begin_layout Description
1207 Syntax word-replace [<DATA>]
1209 \begin_layout Description
1210 Params <DATA>: data is of the form "<replace>
1211 \begin_inset Newline newline
1215 \begin_inset Newline newline
1218 <casesensitive> <matchword> <all> <forward>"
1220 \begin_layout Description
1221 Origin Andre, Jan 7 2004
1224 \begin_layout Subsection*
1227 \begin_layout Description
1228 Action Search for next occurence of a pattern.
1230 \begin_layout Description
1231 Syntax word-findadv [<DATA>]
1233 \begin_layout Description
1234 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).
1236 \begin_layout Description
1237 Origin Tommaso, Nov 15 2007
1240 \begin_layout Subsection*
1243 \begin_layout Description
1244 Action Moves the cursor to the logically next beginning of a word.
1246 \begin_layout Description
1247 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.
1249 \begin_layout Description
1253 \begin_layout Subsection*
1254 LFUN_WORD_FORWARD_SELECT
1256 \begin_layout Description
1257 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1259 \begin_layout Description
1260 Notion See also LFUN_WORD_FORWARD.
1262 \begin_layout Description
1263 Syntax word-forward-select
1266 \begin_layout Subsection*
1269 \begin_layout Description
1270 Action Moves the cursor to the next beginning of a word "on the left".
1272 \begin_layout Description
1273 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.
1275 \begin_layout Description
1278 \begin_layout Description
1279 Origin dov, 28 Oct 2007
1282 \begin_layout Subsection*
1283 LFUN_WORD_LEFT_SELECT
1285 \begin_layout Description
1286 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1288 \begin_layout Description
1289 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1291 \begin_layout Description
1292 Syntax word-left-select
1294 \begin_layout Description
1295 Origin dov, 28 Oct 2007
1298 \begin_layout Subsection*
1301 \begin_layout Description
1302 Action Moves the cursor to the next beginning of a word "on the right".
1304 \begin_layout Description
1305 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.
1307 \begin_layout Description
1310 \begin_layout Description
1311 Origin dov, 28 Oct 2007
1314 \begin_layout Subsection*
1315 LFUN_WORD_RIGHT_SELECT
1317 \begin_layout Description
1318 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1320 \begin_layout Description
1321 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1323 \begin_layout Description
1324 Syntax word-right-select
1326 \begin_layout Description
1327 Origin dov, 28 Oct 2007
1330 \begin_layout Subsection*
1333 \begin_layout Description
1334 Action Puts the word where the cursor stands into the selection.
1336 \begin_layout Description
1339 \begin_layout Description
1340 Origin Andre, 11 Sep 2002
1343 \begin_layout Subsection*
1344 LFUN_WORD_CAPITALIZE
1346 \begin_layout Description
1347 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1349 \begin_layout Description
1350 Syntax word-capitalize
1353 \begin_layout Subsection*
1356 \begin_layout Description
1357 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1359 \begin_layout Description
1363 \begin_layout Subsection*
1366 \begin_layout Description
1367 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1369 \begin_layout Description
1373 \begin_layout Subsection*
1376 \begin_layout Description
1377 Action Add the word under the cursor to the respective spell checker dictionary.
1379 \begin_layout Description
1380 Syntax spelling-add [<STRING>] [<LANG>]
1382 \begin_layout Description
1383 Params <WORD>: word to add <LANG>: language name (see file languages)
1385 \begin_layout Description
1386 Origin JSpitzm, 18 Jan 2010
1389 \begin_layout Subsection*
1390 LFUN_SPELLING_IGNORE
1392 \begin_layout Description
1393 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
1395 \begin_layout Description
1396 Syntax spelling-ignore [<WORD>] [<LANG>]
1398 \begin_layout Description
1399 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1401 \begin_layout Description
1402 Origin JSpitzm, 18 Jan 2010
1405 \begin_layout Subsection*
1406 LFUN_SPELLING_REMOVE
1408 \begin_layout Description
1409 Action Remove the word under the cursor from the respective spell checker dictionary.
1411 \begin_layout Description
1412 Syntax spelling-remove [<STRING>] [<LANG>]
1414 \begin_layout Description
1415 Params <WORD>: word to remove <LANG>: language name (see file languages)
1417 \begin_layout Description
1418 Origin SWitt, 28 July 2010
1421 \begin_layout Subsection*
1422 LFUN_THESAURUS_ENTRY
1424 \begin_layout Description
1425 Action Look up thesaurus entries with respect to the word under the cursor.
1427 \begin_layout Description
1428 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1430 \begin_layout Description
1431 Params <STRING>: word to look up <LANG>: language (see file languages)
1433 \begin_layout Description
1434 Origin Levon, 20 Jul 2001
1437 \begin_layout Subsection*
1440 \begin_layout Description
1441 Action Move the cursor to the beginning of the document.
1443 \begin_layout Description
1447 \begin_layout Subsection*
1448 LFUN_BUFFER_BEGIN_SELECT
1450 \begin_layout Description
1451 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1453 \begin_layout Description
1454 Syntax buffer-begin-select
1457 \begin_layout Subsection*
1460 \begin_layout Description
1461 Action Move the cursor to the end of the document.
1463 \begin_layout Description
1467 \begin_layout Subsection*
1468 LFUN_BUFFER_END_SELECT
1470 \begin_layout Description
1471 Action Move the cursor to the end of the document adding the traversed text to the selection.
1473 \begin_layout Description
1474 Syntax buffer-end-select
1477 \begin_layout Subsection*
1480 \begin_layout Description
1481 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
1483 \begin_layout Description
1486 \begin_layout Description
1487 Origin lasgouttes, 16 Mar 2009
1490 \begin_layout Subsection*
1491 LFUN_INSET_BEGIN_SELECT
1493 \begin_layout Description
1494 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).
1496 \begin_layout Description
1497 Syntax inset-begin-select
1499 \begin_layout Description
1500 Origin lasgouttes, 16 Mar 2009
1503 \begin_layout Subsection*
1506 \begin_layout Description
1507 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
1509 \begin_layout Description
1512 \begin_layout Description
1513 Origin lasgouttes, 16 Mar 2009
1516 \begin_layout Subsection*
1517 LFUN_INSET_END_SELECT
1519 \begin_layout Description
1520 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).
1522 \begin_layout Description
1523 Syntax inset-end-select
1525 \begin_layout Description
1526 Origin lasgouttes, 16 Mar 2009
1529 \begin_layout Subsection*
1530 LFUN_INSET_SELECT_ALL
1532 \begin_layout Description
1533 Action Selects all contents of an inset.
1535 \begin_layout Description
1536 Syntax inset-select-all
1538 \begin_layout Description
1539 Origin vfr, 22 Aug 2009
1542 \begin_layout Subsection*
1545 \begin_layout Description
1546 Action Selects the whole section.
1548 \begin_layout Description
1549 Notion The cursor should be in a section heading before calling this lfun.
1551 \begin_layout Description
1552 Syntax section-select
1554 \begin_layout Description
1555 Origin vfr, 05 May 2009
1558 \begin_layout Subsection*
1561 \begin_layout Description
1562 Action Move the cursor to the begining of the (screen) line.
1564 \begin_layout Description
1568 \begin_layout Subsection*
1569 LFUN_LINE_BEGIN_SELECT
1571 \begin_layout Description
1572 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1574 \begin_layout Description
1575 Syntax line-begin-select
1578 \begin_layout Subsection*
1581 \begin_layout Description
1582 Action Move the cursor to the end of the (screen) line.
1584 \begin_layout Description
1588 \begin_layout Subsection*
1589 LFUN_LINE_END_SELECT
1591 \begin_layout Description
1592 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1594 \begin_layout Description
1595 Syntax line-end-select
1598 \begin_layout Subsection*
1601 \begin_layout Description
1602 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1604 \begin_layout Description
1605 Syntax line-delete-forward
1608 \begin_layout Subsection*
1611 \begin_layout Description
1612 Action Copies to the clipboard the last edit.
1614 \begin_layout Description
1618 \begin_layout Subsection*
1621 \begin_layout Description
1622 Action Cuts to the clipboard.
1624 \begin_layout Description
1628 \begin_layout Subsection*
1631 \begin_layout Description
1632 Action Pastes material (text or picture) from the active clipboard.
1634 \begin_layout Description
1635 Syntax paste [<TYPE>|<NUM>]
1637 \begin_layout Description
1638 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1639 \begin_inset Newline newline
1642 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1645 \begin_layout Subsection*
1646 LFUN_CLIPBOARD_PASTE
1648 \begin_layout Description
1649 Action Pastes text from the active clipboard.
1651 \begin_layout Description
1652 Syntax clipboard-paste [<ARG>]
1654 \begin_layout Description
1655 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1657 \begin_layout Description
1658 Origin Georg, 10 Jul 2006
1661 \begin_layout Subsection*
1662 LFUN_PRIMARY_SELECTION_PASTE
1664 \begin_layout Description
1665 Action Pastes the currently selected text.
1667 \begin_layout Description
1668 Notion Primary selection mechanism is linux-only thing.
1670 \begin_layout Description
1671 Syntax primary-selection-paste [<ARG>]
1673 \begin_layout Description
1674 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1677 \begin_layout Subsection*
1678 LFUN_SELECTION_PASTE
1680 \begin_layout Description
1681 Action Pastes the the internal selection text in permanent selection.
1683 \begin_layout Description
1684 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
1686 \begin_layout Description
1687 Syntax selection-paste
1689 \begin_layout Description
1690 Origin lasgouttes, 14 Jan 2009
1693 \begin_layout Subsection*
1696 \begin_layout Description
1697 Action Undoes the last edit.
1699 \begin_layout Description
1703 \begin_layout Subsection*
1706 \begin_layout Description
1707 Action Redoes the last thing undone.
1709 \begin_layout Description
1713 \begin_layout Subsection*
1716 \begin_layout Description
1717 Action Repeat the given command.
1719 \begin_layout Description
1720 Syntax repeat <COUNT> <LFUN-COMMAND>
1722 \begin_layout Description
1723 Origin Andre, 27 Oct 2003
1726 \begin_layout Subsection*
1727 LFUN_CHARS_TRANSPOSE
1729 \begin_layout Description
1730 Action Transposes the character at the cursor with the one before it.
1732 \begin_layout Description
1733 Syntax chars-transpose
1735 \begin_layout Description
1736 Origin Lgb, 25 Apr 2001
1739 \begin_layout Subsection*
1740 LFUN_DEPTH_DECREMENT
1742 \begin_layout Description
1743 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1745 \begin_layout Description
1746 Syntax depth-decrement
1749 \begin_layout Subsection*
1750 LFUN_DEPTH_INCREMENT
1752 \begin_layout Description
1753 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1755 \begin_layout Description
1756 Syntax depth-increment
1759 \begin_layout Subsection*
1762 \begin_layout Description
1763 Action Toggles the bold font (selection-wise) using mathbf in math.
1765 \begin_layout Description
1769 \begin_layout Subsection*
1770 LFUN_FONT_BOLDSYMBOL
1772 \begin_layout Description
1773 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1775 \begin_layout Description
1776 Syntax font-boldsymbol
1779 \begin_layout Subsection*
1780 LFUN_FONT_TYPEWRITER
1782 \begin_layout Description
1783 Action Toggles the typewriter family font (selection-wise).
1785 \begin_layout Description
1786 Syntax font-typewriter
1789 \begin_layout Subsection*
1792 \begin_layout Description
1793 Action Toggles underline in the font (selection-wise).
1795 \begin_layout Description
1796 Syntax font-underline
1799 \begin_layout Subsection*
1802 \begin_layout Description
1803 Action Toggles double underline in the font (selection-wise).
1805 \begin_layout Description
1806 Syntax font-underunderline
1808 \begin_layout Description
1809 Origin sanda, 5 May 2009
1812 \begin_layout Subsection*
1815 \begin_layout Description
1816 Action Toggles wavy underline in the font (selection-wise).
1818 \begin_layout Description
1819 Syntax font-underwave
1821 \begin_layout Description
1822 Origin sanda, 5 May 2009
1825 \begin_layout Subsection*
1828 \begin_layout Description
1829 Action Toggles strikeout (strike-through) in the font (selection-wise).
1831 \begin_layout Description
1832 Syntax font-strikeout
1834 \begin_layout Description
1835 Origin sanda, 3 May 2009
1838 \begin_layout Subsection*
1841 \begin_layout Description
1842 Action Toggles the emphasis font style (selection-wise).
1844 \begin_layout Description
1848 \begin_layout Subsection*
1851 \begin_layout Description
1852 Action Toggles Noun text style font (selection-wise).
1854 \begin_layout Description
1858 \begin_layout Subsection*
1861 \begin_layout Description
1862 Action Toggles Roman family font (selection-wise).
1864 \begin_layout Description
1868 \begin_layout Subsection*
1871 \begin_layout Description
1872 Action Toggles Sans Serif family font (selection-wise).
1874 \begin_layout Description
1878 \begin_layout Subsection*
1881 \begin_layout Description
1882 Action Toggles Fraktur family font (math-mode, selection-wise).
1884 \begin_layout Description
1887 \begin_layout Description
1888 Origin vermeer, 10 Jan 2002
1891 \begin_layout Subsection*
1894 \begin_layout Description
1895 Action Toggles Italics font shape (math-mode, selection-wise).
1897 \begin_layout Description
1900 \begin_layout Description
1901 Origin vermeer, 10 Jan 2002
1904 \begin_layout Subsection*
1907 \begin_layout Description
1908 Action Reverts the settings of the font to the default values (selection-wise).
1910 \begin_layout Description
1914 \begin_layout Subsection*
1917 \begin_layout Description
1918 Action Sets font size according to lyx format string.
1920 \begin_layout Description
1921 Syntax font-size <SIZE>
1923 \begin_layout Description
1924 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1925 \begin_inset Newline newline
1928 largest|huge|giant|increase|decrease|default
1931 \begin_layout Subsection*
1932 LFUN_TEXTSTYLE_APPLY
1934 \begin_layout Description
1935 Action Toggle user-defined (=last-time used) text style.
1937 \begin_layout Description
1938 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1940 \begin_layout Description
1941 Syntax textstyle-apply
1943 \begin_layout Description
1944 Origin leeming, 12 Mar 2003
1947 \begin_layout Subsection*
1948 LFUN_TEXTSTYLE_UPDATE
1950 \begin_layout Description
1951 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1953 \begin_layout Description
1954 Syntax textstyle-update <FONT_INFO>
1956 \begin_layout Description
1957 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1958 \begin_inset Newline newline
1961 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1963 \begin_layout Description
1964 Origin leeming, 12 Mar 2003
1967 \begin_layout Subsection*
1968 LFUN_SCREEN_FONT_UPDATE
1970 \begin_layout Description
1971 Action Update fonts and its metrics.
1973 \begin_layout Description
1974 Notion Automatically called after zoom, dpi, font names, or norm change.
1976 \begin_layout Description
1977 Syntax screen-font-update
1979 \begin_layout Description
1980 Origin ARRae, 13 Aug 2000
1983 \begin_layout Subsection*
1986 \begin_layout Description
1987 Action Returns the info about the current font.
1989 \begin_layout Description
1993 \begin_layout Subsection*
1994 LFUN_CITATION_INSERT
1996 \begin_layout Description
1997 Action Inserts citation from loaded citation database.
1999 \begin_layout Description
2000 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2002 \begin_layout Description
2003 Params <KEY>: Citation (shortcut listed in available citations).
2004 \begin_inset Newline newline
2007 <TEXT_BEFORE>: text which should appear before citation.
2009 \begin_layout Description
2010 Origin AAS, 97-02-23
2013 \begin_layout Subsection*
2014 LFUN_BIBTEX_DATABASE_ADD
2016 \begin_layout Description
2017 Action Adds database, which will be used for bibtex citations.
2019 \begin_layout Description
2020 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2022 \begin_layout Description
2023 Syntax bibtex-database-add <DATABASE-NAME>
2025 \begin_layout Description
2026 Origin Ale, 30 May 1997
2029 \begin_layout Subsection*
2030 LFUN_BIBTEX_DATABASE_DEL
2032 \begin_layout Description
2033 Action Adds database, which will be used for bibtex citations.
2035 \begin_layout Description
2036 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2038 \begin_layout Description
2039 Syntax bibtex-database-del <DATABASE-NAME>
2041 \begin_layout Description
2042 Origin Ale, 30 May 1997
2045 \begin_layout Subsection*
2048 \begin_layout Description
2049 Action Sets the layout (that is, environment) for the current paragraph.
2051 \begin_layout Description
2052 Syntax layout <LAYOUT>
2054 \begin_layout Description
2055 Params <LAYOUT>: the layout to use
2058 \begin_layout Subsection*
2059 LFUN_LAYOUT_PARAGRAPH
2061 \begin_layout Description
2062 Action Launches the paragraph settings dialog.
2064 \begin_layout Description
2065 Syntax layout-paragraph
2068 \begin_layout Subsection*
2071 \begin_layout Description
2072 Action Launches the tabular settings dialog.
2074 \begin_layout Description
2075 Syntax layout-tabular
2077 \begin_layout Description
2078 Origin Jug, 31 Jul 2000
2081 \begin_layout Subsection*
2082 LFUN_DROP_LAYOUTS_CHOICE
2084 \begin_layout Description
2085 Action Displays list of layout choices.
2087 \begin_layout Description
2088 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
2090 \begin_layout Description
2091 Syntax drop-layouts-choice
2094 \begin_layout Subsection*
2095 LFUN_LAYOUT_MODULES_CLEAR
2097 \begin_layout Description
2098 Action Clears the module list.
2100 \begin_layout Description
2101 Notion Clears the list of included modules for the current buffer.
2103 \begin_layout Description
2104 Syntax layout-modules-clear
2106 \begin_layout Description
2107 Origin rgh, 25 August 2007
2110 \begin_layout Subsection*
2111 LFUN_LAYOUT_MODULE_ADD
2113 \begin_layout Description
2114 Action Adds a module.
2116 \begin_layout Description
2117 Notion Adds a module to the list of included modules for the current buffer.
2119 \begin_layout Description
2120 Syntax layout-module-add <MODULE>
2122 \begin_layout Description
2123 Params <MODULE>: the module to be added
2125 \begin_layout Description
2126 Origin rgh, 25 August 2007
2129 \begin_layout Subsection*
2132 \begin_layout Description
2133 Action Reloads layout information.
2135 \begin_layout Description
2136 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.
2138 \begin_layout Description
2139 Syntax layout-reload
2141 \begin_layout Description
2142 Origin rgh, 3 September 2007
2145 \begin_layout Subsection*
2146 LFUN_TEXTCLASS_APPLY
2148 \begin_layout Description
2149 Action Sets the text class for the current buffer.
2151 \begin_layout Description
2152 Syntax textclass-apply <TEXTCLASS>
2154 \begin_layout Description
2155 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2158 \begin_layout Subsection*
2161 \begin_layout Description
2162 Action Loads information for a textclass from disk.
2164 \begin_layout Description
2165 Syntax textclass-load <TEXTCLASS>
2167 \begin_layout Description
2168 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2171 \begin_layout Subsection*
2174 \begin_layout Description
2175 Action Disable selecting of text-region.
2177 \begin_layout Description
2181 \begin_layout Subsection*
2184 \begin_layout Description
2185 Action Enable selecting of text-region.
2187 \begin_layout Description
2188 Notion After enabling you can simply move arrow keys to get selected region.
2190 \begin_layout Description
2194 \begin_layout Subsection*
2197 \begin_layout Description
2198 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2200 \begin_layout Description
2203 \begin_layout Description
2204 Origin Andre, May 5 2006
2207 \begin_layout Subsection*
2210 \begin_layout Description
2211 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2213 \begin_layout Description
2214 Syntax math-delim [<LEFT>] [<RIGHT>]
2216 \begin_layout Description
2217 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.
2219 \begin_layout Description
2220 Sample math-delim { rangle
2222 \begin_layout Description
2223 Origin Alejandro, 18 Jun 1996
2226 \begin_layout Subsection*
2229 \begin_layout Description
2230 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2232 \begin_layout Description
2233 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2235 \begin_layout Description
2236 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2237 \begin_inset Newline newline
2240 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2242 \begin_layout Description
2243 Sample math-bigdelim "Bigl" "
2249 \begin_layout Description
2250 Origin Enrico & Georg, 7 May 2006
2253 \begin_layout Subsection*
2256 \begin_layout Description
2257 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2259 \begin_layout Description
2260 Syntax math-display [<ARG>]
2262 \begin_layout Description
2263 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2265 \begin_layout Description
2266 Origin Alejandro, 18 Jun 1996
2269 \begin_layout Subsection*
2272 \begin_layout Description
2273 Action Inserts math objects and symbols.
2275 \begin_layout Description
2276 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
2278 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
2280 frac{x}{y}" replaces "abc" with "
2282 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.
2284 \begin_layout Description
2285 Syntax math-insert <ARG>
2287 \begin_layout Description
2288 Params <ARG>: Symbol or LaTeX code to be inserted.
2291 \begin_layout Subsection*
2294 \begin_layout Description
2295 Action Enters subscript expression in math expression.
2297 \begin_layout Description
2298 Syntax math-subscript
2300 \begin_layout Description
2301 Origin vermeer, 12 Dec 2001
2304 \begin_layout Subsection*
2305 LFUN_MATH_SUPERSCRIPT
2307 \begin_layout Description
2308 Action Enters superscript expression in math expression.
2310 \begin_layout Description
2311 Syntax math-superscript
2313 \begin_layout Description
2314 Origin vermeer, 12 Dec 2001
2317 \begin_layout Subsection*
2320 \begin_layout Description
2321 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.
2323 \begin_layout Description
2324 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2326 \begin_layout Description
2327 Syntax math-limits [<STATE>]
2329 \begin_layout Description
2330 Params <STATE>: limits|nolimits
2333 \begin_layout Subsection*
2336 \begin_layout Description
2337 Action Inserts a math macro definition at the cursor position in the text.
2339 \begin_layout Description
2340 Syntax math-macro <NAME> [<NARGS>] [def]
2342 \begin_layout Description
2343 Params <NAME>: The name of the macro, e.g. "mymacro".
2344 \begin_inset Newline newline
2347 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2349 \begin_layout Description
2350 Origin ale, 10 May 1997; sts, 21 Dec 2007
2353 \begin_layout Subsection*
2356 \begin_layout Description
2357 Action Mutates the type of math inset to the newly selected one.
2359 \begin_layout Description
2360 Syntax math-mutate <TYPE>
2362 \begin_layout Description
2363 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2365 \begin_layout Description
2366 Origin Andre, 23 May 2001
2369 \begin_layout Subsection*
2372 \begin_layout Description
2373 Action Inserts space into math expression.
2375 \begin_layout Description
2376 Notion Use spacebar after entering this space to change type of space.
2378 \begin_layout Description
2379 Syntax math-space [<TYPE>] [<LEN>]
2381 \begin_layout Description
2382 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2383 \begin_inset Newline newline
2386 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2387 \begin_inset Newline newline
2390 custom space: hspace
2391 \begin_inset Newline newline
2394 "," used by default.
2395 \begin_inset Newline newline
2398 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2399 \begin_inset Newline newline
2402 <LEN>: length for custom spaces (hspace)
2404 \begin_layout Description
2405 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2408 \begin_layout Subsection*
2411 \begin_layout Description
2412 Action Inserts a matrix.
2414 \begin_layout Description
2415 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2417 \begin_layout Description
2418 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).
2420 \begin_layout Description
2421 Sample math-matrix 3 3 bccc
2424 \begin_layout Subsection*
2425 LFUN_MATH_AMS_MATRIX
2427 \begin_layout Description
2428 Action Inserts a matrix.
2430 \begin_layout Description
2431 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
2433 \begin_layout Description
2434 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
2436 \begin_layout Description
2437 Sample math-ams-matrix 3 3 bmatrix
2440 \begin_layout Subsection*
2443 \begin_layout Description
2444 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.
2446 \begin_layout Description
2447 Notion If there is some selected text, it puts the text inside created math box.
2449 \begin_layout Description
2450 Syntax math-mode [on|<ARG>]
2452 \begin_layout Description
2453 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2454 \begin_inset Newline newline
2457 "on": allow only entering of math mode from text mode.
2459 \begin_layout Description
2460 Origin Alejandro, 4 Jun 1996
2463 \begin_layout Subsection*
2466 \begin_layout Description
2467 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2469 \begin_layout Description
2470 Notion If there is any selected text, then it is moved inside the created regexp inset.
2472 \begin_layout Description
2473 Syntax regexp-mode [<ARG>]
2475 \begin_layout Description
2476 Params <ARG>: eventual argument (regular expression).
2478 \begin_layout Description
2479 Origin Tommaso, 4 Oct 2008
2482 \begin_layout Subsection*
2483 LFUN_MATH_NUMBER_LINE_TOGGLE
2485 \begin_layout Description
2486 Action Toggles numbering of the current formula line.
2488 \begin_layout Description
2489 Notion Must be in display formula mode.
2491 \begin_layout Description
2492 Syntax math-number-line-toggle
2494 \begin_layout Description
2495 Origin Alejandro, 18 Jun 1996
2498 \begin_layout Subsection*
2499 LFUN_MATH_NUMBER_TOGGLE
2501 \begin_layout Description
2502 Action Toggles numbering/labeling of the current formula.
2504 \begin_layout Description
2505 Notion Must be in display formula mode.
2507 \begin_layout Description
2508 Syntax math-number-toggle
2510 \begin_layout Description
2511 Origin Alejandro, 4 Jun 1996
2514 \begin_layout Subsection*
2517 \begin_layout Description
2518 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2520 \begin_layout Description
2521 Notion Selection can be used to determine the input for the external program.
2523 \begin_layout Description
2524 Syntax math-extern <LANG> [<COMMAND>]
2526 \begin_layout Description
2527 Params <LANG>: octave|maxima|maple|mathematica|script
2528 \begin_inset Newline newline
2531 where "script" stands fot the external script (normalized expression will be passed)
2533 \begin_layout Description
2534 Sample math-extern maple simplify
2536 \begin_layout Description
2537 Origin Andre, 24 Apr 2001
2540 \begin_layout Subsection*
2543 \begin_layout Description
2544 Action Changes arbitrarily the size used by math fonts inside a context.
2546 \begin_layout Description
2547 Notion Provides an interface to the LaTeX math mode font size commands.
2549 \begin_layout Description
2550 Syntax math-size <STYLE>
2552 \begin_layout Description
2563 \begin_layout Description
2564 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2567 \begin_layout Subsection*
2568 LFUN_MATH_FONT_STYLE
2570 \begin_layout Description
2571 Action Changes the text style used in math.
2573 \begin_layout Description
2574 Syntax math-font-style <STYLE>
2576 \begin_layout Description
2577 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
2578 \begin_inset Newline newline
2581 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2583 \begin_layout Description
2584 Origin vfr, 9 jan 2009
2587 \begin_layout Subsection*
2588 LFUN_MATH_MACRO_UNFOLD
2590 \begin_layout Description
2591 Action Unfold a Math Macro.
2593 \begin_layout Description
2594 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2598 \begin_layout Description
2599 Syntax math-macro-unfold
2601 \begin_layout Description
2602 Origin sts, 06 January 2008
2605 \begin_layout Subsection*
2606 LFUN_MATH_MACRO_FOLD
2608 \begin_layout Description
2609 Action Fold a Math Macro.
2611 \begin_layout Description
2612 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2616 \begin_layout Description
2617 Syntax math-macro-fold
2619 \begin_layout Description
2620 Origin sts, 06 January 2008
2623 \begin_layout Subsection*
2624 LFUN_MATH_MACRO_ADD_PARAM
2626 \begin_layout Description
2627 Action Add a parameter.
2629 \begin_layout Description
2630 Notion Add a parameter to a Math Macro.
2632 \begin_layout Description
2633 Syntax math-macro-add-param <NUM>
2635 \begin_layout Description
2636 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.
2638 \begin_layout Description
2639 Origin sts, 06 January 2008
2642 \begin_layout Subsection*
2643 LFUN_MATH_MACRO_REMOVE_PARAM
2645 \begin_layout Description
2646 Action Remove the last parameter.
2648 \begin_layout Description
2649 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2651 \begin_layout Description
2652 Syntax math-macro-remove-param <NUM>
2654 \begin_layout Description
2655 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2657 \begin_layout Description
2658 Origin sts, 06 January 2008
2661 \begin_layout Subsection*
2662 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2664 \begin_layout Description
2665 Action Append a greedy parameter.
2667 \begin_layout Description
2668 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2670 \begin_layout Description
2671 Syntax math-macro-append-greedy-param
2673 \begin_layout Description
2674 Origin sts, 06 January 2008
2677 \begin_layout Subsection*
2678 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2680 \begin_layout Description
2681 Action Remove a greedy parameter.
2683 \begin_layout Description
2684 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.
2686 \begin_layout Description
2687 Syntax math-macro-remove-greedy-param
2689 \begin_layout Description
2690 Origin sts, 06 January 2008
2693 \begin_layout Subsection*
2694 LFUN_MATH_MACRO_MAKE_OPTIONAL
2696 \begin_layout Description
2697 Action Make a parameter optional.
2699 \begin_layout Description
2700 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2702 \begin_layout Description
2703 Syntax math-macro-make-optional
2705 \begin_layout Description
2706 Origin sts, 06 January 2008
2709 \begin_layout Subsection*
2710 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2712 \begin_layout Description
2713 Action Make a parameter non-optional.
2715 \begin_layout Description
2716 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.
2718 \begin_layout Description
2719 Syntax math-macro-make-nonoptional
2721 \begin_layout Description
2722 Origin sts, 06 January 2008
2725 \begin_layout Subsection*
2726 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2728 \begin_layout Description
2729 Action Add an optional parameter.
2731 \begin_layout Description
2732 Notion Insert an optional parameter just behind the already existing optional parameters.
2734 \begin_layout Description
2735 Syntax math-macro-add-optional-param
2737 \begin_layout Description
2738 Origin sts, 06 January 2008
2741 \begin_layout Subsection*
2742 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2744 \begin_layout Description
2745 Action Remove the last optional parameter.
2747 \begin_layout Description
2748 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2750 \begin_layout Description
2751 Syntax math-macro-remove-optional-param
2753 \begin_layout Description
2754 Origin sts, 06 January 2008
2757 \begin_layout Subsection*
2758 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2760 \begin_layout Description
2761 Action Add a greedy optional parameter.
2763 \begin_layout Description
2764 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2766 \begin_layout Description
2767 Syntax math-macro-add-greedy-optional-param
2769 \begin_layout Description
2770 Origin sts, 06 January 2008
2773 \begin_layout Subsection*
2774 LFUN_IN_MATHMACROTEMPLATE
2776 \begin_layout Description
2777 Action Only active in Math Macro definition.
2779 \begin_layout Description
2780 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.
2782 \begin_layout Description
2783 Syntax in-mathmacrotemplate
2785 \begin_layout Description
2786 Origin sts, 06 January 2008
2789 \begin_layout Subsection*
2790 LFUN_PARAGRAPH_MOVE_DOWN
2792 \begin_layout Description
2793 Action Moves the current paragraph downwards in the document.
2795 \begin_layout Description
2796 Syntax paragraph-move-down
2798 \begin_layout Description
2799 Origin Edwin, 8 Apr 2006
2802 \begin_layout Subsection*
2803 LFUN_PARAGRAPH_MOVE_UP
2805 \begin_layout Description
2806 Action Moves the current paragraph upwards in the document.
2808 \begin_layout Description
2809 Syntax paragraph-move-up
2811 \begin_layout Description
2812 Origin Edwin, 8 Apr 2006
2815 \begin_layout Subsection*
2818 \begin_layout Description
2819 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2821 \begin_layout Description
2824 \begin_layout Description
2825 Origin Asger, 1 Oct 1996
2828 \begin_layout Subsection*
2829 LFUN_PARAGRAPH_UP_SELECT
2831 \begin_layout Description
2832 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2834 \begin_layout Description
2835 Syntax paragraph-up-select
2837 \begin_layout Description
2838 Origin Asger, 1 Oct 1996
2841 \begin_layout Subsection*
2844 \begin_layout Description
2845 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2847 \begin_layout Description
2848 Syntax paragraph-down
2850 \begin_layout Description
2851 Origin Asger, 1 Oct 1996
2854 \begin_layout Subsection*
2855 LFUN_PARAGRAPH_DOWN_SELECT
2857 \begin_layout Description
2858 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2860 \begin_layout Description
2861 Syntax paragraph-down-select
2863 \begin_layout Description
2864 Origin Asger, 1 Oct 1996
2867 \begin_layout Subsection*
2870 \begin_layout Description
2871 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2873 \begin_layout Description
2874 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).
2876 \begin_layout Description
2877 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2879 \begin_layout Description
2880 Params <PAR_ID_NUMBER>: paragraph id
2881 \begin_inset Newline newline
2884 <POSITION_IN_PAR>: desired position within the paragraph
2886 \begin_layout Description
2887 Origin Dekel, 26 Aug 2000
2890 \begin_layout Subsection*
2891 LFUN_BREAK_PARAGRAPH
2893 \begin_layout Description
2894 Action Breaks the current paragraph at the current location.
2896 \begin_layout Description
2897 Notion Removes the selection.
2899 \begin_layout Description
2900 Syntax break-paragraph [<LAYOUT>]
2902 \begin_layout Description
2903 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2906 \begin_layout Subsection*
2907 LFUN_PARAGRAPH_PARAMS
2909 \begin_layout Description
2910 Action Change paragraph settings.
2912 \begin_layout Description
2913 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.
2915 \begin_layout Description
2916 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2918 \begin_layout Description
2928 \begin_inset Newline newline
2933 paragraph_spacing default|single|onehalf|double|other SIZE
2934 \begin_inset Newline newline
2939 align block|left|right|center|default
2940 \begin_inset Newline newline
2945 labelwidthstring WIDTH|
2949 \begin_layout Description
2950 Origin rgh, Aug 15 2007
2953 \begin_layout Subsection*
2954 LFUN_PARAGRAPH_PARAMS_APPLY
2956 \begin_layout Description
2957 Action Change paragraph settings.
2959 \begin_layout Description
2960 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2962 \begin_layout Description
2963 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2965 \begin_layout Description
2966 Params For parameters see LFUN_PARAGRAPH_PARAMS
2968 \begin_layout Description
2969 Origin leeming, 30 Mar 2004
2972 \begin_layout Subsection*
2973 LFUN_PARAGRAPH_UPDATE
2975 \begin_layout Description
2976 Action Updates the values inside the paragraph dialog from the paragraph.
2978 \begin_layout Description
2979 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2981 \begin_layout Description
2982 Origin leeming, 13 Mar 2003
2985 \begin_layout Subsection*
2988 \begin_layout Description
2989 Action Move the current group in the upward direction in the structure of the document.
2991 \begin_layout Description
2992 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2994 \begin_layout Description
2997 \begin_layout Description
2998 Origin Vermeer, 23 Mar 2006
3001 \begin_layout Subsection*
3004 \begin_layout Description
3005 Action Move the current group in the downward direction in the structure of the document.
3007 \begin_layout Description
3008 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3010 \begin_layout Description
3013 \begin_layout Description
3014 Origin Vermeer, 23 Mar 2006
3017 \begin_layout Subsection*
3020 \begin_layout Description
3021 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3023 \begin_layout Description
3024 Notion Part -> Chapter -> Section -> etc.
3026 \begin_layout Description
3029 \begin_layout Description
3030 Origin Vermeer, 23 Mar 2006
3033 \begin_layout Subsection*
3036 \begin_layout Description
3037 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3039 \begin_layout Description
3040 Notion Part <- Chapter <- Section <- etc.
3042 \begin_layout Description
3045 \begin_layout Description
3046 Origin Vermeer, 23 Mar 2006
3049 \begin_layout Subsection*
3052 \begin_layout Description
3053 Action Edit the inset at cursor with an external application, if one is attributed.
3055 \begin_layout Description
3056 Syntax inset-edit [<INSET_PARAMS>]
3058 \begin_layout Description
3059 Params <INSET_PARAMS>: Parameters for the inset.
3060 \begin_inset Newline newline
3063 Currently only the filename will be considered.
3065 \begin_layout Description
3066 Origin JSpitzm, 27 Apr 2006
3069 \begin_layout Subsection*
3072 \begin_layout Description
3073 Action Inserts table into the document.
3075 \begin_layout Description
3076 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3078 \begin_layout Description
3079 Syntax tabular-insert [<ROWS> <COLUMNS>]
3081 \begin_layout Description
3082 Params In case no arguments are given show insert dialog.
3084 \begin_layout Description
3085 Origin Jug, 12 Apr 2000
3088 \begin_layout Subsection*
3091 \begin_layout Description
3092 Action Moves the cursor to the previous cell inside the table.
3094 \begin_layout Description
3095 Syntax cell-backward
3097 \begin_layout Description
3098 Origin Jug, 22 May 2000
3101 \begin_layout Subsection*
3104 \begin_layout Description
3105 Action Moves the cursor to the next cell inside the table.
3107 \begin_layout Description
3111 \begin_layout Subsection*
3114 \begin_layout Description
3115 Action Splits cell and shifts right part to the next cell (inside the math grid).
3117 \begin_layout Description
3120 \begin_layout Description
3121 Origin Ale, 15 May 1997
3124 \begin_layout Subsection*
3127 \begin_layout Description
3128 Action Register the document as an file inside version control system.
3130 \begin_layout Description
3131 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3132 \begin_inset Newline newline
3135 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3137 \begin_layout Description
3140 \begin_layout Description
3141 Origin Lgb, 1 Jul 1997
3144 \begin_layout Subsection*
3147 \begin_layout Description
3148 Action Checks-in/commits the changes of the registered file to the repository.
3150 \begin_layout Description
3151 Notion In RCS case this also unlocks the file.
3153 \begin_layout Description
3156 \begin_layout Description
3157 Origin Lgb, 1 Jul 1997
3160 \begin_layout Subsection*
3163 \begin_layout Description
3164 Action Checks-out the document for edit (and locks it in some cases).
3166 \begin_layout Description
3169 \begin_layout Description
3170 Origin Lgb, 1 Jul 1997
3173 \begin_layout Subsection*
3176 \begin_layout Description
3177 Action Reverts the document to the last check-in/commit in VCS.
3179 \begin_layout Description
3182 \begin_layout Description
3183 Origin Lgb, 1 Jul 1997
3186 \begin_layout Subsection*
3189 \begin_layout Description
3190 Action Undo last check-in.
3192 \begin_layout Description
3193 Notion This is currently implemented only for RCS.
3195 \begin_layout Description
3198 \begin_layout Description
3199 Origin Lgb, 1 Jul 1997
3202 \begin_layout Subsection*
3205 \begin_layout Description
3206 Action Executes external command. This command is intended to support additional VCS commands.
3208 \begin_layout Description
3209 Syntax vc-command <FLAG> <PATH> <COMMAND>
3211 \begin_layout Description
3212 Params <FLAG>: Flags for the command can be combined together.
3213 \begin_inset Newline newline
3216 U - dUmmy - no flags
3217 \begin_inset Newline newline
3220 D - Doc - need document loaded to proceed
3221 \begin_inset Newline newline
3224 I - dIrty - mark document dirty
3225 \begin_inset Newline newline
3228 R - Reload - ensure that the document is saved and reload it after command execution
3229 \begin_inset Newline newline
3232 M - Message - ask for input string (commit message)
3233 \begin_inset Newline newline
3236 <PATH>: path where to start. $$p will be replaced by the current document path.
3237 \begin_inset Newline newline
3240 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
3242 \begin_layout Description
3243 Sample vc-command DR $$p "svn up"
3245 \begin_layout Description
3246 Origin sanda, 13 Jan 2009
3249 \begin_layout Subsection*
3250 LFUN_VC_LOCKING_TOGGLE
3252 \begin_layout Description
3253 Action Toggles the locking property of the edited file.
3255 \begin_layout Description
3256 Notion This is currently implemented only for SVN.
3258 \begin_layout Description
3259 Syntax vc-locking-toggle
3261 \begin_layout Description
3262 Origin sanda, 25 Jun 2009
3265 \begin_layout Subsection*
3268 \begin_layout Description
3269 Action Update the local archive directory in which resides the current document with the remote repository.
3271 \begin_layout Description
3272 Syntax vc-repo-update
3274 \begin_layout Description
3275 Origin sanda, 16 Oct 2009
3278 \begin_layout Subsection*
3281 \begin_layout Description
3282 Action Compares two revisions of the same file under version control.
3284 \begin_layout Description
3285 Syntax vc-compare [<REV1>] [<REV2>]
3287 \begin_layout Description
3288 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
3289 \begin_inset Newline newline
3292 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
3293 \begin_inset Newline newline
3297 \begin_inset Newline newline
3300 <REV2>: Newer file. Used only if REV1 > 0.
3301 \begin_inset Newline newline
3304 If no parameter is given, interactive dialog will be shown.
3306 \begin_layout Description
3307 Sample Compare current document against last commit
3308 \begin_inset Newline newline
3312 \begin_inset Newline newline
3315 Compare current document against current revision - 5 commits
3316 \begin_inset Newline newline
3320 \begin_inset Newline newline
3323 Compare revisions 120 and 155
3324 \begin_inset Newline newline
3329 \begin_layout Description
3330 Origin sanda, 12 Feb 2010
3333 \begin_layout Subsection*
3336 \begin_layout Description
3337 Action Toggles change tracking to on/off.
3339 \begin_layout Description
3340 Syntax changes-track
3342 \begin_layout Description
3343 Origin levon, 1 Oct 2002
3346 \begin_layout Subsection*
3349 \begin_layout Description
3350 Action Toggles showing of change tracking in typesetted output.
3352 \begin_layout Description
3353 Syntax changes-output
3355 \begin_layout Description
3356 Origin jspitzm, 21 Jan 2005
3359 \begin_layout Subsection*
3362 \begin_layout Description
3363 Action Moves the cursor to the position of the next change of the change tracking records.
3365 \begin_layout Description
3368 \begin_layout Description
3369 Origin schmitt, 4 Oct 2006
3372 \begin_layout Subsection*
3373 LFUN_CHANGE_PREVIOUS
3375 \begin_layout Description
3376 Action Moves the cursor to the position of the previous change of the change tracking records.
3378 \begin_layout Description
3379 Syntax change-previous
3381 \begin_layout Description
3382 Origin vfr, 4 Apr 2009
3385 \begin_layout Subsection*
3388 \begin_layout Description
3389 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3391 \begin_layout Description
3392 Syntax changes-merge
3394 \begin_layout Description
3395 Origin Levon, 16 Oct 2002
3398 \begin_layout Subsection*
3401 \begin_layout Description
3402 Action Accepts tracked change inside the selection.
3404 \begin_layout Description
3405 Syntax change-accept
3407 \begin_layout Description
3408 Origin Levon, 16 Oct 2002
3411 \begin_layout Subsection*
3414 \begin_layout Description
3415 Action Rejects tracked change inside the selection.
3417 \begin_layout Description
3418 Syntax change-reject
3420 \begin_layout Description
3421 Origin Levon, 16 Oct 2002
3424 \begin_layout Subsection*
3425 LFUN_ALL_CHANGES_ACCEPT
3427 \begin_layout Description
3428 Action Accepts all tracked changes in the document.
3430 \begin_layout Description
3431 Syntax all-changes-accept
3433 \begin_layout Description
3434 Origin Levon, 16 Oct 2002
3437 \begin_layout Subsection*
3438 LFUN_ALL_CHANGES_REJECT
3440 \begin_layout Description
3441 Action Rejects all tracked changes in the document.
3443 \begin_layout Description
3444 Notion Reject does not work recursively; the user may have to repeat the operation.
3446 \begin_layout Description
3447 Syntax all-changes-reject
3449 \begin_layout Description
3450 Origin Levon, 16 Oct 2002
3453 \begin_layout Subsection*
3456 \begin_layout Description
3457 Action Apply data for an inset.
3459 \begin_layout Description
3460 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.
3462 \begin_layout Description
3463 Syntax inset-apply <ARGS>
3465 \begin_layout Description
3466 Params See LFUN_INSET_INSERT .
3469 \begin_layout Subsection*
3472 \begin_layout Description
3473 Action Dissolve the current inset into text.
3475 \begin_layout Description
3476 Syntax inset-dissolve [<INSET>]
3478 \begin_layout Description
3479 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.
3480 \begin_inset Newline newline
3483 For values see lyx::InsetLayout::lyxtype_ .
3485 \begin_layout Description
3486 Origin JSpitz, 7 Aug 2006
3489 \begin_layout Subsection*
3492 \begin_layout Description
3493 Action Insert new inset (type given by the parameters).
3495 \begin_layout Description
3496 Syntax inset-insert <INSET> <ARGS>
3498 \begin_layout Description
3499 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular|
3500 \begin_inset Newline newline
3503 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
3504 \begin_inset Newline newline
3507 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3509 \begin_layout Description
3510 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3513 \begin_inset Newline newline
3516 where <label name> is the name of the referenced label and <Format> is one of the following:
3517 \begin_inset Newline newline
3521 \begin_inset Newline newline
3524 eqref -- (<reference>)
3525 \begin_inset Newline newline
3529 \begin_inset Newline newline
3532 vpageref -- on <page>
3533 \begin_inset Newline newline
3536 vref -- <reference> on <page>
3537 \begin_inset Newline newline
3540 formatted -- Formatted reference
3543 \begin_layout Subsection*
3546 \begin_layout Description
3547 Action Modify some properties of an inset.
3549 \begin_layout Description
3550 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.
3552 \begin_layout Description
3553 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
3555 \begin_layout Description
3556 Params Generally see LFUN_INSET_INSERT for further details.
3557 \begin_inset Newline newline
3560 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.
3561 \begin_inset Newline newline
3564 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| align-left|align-right|align-center|align-block|align-decimal|set-decimal-point| valign-top|valign-bottom|valign-middle|longtabular-align-left| longtabular-align-center|longtabular-align-right|m-align-left|m-align-right| m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn| set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth| set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| set-special-column|set-special-multicolumn|set-special-multirow| set-booktabs|unset-booktabs|set-top-space|set-bottom-space| set-interline-space|set-border-lines|tabular-valign-top| tabular-valign-middle|tabular-valign-bottom|set-tabular-width
3565 \begin_inset Newline newline
3568 <ARG>: additional argument for some commands, use debug mode to explore its values.
3570 \begin_layout Description
3571 Sample inset-modify note Note Comment
3572 \begin_inset Newline newline
3575 inset-modify changetype Ovalbox
3578 \begin_layout Subsection*
3579 LFUN_INSET_DIALOG_UPDATE
3581 \begin_layout Description
3582 Action Updates the values inside the dialog from the inset.
3584 \begin_layout Description
3585 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3587 \begin_layout Description
3588 Params <DIALOG-NAME>
3590 \begin_layout Description
3591 Origin leeming, 25 Feb 2003
3594 \begin_layout Subsection*
3597 \begin_layout Description
3598 Action Open the inset's properties dialog.
3600 \begin_layout Description
3601 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, line, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3603 \begin_layout Description
3604 Syntax inset-settings <INSET>
3606 \begin_layout Description
3607 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
3608 \begin_inset Newline newline
3611 graphics|href|include|index|index_print|label|line| listings|note|phantom|ref|space|tabular|vspace|wrap>.
3614 \begin_layout Subsection*
3617 \begin_layout Description
3618 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3620 \begin_layout Description
3621 Syntax inset-toggle [<ARG>]
3623 \begin_layout Description
3624 Params <ARG>: <open|close|toggle|assign>.
3625 \begin_inset Newline newline
3628 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3629 \begin_inset Newline newline
3632 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3634 \begin_layout Description
3635 Origin lasgouttes, 19 Jul 2001
3638 \begin_layout Subsection*
3641 \begin_layout Description
3642 Action Apply the given commands on insets of a given name.
3644 \begin_layout Description
3645 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.
3647 \begin_layout Description
3648 Syntax inset-forall <NAME> <LFUN-COMMAND>
3649 \begin_inset Newline newline
3652 <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.
3654 \begin_layout Description
3655 Sample Remove all index insets:
3656 \begin_inset Newline newline
3659 inset-forall Index delete-char-forward
3660 \begin_inset Newline newline
3663 Close all Notes (also works for a particular branch, for example):
3664 \begin_inset Newline newline
3667 inset-forall Note inset-toggle close
3668 \begin_inset Newline newline
3671 Transform all yellow notes to comments
3672 \begin_inset Newline newline
3675 inset-forall Note:Note inset-modify note Note Comment
3676 \begin_inset Newline newline
3679 Try to put LyX in an infinite loop if there is at least a Note:
3680 \begin_inset Newline newline
3683 inset-forall Note char-backward
3685 \begin_layout Description
3686 Origin lasgouttes, 27 Nov 2009
3689 \begin_layout Subsection*
3690 LFUN_GRAPHICS_RELOAD
3692 \begin_layout Description
3693 Action Reloads the image if necessary.
3695 \begin_layout Description
3696 Syntax graphics-reload
3698 \begin_layout Description
3699 Origin vfr, 10 Aug 2009
3702 \begin_layout Subsection*
3703 LFUN_SET_GRAPHICS_GROUP
3705 \begin_layout Description
3706 Action Set the group for the graphics inset on the cursor position.
3708 \begin_layout Description
3709 Syntax set-graphics-group [<GROUP>]
3711 \begin_layout Description
3712 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3714 \begin_layout Description
3715 Origin sanda, 6 May 2008
3718 \begin_layout Subsection*
3719 LFUN_FINISHED_FORWARD
3721 \begin_layout Description
3722 Action Moves the cursor out of the current slice, going forward.
3724 \begin_layout Description
3725 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.
3728 \begin_layout Subsection*
3729 LFUN_FINISHED_BACKWARD
3731 \begin_layout Description
3732 Action Moves the cursor out of the current slice, going backwards.
3734 \begin_layout Description
3735 Notion See also LFUN_FINISHED_FORWARD.
3738 \begin_layout Subsection*
3741 \begin_layout Description
3742 Action Moves the cursor out of the current slice, going right.
3744 \begin_layout Description
3745 Notion See also LFUN_FINISHED_FORWARD
3748 \begin_layout Subsection*
3751 \begin_layout Description
3752 Action Moves the cursor out of the current slice, going left.
3754 \begin_layout Description
3755 Notion See also LFUN_FINISHED_FORWARD.
3758 \begin_layout Subsection*
3761 \begin_layout Description
3762 Action Set language from the current cursor position.
3764 \begin_layout Description
3765 Syntax language <LANG>
3767 \begin_layout Description
3768 Params <LANG>: Requested language. Look in lib/languages for the list.
3770 \begin_layout Description
3771 Origin Dekel, 2 Mar 2000
3774 \begin_layout Subsection*
3777 \begin_layout Description
3778 Action Goto a label.
3780 \begin_layout Description
3781 Syntax label-goto [<LABEL>]
3783 \begin_layout Description
3784 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.
3786 \begin_layout Description
3787 Origin Ale, 6 Aug 1997
3790 \begin_layout Subsection*
3793 \begin_layout Description
3794 Action Inserts label to text or displayed formula.
3796 \begin_layout Description
3797 Syntax label-insert [<LABEL>]
3799 \begin_layout Description
3800 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3803 \begin_layout Subsection*
3806 \begin_layout Description
3807 Action Go to the next label or cross-reference.
3809 \begin_layout Description
3810 Syntax reference-next
3812 \begin_layout Description
3813 Origin Dekel, 14 Jan 2001
3816 \begin_layout Subsection*
3819 \begin_layout Description
3820 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3822 \begin_layout Description
3823 Notion Bookmark 0 has a special purpose. It is automatically set
3824 \begin_inset Newline newline
3827 1. to the paragraph you are currently editing
3828 \begin_inset Newline newline
3831 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3832 \begin_inset Newline newline
3835 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3837 \begin_layout Description
3838 Syntax bookmark-goto <NUMBER>
3840 \begin_layout Description
3841 Params <NUMBER>: the number of the bookmark to restore.
3843 \begin_layout Description
3844 Origin Dekel, 27 January 2001
3847 \begin_layout Subsection*
3850 \begin_layout Description
3851 Action Save a bookmark.
3853 \begin_layout Description
3854 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.
3856 \begin_layout Description
3857 Syntax bookmark-save <NUMBER>
3859 \begin_layout Description
3860 Params <NUMBER>: the number of the bookmark to save.
3862 \begin_layout Description
3863 Origin Dekel, 27 January 2001
3866 \begin_layout Subsection*
3869 \begin_layout Description
3870 Action Clears the list of saved bookmarks.
3872 \begin_layout Description
3873 Syntax bookmark-clear
3875 \begin_layout Description
3876 Origin bpeng, 31 October 2006
3879 \begin_layout Subsection*
3882 \begin_layout Description
3883 Action Open the given help file according to the language setting.
3885 \begin_layout Description
3886 Syntax help-open <FILE>[.lyx]
3888 \begin_layout Description
3889 Params <FILE>: any document from (/usr/share/)doc directory.
3891 \begin_layout Description
3892 Origin Jug, 27 Jun 1999
3895 \begin_layout Subsection*
3898 \begin_layout Description
3899 Action Terminates the current LyX instance.
3901 \begin_layout Description
3902 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3904 \begin_layout Description
3908 \begin_layout Subsection*
3911 \begin_layout Description
3912 Action Toggles visibility of a given toolbar between on/off/auto.
3914 \begin_layout Description
3915 Notion Skipping "auto" when allowauto is false.
3917 \begin_layout Description
3918 Syntax toolbar-toggle <NAME> [allowauto]
3920 \begin_layout Description
3921 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
3922 \begin_inset Newline newline
3925 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
3927 \begin_layout Description
3928 Origin Edwin, 21 May 2007
3931 \begin_layout Subsection*
3934 \begin_layout Description
3935 Action Opens the menu given by its name.
3937 \begin_layout Description
3938 Syntax menu-open <NAME>
3940 \begin_layout Description
3941 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3944 \begin_layout Subsection*
3947 \begin_layout Description
3948 Action Various UI visibility-toggling actions.
3950 \begin_layout Description
3951 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3953 \begin_layout Description
3954 Params statusbar : Toggle visibility of the statusbar.
3955 \begin_inset Newline newline
3958 menubar : Toggle visibility of the menubar.
3959 \begin_inset Newline newline
3962 scrollbar : Toggle visibility of the scrollbar.
3963 \begin_inset Newline newline
3966 frame : Toggle visibility of the frames around editing window.
3967 \begin_inset Newline newline
3970 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.
3972 \begin_layout Description
3973 Origin sanda, 9 Feb 2007
3976 \begin_layout Subsection*
3979 \begin_layout Description
3980 Action Creates new empty LyX window.
3982 \begin_layout Description
3983 Notion Already opened documents from the previous window can be found under View menu.
3985 \begin_layout Description
3986 Syntax window-new [<GEOMETRY>]
3988 \begin_layout Description
3989 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3991 \begin_layout Description
3992 Origin Abdel, 21 Oct 2006
3995 \begin_layout Subsection*
3998 \begin_layout Description
3999 Action Closes the current LyX window.
4001 \begin_layout Description
4004 \begin_layout Description
4005 Origin Abdel, 23 Oct 2006
4008 \begin_layout Subsection*
4011 \begin_layout Description
4012 Action Creates another split view of current buffer.
4014 \begin_layout Description
4015 Notion All split views act in the same way indpendently.
4017 \begin_layout Description
4018 Syntax split-view <vertical|horizontal>
4020 \begin_layout Description
4021 Params horizontal : The work areas are laid out side by side.
4022 \begin_inset Newline newline
4025 vertical : The work areas laid out vertically.
4027 \begin_layout Description
4028 Origin Abdel, 20 Feb 2008
4031 \begin_layout Subsection*
4032 LFUN_CLOSE_TAB_GROUP
4034 \begin_layout Description
4035 Action Close the current tab group.
4037 \begin_layout Description
4038 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
4040 \begin_layout Description
4041 Syntax close-tab-group
4043 \begin_layout Description
4044 Origin Abdel, 21 Feb 2008
4047 \begin_layout Subsection*
4050 \begin_layout Description
4051 Action Shows hidden dialog or create new one for a given function/inset settings etc.
4053 \begin_layout Description
4054 Syntax dialog-show <NAME> [<DATA>]
4056 \begin_layout Description
4057 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4058 \begin_inset Newline newline
4061 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
4062 \begin_inset Newline newline
4065 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
4066 \begin_inset Newline newline
4069 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
4070 \begin_inset Newline newline
4073 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
4074 \begin_inset Newline newline
4077 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
4078 \begin_inset Newline newline
4081 <SPECIAL>: latexlog|vclog
4082 \begin_inset Newline newline
4085 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
4087 \begin_layout Description
4088 Origin leeming, 17 Jun 2003
4091 \begin_layout Subsection*
4092 LFUN_DIALOG_SHOW_NEW_INSET
4094 \begin_layout Description
4095 Action Shows hidden dialog or create new one for a given inset settings etc.
4097 \begin_layout Description
4098 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
4100 \begin_layout Description
4101 Syntax dialog-show-new-inset <NAME> [<DATA>]
4103 \begin_layout Description
4104 Params See LFUN_DIALOG_SHOW .
4106 \begin_layout Description
4107 Origin leeming, 25 Feb 2003
4110 \begin_layout Subsection*
4113 \begin_layout Description
4114 Action Updates the dialog values from the inset/paragraph/document.
4116 \begin_layout Description
4117 Syntax dialog-update <NAME>
4119 \begin_layout Description
4120 Params <NAME>: paragraph|prefs|<INSET>
4121 \begin_inset Newline newline
4126 \begin_layout Description
4127 Origin leeming, 25 Feb 2003
4130 \begin_layout Subsection*
4133 \begin_layout Description
4134 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
4136 \begin_layout Description
4137 Syntax dialog-hide <NAME>
4139 \begin_layout Description
4140 Params See LFUN_DIALOG_SHOW .
4142 \begin_layout Description
4143 Origin leeming, 25 Feb 2003
4146 \begin_layout Subsection*
4149 \begin_layout Description
4150 Action Toggles dialog between showed/hidden state.
4152 \begin_layout Description
4153 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4155 \begin_layout Description
4156 Syntax dialog-toggle <NAME> [<DATA>]
4158 \begin_layout Description
4159 Params See LFUN_DIALOG_SHOW .
4161 \begin_layout Description
4162 Origin JSpitzm, 30 Apr 2007
4165 \begin_layout Subsection*
4166 LFUN_DIALOG_DISCONNECT_INSET
4168 \begin_layout Description
4169 Action Closes opened connection to opened inset.
4171 \begin_layout Description
4172 Notion Connection is used for apply functions.
4174 \begin_layout Description
4175 Syntax dialog-disconnect-inset <INSET-NAME>
4177 \begin_layout Description
4178 Origin leeming, 25 Feb 2003
4181 \begin_layout Subsection*
4184 \begin_layout Description
4185 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
4187 \begin_layout Description
4188 Notion This is internal LFUN, not to be used by users.
4190 \begin_layout Description
4191 Origin Andre, 9 Aug 2002
4194 \begin_layout Subsection*
4197 \begin_layout Description
4198 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
4200 \begin_layout Description
4201 Notion This is internal LFUN, not to be used by users.
4203 \begin_layout Description
4204 Origin Andre, 9 Aug 2002
4207 \begin_layout Subsection*
4210 \begin_layout Description
4211 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4213 \begin_layout Description
4214 Notion This is internal LFUN, not to be used by users.
4216 \begin_layout Description
4217 Origin Andre, 9 Aug 2002
4220 \begin_layout Subsection*
4223 \begin_layout Description
4224 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4226 \begin_layout Description
4227 Notion This is internal LFUN, not to be used by users.
4229 \begin_layout Description
4230 Origin Andre, 9 Aug 2002
4233 \begin_layout Subsection*
4236 \begin_layout Description
4237 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4239 \begin_layout Description
4240 Notion This is internal LFUN, not to be used by users.
4242 \begin_layout Description
4243 Origin Andre, 9 Aug 2002
4246 \begin_layout Subsection*
4249 \begin_layout Description
4250 Action Turn off the loaded keyboard map.
4252 \begin_layout Description
4256 \begin_layout Subsection*
4259 \begin_layout Description
4260 Action Turn on the primary keyboard map.
4262 \begin_layout Description
4263 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.
4264 \begin_inset Newline newline
4267 The language is to be set in the Preferences dialog.
4269 \begin_layout Description
4270 Syntax keymap-primary
4273 \begin_layout Subsection*
4274 LFUN_KEYMAP_SECONDARY
4276 \begin_layout Description
4277 Action Turn on the secondary keyboard map.
4279 \begin_layout Description
4280 Syntax keymap-secondary
4283 \begin_layout Subsection*
4286 \begin_layout Description
4287 Action Toggles keyboard maps (first/second/off).
4289 \begin_layout Description
4290 Syntax keymap-toggle
4292 \begin_layout Description
4293 Origin leeming, 30 Mar 2004
4296 \begin_layout Subsection*
4297 LFUN_SERVER_GET_LAYOUT
4299 \begin_layout Description
4300 Action Returns the current layout (that is environment) name on the cursor position.
4302 \begin_layout Description
4303 Syntax server-get-layout
4306 \begin_layout Subsection*
4307 LFUN_SERVER_GET_FILENAME
4309 \begin_layout Description
4310 Action Returns path and file name of the currently edited document.
4312 \begin_layout Description
4313 Syntax server-get-filename
4316 \begin_layout Subsection*
4317 LFUN_SERVER_GOTO_FILE_ROW
4319 \begin_layout Description
4320 Action Sets the cursor position in LyX based on the row number of generated TeX file.
4322 \begin_layout Description
4323 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).
4325 \begin_layout Description
4326 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4328 \begin_layout Description
4329 Params <FILE>: the path and 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.
4330 \begin_inset Newline newline
4333 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).
4334 \begin_inset Newline newline
4337 .ext: extensions will be automatically replaced by .lyx.
4338 \begin_inset Newline newline
4341 <ROW_NUMBER> The row number of the LaTeX file to which to go.
4343 \begin_layout Description
4344 Sample server-goto-file-row /home/user/example.lyx 41
4345 \begin_inset Newline newline
4348 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
4350 \begin_layout Description
4351 Origin Edmar, 23 Dec 1998
4354 \begin_layout Subsection*
4357 \begin_layout Description
4358 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
4360 \begin_layout Description
4361 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
4363 \begin_layout Description
4364 Syntax forward-search
4366 \begin_layout Description
4367 Origin sanda, 14 Apr 2010
4370 \begin_layout Subsection*
4373 \begin_layout Description
4374 Action Sends notify message about the last key-sequence to client.
4376 \begin_layout Description
4377 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4379 \begin_layout Description
4380 Syntax server-notify
4383 \begin_layout Subsection*
4386 \begin_layout Description
4387 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4389 \begin_layout Description
4390 Syntax server-set-xy <X> <Y>
4393 \begin_layout Subsection*
4396 \begin_layout Description
4397 Action Returns the coordinates of cursor position in the editing area.
4399 \begin_layout Description
4400 Syntax server-get-xy
4403 \begin_layout Subsection*
4406 \begin_layout Description
4407 Action Generates the code (literate programming).
4409 \begin_layout Description
4410 Notion Latex file with extension
4412 literate_extension is generated. Then LyX invokes
4414 build_command (with a default of``make'') to generate the code and
4416 build_error_filter to process the compilation error messages.
4417 \begin_inset Newline newline
4420 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:
4421 \begin_inset Newline newline
4426 build_command "my_script my_arguments"
4427 \begin_inset Newline newline
4432 build_error_filter differs from the
4434 literate_error_filter only in that the former will identify error messages from your compiler.
4436 \begin_layout Description
4437 Syntax build-program
4440 \begin_layout Subsection*
4441 LFUN_BUFFER_AUTO_SAVE
4443 \begin_layout Description
4444 Action Saves the current buffer to a temporary file.
4446 \begin_layout Description
4447 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4449 \begin_layout Description
4450 Syntax buffer-auto-save
4453 \begin_layout Subsection*
4454 LFUN_BUFFER_CHILD_OPEN
4456 \begin_layout Description
4457 Action Loads the given child document.
4459 \begin_layout Description
4460 Notion The current document is treated as a parent.
4462 \begin_layout Description
4463 Syntax buffer-child-open <FILE>
4465 \begin_layout Description
4466 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4468 \begin_layout Description
4469 Origin Ale, 28 May 1997
4472 \begin_layout Subsection*
4475 \begin_layout Description
4476 Action Runs chktex for the current document.
4478 \begin_layout Description
4479 Syntax buffer-chktex
4481 \begin_layout Description
4482 Origin Asger, 30 Oct 1997
4485 \begin_layout Subsection*
4486 LFUN_BUFFER_TOGGLE_COMPRESSION
4488 \begin_layout Description
4489 Action Toggles compression of the current document on/off.
4491 \begin_layout Description
4492 Syntax buffer-toggle-compression
4494 \begin_layout Description
4495 Origin bpeng, 27 Apr 2006
4498 \begin_layout Subsection*
4499 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
4501 \begin_layout Description
4502 Action Toggles including of resources for forward/reverse search of the given document.
4504 \begin_layout Description
4505 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
4507 \begin_layout Description
4508 Syntax buffer-toggle-output-sync
4510 \begin_layout Description
4511 Origin sanda, 25 May 2010
4514 \begin_layout Subsection*
4517 \begin_layout Description
4518 Action Closes the current buffer.
4520 \begin_layout Description
4521 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4523 \begin_layout Description
4527 \begin_layout Subsection*
4528 LFUN_BUFFER_CLOSE_ALL
4530 \begin_layout Description
4531 Action Closes all buffers.
4533 \begin_layout Description
4534 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4536 \begin_layout Description
4537 Syntax buffer-close-all
4540 \begin_layout Subsection*
4543 \begin_layout Description
4544 Action Exports the current buffer (document) to the given format.
4546 \begin_layout Description
4547 Syntax buffer-export <FORMAT>
4549 \begin_layout Description
4550 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.
4551 \begin_inset Newline newline
4554 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.
4556 \begin_layout Description
4557 Origin Lgb, 29 Jul 1997
4560 \begin_layout Subsection*
4561 LFUN_BUFFER_EXPORT_CUSTOM
4563 \begin_layout Description
4564 Action Exports the current buffer (document) from the given format using the given command on it.
4566 \begin_layout Description
4567 Syntax buffer-export-custom <FORMAT> <COMMAND>
4569 \begin_layout Description
4570 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4571 \begin_inset Newline newline
4574 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4576 \begin_layout Description
4577 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4579 \begin_layout Description
4580 Origin leeming, 27 Mar 2004
4583 \begin_layout Subsection*
4586 \begin_layout Description
4587 Action Prints the current document.
4589 \begin_layout Description
4590 Notion Many settings can be given via the preferences dialog.
4592 \begin_layout Description
4593 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4595 \begin_layout Description
4596 Params <TARGET> is either "printer" or "file".
4597 \begin_inset Newline newline
4600 <TARGER-NAME> is either "default" or file name or printer name.
4601 \begin_inset Newline newline
4604 <COMMAND> command ensuring the printing job.
4606 \begin_layout Description
4607 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4609 \begin_layout Description
4610 Origin leeming, 28 Mar 2004
4613 \begin_layout Subsection*
4616 \begin_layout Description
4617 Action Import a given file as a lyx document.
4619 \begin_layout Description
4620 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.
4622 \begin_layout Description
4623 Syntax buffer-import <FORMAT> [<FILE>]
4625 \begin_layout Description
4626 Origin Asger, 24 Jul 1998
4629 \begin_layout Subsection*
4632 \begin_layout Description
4633 Action Creates a new buffer (that is, document).
4635 \begin_layout Description
4636 Notion Implicit path can be set in Preferences dialog.
4638 \begin_layout Description
4639 Syntax buffer-new [<FILE>]
4641 \begin_layout Description
4642 Params <FILE>: filename of created file with absolute path.
4645 \begin_layout Subsection*
4646 LFUN_BUFFER_NEW_TEMPLATE
4648 \begin_layout Description
4649 Action Creates a new buffer (that is, document) from a template.
4651 \begin_layout Description
4652 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4654 \begin_layout Description
4655 Syntax buffer-new-template [<FILE>]
4657 \begin_layout Description
4658 Params <FILE>: filename of created file with absolute path.
4661 \begin_layout Subsection*
4664 \begin_layout Description
4665 Action Reverts opened document.
4667 \begin_layout Description
4668 Syntax buffer-reload
4670 \begin_layout Description
4671 Origin Asger, 2 Feb 1997
4674 \begin_layout Subsection*
4677 \begin_layout Description
4678 Action Display/switch to the given buffer.
4680 \begin_layout Description
4681 Syntax buffer-switch <BUFFER>
4683 \begin_layout Description
4684 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
4687 \begin_layout Subsection*
4688 LFUN_BUFFER_TOGGLE_READ_ONLY
4690 \begin_layout Description
4691 Action Toggle editing mode of the current document between read/write and read-only.
4693 \begin_layout Description
4694 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.
4696 \begin_layout Description
4697 Syntax buffer-toggle-read-only
4699 \begin_layout Description
4700 Origin Lgb, 27 May 1997
4703 \begin_layout Subsection*
4706 \begin_layout Description
4707 Action Displays current buffer in chosen format.
4709 \begin_layout Description
4710 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.
4712 \begin_layout Description
4713 Syntax buffer-view [<FORMAT>]
4715 \begin_layout Description
4716 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.
4719 \begin_layout Subsection*
4722 \begin_layout Description
4723 Action Exports the current document and put the result into the temporary directory.
4725 \begin_layout Description
4726 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).
4728 \begin_layout Description
4729 Syntax buffer-update [<FORMAT>]
4731 \begin_layout Description
4732 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.
4734 \begin_layout Description
4735 Origin Dekel, 5 Aug 2000
4738 \begin_layout Subsection*
4741 \begin_layout Description
4742 Action Saves the current buffer.
4744 \begin_layout Description
4745 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.
4747 \begin_layout Description
4751 \begin_layout Subsection*
4752 LFUN_BUFFER_WRITE_AS
4754 \begin_layout Description
4755 Action Rename and save current buffer.
4757 \begin_layout Description
4758 Syntax buffer-write-as <FILENAME>
4760 \begin_layout Description
4761 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4764 \begin_layout Subsection*
4765 LFUN_BUFFER_WRITE_ALL
4767 \begin_layout Description
4768 Action Save all changed documents.
4770 \begin_layout Description
4771 Syntax buffer-write-all
4773 \begin_layout Description
4774 Origin rgh, gpothier 6 Aug 2007
4777 \begin_layout Subsection*
4780 \begin_layout Description
4781 Action Switch to the next opened document.
4783 \begin_layout Description
4784 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4786 \begin_layout Description
4790 \begin_layout Subsection*
4791 LFUN_BUFFER_PREVIOUS
4793 \begin_layout Description
4794 Action Switch to the previous opened document.
4796 \begin_layout Description
4797 Syntax buffer-previous
4800 \begin_layout Subsection*
4801 LFUN_MASTER_BUFFER_UPDATE
4803 \begin_layout Description
4804 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4806 \begin_layout Description
4807 Syntax master-buffer-update [<FORMAT>]
4809 \begin_layout Description
4810 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.
4812 \begin_layout Description
4813 Origin Tommaso, 20 Sep 2007
4816 \begin_layout Subsection*
4817 LFUN_MASTER_BUFFER_VIEW
4819 \begin_layout Description
4820 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4822 \begin_layout Description
4823 Syntax master-buffer-view [<FORMAT>]
4825 \begin_layout Description
4826 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.
4828 \begin_layout Description
4829 Origin Tommaso, 20 Sep 2007
4832 \begin_layout Subsection*
4833 LFUN_BUFFER_LANGUAGE
4835 \begin_layout Description
4836 Action Set language of the current document.
4838 \begin_layout Description
4839 Syntax buffer-language <LANG>
4841 \begin_layout Description
4842 Params <LANG>: language name. See lib/languages for list.
4844 \begin_layout Description
4845 Origin leeming, 30 Mar 2004
4848 \begin_layout Subsection*
4849 LFUN_BUFFER_SAVE_AS_DEFAULT
4851 \begin_layout Description
4852 Action Save the current document settings as default.
4854 \begin_layout Description
4855 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4857 \begin_layout Description
4858 Syntax buffer-save-as-default [<ARGS>]
4860 \begin_layout Description
4861 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4863 \begin_layout Description
4864 Origin leeming, 30 Mar 2004
4867 \begin_layout Subsection*
4868 LFUN_BUFFER_PARAMS_APPLY
4870 \begin_layout Description
4871 Action Apply the given settings to the current document.
4873 \begin_layout Description
4874 Syntax buffer-params-apply [<ARGS>]
4876 \begin_layout Description
4877 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4879 \begin_layout Description
4880 Origin leeming, 30 Mar 2004
4883 \begin_layout Subsection*
4886 \begin_layout Description
4887 Action Inserts another LyX file.
4889 \begin_layout Description
4890 Syntax file-insert [<FILE>]
4892 \begin_layout Description
4893 Params <FILE>: Filename to be inserted.
4896 \begin_layout Subsection*
4897 LFUN_FILE_INSERT_PLAINTEXT
4899 \begin_layout Description
4900 Action Inserts plain text file.
4902 \begin_layout Description
4903 Syntax file-insert-plaintext [<FILE>]
4905 \begin_layout Description
4906 Params <FILE>: Filename to be inserted.
4908 \begin_layout Description
4909 Origin CFO-G, 19 Nov 1997
4912 \begin_layout Subsection*
4913 LFUN_FILE_INSERT_PLAINTEXT_PARA
4915 \begin_layout Description
4916 Action Inserts plain text file as paragraph (i.e. join lines).
4918 \begin_layout Description
4919 Syntax file-insert-plaintext-para [<FILE>]
4921 \begin_layout Description
4922 Params <FILE>: Filename to be inserted.
4924 \begin_layout Description
4925 Origin Levon, 14 Feb 2001
4928 \begin_layout Subsection*
4931 \begin_layout Description
4932 Action Open LyX document.
4934 \begin_layout Description
4935 Syntax file-open [<FILE>]
4937 \begin_layout Description
4938 Params <FILE>: Filename to be opened.
4941 \begin_layout Subsection*
4944 \begin_layout Description
4945 Action Executes a command defined in a .def file.
4947 \begin_layout Description
4948 Notion The definitions are by default read from lib/commands/default.def.
4949 \begin_inset Newline newline
4952 A .def file allows to define a command with
4954 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).
4956 def_file "FileName" allows to include another .def file.
4957 \begin_inset Newline newline
4960 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.
4962 \begin_layout Description
4965 \begin_layout Description
4966 Params <NAME>: Name of the command that must be called.
4968 \begin_layout Description
4969 Origin broider, 2 Oct 2007
4972 \begin_layout Subsection*
4975 \begin_layout Description
4976 Action Simulate halting Meta key (Alt key on PCs).
4978 \begin_layout Description
4979 Notion Used for buffer editation not for GUI control.
4981 \begin_layout Description
4985 \begin_layout Subsection*
4988 \begin_layout Description
4989 Action Cancels sequence prepared by LFUN_META_PREFIX .
4991 \begin_layout Description
4995 \begin_layout Subsection*
4996 LFUN_COMMAND_EXECUTE
4998 \begin_layout Description
4999 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
5001 \begin_layout Description
5002 Notion Usually bound to M-x shortcut.
5004 \begin_layout Description
5005 Syntax command-execute
5008 \begin_layout Subsection*
5011 \begin_layout Description
5012 Action Return the current key sequence and available options as a string.
5014 \begin_layout Description
5015 Notion No options are added if no current map exists.
5016 \begin_inset Newline newline
5019 This is probably usable only with connection to lyxserver.
5021 \begin_layout Description
5022 Syntax command-prefix
5025 \begin_layout Subsection*
5026 LFUN_COMMAND_SEQUENCE
5028 \begin_layout Description
5029 Action Run more commands (LFUN and its parameters) in a sequence.
5031 \begin_layout Description
5032 Syntax command-sequence <CMDS>
5034 \begin_layout Description
5035 Params <CMDS>: Sequence of commands separated by semicolons.
5037 \begin_layout Description
5038 Sample command-sequence cut; ert-insert; self-insert
5040 ; paste; self-insert {}; inset-toggle;
5042 \begin_layout Description
5043 Origin Andre, 11 Nov 1999
5046 \begin_layout Subsection*
5047 LFUN_COMMAND_ALTERNATIVES
5049 \begin_layout Description
5050 Action Runs the first listed command that is enabled.
5052 \begin_layout Description
5053 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
5055 \begin_layout Description
5056 Syntax command-alternatives <CMDS>
5058 \begin_layout Description
5059 Params <CMDS>: Sequence of commands separated by semicolons.
5061 \begin_layout Description
5062 Sample command-alternatives completion-accept;cell-forward
5064 \begin_layout Description
5065 Origin rgh, 24 September 2008
5068 \begin_layout Subsection*
5071 \begin_layout Description
5072 Action Shows message in statusbar (for script purposes).
5074 \begin_layout Description
5075 Syntax message <STRING>
5077 \begin_layout Description
5078 Origin Lgb, 8 Apr 2001
5081 \begin_layout Subsection*
5082 LFUN_DEBUG_LEVEL_SET
5084 \begin_layout Description
5085 Action Set debug output level.
5087 \begin_layout Description
5088 Syntax debug-level-set <LEVEL>
5090 \begin_layout Description
5091 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.
5093 \begin_layout Description
5094 Origin sanda, 28 Dec 2009
5097 \begin_layout Subsection*
5098 LFUN_PREFERENCES_SAVE
5100 \begin_layout Description
5101 Action Save user preferences.
5103 \begin_layout Description
5104 Syntax preferences-save
5106 \begin_layout Description
5107 Origin Lgb, 27 Nov 1999
5110 \begin_layout Subsection*
5113 \begin_layout Description
5114 Action Reconfigure the automatic settings.
5116 \begin_layout Description
5119 \begin_layout Description
5120 Origin Asger, 14 Feb 1997
5123 \begin_layout Subsection*
5126 \begin_layout Description
5127 Action Apply the given settings to user preferences.
5129 \begin_layout Description
5130 Syntax lyxrc-apply <SETTINGS>
5132 \begin_layout Description
5133 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.
5136 \begin_layout Subsection*
5137 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
5139 \begin_layout Description
5140 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
5142 \begin_layout Description
5143 Syntax toggle-cursor-follows-scrollbar
5145 \begin_layout Description
5146 Origin ARRae, 2 Dec 1997
5149 \begin_layout Subsection*
5152 \begin_layout Description
5153 Action Set the given LyX color to the color defined by the X11 name given.
5155 \begin_layout Description
5156 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5158 \begin_layout Description
5159 Syntax set-color <LYX_NAME> <X11_NAME>
5161 \begin_layout Description
5162 Origin SLior, 11 Jun 2000
5165 \begin_layout Subsection*
5168 \begin_layout Description
5169 Action Count the statistics (number of words and characters) in the document or in the given selection.
5171 \begin_layout Description
5172 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5174 \begin_layout Description
5177 \begin_layout Description
5178 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5181 \begin_layout Subsection*
5182 LFUN_COMPLETION_INLINE
5184 \begin_layout Description
5185 Action Show the inline completion at the cursor position.
5187 \begin_layout Description
5188 Syntax completion-inline
5190 \begin_layout Description
5191 Origin sts, Feb 19 2008
5194 \begin_layout Subsection*
5195 LFUN_COMPLETION_POPUP
5197 \begin_layout Description
5198 Action Show the completion popup at the cursor position.
5200 \begin_layout Description
5201 Syntax completion-popup
5203 \begin_layout Description
5204 Origin sts, Feb 19 2008
5207 \begin_layout Subsection*
5208 LFUN_COMPLETION_COMPLETE
5210 \begin_layout Description
5211 Action Try to complete the word or command at the cursor position.
5213 \begin_layout Description
5216 \begin_layout Description
5217 Origin sts, Feb 19 2008
5220 \begin_layout Subsection*
5221 LFUN_COMPLETION_CANCEL
5223 \begin_layout Description
5224 Action Try to cancel completion, either the popup or the inline completion.
5226 \begin_layout Description
5227 Syntax completion-cancel
5229 \begin_layout Description
5230 Origin sts, Sep 07 2008
5233 \begin_layout Subsection*
5234 LFUN_COMPLETION_ACCEPT
5236 \begin_layout Description
5237 Action Accept suggested completion.
5239 \begin_layout Description
5240 Syntax completion-accept
5242 \begin_layout Description
5243 Origin sanda, Sep 08 2008
5246 \begin_layout Subsection*
5249 \begin_layout Description
5250 Action Add a branch to the buffer's BranchList.
5252 \begin_layout Description
5253 Syntax branch-add <BRANCH>
5255 \begin_layout Description
5256 Params <BRANCH>: Name of the branch to add
5258 \begin_layout Description
5259 Origin spitz, 7 Jul 2009
5262 \begin_layout Subsection*
5263 LFUN_BRANCH_ACTIVATE
5265 \begin_layout Description
5266 Action Activate the branch.
5268 \begin_layout Description
5269 Syntax branch-activate <BRANCH>
5271 \begin_layout Description
5272 Params <BRANCH>: The branch to activate
5274 \begin_layout Description
5275 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5276 \begin_inset Newline newline
5279 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5281 \begin_layout Description
5282 Origin rgh, 27 May 2008
5285 \begin_layout Subsection*
5286 LFUN_BRANCH_DEACTIVATE
5288 \begin_layout Description
5289 Action De-activate the branch.
5291 \begin_layout Description
5292 Syntax branch-deactivate <BRANCH>
5294 \begin_layout Description
5295 Params <BRANCH>: The branch to deactivate
5297 \begin_layout Description
5298 Origin rgh, 27 May 2008
5301 \begin_layout Subsection*
5302 LFUN_BRANCHES_RENAME
5304 \begin_layout Description
5305 Action Rename all branches of a given name in a document.
5307 \begin_layout Description
5308 Syntax branches-rename <OLDNAME> <NEWNAME>
5310 \begin_layout Description
5311 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5313 \begin_layout Description
5314 Origin spitz, 9 Jul 2009
5317 \begin_layout Subsection*
5318 LFUN_BRANCH_ADD_INSERT
5320 \begin_layout Description
5321 Action Create new branch and directly put the branch inset into the document.
5323 \begin_layout Description
5324 Syntax branch-add-insert [<NAME>]
5326 \begin_layout Description
5327 Params <NAME>: Branch name. If it is not specified, you will be asked.
5329 \begin_layout Description
5330 Origin sanda, 10 Jul 2009
5333 \begin_layout Subsection*
5334 LFUN_LABEL_COPY_AS_REF
5336 \begin_layout Description
5337 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5339 \begin_layout Description
5340 Syntax copy-label-as-reference <LABEL>
5342 \begin_layout Description
5343 Params <LABEL>: The label to copy (for multi-line math)
5345 \begin_layout Description
5346 Origin sts, 16 Nov 2008
5349 \begin_layout Subsection*
5350 LFUN_LABEL_INSERT_AS_REF
5352 \begin_layout Description
5353 Action Inserts the label as a cross-reference at the position of the cursor.
5355 \begin_layout Description
5356 Syntax label-insert-as-reference
5358 \begin_layout Description
5359 Origin vfr, 7 Apr 2009
5362 \begin_layout Subsection*
5365 \begin_layout Description
5366 Action Increases the zoom of the screen fonts.
5368 \begin_layout Description
5369 Syntax buffer-zoom-in [<ZOOM>]
5371 \begin_layout Description
5372 Params <ZOOM>: The zoom in %, the default is 20.
5374 \begin_layout Description
5375 Origin vfr, 30 Mar 2009
5378 \begin_layout Subsection*
5379 LFUN_BUFFER_ZOOM_OUT
5381 \begin_layout Description
5382 Action Decreases the zoom of the screen fonts.
5384 \begin_layout Description
5385 Syntax buffer-zoom-out [<ZOOM>]
5387 \begin_layout Description
5388 Params <ZOOM>: The zoom in %, the default is 20.
5390 \begin_layout Description
5391 Origin vfr, 30 Mar 2009
5394 \begin_layout Subsection*
5397 \begin_layout Description
5398 Action Copies the inset to the clipboard as a certain type.
5400 \begin_layout Description
5401 Notion Currently used only for InsetInfo where its content is copied as a text.
5403 \begin_layout Description
5404 Syntax inset-copy-as
5406 \begin_layout Description
5407 Origin vfr, 18 Apr 2010