1 #LyX 1.6.2svn 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 11.01.2009.
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 Search for next occurence of a pattern.
1607 \begin_layout Description
1608 Syntax word-findadv [<DATA>]
1611 \begin_layout Description
1612 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1613 If no parameter is given, search with last find-dialog data is used for
1619 \begin_layout Description
1620 Origin Tommaso, Nov 15 2007
1623 \begin_layout Description
1624 Action Moves the cursor to the logically next beginning of a word.
1628 \begin_layout Description
1629 Notion This is not the action which should be bound to the arrow keys, because
1630 forward may be left or right, depending on the language.
1631 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1632 which in turn may employ this one.
1636 \begin_layout Description
1640 \begin_layout Subsection*
1641 LFUN_WORD_FORWARD_SELECT
1644 \begin_layout Description
1645 Action Moves the cursor to the logically next beginning of a word, adding
1646 the logically traversed text to the selection.
1650 \begin_layout Description
1651 Notion See also LFUN_WORD_FORWARD.
1655 \begin_layout Description
1656 Syntax word-forward-select
1659 \begin_layout Subsection*
1663 \begin_layout Description
1664 Action Moves the cursor to the next beginning of a word "on the left".
1668 \begin_layout Description
1669 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1671 Generally, it moves the cursor to the next beginning of a word on the left.
1672 However, in Bidi text this become slightly more complicated, and there
1673 are different modes of cursor movement.
1674 In "visual mode", this moves left, plain and simple.
1675 In "logical mode", movement is logically forward in RTL paragraphs, and
1676 logically backwards in LTR paragraphs.
1680 \begin_layout Description
1684 \begin_layout Description
1685 Origin dov, 28 Oct 2007
1688 \begin_layout Subsection*
1689 LFUN_WORD_LEFT_SELECT
1692 \begin_layout Description
1693 Action Moves the cursor to the next beginning of a word "on the left", adding
1694 *logically* traversed text to the selection.
1698 \begin_layout Description
1699 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1703 \begin_layout Description
1704 Syntax word-left-select
1707 \begin_layout Description
1708 Origin dov, 28 Oct 2007
1711 \begin_layout Subsection*
1715 \begin_layout Description
1716 Action Moves the cursor to the next beginning of a word "on the right".
1720 \begin_layout Description
1721 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1723 Generally, it moves the cursor to the next beginning of a word on the right.
1724 However, in Bidi text this become slightly more complicated, and there
1725 are different modes of cursor movement.
1726 In "visual mode", this moves right, plain and simple.
1727 In "logical mode", movement is logically forward in LTR paragraphs, and
1728 logically backwards in RTL paragraphs.
1732 \begin_layout Description
1736 \begin_layout Description
1737 Origin dov, 28 Oct 2007
1740 \begin_layout Subsection*
1741 LFUN_WORD_RIGHT_SELECT
1744 \begin_layout Description
1745 Action Moves the cursor to the next beginning of a word "on the right",
1746 adding *logically* traversed text to the selection.
1750 \begin_layout Description
1751 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1755 \begin_layout Description
1756 Syntax word-right-select
1759 \begin_layout Description
1760 Origin dov, 28 Oct 2007
1763 \begin_layout Subsection*
1767 \begin_layout Description
1768 Action Puts the word where the cursor stands into the selection.
1772 \begin_layout Description
1776 \begin_layout Description
1777 Origin Andre, 11 Sep 2002
1780 \begin_layout Subsection*
1781 LFUN_WORD_CAPITALIZE
1784 \begin_layout Description
1785 Action Capitalizes the words in the selection (i.e.
1786 the first letters) or the letter on the cursor position.
1790 \begin_layout Description
1791 Syntax word-capitalize
1794 \begin_layout Subsection*
1798 \begin_layout Description
1799 Action Change the words in the selection or from the cursor position to
1800 the end of word to the upper case.
1804 \begin_layout Description
1808 \begin_layout Subsection*
1812 \begin_layout Description
1813 Action Change the words in the selection or from the cursor position to
1814 the end of word to the lower case.
1818 \begin_layout Description
1822 \begin_layout Subsection*
1823 LFUN_THESAURUS_ENTRY
1826 \begin_layout Description
1827 Action Look up thesaurus entries with respect to the word under the cursor.
1831 \begin_layout Description
1832 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1835 \begin_layout Description
1836 Params <STRING>: word to look up <LANG>: language (see file languages)
1840 \begin_layout Description
1841 Origin Levon, 20 Jul 2001
1844 \begin_layout Subsection*
1848 \begin_layout Description
1849 Action Move the cursor to the beginning of the document.
1853 \begin_layout Description
1857 \begin_layout Subsection*
1858 LFUN_BUFFER_BEGIN_SELECT
1861 \begin_layout Description
1862 Action Move the cursor to the beginning of the document adding the traversed
1863 text to the selection.
1867 \begin_layout Description
1868 Syntax buffer-begin-select
1871 \begin_layout Subsection*
1875 \begin_layout Description
1876 Action Move the cursor to the end of the document.
1880 \begin_layout Description
1884 \begin_layout Subsection*
1885 LFUN_BUFFER_END_SELECT
1888 \begin_layout Description
1889 Action Move the cursor to the end of the document adding the traversed text
1894 \begin_layout Description
1895 Syntax buffer-end-select
1898 \begin_layout Subsection*
1902 \begin_layout Description
1903 Action Move the cursor to the begining of the (screen) line.
1907 \begin_layout Description
1911 \begin_layout Subsection*
1912 LFUN_LINE_BEGIN_SELECT
1915 \begin_layout Description
1916 Action Move the cursor to the beginning of the (screen) line adding the
1917 traversed text to the selection.
1921 \begin_layout Description
1922 Syntax line-begin-select
1925 \begin_layout Subsection*
1929 \begin_layout Description
1930 Action Move the cursor to the end of the (screen) line.
1934 \begin_layout Description
1938 \begin_layout Subsection*
1939 LFUN_LINE_END_SELECT
1942 \begin_layout Description
1943 Action Move the cursor to the end of the (screen) line adding the traversed
1944 text to the selection.
1948 \begin_layout Description
1949 Syntax line-end-select
1952 \begin_layout Subsection*
1956 \begin_layout Description
1957 Action Deletes the letters to the end of the (screen) line or deletes the
1962 \begin_layout Description
1963 Syntax line-delete-forward
1966 \begin_layout Subsection*
1970 \begin_layout Description
1971 Action Copies to the clipboard the last edit.
1975 \begin_layout Description
1979 \begin_layout Subsection*
1983 \begin_layout Description
1984 Action Cuts to the clipboard.
1988 \begin_layout Description
1992 \begin_layout Subsection*
1996 \begin_layout Description
1997 Action Pastes material from the active clipboard.
2001 \begin_layout Description
2002 Syntax paste [<TYPE>]
2005 \begin_layout Description
2006 Params <TYPE>: pdf|png|jpeg|linkback
2009 \begin_layout Subsection*
2010 LFUN_CLIPBOARD_PASTE
2013 \begin_layout Description
2014 Action Pastes text from the active clipboard.
2018 \begin_layout Description
2019 Syntax clipboard-paste [<ARG>]
2022 \begin_layout Description
2023 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2028 \begin_layout Description
2029 Origin baum, 10 Jul 2006
2032 \begin_layout Subsection*
2033 LFUN_PRIMARY_SELECTION_PASTE
2036 \begin_layout Description
2037 Action Pastes the currently text selected text.
2041 \begin_layout Description
2042 Notion Primary selection mechanism is linux-only thing.
2046 \begin_layout Description
2047 Syntax primary-selection-paste [<ARG>]
2050 \begin_layout Description
2051 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2056 \begin_layout Subsection*
2060 \begin_layout Description
2061 Action Undoes the last edit.
2065 \begin_layout Description
2069 \begin_layout Subsection*
2073 \begin_layout Description
2074 Action Redoes the last thing undone.
2078 \begin_layout Description
2082 \begin_layout Subsection*
2086 \begin_layout Description
2087 Action Repeat the given command.
2091 \begin_layout Description
2092 Syntax repeat <COUNT> <LFUN-COMMAND>
2095 \begin_layout Description
2096 Origin Andre, , 27 Oct 2003
2099 \begin_layout Subsection*
2100 LFUN_CHARS_TRANSPOSE
2103 \begin_layout Description
2104 Action Transposes the character at the cursor with the one before it.
2108 \begin_layout Description
2109 Syntax chars-transpose
2112 \begin_layout Description
2113 Origin Lgb, 25 Apr 2001
2116 \begin_layout Subsection*
2117 LFUN_DEPTH_DECREMENT
2120 \begin_layout Description
2121 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2126 \begin_layout Description
2127 Syntax depth-decrement
2130 \begin_layout Subsection*
2131 LFUN_DEPTH_INCREMENT
2134 \begin_layout Description
2135 Action Increase the nesting depth of the (selected) paragraph(s) inside
2140 \begin_layout Description
2141 Syntax depth-increment
2144 \begin_layout Subsection*
2148 \begin_layout Description
2149 Action Toggles the bold font (selection-wise) using mathbf in math.
2153 \begin_layout Description
2157 \begin_layout Subsection*
2158 LFUN_FONT_BOLDSYMBOL
2161 \begin_layout Description
2162 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2166 \begin_layout Description
2167 Syntax font-boldsymbol
2170 \begin_layout Subsection*
2171 LFUN_FONT_TYPEWRITER
2174 \begin_layout Description
2175 Action Toggles the typewriter family font (selection-wise).
2179 \begin_layout Description
2180 Syntax font-typewriter
2183 \begin_layout Subsection*
2187 \begin_layout Description
2188 Action Toggles underline in the font (selection-wise).
2192 \begin_layout Description
2193 Syntax font-underline
2196 \begin_layout Subsection*
2200 \begin_layout Description
2201 Action Toggles the emphasis font style (selection-wise).
2205 \begin_layout Description
2209 \begin_layout Subsection*
2213 \begin_layout Description
2214 Action Toggles Noun text style font (selection-wise).
2218 \begin_layout Description
2222 \begin_layout Subsection*
2226 \begin_layout Description
2227 Action Toggles Roman family font (selection-wise).
2231 \begin_layout Description
2235 \begin_layout Subsection*
2239 \begin_layout Description
2240 Action Toggles Sans Serif family font (selection-wise).
2244 \begin_layout Description
2248 \begin_layout Subsection*
2252 \begin_layout Description
2253 Action Toggles Fraktur family font (math-mode, selection-wise).
2257 \begin_layout Description
2261 \begin_layout Description
2262 Origin vermeer, 10 Jan 2002
2265 \begin_layout Subsection*
2269 \begin_layout Description
2270 Action Toggles Italics font shape (math-mode, selection-wise).
2274 \begin_layout Description
2278 \begin_layout Description
2279 Origin vermeer, 10 Jan 2002
2282 \begin_layout Subsection*
2286 \begin_layout Description
2287 Action Reverts the settings of the font to the default values (selection-wise).
2291 \begin_layout Description
2295 \begin_layout Subsection*
2299 \begin_layout Description
2300 Action Sets font size according to lyx format string.
2304 \begin_layout Description
2305 Syntax font-size <SIZE>
2308 \begin_layout Description
2309 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2310 \begin_inset Newline newline
2313 largest|huge|giant|increase|decrease|default
2316 \begin_layout Subsection*
2317 LFUN_TEXTSTYLE_APPLY
2320 \begin_layout Description
2321 Action Toggle user-defined (=last-time used) text style.
2325 \begin_layout Description
2326 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2327 trigerred when using Text Style dialog.
2331 \begin_layout Description
2332 Syntax textstyle-apply
2335 \begin_layout Description
2336 Origin leeming, 12 Mar 2003
2339 \begin_layout Subsection*
2340 LFUN_TEXTSTYLE_UPDATE
2343 \begin_layout Description
2344 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2349 \begin_layout Description
2350 Syntax textstyle-update <FONT_INFO>
2353 \begin_layout Description
2354 Params <FONT_INFO>: specifies font atributes, e.g.
2355 family, series, shape, size, emph, noun, underbar, number, color, language,
2358 \begin_inset Newline newline
2361 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2365 \begin_layout Description
2366 Origin leeming, 12 Mar 2003
2369 \begin_layout Subsection*
2370 LFUN_SCREEN_FONT_UPDATE
2373 \begin_layout Description
2374 Action Update fonts and its metrics.
2378 \begin_layout Description
2379 Notion Automatically called after zoom, dpi, font names, or norm change.
2383 \begin_layout Description
2384 Syntax screen-font-update
2387 \begin_layout Description
2388 Origin ARRae, 13 Aug 2000
2391 \begin_layout Subsection*
2395 \begin_layout Description
2396 Action Returns the info about the current font.
2400 \begin_layout Description
2404 \begin_layout Subsection*
2405 LFUN_CITATION_INSERT
2408 \begin_layout Description
2409 Action Inserts citation from loaded citation database.
2413 \begin_layout Description
2414 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2417 \begin_layout Description
2418 Params <KEY>: Citation (shortcut listed in available citations).
2420 \begin_inset Newline newline
2423 <TEXT_BEFORE>: text which should appear before citation.
2427 \begin_layout Description
2428 Origin AAS, 97-02-23
2431 \begin_layout Subsection*
2432 LFUN_BIBTEX_DATABASE_ADD
2435 \begin_layout Description
2436 Action Adds database, which will be used for bibtex citations.
2440 \begin_layout Description
2441 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2442 bibliography) found from the cursor postion.
2446 \begin_layout Description
2447 Syntax bibtex-database-add <DATABASE-NAME>
2450 \begin_layout Description
2451 Origin Ale, 30 May 1997
2454 \begin_layout Subsection*
2455 LFUN_BIBTEX_DATABASE_DEL
2458 \begin_layout Description
2459 Action Adds database, which will be used for bibtex citations.
2463 \begin_layout Description
2464 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2465 X bibliography) found from the cursor postion.
2469 \begin_layout Description
2470 Syntax bibtex-database-del <DATABASE-NAME>
2473 \begin_layout Description
2474 Origin Ale, 30 May 1997
2477 \begin_layout Subsection*
2481 \begin_layout Description
2482 Action Sets the layout (that is, environment) for the current paragraph.
2486 \begin_layout Description
2487 Syntax layout <LAYOUT>
2490 \begin_layout Description
2491 Params <LAYOUT>: the layout to use
2494 \begin_layout Subsection*
2495 LFUN_LAYOUT_PARAGRAPH
2498 \begin_layout Description
2499 Action Launches the paragraph settings dialog.
2503 \begin_layout Description
2504 Syntax layout-paragraph
2507 \begin_layout Subsection*
2511 \begin_layout Description
2512 Action Launches the tabular settings dialog.
2516 \begin_layout Description
2517 Syntax layout-tabular
2520 \begin_layout Description
2521 Origin Jug, 31 Jul 2000
2524 \begin_layout Subsection*
2525 LFUN_DROP_LAYOUTS_CHOICE
2528 \begin_layout Description
2529 Action Displays list of layout choices.
2533 \begin_layout Description
2534 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2535 allowing for choice of layout.
2539 \begin_layout Description
2540 Syntax drop-layouts-choice
2543 \begin_layout Subsection*
2544 LFUN_LAYOUT_MODULES_CLEAR
2547 \begin_layout Description
2548 Action Clears the module list.
2552 \begin_layout Description
2553 Notion Clears the list of included modules for the current buffer.
2557 \begin_layout Description
2558 Syntax layout-modules-clear
2561 \begin_layout Description
2562 Origin rgh, 25 August 2007
2565 \begin_layout Subsection*
2566 LFUN_LAYOUT_MODULE_ADD
2569 \begin_layout Description
2570 Action Adds a module.
2574 \begin_layout Description
2575 Notion Adds a module to the list of included modules for the current buffer.
2579 \begin_layout Description
2580 Syntax layout-module-add <MODULE>
2583 \begin_layout Description
2584 Params <MODULE>: the module to be added
2587 \begin_layout Description
2588 Origin rgh, 25 August 2007
2591 \begin_layout Subsection*
2595 \begin_layout Description
2596 Action Reloads layout information.
2600 \begin_layout Description
2601 Notion Reloads all layout information for the current buffer from disk,
2602 thus recognizing any changes that have been made to layout files on the
2604 This is intended to be used only by layout developers and should not be
2605 used when one is trying to do actual work.
2609 \begin_layout Description
2610 Syntax layout-reload
2613 \begin_layout Description
2614 Origin rgh, 3 September 2007
2617 \begin_layout Subsection*
2618 LFUN_TEXTCLASS_APPLY
2621 \begin_layout Description
2622 Action Sets the text class for the current buffer.
2626 \begin_layout Description
2627 Syntax textclass-apply <TEXTCLASS>
2630 \begin_layout Description
2631 Params <TEXTCLASS>: the textclass to set.
2632 Note that this must be the filename, minus the ".layout" extension.
2636 \begin_layout Subsection*
2640 \begin_layout Description
2641 Action Loads information for a textclass from disk.
2645 \begin_layout Description
2646 Syntax textclass-load <TEXTCLASS>
2649 \begin_layout Description
2650 Params <TEXTCLASS>: the textclass to load.
2651 Note that this must be the filename, minus the ".layout" extension.
2655 \begin_layout Subsection*
2659 \begin_layout Description
2660 Action Disable selecting of text-region.
2664 \begin_layout Description
2668 \begin_layout Subsection*
2672 \begin_layout Description
2673 Action Enable selecting of text-region.
2677 \begin_layout Description
2678 Notion After enabling you can simply move arrow keys to get selected region.
2682 \begin_layout Description
2686 \begin_layout Subsection*
2690 \begin_layout Description
2691 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2695 \begin_layout Description
2699 \begin_layout Description
2700 Origin Andre, May 5 2006
2703 \begin_layout Subsection*
2707 \begin_layout Description
2708 Action Inserts math delimiters (e.g.
2709 parentheses, brackets) enclosing expression.
2713 \begin_layout Description
2714 Syntax math-delim [<LEFT>] [<RIGHT>]
2717 \begin_layout Description
2718 Params <LEFT/RIGHT>: Delimiters to be used.
2719 Each delimiter can be specified by either a LaTeX name or a valid character.
2720 ( is the default letter.
2724 \begin_layout Description
2725 Sample math-delim { rangle
2728 \begin_layout Description
2729 Origin Alejandro, 18 Jun 1996
2732 \begin_layout Subsection*
2736 \begin_layout Description
2737 Action Inserts math fixed size delimiters (e.g.
2738 parentheses, brackets) enclosing expression.
2742 \begin_layout Description
2743 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2746 \begin_layout Description
2747 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2748 \begin_inset Newline newline
2751 <L/RDELIM>: TeX code for delimiter.
2752 See Delimiter dialog for delimiters to be used.
2756 \begin_layout Description
2757 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2760 \begin_layout Description
2761 Origin Enrico & Georg, 7 May 2006
2764 \begin_layout Subsection*
2768 \begin_layout Description
2769 Action Creates a new displayed equation in text mode.
2770 Toggles inlined/display formula in math mode.
2774 \begin_layout Description
2775 Syntax math-display [<ARG>]
2778 \begin_layout Description
2779 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2780 new equation from the text mode.
2784 \begin_layout Description
2785 Origin Alejandro, 18 Jun 1996
2788 \begin_layout Subsection*
2792 \begin_layout Description
2793 Action Inserts math objects and symbols.
2797 \begin_layout Description
2798 Syntax math-insert <ARG>
2801 \begin_layout Description
2802 Params <ARG>: Symbol or LaTeX code to be inserted.
2806 \begin_layout Subsection*
2810 \begin_layout Description
2811 Action Enters subscript expression in math expression.
2815 \begin_layout Description
2816 Syntax math-subscript
2819 \begin_layout Description
2820 Origin vermeer, 12 Dec 2001
2823 \begin_layout Subsection*
2824 LFUN_MATH_SUPERSCRIPT
2827 \begin_layout Description
2828 Action Enters subscript expression in math expression.
2832 \begin_layout Description
2833 Syntax math-superscript
2836 \begin_layout Description
2837 Origin vermeer, 12 Dec 2001
2840 \begin_layout Subsection*
2844 \begin_layout Description
2845 Action Toggles the position of the limits from above/below to the right
2846 side an vice versa in integral symbol, a limit, a summation, etc.
2850 \begin_layout Description
2851 Notion Put the cursor before the symbol with the limits and then invoke
2856 \begin_layout Description
2857 Syntax math-limits [<STATE>]
2860 \begin_layout Description
2861 Params <STATE>: limits|nolimits
2864 \begin_layout Subsection*
2868 \begin_layout Description
2869 Action Inserts a math macro definition at the cursor position in the text.
2873 \begin_layout Description
2874 Syntax math-macro <NAME> [<NARGS>] [def]
2877 \begin_layout Description
2878 Params <NAME>: The name of the macro, e.g.
2880 <NARGS>: The number of parameters of the macro.
2882 "def": Has no effect anymore, just for compatibility with former LyX versions.
2886 \begin_layout Description
2887 Origin ale, 10 May 1997; sts, 21 Dec 2007
2890 \begin_layout Subsection*
2894 \begin_layout Description
2895 Action Mutates the type of math inset to the newly selected one.
2899 \begin_layout Description
2900 Syntax math-mutate <TYPE>
2903 \begin_layout Description
2904 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2905 multline|gather|flalign
2908 \begin_layout Description
2909 Origin Andre, 23 May 2001
2912 \begin_layout Subsection*
2916 \begin_layout Description
2917 Action Inserts space into math expression.
2921 \begin_layout Description
2922 Notion Use spacebar after entering this space to change type of space.
2926 \begin_layout Description
2927 Syntax math-space [<TYPE>] [<LEN>]
2930 \begin_layout Description
2931 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2933 \begin_inset Newline newline
2936 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2938 \begin_inset Newline newline
2941 custom space: hspace
2942 \begin_inset Newline newline
2945 "," used by default.
2946 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
2948 <LEN>: length for custom spaces (hspace)
2951 \begin_layout Description
2952 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2955 \begin_layout Subsection*
2959 \begin_layout Description
2960 Action Inserts a matrix.
2964 \begin_layout Description
2965 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2968 \begin_layout Description
2969 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
2971 1 char) and the horizontal alignments (l, c or r) (i.e.
2976 \begin_layout Description
2977 Sample math-matrix 3 3 bccc
2980 \begin_layout Subsection*
2984 \begin_layout Description
2985 Action In text mode enters math mode (i.e.
2986 puts math insets on the current cursor position), in math mode enters text
2987 mode inside math expression.
2991 \begin_layout Description
2992 Notion If there is some selected text, it puts the text inside created math
2997 \begin_layout Description
2998 Syntax math-mode [<ARG>]
3001 \begin_layout Description
3002 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3007 \begin_layout Description
3008 Origin Alejandro, 4 Jun 1996
3011 \begin_layout Subsection*
3015 \begin_layout Description
3016 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3018 Used by the advanced search dialog.
3022 \begin_layout Description
3023 Notion If there is any selected text, then it is moved inside the created
3028 \begin_layout Description
3029 Syntax regexp-mode [<ARG>]
3032 \begin_layout Description
3033 Params <ARG>: eventual argument (regular expression).
3037 \begin_layout Description
3038 Origin Tommaso, 4 Oct 2008
3041 \begin_layout Subsection*
3042 LFUN_MATH_NUMBER_LINE_TOGGLE
3045 \begin_layout Description
3046 Action Toggles numbering of the current formula line.
3050 \begin_layout Description
3051 Notion Must be in display formula mode.
3055 \begin_layout Description
3056 Syntax math-number-line-toggle
3059 \begin_layout Description
3060 Origin Alejandro, 18 Jun 1996
3063 \begin_layout Subsection*
3064 LFUN_MATH_NUMBER_TOGGLE
3067 \begin_layout Description
3068 Action Toggles numbering/labeling of the current formula.
3072 \begin_layout Description
3073 Notion Must be in display formula mode.
3077 \begin_layout Description
3078 Syntax math-number-toggle
3081 \begin_layout Description
3082 Origin Alejandro, 4 Jun 1996
3085 \begin_layout Subsection*
3089 \begin_layout Description
3090 Action Calls external program and passes the current expression/equation
3091 as an argument for the calculation in the format appropriate to the given
3096 \begin_layout Description
3097 Notion Selection can be used to determine the input for the external program.
3101 \begin_layout Description
3102 Syntax math-extern <LANG> [<COMMAND>]
3105 \begin_layout Description
3106 Params <LANG>: octave|maxima|maple|mathematica|script
3107 \begin_inset Newline newline
3110 where "script" stands fot the external script (normalized expression will
3114 \begin_layout Description
3115 Origin Andre, 24 Apr 2001
3118 \begin_layout Description
3119 Sample math-extern maple simplify
3122 \begin_layout Subsection*
3126 \begin_layout Description
3127 Action Changes arbitrarily the size used by math fonts inside a context.
3131 \begin_layout Description
3132 Notion Provides an interface to the LaTeX math mode font size commands.
3136 \begin_layout Description
3137 Syntax math-size <STYLE>
3140 \begin_layout Description
3141 Params <STYLE>: displaystyle|
3150 \begin_layout Description
3151 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3154 \begin_layout Subsection*
3155 LFUN_MATH_MACRO_UNFOLD
3158 \begin_layout Description
3159 Action Unfold a Math Macro.
3163 \begin_layout Description
3164 Notion Unfold the Math Macro the cursor is in, i.e.
3169 \begin_layout Description
3170 Syntax math-macro-unfold
3173 \begin_layout Description
3174 Origin sts, 06 January 2008
3177 \begin_layout Subsection*
3178 LFUN_MATH_MACRO_FOLD
3181 \begin_layout Description
3182 Action Fold a Math Macro.
3186 \begin_layout Description
3187 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3188 displayed as foo before.
3192 \begin_layout Description
3193 Syntax math-macro-fold
3196 \begin_layout Description
3197 Origin sts, 06 January 2008
3200 \begin_layout Subsection*
3201 LFUN_MATH_MACRO_ADD_PARAM
3204 \begin_layout Description
3205 Action Add a parameter.
3209 \begin_layout Description
3210 Notion Add a parameter to a Math Macro.
3214 \begin_layout Description
3215 Params <NUM>: The number of the parameter behind which the new one will
3216 be added (1 for the first, i.e.
3217 use 0 for add a parameter at the left), defaults to the last one.
3221 \begin_layout Description
3222 Syntax math-macro-add-param <NUM>
3225 \begin_layout Description
3226 Origin sts, 06 January 2008
3229 \begin_layout Subsection*
3230 LFUN_MATH_MACRO_REMOVE_PARAM
3233 \begin_layout Description
3234 Action Remove the last parameter.
3238 \begin_layout Description
3239 Notion Remove the last parameter of a Math Macro and remove its value in
3240 all instances of the macro in the buffer.
3244 \begin_layout Description
3245 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3246 defaults to the last one.
3250 \begin_layout Description
3251 Syntax math-macro-remove-param <NUM>
3254 \begin_layout Description
3255 Origin sts, 06 January 2008
3258 \begin_layout Subsection*
3259 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3262 \begin_layout Description
3263 Action Append a greedy parameter.
3267 \begin_layout Description
3268 Notion Append a greedy parameter to a Math Macro which eats the following
3269 mathed cell in every instance of the macro in the buffer.
3273 \begin_layout Description
3274 Syntax math-macro-append-greedy-param
3277 \begin_layout Description
3278 Origin sts, 06 January 2008
3281 \begin_layout Subsection*
3282 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3285 \begin_layout Description
3286 Action Remove a greedy parameter.
3290 \begin_layout Description
3291 Notion Remove a greedy parameter of a Math Macro and spit out the values
3292 of it in every instance of the macro in the buffer.
3293 If it is an optional parameter the [valud] format is used.
3297 \begin_layout Description
3298 Syntax math-macro-remove-greedy-param
3301 \begin_layout Description
3302 Origin sts, 06 January 2008
3305 \begin_layout Subsection*
3306 LFUN_MATH_MACRO_MAKE_OPTIONAL
3309 \begin_layout Description
3310 Action Make a parameter optional.
3314 \begin_layout Description
3315 Notion Turn the first non-optional parameter of a Math Macro into an optional
3316 parameter with a default value.
3320 \begin_layout Description
3321 Syntax math-macro-make-optional
3324 \begin_layout Description
3325 Origin sts, 06 January 2008
3328 \begin_layout Subsection*
3329 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3332 \begin_layout Description
3333 Action Make a parameter non-optional.
3337 \begin_layout Description
3338 Notion Turn the last optional parameter of a Math Macro into a non-optional
3340 The default value is remembered to be reused later if the user changes
3345 \begin_layout Description
3346 Syntax math-macro-make-nonoptional
3349 \begin_layout Description
3350 Origin sts, 06 January 2008
3353 \begin_layout Subsection*
3354 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3357 \begin_layout Description
3358 Action Add an optional parameter.
3362 \begin_layout Description
3363 Notion Insert an optional parameter just behind the already existing optional
3368 \begin_layout Description
3369 Syntax math-macro-add-optional-param
3372 \begin_layout Description
3373 Origin sts, 06 January 2008
3376 \begin_layout Subsection*
3377 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3380 \begin_layout Description
3381 Action Remove the last optional parameter.
3385 \begin_layout Description
3386 Notion Remove the last optional parameter of a Math Macro and remove it
3387 in all the instances of the macro in the buffer.
3391 \begin_layout Description
3392 Syntax math-macro-remove-optional-param
3395 \begin_layout Description
3396 Origin sts, 06 January 2008
3399 \begin_layout Subsection*
3400 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3403 \begin_layout Description
3404 Action Add a greedy optional parameter.
3408 \begin_layout Description
3409 Notion Add a greedy optional parameter which eats the value from the following
3410 cells in mathed which are in the [value] format.
3414 \begin_layout Description
3415 Syntax math-macro-add-greedy-optional-param
3418 \begin_layout Description
3419 Origin sts, 06 January 2008
3422 \begin_layout Subsection*
3423 LFUN_IN_MATHMACROTEMPLATE
3426 \begin_layout Description
3427 Action Only active in Math Macro definition.
3431 \begin_layout Description
3432 Notion Dummy function which is only active in a Math Macro definition.
3433 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3438 \begin_layout Description
3439 Syntax in-mathmacrotemplate
3442 \begin_layout Description
3443 Origin sts, 06 January 2008
3446 \begin_layout Subsection*
3447 LFUN_PARAGRAPH_MOVE_DOWN
3450 \begin_layout Description
3451 Action Moves the current paragraph downwards in the document.
3455 \begin_layout Description
3456 Syntax paragraph-move-down
3459 \begin_layout Description
3460 Origin Edwin, 8 Apr 2006
3463 \begin_layout Subsection*
3464 LFUN_PARAGRAPH_MOVE_UP
3467 \begin_layout Description
3468 Action Moves the current paragraph upwards in the document.
3472 \begin_layout Description
3473 Syntax paragraph-move-up
3476 \begin_layout Description
3477 Origin Edwin, 8 Apr 2006
3480 \begin_layout Subsection*
3484 \begin_layout Description
3485 Action Move the cursor to the next paragraph (or begining of the current
3486 one) in upward direction.
3490 \begin_layout Description
3494 \begin_layout Description
3495 Origin Asger, 1 Oct 1996
3498 \begin_layout Subsection*
3499 LFUN_PARAGRAPH_UP_SELECT
3502 \begin_layout Description
3503 Action Move the cursor and select the text to the next paragraph (or begining
3504 of the current one) in upward direction.
3508 \begin_layout Description
3509 Syntax paragraph-up-select
3512 \begin_layout Description
3513 Origin Asger, 1 Oct 1996
3516 \begin_layout Subsection*
3520 \begin_layout Description
3521 Action Move the cursor to the next paragraph (or begining of the current
3522 one) in downward direction.
3526 \begin_layout Description
3527 Syntax paragraph-down
3530 \begin_layout Description
3531 Origin Asger, 1 Oct 1996
3534 \begin_layout Subsection*
3535 LFUN_PARAGRAPH_DOWN_SELECT
3538 \begin_layout Description
3539 Action Move the cursor and select the text to the next paragraph (or begining
3540 of the current one) in downward direction.
3544 \begin_layout Description
3545 Syntax paragraph-down-select
3548 \begin_layout Description
3549 Origin Asger, 1 Oct 1996
3552 \begin_layout Subsection*
3556 \begin_layout Description
3557 Action Jump to a paragraph given by its id number and optionally the desired
3558 position within the paragraph.
3562 \begin_layout Description
3563 Notion Note that id number of paragraph is not the sequential number of
3564 paragraph seen on the screen.
3565 Moreover the id is unique for all opened buffers (documents).
3569 \begin_layout Description
3570 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3573 \begin_layout Description
3574 Params <PAR_ID_NUMBER>: paragraph id
3575 \begin_inset Newline newline
3578 <POSITION_IN_PAR>: desired position within the paragraph
3581 \begin_layout Description
3582 Origin Dekel, 26 Aug 2000
3585 \begin_layout Subsection*
3586 LFUN_BREAK_PARAGRAPH
3589 \begin_layout Description
3590 Action Breaks the current paragraph at the current location.
3594 \begin_layout Description
3595 Syntax break-paragraph
3598 \begin_layout Subsection*
3599 LFUN_BREAK_PARAGRAPH
3602 \begin_layout Description
3603 Action Breaks the current paragraph at the current location.
3607 \begin_layout Description
3608 Notion Removes the selection.
3612 \begin_layout Description
3613 Syntax break-paragraph [<LAYOUT>]
3616 \begin_layout Description
3617 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3618 default layout) when the cursor is at the end of the line.
3622 \begin_layout Subsection*
3623 LFUN_PARAGRAPH_PARAMS
3626 \begin_layout Description
3627 Action Change paragraph settings.
3631 \begin_layout Description
3632 Notion Modifies the current paragraph, or currently selected paragraphs.
3633 This function only modifies, and does not override, existing settings.
3634 Note that the "leftindent" indent setting is deprecated.
3638 \begin_layout Description
3639 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3642 \begin_layout Description
3652 \begin_inset Newline newline
3657 paragraph_spacing default|single|onehalf|double|other
3658 \begin_inset Newline newline
3663 align block|left|right|center|default
3664 \begin_inset Newline newline
3669 labelwidthstring WIDTH|
3672 \begin_inset Newline newline
3678 \begin_layout Description
3679 Origin rgh, Aug 15 2007
3682 \begin_layout Subsection*
3683 LFUN_PARAGRAPH_PARAMS_APPLY
3686 \begin_layout Description
3687 Action Change paragraph settings.
3691 \begin_layout Description
3692 Notion Overwrite all nonspecified settings to the default ones.
3693 Use paragraph-params lfun if you don't want to overwrite others settings.
3697 \begin_layout Description
3698 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3701 \begin_layout Description
3702 Params For parameters see LFUN_PARAGRAPH_PARAMS
3705 \begin_layout Description
3706 Origin leeming, 30 Mar 2004
3709 \begin_layout Subsection*
3710 LFUN_PARAGRAPH_UPDATE
3713 \begin_layout Description
3714 Action Updates the values inside the paragraph dialog from the paragraph.
3718 \begin_layout Description
3719 Notion This is internal LFUN, not to be used by users.
3720 Called internally by LFUN_DIALOG_UPDATE.
3724 \begin_layout Description
3725 Origin leeming, 13 Mar 2003
3728 \begin_layout Subsection*
3732 \begin_layout Description
3733 Action Move the current group in the upward direction in the structure of
3738 \begin_layout Description
3739 Notion The "group" can be Part/Chapter/Section/etc.
3740 It moves the whole substructure of the group.
3744 \begin_layout Description
3748 \begin_layout Description
3749 Origin Vermeer, 23 Mar 2006
3752 \begin_layout Subsection*
3756 \begin_layout Description
3757 Action Move the current group in the downward direction in the structure
3762 \begin_layout Description
3763 Notion The "group" can be Part/Chapter/Section/etc.
3764 It moves the whole substructure of the group.
3768 \begin_layout Description
3772 \begin_layout Description
3773 Origin Vermeer, 23 Mar 2006
3776 \begin_layout Subsection*
3780 \begin_layout Description
3781 Action Moves the current group in the downward direction in the hierarchy
3782 of the document structure.
3786 \begin_layout Description
3787 Notion Part -> Chapter -> Section -> etc.
3791 \begin_layout Description
3795 \begin_layout Description
3796 Origin Vermeer, 23 Mar 2006
3799 \begin_layout Subsection*
3803 \begin_layout Description
3804 Action Moves the current group in the upward direction in the hierarchy
3805 of the document structure.
3809 \begin_layout Description
3810 Notion Part <- Chapter <- Section <- etc.
3814 \begin_layout Description
3818 \begin_layout Description
3819 Origin Vermeer, 23 Mar 2006
3822 \begin_layout Subsection*
3826 \begin_layout Description
3827 Action Edit the inset at cursor with an external application, *
3828 if one is attributed.
3832 \begin_layout Description
3833 Syntax inset-edit [<INSET_PARAMS>]
3836 \begin_layout Description
3837 Params <INSET_PARAMS>: Parameters for the inset.
3839 \begin_inset Newline newline
3842 Currently only the filename will be considered.
3846 \begin_layout Description
3847 Origin JSpitzm, 27 Apr 2006
3850 \begin_layout Subsection*
3854 \begin_layout Description
3855 Action Inserts table into the document.
3859 \begin_layout Description
3860 Syntax tabular-insert [<ROWS> <COLUMNS>]
3863 \begin_layout Description
3864 Params In case no arguments are given show insert dialog.
3868 \begin_layout Description
3869 Origin Jug, 12 Apr 2000
3872 \begin_layout Subsection*
3873 LFUN_TABULAR_FEATURE
3876 \begin_layout Description
3877 Action Sets various features to the table/cell on the current cursor position.
3881 \begin_layout Description
3882 Notion Various math-environment features are handled here as well, e.g.
3883 add-vline-left/right for Grid/Cases environment
3886 \begin_layout Description
3887 Syntax tabular-feature <FEATURE> [<ARG>]
3890 \begin_layout Description
3891 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3892 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3893 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3894 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3895 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3896 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3897 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3898 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3899 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3900 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3901 |set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
3902 ar-valign-middle|tabular-valign-bottom
3903 \begin_inset Newline newline
3906 <ARG>: additional argument for some commands, use debug mode to explore
3911 \begin_layout Description
3912 Origin Jug, 28 Jul 2000
3915 \begin_layout Subsection*
3919 \begin_layout Description
3920 Action Moves the cursor to the previous cell inside the table.
3924 \begin_layout Description
3925 Syntax cell-backward
3928 \begin_layout Description
3929 Origin Jug, 22 May 2000
3932 \begin_layout Subsection*
3936 \begin_layout Description
3937 Action Moves the cursor to the next cell inside the table.
3941 \begin_layout Description
3945 \begin_layout Subsection*
3949 \begin_layout Description
3950 Action Splits cell and shifts right part to the next cell (inside the math
3955 \begin_layout Description
3959 \begin_layout Description
3960 Origin Ale, 15 May 1997
3963 \begin_layout Subsection*
3967 \begin_layout Description
3968 Action Register the document as an file inside version control system (RCS,
3973 \begin_layout Description
3974 Notion File is registered inside cvs, svn or rcs repository acording to
3975 the existence of cvs/svn/rcs entries in the document's directory.
3977 \begin_inset Newline newline
3980 See LyX Additional Features Manual (Version Control Chapter) for additional
3985 \begin_layout Description
3989 \begin_layout Description
3990 Origin Lgb, 1 Jul 1997
3993 \begin_layout Subsection*
3997 \begin_layout Description
3998 Action Checks-in/commits the changes of the registered file to the repository.
4002 \begin_layout Description
4003 Notion In RCS case this also unlocks the file.
4007 \begin_layout Description
4011 \begin_layout Description
4012 Origin Lgb, 1 Jul 1997
4015 \begin_layout Subsection*
4019 \begin_layout Description
4020 Action Checks-out the document for edit (and locks it for RCS).
4024 \begin_layout Description
4025 Notion This is implemented only for RCS and SVN, not CVS.
4029 \begin_layout Description
4033 \begin_layout Description
4034 Origin Lgb, 1 Jul 1997
4037 \begin_layout Subsection*
4041 \begin_layout Description
4042 Action Reverts the document to the last check-in/commit in VCS.
4046 \begin_layout Description
4050 \begin_layout Description
4051 Origin Lgb, 1 Jul 1997
4054 \begin_layout Subsection*
4058 \begin_layout Description
4059 Action Undo last check-in.
4063 \begin_layout Description
4064 Notion This is currently implemented only for RCS.
4068 \begin_layout Description
4072 \begin_layout Description
4073 Origin Lgb, 1 Jul 1997
4076 \begin_layout Subsection*
4080 \begin_layout Description
4081 Action Toggles change tracking to on/off.
4085 \begin_layout Description
4086 Syntax changes-track
4089 \begin_layout Description
4090 Origin levon, 1 Oct 2002
4093 \begin_layout Subsection*
4097 \begin_layout Description
4098 Action Toggles showing of change tracking in typesetted output.
4102 \begin_layout Description
4103 Syntax changes-output
4106 \begin_layout Description
4107 Origin jspitzm, 21 Jan 2005
4110 \begin_layout Subsection*
4114 \begin_layout Description
4115 Action Moves the cursor to the position of the next change of the change
4120 \begin_layout Description
4124 \begin_layout Description
4125 Origin schmitt, 4 Oct 2006
4128 \begin_layout Subsection*
4132 \begin_layout Description
4133 Action Open change tracking dialog for merging and moves the cursor to the
4134 position of the next change.
4138 \begin_layout Description
4139 Syntax changes-merge
4142 \begin_layout Description
4143 Origin Levon, 16 Oct 2002
4146 \begin_layout Subsection*
4150 \begin_layout Description
4151 Action Accepts tracked change inside the selection.
4155 \begin_layout Description
4156 Syntax change-accept
4159 \begin_layout Description
4160 Origin Levon, 16 Oct 2002
4163 \begin_layout Subsection*
4167 \begin_layout Description
4168 Action Rejects tracked change inside the selection.
4172 \begin_layout Description
4173 Syntax change-accept
4176 \begin_layout Description
4177 Origin Levon, 16 Oct 2002
4180 \begin_layout Subsection*
4181 LFUN_ALL_CHANGES_ACCEPT
4184 \begin_layout Description
4185 Action Accepts all tracked changes in the document.
4189 \begin_layout Description
4190 Syntax all-changes-accept
4193 \begin_layout Description
4194 Origin Levon, 16 Oct 2002
4197 \begin_layout Subsection*
4198 LFUN_ALL_CHANGES_REJECT
4201 \begin_layout Description
4202 Action Rejects all tracked changes in the document.
4206 \begin_layout Description
4207 Notion Reject does not work recursively; the user may have to repeat the
4212 \begin_layout Description
4213 Syntax all-changes-reject
4216 \begin_layout Description
4217 Origin Levon, 16 Oct 2002
4220 \begin_layout Subsection*
4224 \begin_layout Description
4225 Action Apply data for an inset.
4229 \begin_layout Description
4230 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4232 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4233 on the context where it is called.
4237 \begin_layout Description
4238 Syntax inset-apply <ARGS>
4241 \begin_layout Description
4242 Params See LFUN_INSET_INSERT .
4246 \begin_layout Subsection*
4250 \begin_layout Description
4251 Action Dissolve the current inset into text.
4255 \begin_layout Description
4256 Syntax inset-dissolve [<INSET>]
4259 \begin_layout Description
4260 Params <INSET>: this can be used to make sure the right kind of inset is
4262 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4263 the charstyle inset, even if the cursor is inside several nested insets
4266 \begin_inset Newline newline
4269 For values see lyx::InsetLayout::lyxtype_ .
4273 \begin_layout Description
4274 Origin JSpitz, 7 Aug 2006
4277 \begin_layout Subsection*
4281 \begin_layout Description
4282 Action Insert new inset (type given by the parameters).
4286 \begin_layout Description
4287 Syntax inset-insert <INSET> <ARGS>
4290 \begin_layout Description
4291 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4292 nclude|index|label|nomencl|vspace|ref|toc>
4293 \begin_inset Newline newline
4296 <ARGS>: depends on the given inset.
4297 Use "lyx -dbg action" to explore.
4301 \begin_layout Description
4302 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4305 \begin_inset Newline newline
4308 where <label name> is the name of the referenced label and<Format> is one
4310 \begin_inset Newline newline
4314 \begin_inset Newline newline
4317 eqref -- (<reference>)
4318 \begin_inset Newline newline
4322 \begin_inset Newline newline
4325 vpageref -- on <page>
4326 \begin_inset Newline newline
4329 vref -- <reference> on <page>
4330 \begin_inset Newline newline
4333 prettyref -- Formatted reference
4336 \begin_layout Subsection*
4340 \begin_layout Description
4341 Action Modify existing inset.
4345 \begin_layout Description
4346 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4347 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4352 \begin_layout Description
4353 Syntax inset-modify <INSET> <ARGS>
4356 \begin_layout Description
4357 Params See LFUN_INSET_INSERT for further details.
4361 \begin_layout Subsection*
4362 LFUN_NEXT_INSET_MODIFY
4365 \begin_layout Description
4366 Action Modify the inset at cursor position, if there is one.
4370 \begin_layout Description
4371 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4372 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4377 \begin_layout Description
4378 Syntax next-inset-modify <INSET> <ARGS>
4381 \begin_layout Description
4382 Syntax next-inset-modify changetype <TYPE>
4385 \begin_layout Description
4386 Params See LFUN_INSET_INSERT for further details.
4390 \begin_layout Description
4391 Origin JSpitzm, 23 Mar 2008
4394 \begin_layout Subsection*
4395 LFUN_INSET_DIALOG_UPDATE
4398 \begin_layout Description
4399 Action Updates the values inside the dialog from the inset.
4403 \begin_layout Description
4404 Notion This is internal LFUN, not to be used by users.
4405 Called internally by LFUN_DIALOG_UPDATE
4408 \begin_layout Description
4409 Params <DIALOG-NAME>
4412 \begin_layout Description
4413 Origin leeming, 25 Feb 2003
4416 \begin_layout Subsection*
4420 \begin_layout Description
4421 Action Open the inset's properties dialog.
4425 \begin_layout Description
4426 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4430 \begin_layout Description
4431 Syntax inset-settings <INSET>
4434 \begin_layout Description
4435 Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
4438 \begin_layout Subsection*
4439 LFUN_NEXT_INSET_TOGGLE
4442 \begin_layout Description
4443 Action Toggles the inset at cursor position.
4444 For collapsables, this means it will be (un-)collapsed, in case of other
4445 insets, the editing widget (dialog) will be entered.
4447 LFUN_INSET_SETTINGS.
4451 \begin_layout Description
4452 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4453 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4458 \begin_layout Description
4459 Syntax next-inset-toggle <ARG>
4462 \begin_layout Description
4463 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4467 \begin_layout Description
4468 Origin leeming, 30 Mar 2004
4471 \begin_layout Subsection*
4475 \begin_layout Description
4476 Action Toggles the collapsable inset we are currently in.
4480 \begin_layout Description
4481 Syntax inset-toggle [<ARG>]
4484 \begin_layout Description
4485 Params <ARG>: <open|close|toggle|assign>.
4487 \begin_inset Newline newline
4490 open/close/toggle are for collapsable insets.
4491 close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4492 toggle is used when no argument is given.
4494 \begin_inset Newline newline
4497 assign is for branch inset.
4501 \begin_layout Description
4502 Origin lasgouttes, 19 Jul 2001
4505 \begin_layout Subsection*
4506 LFUN_ALL_INSETS_TOGGLE
4509 \begin_layout Description
4510 Action Toggles (open/closes) all collapsable insets (of a given type) in
4515 \begin_layout Description
4516 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4520 \begin_layout Description
4521 Syntax all-insets-toggle <STATE> <INSET>
4524 \begin_layout Description
4525 Params <STATE>: <toggle|open|close> default: toggle
4526 \begin_inset Newline newline
4529 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4533 \begin_layout Description
4534 Origin leeming, 30 Mar 2004
4537 \begin_layout Subsection*
4538 LFUN_SET_GRAPHICS_GROUP
4541 \begin_layout Description
4542 Action Set the group for the graphics inset on the cursor position.
4546 \begin_layout Description
4547 Syntax set-graphics-group [<GROUP>]
4550 \begin_layout Description
4551 Params <GROUP>: Id for an existing group.
4552 In case the Id is an empty string, the graphics inset is removed from the
4557 \begin_layout Description
4558 Origin sanda, 6 May 2008
4561 \begin_layout Subsection*
4562 LFUN_FINISHED_FORWARD
4565 \begin_layout Description
4566 Action Moves the cursor out of the current slice, going forward.
4570 \begin_layout Description
4571 Notion Cursor movement within an inset may be different than cursor movement
4572 in the surrounding text.
4573 This action should be called automatically by the cursor movement within
4574 the inset, when movement within the inset has ceased (reached the end of
4575 the last paragraph, for example), in order to move correctly back into
4576 the surrounding text.
4580 \begin_layout Subsection*
4581 LFUN_FINISHED_BACKWARD
4584 \begin_layout Description
4585 Action Moves the cursor out of the current slice, going backwards.
4589 \begin_layout Description
4590 Notion See also LFUN_FINISHED_FORWARD.
4594 \begin_layout Subsection*
4598 \begin_layout Description
4599 Action Moves the cursor out of the current slice, going right.
4603 \begin_layout Description
4604 Notion See also LFUN_FINISHED_FORWARD
4607 \begin_layout Subsection*
4611 \begin_layout Description
4612 Action Moves the cursor out of the current slice, going left.
4616 \begin_layout Description
4617 Notion See also LFUN_FINISHED_FORWARD.
4621 \begin_layout Subsection*
4625 \begin_layout Description
4626 Action Set language from the current cursor position.
4630 \begin_layout Description
4631 Syntax language <LANG>
4634 \begin_layout Description
4635 Params <LANG>: Requested language.
4636 Look in lib/languages for the list.
4640 \begin_layout Description
4641 Origin Dekel, 2 Mar 2000
4644 \begin_layout Subsection*
4648 \begin_layout Description
4649 Action Goto a label.
4653 \begin_layout Description
4654 Syntax label-goto [<LABEL>]
4657 \begin_layout Description
4658 Params <LABEL>: Requested label.
4659 If no label is given and refernce is on cursor position, Bookmark 0 is
4660 saved and cursor moves to the position of referenced label.
4664 \begin_layout Description
4665 Origin Ale, 6 Aug 1997
4668 \begin_layout Subsection*
4672 \begin_layout Description
4673 Action Inserts label to text or displayed formula.
4677 \begin_layout Description
4678 Syntax label-insert [<LABEL>]
4681 \begin_layout Description
4682 Params <LABEL>: Requested label.
4683 If no label is given dialog requesting name will be opened.
4687 \begin_layout Subsection*
4691 \begin_layout Description
4692 Action Go to the next label or cross-reference.
4696 \begin_layout Description
4697 Syntax reference-next
4700 \begin_layout Description
4701 Origin Dekel, 14 Jan 2001
4704 \begin_layout Subsection*
4708 \begin_layout Description
4709 Action Goto a bookmark.
4713 \begin_layout Description
4714 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4715 Note that bookmarsk are saved per-session, not per file.
4719 \begin_layout Description
4720 Syntax bookmark-goto <NUMBER>
4723 \begin_layout Description
4724 Params <NUMBER>: the number of the bookmark to restore.
4728 \begin_layout Description
4729 Origin Dekel, 27 January 2001
4732 \begin_layout Subsection*
4736 \begin_layout Description
4737 Action Save a bookmark.
4741 \begin_layout Description
4742 Notion Saves a numbered bookmark to the sessions file.
4743 The number must be between 1 and 9, inclusive.
4744 Note that bookmarks are saved per-session, not per file.
4748 \begin_layout Description
4749 Syntax bookmark-save <NUMBER>
4752 \begin_layout Description
4753 Params <NUMBER>: the number of the bookmark to save.
4757 \begin_layout Description
4758 Origin Dekel, 27 January 2001
4761 \begin_layout Subsection*
4765 \begin_layout Description
4766 Action Clears the list of saved bookmarks.
4770 \begin_layout Description
4771 Syntax bookmark-clear
4774 \begin_layout Description
4775 Origin bpeng, 31 October 2006
4778 \begin_layout Subsection*
4782 \begin_layout Description
4783 Action Open the given help file according to the language setting.
4787 \begin_layout Description
4788 Syntax help-open <FILE>[.lyx]
4791 \begin_layout Description
4792 Params <FILE>: any document from (/usr/share/)doc directory.
4796 \begin_layout Description
4797 Origin Jug, 27 Jun 1999
4800 \begin_layout Subsection*
4804 \begin_layout Description
4805 Action Terminates the current LyX instance.
4809 \begin_layout Description
4810 Notion Terminates the current LyX instance, asking whether to save modified
4815 \begin_layout Description
4819 \begin_layout Subsection*
4823 \begin_layout Description
4824 Action Toggles visibility of a given toolbar between on/off/auto.
4828 \begin_layout Description
4829 Notion Skiping "auto" when allowauto is false.
4833 \begin_layout Description
4834 Syntax toolbar-toggle <NAME> [allowauto]
4837 \begin_layout Description
4838 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4839 ew/update|math_panels|vcs
4842 \begin_layout Description
4843 Origin Edwin, 21 May 2007
4846 \begin_layout Subsection*
4850 \begin_layout Description
4851 Action Opens the menu given by its name.
4855 \begin_layout Description
4856 Syntax menu-open <NAME>
4859 \begin_layout Description
4860 Params <NAME>: menu name.
4861 See various .inc files in lib/ui for candidates.
4865 \begin_layout Subsection*
4869 \begin_layout Description
4870 Action Various UI visibility-toggling actions.
4874 \begin_layout Description
4875 Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
4878 \begin_layout Description
4879 Params statusbar : Toggle visibility of the statusbar.
4881 \begin_inset Newline newline
4884 menubar : Toggle visibility of the menubar.
4886 \begin_inset Newline newline
4889 scrollbar : Toggle visibility of the scrollbar.
4891 \begin_inset Newline newline
4894 frame : Toggle visibility of the frames around editing window.
4896 \begin_inset Newline newline
4899 fullscreen : Toggle fullscreen mode.
4900 This also covers calling the previous functions.
4901 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4906 \begin_layout Description
4907 Origin sanda, 9 Feb 2007
4910 \begin_layout Subsection*
4914 \begin_layout Description
4915 Action Creates new empty LyX window.
4919 \begin_layout Description
4920 Notion Already opened documents from the previous window can be found under
4925 \begin_layout Description
4926 Syntax window-new [<GEOMETRY>]
4929 \begin_layout Description
4930 Params <GEOMETRY>: pass the geometry of the window.
4931 This parameter is currently accepted only on Windows platform.
4935 \begin_layout Description
4936 Origin Abdel, 21 Oct 2006
4939 \begin_layout Subsection*
4943 \begin_layout Description
4944 Action Closes the current LyX window.
4948 \begin_layout Description
4952 \begin_layout Description
4953 Origin Abdel, 23 Oct 2006
4956 \begin_layout Subsection*
4960 \begin_layout Description
4961 Action Creates another split view of current buffer.
4965 \begin_layout Description
4966 Notion All split views act in the same way indpendently.
4970 \begin_layout Description
4971 Syntax split-view <vertical|horizontal>
4974 \begin_layout Description
4975 Params horizontal : The work areas are laid out side by side.
4977 \begin_inset Newline newline
4980 vertical : The work areas laid out vertically.
4984 \begin_layout Description
4985 Origin Abdel, 20 Feb 2008
4988 \begin_layout Subsection*
4989 LFUN_CLOSE_TAB_GROUP
4992 \begin_layout Description
4993 Action Close the current tab group.
4997 \begin_layout Description
4998 Notion This only closes the work areas, not the buffer themselves.
4999 The still opened buffers can be visualized in another tab group.
5003 \begin_layout Description
5004 Syntax close-tab-group
5007 \begin_layout Description
5008 Origin Abdel, 21 Feb 2008
5011 \begin_layout Subsection*
5015 \begin_layout Description
5016 Action Shows hidden dialog or create new one for a given function/inset
5021 \begin_layout Description
5022 Syntax dialog-show <NAME> [<DATA>]
5025 \begin_layout Description
5026 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5028 \begin_inset Newline newline
5031 document|errorlist|ert|external|file|findreplace|float|graphics|
5032 \begin_inset Newline newline
5035 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
5036 \begin_inset Newline newline
5039 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
5040 \begin_inset Newline newline
5043 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
5044 \begin_inset Newline newline
5047 wrap|listings|<SPECIAL>
5048 \begin_inset Newline newline
5051 <SPECIAL>: latexlog|vclog
5052 \begin_inset Newline newline
5055 <DATA>: data, usually settings for the given dialog.
5056 Use debug mode for the details.
5060 \begin_layout Description
5061 Origin leeming, 17 Jun 2003
5064 \begin_layout Subsection*
5065 LFUN_DIALOG_SHOW_NEW_INSET
5068 \begin_layout Description
5069 Action Shows hidden dialog or create new one for a given inset settings
5074 \begin_layout Description
5075 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5080 \begin_layout Description
5081 Syntax dialog-show-new-inset <NAME> [<DATA>]
5084 \begin_layout Description
5085 Params See LFUN_DIALOG_SHOW .
5089 \begin_layout Description
5090 Origin leeming, 25 Feb 2003
5093 \begin_layout Subsection*
5097 \begin_layout Description
5098 Action Updates the dialog values from the inset/paragraph/document.
5102 \begin_layout Description
5103 Syntax dialog-update <NAME>
5106 \begin_layout Description
5107 Params <NAME>: paragraph|prefs|<INSET>
5108 \begin_inset Newline newline
5114 \begin_layout Description
5115 Origin leeming, 25 Feb 2003
5118 \begin_layout Subsection*
5122 \begin_layout Description
5123 Action Hides showed dialog.
5124 Counterpart to LFUN_DIALOG_SHOW .
5128 \begin_layout Description
5129 Syntax dialog-hide <NAME>
5132 \begin_layout Description
5133 Params See LFUN_DIALOG_SHOW .
5137 \begin_layout Description
5138 Origin leeming, 25 Feb 2003
5141 \begin_layout Subsection*
5145 \begin_layout Description
5146 Action Toggles dialog between showed/hidden state.
5150 \begin_layout Description
5151 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5155 \begin_layout Description
5156 Syntax dialog-toggle <NAME> [<DATA>]
5159 \begin_layout Description
5160 Params See LFUN_DIALOG_SHOW .
5164 \begin_layout Description
5165 Origin JSpitzm, 30 Apr 2007
5168 \begin_layout Subsection*
5169 LFUN_DIALOG_DISCONNECT_INSET
5172 \begin_layout Description
5173 Action Closes opened connection to opened inset.
5177 \begin_layout Description
5178 Notion Connection is used for apply functions.
5182 \begin_layout Description
5183 Syntax dialog-disconnect-inset <INSET-NAME>
5186 \begin_layout Description
5187 Origin leeming, 25 Feb 2003
5190 \begin_layout Subsection*
5194 \begin_layout Description
5195 Action This function is called when mouse button is pressed (inside workarea).Act
5196 ion depends on the context.
5200 \begin_layout Description
5201 Notion This is internal LFUN, not to be used by users.
5205 \begin_layout Description
5206 Origin Andre, 9 Aug 2002
5209 \begin_layout Subsection*
5213 \begin_layout Description
5214 Action This function is called when double click on mouse button is pressed
5216 Action depends on the context.
5220 \begin_layout Description
5221 Notion This is internal LFUN, not to be used by users.
5225 \begin_layout Description
5226 Origin Andre, 9 Aug 2002
5229 \begin_layout Subsection*
5233 \begin_layout Description
5234 Action This function is called when triple click on mouse button is pressed
5236 Action depends on the context.
5240 \begin_layout Description
5241 Notion This is internal LFUN, not to be used by users.
5245 \begin_layout Description
5246 Origin Andre, 9 Aug 2002
5249 \begin_layout Subsection*
5253 \begin_layout Description
5254 Action This function is called when mouse cursor is moving over the text.Action
5255 depends on the context.
5259 \begin_layout Description
5260 Notion This is internal LFUN, not to be used by users.
5264 \begin_layout Description
5265 Origin Andre, 9 Aug 2002
5268 \begin_layout Subsection*
5272 \begin_layout Description
5273 Action This function is called when mouse button is released (inside workarea).Ac
5274 tion depends on the context.
5278 \begin_layout Description
5279 Notion This is internal LFUN, not to be used by users.
5283 \begin_layout Description
5284 Origin Andre, 9 Aug 2002
5287 \begin_layout Subsection*
5291 \begin_layout Description
5292 Action Turn off the loaded keyboard map.
5296 \begin_layout Description
5300 \begin_layout Subsection*
5304 \begin_layout Description
5305 Action Turn on the primary keyboard map.
5309 \begin_layout Description
5310 Notion Maps were widely used in past, when X-windows didn't have nowadays
5312 They can be still used to maintain uniform keyboard layout across the various
5315 \begin_inset Newline newline
5318 The language is to be set in the Preferences dialog.
5322 \begin_layout Description
5323 Syntax keymap-primary
5326 \begin_layout Subsection*
5327 LFUN_KEYMAP_SECONDARY
5330 \begin_layout Description
5331 Action Turn on the secondary keyboard map.
5335 \begin_layout Description
5336 Syntax keymap-secondary
5339 \begin_layout Subsection*
5343 \begin_layout Description
5344 Action Toggles keyboard maps (first/second/off).
5348 \begin_layout Description
5349 Syntax keymap-toggle
5352 \begin_layout Description
5353 Origin leeming, 30 Mar 2004
5356 \begin_layout Subsection*
5357 LFUN_SERVER_GET_LAYOUT
5360 \begin_layout Description
5361 Action Returns the current layout (that is environment) name on the cursor
5366 \begin_layout Description
5367 Syntax server-get-layout
5370 \begin_layout Subsection*
5371 LFUN_SERVER_GET_FILENAME
5374 \begin_layout Description
5375 Action Returns path and file name of the currently edited document.
5379 \begin_layout Description
5380 Syntax server-get-filename
5383 \begin_layout Subsection*
5384 LFUN_SERVER_GOTO_FILE_ROW
5387 \begin_layout Description
5388 Action Sets the cursor position based on the row number of generated TeX
5393 \begin_layout Description
5394 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5397 \begin_layout Description
5398 Origin Edmar, 23 Dec 1998
5401 \begin_layout Subsection*
5405 \begin_layout Description
5406 Action Sends notify message about the last key-sequence to client.
5410 \begin_layout Description
5411 Notion This can be used to grab last key-sequence used inside the LyX window.
5412 See also Debug extensions section in Additional features manual.
5416 \begin_layout Description
5417 Syntax server-notify
5420 \begin_layout Subsection*
5424 \begin_layout Description
5425 Action Sets the cursor position based on the editing area coordinates (similar
5426 as clicking on that point with left mouse button).
5430 \begin_layout Description
5431 Syntax server-set-xy <X> <Y>
5434 \begin_layout Subsection*
5438 \begin_layout Description
5439 Action Returns the coordinates of cursor position in the editing area.
5443 \begin_layout Description
5444 Syntax server-get-xy
5447 \begin_layout Subsection*
5451 \begin_layout Description
5452 Action Generates the code (literate programming).
5456 \begin_layout Description
5457 Notion Latex file with extension literate_extension is generated.
5458 Then LyX invokes build_command (with a default of``make'') to generate
5459 the code and build_error_filter to process the compilation error messages.
5461 \begin_inset Newline newline
5464 In case you want to process your literate file with a script, or some other
5465 program, just insert in your lyxrc file an entry with:
5466 \begin_inset Newline newline
5469 build_command "my_script my_arguments"
5470 \begin_inset Newline newline
5473 The build_error_filter differs from the literate_error_filter only in that
5474 the former will identify error messages from your compiler.
5478 \begin_layout Description
5479 Syntax build-program
5482 \begin_layout Subsection*
5483 LFUN_BUFFER_AUTO_SAVE
5486 \begin_layout Description
5487 Action Saves the current buffer to a temporary file.
5491 \begin_layout Description
5492 Notion Saves the current buffer to a file named "#filename#".
5493 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5497 \begin_layout Description
5498 Syntax buffer-auto-save
5501 \begin_layout Subsection*
5502 LFUN_BUFFER_CHILD_OPEN
5505 \begin_layout Description
5506 Action Loads the given child document.
5510 \begin_layout Description
5511 Notion The current document is treated as a parent.
5515 \begin_layout Description
5516 Syntax buffer-child-open <FILE>
5519 \begin_layout Description
5520 Params <FILE>: Filename of the child.
5521 The directory of the parent is assumed by default.
5525 \begin_layout Description
5526 Origin Ale, 28 May 1997
5529 \begin_layout Subsection*
5533 \begin_layout Description
5534 Action Runs chktex for the current document.
5538 \begin_layout Description
5539 Syntax buffer-chktex
5542 \begin_layout Description
5543 Origin Asger, 30 Oct 1997
5546 \begin_layout Subsection*
5547 LFUN_BUFFER_TOGGLE_COMPRESSION
5550 \begin_layout Description
5551 Action Toggles compression of the current document on/off.
5555 \begin_layout Description
5556 Syntax buffer-toggle-compression
5559 \begin_layout Description
5560 Origin bpeng, 27 Apr 2006
5563 \begin_layout Subsection*
5567 \begin_layout Description
5568 Action Closes the current buffer.
5572 \begin_layout Description
5573 Notion Closes the current buffer, asking whether to save it, etc, if the
5574 buffer has been modified.
5578 \begin_layout Description
5582 \begin_layout Subsection*
5586 \begin_layout Description
5587 Action Exports the current buffer (document) to the given format.
5591 \begin_layout Description
5592 Syntax buffer-export <FORMAT>
5595 \begin_layout Description
5596 Params <FORMAT> is either "custom" or one of the formats which you can find
5597 in Tools->Preferences->File formats->Format.
5598 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5599 for pdflatex) or "ps" for postscript.
5601 \begin_inset Newline newline
5604 In case of "custom" you will be asked for a format you want to start from
5605 and for the command that you want to apply to this format.
5606 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5610 \begin_layout Description
5611 Origin Lgb, 29 Jul 1997
5614 \begin_layout Subsection*
5615 LFUN_BUFFER_EXPORT_CUSTOM
5618 \begin_layout Description
5619 Action Exports the current buffer (document) from the given format using
5620 the given command on it.
5624 \begin_layout Description
5625 Syntax buffer-export-custom <FORMAT> <COMMAND>
5628 \begin_layout Description
5629 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5632 \begin_inset Newline newline
5635 <COMMAND> this command will be launched on the file.
5636 Note that you can use "$$FName" string to qualify the intermediate file.
5640 \begin_layout Description
5641 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5644 \begin_layout Description
5645 Origin leeming, 27 Mar 2004
5648 \begin_layout Subsection*
5652 \begin_layout Description
5653 Action Prints the current document.
5657 \begin_layout Description
5658 Notion Many settings can be given via the preferences dialog.
5662 \begin_layout Description
5663 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5666 \begin_layout Description
5667 Params <TARGET> is either "printer" or "file".
5669 \begin_inset Newline newline
5672 <TARGER-NAME> is either "default" or file name or printer name.
5674 \begin_inset Newline newline
5677 <COMMAND> command ensuring the printing job.
5681 \begin_layout Description
5682 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5685 \begin_layout Description
5686 Origin leeming, 28 Mar 2004
5689 \begin_layout Subsection*
5693 \begin_layout Description
5694 Action Import a given file as a lyx document.
5698 \begin_layout Description
5699 Notion File can be imported iff lyx file format is (transitively) reachable
5700 via defined convertors in preferences.
5701 Look into File->Import menu to get an idea of the currently active import
5706 \begin_layout Description
5707 Syntax buffer-import <FORMAT> [<FILE>]
5710 \begin_layout Description
5711 Origin Asger, 24 Jul 1998
5714 \begin_layout Subsection*
5718 \begin_layout Description
5719 Action Creates a new buffer (that is, document).
5723 \begin_layout Description
5724 Notion Implicit path can be set in Preferences dialog.
5728 \begin_layout Description
5729 Syntax buffer-new [<FILE>]
5732 \begin_layout Description
5733 Params <FILE>: filename of created file with absolute path.
5737 \begin_layout Subsection*
5738 LFUN_BUFFER_NEW_TEMPLATE
5741 \begin_layout Description
5742 Action Creates a new buffer (that is, document) from a template.
5746 \begin_layout Description
5747 Notion Path for new files and templates can be set in Preferences dialog.
5748 Template will be asked for via Open-dialog.
5752 \begin_layout Description
5753 Syntax buffer-new-template [<FILE>]
5756 \begin_layout Description
5757 Params <FILE>: filename of created file with absolute path.
5761 \begin_layout Subsection*
5765 \begin_layout Description
5766 Action Reverts opened document.
5770 \begin_layout Description
5771 Syntax buffer-reload
5774 \begin_layout Description
5775 Origin Asger, 2 Feb 1997
5778 \begin_layout Subsection*
5782 \begin_layout Description
5783 Action Switch to the given buffer.
5787 \begin_layout Description
5788 Notion This is useful also in case you need simultaneously more views of
5789 the edited document in different LyX windows.
5793 \begin_layout Description
5794 Syntax buffer-new-template <BUFFER>
5797 \begin_layout Description
5798 Params <BUFFER>: already opened document which is to be shown.
5802 \begin_layout Subsection*
5803 LFUN_BUFFER_TOGGLE_READ_ONLY
5806 \begin_layout Description
5807 Action Toggle editing mode of the current document between read/write and
5812 \begin_layout Description
5813 Notion In the ->Readonly mode checks-in/commits the data if the file is
5814 under version control.
5815 In the Readonly-> mode checkouts the data from repository.
5817 \begin_inset Newline newline
5820 If these operations fail, buffer won't be toggled.
5824 \begin_layout Description
5825 Syntax buffer-toggle-read-only
5828 \begin_layout Description
5829 Origin Lgb, 27 May 1997
5832 \begin_layout Subsection*
5836 \begin_layout Description
5837 Action Displays current buffer in chosen format.
5841 \begin_layout Description
5842 Notion Displays the contents of the current buffer in the chosen format,
5843 for example, PDF or DVI.
5844 This runs the necessary converter, calls the defined viewer, and so forth.
5848 \begin_layout Description
5849 Syntax buffer-view <FORMAT>
5852 \begin_layout Description
5853 Params <FORMAT>: The format to display, where this is one of the formats
5854 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5858 \begin_layout Subsection*
5862 \begin_layout Description
5863 Action Exports the current document and put the result into the temporary
5868 \begin_layout Description
5869 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5870 EW) the output will be rewriten - updated.
5871 This is useful in case your viewer is able to detect such changes (e.g.
5872 ghostview for postscript).
5876 \begin_layout Description
5877 Syntax buffer-update <FORMAT>
5880 \begin_layout Description
5881 Params <FORMAT>: The format to display, where this is one of the formats
5882 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5886 \begin_layout Description
5887 Origin Dekel, 5 Aug 2000
5890 \begin_layout Subsection*
5894 \begin_layout Description
5895 Action Saves the current buffer.
5899 \begin_layout Description
5900 Notion Saves the current buffer to disk, using the filename that is already
5901 associated with the buffer, asking for one if none is yet assigned.
5905 \begin_layout Description
5909 \begin_layout Subsection*
5910 LFUN_BUFFER_WRITE_AS
5913 \begin_layout Description
5914 Action Rename and save current buffer.
5918 \begin_layout Description
5919 Syntax buffer-write-as <FILENAME>
5922 \begin_layout Description
5923 Params <FILENAME>: New name of the buffer/file.
5924 A relative path is with respect to the original location of the buffer/file.
5928 \begin_layout Subsection*
5929 LFUN_BUFFER_WRITE_ALL
5932 \begin_layout Description
5933 Action Save all changed documents.
5937 \begin_layout Description
5938 Syntax buffer-write-all
5941 \begin_layout Description
5942 Origin rgh, gpothier 6 Aug 2007
5945 \begin_layout Subsection*
5949 \begin_layout Description
5950 Action Switch to the next opened document.
5954 \begin_layout Description
5955 Notion Note that this does not necessarily mean next in tabbar (for full
5956 list see View menu).
5960 \begin_layout Description
5964 \begin_layout Subsection*
5965 LFUN_BUFFER_PREVIOUS
5968 \begin_layout Description
5969 Action Switch to the previous opened document.
5973 \begin_layout Description
5974 Syntax buffer-previous
5977 \begin_layout Subsection*
5978 LFUN_MASTER_BUFFER_UPDATE
5981 \begin_layout Description
5982 Action When run from a child document, this updates (exports) document built
5983 from the master buffer.
5984 If a master is not found, it updates the current buffer.
5988 \begin_layout Description
5989 Syntax master-buffer-update
5992 \begin_layout Description
5993 Origin Tommaso, 20 Sep 2007
5996 \begin_layout Subsection*
5997 LFUN_MASTER_BUFFER_VIEW
6000 \begin_layout Description
6001 Action When run from a child document, this command shows a preview built
6002 from the master buffer.
6003 If a master is not found, it previews the current buffer.
6007 \begin_layout Description
6008 Syntax master-buffer-view
6011 \begin_layout Description
6012 Origin Tommaso, 20 Sep 2007
6015 \begin_layout Subsection*
6016 LFUN_BUFFER_LANGUAGE
6019 \begin_layout Description
6020 Action Set language of the current document.
6024 \begin_layout Description
6025 Syntax buffer-language <LANG>
6028 \begin_layout Description
6029 Params <LANG>: language name.
6030 See lib/languages for list.
6034 \begin_layout Description
6035 Origin leeming, 30 Mar 2004
6038 \begin_layout Subsection*
6039 LFUN_BUFFER_SAVE_AS_DEFAULT
6042 \begin_layout Description
6043 Action Save the current document settings as default.
6047 \begin_layout Description
6048 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6052 \begin_layout Description
6053 Syntax buffer-save-as-default [<ARGS>]
6056 \begin_layout Description
6057 Params <ARGS>: contains the particular settings to be saved.
6058 They obey the syntax you can find in document header of usual .lyx file.
6062 \begin_layout Description
6063 Origin leeming, 30 Mar 2004
6066 \begin_layout Subsection*
6067 LFUN_BUFFER_PARAMS_APPLY
6070 \begin_layout Description
6071 Action Apply the given settings to the current document.
6075 \begin_layout Description
6076 Syntax buffer-params-apply [<ARGS>]
6079 \begin_layout Description
6080 Params <ARGS>: contains the particular settings to be saved.
6081 They obey the syntax you can find in document header of usual .lyx file.
6085 \begin_layout Description
6086 Origin leeming, 30 Mar 2004
6089 \begin_layout Subsection*
6093 \begin_layout Description
6094 Action Inserts another LyX file.
6098 \begin_layout Description
6099 Syntax file-insert [<FILE>]
6102 \begin_layout Description
6103 Params <FILE>: Filename to be inserted.
6107 \begin_layout Subsection*
6108 LFUN_FILE_INSERT_PLAINTEXT
6111 \begin_layout Description
6112 Action Inserts plain text file.
6116 \begin_layout Description
6117 Syntax file-insert-plaintext [<FILE>]
6120 \begin_layout Description
6121 Params <FILE>: Filename to be inserted.
6125 \begin_layout Description
6126 Origin CFO-G, 19 Nov 1997
6129 \begin_layout Subsection*
6130 LFUN_FILE_INSERT_PLAINTEXT_PARA
6133 \begin_layout Description
6134 Action Inserts plain text file as paragraph (i.e.
6139 \begin_layout Description
6140 Syntax file-insert-plaintext-para [<FILE>]
6143 \begin_layout Description
6144 Params <FILE>: Filename to be inserted.
6148 \begin_layout Description
6149 Origin Levon, 14 Feb 2001
6152 \begin_layout Subsection*
6156 \begin_layout Description
6157 Action Open LyX document.
6161 \begin_layout Description
6162 Syntax file-open [<FILE>]
6165 \begin_layout Description
6166 Params <FILE>: Filename to be opened.
6170 \begin_layout Subsection*
6174 \begin_layout Description
6175 Action Executes a command defined in a .def file.
6179 \begin_layout Description
6180 Notion The definitions are by default read from lib/commands/default.def.
6182 \begin_inset Newline newline
6185 A .def file allows to define a command with
6187 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6188 <LFUN> is the lfun code to be executed (see e.g.
6189 LFUN_COMMAND_SEQUENCE).
6192 def_file "FileName" allows to include another .def file.
6194 \begin_inset Newline newline
6197 This is particularly useful in connection with toolbar buttons: Since the
6198 name of the button image for this lfun is lib/images/commands/<NAME>.png
6199 this is the way to assign an image to a complex command-sequence.
6203 \begin_layout Description
6207 \begin_layout Description
6208 Params <NAME>: Name of the command that must be called.
6212 \begin_layout Description
6213 Origin broider, 2 Oct 2007
6216 \begin_layout Subsection*
6220 \begin_layout Description
6221 Action Simulate halting Meta key (Alt key on PCs).
6225 \begin_layout Description
6226 Notion Used for buffer editation not for GUI control.
6230 \begin_layout Description
6234 \begin_layout Subsection*
6238 \begin_layout Description
6239 Action Cancels sequence prepared by LFUN_META_PREFIX .
6243 \begin_layout Description
6247 \begin_layout Subsection*
6248 LFUN_COMMAND_EXECUTE
6251 \begin_layout Description
6252 Action Opens the minibuffer toolbar so that the user can type in there.
6256 \begin_layout Description
6257 Notion Usually bound to M-x shortcut.
6261 \begin_layout Description
6262 Syntax command-execute
6265 \begin_layout Subsection*
6269 \begin_layout Description
6270 Action Return the current key sequence and available options as a string.
6274 \begin_layout Description
6275 Notion No options are added if no current map exists.
6277 \begin_inset Newline newline
6280 This is probably usable only with connection to lyxserver.
6284 \begin_layout Description
6285 Syntax command-prefix
6288 \begin_layout Subsection*
6289 LFUN_COMMAND_SEQUENCE
6292 \begin_layout Description
6293 Action Run more commands (LFUN and its parameters) in a sequence.
6297 \begin_layout Description
6298 Syntax command-sequence <CMDS>
6301 \begin_layout Description
6302 Params <CMDS>: Sequence of commands separated by semicolons.
6306 \begin_layout Description
6307 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6311 \begin_layout Description
6312 Origin Andre, 11 Nov 1999
6315 \begin_layout Subsection*
6316 LFUN_COMMAND_ALTERNATIVES
6319 \begin_layout Description
6320 Action Runs the first listed command that is enabled.
6324 \begin_layout Description
6325 Notion This can be used to bind multiple functions to a single key, and
6326 then which one is used will depend upon the context.
6330 \begin_layout Description
6331 Syntax command-alternatives <CMDS>
6334 \begin_layout Description
6335 Params <CMDS>: Sequence of commands separated by semicolons.
6339 \begin_layout Description
6340 Sample command-alternatives completion-accept;cell-forward
6343 \begin_layout Description
6344 Origin rgh, 24 September 2008
6347 \begin_layout Subsection*
6351 \begin_layout Description
6352 Action Shows message in statusbar (for script purposes).
6356 \begin_layout Description
6357 Syntax message <STRING>
6360 \begin_layout Description
6361 Origin Lgb, 8 Apr 2001
6364 \begin_layout Subsection*
6365 LFUN_PREFERENCES_SAVE
6368 \begin_layout Description
6369 Action Save user preferences.
6373 \begin_layout Description
6374 Syntax preferences-save
6377 \begin_layout Description
6378 Origin Lgb, 27 Nov 1999
6381 \begin_layout Subsection*
6385 \begin_layout Description
6386 Action Reconfigure the automatic settings.
6390 \begin_layout Description
6394 \begin_layout Description
6395 Origin Asger, 14 Feb 1997
6398 \begin_layout Subsection*
6402 \begin_layout Description
6403 Action Apply the given settings to user preferences.
6407 \begin_layout Description
6408 Syntax lyxrc-apply <SETTINGS>
6411 \begin_layout Description
6412 Params <SETTINGS>: settings which are to be set.
6413 Take a look into ~/.lyx/preferences to get an idea which commands to use
6415 lyx::LyXRC::LyXRCTags has the list of possible commands.
6419 \begin_layout Subsection*
6420 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6423 \begin_layout Description
6424 Action Determine whether keep cursor inside the editing window regardless
6425 the scrollbar movement.
6429 \begin_layout Description
6430 Syntax toggle-cursor-follows-scrollbar
6433 \begin_layout Description
6434 Origin ARRae, 2 Dec 1997
6437 \begin_layout Subsection*
6441 \begin_layout Description
6442 Action Set the given LyX color to the color defined by the X11 name given.
6446 \begin_layout Description
6447 Notion A new color entry is created if the color is unknown.
6448 Color names can be stored as a part of user settings.
6452 \begin_layout Description
6453 Syntax set-color <LYX_NAME> <X11_NAME>
6456 \begin_layout Description
6457 Origin SLior, 11 Jun 2000
6460 \begin_layout Subsection*
6464 \begin_layout Description
6465 Action Count the statistics (number of words and characters) in the document
6466 or in the given selection.
6470 \begin_layout Description
6471 Notion Note that this function gives the number of words/chars written,
6472 not the number of characters which will be typeset.
6476 \begin_layout Description
6480 \begin_layout Description
6481 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6484 \begin_layout Subsection*
6485 LFUN_COMPLETION_INLINE
6488 \begin_layout Description
6489 Action Show the inline completion at the cursor position.
6493 \begin_layout Description
6494 Syntax completion-inline
6497 \begin_layout Description
6498 Origin sts, Feb 19 2008
6501 \begin_layout Subsection*
6502 LFUN_COMPLETION_POPUP
6505 \begin_layout Description
6506 Action Show the completion popup at the cursor position.
6510 \begin_layout Description
6511 Syntax completion-popup
6514 \begin_layout Description
6515 Origin sts, Feb 19 2008
6518 \begin_layout Subsection*
6519 LFUN_COMPLETION_COMPLETE
6522 \begin_layout Description
6523 Action Try to complete the word or command at the cursor position.
6527 \begin_layout Description
6531 \begin_layout Description
6532 Origin sts, Feb 19 2008
6535 \begin_layout Subsection*
6536 LFUN_COMPLETION_CANCEL
6539 \begin_layout Description
6540 Action Try to cancel completion, either the popup or the inline completion
6544 \begin_layout Description
6545 Syntax completion-cancel
6548 \begin_layout Description
6549 Origin sts, Sep 07 2008
6552 \begin_layout Subsection*
6553 LFUN_COMPLETION_ACCEPT
6556 \begin_layout Description
6557 Action Accept suggested completion.
6561 \begin_layout Description
6562 Syntax completion-accept
6565 \begin_layout Description
6566 Origin sanda, Sep 08 2008
6569 \begin_layout Subsection*
6570 LFUN_BRANCH_ACTIVATE
6573 \begin_layout Description
6574 Action Activate the branch
6577 \begin_layout Description
6578 Syntax branch-activate <BRANCH>
6581 \begin_layout Description
6582 Params <BRANCH>: The branch to activate
6585 \begin_layout Description
6586 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6587 \begin_inset Newline newline
6590 could be used to export a pdf with the answers branch includedwithout one's
6591 having to open LyX and activate the branch manually.
6594 \begin_layout Description
6595 Origin rgh, 27 May 2008
6598 \begin_layout Subsection*
6599 LFUN_BRANCH_ACTIVATE
6602 \begin_layout Description
6603 Action De-activate the branch
6606 \begin_layout Description
6607 Syntax branch-deactivate <BRANCH>
6610 \begin_layout Description
6611 Params <BRANCH>: The branch to deactivate
6614 \begin_layout Description
6615 Origin rgh, 27 May 2008
6618 \begin_layout Subsection*
6619 LFUN_COPY_LABEL_AS_REF
6622 \begin_layout Description
6623 Action Copies the label at the cursor as a cross-reference to be pasted
6628 \begin_layout Description
6629 Syntax copy-label-as-reference
6632 \begin_layout Description
6633 Origin sts, 16 Nov 2008