1 #LyX 1.6.1 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 06.02.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 Sample command-sequence info-insert buffer path; info-insert buffer name
692 \begin_layout Description
693 Origin bpeng, 7 Oct 2007
696 \begin_layout Subsection*
700 \begin_layout Description
701 Action Inserts branch inset.
705 \begin_layout Description
706 Syntax branch-insert <BRANCH-NAME>
709 \begin_layout Description
710 Origin vermeer, 17 Aug 2003
713 \begin_layout Subsection*
717 \begin_layout Description
718 Action Inserts Box inset.
722 \begin_layout Description
723 Syntax box-insert [<TYPE>]
726 \begin_layout Description
727 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
729 \begin_inset Newline newline
732 Framed is the default one.
736 \begin_layout Description
737 Origin vermeer, 7 Oct 2003
740 \begin_layout Subsection*
744 \begin_layout Description
745 Action Inserts CharStyle, Custom inset or XML short element.
749 \begin_layout Description
750 Notion Look into the Customization manual for more information about these
753 \begin_inset Newline newline
756 To make this command enabled the layout file for the document class you're
757 using has to load the character styles.
758 There are a few contained in the Logical Markup module.
759 You can also of course create some yourself.
761 \begin_inset Newline newline
764 For dissolving the element see LFUN_INSET_DISSOLVE.
768 \begin_layout Description
769 Syntax flex-insert <TYPE:Name>
772 \begin_layout Description
773 Params TYPE: CharStyle|Custom|Element|Standard
774 \begin_inset Newline newline
777 Identifies whether this is a Character Style, a Custom Inset or an XML
778 Element, and which dynamical sub-menu this flex inset is in on the LyX
780 If Standard (currently unused): none of these.
781 Name: This name must be defined either in your layout file or imported
784 \begin_inset Newline newline
787 InsetLayout <TYPE:Name>
790 \begin_layout Description
791 Sample flex-insert CharStyle:Code
794 \begin_layout Subsection*
798 \begin_layout Description
799 Action Inserts the given string (accordingly to the correct keymap).
803 \begin_layout Description
804 Notion Automatically replace the currently selected text.
805 Depends on lyxrc settings "auto_region_delete".
809 \begin_layout Description
810 Syntax self-insert <STRING>
813 \begin_layout Subsection*
817 \begin_layout Description
818 Action Inserts one of horizontal space insets.
822 \begin_layout Description
823 Syntax space-insert <NAME> [<LEN>]
826 \begin_layout Description
827 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
828 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
829 \begin_inset Newline newline
832 <LEN>: length for custom spaces (hspace, hspace* for protected)
835 \begin_layout Description
836 Origin JSpitzm, 20 May 2003, Mar 17 2008
839 \begin_layout Subsection*
840 LFUN_HYPERLINK_INSERT
843 \begin_layout Description
844 Action Inserts hyperlinks into the document (clickable in pdf output).
848 \begin_layout Description
849 Notion Hyperlink target can be set via selection + hyperlink-insert function.
853 \begin_layout Description
854 Syntax href-insert [<TARGET>]
857 \begin_layout Description
858 Origin CFO-G, 21 Nov 1997
861 \begin_layout Subsection*
862 LFUN_SPECIALCHAR_INSERT
865 \begin_layout Description
866 Action Inserts various characters into the document.
870 \begin_layout Description
871 Syntax specialchar-insert <CHAR>
874 \begin_layout Description
875 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
876 tence, menu-separator.
880 \begin_layout Description
881 Origin JSpitzm, 6 Dec 2007
884 \begin_layout Subsection*
888 \begin_layout Description
889 Action Inserts table of contents.
893 \begin_layout Description
897 \begin_layout Description
898 Origin Lgb, 27 May 97
901 \begin_layout Subsection*
905 \begin_layout Description
906 Action Start (or remove) Appendix on the given cursor position.
910 \begin_layout Description
914 \begin_layout Description
915 Origin ettrich, 5 May 1998
918 \begin_layout Subsection*
922 \begin_layout Description
923 Action Inserts Index entry.
927 \begin_layout Description
928 Notion It automatically takes the word on the cursor position.
932 \begin_layout Description
936 \begin_layout Description
937 Origin leeming, 3 Aug 2000
940 \begin_layout Subsection*
944 \begin_layout Description
945 Action Inserts list of Index entries on a new page.
949 \begin_layout Description
953 \begin_layout Description
954 Origin Lgb, 27 Feb 1997
957 \begin_layout Subsection*
961 \begin_layout Description
962 Action Inserts Nomenclature entry.
966 \begin_layout Description
967 Notion It automatically takes the word on the cursor position if no symbol
972 \begin_layout Description
973 Syntax nomencl-insert [<SYMBOL>]
976 \begin_layout Description
977 Origin Ugras, 4 Nov 2006
980 \begin_layout Subsection*
981 LFUN_NOMENCLATURE_PRINT
984 \begin_layout Description
985 Action Inserts list of Nomenclature entries.
989 \begin_layout Description
990 Syntax nomenclature-print
993 \begin_layout Description
994 Origin Ugras, 4 Nov 2006
997 \begin_layout Subsection*
1001 \begin_layout Description
1002 Action Inserts Note on the current cursor postion, move selection inside
1007 \begin_layout Description
1008 Syntax note-insert [<TYPE>]
1011 \begin_layout Description
1012 Params <TYPE>: <Note|Greyedout|Comment> default: Note
1015 \begin_layout Subsection*
1019 \begin_layout Description
1020 Action Moves the cursor to the begining of next Note inset.
1024 \begin_layout Description
1028 \begin_layout Subsection*
1032 \begin_layout Description
1033 Action Changes all Note insets of a particular type (source) to a different
1034 type (target) fot the current document.
1038 \begin_layout Description
1039 Syntax notes-mutate <SOURCE> <TARGET>
1042 \begin_layout Description
1043 Params <SOURCE/TARGET>: Note|Comment|Greyedout
1046 \begin_layout Description
1047 Origin sanda, 18 Jun 2008
1050 \begin_layout Subsection*
1054 \begin_layout Description
1055 Action Inserts phantom on the current cursor postion, move selection inside
1060 \begin_layout Description
1061 Syntax phantom-insert [<TYPE>]
1064 \begin_layout Description
1065 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
1068 \begin_layout Description
1069 Origin uwestoehr, 30 Jan 2009
1072 \begin_layout Subsection*
1076 \begin_layout Description
1077 Action Inserts a line break or new line.
1081 \begin_layout Description
1082 Syntax newline-insert [<ARG>]
1085 \begin_layout Description
1086 Params <ARG>: <newline|linebreak> default: newline
1089 \begin_layout Description
1090 Origin JSpitzm, 25 Mar 2008
1093 \begin_layout Subsection*
1097 \begin_layout Description
1098 Action Clears the selection.
1099 If no text is selected call LFUN_FINISHED_FORWARD.
1103 \begin_layout Description
1107 \begin_layout Description
1108 Origin Lgb, 17 May 2001
1111 \begin_layout Subsection*
1115 \begin_layout Description
1116 Action Moves the cursor one line in downward direction.
1120 \begin_layout Description
1124 \begin_layout Subsection*
1128 \begin_layout Description
1129 Action Moves the cursor one line in upward direction.
1133 \begin_layout Description
1137 \begin_layout Subsection*
1141 \begin_layout Description
1142 Action Moves the cursor one line in downward direction adding the current
1143 position to the selection.
1147 \begin_layout Description
1151 \begin_layout Subsection*
1155 \begin_layout Description
1156 Action Moves the cursor one line in upward direction adding the current
1157 position to the selection.
1161 \begin_layout Description
1165 \begin_layout Subsection*
1169 \begin_layout Description
1170 Action Moves the cursor one page in downward direction.
1174 \begin_layout Description
1178 \begin_layout Subsection*
1182 \begin_layout Description
1183 Action Moves the cursor one page in upward direction.
1187 \begin_layout Description
1191 \begin_layout Subsection*
1192 LFUN_SCREEN_DOWN_SELECT
1195 \begin_layout Description
1196 Action Moves the cursor one screen in downward direction adding the current
1197 position to the selection.
1201 \begin_layout Description
1202 Syntax screen-down-select
1205 \begin_layout Subsection*
1206 LFUN_SCREEN_UP_SELECT
1209 \begin_layout Description
1210 Action Moves the cursor one page in upward direction adding the current
1211 position to the selection.
1215 \begin_layout Description
1216 Syntax screen-up-select
1219 \begin_layout Subsection*
1223 \begin_layout Description
1224 Action Scroll the buffer view.
1228 \begin_layout Description
1229 Notion Only scrolls the screen up or down; does not move the cursor.
1233 \begin_layout Description
1234 Syntax scroll <TYPE> <QUANTITY>
1237 \begin_layout Description
1238 Params <TYPE>: line|page
1239 \begin_inset Newline newline
1242 <QUANTITY>: up|down|<number>
1245 \begin_layout Description
1246 Origin Abdel, Dec 27 2007
1249 \begin_layout Subsection*
1250 LFUN_SCREEN_RECENTER
1253 \begin_layout Description
1254 Action Recenters the screen on the current cursor position.
1258 \begin_layout Description
1259 Syntax screen-recenter
1262 \begin_layout Subsection*
1266 \begin_layout Description
1267 Action Moves the cursor one position logically backwards.
1271 \begin_layout Description
1272 Notion This is not the action which should be bound to the arrow keys, because
1273 backwards may be left or right, depending on the language.
1274 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1275 which in turn may employ this one.
1279 \begin_layout Description
1280 Syntax char-backward
1283 \begin_layout Subsection*
1284 LFUN_CHAR_BACKWARD_SELECT
1287 \begin_layout Description
1288 Action Moves the cursor one position logically backwards, adding traversed
1289 position to the selection.
1293 \begin_layout Description
1294 Notion See also LFUN_CHAR_BACKWARD.
1298 \begin_layout Description
1299 Syntax char-backward-select
1302 \begin_layout Subsection*
1303 LFUN_CHAR_DELETE_BACKWARD
1306 \begin_layout Description
1307 Action Deletes one character in the backward direction (usually the "BackSpace"
1312 \begin_layout Description
1313 Syntax char-delete-backward
1316 \begin_layout Subsection*
1317 LFUN_CHAR_DELETE_FORWARD
1320 \begin_layout Description
1321 Action Deletes one character in the backward direction (usually the "Delete"
1326 \begin_layout Description
1327 Syntax char-delete-forward
1330 \begin_layout Subsection*
1334 \begin_layout Description
1335 Action Moves the cursor one position logically forward.
1339 \begin_layout Description
1340 Notion This is not the action which should be bound to the arrow keys, because
1341 forward may be left or right, depending on the language.
1342 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1343 which in turn may employ this one.
1347 \begin_layout Description
1351 \begin_layout Subsection*
1352 LFUN_CHAR_FORWARD_SELECT
1355 \begin_layout Description
1356 Action Moves the cursor one position logically forward, adding traversed
1357 position to the selection.
1361 \begin_layout Description
1362 Notion See also LFUN_CHAR_FORWARD.
1366 \begin_layout Description
1367 Syntax char-forward-select
1370 \begin_layout Subsection*
1374 \begin_layout Description
1375 Action Moves the cursor one position "to the left".
1379 \begin_layout Description
1380 Notion This is the action which should be taken when the "left" key is pressed.
1381 Generally, it moves the cursor one position to the left.
1382 However, in Bidi text this become slightly more complicated, and there
1383 are different modes of cursor movement.
1384 In "visual mode", this moves left, plain and simple.
1385 In "logical mode", movement is logically forward in RTL paragraphs, and
1386 logically backwards in LTR paragraphs.
1390 \begin_layout Description
1394 \begin_layout Subsection*
1395 LFUN_CHAR_LEFT_SELECT
1398 \begin_layout Description
1399 Action Moves the cursor one position "to the left", adding traversed position
1404 \begin_layout Description
1405 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1409 \begin_layout Description
1410 Syntax char-left-select
1413 \begin_layout Subsection*
1417 \begin_layout Description
1418 Action Moves the cursor one position "to the right".
1422 \begin_layout Description
1423 Notion This is the action which should be taken when the "right" key is
1425 Generally, it moves the cursor one position to the right.
1426 However, in Bidi text this become slightly more complicated, and there
1427 are different modes of cursor movement.
1428 In "visual mode", this moves right, plain and simple.
1429 In "logical mode", movement is logically forward in LTR paragraphs, and
1430 logically backwards in RTL paragraphs.
1434 \begin_layout Description
1438 \begin_layout Subsection*
1439 LFUN_CHAR_RIGHT_SELECT
1442 \begin_layout Description
1443 Action Moves the cursor one position "to the right", adding traversed position
1448 \begin_layout Description
1449 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1453 \begin_layout Description
1454 Syntax char-right-select
1457 \begin_layout Subsection*
1461 \begin_layout Description
1462 Action Moves the cursor to the logically previous beginning of a word.
1466 \begin_layout Description
1467 Notion This is not the action which should be bound to the arrow keys, because
1468 backwards may be left or right, depending on the language.
1469 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1470 which in turn may employ this one.
1474 \begin_layout Description
1475 Syntax word-backward
1478 \begin_layout Subsection*
1479 LFUN_WORD_BACKWARD_SELECT
1482 \begin_layout Description
1483 Action Moves the cursor to the logically previous beginning of a word, adding
1484 the logically traversed text to the selection.
1488 \begin_layout Description
1489 Notion See also LFUN_WORD_BACKWARD.
1493 \begin_layout Description
1494 Syntax word-backward-select
1497 \begin_layout Subsection*
1498 LFUN_WORD_DELETE_BACKWARD
1501 \begin_layout Description
1502 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1507 \begin_layout Description
1508 Syntax word-delete-backward
1511 \begin_layout Subsection*
1512 LFUN_WORD_DELETE_FORWARD
1515 \begin_layout Description
1516 Action Deletes characters to the end of the word (usually the "C+Delete"
1521 \begin_layout Description
1522 Syntax word-delete-forward
1525 \begin_layout Subsection*
1526 LFUN_WORD_FIND_FORWARD
1529 \begin_layout Description
1530 Action Search for a given string in forward direction.
1534 \begin_layout Description
1535 Notion Case sensitive, match words.
1536 If no argument given, last search repeated.
1540 \begin_layout Description
1541 Syntax word-find-forward [<STRING>]
1544 \begin_layout Description
1545 Origin Etienne, 16 Feb 1998
1548 \begin_layout Subsection*
1549 LFUN_WORD_FIND_BACKWARD
1552 \begin_layout Description
1553 Action Search for a given string in backward direction.
1557 \begin_layout Description
1558 Notion Case sensitive, match words.
1559 If no argument given, last search repeated.
1563 \begin_layout Description
1564 Syntax word-find-backward [<STRING>]
1567 \begin_layout Description
1568 Origin Etienne, 20 Feb 1998
1571 \begin_layout Subsection*
1575 \begin_layout Description
1576 Action Search for next occurence of a string.
1580 \begin_layout Description
1581 Syntax word-find [<DATA>]
1584 \begin_layout Description
1585 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1586 If no parameter is given, search with last find-dialog data is used for
1592 \begin_layout Description
1593 Origin Andre, Jan 7 2004
1596 \begin_layout Subsection*
1600 \begin_layout Description
1601 Action Replace a string in the document.
1605 \begin_layout Description
1606 Syntax word-replace [<DATA>]
1609 \begin_layout Description
1610 Params <DATA>: data is of the form "<search>
1611 \begin_inset Newline newline
1615 \begin_inset Newline newline
1618 <casesensitive> <matchword> <all> <forward>"
1621 \begin_layout Description
1622 Origin Andre, Jan 7 2004
1625 \begin_layout Subsection*
1629 \begin_layout Description
1630 Action Search for next occurence of a pattern.
1634 \begin_layout Description
1635 Syntax word-findadv [<DATA>]
1638 \begin_layout Description
1639 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1640 If no parameter is given, search with last find-dialog data is used for
1646 \begin_layout Description
1647 Origin Tommaso, Nov 15 2007
1650 \begin_layout Description
1651 Action Moves the cursor to the logically next beginning of a word.
1655 \begin_layout Description
1656 Notion This is not the action which should be bound to the arrow keys, because
1657 forward may be left or right, depending on the language.
1658 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1659 which in turn may employ this one.
1663 \begin_layout Description
1667 \begin_layout Subsection*
1668 LFUN_WORD_FORWARD_SELECT
1671 \begin_layout Description
1672 Action Moves the cursor to the logically next beginning of a word, adding
1673 the logically traversed text to the selection.
1677 \begin_layout Description
1678 Notion See also LFUN_WORD_FORWARD.
1682 \begin_layout Description
1683 Syntax word-forward-select
1686 \begin_layout Subsection*
1690 \begin_layout Description
1691 Action Moves the cursor to the next beginning of a word "on the left".
1695 \begin_layout Description
1696 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1698 Generally, it moves the cursor to the next beginning of a word on the left.
1699 However, in Bidi text this become slightly more complicated, and there
1700 are different modes of cursor movement.
1701 In "visual mode", this moves left, plain and simple.
1702 In "logical mode", movement is logically forward in RTL paragraphs, and
1703 logically backwards in LTR paragraphs.
1707 \begin_layout Description
1711 \begin_layout Description
1712 Origin dov, 28 Oct 2007
1715 \begin_layout Subsection*
1716 LFUN_WORD_LEFT_SELECT
1719 \begin_layout Description
1720 Action Moves the cursor to the next beginning of a word "on the left", adding
1721 *logically* traversed text to the selection.
1725 \begin_layout Description
1726 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1730 \begin_layout Description
1731 Syntax word-left-select
1734 \begin_layout Description
1735 Origin dov, 28 Oct 2007
1738 \begin_layout Subsection*
1742 \begin_layout Description
1743 Action Moves the cursor to the next beginning of a word "on the right".
1747 \begin_layout Description
1748 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1750 Generally, it moves the cursor to the next beginning of a word on the right.
1751 However, in Bidi text this become slightly more complicated, and there
1752 are different modes of cursor movement.
1753 In "visual mode", this moves right, plain and simple.
1754 In "logical mode", movement is logically forward in LTR paragraphs, and
1755 logically backwards in RTL paragraphs.
1759 \begin_layout Description
1763 \begin_layout Description
1764 Origin dov, 28 Oct 2007
1767 \begin_layout Subsection*
1768 LFUN_WORD_RIGHT_SELECT
1771 \begin_layout Description
1772 Action Moves the cursor to the next beginning of a word "on the right",
1773 adding *logically* traversed text to the selection.
1777 \begin_layout Description
1778 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1782 \begin_layout Description
1783 Syntax word-right-select
1786 \begin_layout Description
1787 Origin dov, 28 Oct 2007
1790 \begin_layout Subsection*
1794 \begin_layout Description
1795 Action Puts the word where the cursor stands into the selection.
1799 \begin_layout Description
1803 \begin_layout Description
1804 Origin Andre, 11 Sep 2002
1807 \begin_layout Subsection*
1808 LFUN_WORD_CAPITALIZE
1811 \begin_layout Description
1812 Action Capitalizes the words in the selection (i.e.
1813 the first letters) or the letter on the cursor position.
1817 \begin_layout Description
1818 Syntax word-capitalize
1821 \begin_layout Subsection*
1825 \begin_layout Description
1826 Action Change the words in the selection or from the cursor position to
1827 the end of word to the upper case.
1831 \begin_layout Description
1835 \begin_layout Subsection*
1839 \begin_layout Description
1840 Action Change the words in the selection or from the cursor position to
1841 the end of word to the lower case.
1845 \begin_layout Description
1849 \begin_layout Subsection*
1850 LFUN_THESAURUS_ENTRY
1853 \begin_layout Description
1854 Action Look up thesaurus entries with respect to the word under the cursor.
1858 \begin_layout Description
1859 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1862 \begin_layout Description
1863 Params <STRING>: word to look up <LANG>: language (see file languages)
1867 \begin_layout Description
1868 Origin Levon, 20 Jul 2001
1871 \begin_layout Subsection*
1875 \begin_layout Description
1876 Action Move the cursor to the beginning of the document.
1880 \begin_layout Description
1884 \begin_layout Subsection*
1885 LFUN_BUFFER_BEGIN_SELECT
1888 \begin_layout Description
1889 Action Move the cursor to the beginning of the document adding the traversed
1890 text to the selection.
1894 \begin_layout Description
1895 Syntax buffer-begin-select
1898 \begin_layout Subsection*
1902 \begin_layout Description
1903 Action Move the cursor to the end of the document.
1907 \begin_layout Description
1911 \begin_layout Subsection*
1912 LFUN_BUFFER_END_SELECT
1915 \begin_layout Description
1916 Action Move the cursor to the end of the document adding the traversed text
1921 \begin_layout Description
1922 Syntax buffer-end-select
1925 \begin_layout Subsection*
1929 \begin_layout Description
1930 Action Move the cursor to the begining of the (screen) line.
1934 \begin_layout Description
1938 \begin_layout Subsection*
1939 LFUN_LINE_BEGIN_SELECT
1942 \begin_layout Description
1943 Action Move the cursor to the beginning of the (screen) line adding the
1944 traversed text to the selection.
1948 \begin_layout Description
1949 Syntax line-begin-select
1952 \begin_layout Subsection*
1956 \begin_layout Description
1957 Action Move the cursor to the end of the (screen) line.
1961 \begin_layout Description
1965 \begin_layout Subsection*
1966 LFUN_LINE_END_SELECT
1969 \begin_layout Description
1970 Action Move the cursor to the end of the (screen) line adding the traversed
1971 text to the selection.
1975 \begin_layout Description
1976 Syntax line-end-select
1979 \begin_layout Subsection*
1983 \begin_layout Description
1984 Action Deletes the letters to the end of the (screen) line or deletes the
1989 \begin_layout Description
1990 Syntax line-delete-forward
1993 \begin_layout Subsection*
1997 \begin_layout Description
1998 Action Copies to the clipboard the last edit.
2002 \begin_layout Description
2006 \begin_layout Subsection*
2010 \begin_layout Description
2011 Action Cuts to the clipboard.
2015 \begin_layout Description
2019 \begin_layout Subsection*
2023 \begin_layout Description
2024 Action Pastes material from the active clipboard.
2028 \begin_layout Description
2029 Syntax paste [<TYPE>]
2032 \begin_layout Description
2033 Params <TYPE>: pdf|png|jpeg|linkback
2036 \begin_layout Subsection*
2037 LFUN_CLIPBOARD_PASTE
2040 \begin_layout Description
2041 Action Pastes text from the active clipboard.
2045 \begin_layout Description
2046 Syntax clipboard-paste [<ARG>]
2049 \begin_layout Description
2050 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2055 \begin_layout Description
2056 Origin baum, 10 Jul 2006
2059 \begin_layout Subsection*
2060 LFUN_PRIMARY_SELECTION_PASTE
2063 \begin_layout Description
2064 Action Pastes the currently text selected text.
2068 \begin_layout Description
2069 Notion Primary selection mechanism is linux-only thing.
2073 \begin_layout Description
2074 Syntax primary-selection-paste [<ARG>]
2077 \begin_layout Description
2078 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2083 \begin_layout Subsection*
2084 LFUN_SELECTION_PASTE
2087 \begin_layout Description
2088 Action Pastes the text in permanent selection.
2092 \begin_layout Description
2093 Syntax selection-paste
2096 \begin_layout Subsection*
2100 \begin_layout Description
2101 Action Undoes the last edit.
2105 \begin_layout Description
2109 \begin_layout Subsection*
2113 \begin_layout Description
2114 Action Redoes the last thing undone.
2118 \begin_layout Description
2122 \begin_layout Subsection*
2126 \begin_layout Description
2127 Action Repeat the given command.
2131 \begin_layout Description
2132 Syntax repeat <COUNT> <LFUN-COMMAND>
2135 \begin_layout Description
2136 Origin Andre, , 27 Oct 2003
2139 \begin_layout Subsection*
2140 LFUN_CHARS_TRANSPOSE
2143 \begin_layout Description
2144 Action Transposes the character at the cursor with the one before it.
2148 \begin_layout Description
2149 Syntax chars-transpose
2152 \begin_layout Description
2153 Origin Lgb, 25 Apr 2001
2156 \begin_layout Subsection*
2157 LFUN_DEPTH_DECREMENT
2160 \begin_layout Description
2161 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2166 \begin_layout Description
2167 Syntax depth-decrement
2170 \begin_layout Subsection*
2171 LFUN_DEPTH_INCREMENT
2174 \begin_layout Description
2175 Action Increase the nesting depth of the (selected) paragraph(s) inside
2180 \begin_layout Description
2181 Syntax depth-increment
2184 \begin_layout Subsection*
2188 \begin_layout Description
2189 Action Toggles the bold font (selection-wise) using mathbf in math.
2193 \begin_layout Description
2197 \begin_layout Subsection*
2198 LFUN_FONT_BOLDSYMBOL
2201 \begin_layout Description
2202 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2206 \begin_layout Description
2207 Syntax font-boldsymbol
2210 \begin_layout Subsection*
2211 LFUN_FONT_TYPEWRITER
2214 \begin_layout Description
2215 Action Toggles the typewriter family font (selection-wise).
2219 \begin_layout Description
2220 Syntax font-typewriter
2223 \begin_layout Subsection*
2227 \begin_layout Description
2228 Action Toggles underline in the font (selection-wise).
2232 \begin_layout Description
2233 Syntax font-underline
2236 \begin_layout Subsection*
2240 \begin_layout Description
2241 Action Toggles the emphasis font style (selection-wise).
2245 \begin_layout Description
2249 \begin_layout Subsection*
2253 \begin_layout Description
2254 Action Toggles Noun text style font (selection-wise).
2258 \begin_layout Description
2262 \begin_layout Subsection*
2266 \begin_layout Description
2267 Action Toggles Roman family font (selection-wise).
2271 \begin_layout Description
2275 \begin_layout Subsection*
2279 \begin_layout Description
2280 Action Toggles Sans Serif family font (selection-wise).
2284 \begin_layout Description
2288 \begin_layout Subsection*
2292 \begin_layout Description
2293 Action Toggles Fraktur family font (math-mode, selection-wise).
2297 \begin_layout Description
2301 \begin_layout Description
2302 Origin vermeer, 10 Jan 2002
2305 \begin_layout Subsection*
2309 \begin_layout Description
2310 Action Toggles Italics font shape (math-mode, selection-wise).
2314 \begin_layout Description
2318 \begin_layout Description
2319 Origin vermeer, 10 Jan 2002
2322 \begin_layout Subsection*
2326 \begin_layout Description
2327 Action Reverts the settings of the font to the default values (selection-wise).
2331 \begin_layout Description
2335 \begin_layout Subsection*
2339 \begin_layout Description
2340 Action Sets font size according to lyx format string.
2344 \begin_layout Description
2345 Syntax font-size <SIZE>
2348 \begin_layout Description
2349 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2350 \begin_inset Newline newline
2353 largest|huge|giant|increase|decrease|default
2356 \begin_layout Subsection*
2357 LFUN_TEXTSTYLE_APPLY
2360 \begin_layout Description
2361 Action Toggle user-defined (=last-time used) text style.
2365 \begin_layout Description
2366 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2367 trigerred when using Text Style dialog.
2371 \begin_layout Description
2372 Syntax textstyle-apply
2375 \begin_layout Description
2376 Origin leeming, 12 Mar 2003
2379 \begin_layout Subsection*
2380 LFUN_TEXTSTYLE_UPDATE
2383 \begin_layout Description
2384 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2389 \begin_layout Description
2390 Syntax textstyle-update <FONT_INFO>
2393 \begin_layout Description
2394 Params <FONT_INFO>: specifies font atributes, e.g.
2395 family, series, shape, size, emph, noun, underbar, number, color, language,
2398 \begin_inset Newline newline
2401 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2405 \begin_layout Description
2406 Origin leeming, 12 Mar 2003
2409 \begin_layout Subsection*
2410 LFUN_SCREEN_FONT_UPDATE
2413 \begin_layout Description
2414 Action Update fonts and its metrics.
2418 \begin_layout Description
2419 Notion Automatically called after zoom, dpi, font names, or norm change.
2423 \begin_layout Description
2424 Syntax screen-font-update
2427 \begin_layout Description
2428 Origin ARRae, 13 Aug 2000
2431 \begin_layout Subsection*
2435 \begin_layout Description
2436 Action Returns the info about the current font.
2440 \begin_layout Description
2444 \begin_layout Subsection*
2445 LFUN_CITATION_INSERT
2448 \begin_layout Description
2449 Action Inserts citation from loaded citation database.
2453 \begin_layout Description
2454 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2457 \begin_layout Description
2458 Params <KEY>: Citation (shortcut listed in available citations).
2460 \begin_inset Newline newline
2463 <TEXT_BEFORE>: text which should appear before citation.
2467 \begin_layout Description
2468 Origin AAS, 97-02-23
2471 \begin_layout Subsection*
2472 LFUN_BIBTEX_DATABASE_ADD
2475 \begin_layout Description
2476 Action Adds database, which will be used for bibtex citations.
2480 \begin_layout Description
2481 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2482 bibliography) found from the cursor postion.
2486 \begin_layout Description
2487 Syntax bibtex-database-add <DATABASE-NAME>
2490 \begin_layout Description
2491 Origin Ale, 30 May 1997
2494 \begin_layout Subsection*
2495 LFUN_BIBTEX_DATABASE_DEL
2498 \begin_layout Description
2499 Action Adds database, which will be used for bibtex citations.
2503 \begin_layout Description
2504 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2505 X bibliography) found from the cursor postion.
2509 \begin_layout Description
2510 Syntax bibtex-database-del <DATABASE-NAME>
2513 \begin_layout Description
2514 Origin Ale, 30 May 1997
2517 \begin_layout Subsection*
2521 \begin_layout Description
2522 Action Sets the layout (that is, environment) for the current paragraph.
2526 \begin_layout Description
2527 Syntax layout <LAYOUT>
2530 \begin_layout Description
2531 Params <LAYOUT>: the layout to use
2534 \begin_layout Subsection*
2535 LFUN_LAYOUT_PARAGRAPH
2538 \begin_layout Description
2539 Action Launches the paragraph settings dialog.
2543 \begin_layout Description
2544 Syntax layout-paragraph
2547 \begin_layout Subsection*
2551 \begin_layout Description
2552 Action Launches the tabular settings dialog.
2556 \begin_layout Description
2557 Syntax layout-tabular
2560 \begin_layout Description
2561 Origin Jug, 31 Jul 2000
2564 \begin_layout Subsection*
2565 LFUN_DROP_LAYOUTS_CHOICE
2568 \begin_layout Description
2569 Action Displays list of layout choices.
2573 \begin_layout Description
2574 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2575 allowing for choice of layout.
2579 \begin_layout Description
2580 Syntax drop-layouts-choice
2583 \begin_layout Subsection*
2584 LFUN_LAYOUT_MODULES_CLEAR
2587 \begin_layout Description
2588 Action Clears the module list.
2592 \begin_layout Description
2593 Notion Clears the list of included modules for the current buffer.
2597 \begin_layout Description
2598 Syntax layout-modules-clear
2601 \begin_layout Description
2602 Origin rgh, 25 August 2007
2605 \begin_layout Subsection*
2606 LFUN_LAYOUT_MODULE_ADD
2609 \begin_layout Description
2610 Action Adds a module.
2614 \begin_layout Description
2615 Notion Adds a module to the list of included modules for the current buffer.
2619 \begin_layout Description
2620 Syntax layout-module-add <MODULE>
2623 \begin_layout Description
2624 Params <MODULE>: the module to be added
2627 \begin_layout Description
2628 Origin rgh, 25 August 2007
2631 \begin_layout Subsection*
2635 \begin_layout Description
2636 Action Reloads layout information.
2640 \begin_layout Description
2641 Notion Reloads all layout information for the current buffer from disk,
2642 thus recognizing any changes that have been made to layout files on the
2644 This is intended to be used only by layout developers and should not be
2645 used when one is trying to do actual work.
2649 \begin_layout Description
2650 Syntax layout-reload
2653 \begin_layout Description
2654 Origin rgh, 3 September 2007
2657 \begin_layout Subsection*
2658 LFUN_TEXTCLASS_APPLY
2661 \begin_layout Description
2662 Action Sets the text class for the current buffer.
2666 \begin_layout Description
2667 Syntax textclass-apply <TEXTCLASS>
2670 \begin_layout Description
2671 Params <TEXTCLASS>: the textclass to set.
2672 Note that this must be the filename, minus the ".layout" extension.
2676 \begin_layout Subsection*
2680 \begin_layout Description
2681 Action Loads information for a textclass from disk.
2685 \begin_layout Description
2686 Syntax textclass-load <TEXTCLASS>
2689 \begin_layout Description
2690 Params <TEXTCLASS>: the textclass to load.
2691 Note that this must be the filename, minus the ".layout" extension.
2695 \begin_layout Subsection*
2699 \begin_layout Description
2700 Action Disable selecting of text-region.
2704 \begin_layout Description
2708 \begin_layout Subsection*
2712 \begin_layout Description
2713 Action Enable selecting of text-region.
2717 \begin_layout Description
2718 Notion After enabling you can simply move arrow keys to get selected region.
2722 \begin_layout Description
2726 \begin_layout Subsection*
2730 \begin_layout Description
2731 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2735 \begin_layout Description
2739 \begin_layout Description
2740 Origin Andre, May 5 2006
2743 \begin_layout Subsection*
2747 \begin_layout Description
2748 Action Inserts math delimiters (e.g.
2749 parentheses, brackets) enclosing expression.
2753 \begin_layout Description
2754 Syntax math-delim [<LEFT>] [<RIGHT>]
2757 \begin_layout Description
2758 Params <LEFT/RIGHT>: Delimiters to be used.
2759 Each delimiter can be specified by either a LaTeX name or a valid character.
2760 ( is the default letter.
2764 \begin_layout Description
2765 Sample math-delim { rangle
2768 \begin_layout Description
2769 Origin Alejandro, 18 Jun 1996
2772 \begin_layout Subsection*
2776 \begin_layout Description
2777 Action Inserts math fixed size delimiters (e.g.
2778 parentheses, brackets) enclosing expression.
2782 \begin_layout Description
2783 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2786 \begin_layout Description
2787 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2788 \begin_inset Newline newline
2791 <L/RDELIM>: TeX code for delimiter.
2792 See Delimiter dialog for delimiters to be used.
2796 \begin_layout Description
2797 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2800 \begin_layout Description
2801 Origin Enrico & Georg, 7 May 2006
2804 \begin_layout Subsection*
2808 \begin_layout Description
2809 Action Creates a new displayed equation in text mode.
2810 Toggles inlined/display formula in math mode.
2814 \begin_layout Description
2815 Syntax math-display [<ARG>]
2818 \begin_layout Description
2819 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2820 new equation from the text mode.
2824 \begin_layout Description
2825 Origin Alejandro, 18 Jun 1996
2828 \begin_layout Subsection*
2832 \begin_layout Description
2833 Action Inserts math objects and symbols.
2837 \begin_layout Description
2838 Syntax math-insert <ARG>
2841 \begin_layout Description
2842 Params <ARG>: Symbol or LaTeX code to be inserted.
2846 \begin_layout Subsection*
2850 \begin_layout Description
2851 Action Enters subscript expression in math expression.
2855 \begin_layout Description
2856 Syntax math-subscript
2859 \begin_layout Description
2860 Origin vermeer, 12 Dec 2001
2863 \begin_layout Subsection*
2864 LFUN_MATH_SUPERSCRIPT
2867 \begin_layout Description
2868 Action Enters subscript expression in math expression.
2872 \begin_layout Description
2873 Syntax math-superscript
2876 \begin_layout Description
2877 Origin vermeer, 12 Dec 2001
2880 \begin_layout Subsection*
2884 \begin_layout Description
2885 Action Toggles the position of the limits from above/below to the right
2886 side an vice versa in integral symbol, a limit, a summation, etc.
2890 \begin_layout Description
2891 Notion Put the cursor before the symbol with the limits and then invoke
2896 \begin_layout Description
2897 Syntax math-limits [<STATE>]
2900 \begin_layout Description
2901 Params <STATE>: limits|nolimits
2904 \begin_layout Subsection*
2908 \begin_layout Description
2909 Action Inserts a math macro definition at the cursor position in the text.
2913 \begin_layout Description
2914 Syntax math-macro <NAME> [<NARGS>] [def]
2917 \begin_layout Description
2918 Params <NAME>: The name of the macro, e.g.
2920 <NARGS>: The number of parameters of the macro.
2922 "def": Has no effect anymore, just for compatibility with former LyX versions.
2926 \begin_layout Description
2927 Origin ale, 10 May 1997; sts, 21 Dec 2007
2930 \begin_layout Subsection*
2934 \begin_layout Description
2935 Action Mutates the type of math inset to the newly selected one.
2939 \begin_layout Description
2940 Syntax math-mutate <TYPE>
2943 \begin_layout Description
2944 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2945 multline|gather|flalign
2948 \begin_layout Description
2949 Origin Andre, 23 May 2001
2952 \begin_layout Subsection*
2956 \begin_layout Description
2957 Action Inserts space into math expression.
2961 \begin_layout Description
2962 Notion Use spacebar after entering this space to change type of space.
2966 \begin_layout Description
2967 Syntax math-space [<TYPE>] [<LEN>]
2970 \begin_layout Description
2971 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2973 \begin_inset Newline newline
2976 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2978 \begin_inset Newline newline
2981 custom space: hspace
2982 \begin_inset Newline newline
2985 "," used by default.
2986 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
2988 <LEN>: length for custom spaces (hspace)
2991 \begin_layout Description
2992 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2995 \begin_layout Subsection*
2999 \begin_layout Description
3000 Action Inserts a matrix.
3004 \begin_layout Description
3005 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3008 \begin_layout Description
3009 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3011 1 char) and the horizontal alignments (l, c or r) (i.e.
3016 \begin_layout Description
3017 Sample math-matrix 3 3 bccc
3020 \begin_layout Subsection*
3024 \begin_layout Description
3025 Action In text mode enters math mode (i.e.
3026 puts math insets on the current cursor position), in math mode enters text
3027 mode inside math expression.
3031 \begin_layout Description
3032 Notion If there is some selected text, it puts the text inside created math
3037 \begin_layout Description
3038 Syntax math-mode [<ARG>]
3041 \begin_layout Description
3042 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3047 \begin_layout Description
3048 Origin Alejandro, 4 Jun 1996
3051 \begin_layout Subsection*
3055 \begin_layout Description
3056 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3058 Used by the advanced search dialog.
3062 \begin_layout Description
3063 Notion If there is any selected text, then it is moved inside the created
3068 \begin_layout Description
3069 Syntax regexp-mode [<ARG>]
3072 \begin_layout Description
3073 Params <ARG>: eventual argument (regular expression).
3077 \begin_layout Description
3078 Origin Tommaso, 4 Oct 2008
3081 \begin_layout Subsection*
3082 LFUN_MATH_NUMBER_LINE_TOGGLE
3085 \begin_layout Description
3086 Action Toggles numbering of the current formula line.
3090 \begin_layout Description
3091 Notion Must be in display formula mode.
3095 \begin_layout Description
3096 Syntax math-number-line-toggle
3099 \begin_layout Description
3100 Origin Alejandro, 18 Jun 1996
3103 \begin_layout Subsection*
3104 LFUN_MATH_NUMBER_TOGGLE
3107 \begin_layout Description
3108 Action Toggles numbering/labeling of the current formula.
3112 \begin_layout Description
3113 Notion Must be in display formula mode.
3117 \begin_layout Description
3118 Syntax math-number-toggle
3121 \begin_layout Description
3122 Origin Alejandro, 4 Jun 1996
3125 \begin_layout Subsection*
3129 \begin_layout Description
3130 Action Calls external program and passes the current expression/equation
3131 as an argument for the calculation in the format appropriate to the given
3136 \begin_layout Description
3137 Notion Selection can be used to determine the input for the external program.
3141 \begin_layout Description
3142 Syntax math-extern <LANG> [<COMMAND>]
3145 \begin_layout Description
3146 Params <LANG>: octave|maxima|maple|mathematica|script
3147 \begin_inset Newline newline
3150 where "script" stands fot the external script (normalized expression will
3154 \begin_layout Description
3155 Origin Andre, 24 Apr 2001
3158 \begin_layout Description
3159 Sample math-extern maple simplify
3162 \begin_layout Subsection*
3166 \begin_layout Description
3167 Action Changes arbitrarily the size used by math fonts inside a context.
3171 \begin_layout Description
3172 Notion Provides an interface to the LaTeX math mode font size commands.
3176 \begin_layout Description
3177 Syntax math-size <STYLE>
3180 \begin_layout Description
3181 Params <STYLE>: displaystyle|
3190 \begin_layout Description
3191 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3194 \begin_layout Subsection*
3195 LFUN_MATH_FONT_STYLE
3198 \begin_layout Description
3199 Action Changes the text style used in math.
3203 \begin_layout Description
3204 Syntax math-font-style <STYLE>
3207 \begin_layout Description
3208 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
3209 trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
3212 \begin_layout Description
3213 Origin vfr, 9 jan 2009
3216 \begin_layout Subsection*
3217 LFUN_MATH_MACRO_UNFOLD
3220 \begin_layout Description
3221 Action Unfold a Math Macro.
3225 \begin_layout Description
3226 Notion Unfold the Math Macro the cursor is in, i.e.
3231 \begin_layout Description
3232 Syntax math-macro-unfold
3235 \begin_layout Description
3236 Origin sts, 06 January 2008
3239 \begin_layout Subsection*
3240 LFUN_MATH_MACRO_FOLD
3243 \begin_layout Description
3244 Action Fold a Math Macro.
3248 \begin_layout Description
3249 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3250 displayed as foo before.
3254 \begin_layout Description
3255 Syntax math-macro-fold
3258 \begin_layout Description
3259 Origin sts, 06 January 2008
3262 \begin_layout Subsection*
3263 LFUN_MATH_MACRO_ADD_PARAM
3266 \begin_layout Description
3267 Action Add a parameter.
3271 \begin_layout Description
3272 Notion Add a parameter to a Math Macro.
3276 \begin_layout Description
3277 Params <NUM>: The number of the parameter behind which the new one will
3278 be added (1 for the first, i.e.
3279 use 0 for add a parameter at the left), defaults to the last one.
3283 \begin_layout Description
3284 Syntax math-macro-add-param <NUM>
3287 \begin_layout Description
3288 Origin sts, 06 January 2008
3291 \begin_layout Subsection*
3292 LFUN_MATH_MACRO_REMOVE_PARAM
3295 \begin_layout Description
3296 Action Remove the last parameter.
3300 \begin_layout Description
3301 Notion Remove the last parameter of a Math Macro and remove its value in
3302 all instances of the macro in the buffer.
3306 \begin_layout Description
3307 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3308 defaults to the last one.
3312 \begin_layout Description
3313 Syntax math-macro-remove-param <NUM>
3316 \begin_layout Description
3317 Origin sts, 06 January 2008
3320 \begin_layout Subsection*
3321 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3324 \begin_layout Description
3325 Action Append a greedy parameter.
3329 \begin_layout Description
3330 Notion Append a greedy parameter to a Math Macro which eats the following
3331 mathed cell in every instance of the macro in the buffer.
3335 \begin_layout Description
3336 Syntax math-macro-append-greedy-param
3339 \begin_layout Description
3340 Origin sts, 06 January 2008
3343 \begin_layout Subsection*
3344 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3347 \begin_layout Description
3348 Action Remove a greedy parameter.
3352 \begin_layout Description
3353 Notion Remove a greedy parameter of a Math Macro and spit out the values
3354 of it in every instance of the macro in the buffer.
3355 If it is an optional parameter the [valud] format is used.
3359 \begin_layout Description
3360 Syntax math-macro-remove-greedy-param
3363 \begin_layout Description
3364 Origin sts, 06 January 2008
3367 \begin_layout Subsection*
3368 LFUN_MATH_MACRO_MAKE_OPTIONAL
3371 \begin_layout Description
3372 Action Make a parameter optional.
3376 \begin_layout Description
3377 Notion Turn the first non-optional parameter of a Math Macro into an optional
3378 parameter with a default value.
3382 \begin_layout Description
3383 Syntax math-macro-make-optional
3386 \begin_layout Description
3387 Origin sts, 06 January 2008
3390 \begin_layout Subsection*
3391 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3394 \begin_layout Description
3395 Action Make a parameter non-optional.
3399 \begin_layout Description
3400 Notion Turn the last optional parameter of a Math Macro into a non-optional
3402 The default value is remembered to be reused later if the user changes
3407 \begin_layout Description
3408 Syntax math-macro-make-nonoptional
3411 \begin_layout Description
3412 Origin sts, 06 January 2008
3415 \begin_layout Subsection*
3416 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3419 \begin_layout Description
3420 Action Add an optional parameter.
3424 \begin_layout Description
3425 Notion Insert an optional parameter just behind the already existing optional
3430 \begin_layout Description
3431 Syntax math-macro-add-optional-param
3434 \begin_layout Description
3435 Origin sts, 06 January 2008
3438 \begin_layout Subsection*
3439 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3442 \begin_layout Description
3443 Action Remove the last optional parameter.
3447 \begin_layout Description
3448 Notion Remove the last optional parameter of a Math Macro and remove it
3449 in all the instances of the macro in the buffer.
3453 \begin_layout Description
3454 Syntax math-macro-remove-optional-param
3457 \begin_layout Description
3458 Origin sts, 06 January 2008
3461 \begin_layout Subsection*
3462 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3465 \begin_layout Description
3466 Action Add a greedy optional parameter.
3470 \begin_layout Description
3471 Notion Add a greedy optional parameter which eats the value from the following
3472 cells in mathed which are in the [value] format.
3476 \begin_layout Description
3477 Syntax math-macro-add-greedy-optional-param
3480 \begin_layout Description
3481 Origin sts, 06 January 2008
3484 \begin_layout Subsection*
3485 LFUN_IN_MATHMACROTEMPLATE
3488 \begin_layout Description
3489 Action Only active in Math Macro definition.
3493 \begin_layout Description
3494 Notion Dummy function which is only active in a Math Macro definition.
3495 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3500 \begin_layout Description
3501 Syntax in-mathmacrotemplate
3504 \begin_layout Description
3505 Origin sts, 06 January 2008
3508 \begin_layout Subsection*
3509 LFUN_PARAGRAPH_MOVE_DOWN
3512 \begin_layout Description
3513 Action Moves the current paragraph downwards in the document.
3517 \begin_layout Description
3518 Syntax paragraph-move-down
3521 \begin_layout Description
3522 Origin Edwin, 8 Apr 2006
3525 \begin_layout Subsection*
3526 LFUN_PARAGRAPH_MOVE_UP
3529 \begin_layout Description
3530 Action Moves the current paragraph upwards in the document.
3534 \begin_layout Description
3535 Syntax paragraph-move-up
3538 \begin_layout Description
3539 Origin Edwin, 8 Apr 2006
3542 \begin_layout Subsection*
3546 \begin_layout Description
3547 Action Move the cursor to the next paragraph (or begining of the current
3548 one) in upward direction.
3552 \begin_layout Description
3556 \begin_layout Description
3557 Origin Asger, 1 Oct 1996
3560 \begin_layout Subsection*
3561 LFUN_PARAGRAPH_UP_SELECT
3564 \begin_layout Description
3565 Action Move the cursor and select the text to the next paragraph (or begining
3566 of the current one) in upward direction.
3570 \begin_layout Description
3571 Syntax paragraph-up-select
3574 \begin_layout Description
3575 Origin Asger, 1 Oct 1996
3578 \begin_layout Subsection*
3582 \begin_layout Description
3583 Action Move the cursor to the next paragraph (or begining of the current
3584 one) in downward direction.
3588 \begin_layout Description
3589 Syntax paragraph-down
3592 \begin_layout Description
3593 Origin Asger, 1 Oct 1996
3596 \begin_layout Subsection*
3597 LFUN_PARAGRAPH_DOWN_SELECT
3600 \begin_layout Description
3601 Action Move the cursor and select the text to the next paragraph (or begining
3602 of the current one) in downward direction.
3606 \begin_layout Description
3607 Syntax paragraph-down-select
3610 \begin_layout Description
3611 Origin Asger, 1 Oct 1996
3614 \begin_layout Subsection*
3618 \begin_layout Description
3619 Action Jump to a paragraph given by its id number and optionally the desired
3620 position within the paragraph.
3624 \begin_layout Description
3625 Notion Note that id number of paragraph is not the sequential number of
3626 paragraph seen on the screen.
3627 Moreover the id is unique for all opened buffers (documents).
3631 \begin_layout Description
3632 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3635 \begin_layout Description
3636 Params <PAR_ID_NUMBER>: paragraph id
3637 \begin_inset Newline newline
3640 <POSITION_IN_PAR>: desired position within the paragraph
3643 \begin_layout Description
3644 Origin Dekel, 26 Aug 2000
3647 \begin_layout Subsection*
3648 LFUN_BREAK_PARAGRAPH
3651 \begin_layout Description
3652 Action Breaks the current paragraph at the current location.
3656 \begin_layout Description
3657 Syntax break-paragraph
3660 \begin_layout Subsection*
3661 LFUN_BREAK_PARAGRAPH
3664 \begin_layout Description
3665 Action Breaks the current paragraph at the current location.
3669 \begin_layout Description
3670 Notion Removes the selection.
3674 \begin_layout Description
3675 Syntax break-paragraph [<LAYOUT>]
3678 \begin_layout Description
3679 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3680 default layout) when the cursor is at the end of the line.
3684 \begin_layout Subsection*
3685 LFUN_PARAGRAPH_PARAMS
3688 \begin_layout Description
3689 Action Change paragraph settings.
3693 \begin_layout Description
3694 Notion Modifies the current paragraph, or currently selected paragraphs.
3695 This function only modifies, and does not override, existing settings.
3696 Note that the "leftindent" indent setting is deprecated.
3700 \begin_layout Description
3701 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3704 \begin_layout Description
3714 \begin_inset Newline newline
3719 paragraph_spacing default|single|onehalf|double|other
3720 \begin_inset Newline newline
3725 align block|left|right|center|default
3726 \begin_inset Newline newline
3731 labelwidthstring WIDTH|
3734 \begin_inset Newline newline
3740 \begin_layout Description
3741 Origin rgh, Aug 15 2007
3744 \begin_layout Subsection*
3745 LFUN_PARAGRAPH_PARAMS_APPLY
3748 \begin_layout Description
3749 Action Change paragraph settings.
3753 \begin_layout Description
3754 Notion Overwrite all nonspecified settings to the default ones.
3755 Use paragraph-params lfun if you don't want to overwrite others settings.
3759 \begin_layout Description
3760 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3763 \begin_layout Description
3764 Params For parameters see LFUN_PARAGRAPH_PARAMS
3767 \begin_layout Description
3768 Origin leeming, 30 Mar 2004
3771 \begin_layout Subsection*
3772 LFUN_PARAGRAPH_UPDATE
3775 \begin_layout Description
3776 Action Updates the values inside the paragraph dialog from the paragraph.
3780 \begin_layout Description
3781 Notion This is internal LFUN, not to be used by users.
3782 Called internally by LFUN_DIALOG_UPDATE.
3786 \begin_layout Description
3787 Origin leeming, 13 Mar 2003
3790 \begin_layout Subsection*
3794 \begin_layout Description
3795 Action Move the current group in the upward direction in the structure of
3800 \begin_layout Description
3801 Notion The "group" can be Part/Chapter/Section/etc.
3802 It moves the whole substructure of the group.
3806 \begin_layout Description
3810 \begin_layout Description
3811 Origin Vermeer, 23 Mar 2006
3814 \begin_layout Subsection*
3818 \begin_layout Description
3819 Action Move the current group in the downward direction in the structure
3824 \begin_layout Description
3825 Notion The "group" can be Part/Chapter/Section/etc.
3826 It moves the whole substructure of the group.
3830 \begin_layout Description
3834 \begin_layout Description
3835 Origin Vermeer, 23 Mar 2006
3838 \begin_layout Subsection*
3842 \begin_layout Description
3843 Action Moves the current group in the downward direction in the hierarchy
3844 of the document structure.
3848 \begin_layout Description
3849 Notion Part -> Chapter -> Section -> etc.
3853 \begin_layout Description
3857 \begin_layout Description
3858 Origin Vermeer, 23 Mar 2006
3861 \begin_layout Subsection*
3865 \begin_layout Description
3866 Action Moves the current group in the upward direction in the hierarchy
3867 of the document structure.
3871 \begin_layout Description
3872 Notion Part <- Chapter <- Section <- etc.
3876 \begin_layout Description
3880 \begin_layout Description
3881 Origin Vermeer, 23 Mar 2006
3884 \begin_layout Subsection*
3888 \begin_layout Description
3889 Action Edit the inset at cursor with an external application, *
3890 if one is attributed.
3894 \begin_layout Description
3895 Syntax inset-edit [<INSET_PARAMS>]
3898 \begin_layout Description
3899 Params <INSET_PARAMS>: Parameters for the inset.
3901 \begin_inset Newline newline
3904 Currently only the filename will be considered.
3908 \begin_layout Description
3909 Origin JSpitzm, 27 Apr 2006
3912 \begin_layout Subsection*
3916 \begin_layout Description
3917 Action Inserts table into the document.
3921 \begin_layout Description
3922 Syntax tabular-insert [<ROWS> <COLUMNS>]
3925 \begin_layout Description
3926 Params In case no arguments are given show insert dialog.
3930 \begin_layout Description
3931 Origin Jug, 12 Apr 2000
3934 \begin_layout Subsection*
3935 LFUN_TABULAR_FEATURE
3938 \begin_layout Description
3939 Action Sets various features to the table/cell on the current cursor position.
3943 \begin_layout Description
3944 Notion Various math-environment features are handled here as well, e.g.
3945 add-vline-left/right for Grid/Cases environment
3948 \begin_layout Description
3949 Syntax tabular-feature <FEATURE> [<ARG>]
3952 \begin_layout Description
3953 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3954 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3955 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3956 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3957 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3958 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3959 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3960 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3961 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3962 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3963 |set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
3964 ar-valign-middle|tabular-valign-bottom
3965 \begin_inset Newline newline
3968 <ARG>: additional argument for some commands, use debug mode to explore
3973 \begin_layout Description
3974 Origin Jug, 28 Jul 2000
3977 \begin_layout Subsection*
3981 \begin_layout Description
3982 Action Moves the cursor to the previous cell inside the table.
3986 \begin_layout Description
3987 Syntax cell-backward
3990 \begin_layout Description
3991 Origin Jug, 22 May 2000
3994 \begin_layout Subsection*
3998 \begin_layout Description
3999 Action Moves the cursor to the next cell inside the table.
4003 \begin_layout Description
4007 \begin_layout Subsection*
4011 \begin_layout Description
4012 Action Splits cell and shifts right part to the next cell (inside the math
4017 \begin_layout Description
4021 \begin_layout Description
4022 Origin Ale, 15 May 1997
4025 \begin_layout Subsection*
4029 \begin_layout Description
4030 Action Register the document as an file inside version control system (RCS,
4035 \begin_layout Description
4036 Notion File is registered inside cvs, svn or rcs repository acording to
4037 the existence of cvs/svn/rcs entries in the document's directory.
4039 \begin_inset Newline newline
4042 See LyX Additional Features Manual (Version Control Chapter) for additional
4047 \begin_layout Description
4051 \begin_layout Description
4052 Origin Lgb, 1 Jul 1997
4055 \begin_layout Subsection*
4059 \begin_layout Description
4060 Action Checks-in/commits the changes of the registered file to the repository.
4064 \begin_layout Description
4065 Notion In RCS case this also unlocks the file.
4069 \begin_layout Description
4073 \begin_layout Description
4074 Origin Lgb, 1 Jul 1997
4077 \begin_layout Subsection*
4081 \begin_layout Description
4082 Action Checks-out the document for edit (and locks it for RCS).
4086 \begin_layout Description
4087 Notion This is implemented only for RCS and SVN, not CVS.
4091 \begin_layout Description
4095 \begin_layout Description
4096 Origin Lgb, 1 Jul 1997
4099 \begin_layout Subsection*
4103 \begin_layout Description
4104 Action Reverts the document to the last check-in/commit in VCS.
4108 \begin_layout Description
4112 \begin_layout Description
4113 Origin Lgb, 1 Jul 1997
4116 \begin_layout Subsection*
4120 \begin_layout Description
4121 Action Undo last check-in.
4125 \begin_layout Description
4126 Notion This is currently implemented only for RCS.
4130 \begin_layout Description
4134 \begin_layout Description
4135 Origin Lgb, 1 Jul 1997
4138 \begin_layout Subsection*
4142 \begin_layout Description
4143 Action Executes external command.
4144 This command is intended to support additional VCS commands.
4148 \begin_layout Description
4149 Syntax vc-command <FLAG> <PATH> <COMMAND>
4152 \begin_layout Description
4153 Params <FLAG>: Flags for the command can be combined together.
4155 \begin_inset Newline newline
4158 U - dUmmy - no flags
4159 \begin_inset Newline newline
4162 D - Doc - need document loaded to proceed
4163 \begin_inset Newline newline
4166 I - dIrty - mark document dirty
4167 \begin_inset Newline newline
4170 R - Reload - ensure that the document is saved and reload it after command
4172 \begin_inset Newline newline
4175 M - Message - ask for input string (commit message)
4176 \begin_inset Newline newline
4179 <PATH>: path where to start.
4180 $$p will be replaced by the current document path.
4182 \begin_inset Newline newline
4185 <COMMAND>: command to execute.
4186 $$i/$$p/$$m will be replaced by the current document/path/message.
4190 \begin_layout Description
4191 Sample vc-command DR $$p "svn up"
4194 \begin_layout Description
4195 Origin sanda, 13 Jan 2009
4198 \begin_layout Subsection*
4202 \begin_layout Description
4203 Action Toggles change tracking to on/off.
4207 \begin_layout Description
4208 Syntax changes-track
4211 \begin_layout Description
4212 Origin levon, 1 Oct 2002
4215 \begin_layout Subsection*
4219 \begin_layout Description
4220 Action Toggles showing of change tracking in typesetted output.
4224 \begin_layout Description
4225 Syntax changes-output
4228 \begin_layout Description
4229 Origin jspitzm, 21 Jan 2005
4232 \begin_layout Subsection*
4236 \begin_layout Description
4237 Action Moves the cursor to the position of the next change of the change
4242 \begin_layout Description
4246 \begin_layout Description
4247 Origin schmitt, 4 Oct 2006
4250 \begin_layout Subsection*
4254 \begin_layout Description
4255 Action Open change tracking dialog for merging and moves the cursor to the
4256 position of the next change.
4260 \begin_layout Description
4261 Syntax changes-merge
4264 \begin_layout Description
4265 Origin Levon, 16 Oct 2002
4268 \begin_layout Subsection*
4272 \begin_layout Description
4273 Action Accepts tracked change inside the selection.
4277 \begin_layout Description
4278 Syntax change-accept
4281 \begin_layout Description
4282 Origin Levon, 16 Oct 2002
4285 \begin_layout Subsection*
4289 \begin_layout Description
4290 Action Rejects tracked change inside the selection.
4294 \begin_layout Description
4295 Syntax change-accept
4298 \begin_layout Description
4299 Origin Levon, 16 Oct 2002
4302 \begin_layout Subsection*
4303 LFUN_ALL_CHANGES_ACCEPT
4306 \begin_layout Description
4307 Action Accepts all tracked changes in the document.
4311 \begin_layout Description
4312 Syntax all-changes-accept
4315 \begin_layout Description
4316 Origin Levon, 16 Oct 2002
4319 \begin_layout Subsection*
4320 LFUN_ALL_CHANGES_REJECT
4323 \begin_layout Description
4324 Action Rejects all tracked changes in the document.
4328 \begin_layout Description
4329 Notion Reject does not work recursively; the user may have to repeat the
4334 \begin_layout Description
4335 Syntax all-changes-reject
4338 \begin_layout Description
4339 Origin Levon, 16 Oct 2002
4342 \begin_layout Subsection*
4346 \begin_layout Description
4347 Action Apply data for an inset.
4351 \begin_layout Description
4352 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4354 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4355 on the context where it is called.
4359 \begin_layout Description
4360 Syntax inset-apply <ARGS>
4363 \begin_layout Description
4364 Params See LFUN_INSET_INSERT .
4368 \begin_layout Subsection*
4372 \begin_layout Description
4373 Action Dissolve the current inset into text.
4377 \begin_layout Description
4378 Syntax inset-dissolve [<INSET>]
4381 \begin_layout Description
4382 Params <INSET>: this can be used to make sure the right kind of inset is
4384 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4385 the charstyle inset, even if the cursor is inside several nested insets
4388 \begin_inset Newline newline
4391 For values see lyx::InsetLayout::lyxtype_ .
4395 \begin_layout Description
4396 Origin JSpitz, 7 Aug 2006
4399 \begin_layout Subsection*
4403 \begin_layout Description
4404 Action Insert new inset (type given by the parameters).
4408 \begin_layout Description
4409 Syntax inset-insert <INSET> <ARGS>
4412 \begin_layout Description
4413 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
4414 \begin_inset Newline newline
4417 hyperlink|include|index|label|nomencl|vspace|ref|toc>
4418 \begin_inset Newline newline
4421 <ARGS>: depends on the given inset.
4422 Use "lyx -dbg action" to explore.
4426 \begin_layout Description
4427 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4430 \begin_inset Newline newline
4433 where <label name> is the name of the referenced label and<Format> is one
4435 \begin_inset Newline newline
4439 \begin_inset Newline newline
4442 eqref -- (<reference>)
4443 \begin_inset Newline newline
4447 \begin_inset Newline newline
4450 vpageref -- on <page>
4451 \begin_inset Newline newline
4454 vref -- <reference> on <page>
4455 \begin_inset Newline newline
4458 prettyref -- Formatted reference
4461 \begin_layout Subsection*
4465 \begin_layout Description
4466 Action Modify existing inset.
4470 \begin_layout Description
4471 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4472 graphics, include, label, listings, note, phantom, ref, space, tabular,
4473 vspace, wrap insets.
4477 \begin_layout Description
4478 Syntax inset-modify <INSET> <ARGS>
4481 \begin_layout Description
4482 Params See LFUN_INSET_INSERT for further details.
4486 \begin_layout Subsection*
4487 LFUN_NEXT_INSET_MODIFY
4490 \begin_layout Description
4491 Action Modify the inset at cursor position, if there is one.
4495 \begin_layout Description
4496 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4497 graphics, include, label, listings, note, phantom, ref, space, tabular,
4498 vspace, wrap insets.
4502 \begin_layout Description
4503 Syntax next-inset-modify <INSET> <ARGS>
4506 \begin_layout Description
4507 Syntax next-inset-modify changetype <TYPE>
4510 \begin_layout Description
4511 Params See LFUN_INSET_INSERT for further details.
4515 \begin_layout Description
4516 Origin JSpitzm, 23 Mar 2008
4519 \begin_layout Subsection*
4520 LFUN_INSET_DIALOG_UPDATE
4523 \begin_layout Description
4524 Action Updates the values inside the dialog from the inset.
4528 \begin_layout Description
4529 Notion This is internal LFUN, not to be used by users.
4530 Called internally by LFUN_DIALOG_UPDATE
4533 \begin_layout Description
4534 Params <DIALOG-NAME>
4537 \begin_layout Description
4538 Origin leeming, 25 Feb 2003
4541 \begin_layout Subsection*
4545 \begin_layout Description
4546 Action Open the inset's properties dialog.
4550 \begin_layout Description
4551 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4555 \begin_layout Description
4556 Syntax inset-settings <INSET>
4559 \begin_layout Description
4560 Params <INSET>: <box|branch|ert|float|listings|note|phantom|tabular|wrap>
4564 \begin_layout Subsection*
4565 LFUN_NEXT_INSET_TOGGLE
4568 \begin_layout Description
4569 Action Toggles the inset at cursor position.
4570 For collapsables, this means it will be (un-)collapsed, in case of other
4571 insets, the editing widget (dialog) will be entered.
4573 LFUN_INSET_SETTINGS.
4577 \begin_layout Description
4578 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4579 graphics, include, label, listings, note, phantom, ref, space, tabular,
4580 vspace, wrap insets.
4584 \begin_layout Description
4585 Syntax next-inset-toggle <ARG>
4588 \begin_layout Description
4589 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4593 \begin_layout Description
4594 Origin leeming, 30 Mar 2004
4597 \begin_layout Subsection*
4601 \begin_layout Description
4602 Action Toggles the collapsable inset we are currently in.
4606 \begin_layout Description
4607 Syntax inset-toggle [<ARG>]
4610 \begin_layout Description
4611 Params <ARG>: <open|close|toggle|assign>.
4613 \begin_inset Newline newline
4616 open/close/toggle are for collapsable insets.
4617 close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4618 toggle is used when no argument is given.
4620 \begin_inset Newline newline
4623 assign is for branch inset.
4627 \begin_layout Description
4628 Origin lasgouttes, 19 Jul 2001
4631 \begin_layout Subsection*
4632 LFUN_ALL_INSETS_TOGGLE
4635 \begin_layout Description
4636 Action Toggles (open/closes) all collapsable insets (of a given type) in
4641 \begin_layout Description
4642 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4646 \begin_layout Description
4647 Syntax all-insets-toggle <STATE> <INSET>
4650 \begin_layout Description
4651 Params <STATE>: <toggle|open|close> default: toggle
4652 \begin_inset Newline newline
4655 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4659 \begin_layout Description
4660 Origin leeming, 30 Mar 2004
4663 \begin_layout Subsection*
4664 LFUN_SET_GRAPHICS_GROUP
4667 \begin_layout Description
4668 Action Set the group for the graphics inset on the cursor position.
4672 \begin_layout Description
4673 Syntax set-graphics-group [<GROUP>]
4676 \begin_layout Description
4677 Params <GROUP>: Id for an existing group.
4678 In case the Id is an empty string, the graphics inset is removed from the
4683 \begin_layout Description
4684 Origin sanda, 6 May 2008
4687 \begin_layout Subsection*
4688 LFUN_FINISHED_FORWARD
4691 \begin_layout Description
4692 Action Moves the cursor out of the current slice, going forward.
4696 \begin_layout Description
4697 Notion Cursor movement within an inset may be different than cursor movement
4698 in the surrounding text.
4699 This action should be called automatically by the cursor movement within
4700 the inset, when movement within the inset has ceased (reached the end of
4701 the last paragraph, for example), in order to move correctly back into
4702 the surrounding text.
4706 \begin_layout Subsection*
4707 LFUN_FINISHED_BACKWARD
4710 \begin_layout Description
4711 Action Moves the cursor out of the current slice, going backwards.
4715 \begin_layout Description
4716 Notion See also LFUN_FINISHED_FORWARD.
4720 \begin_layout Subsection*
4724 \begin_layout Description
4725 Action Moves the cursor out of the current slice, going right.
4729 \begin_layout Description
4730 Notion See also LFUN_FINISHED_FORWARD
4733 \begin_layout Subsection*
4737 \begin_layout Description
4738 Action Moves the cursor out of the current slice, going left.
4742 \begin_layout Description
4743 Notion See also LFUN_FINISHED_FORWARD.
4747 \begin_layout Subsection*
4751 \begin_layout Description
4752 Action Set language from the current cursor position.
4756 \begin_layout Description
4757 Syntax language <LANG>
4760 \begin_layout Description
4761 Params <LANG>: Requested language.
4762 Look in lib/languages for the list.
4766 \begin_layout Description
4767 Origin Dekel, 2 Mar 2000
4770 \begin_layout Subsection*
4774 \begin_layout Description
4775 Action Goto a label.
4779 \begin_layout Description
4780 Syntax label-goto [<LABEL>]
4783 \begin_layout Description
4784 Params <LABEL>: Requested label.
4785 If no label is given and refernce is on cursor position, Bookmark 0 is
4786 saved and cursor moves to the position of referenced label.
4790 \begin_layout Description
4791 Origin Ale, 6 Aug 1997
4794 \begin_layout Subsection*
4798 \begin_layout Description
4799 Action Inserts label to text or displayed formula.
4803 \begin_layout Description
4804 Syntax label-insert [<LABEL>]
4807 \begin_layout Description
4808 Params <LABEL>: Requested label.
4809 If no label is given dialog requesting name will be opened.
4813 \begin_layout Subsection*
4817 \begin_layout Description
4818 Action Go to the next label or cross-reference.
4822 \begin_layout Description
4823 Syntax reference-next
4826 \begin_layout Description
4827 Origin Dekel, 14 Jan 2001
4830 \begin_layout Subsection*
4834 \begin_layout Description
4835 Action Goto a bookmark.
4839 \begin_layout Description
4840 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4841 Note that bookmarsk are saved per-session, not per file.
4845 \begin_layout Description
4846 Syntax bookmark-goto <NUMBER>
4849 \begin_layout Description
4850 Params <NUMBER>: the number of the bookmark to restore.
4854 \begin_layout Description
4855 Origin Dekel, 27 January 2001
4858 \begin_layout Subsection*
4862 \begin_layout Description
4863 Action Save a bookmark.
4867 \begin_layout Description
4868 Notion Saves a numbered bookmark to the sessions file.
4869 The number must be between 1 and 9, inclusive.
4870 Note that bookmarks are saved per-session, not per file.
4874 \begin_layout Description
4875 Syntax bookmark-save <NUMBER>
4878 \begin_layout Description
4879 Params <NUMBER>: the number of the bookmark to save.
4883 \begin_layout Description
4884 Origin Dekel, 27 January 2001
4887 \begin_layout Subsection*
4891 \begin_layout Description
4892 Action Clears the list of saved bookmarks.
4896 \begin_layout Description
4897 Syntax bookmark-clear
4900 \begin_layout Description
4901 Origin bpeng, 31 October 2006
4904 \begin_layout Subsection*
4908 \begin_layout Description
4909 Action Open the given help file according to the language setting.
4913 \begin_layout Description
4914 Syntax help-open <FILE>[.lyx]
4917 \begin_layout Description
4918 Params <FILE>: any document from (/usr/share/)doc directory.
4922 \begin_layout Description
4923 Origin Jug, 27 Jun 1999
4926 \begin_layout Subsection*
4930 \begin_layout Description
4931 Action Terminates the current LyX instance.
4935 \begin_layout Description
4936 Notion Terminates the current LyX instance, asking whether to save modified
4941 \begin_layout Description
4945 \begin_layout Subsection*
4949 \begin_layout Description
4950 Action Toggles visibility of a given toolbar between on/off/auto.
4954 \begin_layout Description
4955 Notion Skiping "auto" when allowauto is false.
4959 \begin_layout Description
4960 Syntax toolbar-toggle <NAME> [allowauto]
4963 \begin_layout Description
4964 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4965 ew/update|math_panels|vcs
4968 \begin_layout Description
4969 Origin Edwin, 21 May 2007
4972 \begin_layout Subsection*
4976 \begin_layout Description
4977 Action Opens the menu given by its name.
4981 \begin_layout Description
4982 Syntax menu-open <NAME>
4985 \begin_layout Description
4986 Params <NAME>: menu name.
4987 See various .inc files in lib/ui for candidates.
4991 \begin_layout Subsection*
4995 \begin_layout Description
4996 Action Various UI visibility-toggling actions.
5000 \begin_layout Description
5001 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5004 \begin_layout Description
5005 Params statusbar : Toggle visibility of the statusbar.
5007 \begin_inset Newline newline
5010 menubar : Toggle visibility of the menubar.
5012 \begin_inset Newline newline
5015 scrollbar : Toggle visibility of the scrollbar.
5017 \begin_inset Newline newline
5020 frame : Toggle visibility of the frames around editing window.
5022 \begin_inset Newline newline
5025 fullscreen : Toggle fullscreen mode.
5026 This also covers calling the previous functions.
5027 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5032 \begin_layout Description
5033 Origin sanda, 9 Feb 2007
5036 \begin_layout Subsection*
5040 \begin_layout Description
5041 Action Creates new empty LyX window.
5045 \begin_layout Description
5046 Notion Already opened documents from the previous window can be found under
5051 \begin_layout Description
5052 Syntax window-new [<GEOMETRY>]
5055 \begin_layout Description
5056 Params <GEOMETRY>: pass the geometry of the window.
5057 This parameter is currently accepted only on Windows platform.
5061 \begin_layout Description
5062 Origin Abdel, 21 Oct 2006
5065 \begin_layout Subsection*
5069 \begin_layout Description
5070 Action Closes the current LyX window.
5074 \begin_layout Description
5078 \begin_layout Description
5079 Origin Abdel, 23 Oct 2006
5082 \begin_layout Subsection*
5086 \begin_layout Description
5087 Action Creates another split view of current buffer.
5091 \begin_layout Description
5092 Notion All split views act in the same way indpendently.
5096 \begin_layout Description
5097 Syntax split-view <vertical|horizontal>
5100 \begin_layout Description
5101 Params horizontal : The work areas are laid out side by side.
5103 \begin_inset Newline newline
5106 vertical : The work areas laid out vertically.
5110 \begin_layout Description
5111 Origin Abdel, 20 Feb 2008
5114 \begin_layout Subsection*
5115 LFUN_CLOSE_TAB_GROUP
5118 \begin_layout Description
5119 Action Close the current tab group.
5123 \begin_layout Description
5124 Notion This only closes the work areas, not the buffer themselves.
5125 The still opened buffers can be visualized in another tab group.
5129 \begin_layout Description
5130 Syntax close-tab-group
5133 \begin_layout Description
5134 Origin Abdel, 21 Feb 2008
5137 \begin_layout Subsection*
5141 \begin_layout Description
5142 Action Shows hidden dialog or create new one for a given function/inset
5147 \begin_layout Description
5148 Syntax dialog-show <NAME> [<DATA>]
5151 \begin_layout Description
5152 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5154 \begin_inset Newline newline
5157 document|errorlist|ert|external|file|findreplace|float|graphics|
5158 \begin_inset Newline newline
5161 include|index|info|nomenclature|label|listings|log|mathdelimiter|
5162 \begin_inset Newline newline
5165 mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space|
5166 \begin_inset Newline newline
5169 spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|
5171 \begin_inset Newline newline
5174 view-source|vspace|wrap|<SPECIAL>
5175 \begin_inset Newline newline
5178 <SPECIAL>: latexlog|vclog
5179 \begin_inset Newline newline
5182 <DATA>: data, usually settings for the given dialog.
5183 Use debug mode for the details.
5187 \begin_layout Description
5188 Origin leeming, 17 Jun 2003
5191 \begin_layout Subsection*
5192 LFUN_DIALOG_SHOW_NEW_INSET
5195 \begin_layout Description
5196 Action Shows hidden dialog or create new one for a given inset settings
5201 \begin_layout Description
5202 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5207 \begin_layout Description
5208 Syntax dialog-show-new-inset <NAME> [<DATA>]
5211 \begin_layout Description
5212 Params See LFUN_DIALOG_SHOW .
5216 \begin_layout Description
5217 Origin leeming, 25 Feb 2003
5220 \begin_layout Subsection*
5224 \begin_layout Description
5225 Action Updates the dialog values from the inset/paragraph/document.
5229 \begin_layout Description
5230 Syntax dialog-update <NAME>
5233 \begin_layout Description
5234 Params <NAME>: paragraph|prefs|<INSET>
5235 \begin_inset Newline newline
5241 \begin_layout Description
5242 Origin leeming, 25 Feb 2003
5245 \begin_layout Subsection*
5249 \begin_layout Description
5250 Action Hides showed dialog.
5251 Counterpart to LFUN_DIALOG_SHOW .
5255 \begin_layout Description
5256 Syntax dialog-hide <NAME>
5259 \begin_layout Description
5260 Params See LFUN_DIALOG_SHOW .
5264 \begin_layout Description
5265 Origin leeming, 25 Feb 2003
5268 \begin_layout Subsection*
5272 \begin_layout Description
5273 Action Toggles dialog between showed/hidden state.
5277 \begin_layout Description
5278 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5282 \begin_layout Description
5283 Syntax dialog-toggle <NAME> [<DATA>]
5286 \begin_layout Description
5287 Params See LFUN_DIALOG_SHOW .
5291 \begin_layout Description
5292 Origin JSpitzm, 30 Apr 2007
5295 \begin_layout Subsection*
5296 LFUN_DIALOG_DISCONNECT_INSET
5299 \begin_layout Description
5300 Action Closes opened connection to opened inset.
5304 \begin_layout Description
5305 Notion Connection is used for apply functions.
5309 \begin_layout Description
5310 Syntax dialog-disconnect-inset <INSET-NAME>
5313 \begin_layout Description
5314 Origin leeming, 25 Feb 2003
5317 \begin_layout Subsection*
5321 \begin_layout Description
5322 Action This function is called when mouse button is pressed (inside workarea).Act
5323 ion depends on the context.
5327 \begin_layout Description
5328 Notion This is internal LFUN, not to be used by users.
5332 \begin_layout Description
5333 Origin Andre, 9 Aug 2002
5336 \begin_layout Subsection*
5340 \begin_layout Description
5341 Action This function is called when double click on mouse button is pressed
5343 Action depends on the context.
5347 \begin_layout Description
5348 Notion This is internal LFUN, not to be used by users.
5352 \begin_layout Description
5353 Origin Andre, 9 Aug 2002
5356 \begin_layout Subsection*
5360 \begin_layout Description
5361 Action This function is called when triple click on mouse button is pressed
5363 Action depends on the context.
5367 \begin_layout Description
5368 Notion This is internal LFUN, not to be used by users.
5372 \begin_layout Description
5373 Origin Andre, 9 Aug 2002
5376 \begin_layout Subsection*
5380 \begin_layout Description
5381 Action This function is called when mouse cursor is moving over the text.Action
5382 depends on the context.
5386 \begin_layout Description
5387 Notion This is internal LFUN, not to be used by users.
5391 \begin_layout Description
5392 Origin Andre, 9 Aug 2002
5395 \begin_layout Subsection*
5399 \begin_layout Description
5400 Action This function is called when mouse button is released (inside workarea).Ac
5401 tion depends on the context.
5405 \begin_layout Description
5406 Notion This is internal LFUN, not to be used by users.
5410 \begin_layout Description
5411 Origin Andre, 9 Aug 2002
5414 \begin_layout Subsection*
5418 \begin_layout Description
5419 Action Turn off the loaded keyboard map.
5423 \begin_layout Description
5427 \begin_layout Subsection*
5431 \begin_layout Description
5432 Action Turn on the primary keyboard map.
5436 \begin_layout Description
5437 Notion Maps were widely used in past, when X-windows didn't have nowadays
5439 They can be still used to maintain uniform keyboard layout across the various
5442 \begin_inset Newline newline
5445 The language is to be set in the Preferences dialog.
5449 \begin_layout Description
5450 Syntax keymap-primary
5453 \begin_layout Subsection*
5454 LFUN_KEYMAP_SECONDARY
5457 \begin_layout Description
5458 Action Turn on the secondary keyboard map.
5462 \begin_layout Description
5463 Syntax keymap-secondary
5466 \begin_layout Subsection*
5470 \begin_layout Description
5471 Action Toggles keyboard maps (first/second/off).
5475 \begin_layout Description
5476 Syntax keymap-toggle
5479 \begin_layout Description
5480 Origin leeming, 30 Mar 2004
5483 \begin_layout Subsection*
5484 LFUN_SERVER_GET_LAYOUT
5487 \begin_layout Description
5488 Action Returns the current layout (that is environment) name on the cursor
5493 \begin_layout Description
5494 Syntax server-get-layout
5497 \begin_layout Subsection*
5498 LFUN_SERVER_GET_FILENAME
5501 \begin_layout Description
5502 Action Returns path and file name of the currently edited document.
5506 \begin_layout Description
5507 Syntax server-get-filename
5510 \begin_layout Subsection*
5511 LFUN_SERVER_GOTO_FILE_ROW
5514 \begin_layout Description
5515 Action Sets the cursor position based on the row number of generated TeX
5520 \begin_layout Description
5521 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5524 \begin_layout Description
5525 Origin Edmar, 23 Dec 1998
5528 \begin_layout Subsection*
5532 \begin_layout Description
5533 Action Sends notify message about the last key-sequence to client.
5537 \begin_layout Description
5538 Notion This can be used to grab last key-sequence used inside the LyX window.
5539 See also Debug extensions section in Additional features manual.
5543 \begin_layout Description
5544 Syntax server-notify
5547 \begin_layout Subsection*
5551 \begin_layout Description
5552 Action Sets the cursor position based on the editing area coordinates (similar
5553 as clicking on that point with left mouse button).
5557 \begin_layout Description
5558 Syntax server-set-xy <X> <Y>
5561 \begin_layout Subsection*
5565 \begin_layout Description
5566 Action Returns the coordinates of cursor position in the editing area.
5570 \begin_layout Description
5571 Syntax server-get-xy
5574 \begin_layout Subsection*
5578 \begin_layout Description
5579 Action Generates the code (literate programming).
5583 \begin_layout Description
5584 Notion Latex file with extension literate_extension is generated.
5585 Then LyX invokes build_command (with a default of``make'') to generate
5586 the code and build_error_filter to process the compilation error messages.
5588 \begin_inset Newline newline
5591 In case you want to process your literate file with a script, or some other
5592 program, just insert in your lyxrc file an entry with:
5593 \begin_inset Newline newline
5596 build_command "my_script my_arguments"
5597 \begin_inset Newline newline
5600 The build_error_filter differs from the literate_error_filter only in that
5601 the former will identify error messages from your compiler.
5605 \begin_layout Description
5606 Syntax build-program
5609 \begin_layout Subsection*
5610 LFUN_BUFFER_AUTO_SAVE
5613 \begin_layout Description
5614 Action Saves the current buffer to a temporary file.
5618 \begin_layout Description
5619 Notion Saves the current buffer to a file named "#filename#".
5620 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5624 \begin_layout Description
5625 Syntax buffer-auto-save
5628 \begin_layout Subsection*
5629 LFUN_BUFFER_CHILD_OPEN
5632 \begin_layout Description
5633 Action Loads the given child document.
5637 \begin_layout Description
5638 Notion The current document is treated as a parent.
5642 \begin_layout Description
5643 Syntax buffer-child-open <FILE>
5646 \begin_layout Description
5647 Params <FILE>: Filename of the child.
5648 The directory of the parent is assumed by default.
5652 \begin_layout Description
5653 Origin Ale, 28 May 1997
5656 \begin_layout Subsection*
5660 \begin_layout Description
5661 Action Runs chktex for the current document.
5665 \begin_layout Description
5666 Syntax buffer-chktex
5669 \begin_layout Description
5670 Origin Asger, 30 Oct 1997
5673 \begin_layout Subsection*
5674 LFUN_BUFFER_TOGGLE_COMPRESSION
5677 \begin_layout Description
5678 Action Toggles compression of the current document on/off.
5682 \begin_layout Description
5683 Syntax buffer-toggle-compression
5686 \begin_layout Description
5687 Origin bpeng, 27 Apr 2006
5690 \begin_layout Subsection*
5694 \begin_layout Description
5695 Action Closes the current buffer.
5699 \begin_layout Description
5700 Notion Closes the current buffer, asking whether to save it, etc, if the
5701 buffer has been modified.
5705 \begin_layout Description
5709 \begin_layout Subsection*
5713 \begin_layout Description
5714 Action Exports the current buffer (document) to the given format.
5718 \begin_layout Description
5719 Syntax buffer-export <FORMAT>
5722 \begin_layout Description
5723 Params <FORMAT> is either "custom" or one of the formats which you can find
5724 in Tools->Preferences->File formats->Format.
5725 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5726 for pdflatex) or "ps" for postscript.
5728 \begin_inset Newline newline
5731 In case of "custom" you will be asked for a format you want to start from
5732 and for the command that you want to apply to this format.
5733 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5737 \begin_layout Description
5738 Origin Lgb, 29 Jul 1997
5741 \begin_layout Subsection*
5742 LFUN_BUFFER_EXPORT_CUSTOM
5745 \begin_layout Description
5746 Action Exports the current buffer (document) from the given format using
5747 the given command on it.
5751 \begin_layout Description
5752 Syntax buffer-export-custom <FORMAT> <COMMAND>
5755 \begin_layout Description
5756 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5759 \begin_inset Newline newline
5762 <COMMAND> this command will be launched on the file.
5763 Note that you can use "$$FName" string to qualify the intermediate file.
5767 \begin_layout Description
5768 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5771 \begin_layout Description
5772 Origin leeming, 27 Mar 2004
5775 \begin_layout Subsection*
5779 \begin_layout Description
5780 Action Prints the current document.
5784 \begin_layout Description
5785 Notion Many settings can be given via the preferences dialog.
5789 \begin_layout Description
5790 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5793 \begin_layout Description
5794 Params <TARGET> is either "printer" or "file".
5796 \begin_inset Newline newline
5799 <TARGER-NAME> is either "default" or file name or printer name.
5801 \begin_inset Newline newline
5804 <COMMAND> command ensuring the printing job.
5808 \begin_layout Description
5809 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5812 \begin_layout Description
5813 Origin leeming, 28 Mar 2004
5816 \begin_layout Subsection*
5820 \begin_layout Description
5821 Action Import a given file as a lyx document.
5825 \begin_layout Description
5826 Notion File can be imported iff lyx file format is (transitively) reachable
5827 via defined convertors in preferences.
5828 Look into File->Import menu to get an idea of the currently active import
5833 \begin_layout Description
5834 Syntax buffer-import <FORMAT> [<FILE>]
5837 \begin_layout Description
5838 Origin Asger, 24 Jul 1998
5841 \begin_layout Subsection*
5845 \begin_layout Description
5846 Action Creates a new buffer (that is, document).
5850 \begin_layout Description
5851 Notion Implicit path can be set in Preferences dialog.
5855 \begin_layout Description
5856 Syntax buffer-new [<FILE>]
5859 \begin_layout Description
5860 Params <FILE>: filename of created file with absolute path.
5864 \begin_layout Subsection*
5865 LFUN_BUFFER_NEW_TEMPLATE
5868 \begin_layout Description
5869 Action Creates a new buffer (that is, document) from a template.
5873 \begin_layout Description
5874 Notion Path for new files and templates can be set in Preferences dialog.
5875 Template will be asked for via Open-dialog.
5879 \begin_layout Description
5880 Syntax buffer-new-template [<FILE>]
5883 \begin_layout Description
5884 Params <FILE>: filename of created file with absolute path.
5888 \begin_layout Subsection*
5892 \begin_layout Description
5893 Action Reverts opened document.
5897 \begin_layout Description
5898 Syntax buffer-reload
5901 \begin_layout Description
5902 Origin Asger, 2 Feb 1997
5905 \begin_layout Subsection*
5909 \begin_layout Description
5910 Action Switch to the given buffer.
5914 \begin_layout Description
5915 Notion This is useful also in case you need simultaneously more views of
5916 the edited document in different LyX windows.
5920 \begin_layout Description
5921 Syntax buffer-new-template <BUFFER>
5924 \begin_layout Description
5925 Params <BUFFER>: already opened document which is to be shown.
5929 \begin_layout Subsection*
5930 LFUN_BUFFER_TOGGLE_READ_ONLY
5933 \begin_layout Description
5934 Action Toggle editing mode of the current document between read/write and
5939 \begin_layout Description
5940 Notion In the ->Readonly mode checks-in/commits the data if the file is
5941 under version control.
5942 In the Readonly-> mode checkouts the data from repository.
5944 \begin_inset Newline newline
5947 If these operations fail, buffer won't be toggled.
5951 \begin_layout Description
5952 Syntax buffer-toggle-read-only
5955 \begin_layout Description
5956 Origin Lgb, 27 May 1997
5959 \begin_layout Subsection*
5963 \begin_layout Description
5964 Action Displays current buffer in chosen format.
5968 \begin_layout Description
5969 Notion Displays the contents of the current buffer in the chosen format,
5970 for example, PDF or DVI.
5971 This runs the necessary converter, calls the defined viewer, and so forth.
5975 \begin_layout Description
5976 Syntax buffer-view <FORMAT>
5979 \begin_layout Description
5980 Params <FORMAT>: The format to display, where this is one of the formats
5981 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5985 \begin_layout Subsection*
5989 \begin_layout Description
5990 Action Exports the current document and put the result into the temporary
5995 \begin_layout Description
5996 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5997 EW) the output will be rewriten - updated.
5998 This is useful in case your viewer is able to detect such changes (e.g.
5999 ghostview for postscript).
6003 \begin_layout Description
6004 Syntax buffer-update <FORMAT>
6007 \begin_layout Description
6008 Params <FORMAT>: The format to display, where this is one of the formats
6009 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6013 \begin_layout Description
6014 Origin Dekel, 5 Aug 2000
6017 \begin_layout Subsection*
6021 \begin_layout Description
6022 Action Saves the current buffer.
6026 \begin_layout Description
6027 Notion Saves the current buffer to disk, using the filename that is already
6028 associated with the buffer, asking for one if none is yet assigned.
6032 \begin_layout Description
6036 \begin_layout Subsection*
6037 LFUN_BUFFER_WRITE_AS
6040 \begin_layout Description
6041 Action Rename and save current buffer.
6045 \begin_layout Description
6046 Syntax buffer-write-as <FILENAME>
6049 \begin_layout Description
6050 Params <FILENAME>: New name of the buffer/file.
6051 A relative path is with respect to the original location of the buffer/file.
6055 \begin_layout Subsection*
6056 LFUN_BUFFER_WRITE_ALL
6059 \begin_layout Description
6060 Action Save all changed documents.
6064 \begin_layout Description
6065 Syntax buffer-write-all
6068 \begin_layout Description
6069 Origin rgh, gpothier 6 Aug 2007
6072 \begin_layout Subsection*
6076 \begin_layout Description
6077 Action Switch to the next opened document.
6081 \begin_layout Description
6082 Notion Note that this does not necessarily mean next in tabbar (for full
6083 list see View menu).
6087 \begin_layout Description
6091 \begin_layout Subsection*
6092 LFUN_BUFFER_PREVIOUS
6095 \begin_layout Description
6096 Action Switch to the previous opened document.
6100 \begin_layout Description
6101 Syntax buffer-previous
6104 \begin_layout Subsection*
6105 LFUN_MASTER_BUFFER_UPDATE
6108 \begin_layout Description
6109 Action When run from a child document, this updates (exports) document built
6110 from the master buffer.
6111 If a master is not found, it updates the current buffer.
6115 \begin_layout Description
6116 Syntax master-buffer-update
6119 \begin_layout Description
6120 Origin Tommaso, 20 Sep 2007
6123 \begin_layout Subsection*
6124 LFUN_MASTER_BUFFER_VIEW
6127 \begin_layout Description
6128 Action When run from a child document, this command shows a preview built
6129 from the master buffer.
6130 If a master is not found, it previews the current buffer.
6134 \begin_layout Description
6135 Syntax master-buffer-view
6138 \begin_layout Description
6139 Origin Tommaso, 20 Sep 2007
6142 \begin_layout Subsection*
6143 LFUN_BUFFER_LANGUAGE
6146 \begin_layout Description
6147 Action Set language of the current document.
6151 \begin_layout Description
6152 Syntax buffer-language <LANG>
6155 \begin_layout Description
6156 Params <LANG>: language name.
6157 See lib/languages for list.
6161 \begin_layout Description
6162 Origin leeming, 30 Mar 2004
6165 \begin_layout Subsection*
6166 LFUN_BUFFER_SAVE_AS_DEFAULT
6169 \begin_layout Description
6170 Action Save the current document settings as default.
6174 \begin_layout Description
6175 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6179 \begin_layout Description
6180 Syntax buffer-save-as-default [<ARGS>]
6183 \begin_layout Description
6184 Params <ARGS>: contains the particular settings to be saved.
6185 They obey the syntax you can find in document header of usual .lyx file.
6189 \begin_layout Description
6190 Origin leeming, 30 Mar 2004
6193 \begin_layout Subsection*
6194 LFUN_BUFFER_PARAMS_APPLY
6197 \begin_layout Description
6198 Action Apply the given settings to the current document.
6202 \begin_layout Description
6203 Syntax buffer-params-apply [<ARGS>]
6206 \begin_layout Description
6207 Params <ARGS>: contains the particular settings to be saved.
6208 They obey the syntax you can find in document header of usual .lyx file.
6212 \begin_layout Description
6213 Origin leeming, 30 Mar 2004
6216 \begin_layout Subsection*
6220 \begin_layout Description
6221 Action Inserts another LyX file.
6225 \begin_layout Description
6226 Syntax file-insert [<FILE>]
6229 \begin_layout Description
6230 Params <FILE>: Filename to be inserted.
6234 \begin_layout Subsection*
6235 LFUN_FILE_INSERT_PLAINTEXT
6238 \begin_layout Description
6239 Action Inserts plain text file.
6243 \begin_layout Description
6244 Syntax file-insert-plaintext [<FILE>]
6247 \begin_layout Description
6248 Params <FILE>: Filename to be inserted.
6252 \begin_layout Description
6253 Origin CFO-G, 19 Nov 1997
6256 \begin_layout Subsection*
6257 LFUN_FILE_INSERT_PLAINTEXT_PARA
6260 \begin_layout Description
6261 Action Inserts plain text file as paragraph (i.e.
6266 \begin_layout Description
6267 Syntax file-insert-plaintext-para [<FILE>]
6270 \begin_layout Description
6271 Params <FILE>: Filename to be inserted.
6275 \begin_layout Description
6276 Origin Levon, 14 Feb 2001
6279 \begin_layout Subsection*
6283 \begin_layout Description
6284 Action Open LyX document.
6288 \begin_layout Description
6289 Syntax file-open [<FILE>]
6292 \begin_layout Description
6293 Params <FILE>: Filename to be opened.
6297 \begin_layout Subsection*
6301 \begin_layout Description
6302 Action Executes a command defined in a .def file.
6306 \begin_layout Description
6307 Notion The definitions are by default read from lib/commands/default.def.
6309 \begin_inset Newline newline
6312 A .def file allows to define a command with
6314 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6315 <LFUN> is the lfun code to be executed (see e.g.
6316 LFUN_COMMAND_SEQUENCE).
6319 def_file "FileName" allows to include another .def file.
6321 \begin_inset Newline newline
6324 This is particularly useful in connection with toolbar buttons: Since the
6325 name of the button image for this lfun is lib/images/commands/<NAME>.png
6326 this is the way to assign an image to a complex command-sequence.
6330 \begin_layout Description
6334 \begin_layout Description
6335 Params <NAME>: Name of the command that must be called.
6339 \begin_layout Description
6340 Origin broider, 2 Oct 2007
6343 \begin_layout Subsection*
6347 \begin_layout Description
6348 Action Simulate halting Meta key (Alt key on PCs).
6352 \begin_layout Description
6353 Notion Used for buffer editation not for GUI control.
6357 \begin_layout Description
6361 \begin_layout Subsection*
6365 \begin_layout Description
6366 Action Cancels sequence prepared by LFUN_META_PREFIX .
6370 \begin_layout Description
6374 \begin_layout Subsection*
6375 LFUN_COMMAND_EXECUTE
6378 \begin_layout Description
6379 Action Opens the minibuffer toolbar so that the user can type in there.
6383 \begin_layout Description
6384 Notion Usually bound to M-x shortcut.
6388 \begin_layout Description
6389 Syntax command-execute
6392 \begin_layout Subsection*
6396 \begin_layout Description
6397 Action Return the current key sequence and available options as a string.
6401 \begin_layout Description
6402 Notion No options are added if no current map exists.
6404 \begin_inset Newline newline
6407 This is probably usable only with connection to lyxserver.
6411 \begin_layout Description
6412 Syntax command-prefix
6415 \begin_layout Subsection*
6416 LFUN_COMMAND_SEQUENCE
6419 \begin_layout Description
6420 Action Run more commands (LFUN and its parameters) in a sequence.
6424 \begin_layout Description
6425 Syntax command-sequence <CMDS>
6428 \begin_layout Description
6429 Params <CMDS>: Sequence of commands separated by semicolons.
6433 \begin_layout Description
6434 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6438 \begin_layout Description
6439 Origin Andre, 11 Nov 1999
6442 \begin_layout Subsection*
6443 LFUN_COMMAND_ALTERNATIVES
6446 \begin_layout Description
6447 Action Runs the first listed command that is enabled.
6451 \begin_layout Description
6452 Notion This can be used to bind multiple functions to a single key, and
6453 then which one is used will depend upon the context.
6457 \begin_layout Description
6458 Syntax command-alternatives <CMDS>
6461 \begin_layout Description
6462 Params <CMDS>: Sequence of commands separated by semicolons.
6466 \begin_layout Description
6467 Sample command-alternatives completion-accept;cell-forward
6470 \begin_layout Description
6471 Origin rgh, 24 September 2008
6474 \begin_layout Subsection*
6478 \begin_layout Description
6479 Action Shows message in statusbar (for script purposes).
6483 \begin_layout Description
6484 Syntax message <STRING>
6487 \begin_layout Description
6488 Origin Lgb, 8 Apr 2001
6491 \begin_layout Subsection*
6492 LFUN_PREFERENCES_SAVE
6495 \begin_layout Description
6496 Action Save user preferences.
6500 \begin_layout Description
6501 Syntax preferences-save
6504 \begin_layout Description
6505 Origin Lgb, 27 Nov 1999
6508 \begin_layout Subsection*
6512 \begin_layout Description
6513 Action Reconfigure the automatic settings.
6517 \begin_layout Description
6521 \begin_layout Description
6522 Origin Asger, 14 Feb 1997
6525 \begin_layout Subsection*
6529 \begin_layout Description
6530 Action Apply the given settings to user preferences.
6534 \begin_layout Description
6535 Syntax lyxrc-apply <SETTINGS>
6538 \begin_layout Description
6539 Params <SETTINGS>: settings which are to be set.
6540 Take a look into ~/.lyx/preferences to get an idea which commands to use
6542 lyx::LyXRC::LyXRCTags has the list of possible commands.
6546 \begin_layout Subsection*
6547 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6550 \begin_layout Description
6551 Action Determine whether keep cursor inside the editing window regardless
6552 the scrollbar movement.
6556 \begin_layout Description
6557 Syntax toggle-cursor-follows-scrollbar
6560 \begin_layout Description
6561 Origin ARRae, 2 Dec 1997
6564 \begin_layout Subsection*
6568 \begin_layout Description
6569 Action Set the given LyX color to the color defined by the X11 name given.
6573 \begin_layout Description
6574 Notion A new color entry is created if the color is unknown.
6575 Color names can be stored as a part of user settings.
6579 \begin_layout Description
6580 Syntax set-color <LYX_NAME> <X11_NAME>
6583 \begin_layout Description
6584 Origin SLior, 11 Jun 2000
6587 \begin_layout Subsection*
6591 \begin_layout Description
6592 Action Count the statistics (number of words and characters) in the document
6593 or in the given selection.
6597 \begin_layout Description
6598 Notion Note that this function gives the number of words/chars written,
6599 not the number of characters which will be typeset.
6603 \begin_layout Description
6607 \begin_layout Description
6608 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6611 \begin_layout Subsection*
6612 LFUN_COMPLETION_INLINE
6615 \begin_layout Description
6616 Action Show the inline completion at the cursor position.
6620 \begin_layout Description
6621 Syntax completion-inline
6624 \begin_layout Description
6625 Origin sts, Feb 19 2008
6628 \begin_layout Subsection*
6629 LFUN_COMPLETION_POPUP
6632 \begin_layout Description
6633 Action Show the completion popup at the cursor position.
6637 \begin_layout Description
6638 Syntax completion-popup
6641 \begin_layout Description
6642 Origin sts, Feb 19 2008
6645 \begin_layout Subsection*
6646 LFUN_COMPLETION_COMPLETE
6649 \begin_layout Description
6650 Action Try to complete the word or command at the cursor position.
6654 \begin_layout Description
6658 \begin_layout Description
6659 Origin sts, Feb 19 2008
6662 \begin_layout Subsection*
6663 LFUN_COMPLETION_CANCEL
6666 \begin_layout Description
6667 Action Try to cancel completion, either the popup or the inline completion
6671 \begin_layout Description
6672 Syntax completion-cancel
6675 \begin_layout Description
6676 Origin sts, Sep 07 2008
6679 \begin_layout Subsection*
6680 LFUN_COMPLETION_ACCEPT
6683 \begin_layout Description
6684 Action Accept suggested completion.
6688 \begin_layout Description
6689 Syntax completion-accept
6692 \begin_layout Description
6693 Origin sanda, Sep 08 2008
6696 \begin_layout Subsection*
6697 LFUN_BRANCH_ACTIVATE
6700 \begin_layout Description
6701 Action Activate the branch
6704 \begin_layout Description
6705 Syntax branch-activate <BRANCH>
6708 \begin_layout Description
6709 Params <BRANCH>: The branch to activate
6712 \begin_layout Description
6713 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6714 \begin_inset Newline newline
6717 could be used to export a pdf with the answers branch includedwithout one's
6718 having to open LyX and activate the branch manually.
6721 \begin_layout Description
6722 Origin rgh, 27 May 2008
6725 \begin_layout Subsection*
6726 LFUN_BRANCH_ACTIVATE
6729 \begin_layout Description
6730 Action De-activate the branch
6733 \begin_layout Description
6734 Syntax branch-deactivate <BRANCH>
6737 \begin_layout Description
6738 Params <BRANCH>: The branch to deactivate
6741 \begin_layout Description
6742 Origin rgh, 27 May 2008
6745 \begin_layout Subsection*
6746 LFUN_COPY_LABEL_AS_REF
6749 \begin_layout Description
6750 Action Copies the label at the cursor as a cross-reference to be pasted
6755 \begin_layout Description
6756 Syntax copy-label-as-reference
6759 \begin_layout Description
6760 Origin sts, 16 Nov 2008