1 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
6 \use_default_options false
14 \font_typewriter default
15 \font_default_family default
23 \default_output_format default
24 \paperfontsize default
33 \paperorientation portrait
34 \backgroundcolor #ffffff
41 \paragraph_separation indent
43 \quotes_language english
46 \paperpagestyle default
47 \tracking_changes false
55 \begin_layout Section*
56 LFUNs documentation automatically generated 08.05.2009.
59 \begin_layout Standard
63 \begin_layout Plain Layout
73 \begin_inset VSpace 1cm
79 \begin_layout Subsection*
83 \begin_layout Description
84 Action Adds an acute accent to the next character typed.
88 \begin_layout Description
92 \begin_layout Subsection*
96 \begin_layout Description
97 Action Adds a breve accent to the next character typed.
101 \begin_layout Description
105 \begin_layout Subsection*
109 \begin_layout Description
110 Action Adds a caron to the next character typed.
114 \begin_layout Description
118 \begin_layout Subsection*
122 \begin_layout Description
123 Action Adds a cedilla to the next character typed.
127 \begin_layout Description
128 Syntax accent-cedilla
131 \begin_layout Subsection*
135 \begin_layout Description
136 Action Adds a circle accent to the next character typed.
140 \begin_layout Description
144 \begin_layout Subsection*
145 LFUN_ACCENT_CIRCUMFLEX
148 \begin_layout Description
149 Action Adds a circumflex to the next character typed.
153 \begin_layout Description
154 Syntax accent-circumflex
157 \begin_layout Subsection*
161 \begin_layout Description
162 Action Adds a dot accent to the next character typed.
166 \begin_layout Description
170 \begin_layout Subsection*
174 \begin_layout Description
175 Action Adds a grave accent to the next character typed.
179 \begin_layout Description
183 \begin_layout Subsection*
184 LFUN_ACCENT_HUNGARIAN_UMLAUT
187 \begin_layout Description
188 Action Adds a Hungarian umlaut to the next character typed.
192 \begin_layout Description
196 \begin_layout Subsection*
200 \begin_layout Description
201 Action Adds a macron to the next character typed.
205 \begin_layout Description
209 \begin_layout Subsection*
213 \begin_layout Description
214 Action Adds an ogonek accent to the next character typed.
218 \begin_layout Description
222 \begin_layout Subsection*
226 \begin_layout Description
227 Action Adds a tie over the next two character typed.
231 \begin_layout Description
232 Notion The following char will finish the tie.
236 \begin_layout Description
240 \begin_layout Subsection*
244 \begin_layout Description
245 Action Adds a tilde over the next character typed.
249 \begin_layout Description
253 \begin_layout Subsection*
257 \begin_layout Description
258 Action Adds an umlaut over the next character typed.
262 \begin_layout Description
266 \begin_layout Subsection*
270 \begin_layout Description
271 Action Adds a bar under the next character typed.
275 \begin_layout Description
276 Syntax accent-underbar
279 \begin_layout Subsection*
283 \begin_layout Description
284 Action Adds a dot under the next character typed.
288 \begin_layout Description
289 Syntax accent-underdot
292 \begin_layout Subsection*
296 \begin_layout Description
297 Action Inserts a caption inset.
301 \begin_layout Description
302 Syntax caption-insert
305 \begin_layout Description
306 Origin Lgb, 18 Jul 2000
309 \begin_layout Subsection*
313 \begin_layout Description
314 Action Inserts the current date.
318 \begin_layout Description
319 Syntax date-insert [<ARG>]
322 \begin_layout Description
323 Params <ARG>: Format of date.
324 The default value (%x) can be set in Preferences->Date format.
325 For possible formats see manual page of strftime function.
329 \begin_layout Description
330 Origin jdblair, 31 Jan 2000
333 \begin_layout Subsection*
337 \begin_layout Description
338 Action Inserts a footnote inset.
342 \begin_layout Description
343 Syntax footnote-insert
346 \begin_layout Description
347 Origin Jug, 7 Mar 2000
350 \begin_layout Subsection*
354 \begin_layout Description
355 Action Inserts an ERT inset.
359 \begin_layout Description
363 \begin_layout Description
364 Origin Jug, 18 Feb 2000
367 \begin_layout Subsection*
371 \begin_layout Description
372 Action Inserts a float inset.
376 \begin_layout Description
377 Syntax float-insert <TYPE>
380 \begin_layout Description
381 Params <TYPE>: type of float depends on the used textclass.
382 Usually "algorithm", "table", "figure" parameters can be given.
386 \begin_layout Description
387 Origin Lgb, 27 Jun 2000
390 \begin_layout Subsection*
391 LFUN_FLOAT_WIDE_INSERT
394 \begin_layout Description
395 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
399 \begin_layout Description
400 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
404 \begin_layout Description
405 Syntax float-wide-insert <TYPE>
408 \begin_layout Description
409 Params <TYPE>: type of float depends on the used textclass.
410 Usually "algorithm", "table", "figure" parameters can be given.
414 \begin_layout Description
415 Origin Lgb, 31 Oct 2001
418 \begin_layout Subsection*
419 LFUN_FLOAT_LIST_INSERT
422 \begin_layout Description
423 Action Inserts the list of floats in the document.
427 \begin_layout Description
428 Syntax float-list-insert <TYPE>
431 \begin_layout Description
432 Params <TYPE>: type of float depends on the used textclass.
433 Usually "algorithm", "table", "figure" parameters can be given.
437 \begin_layout Description
438 Origin Lgb, 3 May 2001
441 \begin_layout Subsection*
445 \begin_layout Description
446 Action Inserts floats wrapped by the text around.
450 \begin_layout Description
451 Syntax wrap-insert <TYPE>
454 \begin_layout Description
455 Params <TYPE>: table|figure
458 \begin_layout Description
459 Origin Dekel, 7 Apr 2002
462 \begin_layout Subsection*
466 \begin_layout Description
467 Action Inserts an optional-argument (short title) inset.
471 \begin_layout Description
472 Syntax optional-insert
475 \begin_layout Description
476 Origin vermeer, 12 Aug 2002
479 \begin_layout Subsection*
483 \begin_layout Description
484 Action Inserts a horizontal line.
488 \begin_layout Description
492 \begin_layout Description
493 Origin Andre, Oct 27 2003
496 \begin_layout Subsection*
500 \begin_layout Description
501 Action Inserts a new page.
505 \begin_layout Description
506 Syntax newpage-insert <ARG>
509 \begin_layout Description
510 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
514 \begin_layout Description
515 Origin uwestoehr, 24 Nov 2007
518 \begin_layout Subsection*
519 LFUN_MARGINALNOTE_INSERT
522 \begin_layout Description
523 Action Inserts a marginal note.
527 \begin_layout Description
528 Syntax marginalnote-insert
531 \begin_layout Description
532 Origin Lgb, 26 Jun 2000
535 \begin_layout Subsection*
539 \begin_layout Description
540 Action Inserts a single unicode character.
544 \begin_layout Description
545 Syntax unicode-insert <CHAR>
548 \begin_layout Description
549 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
553 \begin_layout Description
554 Sample unicode-insert 0x0100
557 \begin_layout Description
558 Origin Lgb, 22 Oct 2006
561 \begin_layout Subsection*
565 \begin_layout Description
566 Action Inserts a new listings inset.
570 \begin_layout Description
571 Syntax listing-insert
574 \begin_layout Description
575 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
578 \begin_layout Subsection*
582 \begin_layout Description
583 Action Insert a tab into a listings inset.
587 \begin_layout Description
588 Notion It also works on a selection.
592 \begin_layout Description
596 \begin_layout Description
597 Origin vfvanravesteijn, Sep 30 2008
600 \begin_layout Subsection*
604 \begin_layout Description
605 Action Delete a tab or up to an equivalent amount of spaces from a listings
610 \begin_layout Description
611 Notion It also works on a selection - it removes a tab or spaces from the
612 beginning of each line spanned by the selection.
613 This is useful if you want to indent/unindent multiple lines in one action.
617 \begin_layout Description
621 \begin_layout Description
622 Origin vfvanravesteijn, Sep 30 2008
625 \begin_layout Subsection*
629 \begin_layout Description
630 Action Inserts quotes according to the type and quote-language preference.
634 \begin_layout Description
635 Action Currently English, Swedish, German, Polish, French, Danish quotes
640 \begin_layout Description
641 Syntax quote-insert [<TYPE>]
644 \begin_layout Description
645 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
650 \begin_layout Subsection*
654 \begin_layout Description
655 Action Displays shortcuts, lyxrc, package and textclass availability and
656 menu information in a non-editable boxed InsetText.
660 \begin_layout Description
661 Notion Apart from lfun arguments you can use the following method:
662 \begin_inset Newline newline
666 input the type and argument of this inset, e.g.
667 "menu paste", in the work area.
669 \begin_inset Newline newline
673 select the text and run info-insert lfun.
677 \begin_layout Description
678 Syntax info-insert <TYPE> <ARG>
681 \begin_layout Description
682 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
683 \begin_inset Newline newline
686 <ARG>: argument for a given type.
687 Look into InsetInfo.h for detailed description.
691 \begin_layout Description
692 Sample command-sequence info-insert buffer path; info-insert buffer name
696 \begin_layout Description
697 Origin bpeng, 7 Oct 2007
700 \begin_layout Subsection*
704 \begin_layout Description
705 Action Inserts branch inset.
709 \begin_layout Description
710 Syntax branch-insert <BRANCH-NAME>
713 \begin_layout Description
714 Origin vermeer, 17 Aug 2003
717 \begin_layout Subsection*
721 \begin_layout Description
722 Action Inserts Box inset.
726 \begin_layout Description
727 Syntax box-insert [<TYPE>]
730 \begin_layout Description
731 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
733 \begin_inset Newline newline
736 Framed is the default one.
740 \begin_layout Description
741 Origin vermeer, 7 Oct 2003
744 \begin_layout Subsection*
748 \begin_layout Description
749 Action Inserts CharStyle, Custom inset or XML short element.
753 \begin_layout Description
754 Notion Look into the Customization manual for more information about these
757 \begin_inset Newline newline
760 To make this command enabled the layout file for the document class you're
761 using has to load the character styles.
762 There are a few contained in the Logical Markup module.
763 You can also of course create some yourself.
765 \begin_inset Newline newline
768 For dissolving the element see LFUN_INSET_DISSOLVE.
772 \begin_layout Description
773 Syntax flex-insert <TYPE:Name>
776 \begin_layout Description
777 Params TYPE: CharStyle|Custom|Element|Standard
778 \begin_inset Newline newline
781 Identifies whether this is a Character Style, a Custom Inset or an XML
782 Element, and which dynamical sub-menu this flex inset is in on the LyX
784 If Standard (currently unused): none of these.
785 Name: This name must be defined either in your layout file or imported
788 \begin_inset Newline newline
791 InsetLayout <TYPE:Name>
794 \begin_layout Description
795 Sample flex-insert CharStyle:Code
798 \begin_layout Subsection*
802 \begin_layout Description
803 Action Inserts the given string (accordingly to the correct keymap).
807 \begin_layout Description
808 Notion Automatically replace the currently selected text.
809 Depends on lyxrc settings "auto_region_delete".
813 \begin_layout Description
814 Syntax self-insert <STRING>
817 \begin_layout Subsection*
821 \begin_layout Description
822 Action Inserts one of horizontal space insets.
826 \begin_layout Description
827 Syntax space-insert <NAME> [<LEN>]
830 \begin_layout Description
831 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
832 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
833 \begin_inset Newline newline
836 <LEN>: length for custom spaces (hspace, hspace* for protected)
839 \begin_layout Description
840 Origin JSpitzm, 20 May 2003, Mar 17 2008
843 \begin_layout Subsection*
844 LFUN_HYPERLINK_INSERT
847 \begin_layout Description
848 Action Inserts hyperlinks into the document (clickable in pdf output).
852 \begin_layout Description
853 Notion Hyperlink target can be set via selection + hyperlink-insert function.
857 \begin_layout Description
858 Syntax href-insert [<TARGET>]
861 \begin_layout Description
862 Origin CFO-G, 21 Nov 1997
865 \begin_layout Subsection*
866 LFUN_SPECIALCHAR_INSERT
869 \begin_layout Description
870 Action Inserts various characters into the document.
874 \begin_layout Description
875 Syntax specialchar-insert <CHAR>
878 \begin_layout Description
879 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
880 tence, menu-separator.
884 \begin_layout Description
885 Origin JSpitzm, 6 Dec 2007
888 \begin_layout Subsection*
892 \begin_layout Description
893 Action Inserts table of contents.
897 \begin_layout Description
901 \begin_layout Description
902 Origin Lgb, 27 May 97
905 \begin_layout Subsection*
909 \begin_layout Description
910 Action Start (or remove) Appendix on the given cursor position.
914 \begin_layout Description
918 \begin_layout Description
919 Origin ettrich, 5 May 1998
922 \begin_layout Subsection*
926 \begin_layout Description
927 Action Inserts Index entry.
931 \begin_layout Description
932 Notion It automatically takes the word on the cursor position.
936 \begin_layout Description
937 Syntax index-insert [<TYPE:Name>]
940 \begin_layout Description
941 Params <TYPE:Name>: name of the index, if multiple indices are defined.
942 with an empty argument, the default index is selected.
946 \begin_layout Description
947 Origin leeming, 3 Aug 2000
950 \begin_layout Subsection*
954 \begin_layout Description
955 Action Inserts list of Index entries on a new page.
959 \begin_layout Description
960 Syntax index-print [<TYPE:Name>]
963 \begin_layout Description
964 Params <TYPE:Name>: name of the index, if multiple indices are defined.
965 with an empty argument, the default index is selected.
969 \begin_layout Description
970 Origin Lgb, 27 Feb 1997
973 \begin_layout Subsection*
977 \begin_layout Description
978 Action Inserts Nomenclature entry.
982 \begin_layout Description
983 Notion It automatically takes the word on the cursor position if no symbol
988 \begin_layout Description
989 Syntax nomencl-insert [<SYMBOL>]
992 \begin_layout Description
993 Origin Ugras, 4 Nov 2006
996 \begin_layout Subsection*
997 LFUN_NOMENCLATURE_PRINT
1000 \begin_layout Description
1001 Action Inserts list of Nomenclature entries.
1005 \begin_layout Description
1006 Syntax nomenclature-print
1009 \begin_layout Description
1010 Origin Ugras, 4 Nov 2006
1013 \begin_layout Subsection*
1017 \begin_layout Description
1018 Action Inserts Note on the current cursor postion, move selection inside
1023 \begin_layout Description
1024 Syntax note-insert [<TYPE>]
1027 \begin_layout Description
1028 Params <TYPE>: <Note|Greyedout|Comment> default: Note
1031 \begin_layout Subsection*
1035 \begin_layout Description
1036 Action Moves the cursor to the begining of next Note inset.
1040 \begin_layout Description
1044 \begin_layout Subsection*
1048 \begin_layout Description
1049 Action Changes all Note insets of a particular type (source) to a different
1050 type (target) fot the current document.
1054 \begin_layout Description
1055 Syntax notes-mutate <SOURCE> <TARGET>
1058 \begin_layout Description
1059 Params <SOURCE/TARGET>: Note|Comment|Greyedout
1062 \begin_layout Description
1063 Origin sanda, 18 Jun 2008
1066 \begin_layout Subsection*
1070 \begin_layout Description
1071 Action Inserts phantom on the current cursor postion, move selection inside
1076 \begin_layout Description
1077 Syntax phantom-insert [<TYPE>]
1080 \begin_layout Description
1081 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
1084 \begin_layout Description
1085 Origin uwestoehr, 30 Jan 2009
1088 \begin_layout Subsection*
1092 \begin_layout Description
1093 Action Inserts a line break or new line.
1097 \begin_layout Description
1098 Syntax newline-insert [<ARG>]
1101 \begin_layout Description
1102 Params <ARG>: <newline|linebreak> default: newline
1105 \begin_layout Description
1106 Origin JSpitzm, 25 Mar 2008
1109 \begin_layout Subsection*
1113 \begin_layout Description
1114 Action Clears the selection.
1115 If no text is selected call LFUN_FINISHED_FORWARD.
1119 \begin_layout Description
1123 \begin_layout Description
1124 Origin Lgb, 17 May 2001
1127 \begin_layout Subsection*
1131 \begin_layout Description
1132 Action Moves the cursor one line in downward direction.
1136 \begin_layout Description
1140 \begin_layout Subsection*
1144 \begin_layout Description
1145 Action Moves the cursor one line in upward direction.
1149 \begin_layout Description
1153 \begin_layout Subsection*
1157 \begin_layout Description
1158 Action Moves the cursor one line in downward direction adding the current
1159 position to the selection.
1163 \begin_layout Description
1167 \begin_layout Subsection*
1171 \begin_layout Description
1172 Action Moves the cursor one line in upward direction adding the current
1173 position to the selection.
1177 \begin_layout Description
1181 \begin_layout Subsection*
1185 \begin_layout Description
1186 Action Moves the cursor one page in downward direction.
1190 \begin_layout Description
1194 \begin_layout Subsection*
1198 \begin_layout Description
1199 Action Moves the cursor one page in upward direction.
1203 \begin_layout Description
1207 \begin_layout Subsection*
1208 LFUN_SCREEN_DOWN_SELECT
1211 \begin_layout Description
1212 Action Moves the cursor one screen in downward direction adding the current
1213 position to the selection.
1217 \begin_layout Description
1218 Syntax screen-down-select
1221 \begin_layout Subsection*
1222 LFUN_SCREEN_UP_SELECT
1225 \begin_layout Description
1226 Action Moves the cursor one page in upward direction adding the current
1227 position to the selection.
1231 \begin_layout Description
1232 Syntax screen-up-select
1235 \begin_layout Subsection*
1239 \begin_layout Description
1240 Action Scroll the buffer view.
1244 \begin_layout Description
1245 Notion Only scrolls the screen up or down; does not move the cursor.
1249 \begin_layout Description
1250 Syntax scroll <TYPE> <QUANTITY>
1253 \begin_layout Description
1254 Params <TYPE>: line|page
1255 \begin_inset Newline newline
1258 <QUANTITY>: up|down|<number>
1261 \begin_layout Description
1262 Origin Abdel, Dec 27 2007
1265 \begin_layout Subsection*
1266 LFUN_SCREEN_RECENTER
1269 \begin_layout Description
1270 Action Recenters the screen on the current cursor position.
1274 \begin_layout Description
1275 Syntax screen-recenter
1278 \begin_layout Subsection*
1279 LFUN_SCREEN_SHOW_CURSOR
1282 \begin_layout Description
1283 Action Repositions the screen such that the cursor is visible.
1287 \begin_layout Description
1288 Syntax screen-show-cursor
1291 \begin_layout Description
1292 Origin vfr, 25 Mar 2009
1295 \begin_layout Subsection*
1299 \begin_layout Description
1300 Action Moves the cursor one position logically backwards.
1304 \begin_layout Description
1305 Notion This is not the action which should be bound to the arrow keys, because
1306 backwards may be left or right, depending on the language.
1307 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1308 which in turn may employ this one.
1312 \begin_layout Description
1313 Syntax char-backward
1316 \begin_layout Subsection*
1317 LFUN_CHAR_BACKWARD_SELECT
1320 \begin_layout Description
1321 Action Moves the cursor one position logically backwards, adding traversed
1322 position to the selection.
1326 \begin_layout Description
1327 Notion See also LFUN_CHAR_BACKWARD.
1331 \begin_layout Description
1332 Syntax char-backward-select
1335 \begin_layout Subsection*
1336 LFUN_CHAR_DELETE_BACKWARD
1339 \begin_layout Description
1340 Action Deletes one character in the backward direction (usually the "BackSpace"
1345 \begin_layout Description
1346 Syntax char-delete-backward
1349 \begin_layout Subsection*
1350 LFUN_CHAR_DELETE_FORWARD
1353 \begin_layout Description
1354 Action Deletes one character in the backward direction (usually the "Delete"
1359 \begin_layout Description
1360 Syntax char-delete-forward
1363 \begin_layout Subsection*
1367 \begin_layout Description
1368 Action Moves the cursor one position logically forward.
1372 \begin_layout Description
1373 Notion This is not the action which should be bound to the arrow keys, because
1374 forward may be left or right, depending on the language.
1375 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1376 which in turn may employ this one.
1380 \begin_layout Description
1384 \begin_layout Subsection*
1385 LFUN_CHAR_FORWARD_SELECT
1388 \begin_layout Description
1389 Action Moves the cursor one position logically forward, adding traversed
1390 position to the selection.
1394 \begin_layout Description
1395 Notion See also LFUN_CHAR_FORWARD.
1399 \begin_layout Description
1400 Syntax char-forward-select
1403 \begin_layout Subsection*
1407 \begin_layout Description
1408 Action Moves the cursor one position "to the left".
1412 \begin_layout Description
1413 Notion This is the action which should be taken when the "left" key is pressed.
1414 Generally, it moves the cursor one position to the left.
1415 However, in Bidi text this become slightly more complicated, and there
1416 are different modes of cursor movement.
1417 In "visual mode", this moves left, plain and simple.
1418 In "logical mode", movement is logically forward in RTL paragraphs, and
1419 logically backwards in LTR paragraphs.
1423 \begin_layout Description
1427 \begin_layout Subsection*
1428 LFUN_CHAR_LEFT_SELECT
1431 \begin_layout Description
1432 Action Moves the cursor one position "to the left", adding traversed position
1437 \begin_layout Description
1438 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1442 \begin_layout Description
1443 Syntax char-left-select
1446 \begin_layout Subsection*
1450 \begin_layout Description
1451 Action Moves the cursor one position "to the right".
1455 \begin_layout Description
1456 Notion This is the action which should be taken when the "right" key is
1458 Generally, it moves the cursor one position to the right.
1459 However, in Bidi text this become slightly more complicated, and there
1460 are different modes of cursor movement.
1461 In "visual mode", this moves right, plain and simple.
1462 In "logical mode", movement is logically forward in LTR paragraphs, and
1463 logically backwards in RTL paragraphs.
1467 \begin_layout Description
1471 \begin_layout Subsection*
1472 LFUN_CHAR_RIGHT_SELECT
1475 \begin_layout Description
1476 Action Moves the cursor one position "to the right", adding traversed position
1481 \begin_layout Description
1482 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1486 \begin_layout Description
1487 Syntax char-right-select
1490 \begin_layout Subsection*
1494 \begin_layout Description
1495 Action Moves the cursor to the logically previous beginning of a word.
1499 \begin_layout Description
1500 Notion This is not the action which should be bound to the arrow keys, because
1501 backwards may be left or right, depending on the language.
1502 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1503 which in turn may employ this one.
1507 \begin_layout Description
1508 Syntax word-backward
1511 \begin_layout Subsection*
1512 LFUN_WORD_BACKWARD_SELECT
1515 \begin_layout Description
1516 Action Moves the cursor to the logically previous beginning of a word, adding
1517 the logically traversed text to the selection.
1521 \begin_layout Description
1522 Notion See also LFUN_WORD_BACKWARD.
1526 \begin_layout Description
1527 Syntax word-backward-select
1530 \begin_layout Subsection*
1531 LFUN_WORD_DELETE_BACKWARD
1534 \begin_layout Description
1535 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1540 \begin_layout Description
1541 Syntax word-delete-backward
1544 \begin_layout Subsection*
1545 LFUN_WORD_DELETE_FORWARD
1548 \begin_layout Description
1549 Action Deletes characters to the end of the word (usually the "C+Delete"
1554 \begin_layout Description
1555 Syntax word-delete-forward
1558 \begin_layout Subsection*
1559 LFUN_WORD_FIND_FORWARD
1562 \begin_layout Description
1563 Action Search for a given string in forward direction.
1567 \begin_layout Description
1568 Notion Case sensitive, match words.
1569 If no argument given, last search repeated.
1573 \begin_layout Description
1574 Syntax word-find-forward [<STRING>]
1577 \begin_layout Description
1578 Origin Etienne, 16 Feb 1998
1581 \begin_layout Subsection*
1582 LFUN_WORD_FIND_BACKWARD
1585 \begin_layout Description
1586 Action Search for a given string in backward direction.
1590 \begin_layout Description
1591 Notion Case sensitive, match words.
1592 If no argument given, last search repeated.
1596 \begin_layout Description
1597 Syntax word-find-backward [<STRING>]
1600 \begin_layout Description
1601 Origin Etienne, 20 Feb 1998
1604 \begin_layout Subsection*
1608 \begin_layout Description
1609 Action Search for next occurence of a string.
1613 \begin_layout Description
1614 Syntax word-find [<DATA>]
1617 \begin_layout Description
1618 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1619 If no parameter is given, search with last find-dialog data is used for
1625 \begin_layout Description
1626 Origin Andre, Jan 7 2004
1629 \begin_layout Subsection*
1633 \begin_layout Description
1634 Action Replace a string in the document.
1638 \begin_layout Description
1639 Syntax word-replace [<DATA>]
1642 \begin_layout Description
1643 Params <DATA>: data is of the form "<search>
1644 \begin_inset Newline newline
1648 \begin_inset Newline newline
1651 <casesensitive> <matchword> <all> <forward>"
1654 \begin_layout Description
1655 Origin Andre, Jan 7 2004
1658 \begin_layout Subsection*
1662 \begin_layout Description
1663 Action Search for next occurence of a pattern.
1667 \begin_layout Description
1668 Syntax word-findadv [<DATA>]
1671 \begin_layout Description
1672 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1673 If no parameter is given, search with last find-dialog data is used for
1679 \begin_layout Description
1680 Origin Tommaso, Nov 15 2007
1683 \begin_layout Description
1684 Action Moves the cursor to the logically next beginning of a word.
1688 \begin_layout Description
1689 Notion This is not the action which should be bound to the arrow keys, because
1690 forward may be left or right, depending on the language.
1691 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1692 which in turn may employ this one.
1696 \begin_layout Description
1700 \begin_layout Subsection*
1701 LFUN_WORD_FORWARD_SELECT
1704 \begin_layout Description
1705 Action Moves the cursor to the logically next beginning of a word, adding
1706 the logically traversed text to the selection.
1710 \begin_layout Description
1711 Notion See also LFUN_WORD_FORWARD.
1715 \begin_layout Description
1716 Syntax word-forward-select
1719 \begin_layout Subsection*
1723 \begin_layout Description
1724 Action Moves the cursor to the next beginning of a word "on the left".
1728 \begin_layout Description
1729 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1731 Generally, it moves the cursor to the next beginning of a word on the left.
1732 However, in Bidi text this become slightly more complicated, and there
1733 are different modes of cursor movement.
1734 In "visual mode", this moves left, plain and simple.
1735 In "logical mode", movement is logically forward in RTL paragraphs, and
1736 logically backwards in LTR paragraphs.
1740 \begin_layout Description
1744 \begin_layout Description
1745 Origin dov, 28 Oct 2007
1748 \begin_layout Subsection*
1749 LFUN_WORD_LEFT_SELECT
1752 \begin_layout Description
1753 Action Moves the cursor to the next beginning of a word "on the left", adding
1754 *logically* traversed text to the selection.
1758 \begin_layout Description
1759 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1763 \begin_layout Description
1764 Syntax word-left-select
1767 \begin_layout Description
1768 Origin dov, 28 Oct 2007
1771 \begin_layout Subsection*
1775 \begin_layout Description
1776 Action Moves the cursor to the next beginning of a word "on the right".
1780 \begin_layout Description
1781 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1783 Generally, it moves the cursor to the next beginning of a word on the right.
1784 However, in Bidi text this become slightly more complicated, and there
1785 are different modes of cursor movement.
1786 In "visual mode", this moves right, plain and simple.
1787 In "logical mode", movement is logically forward in LTR paragraphs, and
1788 logically backwards in RTL paragraphs.
1792 \begin_layout Description
1796 \begin_layout Description
1797 Origin dov, 28 Oct 2007
1800 \begin_layout Subsection*
1801 LFUN_WORD_RIGHT_SELECT
1804 \begin_layout Description
1805 Action Moves the cursor to the next beginning of a word "on the right",
1806 adding *logically* traversed text to the selection.
1810 \begin_layout Description
1811 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1815 \begin_layout Description
1816 Syntax word-right-select
1819 \begin_layout Description
1820 Origin dov, 28 Oct 2007
1823 \begin_layout Subsection*
1827 \begin_layout Description
1828 Action Puts the word where the cursor stands into the selection.
1832 \begin_layout Description
1836 \begin_layout Description
1837 Origin Andre, 11 Sep 2002
1840 \begin_layout Subsection*
1841 LFUN_WORD_CAPITALIZE
1844 \begin_layout Description
1845 Action Capitalizes the words in the selection (i.e.
1846 the first letters) or the letter on the cursor position.
1850 \begin_layout Description
1851 Syntax word-capitalize
1854 \begin_layout Subsection*
1858 \begin_layout Description
1859 Action Change the words in the selection or from the cursor position to
1860 the end of word to the upper case.
1864 \begin_layout Description
1868 \begin_layout Subsection*
1872 \begin_layout Description
1873 Action Change the words in the selection or from the cursor position to
1874 the end of word to the lower case.
1878 \begin_layout Description
1882 \begin_layout Subsection*
1883 LFUN_THESAURUS_ENTRY
1886 \begin_layout Description
1887 Action Look up thesaurus entries with respect to the word under the cursor.
1891 \begin_layout Description
1892 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1895 \begin_layout Description
1896 Params <STRING>: word to look up <LANG>: language (see file languages)
1900 \begin_layout Description
1901 Origin Levon, 20 Jul 2001
1904 \begin_layout Subsection*
1908 \begin_layout Description
1909 Action Move the cursor to the beginning of the document.
1913 \begin_layout Description
1917 \begin_layout Subsection*
1918 LFUN_BUFFER_BEGIN_SELECT
1921 \begin_layout Description
1922 Action Move the cursor to the beginning of the document adding the traversed
1923 text to the selection.
1927 \begin_layout Description
1928 Syntax buffer-begin-select
1931 \begin_layout Subsection*
1935 \begin_layout Description
1936 Action Move the cursor to the end of the document.
1940 \begin_layout Description
1944 \begin_layout Subsection*
1945 LFUN_BUFFER_END_SELECT
1948 \begin_layout Description
1949 Action Move the cursor to the end of the document adding the traversed text
1954 \begin_layout Description
1955 Syntax buffer-end-select
1958 \begin_layout Subsection*
1962 \begin_layout Description
1963 Action Move the cursor to the beginning of the current inset if it is not
1964 already there, or at the beginning of the enclosing inset otherwise
1967 \begin_layout Description
1971 \begin_layout Description
1972 Origin JMarc, 2009/03/16
1975 \begin_layout Subsection*
1976 LFUN_INSET_BEGIN_SELECT
1979 \begin_layout Description
1980 Action Move the cursor to the beginning of the current inset if it is not
1981 already there, or at the beginning of the enclosing inset otherwise (adding
1982 the traversed text to the selection).
1986 \begin_layout Description
1987 Syntax inset-begin-select
1990 \begin_layout Description
1991 Origin JMarc, 2009/03/16
1994 \begin_layout Subsection*
1998 \begin_layout Description
1999 Action Move the cursor to the end of the current inset if it is not already
2000 there, or at the end of the enclosing inset otherwise
2003 \begin_layout Description
2007 \begin_layout Description
2008 Origin JMarc, 2009/03/16
2011 \begin_layout Subsection*
2012 LFUN_INSET_END_SELECT
2015 \begin_layout Description
2016 Action Move the cursor to the end of the current inset if it is not already
2017 there, or at the end of the enclosing inset otherwise (adding the traversed
2018 text to the selection).
2022 \begin_layout Description
2023 Syntax inset-end-select
2026 \begin_layout Description
2027 Origin JMarc, 2009/03/16
2030 \begin_layout Subsection*
2034 \begin_layout Description
2035 Action Move the cursor to the begining of the (screen) line.
2039 \begin_layout Description
2043 \begin_layout Subsection*
2044 LFUN_LINE_BEGIN_SELECT
2047 \begin_layout Description
2048 Action Move the cursor to the beginning of the (screen) line adding the
2049 traversed text to the selection.
2053 \begin_layout Description
2054 Syntax line-begin-select
2057 \begin_layout Subsection*
2061 \begin_layout Description
2062 Action Move the cursor to the end of the (screen) line.
2066 \begin_layout Description
2070 \begin_layout Subsection*
2071 LFUN_LINE_END_SELECT
2074 \begin_layout Description
2075 Action Move the cursor to the end of the (screen) line adding the traversed
2076 text to the selection.
2080 \begin_layout Description
2081 Syntax line-end-select
2084 \begin_layout Subsection*
2088 \begin_layout Description
2089 Action Deletes the letters to the end of the (screen) line or deletes the
2094 \begin_layout Description
2095 Syntax line-delete-forward
2098 \begin_layout Subsection*
2102 \begin_layout Description
2103 Action Copies to the clipboard the last edit.
2107 \begin_layout Description
2111 \begin_layout Subsection*
2115 \begin_layout Description
2116 Action Cuts to the clipboard.
2120 \begin_layout Description
2124 \begin_layout Subsection*
2128 \begin_layout Description
2129 Action Pastes material from the active clipboard.
2133 \begin_layout Description
2134 Syntax paste [<TYPE>]
2137 \begin_layout Description
2138 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
2141 \begin_layout Subsection*
2142 LFUN_CLIPBOARD_PASTE
2145 \begin_layout Description
2146 Action Pastes text from the active clipboard.
2150 \begin_layout Description
2151 Syntax clipboard-paste [<ARG>]
2154 \begin_layout Description
2155 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2160 \begin_layout Description
2161 Origin baum, 10 Jul 2006
2164 \begin_layout Subsection*
2165 LFUN_PRIMARY_SELECTION_PASTE
2168 \begin_layout Description
2169 Action Pastes the currently text selected text.
2173 \begin_layout Description
2174 Notion Primary selection mechanism is linux-only thing.
2178 \begin_layout Description
2179 Syntax primary-selection-paste [<ARG>]
2182 \begin_layout Description
2183 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2188 \begin_layout Subsection*
2189 LFUN_SELECTION_PASTE
2192 \begin_layout Description
2193 Action Pastes the text in permanent selection.
2197 \begin_layout Description
2198 Syntax selection-paste
2201 \begin_layout Subsection*
2205 \begin_layout Description
2206 Action Undoes the last edit.
2210 \begin_layout Description
2214 \begin_layout Subsection*
2218 \begin_layout Description
2219 Action Redoes the last thing undone.
2223 \begin_layout Description
2227 \begin_layout Subsection*
2231 \begin_layout Description
2232 Action Repeat the given command.
2236 \begin_layout Description
2237 Syntax repeat <COUNT> <LFUN-COMMAND>
2240 \begin_layout Description
2241 Origin Andre, 27 Oct 2003
2244 \begin_layout Subsection*
2245 LFUN_CHARS_TRANSPOSE
2248 \begin_layout Description
2249 Action Transposes the character at the cursor with the one before it.
2253 \begin_layout Description
2254 Syntax chars-transpose
2257 \begin_layout Description
2258 Origin Lgb, 25 Apr 2001
2261 \begin_layout Subsection*
2262 LFUN_DEPTH_DECREMENT
2265 \begin_layout Description
2266 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2271 \begin_layout Description
2272 Syntax depth-decrement
2275 \begin_layout Subsection*
2276 LFUN_DEPTH_INCREMENT
2279 \begin_layout Description
2280 Action Increase the nesting depth of the (selected) paragraph(s) inside
2285 \begin_layout Description
2286 Syntax depth-increment
2289 \begin_layout Subsection*
2293 \begin_layout Description
2294 Action Toggles the bold font (selection-wise) using mathbf in math.
2298 \begin_layout Description
2302 \begin_layout Subsection*
2303 LFUN_FONT_BOLDSYMBOL
2306 \begin_layout Description
2307 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2311 \begin_layout Description
2312 Syntax font-boldsymbol
2315 \begin_layout Subsection*
2316 LFUN_FONT_TYPEWRITER
2319 \begin_layout Description
2320 Action Toggles the typewriter family font (selection-wise).
2324 \begin_layout Description
2325 Syntax font-typewriter
2328 \begin_layout Subsection*
2332 \begin_layout Description
2333 Action Toggles underline in the font (selection-wise).
2337 \begin_layout Description
2338 Syntax font-underline
2341 \begin_layout Subsection*
2345 \begin_layout Description
2346 Action Toggles double underline in the font (selection-wise).
2350 \begin_layout Description
2351 Syntax font-underunderline
2354 \begin_layout Description
2355 Origin sanda, 5 May 2009
2358 \begin_layout Subsection*
2362 \begin_layout Description
2363 Action Toggles wavy underline in the font (selection-wise).
2367 \begin_layout Description
2368 Syntax font-underwave
2371 \begin_layout Description
2372 Origin sanda, 5 May 2009
2375 \begin_layout Subsection*
2379 \begin_layout Description
2380 Action Toggles strikeout (strike-through) in the font (selection-wise).
2384 \begin_layout Description
2385 Syntax font-strikeout
2388 \begin_layout Description
2389 Origin sanda, 3 May 2009
2392 \begin_layout Subsection*
2396 \begin_layout Description
2397 Action Toggles the emphasis font style (selection-wise).
2401 \begin_layout Description
2405 \begin_layout Subsection*
2409 \begin_layout Description
2410 Action Toggles Noun text style font (selection-wise).
2414 \begin_layout Description
2418 \begin_layout Subsection*
2422 \begin_layout Description
2423 Action Toggles Roman family font (selection-wise).
2427 \begin_layout Description
2431 \begin_layout Subsection*
2435 \begin_layout Description
2436 Action Toggles Sans Serif family font (selection-wise).
2440 \begin_layout Description
2444 \begin_layout Subsection*
2448 \begin_layout Description
2449 Action Toggles Fraktur family font (math-mode, selection-wise).
2453 \begin_layout Description
2457 \begin_layout Description
2458 Origin vermeer, 10 Jan 2002
2461 \begin_layout Subsection*
2465 \begin_layout Description
2466 Action Toggles Italics font shape (math-mode, selection-wise).
2470 \begin_layout Description
2474 \begin_layout Description
2475 Origin vermeer, 10 Jan 2002
2478 \begin_layout Subsection*
2482 \begin_layout Description
2483 Action Reverts the settings of the font to the default values (selection-wise).
2487 \begin_layout Description
2491 \begin_layout Subsection*
2495 \begin_layout Description
2496 Action Sets font size according to lyx format string.
2500 \begin_layout Description
2501 Syntax font-size <SIZE>
2504 \begin_layout Description
2505 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2506 \begin_inset Newline newline
2509 largest|huge|giant|increase|decrease|default
2512 \begin_layout Subsection*
2513 LFUN_TEXTSTYLE_APPLY
2516 \begin_layout Description
2517 Action Toggle user-defined (=last-time used) text style.
2521 \begin_layout Description
2522 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2523 trigerred when using Text Style dialog.
2527 \begin_layout Description
2528 Syntax textstyle-apply
2531 \begin_layout Description
2532 Origin leeming, 12 Mar 2003
2535 \begin_layout Subsection*
2536 LFUN_TEXTSTYLE_UPDATE
2539 \begin_layout Description
2540 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2545 \begin_layout Description
2546 Syntax textstyle-update <FONT_INFO>
2549 \begin_layout Description
2550 Params <FONT_INFO>: specifies font atributes, e.g.
2551 family, series, shape, size, emph, noun, underbar, number, color, language,
2554 \begin_inset Newline newline
2557 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2561 \begin_layout Description
2562 Origin leeming, 12 Mar 2003
2565 \begin_layout Subsection*
2566 LFUN_SCREEN_FONT_UPDATE
2569 \begin_layout Description
2570 Action Update fonts and its metrics.
2574 \begin_layout Description
2575 Notion Automatically called after zoom, dpi, font names, or norm change.
2579 \begin_layout Description
2580 Syntax screen-font-update
2583 \begin_layout Description
2584 Origin ARRae, 13 Aug 2000
2587 \begin_layout Subsection*
2591 \begin_layout Description
2592 Action Returns the info about the current font.
2596 \begin_layout Description
2600 \begin_layout Subsection*
2601 LFUN_CITATION_INSERT
2604 \begin_layout Description
2605 Action Inserts citation from loaded citation database.
2609 \begin_layout Description
2610 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2613 \begin_layout Description
2614 Params <KEY>: Citation (shortcut listed in available citations).
2616 \begin_inset Newline newline
2619 <TEXT_BEFORE>: text which should appear before citation.
2623 \begin_layout Description
2624 Origin AAS, 97-02-23
2627 \begin_layout Subsection*
2628 LFUN_BIBTEX_DATABASE_ADD
2631 \begin_layout Description
2632 Action Adds database, which will be used for bibtex citations.
2636 \begin_layout Description
2637 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2638 bibliography) found from the cursor postion.
2642 \begin_layout Description
2643 Syntax bibtex-database-add <DATABASE-NAME>
2646 \begin_layout Description
2647 Origin Ale, 30 May 1997
2650 \begin_layout Subsection*
2651 LFUN_BIBTEX_DATABASE_DEL
2654 \begin_layout Description
2655 Action Adds database, which will be used for bibtex citations.
2659 \begin_layout Description
2660 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2661 X bibliography) found from the cursor postion.
2665 \begin_layout Description
2666 Syntax bibtex-database-del <DATABASE-NAME>
2669 \begin_layout Description
2670 Origin Ale, 30 May 1997
2673 \begin_layout Subsection*
2677 \begin_layout Description
2678 Action Sets the layout (that is, environment) for the current paragraph.
2682 \begin_layout Description
2683 Syntax layout <LAYOUT>
2686 \begin_layout Description
2687 Params <LAYOUT>: the layout to use
2690 \begin_layout Subsection*
2691 LFUN_LAYOUT_PARAGRAPH
2694 \begin_layout Description
2695 Action Launches the paragraph settings dialog.
2699 \begin_layout Description
2700 Syntax layout-paragraph
2703 \begin_layout Subsection*
2707 \begin_layout Description
2708 Action Launches the tabular settings dialog.
2712 \begin_layout Description
2713 Syntax layout-tabular
2716 \begin_layout Description
2717 Origin Jug, 31 Jul 2000
2720 \begin_layout Subsection*
2721 LFUN_DROP_LAYOUTS_CHOICE
2724 \begin_layout Description
2725 Action Displays list of layout choices.
2729 \begin_layout Description
2730 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2731 allowing for choice of layout.
2735 \begin_layout Description
2736 Syntax drop-layouts-choice
2739 \begin_layout Subsection*
2740 LFUN_LAYOUT_MODULES_CLEAR
2743 \begin_layout Description
2744 Action Clears the module list.
2748 \begin_layout Description
2749 Notion Clears the list of included modules for the current buffer.
2753 \begin_layout Description
2754 Syntax layout-modules-clear
2757 \begin_layout Description
2758 Origin rgh, 25 August 2007
2761 \begin_layout Subsection*
2762 LFUN_LAYOUT_MODULE_ADD
2765 \begin_layout Description
2766 Action Adds a module.
2770 \begin_layout Description
2771 Notion Adds a module to the list of included modules for the current buffer.
2775 \begin_layout Description
2776 Syntax layout-module-add <MODULE>
2779 \begin_layout Description
2780 Params <MODULE>: the module to be added
2783 \begin_layout Description
2784 Origin rgh, 25 August 2007
2787 \begin_layout Subsection*
2791 \begin_layout Description
2792 Action Reloads layout information.
2796 \begin_layout Description
2797 Notion Reloads all layout information for the current buffer from disk,
2798 thus recognizing any changes that have been made to layout files on the
2800 This is intended to be used only by layout developers and should not be
2801 used when one is trying to do actual work.
2805 \begin_layout Description
2806 Syntax layout-reload
2809 \begin_layout Description
2810 Origin rgh, 3 September 2007
2813 \begin_layout Subsection*
2814 LFUN_TEXTCLASS_APPLY
2817 \begin_layout Description
2818 Action Sets the text class for the current buffer.
2822 \begin_layout Description
2823 Syntax textclass-apply <TEXTCLASS>
2826 \begin_layout Description
2827 Params <TEXTCLASS>: the textclass to set.
2828 Note that this must be the filename, minus the ".layout" extension.
2832 \begin_layout Subsection*
2836 \begin_layout Description
2837 Action Loads information for a textclass from disk.
2841 \begin_layout Description
2842 Syntax textclass-load <TEXTCLASS>
2845 \begin_layout Description
2846 Params <TEXTCLASS>: the textclass to load.
2847 Note that this must be the filename, minus the ".layout" extension.
2851 \begin_layout Subsection*
2855 \begin_layout Description
2856 Action Disable selecting of text-region.
2860 \begin_layout Description
2864 \begin_layout Subsection*
2868 \begin_layout Description
2869 Action Enable selecting of text-region.
2873 \begin_layout Description
2874 Notion After enabling you can simply move arrow keys to get selected region.
2878 \begin_layout Description
2882 \begin_layout Subsection*
2886 \begin_layout Description
2887 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2891 \begin_layout Description
2895 \begin_layout Description
2896 Origin Andre, May 5 2006
2899 \begin_layout Subsection*
2903 \begin_layout Description
2904 Action Inserts math delimiters (e.g.
2905 parentheses, brackets) enclosing expression.
2909 \begin_layout Description
2910 Syntax math-delim [<LEFT>] [<RIGHT>]
2913 \begin_layout Description
2914 Params <LEFT/RIGHT>: Delimiters to be used.
2915 Each delimiter can be specified by either a LaTeX name or a valid character.
2916 ( is the default letter.
2920 \begin_layout Description
2921 Sample math-delim { rangle
2924 \begin_layout Description
2925 Origin Alejandro, 18 Jun 1996
2928 \begin_layout Subsection*
2932 \begin_layout Description
2933 Action Inserts math fixed size delimiters (e.g.
2934 parentheses, brackets) enclosing expression.
2938 \begin_layout Description
2939 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2942 \begin_layout Description
2943 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2944 \begin_inset Newline newline
2947 <L/RDELIM>: TeX code for delimiter.
2948 See Delimiter dialog for delimiters to be used.
2952 \begin_layout Description
2953 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2956 \begin_layout Description
2957 Origin Enrico & Georg, 7 May 2006
2960 \begin_layout Subsection*
2964 \begin_layout Description
2965 Action Creates a new displayed equation in text mode.
2966 Toggles inlined/display formula in math mode.
2970 \begin_layout Description
2971 Syntax math-display [<ARG>]
2974 \begin_layout Description
2975 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2976 new equation from the text mode.
2980 \begin_layout Description
2981 Origin Alejandro, 18 Jun 1996
2984 \begin_layout Subsection*
2988 \begin_layout Description
2989 Action Inserts math objects and symbols.
2993 \begin_layout Description
2994 Syntax math-insert <ARG>
2997 \begin_layout Description
2998 Params <ARG>: Symbol or LaTeX code to be inserted.
3002 \begin_layout Subsection*
3006 \begin_layout Description
3007 Action Enters subscript expression in math expression.
3011 \begin_layout Description
3012 Syntax math-subscript
3015 \begin_layout Description
3016 Origin vermeer, 12 Dec 2001
3019 \begin_layout Subsection*
3020 LFUN_MATH_SUPERSCRIPT
3023 \begin_layout Description
3024 Action Enters subscript expression in math expression.
3028 \begin_layout Description
3029 Syntax math-superscript
3032 \begin_layout Description
3033 Origin vermeer, 12 Dec 2001
3036 \begin_layout Subsection*
3040 \begin_layout Description
3041 Action Toggles the position of the limits from above/below to the right
3042 side an vice versa in integral symbol, a limit, a summation, etc.
3046 \begin_layout Description
3047 Notion Put the cursor before the symbol with the limits and then invoke
3052 \begin_layout Description
3053 Syntax math-limits [<STATE>]
3056 \begin_layout Description
3057 Params <STATE>: limits|nolimits
3060 \begin_layout Subsection*
3064 \begin_layout Description
3065 Action Inserts a math macro definition at the cursor position in the text.
3069 \begin_layout Description
3070 Syntax math-macro <NAME> [<NARGS>] [def]
3073 \begin_layout Description
3074 Params <NAME>: The name of the macro, e.g.
3076 <NARGS>: The number of parameters of the macro.
3078 "def": Has no effect anymore, just for compatibility with former LyX versions.
3082 \begin_layout Description
3083 Origin ale, 10 May 1997; sts, 21 Dec 2007
3086 \begin_layout Subsection*
3090 \begin_layout Description
3091 Action Mutates the type of math inset to the newly selected one.
3095 \begin_layout Description
3096 Syntax math-mutate <TYPE>
3099 \begin_layout Description
3100 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
3101 multline|gather|flalign
3104 \begin_layout Description
3105 Origin Andre, 23 May 2001
3108 \begin_layout Subsection*
3112 \begin_layout Description
3113 Action Inserts space into math expression.
3117 \begin_layout Description
3118 Notion Use spacebar after entering this space to change type of space.
3122 \begin_layout Description
3123 Syntax math-space [<TYPE>] [<LEN>]
3126 \begin_layout Description
3127 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
3129 \begin_inset Newline newline
3132 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
3134 \begin_inset Newline newline
3137 custom space: hspace
3138 \begin_inset Newline newline
3141 "," used by default.
3142 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
3144 <LEN>: length for custom spaces (hspace)
3147 \begin_layout Description
3148 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
3151 \begin_layout Subsection*
3155 \begin_layout Description
3156 Action Inserts a matrix.
3160 \begin_layout Description
3161 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3164 \begin_layout Description
3165 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3167 1 char) and the horizontal alignments (l, c or r) (i.e.
3172 \begin_layout Description
3173 Sample math-matrix 3 3 bccc
3176 \begin_layout Subsection*
3180 \begin_layout Description
3181 Action In text mode enters math mode (i.e.
3182 puts math insets on the current cursor position), in math mode enters text
3183 mode inside math expression.
3187 \begin_layout Description
3188 Notion If there is some selected text, it puts the text inside created math
3193 \begin_layout Description
3194 Syntax math-mode [<ARG>]
3197 \begin_layout Description
3198 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3203 \begin_layout Description
3204 Origin Alejandro, 4 Jun 1996
3207 \begin_layout Subsection*
3211 \begin_layout Description
3212 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3214 Used by the advanced search dialog.
3218 \begin_layout Description
3219 Notion If there is any selected text, then it is moved inside the created
3224 \begin_layout Description
3225 Syntax regexp-mode [<ARG>]
3228 \begin_layout Description
3229 Params <ARG>: eventual argument (regular expression).
3233 \begin_layout Description
3234 Origin Tommaso, 4 Oct 2008
3237 \begin_layout Subsection*
3238 LFUN_MATH_NUMBER_LINE_TOGGLE
3241 \begin_layout Description
3242 Action Toggles numbering of the current formula line.
3246 \begin_layout Description
3247 Notion Must be in display formula mode.
3251 \begin_layout Description
3252 Syntax math-number-line-toggle
3255 \begin_layout Description
3256 Origin Alejandro, 18 Jun 1996
3259 \begin_layout Subsection*
3260 LFUN_MATH_NUMBER_TOGGLE
3263 \begin_layout Description
3264 Action Toggles numbering/labeling of the current formula.
3268 \begin_layout Description
3269 Notion Must be in display formula mode.
3273 \begin_layout Description
3274 Syntax math-number-toggle
3277 \begin_layout Description
3278 Origin Alejandro, 4 Jun 1996
3281 \begin_layout Subsection*
3285 \begin_layout Description
3286 Action Calls external program and passes the current expression/equation
3287 as an argument for the calculation in the format appropriate to the given
3292 \begin_layout Description
3293 Notion Selection can be used to determine the input for the external program.
3297 \begin_layout Description
3298 Syntax math-extern <LANG> [<COMMAND>]
3301 \begin_layout Description
3302 Params <LANG>: octave|maxima|maple|mathematica|script
3303 \begin_inset Newline newline
3306 where "script" stands fot the external script (normalized expression will
3310 \begin_layout Description
3311 Origin Andre, 24 Apr 2001
3314 \begin_layout Description
3315 Sample math-extern maple simplify
3318 \begin_layout Subsection*
3322 \begin_layout Description
3323 Action Changes arbitrarily the size used by math fonts inside a context.
3327 \begin_layout Description
3328 Notion Provides an interface to the LaTeX math mode font size commands.
3332 \begin_layout Description
3333 Syntax math-size <STYLE>
3336 \begin_layout Description
3337 Params <STYLE>: displaystyle|
3346 \begin_layout Description
3347 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3350 \begin_layout Subsection*
3351 LFUN_MATH_FONT_STYLE
3354 \begin_layout Description
3355 Action Changes the text style used in math.
3359 \begin_layout Description
3360 Syntax math-font-style <STYLE>
3363 \begin_layout Description
3364 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
3365 trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
3368 \begin_layout Description
3369 Origin vfr, 9 jan 2009
3372 \begin_layout Subsection*
3373 LFUN_MATH_MACRO_UNFOLD
3376 \begin_layout Description
3377 Action Unfold a Math Macro.
3381 \begin_layout Description
3382 Notion Unfold the Math Macro the cursor is in, i.e.
3387 \begin_layout Description
3388 Syntax math-macro-unfold
3391 \begin_layout Description
3392 Origin sts, 06 January 2008
3395 \begin_layout Subsection*
3396 LFUN_MATH_MACRO_FOLD
3399 \begin_layout Description
3400 Action Fold a Math Macro.
3404 \begin_layout Description
3405 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3406 displayed as foo before.
3410 \begin_layout Description
3411 Syntax math-macro-fold
3414 \begin_layout Description
3415 Origin sts, 06 January 2008
3418 \begin_layout Subsection*
3419 LFUN_MATH_MACRO_ADD_PARAM
3422 \begin_layout Description
3423 Action Add a parameter.
3427 \begin_layout Description
3428 Notion Add a parameter to a Math Macro.
3432 \begin_layout Description
3433 Params <NUM>: The number of the parameter behind which the new one will
3434 be added (1 for the first, i.e.
3435 use 0 for add a parameter at the left), defaults to the last one.
3439 \begin_layout Description
3440 Syntax math-macro-add-param <NUM>
3443 \begin_layout Description
3444 Origin sts, 06 January 2008
3447 \begin_layout Subsection*
3448 LFUN_MATH_MACRO_REMOVE_PARAM
3451 \begin_layout Description
3452 Action Remove the last parameter.
3456 \begin_layout Description
3457 Notion Remove the last parameter of a Math Macro and remove its value in
3458 all instances of the macro in the buffer.
3462 \begin_layout Description
3463 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3464 defaults to the last one.
3468 \begin_layout Description
3469 Syntax math-macro-remove-param <NUM>
3472 \begin_layout Description
3473 Origin sts, 06 January 2008
3476 \begin_layout Subsection*
3477 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3480 \begin_layout Description
3481 Action Append a greedy parameter.
3485 \begin_layout Description
3486 Notion Append a greedy parameter to a Math Macro which eats the following
3487 mathed cell in every instance of the macro in the buffer.
3491 \begin_layout Description
3492 Syntax math-macro-append-greedy-param
3495 \begin_layout Description
3496 Origin sts, 06 January 2008
3499 \begin_layout Subsection*
3500 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3503 \begin_layout Description
3504 Action Remove a greedy parameter.
3508 \begin_layout Description
3509 Notion Remove a greedy parameter of a Math Macro and spit out the values
3510 of it in every instance of the macro in the buffer.
3511 If it is an optional parameter the [valud] format is used.
3515 \begin_layout Description
3516 Syntax math-macro-remove-greedy-param
3519 \begin_layout Description
3520 Origin sts, 06 January 2008
3523 \begin_layout Subsection*
3524 LFUN_MATH_MACRO_MAKE_OPTIONAL
3527 \begin_layout Description
3528 Action Make a parameter optional.
3532 \begin_layout Description
3533 Notion Turn the first non-optional parameter of a Math Macro into an optional
3534 parameter with a default value.
3538 \begin_layout Description
3539 Syntax math-macro-make-optional
3542 \begin_layout Description
3543 Origin sts, 06 January 2008
3546 \begin_layout Subsection*
3547 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3550 \begin_layout Description
3551 Action Make a parameter non-optional.
3555 \begin_layout Description
3556 Notion Turn the last optional parameter of a Math Macro into a non-optional
3558 The default value is remembered to be reused later if the user changes
3563 \begin_layout Description
3564 Syntax math-macro-make-nonoptional
3567 \begin_layout Description
3568 Origin sts, 06 January 2008
3571 \begin_layout Subsection*
3572 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3575 \begin_layout Description
3576 Action Add an optional parameter.
3580 \begin_layout Description
3581 Notion Insert an optional parameter just behind the already existing optional
3586 \begin_layout Description
3587 Syntax math-macro-add-optional-param
3590 \begin_layout Description
3591 Origin sts, 06 January 2008
3594 \begin_layout Subsection*
3595 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3598 \begin_layout Description
3599 Action Remove the last optional parameter.
3603 \begin_layout Description
3604 Notion Remove the last optional parameter of a Math Macro and remove it
3605 in all the instances of the macro in the buffer.
3609 \begin_layout Description
3610 Syntax math-macro-remove-optional-param
3613 \begin_layout Description
3614 Origin sts, 06 January 2008
3617 \begin_layout Subsection*
3618 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3621 \begin_layout Description
3622 Action Add a greedy optional parameter.
3626 \begin_layout Description
3627 Notion Add a greedy optional parameter which eats the value from the following
3628 cells in mathed which are in the [value] format.
3632 \begin_layout Description
3633 Syntax math-macro-add-greedy-optional-param
3636 \begin_layout Description
3637 Origin sts, 06 January 2008
3640 \begin_layout Subsection*
3641 LFUN_IN_MATHMACROTEMPLATE
3644 \begin_layout Description
3645 Action Only active in Math Macro definition.
3649 \begin_layout Description
3650 Notion Dummy function which is only active in a Math Macro definition.
3651 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3656 \begin_layout Description
3657 Syntax in-mathmacrotemplate
3660 \begin_layout Description
3661 Origin sts, 06 January 2008
3664 \begin_layout Subsection*
3665 LFUN_PARAGRAPH_MOVE_DOWN
3668 \begin_layout Description
3669 Action Moves the current paragraph downwards in the document.
3673 \begin_layout Description
3674 Syntax paragraph-move-down
3677 \begin_layout Description
3678 Origin Edwin, 8 Apr 2006
3681 \begin_layout Subsection*
3682 LFUN_PARAGRAPH_MOVE_UP
3685 \begin_layout Description
3686 Action Moves the current paragraph upwards in the document.
3690 \begin_layout Description
3691 Syntax paragraph-move-up
3694 \begin_layout Description
3695 Origin Edwin, 8 Apr 2006
3698 \begin_layout Subsection*
3702 \begin_layout Description
3703 Action Move the cursor to the next paragraph (or begining of the current
3704 one) in upward direction.
3708 \begin_layout Description
3712 \begin_layout Description
3713 Origin Asger, 1 Oct 1996
3716 \begin_layout Subsection*
3717 LFUN_PARAGRAPH_UP_SELECT
3720 \begin_layout Description
3721 Action Move the cursor and select the text to the next paragraph (or begining
3722 of the current one) in upward direction.
3726 \begin_layout Description
3727 Syntax paragraph-up-select
3730 \begin_layout Description
3731 Origin Asger, 1 Oct 1996
3734 \begin_layout Subsection*
3738 \begin_layout Description
3739 Action Move the cursor to the next paragraph (or begining of the current
3740 one) in downward direction.
3744 \begin_layout Description
3745 Syntax paragraph-down
3748 \begin_layout Description
3749 Origin Asger, 1 Oct 1996
3752 \begin_layout Subsection*
3753 LFUN_PARAGRAPH_DOWN_SELECT
3756 \begin_layout Description
3757 Action Move the cursor and select the text to the next paragraph (or begining
3758 of the current one) in downward direction.
3762 \begin_layout Description
3763 Syntax paragraph-down-select
3766 \begin_layout Description
3767 Origin Asger, 1 Oct 1996
3770 \begin_layout Subsection*
3774 \begin_layout Description
3775 Action Jump to a paragraph given by its id number and optionally the desired
3776 position within the paragraph.
3780 \begin_layout Description
3781 Notion Note that id number of paragraph is not the sequential number of
3782 paragraph seen on the screen.
3783 Moreover the id is unique for all opened buffers (documents).
3787 \begin_layout Description
3788 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3791 \begin_layout Description
3792 Params <PAR_ID_NUMBER>: paragraph id
3793 \begin_inset Newline newline
3796 <POSITION_IN_PAR>: desired position within the paragraph
3799 \begin_layout Description
3800 Origin Dekel, 26 Aug 2000
3803 \begin_layout Subsection*
3804 LFUN_BREAK_PARAGRAPH
3807 \begin_layout Description
3808 Action Breaks the current paragraph at the current location.
3812 \begin_layout Description
3813 Syntax break-paragraph
3816 \begin_layout Subsection*
3817 LFUN_BREAK_PARAGRAPH
3820 \begin_layout Description
3821 Action Breaks the current paragraph at the current location.
3825 \begin_layout Description
3826 Notion Removes the selection.
3830 \begin_layout Description
3831 Syntax break-paragraph [<LAYOUT>]
3834 \begin_layout Description
3835 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3836 default layout) when the cursor is at the end of the line.
3840 \begin_layout Subsection*
3841 LFUN_PARAGRAPH_PARAMS
3844 \begin_layout Description
3845 Action Change paragraph settings.
3849 \begin_layout Description
3850 Notion Modifies the current paragraph, or currently selected paragraphs.
3851 This function only modifies, and does not override, existing settings.
3852 Note that the "leftindent" indent setting is deprecated.
3856 \begin_layout Description
3857 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3860 \begin_layout Description
3870 \begin_inset Newline newline
3875 paragraph_spacing default|single|onehalf|double|other
3876 \begin_inset Newline newline
3881 align block|left|right|center|default
3882 \begin_inset Newline newline
3887 labelwidthstring WIDTH|
3890 \begin_inset Newline newline
3896 \begin_layout Description
3897 Origin rgh, Aug 15 2007
3900 \begin_layout Subsection*
3901 LFUN_PARAGRAPH_PARAMS_APPLY
3904 \begin_layout Description
3905 Action Change paragraph settings.
3909 \begin_layout Description
3910 Notion Overwrite all nonspecified settings to the default ones.
3911 Use paragraph-params lfun if you don't want to overwrite others settings.
3915 \begin_layout Description
3916 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3919 \begin_layout Description
3920 Params For parameters see LFUN_PARAGRAPH_PARAMS
3923 \begin_layout Description
3924 Origin leeming, 30 Mar 2004
3927 \begin_layout Subsection*
3928 LFUN_PARAGRAPH_UPDATE
3931 \begin_layout Description
3932 Action Updates the values inside the paragraph dialog from the paragraph.
3936 \begin_layout Description
3937 Notion This is internal LFUN, not to be used by users.
3938 Called internally by LFUN_DIALOG_UPDATE.
3942 \begin_layout Description
3943 Origin leeming, 13 Mar 2003
3946 \begin_layout Subsection*
3950 \begin_layout Description
3951 Action Move the current group in the upward direction in the structure of
3956 \begin_layout Description
3957 Notion The "group" can be Part/Chapter/Section/etc.
3958 It moves the whole substructure of the group.
3962 \begin_layout Description
3966 \begin_layout Description
3967 Origin Vermeer, 23 Mar 2006
3970 \begin_layout Subsection*
3974 \begin_layout Description
3975 Action Move the current group in the downward direction in the structure
3980 \begin_layout Description
3981 Notion The "group" can be Part/Chapter/Section/etc.
3982 It moves the whole substructure of the group.
3986 \begin_layout Description
3990 \begin_layout Description
3991 Origin Vermeer, 23 Mar 2006
3994 \begin_layout Subsection*
3998 \begin_layout Description
3999 Action Moves the current group in the downward direction in the hierarchy
4000 of the document structure.
4004 \begin_layout Description
4005 Notion Part -> Chapter -> Section -> etc.
4009 \begin_layout Description
4013 \begin_layout Description
4014 Origin Vermeer, 23 Mar 2006
4017 \begin_layout Subsection*
4021 \begin_layout Description
4022 Action Moves the current group in the upward direction in the hierarchy
4023 of the document structure.
4027 \begin_layout Description
4028 Notion Part <- Chapter <- Section <- etc.
4032 \begin_layout Description
4036 \begin_layout Description
4037 Origin Vermeer, 23 Mar 2006
4040 \begin_layout Subsection*
4044 \begin_layout Description
4045 Action Edit the inset at cursor with an external application, *
4046 if one is attributed.
4050 \begin_layout Description
4051 Syntax inset-edit [<INSET_PARAMS>]
4054 \begin_layout Description
4055 Params <INSET_PARAMS>: Parameters for the inset.
4057 \begin_inset Newline newline
4060 Currently only the filename will be considered.
4064 \begin_layout Description
4065 Origin JSpitzm, 27 Apr 2006
4068 \begin_layout Subsection*
4072 \begin_layout Description
4073 Action Inserts table into the document.
4077 \begin_layout Description
4078 Syntax tabular-insert [<ROWS> <COLUMNS>]
4081 \begin_layout Description
4082 Params In case no arguments are given show insert dialog.
4086 \begin_layout Description
4087 Origin Jug, 12 Apr 2000
4090 \begin_layout Subsection*
4091 LFUN_TABULAR_FEATURE
4094 \begin_layout Description
4095 Action Sets various features to the table/cell on the current cursor position.
4099 \begin_layout Description
4100 Notion Various math-environment features are handled here as well, e.g.
4101 add-vline-left/right for the Grid/Array environment
4104 \begin_layout Description
4105 Syntax tabular-feature <FEATURE> [<ARG>]
4108 \begin_layout Description
4109 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
4110 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4111 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
4112 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
4113 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
4114 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
4115 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
4116 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
4117 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4118 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
4119 |set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
4120 ar-valign-middle|tabular-valign-bottom
4121 \begin_inset Newline newline
4124 <ARG>: additional argument for some commands, use debug mode to explore
4129 \begin_layout Description
4130 Origin Jug, 28 Jul 2000
4133 \begin_layout Subsection*
4137 \begin_layout Description
4138 Action Moves the cursor to the previous cell inside the table.
4142 \begin_layout Description
4143 Syntax cell-backward
4146 \begin_layout Description
4147 Origin Jug, 22 May 2000
4150 \begin_layout Subsection*
4154 \begin_layout Description
4155 Action Moves the cursor to the next cell inside the table.
4159 \begin_layout Description
4163 \begin_layout Subsection*
4167 \begin_layout Description
4168 Action Splits cell and shifts right part to the next cell (inside the math
4173 \begin_layout Description
4177 \begin_layout Description
4178 Origin Ale, 15 May 1997
4181 \begin_layout Subsection*
4185 \begin_layout Description
4186 Action Register the document as an file inside version control system (RCS,
4191 \begin_layout Description
4192 Notion File is registered inside cvs, svn or rcs repository acording to
4193 the existence of cvs/svn/rcs entries in the document's directory.
4195 \begin_inset Newline newline
4198 See LyX Additional Features Manual (Version Control Chapter) for additional
4203 \begin_layout Description
4207 \begin_layout Description
4208 Origin Lgb, 1 Jul 1997
4211 \begin_layout Subsection*
4215 \begin_layout Description
4216 Action Checks-in/commits the changes of the registered file to the repository.
4220 \begin_layout Description
4221 Notion In RCS case this also unlocks the file.
4225 \begin_layout Description
4229 \begin_layout Description
4230 Origin Lgb, 1 Jul 1997
4233 \begin_layout Subsection*
4237 \begin_layout Description
4238 Action Checks-out the document for edit (and locks it for RCS).
4242 \begin_layout Description
4243 Notion This is implemented only for RCS and SVN, not CVS.
4247 \begin_layout Description
4251 \begin_layout Description
4252 Origin Lgb, 1 Jul 1997
4255 \begin_layout Subsection*
4259 \begin_layout Description
4260 Action Reverts the document to the last check-in/commit in VCS.
4264 \begin_layout Description
4268 \begin_layout Description
4269 Origin Lgb, 1 Jul 1997
4272 \begin_layout Subsection*
4276 \begin_layout Description
4277 Action Undo last check-in.
4281 \begin_layout Description
4282 Notion This is currently implemented only for RCS.
4286 \begin_layout Description
4290 \begin_layout Description
4291 Origin Lgb, 1 Jul 1997
4294 \begin_layout Subsection*
4298 \begin_layout Description
4299 Action Executes external command.
4300 This command is intended to support additional VCS commands.
4304 \begin_layout Description
4305 Syntax vc-command <FLAG> <PATH> <COMMAND>
4308 \begin_layout Description
4309 Params <FLAG>: Flags for the command can be combined together.
4311 \begin_inset Newline newline
4314 U - dUmmy - no flags
4315 \begin_inset Newline newline
4318 D - Doc - need document loaded to proceed
4319 \begin_inset Newline newline
4322 I - dIrty - mark document dirty
4323 \begin_inset Newline newline
4326 R - Reload - ensure that the document is saved and reload it after command
4328 \begin_inset Newline newline
4331 M - Message - ask for input string (commit message)
4332 \begin_inset Newline newline
4335 <PATH>: path where to start.
4336 $$p will be replaced by the current document path.
4338 \begin_inset Newline newline
4341 <COMMAND>: command to execute.
4342 $$i/$$p/$$m will be replaced by the current document/path/message.
4346 \begin_layout Description
4347 Sample vc-command DR $$p "svn up"
4350 \begin_layout Description
4351 Origin sanda, 13 Jan 2009
4354 \begin_layout Subsection*
4358 \begin_layout Description
4359 Action Toggles change tracking to on/off.
4363 \begin_layout Description
4364 Syntax changes-track
4367 \begin_layout Description
4368 Origin levon, 1 Oct 2002
4371 \begin_layout Subsection*
4375 \begin_layout Description
4376 Action Toggles showing of change tracking in typesetted output.
4380 \begin_layout Description
4381 Syntax changes-output
4384 \begin_layout Description
4385 Origin jspitzm, 21 Jan 2005
4388 \begin_layout Subsection*
4392 \begin_layout Description
4393 Action Moves the cursor to the position of the next change of the change
4398 \begin_layout Description
4402 \begin_layout Description
4403 Origin schmitt, 4 Oct 2006
4406 \begin_layout Subsection*
4407 LFUN_CHANGE_PREVIOUS
4410 \begin_layout Description
4411 Action Moves the cursor to the position of the previous change of the change
4416 \begin_layout Description
4417 Syntax change-previous
4420 \begin_layout Description
4421 Origin vfr, 4 Apr 2009
4424 \begin_layout Subsection*
4428 \begin_layout Description
4429 Action Open change tracking dialog for merging and moves the cursor to the
4430 position of the next change.
4434 \begin_layout Description
4435 Syntax changes-merge
4438 \begin_layout Description
4439 Origin Levon, 16 Oct 2002
4442 \begin_layout Subsection*
4446 \begin_layout Description
4447 Action Accepts tracked change inside the selection.
4451 \begin_layout Description
4452 Syntax change-accept
4455 \begin_layout Description
4456 Origin Levon, 16 Oct 2002
4459 \begin_layout Subsection*
4463 \begin_layout Description
4464 Action Rejects tracked change inside the selection.
4468 \begin_layout Description
4469 Syntax change-accept
4472 \begin_layout Description
4473 Origin Levon, 16 Oct 2002
4476 \begin_layout Subsection*
4477 LFUN_ALL_CHANGES_ACCEPT
4480 \begin_layout Description
4481 Action Accepts all tracked changes in the document.
4485 \begin_layout Description
4486 Syntax all-changes-accept
4489 \begin_layout Description
4490 Origin Levon, 16 Oct 2002
4493 \begin_layout Subsection*
4494 LFUN_ALL_CHANGES_REJECT
4497 \begin_layout Description
4498 Action Rejects all tracked changes in the document.
4502 \begin_layout Description
4503 Notion Reject does not work recursively; the user may have to repeat the
4508 \begin_layout Description
4509 Syntax all-changes-reject
4512 \begin_layout Description
4513 Origin Levon, 16 Oct 2002
4516 \begin_layout Subsection*
4520 \begin_layout Description
4521 Action Apply data for an inset.
4525 \begin_layout Description
4526 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4528 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4529 on the context where it is called.
4533 \begin_layout Description
4534 Syntax inset-apply <ARGS>
4537 \begin_layout Description
4538 Params See LFUN_INSET_INSERT .
4542 \begin_layout Subsection*
4546 \begin_layout Description
4547 Action Dissolve the current inset into text.
4551 \begin_layout Description
4552 Syntax inset-dissolve [<INSET>]
4555 \begin_layout Description
4556 Params <INSET>: this can be used to make sure the right kind of inset is
4558 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4559 the charstyle inset, even if the cursor is inside several nested insets
4562 \begin_inset Newline newline
4565 For values see lyx::InsetLayout::lyxtype_ .
4569 \begin_layout Description
4570 Origin JSpitz, 7 Aug 2006
4573 \begin_layout Subsection*
4577 \begin_layout Description
4578 Action Insert new inset (type given by the parameters).
4582 \begin_layout Description
4583 Syntax inset-insert <INSET> <ARGS>
4586 \begin_layout Description
4587 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4588 nclude|index|label|nomencl|vspace|ref|toc>
4589 \begin_inset Newline newline
4592 <ARGS>: depends on the given inset.
4593 Use "lyx -dbg action" to explore.
4597 \begin_layout Description
4598 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4601 \begin_inset Newline newline
4604 where <label name> is the name of the referenced label and<Format> is one
4606 \begin_inset Newline newline
4610 \begin_inset Newline newline
4613 eqref -- (<reference>)
4614 \begin_inset Newline newline
4618 \begin_inset Newline newline
4621 vpageref -- on <page>
4622 \begin_inset Newline newline
4625 vref -- <reference> on <page>
4626 \begin_inset Newline newline
4629 prettyref -- Formatted reference
4632 \begin_layout Subsection*
4636 \begin_layout Description
4637 Action Modify existing inset.
4641 \begin_layout Description
4642 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4643 graphics, include, label, listings, note, phantom, ref, space, tabular,
4644 vspace, wrap insets.
4648 \begin_layout Description
4649 Syntax inset-modify <INSET> <ARGS>
4652 \begin_layout Description
4653 Params See LFUN_INSET_INSERT for further details.
4657 \begin_layout Subsection*
4658 LFUN_NEXT_INSET_MODIFY
4661 \begin_layout Description
4662 Action Modify the inset at cursor position, if there is one.
4666 \begin_layout Description
4667 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4668 graphics, include, label, listings, note, phantom, ref, space, tabular,
4669 vspace, wrap insets.
4673 \begin_layout Description
4674 Syntax next-inset-modify <INSET> <ARGS>
4677 \begin_layout Description
4678 Syntax next-inset-modify changetype <TYPE>
4681 \begin_layout Description
4682 Params See LFUN_INSET_INSERT for further details.
4686 \begin_layout Description
4687 Origin JSpitzm, 23 Mar 2008
4690 \begin_layout Subsection*
4691 LFUN_INSET_DIALOG_UPDATE
4694 \begin_layout Description
4695 Action Updates the values inside the dialog from the inset.
4699 \begin_layout Description
4700 Notion This is internal LFUN, not to be used by users.
4701 Called internally by LFUN_DIALOG_UPDATE
4704 \begin_layout Description
4705 Params <DIALOG-NAME>
4708 \begin_layout Description
4709 Origin leeming, 25 Feb 2003
4712 \begin_layout Subsection*
4716 \begin_layout Description
4717 Action Open the inset's properties dialog.
4721 \begin_layout Description
4722 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, *
4723 float, graphics, href, include, index, index_print, label,
4724 listings, * note, phantom, ref, space, tabular, vspace, wrap
4729 \begin_layout Description
4730 Syntax inset-settings <INSET>
4733 \begin_layout Description
4734 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
4735 * graphics|href|include|index|index_print|label|listings|
4736 * note|phantom|ref|space|tabular|vspace|wrap>.
4740 \begin_layout Subsection*
4744 \begin_layout Description
4745 Action Toggles the collapsable inset at cursor position, * or
4746 the inset we are currently in.
4750 \begin_layout Description
4751 Syntax inset-toggle [<ARG>]
4754 \begin_layout Description
4755 Params <ARG>: <open|close|toggle|assign>.
4757 \begin_inset Newline newline
4760 open/close/toggle are for collapsable insets.
4761 toggle is used when no argument is given.
4763 \begin_inset Newline newline
4766 assign synchronize the branch-inset with activation status of the branch.
4767 Used for global toggling when changed activation.
4771 \begin_layout Description
4772 Origin lasgouttes, 19 Jul 2001
4775 \begin_layout Subsection*
4776 LFUN_ALL_INSETS_TOGGLE
4779 \begin_layout Description
4780 Action Toggles (open/closes) all collapsable insets (of a given type) in
4785 \begin_layout Description
4786 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4790 \begin_layout Description
4791 Syntax all-insets-toggle [<STATE>] [<INSET>]
4794 \begin_layout Description
4795 Params <STATE>: <toggle|open|close|assign> default: toggle
4796 \begin_inset Newline newline
4799 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4803 \begin_layout Description
4804 Origin leeming, 30 Mar 2004
4807 \begin_layout Subsection*
4808 LFUN_SET_GRAPHICS_GROUP
4811 \begin_layout Description
4812 Action Set the group for the graphics inset on the cursor position.
4816 \begin_layout Description
4817 Syntax set-graphics-group [<GROUP>]
4820 \begin_layout Description
4821 Params <GROUP>: Id for an existing group.
4822 In case the Id is an empty string, the graphics inset is removed from the
4827 \begin_layout Description
4828 Origin sanda, 6 May 2008
4831 \begin_layout Subsection*
4832 LFUN_FINISHED_FORWARD
4835 \begin_layout Description
4836 Action Moves the cursor out of the current slice, going forward.
4840 \begin_layout Description
4841 Notion Cursor movement within an inset may be different than cursor movement
4842 in the surrounding text.
4843 This action should be called automatically by the cursor movement within
4844 the inset, when movement within the inset has ceased (reached the end of
4845 the last paragraph, for example), in order to move correctly back into
4846 the surrounding text.
4850 \begin_layout Subsection*
4851 LFUN_FINISHED_BACKWARD
4854 \begin_layout Description
4855 Action Moves the cursor out of the current slice, going backwards.
4859 \begin_layout Description
4860 Notion See also LFUN_FINISHED_FORWARD.
4864 \begin_layout Subsection*
4868 \begin_layout Description
4869 Action Moves the cursor out of the current slice, going right.
4873 \begin_layout Description
4874 Notion See also LFUN_FINISHED_FORWARD
4877 \begin_layout Subsection*
4881 \begin_layout Description
4882 Action Moves the cursor out of the current slice, going left.
4886 \begin_layout Description
4887 Notion See also LFUN_FINISHED_FORWARD.
4891 \begin_layout Subsection*
4895 \begin_layout Description
4896 Action Set language from the current cursor position.
4900 \begin_layout Description
4901 Syntax language <LANG>
4904 \begin_layout Description
4905 Params <LANG>: Requested language.
4906 Look in lib/languages for the list.
4910 \begin_layout Description
4911 Origin Dekel, 2 Mar 2000
4914 \begin_layout Subsection*
4918 \begin_layout Description
4919 Action Goto a label.
4923 \begin_layout Description
4924 Syntax label-goto [<LABEL>]
4927 \begin_layout Description
4928 Params <LABEL>: Requested label.
4929 If no label is given and reference is on cursor position, Bookmark 0 is
4930 saved and cursor moves to the position of referenced label.
4934 \begin_layout Description
4935 Origin Ale, 6 Aug 1997
4938 \begin_layout Subsection*
4942 \begin_layout Description
4943 Action Inserts label to text or displayed formula.
4947 \begin_layout Description
4948 Syntax label-insert [<LABEL>]
4951 \begin_layout Description
4952 Params <LABEL>: Requested label.
4953 If no label is given dialog requesting name will be opened.
4957 \begin_layout Subsection*
4961 \begin_layout Description
4962 Action Go to the next label or cross-reference.
4966 \begin_layout Description
4967 Syntax reference-next
4970 \begin_layout Description
4971 Origin Dekel, 14 Jan 2001
4974 \begin_layout Subsection*
4978 \begin_layout Description
4979 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
4980 Note that bookmarsk are saved per-session, not per file.
4984 \begin_layout Description
4985 Notion Bookmark 0 has a special purpose.
4986 It is automatically set
4987 \begin_inset Newline newline
4991 to the paragraph you are currently editing
4992 \begin_inset Newline newline
4996 to the paragraph from where you are jumping to the last-edited position
4998 \begin_inset Newline newline
5002 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
5006 \begin_layout Description
5007 Syntax bookmark-goto <NUMBER>
5010 \begin_layout Description
5011 Params <NUMBER>: the number of the bookmark to restore.
5015 \begin_layout Description
5016 Origin Dekel, 27 January 2001
5019 \begin_layout Subsection*
5023 \begin_layout Description
5024 Action Save a bookmark.
5028 \begin_layout Description
5029 Notion Saves a numbered bookmark to the sessions file.
5030 The number must be between 1 and 9, inclusive.
5031 Note that bookmarks are saved per-session, not per file.
5035 \begin_layout Description
5036 Syntax bookmark-save <NUMBER>
5039 \begin_layout Description
5040 Params <NUMBER>: the number of the bookmark to save.
5044 \begin_layout Description
5045 Origin Dekel, 27 January 2001
5048 \begin_layout Subsection*
5052 \begin_layout Description
5053 Action Clears the list of saved bookmarks.
5057 \begin_layout Description
5058 Syntax bookmark-clear
5061 \begin_layout Description
5062 Origin bpeng, 31 October 2006
5065 \begin_layout Subsection*
5069 \begin_layout Description
5070 Action Open the given help file according to the language setting.
5074 \begin_layout Description
5075 Syntax help-open <FILE>[.lyx]
5078 \begin_layout Description
5079 Params <FILE>: any document from (/usr/share/)doc directory.
5083 \begin_layout Description
5084 Origin Jug, 27 Jun 1999
5087 \begin_layout Subsection*
5091 \begin_layout Description
5092 Action Terminates the current LyX instance.
5096 \begin_layout Description
5097 Notion Terminates the current LyX instance, asking whether to save modified
5102 \begin_layout Description
5106 \begin_layout Subsection*
5110 \begin_layout Description
5111 Action Toggles visibility of a given toolbar between on/off/auto.
5115 \begin_layout Description
5116 Notion Skiping "auto" when allowauto is false.
5120 \begin_layout Description
5121 Syntax toolbar-toggle <NAME> [allowauto]
5124 \begin_layout Description
5125 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
5126 ew/update|math_panels|vcs
5129 \begin_layout Description
5130 Origin Edwin, 21 May 2007
5133 \begin_layout Subsection*
5137 \begin_layout Description
5138 Action Opens the menu given by its name.
5142 \begin_layout Description
5143 Syntax menu-open <NAME>
5146 \begin_layout Description
5147 Params <NAME>: menu name.
5148 See various .inc files in lib/ui for candidates.
5152 \begin_layout Subsection*
5156 \begin_layout Description
5157 Action Various UI visibility-toggling actions.
5161 \begin_layout Description
5162 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5165 \begin_layout Description
5166 Params statusbar : Toggle visibility of the statusbar.
5168 \begin_inset Newline newline
5171 menubar : Toggle visibility of the menubar.
5173 \begin_inset Newline newline
5176 scrollbar : Toggle visibility of the scrollbar.
5178 \begin_inset Newline newline
5181 frame : Toggle visibility of the frames around editing window.
5183 \begin_inset Newline newline
5186 fullscreen : Toggle fullscreen mode.
5187 This also covers calling the previous functions.
5188 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5193 \begin_layout Description
5194 Origin sanda, 9 Feb 2007
5197 \begin_layout Subsection*
5201 \begin_layout Description
5202 Action Creates new empty LyX window.
5206 \begin_layout Description
5207 Notion Already opened documents from the previous window can be found under
5212 \begin_layout Description
5213 Syntax window-new [<GEOMETRY>]
5216 \begin_layout Description
5217 Params <GEOMETRY>: pass the geometry of the window.
5218 This parameter is currently accepted only on Windows platform.
5222 \begin_layout Description
5223 Origin Abdel, 21 Oct 2006
5226 \begin_layout Subsection*
5230 \begin_layout Description
5231 Action Closes the current LyX window.
5235 \begin_layout Description
5239 \begin_layout Description
5240 Origin Abdel, 23 Oct 2006
5243 \begin_layout Subsection*
5247 \begin_layout Description
5248 Action Creates another split view of current buffer.
5252 \begin_layout Description
5253 Notion All split views act in the same way indpendently.
5257 \begin_layout Description
5258 Syntax split-view <vertical|horizontal>
5261 \begin_layout Description
5262 Params horizontal : The work areas are laid out side by side.
5264 \begin_inset Newline newline
5267 vertical : The work areas laid out vertically.
5271 \begin_layout Description
5272 Origin Abdel, 20 Feb 2008
5275 \begin_layout Subsection*
5276 LFUN_CLOSE_TAB_GROUP
5279 \begin_layout Description
5280 Action Close the current tab group.
5284 \begin_layout Description
5285 Notion This only closes the work areas, not the buffer themselves.
5286 The still opened buffers can be visualized in another tab group.
5290 \begin_layout Description
5291 Syntax close-tab-group
5294 \begin_layout Description
5295 Origin Abdel, 21 Feb 2008
5298 \begin_layout Subsection*
5302 \begin_layout Description
5303 Action Shows hidden dialog or create new one for a given function/inset
5308 \begin_layout Description
5309 Syntax dialog-show <NAME> [<DATA>]
5312 \begin_layout Description
5313 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5315 \begin_inset Newline newline
5318 document|errorlist|ert|external|file|findreplace|float|graphics|
5319 \begin_inset Newline newline
5322 include|index|info|nomenclature|label|listings|log|mathdelimiter|
5323 \begin_inset Newline newline
5326 mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space|
5327 \begin_inset Newline newline
5330 spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|
5332 \begin_inset Newline newline
5335 view-source|vspace|wrap|<SPECIAL>
5336 \begin_inset Newline newline
5339 <SPECIAL>: latexlog|vclog
5340 \begin_inset Newline newline
5343 <DATA>: data, usually settings for the given dialog.
5344 Use debug mode for the details.
5348 \begin_layout Description
5349 Origin leeming, 17 Jun 2003
5352 \begin_layout Subsection*
5353 LFUN_DIALOG_SHOW_NEW_INSET
5356 \begin_layout Description
5357 Action Shows hidden dialog or create new one for a given inset settings
5362 \begin_layout Description
5363 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5368 \begin_layout Description
5369 Syntax dialog-show-new-inset <NAME> [<DATA>]
5372 \begin_layout Description
5373 Params See LFUN_DIALOG_SHOW .
5377 \begin_layout Description
5378 Origin leeming, 25 Feb 2003
5381 \begin_layout Subsection*
5385 \begin_layout Description
5386 Action Updates the dialog values from the inset/paragraph/document.
5390 \begin_layout Description
5391 Syntax dialog-update <NAME>
5394 \begin_layout Description
5395 Params <NAME>: paragraph|prefs|<INSET>
5396 \begin_inset Newline newline
5402 \begin_layout Description
5403 Origin leeming, 25 Feb 2003
5406 \begin_layout Subsection*
5410 \begin_layout Description
5411 Action Hides showed dialog.
5412 Counterpart to LFUN_DIALOG_SHOW .
5416 \begin_layout Description
5417 Syntax dialog-hide <NAME>
5420 \begin_layout Description
5421 Params See LFUN_DIALOG_SHOW .
5425 \begin_layout Description
5426 Origin leeming, 25 Feb 2003
5429 \begin_layout Subsection*
5433 \begin_layout Description
5434 Action Toggles dialog between showed/hidden state.
5438 \begin_layout Description
5439 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5443 \begin_layout Description
5444 Syntax dialog-toggle <NAME> [<DATA>]
5447 \begin_layout Description
5448 Params See LFUN_DIALOG_SHOW .
5452 \begin_layout Description
5453 Origin JSpitzm, 30 Apr 2007
5456 \begin_layout Subsection*
5457 LFUN_DIALOG_DISCONNECT_INSET
5460 \begin_layout Description
5461 Action Closes opened connection to opened inset.
5465 \begin_layout Description
5466 Notion Connection is used for apply functions.
5470 \begin_layout Description
5471 Syntax dialog-disconnect-inset <INSET-NAME>
5474 \begin_layout Description
5475 Origin leeming, 25 Feb 2003
5478 \begin_layout Subsection*
5482 \begin_layout Description
5483 Action This function is called when mouse button is pressed (inside workarea).Act
5484 ion depends on the context.
5488 \begin_layout Description
5489 Notion This is internal LFUN, not to be used by users.
5493 \begin_layout Description
5494 Origin Andre, 9 Aug 2002
5497 \begin_layout Subsection*
5501 \begin_layout Description
5502 Action This function is called when double click on mouse button is pressed
5504 Action depends on the context.
5508 \begin_layout Description
5509 Notion This is internal LFUN, not to be used by users.
5513 \begin_layout Description
5514 Origin Andre, 9 Aug 2002
5517 \begin_layout Subsection*
5521 \begin_layout Description
5522 Action This function is called when triple click on mouse button is pressed
5524 Action depends on the context.
5528 \begin_layout Description
5529 Notion This is internal LFUN, not to be used by users.
5533 \begin_layout Description
5534 Origin Andre, 9 Aug 2002
5537 \begin_layout Subsection*
5541 \begin_layout Description
5542 Action This function is called when mouse cursor is moving over the text.Action
5543 depends on the context.
5547 \begin_layout Description
5548 Notion This is internal LFUN, not to be used by users.
5552 \begin_layout Description
5553 Origin Andre, 9 Aug 2002
5556 \begin_layout Subsection*
5560 \begin_layout Description
5561 Action This function is called when mouse button is released (inside workarea).Ac
5562 tion depends on the context.
5566 \begin_layout Description
5567 Notion This is internal LFUN, not to be used by users.
5571 \begin_layout Description
5572 Origin Andre, 9 Aug 2002
5575 \begin_layout Subsection*
5579 \begin_layout Description
5580 Action Turn off the loaded keyboard map.
5584 \begin_layout Description
5588 \begin_layout Subsection*
5592 \begin_layout Description
5593 Action Turn on the primary keyboard map.
5597 \begin_layout Description
5598 Notion Maps were widely used in past, when X-windows didn't have nowadays
5600 They can be still used to maintain uniform keyboard layout across the various
5603 \begin_inset Newline newline
5606 The language is to be set in the Preferences dialog.
5610 \begin_layout Description
5611 Syntax keymap-primary
5614 \begin_layout Subsection*
5615 LFUN_KEYMAP_SECONDARY
5618 \begin_layout Description
5619 Action Turn on the secondary keyboard map.
5623 \begin_layout Description
5624 Syntax keymap-secondary
5627 \begin_layout Subsection*
5631 \begin_layout Description
5632 Action Toggles keyboard maps (first/second/off).
5636 \begin_layout Description
5637 Syntax keymap-toggle
5640 \begin_layout Description
5641 Origin leeming, 30 Mar 2004
5644 \begin_layout Subsection*
5645 LFUN_SERVER_GET_LAYOUT
5648 \begin_layout Description
5649 Action Returns the current layout (that is environment) name on the cursor
5654 \begin_layout Description
5655 Syntax server-get-layout
5658 \begin_layout Subsection*
5659 LFUN_SERVER_GET_FILENAME
5662 \begin_layout Description
5663 Action Returns path and file name of the currently edited document.
5667 \begin_layout Description
5668 Syntax server-get-filename
5671 \begin_layout Subsection*
5672 LFUN_SERVER_GOTO_FILE_ROW
5675 \begin_layout Description
5676 Action Sets the cursor position based on the row number of generated TeX
5681 \begin_layout Description
5682 Notion This can be useful for DVI inverse-search or detection of the problematic
5683 line from LaTeX compilation.
5684 Note that before this function can be used export to LaTeX output must
5685 occur (in order to map the row numbers).
5689 \begin_layout Description
5690 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5693 \begin_layout Description
5694 Params <FILE>: the filename.
5695 Environment variables are expaned in the path.
5696 In case this LFUN does not work make sure you are giving correct path to
5699 \begin_inset Newline newline
5702 If the file is located inside LyX temporary directory it will be mapped
5703 back into the appropriate opened buffer (e.g.
5704 for the case of generated .tex file).
5705 .ext: extensions will be automatically replaced by .lyx.
5709 \begin_layout Description
5710 Origin Edmar, 23 Dec 1998
5713 \begin_layout Subsection*
5717 \begin_layout Description
5718 Action Sends notify message about the last key-sequence to client.
5722 \begin_layout Description
5723 Notion This can be used to grab last key-sequence used inside the LyX window.
5724 See also Debug extensions section in Additional features manual.
5728 \begin_layout Description
5729 Syntax server-notify
5732 \begin_layout Subsection*
5736 \begin_layout Description
5737 Action Sets the cursor position based on the editing area coordinates (similar
5738 as clicking on that point with left mouse button).
5742 \begin_layout Description
5743 Syntax server-set-xy <X> <Y>
5746 \begin_layout Subsection*
5750 \begin_layout Description
5751 Action Returns the coordinates of cursor position in the editing area.
5755 \begin_layout Description
5756 Syntax server-get-xy
5759 \begin_layout Subsection*
5763 \begin_layout Description
5764 Action Generates the code (literate programming).
5768 \begin_layout Description
5769 Notion Latex file with extension literate_extension is generated.
5770 Then LyX invokes build_command (with a default of``make'') to generate
5771 the code and build_error_filter to process the compilation error messages.
5773 \begin_inset Newline newline
5776 In case you want to process your literate file with a script, or some other
5777 program, just insert in your lyxrc file an entry with:
5778 \begin_inset Newline newline
5781 build_command "my_script my_arguments"
5782 \begin_inset Newline newline
5785 The build_error_filter differs from the literate_error_filter only in that
5786 the former will identify error messages from your compiler.
5790 \begin_layout Description
5791 Syntax build-program
5794 \begin_layout Subsection*
5795 LFUN_BUFFER_AUTO_SAVE
5798 \begin_layout Description
5799 Action Saves the current buffer to a temporary file.
5803 \begin_layout Description
5804 Notion Saves the current buffer to a file named "#filename#".
5805 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5809 \begin_layout Description
5810 Syntax buffer-auto-save
5813 \begin_layout Subsection*
5814 LFUN_BUFFER_CHILD_OPEN
5817 \begin_layout Description
5818 Action Loads the given child document.
5822 \begin_layout Description
5823 Notion The current document is treated as a parent.
5827 \begin_layout Description
5828 Syntax buffer-child-open <FILE>
5831 \begin_layout Description
5832 Params <FILE>: Filename of the child.
5833 The directory of the parent is assumed by default.
5837 \begin_layout Description
5838 Origin Ale, 28 May 1997
5841 \begin_layout Subsection*
5845 \begin_layout Description
5846 Action Runs chktex for the current document.
5850 \begin_layout Description
5851 Syntax buffer-chktex
5854 \begin_layout Description
5855 Origin Asger, 30 Oct 1997
5858 \begin_layout Subsection*
5859 LFUN_BUFFER_TOGGLE_COMPRESSION
5862 \begin_layout Description
5863 Action Toggles compression of the current document on/off.
5867 \begin_layout Description
5868 Syntax buffer-toggle-compression
5871 \begin_layout Description
5872 Origin bpeng, 27 Apr 2006
5875 \begin_layout Subsection*
5879 \begin_layout Description
5880 Action Closes the current buffer.
5884 \begin_layout Description
5885 Notion Closes the current buffer, asking whether to save it, etc, if the
5886 buffer has been modified.
5890 \begin_layout Description
5894 \begin_layout Subsection*
5898 \begin_layout Description
5899 Action Exports the current buffer (document) to the given format.
5903 \begin_layout Description
5904 Syntax buffer-export <FORMAT>
5907 \begin_layout Description
5908 Params <FORMAT> is either "custom" or one of the formats which you can find
5909 in Tools->Preferences->File formats->Format.
5910 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5911 for pdflatex) or "ps" for postscript.
5913 \begin_inset Newline newline
5916 In case of "custom" you will be asked for a format you want to start from
5917 and for the command that you want to apply to this format.
5918 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5922 \begin_layout Description
5923 Origin Lgb, 29 Jul 1997
5926 \begin_layout Subsection*
5927 LFUN_BUFFER_EXPORT_CUSTOM
5930 \begin_layout Description
5931 Action Exports the current buffer (document) from the given format using
5932 the given command on it.
5936 \begin_layout Description
5937 Syntax buffer-export-custom <FORMAT> <COMMAND>
5940 \begin_layout Description
5941 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5944 \begin_inset Newline newline
5947 <COMMAND> this command will be launched on the file.
5948 Note that you can use "$$FName" string to qualify the intermediate file.
5952 \begin_layout Description
5953 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5956 \begin_layout Description
5957 Origin leeming, 27 Mar 2004
5960 \begin_layout Subsection*
5964 \begin_layout Description
5965 Action Prints the current document.
5969 \begin_layout Description
5970 Notion Many settings can be given via the preferences dialog.
5974 \begin_layout Description
5975 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5978 \begin_layout Description
5979 Params <TARGET> is either "printer" or "file".
5981 \begin_inset Newline newline
5984 <TARGER-NAME> is either "default" or file name or printer name.
5986 \begin_inset Newline newline
5989 <COMMAND> command ensuring the printing job.
5993 \begin_layout Description
5994 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5997 \begin_layout Description
5998 Origin leeming, 28 Mar 2004
6001 \begin_layout Subsection*
6005 \begin_layout Description
6006 Action Import a given file as a lyx document.
6010 \begin_layout Description
6011 Notion File can be imported iff lyx file format is (transitively) reachable
6012 via defined convertors in preferences.
6013 Look into File->Import menu to get an idea of the currently active import
6018 \begin_layout Description
6019 Syntax buffer-import <FORMAT> [<FILE>]
6022 \begin_layout Description
6023 Origin Asger, 24 Jul 1998
6026 \begin_layout Subsection*
6030 \begin_layout Description
6031 Action Creates a new buffer (that is, document).
6035 \begin_layout Description
6036 Notion Implicit path can be set in Preferences dialog.
6040 \begin_layout Description
6041 Syntax buffer-new [<FILE>]
6044 \begin_layout Description
6045 Params <FILE>: filename of created file with absolute path.
6049 \begin_layout Subsection*
6050 LFUN_BUFFER_NEW_TEMPLATE
6053 \begin_layout Description
6054 Action Creates a new buffer (that is, document) from a template.
6058 \begin_layout Description
6059 Notion Path for new files and templates can be set in Preferences dialog.
6060 Template will be asked for via Open-dialog.
6064 \begin_layout Description
6065 Syntax buffer-new-template [<FILE>]
6068 \begin_layout Description
6069 Params <FILE>: filename of created file with absolute path.
6073 \begin_layout Subsection*
6077 \begin_layout Description
6078 Action Reverts opened document.
6082 \begin_layout Description
6083 Syntax buffer-reload
6086 \begin_layout Description
6087 Origin Asger, 2 Feb 1997
6090 \begin_layout Subsection*
6094 \begin_layout Description
6095 Action Switch to the given buffer.
6099 \begin_layout Description
6100 Notion This is useful also in case you need simultaneously more views of
6101 the edited document in different LyX windows.
6105 \begin_layout Description
6106 Syntax buffer-new-template <BUFFER>
6109 \begin_layout Description
6110 Params <BUFFER>: already opened document which is to be shown.
6114 \begin_layout Subsection*
6115 LFUN_BUFFER_TOGGLE_READ_ONLY
6118 \begin_layout Description
6119 Action Toggle editing mode of the current document between read/write and
6124 \begin_layout Description
6125 Notion In the ->Readonly mode checks-in/commits the data if the file is
6126 under version control.
6127 In the Readonly-> mode checkouts the data from repository.
6129 \begin_inset Newline newline
6132 If these operations fail, buffer won't be toggled.
6136 \begin_layout Description
6137 Syntax buffer-toggle-read-only
6140 \begin_layout Description
6141 Origin Lgb, 27 May 1997
6144 \begin_layout Subsection*
6148 \begin_layout Description
6149 Action Displays current buffer in chosen format.
6153 \begin_layout Description
6154 Notion Displays the contents of the current buffer in the chosen format,
6155 for example, PDF or DVI.
6156 This runs the necessary converter, calls the defined viewer, and so forth.
6160 \begin_layout Description
6161 Syntax buffer-view [<FORMAT>]
6164 \begin_layout Description
6165 Params <FORMAT>: The format to display, where this is one of the formats
6166 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6167 If no format is given, the default format as specified in the same dialog
6172 \begin_layout Subsection*
6176 \begin_layout Description
6177 Action Exports the current document and put the result into the temporary
6182 \begin_layout Description
6183 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6184 EW) the output will be rewriten - updated.
6185 This is useful in case your viewer is able to detect such changes (e.g.
6186 ghostview for postscript).
6190 \begin_layout Description
6191 Syntax buffer-update [<FORMAT>]
6194 \begin_layout Description
6195 Params <FORMAT>: The format to display, where this is one of the formats
6196 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6197 If no format is given, the default format as specified in the same dialog
6202 \begin_layout Description
6203 Origin Dekel, 5 Aug 2000
6206 \begin_layout Subsection*
6210 \begin_layout Description
6211 Action Saves the current buffer.
6215 \begin_layout Description
6216 Notion Saves the current buffer to disk, using the filename that is already
6217 associated with the buffer, asking for one if none is yet assigned.
6221 \begin_layout Description
6225 \begin_layout Subsection*
6226 LFUN_BUFFER_WRITE_AS
6229 \begin_layout Description
6230 Action Rename and save current buffer.
6234 \begin_layout Description
6235 Syntax buffer-write-as <FILENAME>
6238 \begin_layout Description
6239 Params <FILENAME>: New name of the buffer/file.
6240 A relative path is with respect to the original location of the buffer/file.
6244 \begin_layout Subsection*
6245 LFUN_BUFFER_WRITE_ALL
6248 \begin_layout Description
6249 Action Save all changed documents.
6253 \begin_layout Description
6254 Syntax buffer-write-all
6257 \begin_layout Description
6258 Origin rgh, gpothier 6 Aug 2007
6261 \begin_layout Subsection*
6265 \begin_layout Description
6266 Action Switch to the next opened document.
6270 \begin_layout Description
6271 Notion Note that this does not necessarily mean next in tabbar (for full
6272 list see View menu).
6276 \begin_layout Description
6280 \begin_layout Subsection*
6281 LFUN_BUFFER_PREVIOUS
6284 \begin_layout Description
6285 Action Switch to the previous opened document.
6289 \begin_layout Description
6290 Syntax buffer-previous
6293 \begin_layout Subsection*
6294 LFUN_MASTER_BUFFER_UPDATE
6297 \begin_layout Description
6298 Action When run from a child document, this updates (exports) document built
6299 from the master buffer, if available.
6303 \begin_layout Description
6304 Syntax master-buffer-update [<FORMAT>]
6307 \begin_layout Description
6308 Params <FORMAT>: The format to display, where this is one of the formats
6309 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6310 If no format is given, the default format as specified in the same dialog
6315 \begin_layout Description
6316 Origin Tommaso, 20 Sep 2007
6319 \begin_layout Subsection*
6320 LFUN_MASTER_BUFFER_VIEW
6323 \begin_layout Description
6324 Action When run from a child document, this command shows a preview built
6325 from the master buffer, if available.
6329 \begin_layout Description
6330 Syntax master-buffer-view [<FORMAT>]
6333 \begin_layout Description
6334 Params <FORMAT>: The format to display, where this is one of the formats
6335 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6336 If no format is given, the default format as specified in the same dialog
6341 \begin_layout Description
6342 Origin Tommaso, 20 Sep 2007
6345 \begin_layout Subsection*
6346 LFUN_BUFFER_LANGUAGE
6349 \begin_layout Description
6350 Action Set language of the current document.
6354 \begin_layout Description
6355 Syntax buffer-language <LANG>
6358 \begin_layout Description
6359 Params <LANG>: language name.
6360 See lib/languages for list.
6364 \begin_layout Description
6365 Origin leeming, 30 Mar 2004
6368 \begin_layout Subsection*
6369 LFUN_BUFFER_SAVE_AS_DEFAULT
6372 \begin_layout Description
6373 Action Save the current document settings as default.
6377 \begin_layout Description
6378 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6382 \begin_layout Description
6383 Syntax buffer-save-as-default [<ARGS>]
6386 \begin_layout Description
6387 Params <ARGS>: contains the particular settings to be saved.
6388 They obey the syntax you can find in document header of usual .lyx file.
6392 \begin_layout Description
6393 Origin leeming, 30 Mar 2004
6396 \begin_layout Subsection*
6397 LFUN_BUFFER_PARAMS_APPLY
6400 \begin_layout Description
6401 Action Apply the given settings to the current document.
6405 \begin_layout Description
6406 Syntax buffer-params-apply [<ARGS>]
6409 \begin_layout Description
6410 Params <ARGS>: contains the particular settings to be saved.
6411 They obey the syntax you can find in document header of usual .lyx file.
6415 \begin_layout Description
6416 Origin leeming, 30 Mar 2004
6419 \begin_layout Subsection*
6423 \begin_layout Description
6424 Action Inserts another LyX file.
6428 \begin_layout Description
6429 Syntax file-insert [<FILE>]
6432 \begin_layout Description
6433 Params <FILE>: Filename to be inserted.
6437 \begin_layout Subsection*
6438 LFUN_FILE_INSERT_PLAINTEXT
6441 \begin_layout Description
6442 Action Inserts plain text file.
6446 \begin_layout Description
6447 Syntax file-insert-plaintext [<FILE>]
6450 \begin_layout Description
6451 Params <FILE>: Filename to be inserted.
6455 \begin_layout Description
6456 Origin CFO-G, 19 Nov 1997
6459 \begin_layout Subsection*
6460 LFUN_FILE_INSERT_PLAINTEXT_PARA
6463 \begin_layout Description
6464 Action Inserts plain text file as paragraph (i.e.
6469 \begin_layout Description
6470 Syntax file-insert-plaintext-para [<FILE>]
6473 \begin_layout Description
6474 Params <FILE>: Filename to be inserted.
6478 \begin_layout Description
6479 Origin Levon, 14 Feb 2001
6482 \begin_layout Subsection*
6486 \begin_layout Description
6487 Action Open LyX document.
6491 \begin_layout Description
6492 Syntax file-open [<FILE>]
6495 \begin_layout Description
6496 Params <FILE>: Filename to be opened.
6500 \begin_layout Subsection*
6504 \begin_layout Description
6505 Action Executes a command defined in a .def file.
6509 \begin_layout Description
6510 Notion The definitions are by default read from lib/commands/default.def.
6512 \begin_inset Newline newline
6515 A .def file allows to define a command with
6517 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6518 <LFUN> is the lfun code to be executed (see e.g.
6519 LFUN_COMMAND_SEQUENCE).
6522 def_file "FileName" allows to include another .def file.
6524 \begin_inset Newline newline
6527 This is particularly useful in connection with toolbar buttons: Since the
6528 name of the button image for this lfun is lib/images/commands/<NAME>.png
6529 this is the way to assign an image to a complex command-sequence.
6533 \begin_layout Description
6537 \begin_layout Description
6538 Params <NAME>: Name of the command that must be called.
6542 \begin_layout Description
6543 Origin broider, 2 Oct 2007
6546 \begin_layout Subsection*
6550 \begin_layout Description
6551 Action Simulate halting Meta key (Alt key on PCs).
6555 \begin_layout Description
6556 Notion Used for buffer editation not for GUI control.
6560 \begin_layout Description
6564 \begin_layout Subsection*
6568 \begin_layout Description
6569 Action Cancels sequence prepared by LFUN_META_PREFIX .
6573 \begin_layout Description
6577 \begin_layout Subsection*
6578 LFUN_COMMAND_EXECUTE
6581 \begin_layout Description
6582 Action Opens the minibuffer toolbar so that the user can type in there.
6586 \begin_layout Description
6587 Notion Usually bound to M-x shortcut.
6591 \begin_layout Description
6592 Syntax command-execute
6595 \begin_layout Subsection*
6599 \begin_layout Description
6600 Action Return the current key sequence and available options as a string.
6604 \begin_layout Description
6605 Notion No options are added if no current map exists.
6607 \begin_inset Newline newline
6610 This is probably usable only with connection to lyxserver.
6614 \begin_layout Description
6615 Syntax command-prefix
6618 \begin_layout Subsection*
6619 LFUN_COMMAND_SEQUENCE
6622 \begin_layout Description
6623 Action Run more commands (LFUN and its parameters) in a sequence.
6627 \begin_layout Description
6628 Syntax command-sequence <CMDS>
6631 \begin_layout Description
6632 Params <CMDS>: Sequence of commands separated by semicolons.
6636 \begin_layout Description
6637 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6641 \begin_layout Description
6642 Origin Andre, 11 Nov 1999
6645 \begin_layout Subsection*
6646 LFUN_COMMAND_ALTERNATIVES
6649 \begin_layout Description
6650 Action Runs the first listed command that is enabled.
6654 \begin_layout Description
6655 Notion This can be used to bind multiple functions to a single key, and
6656 then which one is used will depend upon the context.
6660 \begin_layout Description
6661 Syntax command-alternatives <CMDS>
6664 \begin_layout Description
6665 Params <CMDS>: Sequence of commands separated by semicolons.
6669 \begin_layout Description
6670 Sample command-alternatives completion-accept;cell-forward
6673 \begin_layout Description
6674 Origin rgh, 24 September 2008
6677 \begin_layout Subsection*
6681 \begin_layout Description
6682 Action Shows message in statusbar (for script purposes).
6686 \begin_layout Description
6687 Syntax message <STRING>
6690 \begin_layout Description
6691 Origin Lgb, 8 Apr 2001
6694 \begin_layout Subsection*
6695 LFUN_PREFERENCES_SAVE
6698 \begin_layout Description
6699 Action Save user preferences.
6703 \begin_layout Description
6704 Syntax preferences-save
6707 \begin_layout Description
6708 Origin Lgb, 27 Nov 1999
6711 \begin_layout Subsection*
6715 \begin_layout Description
6716 Action Reconfigure the automatic settings.
6720 \begin_layout Description
6724 \begin_layout Description
6725 Origin Asger, 14 Feb 1997
6728 \begin_layout Subsection*
6732 \begin_layout Description
6733 Action Apply the given settings to user preferences.
6737 \begin_layout Description
6738 Syntax lyxrc-apply <SETTINGS>
6741 \begin_layout Description
6742 Params <SETTINGS>: settings which are to be set.
6743 Take a look into ~/.lyx/preferences to get an idea which commands to use
6745 lyx::LyXRC::LyXRCTags has the list of possible commands.
6749 \begin_layout Subsection*
6750 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6753 \begin_layout Description
6754 Action Determine whether keep cursor inside the editing window regardless
6755 the scrollbar movement.
6759 \begin_layout Description
6760 Syntax toggle-cursor-follows-scrollbar
6763 \begin_layout Description
6764 Origin ARRae, 2 Dec 1997
6767 \begin_layout Subsection*
6771 \begin_layout Description
6772 Action Set the given LyX color to the color defined by the X11 name given.
6776 \begin_layout Description
6777 Notion A new color entry is created if the color is unknown.
6778 Color names can be stored as a part of user settings.
6782 \begin_layout Description
6783 Syntax set-color <LYX_NAME> <X11_NAME>
6786 \begin_layout Description
6787 Origin SLior, 11 Jun 2000
6790 \begin_layout Subsection*
6794 \begin_layout Description
6795 Action Count the statistics (number of words and characters) in the document
6796 or in the given selection.
6800 \begin_layout Description
6801 Notion Note that this function gives the number of words/chars written,
6802 not the number of characters which will be typeset.
6806 \begin_layout Description
6810 \begin_layout Description
6811 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6814 \begin_layout Subsection*
6815 LFUN_COMPLETION_INLINE
6818 \begin_layout Description
6819 Action Show the inline completion at the cursor position.
6823 \begin_layout Description
6824 Syntax completion-inline
6827 \begin_layout Description
6828 Origin sts, Feb 19 2008
6831 \begin_layout Subsection*
6832 LFUN_COMPLETION_POPUP
6835 \begin_layout Description
6836 Action Show the completion popup at the cursor position.
6840 \begin_layout Description
6841 Syntax completion-popup
6844 \begin_layout Description
6845 Origin sts, Feb 19 2008
6848 \begin_layout Subsection*
6849 LFUN_COMPLETION_COMPLETE
6852 \begin_layout Description
6853 Action Try to complete the word or command at the cursor position.
6857 \begin_layout Description
6861 \begin_layout Description
6862 Origin sts, Feb 19 2008
6865 \begin_layout Subsection*
6866 LFUN_COMPLETION_CANCEL
6869 \begin_layout Description
6870 Action Try to cancel completion, either the popup or the inline completion
6874 \begin_layout Description
6875 Syntax completion-cancel
6878 \begin_layout Description
6879 Origin sts, Sep 07 2008
6882 \begin_layout Subsection*
6883 LFUN_COMPLETION_ACCEPT
6886 \begin_layout Description
6887 Action Accept suggested completion.
6891 \begin_layout Description
6892 Syntax completion-accept
6895 \begin_layout Description
6896 Origin sanda, Sep 08 2008
6899 \begin_layout Subsection*
6900 LFUN_BRANCH_ACTIVATE
6903 \begin_layout Description
6904 Action Activate the branch
6907 \begin_layout Description
6908 Syntax branch-activate <BRANCH>
6911 \begin_layout Description
6912 Params <BRANCH>: The branch to activate
6915 \begin_layout Description
6916 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6917 \begin_inset Newline newline
6920 could be used to export a pdf with the answers branch includedwithout one's
6921 having to open LyX and activate the branch manually.
6924 \begin_layout Description
6925 Origin rgh, 27 May 2008
6928 \begin_layout Subsection*
6929 LFUN_BRANCH_DEACTIVATE
6932 \begin_layout Description
6933 Action De-activate the branch
6936 \begin_layout Description
6937 Syntax branch-deactivate <BRANCH>
6940 \begin_layout Description
6941 Params <BRANCH>: The branch to deactivate
6944 \begin_layout Description
6945 Origin rgh, 27 May 2008
6948 \begin_layout Subsection*
6949 LFUN_COPY_LABEL_AS_REF
6952 \begin_layout Description
6953 Action Copies the label at the cursor as a cross-reference to be pasted
6958 \begin_layout Description
6959 Syntax copy-label-as-reference
6962 \begin_layout Description
6963 Origin sts, 16 Nov 2008
6966 \begin_layout Subsection*
6967 LFUN_INSERT_LABEL_AS_REF
6970 \begin_layout Description
6971 Action Inserts the label as a cross-reference at the position of the cursor.
6975 \begin_layout Description
6976 Syntax insert-label-as-reference
6979 \begin_layout Description
6980 Origin vfr, 7 Apr 2009
6983 \begin_layout Subsection*
6987 \begin_layout Description
6988 Action Increases the zoom of the screen fonts.
6992 \begin_layout Description
6993 Syntax buffer-zoom-in [<ZOOM>]
6996 \begin_layout Description
6997 Params <ZOOM>: The zoom in %, the default is 20.
7001 \begin_layout Description
7002 Origin vfr, 30 Mar 2009
7005 \begin_layout Subsection*
7006 LFUN_BUFFER_ZOOM_OUT
7009 \begin_layout Description
7010 Action Decreases the zoom of the screen fonts.
7014 \begin_layout Description
7015 Syntax buffer-zoom-out [<ZOOM>]
7018 \begin_layout Description
7019 Params <ZOOM>: The zoom in %, the default is 20.
7023 \begin_layout Description
7024 Origin vfr, 30 Mar 2009
7027 \begin_layout Subsection*
7031 \begin_layout Description
7032 Action Selects the whole section.
7036 \begin_layout Description
7037 Notion The cursor should be in a section heading before calling this lfun.
7041 \begin_layout Description
7042 Syntax section-select
7045 \begin_layout Description
7046 Origin vfr, 05 May 2009