1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
6 \use_default_options false
14 \font_typewriter default
15 \font_default_family default
22 \paperfontsize default
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.10.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 Insert a tab into a listings inset.
583 \begin_layout Description
584 Notion It also works on a selection.
588 \begin_layout Description
592 \begin_layout Description
593 Origin vfvanravesteijn, Sep 30 2008
596 \begin_layout Subsection*
600 \begin_layout Description
601 Action Delete a tab or up to an equivalent amount of spaces from a listings
606 \begin_layout Description
607 Notion It also works on a selection - it removes a tab or spaces from the
608 beginning of each line spanned by the selection.
609 This is useful if you want to indent/unindent multiple lines in one action.
613 \begin_layout Description
617 \begin_layout Description
618 Origin vfvanravesteijn, Sep 30 2008
621 \begin_layout Subsection*
625 \begin_layout Description
626 Action Inserts quotes according to the type and quote-language preference.
630 \begin_layout Description
631 Action Currently English, Swedish, German, Polish, French, Danish quotes
636 \begin_layout Description
637 Syntax quote-insert [<TYPE>]
640 \begin_layout Description
641 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
646 \begin_layout Subsection*
650 \begin_layout Description
651 Action Displays shortcuts, lyxrc, package and textclass availability and
652 menu information in a non-editable boxed InsetText.
656 \begin_layout Description
657 Notion Apart from lfun arguments you can use the following method:
658 \begin_inset Newline newline
662 input the type and argument of this inset, e.g.
663 "menu paste", in the work area.
665 \begin_inset Newline newline
669 select the text and run info-insert lfun.
673 \begin_layout Description
674 Syntax info-insert <TYPE> <ARG>
677 \begin_layout Description
678 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
679 \begin_inset Newline newline
682 <ARG>: argument for a given type.
683 Look into InsetInfo.h for detailed description.
687 \begin_layout Description
688 Origin bpeng, 7 Oct 2007
691 \begin_layout Subsection*
695 \begin_layout Description
696 Action Inserts branch inset.
700 \begin_layout Description
701 Syntax branch-insert <BRANCH-NAME>
704 \begin_layout Description
705 Origin vermeer, 17 Aug 2003
708 \begin_layout Subsection*
712 \begin_layout Description
713 Action Inserts Box inset.
717 \begin_layout Description
718 Syntax box-insert [<TYPE>]
721 \begin_layout Description
722 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
724 \begin_inset Newline newline
727 Framed is the default one.
731 \begin_layout Description
732 Origin vermeer, 7 Oct 2003
735 \begin_layout Subsection*
739 \begin_layout Description
740 Action Inserts CharStyle, Custom inset or XML short element.
744 \begin_layout Description
745 Notion Look into the Customization manual for more information about these
748 \begin_inset Newline newline
751 To make this command enabled the layout file for the document class you're
752 using has to load the character styles.
753 There are a few contained in the Logical Markup module.
754 You can also of course create some yourself.
756 \begin_inset Newline newline
759 For dissolving the element see LFUN_INSET_DISSOLVE.
763 \begin_layout Description
764 Syntax flex-insert <TYPE:Name>
767 \begin_layout Description
768 Params TYPE: CharStyle|Custom|Element|Standard
769 \begin_inset Newline newline
772 Identifies whether this is a Character Style, a Custom Inset or an XML
773 Element, and which dynamical sub-menu this flex inset is in on the LyX
775 If Standard (currently unused): none of these.
776 Name: This name must be defined either in your layout file or imported
779 \begin_inset Newline newline
782 InsetLayout <TYPE:Name>
785 \begin_layout Description
786 Sample flex-insert CharStyle:Code
789 \begin_layout Subsection*
793 \begin_layout Description
794 Action Inserts the given string (accordingly to the correct keymap).
798 \begin_layout Description
799 Notion Automatically replace the currently selected text.
800 Depends on lyxrc settings "auto_region_delete".
804 \begin_layout Description
805 Syntax self-insert <STRING>
808 \begin_layout Subsection*
812 \begin_layout Description
813 Action Inserts one of horizontal space insets.
817 \begin_layout Description
818 Syntax space-insert <NAME> [<LEN>]
821 \begin_layout Description
822 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
823 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
824 \begin_inset Newline newline
827 <LEN>: length for custom spaces (hspace, hspace* for protected)
830 \begin_layout Description
831 Origin JSpitzm, 20 May 2003, Mar 17 2008
834 \begin_layout Subsection*
835 LFUN_HYPERLINK_INSERT
838 \begin_layout Description
839 Action Inserts hyperlinks into the document (clickable in pdf output).
843 \begin_layout Description
844 Notion Hyperlink target can be set via selection + hyperlink-insert function.
848 \begin_layout Description
849 Syntax href-insert [<TARGET>]
852 \begin_layout Description
853 Origin CFO-G, 21 Nov 1997
856 \begin_layout Subsection*
857 LFUN_SPECIALCHAR_INSERT
860 \begin_layout Description
861 Action Inserts various characters into the document.
865 \begin_layout Description
866 Syntax specialchar-insert <CHAR>
869 \begin_layout Description
870 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
871 tence, menu-separator.
875 \begin_layout Description
876 Origin JSpitzm, 6 Dec 2007
879 \begin_layout Subsection*
883 \begin_layout Description
884 Action Inserts table of contents.
888 \begin_layout Description
892 \begin_layout Description
893 Origin Lgb, 27 May 97
896 \begin_layout Subsection*
900 \begin_layout Description
901 Action Start (or remove) Appendix on the given cursor position.
905 \begin_layout Description
909 \begin_layout Description
910 Origin ettrich, 5 May 1998
913 \begin_layout Subsection*
917 \begin_layout Description
918 Action Inserts Index entry.
922 \begin_layout Description
923 Notion It automatically takes the word on the cursor position.
927 \begin_layout Description
931 \begin_layout Description
932 Origin leeming, 3 Aug 2000
935 \begin_layout Subsection*
939 \begin_layout Description
940 Action Inserts list of Index entries on a new page.
944 \begin_layout Description
948 \begin_layout Description
949 Origin Lgb, 27 Feb 1997
952 \begin_layout Subsection*
956 \begin_layout Description
957 Action Inserts Nomenclature entry.
961 \begin_layout Description
962 Notion It automatically takes the word on the cursor position if no symbol
967 \begin_layout Description
968 Syntax nomencl-insert [<SYMBOL>]
971 \begin_layout Description
972 Origin Ugras, 4 Nov 2006
975 \begin_layout Subsection*
976 LFUN_NOMENCLATURE_PRINT
979 \begin_layout Description
980 Action Inserts list of Nomenclature entries.
984 \begin_layout Description
985 Syntax nomenclature-print
988 \begin_layout Description
989 Origin Ugras, 4 Nov 2006
992 \begin_layout Subsection*
996 \begin_layout Description
997 Action Inserts Note on the current cursor postion, move selection inside
1002 \begin_layout Description
1003 Syntax note-insert [<TYPE>]
1006 \begin_layout Description
1007 Params <TYPE>: <Note|Greyedout|Comment> default: Note
1010 \begin_layout Subsection*
1014 \begin_layout Description
1015 Action Moves the cursor to the begining of next Note inset.
1019 \begin_layout Description
1023 \begin_layout Subsection*
1027 \begin_layout Description
1028 Action Changes all Note insets of a particular type (source) to a different
1029 type (target) fot the current document.
1033 \begin_layout Description
1034 Syntax notes-mutate <SOURCE> <TARGET>
1037 \begin_layout Description
1038 Params <SOURCE/TARGET>: Note|Comment|Greyedout
1041 \begin_layout Description
1042 Origin sanda, 18 Jun 2008
1045 \begin_layout Subsection*
1049 \begin_layout Description
1050 Action Inserts a line break or new line.
1054 \begin_layout Description
1055 Syntax newline-insert [<ARG>]
1058 \begin_layout Description
1059 Params <ARG>: <newline|linebreak> default: newline
1062 \begin_layout Description
1063 Origin JSpitzm, 25 Mar 2008
1066 \begin_layout Subsection*
1070 \begin_layout Description
1071 Action Clears the selection.
1072 If no text is selected call LFUN_FINISHED_FORWARD.
1076 \begin_layout Description
1080 \begin_layout Description
1081 Origin Lgb, 17 May 2001
1084 \begin_layout Subsection*
1088 \begin_layout Description
1089 Action Moves the cursor one line in downward direction.
1093 \begin_layout Description
1097 \begin_layout Subsection*
1101 \begin_layout Description
1102 Action Moves the cursor one line in upward direction.
1106 \begin_layout Description
1110 \begin_layout Subsection*
1114 \begin_layout Description
1115 Action Moves the cursor one line in downward direction adding the current
1116 position to the selection.
1120 \begin_layout Description
1124 \begin_layout Subsection*
1128 \begin_layout Description
1129 Action Moves the cursor one line in upward direction adding the current
1130 position to the selection.
1134 \begin_layout Description
1138 \begin_layout Subsection*
1142 \begin_layout Description
1143 Action Moves the cursor one page in downward direction.
1147 \begin_layout Description
1151 \begin_layout Subsection*
1155 \begin_layout Description
1156 Action Moves the cursor one page in upward direction.
1160 \begin_layout Description
1164 \begin_layout Subsection*
1165 LFUN_SCREEN_DOWN_SELECT
1168 \begin_layout Description
1169 Action Moves the cursor one screen in downward direction adding the current
1170 position to the selection.
1174 \begin_layout Description
1175 Syntax screen-down-select
1178 \begin_layout Subsection*
1179 LFUN_SCREEN_UP_SELECT
1182 \begin_layout Description
1183 Action Moves the cursor one page in upward direction adding the current
1184 position to the selection.
1188 \begin_layout Description
1189 Syntax screen-up-select
1192 \begin_layout Subsection*
1196 \begin_layout Description
1197 Action Scroll the buffer view.
1201 \begin_layout Description
1202 Notion Only scrolls the screen up or down; does not move the cursor.
1206 \begin_layout Description
1207 Syntax scroll <TYPE> <QUANTITY>
1210 \begin_layout Description
1211 Params <TYPE>: line|page
1212 \begin_inset Newline newline
1215 <QUANTITY>: up|down|<number>
1218 \begin_layout Description
1219 Origin Abdel, Dec 27 2007
1222 \begin_layout Subsection*
1223 LFUN_SCREEN_RECENTER
1226 \begin_layout Description
1227 Action Recenters the screen on the current cursor position.
1231 \begin_layout Description
1232 Syntax screen-recenter
1235 \begin_layout Subsection*
1239 \begin_layout Description
1240 Action Moves the cursor one position logically backwards.
1244 \begin_layout Description
1245 Notion This is not the action which should be bound to the arrow keys, because
1246 backwards may be left or right, depending on the language.
1247 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1248 which in turn may employ this one.
1252 \begin_layout Description
1253 Syntax char-backward
1256 \begin_layout Subsection*
1257 LFUN_CHAR_BACKWARD_SELECT
1260 \begin_layout Description
1261 Action Moves the cursor one position logically backwards, adding traversed
1262 position to the selection.
1266 \begin_layout Description
1267 Notion See also LFUN_CHAR_BACKWARD.
1271 \begin_layout Description
1272 Syntax char-backward-select
1275 \begin_layout Subsection*
1276 LFUN_CHAR_DELETE_BACKWARD
1279 \begin_layout Description
1280 Action Deletes one character in the backward direction (usually the "BackSpace"
1285 \begin_layout Description
1286 Syntax char-delete-backward
1289 \begin_layout Subsection*
1290 LFUN_CHAR_DELETE_FORWARD
1293 \begin_layout Description
1294 Action Deletes one character in the backward direction (usually the "Delete"
1299 \begin_layout Description
1300 Syntax char-delete-forward
1303 \begin_layout Subsection*
1307 \begin_layout Description
1308 Action Moves the cursor one position logically forward.
1312 \begin_layout Description
1313 Notion This is not the action which should be bound to the arrow keys, because
1314 forward may be left or right, depending on the language.
1315 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1316 which in turn may employ this one.
1320 \begin_layout Description
1324 \begin_layout Subsection*
1325 LFUN_CHAR_FORWARD_SELECT
1328 \begin_layout Description
1329 Action Moves the cursor one position logically forward, adding traversed
1330 position to the selection.
1334 \begin_layout Description
1335 Notion See also LFUN_CHAR_FORWARD.
1339 \begin_layout Description
1340 Syntax char-forward-select
1343 \begin_layout Subsection*
1347 \begin_layout Description
1348 Action Moves the cursor one position "to the left".
1352 \begin_layout Description
1353 Notion This is the action which should be taken when the "left" key is pressed.
1354 Generally, it moves the cursor one position to the left.
1355 However, in Bidi text this become slightly more complicated, and there
1356 are different modes of cursor movement.
1357 In "visual mode", this moves left, plain and simple.
1358 In "logical mode", movement is logically forward in RTL paragraphs, and
1359 logically backwards in LTR paragraphs.
1363 \begin_layout Description
1367 \begin_layout Subsection*
1368 LFUN_CHAR_LEFT_SELECT
1371 \begin_layout Description
1372 Action Moves the cursor one position "to the left", adding traversed position
1377 \begin_layout Description
1378 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1382 \begin_layout Description
1383 Syntax char-left-select
1386 \begin_layout Subsection*
1390 \begin_layout Description
1391 Action Moves the cursor one position "to the right".
1395 \begin_layout Description
1396 Notion This is the action which should be taken when the "right" key is
1398 Generally, it moves the cursor one position to the right.
1399 However, in Bidi text this become slightly more complicated, and there
1400 are different modes of cursor movement.
1401 In "visual mode", this moves right, plain and simple.
1402 In "logical mode", movement is logically forward in LTR paragraphs, and
1403 logically backwards in RTL paragraphs.
1407 \begin_layout Description
1411 \begin_layout Subsection*
1412 LFUN_CHAR_RIGHT_SELECT
1415 \begin_layout Description
1416 Action Moves the cursor one position "to the right", adding traversed position
1421 \begin_layout Description
1422 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1426 \begin_layout Description
1427 Syntax char-right-select
1430 \begin_layout Subsection*
1434 \begin_layout Description
1435 Action Moves the cursor to the logically previous beginning of a word.
1439 \begin_layout Description
1440 Notion This is not the action which should be bound to the arrow keys, because
1441 backwards may be left or right, depending on the language.
1442 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1443 which in turn may employ this one.
1447 \begin_layout Description
1448 Syntax word-backward
1451 \begin_layout Subsection*
1452 LFUN_WORD_BACKWARD_SELECT
1455 \begin_layout Description
1456 Action Moves the cursor to the logically previous beginning of a word, adding
1457 the logically traversed text to the selection.
1461 \begin_layout Description
1462 Notion See also LFUN_WORD_BACKWARD.
1466 \begin_layout Description
1467 Syntax word-backward-select
1470 \begin_layout Subsection*
1471 LFUN_WORD_DELETE_BACKWARD
1474 \begin_layout Description
1475 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1480 \begin_layout Description
1481 Syntax word-delete-backward
1484 \begin_layout Subsection*
1485 LFUN_WORD_DELETE_FORWARD
1488 \begin_layout Description
1489 Action Deletes characters to the end of the word (usually the "C+Delete"
1494 \begin_layout Description
1495 Syntax word-delete-forward
1498 \begin_layout Subsection*
1499 LFUN_WORD_FIND_FORWARD
1502 \begin_layout Description
1503 Action Search for a given string in forward direction.
1507 \begin_layout Description
1508 Notion Case sensitive, match words.
1509 If no argument given, last search repeated.
1513 \begin_layout Description
1514 Syntax word-find-forward [<STRING>]
1517 \begin_layout Description
1518 Origin Etienne, 16 Feb 1998
1521 \begin_layout Subsection*
1522 LFUN_WORD_FIND_BACKWARD
1525 \begin_layout Description
1526 Action Search for a given string in backward direction.
1530 \begin_layout Description
1531 Notion Case sensitive, match words.
1532 If no argument given, last search repeated.
1536 \begin_layout Description
1537 Syntax word-find-backward [<STRING>]
1540 \begin_layout Description
1541 Origin Etienne, 20 Feb 1998
1544 \begin_layout Subsection*
1548 \begin_layout Description
1549 Action Search for next occurence of a string.
1553 \begin_layout Description
1554 Syntax word-find [<DATA>]
1557 \begin_layout Description
1558 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1559 If no parameter is given, search with last find-dialog data is used for
1565 \begin_layout Description
1566 Origin Andre, Jan 7 2004
1569 \begin_layout Subsection*
1573 \begin_layout Description
1574 Action Replace a string in the document.
1578 \begin_layout Description
1579 Syntax word-replace [<DATA>]
1582 \begin_layout Description
1583 Params <DATA>: data is of the form "<search>
1584 \begin_inset Newline newline
1588 \begin_inset Newline newline
1591 <casesensitive> <matchword> <all> <forward>"
1594 \begin_layout Description
1595 Origin Andre, Jan 7 2004
1598 \begin_layout Subsection*
1602 \begin_layout Description
1603 Action Moves the cursor to the logically next beginning of a word.
1607 \begin_layout Description
1608 Notion This is not the action which should be bound to the arrow keys, because
1609 forward may be left or right, depending on the language.
1610 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1611 which in turn may employ this one.
1615 \begin_layout Description
1619 \begin_layout Subsection*
1620 LFUN_WORD_FORWARD_SELECT
1623 \begin_layout Description
1624 Action Moves the cursor to the logically next beginning of a word, adding
1625 the logically traversed text to the selection.
1629 \begin_layout Description
1630 Notion See also LFUN_WORD_FORWARD.
1634 \begin_layout Description
1635 Syntax word-forward-select
1638 \begin_layout Subsection*
1642 \begin_layout Description
1643 Action Moves the cursor to the next beginning of a word "on the left".
1647 \begin_layout Description
1648 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1650 Generally, it moves the cursor to the next beginning of a word on the left.
1651 However, in Bidi text this become slightly more complicated, and there
1652 are different modes of cursor movement.
1653 In "visual mode", this moves left, plain and simple.
1654 In "logical mode", movement is logically forward in RTL paragraphs, and
1655 logically backwards in LTR paragraphs.
1659 \begin_layout Description
1663 \begin_layout Description
1664 Origin dov, 28 Oct 2007
1667 \begin_layout Subsection*
1668 LFUN_WORD_LEFT_SELECT
1671 \begin_layout Description
1672 Action Moves the cursor to the next beginning of a word "on the left", adding
1673 *logically* traversed text to the selection.
1677 \begin_layout Description
1678 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1682 \begin_layout Description
1683 Syntax word-left-select
1686 \begin_layout Description
1687 Origin dov, 28 Oct 2007
1690 \begin_layout Subsection*
1694 \begin_layout Description
1695 Action Moves the cursor to the next beginning of a word "on the right".
1699 \begin_layout Description
1700 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1702 Generally, it moves the cursor to the next beginning of a word on the right.
1703 However, in Bidi text this become slightly more complicated, and there
1704 are different modes of cursor movement.
1705 In "visual mode", this moves right, plain and simple.
1706 In "logical mode", movement is logically forward in LTR paragraphs, and
1707 logically backwards in RTL paragraphs.
1711 \begin_layout Description
1715 \begin_layout Description
1716 Origin dov, 28 Oct 2007
1719 \begin_layout Subsection*
1720 LFUN_WORD_RIGHT_SELECT
1723 \begin_layout Description
1724 Action Moves the cursor to the next beginning of a word "on the right",
1725 adding *logically* traversed text to the selection.
1729 \begin_layout Description
1730 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1734 \begin_layout Description
1735 Syntax word-right-select
1738 \begin_layout Description
1739 Origin dov, 28 Oct 2007
1742 \begin_layout Subsection*
1746 \begin_layout Description
1747 Action Puts the word where the cursor stands into the selection.
1751 \begin_layout Description
1755 \begin_layout Description
1756 Origin Andre, 11 Sep 2002
1759 \begin_layout Subsection*
1760 LFUN_WORD_CAPITALIZE
1763 \begin_layout Description
1764 Action Capitalizes the words in the selection (i.e.
1765 the first letters) or the letter on the cursor position.
1769 \begin_layout Description
1770 Syntax word-capitalize
1773 \begin_layout Subsection*
1777 \begin_layout Description
1778 Action Change the words in the selection or from the cursor position to
1779 the end of word to the upper case.
1783 \begin_layout Description
1787 \begin_layout Subsection*
1791 \begin_layout Description
1792 Action Change the words in the selection or from the cursor position to
1793 the end of word to the lower case.
1797 \begin_layout Description
1801 \begin_layout Subsection*
1802 LFUN_THESAURUS_ENTRY
1805 \begin_layout Description
1806 Action Look up thesaurus entries with respect to the word under the cursor.
1810 \begin_layout Description
1811 Syntax thesaurus-entry
1814 \begin_layout Description
1815 Origin Levon, 20 Jul 2001
1818 \begin_layout Subsection*
1822 \begin_layout Description
1823 Action Move the cursor to the beginning of the document.
1827 \begin_layout Description
1831 \begin_layout Subsection*
1832 LFUN_BUFFER_BEGIN_SELECT
1835 \begin_layout Description
1836 Action Move the cursor to the beginning of the document adding the traversed
1837 text to the selection.
1841 \begin_layout Description
1842 Syntax buffer-begin-select
1845 \begin_layout Subsection*
1849 \begin_layout Description
1850 Action Move the cursor to the end of the document.
1854 \begin_layout Description
1858 \begin_layout Subsection*
1859 LFUN_BUFFER_END_SELECT
1862 \begin_layout Description
1863 Action Move the cursor to the end of the document adding the traversed text
1868 \begin_layout Description
1869 Syntax buffer-end-select
1872 \begin_layout Subsection*
1876 \begin_layout Description
1877 Action Move the cursor to the begining of the (screen) line.
1881 \begin_layout Description
1885 \begin_layout Subsection*
1886 LFUN_LINE_BEGIN_SELECT
1889 \begin_layout Description
1890 Action Move the cursor to the beginning of the (screen) line adding the
1891 traversed text to the selection.
1895 \begin_layout Description
1896 Syntax line-begin-select
1899 \begin_layout Subsection*
1903 \begin_layout Description
1904 Action Move the cursor to the end of the (screen) line.
1908 \begin_layout Description
1912 \begin_layout Subsection*
1913 LFUN_LINE_END_SELECT
1916 \begin_layout Description
1917 Action Move the cursor to the end of the (screen) line adding the traversed
1918 text to the selection.
1922 \begin_layout Description
1923 Syntax line-end-select
1926 \begin_layout Subsection*
1930 \begin_layout Description
1931 Action Deletes the letters to the end of the (screen) line or deletes the
1936 \begin_layout Description
1937 Syntax line-delete-forward
1940 \begin_layout Subsection*
1944 \begin_layout Description
1945 Action Copies to the clipboard the last edit.
1949 \begin_layout Description
1953 \begin_layout Subsection*
1957 \begin_layout Description
1958 Action Cuts to the clipboard.
1962 \begin_layout Description
1966 \begin_layout Subsection*
1970 \begin_layout Description
1971 Action Pastes material from the active clipboard.
1975 \begin_layout Description
1976 Syntax paste [<TYPE>]
1979 \begin_layout Description
1980 Params <TYPE>: pdf|png|jpeg|linkback
1983 \begin_layout Subsection*
1984 LFUN_CLIPBOARD_PASTE
1987 \begin_layout Description
1988 Action Pastes text from the active clipboard.
1992 \begin_layout Description
1993 Syntax clipboard-paste [<ARG>]
1996 \begin_layout Description
1997 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2002 \begin_layout Description
2003 Origin baum, 10 Jul 2006
2006 \begin_layout Subsection*
2007 LFUN_PRIMARY_SELECTION_PASTE
2010 \begin_layout Description
2011 Action Pastes the currently text selected text.
2015 \begin_layout Description
2016 Notion Primary selection mechanism is linux-only thing.
2020 \begin_layout Description
2021 Syntax primary-selection-paste [<ARG>]
2024 \begin_layout Description
2025 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2030 \begin_layout Subsection*
2034 \begin_layout Description
2035 Action Undoes the last edit.
2039 \begin_layout Description
2043 \begin_layout Subsection*
2047 \begin_layout Description
2048 Action Redoes the last thing undone.
2052 \begin_layout Description
2056 \begin_layout Subsection*
2060 \begin_layout Description
2061 Action Repeat the given command.
2065 \begin_layout Description
2066 Syntax repeat <COUNT> <LFUN-COMMAND>
2069 \begin_layout Description
2070 Origin Andre, , 27 Oct 2003
2073 \begin_layout Subsection*
2074 LFUN_CHARS_TRANSPOSE
2077 \begin_layout Description
2078 Action Transposes the character at the cursor with the one before it.
2082 \begin_layout Description
2083 Syntax chars-transpose
2086 \begin_layout Description
2087 Origin Lgb, 25 Apr 2001
2090 \begin_layout Subsection*
2091 LFUN_DEPTH_DECREMENT
2094 \begin_layout Description
2095 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2100 \begin_layout Description
2101 Syntax depth-decrement
2104 \begin_layout Subsection*
2105 LFUN_DEPTH_INCREMENT
2108 \begin_layout Description
2109 Action Increase the nesting depth of the (selected) paragraph(s) inside
2114 \begin_layout Description
2115 Syntax depth-increment
2118 \begin_layout Subsection*
2122 \begin_layout Description
2123 Action Toggles the bold font (selection-wise) using mathbf in math.
2127 \begin_layout Description
2131 \begin_layout Subsection*
2132 LFUN_FONT_BOLDSYMBOL
2135 \begin_layout Description
2136 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2140 \begin_layout Description
2141 Syntax font-boldsymbol
2144 \begin_layout Subsection*
2145 LFUN_FONT_TYPEWRITER
2148 \begin_layout Description
2149 Action Toggles the typewriter family font (selection-wise).
2153 \begin_layout Description
2154 Syntax font-typewriter
2157 \begin_layout Subsection*
2161 \begin_layout Description
2162 Action Toggles underline in the font (selection-wise).
2166 \begin_layout Description
2167 Syntax font-underline
2170 \begin_layout Subsection*
2174 \begin_layout Description
2175 Action Toggles the emphasis font style (selection-wise).
2179 \begin_layout Description
2183 \begin_layout Subsection*
2187 \begin_layout Description
2188 Action Toggles Noun text style font (selection-wise).
2192 \begin_layout Description
2196 \begin_layout Subsection*
2200 \begin_layout Description
2201 Action Toggles Roman family font (selection-wise).
2205 \begin_layout Description
2209 \begin_layout Subsection*
2213 \begin_layout Description
2214 Action Toggles Sans Serif family font (selection-wise).
2218 \begin_layout Description
2222 \begin_layout Subsection*
2226 \begin_layout Description
2227 Action Toggles Fraktur family font (math-mode, selection-wise).
2231 \begin_layout Description
2235 \begin_layout Description
2236 Origin vermeer, 10 Jan 2002
2239 \begin_layout Subsection*
2243 \begin_layout Description
2244 Action Toggles Italics font shape (math-mode, selection-wise).
2248 \begin_layout Description
2252 \begin_layout Description
2253 Origin vermeer, 10 Jan 2002
2256 \begin_layout Subsection*
2260 \begin_layout Description
2261 Action Reverts the settings of the font to the default values (selection-wise).
2265 \begin_layout Description
2269 \begin_layout Subsection*
2273 \begin_layout Description
2274 Action Sets font size according to lyx format string.
2278 \begin_layout Description
2279 Syntax font-size <SIZE>
2282 \begin_layout Description
2283 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2284 \begin_inset Newline newline
2287 largest|huge|giant|increase|decrease|default
2290 \begin_layout Subsection*
2291 LFUN_TEXTSTYLE_APPLY
2294 \begin_layout Description
2295 Action Toggle user-defined (=last-time used) text style.
2299 \begin_layout Description
2300 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2301 trigerred when using Text Style dialog.
2305 \begin_layout Description
2306 Syntax textstyle-apply
2309 \begin_layout Description
2310 Origin leeming, 12 Mar 2003
2313 \begin_layout Subsection*
2314 LFUN_TEXTSTYLE_UPDATE
2317 \begin_layout Description
2318 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2323 \begin_layout Description
2324 Syntax textstyle-update <FONT_INFO>
2327 \begin_layout Description
2328 Params <FONT_INFO>: specifies font atributes, e.g.
2329 family, series, shape, size, emph, noun, underbar, number, color, language,
2332 \begin_inset Newline newline
2335 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2339 \begin_layout Description
2340 Origin leeming, 12 Mar 2003
2343 \begin_layout Subsection*
2344 LFUN_SCREEN_FONT_UPDATE
2347 \begin_layout Description
2348 Action Update fonts and its metrics.
2352 \begin_layout Description
2353 Notion Automatically called after zoom, dpi, font names, or norm change.
2357 \begin_layout Description
2358 Syntax screen-font-update
2361 \begin_layout Description
2362 Origin ARRae, 13 Aug 2000
2365 \begin_layout Subsection*
2369 \begin_layout Description
2370 Action Returns the info about the current font.
2374 \begin_layout Description
2378 \begin_layout Subsection*
2379 LFUN_CITATION_INSERT
2382 \begin_layout Description
2383 Action Inserts citation from loaded citation database.
2387 \begin_layout Description
2388 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2391 \begin_layout Description
2392 Params <KEY>: Citation (shortcut listed in available citations).
2394 \begin_inset Newline newline
2397 <TEXT_BEFORE>: text which should appear before citation.
2401 \begin_layout Description
2402 Origin AAS, 97-02-23
2405 \begin_layout Subsection*
2406 LFUN_BIBTEX_DATABASE_ADD
2409 \begin_layout Description
2410 Action Adds database, which will be used for bibtex citations.
2414 \begin_layout Description
2415 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2416 bibliography) found from the cursor postion.
2420 \begin_layout Description
2421 Syntax bibtex-database-add <DATABASE-NAME>
2424 \begin_layout Description
2425 Origin Ale, 30 May 1997
2428 \begin_layout Subsection*
2429 LFUN_BIBTEX_DATABASE_DEL
2432 \begin_layout Description
2433 Action Adds database, which will be used for bibtex citations.
2437 \begin_layout Description
2438 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2439 X bibliography) found from the cursor postion.
2443 \begin_layout Description
2444 Syntax bibtex-database-del <DATABASE-NAME>
2447 \begin_layout Description
2448 Origin Ale, 30 May 1997
2451 \begin_layout Subsection*
2455 \begin_layout Description
2456 Action Sets the layout (that is, environment) for the current paragraph.
2460 \begin_layout Description
2461 Syntax layout <LAYOUT>
2464 \begin_layout Description
2465 Params <LAYOUT>: the layout to use
2468 \begin_layout Subsection*
2469 LFUN_LAYOUT_PARAGRAPH
2472 \begin_layout Description
2473 Action Launches the paragraph settings dialog.
2477 \begin_layout Description
2478 Syntax layout-paragraph
2481 \begin_layout Subsection*
2485 \begin_layout Description
2486 Action Launches the tabular settings dialog.
2490 \begin_layout Description
2491 Syntax layout-tabular
2494 \begin_layout Description
2495 Origin Jug, 31 Jul 2000
2498 \begin_layout Subsection*
2499 LFUN_DROP_LAYOUTS_CHOICE
2502 \begin_layout Description
2503 Action Displays list of layout choices.
2507 \begin_layout Description
2508 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2509 allowing for choice of layout.
2513 \begin_layout Description
2514 Syntax drop-layouts-choice
2517 \begin_layout Subsection*
2518 LFUN_LAYOUT_MODULES_CLEAR
2521 \begin_layout Description
2522 Action Clears the module list.
2526 \begin_layout Description
2527 Notion Clears the list of included modules for the current buffer.
2531 \begin_layout Description
2532 Syntax layout-modules-clear
2535 \begin_layout Description
2536 Origin rgh, 25 August 2007
2539 \begin_layout Subsection*
2540 LFUN_LAYOUT_MODULE_ADD
2543 \begin_layout Description
2544 Action Adds a module.
2548 \begin_layout Description
2549 Notion Adds a module to the list of included modules for the current buffer.
2553 \begin_layout Description
2554 Syntax layout-module-add <MODULE>
2557 \begin_layout Description
2558 Params <MODULE>: the module to be added
2561 \begin_layout Description
2562 Origin rgh, 25 August 2007
2565 \begin_layout Subsection*
2569 \begin_layout Description
2570 Action Reloads layout information.
2574 \begin_layout Description
2575 Notion Reloads all layout information for the current buffer from disk,
2576 thus recognizing any changes that have been made to layout files on the
2578 This is intended to be used only by layout developers and should not be
2579 used when one is trying to do actual work.
2583 \begin_layout Description
2584 Syntax layout-reload
2587 \begin_layout Description
2588 Origin rgh, 3 September 2007
2591 \begin_layout Subsection*
2592 LFUN_TEXTCLASS_APPLY
2595 \begin_layout Description
2596 Action Sets the text class for the current buffer.
2600 \begin_layout Description
2601 Syntax textclass-apply <TEXTCLASS>
2604 \begin_layout Description
2605 Params <TEXTCLASS>: the textclass to set.
2606 Note that this must be the filename, minus the ".layout" extension.
2610 \begin_layout Subsection*
2614 \begin_layout Description
2615 Action Loads information for a textclass from disk.
2619 \begin_layout Description
2620 Syntax textclass-load <TEXTCLASS>
2623 \begin_layout Description
2624 Params <TEXTCLASS>: the textclass to load.
2625 Note that this must be the filename, minus the ".layout" extension.
2629 \begin_layout Subsection*
2633 \begin_layout Description
2634 Action Disable selecting of text-region.
2638 \begin_layout Description
2642 \begin_layout Subsection*
2646 \begin_layout Description
2647 Action Enable selecting of text-region.
2651 \begin_layout Description
2652 Notion After enabling you can simply move arrow keys to get selected region.
2656 \begin_layout Description
2660 \begin_layout Subsection*
2664 \begin_layout Description
2665 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2669 \begin_layout Description
2673 \begin_layout Description
2674 Origin Andre, May 5 2006
2677 \begin_layout Subsection*
2681 \begin_layout Description
2682 Action Inserts math delimiters (e.g.
2683 parentheses, brackets) enclosing expression.
2687 \begin_layout Description
2688 Syntax math-delim [<LEFT>] [<RIGHT>]
2691 \begin_layout Description
2692 Params <LEFT/RIGHT>: Delimiters to be used.
2693 Each delimiter can be specified by either a LaTeX name or a valid character.
2694 ( is the default letter.
2698 \begin_layout Description
2699 Sample math-delim { rangle
2702 \begin_layout Description
2703 Origin Alejandro, 18 Jun 1996
2706 \begin_layout Subsection*
2710 \begin_layout Description
2711 Action Inserts math fixed size delimiters (e.g.
2712 parentheses, brackets) enclosing expression.
2716 \begin_layout Description
2717 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2720 \begin_layout Description
2721 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2722 \begin_inset Newline newline
2725 <L/RDELIM>: TeX code for delimiter.
2726 See Delimiter dialog for delimiters to be used.
2730 \begin_layout Description
2731 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2734 \begin_layout Description
2735 Origin Enrico & Georg, 7 May 2006
2738 \begin_layout Subsection*
2742 \begin_layout Description
2743 Action Creates a new displayed equation in text mode.
2744 Toggles inlined/display formula in math mode.
2748 \begin_layout Description
2749 Syntax math-display [<ARG>]
2752 \begin_layout Description
2753 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2754 new equation from the text mode.
2758 \begin_layout Description
2759 Origin Alejandro, 18 Jun 1996
2762 \begin_layout Subsection*
2766 \begin_layout Description
2767 Action Inserts math objects and symbols.
2771 \begin_layout Description
2772 Syntax math-insert <ARG>
2775 \begin_layout Description
2776 Params <ARG>: Symbol or LaTeX code to be inserted.
2780 \begin_layout Subsection*
2784 \begin_layout Description
2785 Action Enters subscript expression in math expression.
2789 \begin_layout Description
2790 Syntax math-subscript
2793 \begin_layout Description
2794 Origin vermeer, 12 Dec 2001
2797 \begin_layout Subsection*
2798 LFUN_MATH_SUPERSCRIPT
2801 \begin_layout Description
2802 Action Enters subscript expression in math expression.
2806 \begin_layout Description
2807 Syntax math-superscript
2810 \begin_layout Description
2811 Origin vermeer, 12 Dec 2001
2814 \begin_layout Subsection*
2818 \begin_layout Description
2819 Action Toggles the position of the limits from above/below to the right
2820 side an vice versa in integral symbol, a limit, a summation, etc.
2824 \begin_layout Description
2825 Notion Put the cursor before the symbol with the limits and then invoke
2830 \begin_layout Description
2831 Syntax math-limits [<STATE>]
2834 \begin_layout Description
2835 Params <STATE>: limits|nolimits
2838 \begin_layout Subsection*
2842 \begin_layout Description
2843 Action Inserts a math macro definition at the cursor position in the text.
2847 \begin_layout Description
2848 Syntax math-macro <NAME> [<NARGS>] [def]
2851 \begin_layout Description
2852 Params <NAME>: The name of the macro, e.g.
2854 <NARGS>: The number of parameters of the macro.
2856 "def": Has no effect anymore, just for compatibility with former LyX versions.
2860 \begin_layout Description
2861 Origin ale, 10 May 1997; sts, 21 Dec 2007
2864 \begin_layout Subsection*
2868 \begin_layout Description
2869 Action Mutates the type of math inset to the newly selected one.
2873 \begin_layout Description
2874 Syntax math-mutate <TYPE>
2877 \begin_layout Description
2878 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2879 multline|gather|flalign
2882 \begin_layout Description
2883 Origin Andre, 23 May 2001
2886 \begin_layout Subsection*
2890 \begin_layout Description
2891 Action Inserts space into math expression.
2895 \begin_layout Description
2896 Notion Use spacebar after entering this space to change type of space.
2900 \begin_layout Description
2901 Syntax math-space [<TYPE>]
2904 \begin_layout Description
2905 Params <TYPE>: negative spaces: !|negmedspace|negthickspace
2906 \begin_inset Newline newline
2909 positive spaces: ,|:|;|quad|qquad
2910 \begin_inset Newline newline
2913 "," used by default.
2917 \begin_layout Description
2918 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2921 \begin_layout Subsection*
2925 \begin_layout Description
2926 Action Inserts a matrix.
2930 \begin_layout Description
2931 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2934 \begin_layout Description
2935 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
2937 1 char) and the horizontal alignments (l, c or r) (i.e.
2942 \begin_layout Description
2943 Sample math-matrix 3 3 bccc
2946 \begin_layout Subsection*
2950 \begin_layout Description
2951 Action In text mode enters math mode (i.e.
2952 puts math insets on the current cursor position), in math mode enters text
2953 mode inside math expression.
2957 \begin_layout Description
2958 Notion If there is some selected text, it puts the text inside created math
2963 \begin_layout Description
2964 Syntax math-mode [<ARG>]
2967 \begin_layout Description
2968 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
2973 \begin_layout Description
2974 Origin Alejandro, 4 Jun 1996
2977 \begin_layout Subsection*
2978 LFUN_MATH_NUMBER_LINE_TOGGLE
2981 \begin_layout Description
2982 Action Toggles numbering of the current formula line.
2986 \begin_layout Description
2987 Notion Must be in display formula mode.
2991 \begin_layout Description
2992 Syntax math-number-line-toggle
2995 \begin_layout Description
2996 Origin Alejandro, 18 Jun 1996
2999 \begin_layout Subsection*
3000 LFUN_MATH_NUMBER_TOGGLE
3003 \begin_layout Description
3004 Action Toggles numbering/labeling of the current formula.
3008 \begin_layout Description
3009 Notion Must be in display formula mode.
3013 \begin_layout Description
3014 Syntax math-number-toggle
3017 \begin_layout Description
3018 Origin Alejandro, 4 Jun 1996
3021 \begin_layout Subsection*
3025 \begin_layout Description
3026 Action Calls external program and passes the current expression/equation
3027 as an argument for the calculation in the format appropriate to the given
3032 \begin_layout Description
3033 Notion Selection can be used to determine the input for the external program.
3037 \begin_layout Description
3038 Syntax math-extern <LANG> [<COMMAND>]
3041 \begin_layout Description
3042 Params <LANG>: octave|maxima|maple|mathematica|script
3043 \begin_inset Newline newline
3046 where "script" stands fot the external script (normalized expression will
3050 \begin_layout Description
3051 Origin Andre, 24 Apr 2001
3054 \begin_layout Description
3055 Sample math-extern maple simplify
3058 \begin_layout Subsection*
3062 \begin_layout Description
3063 Action Changes arbitrarily the size used by math fonts inside a context.
3067 \begin_layout Description
3068 Notion Provides an interface to the LaTeX math mode font size commands.
3072 \begin_layout Description
3073 Syntax math-size <STYLE>
3076 \begin_layout Description
3077 Params <STYLE>: displaystyle|
3086 \begin_layout Description
3087 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3090 \begin_layout Subsection*
3091 LFUN_MATH_MACRO_UNFOLD
3094 \begin_layout Description
3095 Action Unfold a Math Macro.
3099 \begin_layout Description
3100 Notion Unfold the Math Macro the cursor is in, i.e.
3105 \begin_layout Description
3106 Syntax math-macro-unfold
3109 \begin_layout Description
3110 Origin sts, 06 January 2008
3113 \begin_layout Subsection*
3114 LFUN_MATH_MACRO_FOLD
3117 \begin_layout Description
3118 Action Fold a Math Macro.
3122 \begin_layout Description
3123 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3124 displayed as foo before.
3128 \begin_layout Description
3129 Syntax math-macro-fold
3132 \begin_layout Description
3133 Origin sts, 06 January 2008
3136 \begin_layout Subsection*
3137 LFUN_MATH_MACRO_ADD_PARAM
3140 \begin_layout Description
3141 Action Add a parameter.
3145 \begin_layout Description
3146 Notion Add a parameter to a Math Macro.
3150 \begin_layout Description
3151 Params <NUM>: The number of the parameter behind which the new one will
3152 be added (1 for the first, i.e.
3153 use 0 for add a parameter at the left), defaults to the last one.
3157 \begin_layout Description
3158 Syntax math-macro-add-param <NUM>
3161 \begin_layout Description
3162 Origin sts, 06 January 2008
3165 \begin_layout Subsection*
3166 LFUN_MATH_MACRO_REMOVE_PARAM
3169 \begin_layout Description
3170 Action Remove the last parameter.
3174 \begin_layout Description
3175 Notion Remove the last parameter of a Math Macro and remove its value in
3176 all instances of the macro in the buffer.
3180 \begin_layout Description
3181 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3182 defaults to the last one.
3186 \begin_layout Description
3187 Syntax math-macro-remove-param <NUM>
3190 \begin_layout Description
3191 Origin sts, 06 January 2008
3194 \begin_layout Subsection*
3195 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3198 \begin_layout Description
3199 Action Append a greedy parameter.
3203 \begin_layout Description
3204 Notion Append a greedy parameter to a Math Macro which eats the following
3205 mathed cell in every instance of the macro in the buffer.
3209 \begin_layout Description
3210 Syntax math-macro-append-greedy-param
3213 \begin_layout Description
3214 Origin sts, 06 January 2008
3217 \begin_layout Subsection*
3218 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3221 \begin_layout Description
3222 Action Remove a greedy parameter.
3226 \begin_layout Description
3227 Notion Remove a greedy parameter of a Math Macro and spit out the values
3228 of it in every instance of the macro in the buffer.
3229 If it is an optional parameter the [valud] format is used.
3233 \begin_layout Description
3234 Syntax math-macro-remove-greedy-param
3237 \begin_layout Description
3238 Origin sts, 06 January 2008
3241 \begin_layout Subsection*
3242 LFUN_MATH_MACRO_MAKE_OPTIONAL
3245 \begin_layout Description
3246 Action Make a parameter optional.
3250 \begin_layout Description
3251 Notion Turn the first non-optional parameter of a Math Macro into an optional
3252 parameter with a default value.
3256 \begin_layout Description
3257 Syntax math-macro-make-optional
3260 \begin_layout Description
3261 Origin sts, 06 January 2008
3264 \begin_layout Subsection*
3265 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3268 \begin_layout Description
3269 Action Make a parameter non-optional.
3273 \begin_layout Description
3274 Notion Turn the last optional parameter of a Math Macro into a non-optional
3276 The default value is remembered to be reused later if the user changes
3281 \begin_layout Description
3282 Syntax math-macro-make-nonoptional
3285 \begin_layout Description
3286 Origin sts, 06 January 2008
3289 \begin_layout Subsection*
3290 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3293 \begin_layout Description
3294 Action Add an optional parameter.
3298 \begin_layout Description
3299 Notion Insert an optional parameter just behind the already existing optional
3304 \begin_layout Description
3305 Syntax math-macro-add-optional-param
3308 \begin_layout Description
3309 Origin sts, 06 January 2008
3312 \begin_layout Subsection*
3313 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3316 \begin_layout Description
3317 Action Remove the last optional parameter.
3321 \begin_layout Description
3322 Notion Remove the last optional parameter of a Math Macro and remove it
3323 in all the instances of the macro in the buffer.
3327 \begin_layout Description
3328 Syntax math-macro-remove-optional-param
3331 \begin_layout Description
3332 Origin sts, 06 January 2008
3335 \begin_layout Subsection*
3336 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3339 \begin_layout Description
3340 Action Add a greedy optional parameter.
3344 \begin_layout Description
3345 Notion Add a greedy optional parameter which eats the value from the following
3346 cells in mathed which are in the [value] format.
3350 \begin_layout Description
3351 Syntax math-macro-add-greedy-optional-param
3354 \begin_layout Description
3355 Origin sts, 06 January 2008
3358 \begin_layout Subsection*
3359 LFUN_IN_MATHMACROTEMPLATE
3362 \begin_layout Description
3363 Action Only active in Math Macro definition.
3367 \begin_layout Description
3368 Notion Dummy function which is only active in a Math Macro definition.
3369 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3374 \begin_layout Description
3375 Syntax in-mathmacrotemplate
3378 \begin_layout Description
3379 Origin sts, 06 January 2008
3382 \begin_layout Subsection*
3383 LFUN_PARAGRAPH_MOVE_DOWN
3386 \begin_layout Description
3387 Action Moves the current paragraph downwards in the document.
3391 \begin_layout Description
3392 Syntax paragraph-move-down
3395 \begin_layout Description
3396 Origin Edwin, 8 Apr 2006
3399 \begin_layout Subsection*
3400 LFUN_PARAGRAPH_MOVE_UP
3403 \begin_layout Description
3404 Action Moves the current paragraph upwards in the document.
3408 \begin_layout Description
3409 Syntax paragraph-move-up
3412 \begin_layout Description
3413 Origin Edwin, 8 Apr 2006
3416 \begin_layout Subsection*
3420 \begin_layout Description
3421 Action Move the cursor to the next paragraph (or begining of the current
3422 one) in upward direction.
3426 \begin_layout Description
3430 \begin_layout Description
3431 Origin Asger, 1 Oct 1996
3434 \begin_layout Subsection*
3435 LFUN_PARAGRAPH_UP_SELECT
3438 \begin_layout Description
3439 Action Move the cursor and select the text to the next paragraph (or begining
3440 of the current one) in upward direction.
3444 \begin_layout Description
3445 Syntax paragraph-up-select
3448 \begin_layout Description
3449 Origin Asger, 1 Oct 1996
3452 \begin_layout Subsection*
3456 \begin_layout Description
3457 Action Move the cursor to the next paragraph (or begining of the current
3458 one) in downward direction.
3462 \begin_layout Description
3463 Syntax paragraph-down
3466 \begin_layout Description
3467 Origin Asger, 1 Oct 1996
3470 \begin_layout Subsection*
3471 LFUN_PARAGRAPH_DOWN_SELECT
3474 \begin_layout Description
3475 Action Move the cursor and select the text to the next paragraph (or begining
3476 of the current one) in downward direction.
3480 \begin_layout Description
3481 Syntax paragraph-down-select
3484 \begin_layout Description
3485 Origin Asger, 1 Oct 1996
3488 \begin_layout Subsection*
3492 \begin_layout Description
3493 Action Jump to a paragraph given by its id number and optionally the desired
3494 position within the paragraph.
3498 \begin_layout Description
3499 Notion Note that id number of paragraph is not the sequential number of
3500 paragraph seen on the screen.
3501 Moreover the id is unique for all opened buffers (documents).
3505 \begin_layout Description
3506 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3509 \begin_layout Description
3510 Params <PAR_ID_NUMBER>: paragraph id
3511 \begin_inset Newline newline
3514 <POSITION_IN_PAR>: desired position within the paragraph
3517 \begin_layout Description
3518 Origin Dekel, 26 Aug 2000
3521 \begin_layout Subsection*
3522 LFUN_BREAK_PARAGRAPH
3525 \begin_layout Description
3526 Action Breaks the current paragraph at the current location.
3530 \begin_layout Description
3531 Syntax break-paragraph
3534 \begin_layout Subsection*
3535 LFUN_BREAK_PARAGRAPH
3538 \begin_layout Description
3539 Action Breaks the current paragraph at the current location.
3543 \begin_layout Description
3544 Notion Removes the selection.
3548 \begin_layout Description
3549 Syntax break-paragraph [<LAYOUT>]
3552 \begin_layout Description
3553 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3554 default layout) when the cursor is at the end of the line.
3558 \begin_layout Subsection*
3559 LFUN_PARAGRAPH_PARAMS
3562 \begin_layout Description
3563 Action Change paragraph settings.
3567 \begin_layout Description
3568 Notion Modifies the current paragraph, or currently selected paragraphs.
3569 This function only modifies, and does not override, existing settings.
3570 Note that the "leftindent" indent setting is deprecated.
3574 \begin_layout Description
3575 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3578 \begin_layout Description
3588 \begin_inset Newline newline
3593 paragraph_spacing default|single|onehalf|double|other
3594 \begin_inset Newline newline
3599 align block|left|right|center|default
3600 \begin_inset Newline newline
3605 labelwidthstring WIDTH|
3608 \begin_inset Newline newline
3614 \begin_layout Description
3615 Origin rgh, Aug 15 2007
3618 \begin_layout Subsection*
3619 LFUN_PARAGRAPH_PARAMS_APPLY
3622 \begin_layout Description
3623 Action Change paragraph settings.
3627 \begin_layout Description
3628 Notion Overwrite all nonspecified settings to the default ones.
3629 Use paragraph-params lfun if you don't want to overwrite others settings.
3633 \begin_layout Description
3634 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3637 \begin_layout Description
3638 Params For parameters see LFUN_PARAGRAPH_PARAMS
3641 \begin_layout Description
3642 Origin leeming, 30 Mar 2004
3645 \begin_layout Subsection*
3646 LFUN_PARAGRAPH_UPDATE
3649 \begin_layout Description
3650 Action Updates the values inside the paragraph dialog from the paragraph.
3654 \begin_layout Description
3655 Notion This is internal LFUN, not to be used by users.
3656 Called internally by LFUN_DIALOG_UPDATE.
3660 \begin_layout Description
3661 Origin leeming, 13 Mar 2003
3664 \begin_layout Subsection*
3668 \begin_layout Description
3669 Action Move the current group in the upward direction in the structure of
3674 \begin_layout Description
3675 Notion The "group" can be Part/Chapter/Section/etc.
3676 It moves the whole substructure of the group.
3680 \begin_layout Description
3684 \begin_layout Description
3685 Origin Vermeer, 23 Mar 2006
3688 \begin_layout Subsection*
3692 \begin_layout Description
3693 Action Move the current group in the downward direction in the structure
3698 \begin_layout Description
3699 Notion The "group" can be Part/Chapter/Section/etc.
3700 It moves the whole substructure of the group.
3704 \begin_layout Description
3708 \begin_layout Description
3709 Origin Vermeer, 23 Mar 2006
3712 \begin_layout Subsection*
3716 \begin_layout Description
3717 Action Moves the current group in the downward direction in the hierarchy
3718 of the document structure.
3722 \begin_layout Description
3723 Notion Part -> Chapter -> Section -> etc.
3727 \begin_layout Description
3731 \begin_layout Description
3732 Origin Vermeer, 23 Mar 2006
3735 \begin_layout Subsection*
3739 \begin_layout Description
3740 Action Moves the current group in the upward direction in the hierarchy
3741 of the document structure.
3745 \begin_layout Description
3746 Notion Part <- Chapter <- Section <- etc.
3750 \begin_layout Description
3754 \begin_layout Description
3755 Origin Vermeer, 23 Mar 2006
3758 \begin_layout Subsection*
3762 \begin_layout Description
3763 Action Edit the inset at cursor with an external application, *
3764 if one is attributed.
3768 \begin_layout Description
3769 Syntax inset-edit [<INSET_PARAMS>]
3772 \begin_layout Description
3773 Params <INSET_PARAMS>: Parameters for the inset.
3775 \begin_inset Newline newline
3778 Currently only the filename will be considered.
3782 \begin_layout Description
3783 Origin JSpitzm, 27 Apr 2006
3786 \begin_layout Subsection*
3790 \begin_layout Description
3791 Action Inserts table into the document.
3795 \begin_layout Description
3796 Syntax tabular-insert [<ROWS> <COLUMNS>]
3799 \begin_layout Description
3800 Params In case no arguments are given show insert dialog.
3804 \begin_layout Description
3805 Origin Jug, 12 Apr 2000
3808 \begin_layout Subsection*
3809 LFUN_TABULAR_FEATURE
3812 \begin_layout Description
3813 Action Sets various features to the table/cell on the current cursor position.
3817 \begin_layout Description
3818 Notion Various math-environment features are handled here as well, e.g.
3819 add-vline-left/right for Grid/Cases environment
3822 \begin_layout Description
3823 Syntax tabular-feature <FEATURE> [<ARG>]
3826 \begin_layout Description
3827 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3828 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3829 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3830 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3831 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3832 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3833 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3834 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3835 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3836 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3837 |set-bottom-space|set-interline-space|set-border-lines
3838 \begin_inset Newline newline
3841 <ARG>: additional argument for some commands, use debug mode to explore
3846 \begin_layout Description
3847 Origin Jug, 28 Jul 2000
3850 \begin_layout Subsection*
3854 \begin_layout Description
3855 Action Moves the cursor to the previous cell inside the table.
3859 \begin_layout Description
3860 Syntax cell-backward
3863 \begin_layout Description
3864 Origin Jug, 22 May 2000
3867 \begin_layout Subsection*
3871 \begin_layout Description
3872 Action Moves the cursor to the next cell inside the table.
3876 \begin_layout Description
3880 \begin_layout Subsection*
3884 \begin_layout Description
3885 Action Splits cell and shifts right part to the next cell (inside the math
3890 \begin_layout Description
3894 \begin_layout Description
3895 Origin Ale, 15 May 1997
3898 \begin_layout Subsection*
3902 \begin_layout Description
3903 Action Register the document as an file inside version control system (RCS,
3908 \begin_layout Description
3909 Notion File is registered inside cvs, svn or rcs repository acording to
3910 the existence of cvs/svn/rcs entries in the document's directory.
3912 \begin_inset Newline newline
3915 See LyX Extended Manual (Version Control Chapter) for additional information.
3919 \begin_layout Description
3923 \begin_layout Description
3924 Origin Lgb, 1 Jul 1997
3927 \begin_layout Subsection*
3931 \begin_layout Description
3932 Action Checks-in/commits the changes of the registered file to the repository.
3936 \begin_layout Description
3937 Notion In RCS case this also unlocks the file.
3941 \begin_layout Description
3945 \begin_layout Description
3946 Origin Lgb, 1 Jul 1997
3949 \begin_layout Subsection*
3953 \begin_layout Description
3954 Action Checks-out the document for edit (and locks it for RCS).
3958 \begin_layout Description
3959 Notion This is implemented only for RCS and SVN, not CVS.
3963 \begin_layout Description
3967 \begin_layout Description
3968 Origin Lgb, 1 Jul 1997
3971 \begin_layout Subsection*
3975 \begin_layout Description
3976 Action Reverts the document to the last check-in/commit in VCS.
3980 \begin_layout Description
3984 \begin_layout Description
3985 Origin Lgb, 1 Jul 1997
3988 \begin_layout Subsection*
3992 \begin_layout Description
3993 Action Undo last check-in.
3997 \begin_layout Description
3998 Notion This is currently implemented only for RCS.
4002 \begin_layout Description
4006 \begin_layout Description
4007 Origin Lgb, 1 Jul 1997
4010 \begin_layout Subsection*
4014 \begin_layout Description
4015 Action Toggles change tracking to on/off.
4019 \begin_layout Description
4020 Syntax changes-track
4023 \begin_layout Description
4024 Origin levon, 1 Oct 2002
4027 \begin_layout Subsection*
4031 \begin_layout Description
4032 Action Toggles showing of change tracking in typesetted output.
4036 \begin_layout Description
4037 Syntax changes-output
4040 \begin_layout Description
4041 Origin jspitzm, 21 Jan 2005
4044 \begin_layout Subsection*
4048 \begin_layout Description
4049 Action Moves the cursor to the position of the next change of the change
4054 \begin_layout Description
4058 \begin_layout Description
4059 Origin schmitt, 4 Oct 2006
4062 \begin_layout Subsection*
4066 \begin_layout Description
4067 Action Open change tracking dialog for merging and moves the cursor to the
4068 position of the next change.
4072 \begin_layout Description
4073 Syntax changes-merge
4076 \begin_layout Description
4077 Origin Levon, 16 Oct 2002
4080 \begin_layout Subsection*
4084 \begin_layout Description
4085 Action Accepts tracked change inside the selection.
4089 \begin_layout Description
4090 Syntax change-accept
4093 \begin_layout Description
4094 Origin Levon, 16 Oct 2002
4097 \begin_layout Subsection*
4101 \begin_layout Description
4102 Action Rejects tracked change inside the selection.
4106 \begin_layout Description
4107 Syntax change-accept
4110 \begin_layout Description
4111 Origin Levon, 16 Oct 2002
4114 \begin_layout Subsection*
4115 LFUN_ALL_CHANGES_ACCEPT
4118 \begin_layout Description
4119 Action Accepts all tracked changes in the document.
4123 \begin_layout Description
4124 Syntax all-changes-accept
4127 \begin_layout Description
4128 Origin Levon, 16 Oct 2002
4131 \begin_layout Subsection*
4132 LFUN_ALL_CHANGES_REJECT
4135 \begin_layout Description
4136 Action Rejects all tracked changes in the document.
4140 \begin_layout Description
4141 Notion Reject does not work recursively; the user may have to repeat the
4146 \begin_layout Description
4147 Syntax all-changes-reject
4150 \begin_layout Description
4151 Origin Levon, 16 Oct 2002
4154 \begin_layout Subsection*
4158 \begin_layout Description
4159 Action Apply data for an inset.
4163 \begin_layout Description
4164 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4166 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4167 on the context where it is called.
4171 \begin_layout Description
4172 Syntax inset-apply <ARGS>
4175 \begin_layout Description
4176 Params See LFUN_INSET_INSERT .
4180 \begin_layout Subsection*
4184 \begin_layout Description
4185 Action Dissolve the current inset into text.
4189 \begin_layout Description
4190 Syntax inset-dissolve [<INSET>]
4193 \begin_layout Description
4194 Params <INSET>: this can be used to make sure the right kind of inset is
4196 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4197 the charstyle inset, even if the cursor is inside several nested insets
4200 \begin_inset Newline newline
4203 For values see lyx::InsetLayout::lyxtype_ .
4207 \begin_layout Description
4208 Origin JSpitz, 7 Aug 2006
4211 \begin_layout Subsection*
4215 \begin_layout Description
4216 Action Insert new inset (type given by the parameters).
4220 \begin_layout Description
4221 Syntax inset-insert <INSET> <ARGS>
4224 \begin_layout Description
4225 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4226 nclude|index|label|nomencl|vspace|ref|toc>
4227 \begin_inset Newline newline
4230 <ARGS>: depends on the given inset.
4231 Use "lyx -dbg action" to explore.
4235 \begin_layout Description
4236 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4239 \begin_inset Newline newline
4242 where <label name> is the name of the referenced label and<Format> is one
4244 \begin_inset Newline newline
4248 \begin_inset Newline newline
4251 eqref -- (<reference>)
4252 \begin_inset Newline newline
4256 \begin_inset Newline newline
4259 vpageref -- on <page>
4260 \begin_inset Newline newline
4263 vref -- <reference> on <page>
4264 \begin_inset Newline newline
4267 prettyref -- Formatted reference
4270 \begin_layout Subsection*
4274 \begin_layout Description
4275 Action Modify existing inset.
4279 \begin_layout Description
4280 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4281 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4286 \begin_layout Description
4287 Syntax inset-modify <INSET> <ARGS>
4290 \begin_layout Description
4291 Params See LFUN_INSET_INSERT for further details.
4295 \begin_layout Subsection*
4296 LFUN_NEXT_INSET_MODIFY
4299 \begin_layout Description
4300 Action Modify the inset at cursor position, if there is one.
4304 \begin_layout Description
4305 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4306 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4311 \begin_layout Description
4312 Syntax next-inset-modify <INSET> <ARGS>
4315 \begin_layout Description
4316 Syntax next-inset-modify changetype <TYPE>
4319 \begin_layout Description
4320 Params See LFUN_INSET_INSERT for further details.
4324 \begin_layout Description
4325 Origin JSpitzm, 23 Mar 2008
4328 \begin_layout Subsection*
4329 LFUN_INSET_DIALOG_UPDATE
4332 \begin_layout Description
4333 Action Updates the values inside the dialog from the inset.
4337 \begin_layout Description
4338 Notion This is internal LFUN, not to be used by users.
4339 Called internally by LFUN_DIALOG_UPDATE
4342 \begin_layout Description
4343 Params <DIALOG-NAME>
4346 \begin_layout Description
4347 Origin leeming, 25 Feb 2003
4350 \begin_layout Subsection*
4354 \begin_layout Description
4355 Action Open the inset's properties dialog.
4359 \begin_layout Description
4360 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4364 \begin_layout Description
4365 Syntax inset-settings <INSET>
4368 \begin_layout Description
4369 Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
4372 \begin_layout Subsection*
4373 LFUN_NEXT_INSET_TOGGLE
4376 \begin_layout Description
4377 Action Toggles the inset at cursor position.
4378 For collapsables, this means it will be (un-)collapsed, in case of other
4379 insets, the editing widget (dialog) will be entered.
4381 LFUN_INSET_SETTINGS.
4385 \begin_layout Description
4386 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4387 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4392 \begin_layout Description
4393 Syntax next-inset-toggle <ARG>
4396 \begin_layout Description
4397 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4401 \begin_layout Description
4402 Origin leeming, 30 Mar 2004
4405 \begin_layout Subsection*
4409 \begin_layout Description
4410 Action Toggles the collapsable inset we are currently in.
4414 \begin_layout Description
4415 Syntax inset-toggle [<ARG>]
4418 \begin_layout Description
4419 Params <ARG>: <open|close|toggle|assign>.
4421 \begin_inset Newline newline
4424 open/close/toggle are for collapsable insets.
4425 close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4426 toggle is used when no argument is given.
4428 \begin_inset Newline newline
4431 assign is for branch inset.
4435 \begin_layout Description
4436 Origin lasgouttes, 19 Jul 2001
4439 \begin_layout Subsection*
4440 LFUN_ALL_INSETS_TOGGLE
4443 \begin_layout Description
4444 Action Toggles (open/closes) all collapsable insets (of a given type) in
4449 \begin_layout Description
4450 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4454 \begin_layout Description
4455 Syntax all-insets-toggle <STATE> <INSET>
4458 \begin_layout Description
4459 Params <STATE>: <toggle|open|close> default: toggle
4460 \begin_inset Newline newline
4463 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4467 \begin_layout Description
4468 Origin leeming, 30 Mar 2004
4471 \begin_layout Subsection*
4472 LFUN_SET_GRAPHICS_GROUP
4475 \begin_layout Description
4476 Action Set the group for the graphics inset on the cursor position.
4480 \begin_layout Description
4481 Syntax set-graphics-group [<GROUP>]
4484 \begin_layout Description
4485 Params <GROUP>: Id for an existing group.
4486 In case the Id is an empty string, the graphics inset is removed from the
4491 \begin_layout Description
4492 Origin sanda, 6 May 2008
4495 \begin_layout Subsection*
4496 LFUN_FINISHED_FORWARD
4499 \begin_layout Description
4500 Action Moves the cursor out of the current slice, going forward.
4504 \begin_layout Description
4505 Notion Cursor movement within an inset may be different than cursor movement
4506 in the surrounding text.
4507 This action should be called automatically by the cursor movement within
4508 the inset, when movement within the inset has ceased (reached the end of
4509 the last paragraph, for example), in order to move correctly back into
4510 the surrounding text.
4514 \begin_layout Subsection*
4515 LFUN_FINISHED_BACKWARD
4518 \begin_layout Description
4519 Action Moves the cursor out of the current slice, going backwards.
4523 \begin_layout Description
4524 Notion See also LFUN_FINISHED_FORWARD.
4528 \begin_layout Subsection*
4532 \begin_layout Description
4533 Action Moves the cursor out of the current slice, going right.
4537 \begin_layout Description
4538 Notion See also LFUN_FINISHED_FORWARD
4541 \begin_layout Subsection*
4545 \begin_layout Description
4546 Action Moves the cursor out of the current slice, going left.
4550 \begin_layout Description
4551 Notion See also LFUN_FINISHED_FORWARD.
4555 \begin_layout Subsection*
4559 \begin_layout Description
4560 Action Set language from the current cursor position.
4564 \begin_layout Description
4565 Syntax language <LANG>
4568 \begin_layout Description
4569 Params <LANG>: Requested language.
4570 Look in lib/languages for the list.
4574 \begin_layout Description
4575 Origin Dekel, 2 Mar 2000
4578 \begin_layout Subsection*
4582 \begin_layout Description
4583 Action Goto a label.
4587 \begin_layout Description
4588 Syntax label-goto [<LABEL>]
4591 \begin_layout Description
4592 Params <LABEL>: Requested label.
4593 If no label is given and refernce is on cursor position, Bookmark 0 is
4594 saved and cursor moves to the position of referenced label.
4598 \begin_layout Description
4599 Origin Ale, 6 Aug 1997
4602 \begin_layout Subsection*
4606 \begin_layout Description
4607 Action Inserts label to text or displayed formula.
4611 \begin_layout Description
4612 Syntax label-insert [<LABEL>]
4615 \begin_layout Description
4616 Params <LABEL>: Requested label.
4617 If no label is given dialog requesting name will be opened.
4621 \begin_layout Subsection*
4625 \begin_layout Description
4626 Action Go to the next label or cross-reference.
4630 \begin_layout Description
4631 Syntax reference-next
4634 \begin_layout Description
4635 Origin Dekel, 14 Jan 2001
4638 \begin_layout Subsection*
4642 \begin_layout Description
4643 Action Goto a bookmark.
4647 \begin_layout Description
4648 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4649 Note that bookmarsk are saved per-session, not per file.
4653 \begin_layout Description
4654 Syntax bookmark-goto <NUMBER>
4657 \begin_layout Description
4658 Params <NUMBER>: the number of the bookmark to restore.
4662 \begin_layout Description
4663 Origin Dekel, 27 January 2001
4666 \begin_layout Subsection*
4670 \begin_layout Description
4671 Action Save a bookmark.
4675 \begin_layout Description
4676 Notion Saves a numbered bookmark to the sessions file.
4677 The number must be between 1 and 9, inclusive.
4678 Note that bookmarks are saved per-session, not per file.
4682 \begin_layout Description
4683 Syntax bookmark-save <NUMBER>
4686 \begin_layout Description
4687 Params <NUMBER>: the number of the bookmark to save.
4691 \begin_layout Description
4692 Origin Dekel, 27 January 2001
4695 \begin_layout Subsection*
4699 \begin_layout Description
4700 Action Clears the list of saved bookmarks.
4704 \begin_layout Description
4705 Syntax bookmark-clear
4708 \begin_layout Description
4709 Origin bpeng, 31 October 2006
4712 \begin_layout Subsection*
4716 \begin_layout Description
4717 Action Open the given help file according to the language setting.
4721 \begin_layout Description
4722 Syntax help-open <FILE>[.lyx]
4725 \begin_layout Description
4726 Params <FILE>: any document from (/usr/share/)doc directory.
4730 \begin_layout Description
4731 Origin Jug, 27 Jun 1999
4734 \begin_layout Subsection*
4738 \begin_layout Description
4739 Action Terminates the current LyX instance.
4743 \begin_layout Description
4744 Notion Terminates the current LyX instance, asking whether to save modified
4749 \begin_layout Description
4753 \begin_layout Subsection*
4757 \begin_layout Description
4758 Action Toggles visibility of a given toolbar between on/off/auto.
4762 \begin_layout Description
4763 Notion Skiping "auto" when allowauto is false.
4767 \begin_layout Description
4768 Syntax toolbar-toggle <NAME> [allowauto]
4771 \begin_layout Description
4772 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4773 ew/update|math_panels|vcs
4776 \begin_layout Description
4777 Origin Edwin, 21 May 2007
4780 \begin_layout Subsection*
4784 \begin_layout Description
4785 Action Opens the menu given by its name.
4789 \begin_layout Description
4790 Syntax menu-open <NAME>
4793 \begin_layout Description
4794 Params <NAME>: menu name.
4795 See various .inc files in lib/ui for candidates.
4799 \begin_layout Subsection*
4803 \begin_layout Description
4804 Action Various UI visibility-toggling actions.
4808 \begin_layout Description
4809 Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
4812 \begin_layout Description
4813 Params statusbar : Toggle visibility of the statusbar.
4815 \begin_inset Newline newline
4818 menubar : Toggle visibility of the menubar.
4820 \begin_inset Newline newline
4823 scrollbar : Toggle visibility of the scrollbar.
4825 \begin_inset Newline newline
4828 frame : Toggle visibility of the frames around editing window.
4830 \begin_inset Newline newline
4833 fullscreen : Toggle fullscreen mode.
4834 This also covers calling the previous functions.
4835 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4840 \begin_layout Description
4841 Origin sanda, 9 Feb 2007
4844 \begin_layout Subsection*
4848 \begin_layout Description
4849 Action Creates new empty LyX window.
4853 \begin_layout Description
4854 Notion Already opened documents from the previous window can be found under
4859 \begin_layout Description
4860 Syntax window-new [<GEOMETRY>]
4863 \begin_layout Description
4864 Params <GEOMETRY>: pass the geometry of the window.
4865 This parameter is currently accepted only on Windows platform.
4869 \begin_layout Description
4870 Origin Abdel, 21 Oct 2006
4873 \begin_layout Subsection*
4877 \begin_layout Description
4878 Action Closes the current LyX window.
4882 \begin_layout Description
4886 \begin_layout Description
4887 Origin Abdel, 23 Oct 2006
4890 \begin_layout Subsection*
4894 \begin_layout Description
4895 Action Creates another split view of current buffer.
4899 \begin_layout Description
4900 Notion All split views act in the same way indpendently.
4904 \begin_layout Description
4905 Syntax split-view <vertical|horizontal>
4908 \begin_layout Description
4909 Params horizontal : The work areas are laid out side by side.
4911 \begin_inset Newline newline
4914 vertical : The work areas laid out vertically.
4918 \begin_layout Description
4919 Origin Abdel, 20 Feb 2008
4922 \begin_layout Subsection*
4923 LFUN_CLOSE_TAB_GROUP
4926 \begin_layout Description
4927 Action Close the current tab group.
4931 \begin_layout Description
4932 Notion This only closes the work areas, not the buffer themselves.
4933 The still opened buffers can be visualized in another tab group.
4937 \begin_layout Description
4938 Syntax close-tab-group
4941 \begin_layout Description
4942 Origin Abdel, 21 Feb 2008
4945 \begin_layout Subsection*
4949 \begin_layout Description
4950 Action Shows hidden dialog or create new one for a given function/inset
4955 \begin_layout Description
4956 Syntax dialog-show <NAME> [<DATA>]
4959 \begin_layout Description
4960 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4962 \begin_inset Newline newline
4965 document|errorlist|ert|external|file|findreplace|float|graphics|
4966 \begin_inset Newline newline
4969 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
4970 \begin_inset Newline newline
4973 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
4974 \begin_inset Newline newline
4977 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
4978 \begin_inset Newline newline
4981 wrap|listings|<SPECIAL>
4982 \begin_inset Newline newline
4985 <SPECIAL>: latexlog|vclog
4986 \begin_inset Newline newline
4989 <DATA>: data, usually settings for the given dialog.
4990 Use debug mode for the details.
4994 \begin_layout Description
4995 Origin leeming, 17 Jun 2003
4998 \begin_layout Subsection*
4999 LFUN_DIALOG_SHOW_NEW_INSET
5002 \begin_layout Description
5003 Action Shows hidden dialog or create new one for a given inset settings
5008 \begin_layout Description
5009 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5014 \begin_layout Description
5015 Syntax dialog-show-new-inset <NAME> [<DATA>]
5018 \begin_layout Description
5019 Params See LFUN_DIALOG_SHOW .
5023 \begin_layout Description
5024 Origin leeming, 25 Feb 2003
5027 \begin_layout Subsection*
5031 \begin_layout Description
5032 Action Updates the dialog values from the inset/paragraph/document.
5036 \begin_layout Description
5037 Syntax dialog-update <NAME>
5040 \begin_layout Description
5041 Params <NAME>: paragraph|prefs|<INSET>
5042 \begin_inset Newline newline
5048 \begin_layout Description
5049 Origin leeming, 25 Feb 2003
5052 \begin_layout Subsection*
5056 \begin_layout Description
5057 Action Hides showed dialog.
5058 Counterpart to LFUN_DIALOG_SHOW .
5062 \begin_layout Description
5063 Syntax dialog-hide <NAME>
5066 \begin_layout Description
5067 Params See LFUN_DIALOG_SHOW .
5071 \begin_layout Description
5072 Origin leeming, 25 Feb 2003
5075 \begin_layout Subsection*
5079 \begin_layout Description
5080 Action Toggles dialog between showed/hidden state.
5084 \begin_layout Description
5085 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5089 \begin_layout Description
5090 Syntax dialog-toggle <NAME> [<DATA>]
5093 \begin_layout Description
5094 Params See LFUN_DIALOG_SHOW .
5098 \begin_layout Description
5099 Origin JSpitzm, 30 Apr 2007
5102 \begin_layout Subsection*
5103 LFUN_DIALOG_DISCONNECT_INSET
5106 \begin_layout Description
5107 Action Closes opened connection to opened inset.
5111 \begin_layout Description
5112 Notion Connection is used for apply functions.
5116 \begin_layout Description
5117 Syntax dialog-disconnect-inset <INSET-NAME>
5120 \begin_layout Description
5121 Origin leeming, 25 Feb 2003
5124 \begin_layout Subsection*
5128 \begin_layout Description
5129 Action This function is called when mouse button is pressed (inside workarea).Act
5130 ion depends on the context.
5134 \begin_layout Description
5135 Notion This is internal LFUN, not to be used by users.
5139 \begin_layout Description
5140 Origin Andre, 9 Aug 2002
5143 \begin_layout Subsection*
5147 \begin_layout Description
5148 Action This function is called when double click on mouse button is pressed
5150 Action depends on the context.
5154 \begin_layout Description
5155 Notion This is internal LFUN, not to be used by users.
5159 \begin_layout Description
5160 Origin Andre, 9 Aug 2002
5163 \begin_layout Subsection*
5167 \begin_layout Description
5168 Action This function is called when triple click on mouse button is pressed
5170 Action depends on the context.
5174 \begin_layout Description
5175 Notion This is internal LFUN, not to be used by users.
5179 \begin_layout Description
5180 Origin Andre, 9 Aug 2002
5183 \begin_layout Subsection*
5187 \begin_layout Description
5188 Action This function is called when mouse cursor is moving over the text.Action
5189 depends on the context.
5193 \begin_layout Description
5194 Notion This is internal LFUN, not to be used by users.
5198 \begin_layout Description
5199 Origin Andre, 9 Aug 2002
5202 \begin_layout Subsection*
5206 \begin_layout Description
5207 Action This function is called when mouse button is released (inside workarea).Ac
5208 tion depends on the context.
5212 \begin_layout Description
5213 Notion This is internal LFUN, not to be used by users.
5217 \begin_layout Description
5218 Origin Andre, 9 Aug 2002
5221 \begin_layout Subsection*
5225 \begin_layout Description
5226 Action Turn off the loaded keyboard map.
5230 \begin_layout Description
5234 \begin_layout Subsection*
5238 \begin_layout Description
5239 Action Turn on the primary keyboard map.
5243 \begin_layout Description
5244 Notion Maps were widely used in past, when X-windows didn't have nowadays
5246 They can be still used to maintain uniform keyboard layout across the various
5249 \begin_inset Newline newline
5252 The language is to be set in the Preferences dialog.
5256 \begin_layout Description
5257 Syntax keymap-primary
5260 \begin_layout Subsection*
5261 LFUN_KEYMAP_SECONDARY
5264 \begin_layout Description
5265 Action Turn on the secondary keyboard map.
5269 \begin_layout Description
5270 Syntax keymap-secondary
5273 \begin_layout Subsection*
5277 \begin_layout Description
5278 Action Toggles keyboard maps (first/second/off).
5282 \begin_layout Description
5283 Syntax keymap-toggle
5286 \begin_layout Description
5287 Origin leeming, 30 Mar 2004
5290 \begin_layout Subsection*
5291 LFUN_SERVER_GET_LAYOUT
5294 \begin_layout Description
5295 Action Returns the current layout (that is environment) name on the cursor
5300 \begin_layout Description
5301 Syntax server-get-layout
5304 \begin_layout Subsection*
5305 LFUN_SERVER_GET_FILENAME
5308 \begin_layout Description
5309 Action Returns path and file name of the currently edited document.
5313 \begin_layout Description
5314 Syntax server-get-filename
5317 \begin_layout Subsection*
5318 LFUN_SERVER_GOTO_FILE_ROW
5321 \begin_layout Description
5322 Action Sets the cursor position based on the row number of generated TeX
5327 \begin_layout Description
5328 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5331 \begin_layout Description
5332 Origin Edmar, 23 Dec 1998
5335 \begin_layout Subsection*
5339 \begin_layout Description
5340 Action Sends notify message about the last key-sequence to client.
5344 \begin_layout Description
5345 Notion This can be used to grab last key-sequence used inside the LyX window.
5346 See also Debug extensions section in Extended features manual.
5350 \begin_layout Description
5351 Syntax server-notify
5354 \begin_layout Subsection*
5358 \begin_layout Description
5359 Action Sets the cursor position based on the editing area coordinates (similar
5360 as clicking on that point with left mouse button).
5364 \begin_layout Description
5365 Syntax server-set-xy <X> <Y>
5368 \begin_layout Subsection*
5372 \begin_layout Description
5373 Action Returns the coordinates of cursor position in the editing area.
5377 \begin_layout Description
5378 Syntax server-get-xy
5381 \begin_layout Subsection*
5385 \begin_layout Description
5386 Action Generates the code (literate programming).
5390 \begin_layout Description
5391 Notion Latex file with extension literate_extension is generated.
5392 Then LyX invokes build_command (with a default of``make'') to generate
5393 the code and build_error_filter to process the compilation error messages.
5395 \begin_inset Newline newline
5398 In case you want to process your literate file with a script, or some other
5399 program, just insert in your lyxrc file an entry with:
5400 \begin_inset Newline newline
5403 build_command "my_script my_arguments"
5404 \begin_inset Newline newline
5407 The build_error_filter differs from the literate_error_filter only in that
5408 the former will identify error messages from your compiler.
5412 \begin_layout Description
5413 Syntax build-program
5416 \begin_layout Subsection*
5417 LFUN_BUFFER_AUTO_SAVE
5420 \begin_layout Description
5421 Action Saves the current buffer to a temporary file.
5425 \begin_layout Description
5426 Notion Saves the current buffer to a file named "#filename#".
5427 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5431 \begin_layout Description
5432 Syntax buffer-auto-save
5435 \begin_layout Subsection*
5436 LFUN_BUFFER_CHILD_OPEN
5439 \begin_layout Description
5440 Action Loads the given child document.
5444 \begin_layout Description
5445 Notion The current document is treated as a parent.
5449 \begin_layout Description
5450 Syntax buffer-child-open <FILE>
5453 \begin_layout Description
5454 Params <FILE>: Filename of the child.
5455 The directory of the parent is assumed by default.
5459 \begin_layout Description
5460 Origin Ale, 28 May 1997
5463 \begin_layout Subsection*
5467 \begin_layout Description
5468 Action Runs chktex for the current document.
5472 \begin_layout Description
5473 Syntax buffer-chktex
5476 \begin_layout Description
5477 Origin Asger, 30 Oct 1997
5480 \begin_layout Subsection*
5481 LFUN_BUFFER_TOGGLE_COMPRESSION
5484 \begin_layout Description
5485 Action Toggles compression of the current document on/off.
5489 \begin_layout Description
5490 Syntax buffer-toggle-compression
5493 \begin_layout Description
5494 Origin bpeng, 27 Apr 2006
5497 \begin_layout Subsection*
5501 \begin_layout Description
5502 Action Closes the current buffer.
5506 \begin_layout Description
5507 Notion Closes the current buffer, asking whether to save it, etc, if the
5508 buffer has been modified.
5512 \begin_layout Description
5516 \begin_layout Subsection*
5520 \begin_layout Description
5521 Action Exports the current buffer (document) to the given format.
5525 \begin_layout Description
5526 Syntax buffer-export <FORMAT>
5529 \begin_layout Description
5530 Params <FORMAT> is either "custom" or one of the formats which you can find
5531 in Tools->Preferences->File formats->Format.
5532 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5533 for pdflatex) or "ps" for postscript.
5535 \begin_inset Newline newline
5538 In case of "custom" you will be asked for a format you want to start from
5539 and for the command that you want to apply to this format.
5540 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5544 \begin_layout Description
5545 Origin Lgb, 29 Jul 1997
5548 \begin_layout Subsection*
5549 LFUN_BUFFER_EXPORT_CUSTOM
5552 \begin_layout Description
5553 Action Exports the current buffer (document) from the given format using
5554 the given command on it.
5558 \begin_layout Description
5559 Syntax buffer-export-custom <FORMAT> <COMMAND>
5562 \begin_layout Description
5563 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5566 \begin_inset Newline newline
5569 <COMMAND> this command will be launched on the file.
5570 Note that you can use "$$FName" string to qualify the intermediate file.
5574 \begin_layout Description
5575 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5578 \begin_layout Description
5579 Origin leeming, 27 Mar 2004
5582 \begin_layout Subsection*
5586 \begin_layout Description
5587 Action Prints the current document.
5591 \begin_layout Description
5592 Notion Many settings can be given via the preferences dialog.
5596 \begin_layout Description
5597 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5600 \begin_layout Description
5601 Params <TARGET> is either "printer" or "file".
5603 \begin_inset Newline newline
5606 <TARGER-NAME> is either "default" or file name or printer name.
5608 \begin_inset Newline newline
5611 <COMMAND> command ensuring the printing job.
5615 \begin_layout Description
5616 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5619 \begin_layout Description
5620 Origin leeming, 28 Mar 2004
5623 \begin_layout Subsection*
5627 \begin_layout Description
5628 Action Import a given file as a lyx document.
5632 \begin_layout Description
5633 Notion File can be imported iff lyx file format is (transitively) reachable
5634 via defined convertors in preferences.
5635 Look into File->Import menu to get an idea of the currently active import
5640 \begin_layout Description
5641 Syntax buffer-import <FORMAT> [<FILE>]
5644 \begin_layout Description
5645 Origin Asger, 24 Jul 1998
5648 \begin_layout Subsection*
5652 \begin_layout Description
5653 Action Creates a new buffer (that is, document).
5657 \begin_layout Description
5658 Notion Implicit path can be set in Preferences dialog.
5662 \begin_layout Description
5663 Syntax buffer-new [<FILE>]
5666 \begin_layout Description
5667 Params <FILE>: filename of created file with absolute path.
5671 \begin_layout Subsection*
5672 LFUN_BUFFER_NEW_TEMPLATE
5675 \begin_layout Description
5676 Action Creates a new buffer (that is, document) from a template.
5680 \begin_layout Description
5681 Notion Path for new files and templates can be set in Preferences dialog.
5682 Template will be asked for via Open-dialog.
5686 \begin_layout Description
5687 Syntax buffer-new-template [<FILE>]
5690 \begin_layout Description
5691 Params <FILE>: filename of created file with absolute path.
5695 \begin_layout Subsection*
5699 \begin_layout Description
5700 Action Reverts opened document.
5704 \begin_layout Description
5705 Syntax buffer-reload
5708 \begin_layout Description
5709 Origin Asger, 2 Feb 1997
5712 \begin_layout Subsection*
5716 \begin_layout Description
5717 Action Switch to the given buffer.
5721 \begin_layout Description
5722 Notion This is useful also in case you need simultaneously more views of
5723 the edited document in different LyX windows.
5727 \begin_layout Description
5728 Syntax buffer-new-template <BUFFER>
5731 \begin_layout Description
5732 Params <BUFFER>: already opened document which is to be shown.
5736 \begin_layout Subsection*
5737 LFUN_BUFFER_TOGGLE_READ_ONLY
5740 \begin_layout Description
5741 Action Toggle editing mode of the current document between read/write and
5746 \begin_layout Description
5747 Notion In the ->Readonly mode checks-in/commits the data if the file is
5748 under version control.
5749 In the Readonly-> mode checkouts the data from repository.
5751 \begin_inset Newline newline
5754 If these operations fail, buffer won't be toggled.
5758 \begin_layout Description
5759 Syntax buffer-toggle-read-only
5762 \begin_layout Description
5763 Origin Lgb, 27 May 1997
5766 \begin_layout Subsection*
5770 \begin_layout Description
5771 Action Displays current buffer in chosen format.
5775 \begin_layout Description
5776 Notion Displays the contents of the current buffer in the chosen format,
5777 for example, PDF or DVI.
5778 This runs the necessary converter, calls the defined viewer, and so forth.
5782 \begin_layout Description
5783 Syntax buffer-view <FORMAT>
5786 \begin_layout Description
5787 Params <FORMAT>: The format to display, where this is one of the formats
5788 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5792 \begin_layout Subsection*
5796 \begin_layout Description
5797 Action Exports the current document and put the result into the temporary
5802 \begin_layout Description
5803 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5804 EW) the output will be rewriten - updated.
5805 This is useful in case your viewer is able to detect such changes (e.g.
5806 ghostview for postscript).
5810 \begin_layout Description
5811 Syntax buffer-update <FORMAT>
5814 \begin_layout Description
5815 Params <FORMAT>: The format to display, where this is one of the formats
5816 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5820 \begin_layout Description
5821 Origin Dekel, 5 Aug 2000
5824 \begin_layout Subsection*
5828 \begin_layout Description
5829 Action Saves the current buffer.
5833 \begin_layout Description
5834 Notion Saves the current buffer to disk, using the filename that is already
5835 associated with the buffer, asking for one if none is yet assigned.
5839 \begin_layout Description
5843 \begin_layout Subsection*
5844 LFUN_BUFFER_WRITE_AS
5847 \begin_layout Description
5848 Action Rename and save current buffer.
5852 \begin_layout Description
5853 Syntax buffer-write-as <FILENAME>
5856 \begin_layout Description
5857 Params <FILENAME>: New name of the buffer/file.
5858 A relative path is with respect to the original location of the buffer/file.
5862 \begin_layout Subsection*
5863 LFUN_BUFFER_WRITE_ALL
5866 \begin_layout Description
5867 Action Save all changed documents.
5871 \begin_layout Description
5872 Syntax buffer-write-all
5875 \begin_layout Description
5876 Origin rgh, gpothier 6 Aug 2007
5879 \begin_layout Subsection*
5883 \begin_layout Description
5884 Action Switch to the next opened document.
5888 \begin_layout Description
5889 Notion Note that this does not necessarily mean next in tabbar (for full
5890 list see View menu).
5894 \begin_layout Description
5898 \begin_layout Subsection*
5899 LFUN_BUFFER_PREVIOUS
5902 \begin_layout Description
5903 Action Switch to the previous opened document.
5907 \begin_layout Description
5908 Syntax buffer-previous
5911 \begin_layout Subsection*
5912 LFUN_MASTER_BUFFER_UPDATE
5915 \begin_layout Description
5916 Action When run from a child document, this updates (exports) document built
5917 from the master buffer.
5918 If a master is not found, it updates the current buffer.
5922 \begin_layout Description
5923 Syntax master-buffer-update
5926 \begin_layout Description
5927 Origin Tommaso, 20 Sep 2007
5930 \begin_layout Subsection*
5931 LFUN_MASTER_BUFFER_VIEW
5934 \begin_layout Description
5935 Action When run from a child document, this command shows a preview built
5936 from the master buffer.
5937 If a master is not found, it previews the current buffer.
5941 \begin_layout Description
5942 Syntax master-buffer-view
5945 \begin_layout Description
5946 Origin Tommaso, 20 Sep 2007
5949 \begin_layout Subsection*
5950 LFUN_BUFFER_LANGUAGE
5953 \begin_layout Description
5954 Action Set language of the current document.
5958 \begin_layout Description
5959 Syntax buffer-language <LANG>
5962 \begin_layout Description
5963 Params <LANG>: language name.
5964 See lib/languages for list.
5968 \begin_layout Description
5969 Origin leeming, 30 Mar 2004
5972 \begin_layout Subsection*
5973 LFUN_BUFFER_SAVE_AS_DEFAULT
5976 \begin_layout Description
5977 Action Save the current document settings as default.
5981 \begin_layout Description
5982 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5986 \begin_layout Description
5987 Syntax buffer-save-as-default [<ARGS>]
5990 \begin_layout Description
5991 Params <ARGS>: contains the particular settings to be saved.
5992 They obey the syntax you can find in document header of usual .lyx file.
5996 \begin_layout Description
5997 Origin leeming, 30 Mar 2004
6000 \begin_layout Subsection*
6001 LFUN_BUFFER_PARAMS_APPLY
6004 \begin_layout Description
6005 Action Apply the given settings to the current document.
6009 \begin_layout Description
6010 Syntax buffer-params-apply [<ARGS>]
6013 \begin_layout Description
6014 Params <ARGS>: contains the particular settings to be saved.
6015 They obey the syntax you can find in document header of usual .lyx file.
6019 \begin_layout Description
6020 Origin leeming, 30 Mar 2004
6023 \begin_layout Subsection*
6027 \begin_layout Description
6028 Action Inserts another LyX file.
6032 \begin_layout Description
6033 Syntax file-insert [<FILE>]
6036 \begin_layout Description
6037 Params <FILE>: Filename to be inserted.
6041 \begin_layout Subsection*
6042 LFUN_FILE_INSERT_PLAINTEXT
6045 \begin_layout Description
6046 Action Inserts plain text file.
6050 \begin_layout Description
6051 Syntax file-insert-plaintext [<FILE>]
6054 \begin_layout Description
6055 Params <FILE>: Filename to be inserted.
6059 \begin_layout Description
6060 Origin CFO-G, 19 Nov 1997
6063 \begin_layout Subsection*
6064 LFUN_FILE_INSERT_PLAINTEXT_PARA
6067 \begin_layout Description
6068 Action Inserts plain text file as paragraph (i.e.
6073 \begin_layout Description
6074 Syntax file-insert-plaintext-para [<FILE>]
6077 \begin_layout Description
6078 Params <FILE>: Filename to be inserted.
6082 \begin_layout Description
6083 Origin Levon, 14 Feb 2001
6086 \begin_layout Subsection*
6090 \begin_layout Description
6091 Action Open LyX document.
6095 \begin_layout Description
6096 Syntax file-open [<FILE>]
6099 \begin_layout Description
6100 Params <FILE>: Filename to be opened.
6104 \begin_layout Subsection*
6108 \begin_layout Description
6109 Action Executes a command defined in a .def file.
6113 \begin_layout Description
6114 Notion The definitions are by default read from lib/commands/default.def.
6116 \begin_inset Newline newline
6119 A .def file allows to define a command with
6121 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6122 <LFUN> is the lfun code to be executed (see e.g.
6123 LFUN_COMMAND_SEQUENCE).
6126 def_file "FileName" allows to include another .def file.
6128 \begin_inset Newline newline
6131 This is particularly useful in connection with toolbar buttons: Since the
6132 name of the button image for this lfun is lib/images/commands/<NAME>.png
6133 this is the way to assign an image to a complex command-sequence.
6137 \begin_layout Description
6141 \begin_layout Description
6142 Params <NAME>: Name of the command that must be called.
6146 \begin_layout Description
6147 Origin broider, 2 Oct 2007
6150 \begin_layout Subsection*
6154 \begin_layout Description
6155 Action Simulate halting Meta key (Alt key on PCs).
6159 \begin_layout Description
6160 Notion Used for buffer editation not for GUI control.
6164 \begin_layout Description
6168 \begin_layout Subsection*
6172 \begin_layout Description
6173 Action Cancels sequence prepared by LFUN_META_PREFIX .
6177 \begin_layout Description
6181 \begin_layout Subsection*
6182 LFUN_COMMAND_EXECUTE
6185 \begin_layout Description
6186 Action Opens the minibuffer toolbar so that the user can type in there.
6190 \begin_layout Description
6191 Notion Usually bound to M-x shortcut.
6195 \begin_layout Description
6196 Syntax command-execute
6199 \begin_layout Subsection*
6203 \begin_layout Description
6204 Action Return the current key sequence and available options as a string.
6208 \begin_layout Description
6209 Notion No options are added if no current map exists.
6211 \begin_inset Newline newline
6214 This is probably usable only with connection to lyxserver.
6218 \begin_layout Description
6219 Syntax command-prefix
6222 \begin_layout Subsection*
6223 LFUN_COMMAND_SEQUENCE
6226 \begin_layout Description
6227 Action Run more commands (LFUN and its parameters) in a sequence.
6231 \begin_layout Description
6232 Syntax command-sequence <CMDS>
6235 \begin_layout Description
6236 Params <CMDS>: Sequence of commands separated by semicolons.
6240 \begin_layout Description
6241 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6245 \begin_layout Description
6246 Origin Andre, 11 Nov 1999
6249 \begin_layout Subsection*
6250 LFUN_COMMAND_ALTERNATIVES
6253 \begin_layout Description
6254 Action Runs the first listed command that is enabled.
6258 \begin_layout Description
6259 Notion This can be used to bind multiple functions to a single key, and
6260 then which one is used will depend upon the context.
6264 \begin_layout Description
6265 Syntax command-alternatives <CMDS>
6268 \begin_layout Description
6269 Params <CMDS>: Sequence of commands separated by semicolons.
6273 \begin_layout Description
6274 Sample command-alternatives completion-accept;cell-forward
6277 \begin_layout Description
6278 Origin rgh, 24 September 2008
6281 \begin_layout Subsection*
6285 \begin_layout Description
6286 Action Shows message in statusbar (for script purposes).
6290 \begin_layout Description
6291 Syntax message <STRING>
6294 \begin_layout Description
6295 Origin Lgb, 8 Apr 2001
6298 \begin_layout Subsection*
6299 LFUN_PREFERENCES_SAVE
6302 \begin_layout Description
6303 Action Save user preferences.
6307 \begin_layout Description
6308 Syntax preferences-save
6311 \begin_layout Description
6312 Origin Lgb, 27 Nov 1999
6315 \begin_layout Subsection*
6319 \begin_layout Description
6320 Action Reconfigure the automatic settings.
6324 \begin_layout Description
6328 \begin_layout Description
6329 Origin Asger, 14 Feb 1997
6332 \begin_layout Subsection*
6336 \begin_layout Description
6337 Action Apply the given settings to user preferences.
6341 \begin_layout Description
6342 Syntax lyxrc-apply <SETTINGS>
6345 \begin_layout Description
6346 Params <SETTINGS>: settings which are to be set.
6347 Take a look into ~/.lyx/preferences to get an idea which commands to use
6349 lyx::LyXRC::LyXRCTags has the list of possible commands.
6353 \begin_layout Subsection*
6354 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6357 \begin_layout Description
6358 Action Determine whether keep cursor inside the editing window regardless
6359 the scrollbar movement.
6363 \begin_layout Description
6364 Syntax toggle-cursor-follows-scrollbar
6367 \begin_layout Description
6368 Origin ARRae, 2 Dec 1997
6371 \begin_layout Subsection*
6375 \begin_layout Description
6376 Action Set the given LyX color to the color defined by the X11 name given.
6380 \begin_layout Description
6381 Notion A new color entry is created if the color is unknown.
6382 Color names can be stored as a part of user settings.
6386 \begin_layout Description
6387 Syntax set-color <LYX_NAME> <X11_NAME>
6390 \begin_layout Description
6391 Origin SLior, 11 Jun 2000
6394 \begin_layout Subsection*
6398 \begin_layout Description
6399 Action Count the statistics (number of words and characters) in the document
6400 or in the given selection.
6404 \begin_layout Description
6405 Notion Note that this function gives the number of words/chars written,
6406 not the number of characters which will be typeset.
6410 \begin_layout Description
6414 \begin_layout Description
6415 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6418 \begin_layout Subsection*
6419 LFUN_COMPLETION_INLINE
6422 \begin_layout Description
6423 Action Show the inline completion at the cursor position.
6427 \begin_layout Description
6428 Syntax completion-inline
6431 \begin_layout Description
6432 Origin sts, Feb 19 2008
6435 \begin_layout Subsection*
6436 LFUN_COMPLETION_POPUP
6439 \begin_layout Description
6440 Action Show the completion popup at the cursor position.
6444 \begin_layout Description
6445 Syntax completion-popup
6448 \begin_layout Description
6449 Origin sts, Feb 19 2008
6452 \begin_layout Subsection*
6453 LFUN_COMPLETION_COMPLETE
6456 \begin_layout Description
6457 Action Try to complete the word or command at the cursor position.
6461 \begin_layout Description
6465 \begin_layout Description
6466 Origin sts, Feb 19 2008
6469 \begin_layout Subsection*
6470 LFUN_COMPLETION_CANCEL
6473 \begin_layout Description
6474 Action Try to cancel completion, either the popup or the inline completion
6478 \begin_layout Description
6479 Syntax completion-cancel
6482 \begin_layout Description
6483 Origin sts, Sep 07 2008
6486 \begin_layout Subsection*
6487 LFUN_COMPLETION_ACCEPT
6490 \begin_layout Description
6491 Action Accept suggested completion.
6495 \begin_layout Description
6496 Syntax completion-accept
6499 \begin_layout Description
6500 Origin sanda, Sep 08 2008
6503 \begin_layout Subsection*
6504 LFUN_BRANCH_ACTIVATE
6507 \begin_layout Description
6508 Action Activate the branch
6511 \begin_layout Description
6512 Syntax branch-activate <BRANCH>
6515 \begin_layout Description
6516 Params <BRANCH>: The branch to activate
6519 \begin_layout Description
6520 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6521 \begin_inset Newline newline
6524 could be used to export a pdf with the answers branch includedwithout one's
6525 having to open LyX and activate the branch manually.
6528 \begin_layout Description
6529 Origin rgh, 27 May 2008
6532 \begin_layout Subsection*
6533 LFUN_BRANCH_ACTIVATE
6536 \begin_layout Description
6537 Action De-activate the branch
6540 \begin_layout Description
6541 Syntax branch-deactivate <BRANCH>
6544 \begin_layout Description
6545 Params <BRANCH>: The branch to deactivate
6548 \begin_layout Description
6549 Origin rgh, 27 May 2008