1 #LyX 1.6.2 created this file. For more info see http://www.lyx.org/
6 \use_default_options false
14 \font_typewriter default
15 \font_default_family default
22 \paperfontsize default
30 \paperorientation portrait
37 \paragraph_separation indent
39 \quotes_language english
42 \paperpagestyle default
43 \tracking_changes false
51 \begin_layout Section*
52 LFUNs documentation automatically generated 26.04.2009.
55 \begin_layout Standard
59 \begin_layout Plain Layout
69 \begin_inset VSpace 1cm
75 \begin_layout Subsection*
79 \begin_layout Description
80 Action Adds an acute accent to the next character typed.
84 \begin_layout Description
88 \begin_layout Subsection*
92 \begin_layout Description
93 Action Adds a breve accent to the next character typed.
97 \begin_layout Description
101 \begin_layout Subsection*
105 \begin_layout Description
106 Action Adds a caron to the next character typed.
110 \begin_layout Description
114 \begin_layout Subsection*
118 \begin_layout Description
119 Action Adds a cedilla to the next character typed.
123 \begin_layout Description
124 Syntax accent-cedilla
127 \begin_layout Subsection*
131 \begin_layout Description
132 Action Adds a circle accent to the next character typed.
136 \begin_layout Description
140 \begin_layout Subsection*
141 LFUN_ACCENT_CIRCUMFLEX
144 \begin_layout Description
145 Action Adds a circumflex to the next character typed.
149 \begin_layout Description
150 Syntax accent-circumflex
153 \begin_layout Subsection*
157 \begin_layout Description
158 Action Adds a dot accent to the next character typed.
162 \begin_layout Description
166 \begin_layout Subsection*
170 \begin_layout Description
171 Action Adds a grave accent to the next character typed.
175 \begin_layout Description
179 \begin_layout Subsection*
180 LFUN_ACCENT_HUNGARIAN_UMLAUT
183 \begin_layout Description
184 Action Adds a Hungarian umlaut to the next character typed.
188 \begin_layout Description
192 \begin_layout Subsection*
196 \begin_layout Description
197 Action Adds a macron to the next character typed.
201 \begin_layout Description
205 \begin_layout Subsection*
209 \begin_layout Description
210 Action Adds an ogonek accent to the next character typed.
214 \begin_layout Description
218 \begin_layout Subsection*
222 \begin_layout Description
223 Action Adds a tie over the next two character typed.
227 \begin_layout Description
228 Notion The following char will finish the tie.
232 \begin_layout Description
236 \begin_layout Subsection*
240 \begin_layout Description
241 Action Adds a tilde over the next character typed.
245 \begin_layout Description
249 \begin_layout Subsection*
253 \begin_layout Description
254 Action Adds an umlaut over the next character typed.
258 \begin_layout Description
262 \begin_layout Subsection*
266 \begin_layout Description
267 Action Adds a bar under the next character typed.
271 \begin_layout Description
272 Syntax accent-underbar
275 \begin_layout Subsection*
279 \begin_layout Description
280 Action Adds a dot under the next character typed.
284 \begin_layout Description
285 Syntax accent-underdot
288 \begin_layout Subsection*
292 \begin_layout Description
293 Action Inserts a caption inset.
297 \begin_layout Description
298 Syntax caption-insert
301 \begin_layout Description
302 Origin Lgb, 18 Jul 2000
305 \begin_layout Subsection*
309 \begin_layout Description
310 Action Inserts the current date.
314 \begin_layout Description
315 Syntax date-insert [<ARG>]
318 \begin_layout Description
319 Params <ARG>: Format of date.
320 The default value (%x) can be set in Preferences->Date format.
321 For possible formats see manual page of strftime function.
325 \begin_layout Description
326 Origin jdblair, 31 Jan 2000
329 \begin_layout Subsection*
333 \begin_layout Description
334 Action Inserts a footnote inset.
338 \begin_layout Description
339 Syntax footnote-insert
342 \begin_layout Description
343 Origin Jug, 7 Mar 2000
346 \begin_layout Subsection*
350 \begin_layout Description
351 Action Inserts an ERT inset.
355 \begin_layout Description
359 \begin_layout Description
360 Origin Jug, 18 Feb 2000
363 \begin_layout Subsection*
367 \begin_layout Description
368 Action Inserts a float inset.
372 \begin_layout Description
373 Syntax float-insert <TYPE>
376 \begin_layout Description
377 Params <TYPE>: type of float depends on the used textclass.
378 Usually "algorithm", "table", "figure" parameters can be given.
382 \begin_layout Description
383 Origin Lgb, 27 Jun 2000
386 \begin_layout Subsection*
387 LFUN_FLOAT_WIDE_INSERT
390 \begin_layout Description
391 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
395 \begin_layout Description
396 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
400 \begin_layout Description
401 Syntax float-wide-insert <TYPE>
404 \begin_layout Description
405 Params <TYPE>: type of float depends on the used textclass.
406 Usually "algorithm", "table", "figure" parameters can be given.
410 \begin_layout Description
411 Origin Lgb, 31 Oct 2001
414 \begin_layout Subsection*
415 LFUN_FLOAT_LIST_INSERT
418 \begin_layout Description
419 Action Inserts the list of floats in the document.
423 \begin_layout Description
424 Syntax float-list-insert <TYPE>
427 \begin_layout Description
428 Params <TYPE>: type of float depends on the used textclass.
429 Usually "algorithm", "table", "figure" parameters can be given.
433 \begin_layout Description
434 Origin Lgb, 3 May 2001
437 \begin_layout Subsection*
441 \begin_layout Description
442 Action Inserts floats wrapped by the text around.
446 \begin_layout Description
447 Syntax wrap-insert <TYPE>
450 \begin_layout Description
451 Params <TYPE>: table|figure
454 \begin_layout Description
455 Origin Dekel, 7 Apr 2002
458 \begin_layout Subsection*
462 \begin_layout Description
463 Action Inserts an optional-argument (short title) inset.
467 \begin_layout Description
468 Syntax optional-insert
471 \begin_layout Description
472 Origin vermeer, 12 Aug 2002
475 \begin_layout Subsection*
479 \begin_layout Description
480 Action Inserts a horizontal line.
484 \begin_layout Description
488 \begin_layout Description
489 Origin Andre, Oct 27 2003
492 \begin_layout Subsection*
496 \begin_layout Description
497 Action Inserts a new page.
501 \begin_layout Description
502 Syntax newpage-insert <ARG>
505 \begin_layout Description
506 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
510 \begin_layout Description
511 Origin uwestoehr, 24 Nov 2007
514 \begin_layout Subsection*
515 LFUN_MARGINALNOTE_INSERT
518 \begin_layout Description
519 Action Inserts a marginal note.
523 \begin_layout Description
524 Syntax marginalnote-insert
527 \begin_layout Description
528 Origin Lgb, 26 Jun 2000
531 \begin_layout Subsection*
535 \begin_layout Description
536 Action Inserts a single unicode character.
540 \begin_layout Description
541 Syntax unicode-insert <CHAR>
544 \begin_layout Description
545 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
549 \begin_layout Description
550 Sample unicode-insert 0x0100
553 \begin_layout Description
554 Origin Lgb, 22 Oct 2006
557 \begin_layout Subsection*
561 \begin_layout Description
562 Action Inserts a new listings inset.
566 \begin_layout Description
567 Syntax listing-insert
570 \begin_layout Description
571 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
574 \begin_layout Subsection*
578 \begin_layout Description
579 Action Insert a tab into a listings inset.
583 \begin_layout Description
584 Notion It also works on a selection.
588 \begin_layout Description
592 \begin_layout Description
593 Origin vfvanravesteijn, Sep 30 2008
596 \begin_layout Subsection*
600 \begin_layout Description
601 Action Delete a tab or up to an equivalent amount of spaces from a listings
606 \begin_layout Description
607 Notion It also works on a selection - it removes a tab or spaces from the
608 beginning of each line spanned by the selection.
609 This is useful if you want to indent/unindent multiple lines in one action.
613 \begin_layout Description
617 \begin_layout Description
618 Origin vfvanravesteijn, Sep 30 2008
621 \begin_layout Subsection*
625 \begin_layout Description
626 Action Inserts quotes according to the type and quote-language preference.
630 \begin_layout Description
631 Action Currently English, Swedish, German, Polish, French, Danish quotes
636 \begin_layout Description
637 Syntax quote-insert [<TYPE>]
640 \begin_layout Description
641 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
646 \begin_layout Subsection*
650 \begin_layout Description
651 Action Displays shortcuts, lyxrc, package and textclass availability and
652 menu information in a non-editable boxed InsetText.
656 \begin_layout Description
657 Notion Apart from lfun arguments you can use the following method:
658 \begin_inset Newline newline
662 input the type and argument of this inset, e.g.
663 "menu paste", in the work area.
665 \begin_inset Newline newline
669 select the text and run info-insert lfun.
673 \begin_layout Description
674 Syntax info-insert <TYPE> <ARG>
677 \begin_layout Description
678 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
679 \begin_inset Newline newline
682 <ARG>: argument for a given type.
683 Look into InsetInfo.h for detailed description.
687 \begin_layout Description
688 Sample command-sequence info-insert buffer path; info-insert buffer name
692 \begin_layout Description
693 Origin bpeng, 7 Oct 2007
696 \begin_layout Subsection*
700 \begin_layout Description
701 Action Inserts branch inset.
705 \begin_layout Description
706 Syntax branch-insert <BRANCH-NAME>
709 \begin_layout Description
710 Origin vermeer, 17 Aug 2003
713 \begin_layout Subsection*
717 \begin_layout Description
718 Action Inserts Box inset.
722 \begin_layout Description
723 Syntax box-insert [<TYPE>]
726 \begin_layout Description
727 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
729 \begin_inset Newline newline
732 Framed is the default one.
736 \begin_layout Description
737 Origin vermeer, 7 Oct 2003
740 \begin_layout Subsection*
744 \begin_layout Description
745 Action Inserts CharStyle, Custom inset or XML short element.
749 \begin_layout Description
750 Notion Look into the Customization manual for more information about these
753 \begin_inset Newline newline
756 To make this command enabled the layout file for the document class you're
757 using has to load the character styles.
758 There are a few contained in the Logical Markup module.
759 You can also of course create some yourself.
761 \begin_inset Newline newline
764 For dissolving the element see LFUN_INSET_DISSOLVE.
768 \begin_layout Description
769 Syntax flex-insert <TYPE:Name>
772 \begin_layout Description
773 Params TYPE: CharStyle|Custom|Element|Standard
774 \begin_inset Newline newline
777 Identifies whether this is a Character Style, a Custom Inset or an XML
778 Element, and which dynamical sub-menu this flex inset is in on the LyX
780 If Standard (currently unused): none of these.
781 Name: This name must be defined either in your layout file or imported
784 \begin_inset Newline newline
787 InsetLayout <TYPE:Name>
790 \begin_layout Description
791 Sample flex-insert CharStyle:Code
794 \begin_layout Subsection*
798 \begin_layout Description
799 Action Inserts the given string (accordingly to the correct keymap).
803 \begin_layout Description
804 Notion Automatically replace the currently selected text.
805 Depends on lyxrc settings "auto_region_delete".
809 \begin_layout Description
810 Syntax self-insert <STRING>
813 \begin_layout Subsection*
817 \begin_layout Description
818 Action Inserts one of horizontal space insets.
822 \begin_layout Description
823 Syntax space-insert <NAME> [<LEN>]
826 \begin_layout Description
827 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
828 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
829 \begin_inset Newline newline
832 <LEN>: length for custom spaces (hspace, hspace* for protected)
835 \begin_layout Description
836 Origin JSpitzm, 20 May 2003, Mar 17 2008
839 \begin_layout Subsection*
840 LFUN_HYPERLINK_INSERT
843 \begin_layout Description
844 Action Inserts hyperlinks into the document (clickable in pdf output).
848 \begin_layout Description
849 Notion Hyperlink target can be set via selection + hyperlink-insert function.
853 \begin_layout Description
854 Syntax href-insert [<TARGET>]
857 \begin_layout Description
858 Origin CFO-G, 21 Nov 1997
861 \begin_layout Subsection*
862 LFUN_SPECIALCHAR_INSERT
865 \begin_layout Description
866 Action Inserts various characters into the document.
870 \begin_layout Description
871 Syntax specialchar-insert <CHAR>
874 \begin_layout Description
875 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
876 tence, menu-separator.
880 \begin_layout Description
881 Origin JSpitzm, 6 Dec 2007
884 \begin_layout Subsection*
888 \begin_layout Description
889 Action Inserts table of contents.
893 \begin_layout Description
897 \begin_layout Description
898 Origin Lgb, 27 May 97
901 \begin_layout Subsection*
905 \begin_layout Description
906 Action Start (or remove) Appendix on the given cursor position.
910 \begin_layout Description
914 \begin_layout Description
915 Origin ettrich, 5 May 1998
918 \begin_layout Subsection*
922 \begin_layout Description
923 Action Inserts Index entry.
927 \begin_layout Description
928 Notion It automatically takes the word on the cursor position.
932 \begin_layout Description
933 Syntax index-insert [<TYPE:Name>]
936 \begin_layout Description
937 Params <TYPE:Name>: name of the index, if multiple indices are defined.
938 with an empty argument, the default index is selected.
942 \begin_layout Description
943 Origin leeming, 3 Aug 2000
946 \begin_layout Subsection*
950 \begin_layout Description
951 Action Inserts list of Index entries on a new page.
955 \begin_layout Description
956 Syntax index-print [<TYPE:Name>]
959 \begin_layout Description
960 Params <TYPE:Name>: name of the index, if multiple indices are defined.
961 with an empty argument, the default index is selected.
965 \begin_layout Description
966 Origin Lgb, 27 Feb 1997
969 \begin_layout Subsection*
973 \begin_layout Description
974 Action Inserts Nomenclature entry.
978 \begin_layout Description
979 Notion It automatically takes the word on the cursor position if no symbol
984 \begin_layout Description
985 Syntax nomencl-insert [<SYMBOL>]
988 \begin_layout Description
989 Origin Ugras, 4 Nov 2006
992 \begin_layout Subsection*
993 LFUN_NOMENCLATURE_PRINT
996 \begin_layout Description
997 Action Inserts list of Nomenclature entries.
1001 \begin_layout Description
1002 Syntax nomenclature-print
1005 \begin_layout Description
1006 Origin Ugras, 4 Nov 2006
1009 \begin_layout Subsection*
1013 \begin_layout Description
1014 Action Inserts Note on the current cursor postion, move selection inside
1019 \begin_layout Description
1020 Syntax note-insert [<TYPE>]
1023 \begin_layout Description
1024 Params <TYPE>: <Note|Greyedout|Comment> default: Note
1027 \begin_layout Subsection*
1031 \begin_layout Description
1032 Action Moves the cursor to the begining of next Note inset.
1036 \begin_layout Description
1040 \begin_layout Subsection*
1044 \begin_layout Description
1045 Action Changes all Note insets of a particular type (source) to a different
1046 type (target) fot the current document.
1050 \begin_layout Description
1051 Syntax notes-mutate <SOURCE> <TARGET>
1054 \begin_layout Description
1055 Params <SOURCE/TARGET>: Note|Comment|Greyedout
1058 \begin_layout Description
1059 Origin sanda, 18 Jun 2008
1062 \begin_layout Subsection*
1066 \begin_layout Description
1067 Action Inserts phantom on the current cursor postion, move selection inside
1072 \begin_layout Description
1073 Syntax phantom-insert [<TYPE>]
1076 \begin_layout Description
1077 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
1080 \begin_layout Description
1081 Origin uwestoehr, 30 Jan 2009
1084 \begin_layout Subsection*
1088 \begin_layout Description
1089 Action Inserts a line break or new line.
1093 \begin_layout Description
1094 Syntax newline-insert [<ARG>]
1097 \begin_layout Description
1098 Params <ARG>: <newline|linebreak> default: newline
1101 \begin_layout Description
1102 Origin JSpitzm, 25 Mar 2008
1105 \begin_layout Subsection*
1109 \begin_layout Description
1110 Action Clears the selection.
1111 If no text is selected call LFUN_FINISHED_FORWARD.
1115 \begin_layout Description
1119 \begin_layout Description
1120 Origin Lgb, 17 May 2001
1123 \begin_layout Subsection*
1127 \begin_layout Description
1128 Action Moves the cursor one line in downward direction.
1132 \begin_layout Description
1136 \begin_layout Subsection*
1140 \begin_layout Description
1141 Action Moves the cursor one line in upward direction.
1145 \begin_layout Description
1149 \begin_layout Subsection*
1153 \begin_layout Description
1154 Action Moves the cursor one line in downward direction adding the current
1155 position to the selection.
1159 \begin_layout Description
1163 \begin_layout Subsection*
1167 \begin_layout Description
1168 Action Moves the cursor one line in upward direction adding the current
1169 position to the selection.
1173 \begin_layout Description
1177 \begin_layout Subsection*
1181 \begin_layout Description
1182 Action Moves the cursor one page in downward direction.
1186 \begin_layout Description
1190 \begin_layout Subsection*
1194 \begin_layout Description
1195 Action Moves the cursor one page in upward direction.
1199 \begin_layout Description
1203 \begin_layout Subsection*
1204 LFUN_SCREEN_DOWN_SELECT
1207 \begin_layout Description
1208 Action Moves the cursor one screen in downward direction adding the current
1209 position to the selection.
1213 \begin_layout Description
1214 Syntax screen-down-select
1217 \begin_layout Subsection*
1218 LFUN_SCREEN_UP_SELECT
1221 \begin_layout Description
1222 Action Moves the cursor one page in upward direction adding the current
1223 position to the selection.
1227 \begin_layout Description
1228 Syntax screen-up-select
1231 \begin_layout Subsection*
1235 \begin_layout Description
1236 Action Scroll the buffer view.
1240 \begin_layout Description
1241 Notion Only scrolls the screen up or down; does not move the cursor.
1245 \begin_layout Description
1246 Syntax scroll <TYPE> <QUANTITY>
1249 \begin_layout Description
1250 Params <TYPE>: line|page
1251 \begin_inset Newline newline
1254 <QUANTITY>: up|down|<number>
1257 \begin_layout Description
1258 Origin Abdel, Dec 27 2007
1261 \begin_layout Subsection*
1262 LFUN_SCREEN_RECENTER
1265 \begin_layout Description
1266 Action Recenters the screen on the current cursor position.
1270 \begin_layout Description
1271 Syntax screen-recenter
1274 \begin_layout Subsection*
1275 LFUN_SCREEN_SHOW_CURSOR
1278 \begin_layout Description
1279 Action Repositions the screen such that the cursor is visible.
1283 \begin_layout Description
1284 Syntax screen-show-cursor
1287 \begin_layout Description
1288 Origin vfr, 25 Mar 2009
1291 \begin_layout Subsection*
1295 \begin_layout Description
1296 Action Moves the cursor one position logically backwards.
1300 \begin_layout Description
1301 Notion This is not the action which should be bound to the arrow keys, because
1302 backwards may be left or right, depending on the language.
1303 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1304 which in turn may employ this one.
1308 \begin_layout Description
1309 Syntax char-backward
1312 \begin_layout Subsection*
1313 LFUN_CHAR_BACKWARD_SELECT
1316 \begin_layout Description
1317 Action Moves the cursor one position logically backwards, adding traversed
1318 position to the selection.
1322 \begin_layout Description
1323 Notion See also LFUN_CHAR_BACKWARD.
1327 \begin_layout Description
1328 Syntax char-backward-select
1331 \begin_layout Subsection*
1332 LFUN_CHAR_DELETE_BACKWARD
1335 \begin_layout Description
1336 Action Deletes one character in the backward direction (usually the "BackSpace"
1341 \begin_layout Description
1342 Syntax char-delete-backward
1345 \begin_layout Subsection*
1346 LFUN_CHAR_DELETE_FORWARD
1349 \begin_layout Description
1350 Action Deletes one character in the backward direction (usually the "Delete"
1355 \begin_layout Description
1356 Syntax char-delete-forward
1359 \begin_layout Subsection*
1363 \begin_layout Description
1364 Action Moves the cursor one position logically forward.
1368 \begin_layout Description
1369 Notion This is not the action which should be bound to the arrow keys, because
1370 forward may be left or right, depending on the language.
1371 The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1372 which in turn may employ this one.
1376 \begin_layout Description
1380 \begin_layout Subsection*
1381 LFUN_CHAR_FORWARD_SELECT
1384 \begin_layout Description
1385 Action Moves the cursor one position logically forward, adding traversed
1386 position to the selection.
1390 \begin_layout Description
1391 Notion See also LFUN_CHAR_FORWARD.
1395 \begin_layout Description
1396 Syntax char-forward-select
1399 \begin_layout Subsection*
1403 \begin_layout Description
1404 Action Moves the cursor one position "to the left".
1408 \begin_layout Description
1409 Notion This is the action which should be taken when the "left" key is pressed.
1410 Generally, it moves the cursor one position to the left.
1411 However, in Bidi text this become slightly more complicated, and there
1412 are different modes of cursor movement.
1413 In "visual mode", this moves left, plain and simple.
1414 In "logical mode", movement is logically forward in RTL paragraphs, and
1415 logically backwards in LTR paragraphs.
1419 \begin_layout Description
1423 \begin_layout Subsection*
1424 LFUN_CHAR_LEFT_SELECT
1427 \begin_layout Description
1428 Action Moves the cursor one position "to the left", adding traversed position
1433 \begin_layout Description
1434 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1438 \begin_layout Description
1439 Syntax char-left-select
1442 \begin_layout Subsection*
1446 \begin_layout Description
1447 Action Moves the cursor one position "to the right".
1451 \begin_layout Description
1452 Notion This is the action which should be taken when the "right" key is
1454 Generally, it moves the cursor one position to the right.
1455 However, in Bidi text this become slightly more complicated, and there
1456 are different modes of cursor movement.
1457 In "visual mode", this moves right, plain and simple.
1458 In "logical mode", movement is logically forward in LTR paragraphs, and
1459 logically backwards in RTL paragraphs.
1463 \begin_layout Description
1467 \begin_layout Subsection*
1468 LFUN_CHAR_RIGHT_SELECT
1471 \begin_layout Description
1472 Action Moves the cursor one position "to the right", adding traversed position
1477 \begin_layout Description
1478 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1482 \begin_layout Description
1483 Syntax char-right-select
1486 \begin_layout Subsection*
1490 \begin_layout Description
1491 Action Moves the cursor to the logically previous beginning of a word.
1495 \begin_layout Description
1496 Notion This is not the action which should be bound to the arrow keys, because
1497 backwards may be left or right, depending on the language.
1498 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1499 which in turn may employ this one.
1503 \begin_layout Description
1504 Syntax word-backward
1507 \begin_layout Subsection*
1508 LFUN_WORD_BACKWARD_SELECT
1511 \begin_layout Description
1512 Action Moves the cursor to the logically previous beginning of a word, adding
1513 the logically traversed text to the selection.
1517 \begin_layout Description
1518 Notion See also LFUN_WORD_BACKWARD.
1522 \begin_layout Description
1523 Syntax word-backward-select
1526 \begin_layout Subsection*
1527 LFUN_WORD_DELETE_BACKWARD
1530 \begin_layout Description
1531 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1536 \begin_layout Description
1537 Syntax word-delete-backward
1540 \begin_layout Subsection*
1541 LFUN_WORD_DELETE_FORWARD
1544 \begin_layout Description
1545 Action Deletes characters to the end of the word (usually the "C+Delete"
1550 \begin_layout Description
1551 Syntax word-delete-forward
1554 \begin_layout Subsection*
1555 LFUN_WORD_FIND_FORWARD
1558 \begin_layout Description
1559 Action Search for a given string in forward direction.
1563 \begin_layout Description
1564 Notion Case sensitive, match words.
1565 If no argument given, last search repeated.
1569 \begin_layout Description
1570 Syntax word-find-forward [<STRING>]
1573 \begin_layout Description
1574 Origin Etienne, 16 Feb 1998
1577 \begin_layout Subsection*
1578 LFUN_WORD_FIND_BACKWARD
1581 \begin_layout Description
1582 Action Search for a given string in backward direction.
1586 \begin_layout Description
1587 Notion Case sensitive, match words.
1588 If no argument given, last search repeated.
1592 \begin_layout Description
1593 Syntax word-find-backward [<STRING>]
1596 \begin_layout Description
1597 Origin Etienne, 20 Feb 1998
1600 \begin_layout Subsection*
1604 \begin_layout Description
1605 Action Search for next occurence of a string.
1609 \begin_layout Description
1610 Syntax word-find [<DATA>]
1613 \begin_layout Description
1614 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1615 If no parameter is given, search with last find-dialog data is used for
1621 \begin_layout Description
1622 Origin Andre, Jan 7 2004
1625 \begin_layout Subsection*
1629 \begin_layout Description
1630 Action Replace a string in the document.
1634 \begin_layout Description
1635 Syntax word-replace [<DATA>]
1638 \begin_layout Description
1639 Params <DATA>: data is of the form "<search>
1640 \begin_inset Newline newline
1644 \begin_inset Newline newline
1647 <casesensitive> <matchword> <all> <forward>"
1650 \begin_layout Description
1651 Origin Andre, Jan 7 2004
1654 \begin_layout Subsection*
1658 \begin_layout Description
1659 Action Search for next occurence of a pattern.
1663 \begin_layout Description
1664 Syntax word-findadv [<DATA>]
1667 \begin_layout Description
1668 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1669 If no parameter is given, search with last find-dialog data is used for
1675 \begin_layout Description
1676 Origin Tommaso, Nov 15 2007
1679 \begin_layout Description
1680 Action Moves the cursor to the logically next beginning of a word.
1684 \begin_layout Description
1685 Notion This is not the action which should be bound to the arrow keys, because
1686 forward may be left or right, depending on the language.
1687 The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1688 which in turn may employ this one.
1692 \begin_layout Description
1696 \begin_layout Subsection*
1697 LFUN_WORD_FORWARD_SELECT
1700 \begin_layout Description
1701 Action Moves the cursor to the logically next beginning of a word, adding
1702 the logically traversed text to the selection.
1706 \begin_layout Description
1707 Notion See also LFUN_WORD_FORWARD.
1711 \begin_layout Description
1712 Syntax word-forward-select
1715 \begin_layout Subsection*
1719 \begin_layout Description
1720 Action Moves the cursor to the next beginning of a word "on the left".
1724 \begin_layout Description
1725 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1727 Generally, it moves the cursor to the next beginning of a word on the left.
1728 However, in Bidi text this become slightly more complicated, and there
1729 are different modes of cursor movement.
1730 In "visual mode", this moves left, plain and simple.
1731 In "logical mode", movement is logically forward in RTL paragraphs, and
1732 logically backwards in LTR paragraphs.
1736 \begin_layout Description
1740 \begin_layout Description
1741 Origin dov, 28 Oct 2007
1744 \begin_layout Subsection*
1745 LFUN_WORD_LEFT_SELECT
1748 \begin_layout Description
1749 Action Moves the cursor to the next beginning of a word "on the left", adding
1750 *logically* traversed text to the selection.
1754 \begin_layout Description
1755 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1759 \begin_layout Description
1760 Syntax word-left-select
1763 \begin_layout Description
1764 Origin dov, 28 Oct 2007
1767 \begin_layout Subsection*
1771 \begin_layout Description
1772 Action Moves the cursor to the next beginning of a word "on the right".
1776 \begin_layout Description
1777 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1779 Generally, it moves the cursor to the next beginning of a word on the right.
1780 However, in Bidi text this become slightly more complicated, and there
1781 are different modes of cursor movement.
1782 In "visual mode", this moves right, plain and simple.
1783 In "logical mode", movement is logically forward in LTR paragraphs, and
1784 logically backwards in RTL paragraphs.
1788 \begin_layout Description
1792 \begin_layout Description
1793 Origin dov, 28 Oct 2007
1796 \begin_layout Subsection*
1797 LFUN_WORD_RIGHT_SELECT
1800 \begin_layout Description
1801 Action Moves the cursor to the next beginning of a word "on the right",
1802 adding *logically* traversed text to the selection.
1806 \begin_layout Description
1807 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1811 \begin_layout Description
1812 Syntax word-right-select
1815 \begin_layout Description
1816 Origin dov, 28 Oct 2007
1819 \begin_layout Subsection*
1823 \begin_layout Description
1824 Action Puts the word where the cursor stands into the selection.
1828 \begin_layout Description
1832 \begin_layout Description
1833 Origin Andre, 11 Sep 2002
1836 \begin_layout Subsection*
1837 LFUN_WORD_CAPITALIZE
1840 \begin_layout Description
1841 Action Capitalizes the words in the selection (i.e.
1842 the first letters) or the letter on the cursor position.
1846 \begin_layout Description
1847 Syntax word-capitalize
1850 \begin_layout Subsection*
1854 \begin_layout Description
1855 Action Change the words in the selection or from the cursor position to
1856 the end of word to the upper case.
1860 \begin_layout Description
1864 \begin_layout Subsection*
1868 \begin_layout Description
1869 Action Change the words in the selection or from the cursor position to
1870 the end of word to the lower case.
1874 \begin_layout Description
1878 \begin_layout Subsection*
1879 LFUN_THESAURUS_ENTRY
1882 \begin_layout Description
1883 Action Look up thesaurus entries with respect to the word under the cursor.
1887 \begin_layout Description
1888 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1891 \begin_layout Description
1892 Params <STRING>: word to look up <LANG>: language (see file languages)
1896 \begin_layout Description
1897 Origin Levon, 20 Jul 2001
1900 \begin_layout Subsection*
1904 \begin_layout Description
1905 Action Move the cursor to the beginning of the document.
1909 \begin_layout Description
1913 \begin_layout Subsection*
1914 LFUN_BUFFER_BEGIN_SELECT
1917 \begin_layout Description
1918 Action Move the cursor to the beginning of the document adding the traversed
1919 text to the selection.
1923 \begin_layout Description
1924 Syntax buffer-begin-select
1927 \begin_layout Subsection*
1931 \begin_layout Description
1932 Action Move the cursor to the end of the document.
1936 \begin_layout Description
1940 \begin_layout Subsection*
1941 LFUN_BUFFER_END_SELECT
1944 \begin_layout Description
1945 Action Move the cursor to the end of the document adding the traversed text
1950 \begin_layout Description
1951 Syntax buffer-end-select
1954 \begin_layout Subsection*
1958 \begin_layout Description
1959 Action Move the cursor to the beginning of the current inset if it is not
1960 already there, or at the beginning of the enclosing inset otherwise
1963 \begin_layout Description
1967 \begin_layout Description
1968 Origin JMarc, 2009/03/16
1971 \begin_layout Subsection*
1972 LFUN_INSET_BEGIN_SELECT
1975 \begin_layout Description
1976 Action Move the cursor to the beginning of the current inset if it is not
1977 already there, or at the beginning of the enclosing inset otherwise (adding
1978 the traversed text to the selection).
1982 \begin_layout Description
1983 Syntax inset-begin-select
1986 \begin_layout Description
1987 Origin JMarc, 2009/03/16
1990 \begin_layout Subsection*
1994 \begin_layout Description
1995 Action Move the cursor to the end of the current inset if it is not already
1996 there, or at the end of the enclosing inset otherwise
1999 \begin_layout Description
2003 \begin_layout Description
2004 Origin JMarc, 2009/03/16
2007 \begin_layout Subsection*
2008 LFUN_INSET_END_SELECT
2011 \begin_layout Description
2012 Action Move the cursor to the end of the current inset if it is not already
2013 there, or at the end of the enclosing inset otherwise (adding the traversed
2014 text to the selection).
2018 \begin_layout Description
2019 Syntax inset-end-select
2022 \begin_layout Description
2023 Origin JMarc, 2009/03/16
2026 \begin_layout Subsection*
2030 \begin_layout Description
2031 Action Move the cursor to the begining of the (screen) line.
2035 \begin_layout Description
2039 \begin_layout Subsection*
2040 LFUN_LINE_BEGIN_SELECT
2043 \begin_layout Description
2044 Action Move the cursor to the beginning of the (screen) line adding the
2045 traversed text to the selection.
2049 \begin_layout Description
2050 Syntax line-begin-select
2053 \begin_layout Subsection*
2057 \begin_layout Description
2058 Action Move the cursor to the end of the (screen) line.
2062 \begin_layout Description
2066 \begin_layout Subsection*
2067 LFUN_LINE_END_SELECT
2070 \begin_layout Description
2071 Action Move the cursor to the end of the (screen) line adding the traversed
2072 text to the selection.
2076 \begin_layout Description
2077 Syntax line-end-select
2080 \begin_layout Subsection*
2084 \begin_layout Description
2085 Action Deletes the letters to the end of the (screen) line or deletes the
2090 \begin_layout Description
2091 Syntax line-delete-forward
2094 \begin_layout Subsection*
2098 \begin_layout Description
2099 Action Copies to the clipboard the last edit.
2103 \begin_layout Description
2107 \begin_layout Subsection*
2111 \begin_layout Description
2112 Action Cuts to the clipboard.
2116 \begin_layout Description
2120 \begin_layout Subsection*
2124 \begin_layout Description
2125 Action Pastes material from the active clipboard.
2129 \begin_layout Description
2130 Syntax paste [<TYPE>]
2133 \begin_layout Description
2134 Params <TYPE>: pdf|png|jpeg|linkback
2137 \begin_layout Subsection*
2138 LFUN_CLIPBOARD_PASTE
2141 \begin_layout Description
2142 Action Pastes text from the active clipboard.
2146 \begin_layout Description
2147 Syntax clipboard-paste [<ARG>]
2150 \begin_layout Description
2151 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2156 \begin_layout Description
2157 Origin baum, 10 Jul 2006
2160 \begin_layout Subsection*
2161 LFUN_PRIMARY_SELECTION_PASTE
2164 \begin_layout Description
2165 Action Pastes the currently text selected text.
2169 \begin_layout Description
2170 Notion Primary selection mechanism is linux-only thing.
2174 \begin_layout Description
2175 Syntax primary-selection-paste [<ARG>]
2178 \begin_layout Description
2179 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2184 \begin_layout Subsection*
2185 LFUN_SELECTION_PASTE
2188 \begin_layout Description
2189 Action Pastes the text in permanent selection.
2193 \begin_layout Description
2194 Syntax selection-paste
2197 \begin_layout Subsection*
2201 \begin_layout Description
2202 Action Undoes the last edit.
2206 \begin_layout Description
2210 \begin_layout Subsection*
2214 \begin_layout Description
2215 Action Redoes the last thing undone.
2219 \begin_layout Description
2223 \begin_layout Subsection*
2227 \begin_layout Description
2228 Action Repeat the given command.
2232 \begin_layout Description
2233 Syntax repeat <COUNT> <LFUN-COMMAND>
2236 \begin_layout Description
2237 Origin Andre, 27 Oct 2003
2240 \begin_layout Subsection*
2241 LFUN_CHARS_TRANSPOSE
2244 \begin_layout Description
2245 Action Transposes the character at the cursor with the one before it.
2249 \begin_layout Description
2250 Syntax chars-transpose
2253 \begin_layout Description
2254 Origin Lgb, 25 Apr 2001
2257 \begin_layout Subsection*
2258 LFUN_DEPTH_DECREMENT
2261 \begin_layout Description
2262 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2267 \begin_layout Description
2268 Syntax depth-decrement
2271 \begin_layout Subsection*
2272 LFUN_DEPTH_INCREMENT
2275 \begin_layout Description
2276 Action Increase the nesting depth of the (selected) paragraph(s) inside
2281 \begin_layout Description
2282 Syntax depth-increment
2285 \begin_layout Subsection*
2289 \begin_layout Description
2290 Action Toggles the bold font (selection-wise) using mathbf in math.
2294 \begin_layout Description
2298 \begin_layout Subsection*
2299 LFUN_FONT_BOLDSYMBOL
2302 \begin_layout Description
2303 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2307 \begin_layout Description
2308 Syntax font-boldsymbol
2311 \begin_layout Subsection*
2312 LFUN_FONT_TYPEWRITER
2315 \begin_layout Description
2316 Action Toggles the typewriter family font (selection-wise).
2320 \begin_layout Description
2321 Syntax font-typewriter
2324 \begin_layout Subsection*
2328 \begin_layout Description
2329 Action Toggles underline in the font (selection-wise).
2333 \begin_layout Description
2334 Syntax font-underline
2337 \begin_layout Subsection*
2341 \begin_layout Description
2342 Action Toggles the emphasis font style (selection-wise).
2346 \begin_layout Description
2350 \begin_layout Subsection*
2354 \begin_layout Description
2355 Action Toggles Noun text style font (selection-wise).
2359 \begin_layout Description
2363 \begin_layout Subsection*
2367 \begin_layout Description
2368 Action Toggles Roman family font (selection-wise).
2372 \begin_layout Description
2376 \begin_layout Subsection*
2380 \begin_layout Description
2381 Action Toggles Sans Serif family font (selection-wise).
2385 \begin_layout Description
2389 \begin_layout Subsection*
2393 \begin_layout Description
2394 Action Toggles Fraktur family font (math-mode, selection-wise).
2398 \begin_layout Description
2402 \begin_layout Description
2403 Origin vermeer, 10 Jan 2002
2406 \begin_layout Subsection*
2410 \begin_layout Description
2411 Action Toggles Italics font shape (math-mode, selection-wise).
2415 \begin_layout Description
2419 \begin_layout Description
2420 Origin vermeer, 10 Jan 2002
2423 \begin_layout Subsection*
2427 \begin_layout Description
2428 Action Reverts the settings of the font to the default values (selection-wise).
2432 \begin_layout Description
2436 \begin_layout Subsection*
2440 \begin_layout Description
2441 Action Sets font size according to lyx format string.
2445 \begin_layout Description
2446 Syntax font-size <SIZE>
2449 \begin_layout Description
2450 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2451 \begin_inset Newline newline
2454 largest|huge|giant|increase|decrease|default
2457 \begin_layout Subsection*
2458 LFUN_TEXTSTYLE_APPLY
2461 \begin_layout Description
2462 Action Toggle user-defined (=last-time used) text style.
2466 \begin_layout Description
2467 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2468 trigerred when using Text Style dialog.
2472 \begin_layout Description
2473 Syntax textstyle-apply
2476 \begin_layout Description
2477 Origin leeming, 12 Mar 2003
2480 \begin_layout Subsection*
2481 LFUN_TEXTSTYLE_UPDATE
2484 \begin_layout Description
2485 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2490 \begin_layout Description
2491 Syntax textstyle-update <FONT_INFO>
2494 \begin_layout Description
2495 Params <FONT_INFO>: specifies font atributes, e.g.
2496 family, series, shape, size, emph, noun, underbar, number, color, language,
2499 \begin_inset Newline newline
2502 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2506 \begin_layout Description
2507 Origin leeming, 12 Mar 2003
2510 \begin_layout Subsection*
2511 LFUN_SCREEN_FONT_UPDATE
2514 \begin_layout Description
2515 Action Update fonts and its metrics.
2519 \begin_layout Description
2520 Notion Automatically called after zoom, dpi, font names, or norm change.
2524 \begin_layout Description
2525 Syntax screen-font-update
2528 \begin_layout Description
2529 Origin ARRae, 13 Aug 2000
2532 \begin_layout Subsection*
2536 \begin_layout Description
2537 Action Returns the info about the current font.
2541 \begin_layout Description
2545 \begin_layout Subsection*
2546 LFUN_CITATION_INSERT
2549 \begin_layout Description
2550 Action Inserts citation from loaded citation database.
2554 \begin_layout Description
2555 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2558 \begin_layout Description
2559 Params <KEY>: Citation (shortcut listed in available citations).
2561 \begin_inset Newline newline
2564 <TEXT_BEFORE>: text which should appear before citation.
2568 \begin_layout Description
2569 Origin AAS, 97-02-23
2572 \begin_layout Subsection*
2573 LFUN_BIBTEX_DATABASE_ADD
2576 \begin_layout Description
2577 Action Adds database, which will be used for bibtex citations.
2581 \begin_layout Description
2582 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2583 bibliography) found from the cursor postion.
2587 \begin_layout Description
2588 Syntax bibtex-database-add <DATABASE-NAME>
2591 \begin_layout Description
2592 Origin Ale, 30 May 1997
2595 \begin_layout Subsection*
2596 LFUN_BIBTEX_DATABASE_DEL
2599 \begin_layout Description
2600 Action Adds database, which will be used for bibtex citations.
2604 \begin_layout Description
2605 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2606 X bibliography) found from the cursor postion.
2610 \begin_layout Description
2611 Syntax bibtex-database-del <DATABASE-NAME>
2614 \begin_layout Description
2615 Origin Ale, 30 May 1997
2618 \begin_layout Subsection*
2622 \begin_layout Description
2623 Action Sets the layout (that is, environment) for the current paragraph.
2627 \begin_layout Description
2628 Syntax layout <LAYOUT>
2631 \begin_layout Description
2632 Params <LAYOUT>: the layout to use
2635 \begin_layout Subsection*
2636 LFUN_LAYOUT_PARAGRAPH
2639 \begin_layout Description
2640 Action Launches the paragraph settings dialog.
2644 \begin_layout Description
2645 Syntax layout-paragraph
2648 \begin_layout Subsection*
2652 \begin_layout Description
2653 Action Launches the tabular settings dialog.
2657 \begin_layout Description
2658 Syntax layout-tabular
2661 \begin_layout Description
2662 Origin Jug, 31 Jul 2000
2665 \begin_layout Subsection*
2666 LFUN_DROP_LAYOUTS_CHOICE
2669 \begin_layout Description
2670 Action Displays list of layout choices.
2674 \begin_layout Description
2675 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2676 allowing for choice of layout.
2680 \begin_layout Description
2681 Syntax drop-layouts-choice
2684 \begin_layout Subsection*
2685 LFUN_LAYOUT_MODULES_CLEAR
2688 \begin_layout Description
2689 Action Clears the module list.
2693 \begin_layout Description
2694 Notion Clears the list of included modules for the current buffer.
2698 \begin_layout Description
2699 Syntax layout-modules-clear
2702 \begin_layout Description
2703 Origin rgh, 25 August 2007
2706 \begin_layout Subsection*
2707 LFUN_LAYOUT_MODULE_ADD
2710 \begin_layout Description
2711 Action Adds a module.
2715 \begin_layout Description
2716 Notion Adds a module to the list of included modules for the current buffer.
2720 \begin_layout Description
2721 Syntax layout-module-add <MODULE>
2724 \begin_layout Description
2725 Params <MODULE>: the module to be added
2728 \begin_layout Description
2729 Origin rgh, 25 August 2007
2732 \begin_layout Subsection*
2736 \begin_layout Description
2737 Action Reloads layout information.
2741 \begin_layout Description
2742 Notion Reloads all layout information for the current buffer from disk,
2743 thus recognizing any changes that have been made to layout files on the
2745 This is intended to be used only by layout developers and should not be
2746 used when one is trying to do actual work.
2750 \begin_layout Description
2751 Syntax layout-reload
2754 \begin_layout Description
2755 Origin rgh, 3 September 2007
2758 \begin_layout Subsection*
2759 LFUN_TEXTCLASS_APPLY
2762 \begin_layout Description
2763 Action Sets the text class for the current buffer.
2767 \begin_layout Description
2768 Syntax textclass-apply <TEXTCLASS>
2771 \begin_layout Description
2772 Params <TEXTCLASS>: the textclass to set.
2773 Note that this must be the filename, minus the ".layout" extension.
2777 \begin_layout Subsection*
2781 \begin_layout Description
2782 Action Loads information for a textclass from disk.
2786 \begin_layout Description
2787 Syntax textclass-load <TEXTCLASS>
2790 \begin_layout Description
2791 Params <TEXTCLASS>: the textclass to load.
2792 Note that this must be the filename, minus the ".layout" extension.
2796 \begin_layout Subsection*
2800 \begin_layout Description
2801 Action Disable selecting of text-region.
2805 \begin_layout Description
2809 \begin_layout Subsection*
2813 \begin_layout Description
2814 Action Enable selecting of text-region.
2818 \begin_layout Description
2819 Notion After enabling you can simply move arrow keys to get selected region.
2823 \begin_layout Description
2827 \begin_layout Subsection*
2831 \begin_layout Description
2832 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2836 \begin_layout Description
2840 \begin_layout Description
2841 Origin Andre, May 5 2006
2844 \begin_layout Subsection*
2848 \begin_layout Description
2849 Action Inserts math delimiters (e.g.
2850 parentheses, brackets) enclosing expression.
2854 \begin_layout Description
2855 Syntax math-delim [<LEFT>] [<RIGHT>]
2858 \begin_layout Description
2859 Params <LEFT/RIGHT>: Delimiters to be used.
2860 Each delimiter can be specified by either a LaTeX name or a valid character.
2861 ( is the default letter.
2865 \begin_layout Description
2866 Sample math-delim { rangle
2869 \begin_layout Description
2870 Origin Alejandro, 18 Jun 1996
2873 \begin_layout Subsection*
2877 \begin_layout Description
2878 Action Inserts math fixed size delimiters (e.g.
2879 parentheses, brackets) enclosing expression.
2883 \begin_layout Description
2884 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2887 \begin_layout Description
2888 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2889 \begin_inset Newline newline
2892 <L/RDELIM>: TeX code for delimiter.
2893 See Delimiter dialog for delimiters to be used.
2897 \begin_layout Description
2898 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2901 \begin_layout Description
2902 Origin Enrico & Georg, 7 May 2006
2905 \begin_layout Subsection*
2909 \begin_layout Description
2910 Action Creates a new displayed equation in text mode.
2911 Toggles inlined/display formula in math mode.
2915 \begin_layout Description
2916 Syntax math-display [<ARG>]
2919 \begin_layout Description
2920 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2921 new equation from the text mode.
2925 \begin_layout Description
2926 Origin Alejandro, 18 Jun 1996
2929 \begin_layout Subsection*
2933 \begin_layout Description
2934 Action Inserts math objects and symbols.
2938 \begin_layout Description
2939 Syntax math-insert <ARG>
2942 \begin_layout Description
2943 Params <ARG>: Symbol or LaTeX code to be inserted.
2947 \begin_layout Subsection*
2951 \begin_layout Description
2952 Action Enters subscript expression in math expression.
2956 \begin_layout Description
2957 Syntax math-subscript
2960 \begin_layout Description
2961 Origin vermeer, 12 Dec 2001
2964 \begin_layout Subsection*
2965 LFUN_MATH_SUPERSCRIPT
2968 \begin_layout Description
2969 Action Enters subscript expression in math expression.
2973 \begin_layout Description
2974 Syntax math-superscript
2977 \begin_layout Description
2978 Origin vermeer, 12 Dec 2001
2981 \begin_layout Subsection*
2985 \begin_layout Description
2986 Action Toggles the position of the limits from above/below to the right
2987 side an vice versa in integral symbol, a limit, a summation, etc.
2991 \begin_layout Description
2992 Notion Put the cursor before the symbol with the limits and then invoke
2997 \begin_layout Description
2998 Syntax math-limits [<STATE>]
3001 \begin_layout Description
3002 Params <STATE>: limits|nolimits
3005 \begin_layout Subsection*
3009 \begin_layout Description
3010 Action Inserts a math macro definition at the cursor position in the text.
3014 \begin_layout Description
3015 Syntax math-macro <NAME> [<NARGS>] [def]
3018 \begin_layout Description
3019 Params <NAME>: The name of the macro, e.g.
3021 <NARGS>: The number of parameters of the macro.
3023 "def": Has no effect anymore, just for compatibility with former LyX versions.
3027 \begin_layout Description
3028 Origin ale, 10 May 1997; sts, 21 Dec 2007
3031 \begin_layout Subsection*
3035 \begin_layout Description
3036 Action Mutates the type of math inset to the newly selected one.
3040 \begin_layout Description
3041 Syntax math-mutate <TYPE>
3044 \begin_layout Description
3045 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
3046 multline|gather|flalign
3049 \begin_layout Description
3050 Origin Andre, 23 May 2001
3053 \begin_layout Subsection*
3057 \begin_layout Description
3058 Action Inserts space into math expression.
3062 \begin_layout Description
3063 Notion Use spacebar after entering this space to change type of space.
3067 \begin_layout Description
3068 Syntax math-space [<TYPE>] [<LEN>]
3071 \begin_layout Description
3072 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
3074 \begin_inset Newline newline
3077 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
3079 \begin_inset Newline newline
3082 custom space: hspace
3083 \begin_inset Newline newline
3086 "," used by default.
3087 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
3089 <LEN>: length for custom spaces (hspace)
3092 \begin_layout Description
3093 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
3096 \begin_layout Subsection*
3100 \begin_layout Description
3101 Action Inserts a matrix.
3105 \begin_layout Description
3106 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3109 \begin_layout Description
3110 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3112 1 char) and the horizontal alignments (l, c or r) (i.e.
3117 \begin_layout Description
3118 Sample math-matrix 3 3 bccc
3121 \begin_layout Subsection*
3125 \begin_layout Description
3126 Action In text mode enters math mode (i.e.
3127 puts math insets on the current cursor position), in math mode enters text
3128 mode inside math expression.
3132 \begin_layout Description
3133 Notion If there is some selected text, it puts the text inside created math
3138 \begin_layout Description
3139 Syntax math-mode [<ARG>]
3142 \begin_layout Description
3143 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3148 \begin_layout Description
3149 Origin Alejandro, 4 Jun 1996
3152 \begin_layout Subsection*
3156 \begin_layout Description
3157 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3159 Used by the advanced search dialog.
3163 \begin_layout Description
3164 Notion If there is any selected text, then it is moved inside the created
3169 \begin_layout Description
3170 Syntax regexp-mode [<ARG>]
3173 \begin_layout Description
3174 Params <ARG>: eventual argument (regular expression).
3178 \begin_layout Description
3179 Origin Tommaso, 4 Oct 2008
3182 \begin_layout Subsection*
3183 LFUN_MATH_NUMBER_LINE_TOGGLE
3186 \begin_layout Description
3187 Action Toggles numbering of the current formula line.
3191 \begin_layout Description
3192 Notion Must be in display formula mode.
3196 \begin_layout Description
3197 Syntax math-number-line-toggle
3200 \begin_layout Description
3201 Origin Alejandro, 18 Jun 1996
3204 \begin_layout Subsection*
3205 LFUN_MATH_NUMBER_TOGGLE
3208 \begin_layout Description
3209 Action Toggles numbering/labeling of the current formula.
3213 \begin_layout Description
3214 Notion Must be in display formula mode.
3218 \begin_layout Description
3219 Syntax math-number-toggle
3222 \begin_layout Description
3223 Origin Alejandro, 4 Jun 1996
3226 \begin_layout Subsection*
3230 \begin_layout Description
3231 Action Calls external program and passes the current expression/equation
3232 as an argument for the calculation in the format appropriate to the given
3237 \begin_layout Description
3238 Notion Selection can be used to determine the input for the external program.
3242 \begin_layout Description
3243 Syntax math-extern <LANG> [<COMMAND>]
3246 \begin_layout Description
3247 Params <LANG>: octave|maxima|maple|mathematica|script
3248 \begin_inset Newline newline
3251 where "script" stands fot the external script (normalized expression will
3255 \begin_layout Description
3256 Origin Andre, 24 Apr 2001
3259 \begin_layout Description
3260 Sample math-extern maple simplify
3263 \begin_layout Subsection*
3267 \begin_layout Description
3268 Action Changes arbitrarily the size used by math fonts inside a context.
3272 \begin_layout Description
3273 Notion Provides an interface to the LaTeX math mode font size commands.
3277 \begin_layout Description
3278 Syntax math-size <STYLE>
3281 \begin_layout Description
3282 Params <STYLE>: displaystyle|
3291 \begin_layout Description
3292 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
3295 \begin_layout Subsection*
3296 LFUN_MATH_FONT_STYLE
3299 \begin_layout Description
3300 Action Changes the text style used in math.
3304 \begin_layout Description
3305 Syntax math-font-style <STYLE>
3308 \begin_layout Description
3309 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
3310 trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
3313 \begin_layout Description
3314 Origin vfr, 9 jan 2009
3317 \begin_layout Subsection*
3318 LFUN_MATH_MACRO_UNFOLD
3321 \begin_layout Description
3322 Action Unfold a Math Macro.
3326 \begin_layout Description
3327 Notion Unfold the Math Macro the cursor is in, i.e.
3332 \begin_layout Description
3333 Syntax math-macro-unfold
3336 \begin_layout Description
3337 Origin sts, 06 January 2008
3340 \begin_layout Subsection*
3341 LFUN_MATH_MACRO_FOLD
3344 \begin_layout Description
3345 Action Fold a Math Macro.
3349 \begin_layout Description
3350 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3351 displayed as foo before.
3355 \begin_layout Description
3356 Syntax math-macro-fold
3359 \begin_layout Description
3360 Origin sts, 06 January 2008
3363 \begin_layout Subsection*
3364 LFUN_MATH_MACRO_ADD_PARAM
3367 \begin_layout Description
3368 Action Add a parameter.
3372 \begin_layout Description
3373 Notion Add a parameter to a Math Macro.
3377 \begin_layout Description
3378 Params <NUM>: The number of the parameter behind which the new one will
3379 be added (1 for the first, i.e.
3380 use 0 for add a parameter at the left), defaults to the last one.
3384 \begin_layout Description
3385 Syntax math-macro-add-param <NUM>
3388 \begin_layout Description
3389 Origin sts, 06 January 2008
3392 \begin_layout Subsection*
3393 LFUN_MATH_MACRO_REMOVE_PARAM
3396 \begin_layout Description
3397 Action Remove the last parameter.
3401 \begin_layout Description
3402 Notion Remove the last parameter of a Math Macro and remove its value in
3403 all instances of the macro in the buffer.
3407 \begin_layout Description
3408 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3409 defaults to the last one.
3413 \begin_layout Description
3414 Syntax math-macro-remove-param <NUM>
3417 \begin_layout Description
3418 Origin sts, 06 January 2008
3421 \begin_layout Subsection*
3422 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3425 \begin_layout Description
3426 Action Append a greedy parameter.
3430 \begin_layout Description
3431 Notion Append a greedy parameter to a Math Macro which eats the following
3432 mathed cell in every instance of the macro in the buffer.
3436 \begin_layout Description
3437 Syntax math-macro-append-greedy-param
3440 \begin_layout Description
3441 Origin sts, 06 January 2008
3444 \begin_layout Subsection*
3445 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3448 \begin_layout Description
3449 Action Remove a greedy parameter.
3453 \begin_layout Description
3454 Notion Remove a greedy parameter of a Math Macro and spit out the values
3455 of it in every instance of the macro in the buffer.
3456 If it is an optional parameter the [valud] format is used.
3460 \begin_layout Description
3461 Syntax math-macro-remove-greedy-param
3464 \begin_layout Description
3465 Origin sts, 06 January 2008
3468 \begin_layout Subsection*
3469 LFUN_MATH_MACRO_MAKE_OPTIONAL
3472 \begin_layout Description
3473 Action Make a parameter optional.
3477 \begin_layout Description
3478 Notion Turn the first non-optional parameter of a Math Macro into an optional
3479 parameter with a default value.
3483 \begin_layout Description
3484 Syntax math-macro-make-optional
3487 \begin_layout Description
3488 Origin sts, 06 January 2008
3491 \begin_layout Subsection*
3492 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3495 \begin_layout Description
3496 Action Make a parameter non-optional.
3500 \begin_layout Description
3501 Notion Turn the last optional parameter of a Math Macro into a non-optional
3503 The default value is remembered to be reused later if the user changes
3508 \begin_layout Description
3509 Syntax math-macro-make-nonoptional
3512 \begin_layout Description
3513 Origin sts, 06 January 2008
3516 \begin_layout Subsection*
3517 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3520 \begin_layout Description
3521 Action Add an optional parameter.
3525 \begin_layout Description
3526 Notion Insert an optional parameter just behind the already existing optional
3531 \begin_layout Description
3532 Syntax math-macro-add-optional-param
3535 \begin_layout Description
3536 Origin sts, 06 January 2008
3539 \begin_layout Subsection*
3540 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3543 \begin_layout Description
3544 Action Remove the last optional parameter.
3548 \begin_layout Description
3549 Notion Remove the last optional parameter of a Math Macro and remove it
3550 in all the instances of the macro in the buffer.
3554 \begin_layout Description
3555 Syntax math-macro-remove-optional-param
3558 \begin_layout Description
3559 Origin sts, 06 January 2008
3562 \begin_layout Subsection*
3563 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3566 \begin_layout Description
3567 Action Add a greedy optional parameter.
3571 \begin_layout Description
3572 Notion Add a greedy optional parameter which eats the value from the following
3573 cells in mathed which are in the [value] format.
3577 \begin_layout Description
3578 Syntax math-macro-add-greedy-optional-param
3581 \begin_layout Description
3582 Origin sts, 06 January 2008
3585 \begin_layout Subsection*
3586 LFUN_IN_MATHMACROTEMPLATE
3589 \begin_layout Description
3590 Action Only active in Math Macro definition.
3594 \begin_layout Description
3595 Notion Dummy function which is only active in a Math Macro definition.
3596 It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3601 \begin_layout Description
3602 Syntax in-mathmacrotemplate
3605 \begin_layout Description
3606 Origin sts, 06 January 2008
3609 \begin_layout Subsection*
3610 LFUN_PARAGRAPH_MOVE_DOWN
3613 \begin_layout Description
3614 Action Moves the current paragraph downwards in the document.
3618 \begin_layout Description
3619 Syntax paragraph-move-down
3622 \begin_layout Description
3623 Origin Edwin, 8 Apr 2006
3626 \begin_layout Subsection*
3627 LFUN_PARAGRAPH_MOVE_UP
3630 \begin_layout Description
3631 Action Moves the current paragraph upwards in the document.
3635 \begin_layout Description
3636 Syntax paragraph-move-up
3639 \begin_layout Description
3640 Origin Edwin, 8 Apr 2006
3643 \begin_layout Subsection*
3647 \begin_layout Description
3648 Action Move the cursor to the next paragraph (or begining of the current
3649 one) in upward direction.
3653 \begin_layout Description
3657 \begin_layout Description
3658 Origin Asger, 1 Oct 1996
3661 \begin_layout Subsection*
3662 LFUN_PARAGRAPH_UP_SELECT
3665 \begin_layout Description
3666 Action Move the cursor and select the text to the next paragraph (or begining
3667 of the current one) in upward direction.
3671 \begin_layout Description
3672 Syntax paragraph-up-select
3675 \begin_layout Description
3676 Origin Asger, 1 Oct 1996
3679 \begin_layout Subsection*
3683 \begin_layout Description
3684 Action Move the cursor to the next paragraph (or begining of the current
3685 one) in downward direction.
3689 \begin_layout Description
3690 Syntax paragraph-down
3693 \begin_layout Description
3694 Origin Asger, 1 Oct 1996
3697 \begin_layout Subsection*
3698 LFUN_PARAGRAPH_DOWN_SELECT
3701 \begin_layout Description
3702 Action Move the cursor and select the text to the next paragraph (or begining
3703 of the current one) in downward direction.
3707 \begin_layout Description
3708 Syntax paragraph-down-select
3711 \begin_layout Description
3712 Origin Asger, 1 Oct 1996
3715 \begin_layout Subsection*
3719 \begin_layout Description
3720 Action Jump to a paragraph given by its id number and optionally the desired
3721 position within the paragraph.
3725 \begin_layout Description
3726 Notion Note that id number of paragraph is not the sequential number of
3727 paragraph seen on the screen.
3728 Moreover the id is unique for all opened buffers (documents).
3732 \begin_layout Description
3733 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3736 \begin_layout Description
3737 Params <PAR_ID_NUMBER>: paragraph id
3738 \begin_inset Newline newline
3741 <POSITION_IN_PAR>: desired position within the paragraph
3744 \begin_layout Description
3745 Origin Dekel, 26 Aug 2000
3748 \begin_layout Subsection*
3749 LFUN_BREAK_PARAGRAPH
3752 \begin_layout Description
3753 Action Breaks the current paragraph at the current location.
3757 \begin_layout Description
3758 Syntax break-paragraph
3761 \begin_layout Subsection*
3762 LFUN_BREAK_PARAGRAPH
3765 \begin_layout Description
3766 Action Breaks the current paragraph at the current location.
3770 \begin_layout Description
3771 Notion Removes the selection.
3775 \begin_layout Description
3776 Syntax break-paragraph [<LAYOUT>]
3779 \begin_layout Description
3780 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3781 default layout) when the cursor is at the end of the line.
3785 \begin_layout Subsection*
3786 LFUN_PARAGRAPH_PARAMS
3789 \begin_layout Description
3790 Action Change paragraph settings.
3794 \begin_layout Description
3795 Notion Modifies the current paragraph, or currently selected paragraphs.
3796 This function only modifies, and does not override, existing settings.
3797 Note that the "leftindent" indent setting is deprecated.
3801 \begin_layout Description
3802 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3805 \begin_layout Description
3815 \begin_inset Newline newline
3820 paragraph_spacing default|single|onehalf|double|other
3821 \begin_inset Newline newline
3826 align block|left|right|center|default
3827 \begin_inset Newline newline
3832 labelwidthstring WIDTH|
3835 \begin_inset Newline newline
3841 \begin_layout Description
3842 Origin rgh, Aug 15 2007
3845 \begin_layout Subsection*
3846 LFUN_PARAGRAPH_PARAMS_APPLY
3849 \begin_layout Description
3850 Action Change paragraph settings.
3854 \begin_layout Description
3855 Notion Overwrite all nonspecified settings to the default ones.
3856 Use paragraph-params lfun if you don't want to overwrite others settings.
3860 \begin_layout Description
3861 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3864 \begin_layout Description
3865 Params For parameters see LFUN_PARAGRAPH_PARAMS
3868 \begin_layout Description
3869 Origin leeming, 30 Mar 2004
3872 \begin_layout Subsection*
3873 LFUN_PARAGRAPH_UPDATE
3876 \begin_layout Description
3877 Action Updates the values inside the paragraph dialog from the paragraph.
3881 \begin_layout Description
3882 Notion This is internal LFUN, not to be used by users.
3883 Called internally by LFUN_DIALOG_UPDATE.
3887 \begin_layout Description
3888 Origin leeming, 13 Mar 2003
3891 \begin_layout Subsection*
3895 \begin_layout Description
3896 Action Move the current group in the upward direction in the structure of
3901 \begin_layout Description
3902 Notion The "group" can be Part/Chapter/Section/etc.
3903 It moves the whole substructure of the group.
3907 \begin_layout Description
3911 \begin_layout Description
3912 Origin Vermeer, 23 Mar 2006
3915 \begin_layout Subsection*
3919 \begin_layout Description
3920 Action Move the current group in the downward direction in the structure
3925 \begin_layout Description
3926 Notion The "group" can be Part/Chapter/Section/etc.
3927 It moves the whole substructure of the group.
3931 \begin_layout Description
3935 \begin_layout Description
3936 Origin Vermeer, 23 Mar 2006
3939 \begin_layout Subsection*
3943 \begin_layout Description
3944 Action Moves the current group in the downward direction in the hierarchy
3945 of the document structure.
3949 \begin_layout Description
3950 Notion Part -> Chapter -> Section -> etc.
3954 \begin_layout Description
3958 \begin_layout Description
3959 Origin Vermeer, 23 Mar 2006
3962 \begin_layout Subsection*
3966 \begin_layout Description
3967 Action Moves the current group in the upward direction in the hierarchy
3968 of the document structure.
3972 \begin_layout Description
3973 Notion Part <- Chapter <- Section <- etc.
3977 \begin_layout Description
3981 \begin_layout Description
3982 Origin Vermeer, 23 Mar 2006
3985 \begin_layout Subsection*
3989 \begin_layout Description
3990 Action Edit the inset at cursor with an external application, *
3991 if one is attributed.
3995 \begin_layout Description
3996 Syntax inset-edit [<INSET_PARAMS>]
3999 \begin_layout Description
4000 Params <INSET_PARAMS>: Parameters for the inset.
4002 \begin_inset Newline newline
4005 Currently only the filename will be considered.
4009 \begin_layout Description
4010 Origin JSpitzm, 27 Apr 2006
4013 \begin_layout Subsection*
4017 \begin_layout Description
4018 Action Inserts table into the document.
4022 \begin_layout Description
4023 Syntax tabular-insert [<ROWS> <COLUMNS>]
4026 \begin_layout Description
4027 Params In case no arguments are given show insert dialog.
4031 \begin_layout Description
4032 Origin Jug, 12 Apr 2000
4035 \begin_layout Subsection*
4036 LFUN_TABULAR_FEATURE
4039 \begin_layout Description
4040 Action Sets various features to the table/cell on the current cursor position.
4044 \begin_layout Description
4045 Notion Various math-environment features are handled here as well, e.g.
4046 add-vline-left/right for the Grid/Array environment
4049 \begin_layout Description
4050 Syntax tabular-feature <FEATURE> [<ARG>]
4053 \begin_layout Description
4054 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
4055 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
4056 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
4057 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
4058 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
4059 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
4060 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
4061 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
4062 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
4063 set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
4064 |set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
4065 ar-valign-middle|tabular-valign-bottom
4066 \begin_inset Newline newline
4069 <ARG>: additional argument for some commands, use debug mode to explore
4074 \begin_layout Description
4075 Origin Jug, 28 Jul 2000
4078 \begin_layout Subsection*
4082 \begin_layout Description
4083 Action Moves the cursor to the previous cell inside the table.
4087 \begin_layout Description
4088 Syntax cell-backward
4091 \begin_layout Description
4092 Origin Jug, 22 May 2000
4095 \begin_layout Subsection*
4099 \begin_layout Description
4100 Action Moves the cursor to the next cell inside the table.
4104 \begin_layout Description
4108 \begin_layout Subsection*
4112 \begin_layout Description
4113 Action Splits cell and shifts right part to the next cell (inside the math
4118 \begin_layout Description
4122 \begin_layout Description
4123 Origin Ale, 15 May 1997
4126 \begin_layout Subsection*
4130 \begin_layout Description
4131 Action Register the document as an file inside version control system (RCS,
4136 \begin_layout Description
4137 Notion File is registered inside cvs, svn or rcs repository acording to
4138 the existence of cvs/svn/rcs entries in the document's directory.
4140 \begin_inset Newline newline
4143 See LyX Additional Features Manual (Version Control Chapter) for additional
4148 \begin_layout Description
4152 \begin_layout Description
4153 Origin Lgb, 1 Jul 1997
4156 \begin_layout Subsection*
4160 \begin_layout Description
4161 Action Checks-in/commits the changes of the registered file to the repository.
4165 \begin_layout Description
4166 Notion In RCS case this also unlocks the file.
4170 \begin_layout Description
4174 \begin_layout Description
4175 Origin Lgb, 1 Jul 1997
4178 \begin_layout Subsection*
4182 \begin_layout Description
4183 Action Checks-out the document for edit (and locks it for RCS).
4187 \begin_layout Description
4188 Notion This is implemented only for RCS and SVN, not CVS.
4192 \begin_layout Description
4196 \begin_layout Description
4197 Origin Lgb, 1 Jul 1997
4200 \begin_layout Subsection*
4204 \begin_layout Description
4205 Action Reverts the document to the last check-in/commit in VCS.
4209 \begin_layout Description
4213 \begin_layout Description
4214 Origin Lgb, 1 Jul 1997
4217 \begin_layout Subsection*
4221 \begin_layout Description
4222 Action Undo last check-in.
4226 \begin_layout Description
4227 Notion This is currently implemented only for RCS.
4231 \begin_layout Description
4235 \begin_layout Description
4236 Origin Lgb, 1 Jul 1997
4239 \begin_layout Subsection*
4243 \begin_layout Description
4244 Action Executes external command.
4245 This command is intended to support additional VCS commands.
4249 \begin_layout Description
4250 Syntax vc-command <FLAG> <PATH> <COMMAND>
4253 \begin_layout Description
4254 Params <FLAG>: Flags for the command can be combined together.
4256 \begin_inset Newline newline
4259 U - dUmmy - no flags
4260 \begin_inset Newline newline
4263 D - Doc - need document loaded to proceed
4264 \begin_inset Newline newline
4267 I - dIrty - mark document dirty
4268 \begin_inset Newline newline
4271 R - Reload - ensure that the document is saved and reload it after command
4273 \begin_inset Newline newline
4276 M - Message - ask for input string (commit message)
4277 \begin_inset Newline newline
4280 <PATH>: path where to start.
4281 $$p will be replaced by the current document path.
4283 \begin_inset Newline newline
4286 <COMMAND>: command to execute.
4287 $$i/$$p/$$m will be replaced by the current document/path/message.
4291 \begin_layout Description
4292 Sample vc-command DR $$p "svn up"
4295 \begin_layout Description
4296 Origin sanda, 13 Jan 2009
4299 \begin_layout Subsection*
4303 \begin_layout Description
4304 Action Toggles change tracking to on/off.
4308 \begin_layout Description
4309 Syntax changes-track
4312 \begin_layout Description
4313 Origin levon, 1 Oct 2002
4316 \begin_layout Subsection*
4320 \begin_layout Description
4321 Action Toggles showing of change tracking in typesetted output.
4325 \begin_layout Description
4326 Syntax changes-output
4329 \begin_layout Description
4330 Origin jspitzm, 21 Jan 2005
4333 \begin_layout Subsection*
4337 \begin_layout Description
4338 Action Moves the cursor to the position of the next change of the change
4343 \begin_layout Description
4347 \begin_layout Description
4348 Origin schmitt, 4 Oct 2006
4351 \begin_layout Subsection*
4352 LFUN_CHANGE_PREVIOUS
4355 \begin_layout Description
4356 Action Moves the cursor to the position of the previous change of the change
4361 \begin_layout Description
4362 Syntax change-previous
4365 \begin_layout Description
4366 Origin vfr, 4 Apr 2009
4369 \begin_layout Subsection*
4373 \begin_layout Description
4374 Action Open change tracking dialog for merging and moves the cursor to the
4375 position of the next change.
4379 \begin_layout Description
4380 Syntax changes-merge
4383 \begin_layout Description
4384 Origin Levon, 16 Oct 2002
4387 \begin_layout Subsection*
4391 \begin_layout Description
4392 Action Accepts tracked change inside the selection.
4396 \begin_layout Description
4397 Syntax change-accept
4400 \begin_layout Description
4401 Origin Levon, 16 Oct 2002
4404 \begin_layout Subsection*
4408 \begin_layout Description
4409 Action Rejects tracked change inside the selection.
4413 \begin_layout Description
4414 Syntax change-accept
4417 \begin_layout Description
4418 Origin Levon, 16 Oct 2002
4421 \begin_layout Subsection*
4422 LFUN_ALL_CHANGES_ACCEPT
4425 \begin_layout Description
4426 Action Accepts all tracked changes in the document.
4430 \begin_layout Description
4431 Syntax all-changes-accept
4434 \begin_layout Description
4435 Origin Levon, 16 Oct 2002
4438 \begin_layout Subsection*
4439 LFUN_ALL_CHANGES_REJECT
4442 \begin_layout Description
4443 Action Rejects all tracked changes in the document.
4447 \begin_layout Description
4448 Notion Reject does not work recursively; the user may have to repeat the
4453 \begin_layout Description
4454 Syntax all-changes-reject
4457 \begin_layout Description
4458 Origin Levon, 16 Oct 2002
4461 \begin_layout Subsection*
4465 \begin_layout Description
4466 Action Apply data for an inset.
4470 \begin_layout Description
4471 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4473 This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4474 on the context where it is called.
4478 \begin_layout Description
4479 Syntax inset-apply <ARGS>
4482 \begin_layout Description
4483 Params See LFUN_INSET_INSERT .
4487 \begin_layout Subsection*
4491 \begin_layout Description
4492 Action Dissolve the current inset into text.
4496 \begin_layout Description
4497 Syntax inset-dissolve [<INSET>]
4500 \begin_layout Description
4501 Params <INSET>: this can be used to make sure the right kind of inset is
4503 For example "dissolve" entry in the charstyles sub-menu should only dissolve
4504 the charstyle inset, even if the cursor is inside several nested insets
4507 \begin_inset Newline newline
4510 For values see lyx::InsetLayout::lyxtype_ .
4514 \begin_layout Description
4515 Origin JSpitz, 7 Aug 2006
4518 \begin_layout Subsection*
4522 \begin_layout Description
4523 Action Insert new inset (type given by the parameters).
4527 \begin_layout Description
4528 Syntax inset-insert <INSET> <ARGS>
4531 \begin_layout Description
4532 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4533 nclude|index|label|nomencl|vspace|ref|toc>
4534 \begin_inset Newline newline
4537 <ARGS>: depends on the given inset.
4538 Use "lyx -dbg action" to explore.
4542 \begin_layout Description
4543 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4546 \begin_inset Newline newline
4549 where <label name> is the name of the referenced label and<Format> is one
4551 \begin_inset Newline newline
4555 \begin_inset Newline newline
4558 eqref -- (<reference>)
4559 \begin_inset Newline newline
4563 \begin_inset Newline newline
4566 vpageref -- on <page>
4567 \begin_inset Newline newline
4570 vref -- <reference> on <page>
4571 \begin_inset Newline newline
4574 prettyref -- Formatted reference
4577 \begin_layout Subsection*
4581 \begin_layout Description
4582 Action Modify existing inset.
4586 \begin_layout Description
4587 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4588 graphics, include, label, listings, note, phantom, ref, space, tabular,
4589 vspace, wrap insets.
4593 \begin_layout Description
4594 Syntax inset-modify <INSET> <ARGS>
4597 \begin_layout Description
4598 Params See LFUN_INSET_INSERT for further details.
4602 \begin_layout Subsection*
4603 LFUN_NEXT_INSET_MODIFY
4606 \begin_layout Description
4607 Action Modify the inset at cursor position, if there is one.
4611 \begin_layout Description
4612 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4613 graphics, include, label, listings, note, phantom, ref, space, tabular,
4614 vspace, wrap insets.
4618 \begin_layout Description
4619 Syntax next-inset-modify <INSET> <ARGS>
4622 \begin_layout Description
4623 Syntax next-inset-modify changetype <TYPE>
4626 \begin_layout Description
4627 Params See LFUN_INSET_INSERT for further details.
4631 \begin_layout Description
4632 Origin JSpitzm, 23 Mar 2008
4635 \begin_layout Subsection*
4636 LFUN_INSET_DIALOG_UPDATE
4639 \begin_layout Description
4640 Action Updates the values inside the dialog from the inset.
4644 \begin_layout Description
4645 Notion This is internal LFUN, not to be used by users.
4646 Called internally by LFUN_DIALOG_UPDATE
4649 \begin_layout Description
4650 Params <DIALOG-NAME>
4653 \begin_layout Description
4654 Origin leeming, 25 Feb 2003
4657 \begin_layout Subsection*
4661 \begin_layout Description
4662 Action Open the inset's properties dialog.
4666 \begin_layout Description
4667 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, *
4668 float, graphics, href, include, index, index_print, label,
4669 listings, * note, phantom, ref, space, tabular, vspace, wrap
4674 \begin_layout Description
4675 Syntax inset-settings <INSET>
4678 \begin_layout Description
4679 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
4680 * graphics|href|include|index|index_print|label|listings|
4681 * note|phantom|ref|space|tabular|vspace|wrap>.
4685 \begin_layout Subsection*
4689 \begin_layout Description
4690 Action Toggles the collapsable inset at cursor position, * or
4691 the inset we are currently in.
4695 \begin_layout Description
4696 Syntax inset-toggle [<ARG>]
4699 \begin_layout Description
4700 Params <ARG>: <open|close|toggle|assign>.
4702 \begin_inset Newline newline
4705 open/close/toggle are for collapsable insets.
4706 toggle is used when no argument is given.
4708 \begin_inset Newline newline
4711 assign synchronize the branch-inset with activation status of the branch.
4712 Used for global toggling when changed activation.
4716 \begin_layout Description
4717 Origin lasgouttes, 19 Jul 2001
4720 \begin_layout Subsection*
4721 LFUN_ALL_INSETS_TOGGLE
4724 \begin_layout Description
4725 Action Toggles (open/closes) all collapsable insets (of a given type) in
4730 \begin_layout Description
4731 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4735 \begin_layout Description
4736 Syntax all-insets-toggle [<STATE>] [<INSET>]
4739 \begin_layout Description
4740 Params <STATE>: <toggle|open|close|assign> default: toggle
4741 \begin_inset Newline newline
4744 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4748 \begin_layout Description
4749 Origin leeming, 30 Mar 2004
4752 \begin_layout Subsection*
4753 LFUN_SET_GRAPHICS_GROUP
4756 \begin_layout Description
4757 Action Set the group for the graphics inset on the cursor position.
4761 \begin_layout Description
4762 Syntax set-graphics-group [<GROUP>]
4765 \begin_layout Description
4766 Params <GROUP>: Id for an existing group.
4767 In case the Id is an empty string, the graphics inset is removed from the
4772 \begin_layout Description
4773 Origin sanda, 6 May 2008
4776 \begin_layout Subsection*
4777 LFUN_FINISHED_FORWARD
4780 \begin_layout Description
4781 Action Moves the cursor out of the current slice, going forward.
4785 \begin_layout Description
4786 Notion Cursor movement within an inset may be different than cursor movement
4787 in the surrounding text.
4788 This action should be called automatically by the cursor movement within
4789 the inset, when movement within the inset has ceased (reached the end of
4790 the last paragraph, for example), in order to move correctly back into
4791 the surrounding text.
4795 \begin_layout Subsection*
4796 LFUN_FINISHED_BACKWARD
4799 \begin_layout Description
4800 Action Moves the cursor out of the current slice, going backwards.
4804 \begin_layout Description
4805 Notion See also LFUN_FINISHED_FORWARD.
4809 \begin_layout Subsection*
4813 \begin_layout Description
4814 Action Moves the cursor out of the current slice, going right.
4818 \begin_layout Description
4819 Notion See also LFUN_FINISHED_FORWARD
4822 \begin_layout Subsection*
4826 \begin_layout Description
4827 Action Moves the cursor out of the current slice, going left.
4831 \begin_layout Description
4832 Notion See also LFUN_FINISHED_FORWARD.
4836 \begin_layout Subsection*
4840 \begin_layout Description
4841 Action Set language from the current cursor position.
4845 \begin_layout Description
4846 Syntax language <LANG>
4849 \begin_layout Description
4850 Params <LANG>: Requested language.
4851 Look in lib/languages for the list.
4855 \begin_layout Description
4856 Origin Dekel, 2 Mar 2000
4859 \begin_layout Subsection*
4863 \begin_layout Description
4864 Action Goto a label.
4868 \begin_layout Description
4869 Syntax label-goto [<LABEL>]
4872 \begin_layout Description
4873 Params <LABEL>: Requested label.
4874 If no label is given and reference is on cursor position, Bookmark 0 is
4875 saved and cursor moves to the position of referenced label.
4879 \begin_layout Description
4880 Origin Ale, 6 Aug 1997
4883 \begin_layout Subsection*
4887 \begin_layout Description
4888 Action Inserts label to text or displayed formula.
4892 \begin_layout Description
4893 Syntax label-insert [<LABEL>]
4896 \begin_layout Description
4897 Params <LABEL>: Requested label.
4898 If no label is given dialog requesting name will be opened.
4902 \begin_layout Subsection*
4906 \begin_layout Description
4907 Action Go to the next label or cross-reference.
4911 \begin_layout Description
4912 Syntax reference-next
4915 \begin_layout Description
4916 Origin Dekel, 14 Jan 2001
4919 \begin_layout Subsection*
4923 \begin_layout Description
4924 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
4925 Note that bookmarsk are saved per-session, not per file.
4929 \begin_layout Description
4930 Notion Bookmark 0 has a special purpose.
4931 It is automatically set
4932 \begin_inset Newline newline
4936 to the paragraph you are currently editing
4937 \begin_inset Newline newline
4941 to the paragraph from where you are jumping to the last-edited position
4943 \begin_inset Newline newline
4947 when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
4951 \begin_layout Description
4952 Syntax bookmark-goto <NUMBER>
4955 \begin_layout Description
4956 Params <NUMBER>: the number of the bookmark to restore.
4960 \begin_layout Description
4961 Origin Dekel, 27 January 2001
4964 \begin_layout Subsection*
4968 \begin_layout Description
4969 Action Save a bookmark.
4973 \begin_layout Description
4974 Notion Saves a numbered bookmark to the sessions file.
4975 The number must be between 1 and 9, inclusive.
4976 Note that bookmarks are saved per-session, not per file.
4980 \begin_layout Description
4981 Syntax bookmark-save <NUMBER>
4984 \begin_layout Description
4985 Params <NUMBER>: the number of the bookmark to save.
4989 \begin_layout Description
4990 Origin Dekel, 27 January 2001
4993 \begin_layout Subsection*
4997 \begin_layout Description
4998 Action Clears the list of saved bookmarks.
5002 \begin_layout Description
5003 Syntax bookmark-clear
5006 \begin_layout Description
5007 Origin bpeng, 31 October 2006
5010 \begin_layout Subsection*
5014 \begin_layout Description
5015 Action Open the given help file according to the language setting.
5019 \begin_layout Description
5020 Syntax help-open <FILE>[.lyx]
5023 \begin_layout Description
5024 Params <FILE>: any document from (/usr/share/)doc directory.
5028 \begin_layout Description
5029 Origin Jug, 27 Jun 1999
5032 \begin_layout Subsection*
5036 \begin_layout Description
5037 Action Terminates the current LyX instance.
5041 \begin_layout Description
5042 Notion Terminates the current LyX instance, asking whether to save modified
5047 \begin_layout Description
5051 \begin_layout Subsection*
5055 \begin_layout Description
5056 Action Toggles visibility of a given toolbar between on/off/auto.
5060 \begin_layout Description
5061 Notion Skiping "auto" when allowauto is false.
5065 \begin_layout Description
5066 Syntax toolbar-toggle <NAME> [allowauto]
5069 \begin_layout Description
5070 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
5071 ew/update|math_panels|vcs
5074 \begin_layout Description
5075 Origin Edwin, 21 May 2007
5078 \begin_layout Subsection*
5082 \begin_layout Description
5083 Action Opens the menu given by its name.
5087 \begin_layout Description
5088 Syntax menu-open <NAME>
5091 \begin_layout Description
5092 Params <NAME>: menu name.
5093 See various .inc files in lib/ui for candidates.
5097 \begin_layout Subsection*
5101 \begin_layout Description
5102 Action Various UI visibility-toggling actions.
5106 \begin_layout Description
5107 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5110 \begin_layout Description
5111 Params statusbar : Toggle visibility of the statusbar.
5113 \begin_inset Newline newline
5116 menubar : Toggle visibility of the menubar.
5118 \begin_inset Newline newline
5121 scrollbar : Toggle visibility of the scrollbar.
5123 \begin_inset Newline newline
5126 frame : Toggle visibility of the frames around editing window.
5128 \begin_inset Newline newline
5131 fullscreen : Toggle fullscreen mode.
5132 This also covers calling the previous functions.
5133 However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
5138 \begin_layout Description
5139 Origin sanda, 9 Feb 2007
5142 \begin_layout Subsection*
5146 \begin_layout Description
5147 Action Creates new empty LyX window.
5151 \begin_layout Description
5152 Notion Already opened documents from the previous window can be found under
5157 \begin_layout Description
5158 Syntax window-new [<GEOMETRY>]
5161 \begin_layout Description
5162 Params <GEOMETRY>: pass the geometry of the window.
5163 This parameter is currently accepted only on Windows platform.
5167 \begin_layout Description
5168 Origin Abdel, 21 Oct 2006
5171 \begin_layout Subsection*
5175 \begin_layout Description
5176 Action Closes the current LyX window.
5180 \begin_layout Description
5184 \begin_layout Description
5185 Origin Abdel, 23 Oct 2006
5188 \begin_layout Subsection*
5192 \begin_layout Description
5193 Action Creates another split view of current buffer.
5197 \begin_layout Description
5198 Notion All split views act in the same way indpendently.
5202 \begin_layout Description
5203 Syntax split-view <vertical|horizontal>
5206 \begin_layout Description
5207 Params horizontal : The work areas are laid out side by side.
5209 \begin_inset Newline newline
5212 vertical : The work areas laid out vertically.
5216 \begin_layout Description
5217 Origin Abdel, 20 Feb 2008
5220 \begin_layout Subsection*
5221 LFUN_CLOSE_TAB_GROUP
5224 \begin_layout Description
5225 Action Close the current tab group.
5229 \begin_layout Description
5230 Notion This only closes the work areas, not the buffer themselves.
5231 The still opened buffers can be visualized in another tab group.
5235 \begin_layout Description
5236 Syntax close-tab-group
5239 \begin_layout Description
5240 Origin Abdel, 21 Feb 2008
5243 \begin_layout Subsection*
5247 \begin_layout Description
5248 Action Shows hidden dialog or create new one for a given function/inset
5253 \begin_layout Description
5254 Syntax dialog-show <NAME> [<DATA>]
5257 \begin_layout Description
5258 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5260 \begin_inset Newline newline
5263 document|errorlist|ert|external|file|findreplace|float|graphics|
5264 \begin_inset Newline newline
5267 include|index|info|nomenclature|label|listings|log|mathdelimiter|
5268 \begin_inset Newline newline
5271 mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space|
5272 \begin_inset Newline newline
5275 spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|
5277 \begin_inset Newline newline
5280 view-source|vspace|wrap|<SPECIAL>
5281 \begin_inset Newline newline
5284 <SPECIAL>: latexlog|vclog
5285 \begin_inset Newline newline
5288 <DATA>: data, usually settings for the given dialog.
5289 Use debug mode for the details.
5293 \begin_layout Description
5294 Origin leeming, 17 Jun 2003
5297 \begin_layout Subsection*
5298 LFUN_DIALOG_SHOW_NEW_INSET
5301 \begin_layout Description
5302 Action Shows hidden dialog or create new one for a given inset settings
5307 \begin_layout Description
5308 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5313 \begin_layout Description
5314 Syntax dialog-show-new-inset <NAME> [<DATA>]
5317 \begin_layout Description
5318 Params See LFUN_DIALOG_SHOW .
5322 \begin_layout Description
5323 Origin leeming, 25 Feb 2003
5326 \begin_layout Subsection*
5330 \begin_layout Description
5331 Action Updates the dialog values from the inset/paragraph/document.
5335 \begin_layout Description
5336 Syntax dialog-update <NAME>
5339 \begin_layout Description
5340 Params <NAME>: paragraph|prefs|<INSET>
5341 \begin_inset Newline newline
5347 \begin_layout Description
5348 Origin leeming, 25 Feb 2003
5351 \begin_layout Subsection*
5355 \begin_layout Description
5356 Action Hides showed dialog.
5357 Counterpart to LFUN_DIALOG_SHOW .
5361 \begin_layout Description
5362 Syntax dialog-hide <NAME>
5365 \begin_layout Description
5366 Params See LFUN_DIALOG_SHOW .
5370 \begin_layout Description
5371 Origin leeming, 25 Feb 2003
5374 \begin_layout Subsection*
5378 \begin_layout Description
5379 Action Toggles dialog between showed/hidden state.
5383 \begin_layout Description
5384 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5388 \begin_layout Description
5389 Syntax dialog-toggle <NAME> [<DATA>]
5392 \begin_layout Description
5393 Params See LFUN_DIALOG_SHOW .
5397 \begin_layout Description
5398 Origin JSpitzm, 30 Apr 2007
5401 \begin_layout Subsection*
5402 LFUN_DIALOG_DISCONNECT_INSET
5405 \begin_layout Description
5406 Action Closes opened connection to opened inset.
5410 \begin_layout Description
5411 Notion Connection is used for apply functions.
5415 \begin_layout Description
5416 Syntax dialog-disconnect-inset <INSET-NAME>
5419 \begin_layout Description
5420 Origin leeming, 25 Feb 2003
5423 \begin_layout Subsection*
5427 \begin_layout Description
5428 Action This function is called when mouse button is pressed (inside workarea).Act
5429 ion depends on the context.
5433 \begin_layout Description
5434 Notion This is internal LFUN, not to be used by users.
5438 \begin_layout Description
5439 Origin Andre, 9 Aug 2002
5442 \begin_layout Subsection*
5446 \begin_layout Description
5447 Action This function is called when double click on mouse button is pressed
5449 Action depends on the context.
5453 \begin_layout Description
5454 Notion This is internal LFUN, not to be used by users.
5458 \begin_layout Description
5459 Origin Andre, 9 Aug 2002
5462 \begin_layout Subsection*
5466 \begin_layout Description
5467 Action This function is called when triple click on mouse button is pressed
5469 Action depends on the context.
5473 \begin_layout Description
5474 Notion This is internal LFUN, not to be used by users.
5478 \begin_layout Description
5479 Origin Andre, 9 Aug 2002
5482 \begin_layout Subsection*
5486 \begin_layout Description
5487 Action This function is called when mouse cursor is moving over the text.Action
5488 depends on the context.
5492 \begin_layout Description
5493 Notion This is internal LFUN, not to be used by users.
5497 \begin_layout Description
5498 Origin Andre, 9 Aug 2002
5501 \begin_layout Subsection*
5505 \begin_layout Description
5506 Action This function is called when mouse button is released (inside workarea).Ac
5507 tion depends on the context.
5511 \begin_layout Description
5512 Notion This is internal LFUN, not to be used by users.
5516 \begin_layout Description
5517 Origin Andre, 9 Aug 2002
5520 \begin_layout Subsection*
5524 \begin_layout Description
5525 Action Turn off the loaded keyboard map.
5529 \begin_layout Description
5533 \begin_layout Subsection*
5537 \begin_layout Description
5538 Action Turn on the primary keyboard map.
5542 \begin_layout Description
5543 Notion Maps were widely used in past, when X-windows didn't have nowadays
5545 They can be still used to maintain uniform keyboard layout across the various
5548 \begin_inset Newline newline
5551 The language is to be set in the Preferences dialog.
5555 \begin_layout Description
5556 Syntax keymap-primary
5559 \begin_layout Subsection*
5560 LFUN_KEYMAP_SECONDARY
5563 \begin_layout Description
5564 Action Turn on the secondary keyboard map.
5568 \begin_layout Description
5569 Syntax keymap-secondary
5572 \begin_layout Subsection*
5576 \begin_layout Description
5577 Action Toggles keyboard maps (first/second/off).
5581 \begin_layout Description
5582 Syntax keymap-toggle
5585 \begin_layout Description
5586 Origin leeming, 30 Mar 2004
5589 \begin_layout Subsection*
5590 LFUN_SERVER_GET_LAYOUT
5593 \begin_layout Description
5594 Action Returns the current layout (that is environment) name on the cursor
5599 \begin_layout Description
5600 Syntax server-get-layout
5603 \begin_layout Subsection*
5604 LFUN_SERVER_GET_FILENAME
5607 \begin_layout Description
5608 Action Returns path and file name of the currently edited document.
5612 \begin_layout Description
5613 Syntax server-get-filename
5616 \begin_layout Subsection*
5617 LFUN_SERVER_GOTO_FILE_ROW
5620 \begin_layout Description
5621 Action Sets the cursor position based on the row number of generated TeX
5626 \begin_layout Description
5627 Notion This can be useful for DVI inverse-search or detection of the problematic
5628 line from LaTeX compilation.
5632 \begin_layout Description
5633 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5636 \begin_layout Description
5637 Origin Edmar, 23 Dec 1998
5640 \begin_layout Subsection*
5644 \begin_layout Description
5645 Action Sends notify message about the last key-sequence to client.
5649 \begin_layout Description
5650 Notion This can be used to grab last key-sequence used inside the LyX window.
5651 See also Debug extensions section in Additional features manual.
5655 \begin_layout Description
5656 Syntax server-notify
5659 \begin_layout Subsection*
5663 \begin_layout Description
5664 Action Sets the cursor position based on the editing area coordinates (similar
5665 as clicking on that point with left mouse button).
5669 \begin_layout Description
5670 Syntax server-set-xy <X> <Y>
5673 \begin_layout Subsection*
5677 \begin_layout Description
5678 Action Returns the coordinates of cursor position in the editing area.
5682 \begin_layout Description
5683 Syntax server-get-xy
5686 \begin_layout Subsection*
5690 \begin_layout Description
5691 Action Generates the code (literate programming).
5695 \begin_layout Description
5696 Notion Latex file with extension literate_extension is generated.
5697 Then LyX invokes build_command (with a default of``make'') to generate
5698 the code and build_error_filter to process the compilation error messages.
5700 \begin_inset Newline newline
5703 In case you want to process your literate file with a script, or some other
5704 program, just insert in your lyxrc file an entry with:
5705 \begin_inset Newline newline
5708 build_command "my_script my_arguments"
5709 \begin_inset Newline newline
5712 The build_error_filter differs from the literate_error_filter only in that
5713 the former will identify error messages from your compiler.
5717 \begin_layout Description
5718 Syntax build-program
5721 \begin_layout Subsection*
5722 LFUN_BUFFER_AUTO_SAVE
5725 \begin_layout Description
5726 Action Saves the current buffer to a temporary file.
5730 \begin_layout Description
5731 Notion Saves the current buffer to a file named "#filename#".
5732 This LFUN is called automatically by LyX, to "autosave" the current buffer.
5736 \begin_layout Description
5737 Syntax buffer-auto-save
5740 \begin_layout Subsection*
5741 LFUN_BUFFER_CHILD_OPEN
5744 \begin_layout Description
5745 Action Loads the given child document.
5749 \begin_layout Description
5750 Notion The current document is treated as a parent.
5754 \begin_layout Description
5755 Syntax buffer-child-open <FILE>
5758 \begin_layout Description
5759 Params <FILE>: Filename of the child.
5760 The directory of the parent is assumed by default.
5764 \begin_layout Description
5765 Origin Ale, 28 May 1997
5768 \begin_layout Subsection*
5772 \begin_layout Description
5773 Action Runs chktex for the current document.
5777 \begin_layout Description
5778 Syntax buffer-chktex
5781 \begin_layout Description
5782 Origin Asger, 30 Oct 1997
5785 \begin_layout Subsection*
5786 LFUN_BUFFER_TOGGLE_COMPRESSION
5789 \begin_layout Description
5790 Action Toggles compression of the current document on/off.
5794 \begin_layout Description
5795 Syntax buffer-toggle-compression
5798 \begin_layout Description
5799 Origin bpeng, 27 Apr 2006
5802 \begin_layout Subsection*
5806 \begin_layout Description
5807 Action Closes the current buffer.
5811 \begin_layout Description
5812 Notion Closes the current buffer, asking whether to save it, etc, if the
5813 buffer has been modified.
5817 \begin_layout Description
5821 \begin_layout Subsection*
5825 \begin_layout Description
5826 Action Exports the current buffer (document) to the given format.
5830 \begin_layout Description
5831 Syntax buffer-export <FORMAT>
5834 \begin_layout Description
5835 Params <FORMAT> is either "custom" or one of the formats which you can find
5836 in Tools->Preferences->File formats->Format.
5837 Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5838 for pdflatex) or "ps" for postscript.
5840 \begin_inset Newline newline
5843 In case of "custom" you will be asked for a format you want to start from
5844 and for the command that you want to apply to this format.
5845 Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5849 \begin_layout Description
5850 Origin Lgb, 29 Jul 1997
5853 \begin_layout Subsection*
5854 LFUN_BUFFER_EXPORT_CUSTOM
5857 \begin_layout Description
5858 Action Exports the current buffer (document) from the given format using
5859 the given command on it.
5863 \begin_layout Description
5864 Syntax buffer-export-custom <FORMAT> <COMMAND>
5867 \begin_layout Description
5868 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5871 \begin_inset Newline newline
5874 <COMMAND> this command will be launched on the file.
5875 Note that you can use "$$FName" string to qualify the intermediate file.
5879 \begin_layout Description
5880 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5883 \begin_layout Description
5884 Origin leeming, 27 Mar 2004
5887 \begin_layout Subsection*
5891 \begin_layout Description
5892 Action Prints the current document.
5896 \begin_layout Description
5897 Notion Many settings can be given via the preferences dialog.
5901 \begin_layout Description
5902 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5905 \begin_layout Description
5906 Params <TARGET> is either "printer" or "file".
5908 \begin_inset Newline newline
5911 <TARGER-NAME> is either "default" or file name or printer name.
5913 \begin_inset Newline newline
5916 <COMMAND> command ensuring the printing job.
5920 \begin_layout Description
5921 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5924 \begin_layout Description
5925 Origin leeming, 28 Mar 2004
5928 \begin_layout Subsection*
5932 \begin_layout Description
5933 Action Import a given file as a lyx document.
5937 \begin_layout Description
5938 Notion File can be imported iff lyx file format is (transitively) reachable
5939 via defined convertors in preferences.
5940 Look into File->Import menu to get an idea of the currently active import
5945 \begin_layout Description
5946 Syntax buffer-import <FORMAT> [<FILE>]
5949 \begin_layout Description
5950 Origin Asger, 24 Jul 1998
5953 \begin_layout Subsection*
5957 \begin_layout Description
5958 Action Creates a new buffer (that is, document).
5962 \begin_layout Description
5963 Notion Implicit path can be set in Preferences dialog.
5967 \begin_layout Description
5968 Syntax buffer-new [<FILE>]
5971 \begin_layout Description
5972 Params <FILE>: filename of created file with absolute path.
5976 \begin_layout Subsection*
5977 LFUN_BUFFER_NEW_TEMPLATE
5980 \begin_layout Description
5981 Action Creates a new buffer (that is, document) from a template.
5985 \begin_layout Description
5986 Notion Path for new files and templates can be set in Preferences dialog.
5987 Template will be asked for via Open-dialog.
5991 \begin_layout Description
5992 Syntax buffer-new-template [<FILE>]
5995 \begin_layout Description
5996 Params <FILE>: filename of created file with absolute path.
6000 \begin_layout Subsection*
6004 \begin_layout Description
6005 Action Reverts opened document.
6009 \begin_layout Description
6010 Syntax buffer-reload
6013 \begin_layout Description
6014 Origin Asger, 2 Feb 1997
6017 \begin_layout Subsection*
6021 \begin_layout Description
6022 Action Switch to the given buffer.
6026 \begin_layout Description
6027 Notion This is useful also in case you need simultaneously more views of
6028 the edited document in different LyX windows.
6032 \begin_layout Description
6033 Syntax buffer-new-template <BUFFER>
6036 \begin_layout Description
6037 Params <BUFFER>: already opened document which is to be shown.
6041 \begin_layout Subsection*
6042 LFUN_BUFFER_TOGGLE_READ_ONLY
6045 \begin_layout Description
6046 Action Toggle editing mode of the current document between read/write and
6051 \begin_layout Description
6052 Notion In the ->Readonly mode checks-in/commits the data if the file is
6053 under version control.
6054 In the Readonly-> mode checkouts the data from repository.
6056 \begin_inset Newline newline
6059 If these operations fail, buffer won't be toggled.
6063 \begin_layout Description
6064 Syntax buffer-toggle-read-only
6067 \begin_layout Description
6068 Origin Lgb, 27 May 1997
6071 \begin_layout Subsection*
6075 \begin_layout Description
6076 Action Displays current buffer in chosen format.
6080 \begin_layout Description
6081 Notion Displays the contents of the current buffer in the chosen format,
6082 for example, PDF or DVI.
6083 This runs the necessary converter, calls the defined viewer, and so forth.
6087 \begin_layout Description
6088 Syntax buffer-view [<FORMAT>]
6091 \begin_layout Description
6092 Params <FORMAT>: The format to display, where this is one of the formats
6093 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6094 If no format is given, the default format as specified in the same dialog
6099 \begin_layout Subsection*
6103 \begin_layout Description
6104 Action Exports the current document and put the result into the temporary
6109 \begin_layout Description
6110 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
6111 EW) the output will be rewriten - updated.
6112 This is useful in case your viewer is able to detect such changes (e.g.
6113 ghostview for postscript).
6117 \begin_layout Description
6118 Syntax buffer-update [<FORMAT>]
6121 \begin_layout Description
6122 Params <FORMAT>: The format to display, where this is one of the formats
6123 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6124 If no format is given, the default format as specified in the same dialog
6129 \begin_layout Description
6130 Origin Dekel, 5 Aug 2000
6133 \begin_layout Subsection*
6137 \begin_layout Description
6138 Action Saves the current buffer.
6142 \begin_layout Description
6143 Notion Saves the current buffer to disk, using the filename that is already
6144 associated with the buffer, asking for one if none is yet assigned.
6148 \begin_layout Description
6152 \begin_layout Subsection*
6153 LFUN_BUFFER_WRITE_AS
6156 \begin_layout Description
6157 Action Rename and save current buffer.
6161 \begin_layout Description
6162 Syntax buffer-write-as <FILENAME>
6165 \begin_layout Description
6166 Params <FILENAME>: New name of the buffer/file.
6167 A relative path is with respect to the original location of the buffer/file.
6171 \begin_layout Subsection*
6172 LFUN_BUFFER_WRITE_ALL
6175 \begin_layout Description
6176 Action Save all changed documents.
6180 \begin_layout Description
6181 Syntax buffer-write-all
6184 \begin_layout Description
6185 Origin rgh, gpothier 6 Aug 2007
6188 \begin_layout Subsection*
6192 \begin_layout Description
6193 Action Switch to the next opened document.
6197 \begin_layout Description
6198 Notion Note that this does not necessarily mean next in tabbar (for full
6199 list see View menu).
6203 \begin_layout Description
6207 \begin_layout Subsection*
6208 LFUN_BUFFER_PREVIOUS
6211 \begin_layout Description
6212 Action Switch to the previous opened document.
6216 \begin_layout Description
6217 Syntax buffer-previous
6220 \begin_layout Subsection*
6221 LFUN_MASTER_BUFFER_UPDATE
6224 \begin_layout Description
6225 Action When run from a child document, this updates (exports) document built
6226 from the master buffer, if available.
6230 \begin_layout Description
6231 Syntax master-buffer-update [<FORMAT>]
6234 \begin_layout Description
6235 Params <FORMAT>: The format to display, where this is one of the formats
6236 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6237 If no format is given, the default format as specified in the same dialog
6242 \begin_layout Description
6243 Origin Tommaso, 20 Sep 2007
6246 \begin_layout Subsection*
6247 LFUN_MASTER_BUFFER_VIEW
6250 \begin_layout Description
6251 Action When run from a child document, this command shows a preview built
6252 from the master buffer, if available.
6256 \begin_layout Description
6257 Syntax master-buffer-view [<FORMAT>]
6260 \begin_layout Description
6261 Params <FORMAT>: The format to display, where this is one of the formats
6262 defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6263 If no format is given, the default format as specified in the same dialog
6268 \begin_layout Description
6269 Origin Tommaso, 20 Sep 2007
6272 \begin_layout Subsection*
6273 LFUN_BUFFER_LANGUAGE
6276 \begin_layout Description
6277 Action Set language of the current document.
6281 \begin_layout Description
6282 Syntax buffer-language <LANG>
6285 \begin_layout Description
6286 Params <LANG>: language name.
6287 See lib/languages for list.
6291 \begin_layout Description
6292 Origin leeming, 30 Mar 2004
6295 \begin_layout Subsection*
6296 LFUN_BUFFER_SAVE_AS_DEFAULT
6299 \begin_layout Description
6300 Action Save the current document settings as default.
6304 \begin_layout Description
6305 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6309 \begin_layout Description
6310 Syntax buffer-save-as-default [<ARGS>]
6313 \begin_layout Description
6314 Params <ARGS>: contains the particular settings to be saved.
6315 They obey the syntax you can find in document header of usual .lyx file.
6319 \begin_layout Description
6320 Origin leeming, 30 Mar 2004
6323 \begin_layout Subsection*
6324 LFUN_BUFFER_PARAMS_APPLY
6327 \begin_layout Description
6328 Action Apply the given settings to the current document.
6332 \begin_layout Description
6333 Syntax buffer-params-apply [<ARGS>]
6336 \begin_layout Description
6337 Params <ARGS>: contains the particular settings to be saved.
6338 They obey the syntax you can find in document header of usual .lyx file.
6342 \begin_layout Description
6343 Origin leeming, 30 Mar 2004
6346 \begin_layout Subsection*
6350 \begin_layout Description
6351 Action Inserts another LyX file.
6355 \begin_layout Description
6356 Syntax file-insert [<FILE>]
6359 \begin_layout Description
6360 Params <FILE>: Filename to be inserted.
6364 \begin_layout Subsection*
6365 LFUN_FILE_INSERT_PLAINTEXT
6368 \begin_layout Description
6369 Action Inserts plain text file.
6373 \begin_layout Description
6374 Syntax file-insert-plaintext [<FILE>]
6377 \begin_layout Description
6378 Params <FILE>: Filename to be inserted.
6382 \begin_layout Description
6383 Origin CFO-G, 19 Nov 1997
6386 \begin_layout Subsection*
6387 LFUN_FILE_INSERT_PLAINTEXT_PARA
6390 \begin_layout Description
6391 Action Inserts plain text file as paragraph (i.e.
6396 \begin_layout Description
6397 Syntax file-insert-plaintext-para [<FILE>]
6400 \begin_layout Description
6401 Params <FILE>: Filename to be inserted.
6405 \begin_layout Description
6406 Origin Levon, 14 Feb 2001
6409 \begin_layout Subsection*
6413 \begin_layout Description
6414 Action Open LyX document.
6418 \begin_layout Description
6419 Syntax file-open [<FILE>]
6422 \begin_layout Description
6423 Params <FILE>: Filename to be opened.
6427 \begin_layout Subsection*
6431 \begin_layout Description
6432 Action Executes a command defined in a .def file.
6436 \begin_layout Description
6437 Notion The definitions are by default read from lib/commands/default.def.
6439 \begin_inset Newline newline
6442 A .def file allows to define a command with
6444 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6445 <LFUN> is the lfun code to be executed (see e.g.
6446 LFUN_COMMAND_SEQUENCE).
6449 def_file "FileName" allows to include another .def file.
6451 \begin_inset Newline newline
6454 This is particularly useful in connection with toolbar buttons: Since the
6455 name of the button image for this lfun is lib/images/commands/<NAME>.png
6456 this is the way to assign an image to a complex command-sequence.
6460 \begin_layout Description
6464 \begin_layout Description
6465 Params <NAME>: Name of the command that must be called.
6469 \begin_layout Description
6470 Origin broider, 2 Oct 2007
6473 \begin_layout Subsection*
6477 \begin_layout Description
6478 Action Simulate halting Meta key (Alt key on PCs).
6482 \begin_layout Description
6483 Notion Used for buffer editation not for GUI control.
6487 \begin_layout Description
6491 \begin_layout Subsection*
6495 \begin_layout Description
6496 Action Cancels sequence prepared by LFUN_META_PREFIX .
6500 \begin_layout Description
6504 \begin_layout Subsection*
6505 LFUN_COMMAND_EXECUTE
6508 \begin_layout Description
6509 Action Opens the minibuffer toolbar so that the user can type in there.
6513 \begin_layout Description
6514 Notion Usually bound to M-x shortcut.
6518 \begin_layout Description
6519 Syntax command-execute
6522 \begin_layout Subsection*
6526 \begin_layout Description
6527 Action Return the current key sequence and available options as a string.
6531 \begin_layout Description
6532 Notion No options are added if no current map exists.
6534 \begin_inset Newline newline
6537 This is probably usable only with connection to lyxserver.
6541 \begin_layout Description
6542 Syntax command-prefix
6545 \begin_layout Subsection*
6546 LFUN_COMMAND_SEQUENCE
6549 \begin_layout Description
6550 Action Run more commands (LFUN and its parameters) in a sequence.
6554 \begin_layout Description
6555 Syntax command-sequence <CMDS>
6558 \begin_layout Description
6559 Params <CMDS>: Sequence of commands separated by semicolons.
6563 \begin_layout Description
6564 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6568 \begin_layout Description
6569 Origin Andre, 11 Nov 1999
6572 \begin_layout Subsection*
6573 LFUN_COMMAND_ALTERNATIVES
6576 \begin_layout Description
6577 Action Runs the first listed command that is enabled.
6581 \begin_layout Description
6582 Notion This can be used to bind multiple functions to a single key, and
6583 then which one is used will depend upon the context.
6587 \begin_layout Description
6588 Syntax command-alternatives <CMDS>
6591 \begin_layout Description
6592 Params <CMDS>: Sequence of commands separated by semicolons.
6596 \begin_layout Description
6597 Sample command-alternatives completion-accept;cell-forward
6600 \begin_layout Description
6601 Origin rgh, 24 September 2008
6604 \begin_layout Subsection*
6608 \begin_layout Description
6609 Action Shows message in statusbar (for script purposes).
6613 \begin_layout Description
6614 Syntax message <STRING>
6617 \begin_layout Description
6618 Origin Lgb, 8 Apr 2001
6621 \begin_layout Subsection*
6622 LFUN_PREFERENCES_SAVE
6625 \begin_layout Description
6626 Action Save user preferences.
6630 \begin_layout Description
6631 Syntax preferences-save
6634 \begin_layout Description
6635 Origin Lgb, 27 Nov 1999
6638 \begin_layout Subsection*
6642 \begin_layout Description
6643 Action Reconfigure the automatic settings.
6647 \begin_layout Description
6651 \begin_layout Description
6652 Origin Asger, 14 Feb 1997
6655 \begin_layout Subsection*
6659 \begin_layout Description
6660 Action Apply the given settings to user preferences.
6664 \begin_layout Description
6665 Syntax lyxrc-apply <SETTINGS>
6668 \begin_layout Description
6669 Params <SETTINGS>: settings which are to be set.
6670 Take a look into ~/.lyx/preferences to get an idea which commands to use
6672 lyx::LyXRC::LyXRCTags has the list of possible commands.
6676 \begin_layout Subsection*
6677 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6680 \begin_layout Description
6681 Action Determine whether keep cursor inside the editing window regardless
6682 the scrollbar movement.
6686 \begin_layout Description
6687 Syntax toggle-cursor-follows-scrollbar
6690 \begin_layout Description
6691 Origin ARRae, 2 Dec 1997
6694 \begin_layout Subsection*
6698 \begin_layout Description
6699 Action Set the given LyX color to the color defined by the X11 name given.
6703 \begin_layout Description
6704 Notion A new color entry is created if the color is unknown.
6705 Color names can be stored as a part of user settings.
6709 \begin_layout Description
6710 Syntax set-color <LYX_NAME> <X11_NAME>
6713 \begin_layout Description
6714 Origin SLior, 11 Jun 2000
6717 \begin_layout Subsection*
6721 \begin_layout Description
6722 Action Count the statistics (number of words and characters) in the document
6723 or in the given selection.
6727 \begin_layout Description
6728 Notion Note that this function gives the number of words/chars written,
6729 not the number of characters which will be typeset.
6733 \begin_layout Description
6737 \begin_layout Description
6738 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6741 \begin_layout Subsection*
6742 LFUN_COMPLETION_INLINE
6745 \begin_layout Description
6746 Action Show the inline completion at the cursor position.
6750 \begin_layout Description
6751 Syntax completion-inline
6754 \begin_layout Description
6755 Origin sts, Feb 19 2008
6758 \begin_layout Subsection*
6759 LFUN_COMPLETION_POPUP
6762 \begin_layout Description
6763 Action Show the completion popup at the cursor position.
6767 \begin_layout Description
6768 Syntax completion-popup
6771 \begin_layout Description
6772 Origin sts, Feb 19 2008
6775 \begin_layout Subsection*
6776 LFUN_COMPLETION_COMPLETE
6779 \begin_layout Description
6780 Action Try to complete the word or command at the cursor position.
6784 \begin_layout Description
6788 \begin_layout Description
6789 Origin sts, Feb 19 2008
6792 \begin_layout Subsection*
6793 LFUN_COMPLETION_CANCEL
6796 \begin_layout Description
6797 Action Try to cancel completion, either the popup or the inline completion
6801 \begin_layout Description
6802 Syntax completion-cancel
6805 \begin_layout Description
6806 Origin sts, Sep 07 2008
6809 \begin_layout Subsection*
6810 LFUN_COMPLETION_ACCEPT
6813 \begin_layout Description
6814 Action Accept suggested completion.
6818 \begin_layout Description
6819 Syntax completion-accept
6822 \begin_layout Description
6823 Origin sanda, Sep 08 2008
6826 \begin_layout Subsection*
6827 LFUN_BRANCH_ACTIVATE
6830 \begin_layout Description
6831 Action Activate the branch
6834 \begin_layout Description
6835 Syntax branch-activate <BRANCH>
6838 \begin_layout Description
6839 Params <BRANCH>: The branch to activate
6842 \begin_layout Description
6843 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6844 \begin_inset Newline newline
6847 could be used to export a pdf with the answers branch includedwithout one's
6848 having to open LyX and activate the branch manually.
6851 \begin_layout Description
6852 Origin rgh, 27 May 2008
6855 \begin_layout Subsection*
6856 LFUN_BRANCH_DEACTIVATE
6859 \begin_layout Description
6860 Action De-activate the branch
6863 \begin_layout Description
6864 Syntax branch-deactivate <BRANCH>
6867 \begin_layout Description
6868 Params <BRANCH>: The branch to deactivate
6871 \begin_layout Description
6872 Origin rgh, 27 May 2008
6875 \begin_layout Subsection*
6876 LFUN_COPY_LABEL_AS_REF
6879 \begin_layout Description
6880 Action Copies the label at the cursor as a cross-reference to be pasted
6885 \begin_layout Description
6886 Syntax copy-label-as-reference
6889 \begin_layout Description
6890 Origin sts, 16 Nov 2008
6893 \begin_layout Subsection*
6894 LFUN_INSERT_LABEL_AS_REF
6897 \begin_layout Description
6898 Action Inserts the label as a cross-reference at the position of the cursor.
6902 \begin_layout Description
6903 Syntax insert-label-as-reference
6906 \begin_layout Description
6907 Origin vfr, 7 Apr 2009
6910 \begin_layout Subsection*
6914 \begin_layout Description
6915 Action Increases the zoom of the screen fonts.
6919 \begin_layout Description
6920 Syntax buffer-zoom-in [<ZOOM>]
6923 \begin_layout Description
6924 Params <ZOOM>: The zoom in %, the default is 20.
6928 \begin_layout Description
6929 Origin vfr, 30 Mar 2009
6932 \begin_layout Subsection*
6933 LFUN_BUFFER_ZOOM_OUT
6936 \begin_layout Description
6937 Action Decreases the zoom of the screen fonts.
6941 \begin_layout Description
6942 Syntax buffer-zoom-out [<ZOOM>]
6945 \begin_layout Description
6946 Params <ZOOM>: The zoom in %, the default is 20.
6950 \begin_layout Description
6951 Origin vfr, 30 Mar 2009