1 #LyX 1.6.2 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 03.04.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*
1263 LFUN_SCREEN_SHOW_CURSOR
1266 \begin_layout Description
1267 Action Repositions the screen such that the cursor is visible.
1271 \begin_layout Description
1272 Syntax screen-show-cursor
1275 \begin_layout Description
1276 Origin vfr, 25 Mar 2009
1279 \begin_layout Subsection*
1283 \begin_layout Description
1284 Action Moves the cursor one position logically backwards.
1288 \begin_layout Description
1289 Notion This is not the action which should be bound to the arrow keys, because
1290 backwards may be left or right, depending on the language.
1291 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1292 which in turn may employ this one.
1296 \begin_layout Description
1297 Syntax char-backward
1300 \begin_layout Subsection*
1301 LFUN_CHAR_BACKWARD_SELECT
1304 \begin_layout Description
1305 Action Moves the cursor one position logically backwards, adding traversed
1306 position to the selection.
1310 \begin_layout Description
1311 Notion See also LFUN_CHAR_BACKWARD.
1315 \begin_layout Description
1316 Syntax char-backward-select
1319 \begin_layout Subsection*
1320 LFUN_CHAR_DELETE_BACKWARD
1323 \begin_layout Description
1324 Action Deletes one character in the backward direction (usually the "BackSpace"
1329 \begin_layout Description
1330 Syntax char-delete-backward
1333 \begin_layout Subsection*
1334 LFUN_CHAR_DELETE_FORWARD
1337 \begin_layout Description
1338 Action Deletes one character in the backward direction (usually the "Delete"
1343 \begin_layout Description
1344 Syntax char-delete-forward
1347 \begin_layout Subsection*
1351 \begin_layout Description
1352 Action Moves the cursor one position logically forward.
1356 \begin_layout Description
1357 Notion This is not the action which should be bound to the arrow keys, because
1358 forward may be left or right, depending on the language.
1359 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1360 which in turn may employ this one.
1364 \begin_layout Description
1368 \begin_layout Subsection*
1369 LFUN_CHAR_FORWARD_SELECT
1372 \begin_layout Description
1373 Action Moves the cursor one position logically forward, adding traversed
1374 position to the selection.
1378 \begin_layout Description
1379 Notion See also LFUN_CHAR_FORWARD.
1383 \begin_layout Description
1384 Syntax char-forward-select
1387 \begin_layout Subsection*
1391 \begin_layout Description
1392 Action Moves the cursor one position "to the left".
1396 \begin_layout Description
1397 Notion This is the action which should be taken when the "left" key is pressed.
1398 Generally, it moves the cursor one position to the left.
1399 However, in Bidi text this become slightly more complicated, and there
1400 are different modes of cursor movement.
1401 In "visual mode", this moves left, plain and simple.
1402 In "logical mode", movement is logically forward in RTL paragraphs, and
1403 logically backwards in LTR paragraphs.
1407 \begin_layout Description
1411 \begin_layout Subsection*
1412 LFUN_CHAR_LEFT_SELECT
1415 \begin_layout Description
1416 Action Moves the cursor one position "to the left", adding traversed position
1421 \begin_layout Description
1422 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1426 \begin_layout Description
1427 Syntax char-left-select
1430 \begin_layout Subsection*
1434 \begin_layout Description
1435 Action Moves the cursor one position "to the right".
1439 \begin_layout Description
1440 Notion This is the action which should be taken when the "right" key is
1442 Generally, it moves the cursor one position to the right.
1443 However, in Bidi text this become slightly more complicated, and there
1444 are different modes of cursor movement.
1445 In "visual mode", this moves right, plain and simple.
1446 In "logical mode", movement is logically forward in LTR paragraphs, and
1447 logically backwards in RTL paragraphs.
1451 \begin_layout Description
1455 \begin_layout Subsection*
1456 LFUN_CHAR_RIGHT_SELECT
1459 \begin_layout Description
1460 Action Moves the cursor one position "to the right", adding traversed position
1465 \begin_layout Description
1466 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1470 \begin_layout Description
1471 Syntax char-right-select
1474 \begin_layout Subsection*
1478 \begin_layout Description
1479 Action Moves the cursor to the logically previous beginning of a word.
1483 \begin_layout Description
1484 Notion This is not the action which should be bound to the arrow keys, because
1485 backwards may be left or right, depending on the language.
1486 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1487 which in turn may employ this one.
1491 \begin_layout Description
1492 Syntax word-backward
1495 \begin_layout Subsection*
1496 LFUN_WORD_BACKWARD_SELECT
1499 \begin_layout Description
1500 Action Moves the cursor to the logically previous beginning of a word, adding
1501 the logically traversed text to the selection.
1505 \begin_layout Description
1506 Notion See also LFUN_WORD_BACKWARD.
1510 \begin_layout Description
1511 Syntax word-backward-select
1514 \begin_layout Subsection*
1515 LFUN_WORD_DELETE_BACKWARD
1518 \begin_layout Description
1519 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1524 \begin_layout Description
1525 Syntax word-delete-backward
1528 \begin_layout Subsection*
1529 LFUN_WORD_DELETE_FORWARD
1532 \begin_layout Description
1533 Action Deletes characters to the end of the word (usually the "C+Delete"
1538 \begin_layout Description
1539 Syntax word-delete-forward
1542 \begin_layout Subsection*
1543 LFUN_WORD_FIND_FORWARD
1546 \begin_layout Description
1547 Action Search for a given string in forward direction.
1551 \begin_layout Description
1552 Notion Case sensitive, match words.
1553 If no argument given, last search repeated.
1557 \begin_layout Description
1558 Syntax word-find-forward [<STRING>]
1561 \begin_layout Description
1562 Origin Etienne, 16 Feb 1998
1565 \begin_layout Subsection*
1566 LFUN_WORD_FIND_BACKWARD
1569 \begin_layout Description
1570 Action Search for a given string in backward direction.
1574 \begin_layout Description
1575 Notion Case sensitive, match words.
1576 If no argument given, last search repeated.
1580 \begin_layout Description
1581 Syntax word-find-backward [<STRING>]
1584 \begin_layout Description
1585 Origin Etienne, 20 Feb 1998
1588 \begin_layout Subsection*
1592 \begin_layout Description
1593 Action Search for next occurence of a string.
1597 \begin_layout Description
1598 Syntax word-find [<DATA>]
1601 \begin_layout Description
1602 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1603 If no parameter is given, search with last find-dialog data is used for
1609 \begin_layout Description
1610 Origin Andre, Jan 7 2004
1613 \begin_layout Subsection*
1617 \begin_layout Description
1618 Action Replace a string in the document.
1622 \begin_layout Description
1623 Syntax word-replace [<DATA>]
1626 \begin_layout Description
1627 Params <DATA>: data is of the form "<search>
1628 \begin_inset Newline newline
1632 \begin_inset Newline newline
1635 <casesensitive> <matchword> <all> <forward>"
1638 \begin_layout Description
1639 Origin Andre, Jan 7 2004
1642 \begin_layout Subsection*
1646 \begin_layout Description
1647 Action Search for next occurence of a pattern.
1651 \begin_layout Description
1652 Syntax word-findadv [<DATA>]
1655 \begin_layout Description
1656 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1657 If no parameter is given, search with last find-dialog data is used for
1663 \begin_layout Description
1664 Origin Tommaso, Nov 15 2007
1667 \begin_layout Description
1668 Action Moves the cursor to the logically next beginning of a word.
1672 \begin_layout Description
1673 Notion This is not the action which should be bound to the arrow keys, because
1674 forward may be left or right, depending on the language.
1675 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1676 which in turn may employ this one.
1680 \begin_layout Description
1684 \begin_layout Subsection*
1685 LFUN_WORD_FORWARD_SELECT
1688 \begin_layout Description
1689 Action Moves the cursor to the logically next beginning of a word, adding
1690 the logically traversed text to the selection.
1694 \begin_layout Description
1695 Notion See also LFUN_WORD_FORWARD.
1699 \begin_layout Description
1700 Syntax word-forward-select
1703 \begin_layout Subsection*
1707 \begin_layout Description
1708 Action Moves the cursor to the next beginning of a word "on the left".
1712 \begin_layout Description
1713 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1715 Generally, it moves the cursor to the next beginning of a word on the left.
1716 However, in Bidi text this become slightly more complicated, and there
1717 are different modes of cursor movement.
1718 In "visual mode", this moves left, plain and simple.
1719 In "logical mode", movement is logically forward in RTL paragraphs, and
1720 logically backwards in LTR paragraphs.
1724 \begin_layout Description
1728 \begin_layout Description
1729 Origin dov, 28 Oct 2007
1732 \begin_layout Subsection*
1733 LFUN_WORD_LEFT_SELECT
1736 \begin_layout Description
1737 Action Moves the cursor to the next beginning of a word "on the left", adding
1738 *logically* traversed text to the selection.
1742 \begin_layout Description
1743 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1747 \begin_layout Description
1748 Syntax word-left-select
1751 \begin_layout Description
1752 Origin dov, 28 Oct 2007
1755 \begin_layout Subsection*
1759 \begin_layout Description
1760 Action Moves the cursor to the next beginning of a word "on the right".
1764 \begin_layout Description
1765 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1767 Generally, it moves the cursor to the next beginning of a word on the right.
1768 However, in Bidi text this become slightly more complicated, and there
1769 are different modes of cursor movement.
1770 In "visual mode", this moves right, plain and simple.
1771 In "logical mode", movement is logically forward in LTR paragraphs, and
1772 logically backwards in RTL paragraphs.
1776 \begin_layout Description
1780 \begin_layout Description
1781 Origin dov, 28 Oct 2007
1784 \begin_layout Subsection*
1785 LFUN_WORD_RIGHT_SELECT
1788 \begin_layout Description
1789 Action Moves the cursor to the next beginning of a word "on the right",
1790 adding *logically* traversed text to the selection.
1794 \begin_layout Description
1795 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1799 \begin_layout Description
1800 Syntax word-right-select
1803 \begin_layout Description
1804 Origin dov, 28 Oct 2007
1807 \begin_layout Subsection*
1811 \begin_layout Description
1812 Action Puts the word where the cursor stands into the selection.
1816 \begin_layout Description
1820 \begin_layout Description
1821 Origin Andre, 11 Sep 2002
1824 \begin_layout Subsection*
1825 LFUN_WORD_CAPITALIZE
1828 \begin_layout Description
1829 Action Capitalizes the words in the selection (i.e.
1830 the first letters) or the letter on the cursor position.
1834 \begin_layout Description
1835 Syntax word-capitalize
1838 \begin_layout Subsection*
1842 \begin_layout Description
1843 Action Change the words in the selection or from the cursor position to
1844 the end of word to the upper case.
1848 \begin_layout Description
1852 \begin_layout Subsection*
1856 \begin_layout Description
1857 Action Change the words in the selection or from the cursor position to
1858 the end of word to the lower case.
1862 \begin_layout Description
1866 \begin_layout Subsection*
1867 LFUN_THESAURUS_ENTRY
1870 \begin_layout Description
1871 Action Look up thesaurus entries with respect to the word under the cursor.
1875 \begin_layout Description
1876 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1879 \begin_layout Description
1880 Params <STRING>: word to look up <LANG>: language (see file languages)
1884 \begin_layout Description
1885 Origin Levon, 20 Jul 2001
1888 \begin_layout Subsection*
1892 \begin_layout Description
1893 Action Move the cursor to the beginning of the document.
1897 \begin_layout Description
1901 \begin_layout Subsection*
1902 LFUN_BUFFER_BEGIN_SELECT
1905 \begin_layout Description
1906 Action Move the cursor to the beginning of the document adding the traversed
1907 text to the selection.
1911 \begin_layout Description
1912 Syntax buffer-begin-select
1915 \begin_layout Subsection*
1919 \begin_layout Description
1920 Action Move the cursor to the end of the document.
1924 \begin_layout Description
1928 \begin_layout Subsection*
1929 LFUN_BUFFER_END_SELECT
1932 \begin_layout Description
1933 Action Move the cursor to the end of the document adding the traversed text
1938 \begin_layout Description
1939 Syntax buffer-end-select
1942 \begin_layout Subsection*
1946 \begin_layout Description
1947 Action Move the cursor to the beginning of the current inset if it is not
1948 already there, or at the beginning of the enclosing inset otherwise
1951 \begin_layout Description
1955 \begin_layout Description
1956 Origin JMarc, 2009/03/16
1959 \begin_layout Subsection*
1960 LFUN_INSET_BEGIN_SELECT
1963 \begin_layout Description
1964 Action Move the cursor to the beginning of the current inset if it is not
1965 already there, or at the beginning of the enclosing inset otherwise (adding
1966 the traversed text to the selection).
1970 \begin_layout Description
1971 Syntax inset-begin-select
1974 \begin_layout Description
1975 Origin JMarc, 2009/03/16
1978 \begin_layout Subsection*
1982 \begin_layout Description
1983 Action Move the cursor to the end of the current inset if it is not already
1984 there, or at the end of the enclosing inset otherwise
1987 \begin_layout Description
1991 \begin_layout Description
1992 Origin JMarc, 2009/03/16
1995 \begin_layout Subsection*
1996 LFUN_INSET_END_SELECT
1999 \begin_layout Description
2000 Action Move the cursor to the end of the current inset if it is not already
2001 there, or at the end of the enclosing inset otherwise (adding the traversed
2002 text to the selection).
2006 \begin_layout Description
2007 Syntax inset-end-select
2010 \begin_layout Description
2011 Origin JMarc, 2009/03/16
2014 \begin_layout Subsection*
2018 \begin_layout Description
2019 Action Move the cursor to the begining of the (screen) line.
2023 \begin_layout Description
2027 \begin_layout Subsection*
2028 LFUN_LINE_BEGIN_SELECT
2031 \begin_layout Description
2032 Action Move the cursor to the beginning of the (screen) line adding the
2033 traversed text to the selection.
2037 \begin_layout Description
2038 Syntax line-begin-select
2041 \begin_layout Subsection*
2045 \begin_layout Description
2046 Action Move the cursor to the end of the (screen) line.
2050 \begin_layout Description
2054 \begin_layout Subsection*
2055 LFUN_LINE_END_SELECT
2058 \begin_layout Description
2059 Action Move the cursor to the end of the (screen) line adding the traversed
2060 text to the selection.
2064 \begin_layout Description
2065 Syntax line-end-select
2068 \begin_layout Subsection*
2072 \begin_layout Description
2073 Action Deletes the letters to the end of the (screen) line or deletes the
2078 \begin_layout Description
2079 Syntax line-delete-forward
2082 \begin_layout Subsection*
2086 \begin_layout Description
2087 Action Copies to the clipboard the last edit.
2091 \begin_layout Description
2095 \begin_layout Subsection*
2099 \begin_layout Description
2100 Action Cuts to the clipboard.
2104 \begin_layout Description
2108 \begin_layout Subsection*
2112 \begin_layout Description
2113 Action Pastes material from the active clipboard.
2117 \begin_layout Description
2118 Syntax paste [<TYPE>]
2121 \begin_layout Description
2122 Params <TYPE>: pdf|png|jpeg|linkback
2125 \begin_layout Subsection*
2126 LFUN_CLIPBOARD_PASTE
2129 \begin_layout Description
2130 Action Pastes text from the active clipboard.
2134 \begin_layout Description
2135 Syntax clipboard-paste [<ARG>]
2138 \begin_layout Description
2139 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2144 \begin_layout Description
2145 Origin baum, 10 Jul 2006
2148 \begin_layout Subsection*
2149 LFUN_PRIMARY_SELECTION_PASTE
2152 \begin_layout Description
2153 Action Pastes the currently text selected text.
2157 \begin_layout Description
2158 Notion Primary selection mechanism is linux-only thing.
2162 \begin_layout Description
2163 Syntax primary-selection-paste [<ARG>]
2166 \begin_layout Description
2167 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2172 \begin_layout Subsection*
2173 LFUN_SELECTION_PASTE
2176 \begin_layout Description
2177 Action Pastes the text in permanent selection.
2181 \begin_layout Description
2182 Syntax selection-paste
2185 \begin_layout Subsection*
2189 \begin_layout Description
2190 Action Undoes the last edit.
2194 \begin_layout Description
2198 \begin_layout Subsection*
2202 \begin_layout Description
2203 Action Redoes the last thing undone.
2207 \begin_layout Description
2211 \begin_layout Subsection*
2215 \begin_layout Description
2216 Action Repeat the given command.
2220 \begin_layout Description
2221 Syntax repeat <COUNT> <LFUN-COMMAND>
2224 \begin_layout Description
2225 Origin Andre, 27 Oct 2003
2228 \begin_layout Subsection*
2229 LFUN_CHARS_TRANSPOSE
2232 \begin_layout Description
2233 Action Transposes the character at the cursor with the one before it.
2237 \begin_layout Description
2238 Syntax chars-transpose
2241 \begin_layout Description
2242 Origin Lgb, 25 Apr 2001
2245 \begin_layout Subsection*
2246 LFUN_DEPTH_DECREMENT
2249 \begin_layout Description
2250 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2255 \begin_layout Description
2256 Syntax depth-decrement
2259 \begin_layout Subsection*
2260 LFUN_DEPTH_INCREMENT
2263 \begin_layout Description
2264 Action Increase the nesting depth of the (selected) paragraph(s) inside
2269 \begin_layout Description
2270 Syntax depth-increment
2273 \begin_layout Subsection*
2277 \begin_layout Description
2278 Action Toggles the bold font (selection-wise) using mathbf in math.
2282 \begin_layout Description
2286 \begin_layout Subsection*
2287 LFUN_FONT_BOLDSYMBOL
2290 \begin_layout Description
2291 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2295 \begin_layout Description
2296 Syntax font-boldsymbol
2299 \begin_layout Subsection*
2300 LFUN_FONT_TYPEWRITER
2303 \begin_layout Description
2304 Action Toggles the typewriter family font (selection-wise).
2308 \begin_layout Description
2309 Syntax font-typewriter
2312 \begin_layout Subsection*
2316 \begin_layout Description
2317 Action Toggles underline in the font (selection-wise).
2321 \begin_layout Description
2322 Syntax font-underline
2325 \begin_layout Subsection*
2329 \begin_layout Description
2330 Action Toggles the emphasis font style (selection-wise).
2334 \begin_layout Description
2338 \begin_layout Subsection*
2342 \begin_layout Description
2343 Action Toggles Noun text style font (selection-wise).
2347 \begin_layout Description
2351 \begin_layout Subsection*
2355 \begin_layout Description
2356 Action Toggles Roman family font (selection-wise).
2360 \begin_layout Description
2364 \begin_layout Subsection*
2368 \begin_layout Description
2369 Action Toggles Sans Serif family font (selection-wise).
2373 \begin_layout Description
2377 \begin_layout Subsection*
2381 \begin_layout Description
2382 Action Toggles Fraktur family font (math-mode, selection-wise).
2386 \begin_layout Description
2390 \begin_layout Description
2391 Origin vermeer, 10 Jan 2002
2394 \begin_layout Subsection*
2398 \begin_layout Description
2399 Action Toggles Italics font shape (math-mode, selection-wise).
2403 \begin_layout Description
2407 \begin_layout Description
2408 Origin vermeer, 10 Jan 2002
2411 \begin_layout Subsection*
2415 \begin_layout Description
2416 Action Reverts the settings of the font to the default values (selection-wise).
2420 \begin_layout Description
2424 \begin_layout Subsection*
2428 \begin_layout Description
2429 Action Sets font size according to lyx format string.
2433 \begin_layout Description
2434 Syntax font-size <SIZE>
2437 \begin_layout Description
2438 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2439 \begin_inset Newline newline
2442 largest|huge|giant|increase|decrease|default
2445 \begin_layout Subsection*
2446 LFUN_TEXTSTYLE_APPLY
2449 \begin_layout Description
2450 Action Toggle user-defined (=last-time used) text style.
2454 \begin_layout Description
2455 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2456 trigerred when using Text Style dialog.
2460 \begin_layout Description
2461 Syntax textstyle-apply
2464 \begin_layout Description
2465 Origin leeming, 12 Mar 2003
2468 \begin_layout Subsection*
2469 LFUN_TEXTSTYLE_UPDATE
2472 \begin_layout Description
2473 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2478 \begin_layout Description
2479 Syntax textstyle-update <FONT_INFO>
2482 \begin_layout Description
2483 Params <FONT_INFO>: specifies font atributes, e.g.
2484 family, series, shape, size, emph, noun, underbar, number, color, language,
2487 \begin_inset Newline newline
2490 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2494 \begin_layout Description
2495 Origin leeming, 12 Mar 2003
2498 \begin_layout Subsection*
2499 LFUN_SCREEN_FONT_UPDATE
2502 \begin_layout Description
2503 Action Update fonts and its metrics.
2507 \begin_layout Description
2508 Notion Automatically called after zoom, dpi, font names, or norm change.
2512 \begin_layout Description
2513 Syntax screen-font-update
2516 \begin_layout Description
2517 Origin ARRae, 13 Aug 2000
2520 \begin_layout Subsection*
2524 \begin_layout Description
2525 Action Returns the info about the current font.
2529 \begin_layout Description
2533 \begin_layout Subsection*
2534 LFUN_CITATION_INSERT
2537 \begin_layout Description
2538 Action Inserts citation from loaded citation database.
2542 \begin_layout Description
2543 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2546 \begin_layout Description
2547 Params <KEY>: Citation (shortcut listed in available citations).
2549 \begin_inset Newline newline
2552 <TEXT_BEFORE>: text which should appear before citation.
2556 \begin_layout Description
2557 Origin AAS, 97-02-23
2560 \begin_layout Subsection*
2561 LFUN_BIBTEX_DATABASE_ADD
2564 \begin_layout Description
2565 Action Adds database, which will be used for bibtex citations.
2569 \begin_layout Description
2570 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2571 bibliography) found from the cursor postion.
2575 \begin_layout Description
2576 Syntax bibtex-database-add <DATABASE-NAME>
2579 \begin_layout Description
2580 Origin Ale, 30 May 1997
2583 \begin_layout Subsection*
2584 LFUN_BIBTEX_DATABASE_DEL
2587 \begin_layout Description
2588 Action Adds database, which will be used for bibtex citations.
2592 \begin_layout Description
2593 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2594 X bibliography) found from the cursor postion.
2598 \begin_layout Description
2599 Syntax bibtex-database-del <DATABASE-NAME>
2602 \begin_layout Description
2603 Origin Ale, 30 May 1997
2606 \begin_layout Subsection*
2610 \begin_layout Description
2611 Action Sets the layout (that is, environment) for the current paragraph.
2615 \begin_layout Description
2616 Syntax layout <LAYOUT>
2619 \begin_layout Description
2620 Params <LAYOUT>: the layout to use
2623 \begin_layout Subsection*
2624 LFUN_LAYOUT_PARAGRAPH
2627 \begin_layout Description
2628 Action Launches the paragraph settings dialog.
2632 \begin_layout Description
2633 Syntax layout-paragraph
2636 \begin_layout Subsection*
2640 \begin_layout Description
2641 Action Launches the tabular settings dialog.
2645 \begin_layout Description
2646 Syntax layout-tabular
2649 \begin_layout Description
2650 Origin Jug, 31 Jul 2000
2653 \begin_layout Subsection*
2654 LFUN_DROP_LAYOUTS_CHOICE
2657 \begin_layout Description
2658 Action Displays list of layout choices.
2662 \begin_layout Description
2663 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2664 allowing for choice of layout.
2668 \begin_layout Description
2669 Syntax drop-layouts-choice
2672 \begin_layout Subsection*
2673 LFUN_LAYOUT_MODULES_CLEAR
2676 \begin_layout Description
2677 Action Clears the module list.
2681 \begin_layout Description
2682 Notion Clears the list of included modules for the current buffer.
2686 \begin_layout Description
2687 Syntax layout-modules-clear
2690 \begin_layout Description
2691 Origin rgh, 25 August 2007
2694 \begin_layout Subsection*
2695 LFUN_LAYOUT_MODULE_ADD
2698 \begin_layout Description
2699 Action Adds a module.
2703 \begin_layout Description
2704 Notion Adds a module to the list of included modules for the current buffer.
2708 \begin_layout Description
2709 Syntax layout-module-add <MODULE>
2712 \begin_layout Description
2713 Params <MODULE>: the module to be added
2716 \begin_layout Description
2717 Origin rgh, 25 August 2007
2720 \begin_layout Subsection*
2724 \begin_layout Description
2725 Action Reloads layout information.
2729 \begin_layout Description
2730 Notion Reloads all layout information for the current buffer from disk,
2731 thus recognizing any changes that have been made to layout files on the
2733 This is intended to be used only by layout developers and should not be
2734 used when one is trying to do actual work.
2738 \begin_layout Description
2739 Syntax layout-reload
2742 \begin_layout Description
2743 Origin rgh, 3 September 2007
2746 \begin_layout Subsection*
2747 LFUN_TEXTCLASS_APPLY
2750 \begin_layout Description
2751 Action Sets the text class for the current buffer.
2755 \begin_layout Description
2756 Syntax textclass-apply <TEXTCLASS>
2759 \begin_layout Description
2760 Params <TEXTCLASS>: the textclass to set.
2761 Note that this must be the filename, minus the ".layout" extension.
2765 \begin_layout Subsection*
2769 \begin_layout Description
2770 Action Loads information for a textclass from disk.
2774 \begin_layout Description
2775 Syntax textclass-load <TEXTCLASS>
2778 \begin_layout Description
2779 Params <TEXTCLASS>: the textclass to load.
2780 Note that this must be the filename, minus the ".layout" extension.
2784 \begin_layout Subsection*
2788 \begin_layout Description
2789 Action Disable selecting of text-region.
2793 \begin_layout Description
2797 \begin_layout Subsection*
2801 \begin_layout Description
2802 Action Enable selecting of text-region.
2806 \begin_layout Description
2807 Notion After enabling you can simply move arrow keys to get selected region.
2811 \begin_layout Description
2815 \begin_layout Subsection*
2819 \begin_layout Description
2820 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2824 \begin_layout Description
2828 \begin_layout Description
2829 Origin Andre, May 5 2006
2832 \begin_layout Subsection*
2836 \begin_layout Description
2837 Action Inserts math delimiters (e.g.
2838 parentheses, brackets) enclosing expression.
2842 \begin_layout Description
2843 Syntax math-delim [<LEFT>] [<RIGHT>]
2846 \begin_layout Description
2847 Params <LEFT/RIGHT>: Delimiters to be used.
2848 Each delimiter can be specified by either a LaTeX name or a valid character.
2849 ( is the default letter.
2853 \begin_layout Description
2854 Sample math-delim { rangle
2857 \begin_layout Description
2858 Origin Alejandro, 18 Jun 1996
2861 \begin_layout Subsection*
2865 \begin_layout Description
2866 Action Inserts math fixed size delimiters (e.g.
2867 parentheses, brackets) enclosing expression.
2871 \begin_layout Description
2872 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2875 \begin_layout Description
2876 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2877 \begin_inset Newline newline
2880 <L/RDELIM>: TeX code for delimiter.
2881 See Delimiter dialog for delimiters to be used.
2885 \begin_layout Description
2886 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2889 \begin_layout Description
2890 Origin Enrico & Georg, 7 May 2006
2893 \begin_layout Subsection*
2897 \begin_layout Description
2898 Action Creates a new displayed equation in text mode.
2899 Toggles inlined/display formula in math mode.
2903 \begin_layout Description
2904 Syntax math-display [<ARG>]
2907 \begin_layout Description
2908 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2909 new equation from the text mode.
2913 \begin_layout Description
2914 Origin Alejandro, 18 Jun 1996
2917 \begin_layout Subsection*
2921 \begin_layout Description
2922 Action Inserts math objects and symbols.
2926 \begin_layout Description
2927 Syntax math-insert <ARG>
2930 \begin_layout Description
2931 Params <ARG>: Symbol or LaTeX code to be inserted.
2935 \begin_layout Subsection*
2939 \begin_layout Description
2940 Action Enters subscript expression in math expression.
2944 \begin_layout Description
2945 Syntax math-subscript
2948 \begin_layout Description
2949 Origin vermeer, 12 Dec 2001
2952 \begin_layout Subsection*
2953 LFUN_MATH_SUPERSCRIPT
2956 \begin_layout Description
2957 Action Enters subscript expression in math expression.
2961 \begin_layout Description
2962 Syntax math-superscript
2965 \begin_layout Description
2966 Origin vermeer, 12 Dec 2001
2969 \begin_layout Subsection*
2973 \begin_layout Description
2974 Action Toggles the position of the limits from above/below to the right
2975 side an vice versa in integral symbol, a limit, a summation, etc.
2979 \begin_layout Description
2980 Notion Put the cursor before the symbol with the limits and then invoke
2985 \begin_layout Description
2986 Syntax math-limits [<STATE>]
2989 \begin_layout Description
2990 Params <STATE>: limits|nolimits
2993 \begin_layout Subsection*
2997 \begin_layout Description
2998 Action Inserts a math macro definition at the cursor position in the text.
3002 \begin_layout Description
3003 Syntax math-macro <NAME> [<NARGS>] [def]
3006 \begin_layout Description
3007 Params <NAME>: The name of the macro, e.g.
3009 <NARGS>: The number of parameters of the macro.
3011 "def": Has no effect anymore, just for compatibility with former LyX versions.
3015 \begin_layout Description
3016 Origin ale, 10 May 1997; sts, 21 Dec 2007
3019 \begin_layout Subsection*
3023 \begin_layout Description
3024 Action Mutates the type of math inset to the newly selected one.
3028 \begin_layout Description
3029 Syntax math-mutate <TYPE>
3032 \begin_layout Description
3033 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
3034 multline|gather|flalign
3037 \begin_layout Description
3038 Origin Andre, 23 May 2001
3041 \begin_layout Subsection*
3045 \begin_layout Description
3046 Action Inserts space into math expression.
3050 \begin_layout Description
3051 Notion Use spacebar after entering this space to change type of space.
3055 \begin_layout Description
3056 Syntax math-space [<TYPE>] [<LEN>]
3059 \begin_layout Description
3060 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
3062 \begin_inset Newline newline
3065 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
3067 \begin_inset Newline newline
3070 custom space: hspace
3071 \begin_inset Newline newline
3074 "," used by default.
3075 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
3077 <LEN>: length for custom spaces (hspace)
3080 \begin_layout Description
3081 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
3084 \begin_layout Subsection*
3088 \begin_layout Description
3089 Action Inserts a matrix.
3093 \begin_layout Description
3094 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3097 \begin_layout Description
3098 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3100 1 char) and the horizontal alignments (l, c or r) (i.e.
3105 \begin_layout Description
3106 Sample math-matrix 3 3 bccc
3109 \begin_layout Subsection*
3113 \begin_layout Description
3114 Action In text mode enters math mode (i.e.
3115 puts math insets on the current cursor position), in math mode enters text
3116 mode inside math expression.
3120 \begin_layout Description
3121 Notion If there is some selected text, it puts the text inside created math
3126 \begin_layout Description
3127 Syntax math-mode [<ARG>]
3130 \begin_layout Description
3131 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3136 \begin_layout Description
3137 Origin Alejandro, 4 Jun 1996
3140 \begin_layout Subsection*
3144 \begin_layout Description
3145 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3147 Used by the advanced search dialog.
3151 \begin_layout Description
3152 Notion If there is any selected text, then it is moved inside the created
3157 \begin_layout Description
3158 Syntax regexp-mode [<ARG>]
3161 \begin_layout Description
3162 Params <ARG>: eventual argument (regular expression).
3166 \begin_layout Description
3167 Origin Tommaso, 4 Oct 2008
3170 \begin_layout Subsection*
3171 LFUN_MATH_NUMBER_LINE_TOGGLE
3174 \begin_layout Description
3175 Action Toggles numbering of the current formula line.
3179 \begin_layout Description
3180 Notion Must be in display formula mode.
3184 \begin_layout Description
3185 Syntax math-number-line-toggle
3188 \begin_layout Description
3189 Origin Alejandro, 18 Jun 1996
3192 \begin_layout Subsection*
3193 LFUN_MATH_NUMBER_TOGGLE
3196 \begin_layout Description
3197 Action Toggles numbering/labeling of the current formula.
3201 \begin_layout Description
3202 Notion Must be in display formula mode.
3206 \begin_layout Description
3207 Syntax math-number-toggle
3210 \begin_layout Description
3211 Origin Alejandro, 4 Jun 1996
3214 \begin_layout Subsection*
3218 \begin_layout Description
3219 Action Calls external program and passes the current expression/equation
3220 as an argument for the calculation in the format appropriate to the given
3225 \begin_layout Description
3226 Notion Selection can be used to determine the input for the external program.
3230 \begin_layout Description
3231 Syntax math-extern <LANG> [<COMMAND>]
3234 \begin_layout Description
3235 Params <LANG>: octave|maxima|maple|mathematica|script
3236 \begin_inset Newline newline
3239 where "script" stands fot the external script (normalized expression will
3243 \begin_layout Description
3244 Origin Andre, 24 Apr 2001
3247 \begin_layout Description
3248 Sample math-extern maple simplify
3251 \begin_layout Subsection*
3255 \begin_layout Description
3256 Action Changes arbitrarily the size used by math fonts inside a context.
3260 \begin_layout Description
3261 Notion Provides an interface to the LaTeX math mode font size commands.
3265 \begin_layout Description
3266 Syntax math-size <STYLE>
3269 \begin_layout Description
3270 Params <STYLE>: displaystyle|
3279 \begin_layout Description
3280 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3283 \begin_layout Subsection*
3284 LFUN_MATH_FONT_STYLE
3287 \begin_layout Description
3288 Action Changes the text style used in math.
3292 \begin_layout Description
3293 Syntax math-font-style <STYLE>
3296 \begin_layout Description
3297 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
3298 trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
3301 \begin_layout Description
3302 Origin vfr, 9 jan 2009
3305 \begin_layout Subsection*
3306 LFUN_MATH_MACRO_UNFOLD
3309 \begin_layout Description
3310 Action Unfold a Math Macro.
3314 \begin_layout Description
3315 Notion Unfold the Math Macro the cursor is in, i.e.
3320 \begin_layout Description
3321 Syntax math-macro-unfold
3324 \begin_layout Description
3325 Origin sts, 06 January 2008
3328 \begin_layout Subsection*
3329 LFUN_MATH_MACRO_FOLD
3332 \begin_layout Description
3333 Action Fold a Math Macro.
3337 \begin_layout Description
3338 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3339 displayed as foo before.
3343 \begin_layout Description
3344 Syntax math-macro-fold
3347 \begin_layout Description
3348 Origin sts, 06 January 2008
3351 \begin_layout Subsection*
3352 LFUN_MATH_MACRO_ADD_PARAM
3355 \begin_layout Description
3356 Action Add a parameter.
3360 \begin_layout Description
3361 Notion Add a parameter to a Math Macro.
3365 \begin_layout Description
3366 Params <NUM>: The number of the parameter behind which the new one will
3367 be added (1 for the first, i.e.
3368 use 0 for add a parameter at the left), defaults to the last one.
3372 \begin_layout Description
3373 Syntax math-macro-add-param <NUM>
3376 \begin_layout Description
3377 Origin sts, 06 January 2008
3380 \begin_layout Subsection*
3381 LFUN_MATH_MACRO_REMOVE_PARAM
3384 \begin_layout Description
3385 Action Remove the last parameter.
3389 \begin_layout Description
3390 Notion Remove the last parameter of a Math Macro and remove its value in
3391 all instances of the macro in the buffer.
3395 \begin_layout Description
3396 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3397 defaults to the last one.
3401 \begin_layout Description
3402 Syntax math-macro-remove-param <NUM>
3405 \begin_layout Description
3406 Origin sts, 06 January 2008
3409 \begin_layout Subsection*
3410 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3413 \begin_layout Description
3414 Action Append a greedy parameter.
3418 \begin_layout Description
3419 Notion Append a greedy parameter to a Math Macro which eats the following
3420 mathed cell in every instance of the macro in the buffer.
3424 \begin_layout Description
3425 Syntax math-macro-append-greedy-param
3428 \begin_layout Description
3429 Origin sts, 06 January 2008
3432 \begin_layout Subsection*
3433 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3436 \begin_layout Description
3437 Action Remove a greedy parameter.
3441 \begin_layout Description
3442 Notion Remove a greedy parameter of a Math Macro and spit out the values
3443 of it in every instance of the macro in the buffer.
3444 If it is an optional parameter the [valud] format is used.
3448 \begin_layout Description
3449 Syntax math-macro-remove-greedy-param
3452 \begin_layout Description
3453 Origin sts, 06 January 2008
3456 \begin_layout Subsection*
3457 LFUN_MATH_MACRO_MAKE_OPTIONAL
3460 \begin_layout Description
3461 Action Make a parameter optional.
3465 \begin_layout Description
3466 Notion Turn the first non-optional parameter of a Math Macro into an optional
3467 parameter with a default value.
3471 \begin_layout Description
3472 Syntax math-macro-make-optional
3475 \begin_layout Description
3476 Origin sts, 06 January 2008
3479 \begin_layout Subsection*
3480 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3483 \begin_layout Description
3484 Action Make a parameter non-optional.
3488 \begin_layout Description
3489 Notion Turn the last optional parameter of a Math Macro into a non-optional
3491 The default value is remembered to be reused later if the user changes
3496 \begin_layout Description
3497 Syntax math-macro-make-nonoptional
3500 \begin_layout Description
3501 Origin sts, 06 January 2008
3504 \begin_layout Subsection*
3505 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3508 \begin_layout Description
3509 Action Add an optional parameter.
3513 \begin_layout Description
3514 Notion Insert an optional parameter just behind the already existing optional
3519 \begin_layout Description
3520 Syntax math-macro-add-optional-param
3523 \begin_layout Description
3524 Origin sts, 06 January 2008
3527 \begin_layout Subsection*
3528 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3531 \begin_layout Description
3532 Action Remove the last optional parameter.
3536 \begin_layout Description
3537 Notion Remove the last optional parameter of a Math Macro and remove it
3538 in all the instances of the macro in the buffer.
3542 \begin_layout Description
3543 Syntax math-macro-remove-optional-param
3546 \begin_layout Description
3547 Origin sts, 06 January 2008
3550 \begin_layout Subsection*
3551 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3554 \begin_layout Description
3555 Action Add a greedy optional parameter.
3559 \begin_layout Description
3560 Notion Add a greedy optional parameter which eats the value from the following
3561 cells in mathed which are in the [value] format.
3565 \begin_layout Description
3566 Syntax math-macro-add-greedy-optional-param
3569 \begin_layout Description
3570 Origin sts, 06 January 2008
3573 \begin_layout Subsection*
3574 LFUN_IN_MATHMACROTEMPLATE
3577 \begin_layout Description
3578 Action Only active in Math Macro definition.
3582 \begin_layout Description
3583 Notion Dummy function which is only active in a Math Macro definition.
3584 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3589 \begin_layout Description
3590 Syntax in-mathmacrotemplate
3593 \begin_layout Description
3594 Origin sts, 06 January 2008
3597 \begin_layout Subsection*
3598 LFUN_PARAGRAPH_MOVE_DOWN
3601 \begin_layout Description
3602 Action Moves the current paragraph downwards in the document.
3606 \begin_layout Description
3607 Syntax paragraph-move-down
3610 \begin_layout Description
3611 Origin Edwin, 8 Apr 2006
3614 \begin_layout Subsection*
3615 LFUN_PARAGRAPH_MOVE_UP
3618 \begin_layout Description
3619 Action Moves the current paragraph upwards in the document.
3623 \begin_layout Description
3624 Syntax paragraph-move-up
3627 \begin_layout Description
3628 Origin Edwin, 8 Apr 2006
3631 \begin_layout Subsection*
3635 \begin_layout Description
3636 Action Move the cursor to the next paragraph (or begining of the current
3637 one) in upward direction.
3641 \begin_layout Description
3645 \begin_layout Description
3646 Origin Asger, 1 Oct 1996
3649 \begin_layout Subsection*
3650 LFUN_PARAGRAPH_UP_SELECT
3653 \begin_layout Description
3654 Action Move the cursor and select the text to the next paragraph (or begining
3655 of the current one) in upward direction.
3659 \begin_layout Description
3660 Syntax paragraph-up-select
3663 \begin_layout Description
3664 Origin Asger, 1 Oct 1996
3667 \begin_layout Subsection*
3671 \begin_layout Description
3672 Action Move the cursor to the next paragraph (or begining of the current
3673 one) in downward direction.
3677 \begin_layout Description
3678 Syntax paragraph-down
3681 \begin_layout Description
3682 Origin Asger, 1 Oct 1996
3685 \begin_layout Subsection*
3686 LFUN_PARAGRAPH_DOWN_SELECT
3689 \begin_layout Description
3690 Action Move the cursor and select the text to the next paragraph (or begining
3691 of the current one) in downward direction.
3695 \begin_layout Description
3696 Syntax paragraph-down-select
3699 \begin_layout Description
3700 Origin Asger, 1 Oct 1996
3703 \begin_layout Subsection*
3707 \begin_layout Description
3708 Action Jump to a paragraph given by its id number and optionally the desired
3709 position within the paragraph.
3713 \begin_layout Description
3714 Notion Note that id number of paragraph is not the sequential number of
3715 paragraph seen on the screen.
3716 Moreover the id is unique for all opened buffers (documents).
3720 \begin_layout Description
3721 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3724 \begin_layout Description
3725 Params <PAR_ID_NUMBER>: paragraph id
3726 \begin_inset Newline newline
3729 <POSITION_IN_PAR>: desired position within the paragraph
3732 \begin_layout Description
3733 Origin Dekel, 26 Aug 2000
3736 \begin_layout Subsection*
3737 LFUN_BREAK_PARAGRAPH
3740 \begin_layout Description
3741 Action Breaks the current paragraph at the current location.
3745 \begin_layout Description
3746 Syntax break-paragraph
3749 \begin_layout Subsection*
3750 LFUN_BREAK_PARAGRAPH
3753 \begin_layout Description
3754 Action Breaks the current paragraph at the current location.
3758 \begin_layout Description
3759 Notion Removes the selection.
3763 \begin_layout Description
3764 Syntax break-paragraph [<LAYOUT>]
3767 \begin_layout Description
3768 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3769 default layout) when the cursor is at the end of the line.
3773 \begin_layout Subsection*
3774 LFUN_PARAGRAPH_PARAMS
3777 \begin_layout Description
3778 Action Change paragraph settings.
3782 \begin_layout Description
3783 Notion Modifies the current paragraph, or currently selected paragraphs.
3784 This function only modifies, and does not override, existing settings.
3785 Note that the "leftindent" indent setting is deprecated.
3789 \begin_layout Description
3790 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3793 \begin_layout Description
3803 \begin_inset Newline newline
3808 paragraph_spacing default|single|onehalf|double|other
3809 \begin_inset Newline newline
3814 align block|left|right|center|default
3815 \begin_inset Newline newline
3820 labelwidthstring WIDTH|
3823 \begin_inset Newline newline
3829 \begin_layout Description
3830 Origin rgh, Aug 15 2007
3833 \begin_layout Subsection*
3834 LFUN_PARAGRAPH_PARAMS_APPLY
3837 \begin_layout Description
3838 Action Change paragraph settings.
3842 \begin_layout Description
3843 Notion Overwrite all nonspecified settings to the default ones.
3844 Use paragraph-params lfun if you don't want to overwrite others settings.
3848 \begin_layout Description
3849 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3852 \begin_layout Description
3853 Params For parameters see LFUN_PARAGRAPH_PARAMS
3856 \begin_layout Description
3857 Origin leeming, 30 Mar 2004
3860 \begin_layout Subsection*
3861 LFUN_PARAGRAPH_UPDATE
3864 \begin_layout Description
3865 Action Updates the values inside the paragraph dialog from the paragraph.
3869 \begin_layout Description
3870 Notion This is internal LFUN, not to be used by users.
3871 Called internally by LFUN_DIALOG_UPDATE.
3875 \begin_layout Description
3876 Origin leeming, 13 Mar 2003
3879 \begin_layout Subsection*
3883 \begin_layout Description
3884 Action Move the current group in the upward direction in the structure of
3889 \begin_layout Description
3890 Notion The "group" can be Part/Chapter/Section/etc.
3891 It moves the whole substructure of the group.
3895 \begin_layout Description
3899 \begin_layout Description
3900 Origin Vermeer, 23 Mar 2006
3903 \begin_layout Subsection*
3907 \begin_layout Description
3908 Action Move the current group in the downward direction in the structure
3913 \begin_layout Description
3914 Notion The "group" can be Part/Chapter/Section/etc.
3915 It moves the whole substructure of the group.
3919 \begin_layout Description
3923 \begin_layout Description
3924 Origin Vermeer, 23 Mar 2006
3927 \begin_layout Subsection*
3931 \begin_layout Description
3932 Action Moves the current group in the downward direction in the hierarchy
3933 of the document structure.
3937 \begin_layout Description
3938 Notion Part -> Chapter -> Section -> etc.
3942 \begin_layout Description
3946 \begin_layout Description
3947 Origin Vermeer, 23 Mar 2006
3950 \begin_layout Subsection*
3954 \begin_layout Description
3955 Action Moves the current group in the upward direction in the hierarchy
3956 of the document structure.
3960 \begin_layout Description
3961 Notion Part <- Chapter <- Section <- etc.
3965 \begin_layout Description
3969 \begin_layout Description
3970 Origin Vermeer, 23 Mar 2006
3973 \begin_layout Subsection*
3977 \begin_layout Description
3978 Action Edit the inset at cursor with an external application, *
3979 if one is attributed.
3983 \begin_layout Description
3984 Syntax inset-edit [<INSET_PARAMS>]
3987 \begin_layout Description
3988 Params <INSET_PARAMS>: Parameters for the inset.
3990 \begin_inset Newline newline
3993 Currently only the filename will be considered.
3997 \begin_layout Description
3998 Origin JSpitzm, 27 Apr 2006
4001 \begin_layout Subsection*
4005 \begin_layout Description
4006 Action Inserts table into the document.
4010 \begin_layout Description
4011 Syntax tabular-insert [<ROWS> <COLUMNS>]
4014 \begin_layout Description
4015 Params In case no arguments are given show insert dialog.
4019 \begin_layout Description
4020 Origin Jug, 12 Apr 2000
4023 \begin_layout Subsection*
4024 LFUN_TABULAR_FEATURE
4027 \begin_layout Description
4028 Action Sets various features to the table/cell on the current cursor position.
4032 \begin_layout Description
4033 Notion Various math-environment features are handled here as well, e.g.
4034 add-vline-left/right for the Grid/Array environment
4037 \begin_layout Description
4038 Syntax tabular-feature <FEATURE> [<ARG>]
4041 \begin_layout Description
4042 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
4043 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4044 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
4045 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
4046 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
4047 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
4048 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
4049 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
4050 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4051 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
4052 |set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
4053 ar-valign-middle|tabular-valign-bottom
4054 \begin_inset Newline newline
4057 <ARG>: additional argument for some commands, use debug mode to explore
4062 \begin_layout Description
4063 Origin Jug, 28 Jul 2000
4066 \begin_layout Subsection*
4070 \begin_layout Description
4071 Action Moves the cursor to the previous cell inside the table.
4075 \begin_layout Description
4076 Syntax cell-backward
4079 \begin_layout Description
4080 Origin Jug, 22 May 2000
4083 \begin_layout Subsection*
4087 \begin_layout Description
4088 Action Moves the cursor to the next cell inside the table.
4092 \begin_layout Description
4096 \begin_layout Subsection*
4100 \begin_layout Description
4101 Action Splits cell and shifts right part to the next cell (inside the math
4106 \begin_layout Description
4110 \begin_layout Description
4111 Origin Ale, 15 May 1997
4114 \begin_layout Subsection*
4118 \begin_layout Description
4119 Action Register the document as an file inside version control system (RCS,
4124 \begin_layout Description
4125 Notion File is registered inside cvs, svn or rcs repository acording to
4126 the existence of cvs/svn/rcs entries in the document's directory.
4128 \begin_inset Newline newline
4131 See LyX Additional Features Manual (Version Control Chapter) for additional
4136 \begin_layout Description
4140 \begin_layout Description
4141 Origin Lgb, 1 Jul 1997
4144 \begin_layout Subsection*
4148 \begin_layout Description
4149 Action Checks-in/commits the changes of the registered file to the repository.
4153 \begin_layout Description
4154 Notion In RCS case this also unlocks the file.
4158 \begin_layout Description
4162 \begin_layout Description
4163 Origin Lgb, 1 Jul 1997
4166 \begin_layout Subsection*
4170 \begin_layout Description
4171 Action Checks-out the document for edit (and locks it for RCS).
4175 \begin_layout Description
4176 Notion This is implemented only for RCS and SVN, not CVS.
4180 \begin_layout Description
4184 \begin_layout Description
4185 Origin Lgb, 1 Jul 1997
4188 \begin_layout Subsection*
4192 \begin_layout Description
4193 Action Reverts the document to the last check-in/commit in VCS.
4197 \begin_layout Description
4201 \begin_layout Description
4202 Origin Lgb, 1 Jul 1997
4205 \begin_layout Subsection*
4209 \begin_layout Description
4210 Action Undo last check-in.
4214 \begin_layout Description
4215 Notion This is currently implemented only for RCS.
4219 \begin_layout Description
4223 \begin_layout Description
4224 Origin Lgb, 1 Jul 1997
4227 \begin_layout Subsection*
4231 \begin_layout Description
4232 Action Executes external command.
4233 This command is intended to support additional VCS commands.
4237 \begin_layout Description
4238 Syntax vc-command <FLAG> <PATH> <COMMAND>
4241 \begin_layout Description
4242 Params <FLAG>: Flags for the command can be combined together.
4244 \begin_inset Newline newline
4247 U - dUmmy - no flags
4248 \begin_inset Newline newline
4251 D - Doc - need document loaded to proceed
4252 \begin_inset Newline newline
4255 I - dIrty - mark document dirty
4256 \begin_inset Newline newline
4259 R - Reload - ensure that the document is saved and reload it after command
4261 \begin_inset Newline newline
4264 M - Message - ask for input string (commit message)
4265 \begin_inset Newline newline
4268 <PATH>: path where to start.
4269 $$p will be replaced by the current document path.
4271 \begin_inset Newline newline
4274 <COMMAND>: command to execute.
4275 $$i/$$p/$$m will be replaced by the current document/path/message.
4279 \begin_layout Description
4280 Sample vc-command DR $$p "svn up"
4283 \begin_layout Description
4284 Origin sanda, 13 Jan 2009
4287 \begin_layout Subsection*
4291 \begin_layout Description
4292 Action Toggles change tracking to on/off.
4296 \begin_layout Description
4297 Syntax changes-track
4300 \begin_layout Description
4301 Origin levon, 1 Oct 2002
4304 \begin_layout Subsection*
4308 \begin_layout Description
4309 Action Toggles showing of change tracking in typesetted output.
4313 \begin_layout Description
4314 Syntax changes-output
4317 \begin_layout Description
4318 Origin jspitzm, 21 Jan 2005
4321 \begin_layout Subsection*
4325 \begin_layout Description
4326 Action Moves the cursor to the position of the next change of the change
4331 \begin_layout Description
4335 \begin_layout Description
4336 Origin schmitt, 4 Oct 2006
4339 \begin_layout Subsection*
4343 \begin_layout Description
4344 Action Open change tracking dialog for merging and moves the cursor to the
4345 position of the next change.
4349 \begin_layout Description
4350 Syntax changes-merge
4353 \begin_layout Description
4354 Origin Levon, 16 Oct 2002
4357 \begin_layout Subsection*
4361 \begin_layout Description
4362 Action Accepts tracked change inside the selection.
4366 \begin_layout Description
4367 Syntax change-accept
4370 \begin_layout Description
4371 Origin Levon, 16 Oct 2002
4374 \begin_layout Subsection*
4378 \begin_layout Description
4379 Action Rejects tracked change inside the selection.
4383 \begin_layout Description
4384 Syntax change-accept
4387 \begin_layout Description
4388 Origin Levon, 16 Oct 2002
4391 \begin_layout Subsection*
4392 LFUN_ALL_CHANGES_ACCEPT
4395 \begin_layout Description
4396 Action Accepts all tracked changes in the document.
4400 \begin_layout Description
4401 Syntax all-changes-accept
4404 \begin_layout Description
4405 Origin Levon, 16 Oct 2002
4408 \begin_layout Subsection*
4409 LFUN_ALL_CHANGES_REJECT
4412 \begin_layout Description
4413 Action Rejects all tracked changes in the document.
4417 \begin_layout Description
4418 Notion Reject does not work recursively; the user may have to repeat the
4423 \begin_layout Description
4424 Syntax all-changes-reject
4427 \begin_layout Description
4428 Origin Levon, 16 Oct 2002
4431 \begin_layout Subsection*
4435 \begin_layout Description
4436 Action Apply data for an inset.
4440 \begin_layout Description
4441 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4443 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4444 on the context where it is called.
4448 \begin_layout Description
4449 Syntax inset-apply <ARGS>
4452 \begin_layout Description
4453 Params See LFUN_INSET_INSERT .
4457 \begin_layout Subsection*
4461 \begin_layout Description
4462 Action Dissolve the current inset into text.
4466 \begin_layout Description
4467 Syntax inset-dissolve [<INSET>]
4470 \begin_layout Description
4471 Params <INSET>: this can be used to make sure the right kind of inset is
4473 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4474 the charstyle inset, even if the cursor is inside several nested insets
4477 \begin_inset Newline newline
4480 For values see lyx::InsetLayout::lyxtype_ .
4484 \begin_layout Description
4485 Origin JSpitz, 7 Aug 2006
4488 \begin_layout Subsection*
4492 \begin_layout Description
4493 Action Insert new inset (type given by the parameters).
4497 \begin_layout Description
4498 Syntax inset-insert <INSET> <ARGS>
4501 \begin_layout Description
4502 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4503 nclude|index|label|nomencl|vspace|ref|toc>
4504 \begin_inset Newline newline
4507 <ARGS>: depends on the given inset.
4508 Use "lyx -dbg action" to explore.
4512 \begin_layout Description
4513 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4516 \begin_inset Newline newline
4519 where <label name> is the name of the referenced label and<Format> is one
4521 \begin_inset Newline newline
4525 \begin_inset Newline newline
4528 eqref -- (<reference>)
4529 \begin_inset Newline newline
4533 \begin_inset Newline newline
4536 vpageref -- on <page>
4537 \begin_inset Newline newline
4540 vref -- <reference> on <page>
4541 \begin_inset Newline newline
4544 prettyref -- Formatted reference
4547 \begin_layout Subsection*
4551 \begin_layout Description
4552 Action Modify existing inset.
4556 \begin_layout Description
4557 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4558 graphics, include, label, listings, note, phantom, ref, space, tabular,
4559 vspace, wrap insets.
4563 \begin_layout Description
4564 Syntax inset-modify <INSET> <ARGS>
4567 \begin_layout Description
4568 Params See LFUN_INSET_INSERT for further details.
4572 \begin_layout Subsection*
4573 LFUN_NEXT_INSET_MODIFY
4576 \begin_layout Description
4577 Action Modify the inset at cursor position, if there is one.
4581 \begin_layout Description
4582 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4583 graphics, include, label, listings, note, phantom, ref, space, tabular,
4584 vspace, wrap insets.
4588 \begin_layout Description
4589 Syntax next-inset-modify <INSET> <ARGS>
4592 \begin_layout Description
4593 Syntax next-inset-modify changetype <TYPE>
4596 \begin_layout Description
4597 Params See LFUN_INSET_INSERT for further details.
4601 \begin_layout Description
4602 Origin JSpitzm, 23 Mar 2008
4605 \begin_layout Subsection*
4606 LFUN_INSET_DIALOG_UPDATE
4609 \begin_layout Description
4610 Action Updates the values inside the dialog from the inset.
4614 \begin_layout Description
4615 Notion This is internal LFUN, not to be used by users.
4616 Called internally by LFUN_DIALOG_UPDATE
4619 \begin_layout Description
4620 Params <DIALOG-NAME>
4623 \begin_layout Description
4624 Origin leeming, 25 Feb 2003
4627 \begin_layout Subsection*
4631 \begin_layout Description
4632 Action Open the inset's properties dialog.
4636 \begin_layout Description
4637 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4641 \begin_layout Description
4642 Syntax inset-settings <INSET>
4645 \begin_layout Description
4646 Params <INSET>: <box|branch|ert|float|listings|note|phantom|tabular|wrap>
4650 \begin_layout Subsection*
4654 \begin_layout Description
4655 Action Toggles the collapsable inset we are currently in.
4659 \begin_layout Description
4660 Syntax inset-toggle [<ARG>]
4663 \begin_layout Description
4664 Params <ARG>: <open|close|toggle|assign>.
4666 \begin_inset Newline newline
4669 open/close/toggle are for collapsable insets.
4670 toggle is used when no argument is given.
4672 \begin_inset Newline newline
4675 assign synchronize the branch-inset with activation status of the branch.
4676 Used for global toggling when changed activation.
4680 \begin_layout Description
4681 Origin lasgouttes, 19 Jul 2001
4684 \begin_layout Subsection*
4685 LFUN_ALL_INSETS_TOGGLE
4688 \begin_layout Description
4689 Action Toggles (open/closes) all collapsable insets (of a given type) in
4694 \begin_layout Description
4695 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4699 \begin_layout Description
4700 Syntax all-insets-toggle <STATE> <INSET>
4703 \begin_layout Description
4704 Params <STATE>: <toggle|open|close> default: toggle
4705 \begin_inset Newline newline
4708 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4712 \begin_layout Description
4713 Origin leeming, 30 Mar 2004
4716 \begin_layout Subsection*
4717 LFUN_SET_GRAPHICS_GROUP
4720 \begin_layout Description
4721 Action Set the group for the graphics inset on the cursor position.
4725 \begin_layout Description
4726 Syntax set-graphics-group [<GROUP>]
4729 \begin_layout Description
4730 Params <GROUP>: Id for an existing group.
4731 In case the Id is an empty string, the graphics inset is removed from the
4736 \begin_layout Description
4737 Origin sanda, 6 May 2008
4740 \begin_layout Subsection*
4741 LFUN_FINISHED_FORWARD
4744 \begin_layout Description
4745 Action Moves the cursor out of the current slice, going forward.
4749 \begin_layout Description
4750 Notion Cursor movement within an inset may be different than cursor movement
4751 in the surrounding text.
4752 This action should be called automatically by the cursor movement within
4753 the inset, when movement within the inset has ceased (reached the end of
4754 the last paragraph, for example), in order to move correctly back into
4755 the surrounding text.
4759 \begin_layout Subsection*
4760 LFUN_FINISHED_BACKWARD
4763 \begin_layout Description
4764 Action Moves the cursor out of the current slice, going backwards.
4768 \begin_layout Description
4769 Notion See also LFUN_FINISHED_FORWARD.
4773 \begin_layout Subsection*
4777 \begin_layout Description
4778 Action Moves the cursor out of the current slice, going right.
4782 \begin_layout Description
4783 Notion See also LFUN_FINISHED_FORWARD
4786 \begin_layout Subsection*
4790 \begin_layout Description
4791 Action Moves the cursor out of the current slice, going left.
4795 \begin_layout Description
4796 Notion See also LFUN_FINISHED_FORWARD.
4800 \begin_layout Subsection*
4804 \begin_layout Description
4805 Action Set language from the current cursor position.
4809 \begin_layout Description
4810 Syntax language <LANG>
4813 \begin_layout Description
4814 Params <LANG>: Requested language.
4815 Look in lib/languages for the list.
4819 \begin_layout Description
4820 Origin Dekel, 2 Mar 2000
4823 \begin_layout Subsection*
4827 \begin_layout Description
4828 Action Goto a label.
4832 \begin_layout Description
4833 Syntax label-goto [<LABEL>]
4836 \begin_layout Description
4837 Params <LABEL>: Requested label.
4838 If no label is given and reference is on cursor position, Bookmark 0 is
4839 saved and cursor moves to the position of referenced label.
4843 \begin_layout Description
4844 Origin Ale, 6 Aug 1997
4847 \begin_layout Subsection*
4851 \begin_layout Description
4852 Action Inserts label to text or displayed formula.
4856 \begin_layout Description
4857 Syntax label-insert [<LABEL>]
4860 \begin_layout Description
4861 Params <LABEL>: Requested label.
4862 If no label is given dialog requesting name will be opened.
4866 \begin_layout Subsection*
4870 \begin_layout Description
4871 Action Go to the next label or cross-reference.
4875 \begin_layout Description
4876 Syntax reference-next
4879 \begin_layout Description
4880 Origin Dekel, 14 Jan 2001
4883 \begin_layout Subsection*
4887 \begin_layout Description
4888 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
4889 Note that bookmarsk are saved per-session, not per file.
4893 \begin_layout Description
4894 Notion Bookmark 0 has a special purpose.
4895 It is automatically set
4896 \begin_inset Newline newline
4900 to the paragraph you are currently editing
4901 \begin_inset Newline newline
4905 to the paragraph from where you are jumping to the last-edited position
4907 \begin_inset Newline newline
4911 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
4915 \begin_layout Description
4916 Syntax bookmark-goto <NUMBER>
4919 \begin_layout Description
4920 Params <NUMBER>: the number of the bookmark to restore.
4924 \begin_layout Description
4925 Origin Dekel, 27 January 2001
4928 \begin_layout Subsection*
4932 \begin_layout Description
4933 Action Save a bookmark.
4937 \begin_layout Description
4938 Notion Saves a numbered bookmark to the sessions file.
4939 The number must be between 1 and 9, inclusive.
4940 Note that bookmarks are saved per-session, not per file.
4944 \begin_layout Description
4945 Syntax bookmark-save <NUMBER>
4948 \begin_layout Description
4949 Params <NUMBER>: the number of the bookmark to save.
4953 \begin_layout Description
4954 Origin Dekel, 27 January 2001
4957 \begin_layout Subsection*
4961 \begin_layout Description
4962 Action Clears the list of saved bookmarks.
4966 \begin_layout Description
4967 Syntax bookmark-clear
4970 \begin_layout Description
4971 Origin bpeng, 31 October 2006
4974 \begin_layout Subsection*
4978 \begin_layout Description
4979 Action Open the given help file according to the language setting.
4983 \begin_layout Description
4984 Syntax help-open <FILE>[.lyx]
4987 \begin_layout Description
4988 Params <FILE>: any document from (/usr/share/)doc directory.
4992 \begin_layout Description
4993 Origin Jug, 27 Jun 1999
4996 \begin_layout Subsection*
5000 \begin_layout Description
5001 Action Terminates the current LyX instance.
5005 \begin_layout Description
5006 Notion Terminates the current LyX instance, asking whether to save modified
5011 \begin_layout Description
5015 \begin_layout Subsection*
5019 \begin_layout Description
5020 Action Toggles visibility of a given toolbar between on/off/auto.
5024 \begin_layout Description
5025 Notion Skiping "auto" when allowauto is false.
5029 \begin_layout Description
5030 Syntax toolbar-toggle <NAME> [allowauto]
5033 \begin_layout Description
5034 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
5035 ew/update|math_panels|vcs
5038 \begin_layout Description
5039 Origin Edwin, 21 May 2007
5042 \begin_layout Subsection*
5046 \begin_layout Description
5047 Action Opens the menu given by its name.
5051 \begin_layout Description
5052 Syntax menu-open <NAME>
5055 \begin_layout Description
5056 Params <NAME>: menu name.
5057 See various .inc files in lib/ui for candidates.
5061 \begin_layout Subsection*
5065 \begin_layout Description
5066 Action Various UI visibility-toggling actions.
5070 \begin_layout Description
5071 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5074 \begin_layout Description
5075 Params statusbar : Toggle visibility of the statusbar.
5077 \begin_inset Newline newline
5080 menubar : Toggle visibility of the menubar.
5082 \begin_inset Newline newline
5085 scrollbar : Toggle visibility of the scrollbar.
5087 \begin_inset Newline newline
5090 frame : Toggle visibility of the frames around editing window.
5092 \begin_inset Newline newline
5095 fullscreen : Toggle fullscreen mode.
5096 This also covers calling the previous functions.
5097 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5102 \begin_layout Description
5103 Origin sanda, 9 Feb 2007
5106 \begin_layout Subsection*
5110 \begin_layout Description
5111 Action Creates new empty LyX window.
5115 \begin_layout Description
5116 Notion Already opened documents from the previous window can be found under
5121 \begin_layout Description
5122 Syntax window-new [<GEOMETRY>]
5125 \begin_layout Description
5126 Params <GEOMETRY>: pass the geometry of the window.
5127 This parameter is currently accepted only on Windows platform.
5131 \begin_layout Description
5132 Origin Abdel, 21 Oct 2006
5135 \begin_layout Subsection*
5139 \begin_layout Description
5140 Action Closes the current LyX window.
5144 \begin_layout Description
5148 \begin_layout Description
5149 Origin Abdel, 23 Oct 2006
5152 \begin_layout Subsection*
5156 \begin_layout Description
5157 Action Creates another split view of current buffer.
5161 \begin_layout Description
5162 Notion All split views act in the same way indpendently.
5166 \begin_layout Description
5167 Syntax split-view <vertical|horizontal>
5170 \begin_layout Description
5171 Params horizontal : The work areas are laid out side by side.
5173 \begin_inset Newline newline
5176 vertical : The work areas laid out vertically.
5180 \begin_layout Description
5181 Origin Abdel, 20 Feb 2008
5184 \begin_layout Subsection*
5185 LFUN_CLOSE_TAB_GROUP
5188 \begin_layout Description
5189 Action Close the current tab group.
5193 \begin_layout Description
5194 Notion This only closes the work areas, not the buffer themselves.
5195 The still opened buffers can be visualized in another tab group.
5199 \begin_layout Description
5200 Syntax close-tab-group
5203 \begin_layout Description
5204 Origin Abdel, 21 Feb 2008
5207 \begin_layout Subsection*
5211 \begin_layout Description
5212 Action Shows hidden dialog or create new one for a given function/inset
5217 \begin_layout Description
5218 Syntax dialog-show <NAME> [<DATA>]
5221 \begin_layout Description
5222 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5224 \begin_inset Newline newline
5227 document|errorlist|ert|external|file|findreplace|float|graphics|
5228 \begin_inset Newline newline
5231 include|index|info|nomenclature|label|listings|log|mathdelimiter|
5232 \begin_inset Newline newline
5235 mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space|
5236 \begin_inset Newline newline
5239 spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|
5241 \begin_inset Newline newline
5244 view-source|vspace|wrap|<SPECIAL>
5245 \begin_inset Newline newline
5248 <SPECIAL>: latexlog|vclog
5249 \begin_inset Newline newline
5252 <DATA>: data, usually settings for the given dialog.
5253 Use debug mode for the details.
5257 \begin_layout Description
5258 Origin leeming, 17 Jun 2003
5261 \begin_layout Subsection*
5262 LFUN_DIALOG_SHOW_NEW_INSET
5265 \begin_layout Description
5266 Action Shows hidden dialog or create new one for a given inset settings
5271 \begin_layout Description
5272 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5277 \begin_layout Description
5278 Syntax dialog-show-new-inset <NAME> [<DATA>]
5281 \begin_layout Description
5282 Params See LFUN_DIALOG_SHOW .
5286 \begin_layout Description
5287 Origin leeming, 25 Feb 2003
5290 \begin_layout Subsection*
5294 \begin_layout Description
5295 Action Updates the dialog values from the inset/paragraph/document.
5299 \begin_layout Description
5300 Syntax dialog-update <NAME>
5303 \begin_layout Description
5304 Params <NAME>: paragraph|prefs|<INSET>
5305 \begin_inset Newline newline
5311 \begin_layout Description
5312 Origin leeming, 25 Feb 2003
5315 \begin_layout Subsection*
5319 \begin_layout Description
5320 Action Hides showed dialog.
5321 Counterpart to LFUN_DIALOG_SHOW .
5325 \begin_layout Description
5326 Syntax dialog-hide <NAME>
5329 \begin_layout Description
5330 Params See LFUN_DIALOG_SHOW .
5334 \begin_layout Description
5335 Origin leeming, 25 Feb 2003
5338 \begin_layout Subsection*
5342 \begin_layout Description
5343 Action Toggles dialog between showed/hidden state.
5347 \begin_layout Description
5348 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5352 \begin_layout Description
5353 Syntax dialog-toggle <NAME> [<DATA>]
5356 \begin_layout Description
5357 Params See LFUN_DIALOG_SHOW .
5361 \begin_layout Description
5362 Origin JSpitzm, 30 Apr 2007
5365 \begin_layout Subsection*
5366 LFUN_DIALOG_DISCONNECT_INSET
5369 \begin_layout Description
5370 Action Closes opened connection to opened inset.
5374 \begin_layout Description
5375 Notion Connection is used for apply functions.
5379 \begin_layout Description
5380 Syntax dialog-disconnect-inset <INSET-NAME>
5383 \begin_layout Description
5384 Origin leeming, 25 Feb 2003
5387 \begin_layout Subsection*
5391 \begin_layout Description
5392 Action This function is called when mouse button is pressed (inside workarea).Act
5393 ion depends on the context.
5397 \begin_layout Description
5398 Notion This is internal LFUN, not to be used by users.
5402 \begin_layout Description
5403 Origin Andre, 9 Aug 2002
5406 \begin_layout Subsection*
5410 \begin_layout Description
5411 Action This function is called when double click on mouse button is pressed
5413 Action depends on the context.
5417 \begin_layout Description
5418 Notion This is internal LFUN, not to be used by users.
5422 \begin_layout Description
5423 Origin Andre, 9 Aug 2002
5426 \begin_layout Subsection*
5430 \begin_layout Description
5431 Action This function is called when triple click on mouse button is pressed
5433 Action depends on the context.
5437 \begin_layout Description
5438 Notion This is internal LFUN, not to be used by users.
5442 \begin_layout Description
5443 Origin Andre, 9 Aug 2002
5446 \begin_layout Subsection*
5450 \begin_layout Description
5451 Action This function is called when mouse cursor is moving over the text.Action
5452 depends on the context.
5456 \begin_layout Description
5457 Notion This is internal LFUN, not to be used by users.
5461 \begin_layout Description
5462 Origin Andre, 9 Aug 2002
5465 \begin_layout Subsection*
5469 \begin_layout Description
5470 Action This function is called when mouse button is released (inside workarea).Ac
5471 tion depends on the context.
5475 \begin_layout Description
5476 Notion This is internal LFUN, not to be used by users.
5480 \begin_layout Description
5481 Origin Andre, 9 Aug 2002
5484 \begin_layout Subsection*
5488 \begin_layout Description
5489 Action Turn off the loaded keyboard map.
5493 \begin_layout Description
5497 \begin_layout Subsection*
5501 \begin_layout Description
5502 Action Turn on the primary keyboard map.
5506 \begin_layout Description
5507 Notion Maps were widely used in past, when X-windows didn't have nowadays
5509 They can be still used to maintain uniform keyboard layout across the various
5512 \begin_inset Newline newline
5515 The language is to be set in the Preferences dialog.
5519 \begin_layout Description
5520 Syntax keymap-primary
5523 \begin_layout Subsection*
5524 LFUN_KEYMAP_SECONDARY
5527 \begin_layout Description
5528 Action Turn on the secondary keyboard map.
5532 \begin_layout Description
5533 Syntax keymap-secondary
5536 \begin_layout Subsection*
5540 \begin_layout Description
5541 Action Toggles keyboard maps (first/second/off).
5545 \begin_layout Description
5546 Syntax keymap-toggle
5549 \begin_layout Description
5550 Origin leeming, 30 Mar 2004
5553 \begin_layout Subsection*
5554 LFUN_SERVER_GET_LAYOUT
5557 \begin_layout Description
5558 Action Returns the current layout (that is environment) name on the cursor
5563 \begin_layout Description
5564 Syntax server-get-layout
5567 \begin_layout Subsection*
5568 LFUN_SERVER_GET_FILENAME
5571 \begin_layout Description
5572 Action Returns path and file name of the currently edited document.
5576 \begin_layout Description
5577 Syntax server-get-filename
5580 \begin_layout Subsection*
5581 LFUN_SERVER_GOTO_FILE_ROW
5584 \begin_layout Description
5585 Action Sets the cursor position based on the row number of generated TeX
5590 \begin_layout Description
5591 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5594 \begin_layout Description
5595 Origin Edmar, 23 Dec 1998
5598 \begin_layout Subsection*
5602 \begin_layout Description
5603 Action Sends notify message about the last key-sequence to client.
5607 \begin_layout Description
5608 Notion This can be used to grab last key-sequence used inside the LyX window.
5609 See also Debug extensions section in Additional features manual.
5613 \begin_layout Description
5614 Syntax server-notify
5617 \begin_layout Subsection*
5621 \begin_layout Description
5622 Action Sets the cursor position based on the editing area coordinates (similar
5623 as clicking on that point with left mouse button).
5627 \begin_layout Description
5628 Syntax server-set-xy <X> <Y>
5631 \begin_layout Subsection*
5635 \begin_layout Description
5636 Action Returns the coordinates of cursor position in the editing area.
5640 \begin_layout Description
5641 Syntax server-get-xy
5644 \begin_layout Subsection*
5648 \begin_layout Description
5649 Action Generates the code (literate programming).
5653 \begin_layout Description
5654 Notion Latex file with extension literate_extension is generated.
5655 Then LyX invokes build_command (with a default of``make'') to generate
5656 the code and build_error_filter to process the compilation error messages.
5658 \begin_inset Newline newline
5661 In case you want to process your literate file with a script, or some other
5662 program, just insert in your lyxrc file an entry with:
5663 \begin_inset Newline newline
5666 build_command "my_script my_arguments"
5667 \begin_inset Newline newline
5670 The build_error_filter differs from the literate_error_filter only in that
5671 the former will identify error messages from your compiler.
5675 \begin_layout Description
5676 Syntax build-program
5679 \begin_layout Subsection*
5680 LFUN_BUFFER_AUTO_SAVE
5683 \begin_layout Description
5684 Action Saves the current buffer to a temporary file.
5688 \begin_layout Description
5689 Notion Saves the current buffer to a file named "#filename#".
5690 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5694 \begin_layout Description
5695 Syntax buffer-auto-save
5698 \begin_layout Subsection*
5699 LFUN_BUFFER_CHILD_OPEN
5702 \begin_layout Description
5703 Action Loads the given child document.
5707 \begin_layout Description
5708 Notion The current document is treated as a parent.
5712 \begin_layout Description
5713 Syntax buffer-child-open <FILE>
5716 \begin_layout Description
5717 Params <FILE>: Filename of the child.
5718 The directory of the parent is assumed by default.
5722 \begin_layout Description
5723 Origin Ale, 28 May 1997
5726 \begin_layout Subsection*
5730 \begin_layout Description
5731 Action Runs chktex for the current document.
5735 \begin_layout Description
5736 Syntax buffer-chktex
5739 \begin_layout Description
5740 Origin Asger, 30 Oct 1997
5743 \begin_layout Subsection*
5744 LFUN_BUFFER_TOGGLE_COMPRESSION
5747 \begin_layout Description
5748 Action Toggles compression of the current document on/off.
5752 \begin_layout Description
5753 Syntax buffer-toggle-compression
5756 \begin_layout Description
5757 Origin bpeng, 27 Apr 2006
5760 \begin_layout Subsection*
5764 \begin_layout Description
5765 Action Closes the current buffer.
5769 \begin_layout Description
5770 Notion Closes the current buffer, asking whether to save it, etc, if the
5771 buffer has been modified.
5775 \begin_layout Description
5779 \begin_layout Subsection*
5783 \begin_layout Description
5784 Action Exports the current buffer (document) to the given format.
5788 \begin_layout Description
5789 Syntax buffer-export <FORMAT>
5792 \begin_layout Description
5793 Params <FORMAT> is either "custom" or one of the formats which you can find
5794 in Tools->Preferences->File formats->Format.
5795 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5796 for pdflatex) or "ps" for postscript.
5798 \begin_inset Newline newline
5801 In case of "custom" you will be asked for a format you want to start from
5802 and for the command that you want to apply to this format.
5803 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5807 \begin_layout Description
5808 Origin Lgb, 29 Jul 1997
5811 \begin_layout Subsection*
5812 LFUN_BUFFER_EXPORT_CUSTOM
5815 \begin_layout Description
5816 Action Exports the current buffer (document) from the given format using
5817 the given command on it.
5821 \begin_layout Description
5822 Syntax buffer-export-custom <FORMAT> <COMMAND>
5825 \begin_layout Description
5826 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5829 \begin_inset Newline newline
5832 <COMMAND> this command will be launched on the file.
5833 Note that you can use "$$FName" string to qualify the intermediate file.
5837 \begin_layout Description
5838 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5841 \begin_layout Description
5842 Origin leeming, 27 Mar 2004
5845 \begin_layout Subsection*
5849 \begin_layout Description
5850 Action Prints the current document.
5854 \begin_layout Description
5855 Notion Many settings can be given via the preferences dialog.
5859 \begin_layout Description
5860 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5863 \begin_layout Description
5864 Params <TARGET> is either "printer" or "file".
5866 \begin_inset Newline newline
5869 <TARGER-NAME> is either "default" or file name or printer name.
5871 \begin_inset Newline newline
5874 <COMMAND> command ensuring the printing job.
5878 \begin_layout Description
5879 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5882 \begin_layout Description
5883 Origin leeming, 28 Mar 2004
5886 \begin_layout Subsection*
5890 \begin_layout Description
5891 Action Import a given file as a lyx document.
5895 \begin_layout Description
5896 Notion File can be imported iff lyx file format is (transitively) reachable
5897 via defined convertors in preferences.
5898 Look into File->Import menu to get an idea of the currently active import
5903 \begin_layout Description
5904 Syntax buffer-import <FORMAT> [<FILE>]
5907 \begin_layout Description
5908 Origin Asger, 24 Jul 1998
5911 \begin_layout Subsection*
5915 \begin_layout Description
5916 Action Creates a new buffer (that is, document).
5920 \begin_layout Description
5921 Notion Implicit path can be set in Preferences dialog.
5925 \begin_layout Description
5926 Syntax buffer-new [<FILE>]
5929 \begin_layout Description
5930 Params <FILE>: filename of created file with absolute path.
5934 \begin_layout Subsection*
5935 LFUN_BUFFER_NEW_TEMPLATE
5938 \begin_layout Description
5939 Action Creates a new buffer (that is, document) from a template.
5943 \begin_layout Description
5944 Notion Path for new files and templates can be set in Preferences dialog.
5945 Template will be asked for via Open-dialog.
5949 \begin_layout Description
5950 Syntax buffer-new-template [<FILE>]
5953 \begin_layout Description
5954 Params <FILE>: filename of created file with absolute path.
5958 \begin_layout Subsection*
5962 \begin_layout Description
5963 Action Reverts opened document.
5967 \begin_layout Description
5968 Syntax buffer-reload
5971 \begin_layout Description
5972 Origin Asger, 2 Feb 1997
5975 \begin_layout Subsection*
5979 \begin_layout Description
5980 Action Switch to the given buffer.
5984 \begin_layout Description
5985 Notion This is useful also in case you need simultaneously more views of
5986 the edited document in different LyX windows.
5990 \begin_layout Description
5991 Syntax buffer-new-template <BUFFER>
5994 \begin_layout Description
5995 Params <BUFFER>: already opened document which is to be shown.
5999 \begin_layout Subsection*
6000 LFUN_BUFFER_TOGGLE_READ_ONLY
6003 \begin_layout Description
6004 Action Toggle editing mode of the current document between read/write and
6009 \begin_layout Description
6010 Notion In the ->Readonly mode checks-in/commits the data if the file is
6011 under version control.
6012 In the Readonly-> mode checkouts the data from repository.
6014 \begin_inset Newline newline
6017 If these operations fail, buffer won't be toggled.
6021 \begin_layout Description
6022 Syntax buffer-toggle-read-only
6025 \begin_layout Description
6026 Origin Lgb, 27 May 1997
6029 \begin_layout Subsection*
6033 \begin_layout Description
6034 Action Displays current buffer in chosen format.
6038 \begin_layout Description
6039 Notion Displays the contents of the current buffer in the chosen format,
6040 for example, PDF or DVI.
6041 This runs the necessary converter, calls the defined viewer, and so forth.
6045 \begin_layout Description
6046 Syntax buffer-view <FORMAT>
6049 \begin_layout Description
6050 Params <FORMAT>: The format to display, where this is one of the formats
6051 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6055 \begin_layout Subsection*
6059 \begin_layout Description
6060 Action Exports the current document and put the result into the temporary
6065 \begin_layout Description
6066 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6067 EW) the output will be rewriten - updated.
6068 This is useful in case your viewer is able to detect such changes (e.g.
6069 ghostview for postscript).
6073 \begin_layout Description
6074 Syntax buffer-update <FORMAT>
6077 \begin_layout Description
6078 Params <FORMAT>: The format to display, where this is one of the formats
6079 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6083 \begin_layout Description
6084 Origin Dekel, 5 Aug 2000
6087 \begin_layout Subsection*
6091 \begin_layout Description
6092 Action Saves the current buffer.
6096 \begin_layout Description
6097 Notion Saves the current buffer to disk, using the filename that is already
6098 associated with the buffer, asking for one if none is yet assigned.
6102 \begin_layout Description
6106 \begin_layout Subsection*
6107 LFUN_BUFFER_WRITE_AS
6110 \begin_layout Description
6111 Action Rename and save current buffer.
6115 \begin_layout Description
6116 Syntax buffer-write-as <FILENAME>
6119 \begin_layout Description
6120 Params <FILENAME>: New name of the buffer/file.
6121 A relative path is with respect to the original location of the buffer/file.
6125 \begin_layout Subsection*
6126 LFUN_BUFFER_WRITE_ALL
6129 \begin_layout Description
6130 Action Save all changed documents.
6134 \begin_layout Description
6135 Syntax buffer-write-all
6138 \begin_layout Description
6139 Origin rgh, gpothier 6 Aug 2007
6142 \begin_layout Subsection*
6146 \begin_layout Description
6147 Action Switch to the next opened document.
6151 \begin_layout Description
6152 Notion Note that this does not necessarily mean next in tabbar (for full
6153 list see View menu).
6157 \begin_layout Description
6161 \begin_layout Subsection*
6162 LFUN_BUFFER_PREVIOUS
6165 \begin_layout Description
6166 Action Switch to the previous opened document.
6170 \begin_layout Description
6171 Syntax buffer-previous
6174 \begin_layout Subsection*
6175 LFUN_MASTER_BUFFER_UPDATE
6178 \begin_layout Description
6179 Action When run from a child document, this updates (exports) document built
6180 from the master buffer.
6181 If a master is not found, it updates the current buffer.
6185 \begin_layout Description
6186 Syntax master-buffer-update
6189 \begin_layout Description
6190 Origin Tommaso, 20 Sep 2007
6193 \begin_layout Subsection*
6194 LFUN_MASTER_BUFFER_VIEW
6197 \begin_layout Description
6198 Action When run from a child document, this command shows a preview built
6199 from the master buffer.
6200 If a master is not found, it previews the current buffer.
6204 \begin_layout Description
6205 Syntax master-buffer-view
6208 \begin_layout Description
6209 Origin Tommaso, 20 Sep 2007
6212 \begin_layout Subsection*
6213 LFUN_BUFFER_LANGUAGE
6216 \begin_layout Description
6217 Action Set language of the current document.
6221 \begin_layout Description
6222 Syntax buffer-language <LANG>
6225 \begin_layout Description
6226 Params <LANG>: language name.
6227 See lib/languages for list.
6231 \begin_layout Description
6232 Origin leeming, 30 Mar 2004
6235 \begin_layout Subsection*
6236 LFUN_BUFFER_SAVE_AS_DEFAULT
6239 \begin_layout Description
6240 Action Save the current document settings as default.
6244 \begin_layout Description
6245 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6249 \begin_layout Description
6250 Syntax buffer-save-as-default [<ARGS>]
6253 \begin_layout Description
6254 Params <ARGS>: contains the particular settings to be saved.
6255 They obey the syntax you can find in document header of usual .lyx file.
6259 \begin_layout Description
6260 Origin leeming, 30 Mar 2004
6263 \begin_layout Subsection*
6264 LFUN_BUFFER_PARAMS_APPLY
6267 \begin_layout Description
6268 Action Apply the given settings to the current document.
6272 \begin_layout Description
6273 Syntax buffer-params-apply [<ARGS>]
6276 \begin_layout Description
6277 Params <ARGS>: contains the particular settings to be saved.
6278 They obey the syntax you can find in document header of usual .lyx file.
6282 \begin_layout Description
6283 Origin leeming, 30 Mar 2004
6286 \begin_layout Subsection*
6290 \begin_layout Description
6291 Action Inserts another LyX file.
6295 \begin_layout Description
6296 Syntax file-insert [<FILE>]
6299 \begin_layout Description
6300 Params <FILE>: Filename to be inserted.
6304 \begin_layout Subsection*
6305 LFUN_FILE_INSERT_PLAINTEXT
6308 \begin_layout Description
6309 Action Inserts plain text file.
6313 \begin_layout Description
6314 Syntax file-insert-plaintext [<FILE>]
6317 \begin_layout Description
6318 Params <FILE>: Filename to be inserted.
6322 \begin_layout Description
6323 Origin CFO-G, 19 Nov 1997
6326 \begin_layout Subsection*
6327 LFUN_FILE_INSERT_PLAINTEXT_PARA
6330 \begin_layout Description
6331 Action Inserts plain text file as paragraph (i.e.
6336 \begin_layout Description
6337 Syntax file-insert-plaintext-para [<FILE>]
6340 \begin_layout Description
6341 Params <FILE>: Filename to be inserted.
6345 \begin_layout Description
6346 Origin Levon, 14 Feb 2001
6349 \begin_layout Subsection*
6353 \begin_layout Description
6354 Action Open LyX document.
6358 \begin_layout Description
6359 Syntax file-open [<FILE>]
6362 \begin_layout Description
6363 Params <FILE>: Filename to be opened.
6367 \begin_layout Subsection*
6371 \begin_layout Description
6372 Action Executes a command defined in a .def file.
6376 \begin_layout Description
6377 Notion The definitions are by default read from lib/commands/default.def.
6379 \begin_inset Newline newline
6382 A .def file allows to define a command with
6384 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6385 <LFUN> is the lfun code to be executed (see e.g.
6386 LFUN_COMMAND_SEQUENCE).
6389 def_file "FileName" allows to include another .def file.
6391 \begin_inset Newline newline
6394 This is particularly useful in connection with toolbar buttons: Since the
6395 name of the button image for this lfun is lib/images/commands/<NAME>.png
6396 this is the way to assign an image to a complex command-sequence.
6400 \begin_layout Description
6404 \begin_layout Description
6405 Params <NAME>: Name of the command that must be called.
6409 \begin_layout Description
6410 Origin broider, 2 Oct 2007
6413 \begin_layout Subsection*
6417 \begin_layout Description
6418 Action Simulate halting Meta key (Alt key on PCs).
6422 \begin_layout Description
6423 Notion Used for buffer editation not for GUI control.
6427 \begin_layout Description
6431 \begin_layout Subsection*
6435 \begin_layout Description
6436 Action Cancels sequence prepared by LFUN_META_PREFIX .
6440 \begin_layout Description
6444 \begin_layout Subsection*
6445 LFUN_COMMAND_EXECUTE
6448 \begin_layout Description
6449 Action Opens the minibuffer toolbar so that the user can type in there.
6453 \begin_layout Description
6454 Notion Usually bound to M-x shortcut.
6458 \begin_layout Description
6459 Syntax command-execute
6462 \begin_layout Subsection*
6466 \begin_layout Description
6467 Action Return the current key sequence and available options as a string.
6471 \begin_layout Description
6472 Notion No options are added if no current map exists.
6474 \begin_inset Newline newline
6477 This is probably usable only with connection to lyxserver.
6481 \begin_layout Description
6482 Syntax command-prefix
6485 \begin_layout Subsection*
6486 LFUN_COMMAND_SEQUENCE
6489 \begin_layout Description
6490 Action Run more commands (LFUN and its parameters) in a sequence.
6494 \begin_layout Description
6495 Syntax command-sequence <CMDS>
6498 \begin_layout Description
6499 Params <CMDS>: Sequence of commands separated by semicolons.
6503 \begin_layout Description
6504 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6508 \begin_layout Description
6509 Origin Andre, 11 Nov 1999
6512 \begin_layout Subsection*
6513 LFUN_COMMAND_ALTERNATIVES
6516 \begin_layout Description
6517 Action Runs the first listed command that is enabled.
6521 \begin_layout Description
6522 Notion This can be used to bind multiple functions to a single key, and
6523 then which one is used will depend upon the context.
6527 \begin_layout Description
6528 Syntax command-alternatives <CMDS>
6531 \begin_layout Description
6532 Params <CMDS>: Sequence of commands separated by semicolons.
6536 \begin_layout Description
6537 Sample command-alternatives completion-accept;cell-forward
6540 \begin_layout Description
6541 Origin rgh, 24 September 2008
6544 \begin_layout Subsection*
6548 \begin_layout Description
6549 Action Shows message in statusbar (for script purposes).
6553 \begin_layout Description
6554 Syntax message <STRING>
6557 \begin_layout Description
6558 Origin Lgb, 8 Apr 2001
6561 \begin_layout Subsection*
6562 LFUN_PREFERENCES_SAVE
6565 \begin_layout Description
6566 Action Save user preferences.
6570 \begin_layout Description
6571 Syntax preferences-save
6574 \begin_layout Description
6575 Origin Lgb, 27 Nov 1999
6578 \begin_layout Subsection*
6582 \begin_layout Description
6583 Action Reconfigure the automatic settings.
6587 \begin_layout Description
6591 \begin_layout Description
6592 Origin Asger, 14 Feb 1997
6595 \begin_layout Subsection*
6599 \begin_layout Description
6600 Action Apply the given settings to user preferences.
6604 \begin_layout Description
6605 Syntax lyxrc-apply <SETTINGS>
6608 \begin_layout Description
6609 Params <SETTINGS>: settings which are to be set.
6610 Take a look into ~/.lyx/preferences to get an idea which commands to use
6612 lyx::LyXRC::LyXRCTags has the list of possible commands.
6616 \begin_layout Subsection*
6617 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6620 \begin_layout Description
6621 Action Determine whether keep cursor inside the editing window regardless
6622 the scrollbar movement.
6626 \begin_layout Description
6627 Syntax toggle-cursor-follows-scrollbar
6630 \begin_layout Description
6631 Origin ARRae, 2 Dec 1997
6634 \begin_layout Subsection*
6638 \begin_layout Description
6639 Action Set the given LyX color to the color defined by the X11 name given.
6643 \begin_layout Description
6644 Notion A new color entry is created if the color is unknown.
6645 Color names can be stored as a part of user settings.
6649 \begin_layout Description
6650 Syntax set-color <LYX_NAME> <X11_NAME>
6653 \begin_layout Description
6654 Origin SLior, 11 Jun 2000
6657 \begin_layout Subsection*
6661 \begin_layout Description
6662 Action Count the statistics (number of words and characters) in the document
6663 or in the given selection.
6667 \begin_layout Description
6668 Notion Note that this function gives the number of words/chars written,
6669 not the number of characters which will be typeset.
6673 \begin_layout Description
6677 \begin_layout Description
6678 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6681 \begin_layout Subsection*
6682 LFUN_COMPLETION_INLINE
6685 \begin_layout Description
6686 Action Show the inline completion at the cursor position.
6690 \begin_layout Description
6691 Syntax completion-inline
6694 \begin_layout Description
6695 Origin sts, Feb 19 2008
6698 \begin_layout Subsection*
6699 LFUN_COMPLETION_POPUP
6702 \begin_layout Description
6703 Action Show the completion popup at the cursor position.
6707 \begin_layout Description
6708 Syntax completion-popup
6711 \begin_layout Description
6712 Origin sts, Feb 19 2008
6715 \begin_layout Subsection*
6716 LFUN_COMPLETION_COMPLETE
6719 \begin_layout Description
6720 Action Try to complete the word or command at the cursor position.
6724 \begin_layout Description
6728 \begin_layout Description
6729 Origin sts, Feb 19 2008
6732 \begin_layout Subsection*
6733 LFUN_COMPLETION_CANCEL
6736 \begin_layout Description
6737 Action Try to cancel completion, either the popup or the inline completion
6741 \begin_layout Description
6742 Syntax completion-cancel
6745 \begin_layout Description
6746 Origin sts, Sep 07 2008
6749 \begin_layout Subsection*
6750 LFUN_COMPLETION_ACCEPT
6753 \begin_layout Description
6754 Action Accept suggested completion.
6758 \begin_layout Description
6759 Syntax completion-accept
6762 \begin_layout Description
6763 Origin sanda, Sep 08 2008
6766 \begin_layout Subsection*
6767 LFUN_BRANCH_ACTIVATE
6770 \begin_layout Description
6771 Action Activate the branch
6774 \begin_layout Description
6775 Syntax branch-activate <BRANCH>
6778 \begin_layout Description
6779 Params <BRANCH>: The branch to activate
6782 \begin_layout Description
6783 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6784 \begin_inset Newline newline
6787 could be used to export a pdf with the answers branch includedwithout one's
6788 having to open LyX and activate the branch manually.
6791 \begin_layout Description
6792 Origin rgh, 27 May 2008
6795 \begin_layout Subsection*
6796 LFUN_BRANCH_DEACTIVATE
6799 \begin_layout Description
6800 Action De-activate the branch
6803 \begin_layout Description
6804 Syntax branch-deactivate <BRANCH>
6807 \begin_layout Description
6808 Params <BRANCH>: The branch to deactivate
6811 \begin_layout Description
6812 Origin rgh, 27 May 2008
6815 \begin_layout Subsection*
6816 LFUN_COPY_LABEL_AS_REF
6819 \begin_layout Description
6820 Action Copies the label at the cursor as a cross-reference to be pasted
6825 \begin_layout Description
6826 Syntax copy-label-as-reference
6829 \begin_layout Description
6830 Origin sts, 16 Nov 2008