1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
6 \use_default_options false
14 \font_typewriter default
15 \font_default_family default
22 \paperfontsize default
31 \paperorientation portrait
38 \paragraph_separation indent
40 \quotes_language english
43 \paperpagestyle default
44 \tracking_changes false
52 \begin_layout Section*
53 LFUNs documentation automatically generated 25.09.2008.
56 \begin_layout Standard
60 \begin_layout Plain Layout
70 \begin_inset VSpace 1cm
76 \begin_layout Subsection*
80 \begin_layout Description
81 Action Adds an acute accent to the next character typed.
85 \begin_layout Description
89 \begin_layout Subsection*
93 \begin_layout Description
94 Action Adds a breve accent to the next character typed.
98 \begin_layout Description
102 \begin_layout Subsection*
106 \begin_layout Description
107 Action Adds a caron to the next character typed.
111 \begin_layout Description
115 \begin_layout Subsection*
119 \begin_layout Description
120 Action Adds a cedilla to the next character typed.
124 \begin_layout Description
125 Syntax accent-cedilla
128 \begin_layout Subsection*
132 \begin_layout Description
133 Action Adds a circle accent to the next character typed.
137 \begin_layout Description
141 \begin_layout Subsection*
142 LFUN_ACCENT_CIRCUMFLEX
145 \begin_layout Description
146 Action Adds a circumflex to the next character typed.
150 \begin_layout Description
151 Syntax accent-circumflex
154 \begin_layout Subsection*
158 \begin_layout Description
159 Action Adds a dot accent to the next character typed.
163 \begin_layout Description
167 \begin_layout Subsection*
171 \begin_layout Description
172 Action Adds a grave accent to the next character typed.
176 \begin_layout Description
180 \begin_layout Subsection*
181 LFUN_ACCENT_HUNGARIAN_UMLAUT
184 \begin_layout Description
185 Action Adds a Hungarian umlaut to the next character typed.
189 \begin_layout Description
193 \begin_layout Subsection*
197 \begin_layout Description
198 Action Adds a macron to the next character typed.
202 \begin_layout Description
206 \begin_layout Subsection*
210 \begin_layout Description
211 Action Adds an ogonek accent to the next character typed.
215 \begin_layout Description
219 \begin_layout Subsection*
223 \begin_layout Description
224 Action Adds a tie over the next two character typed.
228 \begin_layout Description
229 Notion The following char will finish the tie.
233 \begin_layout Description
237 \begin_layout Subsection*
241 \begin_layout Description
242 Action Adds a tilde over the next character typed.
246 \begin_layout Description
250 \begin_layout Subsection*
254 \begin_layout Description
255 Action Adds an umlaut over the next character typed.
259 \begin_layout Description
263 \begin_layout Subsection*
267 \begin_layout Description
268 Action Adds a bar under the next character typed.
272 \begin_layout Description
273 Syntax accent-underbar
276 \begin_layout Subsection*
280 \begin_layout Description
281 Action Adds a dot under the next character typed.
285 \begin_layout Description
286 Syntax accent-underdot
289 \begin_layout Subsection*
293 \begin_layout Description
294 Action Inserts a caption inset.
298 \begin_layout Description
299 Syntax caption-insert
302 \begin_layout Description
303 Origin Lgb, 18 Jul 2000
306 \begin_layout Subsection*
310 \begin_layout Description
311 Action Inserts the current date.
315 \begin_layout Description
316 Syntax date-insert [<ARG>]
319 \begin_layout Description
320 Params <ARG>: Format of date.
321 The default value (%x) can be set in Preferences->Date format.
322 For possible formats see manual page of strftime function.
326 \begin_layout Description
327 Origin jdblair, 31 Jan 2000
330 \begin_layout Subsection*
334 \begin_layout Description
335 Action Inserts a footnote inset.
339 \begin_layout Description
340 Syntax footnote-insert
343 \begin_layout Description
344 Origin Jug, 7 Mar 2000
347 \begin_layout Subsection*
351 \begin_layout Description
352 Action Inserts an ERT inset.
356 \begin_layout Description
360 \begin_layout Description
361 Origin Jug, 18 Feb 2000
364 \begin_layout Subsection*
368 \begin_layout Description
369 Action Inserts a float inset.
373 \begin_layout Description
374 Syntax float-insert <TYPE>
377 \begin_layout Description
378 Params <TYPE>: type of float depends on the used textclass.
379 Usually "algorithm", "table", "figure" parameters can be given.
383 \begin_layout Description
384 Origin Lgb, 27 Jun 2000
387 \begin_layout Subsection*
388 LFUN_FLOAT_WIDE_INSERT
391 \begin_layout Description
392 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
396 \begin_layout Description
397 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
401 \begin_layout Description
402 Syntax float-wide-insert <TYPE>
405 \begin_layout Description
406 Params <TYPE>: type of float depends on the used textclass.
407 Usually "algorithm", "table", "figure" parameters can be given.
411 \begin_layout Description
412 Origin Lgb, 31 Oct 2001
415 \begin_layout Subsection*
416 LFUN_FLOAT_LIST_INSERT
419 \begin_layout Description
420 Action Inserts the list of floats in the document.
424 \begin_layout Description
425 Syntax float-list-insert <TYPE>
428 \begin_layout Description
429 Params <TYPE>: type of float depends on the used textclass.
430 Usually "algorithm", "table", "figure" parameters can be given.
434 \begin_layout Description
435 Origin Lgb, 3 May 2001
438 \begin_layout Subsection*
442 \begin_layout Description
443 Action Inserts floats wrapped by the text around.
447 \begin_layout Description
448 Syntax wrap-insert <TYPE>
451 \begin_layout Description
452 Params <TYPE>: table|figure
455 \begin_layout Description
456 Origin Dekel, 7 Apr 2002
459 \begin_layout Subsection*
463 \begin_layout Description
464 Action Inserts an optional-argument (short title) inset.
468 \begin_layout Description
469 Syntax optional-insert
472 \begin_layout Description
473 Origin vermeer, 12 Aug 2002
476 \begin_layout Subsection*
480 \begin_layout Description
481 Action Inserts a horizontal line.
485 \begin_layout Description
489 \begin_layout Description
490 Origin Andre, Oct 27 2003
493 \begin_layout Subsection*
497 \begin_layout Description
498 Action Inserts a new page.
502 \begin_layout Description
503 Syntax newpage-insert <ARG>
506 \begin_layout Description
507 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
511 \begin_layout Description
512 Origin uwestoehr, 24 Nov 2007
515 \begin_layout Subsection*
516 LFUN_MARGINALNOTE_INSERT
519 \begin_layout Description
520 Action Inserts a marginal note.
524 \begin_layout Description
525 Syntax marginalnote-insert
528 \begin_layout Description
529 Origin Lgb, 26 Jun 2000
532 \begin_layout Subsection*
536 \begin_layout Description
537 Action Inserts a single unicode character.
541 \begin_layout Description
542 Syntax unicode-insert <CHAR>
545 \begin_layout Description
546 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
550 \begin_layout Description
551 Sample unicode-insert 0x0100
554 \begin_layout Description
555 Origin Lgb, 22 Oct 2006
558 \begin_layout Subsection*
562 \begin_layout Description
563 Action Inserts a new listings inset.
567 \begin_layout Description
568 Syntax listing-insert
571 \begin_layout Description
572 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
575 \begin_layout Subsection*
579 \begin_layout Description
580 Action Inserts quotes according to the type and quote-language preference.
584 \begin_layout Description
585 Action Currently English, Swedish, German, Polish, French, Danish quotes
590 \begin_layout Description
591 Syntax quote-insert [<TYPE>]
594 \begin_layout Description
595 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
600 \begin_layout Subsection*
604 \begin_layout Description
605 Action Displays shortcuts, lyxrc, package and textclass availability and
606 menu information in a non-editable boxed InsetText.
610 \begin_layout Description
611 Notion Apart from lfun arguments you can use the following method:
612 \begin_inset Newline newline
616 input the type and argument of this inset, e.g.
617 "menu paste", in the work area.
619 \begin_inset Newline newline
623 select the text and run info-insert lfun.
627 \begin_layout Description
628 Syntax info-insert <TYPE> <ARG>
631 \begin_layout Description
632 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
633 \begin_inset Newline newline
636 <ARG>: argument for a given type.
637 Look into InsetInfo.h for detailed description.
641 \begin_layout Description
642 Origin bpeng, 7 Oct 2007
645 \begin_layout Subsection*
649 \begin_layout Description
650 Action Inserts branch inset.
654 \begin_layout Description
655 Syntax branch-insert <BRANCH-NAME>
658 \begin_layout Description
659 Origin vermeer, 17 Aug 2003
662 \begin_layout Subsection*
666 \begin_layout Description
667 Action Inserts Box inset.
671 \begin_layout Description
672 Syntax box-insert [<TYPE>]
675 \begin_layout Description
676 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
678 \begin_inset Newline newline
681 Framed is the default one.
685 \begin_layout Description
686 Origin vermeer, 7 Oct 2003
689 \begin_layout Subsection*
693 \begin_layout Description
694 Action Inserts CharStyle, Custom inset or XML short element.
698 \begin_layout Description
699 Notion Look into the Customization manual for more information about these
702 \begin_inset Newline newline
705 To make this command enabled the layout file for the document class you're
706 using has to load the character styles.
707 There are a few contained in the Logical Markup module.
708 You can also of course create some yourself.
710 \begin_inset Newline newline
713 For dissolving the element see LFUN_INSET_DISSOLVE.
717 \begin_layout Description
718 Syntax flex-insert <TYPE:Name>
721 \begin_layout Description
722 Params TYPE: CharStyle|Custom|Element|Standard
723 \begin_inset Newline newline
726 Identifies whether this is a Character Style, a Custom Inset or an XML
727 Element, and which dynamical sub-menu this flex inset is in on the LyX
729 If Standard (currently unused): none of these.
730 Name: This name must be defined either in your layout file or imported
733 \begin_inset Newline newline
736 InsetLayout <TYPE:Name>
739 \begin_layout Description
740 Sample flex-insert CharStyle:Code
743 \begin_layout Subsection*
747 \begin_layout Description
748 Action Inserts the given string (accordingly to the correct keymap).
752 \begin_layout Description
753 Notion Automatically replace the currently selected text.
754 Depends on lyxrc settings "auto_region_delete".
758 \begin_layout Description
759 Syntax self-insert <STRING>
762 \begin_layout Subsection*
766 \begin_layout Description
767 Action Inserts one of horizontal space insets.
771 \begin_layout Description
772 Syntax space-insert <NAME> [<LEN>]
775 \begin_layout Description
776 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
777 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
778 \begin_inset Newline newline
781 <LEN>: length for custom spaces (hspace, hspace* for protected)
784 \begin_layout Description
785 Origin JSpitzm, 20 May 2003, Mar 17 2008
788 \begin_layout Subsection*
789 LFUN_HYPERLINK_INSERT
792 \begin_layout Description
793 Action Inserts hyperlinks into the document (clickable in pdf output).
797 \begin_layout Description
798 Notion Hyperlink target can be set via selection + hyperlink-insert function.
802 \begin_layout Description
803 Syntax href-insert [<TARGET>]
806 \begin_layout Description
807 Origin CFO-G, 21 Nov 1997
810 \begin_layout Subsection*
811 LFUN_SPECIALCHAR_INSERT
814 \begin_layout Description
815 Action Inserts various characters into the document.
819 \begin_layout Description
820 Syntax specialchar-insert <CHAR>
823 \begin_layout Description
824 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
825 tence, menu-separator.
829 \begin_layout Description
830 Origin JSpitzm, 6 Dec 2007
833 \begin_layout Subsection*
837 \begin_layout Description
838 Action Inserts table of contents.
842 \begin_layout Description
846 \begin_layout Description
847 Origin Lgb, 27 May 97
850 \begin_layout Subsection*
854 \begin_layout Description
855 Action Start (or remove) Appendix on the given cursor position.
859 \begin_layout Description
863 \begin_layout Description
864 Origin ettrich, 5 May 1998
867 \begin_layout Subsection*
871 \begin_layout Description
872 Action Inserts Index entry.
876 \begin_layout Description
877 Notion It automatically takes the word on the cursor position.
881 \begin_layout Description
885 \begin_layout Description
886 Origin leeming, 3 Aug 2000
889 \begin_layout Subsection*
893 \begin_layout Description
894 Action Inserts list of Index entries on a new page.
898 \begin_layout Description
902 \begin_layout Description
903 Origin Lgb, 27 Feb 1997
906 \begin_layout Subsection*
910 \begin_layout Description
911 Action Inserts Nomenclature entry.
915 \begin_layout Description
916 Notion It automatically takes the word on the cursor position if no symbol
921 \begin_layout Description
922 Syntax nomencl-insert [<SYMBOL>]
925 \begin_layout Description
926 Origin Ugras, 4 Nov 2006
929 \begin_layout Subsection*
930 LFUN_NOMENCLATURE_PRINT
933 \begin_layout Description
934 Action Inserts list of Nomenclature entries.
938 \begin_layout Description
939 Syntax nomenclature-print
942 \begin_layout Description
943 Origin Ugras, 4 Nov 2006
946 \begin_layout Subsection*
950 \begin_layout Description
951 Action Inserts Note on the current cursor postion, move selection inside
956 \begin_layout Description
957 Syntax note-insert [<TYPE>]
960 \begin_layout Description
961 Params <TYPE>: <Note|Greyedout|Comment> default: Note
964 \begin_layout Subsection*
968 \begin_layout Description
969 Action Moves the cursor to the begining of next Note inset.
973 \begin_layout Description
977 \begin_layout Subsection*
981 \begin_layout Description
982 Action Changes all Note insets of a particular type (source) to a different
983 type (target) fot the current document.
987 \begin_layout Description
988 Syntax notes-mutate <SOURCE> <TARGET>
991 \begin_layout Description
992 Params <SOURCE/TARGET>: Note|Comment|Greyedout
995 \begin_layout Description
996 Origin sanda, 18 Jun 2008
999 \begin_layout Subsection*
1003 \begin_layout Description
1004 Action Inserts a line break or new line.
1008 \begin_layout Description
1009 Syntax newline-insert [<ARG>]
1012 \begin_layout Description
1013 Params <ARG>: <newline|linebreak> default: newline
1016 \begin_layout Description
1017 Origin JSpitzm, 25 Mar 2008
1020 \begin_layout Subsection*
1024 \begin_layout Description
1025 Action Clears the selection.
1026 If no text is selected call LFUN_FINISHED_FORWARD.
1030 \begin_layout Description
1034 \begin_layout Description
1035 Origin Lgb, 17 May 2001
1038 \begin_layout Subsection*
1042 \begin_layout Description
1043 Action Moves the cursor one line in downward direction.
1047 \begin_layout Description
1051 \begin_layout Subsection*
1055 \begin_layout Description
1056 Action Moves the cursor one line in upward direction.
1060 \begin_layout Description
1064 \begin_layout Subsection*
1068 \begin_layout Description
1069 Action Moves the cursor one line in downward direction adding the current
1070 position to the selection.
1074 \begin_layout Description
1078 \begin_layout Subsection*
1082 \begin_layout Description
1083 Action Moves the cursor one line in upward direction adding the current
1084 position to the selection.
1088 \begin_layout Description
1092 \begin_layout Subsection*
1096 \begin_layout Description
1097 Action Moves the cursor one page in downward direction.
1101 \begin_layout Description
1105 \begin_layout Subsection*
1109 \begin_layout Description
1110 Action Moves the cursor one page in upward direction.
1114 \begin_layout Description
1118 \begin_layout Subsection*
1119 LFUN_SCREEN_DOWN_SELECT
1122 \begin_layout Description
1123 Action Moves the cursor one screen in downward direction adding the current
1124 position to the selection.
1128 \begin_layout Description
1129 Syntax screen-down-select
1132 \begin_layout Subsection*
1133 LFUN_SCREEN_UP_SELECT
1136 \begin_layout Description
1137 Action Moves the cursor one page in upward direction adding the current
1138 position to the selection.
1142 \begin_layout Description
1143 Syntax screen-up-select
1146 \begin_layout Subsection*
1150 \begin_layout Description
1151 Action Scroll the buffer view.
1155 \begin_layout Description
1156 Notion Only scrolls the screen up or down; does not move the cursor.
1160 \begin_layout Description
1161 Syntax scroll <TYPE> <QUANTITY>
1164 \begin_layout Description
1165 Params <TYPE>: line|page
1166 \begin_inset Newline newline
1169 <QUANTITY>: up|down|<number>
1172 \begin_layout Description
1173 Origin Abdel, Dec 27 2007
1176 \begin_layout Subsection*
1177 LFUN_SCREEN_RECENTER
1180 \begin_layout Description
1181 Action Recenters the screen on the current cursor position.
1185 \begin_layout Description
1186 Syntax screen-recenter
1189 \begin_layout Subsection*
1193 \begin_layout Description
1194 Action Moves the cursor one position logically backwards.
1198 \begin_layout Description
1199 Notion This is not the action which should be bound to the arrow keys, because
1200 backwards may be left or right, depending on the language.
1201 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1202 which in turn may employ this one.
1206 \begin_layout Description
1207 Syntax char-backward
1210 \begin_layout Subsection*
1211 LFUN_CHAR_BACKWARD_SELECT
1214 \begin_layout Description
1215 Action Moves the cursor one position logically backwards, adding traversed
1216 position to the selection.
1220 \begin_layout Description
1221 Notion See also LFUN_CHAR_BACKWARD.
1225 \begin_layout Description
1226 Syntax char-backward-select
1229 \begin_layout Subsection*
1230 LFUN_CHAR_DELETE_BACKWARD
1233 \begin_layout Description
1234 Action Deletes one character in the backward direction (usually the "BackSpace"
1239 \begin_layout Description
1240 Syntax char-delete-backward
1243 \begin_layout Subsection*
1244 LFUN_CHAR_DELETE_FORWARD
1247 \begin_layout Description
1248 Action Deletes one character in the backward direction (usually the "Delete"
1253 \begin_layout Description
1254 Syntax char-delete-forward
1257 \begin_layout Subsection*
1261 \begin_layout Description
1262 Action Moves the cursor one position logically forward.
1266 \begin_layout Description
1267 Notion This is not the action which should be bound to the arrow keys, because
1268 forward may be left or right, depending on the language.
1269 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1270 which in turn may employ this one.
1274 \begin_layout Description
1278 \begin_layout Subsection*
1279 LFUN_CHAR_FORWARD_SELECT
1282 \begin_layout Description
1283 Action Moves the cursor one position logically forward, adding traversed
1284 position to the selection.
1288 \begin_layout Description
1289 Notion See also LFUN_CHAR_FORWARD.
1293 \begin_layout Description
1294 Syntax char-forward-select
1297 \begin_layout Subsection*
1301 \begin_layout Description
1302 Action Moves the cursor one position "to the left".
1306 \begin_layout Description
1307 Notion This is the action which should be taken when the "left" key is pressed.
1308 Generally, it moves the cursor one position to the left.
1309 However, in Bidi text this become slightly more complicated, and there
1310 are different modes of cursor movement.
1311 In "visual mode", this moves left, plain and simple.
1312 In "logical mode", movement is logically forward in RTL paragraphs, and
1313 logically backwards in LTR paragraphs.
1317 \begin_layout Description
1321 \begin_layout Subsection*
1322 LFUN_CHAR_LEFT_SELECT
1325 \begin_layout Description
1326 Action Moves the cursor one position "to the left", adding traversed position
1331 \begin_layout Description
1332 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1336 \begin_layout Description
1337 Syntax char-left-select
1340 \begin_layout Subsection*
1344 \begin_layout Description
1345 Action Moves the cursor one position "to the right".
1349 \begin_layout Description
1350 Notion This is the action which should be taken when the "right" key is
1352 Generally, it moves the cursor one position to the right.
1353 However, in Bidi text this become slightly more complicated, and there
1354 are different modes of cursor movement.
1355 In "visual mode", this moves right, plain and simple.
1356 In "logical mode", movement is logically forward in LTR paragraphs, and
1357 logically backwards in RTL paragraphs.
1361 \begin_layout Description
1365 \begin_layout Subsection*
1366 LFUN_CHAR_RIGHT_SELECT
1369 \begin_layout Description
1370 Action Moves the cursor one position "to the right", adding traversed position
1375 \begin_layout Description
1376 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1380 \begin_layout Description
1381 Syntax char-right-select
1384 \begin_layout Subsection*
1388 \begin_layout Description
1389 Action Moves the cursor to the logically previous beginning of a word.
1393 \begin_layout Description
1394 Notion This is not the action which should be bound to the arrow keys, because
1395 backwards may be left or right, depending on the language.
1396 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1397 which in turn may employ this one.
1401 \begin_layout Description
1402 Syntax word-backward
1405 \begin_layout Subsection*
1406 LFUN_WORD_BACKWARD_SELECT
1409 \begin_layout Description
1410 Action Moves the cursor to the logically previous beginning of a word, adding
1411 the logically traversed text to the selection.
1415 \begin_layout Description
1416 Notion See also LFUN_WORD_BACKWARD.
1420 \begin_layout Description
1421 Syntax word-backward-select
1424 \begin_layout Subsection*
1425 LFUN_WORD_DELETE_BACKWARD
1428 \begin_layout Description
1429 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1434 \begin_layout Description
1435 Syntax word-delete-backward
1438 \begin_layout Subsection*
1439 LFUN_WORD_DELETE_FORWARD
1442 \begin_layout Description
1443 Action Deletes characters to the end of the word (usually the "C+Delete"
1448 \begin_layout Description
1449 Syntax word-delete-forward
1452 \begin_layout Subsection*
1453 LFUN_WORD_FIND_FORWARD
1456 \begin_layout Description
1457 Action Search for a given string in forward direction.
1461 \begin_layout Description
1462 Notion Case sensitive, match words.
1463 If no argument given, last search repeated.
1467 \begin_layout Description
1468 Syntax word-find-forward [<STRING>]
1471 \begin_layout Description
1472 Origin Etienne, 16 Feb 1998
1475 \begin_layout Subsection*
1476 LFUN_WORD_FIND_BACKWARD
1479 \begin_layout Description
1480 Action Search for a given string in backward direction.
1484 \begin_layout Description
1485 Notion Case sensitive, match words.
1486 If no argument given, last search repeated.
1490 \begin_layout Description
1491 Syntax word-find-backward [<STRING>]
1494 \begin_layout Description
1495 Origin Etienne, 20 Feb 1998
1498 \begin_layout Subsection*
1502 \begin_layout Description
1503 Action Search for next occurence of a string.
1507 \begin_layout Description
1508 Syntax word-find [<DATA>]
1511 \begin_layout Description
1512 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1513 If no parameter is given, search with last find-dialog data is used for
1519 \begin_layout Description
1520 Origin Andre, Jan 7 2004
1523 \begin_layout Subsection*
1527 \begin_layout Description
1528 Action Replace a string in the document.
1532 \begin_layout Description
1533 Syntax word-replace [<DATA>]
1536 \begin_layout Description
1537 Params <DATA>: data is of the form "<search>
1538 \begin_inset Newline newline
1542 \begin_inset Newline newline
1545 <casesensitive> <matchword> <all> <forward>"
1548 \begin_layout Description
1549 Origin Andre, Jan 7 2004
1552 \begin_layout Subsection*
1556 \begin_layout Description
1557 Action Moves the cursor to the logically next beginning of a word.
1561 \begin_layout Description
1562 Notion This is not the action which should be bound to the arrow keys, because
1563 forward may be left or right, depending on the language.
1564 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1565 which in turn may employ this one.
1569 \begin_layout Description
1573 \begin_layout Subsection*
1574 LFUN_WORD_FORWARD_SELECT
1577 \begin_layout Description
1578 Action Moves the cursor to the logically next beginning of a word, adding
1579 the logically traversed text to the selection.
1583 \begin_layout Description
1584 Notion See also LFUN_WORD_FORWARD.
1588 \begin_layout Description
1589 Syntax word-forward-select
1592 \begin_layout Subsection*
1596 \begin_layout Description
1597 Action Moves the cursor to the next beginning of a word "on the left".
1601 \begin_layout Description
1602 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1604 Generally, it moves the cursor to the next beginning of a word on the left.
1605 However, in Bidi text this become slightly more complicated, and there
1606 are different modes of cursor movement.
1607 In "visual mode", this moves left, plain and simple.
1608 In "logical mode", movement is logically forward in RTL paragraphs, and
1609 logically backwards in LTR paragraphs.
1613 \begin_layout Description
1617 \begin_layout Description
1618 Origin dov, 28 Oct 2007
1621 \begin_layout Subsection*
1622 LFUN_WORD_LEFT_SELECT
1625 \begin_layout Description
1626 Action Moves the cursor to the next beginning of a word "on the left", adding
1627 *logically* traversed text to the selection.
1631 \begin_layout Description
1632 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1636 \begin_layout Description
1637 Syntax word-left-select
1640 \begin_layout Description
1641 Origin dov, 28 Oct 2007
1644 \begin_layout Subsection*
1648 \begin_layout Description
1649 Action Moves the cursor to the next beginning of a word "on the right".
1653 \begin_layout Description
1654 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1656 Generally, it moves the cursor to the next beginning of a word on the right.
1657 However, in Bidi text this become slightly more complicated, and there
1658 are different modes of cursor movement.
1659 In "visual mode", this moves right, plain and simple.
1660 In "logical mode", movement is logically forward in LTR paragraphs, and
1661 logically backwards in RTL paragraphs.
1665 \begin_layout Description
1669 \begin_layout Description
1670 Origin dov, 28 Oct 2007
1673 \begin_layout Subsection*
1674 LFUN_WORD_RIGHT_SELECT
1677 \begin_layout Description
1678 Action Moves the cursor to the next beginning of a word "on the right",
1679 adding *logically* traversed text to the selection.
1683 \begin_layout Description
1684 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1688 \begin_layout Description
1689 Syntax word-right-select
1692 \begin_layout Description
1693 Origin dov, 28 Oct 2007
1696 \begin_layout Subsection*
1700 \begin_layout Description
1701 Action Puts the word where the cursor stands into the selection.
1705 \begin_layout Description
1709 \begin_layout Description
1710 Origin Andre, 11 Sep 2002
1713 \begin_layout Subsection*
1714 LFUN_WORD_CAPITALIZE
1717 \begin_layout Description
1718 Action Capitalizes the words in the selection (i.e.
1719 the first letters) or the letter on the cursor position.
1723 \begin_layout Description
1724 Syntax word-capitalize
1727 \begin_layout Subsection*
1731 \begin_layout Description
1732 Action Change the words in the selection or from the cursor position to
1733 the end of word to the upper case.
1737 \begin_layout Description
1741 \begin_layout Subsection*
1745 \begin_layout Description
1746 Action Change the words in the selection or from the cursor position to
1747 the end of word to the lower case.
1751 \begin_layout Description
1755 \begin_layout Subsection*
1756 LFUN_THESAURUS_ENTRY
1759 \begin_layout Description
1760 Action Look up thesaurus entries with respect to the word under the cursor.
1764 \begin_layout Description
1765 Syntax thesaurus-entry
1768 \begin_layout Description
1769 Origin Levon, 20 Jul 2001
1772 \begin_layout Subsection*
1776 \begin_layout Description
1777 Action Move the cursor to the beginning of the document.
1781 \begin_layout Description
1785 \begin_layout Subsection*
1786 LFUN_BUFFER_BEGIN_SELECT
1789 \begin_layout Description
1790 Action Move the cursor to the beginning of the document adding the traversed
1791 text to the selection.
1795 \begin_layout Description
1796 Syntax buffer-begin-select
1799 \begin_layout Subsection*
1803 \begin_layout Description
1804 Action Move the cursor to the end of the document.
1808 \begin_layout Description
1812 \begin_layout Subsection*
1813 LFUN_BUFFER_END_SELECT
1816 \begin_layout Description
1817 Action Move the cursor to the end of the document adding the traversed text
1822 \begin_layout Description
1823 Syntax buffer-end-select
1826 \begin_layout Subsection*
1830 \begin_layout Description
1831 Action Move the cursor to the begining of the (screen) line.
1835 \begin_layout Description
1839 \begin_layout Subsection*
1840 LFUN_LINE_BEGIN_SELECT
1843 \begin_layout Description
1844 Action Move the cursor to the beginning of the (screen) line adding the
1845 traversed text to the selection.
1849 \begin_layout Description
1850 Syntax line-begin-select
1853 \begin_layout Subsection*
1857 \begin_layout Description
1858 Action Move the cursor to the end of the (screen) line.
1862 \begin_layout Description
1866 \begin_layout Subsection*
1867 LFUN_LINE_END_SELECT
1870 \begin_layout Description
1871 Action Move the cursor to the end of the (screen) line adding the traversed
1872 text to the selection.
1876 \begin_layout Description
1877 Syntax line-end-select
1880 \begin_layout Subsection*
1884 \begin_layout Description
1885 Action Deletes the letters to the end of the (screen) line or deletes the
1890 \begin_layout Description
1891 Syntax line-delete-forward
1894 \begin_layout Subsection*
1898 \begin_layout Description
1899 Action Copies to the clipboard the last edit.
1903 \begin_layout Description
1907 \begin_layout Subsection*
1911 \begin_layout Description
1912 Action Cuts to the clipboard.
1916 \begin_layout Description
1920 \begin_layout Subsection*
1924 \begin_layout Description
1925 Action Pastes material from the active clipboard.
1929 \begin_layout Description
1930 Syntax paste [<TYPE>]
1933 \begin_layout Description
1934 Params <TYPE>: pdf|png|jpeg|linkback
1937 \begin_layout Subsection*
1938 LFUN_CLIPBOARD_PASTE
1941 \begin_layout Description
1942 Action Pastes text from the active clipboard.
1946 \begin_layout Description
1947 Syntax clipboard-paste [<ARG>]
1950 \begin_layout Description
1951 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1956 \begin_layout Description
1957 Origin baum, 10 Jul 2006
1960 \begin_layout Subsection*
1961 LFUN_PRIMARY_SELECTION_PASTE
1964 \begin_layout Description
1965 Action Pastes the currently text selected text.
1969 \begin_layout Description
1970 Notion Primary selection mechanism is linux-only thing.
1974 \begin_layout Description
1975 Syntax primary-selection-paste [<ARG>]
1978 \begin_layout Description
1979 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1984 \begin_layout Subsection*
1988 \begin_layout Description
1989 Action Undoes the last edit.
1993 \begin_layout Description
1997 \begin_layout Subsection*
2001 \begin_layout Description
2002 Action Redoes the last thing undone.
2006 \begin_layout Description
2010 \begin_layout Subsection*
2014 \begin_layout Description
2015 Action Repeat the given command.
2019 \begin_layout Description
2020 Syntax repeat <COUNT> <LFUN-COMMAND>
2023 \begin_layout Description
2024 Origin Andre, , 27 Oct 2003
2027 \begin_layout Subsection*
2028 LFUN_CHARS_TRANSPOSE
2031 \begin_layout Description
2032 Action Transposes the character at the cursor with the one before it.
2036 \begin_layout Description
2037 Syntax chars-transpose
2040 \begin_layout Description
2041 Origin Lgb, 25 Apr 2001
2044 \begin_layout Subsection*
2045 LFUN_DEPTH_DECREMENT
2048 \begin_layout Description
2049 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2054 \begin_layout Description
2055 Syntax depth-decrement
2058 \begin_layout Subsection*
2059 LFUN_DEPTH_INCREMENT
2062 \begin_layout Description
2063 Action Increase the nesting depth of the (selected) paragraph(s) inside
2068 \begin_layout Description
2069 Syntax depth-increment
2072 \begin_layout Subsection*
2076 \begin_layout Description
2077 Action Toggles the bold font (selection-wise) using mathbf in math.
2081 \begin_layout Description
2085 \begin_layout Subsection*
2086 LFUN_FONT_BOLDSYMBOL
2089 \begin_layout Description
2090 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2094 \begin_layout Description
2095 Syntax font-boldsymbol
2098 \begin_layout Subsection*
2099 LFUN_FONT_TYPEWRITER
2102 \begin_layout Description
2103 Action Toggles the typewriter family font (selection-wise).
2107 \begin_layout Description
2108 Syntax font-typewriter
2111 \begin_layout Subsection*
2115 \begin_layout Description
2116 Action Toggles underline in the font (selection-wise).
2120 \begin_layout Description
2121 Syntax font-underline
2124 \begin_layout Subsection*
2128 \begin_layout Description
2129 Action Toggles the emphasis font style (selection-wise).
2133 \begin_layout Description
2137 \begin_layout Subsection*
2141 \begin_layout Description
2142 Action Toggles Noun text style font (selection-wise).
2146 \begin_layout Description
2150 \begin_layout Subsection*
2154 \begin_layout Description
2155 Action Toggles Roman family font (selection-wise).
2159 \begin_layout Description
2163 \begin_layout Subsection*
2167 \begin_layout Description
2168 Action Toggles Sans Serif family font (selection-wise).
2172 \begin_layout Description
2176 \begin_layout Subsection*
2180 \begin_layout Description
2181 Action Toggles Fraktur family font (math-mode, selection-wise).
2185 \begin_layout Description
2189 \begin_layout Description
2190 Origin vermeer, 10 Jan 2002
2193 \begin_layout Subsection*
2197 \begin_layout Description
2198 Action Toggles Italics font shape (math-mode, selection-wise).
2202 \begin_layout Description
2206 \begin_layout Description
2207 Origin vermeer, 10 Jan 2002
2210 \begin_layout Subsection*
2214 \begin_layout Description
2215 Action Reverts the settings of the font to the default values (selection-wise).
2219 \begin_layout Description
2223 \begin_layout Subsection*
2227 \begin_layout Description
2228 Action Sets font size according to lyx format string.
2232 \begin_layout Description
2233 Syntax font-size <SIZE>
2236 \begin_layout Description
2237 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2238 \begin_inset Newline newline
2241 largest|huge|giant|increase|decrease|default
2244 \begin_layout Subsection*
2245 LFUN_TEXTSTYLE_APPLY
2248 \begin_layout Description
2249 Action Toggle user-defined (=last-time used) text style.
2253 \begin_layout Description
2254 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2255 trigerred when using Text Style dialog.
2259 \begin_layout Description
2260 Syntax textstyle-apply
2263 \begin_layout Description
2264 Origin leeming, 12 Mar 2003
2267 \begin_layout Subsection*
2268 LFUN_TEXTSTYLE_UPDATE
2271 \begin_layout Description
2272 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2277 \begin_layout Description
2278 Syntax textstyle-update <FONT_INFO>
2281 \begin_layout Description
2282 Params <FONT_INFO>: specifies font atributes, e.g.
2283 family, series, shape, size, emph, noun, underbar, number, color, language,
2286 \begin_inset Newline newline
2289 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2293 \begin_layout Description
2294 Origin leeming, 12 Mar 2003
2297 \begin_layout Subsection*
2298 LFUN_SCREEN_FONT_UPDATE
2301 \begin_layout Description
2302 Action Update fonts and its metrics.
2306 \begin_layout Description
2307 Notion Automatically called after zoom, dpi, font names, or norm change.
2311 \begin_layout Description
2312 Syntax screen-font-update
2315 \begin_layout Description
2316 Origin ARRae, 13 Aug 2000
2319 \begin_layout Subsection*
2323 \begin_layout Description
2324 Action Returns the info about the current font.
2328 \begin_layout Description
2332 \begin_layout Subsection*
2333 LFUN_CITATION_INSERT
2336 \begin_layout Description
2337 Action Inserts citation from loaded citation database.
2341 \begin_layout Description
2342 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2345 \begin_layout Description
2346 Params <KEY>: Citation (shortcut listed in available citations).
2348 \begin_inset Newline newline
2351 <TEXT_BEFORE>: text which should appear before citation.
2355 \begin_layout Description
2356 Origin AAS, 97-02-23
2359 \begin_layout Subsection*
2360 LFUN_BIBTEX_DATABASE_ADD
2363 \begin_layout Description
2364 Action Adds database, which will be used for bibtex citations.
2368 \begin_layout Description
2369 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2370 bibliography) found from the cursor postion.
2374 \begin_layout Description
2375 Syntax bibtex-database-add <DATABASE-NAME>
2378 \begin_layout Description
2379 Origin Ale, 30 May 1997
2382 \begin_layout Subsection*
2383 LFUN_BIBTEX_DATABASE_DEL
2386 \begin_layout Description
2387 Action Adds database, which will be used for bibtex citations.
2391 \begin_layout Description
2392 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2393 X bibliography) found from the cursor postion.
2397 \begin_layout Description
2398 Syntax bibtex-database-del <DATABASE-NAME>
2401 \begin_layout Description
2402 Origin Ale, 30 May 1997
2405 \begin_layout Subsection*
2409 \begin_layout Description
2410 Action Sets the layout (that is, environment) for the current paragraph.
2414 \begin_layout Description
2415 Syntax layout <LAYOUT>
2418 \begin_layout Description
2419 Params <LAYOUT>: the layout to use
2422 \begin_layout Subsection*
2423 LFUN_LAYOUT_PARAGRAPH
2426 \begin_layout Description
2427 Action Launches the paragraph settings dialog.
2431 \begin_layout Description
2432 Syntax layout-paragraph
2435 \begin_layout Subsection*
2439 \begin_layout Description
2440 Action Launches the tabular settings dialog.
2444 \begin_layout Description
2445 Syntax layout-tabular
2448 \begin_layout Description
2449 Origin Jug, 31 Jul 2000
2452 \begin_layout Subsection*
2453 LFUN_DROP_LAYOUTS_CHOICE
2456 \begin_layout Description
2457 Action Displays list of layout choices.
2461 \begin_layout Description
2462 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2463 allowing for choice of layout.
2467 \begin_layout Description
2468 Syntax drop-layouts-choice
2471 \begin_layout Subsection*
2472 LFUN_LAYOUT_MODULES_CLEAR
2475 \begin_layout Description
2476 Action Clears the module list.
2480 \begin_layout Description
2481 Notion Clears the list of included modules for the current buffer.
2485 \begin_layout Description
2486 Syntax layout-modules-clear
2489 \begin_layout Description
2490 Origin rgh, 25 August 2007
2493 \begin_layout Subsection*
2494 LFUN_LAYOUT_MODULE_ADD
2497 \begin_layout Description
2498 Action Adds a module.
2502 \begin_layout Description
2503 Notion Adds a module to the list of included modules for the current buffer.
2507 \begin_layout Description
2508 Syntax layout-module-add <MODULE>
2511 \begin_layout Description
2512 Params <MODULE>: the module to be added
2515 \begin_layout Description
2516 Origin rgh, 25 August 2007
2519 \begin_layout Subsection*
2523 \begin_layout Description
2524 Action Reloads layout information.
2528 \begin_layout Description
2529 Notion Reloads all layout information for the current buffer from disk,
2530 thus recognizing any changes that have been made to layout files on the
2532 This is intended to be used only by layout developers and should not be
2533 used when one is trying to do actual work.
2537 \begin_layout Description
2538 Syntax layout-reload
2541 \begin_layout Description
2542 Origin rgh, 3 September 2007
2545 \begin_layout Subsection*
2546 LFUN_TEXTCLASS_APPLY
2549 \begin_layout Description
2550 Action Sets the text class for the current buffer.
2554 \begin_layout Description
2555 Syntax textclass-apply <TEXTCLASS>
2558 \begin_layout Description
2559 Params <TEXTCLASS>: the textclass to set.
2560 Note that this must be the filename, minus the ".layout" extension.
2564 \begin_layout Subsection*
2568 \begin_layout Description
2569 Action Loads information for a textclass from disk.
2573 \begin_layout Description
2574 Syntax textclass-load <TEXTCLASS>
2577 \begin_layout Description
2578 Params <TEXTCLASS>: the textclass to load.
2579 Note that this must be the filename, minus the ".layout" extension.
2583 \begin_layout Subsection*
2587 \begin_layout Description
2588 Action Disable selecting of text-region.
2592 \begin_layout Description
2596 \begin_layout Subsection*
2600 \begin_layout Description
2601 Action Enable selecting of text-region.
2605 \begin_layout Description
2606 Notion After enabling you can simply move arrow keys to get selected region.
2610 \begin_layout Description
2614 \begin_layout Subsection*
2618 \begin_layout Description
2619 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2623 \begin_layout Description
2627 \begin_layout Description
2628 Origin Andre, May 5 2006
2631 \begin_layout Subsection*
2635 \begin_layout Description
2636 Action Inserts math delimiters (e.g.
2637 parentheses, brackets) enclosing expression.
2641 \begin_layout Description
2642 Syntax math-delim [<LEFT>] [<RIGHT>]
2645 \begin_layout Description
2646 Params <LEFT/RIGHT>: Delimiters to be used.
2647 Each delimiter can be specified by either a LaTeX name or a valid character.
2648 ( is the default letter.
2652 \begin_layout Description
2653 Sample math-delim { rangle
2656 \begin_layout Description
2657 Origin Alejandro, 18 Jun 1996
2660 \begin_layout Subsection*
2664 \begin_layout Description
2665 Action Inserts math fixed size delimiters (e.g.
2666 parentheses, brackets) enclosing expression.
2670 \begin_layout Description
2671 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2674 \begin_layout Description
2675 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2676 \begin_inset Newline newline
2679 <L/RDELIM>: TeX code for delimiter.
2680 See Delimiter dialog for delimiters to be used.
2684 \begin_layout Description
2685 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2688 \begin_layout Description
2689 Origin Enrico & Georg, 7 May 2006
2692 \begin_layout Subsection*
2696 \begin_layout Description
2697 Action Creates a new displayed equation in text mode.
2698 Toggles inlined/display formula in math mode.
2702 \begin_layout Description
2703 Syntax math-display [<ARG>]
2706 \begin_layout Description
2707 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2708 new equation from the text mode.
2712 \begin_layout Description
2713 Origin Alejandro, 18 Jun 1996
2716 \begin_layout Subsection*
2720 \begin_layout Description
2721 Action Inserts math objects and symbols.
2725 \begin_layout Description
2726 Syntax math-insert <ARG>
2729 \begin_layout Description
2730 Params <ARG>: Symbol or LaTeX code to be inserted.
2734 \begin_layout Subsection*
2738 \begin_layout Description
2739 Action Enters subscript expression in math expression.
2743 \begin_layout Description
2744 Syntax math-subscript
2747 \begin_layout Description
2748 Origin vermeer, 12 Dec 2001
2751 \begin_layout Subsection*
2752 LFUN_MATH_SUPERSCRIPT
2755 \begin_layout Description
2756 Action Enters subscript expression in math expression.
2760 \begin_layout Description
2761 Syntax math-superscript
2764 \begin_layout Description
2765 Origin vermeer, 12 Dec 2001
2768 \begin_layout Subsection*
2772 \begin_layout Description
2773 Action Toggles the position of the limits from above/below to the right
2774 side an vice versa in integral symbol, a limit, a summation, etc.
2778 \begin_layout Description
2779 Notion Put the cursor before the symbol with the limits and then invoke
2784 \begin_layout Description
2785 Syntax math-limits [<STATE>]
2788 \begin_layout Description
2789 Params <STATE>: limits|nolimits
2792 \begin_layout Subsection*
2796 \begin_layout Description
2797 Action Inserts a math macro definition at the cursor position in the text.
2801 \begin_layout Description
2802 Syntax math-macro <NAME> [<NARGS>] [def]
2805 \begin_layout Description
2806 Params <NAME>: The name of the macro, e.g.
2808 <NARGS>: The number of parameters of the macro.
2810 "def": Has no effect anymore, just for compatibility with former LyX versions.
2814 \begin_layout Description
2815 Origin ale, 10 May 1997; sts, 21 Dec 2007
2818 \begin_layout Subsection*
2822 \begin_layout Description
2823 Action Mutates the type of math inset to the newly selected one.
2827 \begin_layout Description
2828 Syntax math-mutate <TYPE>
2831 \begin_layout Description
2832 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2833 multline|gather|flalign
2836 \begin_layout Description
2837 Origin Andre, 23 May 2001
2840 \begin_layout Subsection*
2844 \begin_layout Description
2845 Action Inserts space into math expression.
2849 \begin_layout Description
2850 Notion Use spacebar after entering this space to change type of space.
2854 \begin_layout Description
2855 Syntax math-space [<TYPE>]
2858 \begin_layout Description
2859 Params <TYPE>: negative spaces: !|negmedspace|negthickspace
2860 \begin_inset Newline newline
2863 positive spaces: ,|:|;|quad|qquad
2864 \begin_inset Newline newline
2867 "," used by default.
2871 \begin_layout Description
2872 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2875 \begin_layout Subsection*
2879 \begin_layout Description
2880 Action Inserts a matrix.
2884 \begin_layout Description
2885 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2888 \begin_layout Description
2889 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
2891 1 char) and the horizontal alignments (l, c or r) (i.e.
2896 \begin_layout Description
2897 Sample math-matrix 3 3 bccc
2900 \begin_layout Subsection*
2904 \begin_layout Description
2905 Action In text mode enters math mode (i.e.
2906 puts math insets on the current cursor position), in math mode enters text
2907 mode inside math expression.
2911 \begin_layout Description
2912 Notion If there is some selected text, it puts the text inside created math
2917 \begin_layout Description
2918 Syntax math-mode [<ARG>]
2921 \begin_layout Description
2922 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
2927 \begin_layout Description
2928 Origin Alejandro, 4 Jun 1996
2931 \begin_layout Subsection*
2932 LFUN_MATH_NUMBER_LINE_TOGGLE
2935 \begin_layout Description
2936 Action Toggles numbering of the current formula line.
2940 \begin_layout Description
2941 Notion Must be in display formula mode.
2945 \begin_layout Description
2946 Syntax math-number-line-toggle
2949 \begin_layout Description
2950 Origin Alejandro, 18 Jun 1996
2953 \begin_layout Subsection*
2954 LFUN_MATH_NUMBER_TOGGLE
2957 \begin_layout Description
2958 Action Toggles numbering/labeling of the current formula.
2962 \begin_layout Description
2963 Notion Must be in display formula mode.
2967 \begin_layout Description
2968 Syntax math-number-toggle
2971 \begin_layout Description
2972 Origin Alejandro, 4 Jun 1996
2975 \begin_layout Subsection*
2979 \begin_layout Description
2980 Action Calls external program and passes the current expression/equation
2981 as an argument for the calculation in the format appropriate to the given
2986 \begin_layout Description
2987 Notion Selection can be used to determine the input for the external program.
2991 \begin_layout Description
2992 Syntax math-extern <LANG> [<COMMAND>]
2995 \begin_layout Description
2996 Params <LANG>: octave|maxima|maple|mathematica|script
2997 \begin_inset Newline newline
3000 where "script" stands fot the external script (normalized expression will
3004 \begin_layout Description
3005 Origin Andre, 24 Apr 2001
3008 \begin_layout Description
3009 Sample math-extern maple simplify
3012 \begin_layout Subsection*
3016 \begin_layout Description
3017 Action Changes arbitrarily the size used by math fonts inside a context.
3021 \begin_layout Description
3022 Notion Provides an interface to the LaTeX math mode font size commands.
3026 \begin_layout Description
3027 Syntax math-size <STYLE>
3030 \begin_layout Description
3031 Params <STYLE>: displaystyle|
3040 \begin_layout Description
3041 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3044 \begin_layout Subsection*
3045 LFUN_MATH_MACRO_UNFOLD
3048 \begin_layout Description
3049 Action Unfold a Math Macro.
3053 \begin_layout Description
3054 Notion Unfold the Math Macro the cursor is in, i.e.
3059 \begin_layout Description
3060 Syntax math-macro-unfold
3063 \begin_layout Description
3064 Origin sts, 06 January 2008
3067 \begin_layout Subsection*
3068 LFUN_MATH_MACRO_FOLD
3071 \begin_layout Description
3072 Action Fold a Math Macro.
3076 \begin_layout Description
3077 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3078 displayed as foo before.
3082 \begin_layout Description
3083 Syntax math-macro-fold
3086 \begin_layout Description
3087 Origin sts, 06 January 2008
3090 \begin_layout Subsection*
3091 LFUN_MATH_MACRO_ADD_PARAM
3094 \begin_layout Description
3095 Action Add a parameter.
3099 \begin_layout Description
3100 Notion Add a parameter to a Math Macro.
3104 \begin_layout Description
3105 Params <NUM>: The number of the parameter behind which the new one will
3106 be added (1 for the first, i.e.
3107 use 0 for add a parameter at the left), defaults to the last one.
3111 \begin_layout Description
3112 Syntax math-macro-add-param <NUM>
3115 \begin_layout Description
3116 Origin sts, 06 January 2008
3119 \begin_layout Subsection*
3120 LFUN_MATH_MACRO_REMOVE_PARAM
3123 \begin_layout Description
3124 Action Remove the last parameter.
3128 \begin_layout Description
3129 Notion Remove the last parameter of a Math Macro and remove its value in
3130 all instances of the macro in the buffer.
3134 \begin_layout Description
3135 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3136 defaults to the last one.
3140 \begin_layout Description
3141 Syntax math-macro-remove-param <NUM>
3144 \begin_layout Description
3145 Origin sts, 06 January 2008
3148 \begin_layout Subsection*
3149 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3152 \begin_layout Description
3153 Action Append a greedy parameter.
3157 \begin_layout Description
3158 Notion Append a greedy parameter to a Math Macro which eats the following
3159 mathed cell in every instance of the macro in the buffer.
3163 \begin_layout Description
3164 Syntax math-macro-append-greedy-param
3167 \begin_layout Description
3168 Origin sts, 06 January 2008
3171 \begin_layout Subsection*
3172 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3175 \begin_layout Description
3176 Action Remove a greedy parameter.
3180 \begin_layout Description
3181 Notion Remove a greedy parameter of a Math Macro and spit out the values
3182 of it in every instance of the macro in the buffer.
3183 If it is an optional parameter the [valud] format is used.
3187 \begin_layout Description
3188 Syntax math-macro-remove-greedy-param
3191 \begin_layout Description
3192 Origin sts, 06 January 2008
3195 \begin_layout Subsection*
3196 LFUN_MATH_MACRO_MAKE_OPTIONAL
3199 \begin_layout Description
3200 Action Make a parameter optional.
3204 \begin_layout Description
3205 Notion Turn the first non-optional parameter of a Math Macro into an optional
3206 parameter with a default value.
3210 \begin_layout Description
3211 Syntax math-macro-make-optional
3214 \begin_layout Description
3215 Origin sts, 06 January 2008
3218 \begin_layout Subsection*
3219 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3222 \begin_layout Description
3223 Action Make a parameter non-optional.
3227 \begin_layout Description
3228 Notion Turn the last optional parameter of a Math Macro into a non-optional
3230 The default value is remembered to be reused later if the user changes
3235 \begin_layout Description
3236 Syntax math-macro-make-nonoptional
3239 \begin_layout Description
3240 Origin sts, 06 January 2008
3243 \begin_layout Subsection*
3244 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3247 \begin_layout Description
3248 Action Add an optional parameter.
3252 \begin_layout Description
3253 Notion Insert an optional parameter just behind the already existing optional
3258 \begin_layout Description
3259 Syntax math-macro-add-optional-param
3262 \begin_layout Description
3263 Origin sts, 06 January 2008
3266 \begin_layout Subsection*
3267 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3270 \begin_layout Description
3271 Action Remove the last optional parameter.
3275 \begin_layout Description
3276 Notion Remove the last optional parameter of a Math Macro and remove it
3277 in all the instances of the macro in the buffer.
3281 \begin_layout Description
3282 Syntax math-macro-remove-optional-param
3285 \begin_layout Description
3286 Origin sts, 06 January 2008
3289 \begin_layout Subsection*
3290 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3293 \begin_layout Description
3294 Action Add a greedy optional parameter.
3298 \begin_layout Description
3299 Notion Add a greedy optional parameter which eats the value from the following
3300 cells in mathed which are in the [value] format.
3304 \begin_layout Description
3305 Syntax math-macro-add-greedy-optional-param
3308 \begin_layout Description
3309 Origin sts, 06 January 2008
3312 \begin_layout Subsection*
3313 LFUN_IN_MATHMACROTEMPLATE
3316 \begin_layout Description
3317 Action Only active in Math Macro definition.
3321 \begin_layout Description
3322 Notion Dummy function which is only active in a Math Macro definition.
3323 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3328 \begin_layout Description
3329 Syntax in-mathmacrotemplate
3332 \begin_layout Description
3333 Origin sts, 06 January 2008
3336 \begin_layout Subsection*
3337 LFUN_PARAGRAPH_MOVE_DOWN
3340 \begin_layout Description
3341 Action Moves the current paragraph downwards in the document.
3345 \begin_layout Description
3346 Syntax paragraph-move-down
3349 \begin_layout Description
3350 Origin Edwin, 8 Apr 2006
3353 \begin_layout Subsection*
3354 LFUN_PARAGRAPH_MOVE_UP
3357 \begin_layout Description
3358 Action Moves the current paragraph upwards in the document.
3362 \begin_layout Description
3363 Syntax paragraph-move-up
3366 \begin_layout Description
3367 Origin Edwin, 8 Apr 2006
3370 \begin_layout Subsection*
3374 \begin_layout Description
3375 Action Move the cursor to the next paragraph (or begining of the current
3376 one) in upward direction.
3380 \begin_layout Description
3384 \begin_layout Description
3385 Origin Asger, 1 Oct 1996
3388 \begin_layout Subsection*
3389 LFUN_PARAGRAPH_UP_SELECT
3392 \begin_layout Description
3393 Action Move the cursor and select the text to the next paragraph (or begining
3394 of the current one) in upward direction.
3398 \begin_layout Description
3399 Syntax paragraph-up-select
3402 \begin_layout Description
3403 Origin Asger, 1 Oct 1996
3406 \begin_layout Subsection*
3410 \begin_layout Description
3411 Action Move the cursor to the next paragraph (or begining of the current
3412 one) in downward direction.
3416 \begin_layout Description
3417 Syntax paragraph-down
3420 \begin_layout Description
3421 Origin Asger, 1 Oct 1996
3424 \begin_layout Subsection*
3425 LFUN_PARAGRAPH_DOWN_SELECT
3428 \begin_layout Description
3429 Action Move the cursor and select the text to the next paragraph (or begining
3430 of the current one) in downward direction.
3434 \begin_layout Description
3435 Syntax paragraph-down-select
3438 \begin_layout Description
3439 Origin Asger, 1 Oct 1996
3442 \begin_layout Subsection*
3446 \begin_layout Description
3447 Action Jump to a paragraph given by its id number and optionally the desired
3448 position within the paragraph.
3452 \begin_layout Description
3453 Notion Note that id number of paragraph is not the sequential number of
3454 paragraph seen on the screen.
3455 Moreover the id is unique for all opened buffers (documents).
3459 \begin_layout Description
3460 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3463 \begin_layout Description
3464 Params <PAR_ID_NUMBER>: paragraph id
3465 \begin_inset Newline newline
3468 <POSITION_IN_PAR>: desired position within the paragraph
3471 \begin_layout Description
3472 Origin Dekel, 26 Aug 2000
3475 \begin_layout Subsection*
3476 LFUN_BREAK_PARAGRAPH
3479 \begin_layout Description
3480 Action Breaks the current paragraph at the current location.
3484 \begin_layout Description
3485 Syntax break-paragraph
3488 \begin_layout Subsection*
3489 LFUN_BREAK_PARAGRAPH
3492 \begin_layout Description
3493 Action Breaks the current paragraph at the current location.
3497 \begin_layout Description
3498 Notion Removes the selection.
3502 \begin_layout Description
3503 Syntax break-paragraph [<LAYOUT>]
3506 \begin_layout Description
3507 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3508 default layout) when the cursor is at the end of the line.
3512 \begin_layout Subsection*
3513 LFUN_PARAGRAPH_PARAMS
3516 \begin_layout Description
3517 Action Change paragraph settings.
3521 \begin_layout Description
3522 Notion Modifies the current paragraph, or currently selected paragraphs.
3523 This function only modifies, and does not override, existing settings.
3524 Note that the "leftindent" indent setting is deprecated.
3528 \begin_layout Description
3529 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3532 \begin_layout Description
3542 \begin_inset Newline newline
3547 paragraph_spacing default|single|onehalf|double|other
3548 \begin_inset Newline newline
3553 align block|left|right|center|default
3554 \begin_inset Newline newline
3559 labelwidthstring WIDTH|
3562 \begin_inset Newline newline
3568 \begin_layout Description
3569 Origin rgh, Aug 15 2007
3572 \begin_layout Subsection*
3573 LFUN_PARAGRAPH_PARAMS_APPLY
3576 \begin_layout Description
3577 Action Change paragraph settings.
3581 \begin_layout Description
3582 Notion Overwrite all nonspecified settings to the default ones.
3583 Use paragraph-params lfun if you don't want to overwrite others settings.
3587 \begin_layout Description
3588 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3591 \begin_layout Description
3592 Params For parameters see LFUN_PARAGRAPH_PARAMS
3595 \begin_layout Description
3596 Origin leeming, 30 Mar 2004
3599 \begin_layout Subsection*
3600 LFUN_PARAGRAPH_UPDATE
3603 \begin_layout Description
3604 Action Updates the values inside the paragraph dialog from the paragraph.
3608 \begin_layout Description
3609 Notion This is internal LFUN, not to be used by users.
3610 Called internally by LFUN_DIALOG_UPDATE.
3614 \begin_layout Description
3615 Origin leeming, 13 Mar 2003
3618 \begin_layout Subsection*
3622 \begin_layout Description
3623 Action Move the current group in the upward direction in the structure of
3628 \begin_layout Description
3629 Notion The "group" can be Part/Chapter/Section/etc.
3630 It moves the whole substructure of the group.
3634 \begin_layout Description
3638 \begin_layout Description
3639 Origin Vermeer, 23 Mar 2006
3642 \begin_layout Subsection*
3646 \begin_layout Description
3647 Action Move the current group in the downward direction in the structure
3652 \begin_layout Description
3653 Notion The "group" can be Part/Chapter/Section/etc.
3654 It moves the whole substructure of the group.
3658 \begin_layout Description
3662 \begin_layout Description
3663 Origin Vermeer, 23 Mar 2006
3666 \begin_layout Subsection*
3670 \begin_layout Description
3671 Action Moves the current group in the downward direction in the hierarchy
3672 of the document structure.
3676 \begin_layout Description
3677 Notion Part -> Chapter -> Section -> etc.
3681 \begin_layout Description
3685 \begin_layout Description
3686 Origin Vermeer, 23 Mar 2006
3689 \begin_layout Subsection*
3693 \begin_layout Description
3694 Action Moves the current group in the upward direction in the hierarchy
3695 of the document structure.
3699 \begin_layout Description
3700 Notion Part <- Chapter <- Section <- etc.
3704 \begin_layout Description
3708 \begin_layout Description
3709 Origin Vermeer, 23 Mar 2006
3712 \begin_layout Subsection*
3716 \begin_layout Description
3717 Action Edit the inset at cursor with an external application, *
3718 if one is attributed.
3722 \begin_layout Description
3723 Syntax inset-edit [<INSET_PARAMS>]
3726 \begin_layout Description
3727 Params <INSET_PARAMS>: Parameters for the inset.
3729 \begin_inset Newline newline
3732 Currently only the filename will be considered.
3736 \begin_layout Description
3737 Origin JSpitzm, 27 Apr 2006
3740 \begin_layout Subsection*
3744 \begin_layout Description
3745 Action Inserts table into the document.
3749 \begin_layout Description
3750 Syntax tabular-insert [<ROWS> <COLUMNS>]
3753 \begin_layout Description
3754 Params In case no arguments are given show insert dialog.
3758 \begin_layout Description
3759 Origin Jug, 12 Apr 2000
3762 \begin_layout Subsection*
3763 LFUN_TABULAR_FEATURE
3766 \begin_layout Description
3767 Action Sets various features to the table/cell on the current cursor position.
3771 \begin_layout Description
3772 Notion Various math-environment features are handled here as well, e.g.
3773 add-vline-left/right for Grid/Cases environment
3776 \begin_layout Description
3777 Syntax tabular-feature <FEATURE> [<ARG>]
3780 \begin_layout Description
3781 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3782 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3783 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3784 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3785 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3786 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3787 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3788 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3789 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3790 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3791 |set-bottom-space|set-interline-space|set-border-lines
3792 \begin_inset Newline newline
3795 <ARG>: additional argument for some commands, use debug mode to explore
3800 \begin_layout Description
3801 Origin Jug, 28 Jul 2000
3804 \begin_layout Subsection*
3808 \begin_layout Description
3809 Action Moves the cursor to the previous cell inside the table.
3813 \begin_layout Description
3814 Syntax cell-backward
3817 \begin_layout Description
3818 Origin Jug, 22 May 2000
3821 \begin_layout Subsection*
3825 \begin_layout Description
3826 Action Moves the cursor to the next cell inside the table.
3830 \begin_layout Description
3834 \begin_layout Subsection*
3838 \begin_layout Description
3839 Action Splits cell and shifts right part to the next cell (inside the math
3844 \begin_layout Description
3848 \begin_layout Description
3849 Origin Ale, 15 May 1997
3852 \begin_layout Subsection*
3856 \begin_layout Description
3857 Action Register the document as an file inside version control system (RCS,
3862 \begin_layout Description
3863 Notion File is registered inside cvs, svn or rcs repository acording to
3864 the existence of cvs/svn/rcs entries in the document's directory.
3866 \begin_inset Newline newline
3869 See LyX Extended Manual (Version Control Chapter) for additional information.
3873 \begin_layout Description
3877 \begin_layout Description
3878 Origin Lgb, 1 Jul 1997
3881 \begin_layout Subsection*
3885 \begin_layout Description
3886 Action Checks-in/commits the changes of the registered file to the repository.
3890 \begin_layout Description
3891 Notion In RCS case this also unlocks the file.
3895 \begin_layout Description
3899 \begin_layout Description
3900 Origin Lgb, 1 Jul 1997
3903 \begin_layout Subsection*
3907 \begin_layout Description
3908 Action Checks-out the document for edit (and locks it for RCS).
3912 \begin_layout Description
3913 Notion This is implemented only for RCS and SVN, not CVS.
3917 \begin_layout Description
3921 \begin_layout Description
3922 Origin Lgb, 1 Jul 1997
3925 \begin_layout Subsection*
3929 \begin_layout Description
3930 Action Reverts the document to the last check-in/commit in VCS.
3934 \begin_layout Description
3938 \begin_layout Description
3939 Origin Lgb, 1 Jul 1997
3942 \begin_layout Subsection*
3946 \begin_layout Description
3947 Action Undo last check-in.
3951 \begin_layout Description
3952 Notion This is currently implemented only for RCS.
3956 \begin_layout Description
3960 \begin_layout Description
3961 Origin Lgb, 1 Jul 1997
3964 \begin_layout Subsection*
3968 \begin_layout Description
3969 Action Toggles change tracking to on/off.
3973 \begin_layout Description
3974 Syntax changes-track
3977 \begin_layout Description
3978 Origin levon, 1 Oct 2002
3981 \begin_layout Subsection*
3985 \begin_layout Description
3986 Action Toggles showing of change tracking in typesetted output.
3990 \begin_layout Description
3991 Syntax changes-output
3994 \begin_layout Description
3995 Origin jspitzm, 21 Jan 2005
3998 \begin_layout Subsection*
4002 \begin_layout Description
4003 Action Moves the cursor to the position of the next change of the change
4008 \begin_layout Description
4012 \begin_layout Description
4013 Origin schmitt, 4 Oct 2006
4016 \begin_layout Subsection*
4020 \begin_layout Description
4021 Action Open change tracking dialog for merging and moves the cursor to the
4022 position of the next change.
4026 \begin_layout Description
4027 Syntax changes-merge
4030 \begin_layout Description
4031 Origin Levon, 16 Oct 2002
4034 \begin_layout Subsection*
4038 \begin_layout Description
4039 Action Accepts tracked change inside the selection.
4043 \begin_layout Description
4044 Syntax change-accept
4047 \begin_layout Description
4048 Origin Levon, 16 Oct 2002
4051 \begin_layout Subsection*
4055 \begin_layout Description
4056 Action Rejects tracked change inside the selection.
4060 \begin_layout Description
4061 Syntax change-accept
4064 \begin_layout Description
4065 Origin Levon, 16 Oct 2002
4068 \begin_layout Subsection*
4069 LFUN_ALL_CHANGES_ACCEPT
4072 \begin_layout Description
4073 Action Accepts all tracked changes in the document.
4077 \begin_layout Description
4078 Syntax all-changes-accept
4081 \begin_layout Description
4082 Origin Levon, 16 Oct 2002
4085 \begin_layout Subsection*
4086 LFUN_ALL_CHANGES_REJECT
4089 \begin_layout Description
4090 Action Rejects all tracked changes in the document.
4094 \begin_layout Description
4095 Notion Reject does not work recursively; the user may have to repeat the
4100 \begin_layout Description
4101 Syntax all-changes-reject
4104 \begin_layout Description
4105 Origin Levon, 16 Oct 2002
4108 \begin_layout Subsection*
4112 \begin_layout Description
4113 Action Apply data for an inset.
4117 \begin_layout Description
4118 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4120 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4121 on the context where it is called.
4125 \begin_layout Description
4126 Syntax inset-apply <ARGS>
4129 \begin_layout Description
4130 Params See LFUN_INSET_INSERT .
4134 \begin_layout Subsection*
4138 \begin_layout Description
4139 Action Dissolve the current inset into text.
4143 \begin_layout Description
4144 Syntax inset-dissolve [<INSET>]
4147 \begin_layout Description
4148 Params <INSET>: this can be used to make sure the right kind of inset is
4150 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4151 the charstyle inset, even if the cursor is inside several nested insets
4154 \begin_inset Newline newline
4157 For values see lyx::InsetLayout::lyxtype_ .
4161 \begin_layout Description
4162 Origin JSpitz, 7 Aug 2006
4165 \begin_layout Subsection*
4169 \begin_layout Description
4170 Action Insert new inset (type given by the parameters).
4174 \begin_layout Description
4175 Syntax inset-insert <INSET> <ARGS>
4178 \begin_layout Description
4179 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4180 nclude|index|label|nomencl|vspace|ref|toc>
4181 \begin_inset Newline newline
4184 <ARGS>: depends on the given inset.
4185 Use "lyx -dbg action" to explore.
4189 \begin_layout Description
4190 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4193 \begin_inset Newline newline
4196 where <label name> is the name of the referenced label and<Format> is one
4198 \begin_inset Newline newline
4202 \begin_inset Newline newline
4205 eqref -- (<reference>)
4206 \begin_inset Newline newline
4210 \begin_inset Newline newline
4213 vpageref -- on <page>
4214 \begin_inset Newline newline
4217 vref -- <reference> on <page>
4218 \begin_inset Newline newline
4221 prettyref -- Formatted reference
4224 \begin_layout Subsection*
4228 \begin_layout Description
4229 Action Modify existing inset.
4233 \begin_layout Description
4234 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4235 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4240 \begin_layout Description
4241 Syntax inset-modify <INSET> <ARGS>
4244 \begin_layout Description
4245 Params See LFUN_INSET_INSERT for further details.
4249 \begin_layout Subsection*
4250 LFUN_NEXT_INSET_MODIFY
4253 \begin_layout Description
4254 Action Modify the inset at cursor position, if there is one.
4258 \begin_layout Description
4259 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4260 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4265 \begin_layout Description
4266 Syntax next-inset-modify <INSET> <ARGS>
4269 \begin_layout Description
4270 Syntax next-inset-modify changetype <TYPE>
4273 \begin_layout Description
4274 Params See LFUN_INSET_INSERT for further details.
4278 \begin_layout Description
4279 Origin JSpitzm, 23 Mar 2008
4282 \begin_layout Subsection*
4283 LFUN_INSET_DIALOG_UPDATE
4286 \begin_layout Description
4287 Action Updates the values inside the dialog from the inset.
4291 \begin_layout Description
4292 Notion This is internal LFUN, not to be used by users.
4293 Called internally by LFUN_DIALOG_UPDATE
4296 \begin_layout Description
4297 Params <DIALOG-NAME>
4300 \begin_layout Description
4301 Origin leeming, 25 Feb 2003
4304 \begin_layout Subsection*
4308 \begin_layout Description
4309 Action Open the inset's properties dialog.
4313 \begin_layout Description
4314 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4318 \begin_layout Description
4319 Syntax inset-settings <INSET>
4322 \begin_layout Description
4323 Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
4326 \begin_layout Subsection*
4327 LFUN_NEXT_INSET_TOGGLE
4330 \begin_layout Description
4331 Action Toggles the inset at cursor position.
4332 For collapsables, this means it will be (un-)collapsed, in case of other
4333 insets, the editing widget (dialog) will be entered.
4335 LFUN_INSET_SETTINGS.
4339 \begin_layout Description
4340 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4341 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4346 \begin_layout Description
4347 Syntax next-inset-toggle <ARG>
4350 \begin_layout Description
4351 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4355 \begin_layout Description
4356 Origin leeming, 30 Mar 2004
4359 \begin_layout Subsection*
4363 \begin_layout Description
4364 Action Toggles the collapsable inset we are currently in.
4368 \begin_layout Description
4369 Syntax inset-toggle [<ARG>]
4372 \begin_layout Description
4373 Params <ARG>: <open|close|toggle|assign>.
4375 \begin_inset Newline newline
4378 open/close/toggle are for collapsable insets.
4379 close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4380 toggle is used when no argument is given.
4382 \begin_inset Newline newline
4385 assign is for branch inset.
4389 \begin_layout Description
4390 Origin lasgouttes, 19 Jul 2001
4393 \begin_layout Subsection*
4394 LFUN_ALL_INSETS_TOGGLE
4397 \begin_layout Description
4398 Action Toggles (open/closes) all collapsable insets (of a given type) in
4403 \begin_layout Description
4404 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4408 \begin_layout Description
4409 Syntax all-insets-toggle <STATE> <INSET>
4412 \begin_layout Description
4413 Params <STATE>: <toggle|open|close> default: toggle
4414 \begin_inset Newline newline
4417 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4421 \begin_layout Description
4422 Origin leeming, 30 Mar 2004
4425 \begin_layout Subsection*
4426 LFUN_SET_GRAPHICS_GROUP
4429 \begin_layout Description
4430 Action Set the group for the graphics inset on the cursor position.
4434 \begin_layout Description
4435 Syntax set-graphics-group [<GROUP>]
4438 \begin_layout Description
4439 Params <GROUP>: Id for an existing group.
4440 In case the Id is an empty string, the graphics inset is removed from the
4445 \begin_layout Description
4446 Origin sanda, 6 May 2008
4449 \begin_layout Subsection*
4450 LFUN_FINISHED_FORWARD
4453 \begin_layout Description
4454 Action Moves the cursor out of the current slice, going forward.
4458 \begin_layout Description
4459 Notion Cursor movement within an inset may be different than cursor movement
4460 in the surrounding text.
4461 This action should be called automatically by the cursor movement within
4462 the inset, when movement within the inset has ceased (reached the end of
4463 the last paragraph, for example), in order to move correctly back into
4464 the surrounding text.
4468 \begin_layout Subsection*
4469 LFUN_FINISHED_BACKWARD
4472 \begin_layout Description
4473 Action Moves the cursor out of the current slice, going backwards.
4477 \begin_layout Description
4478 Notion See also LFUN_FINISHED_FORWARD.
4482 \begin_layout Subsection*
4486 \begin_layout Description
4487 Action Moves the cursor out of the current slice, going right.
4491 \begin_layout Description
4492 Notion See also LFUN_FINISHED_FORWARD
4495 \begin_layout Subsection*
4499 \begin_layout Description
4500 Action Moves the cursor out of the current slice, going left.
4504 \begin_layout Description
4505 Notion See also LFUN_FINISHED_FORWARD.
4509 \begin_layout Subsection*
4513 \begin_layout Description
4514 Action Set language from the current cursor position.
4518 \begin_layout Description
4519 Syntax language <LANG>
4522 \begin_layout Description
4523 Params <LANG>: Requested language.
4524 Look in lib/languages for the list.
4528 \begin_layout Description
4529 Origin Dekel, 2 Mar 2000
4532 \begin_layout Subsection*
4536 \begin_layout Description
4537 Action Goto a label.
4541 \begin_layout Description
4542 Syntax label-goto [<LABEL>]
4545 \begin_layout Description
4546 Params <LABEL>: Requested label.
4547 If no label is given and refernce is on cursor position, Bookmark 0 is
4548 saved and cursor moves to the position of referenced label.
4552 \begin_layout Description
4553 Origin Ale, 6 Aug 1997
4556 \begin_layout Subsection*
4560 \begin_layout Description
4561 Action Inserts label to text or displayed formula.
4565 \begin_layout Description
4566 Syntax label-insert [<LABEL>]
4569 \begin_layout Description
4570 Params <LABEL>: Requested label.
4571 If no label is given dialog requesting name will be opened.
4575 \begin_layout Subsection*
4579 \begin_layout Description
4580 Action Go to the next label or cross-reference.
4584 \begin_layout Description
4585 Syntax reference-next
4588 \begin_layout Description
4589 Origin Dekel, 14 Jan 2001
4592 \begin_layout Subsection*
4596 \begin_layout Description
4597 Action Goto a bookmark.
4601 \begin_layout Description
4602 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4603 Note that bookmarsk are saved per-session, not per file.
4607 \begin_layout Description
4608 Syntax bookmark-goto <NUMBER>
4611 \begin_layout Description
4612 Params <NUMBER>: the number of the bookmark to restore.
4616 \begin_layout Description
4617 Origin Dekel, 27 January 2001
4620 \begin_layout Subsection*
4624 \begin_layout Description
4625 Action Save a bookmark.
4629 \begin_layout Description
4630 Notion Saves a numbered bookmark to the sessions file.
4631 The number must be between 1 and 9, inclusive.
4632 Note that bookmarks are saved per-session, not per file.
4636 \begin_layout Description
4637 Syntax bookmark-save <NUMBER>
4640 \begin_layout Description
4641 Params <NUMBER>: the number of the bookmark to save.
4645 \begin_layout Description
4646 Origin Dekel, 27 January 2001
4649 \begin_layout Subsection*
4653 \begin_layout Description
4654 Action Clears the list of saved bookmarks.
4658 \begin_layout Description
4659 Syntax bookmark-clear
4662 \begin_layout Description
4663 Origin bpeng, 31 October 2006
4666 \begin_layout Subsection*
4670 \begin_layout Description
4671 Action Open the given help file according to the language setting.
4675 \begin_layout Description
4676 Syntax help-open <FILE>[.lyx]
4679 \begin_layout Description
4680 Params <FILE>: any document from (/usr/share/)doc directory.
4684 \begin_layout Description
4685 Origin Jug, 27 Jun 1999
4688 \begin_layout Subsection*
4692 \begin_layout Description
4693 Action Terminates the current LyX instance.
4697 \begin_layout Description
4698 Notion Terminates the current LyX instance, asking whether to save modified
4703 \begin_layout Description
4707 \begin_layout Subsection*
4711 \begin_layout Description
4712 Action Toggles visibility of a given toolbar between on/off/auto.
4716 \begin_layout Description
4717 Notion Skiping "auto" when allowauto is false.
4721 \begin_layout Description
4722 Syntax toolbar-toggle <NAME> [allowauto]
4725 \begin_layout Description
4726 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4727 ew/update|math_panels|vcs
4730 \begin_layout Description
4731 Origin Edwin, 21 May 2007
4734 \begin_layout Subsection*
4738 \begin_layout Description
4739 Action Opens the menu given by its name.
4743 \begin_layout Description
4744 Syntax menu-open <NAME>
4747 \begin_layout Description
4748 Params <NAME>: menu name.
4749 See various .inc files in lib/ui for candidates.
4753 \begin_layout Subsection*
4757 \begin_layout Description
4758 Action Various UI visibility-toggling actions.
4762 \begin_layout Description
4763 Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
4766 \begin_layout Description
4767 Params statusbar : Toggle visibility of the statusbar.
4769 \begin_inset Newline newline
4772 menubar : Toggle visibility of the menubar.
4774 \begin_inset Newline newline
4777 scrollbar : Toggle visibility of the scrollbar.
4779 \begin_inset Newline newline
4782 frame : Toggle visibility of the frames around editing window.
4784 \begin_inset Newline newline
4787 fullscreen : Toggle fullscreen mode.
4788 This also covers calling the previous functions.
4789 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4794 \begin_layout Description
4795 Origin sanda, 9 Feb 2007
4798 \begin_layout Subsection*
4802 \begin_layout Description
4803 Action Creates new empty LyX window.
4807 \begin_layout Description
4808 Notion Already opened documents from the previous window can be found under
4813 \begin_layout Description
4814 Syntax window-new [<GEOMETRY>]
4817 \begin_layout Description
4818 Params <GEOMETRY>: pass the geometry of the window.
4819 This parameter is currently accepted only on Windows platform.
4823 \begin_layout Description
4824 Origin Abdel, 21 Oct 2006
4827 \begin_layout Subsection*
4831 \begin_layout Description
4832 Action Closes the current LyX window.
4836 \begin_layout Description
4840 \begin_layout Description
4841 Origin Abdel, 23 Oct 2006
4844 \begin_layout Subsection*
4848 \begin_layout Description
4849 Action Creates another split view of current buffer.
4853 \begin_layout Description
4854 Notion All split views act in the same way indpendently.
4858 \begin_layout Description
4859 Syntax split-view <vertical|horizontal>
4862 \begin_layout Description
4863 Params horizontal : The work areas are laid out side by side.
4865 \begin_inset Newline newline
4868 vertical : The work areas laid out vertically.
4872 \begin_layout Description
4873 Origin Abdel, 20 Feb 2008
4876 \begin_layout Subsection*
4877 LFUN_CLOSE_TAB_GROUP
4880 \begin_layout Description
4881 Action Close the current tab group.
4885 \begin_layout Description
4886 Notion This only closes the work areas, not the buffer themselves.
4887 The still opened buffers can be visualized in another tab group.
4891 \begin_layout Description
4892 Syntax close-tab-group
4895 \begin_layout Description
4896 Origin Abdel, 21 Feb 2008
4899 \begin_layout Subsection*
4903 \begin_layout Description
4904 Action Shows hidden dialog or create new one for a given function/inset
4909 \begin_layout Description
4910 Syntax dialog-show <NAME> [<DATA>]
4913 \begin_layout Description
4914 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4916 \begin_inset Newline newline
4919 document|errorlist|ert|external|file|findreplace|float|graphics|
4920 \begin_inset Newline newline
4923 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
4924 \begin_inset Newline newline
4927 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
4928 \begin_inset Newline newline
4931 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
4932 \begin_inset Newline newline
4935 wrap|listings|<SPECIAL>
4936 \begin_inset Newline newline
4939 <SPECIAL>: latexlog|vclog
4940 \begin_inset Newline newline
4943 <DATA>: data, usually settings for the given dialog.
4944 Use debug mode for the details.
4948 \begin_layout Description
4949 Origin leeming, 17 Jun 2003
4952 \begin_layout Subsection*
4953 LFUN_DIALOG_SHOW_NEW_INSET
4956 \begin_layout Description
4957 Action Shows hidden dialog or create new one for a given inset settings
4962 \begin_layout Description
4963 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
4968 \begin_layout Description
4969 Syntax dialog-show-new-inset <NAME> [<DATA>]
4972 \begin_layout Description
4973 Params See LFUN_DIALOG_SHOW .
4977 \begin_layout Description
4978 Origin leeming, 25 Feb 2003
4981 \begin_layout Subsection*
4985 \begin_layout Description
4986 Action Updates the dialog values from the inset/paragraph/document.
4990 \begin_layout Description
4991 Syntax dialog-update <NAME>
4994 \begin_layout Description
4995 Params <NAME>: paragraph|prefs|<INSET>
4996 \begin_inset Newline newline
5002 \begin_layout Description
5003 Origin leeming, 25 Feb 2003
5006 \begin_layout Subsection*
5010 \begin_layout Description
5011 Action Hides showed dialog.
5012 Counterpart to LFUN_DIALOG_SHOW .
5016 \begin_layout Description
5017 Syntax dialog-hide <NAME>
5020 \begin_layout Description
5021 Params See LFUN_DIALOG_SHOW .
5025 \begin_layout Description
5026 Origin leeming, 25 Feb 2003
5029 \begin_layout Subsection*
5033 \begin_layout Description
5034 Action Toggles dialog between showed/hidden state.
5038 \begin_layout Description
5039 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5043 \begin_layout Description
5044 Syntax dialog-toggle <NAME> [<DATA>]
5047 \begin_layout Description
5048 Params See LFUN_DIALOG_SHOW .
5052 \begin_layout Description
5053 Origin JSpitzm, 30 Apr 2007
5056 \begin_layout Subsection*
5057 LFUN_DIALOG_DISCONNECT_INSET
5060 \begin_layout Description
5061 Action Closes opened connection to opened inset.
5065 \begin_layout Description
5066 Notion Connection is used for apply functions.
5070 \begin_layout Description
5071 Syntax dialog-disconnect-inset <INSET-NAME>
5074 \begin_layout Description
5075 Origin leeming, 25 Feb 2003
5078 \begin_layout Subsection*
5082 \begin_layout Description
5083 Action This function is called when mouse button is pressed (inside workarea).Act
5084 ion depends on the context.
5088 \begin_layout Description
5089 Notion This is internal LFUN, not to be used by users.
5093 \begin_layout Description
5094 Origin Andre, 9 Aug 2002
5097 \begin_layout Subsection*
5101 \begin_layout Description
5102 Action This function is called when double click on mouse button is pressed
5104 Action depends on the context.
5108 \begin_layout Description
5109 Notion This is internal LFUN, not to be used by users.
5113 \begin_layout Description
5114 Origin Andre, 9 Aug 2002
5117 \begin_layout Subsection*
5121 \begin_layout Description
5122 Action This function is called when triple click on mouse button is pressed
5124 Action depends on the context.
5128 \begin_layout Description
5129 Notion This is internal LFUN, not to be used by users.
5133 \begin_layout Description
5134 Origin Andre, 9 Aug 2002
5137 \begin_layout Subsection*
5141 \begin_layout Description
5142 Action This function is called when mouse cursor is moving over the text.Action
5143 depends on the context.
5147 \begin_layout Description
5148 Notion This is internal LFUN, not to be used by users.
5152 \begin_layout Description
5153 Origin Andre, 9 Aug 2002
5156 \begin_layout Subsection*
5160 \begin_layout Description
5161 Action This function is called when mouse button is released (inside workarea).Ac
5162 tion depends on the context.
5166 \begin_layout Description
5167 Notion This is internal LFUN, not to be used by users.
5171 \begin_layout Description
5172 Origin Andre, 9 Aug 2002
5175 \begin_layout Subsection*
5179 \begin_layout Description
5180 Action Turn off the loaded keyboard map.
5184 \begin_layout Description
5188 \begin_layout Subsection*
5192 \begin_layout Description
5193 Action Turn on the primary keyboard map.
5197 \begin_layout Description
5198 Notion Maps were widely used in past, when X-windows didn't have nowadays
5200 They can be still used to maintain uniform keyboard layout across the various
5203 \begin_inset Newline newline
5206 The language is to be set in the Preferences dialog.
5210 \begin_layout Description
5211 Syntax keymap-primary
5214 \begin_layout Subsection*
5215 LFUN_KEYMAP_SECONDARY
5218 \begin_layout Description
5219 Action Turn on the secondary keyboard map.
5223 \begin_layout Description
5224 Syntax keymap-secondary
5227 \begin_layout Subsection*
5231 \begin_layout Description
5232 Action Toggles keyboard maps (first/second/off).
5236 \begin_layout Description
5237 Syntax keymap-toggle
5240 \begin_layout Description
5241 Origin leeming, 30 Mar 2004
5244 \begin_layout Subsection*
5245 LFUN_SERVER_GET_LAYOUT
5248 \begin_layout Description
5249 Action Returns the current layout (that is environment) name on the cursor
5254 \begin_layout Description
5255 Syntax server-get-layout
5258 \begin_layout Subsection*
5259 LFUN_SERVER_GET_FILENAME
5262 \begin_layout Description
5263 Action Returns path and file name of the currently edited document.
5267 \begin_layout Description
5268 Syntax server-get-filename
5271 \begin_layout Subsection*
5272 LFUN_SERVER_GOTO_FILE_ROW
5275 \begin_layout Description
5276 Action Sets the cursor position based on the row number of generated TeX
5281 \begin_layout Description
5282 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5285 \begin_layout Description
5286 Origin Edmar, 23 Dec 1998
5289 \begin_layout Subsection*
5293 \begin_layout Description
5294 Action Sends notify message about the last key-sequence to client.
5298 \begin_layout Description
5299 Notion This can be used to grab last key-sequence used inside the LyX window.
5303 \begin_layout Description
5304 Syntax server-notify
5307 \begin_layout Subsection*
5311 \begin_layout Description
5312 Action Sets the cursor position based on the editing area coordinates (similar
5313 as clicking on that point with left mouse button).
5317 \begin_layout Description
5318 Syntax server-set-xy <X> <Y>
5321 \begin_layout Subsection*
5325 \begin_layout Description
5326 Action Returns the coordinates of cursor position in the editing area.
5330 \begin_layout Description
5331 Syntax server-get-xy
5334 \begin_layout Subsection*
5338 \begin_layout Description
5339 Action Generates the code (literate programming).
5343 \begin_layout Description
5344 Notion Latex file with extension literate_extension is generated.
5345 Then LyX invokes build_command (with a default of``make'') to generate
5346 the code and build_error_filter to process the compilation error messages.
5348 \begin_inset Newline newline
5351 In case you want to process your literate file with a script, or some other
5352 program, just insert in your lyxrc file an entry with:
5353 \begin_inset Newline newline
5356 build_command "my_script my_arguments"
5357 \begin_inset Newline newline
5360 The build_error_filter differs from the literate_error_filter only in that
5361 the former will identify error messages from your compiler.
5365 \begin_layout Description
5366 Syntax build-program
5369 \begin_layout Subsection*
5370 LFUN_BUFFER_AUTO_SAVE
5373 \begin_layout Description
5374 Action Saves the current buffer to a temporary file.
5378 \begin_layout Description
5379 Notion Saves the current buffer to a file named "#filename#".
5380 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5384 \begin_layout Description
5385 Syntax buffer-auto-save
5388 \begin_layout Subsection*
5389 LFUN_BUFFER_CHILD_OPEN
5392 \begin_layout Description
5393 Action Loads the given child document.
5397 \begin_layout Description
5398 Notion The current document is treated as a parent.
5402 \begin_layout Description
5403 Syntax buffer-child-open <FILE>
5406 \begin_layout Description
5407 Params <FILE>: Filename of the child.
5408 The directory of the parent is assumed by default.
5412 \begin_layout Description
5413 Origin Ale, 28 May 1997
5416 \begin_layout Subsection*
5420 \begin_layout Description
5421 Action Runs chktex for the current document.
5425 \begin_layout Description
5426 Syntax buffer-chktex
5429 \begin_layout Description
5430 Origin Asger, 30 Oct 1997
5433 \begin_layout Subsection*
5434 LFUN_BUFFER_TOGGLE_COMPRESSION
5437 \begin_layout Description
5438 Action Toggles compression of the current document on/off.
5442 \begin_layout Description
5443 Syntax buffer-toggle-compression
5446 \begin_layout Description
5447 Origin bpeng, 27 Apr 2006
5450 \begin_layout Subsection*
5454 \begin_layout Description
5455 Action Closes the current buffer.
5459 \begin_layout Description
5460 Notion Closes the current buffer, asking whether to save it, etc, if the
5461 buffer has been modified.
5465 \begin_layout Description
5469 \begin_layout Subsection*
5473 \begin_layout Description
5474 Action Exports the current buffer (document) to the given format.
5478 \begin_layout Description
5479 Syntax buffer-export <FORMAT>
5482 \begin_layout Description
5483 Params <FORMAT> is either "custom" or one of the formats which you can find
5484 in Tools->Preferences->File formats->Format.
5485 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5486 for pdflatex) or "ps" for postscript.
5488 \begin_inset Newline newline
5491 In case of "custom" you will be asked for a format you want to start from
5492 and for the command that you want to apply to this format.
5493 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5497 \begin_layout Description
5498 Origin Lgb, 29 Jul 1997
5501 \begin_layout Subsection*
5502 LFUN_BUFFER_EXPORT_CUSTOM
5505 \begin_layout Description
5506 Action Exports the current buffer (document) from the given format using
5507 the given command on it.
5511 \begin_layout Description
5512 Syntax buffer-export-custom <FORMAT> <COMMAND>
5515 \begin_layout Description
5516 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5519 \begin_inset Newline newline
5522 <COMMAND> this command will be launched on the file.
5523 Note that you can use "$$FName" string to qualify the intermediate file.
5527 \begin_layout Description
5528 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5531 \begin_layout Description
5532 Origin leeming, 27 Mar 2004
5535 \begin_layout Subsection*
5539 \begin_layout Description
5540 Action Prints the current document.
5544 \begin_layout Description
5545 Notion Many settings can be given via the preferences dialog.
5549 \begin_layout Description
5550 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5553 \begin_layout Description
5554 Params <TARGET> is either "printer" or "file".
5556 \begin_inset Newline newline
5559 <TARGER-NAME> is either "default" or file name or printer name.
5561 \begin_inset Newline newline
5564 <COMMAND> command ensuring the printing job.
5568 \begin_layout Description
5569 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5572 \begin_layout Description
5573 Origin leeming, 28 Mar 2004
5576 \begin_layout Subsection*
5580 \begin_layout Description
5581 Action Import a given file as a lyx document.
5585 \begin_layout Description
5586 Notion File can be imported iff lyx file format is (transitively) reachable
5587 via defined convertors in preferences.
5588 Look into File->Import menu to get an idea of the currently active import
5593 \begin_layout Description
5594 Syntax buffer-import <FORMAT> [<FILE>]
5597 \begin_layout Description
5598 Origin Asger, 24 Jul 1998
5601 \begin_layout Subsection*
5605 \begin_layout Description
5606 Action Creates a new buffer (that is, document).
5610 \begin_layout Description
5611 Notion Implicit path can be set in Preferences dialog.
5615 \begin_layout Description
5616 Syntax buffer-new [<FILE>]
5619 \begin_layout Description
5620 Params <FILE>: filename of created file with absolute path.
5624 \begin_layout Subsection*
5625 LFUN_BUFFER_NEW_TEMPLATE
5628 \begin_layout Description
5629 Action Creates a new buffer (that is, document) from a template.
5633 \begin_layout Description
5634 Notion Path for new files and templates can be set in Preferences dialog.
5635 Template will be asked for via Open-dialog.
5639 \begin_layout Description
5640 Syntax buffer-new-template [<FILE>]
5643 \begin_layout Description
5644 Params <FILE>: filename of created file with absolute path.
5648 \begin_layout Subsection*
5652 \begin_layout Description
5653 Action Reverts opened document.
5657 \begin_layout Description
5658 Syntax buffer-reload
5661 \begin_layout Description
5662 Origin Asger, 2 Feb 1997
5665 \begin_layout Subsection*
5669 \begin_layout Description
5670 Action Switch to the given buffer.
5674 \begin_layout Description
5675 Notion This is useful also in case you need simultaneously more views of
5676 the edited document in different LyX windows.
5680 \begin_layout Description
5681 Syntax buffer-new-template <BUFFER>
5684 \begin_layout Description
5685 Params <BUFFER>: already opened document which is to be shown.
5689 \begin_layout Subsection*
5690 LFUN_BUFFER_TOGGLE_READ_ONLY
5693 \begin_layout Description
5694 Action Toggle editing mode of the current document between read/write and
5699 \begin_layout Description
5700 Notion In the ->Readonly mode checks-in/commits the data if the file is
5701 under version control.
5702 In the Readonly-> mode checkouts the data from repository.
5704 \begin_inset Newline newline
5707 If these operations fail, buffer won't be toggled.
5711 \begin_layout Description
5712 Syntax buffer-toggle-read-only
5715 \begin_layout Description
5716 Origin Lgb, 27 May 1997
5719 \begin_layout Subsection*
5723 \begin_layout Description
5724 Action Displays current buffer in chosen format.
5728 \begin_layout Description
5729 Notion Displays the contents of the current buffer in the chosen format,
5730 for example, PDF or DVI.
5731 This runs the necessary converter, calls the defined viewer, and so forth.
5735 \begin_layout Description
5736 Syntax buffer-view <FORMAT>
5739 \begin_layout Description
5740 Params <FORMAT>: The format to display, where this is one of the formats
5741 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5745 \begin_layout Subsection*
5749 \begin_layout Description
5750 Action Exports the current document and put the result into the temporary
5755 \begin_layout Description
5756 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5757 EW) the output will be rewriten - updated.
5758 This is useful in case your viewer is able to detect such changes (e.g.
5759 ghostview for postscript).
5763 \begin_layout Description
5764 Syntax buffer-update <FORMAT>
5767 \begin_layout Description
5768 Params <FORMAT>: The format to display, where this is one of the formats
5769 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5773 \begin_layout Description
5774 Origin Dekel, 5 Aug 2000
5777 \begin_layout Subsection*
5781 \begin_layout Description
5782 Action Saves the current buffer.
5786 \begin_layout Description
5787 Notion Saves the current buffer to disk, using the filename that is already
5788 associated with the buffer, asking for one if none is yet assigned.
5792 \begin_layout Description
5796 \begin_layout Subsection*
5797 LFUN_BUFFER_WRITE_AS
5800 \begin_layout Description
5801 Action Rename and save current buffer.
5805 \begin_layout Description
5806 Syntax buffer-write-as <FILENAME>
5809 \begin_layout Description
5810 Params <FILENAME>: New name of the buffer/file.
5811 A relative path is with respect to the original location of the buffer/file.
5815 \begin_layout Subsection*
5816 LFUN_BUFFER_WRITE_ALL
5819 \begin_layout Description
5820 Action Save all changed documents.
5824 \begin_layout Description
5825 Syntax buffer-write-all
5828 \begin_layout Description
5829 Origin rgh, gpothier 6 Aug 2007
5832 \begin_layout Subsection*
5836 \begin_layout Description
5837 Action Switch to the next opened document.
5841 \begin_layout Description
5842 Notion Note that this does not necessarily mean next in tabbar (for full
5843 list see View menu).
5847 \begin_layout Description
5851 \begin_layout Subsection*
5852 LFUN_BUFFER_PREVIOUS
5855 \begin_layout Description
5856 Action Switch to the previous opened document.
5860 \begin_layout Description
5861 Syntax buffer-previous
5864 \begin_layout Subsection*
5865 LFUN_MASTER_BUFFER_UPDATE
5868 \begin_layout Description
5869 Action When run from a child document, this updates (exports) document built
5870 from the master buffer.
5871 If a master is not found, it updates the current buffer.
5875 \begin_layout Description
5876 Syntax master-buffer-update
5879 \begin_layout Description
5880 Origin Tommaso, 20 Sep 2007
5883 \begin_layout Subsection*
5884 LFUN_MASTER_BUFFER_VIEW
5887 \begin_layout Description
5888 Action When run from a child document, this command shows a preview built
5889 from the master buffer.
5890 If a master is not found, it previews the current buffer.
5894 \begin_layout Description
5895 Syntax master-buffer-view
5898 \begin_layout Description
5899 Origin Tommaso, 20 Sep 2007
5902 \begin_layout Subsection*
5903 LFUN_BUFFER_LANGUAGE
5906 \begin_layout Description
5907 Action Set language of the current document.
5911 \begin_layout Description
5912 Syntax buffer-language <LANG>
5915 \begin_layout Description
5916 Params <LANG>: language name.
5917 See lib/languages for list.
5921 \begin_layout Description
5922 Origin leeming, 30 Mar 2004
5925 \begin_layout Subsection*
5926 LFUN_BUFFER_SAVE_AS_DEFAULT
5929 \begin_layout Description
5930 Action Save the current document settings as default.
5934 \begin_layout Description
5935 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5939 \begin_layout Description
5940 Syntax buffer-save-as-default [<ARGS>]
5943 \begin_layout Description
5944 Params <ARGS>: contains the particular settings to be saved.
5945 They obey the syntax you can find in document header of usual .lyx file.
5949 \begin_layout Description
5950 Origin leeming, 30 Mar 2004
5953 \begin_layout Subsection*
5954 LFUN_BUFFER_PARAMS_APPLY
5957 \begin_layout Description
5958 Action Apply the given settings to the current document.
5962 \begin_layout Description
5963 Syntax buffer-params-apply [<ARGS>]
5966 \begin_layout Description
5967 Params <ARGS>: contains the particular settings to be saved.
5968 They obey the syntax you can find in document header of usual .lyx file.
5972 \begin_layout Description
5973 Origin leeming, 30 Mar 2004
5976 \begin_layout Subsection*
5980 \begin_layout Description
5981 Action Inserts another LyX file.
5985 \begin_layout Description
5986 Syntax file-insert [<FILE>]
5989 \begin_layout Description
5990 Params <FILE>: Filename to be inserted.
5994 \begin_layout Subsection*
5995 LFUN_FILE_INSERT_PLAINTEXT
5998 \begin_layout Description
5999 Action Inserts plain text file.
6003 \begin_layout Description
6004 Syntax file-insert-plaintext [<FILE>]
6007 \begin_layout Description
6008 Params <FILE>: Filename to be inserted.
6012 \begin_layout Description
6013 Origin CFO-G, 19 Nov 1997
6016 \begin_layout Subsection*
6017 LFUN_FILE_INSERT_PLAINTEXT_PARA
6020 \begin_layout Description
6021 Action Inserts plain text file as paragraph (i.e.
6026 \begin_layout Description
6027 Syntax file-insert-plaintext-para [<FILE>]
6030 \begin_layout Description
6031 Params <FILE>: Filename to be inserted.
6035 \begin_layout Description
6036 Origin Levon, 14 Feb 2001
6039 \begin_layout Subsection*
6043 \begin_layout Description
6044 Action Open LyX document.
6048 \begin_layout Description
6049 Syntax file-open [<FILE>]
6052 \begin_layout Description
6053 Params <FILE>: Filename to be opened.
6057 \begin_layout Subsection*
6061 \begin_layout Description
6062 Action Executes a command defined in a .def file.
6066 \begin_layout Description
6067 Notion The definitions are by default read from lib/commands/default.def.
6069 \begin_inset Newline newline
6072 A .def file allows to define a command with
6074 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6075 <LFUN> is the lfun code to be executed (see e.g.
6076 LFUN_COMMAND_SEQUENCE).
6079 def_file "FileName" allows to include another .def file.
6081 \begin_inset Newline newline
6084 This is particularly useful in connection with toolbar buttons: Since the
6085 name of the button image for this lfun is lib/images/commands/<NAME>.png
6086 this is the way to assign an image to a complex command-sequence.
6090 \begin_layout Description
6094 \begin_layout Description
6095 Params <NAME>: Name of the command that must be called.
6099 \begin_layout Description
6100 Origin broider, 2 Oct 2007
6103 \begin_layout Subsection*
6107 \begin_layout Description
6108 Action Simulate halting Meta key (Alt key on PCs).
6112 \begin_layout Description
6113 Notion Used for buffer editation not for GUI control.
6117 \begin_layout Description
6121 \begin_layout Subsection*
6125 \begin_layout Description
6126 Action Cancels sequence prepared by LFUN_META_PREFIX .
6130 \begin_layout Description
6134 \begin_layout Subsection*
6135 LFUN_COMMAND_EXECUTE
6138 \begin_layout Description
6139 Action Opens the minibuffer toolbar so that the user can type in there.
6143 \begin_layout Description
6144 Notion Usually bound to M-x shortcut.
6148 \begin_layout Description
6149 Syntax command-execute
6152 \begin_layout Subsection*
6156 \begin_layout Description
6157 Action Return the current key sequence and available options as a string.
6161 \begin_layout Description
6162 Notion No options are added if no current map exists.
6164 \begin_inset Newline newline
6167 This is probably usable only with connection to lyxserver.
6171 \begin_layout Description
6172 Syntax command-prefix
6175 \begin_layout Subsection*
6176 LFUN_COMMAND_SEQUENCE
6179 \begin_layout Description
6180 Action Run more commands (LFUN and its parameters) in a sequence.
6184 \begin_layout Description
6185 Syntax command-sequence <CMDS>
6188 \begin_layout Description
6189 Params <CMDS>: Sequence of commands separated by semicolons.
6193 \begin_layout Description
6194 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6198 \begin_layout Description
6199 Origin Andre, 11 Nov 1999
6202 \begin_layout Subsection*
6203 LFUN_COMMAND_ALTERNATIVES
6206 \begin_layout Description
6207 Action Runs the first listed command that is enabled.
6211 \begin_layout Description
6212 Notion This can be used to bind multiple functions to a single key, and
6213 then which one is used will depend upon the context.
6217 \begin_layout Description
6218 Syntax command-alternatives <CMDS>
6221 \begin_layout Description
6222 Params <CMDS>: Sequence of commands separated by semicolons.
6226 \begin_layout Description
6227 Sample command-alternatives completion-accept;cell-forward
6230 \begin_layout Description
6231 Origin rgh, 24 September 2008
6234 \begin_layout Subsection*
6238 \begin_layout Description
6239 Action Shows message in statusbar (for script purposes).
6243 \begin_layout Description
6244 Syntax message <STRING>
6247 \begin_layout Description
6248 Origin Lgb, 8 Apr 2001
6251 \begin_layout Subsection*
6252 LFUN_PREFERENCES_SAVE
6255 \begin_layout Description
6256 Action Save user preferences.
6260 \begin_layout Description
6261 Syntax preferences-save
6264 \begin_layout Description
6265 Origin Lgb, 27 Nov 1999
6268 \begin_layout Subsection*
6272 \begin_layout Description
6273 Action Reconfigure the automatic settings.
6277 \begin_layout Description
6281 \begin_layout Description
6282 Origin Asger, 14 Feb 1997
6285 \begin_layout Subsection*
6289 \begin_layout Description
6290 Action Apply the given settings to user preferences.
6294 \begin_layout Description
6295 Syntax lyxrc-apply <SETTINGS>
6298 \begin_layout Description
6299 Params <SETTINGS>: settings which are to be set.
6300 Take a look into ~/.lyx/preferences to get an idea which commands to use
6302 lyx::LyXRC::LyXRCTags has the list of possible commands.
6306 \begin_layout Subsection*
6307 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6310 \begin_layout Description
6311 Action Determine whether keep cursor inside the editing window regardless
6312 the scrollbar movement.
6316 \begin_layout Description
6317 Syntax toggle-cursor-follows-scrollbar
6320 \begin_layout Description
6321 Origin ARRae, 2 Dec 1997
6324 \begin_layout Subsection*
6328 \begin_layout Description
6329 Action Set the given LyX color to the color defined by the X11 name given.
6333 \begin_layout Description
6334 Notion A new color entry is created if the color is unknown.
6335 Color names can be stored as a part of user settings.
6339 \begin_layout Description
6340 Syntax set-color <LYX_NAME> <X11_NAME>
6343 \begin_layout Description
6344 Origin SLior, 11 Jun 2000
6347 \begin_layout Subsection*
6351 \begin_layout Description
6352 Action Count the statistics (number of words and characters) in the document
6353 or in the given selection.
6357 \begin_layout Description
6358 Notion Note that this function gives the number of words/chars written,
6359 not the number of characters which will be typeset.
6363 \begin_layout Description
6367 \begin_layout Description
6368 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6371 \begin_layout Subsection*
6372 LFUN_COMPLETION_INLINE
6375 \begin_layout Description
6376 Action Show the inline completion at the cursor position.
6380 \begin_layout Description
6381 Syntax completion-inline
6384 \begin_layout Description
6385 Origin sts, Feb 19 2008
6388 \begin_layout Subsection*
6389 LFUN_COMPLETION_POPUP
6392 \begin_layout Description
6393 Action Show the completion popup at the cursor position.
6397 \begin_layout Description
6398 Syntax completion-popup
6401 \begin_layout Description
6402 Origin sts, Feb 19 2008
6405 \begin_layout Subsection*
6406 LFUN_COMPLETION_COMPLETE
6409 \begin_layout Description
6410 Action Try to complete the word or command at the cursor position.
6414 \begin_layout Description
6418 \begin_layout Description
6419 Origin sts, Feb 19 2008
6422 \begin_layout Subsection*
6423 LFUN_COMPLETION_CANCEL
6426 \begin_layout Description
6427 Action Try to cancel completion, either the popup or the inline completion
6431 \begin_layout Description
6432 Syntax completion-cancel
6435 \begin_layout Description
6436 Origin sts, Sep 07 2008
6439 \begin_layout Subsection*
6440 LFUN_COMPLETION_ACCEPT
6443 \begin_layout Description
6444 Action Accept suggested completion.
6448 \begin_layout Description
6449 Syntax completion-accept
6452 \begin_layout Description
6453 Origin sanda, Sep 08 2008
6456 \begin_layout Subsection*
6457 LFUN_BRANCH_ACTIVATE
6460 \begin_layout Description
6461 Action Activate the branch
6464 \begin_layout Description
6465 Syntax branch-activate <BRANCH>
6468 \begin_layout Description
6469 Params <BRANCH>: The branch to activate
6472 \begin_layout Description
6473 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6474 \begin_inset Newline newline
6477 could be used to export a pdf with the answers branch includedwithout one's
6478 having to open LyX and activate the branch manually.
6481 \begin_layout Description
6482 Origin rgh, 27 May 2008
6485 \begin_layout Subsection*
6486 LFUN_BRANCH_ACTIVATE
6489 \begin_layout Description
6490 Action De-activate the branch
6493 \begin_layout Description
6494 Syntax branch-deactivate <BRANCH>
6497 \begin_layout Description
6498 Params <BRANCH>: The branch to deactivate
6501 \begin_layout Description
6502 Origin rgh, 27 May 2008