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 23.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*
2057 LFUN_SELECTION_PASTE
2060 \begin_layout Description
2061 Action Pastes the text in permanent selection.
2065 \begin_layout Description
2066 Syntax selection-paste
2069 \begin_layout Subsection*
2073 \begin_layout Description
2074 Action Undoes the last edit.
2078 \begin_layout Description
2082 \begin_layout Subsection*
2086 \begin_layout Description
2087 Action Redoes the last thing undone.
2091 \begin_layout Description
2095 \begin_layout Subsection*
2099 \begin_layout Description
2100 Action Repeat the given command.
2104 \begin_layout Description
2105 Syntax repeat <COUNT> <LFUN-COMMAND>
2108 \begin_layout Description
2109 Origin Andre, , 27 Oct 2003
2112 \begin_layout Subsection*
2113 LFUN_CHARS_TRANSPOSE
2116 \begin_layout Description
2117 Action Transposes the character at the cursor with the one before it.
2121 \begin_layout Description
2122 Syntax chars-transpose
2125 \begin_layout Description
2126 Origin Lgb, 25 Apr 2001
2129 \begin_layout Subsection*
2130 LFUN_DEPTH_DECREMENT
2133 \begin_layout Description
2134 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2139 \begin_layout Description
2140 Syntax depth-decrement
2143 \begin_layout Subsection*
2144 LFUN_DEPTH_INCREMENT
2147 \begin_layout Description
2148 Action Increase the nesting depth of the (selected) paragraph(s) inside
2153 \begin_layout Description
2154 Syntax depth-increment
2157 \begin_layout Subsection*
2161 \begin_layout Description
2162 Action Toggles the bold font (selection-wise) using mathbf in math.
2166 \begin_layout Description
2170 \begin_layout Subsection*
2171 LFUN_FONT_BOLDSYMBOL
2174 \begin_layout Description
2175 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2179 \begin_layout Description
2180 Syntax font-boldsymbol
2183 \begin_layout Subsection*
2184 LFUN_FONT_TYPEWRITER
2187 \begin_layout Description
2188 Action Toggles the typewriter family font (selection-wise).
2192 \begin_layout Description
2193 Syntax font-typewriter
2196 \begin_layout Subsection*
2200 \begin_layout Description
2201 Action Toggles underline in the font (selection-wise).
2205 \begin_layout Description
2206 Syntax font-underline
2209 \begin_layout Subsection*
2213 \begin_layout Description
2214 Action Toggles the emphasis font style (selection-wise).
2218 \begin_layout Description
2222 \begin_layout Subsection*
2226 \begin_layout Description
2227 Action Toggles Noun text style font (selection-wise).
2231 \begin_layout Description
2235 \begin_layout Subsection*
2239 \begin_layout Description
2240 Action Toggles Roman family font (selection-wise).
2244 \begin_layout Description
2248 \begin_layout Subsection*
2252 \begin_layout Description
2253 Action Toggles Sans Serif family font (selection-wise).
2257 \begin_layout Description
2261 \begin_layout Subsection*
2265 \begin_layout Description
2266 Action Toggles Fraktur family font (math-mode, selection-wise).
2270 \begin_layout Description
2274 \begin_layout Description
2275 Origin vermeer, 10 Jan 2002
2278 \begin_layout Subsection*
2282 \begin_layout Description
2283 Action Toggles Italics font shape (math-mode, selection-wise).
2287 \begin_layout Description
2291 \begin_layout Description
2292 Origin vermeer, 10 Jan 2002
2295 \begin_layout Subsection*
2299 \begin_layout Description
2300 Action Reverts the settings of the font to the default values (selection-wise).
2304 \begin_layout Description
2308 \begin_layout Subsection*
2312 \begin_layout Description
2313 Action Sets font size according to lyx format string.
2317 \begin_layout Description
2318 Syntax font-size <SIZE>
2321 \begin_layout Description
2322 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2323 \begin_inset Newline newline
2326 largest|huge|giant|increase|decrease|default
2329 \begin_layout Subsection*
2330 LFUN_TEXTSTYLE_APPLY
2333 \begin_layout Description
2334 Action Toggle user-defined (=last-time used) text style.
2338 \begin_layout Description
2339 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2340 trigerred when using Text Style dialog.
2344 \begin_layout Description
2345 Syntax textstyle-apply
2348 \begin_layout Description
2349 Origin leeming, 12 Mar 2003
2352 \begin_layout Subsection*
2353 LFUN_TEXTSTYLE_UPDATE
2356 \begin_layout Description
2357 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2362 \begin_layout Description
2363 Syntax textstyle-update <FONT_INFO>
2366 \begin_layout Description
2367 Params <FONT_INFO>: specifies font atributes, e.g.
2368 family, series, shape, size, emph, noun, underbar, number, color, language,
2371 \begin_inset Newline newline
2374 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2378 \begin_layout Description
2379 Origin leeming, 12 Mar 2003
2382 \begin_layout Subsection*
2383 LFUN_SCREEN_FONT_UPDATE
2386 \begin_layout Description
2387 Action Update fonts and its metrics.
2391 \begin_layout Description
2392 Notion Automatically called after zoom, dpi, font names, or norm change.
2396 \begin_layout Description
2397 Syntax screen-font-update
2400 \begin_layout Description
2401 Origin ARRae, 13 Aug 2000
2404 \begin_layout Subsection*
2408 \begin_layout Description
2409 Action Returns the info about the current font.
2413 \begin_layout Description
2417 \begin_layout Subsection*
2418 LFUN_CITATION_INSERT
2421 \begin_layout Description
2422 Action Inserts citation from loaded citation database.
2426 \begin_layout Description
2427 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2430 \begin_layout Description
2431 Params <KEY>: Citation (shortcut listed in available citations).
2433 \begin_inset Newline newline
2436 <TEXT_BEFORE>: text which should appear before citation.
2440 \begin_layout Description
2441 Origin AAS, 97-02-23
2444 \begin_layout Subsection*
2445 LFUN_BIBTEX_DATABASE_ADD
2448 \begin_layout Description
2449 Action Adds database, which will be used for bibtex citations.
2453 \begin_layout Description
2454 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2455 bibliography) found from the cursor postion.
2459 \begin_layout Description
2460 Syntax bibtex-database-add <DATABASE-NAME>
2463 \begin_layout Description
2464 Origin Ale, 30 May 1997
2467 \begin_layout Subsection*
2468 LFUN_BIBTEX_DATABASE_DEL
2471 \begin_layout Description
2472 Action Adds database, which will be used for bibtex citations.
2476 \begin_layout Description
2477 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2478 X bibliography) found from the cursor postion.
2482 \begin_layout Description
2483 Syntax bibtex-database-del <DATABASE-NAME>
2486 \begin_layout Description
2487 Origin Ale, 30 May 1997
2490 \begin_layout Subsection*
2494 \begin_layout Description
2495 Action Sets the layout (that is, environment) for the current paragraph.
2499 \begin_layout Description
2500 Syntax layout <LAYOUT>
2503 \begin_layout Description
2504 Params <LAYOUT>: the layout to use
2507 \begin_layout Subsection*
2508 LFUN_LAYOUT_PARAGRAPH
2511 \begin_layout Description
2512 Action Launches the paragraph settings dialog.
2516 \begin_layout Description
2517 Syntax layout-paragraph
2520 \begin_layout Subsection*
2524 \begin_layout Description
2525 Action Launches the tabular settings dialog.
2529 \begin_layout Description
2530 Syntax layout-tabular
2533 \begin_layout Description
2534 Origin Jug, 31 Jul 2000
2537 \begin_layout Subsection*
2538 LFUN_DROP_LAYOUTS_CHOICE
2541 \begin_layout Description
2542 Action Displays list of layout choices.
2546 \begin_layout Description
2547 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2548 allowing for choice of layout.
2552 \begin_layout Description
2553 Syntax drop-layouts-choice
2556 \begin_layout Subsection*
2557 LFUN_LAYOUT_MODULES_CLEAR
2560 \begin_layout Description
2561 Action Clears the module list.
2565 \begin_layout Description
2566 Notion Clears the list of included modules for the current buffer.
2570 \begin_layout Description
2571 Syntax layout-modules-clear
2574 \begin_layout Description
2575 Origin rgh, 25 August 2007
2578 \begin_layout Subsection*
2579 LFUN_LAYOUT_MODULE_ADD
2582 \begin_layout Description
2583 Action Adds a module.
2587 \begin_layout Description
2588 Notion Adds a module to the list of included modules for the current buffer.
2592 \begin_layout Description
2593 Syntax layout-module-add <MODULE>
2596 \begin_layout Description
2597 Params <MODULE>: the module to be added
2600 \begin_layout Description
2601 Origin rgh, 25 August 2007
2604 \begin_layout Subsection*
2608 \begin_layout Description
2609 Action Reloads layout information.
2613 \begin_layout Description
2614 Notion Reloads all layout information for the current buffer from disk,
2615 thus recognizing any changes that have been made to layout files on the
2617 This is intended to be used only by layout developers and should not be
2618 used when one is trying to do actual work.
2622 \begin_layout Description
2623 Syntax layout-reload
2626 \begin_layout Description
2627 Origin rgh, 3 September 2007
2630 \begin_layout Subsection*
2631 LFUN_TEXTCLASS_APPLY
2634 \begin_layout Description
2635 Action Sets the text class for the current buffer.
2639 \begin_layout Description
2640 Syntax textclass-apply <TEXTCLASS>
2643 \begin_layout Description
2644 Params <TEXTCLASS>: the textclass to set.
2645 Note that this must be the filename, minus the ".layout" extension.
2649 \begin_layout Subsection*
2653 \begin_layout Description
2654 Action Loads information for a textclass from disk.
2658 \begin_layout Description
2659 Syntax textclass-load <TEXTCLASS>
2662 \begin_layout Description
2663 Params <TEXTCLASS>: the textclass to load.
2664 Note that this must be the filename, minus the ".layout" extension.
2668 \begin_layout Subsection*
2672 \begin_layout Description
2673 Action Disable selecting of text-region.
2677 \begin_layout Description
2681 \begin_layout Subsection*
2685 \begin_layout Description
2686 Action Enable selecting of text-region.
2690 \begin_layout Description
2691 Notion After enabling you can simply move arrow keys to get selected region.
2695 \begin_layout Description
2699 \begin_layout Subsection*
2703 \begin_layout Description
2704 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2708 \begin_layout Description
2712 \begin_layout Description
2713 Origin Andre, May 5 2006
2716 \begin_layout Subsection*
2720 \begin_layout Description
2721 Action Inserts math delimiters (e.g.
2722 parentheses, brackets) enclosing expression.
2726 \begin_layout Description
2727 Syntax math-delim [<LEFT>] [<RIGHT>]
2730 \begin_layout Description
2731 Params <LEFT/RIGHT>: Delimiters to be used.
2732 Each delimiter can be specified by either a LaTeX name or a valid character.
2733 ( is the default letter.
2737 \begin_layout Description
2738 Sample math-delim { rangle
2741 \begin_layout Description
2742 Origin Alejandro, 18 Jun 1996
2745 \begin_layout Subsection*
2749 \begin_layout Description
2750 Action Inserts math fixed size delimiters (e.g.
2751 parentheses, brackets) enclosing expression.
2755 \begin_layout Description
2756 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2759 \begin_layout Description
2760 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2761 \begin_inset Newline newline
2764 <L/RDELIM>: TeX code for delimiter.
2765 See Delimiter dialog for delimiters to be used.
2769 \begin_layout Description
2770 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2773 \begin_layout Description
2774 Origin Enrico & Georg, 7 May 2006
2777 \begin_layout Subsection*
2781 \begin_layout Description
2782 Action Creates a new displayed equation in text mode.
2783 Toggles inlined/display formula in math mode.
2787 \begin_layout Description
2788 Syntax math-display [<ARG>]
2791 \begin_layout Description
2792 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2793 new equation from the text mode.
2797 \begin_layout Description
2798 Origin Alejandro, 18 Jun 1996
2801 \begin_layout Subsection*
2805 \begin_layout Description
2806 Action Inserts math objects and symbols.
2810 \begin_layout Description
2811 Syntax math-insert <ARG>
2814 \begin_layout Description
2815 Params <ARG>: Symbol or LaTeX code to be inserted.
2819 \begin_layout Subsection*
2823 \begin_layout Description
2824 Action Enters subscript expression in math expression.
2828 \begin_layout Description
2829 Syntax math-subscript
2832 \begin_layout Description
2833 Origin vermeer, 12 Dec 2001
2836 \begin_layout Subsection*
2837 LFUN_MATH_SUPERSCRIPT
2840 \begin_layout Description
2841 Action Enters subscript expression in math expression.
2845 \begin_layout Description
2846 Syntax math-superscript
2849 \begin_layout Description
2850 Origin vermeer, 12 Dec 2001
2853 \begin_layout Subsection*
2857 \begin_layout Description
2858 Action Toggles the position of the limits from above/below to the right
2859 side an vice versa in integral symbol, a limit, a summation, etc.
2863 \begin_layout Description
2864 Notion Put the cursor before the symbol with the limits and then invoke
2869 \begin_layout Description
2870 Syntax math-limits [<STATE>]
2873 \begin_layout Description
2874 Params <STATE>: limits|nolimits
2877 \begin_layout Subsection*
2881 \begin_layout Description
2882 Action Inserts a math macro definition at the cursor position in the text.
2886 \begin_layout Description
2887 Syntax math-macro <NAME> [<NARGS>] [def]
2890 \begin_layout Description
2891 Params <NAME>: The name of the macro, e.g.
2893 <NARGS>: The number of parameters of the macro.
2895 "def": Has no effect anymore, just for compatibility with former LyX versions.
2899 \begin_layout Description
2900 Origin ale, 10 May 1997; sts, 21 Dec 2007
2903 \begin_layout Subsection*
2907 \begin_layout Description
2908 Action Mutates the type of math inset to the newly selected one.
2912 \begin_layout Description
2913 Syntax math-mutate <TYPE>
2916 \begin_layout Description
2917 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2918 multline|gather|flalign
2921 \begin_layout Description
2922 Origin Andre, 23 May 2001
2925 \begin_layout Subsection*
2929 \begin_layout Description
2930 Action Inserts space into math expression.
2934 \begin_layout Description
2935 Notion Use spacebar after entering this space to change type of space.
2939 \begin_layout Description
2940 Syntax math-space [<TYPE>] [<LEN>]
2943 \begin_layout Description
2944 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2946 \begin_inset Newline newline
2949 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2951 \begin_inset Newline newline
2954 custom space: hspace
2955 \begin_inset Newline newline
2958 "," used by default.
2959 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
2961 <LEN>: length for custom spaces (hspace)
2964 \begin_layout Description
2965 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2968 \begin_layout Subsection*
2972 \begin_layout Description
2973 Action Inserts a matrix.
2977 \begin_layout Description
2978 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2981 \begin_layout Description
2982 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
2984 1 char) and the horizontal alignments (l, c or r) (i.e.
2989 \begin_layout Description
2990 Sample math-matrix 3 3 bccc
2993 \begin_layout Subsection*
2997 \begin_layout Description
2998 Action In text mode enters math mode (i.e.
2999 puts math insets on the current cursor position), in math mode enters text
3000 mode inside math expression.
3004 \begin_layout Description
3005 Notion If there is some selected text, it puts the text inside created math
3010 \begin_layout Description
3011 Syntax math-mode [<ARG>]
3014 \begin_layout Description
3015 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3020 \begin_layout Description
3021 Origin Alejandro, 4 Jun 1996
3024 \begin_layout Subsection*
3028 \begin_layout Description
3029 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3031 Used by the advanced search dialog.
3035 \begin_layout Description
3036 Notion If there is any selected text, then it is moved inside the created
3041 \begin_layout Description
3042 Syntax regexp-mode [<ARG>]
3045 \begin_layout Description
3046 Params <ARG>: eventual argument (regular expression).
3050 \begin_layout Description
3051 Origin Tommaso, 4 Oct 2008
3054 \begin_layout Subsection*
3055 LFUN_MATH_NUMBER_LINE_TOGGLE
3058 \begin_layout Description
3059 Action Toggles numbering of the current formula line.
3063 \begin_layout Description
3064 Notion Must be in display formula mode.
3068 \begin_layout Description
3069 Syntax math-number-line-toggle
3072 \begin_layout Description
3073 Origin Alejandro, 18 Jun 1996
3076 \begin_layout Subsection*
3077 LFUN_MATH_NUMBER_TOGGLE
3080 \begin_layout Description
3081 Action Toggles numbering/labeling of the current formula.
3085 \begin_layout Description
3086 Notion Must be in display formula mode.
3090 \begin_layout Description
3091 Syntax math-number-toggle
3094 \begin_layout Description
3095 Origin Alejandro, 4 Jun 1996
3098 \begin_layout Subsection*
3102 \begin_layout Description
3103 Action Calls external program and passes the current expression/equation
3104 as an argument for the calculation in the format appropriate to the given
3109 \begin_layout Description
3110 Notion Selection can be used to determine the input for the external program.
3114 \begin_layout Description
3115 Syntax math-extern <LANG> [<COMMAND>]
3118 \begin_layout Description
3119 Params <LANG>: octave|maxima|maple|mathematica|script
3120 \begin_inset Newline newline
3123 where "script" stands fot the external script (normalized expression will
3127 \begin_layout Description
3128 Origin Andre, 24 Apr 2001
3131 \begin_layout Description
3132 Sample math-extern maple simplify
3135 \begin_layout Subsection*
3139 \begin_layout Description
3140 Action Changes arbitrarily the size used by math fonts inside a context.
3144 \begin_layout Description
3145 Notion Provides an interface to the LaTeX math mode font size commands.
3149 \begin_layout Description
3150 Syntax math-size <STYLE>
3153 \begin_layout Description
3154 Params <STYLE>: displaystyle|
3163 \begin_layout Description
3164 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3167 \begin_layout Subsection*
3168 LFUN_MATH_FONT_STYLE
3171 \begin_layout Description
3172 Action Changes the text style used in math.
3176 \begin_layout Description
3177 Syntax math-font-style <STYLE>
3180 \begin_layout Description
3181 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
3182 trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
3185 \begin_layout Description
3186 Origin vfr, 9 jan 2009
3189 \begin_layout Subsection*
3190 LFUN_MATH_MACRO_UNFOLD
3193 \begin_layout Description
3194 Action Unfold a Math Macro.
3198 \begin_layout Description
3199 Notion Unfold the Math Macro the cursor is in, i.e.
3204 \begin_layout Description
3205 Syntax math-macro-unfold
3208 \begin_layout Description
3209 Origin sts, 06 January 2008
3212 \begin_layout Subsection*
3213 LFUN_MATH_MACRO_FOLD
3216 \begin_layout Description
3217 Action Fold a Math Macro.
3221 \begin_layout Description
3222 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3223 displayed as foo before.
3227 \begin_layout Description
3228 Syntax math-macro-fold
3231 \begin_layout Description
3232 Origin sts, 06 January 2008
3235 \begin_layout Subsection*
3236 LFUN_MATH_MACRO_ADD_PARAM
3239 \begin_layout Description
3240 Action Add a parameter.
3244 \begin_layout Description
3245 Notion Add a parameter to a Math Macro.
3249 \begin_layout Description
3250 Params <NUM>: The number of the parameter behind which the new one will
3251 be added (1 for the first, i.e.
3252 use 0 for add a parameter at the left), defaults to the last one.
3256 \begin_layout Description
3257 Syntax math-macro-add-param <NUM>
3260 \begin_layout Description
3261 Origin sts, 06 January 2008
3264 \begin_layout Subsection*
3265 LFUN_MATH_MACRO_REMOVE_PARAM
3268 \begin_layout Description
3269 Action Remove the last parameter.
3273 \begin_layout Description
3274 Notion Remove the last parameter of a Math Macro and remove its value in
3275 all instances of the macro in the buffer.
3279 \begin_layout Description
3280 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3281 defaults to the last one.
3285 \begin_layout Description
3286 Syntax math-macro-remove-param <NUM>
3289 \begin_layout Description
3290 Origin sts, 06 January 2008
3293 \begin_layout Subsection*
3294 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3297 \begin_layout Description
3298 Action Append a greedy parameter.
3302 \begin_layout Description
3303 Notion Append a greedy parameter to a Math Macro which eats the following
3304 mathed cell in every instance of the macro in the buffer.
3308 \begin_layout Description
3309 Syntax math-macro-append-greedy-param
3312 \begin_layout Description
3313 Origin sts, 06 January 2008
3316 \begin_layout Subsection*
3317 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3320 \begin_layout Description
3321 Action Remove a greedy parameter.
3325 \begin_layout Description
3326 Notion Remove a greedy parameter of a Math Macro and spit out the values
3327 of it in every instance of the macro in the buffer.
3328 If it is an optional parameter the [valud] format is used.
3332 \begin_layout Description
3333 Syntax math-macro-remove-greedy-param
3336 \begin_layout Description
3337 Origin sts, 06 January 2008
3340 \begin_layout Subsection*
3341 LFUN_MATH_MACRO_MAKE_OPTIONAL
3344 \begin_layout Description
3345 Action Make a parameter optional.
3349 \begin_layout Description
3350 Notion Turn the first non-optional parameter of a Math Macro into an optional
3351 parameter with a default value.
3355 \begin_layout Description
3356 Syntax math-macro-make-optional
3359 \begin_layout Description
3360 Origin sts, 06 January 2008
3363 \begin_layout Subsection*
3364 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3367 \begin_layout Description
3368 Action Make a parameter non-optional.
3372 \begin_layout Description
3373 Notion Turn the last optional parameter of a Math Macro into a non-optional
3375 The default value is remembered to be reused later if the user changes
3380 \begin_layout Description
3381 Syntax math-macro-make-nonoptional
3384 \begin_layout Description
3385 Origin sts, 06 January 2008
3388 \begin_layout Subsection*
3389 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3392 \begin_layout Description
3393 Action Add an optional parameter.
3397 \begin_layout Description
3398 Notion Insert an optional parameter just behind the already existing optional
3403 \begin_layout Description
3404 Syntax math-macro-add-optional-param
3407 \begin_layout Description
3408 Origin sts, 06 January 2008
3411 \begin_layout Subsection*
3412 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3415 \begin_layout Description
3416 Action Remove the last optional parameter.
3420 \begin_layout Description
3421 Notion Remove the last optional parameter of a Math Macro and remove it
3422 in all the instances of the macro in the buffer.
3426 \begin_layout Description
3427 Syntax math-macro-remove-optional-param
3430 \begin_layout Description
3431 Origin sts, 06 January 2008
3434 \begin_layout Subsection*
3435 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3438 \begin_layout Description
3439 Action Add a greedy optional parameter.
3443 \begin_layout Description
3444 Notion Add a greedy optional parameter which eats the value from the following
3445 cells in mathed which are in the [value] format.
3449 \begin_layout Description
3450 Syntax math-macro-add-greedy-optional-param
3453 \begin_layout Description
3454 Origin sts, 06 January 2008
3457 \begin_layout Subsection*
3458 LFUN_IN_MATHMACROTEMPLATE
3461 \begin_layout Description
3462 Action Only active in Math Macro definition.
3466 \begin_layout Description
3467 Notion Dummy function which is only active in a Math Macro definition.
3468 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3473 \begin_layout Description
3474 Syntax in-mathmacrotemplate
3477 \begin_layout Description
3478 Origin sts, 06 January 2008
3481 \begin_layout Subsection*
3482 LFUN_PARAGRAPH_MOVE_DOWN
3485 \begin_layout Description
3486 Action Moves the current paragraph downwards in the document.
3490 \begin_layout Description
3491 Syntax paragraph-move-down
3494 \begin_layout Description
3495 Origin Edwin, 8 Apr 2006
3498 \begin_layout Subsection*
3499 LFUN_PARAGRAPH_MOVE_UP
3502 \begin_layout Description
3503 Action Moves the current paragraph upwards in the document.
3507 \begin_layout Description
3508 Syntax paragraph-move-up
3511 \begin_layout Description
3512 Origin Edwin, 8 Apr 2006
3515 \begin_layout Subsection*
3519 \begin_layout Description
3520 Action Move the cursor to the next paragraph (or begining of the current
3521 one) in upward direction.
3525 \begin_layout Description
3529 \begin_layout Description
3530 Origin Asger, 1 Oct 1996
3533 \begin_layout Subsection*
3534 LFUN_PARAGRAPH_UP_SELECT
3537 \begin_layout Description
3538 Action Move the cursor and select the text to the next paragraph (or begining
3539 of the current one) in upward direction.
3543 \begin_layout Description
3544 Syntax paragraph-up-select
3547 \begin_layout Description
3548 Origin Asger, 1 Oct 1996
3551 \begin_layout Subsection*
3555 \begin_layout Description
3556 Action Move the cursor to the next paragraph (or begining of the current
3557 one) in downward direction.
3561 \begin_layout Description
3562 Syntax paragraph-down
3565 \begin_layout Description
3566 Origin Asger, 1 Oct 1996
3569 \begin_layout Subsection*
3570 LFUN_PARAGRAPH_DOWN_SELECT
3573 \begin_layout Description
3574 Action Move the cursor and select the text to the next paragraph (or begining
3575 of the current one) in downward direction.
3579 \begin_layout Description
3580 Syntax paragraph-down-select
3583 \begin_layout Description
3584 Origin Asger, 1 Oct 1996
3587 \begin_layout Subsection*
3591 \begin_layout Description
3592 Action Jump to a paragraph given by its id number and optionally the desired
3593 position within the paragraph.
3597 \begin_layout Description
3598 Notion Note that id number of paragraph is not the sequential number of
3599 paragraph seen on the screen.
3600 Moreover the id is unique for all opened buffers (documents).
3604 \begin_layout Description
3605 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3608 \begin_layout Description
3609 Params <PAR_ID_NUMBER>: paragraph id
3610 \begin_inset Newline newline
3613 <POSITION_IN_PAR>: desired position within the paragraph
3616 \begin_layout Description
3617 Origin Dekel, 26 Aug 2000
3620 \begin_layout Subsection*
3621 LFUN_BREAK_PARAGRAPH
3624 \begin_layout Description
3625 Action Breaks the current paragraph at the current location.
3629 \begin_layout Description
3630 Syntax break-paragraph
3633 \begin_layout Subsection*
3634 LFUN_BREAK_PARAGRAPH
3637 \begin_layout Description
3638 Action Breaks the current paragraph at the current location.
3642 \begin_layout Description
3643 Notion Removes the selection.
3647 \begin_layout Description
3648 Syntax break-paragraph [<LAYOUT>]
3651 \begin_layout Description
3652 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3653 default layout) when the cursor is at the end of the line.
3657 \begin_layout Subsection*
3658 LFUN_PARAGRAPH_PARAMS
3661 \begin_layout Description
3662 Action Change paragraph settings.
3666 \begin_layout Description
3667 Notion Modifies the current paragraph, or currently selected paragraphs.
3668 This function only modifies, and does not override, existing settings.
3669 Note that the "leftindent" indent setting is deprecated.
3673 \begin_layout Description
3674 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3677 \begin_layout Description
3687 \begin_inset Newline newline
3692 paragraph_spacing default|single|onehalf|double|other
3693 \begin_inset Newline newline
3698 align block|left|right|center|default
3699 \begin_inset Newline newline
3704 labelwidthstring WIDTH|
3707 \begin_inset Newline newline
3713 \begin_layout Description
3714 Origin rgh, Aug 15 2007
3717 \begin_layout Subsection*
3718 LFUN_PARAGRAPH_PARAMS_APPLY
3721 \begin_layout Description
3722 Action Change paragraph settings.
3726 \begin_layout Description
3727 Notion Overwrite all nonspecified settings to the default ones.
3728 Use paragraph-params lfun if you don't want to overwrite others settings.
3732 \begin_layout Description
3733 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3736 \begin_layout Description
3737 Params For parameters see LFUN_PARAGRAPH_PARAMS
3740 \begin_layout Description
3741 Origin leeming, 30 Mar 2004
3744 \begin_layout Subsection*
3745 LFUN_PARAGRAPH_UPDATE
3748 \begin_layout Description
3749 Action Updates the values inside the paragraph dialog from the paragraph.
3753 \begin_layout Description
3754 Notion This is internal LFUN, not to be used by users.
3755 Called internally by LFUN_DIALOG_UPDATE.
3759 \begin_layout Description
3760 Origin leeming, 13 Mar 2003
3763 \begin_layout Subsection*
3767 \begin_layout Description
3768 Action Move the current group in the upward direction in the structure of
3773 \begin_layout Description
3774 Notion The "group" can be Part/Chapter/Section/etc.
3775 It moves the whole substructure of the group.
3779 \begin_layout Description
3783 \begin_layout Description
3784 Origin Vermeer, 23 Mar 2006
3787 \begin_layout Subsection*
3791 \begin_layout Description
3792 Action Move the current group in the downward direction in the structure
3797 \begin_layout Description
3798 Notion The "group" can be Part/Chapter/Section/etc.
3799 It moves the whole substructure of the group.
3803 \begin_layout Description
3807 \begin_layout Description
3808 Origin Vermeer, 23 Mar 2006
3811 \begin_layout Subsection*
3815 \begin_layout Description
3816 Action Moves the current group in the downward direction in the hierarchy
3817 of the document structure.
3821 \begin_layout Description
3822 Notion Part -> Chapter -> Section -> etc.
3826 \begin_layout Description
3830 \begin_layout Description
3831 Origin Vermeer, 23 Mar 2006
3834 \begin_layout Subsection*
3838 \begin_layout Description
3839 Action Moves the current group in the upward direction in the hierarchy
3840 of the document structure.
3844 \begin_layout Description
3845 Notion Part <- Chapter <- Section <- etc.
3849 \begin_layout Description
3853 \begin_layout Description
3854 Origin Vermeer, 23 Mar 2006
3857 \begin_layout Subsection*
3861 \begin_layout Description
3862 Action Edit the inset at cursor with an external application, *
3863 if one is attributed.
3867 \begin_layout Description
3868 Syntax inset-edit [<INSET_PARAMS>]
3871 \begin_layout Description
3872 Params <INSET_PARAMS>: Parameters for the inset.
3874 \begin_inset Newline newline
3877 Currently only the filename will be considered.
3881 \begin_layout Description
3882 Origin JSpitzm, 27 Apr 2006
3885 \begin_layout Subsection*
3889 \begin_layout Description
3890 Action Inserts table into the document.
3894 \begin_layout Description
3895 Syntax tabular-insert [<ROWS> <COLUMNS>]
3898 \begin_layout Description
3899 Params In case no arguments are given show insert dialog.
3903 \begin_layout Description
3904 Origin Jug, 12 Apr 2000
3907 \begin_layout Subsection*
3908 LFUN_TABULAR_FEATURE
3911 \begin_layout Description
3912 Action Sets various features to the table/cell on the current cursor position.
3916 \begin_layout Description
3917 Notion Various math-environment features are handled here as well, e.g.
3918 add-vline-left/right for Grid/Cases environment
3921 \begin_layout Description
3922 Syntax tabular-feature <FEATURE> [<ARG>]
3925 \begin_layout Description
3926 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3927 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3928 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3929 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3930 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3931 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3932 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3933 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3934 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3935 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3936 |set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
3937 ar-valign-middle|tabular-valign-bottom
3938 \begin_inset Newline newline
3941 <ARG>: additional argument for some commands, use debug mode to explore
3946 \begin_layout Description
3947 Origin Jug, 28 Jul 2000
3950 \begin_layout Subsection*
3954 \begin_layout Description
3955 Action Moves the cursor to the previous cell inside the table.
3959 \begin_layout Description
3960 Syntax cell-backward
3963 \begin_layout Description
3964 Origin Jug, 22 May 2000
3967 \begin_layout Subsection*
3971 \begin_layout Description
3972 Action Moves the cursor to the next cell inside the table.
3976 \begin_layout Description
3980 \begin_layout Subsection*
3984 \begin_layout Description
3985 Action Splits cell and shifts right part to the next cell (inside the math
3990 \begin_layout Description
3994 \begin_layout Description
3995 Origin Ale, 15 May 1997
3998 \begin_layout Subsection*
4002 \begin_layout Description
4003 Action Register the document as an file inside version control system (RCS,
4008 \begin_layout Description
4009 Notion File is registered inside cvs, svn or rcs repository acording to
4010 the existence of cvs/svn/rcs entries in the document's directory.
4012 \begin_inset Newline newline
4015 See LyX Additional Features Manual (Version Control Chapter) for additional
4020 \begin_layout Description
4024 \begin_layout Description
4025 Origin Lgb, 1 Jul 1997
4028 \begin_layout Subsection*
4032 \begin_layout Description
4033 Action Checks-in/commits the changes of the registered file to the repository.
4037 \begin_layout Description
4038 Notion In RCS case this also unlocks the file.
4042 \begin_layout Description
4046 \begin_layout Description
4047 Origin Lgb, 1 Jul 1997
4050 \begin_layout Subsection*
4054 \begin_layout Description
4055 Action Checks-out the document for edit (and locks it for RCS).
4059 \begin_layout Description
4060 Notion This is implemented only for RCS and SVN, not CVS.
4064 \begin_layout Description
4068 \begin_layout Description
4069 Origin Lgb, 1 Jul 1997
4072 \begin_layout Subsection*
4076 \begin_layout Description
4077 Action Reverts the document to the last check-in/commit in VCS.
4081 \begin_layout Description
4085 \begin_layout Description
4086 Origin Lgb, 1 Jul 1997
4089 \begin_layout Subsection*
4093 \begin_layout Description
4094 Action Undo last check-in.
4098 \begin_layout Description
4099 Notion This is currently implemented only for RCS.
4103 \begin_layout Description
4107 \begin_layout Description
4108 Origin Lgb, 1 Jul 1997
4111 \begin_layout Subsection*
4115 \begin_layout Description
4116 Action Executes external command.
4117 This command is intended to support additional VCS commands.
4121 \begin_layout Description
4122 Syntax vc-command <FLAG> <PATH> <COMMAND>
4125 \begin_layout Description
4126 Params <FLAG>: Flags for the command can be combined together.
4128 \begin_inset Newline newline
4131 U - dUmmy - no flags
4132 \begin_inset Newline newline
4135 D - Doc - need document loaded to proceed
4136 \begin_inset Newline newline
4139 I - dIrty - mark document dirty
4140 \begin_inset Newline newline
4143 R - Reload - ensure that the document is saved and reload it after command
4145 \begin_inset Newline newline
4148 M - Message - ask for input string (commit message)
4149 \begin_inset Newline newline
4152 <PATH>: path where to start.
4153 $$p will be replaced by the current document path.
4155 \begin_inset Newline newline
4158 <COMMAND>: command to execute.
4159 $$i/$$p/$$m will be replaced by the current document/path/message.
4163 \begin_layout Description
4164 Sample vc-command DR $$p "svn up"
4167 \begin_layout Description
4168 Origin sanda, 13 Jan 2009
4171 \begin_layout Subsection*
4175 \begin_layout Description
4176 Action Toggles change tracking to on/off.
4180 \begin_layout Description
4181 Syntax changes-track
4184 \begin_layout Description
4185 Origin levon, 1 Oct 2002
4188 \begin_layout Subsection*
4192 \begin_layout Description
4193 Action Toggles showing of change tracking in typesetted output.
4197 \begin_layout Description
4198 Syntax changes-output
4201 \begin_layout Description
4202 Origin jspitzm, 21 Jan 2005
4205 \begin_layout Subsection*
4209 \begin_layout Description
4210 Action Moves the cursor to the position of the next change of the change
4215 \begin_layout Description
4219 \begin_layout Description
4220 Origin schmitt, 4 Oct 2006
4223 \begin_layout Subsection*
4227 \begin_layout Description
4228 Action Open change tracking dialog for merging and moves the cursor to the
4229 position of the next change.
4233 \begin_layout Description
4234 Syntax changes-merge
4237 \begin_layout Description
4238 Origin Levon, 16 Oct 2002
4241 \begin_layout Subsection*
4245 \begin_layout Description
4246 Action Accepts tracked change inside the selection.
4250 \begin_layout Description
4251 Syntax change-accept
4254 \begin_layout Description
4255 Origin Levon, 16 Oct 2002
4258 \begin_layout Subsection*
4262 \begin_layout Description
4263 Action Rejects tracked change inside the selection.
4267 \begin_layout Description
4268 Syntax change-accept
4271 \begin_layout Description
4272 Origin Levon, 16 Oct 2002
4275 \begin_layout Subsection*
4276 LFUN_ALL_CHANGES_ACCEPT
4279 \begin_layout Description
4280 Action Accepts all tracked changes in the document.
4284 \begin_layout Description
4285 Syntax all-changes-accept
4288 \begin_layout Description
4289 Origin Levon, 16 Oct 2002
4292 \begin_layout Subsection*
4293 LFUN_ALL_CHANGES_REJECT
4296 \begin_layout Description
4297 Action Rejects all tracked changes in the document.
4301 \begin_layout Description
4302 Notion Reject does not work recursively; the user may have to repeat the
4307 \begin_layout Description
4308 Syntax all-changes-reject
4311 \begin_layout Description
4312 Origin Levon, 16 Oct 2002
4315 \begin_layout Subsection*
4319 \begin_layout Description
4320 Action Apply data for an inset.
4324 \begin_layout Description
4325 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4327 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4328 on the context where it is called.
4332 \begin_layout Description
4333 Syntax inset-apply <ARGS>
4336 \begin_layout Description
4337 Params See LFUN_INSET_INSERT .
4341 \begin_layout Subsection*
4345 \begin_layout Description
4346 Action Dissolve the current inset into text.
4350 \begin_layout Description
4351 Syntax inset-dissolve [<INSET>]
4354 \begin_layout Description
4355 Params <INSET>: this can be used to make sure the right kind of inset is
4357 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4358 the charstyle inset, even if the cursor is inside several nested insets
4361 \begin_inset Newline newline
4364 For values see lyx::InsetLayout::lyxtype_ .
4368 \begin_layout Description
4369 Origin JSpitz, 7 Aug 2006
4372 \begin_layout Subsection*
4376 \begin_layout Description
4377 Action Insert new inset (type given by the parameters).
4381 \begin_layout Description
4382 Syntax inset-insert <INSET> <ARGS>
4385 \begin_layout Description
4386 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4387 nclude|index|label|nomencl|vspace|ref|toc>
4388 \begin_inset Newline newline
4391 <ARGS>: depends on the given inset.
4392 Use "lyx -dbg action" to explore.
4396 \begin_layout Description
4397 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4400 \begin_inset Newline newline
4403 where <label name> is the name of the referenced label and<Format> is one
4405 \begin_inset Newline newline
4409 \begin_inset Newline newline
4412 eqref -- (<reference>)
4413 \begin_inset Newline newline
4417 \begin_inset Newline newline
4420 vpageref -- on <page>
4421 \begin_inset Newline newline
4424 vref -- <reference> on <page>
4425 \begin_inset Newline newline
4428 prettyref -- Formatted reference
4431 \begin_layout Subsection*
4435 \begin_layout Description
4436 Action Modify existing inset.
4440 \begin_layout Description
4441 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4442 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4447 \begin_layout Description
4448 Syntax inset-modify <INSET> <ARGS>
4451 \begin_layout Description
4452 Params See LFUN_INSET_INSERT for further details.
4456 \begin_layout Subsection*
4457 LFUN_NEXT_INSET_MODIFY
4460 \begin_layout Description
4461 Action Modify the inset at cursor position, if there is one.
4465 \begin_layout Description
4466 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4467 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4472 \begin_layout Description
4473 Syntax next-inset-modify <INSET> <ARGS>
4476 \begin_layout Description
4477 Syntax next-inset-modify changetype <TYPE>
4480 \begin_layout Description
4481 Params See LFUN_INSET_INSERT for further details.
4485 \begin_layout Description
4486 Origin JSpitzm, 23 Mar 2008
4489 \begin_layout Subsection*
4490 LFUN_INSET_DIALOG_UPDATE
4493 \begin_layout Description
4494 Action Updates the values inside the dialog from the inset.
4498 \begin_layout Description
4499 Notion This is internal LFUN, not to be used by users.
4500 Called internally by LFUN_DIALOG_UPDATE
4503 \begin_layout Description
4504 Params <DIALOG-NAME>
4507 \begin_layout Description
4508 Origin leeming, 25 Feb 2003
4511 \begin_layout Subsection*
4515 \begin_layout Description
4516 Action Open the inset's properties dialog.
4520 \begin_layout Description
4521 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4525 \begin_layout Description
4526 Syntax inset-settings <INSET>
4529 \begin_layout Description
4530 Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
4533 \begin_layout Subsection*
4534 LFUN_NEXT_INSET_TOGGLE
4537 \begin_layout Description
4538 Action Toggles the inset at cursor position.
4539 For collapsables, this means it will be (un-)collapsed, in case of other
4540 insets, the editing widget (dialog) will be entered.
4542 LFUN_INSET_SETTINGS.
4546 \begin_layout Description
4547 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4548 ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4553 \begin_layout Description
4554 Syntax next-inset-toggle <ARG>
4557 \begin_layout Description
4558 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4562 \begin_layout Description
4563 Origin leeming, 30 Mar 2004
4566 \begin_layout Subsection*
4570 \begin_layout Description
4571 Action Toggles the collapsable inset we are currently in.
4575 \begin_layout Description
4576 Syntax inset-toggle [<ARG>]
4579 \begin_layout Description
4580 Params <ARG>: <open|close|toggle|assign>.
4582 \begin_inset Newline newline
4585 open/close/toggle are for collapsable insets.
4586 close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4587 toggle is used when no argument is given.
4589 \begin_inset Newline newline
4592 assign is for branch inset.
4596 \begin_layout Description
4597 Origin lasgouttes, 19 Jul 2001
4600 \begin_layout Subsection*
4601 LFUN_ALL_INSETS_TOGGLE
4604 \begin_layout Description
4605 Action Toggles (open/closes) all collapsable insets (of a given type) in
4610 \begin_layout Description
4611 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4615 \begin_layout Description
4616 Syntax all-insets-toggle <STATE> <INSET>
4619 \begin_layout Description
4620 Params <STATE>: <toggle|open|close> default: toggle
4621 \begin_inset Newline newline
4624 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4628 \begin_layout Description
4629 Origin leeming, 30 Mar 2004
4632 \begin_layout Subsection*
4633 LFUN_SET_GRAPHICS_GROUP
4636 \begin_layout Description
4637 Action Set the group for the graphics inset on the cursor position.
4641 \begin_layout Description
4642 Syntax set-graphics-group [<GROUP>]
4645 \begin_layout Description
4646 Params <GROUP>: Id for an existing group.
4647 In case the Id is an empty string, the graphics inset is removed from the
4652 \begin_layout Description
4653 Origin sanda, 6 May 2008
4656 \begin_layout Subsection*
4657 LFUN_FINISHED_FORWARD
4660 \begin_layout Description
4661 Action Moves the cursor out of the current slice, going forward.
4665 \begin_layout Description
4666 Notion Cursor movement within an inset may be different than cursor movement
4667 in the surrounding text.
4668 This action should be called automatically by the cursor movement within
4669 the inset, when movement within the inset has ceased (reached the end of
4670 the last paragraph, for example), in order to move correctly back into
4671 the surrounding text.
4675 \begin_layout Subsection*
4676 LFUN_FINISHED_BACKWARD
4679 \begin_layout Description
4680 Action Moves the cursor out of the current slice, going backwards.
4684 \begin_layout Description
4685 Notion See also LFUN_FINISHED_FORWARD.
4689 \begin_layout Subsection*
4693 \begin_layout Description
4694 Action Moves the cursor out of the current slice, going right.
4698 \begin_layout Description
4699 Notion See also LFUN_FINISHED_FORWARD
4702 \begin_layout Subsection*
4706 \begin_layout Description
4707 Action Moves the cursor out of the current slice, going left.
4711 \begin_layout Description
4712 Notion See also LFUN_FINISHED_FORWARD.
4716 \begin_layout Subsection*
4720 \begin_layout Description
4721 Action Set language from the current cursor position.
4725 \begin_layout Description
4726 Syntax language <LANG>
4729 \begin_layout Description
4730 Params <LANG>: Requested language.
4731 Look in lib/languages for the list.
4735 \begin_layout Description
4736 Origin Dekel, 2 Mar 2000
4739 \begin_layout Subsection*
4743 \begin_layout Description
4744 Action Goto a label.
4748 \begin_layout Description
4749 Syntax label-goto [<LABEL>]
4752 \begin_layout Description
4753 Params <LABEL>: Requested label.
4754 If no label is given and refernce is on cursor position, Bookmark 0 is
4755 saved and cursor moves to the position of referenced label.
4759 \begin_layout Description
4760 Origin Ale, 6 Aug 1997
4763 \begin_layout Subsection*
4767 \begin_layout Description
4768 Action Inserts label to text or displayed formula.
4772 \begin_layout Description
4773 Syntax label-insert [<LABEL>]
4776 \begin_layout Description
4777 Params <LABEL>: Requested label.
4778 If no label is given dialog requesting name will be opened.
4782 \begin_layout Subsection*
4786 \begin_layout Description
4787 Action Go to the next label or cross-reference.
4791 \begin_layout Description
4792 Syntax reference-next
4795 \begin_layout Description
4796 Origin Dekel, 14 Jan 2001
4799 \begin_layout Subsection*
4803 \begin_layout Description
4804 Action Goto a bookmark.
4808 \begin_layout Description
4809 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4810 Note that bookmarsk are saved per-session, not per file.
4814 \begin_layout Description
4815 Syntax bookmark-goto <NUMBER>
4818 \begin_layout Description
4819 Params <NUMBER>: the number of the bookmark to restore.
4823 \begin_layout Description
4824 Origin Dekel, 27 January 2001
4827 \begin_layout Subsection*
4831 \begin_layout Description
4832 Action Save a bookmark.
4836 \begin_layout Description
4837 Notion Saves a numbered bookmark to the sessions file.
4838 The number must be between 1 and 9, inclusive.
4839 Note that bookmarks are saved per-session, not per file.
4843 \begin_layout Description
4844 Syntax bookmark-save <NUMBER>
4847 \begin_layout Description
4848 Params <NUMBER>: the number of the bookmark to save.
4852 \begin_layout Description
4853 Origin Dekel, 27 January 2001
4856 \begin_layout Subsection*
4860 \begin_layout Description
4861 Action Clears the list of saved bookmarks.
4865 \begin_layout Description
4866 Syntax bookmark-clear
4869 \begin_layout Description
4870 Origin bpeng, 31 October 2006
4873 \begin_layout Subsection*
4877 \begin_layout Description
4878 Action Open the given help file according to the language setting.
4882 \begin_layout Description
4883 Syntax help-open <FILE>[.lyx]
4886 \begin_layout Description
4887 Params <FILE>: any document from (/usr/share/)doc directory.
4891 \begin_layout Description
4892 Origin Jug, 27 Jun 1999
4895 \begin_layout Subsection*
4899 \begin_layout Description
4900 Action Terminates the current LyX instance.
4904 \begin_layout Description
4905 Notion Terminates the current LyX instance, asking whether to save modified
4910 \begin_layout Description
4914 \begin_layout Subsection*
4918 \begin_layout Description
4919 Action Toggles visibility of a given toolbar between on/off/auto.
4923 \begin_layout Description
4924 Notion Skiping "auto" when allowauto is false.
4928 \begin_layout Description
4929 Syntax toolbar-toggle <NAME> [allowauto]
4932 \begin_layout Description
4933 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4934 ew/update|math_panels|vcs
4937 \begin_layout Description
4938 Origin Edwin, 21 May 2007
4941 \begin_layout Subsection*
4945 \begin_layout Description
4946 Action Opens the menu given by its name.
4950 \begin_layout Description
4951 Syntax menu-open <NAME>
4954 \begin_layout Description
4955 Params <NAME>: menu name.
4956 See various .inc files in lib/ui for candidates.
4960 \begin_layout Subsection*
4964 \begin_layout Description
4965 Action Various UI visibility-toggling actions.
4969 \begin_layout Description
4970 Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
4973 \begin_layout Description
4974 Params statusbar : Toggle visibility of the statusbar.
4976 \begin_inset Newline newline
4979 menubar : Toggle visibility of the menubar.
4981 \begin_inset Newline newline
4984 scrollbar : Toggle visibility of the scrollbar.
4986 \begin_inset Newline newline
4989 frame : Toggle visibility of the frames around editing window.
4991 \begin_inset Newline newline
4994 fullscreen : Toggle fullscreen mode.
4995 This also covers calling the previous functions.
4996 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5001 \begin_layout Description
5002 Origin sanda, 9 Feb 2007
5005 \begin_layout Subsection*
5009 \begin_layout Description
5010 Action Creates new empty LyX window.
5014 \begin_layout Description
5015 Notion Already opened documents from the previous window can be found under
5020 \begin_layout Description
5021 Syntax window-new [<GEOMETRY>]
5024 \begin_layout Description
5025 Params <GEOMETRY>: pass the geometry of the window.
5026 This parameter is currently accepted only on Windows platform.
5030 \begin_layout Description
5031 Origin Abdel, 21 Oct 2006
5034 \begin_layout Subsection*
5038 \begin_layout Description
5039 Action Closes the current LyX window.
5043 \begin_layout Description
5047 \begin_layout Description
5048 Origin Abdel, 23 Oct 2006
5051 \begin_layout Subsection*
5055 \begin_layout Description
5056 Action Creates another split view of current buffer.
5060 \begin_layout Description
5061 Notion All split views act in the same way indpendently.
5065 \begin_layout Description
5066 Syntax split-view <vertical|horizontal>
5069 \begin_layout Description
5070 Params horizontal : The work areas are laid out side by side.
5072 \begin_inset Newline newline
5075 vertical : The work areas laid out vertically.
5079 \begin_layout Description
5080 Origin Abdel, 20 Feb 2008
5083 \begin_layout Subsection*
5084 LFUN_CLOSE_TAB_GROUP
5087 \begin_layout Description
5088 Action Close the current tab group.
5092 \begin_layout Description
5093 Notion This only closes the work areas, not the buffer themselves.
5094 The still opened buffers can be visualized in another tab group.
5098 \begin_layout Description
5099 Syntax close-tab-group
5102 \begin_layout Description
5103 Origin Abdel, 21 Feb 2008
5106 \begin_layout Subsection*
5110 \begin_layout Description
5111 Action Shows hidden dialog or create new one for a given function/inset
5116 \begin_layout Description
5117 Syntax dialog-show <NAME> [<DATA>]
5120 \begin_layout Description
5121 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5123 \begin_inset Newline newline
5126 document|errorlist|ert|external|file|findreplace|float|graphics|
5127 \begin_inset Newline newline
5130 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
5131 \begin_inset Newline newline
5134 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
5135 \begin_inset Newline newline
5138 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
5139 \begin_inset Newline newline
5142 wrap|listings|<SPECIAL>
5143 \begin_inset Newline newline
5146 <SPECIAL>: latexlog|vclog
5147 \begin_inset Newline newline
5150 <DATA>: data, usually settings for the given dialog.
5151 Use debug mode for the details.
5155 \begin_layout Description
5156 Origin leeming, 17 Jun 2003
5159 \begin_layout Subsection*
5160 LFUN_DIALOG_SHOW_NEW_INSET
5163 \begin_layout Description
5164 Action Shows hidden dialog or create new one for a given inset settings
5169 \begin_layout Description
5170 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5175 \begin_layout Description
5176 Syntax dialog-show-new-inset <NAME> [<DATA>]
5179 \begin_layout Description
5180 Params See LFUN_DIALOG_SHOW .
5184 \begin_layout Description
5185 Origin leeming, 25 Feb 2003
5188 \begin_layout Subsection*
5192 \begin_layout Description
5193 Action Updates the dialog values from the inset/paragraph/document.
5197 \begin_layout Description
5198 Syntax dialog-update <NAME>
5201 \begin_layout Description
5202 Params <NAME>: paragraph|prefs|<INSET>
5203 \begin_inset Newline newline
5209 \begin_layout Description
5210 Origin leeming, 25 Feb 2003
5213 \begin_layout Subsection*
5217 \begin_layout Description
5218 Action Hides showed dialog.
5219 Counterpart to LFUN_DIALOG_SHOW .
5223 \begin_layout Description
5224 Syntax dialog-hide <NAME>
5227 \begin_layout Description
5228 Params See LFUN_DIALOG_SHOW .
5232 \begin_layout Description
5233 Origin leeming, 25 Feb 2003
5236 \begin_layout Subsection*
5240 \begin_layout Description
5241 Action Toggles dialog between showed/hidden state.
5245 \begin_layout Description
5246 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5250 \begin_layout Description
5251 Syntax dialog-toggle <NAME> [<DATA>]
5254 \begin_layout Description
5255 Params See LFUN_DIALOG_SHOW .
5259 \begin_layout Description
5260 Origin JSpitzm, 30 Apr 2007
5263 \begin_layout Subsection*
5264 LFUN_DIALOG_DISCONNECT_INSET
5267 \begin_layout Description
5268 Action Closes opened connection to opened inset.
5272 \begin_layout Description
5273 Notion Connection is used for apply functions.
5277 \begin_layout Description
5278 Syntax dialog-disconnect-inset <INSET-NAME>
5281 \begin_layout Description
5282 Origin leeming, 25 Feb 2003
5285 \begin_layout Subsection*
5289 \begin_layout Description
5290 Action This function is called when mouse button is pressed (inside workarea).Act
5291 ion depends on the context.
5295 \begin_layout Description
5296 Notion This is internal LFUN, not to be used by users.
5300 \begin_layout Description
5301 Origin Andre, 9 Aug 2002
5304 \begin_layout Subsection*
5308 \begin_layout Description
5309 Action This function is called when double click on mouse button is pressed
5311 Action depends on the context.
5315 \begin_layout Description
5316 Notion This is internal LFUN, not to be used by users.
5320 \begin_layout Description
5321 Origin Andre, 9 Aug 2002
5324 \begin_layout Subsection*
5328 \begin_layout Description
5329 Action This function is called when triple click on mouse button is pressed
5331 Action depends on the context.
5335 \begin_layout Description
5336 Notion This is internal LFUN, not to be used by users.
5340 \begin_layout Description
5341 Origin Andre, 9 Aug 2002
5344 \begin_layout Subsection*
5348 \begin_layout Description
5349 Action This function is called when mouse cursor is moving over the text.Action
5350 depends on the context.
5354 \begin_layout Description
5355 Notion This is internal LFUN, not to be used by users.
5359 \begin_layout Description
5360 Origin Andre, 9 Aug 2002
5363 \begin_layout Subsection*
5367 \begin_layout Description
5368 Action This function is called when mouse button is released (inside workarea).Ac
5369 tion depends on the context.
5373 \begin_layout Description
5374 Notion This is internal LFUN, not to be used by users.
5378 \begin_layout Description
5379 Origin Andre, 9 Aug 2002
5382 \begin_layout Subsection*
5386 \begin_layout Description
5387 Action Turn off the loaded keyboard map.
5391 \begin_layout Description
5395 \begin_layout Subsection*
5399 \begin_layout Description
5400 Action Turn on the primary keyboard map.
5404 \begin_layout Description
5405 Notion Maps were widely used in past, when X-windows didn't have nowadays
5407 They can be still used to maintain uniform keyboard layout across the various
5410 \begin_inset Newline newline
5413 The language is to be set in the Preferences dialog.
5417 \begin_layout Description
5418 Syntax keymap-primary
5421 \begin_layout Subsection*
5422 LFUN_KEYMAP_SECONDARY
5425 \begin_layout Description
5426 Action Turn on the secondary keyboard map.
5430 \begin_layout Description
5431 Syntax keymap-secondary
5434 \begin_layout Subsection*
5438 \begin_layout Description
5439 Action Toggles keyboard maps (first/second/off).
5443 \begin_layout Description
5444 Syntax keymap-toggle
5447 \begin_layout Description
5448 Origin leeming, 30 Mar 2004
5451 \begin_layout Subsection*
5452 LFUN_SERVER_GET_LAYOUT
5455 \begin_layout Description
5456 Action Returns the current layout (that is environment) name on the cursor
5461 \begin_layout Description
5462 Syntax server-get-layout
5465 \begin_layout Subsection*
5466 LFUN_SERVER_GET_FILENAME
5469 \begin_layout Description
5470 Action Returns path and file name of the currently edited document.
5474 \begin_layout Description
5475 Syntax server-get-filename
5478 \begin_layout Subsection*
5479 LFUN_SERVER_GOTO_FILE_ROW
5482 \begin_layout Description
5483 Action Sets the cursor position based on the row number of generated TeX
5488 \begin_layout Description
5489 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5492 \begin_layout Description
5493 Origin Edmar, 23 Dec 1998
5496 \begin_layout Subsection*
5500 \begin_layout Description
5501 Action Sends notify message about the last key-sequence to client.
5505 \begin_layout Description
5506 Notion This can be used to grab last key-sequence used inside the LyX window.
5507 See also Debug extensions section in Additional features manual.
5511 \begin_layout Description
5512 Syntax server-notify
5515 \begin_layout Subsection*
5519 \begin_layout Description
5520 Action Sets the cursor position based on the editing area coordinates (similar
5521 as clicking on that point with left mouse button).
5525 \begin_layout Description
5526 Syntax server-set-xy <X> <Y>
5529 \begin_layout Subsection*
5533 \begin_layout Description
5534 Action Returns the coordinates of cursor position in the editing area.
5538 \begin_layout Description
5539 Syntax server-get-xy
5542 \begin_layout Subsection*
5546 \begin_layout Description
5547 Action Generates the code (literate programming).
5551 \begin_layout Description
5552 Notion Latex file with extension literate_extension is generated.
5553 Then LyX invokes build_command (with a default of``make'') to generate
5554 the code and build_error_filter to process the compilation error messages.
5556 \begin_inset Newline newline
5559 In case you want to process your literate file with a script, or some other
5560 program, just insert in your lyxrc file an entry with:
5561 \begin_inset Newline newline
5564 build_command "my_script my_arguments"
5565 \begin_inset Newline newline
5568 The build_error_filter differs from the literate_error_filter only in that
5569 the former will identify error messages from your compiler.
5573 \begin_layout Description
5574 Syntax build-program
5577 \begin_layout Subsection*
5578 LFUN_BUFFER_AUTO_SAVE
5581 \begin_layout Description
5582 Action Saves the current buffer to a temporary file.
5586 \begin_layout Description
5587 Notion Saves the current buffer to a file named "#filename#".
5588 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5592 \begin_layout Description
5593 Syntax buffer-auto-save
5596 \begin_layout Subsection*
5597 LFUN_BUFFER_CHILD_OPEN
5600 \begin_layout Description
5601 Action Loads the given child document.
5605 \begin_layout Description
5606 Notion The current document is treated as a parent.
5610 \begin_layout Description
5611 Syntax buffer-child-open <FILE>
5614 \begin_layout Description
5615 Params <FILE>: Filename of the child.
5616 The directory of the parent is assumed by default.
5620 \begin_layout Description
5621 Origin Ale, 28 May 1997
5624 \begin_layout Subsection*
5628 \begin_layout Description
5629 Action Runs chktex for the current document.
5633 \begin_layout Description
5634 Syntax buffer-chktex
5637 \begin_layout Description
5638 Origin Asger, 30 Oct 1997
5641 \begin_layout Subsection*
5642 LFUN_BUFFER_TOGGLE_COMPRESSION
5645 \begin_layout Description
5646 Action Toggles compression of the current document on/off.
5650 \begin_layout Description
5651 Syntax buffer-toggle-compression
5654 \begin_layout Description
5655 Origin bpeng, 27 Apr 2006
5658 \begin_layout Subsection*
5662 \begin_layout Description
5663 Action Closes the current buffer.
5667 \begin_layout Description
5668 Notion Closes the current buffer, asking whether to save it, etc, if the
5669 buffer has been modified.
5673 \begin_layout Description
5677 \begin_layout Subsection*
5681 \begin_layout Description
5682 Action Exports the current buffer (document) to the given format.
5686 \begin_layout Description
5687 Syntax buffer-export <FORMAT>
5690 \begin_layout Description
5691 Params <FORMAT> is either "custom" or one of the formats which you can find
5692 in Tools->Preferences->File formats->Format.
5693 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5694 for pdflatex) or "ps" for postscript.
5696 \begin_inset Newline newline
5699 In case of "custom" you will be asked for a format you want to start from
5700 and for the command that you want to apply to this format.
5701 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5705 \begin_layout Description
5706 Origin Lgb, 29 Jul 1997
5709 \begin_layout Subsection*
5710 LFUN_BUFFER_EXPORT_CUSTOM
5713 \begin_layout Description
5714 Action Exports the current buffer (document) from the given format using
5715 the given command on it.
5719 \begin_layout Description
5720 Syntax buffer-export-custom <FORMAT> <COMMAND>
5723 \begin_layout Description
5724 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5727 \begin_inset Newline newline
5730 <COMMAND> this command will be launched on the file.
5731 Note that you can use "$$FName" string to qualify the intermediate file.
5735 \begin_layout Description
5736 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5739 \begin_layout Description
5740 Origin leeming, 27 Mar 2004
5743 \begin_layout Subsection*
5747 \begin_layout Description
5748 Action Prints the current document.
5752 \begin_layout Description
5753 Notion Many settings can be given via the preferences dialog.
5757 \begin_layout Description
5758 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5761 \begin_layout Description
5762 Params <TARGET> is either "printer" or "file".
5764 \begin_inset Newline newline
5767 <TARGER-NAME> is either "default" or file name or printer name.
5769 \begin_inset Newline newline
5772 <COMMAND> command ensuring the printing job.
5776 \begin_layout Description
5777 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5780 \begin_layout Description
5781 Origin leeming, 28 Mar 2004
5784 \begin_layout Subsection*
5788 \begin_layout Description
5789 Action Import a given file as a lyx document.
5793 \begin_layout Description
5794 Notion File can be imported iff lyx file format is (transitively) reachable
5795 via defined convertors in preferences.
5796 Look into File->Import menu to get an idea of the currently active import
5801 \begin_layout Description
5802 Syntax buffer-import <FORMAT> [<FILE>]
5805 \begin_layout Description
5806 Origin Asger, 24 Jul 1998
5809 \begin_layout Subsection*
5813 \begin_layout Description
5814 Action Creates a new buffer (that is, document).
5818 \begin_layout Description
5819 Notion Implicit path can be set in Preferences dialog.
5823 \begin_layout Description
5824 Syntax buffer-new [<FILE>]
5827 \begin_layout Description
5828 Params <FILE>: filename of created file with absolute path.
5832 \begin_layout Subsection*
5833 LFUN_BUFFER_NEW_TEMPLATE
5836 \begin_layout Description
5837 Action Creates a new buffer (that is, document) from a template.
5841 \begin_layout Description
5842 Notion Path for new files and templates can be set in Preferences dialog.
5843 Template will be asked for via Open-dialog.
5847 \begin_layout Description
5848 Syntax buffer-new-template [<FILE>]
5851 \begin_layout Description
5852 Params <FILE>: filename of created file with absolute path.
5856 \begin_layout Subsection*
5860 \begin_layout Description
5861 Action Reverts opened document.
5865 \begin_layout Description
5866 Syntax buffer-reload
5869 \begin_layout Description
5870 Origin Asger, 2 Feb 1997
5873 \begin_layout Subsection*
5877 \begin_layout Description
5878 Action Switch to the given buffer.
5882 \begin_layout Description
5883 Notion This is useful also in case you need simultaneously more views of
5884 the edited document in different LyX windows.
5888 \begin_layout Description
5889 Syntax buffer-new-template <BUFFER>
5892 \begin_layout Description
5893 Params <BUFFER>: already opened document which is to be shown.
5897 \begin_layout Subsection*
5898 LFUN_BUFFER_TOGGLE_READ_ONLY
5901 \begin_layout Description
5902 Action Toggle editing mode of the current document between read/write and
5907 \begin_layout Description
5908 Notion In the ->Readonly mode checks-in/commits the data if the file is
5909 under version control.
5910 In the Readonly-> mode checkouts the data from repository.
5912 \begin_inset Newline newline
5915 If these operations fail, buffer won't be toggled.
5919 \begin_layout Description
5920 Syntax buffer-toggle-read-only
5923 \begin_layout Description
5924 Origin Lgb, 27 May 1997
5927 \begin_layout Subsection*
5931 \begin_layout Description
5932 Action Displays current buffer in chosen format.
5936 \begin_layout Description
5937 Notion Displays the contents of the current buffer in the chosen format,
5938 for example, PDF or DVI.
5939 This runs the necessary converter, calls the defined viewer, and so forth.
5943 \begin_layout Description
5944 Syntax buffer-view <FORMAT>
5947 \begin_layout Description
5948 Params <FORMAT>: The format to display, where this is one of the formats
5949 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5953 \begin_layout Subsection*
5957 \begin_layout Description
5958 Action Exports the current document and put the result into the temporary
5963 \begin_layout Description
5964 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5965 EW) the output will be rewriten - updated.
5966 This is useful in case your viewer is able to detect such changes (e.g.
5967 ghostview for postscript).
5971 \begin_layout Description
5972 Syntax buffer-update <FORMAT>
5975 \begin_layout Description
5976 Params <FORMAT>: The format to display, where this is one of the formats
5977 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5981 \begin_layout Description
5982 Origin Dekel, 5 Aug 2000
5985 \begin_layout Subsection*
5989 \begin_layout Description
5990 Action Saves the current buffer.
5994 \begin_layout Description
5995 Notion Saves the current buffer to disk, using the filename that is already
5996 associated with the buffer, asking for one if none is yet assigned.
6000 \begin_layout Description
6004 \begin_layout Subsection*
6005 LFUN_BUFFER_WRITE_AS
6008 \begin_layout Description
6009 Action Rename and save current buffer.
6013 \begin_layout Description
6014 Syntax buffer-write-as <FILENAME>
6017 \begin_layout Description
6018 Params <FILENAME>: New name of the buffer/file.
6019 A relative path is with respect to the original location of the buffer/file.
6023 \begin_layout Subsection*
6024 LFUN_BUFFER_WRITE_ALL
6027 \begin_layout Description
6028 Action Save all changed documents.
6032 \begin_layout Description
6033 Syntax buffer-write-all
6036 \begin_layout Description
6037 Origin rgh, gpothier 6 Aug 2007
6040 \begin_layout Subsection*
6044 \begin_layout Description
6045 Action Switch to the next opened document.
6049 \begin_layout Description
6050 Notion Note that this does not necessarily mean next in tabbar (for full
6051 list see View menu).
6055 \begin_layout Description
6059 \begin_layout Subsection*
6060 LFUN_BUFFER_PREVIOUS
6063 \begin_layout Description
6064 Action Switch to the previous opened document.
6068 \begin_layout Description
6069 Syntax buffer-previous
6072 \begin_layout Subsection*
6073 LFUN_MASTER_BUFFER_UPDATE
6076 \begin_layout Description
6077 Action When run from a child document, this updates (exports) document built
6078 from the master buffer.
6079 If a master is not found, it updates the current buffer.
6083 \begin_layout Description
6084 Syntax master-buffer-update
6087 \begin_layout Description
6088 Origin Tommaso, 20 Sep 2007
6091 \begin_layout Subsection*
6092 LFUN_MASTER_BUFFER_VIEW
6095 \begin_layout Description
6096 Action When run from a child document, this command shows a preview built
6097 from the master buffer.
6098 If a master is not found, it previews the current buffer.
6102 \begin_layout Description
6103 Syntax master-buffer-view
6106 \begin_layout Description
6107 Origin Tommaso, 20 Sep 2007
6110 \begin_layout Subsection*
6111 LFUN_BUFFER_LANGUAGE
6114 \begin_layout Description
6115 Action Set language of the current document.
6119 \begin_layout Description
6120 Syntax buffer-language <LANG>
6123 \begin_layout Description
6124 Params <LANG>: language name.
6125 See lib/languages for list.
6129 \begin_layout Description
6130 Origin leeming, 30 Mar 2004
6133 \begin_layout Subsection*
6134 LFUN_BUFFER_SAVE_AS_DEFAULT
6137 \begin_layout Description
6138 Action Save the current document settings as default.
6142 \begin_layout Description
6143 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6147 \begin_layout Description
6148 Syntax buffer-save-as-default [<ARGS>]
6151 \begin_layout Description
6152 Params <ARGS>: contains the particular settings to be saved.
6153 They obey the syntax you can find in document header of usual .lyx file.
6157 \begin_layout Description
6158 Origin leeming, 30 Mar 2004
6161 \begin_layout Subsection*
6162 LFUN_BUFFER_PARAMS_APPLY
6165 \begin_layout Description
6166 Action Apply the given settings to the current document.
6170 \begin_layout Description
6171 Syntax buffer-params-apply [<ARGS>]
6174 \begin_layout Description
6175 Params <ARGS>: contains the particular settings to be saved.
6176 They obey the syntax you can find in document header of usual .lyx file.
6180 \begin_layout Description
6181 Origin leeming, 30 Mar 2004
6184 \begin_layout Subsection*
6188 \begin_layout Description
6189 Action Inserts another LyX file.
6193 \begin_layout Description
6194 Syntax file-insert [<FILE>]
6197 \begin_layout Description
6198 Params <FILE>: Filename to be inserted.
6202 \begin_layout Subsection*
6203 LFUN_FILE_INSERT_PLAINTEXT
6206 \begin_layout Description
6207 Action Inserts plain text file.
6211 \begin_layout Description
6212 Syntax file-insert-plaintext [<FILE>]
6215 \begin_layout Description
6216 Params <FILE>: Filename to be inserted.
6220 \begin_layout Description
6221 Origin CFO-G, 19 Nov 1997
6224 \begin_layout Subsection*
6225 LFUN_FILE_INSERT_PLAINTEXT_PARA
6228 \begin_layout Description
6229 Action Inserts plain text file as paragraph (i.e.
6234 \begin_layout Description
6235 Syntax file-insert-plaintext-para [<FILE>]
6238 \begin_layout Description
6239 Params <FILE>: Filename to be inserted.
6243 \begin_layout Description
6244 Origin Levon, 14 Feb 2001
6247 \begin_layout Subsection*
6251 \begin_layout Description
6252 Action Open LyX document.
6256 \begin_layout Description
6257 Syntax file-open [<FILE>]
6260 \begin_layout Description
6261 Params <FILE>: Filename to be opened.
6265 \begin_layout Subsection*
6269 \begin_layout Description
6270 Action Executes a command defined in a .def file.
6274 \begin_layout Description
6275 Notion The definitions are by default read from lib/commands/default.def.
6277 \begin_inset Newline newline
6280 A .def file allows to define a command with
6282 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6283 <LFUN> is the lfun code to be executed (see e.g.
6284 LFUN_COMMAND_SEQUENCE).
6287 def_file "FileName" allows to include another .def file.
6289 \begin_inset Newline newline
6292 This is particularly useful in connection with toolbar buttons: Since the
6293 name of the button image for this lfun is lib/images/commands/<NAME>.png
6294 this is the way to assign an image to a complex command-sequence.
6298 \begin_layout Description
6302 \begin_layout Description
6303 Params <NAME>: Name of the command that must be called.
6307 \begin_layout Description
6308 Origin broider, 2 Oct 2007
6311 \begin_layout Subsection*
6315 \begin_layout Description
6316 Action Simulate halting Meta key (Alt key on PCs).
6320 \begin_layout Description
6321 Notion Used for buffer editation not for GUI control.
6325 \begin_layout Description
6329 \begin_layout Subsection*
6333 \begin_layout Description
6334 Action Cancels sequence prepared by LFUN_META_PREFIX .
6338 \begin_layout Description
6342 \begin_layout Subsection*
6343 LFUN_COMMAND_EXECUTE
6346 \begin_layout Description
6347 Action Opens the minibuffer toolbar so that the user can type in there.
6351 \begin_layout Description
6352 Notion Usually bound to M-x shortcut.
6356 \begin_layout Description
6357 Syntax command-execute
6360 \begin_layout Subsection*
6364 \begin_layout Description
6365 Action Return the current key sequence and available options as a string.
6369 \begin_layout Description
6370 Notion No options are added if no current map exists.
6372 \begin_inset Newline newline
6375 This is probably usable only with connection to lyxserver.
6379 \begin_layout Description
6380 Syntax command-prefix
6383 \begin_layout Subsection*
6384 LFUN_COMMAND_SEQUENCE
6387 \begin_layout Description
6388 Action Run more commands (LFUN and its parameters) in a sequence.
6392 \begin_layout Description
6393 Syntax command-sequence <CMDS>
6396 \begin_layout Description
6397 Params <CMDS>: Sequence of commands separated by semicolons.
6401 \begin_layout Description
6402 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6406 \begin_layout Description
6407 Origin Andre, 11 Nov 1999
6410 \begin_layout Subsection*
6411 LFUN_COMMAND_ALTERNATIVES
6414 \begin_layout Description
6415 Action Runs the first listed command that is enabled.
6419 \begin_layout Description
6420 Notion This can be used to bind multiple functions to a single key, and
6421 then which one is used will depend upon the context.
6425 \begin_layout Description
6426 Syntax command-alternatives <CMDS>
6429 \begin_layout Description
6430 Params <CMDS>: Sequence of commands separated by semicolons.
6434 \begin_layout Description
6435 Sample command-alternatives completion-accept;cell-forward
6438 \begin_layout Description
6439 Origin rgh, 24 September 2008
6442 \begin_layout Subsection*
6446 \begin_layout Description
6447 Action Shows message in statusbar (for script purposes).
6451 \begin_layout Description
6452 Syntax message <STRING>
6455 \begin_layout Description
6456 Origin Lgb, 8 Apr 2001
6459 \begin_layout Subsection*
6460 LFUN_PREFERENCES_SAVE
6463 \begin_layout Description
6464 Action Save user preferences.
6468 \begin_layout Description
6469 Syntax preferences-save
6472 \begin_layout Description
6473 Origin Lgb, 27 Nov 1999
6476 \begin_layout Subsection*
6480 \begin_layout Description
6481 Action Reconfigure the automatic settings.
6485 \begin_layout Description
6489 \begin_layout Description
6490 Origin Asger, 14 Feb 1997
6493 \begin_layout Subsection*
6497 \begin_layout Description
6498 Action Apply the given settings to user preferences.
6502 \begin_layout Description
6503 Syntax lyxrc-apply <SETTINGS>
6506 \begin_layout Description
6507 Params <SETTINGS>: settings which are to be set.
6508 Take a look into ~/.lyx/preferences to get an idea which commands to use
6510 lyx::LyXRC::LyXRCTags has the list of possible commands.
6514 \begin_layout Subsection*
6515 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6518 \begin_layout Description
6519 Action Determine whether keep cursor inside the editing window regardless
6520 the scrollbar movement.
6524 \begin_layout Description
6525 Syntax toggle-cursor-follows-scrollbar
6528 \begin_layout Description
6529 Origin ARRae, 2 Dec 1997
6532 \begin_layout Subsection*
6536 \begin_layout Description
6537 Action Set the given LyX color to the color defined by the X11 name given.
6541 \begin_layout Description
6542 Notion A new color entry is created if the color is unknown.
6543 Color names can be stored as a part of user settings.
6547 \begin_layout Description
6548 Syntax set-color <LYX_NAME> <X11_NAME>
6551 \begin_layout Description
6552 Origin SLior, 11 Jun 2000
6555 \begin_layout Subsection*
6559 \begin_layout Description
6560 Action Count the statistics (number of words and characters) in the document
6561 or in the given selection.
6565 \begin_layout Description
6566 Notion Note that this function gives the number of words/chars written,
6567 not the number of characters which will be typeset.
6571 \begin_layout Description
6575 \begin_layout Description
6576 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6579 \begin_layout Subsection*
6580 LFUN_COMPLETION_INLINE
6583 \begin_layout Description
6584 Action Show the inline completion at the cursor position.
6588 \begin_layout Description
6589 Syntax completion-inline
6592 \begin_layout Description
6593 Origin sts, Feb 19 2008
6596 \begin_layout Subsection*
6597 LFUN_COMPLETION_POPUP
6600 \begin_layout Description
6601 Action Show the completion popup at the cursor position.
6605 \begin_layout Description
6606 Syntax completion-popup
6609 \begin_layout Description
6610 Origin sts, Feb 19 2008
6613 \begin_layout Subsection*
6614 LFUN_COMPLETION_COMPLETE
6617 \begin_layout Description
6618 Action Try to complete the word or command at the cursor position.
6622 \begin_layout Description
6626 \begin_layout Description
6627 Origin sts, Feb 19 2008
6630 \begin_layout Subsection*
6631 LFUN_COMPLETION_CANCEL
6634 \begin_layout Description
6635 Action Try to cancel completion, either the popup or the inline completion
6639 \begin_layout Description
6640 Syntax completion-cancel
6643 \begin_layout Description
6644 Origin sts, Sep 07 2008
6647 \begin_layout Subsection*
6648 LFUN_COMPLETION_ACCEPT
6651 \begin_layout Description
6652 Action Accept suggested completion.
6656 \begin_layout Description
6657 Syntax completion-accept
6660 \begin_layout Description
6661 Origin sanda, Sep 08 2008
6664 \begin_layout Subsection*
6665 LFUN_BRANCH_ACTIVATE
6668 \begin_layout Description
6669 Action Activate the branch
6672 \begin_layout Description
6673 Syntax branch-activate <BRANCH>
6676 \begin_layout Description
6677 Params <BRANCH>: The branch to activate
6680 \begin_layout Description
6681 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6682 \begin_inset Newline newline
6685 could be used to export a pdf with the answers branch includedwithout one's
6686 having to open LyX and activate the branch manually.
6689 \begin_layout Description
6690 Origin rgh, 27 May 2008
6693 \begin_layout Subsection*
6694 LFUN_BRANCH_ACTIVATE
6697 \begin_layout Description
6698 Action De-activate the branch
6701 \begin_layout Description
6702 Syntax branch-deactivate <BRANCH>
6705 \begin_layout Description
6706 Params <BRANCH>: The branch to deactivate
6709 \begin_layout Description
6710 Origin rgh, 27 May 2008
6713 \begin_layout Subsection*
6714 LFUN_COPY_LABEL_AS_REF
6717 \begin_layout Description
6718 Action Copies the label at the cursor as a cross-reference to be pasted
6723 \begin_layout Description
6724 Syntax copy-label-as-reference
6727 \begin_layout Description
6728 Origin sts, 16 Nov 2008