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-12-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 Inserts a subscript or superscript inset.
701 \begin_layout Description
702 Syntax script-insert <TYPE>
704 \begin_layout Description
705 Params <TYPE>: subscript|superscript
707 \begin_layout Description
708 Origin Georg, 23 Nov 2010
711 \begin_layout Subsection*
714 \begin_layout Description
715 Action Start (or remove) Appendix on the given cursor position.
717 \begin_layout Description
720 \begin_layout Description
721 Origin ettrich, 5 May 1998
724 \begin_layout Subsection*
727 \begin_layout Description
728 Action Inserts Index entry.
730 \begin_layout Description
731 Notion It automatically takes the word on the cursor position.
733 \begin_layout Description
734 Syntax index-insert [<TYPE:Name>]
736 \begin_layout Description
737 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
739 \begin_layout Description
740 Origin leeming, 3 Aug 2000
743 \begin_layout Subsection*
746 \begin_layout Description
747 Action Inserts list of Index entries on a new page.
749 \begin_layout Description
750 Syntax index-print [<TYPE:Name>]
752 \begin_layout Description
753 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
755 \begin_layout Description
756 Origin Lgb, 27 Feb 1997
759 \begin_layout Subsection*
762 \begin_layout Description
763 Action Inserts Nomenclature entry.
765 \begin_layout Description
766 Notion It automatically takes the word on the cursor position if no symbol is given.
768 \begin_layout Description
769 Syntax nomencl-insert [<SYMBOL>]
771 \begin_layout Description
772 Origin Ugras, 4 Nov 2006
775 \begin_layout Subsection*
776 LFUN_NOMENCLATURE_PRINT
778 \begin_layout Description
779 Action Inserts list of Nomenclature entries.
781 \begin_layout Description
782 Syntax nomenclature-print
784 \begin_layout Description
785 Origin Ugras, 4 Nov 2006
788 \begin_layout Subsection*
791 \begin_layout Description
792 Action Inserts Note on the current cursor postion, move selection inside the inset.
794 \begin_layout Description
795 Syntax note-insert [<TYPE>]
797 \begin_layout Description
798 Params <TYPE>: <Note|Greyedout|Comment> default: Note
801 \begin_layout Subsection*
804 \begin_layout Description
805 Action Moves the cursor to the begining of next Note inset.
807 \begin_layout Description
811 \begin_layout Subsection*
814 \begin_layout Description
815 Action Inserts phantom on the current cursor postion, move selection inside the inset.
817 \begin_layout Description
818 Syntax phantom-insert [<TYPE>]
820 \begin_layout Description
821 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
823 \begin_layout Description
824 Origin uwestoehr, 30 Jan 2009
827 \begin_layout Subsection*
830 \begin_layout Description
831 Action Inserts a line break or new line.
833 \begin_layout Description
834 Syntax newline-insert [<ARG>]
836 \begin_layout Description
837 Params <ARG>: <newline|linebreak> default: newline
839 \begin_layout Description
840 Origin JSpitzm, 25 Mar 2008
843 \begin_layout Subsection*
846 \begin_layout Description
847 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
849 \begin_layout Description
852 \begin_layout Description
853 Origin Lgb, 17 May 2001
856 \begin_layout Subsection*
859 \begin_layout Description
860 Action Moves the cursor one line in downward direction.
862 \begin_layout Description
866 \begin_layout Subsection*
869 \begin_layout Description
870 Action Moves the cursor one line in upward direction.
872 \begin_layout Description
876 \begin_layout Subsection*
879 \begin_layout Description
880 Action Moves the cursor one line in downward direction adding the current position to the selection.
882 \begin_layout Description
886 \begin_layout Subsection*
889 \begin_layout Description
890 Action Moves the cursor one line in upward direction adding the current position to the selection.
892 \begin_layout Description
896 \begin_layout Subsection*
899 \begin_layout Description
900 Action Moves the cursor one page in downward direction.
902 \begin_layout Description
906 \begin_layout Subsection*
909 \begin_layout Description
910 Action Moves the cursor one page in upward direction.
912 \begin_layout Description
916 \begin_layout Subsection*
917 LFUN_SCREEN_DOWN_SELECT
919 \begin_layout Description
920 Action Moves the cursor one screen in downward direction adding the current position to the selection.
922 \begin_layout Description
923 Syntax screen-down-select
926 \begin_layout Subsection*
927 LFUN_SCREEN_UP_SELECT
929 \begin_layout Description
930 Action Moves the cursor one page in upward direction adding the current position to the selection.
932 \begin_layout Description
933 Syntax screen-up-select
936 \begin_layout Subsection*
939 \begin_layout Description
940 Action Scroll the buffer view.
942 \begin_layout Description
943 Notion Only scrolls the screen up or down; does not move the cursor.
945 \begin_layout Description
946 Syntax scroll <TYPE> <QUANTITY>
948 \begin_layout Description
949 Params <TYPE>: line|page
950 \begin_inset Newline newline
953 <QUANTITY>: up|down|<number>
955 \begin_layout Description
956 Origin Abdel, Dec 27 2007
959 \begin_layout Subsection*
962 \begin_layout Description
963 Action Recenters the screen on the current cursor position.
965 \begin_layout Description
966 Syntax screen-recenter
969 \begin_layout Subsection*
970 LFUN_SCREEN_SHOW_CURSOR
972 \begin_layout Description
973 Action Repositions the screen such that the cursor is visible.
975 \begin_layout Description
976 Syntax screen-show-cursor
978 \begin_layout Description
979 Origin vfr, 25 Mar 2009
982 \begin_layout Subsection*
985 \begin_layout Description
986 Action Moves the cursor one position logically backwards.
988 \begin_layout Description
989 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
991 \begin_layout Description
995 \begin_layout Subsection*
996 LFUN_CHAR_BACKWARD_SELECT
998 \begin_layout Description
999 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1001 \begin_layout Description
1002 Notion See also LFUN_CHAR_BACKWARD.
1004 \begin_layout Description
1005 Syntax char-backward-select
1008 \begin_layout Subsection*
1009 LFUN_CHAR_DELETE_BACKWARD
1011 \begin_layout Description
1012 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1014 \begin_layout Description
1015 Syntax char-delete-backward
1018 \begin_layout Subsection*
1019 LFUN_CHAR_DELETE_FORWARD
1021 \begin_layout Description
1022 Action Deletes one character in the backward direction (usually the "Delete" key).
1024 \begin_layout Description
1025 Syntax char-delete-forward
1028 \begin_layout Subsection*
1031 \begin_layout Description
1032 Action Moves the cursor one position logically forward.
1034 \begin_layout Description
1035 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
1037 \begin_layout Description
1041 \begin_layout Subsection*
1042 LFUN_CHAR_FORWARD_SELECT
1044 \begin_layout Description
1045 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1047 \begin_layout Description
1048 Notion See also LFUN_CHAR_FORWARD.
1050 \begin_layout Description
1051 Syntax char-forward-select
1054 \begin_layout Subsection*
1057 \begin_layout Description
1058 Action Moves the cursor one position "to the left".
1060 \begin_layout Description
1061 Notion This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
1063 \begin_layout Description
1067 \begin_layout Subsection*
1068 LFUN_CHAR_LEFT_SELECT
1070 \begin_layout Description
1071 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1073 \begin_layout Description
1074 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1076 \begin_layout Description
1077 Syntax char-left-select
1080 \begin_layout Subsection*
1083 \begin_layout Description
1084 Action Moves the cursor one position "to the right".
1086 \begin_layout Description
1087 Notion This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
1089 \begin_layout Description
1093 \begin_layout Subsection*
1094 LFUN_CHAR_RIGHT_SELECT
1096 \begin_layout Description
1097 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1099 \begin_layout Description
1100 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1102 \begin_layout Description
1103 Syntax char-right-select
1106 \begin_layout Subsection*
1109 \begin_layout Description
1110 Action Moves the cursor to the logically previous beginning of a word.
1112 \begin_layout Description
1113 Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
1115 \begin_layout Description
1116 Syntax word-backward
1119 \begin_layout Subsection*
1120 LFUN_WORD_BACKWARD_SELECT
1122 \begin_layout Description
1123 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1125 \begin_layout Description
1126 Notion See also LFUN_WORD_BACKWARD.
1128 \begin_layout Description
1129 Syntax word-backward-select
1132 \begin_layout Subsection*
1133 LFUN_WORD_DELETE_BACKWARD
1135 \begin_layout Description
1136 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1138 \begin_layout Description
1139 Syntax word-delete-backward
1142 \begin_layout Subsection*
1143 LFUN_WORD_DELETE_FORWARD
1145 \begin_layout Description
1146 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1148 \begin_layout Description
1149 Syntax word-delete-forward
1152 \begin_layout Subsection*
1153 LFUN_WORD_FIND_FORWARD
1155 \begin_layout Description
1156 Action Search for a given string in forward direction.
1158 \begin_layout Description
1159 Notion Case sensitive, match words. If no argument given, last search repeated.
1161 \begin_layout Description
1162 Syntax word-find-forward [<STRING>]
1164 \begin_layout Description
1165 Origin Etienne, 16 Feb 1998
1168 \begin_layout Subsection*
1169 LFUN_WORD_FIND_BACKWARD
1171 \begin_layout Description
1172 Action Search for a given string in backward direction.
1174 \begin_layout Description
1175 Notion Case sensitive, match words. If no argument given, last search repeated.
1177 \begin_layout Description
1178 Syntax word-find-backward [<STRING>]
1180 \begin_layout Description
1181 Origin Etienne, 20 Feb 1998
1184 \begin_layout Subsection*
1187 \begin_layout Description
1188 Action Search for next occurence of a string.
1190 \begin_layout Description
1191 Syntax word-find [<DATA>]
1193 \begin_layout Description
1194 Params <DATA>: data encoded from Find dialog (see lyx::find2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
1196 \begin_layout Description
1197 Origin Andre, Jan 7 2004
1200 \begin_layout Subsection*
1203 \begin_layout Description
1204 Action Replace a string in the document.
1206 \begin_layout Description
1207 Syntax word-replace [<DATA>]
1209 \begin_layout Description
1210 Params <DATA>: data is of the form "<replace>
1211 \begin_inset Newline newline
1215 \begin_inset Newline newline
1218 <casesensitive> <matchword> <all> <forward>"
1220 \begin_layout Description
1221 Origin Andre, Jan 7 2004
1224 \begin_layout Subsection*
1227 \begin_layout Description
1228 Action Search for next occurence of a pattern.
1230 \begin_layout Description
1231 Syntax word-findadv [<DATA>]
1233 \begin_layout Description
1234 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
1236 \begin_layout Description
1237 Origin Tommaso, Nov 15 2007
1240 \begin_layout Subsection*
1243 \begin_layout Description
1244 Action Moves the cursor to the logically next beginning of a word.
1246 \begin_layout Description
1247 Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
1249 \begin_layout Description
1253 \begin_layout Subsection*
1254 LFUN_WORD_FORWARD_SELECT
1256 \begin_layout Description
1257 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1259 \begin_layout Description
1260 Notion See also LFUN_WORD_FORWARD.
1262 \begin_layout Description
1263 Syntax word-forward-select
1266 \begin_layout Subsection*
1269 \begin_layout Description
1270 Action Moves the cursor to the next beginning of a word "on the left".
1272 \begin_layout Description
1273 Notion This is the action which should be taken when the (e.g., ctrl-) "left" key is pressed. Generally, it moves the cursor to the next beginning of a word on the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
1275 \begin_layout Description
1278 \begin_layout Description
1279 Origin dov, 28 Oct 2007
1282 \begin_layout Subsection*
1283 LFUN_WORD_LEFT_SELECT
1285 \begin_layout Description
1286 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1288 \begin_layout Description
1289 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1291 \begin_layout Description
1292 Syntax word-left-select
1294 \begin_layout Description
1295 Origin dov, 28 Oct 2007
1298 \begin_layout Subsection*
1301 \begin_layout Description
1302 Action Moves the cursor to the next beginning of a word "on the right".
1304 \begin_layout Description
1305 Notion This is the action which should be taken when the (e.g., ctrl-) "right" key is pressed. Generally, it moves the cursor to the next beginning of a word on the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
1307 \begin_layout Description
1310 \begin_layout Description
1311 Origin dov, 28 Oct 2007
1314 \begin_layout Subsection*
1315 LFUN_WORD_RIGHT_SELECT
1317 \begin_layout Description
1318 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1320 \begin_layout Description
1321 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1323 \begin_layout Description
1324 Syntax word-right-select
1326 \begin_layout Description
1327 Origin dov, 28 Oct 2007
1330 \begin_layout Subsection*
1333 \begin_layout Description
1334 Action Puts the word where the cursor stands into the selection.
1336 \begin_layout Description
1339 \begin_layout Description
1340 Origin Andre, 11 Sep 2002
1343 \begin_layout Subsection*
1344 LFUN_WORD_CAPITALIZE
1346 \begin_layout Description
1347 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1349 \begin_layout Description
1350 Syntax word-capitalize
1353 \begin_layout Subsection*
1356 \begin_layout Description
1357 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1359 \begin_layout Description
1363 \begin_layout Subsection*
1366 \begin_layout Description
1367 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1369 \begin_layout Description
1373 \begin_layout Subsection*
1376 \begin_layout Description
1377 Action Add the word under the cursor to the respective spell checker dictionary.
1379 \begin_layout Description
1380 Syntax spelling-add [<STRING>] [<LANG>]
1382 \begin_layout Description
1383 Params <WORD>: word to add <LANG>: language name (see file languages)
1385 \begin_layout Description
1386 Origin JSpitzm, 18 Jan 2010
1389 \begin_layout Subsection*
1390 LFUN_SPELLING_IGNORE
1392 \begin_layout Description
1393 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
1395 \begin_layout Description
1396 Syntax spelling-ignore [<WORD>] [<LANG>]
1398 \begin_layout Description
1399 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1401 \begin_layout Description
1402 Origin JSpitzm, 18 Jan 2010
1405 \begin_layout Subsection*
1406 LFUN_SPELLING_REMOVE
1408 \begin_layout Description
1409 Action Remove the word under the cursor from the respective spell checker dictionary.
1411 \begin_layout Description
1412 Syntax spelling-remove [<STRING>] [<LANG>]
1414 \begin_layout Description
1415 Params <WORD>: word to remove <LANG>: language name (see file languages)
1417 \begin_layout Description
1418 Origin SWitt, 28 July 2010
1421 \begin_layout Subsection*
1422 LFUN_THESAURUS_ENTRY
1424 \begin_layout Description
1425 Action Look up thesaurus entries with respect to the word under the cursor.
1427 \begin_layout Description
1428 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1430 \begin_layout Description
1431 Params <STRING>: word to look up <LANG>: language (see file languages)
1433 \begin_layout Description
1434 Origin Levon, 20 Jul 2001
1437 \begin_layout Subsection*
1440 \begin_layout Description
1441 Action Move the cursor to the beginning of the document.
1443 \begin_layout Description
1447 \begin_layout Subsection*
1448 LFUN_BUFFER_BEGIN_SELECT
1450 \begin_layout Description
1451 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1453 \begin_layout Description
1454 Syntax buffer-begin-select
1457 \begin_layout Subsection*
1460 \begin_layout Description
1461 Action Move the cursor to the end of the document.
1463 \begin_layout Description
1467 \begin_layout Subsection*
1468 LFUN_BUFFER_END_SELECT
1470 \begin_layout Description
1471 Action Move the cursor to the end of the document adding the traversed text to the selection.
1473 \begin_layout Description
1474 Syntax buffer-end-select
1477 \begin_layout Subsection*
1480 \begin_layout Description
1481 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise
1483 \begin_layout Description
1486 \begin_layout Description
1487 Origin lasgouttes, 16 Mar 2009
1490 \begin_layout Subsection*
1491 LFUN_INSET_BEGIN_SELECT
1493 \begin_layout Description
1494 Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection).
1496 \begin_layout Description
1497 Syntax inset-begin-select
1499 \begin_layout Description
1500 Origin lasgouttes, 16 Mar 2009
1503 \begin_layout Subsection*
1506 \begin_layout Description
1507 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise
1509 \begin_layout Description
1512 \begin_layout Description
1513 Origin lasgouttes, 16 Mar 2009
1516 \begin_layout Subsection*
1517 LFUN_INSET_END_SELECT
1519 \begin_layout Description
1520 Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection).
1522 \begin_layout Description
1523 Syntax inset-end-select
1525 \begin_layout Description
1526 Origin lasgouttes, 16 Mar 2009
1529 \begin_layout Subsection*
1530 LFUN_INSET_SELECT_ALL
1532 \begin_layout Description
1533 Action Selects all contents of an inset.
1535 \begin_layout Description
1536 Syntax inset-select-all
1538 \begin_layout Description
1539 Origin vfr, 22 Aug 2009
1542 \begin_layout Subsection*
1545 \begin_layout Description
1546 Action Selects the whole section.
1548 \begin_layout Description
1549 Notion The cursor should be in a section heading before calling this lfun.
1551 \begin_layout Description
1552 Syntax section-select
1554 \begin_layout Description
1555 Origin vfr, 05 May 2009
1558 \begin_layout Subsection*
1561 \begin_layout Description
1562 Action Move the cursor to the begining of the (screen) line.
1564 \begin_layout Description
1568 \begin_layout Subsection*
1569 LFUN_LINE_BEGIN_SELECT
1571 \begin_layout Description
1572 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1574 \begin_layout Description
1575 Syntax line-begin-select
1578 \begin_layout Subsection*
1581 \begin_layout Description
1582 Action Move the cursor to the end of the (screen) line.
1584 \begin_layout Description
1588 \begin_layout Subsection*
1589 LFUN_LINE_END_SELECT
1591 \begin_layout Description
1592 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1594 \begin_layout Description
1595 Syntax line-end-select
1598 \begin_layout Subsection*
1601 \begin_layout Description
1602 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1604 \begin_layout Description
1605 Syntax line-delete-forward
1608 \begin_layout Subsection*
1611 \begin_layout Description
1612 Action Copies to the clipboard the last edit.
1614 \begin_layout Description
1618 \begin_layout Subsection*
1621 \begin_layout Description
1622 Action Cuts to the clipboard.
1624 \begin_layout Description
1628 \begin_layout Subsection*
1631 \begin_layout Description
1632 Action Pastes material (text or picture) from the active clipboard.
1634 \begin_layout Description
1635 Syntax paste [<TYPE>|<NUM>]
1637 \begin_layout Description
1638 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1639 \begin_inset Newline newline
1642 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1645 \begin_layout Subsection*
1646 LFUN_CLIPBOARD_PASTE
1648 \begin_layout Description
1649 Action Pastes text from the active clipboard.
1651 \begin_layout Description
1652 Syntax clipboard-paste [<ARG>]
1654 \begin_layout Description
1655 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1657 \begin_layout Description
1658 Origin Georg, 10 Jul 2006
1661 \begin_layout Subsection*
1662 LFUN_PRIMARY_SELECTION_PASTE
1664 \begin_layout Description
1665 Action Pastes the currently text selected text.
1667 \begin_layout Description
1668 Notion Primary selection mechanism is linux-only thing.
1670 \begin_layout Description
1671 Syntax primary-selection-paste [<ARG>]
1673 \begin_layout Description
1674 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1677 \begin_layout Subsection*
1678 LFUN_SELECTION_PASTE
1680 \begin_layout Description
1681 Action Pastes the text in permanent selection.
1683 \begin_layout Description
1684 Syntax selection-paste
1687 \begin_layout Subsection*
1690 \begin_layout Description
1691 Action Undoes the last edit.
1693 \begin_layout Description
1697 \begin_layout Subsection*
1700 \begin_layout Description
1701 Action Redoes the last thing undone.
1703 \begin_layout Description
1707 \begin_layout Subsection*
1710 \begin_layout Description
1711 Action Repeat the given command.
1713 \begin_layout Description
1714 Syntax repeat <COUNT> <LFUN-COMMAND>
1716 \begin_layout Description
1717 Origin Andre, 27 Oct 2003
1720 \begin_layout Subsection*
1721 LFUN_CHARS_TRANSPOSE
1723 \begin_layout Description
1724 Action Transposes the character at the cursor with the one before it.
1726 \begin_layout Description
1727 Syntax chars-transpose
1729 \begin_layout Description
1730 Origin Lgb, 25 Apr 2001
1733 \begin_layout Subsection*
1734 LFUN_DEPTH_DECREMENT
1736 \begin_layout Description
1737 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1739 \begin_layout Description
1740 Syntax depth-decrement
1743 \begin_layout Subsection*
1744 LFUN_DEPTH_INCREMENT
1746 \begin_layout Description
1747 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1749 \begin_layout Description
1750 Syntax depth-increment
1753 \begin_layout Subsection*
1756 \begin_layout Description
1757 Action Toggles the bold font (selection-wise) using mathbf in math.
1759 \begin_layout Description
1763 \begin_layout Subsection*
1764 LFUN_FONT_BOLDSYMBOL
1766 \begin_layout Description
1767 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1769 \begin_layout Description
1770 Syntax font-boldsymbol
1773 \begin_layout Subsection*
1774 LFUN_FONT_TYPEWRITER
1776 \begin_layout Description
1777 Action Toggles the typewriter family font (selection-wise).
1779 \begin_layout Description
1780 Syntax font-typewriter
1783 \begin_layout Subsection*
1786 \begin_layout Description
1787 Action Toggles underline in the font (selection-wise).
1789 \begin_layout Description
1790 Syntax font-underline
1793 \begin_layout Subsection*
1796 \begin_layout Description
1797 Action Toggles double underline in the font (selection-wise).
1799 \begin_layout Description
1800 Syntax font-underunderline
1802 \begin_layout Description
1803 Origin sanda, 5 May 2009
1806 \begin_layout Subsection*
1809 \begin_layout Description
1810 Action Toggles wavy underline in the font (selection-wise).
1812 \begin_layout Description
1813 Syntax font-underwave
1815 \begin_layout Description
1816 Origin sanda, 5 May 2009
1819 \begin_layout Subsection*
1822 \begin_layout Description
1823 Action Toggles strikeout (strike-through) in the font (selection-wise).
1825 \begin_layout Description
1826 Syntax font-strikeout
1828 \begin_layout Description
1829 Origin sanda, 3 May 2009
1832 \begin_layout Subsection*
1835 \begin_layout Description
1836 Action Toggles the emphasis font style (selection-wise).
1838 \begin_layout Description
1842 \begin_layout Subsection*
1845 \begin_layout Description
1846 Action Toggles Noun text style font (selection-wise).
1848 \begin_layout Description
1852 \begin_layout Subsection*
1855 \begin_layout Description
1856 Action Toggles Roman family font (selection-wise).
1858 \begin_layout Description
1862 \begin_layout Subsection*
1865 \begin_layout Description
1866 Action Toggles Sans Serif family font (selection-wise).
1868 \begin_layout Description
1872 \begin_layout Subsection*
1875 \begin_layout Description
1876 Action Toggles Fraktur family font (math-mode, selection-wise).
1878 \begin_layout Description
1881 \begin_layout Description
1882 Origin vermeer, 10 Jan 2002
1885 \begin_layout Subsection*
1888 \begin_layout Description
1889 Action Toggles Italics font shape (math-mode, selection-wise).
1891 \begin_layout Description
1894 \begin_layout Description
1895 Origin vermeer, 10 Jan 2002
1898 \begin_layout Subsection*
1901 \begin_layout Description
1902 Action Reverts the settings of the font to the default values (selection-wise).
1904 \begin_layout Description
1908 \begin_layout Subsection*
1911 \begin_layout Description
1912 Action Sets font size according to lyx format string.
1914 \begin_layout Description
1915 Syntax font-size <SIZE>
1917 \begin_layout Description
1918 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1919 \begin_inset Newline newline
1922 largest|huge|giant|increase|decrease|default
1925 \begin_layout Subsection*
1926 LFUN_TEXTSTYLE_APPLY
1928 \begin_layout Description
1929 Action Toggle user-defined (=last-time used) text style.
1931 \begin_layout Description
1932 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1934 \begin_layout Description
1935 Syntax textstyle-apply
1937 \begin_layout Description
1938 Origin leeming, 12 Mar 2003
1941 \begin_layout Subsection*
1942 LFUN_TEXTSTYLE_UPDATE
1944 \begin_layout Description
1945 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1947 \begin_layout Description
1948 Syntax textstyle-update <FONT_INFO>
1950 \begin_layout Description
1951 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1952 \begin_inset Newline newline
1955 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1957 \begin_layout Description
1958 Origin leeming, 12 Mar 2003
1961 \begin_layout Subsection*
1962 LFUN_SCREEN_FONT_UPDATE
1964 \begin_layout Description
1965 Action Update fonts and its metrics.
1967 \begin_layout Description
1968 Notion Automatically called after zoom, dpi, font names, or norm change.
1970 \begin_layout Description
1971 Syntax screen-font-update
1973 \begin_layout Description
1974 Origin ARRae, 13 Aug 2000
1977 \begin_layout Subsection*
1980 \begin_layout Description
1981 Action Returns the info about the current font.
1983 \begin_layout Description
1987 \begin_layout Subsection*
1988 LFUN_CITATION_INSERT
1990 \begin_layout Description
1991 Action Inserts citation from loaded citation database.
1993 \begin_layout Description
1994 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1996 \begin_layout Description
1997 Params <KEY>: Citation (shortcut listed in available citations).
1998 \begin_inset Newline newline
2001 <TEXT_BEFORE>: text which should appear before citation.
2003 \begin_layout Description
2004 Origin AAS, 97-02-23
2007 \begin_layout Subsection*
2008 LFUN_BIBTEX_DATABASE_ADD
2010 \begin_layout Description
2011 Action Adds database, which will be used for bibtex citations.
2013 \begin_layout Description
2014 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2016 \begin_layout Description
2017 Syntax bibtex-database-add <DATABASE-NAME>
2019 \begin_layout Description
2020 Origin Ale, 30 May 1997
2023 \begin_layout Subsection*
2024 LFUN_BIBTEX_DATABASE_DEL
2026 \begin_layout Description
2027 Action Adds database, which will be used for bibtex citations.
2029 \begin_layout Description
2030 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2032 \begin_layout Description
2033 Syntax bibtex-database-del <DATABASE-NAME>
2035 \begin_layout Description
2036 Origin Ale, 30 May 1997
2039 \begin_layout Subsection*
2042 \begin_layout Description
2043 Action Sets the layout (that is, environment) for the current paragraph.
2045 \begin_layout Description
2046 Syntax layout <LAYOUT>
2048 \begin_layout Description
2049 Params <LAYOUT>: the layout to use
2052 \begin_layout Subsection*
2053 LFUN_LAYOUT_PARAGRAPH
2055 \begin_layout Description
2056 Action Launches the paragraph settings dialog.
2058 \begin_layout Description
2059 Syntax layout-paragraph
2062 \begin_layout Subsection*
2065 \begin_layout Description
2066 Action Launches the tabular settings dialog.
2068 \begin_layout Description
2069 Syntax layout-tabular
2071 \begin_layout Description
2072 Origin Jug, 31 Jul 2000
2075 \begin_layout Subsection*
2076 LFUN_DROP_LAYOUTS_CHOICE
2078 \begin_layout Description
2079 Action Displays list of layout choices.
2081 \begin_layout Description
2082 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
2084 \begin_layout Description
2085 Syntax drop-layouts-choice
2088 \begin_layout Subsection*
2089 LFUN_LAYOUT_MODULES_CLEAR
2091 \begin_layout Description
2092 Action Clears the module list.
2094 \begin_layout Description
2095 Notion Clears the list of included modules for the current buffer.
2097 \begin_layout Description
2098 Syntax layout-modules-clear
2100 \begin_layout Description
2101 Origin rgh, 25 August 2007
2104 \begin_layout Subsection*
2105 LFUN_LAYOUT_MODULE_ADD
2107 \begin_layout Description
2108 Action Adds a module.
2110 \begin_layout Description
2111 Notion Adds a module to the list of included modules for the current buffer.
2113 \begin_layout Description
2114 Syntax layout-module-add <MODULE>
2116 \begin_layout Description
2117 Params <MODULE>: the module to be added
2119 \begin_layout Description
2120 Origin rgh, 25 August 2007
2123 \begin_layout Subsection*
2126 \begin_layout Description
2127 Action Reloads layout information.
2129 \begin_layout Description
2130 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.
2132 \begin_layout Description
2133 Syntax layout-reload
2135 \begin_layout Description
2136 Origin rgh, 3 September 2007
2139 \begin_layout Subsection*
2140 LFUN_TEXTCLASS_APPLY
2142 \begin_layout Description
2143 Action Sets the text class for the current buffer.
2145 \begin_layout Description
2146 Syntax textclass-apply <TEXTCLASS>
2148 \begin_layout Description
2149 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2152 \begin_layout Subsection*
2155 \begin_layout Description
2156 Action Loads information for a textclass from disk.
2158 \begin_layout Description
2159 Syntax textclass-load <TEXTCLASS>
2161 \begin_layout Description
2162 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2165 \begin_layout Subsection*
2168 \begin_layout Description
2169 Action Disable selecting of text-region.
2171 \begin_layout Description
2175 \begin_layout Subsection*
2178 \begin_layout Description
2179 Action Enable selecting of text-region.
2181 \begin_layout Description
2182 Notion After enabling you can simply move arrow keys to get selected region.
2184 \begin_layout Description
2188 \begin_layout Subsection*
2191 \begin_layout Description
2192 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2194 \begin_layout Description
2197 \begin_layout Description
2198 Origin Andre, May 5 2006
2201 \begin_layout Subsection*
2204 \begin_layout Description
2205 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2207 \begin_layout Description
2208 Syntax math-delim [<LEFT>] [<RIGHT>]
2210 \begin_layout Description
2211 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.
2213 \begin_layout Description
2214 Sample math-delim { rangle
2216 \begin_layout Description
2217 Origin Alejandro, 18 Jun 1996
2220 \begin_layout Subsection*
2223 \begin_layout Description
2224 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2226 \begin_layout Description
2227 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2229 \begin_layout Description
2230 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2231 \begin_inset Newline newline
2234 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2236 \begin_layout Description
2237 Sample math-bigdelim "Bigl" "
2243 \begin_layout Description
2244 Origin Enrico & Georg, 7 May 2006
2247 \begin_layout Subsection*
2250 \begin_layout Description
2251 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2253 \begin_layout Description
2254 Syntax math-display [<ARG>]
2256 \begin_layout Description
2257 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2259 \begin_layout Description
2260 Origin Alejandro, 18 Jun 1996
2263 \begin_layout Subsection*
2266 \begin_layout Description
2267 Action Inserts math objects and symbols.
2269 \begin_layout Description
2270 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
2272 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
2274 frac{x}{y}" replaces "abc" with "
2276 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.
2278 \begin_layout Description
2279 Syntax math-insert <ARG>
2281 \begin_layout Description
2282 Params <ARG>: Symbol or LaTeX code to be inserted.
2285 \begin_layout Subsection*
2288 \begin_layout Description
2289 Action Enters subscript expression in math expression.
2291 \begin_layout Description
2292 Syntax math-subscript
2294 \begin_layout Description
2295 Origin vermeer, 12 Dec 2001
2298 \begin_layout Subsection*
2299 LFUN_MATH_SUPERSCRIPT
2301 \begin_layout Description
2302 Action Enters superscript expression in math expression.
2304 \begin_layout Description
2305 Syntax math-superscript
2307 \begin_layout Description
2308 Origin vermeer, 12 Dec 2001
2311 \begin_layout Subsection*
2314 \begin_layout Description
2315 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.
2317 \begin_layout Description
2318 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2320 \begin_layout Description
2321 Syntax math-limits [<STATE>]
2323 \begin_layout Description
2324 Params <STATE>: limits|nolimits
2327 \begin_layout Subsection*
2330 \begin_layout Description
2331 Action Inserts a math macro definition at the cursor position in the text.
2333 \begin_layout Description
2334 Syntax math-macro <NAME> [<NARGS>] [def]
2336 \begin_layout Description
2337 Params <NAME>: The name of the macro, e.g. "mymacro".
2338 \begin_inset Newline newline
2341 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2343 \begin_layout Description
2344 Origin ale, 10 May 1997; sts, 21 Dec 2007
2347 \begin_layout Subsection*
2350 \begin_layout Description
2351 Action Mutates the type of math inset to the newly selected one.
2353 \begin_layout Description
2354 Syntax math-mutate <TYPE>
2356 \begin_layout Description
2357 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2359 \begin_layout Description
2360 Origin Andre, 23 May 2001
2363 \begin_layout Subsection*
2366 \begin_layout Description
2367 Action Inserts space into math expression.
2369 \begin_layout Description
2370 Notion Use spacebar after entering this space to change type of space.
2372 \begin_layout Description
2373 Syntax math-space [<TYPE>] [<LEN>]
2375 \begin_layout Description
2376 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2377 \begin_inset Newline newline
2380 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2381 \begin_inset Newline newline
2384 custom space: hspace
2385 \begin_inset Newline newline
2388 "," used by default.
2389 \begin_inset Newline newline
2392 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2393 \begin_inset Newline newline
2396 <LEN>: length for custom spaces (hspace)
2398 \begin_layout Description
2399 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2402 \begin_layout Subsection*
2405 \begin_layout Description
2406 Action Inserts a matrix.
2408 \begin_layout Description
2409 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2411 \begin_layout Description
2412 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).
2414 \begin_layout Description
2415 Sample math-matrix 3 3 bccc
2418 \begin_layout Subsection*
2419 LFUN_MATH_AMS_MATRIX
2421 \begin_layout Description
2422 Action Inserts a matrix.
2424 \begin_layout Description
2425 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
2427 \begin_layout Description
2428 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
2430 \begin_layout Description
2431 Sample math-ams-matrix 3 3 bmatrix
2434 \begin_layout Subsection*
2437 \begin_layout Description
2438 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.
2440 \begin_layout Description
2441 Notion If there is some selected text, it puts the text inside created math box.
2443 \begin_layout Description
2444 Syntax math-mode [on|<ARG>]
2446 \begin_layout Description
2447 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2448 \begin_inset Newline newline
2451 "on": allow only entering of math mode from text mode.
2453 \begin_layout Description
2454 Origin Alejandro, 4 Jun 1996
2457 \begin_layout Subsection*
2460 \begin_layout Description
2461 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2463 \begin_layout Description
2464 Notion If there is any selected text, then it is moved inside the created regexp inset.
2466 \begin_layout Description
2467 Syntax regexp-mode [<ARG>]
2469 \begin_layout Description
2470 Params <ARG>: eventual argument (regular expression).
2472 \begin_layout Description
2473 Origin Tommaso, 4 Oct 2008
2476 \begin_layout Subsection*
2477 LFUN_MATH_NUMBER_LINE_TOGGLE
2479 \begin_layout Description
2480 Action Toggles numbering of the current formula line.
2482 \begin_layout Description
2483 Notion Must be in display formula mode.
2485 \begin_layout Description
2486 Syntax math-number-line-toggle
2488 \begin_layout Description
2489 Origin Alejandro, 18 Jun 1996
2492 \begin_layout Subsection*
2493 LFUN_MATH_NUMBER_TOGGLE
2495 \begin_layout Description
2496 Action Toggles numbering/labeling of the current formula.
2498 \begin_layout Description
2499 Notion Must be in display formula mode.
2501 \begin_layout Description
2502 Syntax math-number-toggle
2504 \begin_layout Description
2505 Origin Alejandro, 4 Jun 1996
2508 \begin_layout Subsection*
2511 \begin_layout Description
2512 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2514 \begin_layout Description
2515 Notion Selection can be used to determine the input for the external program.
2517 \begin_layout Description
2518 Syntax math-extern <LANG> [<COMMAND>]
2520 \begin_layout Description
2521 Params <LANG>: octave|maxima|maple|mathematica|script
2522 \begin_inset Newline newline
2525 where "script" stands fot the external script (normalized expression will be passed)
2527 \begin_layout Description
2528 Sample math-extern maple simplify
2530 \begin_layout Description
2531 Origin Andre, 24 Apr 2001
2534 \begin_layout Subsection*
2537 \begin_layout Description
2538 Action Changes arbitrarily the size used by math fonts inside a context.
2540 \begin_layout Description
2541 Notion Provides an interface to the LaTeX math mode font size commands.
2543 \begin_layout Description
2544 Syntax math-size <STYLE>
2546 \begin_layout Description
2557 \begin_layout Description
2558 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2561 \begin_layout Subsection*
2562 LFUN_MATH_FONT_STYLE
2564 \begin_layout Description
2565 Action Changes the text style used in math.
2567 \begin_layout Description
2568 Syntax math-font-style <STYLE>
2570 \begin_layout Description
2571 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
2572 \begin_inset Newline newline
2575 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
2577 \begin_layout Description
2578 Origin vfr, 9 jan 2009
2581 \begin_layout Subsection*
2582 LFUN_MATH_MACRO_UNFOLD
2584 \begin_layout Description
2585 Action Unfold a Math Macro.
2587 \begin_layout Description
2588 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2592 \begin_layout Description
2593 Syntax math-macro-unfold
2595 \begin_layout Description
2596 Origin sts, 06 January 2008
2599 \begin_layout Subsection*
2600 LFUN_MATH_MACRO_FOLD
2602 \begin_layout Description
2603 Action Fold a Math Macro.
2605 \begin_layout Description
2606 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2610 \begin_layout Description
2611 Syntax math-macro-fold
2613 \begin_layout Description
2614 Origin sts, 06 January 2008
2617 \begin_layout Subsection*
2618 LFUN_MATH_MACRO_ADD_PARAM
2620 \begin_layout Description
2621 Action Add a parameter.
2623 \begin_layout Description
2624 Notion Add a parameter to a Math Macro.
2626 \begin_layout Description
2627 Syntax math-macro-add-param <NUM>
2629 \begin_layout Description
2630 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.
2632 \begin_layout Description
2633 Origin sts, 06 January 2008
2636 \begin_layout Subsection*
2637 LFUN_MATH_MACRO_REMOVE_PARAM
2639 \begin_layout Description
2640 Action Remove the last parameter.
2642 \begin_layout Description
2643 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2645 \begin_layout Description
2646 Syntax math-macro-remove-param <NUM>
2648 \begin_layout Description
2649 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2651 \begin_layout Description
2652 Origin sts, 06 January 2008
2655 \begin_layout Subsection*
2656 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2658 \begin_layout Description
2659 Action Append a greedy parameter.
2661 \begin_layout Description
2662 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2664 \begin_layout Description
2665 Syntax math-macro-append-greedy-param
2667 \begin_layout Description
2668 Origin sts, 06 January 2008
2671 \begin_layout Subsection*
2672 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2674 \begin_layout Description
2675 Action Remove a greedy parameter.
2677 \begin_layout Description
2678 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.
2680 \begin_layout Description
2681 Syntax math-macro-remove-greedy-param
2683 \begin_layout Description
2684 Origin sts, 06 January 2008
2687 \begin_layout Subsection*
2688 LFUN_MATH_MACRO_MAKE_OPTIONAL
2690 \begin_layout Description
2691 Action Make a parameter optional.
2693 \begin_layout Description
2694 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2696 \begin_layout Description
2697 Syntax math-macro-make-optional
2699 \begin_layout Description
2700 Origin sts, 06 January 2008
2703 \begin_layout Subsection*
2704 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2706 \begin_layout Description
2707 Action Make a parameter non-optional.
2709 \begin_layout Description
2710 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.
2712 \begin_layout Description
2713 Syntax math-macro-make-nonoptional
2715 \begin_layout Description
2716 Origin sts, 06 January 2008
2719 \begin_layout Subsection*
2720 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2722 \begin_layout Description
2723 Action Add an optional parameter.
2725 \begin_layout Description
2726 Notion Insert an optional parameter just behind the already existing optional parameters.
2728 \begin_layout Description
2729 Syntax math-macro-add-optional-param
2731 \begin_layout Description
2732 Origin sts, 06 January 2008
2735 \begin_layout Subsection*
2736 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2738 \begin_layout Description
2739 Action Remove the last optional parameter.
2741 \begin_layout Description
2742 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2744 \begin_layout Description
2745 Syntax math-macro-remove-optional-param
2747 \begin_layout Description
2748 Origin sts, 06 January 2008
2751 \begin_layout Subsection*
2752 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2754 \begin_layout Description
2755 Action Add a greedy optional parameter.
2757 \begin_layout Description
2758 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2760 \begin_layout Description
2761 Syntax math-macro-add-greedy-optional-param
2763 \begin_layout Description
2764 Origin sts, 06 January 2008
2767 \begin_layout Subsection*
2768 LFUN_IN_MATHMACROTEMPLATE
2770 \begin_layout Description
2771 Action Only active in Math Macro definition.
2773 \begin_layout Description
2774 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.
2776 \begin_layout Description
2777 Syntax in-mathmacrotemplate
2779 \begin_layout Description
2780 Origin sts, 06 January 2008
2783 \begin_layout Subsection*
2784 LFUN_PARAGRAPH_MOVE_DOWN
2786 \begin_layout Description
2787 Action Moves the current paragraph downwards in the document.
2789 \begin_layout Description
2790 Syntax paragraph-move-down
2792 \begin_layout Description
2793 Origin Edwin, 8 Apr 2006
2796 \begin_layout Subsection*
2797 LFUN_PARAGRAPH_MOVE_UP
2799 \begin_layout Description
2800 Action Moves the current paragraph upwards in the document.
2802 \begin_layout Description
2803 Syntax paragraph-move-up
2805 \begin_layout Description
2806 Origin Edwin, 8 Apr 2006
2809 \begin_layout Subsection*
2812 \begin_layout Description
2813 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2815 \begin_layout Description
2818 \begin_layout Description
2819 Origin Asger, 1 Oct 1996
2822 \begin_layout Subsection*
2823 LFUN_PARAGRAPH_UP_SELECT
2825 \begin_layout Description
2826 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2828 \begin_layout Description
2829 Syntax paragraph-up-select
2831 \begin_layout Description
2832 Origin Asger, 1 Oct 1996
2835 \begin_layout Subsection*
2838 \begin_layout Description
2839 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2841 \begin_layout Description
2842 Syntax paragraph-down
2844 \begin_layout Description
2845 Origin Asger, 1 Oct 1996
2848 \begin_layout Subsection*
2849 LFUN_PARAGRAPH_DOWN_SELECT
2851 \begin_layout Description
2852 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2854 \begin_layout Description
2855 Syntax paragraph-down-select
2857 \begin_layout Description
2858 Origin Asger, 1 Oct 1996
2861 \begin_layout Subsection*
2864 \begin_layout Description
2865 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2867 \begin_layout Description
2868 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).
2870 \begin_layout Description
2871 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2873 \begin_layout Description
2874 Params <PAR_ID_NUMBER>: paragraph id
2875 \begin_inset Newline newline
2878 <POSITION_IN_PAR>: desired position within the paragraph
2880 \begin_layout Description
2881 Origin Dekel, 26 Aug 2000
2884 \begin_layout Subsection*
2885 LFUN_BREAK_PARAGRAPH
2887 \begin_layout Description
2888 Action Breaks the current paragraph at the current location.
2890 \begin_layout Description
2891 Notion Removes the selection.
2893 \begin_layout Description
2894 Syntax break-paragraph [<LAYOUT>]
2896 \begin_layout Description
2897 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2900 \begin_layout Subsection*
2901 LFUN_PARAGRAPH_PARAMS
2903 \begin_layout Description
2904 Action Change paragraph settings.
2906 \begin_layout Description
2907 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.
2909 \begin_layout Description
2910 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2912 \begin_layout Description
2922 \begin_inset Newline newline
2927 paragraph_spacing default|single|onehalf|double|other SIZE
2928 \begin_inset Newline newline
2933 align block|left|right|center|default
2934 \begin_inset Newline newline
2939 labelwidthstring WIDTH|
2943 \begin_layout Description
2944 Origin rgh, Aug 15 2007
2947 \begin_layout Subsection*
2948 LFUN_PARAGRAPH_PARAMS_APPLY
2950 \begin_layout Description
2951 Action Change paragraph settings.
2953 \begin_layout Description
2954 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2956 \begin_layout Description
2957 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2959 \begin_layout Description
2960 Params For parameters see LFUN_PARAGRAPH_PARAMS
2962 \begin_layout Description
2963 Origin leeming, 30 Mar 2004
2966 \begin_layout Subsection*
2967 LFUN_PARAGRAPH_UPDATE
2969 \begin_layout Description
2970 Action Updates the values inside the paragraph dialog from the paragraph.
2972 \begin_layout Description
2973 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2975 \begin_layout Description
2976 Origin leeming, 13 Mar 2003
2979 \begin_layout Subsection*
2982 \begin_layout Description
2983 Action Move the current group in the upward direction in the structure of the document.
2985 \begin_layout Description
2986 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2988 \begin_layout Description
2991 \begin_layout Description
2992 Origin Vermeer, 23 Mar 2006
2995 \begin_layout Subsection*
2998 \begin_layout Description
2999 Action Move the current group in the downward direction in the structure of the document.
3001 \begin_layout Description
3002 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
3004 \begin_layout Description
3007 \begin_layout Description
3008 Origin Vermeer, 23 Mar 2006
3011 \begin_layout Subsection*
3014 \begin_layout Description
3015 Action Moves the current group in the downward direction in the hierarchy of the document structure.
3017 \begin_layout Description
3018 Notion Part -> Chapter -> Section -> etc.
3020 \begin_layout Description
3023 \begin_layout Description
3024 Origin Vermeer, 23 Mar 2006
3027 \begin_layout Subsection*
3030 \begin_layout Description
3031 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3033 \begin_layout Description
3034 Notion Part <- Chapter <- Section <- etc.
3036 \begin_layout Description
3039 \begin_layout Description
3040 Origin Vermeer, 23 Mar 2006
3043 \begin_layout Subsection*
3046 \begin_layout Description
3047 Action Edit the inset at cursor with an external application, if one is attributed.
3049 \begin_layout Description
3050 Syntax inset-edit [<INSET_PARAMS>]
3052 \begin_layout Description
3053 Params <INSET_PARAMS>: Parameters for the inset.
3054 \begin_inset Newline newline
3057 Currently only the filename will be considered.
3059 \begin_layout Description
3060 Origin JSpitzm, 27 Apr 2006
3063 \begin_layout Subsection*
3066 \begin_layout Description
3067 Action Inserts table into the document.
3069 \begin_layout Description
3070 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
3072 \begin_layout Description
3073 Syntax tabular-insert [<ROWS> <COLUMNS>]
3075 \begin_layout Description
3076 Params In case no arguments are given show insert dialog.
3078 \begin_layout Description
3079 Origin Jug, 12 Apr 2000
3082 \begin_layout Subsection*
3085 \begin_layout Description
3086 Action Moves the cursor to the previous cell inside the table.
3088 \begin_layout Description
3089 Syntax cell-backward
3091 \begin_layout Description
3092 Origin Jug, 22 May 2000
3095 \begin_layout Subsection*
3098 \begin_layout Description
3099 Action Moves the cursor to the next cell inside the table.
3101 \begin_layout Description
3105 \begin_layout Subsection*
3108 \begin_layout Description
3109 Action Splits cell and shifts right part to the next cell (inside the math grid).
3111 \begin_layout Description
3114 \begin_layout Description
3115 Origin Ale, 15 May 1997
3118 \begin_layout Subsection*
3121 \begin_layout Description
3122 Action Register the document as an file inside version control system.
3124 \begin_layout Description
3125 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3126 \begin_inset Newline newline
3129 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3131 \begin_layout Description
3134 \begin_layout Description
3135 Origin Lgb, 1 Jul 1997
3138 \begin_layout Subsection*
3141 \begin_layout Description
3142 Action Checks-in/commits the changes of the registered file to the repository.
3144 \begin_layout Description
3145 Notion In RCS case this also unlocks the file.
3147 \begin_layout Description
3150 \begin_layout Description
3151 Origin Lgb, 1 Jul 1997
3154 \begin_layout Subsection*
3157 \begin_layout Description
3158 Action Checks-out the document for edit (and locks it in some cases).
3160 \begin_layout Description
3163 \begin_layout Description
3164 Origin Lgb, 1 Jul 1997
3167 \begin_layout Subsection*
3170 \begin_layout Description
3171 Action Reverts the document to the last check-in/commit in VCS.
3173 \begin_layout Description
3176 \begin_layout Description
3177 Origin Lgb, 1 Jul 1997
3180 \begin_layout Subsection*
3183 \begin_layout Description
3184 Action Undo last check-in.
3186 \begin_layout Description
3187 Notion This is currently implemented only for RCS.
3189 \begin_layout Description
3192 \begin_layout Description
3193 Origin Lgb, 1 Jul 1997
3196 \begin_layout Subsection*
3199 \begin_layout Description
3200 Action Executes external command. This command is intended to support additional VCS commands.
3202 \begin_layout Description
3203 Syntax vc-command <FLAG> <PATH> <COMMAND>
3205 \begin_layout Description
3206 Params <FLAG>: Flags for the command can be combined together.
3207 \begin_inset Newline newline
3210 U - dUmmy - no flags
3211 \begin_inset Newline newline
3214 D - Doc - need document loaded to proceed
3215 \begin_inset Newline newline
3218 I - dIrty - mark document dirty
3219 \begin_inset Newline newline
3222 R - Reload - ensure that the document is saved and reload it after command execution
3223 \begin_inset Newline newline
3226 M - Message - ask for input string (commit message)
3227 \begin_inset Newline newline
3230 <PATH>: path where to start. $$p will be replaced by the current document path.
3231 \begin_inset Newline newline
3234 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
3236 \begin_layout Description
3237 Sample vc-command DR $$p "svn up"
3239 \begin_layout Description
3240 Origin sanda, 13 Jan 2009
3243 \begin_layout Subsection*
3244 LFUN_VC_LOCKING_TOGGLE
3246 \begin_layout Description
3247 Action Toggles the locking property of the edited file.
3249 \begin_layout Description
3250 Notion This is currently implemented only for SVN.
3252 \begin_layout Description
3253 Syntax vc-locking-toggle
3255 \begin_layout Description
3256 Origin sanda, 25 Jun 2009
3259 \begin_layout Subsection*
3262 \begin_layout Description
3263 Action Update the local archive directory in which resides the current document with the remote repository.
3265 \begin_layout Description
3266 Syntax vc-repo-update
3268 \begin_layout Description
3269 Origin sanda, 16 Oct 2009
3272 \begin_layout Subsection*
3275 \begin_layout Description
3276 Action Compares two revisions of the same file under version control.
3278 \begin_layout Description
3279 Syntax vc-compare [<REV1>] [<REV2>]
3281 \begin_layout Description
3282 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
3283 \begin_inset Newline newline
3286 In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
3287 \begin_inset Newline newline
3291 \begin_inset Newline newline
3294 <REV2>: Newer file. Used only if REV1 > 0.
3295 \begin_inset Newline newline
3298 If no parameter is given, interactive dialog will be shown.
3300 \begin_layout Description
3301 Sample Compare current document against last commit
3302 \begin_inset Newline newline
3306 \begin_inset Newline newline
3309 Compare current document against current revision - 5 commits
3310 \begin_inset Newline newline
3314 \begin_inset Newline newline
3317 Compare revisions 120 and 155
3318 \begin_inset Newline newline
3323 \begin_layout Description
3324 Origin sanda, 12 Feb 2010
3327 \begin_layout Subsection*
3330 \begin_layout Description
3331 Action Toggles change tracking to on/off.
3333 \begin_layout Description
3334 Syntax changes-track
3336 \begin_layout Description
3337 Origin levon, 1 Oct 2002
3340 \begin_layout Subsection*
3343 \begin_layout Description
3344 Action Toggles showing of change tracking in typesetted output.
3346 \begin_layout Description
3347 Syntax changes-output
3349 \begin_layout Description
3350 Origin jspitzm, 21 Jan 2005
3353 \begin_layout Subsection*
3356 \begin_layout Description
3357 Action Moves the cursor to the position of the next change of the change tracking records.
3359 \begin_layout Description
3362 \begin_layout Description
3363 Origin schmitt, 4 Oct 2006
3366 \begin_layout Subsection*
3367 LFUN_CHANGE_PREVIOUS
3369 \begin_layout Description
3370 Action Moves the cursor to the position of the previous change of the change tracking records.
3372 \begin_layout Description
3373 Syntax change-previous
3375 \begin_layout Description
3376 Origin vfr, 4 Apr 2009
3379 \begin_layout Subsection*
3382 \begin_layout Description
3383 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3385 \begin_layout Description
3386 Syntax changes-merge
3388 \begin_layout Description
3389 Origin Levon, 16 Oct 2002
3392 \begin_layout Subsection*
3395 \begin_layout Description
3396 Action Accepts tracked change inside the selection.
3398 \begin_layout Description
3399 Syntax change-accept
3401 \begin_layout Description
3402 Origin Levon, 16 Oct 2002
3405 \begin_layout Subsection*
3408 \begin_layout Description
3409 Action Rejects tracked change inside the selection.
3411 \begin_layout Description
3412 Syntax change-accept
3414 \begin_layout Description
3415 Origin Levon, 16 Oct 2002
3418 \begin_layout Subsection*
3419 LFUN_ALL_CHANGES_ACCEPT
3421 \begin_layout Description
3422 Action Accepts all tracked changes in the document.
3424 \begin_layout Description
3425 Syntax all-changes-accept
3427 \begin_layout Description
3428 Origin Levon, 16 Oct 2002
3431 \begin_layout Subsection*
3432 LFUN_ALL_CHANGES_REJECT
3434 \begin_layout Description
3435 Action Rejects all tracked changes in the document.
3437 \begin_layout Description
3438 Notion Reject does not work recursively; the user may have to repeat the operation.
3440 \begin_layout Description
3441 Syntax all-changes-reject
3443 \begin_layout Description
3444 Origin Levon, 16 Oct 2002
3447 \begin_layout Subsection*
3450 \begin_layout Description
3451 Action Apply data for an inset.
3453 \begin_layout Description
3454 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.
3456 \begin_layout Description
3457 Syntax inset-apply <ARGS>
3459 \begin_layout Description
3460 Params See LFUN_INSET_INSERT .
3463 \begin_layout Subsection*
3466 \begin_layout Description
3467 Action Dissolve the current inset into text.
3469 \begin_layout Description
3470 Syntax inset-dissolve [<INSET>]
3472 \begin_layout Description
3473 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.
3474 \begin_inset Newline newline
3477 For values see lyx::InsetLayout::lyxtype_ .
3479 \begin_layout Description
3480 Origin JSpitz, 7 Aug 2006
3483 \begin_layout Subsection*
3486 \begin_layout Description
3487 Action Insert new inset (type given by the parameters).
3489 \begin_layout Description
3490 Syntax inset-insert <INSET> <ARGS>
3492 \begin_layout Description
3493 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular|
3494 \begin_inset Newline newline
3497 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
3498 \begin_inset Newline newline
3501 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3503 \begin_layout Description
3504 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3507 \begin_inset Newline newline
3510 where <label name> is the name of the referenced label and <Format> is one of the following:
3511 \begin_inset Newline newline
3515 \begin_inset Newline newline
3518 eqref -- (<reference>)
3519 \begin_inset Newline newline
3523 \begin_inset Newline newline
3526 vpageref -- on <page>
3527 \begin_inset Newline newline
3530 vref -- <reference> on <page>
3531 \begin_inset Newline newline
3534 formatted -- Formatted reference
3537 \begin_layout Subsection*
3540 \begin_layout Description
3541 Action Modify some properties of an inset.
3543 \begin_layout Description
3544 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.
3546 \begin_layout Description
3547 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
3549 \begin_layout Description
3550 Params Generally see LFUN_INSET_INSERT for further details.
3551 \begin_inset Newline newline
3554 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.
3555 \begin_inset Newline newline
3558 <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
3559 \begin_inset Newline newline
3562 <ARG>: additional argument for some commands, use debug mode to explore its values.
3564 \begin_layout Description
3565 Sample inset-modify note Note Comment
3566 \begin_inset Newline newline
3569 inset-modify changetype Ovalbox
3572 \begin_layout Subsection*
3573 LFUN_INSET_DIALOG_UPDATE
3575 \begin_layout Description
3576 Action Updates the values inside the dialog from the inset.
3578 \begin_layout Description
3579 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3581 \begin_layout Description
3582 Params <DIALOG-NAME>
3584 \begin_layout Description
3585 Origin leeming, 25 Feb 2003
3588 \begin_layout Subsection*
3591 \begin_layout Description
3592 Action Open the inset's properties dialog.
3594 \begin_layout Description
3595 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.
3597 \begin_layout Description
3598 Syntax inset-settings <INSET>
3600 \begin_layout Description
3601 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
3602 \begin_inset Newline newline
3605 graphics|href|include|index|index_print|label|line| listings|note|phantom|ref|space|tabular|vspace|wrap>.
3608 \begin_layout Subsection*
3611 \begin_layout Description
3612 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3614 \begin_layout Description
3615 Syntax inset-toggle [<ARG>]
3617 \begin_layout Description
3618 Params <ARG>: <open|close|toggle|assign>.
3619 \begin_inset Newline newline
3622 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3623 \begin_inset Newline newline
3626 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3628 \begin_layout Description
3629 Origin lasgouttes, 19 Jul 2001
3632 \begin_layout Subsection*
3635 \begin_layout Description
3636 Action Apply the given commands on insets of a given name.
3638 \begin_layout Description
3639 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.
3641 \begin_layout Description
3642 Syntax inset-forall <NAME> <LFUN-COMMAND>
3643 \begin_inset Newline newline
3646 <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.
3648 \begin_layout Description
3649 Sample Remove all index insets:
3650 \begin_inset Newline newline
3653 inset-forall Index delete-char-forward
3654 \begin_inset Newline newline
3657 Close all Notes (also works for a particular branch, for example):
3658 \begin_inset Newline newline
3661 inset-forall Note inset-toggle close
3662 \begin_inset Newline newline
3665 Transform all yellow notes to comments
3666 \begin_inset Newline newline
3669 inset-forall Note:Note inset-modify note Note Comment
3670 \begin_inset Newline newline
3673 Try to put LyX in an infinite loop if there is at least a Note:
3674 \begin_inset Newline newline
3677 inset-forall Note char-backward
3679 \begin_layout Description
3680 Origin lasgouttes, 27 Nov 2009
3683 \begin_layout Subsection*
3684 LFUN_GRAPHICS_RELOAD
3686 \begin_layout Description
3687 Action Reloads the image if necessary.
3689 \begin_layout Description
3690 Syntax graphics-reload
3692 \begin_layout Description
3693 Origin vfr, 10 Aug 2009
3696 \begin_layout Subsection*
3697 LFUN_SET_GRAPHICS_GROUP
3699 \begin_layout Description
3700 Action Set the group for the graphics inset on the cursor position.
3702 \begin_layout Description
3703 Syntax set-graphics-group [<GROUP>]
3705 \begin_layout Description
3706 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3708 \begin_layout Description
3709 Origin sanda, 6 May 2008
3712 \begin_layout Subsection*
3713 LFUN_FINISHED_FORWARD
3715 \begin_layout Description
3716 Action Moves the cursor out of the current slice, going forward.
3718 \begin_layout Description
3719 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.
3722 \begin_layout Subsection*
3723 LFUN_FINISHED_BACKWARD
3725 \begin_layout Description
3726 Action Moves the cursor out of the current slice, going backwards.
3728 \begin_layout Description
3729 Notion See also LFUN_FINISHED_FORWARD.
3732 \begin_layout Subsection*
3735 \begin_layout Description
3736 Action Moves the cursor out of the current slice, going right.
3738 \begin_layout Description
3739 Notion See also LFUN_FINISHED_FORWARD
3742 \begin_layout Subsection*
3745 \begin_layout Description
3746 Action Moves the cursor out of the current slice, going left.
3748 \begin_layout Description
3749 Notion See also LFUN_FINISHED_FORWARD.
3752 \begin_layout Subsection*
3755 \begin_layout Description
3756 Action Set language from the current cursor position.
3758 \begin_layout Description
3759 Syntax language <LANG>
3761 \begin_layout Description
3762 Params <LANG>: Requested language. Look in lib/languages for the list.
3764 \begin_layout Description
3765 Origin Dekel, 2 Mar 2000
3768 \begin_layout Subsection*
3771 \begin_layout Description
3772 Action Goto a label.
3774 \begin_layout Description
3775 Syntax label-goto [<LABEL>]
3777 \begin_layout Description
3778 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.
3780 \begin_layout Description
3781 Origin Ale, 6 Aug 1997
3784 \begin_layout Subsection*
3787 \begin_layout Description
3788 Action Inserts label to text or displayed formula.
3790 \begin_layout Description
3791 Syntax label-insert [<LABEL>]
3793 \begin_layout Description
3794 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3797 \begin_layout Subsection*
3800 \begin_layout Description
3801 Action Go to the next label or cross-reference.
3803 \begin_layout Description
3804 Syntax reference-next
3806 \begin_layout Description
3807 Origin Dekel, 14 Jan 2001
3810 \begin_layout Subsection*
3813 \begin_layout Description
3814 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3816 \begin_layout Description
3817 Notion Bookmark 0 has a special purpose. It is automatically set
3818 \begin_inset Newline newline
3821 1. to the paragraph you are currently editing
3822 \begin_inset Newline newline
3825 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3826 \begin_inset Newline newline
3829 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3831 \begin_layout Description
3832 Syntax bookmark-goto <NUMBER>
3834 \begin_layout Description
3835 Params <NUMBER>: the number of the bookmark to restore.
3837 \begin_layout Description
3838 Origin Dekel, 27 January 2001
3841 \begin_layout Subsection*
3844 \begin_layout Description
3845 Action Save a bookmark.
3847 \begin_layout Description
3848 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.
3850 \begin_layout Description
3851 Syntax bookmark-save <NUMBER>
3853 \begin_layout Description
3854 Params <NUMBER>: the number of the bookmark to save.
3856 \begin_layout Description
3857 Origin Dekel, 27 January 2001
3860 \begin_layout Subsection*
3863 \begin_layout Description
3864 Action Clears the list of saved bookmarks.
3866 \begin_layout Description
3867 Syntax bookmark-clear
3869 \begin_layout Description
3870 Origin bpeng, 31 October 2006
3873 \begin_layout Subsection*
3876 \begin_layout Description
3877 Action Open the given help file according to the language setting.
3879 \begin_layout Description
3880 Syntax help-open <FILE>[.lyx]
3882 \begin_layout Description
3883 Params <FILE>: any document from (/usr/share/)doc directory.
3885 \begin_layout Description
3886 Origin Jug, 27 Jun 1999
3889 \begin_layout Subsection*
3892 \begin_layout Description
3893 Action Terminates the current LyX instance.
3895 \begin_layout Description
3896 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3898 \begin_layout Description
3902 \begin_layout Subsection*
3905 \begin_layout Description
3906 Action Toggles visibility of a given toolbar between on/off/auto.
3908 \begin_layout Description
3909 Notion Skipping "auto" when allowauto is false.
3911 \begin_layout Description
3912 Syntax toolbar-toggle <NAME> [allowauto]
3914 \begin_layout Description
3915 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
3916 \begin_inset Newline newline
3919 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
3921 \begin_layout Description
3922 Origin Edwin, 21 May 2007
3925 \begin_layout Subsection*
3928 \begin_layout Description
3929 Action Opens the menu given by its name.
3931 \begin_layout Description
3932 Syntax menu-open <NAME>
3934 \begin_layout Description
3935 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3938 \begin_layout Subsection*
3941 \begin_layout Description
3942 Action Various UI visibility-toggling actions.
3944 \begin_layout Description
3945 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3947 \begin_layout Description
3948 Params statusbar : Toggle visibility of the statusbar.
3949 \begin_inset Newline newline
3952 menubar : Toggle visibility of the menubar.
3953 \begin_inset Newline newline
3956 scrollbar : Toggle visibility of the scrollbar.
3957 \begin_inset Newline newline
3960 frame : Toggle visibility of the frames around editing window.
3961 \begin_inset Newline newline
3964 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.
3966 \begin_layout Description
3967 Origin sanda, 9 Feb 2007
3970 \begin_layout Subsection*
3973 \begin_layout Description
3974 Action Creates new empty LyX window.
3976 \begin_layout Description
3977 Notion Already opened documents from the previous window can be found under View menu.
3979 \begin_layout Description
3980 Syntax window-new [<GEOMETRY>]
3982 \begin_layout Description
3983 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3985 \begin_layout Description
3986 Origin Abdel, 21 Oct 2006
3989 \begin_layout Subsection*
3992 \begin_layout Description
3993 Action Closes the current LyX window.
3995 \begin_layout Description
3998 \begin_layout Description
3999 Origin Abdel, 23 Oct 2006
4002 \begin_layout Subsection*
4005 \begin_layout Description
4006 Action Creates another split view of current buffer.
4008 \begin_layout Description
4009 Notion All split views act in the same way indpendently.
4011 \begin_layout Description
4012 Syntax split-view <vertical|horizontal>
4014 \begin_layout Description
4015 Params horizontal : The work areas are laid out side by side.
4016 \begin_inset Newline newline
4019 vertical : The work areas laid out vertically.
4021 \begin_layout Description
4022 Origin Abdel, 20 Feb 2008
4025 \begin_layout Subsection*
4026 LFUN_CLOSE_TAB_GROUP
4028 \begin_layout Description
4029 Action Close the current tab group.
4031 \begin_layout Description
4032 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
4034 \begin_layout Description
4035 Syntax close-tab-group
4037 \begin_layout Description
4038 Origin Abdel, 21 Feb 2008
4041 \begin_layout Subsection*
4044 \begin_layout Description
4045 Action Shows hidden dialog or create new one for a given function/inset settings etc.
4047 \begin_layout Description
4048 Syntax dialog-show <NAME> [<DATA>]
4050 \begin_layout Description
4051 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4052 \begin_inset Newline newline
4055 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
4056 \begin_inset Newline newline
4059 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
4060 \begin_inset Newline newline
4063 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
4064 \begin_inset Newline newline
4067 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
4068 \begin_inset Newline newline
4071 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
4072 \begin_inset Newline newline
4075 <SPECIAL>: latexlog|vclog
4076 \begin_inset Newline newline
4079 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
4081 \begin_layout Description
4082 Origin leeming, 17 Jun 2003
4085 \begin_layout Subsection*
4086 LFUN_DIALOG_SHOW_NEW_INSET
4088 \begin_layout Description
4089 Action Shows hidden dialog or create new one for a given inset settings etc.
4091 \begin_layout Description
4092 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
4094 \begin_layout Description
4095 Syntax dialog-show-new-inset <NAME> [<DATA>]
4097 \begin_layout Description
4098 Params See LFUN_DIALOG_SHOW .
4100 \begin_layout Description
4101 Origin leeming, 25 Feb 2003
4104 \begin_layout Subsection*
4107 \begin_layout Description
4108 Action Updates the dialog values from the inset/paragraph/document.
4110 \begin_layout Description
4111 Syntax dialog-update <NAME>
4113 \begin_layout Description
4114 Params <NAME>: paragraph|prefs|<INSET>
4115 \begin_inset Newline newline
4120 \begin_layout Description
4121 Origin leeming, 25 Feb 2003
4124 \begin_layout Subsection*
4127 \begin_layout Description
4128 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
4130 \begin_layout Description
4131 Syntax dialog-hide <NAME>
4133 \begin_layout Description
4134 Params See LFUN_DIALOG_SHOW .
4136 \begin_layout Description
4137 Origin leeming, 25 Feb 2003
4140 \begin_layout Subsection*
4143 \begin_layout Description
4144 Action Toggles dialog between showed/hidden state.
4146 \begin_layout Description
4147 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4149 \begin_layout Description
4150 Syntax dialog-toggle <NAME> [<DATA>]
4152 \begin_layout Description
4153 Params See LFUN_DIALOG_SHOW .
4155 \begin_layout Description
4156 Origin JSpitzm, 30 Apr 2007
4159 \begin_layout Subsection*
4160 LFUN_DIALOG_DISCONNECT_INSET
4162 \begin_layout Description
4163 Action Closes opened connection to opened inset.
4165 \begin_layout Description
4166 Notion Connection is used for apply functions.
4168 \begin_layout Description
4169 Syntax dialog-disconnect-inset <INSET-NAME>
4171 \begin_layout Description
4172 Origin leeming, 25 Feb 2003
4175 \begin_layout Subsection*
4178 \begin_layout Description
4179 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
4181 \begin_layout Description
4182 Notion This is internal LFUN, not to be used by users.
4184 \begin_layout Description
4185 Origin Andre, 9 Aug 2002
4188 \begin_layout Subsection*
4191 \begin_layout Description
4192 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
4194 \begin_layout Description
4195 Notion This is internal LFUN, not to be used by users.
4197 \begin_layout Description
4198 Origin Andre, 9 Aug 2002
4201 \begin_layout Subsection*
4204 \begin_layout Description
4205 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4207 \begin_layout Description
4208 Notion This is internal LFUN, not to be used by users.
4210 \begin_layout Description
4211 Origin Andre, 9 Aug 2002
4214 \begin_layout Subsection*
4217 \begin_layout Description
4218 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4220 \begin_layout Description
4221 Notion This is internal LFUN, not to be used by users.
4223 \begin_layout Description
4224 Origin Andre, 9 Aug 2002
4227 \begin_layout Subsection*
4230 \begin_layout Description
4231 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4233 \begin_layout Description
4234 Notion This is internal LFUN, not to be used by users.
4236 \begin_layout Description
4237 Origin Andre, 9 Aug 2002
4240 \begin_layout Subsection*
4243 \begin_layout Description
4244 Action Turn off the loaded keyboard map.
4246 \begin_layout Description
4250 \begin_layout Subsection*
4253 \begin_layout Description
4254 Action Turn on the primary keyboard map.
4256 \begin_layout Description
4257 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.
4258 \begin_inset Newline newline
4261 The language is to be set in the Preferences dialog.
4263 \begin_layout Description
4264 Syntax keymap-primary
4267 \begin_layout Subsection*
4268 LFUN_KEYMAP_SECONDARY
4270 \begin_layout Description
4271 Action Turn on the secondary keyboard map.
4273 \begin_layout Description
4274 Syntax keymap-secondary
4277 \begin_layout Subsection*
4280 \begin_layout Description
4281 Action Toggles keyboard maps (first/second/off).
4283 \begin_layout Description
4284 Syntax keymap-toggle
4286 \begin_layout Description
4287 Origin leeming, 30 Mar 2004
4290 \begin_layout Subsection*
4291 LFUN_SERVER_GET_LAYOUT
4293 \begin_layout Description
4294 Action Returns the current layout (that is environment) name on the cursor position.
4296 \begin_layout Description
4297 Syntax server-get-layout
4300 \begin_layout Subsection*
4301 LFUN_SERVER_GET_FILENAME
4303 \begin_layout Description
4304 Action Returns path and file name of the currently edited document.
4306 \begin_layout Description
4307 Syntax server-get-filename
4310 \begin_layout Subsection*
4311 LFUN_SERVER_GOTO_FILE_ROW
4313 \begin_layout Description
4314 Action Sets the cursor position in LyX based on the row number of generated TeX file.
4316 \begin_layout Description
4317 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).
4319 \begin_layout Description
4320 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4322 \begin_layout Description
4323 Params <FILE>: the path and filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
4324 \begin_inset Newline newline
4327 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).
4328 \begin_inset Newline newline
4331 .ext: extensions will be automatically replaced by .lyx.
4332 \begin_inset Newline newline
4335 <ROW_NUMBER> The row number of the LaTeX file to which to go.
4337 \begin_layout Description
4338 Sample server-goto-file-row /home/user/example.lyx 41
4339 \begin_inset Newline newline
4342 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
4344 \begin_layout Description
4345 Origin Edmar, 23 Dec 1998
4348 \begin_layout Subsection*
4351 \begin_layout Description
4352 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
4354 \begin_layout Description
4355 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
4357 \begin_layout Description
4358 Syntax forward-search
4360 \begin_layout Description
4361 Origin sanda, 14 Apr 2010
4364 \begin_layout Subsection*
4367 \begin_layout Description
4368 Action Sends notify message about the last key-sequence to client.
4370 \begin_layout Description
4371 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4373 \begin_layout Description
4374 Syntax server-notify
4377 \begin_layout Subsection*
4380 \begin_layout Description
4381 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4383 \begin_layout Description
4384 Syntax server-set-xy <X> <Y>
4387 \begin_layout Subsection*
4390 \begin_layout Description
4391 Action Returns the coordinates of cursor position in the editing area.
4393 \begin_layout Description
4394 Syntax server-get-xy
4397 \begin_layout Subsection*
4400 \begin_layout Description
4401 Action Generates the code (literate programming).
4403 \begin_layout Description
4404 Notion Latex file with extension
4406 literate_extension is generated. Then LyX invokes
4408 build_command (with a default of``make'') to generate the code and
4410 build_error_filter to process the compilation error messages.
4411 \begin_inset Newline newline
4414 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:
4415 \begin_inset Newline newline
4420 build_command "my_script my_arguments"
4421 \begin_inset Newline newline
4426 build_error_filter differs from the
4428 literate_error_filter only in that the former will identify error messages from your compiler.
4430 \begin_layout Description
4431 Syntax build-program
4434 \begin_layout Subsection*
4435 LFUN_BUFFER_AUTO_SAVE
4437 \begin_layout Description
4438 Action Saves the current buffer to a temporary file.
4440 \begin_layout Description
4441 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4443 \begin_layout Description
4444 Syntax buffer-auto-save
4447 \begin_layout Subsection*
4448 LFUN_BUFFER_CHILD_OPEN
4450 \begin_layout Description
4451 Action Loads the given child document.
4453 \begin_layout Description
4454 Notion The current document is treated as a parent.
4456 \begin_layout Description
4457 Syntax buffer-child-open <FILE>
4459 \begin_layout Description
4460 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4462 \begin_layout Description
4463 Origin Ale, 28 May 1997
4466 \begin_layout Subsection*
4469 \begin_layout Description
4470 Action Runs chktex for the current document.
4472 \begin_layout Description
4473 Syntax buffer-chktex
4475 \begin_layout Description
4476 Origin Asger, 30 Oct 1997
4479 \begin_layout Subsection*
4480 LFUN_BUFFER_TOGGLE_COMPRESSION
4482 \begin_layout Description
4483 Action Toggles compression of the current document on/off.
4485 \begin_layout Description
4486 Syntax buffer-toggle-compression
4488 \begin_layout Description
4489 Origin bpeng, 27 Apr 2006
4492 \begin_layout Subsection*
4493 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
4495 \begin_layout Description
4496 Action Toggles including of resources for forward/reverse search of the given document.
4498 \begin_layout Description
4499 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
4501 \begin_layout Description
4502 Syntax buffer-toggle-output-sync
4504 \begin_layout Description
4505 Origin sanda, 25 May 2010
4508 \begin_layout Subsection*
4511 \begin_layout Description
4512 Action Closes the current buffer.
4514 \begin_layout Description
4515 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4517 \begin_layout Description
4521 \begin_layout Subsection*
4522 LFUN_BUFFER_CLOSE_ALL
4524 \begin_layout Description
4525 Action Closes all buffers.
4527 \begin_layout Description
4528 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4530 \begin_layout Description
4531 Syntax buffer-close-all
4534 \begin_layout Subsection*
4537 \begin_layout Description
4538 Action Exports the current buffer (document) to the given format.
4540 \begin_layout Description
4541 Syntax buffer-export <FORMAT>
4543 \begin_layout Description
4544 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.
4545 \begin_inset Newline newline
4548 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.
4550 \begin_layout Description
4551 Origin Lgb, 29 Jul 1997
4554 \begin_layout Subsection*
4555 LFUN_BUFFER_EXPORT_CUSTOM
4557 \begin_layout Description
4558 Action Exports the current buffer (document) from the given format using the given command on it.
4560 \begin_layout Description
4561 Syntax buffer-export-custom <FORMAT> <COMMAND>
4563 \begin_layout Description
4564 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4565 \begin_inset Newline newline
4568 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4570 \begin_layout Description
4571 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4573 \begin_layout Description
4574 Origin leeming, 27 Mar 2004
4577 \begin_layout Subsection*
4580 \begin_layout Description
4581 Action Prints the current document.
4583 \begin_layout Description
4584 Notion Many settings can be given via the preferences dialog.
4586 \begin_layout Description
4587 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4589 \begin_layout Description
4590 Params <TARGET> is either "printer" or "file".
4591 \begin_inset Newline newline
4594 <TARGER-NAME> is either "default" or file name or printer name.
4595 \begin_inset Newline newline
4598 <COMMAND> command ensuring the printing job.
4600 \begin_layout Description
4601 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4603 \begin_layout Description
4604 Origin leeming, 28 Mar 2004
4607 \begin_layout Subsection*
4610 \begin_layout Description
4611 Action Import a given file as a lyx document.
4613 \begin_layout Description
4614 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.
4616 \begin_layout Description
4617 Syntax buffer-import <FORMAT> [<FILE>]
4619 \begin_layout Description
4620 Origin Asger, 24 Jul 1998
4623 \begin_layout Subsection*
4626 \begin_layout Description
4627 Action Creates a new buffer (that is, document).
4629 \begin_layout Description
4630 Notion Implicit path can be set in Preferences dialog.
4632 \begin_layout Description
4633 Syntax buffer-new [<FILE>]
4635 \begin_layout Description
4636 Params <FILE>: filename of created file with absolute path.
4639 \begin_layout Subsection*
4640 LFUN_BUFFER_NEW_TEMPLATE
4642 \begin_layout Description
4643 Action Creates a new buffer (that is, document) from a template.
4645 \begin_layout Description
4646 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4648 \begin_layout Description
4649 Syntax buffer-new-template [<FILE>]
4651 \begin_layout Description
4652 Params <FILE>: filename of created file with absolute path.
4655 \begin_layout Subsection*
4658 \begin_layout Description
4659 Action Reverts opened document.
4661 \begin_layout Description
4662 Syntax buffer-reload
4664 \begin_layout Description
4665 Origin Asger, 2 Feb 1997
4668 \begin_layout Subsection*
4671 \begin_layout Description
4672 Action Display/switch to the given buffer.
4674 \begin_layout Description
4675 Syntax buffer-switch <BUFFER>
4677 \begin_layout Description
4678 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
4681 \begin_layout Subsection*
4682 LFUN_BUFFER_TOGGLE_READ_ONLY
4684 \begin_layout Description
4685 Action Toggle editing mode of the current document between read/write and read-only.
4687 \begin_layout Description
4688 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.
4690 \begin_layout Description
4691 Syntax buffer-toggle-read-only
4693 \begin_layout Description
4694 Origin Lgb, 27 May 1997
4697 \begin_layout Subsection*
4700 \begin_layout Description
4701 Action Displays current buffer in chosen format.
4703 \begin_layout Description
4704 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.
4706 \begin_layout Description
4707 Syntax buffer-view [<FORMAT>]
4709 \begin_layout Description
4710 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.
4713 \begin_layout Subsection*
4716 \begin_layout Description
4717 Action Exports the current document and put the result into the temporary directory.
4719 \begin_layout Description
4720 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).
4722 \begin_layout Description
4723 Syntax buffer-update [<FORMAT>]
4725 \begin_layout Description
4726 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.
4728 \begin_layout Description
4729 Origin Dekel, 5 Aug 2000
4732 \begin_layout Subsection*
4735 \begin_layout Description
4736 Action Saves the current buffer.
4738 \begin_layout Description
4739 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.
4741 \begin_layout Description
4745 \begin_layout Subsection*
4746 LFUN_BUFFER_WRITE_AS
4748 \begin_layout Description
4749 Action Rename and save current buffer.
4751 \begin_layout Description
4752 Syntax buffer-write-as <FILENAME>
4754 \begin_layout Description
4755 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4758 \begin_layout Subsection*
4759 LFUN_BUFFER_WRITE_ALL
4761 \begin_layout Description
4762 Action Save all changed documents.
4764 \begin_layout Description
4765 Syntax buffer-write-all
4767 \begin_layout Description
4768 Origin rgh, gpothier 6 Aug 2007
4771 \begin_layout Subsection*
4774 \begin_layout Description
4775 Action Switch to the next opened document.
4777 \begin_layout Description
4778 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4780 \begin_layout Description
4784 \begin_layout Subsection*
4785 LFUN_BUFFER_PREVIOUS
4787 \begin_layout Description
4788 Action Switch to the previous opened document.
4790 \begin_layout Description
4791 Syntax buffer-previous
4794 \begin_layout Subsection*
4795 LFUN_MASTER_BUFFER_UPDATE
4797 \begin_layout Description
4798 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4800 \begin_layout Description
4801 Syntax master-buffer-update [<FORMAT>]
4803 \begin_layout Description
4804 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.
4806 \begin_layout Description
4807 Origin Tommaso, 20 Sep 2007
4810 \begin_layout Subsection*
4811 LFUN_MASTER_BUFFER_VIEW
4813 \begin_layout Description
4814 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4816 \begin_layout Description
4817 Syntax master-buffer-view [<FORMAT>]
4819 \begin_layout Description
4820 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.
4822 \begin_layout Description
4823 Origin Tommaso, 20 Sep 2007
4826 \begin_layout Subsection*
4827 LFUN_BUFFER_LANGUAGE
4829 \begin_layout Description
4830 Action Set language of the current document.
4832 \begin_layout Description
4833 Syntax buffer-language <LANG>
4835 \begin_layout Description
4836 Params <LANG>: language name. See lib/languages for list.
4838 \begin_layout Description
4839 Origin leeming, 30 Mar 2004
4842 \begin_layout Subsection*
4843 LFUN_BUFFER_SAVE_AS_DEFAULT
4845 \begin_layout Description
4846 Action Save the current document settings as default.
4848 \begin_layout Description
4849 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4851 \begin_layout Description
4852 Syntax buffer-save-as-default [<ARGS>]
4854 \begin_layout Description
4855 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4857 \begin_layout Description
4858 Origin leeming, 30 Mar 2004
4861 \begin_layout Subsection*
4862 LFUN_BUFFER_PARAMS_APPLY
4864 \begin_layout Description
4865 Action Apply the given settings to the current document.
4867 \begin_layout Description
4868 Syntax buffer-params-apply [<ARGS>]
4870 \begin_layout Description
4871 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4873 \begin_layout Description
4874 Origin leeming, 30 Mar 2004
4877 \begin_layout Subsection*
4880 \begin_layout Description
4881 Action Inserts another LyX file.
4883 \begin_layout Description
4884 Syntax file-insert [<FILE>]
4886 \begin_layout Description
4887 Params <FILE>: Filename to be inserted.
4890 \begin_layout Subsection*
4891 LFUN_FILE_INSERT_PLAINTEXT
4893 \begin_layout Description
4894 Action Inserts plain text file.
4896 \begin_layout Description
4897 Syntax file-insert-plaintext [<FILE>]
4899 \begin_layout Description
4900 Params <FILE>: Filename to be inserted.
4902 \begin_layout Description
4903 Origin CFO-G, 19 Nov 1997
4906 \begin_layout Subsection*
4907 LFUN_FILE_INSERT_PLAINTEXT_PARA
4909 \begin_layout Description
4910 Action Inserts plain text file as paragraph (i.e. join lines).
4912 \begin_layout Description
4913 Syntax file-insert-plaintext-para [<FILE>]
4915 \begin_layout Description
4916 Params <FILE>: Filename to be inserted.
4918 \begin_layout Description
4919 Origin Levon, 14 Feb 2001
4922 \begin_layout Subsection*
4925 \begin_layout Description
4926 Action Open LyX document.
4928 \begin_layout Description
4929 Syntax file-open [<FILE>]
4931 \begin_layout Description
4932 Params <FILE>: Filename to be opened.
4935 \begin_layout Subsection*
4938 \begin_layout Description
4939 Action Executes a command defined in a .def file.
4941 \begin_layout Description
4942 Notion The definitions are by default read from lib/commands/default.def.
4943 \begin_inset Newline newline
4946 A .def file allows to define a command with
4948 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).
4950 def_file "FileName" allows to include another .def file.
4951 \begin_inset Newline newline
4954 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.
4956 \begin_layout Description
4959 \begin_layout Description
4960 Params <NAME>: Name of the command that must be called.
4962 \begin_layout Description
4963 Origin broider, 2 Oct 2007
4966 \begin_layout Subsection*
4969 \begin_layout Description
4970 Action Simulate halting Meta key (Alt key on PCs).
4972 \begin_layout Description
4973 Notion Used for buffer editation not for GUI control.
4975 \begin_layout Description
4979 \begin_layout Subsection*
4982 \begin_layout Description
4983 Action Cancels sequence prepared by LFUN_META_PREFIX .
4985 \begin_layout Description
4989 \begin_layout Subsection*
4990 LFUN_COMMAND_EXECUTE
4992 \begin_layout Description
4993 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
4995 \begin_layout Description
4996 Notion Usually bound to M-x shortcut.
4998 \begin_layout Description
4999 Syntax command-execute
5002 \begin_layout Subsection*
5005 \begin_layout Description
5006 Action Return the current key sequence and available options as a string.
5008 \begin_layout Description
5009 Notion No options are added if no current map exists.
5010 \begin_inset Newline newline
5013 This is probably usable only with connection to lyxserver.
5015 \begin_layout Description
5016 Syntax command-prefix
5019 \begin_layout Subsection*
5020 LFUN_COMMAND_SEQUENCE
5022 \begin_layout Description
5023 Action Run more commands (LFUN and its parameters) in a sequence.
5025 \begin_layout Description
5026 Syntax command-sequence <CMDS>
5028 \begin_layout Description
5029 Params <CMDS>: Sequence of commands separated by semicolons.
5031 \begin_layout Description
5032 Sample command-sequence cut; ert-insert; self-insert
5034 ; paste; self-insert {}; inset-toggle;
5036 \begin_layout Description
5037 Origin Andre, 11 Nov 1999
5040 \begin_layout Subsection*
5041 LFUN_COMMAND_ALTERNATIVES
5043 \begin_layout Description
5044 Action Runs the first listed command that is enabled.
5046 \begin_layout Description
5047 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
5049 \begin_layout Description
5050 Syntax command-alternatives <CMDS>
5052 \begin_layout Description
5053 Params <CMDS>: Sequence of commands separated by semicolons.
5055 \begin_layout Description
5056 Sample command-alternatives completion-accept;cell-forward
5058 \begin_layout Description
5059 Origin rgh, 24 September 2008
5062 \begin_layout Subsection*
5065 \begin_layout Description
5066 Action Shows message in statusbar (for script purposes).
5068 \begin_layout Description
5069 Syntax message <STRING>
5071 \begin_layout Description
5072 Origin Lgb, 8 Apr 2001
5075 \begin_layout Subsection*
5076 LFUN_DEBUG_LEVEL_SET
5078 \begin_layout Description
5079 Action Set debug output level.
5081 \begin_layout Description
5082 Syntax debug-level-set <LEVEL>
5084 \begin_layout Description
5085 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.
5087 \begin_layout Description
5088 Origin sanda, 28 Dec 2009
5091 \begin_layout Subsection*
5092 LFUN_PREFERENCES_SAVE
5094 \begin_layout Description
5095 Action Save user preferences.
5097 \begin_layout Description
5098 Syntax preferences-save
5100 \begin_layout Description
5101 Origin Lgb, 27 Nov 1999
5104 \begin_layout Subsection*
5107 \begin_layout Description
5108 Action Reconfigure the automatic settings.
5110 \begin_layout Description
5113 \begin_layout Description
5114 Origin Asger, 14 Feb 1997
5117 \begin_layout Subsection*
5120 \begin_layout Description
5121 Action Apply the given settings to user preferences.
5123 \begin_layout Description
5124 Syntax lyxrc-apply <SETTINGS>
5126 \begin_layout Description
5127 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.
5130 \begin_layout Subsection*
5131 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
5133 \begin_layout Description
5134 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
5136 \begin_layout Description
5137 Syntax toggle-cursor-follows-scrollbar
5139 \begin_layout Description
5140 Origin ARRae, 2 Dec 1997
5143 \begin_layout Subsection*
5146 \begin_layout Description
5147 Action Set the given LyX color to the color defined by the X11 name given.
5149 \begin_layout Description
5150 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5152 \begin_layout Description
5153 Syntax set-color <LYX_NAME> <X11_NAME>
5155 \begin_layout Description
5156 Origin SLior, 11 Jun 2000
5159 \begin_layout Subsection*
5162 \begin_layout Description
5163 Action Count the statistics (number of words and characters) in the document or in the given selection.
5165 \begin_layout Description
5166 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5168 \begin_layout Description
5171 \begin_layout Description
5172 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5175 \begin_layout Subsection*
5176 LFUN_COMPLETION_INLINE
5178 \begin_layout Description
5179 Action Show the inline completion at the cursor position.
5181 \begin_layout Description
5182 Syntax completion-inline
5184 \begin_layout Description
5185 Origin sts, Feb 19 2008
5188 \begin_layout Subsection*
5189 LFUN_COMPLETION_POPUP
5191 \begin_layout Description
5192 Action Show the completion popup at the cursor position.
5194 \begin_layout Description
5195 Syntax completion-popup
5197 \begin_layout Description
5198 Origin sts, Feb 19 2008
5201 \begin_layout Subsection*
5202 LFUN_COMPLETION_COMPLETE
5204 \begin_layout Description
5205 Action Try to complete the word or command at the cursor position.
5207 \begin_layout Description
5210 \begin_layout Description
5211 Origin sts, Feb 19 2008
5214 \begin_layout Subsection*
5215 LFUN_COMPLETION_CANCEL
5217 \begin_layout Description
5218 Action Try to cancel completion, either the popup or the inline completion.
5220 \begin_layout Description
5221 Syntax completion-cancel
5223 \begin_layout Description
5224 Origin sts, Sep 07 2008
5227 \begin_layout Subsection*
5228 LFUN_COMPLETION_ACCEPT
5230 \begin_layout Description
5231 Action Accept suggested completion.
5233 \begin_layout Description
5234 Syntax completion-accept
5236 \begin_layout Description
5237 Origin sanda, Sep 08 2008
5240 \begin_layout Subsection*
5243 \begin_layout Description
5244 Action Add a branch to the buffer's BranchList.
5246 \begin_layout Description
5247 Syntax branch-add <BRANCH>
5249 \begin_layout Description
5250 Params <BRANCH>: Name of the branch to add
5252 \begin_layout Description
5253 Origin spitz, 7 Jul 2009
5256 \begin_layout Subsection*
5257 LFUN_BRANCH_ACTIVATE
5259 \begin_layout Description
5260 Action Activate the branch.
5262 \begin_layout Description
5263 Syntax branch-activate <BRANCH>
5265 \begin_layout Description
5266 Params <BRANCH>: The branch to activate
5268 \begin_layout Description
5269 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5270 \begin_inset Newline newline
5273 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5275 \begin_layout Description
5276 Origin rgh, 27 May 2008
5279 \begin_layout Subsection*
5280 LFUN_BRANCH_DEACTIVATE
5282 \begin_layout Description
5283 Action De-activate the branch.
5285 \begin_layout Description
5286 Syntax branch-deactivate <BRANCH>
5288 \begin_layout Description
5289 Params <BRANCH>: The branch to deactivate
5291 \begin_layout Description
5292 Origin rgh, 27 May 2008
5295 \begin_layout Subsection*
5296 LFUN_BRANCHES_RENAME
5298 \begin_layout Description
5299 Action Rename all branches of a given name in a document.
5301 \begin_layout Description
5302 Syntax branches-rename <OLDNAME> <NEWNAME>
5304 \begin_layout Description
5305 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5307 \begin_layout Description
5308 Origin spitz, 9 Jul 2009
5311 \begin_layout Subsection*
5312 LFUN_BRANCH_ADD_INSERT
5314 \begin_layout Description
5315 Action Create new branch and directly put the branch inset into the document.
5317 \begin_layout Description
5318 Syntax branch-add-insert [<NAME>]
5320 \begin_layout Description
5321 Params <NAME>: Branch name. If it is not specified, you will be asked.
5323 \begin_layout Description
5324 Origin sanda, 10 Jul 2009
5327 \begin_layout Subsection*
5328 LFUN_LABEL_COPY_AS_REF
5330 \begin_layout Description
5331 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5333 \begin_layout Description
5334 Syntax copy-label-as-reference <LABEL>
5336 \begin_layout Description
5337 Params <LABEL>: The label to copy (for multi-line math)
5339 \begin_layout Description
5340 Origin sts, 16 Nov 2008
5343 \begin_layout Subsection*
5344 LFUN_LABEL_INSERT_AS_REF
5346 \begin_layout Description
5347 Action Inserts the label as a cross-reference at the position of the cursor.
5349 \begin_layout Description
5350 Syntax label-insert-as-reference
5352 \begin_layout Description
5353 Origin vfr, 7 Apr 2009
5356 \begin_layout Subsection*
5359 \begin_layout Description
5360 Action Increases the zoom of the screen fonts.
5362 \begin_layout Description
5363 Syntax buffer-zoom-in [<ZOOM>]
5365 \begin_layout Description
5366 Params <ZOOM>: The zoom in %, the default is 20.
5368 \begin_layout Description
5369 Origin vfr, 30 Mar 2009
5372 \begin_layout Subsection*
5373 LFUN_BUFFER_ZOOM_OUT
5375 \begin_layout Description
5376 Action Decreases the zoom of the screen fonts.
5378 \begin_layout Description
5379 Syntax buffer-zoom-out [<ZOOM>]
5381 \begin_layout Description
5382 Params <ZOOM>: The zoom in %, the default is 20.
5384 \begin_layout Description
5385 Origin vfr, 30 Mar 2009
5388 \begin_layout Subsection*
5391 \begin_layout Description
5392 Action Copies the inset to the clipboard as a certain type.
5394 \begin_layout Description
5395 Notion Currently used only for InsetInfo where its content is copied as a text.
5397 \begin_layout Description
5398 Syntax inset-copy-as
5400 \begin_layout Description
5401 Origin vfr, 18 Apr 2010