1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
13 \font_typewriter default
14 \font_default_family default
21 \paperfontsize default
30 \paperorientation portrait
37 \paragraph_separation indent
39 \quotes_language english
42 \paperpagestyle default
43 \tracking_changes false
51 \begin_layout Section*
52 LFUNs documentation automatically generated 23.7.2008.
55 \begin_layout Standard
59 \begin_layout Plain Layout
69 \begin_inset VSpace 1cm
75 \begin_layout Subsection*
79 \begin_layout Description
80 Action Adds an acute accent to the next character typed.
84 \begin_layout Description
88 \begin_layout Subsection*
92 \begin_layout Description
93 Action Adds a breve accent to the next character typed.
97 \begin_layout Description
101 \begin_layout Subsection*
105 \begin_layout Description
106 Action Adds a caron to the next character typed.
110 \begin_layout Description
114 \begin_layout Subsection*
118 \begin_layout Description
119 Action Adds a cedilla to the next character typed.
123 \begin_layout Description
124 Syntax accent-cedilla
127 \begin_layout Subsection*
131 \begin_layout Description
132 Action Adds a circle accent to the next character typed.
136 \begin_layout Description
140 \begin_layout Subsection*
141 LFUN_ACCENT_CIRCUMFLEX
144 \begin_layout Description
145 Action Adds a circumflex to the next character typed.
149 \begin_layout Description
150 Syntax accent-circumflex
153 \begin_layout Subsection*
157 \begin_layout Description
158 Action Adds a dot accent to the next character typed.
162 \begin_layout Description
166 \begin_layout Subsection*
170 \begin_layout Description
171 Action Adds a grave accent to the next character typed.
175 \begin_layout Description
179 \begin_layout Subsection*
180 LFUN_ACCENT_HUNGARIAN_UMLAUT
183 \begin_layout Description
184 Action Adds a Hungarian umlaut to the next character typed.
188 \begin_layout Description
192 \begin_layout Subsection*
196 \begin_layout Description
197 Action Adds a macron to the next character typed.
201 \begin_layout Description
205 \begin_layout Subsection*
209 \begin_layout Description
210 Action Adds an ogonek accent to the next character typed.
214 \begin_layout Description
218 \begin_layout Subsection*
222 \begin_layout Description
223 Action Adds a tie over the next two character typed.
227 \begin_layout Description
228 Notion The following char will finish the tie.
232 \begin_layout Description
236 \begin_layout Subsection*
240 \begin_layout Description
241 Action Adds a tilde over the next character typed.
245 \begin_layout Description
249 \begin_layout Subsection*
253 \begin_layout Description
254 Action Adds an umlaut over the next character typed.
258 \begin_layout Description
262 \begin_layout Subsection*
266 \begin_layout Description
267 Action Adds a bar under the next character typed.
271 \begin_layout Description
272 Syntax accent-underbar
275 \begin_layout Subsection*
279 \begin_layout Description
280 Action Adds a dot under the next character typed.
284 \begin_layout Description
285 Syntax accent-underdot
288 \begin_layout Subsection*
292 \begin_layout Description
293 Action Inserts a caption inset.
297 \begin_layout Description
298 Syntax caption-insert
301 \begin_layout Description
302 Origin Lgb, 18 Jul 2000
305 \begin_layout Subsection*
309 \begin_layout Description
310 Action Inserts the current date.
314 \begin_layout Description
315 Syntax date-insert [<ARG>]
318 \begin_layout Description
319 Params <ARG>: Format of date.
320 The default value (%x) can be set in Preferences->Date format.
321 For possible formats see manual page of strftime function.
325 \begin_layout Description
326 Origin jdblair, 31 Jan 2000
329 \begin_layout Subsection*
333 \begin_layout Description
334 Action Inserts a footnote inset.
338 \begin_layout Description
339 Syntax footnote-insert
342 \begin_layout Description
343 Origin Jug, 7 Mar 2000
346 \begin_layout Subsection*
350 \begin_layout Description
351 Action Inserts an ERT inset.
355 \begin_layout Description
359 \begin_layout Description
360 Origin Jug, 18 Feb 2000
363 \begin_layout Subsection*
367 \begin_layout Description
368 Action Inserts a float inset.
372 \begin_layout Description
373 Syntax float-insert <TYPE>
376 \begin_layout Description
377 Params <TYPE>: type of float depends on the used textclass.
378 Usually "algorithm", "table", "figure" parameters can be given.
382 \begin_layout Description
383 Origin Lgb, 27 Jun 2000
386 \begin_layout Subsection*
387 LFUN_FLOAT_WIDE_INSERT
390 \begin_layout Description
391 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
395 \begin_layout Description
396 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
400 \begin_layout Description
401 Syntax float-wide-insert <TYPE>
404 \begin_layout Description
405 Params <TYPE>: type of float depends on the used textclass.
406 Usually "algorithm", "table", "figure" parameters can be given.
410 \begin_layout Description
411 Origin Lgb, 31 Oct 2001
414 \begin_layout Subsection*
415 LFUN_FLOAT_LIST_INSERT
418 \begin_layout Description
419 Action Inserts the list of floats in the document.
423 \begin_layout Description
424 Syntax float-list-insert <TYPE>
427 \begin_layout Description
428 Params <TYPE>: type of float depends on the used textclass.
429 Usually "algorithm", "table", "figure" parameters can be given.
433 \begin_layout Description
434 Origin Lgb, 3 May 2001
437 \begin_layout Subsection*
441 \begin_layout Description
442 Action Inserts floats wrapped by the text around.
446 \begin_layout Description
447 Syntax wrap-insert <TYPE>
450 \begin_layout Description
451 Params <TYPE>: table|figure
454 \begin_layout Description
455 Origin Dekel, 7 Apr 2002
458 \begin_layout Subsection*
462 \begin_layout Description
463 Action Inserts an optional-argument (short title) inset.
467 \begin_layout Description
468 Syntax optional-insert
471 \begin_layout Description
472 Origin vermeer, 12 Aug 2002
475 \begin_layout Subsection*
479 \begin_layout Description
480 Action Inserts a horizontal line.
484 \begin_layout Description
488 \begin_layout Description
489 Origin Andre, Oct 27 2003
492 \begin_layout Subsection*
496 \begin_layout Description
497 Action Inserts a new page.
501 \begin_layout Description
502 Syntax newpage-insert <ARG>
505 \begin_layout Description
506 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
510 \begin_layout Description
511 Origin uwestoehr, 24 Nov 2007
514 \begin_layout Subsection*
515 LFUN_MARGINALNOTE_INSERT
518 \begin_layout Description
519 Action Inserts a marginal note.
523 \begin_layout Description
524 Syntax marginalnote-insert
527 \begin_layout Description
528 Origin Lgb, 26 Jun 2000
531 \begin_layout Subsection*
535 \begin_layout Description
536 Action Inserts a single unicode character.
540 \begin_layout Description
541 Syntax unicode-insert <CHAR>
544 \begin_layout Description
545 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
549 \begin_layout Description
550 Sample unicode-insert 0x0100
553 \begin_layout Description
554 Origin Lgb, 22 Oct 2006
557 \begin_layout Subsection*
561 \begin_layout Description
562 Action Inserts a new listings inset.
566 \begin_layout Description
567 Syntax listing-insert
570 \begin_layout Description
571 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
574 \begin_layout Subsection*
578 \begin_layout Description
579 Action Inserts quotes according to the type and quote-language preference.
583 \begin_layout Description
584 Action Currently English, Swedish, German, Polish, French, Danish quotes
589 \begin_layout Description
590 Syntax quote-insert [<TYPE>]
593 \begin_layout Description
594 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
599 \begin_layout Subsection*
603 \begin_layout Description
604 Action Displays shortcuts, lyxrc, package and textclass availability and
605 menu information in a non-editable boxed InsetText.
609 \begin_layout Description
610 Notion Apart from lfun arguments you can use the following method:
611 \begin_inset Newline newline
615 input the type and argument of this inset, e.g.
616 "menu paste", in the work area.
618 \begin_inset Newline newline
622 select the text and run info-insert lfun.
626 \begin_layout Description
627 Syntax info-insert <TYPE> <ARG>
630 \begin_layout Description
631 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
632 \begin_inset Newline newline
635 <ARG>: argument for a given type.
636 Look into InsetInfo.h for detailed description.
640 \begin_layout Description
641 Origin bpeng, 7 Oct 2007
644 \begin_layout Subsection*
648 \begin_layout Description
649 Action Inserts branch inset.
653 \begin_layout Description
654 Syntax branch-insert <BRANCH-NAME>
657 \begin_layout Description
658 Origin vermeer, 17 Aug 2003
661 \begin_layout Subsection*
665 \begin_layout Description
666 Action Inserts Box inset.
670 \begin_layout Description
671 Syntax box-insert [<TYPE>]
674 \begin_layout Description
675 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
677 \begin_inset Newline newline
680 Framed is the default one.
684 \begin_layout Description
685 Origin vermeer, 7 Oct 2003
688 \begin_layout Subsection*
692 \begin_layout Description
693 Action Inserts CharStyle, Custom inset or XML short element.
697 \begin_layout Description
698 Notion Look into the Customization manual for more information about these
701 \begin_inset Newline newline
704 To make this command enabled the layout file for the document class you're
705 using has to load the character styles.
706 There are a few contained in the Logical Markup module.
707 You can also of course create some yourself.
709 \begin_inset Newline newline
712 For dissolving the element see LFUN_INSET_DISSOLVE.
716 \begin_layout Description
717 Syntax flex-insert <TYPE:Name>
720 \begin_layout Description
721 Params TYPE: CharStyle|Custom|Element|Standard
722 \begin_inset Newline newline
725 Identifies whether this is a Character Style, a Custom Inset or an XML
726 Element, and which dynamical sub-menu this flex inset is in on the LyX
728 If Standard (currently unused): none of these.
729 Name: This name must be defined either in your layout file or imported
732 \begin_inset Newline newline
735 InsetLayout <TYPE:Name>
738 \begin_layout Description
739 Sample flex-insert CharStyle:Code
742 \begin_layout Subsection*
746 \begin_layout Description
747 Action Inserts the given string (accordingly to the correct keymap).
751 \begin_layout Description
752 Notion Automatically replace the currently selected text.
753 Depends on lyxrc settings "auto_region_delete".
757 \begin_layout Description
758 Syntax self-insert <STRING>
761 \begin_layout Subsection*
765 \begin_layout Description
766 Action Inserts one of horizontal space insets.
770 \begin_layout Description
771 Syntax space-insert <NAME> [<LEN>]
774 \begin_layout Description
775 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
776 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
777 \begin_inset Newline newline
780 <LEN>: length for custom spaces (hspace, hspace* for protected)
783 \begin_layout Description
784 Origin JSpitzm, 20 May 2003, Mar 17 2008
787 \begin_layout Subsection*
788 LFUN_HYPERLINK_INSERT
791 \begin_layout Description
792 Action Inserts hyperlinks into the document (clickable in pdf output).
796 \begin_layout Description
797 Notion Hyperlink target can be set via selection + hyperlink-insert function.
801 \begin_layout Description
802 Syntax href-insert [<TARGET>]
805 \begin_layout Description
806 Origin CFO-G, 21 Nov 1997
809 \begin_layout Subsection*
810 LFUN_SPECIALCHAR_INSERT
813 \begin_layout Description
814 Action Inserts various characters into the document.
818 \begin_layout Description
819 Syntax specialchar-insert <CHAR>
822 \begin_layout Description
823 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
824 tence, menu-separator.
828 \begin_layout Description
829 Origin JSpitzm, 6 Dec 2007
832 \begin_layout Subsection*
836 \begin_layout Description
837 Action Inserts table of contents.
841 \begin_layout Description
845 \begin_layout Description
846 Origin Lgb, 27 May 97
849 \begin_layout Subsection*
853 \begin_layout Description
854 Action Start (or remove) Appendix on the given cursor position.
858 \begin_layout Description
862 \begin_layout Description
863 Origin ettrich, 5 May 1998
866 \begin_layout Subsection*
870 \begin_layout Description
871 Action Inserts Index entry.
875 \begin_layout Description
876 Notion It automatically takes the word on the cursor position.
880 \begin_layout Description
884 \begin_layout Description
885 Origin leeming, 3 Aug 2000
888 \begin_layout Subsection*
892 \begin_layout Description
893 Action Inserts list of Index entries on a new page.
897 \begin_layout Description
901 \begin_layout Description
902 Origin Lgb, 27 Feb 1997
905 \begin_layout Subsection*
909 \begin_layout Description
910 Action Inserts Nomenclature entry.
914 \begin_layout Description
915 Notion It automatically takes the word on the cursor position if no symbol
920 \begin_layout Description
921 Syntax nomencl-insert [<SYMBOL>]
924 \begin_layout Description
925 Origin Ugras, 4 Nov 2006
928 \begin_layout Subsection*
929 LFUN_NOMENCLATURE_PRINT
932 \begin_layout Description
933 Action Inserts list of Nomenclature entries.
937 \begin_layout Description
938 Syntax nomenclature-print
941 \begin_layout Description
942 Origin Ugras, 4 Nov 2006
945 \begin_layout Subsection*
949 \begin_layout Description
950 Action Inserts Note on the current cursor postion, move selection inside
955 \begin_layout Description
956 Syntax note-insert [<TYPE>]
959 \begin_layout Description
960 Params <TYPE>: <Note|Greyedout|Comment> default: Note
963 \begin_layout Subsection*
967 \begin_layout Description
968 Action Moves the cursor to the begining of next Note inset.
972 \begin_layout Description
976 \begin_layout Subsection*
980 \begin_layout Description
981 Action Changes all Note insets of a particular type (source) to a different
982 type (target) fot the current document.
986 \begin_layout Description
987 Syntax notes-mutate <SOURCE> <TARGET>
990 \begin_layout Description
991 Params <SOURCE/TARGET>: Note|Comment|Greyedout
994 \begin_layout Description
995 Origin sanda, 18 Jun 2008
998 \begin_layout Subsection*
1002 \begin_layout Description
1003 Action Inserts a line break or new line.
1007 \begin_layout Description
1008 Syntax newline-insert [<ARG>]
1011 \begin_layout Description
1012 Params <ARG>: <newline|linebreak> default: newline
1015 \begin_layout Description
1016 Origin JSpitzm, 25 Mar 2008
1019 \begin_layout Subsection*
1023 \begin_layout Description
1024 Action Clears the selection.
1025 If no text is selected call LFUN_FINISHED_FORWARD.
1029 \begin_layout Description
1033 \begin_layout Description
1034 Origin Lgb, 17 May 2001
1037 \begin_layout Subsection*
1041 \begin_layout Description
1042 Action Moves the cursor one line in downward direction.
1046 \begin_layout Description
1050 \begin_layout Subsection*
1054 \begin_layout Description
1055 Action Moves the cursor one line in upward direction.
1059 \begin_layout Description
1063 \begin_layout Subsection*
1067 \begin_layout Description
1068 Action Moves the cursor one line in downward direction adding the current
1069 position to the selection.
1073 \begin_layout Description
1077 \begin_layout Subsection*
1081 \begin_layout Description
1082 Action Moves the cursor one line in upward direction adding the current
1083 position to the selection.
1087 \begin_layout Description
1091 \begin_layout Subsection*
1095 \begin_layout Description
1096 Action Moves the cursor one page in downward direction.
1100 \begin_layout Description
1104 \begin_layout Subsection*
1108 \begin_layout Description
1109 Action Moves the cursor one page in upward direction.
1113 \begin_layout Description
1117 \begin_layout Subsection*
1118 LFUN_SCREEN_DOWN_SELECT
1121 \begin_layout Description
1122 Action Moves the cursor one screen in downward direction adding the current
1123 position to the selection.
1127 \begin_layout Description
1128 Syntax screen-down-select
1131 \begin_layout Subsection*
1132 LFUN_SCREEN_UP_SELECT
1135 \begin_layout Description
1136 Action Moves the cursor one page in upward direction adding the current
1137 position to the selection.
1141 \begin_layout Description
1142 Syntax screen-up-select
1145 \begin_layout Subsection*
1149 \begin_layout Description
1150 Action Scroll the buffer view.
1154 \begin_layout Description
1155 Notion Only scrolls the screen up or down; does not move the cursor.
1159 \begin_layout Description
1160 Syntax scroll <TYPE> <QUANTITY>
1163 \begin_layout Description
1164 Params <TYPE>: line|page
1165 \begin_inset Newline newline
1168 <QUANTITY>: up|down|<number>
1171 \begin_layout Description
1172 Origin Abdel, Dec 27 2007
1175 \begin_layout Subsection*
1176 LFUN_SCREEN_RECENTER
1179 \begin_layout Description
1180 Action Recenters the screen on the current cursor position.
1184 \begin_layout Description
1185 Syntax screen-recenter
1188 \begin_layout Subsection*
1192 \begin_layout Description
1193 Action Moves the cursor one position logically backwards.
1197 \begin_layout Description
1198 Notion This is not the action which should be bound to the arrow keys, because
1199 backwards may be left or right, depending on the language.
1200 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1201 which in turn may employ this one.
1205 \begin_layout Description
1206 Syntax char-backward
1209 \begin_layout Subsection*
1210 LFUN_CHAR_BACKWARD_SELECT
1213 \begin_layout Description
1214 Action Moves the cursor one position logically backwards, adding traversed
1215 position to the selection.
1219 \begin_layout Description
1220 Notion See also LFUN_CHAR_BACKWARD.
1224 \begin_layout Description
1225 Syntax char-backward-select
1228 \begin_layout Subsection*
1229 LFUN_CHAR_DELETE_BACKWARD
1232 \begin_layout Description
1233 Action Deletes one character in the backward direction (usually the "BackSpace"
1238 \begin_layout Description
1239 Syntax char-delete-backward
1242 \begin_layout Subsection*
1243 LFUN_CHAR_DELETE_FORWARD
1246 \begin_layout Description
1247 Action Deletes one character in the backward direction (usually the "Delete"
1252 \begin_layout Description
1253 Syntax char-delete-forward
1256 \begin_layout Subsection*
1260 \begin_layout Description
1261 Action Moves the cursor one position logically forward.
1265 \begin_layout Description
1266 Notion This is not the action which should be bound to the arrow keys, because
1267 forward may be left or right, depending on the language.
1268 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1269 which in turn may employ this one.
1273 \begin_layout Description
1277 \begin_layout Subsection*
1278 LFUN_CHAR_FORWARD_SELECT
1281 \begin_layout Description
1282 Action Moves the cursor one position logically forward, adding traversed
1283 position to the selection.
1287 \begin_layout Description
1288 Notion See also LFUN_CHAR_FORWARD.
1292 \begin_layout Description
1293 Syntax char-forward-select
1296 \begin_layout Subsection*
1300 \begin_layout Description
1301 Action Moves the cursor one position "to the left".
1305 \begin_layout Description
1306 Notion This is the action which should be taken when the "left" key is pressed.
1307 Generally, it moves the cursor one position to the left.
1308 However, in Bidi text this become slightly more complicated, and there
1309 are different modes of cursor movement.
1310 In "visual mode", this moves left, plain and simple.
1311 In "logical mode", movement is logically forward in RTL paragraphs, and
1312 logically backwards in LTR paragraphs.
1316 \begin_layout Description
1320 \begin_layout Subsection*
1321 LFUN_CHAR_LEFT_SELECT
1324 \begin_layout Description
1325 Action Moves the cursor one position "to the left", adding traversed position
1330 \begin_layout Description
1331 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1335 \begin_layout Description
1336 Syntax char-left-select
1339 \begin_layout Subsection*
1343 \begin_layout Description
1344 Action Moves the cursor one position "to the right".
1348 \begin_layout Description
1349 Notion This is the action which should be taken when the "right" key is
1351 Generally, it moves the cursor one position to the right.
1352 However, in Bidi text this become slightly more complicated, and there
1353 are different modes of cursor movement.
1354 In "visual mode", this moves right, plain and simple.
1355 In "logical mode", movement is logically forward in LTR paragraphs, and
1356 logically backwards in RTL paragraphs.
1360 \begin_layout Description
1364 \begin_layout Subsection*
1365 LFUN_CHAR_RIGHT_SELECT
1368 \begin_layout Description
1369 Action Moves the cursor one position "to the right", adding traversed position
1374 \begin_layout Description
1375 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1379 \begin_layout Description
1380 Syntax char-right-select
1383 \begin_layout Subsection*
1387 \begin_layout Description
1388 Action Moves the cursor to the logically previous beginning of a word.
1392 \begin_layout Description
1393 Notion This is not the action which should be bound to the arrow keys, because
1394 backwards may be left or right, depending on the language.
1395 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1396 which in turn may employ this one.
1400 \begin_layout Description
1401 Syntax word-backward
1404 \begin_layout Subsection*
1405 LFUN_WORD_BACKWARD_SELECT
1408 \begin_layout Description
1409 Action Moves the cursor to the logically previous beginning of a word, adding
1410 the logically traversed text to the selection.
1414 \begin_layout Description
1415 Notion See also LFUN_WORD_BACKWARD.
1419 \begin_layout Description
1420 Syntax word-backward-select
1423 \begin_layout Subsection*
1424 LFUN_WORD_DELETE_BACKWARD
1427 \begin_layout Description
1428 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1433 \begin_layout Description
1434 Syntax word-delete-backward
1437 \begin_layout Subsection*
1438 LFUN_WORD_DELETE_FORWARD
1441 \begin_layout Description
1442 Action Deletes characters to the end of the word (usually the "C+Delete"
1447 \begin_layout Description
1448 Syntax word-delete-forward
1451 \begin_layout Subsection*
1452 LFUN_WORD_FIND_FORWARD
1455 \begin_layout Description
1456 Action Search for a given string in forward direction.
1460 \begin_layout Description
1461 Notion Case sensitive, match words.
1462 If no argument given, last search repeated.
1466 \begin_layout Description
1467 Syntax word-find-forward [<STRING>]
1470 \begin_layout Description
1471 Origin Etienne, 16 Feb 1998
1474 \begin_layout Subsection*
1475 LFUN_WORD_FIND_BACKWARD
1478 \begin_layout Description
1479 Action Search for a given string in backward direction.
1483 \begin_layout Description
1484 Notion Case sensitive, match words.
1485 If no argument given, last search repeated.
1489 \begin_layout Description
1490 Syntax word-find-backward [<STRING>]
1493 \begin_layout Description
1494 Origin Etienne, 20 Feb 1998
1497 \begin_layout Subsection*
1501 \begin_layout Description
1502 Action Search for next occurence of a string.
1506 \begin_layout Description
1507 Syntax word-find [<DATA>]
1510 \begin_layout Description
1511 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1512 If no parameter is given, search with last find-dialog data is used for
1518 \begin_layout Description
1519 Origin Andre, Jan 7 2004
1522 \begin_layout Subsection*
1526 \begin_layout Description
1527 Action Replace a string in the document.
1531 \begin_layout Description
1532 Syntax word-replace [<DATA>]
1535 \begin_layout Description
1536 Params <DATA>: data is of the form "<search>
1537 \begin_inset Newline newline
1541 \begin_inset Newline newline
1544 <casesensitive> <matchword> <all> <forward>"
1547 \begin_layout Description
1548 Origin Andre, Jan 7 2004
1551 \begin_layout Subsection*
1555 \begin_layout Description
1556 Action Moves the cursor to the logically next beginning of a word.
1560 \begin_layout Description
1561 Notion This is not the action which should be bound to the arrow keys, because
1562 forward may be left or right, depending on the language.
1563 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1564 which in turn may employ this one.
1568 \begin_layout Description
1572 \begin_layout Subsection*
1573 LFUN_WORD_FORWARD_SELECT
1576 \begin_layout Description
1577 Action Moves the cursor to the logically next beginning of a word, adding
1578 the logically traversed text to the selection.
1582 \begin_layout Description
1583 Notion See also LFUN_WORD_FORWARD.
1587 \begin_layout Description
1588 Syntax word-forward-select
1591 \begin_layout Subsection*
1595 \begin_layout Description
1596 Action Moves the cursor to the next beginning of a word "on the left".
1600 \begin_layout Description
1601 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1603 Generally, it moves the cursor to the next beginning of a word on the left.
1604 However, in Bidi text this become slightly more complicated, and there
1605 are different modes of cursor movement.
1606 In "visual mode", this moves left, plain and simple.
1607 In "logical mode", movement is logically forward in RTL paragraphs, and
1608 logically backwards in LTR paragraphs.
1612 \begin_layout Description
1616 \begin_layout Description
1617 Origin dov, 28 Oct 2007
1620 \begin_layout Subsection*
1621 LFUN_WORD_LEFT_SELECT
1624 \begin_layout Description
1625 Action Moves the cursor to the next beginning of a word "on the left", adding
1626 *logically* traversed text to the selection.
1630 \begin_layout Description
1631 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1635 \begin_layout Description
1636 Syntax word-left-select
1639 \begin_layout Description
1640 Origin dov, 28 Oct 2007
1643 \begin_layout Subsection*
1647 \begin_layout Description
1648 Action Moves the cursor to the next beginning of a word "on the right".
1652 \begin_layout Description
1653 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1655 Generally, it moves the cursor to the next beginning of a word on the right.
1656 However, in Bidi text this become slightly more complicated, and there
1657 are different modes of cursor movement.
1658 In "visual mode", this moves right, plain and simple.
1659 In "logical mode", movement is logically forward in LTR paragraphs, and
1660 logically backwards in RTL paragraphs.
1664 \begin_layout Description
1668 \begin_layout Description
1669 Origin dov, 28 Oct 2007
1672 \begin_layout Subsection*
1673 LFUN_WORD_RIGHT_SELECT
1676 \begin_layout Description
1677 Action Moves the cursor to the next beginning of a word "on the right",
1678 adding *logically* traversed text to the selection.
1682 \begin_layout Description
1683 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1687 \begin_layout Description
1688 Syntax word-right-select
1691 \begin_layout Description
1692 Origin dov, 28 Oct 2007
1695 \begin_layout Subsection*
1699 \begin_layout Description
1700 Action Puts the word where the cursor stands into the selection.
1704 \begin_layout Description
1708 \begin_layout Description
1709 Origin Andre, 11 Sep 2002
1712 \begin_layout Subsection*
1713 LFUN_WORD_CAPITALIZE
1716 \begin_layout Description
1717 Action Capitalizes the words in the selection (i.e.
1718 the first letters) or the letter on the cursor position.
1722 \begin_layout Description
1723 Syntax word-capitalize
1726 \begin_layout Subsection*
1730 \begin_layout Description
1731 Action Change the words in the selection or from the cursor position to
1732 the end of word to the upper case.
1736 \begin_layout Description
1740 \begin_layout Subsection*
1744 \begin_layout Description
1745 Action Change the words in the selection or from the cursor position to
1746 the end of word to the lower case.
1750 \begin_layout Description
1754 \begin_layout Subsection*
1755 LFUN_THESAURUS_ENTRY
1758 \begin_layout Description
1759 Action Look up thesaurus entries with respect to the word under the cursor.
1763 \begin_layout Description
1764 Syntax thesaurus-entry
1767 \begin_layout Description
1768 Origin Levon, 20 Jul 2001
1771 \begin_layout Subsection*
1775 \begin_layout Description
1776 Action Move the cursor to the beginning of the document.
1780 \begin_layout Description
1784 \begin_layout Subsection*
1785 LFUN_BUFFER_BEGIN_SELECT
1788 \begin_layout Description
1789 Action Move the cursor to the beginning of the document adding the traversed
1790 text to the selection.
1794 \begin_layout Description
1795 Syntax buffer-begin-select
1798 \begin_layout Subsection*
1802 \begin_layout Description
1803 Action Move the cursor to the end of the document.
1807 \begin_layout Description
1811 \begin_layout Subsection*
1812 LFUN_BUFFER_END_SELECT
1815 \begin_layout Description
1816 Action Move the cursor to the end of the document adding the traversed text
1821 \begin_layout Description
1822 Syntax buffer-end-select
1825 \begin_layout Subsection*
1829 \begin_layout Description
1830 Action Move the cursor to the begining of the (screen) line.
1834 \begin_layout Description
1838 \begin_layout Subsection*
1839 LFUN_LINE_BEGIN_SELECT
1842 \begin_layout Description
1843 Action Move the cursor to the beginning of the (screen) line adding the
1844 traversed text to the selection.
1848 \begin_layout Description
1849 Syntax line-begin-select
1852 \begin_layout Subsection*
1856 \begin_layout Description
1857 Action Move the cursor to the end of the (screen) line.
1861 \begin_layout Description
1865 \begin_layout Subsection*
1866 LFUN_LINE_END_SELECT
1869 \begin_layout Description
1870 Action Move the cursor to the end of the (screen) line adding the traversed
1871 text to the selection.
1875 \begin_layout Description
1876 Syntax line-end-select
1879 \begin_layout Subsection*
1883 \begin_layout Description
1884 Action Deletes the letters to the end of the (screen) line or deletes the
1889 \begin_layout Description
1890 Syntax line-delete-forward
1893 \begin_layout Subsection*
1897 \begin_layout Description
1898 Action Copies to the clipboard the last edit.
1902 \begin_layout Description
1906 \begin_layout Subsection*
1910 \begin_layout Description
1911 Action Cuts to the clipboard.
1915 \begin_layout Description
1919 \begin_layout Subsection*
1923 \begin_layout Description
1924 Action Pastes material from the active clipboard.
1928 \begin_layout Description
1929 Syntax paste [<TYPE>]
1932 \begin_layout Description
1933 Params <TYPE>: pdf|png|jpeg|linkback
1936 \begin_layout Subsection*
1937 LFUN_CLIPBOARD_PASTE
1940 \begin_layout Description
1941 Action Pastes text from the active clipboard.
1945 \begin_layout Description
1946 Syntax clipboard-paste [<ARG>]
1949 \begin_layout Description
1950 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1955 \begin_layout Description
1956 Origin baum, 10 Jul 2006
1959 \begin_layout Subsection*
1960 LFUN_PRIMARY_SELECTION_PASTE
1963 \begin_layout Description
1964 Action Pastes the currently text selected text.
1968 \begin_layout Description
1969 Notion Primary selection mechanism is linux-only thing.
1973 \begin_layout Description
1974 Syntax primary-selection-paste [<ARG>]
1977 \begin_layout Description
1978 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1983 \begin_layout Subsection*
1987 \begin_layout Description
1988 Action Undoes the last edit.
1992 \begin_layout Description
1996 \begin_layout Subsection*
2000 \begin_layout Description
2001 Action Redoes the last thing undone.
2005 \begin_layout Description
2009 \begin_layout Subsection*
2013 \begin_layout Description
2014 Action Repeat the given command.
2018 \begin_layout Description
2019 Syntax repeat <COUNT> <LFUN-COMMAND>
2022 \begin_layout Description
2023 Origin Andre, , 27 Oct 2003
2026 \begin_layout Subsection*
2027 LFUN_CHARS_TRANSPOSE
2030 \begin_layout Description
2031 Action Transposes the character at the cursor with the one before it.
2035 \begin_layout Description
2036 Syntax chars-transpose
2039 \begin_layout Description
2040 Origin Lgb, 25 Apr 2001
2043 \begin_layout Subsection*
2044 LFUN_DEPTH_DECREMENT
2047 \begin_layout Description
2048 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2053 \begin_layout Description
2054 Syntax depth-decrement
2057 \begin_layout Subsection*
2058 LFUN_DEPTH_INCREMENT
2061 \begin_layout Description
2062 Action Increase the nesting depth of the (selected) paragraph(s) inside
2067 \begin_layout Description
2068 Syntax depth-increment
2071 \begin_layout Subsection*
2075 \begin_layout Description
2076 Action Toggles the bold font (selection-wise).
2080 \begin_layout Description
2084 \begin_layout Subsection*
2085 LFUN_FONT_TYPEWRITER
2088 \begin_layout Description
2089 Action Toggles the typewriter family font (selection-wise).
2093 \begin_layout Description
2094 Syntax font-typewriter
2097 \begin_layout Subsection*
2101 \begin_layout Description
2102 Action Toggles underline in the font (selection-wise).
2106 \begin_layout Description
2107 Syntax font-underline
2110 \begin_layout Subsection*
2114 \begin_layout Description
2115 Action Toggles the emphasis font style (selection-wise).
2119 \begin_layout Description
2123 \begin_layout Subsection*
2127 \begin_layout Description
2128 Action Toggles Noun text style font (selection-wise).
2132 \begin_layout Description
2136 \begin_layout Subsection*
2140 \begin_layout Description
2141 Action Toggles Roman family font (selection-wise).
2145 \begin_layout Description
2149 \begin_layout Subsection*
2153 \begin_layout Description
2154 Action Toggles Sans Serif family font (selection-wise).
2158 \begin_layout Description
2162 \begin_layout Subsection*
2166 \begin_layout Description
2167 Action Toggles Fraktur family font (math-mode, selection-wise).
2171 \begin_layout Description
2175 \begin_layout Description
2176 Origin vermeer, 10 Jan 2002
2179 \begin_layout Subsection*
2183 \begin_layout Description
2184 Action Toggles Italics font shape (math-mode, selection-wise).
2188 \begin_layout Description
2192 \begin_layout Description
2193 Origin vermeer, 10 Jan 2002
2196 \begin_layout Subsection*
2200 \begin_layout Description
2201 Action Reverts the settings of the font to the default values (selection-wise).
2205 \begin_layout Description
2209 \begin_layout Subsection*
2213 \begin_layout Description
2214 Action Sets font size according to lyx format string.
2218 \begin_layout Description
2219 Syntax font-size <SIZE>
2222 \begin_layout Description
2223 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2224 \begin_inset Newline newline
2227 largest|huge|giant|increase|decrease|default
2230 \begin_layout Subsection*
2231 LFUN_TEXTSTYLE_APPLY
2234 \begin_layout Description
2235 Action Toggle user-defined (=last-time used) text style.
2239 \begin_layout Description
2240 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2241 trigerred when using Text Style dialog.
2245 \begin_layout Description
2246 Syntax textstyle-apply
2249 \begin_layout Description
2250 Origin leeming, 12 Mar 2003
2253 \begin_layout Subsection*
2254 LFUN_TEXTSTYLE_UPDATE
2257 \begin_layout Description
2258 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2263 \begin_layout Description
2264 Syntax textstyle-update <FONT_INFO>
2267 \begin_layout Description
2268 Params <FONT_INFO>: specifies font atributes, e.g.
2269 family, series, shape, size, emph, noun, underbar, number, color, language,
2272 \begin_inset Newline newline
2275 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2279 \begin_layout Description
2280 Origin leeming, 12 Mar 2003
2283 \begin_layout Subsection*
2284 LFUN_SCREEN_FONT_UPDATE
2287 \begin_layout Description
2288 Action Update fonts and its metrics.
2292 \begin_layout Description
2293 Notion Automatically called after zoom, dpi, font names, or norm change.
2297 \begin_layout Description
2298 Syntax screen-font-update
2301 \begin_layout Description
2302 Origin ARRae, 13 Aug 2000
2305 \begin_layout Subsection*
2309 \begin_layout Description
2310 Action Returns the info about the current font.
2314 \begin_layout Description
2318 \begin_layout Subsection*
2319 LFUN_CITATION_INSERT
2322 \begin_layout Description
2323 Action Inserts citation from loaded citation database.
2327 \begin_layout Description
2328 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2331 \begin_layout Description
2332 Params <KEY>: Citation (shortcut listed in available citations).
2334 \begin_inset Newline newline
2337 <TEXT_BEFORE>: text which should appear before citation.
2341 \begin_layout Description
2342 Origin AAS, 97-02-23
2345 \begin_layout Subsection*
2346 LFUN_BIBTEX_DATABASE_ADD
2349 \begin_layout Description
2350 Action Adds database, which will be used for bibtex citations.
2354 \begin_layout Description
2355 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2356 bibliography) found from the cursor postion.
2360 \begin_layout Description
2361 Syntax bibtex-database-add <DATABASE-NAME>
2364 \begin_layout Description
2365 Origin Ale, 30 May 1997
2368 \begin_layout Subsection*
2369 LFUN_BIBTEX_DATABASE_DEL
2372 \begin_layout Description
2373 Action Adds database, which will be used for bibtex citations.
2377 \begin_layout Description
2378 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2379 X bibliography) found from the cursor postion.
2383 \begin_layout Description
2384 Syntax bibtex-database-del <DATABASE-NAME>
2387 \begin_layout Description
2388 Origin Ale, 30 May 1997
2391 \begin_layout Subsection*
2395 \begin_layout Description
2396 Action Sets the layout (that is, environment) for the current paragraph.
2400 \begin_layout Description
2401 Syntax layout <LAYOUT>
2404 \begin_layout Description
2405 Params <LAYOUT>: the layout to use
2408 \begin_layout Subsection*
2409 LFUN_LAYOUT_PARAGRAPH
2412 \begin_layout Description
2413 Action Launches the paragraph settings dialog.
2417 \begin_layout Description
2418 Syntax layout-paragraph
2421 \begin_layout Subsection*
2425 \begin_layout Description
2426 Action Launches the tabular settings dialog.
2430 \begin_layout Description
2431 Syntax layout-tabular
2434 \begin_layout Description
2435 Origin Jug, 31 Jul 2000
2438 \begin_layout Subsection*
2439 LFUN_DROP_LAYOUTS_CHOICE
2442 \begin_layout Description
2443 Action Displays list of layout choices.
2447 \begin_layout Description
2448 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2449 allowing for choice of layout.
2453 \begin_layout Description
2454 Syntax drop-layouts-choice
2457 \begin_layout Subsection*
2458 LFUN_LAYOUT_MODULES_CLEAR
2461 \begin_layout Description
2462 Action Clears the module list.
2466 \begin_layout Description
2467 Notion Clears the list of included modules for the current buffer.
2471 \begin_layout Description
2472 Syntax layout-modules-clear
2475 \begin_layout Description
2476 Origin rgh, 25 August 2007
2479 \begin_layout Subsection*
2480 LFUN_LAYOUT_MODULE_ADD
2483 \begin_layout Description
2484 Action Adds a module.
2488 \begin_layout Description
2489 Notion Adds a module to the list of included modules for the current buffer.
2493 \begin_layout Description
2494 Syntax layout-module-add <MODULE>
2497 \begin_layout Description
2498 Params <MODULE>: the module to be added
2501 \begin_layout Description
2502 Origin rgh, 25 August 2007
2505 \begin_layout Subsection*
2509 \begin_layout Description
2510 Action Reloads layout information.
2514 \begin_layout Description
2515 Notion Reloads all layout information for the current buffer from disk,
2516 thus recognizing any changes that have been made to layout files on the
2518 This is intended to be used only by layout developers and should not be
2519 used when one is trying to do actual work.
2523 \begin_layout Description
2524 Syntax layout-reload
2527 \begin_layout Description
2528 Origin rgh, 3 September 2007
2531 \begin_layout Subsection*
2532 LFUN_TEXTCLASS_APPLY
2535 \begin_layout Description
2536 Action Sets the text class for the current buffer.
2540 \begin_layout Description
2541 Syntax textclass-apply <TEXTCLASS>
2544 \begin_layout Description
2545 Params <TEXTCLASS>: the textclass to set.
2546 Note that this must be the filename, minus the ".layout" extension.
2550 \begin_layout Subsection*
2554 \begin_layout Description
2555 Action Loads information for a textclass from disk.
2559 \begin_layout Description
2560 Syntax textclass-load <TEXTCLASS>
2563 \begin_layout Description
2564 Params <TEXTCLASS>: the textclass to load.
2565 Note that this must be the filename, minus the ".layout" extension.
2569 \begin_layout Subsection*
2573 \begin_layout Description
2574 Action Disable selecting of text-region.
2578 \begin_layout Description
2582 \begin_layout Subsection*
2586 \begin_layout Description
2587 Action Enable selecting of text-region.
2591 \begin_layout Description
2592 Notion After enabling you can simply move arrow keys to get selected region.
2596 \begin_layout Description
2600 \begin_layout Subsection*
2604 \begin_layout Description
2605 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2609 \begin_layout Description
2613 \begin_layout Description
2614 Origin Andre, May 5 2006
2617 \begin_layout Subsection*
2621 \begin_layout Description
2622 Action Inserts math delimiters (e.g.
2623 parentheses, brackets) enclosing expression.
2627 \begin_layout Description
2628 Syntax math-delim [<LEFT>] [<RIGHT>]
2631 \begin_layout Description
2632 Params <LEFT/RIGHT>: Delimiters to be used.
2633 Each delimiter can be specified by either a LaTeX name or a valid character.
2634 ( is the default letter.
2638 \begin_layout Description
2639 Sample math-delim { rangle
2642 \begin_layout Description
2643 Origin Alejandro, 18 Jun 1996
2646 \begin_layout Subsection*
2650 \begin_layout Description
2651 Action Inserts math fixed size delimiters (e.g.
2652 parentheses, brackets) enclosing expression.
2656 \begin_layout Description
2657 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2660 \begin_layout Description
2661 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2662 \begin_inset Newline newline
2665 <L/RDELIM>: TeX code for delimiter.
2666 See Delimiter dialog for delimiters to be used.
2670 \begin_layout Description
2671 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2674 \begin_layout Description
2675 Origin Enrico & Georg, 7 May 2006
2678 \begin_layout Subsection*
2682 \begin_layout Description
2683 Action Creates a new displayed equation in text mode.
2684 Toggles inlined/display formula in math mode.
2688 \begin_layout Description
2689 Syntax math-display [<ARG>]
2692 \begin_layout Description
2693 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2694 new equation from the text mode.
2698 \begin_layout Description
2699 Origin Alejandro, 18 Jun 1996
2702 \begin_layout Subsection*
2706 \begin_layout Description
2707 Action Inserts math objects and symbols.
2711 \begin_layout Description
2712 Syntax math-insert <ARG>
2715 \begin_layout Description
2716 Params <ARG>: Symbol or LaTeX code to be inserted.
2720 \begin_layout Subsection*
2724 \begin_layout Description
2725 Action Enters subscript expression in math expression.
2729 \begin_layout Description
2730 Syntax math-subscript
2733 \begin_layout Description
2734 Origin vermeer, 12 Dec 2001
2737 \begin_layout Subsection*
2738 LFUN_MATH_SUPERSCRIPT
2741 \begin_layout Description
2742 Action Enters subscript expression in math expression.
2746 \begin_layout Description
2747 Syntax math-superscript
2750 \begin_layout Description
2751 Origin vermeer, 12 Dec 2001
2754 \begin_layout Subsection*
2758 \begin_layout Description
2759 Action Toggles the position of the limits from above/below to the right
2760 side an vice versa in integral symbol, a limit, a summation, etc.
2764 \begin_layout Description
2765 Notion Put the cursor before the symbol with the limits and then invoke
2770 \begin_layout Description
2771 Syntax math-limits [<STATE>]
2774 \begin_layout Description
2775 Params <STATE>: limits|nolimits
2778 \begin_layout Subsection*
2782 \begin_layout Description
2783 Action Inserts a math macro definition at the cursor position in the text.
2787 \begin_layout Description
2788 Syntax math-macro <NAME> [<NARGS>] [def]
2791 \begin_layout Description
2792 Params <NAME>: The name of the macro, e.g.
2794 <NARGS>: The number of parameters of the macro.
2796 "def": Has no effect anymore, just for compatibility with former LyX versions.
2800 \begin_layout Description
2801 Origin ale, 10 May 1997; sts, 21 Dec 2007
2804 \begin_layout Subsection*
2808 \begin_layout Description
2809 Action Mutates the type of math inset to the newly selected one.
2813 \begin_layout Description
2814 Syntax math-mutate <TYPE>
2817 \begin_layout Description
2818 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2819 multline|gather|flalign
2822 \begin_layout Description
2823 Origin Andre, 23 May 2001
2826 \begin_layout Subsection*
2830 \begin_layout Description
2831 Action Inserts space into math expression.
2835 \begin_layout Description
2836 Notion Use spacebar after entering this space to change type of space.
2840 \begin_layout Description
2841 Syntax math-space [<TYPE>]
2844 \begin_layout Description
2845 Params <TYPE>: negative spaces: !|negmedspace|negthickspace
2846 \begin_inset Newline newline
2849 positive spaces: ,|:|;|quad|qquad
2850 \begin_inset Newline newline
2853 "," used by default.
2857 \begin_layout Description
2858 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2861 \begin_layout Subsection*
2865 \begin_layout Description
2866 Action Inserts a matrix.
2870 \begin_layout Description
2871 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2874 \begin_layout Description
2875 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
2877 1 char) and the horizontal alignments (l, c or r) (i.e.
2882 \begin_layout Description
2883 Sample math-matrix 3 3 bccc
2886 \begin_layout Subsection*
2890 \begin_layout Description
2891 Action In text mode enters math mode (i.e.
2892 puts math insets on the current cursor position), in math mode enters text
2893 mode inside math expression.
2897 \begin_layout Description
2898 Notion If there is some selected text, it puts the text inside created math
2903 \begin_layout Description
2904 Syntax math-mode [<ARG>]
2907 \begin_layout Description
2908 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
2913 \begin_layout Description
2914 Origin Alejandro, 4 Jun 1996
2917 \begin_layout Subsection*
2918 LFUN_MATH_NUMBER_LINE_TOGGLE
2921 \begin_layout Description
2922 Action Toggles numbering of the current formula line.
2926 \begin_layout Description
2927 Notion Must be in display formula mode.
2931 \begin_layout Description
2932 Syntax math-number-line-toggle
2935 \begin_layout Description
2936 Origin Alejandro, 18 Jun 1996
2939 \begin_layout Subsection*
2940 LFUN_MATH_NUMBER_TOGGLE
2943 \begin_layout Description
2944 Action Toggles numbering/labeling of the current formula.
2948 \begin_layout Description
2949 Notion Must be in display formula mode.
2953 \begin_layout Description
2954 Syntax math-number-toggle
2957 \begin_layout Description
2958 Origin Alejandro, 4 Jun 1996
2961 \begin_layout Subsection*
2965 \begin_layout Description
2966 Action Calls external program and passes the current expression/equation
2967 as an argument for the calculation in the format appropriate to the given
2972 \begin_layout Description
2973 Notion Selection can be used to determine the input for the external program.
2977 \begin_layout Description
2978 Syntax math-extern <LANG> [<COMMAND>]
2981 \begin_layout Description
2982 Params <LANG>: octave|maxima|maple|mathematica|script
2983 \begin_inset Newline newline
2986 where "script" stands fot the external script (normalized expression will
2990 \begin_layout Description
2991 Origin Andre, 24 Apr 2001
2994 \begin_layout Description
2995 Sample math-extern maple simplify
2998 \begin_layout Subsection*
3002 \begin_layout Description
3003 Action Changes arbitrarily the size used by math fonts inside a context.
3007 \begin_layout Description
3008 Notion Provides an interface to the LaTeX math mode font size commands.
3012 \begin_layout Description
3013 Syntax math-size <STYLE>
3016 \begin_layout Description
3017 Params <STYLE>: displaystyle|
3026 \begin_layout Description
3027 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3030 \begin_layout Subsection*
3031 LFUN_MATH_MACRO_UNFOLD
3034 \begin_layout Description
3035 Action Unfold a Math Macro.
3039 \begin_layout Description
3040 Notion Unfold the Math Macro the cursor is in, i.e.
3045 \begin_layout Description
3046 Syntax math-macro-unfold
3049 \begin_layout Description
3050 Origin sts, 06 January 2008
3053 \begin_layout Subsection*
3054 LFUN_MATH_MACRO_FOLD
3057 \begin_layout Description
3058 Action Fold a Math Macro.
3062 \begin_layout Description
3063 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3064 displayed as foo before.
3068 \begin_layout Description
3069 Syntax math-macro-fold
3072 \begin_layout Description
3073 Origin sts, 06 January 2008
3076 \begin_layout Subsection*
3077 LFUN_MATH_MACRO_ADD_PARAM
3080 \begin_layout Description
3081 Action Add a parameter.
3085 \begin_layout Description
3086 Notion Add a parameter to a Math Macro.
3090 \begin_layout Description
3091 Params <NUM>: The number of the parameter behind which the new one will
3092 be added (1 for the first, i.e.
3093 use 0 for add a parameter at the left), defaults to the last one.
3097 \begin_layout Description
3098 Syntax math-macro-add-param <NUM>
3101 \begin_layout Description
3102 Origin sts, 06 January 2008
3105 \begin_layout Subsection*
3106 LFUN_MATH_MACRO_REMOVE_PARAM
3109 \begin_layout Description
3110 Action Remove the last parameter.
3114 \begin_layout Description
3115 Notion Remove the last parameter of a Math Macro and remove its value in
3116 all instances of the macro in the buffer.
3120 \begin_layout Description
3121 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3122 defaults to the last one.
3126 \begin_layout Description
3127 Syntax math-macro-remove-param <NUM>
3130 \begin_layout Description
3131 Origin sts, 06 January 2008
3134 \begin_layout Subsection*
3135 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3138 \begin_layout Description
3139 Action Append a greedy parameter.
3143 \begin_layout Description
3144 Notion Append a greedy parameter to a Math Macro which eats the following
3145 mathed cell in every instance of the macro in the buffer.
3149 \begin_layout Description
3150 Syntax math-macro-append-greedy-param
3153 \begin_layout Description
3154 Origin sts, 06 January 2008
3157 \begin_layout Subsection*
3158 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3161 \begin_layout Description
3162 Action Remove a greedy parameter.
3166 \begin_layout Description
3167 Notion Remove a greedy parameter of a Math Macro and spit out the values
3168 of it in every instance of the macro in the buffer.
3169 If it is an optional parameter the [valud] format is used.
3173 \begin_layout Description
3174 Syntax math-macro-remove-greedy-param
3177 \begin_layout Description
3178 Origin sts, 06 January 2008
3181 \begin_layout Subsection*
3182 LFUN_MATH_MACRO_MAKE_OPTIONAL
3185 \begin_layout Description
3186 Action Make a parameter optional.
3190 \begin_layout Description
3191 Notion Turn the first non-optional parameter of a Math Macro into an optional
3192 parameter with a default value.
3196 \begin_layout Description
3197 Syntax math-macro-make-optional
3200 \begin_layout Description
3201 Origin sts, 06 January 2008
3204 \begin_layout Subsection*
3205 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3208 \begin_layout Description
3209 Action Make a parameter non-optional.
3213 \begin_layout Description
3214 Notion Turn the last optional parameter of a Math Macro into a non-optional
3216 The default value is remembered to be reused later if the user changes
3221 \begin_layout Description
3222 Syntax math-macro-make-nonoptional
3225 \begin_layout Description
3226 Origin sts, 06 January 2008
3229 \begin_layout Subsection*
3230 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3233 \begin_layout Description
3234 Action Add an optional parameter.
3238 \begin_layout Description
3239 Notion Insert an optional parameter just behind the already existing optional
3244 \begin_layout Description
3245 Syntax math-macro-add-optional-param
3248 \begin_layout Description
3249 Origin sts, 06 January 2008
3252 \begin_layout Subsection*
3253 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3256 \begin_layout Description
3257 Action Remove the last optional parameter.
3261 \begin_layout Description
3262 Notion Remove the last optional parameter of a Math Macro and remove it
3263 in all the instances of the macro in the buffer.
3267 \begin_layout Description
3268 Syntax math-macro-remove-optional-param
3271 \begin_layout Description
3272 Origin sts, 06 January 2008
3275 \begin_layout Subsection*
3276 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3279 \begin_layout Description
3280 Action Add a greedy optional parameter.
3284 \begin_layout Description
3285 Notion Add a greedy optional parameter which eats the value from the following
3286 cells in mathed which are in the [value] format.
3290 \begin_layout Description
3291 Syntax math-macro-add-greedy-optional-param
3294 \begin_layout Description
3295 Origin sts, 06 January 2008
3298 \begin_layout Subsection*
3299 LFUN_IN_MATHMACROTEMPLATE
3302 \begin_layout Description
3303 Action Only active in Math Macro definition.
3307 \begin_layout Description
3308 Notion Dummy function which is only active in a Math Macro definition.
3309 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3314 \begin_layout Description
3315 Syntax in-mathmacrotemplate
3318 \begin_layout Description
3319 Origin sts, 06 January 2008
3322 \begin_layout Subsection*
3323 LFUN_PARAGRAPH_MOVE_DOWN
3326 \begin_layout Description
3327 Action Moves the current paragraph downwards in the document.
3331 \begin_layout Description
3332 Syntax paragraph-move-down
3335 \begin_layout Description
3336 Origin Edwin, 8 Apr 2006
3339 \begin_layout Subsection*
3340 LFUN_PARAGRAPH_MOVE_UP
3343 \begin_layout Description
3344 Action Moves the current paragraph upwards in the document.
3348 \begin_layout Description
3349 Syntax paragraph-move-up
3352 \begin_layout Description
3353 Origin Edwin, 8 Apr 2006
3356 \begin_layout Subsection*
3360 \begin_layout Description
3361 Action Move the cursor to the next paragraph (or begining of the current
3362 one) in upward direction.
3366 \begin_layout Description
3370 \begin_layout Description
3371 Origin Asger, 1 Oct 1996
3374 \begin_layout Subsection*
3375 LFUN_PARAGRAPH_UP_SELECT
3378 \begin_layout Description
3379 Action Move the cursor and select the text to the next paragraph (or begining
3380 of the current one) in upward direction.
3384 \begin_layout Description
3385 Syntax paragraph-up-select
3388 \begin_layout Description
3389 Origin Asger, 1 Oct 1996
3392 \begin_layout Subsection*
3396 \begin_layout Description
3397 Action Move the cursor to the next paragraph (or begining of the current
3398 one) in downward direction.
3402 \begin_layout Description
3403 Syntax paragraph-down
3406 \begin_layout Description
3407 Origin Asger, 1 Oct 1996
3410 \begin_layout Subsection*
3411 LFUN_PARAGRAPH_DOWN_SELECT
3414 \begin_layout Description
3415 Action Move the cursor and select the text to the next paragraph (or begining
3416 of the current one) in downward direction.
3420 \begin_layout Description
3421 Syntax paragraph-down-select
3424 \begin_layout Description
3425 Origin Asger, 1 Oct 1996
3428 \begin_layout Subsection*
3432 \begin_layout Description
3433 Action Jump to a paragraph given by its id number and optionally the desired
3434 position within the paragraph.
3438 \begin_layout Description
3439 Notion Note that id number of paragraph is not the sequential number of
3440 paragraph seen on the screen.
3441 Moreover the id is unique for all opened buffers (documents).
3445 \begin_layout Description
3446 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3449 \begin_layout Description
3450 Params <PAR_ID_NUMBER>: paragraph id
3451 \begin_inset Newline newline
3454 <POSITION_IN_PAR>: desired position within the paragraph
3457 \begin_layout Description
3458 Origin Dekel, 26 Aug 2000
3461 \begin_layout Subsection*
3462 LFUN_BREAK_PARAGRAPH
3465 \begin_layout Description
3466 Action Breaks the current paragraph at the current location.
3470 \begin_layout Description
3471 Syntax break-paragraph
3474 \begin_layout Subsection*
3475 LFUN_BREAK_PARAGRAPH
3478 \begin_layout Description
3479 Action Breaks the current paragraph at the current location.
3483 \begin_layout Description
3484 Notion Removes the selection.
3488 \begin_layout Description
3489 Syntax break-paragraph [<LAYOUT>]
3492 \begin_layout Description
3493 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3494 default layout) when the cursor is at the end of the line.
3498 \begin_layout Subsection*
3499 LFUN_PARAGRAPH_PARAMS
3502 \begin_layout Description
3503 Action Change paragraph settings.
3507 \begin_layout Description
3508 Notion Modifies the current paragraph, or currently selected paragraphs.
3509 This function only modifies, and does not override, existing settings.
3510 Note that the "leftindent" indent setting is deprecated.
3514 \begin_layout Description
3515 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3518 \begin_layout Description
3528 \begin_inset Newline newline
3533 paragraph_spacing default|single|onehalf|double|other
3534 \begin_inset Newline newline
3539 align block|left|right|center|default
3540 \begin_inset Newline newline
3545 labelwidthstring WIDTH|
3548 \begin_inset Newline newline
3554 \begin_layout Description
3555 Origin rgh, Aug 15 2007
3558 \begin_layout Subsection*
3559 LFUN_PARAGRAPH_PARAMS_APPLY
3562 \begin_layout Description
3563 Action Change paragraph settings.
3567 \begin_layout Description
3568 Notion Overwrite all nonspecified settings to the default ones.
3569 Use paragraph-params lfun if you don't want to overwrite others settings.
3573 \begin_layout Description
3574 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3577 \begin_layout Description
3578 Params For parameters see LFUN_PARAGRAPH_PARAMS
3581 \begin_layout Description
3582 Origin leeming, 30 Mar 2004
3585 \begin_layout Subsection*
3586 LFUN_PARAGRAPH_UPDATE
3589 \begin_layout Description
3590 Action Updates the values inside the paragraph dialog from the paragraph.
3594 \begin_layout Description
3595 Notion This is internal LFUN, not to be used by users.
3596 Called internally by LFUN_DIALOG_UPDATE.
3600 \begin_layout Description
3601 Origin leeming, 13 Mar 2003
3604 \begin_layout Subsection*
3608 \begin_layout Description
3609 Action Move the current group in the upward direction in the structure of
3614 \begin_layout Description
3615 Notion The "group" can be Part/Chapter/Section/etc.
3616 It moves the whole substructure of the group.
3620 \begin_layout Description
3624 \begin_layout Description
3625 Origin Vermeer, 23 Mar 2006
3628 \begin_layout Subsection*
3632 \begin_layout Description
3633 Action Move the current group in the downward direction in the structure
3638 \begin_layout Description
3639 Notion The "group" can be Part/Chapter/Section/etc.
3640 It moves the whole substructure of the group.
3644 \begin_layout Description
3648 \begin_layout Description
3649 Origin Vermeer, 23 Mar 2006
3652 \begin_layout Subsection*
3656 \begin_layout Description
3657 Action Moves the current group in the downward direction in the hierarchy
3658 of the document structure.
3662 \begin_layout Description
3663 Notion Part -> Chapter -> Section -> etc.
3667 \begin_layout Description
3671 \begin_layout Description
3672 Origin Vermeer, 23 Mar 2006
3675 \begin_layout Subsection*
3679 \begin_layout Description
3680 Action Moves the current group in the upward direction in the hierarchy
3681 of the document structure.
3685 \begin_layout Description
3686 Notion Part <- Chapter <- Section <- etc.
3690 \begin_layout Description
3694 \begin_layout Description
3695 Origin Vermeer, 23 Mar 2006
3698 \begin_layout Subsection*
3702 \begin_layout Description
3703 Action Edit the inset at cursor with an external application, *
3704 if one is attributed.
3708 \begin_layout Description
3709 Syntax inset-edit [<INSET_PARAMS>]
3712 \begin_layout Description
3713 Params <INSET_PARAMS>: Parameters for the inset.
3715 \begin_inset Newline newline
3718 Currently only the filename will be considered.
3722 \begin_layout Description
3723 Origin JSpitzm, 27 Apr 2006
3726 \begin_layout Subsection*
3730 \begin_layout Description
3731 Action Inserts table into the document.
3735 \begin_layout Description
3736 Syntax tabular-insert [<ROWS> <COLUMNS>]
3739 \begin_layout Description
3740 Params In case no arguments are given show insert dialog.
3744 \begin_layout Description
3745 Origin Jug, 12 Apr 2000
3748 \begin_layout Subsection*
3749 LFUN_TABULAR_FEATURE
3752 \begin_layout Description
3753 Action Sets various features to the table/cell on the current cursor position.
3757 \begin_layout Description
3758 Notion Various math-environment features are handled here as well, e.g.
3759 add-vline-left/right for Grid/Cases environment
3762 \begin_layout Description
3763 Syntax tabular-feature <FEATURE> [<ARG>]
3766 \begin_layout Description
3767 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3768 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3769 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3770 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3771 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3772 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3773 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3774 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3775 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3776 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3777 |set-bottom-space|set-interline-space|set-border-lines
3778 \begin_inset Newline newline
3781 <ARG>: additional argument for some commands, use debug mode to explore
3786 \begin_layout Description
3787 Origin Jug, 28 Jul 2000
3790 \begin_layout Subsection*
3794 \begin_layout Description
3795 Action Moves the cursor to the previous cell inside the table.
3799 \begin_layout Description
3800 Syntax cell-backward
3803 \begin_layout Description
3804 Origin Jug, 22 May 2000
3807 \begin_layout Subsection*
3811 \begin_layout Description
3812 Action Moves the cursor to the next cell inside the table.
3816 \begin_layout Description
3820 \begin_layout Subsection*
3824 \begin_layout Description
3825 Action Splits cell and shifts right part to the next cell (inside the math
3830 \begin_layout Description
3834 \begin_layout Description
3835 Origin Ale, 15 May 1997
3838 \begin_layout Subsection*
3842 \begin_layout Description
3843 Action Register the document as an file inside version control system (RCS,
3848 \begin_layout Description
3849 Notion File is registered inside cvs, svn or rcs repository acording to
3850 the existence of cvs/svn/rcs entries in the document's directory.
3852 \begin_inset Newline newline
3855 See LyX Extended Manual (Version Control Chapter) for additional information.
3859 \begin_layout Description
3863 \begin_layout Description
3864 Origin Lgb, 1 Jul 1997
3867 \begin_layout Subsection*
3871 \begin_layout Description
3872 Action Checks-in/commits the changes of the registered file to the repository.
3876 \begin_layout Description
3877 Notion In RCS case this also unlocks the file.
3881 \begin_layout Description
3885 \begin_layout Description
3886 Origin Lgb, 1 Jul 1997
3889 \begin_layout Subsection*
3893 \begin_layout Description
3894 Action Checks-out the document for edit (and locks it for RCS).
3898 \begin_layout Description
3899 Notion This is implemented only for RCS and SVN, not CVS.
3903 \begin_layout Description
3907 \begin_layout Description
3908 Origin Lgb, 1 Jul 1997
3911 \begin_layout Subsection*
3915 \begin_layout Description
3916 Action Reverts the document to the last check-in/commit in VCS.
3920 \begin_layout Description
3924 \begin_layout Description
3925 Origin Lgb, 1 Jul 1997
3928 \begin_layout Subsection*
3932 \begin_layout Description
3933 Action Undo last check-in.
3937 \begin_layout Description
3938 Notion This is currently implemented only for RCS.
3942 \begin_layout Description
3946 \begin_layout Description
3947 Origin Lgb, 1 Jul 1997
3950 \begin_layout Subsection*
3954 \begin_layout Description
3955 Action Toggles change tracking to on/off.
3959 \begin_layout Description
3960 Syntax changes-track
3963 \begin_layout Description
3964 Origin levon, 1 Oct 2002
3967 \begin_layout Subsection*
3971 \begin_layout Description
3972 Action Toggles showing of change tracking in typesetted output.
3976 \begin_layout Description
3977 Syntax changes-output
3980 \begin_layout Description
3981 Origin jspitzm, 21 Jan 2005
3984 \begin_layout Subsection*
3988 \begin_layout Description
3989 Action Moves the cursor to the position of the next change of the change
3994 \begin_layout Description
3998 \begin_layout Description
3999 Origin schmitt, 4 Oct 2006
4002 \begin_layout Subsection*
4006 \begin_layout Description
4007 Action Open change tracking dialog for merging and moves the cursor to the
4008 position of the next change.
4012 \begin_layout Description
4013 Syntax changes-merge
4016 \begin_layout Description
4017 Origin Levon, 16 Oct 2002
4020 \begin_layout Subsection*
4024 \begin_layout Description
4025 Action Accepts tracked change inside the selection.
4029 \begin_layout Description
4030 Syntax change-accept
4033 \begin_layout Description
4034 Origin Levon, 16 Oct 2002
4037 \begin_layout Subsection*
4041 \begin_layout Description
4042 Action Rejects tracked change inside the selection.
4046 \begin_layout Description
4047 Syntax change-accept
4050 \begin_layout Description
4051 Origin Levon, 16 Oct 2002
4054 \begin_layout Subsection*
4055 LFUN_ALL_CHANGES_ACCEPT
4058 \begin_layout Description
4059 Action Accepts all tracked changes in the document.
4063 \begin_layout Description
4064 Syntax all-changes-accept
4067 \begin_layout Description
4068 Origin Levon, 16 Oct 2002
4071 \begin_layout Subsection*
4072 LFUN_ALL_CHANGES_REJECT
4075 \begin_layout Description
4076 Action Rejects all tracked changes in the document.
4080 \begin_layout Description
4081 Notion Reject does not work recursively; the user may have to repeat the
4086 \begin_layout Description
4087 Syntax all-changes-reject
4090 \begin_layout Description
4091 Origin Levon, 16 Oct 2002
4094 \begin_layout Subsection*
4098 \begin_layout Description
4099 Action Apply data for an inset.
4103 \begin_layout Description
4104 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4106 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4107 on the context where it is called.
4111 \begin_layout Description
4112 Syntax inset-apply <ARGS>
4115 \begin_layout Description
4116 Params See LFUN_INSET_INSERT .
4120 \begin_layout Subsection*
4124 \begin_layout Description
4125 Action Dissolve the current inset into text.
4129 \begin_layout Description
4130 Syntax inset-dissolve [<INSET>]
4133 \begin_layout Description
4134 Params <INSET>: this can be used to make sure the right kind of inset is
4136 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4137 the charstyle inset, even if the cursor is inside several nested insets
4140 \begin_inset Newline newline
4143 For values see lyx::InsetLayout::lyxtype_ .
4147 \begin_layout Description
4148 Origin JSpitz, 7 Aug 2006
4151 \begin_layout Subsection*
4155 \begin_layout Description
4156 Action Insert new inset (type given by the parameters).
4160 \begin_layout Description
4161 Syntax inset-insert <INSET> <ARGS>
4164 \begin_layout Description
4165 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4166 nclude|index|label|nomencl|vspace|ref|toc>
4167 \begin_inset Newline newline
4170 <ARGS>: depends on the given inset.
4171 Use "lyx -dbg action" to explore.
4175 \begin_layout Description
4176 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4179 \begin_inset Newline newline
4182 where <label name> is the name of the referenced label and<Format> is one
4184 \begin_inset Newline newline
4188 \begin_inset Newline newline
4191 eqref -- (<reference>)
4192 \begin_inset Newline newline
4196 \begin_inset Newline newline
4199 vpageref -- on <page>
4200 \begin_inset Newline newline
4203 vref -- <reference> on <page>
4204 \begin_inset Newline newline
4207 prettyref -- Formatted reference
4210 \begin_layout Subsection*
4214 \begin_layout Description
4215 Action Modify existing inset.
4219 \begin_layout Description
4220 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4221 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4226 \begin_layout Description
4227 Syntax inset-modify <INSET> <ARGS>
4230 \begin_layout Description
4231 Params See LFUN_INSET_INSERT for further details.
4235 \begin_layout Subsection*
4236 LFUN_NEXT_INSET_MODIFY
4239 \begin_layout Description
4240 Action Modify the inset at cursor position, if there is one.
4244 \begin_layout Description
4245 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4246 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4251 \begin_layout Description
4252 Syntax next-inset-modify <INSET> <ARGS>
4255 \begin_layout Description
4256 Syntax next-inset-modify changetype <TYPE>
4259 \begin_layout Description
4260 Params See LFUN_INSET_INSERT for further details.
4264 \begin_layout Description
4265 Origin JSpitzm, 23 Mar 2008
4268 \begin_layout Subsection*
4269 LFUN_INSET_DIALOG_UPDATE
4272 \begin_layout Description
4273 Action Updates the values inside the dialog from the inset.
4277 \begin_layout Description
4278 Notion This is internal LFUN, not to be used by users.
4279 Called internally by LFUN_DIALOG_UPDATE
4282 \begin_layout Description
4283 Params <DIALOG-NAME>
4286 \begin_layout Description
4287 Origin leeming, 25 Feb 2003
4290 \begin_layout Subsection*
4294 \begin_layout Description
4295 Action Open the inset's properties dialog.
4299 \begin_layout Description
4300 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4304 \begin_layout Description
4305 Syntax inset-settings <INSET>
4308 \begin_layout Description
4309 Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
4312 \begin_layout Subsection*
4313 LFUN_NEXT_INSET_TOGGLE
4316 \begin_layout Description
4317 Action Toggles the inset at cursor position.
4318 For collapsables, this means it will be (un-)collapsed, in case of other
4319 insets, the editing widget (dialog) will be entered.
4321 LFUN_INSET_SETTINGS.
4325 \begin_layout Description
4326 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4327 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4332 \begin_layout Description
4333 Syntax next-inset-toggle <ARG>
4336 \begin_layout Description
4337 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4341 \begin_layout Description
4342 Origin leeming, 30 Mar 2004
4345 \begin_layout Subsection*
4349 \begin_layout Description
4350 Action Toggles the collapsable inset we are currently in.
4354 \begin_layout Description
4355 Syntax inset-toggle [<ARG>]
4358 \begin_layout Description
4359 Params <ARG>: <open|close|toggle|assign>.
4361 \begin_inset Newline newline
4364 open/close/toggle are for collapsable insets.
4365 close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4366 toggle is used when no argument is given.
4368 \begin_inset Newline newline
4371 assign is for branch inset.
4375 \begin_layout Description
4376 Origin lasgouttes, 19 Jul 2001
4379 \begin_layout Subsection*
4380 LFUN_ALL_INSETS_TOGGLE
4383 \begin_layout Description
4384 Action Toggles (open/closes) all collapsable insets (of a given type) in
4389 \begin_layout Description
4390 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4394 \begin_layout Description
4395 Syntax all-insets-toggle <STATE> <INSET>
4398 \begin_layout Description
4399 Params <STATE>: <toggle|open|close> default: toggle
4400 \begin_inset Newline newline
4403 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4407 \begin_layout Description
4408 Origin leeming, 30 Mar 2004
4411 \begin_layout Subsection*
4412 LFUN_GRAPHICS_GROUPS_UNIFY
4415 \begin_layout Description
4416 Action Unify all graphics insets with the one given as an parameter.
4420 \begin_layout Description
4421 Notion This is internally used for synchronize certain group of graphics
4426 \begin_layout Description
4427 Syntax graphics-groups-unigfy <GRAPHICS_PARAMS>
4430 \begin_layout Description
4431 Params <GRAPHICS_PARAMS>: Parameters for graphics inset (syntax can be seen
4436 \begin_layout Description
4437 Origin sanda, 6 May 2008
4440 \begin_layout Subsection*
4441 LFUN_SET_GRAPHICS_GROUP
4444 \begin_layout Description
4445 Action Set the group for the graphics inset on the cursor position.
4449 \begin_layout Description
4450 Syntax set-graphics-group [<GROUP>]
4453 \begin_layout Description
4454 Params <GROUP>: Id for an existing group.
4455 In case tthe Id is an empty string, the graphics inset is removed from
4460 \begin_layout Description
4461 Origin sanda, 6 May 2008
4464 \begin_layout Subsection*
4465 LFUN_FINISHED_FORWARD
4468 \begin_layout Description
4469 Action Moves the cursor out of the current slice, going forward.
4473 \begin_layout Description
4474 Notion Cursor movement within an inset may be different than cursor movement
4475 in the surrounding text.
4476 This action should be called automatically by the cursor movement within
4477 the inset, when movement within the inset has ceased (reached the end of
4478 the last paragraph, for example), in order to move correctly back into
4479 the surrounding text.
4483 \begin_layout Subsection*
4484 LFUN_FINISHED_BACKWARD
4487 \begin_layout Description
4488 Action Moves the cursor out of the current slice, going backwards.
4492 \begin_layout Description
4493 Notion See also LFUN_FINISHED_FORWARD.
4497 \begin_layout Subsection*
4501 \begin_layout Description
4502 Action Moves the cursor out of the current slice, going right.
4506 \begin_layout Description
4507 Notion See also LFUN_FINISHED_FORWARD
4510 \begin_layout Subsection*
4514 \begin_layout Description
4515 Action Moves the cursor out of the current slice, going left.
4519 \begin_layout Description
4520 Notion See also LFUN_FINISHED_FORWARD.
4524 \begin_layout Subsection*
4528 \begin_layout Description
4529 Action Set language from the current cursor position.
4533 \begin_layout Description
4534 Syntax language <LANG>
4537 \begin_layout Description
4538 Params <LANG>: Requested language.
4539 Look in lib/languages for the list.
4543 \begin_layout Description
4544 Origin Dekel, 2 Mar 2000
4547 \begin_layout Subsection*
4551 \begin_layout Description
4552 Action Goto a label.
4556 \begin_layout Description
4557 Syntax label-goto [<LABEL>]
4560 \begin_layout Description
4561 Params <LABEL>: Requested label.
4562 If no label is given and refernce is on cursor position, Bookmark 0 is
4563 saved and cursor moves to the position of referenced label.
4567 \begin_layout Description
4568 Origin Ale, 6 Aug 1997
4571 \begin_layout Subsection*
4575 \begin_layout Description
4576 Action Inserts label to text or displayed formula.
4580 \begin_layout Description
4581 Syntax label-insert [<LABEL>]
4584 \begin_layout Description
4585 Params <LABEL>: Requested label.
4586 If no label is given dialog requesting name will be opened.
4590 \begin_layout Subsection*
4594 \begin_layout Description
4595 Action Go to the next label or cross-reference.
4599 \begin_layout Description
4600 Syntax reference-next
4603 \begin_layout Description
4604 Origin Dekel, 14 Jan 2001
4607 \begin_layout Subsection*
4611 \begin_layout Description
4612 Action Goto a bookmark.
4616 \begin_layout Description
4617 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4618 Note that bookmarsk are saved per-session, not per file.
4622 \begin_layout Description
4623 Syntax bookmark-goto <NUMBER>
4626 \begin_layout Description
4627 Params <NUMBER>: the number of the bookmark to restore.
4631 \begin_layout Description
4632 Origin Dekel, 27 January 2001
4635 \begin_layout Subsection*
4639 \begin_layout Description
4640 Action Save a bookmark.
4644 \begin_layout Description
4645 Notion Saves a numbered bookmark to the sessions file.
4646 The number must be between 1 and 9, inclusive.
4647 Note that bookmarks are saved per-session, not per file.
4651 \begin_layout Description
4652 Syntax bookmark-save <NUMBER>
4655 \begin_layout Description
4656 Params <NUMBER>: the number of the bookmark to save.
4660 \begin_layout Description
4661 Origin Dekel, 27 January 2001
4664 \begin_layout Subsection*
4668 \begin_layout Description
4669 Action Clears the list of saved bookmarks.
4673 \begin_layout Description
4674 Syntax bookmark-clear
4677 \begin_layout Description
4678 Origin bpeng, 31 October 2006
4681 \begin_layout Subsection*
4685 \begin_layout Description
4686 Action Open the given help file according to the language setting.
4690 \begin_layout Description
4691 Syntax help-open <FILE>[.lyx]
4694 \begin_layout Description
4695 Params <FILE>: any document from (/usr/share/)doc directory.
4699 \begin_layout Description
4700 Origin Jug, 27 Jun 1999
4703 \begin_layout Subsection*
4707 \begin_layout Description
4708 Action Terminates the current LyX instance.
4712 \begin_layout Description
4713 Notion Terminates the current LyX instance, asking whether to save modified
4718 \begin_layout Description
4722 \begin_layout Subsection*
4726 \begin_layout Description
4727 Action Toggles visibility of a given toolbar between on/off/auto.
4731 \begin_layout Description
4732 Notion Skiping "auto" when allowauto is false.
4736 \begin_layout Description
4737 Syntax toolbar-toggle <NAME> [allowauto]
4740 \begin_layout Description
4741 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4742 ew/update|math_panels
4745 \begin_layout Description
4746 Origin Edwin, 21 May 2007
4749 \begin_layout Subsection*
4753 \begin_layout Description
4754 Action Opens the menu given by its name.
4758 \begin_layout Description
4759 Syntax menu-open <NAME>
4762 \begin_layout Description
4763 Params <NAME>: menu name.
4764 See various .inc files in lib/ui for candidates.
4768 \begin_layout Subsection*
4772 \begin_layout Description
4773 Action Various UI visibility-toggling actions.
4777 \begin_layout Description
4778 Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
4781 \begin_layout Description
4782 Params statusbar : Toggle visibility of the statusbar.
4784 \begin_inset Newline newline
4787 menubar : Toggle visibility of the menubar.
4789 \begin_inset Newline newline
4792 scrollbar : Toggle visibility of the scrollbar.
4794 \begin_inset Newline newline
4797 frame : Toggle visibility of the frames around editing window.
4799 \begin_inset Newline newline
4802 fullscreen : Toggle fullscreen mode.
4803 This also covers calling the previous functions.
4804 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4809 \begin_layout Description
4810 Origin sanda, 9 Feb 2007
4813 \begin_layout Subsection*
4817 \begin_layout Description
4818 Action Creates new empty LyX window.
4822 \begin_layout Description
4823 Notion Already opened documents from the previous window can be found under
4828 \begin_layout Description
4829 Syntax window-new [<GEOMETRY>]
4832 \begin_layout Description
4833 Params <GEOMETRY>: pass the geometry of the window.
4834 This parameter is currently accepted only on Windows platform.
4838 \begin_layout Description
4839 Origin Abdel, 21 Oct 2006
4842 \begin_layout Subsection*
4846 \begin_layout Description
4847 Action Closes the current LyX window.
4851 \begin_layout Description
4855 \begin_layout Description
4856 Origin Abdel, 23 Oct 2006
4859 \begin_layout Subsection*
4863 \begin_layout Description
4864 Action Creates another split view of current buffer.
4868 \begin_layout Description
4869 Notion All split views act in the same way indpendently.
4873 \begin_layout Description
4874 Syntax split-view <vertical|horizontal>
4877 \begin_layout Description
4878 Params horizontal : The work areas are laid out side by side.
4880 \begin_inset Newline newline
4883 vertical : The work areas laid out vertically.
4887 \begin_layout Description
4888 Origin Abdel, 20 Feb 2008
4891 \begin_layout Subsection*
4892 LFUN_CLOSE_TAB_GROUP
4895 \begin_layout Description
4896 Action Close the current tab group.
4900 \begin_layout Description
4901 Notion This only closes the work areas, not the buffer themselves.
4902 The still opened buffers can be visualized in another tab group.
4906 \begin_layout Description
4907 Syntax close-tab-group
4910 \begin_layout Description
4911 Origin Abdel, 21 Feb 2008
4914 \begin_layout Subsection*
4918 \begin_layout Description
4919 Action Shows hidden dialog or create new one for a given function/inset
4924 \begin_layout Description
4925 Syntax dialog-show <NAME> [<DATA>]
4928 \begin_layout Description
4929 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4931 \begin_inset Newline newline
4934 document|errorlist|ert|external|file|findreplace|float|graphics|
4935 \begin_inset Newline newline
4938 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
4939 \begin_inset Newline newline
4942 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
4943 \begin_inset Newline newline
4946 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
4947 \begin_inset Newline newline
4950 wrap|listings|<SPECIAL>
4951 \begin_inset Newline newline
4954 <SPECIAL>: latexlog|vclog
4955 \begin_inset Newline newline
4958 <DATA>: data, usually settings for the given dialog.
4959 Use debug mode for the details.
4963 \begin_layout Description
4964 Origin leeming, 17 Jun 2003
4967 \begin_layout Subsection*
4968 LFUN_DIALOG_SHOW_NEW_INSET
4971 \begin_layout Description
4972 Action Shows hidden dialog or create new one for a given inset settings
4977 \begin_layout Description
4978 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
4983 \begin_layout Description
4984 Syntax dialog-show-new-inset <NAME> [<DATA>]
4987 \begin_layout Description
4988 Params See LFUN_DIALOG_SHOW .
4992 \begin_layout Description
4993 Origin leeming, 25 Feb 2003
4996 \begin_layout Subsection*
5000 \begin_layout Description
5001 Action Updates the dialog values from the inset/paragraph/document.
5005 \begin_layout Description
5006 Syntax dialog-update <NAME>
5009 \begin_layout Description
5010 Params <NAME>: paragraph|prefs|<INSET>
5011 \begin_inset Newline newline
5017 \begin_layout Description
5018 Origin leeming, 25 Feb 2003
5021 \begin_layout Subsection*
5025 \begin_layout Description
5026 Action Hides showed dialog.
5027 Counterpart to LFUN_DIALOG_SHOW .
5031 \begin_layout Description
5032 Syntax dialog-hide <NAME>
5035 \begin_layout Description
5036 Params See LFUN_DIALOG_SHOW .
5040 \begin_layout Description
5041 Origin leeming, 25 Feb 2003
5044 \begin_layout Subsection*
5048 \begin_layout Description
5049 Action Toggles dialog between showed/hidden state.
5053 \begin_layout Description
5054 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5058 \begin_layout Description
5059 Syntax dialog-toggle <NAME> [<DATA>]
5062 \begin_layout Description
5063 Params See LFUN_DIALOG_SHOW .
5067 \begin_layout Description
5068 Origin JSpitzm, 30 Apr 2007
5071 \begin_layout Subsection*
5072 LFUN_DIALOG_DISCONNECT_INSET
5075 \begin_layout Description
5076 Action Closes opened connection to opened inset.
5080 \begin_layout Description
5081 Notion Connection is used for apply functions.
5085 \begin_layout Description
5086 Syntax dialog-disconnect-inset <INSET-NAME>
5089 \begin_layout Description
5090 Origin leeming, 25 Feb 2003
5093 \begin_layout Subsection*
5097 \begin_layout Description
5098 Action This function is called when mouse button is pressed (inside workarea).Act
5099 ion depends on the context.
5103 \begin_layout Description
5104 Notion This is internal LFUN, not to be used by users.
5108 \begin_layout Description
5109 Origin Andre, 9 Aug 2002
5112 \begin_layout Subsection*
5116 \begin_layout Description
5117 Action This function is called when double click on mouse button is pressed
5119 Action depends on the context.
5123 \begin_layout Description
5124 Notion This is internal LFUN, not to be used by users.
5128 \begin_layout Description
5129 Origin Andre, 9 Aug 2002
5132 \begin_layout Subsection*
5136 \begin_layout Description
5137 Action This function is called when triple click on mouse button is pressed
5139 Action depends on the context.
5143 \begin_layout Description
5144 Notion This is internal LFUN, not to be used by users.
5148 \begin_layout Description
5149 Origin Andre, 9 Aug 2002
5152 \begin_layout Subsection*
5156 \begin_layout Description
5157 Action This function is called when mouse cursor is moving over the text.Action
5158 depends on the context.
5162 \begin_layout Description
5163 Notion This is internal LFUN, not to be used by users.
5167 \begin_layout Description
5168 Origin Andre, 9 Aug 2002
5171 \begin_layout Subsection*
5175 \begin_layout Description
5176 Action This function is called when mouse button is released (inside workarea).Ac
5177 tion depends on the context.
5181 \begin_layout Description
5182 Notion This is internal LFUN, not to be used by users.
5186 \begin_layout Description
5187 Origin Andre, 9 Aug 2002
5190 \begin_layout Subsection*
5194 \begin_layout Description
5195 Action Turn off the loaded keyboard map.
5199 \begin_layout Description
5203 \begin_layout Subsection*
5207 \begin_layout Description
5208 Action Turn on the primary keyboard map.
5212 \begin_layout Description
5213 Notion Maps were widely used in past, when X-windows didn't have nowadays
5215 They can be still used to maintain uniform keyboard layout across the various
5218 \begin_inset Newline newline
5221 The language is to be set in the Preferences dialog.
5225 \begin_layout Description
5226 Syntax keymap-primary
5229 \begin_layout Subsection*
5230 LFUN_KEYMAP_SECONDARY
5233 \begin_layout Description
5234 Action Turn on the secondary keyboard map.
5238 \begin_layout Description
5239 Syntax keymap-secondary
5242 \begin_layout Subsection*
5246 \begin_layout Description
5247 Action Toggles keyboard maps (first/second/off).
5251 \begin_layout Description
5252 Syntax keymap-toggle
5255 \begin_layout Description
5256 Origin leeming, 30 Mar 2004
5259 \begin_layout Subsection*
5260 LFUN_SERVER_GET_LAYOUT
5263 \begin_layout Description
5264 Action Returns the current layout (that is environment) name on the cursor
5269 \begin_layout Description
5270 Syntax server-get-layout
5273 \begin_layout Subsection*
5274 LFUN_SERVER_GET_FILENAME
5277 \begin_layout Description
5278 Action Returns path and file name of the currently edited document.
5282 \begin_layout Description
5283 Syntax server-get-filename
5286 \begin_layout Subsection*
5287 LFUN_SERVER_GOTO_FILE_ROW
5290 \begin_layout Description
5291 Action Sets the cursor position based on the row number of generated TeX
5296 \begin_layout Description
5297 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5300 \begin_layout Description
5301 Origin Edmar, 23 Dec 1998
5304 \begin_layout Subsection*
5308 \begin_layout Description
5309 Action Sends notify message about the last key-sequence to client.
5313 \begin_layout Description
5314 Notion This can be used to grab last key-sequence used inside the LyX window.
5318 \begin_layout Description
5319 Syntax server-notify
5322 \begin_layout Subsection*
5326 \begin_layout Description
5327 Action Sets the cursor position based on the editing area coordinates (similar
5328 as clicking on that point with left mouse button).
5332 \begin_layout Description
5333 Syntax server-set-xy <X> <Y>
5336 \begin_layout Subsection*
5340 \begin_layout Description
5341 Action Returns the coordinates of cursor position in the editing area.
5345 \begin_layout Description
5346 Syntax server-get-xy
5349 \begin_layout Subsection*
5353 \begin_layout Description
5354 Action Generates the code (literate programming).
5358 \begin_layout Description
5359 Notion Latex file with extension literate_extension is generated.
5360 Then LyX invokes build_command (with a default of``make'') to generate
5361 the code and build_error_filter to process the compilation error messages.
5363 \begin_inset Newline newline
5366 In case you want to process your literate file with a script, or some other
5367 program, just insert in your lyxrc file an entry with:
5368 \begin_inset Newline newline
5371 build_command "my_script my_arguments"
5372 \begin_inset Newline newline
5375 The build_error_filter differs from the literate_error_filter only in that
5376 the former will identify error messages from your compiler.
5380 \begin_layout Description
5381 Syntax build-program
5384 \begin_layout Subsection*
5385 LFUN_BUFFER_AUTO_SAVE
5388 \begin_layout Description
5389 Action Saves the current buffer to a temporary file.
5393 \begin_layout Description
5394 Notion Saves the current buffer to a file named "#filename#".
5395 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5399 \begin_layout Description
5400 Syntax buffer-auto-save
5403 \begin_layout Subsection*
5404 LFUN_BUFFER_CHILD_OPEN
5407 \begin_layout Description
5408 Action Loads the given child document.
5412 \begin_layout Description
5413 Notion The current document is treated as a parent.
5417 \begin_layout Description
5418 Syntax buffer-child-open <FILE>
5421 \begin_layout Description
5422 Params <FILE>: Filename of the child.
5423 The directory of the parent is assumed by default.
5427 \begin_layout Description
5428 Origin Ale, 28 May 1997
5431 \begin_layout Subsection*
5435 \begin_layout Description
5436 Action Runs chktex for the current document.
5440 \begin_layout Description
5441 Syntax buffer-chktex
5444 \begin_layout Description
5445 Origin Asger, 30 Oct 1997
5448 \begin_layout Subsection*
5449 LFUN_BUFFER_TOGGLE_COMPRESSION
5452 \begin_layout Description
5453 Action Toggles compression of the current document on/off.
5457 \begin_layout Description
5458 Syntax buffer-toggle-compression
5461 \begin_layout Description
5462 Origin bpeng, 27 Apr 2006
5465 \begin_layout Subsection*
5469 \begin_layout Description
5470 Action Closes the current buffer.
5474 \begin_layout Description
5475 Notion Closes the current buffer, asking whether to save it, etc, if the
5476 buffer has been modified.
5480 \begin_layout Description
5484 \begin_layout Subsection*
5488 \begin_layout Description
5489 Action Exports the current buffer (document) to the given format.
5493 \begin_layout Description
5494 Syntax buffer-export <FORMAT>
5497 \begin_layout Description
5498 Params <FORMAT> is either "custom" or one of the formats which you can find
5499 in Tools->Preferences->File formats->Format.
5500 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5501 for pdflatex) or "ps" for postscript.
5503 \begin_inset Newline newline
5506 In case of "custom" you will be asked for a format you want to start from
5507 and for the command that you want to apply to this format.
5508 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5512 \begin_layout Description
5513 Origin Lgb, 29 Jul 1997
5516 \begin_layout Subsection*
5517 LFUN_BUFFER_EXPORT_CUSTOM
5520 \begin_layout Description
5521 Action Exports the current buffer (document) from the given format using
5522 the given command on it.
5526 \begin_layout Description
5527 Syntax buffer-export-custom <FORMAT> <COMMAND>
5530 \begin_layout Description
5531 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5534 \begin_inset Newline newline
5537 <COMMAND> this command will be launched on the file.
5538 Note that you can use "$$FName" string to qualify the intermediate file.
5542 \begin_layout Description
5543 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5546 \begin_layout Description
5547 Origin leeming, 27 Mar 2004
5550 \begin_layout Subsection*
5554 \begin_layout Description
5555 Action Prints the current document.
5559 \begin_layout Description
5560 Notion Many settings can be given via the preferences dialog.
5564 \begin_layout Description
5565 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5568 \begin_layout Description
5569 Params <TARGET> is either "printer" or "file".
5571 \begin_inset Newline newline
5574 <TARGER-NAME> is either "default" or file name or printer name.
5576 \begin_inset Newline newline
5579 <COMMAND> command ensuring the printing job.
5583 \begin_layout Description
5584 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5587 \begin_layout Description
5588 Origin leeming, 28 Mar 2004
5591 \begin_layout Subsection*
5595 \begin_layout Description
5596 Action Import a given file as a lyx document.
5600 \begin_layout Description
5601 Notion File can be imported iff lyx file format is (transitively) reachable
5602 via defined convertors in preferences.
5603 Look into File->Import menu to get an idea of the currently active import
5608 \begin_layout Description
5609 Syntax buffer-import <FORMAT> [<FILE>]
5612 \begin_layout Description
5613 Origin Asger, 24 Jul 1998
5616 \begin_layout Subsection*
5620 \begin_layout Description
5621 Action Creates a new buffer (that is, document).
5625 \begin_layout Description
5626 Notion Implicit path can be set in Preferences dialog.
5630 \begin_layout Description
5631 Syntax buffer-new [<FILE>]
5634 \begin_layout Description
5635 Params <FILE>: filename of created file with absolute path.
5639 \begin_layout Subsection*
5640 LFUN_BUFFER_NEW_TEMPLATE
5643 \begin_layout Description
5644 Action Creates a new buffer (that is, document) from a template.
5648 \begin_layout Description
5649 Notion Path for new files and templates can be set in Preferences dialog.
5650 Template will be asked for via Open-dialog.
5654 \begin_layout Description
5655 Syntax buffer-new-template [<FILE>]
5658 \begin_layout Description
5659 Params <FILE>: filename of created file with absolute path.
5663 \begin_layout Subsection*
5667 \begin_layout Description
5668 Action Reverts opened document.
5672 \begin_layout Description
5673 Syntax buffer-reload
5676 \begin_layout Description
5677 Origin Asger, 2 Feb 1997
5680 \begin_layout Subsection*
5684 \begin_layout Description
5685 Action Switch to the given buffer.
5689 \begin_layout Description
5690 Notion This is useful also in case you need simultaneously more views of
5691 the edited document in different LyX windows.
5695 \begin_layout Description
5696 Syntax buffer-new-template <BUFFER>
5699 \begin_layout Description
5700 Params <BUFFER>: already opened document which is to be shown.
5704 \begin_layout Subsection*
5705 LFUN_BUFFER_TOGGLE_READ_ONLY
5708 \begin_layout Description
5709 Action Toggle editing mode of the current document between read/write and
5714 \begin_layout Description
5715 Notion In the ->Readonly mode checks-in/commits the data if the file is
5716 under version control.
5717 In the Readonly-> mode checkouts the data from repository.
5719 \begin_inset Newline newline
5722 If these operations fail, buffer won't be toggled.
5726 \begin_layout Description
5727 Syntax buffer-toggle-read-only
5730 \begin_layout Description
5731 Origin Lgb, 27 May 1997
5734 \begin_layout Subsection*
5738 \begin_layout Description
5739 Action Displays current buffer in chosen format.
5743 \begin_layout Description
5744 Notion Displays the contents of the current buffer in the chosen format,
5745 for example, PDF or DVI.
5746 This runs the necessary converter, calls the defined viewer, and so forth.
5750 \begin_layout Description
5751 Syntax buffer-view <FORMAT>
5754 \begin_layout Description
5755 Params <FORMAT>: The format to display, where this is one of the formats
5756 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5760 \begin_layout Subsection*
5764 \begin_layout Description
5765 Action Exports the current document and put the result into the temporary
5770 \begin_layout Description
5771 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5772 EW) the output will be rewriten - updated.
5773 This is useful in case your viewer is able to detect such changes (e.g.
5774 ghostview for postscript).
5778 \begin_layout Description
5779 Syntax buffer-update <FORMAT>
5782 \begin_layout Description
5783 Params <FORMAT>: The format to display, where this is one of the formats
5784 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5788 \begin_layout Description
5789 Origin Dekel, 5 Aug 2000
5792 \begin_layout Subsection*
5796 \begin_layout Description
5797 Action Saves the current buffer.
5801 \begin_layout Description
5802 Notion Saves the current buffer to disk, using the filename that is already
5803 associated with the buffer, asking for one if none is yet assigned.
5807 \begin_layout Description
5811 \begin_layout Subsection*
5812 LFUN_BUFFER_WRITE_AS
5815 \begin_layout Description
5816 Action Rename and save current buffer.
5820 \begin_layout Description
5821 Syntax buffer-write-as <FILENAME>
5824 \begin_layout Description
5825 Params <FILENAME>: New name of the buffer/file.
5826 A relative path is with respect to the original location of the buffer/file.
5830 \begin_layout Subsection*
5831 LFUN_BUFFER_WRITE_ALL
5834 \begin_layout Description
5835 Action Save all changed documents.
5839 \begin_layout Description
5840 Syntax buffer-write-all
5843 \begin_layout Description
5844 Origin rgh, gpothier 6 Aug 2007
5847 \begin_layout Subsection*
5851 \begin_layout Description
5852 Action Switch to the next opened document.
5856 \begin_layout Description
5857 Notion Note that this does not necessarily mean next in tabbar (for full
5858 list see View menu).
5862 \begin_layout Description
5866 \begin_layout Subsection*
5867 LFUN_BUFFER_PREVIOUS
5870 \begin_layout Description
5871 Action Switch to the previous opened document.
5875 \begin_layout Description
5876 Syntax buffer-previous
5879 \begin_layout Subsection*
5880 LFUN_MASTER_BUFFER_UPDATE
5883 \begin_layout Description
5884 Action When run from a child document, this updates (exports) document built
5885 from the master buffer.
5886 If a master is not found, it updates the current buffer.
5890 \begin_layout Description
5891 Syntax master-buffer-update
5894 \begin_layout Description
5895 Origin Tommaso, 20 Sep 2007
5898 \begin_layout Subsection*
5899 LFUN_MASTER_BUFFER_VIEW
5902 \begin_layout Description
5903 Action When run from a child document, this command shows a preview built
5904 from the master buffer.
5905 If a master is not found, it previews the current buffer.
5909 \begin_layout Description
5910 Syntax master-buffer-view
5913 \begin_layout Description
5914 Origin Tommaso, 20 Sep 2007
5917 \begin_layout Subsection*
5918 LFUN_BUFFER_LANGUAGE
5921 \begin_layout Description
5922 Action Set language of the current document.
5926 \begin_layout Description
5927 Syntax buffer-language <LANG>
5930 \begin_layout Description
5931 Params <LANG>: language name.
5932 See lib/languages for list.
5936 \begin_layout Description
5937 Origin leeming, 30 Mar 2004
5940 \begin_layout Subsection*
5941 LFUN_BUFFER_SAVE_AS_DEFAULT
5944 \begin_layout Description
5945 Action Save the current document settings as default.
5949 \begin_layout Description
5950 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5954 \begin_layout Description
5955 Syntax buffer-save-as-default [<ARGS>]
5958 \begin_layout Description
5959 Params <ARGS>: contains the particular settings to be saved.
5960 They obey the syntax you can find in document header of usual .lyx file.
5964 \begin_layout Description
5965 Origin leeming, 30 Mar 2004
5968 \begin_layout Subsection*
5969 LFUN_BUFFER_PARAMS_APPLY
5972 \begin_layout Description
5973 Action Apply the given settings to the current document.
5977 \begin_layout Description
5978 Syntax buffer-params-apply [<ARGS>]
5981 \begin_layout Description
5982 Params <ARGS>: contains the particular settings to be saved.
5983 They obey the syntax you can find in document header of usual .lyx file.
5987 \begin_layout Description
5988 Origin leeming, 30 Mar 2004
5991 \begin_layout Subsection*
5995 \begin_layout Description
5996 Action Inserts another LyX file.
6000 \begin_layout Description
6001 Syntax file-insert [<FILE>]
6004 \begin_layout Description
6005 Params <FILE>: Filename to be inserted.
6009 \begin_layout Subsection*
6010 LFUN_FILE_INSERT_PLAINTEXT
6013 \begin_layout Description
6014 Action Inserts plain text file.
6018 \begin_layout Description
6019 Syntax file-insert-plaintext [<FILE>]
6022 \begin_layout Description
6023 Params <FILE>: Filename to be inserted.
6027 \begin_layout Description
6028 Origin CFO-G, 19 Nov 1997
6031 \begin_layout Subsection*
6032 LFUN_FILE_INSERT_PLAINTEXT_PARA
6035 \begin_layout Description
6036 Action Inserts plain text file as paragraph (i.e.
6041 \begin_layout Description
6042 Syntax file-insert-plaintext-para [<FILE>]
6045 \begin_layout Description
6046 Params <FILE>: Filename to be inserted.
6050 \begin_layout Description
6051 Origin Levon, 14 Feb 2001
6054 \begin_layout Subsection*
6058 \begin_layout Description
6059 Action Open LyX document.
6063 \begin_layout Description
6064 Syntax file-open [<FILE>]
6067 \begin_layout Description
6068 Params <FILE>: Filename to be opened.
6072 \begin_layout Subsection*
6076 \begin_layout Description
6077 Action Executes a command defined in a .def file.
6081 \begin_layout Description
6082 Notion The definitions are by default read from lib/commands/default.def.
6084 \begin_inset Newline newline
6087 A .def file allows to define a command with
6089 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6090 <LFUN> is the lfun code to be executed (see e.g.
6091 LFUN_COMMAND_SEQUENCE).
6094 def_file "FileName" allows to include another .def file.
6096 \begin_inset Newline newline
6099 This is particularly useful in connection with toolbar buttons: Since the
6100 name of the button image for this lfun is lib/images/commands/<NAME>.png
6101 this is the way to assign an image to a complex command-sequence.
6105 \begin_layout Description
6109 \begin_layout Description
6110 Params <NAME>: Name of the command that must be called.
6114 \begin_layout Description
6115 Origin broider, 2 Oct 2007
6118 \begin_layout Subsection*
6122 \begin_layout Description
6123 Action Simulate halting Meta key (Alt key on PCs).
6127 \begin_layout Description
6128 Notion Used for buffer editation not for GUI control.
6132 \begin_layout Description
6136 \begin_layout Subsection*
6140 \begin_layout Description
6141 Action Cancels sequence prepared by LFUN_META_PREFIX .
6145 \begin_layout Description
6149 \begin_layout Subsection*
6150 LFUN_COMMAND_EXECUTE
6153 \begin_layout Description
6154 Action Opens the minibuffer toolbar so that the user can type in there.
6158 \begin_layout Description
6159 Notion Usually bound to M-x shortcut.
6163 \begin_layout Description
6164 Syntax command-execute
6167 \begin_layout Subsection*
6171 \begin_layout Description
6172 Action Return the current key sequence and available options as a string.
6176 \begin_layout Description
6177 Notion No options are added if no current map exists.
6179 \begin_inset Newline newline
6182 This is probably usable only with connection to lyxserver.
6186 \begin_layout Description
6187 Syntax command-prefix
6190 \begin_layout Subsection*
6191 LFUN_COMMAND_SEQUENCE
6194 \begin_layout Description
6195 Action Run more commands (LFUN and its parameters) in a sequence.
6199 \begin_layout Description
6200 Syntax command-sequence <CMDS>
6203 \begin_layout Description
6204 Params <CMDS>: Sequence of commands separated by semicolons.
6208 \begin_layout Description
6209 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6213 \begin_layout Description
6214 Origin Andre, 11 Nov 1999
6217 \begin_layout Subsection*
6221 \begin_layout Description
6222 Action Shows message in statusbar (for script purposes).
6226 \begin_layout Description
6227 Syntax message <STRING>
6230 \begin_layout Description
6231 Origin Lgb, 8 Apr 2001
6234 \begin_layout Subsection*
6235 LFUN_PREFERENCES_SAVE
6238 \begin_layout Description
6239 Action Save user preferences.
6243 \begin_layout Description
6244 Syntax preferences-save
6247 \begin_layout Description
6248 Origin Lgb, 27 Nov 1999
6251 \begin_layout Subsection*
6255 \begin_layout Description
6256 Action Reconfigure the automatic settings.
6260 \begin_layout Description
6264 \begin_layout Description
6265 Origin Asger, 14 Feb 1997
6268 \begin_layout Subsection*
6272 \begin_layout Description
6273 Action Apply the given settings to user preferences.
6277 \begin_layout Description
6278 Syntax lyxrc-apply <SETTINGS>
6281 \begin_layout Description
6282 Params <SETTINGS>: settings which are to be set.
6283 Take a look into ~/.lyx/preferences to get an idea which commands to use
6285 lyx::LyXRC::LyXRCTags has the list of possible commands.
6289 \begin_layout Subsection*
6290 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6293 \begin_layout Description
6294 Action Determine whether keep cursor inside the editing window regardless
6295 the scrollbar movement.
6299 \begin_layout Description
6300 Syntax toggle-cursor-follows-scrollbar
6303 \begin_layout Description
6304 Origin ARRae, 2 Dec 1997
6307 \begin_layout Subsection*
6311 \begin_layout Description
6312 Action Set the given LyX color to the color defined by the X11 name given.
6316 \begin_layout Description
6317 Notion A new color entry is created if the color is unknown.
6318 Color names can be stored as a part of user settings.
6322 \begin_layout Description
6323 Syntax set-color <LYX_NAME> <X11_NAME>
6326 \begin_layout Description
6327 Origin SLior, 11 Jun 2000
6330 \begin_layout Subsection*
6334 \begin_layout Description
6335 Action Count the statistics (number of words and characters) in the document
6336 or in the given selection.
6340 \begin_layout Description
6341 Notion Note that this function gives the number of words/chars written,
6342 not the number of characters which will be typeset.
6346 \begin_layout Description
6350 \begin_layout Description
6351 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6354 \begin_layout Subsection*
6355 LFUN_COMPLETION_INLINE
6358 \begin_layout Description
6359 Action Show the inline completion at the cursor position.
6363 \begin_layout Description
6364 Syntax completion-inline
6367 \begin_layout Description
6368 Origin sts, Feb 19 2008
6371 \begin_layout Subsection*
6372 LFUN_COMPLETION_POPUP
6375 \begin_layout Description
6376 Action Show the completion popup at the cursor position.
6380 \begin_layout Description
6381 Syntax completion-popup
6384 \begin_layout Description
6385 Origin sts, Feb 19 2008
6388 \begin_layout Subsection*
6389 LFUN_COMPLETION_COMPLETE
6392 \begin_layout Description
6393 Action Try to complete the word or command at the cursor position.
6397 \begin_layout Description
6398 Syntax completion-complete
6401 \begin_layout Description
6402 Origin sts, Feb 19 2008
6405 \begin_layout Subsection*
6406 LFUN_BRANCH_ACTIVATE
6409 \begin_layout Description
6410 Action Activate the branch
6413 \begin_layout Description
6414 Syntax branch-activate <BRANCH>
6417 \begin_layout Description
6418 Params <BRANCH>: The branch to activate
6421 \begin_layout Description
6422 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6423 \begin_inset Newline newline
6426 could be used to export a pdf with the answers branch includedwithout one's
6427 having to open LyX and activate the branch manually.
6430 \begin_layout Description
6431 Origin rgh, 27 May 2008
6434 \begin_layout Subsection*
6435 LFUN_BRANCH_ACTIVATE
6438 \begin_layout Description
6439 Action De-activate the branch
6442 \begin_layout Description
6443 Syntax branch-deactivate <BRANCH>
6446 \begin_layout Description
6447 Params <BRANCH>: The branch to deactivate
6450 \begin_layout Description
6451 Origin rgh, 27 May 2008