1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
7 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
8 \renewenvironment{description}{\list{}{%
9 \setlength{\itemsep}{-2pt}
10 \advance\leftmargini6\p@ \itemindent-12\p@
11 \labelwidth\z@ \let\makelabel\descriptionlabel}%
16 \use_default_options false
21 \font_typewriter default
22 \font_default_family default
29 \paperfontsize default
38 \paperorientation portrait
45 \paragraph_separation indent
47 \quotes_language english
50 \paperpagestyle default
51 \tracking_changes false
59 \begin_layout Section*
60 LFUNs documentation automatically generated 2010-11-02
63 \begin_layout Standard
67 \begin_layout Plain Layout
77 \begin_inset VSpace 1cm
82 \begin_layout Subsection*
85 \begin_layout Description
86 Action Adds an acute accent to the next character typed.
88 \begin_layout Description
92 \begin_layout Subsection*
95 \begin_layout Description
96 Action Adds a breve accent to the next character typed.
98 \begin_layout Description
102 \begin_layout Subsection*
105 \begin_layout Description
106 Action Adds a caron to the next character typed.
108 \begin_layout Description
112 \begin_layout Subsection*
115 \begin_layout Description
116 Action Adds a cedilla to the next character typed.
118 \begin_layout Description
119 Syntax accent-cedilla
122 \begin_layout Subsection*
125 \begin_layout Description
126 Action Adds a circle accent to the next character typed.
128 \begin_layout Description
132 \begin_layout Subsection*
133 LFUN_ACCENT_CIRCUMFLEX
135 \begin_layout Description
136 Action Adds a circumflex to the next character typed.
138 \begin_layout Description
139 Syntax accent-circumflex
142 \begin_layout Subsection*
145 \begin_layout Description
146 Action Adds a dot accent to the next character typed.
148 \begin_layout Description
152 \begin_layout Subsection*
155 \begin_layout Description
156 Action Adds a grave accent to the next character typed.
158 \begin_layout Description
162 \begin_layout Subsection*
163 LFUN_ACCENT_HUNGARIAN_UMLAUT
165 \begin_layout Description
166 Action Adds a Hungarian umlaut to the next character typed.
168 \begin_layout Description
172 \begin_layout Subsection*
175 \begin_layout Description
176 Action Adds a macron to the next character typed.
178 \begin_layout Description
182 \begin_layout Subsection*
185 \begin_layout Description
186 Action Adds an ogonek accent to the next character typed.
188 \begin_layout Description
192 \begin_layout Subsection*
195 \begin_layout Description
196 Action Adds a tie over the next two character typed.
198 \begin_layout Description
199 Notion The following char will finish the tie.
201 \begin_layout Description
205 \begin_layout Subsection*
208 \begin_layout Description
209 Action Adds a tilde over the next character typed.
211 \begin_layout Description
215 \begin_layout Subsection*
218 \begin_layout Description
219 Action Adds an umlaut over the next character typed.
221 \begin_layout Description
225 \begin_layout Subsection*
228 \begin_layout Description
229 Action Adds a bar under the next character typed.
231 \begin_layout Description
232 Syntax accent-underbar
235 \begin_layout Subsection*
238 \begin_layout Description
239 Action Adds a dot under the next character typed.
241 \begin_layout Description
242 Syntax accent-underdot
245 \begin_layout Subsection*
248 \begin_layout Description
249 Action Inserts a caption inset.
251 \begin_layout Description
252 Syntax caption-insert
254 \begin_layout Description
255 Origin Lgb, 18 Jul 2000
258 \begin_layout Subsection*
261 \begin_layout Description
262 Action Inserts the current date.
264 \begin_layout Description
265 Syntax date-insert [<ARG>]
267 \begin_layout Description
268 Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
270 \begin_layout Description
271 Origin jdblair, 31 Jan 2000
274 \begin_layout Subsection*
277 \begin_layout Description
278 Action Inserts a footnote inset.
280 \begin_layout Description
281 Syntax footnote-insert
283 \begin_layout Description
284 Origin Jug, 7 Mar 2000
287 \begin_layout Subsection*
290 \begin_layout Description
291 Action Inserts an ERT inset.
293 \begin_layout Description
296 \begin_layout Description
297 Origin Jug, 18 Feb 2000
300 \begin_layout Subsection*
303 \begin_layout Description
304 Action Inserts a float inset.
306 \begin_layout Description
307 Syntax float-insert <TYPE>
309 \begin_layout Description
310 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
312 \begin_layout Description
313 Origin Lgb, 27 Jun 2000
316 \begin_layout Subsection*
317 LFUN_FLOAT_WIDE_INSERT
319 \begin_layout Description
320 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
322 \begin_layout Description
323 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
325 \begin_layout Description
326 Syntax float-wide-insert <TYPE>
328 \begin_layout Description
329 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
331 \begin_layout Description
332 Origin Lgb, 31 Oct 2001
335 \begin_layout Subsection*
336 LFUN_FLOAT_LIST_INSERT
338 \begin_layout Description
339 Action Inserts the list of floats in the document.
341 \begin_layout Description
342 Syntax float-list-insert <TYPE>
344 \begin_layout Description
345 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
347 \begin_layout Description
348 Origin Lgb, 3 May 2001
351 \begin_layout Subsection*
354 \begin_layout Description
355 Action Inserts floats wrapped by the text around.
357 \begin_layout Description
358 Syntax wrap-insert <TYPE>
360 \begin_layout Description
361 Params <TYPE>: table|figure
363 \begin_layout Description
364 Origin Dekel, 7 Apr 2002
367 \begin_layout Subsection*
370 \begin_layout Description
371 Action Inserts an argument (short title) inset.
373 \begin_layout Description
374 Syntax argument-insert
376 \begin_layout Description
377 Origin vermeer, 12 Aug 2002
380 \begin_layout Subsection*
383 \begin_layout Description
384 Action Inserts a new page.
386 \begin_layout Description
387 Syntax newpage-insert <ARG>
389 \begin_layout Description
390 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
392 \begin_layout Description
393 Origin uwestoehr, 24 Nov 2007
396 \begin_layout Subsection*
397 LFUN_MARGINALNOTE_INSERT
399 \begin_layout Description
400 Action Inserts a marginal note.
402 \begin_layout Description
403 Syntax marginalnote-insert
405 \begin_layout Description
406 Origin Lgb, 26 Jun 2000
409 \begin_layout Subsection*
412 \begin_layout Description
413 Action Inserts a single unicode character.
415 \begin_layout Description
416 Syntax unicode-insert <CHAR>
418 \begin_layout Description
419 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
421 \begin_layout Description
422 Sample unicode-insert 0x0100
424 \begin_layout Description
425 Origin Lgb, 22 Oct 2006
428 \begin_layout Subsection*
431 \begin_layout Description
432 Action Inserts a new listings inset.
434 \begin_layout Description
435 Syntax listing-insert
437 \begin_layout Description
438 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
441 \begin_layout Subsection*
444 \begin_layout Description
445 Action Inserts a new preview inset.
447 \begin_layout Description
448 Syntax preview-insert
450 \begin_layout Description
451 Origin vfr, 28 Mar 2010
454 \begin_layout Subsection*
457 \begin_layout Description
458 Action Insert a tab into a listings inset.
460 \begin_layout Description
461 Notion It also works on a selection.
463 \begin_layout Description
466 \begin_layout Description
467 Origin vfr, Sep 30 2008
470 \begin_layout Subsection*
473 \begin_layout Description
474 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
476 \begin_layout Description
477 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action.
479 \begin_layout Description
482 \begin_layout Description
483 Origin vfr, Sep 30 2008
486 \begin_layout Subsection*
489 \begin_layout Description
490 Action Inserts quotes according to the type and quote-language preference.
492 \begin_layout Description
493 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
495 \begin_layout Description
496 Syntax quote-insert [<TYPE>]
498 \begin_layout Description
499 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
502 \begin_layout Subsection*
505 \begin_layout Description
506 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
508 \begin_layout Description
509 Notion Apart from lfun arguments you can use the following method:
510 \begin_inset Newline newline
513 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
514 \begin_inset Newline newline
517 2. select the text and run info-insert lfun.
519 \begin_layout Description
520 Syntax info-insert <TYPE> <ARG>
522 \begin_layout Description
523 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
524 \begin_inset Newline newline
527 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
528 \begin_inset Newline newline
531 shortcut[s]: name of lfun (e.g math-insert
534 \begin_inset Newline newline
537 lyxrc: name of rc_entry (e.g. bind_file)
538 \begin_inset Newline newline
541 lyxinfo: "version" - used version of LyX
542 \begin_inset Newline newline
545 package: name of latex package (e.g. listings)
546 \begin_inset Newline newline
549 textclass: name of textclass (e.g. article)
550 \begin_inset Newline newline
553 menu: name of lfun used in menu
554 \begin_inset Newline newline
557 icon: name of lfun used in toolbar
558 \begin_inset Newline newline
561 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
563 \begin_layout Description
564 Sample command-sequence info-insert buffer path; info-insert buffer name
566 \begin_layout Description
567 Origin bpeng, 7 Oct 2007
570 \begin_layout Subsection*
573 \begin_layout Description
574 Action Inserts branch inset.
576 \begin_layout Description
577 Syntax branch-insert <BRANCH-NAME>
579 \begin_layout Description
580 Origin vermeer, 17 Aug 2003
583 \begin_layout Subsection*
586 \begin_layout Description
587 Action Inserts Box inset.
589 \begin_layout Description
590 Syntax box-insert [<TYPE>]
592 \begin_layout Description
593 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
594 \begin_inset Newline newline
597 Framed is the default one.
599 \begin_layout Description
600 Origin vermeer, 7 Oct 2003
603 \begin_layout Subsection*
606 \begin_layout Description
607 Action Inserts CharStyle, Custom inset or XML short element.
609 \begin_layout Description
610 Notion Look into the Customization manual for more information about these elements.
611 \begin_inset Newline newline
614 To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself.
615 \begin_inset Newline newline
618 For dissolving the element see LFUN_INSET_DISSOLVE.
620 \begin_layout Description
621 Syntax flex-insert 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 Start (or remove) Appendix on the given cursor position.
701 \begin_layout Description
704 \begin_layout Description
705 Origin ettrich, 5 May 1998
708 \begin_layout Subsection*
711 \begin_layout Description
712 Action Inserts Index entry.
714 \begin_layout Description
715 Notion It automatically takes the word on the cursor position.
717 \begin_layout Description
718 Syntax index-insert [<TYPE:Name>]
720 \begin_layout Description
721 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
723 \begin_layout Description
724 Origin leeming, 3 Aug 2000
727 \begin_layout Subsection*
730 \begin_layout Description
731 Action Inserts list of Index entries on a new page.
733 \begin_layout Description
734 Syntax index-print [<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 Lgb, 27 Feb 1997
743 \begin_layout Subsection*
746 \begin_layout Description
747 Action Inserts Nomenclature entry.
749 \begin_layout Description
750 Notion It automatically takes the word on the cursor position if no symbol is given.
752 \begin_layout Description
753 Syntax nomencl-insert [<SYMBOL>]
755 \begin_layout Description
756 Origin Ugras, 4 Nov 2006
759 \begin_layout Subsection*
760 LFUN_NOMENCLATURE_PRINT
762 \begin_layout Description
763 Action Inserts list of Nomenclature entries.
765 \begin_layout Description
766 Syntax nomenclature-print
768 \begin_layout Description
769 Origin Ugras, 4 Nov 2006
772 \begin_layout Subsection*
775 \begin_layout Description
776 Action Inserts Note on the current cursor postion, move selection inside the inset.
778 \begin_layout Description
779 Syntax note-insert [<TYPE>]
781 \begin_layout Description
782 Params <TYPE>: <Note|Greyedout|Comment> default: Note
785 \begin_layout Subsection*
788 \begin_layout Description
789 Action Moves the cursor to the begining of next Note inset.
791 \begin_layout Description
795 \begin_layout Subsection*
798 \begin_layout Description
799 Action Inserts phantom on the current cursor postion, move selection inside the inset.
801 \begin_layout Description
802 Syntax phantom-insert [<TYPE>]
804 \begin_layout Description
805 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
807 \begin_layout Description
808 Origin uwestoehr, 30 Jan 2009
811 \begin_layout Subsection*
814 \begin_layout Description
815 Action Inserts a line break or new line.
817 \begin_layout Description
818 Syntax newline-insert [<ARG>]
820 \begin_layout Description
821 Params <ARG>: <newline|linebreak> default: newline
823 \begin_layout Description
824 Origin JSpitzm, 25 Mar 2008
827 \begin_layout Subsection*
830 \begin_layout Description
831 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
833 \begin_layout Description
836 \begin_layout Description
837 Origin Lgb, 17 May 2001
840 \begin_layout Subsection*
843 \begin_layout Description
844 Action Moves the cursor one line in downward direction.
846 \begin_layout Description
850 \begin_layout Subsection*
853 \begin_layout Description
854 Action Moves the cursor one line in upward direction.
856 \begin_layout Description
860 \begin_layout Subsection*
863 \begin_layout Description
864 Action Moves the cursor one line in downward direction adding the current position to the selection.
866 \begin_layout Description
870 \begin_layout Subsection*
873 \begin_layout Description
874 Action Moves the cursor one line in upward direction adding the current position to the selection.
876 \begin_layout Description
880 \begin_layout Subsection*
883 \begin_layout Description
884 Action Moves the cursor one page in downward direction.
886 \begin_layout Description
890 \begin_layout Subsection*
893 \begin_layout Description
894 Action Moves the cursor one page in upward direction.
896 \begin_layout Description
900 \begin_layout Subsection*
901 LFUN_SCREEN_DOWN_SELECT
903 \begin_layout Description
904 Action Moves the cursor one screen in downward direction adding the current position to the selection.
906 \begin_layout Description
907 Syntax screen-down-select
910 \begin_layout Subsection*
911 LFUN_SCREEN_UP_SELECT
913 \begin_layout Description
914 Action Moves the cursor one page in upward direction adding the current position to the selection.
916 \begin_layout Description
917 Syntax screen-up-select
920 \begin_layout Subsection*
923 \begin_layout Description
924 Action Scroll the buffer view.
926 \begin_layout Description
927 Notion Only scrolls the screen up or down; does not move the cursor.
929 \begin_layout Description
930 Syntax scroll <TYPE> <QUANTITY>
932 \begin_layout Description
933 Params <TYPE>: line|page
934 \begin_inset Newline newline
937 <QUANTITY>: up|down|<number>
939 \begin_layout Description
940 Origin Abdel, Dec 27 2007
943 \begin_layout Subsection*
946 \begin_layout Description
947 Action Recenters the screen on the current cursor position.
949 \begin_layout Description
950 Syntax screen-recenter
953 \begin_layout Subsection*
954 LFUN_SCREEN_SHOW_CURSOR
956 \begin_layout Description
957 Action Repositions the screen such that the cursor is visible.
959 \begin_layout Description
960 Syntax screen-show-cursor
962 \begin_layout Description
963 Origin vfr, 25 Mar 2009
966 \begin_layout Subsection*
969 \begin_layout Description
970 Action Moves the cursor one position logically backwards.
972 \begin_layout Description
973 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.
975 \begin_layout Description
979 \begin_layout Subsection*
980 LFUN_CHAR_BACKWARD_SELECT
982 \begin_layout Description
983 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
985 \begin_layout Description
986 Notion See also LFUN_CHAR_BACKWARD.
988 \begin_layout Description
989 Syntax char-backward-select
992 \begin_layout Subsection*
993 LFUN_CHAR_DELETE_BACKWARD
995 \begin_layout Description
996 Action Deletes one character in the backward direction (usually the "BackSpace" key).
998 \begin_layout Description
999 Syntax char-delete-backward
1002 \begin_layout Subsection*
1003 LFUN_CHAR_DELETE_FORWARD
1005 \begin_layout Description
1006 Action Deletes one character in the backward direction (usually the "Delete" key).
1008 \begin_layout Description
1009 Syntax char-delete-forward
1012 \begin_layout Subsection*
1015 \begin_layout Description
1016 Action Moves the cursor one position logically forward.
1018 \begin_layout Description
1019 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.
1021 \begin_layout Description
1025 \begin_layout Subsection*
1026 LFUN_CHAR_FORWARD_SELECT
1028 \begin_layout Description
1029 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1031 \begin_layout Description
1032 Notion See also LFUN_CHAR_FORWARD.
1034 \begin_layout Description
1035 Syntax char-forward-select
1038 \begin_layout Subsection*
1041 \begin_layout Description
1042 Action Moves the cursor one position "to the left".
1044 \begin_layout Description
1045 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.
1047 \begin_layout Description
1051 \begin_layout Subsection*
1052 LFUN_CHAR_LEFT_SELECT
1054 \begin_layout Description
1055 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1057 \begin_layout Description
1058 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1060 \begin_layout Description
1061 Syntax char-left-select
1064 \begin_layout Subsection*
1067 \begin_layout Description
1068 Action Moves the cursor one position "to the right".
1070 \begin_layout Description
1071 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.
1073 \begin_layout Description
1077 \begin_layout Subsection*
1078 LFUN_CHAR_RIGHT_SELECT
1080 \begin_layout Description
1081 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1083 \begin_layout Description
1084 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1086 \begin_layout Description
1087 Syntax char-right-select
1090 \begin_layout Subsection*
1093 \begin_layout Description
1094 Action Moves the cursor to the logically previous beginning of a word.
1096 \begin_layout Description
1097 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.
1099 \begin_layout Description
1100 Syntax word-backward
1103 \begin_layout Subsection*
1104 LFUN_WORD_BACKWARD_SELECT
1106 \begin_layout Description
1107 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1109 \begin_layout Description
1110 Notion See also LFUN_WORD_BACKWARD.
1112 \begin_layout Description
1113 Syntax word-backward-select
1116 \begin_layout Subsection*
1117 LFUN_WORD_DELETE_BACKWARD
1119 \begin_layout Description
1120 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1122 \begin_layout Description
1123 Syntax word-delete-backward
1126 \begin_layout Subsection*
1127 LFUN_WORD_DELETE_FORWARD
1129 \begin_layout Description
1130 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1132 \begin_layout Description
1133 Syntax word-delete-forward
1136 \begin_layout Subsection*
1137 LFUN_WORD_FIND_FORWARD
1139 \begin_layout Description
1140 Action Search for a given string in forward direction.
1142 \begin_layout Description
1143 Notion Case sensitive, match words. If no argument given, last search repeated.
1145 \begin_layout Description
1146 Syntax word-find-forward [<STRING>]
1148 \begin_layout Description
1149 Origin Etienne, 16 Feb 1998
1152 \begin_layout Subsection*
1153 LFUN_WORD_FIND_BACKWARD
1155 \begin_layout Description
1156 Action Search for a given string in backward 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-backward [<STRING>]
1164 \begin_layout Description
1165 Origin Etienne, 20 Feb 1998
1168 \begin_layout Subsection*
1171 \begin_layout Description
1172 Action Search for next occurence of a string.
1174 \begin_layout Description
1175 Syntax word-find [<DATA>]
1177 \begin_layout Description
1178 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).
1180 \begin_layout Description
1181 Origin Andre, Jan 7 2004
1184 \begin_layout Subsection*
1187 \begin_layout Description
1188 Action Replace a string in the document.
1190 \begin_layout Description
1191 Syntax word-replace [<DATA>]
1193 \begin_layout Description
1194 Params <DATA>: data is of the form "<replace>
1195 \begin_inset Newline newline
1199 \begin_inset Newline newline
1202 <casesensitive> <matchword> <all> <forward>"
1204 \begin_layout Description
1205 Origin Andre, Jan 7 2004
1208 \begin_layout Subsection*
1211 \begin_layout Description
1212 Action Search for next occurence of a pattern.
1214 \begin_layout Description
1215 Syntax word-findadv [<DATA>]
1217 \begin_layout Description
1218 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).
1220 \begin_layout Description
1221 Origin Tommaso, Nov 15 2007
1224 \begin_layout Subsection*
1227 \begin_layout Description
1228 Action Moves the cursor to the logically next beginning of a word.
1230 \begin_layout Description
1231 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.
1233 \begin_layout Description
1237 \begin_layout Subsection*
1238 LFUN_WORD_FORWARD_SELECT
1240 \begin_layout Description
1241 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1243 \begin_layout Description
1244 Notion See also LFUN_WORD_FORWARD.
1246 \begin_layout Description
1247 Syntax word-forward-select
1250 \begin_layout Subsection*
1253 \begin_layout Description
1254 Action Moves the cursor to the next beginning of a word "on the left".
1256 \begin_layout Description
1257 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.
1259 \begin_layout Description
1262 \begin_layout Description
1263 Origin dov, 28 Oct 2007
1266 \begin_layout Subsection*
1267 LFUN_WORD_LEFT_SELECT
1269 \begin_layout Description
1270 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1272 \begin_layout Description
1273 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1275 \begin_layout Description
1276 Syntax word-left-select
1278 \begin_layout Description
1279 Origin dov, 28 Oct 2007
1282 \begin_layout Subsection*
1285 \begin_layout Description
1286 Action Moves the cursor to the next beginning of a word "on the right".
1288 \begin_layout Description
1289 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.
1291 \begin_layout Description
1294 \begin_layout Description
1295 Origin dov, 28 Oct 2007
1298 \begin_layout Subsection*
1299 LFUN_WORD_RIGHT_SELECT
1301 \begin_layout Description
1302 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1304 \begin_layout Description
1305 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1307 \begin_layout Description
1308 Syntax word-right-select
1310 \begin_layout Description
1311 Origin dov, 28 Oct 2007
1314 \begin_layout Subsection*
1317 \begin_layout Description
1318 Action Puts the word where the cursor stands into the selection.
1320 \begin_layout Description
1323 \begin_layout Description
1324 Origin Andre, 11 Sep 2002
1327 \begin_layout Subsection*
1328 LFUN_WORD_CAPITALIZE
1330 \begin_layout Description
1331 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1333 \begin_layout Description
1334 Syntax word-capitalize
1337 \begin_layout Subsection*
1340 \begin_layout Description
1341 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1343 \begin_layout Description
1347 \begin_layout Subsection*
1350 \begin_layout Description
1351 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1353 \begin_layout Description
1357 \begin_layout Subsection*
1360 \begin_layout Description
1361 Action Add the word under the cursor to the respective spell checker dictionary.
1363 \begin_layout Description
1364 Syntax spelling-add [<STRING>] [<LANG>]
1366 \begin_layout Description
1367 Params <WORD>: word to add <LANG>: language name (see file languages)
1369 \begin_layout Description
1370 Origin JSpitzm, 18 Jan 2010
1373 \begin_layout Subsection*
1374 LFUN_SPELLING_IGNORE
1376 \begin_layout Description
1377 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
1379 \begin_layout Description
1380 Syntax spelling-ignore [<WORD>] [<LANG>]
1382 \begin_layout Description
1383 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1385 \begin_layout Description
1386 Origin JSpitzm, 18 Jan 2010
1389 \begin_layout Subsection*
1390 LFUN_SPELLING_REMOVE
1392 \begin_layout Description
1393 Action Remove the word under the cursor from the respective spell checker dictionary.
1395 \begin_layout Description
1396 Syntax spelling-remove [<STRING>] [<LANG>]
1398 \begin_layout Description
1399 Params <WORD>: word to remove <LANG>: language name (see file languages)
1401 \begin_layout Description
1402 Origin SWitt, 28 July 2010
1405 \begin_layout Subsection*
1406 LFUN_THESAURUS_ENTRY
1408 \begin_layout Description
1409 Action Look up thesaurus entries with respect to the word under the cursor.
1411 \begin_layout Description
1412 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1414 \begin_layout Description
1415 Params <STRING>: word to look up <LANG>: language (see file languages)
1417 \begin_layout Description
1418 Origin Levon, 20 Jul 2001
1421 \begin_layout Subsection*
1424 \begin_layout Description
1425 Action Move the cursor to the beginning of the document.
1427 \begin_layout Description
1431 \begin_layout Subsection*
1432 LFUN_BUFFER_BEGIN_SELECT
1434 \begin_layout Description
1435 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1437 \begin_layout Description
1438 Syntax buffer-begin-select
1441 \begin_layout Subsection*
1444 \begin_layout Description
1445 Action Move the cursor to the end of the document.
1447 \begin_layout Description
1451 \begin_layout Subsection*
1452 LFUN_BUFFER_END_SELECT
1454 \begin_layout Description
1455 Action Move the cursor to the end of the document adding the traversed text to the selection.
1457 \begin_layout Description
1458 Syntax buffer-end-select
1461 \begin_layout Subsection*
1464 \begin_layout Description
1465 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
1467 \begin_layout Description
1470 \begin_layout Description
1471 Origin lasgouttes, 16 Mar 2009
1474 \begin_layout Subsection*
1475 LFUN_INSET_BEGIN_SELECT
1477 \begin_layout Description
1478 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).
1480 \begin_layout Description
1481 Syntax inset-begin-select
1483 \begin_layout Description
1484 Origin lasgouttes, 16 Mar 2009
1487 \begin_layout Subsection*
1490 \begin_layout Description
1491 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
1493 \begin_layout Description
1496 \begin_layout Description
1497 Origin lasgouttes, 16 Mar 2009
1500 \begin_layout Subsection*
1501 LFUN_INSET_END_SELECT
1503 \begin_layout Description
1504 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).
1506 \begin_layout Description
1507 Syntax inset-end-select
1509 \begin_layout Description
1510 Origin lasgouttes, 16 Mar 2009
1513 \begin_layout Subsection*
1514 LFUN_INSET_SELECT_ALL
1516 \begin_layout Description
1517 Action Selects all contents of an inset.
1519 \begin_layout Description
1520 Syntax inset-select-all
1522 \begin_layout Description
1523 Origin vfr, 22 Aug 2009
1526 \begin_layout Subsection*
1529 \begin_layout Description
1530 Action Selects the whole section.
1532 \begin_layout Description
1533 Notion The cursor should be in a section heading before calling this lfun.
1535 \begin_layout Description
1536 Syntax section-select
1538 \begin_layout Description
1539 Origin vfr, 05 May 2009
1542 \begin_layout Subsection*
1545 \begin_layout Description
1546 Action Move the cursor to the begining of the (screen) line.
1548 \begin_layout Description
1552 \begin_layout Subsection*
1553 LFUN_LINE_BEGIN_SELECT
1555 \begin_layout Description
1556 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1558 \begin_layout Description
1559 Syntax line-begin-select
1562 \begin_layout Subsection*
1565 \begin_layout Description
1566 Action Move the cursor to the end of the (screen) line.
1568 \begin_layout Description
1572 \begin_layout Subsection*
1573 LFUN_LINE_END_SELECT
1575 \begin_layout Description
1576 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1578 \begin_layout Description
1579 Syntax line-end-select
1582 \begin_layout Subsection*
1585 \begin_layout Description
1586 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1588 \begin_layout Description
1589 Syntax line-delete-forward
1592 \begin_layout Subsection*
1595 \begin_layout Description
1596 Action Copies to the clipboard the last edit.
1598 \begin_layout Description
1602 \begin_layout Subsection*
1605 \begin_layout Description
1606 Action Cuts to the clipboard.
1608 \begin_layout Description
1612 \begin_layout Subsection*
1615 \begin_layout Description
1616 Action Pastes material (text or picture) from the active clipboard.
1618 \begin_layout Description
1619 Syntax paste [<TYPE>|<NUM>]
1621 \begin_layout Description
1622 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1623 \begin_inset Newline newline
1626 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1629 \begin_layout Subsection*
1630 LFUN_CLIPBOARD_PASTE
1632 \begin_layout Description
1633 Action Pastes text from the active clipboard.
1635 \begin_layout Description
1636 Syntax clipboard-paste [<ARG>]
1638 \begin_layout Description
1639 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1641 \begin_layout Description
1642 Origin baum, 10 Jul 2006
1645 \begin_layout Subsection*
1646 LFUN_PRIMARY_SELECTION_PASTE
1648 \begin_layout Description
1649 Action Pastes the currently text selected text.
1651 \begin_layout Description
1652 Notion Primary selection mechanism is linux-only thing.
1654 \begin_layout Description
1655 Syntax primary-selection-paste [<ARG>]
1657 \begin_layout Description
1658 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1661 \begin_layout Subsection*
1662 LFUN_SELECTION_PASTE
1664 \begin_layout Description
1665 Action Pastes the text in permanent selection.
1667 \begin_layout Description
1668 Syntax selection-paste
1671 \begin_layout Subsection*
1674 \begin_layout Description
1675 Action Undoes the last edit.
1677 \begin_layout Description
1681 \begin_layout Subsection*
1684 \begin_layout Description
1685 Action Redoes the last thing undone.
1687 \begin_layout Description
1691 \begin_layout Subsection*
1694 \begin_layout Description
1695 Action Repeat the given command.
1697 \begin_layout Description
1698 Syntax repeat <COUNT> <LFUN-COMMAND>
1700 \begin_layout Description
1701 Origin Andre, 27 Oct 2003
1704 \begin_layout Subsection*
1705 LFUN_CHARS_TRANSPOSE
1707 \begin_layout Description
1708 Action Transposes the character at the cursor with the one before it.
1710 \begin_layout Description
1711 Syntax chars-transpose
1713 \begin_layout Description
1714 Origin Lgb, 25 Apr 2001
1717 \begin_layout Subsection*
1718 LFUN_DEPTH_DECREMENT
1720 \begin_layout Description
1721 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1723 \begin_layout Description
1724 Syntax depth-decrement
1727 \begin_layout Subsection*
1728 LFUN_DEPTH_INCREMENT
1730 \begin_layout Description
1731 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1733 \begin_layout Description
1734 Syntax depth-increment
1737 \begin_layout Subsection*
1740 \begin_layout Description
1741 Action Toggles the bold font (selection-wise) using mathbf in math.
1743 \begin_layout Description
1747 \begin_layout Subsection*
1748 LFUN_FONT_BOLDSYMBOL
1750 \begin_layout Description
1751 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1753 \begin_layout Description
1754 Syntax font-boldsymbol
1757 \begin_layout Subsection*
1758 LFUN_FONT_TYPEWRITER
1760 \begin_layout Description
1761 Action Toggles the typewriter family font (selection-wise).
1763 \begin_layout Description
1764 Syntax font-typewriter
1767 \begin_layout Subsection*
1770 \begin_layout Description
1771 Action Toggles underline in the font (selection-wise).
1773 \begin_layout Description
1774 Syntax font-underline
1777 \begin_layout Subsection*
1780 \begin_layout Description
1781 Action Toggles double underline in the font (selection-wise).
1783 \begin_layout Description
1784 Syntax font-underunderline
1786 \begin_layout Description
1787 Origin sanda, 5 May 2009
1790 \begin_layout Subsection*
1793 \begin_layout Description
1794 Action Toggles wavy underline in the font (selection-wise).
1796 \begin_layout Description
1797 Syntax font-underwave
1799 \begin_layout Description
1800 Origin sanda, 5 May 2009
1803 \begin_layout Subsection*
1806 \begin_layout Description
1807 Action Toggles strikeout (strike-through) in the font (selection-wise).
1809 \begin_layout Description
1810 Syntax font-strikeout
1812 \begin_layout Description
1813 Origin sanda, 3 May 2009
1816 \begin_layout Subsection*
1819 \begin_layout Description
1820 Action Toggles the emphasis font style (selection-wise).
1822 \begin_layout Description
1826 \begin_layout Subsection*
1829 \begin_layout Description
1830 Action Toggles Noun text style font (selection-wise).
1832 \begin_layout Description
1836 \begin_layout Subsection*
1839 \begin_layout Description
1840 Action Toggles Roman family font (selection-wise).
1842 \begin_layout Description
1846 \begin_layout Subsection*
1849 \begin_layout Description
1850 Action Toggles Sans Serif family font (selection-wise).
1852 \begin_layout Description
1856 \begin_layout Subsection*
1859 \begin_layout Description
1860 Action Toggles Fraktur family font (math-mode, selection-wise).
1862 \begin_layout Description
1865 \begin_layout Description
1866 Origin vermeer, 10 Jan 2002
1869 \begin_layout Subsection*
1872 \begin_layout Description
1873 Action Toggles Italics font shape (math-mode, selection-wise).
1875 \begin_layout Description
1878 \begin_layout Description
1879 Origin vermeer, 10 Jan 2002
1882 \begin_layout Subsection*
1885 \begin_layout Description
1886 Action Reverts the settings of the font to the default values (selection-wise).
1888 \begin_layout Description
1892 \begin_layout Subsection*
1895 \begin_layout Description
1896 Action Sets font size according to lyx format string.
1898 \begin_layout Description
1899 Syntax font-size <SIZE>
1901 \begin_layout Description
1902 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1903 \begin_inset Newline newline
1906 largest|huge|giant|increase|decrease|default
1909 \begin_layout Subsection*
1910 LFUN_TEXTSTYLE_APPLY
1912 \begin_layout Description
1913 Action Toggle user-defined (=last-time used) text style.
1915 \begin_layout Description
1916 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1918 \begin_layout Description
1919 Syntax textstyle-apply
1921 \begin_layout Description
1922 Origin leeming, 12 Mar 2003
1925 \begin_layout Subsection*
1926 LFUN_TEXTSTYLE_UPDATE
1928 \begin_layout Description
1929 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1931 \begin_layout Description
1932 Syntax textstyle-update <FONT_INFO>
1934 \begin_layout Description
1935 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1936 \begin_inset Newline newline
1939 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1941 \begin_layout Description
1942 Origin leeming, 12 Mar 2003
1945 \begin_layout Subsection*
1946 LFUN_SCREEN_FONT_UPDATE
1948 \begin_layout Description
1949 Action Update fonts and its metrics.
1951 \begin_layout Description
1952 Notion Automatically called after zoom, dpi, font names, or norm change.
1954 \begin_layout Description
1955 Syntax screen-font-update
1957 \begin_layout Description
1958 Origin ARRae, 13 Aug 2000
1961 \begin_layout Subsection*
1964 \begin_layout Description
1965 Action Returns the info about the current font.
1967 \begin_layout Description
1971 \begin_layout Subsection*
1972 LFUN_CITATION_INSERT
1974 \begin_layout Description
1975 Action Inserts citation from loaded citation database.
1977 \begin_layout Description
1978 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1980 \begin_layout Description
1981 Params <KEY>: Citation (shortcut listed in available citations).
1982 \begin_inset Newline newline
1985 <TEXT_BEFORE>: text which should appear before citation.
1987 \begin_layout Description
1988 Origin AAS, 97-02-23
1991 \begin_layout Subsection*
1992 LFUN_BIBTEX_DATABASE_ADD
1994 \begin_layout Description
1995 Action Adds database, which will be used for bibtex citations.
1997 \begin_layout Description
1998 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2000 \begin_layout Description
2001 Syntax bibtex-database-add <DATABASE-NAME>
2003 \begin_layout Description
2004 Origin Ale, 30 May 1997
2007 \begin_layout Subsection*
2008 LFUN_BIBTEX_DATABASE_DEL
2010 \begin_layout Description
2011 Action Adds database, which will be used for bibtex citations.
2013 \begin_layout Description
2014 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2016 \begin_layout Description
2017 Syntax bibtex-database-del <DATABASE-NAME>
2019 \begin_layout Description
2020 Origin Ale, 30 May 1997
2023 \begin_layout Subsection*
2026 \begin_layout Description
2027 Action Sets the layout (that is, environment) for the current paragraph.
2029 \begin_layout Description
2030 Syntax layout <LAYOUT>
2032 \begin_layout Description
2033 Params <LAYOUT>: the layout to use
2036 \begin_layout Subsection*
2037 LFUN_LAYOUT_PARAGRAPH
2039 \begin_layout Description
2040 Action Launches the paragraph settings dialog.
2042 \begin_layout Description
2043 Syntax layout-paragraph
2046 \begin_layout Subsection*
2049 \begin_layout Description
2050 Action Launches the tabular settings dialog.
2052 \begin_layout Description
2053 Syntax layout-tabular
2055 \begin_layout Description
2056 Origin Jug, 31 Jul 2000
2059 \begin_layout Subsection*
2060 LFUN_DROP_LAYOUTS_CHOICE
2062 \begin_layout Description
2063 Action Displays list of layout choices.
2065 \begin_layout Description
2066 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
2068 \begin_layout Description
2069 Syntax drop-layouts-choice
2072 \begin_layout Subsection*
2073 LFUN_LAYOUT_MODULES_CLEAR
2075 \begin_layout Description
2076 Action Clears the module list.
2078 \begin_layout Description
2079 Notion Clears the list of included modules for the current buffer.
2081 \begin_layout Description
2082 Syntax layout-modules-clear
2084 \begin_layout Description
2085 Origin rgh, 25 August 2007
2088 \begin_layout Subsection*
2089 LFUN_LAYOUT_MODULE_ADD
2091 \begin_layout Description
2092 Action Adds a module.
2094 \begin_layout Description
2095 Notion Adds a module to the list of included modules for the current buffer.
2097 \begin_layout Description
2098 Syntax layout-module-add <MODULE>
2100 \begin_layout Description
2101 Params <MODULE>: the module to be added
2103 \begin_layout Description
2104 Origin rgh, 25 August 2007
2107 \begin_layout Subsection*
2110 \begin_layout Description
2111 Action Reloads layout information.
2113 \begin_layout Description
2114 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.
2116 \begin_layout Description
2117 Syntax layout-reload
2119 \begin_layout Description
2120 Origin rgh, 3 September 2007
2123 \begin_layout Subsection*
2124 LFUN_TEXTCLASS_APPLY
2126 \begin_layout Description
2127 Action Sets the text class for the current buffer.
2129 \begin_layout Description
2130 Syntax textclass-apply <TEXTCLASS>
2132 \begin_layout Description
2133 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2136 \begin_layout Subsection*
2139 \begin_layout Description
2140 Action Loads information for a textclass from disk.
2142 \begin_layout Description
2143 Syntax textclass-load <TEXTCLASS>
2145 \begin_layout Description
2146 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2149 \begin_layout Subsection*
2152 \begin_layout Description
2153 Action Disable selecting of text-region.
2155 \begin_layout Description
2159 \begin_layout Subsection*
2162 \begin_layout Description
2163 Action Enable selecting of text-region.
2165 \begin_layout Description
2166 Notion After enabling you can simply move arrow keys to get selected region.
2168 \begin_layout Description
2172 \begin_layout Subsection*
2175 \begin_layout Description
2176 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2178 \begin_layout Description
2181 \begin_layout Description
2182 Origin Andre, May 5 2006
2185 \begin_layout Subsection*
2188 \begin_layout Description
2189 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2191 \begin_layout Description
2192 Syntax math-delim [<LEFT>] [<RIGHT>]
2194 \begin_layout Description
2195 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.
2197 \begin_layout Description
2198 Sample math-delim { rangle
2200 \begin_layout Description
2201 Origin Alejandro, 18 Jun 1996
2204 \begin_layout Subsection*
2207 \begin_layout Description
2208 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2210 \begin_layout Description
2211 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2213 \begin_layout Description
2214 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2215 \begin_inset Newline newline
2218 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2220 \begin_layout Description
2221 Sample math-bigdelim "Bigl" "
2227 \begin_layout Description
2228 Origin Enrico & Georg, 7 May 2006
2231 \begin_layout Subsection*
2234 \begin_layout Description
2235 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2237 \begin_layout Description
2238 Syntax math-display [<ARG>]
2240 \begin_layout Description
2241 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2243 \begin_layout Description
2244 Origin Alejandro, 18 Jun 1996
2247 \begin_layout Subsection*
2250 \begin_layout Description
2251 Action Inserts math objects and symbols.
2253 \begin_layout Description
2254 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
2256 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
2258 frac{x}{y}" replaces "abc" with "
2260 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.
2262 \begin_layout Description
2263 Syntax math-insert <ARG>
2265 \begin_layout Description
2266 Params <ARG>: Symbol or LaTeX code to be inserted.
2269 \begin_layout Subsection*
2272 \begin_layout Description
2273 Action Enters subscript expression in math expression.
2275 \begin_layout Description
2276 Syntax math-subscript
2278 \begin_layout Description
2279 Origin vermeer, 12 Dec 2001
2282 \begin_layout Subsection*
2283 LFUN_MATH_SUPERSCRIPT
2285 \begin_layout Description
2286 Action Enters subscript expression in math expression.
2288 \begin_layout Description
2289 Syntax math-superscript
2291 \begin_layout Description
2292 Origin vermeer, 12 Dec 2001
2295 \begin_layout Subsection*
2298 \begin_layout Description
2299 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.
2301 \begin_layout Description
2302 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2304 \begin_layout Description
2305 Syntax math-limits [<STATE>]
2307 \begin_layout Description
2308 Params <STATE>: limits|nolimits
2311 \begin_layout Subsection*
2314 \begin_layout Description
2315 Action Inserts a math macro definition at the cursor position in the text.
2317 \begin_layout Description
2318 Syntax math-macro <NAME> [<NARGS>] [def]
2320 \begin_layout Description
2321 Params <NAME>: The name of the macro, e.g. "mymacro".
2322 \begin_inset Newline newline
2325 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2327 \begin_layout Description
2328 Origin ale, 10 May 1997; sts, 21 Dec 2007
2331 \begin_layout Subsection*
2334 \begin_layout Description
2335 Action Mutates the type of math inset to the newly selected one.
2337 \begin_layout Description
2338 Syntax math-mutate <TYPE>
2340 \begin_layout Description
2341 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2343 \begin_layout Description
2344 Origin Andre, 23 May 2001
2347 \begin_layout Subsection*
2350 \begin_layout Description
2351 Action Inserts space into math expression.
2353 \begin_layout Description
2354 Notion Use spacebar after entering this space to change type of space.
2356 \begin_layout Description
2357 Syntax math-space [<TYPE>] [<LEN>]
2359 \begin_layout Description
2360 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2361 \begin_inset Newline newline
2364 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2365 \begin_inset Newline newline
2368 custom space: hspace
2369 \begin_inset Newline newline
2372 "," used by default.
2373 \begin_inset Newline newline
2376 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2377 \begin_inset Newline newline
2380 <LEN>: length for custom spaces (hspace)
2382 \begin_layout Description
2383 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2386 \begin_layout Subsection*
2389 \begin_layout Description
2390 Action Inserts a matrix.
2392 \begin_layout Description
2393 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2395 \begin_layout Description
2396 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).
2398 \begin_layout Description
2399 Sample math-matrix 3 3 bccc
2402 \begin_layout Subsection*
2403 LFUN_MATH_AMS_MATRIX
2405 \begin_layout Description
2406 Action Inserts a matrix.
2408 \begin_layout Description
2409 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
2411 \begin_layout Description
2412 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
2414 \begin_layout Description
2415 Sample math-ams-matrix 3 3 bmatrix
2418 \begin_layout Subsection*
2421 \begin_layout Description
2422 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.
2424 \begin_layout Description
2425 Notion If there is some selected text, it puts the text inside created math box.
2427 \begin_layout Description
2428 Syntax math-mode [on|<ARG>]
2430 \begin_layout Description
2431 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2432 \begin_inset Newline newline
2435 "on": allow only entering of math mode from text mode.
2437 \begin_layout Description
2438 Origin Alejandro, 4 Jun 1996
2441 \begin_layout Subsection*
2444 \begin_layout Description
2445 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2447 \begin_layout Description
2448 Notion If there is any selected text, then it is moved inside the created regexp inset.
2450 \begin_layout Description
2451 Syntax regexp-mode [<ARG>]
2453 \begin_layout Description
2454 Params <ARG>: eventual argument (regular expression).
2456 \begin_layout Description
2457 Origin Tommaso, 4 Oct 2008
2460 \begin_layout Subsection*
2461 LFUN_MATH_NUMBER_LINE_TOGGLE
2463 \begin_layout Description
2464 Action Toggles numbering of the current formula line.
2466 \begin_layout Description
2467 Notion Must be in display formula mode.
2469 \begin_layout Description
2470 Syntax math-number-line-toggle
2472 \begin_layout Description
2473 Origin Alejandro, 18 Jun 1996
2476 \begin_layout Subsection*
2477 LFUN_MATH_NUMBER_TOGGLE
2479 \begin_layout Description
2480 Action Toggles numbering/labeling of the current formula.
2482 \begin_layout Description
2483 Notion Must be in display formula mode.
2485 \begin_layout Description
2486 Syntax math-number-toggle
2488 \begin_layout Description
2489 Origin Alejandro, 4 Jun 1996
2492 \begin_layout Subsection*
2495 \begin_layout Description
2496 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2498 \begin_layout Description
2499 Notion Selection can be used to determine the input for the external program.
2501 \begin_layout Description
2502 Syntax math-extern <LANG> [<COMMAND>]
2504 \begin_layout Description
2505 Params <LANG>: octave|maxima|maple|mathematica|script
2506 \begin_inset Newline newline
2509 where "script" stands fot the external script (normalized expression will be passed)
2511 \begin_layout Description
2512 Sample math-extern maple simplify
2514 \begin_layout Description
2515 Origin Andre, 24 Apr 2001
2518 \begin_layout Subsection*
2521 \begin_layout Description
2522 Action Changes arbitrarily the size used by math fonts inside a context.
2524 \begin_layout Description
2525 Notion Provides an interface to the LaTeX math mode font size commands.
2527 \begin_layout Description
2528 Syntax math-size <STYLE>
2530 \begin_layout Description
2541 \begin_layout Description
2542 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2545 \begin_layout Subsection*
2546 LFUN_MATH_FONT_STYLE
2548 \begin_layout Description
2549 Action Changes the text style used in math.
2551 \begin_layout Description
2552 Syntax math-font-style <STYLE>
2554 \begin_layout Description
2555 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2557 \begin_layout Description
2558 Origin vfr, 9 jan 2009
2561 \begin_layout Subsection*
2562 LFUN_MATH_MACRO_UNFOLD
2564 \begin_layout Description
2565 Action Unfold a Math Macro.
2567 \begin_layout Description
2568 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2572 \begin_layout Description
2573 Syntax math-macro-unfold
2575 \begin_layout Description
2576 Origin sts, 06 January 2008
2579 \begin_layout Subsection*
2580 LFUN_MATH_MACRO_FOLD
2582 \begin_layout Description
2583 Action Fold a Math Macro.
2585 \begin_layout Description
2586 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2590 \begin_layout Description
2591 Syntax math-macro-fold
2593 \begin_layout Description
2594 Origin sts, 06 January 2008
2597 \begin_layout Subsection*
2598 LFUN_MATH_MACRO_ADD_PARAM
2600 \begin_layout Description
2601 Action Add a parameter.
2603 \begin_layout Description
2604 Notion Add a parameter to a Math Macro.
2606 \begin_layout Description
2607 Syntax math-macro-add-param <NUM>
2609 \begin_layout Description
2610 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.
2612 \begin_layout Description
2613 Origin sts, 06 January 2008
2616 \begin_layout Subsection*
2617 LFUN_MATH_MACRO_REMOVE_PARAM
2619 \begin_layout Description
2620 Action Remove the last parameter.
2622 \begin_layout Description
2623 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2625 \begin_layout Description
2626 Syntax math-macro-remove-param <NUM>
2628 \begin_layout Description
2629 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2631 \begin_layout Description
2632 Origin sts, 06 January 2008
2635 \begin_layout Subsection*
2636 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2638 \begin_layout Description
2639 Action Append a greedy parameter.
2641 \begin_layout Description
2642 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2644 \begin_layout Description
2645 Syntax math-macro-append-greedy-param
2647 \begin_layout Description
2648 Origin sts, 06 January 2008
2651 \begin_layout Subsection*
2652 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2654 \begin_layout Description
2655 Action Remove a greedy parameter.
2657 \begin_layout Description
2658 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.
2660 \begin_layout Description
2661 Syntax math-macro-remove-greedy-param
2663 \begin_layout Description
2664 Origin sts, 06 January 2008
2667 \begin_layout Subsection*
2668 LFUN_MATH_MACRO_MAKE_OPTIONAL
2670 \begin_layout Description
2671 Action Make a parameter optional.
2673 \begin_layout Description
2674 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2676 \begin_layout Description
2677 Syntax math-macro-make-optional
2679 \begin_layout Description
2680 Origin sts, 06 January 2008
2683 \begin_layout Subsection*
2684 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2686 \begin_layout Description
2687 Action Make a parameter non-optional.
2689 \begin_layout Description
2690 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.
2692 \begin_layout Description
2693 Syntax math-macro-make-nonoptional
2695 \begin_layout Description
2696 Origin sts, 06 January 2008
2699 \begin_layout Subsection*
2700 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2702 \begin_layout Description
2703 Action Add an optional parameter.
2705 \begin_layout Description
2706 Notion Insert an optional parameter just behind the already existing optional parameters.
2708 \begin_layout Description
2709 Syntax math-macro-add-optional-param
2711 \begin_layout Description
2712 Origin sts, 06 January 2008
2715 \begin_layout Subsection*
2716 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2718 \begin_layout Description
2719 Action Remove the last optional parameter.
2721 \begin_layout Description
2722 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2724 \begin_layout Description
2725 Syntax math-macro-remove-optional-param
2727 \begin_layout Description
2728 Origin sts, 06 January 2008
2731 \begin_layout Subsection*
2732 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2734 \begin_layout Description
2735 Action Add a greedy optional parameter.
2737 \begin_layout Description
2738 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2740 \begin_layout Description
2741 Syntax math-macro-add-greedy-optional-param
2743 \begin_layout Description
2744 Origin sts, 06 January 2008
2747 \begin_layout Subsection*
2748 LFUN_IN_MATHMACROTEMPLATE
2750 \begin_layout Description
2751 Action Only active in Math Macro definition.
2753 \begin_layout Description
2754 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.
2756 \begin_layout Description
2757 Syntax in-mathmacrotemplate
2759 \begin_layout Description
2760 Origin sts, 06 January 2008
2763 \begin_layout Subsection*
2764 LFUN_PARAGRAPH_MOVE_DOWN
2766 \begin_layout Description
2767 Action Moves the current paragraph downwards in the document.
2769 \begin_layout Description
2770 Syntax paragraph-move-down
2772 \begin_layout Description
2773 Origin Edwin, 8 Apr 2006
2776 \begin_layout Subsection*
2777 LFUN_PARAGRAPH_MOVE_UP
2779 \begin_layout Description
2780 Action Moves the current paragraph upwards in the document.
2782 \begin_layout Description
2783 Syntax paragraph-move-up
2785 \begin_layout Description
2786 Origin Edwin, 8 Apr 2006
2789 \begin_layout Subsection*
2792 \begin_layout Description
2793 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2795 \begin_layout Description
2798 \begin_layout Description
2799 Origin Asger, 1 Oct 1996
2802 \begin_layout Subsection*
2803 LFUN_PARAGRAPH_UP_SELECT
2805 \begin_layout Description
2806 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2808 \begin_layout Description
2809 Syntax paragraph-up-select
2811 \begin_layout Description
2812 Origin Asger, 1 Oct 1996
2815 \begin_layout Subsection*
2818 \begin_layout Description
2819 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2821 \begin_layout Description
2822 Syntax paragraph-down
2824 \begin_layout Description
2825 Origin Asger, 1 Oct 1996
2828 \begin_layout Subsection*
2829 LFUN_PARAGRAPH_DOWN_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 downward direction.
2834 \begin_layout Description
2835 Syntax paragraph-down-select
2837 \begin_layout Description
2838 Origin Asger, 1 Oct 1996
2841 \begin_layout Subsection*
2844 \begin_layout Description
2845 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2847 \begin_layout Description
2848 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).
2850 \begin_layout Description
2851 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2853 \begin_layout Description
2854 Params <PAR_ID_NUMBER>: paragraph id
2855 \begin_inset Newline newline
2858 <POSITION_IN_PAR>: desired position within the paragraph
2860 \begin_layout Description
2861 Origin Dekel, 26 Aug 2000
2864 \begin_layout Subsection*
2865 LFUN_BREAK_PARAGRAPH
2867 \begin_layout Description
2868 Action Breaks the current paragraph at the current location.
2870 \begin_layout Description
2871 Notion Removes the selection.
2873 \begin_layout Description
2874 Syntax break-paragraph [<LAYOUT>]
2876 \begin_layout Description
2877 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2880 \begin_layout Subsection*
2881 LFUN_PARAGRAPH_PARAMS
2883 \begin_layout Description
2884 Action Change paragraph settings.
2886 \begin_layout Description
2887 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.
2889 \begin_layout Description
2890 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2892 \begin_layout Description
2902 \begin_inset Newline newline
2907 paragraph_spacing default|single|onehalf|double|other SIZE
2908 \begin_inset Newline newline
2913 align block|left|right|center|default
2914 \begin_inset Newline newline
2919 labelwidthstring WIDTH|
2923 \begin_layout Description
2924 Origin rgh, Aug 15 2007
2927 \begin_layout Subsection*
2928 LFUN_PARAGRAPH_PARAMS_APPLY
2930 \begin_layout Description
2931 Action Change paragraph settings.
2933 \begin_layout Description
2934 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2936 \begin_layout Description
2937 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2939 \begin_layout Description
2940 Params For parameters see LFUN_PARAGRAPH_PARAMS
2942 \begin_layout Description
2943 Origin leeming, 30 Mar 2004
2946 \begin_layout Subsection*
2947 LFUN_PARAGRAPH_UPDATE
2949 \begin_layout Description
2950 Action Updates the values inside the paragraph dialog from the paragraph.
2952 \begin_layout Description
2953 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2955 \begin_layout Description
2956 Origin leeming, 13 Mar 2003
2959 \begin_layout Subsection*
2962 \begin_layout Description
2963 Action Move the current group in the upward direction in the structure of the document.
2965 \begin_layout Description
2966 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2968 \begin_layout Description
2971 \begin_layout Description
2972 Origin Vermeer, 23 Mar 2006
2975 \begin_layout Subsection*
2978 \begin_layout Description
2979 Action Move the current group in the downward direction in the structure of the document.
2981 \begin_layout Description
2982 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2984 \begin_layout Description
2987 \begin_layout Description
2988 Origin Vermeer, 23 Mar 2006
2991 \begin_layout Subsection*
2994 \begin_layout Description
2995 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2997 \begin_layout Description
2998 Notion Part -> Chapter -> Section -> etc.
3000 \begin_layout Description
3003 \begin_layout Description
3004 Origin Vermeer, 23 Mar 2006
3007 \begin_layout Subsection*
3010 \begin_layout Description
3011 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3013 \begin_layout Description
3014 Notion Part <- Chapter <- Section <- etc.
3016 \begin_layout Description
3019 \begin_layout Description
3020 Origin Vermeer, 23 Mar 2006
3023 \begin_layout Subsection*
3026 \begin_layout Description
3027 Action Edit the inset at cursor with an external application, if one is attributed.
3029 \begin_layout Description
3030 Syntax inset-edit [<INSET_PARAMS>]
3032 \begin_layout Description
3033 Params <INSET_PARAMS>: Parameters for the inset.
3034 \begin_inset Newline newline
3037 Currently only the filename will be considered.
3039 \begin_layout Description
3040 Origin JSpitzm, 27 Apr 2006
3043 \begin_layout Subsection*
3046 \begin_layout Description
3047 Action Inserts table into the document.
3049 \begin_layout Description
3050 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3052 \begin_layout Description
3053 Syntax tabular-insert [<ROWS> <COLUMNS>]
3055 \begin_layout Description
3056 Params In case no arguments are given show insert dialog.
3058 \begin_layout Description
3059 Origin Jug, 12 Apr 2000
3062 \begin_layout Subsection*
3065 \begin_layout Description
3066 Action Moves the cursor to the previous cell inside the table.
3068 \begin_layout Description
3069 Syntax cell-backward
3071 \begin_layout Description
3072 Origin Jug, 22 May 2000
3075 \begin_layout Subsection*
3078 \begin_layout Description
3079 Action Moves the cursor to the next cell inside the table.
3081 \begin_layout Description
3085 \begin_layout Subsection*
3088 \begin_layout Description
3089 Action Splits cell and shifts right part to the next cell (inside the math grid).
3091 \begin_layout Description
3094 \begin_layout Description
3095 Origin Ale, 15 May 1997
3098 \begin_layout Subsection*
3101 \begin_layout Description
3102 Action Register the document as an file inside version control system (RCS, CVS).
3104 \begin_layout Description
3105 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3106 \begin_inset Newline newline
3109 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3111 \begin_layout Description
3114 \begin_layout Description
3115 Origin Lgb, 1 Jul 1997
3118 \begin_layout Subsection*
3121 \begin_layout Description
3122 Action Checks-in/commits the changes of the registered file to the repository.
3124 \begin_layout Description
3125 Notion In RCS case this also unlocks the file.
3127 \begin_layout Description
3130 \begin_layout Description
3131 Origin Lgb, 1 Jul 1997
3134 \begin_layout Subsection*
3137 \begin_layout Description
3138 Action Checks-out the document for edit (and locks it for RCS).
3140 \begin_layout Description
3141 Notion This is implemented only for RCS and SVN, not CVS.
3143 \begin_layout Description
3146 \begin_layout Description
3147 Origin Lgb, 1 Jul 1997
3150 \begin_layout Subsection*
3153 \begin_layout Description
3154 Action Reverts the document to the last check-in/commit in VCS.
3156 \begin_layout Description
3159 \begin_layout Description
3160 Origin Lgb, 1 Jul 1997
3163 \begin_layout Subsection*
3166 \begin_layout Description
3167 Action Undo last check-in.
3169 \begin_layout Description
3170 Notion This is currently implemented only for RCS.
3172 \begin_layout Description
3175 \begin_layout Description
3176 Origin Lgb, 1 Jul 1997
3179 \begin_layout Subsection*
3182 \begin_layout Description
3183 Action Executes external command. This command is intended to support additional VCS commands.
3185 \begin_layout Description
3186 Syntax vc-command <FLAG> <PATH> <COMMAND>
3188 \begin_layout Description
3189 Params <FLAG>: Flags for the command can be combined together.
3190 \begin_inset Newline newline
3193 U - dUmmy - no flags
3194 \begin_inset Newline newline
3197 D - Doc - need document loaded to proceed
3198 \begin_inset Newline newline
3201 I - dIrty - mark document dirty
3202 \begin_inset Newline newline
3205 R - Reload - ensure that the document is saved and reload it after command execution
3206 \begin_inset Newline newline
3209 M - Message - ask for input string (commit message)
3210 \begin_inset Newline newline
3213 <PATH>: path where to start. $$p will be replaced by the current document path.
3214 \begin_inset Newline newline
3217 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
3219 \begin_layout Description
3220 Sample vc-command DR $$p "svn up"
3222 \begin_layout Description
3223 Origin sanda, 13 Jan 2009
3226 \begin_layout Subsection*
3227 LFUN_VC_LOCKING_TOGGLE
3229 \begin_layout Description
3230 Action Toggles the locking property of the edited file.
3232 \begin_layout Description
3233 Notion This is currently implemented only for SVN.
3235 \begin_layout Description
3236 Syntax vc-locking-toggle
3238 \begin_layout Description
3239 Origin sanda, 25 Jun 2009
3242 \begin_layout Subsection*
3245 \begin_layout Description
3246 Action Update the local archive directory in which resides the current document with the remote repository.
3248 \begin_layout Description
3249 Notion This is currently implemented only for SVN.
3251 \begin_layout Description
3252 Syntax vc-repo-update
3254 \begin_layout Description
3255 Origin sanda, 16 Oct 2009
3258 \begin_layout Subsection*
3261 \begin_layout Description
3262 Action Compares two revisions of the same file under version control.
3264 \begin_layout Description
3265 Notion This is currently implemented only for SVN and RCS.
3267 \begin_layout Description
3268 Syntax vc-compare [<REV1>] [<REV2>]
3270 \begin_layout Description
3271 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
3272 \begin_inset Newline newline
3275 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
3276 \begin_inset Newline newline
3280 \begin_inset Newline newline
3283 <REV2>: Newer file. Used only if REV1 > 0.
3284 \begin_inset Newline newline
3287 If no parameter is given, interactive dialog will be shown.
3289 \begin_layout Description
3290 Sample Compare current document against last commit
3291 \begin_inset Newline newline
3294 vc-compare 0Compare current document against current revision - 5 commits
3295 \begin_inset Newline newline
3298 vc-compare -5Compare revisions 120 and 155
3299 \begin_inset Newline newline
3304 \begin_layout Description
3305 Origin sanda, 12 Feb 2010
3308 \begin_layout Subsection*
3311 \begin_layout Description
3312 Action Toggles change tracking to on/off.
3314 \begin_layout Description
3315 Syntax changes-track
3317 \begin_layout Description
3318 Origin levon, 1 Oct 2002
3321 \begin_layout Subsection*
3324 \begin_layout Description
3325 Action Toggles showing of change tracking in typesetted output.
3327 \begin_layout Description
3328 Syntax changes-output
3330 \begin_layout Description
3331 Origin jspitzm, 21 Jan 2005
3334 \begin_layout Subsection*
3337 \begin_layout Description
3338 Action Moves the cursor to the position of the next change of the change tracking records.
3340 \begin_layout Description
3343 \begin_layout Description
3344 Origin schmitt, 4 Oct 2006
3347 \begin_layout Subsection*
3348 LFUN_CHANGE_PREVIOUS
3350 \begin_layout Description
3351 Action Moves the cursor to the position of the previous change of the change tracking records.
3353 \begin_layout Description
3354 Syntax change-previous
3356 \begin_layout Description
3357 Origin vfr, 4 Apr 2009
3360 \begin_layout Subsection*
3363 \begin_layout Description
3364 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3366 \begin_layout Description
3367 Syntax changes-merge
3369 \begin_layout Description
3370 Origin Levon, 16 Oct 2002
3373 \begin_layout Subsection*
3376 \begin_layout Description
3377 Action Accepts tracked change inside the selection.
3379 \begin_layout Description
3380 Syntax change-accept
3382 \begin_layout Description
3383 Origin Levon, 16 Oct 2002
3386 \begin_layout Subsection*
3389 \begin_layout Description
3390 Action Rejects tracked change inside the selection.
3392 \begin_layout Description
3393 Syntax change-accept
3395 \begin_layout Description
3396 Origin Levon, 16 Oct 2002
3399 \begin_layout Subsection*
3400 LFUN_ALL_CHANGES_ACCEPT
3402 \begin_layout Description
3403 Action Accepts all tracked changes in the document.
3405 \begin_layout Description
3406 Syntax all-changes-accept
3408 \begin_layout Description
3409 Origin Levon, 16 Oct 2002
3412 \begin_layout Subsection*
3413 LFUN_ALL_CHANGES_REJECT
3415 \begin_layout Description
3416 Action Rejects all tracked changes in the document.
3418 \begin_layout Description
3419 Notion Reject does not work recursively; the user may have to repeat the operation.
3421 \begin_layout Description
3422 Syntax all-changes-reject
3424 \begin_layout Description
3425 Origin Levon, 16 Oct 2002
3428 \begin_layout Subsection*
3431 \begin_layout Description
3432 Action Apply data for an inset.
3434 \begin_layout Description
3435 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.
3437 \begin_layout Description
3438 Syntax inset-apply <ARGS>
3440 \begin_layout Description
3441 Params See LFUN_INSET_INSERT .
3444 \begin_layout Subsection*
3447 \begin_layout Description
3448 Action Dissolve the current inset into text.
3450 \begin_layout Description
3451 Syntax inset-dissolve [<INSET>]
3453 \begin_layout Description
3454 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.
3455 \begin_inset Newline newline
3458 For values see lyx::InsetLayout::lyxtype_ .
3460 \begin_layout Description
3461 Origin JSpitz, 7 Aug 2006
3464 \begin_layout Subsection*
3467 \begin_layout Description
3468 Action Insert new inset (type given by the parameters).
3470 \begin_layout Description
3471 Syntax inset-insert <INSET> <ARGS>
3473 \begin_layout Description
3474 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular| hyperlink|include|index|label|line|nomencl|vspace|ref|toc>
3475 \begin_inset Newline newline
3478 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3480 \begin_layout Description
3481 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3484 \begin_inset Newline newline
3487 where <label name> is the name of the referenced label and <Format> is one of the following:
3488 \begin_inset Newline newline
3492 \begin_inset Newline newline
3495 eqref -- (<reference>)
3496 \begin_inset Newline newline
3500 \begin_inset Newline newline
3503 vpageref -- on <page>
3504 \begin_inset Newline newline
3507 vref -- <reference> on <page>
3508 \begin_inset Newline newline
3511 formatted -- Formatted reference
3514 \begin_layout Subsection*
3517 \begin_layout Description
3518 Action Modify some properties of an inset.
3520 \begin_layout Description
3521 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.
3523 \begin_layout Description
3524 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
3526 \begin_layout Description
3527 Params Generally see LFUN_INSET_INSERT for further details.
3528 \begin_inset Newline newline
3531 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.
3532 \begin_inset Newline newline
3535 <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
3536 \begin_inset Newline newline
3539 <ARG>: additional argument for some commands, use debug mode to explore its values.
3541 \begin_layout Description
3542 Sample inset-modify note Note Commentinset-modify changetype Ovalbox
3545 \begin_layout Subsection*
3546 LFUN_INSET_DIALOG_UPDATE
3548 \begin_layout Description
3549 Action Updates the values inside the dialog from the inset.
3551 \begin_layout Description
3552 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3554 \begin_layout Description
3555 Params <DIALOG-NAME>
3557 \begin_layout Description
3558 Origin leeming, 25 Feb 2003
3561 \begin_layout Subsection*
3564 \begin_layout Description
3565 Action Open the inset's properties dialog.
3567 \begin_layout Description
3568 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.
3570 \begin_layout Description
3571 Syntax inset-settings <INSET>
3573 \begin_layout Description
3574 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float| graphics|href|include|index|index_print|label|line| listings|note|phantom|ref|space|tabular|vspace|wrap>.
3577 \begin_layout Subsection*
3580 \begin_layout Description
3581 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3583 \begin_layout Description
3584 Syntax inset-toggle [<ARG>]
3586 \begin_layout Description
3587 Params <ARG>: <open|close|toggle|assign>.
3588 \begin_inset Newline newline
3591 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3592 \begin_inset Newline newline
3595 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3597 \begin_layout Description
3598 Origin lasgouttes, 19 Jul 2001
3601 \begin_layout Subsection*
3604 \begin_layout Description
3605 Action Apply the given commands on insets of a given name.
3607 \begin_layout Description
3608 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.
3610 \begin_layout Description
3611 Syntax inset-forall <NAME> <LFUN-COMMAND>
3612 \begin_inset Newline newline
3615 <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.
3617 \begin_layout Description
3618 Sample Remove all index insets:
3619 \begin_inset Newline newline
3622 inset-forall Index delete-char-forward
3623 \begin_inset Newline newline
3626 Close all Notes (also works for a particular branch, for example):
3627 \begin_inset Newline newline
3630 inset-forall Note inset-toggle close
3631 \begin_inset Newline newline
3634 Transform all yellow notes to comments
3635 \begin_inset Newline newline
3638 inset-forall Note:Note inset-modify note Note Comment
3639 \begin_inset Newline newline
3642 Try to put LyX in an infinite loop if there is at least a Note:
3643 \begin_inset Newline newline
3646 inset-forall Note char-backward
3648 \begin_layout Description
3649 Origin lasgouttes, 27 Nov 2009
3652 \begin_layout Subsection*
3653 LFUN_GRAPHICS_RELOAD
3655 \begin_layout Description
3656 Action Reloads the image if necessary.
3658 \begin_layout Description
3659 Syntax graphics-reload
3661 \begin_layout Description
3662 Origin vfr, 10 Aug 2009
3665 \begin_layout Subsection*
3666 LFUN_SET_GRAPHICS_GROUP
3668 \begin_layout Description
3669 Action Set the group for the graphics inset on the cursor position.
3671 \begin_layout Description
3672 Syntax set-graphics-group [<GROUP>]
3674 \begin_layout Description
3675 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3677 \begin_layout Description
3678 Origin sanda, 6 May 2008
3681 \begin_layout Subsection*
3682 LFUN_FINISHED_FORWARD
3684 \begin_layout Description
3685 Action Moves the cursor out of the current slice, going forward.
3687 \begin_layout Description
3688 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.
3691 \begin_layout Subsection*
3692 LFUN_FINISHED_BACKWARD
3694 \begin_layout Description
3695 Action Moves the cursor out of the current slice, going backwards.
3697 \begin_layout Description
3698 Notion See also LFUN_FINISHED_FORWARD.
3701 \begin_layout Subsection*
3704 \begin_layout Description
3705 Action Moves the cursor out of the current slice, going right.
3707 \begin_layout Description
3708 Notion See also LFUN_FINISHED_FORWARD
3711 \begin_layout Subsection*
3714 \begin_layout Description
3715 Action Moves the cursor out of the current slice, going left.
3717 \begin_layout Description
3718 Notion See also LFUN_FINISHED_FORWARD.
3721 \begin_layout Subsection*
3724 \begin_layout Description
3725 Action Set language from the current cursor position.
3727 \begin_layout Description
3728 Syntax language <LANG>
3730 \begin_layout Description
3731 Params <LANG>: Requested language. Look in lib/languages for the list.
3733 \begin_layout Description
3734 Origin Dekel, 2 Mar 2000
3737 \begin_layout Subsection*
3740 \begin_layout Description
3741 Action Goto a label.
3743 \begin_layout Description
3744 Syntax label-goto [<LABEL>]
3746 \begin_layout Description
3747 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.
3749 \begin_layout Description
3750 Origin Ale, 6 Aug 1997
3753 \begin_layout Subsection*
3756 \begin_layout Description
3757 Action Inserts label to text or displayed formula.
3759 \begin_layout Description
3760 Syntax label-insert [<LABEL>]
3762 \begin_layout Description
3763 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3766 \begin_layout Subsection*
3769 \begin_layout Description
3770 Action Go to the next label or cross-reference.
3772 \begin_layout Description
3773 Syntax reference-next
3775 \begin_layout Description
3776 Origin Dekel, 14 Jan 2001
3779 \begin_layout Subsection*
3782 \begin_layout Description
3783 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3785 \begin_layout Description
3786 Notion Bookmark 0 has a special purpose. It is automatically set
3787 \begin_inset Newline newline
3790 1. to the paragraph you are currently editing
3791 \begin_inset Newline newline
3794 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3795 \begin_inset Newline newline
3798 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3800 \begin_layout Description
3801 Syntax bookmark-goto <NUMBER>
3803 \begin_layout Description
3804 Params <NUMBER>: the number of the bookmark to restore.
3806 \begin_layout Description
3807 Origin Dekel, 27 January 2001
3810 \begin_layout Subsection*
3813 \begin_layout Description
3814 Action Save a bookmark.
3816 \begin_layout Description
3817 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.
3819 \begin_layout Description
3820 Syntax bookmark-save <NUMBER>
3822 \begin_layout Description
3823 Params <NUMBER>: the number of the bookmark to save.
3825 \begin_layout Description
3826 Origin Dekel, 27 January 2001
3829 \begin_layout Subsection*
3832 \begin_layout Description
3833 Action Clears the list of saved bookmarks.
3835 \begin_layout Description
3836 Syntax bookmark-clear
3838 \begin_layout Description
3839 Origin bpeng, 31 October 2006
3842 \begin_layout Subsection*
3845 \begin_layout Description
3846 Action Open the given help file according to the language setting.
3848 \begin_layout Description
3849 Syntax help-open <FILE>[.lyx]
3851 \begin_layout Description
3852 Params <FILE>: any document from (/usr/share/)doc directory.
3854 \begin_layout Description
3855 Origin Jug, 27 Jun 1999
3858 \begin_layout Subsection*
3861 \begin_layout Description
3862 Action Terminates the current LyX instance.
3864 \begin_layout Description
3865 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3867 \begin_layout Description
3871 \begin_layout Subsection*
3874 \begin_layout Description
3875 Action Toggles visibility of a given toolbar between on/off/auto.
3877 \begin_layout Description
3878 Notion Skipping "auto" when allowauto is false.
3880 \begin_layout Description
3881 Syntax toolbar-toggle <NAME> [allowauto]
3883 \begin_layout Description
3884 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
3886 \begin_layout Description
3887 Origin Edwin, 21 May 2007
3890 \begin_layout Subsection*
3893 \begin_layout Description
3894 Action Opens the menu given by its name.
3896 \begin_layout Description
3897 Syntax menu-open <NAME>
3899 \begin_layout Description
3900 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3903 \begin_layout Subsection*
3906 \begin_layout Description
3907 Action Various UI visibility-toggling actions.
3909 \begin_layout Description
3910 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3912 \begin_layout Description
3913 Params statusbar : Toggle visibility of the statusbar.
3914 \begin_inset Newline newline
3917 menubar : Toggle visibility of the menubar.
3918 \begin_inset Newline newline
3921 scrollbar : Toggle visibility of the scrollbar.
3922 \begin_inset Newline newline
3925 frame : Toggle visibility of the frames around editing window.
3926 \begin_inset Newline newline
3929 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.
3931 \begin_layout Description
3932 Origin sanda, 9 Feb 2007
3935 \begin_layout Subsection*
3938 \begin_layout Description
3939 Action Creates new empty LyX window.
3941 \begin_layout Description
3942 Notion Already opened documents from the previous window can be found under View menu.
3944 \begin_layout Description
3945 Syntax window-new [<GEOMETRY>]
3947 \begin_layout Description
3948 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3950 \begin_layout Description
3951 Origin Abdel, 21 Oct 2006
3954 \begin_layout Subsection*
3957 \begin_layout Description
3958 Action Closes the current LyX window.
3960 \begin_layout Description
3963 \begin_layout Description
3964 Origin Abdel, 23 Oct 2006
3967 \begin_layout Subsection*
3970 \begin_layout Description
3971 Action Creates another split view of current buffer.
3973 \begin_layout Description
3974 Notion All split views act in the same way indpendently.
3976 \begin_layout Description
3977 Syntax split-view <vertical|horizontal>
3979 \begin_layout Description
3980 Params horizontal : The work areas are laid out side by side.
3981 \begin_inset Newline newline
3984 vertical : The work areas laid out vertically.
3986 \begin_layout Description
3987 Origin Abdel, 20 Feb 2008
3990 \begin_layout Subsection*
3991 LFUN_CLOSE_TAB_GROUP
3993 \begin_layout Description
3994 Action Close the current tab group.
3996 \begin_layout Description
3997 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
3999 \begin_layout Description
4000 Syntax close-tab-group
4002 \begin_layout Description
4003 Origin Abdel, 21 Feb 2008
4006 \begin_layout Subsection*
4009 \begin_layout Description
4010 Action Shows hidden dialog or create new one for a given function/inset settings etc.
4012 \begin_layout Description
4013 Syntax dialog-show <NAME> [<DATA>]
4015 \begin_layout Description
4016 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4017 \begin_inset Newline newline
4020 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
4021 \begin_inset Newline newline
4024 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
4025 \begin_inset Newline newline
4028 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
4029 \begin_inset Newline newline
4032 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
4033 \begin_inset Newline newline
4036 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
4037 \begin_inset Newline newline
4040 <SPECIAL>: latexlog|vclog
4041 \begin_inset Newline newline
4044 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
4046 \begin_layout Description
4047 Origin leeming, 17 Jun 2003
4050 \begin_layout Subsection*
4051 LFUN_DIALOG_SHOW_NEW_INSET
4053 \begin_layout Description
4054 Action Shows hidden dialog or create new one for a given inset settings etc.
4056 \begin_layout Description
4057 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
4059 \begin_layout Description
4060 Syntax dialog-show-new-inset <NAME> [<DATA>]
4062 \begin_layout Description
4063 Params See LFUN_DIALOG_SHOW .
4065 \begin_layout Description
4066 Origin leeming, 25 Feb 2003
4069 \begin_layout Subsection*
4072 \begin_layout Description
4073 Action Updates the dialog values from the inset/paragraph/document.
4075 \begin_layout Description
4076 Syntax dialog-update <NAME>
4078 \begin_layout Description
4079 Params <NAME>: paragraph|prefs|<INSET>
4080 \begin_inset Newline newline
4085 \begin_layout Description
4086 Origin leeming, 25 Feb 2003
4089 \begin_layout Subsection*
4092 \begin_layout Description
4093 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
4095 \begin_layout Description
4096 Syntax dialog-hide <NAME>
4098 \begin_layout Description
4099 Params See LFUN_DIALOG_SHOW .
4101 \begin_layout Description
4102 Origin leeming, 25 Feb 2003
4105 \begin_layout Subsection*
4108 \begin_layout Description
4109 Action Toggles dialog between showed/hidden state.
4111 \begin_layout Description
4112 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4114 \begin_layout Description
4115 Syntax dialog-toggle <NAME> [<DATA>]
4117 \begin_layout Description
4118 Params See LFUN_DIALOG_SHOW .
4120 \begin_layout Description
4121 Origin JSpitzm, 30 Apr 2007
4124 \begin_layout Subsection*
4125 LFUN_DIALOG_DISCONNECT_INSET
4127 \begin_layout Description
4128 Action Closes opened connection to opened inset.
4130 \begin_layout Description
4131 Notion Connection is used for apply functions.
4133 \begin_layout Description
4134 Syntax dialog-disconnect-inset <INSET-NAME>
4136 \begin_layout Description
4137 Origin leeming, 25 Feb 2003
4140 \begin_layout Subsection*
4143 \begin_layout Description
4144 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
4146 \begin_layout Description
4147 Notion This is internal LFUN, not to be used by users.
4149 \begin_layout Description
4150 Origin Andre, 9 Aug 2002
4153 \begin_layout Subsection*
4156 \begin_layout Description
4157 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
4159 \begin_layout Description
4160 Notion This is internal LFUN, not to be used by users.
4162 \begin_layout Description
4163 Origin Andre, 9 Aug 2002
4166 \begin_layout Subsection*
4169 \begin_layout Description
4170 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4172 \begin_layout Description
4173 Notion This is internal LFUN, not to be used by users.
4175 \begin_layout Description
4176 Origin Andre, 9 Aug 2002
4179 \begin_layout Subsection*
4182 \begin_layout Description
4183 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4185 \begin_layout Description
4186 Notion This is internal LFUN, not to be used by users.
4188 \begin_layout Description
4189 Origin Andre, 9 Aug 2002
4192 \begin_layout Subsection*
4195 \begin_layout Description
4196 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4198 \begin_layout Description
4199 Notion This is internal LFUN, not to be used by users.
4201 \begin_layout Description
4202 Origin Andre, 9 Aug 2002
4205 \begin_layout Subsection*
4208 \begin_layout Description
4209 Action Turn off the loaded keyboard map.
4211 \begin_layout Description
4215 \begin_layout Subsection*
4218 \begin_layout Description
4219 Action Turn on the primary keyboard map.
4221 \begin_layout Description
4222 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.
4223 \begin_inset Newline newline
4226 The language is to be set in the Preferences dialog.
4228 \begin_layout Description
4229 Syntax keymap-primary
4232 \begin_layout Subsection*
4233 LFUN_KEYMAP_SECONDARY
4235 \begin_layout Description
4236 Action Turn on the secondary keyboard map.
4238 \begin_layout Description
4239 Syntax keymap-secondary
4242 \begin_layout Subsection*
4245 \begin_layout Description
4246 Action Toggles keyboard maps (first/second/off).
4248 \begin_layout Description
4249 Syntax keymap-toggle
4251 \begin_layout Description
4252 Origin leeming, 30 Mar 2004
4255 \begin_layout Subsection*
4256 LFUN_SERVER_GET_LAYOUT
4258 \begin_layout Description
4259 Action Returns the current layout (that is environment) name on the cursor position.
4261 \begin_layout Description
4262 Syntax server-get-layout
4265 \begin_layout Subsection*
4266 LFUN_SERVER_GET_FILENAME
4268 \begin_layout Description
4269 Action Returns path and file name of the currently edited document.
4271 \begin_layout Description
4272 Syntax server-get-filename
4275 \begin_layout Subsection*
4276 LFUN_SERVER_GOTO_FILE_ROW
4278 \begin_layout Description
4279 Action Sets the cursor position based on the row number of generated TeX file.
4281 \begin_layout Description
4282 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).
4284 \begin_layout Description
4285 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4287 \begin_layout Description
4288 Params <FILE>: the filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
4289 \begin_inset Newline newline
4292 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g. for the case of generated .tex file). .ext: extensions will be automatically replaced by .lyx. <ROW_NUMBER> The row number of the LaTeX file to which to go.
4294 \begin_layout Description
4295 Origin Edmar, 23 Dec 1998
4298 \begin_layout Subsection*
4301 \begin_layout Description
4302 Action Sets the cursor position in the previewed (e.g. dvi) file based on the row number in LyX window.
4304 \begin_layout Description
4305 Notion The external program used for forward search call can be specified in
4307 forward_search_dvi and
4309 forward_search_pdf RC settings. By default, the value for pdf is empty, while for dvi it is
4310 \begin_inset Newline newline
4313 "xdvi -sourceposition $$n:$$t $$o"
4314 \begin_inset Newline newline
4317 The values replaced in the call: $$n for row number, $$t for exported temporary .tex file, $$o exported output file, either dvi or pdf, depending on which one exists in the temp dir (preferred is dvi).
4319 \begin_layout Description
4320 Syntax forward-search
4322 \begin_layout Description
4323 Origin sanda, 14 Apr 2010
4326 \begin_layout Subsection*
4329 \begin_layout Description
4330 Action Sends notify message about the last key-sequence to client.
4332 \begin_layout Description
4333 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4335 \begin_layout Description
4336 Syntax server-notify
4339 \begin_layout Subsection*
4342 \begin_layout Description
4343 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4345 \begin_layout Description
4346 Syntax server-set-xy <X> <Y>
4349 \begin_layout Subsection*
4352 \begin_layout Description
4353 Action Returns the coordinates of cursor position in the editing area.
4355 \begin_layout Description
4356 Syntax server-get-xy
4359 \begin_layout Subsection*
4362 \begin_layout Description
4363 Action Generates the code (literate programming).
4365 \begin_layout Description
4366 Notion Latex file with extension
4368 literate_extension is generated. Then LyX invokes
4370 build_command (with a default of``make'') to generate the code and
4372 build_error_filter to process the compilation error messages.
4373 \begin_inset Newline newline
4376 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:
4377 \begin_inset Newline newline
4382 build_command "my_script my_arguments"
4383 \begin_inset Newline newline
4388 build_error_filter differs from the
4390 literate_error_filter only in that the former will identify error messages from your compiler.
4392 \begin_layout Description
4393 Syntax build-program
4396 \begin_layout Subsection*
4397 LFUN_BUFFER_AUTO_SAVE
4399 \begin_layout Description
4400 Action Saves the current buffer to a temporary file.
4402 \begin_layout Description
4403 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4405 \begin_layout Description
4406 Syntax buffer-auto-save
4409 \begin_layout Subsection*
4410 LFUN_BUFFER_CHILD_OPEN
4412 \begin_layout Description
4413 Action Loads the given child document.
4415 \begin_layout Description
4416 Notion The current document is treated as a parent.
4418 \begin_layout Description
4419 Syntax buffer-child-open <FILE>
4421 \begin_layout Description
4422 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4424 \begin_layout Description
4425 Origin Ale, 28 May 1997
4428 \begin_layout Subsection*
4431 \begin_layout Description
4432 Action Runs chktex for the current document.
4434 \begin_layout Description
4435 Syntax buffer-chktex
4437 \begin_layout Description
4438 Origin Asger, 30 Oct 1997
4441 \begin_layout Subsection*
4442 LFUN_BUFFER_TOGGLE_COMPRESSION
4444 \begin_layout Description
4445 Action Toggles compression of the current document on/off.
4447 \begin_layout Description
4448 Syntax buffer-toggle-compression
4450 \begin_layout Description
4451 Origin bpeng, 27 Apr 2006
4454 \begin_layout Subsection*
4455 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
4457 \begin_layout Description
4458 Action Toggles including of resources for forward/reverse search of the given document.
4460 \begin_layout Description
4461 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
4463 \begin_layout Description
4464 Syntax buffer-toggle-output-sync
4466 \begin_layout Description
4467 Origin sanda, 25 May 2010
4470 \begin_layout Subsection*
4473 \begin_layout Description
4474 Action Closes the current buffer.
4476 \begin_layout Description
4477 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4479 \begin_layout Description
4483 \begin_layout Subsection*
4484 LFUN_BUFFER_CLOSE_ALL
4486 \begin_layout Description
4487 Action Closes all buffers.
4489 \begin_layout Description
4490 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4492 \begin_layout Description
4493 Syntax buffer-close-all
4496 \begin_layout Subsection*
4499 \begin_layout Description
4500 Action Exports the current buffer (document) to the given format.
4502 \begin_layout Description
4503 Syntax buffer-export <FORMAT>
4505 \begin_layout Description
4506 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.
4507 \begin_inset Newline newline
4510 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.
4512 \begin_layout Description
4513 Origin Lgb, 29 Jul 1997
4516 \begin_layout Subsection*
4517 LFUN_BUFFER_EXPORT_CUSTOM
4519 \begin_layout Description
4520 Action Exports the current buffer (document) from the given format using the given command on it.
4522 \begin_layout Description
4523 Syntax buffer-export-custom <FORMAT> <COMMAND>
4525 \begin_layout Description
4526 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4527 \begin_inset Newline newline
4530 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4532 \begin_layout Description
4533 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4535 \begin_layout Description
4536 Origin leeming, 27 Mar 2004
4539 \begin_layout Subsection*
4542 \begin_layout Description
4543 Action Prints the current document.
4545 \begin_layout Description
4546 Notion Many settings can be given via the preferences dialog.
4548 \begin_layout Description
4549 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4551 \begin_layout Description
4552 Params <TARGET> is either "printer" or "file".
4553 \begin_inset Newline newline
4556 <TARGER-NAME> is either "default" or file name or printer name.
4557 \begin_inset Newline newline
4560 <COMMAND> command ensuring the printing job.
4562 \begin_layout Description
4563 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4565 \begin_layout Description
4566 Origin leeming, 28 Mar 2004
4569 \begin_layout Subsection*
4572 \begin_layout Description
4573 Action Import a given file as a lyx document.
4575 \begin_layout Description
4576 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.
4578 \begin_layout Description
4579 Syntax buffer-import <FORMAT> [<FILE>]
4581 \begin_layout Description
4582 Origin Asger, 24 Jul 1998
4585 \begin_layout Subsection*
4588 \begin_layout Description
4589 Action Creates a new buffer (that is, document).
4591 \begin_layout Description
4592 Notion Implicit path can be set in Preferences dialog.
4594 \begin_layout Description
4595 Syntax buffer-new [<FILE>]
4597 \begin_layout Description
4598 Params <FILE>: filename of created file with absolute path.
4601 \begin_layout Subsection*
4602 LFUN_BUFFER_NEW_TEMPLATE
4604 \begin_layout Description
4605 Action Creates a new buffer (that is, document) from a template.
4607 \begin_layout Description
4608 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4610 \begin_layout Description
4611 Syntax buffer-new-template [<FILE>]
4613 \begin_layout Description
4614 Params <FILE>: filename of created file with absolute path.
4617 \begin_layout Subsection*
4620 \begin_layout Description
4621 Action Reverts opened document.
4623 \begin_layout Description
4624 Syntax buffer-reload
4626 \begin_layout Description
4627 Origin Asger, 2 Feb 1997
4630 \begin_layout Subsection*
4633 \begin_layout Description
4634 Action Display/switch to the given buffer.
4636 \begin_layout Description
4637 Syntax buffer-switch <BUFFER>
4639 \begin_layout Description
4640 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
4643 \begin_layout Subsection*
4644 LFUN_BUFFER_TOGGLE_READ_ONLY
4646 \begin_layout Description
4647 Action Toggle editing mode of the current document between read/write and read-only.
4649 \begin_layout Description
4650 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.
4652 \begin_layout Description
4653 Syntax buffer-toggle-read-only
4655 \begin_layout Description
4656 Origin Lgb, 27 May 1997
4659 \begin_layout Subsection*
4662 \begin_layout Description
4663 Action Displays current buffer in chosen format.
4665 \begin_layout Description
4666 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.
4668 \begin_layout Description
4669 Syntax buffer-view [<FORMAT>]
4671 \begin_layout Description
4672 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.
4675 \begin_layout Subsection*
4678 \begin_layout Description
4679 Action Exports the current document and put the result into the temporary directory.
4681 \begin_layout Description
4682 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).
4684 \begin_layout Description
4685 Syntax buffer-update [<FORMAT>]
4687 \begin_layout Description
4688 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.
4690 \begin_layout Description
4691 Origin Dekel, 5 Aug 2000
4694 \begin_layout Subsection*
4697 \begin_layout Description
4698 Action Saves the current buffer.
4700 \begin_layout Description
4701 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.
4703 \begin_layout Description
4707 \begin_layout Subsection*
4708 LFUN_BUFFER_WRITE_AS
4710 \begin_layout Description
4711 Action Rename and save current buffer.
4713 \begin_layout Description
4714 Syntax buffer-write-as <FILENAME>
4716 \begin_layout Description
4717 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4720 \begin_layout Subsection*
4721 LFUN_BUFFER_WRITE_ALL
4723 \begin_layout Description
4724 Action Save all changed documents.
4726 \begin_layout Description
4727 Syntax buffer-write-all
4729 \begin_layout Description
4730 Origin rgh, gpothier 6 Aug 2007
4733 \begin_layout Subsection*
4736 \begin_layout Description
4737 Action Switch to the next opened document.
4739 \begin_layout Description
4740 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4742 \begin_layout Description
4746 \begin_layout Subsection*
4747 LFUN_BUFFER_PREVIOUS
4749 \begin_layout Description
4750 Action Switch to the previous opened document.
4752 \begin_layout Description
4753 Syntax buffer-previous
4756 \begin_layout Subsection*
4757 LFUN_MASTER_BUFFER_UPDATE
4759 \begin_layout Description
4760 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4762 \begin_layout Description
4763 Syntax master-buffer-update [<FORMAT>]
4765 \begin_layout Description
4766 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.
4768 \begin_layout Description
4769 Origin Tommaso, 20 Sep 2007
4772 \begin_layout Subsection*
4773 LFUN_MASTER_BUFFER_VIEW
4775 \begin_layout Description
4776 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4778 \begin_layout Description
4779 Syntax master-buffer-view [<FORMAT>]
4781 \begin_layout Description
4782 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.
4784 \begin_layout Description
4785 Origin Tommaso, 20 Sep 2007
4788 \begin_layout Subsection*
4789 LFUN_BUFFER_LANGUAGE
4791 \begin_layout Description
4792 Action Set language of the current document.
4794 \begin_layout Description
4795 Syntax buffer-language <LANG>
4797 \begin_layout Description
4798 Params <LANG>: language name. See lib/languages for list.
4800 \begin_layout Description
4801 Origin leeming, 30 Mar 2004
4804 \begin_layout Subsection*
4805 LFUN_BUFFER_SAVE_AS_DEFAULT
4807 \begin_layout Description
4808 Action Save the current document settings as default.
4810 \begin_layout Description
4811 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4813 \begin_layout Description
4814 Syntax buffer-save-as-default [<ARGS>]
4816 \begin_layout Description
4817 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4819 \begin_layout Description
4820 Origin leeming, 30 Mar 2004
4823 \begin_layout Subsection*
4824 LFUN_BUFFER_PARAMS_APPLY
4826 \begin_layout Description
4827 Action Apply the given settings to the current document.
4829 \begin_layout Description
4830 Syntax buffer-params-apply [<ARGS>]
4832 \begin_layout Description
4833 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4835 \begin_layout Description
4836 Origin leeming, 30 Mar 2004
4839 \begin_layout Subsection*
4842 \begin_layout Description
4843 Action Inserts another LyX file.
4845 \begin_layout Description
4846 Syntax file-insert [<FILE>]
4848 \begin_layout Description
4849 Params <FILE>: Filename to be inserted.
4852 \begin_layout Subsection*
4853 LFUN_FILE_INSERT_PLAINTEXT
4855 \begin_layout Description
4856 Action Inserts plain text file.
4858 \begin_layout Description
4859 Syntax file-insert-plaintext [<FILE>]
4861 \begin_layout Description
4862 Params <FILE>: Filename to be inserted.
4864 \begin_layout Description
4865 Origin CFO-G, 19 Nov 1997
4868 \begin_layout Subsection*
4869 LFUN_FILE_INSERT_PLAINTEXT_PARA
4871 \begin_layout Description
4872 Action Inserts plain text file as paragraph (i.e. join lines).
4874 \begin_layout Description
4875 Syntax file-insert-plaintext-para [<FILE>]
4877 \begin_layout Description
4878 Params <FILE>: Filename to be inserted.
4880 \begin_layout Description
4881 Origin Levon, 14 Feb 2001
4884 \begin_layout Subsection*
4887 \begin_layout Description
4888 Action Open LyX document.
4890 \begin_layout Description
4891 Syntax file-open [<FILE>]
4893 \begin_layout Description
4894 Params <FILE>: Filename to be opened.
4897 \begin_layout Subsection*
4900 \begin_layout Description
4901 Action Executes a command defined in a .def file.
4903 \begin_layout Description
4904 Notion The definitions are by default read from lib/commands/default.def.
4905 \begin_inset Newline newline
4908 A .def file allows to define a command with
4910 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).
4912 def_file "FileName" allows to include another .def file.
4913 \begin_inset Newline newline
4916 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.
4918 \begin_layout Description
4921 \begin_layout Description
4922 Params <NAME>: Name of the command that must be called.
4924 \begin_layout Description
4925 Origin broider, 2 Oct 2007
4928 \begin_layout Subsection*
4931 \begin_layout Description
4932 Action Simulate halting Meta key (Alt key on PCs).
4934 \begin_layout Description
4935 Notion Used for buffer editation not for GUI control.
4937 \begin_layout Description
4941 \begin_layout Subsection*
4944 \begin_layout Description
4945 Action Cancels sequence prepared by LFUN_META_PREFIX .
4947 \begin_layout Description
4951 \begin_layout Subsection*
4952 LFUN_COMMAND_EXECUTE
4954 \begin_layout Description
4955 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
4957 \begin_layout Description
4958 Notion Usually bound to M-x shortcut.
4960 \begin_layout Description
4961 Syntax command-execute
4964 \begin_layout Subsection*
4967 \begin_layout Description
4968 Action Return the current key sequence and available options as a string.
4970 \begin_layout Description
4971 Notion No options are added if no current map exists.
4972 \begin_inset Newline newline
4975 This is probably usable only with connection to lyxserver.
4977 \begin_layout Description
4978 Syntax command-prefix
4981 \begin_layout Subsection*
4982 LFUN_COMMAND_SEQUENCE
4984 \begin_layout Description
4985 Action Run more commands (LFUN and its parameters) in a sequence.
4987 \begin_layout Description
4988 Syntax command-sequence <CMDS>
4990 \begin_layout Description
4991 Params <CMDS>: Sequence of commands separated by semicolons.
4993 \begin_layout Description
4994 Sample command-sequence cut; ert-insert; self-insert
4996 ; paste; self-insert {}; inset-toggle;
4998 \begin_layout Description
4999 Origin Andre, 11 Nov 1999
5002 \begin_layout Subsection*
5003 LFUN_COMMAND_ALTERNATIVES
5005 \begin_layout Description
5006 Action Runs the first listed command that is enabled.
5008 \begin_layout Description
5009 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
5011 \begin_layout Description
5012 Syntax command-alternatives <CMDS>
5014 \begin_layout Description
5015 Params <CMDS>: Sequence of commands separated by semicolons.
5017 \begin_layout Description
5018 Sample command-alternatives completion-accept;cell-forward
5020 \begin_layout Description
5021 Origin rgh, 24 September 2008
5024 \begin_layout Subsection*
5027 \begin_layout Description
5028 Action Shows message in statusbar (for script purposes).
5030 \begin_layout Description
5031 Syntax message <STRING>
5033 \begin_layout Description
5034 Origin Lgb, 8 Apr 2001
5037 \begin_layout Subsection*
5038 LFUN_DEBUG_LEVEL_SET
5040 \begin_layout Description
5041 Action Set debug output level.
5043 \begin_layout Description
5044 Syntax debug-level-set <LEVEL>
5046 \begin_layout Description
5047 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.
5049 \begin_layout Description
5050 Origin sanda, 28 Dec 2009
5053 \begin_layout Subsection*
5054 LFUN_PREFERENCES_SAVE
5056 \begin_layout Description
5057 Action Save user preferences.
5059 \begin_layout Description
5060 Syntax preferences-save
5062 \begin_layout Description
5063 Origin Lgb, 27 Nov 1999
5066 \begin_layout Subsection*
5069 \begin_layout Description
5070 Action Reconfigure the automatic settings.
5072 \begin_layout Description
5075 \begin_layout Description
5076 Origin Asger, 14 Feb 1997
5079 \begin_layout Subsection*
5082 \begin_layout Description
5083 Action Apply the given settings to user preferences.
5085 \begin_layout Description
5086 Syntax lyxrc-apply <SETTINGS>
5088 \begin_layout Description
5089 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.
5092 \begin_layout Subsection*
5093 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
5095 \begin_layout Description
5096 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
5098 \begin_layout Description
5099 Syntax toggle-cursor-follows-scrollbar
5101 \begin_layout Description
5102 Origin ARRae, 2 Dec 1997
5105 \begin_layout Subsection*
5108 \begin_layout Description
5109 Action Set the given LyX color to the color defined by the X11 name given.
5111 \begin_layout Description
5112 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5114 \begin_layout Description
5115 Syntax set-color <LYX_NAME> <X11_NAME>
5117 \begin_layout Description
5118 Origin SLior, 11 Jun 2000
5121 \begin_layout Subsection*
5124 \begin_layout Description
5125 Action Count the statistics (number of words and characters) in the document or in the given selection.
5127 \begin_layout Description
5128 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5130 \begin_layout Description
5133 \begin_layout Description
5134 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5137 \begin_layout Subsection*
5138 LFUN_COMPLETION_INLINE
5140 \begin_layout Description
5141 Action Show the inline completion at the cursor position.
5143 \begin_layout Description
5144 Syntax completion-inline
5146 \begin_layout Description
5147 Origin sts, Feb 19 2008
5150 \begin_layout Subsection*
5151 LFUN_COMPLETION_POPUP
5153 \begin_layout Description
5154 Action Show the completion popup at the cursor position.
5156 \begin_layout Description
5157 Syntax completion-popup
5159 \begin_layout Description
5160 Origin sts, Feb 19 2008
5163 \begin_layout Subsection*
5164 LFUN_COMPLETION_COMPLETE
5166 \begin_layout Description
5167 Action Try to complete the word or command at the cursor position.
5169 \begin_layout Description
5172 \begin_layout Description
5173 Origin sts, Feb 19 2008
5176 \begin_layout Subsection*
5177 LFUN_COMPLETION_CANCEL
5179 \begin_layout Description
5180 Action Try to cancel completion, either the popup or the inline completion.
5182 \begin_layout Description
5183 Syntax completion-cancel
5185 \begin_layout Description
5186 Origin sts, Sep 07 2008
5189 \begin_layout Subsection*
5190 LFUN_COMPLETION_ACCEPT
5192 \begin_layout Description
5193 Action Accept suggested completion.
5195 \begin_layout Description
5196 Syntax completion-accept
5198 \begin_layout Description
5199 Origin sanda, Sep 08 2008
5202 \begin_layout Subsection*
5205 \begin_layout Description
5206 Action Add a branch to the buffer's BranchList.
5208 \begin_layout Description
5209 Syntax branch-add <BRANCH>
5211 \begin_layout Description
5212 Params <BRANCH>: Name of the branch to add
5214 \begin_layout Description
5215 Origin spitz, 7 Jul 2009
5218 \begin_layout Subsection*
5219 LFUN_BRANCH_ACTIVATE
5221 \begin_layout Description
5222 Action Activate the branch.
5224 \begin_layout Description
5225 Syntax branch-activate <BRANCH>
5227 \begin_layout Description
5228 Params <BRANCH>: The branch to activate
5230 \begin_layout Description
5231 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5232 \begin_inset Newline newline
5235 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5237 \begin_layout Description
5238 Origin rgh, 27 May 2008
5241 \begin_layout Subsection*
5242 LFUN_BRANCH_DEACTIVATE
5244 \begin_layout Description
5245 Action De-activate the branch.
5247 \begin_layout Description
5248 Syntax branch-deactivate <BRANCH>
5250 \begin_layout Description
5251 Params <BRANCH>: The branch to deactivate
5253 \begin_layout Description
5254 Origin rgh, 27 May 2008
5257 \begin_layout Subsection*
5258 LFUN_BRANCHES_RENAME
5260 \begin_layout Description
5261 Action Rename all branches of a given name in a document.
5263 \begin_layout Description
5264 Syntax branches-rename <OLDNAME> <NEWNAME>
5266 \begin_layout Description
5267 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5269 \begin_layout Description
5270 Origin spitz, 9 Jul 2009
5273 \begin_layout Subsection*
5274 LFUN_BRANCH_ADD_INSERT
5276 \begin_layout Description
5277 Action Create new branch and directly put the branch inset into the document.
5279 \begin_layout Description
5280 Syntax branch-add-insert [<NAME>]
5282 \begin_layout Description
5283 Params <NAME>: Branch name. If it is not specified, you will be asked.
5285 \begin_layout Description
5286 Origin sanda, 10 Jul 2009
5289 \begin_layout Subsection*
5290 LFUN_LABEL_COPY_AS_REF
5292 \begin_layout Description
5293 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5295 \begin_layout Description
5296 Syntax copy-label-as-reference <LABEL>
5298 \begin_layout Description
5299 Params <LABEL>: The label to copy (for multi-line math)
5301 \begin_layout Description
5302 Origin sts, 16 Nov 2008
5305 \begin_layout Subsection*
5306 LFUN_LABEL_INSERT_AS_REF
5308 \begin_layout Description
5309 Action Inserts the label as a cross-reference at the position of the cursor.
5311 \begin_layout Description
5312 Syntax label-insert-as-reference
5314 \begin_layout Description
5315 Origin vfr, 7 Apr 2009
5318 \begin_layout Subsection*
5321 \begin_layout Description
5322 Action Increases the zoom of the screen fonts.
5324 \begin_layout Description
5325 Syntax buffer-zoom-in [<ZOOM>]
5327 \begin_layout Description
5328 Params <ZOOM>: The zoom in %, the default is 20.
5330 \begin_layout Description
5331 Origin vfr, 30 Mar 2009
5334 \begin_layout Subsection*
5335 LFUN_BUFFER_ZOOM_OUT
5337 \begin_layout Description
5338 Action Decreases the zoom of the screen fonts.
5340 \begin_layout Description
5341 Syntax buffer-zoom-out [<ZOOM>]
5343 \begin_layout Description
5344 Params <ZOOM>: The zoom in %, the default is 20.
5346 \begin_layout Description
5347 Origin vfr, 30 Mar 2009
5350 \begin_layout Subsection*
5353 \begin_layout Description
5354 Action Copies the inset to the clipboard as a certain type
5356 \begin_layout Description
5357 Syntax inset-copy-as [<TYPE>]
5359 \begin_layout Description
5360 Params <TYPE>: The type as which the inset is copied. This can vary from inset to inset.
5362 \begin_layout Description
5363 Sample InsetInfo is copied as text
5365 \begin_layout Description
5366 Origin vfr, 18 Apr 2010