1 #LyX 2.1 created 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
17 \maintain_unincluded_children false
19 \language_package default
24 \font_typewriter default
26 \font_default_family default
27 \use_non_tex_fonts false
33 \default_output_format default
35 \bibtex_command default
36 \index_command default
37 \paperfontsize default
42 \use_package amsmath 1
43 \use_package amssymb 1
45 \use_package mathdots 0
46 \use_package mathtools 0
48 \use_package undertilde 0
50 \cite_engine_type numerical
54 \paperorientation portrait
68 \paragraph_separation indent
69 \paragraph_indentation default
70 \quotes_language english
73 \paperpagestyle default
74 \tracking_changes false
83 \begin_layout Section*
84 LFUNs documentation automatically generated 2012-09-29
87 \begin_layout Standard
91 \begin_layout Plain Layout
101 \begin_inset VSpace 1cm
107 \begin_layout Subsection*
111 \begin_layout Description
112 Action Adds an acute accent to the next character typed.
115 \begin_layout Description
119 \begin_layout Subsection*
123 \begin_layout Description
124 Action Adds a breve accent to the next character typed.
127 \begin_layout Description
131 \begin_layout Subsection*
135 \begin_layout Description
136 Action Adds a caron to the next character typed.
139 \begin_layout Description
143 \begin_layout Subsection*
147 \begin_layout Description
148 Action Adds a cedilla to the next character typed.
151 \begin_layout Description
152 Syntax accent-cedilla
155 \begin_layout Subsection*
159 \begin_layout Description
160 Action Adds a circle accent to the next character typed.
163 \begin_layout Description
167 \begin_layout Subsection*
168 LFUN_ACCENT_CIRCUMFLEX
171 \begin_layout Description
172 Action Adds a circumflex to the next character typed.
175 \begin_layout Description
176 Syntax accent-circumflex
179 \begin_layout Subsection*
183 \begin_layout Description
184 Action Adds a dot accent to the next character typed.
187 \begin_layout Description
191 \begin_layout Subsection*
195 \begin_layout Description
196 Action Adds a grave accent to the next character typed.
199 \begin_layout Description
203 \begin_layout Subsection*
204 LFUN_ACCENT_HUNGARIAN_UMLAUT
207 \begin_layout Description
208 Action Adds a Hungarian umlaut to the next character typed.
211 \begin_layout Description
215 \begin_layout Subsection*
219 \begin_layout Description
220 Action Adds a macron to the next character typed.
223 \begin_layout Description
227 \begin_layout Subsection*
231 \begin_layout Description
232 Action Adds an ogonek accent to the next character typed.
235 \begin_layout Description
239 \begin_layout Subsection*
243 \begin_layout Description
244 Action Adds a tie over the next two character typed.
247 \begin_layout Description
248 Notion The following char will finish the tie.
251 \begin_layout Description
255 \begin_layout Subsection*
259 \begin_layout Description
260 Action Adds a tilde over the next character typed.
263 \begin_layout Description
267 \begin_layout Subsection*
271 \begin_layout Description
272 Action Adds an umlaut over the next character typed.
275 \begin_layout Description
279 \begin_layout Subsection*
283 \begin_layout Description
284 Action Adds a bar under the next character typed.
287 \begin_layout Description
288 Syntax accent-underbar
291 \begin_layout Subsection*
295 \begin_layout Description
296 Action Adds a dot under the next character typed.
299 \begin_layout Description
300 Syntax accent-underdot
303 \begin_layout Subsection*
307 \begin_layout Description
308 Action Inserts a caption inset.
311 \begin_layout Description
312 Syntax caption-insert
315 \begin_layout Description
316 Origin Lgb, 18 Jul 2000
319 \begin_layout Subsection*
323 \begin_layout Description
324 Action Inserts the current date.
327 \begin_layout Description
328 Syntax date-insert [<ARG>]
331 \begin_layout Description
332 Params <ARG>: Format of date.
333 The default value (%x) can be set in Preferences->Date format.
334 For possible formats see manual page of strftime function.
337 \begin_layout Description
338 Origin jdblair, 31 Jan 2000
341 \begin_layout Subsection*
345 \begin_layout Description
346 Action Inserts a footnote inset.
349 \begin_layout Description
350 Syntax footnote-insert
353 \begin_layout Description
354 Origin Jug, 7 Mar 2000
357 \begin_layout Subsection*
361 \begin_layout Description
362 Action Inserts an ERT inset.
365 \begin_layout Description
369 \begin_layout Description
370 Origin Jug, 18 Feb 2000
373 \begin_layout Subsection*
377 \begin_layout Description
378 Action Inserts a float inset.
381 \begin_layout Description
382 Syntax float-insert <TYPE>
385 \begin_layout Description
386 Params <TYPE>: type of float depends on the used textclass.
387 Usually "algorithm", "table", "figure" parameters can be given.
390 \begin_layout Description
391 Origin Lgb, 27 Jun 2000
394 \begin_layout Subsection*
395 LFUN_FLOAT_WIDE_INSERT
398 \begin_layout Description
399 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
402 \begin_layout Description
403 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
406 \begin_layout Description
407 Syntax float-wide-insert <TYPE>
410 \begin_layout Description
411 Params <TYPE>: type of float depends on the used textclass.
412 Usually "algorithm", "table", "figure" parameters can be given.
415 \begin_layout Description
416 Origin Lgb, 31 Oct 2001
419 \begin_layout Subsection*
420 LFUN_FLOAT_LIST_INSERT
423 \begin_layout Description
424 Action Inserts the list of floats in the document.
427 \begin_layout Description
428 Syntax float-list-insert <TYPE>
431 \begin_layout Description
432 Params <TYPE>: type of float depends on the used textclass.
433 Usually "algorithm", "table", "figure" parameters can be given.
436 \begin_layout Description
437 Origin Lgb, 3 May 2001
440 \begin_layout Subsection*
444 \begin_layout Description
445 Action Inserts floats wrapped by the text around.
448 \begin_layout Description
449 Syntax wrap-insert <TYPE>
452 \begin_layout Description
453 Params <TYPE>: table|figure
456 \begin_layout Description
457 Origin Dekel, 7 Apr 2002
460 \begin_layout Subsection*
464 \begin_layout Description
465 Action Inserts an argument (short title) inset.
468 \begin_layout Description
469 Syntax argument-insert
472 \begin_layout Description
473 Origin vermeer, 12 Aug 2002
476 \begin_layout Subsection*
480 \begin_layout Description
481 Action Inserts a new page.
484 \begin_layout Description
485 Syntax newpage-insert <ARG>
488 \begin_layout Description
489 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
492 \begin_layout Description
493 Origin uwestoehr, 24 Nov 2007
496 \begin_layout Subsection*
497 LFUN_MARGINALNOTE_INSERT
500 \begin_layout Description
501 Action Inserts a marginal note.
504 \begin_layout Description
505 Syntax marginalnote-insert
508 \begin_layout Description
509 Origin Lgb, 26 Jun 2000
512 \begin_layout Subsection*
516 \begin_layout Description
517 Action Inserts a single unicode character.
520 \begin_layout Description
521 Syntax unicode-insert <CHAR>
524 \begin_layout Description
525 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
528 \begin_layout Description
529 Sample unicode-insert 0x0100
532 \begin_layout Description
533 Origin Lgb, 22 Oct 2006
536 \begin_layout Subsection*
540 \begin_layout Description
541 Action Inserts a new listings inset.
544 \begin_layout Description
545 Syntax listing-insert
548 \begin_layout Description
549 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
552 \begin_layout Subsection*
556 \begin_layout Description
557 Action Inserts a new preview inset.
560 \begin_layout Description
561 Syntax preview-insert
564 \begin_layout Description
565 Origin vfr, 28 Mar 2010
568 \begin_layout Subsection*
572 \begin_layout Description
573 Action Insert a tab into a listings inset.
576 \begin_layout Description
577 Notion It also works on a selection.
580 \begin_layout Description
584 \begin_layout Description
585 Origin vfr, Sep 30 2008
588 \begin_layout Subsection*
592 \begin_layout Description
593 Action Delete a tab or up to an equivalent amount of spaces from a listings
597 \begin_layout Description
598 Notion It also works on a selection - it removes a tab or spaces from the
599 beginning of each line spanned by the selection.
600 This is useful if you want to indent/unindent multiple lines in one action.
603 \begin_layout Description
607 \begin_layout Description
608 Origin vfr, Sep 30 2008
611 \begin_layout Subsection*
615 \begin_layout Description
616 Action Inserts quotes according to the type and quote-language preference.
619 \begin_layout Description
620 Notion Currently English, Swedish, German, Polish, French, Danish quotes
624 \begin_layout Description
625 Syntax quote-insert [<TYPE>]
628 \begin_layout Description
629 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
633 \begin_layout Subsection*
637 \begin_layout Description
638 Action Displays shortcuts, lyxrc, package and textclass availability and
639 menu information in a non-editable boxed InsetText.
642 \begin_layout Description
643 Notion Apart from lfun arguments you can use the following method:
644 \begin_inset Newline newline
648 input the type and argument of this inset, e.g.
649 "menu paste", in the work area.
650 \begin_inset Newline newline
654 select the text and run info-insert lfun.
657 \begin_layout Description
658 Syntax info-insert <TYPE> <ARG>
661 \begin_layout Description
662 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
663 \begin_inset Newline newline
666 <ARG>: argument for a given type.
667 Look into InsetInfo.h for detailed description.
668 \begin_inset Newline newline
671 shortcut[s]: name of lfun (e.g math-insert
674 \begin_inset Newline newline
677 lyxrc: name of rc_entry (e.g.
679 \begin_inset Newline newline
682 lyxinfo: "version" - used version of LyX
683 \begin_inset Newline newline
686 package: name of latex package (e.g.
688 \begin_inset Newline newline
691 textclass: name of textclass (e.g.
693 \begin_inset Newline newline
696 menu: name of lfun used in menu
697 \begin_inset Newline newline
700 icon: icon of lfun used in toolbar
701 \begin_inset Newline newline
704 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-a
705 uthor"|"vcs-date"|"vcs-time"
708 \begin_layout Description
709 Sample command-sequence info-insert buffer path; info-insert buffer name
712 \begin_layout Description
713 Origin bpeng, 7 Oct 2007
716 \begin_layout Subsection*
720 \begin_layout Description
721 Action Inserts branch inset.
724 \begin_layout Description
725 Syntax branch-insert <BRANCH-NAME>
728 \begin_layout Description
729 Origin vermeer, 17 Aug 2003
732 \begin_layout Subsection*
736 \begin_layout Description
737 Action Inserts Box inset.
740 \begin_layout Description
741 Syntax box-insert [<TYPE>]
744 \begin_layout Description
745 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
746 \begin_inset Newline newline
749 Framed is the default one.
752 \begin_layout Description
753 Origin vermeer, 7 Oct 2003
756 \begin_layout Subsection*
760 \begin_layout Description
761 Action Inserts CharStyle, Custom inset or XML short element.
764 \begin_layout Description
765 Notion Look into the Customization manual for more information about these
767 \begin_inset Newline newline
770 To make this command enabled the layout file for the document class you're
771 using has to load the character styles.
772 There are a few contained in the Logical Markup module.
773 You can also of course create some yourself.
774 \begin_inset Newline newline
777 For dissolving the element see LFUN_INSET_DISSOLVE.
780 \begin_layout Description
781 Syntax flex-insert Name
784 \begin_layout Description
785 Params Name: This name must be defined either in your layout file or imported
787 The definition is InsetLayout Name or InsetLayout <Flex:Name>.
788 The Flex: prefix is optional.
791 \begin_layout Description
792 Sample flex-insert Code
795 \begin_layout Subsection*
799 \begin_layout Description
800 Action Inserts the given string (accordingly to the correct keymap).
803 \begin_layout Description
804 Notion Automatically replace the currently selected text.
805 Depends on lyxrc settings "auto_region_delete".
808 \begin_layout Description
809 Syntax self-insert <STRING>
812 \begin_layout Subsection*
816 \begin_layout Description
817 Action Inserts one of horizontal space insets.
820 \begin_layout Description
821 Syntax space-insert <NAME> [<LEN>]
824 \begin_layout Description
825 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip,
826 negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill,
828 \begin_inset Newline newline
831 Only in math mode: med and thick.
832 \begin_inset Newline newline
835 <LEN>: length for custom spaces (hspace, hspace* for protected)
838 \begin_layout Description
839 Origin JSpitzm, 20 May 2003, Mar 17 2008
842 \begin_layout Subsection*
843 LFUN_HYPERLINK_INSERT
846 \begin_layout Description
847 Action Inserts hyperlinks into the document (clickable in pdf output).
850 \begin_layout Description
851 Notion Hyperlink target can be set via selection + hyperlink-insert function.
854 \begin_layout Description
855 Syntax href-insert [<TARGET>]
858 \begin_layout Description
859 Origin CFO-G, 21 Nov 1997
862 \begin_layout Subsection*
863 LFUN_SPECIALCHAR_INSERT
866 \begin_layout Description
867 Action Inserts various characters into the document.
870 \begin_layout Description
871 Syntax specialchar-insert <CHAR>
874 \begin_layout Description
875 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
876 tence, menu-separator.
879 \begin_layout Description
880 Origin JSpitzm, 6 Dec 2007
883 \begin_layout Subsection*
887 \begin_layout Description
888 Action Inserts a subscript or superscript inset.
891 \begin_layout Description
892 Syntax script-insert <TYPE>
895 \begin_layout Description
896 Params <TYPE>: subscript|superscript
899 \begin_layout Description
900 Origin Georg, 23 Nov 2010
903 \begin_layout Subsection*
907 \begin_layout Description
908 Action Start (or remove) Appendix on the given cursor position.
911 \begin_layout Description
915 \begin_layout Description
916 Origin ettrich, 5 May 1998
919 \begin_layout Subsection*
923 \begin_layout Description
924 Action Inserts Index entry.
927 \begin_layout Description
928 Notion It automatically takes the word on the cursor position.
931 \begin_layout Description
932 Syntax index-insert [<TYPE:Name>]
935 \begin_layout Description
936 Params <TYPE:Name>: name of the index, if multiple indices are defined.
937 With an empty argument, the default index is selected.
940 \begin_layout Description
941 Origin leeming, 3 Aug 2000
944 \begin_layout Subsection*
948 \begin_layout Description
949 Action Inserts list of Index entries on a new page.
952 \begin_layout Description
953 Syntax index-print [<TYPE:Name>]
956 \begin_layout Description
957 Params <TYPE:Name>: name of the index, if multiple indices are defined.
958 With an empty argument, the default index is selected.
961 \begin_layout Description
962 Origin Lgb, 27 Feb 1997
965 \begin_layout Subsection*
969 \begin_layout Description
970 Action Inserts an IPA inset.
973 \begin_layout Description
977 \begin_layout Description
978 Origin spitz, 05 Mar 2012
981 \begin_layout Subsection*
985 \begin_layout Description
986 Action Only active in IPA inset.
989 \begin_layout Description
990 Notion Dummy function which is only active in a IPA inset.
991 It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
994 \begin_layout Description
998 \begin_layout Description
999 Origin spitz, 20 May 2012
1002 \begin_layout Subsection*
1003 LFUN_IPAMACRO_INSERT
1006 \begin_layout Description
1007 Action Inserts special IPA macros into the document.
1010 \begin_layout Description
1011 Syntax ipamacro-insert <CHAR>
1014 \begin_layout Description
1015 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
1016 tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
1019 \begin_layout Description
1020 Origin JSpitzm, 22 Aug 2012
1023 \begin_layout Subsection*
1027 \begin_layout Description
1028 Action Inserts Nomenclature entry.
1031 \begin_layout Description
1032 Notion It automatically takes the word on the cursor position if no symbol
1036 \begin_layout Description
1037 Syntax nomencl-insert [<SYMBOL>]
1040 \begin_layout Description
1041 Origin Ugras, 4 Nov 2006
1044 \begin_layout Subsection*
1045 LFUN_NOMENCLATURE_PRINT
1048 \begin_layout Description
1049 Action Inserts list of Nomenclature entries.
1052 \begin_layout Description
1053 Syntax nomenclature-print
1056 \begin_layout Description
1057 Origin Ugras, 4 Nov 2006
1060 \begin_layout Subsection*
1064 \begin_layout Description
1065 Action Inserts Note on the current cursor position, move selection inside
1069 \begin_layout Description
1070 Syntax note-insert [<TYPE>]
1073 \begin_layout Description
1074 Params <TYPE>: <Note|Greyedout|Comment> default: Note
1077 \begin_layout Subsection*
1081 \begin_layout Description
1082 Action Moves the cursor to the beginning of next Note inset.
1085 \begin_layout Description
1089 \begin_layout Subsection*
1093 \begin_layout Description
1094 Action Inserts phantom on the current cursor position, move selection inside
1098 \begin_layout Description
1099 Syntax phantom-insert [<TYPE>]
1102 \begin_layout Description
1103 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
1106 \begin_layout Description
1107 Origin uwestoehr, 30 Jan 2009
1110 \begin_layout Subsection*
1114 \begin_layout Description
1115 Action Inserts a line break or new line.
1118 \begin_layout Description
1119 Syntax newline-insert [<ARG>]
1122 \begin_layout Description
1123 Params <ARG>: <newline|linebreak> default: newline
1126 \begin_layout Description
1127 Origin JSpitzm, 25 Mar 2008
1130 \begin_layout Subsection*
1134 \begin_layout Description
1135 Action Clears the selection.
1136 If no text is selected call LFUN_FINISHED_FORWARD.
1137 Inside math mode jumps out of the math inset.
1140 \begin_layout Description
1144 \begin_layout Description
1145 Origin Lgb, 17 May 2001
1148 \begin_layout Subsection*
1152 \begin_layout Description
1153 Action Moves the cursor one line in downward direction.
1156 \begin_layout Description
1160 \begin_layout Subsection*
1164 \begin_layout Description
1165 Action Moves the cursor one line in upward direction.
1168 \begin_layout Description
1172 \begin_layout Subsection*
1176 \begin_layout Description
1177 Action Moves the cursor one line in downward direction adding the current
1178 position to the selection.
1181 \begin_layout Description
1185 \begin_layout Subsection*
1189 \begin_layout Description
1190 Action Moves the cursor one line in upward direction adding the current
1191 position to the selection.
1194 \begin_layout Description
1198 \begin_layout Subsection*
1202 \begin_layout Description
1203 Action Moves the cursor one page in downward direction.
1206 \begin_layout Description
1210 \begin_layout Subsection*
1214 \begin_layout Description
1215 Action Moves the cursor one page in upward direction.
1218 \begin_layout Description
1222 \begin_layout Subsection*
1223 LFUN_SCREEN_DOWN_SELECT
1226 \begin_layout Description
1227 Action Moves the cursor one screen in downward direction adding the current
1228 position to the selection.
1231 \begin_layout Description
1232 Syntax screen-down-select
1235 \begin_layout Subsection*
1236 LFUN_SCREEN_UP_SELECT
1239 \begin_layout Description
1240 Action Moves the cursor one page in upward direction adding the current
1241 position to the selection.
1244 \begin_layout Description
1245 Syntax screen-up-select
1248 \begin_layout Subsection*
1252 \begin_layout Description
1253 Action Scroll the buffer view.
1256 \begin_layout Description
1257 Notion Only scrolls the screen up or down; does not move the cursor.
1260 \begin_layout Description
1261 Syntax scroll <TYPE> <QUANTITY>
1264 \begin_layout Description
1265 Params <TYPE>: line|page
1266 \begin_inset Newline newline
1269 <QUANTITY>: up|down|<number>
1272 \begin_layout Description
1273 Origin Abdel, Dec 27 2007
1276 \begin_layout Subsection*
1277 LFUN_SCREEN_RECENTER
1280 \begin_layout Description
1281 Action Recenters the screen on the current cursor position.
1284 \begin_layout Description
1285 Syntax screen-recenter
1288 \begin_layout Subsection*
1289 LFUN_SCREEN_SHOW_CURSOR
1292 \begin_layout Description
1293 Action Repositions the screen such that the cursor is visible.
1296 \begin_layout Description
1297 Syntax screen-show-cursor
1300 \begin_layout Description
1301 Origin vfr, 25 Mar 2009
1304 \begin_layout Subsection*
1308 \begin_layout Description
1309 Action Moves the cursor one position logically backwards.
1312 \begin_layout Description
1313 Notion This is not the action which should be bound to the arrow keys, because
1314 backwards may be left or right, depending on the language.
1315 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1316 which in turn may employ this one.
1319 \begin_layout Description
1320 Syntax char-backward
1323 \begin_layout Subsection*
1324 LFUN_CHAR_BACKWARD_SELECT
1327 \begin_layout Description
1328 Action Moves the cursor one position logically backwards, adding traversed
1329 position to the selection.
1332 \begin_layout Description
1333 Notion See also LFUN_CHAR_BACKWARD.
1336 \begin_layout Description
1337 Syntax char-backward-select
1340 \begin_layout Subsection*
1341 LFUN_CHAR_DELETE_BACKWARD
1344 \begin_layout Description
1345 Action Deletes one character in the backward direction (usually the "BackSpace"
1349 \begin_layout Description
1350 Syntax char-delete-backward
1353 \begin_layout Subsection*
1354 LFUN_CHAR_DELETE_FORWARD
1357 \begin_layout Description
1358 Action Deletes one character in the backward direction (usually the "Delete"
1362 \begin_layout Description
1363 Syntax char-delete-forward
1366 \begin_layout Subsection*
1370 \begin_layout Description
1371 Action Moves the cursor one position logically forward.
1374 \begin_layout Description
1375 Notion This is not the action which should be bound to the arrow keys, because
1376 forward may be left or right, depending on the language.
1377 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1378 which in turn may employ this one.
1381 \begin_layout Description
1385 \begin_layout Subsection*
1386 LFUN_CHAR_FORWARD_SELECT
1389 \begin_layout Description
1390 Action Moves the cursor one position logically forward, adding traversed
1391 position to the selection.
1394 \begin_layout Description
1395 Notion See also LFUN_CHAR_FORWARD.
1398 \begin_layout Description
1399 Syntax char-forward-select
1402 \begin_layout Subsection*
1406 \begin_layout Description
1407 Action Moves the cursor one position "to the left".
1410 \begin_layout Description
1411 Notion This is the action which should be taken when the "left" key is pressed.
1412 Generally, it moves the cursor one position to the left.
1413 However, in Bidi text this become slightly more complicated, and there
1414 are different modes of cursor movement.
1415 In "visual mode", this moves left, plain and simple.
1416 In "logical mode", movement is logically forward in RTL paragraphs, and
1417 logically backwards in LTR paragraphs.
1420 \begin_layout Description
1424 \begin_layout Subsection*
1425 LFUN_CHAR_LEFT_SELECT
1428 \begin_layout Description
1429 Action Moves the cursor one position "to the left", adding traversed position
1433 \begin_layout Description
1434 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1437 \begin_layout Description
1438 Syntax char-left-select
1441 \begin_layout Subsection*
1445 \begin_layout Description
1446 Action Moves the cursor one position "to the right".
1449 \begin_layout Description
1450 Notion This is the action which should be taken when the "right" key is
1452 Generally, it moves the cursor one position to the right.
1453 However, in Bidi text this become slightly more complicated, and there
1454 are different modes of cursor movement.
1455 In "visual mode", this moves right, plain and simple.
1456 In "logical mode", movement is logically forward in LTR paragraphs, and
1457 logically backwards in RTL paragraphs.
1460 \begin_layout Description
1464 \begin_layout Subsection*
1465 LFUN_CHAR_RIGHT_SELECT
1468 \begin_layout Description
1469 Action Moves the cursor one position "to the right", adding traversed position
1473 \begin_layout Description
1474 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1477 \begin_layout Description
1478 Syntax char-right-select
1481 \begin_layout Subsection*
1485 \begin_layout Description
1486 Action Moves the cursor to the logically previous beginning of a word.
1489 \begin_layout Description
1490 Notion This is not the action which should be bound to the arrow keys, because
1491 backwards may be left or right, depending on the language.
1492 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1493 which in turn may employ this one.
1496 \begin_layout Description
1497 Syntax word-backward
1500 \begin_layout Subsection*
1501 LFUN_WORD_BACKWARD_SELECT
1504 \begin_layout Description
1505 Action Moves the cursor to the logically previous beginning of a word, adding
1506 the logically traversed text to the selection.
1509 \begin_layout Description
1510 Notion See also LFUN_WORD_BACKWARD.
1513 \begin_layout Description
1514 Syntax word-backward-select
1517 \begin_layout Subsection*
1518 LFUN_WORD_DELETE_BACKWARD
1521 \begin_layout Description
1522 Action Deletes characters to the beginning of the word (usually the "C+BackSpace
1526 \begin_layout Description
1527 Syntax word-delete-backward
1530 \begin_layout Subsection*
1531 LFUN_WORD_DELETE_FORWARD
1534 \begin_layout Description
1535 Action Deletes characters to the end of the word (usually the "C+Delete"
1539 \begin_layout Description
1540 Syntax word-delete-forward
1543 \begin_layout Subsection*
1544 LFUN_WORD_FIND_FORWARD
1547 \begin_layout Description
1548 Action Search for a given string in forward direction.
1551 \begin_layout Description
1552 Notion Case sensitive, match words.
1553 If no argument given, last search repeated.
1556 \begin_layout Description
1557 Syntax word-find-forward [<STRING>]
1560 \begin_layout Description
1561 Origin Etienne, 16 Feb 1998
1564 \begin_layout Subsection*
1565 LFUN_WORD_FIND_BACKWARD
1568 \begin_layout Description
1569 Action Search for a given string in backward direction.
1572 \begin_layout Description
1573 Notion Case sensitive, match words.
1574 If no argument given, last search repeated.
1577 \begin_layout Description
1578 Syntax word-find-backward [<STRING>]
1581 \begin_layout Description
1582 Origin Etienne, 20 Feb 1998
1585 \begin_layout Subsection*
1589 \begin_layout Description
1590 Action Search for next occurrence of a string.
1593 \begin_layout Description
1594 Syntax word-find [<DATA>]
1597 \begin_layout Description
1598 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1599 If no parameter is given, search with last find-dialog data is used for
1604 \begin_layout Description
1605 Origin Andre, Jan 7 2004
1608 \begin_layout Subsection*
1612 \begin_layout Description
1613 Action Replace a string in the document.
1616 \begin_layout Description
1617 Syntax word-replace [<DATA>]
1620 \begin_layout Description
1621 Params <DATA>: data is of the form "<replace>
1622 \begin_inset Newline newline
1626 \begin_inset Newline newline
1629 <casesensitive> <matchword> <all> <forward> <findnext>"
1632 \begin_layout Description
1633 Origin Andre, Jan 7 2004
1636 \begin_layout Subsection*
1640 \begin_layout Description
1641 Action Search for next occurrence of a pattern.
1644 \begin_layout Description
1645 Syntax word-findadv [<DATA>]
1648 \begin_layout Description
1649 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1650 If no parameter is given, search with last find-dialog data is used for
1655 \begin_layout Description
1656 Origin Tommaso, Nov 15 2007
1659 \begin_layout Subsection*
1663 \begin_layout Description
1664 Action Moves the cursor to the logically next beginning of a word.
1667 \begin_layout Description
1668 Notion This is not the action which should be bound to the arrow keys, because
1669 forward may be left or right, depending on the language.
1670 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1671 which in turn may employ this one.
1674 \begin_layout Description
1678 \begin_layout Subsection*
1679 LFUN_WORD_FORWARD_SELECT
1682 \begin_layout Description
1683 Action Moves the cursor to the logically next beginning of a word, adding
1684 the logically traversed text to the selection.
1687 \begin_layout Description
1688 Notion See also LFUN_WORD_FORWARD.
1691 \begin_layout Description
1692 Syntax word-forward-select
1695 \begin_layout Subsection*
1699 \begin_layout Description
1700 Action Moves the cursor to the next beginning of a word "on the left".
1703 \begin_layout Description
1704 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1706 Generally, it moves the cursor to the next beginning of a word on the left.
1707 However, in Bidi text this become slightly more complicated, and there
1708 are different modes of cursor movement.
1709 In "visual mode", this moves left, plain and simple.
1710 In "logical mode", movement is logically forward in RTL paragraphs, and
1711 logically backwards in LTR paragraphs.
1714 \begin_layout Description
1718 \begin_layout Description
1719 Origin dov, 28 Oct 2007
1722 \begin_layout Subsection*
1723 LFUN_WORD_LEFT_SELECT
1726 \begin_layout Description
1727 Action Moves the cursor to the next beginning of a word "on the left", adding
1728 *logically* traversed text to the selection.
1731 \begin_layout Description
1732 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1735 \begin_layout Description
1736 Syntax word-left-select
1739 \begin_layout Description
1740 Origin dov, 28 Oct 2007
1743 \begin_layout Subsection*
1747 \begin_layout Description
1748 Action Moves the cursor to the next beginning of a word "on the right".
1751 \begin_layout Description
1752 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1754 Generally, it moves the cursor to the next beginning of a word on the right.
1755 However, in Bidi text this become slightly more complicated, and there
1756 are different modes of cursor movement.
1757 In "visual mode", this moves right, plain and simple.
1758 In "logical mode", movement is logically forward in LTR paragraphs, and
1759 logically backwards in RTL paragraphs.
1762 \begin_layout Description
1766 \begin_layout Description
1767 Origin dov, 28 Oct 2007
1770 \begin_layout Subsection*
1771 LFUN_WORD_RIGHT_SELECT
1774 \begin_layout Description
1775 Action Moves the cursor to the next beginning of a word "on the right",
1776 adding *logically* traversed text to the selection.
1779 \begin_layout Description
1780 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1783 \begin_layout Description
1784 Syntax word-right-select
1787 \begin_layout Description
1788 Origin dov, 28 Oct 2007
1791 \begin_layout Subsection*
1795 \begin_layout Description
1796 Action Puts the word where the cursor stands into the selection.
1799 \begin_layout Description
1803 \begin_layout Description
1804 Origin Andre, 11 Sep 2002
1807 \begin_layout Subsection*
1808 LFUN_WORD_CAPITALIZE
1811 \begin_layout Description
1812 Action Capitalizes the words in the selection (i.e.
1813 the first letters) or the letter on the cursor position.
1816 \begin_layout Description
1817 Syntax word-capitalize
1820 \begin_layout Subsection*
1824 \begin_layout Description
1825 Action Change the words in the selection or from the cursor position to
1826 the end of word to the upper case.
1829 \begin_layout Description
1833 \begin_layout Subsection*
1837 \begin_layout Description
1838 Action Change the words in the selection or from the cursor position to
1839 the end of word to the lower case.
1842 \begin_layout Description
1846 \begin_layout Subsection*
1850 \begin_layout Description
1851 Action Add the word under the cursor to the respective spell checker dictionary.
1854 \begin_layout Description
1855 Syntax spelling-add [<STRING>] [<LANG>]
1858 \begin_layout Description
1859 Params <WORD>: word to add <LANG>: language name (see file languages)
1862 \begin_layout Description
1863 Origin JSpitzm, 18 Jan 2010
1866 \begin_layout Subsection*
1867 LFUN_SPELLING_IGNORE
1870 \begin_layout Description
1871 Action Let the spell checker ignore the word under the cursor in the current
1872 session for the given language.
1875 \begin_layout Description
1876 Syntax spelling-ignore [<WORD>] [<LANG>]
1879 \begin_layout Description
1880 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1883 \begin_layout Description
1884 Origin JSpitzm, 18 Jan 2010
1887 \begin_layout Subsection*
1888 LFUN_SPELLING_REMOVE
1891 \begin_layout Description
1892 Action Remove the word under the cursor from the respective spell checker
1896 \begin_layout Description
1897 Syntax spelling-remove [<STRING>] [<LANG>]
1900 \begin_layout Description
1901 Params <WORD>: word to remove <LANG>: language name (see file languages)
1904 \begin_layout Description
1905 Origin SWitt, 28 July 2010
1908 \begin_layout Subsection*
1909 LFUN_THESAURUS_ENTRY
1912 \begin_layout Description
1913 Action Look up thesaurus entries with respect to the word under the cursor.
1916 \begin_layout Description
1917 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1920 \begin_layout Description
1921 Params <STRING>: word to look up <LANG>: language (see file languages)
1924 \begin_layout Description
1925 Origin Levon, 20 Jul 2001
1928 \begin_layout Subsection*
1932 \begin_layout Description
1933 Action Move the cursor to the beginning of the document.
1936 \begin_layout Description
1940 \begin_layout Subsection*
1941 LFUN_BUFFER_BEGIN_SELECT
1944 \begin_layout Description
1945 Action Move the cursor to the beginning of the document adding the traversed
1946 text to the selection.
1949 \begin_layout Description
1950 Syntax buffer-begin-select
1953 \begin_layout Subsection*
1957 \begin_layout Description
1958 Action Move the cursor to the end of the document.
1961 \begin_layout Description
1965 \begin_layout Subsection*
1966 LFUN_BUFFER_END_SELECT
1969 \begin_layout Description
1970 Action Move the cursor to the end of the document adding the traversed text
1974 \begin_layout Description
1975 Syntax buffer-end-select
1978 \begin_layout Subsection*
1982 \begin_layout Description
1983 Action Move the cursor to the beginning of the current inset if it is not
1984 already there, or at the beginning of the enclosing inset otherwise
1987 \begin_layout Description
1991 \begin_layout Description
1992 Origin lasgouttes, 16 Mar 2009
1995 \begin_layout Subsection*
1996 LFUN_INSET_BEGIN_SELECT
1999 \begin_layout Description
2000 Action Move the cursor to the beginning of the current inset if it is not
2001 already there, or at the beginning of the enclosing inset otherwise (adding
2002 the traversed text to the selection).
2005 \begin_layout Description
2006 Syntax inset-begin-select
2009 \begin_layout Description
2010 Origin lasgouttes, 16 Mar 2009
2013 \begin_layout Subsection*
2017 \begin_layout Description
2018 Action Move the cursor to the end of the current inset if it is not already
2019 there, or at the end of the enclosing inset otherwise
2022 \begin_layout Description
2026 \begin_layout Description
2027 Origin lasgouttes, 16 Mar 2009
2030 \begin_layout Subsection*
2031 LFUN_INSET_END_SELECT
2034 \begin_layout Description
2035 Action Move the cursor to the end of the current inset if it is not already
2036 there, or at the end of the enclosing inset otherwise (adding the traversed
2037 text to the selection).
2040 \begin_layout Description
2041 Syntax inset-end-select
2044 \begin_layout Description
2045 Origin lasgouttes, 16 Mar 2009
2048 \begin_layout Subsection*
2049 LFUN_INSET_SELECT_ALL
2052 \begin_layout Description
2053 Action Selects all contents of an inset.
2056 \begin_layout Description
2057 Syntax inset-select-all
2060 \begin_layout Description
2061 Origin vfr, 22 Aug 2009
2064 \begin_layout Subsection*
2068 \begin_layout Description
2069 Action Selects the whole section.
2072 \begin_layout Description
2073 Notion The cursor should be in a section heading before calling this lfun.
2076 \begin_layout Description
2077 Syntax section-select
2080 \begin_layout Description
2081 Origin vfr, 05 May 2009
2084 \begin_layout Subsection*
2088 \begin_layout Description
2089 Action Move the cursor to the beginning of the (screen) line.
2092 \begin_layout Description
2096 \begin_layout Subsection*
2097 LFUN_LINE_BEGIN_SELECT
2100 \begin_layout Description
2101 Action Move the cursor to the beginning of the (screen) line adding the
2102 traversed text to the selection.
2105 \begin_layout Description
2106 Syntax line-begin-select
2109 \begin_layout Subsection*
2113 \begin_layout Description
2114 Action Move the cursor to the end of the (screen) line.
2117 \begin_layout Description
2121 \begin_layout Subsection*
2122 LFUN_LINE_END_SELECT
2125 \begin_layout Description
2126 Action Move the cursor to the end of the (screen) line adding the traversed
2127 text to the selection.
2130 \begin_layout Description
2131 Syntax line-end-select
2134 \begin_layout Subsection*
2138 \begin_layout Description
2139 Action Deletes the letters to the end of the (screen) line or deletes the
2143 \begin_layout Description
2144 Syntax line-delete-forward
2147 \begin_layout Subsection*
2151 \begin_layout Description
2152 Action Copies the current selection to the clipboard.
2155 \begin_layout Description
2159 \begin_layout Subsection*
2163 \begin_layout Description
2164 Action Cuts to the clipboard.
2167 \begin_layout Description
2171 \begin_layout Subsection*
2175 \begin_layout Description
2176 Action Pastes material (text or picture) from the active clipboard.
2179 \begin_layout Description
2180 Syntax paste [<TYPE>|<NUM>]
2183 \begin_layout Description
2184 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
2185 \begin_inset Newline newline
2188 <NUM>: number of the selection in the internal clipboard stack to be pasted.
2191 \begin_layout Subsection*
2192 LFUN_CLIPBOARD_PASTE
2195 \begin_layout Description
2196 Action Pastes text from the active clipboard.
2199 \begin_layout Description
2200 Syntax clipboard-paste [<ARG>]
2203 \begin_layout Description
2204 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2208 \begin_layout Description
2209 Origin Georg, 10 Jul 2006
2212 \begin_layout Subsection*
2213 LFUN_PRIMARY_SELECTION_PASTE
2216 \begin_layout Description
2217 Action Pastes the currently selected text.
2220 \begin_layout Description
2221 Notion Primary selection mechanism is linux-only thing.
2224 \begin_layout Description
2225 Syntax primary-selection-paste [<ARG>]
2228 \begin_layout Description
2229 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2233 \begin_layout Subsection*
2234 LFUN_SELECTION_PASTE
2237 \begin_layout Description
2238 Action Pastes the internal selection text in permanent selection.
2241 \begin_layout Description
2242 Notion Created in order to have middle mouse button pasting correct (bound
2243 to command-alternatives selection-paste ; primary-selection-paste paragraph).
2246 \begin_layout Description
2247 Syntax selection-paste
2250 \begin_layout Description
2251 Origin lasgouttes, 14 Jan 2009
2254 \begin_layout Subsection*
2255 LFUN_CLIPBOARD_PASTE_SIMPLE
2258 \begin_layout Description
2259 Action Pastes simple unformatted text from the active clipboard.
2262 \begin_layout Description
2263 Syntax clipboard-paste-simple [<ARG>]
2266 \begin_layout Description
2267 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2271 \begin_layout Subsection*
2275 \begin_layout Description
2276 Action Undoes the last edit.
2279 \begin_layout Description
2283 \begin_layout Subsection*
2287 \begin_layout Description
2288 Action Redoes the last thing undone.
2291 \begin_layout Description
2295 \begin_layout Subsection*
2299 \begin_layout Description
2300 Action Repeat the given command.
2303 \begin_layout Description
2304 Syntax repeat <COUNT> <LFUN-COMMAND>
2307 \begin_layout Description
2308 Origin Andre, 27 Oct 2003
2311 \begin_layout Subsection*
2312 LFUN_CHARS_TRANSPOSE
2315 \begin_layout Description
2316 Action Transposes the character at the cursor with the one before it.
2319 \begin_layout Description
2320 Syntax chars-transpose
2323 \begin_layout Description
2324 Origin Lgb, 25 Apr 2001
2327 \begin_layout Subsection*
2328 LFUN_DEPTH_DECREMENT
2331 \begin_layout Description
2332 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2336 \begin_layout Description
2337 Syntax depth-decrement
2340 \begin_layout Subsection*
2341 LFUN_DEPTH_INCREMENT
2344 \begin_layout Description
2345 Action Increase the nesting depth of the (selected) paragraph(s) inside
2349 \begin_layout Description
2350 Syntax depth-increment
2353 \begin_layout Subsection*
2357 \begin_layout Description
2358 Action Toggles the bold font (selection-wise) using mathbf in math.
2361 \begin_layout Description
2365 \begin_layout Subsection*
2366 LFUN_FONT_BOLDSYMBOL
2369 \begin_layout Description
2370 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2373 \begin_layout Description
2374 Syntax font-boldsymbol
2377 \begin_layout Subsection*
2378 LFUN_FONT_TYPEWRITER
2381 \begin_layout Description
2382 Action Toggles the typewriter family font (selection-wise).
2385 \begin_layout Description
2386 Syntax font-typewriter
2389 \begin_layout Subsection*
2393 \begin_layout Description
2394 Action Toggles underline in the font (selection-wise).
2397 \begin_layout Description
2398 Syntax font-underline
2401 \begin_layout Subsection*
2405 \begin_layout Description
2406 Action Toggles double underline in the font (selection-wise).
2409 \begin_layout Description
2410 Syntax font-underunderline
2413 \begin_layout Description
2414 Origin sanda, 5 May 2009
2417 \begin_layout Subsection*
2421 \begin_layout Description
2422 Action Toggles wavy underline in the font (selection-wise).
2425 \begin_layout Description
2426 Syntax font-underwave
2429 \begin_layout Description
2430 Origin sanda, 5 May 2009
2433 \begin_layout Subsection*
2437 \begin_layout Description
2438 Action Toggles strikeout (strike-through) in the font (selection-wise).
2441 \begin_layout Description
2442 Syntax font-strikeout
2445 \begin_layout Description
2446 Origin sanda, 3 May 2009
2449 \begin_layout Subsection*
2453 \begin_layout Description
2454 Action Toggles the emphasis font style (selection-wise).
2457 \begin_layout Description
2461 \begin_layout Subsection*
2465 \begin_layout Description
2466 Action Toggles Noun text style font (selection-wise).
2469 \begin_layout Description
2473 \begin_layout Subsection*
2477 \begin_layout Description
2478 Action Toggles Roman family font (selection-wise).
2481 \begin_layout Description
2485 \begin_layout Subsection*
2489 \begin_layout Description
2490 Action Toggles Sans Serif family font (selection-wise).
2493 \begin_layout Description
2497 \begin_layout Subsection*
2501 \begin_layout Description
2502 Action Toggles Fraktur family font (math-mode, selection-wise).
2505 \begin_layout Description
2509 \begin_layout Description
2510 Origin vermeer, 10 Jan 2002
2513 \begin_layout Subsection*
2517 \begin_layout Description
2518 Action Toggles Italics font shape (math-mode, selection-wise).
2521 \begin_layout Description
2525 \begin_layout Description
2526 Origin vermeer, 10 Jan 2002
2529 \begin_layout Subsection*
2533 \begin_layout Description
2534 Action Reverts the settings of the font to the default values (selection-wise).
2537 \begin_layout Description
2541 \begin_layout Subsection*
2545 \begin_layout Description
2546 Action Sets font size according to lyx format string.
2549 \begin_layout Description
2550 Syntax font-size <SIZE>
2553 \begin_layout Description
2554 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2555 \begin_inset Newline newline
2558 largest|huge|giant|increase|decrease|default
2561 \begin_layout Subsection*
2562 LFUN_TEXTSTYLE_APPLY
2565 \begin_layout Description
2566 Action Toggle user-defined (=last-time used) text style.
2569 \begin_layout Description
2570 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2571 triggered when using Text Style dialog.
2574 \begin_layout Description
2575 Syntax textstyle-apply
2578 \begin_layout Description
2579 Origin leeming, 12 Mar 2003
2582 \begin_layout Subsection*
2583 LFUN_TEXTSTYLE_UPDATE
2586 \begin_layout Description
2587 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2591 \begin_layout Description
2592 Syntax textstyle-update <FONT_INFO>
2595 \begin_layout Description
2596 Params <FONT_INFO>: specifies font atributes, e.g.
2597 family, series, shape, size, emph, noun, underbar, number, color, language,
2599 \begin_inset Newline newline
2602 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2605 \begin_layout Description
2606 Origin leeming, 12 Mar 2003
2609 \begin_layout Subsection*
2610 LFUN_SCREEN_FONT_UPDATE
2613 \begin_layout Description
2614 Action Update fonts and its metrics.
2617 \begin_layout Description
2618 Notion Automatically called after zoom, dpi, font names, or norm change.
2621 \begin_layout Description
2622 Syntax screen-font-update
2625 \begin_layout Description
2626 Origin ARRae, 13 Aug 2000
2629 \begin_layout Subsection*
2633 \begin_layout Description
2634 Action Returns the info about the current font.
2637 \begin_layout Description
2641 \begin_layout Subsection*
2642 LFUN_CITATION_INSERT
2645 \begin_layout Description
2646 Action Inserts citation from loaded citation database.
2649 \begin_layout Description
2650 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2653 \begin_layout Description
2654 Params <KEY>: Citation (shortcut listed in available citations).
2655 \begin_inset Newline newline
2658 <TEXT_BEFORE>: text which should appear before citation.
2661 \begin_layout Description
2662 Origin AAS, 97-02-23
2665 \begin_layout Subsection*
2666 LFUN_BIBTEX_DATABASE_ADD
2669 \begin_layout Description
2670 Action Adds database, which will be used for bibtex citations.
2673 \begin_layout Description
2674 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2675 bibliography) found from the cursor position.
2678 \begin_layout Description
2679 Syntax bibtex-database-add <DATABASE-NAME>
2682 \begin_layout Description
2683 Origin Ale, 30 May 1997
2686 \begin_layout Subsection*
2687 LFUN_BIBTEX_DATABASE_DEL
2690 \begin_layout Description
2691 Action Adds database, which will be used for bibtex citations.
2694 \begin_layout Description
2695 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2696 X bibliography) found from the cursor position.
2699 \begin_layout Description
2700 Syntax bibtex-database-del <DATABASE-NAME>
2703 \begin_layout Description
2704 Origin Ale, 30 May 1997
2707 \begin_layout Subsection*
2711 \begin_layout Description
2712 Action Sets the layout (that is, environment) for the current paragraph.
2715 \begin_layout Description
2716 Syntax layout <LAYOUT>
2719 \begin_layout Description
2720 Params <LAYOUT>: the layout to use
2723 \begin_layout Subsection*
2724 LFUN_LAYOUT_PARAGRAPH
2727 \begin_layout Description
2728 Action Launches the paragraph settings dialog.
2731 \begin_layout Description
2732 Syntax layout-paragraph
2735 \begin_layout Subsection*
2739 \begin_layout Description
2740 Action Launches the tabular settings dialog.
2743 \begin_layout Description
2744 Syntax layout-tabular
2747 \begin_layout Description
2748 Origin Jug, 31 Jul 2000
2751 \begin_layout Subsection*
2752 LFUN_DROP_LAYOUTS_CHOICE
2755 \begin_layout Description
2756 Action Displays list of layout choices.
2759 \begin_layout Description
2760 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2761 allowing for choice of layout.
2764 \begin_layout Description
2765 Syntax drop-layouts-choice
2768 \begin_layout Subsection*
2769 LFUN_LAYOUT_MODULES_CLEAR
2772 \begin_layout Description
2773 Action Clears the module list.
2776 \begin_layout Description
2777 Notion Clears the list of included modules for the current buffer.
2780 \begin_layout Description
2781 Syntax layout-modules-clear
2784 \begin_layout Description
2785 Origin rgh, 25 August 2007
2788 \begin_layout Subsection*
2789 LFUN_LAYOUT_MODULE_ADD
2792 \begin_layout Description
2793 Action Adds a module.
2796 \begin_layout Description
2797 Notion Adds a module to the list of included modules for the current buffer.
2800 \begin_layout Description
2801 Syntax layout-module-add <MODULE>
2804 \begin_layout Description
2805 Params <MODULE>: the module to be added
2808 \begin_layout Description
2809 Origin rgh, 25 August 2007
2812 \begin_layout Subsection*
2816 \begin_layout Description
2817 Action Reloads layout information.
2820 \begin_layout Description
2821 Notion Reloads all layout information for the current buffer from disk,
2822 thus recognizing any changes that have been made to layout files on the
2824 This is intended to be used only by layout developers and should not be
2825 used when one is trying to do actual work.
2828 \begin_layout Description
2829 Syntax layout-reload
2832 \begin_layout Description
2833 Origin rgh, 3 September 2007
2836 \begin_layout Subsection*
2837 LFUN_TEXTCLASS_APPLY
2840 \begin_layout Description
2841 Action Sets the text class for the current buffer.
2844 \begin_layout Description
2845 Syntax textclass-apply <TEXTCLASS>
2848 \begin_layout Description
2849 Params <TEXTCLASS>: the textclass to set.
2850 Note that this must be the filename, minus the ".layout" extension.
2853 \begin_layout Subsection*
2857 \begin_layout Description
2858 Action Loads information for a textclass from disk.
2861 \begin_layout Description
2862 Syntax textclass-load <TEXTCLASS>
2865 \begin_layout Description
2866 Params <TEXTCLASS>: the textclass to load.
2867 Note that this must be the filename, minus the ".layout" extension.
2870 \begin_layout Subsection*
2874 \begin_layout Description
2875 Action Disable selecting of text-region.
2878 \begin_layout Description
2882 \begin_layout Subsection*
2886 \begin_layout Description
2887 Action Enable selecting of text-region.
2890 \begin_layout Description
2891 Notion After enabling you can simply move arrow keys to get selected region.
2894 \begin_layout Description
2898 \begin_layout Subsection*
2902 \begin_layout Description
2903 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2906 \begin_layout Description
2910 \begin_layout Description
2911 Origin Andre, May 5 2006
2914 \begin_layout Subsection*
2918 \begin_layout Description
2919 Action Inserts math delimiters (e.g.
2920 parentheses, brackets) enclosing expression.
2923 \begin_layout Description
2924 Syntax math-delim [<LEFT>] [<RIGHT>]
2927 \begin_layout Description
2928 Params <LEFT/RIGHT>: Delimiters to be used.
2929 Each delimiter can be specified by either a LaTeX name or a valid character.
2930 ( is the default letter.
2933 \begin_layout Description
2934 Sample math-delim { rangle
2937 \begin_layout Description
2938 Origin Alejandro, 18 Jun 1996
2941 \begin_layout Subsection*
2945 \begin_layout Description
2946 Action Inserts math fixed size delimiters (e.g.
2947 parentheses, brackets) enclosing expression.
2950 \begin_layout Description
2951 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2954 \begin_layout Description
2955 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2956 \begin_inset Newline newline
2959 <L/RDELIM>: TeX code for delimiter.
2960 See Delimiter dialog for delimiters to be used.
2963 \begin_layout Description
2964 Sample math-bigdelim "Bigl" "
2971 \begin_layout Description
2972 Origin Enrico & Georg, 7 May 2006
2975 \begin_layout Subsection*
2979 \begin_layout Description
2980 Action Creates a new displayed equation in text mode.
2981 Toggles inlined/display formula in math mode.
2984 \begin_layout Description
2985 Syntax math-display [<ARG>]
2988 \begin_layout Description
2989 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2990 new equation from the text mode.
2993 \begin_layout Description
2994 Origin Alejandro, 18 Jun 1996
2997 \begin_layout Subsection*
3001 \begin_layout Description
3002 Action Inserts math objects and symbols.
3005 \begin_layout Description
3006 Notion When <ARG> is a _single_ math inset with more than one cell (such
3009 frac{x}{y}"), the content of cell(0) is replaced by the current selection
3010 (only works if the selection is in mathed).
3011 As an example, if "abc" is selected in mathed, "math-insert
3013 frac{x}{y}" replaces "abc" with "
3015 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
3016 If nothing is selected (or the selection is not in mathed), math-insert
3020 \begin_layout Description
3021 Syntax math-insert <ARG>
3024 \begin_layout Description
3025 Params <ARG>: Symbol or LaTeX code to be inserted.
3028 \begin_layout Subsection*
3032 \begin_layout Description
3033 Action Enters subscript expression in math expression.
3036 \begin_layout Description
3037 Syntax math-subscript
3040 \begin_layout Description
3041 Origin vermeer, 12 Dec 2001
3044 \begin_layout Subsection*
3045 LFUN_MATH_SUPERSCRIPT
3048 \begin_layout Description
3049 Action Enters superscript expression in math expression.
3052 \begin_layout Description
3053 Syntax math-superscript
3056 \begin_layout Description
3057 Origin vermeer, 12 Dec 2001
3060 \begin_layout Subsection*
3064 \begin_layout Description
3065 Action Toggles the position of the limits from above/below to the right
3066 side an vice versa in integral symbol, a limit, a summation, etc.
3069 \begin_layout Description
3070 Notion Put the cursor before the symbol with the limits and then invoke
3074 \begin_layout Description
3075 Syntax math-limits [<STATE>]
3078 \begin_layout Description
3079 Params <STATE>: limits|nolimits
3082 \begin_layout Subsection*
3086 \begin_layout Description
3087 Action Inserts a math macro definition at the cursor position in the text.
3090 \begin_layout Description
3091 Syntax math-macro <NAME> [<NARGS>] [def]
3094 \begin_layout Description
3095 Params <NAME>: The name of the macro, e.g.
3097 \begin_inset Newline newline
3100 <NARGS>: The number of parameters of the macro.
3102 "def": Has no effect anymore, just for compatibility with former LyX versions.
3105 \begin_layout Description
3106 Origin ale, 10 May 1997; sts, 21 Dec 2007
3109 \begin_layout Subsection*
3113 \begin_layout Description
3114 Action Mutates the type of math inset to the newly selected one.
3117 \begin_layout Description
3118 Syntax math-mutate <TYPE>
3121 \begin_layout Description
3122 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
3123 multline|gather|flalign
3126 \begin_layout Description
3127 Origin Andre, 23 May 2001
3130 \begin_layout Subsection*
3134 \begin_layout Description
3135 Action Inserts space into math expression.
3138 \begin_layout Description
3139 Notion Use spacebar after entering this space to change type of space.
3142 \begin_layout Description
3143 Syntax math-space [<TYPE>] [<LEN>]
3146 \begin_layout Description
3147 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
3148 \begin_inset Newline newline
3151 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
3152 \begin_inset Newline newline
3155 custom space: hspace
3156 \begin_inset Newline newline
3159 "," used by default.
3160 \begin_inset Newline newline
3163 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
3165 \begin_inset Newline newline
3168 <LEN>: length for custom spaces (hspace)
3171 \begin_layout Description
3172 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
3175 \begin_layout Subsection*
3179 \begin_layout Description
3180 Action Inserts a matrix.
3183 \begin_layout Description
3184 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3187 \begin_layout Description
3188 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3190 1 char) and the horizontal alignments (l, c or r) (i.e.
3194 \begin_layout Description
3195 Sample math-matrix 3 3 bccc
3198 \begin_layout Subsection*
3199 LFUN_MATH_AMS_MATRIX
3202 \begin_layout Description
3203 Action Inserts a matrix.
3206 \begin_layout Description
3207 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
3210 \begin_layout Description
3211 Params <DECORATION>: Decoration determines the LaTeX name of the matrix
3212 that should be created.
3215 \begin_layout Description
3216 Sample math-ams-matrix 3 3 bmatrix
3219 \begin_layout Subsection*
3223 \begin_layout Description
3224 Action In text mode enters math mode (i.e.
3225 puts math insets on the current cursor position), in math mode enters text
3226 mode inside math expression.
3229 \begin_layout Description
3230 Notion If there is some selected text, it puts the text inside created math
3234 \begin_layout Description
3235 Syntax math-mode [on|<ARG>]
3238 \begin_layout Description
3239 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3241 \begin_inset Newline newline
3244 "on": allow only entering of math mode from text mode.
3247 \begin_layout Description
3248 Origin Alejandro, 4 Jun 1996
3251 \begin_layout Subsection*
3255 \begin_layout Description
3256 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3258 Used by the advanced search dialog.
3261 \begin_layout Description
3262 Notion If there is any selected text, then it is moved inside the created
3266 \begin_layout Description
3267 Syntax regexp-mode [<ARG>]
3270 \begin_layout Description
3271 Params <ARG>: eventual argument (regular expression).
3274 \begin_layout Description
3275 Origin Tommaso, 4 Oct 2008
3278 \begin_layout Subsection*
3279 LFUN_MATH_NUMBER_LINE_TOGGLE
3282 \begin_layout Description
3283 Action Toggles numbering of the current formula line.
3286 \begin_layout Description
3287 Notion Must be in display formula mode.
3290 \begin_layout Description
3291 Syntax math-number-line-toggle
3294 \begin_layout Description
3295 Origin Alejandro, 18 Jun 1996
3298 \begin_layout Subsection*
3299 LFUN_MATH_NUMBER_TOGGLE
3302 \begin_layout Description
3303 Action Toggles numbering/labeling of the current formula.
3306 \begin_layout Description
3307 Notion Must be in display formula mode.
3310 \begin_layout Description
3311 Syntax math-number-toggle
3314 \begin_layout Description
3315 Origin Alejandro, 4 Jun 1996
3318 \begin_layout Subsection*
3322 \begin_layout Description
3323 Action Calls external program and passes the current expression/equation
3324 as an argument for the calculation in the format appropriate to the given
3328 \begin_layout Description
3329 Notion Selection can be used to determine the input for the external program.
3332 \begin_layout Description
3333 Syntax math-extern <LANG> [<COMMAND>]
3336 \begin_layout Description
3337 Params <LANG>: octave|maxima|maple|mathematica|script
3338 \begin_inset Newline newline
3341 where "script" stands for the external script (normalized expression will
3345 \begin_layout Description
3346 Sample math-extern maple simplify
3349 \begin_layout Description
3350 Origin Andre, 24 Apr 2001
3353 \begin_layout Subsection*
3357 \begin_layout Description
3358 Action Changes arbitrarily the size used by math fonts inside a context.
3361 \begin_layout Description
3362 Notion Provides an interface to the LaTeX math mode font size commands.
3365 \begin_layout Description
3366 Syntax math-size <STYLE>
3369 \begin_layout Description
3381 \begin_layout Description
3382 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
3385 \begin_layout Subsection*
3386 LFUN_MATH_FONT_STYLE
3389 \begin_layout Description
3390 Action Changes the text style used in math.
3393 \begin_layout Description
3394 Syntax math-font-style <STYLE>
3397 \begin_layout Description
3398 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
3399 \begin_inset Newline newline
3402 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
3405 \begin_layout Description
3406 Origin vfr, 9 jan 2009
3409 \begin_layout Subsection*
3410 LFUN_MATH_MACRO_UNFOLD
3413 \begin_layout Description
3414 Action Unfold a Math Macro.
3417 \begin_layout Description
3418 Notion Unfold the Math Macro the cursor is in, i.e.
3424 \begin_layout Description
3425 Syntax math-macro-unfold
3428 \begin_layout Description
3429 Origin sts, 06 January 2008
3432 \begin_layout Subsection*
3433 LFUN_MATH_MACRO_FOLD
3436 \begin_layout Description
3437 Action Fold a Math Macro.
3440 \begin_layout Description
3441 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3447 \begin_layout Description
3448 Syntax math-macro-fold
3451 \begin_layout Description
3452 Origin sts, 06 January 2008
3455 \begin_layout Subsection*
3456 LFUN_MATH_MACRO_ADD_PARAM
3459 \begin_layout Description
3460 Action Add a parameter.
3463 \begin_layout Description
3464 Notion Add a parameter to a Math Macro.
3467 \begin_layout Description
3468 Syntax math-macro-add-param <NUM>
3471 \begin_layout Description
3472 Params <NUM>: The number of the parameter behind which the new one will
3473 be added (1 for the first, i.e.
3474 use 0 for add a parameter at the left), defaults to the last one.
3477 \begin_layout Description
3478 Origin sts, 06 January 2008
3481 \begin_layout Subsection*
3482 LFUN_MATH_MACRO_REMOVE_PARAM
3485 \begin_layout Description
3486 Action Remove the last parameter.
3489 \begin_layout Description
3490 Notion Remove the last parameter of a Math Macro and remove its value in
3491 all instances of the macro in the buffer.
3494 \begin_layout Description
3495 Syntax math-macro-remove-param <NUM>
3498 \begin_layout Description
3499 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3500 defaults to the last one.
3503 \begin_layout Description
3504 Origin sts, 06 January 2008
3507 \begin_layout Subsection*
3508 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3511 \begin_layout Description
3512 Action Append a greedy parameter.
3515 \begin_layout Description
3516 Notion Append a greedy parameter to a Math Macro which eats the following
3517 mathed cell in every instance of the macro in the buffer.
3520 \begin_layout Description
3521 Syntax math-macro-append-greedy-param
3524 \begin_layout Description
3525 Origin sts, 06 January 2008
3528 \begin_layout Subsection*
3529 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3532 \begin_layout Description
3533 Action Remove a greedy parameter.
3536 \begin_layout Description
3537 Notion Remove a greedy parameter of a Math Macro and spit out the values
3538 of it in every instance of the macro in the buffer.
3539 If it is an optional parameter the [valud] format is used.
3542 \begin_layout Description
3543 Syntax math-macro-remove-greedy-param
3546 \begin_layout Description
3547 Origin sts, 06 January 2008
3550 \begin_layout Subsection*
3551 LFUN_MATH_MACRO_MAKE_OPTIONAL
3554 \begin_layout Description
3555 Action Make a parameter optional.
3558 \begin_layout Description
3559 Notion Turn the first non-optional parameter of a Math Macro into an optional
3560 parameter with a default value.
3563 \begin_layout Description
3564 Syntax math-macro-make-optional
3567 \begin_layout Description
3568 Origin sts, 06 January 2008
3571 \begin_layout Subsection*
3572 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3575 \begin_layout Description
3576 Action Make a parameter non-optional.
3579 \begin_layout Description
3580 Notion Turn the last optional parameter of a Math Macro into a non-optional
3582 The default value is remembered to be reused later if the user changes
3586 \begin_layout Description
3587 Syntax math-macro-make-nonoptional
3590 \begin_layout Description
3591 Origin sts, 06 January 2008
3594 \begin_layout Subsection*
3595 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3598 \begin_layout Description
3599 Action Add an optional parameter.
3602 \begin_layout Description
3603 Notion Insert an optional parameter just behind the already existing optional
3607 \begin_layout Description
3608 Syntax math-macro-add-optional-param
3611 \begin_layout Description
3612 Origin sts, 06 January 2008
3615 \begin_layout Subsection*
3616 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3619 \begin_layout Description
3620 Action Remove the last optional parameter.
3623 \begin_layout Description
3624 Notion Remove the last optional parameter of a Math Macro and remove it
3625 in all the instances of the macro in the buffer.
3628 \begin_layout Description
3629 Syntax math-macro-remove-optional-param
3632 \begin_layout Description
3633 Origin sts, 06 January 2008
3636 \begin_layout Subsection*
3637 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3640 \begin_layout Description
3641 Action Add a greedy optional parameter.
3644 \begin_layout Description
3645 Notion Add a greedy optional parameter which eats the value from the following
3646 cells in mathed which are in the [value] format.
3649 \begin_layout Description
3650 Syntax math-macro-add-greedy-optional-param
3653 \begin_layout Description
3654 Origin sts, 06 January 2008
3657 \begin_layout Subsection*
3658 LFUN_IN_MATHMACROTEMPLATE
3661 \begin_layout Description
3662 Action Only active in Math Macro definition.
3665 \begin_layout Description
3666 Notion Dummy function which is only active in a Math Macro definition.
3667 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3671 \begin_layout Description
3672 Syntax in-mathmacrotemplate
3675 \begin_layout Description
3676 Origin sts, 06 January 2008
3679 \begin_layout Subsection*
3680 LFUN_PARAGRAPH_MOVE_DOWN
3683 \begin_layout Description
3684 Action Moves the current paragraph downwards in the document.
3687 \begin_layout Description
3688 Syntax paragraph-move-down
3691 \begin_layout Description
3692 Origin Edwin, 8 Apr 2006
3695 \begin_layout Subsection*
3696 LFUN_PARAGRAPH_MOVE_UP
3699 \begin_layout Description
3700 Action Moves the current paragraph upwards in the document.
3703 \begin_layout Description
3704 Notion Movement through the document will possibly break the paragraph-depth
3709 \begin_layout Description
3710 Syntax paragraph-move-up
3713 \begin_layout Description
3714 Origin Edwin, 8 Apr 2006
3717 \begin_layout Subsection*
3721 \begin_layout Description
3722 Action Move the cursor to the next paragraph (or beginning of the current
3723 one) in upward direction.
3726 \begin_layout Description
3730 \begin_layout Description
3731 Origin Asger, 1 Oct 1996
3734 \begin_layout Subsection*
3735 LFUN_PARAGRAPH_UP_SELECT
3738 \begin_layout Description
3739 Action Move the cursor and select the text to the next paragraph (or beginning
3740 of the current one) in upward direction.
3743 \begin_layout Description
3744 Syntax paragraph-up-select
3747 \begin_layout Description
3748 Origin Asger, 1 Oct 1996
3751 \begin_layout Subsection*
3755 \begin_layout Description
3756 Action Move the cursor to the next paragraph (or beginning of the current
3757 one) in downward direction.
3760 \begin_layout Description
3761 Syntax paragraph-down
3764 \begin_layout Description
3765 Origin Asger, 1 Oct 1996
3768 \begin_layout Subsection*
3769 LFUN_PARAGRAPH_DOWN_SELECT
3772 \begin_layout Description
3773 Action Move the cursor and select the text to the next paragraph (or beginning
3774 of the current one) in downward direction.
3777 \begin_layout Description
3778 Syntax paragraph-down-select
3781 \begin_layout Description
3782 Origin Asger, 1 Oct 1996
3785 \begin_layout Subsection*
3789 \begin_layout Description
3790 Action Jump to a paragraph given by its id number and optionally the desired
3791 position within the paragraph.
3794 \begin_layout Description
3795 Notion Note that id number of paragraph is not the sequential number of
3796 paragraph seen on the screen.
3797 Moreover the id is unique for all opened buffers (documents).
3800 \begin_layout Description
3801 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3804 \begin_layout Description
3805 Params <PAR_ID_NUMBER>: paragraph id
3806 \begin_inset Newline newline
3809 <POSITION_IN_PAR>: desired position within the paragraph
3812 \begin_layout Description
3813 Origin Dekel, 26 Aug 2000
3816 \begin_layout Subsection*
3817 LFUN_PARAGRAPH_BREAK
3820 \begin_layout Description
3821 Action Breaks the current paragraph at the current location.
3824 \begin_layout Description
3825 Notion Removes the selection.
3828 \begin_layout Description
3829 Syntax paragraph-break [<LAYOUT>]
3832 \begin_layout Description
3833 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3834 default layout) when the cursor is at the end of the line.
3837 \begin_layout Subsection*
3838 LFUN_PARAGRAPH_PARAMS
3841 \begin_layout Description
3842 Action Change paragraph settings.
3845 \begin_layout Description
3846 Notion Modifies the current paragraph, or currently selected paragraphs.
3847 This function only modifies, and does not override, existing settings.
3848 Note that the "leftindent" indent setting is deprecated.
3851 \begin_layout Description
3852 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3855 \begin_layout Description
3865 \begin_inset Newline newline
3870 paragraph_spacing default|single|onehalf|double|other SIZE
3871 \begin_inset Newline newline
3876 align block|left|right|center|default
3877 \begin_inset Newline newline
3882 labelwidthstring WIDTH|
3887 \begin_layout Description
3888 Origin rgh, Aug 15 2007
3891 \begin_layout Subsection*
3892 LFUN_PARAGRAPH_PARAMS_APPLY
3895 \begin_layout Description
3896 Action Change paragraph settings.
3899 \begin_layout Description
3900 Notion Overwrite all nonspecified settings to the default ones.
3901 Use paragraph-params lfun if you don't want to overwrite others settings.
3904 \begin_layout Description
3905 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3908 \begin_layout Description
3909 Params For parameters see LFUN_PARAGRAPH_PARAMS
3912 \begin_layout Description
3913 Origin leeming, 30 Mar 2004
3916 \begin_layout Subsection*
3917 LFUN_PARAGRAPH_UPDATE
3920 \begin_layout Description
3921 Action Updates the values inside the paragraph dialog from the paragraph.
3924 \begin_layout Description
3925 Notion This is an internal LFUN, not to be used by users.
3926 Called internally by LFUN_DIALOG_UPDATE.
3929 \begin_layout Description
3930 Origin leeming, 13 Mar 2003
3933 \begin_layout Subsection*
3937 \begin_layout Description
3938 Action Move the current group in the upward direction in the structure of
3942 \begin_layout Description
3943 Notion The "group" can be Part/Chapter/Section/etc.
3944 It moves the whole substructure of the group.
3947 \begin_layout Description
3951 \begin_layout Description
3952 Origin Vermeer, 23 Mar 2006
3955 \begin_layout Subsection*
3959 \begin_layout Description
3960 Action Move the current group in the downward direction in the structure
3964 \begin_layout Description
3965 Notion The "group" can be Part/Chapter/Section/etc.
3966 It moves the whole substructure of the group.
3969 \begin_layout Description
3973 \begin_layout Description
3974 Origin Vermeer, 23 Mar 2006
3977 \begin_layout Subsection*
3981 \begin_layout Description
3982 Action Moves the current group in the downward direction in the hierarchy
3983 of the document structure.
3986 \begin_layout Description
3987 Notion Part -> Chapter -> Section -> etc.
3990 \begin_layout Description
3994 \begin_layout Description
3995 Origin Vermeer, 23 Mar 2006
3998 \begin_layout Subsection*
4002 \begin_layout Description
4003 Action Moves the current group in the upward direction in the hierarchy
4004 of the document structure.
4007 \begin_layout Description
4008 Notion Part <- Chapter <- Section <- etc.
4011 \begin_layout Description
4015 \begin_layout Description
4016 Origin Vermeer, 23 Mar 2006
4019 \begin_layout Subsection*
4023 \begin_layout Description
4024 Action Edit the inset at cursor with an external application, if one is
4028 \begin_layout Description
4029 Syntax inset-edit [<INSET_PARAMS>]
4032 \begin_layout Description
4033 Params <INSET_PARAMS>: Parameters for the inset.
4034 \begin_inset Newline newline
4037 Currently only the filename will be considered.
4040 \begin_layout Description
4041 Origin JSpitzm, 27 Apr 2006
4044 \begin_layout Subsection*
4048 \begin_layout Description
4049 Action Inserts table into the document.
4052 \begin_layout Description
4053 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
4056 \begin_layout Description
4057 Syntax tabular-insert [<ROWS> <COLUMNS>]
4060 \begin_layout Description
4061 Params In case no arguments are given show insert dialog.
4064 \begin_layout Description
4065 Origin Jug, 12 Apr 2000
4068 \begin_layout Subsection*
4072 \begin_layout Description
4073 Action Moves the cursor to the previous cell inside the table.
4076 \begin_layout Description
4077 Syntax cell-backward
4080 \begin_layout Description
4081 Origin Jug, 22 May 2000
4084 \begin_layout Subsection*
4088 \begin_layout Description
4089 Action Moves the cursor to the next cell inside the table.
4092 \begin_layout Description
4096 \begin_layout Subsection*
4100 \begin_layout Description
4101 Action Splits cell and shifts right part to the next cell (inside the math
4105 \begin_layout Description
4109 \begin_layout Description
4110 Origin Ale, 15 May 1997
4113 \begin_layout Subsection*
4117 \begin_layout Description
4118 Action Register the document as an file inside version control system.
4121 \begin_layout Description
4122 Notion File is registered inside cvs, svn or rcs repository acording to
4123 the existence of cvs/svn/rcs entries in the document's directory.
4124 \begin_inset Newline newline
4127 See LyX Additional Features Manual (Version Control Chapter) for additional
4131 \begin_layout Description
4135 \begin_layout Description
4136 Origin Lgb, 1 Jul 1997
4139 \begin_layout Subsection*
4143 \begin_layout Description
4144 Action Checks-in/commits the changes of the registered file to the repository.
4147 \begin_layout Description
4148 Notion In RCS case this also unlocks the file.
4151 \begin_layout Description
4155 \begin_layout Description
4156 Origin Lgb, 1 Jul 1997
4159 \begin_layout Subsection*
4163 \begin_layout Description
4164 Action Checks-out the document for edit (and locks it in some cases).
4167 \begin_layout Description
4171 \begin_layout Description
4172 Origin Lgb, 1 Jul 1997
4175 \begin_layout Subsection*
4179 \begin_layout Description
4180 Action Reverts the document to the last check-in/commit in VCS.
4183 \begin_layout Description
4187 \begin_layout Description
4188 Origin Lgb, 1 Jul 1997
4191 \begin_layout Subsection*
4195 \begin_layout Description
4196 Action Undo last check-in.
4199 \begin_layout Description
4200 Notion This is currently implemented only for RCS.
4203 \begin_layout Description
4207 \begin_layout Description
4208 Origin Lgb, 1 Jul 1997
4211 \begin_layout Subsection*
4215 \begin_layout Description
4216 Action Executes external command.
4217 This command is intended to support additional VCS commands.
4220 \begin_layout Description
4221 Syntax vc-command <FLAG> <PATH> <COMMAND>
4224 \begin_layout Description
4225 Params <FLAG>: Flags for the command can be combined together.
4226 \begin_inset Newline newline
4229 U - dUmmy - no flags
4230 \begin_inset Newline newline
4233 D - Doc - need document loaded to proceed
4234 \begin_inset Newline newline
4237 I - dIrty - mark document dirty
4238 \begin_inset Newline newline
4241 R - Reload - ensure that the document is saved and reload it after command
4243 \begin_inset Newline newline
4246 M - Message - ask for input string (commit message)
4247 \begin_inset Newline newline
4250 <PATH>: path where to start.
4251 $$p will be replaced by the current document path.
4252 \begin_inset Newline newline
4255 <COMMAND>: command to execute.
4256 $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
4260 \begin_layout Description
4261 Sample vc-command DR $$p "svn up"
4264 \begin_layout Description
4265 Origin sanda, 13 Jan 2009
4268 \begin_layout Subsection*
4269 LFUN_VC_LOCKING_TOGGLE
4272 \begin_layout Description
4273 Action Toggles the locking property of the edited file.
4276 \begin_layout Description
4277 Notion This is currently implemented only for SVN.
4280 \begin_layout Description
4281 Syntax vc-locking-toggle
4284 \begin_layout Description
4285 Origin sanda, 25 Jun 2009
4288 \begin_layout Subsection*
4292 \begin_layout Description
4293 Action Update the local archive directory in which resides the current document
4294 with the remote repository.
4297 \begin_layout Description
4298 Syntax vc-repo-update
4301 \begin_layout Description
4302 Origin sanda, 16 Oct 2009
4305 \begin_layout Subsection*
4309 \begin_layout Description
4310 Action Compares two revisions of the same file under version control.
4313 \begin_layout Description
4314 Syntax vc-compare [<REV1>] [<REV2>]
4317 \begin_layout Description
4318 Params Revision number either points directly to commit in history or if
4319 negative number -x it points to (last commit - x).
4320 \begin_inset Newline newline
4323 In RCS we subtract only in the last number of revision specification.
4324 Special case "0" is reserved for the last committed revision.
4325 \begin_inset Newline newline
4329 \begin_inset Newline newline
4333 Used only if REV1 > 0.
4334 \begin_inset Newline newline
4337 If no parameter is given, interactive dialog will be shown.
4340 \begin_layout Description
4341 Sample Compare current document against last commit
4342 \begin_inset Newline newline
4346 \begin_inset Newline newline
4349 Compare current document against current revision - 5 commits
4350 \begin_inset Newline newline
4354 \begin_inset Newline newline
4357 Compare revisions 120 and 155
4358 \begin_inset Newline newline
4364 \begin_layout Description
4365 Origin sanda, 12 Feb 2010
4368 \begin_layout Subsection*
4372 \begin_layout Description
4373 Action Toggles change tracking to on/off.
4376 \begin_layout Description
4377 Syntax changes-track
4380 \begin_layout Description
4381 Origin levon, 1 Oct 2002
4384 \begin_layout Subsection*
4388 \begin_layout Description
4389 Action Toggles showing of change tracking in typesetted output.
4392 \begin_layout Description
4393 Syntax changes-output
4396 \begin_layout Description
4397 Origin jspitzm, 21 Jan 2005
4400 \begin_layout Subsection*
4404 \begin_layout Description
4405 Action Moves the cursor to the position of the next change of the change
4409 \begin_layout Description
4413 \begin_layout Description
4414 Origin schmitt, 4 Oct 2006
4417 \begin_layout Subsection*
4418 LFUN_CHANGE_PREVIOUS
4421 \begin_layout Description
4422 Action Moves the cursor to the position of the previous change of the change
4426 \begin_layout Description
4427 Syntax change-previous
4430 \begin_layout Description
4431 Origin vfr, 4 Apr 2009
4434 \begin_layout Subsection*
4438 \begin_layout Description
4439 Action Open change tracking dialog for merging and moves the cursor to the
4440 position of the next change.
4443 \begin_layout Description
4444 Syntax changes-merge
4447 \begin_layout Description
4448 Origin Levon, 16 Oct 2002
4451 \begin_layout Subsection*
4455 \begin_layout Description
4456 Action Accepts tracked change inside the selection.
4459 \begin_layout Description
4460 Syntax change-accept
4463 \begin_layout Description
4464 Origin Levon, 16 Oct 2002
4467 \begin_layout Subsection*
4471 \begin_layout Description
4472 Action Rejects tracked change inside the selection.
4475 \begin_layout Description
4476 Syntax change-reject
4479 \begin_layout Description
4480 Origin Levon, 16 Oct 2002
4483 \begin_layout Subsection*
4484 LFUN_ALL_CHANGES_ACCEPT
4487 \begin_layout Description
4488 Action Accepts all tracked changes in the document.
4491 \begin_layout Description
4492 Syntax all-changes-accept
4495 \begin_layout Description
4496 Origin Levon, 16 Oct 2002
4499 \begin_layout Subsection*
4500 LFUN_ALL_CHANGES_REJECT
4503 \begin_layout Description
4504 Action Rejects all tracked changes in the document.
4507 \begin_layout Description
4508 Notion Reject does not work recursively; the user may have to repeat the
4512 \begin_layout Description
4513 Syntax all-changes-reject
4516 \begin_layout Description
4517 Origin Levon, 16 Oct 2002
4520 \begin_layout Subsection*
4524 \begin_layout Description
4525 Action Apply data for an inset.
4528 \begin_layout Description
4529 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4531 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4532 on the context where it is called.
4535 \begin_layout Description
4536 Syntax inset-apply <ARGS>
4539 \begin_layout Description
4540 Params See LFUN_INSET_INSERT .
4543 \begin_layout Subsection*
4547 \begin_layout Description
4548 Action Dissolve the current inset into text.
4551 \begin_layout Description
4552 Syntax inset-dissolve [<INSET>]
4555 \begin_layout Description
4556 Params <INSET>: this can be used to make sure the right kind of inset is
4558 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4559 the charstyle inset, even if the cursor is inside several nested insets
4561 \begin_inset Newline newline
4564 For values see lyx::InsetLayout::lyxtype_ .
4567 \begin_layout Description
4568 Origin JSpitz, 7 Aug 2006
4571 \begin_layout Subsection*
4575 \begin_layout Description
4576 Action Insert new inset (type given by the parameters).
4579 \begin_layout Description
4580 Syntax inset-insert <INSET> <ARGS>
4583 \begin_layout Description
4584 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
4585 \begin_inset Newline newline
4588 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|scri
4590 \begin_inset Newline newline
4593 <ARGS>: depends on the given inset.
4594 Use "lyx -dbg action" to explore.
4597 \begin_layout Description
4598 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4601 \begin_inset Newline newline
4604 where <label name> is the name of the referenced label and <Format> is one
4606 \begin_inset Newline newline
4610 \begin_inset Newline newline
4613 eqref -- (<reference>)
4614 \begin_inset Newline newline
4618 \begin_inset Newline newline
4621 vpageref -- on <page>
4622 \begin_inset Newline newline
4625 vref -- <reference> on <page>
4626 \begin_inset Newline newline
4629 formatted -- Formatted reference
4632 \begin_layout Subsection*
4636 \begin_layout Description
4637 Action Modify some properties of an inset.
4640 \begin_layout Description
4641 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4642 graphics, include, index, info, label, listings, newline, newpage, nomencl,
4643 note, phantom, ref, space, tabular, vspace, wrap insets.
4646 \begin_layout Description
4647 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify
4648 tabular <FEATURE> [<ARG>]
4651 \begin_layout Description
4652 Params Generally see LFUN_INSET_INSERT for further details.
4653 \begin_inset Newline newline
4656 In case that <INSET> is "tabular" various math-environment features are
4657 handled as well, e.g.
4658 add-vline-left/right for the Grid/Array environment.
4659 \begin_inset Newline newline
4662 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-colum
4663 n| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4664 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point
4665 | valign-top|valign-bottom|valign-middle|longtabular-align-left| longtabular-ali
4666 gn-center|longtabular-align-right|m-align-left|m-align-right| m-align-center|m-v
4667 align-top|m-valign-bottom|m-valign-middle|multicolumn| set-all-lines|unset-all-l
4668 ines|set-longtabular|unset-longtabular|set-pwidth| set-mpwidth|set-rotate-tabula
4669 r|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|
4670 toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltf
4671 irsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|
4672 toggle-ltcaption| set-special-column|set-special-multicolumn|set-special-multiro
4673 w| set-booktabs|unset-booktabs|set-top-space|set-bottom-space| set-interline-spa
4674 ce|set-border-lines|tabular-valign-top| tabular-valign-middle|tabular-valign-bot
4675 tom|set-tabular-width
4676 \begin_inset Newline newline
4679 <ARG>: additional argument for some commands, use debug mode to explore
4683 \begin_layout Description
4684 Sample inset-modify note Note Comment
4685 \begin_inset Newline newline
4688 inset-modify changetype Ovalbox
4691 \begin_layout Subsection*
4692 LFUN_INSET_DIALOG_UPDATE
4695 \begin_layout Description
4696 Action Updates the values inside the dialog from the inset.
4699 \begin_layout Description
4700 Notion This is an internal LFUN, not to be used by users.
4701 Called internally by LFUN_DIALOG_UPDATE
4704 \begin_layout Description
4705 Params <DIALOG-NAME>
4708 \begin_layout Description
4709 Origin leeming, 25 Feb 2003
4712 \begin_layout Subsection*
4716 \begin_layout Description
4717 Action Open the inset's properties dialog.
4720 \begin_layout Description
4721 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
4722 graphics, href, include, index, index_print, label, line, listings, note,
4723 phantom, ref, space, tabular, vspace, wrap insets.
4726 \begin_layout Description
4727 Syntax inset-settings <INSET>
4730 \begin_layout Description
4731 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
4732 \begin_inset Newline newline
4735 graphics|href|include|index|index_print|label|line|
4736 \begin_inset Newline newline
4739 listings|note|phantom|ref|space|tabular|vspace|wrap>.
4742 \begin_layout Subsection*
4746 \begin_layout Description
4747 Action Toggles the collapsible inset at cursor position, or the inset we
4751 \begin_layout Description
4752 Syntax inset-toggle [<ARG>]
4755 \begin_layout Description
4756 Params <ARG>: <open|close|toggle|assign>.
4757 \begin_inset Newline newline
4760 open/close/toggle are for collapsible insets.
4761 toggle is used when no argument is given.
4762 \begin_inset Newline newline
4765 assign synchronize the branch-inset with activation status of the branch.
4766 Used for global toggling when changed activation.
4769 \begin_layout Description
4770 Origin lasgouttes, 19 Jul 2001
4773 \begin_layout Subsection*
4777 \begin_layout Description
4778 Action Apply the given commands on insets of a given name.
4781 \begin_layout Description
4782 Notion WARNING: use at your own risks; this function gives you too many
4783 ways of shooting yourself in the foot.
4784 A typical example is inset-forall Note note-insert which starts an infinite
4786 This is mitigated by the fact that the number of actions is arbitrarily
4788 Note also that inset-forall does not update metrics between iterations,
4789 which can lead to bugs.
4790 This has to be eventually fixed.
4793 \begin_layout Description
4794 Syntax inset-forall <NAME> <LFUN-COMMAND>
4795 \begin_inset Newline newline
4798 <NAME>: Type of Inset.
4799 If <NAME> is *, all insets are matched.
4800 The name is used like for InsetLayout in layout files: "Note" matches all
4801 note insets, while "Note:Note" only matches LyX yellow note insets.
4804 \begin_layout Description
4805 Sample Remove all index insets:
4806 \begin_inset Newline newline
4809 inset-forall Index delete-char-forward
4810 \begin_inset Newline newline
4813 Close all Notes (also works for a particular branch, for example):
4814 \begin_inset Newline newline
4817 inset-forall Note inset-toggle close
4818 \begin_inset Newline newline
4821 Transform all yellow notes to comments
4822 \begin_inset Newline newline
4825 inset-forall Note:Note inset-modify note Note Comment
4826 \begin_inset Newline newline
4829 Try to put LyX in an infinite loop if there is at least a Note:
4830 \begin_inset Newline newline
4833 inset-forall Note char-backward
4836 \begin_layout Description
4837 Origin lasgouttes, 27 Nov 2009
4840 \begin_layout Subsection*
4841 LFUN_GRAPHICS_RELOAD
4844 \begin_layout Description
4845 Action Reloads the image if necessary.
4848 \begin_layout Description
4849 Syntax graphics-reload
4852 \begin_layout Description
4853 Origin vfr, 10 Aug 2009
4856 \begin_layout Subsection*
4857 LFUN_SET_GRAPHICS_GROUP
4860 \begin_layout Description
4861 Action Set the group for the graphics inset on the cursor position.
4864 \begin_layout Description
4865 Syntax set-graphics-group [<GROUP>]
4868 \begin_layout Description
4869 Params <GROUP>: Id for an existing group.
4870 In case the Id is an empty string, the graphics inset is removed from the
4874 \begin_layout Description
4875 Origin sanda, 6 May 2008
4878 \begin_layout Subsection*
4879 LFUN_FINISHED_FORWARD
4882 \begin_layout Description
4883 Action Moves the cursor out of the current slice, going forward.
4886 \begin_layout Description
4887 Notion Cursor movement within an inset may be different than cursor movement
4888 in the surrounding text.
4889 This action should be called automatically by the cursor movement within
4890 the inset, when movement within the inset has ceased (reached the end of
4891 the last paragraph, for example), in order to move correctly back into
4892 the surrounding text.
4895 \begin_layout Subsection*
4896 LFUN_FINISHED_BACKWARD
4899 \begin_layout Description
4900 Action Moves the cursor out of the current slice, going backwards.
4903 \begin_layout Description
4904 Notion See also LFUN_FINISHED_FORWARD.
4907 \begin_layout Subsection*
4911 \begin_layout Description
4912 Action Moves the cursor out of the current slice, going right.
4915 \begin_layout Description
4916 Notion See also LFUN_FINISHED_FORWARD
4919 \begin_layout Subsection*
4923 \begin_layout Description
4924 Action Moves the cursor out of the current slice, going left.
4927 \begin_layout Description
4928 Notion See also LFUN_FINISHED_FORWARD.
4931 \begin_layout Subsection*
4935 \begin_layout Description
4936 Action Set language from the current cursor position.
4939 \begin_layout Description
4940 Syntax language <LANG>
4943 \begin_layout Description
4944 Params <LANG>: Requested language.
4945 Look in lib/languages for the list.
4948 \begin_layout Description
4949 Origin Dekel, 2 Mar 2000
4952 \begin_layout Subsection*
4956 \begin_layout Description
4957 Action Goto a label.
4960 \begin_layout Description
4961 Syntax label-goto [<LABEL>]
4964 \begin_layout Description
4965 Params <LABEL>: Requested label.
4966 If no label is given and reference is on cursor position, Bookmark 0 is
4967 saved and cursor moves to the position of referenced label.
4970 \begin_layout Description
4971 Origin Ale, 6 Aug 1997
4974 \begin_layout Subsection*
4978 \begin_layout Description
4979 Action Inserts label to text or displayed formula.
4982 \begin_layout Description
4983 Syntax label-insert [<LABEL>]
4986 \begin_layout Description
4987 Params <LABEL>: Requested label.
4988 If no label is given dialog requesting name will be opened.
4991 \begin_layout Subsection*
4995 \begin_layout Description
4996 Action Go to the next label or cross-reference.
4999 \begin_layout Description
5000 Syntax reference-next
5003 \begin_layout Description
5004 Origin Dekel, 14 Jan 2001
5007 \begin_layout Subsection*
5011 \begin_layout Description
5012 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
5013 Note that bookmarks are saved per-session, not per file.
5016 \begin_layout Description
5017 Notion Bookmark 0 has a special purpose.
5018 It is automatically set
5019 \begin_inset Newline newline
5023 to the paragraph you are currently editing
5024 \begin_inset Newline newline
5028 to the paragraph from where you are jumping to the last-edited position
5030 \begin_inset Newline newline
5034 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
5037 \begin_layout Description
5038 Syntax bookmark-goto <NUMBER>
5041 \begin_layout Description
5042 Params <NUMBER>: the number of the bookmark to restore.
5045 \begin_layout Description
5046 Origin Dekel, 27 January 2001
5049 \begin_layout Subsection*
5053 \begin_layout Description
5054 Action Save a bookmark.
5057 \begin_layout Description
5058 Notion Saves a numbered bookmark to the sessions file.
5059 The number must be between 1 and 9, inclusive.
5060 Note that bookmarks are saved per-session, not per file.
5063 \begin_layout Description
5064 Syntax bookmark-save <NUMBER>
5067 \begin_layout Description
5068 Params <NUMBER>: the number of the bookmark to save.
5071 \begin_layout Description
5072 Origin Dekel, 27 January 2001
5075 \begin_layout Subsection*
5079 \begin_layout Description
5080 Action Clears the list of saved bookmarks.
5083 \begin_layout Description
5084 Syntax bookmark-clear
5087 \begin_layout Description
5088 Origin bpeng, 31 October 2006
5091 \begin_layout Subsection*
5095 \begin_layout Description
5096 Action Open the given help file according to the language setting.
5099 \begin_layout Description
5100 Syntax help-open <FILE>[.lyx]
5103 \begin_layout Description
5104 Params <FILE>: any document from (/usr/share/)doc directory.
5107 \begin_layout Description
5108 Origin Jug, 27 Jun 1999
5111 \begin_layout Subsection*
5115 \begin_layout Description
5116 Action Terminates the current LyX instance.
5119 \begin_layout Description
5120 Notion Terminates the current LyX instance, asking whether to save modified
5124 \begin_layout Description
5128 \begin_layout Subsection*
5132 \begin_layout Description
5133 Action Toggles visibility of a given toolbar between on/off/auto.
5136 \begin_layout Description
5137 Notion Skipping "auto" when allowauto is false.
5140 \begin_layout Description
5141 Syntax toolbar-toggle <NAME> [allowauto]
5144 \begin_layout Description
5145 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
5146 \begin_inset Newline newline
5149 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
5152 \begin_layout Description
5153 Origin Edwin, 21 May 2007
5156 \begin_layout Subsection*
5160 \begin_layout Description
5161 Action Opens the menu given by its name.
5164 \begin_layout Description
5165 Syntax menu-open <NAME>
5168 \begin_layout Description
5169 Params <NAME>: menu name.
5170 See various .inc files in lib/ui for candidates.
5173 \begin_layout Subsection*
5177 \begin_layout Description
5178 Action Various UI visibility-toggling actions.
5181 \begin_layout Description
5182 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5185 \begin_layout Description
5186 Params statusbar : Toggle visibility of the statusbar.
5187 \begin_inset Newline newline
5190 menubar : Toggle visibility of the menubar.
5191 \begin_inset Newline newline
5194 scrollbar : Toggle visibility of the scrollbar.
5195 \begin_inset Newline newline
5198 frame : Toggle visibility of the frames around editing window.
5199 \begin_inset Newline newline
5202 fullscreen : Toggle fullscreen mode.
5203 This also covers calling the previous functions.
5204 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5208 \begin_layout Description
5209 Origin sanda, 9 Feb 2007
5212 \begin_layout Subsection*
5216 \begin_layout Description
5217 Action Creates new empty LyX window.
5220 \begin_layout Description
5221 Notion Already opened documents from the previous window can be found under
5225 \begin_layout Description
5226 Syntax window-new [<GEOMETRY>]
5229 \begin_layout Description
5230 Params <GEOMETRY>: pass the geometry of the window.
5231 This parameter is currently accepted only on Windows platform.
5234 \begin_layout Description
5235 Origin Abdel, 21 Oct 2006
5238 \begin_layout Subsection*
5242 \begin_layout Description
5243 Action Closes the current LyX window.
5246 \begin_layout Description
5250 \begin_layout Description
5251 Origin Abdel, 23 Oct 2006
5254 \begin_layout Subsection*
5258 \begin_layout Description
5259 Action Creates another split view of current buffer.
5262 \begin_layout Description
5263 Notion All split views act in the same way independently.
5266 \begin_layout Description
5267 Syntax view-split <vertical|horizontal>
5270 \begin_layout Description
5271 Params horizontal : The work areas are laid out side by side.
5272 \begin_inset Newline newline
5275 vertical : The work areas laid out vertically.
5278 \begin_layout Description
5279 Origin Abdel, 20 Feb 2008
5282 \begin_layout Subsection*
5286 \begin_layout Description
5287 Action Close the current document work area.
5290 \begin_layout Description
5291 Notion Close the current work area.
5292 If no other work areas are showing the buffer, then close the associated
5296 \begin_layout Description
5300 \begin_layout Description
5301 Origin Tommaso, 15 Sep 2012
5304 \begin_layout Subsection*
5305 LFUN_TAB_GROUP_CLOSE
5308 \begin_layout Description
5309 Action Close the current tab group.
5312 \begin_layout Description
5313 Notion This only closes the work areas, not the buffers themselves.
5314 The still opened buffers can be visualized in another tab group.
5317 \begin_layout Description
5318 Syntax tab-group-close
5321 \begin_layout Description
5322 Origin Abdel, 21 Feb 2008
5325 \begin_layout Subsection*
5329 \begin_layout Description
5330 Action Shows hidden dialog or creates new one for a given function/inset
5334 \begin_layout Description
5335 Syntax dialog-show <NAME> [<DATA>]
5338 \begin_layout Description
5339 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5340 \begin_inset Newline newline
5343 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
5344 \begin_inset Newline newline
5347 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
5349 \begin_inset Newline newline
5352 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
5353 \begin_inset Newline newline
5356 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
5357 \begin_inset Newline newline
5360 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
5361 \begin_inset Newline newline
5364 <SPECIAL>: latexlog|vclog
5365 \begin_inset Newline newline
5368 <DATA>: data, usually settings for the given dialog.
5369 Use debug mode for the details.
5372 \begin_layout Description
5373 Origin leeming, 17 Jun 2003
5376 \begin_layout Subsection*
5377 LFUN_DIALOG_SHOW_NEW_INSET
5380 \begin_layout Description
5381 Action Shows hidden dialog or create new one for a given inset settings
5385 \begin_layout Description
5386 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5390 \begin_layout Description
5391 Syntax dialog-show-new-inset <NAME> [<DATA>]
5394 \begin_layout Description
5395 Params See LFUN_DIALOG_SHOW .
5398 \begin_layout Description
5399 Origin leeming, 25 Feb 2003
5402 \begin_layout Subsection*
5406 \begin_layout Description
5407 Action Updates the dialog values from the inset/paragraph/document.
5410 \begin_layout Description
5411 Syntax dialog-update <NAME>
5414 \begin_layout Description
5415 Params <NAME>: paragraph|prefs|<INSET>
5416 \begin_inset Newline newline
5422 \begin_layout Description
5423 Origin leeming, 25 Feb 2003
5426 \begin_layout Subsection*
5430 \begin_layout Description
5431 Action Hides showed dialog.
5432 Counterpart to LFUN_DIALOG_SHOW .
5435 \begin_layout Description
5436 Syntax dialog-hide <NAME>
5439 \begin_layout Description
5440 Params See LFUN_DIALOG_SHOW .
5443 \begin_layout Description
5444 Origin leeming, 25 Feb 2003
5447 \begin_layout Subsection*
5451 \begin_layout Description
5452 Action Toggles dialog between showed/hidden state.
5455 \begin_layout Description
5456 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5459 \begin_layout Description
5460 Syntax dialog-toggle <NAME> [<DATA>]
5463 \begin_layout Description
5464 Params See LFUN_DIALOG_SHOW .
5467 \begin_layout Description
5468 Origin JSpitzm, 30 Apr 2007
5471 \begin_layout Subsection*
5472 LFUN_DIALOG_DISCONNECT_INSET
5475 \begin_layout Description
5476 Action Closes opened connection to opened inset.
5479 \begin_layout Description
5480 Notion Connection is used for apply functions.
5483 \begin_layout Description
5484 Syntax dialog-disconnect-inset <INSET-NAME>
5487 \begin_layout Description
5488 Origin leeming, 25 Feb 2003
5491 \begin_layout Subsection*
5495 \begin_layout Description
5496 Action This function is called when mouse button is pressed (inside workarea).
5497 Action depends on the context.
5500 \begin_layout Description
5501 Notion This is an internal LFUN, not to be used by users.
5504 \begin_layout Description
5505 Origin Andre, 9 Aug 2002
5508 \begin_layout Subsection*
5512 \begin_layout Description
5513 Action This function is called when double click on mouse button is pressed
5515 Action depends on the context.
5518 \begin_layout Description
5519 Notion This is an internal LFUN, not to be used by users.
5522 \begin_layout Description
5523 Origin Andre, 9 Aug 2002
5526 \begin_layout Subsection*
5530 \begin_layout Description
5531 Action This function is called when triple click on mouse button is pressed
5533 Action depends on the context.
5536 \begin_layout Description
5537 Notion This is an internal LFUN, not to be used by users.
5540 \begin_layout Description
5541 Origin Andre, 9 Aug 2002
5544 \begin_layout Subsection*
5548 \begin_layout Description
5549 Action This function is called when mouse cursor is moving over the text.
5550 Action depends on the context.
5553 \begin_layout Description
5554 Notion This is an internal LFUN, not to be used by users.
5557 \begin_layout Description
5558 Origin Andre, 9 Aug 2002
5561 \begin_layout Subsection*
5565 \begin_layout Description
5566 Action This function is called when mouse button is released (inside workarea).
5567 Action depends on the context.
5570 \begin_layout Description
5571 Notion This is an internal LFUN, not to be used by users.
5574 \begin_layout Description
5575 Origin Andre, 9 Aug 2002
5578 \begin_layout Subsection*
5582 \begin_layout Description
5583 Action Turn off the loaded keyboard map.
5586 \begin_layout Description
5590 \begin_layout Subsection*
5594 \begin_layout Description
5595 Action Turn on the primary keyboard map.
5598 \begin_layout Description
5599 Notion Maps were widely used in past, when X-windows didn't have nowadays
5601 They can be still used to maintain uniform keyboard layout across the various
5603 \begin_inset Newline newline
5606 The language is to be set in the Preferences dialog.
5609 \begin_layout Description
5610 Syntax keymap-primary
5613 \begin_layout Subsection*
5614 LFUN_KEYMAP_SECONDARY
5617 \begin_layout Description
5618 Action Turn on the secondary keyboard map.
5621 \begin_layout Description
5622 Syntax keymap-secondary
5625 \begin_layout Subsection*
5629 \begin_layout Description
5630 Action Toggles keyboard maps (first/second/off).
5633 \begin_layout Description
5634 Syntax keymap-toggle
5637 \begin_layout Description
5638 Origin leeming, 30 Mar 2004
5641 \begin_layout Subsection*
5642 LFUN_SERVER_GET_LAYOUT
5645 \begin_layout Description
5646 Action Returns the current layout (that is environment) name on the cursor
5650 \begin_layout Description
5651 Syntax server-get-layout
5654 \begin_layout Subsection*
5655 LFUN_SERVER_GET_FILENAME
5658 \begin_layout Description
5659 Action Returns path and file name of the currently edited document.
5662 \begin_layout Description
5663 Syntax server-get-filename
5666 \begin_layout Subsection*
5667 LFUN_SERVER_GOTO_FILE_ROW
5670 \begin_layout Description
5671 Action Sets the cursor position in LyX based on the row number of generated
5675 \begin_layout Description
5676 Notion This can be useful for DVI inverse-search or detection of the problematic
5677 line from LaTeX compilation.
5678 Note that before this function can be used export to LaTeX output must
5679 occur (in order to map the row numbers).
5682 \begin_layout Description
5683 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5686 \begin_layout Description
5687 Params <FILE>: the path and filename.
5688 Environment variables are expanded in the path.
5689 In case this LFUN does not work make sure you are giving correct path to
5691 \begin_inset Newline newline
5694 If the file is located inside LyX temporary directory it will be mapped
5695 back into the appropriate opened buffer (e.g.
5696 for the case of generated .tex file).
5697 \begin_inset Newline newline
5700 .ext: extensions will be automatically replaced by .lyx.
5701 \begin_inset Newline newline
5704 <ROW_NUMBER> The row number of the LaTeX file to which to go.
5707 \begin_layout Description
5708 Sample server-goto-file-row /home/user/example.lyx 41
5709 \begin_inset Newline newline
5712 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
5715 \begin_layout Description
5716 Origin Edmar, 23 Dec 1998
5719 \begin_layout Subsection*
5723 \begin_layout Description
5724 Action Sets the cursor position in the previewed (dvi/pdf) file based on
5725 the row number in LyX window.
5728 \begin_layout Description
5729 Notion The external program used for forward search call can be specified
5730 in LyX Output preferences.
5731 See Additional manual for details of these settings.
5734 \begin_layout Description
5735 Syntax forward-search
5738 \begin_layout Description
5739 Origin sanda, 14 Apr 2010
5742 \begin_layout Subsection*
5746 \begin_layout Description
5747 Action Sends notify message about the last key-sequence to client.
5750 \begin_layout Description
5751 Notion This can be used to grab last key-sequence used inside the LyX window.
5752 See also Debug extensions section in Additional features manual.
5755 \begin_layout Description
5756 Syntax server-notify
5759 \begin_layout Subsection*
5763 \begin_layout Description
5764 Action Sets the cursor position based on the editing area coordinates (similar
5765 to clicking on that point with left mouse button).
5768 \begin_layout Description
5769 Syntax server-set-xy <X> <Y>
5772 \begin_layout Subsection*
5776 \begin_layout Description
5777 Action Returns the coordinates of cursor position in the editing area.
5780 \begin_layout Description
5781 Syntax server-get-xy
5784 \begin_layout Subsection*
5788 \begin_layout Description
5789 Action Generates the code (literate programming).
5792 \begin_layout Description
5793 Notion Latex file with extension
5795 literate_extension is generated.
5798 build_command (with a default of ``make'') to generate the code and
5800 build_error_filter to process the compilation error messages.
5801 \begin_inset Newline newline
5804 In case you want to process your literate file with a script, or some other
5805 program, just insert in your lyxrc file an entry with:
5806 \begin_inset Newline newline
5811 build_command "my_script my_arguments"
5812 \begin_inset Newline newline
5817 build_error_filter differs from the
5819 literate_error_filter only in that the former will identify error messages
5823 \begin_layout Description
5824 Syntax build-program
5827 \begin_layout Subsection*
5828 LFUN_BUFFER_AUTO_SAVE
5831 \begin_layout Description
5832 Action Saves the current buffer to a temporary file.
5835 \begin_layout Description
5836 Notion Saves the current buffer to a file named "#filename#".
5837 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5840 \begin_layout Description
5841 Syntax buffer-auto-save
5844 \begin_layout Subsection*
5845 LFUN_BUFFER_CHILD_OPEN
5848 \begin_layout Description
5849 Action Loads the given child document.
5852 \begin_layout Description
5853 Notion The current document is treated as a parent.
5856 \begin_layout Description
5857 Syntax buffer-child-open <FILE>
5860 \begin_layout Description
5861 Params <FILE>: Filename of the child.
5862 The directory of the parent is assumed by default.
5865 \begin_layout Description
5866 Origin Ale, 28 May 1997
5869 \begin_layout Subsection*
5873 \begin_layout Description
5874 Action Runs chktex for the current document.
5877 \begin_layout Description
5878 Syntax buffer-chktex
5881 \begin_layout Description
5882 Origin Asger, 30 Oct 1997
5885 \begin_layout Subsection*
5886 LFUN_BUFFER_TOGGLE_COMPRESSION
5889 \begin_layout Description
5890 Action Toggles compression of the current document on/off.
5893 \begin_layout Description
5894 Syntax buffer-toggle-compression
5897 \begin_layout Description
5898 Origin bpeng, 27 Apr 2006
5901 \begin_layout Subsection*
5902 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
5905 \begin_layout Description
5906 Action Toggles including of resources for forward/reverse search of the
5910 \begin_layout Description
5911 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
5913 Custom LaTeX macro can be defined in preferences.
5916 \begin_layout Description
5917 Syntax buffer-toggle-output-sync
5920 \begin_layout Description
5921 Origin sanda, 25 May 2010
5924 \begin_layout Subsection*
5928 \begin_layout Description
5929 Action Closes the current buffer.
5932 \begin_layout Description
5933 Notion Closes the current buffer, asking whether to save it, etc, if the
5934 buffer has been modified.
5937 \begin_layout Description
5941 \begin_layout Subsection*
5942 LFUN_BUFFER_CLOSE_ALL
5945 \begin_layout Description
5946 Action Closes all buffers.
5949 \begin_layout Description
5950 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
5954 \begin_layout Description
5955 Syntax buffer-close-all
5958 \begin_layout Subsection*
5962 \begin_layout Description
5963 Action Exports the current buffer (document) to the given format.
5966 \begin_layout Description
5967 Syntax buffer-export <FORMAT> [<DEST>]
5970 \begin_layout Description
5971 Params <FORMAT> is either "custom" or one of the formats which you can find
5972 in Tools->Preferences->File formats->Format.
5973 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5974 for pdflatex) or "ps" for postscript.
5975 \begin_inset Newline newline
5978 In case of "custom" you will be asked for a format you want to start from
5979 and for the command that you want to apply to this format.
5980 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5981 <DEST> If present, this argument provides the export destination filename.
5982 Its containing folder will also be the destination folder, where all
5983 the needed external files will be copied.
5986 \begin_layout Description
5987 Origin Lgb, 29 Jul 1997
5990 \begin_layout Subsection*
5991 LFUN_BUFFER_EXPORT_CUSTOM
5994 \begin_layout Description
5995 Action Exports the current buffer (document) from the given format using
5996 the given command on it.
5999 \begin_layout Description
6000 Syntax buffer-export-custom <FORMAT> <COMMAND>
6003 \begin_layout Description
6004 Params <FORMAT> format to start from (LyX will care to produce such intermediate
6006 \begin_inset Newline newline
6009 <COMMAND> this command will be launched on the file.
6010 Note that you can use "$$FName" string to qualify the intermediate file.
6013 \begin_layout Description
6014 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
6017 \begin_layout Description
6018 Origin leeming, 27 Mar 2004
6021 \begin_layout Subsection*
6022 LFUN_BUFFER_EXPORT_AS
6025 \begin_layout Description
6026 Action Pops up a dialog for exporting the current buffer.
6029 \begin_layout Description
6030 Syntax buffer-export-as
6033 \begin_layout Description
6034 Origin tommaso, 6 Oct 2011
6037 \begin_layout Subsection*
6041 \begin_layout Description
6042 Action Prints the current document.
6045 \begin_layout Description
6046 Notion Many settings can be given via the preferences dialog.
6049 \begin_layout Description
6050 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
6053 \begin_layout Description
6054 Params <TARGET> is either "printer" or "file".
6055 \begin_inset Newline newline
6058 <TARGER-NAME> is either "default" or file name or printer name.
6059 \begin_inset Newline newline
6062 <COMMAND> command ensuring the printing job.
6065 \begin_layout Description
6066 Sample buffer-print file "/trash/newfile1.ps" "dvips"
6069 \begin_layout Description
6070 Origin leeming, 28 Mar 2004
6073 \begin_layout Subsection*
6077 \begin_layout Description
6078 Action Import a given file as a lyx document.
6081 \begin_layout Description
6082 Notion File can be imported iff lyx file format is (transitively) reachable
6083 via defined converters in preferences.
6084 Look in the File->Import menu to get an idea of the currently active import
6088 \begin_layout Description
6089 Syntax buffer-import <FORMAT> [<FILE>]
6092 \begin_layout Description
6093 Origin Asger, 24 Jul 1998
6096 \begin_layout Subsection*
6100 \begin_layout Description
6101 Action Creates a new buffer (that is, document) and switches to it.
6104 \begin_layout Description
6105 Notion Implicit path can be set in Preferences dialog.
6108 \begin_layout Description
6109 Syntax buffer-new [<FILE>]
6112 \begin_layout Description
6113 Params <FILE>: filename of created file with absolute path.
6116 \begin_layout Subsection*
6117 LFUN_BUFFER_NEW_TEMPLATE
6120 \begin_layout Description
6121 Action Creates a new buffer (that is, document) from a template.
6124 \begin_layout Description
6125 Notion Path for new files and templates can be set in Preferences dialog.
6126 Template will be asked for via Open-dialog.
6129 \begin_layout Description
6130 Syntax buffer-new-template [<FILE>]
6133 \begin_layout Description
6134 Params <FILE>: filename of created file with absolute path.
6137 \begin_layout Subsection*
6141 \begin_layout Description
6142 Action Reverts opened document.
6145 \begin_layout Description
6146 Syntax buffer-reload
6149 \begin_layout Description
6150 Origin Asger, 2 Feb 1997
6153 \begin_layout Subsection*
6157 \begin_layout Description
6158 Action Display and switch to the given buffer.
6161 \begin_layout Description
6162 Syntax buffer-switch <BUFFER>
6165 \begin_layout Description
6166 Params <BUFFER>: path and filename of already opened (but possibly hidden)
6167 document which is to be shown.
6170 \begin_layout Subsection*
6171 LFUN_BUFFER_TOGGLE_READ_ONLY
6174 \begin_layout Description
6175 Action Toggle editing mode of the current document between read/write and
6179 \begin_layout Description
6180 Notion This function is not allowed if the file is under version control,
6181 since read-only flag is often used in version control file locking.
6184 \begin_layout Description
6185 Syntax buffer-toggle-read-only
6188 \begin_layout Description
6189 Origin Lgb, 27 May 1997
6192 \begin_layout Subsection*
6196 \begin_layout Description
6197 Action Displays current buffer in chosen format.
6200 \begin_layout Description
6201 Notion Displays the contents of the current buffer in the chosen format,
6202 for example, PDF or DVI.
6203 This runs the necessary converter, calls the defined viewer, and so forth.
6206 \begin_layout Description
6207 Syntax buffer-view [<FORMAT>]
6210 \begin_layout Description
6211 Params <FORMAT>: The format to display, where this is one of the formats
6212 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6213 If no format is given, the default format as specified in the same dialog
6217 \begin_layout Subsection*
6221 \begin_layout Description
6222 Action Exports the current document and put the result into the temporary
6226 \begin_layout Description
6227 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6228 EW) the output will be rewritten - updated.
6229 This is useful in case your viewer is able to detect such changes (e.g.
6230 ghostview for postscript).
6233 \begin_layout Description
6234 Syntax buffer-update [<FORMAT>]
6237 \begin_layout Description
6238 Params <FORMAT>: The format to display, where this is one of the formats
6239 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6240 If no format is given, the default format as specified in the same dialog
6244 \begin_layout Description
6245 Origin Dekel, 5 Aug 2000
6248 \begin_layout Subsection*
6252 \begin_layout Description
6253 Action Saves the current buffer.
6256 \begin_layout Description
6257 Notion Saves the current buffer to disk, using the filename that is already
6258 associated with the buffer, asking for one if none is yet assigned.
6261 \begin_layout Description
6265 \begin_layout Subsection*
6266 LFUN_BUFFER_WRITE_AS
6269 \begin_layout Description
6270 Action Rename and save current buffer.
6273 \begin_layout Description
6274 Syntax buffer-write-as <FILENAME>
6277 \begin_layout Description
6278 Params <FILENAME>: New name of the buffer/file.
6279 A relative path is with respect to the original location of the buffer/file.
6282 \begin_layout Subsection*
6286 \begin_layout Description
6287 Action Applies a command to all visible, hidden, or both types of buffers
6288 in the active window.
6291 \begin_layout Description
6292 Syntax buffer-forall [<BUFFER-TYPE>] <LFUN-COMMAND>
6295 \begin_layout Description
6296 Params <BUFFER-TYPE>: <visible|hidden|both default:> default: visible <LFUN-COMM
6297 AND>: The command that is to be applied to the buffers.
6300 \begin_layout Description
6301 Sample Close all Notes in all visible documents:
6302 \begin_inset Newline newline
6305 buffer-forall inset-forall Note inset-toggle close
6306 \begin_inset Newline newline
6309 Toggle change tracking on all documents:
6310 \begin_inset Newline newline
6313 buffer-forall both changes-track
6314 \begin_inset Newline newline
6317 Toggle read-only for all visible documents:
6318 \begin_inset Newline newline
6321 buffer-forall buffer-toggle-read-only
6322 \begin_inset Newline newline
6325 Show statistics for each document:
6326 \begin_inset Newline newline
6329 buffer-forall both statistics
6330 \begin_inset Newline newline
6333 Activate the branch named "Solutions" in all visible documents:
6334 \begin_inset Newline newline
6337 buffer-forall branch-activate Solutions
6338 \begin_inset Newline newline
6341 Export all visible documents to PDF (pdflatex):
6342 \begin_inset Newline newline
6345 buffer-forall buffer-export pdf2
6346 \begin_inset Newline newline
6352 \begin_layout Description
6353 Origin scottkostyshak, 20 Jul 2012
6356 \begin_layout Subsection*
6357 LFUN_BUFFER_WRITE_ALL
6360 \begin_layout Description
6361 Action Save all changed documents.
6364 \begin_layout Description
6365 Syntax buffer-write-all
6368 \begin_layout Description
6369 Origin rgh, gpothier 6 Aug 2007
6372 \begin_layout Subsection*
6376 \begin_layout Description
6377 Action Switch to the next opened document.
6380 \begin_layout Description
6381 Notion Note that this does not necessarily mean next in tabbar (for full
6382 list see View menu).
6385 \begin_layout Description
6389 \begin_layout Subsection*
6390 LFUN_BUFFER_PREVIOUS
6393 \begin_layout Description
6394 Action Switch to the previous opened document.
6397 \begin_layout Description
6398 Syntax buffer-previous
6401 \begin_layout Subsection*
6402 LFUN_MASTER_BUFFER_UPDATE
6405 \begin_layout Description
6406 Action When run from a child document, this updates (exports) document built
6407 from the master buffer, if available.
6410 \begin_layout Description
6411 Syntax master-buffer-update [<FORMAT>]
6414 \begin_layout Description
6415 Params <FORMAT>: The format to display, where this is one of the formats
6416 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6417 If no format is given, the default format as specified in the same dialog
6421 \begin_layout Description
6422 Origin Tommaso, 20 Sep 2007
6425 \begin_layout Subsection*
6426 LFUN_MASTER_BUFFER_VIEW
6429 \begin_layout Description
6430 Action When run from a child document, this command shows a preview built
6431 from the master buffer, if available.
6434 \begin_layout Description
6435 Syntax master-buffer-view [<FORMAT>]
6438 \begin_layout Description
6439 Params <FORMAT>: The format to display, where this is one of the formats
6440 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6441 If no format is given, the default format as specified in the same dialog
6445 \begin_layout Description
6446 Origin Tommaso, 20 Sep 2007
6449 \begin_layout Subsection*
6450 LFUN_BUFFER_LANGUAGE
6453 \begin_layout Description
6454 Action Set language of the current document.
6457 \begin_layout Description
6458 Syntax buffer-language <LANG>
6461 \begin_layout Description
6462 Params <LANG>: language name.
6463 See lib/languages for list.
6466 \begin_layout Description
6467 Origin leeming, 30 Mar 2004
6470 \begin_layout Subsection*
6471 LFUN_BUFFER_SAVE_AS_DEFAULT
6474 \begin_layout Description
6475 Action Save the current document settings as default.
6478 \begin_layout Description
6479 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6482 \begin_layout Description
6483 Syntax buffer-save-as-default [<ARGS>]
6486 \begin_layout Description
6487 Params <ARGS>: contains the particular settings to be saved.
6488 They obey the syntax you can find in document header of usual .lyx file.
6491 \begin_layout Description
6492 Origin leeming, 30 Mar 2004
6495 \begin_layout Subsection*
6496 LFUN_BUFFER_PARAMS_APPLY
6499 \begin_layout Description
6500 Action Apply the given settings to the current document.
6503 \begin_layout Description
6504 Syntax buffer-params-apply [<ARGS>]
6507 \begin_layout Description
6508 Params <ARGS>: contains the particular settings to be saved.
6509 They obey the syntax you can find in document header of usual .lyx file.
6512 \begin_layout Description
6513 Origin leeming, 30 Mar 2004
6516 \begin_layout Subsection*
6520 \begin_layout Description
6521 Action Inserts another LyX file.
6524 \begin_layout Description
6525 Syntax file-insert [<FILE>]
6528 \begin_layout Description
6529 Params <FILE>: Filename to be inserted.
6532 \begin_layout Subsection*
6533 LFUN_FILE_INSERT_PLAINTEXT
6536 \begin_layout Description
6537 Action Inserts plain text file.
6540 \begin_layout Description
6541 Syntax file-insert-plaintext [<FILE>]
6544 \begin_layout Description
6545 Params <FILE>: Filename to be inserted.
6548 \begin_layout Description
6549 Origin CFO-G, 19 Nov 1997
6552 \begin_layout Subsection*
6553 LFUN_FILE_INSERT_PLAINTEXT_PARA
6556 \begin_layout Description
6557 Action Inserts plain text file as paragraph (i.e.
6561 \begin_layout Description
6562 Syntax file-insert-plaintext-para [<FILE>]
6565 \begin_layout Description
6566 Params <FILE>: Filename to be inserted.
6569 \begin_layout Description
6570 Origin Levon, 14 Feb 2001
6573 \begin_layout Subsection*
6577 \begin_layout Description
6578 Action Open LyX document.
6581 \begin_layout Description
6582 Syntax file-open [<FILE>]
6585 \begin_layout Description
6586 Params <FILE>: Filename to be opened.
6589 \begin_layout Subsection*
6593 \begin_layout Description
6594 Action Executes a command defined in a .def file.
6597 \begin_layout Description
6598 Notion The definitions are by default read from lib/commands/default.def.
6599 \begin_inset Newline newline
6602 A .def file allows to define a command with
6604 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6605 <LFUN> is the lfun code to be executed (see e.g.
6606 LFUN_COMMAND_SEQUENCE).
6609 def_file "FileName" allows to include another .def file.
6610 \begin_inset Newline newline
6613 This is particularly useful in connection with toolbar buttons: Since the
6614 name of the button image for this lfun is lib/images/commands/<NAME>.png
6615 this is the way to assign an image to a complex command-sequence.
6618 \begin_layout Description
6622 \begin_layout Description
6623 Params <NAME>: Name of the command that must be called.
6626 \begin_layout Description
6627 Origin broider, 2 Oct 2007
6630 \begin_layout Subsection*
6634 \begin_layout Description
6635 Action Simulate halting Meta key (Alt key on PCs).
6638 \begin_layout Description
6639 Notion Used for buffer editation not for GUI control.
6642 \begin_layout Description
6646 \begin_layout Subsection*
6650 \begin_layout Description
6651 Action Cancels sequence prepared by LFUN_META_PREFIX .
6654 \begin_layout Description
6658 \begin_layout Subsection*
6659 LFUN_COMMAND_EXECUTE
6662 \begin_layout Description
6663 Action Switches the focus to the minibuffer so that the user can type in
6665 If necessary, it opens the minibuffer toolbar.
6668 \begin_layout Description
6669 Notion Usually bound to M-x shortcut.
6672 \begin_layout Description
6673 Syntax command-execute
6676 \begin_layout Subsection*
6680 \begin_layout Description
6681 Action Return the current key sequence and available options as a string.
6684 \begin_layout Description
6685 Notion No options are added if no current map exists.
6686 \begin_inset Newline newline
6689 This is probably usable only with connection to lyxserver.
6692 \begin_layout Description
6693 Syntax command-prefix
6696 \begin_layout Subsection*
6697 LFUN_COMMAND_SEQUENCE
6700 \begin_layout Description
6701 Action Run more commands (LFUN and its parameters) in a sequence.
6704 \begin_layout Description
6705 Syntax command-sequence <CMDS>
6708 \begin_layout Description
6709 Params <CMDS>: Sequence of commands separated by semicolons.
6712 \begin_layout Description
6713 Sample command-sequence cut; ert-insert; self-insert
6715 ; paste; self-insert {}; inset-toggle;
6718 \begin_layout Description
6719 Origin Andre, 11 Nov 1999
6722 \begin_layout Subsection*
6723 LFUN_COMMAND_ALTERNATIVES
6726 \begin_layout Description
6727 Action Runs the first listed command that is enabled.
6730 \begin_layout Description
6731 Notion This can be used to bind multiple functions to a single key, and
6732 then which one is used will depend upon the context.
6735 \begin_layout Description
6736 Syntax command-alternatives <CMDS>
6739 \begin_layout Description
6740 Params <CMDS>: Sequence of commands separated by semicolons.
6743 \begin_layout Description
6744 Sample command-alternatives completion-accept;cell-forward
6747 \begin_layout Description
6748 Origin rgh, 24 September 2008
6751 \begin_layout Subsection*
6755 \begin_layout Description
6756 Action Shows message in statusbar (for script purposes).
6759 \begin_layout Description
6760 Syntax message <STRING>
6763 \begin_layout Description
6764 Origin Lgb, 8 Apr 2001
6767 \begin_layout Subsection*
6768 LFUN_DEBUG_LEVEL_SET
6771 \begin_layout Description
6772 Action Set debug output level.
6775 \begin_layout Description
6776 Syntax debug-level-set <LEVEL>
6779 \begin_layout Description
6780 Params <LEVEL>: comma separated list of levels or the correspondent number
6781 of their combination.
6782 0 is equivalent to disabling all debug events.
6783 See lyx -dbg for the current list of debug levels and their numbers.
6786 \begin_layout Description
6787 Origin sanda, 28 Dec 2009
6790 \begin_layout Subsection*
6791 LFUN_PREFERENCES_SAVE
6794 \begin_layout Description
6795 Action Save user preferences.
6798 \begin_layout Description
6799 Syntax preferences-save
6802 \begin_layout Description
6803 Origin Lgb, 27 Nov 1999
6806 \begin_layout Subsection*
6810 \begin_layout Description
6811 Action Reconfigure the automatic settings.
6814 \begin_layout Description
6818 \begin_layout Description
6819 Origin Asger, 14 Feb 1997
6822 \begin_layout Subsection*
6826 \begin_layout Description
6827 Action Apply the given settings to user preferences.
6830 \begin_layout Description
6831 Syntax lyxrc-apply <SETTINGS>
6834 \begin_layout Description
6835 Params <SETTINGS>: settings which are to be set.
6836 Take a look into ~/.lyx/preferences to get an idea which commands to use
6838 lyx::LyXRC::LyXRCTags has the list of possible commands.
6841 \begin_layout Subsection*
6842 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6845 \begin_layout Description
6846 Action Determine whether to keep cursor inside the editing window regardless
6847 of the scrollbar movement.
6850 \begin_layout Description
6851 Syntax toggle-cursor-follows-scrollbar
6854 \begin_layout Description
6855 Origin ARRae, 2 Dec 1997
6858 \begin_layout Subsection*
6862 \begin_layout Description
6863 Action Set the given LyX color to the color defined by the X11 name given.
6866 \begin_layout Description
6867 Notion A new color entry is created if the color is unknown.
6868 Color names can be stored as a part of user settings.
6871 \begin_layout Description
6872 Syntax set-color <LYX_NAME> <X11_NAME>
6875 \begin_layout Description
6876 Origin SLior, 11 Jun 2000
6879 \begin_layout Subsection*
6883 \begin_layout Description
6884 Action Count the statistics (number of words and characters) in the document
6885 or in the given selection.
6888 \begin_layout Description
6889 Notion Note that this function gives the number of words/chars written,
6890 not the number of characters which will be typeset.
6893 \begin_layout Description
6897 \begin_layout Description
6898 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6901 \begin_layout Subsection*
6902 LFUN_COMPLETION_INLINE
6905 \begin_layout Description
6906 Action Show the inline completion at the cursor position.
6909 \begin_layout Description
6910 Syntax completion-inline
6913 \begin_layout Description
6914 Origin sts, Feb 19 2008
6917 \begin_layout Subsection*
6918 LFUN_COMPLETION_POPUP
6921 \begin_layout Description
6922 Action Show the completion popup at the cursor position.
6925 \begin_layout Description
6926 Syntax completion-popup
6929 \begin_layout Description
6930 Origin sts, Feb 19 2008
6933 \begin_layout Subsection*
6934 LFUN_COMPLETION_COMPLETE
6937 \begin_layout Description
6938 Action Try to complete the word or command at the cursor position.
6941 \begin_layout Description
6945 \begin_layout Description
6946 Origin sts, Feb 19 2008
6949 \begin_layout Subsection*
6950 LFUN_COMPLETION_CANCEL
6953 \begin_layout Description
6954 Action Try to cancel completion, either the popup or the inline completion.
6957 \begin_layout Description
6958 Syntax completion-cancel
6961 \begin_layout Description
6962 Origin sts, Sep 07 2008
6965 \begin_layout Subsection*
6966 LFUN_COMPLETION_ACCEPT
6969 \begin_layout Description
6970 Action Accept suggested completion.
6973 \begin_layout Description
6974 Syntax completion-accept
6977 \begin_layout Description
6978 Origin sanda, Sep 08 2008
6981 \begin_layout Subsection*
6985 \begin_layout Description
6986 Action Add a branch to the buffer's BranchList.
6989 \begin_layout Description
6990 Syntax branch-add <BRANCH>
6993 \begin_layout Description
6994 Params <BRANCH>: Name of the branch to add
6997 \begin_layout Description
6998 Origin spitz, 7 Jul 2009
7001 \begin_layout Subsection*
7002 LFUN_BRANCH_ACTIVATE
7005 \begin_layout Description
7006 Action Activate the branch.
7009 \begin_layout Description
7010 Syntax branch-activate <BRANCH>
7013 \begin_layout Description
7014 Params <BRANCH>: The branch to activate
7017 \begin_layout Description
7018 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
7019 \begin_inset Newline newline
7022 could be used to export a pdf with the answers branch included without one's
7023 having to open LyX and activate the branch manually.
7026 \begin_layout Description
7027 Origin rgh, 27 May 2008
7030 \begin_layout Subsection*
7031 LFUN_BRANCH_DEACTIVATE
7034 \begin_layout Description
7035 Action De-activate the branch.
7038 \begin_layout Description
7039 Syntax branch-deactivate <BRANCH>
7042 \begin_layout Description
7043 Params <BRANCH>: The branch to deactivate
7046 \begin_layout Description
7047 Origin rgh, 27 May 2008
7050 \begin_layout Subsection*
7051 LFUN_BRANCHES_RENAME
7054 \begin_layout Description
7055 Action Rename all branches of a given name in a document.
7058 \begin_layout Description
7059 Syntax branches-rename <OLDNAME> <NEWNAME>
7062 \begin_layout Description
7063 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
7067 \begin_layout Description
7068 Origin spitz, 9 Jul 2009
7071 \begin_layout Subsection*
7072 LFUN_BRANCH_ADD_INSERT
7075 \begin_layout Description
7076 Action Create new branch and directly put the branch inset into the document.
7079 \begin_layout Description
7080 Syntax branch-add-insert [<NAME>]
7083 \begin_layout Description
7084 Params <NAME>: Branch name.
7085 If it is not specified, you will be asked.
7088 \begin_layout Description
7089 Origin sanda, 10 Jul 2009
7092 \begin_layout Subsection*
7093 LFUN_LABEL_COPY_AS_REF
7096 \begin_layout Description
7097 Action Copies the label at the cursor as a cross-reference to be pasted
7101 \begin_layout Description
7102 Syntax copy-label-as-reference <LABEL>
7105 \begin_layout Description
7106 Params <LABEL>: The label to copy (for multi-line math)
7109 \begin_layout Description
7110 Origin sts, 16 Nov 2008
7113 \begin_layout Subsection*
7114 LFUN_LABEL_INSERT_AS_REF
7117 \begin_layout Description
7118 Action Inserts the label as a cross-reference at the position of the cursor.
7121 \begin_layout Description
7122 Syntax label-insert-as-reference
7125 \begin_layout Description
7126 Origin vfr, 7 Apr 2009
7129 \begin_layout Subsection*
7133 \begin_layout Description
7134 Action Increases the zoom of the screen fonts.
7137 \begin_layout Description
7138 Syntax buffer-zoom-in [<ZOOM>]
7141 \begin_layout Description
7142 Params <ZOOM>: The zoom in %, the default is 20.
7145 \begin_layout Description
7146 Origin vfr, 30 Mar 2009
7149 \begin_layout Subsection*
7150 LFUN_BUFFER_ZOOM_OUT
7153 \begin_layout Description
7154 Action Decreases the zoom of the screen fonts.
7157 \begin_layout Description
7158 Syntax buffer-zoom-out [<ZOOM>]
7161 \begin_layout Description
7162 Params <ZOOM>: The zoom in %, the default is 20.
7165 \begin_layout Description
7166 Origin vfr, 30 Mar 2009
7169 \begin_layout Subsection*
7173 \begin_layout Description
7174 Action Copies the inset to the clipboard as a certain type.
7177 \begin_layout Description
7178 Notion Currently used only for InsetInfo where its content is copied as
7182 \begin_layout Description
7183 Syntax inset-copy-as
7186 \begin_layout Description
7187 Origin vfr, 18 Apr 2010