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-01-10
63 \begin_layout Standard
67 \begin_layout Plain Layout
77 \begin_inset VSpace 1cm
82 \begin_layout Subsection*
85 \begin_layout Description
86 Action Adds an acute accent to the next character typed.
88 \begin_layout Description
92 \begin_layout Subsection*
95 \begin_layout Description
96 Action Adds a breve accent to the next character typed.
98 \begin_layout Description
102 \begin_layout Subsection*
105 \begin_layout Description
106 Action Adds a caron to the next character typed.
108 \begin_layout Description
112 \begin_layout Subsection*
115 \begin_layout Description
116 Action Adds a cedilla to the next character typed.
118 \begin_layout Description
119 Syntax accent-cedilla
122 \begin_layout Subsection*
125 \begin_layout Description
126 Action Adds a circle accent to the next character typed.
128 \begin_layout Description
132 \begin_layout Subsection*
133 LFUN_ACCENT_CIRCUMFLEX
135 \begin_layout Description
136 Action Adds a circumflex to the next character typed.
138 \begin_layout Description
139 Syntax accent-circumflex
142 \begin_layout Subsection*
145 \begin_layout Description
146 Action Adds a dot accent to the next character typed.
148 \begin_layout Description
152 \begin_layout Subsection*
155 \begin_layout Description
156 Action Adds a grave accent to the next character typed.
158 \begin_layout Description
162 \begin_layout Subsection*
163 LFUN_ACCENT_HUNGARIAN_UMLAUT
165 \begin_layout Description
166 Action Adds a Hungarian umlaut to the next character typed.
168 \begin_layout Description
172 \begin_layout Subsection*
175 \begin_layout Description
176 Action Adds a macron to the next character typed.
178 \begin_layout Description
182 \begin_layout Subsection*
185 \begin_layout Description
186 Action Adds an ogonek accent to the next character typed.
188 \begin_layout Description
192 \begin_layout Subsection*
195 \begin_layout Description
196 Action Adds a tie over the next two character typed.
198 \begin_layout Description
199 Notion The following char will finish the tie.
201 \begin_layout Description
205 \begin_layout Subsection*
208 \begin_layout Description
209 Action Adds a tilde over the next character typed.
211 \begin_layout Description
215 \begin_layout Subsection*
218 \begin_layout Description
219 Action Adds an umlaut over the next character typed.
221 \begin_layout Description
225 \begin_layout Subsection*
228 \begin_layout Description
229 Action Adds a bar under the next character typed.
231 \begin_layout Description
232 Syntax accent-underbar
235 \begin_layout Subsection*
238 \begin_layout Description
239 Action Adds a dot under the next character typed.
241 \begin_layout Description
242 Syntax accent-underdot
245 \begin_layout Subsection*
248 \begin_layout Description
249 Action Inserts a caption inset.
251 \begin_layout Description
252 Syntax caption-insert
254 \begin_layout Description
255 Origin Lgb, 18 Jul 2000
258 \begin_layout Subsection*
261 \begin_layout Description
262 Action Inserts the current date.
264 \begin_layout Description
265 Syntax date-insert [<ARG>]
267 \begin_layout Description
268 Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
270 \begin_layout Description
271 Origin jdblair, 31 Jan 2000
274 \begin_layout Subsection*
277 \begin_layout Description
278 Action Inserts a footnote inset.
280 \begin_layout Description
281 Syntax footnote-insert
283 \begin_layout Description
284 Origin Jug, 7 Mar 2000
287 \begin_layout Subsection*
290 \begin_layout Description
291 Action Inserts an ERT inset.
293 \begin_layout Description
296 \begin_layout Description
297 Origin Jug, 18 Feb 2000
300 \begin_layout Subsection*
303 \begin_layout Description
304 Action Inserts a float inset.
306 \begin_layout Description
307 Syntax float-insert <TYPE>
309 \begin_layout Description
310 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
312 \begin_layout Description
313 Origin Lgb, 27 Jun 2000
316 \begin_layout Subsection*
317 LFUN_FLOAT_WIDE_INSERT
319 \begin_layout Description
320 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
322 \begin_layout Description
323 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
325 \begin_layout Description
326 Syntax float-wide-insert <TYPE>
328 \begin_layout Description
329 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
331 \begin_layout Description
332 Origin Lgb, 31 Oct 2001
335 \begin_layout Subsection*
336 LFUN_FLOAT_LIST_INSERT
338 \begin_layout Description
339 Action Inserts the list of floats in the document.
341 \begin_layout Description
342 Syntax float-list-insert <TYPE>
344 \begin_layout Description
345 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
347 \begin_layout Description
348 Origin Lgb, 3 May 2001
351 \begin_layout Subsection*
354 \begin_layout Description
355 Action Inserts floats wrapped by the text around.
357 \begin_layout Description
358 Syntax wrap-insert <TYPE>
360 \begin_layout Description
361 Params <TYPE>: table|figure
363 \begin_layout Description
364 Origin Dekel, 7 Apr 2002
367 \begin_layout Subsection*
370 \begin_layout Description
371 Action Inserts an optional-argument (short title) inset.
373 \begin_layout Description
374 Syntax optional-insert
376 \begin_layout Description
377 Origin vermeer, 12 Aug 2002
380 \begin_layout Subsection*
383 \begin_layout Description
384 Action Inserts a horizontal line.
386 \begin_layout Description
389 \begin_layout Description
390 Origin Andre, Oct 27 2003
393 \begin_layout Subsection*
396 \begin_layout Description
397 Action Inserts a new page.
399 \begin_layout Description
400 Syntax newpage-insert <ARG>
402 \begin_layout Description
403 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
405 \begin_layout Description
406 Origin uwestoehr, 24 Nov 2007
409 \begin_layout Subsection*
410 LFUN_MARGINALNOTE_INSERT
412 \begin_layout Description
413 Action Inserts a marginal note.
415 \begin_layout Description
416 Syntax marginalnote-insert
418 \begin_layout Description
419 Origin Lgb, 26 Jun 2000
422 \begin_layout Subsection*
425 \begin_layout Description
426 Action Inserts a single unicode character.
428 \begin_layout Description
429 Syntax unicode-insert <CHAR>
431 \begin_layout Description
432 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
434 \begin_layout Description
435 Sample unicode-insert 0x0100
437 \begin_layout Description
438 Origin Lgb, 22 Oct 2006
441 \begin_layout Subsection*
444 \begin_layout Description
445 Action Inserts a new listings inset.
447 \begin_layout Description
448 Syntax listing-insert
450 \begin_layout Description
451 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
454 \begin_layout Subsection*
457 \begin_layout Description
458 Action 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|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 package: name of latex package (e.g. listings)
542 \begin_inset Newline newline
545 textclass: name of textclass (e.g. article)
546 \begin_inset Newline newline
549 menu: name of lfun used in menu
550 \begin_inset Newline newline
553 icon: name of lfun used in toolbar
554 \begin_inset Newline newline
557 buffer: "name"|"path"|"class"
559 \begin_layout Description
560 Sample command-sequence info-insert buffer path; info-insert buffer name
562 \begin_layout Description
563 Origin bpeng, 7 Oct 2007
566 \begin_layout Subsection*
569 \begin_layout Description
570 Action Inserts branch inset.
572 \begin_layout Description
573 Syntax branch-insert <BRANCH-NAME>
575 \begin_layout Description
576 Origin vermeer, 17 Aug 2003
579 \begin_layout Subsection*
582 \begin_layout Description
583 Action Inserts Box inset.
585 \begin_layout Description
586 Syntax box-insert [<TYPE>]
588 \begin_layout Description
589 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
590 \begin_inset Newline newline
593 Framed is the default one.
595 \begin_layout Description
596 Origin vermeer, 7 Oct 2003
599 \begin_layout Subsection*
602 \begin_layout Description
603 Action Inserts CharStyle, Custom inset or XML short element.
605 \begin_layout Description
606 Notion Look into the Customization manual for more information about these elements.
607 \begin_inset Newline newline
610 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.
611 \begin_inset Newline newline
614 For dissolving the element see LFUN_INSET_DISSOLVE.
616 \begin_layout Description
617 Syntax flex-insert <TYPE:Name>
619 \begin_layout Description
620 Params TYPE: CharStyle|Custom|Element|Standard
621 \begin_inset Newline newline
624 Identifies whether this is a Character Style, a Custom Inset or an XML Element, and which dynamical sub-menu this flex inset is in on the LyX menu tree. If Standard (currently unused): none of these.
625 \begin_inset Newline newline
628 Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
630 \begin_layout Description
631 Sample flex-insert CharStyle:Code
634 \begin_layout Subsection*
637 \begin_layout Description
638 Action Inserts the given string (accordingly to the correct keymap).
640 \begin_layout Description
641 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
643 \begin_layout Description
644 Syntax self-insert <STRING>
647 \begin_layout Subsection*
650 \begin_layout Description
651 Action Inserts one of horizontal space insets.
653 \begin_layout Description
654 Syntax space-insert <NAME> [<LEN>]
656 \begin_layout Description
657 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
658 \begin_inset Newline newline
661 <LEN>: length for custom spaces (hspace, hspace* for protected)
663 \begin_layout Description
664 Origin JSpitzm, 20 May 2003, Mar 17 2008
667 \begin_layout Subsection*
668 LFUN_HYPERLINK_INSERT
670 \begin_layout Description
671 Action Inserts hyperlinks into the document (clickable in pdf output).
673 \begin_layout Description
674 Notion Hyperlink target can be set via selection + hyperlink-insert function.
676 \begin_layout Description
677 Syntax href-insert [<TARGET>]
679 \begin_layout Description
680 Origin CFO-G, 21 Nov 1997
683 \begin_layout Subsection*
684 LFUN_SPECIALCHAR_INSERT
686 \begin_layout Description
687 Action Inserts various characters into the document.
689 \begin_layout Description
690 Syntax specialchar-insert <CHAR>
692 \begin_layout Description
693 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
695 \begin_layout Description
696 Origin JSpitzm, 6 Dec 2007
699 \begin_layout Subsection*
702 \begin_layout Description
703 Action Inserts table of contents.
705 \begin_layout Description
708 \begin_layout Description
709 Origin Lgb, 27 May 97
712 \begin_layout Subsection*
715 \begin_layout Description
716 Action Start (or remove) Appendix on the given cursor position.
718 \begin_layout Description
721 \begin_layout Description
722 Origin ettrich, 5 May 1998
725 \begin_layout Subsection*
728 \begin_layout Description
729 Action Inserts Index entry.
731 \begin_layout Description
732 Notion It automatically takes the word on the cursor position.
734 \begin_layout Description
735 Syntax index-insert [<TYPE:Name>]
737 \begin_layout Description
738 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
740 \begin_layout Description
741 Origin leeming, 3 Aug 2000
744 \begin_layout Subsection*
747 \begin_layout Description
748 Action Inserts list of Index entries on a new page.
750 \begin_layout Description
751 Syntax index-print [<TYPE:Name>]
753 \begin_layout Description
754 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
756 \begin_layout Description
757 Origin Lgb, 27 Feb 1997
760 \begin_layout Subsection*
763 \begin_layout Description
764 Action Inserts Nomenclature entry.
766 \begin_layout Description
767 Notion It automatically takes the word on the cursor position if no symbol is given.
769 \begin_layout Description
770 Syntax nomencl-insert [<SYMBOL>]
772 \begin_layout Description
773 Origin Ugras, 4 Nov 2006
776 \begin_layout Subsection*
777 LFUN_NOMENCLATURE_PRINT
779 \begin_layout Description
780 Action Inserts list of Nomenclature entries.
782 \begin_layout Description
783 Syntax nomenclature-print
785 \begin_layout Description
786 Origin Ugras, 4 Nov 2006
789 \begin_layout Subsection*
792 \begin_layout Description
793 Action Inserts Note on the current cursor postion, move selection inside the inset.
795 \begin_layout Description
796 Syntax note-insert [<TYPE>]
798 \begin_layout Description
799 Params <TYPE>: <Note|Greyedout|Comment> default: Note
802 \begin_layout Subsection*
805 \begin_layout Description
806 Action Moves the cursor to the begining of next Note inset.
808 \begin_layout Description
812 \begin_layout Subsection*
815 \begin_layout Description
816 Action Changes all Note insets of a particular type (source) to a different type (target) fot the current document.
818 \begin_layout Description
819 Syntax notes-mutate <SOURCE> <TARGET>
821 \begin_layout Description
822 Params <SOURCE/TARGET>: Note|Comment|Greyedout
824 \begin_layout Description
825 Origin sanda, 18 Jun 2008
828 \begin_layout Subsection*
831 \begin_layout Description
832 Action Inserts phantom on the current cursor postion, move selection inside the inset.
834 \begin_layout Description
835 Syntax phantom-insert [<TYPE>]
837 \begin_layout Description
838 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
840 \begin_layout Description
841 Origin uwestoehr, 30 Jan 2009
844 \begin_layout Subsection*
847 \begin_layout Description
848 Action Inserts a line break or new line.
850 \begin_layout Description
851 Syntax newline-insert [<ARG>]
853 \begin_layout Description
854 Params <ARG>: <newline|linebreak> default: newline
856 \begin_layout Description
857 Origin JSpitzm, 25 Mar 2008
860 \begin_layout Subsection*
863 \begin_layout Description
864 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD.
866 \begin_layout Description
869 \begin_layout Description
870 Origin Lgb, 17 May 2001
873 \begin_layout Subsection*
876 \begin_layout Description
877 Action Moves the cursor one line in downward direction.
879 \begin_layout Description
883 \begin_layout Subsection*
886 \begin_layout Description
887 Action Moves the cursor one line in upward direction.
889 \begin_layout Description
893 \begin_layout Subsection*
896 \begin_layout Description
897 Action Moves the cursor one line in downward direction adding the current position to the selection.
899 \begin_layout Description
903 \begin_layout Subsection*
906 \begin_layout Description
907 Action Moves the cursor one line in upward direction adding the current position to the selection.
909 \begin_layout Description
913 \begin_layout Subsection*
916 \begin_layout Description
917 Action Moves the cursor one page in downward direction.
919 \begin_layout Description
923 \begin_layout Subsection*
926 \begin_layout Description
927 Action Moves the cursor one page in upward direction.
929 \begin_layout Description
933 \begin_layout Subsection*
934 LFUN_SCREEN_DOWN_SELECT
936 \begin_layout Description
937 Action Moves the cursor one screen in downward direction adding the current position to the selection.
939 \begin_layout Description
940 Syntax screen-down-select
943 \begin_layout Subsection*
944 LFUN_SCREEN_UP_SELECT
946 \begin_layout Description
947 Action Moves the cursor one page in upward direction adding the current position to the selection.
949 \begin_layout Description
950 Syntax screen-up-select
953 \begin_layout Subsection*
956 \begin_layout Description
957 Action Scroll the buffer view.
959 \begin_layout Description
960 Notion Only scrolls the screen up or down; does not move the cursor.
962 \begin_layout Description
963 Syntax scroll <TYPE> <QUANTITY>
965 \begin_layout Description
966 Params <TYPE>: line|page
967 \begin_inset Newline newline
970 <QUANTITY>: up|down|<number>
972 \begin_layout Description
973 Origin Abdel, Dec 27 2007
976 \begin_layout Subsection*
979 \begin_layout Description
980 Action Recenters the screen on the current cursor position.
982 \begin_layout Description
983 Syntax screen-recenter
986 \begin_layout Subsection*
987 LFUN_SCREEN_SHOW_CURSOR
989 \begin_layout Description
990 Action Repositions the screen such that the cursor is visible.
992 \begin_layout Description
993 Syntax screen-show-cursor
995 \begin_layout Description
996 Origin vfr, 25 Mar 2009
999 \begin_layout Subsection*
1002 \begin_layout Description
1003 Action Moves the cursor one position logically backwards.
1005 \begin_layout Description
1006 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.
1008 \begin_layout Description
1009 Syntax char-backward
1012 \begin_layout Subsection*
1013 LFUN_CHAR_BACKWARD_SELECT
1015 \begin_layout Description
1016 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1018 \begin_layout Description
1019 Notion See also LFUN_CHAR_BACKWARD.
1021 \begin_layout Description
1022 Syntax char-backward-select
1025 \begin_layout Subsection*
1026 LFUN_CHAR_DELETE_BACKWARD
1028 \begin_layout Description
1029 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1031 \begin_layout Description
1032 Syntax char-delete-backward
1035 \begin_layout Subsection*
1036 LFUN_CHAR_DELETE_FORWARD
1038 \begin_layout Description
1039 Action Deletes one character in the backward direction (usually the "Delete" key).
1041 \begin_layout Description
1042 Syntax char-delete-forward
1045 \begin_layout Subsection*
1048 \begin_layout Description
1049 Action Moves the cursor one position logically forward.
1051 \begin_layout Description
1052 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.
1054 \begin_layout Description
1058 \begin_layout Subsection*
1059 LFUN_CHAR_FORWARD_SELECT
1061 \begin_layout Description
1062 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1064 \begin_layout Description
1065 Notion See also LFUN_CHAR_FORWARD.
1067 \begin_layout Description
1068 Syntax char-forward-select
1071 \begin_layout Subsection*
1074 \begin_layout Description
1075 Action Moves the cursor one position "to the left".
1077 \begin_layout Description
1078 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.
1080 \begin_layout Description
1084 \begin_layout Subsection*
1085 LFUN_CHAR_LEFT_SELECT
1087 \begin_layout Description
1088 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1090 \begin_layout Description
1091 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1093 \begin_layout Description
1094 Syntax char-left-select
1097 \begin_layout Subsection*
1100 \begin_layout Description
1101 Action Moves the cursor one position "to the right".
1103 \begin_layout Description
1104 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.
1106 \begin_layout Description
1110 \begin_layout Subsection*
1111 LFUN_CHAR_RIGHT_SELECT
1113 \begin_layout Description
1114 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1116 \begin_layout Description
1117 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1119 \begin_layout Description
1120 Syntax char-right-select
1123 \begin_layout Subsection*
1126 \begin_layout Description
1127 Action Moves the cursor to the logically previous beginning of a word.
1129 \begin_layout Description
1130 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.
1132 \begin_layout Description
1133 Syntax word-backward
1136 \begin_layout Subsection*
1137 LFUN_WORD_BACKWARD_SELECT
1139 \begin_layout Description
1140 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1142 \begin_layout Description
1143 Notion See also LFUN_WORD_BACKWARD.
1145 \begin_layout Description
1146 Syntax word-backward-select
1149 \begin_layout Subsection*
1150 LFUN_WORD_DELETE_BACKWARD
1152 \begin_layout Description
1153 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1155 \begin_layout Description
1156 Syntax word-delete-backward
1159 \begin_layout Subsection*
1160 LFUN_WORD_DELETE_FORWARD
1162 \begin_layout Description
1163 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1165 \begin_layout Description
1166 Syntax word-delete-forward
1169 \begin_layout Subsection*
1170 LFUN_WORD_FIND_FORWARD
1172 \begin_layout Description
1173 Action Search for a given string in forward direction.
1175 \begin_layout Description
1176 Notion Case sensitive, match words. If no argument given, last search repeated.
1178 \begin_layout Description
1179 Syntax word-find-forward [<STRING>]
1181 \begin_layout Description
1182 Origin Etienne, 16 Feb 1998
1185 \begin_layout Subsection*
1186 LFUN_WORD_FIND_BACKWARD
1188 \begin_layout Description
1189 Action Search for a given string in backward direction.
1191 \begin_layout Description
1192 Notion Case sensitive, match words. If no argument given, last search repeated.
1194 \begin_layout Description
1195 Syntax word-find-backward [<STRING>]
1197 \begin_layout Description
1198 Origin Etienne, 20 Feb 1998
1201 \begin_layout Subsection*
1204 \begin_layout Description
1205 Action Search for next occurence of a string.
1207 \begin_layout Description
1208 Syntax word-find [<DATA>]
1210 \begin_layout Description
1211 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).
1213 \begin_layout Description
1214 Origin Andre, Jan 7 2004
1217 \begin_layout Subsection*
1220 \begin_layout Description
1221 Action Replace a string in the document.
1223 \begin_layout Description
1224 Syntax word-replace [<DATA>]
1226 \begin_layout Description
1227 Params <DATA>: data is of the form "<replace>
1228 \begin_inset Newline newline
1232 \begin_inset Newline newline
1235 <casesensitive> <matchword> <all> <forward>"
1237 \begin_layout Description
1238 Origin Andre, Jan 7 2004
1241 \begin_layout Subsection*
1244 \begin_layout Description
1245 Action Search for next occurence of a pattern.
1247 \begin_layout Description
1248 Syntax word-findadv [<DATA>]
1250 \begin_layout Description
1251 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).
1253 \begin_layout Description
1254 Origin Tommaso, Nov 15 2007
1257 \begin_layout Subsection*
1260 \begin_layout Description
1261 Action Moves the cursor to the logically next beginning of a word.
1263 \begin_layout Description
1264 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.
1266 \begin_layout Description
1270 \begin_layout Subsection*
1271 LFUN_WORD_FORWARD_SELECT
1273 \begin_layout Description
1274 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1276 \begin_layout Description
1277 Notion See also LFUN_WORD_FORWARD.
1279 \begin_layout Description
1280 Syntax word-forward-select
1283 \begin_layout Subsection*
1286 \begin_layout Description
1287 Action Moves the cursor to the next beginning of a word "on the left".
1289 \begin_layout Description
1290 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.
1292 \begin_layout Description
1295 \begin_layout Description
1296 Origin dov, 28 Oct 2007
1299 \begin_layout Subsection*
1300 LFUN_WORD_LEFT_SELECT
1302 \begin_layout Description
1303 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1305 \begin_layout Description
1306 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1308 \begin_layout Description
1309 Syntax word-left-select
1311 \begin_layout Description
1312 Origin dov, 28 Oct 2007
1315 \begin_layout Subsection*
1318 \begin_layout Description
1319 Action Moves the cursor to the next beginning of a word "on the right".
1321 \begin_layout Description
1322 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.
1324 \begin_layout Description
1327 \begin_layout Description
1328 Origin dov, 28 Oct 2007
1331 \begin_layout Subsection*
1332 LFUN_WORD_RIGHT_SELECT
1334 \begin_layout Description
1335 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1337 \begin_layout Description
1338 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1340 \begin_layout Description
1341 Syntax word-right-select
1343 \begin_layout Description
1344 Origin dov, 28 Oct 2007
1347 \begin_layout Subsection*
1350 \begin_layout Description
1351 Action Puts the word where the cursor stands into the selection.
1353 \begin_layout Description
1356 \begin_layout Description
1357 Origin Andre, 11 Sep 2002
1360 \begin_layout Subsection*
1361 LFUN_WORD_CAPITALIZE
1363 \begin_layout Description
1364 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1366 \begin_layout Description
1367 Syntax word-capitalize
1370 \begin_layout Subsection*
1373 \begin_layout Description
1374 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1376 \begin_layout Description
1380 \begin_layout Subsection*
1383 \begin_layout Description
1384 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1386 \begin_layout Description
1390 \begin_layout Subsection*
1391 LFUN_THESAURUS_ENTRY
1393 \begin_layout Description
1394 Action Look up thesaurus entries with respect to the word under the cursor.
1396 \begin_layout Description
1397 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1399 \begin_layout Description
1400 Params <STRING>: word to look up <LANG>: language (see file languages)
1402 \begin_layout Description
1403 Origin Levon, 20 Jul 2001
1406 \begin_layout Subsection*
1409 \begin_layout Description
1410 Action Move the cursor to the beginning of the document.
1412 \begin_layout Description
1416 \begin_layout Subsection*
1417 LFUN_BUFFER_BEGIN_SELECT
1419 \begin_layout Description
1420 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1422 \begin_layout Description
1423 Syntax buffer-begin-select
1426 \begin_layout Subsection*
1429 \begin_layout Description
1430 Action Move the cursor to the end of the document.
1432 \begin_layout Description
1436 \begin_layout Subsection*
1437 LFUN_BUFFER_END_SELECT
1439 \begin_layout Description
1440 Action Move the cursor to the end of the document adding the traversed text to the selection.
1442 \begin_layout Description
1443 Syntax buffer-end-select
1446 \begin_layout Subsection*
1449 \begin_layout Description
1450 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
1452 \begin_layout Description
1455 \begin_layout Description
1456 Origin lasgouttes, 16 Mar 2009
1459 \begin_layout Subsection*
1460 LFUN_INSET_BEGIN_SELECT
1462 \begin_layout Description
1463 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).
1465 \begin_layout Description
1466 Syntax inset-begin-select
1468 \begin_layout Description
1469 Origin lasgouttes, 16 Mar 2009
1472 \begin_layout Subsection*
1475 \begin_layout Description
1476 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
1478 \begin_layout Description
1481 \begin_layout Description
1482 Origin lasgouttes, 16 Mar 2009
1485 \begin_layout Subsection*
1486 LFUN_INSET_END_SELECT
1488 \begin_layout Description
1489 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).
1491 \begin_layout Description
1492 Syntax inset-end-select
1494 \begin_layout Description
1495 Origin lasgouttes, 16 Mar 2009
1498 \begin_layout Subsection*
1499 LFUN_INSET_SELECT_ALL
1501 \begin_layout Description
1502 Action Selects all contents of an inset.
1504 \begin_layout Description
1505 Syntax inset-select-all
1507 \begin_layout Description
1508 Origin vfr, 22 Aug 2009
1511 \begin_layout Subsection*
1514 \begin_layout Description
1515 Action Selects the whole section.
1517 \begin_layout Description
1518 Notion The cursor should be in a section heading before calling this lfun.
1520 \begin_layout Description
1521 Syntax section-select
1523 \begin_layout Description
1524 Origin vfr, 05 May 2009
1527 \begin_layout Subsection*
1530 \begin_layout Description
1531 Action Move the cursor to the begining of the (screen) line.
1533 \begin_layout Description
1537 \begin_layout Subsection*
1538 LFUN_LINE_BEGIN_SELECT
1540 \begin_layout Description
1541 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1543 \begin_layout Description
1544 Syntax line-begin-select
1547 \begin_layout Subsection*
1550 \begin_layout Description
1551 Action Move the cursor to the end of the (screen) line.
1553 \begin_layout Description
1557 \begin_layout Subsection*
1558 LFUN_LINE_END_SELECT
1560 \begin_layout Description
1561 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1563 \begin_layout Description
1564 Syntax line-end-select
1567 \begin_layout Subsection*
1570 \begin_layout Description
1571 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1573 \begin_layout Description
1574 Syntax line-delete-forward
1577 \begin_layout Subsection*
1580 \begin_layout Description
1581 Action Copies to the clipboard the last edit.
1583 \begin_layout Description
1587 \begin_layout Subsection*
1590 \begin_layout Description
1591 Action Cuts to the clipboard.
1593 \begin_layout Description
1597 \begin_layout Subsection*
1600 \begin_layout Description
1601 Action Pastes material (text or picture) from the active clipboard.
1603 \begin_layout Description
1604 Syntax paste [<TYPE>|<NUM>]
1606 \begin_layout Description
1607 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1608 \begin_inset Newline newline
1611 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1614 \begin_layout Subsection*
1615 LFUN_CLIPBOARD_PASTE
1617 \begin_layout Description
1618 Action Pastes text from the active clipboard.
1620 \begin_layout Description
1621 Syntax clipboard-paste [<ARG>]
1623 \begin_layout Description
1624 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1626 \begin_layout Description
1627 Origin baum, 10 Jul 2006
1630 \begin_layout Subsection*
1631 LFUN_PRIMARY_SELECTION_PASTE
1633 \begin_layout Description
1634 Action Pastes the currently text selected text.
1636 \begin_layout Description
1637 Notion Primary selection mechanism is linux-only thing.
1639 \begin_layout Description
1640 Syntax primary-selection-paste [<ARG>]
1642 \begin_layout Description
1643 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1646 \begin_layout Subsection*
1647 LFUN_SELECTION_PASTE
1649 \begin_layout Description
1650 Action Pastes the text in permanent selection.
1652 \begin_layout Description
1653 Syntax selection-paste
1656 \begin_layout Subsection*
1659 \begin_layout Description
1660 Action Undoes the last edit.
1662 \begin_layout Description
1666 \begin_layout Subsection*
1669 \begin_layout Description
1670 Action Redoes the last thing undone.
1672 \begin_layout Description
1676 \begin_layout Subsection*
1679 \begin_layout Description
1680 Action Repeat the given command.
1682 \begin_layout Description
1683 Syntax repeat <COUNT> <LFUN-COMMAND>
1685 \begin_layout Description
1686 Origin Andre, 27 Oct 2003
1689 \begin_layout Subsection*
1690 LFUN_CHARS_TRANSPOSE
1692 \begin_layout Description
1693 Action Transposes the character at the cursor with the one before it.
1695 \begin_layout Description
1696 Syntax chars-transpose
1698 \begin_layout Description
1699 Origin Lgb, 25 Apr 2001
1702 \begin_layout Subsection*
1703 LFUN_DEPTH_DECREMENT
1705 \begin_layout Description
1706 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1708 \begin_layout Description
1709 Syntax depth-decrement
1712 \begin_layout Subsection*
1713 LFUN_DEPTH_INCREMENT
1715 \begin_layout Description
1716 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1718 \begin_layout Description
1719 Syntax depth-increment
1722 \begin_layout Subsection*
1725 \begin_layout Description
1726 Action Toggles the bold font (selection-wise) using mathbf in math.
1728 \begin_layout Description
1732 \begin_layout Subsection*
1733 LFUN_FONT_BOLDSYMBOL
1735 \begin_layout Description
1736 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1738 \begin_layout Description
1739 Syntax font-boldsymbol
1742 \begin_layout Subsection*
1743 LFUN_FONT_TYPEWRITER
1745 \begin_layout Description
1746 Action Toggles the typewriter family font (selection-wise).
1748 \begin_layout Description
1749 Syntax font-typewriter
1752 \begin_layout Subsection*
1755 \begin_layout Description
1756 Action Toggles underline in the font (selection-wise).
1758 \begin_layout Description
1759 Syntax font-underline
1762 \begin_layout Subsection*
1765 \begin_layout Description
1766 Action Toggles double underline in the font (selection-wise).
1768 \begin_layout Description
1769 Syntax font-underunderline
1771 \begin_layout Description
1772 Origin sanda, 5 May 2009
1775 \begin_layout Subsection*
1778 \begin_layout Description
1779 Action Toggles wavy underline in the font (selection-wise).
1781 \begin_layout Description
1782 Syntax font-underwave
1784 \begin_layout Description
1785 Origin sanda, 5 May 2009
1788 \begin_layout Subsection*
1791 \begin_layout Description
1792 Action Toggles strikeout (strike-through) in the font (selection-wise).
1794 \begin_layout Description
1795 Syntax font-strikeout
1797 \begin_layout Description
1798 Origin sanda, 3 May 2009
1801 \begin_layout Subsection*
1804 \begin_layout Description
1805 Action Toggles the emphasis font style (selection-wise).
1807 \begin_layout Description
1811 \begin_layout Subsection*
1814 \begin_layout Description
1815 Action Toggles Noun text style font (selection-wise).
1817 \begin_layout Description
1821 \begin_layout Subsection*
1824 \begin_layout Description
1825 Action Toggles Roman family font (selection-wise).
1827 \begin_layout Description
1831 \begin_layout Subsection*
1834 \begin_layout Description
1835 Action Toggles Sans Serif family font (selection-wise).
1837 \begin_layout Description
1841 \begin_layout Subsection*
1844 \begin_layout Description
1845 Action Toggles Fraktur family font (math-mode, selection-wise).
1847 \begin_layout Description
1850 \begin_layout Description
1851 Origin vermeer, 10 Jan 2002
1854 \begin_layout Subsection*
1857 \begin_layout Description
1858 Action Toggles Italics font shape (math-mode, selection-wise).
1860 \begin_layout Description
1863 \begin_layout Description
1864 Origin vermeer, 10 Jan 2002
1867 \begin_layout Subsection*
1870 \begin_layout Description
1871 Action Reverts the settings of the font to the default values (selection-wise).
1873 \begin_layout Description
1877 \begin_layout Subsection*
1880 \begin_layout Description
1881 Action Sets font size according to lyx format string.
1883 \begin_layout Description
1884 Syntax font-size <SIZE>
1886 \begin_layout Description
1887 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1888 \begin_inset Newline newline
1891 largest|huge|giant|increase|decrease|default
1894 \begin_layout Subsection*
1895 LFUN_TEXTSTYLE_APPLY
1897 \begin_layout Description
1898 Action Toggle user-defined (=last-time used) text style.
1900 \begin_layout Description
1901 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1903 \begin_layout Description
1904 Syntax textstyle-apply
1906 \begin_layout Description
1907 Origin leeming, 12 Mar 2003
1910 \begin_layout Subsection*
1911 LFUN_TEXTSTYLE_UPDATE
1913 \begin_layout Description
1914 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1916 \begin_layout Description
1917 Syntax textstyle-update <FONT_INFO>
1919 \begin_layout Description
1920 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1921 \begin_inset Newline newline
1924 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1926 \begin_layout Description
1927 Origin leeming, 12 Mar 2003
1930 \begin_layout Subsection*
1931 LFUN_SCREEN_FONT_UPDATE
1933 \begin_layout Description
1934 Action Update fonts and its metrics.
1936 \begin_layout Description
1937 Notion Automatically called after zoom, dpi, font names, or norm change.
1939 \begin_layout Description
1940 Syntax screen-font-update
1942 \begin_layout Description
1943 Origin ARRae, 13 Aug 2000
1946 \begin_layout Subsection*
1949 \begin_layout Description
1950 Action Returns the info about the current font.
1952 \begin_layout Description
1956 \begin_layout Subsection*
1957 LFUN_CITATION_INSERT
1959 \begin_layout Description
1960 Action Inserts citation from loaded citation database.
1962 \begin_layout Description
1963 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1965 \begin_layout Description
1966 Params <KEY>: Citation (shortcut listed in available citations).
1967 \begin_inset Newline newline
1970 <TEXT_BEFORE>: text which should appear before citation.
1972 \begin_layout Description
1973 Origin AAS, 97-02-23
1976 \begin_layout Subsection*
1977 LFUN_BIBTEX_DATABASE_ADD
1979 \begin_layout Description
1980 Action Adds database, which will be used for bibtex citations.
1982 \begin_layout Description
1983 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1985 \begin_layout Description
1986 Syntax bibtex-database-add <DATABASE-NAME>
1988 \begin_layout Description
1989 Origin Ale, 30 May 1997
1992 \begin_layout Subsection*
1993 LFUN_BIBTEX_DATABASE_DEL
1995 \begin_layout Description
1996 Action Adds database, which will be used for bibtex citations.
1998 \begin_layout Description
1999 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2001 \begin_layout Description
2002 Syntax bibtex-database-del <DATABASE-NAME>
2004 \begin_layout Description
2005 Origin Ale, 30 May 1997
2008 \begin_layout Subsection*
2011 \begin_layout Description
2012 Action Sets the layout (that is, environment) for the current paragraph.
2014 \begin_layout Description
2015 Syntax layout <LAYOUT>
2017 \begin_layout Description
2018 Params <LAYOUT>: the layout to use
2021 \begin_layout Subsection*
2022 LFUN_LAYOUT_PARAGRAPH
2024 \begin_layout Description
2025 Action Launches the paragraph settings dialog.
2027 \begin_layout Description
2028 Syntax layout-paragraph
2031 \begin_layout Subsection*
2034 \begin_layout Description
2035 Action Launches the tabular settings dialog.
2037 \begin_layout Description
2038 Syntax layout-tabular
2040 \begin_layout Description
2041 Origin Jug, 31 Jul 2000
2044 \begin_layout Subsection*
2045 LFUN_DROP_LAYOUTS_CHOICE
2047 \begin_layout Description
2048 Action Displays list of layout choices.
2050 \begin_layout Description
2051 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
2053 \begin_layout Description
2054 Syntax drop-layouts-choice
2057 \begin_layout Subsection*
2058 LFUN_LAYOUT_MODULES_CLEAR
2060 \begin_layout Description
2061 Action Clears the module list.
2063 \begin_layout Description
2064 Notion Clears the list of included modules for the current buffer.
2066 \begin_layout Description
2067 Syntax layout-modules-clear
2069 \begin_layout Description
2070 Origin rgh, 25 August 2007
2073 \begin_layout Subsection*
2074 LFUN_LAYOUT_MODULE_ADD
2076 \begin_layout Description
2077 Action Adds a module.
2079 \begin_layout Description
2080 Notion Adds a module to the list of included modules for the current buffer.
2082 \begin_layout Description
2083 Syntax layout-module-add <MODULE>
2085 \begin_layout Description
2086 Params <MODULE>: the module to be added
2088 \begin_layout Description
2089 Origin rgh, 25 August 2007
2092 \begin_layout Subsection*
2095 \begin_layout Description
2096 Action Reloads layout information.
2098 \begin_layout Description
2099 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.
2101 \begin_layout Description
2102 Syntax layout-reload
2104 \begin_layout Description
2105 Origin rgh, 3 September 2007
2108 \begin_layout Subsection*
2109 LFUN_TEXTCLASS_APPLY
2111 \begin_layout Description
2112 Action Sets the text class for the current buffer.
2114 \begin_layout Description
2115 Syntax textclass-apply <TEXTCLASS>
2117 \begin_layout Description
2118 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2121 \begin_layout Subsection*
2124 \begin_layout Description
2125 Action Loads information for a textclass from disk.
2127 \begin_layout Description
2128 Syntax textclass-load <TEXTCLASS>
2130 \begin_layout Description
2131 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2134 \begin_layout Subsection*
2137 \begin_layout Description
2138 Action Disable selecting of text-region.
2140 \begin_layout Description
2144 \begin_layout Subsection*
2147 \begin_layout Description
2148 Action Enable selecting of text-region.
2150 \begin_layout Description
2151 Notion After enabling you can simply move arrow keys to get selected region.
2153 \begin_layout Description
2157 \begin_layout Subsection*
2160 \begin_layout Description
2161 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2163 \begin_layout Description
2166 \begin_layout Description
2167 Origin Andre, May 5 2006
2170 \begin_layout Subsection*
2173 \begin_layout Description
2174 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2176 \begin_layout Description
2177 Syntax math-delim [<LEFT>] [<RIGHT>]
2179 \begin_layout Description
2180 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.
2182 \begin_layout Description
2183 Sample math-delim { rangle
2185 \begin_layout Description
2186 Origin Alejandro, 18 Jun 1996
2189 \begin_layout Subsection*
2192 \begin_layout Description
2193 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2195 \begin_layout Description
2196 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2198 \begin_layout Description
2199 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2200 \begin_inset Newline newline
2203 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2205 \begin_layout Description
2206 Sample math-bigdelim "Bigl" "
2212 \begin_layout Description
2213 Origin Enrico & Georg, 7 May 2006
2216 \begin_layout Subsection*
2219 \begin_layout Description
2220 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2222 \begin_layout Description
2223 Syntax math-display [<ARG>]
2225 \begin_layout Description
2226 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2228 \begin_layout Description
2229 Origin Alejandro, 18 Jun 1996
2232 \begin_layout Subsection*
2235 \begin_layout Description
2236 Action Inserts math objects and symbols.
2238 \begin_layout Description
2239 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
2241 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
2243 frac{x}{y}" replaces "abc" with "
2245 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.
2247 \begin_layout Description
2248 Syntax math-insert <ARG>
2250 \begin_layout Description
2251 Params <ARG>: Symbol or LaTeX code to be inserted.
2254 \begin_layout Subsection*
2257 \begin_layout Description
2258 Action Enters subscript expression in math expression.
2260 \begin_layout Description
2261 Syntax math-subscript
2263 \begin_layout Description
2264 Origin vermeer, 12 Dec 2001
2267 \begin_layout Subsection*
2268 LFUN_MATH_SUPERSCRIPT
2270 \begin_layout Description
2271 Action Enters subscript expression in math expression.
2273 \begin_layout Description
2274 Syntax math-superscript
2276 \begin_layout Description
2277 Origin vermeer, 12 Dec 2001
2280 \begin_layout Subsection*
2283 \begin_layout Description
2284 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.
2286 \begin_layout Description
2287 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2289 \begin_layout Description
2290 Syntax math-limits [<STATE>]
2292 \begin_layout Description
2293 Params <STATE>: limits|nolimits
2296 \begin_layout Subsection*
2299 \begin_layout Description
2300 Action Inserts a math macro definition at the cursor position in the text.
2302 \begin_layout Description
2303 Syntax math-macro <NAME> [<NARGS>] [def]
2305 \begin_layout Description
2306 Params <NAME>: The name of the macro, e.g. "mymacro".
2307 \begin_inset Newline newline
2310 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2312 \begin_layout Description
2313 Origin ale, 10 May 1997; sts, 21 Dec 2007
2316 \begin_layout Subsection*
2319 \begin_layout Description
2320 Action Mutates the type of math inset to the newly selected one.
2322 \begin_layout Description
2323 Syntax math-mutate <TYPE>
2325 \begin_layout Description
2326 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2328 \begin_layout Description
2329 Origin Andre, 23 May 2001
2332 \begin_layout Subsection*
2335 \begin_layout Description
2336 Action Inserts space into math expression.
2338 \begin_layout Description
2339 Notion Use spacebar after entering this space to change type of space.
2341 \begin_layout Description
2342 Syntax math-space [<TYPE>] [<LEN>]
2344 \begin_layout Description
2345 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2346 \begin_inset Newline newline
2349 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2350 \begin_inset Newline newline
2353 custom space: hspace
2354 \begin_inset Newline newline
2357 "," used by default.
2358 \begin_inset Newline newline
2361 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2362 \begin_inset Newline newline
2365 <LEN>: length for custom spaces (hspace)
2367 \begin_layout Description
2368 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2371 \begin_layout Subsection*
2374 \begin_layout Description
2375 Action Inserts a matrix.
2377 \begin_layout Description
2378 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2380 \begin_layout Description
2381 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).
2383 \begin_layout Description
2384 Sample math-matrix 3 3 bccc
2387 \begin_layout Subsection*
2388 LFUN_MATH_AMS_MATRIX
2390 \begin_layout Description
2391 Action Inserts a matrix.
2393 \begin_layout Description
2394 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
2396 \begin_layout Description
2397 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
2399 \begin_layout Description
2400 Sample math-ams-matrix 3 3 bmatrix
2403 \begin_layout Subsection*
2406 \begin_layout Description
2407 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.
2409 \begin_layout Description
2410 Notion If there is some selected text, it puts the text inside created math box.
2412 \begin_layout Description
2413 Syntax math-mode [on|<ARG>]
2415 \begin_layout Description
2416 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2417 \begin_inset Newline newline
2420 "on": allow only entering of math mode from text mode.
2422 \begin_layout Description
2423 Origin Alejandro, 4 Jun 1996
2426 \begin_layout Subsection*
2429 \begin_layout Description
2430 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2432 \begin_layout Description
2433 Notion If there is any selected text, then it is moved inside the created regexp inset.
2435 \begin_layout Description
2436 Syntax regexp-mode [<ARG>]
2438 \begin_layout Description
2439 Params <ARG>: eventual argument (regular expression).
2441 \begin_layout Description
2442 Origin Tommaso, 4 Oct 2008
2445 \begin_layout Subsection*
2446 LFUN_MATH_NUMBER_LINE_TOGGLE
2448 \begin_layout Description
2449 Action Toggles numbering of the current formula line.
2451 \begin_layout Description
2452 Notion Must be in display formula mode.
2454 \begin_layout Description
2455 Syntax math-number-line-toggle
2457 \begin_layout Description
2458 Origin Alejandro, 18 Jun 1996
2461 \begin_layout Subsection*
2462 LFUN_MATH_NUMBER_TOGGLE
2464 \begin_layout Description
2465 Action Toggles numbering/labeling of the current formula.
2467 \begin_layout Description
2468 Notion Must be in display formula mode.
2470 \begin_layout Description
2471 Syntax math-number-toggle
2473 \begin_layout Description
2474 Origin Alejandro, 4 Jun 1996
2477 \begin_layout Subsection*
2480 \begin_layout Description
2481 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2483 \begin_layout Description
2484 Notion Selection can be used to determine the input for the external program.
2486 \begin_layout Description
2487 Syntax math-extern <LANG> [<COMMAND>]
2489 \begin_layout Description
2490 Params <LANG>: octave|maxima|maple|mathematica|script
2491 \begin_inset Newline newline
2494 where "script" stands fot the external script (normalized expression will be passed)
2496 \begin_layout Description
2497 Sample math-extern maple simplify
2499 \begin_layout Description
2500 Origin Andre, 24 Apr 2001
2503 \begin_layout Subsection*
2506 \begin_layout Description
2507 Action Changes arbitrarily the size used by math fonts inside a context.
2509 \begin_layout Description
2510 Notion Provides an interface to the LaTeX math mode font size commands.
2512 \begin_layout Description
2513 Syntax math-size <STYLE>
2515 \begin_layout Description
2526 \begin_layout Description
2527 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2530 \begin_layout Subsection*
2531 LFUN_MATH_FONT_STYLE
2533 \begin_layout Description
2534 Action Changes the text style used in math.
2536 \begin_layout Description
2537 Syntax math-font-style <STYLE>
2539 \begin_layout Description
2540 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2542 \begin_layout Description
2543 Origin vfr, 9 jan 2009
2546 \begin_layout Subsection*
2547 LFUN_MATH_MACRO_UNFOLD
2549 \begin_layout Description
2550 Action Unfold a Math Macro.
2552 \begin_layout Description
2553 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2557 \begin_layout Description
2558 Syntax math-macro-unfold
2560 \begin_layout Description
2561 Origin sts, 06 January 2008
2564 \begin_layout Subsection*
2565 LFUN_MATH_MACRO_FOLD
2567 \begin_layout Description
2568 Action Fold a Math Macro.
2570 \begin_layout Description
2571 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2575 \begin_layout Description
2576 Syntax math-macro-fold
2578 \begin_layout Description
2579 Origin sts, 06 January 2008
2582 \begin_layout Subsection*
2583 LFUN_MATH_MACRO_ADD_PARAM
2585 \begin_layout Description
2586 Action Add a parameter.
2588 \begin_layout Description
2589 Notion Add a parameter to a Math Macro.
2591 \begin_layout Description
2592 Syntax math-macro-add-param <NUM>
2594 \begin_layout Description
2595 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.
2597 \begin_layout Description
2598 Origin sts, 06 January 2008
2601 \begin_layout Subsection*
2602 LFUN_MATH_MACRO_REMOVE_PARAM
2604 \begin_layout Description
2605 Action Remove the last parameter.
2607 \begin_layout Description
2608 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2610 \begin_layout Description
2611 Syntax math-macro-remove-param <NUM>
2613 \begin_layout Description
2614 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2616 \begin_layout Description
2617 Origin sts, 06 January 2008
2620 \begin_layout Subsection*
2621 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2623 \begin_layout Description
2624 Action Append a greedy parameter.
2626 \begin_layout Description
2627 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2629 \begin_layout Description
2630 Syntax math-macro-append-greedy-param
2632 \begin_layout Description
2633 Origin sts, 06 January 2008
2636 \begin_layout Subsection*
2637 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2639 \begin_layout Description
2640 Action Remove a greedy parameter.
2642 \begin_layout Description
2643 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.
2645 \begin_layout Description
2646 Syntax math-macro-remove-greedy-param
2648 \begin_layout Description
2649 Origin sts, 06 January 2008
2652 \begin_layout Subsection*
2653 LFUN_MATH_MACRO_MAKE_OPTIONAL
2655 \begin_layout Description
2656 Action Make a parameter optional.
2658 \begin_layout Description
2659 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2661 \begin_layout Description
2662 Syntax math-macro-make-optional
2664 \begin_layout Description
2665 Origin sts, 06 January 2008
2668 \begin_layout Subsection*
2669 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2671 \begin_layout Description
2672 Action Make a parameter non-optional.
2674 \begin_layout Description
2675 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.
2677 \begin_layout Description
2678 Syntax math-macro-make-nonoptional
2680 \begin_layout Description
2681 Origin sts, 06 January 2008
2684 \begin_layout Subsection*
2685 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2687 \begin_layout Description
2688 Action Add an optional parameter.
2690 \begin_layout Description
2691 Notion Insert an optional parameter just behind the already existing optional parameters.
2693 \begin_layout Description
2694 Syntax math-macro-add-optional-param
2696 \begin_layout Description
2697 Origin sts, 06 January 2008
2700 \begin_layout Subsection*
2701 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2703 \begin_layout Description
2704 Action Remove the last optional parameter.
2706 \begin_layout Description
2707 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2709 \begin_layout Description
2710 Syntax math-macro-remove-optional-param
2712 \begin_layout Description
2713 Origin sts, 06 January 2008
2716 \begin_layout Subsection*
2717 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2719 \begin_layout Description
2720 Action Add a greedy optional parameter.
2722 \begin_layout Description
2723 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2725 \begin_layout Description
2726 Syntax math-macro-add-greedy-optional-param
2728 \begin_layout Description
2729 Origin sts, 06 January 2008
2732 \begin_layout Subsection*
2733 LFUN_IN_MATHMACROTEMPLATE
2735 \begin_layout Description
2736 Action Only active in Math Macro definition.
2738 \begin_layout Description
2739 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.
2741 \begin_layout Description
2742 Syntax in-mathmacrotemplate
2744 \begin_layout Description
2745 Origin sts, 06 January 2008
2748 \begin_layout Subsection*
2749 LFUN_PARAGRAPH_MOVE_DOWN
2751 \begin_layout Description
2752 Action Moves the current paragraph downwards in the document.
2754 \begin_layout Description
2755 Syntax paragraph-move-down
2757 \begin_layout Description
2758 Origin Edwin, 8 Apr 2006
2761 \begin_layout Subsection*
2762 LFUN_PARAGRAPH_MOVE_UP
2764 \begin_layout Description
2765 Action Moves the current paragraph upwards in the document.
2767 \begin_layout Description
2768 Syntax paragraph-move-up
2770 \begin_layout Description
2771 Origin Edwin, 8 Apr 2006
2774 \begin_layout Subsection*
2777 \begin_layout Description
2778 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2780 \begin_layout Description
2783 \begin_layout Description
2784 Origin Asger, 1 Oct 1996
2787 \begin_layout Subsection*
2788 LFUN_PARAGRAPH_UP_SELECT
2790 \begin_layout Description
2791 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2793 \begin_layout Description
2794 Syntax paragraph-up-select
2796 \begin_layout Description
2797 Origin Asger, 1 Oct 1996
2800 \begin_layout Subsection*
2803 \begin_layout Description
2804 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2806 \begin_layout Description
2807 Syntax paragraph-down
2809 \begin_layout Description
2810 Origin Asger, 1 Oct 1996
2813 \begin_layout Subsection*
2814 LFUN_PARAGRAPH_DOWN_SELECT
2816 \begin_layout Description
2817 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2819 \begin_layout Description
2820 Syntax paragraph-down-select
2822 \begin_layout Description
2823 Origin Asger, 1 Oct 1996
2826 \begin_layout Subsection*
2829 \begin_layout Description
2830 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2832 \begin_layout Description
2833 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).
2835 \begin_layout Description
2836 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2838 \begin_layout Description
2839 Params <PAR_ID_NUMBER>: paragraph id
2840 \begin_inset Newline newline
2843 <POSITION_IN_PAR>: desired position within the paragraph
2845 \begin_layout Description
2846 Origin Dekel, 26 Aug 2000
2849 \begin_layout Subsection*
2850 LFUN_BREAK_PARAGRAPH
2852 \begin_layout Description
2853 Action Breaks the current paragraph at the current location.
2855 \begin_layout Description
2856 Notion Removes the selection.
2858 \begin_layout Description
2859 Syntax break-paragraph [<LAYOUT>]
2861 \begin_layout Description
2862 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2865 \begin_layout Subsection*
2866 LFUN_PARAGRAPH_PARAMS
2868 \begin_layout Description
2869 Action Change paragraph settings.
2871 \begin_layout Description
2872 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.
2874 \begin_layout Description
2875 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2877 \begin_layout Description
2887 \begin_inset Newline newline
2892 paragraph_spacing default|single|onehalf|double|other SIZE
2893 \begin_inset Newline newline
2898 align block|left|right|center|default
2899 \begin_inset Newline newline
2904 labelwidthstring WIDTH|
2908 \begin_layout Description
2909 Origin rgh, Aug 15 2007
2912 \begin_layout Subsection*
2913 LFUN_PARAGRAPH_PARAMS_APPLY
2915 \begin_layout Description
2916 Action Change paragraph settings.
2918 \begin_layout Description
2919 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2921 \begin_layout Description
2922 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2924 \begin_layout Description
2925 Params For parameters see LFUN_PARAGRAPH_PARAMS
2927 \begin_layout Description
2928 Origin leeming, 30 Mar 2004
2931 \begin_layout Subsection*
2932 LFUN_PARAGRAPH_UPDATE
2934 \begin_layout Description
2935 Action Updates the values inside the paragraph dialog from the paragraph.
2937 \begin_layout Description
2938 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2940 \begin_layout Description
2941 Origin leeming, 13 Mar 2003
2944 \begin_layout Subsection*
2947 \begin_layout Description
2948 Action Move the current group in the upward direction in the structure of the document.
2950 \begin_layout Description
2951 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2953 \begin_layout Description
2956 \begin_layout Description
2957 Origin Vermeer, 23 Mar 2006
2960 \begin_layout Subsection*
2963 \begin_layout Description
2964 Action Move the current group in the downward direction in the structure of the document.
2966 \begin_layout Description
2967 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2969 \begin_layout Description
2972 \begin_layout Description
2973 Origin Vermeer, 23 Mar 2006
2976 \begin_layout Subsection*
2979 \begin_layout Description
2980 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2982 \begin_layout Description
2983 Notion Part -> Chapter -> Section -> etc.
2985 \begin_layout Description
2988 \begin_layout Description
2989 Origin Vermeer, 23 Mar 2006
2992 \begin_layout Subsection*
2995 \begin_layout Description
2996 Action Moves the current group in the upward direction in the hierarchy of the document structure.
2998 \begin_layout Description
2999 Notion Part <- Chapter <- Section <- etc.
3001 \begin_layout Description
3004 \begin_layout Description
3005 Origin Vermeer, 23 Mar 2006
3008 \begin_layout Subsection*
3009 LFUN_OUTLINE_DRAGMOVE
3011 \begin_layout Description
3012 Action Moves the document section associated with the specified heading to a specified location. Both the heading and the target paragraph are specified by the paragraph ID numbers.
3014 \begin_layout Description
3015 Notion The heading is a paragraph with style Part/Chapter/Section/ etc. Id number of the paragraph is not the sequential number seen on the screen, but an internal number that is unique for all opened buffers (documents).
3017 \begin_layout Description
3018 Syntax outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
3020 \begin_layout Description
3021 Params <PAR_ID_SECTION>: paragraph id of the section heading which is to be moved.
3022 \begin_inset Newline newline
3025 <PAR_ID_DROP_POSITION>: the paragraph id where the section will be moved to.
3027 \begin_layout Description
3028 Origin Rob Oakes, 22 June 2009
3031 \begin_layout Subsection*
3034 \begin_layout Description
3035 Action Edit the inset at cursor with an external application, if one is attributed.
3037 \begin_layout Description
3038 Syntax inset-edit [<INSET_PARAMS>]
3040 \begin_layout Description
3041 Params <INSET_PARAMS>: Parameters for the inset.
3042 \begin_inset Newline newline
3045 Currently only the filename will be considered.
3047 \begin_layout Description
3048 Origin JSpitzm, 27 Apr 2006
3051 \begin_layout Subsection*
3054 \begin_layout Description
3055 Action Inserts table into the document.
3057 \begin_layout Description
3058 Syntax tabular-insert [<ROWS> <COLUMNS>]
3060 \begin_layout Description
3061 Params In case no arguments are given show insert dialog.
3063 \begin_layout Description
3064 Origin Jug, 12 Apr 2000
3067 \begin_layout Subsection*
3068 LFUN_TABULAR_FEATURE
3070 \begin_layout Description
3071 Action Sets various features to the table/cell on the current cursor position.
3073 \begin_layout Description
3074 Notion Various math-environment features are handled here as well, e.g. add-vline-left/right for the Grid/Array environment
3076 \begin_layout Description
3077 Syntax tabular-feature <FEATURE> [<ARG>]
3079 \begin_layout Description
3080 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| align-left|align-right|align-center|align-block|valign-top|valign-bottom| valign-middle|longtabular-align-left|longtabular-align-center| longtabular-align-right|m-align-left|m-align-right|m-align-center| m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines| unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| set-special-column|set-special-multi|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
3081 \begin_inset Newline newline
3084 <ARG>: additional argument for some commands, use debug mode to explore its values.
3086 \begin_layout Description
3087 Origin Jug, 28 Jul 2000
3090 \begin_layout Subsection*
3093 \begin_layout Description
3094 Action Moves the cursor to the previous cell inside the table.
3096 \begin_layout Description
3097 Syntax cell-backward
3099 \begin_layout Description
3100 Origin Jug, 22 May 2000
3103 \begin_layout Subsection*
3106 \begin_layout Description
3107 Action Moves the cursor to the next cell inside the table.
3109 \begin_layout Description
3113 \begin_layout Subsection*
3116 \begin_layout Description
3117 Action Splits cell and shifts right part to the next cell (inside the math grid).
3119 \begin_layout Description
3122 \begin_layout Description
3123 Origin Ale, 15 May 1997
3126 \begin_layout Subsection*
3129 \begin_layout Description
3130 Action Register the document as an file inside version control system (RCS, CVS).
3132 \begin_layout Description
3133 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3134 \begin_inset Newline newline
3137 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3139 \begin_layout Description
3142 \begin_layout Description
3143 Origin Lgb, 1 Jul 1997
3146 \begin_layout Subsection*
3149 \begin_layout Description
3150 Action Checks-in/commits the changes of the registered file to the repository.
3152 \begin_layout Description
3153 Notion In RCS case this also unlocks the file.
3155 \begin_layout Description
3158 \begin_layout Description
3159 Origin Lgb, 1 Jul 1997
3162 \begin_layout Subsection*
3165 \begin_layout Description
3166 Action Checks-out the document for edit (and locks it for RCS).
3168 \begin_layout Description
3169 Notion This is implemented only for RCS and SVN, not CVS.
3171 \begin_layout Description
3174 \begin_layout Description
3175 Origin Lgb, 1 Jul 1997
3178 \begin_layout Subsection*
3181 \begin_layout Description
3182 Action Reverts the document to the last check-in/commit in VCS.
3184 \begin_layout Description
3187 \begin_layout Description
3188 Origin Lgb, 1 Jul 1997
3191 \begin_layout Subsection*
3194 \begin_layout Description
3195 Action Undo last check-in.
3197 \begin_layout Description
3198 Notion This is currently implemented only for RCS.
3200 \begin_layout Description
3203 \begin_layout Description
3204 Origin Lgb, 1 Jul 1997
3207 \begin_layout Subsection*
3210 \begin_layout Description
3211 Action Executes external command. This command is intended to support additional VCS commands.
3213 \begin_layout Description
3214 Syntax vc-command <FLAG> <PATH> <COMMAND>
3216 \begin_layout Description
3217 Params <FLAG>: Flags for the command can be combined together.
3218 \begin_inset Newline newline
3221 U - dUmmy - no flags
3222 \begin_inset Newline newline
3225 D - Doc - need document loaded to proceed
3226 \begin_inset Newline newline
3229 I - dIrty - mark document dirty
3230 \begin_inset Newline newline
3233 R - Reload - ensure that the document is saved and reload it after command execution
3234 \begin_inset Newline newline
3237 M - Message - ask for input string (commit message)
3238 \begin_inset Newline newline
3241 <PATH>: path where to start. $$p will be replaced by the current document path.
3242 \begin_inset Newline newline
3245 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
3247 \begin_layout Description
3248 Sample vc-command DR $$p "svn up"
3250 \begin_layout Description
3251 Origin sanda, 13 Jan 2009
3254 \begin_layout Subsection*
3255 LFUN_VC_LOCKING_TOGGLE
3257 \begin_layout Description
3258 Action Toggles the locking property of the edited file.
3260 \begin_layout Description
3261 Notion This is currently implemented only for SVN.
3263 \begin_layout Description
3264 Syntax vc-locking-toggle
3266 \begin_layout Description
3267 Origin sanda, 25 Jun 2009
3270 \begin_layout Subsection*
3273 \begin_layout Description
3274 Action Update the local archive directory in which resides the current document with the remote repository.
3276 \begin_layout Description
3277 Notion This is currently implemented only for SVN.
3279 \begin_layout Description
3280 Syntax vc-repo-update
3282 \begin_layout Description
3283 Origin sanda, 16 Oct 2009
3286 \begin_layout Subsection*
3289 \begin_layout Description
3290 Action Toggles change tracking to on/off.
3292 \begin_layout Description
3293 Syntax changes-track
3295 \begin_layout Description
3296 Origin levon, 1 Oct 2002
3299 \begin_layout Subsection*
3302 \begin_layout Description
3303 Action Toggles showing of change tracking in typesetted output.
3305 \begin_layout Description
3306 Syntax changes-output
3308 \begin_layout Description
3309 Origin jspitzm, 21 Jan 2005
3312 \begin_layout Subsection*
3315 \begin_layout Description
3316 Action Moves the cursor to the position of the next change of the change tracking records.
3318 \begin_layout Description
3321 \begin_layout Description
3322 Origin schmitt, 4 Oct 2006
3325 \begin_layout Subsection*
3326 LFUN_CHANGE_PREVIOUS
3328 \begin_layout Description
3329 Action Moves the cursor to the position of the previous change of the change tracking records.
3331 \begin_layout Description
3332 Syntax change-previous
3334 \begin_layout Description
3335 Origin vfr, 4 Apr 2009
3338 \begin_layout Subsection*
3341 \begin_layout Description
3342 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3344 \begin_layout Description
3345 Syntax changes-merge
3347 \begin_layout Description
3348 Origin Levon, 16 Oct 2002
3351 \begin_layout Subsection*
3354 \begin_layout Description
3355 Action Accepts tracked change inside the selection.
3357 \begin_layout Description
3358 Syntax change-accept
3360 \begin_layout Description
3361 Origin Levon, 16 Oct 2002
3364 \begin_layout Subsection*
3367 \begin_layout Description
3368 Action Rejects tracked change inside the selection.
3370 \begin_layout Description
3371 Syntax change-accept
3373 \begin_layout Description
3374 Origin Levon, 16 Oct 2002
3377 \begin_layout Subsection*
3378 LFUN_ALL_CHANGES_ACCEPT
3380 \begin_layout Description
3381 Action Accepts all tracked changes in the document.
3383 \begin_layout Description
3384 Syntax all-changes-accept
3386 \begin_layout Description
3387 Origin Levon, 16 Oct 2002
3390 \begin_layout Subsection*
3391 LFUN_ALL_CHANGES_REJECT
3393 \begin_layout Description
3394 Action Rejects all tracked changes in the document.
3396 \begin_layout Description
3397 Notion Reject does not work recursively; the user may have to repeat the operation.
3399 \begin_layout Description
3400 Syntax all-changes-reject
3402 \begin_layout Description
3403 Origin Levon, 16 Oct 2002
3406 \begin_layout Subsection*
3409 \begin_layout Description
3410 Action Apply data for an inset.
3412 \begin_layout Description
3413 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.
3415 \begin_layout Description
3416 Syntax inset-apply <ARGS>
3418 \begin_layout Description
3419 Params See LFUN_INSET_INSERT .
3422 \begin_layout Subsection*
3425 \begin_layout Description
3426 Action Dissolve the current inset into text.
3428 \begin_layout Description
3429 Syntax inset-dissolve [<INSET>]
3431 \begin_layout Description
3432 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.
3433 \begin_inset Newline newline
3436 For values see lyx::InsetLayout::lyxtype_ .
3438 \begin_layout Description
3439 Origin JSpitz, 7 Aug 2006
3442 \begin_layout Subsection*
3445 \begin_layout Description
3446 Action Insert new inset (type given by the parameters).
3448 \begin_layout Description
3449 Syntax inset-insert <INSET> <ARGS>
3451 \begin_layout Description
3452 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|include|index|label|nomencl|vspace|ref|toc>
3453 \begin_inset Newline newline
3456 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3458 \begin_layout Description
3459 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3462 \begin_inset Newline newline
3465 where <label name> is the name of the referenced label and <Format> is one of the following:
3466 \begin_inset Newline newline
3470 \begin_inset Newline newline
3473 eqref -- (<reference>)
3474 \begin_inset Newline newline
3478 \begin_inset Newline newline
3481 vpageref -- on <page>
3482 \begin_inset Newline newline
3485 vref -- <reference> on <page>
3486 \begin_inset Newline newline
3489 prettyref -- Formatted reference
3492 \begin_layout Subsection*
3495 \begin_layout Description
3496 Action Modify existing inset.
3498 \begin_layout Description
3499 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3501 \begin_layout Description
3502 Syntax inset-modify <INSET> <ARGS>
3504 \begin_layout Description
3505 Params See LFUN_INSET_INSERT for further details.
3508 \begin_layout Subsection*
3509 LFUN_NEXT_INSET_MODIFY
3511 \begin_layout Description
3512 Action Modify the inset at cursor position, if there is one.
3514 \begin_layout Description
3515 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3517 \begin_layout Description
3518 Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
3520 \begin_layout Description
3521 Params See LFUN_INSET_INSERT for further details.
3523 \begin_layout Description
3524 Origin JSpitzm, 23 Mar 2008
3527 \begin_layout Subsection*
3528 LFUN_INSET_DIALOG_UPDATE
3530 \begin_layout Description
3531 Action Updates the values inside the dialog from the inset.
3533 \begin_layout Description
3534 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3536 \begin_layout Description
3537 Params <DIALOG-NAME>
3539 \begin_layout Description
3540 Origin leeming, 25 Feb 2003
3543 \begin_layout Subsection*
3546 \begin_layout Description
3547 Action Open the inset's properties dialog.
3549 \begin_layout Description
3550 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
3552 \begin_layout Description
3553 Syntax inset-settings <INSET>
3555 \begin_layout Description
3556 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float| graphics|href|include|index|index_print|label|listings| note|phantom|ref|space|tabular|vspace|wrap>.
3559 \begin_layout Subsection*
3562 \begin_layout Description
3563 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3565 \begin_layout Description
3566 Syntax inset-toggle [<ARG>]
3568 \begin_layout Description
3569 Params <ARG>: <open|close|toggle|assign>.
3570 \begin_inset Newline newline
3573 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3574 \begin_inset Newline newline
3577 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3579 \begin_layout Description
3580 Origin lasgouttes, 19 Jul 2001
3583 \begin_layout Subsection*
3584 LFUN_ALL_INSETS_TOGGLE
3586 \begin_layout Description
3587 Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
3589 \begin_layout Description
3590 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
3592 \begin_layout Description
3593 Syntax all-insets-toggle [<STATE>] [<INSET>]
3595 \begin_layout Description
3596 Params <STATE>: <toggle|open|close|assign> default: toggle
3597 \begin_inset Newline newline
3600 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
3602 \begin_layout Description
3603 Origin leeming, 30 Mar 2004
3606 \begin_layout Subsection*
3609 \begin_layout Description
3610 Action Apply the given commands on insets of a given name.
3612 \begin_layout Description
3613 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.
3615 \begin_layout Description
3616 Syntax inset-forall <NAME> <LFUN-COMMAND>
3617 \begin_inset Newline newline
3620 <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.
3622 \begin_layout Description
3623 Sample Remove all index insets:
3624 \begin_inset Newline newline
3627 inset-forall Index delete-char-forward
3628 \begin_inset Newline newline
3631 Close all Notes (also works for a particular branch, for example):
3632 \begin_inset Newline newline
3635 inset-forall Note inset-toggle close
3636 \begin_inset Newline newline
3639 Try to put LyX in an infinite loop if there is at least a Note:
3640 \begin_inset Newline newline
3643 inset-forall Note char-backward
3645 \begin_layout Description
3646 Origin lasgouttes, 27 Nov 2009
3649 \begin_layout Subsection*
3650 LFUN_GRAPHICS_RELOAD
3652 \begin_layout Description
3653 Action Reloads the image if necessary.
3655 \begin_layout Description
3656 Syntax graphics-reload
3658 \begin_layout Description
3659 Origin vfr, 10 Aug 2009
3662 \begin_layout Subsection*
3663 LFUN_SET_GRAPHICS_GROUP
3665 \begin_layout Description
3666 Action Set the group for the graphics inset on the cursor position.
3668 \begin_layout Description
3669 Syntax set-graphics-group [<GROUP>]
3671 \begin_layout Description
3672 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3674 \begin_layout Description
3675 Origin sanda, 6 May 2008
3678 \begin_layout Subsection*
3679 LFUN_FINISHED_FORWARD
3681 \begin_layout Description
3682 Action Moves the cursor out of the current slice, going forward.
3684 \begin_layout Description
3685 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.
3688 \begin_layout Subsection*
3689 LFUN_FINISHED_BACKWARD
3691 \begin_layout Description
3692 Action Moves the cursor out of the current slice, going backwards.
3694 \begin_layout Description
3695 Notion See also LFUN_FINISHED_FORWARD.
3698 \begin_layout Subsection*
3701 \begin_layout Description
3702 Action Moves the cursor out of the current slice, going right.
3704 \begin_layout Description
3705 Notion See also LFUN_FINISHED_FORWARD
3708 \begin_layout Subsection*
3711 \begin_layout Description
3712 Action Moves the cursor out of the current slice, going left.
3714 \begin_layout Description
3715 Notion See also LFUN_FINISHED_FORWARD.
3718 \begin_layout Subsection*
3721 \begin_layout Description
3722 Action Set language from the current cursor position.
3724 \begin_layout Description
3725 Syntax language <LANG>
3727 \begin_layout Description
3728 Params <LANG>: Requested language. Look in lib/languages for the list.
3730 \begin_layout Description
3731 Origin Dekel, 2 Mar 2000
3734 \begin_layout Subsection*
3737 \begin_layout Description
3738 Action Goto a label.
3740 \begin_layout Description
3741 Syntax label-goto [<LABEL>]
3743 \begin_layout Description
3744 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.
3746 \begin_layout Description
3747 Origin Ale, 6 Aug 1997
3750 \begin_layout Subsection*
3753 \begin_layout Description
3754 Action Inserts label to text or displayed formula.
3756 \begin_layout Description
3757 Syntax label-insert [<LABEL>]
3759 \begin_layout Description
3760 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3763 \begin_layout Subsection*
3766 \begin_layout Description
3767 Action Go to the next label or cross-reference.
3769 \begin_layout Description
3770 Syntax reference-next
3772 \begin_layout Description
3773 Origin Dekel, 14 Jan 2001
3776 \begin_layout Subsection*
3779 \begin_layout Description
3780 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3782 \begin_layout Description
3783 Notion Bookmark 0 has a special purpose. It is automatically set
3784 \begin_inset Newline newline
3787 1. to the paragraph you are currently editing
3788 \begin_inset Newline newline
3791 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3792 \begin_inset Newline newline
3795 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3797 \begin_layout Description
3798 Syntax bookmark-goto <NUMBER>
3800 \begin_layout Description
3801 Params <NUMBER>: the number of the bookmark to restore.
3803 \begin_layout Description
3804 Origin Dekel, 27 January 2001
3807 \begin_layout Subsection*
3810 \begin_layout Description
3811 Action Save a bookmark.
3813 \begin_layout Description
3814 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.
3816 \begin_layout Description
3817 Syntax bookmark-save <NUMBER>
3819 \begin_layout Description
3820 Params <NUMBER>: the number of the bookmark to save.
3822 \begin_layout Description
3823 Origin Dekel, 27 January 2001
3826 \begin_layout Subsection*
3829 \begin_layout Description
3830 Action Clears the list of saved bookmarks.
3832 \begin_layout Description
3833 Syntax bookmark-clear
3835 \begin_layout Description
3836 Origin bpeng, 31 October 2006
3839 \begin_layout Subsection*
3842 \begin_layout Description
3843 Action Open the given help file according to the language setting.
3845 \begin_layout Description
3846 Syntax help-open <FILE>[.lyx]
3848 \begin_layout Description
3849 Params <FILE>: any document from (/usr/share/)doc directory.
3851 \begin_layout Description
3852 Origin Jug, 27 Jun 1999
3855 \begin_layout Subsection*
3858 \begin_layout Description
3859 Action Terminates the current LyX instance.
3861 \begin_layout Description
3862 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3864 \begin_layout Description
3868 \begin_layout Subsection*
3871 \begin_layout Description
3872 Action Toggles visibility of a given toolbar between on/off/auto.
3874 \begin_layout Description
3875 Notion Skipping "auto" when allowauto is false.
3877 \begin_layout Description
3878 Syntax toolbar-toggle <NAME> [allowauto]
3880 \begin_layout Description
3881 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
3883 \begin_layout Description
3884 Origin Edwin, 21 May 2007
3887 \begin_layout Subsection*
3890 \begin_layout Description
3891 Action Opens the menu given by its name.
3893 \begin_layout Description
3894 Syntax menu-open <NAME>
3896 \begin_layout Description
3897 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3900 \begin_layout Subsection*
3903 \begin_layout Description
3904 Action Various UI visibility-toggling actions.
3906 \begin_layout Description
3907 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3909 \begin_layout Description
3910 Params statusbar : Toggle visibility of the statusbar.
3911 \begin_inset Newline newline
3914 menubar : Toggle visibility of the menubar.
3915 \begin_inset Newline newline
3918 scrollbar : Toggle visibility of the scrollbar.
3919 \begin_inset Newline newline
3922 frame : Toggle visibility of the frames around editing window.
3923 \begin_inset Newline newline
3926 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.
3928 \begin_layout Description
3929 Origin sanda, 9 Feb 2007
3932 \begin_layout Subsection*
3935 \begin_layout Description
3936 Action Creates new empty LyX window.
3938 \begin_layout Description
3939 Notion Already opened documents from the previous window can be found under View menu.
3941 \begin_layout Description
3942 Syntax window-new [<GEOMETRY>]
3944 \begin_layout Description
3945 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3947 \begin_layout Description
3948 Origin Abdel, 21 Oct 2006
3951 \begin_layout Subsection*
3954 \begin_layout Description
3955 Action Closes the current LyX window.
3957 \begin_layout Description
3960 \begin_layout Description
3961 Origin Abdel, 23 Oct 2006
3964 \begin_layout Subsection*
3967 \begin_layout Description
3968 Action Creates another split view of current buffer.
3970 \begin_layout Description
3971 Notion All split views act in the same way indpendently.
3973 \begin_layout Description
3974 Syntax split-view <vertical|horizontal>
3976 \begin_layout Description
3977 Params horizontal : The work areas are laid out side by side.
3978 \begin_inset Newline newline
3981 vertical : The work areas laid out vertically.
3983 \begin_layout Description
3984 Origin Abdel, 20 Feb 2008
3987 \begin_layout Subsection*
3988 LFUN_CLOSE_TAB_GROUP
3990 \begin_layout Description
3991 Action Close the current tab group.
3993 \begin_layout Description
3994 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
3996 \begin_layout Description
3997 Syntax close-tab-group
3999 \begin_layout Description
4000 Origin Abdel, 21 Feb 2008
4003 \begin_layout Subsection*
4006 \begin_layout Description
4007 Action Shows hidden dialog or create new one for a given function/inset settings etc.
4009 \begin_layout Description
4010 Syntax dialog-show <NAME> [<DATA>]
4012 \begin_layout Description
4013 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4014 \begin_inset Newline newline
4017 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
4018 \begin_inset Newline newline
4021 graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|
4022 \begin_inset Newline newline
4025 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
4026 \begin_inset Newline newline
4029 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
4030 \begin_inset Newline newline
4033 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
4034 \begin_inset Newline newline
4037 <SPECIAL>: latexlog|vclog
4038 \begin_inset Newline newline
4041 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
4043 \begin_layout Description
4044 Origin leeming, 17 Jun 2003
4047 \begin_layout Subsection*
4048 LFUN_DIALOG_SHOW_NEW_INSET
4050 \begin_layout Description
4051 Action Shows hidden dialog or create new one for a given inset settings etc.
4053 \begin_layout Description
4054 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
4056 \begin_layout Description
4057 Syntax dialog-show-new-inset <NAME> [<DATA>]
4059 \begin_layout Description
4060 Params See LFUN_DIALOG_SHOW .
4062 \begin_layout Description
4063 Origin leeming, 25 Feb 2003
4066 \begin_layout Subsection*
4069 \begin_layout Description
4070 Action Updates the dialog values from the inset/paragraph/document.
4072 \begin_layout Description
4073 Syntax dialog-update <NAME>
4075 \begin_layout Description
4076 Params <NAME>: paragraph|prefs|<INSET>
4077 \begin_inset Newline newline
4082 \begin_layout Description
4083 Origin leeming, 25 Feb 2003
4086 \begin_layout Subsection*
4089 \begin_layout Description
4090 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
4092 \begin_layout Description
4093 Syntax dialog-hide <NAME>
4095 \begin_layout Description
4096 Params See LFUN_DIALOG_SHOW .
4098 \begin_layout Description
4099 Origin leeming, 25 Feb 2003
4102 \begin_layout Subsection*
4105 \begin_layout Description
4106 Action Toggles dialog between showed/hidden state.
4108 \begin_layout Description
4109 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4111 \begin_layout Description
4112 Syntax dialog-toggle <NAME> [<DATA>]
4114 \begin_layout Description
4115 Params See LFUN_DIALOG_SHOW .
4117 \begin_layout Description
4118 Origin JSpitzm, 30 Apr 2007
4121 \begin_layout Subsection*
4122 LFUN_DIALOG_DISCONNECT_INSET
4124 \begin_layout Description
4125 Action Closes opened connection to opened inset.
4127 \begin_layout Description
4128 Notion Connection is used for apply functions.
4130 \begin_layout Description
4131 Syntax dialog-disconnect-inset <INSET-NAME>
4133 \begin_layout Description
4134 Origin leeming, 25 Feb 2003
4137 \begin_layout Subsection*
4140 \begin_layout Description
4141 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
4143 \begin_layout Description
4144 Notion This is internal LFUN, not to be used by users.
4146 \begin_layout Description
4147 Origin Andre, 9 Aug 2002
4150 \begin_layout Subsection*
4153 \begin_layout Description
4154 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
4156 \begin_layout Description
4157 Notion This is internal LFUN, not to be used by users.
4159 \begin_layout Description
4160 Origin Andre, 9 Aug 2002
4163 \begin_layout Subsection*
4166 \begin_layout Description
4167 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4169 \begin_layout Description
4170 Notion This is internal LFUN, not to be used by users.
4172 \begin_layout Description
4173 Origin Andre, 9 Aug 2002
4176 \begin_layout Subsection*
4179 \begin_layout Description
4180 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4182 \begin_layout Description
4183 Notion This is internal LFUN, not to be used by users.
4185 \begin_layout Description
4186 Origin Andre, 9 Aug 2002
4189 \begin_layout Subsection*
4192 \begin_layout Description
4193 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4195 \begin_layout Description
4196 Notion This is internal LFUN, not to be used by users.
4198 \begin_layout Description
4199 Origin Andre, 9 Aug 2002
4202 \begin_layout Subsection*
4205 \begin_layout Description
4206 Action Turn off the loaded keyboard map.
4208 \begin_layout Description
4212 \begin_layout Subsection*
4215 \begin_layout Description
4216 Action Turn on the primary keyboard map.
4218 \begin_layout Description
4219 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.
4220 \begin_inset Newline newline
4223 The language is to be set in the Preferences dialog.
4225 \begin_layout Description
4226 Syntax keymap-primary
4229 \begin_layout Subsection*
4230 LFUN_KEYMAP_SECONDARY
4232 \begin_layout Description
4233 Action Turn on the secondary keyboard map.
4235 \begin_layout Description
4236 Syntax keymap-secondary
4239 \begin_layout Subsection*
4242 \begin_layout Description
4243 Action Toggles keyboard maps (first/second/off).
4245 \begin_layout Description
4246 Syntax keymap-toggle
4248 \begin_layout Description
4249 Origin leeming, 30 Mar 2004
4252 \begin_layout Subsection*
4253 LFUN_SERVER_GET_LAYOUT
4255 \begin_layout Description
4256 Action Returns the current layout (that is environment) name on the cursor position.
4258 \begin_layout Description
4259 Syntax server-get-layout
4262 \begin_layout Subsection*
4263 LFUN_SERVER_GET_FILENAME
4265 \begin_layout Description
4266 Action Returns path and file name of the currently edited document.
4268 \begin_layout Description
4269 Syntax server-get-filename
4272 \begin_layout Subsection*
4273 LFUN_SERVER_GOTO_FILE_ROW
4275 \begin_layout Description
4276 Action Sets the cursor position based on the row number of generated TeX file.
4278 \begin_layout Description
4279 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).
4281 \begin_layout Description
4282 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4284 \begin_layout Description
4285 Params <FILE>: the filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
4286 \begin_inset Newline newline
4289 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g. for the case of generated .tex file). .ext: extensions will be automatically replaced by .lyx. <ROW_NUMBER> The row number of the LaTeX file to which to go.
4291 \begin_layout Description
4292 Origin Edmar, 23 Dec 1998
4295 \begin_layout Subsection*
4298 \begin_layout Description
4299 Action Sends notify message about the last key-sequence to client.
4301 \begin_layout Description
4302 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4304 \begin_layout Description
4305 Syntax server-notify
4308 \begin_layout Subsection*
4311 \begin_layout Description
4312 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4314 \begin_layout Description
4315 Syntax server-set-xy <X> <Y>
4318 \begin_layout Subsection*
4321 \begin_layout Description
4322 Action Returns the coordinates of cursor position in the editing area.
4324 \begin_layout Description
4325 Syntax server-get-xy
4328 \begin_layout Subsection*
4331 \begin_layout Description
4332 Action Generates the code (literate programming).
4334 \begin_layout Description
4335 Notion Latex file with extension
4337 literate_extension is generated. Then LyX invokes
4339 build_command (with a default of``make'') to generate the code and
4341 build_error_filter to process the compilation error messages.
4342 \begin_inset Newline newline
4345 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:
4346 \begin_inset Newline newline
4351 build_command "my_script my_arguments"
4352 \begin_inset Newline newline
4357 build_error_filter differs from the
4359 literate_error_filter only in that the former will identify error messages from your compiler.
4361 \begin_layout Description
4362 Syntax build-program
4365 \begin_layout Subsection*
4366 LFUN_BUFFER_AUTO_SAVE
4368 \begin_layout Description
4369 Action Saves the current buffer to a temporary file.
4371 \begin_layout Description
4372 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4374 \begin_layout Description
4375 Syntax buffer-auto-save
4378 \begin_layout Subsection*
4379 LFUN_BUFFER_CHILD_OPEN
4381 \begin_layout Description
4382 Action Loads the given child document.
4384 \begin_layout Description
4385 Notion The current document is treated as a parent.
4387 \begin_layout Description
4388 Syntax buffer-child-open <FILE>
4390 \begin_layout Description
4391 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4393 \begin_layout Description
4394 Origin Ale, 28 May 1997
4397 \begin_layout Subsection*
4400 \begin_layout Description
4401 Action Runs chktex for the current document.
4403 \begin_layout Description
4404 Syntax buffer-chktex
4406 \begin_layout Description
4407 Origin Asger, 30 Oct 1997
4410 \begin_layout Subsection*
4411 LFUN_BUFFER_TOGGLE_COMPRESSION
4413 \begin_layout Description
4414 Action Toggles compression of the current document on/off.
4416 \begin_layout Description
4417 Syntax buffer-toggle-compression
4419 \begin_layout Description
4420 Origin bpeng, 27 Apr 2006
4423 \begin_layout Subsection*
4426 \begin_layout Description
4427 Action Closes the current buffer.
4429 \begin_layout Description
4430 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4432 \begin_layout Description
4436 \begin_layout Subsection*
4437 LFUN_BUFFER_CLOSE_ALL
4439 \begin_layout Description
4440 Action Closes all buffers.
4442 \begin_layout Description
4443 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4445 \begin_layout Description
4446 Syntax buffer-close-all
4449 \begin_layout Subsection*
4452 \begin_layout Description
4453 Action Exports the current buffer (document) to the given format.
4455 \begin_layout Description
4456 Syntax buffer-export <FORMAT>
4458 \begin_layout Description
4459 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.
4460 \begin_inset Newline newline
4463 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.
4465 \begin_layout Description
4466 Origin Lgb, 29 Jul 1997
4469 \begin_layout Subsection*
4470 LFUN_BUFFER_EXPORT_CUSTOM
4472 \begin_layout Description
4473 Action Exports the current buffer (document) from the given format using the given command on it.
4475 \begin_layout Description
4476 Syntax buffer-export-custom <FORMAT> <COMMAND>
4478 \begin_layout Description
4479 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4480 \begin_inset Newline newline
4483 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4485 \begin_layout Description
4486 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4488 \begin_layout Description
4489 Origin leeming, 27 Mar 2004
4492 \begin_layout Subsection*
4495 \begin_layout Description
4496 Action Prints the current document.
4498 \begin_layout Description
4499 Notion Many settings can be given via the preferences dialog.
4501 \begin_layout Description
4502 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4504 \begin_layout Description
4505 Params <TARGET> is either "printer" or "file".
4506 \begin_inset Newline newline
4509 <TARGER-NAME> is either "default" or file name or printer name.
4510 \begin_inset Newline newline
4513 <COMMAND> command ensuring the printing job.
4515 \begin_layout Description
4516 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4518 \begin_layout Description
4519 Origin leeming, 28 Mar 2004
4522 \begin_layout Subsection*
4525 \begin_layout Description
4526 Action Import a given file as a lyx document.
4528 \begin_layout Description
4529 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.
4531 \begin_layout Description
4532 Syntax buffer-import <FORMAT> [<FILE>]
4534 \begin_layout Description
4535 Origin Asger, 24 Jul 1998
4538 \begin_layout Subsection*
4541 \begin_layout Description
4542 Action Creates a new buffer (that is, document).
4544 \begin_layout Description
4545 Notion Implicit path can be set in Preferences dialog.
4547 \begin_layout Description
4548 Syntax buffer-new [<FILE>]
4550 \begin_layout Description
4551 Params <FILE>: filename of created file with absolute path.
4554 \begin_layout Subsection*
4555 LFUN_BUFFER_NEW_TEMPLATE
4557 \begin_layout Description
4558 Action Creates a new buffer (that is, document) from a template.
4560 \begin_layout Description
4561 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4563 \begin_layout Description
4564 Syntax buffer-new-template [<FILE>]
4566 \begin_layout Description
4567 Params <FILE>: filename of created file with absolute path.
4570 \begin_layout Subsection*
4573 \begin_layout Description
4574 Action Reverts opened document.
4576 \begin_layout Description
4577 Syntax buffer-reload
4579 \begin_layout Description
4580 Origin Asger, 2 Feb 1997
4583 \begin_layout Subsection*
4586 \begin_layout Description
4587 Action Switch to the given buffer.
4589 \begin_layout Description
4590 Notion This is useful also in case you need simultaneously more views of the edited document in different LyX windows.
4592 \begin_layout Description
4593 Syntax buffer-new-template <BUFFER>
4595 \begin_layout Description
4596 Params <BUFFER>: already opened document which is to be shown.
4599 \begin_layout Subsection*
4600 LFUN_BUFFER_TOGGLE_READ_ONLY
4602 \begin_layout Description
4603 Action Toggle editing mode of the current document between read/write and read-only.
4605 \begin_layout Description
4606 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.
4608 \begin_layout Description
4609 Syntax buffer-toggle-read-only
4611 \begin_layout Description
4612 Origin Lgb, 27 May 1997
4615 \begin_layout Subsection*
4618 \begin_layout Description
4619 Action Displays current buffer in chosen format.
4621 \begin_layout Description
4622 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.
4624 \begin_layout Description
4625 Syntax buffer-view [<FORMAT>]
4627 \begin_layout Description
4628 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.
4631 \begin_layout Subsection*
4634 \begin_layout Description
4635 Action Exports the current document and put the result into the temporary directory.
4637 \begin_layout Description
4638 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).
4640 \begin_layout Description
4641 Syntax buffer-update [<FORMAT>]
4643 \begin_layout Description
4644 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.
4646 \begin_layout Description
4647 Origin Dekel, 5 Aug 2000
4650 \begin_layout Subsection*
4653 \begin_layout Description
4654 Action Saves the current buffer.
4656 \begin_layout Description
4657 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.
4659 \begin_layout Description
4663 \begin_layout Subsection*
4664 LFUN_BUFFER_WRITE_AS
4666 \begin_layout Description
4667 Action Rename and save current buffer.
4669 \begin_layout Description
4670 Syntax buffer-write-as <FILENAME>
4672 \begin_layout Description
4673 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4676 \begin_layout Subsection*
4677 LFUN_BUFFER_WRITE_ALL
4679 \begin_layout Description
4680 Action Save all changed documents.
4682 \begin_layout Description
4683 Syntax buffer-write-all
4685 \begin_layout Description
4686 Origin rgh, gpothier 6 Aug 2007
4689 \begin_layout Subsection*
4692 \begin_layout Description
4693 Action Switch to the next opened document.
4695 \begin_layout Description
4696 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4698 \begin_layout Description
4702 \begin_layout Subsection*
4703 LFUN_BUFFER_PREVIOUS
4705 \begin_layout Description
4706 Action Switch to the previous opened document.
4708 \begin_layout Description
4709 Syntax buffer-previous
4712 \begin_layout Subsection*
4713 LFUN_MASTER_BUFFER_UPDATE
4715 \begin_layout Description
4716 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4718 \begin_layout Description
4719 Syntax master-buffer-update [<FORMAT>]
4721 \begin_layout Description
4722 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.
4724 \begin_layout Description
4725 Origin Tommaso, 20 Sep 2007
4728 \begin_layout Subsection*
4729 LFUN_MASTER_BUFFER_VIEW
4731 \begin_layout Description
4732 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4734 \begin_layout Description
4735 Syntax master-buffer-view [<FORMAT>]
4737 \begin_layout Description
4738 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.
4740 \begin_layout Description
4741 Origin Tommaso, 20 Sep 2007
4744 \begin_layout Subsection*
4745 LFUN_BUFFER_LANGUAGE
4747 \begin_layout Description
4748 Action Set language of the current document.
4750 \begin_layout Description
4751 Syntax buffer-language <LANG>
4753 \begin_layout Description
4754 Params <LANG>: language name. See lib/languages for list.
4756 \begin_layout Description
4757 Origin leeming, 30 Mar 2004
4760 \begin_layout Subsection*
4761 LFUN_BUFFER_SAVE_AS_DEFAULT
4763 \begin_layout Description
4764 Action Save the current document settings as default.
4766 \begin_layout Description
4767 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4769 \begin_layout Description
4770 Syntax buffer-save-as-default [<ARGS>]
4772 \begin_layout Description
4773 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4775 \begin_layout Description
4776 Origin leeming, 30 Mar 2004
4779 \begin_layout Subsection*
4780 LFUN_BUFFER_PARAMS_APPLY
4782 \begin_layout Description
4783 Action Apply the given settings to the current document.
4785 \begin_layout Description
4786 Syntax buffer-params-apply [<ARGS>]
4788 \begin_layout Description
4789 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4791 \begin_layout Description
4792 Origin leeming, 30 Mar 2004
4795 \begin_layout Subsection*
4798 \begin_layout Description
4799 Action Inserts another LyX file.
4801 \begin_layout Description
4802 Syntax file-insert [<FILE>]
4804 \begin_layout Description
4805 Params <FILE>: Filename to be inserted.
4808 \begin_layout Subsection*
4809 LFUN_FILE_INSERT_PLAINTEXT
4811 \begin_layout Description
4812 Action Inserts plain text file.
4814 \begin_layout Description
4815 Syntax file-insert-plaintext [<FILE>]
4817 \begin_layout Description
4818 Params <FILE>: Filename to be inserted.
4820 \begin_layout Description
4821 Origin CFO-G, 19 Nov 1997
4824 \begin_layout Subsection*
4825 LFUN_FILE_INSERT_PLAINTEXT_PARA
4827 \begin_layout Description
4828 Action Inserts plain text file as paragraph (i.e. join lines).
4830 \begin_layout Description
4831 Syntax file-insert-plaintext-para [<FILE>]
4833 \begin_layout Description
4834 Params <FILE>: Filename to be inserted.
4836 \begin_layout Description
4837 Origin Levon, 14 Feb 2001
4840 \begin_layout Subsection*
4843 \begin_layout Description
4844 Action Open LyX document.
4846 \begin_layout Description
4847 Syntax file-open [<FILE>]
4849 \begin_layout Description
4850 Params <FILE>: Filename to be opened.
4853 \begin_layout Subsection*
4856 \begin_layout Description
4857 Action Executes a command defined in a .def file.
4859 \begin_layout Description
4860 Notion The definitions are by default read from lib/commands/default.def.
4861 \begin_inset Newline newline
4864 A .def file allows to define a command with
4866 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).
4868 def_file "FileName" allows to include another .def file.
4869 \begin_inset Newline newline
4872 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.
4874 \begin_layout Description
4877 \begin_layout Description
4878 Params <NAME>: Name of the command that must be called.
4880 \begin_layout Description
4881 Origin broider, 2 Oct 2007
4884 \begin_layout Subsection*
4887 \begin_layout Description
4888 Action Simulate halting Meta key (Alt key on PCs).
4890 \begin_layout Description
4891 Notion Used for buffer editation not for GUI control.
4893 \begin_layout Description
4897 \begin_layout Subsection*
4900 \begin_layout Description
4901 Action Cancels sequence prepared by LFUN_META_PREFIX .
4903 \begin_layout Description
4907 \begin_layout Subsection*
4908 LFUN_COMMAND_EXECUTE
4910 \begin_layout Description
4911 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
4913 \begin_layout Description
4914 Notion Usually bound to M-x shortcut.
4916 \begin_layout Description
4917 Syntax command-execute
4920 \begin_layout Subsection*
4923 \begin_layout Description
4924 Action Return the current key sequence and available options as a string.
4926 \begin_layout Description
4927 Notion No options are added if no current map exists.
4928 \begin_inset Newline newline
4931 This is probably usable only with connection to lyxserver.
4933 \begin_layout Description
4934 Syntax command-prefix
4937 \begin_layout Subsection*
4938 LFUN_COMMAND_SEQUENCE
4940 \begin_layout Description
4941 Action Run more commands (LFUN and its parameters) in a sequence.
4943 \begin_layout Description
4944 Syntax command-sequence <CMDS>
4946 \begin_layout Description
4947 Params <CMDS>: Sequence of commands separated by semicolons.
4949 \begin_layout Description
4950 Sample command-sequence cut; ert-insert; self-insert
4952 ; paste; self-insert {}; inset-toggle;
4954 \begin_layout Description
4955 Origin Andre, 11 Nov 1999
4958 \begin_layout Subsection*
4959 LFUN_COMMAND_ALTERNATIVES
4961 \begin_layout Description
4962 Action Runs the first listed command that is enabled.
4964 \begin_layout Description
4965 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
4967 \begin_layout Description
4968 Syntax command-alternatives <CMDS>
4970 \begin_layout Description
4971 Params <CMDS>: Sequence of commands separated by semicolons.
4973 \begin_layout Description
4974 Sample command-alternatives completion-accept;cell-forward
4976 \begin_layout Description
4977 Origin rgh, 24 September 2008
4980 \begin_layout Subsection*
4983 \begin_layout Description
4984 Action Shows message in statusbar (for script purposes).
4986 \begin_layout Description
4987 Syntax message <STRING>
4989 \begin_layout Description
4990 Origin Lgb, 8 Apr 2001
4993 \begin_layout Subsection*
4994 LFUN_DEBUG_LEVEL_SET
4996 \begin_layout Description
4997 Action Set debug output level.
4999 \begin_layout Description
5000 Syntax debug-level-set <LEVEL>
5002 \begin_layout Description
5003 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.
5005 \begin_layout Description
5006 Origin sanda, 28 Dec 2009
5009 \begin_layout Subsection*
5010 LFUN_PREFERENCES_SAVE
5012 \begin_layout Description
5013 Action Save user preferences.
5015 \begin_layout Description
5016 Syntax preferences-save
5018 \begin_layout Description
5019 Origin Lgb, 27 Nov 1999
5022 \begin_layout Subsection*
5025 \begin_layout Description
5026 Action Reconfigure the automatic settings.
5028 \begin_layout Description
5031 \begin_layout Description
5032 Origin Asger, 14 Feb 1997
5035 \begin_layout Subsection*
5038 \begin_layout Description
5039 Action Apply the given settings to user preferences.
5041 \begin_layout Description
5042 Syntax lyxrc-apply <SETTINGS>
5044 \begin_layout Description
5045 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.
5048 \begin_layout Subsection*
5049 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
5051 \begin_layout Description
5052 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
5054 \begin_layout Description
5055 Syntax toggle-cursor-follows-scrollbar
5057 \begin_layout Description
5058 Origin ARRae, 2 Dec 1997
5061 \begin_layout Subsection*
5064 \begin_layout Description
5065 Action Set the given LyX color to the color defined by the X11 name given.
5067 \begin_layout Description
5068 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5070 \begin_layout Description
5071 Syntax set-color <LYX_NAME> <X11_NAME>
5073 \begin_layout Description
5074 Origin SLior, 11 Jun 2000
5077 \begin_layout Subsection*
5080 \begin_layout Description
5081 Action Count the statistics (number of words and characters) in the document or in the given selection.
5083 \begin_layout Description
5084 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5086 \begin_layout Description
5089 \begin_layout Description
5090 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5093 \begin_layout Subsection*
5094 LFUN_COMPLETION_INLINE
5096 \begin_layout Description
5097 Action Show the inline completion at the cursor position.
5099 \begin_layout Description
5100 Syntax completion-inline
5102 \begin_layout Description
5103 Origin sts, Feb 19 2008
5106 \begin_layout Subsection*
5107 LFUN_COMPLETION_POPUP
5109 \begin_layout Description
5110 Action Show the completion popup at the cursor position.
5112 \begin_layout Description
5113 Syntax completion-popup
5115 \begin_layout Description
5116 Origin sts, Feb 19 2008
5119 \begin_layout Subsection*
5120 LFUN_COMPLETION_COMPLETE
5122 \begin_layout Description
5123 Action Try to complete the word or command at the cursor position.
5125 \begin_layout Description
5128 \begin_layout Description
5129 Origin sts, Feb 19 2008
5132 \begin_layout Subsection*
5133 LFUN_COMPLETION_CANCEL
5135 \begin_layout Description
5136 Action Try to cancel completion, either the popup or the inline completion.
5138 \begin_layout Description
5139 Syntax completion-cancel
5141 \begin_layout Description
5142 Origin sts, Sep 07 2008
5145 \begin_layout Subsection*
5146 LFUN_COMPLETION_ACCEPT
5148 \begin_layout Description
5149 Action Accept suggested completion.
5151 \begin_layout Description
5152 Syntax completion-accept
5154 \begin_layout Description
5155 Origin sanda, Sep 08 2008
5158 \begin_layout Subsection*
5161 \begin_layout Description
5162 Action Add a branch to the buffer's BranchList.
5164 \begin_layout Description
5165 Syntax branch-add <BRANCH>
5167 \begin_layout Description
5168 Params <BRANCH>: Name of the branch to add
5170 \begin_layout Description
5171 Origin spitz, 7 Jul 2009
5174 \begin_layout Subsection*
5175 LFUN_BRANCH_ACTIVATE
5177 \begin_layout Description
5178 Action Activate the branch.
5180 \begin_layout Description
5181 Syntax branch-activate <BRANCH>
5183 \begin_layout Description
5184 Params <BRANCH>: The branch to activate
5186 \begin_layout Description
5187 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5188 \begin_inset Newline newline
5191 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5193 \begin_layout Description
5194 Origin rgh, 27 May 2008
5197 \begin_layout Subsection*
5198 LFUN_BRANCH_DEACTIVATE
5200 \begin_layout Description
5201 Action De-activate the branch.
5203 \begin_layout Description
5204 Syntax branch-deactivate <BRANCH>
5206 \begin_layout Description
5207 Params <BRANCH>: The branch to deactivate
5209 \begin_layout Description
5210 Origin rgh, 27 May 2008
5213 \begin_layout Subsection*
5214 LFUN_BRANCHES_RENAME
5216 \begin_layout Description
5217 Action Rename all branches of a given name in a document.
5219 \begin_layout Description
5220 Syntax branches-rename <OLDNAME> <NEWNAME>
5222 \begin_layout Description
5223 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5225 \begin_layout Description
5226 Origin spitz, 9 Jul 2009
5229 \begin_layout Subsection*
5230 LFUN_BRANCH_ADD_INSERT
5232 \begin_layout Description
5233 Action Create new branch and directly put the branch inset into the document.
5235 \begin_layout Description
5236 Syntax branch-add-insert [<NAME>]
5238 \begin_layout Description
5239 Params <NAME>: Branch name. If it is not specified, you will be asked.
5241 \begin_layout Description
5242 Origin sanda, 10 Jul 2009
5245 \begin_layout Subsection*
5246 LFUN_LABEL_COPY_AS_REF
5248 \begin_layout Description
5249 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5251 \begin_layout Description
5252 Syntax copy-label-as-reference <LABEL>
5254 \begin_layout Description
5255 Params <LABEL>: The label to copy (for multi-line math)
5257 \begin_layout Description
5258 Origin sts, 16 Nov 2008
5261 \begin_layout Subsection*
5262 LFUN_LABEL_INSERT_AS_REF
5264 \begin_layout Description
5265 Action Inserts the label as a cross-reference at the position of the cursor.
5267 \begin_layout Description
5268 Syntax label-insert-as-reference
5270 \begin_layout Description
5271 Origin vfr, 7 Apr 2009
5274 \begin_layout Subsection*
5277 \begin_layout Description
5278 Action Increases the zoom of the screen fonts.
5280 \begin_layout Description
5281 Syntax buffer-zoom-in [<ZOOM>]
5283 \begin_layout Description
5284 Params <ZOOM>: The zoom in %, the default is 20.
5286 \begin_layout Description
5287 Origin vfr, 30 Mar 2009
5290 \begin_layout Subsection*
5291 LFUN_BUFFER_ZOOM_OUT
5293 \begin_layout Description
5294 Action Decreases the zoom of the screen fonts.
5296 \begin_layout Description
5297 Syntax buffer-zoom-out [<ZOOM>]
5299 \begin_layout Description
5300 Params <ZOOM>: The zoom in %, the default is 20.
5302 \begin_layout Description
5303 Origin vfr, 30 Mar 2009
projects / lyx.git / blob